Rust - Dust Detector Bricklet

Dies ist die Beschreibung der Rust API Bindings für das Dust Detector Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Dust Detector 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::{dust_detector_bricklet::*, ip_connection::IpConnection};

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

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

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

    // Get current dust density.
    let dust_density = dd.get_dust_density().recv()?;
    println!("Dust Density: {} µg/m³", dust_density);

    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::{dust_detector_bricklet::*, ip_connection::IpConnection};

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

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

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

    let dust_density_receiver = dd.get_dust_density_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `dd` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for dust_density in dust_density_receiver {
            println!("Dust Density: {} µg/m³", dust_density);
        }
    });

    // Set period for dust density receiver to 1s (1000ms).
    // Note: The dust density callback is only called every second
    //       if the dust density has changed since the last call!
    dd.set_dust_density_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::{dust_detector_bricklet::*, ip_connection::IpConnection};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let dd = DustDetectorBricklet::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).
    dd.set_debounce_period(10000);

    let dust_density_reached_receiver = dd.get_dust_density_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `dd` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for dust_density_reached in dust_density_reached_receiver {
            println!("Dust Density: {} µg/m³", dust_density_reached);
        }
    });

    // Configure threshold for dust density "greater than 10 µg/m³".
    dd.set_dust_density_callback_threshold('>', 10, 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 DustDetectorBricklet::new(uid: &str, ip_connection: &IpConnection) → DustDetectorBricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • dust_detector – Typ: DustDetectorBricklet

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

let dust_detector = DustDetectorBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn DustDetectorBricklet::get_dust_density(&self) → ConvertingReceiver<u16>
Rückgabe:
  • dust_density – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Gibt die Staubdichte zurück.

Wenn die Staubdichte periodisch abgefragt werden soll, wird empfohlen den DustDetectorBricklet::get_dust_density_callback_receiver Callback zu nutzen und die Periode mit DustDetectorBricklet::set_dust_density_callback_period vorzugeben.

Fortgeschrittene Funktionen

pub fn DustDetectorBricklet::set_moving_average(&self, average: u8) → ConvertingReceiver<()>
Parameter:
  • average – Typ: u8, Wertebereich: [0 bis 100], Standardwert: 100

Setzt die Länge eines gleitenden Mittelwerts für die Staubdichte.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

pub fn DustDetectorBricklet::get_moving_average(&self) → ConvertingReceiver<u8>
Rückgabe:
  • average – Typ: u8, Wertebereich: [0 bis 100], Standardwert: 100

Gibt die Länge des gleitenden Mittelwerts zurück, wie von DustDetectorBricklet::set_moving_average gesetzt.

pub fn DustDetectorBricklet::get_identity(&self) → ConvertingReceiver<Identity>
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connected_uid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardware_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: u16, Wertebereich: [0 bis 216 - 1]

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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 DustDetectorBricklet::set_dust_density_callback_period(&self, period: u32) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der DustDetectorBricklet::get_dust_density_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der DustDetectorBricklet::get_dust_density_callback_receiver Callback wird nur ausgelöst, wenn sich die Staubdichte seit der letzten Auslösung geändert hat.

pub fn DustDetectorBricklet::get_dust_density_callback_period(&self) → ConvertingReceiver<u32>
Rückgabe:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von DustDetectorBricklet::set_dust_density_callback_period gesetzt.

pub fn DustDetectorBricklet::set_dust_density_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den DustDetectorBricklet::get_dust_density_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn DustDetectorBricklet::get_dust_density_callback_threshold(&self) → ConvertingReceiver<DustDensityCallbackThreshold>
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von DustDetectorBricklet::set_dust_density_callback_threshold gesetzt.

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

Für option:

  • DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn DustDetectorBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>
Parameter:
  • debounce – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

pub fn DustDetectorBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>
Rückgabe:
  • debounce – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von DustDetectorBricklet::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 DustDetectorBricklet::get_dust_density_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • dust_density – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

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

Dieser Callback wird mit der Periode, wie gesetzt mit DustDetectorBricklet::set_dust_density_callback_period, ausgelöst. Der empfangene Variable ist die Staubdichte des Sensors.

Der DustDetectorBricklet::get_dust_density_callback_receiver Callback wird nur ausgelöst, wenn sich die Staubdichte seit der letzten Auslösung geändert hat.

pub fn DustDetectorBricklet::get_dust_density_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • dust_density – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Receiver die mit dieser Funktion erstellt werden, empfangen Dust Density Reached-Events.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von DustDetectorBricklet::set_dust_density_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Staubdichte des Sensors.

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

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

pub fn DustDetectorBricklet::get_api_version(&self) → [u8; 3]
Rückgabeobjekt:
  • api_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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 DustDetectorBricklet::get_response_expected(&mut self, function_id: u8) → bool
Parameter:
  • function_id – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: 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 DustDetectorBricklet::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:

Für function_id:

  • DUST_DETECTOR_BRICKLET_FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
  • DUST_DETECTOR_BRICKLET_FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
  • DUST_DETECTOR_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • DUST_DETECTOR_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 10
pub fn DustDetectorBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()
Parameter:
  • function_id – Typ: u8, Wertebereich: Siehe Konstanten
  • response_expected – Typ: 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:

Für function_id:

  • DUST_DETECTOR_BRICKLET_FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
  • DUST_DETECTOR_BRICKLET_FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
  • DUST_DETECTOR_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • DUST_DETECTOR_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 10
pub fn DustDetectorBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()
Parameter:
  • response_expected – Typ: bool

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

Konstanten

pub const DustDetectorBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Dust Detector Bricklet zu identifizieren.

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

pub const DustDetectorBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Dust Detector Bricklet dar.