Software / API Bindings / JavaScript / API Reference and Examples / Bricklets / Thermal Imaging Bricklet

JavaScript - Thermal Imaging Bricklet¶

This is the description of the JavaScript API bindings for the Thermal Imaging Bricklet. General information and technical specifications for the Thermal Imaging 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 Thermal Imaging Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var ti = new Tinkerforge.BrickletThermalImaging(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) {
        // Enable high contrast image transfer for callback
        ti.setImageTransferConfig(Tinkerforge.BrickletThermalImaging.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE);
    }
);

// Register high contrast image callback
ti.on(Tinkerforge.BrickletThermalImaging.CALLBACK_HIGH_CONTRAST_IMAGE,
    // Callback function for high contrast image callback
    function (image) {
        // image is an array of size 80*60 with a 8 bit grey value for each element
    }
);

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>Thermal Imaging 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 ti = new Tinkerforge.BrickletThermalImaging(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) {
                        // Enable high contrast image transfer for callback
                        ti.setImageTransferConfig(Tinkerforge.BrickletThermalImaging.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE);
                    }
                );

                // Register high contrast image callback
                ti.on(Tinkerforge.BrickletThermalImaging.CALLBACK_HIGH_CONTRAST_IMAGE,
                    // Callback function for high contrast image callback
                    function (image) {
                        // image is an array of size 80*60 with a 8 bit grey value for each element
                    }
                );
            }
        </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 BrickletThermalImaging(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	thermalImaging – Type: BrickletThermalImaging

Creates an object with the unique device ID uid:

var thermalImaging = new BrickletThermalImaging("YOUR_DEVICE_UID", ipcon);

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

BrickletThermalImaging.getHighContrastImage([returnCallback][, errorCallback])¶

Callback Parameters:	image – Type: [int, ...], Length: 4800, Range: [0 to 255]
Returns:	undefined

Returns the current high contrast image. See here for the difference between High Contrast and Temperature Image. If you don't know what to use the High Contrast Image is probably right for you.

The data is organized as a 8-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.

Each 8-bit value represents one gray-scale image pixel that can directly be shown to a user on a display.

Before you can use this function you have to enable it with setImageTransferConfig().

BrickletThermalImaging.getTemperatureImage([returnCallback][, errorCallback])¶

Callback Parameters:	image – Type: [int, ...], Length: 4800, Unit: ? K, Range: [0 to 2¹⁶ - 1]
Returns:	undefined

Returns the current temperature image. See here for the difference between High Contrast and Temperature Image. If you don't know what to use the High Contrast Image is probably right for you.

The data is organized as a 16-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.

Each 16-bit value represents one temperature measurement in either Kelvin/10 or Kelvin/100 (depending on the resolution set with setResolution()).

Before you can use this function you have to enable it with setImageTransferConfig().

BrickletThermalImaging.getStatistics([returnCallback][, errorCallback])¶

Callback Parameters:

Callback Parameters:	spotmeterStatistics – Type: [int, ...], Length: 4 0: meanTemperature – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1] 1: maxTemperature – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1] 2: minTemperature – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1] 3: pixelCount – Type: int, Range: [0 to 4800] temperatures – Type: [int, ...], Length: 4 0: focalPlainArray – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1] 1: focalPlainArrayLastFFC – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1] 2: housing – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1] 3: housingLastFFC – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1] resolution – Type: int, Range: See constants ffcStatus – Type: int, Range: See constants temperatureWarning – Type: [boolean, ...], Length: 2 0: shutterLockout – Type: boolean 1: overtemperatureShutDownImminent – Type: boolean
Returns:	undefined

spotmeterStatistics – Type: [int, ...], Length: 4

0: meanTemperature – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1]
1: maxTemperature – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1]
2: minTemperature – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1]
3: pixelCount – Type: int, Range: [0 to 4800]

temperatures – Type: [int, ...], Length: 4

0: focalPlainArray – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1]
1: focalPlainArrayLastFFC – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1]
2: housing – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1]
3: housingLastFFC – Type: int, Unit: ? K, Range: [0 to 2¹⁶ - 1]

resolution – Type: int, Range: See constants
ffcStatus – Type: int, Range: See constants
temperatureWarning – Type: [boolean, ...], Length: 2

0: shutterLockout – Type: boolean
1: overtemperatureShutDownImminent – Type: boolean

