pwrmeter330a
2.1.0.0
|
API for configuring and manipulating PWR Meter 3 30A Click driver. More...
Modules | |
PWR Meter 3 30A Registers List | |
List of registers of PWR Meter 3 30A Click driver. | |
PWR Meter 3 30A Registers Settings | |
Settings for registers of PWR Meter 3 30A Click driver. | |
PWR Meter 3 30A MikroBUS Map | |
MikroBUS pin mapping of PWR Meter 3 30A Click driver. | |
Functions | |
void | pwrmeter330a_cfg_setup (pwrmeter330a_cfg_t *cfg) |
PWR Meter 3 30A configuration object setup function. More... | |
err_t | pwrmeter330a_init (pwrmeter330a_t *ctx, pwrmeter330a_cfg_t *cfg) |
PWR Meter 3 30A initialization function. More... | |
err_t | pwrmeter330a_default_cfg (pwrmeter330a_t *ctx) |
PWR Meter 3 30A default configuration function. More... | |
err_t | pwrmeter330a_write_register (pwrmeter330a_t *ctx, uint8_t reg, uint32_t data_in) |
PWR Meter 3 30A write register function. More... | |
err_t | pwrmeter330a_read_register (pwrmeter330a_t *ctx, uint8_t reg, uint32_t *data_out) |
PWR Meter 3 30A read register function. More... | |
uint8_t | pwrmeter330a_get_dio0_pin (pwrmeter330a_t *ctx) |
PWR Meter 3 30A get dio0 pin function. More... | |
uint8_t | pwrmeter330a_get_dio1_pin (pwrmeter330a_t *ctx) |
PWR Meter 3 30A get dio1 pin function. More... | |
void | pwrmeter330a_enable_device (pwrmeter330a_t *ctx) |
PWR Meter 3 30A enable device function. More... | |
void | pwrmeter330a_disable_device (pwrmeter330a_t *ctx) |
PWR Meter 3 30A disable device function. More... | |
err_t | pwrmeter330a_allow_write_access (pwrmeter330a_t *ctx) |
PWR Meter 3 30A allow write access function. More... | |
err_t | pwrmeter330a_deny_write_access (pwrmeter330a_t *ctx) |
PWR Meter 3 30A deny write access function. More... | |
err_t | pwrmeter330a_set_bypass_n_state (pwrmeter330a_t *ctx, uint8_t state) |
PWR Meter 3 30A set bypass n state function. More... | |
err_t | pwrmeter330a_set_num_samples (pwrmeter330a_t *ctx, uint16_t num_samples) |
PWR Meter 3 30A set num samples function. More... | |
err_t | pwrmeter330a_set_dio0_sel (pwrmeter330a_t *ctx, uint8_t dio_sel) |
PWR Meter 3 30A set dio0 sel function. More... | |
err_t | pwrmeter330a_set_dio1_sel (pwrmeter330a_t *ctx, uint8_t dio_sel) |
PWR Meter 3 30A set dio1 sel function. More... | |
err_t | pwrmeter330a_set_ovrms_thold (pwrmeter330a_t *ctx, uint8_t ovrms) |
PWR Meter 3 30A set ovrms threshold function. More... | |
err_t | pwrmeter330a_set_uvrms_thold (pwrmeter330a_t *ctx, uint8_t uvrms) |
PWR Meter 3 30A set uvrms threshold function. More... | |
err_t | pwrmeter330a_read_rms (pwrmeter330a_t *ctx, float *v_rms, float *i_rms) |
PWR Meter 3 30A read rms function. More... | |
err_t | pwrmeter330a_read_average_rms (pwrmeter330a_t *ctx, float *v_rms, float *i_rms, uint16_t num_avg) |
PWR Meter 3 30A read average rms function. More... | |
API for configuring and manipulating PWR Meter 3 30A Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
err_t pwrmeter330a_allow_write_access | ( | pwrmeter330a_t * | ctx | ) |
PWR Meter 3 30A allow write access function.
This function allows writing to registers by setting the correct write access code.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void pwrmeter330a_cfg_setup | ( | pwrmeter330a_cfg_t * | cfg | ) |
PWR Meter 3 30A configuration object setup function.
This function initializes Click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See pwrmeter330a_cfg_t object definition for detailed explanation. |
err_t pwrmeter330a_default_cfg | ( | pwrmeter330a_t * | ctx | ) |
PWR Meter 3 30A default configuration function.
This function executes a default configuration of PWR Meter 3 30A Click board.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t pwrmeter330a_deny_write_access | ( | pwrmeter330a_t * | ctx | ) |
PWR Meter 3 30A deny write access function.
This function denies writing to registers by setting the wrong write access code.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void pwrmeter330a_disable_device | ( | pwrmeter330a_t * | ctx | ) |
PWR Meter 3 30A disable device function.
This function disables device by setting the EN pin to HIGH logic state.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
void pwrmeter330a_enable_device | ( | pwrmeter330a_t * | ctx | ) |
PWR Meter 3 30A enable device function.
This function enables device by setting the EN pin to LOW logic state.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
uint8_t pwrmeter330a_get_dio0_pin | ( | pwrmeter330a_t * | ctx | ) |
PWR Meter 3 30A get dio0 pin function.
This function returns the DIO0 pin logic state.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
uint8_t pwrmeter330a_get_dio1_pin | ( | pwrmeter330a_t * | ctx | ) |
PWR Meter 3 30A get dio1 pin function.
This function returns the DIO1 pin logic state.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
err_t pwrmeter330a_init | ( | pwrmeter330a_t * | ctx, |
pwrmeter330a_cfg_t * | cfg | ||
) |
PWR Meter 3 30A initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
[out] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See pwrmeter330a_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t pwrmeter330a_read_average_rms | ( | pwrmeter330a_t * | ctx, |
float * | v_rms, | ||
float * | i_rms, | ||
uint16_t | num_avg | ||
) |
PWR Meter 3 30A read average rms function.
This function reads the voltage and current RMS measurements averaged from a specified number of samples.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
[out] | v_rms | : Averaged voltage RMS measurement in Volts. |
[out] | i_rms | : Averaged current RMS measurement in Ampers. |
[in] | num_avg | : Number of samples for averaging RMS measurements. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t pwrmeter330a_read_register | ( | pwrmeter330a_t * | ctx, |
uint8_t | reg, | ||
uint32_t * | data_out | ||
) |
PWR Meter 3 30A read register function.
This function reads a 32-bit data from the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[out] | data_out | : Output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t pwrmeter330a_read_rms | ( | pwrmeter330a_t * | ctx, |
float * | v_rms, | ||
float * | i_rms | ||
) |
PWR Meter 3 30A read rms function.
This function reads the voltage and current RMS measurements.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
[out] | v_rms | : Voltage RMS measurement in Volts. |
[out] | i_rms | : Current RMS measurement in Ampers. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t pwrmeter330a_set_bypass_n_state | ( | pwrmeter330a_t * | ctx, |
uint8_t | state | ||
) |
PWR Meter 3 30A set bypass n state function.
This function sets whether RMS is calculated based on voltage zero crossing (AC measurement) or predefined num samples (DC measurement).
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
[in] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t pwrmeter330a_set_dio0_sel | ( | pwrmeter330a_t * | ctx, |
uint8_t | dio_sel | ||
) |
PWR Meter 3 30A set dio0 sel function.
This function sets the DIO0 selection. Determines which flags are output on the DIO0 pin.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
[in] | dio_sel | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t pwrmeter330a_set_dio1_sel | ( | pwrmeter330a_t * | ctx, |
uint8_t | dio_sel | ||
) |
PWR Meter 3 30A set dio1 sel function.
This function sets the DIO1 selection. Determines which flags are output on the DIO1 pin.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
[in] | dio_sel | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t pwrmeter330a_set_num_samples | ( | pwrmeter330a_t * | ctx, |
uint16_t | num_samples | ||
) |
PWR Meter 3 30A set num samples function.
This function sets the number of samples for RMS calculations. Bypass N state must be set/true for this to have effect.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
[in] | num_samples | : 0-1023 samples, |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t pwrmeter330a_set_ovrms_thold | ( | pwrmeter330a_t * | ctx, |
uint8_t | ovrms | ||
) |
PWR Meter 3 30A set ovrms threshold function.
This function sets the overvoltage RMS threshold.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
[in] | ovrms | : 0-63 steps, a single step represents about 9.3V, |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t pwrmeter330a_set_uvrms_thold | ( | pwrmeter330a_t * | ctx, |
uint8_t | uvrms | ||
) |
PWR Meter 3 30A set uvrms threshold function.
This function sets the undervoltage RMS threshold.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
[in] | uvrms | : 0-63 steps, a single step represents about 9.3V, |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t pwrmeter330a_write_register | ( | pwrmeter330a_t * | ctx, |
uint8_t | reg, | ||
uint32_t | data_in | ||
) |
PWR Meter 3 30A write register function.
This function writes a desired 32-bit data to the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See pwrmeter330a_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[in] | data_in | : 32-bit data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.