LabVIEW - Sound Pressure Level Bricklet¶

Simple¶

Download (Example Simple.vi)

Threshold¶

Download (Example Threshold.vi), Download (Example Threshold - Decibel Callback.vi)

Callback¶

Download (Example Callback.vi), Download (Example Callback - Decibel Callback.vi)

Graph¶

Download (Example Graph.vi), Download (Example Graph - Decibel Callback.vi)

Basic Functions¶

BrickletSoundPressureLevel(uid, ipcon) → soundPressureLevel¶

Input:	uid – Type: String ipcon – Type: .NET Refnum (IPConnection)
Output:	soundPressureLevel – Type: .NET Refnum (BrickletSoundPressureLevel)

Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected.

BrickletSoundPressureLevel.GetDecibel() → decibel¶

Output:	decibel – Type: Int32, Unit: 1/10 dB, Range: [0 to 120]

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 with SetConfiguration().

By default dB(A) will be used.

If you want to get the value periodically, it is recommended to use the DecibelCallback callback. You can set the callback configuration with SetDecibelCallbackConfiguration().

BrickletSoundPressureLevel.GetSpectrum() → spectrum¶

Output:	spectrum – Type: Int32[], Length: variable, Unit: ? dB, Range: [0 to 216 - 1]

Returns the frequency spectrum. The length of the spectrum is between 512 (FFT size 1024) and 64 (FFT size 128). See SetConfiguration().

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() 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.

BrickletSoundPressureLevel.SetConfiguration(fftSize, weighting)¶

Input:	fftSize – Type: Byte, Range: See constants, Default: 3 weighting – Type: Byte, Range: See constants, Default: 0

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.

The following constants are available for this function:

For fftSize:

• BrickletSoundPressureLevel.FFT_SIZE_128 = 0
• BrickletSoundPressureLevel.FFT_SIZE_256 = 1
• BrickletSoundPressureLevel.FFT_SIZE_512 = 2
• BrickletSoundPressureLevel.FFT_SIZE_1024 = 3

For weighting:

• BrickletSoundPressureLevel.WEIGHTING_A = 0
• BrickletSoundPressureLevel.WEIGHTING_B = 1
• BrickletSoundPressureLevel.WEIGHTING_C = 2
• BrickletSoundPressureLevel.WEIGHTING_D = 3
• BrickletSoundPressureLevel.WEIGHTING_Z = 4
• BrickletSoundPressureLevel.WEIGHTING_ITU_R_468 = 5

BrickletSoundPressureLevel.GetConfiguration() → fftSize, weighting¶

Output:	fftSize – Type: Byte, Range: See constants, Default: 3 weighting – Type: Byte, Range: See constants, Default: 0

Returns the configuration as set by SetConfiguration().

The following constants are available for this function:

For fftSize:

• BrickletSoundPressureLevel.FFT_SIZE_128 = 0
• BrickletSoundPressureLevel.FFT_SIZE_256 = 1
• BrickletSoundPressureLevel.FFT_SIZE_512 = 2
• BrickletSoundPressureLevel.FFT_SIZE_1024 = 3

For weighting:

• BrickletSoundPressureLevel.WEIGHTING_A = 0
• BrickletSoundPressureLevel.WEIGHTING_B = 1
• BrickletSoundPressureLevel.WEIGHTING_C = 2
• BrickletSoundPressureLevel.WEIGHTING_D = 3
• BrickletSoundPressureLevel.WEIGHTING_Z = 4
• BrickletSoundPressureLevel.WEIGHTING_ITU_R_468 = 5

Advanced Functions¶

BrickletSoundPressureLevel.GetSPITFPErrorCount() → errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow¶

Output:	errorCountAckChecksum – Type: Int64, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: Int64, Range: [0 to 232 - 1] errorCountFrame – Type: Int64, Range: [0 to 232 - 1] errorCountOverflow – Type: Int64, Range: [0 to 232 - 1]

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.

