Software / API Bindings / JavaScript / API Reference and Examples / Bricklets (Discontinued) / Temperature IR Bricklet

JavaScript - Temperature IR Bricklet¶

This is the description of the JavaScript API bindings for the Temperature IR Bricklet. General information and technical specifications for the Temperature IR Bricklet are summarized in its hardware description.

An installation guide for the JavaScript API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.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 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)

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)

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)

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

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

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

API¶

Generally, every function of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback function is called with the results as arguments, if the function returns its results asynchronously. The errorCallback is called with an error code in case of an error. The error code can be one of the following values:

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

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions¶

new BrickletTemperatureIR(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	temperatureIR – Type: BrickletTemperatureIR

Creates an object with the unique device ID uid:

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

This object can then be used after the IP Connection is connected.

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

Callback Parameters:	temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 1250]
Returns:	undefined

Returns the ambient temperature of the sensor.

If you want to get the ambient temperature periodically, it is recommended to use the CALLBACK_AMBIENT_TEMPERATURE callback and set the period with setAmbientTemperatureCallbackPeriod().

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

Callback Parameters:	temperature – Type: int, Unit: 1/10 °C, Range: [-700 to 3800]
Returns:	undefined

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at.

The temperature of different materials is dependent on their emissivity. The emissivity of the material can be set with setEmissivity().

If you want to get the object temperature periodically, it is recommended to use the CALLBACK_OBJECT_TEMPERATURE callback and set the period with setObjectTemperatureCallbackPeriod().

Advanced Functions¶

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

Parameters:	emissivity – Type: int, Unit: 1/65535, Range: [6553 to 2¹⁶ - 1], Default: 2¹⁶ - 1
Callback Parameters:	undefined
Returns:	undefined

Sets the emissivity that is used to calculate the surface temperature as returned by getObjectTemperature().

The emissivity is usually given as a value between 0.0 and 1.0. A list of emissivities of different materials can be found here.

The parameter of setEmissivity() has to be given with a factor of 65535 (16-bit). For example: An emissivity of 0.1 can be set with the value 6553, an emissivity of 0.5 with the value 32767 and so on.

Note

If you need a precise measurement for the object temperature, it is absolutely crucial that you also provide a precise emissivity.

The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

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

Callback Parameters:	emissivity – Type: int, Unit: 1/65535, Range: [6553 to 2¹⁶ - 1], Default: 2¹⁶ - 1
Returns:	undefined

Returns the emissivity as set by setEmissivity().

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

Callback Parameters:

Callback Parameters:	uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]
Returns:	undefined

uid – Type: string, Length: up to 8
connectedUid – Type: string, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardwareVersion – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

firmwareVersion – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

Returns:

undefined

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

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

Parameters:	callback_id – Type: int function – Type: function
Returns:	undefined

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletTemperatureIR.setAmbientTemperatureCallbackPeriod(period[, returnCallback][, errorCallback])¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

Sets the period with which the CALLBACK_AMBIENT_TEMPERATURE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_AMBIENT_TEMPERATURE callback is only triggered if the temperature has changed since the last triggering.

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

Callback Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Returns:	undefined

Returns the period as set by setAmbientTemperatureCallbackPeriod().

BrickletTemperatureIR.setObjectTemperatureCallbackPeriod(period[, returnCallback][, errorCallback])¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

Sets the period with which the CALLBACK_OBJECT_TEMPERATURE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_OBJECT_TEMPERATURE callback is only triggered if the temperature has changed since the last triggering.

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

Callback Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Returns:	undefined

Returns the period as set by setObjectTemperatureCallbackPeriod().

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

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

Sets the thresholds for the CALLBACK_AMBIENT_TEMPERATURE_REACHED callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the ambient temperature is outside the min and max values
'i'	Callback is triggered when the ambient temperature is inside the min and max values
'<'	Callback is triggered when the ambient temperature is smaller than the min value (max is ignored)
'>'	Callback is triggered when the ambient temperature is greater than the min value (max is ignored)

The following constants are available for this function:

For 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 Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0
Returns:	undefined

Returns the threshold as set by setAmbientTemperatureCallbackThreshold().

The following constants are available for this function:

For 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])¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

Sets the thresholds for the CALLBACK_OBJECT_TEMPERATURE_REACHED callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the object temperature is outside the min and max values
'i'	Callback is triggered when the object temperature is inside the min and max values
'<'	Callback is triggered when the object temperature is smaller than the min value (max is ignored)
'>'	Callback is triggered when the object temperature is greater than the min value (max is ignored)

The following constants are available for this function:

For 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 Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0
Returns:	undefined

Returns the threshold as set by setObjectTemperatureCallbackThreshold().

The following constants are available for this function:

For 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])¶

Parameters:	debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100
Callback Parameters:	undefined
Returns:	undefined

Sets the period with which the threshold callbacks

CALLBACK_AMBIENT_TEMPERATURE_REACHED,
CALLBACK_OBJECT_TEMPERATURE_REACHED

are triggered, if the thresholds

setAmbientTemperatureCallbackThreshold(),
setObjectTemperatureCallbackThreshold()

keep being reached.

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

Callback Parameters:	debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100
Returns:	undefined

Returns the debounce period as set by setDebouncePeriod().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

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

The available constants with inherent number and type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

BrickletTemperatureIR.CALLBACK_AMBIENT_TEMPERATURE¶

Callback Parameters:	temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 1250]

This callback is triggered periodically with the period that is set by setAmbientTemperatureCallbackPeriod(). The parameter is the ambient temperature of the sensor.

The CALLBACK_AMBIENT_TEMPERATURE callback is only triggered if the ambient temperature has changed since the last triggering.

BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE¶

Callback Parameters:	temperature – Type: int, Unit: 1/10 °C, Range: [-700 to 3800]

This callback is triggered periodically with the period that is set by setObjectTemperatureCallbackPeriod(). The parameter is the object temperature of the sensor.

The CALLBACK_OBJECT_TEMPERATURE callback is only triggered if the object temperature has changed since the last triggering.

BrickletTemperatureIR.CALLBACK_AMBIENT_TEMPERATURE_REACHED¶

Callback Parameters:	temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 1250]

This callback is triggered when the threshold as set by setAmbientTemperatureCallbackThreshold() is reached. The parameter is the ambient temperature of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE_REACHED¶

Callback Parameters:	temperature – Type: int, Unit: 1/10 °C, Range: [-700 to 3800]

This callback is triggered when the threshold as set by setObjectTemperatureCallbackThreshold() is reached. The parameter is the object temperature of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletTemperatureIR.getAPIVersion()¶

Returns:	apiVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletTemperatureIR.getResponseExpected(functionId[, errorCallback])¶

Parameters:	functionId – Type: int, Range: See constants
Returns:	responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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])¶

Parameters:	functionId – Type: int, Range: See constants responseExpected – Type: boolean
Returns:	undefined

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For 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)¶

Parameters:	responseExpected – Type: boolean
Returns:	undefined

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants¶

BrickletTemperatureIR.DEVICE_IDENTIFIER¶

This constant is used to identify a Temperature IR Bricklet.

The getIdentity() function and the IPConnection.CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletTemperatureIR.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Temperature IR Bricklet.