Dies ist die Beschreibung der Shell API Bindings für das Industrial Dual 0-20mA Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual 0-20mA 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).
1 2 3 4 5 6 7 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0
# Get current current from channel 0
tinkerforge call industrial-dual-0-20ma-v2-bricklet $uid get-current 0
|
Download (example-callback.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0
# Handle incoming current callbacks
tinkerforge dispatch industrial-dual-0-20ma-v2-bricklet $uid current &
# Set period for current (channel 0) callback to 1s (1000ms) without a threshold
tinkerforge call industrial-dual-0-20ma-v2-bricklet $uid set-current-callback-configuration 0 1000 false threshold-option-off 0 0
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
Download (example-threshold.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0
# Handle incoming current callbacks
tinkerforge dispatch industrial-dual-0-20ma-v2-bricklet $uid current &
# Configure threshold for current (channel 0) "greater than 10 mA"
# with a debounce period of 10s (10000ms)
tinkerforge call industrial-dual-0-20ma-v2-bricklet $uid set-current-callback-configuration 0 10000 false threshold-option-greater 10000000 0
echo "Press key to exit"; read dummy
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
industrial-dual-0-20ma-v2-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
Der call
Befehl wird verwendet um eine Funktion des Industrial Dual 0-20mA 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 Industrial Dual 0-20mA Bricklet 2.0 an
und endet danndispatch
industrial-dual-0-20ma-v2-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
Der dispatch
Befehl wird verwendet um eingehende Callbacks des Industrial Dual 0-20mA 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 Industrial Dual 0-20mA Bricklet 2.0 an
und endet dannindustrial-dual-0-20ma-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.
industrial-dual-0-20ma-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)industrial-dual-0-20ma-v2-bricklet
<uid> get-current
<channel>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die gemessenen Stromstärke des spezifizierten Kanals zurück.
Es ist möglich zu erkennen ob ein IEC 60381-1-kompatibler Sensor angeschlossen ist und ob er funktionsfähig ist.
Falls die zurückgegebene Stromstärke kleiner als 4mA ist, ist wahrscheinlich kein Sensor angeschlossen oder der Sensor ist defekt. Falls die zurückgegebene Stromstärke über 20mA ist, besteht entweder ein Kurzschluss oder der Sensor ist defekt. Somit ist erkennbar ob ein Sensor angeschlossen und funktionsfähig ist.
Wenn der Wert periodisch benötigt wird, kann auch der current
Callback
verwendet werden. Der Callback wird mit der Funktion
set-current-callback-configuration
konfiguriert.
industrial-dual-0-20ma-v2-bricklet
<uid> set-channel-led-config
<channel> <config>¶Parameter: |
|
---|---|
Ausgabe: |
|
Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des gemessenen Wertes skaliert werden.
Das Verhalten des Kanalstatus kann mittels set-channel-led-status-config
eingestellt werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <config>:
industrial-dual-0-20ma-v2-bricklet
<uid> get-channel-led-config
<channel>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die Kanal-LED-Konfiguration zurück, wie von set-channel-led-config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
industrial-dual-0-20ma-v2-bricklet
<uid> set-channel-led-status-config
<channel> <min> <max> <config>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Kanal-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn
die Kanal-LED auf Kanalstatus eingestellt ist, siehe set-channel-led-config
.
Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.
Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in nA gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 10mA wird die LED eingeschaltet sobald der gemessene Strom über 10mA steigt und wieder ausgeschaltet sobald der Strom unter 10mA fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in nA gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 10mA wird die LED eingeschaltet sobald der gemessene Strom unter 10mA fällt und wieder ausgeschaltet sobald der Strom über 10mA steigt.
Im Intensitätsmodus kann ein Bereich in nA angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=4mA und max=20mA: Die LED ist bei 4mA und darunter aus, bei 20mA und darüber an und zwischen 4mA und 20mA wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <config>:
industrial-dual-0-20ma-v2-bricklet
<uid> get-channel-led-status-config
<channel>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die Kanal-LED-Status-Konfiguration zurück, wie von
set-channel-led-status-config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
industrial-dual-0-20ma-v2-bricklet
<uid> set-sample-rate
<rate>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Abtastrate auf 240, 60, 15 oder 4 Samples pro Sekunde. Die Auflösung für die Raten sind 12, 14, 16 und 18 Bit respektive.
Wert | Beschreibung |
---|---|
0 | 240 Samples pro Sekunde, 12 Bit Auflösung |
1 | 60 Samples pro Sekunde, 14 Bit Auflösung |
2 | 15 Samples pro Sekunde, 16 Bit Auflösung |
3 | 4 Samples pro Sekunde, 18 Bit Auflösung |
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <rate>:
industrial-dual-0-20ma-v2-bricklet
<uid> get-sample-rate
¶Ausgabe: |
|
---|
Gibt die Abtastrate zurück, wie von set-sample-rate
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für rate:
industrial-dual-0-20ma-v2-bricklet
<uid> set-gain
<gain>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Verstärkung zwischen 1x und 8x. Wenn ein sehr kleiner Strom gemessen werden soll, dann kann die Verstärkung hochgesetzt werden, um die Auflösung zu verbessern.
Beispiel: Wenn 0,5mA gemessen werden mit einer Verstärkung von 8x dann wird 4mA zurückgegeben.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <gain>:
industrial-dual-0-20ma-v2-bricklet
<uid> get-gain
¶Ausgabe: |
|
---|
Gibt die Verstärkung zurück, wie von set-gain
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für gain:
industrial-dual-0-20ma-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.
industrial-dual-0-20ma-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>:
industrial-dual-0-20ma-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:
industrial-dual-0-20ma-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.
industrial-dual-0-20ma-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.
industrial-dual-0-20ma-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.
industrial-dual-0-20ma-v2-bricklet
<uid> set-current-callback-configuration
<channel> <period> <value-has-to-change> <option> <min> <max>¶Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der current
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.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den current
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <option>:
industrial-dual-0-20ma-v2-bricklet
<uid> get-current-callback-configuration
<channel>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die Callback-Konfiguration zurück, wie mittels set-current-callback-configuration
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch industrial-dual-0-20ma-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.
industrial-dual-0-20ma-v2-bricklet
<uid> current
¶Ausgabe: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set-current-callback-configuration
gesetzten Konfiguration
Der Parameter ist der gleiche wie get-current
.
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.
industrial-dual-0-20ma-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:
industrial-dual-0-20ma-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:
industrial-dual-0-20ma-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.
industrial-dual-0-20ma-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.
industrial-dual-0-20ma-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.
industrial-dual-0-20ma-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.