Struct tinkerforge::sound_intensity_bricklet::SoundIntensityBricklet

source ·

pub struct SoundIntensityBricklet { /* private fields */ }

Expand description

Measures sound intensity

Implementations

source

pub fn new(uid: &str, ip_connection: &IpConnection) -> SoundIntensityBricklet

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

source

pub fn get_response_expected(
&mut self,
fun: SoundIntensityBrickletFunction
) -> 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 send 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.

source

pub fn set_response_expected(
 &mut self,
 fun: SoundIntensityBrickletFunction,
 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 send and errors are silently ignored, because they cannot be detected.

source

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.

source

pub fn get_intensity_callback_receiver(&self) -> ConvertingCallbackReceiver<u16>

This receiver is triggered periodically with the period that is set by set_intensity_callback_period. The parameter is the intensity of the sensor.

The get_intensity_callback_receiver receiver is only triggered if the intensity has changed since the last triggering.

source

pub fn get_intensity_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u16>

This receiver is triggered when the threshold as set by set_intensity_callback_threshold is reached. The parameter is the intensity of the encoder.

If the threshold keeps being reached, the receiver is triggered periodically with the period as set by set_debounce_period.

source

pub fn get_intensity(&self) -> ConvertingReceiver<u16>

Returns the current sound intensity. The value has a range of 0 to 4095.

The value corresponds to the upper envelop__ of the signal of the microphone capsule.

If you want to get the intensity periodically, it is recommended to use the get_intensity_callback_receiver receiver and set the period with set_intensity_callback_period.

source

pub fn set_intensity_callback_period(
&self,
period: u32
) -> ConvertingReceiver<()>

Sets the period in ms with which the get_intensity_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

The get_intensity_callback_receiver receiver is only triggered if the intensity has changed since the last triggering.

The default value is 0.

source

pub fn get_intensity_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by set_intensity_callback_period.

source

pub fn set_intensity_callback_threshold(
 &self,
 option: char,
 min: u16,
 max: u16
) -> ConvertingReceiver<()>

Sets the thresholds for the get_intensity_reached_callback_receiver receiver.

The following options are possible:

Option	Description
‘x’	Receiver is turned off
‘o’	Receiver is triggered when the intensity is outside the min and max values
‘i’	Receiver is triggered when the intensity is inside the min and max values
‘<’	Receiver is triggered when the intensity is smaller than the min value (max is ignored)
‘>’	Receiver is triggered when the intensity is greater than the min value (max is ignored)