current3  2.0.0.0
Main Page

Current 3 click

Current 3 Click is a compact add-on board for applications like current sense and temperature monitoring.

click Product page


Click library

  • Author : MikroE Team
  • Date : jul 2020.
  • Type : I2C type

Software Support

We provide a library for the Current3 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for Current3 Click driver.

Standard key functions :

  • Config Object Initialization function.

    void current3_cfg_setup ( current3_cfg_t *cfg );

  • Initialization function.

    CURRENT3_RETVAL current3_init ( current3_t *ctx, current3_cfg_t *cfg );

  • Click Default Configuration function.

    void current3_default_cfg ( current3_t *ctx );

Example key functions :

  • The function get the temperature by read multiple data bytes from a group of contiguous registers

    float current3_get_temperature ( current3_t *ctx, uint8_t temp_sel );

  • The function source voltage registers store the voltage measured at the SENSE+ pin

    float current3_get_source_voltage ( current3_t *ctx );

  • The function current measurement measure the direction of current flow
  • ( from SENSE+ to SENSE- or from SENSE- to SENSE+ )

    float current3_get_current ( current3_t *ctx );

Examples Description

Current 3 Click can be used to measure current ranging up to 8000mA, and display temperature, voltage and current data - using I2C comunication.

The demo application is composed of two sections :

Application Init

Initialization driver enables - I2C, check communication and set sense sampling configuration, also write log.

void application_init ( void )
{
log_cfg_t log_cfg;
uint8_t read_data;
// Logger initialization.
LOG_MAP_USB_UART( log_cfg );
log_cfg.baud = 115200;
log_cfg.level = LOG_LEVEL_DEBUG;
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
CURRENT3_MAP_MIKROBUS( cfg, MIKROBUS_1 );
current3_init( &current3, &cfg );
Delay_ms( 100 );
log_printf( &logger, " Driver init. done \r\n" );
log_printf( &logger, "---------------------------\r\n" );
current3_generic_read( &current3, CURRENT3_REG_PRODUCT_ID, &read_data, 1 );
if ( read_data == CURRENT3_DEV_ID )
{
log_printf( &logger, " Communication OK \r\n" );
log_printf( &logger, "---------------------------\r\n" );
}
else
{
log_printf( &logger, " Communication ERROR \r\n" );
log_printf( &logger, " Reset the device \r\n" );
log_printf( &logger, "---------------------------\r\n" );
for ( ; ; );
}
current3_default_cfg( &current3, sense_cfg_data );
}

Application Task

This is an example which demonstrates the use of Current 3 Click board. Current 3 Click board can be used to measure current ranging up to 8000mA, and display temperature, voltage and current data. All data logs write on USB uart changes for every 2 sec.

void application_task ( void )
{
log_printf( &logger, " Temperature = %.2f C\r\n", temperature );
voltage = current3_get_source_voltage( &current3 );
log_printf( &logger, " Voltage = %.2f V\r\n", voltage );
current = current3_get_current( &current3 );
log_printf( &logger, " Current = %.2f mA\r\n", current );
log_printf( &logger, "---------------------------\r\n" );
Delay_ms( 2000 );
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Current3

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. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


CURRENT3_DEV_ID
#define CURRENT3_DEV_ID
Definition: current3.h:150
current3_default_cfg
void current3_default_cfg(current3_t *ctx, current3_sense_cfg_data_t sense_cfg_data)
Click Default Configuration function.
current3_get_current
float current3_get_current(current3_t *ctx)
Get current measurement function.
current3_get_temperature
float current3_get_temperature(current3_t *ctx, uint8_t temp_sel)
Get temperature function.
application_task
void application_task(void)
Definition: main.c:84
current3_get_source_voltage
float current3_get_source_voltage(current3_t *ctx)
Get source voltage function.
current3_cfg_t
Click configuration structure definition.
Definition: current3.h:334
CURRENT3_MAP_MIKROBUS
#define CURRENT3_MAP_MIKROBUS(cfg, mikrobus)
Definition: current3.h:52
CURRENT3_REG_PRODUCT_ID
#define CURRENT3_REG_PRODUCT_ID
Definition: current3.h:141
application_init
void application_init(void)
Definition: main.c:43
current3_generic_read
void current3_generic_read(current3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
current3_init
CURRENT3_RETVAL current3_init(current3_t *ctx, current3_cfg_t *cfg)
Initialization function.
current3_cfg_setup
void current3_cfg_setup(current3_cfg_t *cfg)
Config Object Initialization function.
CURRENT3_TEMP_INTERNAL_DIODE
#define CURRENT3_TEMP_INTERNAL_DIODE
Definition: current3.h:157