Returns:

undefined

Returns the spotmeter statistics, various temperatures, current resolution and status bits.

The spotmeter statistics are:

Index 0: Mean Temperature.
Index 1: Maximum Temperature.
Index 2: Minimum Temperature.
Index 3: Pixel Count of spotmeter region of interest.

The temperatures are:

Index 0: Focal Plain Array temperature.
Index 1: Focal Plain Array temperature at last FFC (Flat Field Correction).
Index 2: Housing temperature.
Index 3: Housing temperature at last FFC.

The resolution is either 0 to 6553 Kelvin or 0 to 655 Kelvin. If the resolution is the former, the temperatures are in Kelvin/10, if it is the latter the temperatures are in Kelvin/100.

FFC (Flat Field Correction) Status:

FFC Never Commanded: Only seen on startup before first FFC.
FFC Imminent: This state is entered 2 seconds prior to initiating FFC.
FFC In Progress: Flat field correction is started (shutter moves in front of lens and back). Takes about 1 second.
FFC Complete: Shutter is in waiting position again, FFC done.

Temperature warning bits:

Index 0: Shutter lockout (if true shutter is locked out because temperature is outside -10°C to +65°C)
Index 1: Overtemperature shut down imminent (goes true 10 seconds before shutdown)

The following constants are available for this function:

For resolution:

BrickletThermalImaging.RESOLUTION_0_TO_6553_KELVIN = 0
BrickletThermalImaging.RESOLUTION_0_TO_655_KELVIN = 1

For ffc_status:

BrickletThermalImaging.FFC_STATUS_NEVER_COMMANDED = 0
BrickletThermalImaging.FFC_STATUS_IMMINENT = 1
BrickletThermalImaging.FFC_STATUS_IN_PROGRESS = 2
BrickletThermalImaging.FFC_STATUS_COMPLETE = 3

BrickletThermalImaging.setResolution(resolution[, returnCallback][, errorCallback])¶

Parameters:	resolution – Type: int, Range: See constants, Default: 1
Callback Parameters:	undefined
Returns:	undefined

Sets the resolution. The Thermal Imaging Bricklet can either measure

from 0 to 6553 Kelvin (-273.15°C to +6279.85°C) with 0.1°C resolution or
from 0 to 655 Kelvin (-273.15°C to +381.85°C) with 0.01°C resolution.

The accuracy is specified for -10°C to 450°C in the first range and -10°C and 140°C in the second range.

The following constants are available for this function:

For resolution:

BrickletThermalImaging.RESOLUTION_0_TO_6553_KELVIN = 0
BrickletThermalImaging.RESOLUTION_0_TO_655_KELVIN = 1

BrickletThermalImaging.getResolution([returnCallback][, errorCallback])¶

Callback Parameters:	resolution – Type: int, Range: See constants
Returns:	undefined

Returns the resolution as set by setResolution().

The following constants are available for this function:

For resolution:

BrickletThermalImaging.RESOLUTION_0_TO_6553_KELVIN = 0
BrickletThermalImaging.RESOLUTION_0_TO_655_KELVIN = 1

BrickletThermalImaging.setSpotmeterConfig(regionOfInterest[, returnCallback][, errorCallback])¶

Parameters:	regionOfInterest – Type: [int, ...], Length: 4 0: firstColumn – Type: int, Range: [0 to 78], Default: 39 1: firstRow – Type: int, Range: [0 to 58], Default: 29 2: lastColumn – Type: int, Range: [1 to 79], Default: 40 3: lastRow – Type: int, Range: [1 to 59], Default: 30
Callback Parameters:	undefined
Returns:	undefined

Sets the spotmeter region of interest. The 4 values are

Index 0: Column start (has to be smaller than column end).
Index 1: Row start (has to be smaller than row end).
Index 2: Column end (has to be smaller than 80).
Index 3: Row end (has to be smaller than 60).

The spotmeter statistics can be read out with getStatistics().

BrickletThermalImaging.getSpotmeterConfig([returnCallback][, errorCallback])¶

Callback Parameters:	regionOfInterest – Type: [int, ...], Length: 4 0: firstColumn – Type: int, Range: [0 to 78], Default: 39 1: firstRow – Type: int, Range: [0 to 58], Default: 29 2: lastColumn – Type: int, Range: [1 to 79], Default: 40 3: lastRow – Type: int, Range: [1 to 59], Default: 30
Returns:	undefined

