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.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example-simple-current.sh)
1#!/bin/sh
2# Connects to localhost:4223 by default, use --host and --port to change this
3
4uid=XYZ # Change XYZ to the UID of your Industrial Analog Out Bricklet
5
6# Set output current to 4.5mA
7tinkerforge call industrial-analog-out-bricklet $uid set-current 4500
8tinkerforge call industrial-analog-out-bricklet $uid enable
9
10echo "Press key to exit"; read dummy
11
12tinkerforge call industrial-analog-out-bricklet $uid disable
Download (example-simple-voltage.sh)
1#!/bin/sh
2# Connects to localhost:4223 by default, use --host and --port to change this
3
4uid=XYZ # Change XYZ to the UID of your Industrial Analog Out Bricklet
5
6# Set output voltage to 3.3V
7tinkerforge call industrial-analog-out-bricklet $uid set-voltage 3300
8tinkerforge call industrial-analog-out-bricklet $uid enable
9
10echo "Press key to exit"; read dummy
11
12tinkerforge call industrial-analog-out-bricklet $uid disable
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
Allgemeine Optionen des call und des dispatch Befehls sind
hier zu finden. Im Folgenden wird die spezifische
Befehlsstruktur dargestellt.
| Parameter: |
|
|---|
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
| Parameter: |
|
|---|
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
| Parameter: |
|
|---|
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.
| Parameter: |
|
|---|
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)
| Ausgabe: |
|
|---|
Aktiviert die Ausgabe von Spannung und Strom.
Der Standardwert ist deaktiviert.
| Ausgabe: |
|
|---|
Deaktiviert die Ausgabe von Spannung und Strom.
Der Standardwert ist deaktiviert.
| Ausgabe: |
|
|---|
Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt die Ausgangsspannung.
Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.
| Ausgabe: |
|
|---|
Gibt die Spannung zurück, wie von set-voltage gesetzt.
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt den Ausgangsstrom.
Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.
| Ausgabe: |
|
|---|
Gibt die Spannung zurück, wie von set-current gesetzt.
| Parameter: |
|
|---|---|
| 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
| Ausgabe: |
|
|---|
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
| Ausgabe: |
|
|---|
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.