ipd2017 2.1.0.0
Modules | Functions
IPD 2017 Click Driver

API for configuring and manipulating IPD 2017 Click driver. More...

Modules

 IPD 2017 MikroBUS Map
 MikroBUS pin mapping of IPD 2017 Click driver.
 
 Ipd2017_set
 

Functions

void ipd2017_cfg_setup (ipd2017_cfg_t *cfg)
 IPD 2017 configuration object setup function. More...
 
err_t ipd2017_init (ipd2017_t *ctx, ipd2017_cfg_t *cfg)
 IPD 2017 initialization function. More...
 
void ipd2017_all_pins_set (ipd2017_t *ctx)
 IPD 2017 pin setting function. More...
 
void ipd2017_all_pins_clear (ipd2017_t *ctx)
 IPD 2017 pin clearing function. More...
 
err_t ipd2017_set_out_level (ipd2017_t *ctx, uint8_t out_sel, uint8_t state)
 IPD 2017 set output level function. More...
 
uint8_t ipd2017_get_out_state (ipd2017_t *ctx)
 IPD 2017 get output level function. More...
 

Detailed Description

API for configuring and manipulating IPD 2017 Click driver.

Function Documentation

◆ ipd2017_all_pins_clear()

void ipd2017_all_pins_clear ( ipd2017_t ctx)

IPD 2017 pin clearing function.

This function is usedd to set all pins to the low level of IPD 2017 click board.

Parameters
[in]ctx: Click context object. See ipd2017_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ ipd2017_all_pins_set()

void ipd2017_all_pins_set ( ipd2017_t ctx)

IPD 2017 pin setting function.

This function is used to set all pins to the high level of IPD 2017 click board.

Parameters
[in]ctx: Click context object. See ipd2017_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ ipd2017_cfg_setup()

void ipd2017_cfg_setup ( ipd2017_cfg_t cfg)

IPD 2017 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ ipd2017_get_out_state()

uint8_t ipd2017_get_out_state ( ipd2017_t ctx)

IPD 2017 get output level function.

This function is used to get output level state.

Parameters
[out]ctx: Click context object. See ipd2017_t object definition for detailed explanation.
Returns
State of the output pins.
Note
None.

◆ ipd2017_init()

err_t ipd2017_init ( ipd2017_t ctx,
ipd2017_cfg_t cfg 
)

IPD 2017 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters
[out]ctx: Click context object. See ipd2017_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See ipd2017_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ipd2017_set_out_level()

err_t ipd2017_set_out_level ( ipd2017_t ctx,
uint8_t  out_sel,
uint8_t  state 
)

IPD 2017 set output level function.

This function is used to set output level state.

Parameters
[out]ctx: Click context object. See ipd2017_t object definition for detailed explanation.
[in]out_sel: Selected output channel.
[in]state: State of the selected output channel.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.