Dies ist die Beschreibung der Shell API Bindings für das Servo Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Servo Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Shell API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example-callback.sh)
1#!/bin/sh
2# Connects to localhost:4223 by default, use --host and --port to change this
3
4uid=XYZ # Change XYZ to the UID of your Servo Bricklet 2.0
5
6# Use position reached callback to swing back and forth
7tinkerforge dispatch servo-v2-bricklet $uid position-reached\
8 --execute "if [ {position} -eq 9000 ];
9 then echo 'Position: 90°, going to -90°' && tinkerforge call servo-v2-bricklet $uid set-position 0 -9000;
10 elif [ {position} -eq -9000 ];
11 then echo 'Position: -90°, going to 90°' && tinkerforge call servo-v2-bricklet $uid set-position 0 9000;
12 else echo error; fi" &
13
14# Enable position reached callback
15tinkerforge call servo-v2-bricklet $uid set-position-reached-callback-configuration 0 true
16
17# Set velocity to 100°/s. This has to be smaller or equal to the
18# maximum velocity of the servo you are using, otherwise the position
19# reached callback will be called too early
20tinkerforge call servo-v2-bricklet $uid set-motion-configuration 0 10000 500000 500000
21tinkerforge call servo-v2-bricklet $uid set-position 0 9000
22tinkerforge call servo-v2-bricklet $uid set-enable 0 true
23
24echo "Press key to exit"; read dummy
25
26tinkerforge call servo-v2-bricklet $uid set-enable 0 false
27
28kill -- -$$ # Stop callback dispatch in background
Download (example-configuration.sh)
1#!/bin/sh
2# Connects to localhost:4223 by default, use --host and --port to change this
3
4uid=XYZ # Change XYZ to the UID of your Servo Bricklet 2.0
5
6# Servo 1: Connected to port 0, period of 19.5ms, pulse width of 1 to 2ms
7# and operating angle -100 to 100°
8tinkerforge call servo-v2-bricklet $uid set-degree 0 -10000 10000
9tinkerforge call servo-v2-bricklet $uid set-pulse-width 0 1000 2000
10tinkerforge call servo-v2-bricklet $uid set-period 0 19500
11tinkerforge call servo-v2-bricklet $uid set-motion-configuration 0 500000 1000 1000 # Full velocity with slow ac-/deceleration
12
13
14# Servo 2: Connected to port 5, period of 20ms, pulse width of 0.95 to 1.95ms
15# and operating angle -90 to 90°
16tinkerforge call servo-v2-bricklet $uid set-degree 5 -9000 9000
17tinkerforge call servo-v2-bricklet $uid set-pulse-width 5 950 1950
18tinkerforge call servo-v2-bricklet $uid set-period 5 20000
19tinkerforge call servo-v2-bricklet $uid set-motion-configuration 5 500000 500000 500000 # Full velocity with full ac-/deceleration
20
21tinkerforge call servo-v2-bricklet $uid set-position 0 10000 # Set to most right position
22tinkerforge call servo-v2-bricklet $uid set-enable 0 true
23
24tinkerforge call servo-v2-bricklet $uid set-position 5 -9000 # Set to most left position
25tinkerforge call servo-v2-bricklet $uid set-enable 5 true
26
27echo "Press key to exit"; read dummy
28
29tinkerforge call servo-v2-bricklet $uid set-enable 0 false
30tinkerforge call servo-v2-bricklet $uid set-enable 5 false
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
Jede Funktion der Servo Brick API, welche den servo_channel Parameter verwendet,
kann einen Servo über die Servo-Kanal (0 bis 9) adressieren. Falls es sich um
eine Setter-Funktion handelt können mehrere Servos gleichzeitig mit einer
Bitmaske adressiert werden. Um dies zu kennzeichnen muss das höchstwertigste
Bit gesetzt werden. Beispiel: 1 adressiert den Servo 1,
(1 << 1) | (1 << 5) | (1 << 15) adressiert die Servos 1 und 5.
Das ermöglicht es Konfigurationen von
verschiedenen Servos mit einem Funktionsaufruf durchzuführen. Es ist
sichergestellt das die Änderungen in der selben PWM Periode vorgenommen werden,
für alle Servos entsprechend der Bitmaske.
Allgemeine Optionen des call und des dispatch Befehls sind
hier zu finden. Im Folgenden wird die spezifische
Befehlsstruktur dargestellt.
| Parameter: |
|
|---|
Der call Befehl wird verwendet um eine Funktion des Servo Bricklet 2.0 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 Servo Bricklet 2.0 an
und endet dann
| Parameter: |
|
|---|
Der dispatch Befehl wird verwendet um eingehende Callbacks des Servo Bricklet 2.0
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 Servo Bricklet 2.0 an
und endet dann
| Parameter: |
|
|---|
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.
| Parameter: |
|
|---|
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)
| Ausgabe: |
|
|---|
Gibt die Status-Informationen des Servo Bricklet 2.0 zurück.
Der Status umfasst
für jeden Kanal die Information ob dieser gerade aktiviert oder deaktiviert ist,
für jeden Kanal die aktuelle Position
für jeden Kanal die aktuelle Geschwindigkeit,
für jeden Kanal den Stromverbrauch und
die Eingangsspannung
Hinweis: Die Position und Geschwindigkeit ist eine Momentaufnahme der aktuellen Position und Geschwindigkeit eines sich in Bewegung befindlichen Servos.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Aktiviert einen Servo-Kanal (0 bis 9). Wenn ein Servo aktiviert wird, wird die konfigurierte Position, Geschwindigkeit, Beschleunigung, etc. sofort übernommen.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Gibt zurück ob ein Servo-Kanal aktiviert ist.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt die Position in °/100 für den angegebenen Servo-Kanal.
Der Standardbereich für die Position ist -9000 bis 9000, aber dies kann,
entsprechend dem verwendetem Servo, mit 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
set-degree definiert werden.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Gibt die Position des angegebenen Servo-Kanals zurück, wie von set-position
gesetzt.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Gibt die aktuelle Position des angegebenen Servo-Kanals zurück. Dies kann vom Wert
von set-position abweichen, wenn der Servo gerade sein Positionsziel
anfährt.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Gibt die aktuelle Geschwindigkeit des angegebenen Servo-Kanals zurück. Dies kann
von der Geschwindigkeit die per set-motion-configuration gesetzt wurde
abweichen, wenn der Servo gerade sein Geschwindigkeitsziel anfährt.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt die maximale Geschwindigkeit des angegebenen Servo-Kanals in °/100s sowie die Beschleunigung und Verzögerung in °/100s².
Mit einer Geschwindigkeit von 0 °/100s wird die Position sofort gesetzt (keine Geschwindigkeit).
Mit einer Beschleunigung/Verzögerung von 0 °/100s² wird die Geschwindigkeit sofort gesetzt (keine Beschleunigung/Verzögerung).
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Gibt die 'Motion Configuration' zurück, wie von set-motion-configuration gesetzt.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt die minimale und maximale Pulsweite des angegebenen Servo-Kanals in µs.
Normalerweise werden Servos mit einer PWM angesteuert, wobei die Länge des Pulses die Position des Servos steuert. Jeder Servo hat unterschiedliche minimale und maximale Pulsweiten, diese können mit dieser Funktion spezifiziert werden.
Wenn im Datenblatt des Servos die minimale und maximale Pulsweite spezifiziert ist, sollten diese Werte entsprechend gesetzt werden. Sollte der Servo ohne ein Datenblatt vorliegen, müssen die Werte durch Ausprobieren gefunden werden.
Beide Werte haben einen Wertebereich von 1 bis 65535 (unsigned 16-bit integer). Der minimale Wert muss kleiner als der maximale sein.
Die Standardwerte sind 1000µs (1ms) und 2000µs (2ms) für minimale und maximale Pulsweite.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Gibt die minimale und maximale Pulsweite des angegebenen Servo-Kanals zurück, wie von
set-pulse-width gesetzt.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt den minimalen und maximalen Winkel des angegebenen Servo-Kanals (standardmäßig in °/100).
Dies definiert die abstrakten Werte zwischen welchen die minimale und maximale
Pulsweite skaliert wird. Beispiel: Wenn eine Pulsweite von 1000µs bis 2000µs und
ein Winkelbereich von -90° bis 90° spezifiziert ist, wird ein Aufruf von
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 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. 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.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Gibt den minimalen und maximalen Winkel für den angegebenen Servo-Kanals zurück,
wie von set-degree gesetzt.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt die Periode des angegebenen Servo-Kanals in µs.
Normalerweise werden Servos mit einer PWM angesteuert. Unterschiedliche Servos erwarten PWMs mit unterschiedlichen Perioden. Die meisten Servos werden mit einer Periode von 20ms betrieben.
Wenn im Datenblatt des Servos die Periode spezifiziert ist, sollte dieser Wert entsprechend gesetzt werden. Sollte der Servo ohne ein Datenblatt vorliegen und die korrekte Periode unbekannt sein, wird der Standardwert (19,5ms) meinst funktionieren.
Die minimal mögliche Periode ist 1µs und die maximale 1000000µs.
Der Standardwert ist 19,5ms (19500µs).
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Gibt die Periode für den angegebenen Servo-Kanal zurück, wie von set-period
gesetzt.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Gibt den Stromverbrauch des angegebenen Servo-Kanals in mA zurück.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt die Durchschnittsberechnungsdauer der Strommessung des angegebenen Servo-Kanals in ms.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Gibt die Servo-Stromverbrauchskonfiguration für den angegebenen Servo-Kanal
zurück, wie von set-servo-current-configuration gesetzt.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt die Durchschnittsberechnungsdauer der Eingangsspannungsmessung des angegebenen Servo-Kanals in ms.
| Ausgabe: |
|
|---|
Gibt die Servo-Eingangsspannungskonfiguration zurück, wie von set-input-voltage-configuration gesetzt.
| Ausgabe: |
|
|---|
Gibt den Stromverbrauch aller Servos zusammen in mA zurück.
| Ausgabe: |
|
|---|
Gibt die externe Eingangsspannung (in mV) zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den Servo Brick, eingespeist.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt einen Offset-Wert (in mA) für jeden Kanal.
Hinweis: Im Auslieferungszustand ist das Servo Bricklet 2.0 bereits kalibriert.
| Ausgabe: |
|
|---|
Gibt die Stromkalibrierung zurück, wie von set-current-calibration.
| Ausgabe: |
|
|---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <config>:
status-led-config-off = 0
status-led-config-on = 1
status-led-config-show-heartbeat = 2
status-led-config-show-status = 3
| Ausgabe: |
|
|---|
Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
status-led-config-off = 0
status-led-config-on = 1
status-led-config-show-heartbeat = 2
status-led-config-show-status = 3
| Ausgabe: |
|
|---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
| Ausgabe: |
|
|---|
Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
| Ausgabe: |
|
|---|
Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Aktiviert/Deaktiviert position-reached Callback.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Gibt die Callback-Konfiguration zurück, wie mittels
set-position-reached-callback-configuration gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch servo-v2-bricklet <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.
| Ausgabe: |
|
|---|
Dieser Callback wird ausgelöst, wenn eine konfigurierte Position, wie von
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 Parameter sind der Servo und die Position die erreicht wurde.
Dieser Callback kann mit set-position-reached-callback-configuration aktiviert werden.
Bemerkung
Da es nicht möglich ist eine Rückmeldung vom Servo zu erhalten,
funktioniert dies nur wenn die konfigurierte Geschwindigkeit (siehe set-motion-configuration)
kleiner oder gleich der maximalen Geschwindigkeit des Motors ist. Andernfalls
wird der Motor hinter dem Vorgabewert zurückbleiben und der Callback wird
zu früh ausgelöst.
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.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <mode>:
bootloader-mode-bootloader = 0
bootloader-mode-firmware = 1
bootloader-mode-bootloader-wait-for-reboot = 2
bootloader-mode-firmware-wait-for-reboot = 3
bootloader-mode-firmware-wait-for-erase-and-reboot = 4
Für status:
bootloader-status-ok = 0
bootloader-status-invalid-mode = 1
bootloader-status-no-change = 2
bootloader-status-entry-function-not-present = 3
bootloader-status-device-identifier-incorrect = 4
bootloader-status-crc-mismatch = 5
| Ausgabe: |
|
|---|
Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
bootloader-mode-bootloader = 0
bootloader-mode-firmware = 1
bootloader-mode-bootloader-wait-for-reboot = 2
bootloader-mode-firmware-wait-for-reboot = 3
bootloader-mode-firmware-wait-for-erase-and-reboot = 4
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt den Firmware-Pointer für write-firmware. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
set-write-firmware-pointer gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
| Ausgabe: |
|
|---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.