stepup2
2.1.0.0
|
API for configuring and manipulating Step Up 2 Click driver. More...
Modules | |
Step Up 2 Registers List | |
List of registers of Step Up 2 Click driver. | |
Step Up 2 Registers Settings | |
Settings for registers of Step Up 2 Click driver. | |
Step Up 2 MikroBUS Map | |
MikroBUS pin mapping of Step Up 2 Click driver. | |
Functions | |
void | stepup2_cfg_setup (stepup2_cfg_t *cfg) |
Step Up 2 configuration object setup function. More... | |
err_t | stepup2_init (stepup2_t *ctx, stepup2_cfg_t *cfg) |
Step Up 2 initialization function. More... | |
err_t | stepup2_default_cfg (stepup2_t *ctx) |
Step Up 2 default configuration function. More... | |
void | stepup2_enable (stepup2_t *ctx) |
Step Up 2 enable the device function. More... | |
void | stepup2_disable (stepup2_t *ctx) |
Step Up 2 disable the device function. More... | |
err_t | stepup2_write_data (stepup2_t *ctx, uint8_t ctrl_byte, uint8_t data_in) |
Step Up 2 data writing function. More... | |
err_t | stepup2_read_data (stepup2_t *ctx, uint8_t *data_out) |
Step Up 2 data reading function. More... | |
err_t | stepup2_set_wiper_pos (stepup2_t *ctx, uint8_t wiper_pos) |
Step Up 2 sets the wiper position function. More... | |
err_t | stepup2_set_resistance (stepup2_t *ctx, float res_kohm) |
Step Up 2 sets the resistance function. More... | |
err_t | stepup2_set_vout (stepup2_t *ctx, stepup2_vout_t vout) |
Step Up 2 sets the VOUT function. More... | |
API for configuring and manipulating Step Up 2 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void stepup2_cfg_setup | ( | stepup2_cfg_t * | cfg | ) |
Step Up 2 configuration object setup function.
This function initializes Click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See stepup2_cfg_t object definition for detailed explanation. |
err_t stepup2_default_cfg | ( | stepup2_t * | ctx | ) |
Step Up 2 default configuration function.
This function executes a default configuration of Step Up 2 Click board.
[in] | ctx | : Click context object. See stepup2_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void stepup2_disable | ( | stepup2_t * | ctx | ) |
Step Up 2 disable the device function.
This function turns off power switch and disable the boost mode of the TPS61299, 95-nA Quiescent Current, 5.5-V Boost Converter with Input Current Limit and Fast Transient Performance on the Step Up 2 Click board.
[in] | ctx | : Click context object. See stepup2_t object definition for detailed explanation. |
void stepup2_enable | ( | stepup2_t * | ctx | ) |
Step Up 2 enable the device function.
This function turns on the power switch and enables the boost mode of the TPS61299, 95-nA Quiescent Current, 5.5-V Boost Converter with Input Current Limit and Fast Transient Performance on the Step Up 2 Click board.
[in] | ctx | : Click context object. See stepup2_t object definition for detailed explanation. |
err_t stepup2_init | ( | stepup2_t * | ctx, |
stepup2_cfg_t * | cfg | ||
) |
Step Up 2 initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
[out] | ctx | : Click context object. See stepup2_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See stepup2_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepup2_read_data | ( | stepup2_t * | ctx, |
uint8_t * | data_out | ||
) |
Step Up 2 data reading function.
This function reads the volatile memory register and the wiper position of the MAX5419, 256-Tap, Nonvolatile, I2C-Interface, Digital Potentiometers on the Step Up 2 Click board.
[in] | ctx | : Click context object. See stepup2_t object definition for detailed explanation. |
[out] | data_out | : Output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepup2_set_resistance | ( | stepup2_t * | ctx, |
float | res_kohm | ||
) |
Step Up 2 sets the resistance function.
This function sets a desired resistance by writing to the volatile memory register and the wiper position of the MAX5419, 256-Tap, Nonvolatile, I2C-Interface, Digital Potentiometers on the Step Up 2 Click board.
[in] | ctx | : Click context object. See stepup2_t object definition for detailed explanation. |
[in] | res_kohm | : Resistance [0-200kOhm]. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepup2_set_vout | ( | stepup2_t * | ctx, |
stepup2_vout_t | vout | ||
) |
Step Up 2 sets the VOUT function.
This function sets the voltage output level by writes to the volatile memory register and the wiper position of the TPS61299, 95-nA Quiescent Current, 5.5-V Boost Converter with Input Current Limit and Fast Transient Performance on the Step Up 2 Click board.
[in] | ctx | : Click context object. See stepup2_t object definition for detailed explanation. |
[in] | vout | : Voltage output [2.5-5.5V]. See stepup2_vout_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepup2_set_wiper_pos | ( | stepup2_t * | ctx, |
uint8_t | wiper_pos | ||
) |
Step Up 2 sets the wiper position function.
This function writes to the volatile memory register and the wiper position updates with the data in the volatile memory register of the MAX5419, 256-Tap, Nonvolatile, I2C-Interface, Digital Potentiometers on the Step Up 2 Click board.
[in] | ctx | : Click context object. See stepup2_t object definition for detailed explanation. |
[in] | wiper_pos | : Wiper position [0-63]. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepup2_write_data | ( | stepup2_t * | ctx, |
uint8_t | ctrl_byte, | ||
uint8_t | data_in | ||
) |
Step Up 2 data writing function.
This function writes a desired data byte using the selected command of the MAX5419, 256-Tap, Nonvolatile, I2C-Interface, Digital Potentiometers on the Step Up 2 Click board.
[in] | ctx | : Click context object. See stepup2_t object definition for detailed explanation. |
[in] | ctrl_byte | : Control byte. See #stepup2_ctrl_byte object definition for detailed explanation. |
[in] | data_in | : Data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.