Shell - Industrial Analog Out Bricklet 2.0

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

Download (example-simple-current.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
#!/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 Analog Out Bricklet 2.0

# Set output current to 4.5mA
tinkerforge call industrial-analog-out-v2-bricklet $uid set-current 4500
tinkerforge call industrial-analog-out-v2-bricklet $uid set-enabled true

echo "Press key to exit"; read dummy

tinkerforge call industrial-analog-out-v2-bricklet $uid set-enabled false

Simple Voltage

Download (example-simple-voltage.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
#!/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 Analog Out Bricklet 2.0

# Set output voltage to 3.3V
tinkerforge call industrial-analog-out-v2-bricklet $uid set-voltage 3300
tinkerforge call industrial-analog-out-v2-bricklet $uid set-enabled true

echo "Press key to exit"; read dummy

tinkerforge call industrial-analog-out-v2-bricklet $uid set-enabled false

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-analog-out-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Industrial Analog Out 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 Analog Out Bricklet 2.0 an und endet dann
tinkerforge dispatch industrial-analog-out-v2-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Industrial Analog Out 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 Analog Out Bricklet 2.0 an und endet dann
tinkerforge call industrial-analog-out-v2-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-analog-out-v2-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-analog-out-v2-bricklet <uid> set-enabled <enabled>
Parameter:
  • <enabled> – Typ: Bool, Standardwert: false
Ausgabe:
  • keine Ausgabe

Aktiviert/deaktiviert die Ausgabe von Spannung und Strom.

tinkerforge call industrial-analog-out-v2-bricklet <uid> get-enabled
Ausgabe:
  • enabled – Typ: Bool, Standardwert: false

Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.

tinkerforge call industrial-analog-out-v2-bricklet <uid> set-voltage <voltage>
Parameter:
  • <voltage> – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 10000]
Ausgabe:
  • keine Ausgabe

Setzt die Ausgangsspannung.

Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.

tinkerforge call industrial-analog-out-v2-bricklet <uid> get-voltage
Ausgabe:
  • voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 10000]

Gibt die Spannung zurück, wie von set-voltage gesetzt.

tinkerforge call industrial-analog-out-v2-bricklet <uid> set-current <current>
Parameter:
  • <current> – Typ: Int, Einheit: 1 µA, Wertebereich: [0 bis 24000]
Ausgabe:
  • keine Ausgabe

Setzt den Ausgangsstrom.

Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.

tinkerforge call industrial-analog-out-v2-bricklet <uid> get-current
Ausgabe:
  • current – Typ: Int, Einheit: 1 µA, Wertebereich: [0 bis 24000]

Gibt die Spannung zurück, wie von set-current gesetzt.

tinkerforge call industrial-analog-out-v2-bricklet <uid> set-out-led-config <config>
Parameter:
  • <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:
  • keine Ausgabe

Die Out LED kann an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der "Out-Status" angezeigt werden. Falls Out-Status gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des Ausgabewertes (Spannung oder Strom) skaliert werden.

Das Verhalten des Out-Status kann mittels set-out-led-status-config eingestellt werden.

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

Für <config>:

  • out-led-config-off = 0
  • out-led-config-on = 1
  • out-led-config-show-heartbeat = 2
  • out-led-config-show-out-status = 3
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-out-led-config
Ausgabe:
  • config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

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

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

Für config:

  • out-led-config-off = 0
  • out-led-config-on = 1
  • out-led-config-show-heartbeat = 2
  • out-led-config-show-out-status = 3
tinkerforge call industrial-analog-out-v2-bricklet <uid> set-out-led-status-config <min> <max> <config>
Parameter:
  • <min> – Typ: Int, Wertebereich: [0 bis 24000], Standardwert: 0
  • <max> – Typ: Int, Wertebereich: [0 bis 24000], Standardwert: 10000
  • <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
Ausgabe:
  • keine Ausgabe

Setzt die Out-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Out-LED auf Out-Status eingestellt ist, siehe set-out-led-config.

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert über 5V steigt und wieder ausgeschaltet sobald der Ausgabewert unter 5V fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert unter 5V fällt und wieder ausgeschaltet sobald der Ausgabewert über 5V steigt.

Im Intensitätsmodus kann ein Bereich in mV oder µA angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=2V und max=8V: Die LED ist bei 2V und darunter aus, bei 8V und darüber an und zwischen 2V und 8V wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

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

Für <config>:

  • out-led-status-config-threshold = 0
  • out-led-status-config-intensity = 1
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-out-led-status-config
Ausgabe:
  • min – Typ: Int, Wertebereich: [0 bis 24000], Standardwert: 0
  • max – Typ: Int, Wertebereich: [0 bis 24000], Standardwert: 10000
  • config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1

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

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

Für config:

  • out-led-status-config-threshold = 0
  • out-led-status-config-intensity = 1

Fortgeschrittene Funktionen

tinkerforge call industrial-analog-out-v2-bricklet <uid> set-configuration <voltage-range> <current-range>
Parameter:
  • <voltage-range> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
  • <current-range> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:
  • keine Ausgabe

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

  • 0V bis 5V
  • 0V bis 10V

Einstellbare Stromwertebereiche sind:

  • 4mA bis 20mA
  • 0mA bis 20mA
  • 0mA bis 24mA

Die Auflösung ist immer 12 Bit. Dass heißt, die Genauigkeit erhöht sich bei kleineren Wertebereichen.

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

Für <voltage-range>:

  • voltage-range-0-to-5v = 0
  • voltage-range-0-to-10v = 1

Für <current-range>:

  • current-range-4-to-20ma = 0
  • current-range-0-to-20ma = 1
  • current-range-0-to-24ma = 2
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-configuration
Ausgabe:
  • voltage-range – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
  • current-range – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von set-configuration gesetzt.

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

Für voltage-range:

  • voltage-range-0-to-5v = 0
  • voltage-range-0-to-10v = 1

Für current-range:

  • current-range-4-to-20ma = 0
  • current-range-0-to-20ma = 1
  • current-range-0-to-24ma = 2
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-frame – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-overflow – Typ: Int, Wertebereich: [0 bis 232 - 1]

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-analog-out-v2-bricklet <uid> set-bootloader-mode <mode>
Parameter:
  • <mode> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • status – Typ: Int, Wertebereich: Siehe 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 Bootloader- 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:

Für <mode>:

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4

Für status:

  • bootloader-status-ok = 0
  • bootloader-status-invalid-mode = 1
  • bootloader-status-no-change = 2
  • bootloader-status-entry-function-not-present = 3
  • bootloader-status-device-identifier-incorrect = 4
  • bootloader-status-crc-mismatch = 5
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode – Typ: Int, Wertebereich: Siehe Symbole

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

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

Für mode:

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4
tinkerforge call industrial-analog-out-v2-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
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-analog-out-v2-bricklet <uid> write-firmware <data>
Parameter:
  • <data> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:
  • status – Typ: Int, Wertebereich: [0 bis 255]

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-analog-out-v2-bricklet <uid> set-status-led-config <config>
Parameter:
  • <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
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:

Für <config>:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-status-led-config
Ausgabe:
  • config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

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

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

Für config:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-chip-temperature
Ausgabe:
  • temperature – Typ: Int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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-analog-out-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-analog-out-v2-bricklet <uid> write-uid <uid>
Parameter:
  • <uid> – Typ: Int, Wertebereich: [0 bis 232 - 1]
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-analog-out-v2-bricklet <uid> read-uid
Ausgabe:
  • uid – Typ: Int, Wertebereich: [0 bis 232 - 1]

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-analog-out-v2-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, i, 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden.