MATLAB/Octave - Laser Range Finder Bricklet¶

Simple (MATLAB)¶

Download (matlab_example_simple.m)

 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

function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLaserRangeFinder;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Laser Range Finder Bricklet

    ipcon = IPConnection(); % Create IP connection
    lrf = handle(BrickletLaserRangeFinder(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Turn laser on and wait 250ms for very first measurement to be ready
    lrf.enableLaser();
    pause(0.25);

    % Get current distance
    distance = lrf.getDistance();
    fprintf('Distance: %i cm\n', distance);

    input('Press key to exit\n', 's');

    lrf.disableLaser(); % Turn laser off

    ipcon.disconnect();
end

Callback (MATLAB)¶

Download (matlab_example_callback.m)

 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
36
37

function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLaserRangeFinder;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Laser Range Finder Bricklet

    ipcon = IPConnection(); % Create IP connection
    lrf = handle(BrickletLaserRangeFinder(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Turn laser on and wait 250ms for very first measurement to be ready
    lrf.enableLaser();
    pause(0.25);

    % Register distance callback to function cb_distance
    set(lrf, 'DistanceCallback', @(h, e) cb_distance(e));

    % 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('Press key to exit\n', 's');

    lrf.disableLaser(); % Turn laser off

    ipcon.disconnect();
end

% Callback function for distance callback
function cb_distance(e)
    fprintf('Distance: %i cm\n', e.distance);
end

Threshold (MATLAB)¶

Download (matlab_example_threshold.m)

 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
36
37
38

function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLaserRangeFinder;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Laser Range Finder Bricklet

    ipcon = IPConnection(); % Create IP connection
    lrf = handle(BrickletLaserRangeFinder(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % 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);

    % Register distance reached callback to function cb_distance_reached
    set(lrf, 'DistanceReachedCallback', @(h, e) cb_distance_reached(e));

    % Configure threshold for distance "greater than 20 cm"
    lrf.setDistanceCallbackThreshold('>', 20, 0);

    input('Press key to exit\n', 's');

    lrf.disableLaser(); % Turn laser off

    ipcon.disconnect();
end

% Callback function for distance reached callback
function cb_distance_reached(e)
    fprintf('Distance: %i cm\n', e.distance);
end

Simple (Octave)¶

Download (octave_example_simple.m)

 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

function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Laser Range Finder Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    lrf = javaObject("com.tinkerforge.BrickletLaserRangeFinder", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Turn laser on and wait 250ms for very first measurement to be ready
    lrf.enableLaser();
    pause(0.25);

    % Get current distance
    distance = lrf.getDistance();
    fprintf("Distance: %d cm\n", distance);

    input("Press key to exit\n", "s");

    lrf.disableLaser(); % Turn laser off

    ipcon.disconnect();
end

Callback (Octave)¶

Download (octave_example_callback.m)

 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
36

function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Laser Range Finder Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    lrf = javaObject("com.tinkerforge.BrickletLaserRangeFinder", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Turn laser on and wait 250ms for very first measurement to be ready
    lrf.enableLaser();
    pause(0.25);

    % Register distance callback to function cb_distance
    lrf.addDistanceCallback(@cb_distance);

    % 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("Press key to exit\n", "s");

    lrf.disableLaser(); % Turn laser off

    ipcon.disconnect();
end

% Callback function for distance callback
function cb_distance(e)
    fprintf("Distance: %d cm\n", e.distance);
end

Threshold (Octave)¶

Download (octave_example_threshold.m)

 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
36
37

function octave_example_threshold()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Laser Range Finder Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    lrf = javaObject("com.tinkerforge.BrickletLaserRangeFinder", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % 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);

    % Register distance reached callback to function cb_distance_reached
    lrf.addDistanceReachedCallback(@cb_distance_reached);

    % Configure threshold for distance "greater than 20 cm"
    lrf.setDistanceCallbackThreshold(">", 20, 0);

    input("Press key to exit\n", "s");

    lrf.disableLaser(); % Turn laser off

    ipcon.disconnect();
end

% Callback function for distance reached callback
function cb_distance_reached(e)
    fprintf("Distance: %d cm\n", e.distance);
end

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.

In MATLAB:

import com.tinkerforge.BrickletLaserRangeFinder;

laserRangeFinder = BrickletLaserRangeFinder("YOUR_DEVICE_UID", ipcon);

In Octave:

laserRangeFinder = java_new("com.tinkerforge.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(short mode)¶

Parameter:	mode – Typ: short, 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

short BrickletLaserRangeFinder.getMode()¶

Rückgabe:	mode – Typ: short, 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.

boolean BrickletLaserRangeFinder.isLaserEnabled()¶

Rückgabe:	laserEnabled – Typ: boolean

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

void BrickletLaserRangeFinder.setConfiguration(short acquisitionCount, boolean enableQuickTermination, short thresholdValue, int measurementFrequency)¶

Parameter:	acquisitionCount – Typ: short, Wertebereich: [1 bis 255], Standardwert: 128 enableQuickTermination – Typ: boolean, Standardwert: false thresholdValue – Typ: short, 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).

Neu in Version 2.0.3 (Plugin).

BrickletLaserRangeFinder.Configuration BrickletLaserRangeFinder.getConfiguration()¶

Rückgabeobjekt:	acquisitionCount – Typ: short, Wertebereich: [1 bis 255], Standardwert: 128 enableQuickTermination – Typ: boolean, Standardwert: false thresholdValue – Typ: short, 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.

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen¶

void BrickletLaserRangeFinder.setMovingAverage(short distanceAverageLength, short velocityAverageLength)¶

Parameter:	distanceAverageLength – Typ: short, Wertebereich: [0 bis 30], Standardwert: 10 velocityAverageLength – Typ: short, 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.MovingAverage BrickletLaserRangeFinder.getMovingAverage()¶

Rückgabeobjekt:	distanceAverageLength – Typ: short, Wertebereich: [0 bis 30], Standardwert: 10 velocityAverageLength – Typ: short, Wertebereich: [0 bis 30], Standardwert: 10

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

short BrickletLaserRangeFinder.getSensorHardwareVersion()¶

Rückgabe:	version – Typ: short, 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

Neu in Version 2.0.3 (Plugin).

BrickletLaserRangeFinder.Identity BrickletLaserRangeFinder.getIdentity()¶

Rückgabeobjekt:

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: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, 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 = '>'

BrickletLaserRangeFinder.DistanceCallbackThreshold BrickletLaserRangeFinder.getDistanceCallbackThreshold()¶

Rückgabeobjekt:	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 = '>'

BrickletLaserRangeFinder.VelocityCallbackThreshold BrickletLaserRangeFinder.getVelocityCallbackThreshold()¶

Rückgabeobjekt:	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 wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb beschrieben.

callback BrickletLaserRangeFinder.DistanceCallback¶

Event-Objekt:	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.

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addDistanceCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeDistanceCallback() wieder entfernt werden.

callback BrickletLaserRangeFinder.VelocityCallback¶

Event-Objekt:	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.

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addVelocityCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeVelocityCallback() wieder entfernt werden.

callback BrickletLaserRangeFinder.DistanceReachedCallback¶

Event-Objekt:	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.

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addDistanceReachedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeDistanceReachedCallback() wieder entfernt werden.

callback BrickletLaserRangeFinder.VelocityReachedCallback¶

Event-Objekt:	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.

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addVelocityReachedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeVelocityReachedCallback() wieder entfernt werden.

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.

short[] BrickletLaserRangeFinder.getAPIVersion()¶

Rückgabeobjekt:	apiVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, 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.

boolean BrickletLaserRangeFinder.getResponseExpected(byte functionId)¶

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

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, boolean responseExpected)¶

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

Ä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(boolean responseExpected)¶

Parameter:	responseExpected – Typ: boolean

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