hallcurrent10
2.0.0.0
|
API for configuring and manipulating Hall Current 10 Click driver. More...
Modules | |
Hall Current 10 Registers Settings | |
Settings for registers of Hall Current 10 Click driver. | |
Hall Current 10 MikroBUS Map | |
MikroBUS pin mapping of Hall Current 10 Click driver. | |
Functions | |
void | hallcurrent10_cfg_setup (hallcurrent10_cfg_t *cfg) |
Hall Current 10 configuration object setup function. More... | |
err_t | hallcurrent10_init (hallcurrent10_t *ctx, hallcurrent10_cfg_t *cfg) |
Hall Current 10 initialization function. More... | |
err_t | hallcurrent10_default_cfg (hallcurrent10_t *ctx) |
Hall Current 10 default configuration function. More... | |
err_t | hallcurrent10_read_adc (hallcurrent10_t *ctx, uint16_t *read_adc) |
Hall Current 10 I2C ADC reading function. More... | |
err_t | hallcurrent10_get_adc_volatge (hallcurrent10_t *ctx, float *adc_vtg) |
Hall Current 10 get ADC voltage function. More... | |
err_t | hallcurrent10_get_current (hallcurrent10_t *ctx, float *current) |
Hall Current 10 get current function. More... | |
API for configuring and manipulating Hall Current 10 Click driver.
void hallcurrent10_cfg_setup | ( | hallcurrent10_cfg_t * | cfg | ) |
Hall Current 10 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See hallcurrent10_cfg_t object definition for detailed explanation. |
err_t hallcurrent10_default_cfg | ( | hallcurrent10_t * | ctx | ) |
Hall Current 10 default configuration function.
This function executes a default configuration of Hall Current 10 click board.
[in] | ctx | : Click context object. See hallcurrent10_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t hallcurrent10_get_adc_volatge | ( | hallcurrent10_t * | ctx, |
float * | adc_vtg | ||
) |
Hall Current 10 get ADC voltage function.
This function reads 12-bit ADC data and calculate ADC voltage ( mV ) by using I2C serial interface.
[in] | ctx | : Click context object. See hallcurrent10_t object definition for detailed explanation. |
[out] | adc_vtg | : Output ADC voltage ( mV ) data. |
0
- Success, -1
- Error.err_t hallcurrent10_get_current | ( | hallcurrent10_t * | ctx, |
float * | current | ||
) |
Hall Current 10 get current function.
This function reads 12-bit ADC data and calculate current ( mA ) by using I2C serial interface.
[in] | ctx | : Click context object. See hallcurrent10_t object definition for detailed explanation. |
[out] | current | : Current ( mA ) data. |
0
- Success, -1
- Error.err_t hallcurrent10_init | ( | hallcurrent10_t * | ctx, |
hallcurrent10_cfg_t * | cfg | ||
) |
Hall Current 10 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See hallcurrent10_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See hallcurrent10_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t hallcurrent10_read_adc | ( | hallcurrent10_t * | ctx, |
uint16_t * | read_adc | ||
) |
Hall Current 10 I2C ADC reading function.
This function reads 12-bit ADC data by using I2C serial interface.
[in] | ctx | : Click context object. See hallcurrent10_t object definition for detailed explanation. |
[out] | read_adc | : Output ADC read data. |
0
- Success, -1
- Error.