Shell - Industrial Analog Out Bricklet

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

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

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

echo "Press key to exit"; read dummy

tinkerforge call industrial-analog-out-bricklet $uid disable

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

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

echo "Press key to exit"; read dummy

tinkerforge call industrial-analog-out-bricklet $uid disable

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-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 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 an und endet dann
tinkerforge dispatch industrial-analog-out-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Industrial Analog Out 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 Analog Out Bricklet an und endet dann
tinkerforge call industrial-analog-out-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-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-bricklet <uid> enable
Ausgabe:
  • keine Ausgabe

Aktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

tinkerforge call industrial-analog-out-bricklet <uid> disable
Ausgabe:
  • keine Ausgabe

Deaktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

tinkerforge call industrial-analog-out-bricklet <uid> is-enabled
Ausgabe:
  • enabled – Typ: Bool

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

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

Setzt die Ausgangsspannung in mV.

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

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

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

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

Setzt den Ausgangsstrom in µA.

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

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

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

Fortgeschrittene Funktionen

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

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

  • 0V bis 5V
  • 0V bis 10V (Standard)

Einstellbare Stromwertebereiche sind:

  • 4mA bis 20mA (Standard)
  • 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-bricklet <uid> get-configuration
Ausgabe:
  • voltage-range – Typ: Int, Wertebereich: Siehe Symbole
  • current-range – Typ: Int, Wertebereich: Siehe Symbole

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-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
  • hardware-version – Typ: Int Array, Länge: 3, Wertebereich: [0 bis 255]
  • firmware-version – Typ: Int Array, Länge: 3, 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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden.