easypull 2.1.0.0
Topics | Functions
EasyPull Click Driver

API for configuring and manipulating EasyPull Click driver. More...

Topics

 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.
 
err_t easypull_init (easypull_t *ctx, easypull_cfg_t *cfg)
 EasyPull initialization function.
 
uint8_t easypull_get_an_pin (easypull_t *ctx)
 EasyPull AN pin reading function.
 
uint8_t easypull_get_rst_pin (easypull_t *ctx)
 EasyPull RST pin reading function.
 
uint8_t easypull_get_cs_pin (easypull_t *ctx)
 EasyPull CS pin reading function.
 
uint8_t easypull_get_pwm_pin (easypull_t *ctx)
 EasyPull PWM pin reading function.
 
uint8_t easypull_get_int_pin (easypull_t *ctx)
 EasyPull INT pin reading function.
 

Detailed Description

API for configuring and manipulating EasyPull Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ easypull_cfg_setup()

void easypull_cfg_setup ( easypull_cfg_t * cfg)

EasyPull configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See easypull_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ easypull_get_an_pin()

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.

Parameters
[in]ctx: Click context object. See easypull_t object definition for detailed explanation.
Returns
  • 0 - Low pin state,
  • 1 - High pin state.
Note
None.

◆ easypull_get_cs_pin()

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.

Parameters
[in]ctx: Click context object. See easypull_t object definition for detailed explanation.
Returns
  • 0 - Low pin state,
  • 1 - High pin state.
Note
None.

◆ easypull_get_int_pin()

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.

Parameters
[in]ctx: Click context object. See easypull_t object definition for detailed explanation.
Returns
  • 0 - Low pin state,
  • 1 - High pin state.
Note
None.

◆ easypull_get_pwm_pin()

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.

Parameters
[in]ctx: Click context object. See easypull_t object definition for detailed explanation.
Returns
  • 0 - Low pin state,
  • 1 - High pin state.
Note
None.

◆ easypull_get_rst_pin()

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.

Parameters
[in]ctx: Click context object. See easypull_t object definition for detailed explanation.
Returns
  • 0 - Low pin state,
  • 1 - High pin state.
Note
None.

◆ easypull_init()

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.

Parameters
[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.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.