tinkerforge 2.1.14 → 2.1.15

data/lib/tinkerforge/bricklet_rotary_encoder.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-07-27.      #
+# This file was automatically generated on 2017-11-20.      #
 #                                                           #
-# Ruby Bindings Version 2.1.14                              #
+# Ruby Bindings Version 2.1.15                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #

data/lib/tinkerforge/bricklet_rotary_poti.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-07-27.      #
+# This file was automatically generated on 2017-11-20.      #
 #                                                           #
-# Ruby Bindings Version 2.1.14                              #
+# Ruby Bindings Version 2.1.15                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #

data/lib/tinkerforge/bricklet_rs232.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-07-27.      #
+# This file was automatically generated on 2017-11-20.      #
 #                                                           #
-# Ruby Bindings Version 2.1.14                              #
+# Ruby Bindings Version 2.1.15                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #

data/lib/tinkerforge/bricklet_rs485.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-07-27.      #
+# This file was automatically generated on 2017-11-20.      #
 #                                                           #
-# Ruby Bindings Version 2.1.14                              #
+# Ruby Bindings Version 2.1.15                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
@@ -949,7 +949,7 @@ module Tinkerforge
       send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 1, 'C'
     end
 
-    # Sets the firmware pointer for func:`WriteFirmware`. The pointer has
+    # Sets the firmware pointer for BrickletRS485#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).
     # 

data/lib/tinkerforge/bricklet_segment_display_4x7.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-07-27.      #
+# This file was automatically generated on 2017-11-20.      #
 #                                                           #
-# Ruby Bindings Version 2.1.14                              #
+# Ruby Bindings Version 2.1.15                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #

data/lib/tinkerforge/bricklet_solid_state_relay.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-07-27.      #
+# This file was automatically generated on 2017-11-20.      #
 #                                                           #
-# Ruby Bindings Version 2.1.14                              #
+# Ruby Bindings Version 2.1.15                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #

data/lib/tinkerforge/bricklet_sound_intensity.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-07-27.      #
+# This file was automatically generated on 2017-11-20.      #
 #                                                           #
-# Ruby Bindings Version 2.1.14                              #
+# Ruby Bindings Version 2.1.15                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #

data/lib/tinkerforge/bricklet_temperature.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-07-27.      #
+# This file was automatically generated on 2017-11-20.      #
 #                                                           #
-# Ruby Bindings Version 2.1.14                              #
+# Ruby Bindings Version 2.1.15                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #

data/lib/tinkerforge/bricklet_temperature_ir.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-07-27.      #
+# This file was automatically generated on 2017-11-20.      #
 #                                                           #
-# Ruby Bindings Version 2.1.14                              #
+# Ruby Bindings Version 2.1.15                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #

data/lib/tinkerforge/bricklet_thermal_imaging.rb

