Design a reliable current sensing system with TMCS1101-Q1 and TM4C1294NCPDT
Electricity can be shocking - your current sensing doesn't have to be!
Published Apr 23, 2023
Click board™
Hall Current 15 Click
Dev. board
Fusion for Tiva v8
Compiler
NECTO Studio
MCU
TM4C1294NCPDT
Achieve high-precision current sensing with a galvanically isolated Hall-effect current sensor, offering accurate and stable DC/AC current measurements
A
A
Hardware Overview
How does it work?
Hall Current 15 Click is based on the TMCS1101-Q1, a precise Hall-effect current sensor featuring a 600V isolation working voltage, <1.5% full-scale error across temperature, and device options providing both unidirectional and bidirectional current sensing from Texas Instruments. The input current flows through an internal 1.8mΩ conductor that generates a magnetic field measured by an integrated Hall-effect sensor and amplified by a precision signal chain. The device has a bandwidth of 80kHz and can be used for AC and DC current measurements. It is optimized for high accuracy and temperature stability, with offset and sensitivity compensated across the operating temperature
range. This Click board™ possesses two ways to communicate with the MCU. The analog output signal of the TMCS1101-Q1 can be converted to a digital value using ADC101C021, a 10-bit resolution analog-to-digital converter from Texas Instruments using a 2-wire I2C compatible interface, or can be sent directly to an analog pin of the mikroBUS™ socket labeled as AN. Selection can be performed by using an onboard SMD switch labeled OUT SEL, setting it to an appropriate position marked as AN or ADC. The ADC101C021 can transfer data supporting modes up to High-Speed, alongside its alert function, which provides an interrupt routed to the ALR pin of the mikroBUS™ socket activated
when analog input violates a programmable upper or lower limit value. 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 operate with either 3.3V or 5V logic voltage levels selected via the VCC SEL jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. However, the Click board™ comes equipped with a library containing easy-to-use functions and an example code that can be used, as a reference, for further development.
Features overview
Development board
Fusion for TIVA 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 Texas Instruments, regardless of their number of pins, and a broad set of unique functions, such as the first-ever embedded debugger/programmer over a WiFi network. 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 TIVA v8 provides a fluid and immersive working experience, allowing access
anywhere and under any circumstances at any time. Each part of the Fusion for TIVA 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 TIVA 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.
Microcontroller Overview
MCU Card / MCU
Type
8th Generation
Architecture
ARM Cortex-M4
MCU Memory (KB)
1024
Silicon Vendor
Texas Instruments
Pin count
128
RAM (Bytes)
262144
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 Fusion for Tiva v8 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 Hall Current 15 Click driver.
Key functions:
hallcurrent15_read_raw_adcThis function reads the raw ADC value.hallcurrent15_read_voltageThis function reads the raw ADC value and converts it to a proportional voltage level.hallcurrent15_read_currentThis function reads the input current level [A] based on HALLCURRENT15_NUM_CONVERSIONS of voltage measurements.
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 main.c
* @brief Hall Current 15 Click Example.
*
* # Description
* This example demonstrates the use of Hall Current 15 click board by reading and
* displaying the input current measurements.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes the driver and logger.
*
* ## Application Task
* Reads the input current measurements and displays the results on the USB UART
* approximately once per second.
*
* @author Stefan Filipovic
*
*/
#include "board.h"
#include "log.h"
#include "hallcurrent15.h"
static hallcurrent15_t hallcurrent15; /**< Hall Current 15 Click driver object. */
static log_t logger; /**< Logger object. */
void application_init ( void )
{
log_cfg_t log_cfg; /**< Logger config object. */
hallcurrent15_cfg_t hallcurrent15_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.
hallcurrent15_cfg_setup( &hallcurrent15_cfg );
HALLCURRENT15_MAP_MIKROBUS( hallcurrent15_cfg, MIKROBUS_1 );
err_t init_flag = hallcurrent15_init( &hallcurrent15, &hallcurrent15_cfg );
if ( ( ADC_ERROR == init_flag ) || ( I2C_MASTER_ERROR == init_flag ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
void application_task ( void )
{
float current = 0;
if ( HALLCURRENT15_OK == hallcurrent15_read_current ( &hallcurrent15, ¤t ) )
{
log_printf( &logger, " Current : %.3f[A]\r\n\n", current );
Delay_ms ( 1000 );
}
}
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
