com.pi4j.component.servo

Interface ServoDriver

All Known Implementing Classes:

MaestroServoDriver, PCA9685GpioServoDriver, RPIServoBlasterServoDriver

public interface ServoDriver

This interface represents a driver hardware to produce pulses needed for driving a servo.

Author:

Daniel Sendula

Method Summary

Modifier and Type	Method and Description
Pin	getPin()
int	getServoPulseResolution() This is read only value driver is to provide to users of this class.
int	getServoPulseWidth() This method returns current servo pulse width.
void	setServoPulseWidth(int width) Sets servo pulse width in resolution provided by getServoPulseResolution().

Method Detail

getServoPulseWidth

int getServoPulseWidth()

This method returns current servo pulse width. Zero may represent this driver stopped producing pulses. Also, value of -1 may define undefined situation when this abstraction didn't get initial value yet and there is no way telling what real, hardware or software driver is sending.

Returns:

current servo pulse this driver is producing

setServoPulseWidth

void setServoPulseWidth(int width)

Sets servo pulse width in resolution provided by getServoPulseResolution(). Zero value may mean that this driver is currently not producing pulse. Negative values may, generally, be invalid.

Parameters:

width - pulse width in resolution read from getServoPulseResolution()

getServoPulseResolution

int getServoPulseResolution()

This is read only value driver is to provide to users of this class. It defines resolution getServoPulseWidth() and setServoPulseWidth(int) methods are operating in. Resolution is provided in 1/n (ms) where value returned from this method is n.

Returns:

resolution of servo pulse widths used in this interface

getPin

Pin getPin()