Loom_Relay class

Relay actuator module.

Contents

Base classes

class LoomActuator
Abstract base class of actuator modules.

Protected variables

byte pin
The digital pin the relay is connect to.
bool on
Whether the relay is on or off.

CONSTRUCTORS / DESTRUCTOR

Loom_Relay(LoomManager* manager, const byte pin = 10)
Constructor.
Loom_Relay(LoomManager* manager, JsonArrayConst p)
Constructor that takes Json Array, extracts args and delegates to regular constructor.
~Loom_Relay() defaulted
Destructor.

OPERATION

void package(JsonObject json) override
Not all actuators need a package method, implement with empty body.
auto dispatch(JsonObject json) -> bool override
Route command to driver.
void add_config(JsonObject json) override
Add configuration information to JsonObject.
void set(const bool state)
Set relay state.

Function documentation

Loom_Relay::Loom_Relay(LoomManager* manager, const byte pin = 10)

Constructor.

Parameters
manager
pin in Set(Int) | <10> | {5, 6, 9, 10, 11, 12, 13, 14("A0"), 15("A1"), 16("A2"), 17("A3"), 18("A4"), 19("A5")} | Which pin should be used to control the relay

Loom_Relay::Loom_Relay(LoomManager* manager, JsonArrayConst p)

Constructor that takes Json Array, extracts args and delegates to regular constructor.

Parameters
manager
p in The array of constuctor args to expand

void Loom_Relay::add_config(JsonObject json) override

Add configuration information to JsonObject.

Parameters
json in Json configuration object to add to

LoomManager iterates over modules to build complete configuration

void Loom_Relay::set(const bool state)

Set relay state.

Parameters
state in The state to set relay to (True=HIGH, False=LOW)