Library Description

The library contains a basic functions for using Compass 5 Click.

Key functions:

• void compass5_get_id ( uint8_t *company_id, uint8_t *device_id ); - Function for get ID.
• uint8_t compass5_set_operation_mode ( uint8_t op_mode ); - Function for set operation mode.
• void compass5_get_mag_data ( int16_t *axis_x, int16_t *axis_y, int16_t *axis_z ); - Full measurement axis.

Examples description

The application is composed of three sections :

• System Initialization - Initializes I2C and start to write log.
• Application Initialization - Initialization driver enables - I2C, performed power down mode, sets continuous measurement mode and start measurement, also write log.
• Application Task - (code snippet) - This is an example which demonstrates the use of Compass 5 Click board™. Measured and display sensor Magnetic data for X-axis, Y-axis and Z-axis. Results are being sent to the Usart Terminal where you can track their changes. All data logs write on USB uart changes for every 2 sec.

void application_task ( )
{
    int16_t x_val;
    int16_t y_val;
    int16_t z_val;
    
    if ( compass5_check_data_ready( ) == COMPASS5_DATA_READY )
    {
        compass5_measurement_axis( &x_val, &y_val, &z_val );
        Delay_ms( 10 );
    
        FloatToStr( x_val, log_txt );
        mikrobus_logWrite( " X-axis: ", _LOG_TEXT );
        mikrobus_logWrite( log_txt, _LOG_TEXT );
        mikrobus_logWrite( "mG", _LOG_LINE );
        FloatToStr( y_val, log_txt );
        mikrobus_logWrite( " Y-axis: ", _LOG_TEXT );
        mikrobus_logWrite( log_txt, _LOG_TEXT );
        mikrobus_logWrite( "mG", _LOG_LINE );
        FloatToStr( z_val, log_txt );
        mikrobus_logWrite( " Z-axis: ", _LOG_TEXT );
        mikrobus_logWrite( log_txt, _LOG_TEXT );
        mikrobus_logWrite( "mG", _LOG_LINE );
        
        mikrobus_logWrite( "--------------------", _LOG_LINE );
    }
    Delay_ms( 2000 );
}

Other mikroE Libraries used in the example:

• I2C Library
• UART Library

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.