Provide precise and dependable relay control activated by magnetic fields. It empowers you to optimize applications in security systems and industrial automation with ease.
A
A
Hardware Overview
How does it work?
Hall Switch Click is based on the AH1389, an ultra-sensitive dual output unipolar Hall Effect switch, from Diodes Incorporated. This IC utilizes Hall effect - a phenomenon in which the current flow, or rather - the path of the conductor electrons is affected by the magnetic field. Due to the fact that the path of the electrons is curved, a buildup of positive charges is formed on the opposite side of this path, and the voltage is generated. If a voltmeter is connected to the path perpendicular to the current path and the magnetic field, a voltage will be detected. The AH1389 has the ability to detect both the north and south poles of the magnetic field. The magnetic field from the south pole magnet will pull the output 2 to a LOW (active) state, while the magnetic field from the north pole magnet will pull the output 1 to a LOW
(active) state. The IC features several sections for the signal conditioning. It also provides the hysteresis for the output activation, to avoid erratic triggering. The magnetic field strength which activates outputs is about ±25 G, while the field strength under ±20 G will deactivate outputs, giving a hysteresis of typical 5 G. The positive and negative sign is used with respect to the magnet poles (north pole has a negative sign prefix). The outputs of the AH1389 IC are routed to the operational amplifiers, which work as the inverting comparators. When the output of the AH1389 IC is activated - pulled to a LOW voltage level, the output from the comparator will be set to 5V. This will cause biasing of the BJT, allowing current flow through the relay coil, and thus forming a magnetic field necessary for closing the relay
contacts. A Schottky diode across the relay coil prevents the reverse kickback voltage, which forms due to the inert nature of the coils. Activation of the relay coils is indicated by the red and blue LEDs, respectively. Two outputs of the AH1389 IC are also routed to the mikroBUS pins: north pole output (1) is routed to the CS pin and the south pole output (2) is routed to the INT pin of the mikroBUS™ so that the status of the IC can be monitored by the MCU. Two varistors are used to prevent voltage peaks when the load is connected or disconnected on the relay output contacts. The output contacts are further routed to the screw terminals, which allow up to 10A. However the relays allow up to 5A for 250V AC/30V DC, so the connected load should not exceed these power ratings.
Features overview
Development board
Nucleo-64 with STM32F091RC MCU offers a cost-effective and adaptable platform for developers to explore new ideas and prototype their designs. This board harnesses the versatility of the STM32 microcontroller, enabling users to select the optimal balance of performance and power consumption for their projects. It accommodates the STM32 microcontroller in the LQFP64 package and includes essential components such as a user LED, which doubles as an ARDUINO® signal, alongside user and reset push-buttons, and a 32.768kHz crystal oscillator for precise timing operations. Designed with expansion and flexibility in mind, the Nucleo-64 board features an ARDUINO® Uno V3 expansion connector and ST morpho extension pin
headers, granting complete access to the STM32's I/Os for comprehensive project integration. Power supply options are adaptable, supporting ST-LINK USB VBUS or external power sources, ensuring adaptability in various development environments. The board also has an on-board ST-LINK debugger/programmer with USB re-enumeration capability, simplifying the programming and debugging process. Moreover, the board is designed to simplify advanced development with its external SMPS for efficient Vcore logic supply, support for USB Device full speed or USB SNK/UFP full speed, and built-in cryptographic features, enhancing both the power efficiency and security of projects. Additional connectivity is
provided through dedicated connectors for external SMPS experimentation, a USB connector for the ST-LINK, and a MIPI® debug connector, expanding the possibilities for hardware interfacing and experimentation. Developers will find extensive support through comprehensive free software libraries and examples, courtesy of the STM32Cube MCU Package. This, combined with compatibility with a wide array of Integrated Development Environments (IDEs), including IAR Embedded Workbench®, MDK-ARM, and STM32CubeIDE, ensures a smooth and efficient development experience, allowing users to fully leverage the capabilities of the Nucleo-64 board in their projects.
Microcontroller Overview
MCU Card / MCU

