Rust - Air Quality Bricklet

Dies ist die Beschreibung der Rust API Bindings für das Air Quality Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Air Quality Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Rust API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf docs.rs.

Beispiele

Der folgende Beispielcode ist 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
30
31
32
33
34
35
36
37
38
39
40
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: {} mbar", 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)

 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
37
38
39
40
41
42
43
44
45
46
47
48
49
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: {} mbar", 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

Um eine nicht-blockierende Verwendung zu erlauben, gibt fast jede Funktion der Rust-Bindings einen Wrapper um einen mpsc::Receiver zurück. Um das Ergebnis eines Funktionsaufrufs zu erhalten und zu blockieren, bis das Gerät die Anfrage verarbeitet hat, können die recv-Varianten des Receivers verwendet werden. Diese geben entweder das vom Gerät gesendete Ergebnis, oder einen aufgetretenen Fehler zurück.

Funktionen die direkt ein Result zurückgeben, blockieren bis das Gerät die Anfrage verarbeitet hat.

Alle folgend aufgelisteten Funktionen sind Thread-sicher, diese, die einen Receiver zurückgeben, sind Lock-frei.

Grundfunktionen

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

Erzeugt ein neues AirQualityBricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IP-Connection ipcon hinzu:

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden wurde (siehe Beispiele oben).

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

Gibt alle Werte zurück, die das Air Quality Bricklet misst. Diese Werte umfassen: IAQ (Indoor Air Quality = Innenraumluftqualität) Index, IAQ Index Genauigkeit, Temperatur, Luftfeuchte und Luftdruck.

Air Quality Index description

Die Werte haben diese Bereiche und Einheiten:

  • IAQ Index: 0 bis 500, ein höhere Werte bedeutet eine stärkere Luftverschmutzung
  • IAQ Index Genauigkeit: 0 = unzuverlässig bis 3 = hoch
  • Temperatur: in 0,01 °C Schritten
  • Luftfeuchte: in 0,01 %RH Schritten
  • Luftdruck: in 0,01 mbar Schritten

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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<()>

Setzt ein Temperatur-Offset mit Auflösung 1/100°C. Ein Offset von 10 verringert die gemessene Temperatur um 0,1°C.

Wenn das Bricklet in einem Gehäuse verbaut wird, aber die Umgebungstemperatur außerhalb des Gehäuses gemessen werden soll, dann muss vom gemessenen Temperatur ein bestimmter Wert abgezogen werden, um den Messfehler durch das Aufheizen des Gehäuses zu kompensieren.

Wir empfehlen den Messaufbau im Gehäuse mindestens 24 Stunden laufen zu lassen, damit sich ein Temperaturgleichgewicht einstellt. Danach muss die Temperatur außerhalb des Gehäuses gemessen werden und die Differenz zur Temperatur innerhalb des Gehäuses als Offset eingestellt werden.

Dieses Temperatur-Offset geht in die Berechnung der Luftfeuchte und des IAQ Index mit ein. Um die Genauigkeit der Messwerte innerhalb eines Gehäuses zu verbessern sollte der Temperatur-Offset unbedingt bestimmt und eingestellt werden.

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

Gibt das Temperatur-Offset zurück, wie mittels AirQualityBricklet::set_temperature_offset gesetzt.

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

Gibt den IAQ Index und dessen Genaugkeit zurück. Der IAQ Index hate einen Wertebereich von 0 bis 500, ein höhere Werte bedeutet eine stärkere Luftverschmutzung.

IAQ Index Beschreibung

Wenn der Wert periodisch benötigt wird, kann auch der AirQualityBricklet::get_iaq_index_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion AirQualityBricklet::set_iaq_index_callback_configuration konfiguriert.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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>

Gibt die Temperatur in 0,01 °C Schritten zurück.

Wenn der Wert periodisch benötigt wird, kann auch der AirQualityBricklet::get_temperature_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion AirQualityBricklet::set_temperature_callback_configuration konfiguriert.

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

Gibt die relative Luftfeuchtigkeit in 0,01 %RH Schritten zurück.

Wenn der Wert periodisch benötigt wird, kann auch der AirQualityBricklet::get_humidity_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion AirQualityBricklet::set_humidity_callback_configuration konfiguriert.

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

Gibt den Luftdruck in 0,01 mbar Schritten zurück.

Wenn der Wert periodisch benötigt wird, kann auch der AirQualityBricklet::get_air_pressure_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion AirQualityBricklet::set_air_pressure_callback_configuration konfiguriert.

Fortgeschrittene Funktionen

pub fn AirQualityBricklet::remove_calibration(&self) → ConvertingReceiver<()>

Löscht die Kalibrierung auf dem Flash. Nach dem diese Funktion aufgerufen wird muss das Air Quality Bricklet vom Strom getrennt werden.

Beim nächsten starten des Bricklet wird eine komplett neue Kalibrierung gestartet, wie beim allerersten Starten des Bricklets.

Die Kalibrierung basiert auf den Daten der letzten vier Tage, daher dauert es vier Tage bis eine volle Kalibrierung wieder hergestellt ist.

Neu in Version 2.0.3 (Plugin).

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

Das Air Quality Bricklet nutzt eine automatische Hintergrundkalibrierung um den IAQ-Index zu bestimmen. Der Kalibrierungsmechanismus nutzt eine Historie von gemessenen Werte. Die Länge dieser Historie kann zwischen 4 und 28 Tagen konfiguriert werden.

