TOP Contributors

  1. MIKROE (2784 codes)
  2. Alcides Ramos (405 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (133 codes)
  5. Bugz Bensce (97 codes)
  6. S P (73 codes)
  7. dany (71 codes)
  8. MikroBUS.NET Team (35 codes)
  9. NART SCHINACKOW (34 codes)
  10. Armstrong Subero (27 codes)

Most Downloaded

  1. Timer Calculator (141454 times)
  2. FAT32 Library (74299 times)
  3. Network Ethernet Library (58837 times)
  4. USB Device Library (48909 times)
  5. Network WiFi Library (44679 times)
  6. FT800 Library (44214 times)
  7. GSM click (30933 times)
  8. mikroSDK (29803 times)
  9. PID Library (27403 times)
  10. microSD click (27333 times)
Libstock prefers package manager

Package Manager

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]

< Back
mikroSDK Library

Hall Switch 3 Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.5

mikroSDK Library: 2.0.0.0

Category: Magnetic

Downloaded: 113 times

Not followed.

License: MIT license  

Hall Switch 3 Click is a compact add-on board representing a magnetic field-activated switch. This board features the NMH1000, a Hall-effect magnetic switch from NXP Semiconductor. It is a low-voltage, low-current, and low-output data rate device with a very small size. The switch is most sensitive to a vertical field passing through the top-bottom surfaces, orthogonal to the plane of the Hall Switch 3 Click board™.

No Abuse Reported

Do you want to subscribe in order to receive notifications regarding "Hall Switch 3 Click" changes.

Do you want to unsubscribe in order to stop receiving notifications regarding "Hall Switch 3 Click" changes.

Do you want to report abuse regarding "Hall Switch 3 Click".

  • Information
  • Comments (0)

mikroSDK Library Blog


Hall Switch 3 Click

Hall Switch 3 Click is a compact add-on board representing a magnetic field-activated switch. This board features the NMH1000, a Hall-effect magnetic switch from NXP Semiconductor. It is a low-voltage, low-current, and low-output data rate device with a very small size. The switch is most sensitive to a vertical field passing through the top-bottom surfaces, orthogonal to the plane of the Hall Switch 3 Click board™.

hallswitch3_click.png

Click Product page


Click library

  • Author : Nenad Filipovic
  • Date : Nov 2023.
  • Type : I2C type

Software Support

We provide a library for the Hall Switch 3 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 Hall Switch 3 Click driver.

Standard key functions :

  • hallswitch3_cfg_setup Config Object Initialization function.

    void hallswitch3_cfg_setup ( hallswitch3_cfg_t *cfg );
  • hallswitch3_init Initialization function.

    err_t hallswitch3_init ( hallswitch3_t *ctx, hallswitch3_cfg_t *cfg );
  • hallswitch3_default_cfg Click Default Configuration function.

    err_t hallswitch3_default_cfg ( hallswitch3_t *ctx );

Example key functions :

  • hallswitch3_get_mag_data This function is used to indicates a relative magnetic field strength.

    err_t hallswitch3_get_mag_data ( hallswitch3_t *ctx, int8_t *mag_data );
  • hallswitch3_set_out_data_rate This function provides the capability for the user to override the fixed sample rate controlling the sleep-compare-Vout cycle time.

    err_t hallswitch3_set_out_data_rate ( hallswitch3_t *ctx, uint8_t odr );
  • hallswitch3_get_status This function reads a status reporting of modes and selections.

    err_t hallswitch3_get_status ( hallswitch3_t *ctx, uint8_t *status );

Example Description

This example demonstrates the use of Hall Switch 3 Click board by reading and displaying the magnetic field strength value.

The demo application is composed of two sections :

Application Init

Initialization of I2C module and log UART. After driver initialization, the app executes a default configuration.

void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    hallswitch3_cfg_t hallswitch3_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 );
    log_info( &logger, " Application Init " );

    // Click initialization.
    hallswitch3_cfg_setup( &hallswitch3_cfg );
    HALLSWITCH3_MAP_MIKROBUS( hallswitch3_cfg, MIKROBUS_1 );
    if ( I2C_MASTER_ERROR == hallswitch3_init( &hallswitch3, &hallswitch3_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }

    if ( HALLSWITCH3_ERROR == hallswitch3_default_cfg ( &hallswitch3 ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }

    log_info( &logger, " Application Task " );
}

Application Task

This example demonstrates the use of the Hall Switch 3 Click board. The demo application reads and displays the relative magnetic field strength value [Gaussian units] and detects when the magnetic field strength is not in the configured range. The results are sent to the UART terminal, where you can monitor their changes.

void application_task ( void ) 
{
    int8_t mag_data = 0;
    if ( HALLSWITCH3_OK == hallswitch3_get_mag_data( &hallswitch3, &mag_data ) )
    {
        log_printf( &logger, " Magnetic Field: %d [Gs]\r\n", ( int16_t ) mag_data );
        if ( HALLSWITCH3_OUT_STATE_LOW == hallswitch3_check_mag_field( &hallswitch3 ) )
        {
            log_printf( &logger, " The switch is open.\r\n" );
        }
    }
    Delay_ms ( 1000 );
}

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.HallSwitch3

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.


ALSO FROM THIS AUTHOR

Boost click

2

Boost click carries Microchip’s MIC2606, a 2MHz, PWM DC/DC boost switching regulator available in a 2mm x 2mm MLF package. The input voltage can be set to 5V from mikroBUS or in range 7-20V from an external DC source connected to VIN screw terminal. The output voltage can be set up to 38V.

[Learn More]

Comparator Click

0

Comparator Click represents board equipped with two independent precise voltage comparators.

[Learn More]

Relay 2 Click

0

Relay 2 Click is a dual relay Click board™, equipped with two single-pole solid state relays (SSR), built with the patented OptoMOS® technology.

[Learn More]