3dhall3

\mainpage Main Page

---

3D Hall 3 click

3D Hall 3 click is a very accurate, magnetic field sensing Click board™, used to measure the intensity of the magnetic field across three perpendicular axes.

click Product page

---

Click library

• Author : Petar Suknjaja
• Date : Dec 2019.
• Type : I2C/SPI type

Software Support

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

Standard key functions :

• Config Object Initialization function.

void c3dhall3_cfg_setup ( c3dhall3_cfg_t *cfg );

• Initialization function.

C3DHALL3_RETVAL c3dhall3_init ( c3dhall3_t *ctx, c3dhall3_cfg_t *cfg );

• Click Default Configuration function.

void c3dhall3_default_cfg ( c3dhall3_t *ctx );

Example key functions :

• This function reads xyz values from the module.

void c3dhall3_read_xyz ( c3dhall3_t *ctx, int16_t *out_xyz );

• This function writes offest values to the module.

void c3dhall3_write_offset (c3dhall3_t *ctx, uint8_t axis, uint16_t offset );

• This function sets desired threshold value.

void c3dhall3_interrupt_threshold ( c3dhall3_t *ctx, uint16_t threshold );

Examples Description

This example returns values of X,Y and Z axes.

The demo application is composed of two sections :

Application Init

Initializes driver and sets basic configuration.

void application_init ( void )
{
    log_cfg_t log_cfg;
    c3dhall3_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.

    c3dhall3_cfg_setup( &cfg );
    C3DHALL3_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    c3dhall3_init( &c3dhall3, &cfg );
    c3dhall3_default_cfg ( &c3dhall3 );
    log_info( &logger, "---- System Init ----" );
}
  

Application Task

Reads the values of the X,Y and Z axes.

void application_task ( void )
{
    int16_t axes_xyz[3];

    //  Task implementation.
    
    c3dhall3_read_xyz( &c3dhall3, axes_xyz );
    log_printf( &logger, "X: %d \r\n", axes_xyz[ 0 ] );
    log_printf( &logger, "Y: %d \r\n", axes_xyz[ 1 ] );
    log_printf( &logger, "Z: %d \r\n", axes_xyz[ 2 ] );

    Delay_ms( 100 );
}

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.3DHall3

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.

---