Rust - Servo Bricklet 2.0

Dies ist die Beschreibung der Rust API Bindings für das Servo Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Servo 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).

Configuration

Download (example_configuration.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
use std::{error::Error, io};

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

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

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

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

    // Servo 1: Connected to port 0, period of 19.5ms, pulse width of 1 to 2ms
    //          and operating angle -100 to 100°
    s.set_degree(0, -10000, 10000).recv()?;
    s.set_pulse_width(0, 1000, 2000).recv()?;
    s.set_period(0, 19500).recv()?;
    s.set_motion_configuration(0, 500000, 1000, 1000).recv()?; // Full velocity with slow ac-/deceleration

    // Servo 2: Connected to port 5, period of 20ms, pulse width of 0.95 to 1.95ms
    //          and operating angle -90 to 90°
    s.set_degree(5, -9000, 9000).recv()?;
    s.set_pulse_width(5, 950, 1950).recv()?;
    s.set_period(5, 20000).recv()?;
    s.set_motion_configuration(5, 500000, 500000, 500000).recv()?; // Full velocity with full ac-/deceleration

    s.set_position(0, 10000).recv()?; // Set to most right position
    s.set_enable(0, true).recv()?;

    s.set_position(5, -9000).recv()?; // Set to most left position
    s.set_enable(5, true).recv()?;

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

    s.set_enable(0, false).recv()?;
    s.set_enable(5, false).recv()?;

    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
43
44
45
46
47
48
49
50
51
52
53
54
55
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, servo_v2_bricklet::*};

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

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

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

    let position_reached_receiver = s.get_position_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `s` object
    // is dropped, so there is no need for manual cleanup.
    let s_copy = s.clone(); // Device objects don't implement Sync, so they can't be shared 
                            // between threads (by reference). So clone the device and move the copy.
    thread::spawn(move || {
        for position_reached in position_reached_receiver {
            if position_reached.position == 9000 {
                println!("Position: 90°, going to -90°");
                s_copy.set_position(position_reached.servo_channel, -9000);
            } else if position_reached.position == -9000 {
                println!("Position: -90°, going to 90°");
                s_copy.set_position(position_reached.servo_channel, 9000);
            } else {
                // Can only happen if another program sets position
                println!("Error");
            }
        }
    });

    // Enable position reached callback
    s.set_position_reached_callback_configuration(0, true).recv()?;

    // Set velocity to 100°/s. This has to be smaller or equal to the
    // maximum velocity of the servo you are using, otherwise the position
    // reached callback will be called too early
    s.set_motion_configuration(0, 10000, 500000, 500000).recv()?;
    s.set_position(0, 9000).recv()?;
    s.set_enable(0, true).recv()?;

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

    s.set_enable(0, false).recv()?;

    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.

Jede Funktion der Servo Brick API, welche den servo_channel Parameter verwendet, kann einen Servo über die Servo-Kanal (0 bis 9) adressieren. Falls es sich um eine Setter-Funktion handelt können mehrere Servos gleichzeitig mit einer Bitmaske adressiert werden. Um dies zu kennzeichnen muss das höchstwertigste Bit gesetzt werden. Beispiel: 1 adressiert den Servo 1, (1 << 1) | (1 << 5) | (1 << 15) adressiert die Servos 1 und 5. Das ermöglicht es Konfigurationen von verschiedenen Servos mit einem Funktionsaufruf durchzuführen. Es ist sichergestellt das die Änderungen in der selben PWM Periode vorgenommen werden, für alle Servos entsprechend der Bitmaske.

Grundfunktionen

pub fn ServoV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → ServoV2Bricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • servo_v2 – Typ: ServoV2Bricklet

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

let servo_v2 = ServoV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn ServoV2Bricklet::get_status(&self) → ConvertingReceiver<Status>
Rückgabeobjekt:
  • enabled – Typ: [bool; 10]
  • current_position – Typ: [i16; 10], Einheit: 1/100 °, Wertebereich: ?
  • current_velocity – Typ: [i16; 10], Einheit: 1/100 °/s, Wertebereich: [0 bis 500000]
  • current – Typ: [u16; 10], Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]
  • input_voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die Status-Informationen des Servo Bricklet 2.0 zurück.

