tinkerforge 2.1.14 → 2.1.15

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f05ead98338ead488cabeac20156b97fba8ad5e
+  data.tar.gz: 6a2248c9d3a0a3000c289800a4def1e54d54cebd
+SHA512:
+  metadata.gz: f8689604a21263fd246c9e7d3abd8f61918c3785440023485caeda3ceeffcdaa527cda67e40cd7e2e3d4face22623312468c84ae20055a93b5e9b9656b2b4ebe
+  data.tar.gz: a5c5ff0d40367bace070c1a0cd2d6f10395efe627ad67ccecf5d1fefa800cb7ef2415840ee46c0ee3315e9c7cd782cf6734bdc3f45df92fa6007e46a0ecdd5df

data/lib/tinkerforge/brick_dc.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/brick_imu.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/brick_imu_v2.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/brick_master.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/brick_red.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/brick_servo.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/brick_silent_stepper.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/brick_stepper.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_accelerometer.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_ambient_light.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_ambient_light_v2.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_analog_in.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_analog_in_v2.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_analog_out.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_analog_out_v2.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_barometer.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_can.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_co2.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_color.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_current12.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_current25.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_distance_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_distance_us.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_dmx.rb

@@ -0,0 +1,520 @@
+# -*- 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
+  # DMX Master and Slave
+  class BrickletDMX < Device
+    DEVICE_IDENTIFIER = 285 # :nodoc:
+    DEVICE_DISPLAY_NAME = 'DMX Bricklet' # :nodoc:
+
+    # This callback is triggered as soon as a new frame write is started.
+    # You should send the data for the next frame directly after this callback
+    # was triggered.
+    # 
+    # For an explanation of the general approach see BrickletDMX#write_frame.
+    # 
+    # This callback can be enabled via BrickletDMX#set_frame_callback_config.
+    # 
+    # This callback can only be triggered in master mode.
+    CALLBACK_FRAME_STARTED = 14
+
+    # This callback is triggered in slave mode when a new frame was received from the DMX master
+    # and it can be read out. You have to read the frame before the master has written
+    # the next frame, see BrickletDMX#read_frame for more details.
+    # 
+    # The parameter is the frame number, it is increased by one with each received frame.
+    # 
+    # This callback can be enabled via BrickletDMX#set_frame_callback_config.
+    # 
+    # This callback can only be triggered in slave mode.
+    CALLBACK_FRAME_AVAILABLE = 15
+
+    # This callback is called as soon as a new frame is available
+    # (written by the DMX master).
+    # 
+    # The size of the array is equivalent to the number of channels in
+    # the frame. Each byte represents one channel.
+    # 
+    # This callback can be enabled via BrickletDMX#set_frame_callback_config.
+    # 
+    # This callback can only be triggered in slave mode.
+    CALLBACK_FRAME_LOW_LEVEL = 16
+
+    # This callback is called if a new error occurs. It returns
+    # the current overrun and framing error count.
+    CALLBACK_FRAME_ERROR_COUNT = 17
+
+    # This callback is called as soon as a new frame is available
+    # (written by the DMX master).
+    # 
+    # The size of the array is equivalent to the number of channels in
+    # the frame. Each byte represents one channel.
+    # 
+    # This callback can be enabled via BrickletDMX#set_frame_callback_config.
+    # 
+    # This callback can only be triggered in slave mode.
+    CALLBACK_FRAME = -16
+
+    FUNCTION_SET_DMX_MODE = 1 # :nodoc:
+    FUNCTION_GET_DMX_MODE = 2 # :nodoc:
+    FUNCTION_WRITE_FRAME_LOW_LEVEL = 3 # :nodoc:
+    FUNCTION_READ_FRAME_LOW_LEVEL = 4 # :nodoc:
+    FUNCTION_SET_FRAME_DURATION = 5 # :nodoc:
+    FUNCTION_GET_FRAME_DURATION = 6 # :nodoc:
+    FUNCTION_GET_FRAME_ERROR_COUNT = 7 # :nodoc:
+    FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8 # :nodoc:
+    FUNCTION_GET_COMMUNICATION_LED_CONFIG = 9 # :nodoc:
+    FUNCTION_SET_ERROR_LED_CONFIG = 10 # :nodoc:
+    FUNCTION_GET_ERROR_LED_CONFIG = 11 # :nodoc:
+    FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12 # :nodoc:
+    FUNCTION_GET_FRAME_CALLBACK_CONFIG = 13 # :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:
+
+    DMX_MODE_MASTER = 0 # :nodoc:
+    DMX_MODE_SLAVE = 1 # :nodoc:
+    COMMUNICATION_LED_CONFIG_OFF = 0 # :nodoc:
+    COMMUNICATION_LED_CONFIG_ON = 1 # :nodoc:
+    COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2 # :nodoc:
+    COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3 # :nodoc:
+    ERROR_LED_CONFIG_OFF = 0 # :nodoc:
+    ERROR_LED_CONFIG_ON = 1 # :nodoc:
+    ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2 # :nodoc:
+    ERROR_LED_CONFIG_SHOW_ERROR = 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_SET_DMX_MODE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_DMX_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_WRITE_FRAME_LOW_LEVEL] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_READ_FRAME_LOW_LEVEL] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_FRAME_DURATION] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_FRAME_DURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_FRAME_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_COMMUNICATION_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_COMMUNICATION_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_ERROR_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_ERROR_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_FRAME_CALLBACK_CONFIG] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_FRAME_CALLBACK_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_FRAME_STARTED] = ''
+      @callback_formats[CALLBACK_FRAME_AVAILABLE] = 'L'
+      @callback_formats[CALLBACK_FRAME_LOW_LEVEL] = 'S S C56 L'
+      @callback_formats[CALLBACK_FRAME_ERROR_COUNT] = 'L L'
+
+      @high_level_callbacks[CALLBACK_FRAME] = [['stream_length', 'stream_chunk_offset', 'stream_chunk_data', nil], {'fixed_length' => nil, 'single_chunk' => false}, nil]
+    end
+
+    # Sets the DMX mode to either master or slave.
+    # 
+    # Calling this function sets frame number to 0.
+    def set_dmx_mode(dmx_mode)
+      send_request FUNCTION_SET_DMX_MODE, [dmx_mode], 'C', 0, ''
+    end
+
+    # Returns the DMX mode, as set by func:`Set DMX Mode`.
+    def get_dmx_mode
+      send_request FUNCTION_GET_DMX_MODE, [], '', 1, 'C'
+    end
+
+    # Writes a DMX frame. The maximum frame size is 512 byte. Each byte represents one channel.
+    # 
+    # The next frame can be written after the CALLBACK_FRAME_STARTED callback was called. The frame
+    # is double buffered, so a new frame can be written as soon as the writing of the prior frame
+    # starts.
+    # 
+    # The data will be transfered when the next frame duration ends, see BrickletDMX#set_frame_duration.
+    # 
+    # Generic approach:
+    # 
+    # * Set the frame duration to a value that represents the number of frames per second you want to achieve.
+    # * Set channels for first frame.
+    # * Wait for the CALLBACK_FRAME_STARTED callback.
+    # * Set channels for next frame.
+    # * Wait for the CALLBACK_FRAME_STARTED callback.
+    # * and so on.
+    # 
+    # This approach ensures that you can set new DMX data with a fixed frame rate.
+    # 
+    # This function can only be called in master mode.
+    def write_frame_low_level(frame_length, frame_chunk_offset, frame_chunk_data)
+      send_request FUNCTION_WRITE_FRAME_LOW_LEVEL, [frame_length, frame_chunk_offset, frame_chunk_data], 'S S C60', 0, ''
+    end
+
+    # Returns the last frame that was written by the DMX master. The size of the array
+    # is equivalent to the number of channels in the frame. Each byte represents one channel.
+    # 
+    # The next frame is available after the CALLBACK_FRAME_AVAILABLE callback was called.
+    # 
+    # Generic approach:
+    # 
+    # * Call BrickletDMX#read_frame to get first frame.
+    # * Wait for the CALLBACK_FRAME_AVAILABLE callback.
+    # * Call BrickletDMX#read_frame to get second frame.
+    # * Wait for the CALLBACK_FRAME_AVAILABLE callback.
+    # * and so on.
+    # 
+    # Instead of polling this function you can also use the CALLBACK_FRAME callback.
+    # You can enable it with BrickletDMX#set_frame_callback_config.
+    # 
+    # The frame number starts at 0 and it is increased by one with each received frame.
+    # 
+    # This function can only be called in slave mode.
+    def read_frame_low_level
+      send_request FUNCTION_READ_FRAME_LOW_LEVEL, [], '', 64, 'S S C56 L'
+    end
+
+    # Sets the duration of a frame in ms.
+    # 
+    # Example: If you want to achieve 20 frames per second, you should
+    # set the frame duration to 50ms (50ms * 20 = 1 second).
+    # 
+    # If you always want to send a frame as fast as possible you can set
+    # this value to 0.
+    # 
+    # This setting is only used in master mode.
+    # 
+    # Default value: 100ms (10 frames per second).
+    def set_frame_duration(frame_duration)
+      send_request FUNCTION_SET_FRAME_DURATION, [frame_duration], 'S', 0, ''
+    end
+
+    # Returns the frame duration as set by BrickletDMX#set_frame_duration.
+    def get_frame_duration
+      send_request FUNCTION_GET_FRAME_DURATION, [], '', 2, 'S'
+    end
+
+    # Returns the current number of overrun and framing errors.
+    def get_frame_error_count
+      send_request FUNCTION_GET_FRAME_ERROR_COUNT, [], '', 8, 'L L'
+    end
+
+    # Sets the communication LED configuration. By default the LED shows
+    # communication traffic, 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 off.
+    def set_communication_led_config(config)
+      send_request FUNCTION_SET_COMMUNICATION_LED_CONFIG, [config], 'C', 0, ''
+    end
+
+    # Returns the configuration as set by BrickletDMX#set_communication_led_config
+    def get_communication_led_config
+      send_request FUNCTION_GET_COMMUNICATION_LED_CONFIG, [], '', 1, 'C'
+    end
+
+    # Sets the error LED configuration.
+    # 
+    # By default the error LED turns on if there is any error (see CALLBACK_FRAME_ERROR_COUNT
+    # callback). If you call this function with the Show-Error option again, the LED
+    # will turn off until the next error occurs.
+    # 
+    # You can also turn the LED permanently on/off or show a heartbeat.
+    # 
+    # If the Bricklet is in bootloader mode, the LED is off.
+    def set_error_led_config(config)
+      send_request FUNCTION_SET_ERROR_LED_CONFIG, [config], 'C', 0, ''
+    end
+
+    # Returns the configuration as set by BrickletDMX#set_error_led_config.
+    def get_error_led_config
+      send_request FUNCTION_GET_ERROR_LED_CONFIG, [], '', 1, 'C'
+    end
+
+    # Enables/Disables the different callbacks. By default the
+    # CALLBACK_FRAME_STARTED callback and CALLBACK_FRAME_AVAILABLE callback are enabled while
+    # the CALLBACK_FRAME callback and CALLBACK_FRAME_ERROR_COUNT callback are disabled.
+    # 
+    # If you want to use the CALLBACK_FRAME callback you can enable it and disable
+    # the cb:`Frame Available` callback at the same time. It becomes redundant in
+    # this case.
+    def set_frame_callback_config(frame_started_callback_enabled, frame_available_callback_enabled, frame_callback_enabled, frame_error_count_callback_enabled)
+      send_request FUNCTION_SET_FRAME_CALLBACK_CONFIG, [frame_started_callback_enabled, frame_available_callback_enabled, frame_callback_enabled, frame_error_count_callback_enabled], '? ? ? ?', 0, ''
+    end
+
+    # Returns the frame callback config as set by BrickletDMX#set_frame_callback_config.
+    def get_frame_callback_config
+      send_request FUNCTION_GET_FRAME_CALLBACK_CONFIG, [], '', 4, '? ? ? ?'
+    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 BrickletDMX#set_bootloader_mode.
+    def get_bootloader_mode
+      send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 1, 'C'
+    end
+
+    # Sets the firmware pointer for BrickletDMX#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
+    # BrickletDMX#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 BrickletDMX#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
+
+    # Writes a DMX frame. The maximum frame size is 512 byte. Each byte represents one channel.
+    # 
+    # The next frame can be written after the CALLBACK_FRAME_STARTED callback was called. The frame
+    # is double buffered, so a new frame can be written as soon as the writing of the prior frame
+    # starts.
+    # 
+    # The data will be transfered when the next frame duration ends, see BrickletDMX#set_frame_duration.
+    # 
+    # Generic approach:
+    # 
+    # * Set the frame duration to a value that represents the number of frames per second you want to achieve.
+    # * Set channels for first frame.
+    # * Wait for the CALLBACK_FRAME_STARTED callback.
+    # * Set channels for next frame.
+    # * Wait for the CALLBACK_FRAME_STARTED callback.
+    # * and so on.
+    # 
+    # This approach ensures that you can set new DMX data with a fixed frame rate.
+    # 
+    # This function can only be called in master mode.
+    def write_frame(frame)
+      if frame.length > 65535
+        raise ArgumentError, 'Frame can be at most 65535 items long'
+      end
+
+      frame_length = frame.length
+      frame_chunk_offset = 0
+
+      if frame_length == 0
+        frame_chunk_data = [0] * 60
+        ret = write_frame_low_level frame_length, frame_chunk_offset, frame_chunk_data
+      else
+        ret = nil # assigned in block
+
+        @stream_mutex.synchronize {
+          while frame_chunk_offset < frame_length
+            frame_chunk_data = frame[frame_chunk_offset, 60]
+
+            if frame_chunk_data.length < 60
+              frame_chunk_data += [0] * (60 - frame_chunk_data.length)
+            end
+
+            ret = write_frame_low_level frame_length, frame_chunk_offset, frame_chunk_data
+            frame_chunk_offset += 60
+          end
+        }
+      end
+
+      ret
+    end
+
+    # Returns the last frame that was written by the DMX master. The size of the array
+    # is equivalent to the number of channels in the frame. Each byte represents one channel.
+    # 
+    # The next frame is available after the CALLBACK_FRAME_AVAILABLE callback was called.
+    # 
+    # Generic approach:
+    # 
+    # * Call BrickletDMX#read_frame to get first frame.
+    # * Wait for the CALLBACK_FRAME_AVAILABLE callback.
+    # * Call BrickletDMX#read_frame to get second frame.
+    # * Wait for the CALLBACK_FRAME_AVAILABLE callback.
+    # * and so on.
+    # 
+    # Instead of polling this function you can also use the CALLBACK_FRAME callback.
+    # You can enable it with BrickletDMX#set_frame_callback_config.
+    # 
+    # The frame number starts at 0 and it is increased by one with each received frame.
+    # 
+    # This function can only be called in slave mode.
+    def read_frame
+      ret = nil # assigned in block
+      frame_length = nil # assigned in block
+      frame_data = nil # assigned in block
+
+      @stream_mutex.synchronize {
+        ret = read_frame_low_level
+        frame_length = ret[0]
+        frame_chunk_offset = ret[1]
+        frame_out_of_sync = frame_chunk_offset != 0
+        frame_data = ret[2]
+
+        while not frame_out_of_sync and frame_data.length < frame_length
+          ret = read_frame_low_level
+          frame_length = ret[0]
+          frame_chunk_offset = ret[1]
+          frame_out_of_sync = frame_chunk_offset != frame_data.length
+          frame_data += ret[2]
+        end
+
+        if frame_out_of_sync # discard remaining stream to bring it back in-sync
+          while frame_chunk_offset + 56 < frame_length
+            ret = read_frame_low_level
+            frame_length = ret[0]
+            frame_chunk_offset = ret[1]
+          end
+
+          raise StreamOutOfSyncException, 'Frame stream is out-of-sync'
+        end
+      }
+
+      [frame_data[0, frame_length], ret[3]]
+    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