Python - Thermal Imaging Bricklet¶

Callback¶

Download (example_callback.py)

 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

#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Thermal Imaging Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_thermal_imaging import BrickletThermalImaging

# Callback function for high contrast image callback
def cb_high_contrast_image(image):
    # image is an tuple of size 80*60 with a 8 bit grey value for each element
    pass

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    ti = BrickletThermalImaging(UID, ipcon) # Create device object

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

    # Register high contrast image callback to function cb_high_contrast_image
    ti.register_callback(ti.CALLBACK_HIGH_CONTRAST_IMAGE, cb_high_contrast_image)

    # Enable high contrast image transfer for callback
    ti.set_image_transfer_config(ti.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Opencv High Contrast¶

Download (example_opencv_high_contrast.py)

 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

#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Thermal Imaging Bricklet

import cv2
import numpy

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_thermal_imaging import BrickletThermalImaging

# Callback function for high contrast image callback
def cb_high_contrast_image(image):
    # image is an tuple of size 80*60 with a 8 bit grey value for each element
    reshaped_image = numpy.array(image, dtype=numpy.uint8).reshape(60, 80)

    # scale image 8x
    resized_image = cv2.resize(reshaped_image, (640, 480), interpolation=cv2.INTER_CUBIC)

    cv2.imshow('High Contrast Image', resized_image)
    cv2.waitKey(1)

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    ti = BrickletThermalImaging(UID, ipcon) # Create device object

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

    # Register high contrast image callback to function cb_high_contrast_image
    ti.register_callback(ti.CALLBACK_HIGH_CONTRAST_IMAGE, cb_high_contrast_image)

    # Enable high contrast image transfer for callback
    ti.set_image_transfer_config(ti.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()
    cv2.destroyAllWindows()

Opencv Temperature¶

Download (example_opencv_temperature.py)

 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

#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Thermal Imaging Bricklet

import cv2
import numpy

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_thermal_imaging import BrickletThermalImaging

# Callback function for temperature image callback
def cb_temperature_image(image):
    # image is an tuple of size 80*60 with a 16 bit grey value for each element
    reshaped_image = numpy.array(image, dtype=numpy.uint16).reshape(60, 80)

    # scale image 8x
    resized_image = cv2.resize(reshaped_image, (640, 480), interpolation=cv2.INTER_CUBIC)

    cv2.imshow('Temperature Image', resized_image)
    cv2.waitKey(1)

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    ti = BrickletThermalImaging(UID, ipcon) # Create device object

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

    # Register temperature image callback to function cb_temperature_image
    ti.register_callback(ti.CALLBACK_TEMPERATURE_IMAGE, cb_temperature_image)

    # Enable temperature image transfer for callback
    ti.set_image_transfer_config(ti.IMAGE_TRANSFER_CALLBACK_TEMPERATURE_IMAGE)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()
    cv2.destroyAllWindows()

Thermal Imaging To Lcd¶

Download (example_thermal_imaging_to_lcd.py)

 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

#!/usr/bin/env python
# -*- coding: utf-8 -*-

# Draws thermal image of Thermal Imaging Bricklet to LCD 128x64 Bricklet.
#
# You can find a video of this running on a HAT Brick here:
# https://www.tinkerforge.com/en/doc/Hardware/Bricks/HAT_Brick.html#description

HOST = "localhost"
PORT = 4223
UID_TI  = "ABC"  # Change ABC to the UID of your Thermal Imaging Bricklet
UID_LCD = "DEF"  # Change DEF to the UID of your LCD 128x64 Bricklet
LCD_WIDTH  = 128 # Columns LCD
LCD_HEIGHT = 64  # Rows LCD
TI_WIDTH   = 80  # Columns Thermal Image
TI_HEIGHT  = 60  # Rows Thermal Image
THRESHOLD  = 100 # Thermal threshold value

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_thermal_imaging import BrickletThermalImaging
from tinkerforge.bricklet_lcd_128x64 import BrickletLCD128x64

# Callback function for high contrast image callback
def cb_high_contrast_image(lcd, image):
    # Convert 8 bit thermal image into 1 bit image for LCD 128x64
    image_bw = []
    for x in image:
        image_bw.append(x > THRESHOLD)

    # Draw 1 bit image to to center of LCD 128x64
    lcd.write_pixels(24, 2, TI_WIDTH+24-1, TI_HEIGHT+2-1, image_bw)

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection

    # Create device objects
    ti = BrickletThermalImaging(UID_TI, ipcon)
    lcd = BrickletLCD128x64(UID_LCD, ipcon)

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

    # Clear image
    lcd.clear_display()

    # Register high contrast image callback to function cb_high_contrast_image
    ti.register_callback(ti.CALLBACK_HIGH_CONTRAST_IMAGE, lambda x: cb_high_contrast_image(lcd, x))

    # Enable high contrast image transfer for callback
    ti.set_image_transfer_config(ti.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Create Image¶

Download (example_create_image.py)

 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

#!/usr/bin/env python
# -*- coding: utf-8 -*-

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

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Thermal Imaging Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_thermal_imaging import BrickletThermalImaging

import time
import math
from PIL import Image

# Creates standard thermal image color palette (blue=cold, red=hot)
def get_thermal_image_color_palette():
    palette = []

    #The palette is gnuplot's PM3D palette.
    #See here for details: https://stackoverflow.com/questions/28495390/thermal-imaging-palette
    for x in range(256):
        x /= 255.0
        palette.append(int(round(255*math.sqrt(x))))                  # RED
        palette.append(int(round(255*pow(x, 3))))                     # GREEN
        if math.sin(2 * math.pi * x) >= 0:
            palette.append(int(round(255*math.sin(2 * math.pi * x)))) # BLUE
        else:
            palette.append(0)

    return palette

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    ti = 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 getter
    ti.set_image_transfer_config(ti.IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE)

    # 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 get_high_contrast_image any time.
    time.sleep(0.5)

    # Get image data
    image_data = ti.get_high_contrast_image()

    # Make PNG with PIL
    image = Image.new('P', (80, 60))
    image.putdata(image_data)

    # This puts a color palette into place, if you 
    # remove this line you will get a greyscale image.
    image.putpalette(get_thermal_image_color_palette())

    # Scale to 800x600 and save thermal image!
    image.resize((80*10, 60*10), Image.ANTIALIAS).save('thermal_image.png')

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Live Video¶

Download (example_live_video.py)

  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

#!/usr/bin/env python
# -*- coding: utf-8 -*-

#
# Shows live thermal image video in Tk window
#

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Thermal Imaging Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_thermal_imaging import BrickletThermalImaging

import math
import time
try:
    from Tkinter import Tk, Canvas, PhotoImage, mainloop, Label # Python 2
    from Queue import Queue, Empty
except:
    from tkinter import Tk, Canvas, PhotoImage, mainloop, Label # Python 3
    from queue import Queue, Empty

from PIL import Image, ImageTk

WIDTH  = 80
HEIGHT = 60
SCALE  = 5 # Use scale 5 for 400x300 window size (change for different size). Use scale -1 for maximized mode

image_queue = Queue()

# Creates standard thermal image color palette (blue=cold, red=hot)
def get_thermal_image_color_palette():
    palette = []

    #The palette is gnuplot's PM3D palette.
    #See here for details: https://stackoverflow.com/questions/28495390/thermal-imaging-palette
    for x in range(256):
        x /= 255.0
        palette.append(int(round(255*math.sqrt(x))))                  # RED
        palette.append(int(round(255*pow(x, 3))))                     # GREEN
        if math.sin(2 * math.pi * x) >= 0:
            palette.append(int(round(255*math.sin(2 * math.pi * x)))) # BLUE
        else:
            palette.append(0)

    return palette

# Callback function for high contrast image
def cb_high_contrast_image(image):
    # Save image to queue (for loop below)
    global image_queue
    image_queue.put(image)

def on_closing(window, exit_queue):
    exit_queue.put(True)
    

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    ti = BrickletThermalImaging(UID, ipcon) # Create device object

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

    # Register illuminance callback to function cb_high_contrast_image
    ti.register_callback(ti.CALLBACK_HIGH_CONTRAST_IMAGE, cb_high_contrast_image)

    # Enable high contrast image transfer for callback
    ti.set_image_transfer_config(ti.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE)
    
    # Create Tk window and label
    window = Tk()
    
    # Run maximized
    if SCALE == -1:        
        window.geometry("%dx%d+0+0" % (window.winfo_screenwidth(), window.winfo_screenheight()))
        window.update() # Update to resize the window
        
        w, h = window.winfo_width(), window.winfo_height()
        SCALE = min(w // WIDTH, h // HEIGHT)

    label = Label(window)
    label.pack()

    image = Image.new('P', (WIDTH, HEIGHT))
    # This puts a color palette into place, if you 
    # remove this line you will get a greyscale image.
    image.putpalette(get_thermal_image_color_palette())
    
    exit_queue = Queue()
    window.protocol("WM_DELETE_WINDOW", lambda: on_closing(window, exit_queue))

    while True:        
        try:
            exit_queue.get_nowait()
            break # If the exit_queue is not empty, the window was closed.
        except Empty:
            pass
        
        # Get image from queue (blocks as long as no data available)
        image_data = image_queue.get(True)

        # Use original width/height to put data and resize again afterwards
        image = image.resize((WIDTH, HEIGHT))
        image.putdata(image_data)
        image = image.resize((WIDTH*SCALE, HEIGHT*SCALE), Image.ANTIALIAS)

        # Translate PIL Image to Tk PhotoImageShow and show as label
        photo_image = ImageTk.PhotoImage(image)
        label.configure(image=photo_image)
        
        window.update()
        
    window.destroy()

Basic Functions¶

BrickletThermalImaging(uid, ipcon)¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	thermal_imaging – Type: BrickletThermalImaging

Creates an object with the unique device ID uid:

thermal_imaging = BrickletThermalImaging("YOUR_DEVICE_UID", ipcon)

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

BrickletThermalImaging.get_high_contrast_image()¶

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

BrickletThermalImaging.get_temperature_image()¶

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

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

BrickletThermalImaging.get_statistics()¶

Return Object:

spotmeter_statistics – Type: [int, ...], Length: 4 0: mean_temperature – Type: int, Unit: ? K, Range: [0 to 216 - 1] 1: max_temperature – Type: int, Unit: ? K, Range: [0 to 216 - 1] 2: min_temperature – Type: int, Unit: ? K, Range: [0 to 216 - 1] 3: pixel_count – Type: int, Range: [0 to 4800] temperatures – Type: [int, ...], Length: 4 0: focal_plain_array – Type: int, Unit: ? K, Range: [0 to 216 - 1] 1: focal_plain_array_last_ffc – Type: int, Unit: ? K, Range: [0 to 216 - 1] 2: housing – Type: int, Unit: ? K, Range: [0 to 216 - 1] 3: housing_last_ffc – Type: int, Unit: ? K, Range: [0 to 216 - 1] resolution – Type: int, Range: See constants ffc_status – Type: int, Range: See constants temperature_warning – Type: [bool, ...], Length: 2 0: shutter_lockout – Type: bool 1: overtemperature_shut_down_imminent – Type: bool

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.set_resolution(resolution)¶

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

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

Returns:	resolution – Type: int, Range: See constants

Returns the resolution as set by set_resolution().

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.set_spotmeter_config(region_of_interest)¶

Parameters:	region_of_interest – Type: [int, ...], Length: 4 0: first_column – Type: int, Range: [0 to 78], Default: 39 1: first_row – Type: int, Range: [0 to 58], Default: 29 2: last_column – Type: int, Range: [1 to 79], Default: 40 3: last_row – Type: int, Range: [1 to 59], Default: 30
Returns:	None

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

BrickletThermalImaging.get_spotmeter_config()¶

Return Object:	region_of_interest – Type: [int, ...], Length: 4 0: first_column – Type: int, Range: [0 to 78], Default: 39 1: first_row – Type: int, Range: [0 to 58], Default: 29 2: last_column – Type: int, Range: [1 to 79], Default: 40 3: last_row – Type: int, Range: [1 to 59], Default: 30

Returns the spotmeter config as set by set_spotmeter_config().

BrickletThermalImaging.set_high_contrast_config(region_of_interest, dampening_factor, clip_limit, empty_counts)¶

Parameters:

region_of_interest – Type: [int, ...], Length: 4 0: first_column – Type: int, Range: [0 to 79], Default: 0 1: first_row – Type: int, Range: [0 to 58], Default: 0 2: last_column – Type: int, Range: [0 to 79], Default: 79 3: last_row – Type: int, Range: [1 to 59], Default: 59 dampening_factor – Type: int, Range: [0 to 256], Default: 64 clip_limit – Type: [int, ...], Length: 2 0: agc_heq_clip_limit_high – Type: int, Range: [0 to 4800], Default: 4800 1: agc_heq_clip_limit_low – Type: int, Range: [0 to 210], Default: 29 empty_counts – Type: int, Range: [0 to 214 - 1], Default: 2

Returns:

None

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

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

Return Object:

region_of_interest – Type: [int, ...], Length: 4 0: first_column – Type: int, Range: [0 to 78], Default: 0 1: first_row – Type: int, Range: [0 to 58], Default: 0 2: last_column – Type: int, Range: [1 to 79], Default: 79 3: last_row – Type: int, Range: [1 to 59], Default: 59 dampening_factor – Type: int, Range: [0 to 256], Default: 64 clip_limit – Type: [int, ...], Length: 2 0: agc_heq_clip_limit_high – Type: int, Range: [0 to 4800], Default: 4800 1: agc_heq_clip_limit_low – Type: int, Range: [0 to 210], Default: 29 empty_counts – Type: int, Range: [0 to 216 - 1], Default: 2

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

Advanced Functions¶

BrickletThermalImaging.set_flux_linear_parameters(scene_emissivity, temperature_background, tau_window, temperatur_window, tau_atmosphere, temperature_atmosphere, reflection_window, temperature_reflection)¶

Parameters:

scene_emissivity – Type: int, Unit: 25/2048 %, Range: [82 to 213], Default: 213 temperature_background – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515 tau_window – Type: int, Unit: 25/2048 %, Range: [82 to 213], Default: 213 temperatur_window – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515 tau_atmosphere – Type: int, Unit: 25/2048 %, Range: [82 to 213], Default: 213 temperature_atmosphere – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515 reflection_window – Type: int, Unit: 25/2048 %, Range: [0 to 213], Default: 0 temperature_reflection – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515

Returns:

None

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

Return Object:

scene_emissivity – Type: int, Unit: 25/2048 %, Range: [82 to 213], Default: 213 temperature_background – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515 tau_window – Type: int, Unit: 25/2048 %, Range: [82 to 213], Default: 213 temperatur_window – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515 tau_atmosphere – Type: int, Unit: 25/2048 %, Range: [82 to 213], Default: 213 temperature_atmosphere – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515 reflection_window – Type: int, Unit: 25/2048 %, Range: [0 to 213], Default: 0 temperature_reflection – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515

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

New in version 2.0.5 (Plugin).

BrickletThermalImaging.set_ffc_shutter_mode(shutter_mode, temp_lockout_state, video_freeze_during_ffc, ffc_desired, elapsed_time_since_last_ffc, desired_ffc_period, explicit_cmd_to_open, desired_ffc_temp_delta, imminent_delay)¶

Parameters:

shutter_mode – Type: int, Range: See constants, Default: 1 temp_lockout_state – Type: int, Range: See constants, Default: 0 video_freeze_during_ffc – Type: bool, Default: True ffc_desired – Type: bool, Default: False elapsed_time_since_last_ffc – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 desired_ffc_period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 300000 explicit_cmd_to_open – Type: bool, Default: False desired_ffc_temp_delta – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 300 imminent_delay – Type: int, Range: [0 to 216 - 1], Default: 52

Returns:

None

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

Return Object:

shutter_mode – Type: int, Range: See constants, Default: 1 temp_lockout_state – Type: int, Range: See constants, Default: 0 video_freeze_during_ffc – Type: bool, Default: True ffc_desired – Type: bool, Default: False elapsed_time_since_last_ffc – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 desired_ffc_period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 300000 explicit_cmd_to_open – Type: bool, Default: False desired_ffc_temp_delta – Type: int, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 300 imminent_delay – 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 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.run_ffc_normalization()¶

Returns:	None

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

Return Object:	error_count_ack_checksum – Type: int, Range: [0 to 232 - 1] error_count_message_checksum – Type: int, Range: [0 to 232 - 1] error_count_frame – Type: int, Range: [0 to 232 - 1] error_count_overflow – Type: int, 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.

BrickletThermalImaging.set_status_led_config(config)¶

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

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

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

Returns the configuration as set by set_status_led_config()

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

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.

BrickletThermalImaging.reset()¶

Returns:	None

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

Return Object:

uid – Type: str, Length: up to 8 connected_uid – Type: str, Length: up to 8 position – Type: chr, Range: ["a" to "h", "z"] hardware_version – 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] firmware_version – 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] device_identifier – 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¶

BrickletThermalImaging.register_callback(callback_id, function)¶

Parameters:	callback_id – Type: int function – Type: callable
Returns:	None

Registers the given function with the given callback_id.

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

BrickletThermalImaging.set_image_transfer_config(config)¶

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

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: get_high_contrast_image().
• Manual Temperature Image: get_temperature_image().
• 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.get_image_transfer_config()¶

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

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

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 register_callback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

def my_callback(param):
    print(param)

thermal_imaging.register_callback(BrickletThermalImaging.CALLBACK_EXAMPLE, my_callback)

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

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

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 None for image.

BrickletThermalImaging.CALLBACK_TEMPERATURE_IMAGE¶

Callback Parameters:	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 set_image_transfer_config()).

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

Note

If reconstructing the value fails, the callback is triggered with None 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.get_api_version()¶

Return Object:	api_version – 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.get_response_expected(function_id)¶

Parameters:	function_id – Type: int, Range: See constants
Returns:	response_expected – Type: bool

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 set_response_expected(). 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.set_response_expected(function_id, response_expected)¶

Parameters:	function_id – Type: int, Range: See constants response_expected – Type: bool
Returns:	None

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 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.set_response_expected_all(response_expected)¶

Parameters:	response_expected – Type: bool
Returns:	None

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

BrickletThermalImaging.get_bootloader_mode()¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see set_bootloader_mode().

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.set_write_firmware_pointer(pointer)¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]
Returns:	None

Sets the firmware pointer for write_firmware(). 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.write_firmware(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 set_write_firmware_pointer() 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.write_uid(uid)¶

Parameters:	uid – Type: int, Range: [0 to 232 - 1]
Returns:	None

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

Returns:	uid – Type: int, Range: [0 to 232 - 1]

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