Der Status umfasst

  • für jeden Kanal die Information ob dieser gerade aktiviert oder deaktiviert ist,
  • für jeden Kanal die aktuelle Position
  • für jeden Kanal die aktuelle Geschwindigkeit,
  • für jeden Kanal den Stromverbrauch und
  • die Eingangsspannung

Hinweis: Die Position und Geschwindigkeit ist eine Momentaufnahme der aktuellen Position und Geschwindigkeit eines sich in Bewegung befindlichen Servos.

pub fn ServoV2Bricklet::set_enable(&self, servo_channel: u16, enable: bool) → ConvertingReceiver<()>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9, 215 bis 33791]
  • enable – Typ: bool, Standardwert: false

Aktiviert einen Servo-Kanal (0 bis 9). Wenn ein Servo aktiviert wird, wird die konfigurierte Position, Geschwindigkeit, Beschleunigung, etc. sofort übernommen.

pub fn ServoV2Bricklet::get_enabled(&self, servo_channel: u16) → ConvertingReceiver<bool>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9]
Rückgabe:
  • enable – Typ: bool, Standardwert: false

Gibt zurück ob ein Servo-Kanal aktiviert ist.

pub fn ServoV2Bricklet::set_position(&self, servo_channel: u16, position: i16) → ConvertingReceiver<()>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9, 215 bis 33791]
  • position – Typ: i16, Einheit: 1/100 °, Wertebereich: ?

Setzt die Position in °/100 für den angegebenen Servo-Kanal.

Der Standardbereich für die Position ist -9000 bis 9000, aber dies kann, entsprechend dem verwendetem Servo, mit ServoV2Bricklet::set_degree definiert werden.

Wenn ein Linearservo oder RC Brushless Motor Controller oder ähnlich mit dem Servo Brick gesteuert werden soll, können Längen oder Geschwindigkeiten mit ServoV2Bricklet::set_degree definiert werden.

pub fn ServoV2Bricklet::get_position(&self, servo_channel: u16) → ConvertingReceiver<i16>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9]
Rückgabe:
  • position – Typ: i16, Einheit: 1/100 °, Wertebereich: ?

Gibt die Position des angegebenen Servo-Kanals zurück, wie von ServoV2Bricklet::set_position gesetzt.

pub fn ServoV2Bricklet::get_current_position(&self, servo_channel: u16) → ConvertingReceiver<i16>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9]
Rückgabe:
  • position – Typ: i16, Einheit: 1/100 °, Wertebereich: ?

Gibt die aktuelle Position des angegebenen Servo-Kanals zurück. Dies kann vom Wert von ServoV2Bricklet::set_position abweichen, wenn der Servo gerade sein Positionsziel anfährt.

pub fn ServoV2Bricklet::get_current_velocity(&self, servo_channel: u16) → ConvertingReceiver<u16>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9]
Rückgabe:
  • velocity – Typ: u16, Einheit: 1/100 °/s, Wertebereich: [0 bis 500000]

Gibt die aktuelle Geschwindigkeit des angegebenen Servo-Kanals zurück. Dies kann von der Geschwindigkeit die per ServoV2Bricklet::set_motion_configuration gesetzt wurde abweichen, wenn der Servo gerade sein Geschwindigkeitsziel anfährt.

pub fn ServoV2Bricklet::set_motion_configuration(&self, servo_channel: u16, velocity: u32, acceleration: u32, deceleration: u32) → ConvertingReceiver<()>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9, 215 bis 33791]
  • velocity – Typ: u32, Einheit: 1/100 °/s, Wertebereich: [0 bis 500000], Standardwert: 100000
  • acceleration – Typ: u32, Einheit: 1/100 °/s², Wertebereich: [0 bis 500000], Standardwert: 50000
  • deceleration – Typ: u32, Einheit: 1/100 °/s², Wertebereich: [0 bis 500000], Standardwert: 50000

