hallcurrent15

\mainpage Main Page

---

Hall Current 15 Click

Hall Current 15 Click is a compact add-on board that provides precise AC or DC current-sensing solution. This board features the TMCS1101-Q1, 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. A low-drift, temperature-compensated signal chain provides <1.5% full-scale error across a broad operating temperature range. 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 : Stefan Filipovic
• Date : Apr 2022.
• Type : ADC/I2C type

Software Support

We provide a library for the Hall Current 15 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 Hall Current 15 Click driver.

Standard key functions :

• hallcurrent15_cfg_setup Config Object Initialization function.

void hallcurrent15_cfg_setup ( hallcurrent15_cfg_t *cfg );

• hallcurrent15_init Initialization function.

err_t hallcurrent15_init ( hallcurrent15_t *ctx, hallcurrent15_cfg_t *cfg );

Example key functions :

• hallcurrent15_read_raw_adc This function reads raw ADC value.

err_t hallcurrent15_read_raw_adc ( hallcurrent15_t *ctx, uint16_t *raw_adc );

• hallcurrent15_read_voltage This function reads raw ADC value and converts it to proportional voltage level.

err_t hallcurrent15_read_voltage ( hallcurrent15_t *ctx, float *voltage );

• hallcurrent15_read_current This function reads the input current level [A] based on HALLCURRENT15_NUM_CONVERSIONS of voltage measurements.

err_t hallcurrent15_read_current ( hallcurrent15_t *ctx, float *current );

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.

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 " );
}

Application Task

Reads the input current measurements and displays the results on the USB UART approximately once per second.

void application_task ( void )
{
    float current = 0;
    if ( HALLCURRENT15_OK == hallcurrent15_read_current ( &hallcurrent15, &current ) ) 
    {
        log_printf( &logger, " Current : %.3f[A]\r\n\n", current );
        Delay_ms ( 1000 );
    }
}

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.HallCurrent15

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.

---