opto 2.0.0.0
Public function

Functions

void opto_cfg_setup (opto_cfg_t *cfg)
 Config Object Initialization function.
 
OPTO_RETVAL opto_init (opto_t *ctx, opto_cfg_t *cfg)
 Initialization function.
 
uint8_t opto_check_out1 (opto_t *ctx)
 OUT1 Check function.
 
uint8_t opto_check_out2 (opto_t *ctx)
 OUT2 Check function.
 
uint8_t opto_check_out3 (opto_t *ctx)
 OUT3 Check function.
 
uint8_t opto_check_out4 (opto_t *ctx)
 OUT4 Check function.
 

Detailed Description

Function Documentation

◆ opto_cfg_setup()

void opto_cfg_setup ( opto_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.

◆ opto_check_out1()

uint8_t opto_check_out1 ( opto_t * ctx)

OUT1 Check function.

Parameters
ctxClick object
Returns
'0' low state
'1' high state

@description Function checks the state of OUT1 pin.

◆ opto_check_out2()

uint8_t opto_check_out2 ( opto_t * ctx)

OUT2 Check function.

Parameters
ctxClick object
Returns
'0' low state
'1' high state

@description Function checks the state of OUT2 pin.

◆ opto_check_out3()

uint8_t opto_check_out3 ( opto_t * ctx)

OUT3 Check function.

Parameters
ctxClick object
Returns
'0' low state
'1' high state

@description Function checks the state of OUT3 pin.

◆ opto_check_out4()

uint8_t opto_check_out4 ( opto_t * ctx)

OUT4 Check function.

Parameters
ctxClick object
Returns
'0' low state
'1' high state

@description Function checks the state of OUT4 pin.

◆ opto_init()

OPTO_RETVAL opto_init ( opto_t * ctx,
opto_cfg_t * cfg )

Initialization function.

Parameters
optoClick object.
cfgClick configuration structure.

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