signalrelay  2.0.0.0
Functions

Functions

void signalrelay_cfg_setup (signalrelay_cfg_t *cfg)
 Config Object Initialization function. More...
 
SIGNALRELAY_RETVAL signalrelay_init (signalrelay_t *ctx, signalrelay_cfg_t *cfg)
 Initialization function. More...
 
void signalrelay_default_cfg (signalrelay_t *ctx)
 Click Default Configuration function. More...
 
void signalrelay_relay_state (signalrelay_t *ctx, uint8_t relay, uint8_t state)
 Relays state. More...
 

Detailed Description

Function Documentation

◆ signalrelay_cfg_setup()

void signalrelay_cfg_setup ( signalrelay_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.

◆ signalrelay_default_cfg()

void signalrelay_default_cfg ( signalrelay_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for SignalRelay click.

Note
All relays are initially set to OFF state.

◆ signalrelay_init()

SIGNALRELAY_RETVAL signalrelay_init ( signalrelay_t ctx,
signalrelay_cfg_t cfg 
)

Initialization function.

Parameters
signalrelayClick object.
cfgClick configuration structure.

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

◆ signalrelay_relay_state()

void signalrelay_relay_state ( signalrelay_t ctx,
uint8_t  relay,
uint8_t  state 
)

Relays state.

Parameters
ctxClick object.
relayNumber of relay (Relay 1/2/3/4)
stateRelay state (ON or OFF)