Rust - CO2 Bricklet

Dies ist die Beschreibung der Rust API Bindings für das CO2 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des CO2 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
use std::{error::Error, io};

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

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

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

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

    // Get current CO2 concentration.
    let co2_concentration = co2.get_co2_concentration().recv()?;
    println!("CO2 Concentration: {} ppm", co2_concentration);

    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
use std::{error::Error, io, thread};
use tinkerforge::{co2_bricklet::*, ip_connection::IpConnection};

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

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

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

    let co2_concentration_receiver = co2.get_co2_concentration_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `co2` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for co2_concentration in co2_concentration_receiver {
            println!("CO2 Concentration: {} ppm", co2_concentration);
        }
    });

    // Set period for CO2 concentration receiver to 1s (1000ms).
    // Note: The CO2 concentration callback is only called every second
    //       if the CO2 concentration has changed since the last call!
    co2.set_co2_concentration_callback_period(1000);

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

Threshold

Download (example_threshold.rs)

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

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

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

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

    // Get threshold receivers with a debounce time of 10 seconds (10000ms).
    co2.set_debounce_period(10000);

    let co2_concentration_reached_receiver = co2.get_co2_concentration_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `co2` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for co2_concentration_reached in co2_concentration_reached_receiver {
            println!("CO2 Concentration: {} ppm", co2_concentration_reached);
        }
    });

    // Configure threshold for CO2 concentration "greater than 750 ppm".
    co2.set_co2_concentration_callback_threshold('>', 750, 0);

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

Erzeugt ein neues Co2Bricklet-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 Co2Bricklet::get_co2_concentration(&self) → ConvertingReceiver<u16>

Gibt die gemessene CO2-Konzentration zurück. Der Wert ist in ppm (Teile pro Million) und im Bereich von 0 bis 10000.

Wenn die CO2-Konzentration periodisch abgefragt werden soll, wird empfohlen den Co2Bricklet::get_co2_concentration_callback_receiver Callback zu nutzen und die Periode mit Co2Bricklet::set_co2_concentration_callback_period vorzugeben.

Fortgeschrittene Funktionen

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

Siehe Co2Bricklet::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

pub fn Co2Bricklet::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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • CO2_BRICKLET_FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2
  • CO2_BRICKLET_FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4
  • CO2_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
pub fn Co2Bricklet::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 Co2Bricklet::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 Co2Bricklet::set_co2_concentration_callback_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der Co2Bricklet::get_co2_concentration_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der Co2Bricklet::get_co2_concentration_callback_receiver Callback wird nur ausgelöst wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn Co2Bricklet::get_co2_concentration_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von Co2Bricklet::set_co2_concentration_callback_period gesetzt.

pub fn Co2Bricklet::set_co2_concentration_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>

Setzt den Schwellwert für den Co2Bricklet::get_co2_concentration_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst wenn die CO2-Konzentration außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst wenn die CO2-Konzentration innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst wenn die CO2-Konzentration kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst wenn die CO2-Konzentration größer als der min Wert ist (max wird ignoriert)

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

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

  • CO2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • CO2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • CO2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • CO2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • CO2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn Co2Bricklet::get_co2_concentration_callback_threshold(&self) → ConvertingReceiver<Co2ConcentrationCallbackThreshold>

Gibt den Schwellwert zurück, wie von Co2Bricklet::set_co2_concentration_callback_threshold gesetzt.

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

  • CO2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • CO2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • CO2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • CO2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • CO2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn Co2Bricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

pub fn Co2Bricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

Gibt die Entprellperiode zurück, wie von Co2Bricklet::set_debounce_period gesetzt.

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 Co2Bricklet::get_co2_concentration_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

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

Dieser Callback wird mit der Periode, wie gesetzt mit Co2Bricklet::set_co2_concentration_callback_period, ausgelöst. Der empfangene Variable ist die gemessene CO2-Konzentration des Sensors.

Der Co2Bricklet::get_co2_concentration_callback_receiver Callback wird nur ausgelöst wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

pub fn Co2Bricklet::get_co2_concentration_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

Receiver die mit dieser Funktion erstellt werden, empfangen CO2 Concentration Reached-Events.

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von Co2Bricklet::set_co2_concentration_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die gemessene CO2-Konzentration.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit Co2Bricklet::set_debounce_period gesetzt, ausgelöst.

Konstanten

Co2Bricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein CO2 Bricklet zu identifizieren.

Die Co2Bricklet::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.

Co2Bricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet dar.