Shell - Industrial Digital In 4 Bricklet 2.0

Dies ist die Beschreibung der Shell API Bindings für das Industrial Digital In 4 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Digital In 4 Bricklet 2.0 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).

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 2.0

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

Callback

Download (example-callback.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 2.0

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

# Set period for value (channel 1) callback to 0.1s (100ms)
tinkerforge call industrial-digital-in-4-v2-bricklet $uid set-value-callback-configuration 1 100 false

echo "Press key to exit"; read dummy

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

Edge Count

Download (example-edge-count.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
#!/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 2.0

# Configure rising edge count (channel 3) with 10ms debounce
tinkerforge call industrial-digital-in-4-v2-bricklet $uid set-edge-count-configuration channel-3 edge-type-rising 10

# Get edge count 10 times with 1s delay
for i in 0 1 2 3 4 5 6 7 8 9; do
    sleep 1

    # Get current edge count
    tinkerforge call industrial-digital-in-4-v2-bricklet $uid get-edge-count channel-3 false
done

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 industrial-digital-in-4-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

Der call Befehl wird verwendet um eine Funktion des Industrial Digital In 4 Bricklet 2.0 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 2.0 an und endet dann
tinkerforge dispatch industrial-digital-in-4-v2-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> -- string
  • <callback> -- string

Der dispatch Befehl wird verwendet um eingehende Callbacks des Industrial Digital In 4 Bricklet 2.0 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 2.0 an und endet dann
tinkerforge call industrial-digital-in-4-v2-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 industrial-digital-in-4-v2-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 industrial-digital-in-4-v2-bricklet <uid> get-value
Ausgabe:
  • value -- bool,bool,bool,bool

Gibt die Eingangswerte als Bools zurück, true bedeutet logisch 1 und false logisch 0.

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> set-channel-led-config <channel> <config>
Parameter:
  • <channel> -- int (hat Symbole)
  • <config> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

Standardmäßig sind die LEDs für alle Kanäle auf Kanalstatus konfiguriert.

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

  • channel-0 = 0, für <channel>
  • channel-1 = 1, für <channel>
  • channel-2 = 2, für <channel>
  • channel-3 = 3, für <channel>
  • channel-led-config-off = 0, für <config>
  • channel-led-config-on = 1, für <config>
  • channel-led-config-show-heartbeat = 2, für <config>
  • channel-led-config-show-channel-status = 3, für <config>
tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-channel-led-config <channel>
Parameter:
  • <channel> -- int (hat Symbole)
Ausgabe:
  • config -- int (hat Symbole)

Gibt die Kanal-LED-Konfiguration zurück, wie von set-channel-led-config gesetzt.

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

  • channel-0 = 0, für <channel>
  • channel-1 = 1, für <channel>
  • channel-2 = 2, für <channel>
  • channel-3 = 3, für <channel>
  • channel-led-config-off = 0, für config
  • channel-led-config-on = 1, für config
  • channel-led-config-show-heartbeat = 2, für config
  • channel-led-config-show-channel-status = 3, für config

Fortgeschrittene Funktionen

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-edge-count <channel> <reset-counter>
Parameter:
  • <channel> -- int (hat Symbole)
  • <reset-counter> -- bool
Ausgabe:
  • count -- int

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

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

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

  • channel-0 = 0, für <channel>
  • channel-1 = 1, für <channel>
  • channel-2 = 2, für <channel>
  • channel-3 = 3, für <channel>
tinkerforge call industrial-digital-in-4-v2-bricklet <uid> set-edge-count-configuration <channel> <edge-type> <debounce>
Parameter:
  • <channel> -- int (hat Symbole)
  • <edge-type> -- int (hat Symbole)
  • <debounce> -- int
Ausgabe:

keine Ausgabe

Konfiguriert den Flankenzähler für einen bestimmten Kanal.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. 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:

  • channel-0 = 0, für <channel>
  • channel-1 = 1, für <channel>
  • channel-2 = 2, für <channel>
  • channel-3 = 3, für <channel>
  • edge-type-rising = 0, für <edge-type>
  • edge-type-falling = 1, für <edge-type>
  • edge-type-both = 2, für <edge-type>
tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-edge-count-configuration <channel>
Parameter:
  • <channel> -- int (hat Symbole)
Ausgabe:
  • edge-type -- int (hat Symbole)
  • debounce -- int

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

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

  • channel-0 = 0, für <channel>
  • channel-1 = 1, für <channel>
  • channel-2 = 2, für <channel>
  • channel-3 = 3, für <channel>
  • edge-type-rising = 0, für edge-type
  • edge-type-falling = 1, für edge-type
  • edge-type-both = 2, für edge-type
tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • error-count-ack-checksum -- int
  • error-count-message-checksum -- int
  • error-count-frame -- int
  • error-count-overflow -- int

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> set-bootloader-mode <mode>
Parameter:
  • <mode> -- int (hat Symbole)
Ausgabe:
  • status -- int (hat Symbole)

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • bootloader-mode-bootloader = 0, für <mode>
  • bootloader-mode-firmware = 1, für <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, für <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, für <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für <mode>
  • bootloader-status-ok = 0, für status
  • bootloader-status-invalid-mode = 1, für status
  • bootloader-status-no-change = 2, für status
  • bootloader-status-entry-function-not-present = 3, für status
  • bootloader-status-device-identifier-incorrect = 4, für status
  • bootloader-status-crc-mismatch = 5, für status
tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode -- int (hat Symbole)

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

  • bootloader-mode-bootloader = 0, für mode
  • bootloader-mode-firmware = 1, für mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, für mode
  • bootloader-mode-firmware-wait-for-reboot = 3, für mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für mode
tinkerforge call industrial-digital-in-4-v2-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> -- int
Ausgabe:

keine Ausgabe

Setzt den Firmware-Pointer für write-firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> write-firmware <data>
Parameter:
  • <data> -- int,int,..61x..,int
Ausgabe:
  • status -- int

Schreibt 64 Bytes Firmware an die Position die vorher von set-write-firmware-pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> set-status-led-config <config>
Parameter:
  • <config> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • status-led-config-off = 0, für <config>
  • status-led-config-on = 1, für <config>
  • status-led-config-show-heartbeat = 2, für <config>
  • status-led-config-show-status = 3, für <config>
tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-status-led-config
Ausgabe:
  • config -- int (hat Symbole)

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

  • status-led-config-off = 0, für config
  • status-led-config-on = 1, für config
  • status-led-config-show-heartbeat = 2, für config
  • status-led-config-show-status = 3, für config
tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-chip-temperature
Ausgabe:
  • temperature -- int

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> reset
Ausgabe:keine Ausgabe

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> write-uid <uid>
Parameter:
  • <uid> -- int
Ausgabe:

keine Ausgabe

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> read-uid
Ausgabe:
  • uid -- int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

tinkerforge call industrial-digital-in-4-v2-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 industrial-digital-in-4-v2-bricklet <uid> set-value-callback-configuration <channel> <period> <value-has-to-change>
Parameter:
  • <channel> -- int (hat Symbole)
  • <period> -- int
  • <value-has-to-change> -- bool
Ausgabe:

keine Ausgabe

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode in ms ist die Periode mit der der value Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Der Standardwert ist (0, false).

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

  • channel-0 = 0, für <channel>
  • channel-1 = 1, für <channel>
  • channel-2 = 2, für <channel>
  • channel-3 = 3, für <channel>
tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-value-callback-configuration <channel>
Parameter:
  • <channel> -- int (hat Symbole)
Ausgabe:
  • period -- int
  • value-has-to-change -- bool

Gibt die Callback-Konfiguration für den gegebenen Kanal zurück, wie mittels set-value-callback-configuration gesetzt.

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

  • channel-0 = 0, für <channel>
  • channel-1 = 1, für <channel>
  • channel-2 = 2, für <channel>
  • channel-3 = 3, für <channel>
tinkerforge call industrial-digital-in-4-v2-bricklet <uid> set-all-value-callback-configuration <period> <value-has-to-change>
Parameter:
  • <period> -- int
  • <value-has-to-change> -- bool
Ausgabe:

keine Ausgabe

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode in ms ist die Periode mit der der all-value Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Der Standardwert ist (0, false).

tinkerforge call industrial-digital-in-4-v2-bricklet <uid> get-all-value-callback-configuration
Ausgabe:
  • period -- int
  • value-has-to-change -- bool

Gibt die Callback-Konfiguration zurück, wie mittels set-all-value-callback-configuration gesetzt.

Callbacks

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

tinkerforge dispatch industrial-digital-in-4-v2-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 industrial-digital-in-4-v2-bricklet <uid> value
Ausgabe:
  • channel -- int (hat Symbole)
  • changed -- bool
  • value -- bool

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set-value-callback-configuration gesetzten Konfiguration

Die Parameter sind der Kanal, Changed und der Wert. Der changed-Parameter ist True wenn sich der Wert seit dem letzten Callback geändert hat.

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

  • channel-0 = 0, für channel
  • channel-1 = 1, für channel
  • channel-2 = 2, für channel
  • channel-3 = 3, für channel
tinkerforge dispatch industrial-digital-in-4-v2-bricklet <uid> all-value
Ausgabe:
  • changed -- bool,bool,bool,bool
  • value -- bool,bool,bool,bool

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set-all-value-callback-configuration gesetzten Konfiguration

Die Parameter sind der gleiche wie get-value. Zusätzlich ist der changed-Parameter True wenn sich der Wert seit dem letzten Callback geändert hat.