JavaScript - Temperature IR Bricklet¶

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 Temperature IR Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var tir = new Tinkerforge.BrickletTemperatureIR(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 object temperature callback to 1s (1000ms)
        // Note: The object temperature callback is only called every second
        //       if the object temperature has changed since the last call!
        tir.setObjectTemperatureCallbackPeriod(1000);
    }
);

// Register object temperature callback
tir.on(Tinkerforge.BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE,
    // Callback function for object temperature callback
    function (temperature) {
        console.log('Object Temperature: ' + temperature/10.0 + ' °C');
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Water Boiling (Node.js)¶

Download (ExampleWaterBoiling.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

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var tir = new Tinkerforge.BrickletTemperatureIR(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 emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
        tir.setEmissivity(64224);

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

        // Configure threshold for object temperature "greater than 100 °C"
        tir.setObjectTemperatureCallbackThreshold('>', 100*10, 0);
    }
);

// Register object temperature reached callback
tir.on(Tinkerforge.BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE_REACHED,
    // Callback function for object temperature reached callback
    function (temperature) {
        console.log('Object Temperature: ' + temperature/10.0 + ' °C');
        console.log('The water is boiling!');
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(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
44
45
46
47

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var tir = new Tinkerforge.BrickletTemperatureIR(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 ambient temperature
        tir.getAmbientTemperature(
            function (ambientTemperature) {
                console.log('Ambient Temperature: ' + ambientTemperature/10.0 + ' °C');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );

        // Get current object temperature
        tir.getObjectTemperature(
            function (objectTemperature) {
                console.log('Object Temperature: ' + objectTemperature/10.0 + ' °C');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

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>Temperature 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 tir = new Tinkerforge.BrickletTemperatureIR(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 object temperature callback to 1s (1000ms)
                        // Note: The object temperature callback is only called every second
                        //       if the object temperature has changed since the last call!
                        tir.setObjectTemperatureCallbackPeriod(1000);
                    }
                );

                // Register object temperature callback
                tir.on(Tinkerforge.BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE,
                    // Callback function for object temperature callback
                    function (temperature) {
                        textArea.value += 'Object Temperature: ' + temperature/10.0 + ' °C\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Water Boiling (HTML)¶

Download (ExampleWaterBoiling.html), Test (ExampleWaterBoiling.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>Temperature IR Bricklet Water Boiling 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 tir = new Tinkerforge.BrickletTemperatureIR(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 emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
                        tir.setEmissivity(64224);

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

                        // Configure threshold for object temperature "greater than 100 °C"
                        tir.setObjectTemperatureCallbackThreshold('>', 100*10, 0);
                    }
                );

                // Register object temperature reached callback
                tir.on(Tinkerforge.BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE_REACHED,
                    // Callback function for object temperature reached callback
                    function (temperature) {
                        textArea.value += 'Object Temperature: ' + temperature/10.0 + ' °C\n';
                        textArea.value += 'The water is boiling!\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

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
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>Temperature 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 tir = new Tinkerforge.BrickletTemperatureIR(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 ambient temperature
                        tir.getAmbientTemperature(
                            function (ambientTemperature) {
                                textArea.value += 'Ambient Temperature: ' + ambientTemperature/10.0 + ' °C\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );

                        // Get current object temperature
                        tir.getObjectTemperature(
                            function (objectTemperature) {
                                textArea.value += 'Object Temperature: ' + objectTemperature/10.0 + ' °C\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

Grundfunktionen¶

new BrickletTemperatureIR(uid, ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	temperatureIR – Typ: BrickletTemperatureIR

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

var temperatureIR = new BrickletTemperatureIR("YOUR_DEVICE_UID", ipcon)

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

BrickletTemperatureIR.getAmbientTemperature([returnCallback][, errorCallback])¶

Callback-Parameter:	temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]
Rückgabe:	undefined

Gibt die Umgebungstemperatur des Sensors zurück.

Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen den CALLBACK_AMBIENT_TEMPERATURE Callback zu nutzen und die Periode mit setAmbientTemperatureCallbackPeriod() vorzugeben.

BrickletTemperatureIR.getObjectTemperature([returnCallback][, errorCallback])¶

Callback-Parameter:	temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]
Rückgabe:	undefined

Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt.

Die Temperatur von unterschiedlichen Materialien ist abhängig von ihrem Emissionsgrad. Der Emissionsgrad des Materials kann mit setEmissivity() gesetzt werden.

Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen den CALLBACK_OBJECT_TEMPERATURE Callback zu nutzen und die Periode mit setObjectTemperatureCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

BrickletTemperatureIR.setEmissivity(emissivity[, returnCallback][, errorCallback])¶

Parameter:	emissivity – Typ: int, Einheit: 1/65535, Wertebereich: [6553 bis 216 - 1], Standardwert: 216 - 1
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt den Emissionsgrad, welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von getObjectTemperature() zurückgegeben.

Der Emissionsgrad wird normalerweise als Wert zwischen 0,0 und 1,0 angegeben. Eine Liste von Emissionsgraden unterschiedlicher Materialien ist hier zu finden.

Der Parameter von setEmissivity() muss mit eine Faktor von 65535 (16-Bit) vorgegeben werden. Beispiel: Ein Emissionsgrad von 0,1 kann mit dem Wert 6553 gesetzt werden, ein Emissionsgrad von 0,5 mit dem Wert 32767 und so weiter.

Bemerkung

Wenn eine exakte Messung der Objekttemperatur notwendig ist, ist es entscheidend eine exakten Emissionsgrad anzugeben.

Der Emissionsgrad wird in nicht-flüchtigem Speicher gespeichert und wird auch noch einem Neustart weiter genutzt.

BrickletTemperatureIR.getEmissivity([returnCallback][, errorCallback])¶

Callback-Parameter:	emissivity – Typ: int, Einheit: 1/65535, Wertebereich: [6553 bis 216 - 1], Standardwert: 216 - 1
Rückgabe:	undefined

Gibt den Emissionsgrad zurück, wie von setEmissivity() gesetzt.

BrickletTemperatureIR.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', '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 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¶

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

BrickletTemperatureIR.setAmbientTemperatureCallbackPeriod(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_AMBIENT_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletTemperatureIR.getAmbientTemperatureCallbackPeriod([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 setAmbientTemperatureCallbackPeriod() gesetzt.

BrickletTemperatureIR.setObjectTemperatureCallbackPeriod(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_OBJECT_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletTemperatureIR.getObjectTemperatureCallbackPeriod([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 setObjectTemperatureCallbackPeriod() gesetzt.

BrickletTemperatureIR.setAmbientTemperatureCallbackThreshold(option, min, max[, returnCallback][, errorCallback])¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt den Schwellwert für den CALLBACK_AMBIENT_TEMPERATURE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

BrickletTemperatureIR.getAmbientTemperatureCallbackThreshold([returnCallback][, errorCallback])¶

Callback-Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:	undefined

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

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

Für option:

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

BrickletTemperatureIR.setObjectTemperatureCallbackThreshold(option, min, max[, returnCallback][, errorCallback])¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt den Schwellwert für den CALLBACK_OBJECT_TEMPERATURE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

BrickletTemperatureIR.getObjectTemperatureCallbackThreshold([returnCallback][, errorCallback])¶

Callback-Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:	undefined

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

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

Für option:

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

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

• CALLBACK_AMBIENT_TEMPERATURE_REACHED,
• CALLBACK_OBJECT_TEMPERATURE_REACHED

ausgelöst werden, wenn die Schwellwerte

• setAmbientTemperatureCallbackThreshold(),
• setObjectTemperatureCallbackThreshold()

weiterhin erreicht bleiben.

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

temperatureIR.on(BrickletTemperatureIR.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

BrickletTemperatureIR.CALLBACK_AMBIENT_TEMPERATURE¶

Callback-Parameter:	temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

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

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

BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE¶

Callback-Parameter:	temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

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

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

BrickletTemperatureIR.CALLBACK_AMBIENT_TEMPERATURE_REACHED¶

Callback-Parameter:	temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

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

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

BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE_REACHED¶

Callback-Parameter:	temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setObjectTemperatureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Objekttemperatur 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.

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

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

• BrickletTemperatureIR.FUNCTION_SET_EMISSIVITY = 3
• BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
• BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
• BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
• BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
• BrickletTemperatureIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13

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

• BrickletTemperatureIR.FUNCTION_SET_EMISSIVITY = 3
• BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
• BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
• BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
• BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
• BrickletTemperatureIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13

BrickletTemperatureIR.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¶

BrickletTemperatureIR.DEVICE_IDENTIFIER¶

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

BrickletTemperatureIR.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Temperature IR Bricklet dar.