ireclipse 2.0.0.0

Functions

void ireclipse_cfg_setup (ireclipse_cfg_t *cfg)
 Config Object Initialization function.
 
IRECLIPSE_RETVAL ireclipse_init (ireclipse_t *ctx, ireclipse_cfg_t *cfg)
 Initialization function.
 
uint8_t ireclipse_int_status (ireclipse_t *ctx)
 Detecting states of IR beam from EE-SX198 photo interrupter sensor.
 

Detailed Description

Function Documentation

◆ ireclipse_cfg_setup()

void ireclipse_cfg_setup ( ireclipse_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ ireclipse_init()

IRECLIPSE_RETVAL ireclipse_init ( ireclipse_t * ctx,
ireclipse_cfg_t * cfg )

Initialization function.

Parameters
ireclipseClick object.
cfgClick configuration structure.

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

◆ ireclipse_int_status()

uint8_t ireclipse_int_status ( ireclipse_t * ctx)

Detecting states of IR beam from EE-SX198 photo interrupter sensor.

Parameters
ctxClick object.
Returns
State of INT pin:
 0 : beam not eclipsed;
 1 : beam is eclipsed;

Function states of IR beam from EE-SX198 photo interrupter sensor, ( eclipsed or not eclipsed ) and returns the state of the INT pin.