Architecture
ARM Cortex-M0
MCU Memory (KB)
256
Silicon Vendor
STMicroelectronics
Pin count
64
RAM (Bytes)
32768
You complete me!
Accessories
Click Shield for Nucleo-64 comes equipped with two proprietary mikroBUS™ sockets, allowing all the Click board™ devices to be interfaced with the STM32 Nucleo-64 board with no effort. This way, Mikroe allows its users to add any functionality from our ever-growing range of Click boards™, such as WiFi, GSM, GPS, Bluetooth, ZigBee, environmental sensors, LEDs, speech recognition, motor control, movement sensors, and many more. More than 1537 Click boards™, which can be stacked and integrated, are at your disposal. The STM32 Nucleo-64 boards are based on the microcontrollers in 64-pin packages, a 32-bit MCU with an ARM Cortex M4 processor operating at 84MHz, 512Kb Flash, and 96KB SRAM, divided into two regions where the top section represents the ST-Link/V2 debugger and programmer while the bottom section of the board is an actual development board. These boards are controlled and powered conveniently through a USB connection to program and efficiently debug the Nucleo-64 board out of the box, with an additional USB cable connected to the USB mini port on the board. Most of the STM32 microcontroller pins are brought to the IO pins on the left and right edge of the board, which are then connected to two existing mikroBUS™ sockets. This Click Shield also has several switches that perform functions such as selecting the logic levels of analog signals on mikroBUS™ sockets and selecting logic voltage levels of the mikroBUS™ sockets themselves. Besides, the user is offered the possibility of using any Click board™ with the help of existing bidirectional level-shifting voltage translators, regardless of whether the Click board™ operates at a 3.3V or 5V logic voltage level. Once you connect the STM32 Nucleo-64 board with our Click Shield for Nucleo-64, you can access hundreds of Click boards™, working with 3.3V or 5V logic voltage levels.
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Click board™ Schematic

Step by step
Project assembly
Track your results in real time
Application Output
1. Application Output - In Debug mode, the 'Application Output' window enables real-time data monitoring, offering direct insight into execution results. Ensure proper data display by configuring the environment correctly using the provided tutorial.

2. UART Terminal - Use the UART Terminal to monitor data transmission via a USB to UART converter, allowing direct communication between the Click board™ and your development system. Configure the baud rate and other serial settings according to your project's requirements to ensure proper functionality. For step-by-step setup instructions, refer to the provided tutorial.

3. Plot Output - The Plot feature offers a powerful way to visualize real-time sensor data, enabling trend analysis, debugging, and comparison of multiple data points. To set it up correctly, follow the provided tutorial, which includes a step-by-step example of using the Plot feature to display Click board™ readings. To use the Plot feature in your code, use the function: plot(*insert_graph_name*, variable_name);. This is a general format, and it is up to the user to replace 'insert_graph_name' with the actual graph name and 'variable_name' with the parameter to be displayed.

