Rust - Dual Button Bricklet¶

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
41
42
43

use std::{error::Error, io, thread};
use tinkerforge::{dual_button_bricklet::*, ip_connection::IpConnection};

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

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

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

    let state_changed_receiver = db.get_state_changed_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `db` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for state_changed in state_changed_receiver {
            if state_changed.button_l == DUAL_BUTTON_BRICKLET_BUTTON_STATE_PRESSED {
                println!("Left Button: Pressed");
            } else if state_changed.button_l == DUAL_BUTTON_BRICKLET_BUTTON_STATE_RELEASED {
                println!("Left Button: Released");
            }

            if state_changed.button_r == DUAL_BUTTON_BRICKLET_BUTTON_STATE_PRESSED {
                println!("Right Button: Pressed");
            } else if state_changed.button_r == DUAL_BUTTON_BRICKLET_BUTTON_STATE_RELEASED {
                println!("Right Button: Released");
            }

            println!();
        }
    });

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

Grundfunktionen¶

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

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	dual_button – Typ: DualButtonBricklet

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

let dual_button = DualButtonBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn DualButtonBricklet::set_led_state(&self, led_l: u8, led_r: u8) → ConvertingReceiver<()>¶

Parameter:	led_l – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1 led_r – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt den Zustand der LEDs. Möglich Zustände sind:

• 0 = AutoToggleOn: Aktiviert Auto-Toggle und anfänglich aktiviert LED
• 1 = AutoToggleOff: Aktiviert Auto-Toggle und anfänglich deaktiviert LED.
• 2 = On: Aktiviert LED (Auto-Toggle is deaktiviert).
• 3 = Off: Deaktiviert LED (Auto-Toggle is deaktiviert).

Im Auto-Toggle Modus wechselt die LED automatisch zwischen aus und an bei jedem Tasterdruck.

Wenn nur eine der LEDs gesetzt werden soll und der aktuelle Zustand der anderen LED nicht bekannt ist, dann kann der Zustand mit DualButtonBricklet::get_led_state ausgelesen werden oder es kann DualButtonBricklet::set_selected_led_state genutzt werden.

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

Für led_l:

• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_ON = 0
• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_OFF = 1
• DUAL_BUTTON_BRICKLET_LED_STATE_ON = 2
• DUAL_BUTTON_BRICKLET_LED_STATE_OFF = 3

Für led_r:

• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_ON = 0
• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_OFF = 1
• DUAL_BUTTON_BRICKLET_LED_STATE_ON = 2
• DUAL_BUTTON_BRICKLET_LED_STATE_OFF = 3

pub fn DualButtonBricklet::get_led_state(&self) → ConvertingReceiver<LedState>¶

Rückgabeobjekt:	led_l – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1 led_r – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt den aktuellen Zustand der LEDs zurück, wie von DualButtonBricklet::set_led_state gesetzt.

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

Für led_l:

• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_ON = 0
• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_OFF = 1
• DUAL_BUTTON_BRICKLET_LED_STATE_ON = 2
• DUAL_BUTTON_BRICKLET_LED_STATE_OFF = 3

Für led_r:

• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_ON = 0
• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_OFF = 1
• DUAL_BUTTON_BRICKLET_LED_STATE_ON = 2
• DUAL_BUTTON_BRICKLET_LED_STATE_OFF = 3

pub fn DualButtonBricklet::get_button_state(&self) → ConvertingReceiver<ButtonState>¶

Rückgabeobjekt:	button_l – Typ: u8, Wertebereich: Siehe Konstanten button_r – Typ: u8, Wertebereich: Siehe Konstanten

Gibt den aktuellen Zustand beider Taster zurück. Mögliche Zustände sind:

• 0 = pressed (gedrückt)
• 1 = released (losgelassen)

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

Für button_l:

• DUAL_BUTTON_BRICKLET_BUTTON_STATE_PRESSED = 0
• DUAL_BUTTON_BRICKLET_BUTTON_STATE_RELEASED = 1

Für button_r:

• DUAL_BUTTON_BRICKLET_BUTTON_STATE_PRESSED = 0
• DUAL_BUTTON_BRICKLET_BUTTON_STATE_RELEASED = 1

Fortgeschrittene Funktionen¶

pub fn DualButtonBricklet::set_selected_led_state(&self, led: u8, state: u8) → ConvertingReceiver<()>¶

Parameter:	led – Typ: u8, Wertebereich: Siehe Konstanten state – Typ: u8, Wertebereich: Siehe Konstanten

Setzt den Zustand der selektierten LED (0 oder 1).

Die andere LED bleibt unangetastet.

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

Für led:

• DUAL_BUTTON_BRICKLET_LED_LEFT = 0
• DUAL_BUTTON_BRICKLET_LED_RIGHT = 1

Für state:

• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_ON = 0
• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_OFF = 1
• DUAL_BUTTON_BRICKLET_LED_STATE_ON = 2
• DUAL_BUTTON_BRICKLET_LED_STATE_OFF = 3

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

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 DualButtonBricklet::get_state_changed_callback_receiver(&self) → ConvertingCallbackReceiver<StateChangedEvent>¶

Event-Objekt:	button_l – Typ: u8, Wertebereich: Siehe Konstanten button_r – Typ: u8, Wertebereich: Siehe Konstanten led_l – Typ: u8, Wertebereich: Siehe Konstanten led_r – Typ: u8, Wertebereich: Siehe Konstanten

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

Dieser Callback wird aufgerufen wenn einer der Taster gedrückt wird.

Mögliche Zustände der Taster sind:

• 0 = pressed (gedrückt)
• 1 = released (losgelassen)

Mögliche Zustände der LEDs sind:

• 0 = AutoToggleOn: Auto-Toggle aktiv und LED an.
• 1 = AutoToggleOff: Auto-Toggle aktiv und LED aus.
• 2 = On: Aktiviert LED (Auto-Toggle ist deaktiviert).
• 3 = Off: Deaktiviert LED (Auto-Toggle ist deaktiviert).

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

Für button_l:

• DUAL_BUTTON_BRICKLET_BUTTON_STATE_PRESSED = 0
• DUAL_BUTTON_BRICKLET_BUTTON_STATE_RELEASED = 1

Für button_r:

• DUAL_BUTTON_BRICKLET_BUTTON_STATE_PRESSED = 0
• DUAL_BUTTON_BRICKLET_BUTTON_STATE_RELEASED = 1

Für led_l:

• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_ON = 0
• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_OFF = 1
• DUAL_BUTTON_BRICKLET_LED_STATE_ON = 2
• DUAL_BUTTON_BRICKLET_LED_STATE_OFF = 3

Für led_r:

• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_ON = 0
• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_OFF = 1
• DUAL_BUTTON_BRICKLET_LED_STATE_ON = 2
• DUAL_BUTTON_BRICKLET_LED_STATE_OFF = 3

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

• DUAL_BUTTON_BRICKLET_FUNCTION_SET_LED_STATE = 1
• DUAL_BUTTON_BRICKLET_FUNCTION_SET_SELECTED_LED_STATE = 5

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

• DUAL_BUTTON_BRICKLET_FUNCTION_SET_LED_STATE = 1
• DUAL_BUTTON_BRICKLET_FUNCTION_SET_SELECTED_LED_STATE = 5

pub fn DualButtonBricklet::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 DualButtonBricklet::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Dual Button Bricklet zu identifizieren.

Die DualButtonBricklet::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 DualButtonBricklet::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Dual Button Bricklet dar.