Intermediate
30 min

Achieve accurate and real-time positioning of objects in three-dimensional space with MLX90380 and STM32F031K6

Magnetism mapped: 3D Hall sensor, your spatial intelligence

3D Hall 6 Click with Nucleo 32 with STM32F031K6 MCU

Published Oct 01, 2024

Click board™

3D Hall 6 Click

Dev. board

Nucleo 32 with STM32F031K6 MCU

Compiler

NECTO Studio

MCU

STM32F031K6

Harness the power of 3D magnetic sensors to fortify your home's security, ensuring peace of mind with real-time intrusion detection and comprehensive surveillance.

A

A

Hardware Overview

How does it work?

3D Hall 6 Click is based on the MLX90380, a monolithic contactless sensor IC sensitive to the flux density applied orthogonally and parallel to the IC surface, from Melexis. This sensor relies on a Hall effect to accurately sense magnetic field changes on three perpendicular axes. The internal magnetic field sensing elements are multiplexed and connected to a pre-amplifier and then to a sine and cosine analog outputs. All of the analog outptts are routed to the MCP3204 - onboard 4-channel 12-Bit A/D converter with SPI interface, from Microchip. The magnetic sensor has a very low pin count. However, in order to allow reading of the 4 analog inputs on the single Click board™, 3D Hall 6 click have onboard 4-channel, 12-Bit A/D converter, with SPI interface. Thus, the communication interface procedure relies on

reading the appropriate registers of the MCP3204. The MLX90380 contactless sensor also features a powerful programming engine, which allows the sensitivity and filter bandwidth to be programmed to optimally use the ADC input range of the ADC. However, because 3D Hall 6 click have onboard A/D converter, the output voltage of the MLX90380 is matched with the input range of the MCP3204, so the user don’t need to do any additional setting. High-speed dual analog outputs allow the MLX90380 to deliver accurate sine/cosine signals when used with a rotating permanent magnet. The sensor provides raw data output, based on a strength of the magnetic field. The measurement is affected by many factors: slight manufacturing differences between ICs affect the readings, even the slight differences

between Hall plates within the same IC might affect the accuracy, although the IC contains highly matched sensing elements. Also, the altitude might affect the readings, as well as temperature changes. The 3D Hall 6 software library contains simplified functions that allow straight-forward readings to be performed, reducing the steps needed for a proper initialization and configuration of the device. 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.

3D Hall 6 Click top side image
3D Hall 6 Click bottom side image

Features overview

Development board

Nucleo 32 with STM32F031K6 MCU board provides an affordable and flexible platform for experimenting with STM32 microcontrollers in 32-pin packages. Featuring Arduino™ Nano connectivity, it allows easy expansion with specialized shields, while being mbed-enabled for seamless integration with online resources. The

board includes an on-board ST-LINK/V2-1 debugger/programmer, supporting USB reenumeration with three interfaces: Virtual Com port, mass storage, and debug port. It offers a flexible power supply through either USB VBUS or an external source. Additionally, it includes three LEDs (LD1 for USB communication, LD2 for power,

and LD3 as a user LED) and a reset push button. The STM32 Nucleo-32 board is supported by various Integrated Development Environments (IDEs) such as IAR™, Keil®, and GCC-based IDEs like AC6 SW4STM32, making it a versatile tool for developers.

Nucleo 32 with STM32F031K6 MCU double side image

Microcontroller Overview

MCU Card / MCU

default

Architecture

ARM Cortex-M0

MCU Memory (KB)

32

Silicon Vendor

STMicroelectronics

Pin count

32

RAM (Bytes)

4096

You complete me!

Accessories

