Dies ist die Beschreibung der Shell API Bindings für das Laser Range Finder Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Laser Range Finder 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).
1 2 3 4 5 6 7 8 9 10 11 12 13 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Laser Range Finder Bricklet
# Turn laser on and wait 250ms for very first measurement to be ready
tinkerforge call laser-range-finder-bricklet $uid enable-laser
sleep 0.25
# Get current distance
tinkerforge call laser-range-finder-bricklet $uid get-distance
tinkerforge call laser-range-finder-bricklet $uid disable-laser # Turn laser off
|
Download (example-callback.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Laser Range Finder Bricklet
# Turn laser on and wait 250ms for very first measurement to be ready
tinkerforge call laser-range-finder-bricklet $uid enable-laser
sleep 0.25
# Handle incoming distance callbacks
tinkerforge dispatch laser-range-finder-bricklet $uid distance &
# Set period for distance callback to 0.2s (200ms)
# Note: The distance callback is only called every 0.2 seconds
# if the distance has changed since the last call!
tinkerforge call laser-range-finder-bricklet $uid set-distance-callback-period 200
echo "Press key to exit"; read dummy
tinkerforge call laser-range-finder-bricklet $uid disable-laser # Turn laser off
kill -- -$$ # Stop callback dispatch in background
|
Download (example-threshold.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Laser Range Finder Bricklet
# Turn laser on and wait 250ms for very first measurement to be ready
tinkerforge call laser-range-finder-bricklet $uid enable-laser
sleep 0.25
# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call laser-range-finder-bricklet $uid set-debounce-period 10000
# Handle incoming distance reached callbacks
tinkerforge dispatch laser-range-finder-bricklet $uid distance-reached &
# Configure threshold for distance "greater than 20 cm"
tinkerforge call laser-range-finder-bricklet $uid set-distance-callback-threshold threshold-option-greater 20 0
echo "Press key to exit"; read dummy
tinkerforge call laser-range-finder-bricklet $uid disable-laser # Turn laser off
kill -- -$$ # Stop callback dispatch in background
|
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
laser-range-finder-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
Der call
Befehl wird verwendet um eine Funktion des Laser Range Finder 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 Laser Range Finder Bricklet an
und endet danndispatch
laser-range-finder-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
Der dispatch
Befehl wird verwendet um eingehende Callbacks des Laser Range Finder 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 Laser Range Finder Bricklet an
und endet dannlaser-range-finder-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.
laser-range-finder-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)laser-range-finder-bricklet
<uid> get-distance
¶Ausgabe: |
|
---|
Gibt die gemessene Distanz zurück.
Sensor Hardware Version 1 (siehe get-sensor-hardware-version
) kann nicht
gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels
set-mode
der Distanzmodus aktiviert sein.
Sensor Hardware Version 3 kann gleichzeitig Distanz und Geschwindigkeit
messen. Zusätzlich muss der Laser aktiviert werden, siehe enable-laser
.
Wenn der Entfernungswert periodisch abgefragt werden soll, wird empfohlen
den distance
Callback zu nutzen und die Periode mit
set-distance-callback-period
vorzugeben.
laser-range-finder-bricklet
<uid> get-velocity
¶Ausgabe: |
|
---|
Gibt die gemessene Geschwindigkeit zurück.
Sensor Hardware Version 1 (siehe get-sensor-hardware-version
) kann nicht
gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels
set-mode
ein Geschwindigkeitsmodus aktiviert sein.
Sensor Hardware Version 3 kann gleichzeitig Distanz und Geschwindigkeit
messen, jedoch liefert die Geschwindigkeitsmessung nur dann stabile Werte,
wenn eine feste Messfrequenz (siehe set-configuration
) eingestellt ist.
Zusätzlich muss der Laser aktiviert werden, siehe enable-laser
.
Wenn der Geschwindigkeitswert periodisch abgefragt werden soll, wird empfohlen
den velocity
Callback zu nutzen und die Periode mit
set-velocity-callback-period
vorzugeben.
laser-range-finder-bricklet
<uid> set-mode
<mode>¶Parameter: |
|
---|---|
Ausgabe: |
|
Bemerkung
Diese Funktion ist nur verfügbar, wenn ein LIDAR-Lite Sensor mit Hardware
Version 1 verbaut ist. Für Hardware Version 3 gibt es set-configuration
.
die Hardware Version des Sensors kann mittels get-sensor-hardware-version
abgefragt werden.
Der LIDAR-Lite Sensor (Hardware Version 1) hat fünf verschiedene Modi. Ein Modus ist für Distanzmessungen und vier Modi sind für Geschwindigkeitsmessungen mit unterschiedlichen Wertebereichen.
Die folgenden Modi können genutzt werden:
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <mode>:
laser-range-finder-bricklet
<uid> get-mode
¶Ausgabe: |
|
---|
Gibt den Modus zurück, wie von set-mode
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
laser-range-finder-bricklet
<uid> enable-laser
¶Ausgabe: |
|
---|
Aktiviert den Laser des LIDAR.
Wir empfehlen nach dem aktivieren des Lasers 250ms zu warten bis zum
ersten Aufruf von get-distance
um stabile Messwerte zu garantieren.
laser-range-finder-bricklet
<uid> disable-laser
¶Ausgabe: |
|
---|
Deaktiviert den Laser des LIDAR.
laser-range-finder-bricklet
<uid> is-laser-enabled
¶Ausgabe: |
|
---|
Gibt true zurück wenn der Laser aktiviert ist, false sonst.
laser-range-finder-bricklet
<uid> set-configuration
<acquisition-count> <enable-quick-termination> <threshold-value> <measurement-frequency>¶Parameter: |
|
---|---|
Ausgabe: |
|
Bemerkung
Diese Funktion ist nur verfügbar, wenn ein LIDAR-Lite Sensor mit Hardware
Version 3 verbaut ist. Für Hardware Version 1 gibt es set-mode
.
Die Hardware Version des Sensors kann mittels get-sensor-hardware-version
abgefragt werden.
Der Parameter Acquisition Count definiert die Anzahl der Datenerfassungen die integriert werden, um eine Korrelation zu finden. Mit einer größeren Anzahl kann das Bricklet höhere Distanzen messen, mit einer kleineren Anzahl ist die Messrate höher. Erlaubte Werte sind 1-255.
Wenn der Parameter Enable Quick Termination auf true gesetzt wird, wird die Distanzmessung abgeschlossen, sobald das erste mal ein hoher Peak erfasst wird. Dadurch kann eine höhere Messrate erreicht werden wobei gleichzeitig Messungen mit langer Distanz möglich sind. Die Wahrscheinlichkeit einer Falschmessung erhöht sich allerdings.
Normalerweise wird die Distanz mit Hilfe eines Detektionsalgorithmus berechnet. Dieser verwendet Peak-Werte, Signalstärke und Rauschen. Es ist möglich stattdessen über den Parameter Threshold Value einen festen Schwellwert zu setzen der zur Distanzbestimmung genutzt werden soll. Um den Abstand zu einem Objekt mit sehr niedriger Reflektivität zu messen (z.B. Glas) kann der Wert niedrig gesetzt werden. Um den Abstand zu einem Objekt mit sehr hoher Reflektivität zu messen (z.B. Spiegel) kann der Wert sehr hoch gesetzt werden. Mit einem Wert von 0 wird der Standardalgorithmus genutzt. Ansonsten ist der erlaubte Wertebereich 1-255.
Der Measurement Frequency Parameter erzwingt eine feste Messfrequenz. Wenn der Wert auf 0 gesetzt wird, nutzt das Laser Range Finder Bricklet die optimale Frequenz je nach Konfiguration und aktuell gemessener Distanz. Da die Messrate in diesem Fall nicht fest ist, ist die Geschwindigkeitsmessung nicht stabil. Für eine stabile Geschwindigkeitsmessung sollte eine feste Messfrequenz eingestellt werden. Je niedriger die Frequenz ist, desto größer ist die Auflösung der Geschwindigkeitsmessung. Der erlaubte Wertbereich ist 10Hz-500Hz (und 0 um die feste Messfrequenz auszustellen).
Neu in Version 2.0.3 (Plugin).
laser-range-finder-bricklet
<uid> get-configuration
¶Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-configuration
gesetzt.
Neu in Version 2.0.3 (Plugin).
laser-range-finder-bricklet
<uid> set-moving-average
<distance-average-length> <velocity-average-length>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Länge eines gleitenden Mittelwerts für die Entfernung und Geschwindigkeit.
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.
laser-range-finder-bricklet
<uid> get-moving-average
¶Ausgabe: |
|
---|
Gibt die Länge des gleitenden Mittelwerts zurück, wie von
set-moving-average
gesetzt.
laser-range-finder-bricklet
<uid> get-sensor-hardware-version
¶Ausgabe: |
|
---|
Gibt die LIDAR-Lite Hardware version zurück.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für version:
Neu in Version 2.0.3 (Plugin).
laser-range-finder-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.
laser-range-finder-bricklet
<uid> set-distance-callback-period
<period>¶Parameter: |
|
---|---|
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.
laser-range-finder-bricklet
<uid> get-distance-callback-period
¶Ausgabe: |
|
---|
Gibt die Periode zurück, wie von set-distance-callback-period
gesetzt.
laser-range-finder-bricklet
<uid> set-velocity-callback-period
<period>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Periode mit welcher der velocity
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der velocity
Callback wird nur ausgelöst, wenn sich der
Geschwindigkeitswert seit der letzten Auslösung geändert hat.
laser-range-finder-bricklet
<uid> get-velocity-callback-period
¶Ausgabe: |
|
---|
Gibt die Periode zurück, wie von set-velocity-callback-period
gesetzt.
laser-range-finder-bricklet
<uid> set-distance-callback-threshold
<option> <min> <max>¶Parameter: |
|
---|---|
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>:
laser-range-finder-bricklet
<uid> get-distance-callback-threshold
¶Ausgabe: |
|
---|
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:
laser-range-finder-bricklet
<uid> set-velocity-callback-threshold
<option> <min> <max>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Schwellwert für den velocity-reached
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn der Geschwindigkeitswert außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn der Geschwindigkeitswert innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn der Geschwindigkeitswert kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn der Geschwindigkeitswert größer als der min Wert ist (max wird ignoriert) |
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <option>:
laser-range-finder-bricklet
<uid> get-velocity-callback-threshold
¶Ausgabe: |
|
---|
Gibt den Schwellwert zurück, wie von set-velocity-callback-threshold
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
laser-range-finder-bricklet
<uid> set-debounce-period
<debounce>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
laser-range-finder-bricklet
<uid> get-debounce-period
¶Ausgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von set-debounce-period
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch laser-range-finder-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.
laser-range-finder-bricklet
<uid> distance
¶Ausgabe: |
|
---|
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.
laser-range-finder-bricklet
<uid> velocity
¶Ausgabe: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit set-velocity-callback-period
,
ausgelöst. Der Parameter ist die Geschwindigkeit des Sensors.
Der velocity
Callback wird nur ausgelöst, wenn sich der
Geschwindigkeitswert seit der letzten Auslösung geändert hat.
laser-range-finder-bricklet
<uid> distance-reached
¶Ausgabe: |
|
---|
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.
laser-range-finder-bricklet
<uid> velocity-reached
¶Ausgabe: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
set-velocity-callback-threshold
gesetzt, erreicht wird.
Der Parameter ist der Geschwindigkeitswert des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit set-debounce-period
gesetzt, ausgelöst.