opto3  2.0.0.0
Functions
Public function

Functions

void opto3_cfg_setup (opto3_cfg_t *cfg)
 Config Object Initialization function. More...
 
OPTO3_RETVAL opto3_init (opto3_t *ctx, opto3_cfg_t *cfg)
 Initialization function. More...
 
OPTO3_STATE opto3_get_in1 (opto3_t *ctx)
 Gets input. More...
 
OPTO3_STATE opto3_get_in2 (opto3_t *ctx)
 Gets input. More...
 
void opto3_set_out1 (opto3_t *ctx, OPTO3_SWITCH state)
 Gets output. More...
 
void opto3_set_out2 (opto3_t *ctx, OPTO3_SWITCH state)
 Gets output. More...
 

Detailed Description

Function Documentation

◆ opto3_cfg_setup()

void opto3_cfg_setup ( opto3_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.

◆ opto3_get_in1()

OPTO3_STATE opto3_get_in1 ( opto3_t ctx)

Gets input.

Parameters
ctxClick object.

@description This function gets input from pin 1.

◆ opto3_get_in2()

OPTO3_STATE opto3_get_in2 ( opto3_t ctx)

Gets input.

Parameters
ctxClick object.

@description This function gets input from pin 2.

◆ opto3_init()

OPTO3_RETVAL opto3_init ( opto3_t ctx,
opto3_cfg_t cfg 
)

Initialization function.

Parameters
opto3Click object.
cfgClick configuration structure.

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

◆ opto3_set_out1()

void opto3_set_out1 ( opto3_t ctx,
OPTO3_SWITCH  state 
)

Gets output.

Parameters
ctxClick object.
statePin state @description This function sets output pin 1.

◆ opto3_set_out2()

void opto3_set_out2 ( opto3_t ctx,
OPTO3_SWITCH  state 
)

Gets output.

Parameters
ctxClick object.
statePin state @description This function sets output pin 2.