hallswitch2  2.0.0.0
Main Page

Hall Switch 2 Click

Hall Switch 2 Click is a compact add-on board that represents a magnetic field-activated dual-relay Click boardâ„¢. This board features the MHA100KN, a high-performance, low-power Hall-Effect sensor from MEMSIC.

Click Product page


Click library

  • Author : Stefan Filipovic
  • Date : Jul 2021.
  • Type : GPIO type

Software Support

We provide a library for the HallSwitch2 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for HallSwitch2 Click driver.

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of Hall Switch 2 Click board.

The demo application is composed of two sections :

Application Init

Initializes the driver and logger and makes an initial log.

void application_init ( void )
{
log_cfg_t log_cfg;
hallswitch2_cfg_t hallswitch2_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
Delay_ms ( 100 );
log_info( &logger, " Application Init " );
// Click initialization.
hallswitch2_cfg_setup( &hallswitch2_cfg );
HALLSWITCH2_MAP_MIKROBUS( hallswitch2_cfg, MIKROBUS_1 );
if ( hallswitch2_init( &hallswitch2, &hallswitch2_cfg ) == DIGITAL_OUT_UNSUPPORTED_PIN )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Displays the corresponding message on the USB UART based on the switches state, i.e. based on the magnetic field presence.

void application_task ( void )
{
switch ( hallswitch2_check_state( &hallswitch2 ) )
{
{
if ( HALLSWITCH2_NO_MAGNET_DETECTED != print_state )
{
log_printf( &logger, " No magnet detected\r\n" );
log_printf( &logger, " Switches - disabled\r\n\r\n" );
}
break;
}
{
if ( HALLSWITCH2_S_POLE_DETECTED != print_state )
{
log_printf( &logger, " South pole detected\r\n" );
log_printf( &logger, " Switch 1 - enabled\r\n\r\n" );
}
break;
}
{
if ( HALLSWITCH2_N_POLE_DETECTED != print_state )
{
log_printf( &logger, " North pole detected\r\n" );
log_printf( &logger, " Switch 2 - enabled\r\n\r\n" );
}
break;
}
default:
{
break;
}
}
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.HallSwitch2

Additional notes and informations

Depending on the development board you are using, you may need USB UART Click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


hallswitch2_cfg_t
Hall Switch 2 Click configuration object.
Definition: hallswitch2.h:115
hallswitch2_init
err_t hallswitch2_init(hallswitch2_t *ctx, hallswitch2_cfg_t *cfg)
Hall Switch 2 initialization function.
hallswitch2_t
Hall Switch 2 Click context object.
Definition: hallswitch2.h:104
hallswitch2_check_state
uint8_t hallswitch2_check_state(hallswitch2_t *ctx)
Hall Switch 2 check state function.
HALLSWITCH2_NO_MAGNET_DETECTED
#define HALLSWITCH2_NO_MAGNET_DETECTED
Hall Switch 2 switch state values.
Definition: hallswitch2.h:72
application_task
void application_task(void)
Definition: main.c:62
HALLSWITCH2_MAP_MIKROBUS
#define HALLSWITCH2_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: hallswitch2.h:92
hallswitch2_cfg_setup
void hallswitch2_cfg_setup(hallswitch2_cfg_t *cfg)
Hall Switch 2 configuration object setup function.
application_init
void application_init(void)
Definition: main.c:29
HALLSWITCH2_S_POLE_DETECTED
#define HALLSWITCH2_S_POLE_DETECTED
Definition: hallswitch2.h:73
HALLSWITCH2_N_POLE_DETECTED
#define HALLSWITCH2_N_POLE_DETECTED
Definition: hallswitch2.h:74