Dies ist die Beschreibung der Shell API Bindings für das Industrial Quad Relay Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Quad Relay Bricklet 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 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 Industrial Quad Relay Bricklet
# Turn relays alternating on/off 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 industrial-quad-relay-bricklet $uid set-value 1 # 1 << 0 = 1
sleep 0.1
tinkerforge call industrial-quad-relay-bricklet $uid set-value 2 # 1 << 1 = 2
sleep 0.1
tinkerforge call industrial-quad-relay-bricklet $uid set-value 4 # 1 << 2 = 4
sleep 0.1
tinkerforge call industrial-quad-relay-bricklet $uid set-value 8 # 1 << 3 = 8
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
industrial-quad-relay-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
Der call
Befehl wird verwendet um eine Funktion des Industrial Quad Relay Bricklet 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 Quad Relay Bricklet an
und endet danndispatch
industrial-quad-relay-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
Der dispatch
Befehl wird verwendet um eingehende Callbacks des Industrial Quad Relay Bricklet
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 Quad Relay Bricklet an
und endet dannindustrial-quad-relay-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-quad-relay-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-quad-relay-bricklet
<uid> set-value
<value-mask>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Ausgabewerte mit einer Bitmaske (16Bit). Eine 1 in der Bitmaske bedeutet Relais geschlossen und eine 0 in der Bitmaske bedeutet Relais offen.
Zum Beispiel: Der Wert 3 bzw. 0b0011 wird die Relais 0-1 schließen und alle anderen öffnen.
Falls keine Gruppen verwendet werden (siehe set-group
), entsprechen
die Pins der Beschriftung auf dem Industrial Quad Relay Bricklet.
Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.
Alle laufenden Monoflop Timer werden abgebrochen, wenn diese Funktion aufgerufen wird.
industrial-quad-relay-bricklet
<uid> set-monoflop
<selection-mask> <value-mask> <time>¶Parameter: |
|
---|---|
Ausgabe: |
|
Konfiguriert einen Monoflop für die Pins, wie mittels der Bitmaske des ersten Parameters festgelegt.
Der zweite Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Pins. Eine 1 in der Bitmaske bedeutet Relais geschlossen und eine 0 in der Bitmaske bedeutet Relais offen.
Der dritte Parameter stellt die Zeit dar, welche die Pins den Zustand halten sollen.
Wenn diese Funktion mit den Parametern (9, 1, 1500) bzw. (0b1001, 0b0001, 1500) aufgerufen wird: Pin 0 wird auf geschlossen und Pin 3 auf geöffnet gesetzt. Nach 1,5s wird Pin 0 wieder geöffnet und Pin 3 geschlossen.
Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Quad Relay Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Pin wird die gesamte Zeit im Zustand geschlossen sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Pin nach spätestens zwei Sekunden in den Zustand geöffnet wechseln.
industrial-quad-relay-bricklet
<uid> get-monoflop
<pin>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt (für den angegebenen Pin) 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.
industrial-quad-relay-bricklet
<uid> set-group
<group>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt eine Gruppe von Quad Relay Bricklets die zusammenarbeiten sollen.
Mögliche Gruppierungen können mit der Funktion get-available-for-group
gefunden werden.
Eine Gruppe besteht aus 4 Element. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.
Jedes Element kann entweder auf einen der Ports ('a' bis 'd') gesetzt werden oder falls nicht genutzt 'n' gesetzt werden.
Zum Beispiel: Falls zwei Quad Relay Bricklets mit Port A und Port B verbunden
sind, könnte diese Funktion mit ['a', 'b', 'n', 'n']
aufgerufen werden.
In diesem Fall wären die Pins von Port A den Werten 0-3 zugewiesen und
die Pins von Port B den Werten 4-7. Es ist jetzt möglich mit der Funktion
set-value
beide Bricklets gleichzeitig zu kontrollieren.
industrial-quad-relay-bricklet
<uid> get-group
¶Ausgabe: |
|
---|
Gibt die Gruppierung zurück, wie von set-group
gesetzt.
industrial-quad-relay-bricklet
<uid> get-available-for-group
¶Ausgabe: |
|
---|
Gibt eine Bitmaske von Ports zurück die für die Gruppierung zur Verfügung stehen. Zum Beispiel bedeutet der Wert 5 bzw. 0b0101: Port A und Port C sind mit Bricklets verbunden die zusammen gruppiert werden können.
industrial-quad-relay-bricklet
<uid> set-selected-values
<selection-mask> <value-mask>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Ausgabewerte mit einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske ist 16 Bit lang. true steht für ein geschlossenes Relais und false für ein offenes Relay.
Zum Beispiel: Die Werte (3, 1) bzw. (0b0011, 0b0001) wird das Relais 0 schließen, das Relais 1 öffnen und alle anderen unangetastet lassen.
Falls keine Gruppen verwendet werden (siehe set-group
), entsprechen
die Pins der Beschriftung auf dem Industrial Quad Relay Bricklet.
Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.
Laufende Monoflop Timer für die ausgewählten Relais werden abgebrochen, wenn diese Funktion aufgerufen wird.
industrial-quad-relay-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.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch industrial-quad-relay-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-quad-relay-bricklet
<uid> monoflop-done
¶Ausgabe: |
|
---|
Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (der Zustand nach dem Monoflop).