easypull 2.1.0.0
|
API for configuring and manipulating EasyPull Click driver. More...
Modules | |
EasyPull MikroBUS Map | |
MikroBUS pin mapping of EasyPull Click driver. | |
Easypull_set | |
Functions | |
void | easypull_cfg_setup (easypull_cfg_t *cfg) |
EasyPull configuration object setup function. More... | |
err_t | easypull_init (easypull_t *ctx, easypull_cfg_t *cfg) |
EasyPull initialization function. More... | |
uint8_t | easypull_get_an_pin (easypull_t *ctx) |
EasyPull AN pin reading function. More... | |
uint8_t | easypull_get_rst_pin (easypull_t *ctx) |
EasyPull RST pin reading function. More... | |
uint8_t | easypull_get_cs_pin (easypull_t *ctx) |
EasyPull CS pin reading function. More... | |
uint8_t | easypull_get_pwm_pin (easypull_t *ctx) |
EasyPull PWM pin reading function. More... | |
uint8_t | easypull_get_int_pin (easypull_t *ctx) |
EasyPull INT pin reading function. More... | |
API for configuring and manipulating EasyPull Click driver.
void easypull_cfg_setup | ( | easypull_cfg_t * | cfg | ) |
EasyPull configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See easypull_cfg_t object definition for detailed explanation. |
uint8_t easypull_get_an_pin | ( | easypull_t * | ctx | ) |
EasyPull AN pin reading function.
This function reads the state of the AN pin of EasyPull click board.
[in] | ctx | : Click context object. See easypull_t object definition for detailed explanation. |
0
- Low pin state, 1
- High pin state. uint8_t easypull_get_cs_pin | ( | easypull_t * | ctx | ) |
EasyPull CS pin reading function.
This function reads the state of the CS pin of EasyPull click board.
[in] | ctx | : Click context object. See easypull_t object definition for detailed explanation. |
0
- Low pin state, 1
- High pin state. uint8_t easypull_get_int_pin | ( | easypull_t * | ctx | ) |
EasyPull INT pin reading function.
This function reads the state of the INT pin of EasyPull click board.
[in] | ctx | : Click context object. See easypull_t object definition for detailed explanation. |
0
- Low pin state, 1
- High pin state. uint8_t easypull_get_pwm_pin | ( | easypull_t * | ctx | ) |
EasyPull PWM pin reading function.
This function reads the state of the PWM pin of EasyPull click board.
[in] | ctx | : Click context object. See easypull_t object definition for detailed explanation. |
0
- Low pin state, 1
- High pin state. uint8_t easypull_get_rst_pin | ( | easypull_t * | ctx | ) |
EasyPull RST pin reading function.
This function reads the state of the RST pin of EasyPull click board.
[in] | ctx | : Click context object. See easypull_t object definition for detailed explanation. |
0
- Low pin state, 1
- High pin state. err_t easypull_init | ( | easypull_t * | ctx, |
easypull_cfg_t * | cfg | ||
) |
EasyPull initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See easypull_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See easypull_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.