public class BrickletUVLight extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletUVLight.UVLightCallbackThreshold |
static interface |
BrickletUVLight.UVLightListener
This listener is triggered periodically with the period that is set by
setUVLightCallbackPeriod(long) . |
static interface |
BrickletUVLight.UVLightReachedListener
This listener is triggered when the threshold as set by
setUVLightCallbackThreshold(char, long, long) 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_UV_LIGHT |
static byte |
FUNCTION_GET_UV_LIGHT_CALLBACK_PERIOD |
static byte |
FUNCTION_GET_UV_LIGHT_CALLBACK_THRESHOLD |
static byte |
FUNCTION_SET_DEBOUNCE_PERIOD |
static byte |
FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD |
static byte |
FUNCTION_SET_UV_LIGHT_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 |
---|
BrickletUVLight(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addUVLightListener(BrickletUVLight.UVLightListener listener)
Adds a UVLight listener.
|
void |
addUVLightReachedListener(BrickletUVLight.UVLightReachedListener listener)
Adds a UVLightReached 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.
|
long |
getUVLight()
Returns the UV light intensity of the sensor.
|
long |
getUVLightCallbackPeriod()
Returns the period as set by
setUVLightCallbackPeriod(long) . |
BrickletUVLight.UVLightCallbackThreshold |
getUVLightCallbackThreshold()
Returns the threshold as set by
setUVLightCallbackThreshold(char, long, long) . |
void |
removeUVLightListener(BrickletUVLight.UVLightListener listener)
Removes a UVLight listener.
|
void |
removeUVLightReachedListener(BrickletUVLight.UVLightReachedListener listener)
Removes a UVLightReached listener.
|
void |
setDebouncePeriod(long debounce)
Sets the period with which the threshold listeners
*
BrickletUVLight.UVLightReachedListener ,
are triggered, if the thresholds
* setUVLightCallbackThreshold(char, long, long) ,
keep being reached. |
void |
setUVLightCallbackPeriod(long period)
Sets the period with which the
BrickletUVLight.UVLightListener listener is triggered
periodically. |
void |
setUVLightCallbackThreshold(char option,
long min,
long max)
Sets the thresholds for the
BrickletUVLight.UVLightReachedListener 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_UV_LIGHT
public static final byte FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD
public static final byte FUNCTION_GET_UV_LIGHT_CALLBACK_PERIOD
public static final byte FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_UV_LIGHT_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 BrickletUVLight(java.lang.String uid, IPConnection ipcon)
public long getUVLight() throws TinkerforgeException
BrickletUVLight.UVLightListener
listener and set the period with
setUVLightCallbackPeriod(long)
.TinkerforgeException
public void setUVLightCallbackPeriod(long period) throws TinkerforgeException
BrickletUVLight.UVLightListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickletUVLight.UVLightListener
listener is only triggered if the intensity has changed since
the last triggering.TinkerforgeException
public long getUVLightCallbackPeriod() throws TinkerforgeException
setUVLightCallbackPeriod(long)
.TinkerforgeException
public void setUVLightCallbackThreshold(char option, long min, long max) throws TinkerforgeException
BrickletUVLight.UVLightReachedListener
listener.
The following options are possible:
\verbatim
"Option", "Description"
"'x'", "Listener is turned off"
"'o'", "Listener is triggered when the intensity is *outside* the min and max values"
"'i'", "Listener is triggered when the intensity is *inside* the min and max values"
"'<'", "Listener is triggered when the intensity is smaller than the min value (max is ignored)"
"'>'", "Listener is triggered when the intensity is greater than the min value (max is ignored)"
\endverbatimTinkerforgeException
public BrickletUVLight.UVLightCallbackThreshold getUVLightCallbackThreshold() throws TinkerforgeException
setUVLightCallbackThreshold(char, long, long)
.TinkerforgeException
public void setDebouncePeriod(long debounce) throws TinkerforgeException
BrickletUVLight.UVLightReachedListener
,
are triggered, if the thresholds
* setUVLightCallbackThreshold(char, long, long)
,
keep being reached.TinkerforgeException
public long getDebouncePeriod() throws TinkerforgeException
setDebouncePeriod(long)
.TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addUVLightListener(BrickletUVLight.UVLightListener listener)
public void removeUVLightListener(BrickletUVLight.UVLightListener listener)
public void addUVLightReachedListener(BrickletUVLight.UVLightReachedListener listener)
public void removeUVLightReachedListener(BrickletUVLight.UVLightReachedListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.