MQTT - Laser Range Finder Bricklet 2.0

Dies ist die Beschreibung der MQTT 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 MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

API

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"-Attribut enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/laser_range_finder_v2_bricklet/<UID>/get_distance
Response-Payload:
  • distance -- int

Gibt die gemessene Distanz zurück. Der Wertebereich ist 0 bis 4000 und die Werte haben die Einheit cm.

Der Laser muss aktiviert werden, siehe request/laser_range_finder_v2_bricklet/<UID>/set_enable.

Wenn der Wert periodisch benötigt wird, kann auch der register/laser_range_finder_v2_bricklet/<UID>/distance Callback verwendet werden. Der Callback wird mit der Funktion request/laser_range_finder_v2_bricklet/<UID>/set_distance_callback_configuration konfiguriert.

request/laser_range_finder_v2_bricklet/<UID>/get_velocity
Response-Payload:
  • velocity -- int

Gibt die gemessene Geschwindigkeit zurück. Der Wertebereich ist -12800 bis 12700 und die Werte haben die Einheit 1/100 m/s.

Die Geschwindigkeitsmessung liefert nur dann stabile Werte, wenn eine feste Messfrequenz (siehe request/laser_range_finder_v2_bricklet/<UID>/set_configuration) eingestellt ist. Zusätzlich muss der Laser aktiviert werden, siehe request/laser_range_finder_v2_bricklet/<UID>/set_enable.

Wenn der Wert periodisch benötigt wird, kann auch der register/laser_range_finder_v2_bricklet/<UID>/velocity Callback verwendet werden. Der Callback wird mit der Funktion request/laser_range_finder_v2_bricklet/<UID>/set_velocity_callback_configuration konfiguriert.

request/laser_range_finder_v2_bricklet/<UID>/set_enable
Request-Payload:
  • enable -- bool

Aktiviert den Laser des LIDAR wenn auf true gesetzt.

Wir empfehlen nach dem Aktivieren des Lasers 250ms zu warten bis zum ersten Aufruf von request/laser_range_finder_v2_bricklet/<UID>/get_distance um stabile Messwerte zu garantieren.

request/laser_range_finder_v2_bricklet/<UID>/get_enable
Response-Payload:
  • enable -- bool

Gibt den Wert zurück wie von request/laser_range_finder_v2_bricklet/<UID>/set_enable gesetzt.

request/laser_range_finder_v2_bricklet/<UID>/set_configuration
Request-Payload:
  • acquisition_count -- int
  • enable_quick_termination -- bool
  • threshold_value -- int
  • measurement_frequency -- int

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 in Hz 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.

request/laser_range_finder_v2_bricklet/<UID>/get_configuration
Response-Payload:
  • acquisition_count -- int
  • enable_quick_termination -- bool
  • threshold_value -- int
  • measurement_frequency -- int

Gibt die Konfiguration zurück, wie von request/laser_range_finder_v2_bricklet/<UID>/set_configuration gesetzt.

request/laser_range_finder_v2_bricklet/<UID>/set_distance_led_config
Request-Payload:
  • config -- int (hat Symbole)

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).

Der Standardwert ist 3 (Distanzanzeige).

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

für config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowDistance" = 3
request/laser_range_finder_v2_bricklet/<UID>/get_distance_led_config
Response-Payload:
  • config -- int (hat Symbole)

Gibt die LED-Konfiguration zurück, wie von request/laser_range_finder_v2_bricklet/<UID>/set_distance_led_config gesetzt.

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

für config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowDistance" = 3

Fortgeschrittene Funktionen

request/laser_range_finder_v2_bricklet/<UID>/set_moving_average
Request-Payload:
  • distance_average_length -- int
  • velocity_average_length -- int

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.

Der Wertebereich liegt bei 0-255.

Der Standardwert ist 10.

request/laser_range_finder_v2_bricklet/<UID>/get_moving_average
Response-Payload:
  • distance_average_length -- int
  • velocity_average_length -- int

Gibt die Länge des gleitenden Mittelwerts zurück, wie von request/laser_range_finder_v2_bricklet/<UID>/set_moving_average gesetzt.

request/laser_range_finder_v2_bricklet/<UID>/set_offset_calibration
Request-Payload:
  • offset -- int

Der Offset wird in cm gegeben 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.

request/laser_range_finder_v2_bricklet/<UID>/get_offset_calibration
Response-Payload:
  • offset -- int

Gibt den Offset-Wert zurück, wie von request/laser_range_finder_v2_bricklet/<UID>/set_offset_calibration gesetzt.

request/laser_range_finder_v2_bricklet/<UID>/get_spitfp_error_count
Response-Payload:
  • error_count_ack_checksum -- int
  • error_count_message_checksum -- int
  • error_count_frame -- int
  • error_count_overflow -- int

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

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.

request/laser_range_finder_v2_bricklet/<UID>/set_bootloader_mode
Request-Payload:
  • mode -- int (hat Symbole)