Returns the spotmeter config as set by setSpotmeterConfig().

BrickletThermalImaging.setHighContrastConfig(regionOfInterest, dampeningFactor, clipLimit, emptyCounts[, returnCallback][, errorCallback])¶

Parameters:	regionOfInterest – Type: [int, ...], Length: 4 0: firstColumn – Type: int, Range: [0 to 79], Default: 0 1: firstRow – Type: int, Range: [0 to 58], Default: 0 2: lastColumn – Type: int, Range: [0 to 79], Default: 79 3: lastRow – Type: int, Range: [1 to 59], Default: 59 dampeningFactor – Type: int, Range: [0 to 256], Default: 64 clipLimit – Type: [int, ...], Length: 2 0: agcHEQClipLimitHigh – Type: int, Range: [0 to 4800], Default: 4800 1: agcHEQClipLimitLow – Type: int, Range: [0 to 2¹⁰], Default: 2⁹ emptyCounts – Type: int, Range: [0 to 2¹⁴ - 1], Default: 2
Callback Parameters:	undefined
Returns:	undefined

Sets the high contrast region of interest, dampening factor, clip limit and empty counts. This config is only used in high contrast mode (see setImageTransferConfig()).

The high contrast region of interest consists of four values:

Index 0: Column start (has to be smaller than or equal to column end).
Index 1: Row start (has to be smaller than row end).
Index 2: Column end (has to be smaller than 80).
Index 3: Row end (has to be smaller than 60).

The algorithm to generate the high contrast image is applied to this region.

Dampening Factor: This parameter is the amount of temporal dampening applied to the HEQ (history equalization) transformation function. An IIR filter of the form:

(N / 256) * previous + ((256 - N) / 256) * current

is applied, and the HEQ dampening factor represents the value N in the equation, i.e., a value that applies to the amount of influence the previous HEQ transformation function has on the current function. The lower the value of N the higher the influence of the current video frame whereas the higher the value of N the more influence the previous damped transfer function has.

Clip Limit Index 0 (AGC HEQ Clip Limit High): This parameter defines the maximum number of pixels allowed to accumulate in any given histogram bin. Any additional pixels in a given bin are clipped. The effect of this parameter is to limit the influence of highly-populated bins on the resulting HEQ transformation function.

Clip Limit Index 1 (AGC HEQ Clip Limit Low): This parameter defines an artificial population that is added to every non-empty histogram bin. In other words, if the Clip Limit Low is set to L, a bin with an actual population of X will have an effective population of L + X. Any empty bin that is nearby a populated bin will be given an artificial population of L. The effect of higher values is to provide a more linear transfer function; lower values provide a more non-linear (equalized) transfer function.

Empty Counts: This parameter specifies the maximum number of pixels in a bin that will be interpreted as an empty bin. Histogram bins with this number of pixels or less will be processed as an empty bin.

BrickletThermalImaging.getHighContrastConfig([returnCallback][, errorCallback])¶

Callback Parameters:

Callback Parameters:	regionOfInterest – Type: [int, ...], Length: 4 0: firstColumn – Type: int, Range: [0 to 78], Default: 0 1: firstRow – Type: int, Range: [0 to 58], Default: 0 2: lastColumn – Type: int, Range: [1 to 79], Default: 79 3: lastRow – Type: int, Range: [1 to 59], Default: 59 dampeningFactor – Type: int, Range: [0 to 256], Default: 64 clipLimit – Type: [int, ...], Length: 2 0: agcHEQClipLimitHigh – Type: int, Range: [0 to 4800], Default: 4800 1: agcHEQClipLimitLow – Type: int, Range: [0 to 2¹⁰], Default: 2⁹ emptyCounts – Type: int, Range: [0 to 2¹⁶ - 1], Default: 2
Returns:	undefined

regionOfInterest – Type: [int, ...], Length: 4

0: firstColumn – Type: int, Range: [0 to 78], Default: 0
1: firstRow – Type: int, Range: [0 to 58], Default: 0
2: lastColumn – Type: int, Range: [1 to 79], Default: 79
3: lastRow – Type: int, Range: [1 to 59], Default: 59

dampeningFactor – Type: int, Range: [0 to 256], Default: 64
clipLimit – Type: [int, ...], Length: 2

