C# - Laser Range Finder Bricklet¶

Simple¶

Download (ExampleSimple.cs)

 1using System;
 2using System.Threading;
 3using Tinkerforge;
 4
 5class Example
 6{
 7    private static string HOST = "localhost";
 8    private static int PORT = 4223;
 9    private static string UID = "XYZ"; // Change XYZ to the UID of your Laser Range Finder Bricklet
10
11    static void Main()
12    {
13        IPConnection ipcon = new IPConnection(); // Create IP connection
14        BrickletLaserRangeFinder lrf =
15          new BrickletLaserRangeFinder(UID, ipcon); // Create device object
16
17        ipcon.Connect(HOST, PORT); // Connect to brickd
18        // Don't use device before ipcon is connected
19
20        // Turn laser on and wait 250ms for very first measurement to be ready
21        lrf.EnableLaser();
22        Thread.Sleep(250);
23
24        // Get current distance
25        int distance = lrf.GetDistance();
26        Console.WriteLine("Distance: " + distance + " cm");
27
28        Console.WriteLine("Press enter to exit");
29        Console.ReadLine();
30
31        lrf.DisableLaser(); // Turn laser off
32
33        ipcon.Disconnect();
34    }
35}

Callback¶

Download (ExampleCallback.cs)

 1using System;
 2using System.Threading;
 3using Tinkerforge;
 4
 5class Example
 6{
 7    private static string HOST = "localhost";
 8    private static int PORT = 4223;
 9    private static string UID = "XYZ"; // Change XYZ to the UID of your Laser Range Finder Bricklet
10
11    // Callback function for distance callback
12    static void DistanceCB(BrickletLaserRangeFinder sender, int distance)
13    {
14        Console.WriteLine("Distance: " + distance + " cm");
15    }
16
17    static void Main()
18    {
19        IPConnection ipcon = new IPConnection(); // Create IP connection
20        BrickletLaserRangeFinder lrf =
21          new BrickletLaserRangeFinder(UID, ipcon); // Create device object
22
23        ipcon.Connect(HOST, PORT); // Connect to brickd
24        // Don't use device before ipcon is connected
25
26        // Turn laser on and wait 250ms for very first measurement to be ready
27        lrf.EnableLaser();
28        Thread.Sleep(250);
29
30        // Register distance callback to function DistanceCB
31        lrf.DistanceCallback += DistanceCB;
32
33        // Set period for distance callback to 0.2s (200ms)
34        // Note: The distance callback is only called every 0.2 seconds
35        //       if the distance has changed since the last call!
36        lrf.SetDistanceCallbackPeriod(200);
37
38        Console.WriteLine("Press enter to exit");
39        Console.ReadLine();
40
41        lrf.DisableLaser(); // Turn laser off
42
43        ipcon.Disconnect();
44    }
45}

Threshold¶

Download (ExampleThreshold.cs)

 1using System;
 2using System.Threading;
 3using Tinkerforge;
 4
 5class Example
 6{
 7    private static string HOST = "localhost";
 8    private static int PORT = 4223;
 9    private static string UID = "XYZ"; // Change XYZ to the UID of your Laser Range Finder Bricklet
10
11    // Callback function for distance reached callback
12    static void DistanceReachedCB(BrickletLaserRangeFinder sender, int distance)
13    {
14        Console.WriteLine("Distance: " + distance + " cm");
15    }
16
17    static void Main()
18    {
19        IPConnection ipcon = new IPConnection(); // Create IP connection
20        BrickletLaserRangeFinder lrf =
21          new BrickletLaserRangeFinder(UID, ipcon); // Create device object
22
23        ipcon.Connect(HOST, PORT); // Connect to brickd
24        // Don't use device before ipcon is connected
25
26        // Turn laser on and wait 250ms for very first measurement to be ready
27        lrf.EnableLaser();
28        Thread.Sleep(250);
29
30        // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
31        lrf.SetDebouncePeriod(10000);
32
33        // Register distance reached callback to function DistanceReachedCB
34        lrf.DistanceReachedCallback += DistanceReachedCB;
35
36        // Configure threshold for distance "greater than 20 cm"
37        lrf.SetDistanceCallbackThreshold('>', 20, 0);
38
39        Console.WriteLine("Press enter to exit");
40        Console.ReadLine();
41
42        lrf.DisableLaser(); // Turn laser off
43
44        ipcon.Disconnect();
45    }
46}

