Shell - Analog In Bricklet 2.0

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

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

# Get current voltage
tinkerforge call analog-in-v2-bricklet $uid get-voltage

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

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

# Set period for voltage callback to 1s (1000ms)
# Note: The voltage callback is only called every second
#       if the voltage has changed since the last call!
tinkerforge call analog-in-v2-bricklet $uid set-voltage-callback-period 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 Analog In Bricklet 2.0

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

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

# Configure threshold for voltage "smaller than 5 V"
tinkerforge call analog-in-v2-bricklet $uid set-voltage-callback-threshold threshold-option-smaller 5000 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

Befehlsstruktur

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

tinkerforge call analog-in-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

Der call Befehl wird verwendet um eine Funktion des Analog In 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 Analog In Bricklet 2.0 an und endet dann
tinkerforge dispatch analog-in-v2-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> -- string
  • <callback> -- string

Der dispatch Befehl wird verwendet um eingehende Callbacks des Analog In 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 Analog In Bricklet 2.0 an und endet dann
tinkerforge call analog-in-v2-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- 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 analog-in-v2-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> -- string
  • <callback> -- 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 analog-in-v2-bricklet <uid> get-voltage
Ausgabe:
  • voltage -- int

Gibt die gemessene Spannung zurück. Der Wert ist in mV und im Bereich von 0 bis 42V. Die Auflösung ca. 10mV.

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 analog-in-v2-bricklet <uid> get-analog-value
Ausgabe:
  • value -- int

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den analog-value Callback zu nutzen und die Periode mit set-analog-value-callback-period vorzugeben.

tinkerforge call analog-in-v2-bricklet <uid> set-moving-average <average>
Parameter:
  • <average> -- int
Ausgabe:

keine Ausgabe

Setzt die Länge eines gleitenden Mittelwerts für die Spannung.

Wenn die Länge auf 1 gesetzt wird, ist das Averaging aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-50.

Der Standardwert ist 50.

tinkerforge call analog-in-v2-bricklet <uid> get-moving-average
Ausgabe:
  • average -- int

Gibt die Länge des gleitenden Mittelwerts zurück, wie von set-moving-average gesetzt.

tinkerforge call analog-in-v2-bricklet <uid> get-identity
Ausgabe:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (hat Symbole)

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 analog-in-v2-bricklet <uid> set-voltage-callback-period <period>
Parameter:
  • <period> -- int
Ausgabe:

keine Ausgabe

Setzt die Periode in ms mit welcher der voltage Callback 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.

Der Standardwert ist 0.

tinkerforge call analog-in-v2-bricklet <uid> get-voltage-callback-period
Ausgabe:
  • period -- int

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

tinkerforge call analog-in-v2-bricklet <uid> set-analog-value-callback-period <period>
Parameter:
  • <period> -- int
Ausgabe:

keine Ausgabe

Setzt die Periode in ms mit welcher der analog-value Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der analog-value Callback wird nur ausgelöst wenn sich der Analogwert seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

tinkerforge call analog-in-v2-bricklet <uid> get-analog-value-callback-period
Ausgabe:
  • period -- int

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

tinkerforge call analog-in-v2-bricklet <uid> set-voltage-callback-threshold <option> <min> <max>
Parameter:
  • <option> -- char (hat Symbole)
  • <min> -- int
  • <max> -- int
Ausgabe:

keine Ausgabe

Setzt den Schwellwert für den voltage-reached Callback.

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:

  • threshold-option-off = x, für <option>
  • threshold-option-outside = o, für <option>
  • threshold-option-inside = i, für <option>
  • threshold-option-smaller = <, für <option>
  • threshold-option-greater = >, für <option>
tinkerforge call analog-in-v2-bricklet <uid> get-voltage-callback-threshold
Ausgabe:
  • option -- char (hat Symbole)
  • min -- int
  • max -- int

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

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

  • threshold-option-off = x, für option
  • threshold-option-outside = o, für option
  • threshold-option-inside = i, für option
  • threshold-option-smaller = <, für option
  • threshold-option-greater = >, für option
tinkerforge call analog-in-v2-bricklet <uid> set-analog-value-callback-threshold <option> <min> <max>
Parameter:
  • <option> -- char (hat Symbole)
  • <min> -- int
  • <max> -- int
Ausgabe:

keine Ausgabe

Setzt den Schwellwert für den analog-value-reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst wenn der Analogwert außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst wenn der Analogwert innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst wenn der Analogwert 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:

  • threshold-option-off = x, für <option>
  • threshold-option-outside = o, für <option>
  • threshold-option-inside = i, für <option>
  • threshold-option-smaller = <, für <option>
  • threshold-option-greater = >, für <option>
tinkerforge call analog-in-v2-bricklet <uid> get-analog-value-callback-threshold
Ausgabe:
  • option -- char (hat Symbole)
  • min -- int
  • max -- int

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

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

  • threshold-option-off = x, für option
  • threshold-option-outside = o, für option
  • threshold-option-inside = i, für option
  • threshold-option-smaller = <, für option
  • threshold-option-greater = >, für option
tinkerforge call analog-in-v2-bricklet <uid> set-debounce-period <debounce>
Parameter:
  • <debounce> -- int
Ausgabe:

keine Ausgabe

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

tinkerforge call analog-in-v2-bricklet <uid> get-debounce-period
Ausgabe:
  • debounce -- int

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 analog-in-v2-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 analog-in-v2-bricklet <uid> voltage
Ausgabe:
  • voltage -- int

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

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

tinkerforge dispatch analog-in-v2-bricklet <uid> analog-value
Ausgabe:
  • value -- int

Dieser Callback wird mit der Periode, wie gesetzt mit set-analog-value-callback-period, ausgelöst. Der Parameter ist der Analogwert des Sensors.

Der analog-value Callback wird nur ausgelöst wenn sich der Analogwert seit der letzten Auslösung geändert hat.

tinkerforge dispatch analog-in-v2-bricklet <uid> voltage-reached
Ausgabe:
  • voltage -- int

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

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

tinkerforge dispatch analog-in-v2-bricklet <uid> analog-value-reached
Ausgabe:
  • value -- int

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von set-analog-value-callback-threshold gesetzt, erreicht wird. Der Parameter ist der Analogwert des Sensors.

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