Rust - Rotary Encoder Bricklet

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

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

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

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

    // Get current count without reset.
    let count = re.get_count(false).recv()?;
    println!("Count: {}", count);

    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, rotary_encoder_bricklet::*};

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

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

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

    let count_receiver = re.get_count_callback_receiver();

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

    // Set period for count receiver to 0.05s (50ms).
    // Note: The count callback is only called every 0.05 seconds
    //       if the count has changed since the last call!
    re.set_count_callback_period(50);

    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 RotaryEncoderBricklet::new(uid: &str, ip_connection: &IpConnection) → RotaryEncoderBricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • rotary_encoder – Typ: RotaryEncoderBricklet

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

let rotary_encoder = RotaryEncoderBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn RotaryEncoderBricklet::get_count(&self, reset: bool) → ConvertingReceiver<i32>
Parameter:
  • reset – Typ: bool
Rückgabe:
  • count – Typ: i32, Wertebereich: [-231 bis 231 - 1]

Gibt den aktuellen Zählerwert des Encoders zurück. Wenn reset auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurück gesetzt.

Der Encoder hat 24 Schritte pro Umdrehung.

Wenn der Encoder nach links gedreht wird wird der Zählerwert dekrementiert, d.h. negative Zählerwerte sind möglich.

pub fn RotaryEncoderBricklet::is_pressed(&self) → ConvertingReceiver<bool>
Rückgabe:
  • pressed – Typ: bool

Gibt true zurück wenn der Taster gedrückt ist und sonst false.

Es wird empfohlen die RotaryEncoderBricklet::get_pressed_callback_receiver und RotaryEncoderBricklet::get_released_callback_receiver Callbacks zu nutzen, um den Taster programmatisch zu behandeln.

Fortgeschrittene Funktionen

pub fn RotaryEncoderBricklet::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 RotaryEncoderBricklet::set_count_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 RotaryEncoderBricklet::get_count_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der RotaryEncoderBricklet::get_count_callback_receiver Callback wird nur ausgelöst, wenn sich der Zählerwert seit der letzten Auslösung geändert hat.

pub fn RotaryEncoderBricklet::get_count_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 RotaryEncoderBricklet::set_count_callback_period gesetzt.

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

Setzt den Schwellwert für den RotaryEncoderBricklet::get_count_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • ROTARY_ENCODER_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • ROTARY_ENCODER_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • ROTARY_ENCODER_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • ROTARY_ENCODER_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • ROTARY_ENCODER_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn RotaryEncoderBricklet::get_count_callback_threshold(&self) → ConvertingReceiver<CountCallbackThreshold>
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: i32, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: i32, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von RotaryEncoderBricklet::set_count_callback_threshold gesetzt.

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

Für option:

  • ROTARY_ENCODER_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • ROTARY_ENCODER_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • ROTARY_ENCODER_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • ROTARY_ENCODER_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • ROTARY_ENCODER_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn RotaryEncoderBricklet::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 der Schwellwert-Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

pub fn RotaryEncoderBricklet::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 RotaryEncoderBricklet::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 RotaryEncoderBricklet::get_count_callback_receiver(&self) → ConvertingCallbackReceiver<i32>
Event:
  • count – Typ: i32, Wertebereich: [-231 bis 231 - 1]

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

Dieser Callback wird mit der Periode, wie gesetzt mit RotaryEncoderBricklet::set_count_callback_period, ausgelöst. Der empfangene Variable ist der Zählerwert des Encoders.

Der RotaryEncoderBricklet::get_count_callback_receiver Callback wird nur ausgelöst, wenn sich der Zähler seit der letzten Auslösung geändert hat.

pub fn RotaryEncoderBricklet::get_count_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>
Event:
  • count – Typ: i32, Wertebereich: [-231 bis 231 - 1]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von RotaryEncoderBricklet::set_count_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist der Zählerwert des Encoders.

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

pub fn RotaryEncoderBricklet::get_pressed_callback_receiver(&self) → ConvertingCallbackReceiver<()>

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

Dieser Callback wird ausgelöst, wenn der Taster gedrückt wird.

pub fn RotaryEncoderBricklet::get_released_callback_receiver(&self) → ConvertingCallbackReceiver<()>

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

Dieser Callback wird ausgelöst, wenn der Taster losgelassen wird.

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

  • ROTARY_ENCODER_BRICKLET_FUNCTION_SET_COUNT_CALLBACK_PERIOD = 2
  • ROTARY_ENCODER_BRICKLET_FUNCTION_SET_COUNT_CALLBACK_THRESHOLD = 4
  • ROTARY_ENCODER_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
pub fn RotaryEncoderBricklet::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:

  • ROTARY_ENCODER_BRICKLET_FUNCTION_SET_COUNT_CALLBACK_PERIOD = 2
  • ROTARY_ENCODER_BRICKLET_FUNCTION_SET_COUNT_CALLBACK_THRESHOLD = 4
  • ROTARY_ENCODER_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
pub fn RotaryEncoderBricklet::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 RotaryEncoderBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Rotary Encoder Bricklet zu identifizieren.

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

Diese Konstante stellt den Anzeigenamen eines Rotary Encoder Bricklet dar.