Beginner
10 min
0

Discover new directions with AK8963 and STM32F732IE

Chart your course with eCompass innovation

Compass 2 Click with Fusion for STM32 v8

Published Sep 13, 2023

Click board™

Compass 2 Click

Development board

Fusion for STM32 v8

Compiler

NECTO Studio

MCU

STM32F732IE

Experience the future of direction-finding with our electronic compass technology. It offers precision and responsiveness, making it an essential tool for applications based on position detection, navigation, and orientation.

A

A

Hardware Overview

How does it work?

Compass 2 Click is based on the AK8963, a 3-axis electronic compass from AKM Semiconductor. This electronic compass includes an A/D converter for magnetometer data output in two selectable resolutions. The sensitivity for 14-bit resolution is typically 0.6μT/LSB, while for 16-bit, it is typically 0.15μT/LSB. Some other functions built into this electronic compass are a power-on reset circuit, a data-ready indicator, a magnetic sensor overflow monitor function, a self-test function for a built-in internal magnetic source, and very low power consumption. The AK8963 has several operating modes. All internal circuits are turned off in Power-down mode while all registers are accessible (fuse ROM data cannot be read correctly). In Signal measurement mode, the sensor is measured, and data is processed. The Continuous measurement

mode differs from the Single measurement because the sensor is measured periodically at 8Hz or 100Hz, after which the data is processed. The third measurement mode is an External trigger measurement that will start after the AK8963 gets a trigger input. To check if the sensor is working normally, AK8963 uses the Self-test mode. This test the AK8963 achieves by generating a magnetic field by its internal magnetic source, and then the sensor is measured. The last is the Fuse ROM access mode, which reads Fuse ROM data (sensitivity adjustment data for each axis). This Click board™ allows the use of both I2C and SPI interfaces. Selection is made by positioning SMD jumpers marked SPI I2C to the appropriate position. All jumpers must be on the same side, or the Click

board™ may become unresponsive. When the I2C interface is selected, the AK8963 allows the choice of its I2C address, using the ADDR SEL SMD jumper set to an appropriate position marked 1 or 0. In addition to the general reset function (RST pin), there is also the INT pin used as an interrupt signal to tell the host MCU about the status of the AK8963, and the TRG pin which serves as a trigger pin to make the AK8963 to enter the External Trigger measurement mode. This Click board™ can be operated only with a 3.3V logic voltage level. The board must perform appropriate logic voltage level conversion before using MCUs with different logic levels. Also, it comes equipped with a library containing functions and an example code that can be used as a reference for further development.

Compass 2 Click top side image
Compass 2 Click bottom side image

Features overview

Development board

Fusion for STM32 v8 is a development board specially designed for the needs of rapid development of embedded applications. It supports a wide range of microcontrollers, such as different 32-bit ARM® Cortex®-M based MCUs from STMicroelectronics, regardless of their number of pins, and a broad set of unique functions, such as the first-ever embedded debugger/programmer over WiFi. The development board is well organized and designed so that the end-user has all the necessary elements, such as switches, buttons, indicators, connectors, and others, in one place. Thanks to innovative manufacturing technology, Fusion for STM32 v8 provides a fluid and immersive working experience, allowing

access anywhere and under any circumstances at any time. Each part of the Fusion for STM32 v8 development board contains the components necessary for the most efficient operation of the same board. An advanced integrated CODEGRIP programmer/debugger module offers many valuable programming/debugging options, including support for JTAG, SWD, and SWO Trace (Single Wire Output)), and seamless integration with the Mikroe software environment. Besides, it also includes a clean and regulated power supply module for the development board. It can use a wide range of external power sources, including a battery, an external 12V power supply, and a power source via the USB Type-C (USB-C) connector.

Communication options such as USB-UART, USB HOST/DEVICE, CAN (on the MCU card, if supported), and Ethernet is also included. In addition, it also has the well-established mikroBUS™ standard, a standardized socket for the MCU card (SiBRAIN standard), and two display options for the TFT board line of products and character-based LCD. Fusion for STM32 v8 is an integral part of the Mikroe ecosystem for rapid development. Natively supported by Mikroe software tools, it covers many aspects of prototyping and development thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

