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 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
|
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
|
Mögliche Exit Codes für alle tinkerforge
Befehle sind:
argparse
Modul fehltAllgemeine Optionen des call
und des dispatch
Befehls sind
hier zu finden. Im Folgenden wird die spezifische
Befehlsstruktur dargestellt.
call
industrial-analog-out-bricklet
[<option>..] <uid> <function> [<argument>..]¶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 danndispatch
industrial-analog-out-bricklet
[<option>..] <uid> <callback>¶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 dannindustrial-analog-out-bricklet
<uid> <function>
[<option>..] [<argument>..]¶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 dannGetter-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 dieseMit 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.
industrial-analog-out-bricklet
<uid> <callback>
[<option>..]¶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)industrial-analog-out-bricklet
<uid> enable
¶Ausgabe: |
|
---|
Aktiviert die Ausgabe von Spannung und Strom.
Der Standardwert ist deaktiviert.
industrial-analog-out-bricklet
<uid> disable
¶Ausgabe: |
|
---|
Deaktiviert die Ausgabe von Spannung und Strom.
Der Standardwert ist deaktiviert.
industrial-analog-out-bricklet
<uid> is-enabled
¶Ausgabe: |
|
---|
Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.
industrial-analog-out-bricklet
<uid> set-voltage
<voltage>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Ausgangsspannung.
Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.
industrial-analog-out-bricklet
<uid> get-voltage
¶Ausgabe: |
|
---|
Gibt die Spannung zurück, wie von set-voltage
gesetzt.
industrial-analog-out-bricklet
<uid> set-current
<current>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Ausgangsstrom.
Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.
industrial-analog-out-bricklet
<uid> get-current
¶Ausgabe: |
|
---|
Gibt die Spannung zurück, wie von set-current
gesetzt.
industrial-analog-out-bricklet
<uid> set-configuration
<voltage-range> <current-range>¶Parameter: |
|
---|---|
Ausgabe: |
|
Konfiguriert die Spannungs- und Stromwertebereiche.
Einstellbare Spannungswertebereiche sind:
Einstellbare Stromwertebereiche sind:
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>:
Für <current-range>:
industrial-analog-out-bricklet
<uid> get-configuration
¶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:
Für current-range:
industrial-analog-out-bricklet
<uid> get-identity
¶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.