Deutsch
English
Menu

MATLAB/Octave - Thermal Imaging Bricklet

This is the description of the MATLAB/Octave 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 MATLAB/Octave API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Callback (MATLAB)

Download (matlab_example_callback.m)

 1function matlab_example_callback()
 2    import com.tinkerforge.IPConnection;
 3    import com.tinkerforge.BrickletThermalImaging;
 4
 5    HOST = 'localhost';
 6    PORT = 4223;
 7    UID = 'XYZ'; % Change XYZ to the UID of your Thermal Imaging Bricklet
 8
 9    ipcon = IPConnection(); % Create IP connection
10    ti = handle(BrickletThermalImaging(UID, ipcon), 'CallbackProperties'); % Create device object
11
12    ipcon.connect(HOST, PORT); % Connect to brickd
13    % Don't use device before ipcon is connected
14
15    % Register high contrast image callback to function cb_high_contrast_image
16    set(ti, 'HighContrastImageCallback', @(h, e) cb_high_contrast_image(e));
17
18    % Enable high contrast image transfer for callback
19    ti.setImageTransferConfig(BrickletThermalImaging.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE);
20
21    input('Press key to exit\n', 's');
22    ipcon.disconnect();
23end
24
25% Callback function for high contrast image callback
26function cb_high_contrast_image(e)
27    % e.image is an array of size 80*60 with a 8 bit grey value for each element
28end

Create Image (MATLAB)

Download (matlab_example_create_image.m)

 1function matlab_example_create_image()
 2  import java.io.File;
 3  import javax.imageio.ImageIO;
 4  import com.tinkerforge.IPConnection;
 5  import java.awt.image.BufferedImage;
 6  import com.tinkerforge.BrickletThermalImaging;
 7
 8  % Takes one thermal image and saves it as PNG
 9
10  HOST = 'localhost';
11  PORT = 4223;
12  UID = 'XYZ'; % Change XYZ to the UID of your Thermal Imaging Bricklet
13
14  WIDTH = 80;
15  HEIGHT = 60;
16  SCALE = 10;
17
18  % Creates standard thermal image color palette (blue=cold, red=hot)
19  paletteR = zeros(1, 255, 'int32');
20  paletteG = zeros(1, 255, 'int32');
21  paletteB = zeros(1, 255, 'int32');
22
23  function createThermalImageColorPalette()
24    % The palette is gnuplot's PM3D palette.
25    % See here for details: https://stackoverflow.com/questions/28495390/thermal-imaging-palette
26    for x = 1:1:255
27      paletteR(x) = int32(fix(255 * sqrt(x / 255)));
28      paletteG(x) = int32(fix(255 * (x / 255)^3));
29      paletteB(x) = 0;
30
31      paletteBSine = sin(2 * pi * (x / 255));
32
33      if paletteBSine >= 0
34        paletteB(x) = int32(fix(255 * sin(2 * pi * (x / 255))));
35      end
36    end
37  end
38
39  % Helper function for simple buffer resize
40  function resizedBufferedImage = resize(sourceBufferedImage, newW, newH)
41    import java.awt.Image;
42    import java.awt.image.BufferedImage;
43
44    scaledSourceBufferedImage = sourceBufferedImage.getScaledInstance(newW, ...
45                                                                      newH, ...
46                                                                      Image.SCALE_SMOOTH);
47    resizedBufferedImage = BufferedImage(newW, newH, BufferedImage.TYPE_INT_ARGB);
48
49    g2d = resizedBufferedImage.createGraphics();
50    g2d.drawImage(scaledSourceBufferedImage, 0, 0, []);
51    g2d.dispose();
52  end
53
54  ipcon = IPConnection(); % Create IP connection
55  ti = handle(BrickletThermalImaging(UID, ipcon), 'CallbackProperties'); % Create device object
56
57  ipcon.connect(HOST, PORT); % Connect to brickd
58  % Do not use device before ipcon is connected
59
60  % Enable high contrast image transfer for getter
61  ti.setImageTransferConfig(BrickletThermalImaging.IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE);
62
63  createThermalImageColorPalette();
64
65  % If we change between transfer modes we have to wait until one more
66  % image is taken after the mode is set and the first image is saved
67  % we can call get_high_contrast_image any time.
68  pause on;
69  pause(0.5);
70
71  image = typecast(ti.getHighContrastImage(), 'int32');
72
73  % Use palette mapping to create thermal image coloring
74  for i = 1:1:4800
75    % Because in MATLAB/Octave indexing starts from 1
76    if image(i) < 255
77      image(i) = image(i) + 1;
78    end
79
80    alphaLSH = uint32(bitshift(255, 24));
81    redLSH = uint32(bitshift(paletteR(image(i)), 16));
82    greenLSH = uint32(bitshift(paletteG(image(i)), 8));
83    blueLSH = uint32(bitshift(paletteB(image(i)), 0));
84
85    image(i) = typecast(bitor(bitor(alphaLSH, redLSH), bitor(greenLSH, blueLSH)), ...
86                        'int32');
87  end
88
89  % Create BufferedImage with data
90  bufferedImage = BufferedImage(WIDTH, HEIGHT, BufferedImage.TYPE_INT_ARGB);
91  bufferedImage.setRGB(0, 0, WIDTH, HEIGHT, image, 0, WIDTH);
92
93  % Scale to 800x600 and save thermal image!
94  ImageIO.write(resize(bufferedImage, WIDTH*SCALE, HEIGHT*SCALE), 'png', File('thermal_image.png'));
95
96  input('Press key to exit\n', 's');
97
98  ipcon.disconnect();
99end

