hallcurrent15
2.0.0.0
|
API for configuring and manipulating Hall Current 15 Click driver. More...
Modules | |
Hall Current 15 Registers List | |
List of registers of Hall Current 15 Click driver. | |
Hall Current 15 Registers Settings | |
Settings for registers of Hall Current 15 Click driver. | |
Hall Current 15 MikroBUS Map | |
MikroBUS pin mapping of Hall Current 15 Click driver. | |
Functions | |
void | hallcurrent15_cfg_setup (hallcurrent15_cfg_t *cfg) |
Hall Current 15 configuration object setup function. More... | |
void | hallcurrent15_drv_interface_selection (hallcurrent15_cfg_t *cfg, hallcurrent15_drv_t drv_sel) |
Hall Current 15 driver interface setup function. More... | |
err_t | hallcurrent15_init (hallcurrent15_t *ctx, hallcurrent15_cfg_t *cfg) |
Hall Current 15 initialization function. More... | |
err_t | hallcurrent15_write_register (hallcurrent15_t *ctx, uint8_t reg, uint16_t data_in) |
Hall Current 15 write register function. More... | |
err_t | hallcurrent15_read_register (hallcurrent15_t *ctx, uint8_t reg, uint16_t *data_out) |
Hall Current 15 read register function. More... | |
uint8_t | hallcurrent15_get_alert_pin (hallcurrent15_t *ctx) |
Hall Current 15 get alert pin function. More... | |
err_t | hallcurrent15_read_raw_adc (hallcurrent15_t *ctx, uint16_t *raw_adc) |
Hall Current 15 read raw ADC value function. More... | |
err_t | hallcurrent15_read_voltage (hallcurrent15_t *ctx, float *voltage) |
Hall Current 15 read voltage level function. More... | |
err_t | hallcurrent15_set_vref (hallcurrent15_t *ctx, float vref) |
Hall Current 15 set vref function. More... | |
err_t | hallcurrent15_read_current (hallcurrent15_t *ctx, float *current) |
Hall Current 15 read current function. More... | |
API for configuring and manipulating Hall Current 15 Click driver.
void hallcurrent15_cfg_setup | ( | hallcurrent15_cfg_t * | cfg | ) |
Hall Current 15 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See hallcurrent15_cfg_t object definition for detailed explanation. |
void hallcurrent15_drv_interface_selection | ( | hallcurrent15_cfg_t * | cfg, |
hallcurrent15_drv_t | drv_sel | ||
) |
Hall Current 15 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 hallcurrent15_cfg_t object definition for detailed explanation. |
[in] | drv_sel | : Driver interface selection. See hallcurrent15_drv_t object definition for detailed explanation. |
uint8_t hallcurrent15_get_alert_pin | ( | hallcurrent15_t * | ctx | ) |
Hall Current 15 get alert pin function.
This function returns the alert (ALR) pin logic state.
[in] | ctx | : Click context object. See hallcurrent15_t object definition for detailed explanation. |
err_t hallcurrent15_init | ( | hallcurrent15_t * | ctx, |
hallcurrent15_cfg_t * | cfg | ||
) |
Hall Current 15 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See hallcurrent15_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See hallcurrent15_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t hallcurrent15_read_current | ( | hallcurrent15_t * | ctx, |
float * | current | ||
) |
Hall Current 15 read current function.
This function reads the input current level [A] based on HALLCURRENT15_NUM_CONVERSIONS of voltage measurements.
[in] | ctx | : Click context object. See hallcurrent15_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 hallcurrent15_read_raw_adc | ( | hallcurrent15_t * | ctx, |
uint16_t * | raw_adc | ||
) |
Hall Current 15 read raw ADC value function.
This function reads raw ADC value.
[in] | ctx | : Click context object. See hallcurrent15_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 hallcurrent15_read_register | ( | hallcurrent15_t * | ctx, |
uint8_t | reg, | ||
uint16_t * | data_out | ||
) |
Hall Current 15 read register function.
This function reads data from the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See hallcurrent15_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[out] | data_out | : Output data read. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t hallcurrent15_read_voltage | ( | hallcurrent15_t * | ctx, |
float * | voltage | ||
) |
Hall Current 15 read voltage level function.
This function reads raw ADC value and converts it to proportional voltage level.
[in] | ctx | : Click context object. See hallcurrent15_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 hallcurrent15_set_vref | ( | hallcurrent15_t * | ctx, |
float | vref | ||
) |
Hall Current 15 set vref function.
This function sets the voltage reference for Hall Current 15 click driver.
[in] | ctx | : Click context object. See hallcurrent15_t object definition for detailed explanation. |
[in] | vref | : Reference voltage (volts). |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t hallcurrent15_write_register | ( | hallcurrent15_t * | ctx, |
uint8_t | reg, | ||
uint16_t | data_in | ||
) |
Hall Current 15 write register function.
This function writes a desired data to the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See hallcurrent15_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[in] | data_in | : Data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.