Software / API Bindings / Rust / API Reference and Examples / Bricklets / Air Quality Bricklet

Rust - Air Quality Bricklet¶

This is the description of the Rust API bindings for the Air Quality Bricklet. General information and technical specifications for the Air Quality Bricklet 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)

use std::{error::Error, io};

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

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

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

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

    // Get current all values.
    let all_values = aq.get_all_values().recv()?;

    println!("IAQ Index: {}", all_values.iaq_index);

    if all_values.iaq_index_accuracy == AIR_QUALITY_BRICKLET_ACCURACY_UNRELIABLE {
        println!("IAQ Index Accuracy: Unreliable");
    } else if all_values.iaq_index_accuracy == AIR_QUALITY_BRICKLET_ACCURACY_LOW {
        println!("IAQ Index Accuracy: Low");
    } else if all_values.iaq_index_accuracy == AIR_QUALITY_BRICKLET_ACCURACY_MEDIUM {
        println!("IAQ Index Accuracy: Medium");
    } else if all_values.iaq_index_accuracy == AIR_QUALITY_BRICKLET_ACCURACY_HIGH {
        println!("IAQ Index Accuracy: High");
    }

    println!("Temperature: {} °C", all_values.temperature as f32 / 100.0);
    println!("Humidity: {} %RH", all_values.humidity as f32 / 100.0);
    println!("Air Pressure: {} hPa", all_values.air_pressure as f32 / 100.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)

use std::{error::Error, io, thread};
use tinkerforge::{air_quality_bricklet::*, ip_connection::IpConnection};

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

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

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

    let all_values_receiver = aq.get_all_values_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `aq` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for all_values in all_values_receiver {
            println!("IAQ Index: {}", all_values.iaq_index);

            if all_values.iaq_index_accuracy == AIR_QUALITY_BRICKLET_ACCURACY_UNRELIABLE {
                println!("IAQ Index Accuracy: Unreliable");
            } else if all_values.iaq_index_accuracy == AIR_QUALITY_BRICKLET_ACCURACY_LOW {
                println!("IAQ Index Accuracy: Low");
            } else if all_values.iaq_index_accuracy == AIR_QUALITY_BRICKLET_ACCURACY_MEDIUM {
                println!("IAQ Index Accuracy: Medium");
            } else if all_values.iaq_index_accuracy == AIR_QUALITY_BRICKLET_ACCURACY_HIGH {
                println!("IAQ Index Accuracy: High");
            }

            println!("Temperature: {} °C", all_values.temperature as f32 / 100.0);
            println!("Humidity: {} %RH", all_values.humidity as f32 / 100.0);
            println!("Air Pressure: {} hPa", all_values.air_pressure as f32 / 100.0);
            println!();
        }
    });

    // Set period for all values callback to 1s (1000ms).
    aq.set_all_values_callback_configuration(1000, false);

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

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 AirQualityBricklet::new(uid: &str, ip_connection: &IpConnection) → AirQualityBricklet¶

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	air_quality – Type: AirQualityBricklet

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

let air_quality = AirQualityBricklet::new("YOUR_DEVICE_UID", &ip_connection);

This device object can be used after the IP connection has been connected.

pub fn AirQualityBricklet::get_all_values(&self) → ConvertingReceiver<AllValues>¶

Return Object:	iaq_index – Type: i32, Range: [0 to 500] iaq_index_accuracy – Type: u8, Range: See constants temperature – Type: i32, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1] humidity – Type: i32, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1] air_pressure – Type: i32, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]

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.

The following constants are available for this function:

For iaq_index_accuracy:

AIR_QUALITY_BRICKLET_ACCURACY_UNRELIABLE = 0
AIR_QUALITY_BRICKLET_ACCURACY_LOW = 1
AIR_QUALITY_BRICKLET_ACCURACY_MEDIUM = 2
AIR_QUALITY_BRICKLET_ACCURACY_HIGH = 3

pub fn AirQualityBricklet::set_temperature_offset(&self, offset: i32) → ConvertingReceiver<()>¶

