Software / API Bindings / JavaScript / API Referenz und Beispiele / Bricklets / Distance IR Bricklet 2.0

JavaScript - Distance IR Bricklet 2.0¶

Dies ist die Beschreibung der JavaScript API Bindings für das Distance IR Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Distance IR Bricklet 2.0 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)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var dir = new Tinkerforge.BrickletDistanceIRV2(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)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var dir = new Tinkerforge.BrickletDistanceIRV2(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 1s (1000ms) without a threshold
        dir.setDistanceCallbackConfiguration(1000, false, 'x', 0, 0);
    }
);

// Register distance callback
dir.on(Tinkerforge.BrickletDistanceIRV2.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)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var dir = new Tinkerforge.BrickletDistanceIRV2(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) {
        // Configure threshold for distance "smaller than 30 cm"
        // with a debounce period of 1s (1000ms)
        dir.setDistanceCallbackConfiguration(1000, false, '<', 30*10, 0);
    }
);

// Register distance callback
dir.on(Tinkerforge.BrickletDistanceIRV2.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);
    }
);

Simple (HTML)¶

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

<!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 2.0 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.BrickletDistanceIRV2(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)

<!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 2.0 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.BrickletDistanceIRV2(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 1s (1000ms) without a threshold
                        dir.setDistanceCallbackConfiguration(1000, false, 'x', 0, 0);
                    }
                );

                // Register distance callback
                dir.on(Tinkerforge.BrickletDistanceIRV2.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)

