Dies ist die Beschreibung der Shell API Bindings für das DC Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des DC 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-configuration.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your DC Bricklet 2.0
tinkerforge call dc-v2-bricklet $uid set-drive-mode drive-mode-drive-coast
tinkerforge call dc-v2-bricklet $uid set-pwm-frequency 10000 # Use PWM frequency of 10 kHz
tinkerforge call dc-v2-bricklet $uid set-motion 4096 16384 # Slow acceleration (12.5 %/s), fast decceleration (50 %/s) for stopping
tinkerforge call dc-v2-bricklet $uid set-velocity 32767 # Full speed forward (100 %)
tinkerforge call dc-v2-bricklet $uid set-enabled true # Enable motor power
echo "Press key to exit"; read dummy
tinkerforge call dc-v2-bricklet $uid set-velocity 0 # Stop motor before disabling motor power
sleep 2 # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
tinkerforge call dc-v2-bricklet $uid set-enabled false # Disable motor power
|
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=XYZ # Change XYZ to the UID of your DC Bricklet 2.0
# The acceleration has to be smaller or equal to the maximum
# acceleration of the DC motor, otherwise the velocity reached
# callback will be called too early
tinkerforge call dc-v2-bricklet $uid set-motion 4096 16384 # Slow acceleration (12.5 %/s), fast decceleration (50 %/s) for stopping
tinkerforge call dc-v2-bricklet $uid set-velocity 32767 # Full speed forward (100 %)
# Use velocity reached callback to swing back and forth
# between full speed forward and full speed backward
tinkerforge dispatch dc-v2-bricklet $uid velocity-reached\
--execute "if [ {velocity} -eq 32767 ]; then tinkerforge call dc-v2-bricklet $uid set-velocity -32767;
elif [ {velocity} -eq -32767 ]; then tinkerforge call dc-v2-bricklet $uid set-velocity 32767;
else echo error; fi" &
# Enable motor power
tinkerforge call dc-v2-bricklet $uid set-enabled true
echo "Press key to exit"; read dummy
tinkerforge call dc-v2-bricklet $uid set-velocity 0 # Stop motor before disabling motor power
sleep 2 # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
tinkerforge call dc-v2-bricklet $uid set-enabled false # Disable motor power
kill -- -$$ # Stop callback dispatch in background
|
Mögliche Exit Codes für alle tinkerforge
Befehle sind:
argparse
Modul fehltAllgemeine Optionen des call
und des dispatch
Befehls sind
hier zu finden. Im Folgenden wird die spezifische
Befehlsstruktur dargestellt.
call
dc-v2-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
Der call
Befehl wird verwendet um eine Funktion des DC 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 DC Bricklet 2.0 an
und endet danndispatch
dc-v2-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
Der dispatch
Befehl wird verwendet um eingehende Callbacks des DC 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 DC Bricklet 2.0 an
und endet danndc-v2-bricklet
<uid> <function>
[<option>..] [<argument>..]¶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 dannGetter-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 dieseMit 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.
dc-v2-bricklet
<uid> <callback>
[<option>..]¶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)dc-v2-bricklet
<uid> set-enabled
<enabled>¶Parameter: |
|
---|---|
Ausgabe: |
|
Aktiviert/Deaktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (Geschwindigkeit, Beschleunigung, etc.).
dc-v2-bricklet
<uid> get-enabled
¶Ausgabe: |
|
---|
Gibt true zurück wenn die Treiberstufe aktiv ist, sonst false.
dc-v2-bricklet
<uid> set-velocity
<velocity>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Geschwindigkeit des Motors. Hierbei sind -32767 maximale
Geschwindigkeit rückwärts, 0 ist Halt und 32767 maximale Geschwindigkeit
vorwärts. In Abhängigkeit von der Beschleunigung (siehe set-motion
)
wird der Motor nicht direkt auf die Geschwindigkeit gebracht sondern
gleichmäßig beschleunigt.
Die Geschwindigkeit beschreibt das Tastverhältnis der PWM für die
Motoransteuerung. Z.B. entspricht ein Geschwindigkeitswert von 3277 einer PWM
mit einem Tastverhältnis von 10%. Weiterhin kann neben dem Tastverhältnis auch
die Frequenz der PWM verändert werden, siehe set-pwm-frequency
.
dc-v2-bricklet
<uid> get-velocity
¶Ausgabe: |
|
---|
Gibt die Geschwindigkeit zurück, wie gesetzt von set-velocity
.
dc-v2-bricklet
<uid> get-current-velocity
¶Ausgabe: |
|
---|
Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert
unterscheidet sich von get-velocity
, sobald der Motor auf einen
neuen Zielwert, wie von set-velocity
vorgegeben, beschleunigt.
dc-v2-bricklet
<uid> set-motion
<acceleration> <deceleration>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Beschleunigung/Debeschleunigung des Motors. Die Einheit dieses Wertes ist Geschwindigkeit/s. Ein Beschleunigungswert von 10000 bedeutet, dass jede Sekunde die Geschwindigkeit um 10000 erhöht wird (entspricht rund 30% Tastverhältnis).
Beispiel: Soll die Geschwindigkeit von 0 auf 16000 (entspricht ungefähr 50% Tastverhältnis) in 10 Sekunden beschleunigt werden, so ist die Beschleunigung auf 1600 einzustellen.
Eine Beschleunigung/Debeschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Rampe gefahren.
dc-v2-bricklet
<uid> get-motion
¶Ausgabe: |
|
---|
Gibt die Beschleunigung/Debeschleunigung zurück, wie gesetzt von set-motion
.
dc-v2-bricklet
<uid> full-brake
¶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 set-velocity
mit 0 erlaubt einen normalen Stopp des Motors.
dc-v2-bricklet
<uid> get-pwm-frequency
¶Ausgabe: |
|
---|
Gibt die PWM Frequenz zurück, wie gesetzt von set-pwm-frequency
.
dc-v2-bricklet
<uid> get-power-statistics
¶Ausgabe: |
|
---|
Gibt die Eingangsspannung und den Stromverbrauch des Treibers zurück.
dc-v2-bricklet
<uid> set-drive-mode
<mode>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Fahrmodus. Verfügbare Modi sind:
Diese Modi sind verschiedene Arten der Motoransteuerung.
Im Fahren/Bremsen Modus wird der Motor entweder gefahren oder gebremst. Es gibt keinen Leerlauf. Vorteile sind die lineare Korrelation zwischen PWM und Geschwindigkeit, präzisere Beschleunigungen und die Möglichkeit mit geringeren Geschwindigkeiten zu fahren.
Im Fahren/Leerlauf Modus wir der Motor entweder gefahren oder befindet sich im Leerlauf. Vorteile sind die geringere Stromaufnahme und geringere Belastung des Motors und der Treiberstufe.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <mode>:
dc-v2-bricklet
<uid> get-drive-mode
¶Ausgabe: |
|
---|
Gibt den Fahrmodus zurück, wie von set-drive-mode
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
dc-v2-bricklet
<uid> set-pwm-frequency
<frequency>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Frequenz der PWM, welche den Motor steuert. Oftmals ist eine hohe Frequenz geräuschärmer und der Motor läuft dadurch ruhiger. Trotz dessen führt eine geringe Frequenz zu weniger Schaltvorgängen und somit zu weniger Schaltverlusten. Bei einer Vielzahl von Motoren ermöglichen geringere Frequenzen höhere Drehmomente.
Im Allgemeinen kann diese Funktion ignoriert werden, da der Standardwert höchstwahrscheinlich zu einem akzeptablen Ergebnis führt.
dc-v2-bricklet
<uid> set-error-led-config
<config>¶Parameter: |
|
---|---|
Ausgabe: |
|
Konfiguriert die Touch-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option den Fehler-Status anzuzeigen.
Wenn die LED konfiguriert ist um Fehler anzuzeigen gibt es drei unterschiedliche Zustände:
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <config>:
dc-v2-bricklet
<uid> get-error-led-config
¶Ausgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von set-error-led-config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
dc-v2-bricklet
<uid> get-spitfp-error-count
¶Ausgabe: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
dc-v2-bricklet
<uid> set-status-led-config
<config>¶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>:
dc-v2-bricklet
<uid> get-status-led-config
¶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:
dc-v2-bricklet
<uid> get-chip-temperature
¶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.
dc-v2-bricklet
<uid> reset
¶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.
dc-v2-bricklet
<uid> get-identity
¶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.
dc-v2-bricklet
<uid> set-emergency-shutdown-callback-configuration
<enabled>¶Parameter: |
|
---|---|
Ausgabe: |
|
Aktiviert/Deaktiviert emergency-shutdown
Callback.
dc-v2-bricklet
<uid> get-emergency-shutdown-callback-configuration
¶Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set-emergency-shutdown-callback-configuration
gesetzt.
dc-v2-bricklet
<uid> set-velocity-reached-callback-configuration
<enabled>¶Parameter: |
|
---|---|
Ausgabe: |
|
Aktiviert/Deaktiviert velocity-reached
Callback.
dc-v2-bricklet
<uid> get-velocity-reached-callback-configuration
¶Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set-velocity-reached-callback-configuration
gesetzt.
dc-v2-bricklet
<uid> set-current-velocity-callback-configuration
<period> <value-has-to-change>¶Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der current-velocity
Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
dc-v2-bricklet
<uid> get-current-velocity-callback-configuration
¶Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set-current-velocity-callback-configuration
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch dc-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.
dc-v2-bricklet
<uid> emergency-shutdown
¶Ausgabe: |
|
---|
Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch (über 5A) oder die Temperatur der Treiberstufe zu hoch ist (über 175°C). Beide Möglichkeiten sind letztendlich gleichbedeutend, da die Temperatur ihren Schwellwert überschreitet sobald der Motor zu viel Strom verbraucht. Im Falle einer Spannung unter 3,3V (Stapel- oder externe Spannungsversorgung) wird dieser Callback auch ausgelöst.
Sobald dieser Callback ausgelöst wird, wird die Treiberstufe deaktiviert.
Das bedeutet set-enabled
muss aufgerufen werden, um den Motor
erneut zu fahren.
Bemerkung
Dieser Callback funktioniert nur im Fahren/Bremsen Modus (siehe
set-drive-mode
). Im Fahren/Leerlauf Modus ist es leider nicht möglich
das Überstrom/Übertemperatur-Signal zuverlässig aus dem Chip der Treiberstufe
auszulesen.
dc-v2-bricklet
<uid> velocity-reached
¶Ausgabe: |
|
---|
Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit
erreicht wird. Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist, die
Beschleunigung auf 5000 und die Geschwindigkeit auf 10000 konfiguriert ist,
wird der velocity-reached
Callback nach ungefähr 2 Sekunden ausgelöst,
wenn die konfigurierte Geschwindigkeit letztendlich erreicht ist.
Bemerkung
Da es nicht möglich ist eine Rückmeldung vom Gleichstrommotor zu erhalten,
funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe
set-motion
) 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.
dc-v2-bricklet
<uid> current-velocity
¶Ausgabe: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
set-current-velocity-callback-configuration
, ausgelöst. Der Parameter ist die
aktuelle vom Motor genutzte Geschwindigkeit.
Der current-velocity
Callback wird nur nach Ablauf der Periode
ausgelöst, wenn sich die Geschwindigkeit geändert hat.
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.
dc-v2-bricklet
<uid> set-bootloader-mode
<mode>¶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>:
Für status:
dc-v2-bricklet
<uid> get-bootloader-mode
¶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:
dc-v2-bricklet
<uid> set-write-firmware-pointer
<pointer>¶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.
dc-v2-bricklet
<uid> write-firmware
<data>¶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.
dc-v2-bricklet
<uid> write-uid
<uid>¶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.
dc-v2-bricklet
<uid> read-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.