Rust - Stepper Brick

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

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

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

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

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

    stepper.set_motor_current(800); // 800mA
    stepper.set_step_mode(8); // 1/8 step mode
    stepper.set_max_velocity(2000); // Velocity 2000 steps/s

    // Slow acceleration (500 steps/s^2),
    // Fast deacceleration (5000 steps/s^2)
    stepper.set_speed_ramping(500, 5000);

    stepper.enable(); // Enable motor power
    stepper.set_steps(60000); // Drive 60000 steps forward

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

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

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

    // Spawn thread to handle received callback messages. This thread ends when the stepper
    // is dropped, so there is no need for manual cleanup.
    let stepper_copy = stepper.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 || {
        let mut rng = thread_rng();
        for _position_reached in position_reached_receiver {
            let steps = if rng.gen() {
                let steps = rng.gen_range(1000, 5001); // steps (forward)
                println!("Driving forward: {} steps", steps);
                steps
            } else {
                let steps = rng.gen_range(-5000, -999); // steps (backward)
                println!("Driving backward: {} steps", steps);
                steps
            };

            let vel = rng.gen_range(200, 2001); // steps/s
            let acc = rng.gen_range(100, 1001); // steps/s^2
            let dec = rng.gen_range(100, 1001); // steps/s^2

            println!("Configuration (vel, acc, dec): ({}, {}, {})", vel, acc, dec);

            stepper_copy.set_speed_ramping(acc, dec);
            stepper_copy.set_max_velocity(vel);
            stepper_copy.set_steps(steps);
        }
    });

    stepper.enable(); // Enable motor power
    stepper.set_steps(1); // Drive one step forward to get things going

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    stepper.disable();
    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 StepperBrick::new(uid: &str, ip_connection: &IpConnection) → StepperBrick

Erzeugt ein neues StepperBrick-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 StepperBrick::set_max_velocity(&self, velocity: u16) → ConvertingReceiver<()>

Setzt die maximale Geschwindigkeit des Schrittmotors in Schritten je Sekunde. Diese Funktion startet nicht den Motor, sondern setzt nur die maximale Geschwindigkeit auf welche der Schrittmotor beschleunigt wird. Um den Motor zu fahren können StepperBrick::set_target_position, StepperBrick::set_steps, StepperBrick::drive_forward oder StepperBrick::drive_backward verwendet werden.

pub fn StepperBrick::get_max_velocity(&self) → ConvertingReceiver<u16>

Gibt die Geschwindigkeit zurück, wie von StepperBrick::set_max_velocity gesetzt.

pub fn StepperBrick::get_current_velocity(&self) → ConvertingReceiver<u16>

Gibt die aktuelle Geschwindigkeit des Schrittmotors in Schritten je Sekunde zurück.

pub fn StepperBrick::set_speed_ramping(&self, acceleration: u16, deacceleration: u16) → ConvertingReceiver<()>

Setzt die Beschleunigung und die Verzögerung des Schrittmotors. Die Werte müssen in Schritten/s² angegeben werden. Eine Beschleunigung von 1000 bedeutet, dass jede Sekunde die Geschwindigkeit um 1000 Schritte/s erhöht wird.

Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist und es soll auf eine Geschwindigkeit von 8000 Schritten/s in 10 Sekunden beschleunigt werden, muss die Beschleunigung auf 800 Schritte/s² gesetzt werden.

Eine Beschleunigung/Verzögerung von 0 bedeutet ein sprunghaftes Beschleunigen/Verzögern (nicht empfohlen).

Der Standardwert ist 1000 für beide Parameter.

pub fn StepperBrick::get_speed_ramping(&self) → ConvertingReceiver<SpeedRamping>

Gibt die Beschleunigung und Verzögerung zurück, wie von StepperBrick::set_speed_ramping gesetzt.

pub fn StepperBrick::full_brake(&self) → ConvertingReceiver<()>

Führt eine aktive Vollbremsung aus.

Warnung

