Struct SoundPressureLevelBricklet

pub struct SoundPressureLevelBricklet { /* private fields */ }

Measures Sound Pressure Level in dB(A/B/C/D/Z)

Implementations

impl SoundPressureLevelBricklet

pub const DEVICE_IDENTIFIER: u16 = 290u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Sound Pressure Level Bricklet"

pub fn new( uid: Uid, connection: AsyncIpConnection, ) -> SoundPressureLevelBricklet

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

pub fn get_response_expected( &mut self, fun: SoundPressureLevelBrickletFunction, ) -> Result<bool, GetResponseExpectedError>

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 set_response_expected. 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.

See set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected( &mut self, fun: SoundPressureLevelBrickletFunction, response_expected: bool, ) -> Result<(), SetResponseExpectedError>

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.

pub fn set_response_expected_all(&mut self, response_expected: bool)

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

pub fn get_api_version(&self) -> [u8; 3]

Returns the version of the API definition (major, minor, revision) 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.

pub async fn get_decibel_callback_receiver(&mut self) -> impl Stream<Item = u16>

This receiver is triggered periodically according to the configuration set by set_decibel_callback_configuration.

The parameter is the same as get_decibel.

pub async fn get_spectrum_low_level_callback_receiver( &mut self, ) -> impl Stream<Item = SpectrumLowLevelEvent>

See get_spectrum_callback_receiver

pub async fn get_decibel(&mut self) -> Result<u16, TinkerforgeError>

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 [set_configuration].

By default dB(A) will be used.

If you want to get the value periodically, it is recommended to use the [get_decibel_callback_receiver] receiver. You can set the receiver configuration with [set_decibel_callback_configuration].

pub async fn set_decibel_callback_configuration( &mut self, period: u32, value_has_to_change: bool, option: char, min: u16, max: u16, ) -> Result<(), TinkerforgeError>

The period is the period with which the [get_decibel_callback_receiver] receiver is triggered periodically. A value of 0 turns the receiver off.

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

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

It is furthermore possible to constrain the receiver with thresholds.

The option-parameter together with min/max sets a threshold for the [get_decibel_callback_receiver] receiver.

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 receiver is triggered with the fixed period.

Associated constants:

• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_OFF
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_INSIDE
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_SMALLER
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_GREATER

pub async fn get_decibel_callback_configuration( &mut self, ) -> Result<DecibelCallbackConfiguration, TinkerforgeError>

Returns the receiver configuration as set by [set_decibel_callback_configuration].

Associated constants:

• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_OFF
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_INSIDE
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_SMALLER
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_GREATER

pub async fn get_spectrum_low_level( &mut self, ) -> Result<SpectrumLowLevel, TinkerforgeError>

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

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 [set_configuration] 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.

pub async fn set_spectrum_callback_configuration( &mut self, period: u32, ) -> Result<(), TinkerforgeError>

The period is the period with which the [get_spectrum_callback_receiver] receiver is triggered periodically. A value of 0 turns the receiver off.

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

pub async fn get_spectrum_callback_configuration( &mut self, ) -> Result<u32, TinkerforgeError>

Returns the receiver configuration as set by [get_spectrum_callback_configuration].

pub async fn set_configuration( &mut self, fft_size: u8, weighting: u8, ) -> Result<(), TinkerforgeError>

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.

Associated constants:

• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_128
• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_256
• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_512
• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_1024
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_A
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_B
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_C
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_D
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_Z
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_ITU_R_468

pub async fn get_configuration( &mut self, ) -> Result<Configuration, TinkerforgeError>

Returns the configuration as set by [set_configuration].

Associated constants:

• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_128
• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_256
• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_512
• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_1024
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_A
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_B
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_C
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_D
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_Z
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_ITU_R_468

pub async fn get_spitfp_error_count( &mut self, ) -> Result<SpitfpErrorCount, TinkerforgeError>

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.

pub async fn set_bootloader_mode( &mut self, mode: u8, ) -> Result<u8, TinkerforgeError>

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.

Associated constants:

• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_STATUS_OK
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>

Returns the current bootloader mode, see [set_bootloader_mode].

Associated constants:

• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub async fn set_write_firmware_pointer( &mut self, pointer: u32, ) -> Result<(), TinkerforgeError>

Sets the firmware pointer for [write_firmware]. 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.

pub async fn write_firmware( &mut self, data: &[u8; 64], ) -> Result<u8, TinkerforgeError>

Writes 64 Bytes of firmware at the position as written by [set_write_firmware_pointer] 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.

pub async fn set_status_led_config( &mut self, config: u8, ) -> Result<(), TinkerforgeError>

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.

Associated constants:

• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_OFF
• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_ON
• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>

Returns the configuration as set by [set_status_led_config]

Associated constants:

• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_OFF
• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_ON
• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>

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.

pub async fn reset(&mut self) -> Result<(), TinkerforgeError>

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!

pub async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>

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.

pub async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>

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

pub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>

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. |device_identifier_constant|

Trait Implementations

impl Clone for SoundPressureLevelBricklet

fn clone(&self) -> SoundPressureLevelBricklet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.