pwrmeter2
2.0.0.0
|
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... | |
void pwrmeter2_cfg_setup | ( | pwrmeter2_cfg_t * | cfg | ) |
Config Object Initialization function.
cfg | Click configuration structure. |
@description This function initializes click configuration structure to init state.
uint8_t pwrmeter2_check_data_ready | ( | pwrmeter2_t * | ctx, |
uint8_t | sel_chann | ||
) |
Data Ready Check function.
ctx | Click object. |
sel_chann | Determines which channel be checked. |
@description This function waits until conversion, for the desired channel, is finished and returns information about data width.
uint8_t pwrmeter2_check_ready_pin | ( | pwrmeter2_t * | ctx | ) |
Ready Pin Check function.
ctx | Click object. |
@description This function returns the state of the Data Ready ( DR ) pin.
void pwrmeter2_default_cfg | ( | pwrmeter2_t * | ctx | ) |
Click Default Configuration function.
ctx | Click object. |
@description This function executes default configuration for PWR Meter 2 click.
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.
ctx | Click object. |
wr_buf | Write data buffer |
wr_len | Number of byte in write data buffer |
rd_buf | Read data buffer |
rd_len | Number of byte in read data buffer |
@description Generic SPI transfer, for sending and receiving packages
void pwrmeter2_get_data | ( | pwrmeter2_t * | ctx, |
int32_t * | voltage_data, | ||
int32_t * | current_data, | ||
uint32_t * | power_data | ||
) |
Data Get function.
ctx | Click object. |
voltage_data | Stores the voltage data in mV. |
current_data | Stores the current data in mA. |
power_data | tores the power data in mW. |
@description This function gets the calculated voltage( mV ), current( mA ) and power( mW ) data.
uint8_t pwrmeter2_get_modulator_0 | ( | pwrmeter2_t * | ctx | ) |
Modulator 0 Get function.
ctx | Click object. |
@description This function returns the state of the modulator output for the channel 0.
uint8_t pwrmeter2_get_modulator_1 | ( | pwrmeter2_t * | ctx | ) |
Modulator 1 Get function.
ctx | Click object. |
@description This function returns the state of the modulator output for the channel 1.
PWRMETER2_RETVAL pwrmeter2_init | ( | pwrmeter2_t * | ctx, |
pwrmeter2_cfg_t * | cfg | ||
) |
Initialization function.
pwrmeter2 | Click object. |
cfg | Click configuration structure. |
@description This function initializes all necessary pins and peripherals used for this click.
uint8_t pwrmeter2_read_conv_data | ( | pwrmeter2_t * | ctx, |
uint32_t * | data_ch_0, | ||
uint32_t * | data_ch_1 | ||
) |
Read Converted Data function.
ctx | Click object. |
data_ch_0 | Buffer where the converted data from channel 0 register be stored. |
data_ch_1 | Buffer where the converted data from channel 1 register be stored. |
@description This function reads the converted data from both channels when conversion is finished.
uint8_t pwrmeter2_read_reg | ( | pwrmeter2_t * | ctx, |
uint8_t | register_address, | ||
uint32_t * | data_out, | ||
uint8_t | n_data | ||
) |
Generic Read function.
ctx | Click object. |
register_address | Address which from data be read. |
data_out | Number of data to be read. |
n_data | Buffer where data be stored. |
@description This function reads the desired number of 24-bit data from the register/registers.
void pwrmeter2_reset | ( | pwrmeter2_t * | ctx | ) |
Reset function.
ctx | Click object. |
@description This function performs the hardware reset and puts the device back to the normal operation mode after 1.2 seconds.
uint8_t pwrmeter2_write_reg | ( | pwrmeter2_t * | ctx, |
uint8_t | register_address, | ||
uint32_t | transfer_data | ||
) |
Generic Write function.
ctx | Click object. |
register_address | Address where data be written. |
transfer_data | Data to be written. |
@description This function writes 24-bit data to the register.