Diese Funktion ist für Notsituationen bestimmt, in denen ein unverzüglicher Halt notwendig ist. Abhängig von der aktuellen Geschwindigkeit und der Kraft des Motors kann eine Vollbremsung brachial sein.

Ein Aufruf von StepperBrick::stop stoppt den Motor.

pub fn StepperBrick::set_steps(&self, steps: i32) → ConvertingReceiver<()>

Setzt die Anzahl der Schritte die der Schrittmotor fahren soll. Positive Werte fahren den Motor vorwärts und negative rückwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit StepperBrick::set_max_velocity und StepperBrick::set_speed_ramping gesetzt, verwendet.

pub fn StepperBrick::get_steps(&self) → ConvertingReceiver<i32>

Gibt die letzten Schritte zurück, wie von StepperBrick::set_steps gesetzt.

pub fn StepperBrick::get_remaining_steps(&self) → ConvertingReceiver<i32>

Gibt die verbleibenden Schritte des letzten Aufrufs von StepperBrick::set_steps zurück. Beispiel: Wenn StepperBrick::set_steps mit 2000 aufgerufen wird und StepperBrick::get_remaining_steps aufgerufen wird wenn der Motor 500 Schritte fahren hat, wird 1500 zurückgegeben.

pub fn StepperBrick::drive_forward(&self) → ConvertingReceiver<()>

Fährt den Schrittmotor vorwärts bis StepperBrick::drive_backward oder StepperBrick::stop aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit StepperBrick::set_max_velocity und StepperBrick::set_speed_ramping gesetzt, verwendet.

pub fn StepperBrick::drive_backward(&self) → ConvertingReceiver<()>

Fährt den Schrittmotor rückwärts bis StepperBrick::drive_forward oder StepperBrick::stop aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit StepperBrick::set_max_velocity und StepperBrick::set_speed_ramping gesetzt, verwendet.

pub fn StepperBrick::stop(&self) → ConvertingReceiver<()>

Stoppt den Schrittmotor mit der Verzögerung, wie von StepperBrick::set_speed_ramping gesetzt.

pub fn StepperBrick::set_motor_current(&self, current: u16) → ConvertingReceiver<()>

Setzt den Strom in mA mit welchem der Motor angetrieben wird. Der minimale Wert ist 100mA, der maximale Wert ist 2291mA und der Standardwert ist 800mA.

Warnung

Dieser Wert sollte nicht über die Spezifikation des Schrittmotors gesetzt werden. Sonst ist eine Beschädigung des Motors möglich.

pub fn StepperBrick::get_motor_current(&self) → ConvertingReceiver<u16>

Gibt den Strom zurück, wie von StepperBrick::set_motor_current gesetzt.

pub fn StepperBrick::enable(&self) → ConvertingReceiver<()>

Aktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (maximale Geschwindigkeit, Beschleunigung, etc.).

pub fn StepperBrick::disable(&self) → ConvertingReceiver<()>

Deaktiviert die Treiberstufe. Die Konfiguration (Geschwindigkeit, Beschleunigung, etc.) bleibt erhalten aber der Motor wird nicht angesteuert bis eine erneute Aktivierung erfolgt.

pub fn StepperBrick::is_enabled(&self) → ConvertingReceiver<bool>

Gibt true zurück wenn die Treiberstufe aktiv ist, sonst false.

Fortgeschrittene Funktionen

pub fn StepperBrick::set_current_position(&self, position: i32) → ConvertingReceiver<()>

Setzt den aktuellen Schrittwert des internen Schrittzählers. Dies kann benutzt werden um die aktuelle Position auf 0 zu setzen wenn ein definierter Startpunkt erreicht wurde (z.B. wenn eine CNC Maschine eine Ecke erreicht).

pub fn StepperBrick::get_current_position(&self) → ConvertingReceiver<i32>

Gibt die aktuelle Position des Schrittmotors in Schritten zurück. Nach dem Hochfahren ist die Position 0. Die Schritte werden bei Verwendung aller möglichen Fahrfunktionen gezählt (StepperBrick::set_target_position, StepperBrick::set_steps, StepperBrick::drive_forward der StepperBrick::drive_backward). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit StepperBrick::set_current_position.

