Rust - Tilt Bricklet

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

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

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

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

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

    // Get current tilt state.
    let state = t.get_tilt_state().recv()?;

    if state == TILT_BRICKLET_TILT_STATE_CLOSED {
        println!("Tilt State: Closed");
    } else if state == TILT_BRICKLET_TILT_STATE_OPEN {
        println!("Tilt State: Open");
    } else if state == TILT_BRICKLET_TILT_STATE_CLOSED_VIBRATING {
        println!("Tilt State: Closed Vibrating");
    }

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

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

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

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

    // Enable tilt state callback
    t.enable_tilt_state_callback();

    let tilt_state_receiver = t.get_tilt_state_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `t` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for tilt_state in tilt_state_receiver {
            if tilt_state == TILT_BRICKLET_TILT_STATE_CLOSED {
                println!("Tilt State: Closed");
            } else if tilt_state == TILT_BRICKLET_TILT_STATE_OPEN {
                println!("Tilt State: Open");
            } else if tilt_state == TILT_BRICKLET_TILT_STATE_CLOSED_VIBRATING {
                println!("Tilt State: Closed Vibrating");
            }
        }
    });

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

Erzeugt ein neues TiltBricklet-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 TiltBricklet::get_tilt_state(&self) → ConvertingReceiver<u8>

Gibt den aktuellen Tilt-Zustand zurück. Der Zustand kann folgende Werte annehmen:

  • 0 = Closed: Der Ball im Neigungsschalter schließt den Stromkreis.
  • 1 = Open: Der Ball im Neigungsschalter schließt den Stromkreis nicht.
  • 2 = Closed Vibrating: Der Neigungsschalter ist in Bewegung (schnelle Änderungen zwischen open und close).
Tilt-Zustände

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

  • TILT_BRICKLET_TILT_STATE_CLOSED = 0
  • TILT_BRICKLET_TILT_STATE_OPEN = 1
  • TILT_BRICKLET_TILT_STATE_CLOSED_VIBRATING = 2

Fortgeschrittene Funktionen

pub fn TiltBricklet::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 TiltBricklet::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 TiltBricklet::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:

  • TILT_BRICKLET_FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
  • TILT_BRICKLET_FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3
pub fn TiltBricklet::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:

  • TILT_BRICKLET_FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
  • TILT_BRICKLET_FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3
pub fn TiltBricklet::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 TiltBricklet::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 TiltBricklet::enable_tilt_state_callback(&self) → ConvertingReceiver<()>

Aktiviert den TiltBricklet::get_tilt_state_callback_receiver Callback.

pub fn TiltBricklet::disable_tilt_state_callback(&self) → ConvertingReceiver<()>

Deaktiviert den TiltBricklet::get_tilt_state_callback_receiver Callback.

pub fn TiltBricklet::is_tilt_state_callback_enabled(&self) → ConvertingReceiver<bool>

Gibt true zurück wenn der TiltBricklet::get_tilt_state_callback_receiver Callback aktiviert ist.

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 TiltBricklet::get_tilt_state_callback_receiver(&self) → ConvertingCallbackReceiver<u8>

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

Dieser Callback übergibt den aktuellen Tilt-Status. Der Callback wird aufgerufen wenn sich der Status ändert.

Siehe TiltBricklet::get_tilt_state für eine Beschreibung der Zustände.

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

  • TILT_BRICKLET_TILT_STATE_CLOSED = 0
  • TILT_BRICKLET_TILT_STATE_OPEN = 1
  • TILT_BRICKLET_TILT_STATE_CLOSED_VIBRATING = 2

Konstanten

TiltBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Tilt Bricklet zu identifizieren.

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

TiltBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Tilt Bricklet dar.