Shell - Industrial Digital In 4 Bricklet¶

Simple¶

Download (example-simple.sh)

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 Digital In 4 Bricklet

# Get current value as bitmask
tinkerforge call industrial-digital-in-4-bricklet $uid get-value

Interrupt¶

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 Industrial Digital In 4 Bricklet

# Handle incoming interrupt callbacks
tinkerforge dispatch industrial-digital-in-4-bricklet $uid interrupt &

# Enable interrupt on pin 0: 1 << 0 = 1
tinkerforge call industrial-digital-in-4-bricklet $uid set-interrupt 1

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Befehlsstruktur¶

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

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

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

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

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

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

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

tinkerforge call industrial-digital-in-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-in-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-in-4-bricklet <uid> get-value¶

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

Gibt die Ausgabewerte mit einer Bitmaske zurück. Die Bitmaske ist 16Bit lang. true bedeutet logisch 1 und false logisch 0.

Zum Beispiel: Der Wert 3 bzw. 0b0011 bedeutet, dass die Pins 0-1 auf logisch 1 und alle anderen auf logisch 0 sind.

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

tinkerforge call industrial-digital-in-4-bricklet <uid> get-edge-count <pin> <reset-counter>¶

Parameter:	<pin> – Typ: Int, Wertebereich: [0 bis 3] <reset-counter> – Typ: Bool
Ausgabe:	count – Typ: Int, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Pin zurück. Die zu zählenden Flanken können mit set-edge-count-config konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Die Flankenzähler benutzen die Gruppierung, wie von set-group gesetzt.

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen¶

tinkerforge call industrial-digital-in-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 In 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 In 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 get-value beide Bricklets gleichzeitig auszulesen.

Änderungen an der Gruppeneinteilung setzt die Konfiguration und Zählerwerte aller Flankenzähler zurück.

tinkerforge call industrial-digital-in-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-in-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-in-4-bricklet <uid> set-edge-count-config <selection-mask> <edge-type> <debounce>¶

Parameter:	<selection-mask> – Typ: Int, Wertebereich: [0 bis 216 - 1] <edge-type> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 <debounce> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100
Ausgabe:	keine Ausgabe

Konfiguriert den Flankenzähler für die ausgewählten Pins. Eine Bitmaske von 9 bzw. 0b1001 aktiviert den Flankenzähler für die Pins 0 und 3.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Pins die als Eingang konfiguriert sind. Mögliche Flankentypen sind:

• 0 = steigend
• 1 = fallend
• 2 = beide

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.

Die Flankenzähler benutzen die Gruppierung, wie von set-group gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für <edge-type>:

• edge-type-rising = 0
• edge-type-falling = 1
• edge-type-both = 2

Neu in Version 2.0.1 (Plugin).

tinkerforge call industrial-digital-in-4-bricklet <uid> get-edge-count-config <pin>¶

Parameter:	<pin> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:	edge-type – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 debounce – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Pin zurück, wie von set-edge-count-config gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für edge-type:

• edge-type-rising = 0
• edge-type-falling = 1
• edge-type-both = 2

Neu in Version 2.0.1 (Plugin).

tinkerforge call industrial-digital-in-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. 

Konfigurationsfunktionen für Callbacks¶

tinkerforge call industrial-digital-in-4-bricklet <uid> set-debounce-period <debounce>¶

Parameter:	<debounce> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Ausgabe:	keine Ausgabe

Setzt die Entprellperiode der interrupt Callback.

Beispiel: Wenn dieser Wert auf 100 gesetzt wird, erhält man den Interrupt maximal alle 100ms. Dies ist notwendig falls etwas prellendes an das Digital In 4 Bricklet angeschlossen ist, wie z.B. einen Schalter.

tinkerforge call industrial-digital-in-4-bricklet <uid> get-debounce-period¶

Ausgabe:	debounce – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set-debounce-period gesetzt.

tinkerforge call industrial-digital-in-4-bricklet <uid> set-interrupt <interrupt-mask>¶

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

Setzt durch eine Bitmaske die Pins für welche der Interrupt aktiv ist. Interrupts werden ausgelöst bei Änderung des Spannungspegels eines Pins, z.B. ein Wechsel von logisch 1 zu logisch 0 und logisch 0 zu logisch 1.

Beispiel: Eine Interrupt Bitmaske von 9 bzw. 0b1001 aktiviert den Interrupt für die Pins 0 und 3.

Die Interrupts benutzen die Gruppierung, wie von set-group gesetzt.

Der Interrupt wird mit dem interrupt Callback zugestellt.

tinkerforge call industrial-digital-in-4-bricklet <uid> get-interrupt¶

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

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

Callbacks¶

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

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

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch industrial-digital-in-4-bricklet <uid> interrupt¶

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

Dieser Callback wird ausgelöst sobald eine Änderung des Spannungspegels detektiert wird, an Pins für welche der Interrupt mit set-interrupt aktiviert wurde.

Die Rückgabewerte sind eine Bitmaske der aufgetretenen Interrupts und der aktuellen Zustände.

Beispiele:

• (1, 1) bzw. (0b0001, 0b0001) bedeutet, dass ein Interrupt am Pin 0 aufgetreten ist und aktuell Pin 0 logisch 1 ist und die Pins 1-3 logisch 0 sind.
• (9, 14) bzw. (0b1001, 0b1110) bedeutet, dass Interrupts an den Pins 0 und 3 aufgetreten sind und aktuell Pin 0 logisch 0 ist und die Pins 1-3 logisch 1 sind.

Die Interrupts benutzen die Gruppierung, wie von set-group gesetzt.