JavaScript - Temperature IR Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
            - Examples
              - Simple (Node.js)
              - WaterBoiling (Node.js)
              - Callback (Node.js)
              - Simple (HTML)
              - WaterBoiling (HTML)
              - Callback (HTML)
            - API
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
              - Constants
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# 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).

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

    var Tinkerforge = require('tinkerforge');

    var HOST = 'localhost';
    var PORT = 4223;
    var UID = 'kqJ'; // Change to your UID

    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 object and ambient temperatures (unit is °C/10)
            tir.getObjectTemperature(
                function(obj) {
                    console.log('Object Temperature: '+obj/10+' °C');
                },
                function(error) {
                    console.log('Error: '+error);
                }
            );
            tir.getAmbientTemperature(
                function(amb) {
                    console.log('Ambient Temperature: '+amb/10+' °C');
                },
                function(error) {
                    console.log('Error: '+error);
                }
            );
        }
    );

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

### WaterBoiling (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 = 'kqJ'; // Change to your UID

    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)
            tir.setEmissivity(parseInt(0xFFFF*0.98));
            // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
            tir.setDebouncePeriod(10000);
            // Configure threshold for "greater than 100 °C" (unit is °C/10)
            tir.setObjectTemperatureCallbackThreshold('>', 100*10, 0);
        }
    );

    // Register threshold reached callback
    tir.on(Tinkerforge.BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE_REACHED,
        // Callback for object temperature greater than 100 °C
        // (parameter has unit °C/10)
        function(temp) {
            console.log('The surface has a temperature of ' + temp/10.0 + ' °C.');
            console.log('The water is boiling!');
            console.log();
        }
    );

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

### Callback (Node.js)

Download (ExampleCallback.js)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52

    var Tinkerforge = require('tinkerforge');

    var HOST = 'localhost';
    var PORT = 4223;
    var UID = 'kqJ'; // Change to your UID

    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 temperature callbacks to 1s (1000ms)
            // Note: The callbacks are only called every second if the
            // value has changed since the last call!
            tir.setObjectTemperatureCallbackPeriod(1000);
            tir.setAmbientTemperatureCallbackPeriod(1000);
        }
    );

    // Register object temperature callback
    tir.on(Tinkerforge.BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE,
        // Callback functions for object/ambient temperature callbacks
        // (parameters have unit °C/10)
        function(temp) {
            console.log('Object Temperature: '+temp/10+' °C');
            console.log();
        }
    );
    // Register ambient temperature callback
    tir.on(Tinkerforge.BrickletTemperatureIR.CALLBACK_AMBIENT_TEMPERATURE,
        // Callback functions for object/ambient temperature callbacks
        // (parameters have unit °C/10)
        function(temp) {
            console.log('Ambient Temperature: '+temp/10+' °C');
            console.log();
        }
    );

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

### Simple (HTML)

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

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66

    <!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 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 object and ambient temperatures (unit is °C/10)
                            tir.getObjectTemperature(
                                function(obj) {
                                    textArea.value += 'Object Temperature: '+obj/10+' °C\n';
                                },
                                function(error) {
                                    textArea.value += 'Error: '+error+'\n';
                                }
                            );
                            tir.getAmbientTemperature(
                                function(amb) {
                                    textArea.value += 'Ambient Temperature: '+amb/10+' °C\n';
                                },
                                function(error) {
                                    textArea.value += 'Error: '+error+'\n';
                                }
                            );
                        }
                    );
                }
            </script>
        </body>
    </html>

### WaterBoiling (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

    <!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 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 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)
                            tir.setEmissivity(parseInt(0xFFFF*0.98));
                            // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
                            tir.setDebouncePeriod(10000);
                            // Configure threshold for "greater than 100 °C" (unit is °C/10)
                            tir.setObjectTemperatureCallbackThreshold('>', 100*10, 0);
                        }
                    );
                    // Register threshold reached callback
                    tir.on(Tinkerforge.BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE_REACHED,
                        // Callback for object temperature greater than 100 °C
                        // (parameter has unit °C/10)
                        function(temp) {
                            textArea.value += 'The surface has a temperature of ' + temp/10.0 + ' °C.\n';
                            textArea.value += 'The water is boiling!';
                            textArea.value += '\n';
                            textArea.scrollTop = textArea.scrollHeight;
                        }
                    );
                }
            </script>
        </body>
    </html>

### Callback (HTML)

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

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74

    <!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 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 temperature callbacks to 1s (1000ms)
                            // Note: The callbacks are only called every second if the
                            // value has changed since the last call!
                            tir.setObjectTemperatureCallbackPeriod(1000);
                            tir.setAmbientTemperatureCallbackPeriod(1000);
                        }
                    );
                    // Register object temperature callback
                    tir.on(Tinkerforge.BrickletTemperatureIR.CALLBACK_OBJECT_TEMPERATURE,
                        // Callback functions for object/ambient temperature callbacks
                        // (parameters have unit °C/10)
                        function(temp) {
                            textArea.value += 'Object Temperature: '+temp/10+' °C';
                            textArea.value += '\n';
                            textArea.scrollTop = textArea.scrollHeight;
                        }
                    );
                    // Register ambient temperature callback
                    tir.on(Tinkerforge.BrickletTemperatureIR.CALLBACK_AMBIENT_TEMPERATURE,
                        // Callback functions for object/ambient temperature callbacks
                        // (parameters have unit °C/10)
                        function(temp) {
                           textArea.value += 'Ambient Temperature: '+temp/10+' °C';
                           textArea.value += '\n';
                           textArea.scrollTop = textArea.scrollHeight;
                        }
                    );
                }
            </script>
        </body>
    </html>

