JavaScript - Laser Range Finder Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (Node.js)

Download (ExampleSimple.js)

 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
43
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var lrf = new Tinkerforge.BrickletLaserRangeFinder(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Turn laser on and wait 250ms for very first measurement to be ready
        lrf.enableLaser();

        setTimeout(function () {
            // Get current distance
            lrf.getDistance(
                function (distance) {
                    console.log('Distance: ' + distance + ' cm');
                },
                function (error) {
                    console.log('Error: ' + error);
                }
            );
        }, 250);
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        lrf.disableLaser(); // Turn laser off
        ipcon.disconnect();
        process.exit(0);
    }
);

Callback (Node.js)

Download (ExampleCallback.js)

 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
43
44
45
46
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var lrf = new Tinkerforge.BrickletLaserRangeFinder(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Turn laser on and wait 250ms for very first measurement to be ready
        lrf.enableLaser();

        setTimeout(function () {
            // 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);
        }, 250);
    }
);

// Register distance callback
lrf.on(Tinkerforge.BrickletLaserRangeFinder.CALLBACK_DISTANCE,
    // Callback function for distance callback
    function (distance) {
        console.log('Distance: ' + distance + ' cm');
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        lrf.disableLaser(); // Turn laser off
        ipcon.disconnect();
        process.exit(0);
    }
);

Threshold (Node.js)

Download (ExampleThreshold.js)

 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
43
44
45
46
47
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var lrf = new Tinkerforge.BrickletLaserRangeFinder(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Turn laser on and wait 250ms for very first measurement to be ready
        lrf.enableLaser();

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

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

// Register distance reached callback
lrf.on(Tinkerforge.BrickletLaserRangeFinder.CALLBACK_DISTANCE_REACHED,
    // Callback function for distance reached callback
    function (distance) {
        console.log('Distance: ' + distance + ' cm');
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        lrf.disableLaser(); // Turn laser off
        ipcon.disconnect();
        process.exit(0);
    }
);

Simple (HTML)

Download (ExampleSimple.html), Test (ExampleSimple.html)

 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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Laser Range Finder Bricklet Simple Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var lrf = new Tinkerforge.BrickletLaserRangeFinder(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Turn laser on and wait 250ms for very first measurement to be ready
                        lrf.enableLaser();

                        setTimeout(function () {
                            // Get current distance
                            lrf.getDistance(
                                function (distance) {
                                    textArea.value += 'Distance: ' + distance + ' cm\n';
                                },
                                function (error) {
                                    textArea.value += 'Error: ' + error + '\n';
                                }
                            );
                        }, 250);
                    }
                );
            }
        </script>
    </body>
</html>

Callback (HTML)