Grundfunktionen¶

class BrickletLaserRangeFinder(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	laserRangeFinder – Typ: BrickletLaserRangeFinder

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

BrickletLaserRangeFinder laserRangeFinder = new BrickletLaserRangeFinder("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

int BrickletLaserRangeFinder.GetDistance()¶

Rückgabe:	distance – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 4000]

Gibt die gemessene Distanz zurück.

Sensor Hardware Version 1 (siehe GetSensorHardwareVersion()) kann nicht gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels SetMode() der Distanzmodus aktiviert sein. Sensor Hardware Version 3 kann gleichzeitig Distanz und Geschwindigkeit messen. Zusätzlich muss der Laser aktiviert werden, siehe EnableLaser().

Wenn der Entfernungswert periodisch abgefragt werden soll, wird empfohlen den DistanceCallback Callback zu nutzen und die Periode mit SetDistanceCallbackPeriod() vorzugeben.

short BrickletLaserRangeFinder.GetVelocity()¶

Rückgabe:	velocity – Typ: short, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Gibt die gemessene Geschwindigkeit zurück.

Sensor Hardware Version 1 (siehe GetSensorHardwareVersion()) kann nicht gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels SetMode() 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 SetConfiguration()) eingestellt ist. Zusätzlich muss der Laser aktiviert werden, siehe EnableLaser().

Wenn der Geschwindigkeitswert periodisch abgefragt werden soll, wird empfohlen den VelocityCallback Callback zu nutzen und die Periode mit SetVelocityCallbackPeriod() vorzugeben.

void BrickletLaserRangeFinder.SetMode(byte mode)¶

Parameter:	mode – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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 SetConfiguration(). die Hardware Version des Sensors kann mittels GetSensorHardwareVersion() 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 Konstanten sind für diese Funktion verfügbar:

Für mode:

• BrickletLaserRangeFinder.MODE_DISTANCE = 0

• BrickletLaserRangeFinder.MODE_VELOCITY_MAX_13MS = 1

• BrickletLaserRangeFinder.MODE_VELOCITY_MAX_32MS = 2

• BrickletLaserRangeFinder.MODE_VELOCITY_MAX_64MS = 3

• BrickletLaserRangeFinder.MODE_VELOCITY_MAX_127MS = 4

byte BrickletLaserRangeFinder.GetMode()¶

Rückgabe:	mode – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den Modus zurück, wie von SetMode() gesetzt.

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

Für mode:

• BrickletLaserRangeFinder.MODE_DISTANCE = 0

• BrickletLaserRangeFinder.MODE_VELOCITY_MAX_13MS = 1

• BrickletLaserRangeFinder.MODE_VELOCITY_MAX_32MS = 2

• BrickletLaserRangeFinder.MODE_VELOCITY_MAX_64MS = 3

• BrickletLaserRangeFinder.MODE_VELOCITY_MAX_127MS = 4

void BrickletLaserRangeFinder.EnableLaser()¶

Aktiviert den Laser des LIDAR.

Wir empfehlen nach dem aktivieren des Lasers 250ms zu warten bis zum ersten Aufruf von GetDistance() um stabile Messwerte zu garantieren.

void BrickletLaserRangeFinder.DisableLaser()¶

Deaktiviert den Laser des LIDAR.

bool BrickletLaserRangeFinder.IsLaserEnabled()¶

Rückgabe:	laserEnabled – Typ: bool

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

void BrickletLaserRangeFinder.SetConfiguration(byte acquisitionCount, bool enableQuickTermination, byte thresholdValue, int measurementFrequency)¶