Setzt die maximale Geschwindigkeit des angegebenen Servo-Kanals in °/100s sowie die Beschleunigung und Verzögerung in °/100s².

Mit einer Geschwindigkeit von 0 °/100s wird die Position sofort gesetzt (keine Geschwindigkeit).

Mit einer Beschleunigung/Verzögerung von 0 °/100s² wird die Geschwindigkeit sofort gesetzt (keine Beschleunigung/Verzögerung).

pub fn ServoV2Bricklet::get_motion_configuration(&self, servo_channel: u16) → ConvertingReceiver<MotionConfiguration>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9]
Rückgabeobjekt:
  • velocity – Typ: u32, Einheit: 1/100 °/s, Wertebereich: [0 bis 500000], Standardwert: 100000
  • acceleration – Typ: u32, Einheit: 1/100 °/s², Wertebereich: [0 bis 500000], Standardwert: 50000
  • deceleration – Typ: u32, Einheit: 1/100 °/s², Wertebereich: [0 bis 500000], Standardwert: 50000

Gibt die 'Motion Configuration' zurück, wie von ServoV2Bricklet::set_motion_configuration gesetzt.

pub fn ServoV2Bricklet::set_pulse_width(&self, servo_channel: u16, min: u32, max: u32) → ConvertingReceiver<()>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9, 215 bis 33791]
  • min – Typ: u32, Einheit: 1 µs, Wertebereich: [0 bis 232 - 1], Standardwert: 1000
  • max – Typ: u32, Einheit: 1 µs, Wertebereich: [0 bis 232 - 1], Standardwert: 2000

Setzt die minimale und maximale Pulsweite des angegebenen Servo-Kanals in µs.

Normalerweise werden Servos mit einer PWM angesteuert, wobei die Länge des Pulses die Position des Servos steuert. Jeder Servo hat unterschiedliche minimale und maximale Pulsweiten, diese können mit dieser Funktion spezifiziert werden.

Wenn im Datenblatt des Servos die minimale und maximale Pulsweite spezifiziert ist, sollten diese Werte entsprechend gesetzt werden. Sollte der Servo ohne ein Datenblatt vorliegen, müssen die Werte durch Ausprobieren gefunden werden.

Beide Werte haben einen Wertebereich von 1 bis 65535 (unsigned 16-bit integer). Der minimale Wert muss kleiner als der maximale sein.

Die Standardwerte sind 1000µs (1ms) und 2000µs (2ms) für minimale und maximale Pulsweite.

pub fn ServoV2Bricklet::get_pulse_width(&self, servo_channel: u16) → ConvertingReceiver<PulseWidth>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9]
Rückgabeobjekt:
  • min – Typ: u32, Einheit: 1 µs, Wertebereich: [0 bis 232 - 1], Standardwert: 1000
  • max – Typ: u32, Einheit: 1 µs, Wertebereich: [0 bis 232 - 1], Standardwert: 2000

Gibt die minimale und maximale Pulsweite des angegebenen Servo-Kanals zurück, wie von ServoV2Bricklet::set_pulse_width gesetzt.

pub fn ServoV2Bricklet::set_degree(&self, servo_channel: u16, min: i16, max: i16) → ConvertingReceiver<()>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9, 215 bis 33791]
  • min – Typ: i16, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: -9000
  • max – Typ: i16, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 9000

Setzt den minimalen und maximalen Winkel des angegebenen Servo-Kanals (standardmäßig in °/100).

Dies definiert die abstrakten Werte zwischen welchen die minimale und maximale Pulsweite skaliert wird. Beispiel: Wenn eine Pulsweite von 1000µs bis 2000µs und ein Winkelbereich von -90° bis 90° spezifiziert ist, wird ein Aufruf von ServoV2Bricklet::set_position mit 0 in einer Pulsweite von 1500µs resultieren (-90° = 1000µs, 90° = 2000µs, etc.).

