Spezifikationen / Modbus Protokoll / API / Bricklets (Abgekündigt) / Laser Range Finder Bricklet

Modbus - Laser Range Finder Bricklet¶

Dies ist die Beschreibung des Modbus Protokolls 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.

API¶

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletLaserRangeFinder.get_distance¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	distance – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 4000]

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 CALLBACK_DISTANCE Callback zu nutzen und die Periode mit set_distance_callback_period vorzugeben.

BrickletLaserRangeFinder.get_velocity¶

Funktions-ID:	2
Anfrage:	keine Nutzdaten
Antwort:	velocity – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

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 CALLBACK_VELOCITY Callback zu nutzen und die Periode mit set_velocity_callback_period vorzugeben.

BrickletLaserRangeFinder.set_mode¶

Funktions-ID:	15
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
Antwort:	keine 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 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:

0: Distanz wird gemessen mit Auflösung 1,0 cm und Wertebereich 0-4000 cm
1: Geschwindigkeit wird gemessen mit Auflösung 0,1 m/s und Wertebereich 0-12,7 m/s
2: Geschwindigkeit wird gemessen mit Auflösung 0,25 m/s und Wertebereich 0-31,75 m/s
3: Geschwindigkeit wird gemessen mit Auflösung 0,5 m/s und Wertebereich 0-63,5 m/s
4: Geschwindigkeit wird gemessen mit Auflösung 1,0 m/s und Wertebereich 0-127 m/s

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

0 = Distance
1 = Velocity Max 13ms
2 = Velocity Max 32ms
3 = Velocity Max 64ms
4 = Velocity Max 127ms

BrickletLaserRangeFinder.get_mode¶

Funktions-ID:	16
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

Gibt den Modus zurück, wie von set_mode gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

0 = Distance
1 = Velocity Max 13ms
2 = Velocity Max 32ms
3 = Velocity Max 64ms
4 = Velocity Max 127ms

BrickletLaserRangeFinder.enable_laser¶

Funktions-ID:	17
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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.

BrickletLaserRangeFinder.disable_laser¶

Funktions-ID:	18
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Deaktiviert den Laser des LIDAR.

BrickletLaserRangeFinder.is_laser_enabled¶

Funktions-ID:	19
Anfrage:	keine Nutzdaten
Antwort:	laser_enabled – Typ: bool

Gibt true zurück wenn der Laser aktiviert ist, false sonst.

BrickletLaserRangeFinder.set_configuration¶

Funktions-ID:	25
Anfrage:	acquisition_count – Typ: uint8, Wertebereich: [1 bis 255], Standardwert: 128 enable_quick_termination – Typ: bool, Standardwert: false threshold_value – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 0 measurement_frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0
Antwort:	keine 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 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).

BrickletLaserRangeFinder.get_configuration¶

Funktions-ID:	26
Anfrage:	keine Nutzdaten
Antwort:	acquisition_count – Typ: uint8, Wertebereich: [1 bis 255], Standardwert: 128 enable_quick_termination – Typ: bool, Standardwert: false threshold_value – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 0 measurement_frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0

Gibt die Konfiguration zurück, wie von set_configuration gesetzt.

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen¶

BrickletLaserRangeFinder.set_moving_average¶

Funktions-ID:	13
Anfrage:	distance_average_length – Typ: uint8, Wertebereich: [0 bis 30], Standardwert: 10 velocity_average_length – Typ: uint8, Wertebereich: [0 bis 30], Standardwert: 10
Antwort:	keine 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.

BrickletLaserRangeFinder.get_moving_average¶

Funktions-ID:	14
Anfrage:	keine Nutzdaten
Antwort:	distance_average_length – Typ: uint8, Wertebereich: [0 bis 30], Standardwert: 10 velocity_average_length – Typ: uint8, Wertebereich: [0 bis 30], Standardwert: 10

Gibt die Länge des gleitenden Mittelwerts zurück, wie von set_moving_average gesetzt.