Parameters:	offset – Type: i32, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1]

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.

pub fn AirQualityBricklet::get_temperature_offset(&self) → ConvertingReceiver<i32>¶

Returns:	offset – Type: i32, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1]

Returns the temperature offset as set by AirQualityBricklet::set_temperature_offset.

pub fn AirQualityBricklet::get_iaq_index(&self) → ConvertingReceiver<IaqIndex>¶

Return Object:	iaq_index – Type: i32, Range: [0 to 500] iaq_index_accuracy – Type: u8, Range: See constants

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

If you want to get the value periodically, it is recommended to use the AirQualityBricklet::get_iaq_index_callback_receiver callback. You can set the callback configuration with AirQualityBricklet::set_iaq_index_callback_configuration.

The following constants are available for this function:

For iaq_index_accuracy:

AIR_QUALITY_BRICKLET_ACCURACY_UNRELIABLE = 0
AIR_QUALITY_BRICKLET_ACCURACY_LOW = 1
AIR_QUALITY_BRICKLET_ACCURACY_MEDIUM = 2
AIR_QUALITY_BRICKLET_ACCURACY_HIGH = 3

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

Returns:	temperature – Type: i32, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1]

Returns temperature.

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

pub fn AirQualityBricklet::get_humidity(&self) → ConvertingReceiver<i32>¶

Returns:	humidity – Type: i32, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1]

Returns relative humidity.

If you want to get the value periodically, it is recommended to use the AirQualityBricklet::get_humidity_callback_receiver callback. You can set the callback configuration with AirQualityBricklet::set_humidity_callback_configuration.

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

Returns:	air_pressure – Type: i32, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]

Returns air pressure.

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

Advanced Functions¶

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

New in version 2.0.3 (Plugin).

pub fn AirQualityBricklet::set_background_calibration_duration(&self, duration: u8) → ConvertingReceiver<()>¶

Parameters:	duration – Type: u8, Range: See constants, Default: 1

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.

The following constants are available for this function:

For duration:

AIR_QUALITY_BRICKLET_DURATION_4_DAYS = 0
AIR_QUALITY_BRICKLET_DURATION_28_DAYS = 1

New in version 2.0.3 (Plugin).

pub fn AirQualityBricklet::get_background_calibration_duration(&self) → ConvertingReceiver<u8>¶

Returns:	duration – Type: u8, Range: See constants, Default: 1

Returns the background calibration duration as set by AirQualityBricklet::set_background_calibration_duration.

The following constants are available for this function:

For duration:

AIR_QUALITY_BRICKLET_DURATION_4_DAYS = 0
AIR_QUALITY_BRICKLET_DURATION_28_DAYS = 1

New in version 2.0.3 (Plugin).

pub fn AirQualityBricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>¶

Return Object:	error_count_ack_checksum – Type: u32, Range: [0 to 2³² - 1] error_count_message_checksum – Type: u32, Range: [0 to 2³² - 1] error_count_frame – Type: u32, Range: [0 to 2³² - 1] error_count_overflow – Type: u32, Range: [0 to 2³² - 1]

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 AirQualityBricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameters:	config – Type: u8, Range: See constants, Default: 3

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:

For config:

AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_OFF = 0
AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_ON = 1
AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn AirQualityBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>¶

Returns:	config – Type: u8, Range: See constants, Default: 3

Returns the configuration as set by AirQualityBricklet::set_status_led_config

The following constants are available for this function:

For config:

AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_OFF = 0
AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_ON = 1
AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
AIR_QUALITY_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn AirQualityBricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>¶

Returns:	temperature – Type: i16, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

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.

pub fn AirQualityBricklet::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 AirQualityBricklet::get_identity(&self) → ConvertingReceiver<Identity>¶

Return Object:

Return Object:	uid – Type: String, Length: up to 8 connected_uid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardware_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255] firmware_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255] device_identifier – Type: u16, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connected_uid – Type: String, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardware_version – Type: [u8; 3]

0: major – Type: u8, Range: [0 to 255]
1: minor – Type: u8, Range: [0 to 255]
2: revision – Type: u8, Range: [0 to 255]