BrickletSoundPressureLevel.SetStatusLEDConfig(config)¶

Input:	config – Type: Byte, Range: See constants, Default: 3

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.

The following constants are available for this function:

For config:

• BrickletSoundPressureLevel.STATUS_LED_CONFIG_OFF = 0
• BrickletSoundPressureLevel.STATUS_LED_CONFIG_ON = 1
• BrickletSoundPressureLevel.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletSoundPressureLevel.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletSoundPressureLevel.GetStatusLEDConfig() → config¶

Output:	config – Type: Byte, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

For config:

• BrickletSoundPressureLevel.STATUS_LED_CONFIG_OFF = 0
• BrickletSoundPressureLevel.STATUS_LED_CONFIG_ON = 1
• BrickletSoundPressureLevel.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletSoundPressureLevel.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletSoundPressureLevel.GetChipTemperature() → temperature¶

Output:	temperature – Type: Int16, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

BrickletSoundPressureLevel.Reset()¶

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!

BrickletSoundPressureLevel.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier¶

Output:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Char, Range: ["a" to "h", "z"] hardwareVersion – Type: Byte[3] 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] firmwareVersion – Type: Byte[3] 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] deviceIdentifier – Type: Int32, Range: [0 to 216 - 1]

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 Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

BrickletSoundPressureLevel.SetDecibelCallbackConfiguration(period, valueHasToChange, option, min, max)¶

Input:	period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: Boolean, Default: F option – Type: Char, Range: See constants, Default: "x" min – Type: Int32, Unit: 1/10 dB, Range: [0 to 216 - 1], Default: 0 max – Type: Int32, Unit: 1/10 dB, Range: [0 to 216 - 1], Default: 0

The period is the period with which the DecibelCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the DecibelCallback callback.

The following options are possible:

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)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

• BrickletSoundPressureLevel.THRESHOLD_OPTION_OFF = "x"
• BrickletSoundPressureLevel.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletSoundPressureLevel.THRESHOLD_OPTION_INSIDE = "i"
• BrickletSoundPressureLevel.THRESHOLD_OPTION_SMALLER = "<"
• BrickletSoundPressureLevel.THRESHOLD_OPTION_GREATER = ">"

BrickletSoundPressureLevel.GetDecibelCallbackConfiguration() → period, valueHasToChange, option, min, max¶

Output:	period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: Boolean, Default: F option – Type: Char, Range: See constants, Default: "x" min – Type: Int32, Unit: 1/10 dB, Range: [0 to 216 - 1], Default: 0 max – Type: Int32, Unit: 1/10 dB, Range: [0 to 216 - 1], Default: 0

Returns the callback configuration as set by SetDecibelCallbackConfiguration().

The following constants are available for this function:

For option:

• BrickletSoundPressureLevel.THRESHOLD_OPTION_OFF = "x"
• BrickletSoundPressureLevel.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletSoundPressureLevel.THRESHOLD_OPTION_INSIDE = "i"
• BrickletSoundPressureLevel.THRESHOLD_OPTION_SMALLER = "<"
• BrickletSoundPressureLevel.THRESHOLD_OPTION_GREATER = ">"

BrickletSoundPressureLevel.SetSpectrumCallbackConfiguration(period)¶

Input:	period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

The period is the period with which the SpectrumCallback callback is triggered periodically. A value of 0 turns the callback off.

Every new measured spectrum will be send at most once. Set the period to 1 to make sure that you get every spectrum.

BrickletSoundPressureLevel.GetSpectrumCallbackConfiguration() → period¶

Output:	period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the callback configuration as set by GetSpectrumCallbackConfiguration().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object. The available callback property and their type of parameters are described below.

event BrickletSoundPressureLevel.DecibelCallback → sender, decibel¶

Callback Output:	sender – Type: .NET Refnum (BrickletSoundPressureLevel) decibel – Type: Int32, Unit: 1/10 dB, Range: [0 to 120]

