com.pi4j.component.servo.impl

Class GenericServo

java.lang.Object

com.pi4j.component.ComponentBase

com.pi4j.component.servo.impl.GenericServo

All Implemented Interfaces:

Component, Servo

public class GenericServo
extends ComponentBase
implements Servo

Author:

Christian Wehrli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericServo.Orientation

Field Summary

Fields

Modifier and Type	Field and Description
static float	PWM_MAX
static float	PWM_MIN
static float	PWM_NEUTRAL

Fields inherited from interface com.pi4j.component.servo.Servo

END_POINT_MAX, END_POINT_MIN, POS_MAX_LEFT, POS_MAX_RIGHT, POS_NEUTRAL, PROP_END_POINT_DEFAULT, PROP_END_POINT_LEFT, PROP_END_POINT_RIGHT, PROP_IS_REVERSE, PROP_IS_REVERSE_DEFAULT, PROP_SUBTRIM, PROP_SUBTRIM_DEFAULT, SUBTRIM_MAX_LEFT, SUBTRIM_MAX_RIGHT, SUBTRIM_NEUTRAL

Constructor Summary

Constructors

Constructor and Description
GenericServo(ServoDriver servoDriver, String name)
GenericServo(ServoDriver servoDriver, String name, Map<String,String> properties)

Method Summary

Modifier and Type	Method and Description
float	getPosition()
protected int	getPwmDuration()
ServoDriver	getServoDriver() Returns servo driver this servo is attached to
protected void	init()
void	off() Make the servo passive.
void	setPosition(float position) Sets the servos desired position by providing a percentage value.
void	setProperty(String key, String value)
protected void	setServoDriver(ServoDriver servoDriver)
String	toString()

Methods inherited from class com.pi4j.component.ComponentBase

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pi4j.component.Component

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

Field Detail

PWM_MIN

public static final float PWM_MIN

See Also:

Constant Field Values

PWM_NEUTRAL

public static final float PWM_NEUTRAL

See Also:

Constant Field Values

PWM_MAX

public static final float PWM_MAX

See Also:

Constant Field Values

Constructor Detail

GenericServo

public GenericServo(ServoDriver servoDriver,
                    String name)

GenericServo

public GenericServo(ServoDriver servoDriver,
                    String name,
                    Map<String,String> properties)

Method Detail

setServoDriver

protected void setServoDriver(ServoDriver servoDriver)

getServoDriver

public ServoDriver getServoDriver()

Description copied from interface: Servo

Returns servo driver this servo is attached to

Specified by:

getServoDriver in interface Servo

Returns:

servo driver

setPosition

public void setPosition(float position)

Description copied from interface: Servo

Sets the servos desired position by providing a percentage value.

E.g.: a position value of -100 would force the servo to travel to its max. left position as defined in property Servo.PROP_END_POINT_LEFT.

Specified by:

setPosition in interface Servo

Parameters:

position - value between -100 and +100 according to Servo.POS_MAX_LEFT respectively Servo.POS_MAX_RIGHT.

getPosition

public float getPosition()

Specified by:

getPosition in interface Servo

Returns:

current position value between -100 and +100[%]

off

public void off()

Description copied from interface: Servo

Make the servo passive. How/if the happens is implementation specific.

Specified by:

off in interface Servo

getPwmDuration

protected int getPwmDuration()

setProperty

public void setProperty(String key,
                        String value)

Specified by:

setProperty in interface Component

Overrides:

setProperty in class ComponentBase

init

protected void init()

toString

public String toString()

Overrides:

toString in class Object