Package com.opensourcewithslu.inputdevices

Class RotaryEncoderHelper

java.lang.Object

com.opensourcewithslu.inputdevices.RotaryEncoderHelper

public class RotaryEncoderHelper
extends Object

The RotaryEncoderHelper class initializes a rotary encoder component and returns the value of the encoder when called upon.

Constructor Summary

Constructors

Constructor	Description
RotaryEncoderHelper(MultiPinConfiguration multiPin)	The RotaryEncoderHelper constructor.

Method Summary

Modifier and Type	Method	Description
int	getEncoderValue()	Gets the value of the rotary encoder.
void	initialize()	Initializes the listener that keeps track of the rotary encoder's position.

Methods inherited from class java.lang.Object

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

Constructor Details

RotaryEncoderHelper

public RotaryEncoderHelper(MultiPinConfiguration multiPin)

The RotaryEncoderHelper constructor.

Parameters:

multiPin - A MultiPinConfiguration Object.

Method Details

initialize

public void initialize()

Initializes the listener that keeps track of the rotary encoder's position. Automatically called when the RotaryEncoderHelper is instantiated.

getEncoderValue

public int getEncoderValue()

Gets the value of the rotary encoder.

Returns:

The value of the rotary encoder.