Live Video (MATLAB)

Download (matlab_example_live_video.m)

  1function matlab_example_live_video()
  2  import java.awt.*;
  3  import javax.swing.*;
  4  import java.awt.Image;
  5  import javax.swing.BoxLayout;
  6  import javax.swing.ImageIcon;
  7  import java.awt.event.WindowEvent;
  8  import com.tinkerforge.IPConnection;
  9  import java.awt.image.BufferedImage;
 10  import com.tinkerforge.BrickletThermalImaging;
 11
 12  % Shows live thermal image video in in swing label
 13
 14  HOST = 'localhost';
 15  PORT = 4223;
 16  UID = 'XYZ'; % Change XYZ to the UID of your Thermal Imaging Bricklet
 17
 18  WIDTH = 80;
 19  HEIGHT = 60;
 20  SCALE = 5;
 21
 22% Creates standard thermal image color palette (blue=cold, red=hot)
 23  paletteR = zeros(1, 255, 'int32');
 24  paletteG = zeros(1, 255, 'int32');
 25  paletteB = zeros(1, 255, 'int32');
 26
 27  function createThermalImageColorPalette()
 28    % The palette is gnuplot's PM3D palette.
 29    % See here for details: https://stackoverflow.com/questions/28495390/thermal-imaging-palette
 30    for x = 1:1:255
 31      paletteR(x) = int32(fix(255 * sqrt(x / 255)));
 32      paletteG(x) = int32(fix(255 * (x / 255)^3));
 33      paletteB(x) = 0;
 34
 35      paletteBSine = sin(2 * pi * (x / 255));
 36
 37      if paletteBSine >= 0
 38        paletteB(x) = int32(fix(255 * sin(2 * pi * (x / 255))));
 39      end
 40    end
 41  end
 42
 43  % Function to handle example exit
 44  function end_example()
 45      ipcon.disconnect();
 46      frameExample.hide();
 47  end
 48
 49  ipcon = IPConnection(); % Create IP connection
 50  ti = handle(BrickletThermalImaging(UID, ipcon), 'CallbackProperties'); % Create device object
 51
 52  ipcon.connect(HOST, PORT); % Connect to brickd
 53  % Do not use device before ipcon is connected
 54
 55  % Enable high contrast image transfer for callback
 56  ti.setImageTransferConfig(BrickletThermalImaging.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE);
 57
 58  createThermalImageColorPalette();
 59
 60  % If we change between transfer modes we have to wait until one more
 61  % image is taken after the mode is set and the first image is saved
 62  % we can call get_high_contrast_image any time.
 63  pause on;
 64  pause(0.5);
 65
 66  % Prepare the JPanel and the JFrame
 67  panelExample = JPanel();
 68  frameExample = JFrame('Example Live Video');
 69
 70  set(frameExample, 'WindowClosingCallback', @(h, e) end_example());
 71  frameExample.setSize(WIDTH*SCALE, HEIGHT*SCALE);
 72  panelExample.setLayout(BoxLayout(panelExample, BoxLayout.Y_AXIS));
 73
 74  % Prepare JLabel
 75  bufferedImage = BufferedImage(80, 60, BufferedImage.TYPE_INT_ARGB);
 76
 77  newW = WIDTH*SCALE;
 78  newH = HEIGHT*SCALE;
 79  scaledSourceBufferedImage = bufferedImage.getScaledInstance(newW, ...
 80                                                              newH, ...
 81                                                              Image.SCALE_SMOOTH);
 82  resizedBufferedImage = BufferedImage(newW, newH, BufferedImage.TYPE_INT_ARGB);
 83  g2d = resizedBufferedImage.createGraphics();
 84  g2d.drawImage(scaledSourceBufferedImage, 0, 0, []);
 85  g2d.dispose();
 86
 87  labelExample = JLabel(ImageIcon(resizedBufferedImage));
 88  labelExample.setAlignmentX(Component.CENTER_ALIGNMENT);
 89
 90  % Populate the layout
 91  panelExample.add(labelExample);
 92
 93  frameExample.getContentPane().add(panelExample);
 94  frameExample.pack();
 95  frameExample.show();
 96
 97  % Register high contrast image callback to function cb_high_contrast_image
 98  set(ti, 'HighContrastImageCallback', @(h, e) cb_high_contrast_image(e, ...
 99                                                                      paletteR, ...
100                                                                      paletteG, ...
101                                                                      paletteB, ...
102                                                                      WIDTH, ...
103                                                                      HEIGHT, ...
104                                                                      SCALE, ...
105                                                                      labelExample));
106end
107
108% Callback function for high contrast image callback
109function cb_high_contrast_image(e, ...
110                                paletteR, ...
111                                paletteG, ...
112                                paletteB, ...
113                                WIDTH, ...
114                                HEIGHT, ...
115                                SCALE, ...
116                                labelExample)
117    import java.awt.Image;
118    import javax.swing.JLabel;
119    import javax.swing.ImageIcon;
120    import java.awt.image.BufferedImage;
121
122    image = typecast(e.image, 'int32');
123
124    % Use palette mapping to create thermal image coloring
125    for i = 1:1:4800
126      % Because in MATLAB/Octave indexing starts from 1
127      if image(i) < 255
128        image(i) = image(i) + 1;
129      end
130
131      alphaLSH = uint32(bitshift(255, 24));
132      redLSH = uint32(bitshift(paletteR(image(i)), 16));
133      greenLSH = uint32(bitshift(paletteG(image(i)), 8));
134      blueLSH = uint32(bitshift(paletteB(image(i)), 0));
135
136      image(i) = typecast(bitor(bitor(alphaLSH, redLSH), bitor(greenLSH, blueLSH)), ...
137                          'int32');
138    end
139
140    % Create BufferedImage with data
141    bufferedImage = BufferedImage(WIDTH, HEIGHT, BufferedImage.TYPE_INT_ARGB);
142    bufferedImage.setRGB(0, 0, WIDTH, HEIGHT, image, 0, WIDTH);
143
144    % Simple buffer resize
145    newW = WIDTH*SCALE;
146    newH = HEIGHT*SCALE;
147    scaledSourceBufferedImage = bufferedImage.getScaledInstance(newW, ...
148                                                                newH, ...
149                                                                Image.SCALE_SMOOTH);
150    resizedBufferedImage = BufferedImage(newW, newH, BufferedImage.TYPE_INT_ARGB);
151    g2d = resizedBufferedImage.createGraphics();
152    g2d.drawImage(scaledSourceBufferedImage, 0, 0, []);
153    g2d.dispose();
154
155    % Set resized buffered image as icon of label. Change SCALE to change the
156    % size of the video
157    labelExample.setIcon(ImageIcon(resizedBufferedImage));
158end