Wenn das Bricklet hauptsächlich am gleichen Ort bleibt und die Umgebung nicht oft verändert wird, empfehlen wir eine Länge von 28 Tagen zu verwenden.

Wenn die Länge geändert wird,wird die aktuelle Kalibrierung verworfen und die Kalibrierung beginnt von vorne. Die Konfiguration der Länge wird im Flash gespeichert, diese Funktion sollte also nur einmal in der Lebenszeit des Bricklets aufgerufen werden müssen.

Eine Änderung der Kalibrierungslänge wird beim nächsten Start des Bricklets übernommen.

Vor Firmware-Version 2.0.3 war die Hintergrundkalibrierungslänge 4 Tage und nicht konfigurierbare.

Der Standardwert (seit Firmware-Version 2.0.3) beträgt 28 Tage.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • AIR_QUALITY_BRICKLET_DURATION_4_DAYS = 0
  • AIR_QUALITY_BRICKLET_DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

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

Gibt die Länge der Hintergrundkalibrierung zurück, wie von AirQualityBricklet::set_background_calibration_duration gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • AIR_QUALITY_BRICKLET_DURATION_4_DAYS = 0
  • AIR_QUALITY_BRICKLET_DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

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

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

pub fn AirQualityBricklet::get_response_expected(&mut self, function_id: u8) → bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels AirQualityBricklet::set_response_expected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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) → ()

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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) → ()

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

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

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

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

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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
  • 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>

Gibt den aktuellen Bootloader-Modus zurück, siehe AirQualityBricklet::set_bootloader_mode.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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<()>

Setzt den Firmware-Pointer für AirQualityBricklet::write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

pub fn AirQualityBricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>

Schreibt 64 Bytes Firmware an die Position die vorher von AirQualityBricklet::set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

pub fn AirQualityBricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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>

Gibt die Konfiguration zurück, wie von AirQualityBricklet::set_status_led_config gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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>

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

pub fn AirQualityBricklet::reset(&self) → ConvertingReceiver<()>

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

pub fn AirQualityBricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

pub fn AirQualityBricklet::read_uid(&self) → ConvertingReceiver<u32>

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

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

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

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

Die Periode in ms ist die Periode mit der der AirQualityBricklet::get_all_values_callback_receiver Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen der Werte.

Der Standardwert ist (0, false).

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

Gibt die Callback-Konfiguration zurück, wie mittels AirQualityBricklet::set_all_values_callback_configuration gesetzt.

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

Die Periode in ms ist die Periode mit der der AirQualityBricklet::get_iaq_index_callback_receiver Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen der Werte.

Der Standardwert ist (0, false).

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

Gibt die Callback-Konfiguration zurück, wie mittels AirQualityBricklet::set_iaq_index_callback_configuration gesetzt.

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

Die Periode in ms ist die Periode mit der der AirQualityBricklet::get_temperature_callback_receiver Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den AirQualityBricklet::get_temperature_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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>

Gibt die Callback-Konfiguration zurück, wie mittels AirQualityBricklet::set_temperature_callback_configuration gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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<()>

Die Periode in ms ist die Periode mit der der AirQualityBricklet::get_humidity_callback_receiver Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den AirQualityBricklet::get_humidity_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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>

Gibt die Callback-Konfiguration zurück, wie mittels AirQualityBricklet::set_humidity_callback_configuration gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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<()>

Die Periode in ms ist die Periode mit der der AirQualityBricklet::get_air_pressure_callback_receiver Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den AirQualityBricklet::get_air_pressure_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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>

Gibt die Callback-Konfiguration zurück, wie mittels AirQualityBricklet::set_air_pressure_callback_configuration gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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 können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

pub fn AirQualityBricklet::get_all_values_callback_receiver(&self) → ConvertingCallbackReceiver<AllValuesEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen All Values-Events.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels AirQualityBricklet::set_all_values_callback_configuration gesetzten Konfiguration

Die Felder der empfangenen Struktur sind der gleiche wie AirQualityBricklet::get_all_values.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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>

Receiver die mit dieser Funktion erstellt werden, empfangen IAQ Index-Events.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels AirQualityBricklet::set_iaq_index_callback_configuration gesetzten Konfiguration

Die Felder der empfangenen Struktur sind die gleichen wie AirQualityBricklet::get_iaq_index.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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>

Receiver die mit dieser Funktion erstellt werden, empfangen Temperature-Events.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels AirQualityBricklet::set_temperature_callback_configuration gesetzten Konfiguration

Der empfangene Variable ist der gleiche wie AirQualityBricklet::get_temperature.

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

Receiver die mit dieser Funktion erstellt werden, empfangen Humidity-Events.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels AirQualityBricklet::set_humidity_callback_configuration gesetzten Konfiguration

Der empfangene Variable ist der gleiche wie AirQualityBricklet::get_humidity.

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

Receiver die mit dieser Funktion erstellt werden, empfangen Air Pressure-Events.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels AirQualityBricklet::set_air_pressure_callback_configuration gesetzten Konfiguration

Der empfangene Variable ist der gleiche wie AirQualityBricklet::get_air_pressure.

Konstanten

AirQualityBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Air Quality Bricklet zu identifizieren.

Die AirQualityBricklet::get_identity Funktion und der IpConnection::get_enumerate_callback_receiver Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

AirQualityBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Air Quality Bricklet dar.