Shell - Stepper Brick

Dies ist die Beschreibung der Shell 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 Shell API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Configuration

Download (example-configuration.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XXYYZZ # Change XXYYZZ to the UID of your Stepper Brick

tinkerforge call stepper-brick $uid set-motor-current 800 # 800 mA
tinkerforge call stepper-brick $uid set-step-mode step-mode-eighth-step # 1/8 step mode
tinkerforge call stepper-brick $uid set-max-velocity 2000 # Velocity 2000 steps/s

# Slow acceleration (500 steps/s^2),
# Fast deacceleration (5000 steps/s^2)
tinkerforge call stepper-brick $uid set-speed-ramping 500 5000

tinkerforge call stepper-brick $uid enable # Enable motor power
tinkerforge call stepper-brick $uid set-steps 60000 # Drive 60000 steps forward

echo "Press key to exit"; read dummy

# Stop motor before disabling motor power
tinkerforge call stepper-brick $uid stop # Request motor stop
tinkerforge call stepper-brick $uid set-speed-ramping 500 5000 # Fast deacceleration (5000 steps/s^2) for stopping
sleep 0.4 # Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
tinkerforge call stepper-brick $uid disable # Disable motor power

Callback

Download (example-callback.sh)

 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
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XXYYZZ # Change XXYYZZ to the UID of your Stepper Brick

# Use position reached callback to program random movement
tinkerforge dispatch stepper-brick $uid position-reached\
 --execute "echo Changing configuration;
            tinkerforge call stepper-brick $uid set-max-velocity $(((RANDOM%1800)+1200));
            tinkerforge call stepper-brick $uid set-speed-ramping $(((RANDOM%900)+100)) $(((RANDOM%900)+100));
            if [ $((RANDOM % 2)) -eq 1 ];
            then tinkerforge call stepper-brick $uid set-steps $(((RANDOM%4000)+1000));
            else tinkerforge call stepper-brick $uid set-steps $(((RANDOM%4000)-5000));
            fi" &

tinkerforge call stepper-brick $uid enable # Enable motor power
tinkerforge call stepper-brick $uid set-steps 1 # Drive one step forward to get things going

echo "Press key to exit"; read dummy

# Stop motor before disabling motor power
tinkerforge call stepper-brick $uid stop # Request motor stop
tinkerforge call stepper-brick $uid set-speed-ramping 500 5000 # Fast deacceleration (5000 steps/s^2) for stopping
sleep 0.4 # Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
tinkerforge call stepper-brick $uid disable # Disable motor power

kill -- -$$ # Stop callback dispatch in background

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call stepper-brick [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Stepper Brick aufzurufen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
  • --list-functions zeigt eine Liste der bekannten Funktionen des Stepper Brick an und endet dann
tinkerforge dispatch stepper-brick [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Stepper Brick abzufertigen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
  • --list-callbacks zeigt eine Liste der bekannten Callbacks des Stepper Brick an und endet dann
tinkerforge call stepper-brick <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

  • --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch stepper-brick <uid> <callback> [<option>..]
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifische <callback> an und endet dann
  • --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen

tinkerforge call stepper-brick <uid> set-max-velocity <velocity>
Parameter:
  • <velocity> – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
Ausgabe:
  • keine Ausgabe

Setzt die maximale Geschwindigkeit des Schrittmotors. 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 set-target-position, set-steps, drive-forward oder drive-backward verwendet werden.

tinkerforge call stepper-brick <uid> get-max-velocity
Ausgabe:
  • velocity – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

Gibt die Geschwindigkeit zurück, wie von set-max-velocity gesetzt.

tinkerforge call stepper-brick <uid> get-current-velocity
Ausgabe:
  • velocity – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.

tinkerforge call stepper-brick <uid> set-speed-ramping <acceleration> <deacceleration>
Parameter:
  • <acceleration> – Typ: Int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • <deacceleration> – Typ: Int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
Ausgabe:
  • keine Ausgabe

Setzt die Beschleunigung und die Verzögerung des Schrittmotors. 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).

tinkerforge call stepper-brick <uid> get-speed-ramping
Ausgabe:
  • acceleration – Typ: Int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • deacceleration – Typ: Int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000

Gibt die Beschleunigung und Verzögerung zurück, wie von set-speed-ramping gesetzt.

tinkerforge call stepper-brick <uid> full-brake
Ausgabe:
  • keine Ausgabe

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 stop stoppt den Motor.

tinkerforge call stepper-brick <uid> set-steps <steps>
Parameter:
  • <steps> – Typ: Int, Wertebereich: [-231 bis 231 - 1]
Ausgabe:
  • keine Ausgabe

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 set-max-velocity und set-speed-ramping gesetzt, verwendet.

tinkerforge call stepper-brick <uid> get-steps
Ausgabe:
  • steps – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Gibt die letzten Schritte zurück, wie von set-steps gesetzt.

tinkerforge call stepper-brick <uid> get-remaining-steps
Ausgabe:
  • steps – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Gibt die verbleibenden Schritte des letzten Aufrufs von set-steps zurück. Beispiel: Wenn set-steps mit 2000 aufgerufen wird und get-remaining-steps aufgerufen wird wenn der Motor 500 Schritte fahren hat, wird 1500 zurückgegeben.

tinkerforge call stepper-brick <uid> drive-forward
Ausgabe:
  • keine Ausgabe

Fährt den Schrittmotor vorwärts bis drive-backward oder stop aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit set-max-velocity und set-speed-ramping gesetzt, verwendet.

tinkerforge call stepper-brick <uid> drive-backward
Ausgabe:
  • keine Ausgabe

Fährt den Schrittmotor rückwärts bis drive-forward oder stop aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit set-max-velocity und set-speed-ramping gesetzt, verwendet.

tinkerforge call stepper-brick <uid> stop
Ausgabe:
  • keine Ausgabe

Stoppt den Schrittmotor mit der Verzögerung, wie von set-speed-ramping gesetzt.

tinkerforge call stepper-brick <uid> set-motor-current <current>
Parameter:
  • <current> – Typ: Int, Einheit: 1 mA, Wertebereich: [100 bis 2291], Standardwert: 800
Ausgabe:
  • keine Ausgabe

Setzt den Strom mit welchem der Motor angetrieben wird.

Warnung

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

tinkerforge call stepper-brick <uid> get-motor-current
Ausgabe:
  • current – Typ: Int, Einheit: 1 mA, Wertebereich: [100 bis 2291], Standardwert: 800

Gibt den Strom zurück, wie von set-motor-current gesetzt.

tinkerforge call stepper-brick <uid> enable
Ausgabe:
  • keine Ausgabe

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

tinkerforge call stepper-brick <uid> disable
Ausgabe:
  • keine Ausgabe

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

Warnung

Die Treiberstufe zu deaktivieren während der Motor sich noch dreht kann zur Beschädigung der Treiberstufe führen. Der Motor sollte durch Aufrufen der stop Funktion gestoppt werden, bevor die Treiberstufe deaktiviert wird. Die stop Funktion wartet nicht bis der Motor wirklich zum Stillstand gekommen ist. Dazu muss nach dem Aufruf der stop Funktion eine angemessen Zeit gewartet werden bevor die disable Funktion aufgerufen wird.

tinkerforge call stepper-brick <uid> is-enabled
Ausgabe:
  • enabled – Typ: Bool

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

Fortgeschrittene Funktionen

tinkerforge call stepper-brick <uid> set-current-position <position>
Parameter:
  • <position> – Typ: Int, Wertebereich: [-231 bis 231 - 1]
Ausgabe:
  • keine Ausgabe

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).

tinkerforge call stepper-brick <uid> get-current-position
Ausgabe:
  • position – Typ: Int, Wertebereich: [-231 bis 231 - 1]

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 (set-target-position, set-steps, drive-forward der drive-backward). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit set-current-position.

tinkerforge call stepper-brick <uid> set-target-position <position>
Parameter:
  • <position> – Typ: Int, Wertebereich: [-231 bis 231 - 1]
Ausgabe:
  • keine Ausgabe

Setzt die Zielposition des Schrittmotors in Schritten. Beispiel: Wenn die aktuelle Position des Motors 500 ist und 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 set-max-velocity und set-speed-ramping gesetzt, verwendet.

Ein Aufruf von set-target-position mit dem Parameter x ist äquivalent mit einem Aufruf von set-steps mit dem Parameter (x - get-current-position).

tinkerforge call stepper-brick <uid> get-target-position
Ausgabe:
  • position – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Gibt die letzte Zielposition zurück, wie von set-target-position gesetzt.

tinkerforge call stepper-brick <uid> set-step-mode <mode>
Parameter:
  • <mode> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 8
Ausgabe:
  • keine Ausgabe

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.

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

Für <mode>:

  • step-mode-full-step = 1
  • step-mode-half-step = 2
  • step-mode-quarter-step = 4
  • step-mode-eighth-step = 8
tinkerforge call stepper-brick <uid> get-step-mode
Ausgabe:
  • mode – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 8

Gibt den Schrittmodus zurück, wie von set-step-mode gesetzt.

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

Für mode:

  • step-mode-full-step = 1
  • step-mode-half-step = 2
  • step-mode-quarter-step = 4
  • step-mode-eighth-step = 8
tinkerforge call stepper-brick <uid> get-stack-input-voltage
Ausgabe:
  • voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

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

tinkerforge call stepper-brick <uid> get-external-input-voltage
Ausgabe:
  • voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die externe Eingangsspannung 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.

tinkerforge call stepper-brick <uid> get-current-consumption
Ausgabe:
  • current – Typ: Int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt die Stromaufnahme des Motors zurück.

tinkerforge call stepper-brick <uid> set-decay <decay>
Parameter:
  • <decay> – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Ausgabe:
  • keine Ausgabe

Setzt den Decay Modus (Abklingmodus) des Schrittmotors. 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 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.

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.

tinkerforge call stepper-brick <uid> get-decay
Ausgabe:
  • decay – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Gibt den Decay Modus zurück, wie von set-decay gesetzt.

tinkerforge call stepper-brick <uid> set-sync-rect <sync-rect>
Parameter:
  • <sync-rect> – Typ: Bool, Standardwert: false
Ausgabe:
  • keine Ausgabe

Aktiviert oder deaktiviert (true oder false) die Synchrongleichrichtung.

Bei aktiver Synchrongleichrichtung kann der Decay Modus geändert werden (Siehe 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.

tinkerforge call stepper-brick <uid> is-sync-rect
Ausgabe:
  • sync-rect – Typ: Bool, Standardwert: false

Gibt zurück ob die Synchrongleichrichtung aktiviert ist.

tinkerforge call stepper-brick <uid> set-time-base <time-base>
Parameter:
  • <time-base> – Typ: Int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1
Ausgabe:
  • keine Ausgabe

Setzt die Zeitbasis der Geschwindigkeit und Beschleunigung des Stepper Brick.

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.

tinkerforge call stepper-brick <uid> get-time-base
Ausgabe:
  • time-base – Typ: Int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1

Gibt die Zeitbasis zurück, wie von set-time-base gesetzt.

tinkerforge call stepper-brick <uid> get-all-data
Ausgabe:
  • current-velocity – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
  • current-position – Typ: Int, Wertebereich: [-231 bis 231 - 1]
  • remaining-steps – Typ: Int, Wertebereich: [-231 bis 231 - 1]
  • stack-voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • external-voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • current-consumption – Typ: Int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

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 all-data Callback.

tinkerforge call stepper-brick <uid> set-spitfp-baudrate-config <enable-dynamic-baudrate> <minimum-dynamic-baudrate>
Parameter:
  • <enable-dynamic-baudrate> – Typ: Bool, Standardwert: true
  • <minimum-dynamic-baudrate> – Typ: Int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Ausgabe:
  • keine Ausgabe

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 set-spitfp-baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von set-spitfp-baudrate gesetzt statisch verwendet.

Neu in Version 2.3.6 (Firmware).

tinkerforge call stepper-brick <uid> get-spitfp-baudrate-config
Ausgabe:
  • enable-dynamic-baudrate – Typ: Bool, Standardwert: true
  • minimum-dynamic-baudrate – Typ: Int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe set-spitfp-baudrate-config.

Neu in Version 2.3.6 (Firmware).

tinkerforge call stepper-brick <uid> get-send-timeout-count <communication-method>
Parameter:
  • <communication-method> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • timeout-count – Typ: Int, Wertebereich: [0 bis 232 - 1]

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 Symbole sind für diese Funktion verfügbar:

Für <communication-method>:

  • communication-method-none = 0
  • communication-method-usb = 1
  • communication-method-spi-stack = 2
  • communication-method-chibi = 3
  • communication-method-rs485 = 4
  • communication-method-wifi = 5
  • communication-method-ethernet = 6
  • communication-method-wifi-v2 = 7

Neu in Version 2.3.4 (Firmware).

tinkerforge call stepper-brick <uid> set-spitfp-baudrate <bricklet-port> <baudrate>
Parameter:
  • <bricklet-port> – Typ: Char, Wertebereich: [a bis b]
  • <baudrate> – Typ: Int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Ausgabe:
  • keine Ausgabe

Setzt die Baudrate eines spezifischen Bricklet Ports .

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 get-spitfp-error-count) kann die Baudrate verringert werden.

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

Neu in Version 2.3.3 (Firmware).

tinkerforge call stepper-brick <uid> get-spitfp-baudrate <bricklet-port>
Parameter:
  • <bricklet-port> – Typ: Char, Wertebereich: [a bis b]
Ausgabe:
  • baudrate – Typ: Int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Gibt die Baudrate für einen Bricklet Port zurück, siehe set-spitfp-baudrate.

Neu in Version 2.3.3 (Firmware).

tinkerforge call stepper-brick <uid> get-spitfp-error-count <bricklet-port>
Parameter:
  • <bricklet-port> – Typ: Char, Wertebereich: [a bis b]
Ausgabe:
  • error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-frame – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-overflow – Typ: Int, 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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.3.3 (Firmware).

tinkerforge call stepper-brick <uid> enable-status-led
Ausgabe:
  • keine Ausgabe

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).

