Provide a comprehensive view of magnetic fields in three dimensions using TLV493D-A1B6 and STM32G474RE
Tri-axis magnetic field sensing
Published Nov 08, 2024
Click board™
3D Hall 2 click
Dev. board
Nucleo 64 with STM32G474RE MCU
Compiler
NECTO Studio
MCU
STM32G474RE
Explore our cutting-edge solution that senses magnetic field strength along three perpendicular axes, delivering unrivaled accuracy for a wide range of applications
A
A
Hardware Overview
How does it work?
3D Hall 2 Click is based on the TLV493D-A1B6, a low power 3D magnetic sensor, from Infineon. This sensor relies on a Hall effect to accurately sense magnetic field changes on three perpendicular axes. The internal sensing elements are spinning Hall sensor plates, connected to a 12bit low noise Analog to Digital Converter (ADC), which sequentially samples each sensor, providing 12-bit spatial data over the I2C interface. An additional 8-bit thermal sensor is also available, and it is used for the thermal compensation. The magnetic sensor has very low pin count (only 6), packed in a SOP6 casing. Therefore, the I2C interface is used for the reset too, while the interrupt pin is multiplexed with the I2C clock line. The interrupt is a useful feature which is used to signal a data ready event to the host microcontroller. For more robust data transfer, the device also contains a frame counter, which increases after each sensor sampling cycle. If the cycle was stopped for whatever reason, the frame counter will indicate this problem, and the application is able to take the necessary steps. Parity Error Check mechanism is also implemented for even more
data transfer robustness. 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. Therefore, the sensor IC is equipped with the thermal sensor, used to measure influence of the ambient temperature. Unlike errors which occur as the result due to influence of other elements, the thermal influence is not linear and therefore, the host firmware should utilize a Look-up Table (LUT) for several thermal values, in order to achieve linear response. The thermal sensor allows reducing the error margin of the angle measurement from ±2˚ to ±3˚ by using such LUT table compensation. The datasheet contains the whole calibrating procedure, as well as the angle calculation based on raw sensor data, as well as formulas for conversion the thermal and the magnetic data.
There are two configuration registers, used to set the working parameters. The interrupt functionality, thermal sensor availability, the power mode, I2C interface speed, data parity test, and other working parameters are contained within two configuration registers, referred to as MOD1 and MOD2 in the datasheet. The I2C address of the device can be changed by overwriting corresponding I2C address bits in these two registers. The I2C slave address is additionally determined at the startup, by sampling the state of the SDA (I2C Serial Data) pin within first 200 µs, after which the address remains fixed until the next reset cycle. I2C pins (SCL and SDA) are routed to the mikroBUS™ of the Click board™ for an easy interfacing with the development system. 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.
Features overview
Development board
Nucleo-64 with STM32G474R MCU offers a cost-effective and adaptable platform for developers to explore new ideas and prototype their designs. This board harnesses the versatility of the STM32 microcontroller, enabling users to select the optimal balance of performance and power consumption for their projects. It accommodates the STM32 microcontroller in the LQFP64 package and includes essential components such as a user LED, which doubles as an ARDUINO® signal, alongside user and reset push-buttons, and a 32.768kHz crystal oscillator for precise timing operations. Designed with expansion and flexibility in mind, the Nucleo-64 board features an ARDUINO® Uno V3 expansion connector and ST morpho extension pin
headers, granting complete access to the STM32's I/Os for comprehensive project integration. Power supply options are adaptable, supporting ST-LINK USB VBUS or external power sources, ensuring adaptability in various development environments. The board also has an on-board ST-LINK debugger/programmer with USB re-enumeration capability, simplifying the programming and debugging process. Moreover, the board is designed to simplify advanced development with its external SMPS for efficient Vcore logic supply, support for USB Device full speed or USB SNK/UFP full speed, and built-in cryptographic features, enhancing both the power efficiency and security of projects. Additional connectivity is
provided through dedicated connectors for external SMPS experimentation, a USB connector for the ST-LINK, and a MIPI® debug connector, expanding the possibilities for hardware interfacing and experimentation. Developers will find extensive support through comprehensive free software libraries and examples, courtesy of the STM32Cube MCU Package. This, combined with compatibility with a wide array of Integrated Development Environments (IDEs), including IAR Embedded Workbench®, MDK-ARM, and STM32CubeIDE, ensures a smooth and efficient development experience, allowing users to fully leverage the capabilities of the Nucleo-64 board in their projects.
Microcontroller Overview
MCU Card / MCU
Architecture
ARM Cortex-M4
MCU Memory (KB)
512
Silicon Vendor
STMicroelectronics
Pin count
64
RAM (Bytes)
128k
You complete me!
Accessories
Click Shield for Nucleo-64 comes equipped with two proprietary mikroBUS™ sockets, allowing all the Click board™ devices to be interfaced with the STM32 Nucleo-64 board with no effort. This way, Mikroe allows its users to add any functionality from our ever-growing range of Click boards™, such as WiFi, GSM, GPS, Bluetooth, ZigBee, environmental sensors, LEDs, speech recognition, motor control, movement sensors, and many more. More than 1537 Click boards™, which can be stacked and integrated, are at your disposal. The STM32 Nucleo-64 boards are based on the microcontrollers in 64-pin packages, a 32-bit MCU with an ARM Cortex M4 processor operating at 84MHz, 512Kb Flash, and 96KB SRAM, divided into two regions where the top section represents the ST-Link/V2 debugger and programmer while the bottom section of the board is an actual development board. These boards are controlled and powered conveniently through a USB connection to program and efficiently debug the Nucleo-64 board out of the box, with an additional USB cable connected to the USB mini port on the board. Most of the STM32 microcontroller pins are brought to the IO pins on the left and right edge of the board, which are then connected to two existing mikroBUS™ sockets. This Click Shield also has several switches that perform functions such as selecting the logic levels of analog signals on mikroBUS™ sockets and selecting logic voltage levels of the mikroBUS™ sockets themselves. Besides, the user is offered the possibility of using any Click board™ with the help of existing bidirectional level-shifting voltage translators, regardless of whether the Click board™ operates at a 3.3V or 5V logic voltage level. Once you connect the STM32 Nucleo-64 board with our Click Shield for Nucleo-64, you can access hundreds of Click boards™, working with 3.3V or 5V logic voltage levels.
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Click board™ Schematic
Step by step
Project assembly
Start by selecting your development board and Click board™. Begin with the Nucleo 64 with STM32G474RE MCU as your development board.
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 2 Click driver.
Key functions:
c3dhall2_read_data- This function reads data from registerc3dhall2_get_axis_temp_data- This function gets temperature and axis datac3dhall2_configuration- This function configures the chip for measurement.
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 C3dHall2 Click example
*
* # Description
*
* This application reads X/Y/Z hall axis and temperature
* data and converts it to human readable format.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes the driver and configures the click board.
*
* ## Application Task
* Reads X/Y/Z hall axis and Temperature data.
* All data logs on the USBUART every 200ms.
*
* \author MikroE Team
*
*/
// ------------------------------------------------------------------- INCLUDES
#include "board.h"
#include "log.h"
#include "c3dhall2.h"
// ------------------------------------------------------------------ VARIABLES
static c3dhall2_t c3dhall2;
static log_t logger;
// ------------------------------------------------------ APPLICATION FUNCTIONS
void application_init ( void )
{
log_cfg_t log_cfg;
c3dhall2_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.
c3dhall2_cfg_setup( &cfg );
C3DHALL2_MAP_MIKROBUS( cfg, MIKROBUS_1 );
c3dhall2_init( &c3dhall2, &cfg );
c3dhall2_default_cfg( &c3dhall2 );
}
void application_task ( void )
{
float xyz_axis[ 3 ] = { 0 };
float temperature = 0;
if ( C3DHALL2_OK == c3dhall2_get_axis_temp_data( &c3dhall2, &xyz_axis[ 0 ], &temperature ) )
{
log_printf( &logger, " Axis X: %.2f mT\r\n", xyz_axis[ 0 ] );
log_printf( &logger, " Axis Y: %.2f mT\r\n", xyz_axis[ 1 ] );
log_printf( &logger, " Axis Z: %.2f mT\r\n", xyz_axis[ 2 ] );
log_printf( &logger, " Temperature: %.2f C\r\n\n", temperature );
Delay_ms ( 200 );
}
}
int main ( void )
{
/* Do not remove this line or clock might not be set correctly. */
#ifdef PREINIT_SUPPORTED
preinit();
#endif
application_init( );
for ( ; ; )
{
application_task( );
}
return 0;
}
// ------------------------------------------------------------------------ END
/*!
* \file
* \brief C3dHall2 Click example
*
* # Description
*
* This application reads X/Y/Z hall axis and temperature
* data and converts it to human readable format.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes the driver and configures the click board.
*
* ## Application Task
* Reads X/Y/Z hall axis and Temperature data.
* All data logs on the USBUART every 200ms.
*
* \author MikroE Team
*
*/
// ------------------------------------------------------------------- INCLUDES
#include "board.h"
#include "log.h"
#include "c3dhall2.h"
// ------------------------------------------------------------------ VARIABLES
static c3dhall2_t c3dhall2;
static log_t logger;
// ------------------------------------------------------ APPLICATION FUNCTIONS
void application_init ( void )
{
log_cfg_t log_cfg;
c3dhall2_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.
c3dhall2_cfg_setup( &cfg );
C3DHALL2_MAP_MIKROBUS( cfg, MIKROBUS_1 );
c3dhall2_init( &c3dhall2, &cfg );
c3dhall2_default_cfg( &c3dhall2 );
}
void application_task ( void )
{
float xyz_axis[ 3 ] = { 0 };
float temperature = 0;
if ( C3DHALL2_OK == c3dhall2_get_axis_temp_data( &c3dhall2, &xyz_axis[ 0 ], &temperature ) )
{
log_printf( &logger, " Axis X: %.2f mT\r\n", xyz_axis[ 0 ] );
log_printf( &logger, " Axis Y: %.2f mT\r\n", xyz_axis[ 1 ] );
log_printf( &logger, " Axis Z: %.2f mT\r\n", xyz_axis[ 2 ] );
log_printf( &logger, " Temperature: %.2f C\r\n\n", temperature );
Delay_ms ( 200 );
}
}
int main ( void )
{
/* Do not remove this line or clock might not be set correctly. */
#ifdef PREINIT_SUPPORTED
preinit();
#endif
application_init( );
for ( ; ; )
{
application_task( );
}
return 0;
}
// ------------------------------------------------------------------------ END
