Actuator Class Reference

#include <Actuators.h>

Inheritance diagram for Actuator:

Collaboration diagram for Actuator:

Public Member Functions
	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 ()

Protected Member Functions
void	measure () override
void	power_up () override
void	power_down () override
void	package () override

Additional Inherited Members
Public Attributes inherited from Module
bool	moduleInitialized = true
int	module_address = -1

Detailed Description

All actuators eg. Servos, Steppers, etc. use this to allow for max control

Author

Will Richards

Member Function Documentation

control()

virtual void Actuator::control ( JsonArray  json )

pure virtual

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

Parameters

json	The parameters that can change

Implemented in Loom_Neopixel, Loom_Relay, Loom_Servo, and Loom_Stepper.

get_instance_num()

int Actuator::get_instance_num ( )

inline

Get the instance number of the actuator

getModuleName()

const char * Actuator::getModuleName ( )

inlineoverridevirtual

Reimplemented from Module.

initialize()

virtual void Actuator::initialize ( )

pure virtual

Implements Module.

measure()

void Actuator::measure ( )

inlineoverrideprotectedvirtual

Implements Module.

package()

void Actuator::package ( )

inlineoverrideprotectedvirtual

Implements Module.

power_down()

void Actuator::power_down ( )

inlineoverrideprotectedvirtual

Implements Module.

power_up()

void Actuator::power_up ( )

inlineoverrideprotectedvirtual

Implements Module.

printModuleName()

void Actuator::printModuleName ( const char *  message )

inlineoverridevirtual

Reimplemented from Module.

typeToString()

const char * Actuator::typeToString ( )

inline

Convert the type of actuator to a String

---

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

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