Rust - Servo Brick

Dies ist die Beschreibung der Rust API Bindings für den Servo Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Servo Brick 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
46
47
48
49
use std::{error::Error, io};

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

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

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

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

    // Configure two servos with voltage 5.5V
    // Servo 1: Connected to port 0, period of 19.5ms, pulse width of 1 to 2ms
    //          and operating angle -100 to 100°
    //
    // Servo 2: Connected to port 5, period of 20ms, pulse width of 0.95
    //          to 1.95ms and operating angle -90 to 90°
    servo.set_output_voltage(5500);

    servo.set_degree(0, -10000, 10000);
    servo.set_pulse_width(0, 1000, 2000);
    servo.set_period(0, 19500);
    servo.set_acceleration(0, 1000); // Slow acceleration
    servo.set_velocity(0, 65535); // Full speed

    servo.set_degree(5, -9000, 9000);
    servo.set_pulse_width(5, 950, 1950);
    servo.set_period(5, 20000);
    servo.set_acceleration(5, 65535); // Full acceleration
    servo.set_velocity(5, 65535); // Full speed

    servo.set_position(0, 10000); // Set to most right position
    servo.enable(0);

    servo.set_position(5, -9000); // Set to most left position
    servo.enable(5);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    servo.disable(0);
    servo.disable(5);
    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
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, servo_brick::*};

const HOST: &str = "127.0.0.1";
const PORT: u16 = 4223;
const UID: &str = "XXYYZZ"; // Change XXYYZZ to the UID of your Servo Brick

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

    // Spawn thread to handle received callback messages. This thread ends when the servo
    // is dropped, so there is no need for manual cleanup.
    let servo_copy = servo.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°");
                servo_copy.set_position(position_reached.servo_num, -9000);
            } else if position_reached.position == -9000 {
                println!("Position: -90°, going to 90°");
                servo_copy.set_position(position_reached.servo_num, 9000);
            } else {
                // Can only happen if another program sets position
                println!("Error");
            }
        }
    });

    // Enable position reached callback
    servo.enable_position_reached_callback();

    // 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
    servo.set_velocity(0, 10000);
    servo.set_position(0, 9000);
    servo.enable(0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    servo.disable(0);
    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_num Parameter verwendet, kann einen Servo über die Servo Nummer (0 bis 6) 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 << 7) adressiert die Servos 1 und 5, 0xFF adressiert alle 7 Servos, und so weiter. 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 ServoBrick::new(uid: &str, ip_connection: &IpConnection) → ServoBrick

Erzeugt ein neues ServoBrick-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 ServoBrick::enable(&self, servo_num: u8) → ConvertingReceiver<()>

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

pub fn ServoBrick::disable(&self, servo_num: u8) → ConvertingReceiver<()>

Deaktiviert einen Servo (0 bis 6). Deaktivierte Servos werden nicht angesteuert, z.B. halten deaktivierte Servos nicht ihre Position wenn eine Last angebracht ist.

pub fn ServoBrick::is_enabled(&self, servo_num: u8) → ConvertingReceiver<bool>

Gibt zurück ob ein Servo aktiviert ist.

pub fn ServoBrick::set_position(&self, servo_num: u8, position: i16) → ConvertingReceiver<()>

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

Der Standardbereich für die Position ist -9000 bis 9000, aber dies kann, entsprechend dem verwendetem Servo, mit ServoBrick::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 ServoBrick::set_degree definiert werden.

pub fn ServoBrick::get_position(&self, servo_num: u8) → ConvertingReceiver<i16>

Gibt die Position des angegebenen Servos zurück, wie von ServoBrick::set_position gesetzt.

pub fn ServoBrick::get_current_position(&self, servo_num: u8) → ConvertingReceiver<i16>

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

pub fn ServoBrick::set_velocity(&self, servo_num: u8, velocity: u16) → ConvertingReceiver<()>

Setzt die maximale Geschwindigkeit des angegebenen Servos in °/100s. Die Geschwindigkeit wird entsprechend mit dem Wert, wie von ServoBrick::set_acceleration gesetzt, beschleunigt.

Die minimale Geschwindigkeit ist 0 (keine Bewegung) und die maximale ist 65535. Mit einem Wert von 65535 wird die Position sofort gesetzt (keine Geschwindigkeit).

Der Standardwert ist 65535.

