Library Description

This library holds functions that can be used to read, write and measure magnetic field and temperature.

Key functions:

• void compass3_write_byte ( uint8_t reg_adr, uint8_t data_in ); - Writes 8-bit data into register defined by 8-bit register address.
• void compass3_full_measurement ( float *x_val, float *y_val, float *z_val ); - Measures magnetic field surrounding the device.
• float compass3_read_temp ( ); - Function is used to measure temperature.

Examples description

The application is composed of three sections :

• System Initialization - Initializes I2C module, LOG and GPIO structures, sets INT pin as input.
• Application Initialization - Initalizes I2C driver, applies default setup and writes an initial log.
• Application Task - (code snippet) This example demonstrates the use of Compass 3 Click board by measuring the magnetic field surrounding the device.

void application_task ( )
{
    if( compass3_check_int () == COMPASS3_INTERRUPT )
    {
        compass3_full_measurement ( &x_val, &y_val, &z_val );

        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 );

        Delay_ms( 1000 );
        mikrobus_logWrite( "--------------------", _LOG_LINE );
    }
}

Other mikroE Libraries used in the example:

• I2C
• UART
• Conversions

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.