pwrmeter2  2.0.0.0
Functions

Functions

void pwrmeter2_cfg_setup (pwrmeter2_cfg_t *cfg)
 Config Object Initialization function. More...
 
PWRMETER2_RETVAL pwrmeter2_init (pwrmeter2_t *ctx, pwrmeter2_cfg_t *cfg)
 Initialization function. More...
 
void pwrmeter2_default_cfg (pwrmeter2_t *ctx)
 Click Default Configuration function. More...
 
void pwrmeter2_generic_transfer (pwrmeter2_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function. More...
 
uint8_t pwrmeter2_write_reg (pwrmeter2_t *ctx, uint8_t register_address, uint32_t transfer_data)
 Generic Write function. More...
 
uint8_t pwrmeter2_read_reg (pwrmeter2_t *ctx, uint8_t register_address, uint32_t *data_out, uint8_t n_data)
 Generic Read function. More...
 
uint8_t pwrmeter2_check_data_ready (pwrmeter2_t *ctx, uint8_t sel_chann)
 Data Ready Check function. More...
 
uint8_t pwrmeter2_read_conv_data (pwrmeter2_t *ctx, uint32_t *data_ch_0, uint32_t *data_ch_1)
 Read Converted Data function. More...
 
void pwrmeter2_get_data (pwrmeter2_t *ctx, int32_t *voltage_data, int32_t *current_data, uint32_t *power_data)
 Data Get function. More...
 
void pwrmeter2_reset (pwrmeter2_t *ctx)
 Reset function. More...
 
uint8_t pwrmeter2_get_modulator_1 (pwrmeter2_t *ctx)
 Modulator 1 Get function. More...
 
uint8_t pwrmeter2_get_modulator_0 (pwrmeter2_t *ctx)
 Modulator 0 Get function. More...
 
uint8_t pwrmeter2_check_ready_pin (pwrmeter2_t *ctx)
 Ready Pin Check function. More...
 

Detailed Description

Function Documentation

◆ pwrmeter2_cfg_setup()

void pwrmeter2_cfg_setup ( pwrmeter2_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ pwrmeter2_check_data_ready()

uint8_t pwrmeter2_check_data_ready ( pwrmeter2_t ctx,
uint8_t  sel_chann 
)

Data Ready Check function.

Parameters
ctxClick object.
sel_channDetermines which channel be checked.

@description This function waits until conversion, for the desired channel, is finished and returns information about data width.

◆ pwrmeter2_check_ready_pin()

uint8_t pwrmeter2_check_ready_pin ( pwrmeter2_t ctx)

Ready Pin Check function.

Parameters
ctxClick object.

@description This function returns the state of the Data Ready ( DR ) pin.

◆ pwrmeter2_default_cfg()

void pwrmeter2_default_cfg ( pwrmeter2_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for PWR Meter 2 click.

◆ pwrmeter2_generic_transfer()

void pwrmeter2_generic_transfer ( pwrmeter2_t ctx,
uint8_t *  wr_buf,
uint16_t  wr_len,
uint8_t *  rd_buf,
uint16_t  rd_len 
)

Generic transfer function.

Parameters
ctxClick object.
wr_bufWrite data buffer
wr_lenNumber of byte in write data buffer
rd_bufRead data buffer
rd_lenNumber of byte in read data buffer

@description Generic SPI transfer, for sending and receiving packages

◆ pwrmeter2_get_data()

void pwrmeter2_get_data ( pwrmeter2_t ctx,
int32_t *  voltage_data,
int32_t *  current_data,
uint32_t *  power_data 
)

Data Get function.

Parameters
ctxClick object.
voltage_dataStores the voltage data in mV.
current_dataStores the current data in mA.
power_datatores the power data in mW.

@description This function gets the calculated voltage( mV ), current( mA ) and power( mW ) data.

◆ pwrmeter2_get_modulator_0()

uint8_t pwrmeter2_get_modulator_0 ( pwrmeter2_t ctx)

Modulator 0 Get function.

Parameters
ctxClick object.

@description This function returns the state of the modulator output for the channel 0.

◆ pwrmeter2_get_modulator_1()

uint8_t pwrmeter2_get_modulator_1 ( pwrmeter2_t ctx)

Modulator 1 Get function.

Parameters
ctxClick object.

@description This function returns the state of the modulator output for the channel 1.

◆ pwrmeter2_init()

PWRMETER2_RETVAL pwrmeter2_init ( pwrmeter2_t ctx,
pwrmeter2_cfg_t cfg 
)

Initialization function.

Parameters
pwrmeter2Click object.
cfgClick configuration structure.

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

◆ pwrmeter2_read_conv_data()

uint8_t pwrmeter2_read_conv_data ( pwrmeter2_t ctx,
uint32_t *  data_ch_0,
uint32_t *  data_ch_1 
)

Read Converted Data function.

Parameters
ctxClick object.
data_ch_0Buffer where the converted data from channel 0 register be stored.
data_ch_1Buffer where the converted data from channel 1 register be stored.

@description This function reads the converted data from both channels when conversion is finished.

◆ pwrmeter2_read_reg()

uint8_t pwrmeter2_read_reg ( pwrmeter2_t ctx,
uint8_t  register_address,
uint32_t *  data_out,
uint8_t  n_data 
)

Generic Read function.

Parameters
ctxClick object.
register_addressAddress which from data be read.
data_outNumber of data to be read.
n_dataBuffer where data be stored.

@description This function reads the desired number of 24-bit data from the register/registers.

◆ pwrmeter2_reset()

void pwrmeter2_reset ( pwrmeter2_t ctx)

Reset function.

Parameters
ctxClick object.

@description This function performs the hardware reset and puts the device back to the normal operation mode after 1.2 seconds.

◆ pwrmeter2_write_reg()

uint8_t pwrmeter2_write_reg ( pwrmeter2_t ctx,
uint8_t  register_address,
uint32_t  transfer_data 
)

Generic Write function.

Parameters
ctxClick object.
register_addressAddress where data be written.
transfer_dataData to be written.

@description This function writes 24-bit data to the register.