3dhall3

---

3D Hall 3 Click

3D Hall 3 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.

---

Click Library

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

Software Support

Example Description

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

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.3DHall3

Example Key Functions

• c3dhall3_cfg_setup Config Object Initialization function.

void c3dhall3_cfg_setup ( c3dhall3_cfg_t *cfg );

• c3dhall3_init Initialization function.

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

• c3dhall3_default_cfg Click Default Configuration function.

void c3dhall3_default_cfg ( c3dhall3_t *ctx );

• c3dhall3_read_xyz This function reads xyz values from the module.

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

• c3dhall3_write_offset This function writes offest values to the module.

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

• c3dhall3_interrupt_threshold This function sets desired threshold value.

void c3dhall3_interrupt_threshold ( c3dhall3_t *ctx, uint16_t threshold );

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 );
}

Application Output

This Click board can be interfaced and monitored in two ways:

• Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
• UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.

---