Click Shield for Nucleo-32 is the perfect way to expand your development board's functionalities with STM32 Nucleo-32 pinout. The Click Shield for Nucleo-32 provides two mikroBUS™ sockets to add any functionality from our ever-growing range of Click boards™. We are fully stocked with everything, from sensors and WiFi transceivers to motor control and audio amplifiers. The Click Shield for Nucleo-32 is compatible with the STM32 Nucleo-32 board, providing an affordable and flexible way for users to try out new ideas and quickly create prototypes with any STM32 microcontrollers, choosing from the various combinations of performance, power consumption, and features. The STM32 Nucleo-32 boards do not require any separate probe as they integrate the ST-LINK/V2-1 debugger/programmer and come with the STM32 comprehensive software HAL library and various packaged software examples. This development platform provides users with an effortless and common way to combine the STM32 Nucleo-32 footprint compatible board with their favorite Click boards™ in their upcoming projects.

Click Shield for Nucleo-32 accessories 1 image

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
NC
NC
RST
SPI Chip Enable
PA4
CS
SPI Clock
PB3
SCK
SPI Data OUT
PB4
MISO
SPI Data IN
PB5
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
NC
NC
PWM
NC
NC
INT
NC
NC
TX
NC
NC
RX
NC
NC
SCL
NC
NC
SDA
NC
NC
5V
Ground
GND
GND
1

Take a closer look

Click board™ Schematic

3D Hall 6 Click Schematic schematic

Step by step

Project assembly

Click Shield for Nucleo-144 front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Nucleo 32 with STM32F031K6 MCU as your development board.

Click Shield for Nucleo-144 front image hardware assembly
Nucleo 144 with STM32L4A6ZG MCU front image hardware assembly
2x4 RGB Click front image hardware assembly
Prog-cut hardware assembly
Nucleo-32 with STM32 MCU 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 image step 5 hardware assembly
Necto image step 6 hardware assembly
Clicker 4 for STM32F4 HA MCU Step hardware assembly
Necto No Display image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Debug Image Necto Step hardware assembly

Track your results in real time

Application Output

1. Application Output - In Debug mode, the 'Application Output' window enables real-time data monitoring, offering direct insight into execution results. Ensure proper data display by configuring the environment correctly using the provided tutorial.

2. UART Terminal - Use the UART Terminal to monitor data transmission via a USB to UART converter, allowing direct communication between the Click board™ and your development system. Configure the baud rate and other serial settings according to your project's requirements to ensure proper functionality. For step-by-step setup instructions, refer to the provided tutorial.

3. Plot Output - The Plot feature offers a powerful way to visualize real-time sensor data, enabling trend analysis, debugging, and comparison of multiple data points. To set it up correctly, follow the provided tutorial, which includes a step-by-step example of using the Plot feature to display Click board™ readings. To use the Plot feature in your code, use the function: plot(*insert_graph_name*, variable_name);. This is a general format, and it is up to the user to replace 'insert_graph_name' with the actual graph name and 'variable_name' with the parameter to be displayed.

Software Support

Library Description

This library contains API for 3D Hall 6 Click driver.

Key functions:

  • c3dhall6_set_reference_values - This function sets reference values for voltage and angle calculations

  • c3dhall6_get_adc_value - This function reads ADC value on selected channel

  • c3dhall6_get_volt - This function reads ADC value on selected channel and converts that value to Volts or miliVolts - depending on reference voltage setting.

Open Source

Code example

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.

/*!
 * \file 
 * \brief 3dHall6 Click example
 * 
 * # Description
 * This application measure the intensity of the magnetic field across three perpendicular axes.
 *
 * The demo application is composed of two sections :
 * 
 * ## Application Init 
 * Initializes device.
 * 
 * ## Application Task  
 *  Executes one or more 'c3dhall6_log_xxx_task' functions
 *  
 *  Additional Functions :
 *
 *  - c3dhall6_log_adc_task() - performs and logs adc measurements on all channels
 *  - c3dhall6_log_volt_task() - performs and logs voltage measurements on all channels
 *  - c3dhall6_log_angleRad_task() - performs and logs angle measurements in radians on each die
 *  - c3dhall6_log_angleDeg_task() - performs and logs angle measurements in degrees on each die
 * 
 * \author MikroE Team
 *
 */
// ------------------------------------------------------------------- INCLUDES

#include "board.h"
#include "log.h"
#include "c3dhall6.h"

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

static c3dhall6_t c3dhall6;
static log_t logger;

