Package com.tinkerforge
Class BrickletHumidity
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletHumidity
-
public class BrickletHumidity extends Device
Measures relative humidity
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletHumidity.AnalogValueCallbackThreshold
static interface
BrickletHumidity.AnalogValueListener
This listener is triggered periodically with the period that is set bysetAnalogValueCallbackPeriod(long)
.static interface
BrickletHumidity.AnalogValueReachedListener
This listener is triggered when the threshold as set bysetAnalogValueCallbackThreshold(char, int, int)
is reached.class
BrickletHumidity.HumidityCallbackThreshold
static interface
BrickletHumidity.HumidityListener
This listener is triggered periodically with the period that is set bysetHumidityCallbackPeriod(long)
.static interface
BrickletHumidity.HumidityReachedListener
This listener is triggered when the threshold as set bysetHumidityCallbackThreshold(char, int, int)
is reached.-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEVICE_DISPLAY_NAME
static int
DEVICE_IDENTIFIER
static byte
FUNCTION_GET_ANALOG_VALUE
static byte
FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD
static byte
FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD
static byte
FUNCTION_GET_DEBOUNCE_PERIOD
static byte
FUNCTION_GET_HUMIDITY
static byte
FUNCTION_GET_HUMIDITY_CALLBACK_PERIOD
static byte
FUNCTION_GET_HUMIDITY_CALLBACK_THRESHOLD
static byte
FUNCTION_GET_IDENTITY
static byte
FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD
static byte
FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD
static byte
FUNCTION_SET_DEBOUNCE_PERIOD
static byte
FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD
static byte
FUNCTION_SET_HUMIDITY_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 Summary
Constructors Constructor Description BrickletHumidity(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_HUMIDITY
public static final byte FUNCTION_GET_HUMIDITY
- See Also:
- Constant Field Values
-
FUNCTION_GET_ANALOG_VALUE
public static final byte FUNCTION_GET_ANALOG_VALUE
- See Also:
- Constant Field Values
-
FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD
public static final byte FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_HUMIDITY_CALLBACK_PERIOD
public static final byte FUNCTION_GET_HUMIDITY_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD
public static final byte FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD
public static final byte FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_GET_HUMIDITY_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_HUMIDITY_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_SET_DEBOUNCE_PERIOD
public static final byte FUNCTION_SET_DEBOUNCE_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_DEBOUNCE_PERIOD
public static final byte FUNCTION_GET_DEBOUNCE_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OFF
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_OUTSIDE
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_INSIDE
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_SMALLER
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_GREATER
public static final char THRESHOLD_OPTION_GREATER
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletHumidity
public BrickletHumidity(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
getHumidity
public int getHumidity() throws TinkerforgeException
Returns the humidity of the sensor. If you want to get the humidity periodically, it is recommended to use theBrickletHumidity.HumidityListener
listener and set the period withsetHumidityCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
getAnalogValue
public int getAnalogValue() throws TinkerforgeException
Returns the value as read by a 12-bit analog-to-digital converter. \note The value returned bygetHumidity()
is averaged over several samples to yield less noise, whilegetAnalogValue()
gives back raw unfiltered analog values. The returned humidity value is calibrated for room temperatures, if you use the sensor in extreme cold or extreme warm environments, you might want to calculate the humidity from the analog value yourself. See the `HIH 5030 datasheet <https://github.com/Tinkerforge/humidity-bricklet/raw/master/datasheets/hih-5030.pdf>`__. If you want the analog value periodically, it is recommended to use theBrickletHumidity.AnalogValueListener
listener and set the period withsetAnalogValueCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setHumidityCallbackPeriod
public void setHumidityCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickletHumidity.HumidityListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickletHumidity.HumidityListener
listener is only triggered if the humidity has changed since the last triggering.- Throws:
TinkerforgeException
-
getHumidityCallbackPeriod
public long getHumidityCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetHumidityCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setAnalogValueCallbackPeriod
public void setAnalogValueCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickletHumidity.AnalogValueListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickletHumidity.AnalogValueListener
listener is only triggered if the analog value has changed since the last triggering.- Throws:
TinkerforgeException
-
getAnalogValueCallbackPeriod
public long getAnalogValueCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetAnalogValueCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setHumidityCallbackThreshold
public void setHumidityCallbackThreshold(char option, int min, int max) throws TinkerforgeException
Sets the thresholds for theBrickletHumidity.HumidityReachedListener
listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Listener is turned off" "'o'", "Listener is triggered when the humidity is *outside* the min and max values" "'i'", "Listener is triggered when the humidity is *inside* the min and max values" "'<'", "Listener is triggered when the humidity is smaller than the min value (max is ignored)" "'>'", "Listener is triggered when the humidity is greater than the min value (max is ignored)" \endverbatim- Throws:
TinkerforgeException
-
getHumidityCallbackThreshold
public BrickletHumidity.HumidityCallbackThreshold getHumidityCallbackThreshold() throws TinkerforgeException
Returns the threshold as set bysetHumidityCallbackThreshold(char, int, int)
.- Throws:
TinkerforgeException
-
setAnalogValueCallbackThreshold
public void setAnalogValueCallbackThreshold(char option, int min, int max) throws TinkerforgeException
Sets the thresholds for theBrickletHumidity.AnalogValueReachedListener
listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Listener is turned off" "'o'", "Listener is triggered when the analog value is *outside* the min and max values" "'i'", "Listener is triggered when the analog value is *inside* the min and max values" "'<'", "Listener is triggered when the analog value is smaller than the min value (max is ignored)" "'>'", "Listener is triggered when the analog value is greater than the min value (max is ignored)" \endverbatim- Throws:
TinkerforgeException
-
getAnalogValueCallbackThreshold
public BrickletHumidity.AnalogValueCallbackThreshold getAnalogValueCallbackThreshold() throws TinkerforgeException
Returns the threshold as set bysetAnalogValueCallbackThreshold(char, int, int)
.- Throws:
TinkerforgeException
-
setDebouncePeriod
public void setDebouncePeriod(long debounce) throws TinkerforgeException
Sets the period with which the threshold listeners *BrickletHumidity.HumidityReachedListener
, *BrickletHumidity.AnalogValueReachedListener
are triggered, if the thresholds *setHumidityCallbackThreshold(char, int, int)
, *setAnalogValueCallbackThreshold(char, int, int)
keep being reached.- Throws:
TinkerforgeException
-
getDebouncePeriod
public long getDebouncePeriod() throws TinkerforgeException
Returns the debounce period as set bysetDebouncePeriod(long)
.- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier. The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
addHumidityListener
public void addHumidityListener(BrickletHumidity.HumidityListener listener)
Adds a Humidity listener.
-
removeHumidityListener
public void removeHumidityListener(BrickletHumidity.HumidityListener listener)
Removes a Humidity listener.
-
addAnalogValueListener
public void addAnalogValueListener(BrickletHumidity.AnalogValueListener listener)
Adds a AnalogValue listener.
-
removeAnalogValueListener
public void removeAnalogValueListener(BrickletHumidity.AnalogValueListener listener)
Removes a AnalogValue listener.
-
addHumidityReachedListener
public void addHumidityReachedListener(BrickletHumidity.HumidityReachedListener listener)
Adds a HumidityReached listener.
-
removeHumidityReachedListener
public void removeHumidityReachedListener(BrickletHumidity.HumidityReachedListener listener)
Removes a HumidityReached listener.
-
addAnalogValueReachedListener
public void addAnalogValueReachedListener(BrickletHumidity.AnalogValueReachedListener listener)
Adds a AnalogValueReached listener.
-
removeAnalogValueReachedListener
public void removeAnalogValueReachedListener(BrickletHumidity.AnalogValueReachedListener listener)
Removes a AnalogValueReached listener.
-
-