Dies ist die Beschreibung der MQTT 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 MQTT 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 15 | # Change XYZ to the UID of your Laser Range Finder Bricklet
setup:
# Turn laser on and wait 250ms for very first measurement to be ready
publish '' to tinkerforge/request/laser_range_finder_bricklet/XYZ/enable_laser
wait for 0.25s
# Get current distance
subscribe to tinkerforge/response/laser_range_finder_bricklet/XYZ/get_distance
publish '' to tinkerforge/request/laser_range_finder_bricklet/XYZ/get_distance
cleanup:
# If you are done, run this to clean up
publish '' to tinkerforge/request/laser_range_finder_bricklet/XYZ/disable_laser # Turn laser off
|
Download (example-callback.txt)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | # Change XYZ to the UID of your Laser Range Finder Bricklet
setup:
# Turn laser on and wait 250ms for very first measurement to be ready
publish '' to tinkerforge/request/laser_range_finder_bricklet/XYZ/enable_laser
wait for 0.25s
# Handle incoming distance callbacks
subscribe to tinkerforge/callback/laser_range_finder_bricklet/XYZ/distance
publish '{"register": true}' to tinkerforge/register/laser_range_finder_bricklet/XYZ/distance # Register distance callback
# 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!
publish '{"period": 200}' to tinkerforge/request/laser_range_finder_bricklet/XYZ/set_distance_callback_period
cleanup:
# If you are done, run this to clean up
publish '' to tinkerforge/request/laser_range_finder_bricklet/XYZ/disable_laser # Turn laser off
|
Download (example-threshold.txt)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | # Change XYZ to the UID of your Laser Range Finder Bricklet
setup:
# Turn laser on and wait 250ms for very first measurement to be ready
publish '' to tinkerforge/request/laser_range_finder_bricklet/XYZ/enable_laser
wait for 0.25s
# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
publish '{"debounce": 10000}' to tinkerforge/request/laser_range_finder_bricklet/XYZ/set_debounce_period
# Handle incoming distance reached callbacks
subscribe to tinkerforge/callback/laser_range_finder_bricklet/XYZ/distance_reached
publish '{"register": true}' to tinkerforge/register/laser_range_finder_bricklet/XYZ/distance_reached # Register distance_reached callback
# Configure threshold for distance "greater than 20 cm"
publish '{"option": "greater", "min": 20, "max": 0}' to tinkerforge/request/laser_range_finder_bricklet/XYZ/set_distance_callback_threshold
cleanup:
# If you are done, run this to clean up
publish '' to tinkerforge/request/laser_range_finder_bricklet/XYZ/disable_laser # Turn laser off
|
Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.
Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR
-Member enthält.
Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/...
für .../request/...
und .../callback/...
für .../register/...
.
request/
laser_range_finder_bricklet/
<UID>/
get_distance
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die gemessene Distanz zurück.
Sensor Hardware Version 1 (siehe request/laser_range_finder_bricklet/<UID>/get_sensor_hardware_version
) kann nicht
gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels
request/laser_range_finder_bricklet/<UID>/set_mode
der Distanzmodus aktiviert sein.
Sensor Hardware Version 3 kann gleichzeitig Distanz und Geschwindigkeit
messen. Zusätzlich muss der Laser aktiviert werden, siehe request/laser_range_finder_bricklet/<UID>/enable_laser
.
Wenn der Entfernungswert periodisch abgefragt werden soll, wird empfohlen
den register/laser_range_finder_bricklet/<UID>/distance
Callback zu nutzen und die Periode mit
request/laser_range_finder_bricklet/<UID>/set_distance_callback_period
vorzugeben.
request/
laser_range_finder_bricklet/
<UID>/
get_velocity
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die gemessene Geschwindigkeit zurück.
Sensor Hardware Version 1 (siehe request/laser_range_finder_bricklet/<UID>/get_sensor_hardware_version
) kann nicht
gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels
request/laser_range_finder_bricklet/<UID>/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 request/laser_range_finder_bricklet/<UID>/set_configuration
) eingestellt ist.
Zusätzlich muss der Laser aktiviert werden, siehe request/laser_range_finder_bricklet/<UID>/enable_laser
.
Wenn der Geschwindigkeitswert periodisch abgefragt werden soll, wird empfohlen
den register/laser_range_finder_bricklet/<UID>/velocity
Callback zu nutzen und die Periode mit
request/laser_range_finder_bricklet/<UID>/set_velocity_callback_period
vorzugeben.
request/
laser_range_finder_bricklet/
<UID>/
set_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
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 request/laser_range_finder_bricklet/<UID>/set_configuration
.
die Hardware Version des Sensors kann mittels request/laser_range_finder_bricklet/<UID>/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:
request/
laser_range_finder_bricklet/
<UID>/
get_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den Modus zurück, wie von request/laser_range_finder_bricklet/<UID>/set_mode
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
request/
laser_range_finder_bricklet/
<UID>/
enable_laser
¶Anfrage: |
|
---|---|
Antwort: |
|
Aktiviert den Laser des LIDAR.
Wir empfehlen nach dem aktivieren des Lasers 250ms zu warten bis zum
ersten Aufruf von request/laser_range_finder_bricklet/<UID>/get_distance
um stabile Messwerte zu garantieren.
request/
laser_range_finder_bricklet/
<UID>/
disable_laser
¶Anfrage: |
|
---|---|
Antwort: |
|
Deaktiviert den Laser des LIDAR.
request/
laser_range_finder_bricklet/
<UID>/
is_laser_enabled
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt true zurück wenn der Laser aktiviert ist, false sonst.
request/
laser_range_finder_bricklet/
<UID>/
set_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
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 request/laser_range_finder_bricklet/<UID>/set_mode
.
Die Hardware Version des Sensors kann mittels request/laser_range_finder_bricklet/<UID>/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).
request/
laser_range_finder_bricklet/
<UID>/
get_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Konfiguration zurück, wie von request/laser_range_finder_bricklet/<UID>/set_configuration
gesetzt.
Neu in Version 2.0.3 (Plugin).
request/
laser_range_finder_bricklet/
<UID>/
set_moving_average
¶Anfrage: |
|
---|---|
Antwort: |
|
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.
request/
laser_range_finder_bricklet/
<UID>/
get_moving_average
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Länge des gleitenden Mittelwerts zurück, wie von
request/laser_range_finder_bricklet/<UID>/set_moving_average
gesetzt.
request/
laser_range_finder_bricklet/
<UID>/
get_sensor_hardware_version
¶Anfrage: |
|
---|---|
Antwort: |
|
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).
request/
laser_range_finder_bricklet/
<UID>/
get_identity
¶Anfrage: |
|
---|---|
Antwort: |
|
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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.
Der Display Name enthält den Anzeigenamen des Laser Range Finder.
request/
laser_range_finder_bricklet/
<UID>/
set_distance_callback_period
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Periode mit welcher der register/laser_range_finder_bricklet/<UID>/distance
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der register/laser_range_finder_bricklet/<UID>/distance
Callback wird nur ausgelöst, wenn sich der Entfernungswert
seit der letzten Auslösung geändert hat.
request/
laser_range_finder_bricklet/
<UID>/
get_distance_callback_period
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Periode zurück, wie von request/laser_range_finder_bricklet/<UID>/set_distance_callback_period
gesetzt.
request/
laser_range_finder_bricklet/
<UID>/
set_velocity_callback_period
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Periode mit welcher der register/laser_range_finder_bricklet/<UID>/velocity
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der register/laser_range_finder_bricklet/<UID>/velocity
Callback wird nur ausgelöst, wenn sich der
Geschwindigkeitswert seit der letzten Auslösung geändert hat.
request/
laser_range_finder_bricklet/
<UID>/
get_velocity_callback_period
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Periode zurück, wie von request/laser_range_finder_bricklet/<UID>/set_velocity_callback_period
gesetzt.
request/
laser_range_finder_bricklet/
<UID>/
set_distance_callback_threshold
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Schwellwert für den register/laser_range_finder_bricklet/<UID>/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:
request/
laser_range_finder_bricklet/
<UID>/
get_distance_callback_threshold
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den Schwellwert zurück, wie von request/laser_range_finder_bricklet/<UID>/set_distance_callback_threshold
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
request/
laser_range_finder_bricklet/
<UID>/
set_velocity_callback_threshold
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Schwellwert für den register/laser_range_finder_bricklet/<UID>/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:
request/
laser_range_finder_bricklet/
<UID>/
get_velocity_callback_threshold
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den Schwellwert zurück, wie von request/laser_range_finder_bricklet/<UID>/set_velocity_callback_threshold
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
request/
laser_range_finder_bricklet/
<UID>/
set_debounce_period
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Periode mit welcher die Schwellwert Callbacks
register/laser_range_finder_bricklet/<UID>/distance_reached
,register/laser_range_finder_bricklet/<UID>/velocity_reached
,ausgelöst werden, wenn die Schwellwerte
request/laser_range_finder_bricklet/<UID>/set_distance_callback_threshold
,request/laser_range_finder_bricklet/<UID>/set_velocity_callback_threshold
,weiterhin erreicht bleiben.
request/
laser_range_finder_bricklet/
<UID>/
get_debounce_period
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Entprellperiode zurück, wie von request/laser_range_finder_bricklet/<UID>/set_debounce_period
gesetzt.
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit dem entsprechenden .../register/...
-Topic und einem optionalen Suffix durchgeführt werden.
Mit diesem Suffix kann das Callback später deregistriert werden.
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.
register/
laser_range_finder_bricklet/
<UID>/
distance
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/laser_range_finder_bricklet/<UID>/distance[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/laser_range_finder_bricklet/<UID>/distance[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird mit der Periode, wie gesetzt mit request/laser_range_finder_bricklet/<UID>/set_distance_callback_period
,
ausgelöst. Der Payload des Callbacks ist die Entfernungswert des Sensors.
Der register/laser_range_finder_bricklet/<UID>/distance
Callback wird nur ausgelöst, wenn sich der Entfernungswert
seit der letzten Auslösung geändert hat.
register/
laser_range_finder_bricklet/
<UID>/
velocity
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/laser_range_finder_bricklet/<UID>/velocity[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/laser_range_finder_bricklet/<UID>/velocity[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird mit der Periode, wie gesetzt mit request/laser_range_finder_bricklet/<UID>/set_velocity_callback_period
,
ausgelöst. Der Payload des Callbacks ist die Geschwindigkeit des Sensors.
Der register/laser_range_finder_bricklet/<UID>/velocity
Callback wird nur ausgelöst, wenn sich der
Geschwindigkeitswert seit der letzten Auslösung geändert hat.
register/
laser_range_finder_bricklet/
<UID>/
distance_reached
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/laser_range_finder_bricklet/<UID>/distance_reached[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/laser_range_finder_bricklet/<UID>/distance_reached[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
request/laser_range_finder_bricklet/<UID>/set_distance_callback_threshold
gesetzt, erreicht wird.
Der Payload des Callbacks ist der Entfernungswert des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit request/laser_range_finder_bricklet/<UID>/set_debounce_period
gesetzt, ausgelöst.
register/
laser_range_finder_bricklet/
<UID>/
velocity_reached
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/laser_range_finder_bricklet/<UID>/velocity_reached[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/laser_range_finder_bricklet/<UID>/velocity_reached[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
request/laser_range_finder_bricklet/<UID>/set_velocity_callback_threshold
gesetzt, erreicht wird.
Der Payload des Callbacks ist der Geschwindigkeitswert des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit request/laser_range_finder_bricklet/<UID>/set_debounce_period
gesetzt, ausgelöst.