Shell - Industrial Digital Out 4 Bricklet¶

Simple¶

Download (example-simple.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 Industrial Digital Out 4 Bricklet

# Set pins alternating high/low 10 times with 100ms delay
for i in 0 1 2 3 4 5 6 7 8 9; do
    sleep 0.1
    tinkerforge call industrial-digital-out-4-bricklet $uid set-value 1 # 1 << 0 = 1
    sleep 0.1
    tinkerforge call industrial-digital-out-4-bricklet $uid set-value 2 # 1 << 1 = 2
    sleep 0.1
    tinkerforge call industrial-digital-out-4-bricklet $uid set-value 4 # 1 << 2 = 4
    sleep 0.1
    tinkerforge call industrial-digital-out-4-bricklet $uid set-value 8 # 1 << 3 = 8
done

Befehlsstruktur¶

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

tinkerforge call industrial-digital-out-4-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Industrial Digital Out 4 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 Digital Out 4 Bricklet an und endet dann

tinkerforge dispatch industrial-digital-out-4-bricklet [<option>..] <uid> <callback>¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Industrial Digital Out 4 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 Digital Out 4 Bricklet an und endet dann

tinkerforge call industrial-digital-out-4-bricklet <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 industrial-digital-out-4-bricklet <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 industrial-digital-out-4-bricklet <uid> set-value <value-mask>¶

Parameter:	<value-mask> – Typ: Int, Wertebereich: [0 bis 216 - 1]
Ausgabe:	keine Ausgabe

Setzt die Ausgabewerte mit einer Bitmaske (16Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Zum Beispiel: Der Wert 3 bzw. 0b0011 wird die Pins 0-1 auf logisch 1 und alle anderen auf logisch 0 setzen.

Falls keine Gruppen verwendet werden (siehe set-group), entsprechen die Pins der Beschriftung auf dem Industrial Digital Out 4 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.

tinkerforge call industrial-digital-out-4-bricklet <uid> get-value¶

Ausgabe:	value-mask – Typ: Int, Wertebereich: [0 bis 216 - 1]

Gibt die Bitmaske zurück, wie von set-value gesetzt.

tinkerforge call industrial-digital-out-4-bricklet <uid> set-selected-values <selection-mask> <value-mask>¶

Parameter:	<selection-mask> – Typ: Int, Wertebereich: [0 bis 216 - 1] <value-mask> – Typ: Int, Wertebereich: [0 bis 216 - 1]
Ausgabe:	keine Ausgabe

Setzt die Ausgabewerte mit einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske ist 16 Bit lang. true bedeutet logisch 1 und false logisch 0.

Zum Beispiel: Die Werte (3, 1) bzw. (0b0011, 0b0001) werden den Pin 0 auf logisch 1 und den Pin 1 auf logisch 0 setzen. Alle anderen Pins bleiben unangetastet.

Falls keine Gruppen verwendet werden (siehe set-group), entsprechen die Pins der Beschriftung auf dem Industrial Digital Out 4 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 Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

Fortgeschrittene Funktionen¶

tinkerforge call industrial-digital-out-4-bricklet <uid> set-monoflop <selection-mask> <value-mask> <time>¶

Parameter:	<selection-mask> – Typ: Int, Wertebereich: [0 bis 216 - 1] <value-mask> – Typ: Int, Wertebereich: [0 bis 216 - 1] <time> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Ausgabe:	keine 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 logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

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 logisch 1 und Pin 3 auf logisch 0 gesetzt. Nach 1,5s wird Pin 0 wieder auf logisch 0 und Pin 3 auf logisch 1 gesetzt.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Digital Out 4 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 logisch 1 sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Pin nach spätestens zwei Sekunden in den Zustand logisch 0 wechseln.

tinkerforge call industrial-digital-out-4-bricklet <uid> get-monoflop <pin>¶

Parameter:	<pin> – Typ: Int, Wertebereich: [0 bis 15]
Ausgabe:	value – Typ: Int, Wertebereich: [0 bis 1] time – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] time-remaining – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

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.

tinkerforge call industrial-digital-out-4-bricklet <uid> set-group <group>¶

Parameter:	<group> – Typ: Char Array, Länge: 4, Wertebereich: [a bis d, n]
Ausgabe:	keine Ausgabe

Setzt eine Gruppe von Digital Out 4 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 Digital Out 4 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.

tinkerforge call industrial-digital-out-4-bricklet <uid> get-group¶

Ausgabe:	group – Typ: Char Array, Länge: 4, Wertebereich: [a bis d, n]

Gibt die Gruppierung zurück, wie von set-group gesetzt.

tinkerforge call industrial-digital-out-4-bricklet <uid> get-available-for-group¶

Ausgabe:	available – Typ: Int, Wertebereich: [0 bis 15]

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.

tinkerforge call industrial-digital-out-4-bricklet <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: [a bis h, z] 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 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¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch industrial-digital-out-4-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch industrial-digital-out-4-bricklet <uid> monoflop-done¶

Ausgabe:	selection-mask – Typ: Int, Wertebereich: [0 bis 216 - 1] value-mask – Typ: Int, Wertebereich: [0 bis 216 - 1]

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