Java - Thermal Imaging Bricklet

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

Examples

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

Callback

Download (ExampleCallback.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletThermalImaging;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Thermal Imaging Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletThermalImaging ti = new BrickletThermalImaging(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Add high contrast image listener
        ti.addHighContrastImageListener(new BrickletThermalImaging.HighContrastImageListener() {
            public void highContrastImage(int[] image) {
                // image is an array of size 80*60 with a 8 bit grey value for each element
            }
        });

        // Enable high contrast image transfer for callback
        ti.setImageTransferConfig(BrickletThermalImaging.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Create Image

Download (ExampleCreateImage.java)

 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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
import com.tinkerforge.BrickletThermalImaging;
import com.tinkerforge.IPConnection;

import java.awt.image.BufferedImage;
import javax.imageio.ImageIO;
import java.io.File;
import java.awt.Image;
import java.awt.image.Raster;
import java.awt.image.WritableRaster;
import java.awt.image.DataBuffer;
import java.awt.image.DataBufferInt;
import java.awt.Graphics2D;
import java.lang.Math;

//
// Takes one thermal image and saves it as PNG
//

public class ExampleCreateImage {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;
    private static final String UID = "XYZ"; // Change to your UID

    // Creates standard thermal image color palette (blue=cold, red=hot)
    private static int[] paletteR = new int[256];
    private static int[] paletteG = new int[256];
    private static int[] paletteB = new int[256];
    public static void createThermalImageColorPalette()
    {
        for(int x = 0; x < 256; x++)
        {
            paletteR[x] = (int)(255*Math.sqrt(x/255.0));
            paletteG[x] = (int)(255*Math.pow(x/255.0, 3));
            if(Math.sin(2*Math.PI * (x/255.0)) >= 0.0) 
            {
                paletteB[x] = (int)(255*Math.sin(2*Math.PI * (x/255.0)));
            } else 
            {
                paletteB[x] = 0;
            }
        }
    }

    // Helper function for simple buffer resize
    public static BufferedImage resize(BufferedImage img, int newW, int newH) { 
        Image tmp = img.getScaledInstance(newW, newH, Image.SCALE_SMOOTH);
        BufferedImage dimg = new BufferedImage(newW, newH, BufferedImage.TYPE_INT_ARGB);

        Graphics2D g2d = dimg.createGraphics();
        g2d.drawImage(tmp, 0, 0, null);
        g2d.dispose();

        return dimg;
    }  

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions you
    //       might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletThermalImaging ti = new BrickletThermalImaging(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Enable high contrast image transfer for manual getter 
        ti.setImageTransferConfig(BrickletThermalImaging.IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE);

        createThermalImageColorPalette();

        // If we change between transfer modes we have to wait until one more 
        // image is taken after the mode is set and the first image is saved 
        // we can call GetHighContrastImage any time.
        Thread.sleep(250);

        int[] image = ti.getHighContrastImage();

        // Use palette mapping to create thermal image coloring 
        for(int i = 0; i < 80*60; i++) {
            image[i] = (255 << 24) | (paletteR[image[i]] << 16) | (paletteG[image[i]] << 8) | (paletteB[image[i]] << 0);
        }

        // Create BufferedImage with data
        DataBuffer buffer = new DataBufferInt(image, image.length);
        BufferedImage bufferedImage = new BufferedImage(80, 60, BufferedImage.TYPE_INT_ARGB);
        bufferedImage.setRGB(0, 0, 80, 60, image, 0, 80);

        // Scale to 800x600 and save thermal image!
        ImageIO.write(resize(bufferedImage, 80*10, 60*10), "png", new File("thermal_image.png"));

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Live Video

Download (ExampleLiveVideo.java)

  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
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
import com.tinkerforge.BrickletThermalImaging;
import com.tinkerforge.IPConnection;

import java.awt.image.BufferedImage;
import javax.imageio.ImageIO;
import java.io.File;
import java.awt.Image;
import java.awt.image.Raster;
import java.awt.image.WritableRaster;
import java.awt.image.DataBuffer;
import java.awt.image.DataBufferInt;
import java.awt.Graphics2D;
import java.lang.Math;

import java.awt.Container;
import java.awt.EventQueue;
import javax.swing.GroupLayout;
import javax.swing.ImageIcon;
import javax.swing.JFrame;
import javax.swing.JLabel;

//
// Shows live thermal image video in in swing label
//

public class ExampleLiveVideo extends JFrame  {
    static final long serialVersionUID = 42L;

    private static final String HOST = "localhost";
    private static final int PORT = 4223;
    private static final String UID = "XYZ"; // Change to your UID

    private static final int WIDTH = 80;
    private static final int HEIGHT = 60;
    private static final int SCALE = 5;

    // Creates standard thermal image color palette (blue=cold, red=hot)
    private static int[] paletteR = new int[256];
    private static int[] paletteG = new int[256];
    private static int[] paletteB = new int[256];
    public static void createThermalImageColorPalette()
    {
        for(int x = 0; x < 256; x++)
        {
            paletteR[x] = (int)(255*Math.sqrt(x/255.0));
            paletteG[x] = (int)(255*Math.pow(x/255.0, 3));
            if(Math.sin(2*Math.PI * (x/255.0)) >= 0.0) 
            {
                paletteB[x] = (int)(255*Math.sin(2*Math.PI * (x/255.0)));
            } else 
            {
                paletteB[x] = 0;
            }
        }
    }

    // Helper function for simple buffer resize
    public static BufferedImage resize(BufferedImage img, int newW, int newH) { 
        Image tmp = img.getScaledInstance(newW, newH, Image.SCALE_SMOOTH);
        BufferedImage dimg = new BufferedImage(newW, newH, BufferedImage.TYPE_INT_ARGB);

        Graphics2D g2d = dimg.createGraphics();
        g2d.drawImage(tmp, 0, 0, null);
        g2d.dispose();

        return dimg;
    }  

    public ExampleLiveVideo() {
        try {
            IPConnection ipcon = new IPConnection(); // Create IP connection
            BrickletThermalImaging ti = new BrickletThermalImaging(UID, ipcon); // Create device object

            ipcon.connect(HOST, PORT); // Connect to brickd
            // Don't use device before ipcon is connected

            // Enable high contrast image transfer for manual getter 
            ti.setImageTransferConfig(BrickletThermalImaging.IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE);

            createThermalImageColorPalette();

            // Create label and layout with empty Icon in it, so the window automatically resizes correctly
            setDefaultCloseOperation(EXIT_ON_CLOSE);
            JLabel label = new JLabel(new ImageIcon(resize(new BufferedImage(WIDTH, HEIGHT, BufferedImage.TYPE_INT_ARGB), WIDTH*SCALE, HEIGHT*SCALE)));
            GroupLayout gl = new GroupLayout(getContentPane());
            getContentPane().setLayout(gl);
            gl.setAutoCreateContainerGaps(true);
            gl.setHorizontalGroup(gl.createSequentialGroup().addComponent(label));
            gl.setVerticalGroup(gl.createParallelGroup().addComponent(label));
            pack();

            // Enable high contrast image transfer for callback
            ti.setImageTransferConfig(BrickletThermalImaging.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE);

            // Add and implement high contrast image listener
            ti.addHighContrastImageListener(new BrickletThermalImaging.HighContrastImageListener() {
                public void highContrastImage(int[] image) {
                    // Use palette mapping to create thermal image coloring 
                    for(int i = 0; i < WIDTH*HEIGHT; i++) {
                        image[i] = (255 << 24) | (paletteR[image[i]] << 16) | (paletteG[image[i]] << 8) | (paletteB[image[i]] << 0);
                    }

                    // Create BufferedImage with data
                    DataBuffer buffer = new DataBufferInt(image, image.length);
                    BufferedImage bufferedImage = new BufferedImage(WIDTH, HEIGHT, BufferedImage.TYPE_INT_ARGB);
                    bufferedImage.setRGB(0, 0, WIDTH, HEIGHT, image, 0, WIDTH);

                    // Set resized buffered image as icon of label
                    // change SCALE to change the size of the video
                    label.setIcon(new ImageIcon(resize(bufferedImage, WIDTH*SCALE, HEIGHT*SCALE)));
                }
            });
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
    }

    public static void main(String args[]) throws Exception {
        EventQueue.invokeLater(() -> {
            ExampleLiveVideo elv = new ExampleLiveVideo();
            elv.setVisible(true);
        });
    }
}

API

Generally, every method of the Java 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 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:

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

This object can then be used after the IP Connection is connected (see examples above).

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: [-1000 to 1400]

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
    • 0: meanTemperature – Type: int, Unit: ? K, Range: [0 to 216 - 1]
    • 1: maxTemperature – Type: int, Unit: ? K, Range: [0 to 216 - 1]
    • 2: minTemperature – Type: int, Unit: ? K, Range: [0 to 216 - 1]
    • 3: pixelCount – Type: int, Range: [0 to 4800]
  • temperatures – Type: int[], Length: 4
    • 0: focalPlainArray – Type: int, Unit: ? K, Range: [0 to 216 - 1]
    • 1: focalPlainArrayLastFFC – Type: int, Unit: ? K, Range: [0 to 216 - 1]
    • 2: housing – Type: int, Unit: ? K, Range: [0 to 216 - 1]
    • 3: 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
    • 0: shutterLockout – Type: boolean
    • 1: 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
    • 0: firstColumn – Type: int, Range: [0 to 79], Default: 39
    • 1: firstRow – Type: int, Range: [0 to 59], Default: 29
    • 2: lastColumn – Type: int, Range: [1 to 80], Default: 40
    • 3: lastRow – Type: int, Range: [1 to 60], Default: 30

Sets the spotmeter region of interest. The 4 values are

  • Index 0: Column start (has to be smaller then Column end).
  • Index 1: Row start (has to be smaller then Row end).
  • Index 2: Column end (has to be smaller then 80).
  • Index 3: Row end (has to be smaller then 60).

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

int[] BrickletThermalImaging.getSpotmeterConfig()
Return Object:
  • 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 the spotmeter config as set by setSpotmeterConfig().

void BrickletThermalImaging.setHighContrastConfig(int[] regionOfInterest, int dampeningFactor, int[] clipLimit, int emptyCounts)
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 1024], Default: 512
  • emptyCounts – Type: int, Range: [0 to 216 - 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 or equal then Column end).
  • Index 1: Row start (has to be smaller then Row end).
  • Index 2: Column end (has to be smaller then 80).
  • Index 3: Row end (has to be smaller then 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
    • 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 1024], Default: 512
  • emptyCounts – Type: int, Range: [0 to 216 - 1], Default: 2

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

Advanced Functions

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.

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

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.

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', 'i', '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 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

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

Listener 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/listener 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

Listeners

Listeners can be registered to receive time critical or recurring data from the device. The registration is done with add*Listener() functions of the device object.

The parameter is a listener class object, for example:

device.addExampleListener(new BrickletThermalImaging.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

The available listener classes with inherent methods to be overwritten are described below. It is possible to add several listeners and to remove them with the corresponding remove*Listener() function.

Note

Using listeners 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.

class BrickletThermalImaging.HighContrastImageListener()

This listener can be added with the addHighContrastImageListener() function. An added listener can be removed with the removeHighContrastImageListener() function.

void highContrastImage(int[] image)
Parameters:
  • image – Type: int[], Length: 4800, Range: [0 to 255]

This listener is triggered with every new high contrast image if the transfer image config is configured for high contrast listener (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 listener is triggered with null for image.

class BrickletThermalImaging.TemperatureImageListener()

This listener can be added with the addTemperatureImageListener() function. An added listener can be removed with the removeTemperatureImageListener() function.

void temperatureImage(int[] image)
Parameters:
  • image – Type: int[], Length: 4800, Unit: ? K, Range: [-1000 to 1400]

This listener is triggered with every new temperature image if the transfer image config is configured for temperature listener (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 listener 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.

int[] BrickletThermalImaging.getAPIVersion()
Return Object:
  • 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.

boolean BrickletThermalImaging.getResponseExpected(int functionId)
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 listener 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.

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_WRITE_FIRMWARE_POINTER = 237
  • BrickletThermalImaging.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletThermalImaging.FUNCTION_RESET = 243
  • BrickletThermalImaging.FUNCTION_WRITE_UID = 248
void BrickletThermalImaging.setResponseExpected(int functionId, boolean responseExpected)
Parameters:
  • functionId – Type: int, 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 listener 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 send 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_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 listener configuration functions of this device at once.

Constants

int BrickletThermalImaging.DEVICE_IDENTIFIER

This constant is used to identify a Thermal Imaging Bricklet.

The getIdentity() function and the IPConnection.EnumerateListener listener 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.