current11
2.1.0.0
|
API for configuring and manipulating Current 11 Click driver. More...
Modules | |
Current 11 Registers Settings | |
Settings for registers of Current 11 Click driver. | |
Current 11 MikroBUS Map | |
MikroBUS pin mapping of Current 11 Click driver. | |
Functions | |
void | current11_cfg_setup (current11_cfg_t *cfg) |
Current 11 configuration object setup function. More... | |
void | current11_drv_interface_sel (current11_cfg_t *cfg, current11_drv_t drv_sel) |
Current 11 driver interface setup function. More... | |
err_t | current11_init (current11_t *ctx, current11_cfg_t *cfg) |
Current 11 initialization function. More... | |
err_t | current11_read_raw_adc (current11_t *ctx, uint16_t *raw_adc) |
Current 11 read raw ADC value function. More... | |
err_t | current11_read_voltage (current11_t *ctx, float *voltage) |
Current 11 read voltage level function. More... | |
err_t | current11_set_vref (current11_t *ctx, float vref) |
Current 11 set vref function. More... | |
err_t | current11_calibrate_offset (current11_t *ctx) |
Current 11 calibrate offset function. More... | |
err_t | current11_read_current (current11_t *ctx, float *current) |
Current 11 read current function. More... | |
API for configuring and manipulating Current 11 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 current11_calibrate_offset | ( | current11_t * | ctx | ) |
Current 11 calibrate offset function.
This function calibrates the zero current offset value.
[in] | ctx | : Click context object. See current11_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void current11_cfg_setup | ( | current11_cfg_t * | cfg | ) |
Current 11 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See current11_cfg_t object definition for detailed explanation. |
void current11_drv_interface_sel | ( | current11_cfg_t * | cfg, |
current11_drv_t | drv_sel | ||
) |
Current 11 driver interface setup function.
This function sets a serial driver interface which will be used further in the click driver.
[out] | cfg | : Click configuration structure. See current11_cfg_t object definition for detailed explanation. |
[in] | drv_sel | : Driver interface selection. See current11_drv_t object definition for detailed explanation. |
err_t current11_init | ( | current11_t * | ctx, |
current11_cfg_t * | cfg | ||
) |
Current 11 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See current11_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See current11_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t current11_read_current | ( | current11_t * | ctx, |
float * | current | ||
) |
Current 11 read current function.
This function reads the input current level [A] based on CURRENT11_NUM_CONVERSIONS of voltage measurements.
[in] | ctx | : Click context object. See current11_t object definition for detailed explanation. |
[out] | current | : Input current level [A]. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t current11_read_raw_adc | ( | current11_t * | ctx, |
uint16_t * | raw_adc | ||
) |
Current 11 read raw ADC value function.
This function reads raw ADC value.
[in] | ctx | : Click context object. See current11_t object definition for detailed explanation. |
[out] | raw_adc | : Output ADC result. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t current11_read_voltage | ( | current11_t * | ctx, |
float * | voltage | ||
) |
Current 11 read voltage level function.
This function reads raw ADC value and converts it to proportional voltage level.
[in] | ctx | : Click context object. See current11_t object definition for detailed explanation. |
[out] | voltage | : Output voltage level [V]. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t current11_set_vref | ( | current11_t * | ctx, |
float | vref | ||
) |
Current 11 set vref function.
This function sets the voltage reference for Current 11 click driver.
[in] | ctx | : Click context object. See current11_t object definition for detailed explanation. |
[in] | vref | : Reference voltage (volts). |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.