Include dependency graph for relay.h:

API Description

Functions
relay_context	relay_init (int pin)

void	relay_close (relay_context dev)

upm_result_t	relay_on (relay_context dev)

upm_result_t	relay_off (relay_context dev)

bool	relay_is_on (relay_context dev)

bool	relay_is_off (relay_context dev)

Typedefs
typedef struct _relay_context *	relay_context

Function Documentation

relay_context relay_init ( int pin )

relay init function

Parameters

pin	Pin to use

void relay_close ( relay_context dev )

relay destructor

upm_result_t relay_on ( relay_context dev )

Sets the relay switch to on (closed circuit). This allows current to flow and lights up the indicator LED.

upm_result_t relay_off ( relay_context dev )

Sets the relay switch to off (open circuit). This stops current from flowing and the indicator LED is not lit.

bool relay_is_on ( relay_context dev )

Checks whether the relay switch is closed.

bool relay_is_off ( relay_context dev )

Checks whether the relay switch is open.

device context