Anwendungsfälle:

  • Das Datenblatt des Servos spezifiziert einen Bereich von 200° mit einer Mittelposition bei 110°. In diesem Fall kann das Minimum auf -9000 und das Maximum auf 11000 gesetzt werden.
  • Es wird ein Bereich von 220° am Servo gemessen und eine Mittelposition ist nicht bekannt bzw. wird nicht benötigt. In diesem Fall kann das Minimum auf 0 und das Maximum auf 22000 gesetzt werden.
  • Ein Linearservo mit einer Antriebslänge von 20cm. In diesem Fall kann das Minimum auf 0 und das Maximum auf 20000 gesetzt werden. Jetzt kann die Position mittels ServoV2Bricklet::set_position mit einer Auflösung von cm/100 gesetzt werden. Auch die Geschwindigkeit hat eine Auflösung von cm/100s und die Beschleunigung von cm/100s².
  • Die Einheit ist irrelevant und eine möglichst hohe Auflösung ist gewünscht. In diesem Fall kann das Minimum auf -32767 und das Maximum auf 32767 gesetzt werden.
  • Ein Brushless Motor, mit einer maximalen Drehzahl von 1000 U/min, soll mit einem RC Brushless Motor Controller gesteuert werden. In diesem Fall kann das Minimum auf 0 und das Maximum auf 10000 gesetzt werden. ServoV2Bricklet::set_position steuert jetzt die Drehzahl in U/min.

Beide Werte haben einen Wertebereich von -32767 bis 32767 (signed 16-bit integer). Der minimale Wert muss kleiner als der maximale sein.

Die Standardwerte sind -9000 und 9000 für den minimalen und maximalen Winkel.

pub fn ServoV2Bricklet::get_degree(&self, servo_channel: u16) → ConvertingReceiver<Degree>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9]
Rückgabeobjekt:
  • min – Typ: i16, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: -9000
  • max – Typ: i16, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 9000

Gibt den minimalen und maximalen Winkel für den angegebenen Servo-Kanals zurück, wie von ServoV2Bricklet::set_degree gesetzt.

pub fn ServoV2Bricklet::set_period(&self, servo_channel: u16, period: u32) → ConvertingReceiver<()>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9, 215 bis 33791]
  • period – Typ: u32, Einheit: 1 µs, Wertebereich: [1 bis 1000000], Standardwert: 19500

Setzt die Periode des angegebenen Servo-Kanals in µs.

Normalerweise werden Servos mit einer PWM angesteuert. Unterschiedliche Servos erwarten PWMs mit unterschiedlichen Perioden. Die meisten Servos werden mit einer Periode von 20ms betrieben.

Wenn im Datenblatt des Servos die Periode spezifiziert ist, sollte dieser Wert entsprechend gesetzt werden. Sollte der Servo ohne ein Datenblatt vorliegen und die korrekte Periode unbekannt sein, wird der Standardwert (19,5ms) meinst funktionieren.

Die minimal mögliche Periode ist 1µs und die maximale 1000000µs.

Der Standardwert ist 19,5ms (19500µs).

pub fn ServoV2Bricklet::get_period(&self, servo_channel: u16) → ConvertingReceiver<u32>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9]
Rückgabe:
  • period – Typ: u32, Einheit: 1 µs, Wertebereich: [1 bis 1000000], Standardwert: 19500

Gibt die Periode für den angegebenen Servo-Kanal zurück, wie von ServoV2Bricklet::set_period gesetzt.

pub fn ServoV2Bricklet::get_servo_current(&self, servo_channel: u16) → ConvertingReceiver<u16>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9]
Rückgabe:
  • current – Typ: u16, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt den Stromverbrauch des angegebenen Servo-Kanals in mA zurück.

pub fn ServoV2Bricklet::set_servo_current_configuration(&self, servo_channel: u16, averaging_duration: u8) → ConvertingReceiver<()>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9, 215 bis 33791]
  • averaging_duration – Typ: u8, Einheit: 1 ms, Wertebereich: [1 bis 255], Standardwert: 255

Setzt die Durchschnittsberechnungsdauer der Strommessung des angegebenen Servo-Kanals in ms.

