Dies ist die Beschreibung der Shell API Bindings für das Laser Range Finder Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Laser Range Finder Bricklet 2.0 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 14 | #!/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 2.0
# Turn laser on and wait 250ms for very first measurement to be ready
tinkerforge call laser-range-finder-v2-bricklet $uid set-enable true
sleep 0.25
# Get current distance
tinkerforge call laser-range-finder-v2-bricklet $uid get-distance
# Turn laser off
tinkerforge call laser-range-finder-v2-bricklet $uid set-enable false
|
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 | #!/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 2.0
# Turn laser on and wait 250ms for very first measurement to be ready
tinkerforge call laser-range-finder-v2-bricklet $uid set-enable true
sleep 0.25
# Handle incoming distance callbacks
tinkerforge dispatch laser-range-finder-v2-bricklet $uid distance &
# Set period for distance callback to 0.2s (200ms) without a threshold
tinkerforge call laser-range-finder-v2-bricklet $uid set-distance-callback-configuration 200 false threshold-option-off 0 0
echo "Press key to exit"; read dummy
# Turn laser off
tinkerforge call laser-range-finder-v2-bricklet $uid set-enable false
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 | #!/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 2.0
# Turn laser on and wait 250ms for very first measurement to be ready
tinkerforge call laser-range-finder-v2-bricklet $uid set-enable true
sleep 0.25
# Handle incoming distance callbacks
tinkerforge dispatch laser-range-finder-v2-bricklet $uid distance &
# Configure threshold for distance "greater than 20 cm"
# with a debounce period of 1s (1000ms)
tinkerforge call laser-range-finder-v2-bricklet $uid set-distance-callback-configuration 1000 false threshold-option-greater 20 0
echo "Press key to exit"; read dummy
# Turn laser off
tinkerforge call laser-range-finder-v2-bricklet $uid set-enable false
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-v2-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
Der call
Befehl wird verwendet um eine Funktion des Laser Range Finder 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 Laser Range Finder Bricklet 2.0 an
und endet danndispatch
laser-range-finder-v2-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
Der dispatch
Befehl wird verwendet um eingehende Callbacks des Laser Range Finder 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 Laser Range Finder Bricklet 2.0 an
und endet dannlaser-range-finder-v2-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-v2-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-v2-bricklet
<uid> get-distance
¶Ausgabe: |
|
---|
Gibt die gemessene Distanz zurück.
Der Laser muss aktiviert werden, siehe set-enable
.
Wenn der Wert periodisch benötigt wird, kann auch der distance
Callback
verwendet werden. Der Callback wird mit der Funktion
set-distance-callback-configuration
konfiguriert.
laser-range-finder-v2-bricklet
<uid> get-velocity
¶Ausgabe: |
|
---|
Gibt die gemessene Geschwindigkeit zurück.
Die Geschwindigkeitsmessung liefert nur dann stabile Werte,
wenn eine feste Messfrequenz (siehe set-configuration
) eingestellt ist.
Zusätzlich muss der Laser aktiviert werden, siehe set-enable
.
Wenn der Wert periodisch benötigt wird, kann auch der velocity
Callback
verwendet werden. Der Callback wird mit der Funktion
set-velocity-callback-configuration
konfiguriert.
laser-range-finder-v2-bricklet
<uid> set-enable
<enable>¶Parameter: |
|
---|---|
Ausgabe: |
|
Aktiviert den Laser des LIDAR wenn auf true gesetzt.
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-v2-bricklet
<uid> get-enable
¶Ausgabe: |
|
---|
Gibt den Wert zurück wie von set-enable
gesetzt.
laser-range-finder-v2-bricklet
<uid> set-configuration
<acquisition-count> <enable-quick-termination> <threshold-value> <measurement-frequency>¶Parameter: |
|
---|---|
Ausgabe: |
|
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 wird gesetzt. Er 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).
Die Standardwerte für Acquisition Count, Enable Quick Termination, Threshold Value und Measurement Frequency sind 128, false, 0 und 0.
laser-range-finder-v2-bricklet
<uid> get-configuration
¶Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-configuration
gesetzt.
laser-range-finder-v2-bricklet
<uid> set-distance-led-config
<config>¶Parameter: |
|
---|---|
Ausgabe: |
|
Konfiguriert die Distanz-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED die Distanz anzuzeigen (heller = Objekt näher).
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <config>:
laser-range-finder-v2-bricklet
<uid> get-distance-led-config
¶Ausgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von set-distance-led-config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
laser-range-finder-v2-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-v2-bricklet
<uid> get-moving-average
¶Ausgabe: |
|
---|
Gibt die Länge des gleitenden Mittelwerts zurück, wie von
set-moving-average
gesetzt.
laser-range-finder-v2-bricklet
<uid> set-offset-calibration
<offset>¶Parameter: |
|
---|---|
Ausgabe: |
|
Der Offset wird auf die Distanz addiert. Es wird in nicht-flüchtigen Speicher gespeichert und muss nur einmal gesetzt werden.
Der Offset wird für das Bricklet pro Sensor von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte also nicht notwendig sein.
Wenn der Offset re-kalibriert werden soll muss er zuerst auf 0 gesetzt. Danach kann der Offset wieder gesetzt werden in dem die Differenz zu einer bekannte Distanz gemessen wird.
laser-range-finder-v2-bricklet
<uid> get-offset-calibration
¶Ausgabe: |
|
---|
Gibt den Offset-Wert zurück, wie von set-offset-calibration
gesetzt.
laser-range-finder-v2-bricklet
<uid> get-spitfp-error-count
¶Ausgabe: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
laser-range-finder-v2-bricklet
<uid> set-status-led-config
<config>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <config>:
laser-range-finder-v2-bricklet
<uid> get-status-led-config
¶Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-status-led-config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
laser-range-finder-v2-bricklet
<uid> get-chip-temperature
¶Ausgabe: |
|
---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
laser-range-finder-v2-bricklet
<uid> reset
¶Ausgabe: |
|
---|
Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
laser-range-finder-v2-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-v2-bricklet
<uid> set-distance-callback-configuration
<period> <value-has-to-change> <option> <min> <max>¶Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der distance
Callback ausgelöst wird. Ein Wert von 0
schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den distance
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <option>:
laser-range-finder-v2-bricklet
<uid> get-distance-callback-configuration
¶Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels set-distance-callback-configuration
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
laser-range-finder-v2-bricklet
<uid> set-velocity-callback-configuration
<period> <value-has-to-change> <option> <min> <max>¶Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der velocity
Callback ausgelöst wird. Ein Wert von 0
schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den velocity
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <option>:
laser-range-finder-v2-bricklet
<uid> get-velocity-callback-configuration
¶Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels set-velocity-callback-configuration
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch laser-range-finder-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.
laser-range-finder-v2-bricklet
<uid> distance
¶Ausgabe: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set-distance-callback-configuration
gesetzten Konfiguration
Der Parameter ist der gleiche wie get-distance
.
laser-range-finder-v2-bricklet
<uid> velocity
¶Ausgabe: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set-velocity-callback-configuration
gesetzten Konfiguration
Der Parameter ist der gleiche wie get-velocity
.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
laser-range-finder-v2-bricklet
<uid> set-bootloader-mode
<mode>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <mode>:
Für status:
laser-range-finder-v2-bricklet
<uid> get-bootloader-mode
¶Ausgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
laser-range-finder-v2-bricklet
<uid> set-write-firmware-pointer
<pointer>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Firmware-Pointer für write-firmware
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
laser-range-finder-v2-bricklet
<uid> write-firmware
<data>¶Parameter: |
|
---|---|
Ausgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
set-write-firmware-pointer
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
laser-range-finder-v2-bricklet
<uid> write-uid
<uid>¶Parameter: |
|
---|---|
Ausgabe: |
|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
laser-range-finder-v2-bricklet
<uid> read-uid
¶Ausgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.