Rust - Joystick Bricklet

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

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

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let j = JoystickBricklet::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
35
36
37
38
39
40
41
42
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, joystick_bricklet::*};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let j = JoystickBricklet::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");
        }
    });

    let released_receiver = j.get_released_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 _released in released_receiver {
            println!("Released");
        }
    });

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

Find Borders

Download (example_find_borders.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
44
45
46
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, joystick_bricklet::*};

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

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

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

    // Get threshold receivers with a debounce time of 0.2 seconds (200ms)
    j.set_debounce_period(200);

    let position_reached_receiver = j.get_position_reached_callback_receiver();

    // Spawn thread to handle received events.
    // This thread ends when the `j`
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for position_reached in position_reached_receiver {
            if position_reached.y == 100 {
                println!("Top");
            } else if position_reached.y == -100 {
                println!("Bottom");
            } else if position_reached.x == 100 {
                println!("Right");
            } else if position_reached.x == -100 {
                println!("Left");
            }
            println!();
        }
    });

    // Configure threshold for position "outside of -99, -99 to 99, 99"
    j.set_position_callback_threshold('o', -99, 99, -99, 99);

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

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

let joystick = JoystickBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn JoystickBricklet::get_position(&self) → ConvertingReceiver<Position>
Rückgabeobjekt:
  • x – Typ: i16, Wertebereich: [-100 bis 100]
  • y – Typ: i16, Wertebereich: [-100 bis 100]

Gibt die Position des Joystick zurück. Die Mittelposition des Joysticks ist x=0, y=0. Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe JoystickBricklet::calibrate).

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

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

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

Es wird empfohlen die JoystickBricklet::get_pressed_callback_receiver und JoystickBricklet::get_released_callback_receiver Callbacks zu nutzen, um die Taste programmatisch zu behandeln.

Fortgeschrittene Funktionen

pub fn JoystickBricklet::get_analog_value(&self) → ConvertingReceiver<AnalogValue>
Rückgabeobjekt:
  • x – Typ: u16, Wertebereich: [0 bis 4095]
  • y – Typ: u16, Wertebereich: [0 bis 4095]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von JoystickBricklet::get_position zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während JoystickBricklet::get_analog_value unverarbeitete Analogwerte zurück gibt. Der einzige Grund JoystickBricklet::get_analog_value zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn die Analogwerte periodisch abgefragt werden sollen, wird empfohlen den JoystickBricklet::get_analog_value_callback_receiver Callback zu nutzen und die Periode mit JoystickBricklet::set_analog_value_callback_period vorzugeben.

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

Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet 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 den EEPROM des Joystick Bricklet gespeichert, somit ist die Kalibrierung nur einmalig notwendig.

pub fn JoystickBricklet::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 '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 JoystickBricklet::set_position_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 JoystickBricklet::get_position_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

The JoystickBricklet::get_position_callback_receiver Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

pub fn JoystickBricklet::get_position_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 JoystickBricklet::set_position_callback_period gesetzt.

pub fn JoystickBricklet::set_analog_value_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 JoystickBricklet::get_analog_value_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der JoystickBricklet::get_analog_value_callback_receiver Callback wird nur ausgelöst, wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

pub fn JoystickBricklet::get_analog_value_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 JoystickBricklet::set_analog_value_callback_period gesetzt.

pub fn JoystickBricklet::set_position_callback_threshold(&self, option: char, min_x: i16, max_x: i16, min_y: i16, max_y: i16) → ConvertingReceiver<()>
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min_x – Typ: i16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_x – Typ: i16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • min_y – Typ: i16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_y – Typ: i16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den JoystickBricklet::get_position_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn JoystickBricklet::get_position_callback_threshold(&self) → ConvertingReceiver<PositionCallbackThreshold>
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min_x – Typ: i16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_x – Typ: i16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • min_y – Typ: i16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_y – Typ: i16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von JoystickBricklet::set_position_callback_threshold gesetzt.

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

Für option:

  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn JoystickBricklet::set_analog_value_callback_threshold(&self, option: char, min_x: u16, max_x: u16, min_y: u16, max_y: u16) → ConvertingReceiver<()>
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min_x – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_x – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_y – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_y – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den JoystickBricklet::get_analog_value_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn JoystickBricklet::get_analog_value_callback_threshold(&self) → ConvertingReceiver<AnalogValueCallbackThreshold>
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min_x – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_x – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_y – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_y – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von JoystickBricklet::set_analog_value_callback_threshold gesetzt.

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

Für option:

  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • JOYSTICK_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn JoystickBricklet::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 die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

pub fn JoystickBricklet::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 JoystickBricklet::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 JoystickBricklet::get_position_callback_receiver(&self) → ConvertingCallbackReceiver<PositionEvent>
Event-Objekt:
  • x – Typ: i16, Wertebereich: [-100 bis 100]
  • y – Typ: i16, Wertebereich: [-100 bis 100]

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

Dieser Callback wird mit der Periode, wie gesetzt mit JoystickBricklet::set_position_callback_period, ausgelöst. Der empfangene Variable ist die Position des Joysticks.

Der JoystickBricklet::get_position_callback_receiver Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

pub fn JoystickBricklet::get_analog_value_callback_receiver(&self) → ConvertingCallbackReceiver<AnalogValueEvent>
Event-Objekt:
  • x – Typ: u16, Wertebereich: [0 bis 4095]
  • y – Typ: u16, Wertebereich: [0 bis 4095]

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

Dieser Callback wird mit der Periode, wie gesetzt mit JoystickBricklet::set_analog_value_callback_period, ausgelöst. Der empfangene Variable sind die Analogwerte des Joysticks.

Der JoystickBricklet::get_analog_value_callback_receiver Callback wird nur ausgelöst, wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

pub fn JoystickBricklet::get_position_reached_callback_receiver(&self) → ConvertingCallbackReceiver<PositionReachedEvent>
Event-Objekt:
  • x – Typ: i16, Wertebereich: [-100 bis 100]
  • y – Typ: i16, Wertebereich: [-100 bis 100]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von JoystickBricklet::set_position_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Position des Joysticks.

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

pub fn JoystickBricklet::get_analog_value_reached_callback_receiver(&self) → ConvertingCallbackReceiver<AnalogValueReachedEvent>
Event-Objekt:
  • x – Typ: u16, Wertebereich: [0 bis 4095]
  • y – Typ: u16, Wertebereich: [0 bis 4095]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von JoystickBricklet::set_analog_value_callback_threshold gesetzt, erreicht wird. Der empfangene Variable sind die Analogwerte des Joystick.

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

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

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

Dieser Callback wird ausgelöst, wenn die Taste gedrückt wird.

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

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

Dieser Callback wird ausgelöst, wenn die Taste 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 JoystickBricklet::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 JoystickBricklet::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 JoystickBricklet::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:

  • JOYSTICK_BRICKLET_FUNCTION_CALIBRATE = 4
  • JOYSTICK_BRICKLET_FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
  • JOYSTICK_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • JOYSTICK_BRICKLET_FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
  • JOYSTICK_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • JOYSTICK_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 13
pub fn JoystickBricklet::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:

  • JOYSTICK_BRICKLET_FUNCTION_CALIBRATE = 4
  • JOYSTICK_BRICKLET_FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
  • JOYSTICK_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • JOYSTICK_BRICKLET_FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
  • JOYSTICK_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • JOYSTICK_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 13
pub fn JoystickBricklet::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 JoystickBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Joystick Bricklet zu identifizieren.

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

Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet dar.