Download (ExampleCallback.html), Test (ExampleCallback.html)

 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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Laser Range Finder Bricklet Callback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var lrf = new Tinkerforge.BrickletLaserRangeFinder(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Turn laser on and wait 250ms for very first measurement to be ready
                        lrf.enableLaser();

                        setTimeout(function () {
                            // 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);
                        }, 250);
                    }
                );

                // Register distance callback
                lrf.on(Tinkerforge.BrickletLaserRangeFinder.CALLBACK_DISTANCE,
                    // Callback function for distance callback
                    function (distance) {
                        textArea.value += 'Distance: ' + distance + ' cm\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Threshold (HTML)

Download (ExampleThreshold.html), Test (ExampleThreshold.html)

 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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Laser Range Finder Bricklet Threshold Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var lrf = new Tinkerforge.BrickletLaserRangeFinder(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Turn laser on and wait 250ms for very first measurement to be ready
                        lrf.enableLaser();

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

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

                // Register distance reached callback
                lrf.on(Tinkerforge.BrickletLaserRangeFinder.CALLBACK_DISTANCE_REACHED,
                    // Callback function for distance reached callback
                    function (distance) {
                        textArea.value += 'Distance: ' + distance + ' cm\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

API

Allgemein kann jede Funktion der JavaScript Bindings zwei optionale Parameter haben, returnCallback und errorCallback. Dies sind benutzerdefinierte Callback-Funktionen. Die returnCallback-Funktion wird mit dem Ergebnissen der Funktion als Argumente aufgerufen, falls die Funktion ihre Ergebnisse asynchron zurückgibt. Die errorCallback-Funktion wird im Fehlerfall mit einem Fehlercode aufgerufen. Der Fehlercode kann einer der folgenden Werte sein:

  • IPConnection.ERROR_ALREADY_CONNECTED = 11
  • IPConnection.ERROR_NOT_CONNECTED = 12
  • IPConnection.ERROR_CONNECT_FAILED = 13
  • IPConnection.ERROR_INVALID_FUNCTION_ID = 21
  • IPConnection.ERROR_TIMEOUT = 31
  • IPConnection.ERROR_INVALID_PARAMETER = 41
  • IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
  • IPConnection.ERROR_UNKNOWN_ERROR = 43
  • IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
  • IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen

new BrickletLaserRangeFinder(uid, ipcon)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: IPConnection
Rückgabe:
  • laserRangeFinder – Typ: BrickletLaserRangeFinder

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

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

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

BrickletLaserRangeFinder.getDistance([returnCallback][, errorCallback])
Callback-Parameter:
  • distance – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 4000]
Rückgabe:
  • undefined

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

BrickletLaserRangeFinder.getVelocity([returnCallback][, errorCallback])
Callback-Parameter:
  • velocity – Typ: int, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]
Rückgabe:
  • undefined

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

BrickletLaserRangeFinder.setMode(mode[, returnCallback][, errorCallback])
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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
BrickletLaserRangeFinder.getMode([returnCallback][, errorCallback])
Callback-Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • undefined

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
BrickletLaserRangeFinder.enableLaser([returnCallback][, errorCallback])
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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([returnCallback][, errorCallback])
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Deaktiviert den Laser des LIDAR.

BrickletLaserRangeFinder.isLaserEnabled([returnCallback][, errorCallback])
Callback-Parameter:
  • laserEnabled – Typ: boolean
Rückgabe:
  • undefined

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

BrickletLaserRangeFinder.setConfiguration(acquisitionCount, enableQuickTermination, thresholdValue, measurementFrequency[, returnCallback][, errorCallback])
Parameter:
  • acquisitionCount – Typ: int, Wertebereich: [1 bis 255], Standardwert: 128
  • enableQuickTermination – Typ: boolean, Standardwert: false
  • thresholdValue – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
  • measurementFrequency – Typ: int, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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([returnCallback][, errorCallback])
Callback-Parameter:
  • acquisitionCount – Typ: int, Wertebereich: [1 bis 255], Standardwert: 128
  • enableQuickTermination – Typ: boolean, Standardwert: false
  • thresholdValue – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
  • measurementFrequency – Typ: int, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0
Rückgabe:
  • undefined

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

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen

BrickletLaserRangeFinder.setMovingAverage(distanceAverageLength, velocityAverageLength[, returnCallback][, errorCallback])
Parameter:
  • distanceAverageLength – Typ: int, Wertebereich: [0 bis 30], Standardwert: 10
  • velocityAverageLength – Typ: int, Wertebereich: [0 bis 30], Standardwert: 10
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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([returnCallback][, errorCallback])
Callback-Parameter:
  • distanceAverageLength – Typ: int, Wertebereich: [0 bis 30], Standardwert: 10
  • velocityAverageLength – Typ: int, Wertebereich: [0 bis 30], Standardwert: 10
Rückgabe:
  • undefined

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

BrickletLaserRangeFinder.getSensorHardwareVersion([returnCallback][, errorCallback])
Callback-Parameter:
  • version – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undefined

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.getIdentity([returnCallback][, errorCallback])
Callback-Parameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

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.on(callback_id, function)
Parameter:
  • callback_id – Typ: int
  • function – Typ: function
Rückgabe:
  • undefined

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletLaserRangeFinder.setDistanceCallbackPeriod(period[, returnCallback][, errorCallback])
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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

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

BrickletLaserRangeFinder.getDistanceCallbackPeriod([returnCallback][, errorCallback])
Callback-Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • undefined

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

BrickletLaserRangeFinder.setVelocityCallbackPeriod(period[, returnCallback][, errorCallback])
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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

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

BrickletLaserRangeFinder.getVelocityCallbackPeriod([returnCallback][, errorCallback])
Callback-Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • undefined

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

BrickletLaserRangeFinder.setDistanceCallbackThreshold(option, min, max[, returnCallback][, errorCallback])
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
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt den Schwellwert für den CALLBACK_DISTANCE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

Die folgenden 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.getDistanceCallbackThreshold([returnCallback][, errorCallback])
Callback-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
Rückgabe:
  • undefined

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 = '>'
BrickletLaserRangeFinder.setVelocityCallbackThreshold(option, min, max[, returnCallback][, errorCallback])
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt den Schwellwert für den CALLBACK_VELOCITY_REACHED Callback.

Die folgenden Optionen sind möglich:

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

Die folgenden 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.getVelocityCallbackThreshold([returnCallback][, errorCallback])
Callback-Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • undefined

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 = '>'
BrickletLaserRangeFinder.setDebouncePeriod(debounce[, returnCallback][, errorCallback])
Parameter:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

BrickletLaserRangeFinder.getDebouncePeriod([returnCallback][, errorCallback])
Callback-Parameter:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • undefined

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 kann mit der Funktion on() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

laserRangeFinder.on(BrickletLaserRangeFinder.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickletLaserRangeFinder.CALLBACK_DISTANCE
Callback-Parameter:
  • 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 CALLBACK_DISTANCE Callback wird nur ausgelöst, wenn sich der Entfernungswert seit der letzten Auslösung geändert hat.

BrickletLaserRangeFinder.CALLBACK_VELOCITY
Callback-Parameter:
  • velocity – Typ: int, 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 CALLBACK_VELOCITY Callback wird nur ausgelöst, wenn sich der Geschwindigkeitswert seit der letzten Auslösung geändert hat.

BrickletLaserRangeFinder.CALLBACK_DISTANCE_REACHED
Callback-Parameter:
  • 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.

BrickletLaserRangeFinder.CALLBACK_VELOCITY_REACHED
Callback-Parameter:
  • velocity – Typ: int, 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()
Rückgabe:
  • apiVersion – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, 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[, errorCallback])
Parameter:
  • functionId – Typ: int, 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 function_id:

  • 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
BrickletLaserRangeFinder.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean
Rückgabe:
  • undefined

Ä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 function_id:

  • 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
BrickletLaserRangeFinder.setResponseExpectedAll(responseExpected)
Parameter:
  • responseExpected – Typ: boolean
Rückgabe:
  • undefined

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

Konstanten

BrickletLaserRangeFinder.DEVICE_IDENTIFIER

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

Die getIdentity() Funktion und der IPConnection.CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletLaserRangeFinder.DEVICE_DISPLAY_NAME

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