Response-Payload:
  • status -- int (hat Symbole)

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 Bootlodaer- 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:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4

für status:

  • "OK" = 0
  • "InvalidMode" = 1
  • "NoChange" = 2
  • "EntryFunctionNotPresent" = 3
  • "DeviceIdentifierIncorrect" = 4
  • "CRCMismatch" = 5
request/laser_range_finder_v2_bricklet/<UID>/get_bootloader_mode
Response-Payload:
  • mode -- int (hat Symbole)

Gibt den aktuellen Bootloader-Modus zurück, siehe request/laser_range_finder_v2_bricklet/<UID>/set_bootloader_mode.

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

für mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4
request/laser_range_finder_v2_bricklet/<UID>/set_write_firmware_pointer
Request-Payload:
  • pointer -- int

Setzt den Firmware-Pointer für request/laser_range_finder_v2_bricklet/<UID>/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.

request/laser_range_finder_v2_bricklet/<UID>/write_firmware
Request-Payload:
  • data -- [int,... (x64)]
Response-Payload:
  • status -- int

Schreibt 64 Bytes Firmware an die Position die vorher von request/laser_range_finder_v2_bricklet/<UID>/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.

request/laser_range_finder_v2_bricklet/<UID>/set_status_led_config
Request-Payload:
  • config -- int (hat Symbole)

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:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/laser_range_finder_v2_bricklet/<UID>/get_status_led_config
Response-Payload:
  • config -- int (hat Symbole)

Gibt die Konfiguration zurück, wie von request/laser_range_finder_v2_bricklet/<UID>/set_status_led_config gesetzt.

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

für config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/laser_range_finder_v2_bricklet/<UID>/get_chip_temperature
Response-Payload:
  • temperature -- int

Gibt die Temperatur in °C, 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.

request/laser_range_finder_v2_bricklet/<UID>/reset

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.

request/laser_range_finder_v2_bricklet/<UID>/write_uid
Request-Payload:
  • uid -- int

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.

request/laser_range_finder_v2_bricklet/<UID>/read_uid
Response-Payload:
  • uid -- int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

request/laser_range_finder_v2_bricklet/<UID>/get_identity
Response-Payload:
  • uid -- string
  • connected_uid -- string
  • position -- char
  • hardware_version -- [int,int,int]
  • firmware_version -- [int,int,int]
  • device_identifier -- int (hat Symbole)
  • _display_name -- string

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. 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 2.0.

Konfigurationsfunktionen für Callbacks

request/laser_range_finder_v2_bricklet/<UID>/set_distance_callback_configuration
Request-Payload:
  • period -- int
  • value_has_to_change -- bool
  • option -- char (hat Symbole)
  • min -- int
  • max -- int

Die Periode in ms ist die Periode mit der der register/laser_range_finder_v2_bricklet/<UID>/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 register/laser_range_finder_v2_bricklet/<UID>/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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/laser_range_finder_v2_bricklet/<UID>/get_distance_callback_configuration
Response-Payload:
  • period -- int
  • value_has_to_change -- bool
  • option -- char (hat Symbole)
  • min -- int
  • max -- int

Gibt die Callback-Konfiguration zurück, wie mittels request/laser_range_finder_v2_bricklet/<UID>/set_distance_callback_configuration gesetzt.

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

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/laser_range_finder_v2_bricklet/<UID>/set_velocity_callback_configuration
Request-Payload:
  • period -- int
  • value_has_to_change -- bool
  • option -- char (hat Symbole)
  • min -- int
  • max -- int

Die Periode in ms ist die Periode mit der der register/laser_range_finder_v2_bricklet/<UID>/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 register/laser_range_finder_v2_bricklet/<UID>/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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/laser_range_finder_v2_bricklet/<UID>/get_velocity_callback_configuration
Response-Payload:
  • period -- int
  • value_has_to_change -- bool
  • option -- char (hat Symbole)
  • min -- int
  • max -- int

Gibt die Callback-Konfiguration zurück, wie mittels request/laser_range_finder_v2_bricklet/<UID>/set_velocity_callback_configuration gesetzt.

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

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'

Callbacks

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_v2_bricklet/<UID>/distance
Request-Payload:
  • register -- bool
Response-Payload:
  • distance -- int

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/laser_range_finder_v2_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_v2_bricklet/<UID>/distance[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/laser_range_finder_v2_bricklet/<UID>/set_distance_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie request/laser_range_finder_v2_bricklet/<UID>/get_distance.

register/laser_range_finder_v2_bricklet/<UID>/velocity
Request-Payload:
  • register -- bool
Response-Payload:
  • velocity -- int

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/laser_range_finder_v2_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_v2_bricklet/<UID>/velocity[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/laser_range_finder_v2_bricklet/<UID>/set_velocity_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie request/laser_range_finder_v2_bricklet/<UID>/get_velocity.