pub fn ServoBrick::get_velocity(&self, servo_num: u8) → ConvertingReceiver<u16>

Gibt die Geschwindigkeit des angegebenen Servos zurück, wie von ServoBrick::set_velocity gesetzt.

pub fn ServoBrick::get_current_velocity(&self, servo_num: u8) → ConvertingReceiver<u16>

Gibt die aktuelle Geschwindigkeit des angegebenen Servos zurück. Dies kann vom Wert von ServoBrick::set_velocity abweichen, wenn der Servo gerade sein Geschwindigkeitsziel anfährt.

pub fn ServoBrick::set_acceleration(&self, servo_num: u8, acceleration: u16) → ConvertingReceiver<()>

Setzt die Beschleunigung des angegebenen Servos in °/100s².

Die minimale Beschleunigung ist 1 und die maximale 65535. Mit einem Wert von 65535 wird die Geschwindigkeit sofort gesetzt (keine Beschleunigung).

Der Standardwert ist 65535.

pub fn ServoBrick::get_acceleration(&self, servo_num: u8) → ConvertingReceiver<u16>

Gibt die Beschleunigung des angegebenen Servos zurück, wie von ServoBrick::set_acceleration gesetzt.

pub fn ServoBrick::set_output_voltage(&self, voltage: u16) → ConvertingReceiver<()>

Setzt die Ausgangsspannung mit welchem der Servo angetrieben wird in mV. Die minimale Ausgangsspannung ist 2000mV und die maximale 9000mV.

Bemerkung

Es wird empfohlen diesen Wert auf die maximale Spannung laut Spezifikation des Servos zu setzten. Die meisten Servos erreichen ihre maximale Kraft nur mit hohen Spannungen

Der Standardwert ist 5000.

pub fn ServoBrick::get_output_voltage(&self) → ConvertingReceiver<u16>

Gibt die Ausgangsspannung zurück, wie von ServoBrick::set_output_voltage gesetzt.

pub fn ServoBrick::set_pulse_width(&self, servo_num: u8, min: u16, max: u16) → ConvertingReceiver<()>

Setzt die minimale und maximale Pulsweite des angegebenen Servos 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 ServoBrick::get_pulse_width(&self, servo_num: u8) → ConvertingReceiver<PulseWidth>

Gibt die minimale und maximale Pulsweite des angegebenen Servos zurück, wie von ServoBrick::set_pulse_width gesetzt.

pub fn ServoBrick::set_degree(&self, servo_num: u8, min: i16, max: i16) → ConvertingReceiver<()>

