Struct tinkerforge::air_quality_bricklet::AirQualityBricklet

source ·

pub struct AirQualityBricklet { /* private fields */ }

Expand description

Measures IAQ index, temperature, humidity and air pressure

Implementations§

source §

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

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: AirQualityBrickletFunction ) -> 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: AirQualityBrickletFunction, 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 fn get_all_values_callback_receiver( &self ) -> ConvertingCallbackReceiver<AllValuesEvent>

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

The parameters are the same as get_all_values.

source

pub fn get_iaq_index_callback_receiver( &self ) -> ConvertingCallbackReceiver<IaqIndexEvent>

This receiver is triggered periodically according to the configuration set by [set_iaq_index_callback_configuration].

The parameters are the same as [get_iaq_index].

source

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

source

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

This receiver is triggered periodically according to the configuration set by [set_humidity_callback_configuration].

The parameter is the same as [get_humidity].

source

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

source

pub fn get_all_values(&self) -> ConvertingReceiver<AllValues>

Returns all values measured by the Air Quality Bricklet. The values are IAQ (Indoor Air Quality) Index (higher value means greater level of air pollution), IAQ Index Accuracy, Temperature, Humidity and Air Pressure.

.. image:: /Images/Misc/bricklet_air_quality_iaq_index.png :scale: 100 % :alt: Air Quality Index description :align: center :target: ../../_images/Misc/bricklet_air_quality_iaq_index.png

Associated constants:

AIR_QUALITY_BRICKLET_ACCURACY_UNRELIABLE
AIR_QUALITY_BRICKLET_ACCURACY_LOW
AIR_QUALITY_BRICKLET_ACCURACY_MEDIUM
AIR_QUALITY_BRICKLET_ACCURACY_HIGH

source

pub fn set_temperature_offset(&self, offset: i32) -> ConvertingReceiver<()>

Sets a temperature offset. A offset of 10 will decrease the measured temperature by 0.1 °C.

If you install this Bricklet into an enclosure and you want to measure the ambient temperature, you may have to decrease the measured temperature by some value to compensate for the error because of the heating inside of the enclosure.

We recommend that you leave the parts in the enclosure running for at least 24 hours such that a temperature equilibrium can be reached. After that you can measure the temperature directly outside of enclosure and set the difference as offset.

This temperature offset is used to calculate the relative humidity and IAQ index measurements. In case the Bricklet is installed in an enclosure, we recommend to measure and set the temperature offset to improve the accuracy of the measurements.

source

pub fn get_temperature_offset(&self) -> ConvertingReceiver<i32>

Returns the temperature offset as set by [set_temperature_offset].

source

pub fn set_all_values_callback_configuration( &self, period: u32, value_has_to_change: bool ) -> ConvertingReceiver<()>

