TOP Contributors

  1. MIKROE (2784 codes)
  2. Alcides Ramos (405 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (133 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 (141317 times)
  2. FAT32 Library (74154 times)
  3. Network Ethernet Library (58737 times)
  4. USB Device Library (48834 times)
  5. Network WiFi Library (44544 times)
  6. FT800 Library (44117 times)
  7. GSM click (30857 times)
  8. mikroSDK (29699 times)
  9. PID Library (27359 times)
  10. microSD click (27273 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 8 Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.3

mikroSDK Library: 2.0.0.0

Category: Magnetic

Downloaded: 80 times

Not followed.

License: MIT license  

Compass 8 Click is a compact add-on board designed for precise compass applications. This board features the AK09919, a 3-axis electronic compass IC from AKM Semiconductor. The AK09919 is based on high-sensitivity Hall sensor technology for detecting terrestrial magnetism across the X, Y, and Z axes, has multiple operational modes, a built-in oscillator, and a Power On Reset circuit. It also includes a magnetic sensor overflow monitor and a 16-sample FIFO data buffer for efficient data handling.

No Abuse Reported

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

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

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

  • Information
  • Comments (0)

mikroSDK Library Blog


Compass 8 Click

Compass 8 Click is a compact add-on board designed for precise compass applications. This board features the AK09919, a 3-axis electronic compass IC from AKM Semiconductor. The AK09919 is based on high-sensitivity Hall sensor technology for detecting terrestrial magnetism across the X, Y, and Z axes, has multiple operational modes, a built-in oscillator, and a Power On Reset circuit. It also includes a magnetic sensor overflow monitor and a 16-sample FIFO data buffer for efficient data handling.

compass8_click.png

Click Product page


Click library

  • Author : Nenad Filipovic
  • Date : Feb 2024.
  • Type : I2C type

Software Support

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

Standard key functions :

  • compass8_cfg_setup Config Object Initialization function.

    void compass8_cfg_setup ( compass8_cfg_t *cfg );
  • compass8_init Initialization function.

    err_t compass8_init ( compass8_t *ctx, compass8_cfg_t *cfg );
  • compass8_default_cfg Click Default Configuration function.

    err_t compass8_default_cfg ( compass8_t *ctx );

Example key functions :

  • compass8_get_magnetic_data This function reads the raw magnetic sensor measurement data and calculates magnetic flux density [microTesla] using the I2C serial interface.

    err_t compass8_get_magnetic_data ( compass8_t *ctx, compass8_axes_t *axis );
  • compass8_set_operation_mode This function sets the desired sensor operation mode by using the I2C serial interface.

    err_t compass8_set_operation_mode ( compass8_t *ctx, uint8_t op_mode );
  • compass8_sw_reset This function performs software reset by using the I2C serial interface.

    err_t compass8_sw_reset ( compass8_t *ctx );

Example Description

This library contains API for the Compass 8 Click driver. The library initializes and defines the I2C drivers to write and read data from registers, as well as the default configuration for reading measurement data.

The demo application is composed of two sections :

Application Init

The initialization of the I2C module, log UART, and additional pins. After the driver init, the app executes a default configuration.

void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    compass8_cfg_t compass8_cfg;  /**< Click config object. */

    /** 
     * 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.
    compass8_cfg_setup( &compass8_cfg );
    COMPASS8_MAP_MIKROBUS( compass8_cfg, MIKROBUS_1 );
    if ( I2C_MASTER_ERROR == compass8_init( &compass8, &compass8_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }

    if ( COMPASS8_ERROR == compass8_default_cfg ( &compass8 ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }

    log_info( &logger, " Application Task " );
}

Application Task

This example demonstrates the use of the Compass 8 Click board. Measures and displays magnetic flux density in microtesla (uT) for X-axis, Y-axis, and Z-axis. Results are being sent to the UART Terminal, where you can track their changes.

void application_task ( void ) 
{
    compass8_axes_t axis; 
    if ( COMPASS8_OK == compass8_get_magnetic_data( &compass8, &axis ) ) 
    {
        log_printf( &logger, " X-axis: %.2f uT\r\n", axis.x );
        log_printf( &logger, " Y-axis: %.2f uT\r\n", axis.y );
        log_printf( &logger, " Z-axis: %.2f uT\r\n", axis.z );      
        log_printf( &logger,  "--------------------\r\n" );
        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.Compass8

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.


ALSO FROM THIS AUTHOR

STSPIN820 Click

0

STSPIN820 Click is a stepper motor driver with the PWM current control, selectable microstepping up to 256 microsteps, and a wide voltage range. It is based on the STSPIN820, a stepper motor driver from STSPIN8 series. Designed to be a bullet-proof solution for the new wave of demanding industrial applications, it integrates two full-bridges with low ON resistance, the control logic, and a full set of protection features, in a small 4x4mm QFN package. Its output stage implements the PWM current control with the fixed OFF time. The device can be used with the step motor voltage ranging from 7V up to 45V, and current up to 1.5A per bridge.

[Learn More]

Wireless Stepper Motor Control

6

This is a simple demonstration of using nRF and Stepper click boards for wirelessly controlling the stepper motor. Master module sends command to the slave (ON, OFF, DIRECTION, 1 step, 1/2 step, 1/4 step and 1/8 step). Upon reception, slave processes this command and drives stepper motor.

[Learn More]

DC Motor 8 Click

0

DC Motor 8 Click is a DC motor driver. It can drive simple DC motors with brushes, providing them with a significant amount of current and voltage up to 40V. The Click has one control input, that uses the PWM signal from the host MCU. It uses the half-bridge topology to regulate the speed of the motor rotation, employs advanced dead-time circuitry that monitors the output stage, providing maximum switching efficiency and features an advanced technique to avoid shoot-through currents.

[Learn More]