Setzt den minimalen und maximalen Winkel des angegebenen Servos (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 ServoBrick::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 ServoBrick::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. ServoBrick::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 ServoBrick::get_degree(&self, servo_num: u8) → ConvertingReceiver<Degree>

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

pub fn ServoBrick::set_period(&self, servo_num: u8, period: u16) → ConvertingReceiver<()>

Setzt die Periode des angegebenen Servos 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 65535µs.

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

pub fn ServoBrick::get_period(&self, servo_num: u8) → ConvertingReceiver<u16>

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

pub fn ServoBrick::get_servo_current(&self, servo_num: u8) → ConvertingReceiver<u16>

Gibt den Stromverbrauch des angegebenen Servos in mA zurück.

pub fn ServoBrick::get_overall_current(&self) → ConvertingReceiver<u16>

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

pub fn ServoBrick::get_stack_input_voltage(&self) → ConvertingReceiver<u16>

Gibt die Eingangsspannung des Stapels in mV zurück. Die Eingangsspannung des Stapels wird über diesen verteilt, z.B. mittels einer Step-Down oder Step-Up Power Supply.

pub fn ServoBrick::get_external_input_voltage(&self) → ConvertingReceiver<u16>

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

Sobald eine externe Eingangsspannung und die Spannungsversorgung des Stapels anliegt, werden die Motoren über die externe Spannung versorgt. Sollte nur die Spannungsversorgung des Stapels verfügbar sein, erfolgt die Versorgung der Motoren über diese.

Warnung

Das bedeutet, bei einer hohen Versorgungsspannung des Stapels und einer geringen externen Versorgungsspannung erfolgt die Spannungsversorgung der Motoren über die geringere externe Versorgungsspannung. Wenn dann die externe Spannungsversorgung getrennt wird, erfolgt sofort die Versorgung der Motoren über die höhere Versorgungsspannung des Stapels.

Fortgeschrittene Funktionen

pub fn ServoBrick::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 ServoBrick::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 ServoBrick::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 ServoBrick::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

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

  • SERVO_BRICK_FUNCTION_ENABLE = 1
  • SERVO_BRICK_FUNCTION_DISABLE = 2
  • SERVO_BRICK_FUNCTION_SET_POSITION = 4
  • SERVO_BRICK_FUNCTION_SET_VELOCITY = 7
  • SERVO_BRICK_FUNCTION_SET_ACCELERATION = 10
  • SERVO_BRICK_FUNCTION_SET_OUTPUT_VOLTAGE = 12
  • SERVO_BRICK_FUNCTION_SET_PULSE_WIDTH = 14
  • SERVO_BRICK_FUNCTION_SET_DEGREE = 16
  • SERVO_BRICK_FUNCTION_SET_PERIOD = 18
  • SERVO_BRICK_FUNCTION_SET_MINIMUM_VOLTAGE = 24
  • SERVO_BRICK_FUNCTION_ENABLE_POSITION_REACHED_CALLBACK = 29
  • SERVO_BRICK_FUNCTION_DISABLE_POSITION_REACHED_CALLBACK = 30
  • SERVO_BRICK_FUNCTION_ENABLE_VELOCITY_REACHED_CALLBACK = 32
  • SERVO_BRICK_FUNCTION_DISABLE_VELOCITY_REACHED_CALLBACK = 33
  • SERVO_BRICK_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • SERVO_BRICK_FUNCTION_SET_SPITFP_BAUDRATE = 234
  • SERVO_BRICK_FUNCTION_ENABLE_STATUS_LED = 238
  • SERVO_BRICK_FUNCTION_DISABLE_STATUS_LED = 239
  • SERVO_BRICK_FUNCTION_RESET = 243
pub fn ServoBrick::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 ServoBrick::set_spitfp_baudrate_config(&self, enable_dynamic_baudrate: bool, minimum_dynamic_baudrate: u32) → ConvertingReceiver<()>

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion ServoBrick::set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von ServoBrick::set_spitfp_baudrate gesetzt statisch verwendet.

Die minimale dynamische Baudrate hat einen Wertebereich von 400000 bis 2000000 Baud.

Standardmäßig ist die dynamische Baudrate aktiviert und die minimale dynamische Baudrate ist 400000.

Neu in Version 2.3.4 (Firmware).

pub fn ServoBrick::get_spitfp_baudrate_config(&self) → ConvertingReceiver<SpitfpBaudrateConfig>

Gibt die Baudratenkonfiguration zurück, siehe ServoBrick::set_spitfp_baudrate_config.

Neu in Version 2.3.4 (Firmware).

pub fn ServoBrick::get_send_timeout_count(&self, communication_method: u8) → ConvertingReceiver<u32>

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

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

  • SERVO_BRICK_COMMUNICATION_METHOD_NONE = 0
  • SERVO_BRICK_COMMUNICATION_METHOD_USB = 1
  • SERVO_BRICK_COMMUNICATION_METHOD_SPI_STACK = 2
  • SERVO_BRICK_COMMUNICATION_METHOD_CHIBI = 3
  • SERVO_BRICK_COMMUNICATION_METHOD_RS485 = 4
  • SERVO_BRICK_COMMUNICATION_METHOD_WIFI = 5
  • SERVO_BRICK_COMMUNICATION_METHOD_ETHERNET = 6
  • SERVO_BRICK_COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.3.2 (Firmware).

pub fn ServoBrick::set_spitfp_baudrate(&self, bricklet_port: char, baudrate: u32) → ConvertingReceiver<()>

Setzt die Baudrate eines spezifischen Bricklet Ports ('a' - 'd'). Die Baudrate hat einen möglichen Wertebereich von 400000 bis 2000000.

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe ServoBrick::get_spitfp_error_count) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe ServoBrick::set_spitfp_baudrate_config).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Die Standardbaudrate für alle Ports ist 1400000.

Neu in Version 2.3.2 (Firmware).

pub fn ServoBrick::get_spitfp_baudrate(&self, bricklet_port: char) → ConvertingReceiver<u32>

Gibt die Baudrate für einen Bricklet Port zurück, siehe ServoBrick::set_spitfp_baudrate.

Neu in Version 2.3.2 (Firmware).

