com.raspoid.additionalcomponents

Class RotaryEncoder

java.lang.Object

com.raspoid.GPIOComponent

com.raspoid.additionalcomponents.Button

com.raspoid.additionalcomponents.RotaryEncoder

All Implemented Interfaces:

Component

public class RotaryEncoder
extends Button

A rotary encoder is an electro-mechanical device that converts the motion of a shaft or axle to digital code.

A rotary encoders is usually placed at the side which is perpendicular to the shaft. They act as sensors for detecting angle, speed, length, position, and acceleration in automation field.

Example datasheet: Rotary Encoder

Example of use: RotaryEncoderExample

Field Summary

Fields inherited from class com.raspoid.additionalcomponents.Button

digitalInput

Fields inherited from class com.raspoid.GPIOComponent

gpio

Constructor Summary

Constructors

Constructor and Description
RotaryEncoder(GPIOPin swPin, GPIOPin dtPin, GPIOPin clkPin) Constructor for a new rotary encoder using specific GPIO pin for sw, dt and clk pins.

Method Summary

Modifier and Type	Method and Description
int	getCounterValue() Get the current value of the counter corresponding to the position of the shaft.
void	getEncoderTurn() Updates the value of the counter used for this rotary encoder.

Methods inherited from class com.raspoid.additionalcomponents.Button

getGpioPinDigitalInput, isPressed

Methods inherited from class com.raspoid.GPIOComponent

getType

Methods inherited from class java.lang.Object

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

Constructor Detail

RotaryEncoder

public RotaryEncoder(GPIOPin swPin,
                     GPIOPin dtPin,
                     GPIOPin clkPin)

Constructor for a new rotary encoder using specific GPIO pin for sw, dt and clk pins.

Parameters:

swPin - GPIO pin corresponding to the push button of the encoder.

dtPin - GPIO pin corresponding to the data signal from the encoder.

clkPin - GPIO pin corresponding to the clock from the encoder.

Method Detail

getEncoderTurn

public void getEncoderTurn()

Updates the value of the counter used for this rotary encoder.

The counter is used to represent the position of the shaft. If you turn to the right, the counter is incremeted by one for each tick. If you turn to the left, the counter is then decremented by one for each tick.

See Also:

getCounterValue()

getCounterValue

public int getCounterValue()

Get the current value of the counter corresponding to the position of the shaft.

Returns:

the value of the counter corresponding to the position of the shaft.