compass7  2.0.0.0
Main Page

Compass 7 Click

Compass 7 Click is a compact add-on board perfect for applications like an electronic compass. This board features the MMC5633NJL, a monolithic complete 3-axis AMR magnetic sensor with on-chip signal processing and an integrated digital bus from MEMSIC. It can measure magnetic fields within the full-scale range of ±30 Gauss (G) with up to 0.0625mG per LSB resolution at 20bits operation mode and 2mG total RMS noise level, enabling heading accuracy of ±1º in electronic compass applications. Also, an integrated SET/RESET function eliminates thermal variation-induced offset error (Null field output) and clears the residual magnetization resulting from powerful external fields.

Click Product page


Click library

  • Author : Stefan Filipovic
  • Date : Jun 2022.
  • Type : I2C type

Software Support

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

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of Compass 7 Click board by reading and displaying the magnetic field strength of 3-axis as well as the temperature measurements in Celsius.

The demo application is composed of two sections :

Application Init

Initializes the driver and performs the Click default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
compass7_cfg_t compass7_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
compass7_cfg_setup( &compass7_cfg );
COMPASS7_MAP_MIKROBUS( compass7_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == compass7_init( &compass7, &compass7_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( COMPASS7_ERROR == compass7_default_cfg ( &compass7 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Starts the single magnetic measurement and reads the magnetic field strength of 3-axis in Gauss, then starts the temperature measurement and reads the temperature in Celsius.

The results are being displayed on the USB UART every 100ms approximately.

void application_task ( void )
{
compass7_magnetic_flux_t magnetic_flux;
float temperature;
( COMPASS7_OK == compass7_get_magnetic_flux ( &compass7, &magnetic_flux ) ) )
{
log_printf ( &logger, " X: %.2f G\r\n", magnetic_flux.x_axis );
log_printf ( &logger, " Y: %.2f G\r\n", magnetic_flux.y_axis );
log_printf ( &logger, " Z: %.2f G\r\n", magnetic_flux.z_axis );
}
( COMPASS7_OK == compass7_get_temperature ( &compass7, &temperature ) ) )
{
log_printf ( &logger, " Temperature: %.2f C\r\n\n", temperature );
}
Delay_ms ( 100 );
}

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

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.


compass7_magnetic_flux_t::x_axis
float x_axis
Definition: compass7.h:281
compass7_cfg_t
Compass 7 Click configuration object.
Definition: compass7.h:266
COMPASS7_MAP_MIKROBUS
#define COMPASS7_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: compass7.h:240
compass7_default_cfg
err_t compass7_default_cfg(compass7_t *ctx)
Compass 7 default configuration function.
compass7_get_temperature
err_t compass7_get_temperature(compass7_t *ctx, float *temperature)
Compass 7 get temperature function.
application_task
void application_task(void)
Definition: main.c:66
COMPASS7_OK
@ COMPASS7_OK
Definition: compass7.h:293
compass7_magnetic_flux_t::z_axis
float z_axis
Definition: compass7.h:283
compass7_init
err_t compass7_init(compass7_t *ctx, compass7_cfg_t *cfg)
Compass 7 initialization function.
compass7_get_magnetic_flux
err_t compass7_get_magnetic_flux(compass7_t *ctx, compass7_magnetic_flux_t *flux)
Compass 7 get magnetic flux function.
compass7_cfg_setup
void compass7_cfg_setup(compass7_cfg_t *cfg)
Compass 7 configuration object setup function.
compass7_magnetic_flux_t::y_axis
float y_axis
Definition: compass7.h:282
application_init
void application_init(void)
Definition: main.c:30
compass7_magnetic_flux_t
Compass 7 magnetic flux data object.
Definition: compass7.h:280
COMPASS7_MEAS_SINGLE_T
#define COMPASS7_MEAS_SINGLE_T
Compass 7 measurement mode settings.
Definition: compass7.h:201
compass7_t
Compass 7 Click context object.
Definition: compass7.h:252
compass7_set_measurement_mode
err_t compass7_set_measurement_mode(compass7_t *ctx, uint8_t mode)
Compass 7 set measurement mode function.
COMPASS7_ERROR
@ COMPASS7_ERROR
Definition: compass7.h:294
COMPASS7_MEAS_SINGLE_M
#define COMPASS7_MEAS_SINGLE_M
Definition: compass7.h:202