Struct TemperatureBricklet

Source

pub struct TemperatureBricklet { /* private fields */ }

Expand description

Measures ambient temperature with 0.5°C accuracy

Implementations§

Source §

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

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: TemperatureBrickletFunction, ) -> 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.

Source

pub fn set_response_expected( &mut self, fun: TemperatureBrickletFunction, 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.

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

Source

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

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

The get_temperature_callback_receiver receiver is only triggered if the temperature has changed since the last triggering.

Source

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

This receiver is triggered when the threshold as set by [set_temperature_callback_threshold] is reached. The parameter is the temperature of the sensor.

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

Source

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

Returns the temperature of the sensor.

If you want to get the temperature periodically, it is recommended to use the [get_temperature_callback_receiver] receiver and set the period with [set_temperature_callback_period].

Source

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

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

The [get_temperature_callback_receiver] receiver is only triggered if the temperature has changed since the last triggering.

Source

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

Returns the period as set by [set_temperature_callback_period].

Source

pub async fn set_temperature_callback_threshold( &mut self, option: char, min: i16, max: i16, ) -> Result<(), TinkerforgeError>

Sets the thresholds for the [get_temperature_reached_callback_receiver] receiver.

The following options are possible:

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

Associated constants:

TEMPERATURE_BRICKLET_THRESHOLD_OPTION_OFF
TEMPERATURE_BRICKLET_THRESHOLD_OPTION_OUTSIDE
TEMPERATURE_BRICKLET_THRESHOLD_OPTION_INSIDE
TEMPERATURE_BRICKLET_THRESHOLD_OPTION_SMALLER
TEMPERATURE_BRICKLET_THRESHOLD_OPTION_GREATER

Source

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

Returns the threshold as set by [set_temperature_callback_threshold].

Associated constants:

TEMPERATURE_BRICKLET_THRESHOLD_OPTION_OFF
TEMPERATURE_BRICKLET_THRESHOLD_OPTION_OUTSIDE
TEMPERATURE_BRICKLET_THRESHOLD_OPTION_INSIDE
TEMPERATURE_BRICKLET_THRESHOLD_OPTION_SMALLER
TEMPERATURE_BRICKLET_THRESHOLD_OPTION_GREATER

Source

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

Sets the period with which the threshold receiver

[get_temperature_reached_callback_receiver]

is triggered, if the threshold

[set_temperature_callback_threshold]

keeps being reached.

Source

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

Returns the debounce period as set by [set_debounce_period].

Source

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

Sets the I2C mode. Possible modes are:

0: Fast (400kHz)
1: Slow (100kHz)

If you have problems with obvious outliers in the Temperature Bricklet measurements, they may be caused by EMI issues. In this case it may be helpful to lower the I2C speed.

It is however not recommended to lower the I2C speed in applications where a high throughput needs to be achieved.

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants: