Package com.tinkerforge
Class BrickletSoundPressureLevel
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletSoundPressureLevel
-
public class BrickletSoundPressureLevel extends Device
Measures Sound Pressure Level in dB(A/B/C/D/Z)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletSoundPressureLevel.Configuration
class
BrickletSoundPressureLevel.DecibelCallbackConfiguration
static interface
BrickletSoundPressureLevel.DecibelListener
This listener is triggered periodically according to the configuration set bysetDecibelCallbackConfiguration(long, boolean, char, int, int)
.static interface
BrickletSoundPressureLevel.SpectrumListener
This listener is triggered periodically according to the configuration set bysetSpectrumCallbackConfiguration(long)
.class
BrickletSoundPressureLevel.SpectrumLowLevel
static interface
BrickletSoundPressureLevel.SpectrumLowLevelListener
class
BrickletSoundPressureLevel.SPITFPErrorCount
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletSoundPressureLevel(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
addDecibelListener(BrickletSoundPressureLevel.DecibelListener listener)
Adds a Decibel listener.void
addSpectrumListener(BrickletSoundPressureLevel.SpectrumListener listener)
Adds a Spectrum listener.void
addSpectrumLowLevelListener(BrickletSoundPressureLevel.SpectrumLowLevelListener listener)
Adds a SpectrumLowLevel listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.BrickletSoundPressureLevel.Configuration
getConfiguration()
Returns the configuration as set bysetConfiguration(int, int)
.int
getDecibel()
Returns the measured sound pressure in decibels.BrickletSoundPressureLevel.DecibelCallbackConfiguration
getDecibelCallbackConfiguration()
Returns the listener configuration as set bysetDecibelCallbackConfiguration(long, boolean, 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.int[]
getSpectrum()
Returns the frequency spectrum.long
getSpectrumCallbackConfiguration()
Returns the listener configuration as set bygetSpectrumCallbackConfiguration()
.BrickletSoundPressureLevel.SpectrumLowLevel
getSpectrumLowLevel()
Returns the frequency spectrum.BrickletSoundPressureLevel.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
long
readUID()
Returns the current UID as an integer.void
removeDecibelListener(BrickletSoundPressureLevel.DecibelListener listener)
Removes a Decibel listener.void
removeSpectrumListener(BrickletSoundPressureLevel.SpectrumListener listener)
Removes a Spectrum listener.void
removeSpectrumLowLevelListener(BrickletSoundPressureLevel.SpectrumLowLevelListener listener)
Removes a SpectrumLowLevel listener.void
reset()
Calling this function will reset the Bricklet.int
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested mode change was instigated.void
setConfiguration(int fftSize, int weighting)
Sets the Sound Pressure Level Bricklet configuration.void
setDecibelCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)
The period is the period with which theBrickletSoundPressureLevel.DecibelListener
listener is triggered periodically.void
setSpectrumCallbackConfiguration(long period)
The period is the period with which theBrickletSoundPressureLevel.SpectrumListener
listener is triggered periodically.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.int
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before.void
writeUID(long uid)
Writes a new UID into flash.-
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_DECIBEL
public static final byte FUNCTION_GET_DECIBEL
- See Also:
- Constant Field Values
-
FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_DECIBEL_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_DECIBEL_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPECTRUM_LOW_LEVEL
public static final byte FUNCTION_GET_SPECTRUM_LOW_LEVEL
- See Also:
- Constant Field Values
-
FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPECTRUM_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_SPECTRUM_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_CONFIGURATION
public static final byte FUNCTION_SET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_CONFIGURATION
public static final byte FUNCTION_GET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_WRITE_FIRMWARE
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_UID
public static final byte FUNCTION_WRITE_UID
- See Also:
- Constant Field Values
-
FUNCTION_READ_UID
public static final byte FUNCTION_READ_UID
- 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
-
FFT_SIZE_128
public static final int FFT_SIZE_128
- See Also:
- Constant Field Values
-
FFT_SIZE_256
public static final int FFT_SIZE_256
- See Also:
- Constant Field Values
-
FFT_SIZE_512
public static final int FFT_SIZE_512
- See Also:
- Constant Field Values
-
FFT_SIZE_1024
public static final int FFT_SIZE_1024
- See Also:
- Constant Field Values
-
WEIGHTING_A
public static final int WEIGHTING_A
- See Also:
- Constant Field Values
-
WEIGHTING_B
public static final int WEIGHTING_B
- See Also:
- Constant Field Values
-
WEIGHTING_C
public static final int WEIGHTING_C
- See Also:
- Constant Field Values
-
WEIGHTING_D
public static final int WEIGHTING_D
- See Also:
- Constant Field Values
-
WEIGHTING_Z
public static final int WEIGHTING_Z
- See Also:
- Constant Field Values
-
WEIGHTING_ITU_R_468
public static final int WEIGHTING_ITU_R_468
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_BOOTLOADER
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_FIRMWARE
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_OK
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_INVALID_MODE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_NO_CHANGE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_CRC_MISMATCH
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_STATUS
public static final int STATUS_LED_CONFIG_SHOW_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletSoundPressureLevel
public BrickletSoundPressureLevel(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
-
getDecibel
public int getDecibel() throws TinkerforgeException
Returns the measured sound pressure in decibels. The Bricklet supports the weighting standards dB(A), dB(B), dB(C), dB(D), dB(Z) and ITU-R 468. You can configure the weighting withsetConfiguration(int, int)
. By default dB(A) will be used. If you want to get the value periodically, it is recommended to use theBrickletSoundPressureLevel.DecibelListener
listener. You can set the listener configuration withsetDecibelCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setDecibelCallbackConfiguration
public void setDecibelCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
The period is the period with which theBrickletSoundPressureLevel.DecibelListener
listener is triggered periodically. A value of 0 turns the listener off. If the `value has to change`-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change. If it is set to false, the listener is continuously triggered with the period, independent of the value. It is furthermore possible to constrain the listener with thresholds. The `option`-parameter together with min/max sets a threshold for theBrickletSoundPressureLevel.DecibelListener
listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Threshold is turned off" "'o'", "Threshold is triggered when the value is *outside* the min and max values" "'i'", "Threshold is triggered when the value is *inside* or equal to the min and max values" "'<'", "Threshold is triggered when the value is smaller than the min value (max is ignored)" "'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)" \endverbatim If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.- Throws:
TinkerforgeException
-
getDecibelCallbackConfiguration
public BrickletSoundPressureLevel.DecibelCallbackConfiguration getDecibelCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetDecibelCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
getSpectrumLowLevel
public BrickletSoundPressureLevel.SpectrumLowLevel getSpectrumLowLevel() throws TinkerforgeException
Returns the frequency spectrum. The length of the spectrum is between 512 (FFT size 1024) and 64 (FFT size 128). SeesetConfiguration(int, int)
. Each array element is one bin of the FFT. The first bin is always the DC offset and the other bins have a size between 40Hz (FFT size 1024) and 320Hz (FFT size 128). In sum the frequency of the spectrum always has a range from 0 to 20480Hz (the FFT is applied to samples with a frequency of 40960Hz). The returned data is already equalized, which means that the microphone frequency response is compensated and the weighting function is applied (seesetConfiguration(int, int)
for the available weighting standards). Use dB(Z) if you need the unaltered spectrum. The values are not in dB form yet. If you want a proper dB scale of the spectrum you have to apply the formula f(x) = 20*log10(max(1, x/sqrt(2))) on each value.- Throws:
TinkerforgeException
-
setSpectrumCallbackConfiguration
public void setSpectrumCallbackConfiguration(long period) throws TinkerforgeException
The period is the period with which theBrickletSoundPressureLevel.SpectrumListener
listener is triggered periodically. A value of 0 turns the listener off. Every new measured spectrum will be send at most once. Set the period to 1 to make sure that you get every spectrum.- Throws:
TinkerforgeException
-
getSpectrumCallbackConfiguration
public long getSpectrumCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bygetSpectrumCallbackConfiguration()
.- Throws:
TinkerforgeException
-
setConfiguration
public void setConfiguration(int fftSize, int weighting) throws TinkerforgeException
Sets the Sound Pressure Level Bricklet configuration. With different FFT sizes the Bricklet has a different amount of samples per second and the size of the FFT bins changes. The higher the FFT size the more precise is the result of the dB(X) calculation. Available FFT sizes are: * 1024: 512 bins, 10 samples per second, each bin has size 40Hz * 512: 256 bins, 20 samples per second, each bin has size 80Hz * 256: 128 bins, 40 samples per second, each bin has size 160Hz * 128: 64 bins, 80 samples per second, each bin has size 320Hz The Bricklet supports different weighting functions. You can choose between dB(A), dB(B), dB(C), dB(D), dB(Z) and ITU-R 468. dB(A/B/C/D) are the standard dB weighting curves. dB(A) is often used to measure volumes at concerts etc. dB(Z) has a flat response, no weighting is applied. ITU-R 468 is an ITU weighting standard mostly used in the UK and Europe.- Throws:
TinkerforgeException
-
getConfiguration
public BrickletSoundPressureLevel.Configuration getConfiguration() throws TinkerforgeException
Returns the configuration as set bysetConfiguration(int, int)
.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletSoundPressureLevel.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
Returns the error count for the communication between Brick and Bricklet. The errors are divided into * ACK checksum errors, * message checksum errors, * framing errors and * overflow errors. The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.- Throws:
TinkerforgeException
-
setBootloaderMode
public int setBootloaderMode(int mode) throws TinkerforgeException
Sets the bootloader mode and returns the status after the requested mode change was instigated. You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
getBootloaderMode
public int getBootloaderMode() throws TinkerforgeException
Returns the current bootloader mode, seesetBootloaderMode(int)
.- Throws:
TinkerforgeException
-
setWriteFirmwarePointer
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
Sets the firmware pointer forwriteFirmware(int[])
. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256). This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
writeFirmware
public int writeFirmware(int[] data) throws TinkerforgeException
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before. The firmware is written to flash every 4 chunks. You can only write firmware in bootloader mode. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
setStatusLEDConfig
public void setStatusLEDConfig(int config) throws TinkerforgeException
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets. You can also turn the LED permanently on/off or show a heartbeat. If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.- Throws:
TinkerforgeException
-
getStatusLEDConfig
public int getStatusLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetStatusLEDConfig(int)
- Throws:
TinkerforgeException
-
getChipTemperature
public int getChipTemperature() throws TinkerforgeException
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature! The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.- Throws:
TinkerforgeException
-
reset
public void reset() throws TinkerforgeException
Calling this function will reset the Bricklet. All configurations will be lost. After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!- Throws:
TinkerforgeException
-
writeUID
public void writeUID(long uid) throws TinkerforgeException
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first. We recommend that you use Brick Viewer to change the UID.- Throws:
TinkerforgeException
-
readUID
public long readUID() throws TinkerforgeException
Returns the current UID as an integer. Encode as Base58 to get the usual string version.- 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
-
getSpectrum
public int[] getSpectrum() throws TinkerforgeException
Returns the frequency spectrum. The length of the spectrum is between 512 (FFT size 1024) and 64 (FFT size 128). SeesetConfiguration(int, int)
. Each array element is one bin of the FFT. The first bin is always the DC offset and the other bins have a size between 40Hz (FFT size 1024) and 320Hz (FFT size 128). In sum the frequency of the spectrum always has a range from 0 to 20480Hz (the FFT is applied to samples with a frequency of 40960Hz). The returned data is already equalized, which means that the microphone frequency response is compensated and the weighting function is applied (seesetConfiguration(int, int)
for the available weighting standards). Use dB(Z) if you need the unaltered spectrum. The values are not in dB form yet. If you want a proper dB scale of the spectrum you have to apply the formula f(x) = 20*log10(max(1, x/sqrt(2))) on each value.- Throws:
TinkerforgeException
-
addDecibelListener
public void addDecibelListener(BrickletSoundPressureLevel.DecibelListener listener)
Adds a Decibel listener.
-
removeDecibelListener
public void removeDecibelListener(BrickletSoundPressureLevel.DecibelListener listener)
Removes a Decibel listener.
-
addSpectrumLowLevelListener
public void addSpectrumLowLevelListener(BrickletSoundPressureLevel.SpectrumLowLevelListener listener)
Adds a SpectrumLowLevel listener.
-
removeSpectrumLowLevelListener
public void removeSpectrumLowLevelListener(BrickletSoundPressureLevel.SpectrumLowLevelListener listener)
Removes a SpectrumLowLevel listener.
-
addSpectrumListener
public void addSpectrumListener(BrickletSoundPressureLevel.SpectrumListener listener)
Adds a Spectrum listener.
-
removeSpectrumListener
public void removeSpectrumListener(BrickletSoundPressureLevel.SpectrumListener listener)
Removes a Spectrum listener.
-
-