c3dhall2 2.0.0.0
Main Page

3D Hall 2 click

3D Hall 2 click is a very accurate magnetic field sensing Click boardâ„¢, used to sense the magnetic field strength in three perpendicular axes. It relies on a TLV493D-A1B6, a low power 3D magnetic sensor from Infineon.

click Product page


Click library

  • Author : MikroE Team
  • Date : Dec 2019.
  • Type : I2C type

Software Support

We provide a library for the 3d Hall 2 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

‍This library contains API for 3d Hall 2 Click driver.

Standard key functions :

Example key functions :

  • c3dhall2_read_data This function reads data from register.
    err_t c3dhall2_read_data ( c3dhall2_t *ctx, uint8_t *data_buf, uint16_t len );
    err_t c3dhall2_read_data(c3dhall2_t *ctx, uint8_t *data_buf, uint16_t len)
    Generic read function.
  • c3dhall2_get_axis_temp_data This function gets temperature and axis data.
    err_t c3dhall2_get_axis_temp_data ( c3dhall2_t *ctx, float *axis_data, float *temp_data );
    err_t c3dhall2_get_axis_temp_data(c3dhall2_t *ctx, float *axis_data, float *temp_data)
    Functions for getting Hall axis data and Temperature data.
  • c3dhall2_configuration This function configures the chip for measurement.
    err_t c3dhall2_configuration ( c3dhall2_t *ctx, uint8_t settings1, uint8_t settings2 );
    err_t c3dhall2_configuration(c3dhall2_t *ctx, uint8_t settings1, uint8_t settings2)
    Functions for settings chip for measurement.

Examples Description

‍This example reads X/Y/Z hall axis and temperature data and converts it to human readable format.

The demo application is composed of two sections :

Application Init

‍Initializes the driver and configures the click board.

void application_init ( void )
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
C3DHALL2_MAP_MIKROBUS( cfg, MIKROBUS_1 );
c3dhall2_init( &c3dhall2, &cfg );
c3dhall2_default_cfg( &c3dhall2 );
}
#define C3DHALL2_MAP_MIKROBUS(cfg, mikrobus)
Definition c3dhall2.h:66
void application_init(void)
Definition main.c:35

Application Task

‍Reads X/Y/Z hall axis and Temperature data. All data logs on the USBUART every 200ms.

void application_task ( void )
{
float xyz_axis[ 3 ] = { 0 };
float temperature = 0;
if ( C3DHALL2_OK == c3dhall2_get_axis_temp_data( &c3dhall2, &xyz_axis[ 0 ], &temperature ) )
{
log_printf( &logger, " Axis X: %.2f mT\r\n", xyz_axis[ 0 ] );
log_printf( &logger, " Axis Y: %.2f mT\r\n", xyz_axis[ 1 ] );
log_printf( &logger, " Axis Z: %.2f mT\r\n", xyz_axis[ 2 ] );
log_printf( &logger, " Temperature: %.2f C\r\n\n", temperature );
Delay_ms ( 200 );
}
}
@ C3DHALL2_OK
Definition c3dhall2.h:152
void application_task(void)
Definition main.c:62

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.3dHall2

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. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.