Rust - Moisture Bricklet

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

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

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

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

    // Get current moisture value.
    let moisture = m.get_moisture_value().recv()?;
    println!("Moisture Value: {}", moisture);

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

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

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

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

    let moisture_receiver = m.get_moisture_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `m` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for moisture in moisture_receiver {
            println!("Moisture Value: {}", moisture);
        }
    });

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

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let m = MoistureBricklet::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 1 second (1000ms).
    m.set_debounce_period(1000);

    let moisture_reached_receiver = m.get_moisture_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `m` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for moisture_reached in moisture_reached_receiver {
            println!("Moisture Value: {}", moisture_reached);
        }
    });

    // Configure threshold for moisture value "greater than 200".
    m.set_moisture_callback_threshold('>', 200, 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 MoistureBricklet::new(uid: &str, ip_connection: &IpConnection) → MoistureBricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • moisture – Typ: MoistureBricklet

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

let moisture = MoistureBricklet::new("YOUR_DEVICE_UID", &ip_connection);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden.

pub fn MoistureBricklet::get_moisture_value(&self) → ConvertingReceiver<u16>
Rückgabe:
  • moisture – Typ: u16, Wertebereich: [0 bis 212 - 1]

Gibt den aktuellen Feuchtigkeitswert zurück. Ein kleiner Wert entspricht einer geringen Feuchtigkeit, ein großer Wert entspricht einer hohen Feuchtigkeit.

Wenn der Feuchtigkeitswert periodisch abgefragt werden soll, wird empfohlen den MoistureBricklet::get_moisture_callback_receiver Callback zu nutzen und die Periode mit MoistureBricklet::set_moisture_callback_period vorzugeben.

Fortgeschrittene Funktionen

pub fn MoistureBricklet::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 den Feuchtigkeitswert.

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 MoistureBricklet::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 MoistureBricklet::set_moving_average gesetzt.

pub fn MoistureBricklet::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 MoistureBricklet::set_moisture_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 MoistureBricklet::get_moisture_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der MoistureBricklet::get_moisture_callback_receiver Callback wird nur ausgelöst, wenn sich der Feuchtigkeitswert seit der letzten Auslösung geändert hat.

pub fn MoistureBricklet::get_moisture_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 MoistureBricklet::set_moisture_callback_period gesetzt.

pub fn MoistureBricklet::set_moisture_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den MoistureBricklet::get_moisture_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • MOISTURE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • MOISTURE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • MOISTURE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • MOISTURE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • MOISTURE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn MoistureBricklet::get_moisture_callback_threshold(&self) → ConvertingReceiver<MoistureCallbackThreshold>
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von MoistureBricklet::set_moisture_callback_threshold gesetzt.

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

Für option:

  • MOISTURE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • MOISTURE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • MOISTURE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • MOISTURE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • MOISTURE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn MoistureBricklet::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 MoistureBricklet::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 MoistureBricklet::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 MoistureBricklet::get_moisture_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • moisture – Typ: u16, Wertebereich: [0 bis 212 - 1]

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

Dieser Callback wird mit der Periode, wie gesetzt mit MoistureBricklet::set_moisture_callback_period, ausgelöst. Der empfangene Variable ist der Feuchtigkeitswert des Sensors.

The MoistureBricklet::get_moisture_callback_receiver Callback wird nur ausgelöst, wenn sich der Feuchtigkeitswert seit der letzten Auslösung geändert hat.

pub fn MoistureBricklet::get_moisture_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • moisture – Typ: u16, Wertebereich: [0 bis 212 - 1]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von MoistureBricklet::set_moisture_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Feuchtigkeitswert des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit MoistureBricklet::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 MoistureBricklet::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 MoistureBricklet::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 MoistureBricklet::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:

  • MOISTURE_BRICKLET_FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2
  • MOISTURE_BRICKLET_FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4
  • MOISTURE_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • MOISTURE_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 10
pub fn MoistureBricklet::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:

  • MOISTURE_BRICKLET_FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2
  • MOISTURE_BRICKLET_FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4
  • MOISTURE_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • MOISTURE_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 10
pub fn MoistureBricklet::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 MoistureBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Moisture Bricklet zu identifizieren.

Die MoistureBricklet::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 MoistureBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Moisture Bricklet dar.