Package com.tinkerforge
Class BrickletDustDetector
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletDustDetector
-
public class BrickletDustDetector extends Device
Measures dust density
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletDustDetector.DustDensityCallbackThreshold
static interface
BrickletDustDetector.DustDensityListener
This listener is triggered periodically with the period that is set bysetDustDensityCallbackPeriod(long)
.static interface
BrickletDustDetector.DustDensityReachedListener
This listener is triggered when the threshold as set bysetDustDensityCallbackThreshold(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_DUST_DENSITY
static byte
FUNCTION_GET_DUST_DENSITY_CALLBACK_PERIOD
static byte
FUNCTION_GET_DUST_DENSITY_CALLBACK_THRESHOLD
static byte
FUNCTION_GET_IDENTITY
static byte
FUNCTION_GET_MOVING_AVERAGE
static byte
FUNCTION_SET_DEBOUNCE_PERIOD
static byte
FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD
static byte
FUNCTION_SET_DUST_DENSITY_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 BrickletDustDetector(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
addDustDensityListener(BrickletDustDetector.DustDensityListener listener)
Adds a DustDensity listener.void
addDustDensityReachedListener(BrickletDustDetector.DustDensityReachedListener listener)
Adds a DustDensityReached listener.long
getDebouncePeriod()
Returns the debounce period as set bysetDebouncePeriod(long)
.int
getDustDensity()
Returns the dust density.long
getDustDensityCallbackPeriod()
Returns the period as set bysetDustDensityCallbackPeriod(long)
.BrickletDustDetector.DustDensityCallbackThreshold
getDustDensityCallbackThreshold()
Returns the threshold as set bysetDustDensityCallbackThreshold(char, int, int)
.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 bysetMovingAverage(short)
.void
removeDustDensityListener(BrickletDustDetector.DustDensityListener listener)
Removes a DustDensity listener.void
removeDustDensityReachedListener(BrickletDustDetector.DustDensityReachedListener listener)
Removes a DustDensityReached listener.void
setDebouncePeriod(long debounce)
Sets the period with which the threshold listener *BrickletDustDetector.DustDensityReachedListener
is triggered, if the threshold *setDustDensityCallbackThreshold(char, int, int)
keeps being reached.void
setDustDensityCallbackPeriod(long period)
Sets the period with which theBrickletDustDetector.DustDensityListener
listener is triggered periodically.void
setDustDensityCallbackThreshold(char option, int min, int max)
Sets the thresholds for theBrickletDustDetector.DustDensityReachedListener
listener.void
setMovingAverage(short average)
Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__ for the dust density.-
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_DUST_DENSITY
public static final byte FUNCTION_GET_DUST_DENSITY
- See Also:
- Constant Field Values
-
FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD
public static final byte FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_DUST_DENSITY_CALLBACK_PERIOD
public static final byte FUNCTION_GET_DUST_DENSITY_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_GET_DUST_DENSITY_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_DUST_DENSITY_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
-
BrickletDustDetector
public BrickletDustDetector(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
-
getDustDensity
public int getDustDensity() throws TinkerforgeException
Returns the dust density. If you want to get the dust density periodically, it is recommended to use theBrickletDustDetector.DustDensityListener
listener and set the period withsetDustDensityCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setDustDensityCallbackPeriod
public void setDustDensityCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickletDustDetector.DustDensityListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickletDustDetector.DustDensityListener
listener is only triggered if the dust density has changed since the last triggering.- Throws:
TinkerforgeException
-
getDustDensityCallbackPeriod
public long getDustDensityCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetDustDensityCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setDustDensityCallbackThreshold
public void setDustDensityCallbackThreshold(char option, int min, int max) throws TinkerforgeException
Sets the thresholds for theBrickletDustDetector.DustDensityReachedListener
listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Listener is turned off" "'o'", "Listener is triggered when the dust density value is *outside* the min and max values" "'i'", "Listener is triggered when the dust density value is *inside* the min and max values" "'<'", "Listener is triggered when the dust density value is smaller than the min value (max is ignored)" "'>'", "Listener is triggered when the dust density value is greater than the min value (max is ignored)" \endverbatim- Throws:
TinkerforgeException
-
getDustDensityCallbackThreshold
public BrickletDustDetector.DustDensityCallbackThreshold getDustDensityCallbackThreshold() throws TinkerforgeException
Returns the threshold as set bysetDustDensityCallbackThreshold(char, int, int)
.- Throws:
TinkerforgeException
-
setDebouncePeriod
public void setDebouncePeriod(long debounce) throws TinkerforgeException
Sets the period with which the threshold listener *BrickletDustDetector.DustDensityReachedListener
is triggered, if the threshold *setDustDensityCallbackThreshold(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 dust density. 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
-
addDustDensityListener
public void addDustDensityListener(BrickletDustDetector.DustDensityListener listener)
Adds a DustDensity listener.
-
removeDustDensityListener
public void removeDustDensityListener(BrickletDustDetector.DustDensityListener listener)
Removes a DustDensity listener.
-
addDustDensityReachedListener
public void addDustDensityReachedListener(BrickletDustDetector.DustDensityReachedListener listener)
Adds a DustDensityReached listener.
-
removeDustDensityReachedListener
public void removeDustDensityReachedListener(BrickletDustDetector.DustDensityReachedListener listener)
Removes a DustDensityReached listener.
-
-