This callback is triggered periodically according to the configuration set by SetDecibelCallbackConfiguration().

The parameter is the same as GetDecibel().

event BrickletSoundPressureLevel.SpectrumCallback → sender, spectrum¶

Callback Output:	sender – Type: .NET Refnum (BrickletSoundPressureLevel) spectrum – Type: Int32[], Length: variable, Unit: ? dB, Range: [0 to 216 - 1]

This callback is triggered periodically according to the configuration set by SetSpectrumCallbackConfiguration().

The parameter is the same as GetSpectrum().

Note

If reconstructing the value fails, the callback is triggered with null for spectrum.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletSoundPressureLevel.GetAPIVersion() → apiVersion¶

Output:	apiVersion – Type: Byte[3] 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletSoundPressureLevel.GetResponseExpected(functionId) → responseExpected¶

Input:	functionId – Type: Byte, Range: See constants
Output:	responseExpected – Type: Boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BrickletSoundPressureLevel.FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION = 2
• BrickletSoundPressureLevel.FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION = 6
• BrickletSoundPressureLevel.FUNCTION_SET_CONFIGURATION = 9
• BrickletSoundPressureLevel.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletSoundPressureLevel.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletSoundPressureLevel.FUNCTION_RESET = 243
• BrickletSoundPressureLevel.FUNCTION_WRITE_UID = 248

BrickletSoundPressureLevel.SetResponseExpected(functionId, responseExpected)¶

Input:	functionId – Type: Byte, Range: See constants responseExpected – Type: Boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BrickletSoundPressureLevel.FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION = 2
• BrickletSoundPressureLevel.FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION = 6
• BrickletSoundPressureLevel.FUNCTION_SET_CONFIGURATION = 9
• BrickletSoundPressureLevel.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletSoundPressureLevel.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletSoundPressureLevel.FUNCTION_RESET = 243
• BrickletSoundPressureLevel.FUNCTION_WRITE_UID = 248

BrickletSoundPressureLevel.SetResponseExpectedAll(responseExpected)¶

Input:	responseExpected – Type: Boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletSoundPressureLevel.SetBootloaderMode(mode) → status¶

Input:	mode – Type: Byte, Range: See constants
Output:	status – Type: Byte, Range: See constants

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.

The following constants are available for this function:

For mode:

• BrickletSoundPressureLevel.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletSoundPressureLevel.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletSoundPressureLevel.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletSoundPressureLevel.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletSoundPressureLevel.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletSoundPressureLevel.BOOTLOADER_STATUS_OK = 0
• BrickletSoundPressureLevel.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletSoundPressureLevel.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletSoundPressureLevel.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletSoundPressureLevel.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletSoundPressureLevel.BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletSoundPressureLevel.GetBootloaderMode() → mode¶

Output:	mode – Type: Byte, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

For mode:

• BrickletSoundPressureLevel.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletSoundPressureLevel.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletSoundPressureLevel.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletSoundPressureLevel.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletSoundPressureLevel.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletSoundPressureLevel.SetWriteFirmwarePointer(pointer)¶

Input:	pointer – Type: Int64, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for WriteFirmware(). 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.

BrickletSoundPressureLevel.WriteFirmware(data) → status¶

Input:	data – Type: Byte[64], Range: [0 to 255]
Output:	status – Type: Byte, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer() 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.

BrickletSoundPressureLevel.WriteUID(uid)¶

Input:	uid – Type: Int64, Range: [0 to 232 - 1]

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.

BrickletSoundPressureLevel.ReadUID() → uid¶

Output:	uid – Type: Int64, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

BrickletSoundPressureLevel.DEVICE_IDENTIFIER¶

This constant is used to identify a Sound Pressure Level Bricklet.

The GetIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

BrickletSoundPressureLevel.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Sound Pressure Level Bricklet.