tinkerforge call stepper-brick <uid> disable-status-led
Ausgabe:
  • keine Ausgabe

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).

tinkerforge call stepper-brick <uid> is-status-led-enabled
Ausgabe:
  • enabled – Typ: Bool, Standardwert: true

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

Neu in Version 2.3.1 (Firmware).

tinkerforge call stepper-brick <uid> get-chip-temperature
Ausgabe:
  • temperature – Typ: Int, Einheit: 1/10 °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 Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

tinkerforge call stepper-brick <uid> reset
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call stepper-brick <uid> get-identity
Ausgabe:
  • uid – Typ: String, Länge: bis zu 8
  • connected-uid – Typ: String, Länge: bis zu 8
  • position – Typ: Char, Wertebereich: [0 bis 8]
  • hardware-version – Typ: Int Array, Länge: 3
    • 0: major – Typ: Int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Int, Wertebereich: [0 bis 255]
  • firmware-version – Typ: Int Array, Länge: 3
    • 0: major – Typ: Int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Int, Wertebereich: [0 bis 255]
  • device-identifier – Typ: Int, Wertebereich: [0 bis 216 - 1]

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 ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

tinkerforge call stepper-brick <uid> set-minimum-voltage <voltage>
Parameter:
  • <voltage> – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000
Ausgabe:
  • keine Ausgabe

