Shell - IO-16 Bricklet

Dies ist die Beschreibung der Shell API Bindings für das IO-16 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IO-16 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Shell API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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-16 Bricklet

# Get current value from port A as bitmask
tinkerforge call io16-bricklet $uid get-port a

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-16 Bricklet

# Set pin 0 on port A to output low: 1 << 0 = 1
tinkerforge call io16-bricklet $uid set-port-configuration a 1 direction-out false

# Set pin 0 and 7 on port B to output high: (1 << 0) | (1 << 7) = 129
tinkerforge call io16-bricklet $uid set-port-configuration b 129 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-16 Bricklet

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

# Enable interrupt on pin 2 of port A: 1 << 2 = 4
tinkerforge call io16-bricklet $uid set-port-interrupt a 4

echo "Press key to exit"; read dummy

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

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

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

tinkerforge call io16-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

Der call Befehl wird verwendet um eine Funktion des IO-16 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-16 Bricklet an und endet dann
tinkerforge dispatch io16-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> -- string
  • <callback> -- string

Der dispatch Befehl wird verwendet um eingehende Callbacks des IO-16 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-16 Bricklet an und endet dann
tinkerforge call io16-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- 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 io16-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> -- string
  • <callback> -- 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 io16-bricklet <uid> set-port <port> <value-mask>
Parameter:
  • <port> -- char
  • <value-mask> -- int
Ausgabe:

keine Ausgabe

