Java - Laser Range Finder Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLaserRangeFinder;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Laser Range Finder Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLaserRangeFinder lrf =
          new 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();
        Thread.sleep(250);

        // Get current distance
        int distance = lrf.getDistance(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Distance: " + distance + " cm");

        System.out.println("Press key to exit"); System.in.read();
        lrf.disableLaser(); // Turn laser off
        ipcon.disconnect();
    }
}

Callback

Download (ExampleCallback.java)

 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
39
40
41
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLaserRangeFinder;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Laser Range Finder Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLaserRangeFinder lrf =
          new 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();
        Thread.sleep(250);

        // Add distance listener
        lrf.addDistanceListener(new BrickletLaserRangeFinder.DistanceListener() {
            public void distance(int distance) {
                System.out.println("Distance: " + distance + " cm");
            }
        });

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

        System.out.println("Press key to exit"); System.in.read();
        lrf.disableLaser(); // Turn laser off
        ipcon.disconnect();
    }
}

Threshold

Download (ExampleThreshold.java)

 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
39
40
41
42
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLaserRangeFinder;

public class ExampleThreshold {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Laser Range Finder Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLaserRangeFinder lrf =
          new 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();
        Thread.sleep(250);

        // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        lrf.setDebouncePeriod(10000);

        // Add distance reached listener
        lrf.addDistanceReachedListener(new BrickletLaserRangeFinder.DistanceReachedListener() {
            public void distanceReached(int distance) {
                System.out.println("Distance: " + distance + " cm");
            }
        });

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

        System.out.println("Press key to exit"); System.in.read();
        lrf.disableLaser(); // Turn laser off
        ipcon.disconnect();
    }
}

API

Prinzipiell kann jede Methode der Java Bindings eine 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.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

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 (siehe Beispiele oben).

int BrickletLaserRangeFinder.getDistance()
Rückgabe:
  • distance – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die gemessene Distanz zurück. Der Wertebereich ist 0 bis 4000 und die Werte haben die Einheit cm.

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 DistanceListener Listener zu nutzen und die Periode mit setDistanceCallbackPeriod() vorzugeben.

short BrickletLaserRangeFinder.getVelocity()
Rückgabe:
  • velocity – Typ: short, Wertebereich: [-215 bis 215 - 1]

Gibt die gemessene Geschwindigkeit zurück. Der Wertebereich ist -12800 bis 12700 und die Werte haben die Einheit 1/100 m/s.

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 VelocityListener Listener zu nutzen und die Periode mit setVelocityCallbackPeriod() vorzugeben.

void BrickletLaserRangeFinder.setMode(short mode)
Parameter:
  • mode – Typ: short, Wertebereich: Siehe Konstanten

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-400 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

Der Standardmodus ist 0 (Distanzmessung).

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

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: [0 bis 255]
  • enableQuickTermination – Typ: boolean
  • thresholdValue – Typ: short, Wertebereich: [0 bis 255]
  • measurementFrequency – Typ: int, Wertebereich: [0 bis 216 - 1]

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 in Hz gesetzt. Er erzwingt eine feste Messfrequenz. Wenn der Wert auf 0 gesetzt wird, nutzt das Laser Range Finder Bricklet die optimale Frequenz je nach Konfiguration und aktuell gemessener Distanz. Da die Messrate in diesem Fall nicht fest ist, ist die Geschwindigkeitsmessung nicht stabil. Für eine stabile Geschwindigkeitsmessung sollte eine feste Messfrequenz eingestellt werden. Je niedriger die Frequenz ist, desto größer ist die Auflösung der Geschwindigkeitsmessung. Der erlaubte Wertbereich ist 10Hz-500Hz (und 0 um die feste Messfrequenz auszustellen).

Die Standardwerte für Acquisition Count, Enable Quick Termination, Threshold Value und Measurement Frequency sind 128, false, 0 und 0.

Neu in Version 2.0.3 (Plugin).

BrickletLaserRangeFinder.Configuration BrickletLaserRangeFinder.getConfiguration()
Rückgabeobjekt:
  • acquisitionCount – Typ: short, Wertebereich: [0 bis 255]
  • enableQuickTermination – Typ: boolean
  • thresholdValue – Typ: short, Wertebereich: [0 bis 255]
  • measurementFrequency – Typ: int, Wertebereich: [0 bis 216 - 1]

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 255]
  • velocityAverageLength – Typ: short, Wertebereich: [0 bis 255]

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.

