Shell - Industrial Dual Analog In Bricklet

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

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 Dual Analog In Bricklet

# Get current voltage from channel 1
tinkerforge call industrial-dual-analog-in-bricklet $uid get-voltage 1

Callback

Download (example-callback.sh)

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

# Handle incoming voltage callbacks
tinkerforge dispatch industrial-dual-analog-in-bricklet $uid voltage &

# Set period for voltage (channel 1) callback to 1s (1000ms)
# Note: The voltage (channel 1) callback is only called every second
#       if the voltage (channel 1) has changed since the last call!
tinkerforge call industrial-dual-analog-in-bricklet $uid set-voltage-callback-period 1 1000

echo "Press key to exit"; read dummy

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

Threshold

Download (example-threshold.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
#!/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 Dual Analog In Bricklet

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call industrial-dual-analog-in-bricklet $uid set-debounce-period 10000

# Handle incoming voltage reached callbacks
tinkerforge dispatch industrial-dual-analog-in-bricklet $uid voltage-reached &

# Configure threshold for voltage (channel 1) "greater than 10 V"
tinkerforge call industrial-dual-analog-in-bricklet $uid set-voltage-callback-threshold 1 threshold-option-greater 10000 0

echo "Press key to exit"; read dummy

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

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

Das Bricklet hat zwei Eingangskanäle. Funktionen die sich direkt auf einen der Kanäle beziehen haben einen channel Parameter, um den Kanal anzugeben. Gültige Werte für das channel Parameter sind 0 und 1.

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call industrial-dual-analog-in-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

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

Der dispatch Befehl wird verwendet um eingehende Callbacks des Industrial Dual Analog In 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 Dual Analog In Bricklet an und endet dann
tinkerforge call industrial-dual-analog-in-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-dual-analog-in-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-dual-analog-in-bricklet <uid> get-voltage <channel>
Parameter:
  • <channel> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:
  • voltage – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Gibt die Spannung für den übergebenen Kanal in mV zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den voltage Callback zu nutzen und die Periode mit set-voltage-callback-period vorzugeben.

Fortgeschrittene Funktionen

tinkerforge call industrial-dual-analog-in-bricklet <uid> set-sample-rate <rate>
Parameter:
  • <rate> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

Setzt die Abtastrate. Der Wertebereich der verfügbare Abtastraten liegt zwischen 1 Wert pro Sekunde und 976 Werte pro Sekunde. Ein Verringern der Abtastrate wird auch das Rauschen auf den Daten verringern.

Der Standardwert ist 6 (2 Werte pro Sekunde).

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

Für <rate>:

  • sample-rate-976-sps = 0
  • sample-rate-488-sps = 1
  • sample-rate-244-sps = 2
  • sample-rate-122-sps = 3
  • sample-rate-61-sps = 4
  • sample-rate-4-sps = 5
  • sample-rate-2-sps = 6
  • sample-rate-1-sps = 7
tinkerforge call industrial-dual-analog-in-bricklet <uid> get-sample-rate
Ausgabe:
  • rate – Typ: Int, Wertebereich: Siehe Symbole

Gibt die Abtastrate zurück, wie von set-sample-rate gesetzt.

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

Für rate:

  • sample-rate-976-sps = 0
  • sample-rate-488-sps = 1
  • sample-rate-244-sps = 2
  • sample-rate-122-sps = 3
  • sample-rate-61-sps = 4
  • sample-rate-4-sps = 5
  • sample-rate-2-sps = 6
  • sample-rate-1-sps = 7
tinkerforge call industrial-dual-analog-in-bricklet <uid> set-calibration <offset> <gain>
Parameter:
  • <offset> – Typ: Int Array, Länge: 2, Wertebereich: [-231 bis 231 - 1]
  • <gain> – Typ: Int Array, Länge: 2, Wertebereich: [-231 bis 231 - 1]
Ausgabe:
  • keine Ausgabe

Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.

Siehe MCP3911 Datenblatt 7.7 und 7.8. Das Industrial Dual Analog In Bricklet wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.

tinkerforge call industrial-dual-analog-in-bricklet <uid> get-calibration
Ausgabe:
  • offset – Typ: Int Array, Länge: 2, Wertebereich: [-231 bis 231 - 1]
  • gain – Typ: Int Array, Länge: 2, Wertebereich: [-231 bis 231 - 1]

Gibt die Kalibrierung zurück, wie von set-calibration gesetzt.

tinkerforge call industrial-dual-analog-in-bricklet <uid> get-adc-values
Ausgabe:
  • value – Typ: Int Array, Länge: 2, Wertebereich: [-231 bis 231 - 1]

Gibt die ADC-Werte des MCP3911 ICs zurück. Diese Funktion wird für die Kalibrierung benötigt, siehe set-calibration.

tinkerforge call industrial-dual-analog-in-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. 

Konfigurationsfunktionen für Callbacks

tinkerforge call industrial-dual-analog-in-bricklet <uid> set-voltage-callback-period <channel> <period>
Parameter:
  • <channel> – Typ: Int, Wertebereich: [0 bis 255]
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt die Periode mit welcher der voltage Callback für den übergebenen Kanal ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der voltage Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

tinkerforge call industrial-dual-analog-in-bricklet <uid> get-voltage-callback-period <channel>
Parameter:
  • <channel> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set-voltage-callback-period gesetzt.

tinkerforge call industrial-dual-analog-in-bricklet <uid> set-voltage-callback-threshold <channel> <option> <min> <max>
Parameter:
  • <channel> – Typ: Int, Wertebereich: [0 bis 255]
  • <option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • <min> – Typ: Int, Wertebereich: [-231 bis 231 - 1]
  • <max> – Typ: Int, Wertebereich: [-231 bis 231 - 1]
Ausgabe:
  • keine Ausgabe

Setzt den Schwellwert des voltage-reached Callbacks für den übergebenen Kanal.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Spannung größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

Für <option>:

  • threshold-option-off = x
  • threshold-option-outside = o
  • threshold-option-inside = i
  • threshold-option-smaller = <
  • threshold-option-greater = >
tinkerforge call industrial-dual-analog-in-bricklet <uid> get-voltage-callback-threshold <channel>
Parameter:
  • <channel> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:
  • option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • min – Typ: Int, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Gibt den Schwellwert zurück, wie von set-voltage-callback-threshold gesetzt.

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

Für option:

  • threshold-option-off = x
  • threshold-option-outside = o
  • threshold-option-inside = i
  • threshold-option-smaller = <
  • threshold-option-greater = >
tinkerforge call industrial-dual-analog-in-bricklet <uid> set-debounce-period <debounce>
Parameter:
  • <debounce> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Ausgabe:
  • keine Ausgabe

Setzt die Periode mit welcher der Schwellwert Callback

ausgelöst werden, wenn der Schwellwert

weiterhin erreicht bleibt.

tinkerforge call industrial-dual-analog-in-bricklet <uid> get-debounce-period
Ausgabe:
  • debounce – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set-debounce-period gesetzt.

Callbacks

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

tinkerforge dispatch industrial-dual-analog-in-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-dual-analog-in-bricklet <uid> voltage
Ausgabe:
  • channel – Typ: Int, Wertebereich: [0 bis 255]
  • voltage – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set-voltage-callback-period, ausgelöst. Der Parameter ist die Spannung des Kanals.

Der voltage Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

tinkerforge dispatch industrial-dual-analog-in-bricklet <uid> voltage-reached
Ausgabe:
  • channel – Typ: Int, Wertebereich: [0 bis 255]
  • voltage – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set-voltage-callback-threshold gesetzt, erreicht wird. Der Parameter ist die Spannung des Kanals.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set-debounce-period gesetzt, ausgelöst.