Rust - Tilt Bricklet¶

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().recv()?;

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

Grundfunktionen¶

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

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	tilt – Typ: TiltBricklet

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

let tilt = TiltBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn TiltBricklet::get_tilt_state(&self) → ConvertingReceiver<u8>¶

Rückgabe:	state – Typ: u8, Wertebereich: Siehe Konstanten

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).

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

Für state:

• 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_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', '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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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 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>¶

Rückgabe:	enabled – Typ: bool, Standardwert: false

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.

pub fn TiltBricklet::get_tilt_state_callback_receiver(&self) → ConvertingCallbackReceiver<u8>¶

Event:	state – Typ: u8, Wertebereich: Siehe Konstanten

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:

Für state:

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

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

Für function_id:

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

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:

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

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

pub const TiltBricklet::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Tilt Bricklet dar.