Struct tinkerforge::barometer_v2_bricklet::BarometerV2Bricklet

pub struct BarometerV2Bricklet { /* fields omitted */ }

Measures air pressure and altitude changes

Methods

impl BarometerV2Bricklet

pub const DEVICE_IDENTIFIER: u16

pub const DEVICE_DISPLAY_NAME: &'static str

pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> BarometerV2Bricklet

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: BarometerV2BrickletFunction
) -> 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.

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

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 fn get_air_pressure_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<i32>

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

The parameter is the same as get_air_pressure.

pub fn get_altitude_callback_receiver(&self) -> ConvertingCallbackReceiver<i32>

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

The parameter is the same as get_altitude.

pub fn get_temperature_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<i32>

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

The parameter is the same as get_temperature.

pub fn 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 get_air_pressure_callback_receiver receiver. You can set the receiver configuration with set_air_pressure_callback_configuration.

pub fn 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 get_air_pressure_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_air_pressure_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.

The default value is (0, false, 'x', 0, 0).

Associated constants:

• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OFF
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_air_pressure_callback_configuration(
    &self
) -> ConvertingReceiver<AirPressureCallbackConfiguration>

Returns the receiver configuration as set by set_air_pressure_callback_configuration.

Associated constants:

• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OFF
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn 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 set_reference_air_pressure.

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

pub fn 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 get_altitude_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_altitude_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.

The default value is (0, false, 'x', 0, 0).

Associated constants:

• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OFF
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_altitude_callback_configuration(
    &self
) -> ConvertingReceiver<AltitudeCallbackConfiguration>

Returns the receiver configuration as set by set_altitude_callback_configuration.

Associated constants:

• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OFF
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn 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_v2_bricklet or the temperature_ir_v2_bricklet.

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

pub fn 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 get_temperature_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_temperature_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.

The default value is (0, false, 'x', 0, 0).

Associated constants:

• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OFF
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_temperature_callback_configuration(
    &self
) -> ConvertingReceiver<TemperatureCallbackConfiguration>

Returns the receiver configuration as set by set_temperature_callback_configuration.

Associated constants:

• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OFF
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
• BAROMETER_V2_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn 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 get_moving_average_configuration(
    &self
) -> ConvertingReceiver<MovingAverageConfiguration>

Returns the moving average configuration as set by set_moving_average_configuration.

pub fn 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 get_reference_air_pressure(&self) -> ConvertingReceiver<i32>

Returns the reference air pressure as set by set_reference_air_pressure.

pub fn 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 get_calibration(&self) -> ConvertingReceiver<Calibration>

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

pub fn 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.

Associated constants:

• BAROMETER_V2_BRICKLET_DATA_RATE_OFF
• BAROMETER_V2_BRICKLET_DATA_RATE_1HZ
• BAROMETER_V2_BRICKLET_DATA_RATE_10HZ
• BAROMETER_V2_BRICKLET_DATA_RATE_25HZ
• BAROMETER_V2_BRICKLET_DATA_RATE_50HZ
• BAROMETER_V2_BRICKLET_DATA_RATE_75HZ
• BAROMETER_V2_BRICKLET_LOW_PASS_FILTER_OFF
• BAROMETER_V2_BRICKLET_LOW_PASS_FILTER_1_9TH
• BAROMETER_V2_BRICKLET_LOW_PASS_FILTER_1_20TH

pub fn get_sensor_configuration(
    &self
) -> ConvertingReceiver<SensorConfiguration>

Returns the sensor configuration as set by set_sensor_configuration.

Associated constants:

• BAROMETER_V2_BRICKLET_DATA_RATE_OFF
• BAROMETER_V2_BRICKLET_DATA_RATE_1HZ
• BAROMETER_V2_BRICKLET_DATA_RATE_10HZ
• BAROMETER_V2_BRICKLET_DATA_RATE_25HZ
• BAROMETER_V2_BRICKLET_DATA_RATE_50HZ
• BAROMETER_V2_BRICKLET_DATA_RATE_75HZ
• BAROMETER_V2_BRICKLET_LOW_PASS_FILTER_OFF
• BAROMETER_V2_BRICKLET_LOW_PASS_FILTER_1_9TH
• BAROMETER_V2_BRICKLET_LOW_PASS_FILTER_1_20TH

pub fn 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 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.

Associated constants:

• BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• BAROMETER_V2_BRICKLET_BOOTLOADER_STATUS_OK
• BAROMETER_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• BAROMETER_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• BAROMETER_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• BAROMETER_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• BAROMETER_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>

Returns the current bootloader mode, see set_bootloader_mode.

Associated constants:

• BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• BAROMETER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>

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 fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>

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

Associated constants:

• BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_ON
• BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by set_status_led_config

Associated constants:

• BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_ON
• BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• BAROMETER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

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

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

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

Trait Implementations

impl Clone for BarometerV2Bricklet

fn clone(&self) -> BarometerV2Bricklet

Returns a copy of the value.

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

Performs copy-assignment from source.