Fusion for STM32 v8 horizontal image

Microcontroller Overview

MCU Card / MCU

default

Type

8th Generation

Architecture

ARM Cortex-M7

MCU Memory (KB)

512

Silicon Vendor

STMicroelectronics

Pin count

176

RAM (Bytes)

262144

Used MCU Pins

mikroBUS™ mapper

External Trigger Pulse
PF3
AN
Reset
PI9
RST
SPI Chip Select
PC3
CS
SPI Clock
PI1
SCK
SPI Data OUT
PI2
MISO
SPI Data IN
PI3
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
NC
NC
PWM
Interrupt
PA4
INT
NC
NC
TX
NC
NC
RX
I2C Clock
PF1
SCL
I2C Data
PF0
SDA
NC
NC
5V
Ground
GND
GND
1

Take a closer look

Schematic

Compass 2 Click Schematic schematic

Step by step

Project assembly

Fusion for PIC v8 front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Fusion for STM32 v8 as your development board.

Fusion for PIC v8 front image hardware assembly
Buck 22 Click front image hardware assembly
SiBRAIN for PIC32MZ1024EFK144 front image hardware assembly
v8 SiBRAIN MB 1 - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
NECTO Compiler Selection Step Image hardware assembly
NECTO Output Selection Step Image hardware assembly
Necto image step 6 hardware assembly
Necto image step 7 hardware assembly
Necto image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Necto PreFlash Image hardware assembly

Track your results in real time

Application Output

After pressing the "FLASH" button on the left-side panel, it is necessary to open the UART terminal to display the achieved results. By clicking on the Tools icon in the right-hand panel, multiple different functions are displayed, among which is the UART Terminal. Click on the offered "UART Terminal" icon.

UART Application Output Step 1

Once the UART terminal is opened, the window takes on a new form. At the top of the tab are two buttons, one for adjusting the parameters of the UART terminal and the other for connecting the UART terminal. The tab's lower part is reserved for displaying the achieved results. Before connecting, the terminal has a Disconnected status, indicating that the terminal is not yet active. Before connecting, it is necessary to check the set parameters of the UART terminal. Click on the "OPTIONS" button.

UART Application Output Step 2

In the newly opened UART Terminal Options field, we check if the terminal settings are correct, such as the set port and the Baud rate of UART communication. If the data is not displayed properly, it is possible that the Baud rate value is not set correctly and needs to be adjusted to 115200. If all the parameters are set correctly, click on "CONFIGURE".

UART Application Output Step 3

The next step is to click on the "CONNECT" button, after which the terminal status changes from Disconnected to Connected in green, and the data is displayed in the Received data field.

UART Application Output Step 4

Software Support

Library Description

This library contains API for Compass 2 Click driver.

Key functions:

  • compass2_get_axis_data - This function gets the data from one specified axis

  • compass2_new_measurement - This function prepares the device for a new measurement

  • compass2_reset - This function does a hardware reset of the device.

Open Source

Code example

This example can be found in NECTO Studio. Feel free to download the code, or you can copy the code below.

/*!
 * \file 
 * \brief Comass2 Click example
 * 
 * # 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.
 * 
 * ## Application Task  
 * Reads and displays data from all three axes every two seconds.
 * 
 * \author MikroE Team
 *
 */
// ------------------------------------------------------------------- INCLUDES

#include "board.h"
#include "log.h"
#include "compass2.h"

// ------------------------------------------------------------------ VARIABLES

static compass2_t compass2;
static log_t logger;

// ------------------------------------------------------ APPLICATION FUNCTIONS

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_reset( &compass2 );
    Delay_ms( 100 );

    compass2_default_cfg( &compass2 );
    Delay_ms( 100 );
}

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( 2000 );
}

void main ( )
{
    application_init( );

    for ( ; ; )
    {
        application_task( );
    }
}

// ------------------------------------------------------------------------ END

Additional Support

Resources