public class BrickletRotaryEncoder extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletRotaryEncoder.CountCallbackThreshold |
static interface |
BrickletRotaryEncoder.CountListener
This listener is triggered periodically with the period that is set by
setCountCallbackPeriod(long) . |
static interface |
BrickletRotaryEncoder.CountReachedListener
This listener is triggered when the threshold as set by
setCountCallbackThreshold(char, int, int) is reached. |
static interface |
BrickletRotaryEncoder.PressedListener
This listener is triggered when the button is pressed.
|
static interface |
BrickletRotaryEncoder.ReleasedListener
This listener is triggered when the button is released.
|
Device.Identity
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEVICE_DISPLAY_NAME |
static int |
DEVICE_IDENTIFIER |
static byte |
FUNCTION_GET_COUNT |
static byte |
FUNCTION_GET_COUNT_CALLBACK_PERIOD |
static byte |
FUNCTION_GET_COUNT_CALLBACK_THRESHOLD |
static byte |
FUNCTION_GET_DEBOUNCE_PERIOD |
static byte |
FUNCTION_GET_IDENTITY |
static byte |
FUNCTION_IS_PRESSED |
static byte |
FUNCTION_SET_COUNT_CALLBACK_PERIOD |
static byte |
FUNCTION_SET_COUNT_CALLBACK_THRESHOLD |
static byte |
FUNCTION_SET_DEBOUNCE_PERIOD |
static char |
THRESHOLD_OPTION_GREATER |
static char |
THRESHOLD_OPTION_INSIDE |
static char |
THRESHOLD_OPTION_OFF |
static char |
THRESHOLD_OPTION_OUTSIDE |
static char |
THRESHOLD_OPTION_SMALLER |
Constructor and Description |
---|
BrickletRotaryEncoder(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addCountListener(BrickletRotaryEncoder.CountListener listener)
Adds a Count listener.
|
void |
addCountReachedListener(BrickletRotaryEncoder.CountReachedListener listener)
Adds a CountReached listener.
|
void |
addPressedListener(BrickletRotaryEncoder.PressedListener listener)
Adds a Pressed listener.
|
void |
addReleasedListener(BrickletRotaryEncoder.ReleasedListener listener)
Adds a Released listener.
|
int |
getCount(boolean reset)
Returns the current count of the encoder.
|
long |
getCountCallbackPeriod()
Returns the period as set by
setCountCallbackPeriod(long) . |
BrickletRotaryEncoder.CountCallbackThreshold |
getCountCallbackThreshold()
Returns the threshold as set by
setCountCallbackThreshold(char, int, int) . |
long |
getDebouncePeriod()
Returns the debounce period as set by
setDebouncePeriod(long) . |
Device.Identity |
getIdentity()
Returns the UID, the UID where the Bricklet is connected to,
the position, the hardware and firmware version as well as the
device identifier.
|
boolean |
isPressed()
Returns *true* if the button is pressed and *false* otherwise.
|
void |
removeCountListener(BrickletRotaryEncoder.CountListener listener)
Removes a Count listener.
|
void |
removeCountReachedListener(BrickletRotaryEncoder.CountReachedListener listener)
Removes a CountReached listener.
|
void |
removePressedListener(BrickletRotaryEncoder.PressedListener listener)
Removes a Pressed listener.
|
void |
removeReleasedListener(BrickletRotaryEncoder.ReleasedListener listener)
Removes a Released listener.
|
void |
setCountCallbackPeriod(long period)
Sets the period with which the
BrickletRotaryEncoder.CountListener listener is triggered
periodically. |
void |
setCountCallbackThreshold(char option,
int min,
int max)
Sets the thresholds for the
BrickletRotaryEncoder.CountReachedListener listener. |
void |
setDebouncePeriod(long debounce)
Sets the period with which the threshold listener
*
BrickletRotaryEncoder.CountReachedListener
is triggered, if the thresholds
* setCountCallbackThreshold(char, int, int)
keeps being reached. |
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final java.lang.String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_COUNT
public static final byte FUNCTION_SET_COUNT_CALLBACK_PERIOD
public static final byte FUNCTION_GET_COUNT_CALLBACK_PERIOD
public static final byte FUNCTION_SET_COUNT_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_COUNT_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_DEBOUNCE_PERIOD
public static final byte FUNCTION_GET_DEBOUNCE_PERIOD
public static final byte FUNCTION_IS_PRESSED
public static final byte FUNCTION_GET_IDENTITY
public static final char THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_GREATER
public BrickletRotaryEncoder(java.lang.String uid, IPConnection ipcon)
public int getCount(boolean reset) throws TinkerforgeException
TinkerforgeException
public void setCountCallbackPeriod(long period) throws TinkerforgeException
BrickletRotaryEncoder.CountListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickletRotaryEncoder.CountListener
listener is only triggered if the count has changed since the
last triggering.TinkerforgeException
public long getCountCallbackPeriod() throws TinkerforgeException
setCountCallbackPeriod(long)
.TinkerforgeException
public void setCountCallbackThreshold(char option, int min, int max) throws TinkerforgeException
BrickletRotaryEncoder.CountReachedListener
listener.
The following options are possible:
\verbatim
"Option", "Description"
"'x'", "Listener is turned off"
"'o'", "Listener is triggered when the count is *outside* the min and max values"
"'i'", "Listener is triggered when the count is *inside* the min and max values"
"'<'", "Listener is triggered when the count is smaller than the min value (max is ignored)"
"'>'", "Listener is triggered when the count is greater than the min value (max is ignored)"
\endverbatimTinkerforgeException
public BrickletRotaryEncoder.CountCallbackThreshold getCountCallbackThreshold() throws TinkerforgeException
setCountCallbackThreshold(char, int, int)
.TinkerforgeException
public void setDebouncePeriod(long debounce) throws TinkerforgeException
BrickletRotaryEncoder.CountReachedListener
is triggered, if the thresholds
* setCountCallbackThreshold(char, int, int)
keeps being reached.TinkerforgeException
public long getDebouncePeriod() throws TinkerforgeException
setDebouncePeriod(long)
.TinkerforgeException
public boolean isPressed() throws TinkerforgeException
BrickletRotaryEncoder.PressedListener
and BrickletRotaryEncoder.ReleasedListener
listeners
to handle the button.TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addCountListener(BrickletRotaryEncoder.CountListener listener)
public void removeCountListener(BrickletRotaryEncoder.CountListener listener)
public void addCountReachedListener(BrickletRotaryEncoder.CountReachedListener listener)
public void removeCountReachedListener(BrickletRotaryEncoder.CountReachedListener listener)
public void addPressedListener(BrickletRotaryEncoder.PressedListener listener)
public void removePressedListener(BrickletRotaryEncoder.PressedListener listener)
public void addReleasedListener(BrickletRotaryEncoder.ReleasedListener listener)
public void removeReleasedListener(BrickletRotaryEncoder.ReleasedListener listener)
Copyright © 2020 Tinkerforge GmbH. All rights reserved.