<!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 2.0 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.BrickletDistanceIRV2(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) {
                        // Configure threshold for distance "smaller than 30 cm"
                        // with a debounce period of 1s (1000ms)
                        dir.setDistanceCallbackConfiguration(1000, false, '<', 30*10, 0);
                    }
                );

                // Register distance callback
                dir.on(Tinkerforge.BrickletDistanceIRV2.CALLBACK_DISTANCE,
                    // Callback function for distance callback
                    function (distance) {
                        textArea.value += 'Distance: ' + distance/10.0 + ' 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
IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
IPConnection.ERROR_DEVICE_REPLACED = 82
IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83
IPConnection.ERROR_INT64_NOT_SUPPORTED = 91

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen¶

new BrickletDistanceIRV2(uid, ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	distanceIRV2 – Typ: BrickletDistanceIRV2

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

var distanceIRV2 = new BrickletDistanceIRV2("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletDistanceIRV2.getDistance([returnCallback][, errorCallback])¶

Callback-Parameter:	distance – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	undefined

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

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_DISTANCE Callback verwendet werden. Der Callback wird mit der Funktion setDistanceCallbackConfiguration() konfiguriert.

BrickletDistanceIRV2.getAnalogValue([returnCallback][, errorCallback])¶

Callback-Parameter:	analogValue – Typ: int, Wertebereich: [0 bis 2²¹ - 1]
Rückgabe:	undefined

Gibt den Analogwert des Analog/Digital-Wandler zurück.

Dieser Wert ist ein unverarbeiteter Rohwert. Wir haben sichergestellt, dass die Integrationszeit des ADCs kleiner ist als das Messintervall des Sensors (10ms vs 16,5ms). Dadurch ist sichergestellt das keine Informationen verloren gehen können.

Der Analogwert kann genutzt werden wenn eine eigene Kalibrierung oder Lookup-Tabelle benötigt wird.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_ANALOG_VALUE Callback verwendet werden. Der Callback wird mit der Funktion setAnalogValueCallbackConfiguration() konfiguriert.

BrickletDistanceIRV2.setMovingAverageConfiguration(movingAverageLength[, returnCallback][, errorCallback])¶

Parameter:	movingAverageLength – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 25
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt die Länge eines gleitenden Mittelwerts für die Distanz.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Einer neue Wert wird alle ~10ms gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von ca. 10s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

BrickletDistanceIRV2.getMovingAverageConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:	movingAverageLength – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 25
Rückgabe:	undefined

Gibt die Moving Average-Konfiguration zurück, wie von setMovingAverageConfiguration() gesetzt.

BrickletDistanceIRV2.setDistanceLEDConfig(config[, returnCallback][, errorCallback])¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Callback-Parameter:	undefined
Rückgabe:	undefined

Konfiguriert die Distanz-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED die Distanz anzuzeigen (heller = Objekt näher).

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

Für config:

BrickletDistanceIRV2.DISTANCE_LED_CONFIG_OFF = 0
BrickletDistanceIRV2.DISTANCE_LED_CONFIG_ON = 1
BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

BrickletDistanceIRV2.getDistanceLEDConfig([returnCallback][, errorCallback])¶

Callback-Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	undefined

Gibt die LED-Konfiguration zurück, wie von setDistanceLEDConfig() gesetzt.

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

Für config:

BrickletDistanceIRV2.DISTANCE_LED_CONFIG_OFF = 0
BrickletDistanceIRV2.DISTANCE_LED_CONFIG_ON = 1
BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

BrickletDistanceIRV2.setSensorType(sensor[, returnCallback][, errorCallback])¶

Parameter:	sensor – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt den Sensor-Typ.

Das Bricklet kommt vorkonfiguriert mit dem korrektem Sensor und der Sensor-Typ wird im Flash gespeichert (d.h. das Bricklet behält die Einstellung auch wenn es vom Strom getrennt wird).

Die Einstellung kann im Brick Viewer vorgenommen werden. Diese Funktion sollte in einem externen Programm also nicht ausgeführt werden müssen.

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

Für sensor:

BrickletDistanceIRV2.SENSOR_TYPE_2Y0A41 = 0
BrickletDistanceIRV2.SENSOR_TYPE_2Y0A21 = 1
BrickletDistanceIRV2.SENSOR_TYPE_2Y0A02 = 2

BrickletDistanceIRV2.getSensorType([returnCallback][, errorCallback])¶

Callback-Parameter:	sensor – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

Gibt den Sensor-Typ zurück, wie von setSensorType() gesetzt.

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

Für sensor:

BrickletDistanceIRV2.SENSOR_TYPE_2Y0A41 = 0
BrickletDistanceIRV2.SENSOR_TYPE_2Y0A21 = 1
BrickletDistanceIRV2.SENSOR_TYPE_2Y0A02 = 2

Fortgeschrittene Funktionen¶

BrickletDistanceIRV2.getSPITFPErrorCount([returnCallback][, errorCallback])¶

Callback-Parameter:	errorCountAckChecksum – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletDistanceIRV2.setStatusLEDConfig(config[, returnCallback][, errorCallback])¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

BrickletDistanceIRV2.STATUS_LED_CONFIG_OFF = 0
BrickletDistanceIRV2.STATUS_LED_CONFIG_ON = 1
BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletDistanceIRV2.getStatusLEDConfig([returnCallback][, errorCallback])¶

Callback-Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	undefined

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

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

Für config:

BrickletDistanceIRV2.STATUS_LED_CONFIG_OFF = 0
BrickletDistanceIRV2.STATUS_LED_CONFIG_ON = 1
BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletDistanceIRV2.getChipTemperature([returnCallback][, errorCallback])¶

Callback-Parameter:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	undefined

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletDistanceIRV2.reset([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletDistanceIRV2.getIdentity([returnCallback][, errorCallback])¶

Callback-Parameter:

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', '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 2¹⁶ - 1]
Rückgabe:	undefined

uid – Typ: string, Länge: bis zu 8
connectedUid – Typ: string, Länge: bis zu 8
position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
hardwareVersion – Typ: [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 2¹⁶ - 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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

BrickletDistanceIRV2.on(callback_id, function[, errorCallback])¶

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.

BrickletDistanceIRV2.setDistanceCallbackConfiguration(period, valueHasToChange, option, min, max[, returnCallback][, errorCallback])¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

Die Periode ist die Periode mit der der CALLBACK_DISTANCE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_DISTANCE Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

BrickletDistanceIRV2.THRESHOLD_OPTION_OFF = 'x'
BrickletDistanceIRV2.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletDistanceIRV2.THRESHOLD_OPTION_INSIDE = 'i'
BrickletDistanceIRV2.THRESHOLD_OPTION_SMALLER = '<'
BrickletDistanceIRV2.THRESHOLD_OPTION_GREATER = '>'

BrickletDistanceIRV2.getDistanceCallbackConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:

Callback-Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Rückgabe:	undefined

period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
valueHasToChange – Typ: boolean, Standardwert: false
option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
max – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Rückgabe:

undefined

Gibt die Callback-Konfiguration zurück, wie mittels setDistanceCallbackConfiguration() gesetzt.

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

Für option:

BrickletDistanceIRV2.THRESHOLD_OPTION_OFF = 'x'
BrickletDistanceIRV2.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletDistanceIRV2.THRESHOLD_OPTION_INSIDE = 'i'
BrickletDistanceIRV2.THRESHOLD_OPTION_SMALLER = '<'
BrickletDistanceIRV2.THRESHOLD_OPTION_GREATER = '>'

BrickletDistanceIRV2.setAnalogValueCallbackConfiguration(period, valueHasToChange, option, min, max[, returnCallback][, errorCallback])¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

Die Periode ist die Periode mit der der CALLBACK_ANALOG_VALUE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_ANALOG_VALUE Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

BrickletDistanceIRV2.THRESHOLD_OPTION_OFF = 'x'
BrickletDistanceIRV2.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletDistanceIRV2.THRESHOLD_OPTION_INSIDE = 'i'
BrickletDistanceIRV2.THRESHOLD_OPTION_SMALLER = '<'
BrickletDistanceIRV2.THRESHOLD_OPTION_GREATER = '>'

BrickletDistanceIRV2.getAnalogValueCallbackConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	undefined

Gibt die Callback-Konfiguration zurück, wie mittels setAnalogValueCallbackConfiguration() gesetzt.

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

Für option:

BrickletDistanceIRV2.THRESHOLD_OPTION_OFF = 'x'
BrickletDistanceIRV2.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletDistanceIRV2.THRESHOLD_OPTION_INSIDE = 'i'
BrickletDistanceIRV2.THRESHOLD_OPTION_SMALLER = '<'
BrickletDistanceIRV2.THRESHOLD_OPTION_GREATER = '>'

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:

distanceIRV2.on(BrickletDistanceIRV2.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.

BrickletDistanceIRV2.CALLBACK_DISTANCE¶

Callback-Parameter:	distance – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 2¹⁶ - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setDistanceCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getDistance().

BrickletDistanceIRV2.CALLBACK_ANALOG_VALUE¶

Callback-Parameter:	analogValue – Typ: int, Wertebereich: [0 bis 2²¹ - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setAnalogValueCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getAnalogValue().

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.

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

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

BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
BrickletDistanceIRV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION = 6
BrickletDistanceIRV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 9
BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_LED_CONFIG = 11
BrickletDistanceIRV2.FUNCTION_SET_SENSOR_TYPE = 13
BrickletDistanceIRV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletDistanceIRV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletDistanceIRV2.FUNCTION_RESET = 243
BrickletDistanceIRV2.FUNCTION_WRITE_UID = 248

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

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

Für function_id:

BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
BrickletDistanceIRV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION = 6
BrickletDistanceIRV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 9
BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_LED_CONFIG = 11
BrickletDistanceIRV2.FUNCTION_SET_SENSOR_TYPE = 13
BrickletDistanceIRV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletDistanceIRV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletDistanceIRV2.FUNCTION_RESET = 243
BrickletDistanceIRV2.FUNCTION_WRITE_UID = 248

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletDistanceIRV2.setBootloaderMode(mode[, returnCallback][, errorCallback])¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:	status – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

BrickletDistanceIRV2.BOOTLOADER_STATUS_OK = 0
BrickletDistanceIRV2.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletDistanceIRV2.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletDistanceIRV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletDistanceIRV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletDistanceIRV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletDistanceIRV2.getBootloaderMode([returnCallback][, errorCallback])¶

Callback-Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

Für mode:

BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletDistanceIRV2.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletDistanceIRV2.writeFirmware(data[, returnCallback][, errorCallback])¶

Parameter:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Callback-Parameter:	status – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	undefined

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletDistanceIRV2.writeUID(uid[, returnCallback][, errorCallback])¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Callback-Parameter:	undefined
Rückgabe:	undefined

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletDistanceIRV2.readUID([returnCallback][, errorCallback])¶

Callback-Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

BrickletDistanceIRV2.DEVICE_IDENTIFIER¶

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

BrickletDistanceIRV2.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Distance IR Bricklet 2.0 dar.