|
hallcurrent20 2.2.0
|
API for configuring and manipulating Hall Current 20 Click driver. More...
Topics | |
| Hall Current 20 Registers Settings | |
| Settings for registers of Hall Current 20 Click driver. | |
| Hall Current 20 MikroBUS Map | |
| MikroBUS pin mapping of Hall Current 20 Click driver. | |
Functions | |
| void | hallcurrent20_cfg_setup (hallcurrent20_cfg_t *cfg) |
| Hall Current 20 configuration object setup function. | |
| void | hallcurrent20_drv_interface_sel (hallcurrent20_cfg_t *cfg, hallcurrent20_drv_t drv_sel) |
| Hall Current 20 driver interface setup function. | |
| err_t | hallcurrent20_init (hallcurrent20_t *ctx, hallcurrent20_cfg_t *cfg) |
| Hall Current 20 initialization function. | |
| err_t | hallcurrent20_read_raw_adc (hallcurrent20_t *ctx, uint16_t *raw_adc) |
| Hall Current 20 read raw ADC value function. | |
| err_t | hallcurrent20_read_voltage (hallcurrent20_t *ctx, float *voltage) |
| Hall Current 20 read voltage level function. | |
| err_t | hallcurrent20_read_voltage_avg (hallcurrent20_t *ctx, uint16_t num_conv, float *voltage_avg) |
| Hall Current 20 read average voltage level function. | |
| err_t | hallcurrent20_set_vref (hallcurrent20_t *ctx, float vref) |
| Hall Current 20 set vref function. | |
| uint8_t | hallcurrent20_get_fault_pin (hallcurrent20_t *ctx) |
| Hall Current 20 get fault pin function. | |
| err_t | hallcurrent20_calib_offset (hallcurrent20_t *ctx) |
| Hall Current 20 calib offset function. | |
| err_t | hallcurrent20_calib_resolution (hallcurrent20_t *ctx, float calib_current) |
| Hall Current 20 calib resolution function. | |
| err_t | hallcurrent20_read_current (hallcurrent20_t *ctx, float *current) |
| Hall Current 20 read current function. | |
API for configuring and manipulating Hall Current 20 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 hallcurrent20_calib_offset | ( | hallcurrent20_t * | ctx | ) |
Hall Current 20 calib offset function.
This function calibrates the zero current offset value.
| [in] | ctx | : Click context object. See hallcurrent20_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t hallcurrent20_calib_resolution | ( | hallcurrent20_t * | ctx, |
| float | calib_current ) |
Hall Current 20 calib resolution function.
This function calibrates the data resolution at the known load current.
| [in] | ctx | : Click context object. See hallcurrent20_t object definition for detailed explanation. |
| [in] | calib_current | : The known load current used for calibrating data resolution. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | void hallcurrent20_cfg_setup | ( | hallcurrent20_cfg_t * | cfg | ) |
Hall Current 20 configuration object setup function.
This function initializes Click configuration structure to initial values.
| [out] | cfg | : Click configuration structure. See hallcurrent20_cfg_t object definition for detailed explanation. |
| void hallcurrent20_drv_interface_sel | ( | hallcurrent20_cfg_t * | cfg, |
| hallcurrent20_drv_t | drv_sel ) |
Hall Current 20 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 hallcurrent20_cfg_t object definition for detailed explanation. |
| [in] | drv_sel | : Driver interface selection. See hallcurrent20_drv_t object definition for detailed explanation. |
| uint8_t hallcurrent20_get_fault_pin | ( | hallcurrent20_t * | ctx | ) |
Hall Current 20 get fault pin function.
This function returns the overcurrent fault pin logic state.
| [in] | ctx | : Click context object. See hallcurrent20_t object definition for detailed explanation. |
| err_t hallcurrent20_init | ( | hallcurrent20_t * | ctx, |
| hallcurrent20_cfg_t * | cfg ) |
Hall Current 20 initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
| [out] | ctx | : Click context object. See hallcurrent20_t object definition for detailed explanation. |
| [in] | cfg | : Click configuration structure. See hallcurrent20_cfg_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t hallcurrent20_read_current | ( | hallcurrent20_t * | ctx, |
| float * | current ) |
Hall Current 20 read current function.
This function reads the input current level [A].
| [in] | ctx | : Click context object. See hallcurrent20_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 hallcurrent20_read_raw_adc | ( | hallcurrent20_t * | ctx, |
| uint16_t * | raw_adc ) |
Hall Current 20 read raw ADC value function.
This function reads raw ADC value.
| [in] | ctx | : Click context object. See hallcurrent20_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 hallcurrent20_read_voltage | ( | hallcurrent20_t * | ctx, |
| float * | voltage ) |
Hall Current 20 read voltage level function.
This function reads raw ADC value and converts it to proportional voltage level.
| [in] | ctx | : Click context object. See hallcurrent20_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 hallcurrent20_read_voltage_avg | ( | hallcurrent20_t * | ctx, |
| uint16_t | num_conv, | ||
| float * | voltage_avg ) |
Hall Current 20 read average voltage level function.
This function reads a desired number of ADC samples and calculates the average voltage level.
| [in] | ctx | : Click context object. See hallcurrent20_t object definition for detailed explanation. |
| [in] | num_conv | : Number of ADC samples. |
| [out] | voltage_avg | : Average output voltage level [V]. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t hallcurrent20_set_vref | ( | hallcurrent20_t * | ctx, |
| float | vref ) |
Hall Current 20 set vref function.
This function sets the voltage reference for Hall Current 20 Click driver.
| [in] | ctx | : Click context object. See hallcurrent20_t object definition for detailed explanation. |
| [in] | vref | : Reference voltage (volts). |
0 - Success, -1 - Error. See #err_t definition for detailed explanation.