Struct BarometerBricklet

Source

pub struct BarometerBricklet { /* private fields */ }

Expand description

Measures air pressure and altitude changes

Implementations§

Source §

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

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: BarometerBrickletFunction, ) -> 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: BarometerBrickletFunction, 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_air_pressure_callback_receiver( &mut self, ) -> impl Stream<Item = i32>

This receiver is triggered periodically with the period that is set by set_air_pressure_callback_period. The parameter is the air pressure of the air pressure sensor.

The get_air_pressure_callback_receiver receiver is only triggered if the air pressure has changed since the last triggering.

Source

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

This receiver is triggered periodically with the period that is set by [set_altitude_callback_period]. The parameter is the altitude of the air pressure sensor.

The [get_altitude_callback_receiver] receiver is only triggered if the altitude has changed since the last triggering.

Source

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

This receiver is triggered when the threshold as set by [set_air_pressure_callback_threshold] is reached. The parameter is the air pressure of the air pressure 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_altitude_reached_callback_receiver( &mut self, ) -> impl Stream<Item = i32>

This receiver is triggered when the threshold as set by [set_altitude_callback_threshold] is reached. The parameter is the altitude of the air pressure 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_air_pressure(&mut self) -> Result<i32, TinkerforgeError>

Returns the air pressure of the air pressure sensor.

If you want to get the air pressure periodically, it is recommended to use the [get_air_pressure_callback_receiver] receiver and set the period with [set_air_pressure_callback_period].

Source

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

Returns the relative altitude of the air pressure sensor. The value is calculated based on the difference between the current air pressure and the reference air pressure that can be set with [set_reference_air_pressure].

If you want to get the altitude periodically, it is recommended to use the [get_altitude_callback_receiver] receiver and set the period with [set_altitude_callback_period].

Source

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

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

The [get_air_pressure_callback_receiver] receiver is only triggered if the air pressure has changed since the last triggering.

Source

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

Returns the period as set by [set_air_pressure_callback_period].

Source

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

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

The [get_altitude_callback_receiver] receiver is only triggered if the altitude has changed since the last triggering.

Source

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

Returns the period as set by [set_altitude_callback_period].

Source

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

Sets the thresholds for the [get_air_pressure_reached_callback_receiver] receiver.

The following options are possible:

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

Associated constants:

BAROMETER_BRICKLET_THRESHOLD_OPTION_OFF
BAROMETER_BRICKLET_THRESHOLD_OPTION_OUTSIDE
BAROMETER_BRICKLET_THRESHOLD_OPTION_INSIDE
BAROMETER_BRICKLET_THRESHOLD_OPTION_SMALLER
BAROMETER_BRICKLET_THRESHOLD_OPTION_GREATER

Source

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

Returns the threshold as set by [set_air_pressure_callback_threshold].

Associated constants:

BAROMETER_BRICKLET_THRESHOLD_OPTION_OFF
BAROMETER_BRICKLET_THRESHOLD_OPTION_OUTSIDE
BAROMETER_BRICKLET_THRESHOLD_OPTION_INSIDE
BAROMETER_BRICKLET_THRESHOLD_OPTION_SMALLER
BAROMETER_BRICKLET_THRESHOLD_OPTION_GREATER

Source

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

Sets the thresholds for the [get_altitude_reached_callback_receiver] receiver.

The following options are possible:

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

Associated constants:

BAROMETER_BRICKLET_THRESHOLD_OPTION_OFF
BAROMETER_BRICKLET_THRESHOLD_OPTION_OUTSIDE
BAROMETER_BRICKLET_THRESHOLD_OPTION_INSIDE
BAROMETER_BRICKLET_THRESHOLD_OPTION_SMALLER
BAROMETER_BRICKLET_THRESHOLD_OPTION_GREATER

Source

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

Returns the threshold as set by [set_altitude_callback_threshold].

Associated constants:

BAROMETER_BRICKLET_THRESHOLD_OPTION_OFF
BAROMETER_BRICKLET_THRESHOLD_OPTION_OUTSIDE
BAROMETER_BRICKLET_THRESHOLD_OPTION_INSIDE
BAROMETER_BRICKLET_THRESHOLD_OPTION_SMALLER
BAROMETER_BRICKLET_THRESHOLD_OPTION_GREATER

Source

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

Sets the period with which the threshold receivers

[get_air_pressure_reached_callback_receiver],
[get_altitude_reached_callback_receiver]

are triggered, if the thresholds

[set_air_pressure_callback_threshold],
[set_altitude_callback_threshold]

keep 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_reference_air_pressure( &mut self, air_pressure: i32, ) -> Result<(), TinkerforgeError>

Sets the reference air pressure for the altitude calculation. Setting the reference to the current air pressure results in a calculated altitude of 0cm. Passing 0 is a shortcut for passing the current air pressure as reference.

Well known reference values are the Q codes QNH__ and QFE__ used in aviation.

Source

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

Returns the temperature of the air pressure sensor.

This temperature is used internally for temperature compensation of the air pressure measurement. It is not as accurate as the temperature measured by the temperature_bricklet or the temperature_ir_bricklet.

Source

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

Returns the reference air pressure as set by [set_reference_air_pressure].

Source

pub async fn set_averaging( &mut self, moving_average_pressure: u8, average_pressure: u8, average_temperature: u8, ) -> Result<(), TinkerforgeError>

Sets the different averaging parameters. It is possible to set the length of a normal averaging for the temperature and pressure, as well as an additional length of a moving average__ for the pressure. The moving average is calculated from the normal averages. There is no moving average for the temperature.

Setting the all three parameters to 0 will turn the averaging completely off. If the averaging is off, there is lots of noise on the data, but the data is without delay. Thus we recommend to turn the averaging off if the Barometer Bricklet data is to be used for sensor fusion with other sensors.

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

Source

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

Returns the averaging configuration as set by [set_averaging].

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

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 Barometer 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.3$nbsp;(Plugin)

Associated constants: