relay3 2.0.0.0
Public function

Functions

void relay3_cfg_setup (relay3_cfg_t *cfg)
 Config Object Initialization function.
 
RELAY3_RETVAL relay3_init (relay3_t *ctx, relay3_cfg_t *cfg)
 Initialization function.
 
void relay3_relay_on (relay3_t *ctx, uint8_t relay)
 Relay on function.
 
void relay3_relay_off (relay3_t *ctx, uint8_t relay)
 Relay off function.
 
void relay3_on_delay (relay3_t *ctx, uint8_t relay, uint8_t units, uint16_t time)
 Relay on with delay function.
 

Detailed Description

Function Documentation

◆ relay3_cfg_setup()

void relay3_cfg_setup ( relay3_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.

◆ relay3_init()

RELAY3_RETVAL relay3_init ( relay3_t * ctx,
relay3_cfg_t * cfg )

Initialization function.

Parameters
relay3Click object.
cfgClick configuration structure.

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

◆ relay3_on_delay()

void relay3_on_delay ( relay3_t * ctx,
uint8_t relay,
uint8_t units,
uint16_t time )

Relay on with delay function.

Relay off with delay function.

Parameters
cfgClick configuration structure.
relayRelay choice (1/2).
unitsUnit variable (ms/s).
timeDelay duration variable.

@description This function turns on one of the relays after the delay time passes.

Parameters
cfgClick configuration structure.
relayRelay choice (1/2).
unitsUnit variable (ms/s).
timeDelay duration variable.

@description This function turns off one of the relays after the delay time passes.

◆ relay3_relay_off()

void relay3_relay_off ( relay3_t * ctx,
uint8_t relay )

Relay off function.

Parameters
cfgClick configuration structure.
relayRelay choice (1/2).

@description This function turns off either the 1st or the 2nd relay on the click.

◆ relay3_relay_on()

void relay3_relay_on ( relay3_t * ctx,
uint8_t relay )

Relay on function.

Parameters
cfgClick configuration structure.
relayRelay choice (1/2).

@description This function turns on either the 1st or the 2nd relay on the click.