The period is the period with which the [get_all_values_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 at least one of the values has changed. If the values 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.

source

pub fn get_all_values_callback_configuration( &self ) -> ConvertingReceiver<AllValuesCallbackConfiguration>

Returns the receiver configuration as set by [set_all_values_callback_configuration].

source

pub fn get_iaq_index(&self) -> ConvertingReceiver<IaqIndex>

Returns the IAQ index and accuracy. The higher the IAQ index, the greater the level of air pollution.

.. image:: /Images/Misc/bricklet_air_quality_iaq_index.png :scale: 100 % :alt: IAQ index description :align: center :target: ../../_images/Misc/bricklet_air_quality_iaq_index.png

If you want to get the value periodically, it is recommended to use the [get_iaq_index_callback_receiver] receiver. You can set the receiver configuration with [set_iaq_index_callback_configuration].

Associated constants:

AIR_QUALITY_BRICKLET_ACCURACY_UNRELIABLE
AIR_QUALITY_BRICKLET_ACCURACY_LOW
AIR_QUALITY_BRICKLET_ACCURACY_MEDIUM
AIR_QUALITY_BRICKLET_ACCURACY_HIGH

source

pub fn set_iaq_index_callback_configuration( &self, period: u32, value_has_to_change: bool ) -> ConvertingReceiver<()>

The period is the period with which the [get_iaq_index_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 at least one of the values has changed. If the values 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.

source

pub fn get_iaq_index_callback_configuration( &self ) -> ConvertingReceiver<IaqIndexCallbackConfiguration>

Returns the receiver configuration as set by [set_iaq_index_callback_configuration].

source

pub fn get_temperature(&self) -> ConvertingReceiver<i32>

Returns temperature.

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

source

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

The period 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.

Associated constants:

AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OFF
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_INSIDE
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_SMALLER
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_GREATER

source

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

Returns the receiver configuration as set by [set_temperature_callback_configuration].

Associated constants:

AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OFF
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_INSIDE
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_SMALLER
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn get_humidity(&self) -> ConvertingReceiver<i32>

Returns relative humidity.

If you want to get the value periodically, it is recommended to use the [get_humidity_callback_receiver] receiver. You can set the receiver configuration with [set_humidity_callback_configuration].

source

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

The period is the period with which the [get_humidity_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_humidity_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.

Associated constants:

AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OFF
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_INSIDE
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_SMALLER
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn get_humidity_callback_configuration( &self ) -> ConvertingReceiver<HumidityCallbackConfiguration>

Returns the receiver configuration as set by [set_humidity_callback_configuration].

Associated constants:

AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OFF
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_INSIDE
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_SMALLER
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn get_air_pressure(&self) -> ConvertingReceiver<i32>

Returns air pressure.

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

source

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

The period 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.

Associated constants:

AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OFF
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_INSIDE
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_SMALLER
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_GREATER

source

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

Returns the receiver configuration as set by [set_air_pressure_callback_configuration].

Associated constants:

AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OFF
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_INSIDE
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_SMALLER
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn remove_calibration(&self) -> ConvertingReceiver<()>

Deletes the calibration from flash. After you call this function, you need to power cycle the Air Quality Bricklet.

On the next power up the Bricklet will start a new calibration, as if it was started for the very first time.

The calibration is based on the data of the last four days, so it takes four days until a full calibration is re-established.

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

source

pub fn set_background_calibration_duration( &self, duration: u8 ) -> ConvertingReceiver<()>

The Air Quality Bricklet uses an automatic background calibration mechanism to calculate the IAQ Index. This calibration mechanism considers a history of measured data. The duration of this history can be configured to either be 4 days or 28 days.

If you keep the Bricklet mostly at one place and it does not get moved around to different environments, we recommend that you use a duration of 28 days.

If you change the duration, the current calibration will be discarded and the calibration will start from beginning again. The configuration of the duration is saved in flash, so you should only have to call this function once in the lifetime of the Bricklet.

The Bricklet has to be power cycled after this function is called for a duration change to take effect.

Before firmware version 2.0.3 this was not configurable and the duration was 4 days.

The default value (since firmware version 2.0.3) is 28 days.

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

Associated constants:

AIR_QUALITY_BRICKLET_DURATION_4_DAYS
AIR_QUALITY_BRICKLET_DURATION_28_DAYS

source

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

Returns the background calibration duration as set by [set_background_calibration_duration].

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

Associated constants:

AIR_QUALITY_BRICKLET_DURATION_4_DAYS
AIR_QUALITY_BRICKLET_DURATION_28_DAYS

source

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.

source

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:

AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_FIRMWARE
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
AIR_QUALITY_BRICKLET_BOOTLOADER_STATUS_OK
AIR_QUALITY_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
AIR_QUALITY_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
AIR_QUALITY_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
AIR_QUALITY_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
AIR_QUALITY_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

source

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

Returns the current bootloader mode, see [set_bootloader_mode].

Associated constants:

AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_FIRMWARE
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

source

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.

source

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.

source

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:

AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_OFF
AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_ON
AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

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

Returns the configuration as set by [set_status_led_config]

Associated constants:

AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_OFF
AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_ON
AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>

Returns the temperature 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.

source