Setzt den Ausgangszustand (logisch 1 oder logisch 0) für einen Port ("a" oder "b") mittels einer Bitmaske (8Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Beispiel: Der Wert 15 bzw. 0b00001111 setzt die Pins 0-3 auf logisch 1 und die Pins 4-7 auf logisch 0.

Alle laufenden Monoflop Timer für den angegebenen Port 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-port-configuration zugeschaltet werden.

tinkerforge call io16-bricklet <uid> get-port <port>
Parameter:
  • <port> -- char
Ausgabe:
  • value-mask -- int

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

tinkerforge call io16-bricklet <uid> set-port-configuration <port> <selection-mask> <direction> <value>
Parameter:
  • <port> -- char
  • <selection-mask> -- int
  • <direction> -- char (hat Symbole)
  • <value> -- bool
Ausgabe:

keine Ausgabe

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

  • ('a', 255, 'i', true) bzw. ('a', 0b11111111, 'i', true) setzt alle Pins des Ports a als Eingang mit Pull-Up.
  • ('a', 128, 'i', false) bzw. ('a', 0b10000000, 'i', false) setzt Pin 7 des Ports A als Standard Eingang (potentialfrei wenn nicht verbunden).
  • ('b', 3, 'o', false) bzw. ('b', 0b00000011, 'o', false) setzt die Pins 0 und 1 des Ports B als Ausgang im Zustand logisch 0.
  • ('b', 4, 'o', true) bzw. ('b', 0b00000100, 'o', true) setzt Pin 2 des Ports B als Ausgang im Zustand logisch 1.

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

Die Standardkonfiguration ist Eingang mit Pull-Up.

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

  • direction-in = i, für <direction>
  • direction-out = o, für <direction>
tinkerforge call io16-bricklet <uid> get-port-configuration <port>
Parameter:
  • <port> -- char
Ausgabe:
  • direction-mask -- int
  • value-mask -- int

Gibt eine Bitmaske für die Richtung und eine Bitmaske für den Zustand der Pins des gewählten Ports 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 (15, 51) bzw. (0b00001111, 0b00110011) für Richtung und Zustand bedeutet:

  • Pin 0 und 1 sind als Eingang mit Pull-Up konfiguriert,
  • Pin 2 und 3 sind als Standard Eingang konfiguriert,
  • Pin 4 und 5 sind als Ausgang im Zustand logisch 1 konfiguriert
  • und Pin 6 und 7 sind als Ausgang im Zustand logisch 0 konfiguriert.
tinkerforge call io16-bricklet <uid> get-edge-count <pin> <reset-counter>
Parameter:
  • <pin> -- int
  • <reset-counter> -- bool
Ausgabe:
  • count -- int

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Pin von Port A 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.3 (Plugin).

Fortgeschrittene Funktionen

tinkerforge call io16-bricklet <uid> set-port-monoflop <port> <selection-mask> <value-mask> <time>
Parameter:
  • <port> -- char
  • <selection-mask> -- int
  • <value-mask> -- int
  • <time> -- int
Ausgabe:

keine Ausgabe

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

Der dritte Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Ausgangspins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Der vierte Parameter stellt die Zeit (in ms) dar, welche die Pins den Zustand halten sollen.

Wenn diese Funktion mit den Parametern ('a', 9, 1, 1500) bzw. ('a', 0b00001001, 0b00000001, 1500) aufgerufen wird: Pin 0 wird auf logisch 1 und Pin 3 auf logisch 0 am Port 'a' 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-16 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 io16-bricklet <uid> get-port-monoflop <port> <pin>
Parameter:
  • <port> -- char
  • <pin> -- int
Ausgabe:
  • value -- int
  • time -- int
  • time-remaining -- int

Gibt (für den angegebenen Pin) den aktuellen Zustand und die Zeit, wie von set-port-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 io16-bricklet <uid> set-selected-values <port> <selection-mask> <value-mask>
Parameter:
  • <port> -- char
  • <selection-mask> -- int
  • <value-mask> -- int
Ausgabe:

keine Ausgabe

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

Beispiel: Die Parameter ('a', 192, 128) bzw. ('a', 0b11000000, 0b10000000) setzen den Pin 7 auf logisch 1 und den Pin 6 auf logisch 0 an Port A. Die Pins 0-6 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-port-configuration zugeschaltet werden.

tinkerforge call io16-bricklet <uid> set-edge-count-config <pin> <edge-type> <debounce>
Parameter:
  • <pin> -- int
  • <edge-type> -- int (hat Symbole)
  • <debounce> -- int
Ausgabe:

keine Ausgabe

Konfiguriert den Flankenzähler für den ausgewählten Pin von Port A. Der Flankenzähler steht für Pins 0 und 1 zur Verfügung.

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

Die Entprellzeit (debounce) wird in ms angegeben.

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.

Standardwerte: 0 (edge type) und 100ms (debounce).

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

  • edge-type-rising = 0, für <edge-type>
  • edge-type-falling = 1, für <edge-type>
  • edge-type-both = 2, für <edge-type>

Neu in Version 2.0.3 (Plugin).

tinkerforge call io16-bricklet <uid> get-edge-count-config <pin>
Parameter:
  • <pin> -- int
Ausgabe:
  • edge-type -- int (hat Symbole)
  • debounce -- int

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

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

  • edge-type-rising = 0, für edge-type
  • edge-type-falling = 1, für edge-type
  • edge-type-both = 2, für edge-type

Neu in Version 2.0.3 (Plugin).

tinkerforge call io16-bricklet <uid> get-identity
Ausgabe:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (hat Symbole)

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

tinkerforge call io16-bricklet <uid> set-debounce-period <debounce>
Parameter:
  • <debounce> -- int
Ausgabe:

keine Ausgabe

Setzt die Entprellperiode der interrupt Callback in ms.

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-16 Bricklet angeschlossen ist, wie z.B. eine Taste.

Der Standardwert ist 100.

tinkerforge call io16-bricklet <uid> get-debounce-period
Ausgabe:
  • debounce -- int

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

tinkerforge call io16-bricklet <uid> set-port-interrupt <port> <interrupt-mask>
Parameter:
  • <port> -- char
  • <interrupt-mask> -- int
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: ('a', 129) bzw. ('a', 0b10000001) aktiviert den Interrupt für die Pins 0 und 7 des Ports a.

Der Interrupt wird mit dem interrupt Callback zugestellt.

tinkerforge call io16-bricklet <uid> get-port-interrupt <port>
Parameter:
  • <port> -- char
Ausgabe:
  • interrupt-mask -- int

Gibt die Interrupt Bitmaske für den angegebenen Port zurück, wie von set-port-interrupt gesetzt.

Callbacks

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

tinkerforge dispatch io16-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.

tinkerforge dispatch io16-bricklet <uid> interrupt
Ausgabe:
  • port -- char
  • interrupt-mask -- int
  • value-mask -- int

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

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

Beispiele:

  • ('a', 1, 1) bzw. ('a', 0b00000001, 0b00000001) bedeutet, dass an Port A ein Interrupt am Pin 0 aufgetreten ist und aktuell ist Pin 0 logisch 1 und die Pins 1-7 sind logisch 0.
  • ('b', 129, 254) bzw. ('b', 0b10000001, 0b11111110) bedeutet, dass an Port B Interrupts an den Pins 0 und 7 aufgetreten sind und aktuell ist Pin 0 logisch 0 und die Pins 1-7 sind logisch 1.
tinkerforge dispatch io16-bricklet <uid> monoflop-done
Ausgabe:
  • port -- char
  • selection-mask -- int
  • value-mask -- int

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten den Port, die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (der Zustand nach dem Monoflop).