0: agcHEQClipLimitHigh – Type: int, Range: [0 to 4800], Default: 4800
1: agcHEQClipLimitLow – Type: int, Range: [0 to 2¹⁰], Default: 2⁹

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

Returns:

undefined

Returns the high contrast config as set by setHighContrastConfig().

Advanced Functions¶

BrickletThermalImaging.setFluxLinearParameters(sceneEmissivity, temperatureBackground, tauWindow, temperaturWindow, tauAtmosphere, temperatureAtmosphere, reflectionWindow, temperatureReflection[, returnCallback][, errorCallback])¶

Parameters:	sceneEmissivity – Type: int, Unit: 25/2048 %, Range: [82 to 2¹³], Default: 2¹³ temperatureBackground – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 29515 tauWindow – Type: int, Unit: 25/2048 %, Range: [82 to 2¹³], Default: 2¹³ temperaturWindow – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 29515 tauAtmosphere – Type: int, Unit: 25/2048 %, Range: [82 to 2¹³], Default: 2¹³ temperatureAtmosphere – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 29515 reflectionWindow – Type: int, Unit: 25/2048 %, Range: [0 to 2¹³], Default: 0 temperatureReflection – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 29515
Callback Parameters:	undefined
Returns:	undefined

Sets the flux linear parameters that can be used for radiometry calibration.

See FLIR document 102-PS245-100-01 for more details.

New in version 2.0.5 (Plugin).

BrickletThermalImaging.getFluxLinearParameters([returnCallback][, errorCallback])¶

Callback Parameters:

Callback Parameters:	sceneEmissivity – Type: int, Unit: 25/2048 %, Range: [82 to 2¹³], Default: 2¹³ temperatureBackground – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 29515 tauWindow – Type: int, Unit: 25/2048 %, Range: [82 to 2¹³], Default: 2¹³ temperaturWindow – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 29515 tauAtmosphere – Type: int, Unit: 25/2048 %, Range: [82 to 2¹³], Default: 2¹³ temperatureAtmosphere – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 29515 reflectionWindow – Type: int, Unit: 25/2048 %, Range: [0 to 2¹³], Default: 0 temperatureReflection – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 29515
Returns:	undefined

sceneEmissivity – Type: int, Unit: 25/2048 %, Range: [82 to 2¹³], Default: 2¹³
temperatureBackground – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 29515
tauWindow – Type: int, Unit: 25/2048 %, Range: [82 to 2¹³], Default: 2¹³
temperaturWindow – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 29515
tauAtmosphere – Type: int, Unit: 25/2048 %, Range: [82 to 2¹³], Default: 2¹³
temperatureAtmosphere – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 29515
reflectionWindow – Type: int, Unit: 25/2048 %, Range: [0 to 2¹³], Default: 0
temperatureReflection – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 29515

Returns:

undefined

Returns the flux linear parameters, as set by setFluxLinearParameters().

New in version 2.0.5 (Plugin).

BrickletThermalImaging.setFFCShutterMode(shutterMode, tempLockoutState, videoFreezeDuringFFC, ffcDesired, elapsedTimeSinceLastFFC, desiredFFCPeriod, explicitCmdToOpen, desiredFFCTempDelta, imminentDelay[, returnCallback][, errorCallback])¶

Parameters:	shutterMode – Type: int, Range: See constants, Default: 1 tempLockoutState – Type: int, Range: See constants, Default: 0 videoFreezeDuringFFC – Type: boolean, Default: true ffcDesired – Type: boolean, Default: false elapsedTimeSinceLastFFC – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 desiredFFCPeriod – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 300000 explicitCmdToOpen – Type: boolean, Default: false desiredFFCTempDelta – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 300 imminentDelay – Type: int, Range: [0 to 2¹⁶ - 1], Default: 52
Callback Parameters:	undefined
Returns:	undefined

Sets the FFC shutter mode parameters.

See FLIR document 110-0144-03 4.5.15 for more details.

The following constants are available for this function:

For shutter_mode:

BrickletThermalImaging.SHUTTER_MODE_MANUAL = 0
BrickletThermalImaging.SHUTTER_MODE_AUTO = 1
BrickletThermalImaging.SHUTTER_MODE_EXTERNAL = 2

For temp_lockout_state:

