public class BrickletSoundPressureLevel extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletSoundPressureLevel.Configuration |
class |
BrickletSoundPressureLevel.DecibelCallbackConfiguration |
static interface |
BrickletSoundPressureLevel.DecibelListener
This listener is triggered periodically according to the configuration set by
setDecibelCallbackConfiguration(long, boolean, char, int, int) . |
static interface |
BrickletSoundPressureLevel.SpectrumListener
This listener is triggered periodically according to the configuration set by
setSpectrumCallbackConfiguration(long) . |
class |
BrickletSoundPressureLevel.SpectrumLowLevel |
static interface |
BrickletSoundPressureLevel.SpectrumLowLevelListener |
class |
BrickletSoundPressureLevel.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletSoundPressureLevel(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and 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, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
BrickletSoundPressureLevel.Configuration |
getConfiguration()
Returns the configuration as set by
setConfiguration(int, int) . |
int |
getDecibel()
Returns the measured sound pressure in decibels.
|
BrickletSoundPressureLevel.DecibelCallbackConfiguration |
getDecibelCallbackConfiguration()
Returns the listener configuration as set by
setDecibelCallbackConfiguration(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 by
getSpectrumCallbackConfiguration() . |
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 by
setStatusLEDConfig(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 the
BrickletSoundPressureLevel.DecibelListener listener is triggered
periodically. |
void |
setSpectrumCallbackConfiguration(long period)
The period is the period with which the
BrickletSoundPressureLevel.SpectrumListener listener is
triggered periodically. |
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(int[]) . |
int |
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written by
setWriteFirmwarePointer(long) before. |
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final java.lang.String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_DECIBEL
public static final byte FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_DECIBEL_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_SPECTRUM_LOW_LEVEL
public static final byte FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_SPECTRUM_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_CONFIGURATION
public static final byte FUNCTION_GET_CONFIGURATION
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final char THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_GREATER
public static final int FFT_SIZE_128
public static final int FFT_SIZE_256
public static final int FFT_SIZE_512
public static final int FFT_SIZE_1024
public static final int WEIGHTING_A
public static final int WEIGHTING_B
public static final int WEIGHTING_C
public static final int WEIGHTING_D
public static final int WEIGHTING_Z
public static final int WEIGHTING_ITU_R_468
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletSoundPressureLevel(java.lang.String uid, IPConnection ipcon)
public int getDecibel() throws TinkerforgeException
setConfiguration(int, int)
.
By default dB(A) will be used.
If you want to get the value periodically, it is recommended to use the
BrickletSoundPressureLevel.DecibelListener
listener. You can set the listener configuration
with setDecibelCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setDecibelCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletSoundPressureLevel.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 the BrickletSoundPressureLevel.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.TinkerforgeException
public BrickletSoundPressureLevel.DecibelCallbackConfiguration getDecibelCallbackConfiguration() throws TinkerforgeException
setDecibelCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public BrickletSoundPressureLevel.SpectrumLowLevel getSpectrumLowLevel() throws TinkerforgeException
setConfiguration(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
(see setConfiguration(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.TinkerforgeException
public void setSpectrumCallbackConfiguration(long period) throws TinkerforgeException
BrickletSoundPressureLevel.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.TinkerforgeException
public long getSpectrumCallbackConfiguration() throws TinkerforgeException
getSpectrumCallbackConfiguration()
.TinkerforgeException
public void setConfiguration(int fftSize, int weighting) throws TinkerforgeException
TinkerforgeException
public BrickletSoundPressureLevel.Configuration getConfiguration() throws TinkerforgeException
setConfiguration(int, int)
.TinkerforgeException
public BrickletSoundPressureLevel.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
writeFirmware(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.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
setWriteFirmwarePointer(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.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public int[] getSpectrum() throws TinkerforgeException
setConfiguration(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
(see setConfiguration(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.TinkerforgeException
public void addDecibelListener(BrickletSoundPressureLevel.DecibelListener listener)
public void removeDecibelListener(BrickletSoundPressureLevel.DecibelListener listener)
public void addSpectrumLowLevelListener(BrickletSoundPressureLevel.SpectrumLowLevelListener listener)
public void removeSpectrumLowLevelListener(BrickletSoundPressureLevel.SpectrumLowLevelListener listener)
public void addSpectrumListener(BrickletSoundPressureLevel.SpectrumListener listener)
public void removeSpectrumListener(BrickletSoundPressureLevel.SpectrumListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.