public class BrickletDistanceUS extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletDistanceUS.DistanceCallbackThreshold |
static interface |
BrickletDistanceUS.DistanceListener
This listener is triggered periodically with the period that is set by
setDistanceCallbackPeriod(long) . |
static interface |
BrickletDistanceUS.DistanceReachedListener
This listener is triggered when the threshold as set by
setDistanceCallbackThreshold(char, int, int) is reached. |
Device.Identity
Modifier and Type | Field and Description |
---|---|
static String |
DEVICE_DISPLAY_NAME |
static int |
DEVICE_IDENTIFIER |
static byte |
FUNCTION_GET_DEBOUNCE_PERIOD |
static byte |
FUNCTION_GET_DISTANCE_CALLBACK_PERIOD |
static byte |
FUNCTION_GET_DISTANCE_CALLBACK_THRESHOLD |
static byte |
FUNCTION_GET_DISTANCE_VALUE |
static byte |
FUNCTION_GET_IDENTITY |
static byte |
FUNCTION_GET_MOVING_AVERAGE |
static byte |
FUNCTION_SET_DEBOUNCE_PERIOD |
static byte |
FUNCTION_SET_DISTANCE_CALLBACK_PERIOD |
static byte |
FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD |
static byte |
FUNCTION_SET_MOVING_AVERAGE |
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 |
---|
BrickletDistanceUS(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addDistanceListener(BrickletDistanceUS.DistanceListener listener)
Adds a Distance listener.
|
void |
addDistanceReachedListener(BrickletDistanceUS.DistanceReachedListener listener)
Adds a DistanceReached listener.
|
long |
getDebouncePeriod()
Returns the debounce period as set by
setDebouncePeriod(long) . |
long |
getDistanceCallbackPeriod()
Returns the period as set by
setDistanceCallbackPeriod(long) . |
BrickletDistanceUS.DistanceCallbackThreshold |
getDistanceCallbackThreshold()
Returns the threshold as set by
setDistanceCallbackThreshold(char, int, int) . |
int |
getDistanceValue()
Returns the current distance value measured by the sensor.
|
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.
|
short |
getMovingAverage()
Returns the length moving average as set by
setMovingAverage(short) . |
void |
removeDistanceListener(BrickletDistanceUS.DistanceListener listener)
Removes a Distance listener.
|
void |
removeDistanceReachedListener(BrickletDistanceUS.DistanceReachedListener listener)
Removes a DistanceReached listener.
|
void |
setDebouncePeriod(long debounce)
Sets the period with which the threshold listeners
*
BrickletDistanceUS.DistanceReachedListener ,
are triggered, if the thresholds
* setDistanceCallbackThreshold(char, int, int) ,
keep being reached. |
void |
setDistanceCallbackPeriod(long period)
Sets the period with which the
BrickletDistanceUS.DistanceListener listener is triggered
periodically. |
void |
setDistanceCallbackThreshold(char option,
int min,
int max)
Sets the thresholds for the
BrickletDistanceUS.DistanceReachedListener listener. |
void |
setMovingAverage(short average)
Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__
for the distance value.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_DISTANCE_VALUE
public static final byte FUNCTION_SET_DISTANCE_CALLBACK_PERIOD
public static final byte FUNCTION_GET_DISTANCE_CALLBACK_PERIOD
public static final byte FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_DISTANCE_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_DEBOUNCE_PERIOD
public static final byte FUNCTION_GET_DEBOUNCE_PERIOD
public static final byte FUNCTION_SET_MOVING_AVERAGE
public static final byte FUNCTION_GET_MOVING_AVERAGE
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 BrickletDistanceUS(String uid, IPConnection ipcon)
public int getDistanceValue() throws TinkerforgeException
BrickletDistanceUS.DistanceListener
listener and set the period with
setDistanceCallbackPeriod(long)
.TinkerforgeException
public void setDistanceCallbackPeriod(long period) throws TinkerforgeException
BrickletDistanceUS.DistanceListener
listener is triggered
periodically. A value of 0 turns the listener off.
Der BrickletDistanceUS.DistanceListener
listener is only triggered if the distance value has changed
since the last triggering.TinkerforgeException
public long getDistanceCallbackPeriod() throws TinkerforgeException
setDistanceCallbackPeriod(long)
.TinkerforgeException
public void setDistanceCallbackThreshold(char option, int min, int max) throws TinkerforgeException
BrickletDistanceUS.DistanceReachedListener
listener.
The following options are possible:
\verbatim
"Option", "Description"
"'x'", "Listener is turned off"
"'o'", "Listener is triggered when the distance value is *outside* the min and max values"
"'i'", "Listener is triggered when the distance value is *inside* the min and max values"
"'<'", "Listener is triggered when the distance value is smaller than the min value (max is ignored)"
"'>'", "Listener is triggered when the distance value is greater than the min value (max is ignored)"
\endverbatimTinkerforgeException
public BrickletDistanceUS.DistanceCallbackThreshold getDistanceCallbackThreshold() throws TinkerforgeException
setDistanceCallbackThreshold(char, int, int)
.TinkerforgeException
public void setDebouncePeriod(long debounce) throws TinkerforgeException
BrickletDistanceUS.DistanceReachedListener
,
are triggered, if the thresholds
* setDistanceCallbackThreshold(char, int, int)
,
keep being reached.TinkerforgeException
public long getDebouncePeriod() throws TinkerforgeException
setDebouncePeriod(long)
.TinkerforgeException
public void setMovingAverage(short average) throws TinkerforgeException
TinkerforgeException
public short getMovingAverage() throws TinkerforgeException
setMovingAverage(short)
.TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addDistanceListener(BrickletDistanceUS.DistanceListener listener)
public void removeDistanceListener(BrickletDistanceUS.DistanceListener listener)
public void addDistanceReachedListener(BrickletDistanceUS.DistanceReachedListener listener)
public void removeDistanceReachedListener(BrickletDistanceUS.DistanceReachedListener listener)
Copyright © 2022 Tinkerforge GmbH. All rights reserved.