Shell - Servo Brick

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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

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

# Use position reached callback to swing back and forth
tinkerforge dispatch servo-brick $uid position-reached\
 --execute "if   [ {position} -eq  9000 ];
            then echo 'Position: 90°, going to -90°' && tinkerforge call servo-brick $uid set-position 0 -9000;
            elif [ {position} -eq -9000 ];
            then echo 'Position: -90°, going to 90°' && tinkerforge call servo-brick $uid set-position 0 9000;
            else echo error; fi" &

# Enable position reached callback
tinkerforge call servo-brick $uid 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
tinkerforge call servo-brick $uid set-velocity 0 10000
tinkerforge call servo-brick $uid set-position 0 9000
tinkerforge call servo-brick $uid enable 0

echo "Press key to exit"; read dummy

tinkerforge call servo-brick $uid disable 0

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

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
24
25
26
27
28
29
30
31
32
33
34
35
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

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

# 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°
tinkerforge call servo-brick $uid set-output-voltage 5500

tinkerforge call servo-brick $uid set-degree 0 -10000 10000
tinkerforge call servo-brick $uid set-pulse-width 0 1000 2000
tinkerforge call servo-brick $uid set-period 0 19500
tinkerforge call servo-brick $uid set-acceleration 0 1000 # Slow acceleration
tinkerforge call servo-brick $uid set-velocity 0 65535 # Full speed

tinkerforge call servo-brick $uid set-degree 5 -9000 9000
tinkerforge call servo-brick $uid set-pulse-width 5 950 1950
tinkerforge call servo-brick $uid set-period 5 20000
tinkerforge call servo-brick $uid set-acceleration 5 65535 # Full acceleration
tinkerforge call servo-brick $uid set-velocity 5 65535 # Full speed

tinkerforge call servo-brick $uid set-position 0 10000 # Set to most right position
tinkerforge call servo-brick $uid enable 0

tinkerforge call servo-brick $uid set-position 5 -9000 # Set to most left position
tinkerforge call servo-brick $uid enable 5

echo "Press key to exit"; read dummy

tinkerforge call servo-brick $uid disable 0
tinkerforge call servo-brick $uid disable 5

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

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.

Befehlsstruktur

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

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

Der call Befehl wird verwendet um eine Funktion des Servo 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 Servo Brick an und endet dann
tinkerforge dispatch servo-brick [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Servo 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 Servo Brick an und endet dann
tinkerforge call servo-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 servo-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 servo-brick <uid> enable <servo-num>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6, 128 bis 255]
Ausgabe:
  • keine Ausgabe

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

tinkerforge call servo-brick <uid> disable <servo-num>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6, 128 bis 255]
Ausgabe:
  • keine Ausgabe

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

tinkerforge call servo-brick <uid> is-enabled <servo-num>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6]
Ausgabe:
  • enabled – Typ: Bool

Gibt zurück ob ein Servo aktiviert ist.

tinkerforge call servo-brick <uid> set-position <servo-num> <position>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6, 128 bis 255]
  • <position> – Typ: Int, Einheit: 1/100 °, Wertebereich: ?
Ausgabe:
  • keine Ausgabe

Setzt die Position für den angegebenen Servo.

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.

tinkerforge call servo-brick <uid> get-position <servo-num>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6]
Ausgabe:
  • position – Typ: Int, Einheit: 1/100 °, Wertebereich: ?

Gibt die Position des angegebenen Servos zurück, wie von set-position gesetzt.

tinkerforge call servo-brick <uid> get-current-position <servo-num>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6]
Ausgabe:
  • position – Typ: Int, Einheit: 1/100 °, Wertebereich: ?

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

tinkerforge call servo-brick <uid> set-velocity <servo-num> <velocity>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6, 128 bis 255]
  • <velocity> – Typ: Int, Einheit: 1/100 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1
Ausgabe:
  • keine Ausgabe

Setzt die maximale Geschwindigkeit des angegebenen Servos. Die Geschwindigkeit wird entsprechend mit dem Wert, wie von 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).

tinkerforge call servo-brick <uid> get-velocity <servo-num>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6]
Ausgabe:
  • velocity – Typ: Int, Einheit: 1/100 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

Gibt die Geschwindigkeit des angegebenen Servos zurück, wie von set-velocity gesetzt.

tinkerforge call servo-brick <uid> get-current-velocity <servo-num>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6]
Ausgabe:
  • velocity – Typ: Int, Einheit: 1/100 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

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

tinkerforge call servo-brick <uid> set-acceleration <servo-num> <acceleration>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6, 128 bis 255]
  • <acceleration> – Typ: Int, Einheit: 1/100 °/s², Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1
Ausgabe:
  • keine Ausgabe

Setzt die Beschleunigung des angegebenen Servos.

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

tinkerforge call servo-brick <uid> get-acceleration <servo-num>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6]
Ausgabe:
  • acceleration – Typ: Int, Einheit: 1/100 °/s², Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

Gibt die Beschleunigung des angegebenen Servos zurück, wie von set-acceleration gesetzt.

