hallcurrent12  2.0.0.0
Main Page

Hall Current 12 click

Hall Current 12 Click is a compact add-on board that provides economical and precise AC or DC current sensing solutions. This board features the TMCS1100, a galvanically isolated Hall-effect current sensor capable of DC or AC current measurement with high accuracy, excellent linearity, and temperature stability from Texas Instruments. It enables the lowest drift, <1% full-scale error, and highest accuracy over time and temperature. It also provides a reliable 600V lifetime working voltage and 3kVRMS isolation between the current path and circuitry with uni/bidirectional current sensing. Besides, the user is allowed to process the output signal in analog or digital form.

click Product page


Click library

  • Author : Nenad Filipovic
  • Date : Jul 2021.
  • Type : I2C type

Software Support

We provide a library for the HallCurrent12 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for HallCurrent12 Click driver.

Standard key functions :

Example key functions :

Example Description

This library contains API for Hall Current 12 Click driver. The demo application reads ADC value and current ( A ).

The demo application is composed of two sections :

Application Init

Initializes I2C driver and log UART. After driver initialization the app set default settings.

void application_init ( void )
{
log_cfg_t log_cfg;
hallcurrent12_cfg_t hallcurrent12_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
hallcurrent12_cfg_setup( &hallcurrent12_cfg );
HALLCURRENT12_MAP_MIKROBUS( hallcurrent12_cfg, MIKROBUS_1 );
err_t init_flag = hallcurrent12_init( &hallcurrent12, &hallcurrent12_cfg );
if ( I2C_MASTER_ERROR == init_flag )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
hallcurrent12_default_cfg ( &hallcurrent12 );
log_info( &logger, " Application Task " );
log_printf( &logger, "--------------------------\r\n" );
Delay_ms( 100 );
}

Application Task

This is an example that demonstrates the use of the Hall Current 12 Click boardâ„¢. In this example, we read and display the ADC values and current ( A ) data. Results are being sent to the Usart Terminal where you can track their changes.

void application_task ( void )
{
static uint16_t adc_data;
static float current;
hallcurrent12_get_adc( &hallcurrent12, &adc_data );
log_printf( &logger, " ADC Value : %d \r\n", adc_data );
Delay_ms( 100 );
hallcurrent12_get_current ( &hallcurrent12, &current );
log_printf( &logger, " Current : %.3f A \r\n", current );
log_printf( &logger, "--------------------------\r\n" );
Delay_ms( 1000 );
}

Note

Switches: Sensitivity : Low ( GAIN = 1 ), Vout_Sel : ADC ( I2C serial interface ), Vref_Sel : GND ( unidirectional measurement ).

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.HallCurrent12

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


hallcurrent12_cfg_t
Hall Current 12 Click configuration object.
Definition: hallcurrent12.h:120
hallcurrent12_init
err_t hallcurrent12_init(hallcurrent12_t *ctx, hallcurrent12_cfg_t *cfg)
Hall Current 12 initialization function.
application_task
void application_task(void)
Definition: main.c:73
hallcurrent12_cfg_setup
void hallcurrent12_cfg_setup(hallcurrent12_cfg_t *cfg)
Hall Current 12 configuration object setup function.
HALLCURRENT12_MAP_MIKROBUS
#define HALLCURRENT12_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: hallcurrent12.h:71
hallcurrent12_get_adc
err_t hallcurrent12_get_adc(hallcurrent12_t *ctx, uint16_t *data_out)
Hall Current 12 get ADC function.
application_init
void application_init(void)
Definition: main.c:37
hallcurrent12_s
Hall Current 12 Click context object.
Definition: hallcurrent12.h:100
hallcurrent12_get_current
err_t hallcurrent12_get_current(hallcurrent12_t *ctx, float *current)
Hall Current 12 get current function.
hallcurrent12_default_cfg
err_t hallcurrent12_default_cfg(hallcurrent12_t *ctx)
Hall Current 12 default configuration function.
hallcurrent12_get_adc_voltage
err_t hallcurrent12_get_adc_voltage(hallcurrent12_t *ctx, float *adc_vtg)
Hall Current 12 get ADC voltage function.