compass5  2.0.0.0
Main Page

Compass 5 click

Compass 5 Click is a compact add-on board that contains a 3-axis magnetometer device suitable for compass application. This board features the AK09918C, a 3-axis electronic compass with high sensitive Hall sensor technology from AKM Semiconductor.

click Product page


Click library

  • Author : Jelena Milosavljevic
  • Date : Jul 2021.
  • Type : I2C type

Software Support

We provide a library for the Compass5 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 Compass5 Click driver.

Standard key functions :

Example key functions :

Example Description

This is an example that demonstrates the use of Compass 5 Click board that reads data

from magnetic sensors for X, Y, and Z axes,processes it and displays it via the UART terminal.

The demo application is composed of two sections :

Application Init

Initializes I2C and starts to write log, performs power down mode, sets continuous measurement mode; also write log.

void application_init ( void ) {
log_cfg_t log_cfg;
compass5_cfg_t compass5_cfg;
// Logger initialization.
LOG_MAP_USB_UART( log_cfg );
log_cfg.level = LOG_LEVEL_DEBUG;
log_cfg.baud = 115200;
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
Delay_ms( 100 );
// Click initialization.
compass5_cfg_setup( &compass5_cfg );
COMPASS5_MAP_MIKROBUS( compass5_cfg, MIKROBUS_1 );
err_t init_flag = compass5_init( &compass5, &compass5_cfg );
if ( I2C_MASTER_ERROR == init_flag ) {
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
compass5_sw_reset( &compass5 );
Delay_ms( 500 );
log_printf( &logger, "--------------------\r\n" );
log_printf( &logger, " Compass 3 click \r\n" );
log_printf( &logger, "--------------------\r\n" );
}
else {
log_printf( &logger, " Fatal error!!! \r\n" );
for ( ; ; );
}
Delay_ms( 100 );
log_printf( &logger, " Power Down Mode \r\n" );
log_printf( &logger, "-------------------\r\n" );
Delay_ms( 100 );
log_printf( &logger, " Continuous \r\n" );
log_printf( &logger, " Measurement Mode \r\n" );
log_printf( &logger, "-------------------\r\n" );
Delay_ms( 100 );
log_printf( &logger, " Start Measurement \r\n" );
log_printf( &logger, "-------------------\r\n" );
Delay_ms( 100 );
log_info( &logger, " Application Task " );
}

Application Task

When Compass 5 click is connected to a mikroBUS, this example collects data on the current position of the X,

Y and Z axes via I2C communication, processes and displays the data via the UART terminal. All axis data is printed every 2 seconds.

void application_task ( void ) {
int16_t x_val;
int16_t y_val;
int16_t z_val;
compass5_measurement_axis( &compass5, &x_val, &y_val, &z_val );
Delay_ms( 10 );
log_printf( &logger, " X-axis: %d mG\r\n", x_val );
log_printf( &logger, " Y-axis: %d mG\r\n", y_val );
log_printf( &logger, " Z-axis: %d mG\r\n", z_val );
log_printf( &logger, "--------------------\r\n" );
}
Delay_ms( 2000 );
}

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.Compass5

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.


compass5_check_data_ready
uint8_t compass5_check_data_ready(compass5_t *ctx)
Compass 5 check data ready function.
compass5_read_byte
uint8_t compass5_read_byte(compass5_t *ctx, uint8_t reg)
Compass 5 read 1 byte function.
compass5_cfg_t
Compass 5 Click configuration object.
Definition: compass5.h:198
COMPASS5_MODE_POWER_DOWN
#define COMPASS5_MODE_POWER_DOWN
Compass 5 description setting operation mode.
Definition: compass5.h:119
compass5_set_operation_mode
uint8_t compass5_set_operation_mode(compass5_t *ctx, uint8_t op_mode)
Compass 5 set operation mode function.
application_task
void application_task(void)
Definition: main.c:87
compass5_get_id
void compass5_get_id(compass5_t *ctx, uint8_t *company_id, uint8_t *device_id)
Compass 5 get ID function.
COMPASS5_DEVICE_ID_NUM
#define COMPASS5_DEVICE_ID_NUM
Compass 5 description register.
Definition: compass5.h:64
device_id
uint8_t device_id
Definition: main.c:28
compass5_sw_reset
void compass5_sw_reset(compass5_t *ctx)
Compass 5 software reset function.
COMPASS5_MAP_MIKROBUS
#define COMPASS5_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: compass5.h:172
COMPASS5_DATA_READY
#define COMPASS5_DATA_READY
Definition: compass5.h:141
application_init
void application_init(void)
Definition: main.c:32
COMPASS5_MODE_CON_MEASUREMENT_100HZ
#define COMPASS5_MODE_CON_MEASUREMENT_100HZ
Definition: compass5.h:124
compass5_cfg_setup
void compass5_cfg_setup(compass5_cfg_t *cfg)
Compass 5 configuration object setup function.
compass5_t
Compass 5 Click context object.
Definition: compass5.h:184
compass5_measurement_axis
void compass5_measurement_axis(compass5_t *ctx, int16_t *axis_x, int16_t *axis_y, int16_t *axis_z)
Compass 5 full measurement axis function.
compass5_write_byte
void compass5_write_byte(compass5_t *ctx, uint8_t reg, uint8_t tx_data)
Compass 5 write byte function.
company_id
uint8_t company_id
Definition: main.c:29
COMPASS5_COMPANI_ID_NUM
#define COMPASS5_COMPANI_ID_NUM
Definition: compass5.h:65
compass5_init
err_t compass5_init(compass5_t *ctx, compass5_cfg_t *cfg)
Compass 5 initialization function.