BrickletThermalImaging.SHUTTER_LOCKOUT_INACTIVE = 0
BrickletThermalImaging.SHUTTER_LOCKOUT_HIGH = 1
BrickletThermalImaging.SHUTTER_LOCKOUT_LOW = 2

New in version 2.0.6 (Plugin).

BrickletThermalImaging.getFFCShutterMode([returnCallback][, errorCallback])¶

Callback Parameters:

Callback Parameters:	shutterMode – Type: int, Range: See constants, Default: 1 tempLockoutState – Type: int, Range: See constants, Default: 0 videoFreezeDuringFFC – Type: boolean, Default: true ffcDesired – Type: boolean, Default: false elapsedTimeSinceLastFFC – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 desiredFFCPeriod – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 300000 explicitCmdToOpen – Type: boolean, Default: false desiredFFCTempDelta – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 300 imminentDelay – Type: int, Range: [0 to 2¹⁶ - 1], Default: 52
Returns:	undefined

shutterMode – Type: int, Range: See constants, Default: 1
tempLockoutState – Type: int, Range: See constants, Default: 0
videoFreezeDuringFFC – Type: boolean, Default: true
ffcDesired – Type: boolean, Default: false
elapsedTimeSinceLastFFC – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
desiredFFCPeriod – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 300000
explicitCmdToOpen – Type: boolean, Default: false
desiredFFCTempDelta – Type: int, Unit: 1/100 K, Range: [0 to 2¹⁶ - 1], Default: 300
imminentDelay – Type: int, Range: [0 to 2¹⁶ - 1], Default: 52

Returns:

undefined

Sets the FFC shutter mode parameters.

See FLIR document 110-0144-03 4.5.15 for more details.

The following constants are available for this function:

For shutter_mode:

BrickletThermalImaging.SHUTTER_MODE_MANUAL = 0
BrickletThermalImaging.SHUTTER_MODE_AUTO = 1
BrickletThermalImaging.SHUTTER_MODE_EXTERNAL = 2

For temp_lockout_state:

BrickletThermalImaging.SHUTTER_LOCKOUT_INACTIVE = 0
BrickletThermalImaging.SHUTTER_LOCKOUT_HIGH = 1
BrickletThermalImaging.SHUTTER_LOCKOUT_LOW = 2

New in version 2.0.6 (Plugin).

