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 (141240 times)
  2. FAT32 Library (74040 times)
  3. Network Ethernet Library (58675 times)
  4. USB Device Library (48785 times)
  5. Network WiFi Library (44490 times)
  6. FT800 Library (44034 times)
  7. GSM click (30784 times)
  8. mikroSDK (29625 times)
  9. PID Library (27347 times)
  10. microSD click (27232 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 Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.17

mikroSDK Library: 2.0.0.0

Category: Magnetic

Downloaded: 408 times

Not followed.

License: MIT license  

Compass Click is an add-on board in mikroBUS form factor. It features LSM303DLHC ultra compact high performance e-compass module.

No Abuse Reported

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

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

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

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


Compass Click

Compass Click is an add-on board in mikroBUS form factor. It features LSM303DLHC ultra compact high performance e-compass module.

compass_click.png

Click Product page


Click library

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

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    void compass_cfg_setup ( compass_cfg_t *cfg );

  • Initialization function.

    COMPASS_RETVAL compass_init ( compass_t ctx, compass_cfg_t cfg );

  • Click Default Configuration function.

    void compass_default_cfg ( compass_t *ctx );

Example key functions :

  • This function reads data for megnetic axes.

    void compass_read_magnet_axis ( compass_t ctx, int16_t x_axis, int16_t y_axis, int16_t z_axis );

  • This function reads data for accelerometer axes.

    void compass_read_accel_axis ( compass_t ctx, int16_t x_axis, int16_t y_axis, int16_t z_axis );

  • This function writes magnet data to the desired register.

    void compass_magnet_generic_write ( compass_t ctx, uint8_t reg, uint8_t data_buf, uint8_t len );

Examples Description

This application measures magnetic and accelerometer axes data and shows them over USBUART

The demo application is composed of two sections :

Application Init

Initialization driver init and init chip


void application_init ( void )
{
    log_cfg_t log_cfg;
    compass_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 ----\r\n" );
    //  Click initialization.

    compass_cfg_setup( &cfg );
    COMPASS_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    compass_init( &compass, &cfg );
    compass_default_config( &compass );
}

Application Task

Read magnet axis data and accel axis data and logs data on USBUART every 1 sec.

void application_task ( void )
{
    int16_t accel_axis[ 3 ];
    int16_t magnet_axis[ 3 ];

    compass_read_magnet_axis( &compass, &magnet_axis[ 0 ], &magnet_axis[ 1 ], &magnet_axis[ 2 ] );
    log_printf( &logger, "Magnet axis -- X: %d Y: %d  Z: %d \r\n", magnet_axis[ 0 ], magnet_axis[ 1 ], magnet_axis[ 2 ] );

    compass_read_accel_axis ( &compass, &accel_axis[ 0 ], &accel_axis[ 1 ], &accel_axis[ 2 ] );
    log_printf( &logger, "Magnet axis -- X: %d Y: %d  Z: %d \r\n", accel_axis[ 0 ], accel_axis[ 1 ], accel_axis[ 2 ] );

    log_printf( &logger, " \r\n");
    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.Compass

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 SPI click

5

RS232 SPI click is based around the MAX3100, a universal universal asynchronous receiver transmitter (UART) - the first UART specifically optimized for small microcontroller-based systems, from Maxim Integrated.

[Learn More]

LTE Cat.4 Click

0

LTE Cat.4 Click (for Europe) is a compact add-on board made specially for 4G M2M and IoT applications in Europe. This board features the EG95EXGA-128-SGNS, an IoT/M2M-optimized LTE Cat.4 module that meets the 3GPP Release 11 standard from Quectel. It supports multiple wireless standards, including LTE-FDD, WCDMA, and GSM, ensuring broad network compatibility. Key features include multi-band LTE support (B1/B3/B7/B8/B20/B28), RX diversity for bands B1 and B8, and multi-constellation GNSS (GPS, GLONASS, BeiDou/Compass, Galileo, QZSS). It also integrates a 16-bit mono audio codec for voice functionality with support for CTIA standard headphones. Additionally, it offers a USB Type C connector for power and data transfer, AT command communication, and firmware upgrades.

[Learn More]

UART MUX 4 Click

0

UART MUX 4 Click is a compact add-on board that switches the UART pins (RX and TX) from the mikroBUS™ socket to one of the two available outputs. This board features the 74HC4066D, a quad single-pole, single-throw analog switch from Nexperia. The UART MUX 4 Click allows you to switch from one multiplexed UART to another easily, but not both simultaneously.

[Learn More]