pub fn StepperBrick::set_target_position(&self, position: i32) → ConvertingReceiver<()>

Setzt die Zielposition des Schrittmotors in Schritten. Beispiel: Wenn die aktuelle Position des Motors 500 ist und StepperBrick::set_target_position mit 1000 aufgerufen wird, dann verfährt der Schrittmotor 500 Schritte vorwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit StepperBrick::set_max_velocity und StepperBrick::set_speed_ramping gesetzt, verwendet.

Ein Aufruf von StepperBrick::set_target_position mit dem Parameter x ist äquivalent mit einem Aufruf von StepperBrick::set_steps mit dem Parameter (x - StepperBrick::get_current_position).

pub fn StepperBrick::get_target_position(&self) → ConvertingReceiver<i32>

Gibt die letzte Zielposition zurück, wie von StepperBrick::set_target_position gesetzt.

pub fn StepperBrick::set_step_mode(&self, mode: u8) → ConvertingReceiver<()>

Setzt den Schrittmodus des Schrittmotors. Mögliche Werte sind:

  • Vollschritt = 1
  • Halbschritt = 2
  • Viertelschritt = 4
  • Achtelschritt = 8

Ein höherer Wert erhöht die Auflösung und verringert das Drehmoment des Schrittmotors.

Der Standardwert ist 8 (Achtelschritt).

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

  • STEPPER_BRICK_STEP_MODE_FULL_STEP = 1
  • STEPPER_BRICK_STEP_MODE_HALF_STEP = 2
  • STEPPER_BRICK_STEP_MODE_QUARTER_STEP = 4
  • STEPPER_BRICK_STEP_MODE_EIGHTH_STEP = 8
pub fn StepperBrick::get_step_mode(&self) → ConvertingReceiver<u8>

Gibt den Schrittmodus zurück, wie von StepperBrick::set_step_mode gesetzt.

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

  • STEPPER_BRICK_STEP_MODE_FULL_STEP = 1
  • STEPPER_BRICK_STEP_MODE_HALF_STEP = 2
  • STEPPER_BRICK_STEP_MODE_QUARTER_STEP = 4
  • STEPPER_BRICK_STEP_MODE_EIGHTH_STEP = 8
pub fn StepperBrick::get_stack_input_voltage(&self) → ConvertingReceiver<u16>

Gibt die Eingangsspannung (in mV) des Stapels zurück. Die Eingangsspannung des Stapel wird über diesen bereitgestellt und von einer Step-Down oder Step-Up Power Supply erzeugt.

pub fn StepperBrick::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 Stepper Brick, eingespeist.

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

Warnung

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

pub fn StepperBrick::get_current_consumption(&self) → ConvertingReceiver<u16>

Gibt die Stromaufnahme des Motors zurück (in mA).

pub fn StepperBrick::set_decay(&self, decay: u16) → ConvertingReceiver<()>

Setzt den Decay Modus (Abklingmodus) des Schrittmotors. Der mögliche Wertebereich ist 0 bis 65535. Ein Wert von 0 setzt den Fast Decay Modus (schneller Stromabbau), ein Wert von 65535 den Slow Decay Modus (langsamer Stromabbau) ein Wert dazwischen den Mixed Decay Modus (Nutzung beider Modi).

Eine Änderung des Decay Modus ist nur möglich wenn die Synchrongleichrichtung aktiviert ist (siehe StepperBrick::set_sync_rect).

Für eine gute Erläuterung der verschiedenen Decay Modi siehe diesen Blogeintrag (Englisch) von Avayan oder diesen Blogeintrag (Deutsch) von T. Ostermann.

Ein guter Decay Modus ist leider unterschiedlich für jeden Motor. Der beste Weg einen guten Decay Modus für den jeweiligen Schrittmotor zu finden, wenn der Strom nicht mit einem Oszilloskop gemessen werden kann, ist auf die Geräusche des Motors zu hören. Wenn der Wert zu gering ist, ist oftmals ein hoher Ton zu hören und wenn er zu hoch ist, oftmals ein brummendes Geräusch.

