ireclipse2  2.1.0.0
Modules | Functions
IR Eclipse 2 Click Driver

API for configuring and manipulating IR Eclipse 2 Click driver. More...

Modules

 IR Eclipse 2 MikroBUS Map
 MikroBUS pin mapping of IR Eclipse 2 Click driver.
 
 Ireclipse2_set
 

Functions

void ireclipse2_cfg_setup (ireclipse2_cfg_t *cfg)
 IR Eclipse 2 configuration object setup function. More...
 
err_t ireclipse2_init (ireclipse2_t *ctx, ireclipse2_cfg_t *cfg)
 IR Eclipse 2 initialization function. More...
 
void ireclipse2_enable (ireclipse2_t *ctx)
 IR Eclipse 2 enable function. More...
 
void ireclipse2_disable (ireclipse2_t *ctx)
 IR Eclipse 2 disable function. More...
 
uint8_t ireclipse2_get_state (ireclipse2_t *ctx)
 IR Eclipse 2 get state function. More...
 

Detailed Description

API for configuring and manipulating IR Eclipse 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

◆ ireclipse2_cfg_setup()

void ireclipse2_cfg_setup ( ireclipse2_cfg_t cfg)

IR Eclipse 2 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ ireclipse2_disable()

void ireclipse2_disable ( ireclipse2_t ctx)

IR Eclipse 2 disable function.

This function disables the transmitter of the photo-microsensor of IR Eclipse 2 click board.

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

◆ ireclipse2_enable()

void ireclipse2_enable ( ireclipse2_t ctx)

IR Eclipse 2 enable function.

This function enables the transmitter of the photo-microsensor of IR Eclipse 2 click board.

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

◆ ireclipse2_get_state()

uint8_t ireclipse2_get_state ( ireclipse2_t ctx)

IR Eclipse 2 get state function.

This function detecting eclipse states of IR Eclipse 2 click board.

Parameters
[in]ctx: Click context object. See ireclipse2_t object definition for detailed explanation.
Returns
  • 0 - Eclipse not detected,
  • 1 - Eclipse is detected.
Note
None.

◆ ireclipse2_init()

err_t ireclipse2_init ( ireclipse2_t ctx,
ireclipse2_cfg_t cfg 
)

IR Eclipse 2 initialization function.

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

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