@@ -0,0 +1,555 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2017-11-20.      #
+#                                                           #
+# Ruby Bindings Version 2.1.15                              #
+#                                                           #
+# If you have a bugfix for this file and want to commit it, #
+# please fix the bug in the generator. You can find a link  #
+# to the generators git repository on tinkerforge.com       #
+#############################################################
+
+module Tinkerforge
+  # 80x60 pixel thermal imaging camera
+  class BrickletThermalImaging < Device
+    DEVICE_IDENTIFIER = 278 # :nodoc:
+    DEVICE_DISPLAY_NAME = 'Thermal Imaging Bricklet' # :nodoc:
+
+    # This callback is triggered with every new high contrast image if the transfer image
+    # config is configured for high contrast callback (see BrickletThermalImaging#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.
+    CALLBACK_HIGH_CONTRAST_IMAGE_LOW_LEVEL = 12
+
+    # This callback is triggered with every new temperature image if the transfer image
+    # config is configured for temperature callback (see BrickletThermalImaging#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 BrickletThermalImaging#set_resolution).
+    CALLBACK_TEMPERATURE_IMAGE_LOW_LEVEL = 13
+
+    # This callback is triggered with every new high contrast image if the transfer image
+    # config is configured for high contrast callback (see BrickletThermalImaging#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.
+    CALLBACK_HIGH_CONTRAST_IMAGE = -12
+
+    # This callback is triggered with every new temperature image if the transfer image
+    # config is configured for temperature callback (see BrickletThermalImaging#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 BrickletThermalImaging#set_resolution).
+    CALLBACK_TEMPERATURE_IMAGE = -13
+
+    FUNCTION_GET_HIGH_CONTRAST_IMAGE_LOW_LEVEL = 1 # :nodoc:
+    FUNCTION_GET_TEMPERATURE_IMAGE_LOW_LEVEL = 2 # :nodoc:
+    FUNCTION_GET_STATISTICS = 3 # :nodoc:
+    FUNCTION_SET_RESOLUTION = 4 # :nodoc:
+    FUNCTION_GET_RESOLUTION = 5 # :nodoc:
+    FUNCTION_SET_SPOTMETER_CONFIG = 6 # :nodoc:
+    FUNCTION_GET_SPOTMETER_CONFIG = 7 # :nodoc:
+    FUNCTION_SET_HIGH_CONTRAST_CONFIG = 8 # :nodoc:
+    FUNCTION_GET_HIGH_CONTRAST_CONFIG = 9 # :nodoc:
+    FUNCTION_SET_IMAGE_TRANSFER_CONFIG = 10 # :nodoc:
+    FUNCTION_GET_IMAGE_TRANSFER_CONFIG = 11 # :nodoc:
+    FUNCTION_GET_SPITFP_ERROR_COUNT = 234 # :nodoc:
+    FUNCTION_SET_BOOTLOADER_MODE = 235 # :nodoc:
+    FUNCTION_GET_BOOTLOADER_MODE = 236 # :nodoc:
+    FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237 # :nodoc:
+    FUNCTION_WRITE_FIRMWARE = 238 # :nodoc:
+    FUNCTION_SET_STATUS_LED_CONFIG = 239 # :nodoc:
+    FUNCTION_GET_STATUS_LED_CONFIG = 240 # :nodoc:
+    FUNCTION_GET_CHIP_TEMPERATURE = 242 # :nodoc:
+    FUNCTION_RESET = 243 # :nodoc:
+    FUNCTION_WRITE_UID = 248 # :nodoc:
+    FUNCTION_READ_UID = 249 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :nodoc:
+
+    RESOLUTION_0_TO_6553_KELVIN = 0 # :nodoc:
+    RESOLUTION_0_TO_655_KELVIN = 1 # :nodoc:
+    FFC_STATUS_NEVER_COMMANDED = 0 # :nodoc:
+    FFC_STATUS_IMMINENT = 1 # :nodoc:
+    FFC_STATUS_IN_PROGRESS = 2 # :nodoc:
+    FFC_STATUS_COMPLETE = 3 # :nodoc:
+    IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE = 0 # :nodoc:
+    IMAGE_TRANSFER_MANUAL_TEMPERATURE_IMAGE = 1 # :nodoc:
+    IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE = 2 # :nodoc:
+    IMAGE_TRANSFER_CALLBACK_TEMPERATURE_IMAGE = 3 # :nodoc:
+    BOOTLOADER_MODE_BOOTLOADER = 0 # :nodoc:
+    BOOTLOADER_MODE_FIRMWARE = 1 # :nodoc:
+    BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2 # :nodoc:
+    BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3 # :nodoc:
+    BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4 # :nodoc:
+    BOOTLOADER_STATUS_OK = 0 # :nodoc:
+    BOOTLOADER_STATUS_INVALID_MODE = 1 # :nodoc:
+    BOOTLOADER_STATUS_NO_CHANGE = 2 # :nodoc:
+    BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3 # :nodoc:
+    BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4 # :nodoc:
+    BOOTLOADER_STATUS_CRC_MISMATCH = 5 # :nodoc:
+    STATUS_LED_CONFIG_OFF = 0 # :nodoc:
+    STATUS_LED_CONFIG_ON = 1 # :nodoc:
+    STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2 # :nodoc:
+    STATUS_LED_CONFIG_SHOW_STATUS = 3 # :nodoc:
+
+    # Creates an object with the unique device ID <tt>uid</tt> and adds it to
+    # the IP Connection <tt>ipcon</tt>.
+    def initialize(uid, ipcon)
+      super uid, ipcon
+
+      @api_version = [2, 0, 0]
+
+      @response_expected[FUNCTION_GET_HIGH_CONTRAST_IMAGE_LOW_LEVEL] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_TEMPERATURE_IMAGE_LOW_LEVEL] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_STATISTICS] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_RESOLUTION] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_RESOLUTION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_SPOTMETER_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_SPOTMETER_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_HIGH_CONTRAST_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_HIGH_CONTRAST_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_IMAGE_TRANSFER_CONFIG] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_IMAGE_TRANSFER_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_HIGH_CONTRAST_IMAGE_LOW_LEVEL] = 'S C62'
+      @callback_formats[CALLBACK_TEMPERATURE_IMAGE_LOW_LEVEL] = 'S S31'
+
+      @high_level_callbacks[CALLBACK_HIGH_CONTRAST_IMAGE] = [['stream_chunk_offset', 'stream_chunk_data'], {'fixed_length' => 4800, 'single_chunk' => false}, nil]
+      @high_level_callbacks[CALLBACK_TEMPERATURE_IMAGE] = [['stream_chunk_offset', 'stream_chunk_data'], {'fixed_length' => 4800, 'single_chunk' => false}, nil]
+    end
+
+    # Returns the current high contrast image. See `here <https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Thermal_Imaging.html#high-contrast-image-vs-temperature-image>`__
+    # 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
+    # BrickletThermalImaging#set_image_transfer_config.
+    def get_high_contrast_image_low_level
+      send_request FUNCTION_GET_HIGH_CONTRAST_IMAGE_LOW_LEVEL, [], '', 64, 'S C62'
+    end
+
+    # Returns the current temperature image. See `here <https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Thermal_Imaging.html#high-contrast-image-vs-temperature-image>`__
+    # 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 withBrickletThermalImaging#set_resolution).
+    # 
+    # Before you can use this function you have to enable it with
+    # BrickletThermalImaging#set_image_transfer_config.
+    def get_temperature_image_low_level
+      send_request FUNCTION_GET_TEMPERATURE_IMAGE_LOW_LEVEL, [], '', 64, 'S S31'
+    end
+
+    # 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)
+    def get_statistics
+      send_request FUNCTION_GET_STATISTICS, [], '', 20, 'S4 S4 C C ?2'
+    end
+
+    # 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 default value is 0 to 655 Kelvin.
+    def set_resolution(resolution)
+      send_request FUNCTION_SET_RESOLUTION, [resolution], 'C', 0, ''
+    end
+
+    # Returns the resolution as set by BrickletThermalImaging#set_resolution.
+    def get_resolution
+      send_request FUNCTION_GET_RESOLUTION, [], '', 1, 'C'
+    end
+
+    # 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 BrickletThermalImaging#get_statistics.
+    # 
+    # The default region of interest is (39, 29, 40, 30).
+    def set_spotmeter_config(region_of_interest)
+      send_request FUNCTION_SET_SPOTMETER_CONFIG, [region_of_interest], 'C4', 0, ''
+    end
+
+    # Returns the spotmeter config as set by BrickletThermalImaging#set_spotmeter_config.
+    def get_spotmeter_config
+      send_request FUNCTION_GET_SPOTMETER_CONFIG, [], '', 4, 'C4'
+    end
+
+    # Sets the high contrast region of interest, dampening factor, clip limit and empty counts.
+    # This config is only used in high contrast mode (see BrickletThermalImaging#set_image_transfer_config).
+    # 
+    # 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 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.
+    # 
+    # Clip Limit Index 1 (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.
+    # 
+    # 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.
+    # 
+    # The default values are
+    # 
+    # * Region Of Interest = (0, 0, 79, 59),
+    # * Dampening Factor = 64,
+    # * Clip Limit = (4800, 512) and
+    # * Empty Counts = 2.
+    def set_high_contrast_config(region_of_interest, dampening_factor, clip_limit, empty_counts)
+      send_request FUNCTION_SET_HIGH_CONTRAST_CONFIG, [region_of_interest, dampening_factor, clip_limit, empty_counts], 'C4 S S2 S', 0, ''
+    end
+
+    # Returns the high contrast config as set by BrickletThermalImaging#set_high_contrast_config.
+    def get_high_contrast_config
+      send_request FUNCTION_GET_HIGH_CONTRAST_CONFIG, [], '', 12, 'C4 S S2 S'
+    end
+
+    # 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: BrickletThermalImaging#get_high_contrast_image.
+    # * Manual Temperature Image: BrickletThermalImaging#get_temperature_image.
+    # * Callback High Contrast Image: CALLBACK_HIGH_CONTRAST_IMAGE callback.
+    # * Callback Temperature Image: CALLBACK_TEMPERATURE_IMAGE callback.
+    # 
+    # The default is Manual High Contrast Image (0).
+    def set_image_transfer_config(config)
+      send_request FUNCTION_SET_IMAGE_TRANSFER_CONFIG, [config], 'C', 0, ''
+    end
+
+    # Returns the image transfer config, as set by BrickletThermalImaging#set_image_transfer_config.
+    def get_image_transfer_config
+      send_request FUNCTION_GET_IMAGE_TRANSFER_CONFIG, [], '', 1, 'C'
+    end
+
+    # Returns the error count for the communication between Brick and Bricklet.
+    # 
+    # The errors are divided into
+    # 
+    # * ack checksum errors,
+    # * message checksum errors,
+    # * frameing 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.
+    def get_spitfp_error_count
+      send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 16, 'L L L L'
+    end
+
+    # 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 und 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.
+    def set_bootloader_mode(mode)
+      send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 1, 'C'
+    end
+
+    # Returns the current bootloader mode, see BrickletThermalImaging#set_bootloader_mode.
+    def get_bootloader_mode
+      send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 1, 'C'
+    end
+
+    # Sets the firmware pointer for BrickletThermalImaging#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.
+    def set_write_firmware_pointer(pointer)
+      send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 0, ''
+    end
+
+    # Writes 64 Bytes of firmware at the position as written by
+    # BrickletThermalImaging#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.
+    def write_firmware(data)
+      send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 1, 'C'
+    end
+
+    # 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.
+    def set_status_led_config(config)
+      send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 0, ''
+    end
+
+    # Returns the configuration as set by BrickletThermalImaging#set_status_led_config
+    def get_status_led_config
+      send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 1, 'C'
+    end
+
+    # Returns the temperature in °C 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.
+    def get_chip_temperature
+      send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 2, 's'
+    end
+
+    # 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!
+    def reset
+      send_request FUNCTION_RESET, [], '', 0, ''
+    end
+
+    # 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.
+    def write_uid(uid)
+      send_request FUNCTION_WRITE_UID, [uid], 'L', 0, ''
+    end
+
+    # Returns the current UID as an integer. Encode as
+    # Base58 to get the usual string version.
+    def read_uid
+      send_request FUNCTION_READ_UID, [], '', 4, 'L'
+    end
+
+    # Returns the UID, the UID where the Bricklet is connected to,
+    # the position, the hardware and firmware version as well as the
+    # device identifier.
+    # 
+    # The position can be 'a', 'b', 'c' or 'd'.
+    # 
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
+    def get_identity
+      send_request FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S'
+    end
+
+    # Returns the current high contrast image. See `here <https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Thermal_Imaging.html#high-contrast-image-vs-temperature-image>`__
+    # 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
+    # BrickletThermalImaging#set_image_transfer_config.
+    def get_high_contrast_image
+      image_length = 4800
+      image_data = nil # assigned in block
+
+      @stream_mutex.synchronize {
+        ret = get_high_contrast_image_low_level
+        image_chunk_offset = ret[0]
+
+        if image_chunk_offset == (1 << 16) - 1 # maximum chunk offset -> stream has no data
+          image_length = 0
+          image_chunk_offset = 0
+          image_out_of_sync = false
+          image_data = []
+        else
+          image_out_of_sync = image_chunk_offset != 0
+          image_data = ret[1]
+        end
+
+        while not image_out_of_sync and image_data.length < image_length
+          ret = get_high_contrast_image_low_level
+          image_chunk_offset = ret[0]
+          image_out_of_sync = image_chunk_offset != image_data.length
+          image_data += ret[1]
+        end
+
+        if image_out_of_sync # discard remaining stream to bring it back in-sync
+          while image_chunk_offset + 62 < image_length
+            ret = get_high_contrast_image_low_level
+            image_chunk_offset = ret[0]
+          end
+
+          raise StreamOutOfSyncException, 'Image stream is out-of-sync'
+        end
+      }
+
+      image_data[0, image_length]
+    end
+
+    # Returns the current temperature image. See `here <https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Thermal_Imaging.html#high-contrast-image-vs-temperature-image>`__
+    # 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 withBrickletThermalImaging#set_resolution).
+    # 
+    # Before you can use this function you have to enable it with
+    # BrickletThermalImaging#set_image_transfer_config.
+    def get_temperature_image
+      image_length = 4800
+      image_data = nil # assigned in block
+
+      @stream_mutex.synchronize {
+        ret = get_temperature_image_low_level
+        image_chunk_offset = ret[0]
+
+        if image_chunk_offset == (1 << 16) - 1 # maximum chunk offset -> stream has no data
+          image_length = 0
+          image_chunk_offset = 0
+          image_out_of_sync = false
+          image_data = []
+        else
+          image_out_of_sync = image_chunk_offset != 0
+          image_data = ret[1]
+        end
+
+        while not image_out_of_sync and image_data.length < image_length
+          ret = get_temperature_image_low_level
+          image_chunk_offset = ret[0]
+          image_out_of_sync = image_chunk_offset != image_data.length
+          image_data += ret[1]
+        end
+
+        if image_out_of_sync # discard remaining stream to bring it back in-sync
+          while image_chunk_offset + 31 < image_length
+            ret = get_temperature_image_low_level
+            image_chunk_offset = ret[0]
+          end
+
+          raise StreamOutOfSyncException, 'Image stream is out-of-sync'
+        end
+      }
+
+      image_data[0, image_length]
+    end
+
+    # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.
+    def register_callback(id, &block)
+      callback = block
+      @registered_callbacks[id] = callback
+    end
+  end
+end