BrickletThermalImaging.runFFCNormalization([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Starts the Flat-Field Correction (FFC) normalization.

See FLIR document 110-0144-03 4.5.16 for more details.

New in version 2.0.6 (Plugin).

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

Callback Parameters:	errorCountAckChecksum – Type: int, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: int, Range: [0 to 2³² - 1] errorCountFrame – Type: int, Range: [0 to 2³² - 1] errorCountOverflow – Type: int, Range: [0 to 2³² - 1]
Returns:	undefined

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

ACK checksum errors,
message checksum errors,
framing errors and
overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

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

Parameters:	config – Type: int, Range: See constants, Default: 3
Callback Parameters:	undefined
Returns:	undefined

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

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

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

Callback Parameters:	config – Type: int, Range: See constants, Default: 3
Returns:	undefined

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For config:

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

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

Callback Parameters:	temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]
Returns:	undefined

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

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

Callback Parameters:	undefined
Returns:	undefined

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

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

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

BrickletThermalImaging.setImageTransferConfig(config[, returnCallback][, errorCallback])¶

Parameters:	config – Type: int, Range: See constants, Default: 0
Callback Parameters:	undefined
Returns:	undefined

The necessary bandwidth of this Bricklet is too high to use getter/callback or high contrast/temperature image at the same time. You have to configure the one you want to use, the Bricklet will optimize the internal configuration accordingly.

Corresponding functions:

Manual High Contrast Image: getHighContrastImage().
Manual Temperature Image: getTemperatureImage().
Callback High Contrast Image: CALLBACK_HIGH_CONTRAST_IMAGE callback.
Callback Temperature Image: CALLBACK_TEMPERATURE_IMAGE callback.

The following constants are available for this function:

For config:

BrickletThermalImaging.IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE = 0
BrickletThermalImaging.IMAGE_TRANSFER_MANUAL_TEMPERATURE_IMAGE = 1
BrickletThermalImaging.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE = 2
BrickletThermalImaging.IMAGE_TRANSFER_CALLBACK_TEMPERATURE_IMAGE = 3

BrickletThermalImaging.getImageTransferConfig([returnCallback][, errorCallback])¶

Callback Parameters:	config – Type: int, Range: See constants, Default: 0
Returns:	undefined

Returns the image transfer config, as set by setImageTransferConfig().

The following constants are available for this function:

For config:

BrickletThermalImaging.IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE = 0
BrickletThermalImaging.IMAGE_TRANSFER_MANUAL_TEMPERATURE_IMAGE = 1
BrickletThermalImaging.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE = 2
BrickletThermalImaging.IMAGE_TRANSFER_CALLBACK_TEMPERATURE_IMAGE = 3

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:

thermalImaging.on(BrickletThermalImaging.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.

BrickletThermalImaging.CALLBACK_HIGH_CONTRAST_IMAGE¶

Callback Parameters:	image – Type: [int, ...], Length: 4800, Range: [0 to 255]

This callback is triggered with every new high contrast image if the transfer image config is configured for high contrast callback (see setImageTransferConfig()).

The data is organized as a 8-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.

Each 8-bit value represents one gray-scale image pixel that can directly be shown to a user on a display.

Note

If reconstructing the value fails, the callback is triggered with null for image.

BrickletThermalImaging.CALLBACK_TEMPERATURE_IMAGE¶

Callback Parameters:	image – Type: [int, ...], Length: 4800, Unit: ? K, Range: [0 to 2¹⁶ - 1]

This callback is triggered with every new temperature image if the transfer image config is configured for temperature callback (see setImageTransferConfig()).

The data is organized as a 16-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.

Each 16-bit value represents one temperature measurement in either Kelvin/10 or Kelvin/100 (depending on the resolution set with setResolution()).

Note

If reconstructing the value fails, the callback is triggered with null for image.

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.

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

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

BrickletThermalImaging.FUNCTION_SET_RESOLUTION = 4
BrickletThermalImaging.FUNCTION_SET_SPOTMETER_CONFIG = 6
BrickletThermalImaging.FUNCTION_SET_HIGH_CONTRAST_CONFIG = 8
BrickletThermalImaging.FUNCTION_SET_IMAGE_TRANSFER_CONFIG = 10
BrickletThermalImaging.FUNCTION_SET_FLUX_LINEAR_PARAMETERS = 14
BrickletThermalImaging.FUNCTION_SET_FFC_SHUTTER_MODE = 16
BrickletThermalImaging.FUNCTION_RUN_FFC_NORMALIZATION = 18
BrickletThermalImaging.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletThermalImaging.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletThermalImaging.FUNCTION_RESET = 243
BrickletThermalImaging.FUNCTION_WRITE_UID = 248

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

BrickletThermalImaging.FUNCTION_SET_RESOLUTION = 4
BrickletThermalImaging.FUNCTION_SET_SPOTMETER_CONFIG = 6
BrickletThermalImaging.FUNCTION_SET_HIGH_CONTRAST_CONFIG = 8
BrickletThermalImaging.FUNCTION_SET_IMAGE_TRANSFER_CONFIG = 10
BrickletThermalImaging.FUNCTION_SET_FLUX_LINEAR_PARAMETERS = 14
BrickletThermalImaging.FUNCTION_SET_FFC_SHUTTER_MODE = 16
BrickletThermalImaging.FUNCTION_RUN_FFC_NORMALIZATION = 18
BrickletThermalImaging.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletThermalImaging.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletThermalImaging.FUNCTION_RESET = 243
BrickletThermalImaging.FUNCTION_WRITE_UID = 248

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

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

Parameters:	mode – Type: int, Range: See constants
Callback Parameters:	status – Type: int, Range: See constants
Returns:	undefined

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

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

For status:

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

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

Callback Parameters:	mode – Type: int, Range: See constants
Returns:	undefined

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For mode:

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

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

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

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

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

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Callback Parameters:	status – Type: int, Range: [0 to 255]
Returns:	undefined

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

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

Parameters:	uid – Type: int, Range: [0 to 2³² - 1]
Callback Parameters:	undefined
Returns:	undefined

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

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

Callback Parameters:	uid – Type: int, Range: [0 to 2³² - 1]
Returns:	undefined

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

BrickletThermalImaging.DEVICE_IDENTIFIER¶

This constant is used to identify a Thermal Imaging 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.

BrickletThermalImaging.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Thermal Imaging Bricklet.