compass6  2.0.0.0
Main Page

Compass 6 click

Compass 6 Click is a compact add-on board perfect for implementation in applications such as an electronic compass. This board features the HSCDTD008A, a high-sensitivity geomagnetic sensor from ALPS Alpine.

click Product page


Click library

  • Author : Luka Filipovic
  • Date : Aug 2021.
  • Type : I2C type

Software Support

We provide a library for the Compass6 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 from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Compass6 Click driver.

Standard key functions :

Example key functions :

Example Description

This example is a showcase the ability of the device

to read 3 axis data of magnetic raw value when data is ready.

The demo application is composed of two sections :

Application Init

Initialization of communication modules (I2C, UART) and data

ready pin as input. Then reads identification data and checks if some of them have wrong value, and configures device for reading.

void application_init ( void )
{
log_cfg_t log_cfg;
compass6_cfg_t compass6_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
compass6_cfg_setup( &compass6_cfg );
COMPASS6_MAP_MIKROBUS( compass6_cfg, MIKROBUS_1 );
err_t init_flag = compass6_init( &compass6, &compass6_cfg );
if ( I2C_MASTER_ERROR == init_flag )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
uint8_t temp_data = 0;
compass6_generic_read( &compass6, COMPASS6_REG_WHO_I_AM, &temp_data );
log_printf( &logger, " > Who am I: 0x%.2X\r\n", ( uint16_t )temp_data );
if ( COMPASS6_WHO_AM_I != temp_data )
{
log_error( &logger, " Who am I. " );
}
log_printf( &logger, " > Version: 0x%.2X\r\n", ( uint16_t )temp_data );
if ( COMPASS6_VERSION != temp_data )
{
log_error( &logger, " Version. " );
}
compass6_generic_read( &compass6, COMPASS6_REG_INFO_ALPS, &temp_data );
log_printf( &logger, " > ALPS: 0x%.2X\r\n", ( uint16_t )temp_data );
if ( COMPASS6_ALPS != temp_data )
{
log_error( &logger, " ALPS. " );
}
compass6_default_cfg ( &compass6 );
log_info( &logger, " Application Task " );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
}

Application Task

Checks Data ready pin and if asserted high it will read data of all

3 axes(x, y, z) and log data to Terminal.

void application_task ( void )
{
if ( compass6_data_ready( &compass6 ) )
{
compass6_axes_t axes_data;
compass6_get_axes_data( &compass6, &axes_data );
log_printf( &logger, " > X: %d\r\n", axes_data.x );
log_printf( &logger, " > Y: %d\r\n", axes_data.y );
log_printf( &logger, " > Z: %d\r\n", axes_data.z );
log_printf( &logger, "*********************\r\n" );
}
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Compass6

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. UART terminal is available in all MikroElektronika compilers.


COMPASS6_REG_WHO_I_AM
#define COMPASS6_REG_WHO_I_AM
Definition: compass6.h:76
compass6_cfg_t
Compass 6 Click configuration object.
Definition: compass6.h:172
compass6_axes_t::z
int16_t z
Definition: compass6.h:202
compass6_default_cfg
err_t compass6_default_cfg(compass6_t *ctx)
Compass 6 default configuration function.
compass6_init
err_t compass6_init(compass6_t *ctx, compass6_cfg_t *cfg)
Compass 6 initialization function.
compass6_data_ready
uint8_t compass6_data_ready(compass6_t *ctx)
Get data ready pin state.
application_task
void application_task(void)
Definition: main.c:90
compass6_generic_read
err_t compass6_generic_read(compass6_t *ctx, uint8_t reg, uint8_t *rx_data)
Compass 6 I2C reading function.
COMPASS6_REG_INFO_VERSION
#define COMPASS6_REG_INFO_VERSION
Definition: compass6.h:74
compass6_get_axes_data
err_t compass6_get_axes_data(compass6_t *ctx, compass6_axes_t *axes_data)
Magnetic axes data reading.
compass6_axes_t::x
int16_t x
Definition: compass6.h:200
compass6_axes_t
Compass 6 Click axes data.
Definition: compass6.h:199
COMPASS6_REG_INFO_ALPS
#define COMPASS6_REG_INFO_ALPS
Definition: compass6.h:75
COMPASS6_VERSION
#define COMPASS6_VERSION
Definition: compass6.h:116
COMPASS6_ALPS
#define COMPASS6_ALPS
Definition: compass6.h:117
application_init
void application_init(void)
Definition: main.c:31
compass6_cfg_setup
void compass6_cfg_setup(compass6_cfg_t *cfg)
Compass 6 configuration object setup function.
compass6_axes_t::y
int16_t y
Definition: compass6.h:201
compass6_t
Compass 6 Click context object.
Definition: compass6.h:155
COMPASS6_WHO_AM_I
#define COMPASS6_WHO_AM_I
Compass 6 identification value.
Definition: compass6.h:115
COMPASS6_MAP_MIKROBUS
#define COMPASS6_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: compass6.h:142