ipd2  2.1.0.0
Modules | Functions
IPD 2 Click Driver

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

Modules

 IPD 2 MikroBUS Map
 MikroBUS pin mapping of IPD 2 Click driver.
 

Functions

void ipd2_cfg_setup (ipd2_cfg_t *cfg)
 IPD 2 configuration object setup function. More...
 
err_t ipd2_init (ipd2_t *ctx, ipd2_cfg_t *cfg)
 IPD 2 initialization function. More...
 
void ipd2_enable_out1 (ipd2_t *ctx)
 IPD 2 enable OUT1 function. More...
 
void ipd2_disable_out1 (ipd2_t *ctx)
 IPD 2 disable OUT1 function. More...
 
void ipd2_enable_out2 (ipd2_t *ctx)
 IPD 2 enable OUT2 function. More...
 
void ipd2_disable_out2 (ipd2_t *ctx)
 IPD 2 disable OUT2 function. More...
 
uint8_t ipd2_get_st1_pin (ipd2_t *ctx)
 IPD 2 get ST1 pin function. More...
 
uint8_t ipd2_get_st2_pin (ipd2_t *ctx)
 IPD 2 get ST2 pin function. More...
 

Detailed Description

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

◆ ipd2_cfg_setup()

void ipd2_cfg_setup ( ipd2_cfg_t cfg)

IPD 2 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ ipd2_disable_out1()

void ipd2_disable_out1 ( ipd2_t ctx)

IPD 2 disable OUT1 function.

This function disables OUT1 by setting the IN1 pin to low logic state.

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

◆ ipd2_disable_out2()

void ipd2_disable_out2 ( ipd2_t ctx)

IPD 2 disable OUT2 function.

This function disables OUT2 by setting the IN2 pin to low logic state.

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

◆ ipd2_enable_out1()

void ipd2_enable_out1 ( ipd2_t ctx)

IPD 2 enable OUT1 function.

This function enables OUT1 by setting the IN1 pin to high logic state.

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

◆ ipd2_enable_out2()

void ipd2_enable_out2 ( ipd2_t ctx)

IPD 2 enable OUT2 function.

This function enables OUT2 by setting the IN2 pin to high logic state.

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

◆ ipd2_get_st1_pin()

uint8_t ipd2_get_st1_pin ( ipd2_t ctx)

IPD 2 get ST1 pin function.

This function returns the ST1 pin logic state.

Parameters
[in]ctx: Click context object. See ipd2_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ ipd2_get_st2_pin()

uint8_t ipd2_get_st2_pin ( ipd2_t ctx)

IPD 2 get ST2 pin function.

This function returns the ST2 pin logic state.

Parameters
[in]ctx: Click context object. See ipd2_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ ipd2_init()

err_t ipd2_init ( ipd2_t ctx,
ipd2_cfg_t cfg 
)

IPD 2 initialization function.

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

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