Shell - IO-4 Bricklet¶

Input¶

Download (example-input.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 IO-4 Bricklet

# Get current value as bitmask
tinkerforge call io4-bricklet $uid get-value

Output¶

Download (example-output.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

#!/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

# Set pin 1 to output low: 1 << 1 = 2
tinkerforge call io4-bricklet $uid set-configuration 2 direction-out false

# Set pin 2 and 3 to output high: (1 << 2) | (1 << 3) = 12
tinkerforge call io4-bricklet $uid set-configuration 12 direction-out true

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 IO-4 Bricklet

# Handle incoming interrupt callbacks
tinkerforge dispatch io4-bricklet $uid interrupt &

# Enable interrupt on pin 0: 1 << 0 = 1
tinkerforge call io4-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 io4-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

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

tinkerforge dispatch io4-bricklet [<option>..] <uid> <callback>¶

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

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

tinkerforge call io4-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 io4-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 io4-bricklet <uid> set-value <value-mask>¶

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

Setzt den Ausgangszustand (logisch 1 oder logisch 0) mittels einer Bitmaske (4Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Beispiel: Der Wert 3 bzw. 0b0011 setzt die Pins 0-1 auf logisch 1 und die Pins 2-3 auf logisch 0.

Alle laufenden Monoflop Timer werden abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Pins die als Eingang konfiguriert sind. Pull-Up Widerstände können mit set-configuration zugeschaltet werden.

tinkerforge call io4-bricklet <uid> get-value¶

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

Gibt eine Bitmaske der aktuell gemessenen Zustände zurück. Diese Funktion gibt die Zustände aller Pins zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.

tinkerforge call io4-bricklet <uid> set-configuration <selection-mask> <direction> <value>¶

Parameter:	<selection-mask> – Typ: Int, Wertebereich: [0 bis 15] <direction> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: i <value> – Typ: Bool, Standardwert: true
Ausgabe:	keine Ausgabe

Konfiguriert den Zustand und die Richtung eines angegebenen Pins. 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:

• (15, 'i', true) bzw. (0b1111, 'i', true) setzt alle Pins als Eingang mit Pull-Up.
• (8, 'i', false) bzw. (0b1000, 'i', false) setzt Pin 3 als Standard Eingang (potentialfrei wenn nicht verbunden).
• (3, 'o', false) bzw. (0b0011, 'o', false) setzt die Pins 0 und 1 als Ausgang im Zustand logisch 0.
• (4, 'o', true) bzw. (0b0100, 'o', true) setzt Pin 2 als Ausgang im Zustand logisch 1.

Laufende Monoflop Timer für die angegebenen Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

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

Für <direction>:

• direction-in = i
• direction-out = o

tinkerforge call io4-bricklet <uid> get-configuration¶

Ausgabe:	direction-mask – Typ: Int, Wertebereich: [0 bis 15] value-mask – Typ: Int, Wertebereich: [0 bis 15]

Gibt eine Bitmaske für die Richtung und eine Bitmaske für den Zustand der Pins zurück. Eine 1 in der Bitmaske für die Richtung bedeutet Eingang und eine 0 in der Bitmaske bedeutet Ausgang.

Beispiel: Ein Rückgabewert von (3, 5) bzw. (0b0011, 0b0101) für Richtung und Zustand bedeutet:

• Pin 0 ist als Eingang mit Pull-Up konfiguriert,
• Pin 1 ist als Standard Eingang konfiguriert,
• Pin 2 ist als Ausgang im Zustand logisch 1 konfiguriert und
• Pin 3 ist als Ausgang im Zustand logisch 0 konfiguriert.

tinkerforge call io4-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.

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen¶

tinkerforge call io4-bricklet <uid> set-monoflop <selection-mask> <value-mask> <time>¶

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

Konfiguriert einen Monoflop für die Pins, wie mittels der 4 Bit langen Bitmaske des ersten Parameters festgelegt. Die festgelegten Pins müssen als Ausgänge konfiguriert sein. Als Eingänge konfigurierte Pins werden ignoriert.

Der zweite Parameter ist eine Bitmaske mit den gewünschten Zustanden der festgelegten Ausgangspins. 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 logisch 0 und Pin 3 logisch 1 gesetzt.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-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 io4-bricklet <uid> get-monoflop <pin>¶

Parameter:	<pin> – Typ: Int, Wertebereich: [0 bis 3]
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 io4-bricklet <uid> set-selected-values <selection-mask> <value-mask>¶

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

Setzt den Ausgangszustand (logisch 1 oder logisch 0) mittels einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske hat eine Länge von 4 Bit, true bedeutet logisch 1 und false logisch 0.

Beispiel: Die Parameter (9, 4) bzw (0b0110, 0b0100) setzen den Pin 1 auf logisch 0 und den Pin 2 auf logisch 1. Die Pins 0 und 3 bleiben unangetastet.

Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Pins die als Eingang konfiguriert sind. Pull-Up Widerstände können mit set-configuration zugeschaltet werden.

tinkerforge call io4-bricklet <uid> set-edge-count-config <selection-mask> <edge-type> <debounce>¶

Parameter:	<selection-mask> – Typ: Int, Wertebereich: [0 bis 15] <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.

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 (Standard)
• 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 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 io4-bricklet <uid> get-edge-count-config <pin>¶

Parameter:	<pin> – Typ: Int, Wertebereich: [0 bis 3]
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 io4-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 io4-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 IO-4 Bricklet angeschlossen ist, wie z.B. eine Taste.

tinkerforge call io4-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 io4-bricklet <uid> set-interrupt <interrupt-mask>¶

Parameter:	<interrupt-mask> – Typ: Int, Wertebereich: [0 bis 15]
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 10 bzw. 0b1010 aktiviert den Interrupt für die Pins 1 und 3.

Der Interrupt wird mit dem interrupt Callback zugestellt.

tinkerforge call io4-bricklet <uid> get-interrupt¶

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

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 io4-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch io4-bricklet <uid> interrupt¶

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

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.

tinkerforge dispatch io4-bricklet <uid> monoflop-done¶

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

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