Intermediate
30 min

Accurately measure currents of up to 120A using TLI4971-A120T5 and STM32F373RC

Max current, max clarity

Hall Current 8 Click - 120A with Fusion for ARM v8

Published Aug 12, 2023

Click board™

Hall Current 8 Click - 120A

Dev Board

Fusion for ARM v8

Compiler

NECTO Studio

MCU

STM32F373RC

Engineered to excel, our Hall-effect current sensing solution, capable of measuring up to 120A, empowers industries to make informed decisions, proactively manage power consumption, and enhance overall system reliability

A

A

Hardware Overview

How does it work?

Hall Current 8 Click - 120A is based on the TLI4971-A120T5, a high-precision miniature coreless magnetic current sensor for AC and DC measurements with an analog interface and two fast overcurrent detection outputs from Infineon Technologies. The well-established Hall technology, on which the TLI4971 is based, enables accurate and highly linear measurement of currents with a full scale that depends on the chosen product variant, in this case, up to 120A. Typical applications are electrical drives and general-purpose inverters. It is suitable for fast over-current detection, which allows the control unit to switch off and protect the affected system from damage independently from the primary measurement path. The preconfigured output mode of the TLI4971-A120T5 is set to semi-differential mode. Current

flowing through the primary conductors is galvanically isolated, protecting low-voltage parts of the Click board™, as well as the host MCU, and induces a magnetic field that is differentially measured by two Hall probes. A high-performance amplifier combines the signal resulting from the differential field and the internal compensation information provided by the temperature and stress compensation unit. Then the amplifier output signal is fed into a differential output amplifier, which drives the sensor's analog output on the AN pin of the mikroBUS™ socket. In addition to the already mentioned characteristics, this Click board™ has two separate interface pins (OCD) routed to the PWM and INT pins of the mikroBUS socket. They provide fast output signals if a current exceeds a preset threshold in combination with the red and

yellow LEDs marked with OCD1 and OCD2. Those pins offer a swift response thanks to independence from the main signal path. They can be used as a trap functionality to shut down the current source quickly and precisely detect mild overload conditions. Also, this Click board™ should be connected in series with the load. Two onboard terminal connectors measure the current, one terminal block for the positive and the other for the negative current input. 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.

Hall Current 8 Click - 120A hardware overview image
Hall Current 8 Click - 120A Current Warning image

Features overview

Development board

Fusion for ARM 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 ARM® Cortex®-M based MCUs 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 ARM v8 provides a fluid and immersive working experience, allowing access anywhere and under any

circumstances at any time. Each part of the Fusion for ARM 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 ARM 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 ARM v8 horizontal image

Microcontroller Overview

MCU Card / MCU

default

Type

8th Generation

Architecture

ARM Cortex-M4

MCU Memory (KB)

256

Silicon Vendor

STMicroelectronics

Pin count

64

RAM (Bytes)

32768

Used MCU Pins

mikroBUS™ mapper

Analog Signal
PC0
AN
NC
NC
RST
NC
NC
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
Overcurrent Output 2
PA1
PWM
Overcurrent Output 1
PE8
INT
NC
NC
TX
NC
NC
RX
NC
NC
SCL
NC
NC
SDA
NC
NC
5V
Ground
GND
GND
1

Take a closer look

Schematic

Hall Current 8 Click - 120A 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 ARM v8 as your development board.

Fusion for PIC v8 front image hardware assembly
GNSS2 Click front image hardware assembly
SiBRAIN for PIC32MZ1024EFK144 front image hardware assembly
GNSS2 Click complete accessories setup image hardware assembly
v8 SiBRAIN Access 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 Hall Current 8 Click - 120A driver.

Key functions:

  • hallcurrent8120a_calibration - This function sets the calibration value into the offset data from context object of the TLI4971 high precision coreless current sensor on Hall Current 8 120A Click

  • hallcurrent8120a_get_voltage - This function reads results of AD conversion of the AN pin and converts them to proportional voltage level

  • hallcurrent8120a_get_current - This function reads results of AD conversion of the AN pin and converts them to proportional current level

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 main.c
 * @brief Hall Current 8 120A Click Example.
 *
 * # Description
 * This library contains API for Hall Current 8 120A Click driver.
 * The library initializes and defines the ADC drivers.
 * The library also includes a function for calibration, 
 * current measurement and overcurrent detection.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * Initializes ADC driver, calibrate AD conversion 
 * of the AN pin and start to write log.
 *
 * ## Application Task
 * This is an example that demonstrates the use of the Hall Current 8 120A click board.
 * In this example, we read and display current data [A], 
 * ADC value and AN pin voltage level [V]. 
 * Results are being sent to the Usart Terminal where you can track their changes.
 *
 * @author Stefan Ilic
 *
 */

#include "board.h"
#include "log.h"
#include "hallcurrent8120a.h"

static hallcurrent8120a_t hallcurrent8120a;   /**< Hall Current 8 120A Click driver object. */
static log_t logger;                          /**< Logger object. */

hallcurrent8120a_offset_t offset_val;

void application_init ( void ) {
    log_cfg_t log_cfg;                            /**< Logger config object. */
    hallcurrent8120a_cfg_t hallcurrent8120a_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.

    hallcurrent8120a_cfg_setup( &hallcurrent8120a_cfg );
    HALLCURRENT8120A_MAP_MIKROBUS( hallcurrent8120a_cfg, MIKROBUS_1 );
    if ( hallcurrent8120a_init( &hallcurrent8120a, &hallcurrent8120a_cfg ) == ADC_ERROR ) {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }
    Delay_ms( 1000 );
    
    log_printf( &logger, "---------------------------\r\n" );
    log_printf( &logger, " Turn OFF the power supply \r\n" );
    Delay_ms( 5000 );
    
    log_printf( &logger, "---------------------------\r\n" );
    log_printf( &logger, "     Start Calibration     \r\n" );
    hallcurrent8120a_calibration ( &hallcurrent8120a, &offset_val );
    Delay_ms( 1000 );
    
    log_printf( &logger, "---------------------------\r\n");
    log_printf( &logger, " Turn ON the power supply  \r\n" );
    Delay_ms( 5000 );
    
    log_printf( &logger, "---------------------------\r\n");
    log_printf( &logger, "    Start measurements :   \r\n");
    log_printf( &logger, "---------------------------\r\n");
}

void application_task ( void ) {
    float hallcurrent8120a_current = 0;
    
    if ( hallcurrent8120a_get_current ( &hallcurrent8120a, &offset_val, &hallcurrent8120a_current ) != ADC_ERROR ) {
        log_printf( &logger, "   Current     : %.2f [A]\r\n", hallcurrent8120a_current );
    }
    
    uint16_t hallcurrent8120a_an_value = 0;

    if ( hallcurrent8120a_read_an_pin_value ( &hallcurrent8120a, &hallcurrent8120a_an_value ) != ADC_ERROR ) {
        log_printf( &logger, "   ADC Value   : %u\r\n", hallcurrent8120a_an_value );
    }

    float hallcurrent8120a_an_voltage = 0;

    if ( hallcurrent8120a_read_an_pin_voltage ( &hallcurrent8120a, &hallcurrent8120a_an_voltage ) != ADC_ERROR ) {
        log_printf( &logger, "   AN Voltage  : %.2f [V]\r\n", hallcurrent8120a_an_voltage );
    }
    log_printf( &logger, "---------------------------\r\n");
    Delay_ms( 1000 );
}

void main ( void ) {
    application_init( );

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

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

Additional Support

Resources