Callback (Octave)

Download (octave_example_callback.m)

 1function octave_example_callback()
 2    more off;
 3
 4    HOST = "localhost";
 5    PORT = 4223;
 6    UID = "XYZ"; % Change XYZ to the UID of your Thermal Imaging Bricklet
 7
 8    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
 9    ti = javaObject("com.tinkerforge.BrickletThermalImaging", UID, ipcon); % Create device object
10
11    ipcon.connect(HOST, PORT); % Connect to brickd
12    % Don't use device before ipcon is connected
13
14    % Register high contrast image callback to function cb_high_contrast_image
15    ti.addHighContrastImageCallback(@cb_high_contrast_image);
16
17    % Enable high contrast image transfer for callback
18    ti.setImageTransferConfig(ti.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE);
19
20    input("Press key to exit\n", "s");
21    ipcon.disconnect();
22end
23
24% Callback function for high contrast image callback
25function cb_high_contrast_image(e)
26    % e.image is an array of size 80*60 with a 8 bit grey value for each element
27end

Create Image (Octave)

Download (octave_example_create_image.m)

  1function octave_example_create_image()
  2  more off;
  3
  4  % Takes one thermal image and saves it as PNG
  5
  6  HOST = "localhost";
  7  PORT = 4223;
  8  UID = "XYZ"; % Change XYZ to the UID of your Thermal Imaging Bricklet
  9
 10  WIDTH = 80;
 11  HEIGHT = 60;
 12  SCALE = 10;
 13
 14  ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
 15  ti = javaObject("com.tinkerforge.BrickletThermalImaging", UID, ipcon); % Create device object
 16
 17  % Creates standard thermal image color palette (blue=cold, red=hot)
 18  paletteR = zeros(1, 255, "int32");
 19  paletteG = zeros(1, 255, "int32");
 20  paletteB = zeros(1, 255, "int32");
 21
 22  function createThermalImageColorPalette()
 23    % The palette is gnuplot's PM3D palette.
 24    % See here for details: https://stackoverflow.com/questions/28495390/thermal-imaging-palette
 25    for x = 1:1:255
 26      paletteR(x) = int32(fix(255 * sqrt(x / 255)));
 27      paletteG(x) = int32(fix(255 * (x / 255)^3));
 28      paletteB(x) = 0;
 29
 30      paletteBSine = sin(2 * pi * (x / 255));
 31
 32      if paletteBSine >= 0
 33        paletteB(x) = int32(fix(255 * sin(2 * pi * (x / 255))));
 34      end
 35    end
 36  end
 37
 38  % Helper function for simple buffer resize
 39  function resizedBufferedImage = resize(sourceBufferedImage, newW, newH)
 40    scaledSourceBufferedImage = sourceBufferedImage.getScaledInstance(newW, ...
 41                                                                      newH, ...
 42                                                                      java_get("java.awt.Image", "SCALE_SMOOTH"));
 43    resizedBufferedImage = javaObject("java.awt.image.BufferedImage", ...
 44                                      newW, ...
 45                                      newH, ...
 46                                      java_get("java.awt.image.BufferedImage", "TYPE_INT_ARGB"));
 47    g2d = resizedBufferedImage.createGraphics();
 48    g2d.drawImage(scaledSourceBufferedImage, 0, 0, []);
 49    g2d.dispose();
 50  end
 51
 52  ipcon.connect(HOST, PORT); % Connect to brickd
 53  % Do not use device before ipcon is connected
 54
 55  % Enable high contrast image transfer for getter
 56  ti.setImageTransferConfig(java_get("com.tinkerforge.BrickletThermalImaging", ...
 57                                     "IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE"));
 58
 59  createThermalImageColorPalette();
 60
 61  % If we change between transfer modes we have to wait until one more
 62  % image is taken after the mode is set and the first image is saved
 63  % we can call get_high_contrast_image any time.
 64  pause(0.5);
 65
 66  image = typecast(ti.getHighContrastImage(), "int32");
 67
 68  % Use palette mapping to create thermal image coloring
 69  for i = 1:1:4800
 70    % Because in MATLAB/Octave indexing starts from 1
 71    if image(i) < 255
 72      image(i) = image(i) + 1;
 73    end
 74
 75    alphaLSH = uint32(bitshift(255, 24));
 76    redLSH = uint32(bitshift(paletteR(image(i)), 16));
 77    greenLSH = uint32(bitshift(paletteG(image(i)), 8));
 78    blueLSH = uint32(bitshift(paletteB(image(i)), 0));
 79
 80    image(i) = typecast(bitor(bitor(alphaLSH, redLSH), bitor(greenLSH, blueLSH)), ...
 81                        "int32");
 82  end
 83
 84  % Create BufferedImage with data
 85  bufferedImage = javaObject("java.awt.image.BufferedImage", ...
 86                             WIDTH, ...
 87                             HEIGHT, ...
 88                             java_get("java.awt.image.BufferedImage", "TYPE_INT_ARGB"));
 89
 90  bufferedImage.setRGB(0, 0, WIDTH, HEIGHT, image, 0, WIDTH);
 91
 92  % Scale to 800x600 and save thermal image!
 93  javaMethod("write", ...
 94             "javax.imageio.ImageIO", ...
 95             resize(bufferedImage, WIDTH*SCALE, HEIGHT*SCALE), ...
 96             "png", ...
 97             javaObject("java.io.File", "thermal_image.png"));
 98
 99  input("Press key to exit\n", "s");
