Loom_Relay Class Reference

#include <Loom_Relay.h>

Inheritance diagram for Loom_Relay:

Collaboration diagram for Loom_Relay:

Public Member Functions
	Loom_Relay (const byte controlPin=10)
	Loom_Relay (Manager &man, const byte controlPin=10)
void	control (JsonArray json) override
void	initialize () override
void	package (JsonObject json) override
void	printModuleName (const char *message) override
const char *	getModuleName () override
void	setState (bool state)
Public Member Functions inherited from Actuator
	Actuator (ACTUATOR_TYPE actType, int instance)
virtual void	initialize ()=0
virtual void	package (JsonObject json)=0
virtual void	control (JsonArray json)=0
void	printModuleName (const char *message) override
const char *	getModuleName () override
const char *	typeToString ()
int	get_instance_num ()
Public Member Functions inherited from Module
	Module (const char *modName)
void	setModuleName (const char *modName)
virtual const char *	getModuleName ()
virtual void	printModuleName (const char *message)
virtual void	initialize ()=0
virtual void	measure ()=0
virtual void	package ()=0
virtual void	power_up ()=0
virtual void	power_down ()=0
virtual void	display_data ()

Additional Inherited Members
Public Attributes inherited from Module
bool	moduleInitialized = true
int	module_address = -1
Protected Member Functions inherited from Actuator
void	measure () override
void	power_up () override
void	power_down () override
void	package () override

Detailed Description

Relay controls for integration with Max

Author

Will Richards

Constructor & Destructor Documentation

Loom_Relay()

Loom_Relay::Loom_Relay	(	Manager &	man,
		const byte	controlPin = 10
	)

Construct a new object to manually control the relay

Parameters

man	Instance of the Manager

Member Function Documentation

control()

void Loom_Relay::control ( JsonArray  json )

overridevirtual

Called when a packet is received that needs to move the actuator

Parameters

json	The parameters that can change

Implements Actuator.

getModuleName()

const char * Loom_Relay::getModuleName ( )

inlineoverridevirtual

Reimplemented from Actuator.

initialize()

void Loom_Relay::initialize ( )

inlineoverridevirtual

Implements Actuator.

package()

void Loom_Relay::package ( JsonObject  json )

overridevirtual

Implements Actuator.

printModuleName()

void Loom_Relay::printModuleName ( const char *  message )

inlineoverridevirtual

Reimplemented from Actuator.

setState()

void Loom_Relay::setState

(

bool

state

)

Set the state of the relay

Parameters

state

New state of the relay

---

The documentation for this class was generated from the following files:

• C:/Users/jwilt/AppData/Local/Arduino15/packages/loom4/hardware/samd/4.5/libraries/Loom/src/Hardware/Actuators/Loom_Relay/Loom_Relay.h
• C:/Users/jwilt/AppData/Local/Arduino15/packages/loom4/hardware/samd/4.5/libraries/Loom/src/Hardware/Actuators/Loom_Relay/Loom_Relay.cpp