Mathematica - Laser Range Finder Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Laser Range Finder Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
lrf=NETNew["Tinkerforge.BrickletLaserRangeFinder",uid,ipcon]
ipcon@Connect[host,port]

(*Turn laser on and wait 250ms for very first measurement to be ready*)
lrf@EnableLaser[]
Pause[0.25]

(*Get current distance*)
Print["Distance: "<>ToString[N[Quantity[lrf@GetDistance[],"cm"]]]]

(*Clean up*)
lrf@DisableLaser[](*Turn laser off*)
ipcon@Disconnect[]
ReleaseNETObject[lrf]
ReleaseNETObject[ipcon]

Callback

Download (ExampleCallback.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Laser Range Finder Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
lrf=NETNew["Tinkerforge.BrickletLaserRangeFinder",uid,ipcon]
ipcon@Connect[host,port]

(*Turn laser on and wait 250ms for very first measurement to be ready*)
lrf@EnableLaser[]
Pause[0.25]

(*Callback function for distance callback*)
DistanceCB[sender_,distance_]:=
 Print["Distance: "<>ToString[N[Quantity[distance,"cm"]]]]
AddEventHandler[lrf@DistanceCallback,DistanceCB]

(*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!*)
lrf@SetDistanceCallbackPeriod[200]

Input["Click OK to exit"]

(*Clean up*)
lrf@DisableLaser[](*Turn laser off*)
ipcon@Disconnect[]
ReleaseNETObject[lrf]
ReleaseNETObject[ipcon]

Threshold

Download (ExampleThreshold.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Laser Range Finder Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
lrf=NETNew["Tinkerforge.BrickletLaserRangeFinder",uid,ipcon]
ipcon@Connect[host,port]

(*Turn laser on and wait 250ms for very first measurement to be ready*)
lrf@EnableLaser[]
Pause[0.25]

(*Get threshold callbacks with a debounce time of 10 seconds (10000ms)*)
lrf@SetDebouncePeriod[10000]

(*Callback function for distance reached callback*)
DistanceReachedCB[sender_,distance_]:=
 Print["Distance: "<>ToString[N[Quantity[distance,"cm"]]]]
AddEventHandler[lrf@DistanceReachedCallback,DistanceReachedCB]

(*Configure threshold for distance "greater than 20 cm"*)
option=Tinkerforge`BrickletLaserRangeFinder`THRESHOLDUOPTIONUGREATER
lrf@SetDistanceCallbackThreshold[option,20,0]

Input["Click OK to exit"]

(*Clean up*)
lrf@DisableLaser[](*Turn laser off*)
ipcon@Disconnect[]
ReleaseNETObject[lrf]
ReleaseNETObject[ipcon]

API

Prinzipiell kann jede Funktion der Mathematica Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Da .NET/Link nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben. Weitere Informationen über das out Schlüsselwort in .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletLaserRangeFinder[uid, ipcon] → laserRangeFinder
Parameter:
  • uid – Typ: String
  • ipcon – Typ: NETObject[IPConnection]
Rückgabe:
  • laserRangeFinder – Typ: NETObject[BrickletLaserRangeFinder]

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

laserRangeFinder=NETNew["Tinkerforge.BrickletLaserRangeFinder","YOUR_DEVICE_UID",ipcon]

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

Die .NET Runtime hat eingebauten Garbage Collection welche Objekte wieder freigibt, wenn sie vom Programm nicht mehr verwendet werden. Da Mathematica aber selbst nicht automatisch feststellen kann, wann ein Mathematica "Programm" ein .NET Objekt nicht mehr verwendet, muss sich das Programm selbst darum kümmern. Für diesen Zweck wird die ReleaseNETObject[] Funktion in den Beispielen verwendet.

Weitere Informationen über Objekt-Verwaltung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

BrickletLaserRangeFinder@GetDistance[] → distance
Rückgabe:
  • distance – Typ: Integer, 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.

BrickletLaserRangeFinder@GetVelocity[] → velocity
Rückgabe:
  • velocity – Typ: Integer, 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.

BrickletLaserRangeFinder@SetMode[mode] → Null
Parameter:
  • mode – Typ: Integer, 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`MODEUDISTANCE = 0
  • BrickletLaserRangeFinder`MODEUVELOCITYUMAXU13MS = 1
  • BrickletLaserRangeFinder`MODEUVELOCITYUMAXU32MS = 2
  • BrickletLaserRangeFinder`MODEUVELOCITYUMAXU64MS = 3
  • BrickletLaserRangeFinder`MODEUVELOCITYUMAXU127MS = 4
BrickletLaserRangeFinder@GetMode[] → mode
Rückgabe:
  • mode – Typ: Integer, 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`MODEUDISTANCE = 0
  • BrickletLaserRangeFinder`MODEUVELOCITYUMAXU13MS = 1
  • BrickletLaserRangeFinder`MODEUVELOCITYUMAXU32MS = 2
  • BrickletLaserRangeFinder`MODEUVELOCITYUMAXU64MS = 3
  • BrickletLaserRangeFinder`MODEUVELOCITYUMAXU127MS = 4
BrickletLaserRangeFinder@EnableLaser[] → Null

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.

BrickletLaserRangeFinder@DisableLaser[] → Null

Deaktiviert den Laser des LIDAR.

BrickletLaserRangeFinder@IsLaserEnabled[] → laserEnabled
Rückgabe:
  • laserEnabled – Typ: True/False

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

BrickletLaserRangeFinder@SetConfiguration[acquisitionCount, enableQuickTermination, thresholdValue, measurementFrequency] → Null
Parameter:
  • acquisitionCount – Typ: Integer, Wertebereich: [1 bis 255], Standardwert: 128
  • enableQuickTermination – Typ: True/False, Standardwert: False
  • thresholdValue – Typ: Integer, Wertebereich: [0 bis 255], Standardwert: 0
  • measurementFrequency – Typ: Integer, 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 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).

Neu in Version 2.0.3 (Plugin).

BrickletLaserRangeFinder@GetConfiguration[out acquisitionCount, out enableQuickTermination, out thresholdValue, out measurementFrequency] → Null
Ausgabeparameter:
  • acquisitionCount – Typ: Integer, Wertebereich: [1 bis 255], Standardwert: 128
  • enableQuickTermination – Typ: True/False, Standardwert: False
  • thresholdValue – Typ: Integer, Wertebereich: [0 bis 255], Standardwert: 0
  • measurementFrequency – Typ: Integer, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0

Gibt die Konfiguration zurück, wie von SetConfiguration[] gesetzt.

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen

BrickletLaserRangeFinder@SetMovingAverage[distanceAverageLength, velocityAverageLength] → Null
Parameter:
  • distanceAverageLength – Typ: Integer, Wertebereich: [0 bis 30], Standardwert: 10
  • velocityAverageLength – Typ: Integer, 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.

BrickletLaserRangeFinder@GetMovingAverage[out distanceAverageLength, out velocityAverageLength] → Null
Ausgabeparameter:
  • distanceAverageLength – Typ: Integer, Wertebereich: [0 bis 30], Standardwert: 10
  • velocityAverageLength – Typ: Integer, Wertebereich: [0 bis 30], Standardwert: 10

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

BrickletLaserRangeFinder@GetSensorHardwareVersion[] → version
Rückgabe:
  • version – Typ: Integer, 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`VERSIONU1 = 1
  • BrickletLaserRangeFinder`VERSIONU3 = 3

Neu in Version 2.0.3 (Plugin).

BrickletLaserRangeFinder@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Ausgabeparameter:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Integer, Wertebereich: [ToCharacterCode["a"][[0]] bis ToCharacterCode["h"][[0]], ToCharacterCode["i"][[0]], ToCharacterCode["z"][[0]]]
  • hardwareVersioni – Typ: Integer
    • 1: major – Typ: Integer, Wertebereich: [0 bis 255]
    • 2: minor – Typ: Integer, Wertebereich: [0 bis 255]
    • 3: revision – Typ: Integer, Wertebereich: [0 bis 255]
  • firmwareVersioni – Typ: Integer
    • 1: major – Typ: Integer, Wertebereich: [0 bis 255]
    • 2: minor – Typ: Integer, Wertebereich: [0 bis 255]
    • 3: revision – Typ: Integer, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: Integer, 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

BrickletLaserRangeFinder@SetDistanceCallbackPeriod[period] → Null
Parameter:
  • period – Typ: Integer, 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.

BrickletLaserRangeFinder@GetDistanceCallbackPeriod[] → period
Rückgabe:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetDistanceCallbackPeriod[] gesetzt.

BrickletLaserRangeFinder@SetVelocityCallbackPeriod[period] → Null
Parameter:
  • period – Typ: Integer, 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.

BrickletLaserRangeFinder@GetVelocityCallbackPeriod[] → period
Rückgabe:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetVelocityCallbackPeriod[] gesetzt.

BrickletLaserRangeFinder@SetDistanceCallbackThreshold[option, min, max] → Null
Parameter:
  • option – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: ToCharacterCode["x"][[0]]
  • min – Typ: Integer, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: Integer, 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`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletLaserRangeFinder@GetDistanceCallbackThreshold[out option, out min, out max] → Null
Ausgabeparameter:
  • option – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: ToCharacterCode["x"][[0]]
  • min – Typ: Integer, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: Integer, 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`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletLaserRangeFinder@SetVelocityCallbackThreshold[option, min, max] → Null
Parameter:
  • option – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: ToCharacterCode["x"][[0]]
  • min – Typ: Integer, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: Integer, 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`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletLaserRangeFinder@GetVelocityCallbackThreshold[out option, out min, out max] → Null
Ausgabeparameter:
  • option – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: ToCharacterCode["x"][[0]]
  • min – Typ: Integer, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: Integer, 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`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletLaserRangeFinder`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletLaserRangeFinder@SetDebouncePeriod[debounce] → Null
Parameter:
  • debounce – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

BrickletLaserRangeFinder@GetDebouncePeriod[] → debounce
Rückgabe:
  • debounce – Typ: Integer, 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 erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[laserRangeFinder@ExampleCallback,MyCallback]

Weitere Informationen über Event-Behandlung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

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.

event BrickletLaserRangeFinder@DistanceCallback[sender, distance]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletLaserRangeFinder]
  • distance – Typ: Integer, 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[sender, velocity]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletLaserRangeFinder]
  • velocity – Typ: Integer, 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[sender, distance]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletLaserRangeFinder]
  • distance – Typ: Integer, 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[sender, velocity]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletLaserRangeFinder]
  • velocity – Typ: Integer, 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.

BrickletLaserRangeFinder@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Ausgabeparameter:
  • apiVersioni – Typ: Integer
    • 1: major – Typ: Integer, Wertebereich: [0 bis 255]
    • 2: minor – Typ: Integer, Wertebereich: [0 bis 255]
    • 3: revision – Typ: Integer, 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.

BrickletLaserRangeFinder@GetResponseExpected[functionId] → responseExpected
Parameter:
  • functionId – Typ: Integer, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: True/False

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`FUNCTIONUSETUDISTANCEUCALLBACKUPERIOD = 3
  • BrickletLaserRangeFinder`FUNCTIONUSETUVELOCITYUCALLBACKUPERIOD = 5
  • BrickletLaserRangeFinder`FUNCTIONUSETUDISTANCEUCALLBACKUTHRESHOLD = 7
  • BrickletLaserRangeFinder`FUNCTIONUSETUVELOCITYUCALLBACKUTHRESHOLD = 9
  • BrickletLaserRangeFinder`FUNCTIONUSETUDEBOUNCEUPERIOD = 11
  • BrickletLaserRangeFinder`FUNCTIONUSETUMOVINGUAVERAGE = 13
  • BrickletLaserRangeFinder`FUNCTIONUSETUMODE = 15
  • BrickletLaserRangeFinder`FUNCTIONUENABLEULASER = 17
  • BrickletLaserRangeFinder`FUNCTIONUDISABLEULASER = 18
  • BrickletLaserRangeFinder`FUNCTIONUSETUCONFIGURATION = 25
BrickletLaserRangeFinder@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId – Typ: Integer, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: True/False

Ä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`FUNCTIONUSETUDISTANCEUCALLBACKUPERIOD = 3
  • BrickletLaserRangeFinder`FUNCTIONUSETUVELOCITYUCALLBACKUPERIOD = 5
  • BrickletLaserRangeFinder`FUNCTIONUSETUDISTANCEUCALLBACKUTHRESHOLD = 7
  • BrickletLaserRangeFinder`FUNCTIONUSETUVELOCITYUCALLBACKUTHRESHOLD = 9
  • BrickletLaserRangeFinder`FUNCTIONUSETUDEBOUNCEUPERIOD = 11
  • BrickletLaserRangeFinder`FUNCTIONUSETUMOVINGUAVERAGE = 13
  • BrickletLaserRangeFinder`FUNCTIONUSETUMODE = 15
  • BrickletLaserRangeFinder`FUNCTIONUENABLEULASER = 17
  • BrickletLaserRangeFinder`FUNCTIONUDISABLEULASER = 18
  • BrickletLaserRangeFinder`FUNCTIONUSETUCONFIGURATION = 25
BrickletLaserRangeFinder@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected – Typ: True/False

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

Konstanten

BrickletLaserRangeFinder`DEVICEUIDENTIFIER

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.

BrickletLaserRangeFinder`DEVICEDISPLAYNAME

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