boost11
2.1.0.0
|
API for configuring and manipulating Boost 11 Click driver. More...
Modules | |
Boost 11 Registers List | |
List of registers of Boost 11 Click driver. | |
Boost 11 Registers Settings | |
Settings for registers of Boost 11 Click driver. | |
Boost 11 MikroBUS Map | |
MikroBUS pin mapping of Boost 11 Click driver. | |
Functions | |
void | boost11_cfg_setup (boost11_cfg_t *cfg) |
Boost 11 configuration object setup function. More... | |
err_t | boost11_init (boost11_t *ctx, boost11_cfg_t *cfg) |
Boost 11 initialization function. More... | |
void | boost11_active_mode (boost11_t *ctx) |
Boost 11 enable function. More... | |
void | boost11_standby_mode (boost11_t *ctx) |
Boost 11 disable function. More... | |
err_t | boost11_read_an_pin_value (boost11_t *ctx, uint16_t *data_out) |
Boost 11 read AN pin value function. More... | |
err_t | boost11_read_an_pin_voltage (boost11_t *ctx, float *data_out) |
Boost 11 read AN pin voltage level function. More... | |
err_t | boost11_set_vref (boost11_t *ctx, float vref) |
Boost 11 set vref function. More... | |
API for configuring and manipulating Boost 11 Click driver.
void boost11_active_mode | ( | boost11_t * | ctx | ) |
Boost 11 enable function.
This function activates the boost operating mode.
[in] | ctx | : Click context object. See boost11_t object definition for detailed explanation. |
void boost11_cfg_setup | ( | boost11_cfg_t * | cfg | ) |
Boost 11 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See boost11_cfg_t object definition for detailed explanation. |
err_t boost11_init | ( | boost11_t * | ctx, |
boost11_cfg_t * | cfg | ||
) |
Boost 11 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See boost11_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See boost11_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t boost11_read_an_pin_value | ( | boost11_t * | ctx, |
uint16_t * | data_out | ||
) |
Boost 11 read AN pin value function.
This function reads results of AD conversion of the AN pin.
[in] | ctx | : Click context object. See boost11_t object definition for detailed explanation. |
[out] | data_out | : Output ADC result. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t boost11_read_an_pin_voltage | ( | boost11_t * | ctx, |
float * | data_out | ||
) |
Boost 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 boost11_t object definition for detailed explanation. |
[out] | data_out | : Output voltage level of the analog pin [V]. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t boost11_set_vref | ( | boost11_t * | ctx, |
float | vref | ||
) |
Boost 11 set vref function.
This function sets the voltage reference for Boost 11 click driver.
[in] | ctx | : Click context object. See boost11_t object definition for detailed explanation. |
[in] | vref | : Reference voltage (volts). |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.