pub fn ServoV2Bricklet::get_servo_current_configuration(&self, servo_channel: u16) → ConvertingReceiver<u8>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9]
Rückgabe:
  • averaging_duration – Typ: u8, Einheit: 1 ms, Wertebereich: [1 bis 255], Standardwert: 255

Gibt die Servo-Stromverbrauchskonfiguration für den angegebenen Servo-Kanal zurück, wie von ServoV2Bricklet::set_servo_current_configuration gesetzt.

pub fn ServoV2Bricklet::set_input_voltage_configuration(&self, averaging_duration: u8) → ConvertingReceiver<()>
Parameter:
  • averaging_duration – Typ: u8, Einheit: 1 ms, Wertebereich: [1 bis 255], Standardwert: 255

Setzt die Durchschnittsberechnungsdauer der Eingangsspannungsmessung des angegebenen Servo-Kanals in ms.

pub fn ServoV2Bricklet::get_input_voltage_configuration(&self) → ConvertingReceiver<u8>
Rückgabe:
  • averaging_duration – Typ: u8, Einheit: 1 ms, Wertebereich: [1 bis 255], Standardwert: 255

Gibt die Servo-Eingangsspannungskonfiguration zurück, wie von ServoV2Bricklet::set_input_voltage_configuration gesetzt.

pub fn ServoV2Bricklet::get_overall_current(&self) → ConvertingReceiver<u16>
Rückgabe:
  • current – Typ: u16, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt den Stromverbrauch aller Servos zusammen in mA zurück.

pub fn ServoV2Bricklet::get_input_voltage(&self) → ConvertingReceiver<u16>
Rückgabe:
  • voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die externe Eingangsspannung (in mV) zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den Servo Brick, eingespeist.

Fortgeschrittene Funktionen

pub fn ServoV2Bricklet::set_current_calibration(&self, offset: [i16; 10]) → ConvertingReceiver<()>
Parameter:
  • offset – Typ: [i16; 10], Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1]

Setzt einen Offset-Wert (in mA) für jeden Kanal.

Hinweis: Im Auslieferungszustand ist das Servo Bricklet 2.0 bereits kalibriert.

pub fn ServoV2Bricklet::get_current_calibration(&self) → ConvertingReceiver<[i16; 10]>
Rückgabe:
  • offset – Typ: [i16; 10], Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1]

Gibt die Stromkalibrierung zurück, wie von ServoV2Bricklet::set_current_calibration.

pub fn ServoV2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>
Rückgabeobjekt:
  • error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: u32, Wertebereich: [0 bis 232 - 1]

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 ServoV2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>
Parameter:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

Für config:

  • SERVO_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • SERVO_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • SERVO_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • SERVO_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn ServoV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • SERVO_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • SERVO_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • SERVO_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • SERVO_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn ServoV2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>
Rückgabe:
  • temperature – Typ: i16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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 ServoV2Bricklet::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 ServoV2Bricklet::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 ServoV2Bricklet::set_position_reached_callback_configuration(&self, servo_channel: u16, enabled: bool) → ConvertingReceiver<()>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9, 215 bis 33791]
  • enabled – Typ: bool, Standardwert: false

Aktiviert/Deaktiviert ServoV2Bricklet::get_position_reached_callback_receiver Callback.

pub fn ServoV2Bricklet::get_position_reached_callback_configuration(&self, servo_channel: u16) → ConvertingReceiver<bool>
Parameter:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9]
Rückgabe:
  • enabled – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels ServoV2Bricklet::set_position_reached_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 ServoV2Bricklet::get_position_reached_callback_receiver(&self) → ConvertingCallbackReceiver<PositionReachedEvent>
Event-Objekt:
  • servo_channel – Typ: u16, Wertebereich: [0 bis 9]
  • position – Typ: i16, Einheit: 1/100 °, Wertebereich: ?

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

