vcpmonitor3  2.0.0.0
Main Page

VCP Monitor 3 click

VCP Monitor 3 Click is a high precision Voltage, Current and Power measurement Click board™ with an input capable of taking up to 15V. It features the LTC2947, from Analog Devices, a high precision power and energy monitor with an internal sense resistor supporting up to ±30A.

click Product page


Click library

  • Author : Mikroe Team
  • Date : Oct 2021.
  • Type : I2C/SPI type

Software Support

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

Standard key functions :

Example key functions :

Example Description

VCP Monitor 3 Click show it's full usage by reading current, voltage, power, die temperature and voltage at DVCC using SPI or I2C communication protocol.

The demo application is composed of two sections :

Application Init

Initalizes SPI or I2C driver and sets up the device.

void application_init ( void )
{
log_cfg_t log_cfg;
vcpmonitor3_cfg_t vcpmonitor3_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
vcpmonitor3_cfg_setup( &vcpmonitor3_cfg );
VCPMONITOR3_MAP_MIKROBUS( vcpmonitor3_cfg, MIKROBUS_1 );
err_t init_flag = vcpmonitor3_init( &vcpmonitor3, &vcpmonitor3_cfg );
if ( ( I2C_MASTER_ERROR == init_flag ) || ( SPI_MASTER_ERROR == init_flag ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( VCPMONITOR3_ERROR == vcpmonitor3_default_cfg ( &vcpmonitor3 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

This example shows capabilities of VCP Monitor 3 Click board by reading current, voltage, power, die temperature and voltage at DVCC and displaying the results via USART terminal.

void application_task ( void )
{
volt_data = vcpmonitor3_read_v( &vcpmonitor3 );
log_printf( &logger, " Voltage : %.2f V \r\n", volt_data );
cur_data = vcpmonitor3_read_i( &vcpmonitor3 );
log_printf( &logger, " Current : %.2f A \r\n", cur_data );
pow_data = vcpmonitor3_read_p( &vcpmonitor3 );
log_printf( &logger, " Power : %.2f W \r\n", pow_data );
die_temp = vcpmonitor3_read_temp( &vcpmonitor3 );
log_printf( &logger, " Die Temperature : %.2f C \r\n", die_temp );
volt_vcc = vcpmonitor3_read_vcc( &vcpmonitor3 );
log_printf( &logger, " Voltage at DVCC : %.2f V \r\n", volt_vcc );
log_printf( &logger, " ------------------------------- \r\n" );
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.VCPMonitor3

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.


vcpmonitor3_init
err_t vcpmonitor3_init(vcpmonitor3_t *ctx, vcpmonitor3_cfg_t *cfg)
VCP Monitor 3 initialization function.
vcpmonitor3_set_op_mode
void vcpmonitor3_set_op_mode(vcpmonitor3_t *ctx, uint8_t op_mode)
Set Operation Mode function.
application_task
void application_task(void)
Definition: main.c:73
vcpmonitor3_default_cfg
err_t vcpmonitor3_default_cfg(vcpmonitor3_t *ctx)
VCP Monitor 3 default configuration function.
VCPMONITOR3_ERROR
@ VCPMONITOR3_ERROR
Definition: vcpmonitor3.h:534
vcpmonitor3_rd_page_0
void vcpmonitor3_rd_page_0(vcpmonitor3_t *ctx, uint8_t reg, uint8_t *rd_data, uint8_t n_bytes)
Read Data From Page 0 function.
vcpmonitor3_read_p
float vcpmonitor3_read_p(vcpmonitor3_t *ctx)
Read Power in Watts function.
vcpmonitor3_read_vcc
float vcpmonitor3_read_vcc(vcpmonitor3_t *ctx)
Read Voltage at DVCC in Volts function.
vcpmonitor3_s
VCP Monitor 3 Click context object.
Definition: vcpmonitor3.h:485
vcpmonitor3_cfg_setup
void vcpmonitor3_cfg_setup(vcpmonitor3_cfg_t *cfg)
VCP Monitor 3 configuration object setup function.
application_init
void application_init(void)
Definition: main.c:36
vcpmonitor3_cfg_t
VCP Monitor 3 Click configuration object.
Definition: vcpmonitor3.h:506
vcpmonitor3_read_v
float vcpmonitor3_read_v(vcpmonitor3_t *ctx)
Read Voltage in Volts function.
VCPMONITOR3_MAP_MIKROBUS
#define VCPMONITOR3_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: vcpmonitor3.h:450
vcpmonitor3_read_i
float vcpmonitor3_read_i(vcpmonitor3_t *ctx)
Read Current in Amps function.
vcpmonitor3_read_temp
float vcpmonitor3_read_temp(vcpmonitor3_t *ctx)
Read Die Temperature in degrees Centigrade function.