Shell - Distance US Bricklet¶

Simple¶

Download (example-simple.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 Distance US Bricklet
5
6# Get current distance value
7tinkerforge call distance-us-bricklet $uid get-distance-value

Callback¶

Download (example-callback.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 Distance US Bricklet
 5
 6# Handle incoming distance value callbacks
 7tinkerforge dispatch distance-us-bricklet $uid distance &
 8
 9# Set period for distance value callback to 0.2s (200ms)
10# Note: The distance value callback is only called every 0.2 seconds
11#       if the distance value has changed since the last call!
12tinkerforge call distance-us-bricklet $uid set-distance-callback-period 200
13
14echo "Press key to exit"; read dummy
15
16kill -- -$$ # Stop callback dispatch in background

Threshold¶

Download (example-threshold.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 Distance US Bricklet
 5
 6# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
 7tinkerforge call distance-us-bricklet $uid set-debounce-period 10000
 8
 9# Handle incoming distance value reached callbacks
10tinkerforge dispatch distance-us-bricklet $uid distance-reached &
11
12# Configure threshold for distance value "smaller than 200"
13tinkerforge call distance-us-bricklet $uid set-distance-callback-threshold threshold-option-smaller 200 0
14
15echo "Press key to exit"; read dummy
16
17kill -- -$$ # Stop callback dispatch in background

Befehlsstruktur¶

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

tinkerforge call distance-us-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Distance US 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 Distance US Bricklet an und endet dann

tinkerforge dispatch distance-us-bricklet [<option>..] <uid> <callback>¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Distance US 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 Distance US Bricklet an und endet dann

tinkerforge call distance-us-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 distance-us-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 distance-us-bricklet <uid> get-distance-value¶

Ausgabe:	distance – Typ: Int, Wertebereich: [0 bis 212 - 1]

Gibt den aktuellen Entfernungswert zurück. Ein kleiner Wert entspricht einer kleinen Entfernung, ein großer Wert entspricht einer großen Entfernung. Das Verhältnis zwischen gemessenem Entfernungswert und wirklicher Entfernung wird durch die 5V Versorgungsspannung beeinflusst (Abweichungen der Versorgungsspannung führen zu Abweichungen in den Entfernungswerten) und ist nicht-linear (Auflösung ist größer im Nahbereich).

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

Fortgeschrittene Funktionen¶

tinkerforge call distance-us-bricklet <uid> set-moving-average <average>¶

Parameter:	<average> – Typ: Int, Wertebereich: [0 bis 100], Standardwert: 20
Ausgabe:	keine Ausgabe

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

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

tinkerforge call distance-us-bricklet <uid> get-moving-average¶

Ausgabe:	average – Typ: Int, Wertebereich: [0 bis 100], Standardwert: 20

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

tinkerforge call distance-us-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, Wertebereich: [a bis h, z] hardware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] firmware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, 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 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. 

Konfigurationsfunktionen für Callbacks¶

tinkerforge call distance-us-bricklet <uid> set-distance-callback-period <period>¶

Parameter:	<period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

Setzt die Periode mit welcher der distance Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

tinkerforge call distance-us-bricklet <uid> get-distance-callback-period¶

Ausgabe:	period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

tinkerforge call distance-us-bricklet <uid> set-distance-callback-threshold <option> <min> <max>¶

Parameter:	<option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x <min> – Typ: Int, Wertebereich: [0 bis 212 - 1] <max> – Typ: Int, Wertebereich: [0 bis 212 - 1]
Ausgabe:	keine Ausgabe

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

Die folgenden Optionen sind möglich:

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

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 distance-us-bricklet <uid> get-distance-callback-threshold¶

Ausgabe:	option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x min – Typ: Int, Wertebereich: [0 bis 212 - 1] max – Typ: Int, Wertebereich: [0 bis 212 - 1]

Gibt den Schwellwert zurück, wie von set-distance-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 distance-us-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 die Schwellwert Callbacks

• distance-reached,

ausgelöst werden, wenn die Schwellwerte

• set-distance-callback-threshold,

weiterhin erreicht bleiben.

tinkerforge call distance-us-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 distance-us-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch distance-us-bricklet <uid> distance¶

Ausgabe:	distance – Typ: Int, Wertebereich: [0 bis 212 - 1]

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

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

tinkerforge dispatch distance-us-bricklet <uid> distance-reached¶

Ausgabe:	distance – Typ: Int, Wertebereich: [0 bis 212 - 1]

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

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