Loom_Stepper Class Reference

#include <Loom_Stepper.h>

Inheritance diagram for Loom_Stepper:

Collaboration diagram for Loom_Stepper:

Public Member Functions
	Loom_Stepper (Manager &man, int instance_num=0)
	Loom_Stepper (int instance_num=0)
	~Loom_Stepper ()
void	control (JsonArray json) override
void	initialize () override
void	package (JsonObject json) override
void	moveSteps (const uint16_t steps, const uint8_t speed, const bool clockwise=true)
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

Stepper Motor Control for Max

Author

Will Richards

Constructor & Destructor Documentation

Loom_Stepper()

Loom_Stepper::Loom_Stepper	(	Manager &	man,
		int	instance_num = 0
	)

Construct a new

~Loom_Stepper()

Loom_Stepper::~Loom_Stepper

(

)

Deconstructor to clean up motor controller pointers

Member Function Documentation

control()

void Loom_Stepper::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.

initialize()

void Loom_Stepper::initialize ( )

overridevirtual

Implements Actuator.

moveSteps()

void Loom_Stepper::moveSteps	(	const uint16_t	steps,
		const uint8_t	speed,
		const bool	clockwise = true
	)

Move the motor a set number of steps forward

Parameters

steps	Number of steps to move
speed	The speed to move steps
clockwise	If we want to rotate clockwise or counter clockwise

package()

void Loom_Stepper::package ( JsonObject  json )

overridevirtual

Implements Actuator.

---

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_Stepper/Loom_Stepper.h
• C:/Users/jwilt/AppData/Local/Arduino15/packages/loom4/hardware/samd/4.5/libraries/Loom/src/Hardware/Actuators/Loom_Stepper/Loom_Stepper.cpp