Rust - Barometer Bricklet 2.0

This is the description of the Rust API bindings for the Barometer Bricklet 2.0. General information and technical specifications for the Barometer Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
use std::{error::Error, io};

use tinkerforge::{barometer_v2_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Barometer Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let b = BarometerV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Get current air pressure.
    let air_pressure = b.get_air_pressure().recv()?;
    println!("Air Pressure: {} mbar", air_pressure as f32 / 1000.0);

    // Get current altitude.
    let altitude = b.get_altitude().recv()?;
    println!("Altitude: {} m", altitude as f32 / 1000.0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Callback

Download (example_callback.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
use std::{error::Error, io, thread};
use tinkerforge::{barometer_v2_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Barometer Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let b = BarometerV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let air_pressure_receiver = b.get_air_pressure_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `b` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for air_pressure in air_pressure_receiver {
            println!("Air Pressure: {} mbar", air_pressure as f32 / 1000.0);
        }
    });

    // Set period for air pressure callback to 1s (1000ms) without a threshold.
    b.set_air_pressure_callback_configuration(1000, false, 'x', 0, 0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Threshold

Download (example_threshold.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
use std::{error::Error, io, thread};
use tinkerforge::{barometer_v2_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Barometer Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let b = BarometerV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let air_pressure_receiver = b.get_air_pressure_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `b` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for air_pressure in air_pressure_receiver {
            println!("Air Pressure: {} mbar", air_pressure as f32 / 1000.0);
            println!("Enjoy the potentially good weather!");
        }
    });

    // Configure threshold for air pressure "greater than 1025 mbar"
    // with a debounce period of 1s (1000ms).
    b.set_air_pressure_callback_configuration(1000, false, '>', 1025 * 1000, 0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occured.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions

pub fn BarometerV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → BarometerV2Bricklet

Creates a new BarometerV2Bricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

This device object can be used after the IP connection has been connected (see examples above).

pub fn BarometerV2Bricklet::get_air_pressure(&self) → ConvertingReceiver<i32>

Returns the measured air pressure. The value has a range of 260000 to 1260000 and is given in mbar/1000, i.e. a value of 1001092 means that an air pressure of 1001.092 mbar is measured.

If you want to get the value periodically, it is recommended to use the BarometerV2Bricklet::get_air_pressure_callback_receiver callback. You can set the callback configuration with BarometerV2Bricklet::set_air_pressure_callback_configuration.

pub fn BarometerV2Bricklet::get_altitude(&self) → ConvertingReceiver<i32>

Returns the relative altitude of the air pressure sensor. The value is given in mm and is calculated based on the difference between the current air pressure and the reference air pressure that can be set with BarometerV2Bricklet::set_reference_air_pressure.

If you want to get the value periodically, it is recommended to use the BarometerV2Bricklet::get_altitude_callback_receiver callback. You can set the callback configuration with BarometerV2Bricklet::set_altitude_callback_configuration.

pub fn BarometerV2Bricklet::get_temperature(&self) → ConvertingReceiver<i32>

Returns the temperature of the air pressure sensor. The value has a range of -4000 to 8500 and is given in °C/100, i.e. a value of 2007 means that a temperature of 20.07 °C is measured.

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 2.0 or the Temperature IR Bricklet 2.0.

If you want to get the value periodically, it is recommended to use the BarometerV2Bricklet::get_temperature_callback_receiver callback. You can set the callback configuration with BarometerV2Bricklet::set_temperature_callback_configuration.

pub fn BarometerV2Bricklet::set_moving_average_configuration(&self, moving_average_length_air_pressure: u16, moving_average_length_temperature: u16) → ConvertingReceiver<()>

Sets the length of a moving averaging for the air pressure and temperature measurements.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

The range for the averaging is 1-1000.

If you want to do long term measurements the longest moving average will give the cleanest results.

The default value is 100.

pub fn BarometerV2Bricklet::get_moving_average_configuration(&self) → ConvertingReceiver<MovingAverageConfiguration>

Returns the moving average configuration as set by BarometerV2Bricklet::set_moving_average_configuration.

pub fn BarometerV2Bricklet::set_reference_air_pressure(&self, air_pressure: i32) → ConvertingReceiver<()>

Sets the reference air pressure in mbar/1000 for the altitude calculation. Valid values are between 260000 and 1260000. Setting the reference to the current air pressure results in a calculated altitude of 0mm. 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.

The default value is 1013.25mbar.

pub fn BarometerV2Bricklet::get_reference_air_pressure(&self) → ConvertingReceiver<i32>

Returns the reference air pressure as set by BarometerV2Bricklet::set_reference_air_pressure.

Advanced Functions

pub fn BarometerV2Bricklet::set_calibration(&self, measured_air_pressure: i32, actual_air_pressure: i32) → ConvertingReceiver<()>

Sets the one point calibration (OPC) values for the air pressure measurement.

Before the Bricklet can be calibrated any previous calibration has to be removed by setting measured air pressure and actual air pressure to 0.

Then the current air pressure has to be measured using the Bricklet (measured air pressure) and with and accurate reference barometer (actual air pressure) at the same time and passed to this function in mbar/1000.

After proper calibration the air pressure measurement can achieve an accuracy up to 0.2 mbar.

The calibration is saved in the EEPROM of the Bricklet and only needs to be configured once.

pub fn BarometerV2Bricklet::get_calibration(&self) → ConvertingReceiver<Calibration>

Returns the air pressure one point calibration values as set by BarometerV2Bricklet::set_calibration.

pub fn BarometerV2Bricklet::set_sensor_configuration(&self, data_rate: u8, air_pressure_low_pass_filter: u8) → ConvertingReceiver<()>

Configures the data rate and air pressure low pass filter. The low pass filter cut-off frequency (if enabled) can be set to 1/9th or 1/20th of the configure data rate to decrease the noise on the air pressure data.

The low pass filter configuration only applies to the air pressure measurement. There is no low pass filter for the temperature measurement.

A higher data rate will result in a less precise temperature because of self-heating of the sensor. If the accuracy of the temperature reading is important to you, we would recommend the 1Hz data rate.

The default values are 50Hz data rate and 1/9th low pass filter.

The following constants are available for this function:

  • BAROMETER_V2_BRICKLET_DATA_RATE_OFF = 0
  • BAROMETER_V2_BRICKLET_DATA_RATE_1HZ = 1
  • BAROMETER_V2_BRICKLET_DATA_RATE_10HZ = 2
  • BAROMETER_V2_BRICKLET_DATA_RATE_25HZ = 3
  • BAROMETER_V2_BRICKLET_DATA_RATE_50HZ = 4
  • BAROMETER_V2_BRICKLET_DATA_RATE_75HZ = 5
  • BAROMETER_V2_BRICKLET_LOW_PASS_FILTER_OFF = 0
  • BAROMETER_V2_BRICKLET_LOW_PASS_FILTER_1_9TH = 1
  • BAROMETER_V2_BRICKLET_LOW_PASS_FILTER_1_20TH = 2
pub fn BarometerV2Bricklet::get_sensor_configuration(&self) → ConvertingReceiver<SensorConfiguration>

Returns the sensor configuration as set by BarometerV2Bricklet::set_sensor_configuration.

The following constants are available for this function:

  • BAROMETER_V2_BRICKLET_DATA_RATE_OFF = 0
  • BAROMETER_V2_BRICKLET_DATA_RATE_1HZ = 1
  • BAROMETER_V2_BRICKLET_DATA_RATE_10HZ = 2
  • BAROMETER_V2_BRICKLET_DATA_RATE_25HZ = 3
  • BAROMETER_V2_BRICKLET_DATA_RATE_50HZ = 4
  • BAROMETER_V2_BRICKLET_DATA_RATE_75HZ = 5
  • BAROMETER_V2_BRICKLET_LOW_PASS_FILTER_OFF = 0
  • BAROMETER_V2_BRICKLET_LOW_PASS_FILTER_1_9TH = 1
  • BAROMETER_V2_BRICKLET_LOW_PASS_FILTER_1_20TH = 2
pub fn BarometerV2Bricklet::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 fn BarometerV2Bricklet::get_response_expected(&mut self, function_id: u8) → bool

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 BarometerV2Bricklet::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 BarometerV2Bricklet::set_response_expected for the list of function ID constants available for this function.

pub fn BarometerV2Bricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()

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.

The following function ID constants are available for this function:

  • BAROMETER_V2_BRICKLET_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
  • BAROMETER_V2_BRICKLET_FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
  • BAROMETER_V2_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • BAROMETER_V2_BRICKLET_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
  • BAROMETER_V2_BRICKLET_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
  • BAROMETER_V2_BRICKLET_FUNCTION_SET_CALIBRATION = 17
  • BAROMETER_V2_BRICKLET_FUNCTION_SET_SENSOR_CONFIGURATION = 19
  • BAROMETER_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BAROMETER_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BAROMETER_V2_BRICKLET_FUNCTION_RESET = 243
  • BAROMETER_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn BarometerV2Bricklet::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 BarometerV2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>

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 fn BarometerV2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>

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:

  • BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BAROMETER_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • BAROMETER_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BAROMETER_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BAROMETER_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BAROMETER_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BAROMETER_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn BarometerV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>

Returns the current bootloader mode, see BarometerV2Bricklet::set_bootloader_mode.

The following constants are available for this function:

  • BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn BarometerV2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>

Sets the firmware pointer for BarometerV2Bricklet::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 fn BarometerV2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>

Writes 64 Bytes of firmware at the position as written by BarometerV2Bricklet::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 fn BarometerV2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>

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:

  • BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn BarometerV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>

Returns the configuration as set by BarometerV2Bricklet::set_status_led_config

The following constants are available for this function:

  • BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn BarometerV2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>

Returns the temperature in °C 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 fn BarometerV2Bricklet::reset(&self) → ConvertingReceiver<()>

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 fn BarometerV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>

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 fn BarometerV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>

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

pub fn BarometerV2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>

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' or 'd'.

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

Callback Configuration Functions

pub fn BarometerV2Bricklet::set_air_pressure_callback_configuration(&self, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32) → ConvertingReceiver<()>

The period in ms is the period with which the BarometerV2Bricklet::get_air_pressure_callback_receiver 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 BarometerV2Bricklet::get_air_pressure_callback_receiver 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 default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn BarometerV2Bricklet::get_air_pressure_callback_configuration(&self) → ConvertingReceiver<AirPressureCallbackConfiguration>

Returns the callback configuration as set by BarometerV2Bricklet::set_air_pressure_callback_configuration.

The following constants are available for this function:

  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn BarometerV2Bricklet::set_altitude_callback_configuration(&self, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32) → ConvertingReceiver<()>

The period in ms is the period with which the BarometerV2Bricklet::get_altitude_callback_receiver 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 BarometerV2Bricklet::get_altitude_callback_receiver 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 default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn BarometerV2Bricklet::get_altitude_callback_configuration(&self) → ConvertingReceiver<AltitudeCallbackConfiguration>

Returns the callback configuration as set by BarometerV2Bricklet::set_altitude_callback_configuration.

The following constants are available for this function:

  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn BarometerV2Bricklet::set_temperature_callback_configuration(&self, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32) → ConvertingReceiver<()>

The period in ms is the period with which the BarometerV2Bricklet::get_temperature_callback_receiver 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 BarometerV2Bricklet::get_temperature_callback_receiver 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 default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn BarometerV2Bricklet::get_temperature_callback_configuration(&self) → ConvertingReceiver<TemperatureCallbackConfiguration>

Returns the callback configuration as set by BarometerV2Bricklet::set_temperature_callback_configuration.

The following constants are available for this function:

  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding get_*_callback_receiver function, which returns a receiver for callback events.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

pub fn BarometerV2Bricklet::get_air_pressure_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

Receivers created with this function receive Air Pressure events.

This callback is triggered periodically according to the configuration set by BarometerV2Bricklet::set_air_pressure_callback_configuration.

The received variable is the same as BarometerV2Bricklet::get_air_pressure.

pub fn BarometerV2Bricklet::get_altitude_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

Receivers created with this function receive Altitude events.

This callback is triggered periodically according to the configuration set by BarometerV2Bricklet::set_altitude_callback_configuration.

The received variable is the same as BarometerV2Bricklet::get_altitude.

pub fn BarometerV2Bricklet::get_temperature_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

Receivers created with this function receive Temperature events.

This callback is triggered periodically according to the configuration set by BarometerV2Bricklet::set_temperature_callback_configuration.

The received variable is the same as BarometerV2Bricklet::get_temperature.

Constants

BarometerV2Bricklet::DEVICE_IDENTIFIER

This constant is used to identify a Barometer Bricklet 2.0.

The BarometerV2Bricklet::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BarometerV2Bricklet::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Barometer Bricklet 2.0.