firmware_version – Type: [u8; 3]

0: major – Type: u8, Range: [0 to 255]
1: minor – Type: u8, Range: [0 to 255]
2: revision – Type: u8, Range: [0 to 255]

device_identifier – Type: u16, Range: [0 to 2¹⁶ - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

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 AirQualityBricklet::set_all_values_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶

Parameters:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false

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

pub fn AirQualityBricklet::get_all_values_callback_configuration(&self) → ConvertingReceiver<AllValuesCallbackConfiguration>¶

Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false

Returns the callback configuration as set by AirQualityBricklet::set_all_values_callback_configuration.

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

Parameters:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false

The period is the period with which the AirQualityBricklet::get_iaq_index_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

pub fn AirQualityBricklet::get_iaq_index_callback_configuration(&self) → ConvertingReceiver<IaqIndexCallbackConfiguration>¶

Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false

Returns the callback configuration as set by AirQualityBricklet::set_iaq_index_callback_configuration.

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

Parameters:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: i32, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

The period is the period with which the AirQualityBricklet::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 AirQualityBricklet::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 following constants are available for this function:

For option:

AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn AirQualityBricklet::get_temperature_callback_configuration(&self) → ConvertingReceiver<TemperatureCallbackConfiguration>¶

Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: i32, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

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

The following constants are available for this function:

For option:

AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

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

Parameters:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: i32, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1], Default: 0

The period is the period with which the AirQualityBricklet::get_humidity_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

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 AirQualityBricklet::get_humidity_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 following constants are available for this function:

For option:

AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn AirQualityBricklet::get_humidity_callback_configuration(&self) → ConvertingReceiver<HumidityCallbackConfiguration>¶

Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: i32, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by AirQualityBricklet::set_humidity_callback_configuration.

The following constants are available for this function:

For option:

AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

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

Parameters:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: i32, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0

The period is the period with which the AirQualityBricklet::get_air_pressure_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

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 AirQualityBricklet::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 following constants are available for this function:

For option:

AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn AirQualityBricklet::get_air_pressure_callback_configuration(&self) → ConvertingReceiver<AirPressureCallbackConfiguration>¶

Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: i32, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0

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

The following constants are available for this function:

For option:

AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
AIR_QUALITY_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
AIR_QUALITY_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 AirQualityBricklet::get_all_values_callback_receiver(&self) → ConvertingCallbackReceiver<AllValuesEvent>¶

Event Object:	iaq_index – Type: i32, Range: [0 to 500] iaq_index_accuracy – Type: u8, Range: See constants temperature – Type: i32, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1] humidity – Type: i32, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1] air_pressure – Type: i32, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]

Receivers created with this function receive All Values events.

This callback is triggered periodically according to the configuration set by AirQualityBricklet::set_all_values_callback_configuration.

The members of the received struct are the same as AirQualityBricklet::get_all_values.

The following constants are available for this function:

For iaq_index_accuracy:

AIR_QUALITY_BRICKLET_ACCURACY_UNRELIABLE = 0
AIR_QUALITY_BRICKLET_ACCURACY_LOW = 1
AIR_QUALITY_BRICKLET_ACCURACY_MEDIUM = 2
AIR_QUALITY_BRICKLET_ACCURACY_HIGH = 3

pub fn AirQualityBricklet::get_iaq_index_callback_receiver(&self) → ConvertingCallbackReceiver<IaqIndexEvent>¶

Event Object:	iaq_index – Type: i32, Range: [0 to 500] iaq_index_accuracy – Type: u8, Range: See constants

Receivers created with this function receive IAQ Index events.

This callback is triggered periodically according to the configuration set by AirQualityBricklet::set_iaq_index_callback_configuration.

The members of the received struct are the same as AirQualityBricklet::get_iaq_index.

The following constants are available for this function:

For iaq_index_accuracy:

AIR_QUALITY_BRICKLET_ACCURACY_UNRELIABLE = 0
AIR_QUALITY_BRICKLET_ACCURACY_LOW = 1
AIR_QUALITY_BRICKLET_ACCURACY_MEDIUM = 2
AIR_QUALITY_BRICKLET_ACCURACY_HIGH = 3

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