BrickletLaserRangeFinder.get_sensor_hardware_version¶

Funktions-ID:	24
Anfrage:	keine Nutzdaten
Antwort:	version – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt die LIDAR-Lite Hardware version zurück.

Neu in Version 2.0.3 (Plugin).

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für version:

1 = 1
3 = 3

BrickletLaserRangeFinder.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] device_identifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]

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.

Konfigurationsfunktionen für Callbacks¶

BrickletLaserRangeFinder.set_distance_callback_period¶

Funktions-ID:	3
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der CALLBACK_DISTANCE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CALLBACK_DISTANCE Callback wird nur ausgelöst, wenn sich der Entfernungswert seit der letzten Auslösung geändert hat.

BrickletLaserRangeFinder.get_distance_callback_period¶

Funktions-ID:	4
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_distance_callback_period gesetzt.

BrickletLaserRangeFinder.set_velocity_callback_period¶

Funktions-ID:	5
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der CALLBACK_VELOCITY Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CALLBACK_VELOCITY Callback wird nur ausgelöst, wenn sich der Geschwindigkeitswert seit der letzten Auslösung geändert hat.

BrickletLaserRangeFinder.get_velocity_callback_period¶

Funktions-ID:	6
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_velocity_callback_period gesetzt.

BrickletLaserRangeFinder.set_distance_callback_threshold¶

Funktions-ID:	7
Anfrage:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den CALLBACK_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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

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

BrickletLaserRangeFinder.get_distance_callback_threshold¶

Funktions-ID:	8
Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_distance_callback_threshold gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

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

BrickletLaserRangeFinder.set_velocity_callback_threshold¶

Funktions-ID:	9
Anfrage:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den CALLBACK_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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

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

BrickletLaserRangeFinder.get_velocity_callback_threshold¶

Funktions-ID:	10
Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_velocity_callback_threshold gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

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

BrickletLaserRangeFinder.set_debounce_period¶

Funktions-ID:	11
Anfrage:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Antwort:	keine Antwort

Setzt die Periode mit welcher die Schwellwert Callbacks

CALLBACK_DISTANCE_REACHED,
CALLBACK_VELOCITY_REACHED,

ausgelöst werden, wenn die Schwellwerte

set_distance_callback_threshold,
set_velocity_callback_threshold,

weiterhin erreicht bleiben.

BrickletLaserRangeFinder.get_debounce_period¶

Funktions-ID:	12
Anfrage:	keine Nutzdaten
Antwort:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set_debounce_period gesetzt.

Callbacks¶

BrickletLaserRangeFinder.CALLBACK_DISTANCE¶

Funktions-ID:	20
Antwort:	distance – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 4000]

Dieser Callback wird mit der Periode, wie gesetzt mit set_distance_callback_period, ausgelöst. Der Rückgabewert ist die Entfernungswert des Sensors.

Der CALLBACK_DISTANCE Callback wird nur ausgelöst, wenn sich der Entfernungswert seit der letzten Auslösung geändert hat.

BrickletLaserRangeFinder.CALLBACK_VELOCITY¶

Funktions-ID:	21
Antwort:	velocity – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Dieser Callback wird mit der Periode, wie gesetzt mit set_velocity_callback_period, ausgelöst. Der Rückgabewert ist die Geschwindigkeit des Sensors.

Der CALLBACK_VELOCITY Callback wird nur ausgelöst, wenn sich der Geschwindigkeitswert seit der letzten Auslösung geändert hat.

BrickletLaserRangeFinder.CALLBACK_DISTANCE_REACHED¶

Funktions-ID:	22
Antwort:	distance – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 4000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_distance_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist der Entfernungswert des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set_debounce_period gesetzt, ausgelöst.

BrickletLaserRangeFinder.CALLBACK_VELOCITY_REACHED¶

Funktions-ID:	23
Antwort:	velocity – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_velocity_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist der Geschwindigkeitswert des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set_debounce_period gesetzt, ausgelöst.