Software Support
Library Description
This library contains API for Hall Switch Click driver.
Key functions:
hallswitch_set_npole
- Function for turn on and turn off N Pole
Open Source
Code example
The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.
/*!
* \file
* \brief Hall Switch Click example
*
* # Description
* The application sets sensor magnetic pole
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes Driver init and turn OFF S-pole and N-pole
*
* ## Application Task
* Turns S and N on and off every 500 ms
*
* \author MikroE Team
*
*/
// ------------------------------------------------------------------- INCLUDES
#include "board.h"
#include "log.h"
#include "hallswitch.h"
// ------------------------------------------------------------------ VARIABLES
static hallswitch_t hallswitch;
static log_t logger;
// ------------------------------------------------------ APPLICATION FUNCTIONS
void application_init ( void )
{
log_cfg_t log_cfg;
hallswitch_cfg_t cfg;
/**
* Logger initialization.
* Default baud rate: 115200
* Default log level: LOG_LEVEL_DEBUG
* @note If USB_UART_RX and USB_UART_TX
* are defined as HAL_PIN_NC, you will
* need to define them manually for log to work.
* See @b LOG_MAP_USB_UART macro definition for detailed explanation.
*/
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info(&logger, "---- Application Init ----");
// Click initialization.
hallswitch_cfg_setup( &cfg );
HALLSWITCH_MAP_MIKROBUS( cfg, MIKROBUS_1 );
hallswitch_init( &hallswitch, &cfg );
hallswitch_set_npole( &hallswitch, HALLSWITCH_POLE_NO_ACTIVE );
hallswitch_set_spole( &hallswitch, HALLSWITCH_POLE_NO_ACTIVE );
}
void application_task()
{
hallswitch_set_npole( &hallswitch, HALLSWITCH_POLE_ACTIVE );
Delay_ms ( 500 );
hallswitch_set_spole( &hallswitch, HALLSWITCH_POLE_ACTIVE );
Delay_ms ( 500 );
hallswitch_set_npole( &hallswitch, HALLSWITCH_POLE_NO_ACTIVE );
Delay_ms ( 500 );
hallswitch_set_spole( &hallswitch, HALLSWITCH_POLE_NO_ACTIVE );
Delay_ms ( 500 );
}
int main ( void )
{
/* Do not remove this line or clock might not be set correctly. */
#ifdef PREINIT_SUPPORTED
preinit();
#endif
application_init( );
for ( ; ; )
{
application_task( );
}
return 0;
}
// ------------------------------------------------------------------------ END
/*!
* \file
* \brief Hall Switch Click example
*
* # Description
* The application sets sensor magnetic pole
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes Driver init and turn OFF S-pole and N-pole
*
* ## Application Task
* Turns S and N on and off every 500 ms
*
* \author MikroE Team
*
*/
// ------------------------------------------------------------------- INCLUDES
#include "board.h"
#include "log.h"
#include "hallswitch.h"
// ------------------------------------------------------------------ VARIABLES
static hallswitch_t hallswitch;
static log_t logger;
// ------------------------------------------------------ APPLICATION FUNCTIONS
void application_init ( void )
{
log_cfg_t log_cfg;
hallswitch_cfg_t cfg;
/**
* Logger initialization.
* Default baud rate: 115200
* Default log level: LOG_LEVEL_DEBUG
* @note If USB_UART_RX and USB_UART_TX
* are defined as HAL_PIN_NC, you will
* need to define them manually for log to work.
* See @b LOG_MAP_USB_UART macro definition for detailed explanation.
*/
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info(&logger, "---- Application Init ----");
// Click initialization.
hallswitch_cfg_setup( &cfg );
HALLSWITCH_MAP_MIKROBUS( cfg, MIKROBUS_1 );
hallswitch_init( &hallswitch, &cfg );
hallswitch_set_npole( &hallswitch, HALLSWITCH_POLE_NO_ACTIVE );
hallswitch_set_spole( &hallswitch, HALLSWITCH_POLE_NO_ACTIVE );
}
void application_task()
{
hallswitch_set_npole( &hallswitch, HALLSWITCH_POLE_ACTIVE );
Delay_ms ( 500 );
hallswitch_set_spole( &hallswitch, HALLSWITCH_POLE_ACTIVE );
Delay_ms ( 500 );
hallswitch_set_npole( &hallswitch, HALLSWITCH_POLE_NO_ACTIVE );
Delay_ms ( 500 );
hallswitch_set_spole( &hallswitch, HALLSWITCH_POLE_NO_ACTIVE );
Delay_ms ( 500 );
}
int main ( void )
{
/* Do not remove this line or clock might not be set correctly. */
#ifdef PREINIT_SUPPORTED
preinit();
#endif
application_init( );
for ( ; ; )
{
application_task( );
}
return 0;
}
// ------------------------------------------------------------------------ END