We strongly encourage users to use Package manager for sharing their code on Libstock website, because it boosts your efficiency and leaves the end user with no room for error. [more info]
Rating:
Author: MIKROE
Last Updated: 2024-10-31
Package Version: 2.1.0.14
mikroSDK Library: 2.0.0.0
Category: Magnetic
Downloaded: 156 times
Not followed.
License: MIT license
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.
Do you want to subscribe in order to receive notifications regarding "Hall Switch 2 Click" changes.
Do you want to unsubscribe in order to stop receiving notifications regarding "Hall Switch 2 Click" changes.
Do you want to report abuse regarding "Hall Switch 2 Click".
DOWNLOAD LINK | RELATED COMPILER | CONTAINS |
---|---|---|
4586_hall_switch_2_cl.zip [560.15KB] | mikroC AI for ARM GCC for ARM Clang for ARM mikroC AI for PIC mikroC AI for PIC32 XC32 GCC for RISC-V Clang for RISC-V mikroC AI for AVR mikroC AI for dsPIC XC16 |
|
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.
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.
This library contains API for HallSwitch2 Click driver.
hallswitch2_cfg_setup
Config Object Initialization function.
void hallswitch2_cfg_setup ( hallswitch2_cfg_t *cfg );
hallswitch2_init
Initialization function.
err_t hallswitch2_init ( hallswitch2_t *ctx, hallswitch2_cfg_t *cfg );
hallswitch2_check_state
This function checks the S and N pin states, which indicates a magnetic field poles.uint8_t hallswitch2_check_state ( hallswitch2_t *ctx );
This example demonstrates the use of Hall Switch 2 Click board.
The demo application is composed of two sections :
Initializes the driver and logger and makes an initial log.
void application_init ( void )
{
log_cfg_t log_cfg; /**< Logger config object. */
hallswitch2_cfg_t hallswitch2_cfg; /**< Click config object. */
/**
* 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 );
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 " );
}
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 ) )
{
case HALLSWITCH2_NO_MAGNET_DETECTED:
{
if ( HALLSWITCH2_NO_MAGNET_DETECTED != print_state )
{
log_printf( &logger, " No magnet detected\r\n" );
log_printf( &logger, " Switches - disabled\r\n\r\n" );
print_state = HALLSWITCH2_NO_MAGNET_DETECTED;
}
break;
}
case HALLSWITCH2_S_POLE_DETECTED:
{
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" );
print_state = HALLSWITCH2_S_POLE_DETECTED;
}
break;
}
case HALLSWITCH2_N_POLE_DETECTED:
{
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" );
print_state = HALLSWITCH2_N_POLE_DETECTED;
}
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:
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.