// ------------------------------------------------------- ADDITIONAL FUNCTIONS

static void c3dhall6_log_adc_task( )
{
    uint16_t ch0_adc_value;
    uint16_t ch1_adc_value;
    uint16_t ch2_adc_value;
    uint16_t ch3_adc_value;

    c3dhall6_get_adc_value( &c3dhall6, C3DHALL6_CHANNEL_0, &ch0_adc_value );
    c3dhall6_get_adc_value( &c3dhall6, C3DHALL6_CHANNEL_1, &ch1_adc_value );
    c3dhall6_get_adc_value( &c3dhall6, C3DHALL6_CHANNEL_2, &ch2_adc_value );
    c3dhall6_get_adc_value( &c3dhall6, C3DHALL6_CHANNEL_3, &ch3_adc_value );
    
    log_printf( &logger, "ADC on CH0 : %d \r\n", ch0_adc_value );
    log_printf( &logger, "ADC on CH1 : %d \r\n", ch1_adc_value );
    log_printf( &logger, "ADC on CH2 : %d \r\n", ch2_adc_value );
    log_printf( &logger, "ADC on CH3 : %d \r\n", ch3_adc_value );
}

void c3dhall6_log_volt_task( )
{
    float ch0_voltage;
    float ch1_voltage;
    float ch2_voltage;
    float ch3_voltage;

    c3dhall6_get_volt( &c3dhall6, C3DHALL6_CHANNEL_0, &ch0_voltage );
    c3dhall6_get_volt( &c3dhall6, C3DHALL6_CHANNEL_1, &ch1_voltage );
    c3dhall6_get_volt( &c3dhall6, C3DHALL6_CHANNEL_2, &ch2_voltage );
    c3dhall6_get_volt( &c3dhall6, C3DHALL6_CHANNEL_3, &ch3_voltage );
   
    log_printf( &logger, "Voltage on CH0 : %f V \r\n", ch0_voltage );
    log_printf( &logger, "Voltage on CH1 : %f V \r\n", ch1_voltage );
    log_printf( &logger, "Voltage on CH2 : %f V \r\n", ch2_voltage );
    log_printf( &logger, "Voltage on CH3 : %f V \r\n", ch3_voltage );
}

void c3dhall6_log_angle_rad_task( )
{
    float die_a_angle;
    float die_b_angle;

    c3dhall6_get_angle_rad( &c3dhall6, C3DHALL6_DIE_A, &die_a_angle );
    c3dhall6_get_angle_rad( &c3dhall6, C3DHALL6_DIE_B, &die_b_angle );

    log_printf( &logger, "DIE A Angle value :  %f rad \r\n", die_a_angle );
    log_printf( &logger, "DIE B Angle value :  %f rad \r\n", die_b_angle );    
}

void c3dhall6_log_angle_deg_task( )
{
    float die_a_angle;
    float die_b_angle;
    char degree_unit[2] = { 176, 0 };

    c3dhall6_get_angle_deg( &c3dhall6, C3DHALL6_DIE_A, &die_a_angle );
    c3dhall6_get_angle_deg( &c3dhall6, C3DHALL6_DIE_B, &die_b_angle );

    log_printf( &logger, "DIE A Angle value :  %f %c \r\n", die_a_angle, degree_unit );
    log_printf( &logger, "DIE B Angle value :  %f %c \r\n", die_b_angle, degree_unit ); 
    
}

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

void application_init ( void )
{
    log_cfg_t log_cfg;
    c3dhall6_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.

    c3dhall6_cfg_setup( &cfg );
    C3DHALL6_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    c3dhall6_init( &c3dhall6, &cfg );

    Delay_ms( 300 );
    c3dhall6_set_reference_values( &c3dhall6, 3.3, 2048.0, 2048.0, 2048.0, 2048.0 );
}

void application_task ( void )
{
    c3dhall6_log_angle_deg_task( );
    Delay_ms( 1000 );
}

void main ( void )
{
    application_init( );

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


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

Additional Support

Resources

Love this project?

'Buy This Kit' button takes you directly to the shopping cart where you can easily add or remove products.