Setzt die minimale Spannung, bei welcher der under-voltage 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.

tinkerforge call stepper-brick <uid> get-minimum-voltage
Ausgabe:
  • voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000

Gibt die minimale Spannung zurück, wie von set-minimum-voltage gesetzt.

tinkerforge call stepper-brick <uid> set-all-data-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt die Periode mit welcher der all-data Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

tinkerforge call stepper-brick <uid> get-all-data-period
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set-all-data-period gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch stepper-brick <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

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.

tinkerforge dispatch stepper-brick <uid> under-voltage
Ausgabe:
  • voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels set-minimum-voltage gesetzten, Schwellwert sinkt. Der Parameter ist die aktuelle Spannung.

tinkerforge dispatch stepper-brick <uid> position-reached
Ausgabe:
  • position – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Position, wie von set-steps oder 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 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.

tinkerforge dispatch stepper-brick <uid> all-data
Ausgabe:
  • current-velocity – Typ: Int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
  • current-position – Typ: Int, Wertebereich: [-231 bis 231 - 1]
  • remaining-steps – Typ: Int, Wertebereich: [-231 bis 231 - 1]
  • stack-voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • external-voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • current-consumption – Typ: Int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set-all-data-period, ausgelöst. Die Parameter sind die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

tinkerforge dispatch stepper-brick <uid> new-state
Ausgabe:
  • state-new – Typ: Int, Wertebereich: Siehe Symbole
  • state-previous – Typ: Int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für state-new:

  • state-stop = 1
  • state-acceleration = 2
  • state-run = 3
  • state-deacceleration = 4
  • state-direction-change-to-forward = 5
  • state-direction-change-to-backward = 6