Parameter:	acquisitionCount – Typ: byte, Wertebereich: [1 bis 255], Standardwert: 128 enableQuickTermination – Typ: bool, Standardwert: false thresholdValue – Typ: byte, Wertebereich: [0 bis 255], Standardwert: 0 measurementFrequency – Typ: int, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0

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 SetMode(). Die Hardware Version des Sensors kann mittels GetSensorHardwareVersion() 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).

Added in version 2.0.3$nbsp;(Plugin).

void BrickletLaserRangeFinder.GetConfiguration(out byte acquisitionCount, out bool enableQuickTermination, out byte thresholdValue, out int measurementFrequency)¶

Ausgabeparameter:	acquisitionCount – Typ: byte, Wertebereich: [1 bis 255], Standardwert: 128 enableQuickTermination – Typ: bool, Standardwert: false thresholdValue – Typ: byte, Wertebereich: [0 bis 255], Standardwert: 0 measurementFrequency – Typ: int, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0

Gibt die Konfiguration zurück, wie von SetConfiguration() gesetzt.

Added in version 2.0.3$nbsp;(Plugin).

Fortgeschrittene Funktionen¶

void BrickletLaserRangeFinder.SetMovingAverage(byte distanceAverageLength, byte velocityAverageLength)¶

Parameter:	distanceAverageLength – Typ: byte, Wertebereich: [0 bis 30], Standardwert: 10 velocityAverageLength – Typ: byte, Wertebereich: [0 bis 30], Standardwert: 10

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.

void BrickletLaserRangeFinder.GetMovingAverage(out byte distanceAverageLength, out byte velocityAverageLength)¶

Ausgabeparameter:	distanceAverageLength – Typ: byte, Wertebereich: [0 bis 30], Standardwert: 10 velocityAverageLength – Typ: byte, Wertebereich: [0 bis 30], Standardwert: 10

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

byte BrickletLaserRangeFinder.GetSensorHardwareVersion()¶

Rückgabe:	version – Typ: byte, Wertebereich: Siehe Konstanten

Gibt die LIDAR-Lite Hardware version zurück.

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

Für version:

• BrickletLaserRangeFinder.VERSION_1 = 1

• BrickletLaserRangeFinder.VERSION_3 = 3

Added in version 2.0.3$nbsp;(Plugin).

void BrickletLaserRangeFinder.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶

Ausgabeparameter:

uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

void BrickletLaserRangeFinder.SetDistanceCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

long BrickletLaserRangeFinder.GetDistanceCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetDistanceCallbackPeriod() gesetzt.

void BrickletLaserRangeFinder.SetVelocityCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

long BrickletLaserRangeFinder.GetVelocityCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetVelocityCallbackPeriod() gesetzt.

void BrickletLaserRangeFinder.SetDistanceCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den DistanceReachedCallback 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 Konstanten sind für diese Funktion verfügbar:

Für option:

• BrickletLaserRangeFinder.THRESHOLD_OPTION_OFF = 'x'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_SMALLER = '<'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_GREATER = '>'

void BrickletLaserRangeFinder.GetDistanceCallbackThreshold(out char option, out int min, out int max)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetDistanceCallbackThreshold() gesetzt.

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

Für option:

• BrickletLaserRangeFinder.THRESHOLD_OPTION_OFF = 'x'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_SMALLER = '<'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_GREATER = '>'

