hallcurrent11 2.0.0.0
|
API for configuring and manipulating Hall Current 11 Click driver. More...
Modules | |
Hall Current 11 Registers Settings | |
Settings for registers of Hall Current 11 Click driver. | |
Hall Current 11 MikroBUS Map | |
MikroBUS pin mapping of Hall Current 11 Click driver. | |
Functions | |
void | hallcurrent11_cfg_setup (hallcurrent11_cfg_t *cfg) |
Hall Current 11 configuration object setup function. More... | |
err_t | hallcurrent11_init (hallcurrent11_t *ctx, hallcurrent11_cfg_t *cfg) |
Hall Current 11 initialization function. More... | |
err_t | hallcurrent11_default_cfg (hallcurrent11_t *ctx) |
Hall Current 11 default configuration function. More... | |
err_t | hallcurrent11_get_adc (hallcurrent11_t *ctx, uint16_t *data_out) |
Hall Current 11 ADC reading function. More... | |
err_t | hallcurrent11_get_adc_voltage (hallcurrent11_t *ctx, float *adc_vtg) |
Hall Current 11 get ADC voltage function. More... | |
err_t | hallcurrent11_get_current (hallcurrent11_t *ctx, float *current) |
Hall Current 11 get current function. More... | |
err_t | hallcurrent11_read_an_pin_voltage (hallcurrent11_t *ctx, float *data_out) |
Hall Current 11 read AN pin voltage level function. More... | |
API for configuring and manipulating Hall Current 11 Click driver.
void hallcurrent11_cfg_setup | ( | hallcurrent11_cfg_t * | cfg | ) |
Hall Current 11 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See hallcurrent11_cfg_t object definition for detailed explanation. |
err_t hallcurrent11_default_cfg | ( | hallcurrent11_t * | ctx | ) |
Hall Current 11 default configuration function.
This function executes a default configuration of Hall Current 11 click board.
[in] | ctx | : Click context object. See hallcurrent11_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t hallcurrent11_get_adc | ( | hallcurrent11_t * | ctx, |
uint16_t * | data_out | ||
) |
Hall Current 11 ADC reading function.
This function reads 12-bit ADC data.
[in] | ctx | : Click context object. See hallcurrent11_t object definition for detailed explanation. |
[out] | read_adc | : Output ADC read data. |
0
- Success, -1
- Error.err_t hallcurrent11_get_adc_voltage | ( | hallcurrent11_t * | ctx, |
float * | adc_vtg | ||
) |
Hall Current 11 get ADC voltage function.
This function reads 12-bit ADC data and calculate ADC voltage ( mV ).
[in] | ctx | : Click context object. See hallcurrent11_t object definition for detailed explanation. |
[out] | adc_vtg | : Output ADC voltage ( mV ) data. |
0
- Success, -1
- Error.err_t hallcurrent11_get_current | ( | hallcurrent11_t * | ctx, |
float * | current | ||
) |
Hall Current 11 get current function.
This function reads 12-bit ADC data and calculate current ( mA ).
[in] | ctx | : Click context object. See hallcurrent11_t object definition for detailed explanation. |
[out] | current | : Current ( mA ) data. |
0
- Success, -1
- Error.err_t hallcurrent11_init | ( | hallcurrent11_t * | ctx, |
hallcurrent11_cfg_t * | cfg | ||
) |
Hall Current 11 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See hallcurrent11_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See hallcurrent11_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t hallcurrent11_read_an_pin_voltage | ( | hallcurrent11_t * | ctx, |
float * | data_out | ||
) |
Hall Current 11 read AN pin voltage level function.
This function reads results of AD conversion of the AN pin and converts them to proportional voltage level.
[in] | ctx | : Click context object. See hallcurrent11_t object definition for detailed explanation. |
[out] | data_out | : Output voltage level of the analog pin ( V ). |
0
- Success, -1
- Error.