com.pi4j.component.motor.impl

Class GpioStepperMotorComponent

java.lang.Object

com.pi4j.component.ComponentBase

com.pi4j.component.motor.MotorBase

com.pi4j.component.motor.StepperMotorBase

com.pi4j.component.motor.impl.GpioStepperMotorComponent

All Implemented Interfaces:

Component, Motor, StepperMotor

public class GpioStepperMotorComponent
extends StepperMotorBase

Field Summary

Fields inherited from class com.pi4j.component.motor.StepperMotorBase

stepIntervalMilliseconds, stepIntervalNanoseconds, stepSequence, stepsPerRevolution

Constructor Summary

Constructors

Constructor and Description
GpioStepperMotorComponent(GpioPinDigitalOutput[] pins) default constructor; using this constructor assumes that: (1) a pin state of HIGH is MOTOR STEP ON (2) a pin state of LOW is MOTOR STEP OFF
GpioStepperMotorComponent(GpioPinDigitalOutput[] pins, PinState onState, PinState offState) using this constructor requires that the consumer define the STEP ON and STEP OFF pin states

Method Summary

Methods

Modifier and Type	Method and Description
MotorState	getState() Return the current motor state
void	setState(MotorState state) change the current stepper motor state
void	step(long steps)

Methods inherited from class com.pi4j.component.motor.StepperMotorBase

getStepSequence, getStepsPerRevolution, rotate, setStepInterval, setStepInterval, setStepSequence, setStepsPerRevolution

Methods inherited from class com.pi4j.component.motor.MotorBase

forward, forward, isState, isStopped, reverse, reverse, stop

Methods inherited from class com.pi4j.component.ComponentBase

clearProperties, getName, getProperties, getProperty, getProperty, getTag, hasProperty, removeProperty, setName, setProperty, setTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pi4j.component.motor.Motor

forward, forward, isState, isStopped, reverse, reverse, stop

Methods inherited from interface com.pi4j.component.Component

clearProperties, getName, getProperties, getProperty, getProperty, getTag, hasProperty, removeProperty, setName, setProperty, setTag

Constructor Detail

GpioStepperMotorComponent

public GpioStepperMotorComponent(GpioPinDigitalOutput[] pins,
                         PinState onState,
                         PinState offState)

using this constructor requires that the consumer define the STEP ON and STEP OFF pin states

Parameters:

pins - GPIO digital output pins for each controller in the stepper motor

onState - pin state to set when MOTOR STEP is ON

offState - pin state to set when MOTOR STEP is OFF

GpioStepperMotorComponent

public GpioStepperMotorComponent(GpioPinDigitalOutput[] pins)

default constructor; using this constructor assumes that: (1) a pin state of HIGH is MOTOR STEP ON (2) a pin state of LOW is MOTOR STEP OFF

Parameters:

pins - GPIO digital output pins for each controller in the stepper motor

Method Detail

getState

public MotorState getState()

Return the current motor state

Specified by:

getState in interface Motor

Specified by:

getState in class MotorBase

Returns:

MotorState

setState

public void setState(MotorState state)

change the current stepper motor state

Specified by:

setState in interface Motor

Specified by:

setState in class MotorBase

Parameters:

state - new motor state to apply

step

public void step(long steps)

Specified by:

step in interface StepperMotor

Specified by:

step in class StepperMotorBase