Dies ist die Beschreibung des TCP/IP Protokolls 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 allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.
BrickletLaserRangeFinderV2.
get_distance
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die gemessene Distanz zurück.
Der Laser muss aktiviert werden, siehe set_enable
.
Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_DISTANCE
Callback
verwendet werden. Der Callback wird mit der Funktion
set_distance_callback_configuration
konfiguriert.
BrickletLaserRangeFinderV2.
get_velocity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 CALLBACK_VELOCITY
Callback
verwendet werden. Der Callback wird mit der Funktion
set_velocity_callback_configuration
konfiguriert.
BrickletLaserRangeFinderV2.
set_enable
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletLaserRangeFinderV2.
get_enable
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Wert zurück wie von set_enable
gesetzt.
BrickletLaserRangeFinderV2.
set_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletLaserRangeFinderV2.
get_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Konfiguration zurück, wie von set_configuration
gesetzt.
BrickletLaserRangeFinderV2.
set_distance_led_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für config:
BrickletLaserRangeFinderV2.
get_distance_led_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die LED-Konfiguration zurück, wie von set_distance_led_config
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für config:
BrickletLaserRangeFinderV2.
set_moving_average
¶Funktions-ID: |
|
---|---|
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.
BrickletLaserRangeFinderV2.
get_moving_average
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Länge des gleitenden Mittelwerts zurück, wie von
set_moving_average
gesetzt.
BrickletLaserRangeFinderV2.
set_offset_calibration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletLaserRangeFinderV2.
get_offset_calibration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Offset-Wert zurück, wie von set_offset_calibration
gesetzt.
BrickletLaserRangeFinderV2.
get_spitfp_error_count
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletLaserRangeFinderV2.
set_status_led_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für config:
BrickletLaserRangeFinderV2.
get_status_led_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Konfiguration zurück, wie von set_status_led_config
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für config:
BrickletLaserRangeFinderV2.
get_chip_temperature
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletLaserRangeFinderV2.
reset
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletLaserRangeFinderV2.
get_identity
¶Funktions-ID: |
|
---|---|
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.
BrickletLaserRangeFinderV2.
set_distance_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Die Periode ist die Periode mit der der CALLBACK_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 CALLBACK_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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletLaserRangeFinderV2.
get_distance_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels set_distance_callback_configuration
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletLaserRangeFinderV2.
set_velocity_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Die Periode ist die Periode mit der der CALLBACK_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 CALLBACK_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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletLaserRangeFinderV2.
get_velocity_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels set_velocity_callback_configuration
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletLaserRangeFinderV2.
CALLBACK_DISTANCE
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set_distance_callback_configuration
gesetzten Konfiguration
Der Rückgabewert ist der gleiche wie get_distance
.
BrickletLaserRangeFinderV2.
CALLBACK_VELOCITY
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set_velocity_callback_configuration
gesetzten Konfiguration
Der Rückgabewert 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.
BrickletLaserRangeFinderV2.
set_bootloader_mode
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für mode:
Für status:
BrickletLaserRangeFinderV2.
get_bootloader_mode
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode
.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für mode:
BrickletLaserRangeFinderV2.
set_write_firmware_pointer
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletLaserRangeFinderV2.
write_firmware
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletLaserRangeFinderV2.
write_uid
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletLaserRangeFinderV2.
read_uid
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.