100
101  ipcon.disconnect();
102end

API

Generally, every method of the MATLAB bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since the MATLAB bindings are based on Java and Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions

class BrickletThermalImaging(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • thermalImaging – Type: BrickletThermalImaging

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletThermalImaging;

thermalImaging = BrickletThermalImaging('YOUR_DEVICE_UID', ipcon);

In Octave:

thermalImaging = java_new("com.tinkerforge.BrickletThermalImaging", "YOUR_DEVICE_UID", ipcon);

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

int[] BrickletThermalImaging.getHighContrastImage()
Returns:
  • image – Type: int[], Length: 4800, Range: [0 to 255]

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

int[] BrickletThermalImaging.getTemperatureImage()
Returns:
  • image – Type: int[], Length: 4800, Unit: ? K, Range: [0 to 216 - 1]

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.Statistics BrickletThermalImaging.getStatistics()
Return Object:
  • spotmeterStatistics – Type: int[], Length: 4
    • 1: meanTemperature – Type: int, Unit: ? K, Range: [0 to 216 - 1]
    • 2: maxTemperature – Type: int, Unit: ? K, Range: [0 to 216 - 1]
    • 3: minTemperature – Type: int, Unit: ? K, Range: [0 to 216 - 1]
    • 4: pixelCount – Type: int, Range: [0 to 4800]
  • temperatures – Type: int[], Length: 4
    • 1: focalPlainArray – Type: int, Unit: ? K, Range: [0 to 216 - 1]
    • 2: focalPlainArrayLastFFC – Type: int, Unit: ? K, Range: [0 to 216 - 1]
    • 3: housing – Type: int, Unit: ? K, Range: [0 to 216 - 1]
    • 4: housingLastFFC – Type: int, Unit: ? K, Range: [0 to 216 - 1]
  • resolution – Type: int, Range: See constants
  • ffcStatus – Type: int, Range: See constants
  • temperatureWarning – Type: boolean[], Length: 2
    • 1: shutterLockout – Type: boolean
    • 2: overtemperatureShutDownImminent – Type: boolean

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

  • BrickletThermalImaging.FFC_STATUS_NEVER_COMMANDED = 0

  • BrickletThermalImaging.FFC_STATUS_IMMINENT = 1

  • BrickletThermalImaging.FFC_STATUS_IN_PROGRESS = 2

  • BrickletThermalImaging.FFC_STATUS_COMPLETE = 3

void BrickletThermalImaging.setResolution(int resolution)
Parameters:
  • resolution – Type: int, Range: See constants, Default: 1

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

int BrickletThermalImaging.getResolution()
Returns:
  • resolution – Type: int, Range: See constants

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

void BrickletThermalImaging.setSpotmeterConfig(int[] regionOfInterest)
Parameters:
  • regionOfInterest – Type: int[], Length: 4
    • 1: firstColumn – Type: int, Range: [0 to 78], Default: 39
    • 2: firstRow – Type: int, Range: [0 to 58], Default: 29
    • 3: lastColumn – Type: int, Range: [1 to 79], Default: 40
    • 4: lastRow – Type: int, Range: [1 to 59], Default: 30

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

int[] BrickletThermalImaging.getSpotmeterConfig()
Return Object:
  • regionOfInterest – Type: int[], Length: 4
    • 1: firstColumn – Type: int, Range: [0 to 78], Default: 39
    • 2: firstRow – Type: int, Range: [0 to 58], Default: 29
    • 3: lastColumn – Type: int, Range: [1 to 79], Default: 40
    • 4: lastRow – Type: int, Range: [1 to 59], Default: 30

Returns the spotmeter config as set by setSpotmeterConfig().

void BrickletThermalImaging.setHighContrastConfig(int[] regionOfInterest, int dampeningFactor, int[] clipLimit, int emptyCounts)
Parameters:
  • regionOfInterest – Type: int[], Length: 4
    • 1: firstColumn – Type: int, Range: [0 to 79], Default: 0
    • 2: firstRow – Type: int, Range: [0 to 58], Default: 0
    • 3: lastColumn – Type: int, Range: [0 to 79], Default: 79
    • 4: lastRow – Type: int, Range: [1 to 59], Default: 59
  • dampeningFactor – Type: int, Range: [0 to 256], Default: 64
  • clipLimit – Type: int[], Length: 2
    • 1: agcHEQClipLimitHigh – Type: int, Range: [0 to 4800], Default: 4800
    • 2: agcHEQClipLimitLow – Type: int, Range: [0 to 210], Default: 29
  • emptyCounts – Type: int, Range: [0 to 214 - 1], Default: 2

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.HighContrastConfig BrickletThermalImaging.getHighContrastConfig()
Return Object:
  • regionOfInterest – Type: int[], Length: 4
    • 1: firstColumn – Type: int, Range: [0 to 78], Default: 0
    • 2: firstRow – Type: int, Range: [0 to 58], Default: 0
    • 3: lastColumn – Type: int, Range: [1 to 79], Default: 79
    • 4: lastRow – Type: int, Range: [1 to 59], Default: 59
  • dampeningFactor – Type: int, Range: [0 to 256], Default: 64
  • clipLimit – Type: int[], Length: 2
    • 1: agcHEQClipLimitHigh – Type: int, Range: [0 to 4800], Default: 4800
    • 2: agcHEQClipLimitLow – Type: int, Range: [0 to 210], Default: 29
  • emptyCounts – Type: int, Range: [0 to 216 - 1], Default: 2

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

Advanced Functions

void BrickletThermalImaging.setFluxLinearParameters(int sceneEmissivity, int temperatureBackground, int tauWindow, int temperaturWindow, int tauAtmosphere, int temperatureAtmosphere, int reflectionWindow, int temperatureReflection)
Parameters:
  • sceneEmissivity – Type: int, Unit: 25/2048 %, Range: [82 to 213], Default: 213
  • temperatureBackground – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515
  • tauWindow – Type: int, Unit: 25/2048 %, Range: [82 to 213], Default: 213
  • temperaturWindow – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515
  • tauAtmosphere – Type: int, Unit: 25/2048 %, Range: [82 to 213], Default: 213
  • temperatureAtmosphere – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515
  • reflectionWindow – Type: int, Unit: 25/2048 %, Range: [0 to 213], Default: 0
  • temperatureReflection – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515

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

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

Added in version 2.0.5$nbsp;(Plugin).

BrickletThermalImaging.FluxLinearParameters BrickletThermalImaging.getFluxLinearParameters()
Return Object:
  • sceneEmissivity – Type: int, Unit: 25/2048 %, Range: [82 to 213], Default: 213
  • temperatureBackground – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515
  • tauWindow – Type: int, Unit: 25/2048 %, Range: [82 to 213], Default: 213
  • temperaturWindow – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515
  • tauAtmosphere – Type: int, Unit: 25/2048 %, Range: [82 to 213], Default: 213
  • temperatureAtmosphere – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515
  • reflectionWindow – Type: int, Unit: 25/2048 %, Range: [0 to 213], Default: 0
  • temperatureReflection – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515

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

Added in version 2.0.5$nbsp;(Plugin).

void BrickletThermalImaging.setFFCShutterMode(int shutterMode, int tempLockoutState, boolean videoFreezeDuringFFC, boolean ffcDesired, long elapsedTimeSinceLastFFC, long desiredFFCPeriod, boolean explicitCmdToOpen, int desiredFFCTempDelta, int imminentDelay)
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: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • desiredFFCPeriod – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 300000
  • explicitCmdToOpen – Type: boolean, Default: false
  • desiredFFCTempDelta – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 300
  • imminentDelay – Type: int, Range: [0 to 216 - 1], Default: 52

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

  • BrickletThermalImaging.SHUTTER_MODE_MANUAL = 0

  • BrickletThermalImaging.SHUTTER_MODE_AUTO = 1

  • BrickletThermalImaging.SHUTTER_MODE_EXTERNAL = 2

For tempLockoutState:

  • BrickletThermalImaging.SHUTTER_LOCKOUT_INACTIVE = 0

  • BrickletThermalImaging.SHUTTER_LOCKOUT_HIGH = 1

  • BrickletThermalImaging.SHUTTER_LOCKOUT_LOW = 2

Added in version 2.0.6$nbsp;(Plugin).

BrickletThermalImaging.FFCShutterMode BrickletThermalImaging.getFFCShutterMode()
Return Object:
  • 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: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • desiredFFCPeriod – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 300000
  • explicitCmdToOpen – Type: boolean, Default: false
  • desiredFFCTempDelta – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 300
  • imminentDelay – Type: int, Range: [0 to 216 - 1], Default: 52

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

  • BrickletThermalImaging.SHUTTER_MODE_MANUAL = 0

  • BrickletThermalImaging.SHUTTER_MODE_AUTO = 1

  • BrickletThermalImaging.SHUTTER_MODE_EXTERNAL = 2

For tempLockoutState:

  • BrickletThermalImaging.SHUTTER_LOCKOUT_INACTIVE = 0

  • BrickletThermalImaging.SHUTTER_LOCKOUT_HIGH = 1

  • BrickletThermalImaging.SHUTTER_LOCKOUT_LOW = 2

Added in version 2.0.6$nbsp;(Plugin).

void BrickletThermalImaging.runFFCNormalization()

Starts the Flat-Field Correction (FFC) normalization.

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

Added in version 2.0.6$nbsp;(Plugin).

BrickletThermalImaging.SPITFPErrorCount BrickletThermalImaging.getSPITFPErrorCount()
Return Object:
  • errorCountAckChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: long, Range: [0 to 232 - 1]

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.

void BrickletThermalImaging.setStatusLEDConfig(int config)
Parameters:
  • config – Type: int, Range: See constants, Default: 3

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

int BrickletThermalImaging.getStatusLEDConfig()
Returns:
  • config – Type: int, Range: See constants, Default: 3

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

int BrickletThermalImaging.getChipTemperature()
Returns:
  • temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

void BrickletThermalImaging.reset()

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.Identity BrickletThermalImaging.getIdentity()
Return Object:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: short[], Length: 3
    • 1: major – Type: short, Range: [0 to 255]
    • 2: minor – Type: short, Range: [0 to 255]
    • 3: revision – Type: short, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3
    • 1: major – Type: short, Range: [0 to 255]
    • 2: minor – Type: short, Range: [0 to 255]
    • 3: revision – Type: short, Range: [0 to 255]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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

void BrickletThermalImaging.setImageTransferConfig(int config)
Parameters:
  • config – Type: int, Range: See constants, Default: 0

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:

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

int BrickletThermalImaging.getImageTransferConfig()
Returns:
  • config – Type: int, Range: See constants, Default: 0

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 "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields 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.

callback BrickletThermalImaging.HighContrastImageCallback
Event Object:
  • 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.

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addHighContrastImageCallback() function. An added callback function can be removed with the removeHighContrastImageCallback() function.

callback BrickletThermalImaging.TemperatureImageCallback
Event Object:
  • image – Type: int[], Length: 4800, Unit: ? K, Range: [0 to 216 - 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.

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addTemperatureImageCallback() function. An added callback function can be removed with the removeTemperatureImageCallback() function.

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.

short[] BrickletThermalImaging.getAPIVersion()
Return Object:
  • apiVersion – Type: short[], Length: 3
    • 1: major – Type: short, Range: [0 to 255]
    • 2: minor – Type: short, Range: [0 to 255]
    • 3: revision – Type: short, 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.

boolean BrickletThermalImaging.getResponseExpected(byte functionId)
Parameters:
  • functionId – Type: byte, 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 functionId:

  • 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

void BrickletThermalImaging.setResponseExpected(byte functionId, boolean responseExpected)
Parameters:
  • functionId – Type: byte, Range: See constants
  • responseExpected – Type: 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.

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

  • 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

void BrickletThermalImaging.setResponseExpectedAll(boolean responseExpected)
Parameters:
  • responseExpected – Type: boolean

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.

int BrickletThermalImaging.setBootloaderMode(int mode)
Parameters:
  • mode – Type: int, Range: See constants
Returns:
  • status – Type: int, Range: See constants

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

int BrickletThermalImaging.getBootloaderMode()
Returns:
  • mode – Type: int, Range: See constants

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

void BrickletThermalImaging.setWriteFirmwarePointer(long pointer)
Parameters:
  • pointer – Type: long, Unit: 1 B, Range: [0 to 232 - 1]

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.

int BrickletThermalImaging.writeFirmware(int[] data)
Parameters:
  • data – Type: int[], Length: 64, Range: [0 to 255]
Returns:
  • status – Type: int, Range: [0 to 255]

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.

void BrickletThermalImaging.writeUID(long uid)
Parameters:
  • uid – Type: long, Range: [0 to 232 - 1]

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.

long BrickletThermalImaging.readUID()
Returns:
  • uid – Type: long, Range: [0 to 232 - 1]

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

Constants

int BrickletThermalImaging.DEVICE_IDENTIFIER

This constant is used to identify a Thermal Imaging Bricklet.

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

String BrickletThermalImaging.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Thermal Imaging Bricklet.