Library Description

This library provides generic functions for working with the Click board.

Key functions:

• void magneto5_reset( void ) - Used to software reset the sensor.
• float magneto5_getAxisValue(uint8_t axis, uint8_t maxResolution) - The function returns the calculated Gauss value.
• void magneto5_getAxisData( int16_t *axisBuffer, uint8_t maxResolution ) - Used for the reading of the raw axis data from registers.

Examples Description

The application is composed of three sections:

• System Initialization - Initializes I2C module.
• Application Initialization - Initializes driver init and set measurement mode and channel.
• Application Task - (code snippet) - Reads X / Y / Z data axis and logs to USBUART every 1 sec.

void applicationTask()
{
 X_axis = magneto5_getAxisValue( _MAGNETO5_AXIS_X, _MAGNETO5_CH3_12bits_1ms);
 Y_axis = magneto5_getAxisValue( _MAGNETO5_AXIS_Y, _MAGNETO5_CH3_12bits_1ms );
 Z_axis = magneto5_getAxisValue( _MAGNETO5_AXIS_Z, _MAGNETO5_CH3_12bits_1ms );

 FloatToStr( X_axis, writeText );
 mikrobus_logWrite( "-- X axis : ", _LOG_TEXT );
 mikrobus_logWrite( writeText, _LOG_LINE );

 FloatToStr( Y_axis, writeText );
 mikrobus_logWrite( "-- Y axis : ", _LOG_TEXT );
 mikrobus_logWrite( writeText, _LOG_LINE );

 FloatToStr( Z_axis, writeText );
 mikrobus_logWrite( "-- Z axis : ", _LOG_TEXT );
 mikrobus_logWrite( writeText, _LOG_LINE );

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

Other mikroE Libraries used in the example:

• Conversions
• I2C
• UART
• C_String Library

Additional notes and information

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.