public class BrickletLine extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletLine.ReflectivityCallbackThreshold |
static interface |
BrickletLine.ReflectivityListener
This listener is triggered periodically with the period that is set by
setReflectivityCallbackPeriod(long) . |
static interface |
BrickletLine.ReflectivityReachedListener
This listener is triggered when the threshold as set by
setReflectivityCallbackThreshold(char, int, int) is reached. |
Device.Identity
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEVICE_DISPLAY_NAME |
static int |
DEVICE_IDENTIFIER |
static byte |
FUNCTION_GET_DEBOUNCE_PERIOD |
static byte |
FUNCTION_GET_IDENTITY |
static byte |
FUNCTION_GET_REFLECTIVITY |
static byte |
FUNCTION_GET_REFLECTIVITY_CALLBACK_PERIOD |
static byte |
FUNCTION_GET_REFLECTIVITY_CALLBACK_THRESHOLD |
static byte |
FUNCTION_SET_DEBOUNCE_PERIOD |
static byte |
FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD |
static byte |
FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD |
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 |
---|
BrickletLine(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addReflectivityListener(BrickletLine.ReflectivityListener listener)
Adds a Reflectivity listener.
|
void |
addReflectivityReachedListener(BrickletLine.ReflectivityReachedListener listener)
Adds a ReflectivityReached listener.
|
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.
|
int |
getReflectivity()
Returns the currently measured reflectivity.
|
long |
getReflectivityCallbackPeriod()
Returns the period as set by
setReflectivityCallbackPeriod(long) . |
BrickletLine.ReflectivityCallbackThreshold |
getReflectivityCallbackThreshold()
Returns the threshold as set by
setReflectivityCallbackThreshold(char, int, int) . |
void |
removeReflectivityListener(BrickletLine.ReflectivityListener listener)
Removes a Reflectivity listener.
|
void |
removeReflectivityReachedListener(BrickletLine.ReflectivityReachedListener listener)
Removes a ReflectivityReached listener.
|
void |
setDebouncePeriod(long debounce)
Sets the period with which the threshold listener
*
BrickletLine.ReflectivityReachedListener
is triggered, if the threshold
* setReflectivityCallbackThreshold(char, int, int)
keeps being reached. |
void |
setReflectivityCallbackPeriod(long period)
Sets the period with which the
BrickletLine.ReflectivityListener listener is triggered
periodically. |
void |
setReflectivityCallbackThreshold(char option,
int min,
int max)
Sets the thresholds for the
BrickletLine.ReflectivityReachedListener listener. |
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_REFLECTIVITY
public static final byte FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD
public static final byte FUNCTION_GET_REFLECTIVITY_CALLBACK_PERIOD
public static final byte FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_REFLECTIVITY_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_DEBOUNCE_PERIOD
public static final byte FUNCTION_GET_DEBOUNCE_PERIOD
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 BrickletLine(java.lang.String uid, IPConnection ipcon)
public int getReflectivity() throws TinkerforgeException
BrickletLine.ReflectivityListener
listener and set the period with
setReflectivityCallbackPeriod(long)
.TinkerforgeException
public void setReflectivityCallbackPeriod(long period) throws TinkerforgeException
BrickletLine.ReflectivityListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickletLine.ReflectivityListener
listener is only triggered if the reflectivity has
changed since the last triggering.TinkerforgeException
public long getReflectivityCallbackPeriod() throws TinkerforgeException
setReflectivityCallbackPeriod(long)
.TinkerforgeException
public void setReflectivityCallbackThreshold(char option, int min, int max) throws TinkerforgeException
BrickletLine.ReflectivityReachedListener
listener.
The following options are possible:
\verbatim
"Option", "Description"
"'x'", "Listener is turned off"
"'o'", "Listener is triggered when the reflectivity is *outside* the min and max values"
"'i'", "Listener is triggered when the reflectivity is *inside* the min and max values"
"'<'", "Listener is triggered when the reflectivity is smaller than the min value (max is ignored)"
"'>'", "Listener is triggered when the reflectivity is greater than the min value (max is ignored)"
\endverbatimTinkerforgeException
public BrickletLine.ReflectivityCallbackThreshold getReflectivityCallbackThreshold() throws TinkerforgeException
setReflectivityCallbackThreshold(char, int, int)
.TinkerforgeException
public void setDebouncePeriod(long debounce) throws TinkerforgeException
BrickletLine.ReflectivityReachedListener
is triggered, if the threshold
* setReflectivityCallbackThreshold(char, int, int)
keeps being reached.TinkerforgeException
public long getDebouncePeriod() throws TinkerforgeException
setDebouncePeriod(long)
.TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addReflectivityListener(BrickletLine.ReflectivityListener listener)
public void removeReflectivityListener(BrickletLine.ReflectivityListener listener)
public void addReflectivityReachedListener(BrickletLine.ReflectivityReachedListener listener)
public void removeReflectivityReachedListener(BrickletLine.ReflectivityReachedListener listener)
Copyright © 2020 Tinkerforge GmbH. All rights reserved.