JavaScript - Distance IR Bricklet

Dies ist die Beschreibung der JavaScript API Bindings für das Distance IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Distance IR 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
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Distance IR Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var dir = new Tinkerforge.BrickletDistanceIR(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) {
        // Get current distance
        dir.getDistance(
            function (distance) {
                console.log('Distance: ' + distance/10.0 + ' cm');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        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
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Distance IR Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var dir = new Tinkerforge.BrickletDistanceIR(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) {
        // 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!
        dir.setDistanceCallbackPeriod(200);
    }
);

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

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        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
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Distance IR Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var dir = new Tinkerforge.BrickletDistanceIR(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) {
        // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        dir.setDebouncePeriod(10000);

        // Configure threshold for distance "smaller than 30 cm"
        dir.setDistanceCallbackThreshold('<', 30*10, 0);
    }
);

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

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        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
<!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>Distance IR 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 dir = new Tinkerforge.BrickletDistanceIR(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) {
                        // Get current distance
                        dir.getDistance(
                            function (distance) {
                                textArea.value += 'Distance: ' + distance/10.0 + ' cm\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </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
<!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>Distance IR 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 dir = new Tinkerforge.BrickletDistanceIR(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) {
                        // 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!
                        dir.setDistanceCallbackPeriod(200);
                    }
                );

                // Register distance callback
                dir.on(Tinkerforge.BrickletDistanceIR.CALLBACK_DISTANCE,
                    // Callback function for distance callback
                    function (distance) {
                        textArea.value += 'Distance: ' + distance/10.0 + ' 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
<!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>Distance IR 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 dir = new Tinkerforge.BrickletDistanceIR(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) {
                        // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
                        dir.setDebouncePeriod(10000);

                        // Configure threshold for distance "smaller than 30 cm"
                        dir.setDistanceCallbackThreshold('<', 30*10, 0);
                    }
                );

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

API

Allgemein kann jede Methode der JavaScript Bindings zwei optionale Parameter haben, returnCallback und errorCallback. Dies sind benutzerdefinierte Callback-Funktionen. Die returnCallback-Funktion wird mit dem Ergebnissen der Methode als Argumente aufgerufen, falls die Methode 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 BrickletDistanceIR(uid, ipcon)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: IPConnection
Rückgabe:
  • distanceIR – Typ: BrickletDistanceIR

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

var distanceIR = new BrickletDistanceIR("YOUR_DEVICE_UID", ipcon)

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

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

Gibt die gemessene Entfernung des Sensors zurück. Der Wert ist in mm und die möglichen Entfernungsbereiche sind 40 bis 300, 100 bis 800 und 200 bis 1500, in Abhängigkeit vom gewählten IR Sensor.

Wenn die Entfernung periodisch abgefragt werden soll, wird empfohlen den CALLBACK_DISTANCE Callback zu nutzen und die Periode mit setDistanceCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

BrickletDistanceIR.getAnalogValue([returnCallback][, errorCallback])
Callback-Parameter:
  • value – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von getDistance() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während getAnalogValue() unverarbeitete Analogwerte zurück gibt. Der einzige Grund getAnalogValue() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit setAnalogValueCallbackPeriod() vorzugeben.

BrickletDistanceIR.setSamplingPoint(position, distance[, returnCallback][, errorCallback])
Parameter:
  • position – Typ: int, Wertebereich: [0 bis 255]
  • distance – Typ: int, Wertebereich: [0 bis 216 - 1]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt einen Messpunkt für eine vorgegebene Position in der Wertetabelle. Die Wertetabelle beinhaltet 128 äquidistante Analogwerte mit entsprechenden Entfernungen.

Wenn eine Entfernung von 50cm bei einem Analogwert von 2048 gemessen wird, dann sollte der Aufruf der Funktion mit (64, 5000) erfolgen. Der verwendete Analog-Digital-Wandler hat eine Auflösung von 12 Bit. Mit 128 Messpunkten im gesamten Bereich bedeutet das, dass jeder Messpunkt 32 Analogwerte umfasst. Daher wird dem Analogwert 2048 der Messpunkt 64 = 2048/32 zugeordnet.

Messpunkte werden im EEPROM des Distance IR Bricklet gespeichert und werden bei jedem Hochfahren geladen.

Bemerkung

Ein einfacher Weg, die Messpunkte des Distance IR Bricklet zu kalibrieren, ist im Brick Viewer implementiert. Wenn der Bricklet kalibriert werden soll wird dringend empfohlen diese Implementierung zu nutzen.

BrickletDistanceIR.getSamplingPoint(position[, returnCallback][, errorCallback])
Parameter:
  • position – Typ: int, Wertebereich: [0 bis 255]
Callback-Parameter:
  • distance – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

Gibt die Entfernung eines Messpunktes zurück, wie von setSamplingPoint() gesetzt.

BrickletDistanceIR.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: [int, ...], 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.

BrickletDistanceIR.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:

  • BrickletDistanceIR.FUNCTION_SET_SAMPLING_POINT = 3
  • BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 5
  • BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 9
  • BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletDistanceIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13
BrickletDistanceIR.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:

  • BrickletDistanceIR.FUNCTION_SET_SAMPLING_POINT = 3
  • BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 5
  • BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 9
  • BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletDistanceIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13
BrickletDistanceIR.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.

BrickletDistanceIR.getIdentity([returnCallback][, errorCallback])
Callback-Parameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [int, ...], Länge: 3, 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 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 Callbacks

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

BrickletDistanceIR.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 Strom seit der letzten Auslösung geändert hat.

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

BrickletDistanceIR.setAnalogValueCallbackPeriod(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_ANALOG_VALUE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletDistanceIR.getAnalogValueCallbackPeriod([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 setAnalogValueCallbackPeriod() gesetzt.

BrickletDistanceIR.setDistanceCallbackThreshold(option, min, max[, returnCallback][, errorCallback])
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]
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 die Entfernung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Entfernung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Entfernung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Entfernung 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:

  • BrickletDistanceIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDistanceIR.THRESHOLD_OPTION_GREATER = '>'
BrickletDistanceIR.getDistanceCallbackThreshold([returnCallback][, errorCallback])
Callback-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]
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:

  • BrickletDistanceIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDistanceIR.THRESHOLD_OPTION_GREATER = '>'
BrickletDistanceIR.setAnalogValueCallbackThreshold(option, min, max[, returnCallback][, errorCallback])
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]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt den Schwellwert für den CALLBACK_ANALOG_VALUE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Analogwert 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:

  • BrickletDistanceIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDistanceIR.THRESHOLD_OPTION_GREATER = '>'
BrickletDistanceIR.getAnalogValueCallbackThreshold([returnCallback][, errorCallback])
Callback-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]
Rückgabe:
  • undefined

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

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

Für option:

  • BrickletDistanceIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDistanceIR.THRESHOLD_OPTION_GREATER = '>'
BrickletDistanceIR.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.

BrickletDistanceIR.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:

distanceIR.on(BrickletDistanceIR.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.

BrickletDistanceIR.CALLBACK_DISTANCE
Callback-Parameter:
  • distance – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

BrickletDistanceIR.CALLBACK_ANALOG_VALUE
Callback-Parameter:
  • value – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

BrickletDistanceIR.CALLBACK_DISTANCE_REACHED
Callback-Parameter:
  • distance – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

BrickletDistanceIR.CALLBACK_ANALOG_VALUE_REACHED
Callback-Parameter:
  • value – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

Konstanten

BrickletDistanceIR.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Distance IR 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.

BrickletDistanceIR.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Distance IR Bricklet dar.