Package com.tinkerforge
Class BrickletSoundIntensity
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletSoundIntensity
-
public class BrickletSoundIntensity extends Device
Measures sound intensity
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletSoundIntensity.IntensityCallbackThreshold
static interface
BrickletSoundIntensity.IntensityListener
This listener is triggered periodically with the period that is set bysetIntensityCallbackPeriod(long)
.static interface
BrickletSoundIntensity.IntensityReachedListener
This listener is triggered when the threshold as set bysetIntensityCallbackThreshold(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_INTENSITY
static byte
FUNCTION_GET_INTENSITY_CALLBACK_PERIOD
static byte
FUNCTION_GET_INTENSITY_CALLBACK_THRESHOLD
static byte
FUNCTION_SET_DEBOUNCE_PERIOD
static byte
FUNCTION_SET_INTENSITY_CALLBACK_PERIOD
static byte
FUNCTION_SET_INTENSITY_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 BrickletSoundIntensity(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
addIntensityListener(BrickletSoundIntensity.IntensityListener listener)
Adds a Intensity listener.void
addIntensityReachedListener(BrickletSoundIntensity.IntensityReachedListener listener)
Adds a IntensityReached 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.int
getIntensity()
Returns the current sound intensity.long
getIntensityCallbackPeriod()
Returns the period as set bysetIntensityCallbackPeriod(long)
.BrickletSoundIntensity.IntensityCallbackThreshold
getIntensityCallbackThreshold()
Returns the threshold as set bysetIntensityCallbackThreshold(char, int, int)
.void
removeIntensityListener(BrickletSoundIntensity.IntensityListener listener)
Removes a Intensity listener.void
removeIntensityReachedListener(BrickletSoundIntensity.IntensityReachedListener listener)
Removes a IntensityReached listener.void
setDebouncePeriod(long debounce)
Sets the period with which the threshold listener *BrickletSoundIntensity.IntensityReachedListener
is triggered, if the thresholds *setIntensityCallbackThreshold(char, int, int)
keeps being reached.void
setIntensityCallbackPeriod(long period)
Sets the period with which theBrickletSoundIntensity.IntensityListener
listener is triggered periodically.void
setIntensityCallbackThreshold(char option, int min, int max)
Sets the thresholds for theBrickletSoundIntensity.IntensityReachedListener
listener.-
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_INTENSITY
public static final byte FUNCTION_GET_INTENSITY
- See Also:
- Constant Field Values
-
FUNCTION_SET_INTENSITY_CALLBACK_PERIOD
public static final byte FUNCTION_SET_INTENSITY_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_INTENSITY_CALLBACK_PERIOD
public static final byte FUNCTION_GET_INTENSITY_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_GET_INTENSITY_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_INTENSITY_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
-
BrickletSoundIntensity
public BrickletSoundIntensity(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
-
getIntensity
public int getIntensity() throws TinkerforgeException
Returns the current sound intensity. The value corresponds to the `upper envelop <https://en.wikipedia.org/wiki/Envelope_(waves)>`__ of the signal of the microphone capsule. If you want to get the intensity periodically, it is recommended to use theBrickletSoundIntensity.IntensityListener
listener and set the period withsetIntensityCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setIntensityCallbackPeriod
public void setIntensityCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickletSoundIntensity.IntensityListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickletSoundIntensity.IntensityListener
listener is only triggered if the intensity has changed since the last triggering.- Throws:
TinkerforgeException
-
getIntensityCallbackPeriod
public long getIntensityCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetIntensityCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setIntensityCallbackThreshold
public void setIntensityCallbackThreshold(char option, int min, int max) throws TinkerforgeException
Sets the thresholds for theBrickletSoundIntensity.IntensityReachedListener
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)" \endverbatim- Throws:
TinkerforgeException
-
getIntensityCallbackThreshold
public BrickletSoundIntensity.IntensityCallbackThreshold getIntensityCallbackThreshold() throws TinkerforgeException
Returns the threshold as set bysetIntensityCallbackThreshold(char, int, int)
.- Throws:
TinkerforgeException
-
setDebouncePeriod
public void setDebouncePeriod(long debounce) throws TinkerforgeException
Sets the period with which the threshold listener *BrickletSoundIntensity.IntensityReachedListener
is triggered, if the thresholds *setIntensityCallbackThreshold(char, int, int)
keeps 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
-
addIntensityListener
public void addIntensityListener(BrickletSoundIntensity.IntensityListener listener)
Adds a Intensity listener.
-
removeIntensityListener
public void removeIntensityListener(BrickletSoundIntensity.IntensityListener listener)
Removes a Intensity listener.
-
addIntensityReachedListener
public void addIntensityReachedListener(BrickletSoundIntensity.IntensityReachedListener listener)
Adds a IntensityReached listener.
-
removeIntensityReachedListener
public void removeIntensityReachedListener(BrickletSoundIntensity.IntensityReachedListener listener)
Removes a IntensityReached listener.
-
-