pub fn ServoBrick::get_spitfp_error_count(&self, bricklet_port: char) → 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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.3.2 (Firmware).

pub fn ServoBrick::enable_status_led(&self) → ConvertingReceiver<()>

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

pub fn ServoBrick::disable_status_led(&self) → ConvertingReceiver<()>

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

pub fn ServoBrick::is_status_led_enabled(&self) → ConvertingReceiver<bool>

Gibt true zurück wenn die Status LED aktiviert ist, false sonst.

Neu in Version 2.3.1 (Firmware).

pub fn ServoBrick::get_protocol1_bricklet_name(&self, port: char) → ConvertingReceiver<Protocol1BrickletName>

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

pub fn ServoBrick::get_chip_temperature(&self) → ConvertingReceiver<i16>

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

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine Genauigkeit von +-15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

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

Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.

Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

pub fn ServoBrick::get_identity(&self) → ConvertingReceiver<Identity>

Gibt die UID, die UID zu der der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann '0'-'8' (Stack Position) sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.

Konfigurationsfunktionen für Callbacks

pub fn ServoBrick::set_minimum_voltage(&self, voltage: u16) → ConvertingReceiver<()>

Setzt die minimale Spannung in mV, bei welcher der ServoBrick::get_under_voltage_callback_receiver Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der Servo Brick noch funktioniert, ist 5V. Mit dieser Funktion kann eine Entladung der versorgenden Batterie detektiert werden. Beim Einsatz einer Netzstromversorgung wird diese Funktionalität höchstwahrscheinlich nicht benötigt.

Der Standardwert ist 5V (5000mV).

pub fn ServoBrick::get_minimum_voltage(&self) → ConvertingReceiver<u16>

Gibt die minimale Spannung zurück, wie von ServoBrick::set_minimum_voltage gesetzt.

pub fn ServoBrick::enable_position_reached_callback(&self) → ConvertingReceiver<()>

Aktiviert den ServoBrick::get_position_reached_callback_receiver Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

pub fn ServoBrick::disable_position_reached_callback(&self) → ConvertingReceiver<()>

Deaktiviert den ServoBrick::get_position_reached_callback_receiver Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

pub fn ServoBrick::is_position_reached_callback_enabled(&self) → ConvertingReceiver<bool>

Gibt true zurück wenn der ServoBrick::get_position_reached_callback_receiver Callback aktiviert ist, false sonst.

Neu in Version 2.0.1 (Firmware).

pub fn ServoBrick::enable_velocity_reached_callback(&self) → ConvertingReceiver<()>

Aktiviert den ServoBrick::get_velocity_reached_callback_receiver Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

pub fn ServoBrick::disable_velocity_reached_callback(&self) → ConvertingReceiver<()>

Deaktiviert den ServoBrick::get_velocity_reached_callback_receiver Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

pub fn ServoBrick::is_velocity_reached_callback_enabled(&self) → ConvertingReceiver<bool>

Gibt true zurück wenn der ServoBrick::get_velocity_reached_callback_receiver Callback aktiviert ist, false sonst.

Neu in Version 2.0.1 (Firmware).

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 ServoBrick::get_under_voltage_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

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

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels ServoBrick::set_minimum_voltage gesetzten, Schwellwert sinkt. Der empfangene Variable ist die aktuelle Spannung in mV.
pub fn ServoBrick::get_position_reached_callback_receiver(&self) → ConvertingCallbackReceiver<PositionReachedEvent>

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

Dieser Callback wird ausgelöst, wenn eine konfigurierte Position, wie von ServoBrick::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 ServoBrick::enable_position_reached_callback aktiviert werden.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Servo zu erhalten, funktioniert dies nur wenn die konfigurierte Geschwindigkeit (siehe ServoBrick::set_velocity) 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.

pub fn ServoBrick::get_velocity_reached_callback_receiver(&self) → ConvertingCallbackReceiver<VelocityReachedEvent>

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

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit, wie von ServoBrick::set_velocity gesetzt, erreicht wird. Die Felder der empfangenen Struktur sind der Servo und die Geschwindigkeit die erreicht wurde.

Dieser Callback kann mit ServoBrick::enable_velocity_reached_callback aktiviert werden.

Bemerkung

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

Konstanten

ServoBrick::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen Servo Brick zu identifizieren.

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

ServoBrick::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Servo Brick dar.