void BrickletLaserRangeFinder.SetVelocityCallbackThreshold(char option, short min, short max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: short, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: short, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den VelocityReachedCallback 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 Konstanten sind für diese Funktion verfügbar:

Für option:

• BrickletLaserRangeFinder.THRESHOLD_OPTION_OFF = 'x'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_SMALLER = '<'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_GREATER = '>'

void BrickletLaserRangeFinder.GetVelocityCallbackThreshold(out char option, out short min, out short max)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: short, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: short, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetVelocityCallbackThreshold() gesetzt.

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

Für option:

• BrickletLaserRangeFinder.THRESHOLD_OPTION_OFF = 'x'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_SMALLER = '<'

• BrickletLaserRangeFinder.THRESHOLD_OPTION_GREATER = '>'

void BrickletLaserRangeFinder.SetDebouncePeriod(long debounce)¶

Parameter:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

• DistanceReachedCallback,

• VelocityReachedCallback,

ausgelöst werden, wenn die Schwellwerte

• SetDistanceCallbackThreshold(),

• SetVelocityCallbackThreshold(),

weiterhin erreicht bleiben.

long BrickletLaserRangeFinder.GetDebouncePeriod()¶

Rückgabe:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:

void MyCallback(BrickletLaserRangeFinder sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

laserRangeFinder.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

event BrickletLaserRangeFinder.DistanceCallback(BrickletLaserRangeFinder sender, int distance)¶

Callback-Parameter:	sender – Typ: BrickletLaserRangeFinder distance – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 4000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetDistanceCallbackPeriod(), ausgelöst. Der Parameter ist die Entfernungswert des Sensors.

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

event BrickletLaserRangeFinder.VelocityCallback(BrickletLaserRangeFinder sender, short velocity)¶

Callback-Parameter:	sender – Typ: BrickletLaserRangeFinder velocity – Typ: short, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Dieser Callback wird mit der Periode, wie gesetzt mit SetVelocityCallbackPeriod(), ausgelöst. Der Parameter ist die Geschwindigkeit des Sensors.

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

event BrickletLaserRangeFinder.DistanceReachedCallback(BrickletLaserRangeFinder sender, int distance)¶

Callback-Parameter:	sender – Typ: BrickletLaserRangeFinder distance – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 4000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetDistanceCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Entfernungswert des Sensors.

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

event BrickletLaserRangeFinder.VelocityReachedCallback(BrickletLaserRangeFinder sender, short velocity)¶

Callback-Parameter:	sender – Typ: BrickletLaserRangeFinder velocity – Typ: short, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetVelocityCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Geschwindigkeitswert des Sensors.

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

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

byte[] BrickletLaserRangeFinder.GetAPIVersion()¶

Ausgabeparameter:	apiVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

bool BrickletLaserRangeFinder.GetResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

• BrickletLaserRangeFinder.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 3

• BrickletLaserRangeFinder.FUNCTION_SET_VELOCITY_CALLBACK_PERIOD = 5

• BrickletLaserRangeFinder.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 7

• BrickletLaserRangeFinder.FUNCTION_SET_VELOCITY_CALLBACK_THRESHOLD = 9

• BrickletLaserRangeFinder.FUNCTION_SET_DEBOUNCE_PERIOD = 11

• BrickletLaserRangeFinder.FUNCTION_SET_MOVING_AVERAGE = 13

• BrickletLaserRangeFinder.FUNCTION_SET_MODE = 15

• BrickletLaserRangeFinder.FUNCTION_ENABLE_LASER = 17

• BrickletLaserRangeFinder.FUNCTION_DISABLE_LASER = 18

• BrickletLaserRangeFinder.FUNCTION_SET_CONFIGURATION = 25

void BrickletLaserRangeFinder.SetResponseExpected(byte functionId, bool responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

• BrickletLaserRangeFinder.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 3

• BrickletLaserRangeFinder.FUNCTION_SET_VELOCITY_CALLBACK_PERIOD = 5

• BrickletLaserRangeFinder.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 7

• BrickletLaserRangeFinder.FUNCTION_SET_VELOCITY_CALLBACK_THRESHOLD = 9

• BrickletLaserRangeFinder.FUNCTION_SET_DEBOUNCE_PERIOD = 11

• BrickletLaserRangeFinder.FUNCTION_SET_MOVING_AVERAGE = 13

• BrickletLaserRangeFinder.FUNCTION_SET_MODE = 15

• BrickletLaserRangeFinder.FUNCTION_ENABLE_LASER = 17

• BrickletLaserRangeFinder.FUNCTION_DISABLE_LASER = 18

• BrickletLaserRangeFinder.FUNCTION_SET_CONFIGURATION = 25

void BrickletLaserRangeFinder.SetResponseExpectedAll(bool responseExpected)¶

Parameter:	responseExpected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten¶

int BrickletLaserRangeFinder.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Laser Range Finder Bricklet zu identifizieren.

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickletLaserRangeFinder.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Laser Range Finder Bricklet dar.