tinkerforge call servo-brick <uid> set-output-voltage <voltage>
Parameter:
  • <voltage> – Typ: Int, Einheit: 1 mV, Wertebereich: [2000 bis 9000], Standardwert: 5000
Ausgabe:
  • keine Ausgabe

Setzt die Ausgangsspannung mit welchem der Servo angetrieben wird.

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

tinkerforge call servo-brick <uid> get-output-voltage
Ausgabe:
  • voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [2000 bis 9000], Standardwert: 5000

Gibt die Ausgangsspannung zurück, wie von set-output-voltage gesetzt.

tinkerforge call servo-brick <uid> set-pulse-width <servo-num> <min> <max>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6, 128 bis 255]
  • <min> – Typ: Int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • <max> – Typ: Int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 2000
Ausgabe:
  • keine Ausgabe

Setzt die minimale und maximale Pulsweite des angegebenen Servos.

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.

Der minimale Wert muss kleiner als der maximale sein.

tinkerforge call servo-brick <uid> get-pulse-width <servo-num>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6]
Ausgabe:
  • min – Typ: Int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • max – Typ: Int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 2000

Gibt die minimale und maximale Pulsweite des angegebenen Servos zurück, wie von set-pulse-width gesetzt.

tinkerforge call servo-brick <uid> set-degree <servo-num> <min> <max>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6, 128 bis 255]
  • <min> – Typ: Int, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: -9000
  • <max> – Typ: Int, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 9000
Ausgabe:
  • keine Ausgabe

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

Der minimale Wert muss kleiner als der maximale sein.

tinkerforge call servo-brick <uid> get-degree <servo-num>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6]
Ausgabe:
  • min – Typ: Int, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: -9000
  • max – Typ: Int, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 9000

Gibt den minimalen und maximalen Winkel für den angegebenen Servo zurück, wie von set-degree gesetzt.

tinkerforge call servo-brick <uid> set-period <servo-num> <period>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6, 128 bis 255]
  • <period> – Typ: Int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 19500
Ausgabe:
  • keine Ausgabe

Setzt die Periode des angegebenen Servos.

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 meist funktionieren.

tinkerforge call servo-brick <uid> get-period <servo-num>
Parameter:
  • <servo-num> – Typ: Int, Wertebereich: [0 bis 6]
Ausgabe:
  • period – Typ: Int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 19500

Gibt die Periode für den angegebenen Servo zurück, wie von set-period gesetzt.

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

Gibt den Stromverbrauch des angegebenen Servos zurück.

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

Gibt den Stromverbrauch aller Servos zusammen zurück.

tinkerforge call servo-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 Stapels wird über diesen verteilt, z.B. mittels einer Step-Down oder Step-Up Power Supply.

tinkerforge call servo-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 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

tinkerforge call servo-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.4 (Firmware).

tinkerforge call servo-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.4 (Firmware).

tinkerforge call servo-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.2 (Firmware).

tinkerforge call servo-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.2 (Firmware).

tinkerforge call servo-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.2 (Firmware).

tinkerforge call servo-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.2 (Firmware).

tinkerforge call servo-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 servo-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 servo-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 servo-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 servo-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 servo-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 servo-brick <uid> set-minimum-voltage <voltage>
Parameter:
  • <voltage> – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 5000
Ausgabe:
  • keine Ausgabe

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

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

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

tinkerforge call servo-brick <uid> enable-position-reached-callback
Ausgabe:
  • keine Ausgabe

Aktiviert den position-reached Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

tinkerforge call servo-brick <uid> disable-position-reached-callback
Ausgabe:
  • keine Ausgabe

Deaktiviert den position-reached Callback.

Neu in Version 2.0.1 (Firmware).

tinkerforge call servo-brick <uid> is-position-reached-callback-enabled
Ausgabe:
  • enabled – Typ: Bool, Standardwert: false

Gibt true zurück wenn der position-reached Callback aktiviert ist, false sonst.

Neu in Version 2.0.1 (Firmware).

tinkerforge call servo-brick <uid> enable-velocity-reached-callback
Ausgabe:
  • keine Ausgabe

Aktiviert den velocity-reached Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

tinkerforge call servo-brick <uid> disable-velocity-reached-callback
Ausgabe:
  • keine Ausgabe

Deaktiviert den velocity-reached Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

tinkerforge call servo-brick <uid> is-velocity-reached-callback-enabled
Ausgabe:
  • enabled – Typ: Bool, Standardwert: false

Gibt true zurück wenn der velocity-reached 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:

tinkerforge dispatch servo-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 servo-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 servo-brick <uid> position-reached
Ausgabe:
  • servo-num – Typ: Int, Wertebereich: [0 bis 6]
  • position – Typ: Int, Einheit: 1/100 °, Wertebereich: ?

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

tinkerforge dispatch servo-brick <uid> velocity-reached
Ausgabe:
  • servo-num – Typ: Int, Wertebereich: [0 bis 6]
  • velocity – Typ: Int, Einheit: 1/100 °/s, Wertebereich: [-215 bis 215 - 1]

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit, wie von set-velocity gesetzt, erreicht wird. Die Parameter sind der Servo und die Geschwindigkeit die erreicht wurde.

Dieser Callback kann mit 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 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.

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