Der Wertebereich liegt bei 0-30.

Der Standardwert ist 10.

BrickletLaserRangeFinder.MovingAverage BrickletLaserRangeFinder.getMovingAverage()
Rückgabeobjekt:
  • distanceAverageLength – Typ: short, Wertebereich: [0 bis 255]
  • velocityAverageLength – Typ: short, Wertebereich: [0 bis 255]

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

short[] BrickletLaserRangeFinder.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]

Gibt die Version der API Definition (Major, Minor, Revision) 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(short functionId)
Parameter:
  • functionId – Typ: short, 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 Listeners 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(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, 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 Listeners (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 Listeners diese Gerätes.

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
  • hardwareVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3, 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 kann 'a', 'b', 'c' oder 'd' sein.

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 Listener

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 DistanceListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

Der DistanceListener Listener 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 VelocityListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

Der VelocityListener Listener 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, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt den Schwellwert für den DistanceReachedListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Listener ist inaktiv
'o' Listener wird ausgelöst, wenn der Entfernungswert außerhalb des min und max Wertes ist
'i' Listener wird ausgelöst, wenn der Entfernungswert innerhalb des min und max Wertes ist
'<' Listener wird ausgelöst, wenn der Entfernungswert kleiner als der min Wert ist (max wird ignoriert)
'>' Listener wird ausgelöst, wenn der Entfernungswert größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

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, Wertebereich: [-215 bis 215 - 1]
  • max – Typ: short, Wertebereich: [-215 bis 215 - 1]

Setzt den Schwellwert für den VelocityReachedListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Listener ist inaktiv
'o' Listener wird ausgelöst, wenn der Geschwindigkeitswert außerhalb des min und max Wertes ist
'i' Listener wird ausgelöst, wenn der Geschwindigkeitswert innerhalb des min und max Wertes ist
'<' Listener wird ausgelöst, wenn der Geschwindigkeitswert kleiner als der min Wert ist (max wird ignoriert)
'>' Listener wird ausgelöst, wenn der Geschwindigkeitswert größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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, Wertebereich: [-215 bis 215 - 1]
  • max – Typ: short, Wertebereich: [-215 bis 215 - 1]

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 Listeners

ausgelöst werden, wenn die Schwellwerte

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.

Listener

Listener können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit add*Listener() Funktionen eines Geräteobjekts durchgeführt werden.

Der Parameter ist ein Listener Klassen Objekt, z.B.:

device.addExampleListener(new BrickletLaserRangeFinder.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

Die verfügbaren Listener Klassen mit den Methoden welche überschrieben werden können werden unterhalb beschrieben. Es ist möglich mehrere Listener hinzuzufügen und auch mit einem korrespondierenden remove*Listener() wieder zu entfernen.

Bemerkung

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

class BrickletLaserRangeFinder.DistanceListener()

Dieser Listener kann mit der Funktion addDistanceListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeDistanceListener() wieder entfernt werden.

void distance(int distance)
Parameter:
  • distance – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

class BrickletLaserRangeFinder.VelocityListener()

Dieser Listener kann mit der Funktion addVelocityListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeVelocityListener() wieder entfernt werden.

void velocity(short velocity)
Parameter:
  • velocity – Typ: short, Wertebereich: [-215 bis 215 - 1]

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

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

class BrickletLaserRangeFinder.DistanceReachedListener()

Dieser Listener kann mit der Funktion addDistanceReachedListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeDistanceReachedListener() wieder entfernt werden.

void distanceReached(int distance)
Parameter:
  • distance – Typ: int, Wertebereich: [0 bis 216 - 1]

Dieser Listener 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 Listener mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

class BrickletLaserRangeFinder.VelocityReachedListener()

Dieser Listener kann mit der Funktion addVelocityReachedListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeVelocityReachedListener() wieder entfernt werden.

void velocityReached(short velocity)
Parameter:
  • velocity – Typ: short, Wertebereich: [-215 bis 215 - 1]

Dieser Listener 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 Listener mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

Konstanten

int BrickletLaserRangeFinder.DEVICE_IDENTIFIER

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

Die getIdentity() Funktion und der IPConnection.EnumerateListener Listener 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.