3dhall13 2.2.0
Loading...
Searching...
No Matches
3dhall13


3D Hall 13 Click

3D Hall 13 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 : Stefan Filipovic
  • Date : Mar 2025.
  • Type : I2C type

Software Support

Example Description

This example demonstrates the use of 3D Hall 13 Click board by reading the magnetic flux density from 3 axes, and the angle and magnitude between X and Y axes
as well as the sensor internal temperature.

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.3DHall13

Example Key Functions

  • c3dhall13_cfg_setup This function initializes Click configuration structure to initial values.
    void c3dhall13_cfg_setup(c3dhall13_cfg_t *cfg)
    3D Hall 13 configuration object setup function.
    3D Hall 13 Click configuration object.
    Definition c3dhall13.h:391
  • c3dhall13_init This function initializes all necessary pins and peripherals used for this Click board.
    err_t c3dhall13_init(c3dhall13_t *ctx, c3dhall13_cfg_t *cfg)
    3D Hall 13 initialization function.
    3D Hall 13 Click context object.
    Definition c3dhall13.h:374
  • c3dhall13_default_cfg This function executes a default configuration of 3D Hall 13 Click board.
    err_t c3dhall13_default_cfg(c3dhall13_t *ctx)
    3D Hall 13 default configuration function.
  • c3dhall13_read_data This function reads new data which consists of X, Y, and Z axis values in mT, and temperature in Celsius.
    err_t c3dhall13_read_data(c3dhall13_t *ctx, c3dhall13_data_t *data_out)
    3D Hall 13 read data function.
    3D Hall 13 Click data object.
    Definition c3dhall13.h:359

Application Init

Initializes the driver and performs the Click default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
c3dhall13_cfg_t c3dhall13_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
c3dhall13_cfg_setup( &c3dhall13_cfg );
C3DHALL13_MAP_MIKROBUS( c3dhall13_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == c3dhall13_init( &c3dhall13, &c3dhall13_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( C3DHALL13_ERROR == c3dhall13_default_cfg ( &c3dhall13 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
@ C3DHALL13_ERROR
Definition c3dhall13.h:409
#define C3DHALL13_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition c3dhall13.h:346
void application_init(void)
Definition main.c:30

Application Task

Reads data from the sensor approximately every 100ms and displays the measurement values on the USB UART.

void application_task ( void )
{
c3dhall13_data_t sensor_data;
if ( C3DHALL13_OK == c3dhall13_read_data ( &c3dhall13, &sensor_data ) )
{
log_printf( &logger, " X-axis: %.1f mT\r\n", sensor_data.x_axis );
log_printf( &logger, " Y-axis: %.1f mT\r\n", sensor_data.y_axis );
log_printf( &logger, " Z-axis: %.1f mT\r\n", sensor_data.z_axis );
log_printf( &logger, " Angle: %.1f Degrees\r\n", sensor_data.angle );
log_printf( &logger, " Magnitude: %u\r\n", ( uint16_t ) sensor_data.magnitude );
log_printf( &logger, " Temperature: %.2f Celsius\r\n\n", sensor_data.temperature );
Delay_ms ( 100 );
}
}
@ C3DHALL13_OK
Definition c3dhall13.h:408
void application_task(void)
Definition main.c:66
float z_axis
Definition c3dhall13.h:362
uint8_t magnitude
Definition c3dhall13.h:365
float x_axis
Definition c3dhall13.h:360
float y_axis
Definition c3dhall13.h:361
float angle
Definition c3dhall13.h:363
float temperature
Definition c3dhall13.h:364

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.