vcpmonitor6  2.1.0.0
Modules | Functions
VCP Monitor 6 Click Driver

API for configuring and manipulating VCP Monitor 6 Click driver. More...

Modules

 VCP Monitor 6 Registers List
 List of registers of VCP Monitor 6 Click driver.
 
 VCP Monitor 6 Registers Settings
 Settings for registers of VCP Monitor 6 Click driver.
 
 VCP Monitor 6 MikroBUS Map
 MikroBUS pin mapping of VCP Monitor 6 Click driver.
 

Functions

void vcpmonitor6_cfg_setup (vcpmonitor6_cfg_t *cfg)
 VCP Monitor 6 configuration object setup function. More...
 
err_t vcpmonitor6_init (vcpmonitor6_t *ctx, vcpmonitor6_cfg_t *cfg)
 VCP Monitor 6 initialization function. More...
 
err_t vcpmonitor6_default_cfg (vcpmonitor6_t *ctx)
 VCP Monitor 6 default configuration function. More...
 
err_t vcpmonitor6_generic_write (vcpmonitor6_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 VCP Monitor 6 I2C writing function. More...
 
err_t vcpmonitor6_generic_read (vcpmonitor6_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 VCP Monitor 6 I2C reading function. More...
 
err_t vcpmonitor6_reg_write (vcpmonitor6_t *ctx, uint8_t reg, uint16_t data_in)
 VCP Monitor 6 register writing function. More...
 
err_t vcpmonitor6_reg_read (vcpmonitor6_t *ctx, uint8_t reg, uint16_t *data_out)
 VCP Monitor 6 register reading function. More...
 
err_t vcpmonitor6_sw_reset (vcpmonitor6_t *ctx)
 VCP Monitor 6 SW reset writing function. More...
 
err_t vcpmonitor6_set_conv_dly (vcpmonitor6_t *ctx, uint16_t dly_ms)
 VCP Monitor 6 set conversion delay function. More...
 
err_t vcpmonitor6_set_op_mode (vcpmonitor6_t *ctx, uint8_t op_mode)
 VCP Monitor 6 set the operating mode function. More...
 
err_t vcpmonitor6_set_conv_time (vcpmonitor6_t *ctx, uint8_t vbusct, uint8_t vsenct, uint8_t tct)
 VCP Monitor 6 set the conversion time function. More...
 
err_t vcpmonitor6_set_adc_avg (vcpmonitor6_t *ctx, uint8_t avg)
 VCP Monitor 6 set the ADC sample function. More...
 
err_t vcpmonitor6_get_bus_voltage (vcpmonitor6_t *ctx, float *voltage)
 VCP Monitor 6 get the voltage function. More...
 
err_t vcpmonitor6_get_temperature (vcpmonitor6_t *ctx, float *temperature)
 VCP Monitor 6 get the temperature function. More...
 
err_t vcpmonitor6_get_current (vcpmonitor6_t *ctx, float *current)
 VCP Monitor 6 get the current function. More...
 
err_t vcpmonitor6_get_power (vcpmonitor6_t *ctx, float *power)
 VCP Monitor 6 get the power function. More...
 
err_t vcpmonitor6_get_energy (vcpmonitor6_t *ctx, float *energy)
 VCP Monitor 6 get the energy function. More...
 
err_t vcpmonitor6_get_charge (vcpmonitor6_t *ctx, float *charge)
 VCP Monitor 6 get the charge function. More...
 
err_t vcpmonitor6_set_diag_flg_alr (vcpmonitor6_t *ctx, uint16_t diag_flg_alr)
 VCP Monitor 6 set diagnostic function. More...
 
err_t vcpmonitor6_get_indc_flg (vcpmonitor6_t *ctx, uint16_t *indc_flg)
 VCP Monitor 6 get diagnostic indicates function. More...
 
err_t vcpmonitor6_wait_conv_cmpl (vcpmonitor6_t *ctx)
 VCP Monitor 6 wait conversion function. More...
 
err_t vcpmonitor6_get_device_id (vcpmonitor6_t *ctx, uint16_t *man_id)
 VCP Monitor 6 get device ID function. More...
 
uint8_t vcpmonitor6_get_alarm (vcpmonitor6_t *ctx)
 VCP Monitor 6 get alarm function. More...
 

Detailed Description

API for configuring and manipulating VCP Monitor 6 Click driver.

Function Documentation

◆ vcpmonitor6_cfg_setup()

void vcpmonitor6_cfg_setup ( vcpmonitor6_cfg_t cfg)

VCP Monitor 6 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See vcpmonitor6_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ vcpmonitor6_default_cfg()

err_t vcpmonitor6_default_cfg ( vcpmonitor6_t ctx)

VCP Monitor 6 default configuration function.

This function executes a default configuration of VCP Monitor 6 click board.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ vcpmonitor6_generic_read()

err_t vcpmonitor6_generic_read ( vcpmonitor6_t ctx,
uint8_t  reg,
uint8_t *  data_out,
uint8_t  len 
)

VCP Monitor 6 I2C reading function.

This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[in]reg: Start register address.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_generic_write()

err_t vcpmonitor6_generic_write ( vcpmonitor6_t ctx,
uint8_t  reg,
uint8_t *  data_in,
uint8_t  len 
)

VCP Monitor 6 I2C writing function.

This function writes a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[in]reg: Start register address.
[in]data_in: Data to be written.
[in]len: Number of bytes to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_get_alarm()

uint8_t vcpmonitor6_get_alarm ( vcpmonitor6_t ctx)

VCP Monitor 6 get alarm function.

This function get states of the ALR [INT] pin.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
Returns
  • 0 - Low pin state,
  • 1 - High pin state. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_get_bus_voltage()

err_t vcpmonitor6_get_bus_voltage ( vcpmonitor6_t ctx,
float *  voltage 
)

VCP Monitor 6 get the voltage function.

This function reads the BUS voltage output measurement in volts [V] by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[out]voltage: BUS voltage [V].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_get_charge()

err_t vcpmonitor6_get_charge ( vcpmonitor6_t ctx,
float *  charge 
)

VCP Monitor 6 get the charge function.

This function reads the charge measurement result in Coulombs [C] by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[out]charge: Energy [C].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_get_current()

err_t vcpmonitor6_get_current ( vcpmonitor6_t ctx,
float *  current 
)

VCP Monitor 6 get the current function.

This function reads the current measurement result in milliamperes [mA] by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[out]current: Current [mA].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_get_device_id()

err_t vcpmonitor6_get_device_id ( vcpmonitor6_t ctx,
uint16_t *  man_id 
)

VCP Monitor 6 get device ID function.

This function reads the Manufacturer ID register by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[out]man_id: Manufacturer ID [0x5449].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_get_energy()

err_t vcpmonitor6_get_energy ( vcpmonitor6_t ctx,
float *  energy 
)

VCP Monitor 6 get the energy function.

This function reads the energy measurement result in kilojoules [kJ] by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[out]energy: Energy [kJ].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_get_indc_flg()

err_t vcpmonitor6_get_indc_flg ( vcpmonitor6_t ctx,
uint16_t *  indc_flg 
)

VCP Monitor 6 get diagnostic indicates function.

This function indicates health flags of the measurements by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[out]indc_flg: Health flags indicator.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_get_power()

err_t vcpmonitor6_get_power ( vcpmonitor6_t ctx,
float *  power 
)

VCP Monitor 6 get the power function.

This function reads the power measurement result in watts [W] by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[out]power: Power [W].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_get_temperature()

err_t vcpmonitor6_get_temperature ( vcpmonitor6_t ctx,
float *  temperature 
)

VCP Monitor 6 get the temperature function.

This function reads the internal die temperature measurement in degree Celsius [degC] by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[out]temperature: Internal die temperature measurement [degC].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_init()

err_t vcpmonitor6_init ( vcpmonitor6_t ctx,
vcpmonitor6_cfg_t cfg 
)

VCP Monitor 6 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters
[out]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See vcpmonitor6_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_reg_read()

err_t vcpmonitor6_reg_read ( vcpmonitor6_t ctx,
uint8_t  reg,
uint16_t *  data_out 
)

VCP Monitor 6 register reading function.

This function reads a 16-bit data from the selected register by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[in]reg: Register address.
[out]data_out: Output read data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_reg_write()

err_t vcpmonitor6_reg_write ( vcpmonitor6_t ctx,
uint8_t  reg,
uint16_t  data_in 
)

VCP Monitor 6 register writing function.

This function writes a 16-bit data to the selected register by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[in]reg: Register address.
[in]data_in: Data to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_set_adc_avg()

err_t vcpmonitor6_set_adc_avg ( vcpmonitor6_t ctx,
uint8_t  avg 
)

VCP Monitor 6 set the ADC sample function.

This function sets the desired ADC sample averaging count to all active inputs by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[in]avg: ADC sample averaging count [0x00-0x07].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_set_conv_dly()

err_t vcpmonitor6_set_conv_dly ( vcpmonitor6_t ctx,
uint16_t  dly_ms 
)

VCP Monitor 6 set conversion delay function.

This function sets the delay for initial ADC conversion in steps of 2 ms by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[in]dly_ms: Conversion delay [0-510ms].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_set_conv_time()

err_t vcpmonitor6_set_conv_time ( vcpmonitor6_t ctx,
uint8_t  vbusct,
uint8_t  vsenct,
uint8_t  tct 
)

VCP Monitor 6 set the conversion time function.

This function sets the desired conversion times of the bus voltage, shunt resistor voltage and temperature measurement by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[in]vbusct: Conversion time of the bus voltage measurement [0x00-0x07].
[in]vsenct: Conversion time of the shunt resistor voltage [0x00-0x07].
[in]tct: Conversion time of the temperature measurement [0x00-0x07].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_set_diag_flg_alr()

err_t vcpmonitor6_set_diag_flg_alr ( vcpmonitor6_t ctx,
uint16_t  diag_flg_alr 
)

VCP Monitor 6 set diagnostic function.

This function sets the diagnostic flags and alert by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[in]diag_flg_alr: Diagnostic flags and alert bitmask.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_set_op_mode()

err_t vcpmonitor6_set_op_mode ( vcpmonitor6_t ctx,
uint8_t  op_mode 
)

VCP Monitor 6 set the operating mode function.

This function sets the desired operating mode for continuous or triggered mode on bus voltage, current or temperature measurement by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
[in]op_mode: Operating mode [0x00-0x0F].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_sw_reset()

err_t vcpmonitor6_sw_reset ( vcpmonitor6_t ctx)

VCP Monitor 6 SW reset writing function.

This function resets all registers to default values by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ vcpmonitor6_wait_conv_cmpl()

err_t vcpmonitor6_wait_conv_cmpl ( vcpmonitor6_t ctx)

VCP Monitor 6 wait conversion function.

This function waits until the conversion is completed by using the I2C serial interface.

Parameters
[in]ctx: Click context object. See vcpmonitor6_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.