Im Allgemeinen ist der Fast Decay Modus (kleine Werte) geräuschvoller, erlaubt aber höhere Motorgeschwindigkeiten.

Der Standardwert ist 10000.

Bemerkung

Es existiert leider keine Formel zur Berechnung des optimalen Decay Modus eines Schrittmotors. Sollten Probleme mit lauten Geräuschen oder einer zu geringen maximalen Motorgeschwindigkeit bestehen, bleibt nur Ausprobieren um einen besseren Decay Modus zu finden.

pub fn StepperBrick::get_decay(&self) → ConvertingReceiver<u16>

Gibt den Decay Modus zurück, wie von StepperBrick::set_decay gesetzt.

pub fn StepperBrick::set_sync_rect(&self, sync_rect: bool) → ConvertingReceiver<()>

Aktiviert oder deaktiviert (true oder false) die Synchrongleichrichtung.

Bei aktiver Synchrongleichrichtung kann der Decay Modus geändert werden (Siehe StepperBrick::set_decay). Ohne Synchrongleichrichtung wird der Fast Decay Modus verwendet.

Für eine Erläuterung der Synchrongleichrichtung siehe hier.

Warnung

Wenn hohe Geschwindigkeiten (> 10000 Schritte/s) mit einem großen Schrittmotor mit einer hohen Induktivität genutzt werden sollen, wird dringend geraten die Synchrongleichrichtung zu deaktivieren. Sonst kann es vorkommen, dass der Brick die Last nicht bewältigen kann und überhitzt.

Der Standardwert ist false.

pub fn StepperBrick::is_sync_rect(&self) → ConvertingReceiver<bool>

Gibt zurück ob die Synchrongleichrichtung aktiviert ist.

pub fn StepperBrick::set_time_base(&self, time_base: u32) → ConvertingReceiver<()>

Setzt die Zeitbasis der Geschwindigkeit und Beschleunigung des Stepper Brick (in Sekunden).

Beispiel: Wenn aller 1,5 Sekunden ein Schritt gefahren werden soll, kann die Zeitbasis auf 15 und die Geschwindigkeit auf 10 gesetzt werden. Damit ist die Geschwindigkeit 10Schritte/15s = 1Schritt/1,5s.

Der Standardwert ist 1.

pub fn StepperBrick::get_time_base(&self) → ConvertingReceiver<u32>

Gibt die Zeitbasis zurück, wie von StepperBrick::set_time_base gesetzt.

pub fn StepperBrick::get_all_data(&self) → ConvertingReceiver<AllData>

Gibt die folgenden Parameter zurück: Die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

Es existiert auch ein Callback für diese Funktion, siehe StepperBrick::get_all_data_callback_receiver Callback.

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

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

  • STEPPER_BRICK_FUNCTION_SET_MAX_VELOCITY = 1
  • STEPPER_BRICK_FUNCTION_SET_SPEED_RAMPING = 4
  • STEPPER_BRICK_FUNCTION_FULL_BRAKE = 6
  • STEPPER_BRICK_FUNCTION_SET_CURRENT_POSITION = 7
  • STEPPER_BRICK_FUNCTION_SET_TARGET_POSITION = 9
  • STEPPER_BRICK_FUNCTION_SET_STEPS = 11
  • STEPPER_BRICK_FUNCTION_SET_STEP_MODE = 14
  • STEPPER_BRICK_FUNCTION_DRIVE_FORWARD = 16
  • STEPPER_BRICK_FUNCTION_DRIVE_BACKWARD = 17
  • STEPPER_BRICK_FUNCTION_STOP = 18
  • STEPPER_BRICK_FUNCTION_SET_MOTOR_CURRENT = 22
  • STEPPER_BRICK_FUNCTION_ENABLE = 24
  • STEPPER_BRICK_FUNCTION_DISABLE = 25
  • STEPPER_BRICK_FUNCTION_SET_DECAY = 27
  • STEPPER_BRICK_FUNCTION_SET_MINIMUM_VOLTAGE = 29
  • STEPPER_BRICK_FUNCTION_SET_SYNC_RECT = 33
  • STEPPER_BRICK_FUNCTION_SET_TIME_BASE = 35
  • STEPPER_BRICK_FUNCTION_SET_ALL_DATA_PERIOD = 38
  • STEPPER_BRICK_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • STEPPER_BRICK_FUNCTION_SET_SPITFP_BAUDRATE = 234
  • STEPPER_BRICK_FUNCTION_ENABLE_STATUS_LED = 238
  • STEPPER_BRICK_FUNCTION_DISABLE_STATUS_LED = 239
  • STEPPER_BRICK_FUNCTION_RESET = 243
