Rust - Joystick Bricklet 2.0

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

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

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

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

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

    // Get current position.
    let position = j.get_position().recv()?;

    println!("Position [X]: {}", position.x);
    println!("Position [Y]: {}", position.y);

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

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

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

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

    let pressed_receiver = j.get_pressed_callback_receiver();

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

    // Set period for pressed callback to 0.01s (10ms).
    j.set_pressed_callback_configuration(10, true);

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

Erzeugt ein neues JoystickV2Bricklet-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 JoystickV2Bricklet::get_position(&self) → ConvertingReceiver<Position>

Gibt die Position des Joystick zurück. Der Wertebereich ist von -100 bis 100 für beide Achsen. Die Mittelposition des Joysticks ist x=0, y=0. Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe JoystickV2Bricklet::calibrate).

Wenn die Position periodisch abgefragt werden sollen, wird empfohlen den JoystickV2Bricklet::get_position_callback_receiver Callback zu nutzen und die Periode mit JoystickV2Bricklet::set_position_callback_configuration vorzugeben.

pub fn JoystickV2Bricklet::is_pressed(&self) → ConvertingReceiver<bool>

Gibt true zurück wenn die Taste gedrückt ist und sonst false.

Wenn der Tastendruck periodisch abgefragt werden sollen, wird empfohlen den JoystickV2Bricklet::get_pressed_callback_receiver Callback zu nutzen und die Periode mit JoystickV2Bricklet::set_pressed_callback_configuration vorzugeben.

Fortgeschrittene Funktionen

pub fn JoystickV2Bricklet::calibrate(&self) → ConvertingReceiver<()>

Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet 2.0 nicht x=0 und y=0 in der Mittelposition zurückgeben, kann diese Funktion aufgerufen werden wenn der Joystick sich unbewegt in der Mittelposition befindet.

Die resultierende Kalibrierung wird in nicht-flüchtigen Speicher gespeichert, somit ist die Kalibrierung nur einmalig notwendig.

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

Siehe JoystickV2Bricklet::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

pub fn JoystickV2Bricklet::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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • JOYSTICK_V2_BRICKLET_FUNCTION_CALIBRATE = 3
  • JOYSTICK_V2_BRICKLET_FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION = 4
  • JOYSTICK_V2_BRICKLET_FUNCTION_SET_PRESSED_CALLBACK_CONFIGURATION = 7
  • JOYSTICK_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • JOYSTICK_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • JOYSTICK_V2_BRICKLET_FUNCTION_RESET = 243
  • JOYSTICK_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn JoystickV2Bricklet::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 JoystickV2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

pub fn JoystickV2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • JOYSTICK_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn JoystickV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>

Gibt den aktuellen Bootloader-Modus zurück, siehe JoystickV2Bricklet::set_bootloader_mode.

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

  • JOYSTICK_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • JOYSTICK_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn JoystickV2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>

Setzt den Firmware-Pointer für JoystickV2Bricklet::write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

pub fn JoystickV2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>

Schreibt 64 Bytes Firmware an die Position die vorher von JoystickV2Bricklet::set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

pub fn JoystickV2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • JOYSTICK_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • JOYSTICK_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • JOYSTICK_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • JOYSTICK_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn JoystickV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>

Gibt die Konfiguration zurück, wie von JoystickV2Bricklet::set_status_led_config gesetzt.

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

  • JOYSTICK_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • JOYSTICK_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • JOYSTICK_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • JOYSTICK_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn JoystickV2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

pub fn JoystickV2Bricklet::reset(&self) → ConvertingReceiver<()>

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

pub fn JoystickV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

pub fn JoystickV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

pub fn JoystickV2Bricklet::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 JoystickV2Bricklet::set_position_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>

Die Periode in ms ist die Periode mit der der JoystickV2Bricklet::get_position_callback_receiver Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf true gesetzt wird, wird der Callback nur ausgelöst, wenn sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein Wert sich das nächste mal ändert.

Wird der Parameter auf false gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen der Werte.

Der Standardwert ist (0, false).

pub fn JoystickV2Bricklet::get_position_callback_configuration(&self) → ConvertingReceiver<PositionCallbackConfiguration>

Gibt die Callback-Konfiguration zurück, wie mittels JoystickV2Bricklet::set_position_callback_configuration gesetzt.

pub fn JoystickV2Bricklet::set_pressed_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>

Die Periode in ms ist die Periode mit der der JoystickV2Bricklet::get_pressed_callback_receiver Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf true gesetzt wird, wird der Callback nur ausgelöst, wenn sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein Wert sich das nächste mal ändert.

Wird der Parameter auf false gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen der Werte.

Der Standardwert ist (0, false).

pub fn JoystickV2Bricklet::get_pressed_callback_configuration(&self) → ConvertingReceiver<PressedCallbackConfiguration>

Gibt die Callback-Konfiguration zurück, wie mittels JoystickV2Bricklet::set_pressed_callback_configuration 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 JoystickV2Bricklet::get_position_callback_receiver(&self) → ConvertingCallbackReceiver<PositionEvent>

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels JoystickV2Bricklet::set_position_callback_configuration gesetzten Konfiguration

Die Felder der empfangenen Struktur sind die gleichen wie bei JoystickV2Bricklet::get_position.

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

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels JoystickV2Bricklet::set_pressed_callback_configuration gesetzten Konfiguration

Der Felder der empfangenen Struktur ist der gleiche wie bei JoystickV2Bricklet::is_pressed.

Konstanten

JoystickV2Bricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Joystick Bricklet 2.0 zu identifizieren.

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

JoystickV2Bricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet 2.0 dar.