Library Description

The library contains a basic functions for using Compass 4 click.

Key functions:

• void compass4_configuration ( uint8_t cfg1, uint8_t cfg2 ) - Configuration function
• uint8_t compass4_get_axis ( compass4_axis_t *axis ) - Gets XYZ Axis value
• uint8_t compass4_get_magnetic_flux ( compass4_flux_t *flux ) - Gets magnetic flux of XYZ axis value

Examples description

The application is composed of three sections :

• System Initialization - Initializes I2C or SPI module and all necessary GPIO pins
• Application Initialization - Initializes driver inti, reset module, configuration module for measurement and cheeks communication with the module.
• Application Task - Reads magnetic flux or x, y, z-axis, and logs data to USB UART every 1 second.
• Note - SPI communication only works when the jumpers for the slave address are at GND.

void application_task ( )
{
    compass4_flux_t flux;
    char demo_text[ 20 ];
    uint8_t err;
    
    err = compass4_get_magnetic_flux( &flux );
    if ( err != 0 )
    {
        mikrobus_logWrite( ">> Measurement error ", _LOG_LINE );
    }
    else
    {
        mikrobus_logWrite( ">> Magnetic flux data <<", _LOG_LINE );
        FloatToStr( flux.x, demo_text );
        mikrobus_logWrite( ">> X: ", _LOG_TEXT );
        mikrobus_logWrite( demo_text, _LOG_LINE );

        FloatToStr( flux.y, demo_text );
        mikrobus_logWrite( ">> Y: ", _LOG_TEXT );
        mikrobus_logWrite( demo_text, _LOG_LINE );

        FloatToStr( flux.z, demo_text );
        mikrobus_logWrite( ">> Z: ", _LOG_TEXT );
        mikrobus_logWrite( demo_text, _LOG_LINE );
    }
    mikrobus_logWrite( ">>____________________<<", _LOG_LINE );
    Delay_ms( 1000 );
}

Other mikroE Libraries used in the example:

• I2C Library
• SPI Library
• Conversions 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.