Dieser Callback wird ausgelöst, wenn eine konfigurierte Position, wie von ServoV2Bricklet::set_position gesetzt, erreicht wird. Falls die neue Position der aktuellen Position entspricht, wird der Callback nicht ausgelöst, weil sich der Servo nicht bewegt hat. Die Felder der empfangenen Struktur sind der Servo und die Position die erreicht wurde.

Dieser Callback kann mit ServoV2Bricklet::set_position_reached_callback_configuration aktiviert werden.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Servo zu erhalten, funktioniert dies nur wenn die konfigurierte Geschwindigkeit (siehe ServoV2Bricklet::set_motion_configuration) kleiner oder gleich der maximalen Geschwindigkeit des Motors ist. Andernfalls wird der Motor hinter dem Vorgabewert zurückbleiben und der Callback wird zu früh ausgelöst.

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

  • SERVO_V2_BRICKLET_FUNCTION_SET_ENABLE = 2
  • SERVO_V2_BRICKLET_FUNCTION_SET_POSITION = 4
  • SERVO_V2_BRICKLET_FUNCTION_SET_MOTION_CONFIGURATION = 8
  • SERVO_V2_BRICKLET_FUNCTION_SET_PULSE_WIDTH = 10
  • SERVO_V2_BRICKLET_FUNCTION_SET_DEGREE = 12
  • SERVO_V2_BRICKLET_FUNCTION_SET_PERIOD = 14
  • SERVO_V2_BRICKLET_FUNCTION_SET_SERVO_CURRENT_CONFIGURATION = 17
  • SERVO_V2_BRICKLET_FUNCTION_SET_INPUT_VOLTAGE_CONFIGURATION = 19
  • SERVO_V2_BRICKLET_FUNCTION_SET_CURRENT_CALIBRATION = 23
  • SERVO_V2_BRICKLET_FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION = 25
  • SERVO_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • SERVO_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • SERVO_V2_BRICKLET_FUNCTION_RESET = 243
  • SERVO_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn ServoV2Bricklet::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:

  • SERVO_V2_BRICKLET_FUNCTION_SET_ENABLE = 2
  • SERVO_V2_BRICKLET_FUNCTION_SET_POSITION = 4
  • SERVO_V2_BRICKLET_FUNCTION_SET_MOTION_CONFIGURATION = 8
  • SERVO_V2_BRICKLET_FUNCTION_SET_PULSE_WIDTH = 10
  • SERVO_V2_BRICKLET_FUNCTION_SET_DEGREE = 12
  • SERVO_V2_BRICKLET_FUNCTION_SET_PERIOD = 14
  • SERVO_V2_BRICKLET_FUNCTION_SET_SERVO_CURRENT_CONFIGURATION = 17
  • SERVO_V2_BRICKLET_FUNCTION_SET_INPUT_VOLTAGE_CONFIGURATION = 19
  • SERVO_V2_BRICKLET_FUNCTION_SET_CURRENT_CALIBRATION = 23
  • SERVO_V2_BRICKLET_FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION = 25
  • SERVO_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • SERVO_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • SERVO_V2_BRICKLET_FUNCTION_RESET = 243
  • SERVO_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn ServoV2Bricklet::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.

Interne Funktionen

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

pub fn ServoV2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>
Parameter:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: u8, Wertebereich: Siehe Konstanten

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

Für mode:

  • SERVO_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • SERVO_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • SERVO_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • SERVO_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • SERVO_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • SERVO_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • SERVO_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • SERVO_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • SERVO_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • SERVO_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • SERVO_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn ServoV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • SERVO_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • SERVO_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • SERVO_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • SERVO_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • SERVO_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn ServoV2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>
Parameter:
  • pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für ServoV2Bricklet::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 ServoV2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>
Parameter:
  • data – Typ: [u8; 64], Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: u8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von ServoV2Bricklet::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 ServoV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>
Parameter:
  • uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

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 ServoV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>
Rückgabe:
  • uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

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

Konstanten

pub const ServoV2Bricklet::DEVICE_IDENTIFIER

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

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

Diese Konstante stellt den Anzeigenamen eines Servo Bricklet 2.0 dar.