Package com.tinkerforge
Class BrickletMoisture
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletMoisture
-
public class BrickletMoisture extends Device
Measures soil moisture
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletMoisture.MoistureCallbackThreshold
static interface
BrickletMoisture.MoistureListener
This listener is triggered periodically with the period that is set bysetMoistureCallbackPeriod(long)
.static interface
BrickletMoisture.MoistureReachedListener
This listener is triggered when the threshold as set bysetMoistureCallbackThreshold(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_DEBOUNCE_PERIOD
static byte
FUNCTION_GET_IDENTITY
static byte
FUNCTION_GET_MOISTURE_CALLBACK_PERIOD
static byte
FUNCTION_GET_MOISTURE_CALLBACK_THRESHOLD
static byte
FUNCTION_GET_MOISTURE_VALUE
static byte
FUNCTION_GET_MOVING_AVERAGE
static byte
FUNCTION_SET_DEBOUNCE_PERIOD
static byte
FUNCTION_SET_MOISTURE_CALLBACK_PERIOD
static byte
FUNCTION_SET_MOISTURE_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 Summary
Constructors Constructor Description BrickletMoisture(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addMoistureListener(BrickletMoisture.MoistureListener listener)
Adds a Moisture listener.void
addMoistureReachedListener(BrickletMoisture.MoistureReachedListener listener)
Adds a MoistureReached listener.long
getDebouncePeriod()
Returns the debounce period as set bysetDebouncePeriod(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
getMoistureCallbackPeriod()
Returns the period as set bysetMoistureCallbackPeriod(long)
.BrickletMoisture.MoistureCallbackThreshold
getMoistureCallbackThreshold()
Returns the threshold as set bysetMoistureCallbackThreshold(char, int, int)
.int
getMoistureValue()
Returns the current moisture value.short
getMovingAverage()
Returns the length moving average as set bysetMovingAverage(short)
.void
removeMoistureListener(BrickletMoisture.MoistureListener listener)
Removes a Moisture listener.void
removeMoistureReachedListener(BrickletMoisture.MoistureReachedListener listener)
Removes a MoistureReached listener.void
setDebouncePeriod(long debounce)
Sets the period with which the threshold listener *BrickletMoisture.MoistureReachedListener
is triggered, if the threshold *setMoistureCallbackThreshold(char, int, int)
keeps being reached.void
setMoistureCallbackPeriod(long period)
Sets the period with which theBrickletMoisture.MoistureListener
listener is triggered periodically.void
setMoistureCallbackThreshold(char option, int min, int max)
Sets the thresholds for theBrickletMoisture.MoistureReachedListener
listener.void
setMovingAverage(short average)
Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__ for the moisture value.-
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_MOISTURE_VALUE
public static final byte FUNCTION_GET_MOISTURE_VALUE
- See Also:
- Constant Field Values
-
FUNCTION_SET_MOISTURE_CALLBACK_PERIOD
public static final byte FUNCTION_SET_MOISTURE_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_MOISTURE_CALLBACK_PERIOD
public static final byte FUNCTION_GET_MOISTURE_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_GET_MOISTURE_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_MOISTURE_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_SET_MOVING_AVERAGE
public static final byte FUNCTION_SET_MOVING_AVERAGE
- See Also:
- Constant Field Values
-
FUNCTION_GET_MOVING_AVERAGE
public static final byte FUNCTION_GET_MOVING_AVERAGE
- 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
-
BrickletMoisture
public BrickletMoisture(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
-
getMoistureValue
public int getMoistureValue() throws TinkerforgeException
Returns the current moisture value. A small value corresponds to little moisture, a big value corresponds to much moisture. If you want to get the moisture value periodically, it is recommended to use theBrickletMoisture.MoistureListener
listener and set the period withsetMoistureCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setMoistureCallbackPeriod
public void setMoistureCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickletMoisture.MoistureListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickletMoisture.MoistureListener
listener is only triggered if the moisture value has changed since the last triggering.- Throws:
TinkerforgeException
-
getMoistureCallbackPeriod
public long getMoistureCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetMoistureCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setMoistureCallbackThreshold
public void setMoistureCallbackThreshold(char option, int min, int max) throws TinkerforgeException
Sets the thresholds for theBrickletMoisture.MoistureReachedListener
listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Listener is turned off" "'o'", "Listener is triggered when the moisture value is *outside* the min and max values" "'i'", "Listener is triggered when the moisture value is *inside* the min and max values" "'<'", "Listener is triggered when the moisture value is smaller than the min value (max is ignored)" "'>'", "Listener is triggered when the moisture value is greater than the min value (max is ignored)" \endverbatim- Throws:
TinkerforgeException
-
getMoistureCallbackThreshold
public BrickletMoisture.MoistureCallbackThreshold getMoistureCallbackThreshold() throws TinkerforgeException
Returns the threshold as set bysetMoistureCallbackThreshold(char, int, int)
.- Throws:
TinkerforgeException
-
setDebouncePeriod
public void setDebouncePeriod(long debounce) throws TinkerforgeException
Sets the period with which the threshold listener *BrickletMoisture.MoistureReachedListener
is triggered, if the threshold *setMoistureCallbackThreshold(char, int, int)
keeps being reached.- Throws:
TinkerforgeException
-
getDebouncePeriod
public long getDebouncePeriod() throws TinkerforgeException
Returns the debounce period as set bysetDebouncePeriod(long)
.- Throws:
TinkerforgeException
-
setMovingAverage
public void setMovingAverage(short average) throws TinkerforgeException
Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__ for the moisture value. Setting the length to 0 will turn the averaging completely off. With less averaging, there is more noise on the data.- Throws:
TinkerforgeException
-
getMovingAverage
public short getMovingAverage() throws TinkerforgeException
Returns the length moving average as set bysetMovingAverage(short)
.- 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
-
addMoistureListener
public void addMoistureListener(BrickletMoisture.MoistureListener listener)
Adds a Moisture listener.
-
removeMoistureListener
public void removeMoistureListener(BrickletMoisture.MoistureListener listener)
Removes a Moisture listener.
-
addMoistureReachedListener
public void addMoistureReachedListener(BrickletMoisture.MoistureReachedListener listener)
Adds a MoistureReached listener.
-
removeMoistureReachedListener
public void removeMoistureReachedListener(BrickletMoisture.MoistureReachedListener listener)
Removes a MoistureReached listener.
-
-