solidswitch8 2.1.0.0
|
API for configuring and manipulating SolidSwitch 8 Click driver. More...
Modules | |
SolidSwitch 8 Registers Settings | |
Settings for registers of SolidSwitch 8 Click driver. | |
SolidSwitch 8 MikroBUS Map | |
MikroBUS pin mapping of SolidSwitch 8 Click driver. | |
Functions | |
void | solidswitch8_cfg_setup (solidswitch8_cfg_t *cfg) |
SolidSwitch 8 configuration object setup function. More... | |
err_t | solidswitch8_init (solidswitch8_t *ctx, solidswitch8_cfg_t *cfg) |
SolidSwitch 8 initialization function. More... | |
void | solidswitch8_default_cfg (solidswitch8_t *ctx) |
SolidSwitch 8 default configuration function. More... | |
void | solidswitch8_set_err_pin (solidswitch8_t *ctx, uint8_t pin_state) |
SolidSwitch 8 err pin setting function. More... | |
void | solidswitch8_set_in_pin (solidswitch8_t *ctx, uint8_t pin_state) |
SolidSwitch 8 in pin setting function. More... | |
uint8_t | solidswitch8_get_sts_pin (solidswitch8_t *ctx) |
SolidSwitch 8 sts pin reading function. More... | |
API for configuring and manipulating SolidSwitch 8 Click driver.
void solidswitch8_cfg_setup | ( | solidswitch8_cfg_t * | cfg | ) |
SolidSwitch 8 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See solidswitch8_cfg_t object definition for detailed explanation. |
void solidswitch8_default_cfg | ( | solidswitch8_t * | ctx | ) |
SolidSwitch 8 default configuration function.
This function executes a default configuration of SolidSwitch 8 click board.
[in] | ctx | : Click context object. See solidswitch8_t object definition for detailed explanation. |
uint8_t solidswitch8_get_sts_pin | ( | solidswitch8_t * | ctx | ) |
SolidSwitch 8 sts pin reading function.
This function reads the state of the status pin of SolidSwitch 8 click board.
[in] | ctx | : Click context object. See solidswitch8_t object definition for detailed explanation. |
0
- Low pin state, 1
- High pin state. err_t solidswitch8_init | ( | solidswitch8_t * | ctx, |
solidswitch8_cfg_t * | cfg | ||
) |
SolidSwitch 8 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See solidswitch8_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See solidswitch8_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void solidswitch8_set_err_pin | ( | solidswitch8_t * | ctx, |
uint8_t | pin_state | ||
) |
SolidSwitch 8 err pin setting function.
This function sets the err pin state to the selected level of SolidSwitch 8 click board.
[in] | ctx | : Click context object. See solidswitch8_t object definition for detailed explanation. |
[in] | pin_state | : State of the selected pin. |
void solidswitch8_set_in_pin | ( | solidswitch8_t * | ctx, |
uint8_t | pin_state | ||
) |
SolidSwitch 8 in pin setting function.
This function sets the in pin state to the selected level of SolidSwitch 8 click board.
[in] | ctx | : Click context object. See solidswitch8_t object definition for detailed explanation. |
[in] | pin_state | : State of the selected pin. |