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]
Rating:
Author: MIKROE
Last Updated: 2024-10-31
Package Version: 2.1.0.21
mikroSDK Library: 2.0.0.0
Category: Magnetic
Downloaded: 270 times
Not followed.
License: MIT license
3D HALL 5 Click is a very accurate, magnetic field sensing Click board, used to measure the intensity of the magnetic field across three perpendicular axes.
Do you want to subscribe in order to receive notifications regarding "3D Hall 5 Click" changes.
Do you want to unsubscribe in order to stop receiving notifications regarding "3D Hall 5 Click" changes.
Do you want to report abuse regarding "3D Hall 5 Click".
DOWNLOAD LINK | RELATED COMPILER | CONTAINS |
---|---|---|
3108_3d_hall_5_click.zip [505.67KB] | mikroC AI for ARM GCC for ARM Clang for ARM mikroC AI for PIC mikroC AI for PIC32 XC32 GCC for RISC-V Clang for RISC-V mikroC AI for AVR mikroC AI for dsPIC XC16 |
|
3D HALL 5 Click is a very accurate, magnetic field sensing Click board, used to measure the intensity of the magnetic field across three perpendicular axes.
We provide a library for the 3dHall5 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.
This library contains API for 3dHall5 Click driver.
Config Object Initialization function.
void c3dhall5_cfg_setup ( c3dhall5_cfg_t *cfg );
Initialization function.
C3DHALL5_RETVAL c3dhall5_init ( c3dhall5_t ctx, c3dhall5_cfg_t cfg );
Click Default Configuration function.
void c3dhall5_default_cfg ( c3dhall5_t *ctx );
Axis data
int16_t c3dhall5_get_axis_data ( c3dhall5_t *ctx, uint8_t axis );
Set offest
void c3dhall5_set_offset ( c3dhall5_t *ctx, uint8_t offset_axis, int16_t offset );
Interrupt state
uint8_t c3dhall5_get_interrupt_state ( c3dhall5_t *ctx );
The Demo application displays and reads 3 magnetic axes.
The demo application is composed of two sections :
Configuring clicks and log objects. Reads device ID for check communication.
void application_init ( void )
{
log_cfg_t log_cfg;
c3dhall5_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.
c3dhall5_cfg_setup( &cfg );
C3DHALL5_MAP_MIKROBUS( cfg, MIKROBUS_1 );
c3dhall5_init( &c3dhall5, &cfg );
c3dhall5_default_cfg ( &c3dhall5 );
device_id = c3dhall5_get_device_id ( &c3dhall5 );
log_info( &logger, "** Device ID: 0x%x", device_id );
}
Reads the magnetics X / Y / Z axis data every 1 seconds.
void application_task ( void )
{
int16_t axis_X;
int16_t axis_Y;
int16_t axis_Z;
// Task implementation.
axis_X = c3dhall5_get_axis_data( &c3dhall5, C3DHALL5_AXIS_X );
axis_Y = c3dhall5_get_axis_data( &c3dhall5, C3DHALL5_AXIS_Y );
axis_Z = c3dhall5_get_axis_data( &c3dhall5, C3DHALL5_AXIS_Z );
log_printf( &logger, "----- AXIS -----\r\n" );
log_printf( &logger, "** X: %d \r\n", axis_X );
log_printf( &logger, "** Y: %d \r\n", axis_Y );
log_printf( &logger, "** Z: %d \r\n", axis_Z );
log_printf( &logger, "----------------\r\n" );
Delay_ms ( 1000 );
}
Default communication that is set is I2C communication. If you want to use SPI, you have to set up the cfg structure.
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:
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.