## API

Generally, every method of the JavaScript bindings can take two optional parameters, `returnCallback` and `errorCallback`. These are two user defined callback functions. The `returnCallback` is called with the return values as parameters, if the method returns something. 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

The namespace for the JavaScript bindings is `Tinkerforge.*`.

### Basic Functions

new `BrickletTemperatureIR`(uid, ipcon)

  Parameters:

  - uid -- string
  - ipcon -- IPConnection

  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 (see examples above).

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

  Callback:

  - temperature -- int

  Returns the ambient temperature of the sensor. The value has a range of -400 to 1250 and is given in °C/10, e.g. a value of 423 means that an ambient temperature of 42.3 °C is measured.

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

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

  Callback:

  - temperature -- int

  Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at. The value has a range of -700 to 3800 and is given in °C/10, e.g. a value of 3001 means that a temperature of 300.1 °C is measured on the surface of the object.

  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 `CALLBACK_OBJECT_TEMPERATURE` and set the period with `setObjectTemperatureCallbackPeriod()`.

### Advanced Functions

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

  Parameters:

  - emissivity -- int

  Callback: | 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 default emissivity is 1.0 (value of 65535) and the minimum emissivity the sensor can handle is 0.1 (value of 6553).

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

  Callback:

  - emissivity -- int

  Returns the emissivity as set by `setEmissivity()`.

`BrickletTemperatureIR.``getAPIVersion`()

  Return type: | [int, int, int]

  Returns the version of the API definition (major, minor, revision) 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 -- int

  Return 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 send and errors are silently ignored, because they cannot be detected.

  See `setResponseExpected()` for the list of function ID constants available for this function.

`BrickletTemperatureIR.``setResponseExpected`(functionId, responseExpected[, errorCallback])

  Parameters:

  - functionId -- int
  - responseExpected -- boolean

  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 and callbacks it is always disabled.

  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 send and errors are silently ignored, because they cannot be detected.

  The following function ID constants are available for this function:

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

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

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

  Callback:

  - uid -- string
  - connectedUid -- string
  - position -- char
  - hardwareVersion -- [int, int, int]
  - firmwareVersion -- [int, int, int]
  - deviceIdentifier -- int

  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' or 'd'.

  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`(id, callback)

  Parameters:

  - id -- int
  - callback -- function

  Registers a callback with ID id to the function callback. The available IDs with corresponding function signatures are listed below.

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

  Parameters:

  - period -- int

  Callback: | undefined

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

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

  The default value is 0.

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

  Callback:

  - period -- int

  Returns the period as set by `setAmbientTemperatureCallbackPeriod()`.

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

  Parameters:

  - period -- int

  Callback: | undefined

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

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

  The default value is 0.

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

  Callback:

  - period -- int

  Returns the period as set by `setObjectTemperatureCallbackPeriod()`.

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

  Parameters:

  - option -- char
  - min -- int
  - max -- int

  Callback: | 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 default value is ('x', 0, 0).

  The following constants are available for this function:

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

  - option -- char
  - min -- int
  - max -- int

  Returns the threshold as set by `setAmbientTemperatureCallbackThreshold()`.

  The following constants are available for this function:

  - 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 -- char
  - min -- int
  - max -- int

  Callback: | 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 default value is ('x', 0, 0).

  The following constants are available for this function:

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

  - option -- char
  - min -- int
  - max -- int

  Returns the threshold as set by `setObjectTemperatureCallbackThreshold()`.

  The following constants are available for this function:

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

  Callback: | undefined

  Sets the period in ms with which the threshold callbacks

  - `CALLBACK_AMBIENT_TEMPERATURE_REACHED`,
  - `CALLBACK_OBJECT_TEMPERATURE_REACHED`

  are triggered, if the thresholds

  - `setAmbientTemperatureCallbackThreshold()`,
  - `setObjectTemperatureCallbackThreshold()`

  keep being reached.

  The default value is 100.

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

  Callback:

  - debounce -- int

  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`

  Parameters:

  - temperature -- int

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

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

`BrickletTemperatureIR.``CALLBACK_OBJECT_TEMPERATURE`

  Parameters:

  - temperature -- int

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

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

`BrickletTemperatureIR.``CALLBACK_AMBIENT_TEMPERATURE_REACHED`

  Parameters:

  - temperature -- int

  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`

  Parameters:

  - temperature -- int

  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()`.

### Constants

`BrickletTemperatureIR.``DEVICE_IDENTIFIER`

  This constant is used to identify a Temperature IR Bricklet.

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

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.