Für state-previous:

  • state-stop = 1
  • state-acceleration = 2
  • state-run = 3
  • state-deacceleration = 4
  • state-direction-change-to-forward = 5
  • state-direction-change-to-backward = 6

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.

tinkerforge call stepper-brick <uid> get-protocol1-bricklet-name <port>
Parameter:
  • <port> – Typ: Char, Wertebereich: [a bis b]
Ausgabe:
  • protocol-version – Typ: Int, Wertebereich: [0 bis 255]
  • firmware-version – Typ: Int Array, Länge: 3
    • 0: major – Typ: Int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Int, Wertebereich: [0 bis 255]
  • name – Typ: String, Länge: bis zu 40

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.

tinkerforge call stepper-brick <uid> write-bricklet-plugin <port> <offset> <chunk>
Parameter:
  • <port> – Typ: Char, Wertebereich: [a bis b]
  • <offset> – Typ: Int, Wertebereich: [0 bis 255]
  • <chunk> – Typ: Int Array, Länge: 32, Wertebereich: [0 bis 255]
Ausgabe:
  • keine Ausgabe

Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.

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

tinkerforge call stepper-brick <uid> read-bricklet-plugin <port> <offset>
Parameter:
  • <port> – Typ: Char, Wertebereich: [a bis b]
  • <offset> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:
  • chunk – Typ: Int Array, Länge: 32, Wertebereich: [0 bis 255]

Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.

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