Dies ist die Beschreibung der Shell API Bindings für das IO-4 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IO-4 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 IO-4 Bricklet 2.0
# Get current value
tinkerforge call io4-v2-bricklet $uid get-value
|
Download (example-interrupt.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 IO-4 Bricklet 2.0
# Handle incoming input value callbacks
tinkerforge dispatch io4-v2-bricklet $uid input-value &
# Set period for input value (channel 1) callback to 0.5s (500ms)
tinkerforge call io4-v2-bricklet $uid set-input-value-callback-configuration 1 500 false
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
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 IO-4 Bricklet 2.0
# Configure channel 3 as output low
tinkerforge call io4-v2-bricklet $uid set-configuration 3 direction-out false
# Set channel 3 alternating high/low 10 times with 100 ms delay
for i in 0 1 2 3 4 5 6 7 8 9; do
sleep 0.1
tinkerforge call io4-v2-bricklet $uid set-selected-value 3 true
sleep 0.1
tinkerforge call io4-v2-bricklet $uid set-selected-value 3 false
done
|
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
io4-v2-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
Der call
Befehl wird verwendet um eine Funktion des IO-4 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 IO-4 Bricklet 2.0 an
und endet danndispatch
io4-v2-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
Der dispatch
Befehl wird verwendet um eingehende Callbacks des IO-4 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 IO-4 Bricklet 2.0 an
und endet dannio4-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.
io4-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)io4-v2-bricklet
<uid> set-value
<value>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Zustand aller vier Kanäle. Der Wert true bzw. false erzeugen logisch 1 bzw. logisch 0 auf dem entsprechenden Kanal.
Mit der Funktionen set-selected-value
können einzelnen Kanäle gesetzt
werden.
Beispiel: (True, True, False, False) setzt die Kanäle 0-1 auf logisch 1 und die Kanäle 2-3 auf logisch 0.
Alle laufenden Monoflop Timer und PWMs werden abgebrochen, wenn diese Funktion aufgerufen wird.
Bemerkung
Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert
sind. Pull-Up Widerstände können mit set-configuration
zugeschaltet
werden.
io4-v2-bricklet
<uid> get-value
¶Ausgabe: |
|
---|
Gibt die aktuell gemessenen Zustände zurück. Diese Funktion gibt die Zustände aller Kanäle zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.
io4-v2-bricklet
<uid> set-selected-value
<channel> <value>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Ausgabewert des ausgewählte Kanals ohne die anderen Kanäle zu beeinflussen.
Ein laufender Monoflop Timer oder PWM für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.
Bemerkung
Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert
sind. Pull-Up Widerstände können mit set-configuration
zugeschaltet
werden.
io4-v2-bricklet
<uid> set-configuration
<channel> <direction> <value>¶Parameter: |
|
---|---|
Ausgabe: |
|
Konfiguriert den Zustand und die Richtung eines angegebenen Kanals. Mögliche Richtungen sind 'i' und 'o' für Ein- und Ausgang.
Wenn die Richtung als Ausgang konfiguriert ist, ist der Zustand entweder logisch 1 oder logisch 0 (gesetzt als true oder false).
Wenn die Richtung als Eingang konfiguriert ist, ist der Zustand entweder Pull-Up oder Standard (gesetzt als true oder false).
Beispiele:
Ein laufender Monoflop Timer oder PWM für den angegebenen Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <direction>:
io4-v2-bricklet
<uid> get-configuration
<channel>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die Kanal-Konfiguration zurück, wie von set-configuration
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für direction:
io4-v2-bricklet
<uid> set-monoflop
<channel> <value> <time>¶Parameter: |
|
---|---|
Ausgabe: |
|
Der erste Parameter ist der gewünschte Zustand des Kanals (true bedeutet high und false low). Der zweite Parameter stellt die Zeit dar, in welcher der Kanal den Zustand halten soll.
Wenn diese Funktion mit den Parametern (true, 1500) aufgerufen wird: Der Kanal wird angeschaltet und nach 1,5s wieder ausgeschaltet.
Ein PWM für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.
Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-4 Bricklet 2.0 ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Kanal wird die gesamte Zeit eingeschaltet sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Kanal nach spätestens zwei Sekunden ausschalten.
io4-v2-bricklet
<uid> get-monoflop
<channel>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt (für den angegebenen Kanal) den aktuellen Zustand und die Zeit, wie von
set-monoflop
gesetzt, sowie die noch verbleibende Zeit bis zum
Zustandswechsel, zurück.
Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.
io4-v2-bricklet
<uid> get-edge-count
<channel> <reset-counter>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Kanal zurück.
Die zu zählenden Flanken können mit set-edge-count-configuration
konfiguriert werden.
Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.
Bemerkung
Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.
io4-v2-bricklet
<uid> set-edge-count-configuration
<channel> <edge-type> <debounce>¶Parameter: |
|
---|---|
Ausgabe: |
|
Konfiguriert den Flankenzähler für einen bestimmten Kanal.
Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Kanäle die als Eingang konfiguriert sind. Mögliche Flankentypen sind:
Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.
Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.
Bemerkung
Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <edge-type>:
io4-v2-bricklet
<uid> get-edge-count-configuration
<channel>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Kanal zurück,
wie von set-edge-count-configuration
gesetzt.
Bemerkung
Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für edge-type:
io4-v2-bricklet
<uid> set-pwm-configuration
<channel> <frequency> <duty-cycle>¶Parameter: |
|
---|---|
Ausgabe: |
|
Aktiviert ein PWM auf dem angegebenen Kanal.
Bevor diese Funktion aufgerufen wird, muss der Kanal als Ausgabe konfiguriert werden,
ansonsten wird ein "invalid parameter"-Fehler gemeldet. Um die PWM wieder auszustellen, kann die Frequenz auf
0 gesetzt werden oder eine andere Funktion aufgerufen werden die Einstellungen am
Kanal verändert (z.B. set-selected-value
).
Ein laufender Monoflop Timer für den angegebenen Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.
io4-v2-bricklet
<uid> get-pwm-configuration
<channel>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die PWM Konfiguration zurück, wie von set-pwm-configuration
gesetzt.
io4-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.
io4-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>:
io4-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:
io4-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.
io4-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.
io4-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.
io4-v2-bricklet
<uid> set-input-value-callback-configuration
<channel> <period> <value-has-to-change>¶Parameter: |
|
---|---|
Ausgabe: |
|
Dieser Callback kann pro Kanal konfiguriert werden.
Die Periode ist die Periode mit der der input-value
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.
io4-v2-bricklet
<uid> get-input-value-callback-configuration
<channel>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die Callback-Konfiguration für den gegebenen Kanal zurück, wie mittels
set-input-value-callback-configuration
gesetzt.
io4-v2-bricklet
<uid> set-all-input-value-callback-configuration
<period> <value-has-to-change>¶Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der all-input-value
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.
io4-v2-bricklet
<uid> get-all-input-value-callback-configuration
¶Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set-all-input-value-callback-configuration
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch io4-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.
io4-v2-bricklet
<uid> input-value
¶Ausgabe: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set-input-value-callback-configuration
gesetzten Konfiguration
Die Parameter sind der Kanal, Changed und der Wert. Der changed-Parameter ist True wenn sich der Wert seit dem letzten Callback geändert hat.
io4-v2-bricklet
<uid> all-input-value
¶Ausgabe: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set-all-input-value-callback-configuration
gesetzten Konfiguration
Die Parameter sind der gleiche wie get-value
. Zusätzlich ist der
changed-Parameter True wenn sich der Wert seit dem letzten Callback geändert hat.
io4-v2-bricklet
<uid> monoflop-done
¶Ausgabe: |
|
---|
Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten den Kanal und den aktuellen Zustand des Kanals (der Zustand nach dem Monoflop).
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.
io4-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:
io4-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:
io4-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.
io4-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.
io4-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.
io4-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.