pub fn StepperBrick::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 StepperBrick::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 StepperBrick::set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von StepperBrick::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.6 (Firmware).

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

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

Neu in Version 2.3.6 (Firmware).

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

  • STEPPER_BRICK_COMMUNICATION_METHOD_NONE = 0
  • STEPPER_BRICK_COMMUNICATION_METHOD_USB = 1
  • STEPPER_BRICK_COMMUNICATION_METHOD_SPI_STACK = 2
  • STEPPER_BRICK_COMMUNICATION_METHOD_CHIBI = 3
  • STEPPER_BRICK_COMMUNICATION_METHOD_RS485 = 4
  • STEPPER_BRICK_COMMUNICATION_METHOD_WIFI = 5
  • STEPPER_BRICK_COMMUNICATION_METHOD_ETHERNET = 6
  • STEPPER_BRICK_COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.3.4 (Firmware).

pub fn StepperBrick::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 StepperBrick::get_spitfp_error_count) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe StepperBrick::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.3 (Firmware).

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

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

Neu in Version 2.3.3 (Firmware).

pub fn StepperBrick::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.3 (Firmware).

pub fn StepperBrick::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 StepperBrick::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 StepperBrick::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 StepperBrick::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 StepperBrick::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 StepperBrick::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 StepperBrick::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 StepperBrick::set_minimum_voltage(&self, voltage: u16) → ConvertingReceiver<()>

Setzt die minimale Spannung in mV, bei welcher der StepperBrick::get_under_voltage_callback_receiver Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der Stepper Brick noch funktioniert, ist 8V. 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 8V.

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

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

pub fn StepperBrick::set_all_data_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der StepperBrick::get_all_data_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

pub fn StepperBrick::get_all_data_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von StepperBrick::set_all_data_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 StepperBrick::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 StepperBrick::set_minimum_voltage gesetzten, Schwellwert sinkt. Der empfangene Variable ist die aktuelle Spannung in mV.
pub fn StepperBrick::get_position_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

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

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Position, wie von StepperBrick::set_steps oder StepperBrick::set_target_position gesetzt, erreicht wird.

Bemerkung

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

pub fn StepperBrick::get_all_data_callback_receiver(&self) → ConvertingCallbackReceiver<AllDataEvent>

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

Dieser Callback wird mit der Periode, wie gesetzt mit StepperBrick::set_all_data_period, ausgelöst. Die Felder der empfangenen Struktur sind die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.
pub fn StepperBrick::get_new_state_callback_receiver(&self) → ConvertingCallbackReceiver<NewStateEvent>

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

Dieser Callback wird immer dann ausgelöst, wenn der Stepper Brick einen neuen Zustand erreicht. Es wird sowohl der neue wie auch der alte Zustand zurückgegeben.

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

  • STEPPER_BRICK_STATE_STOP = 1
  • STEPPER_BRICK_STATE_ACCELERATION = 2
  • STEPPER_BRICK_STATE_RUN = 3
  • STEPPER_BRICK_STATE_DEACCELERATION = 4
  • STEPPER_BRICK_STATE_DIRECTION_CHANGE_TO_FORWARD = 5
  • STEPPER_BRICK_STATE_DIRECTION_CHANGE_TO_BACKWARD = 6

Konstanten

StepperBrick::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen Stepper Brick zu identifizieren.

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

StepperBrick::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Stepper Brick dar.