TOP Contributors

  1. MIKROE (2784 codes)
  2. Alcides Ramos (393 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (123 codes)
  5. Bugz Bensce (97 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 (140561 times)
  2. FAT32 Library (73061 times)
  3. Network Ethernet Library (58070 times)
  4. USB Device Library (48249 times)
  5. Network WiFi Library (43842 times)
  6. FT800 Library (43326 times)
  7. GSM click (30367 times)
  8. mikroSDK (29002 times)
  9. PID Library (27120 times)
  10. microSD click (26742 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 2 Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.16

mikroSDK Library: 2.0.0.0

Category: Magnetic

Downloaded: 237 times

Not followed.

License: MIT license  

Compass 2 Click carries the AK8963 3-axis electronic compass. The AK8963 sensor is based on the Hall effect.

No Abuse Reported

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

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

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

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


Compass 2 Click

Compass 2 Click carries the AK8963 3-axis electronic compass. The AK8963 sensor is based on the Hall effect.

compass2_click.png

Click Product page


Click library

  • Author : MikroE Team
  • Date : Dec 2019.
  • Type : I2C/SPI type

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    void compass2_cfg_setup ( compass2_cfg_t *cfg );

  • Initialization function.

    COMPASS2_RETVAL compass2_init ( compass2_t ctx, compass2_cfg_t cfg );

  • Click Default Configuration function.

    void compass2_default_cfg ( compass2_t *ctx );

Example key functions :

  • This function gets the data from one specified axis.

    int16_t compass2_get_axis_data ( compass2_t *ctx, uint8_t axis );

  • This function prepares the device for a new measurement.

    void compass2_new_measurement ( compass2_t *ctx );

  • This function does a hardware reset of the device.

    void compass2_reset ( compass2_t *ctx );

Examples Description

The example prepares the device for a new measurement and reads and displays data from all three axes.

The demo application is composed of two sections :

Application Init

Initializes and configures the Click and logger modules.


void application_init ( )
{
    log_cfg_t log_cfg;
    compass2_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_info( &logger, "---- Application Init ----" );

    //  Click initialization.

    compass2_cfg_setup( &cfg );
    COMPASS2_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    compass2_init( &compass2, &cfg );
    compass2_default_cfg( &compass2 );
}

Application Task

Reads and displays data from all three axes every two seconds.


void application_task ( )
{
    int16_t x_axis;
    int16_t y_axis;
    int16_t z_axis;

    compass2_new_measurement( &compass2 );

    log_printf( &logger, " --- Axis ---\r\n" );

    x_axis = compass2_get_axis_data( &compass2, COMPASS2_X_AXIS );
    y_axis = compass2_get_axis_data( &compass2, COMPASS2_Y_AXIS );
    z_axis = compass2_get_axis_data( &compass2, COMPASS2_Z_AXIS );

    log_printf( &logger, "X: %d\r\n", x_axis );
    log_printf( &logger, "Y: %d\r\n", y_axis );
    log_printf( &logger, "Z: %d\r\n", z_axis );

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

    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
}  

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

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

TMR mix-sens Click

0

The TMR mix-sens Click has three types of magnetic field sensors: Two digital and one analog sensor.

[Learn More]

Button 3 Click

0

Button 3 Click is a compact add-on board for precise and reliable tactile input detection. This board features three TL3215 series tactile switches from E-Switch, known for their high reliability and consistent performance. Each switch has a 2mm actuator, 160gf actuation force, and a silver contact material for excellent conductivity and durability. The integrated LED provides clear visual feedback, and the board supports the new Click Snap feature, allowing the main sensor area to become movable by breaking the PCB for flexible implementation.

[Learn More]

RTC 2 click

0

Example for RTC2 click board in mikroBUS form factor. It is a simple demonstration how to read/write date and time from DS1307 RTC (real-time clock). Date and time are read from the RTC every 10 milliseconds and printed on LCD. Communication with the board is done via I2C interface.

[Learn More]