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.17
mikroSDK Library: 2.0.0.0
Category: Magnetic
Downloaded: 237 times
Not followed.
License: MIT license
Compass Click is an add-on board in mikroBUS form factor. It features LSM303DLHC ultra compact high performance e-compass module.
Do you want to subscribe in order to receive notifications regarding "Compass Click" changes.
Do you want to unsubscribe in order to stop receiving notifications regarding "Compass Click" changes.
Do you want to report abuse regarding "Compass Click".
DOWNLOAD LINK | RELATED COMPILER | CONTAINS |
---|---|---|
3447_compass_click.zip [372.74KB] | 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 |
|
Compass Click is an add-on board in mikroBUS form factor. It features LSM303DLHC ultra compact high performance e-compass module.
We provide a library for the Compass 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 Compass Click driver.
Config Object Initialization function.
void compass_cfg_setup ( compass_cfg_t *cfg );
Initialization function.
COMPASS_RETVAL compass_init ( compass_t ctx, compass_cfg_t cfg );
Click Default Configuration function.
void compass_default_cfg ( compass_t *ctx );
This function reads data for megnetic axes.
void compass_read_magnet_axis ( compass_t ctx, int16_t x_axis, int16_t y_axis, int16_t z_axis );
This function reads data for accelerometer axes.
void compass_read_accel_axis ( compass_t ctx, int16_t x_axis, int16_t y_axis, int16_t z_axis );
This function writes magnet data to the desired register.
void compass_magnet_generic_write ( compass_t ctx, uint8_t reg, uint8_t data_buf, uint8_t len );
This application measures magnetic and accelerometer axes data and shows them over USBUART
The demo application is composed of two sections :
Initialization driver init and init chip
void application_init ( void )
{
log_cfg_t log_cfg;
compass_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 ----\r\n" );
// Click initialization.
compass_cfg_setup( &cfg );
COMPASS_MAP_MIKROBUS( cfg, MIKROBUS_1 );
compass_init( &compass, &cfg );
compass_default_config( &compass );
}
Read magnet axis data and accel axis data and logs data on USBUART every 1 sec.
void application_task ( void )
{
int16_t accel_axis[ 3 ];
int16_t magnet_axis[ 3 ];
compass_read_magnet_axis( &compass, &magnet_axis[ 0 ], &magnet_axis[ 1 ], &magnet_axis[ 2 ] );
log_printf( &logger, "Magnet axis -- X: %d Y: %d Z: %d \r\n", magnet_axis[ 0 ], magnet_axis[ 1 ], magnet_axis[ 2 ] );
compass_read_accel_axis ( &compass, &accel_axis[ 0 ], &accel_axis[ 1 ], &accel_axis[ 2 ] );
log_printf( &logger, "Magnet axis -- X: %d Y: %d Z: %d \r\n", accel_axis[ 0 ], accel_axis[ 1 ], accel_axis[ 2 ] );
log_printf( &logger, " \r\n");
Delay_ms ( 1000 );
}
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.