ipd2015 2.1.0.0
IPD 2015 Click Driver

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

Topics

 IPD 2015 MikroBUS Map
 MikroBUS pin mapping of IPD 2015 Click driver.
 
 Ipd2015_set
 

Functions

void ipd2015_cfg_setup (ipd2015_cfg_t *cfg)
 IPD 2015 configuration object setup function.
 
err_t ipd2015_init (ipd2015_t *ctx, ipd2015_cfg_t *cfg)
 IPD 2015 initialization function.
 
void ipd2015_all_pins_set (ipd2015_t *ctx)
 IPD 2015 pin setting function.
 
void ipd2015_all_pins_clear (ipd2015_t *ctx)
 IPD 2015 pin clearing function.
 
err_t ipd2015_set_out_level (ipd2015_t *ctx, uint8_t out_sel, uint8_t state)
 IPD 2015 set output level function.
 
uint8_t ipd2015_get_out_state (ipd2015_t *ctx)
 IPD 2015 get output level function.
 

Detailed Description

API for configuring and manipulating IPD 2015 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

◆ ipd2015_all_pins_clear()

void ipd2015_all_pins_clear ( ipd2015_t * ctx)

IPD 2015 pin clearing function.

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

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

◆ ipd2015_all_pins_set()

void ipd2015_all_pins_set ( ipd2015_t * ctx)

IPD 2015 pin setting function.

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

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

◆ ipd2015_cfg_setup()

void ipd2015_cfg_setup ( ipd2015_cfg_t * cfg)

IPD 2015 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ ipd2015_get_out_state()

uint8_t ipd2015_get_out_state ( ipd2015_t * ctx)

IPD 2015 get output level function.

This function is used to get output level state.

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

◆ ipd2015_init()

err_t ipd2015_init ( ipd2015_t * ctx,
ipd2015_cfg_t * cfg )

IPD 2015 initialization function.

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

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

◆ ipd2015_set_out_level()

err_t ipd2015_set_out_level ( ipd2015_t * ctx,
uint8_t out_sel,
uint8_t state )

IPD 2015 set output level function.

This function is used to set output level state.

Parameters
[out]ctx: Click context object. See ipd2015_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.