Event:	temperature – Type: i32, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1]

Receivers created with this function receive Temperature events.

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

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

pub fn AirQualityBricklet::get_humidity_callback_receiver(&self) → ConvertingCallbackReceiver<i32>¶

Event:	humidity – Type: i32, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1]

Receivers created with this function receive Humidity events.

This callback is triggered periodically according to the configuration set by AirQualityBricklet::set_humidity_callback_configuration.

The received variable is the same as AirQualityBricklet::get_humidity.

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

Event:	air_pressure – Type: i32, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]

Receivers created with this function receive Air Pressure events.

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

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

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

pub fn AirQualityBricklet::get_api_version(&self) → [u8; 3]¶

Return Object:	api_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255]

Returns the version of the API definition 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 AirQualityBricklet::get_response_expected(&mut self, function_id: u8) → bool¶

Parameters:	function_id – Type: u8, Range: See constants
Returns:	response_expected – Type: 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 AirQualityBricklet::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.

The following constants are available for this function:

For function_id:

AIR_QUALITY_BRICKLET_FUNCTION_SET_TEMPERATURE_OFFSET = 2
AIR_QUALITY_BRICKLET_FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
AIR_QUALITY_BRICKLET_FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
AIR_QUALITY_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
AIR_QUALITY_BRICKLET_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
AIR_QUALITY_BRICKLET_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
AIR_QUALITY_BRICKLET_FUNCTION_REMOVE_CALIBRATION = 23
AIR_QUALITY_BRICKLET_FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
AIR_QUALITY_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
AIR_QUALITY_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
AIR_QUALITY_BRICKLET_FUNCTION_RESET = 243
AIR_QUALITY_BRICKLET_FUNCTION_WRITE_UID = 248

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

Parameters:	function_id – Type: u8, Range: See constants response_expected – Type: 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.

The following constants are available for this function:

For function_id:

AIR_QUALITY_BRICKLET_FUNCTION_SET_TEMPERATURE_OFFSET = 2
AIR_QUALITY_BRICKLET_FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
AIR_QUALITY_BRICKLET_FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
AIR_QUALITY_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
AIR_QUALITY_BRICKLET_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
AIR_QUALITY_BRICKLET_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
AIR_QUALITY_BRICKLET_FUNCTION_REMOVE_CALIBRATION = 23
AIR_QUALITY_BRICKLET_FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
AIR_QUALITY_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
AIR_QUALITY_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
AIR_QUALITY_BRICKLET_FUNCTION_RESET = 243
AIR_QUALITY_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn AirQualityBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()¶

Parameters:	response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

pub fn AirQualityBricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>¶

Parameters:	mode – Type: u8, Range: See constants
Returns:	status – Type: u8, Range: See constants

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:

For mode:

AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

AIR_QUALITY_BRICKLET_BOOTLOADER_STATUS_OK = 0
AIR_QUALITY_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
AIR_QUALITY_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
AIR_QUALITY_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
AIR_QUALITY_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
AIR_QUALITY_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

pub fn AirQualityBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>¶

Returns:	mode – Type: u8, Range: See constants

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

The following constants are available for this function:

For mode:

AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
AIR_QUALITY_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

pub fn AirQualityBricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>¶

Parameters:	pointer – Type: u32, Unit: 1 B, Range: [0 to 2³² - 1]

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

Parameters:	data – Type: [u8; 64], Range: [0 to 255]
Returns:	status – Type: u8, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by AirQualityBricklet::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 AirQualityBricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>¶

Parameters:	uid – Type: u32, Range: [0 to 2³² - 1]

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

Returns:	uid – Type: u32, Range: [0 to 2³² - 1]

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

Constants¶

pub const AirQualityBricklet::DEVICE_IDENTIFIER¶

This constant is used to identify a Air Quality Bricklet.

The AirQualityBricklet::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.

pub const AirQualityBricklet::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Air Quality Bricklet.