currentlimit5
2.0.0.0
|
API for configuring and manipulating Current Limit 5 Click driver. More...
Modules | |
Current Limit 5 Settings | |
Settings of Current Limit 5 Click driver. | |
Current Limit 5 MikroBUS Map | |
MikroBUS pin mapping of Current Limit 5 Click driver. | |
Functions | |
void | currentlimit5_cfg_setup (currentlimit5_cfg_t *cfg) |
Current Limit 5 configuration object setup function. More... | |
err_t | currentlimit5_init (currentlimit5_t *ctx, currentlimit5_cfg_t *cfg) |
Current Limit 5 initialization function. More... | |
err_t | currentlimit5_default_cfg (currentlimit5_t *ctx) |
Current Limit 5 default configuration function. More... | |
err_t | currentlimit5_set_ilimit (currentlimit5_t *ctx, currentlimit5_ilimit_t ilimit) |
Current Limit 5 set ilimit function. More... | |
uint8_t | currentlimit5_get_fault_pin (currentlimit5_t *ctx) |
Current Limit 5 get fault pin function. More... | |
void | currentlimit5_enable_limit (currentlimit5_t *ctx) |
Current Limit 5 enable limit function. More... | |
void | currentlimit5_disable_limit (currentlimit5_t *ctx) |
Current Limit 5 disable limit function. More... | |
API for configuring and manipulating Current Limit 5 Click driver.
void currentlimit5_cfg_setup | ( | currentlimit5_cfg_t * | cfg | ) |
Current Limit 5 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See currentlimit5_cfg_t object definition for detailed explanation. |
err_t currentlimit5_default_cfg | ( | currentlimit5_t * | ctx | ) |
Current Limit 5 default configuration function.
This function executes a default configuration of Current Limit 5 click board.
[in] | ctx | : Click context object. See currentlimit5_t object definition for detailed explanation. |
0
- Success, -1
- Error.void currentlimit5_disable_limit | ( | currentlimit5_t * | ctx | ) |
Current Limit 5 disable limit function.
This function disables the current limiting switch.
[in] | ctx | : Click context object. See currentlimit5_t object definition for detailed explanation. |
void currentlimit5_enable_limit | ( | currentlimit5_t * | ctx | ) |
Current Limit 5 enable limit function.
This function enables the current limiting switch.
[in] | ctx | : Click context object. See currentlimit5_t object definition for detailed explanation. |
uint8_t currentlimit5_get_fault_pin | ( | currentlimit5_t * | ctx | ) |
Current Limit 5 get fault pin function.
This function returns the fault pin logic state.
[in] | ctx | : Click context object. See currentlimit5_t object definition for detailed explanation. |
0
- Current limiting or thermal shutdown operation, 1
- Normal operation. err_t currentlimit5_init | ( | currentlimit5_t * | ctx, |
currentlimit5_cfg_t * | cfg | ||
) |
Current Limit 5 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See currentlimit5_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See currentlimit5_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t currentlimit5_set_ilimit | ( | currentlimit5_t * | ctx, |
currentlimit5_ilimit_t | ilimit | ||
) |
Current Limit 5 set ilimit function.
This function sets the current limit value by configuring the onboard digital potentiometer.
[in] | ctx | : Click context object. See currentlimit5_t object definition for detailed explanation. |
[in] | ilimit | : Ilimit value. See currentlimit5_ilimit_t enum definition for detailed explanation. |
0
- Success, -1
- Error.