TOP Contributors

  1. MIKROE (2762 codes)
  2. Alcides Ramos (374 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (118 codes)
  5. Bugz Bensce (90 codes)
  6. S P (73 codes)
  7. dany (71 codes)
  8. MikroBUS.NET Team (35 codes)
  9. NART SCHINACKOW (34 codes)
  10. Armstrong Subero (27 codes)

Most Downloaded

  1. Timer Calculator (139254 times)
  2. FAT32 Library (71751 times)
  3. Network Ethernet Library (57122 times)
  4. USB Device Library (47430 times)
  5. Network WiFi Library (43082 times)
  6. FT800 Library (42404 times)
  7. GSM click (29835 times)
  8. mikroSDK (28078 times)
  9. PID Library (26885 times)
  10. microSD click (26198 times)
Libstock prefers package manager

Package Manager

We strongly encourage users to use Package manager for sharing their code on Libstock website, because it boosts your efficiency and leaves the end user with no room for error. [more info]

< Back
mikroSDK Library

Compass 3 Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.15

mikroSDK Library: 2.0.0.0

Category: Magnetic

Downloaded: 202 times

Not followed.

License: MIT license  

Compass 3 Click is an expansion board that can measure the three-axis magnetic field which is perfect for implementation in applications such as electric compasses. This board features MMC5883MA, a complete 3-axis magnetic sensor with signal processing from MEMSIC.

No Abuse Reported

Do you want to subscribe in order to receive notifications regarding "Compass 3 Click" changes.

Do you want to unsubscribe in order to stop receiving notifications regarding "Compass 3 Click" changes.

Do you want to report abuse regarding "Compass 3 Click".

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


Compass 3 Click

Compass 3 Click is an expansion board that can measure the three-axis magnetic field which is perfect for implementation in applications such as electric compasses. This board features MMC5883MA, a complete 3-axis magnetic sensor with signal processing from MEMSIC.

compass3_click.png

Click Product page


Click library

  • Author : Jovan Stajkovic
  • Date : Jan 2020.
  • Type : I2C type

Software Support

We provide a library for the Compass3 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for Compass3 Click driver.

Standard key functions :

  • Config Object Initialization function.

    void compass3_cfg_setup ( compass3_cfg_t *cfg );

  • Initialization function.

    COMPASS3_RETVAL compass3_init ( compass3_t ctx, compass3_cfg_t cfg );

  • Click Default Configuration function.

    void compass3_default_cfg ( compass3_t *ctx );

Example key functions :

  • Measures magnetic field surrounding the device.

    void compass3_full_measurement ( compass3_t ctx, float x_val, float y_val, float z_val );

  • Function is used to measure temperature.

    float compass3_read_temp ( compass3_t *ctx );

  • Function checks interrupt occurence.

    uint8_t compass3_check_int ( compass3_t *ctx );

Examples Description

This demoapp measures the magnetic field surrounding the device.

The demo application is composed of two sections :

Application Init

Initalizes I2C driver and Click driver, performs check, applies default setup and writes an initial log.


void application_init ( void )
{
    log_cfg_t log_cfg;
    compass3_cfg_t cfg;

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_printf( &logger, "---- Application Init ----\r\n" );

    //  Click initialization.

    compass3_cfg_setup( &cfg );
    COMPASS3_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    compass3_init( &compass3, &cfg );
    Delay_ms ( 100 );

    compass3_generic_read( &compass3, COMPASS3_DEVICE_ID, &test_val, 1 );

    if ( test_val == COMPASS3_DEVICE_ID_NUM )
    {
        log_printf( &logger, "--------------------\r\n" );
        log_printf( &logger, "   Compass 3 Click  \r\n" );
        log_printf( &logger, "--------------------\r\n" );
    }
    else
    {
        log_printf( &logger, "   Fatal error!!!   \r\n" );
        for ( ; ; );
    }

    compass3_default_cfg ( &compass3 );
    Delay_ms ( 100 );
}

Application Task

This example demonstrates the use of Compass 3 Click board by measuring the magnetic field surrounding the device.


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

        log_printf( &logger,"  X-axis : %2.f mG\r\n", x_val );
        log_printf( &logger,"  Y-axis : %2.f mG\r\n", y_val );
        log_printf( &logger,"  Z-axis : %2.f mG\r\n", z_val );

        Delay_ms ( 1000 );
        log_printf( &logger, "--------------------\r\n" );
    }
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Compass3

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.


ALSO FROM THIS AUTHOR

RS232 2 click

5

RS232 2 click performs full RS232 to UART signal conversion, allowing both 3.3V and 5V operation. Additionally, it features ±15 kV ESD protection for the RS-232 I/O pins.

[Learn More]

ISO ADC 2 click

5

ISO ADC 2 Click is a compact add-on board that represents a completely isolated 12-bit, 300 kSPS data acquisition system. This board features the AD7091R, successive-approximation analog-to-digital converter (ADC) from Analog Devices.

[Learn More]

3D Hall 11 Click

0

3D Hall 11 Click is a compact add-on board used to detect the strength of a magnetic field in all three dimensions. This board features the TMAG5273, a low-power linear 3D Hall-effect sensor from Texas Instruments. A precision analog signal chain alongside an integrated 12-bit ADC digitizes the measured analog magnetic field values and passes them via the I2C interface to the microcontroller for further processing. It can achieve ultra-high precision at speeds up to 20kSPS for faster and more accurate real-time control and has an integrated temperature sensor available for multiple system functions.

[Learn More]