tinkerforge 2.1.21 → 2.1.22

data/lib/tinkerforge/bricklet_color.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #
@@ -220,7 +220,7 @@ module Tinkerforge
     end
 
     # Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__
-    # for the resistance and temperature.
+    # for the distance.
     # 
     # Setting the length to 1 will turn the averaging off. With less averaging, there
     # is more noise on the data.

data/lib/tinkerforge/bricklet_distance_us.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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_dual_button.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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_dual_button_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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_dual_relay.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #
@@ -53,7 +53,7 @@ module Tinkerforge
     # of the other relay, you can get the state with BrickletDualRelay#get_state or you
     # can use BrickletDualRelay#set_selected_state.
     # 
-    # Running monoflop timers will be overwritten if this function is called.
+    # All running monoflop timers will be aborted if this function is called.
     # 
     # The default value is (*false*, *false*).
     def set_state(relay1, relay2)
@@ -93,6 +93,8 @@ module Tinkerforge
 
     # Sets the state of the selected relay (1 or 2), *true* means on and *false* means off.
     # 
+    # A running monoflop timer for the selected relay will be aborted if this function is called.
+    # 
     # The other relay remains untouched.
     def set_selected_state(relay, state)
       send_request FUNCTION_SET_SELECTED_STATE, [relay, state], 'C ?', 0, ''

data/lib/tinkerforge/bricklet_dust_detector.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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_e_paper_296x128.rb

@@ -0,0 +1,600 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2019-05-21.      #
+#                                                           #
+# Ruby Bindings Version 2.1.22                              #
+#                                                           #
+# 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
+  # Three color 296x128 e-paper display
+  class BrickletEPaper296x128 < Device
+    DEVICE_IDENTIFIER = 2146 # :nodoc:
+    DEVICE_DISPLAY_NAME = 'E-Paper 296x128 Bricklet' # :nodoc:
+
+    # Callback for the current draw status. Will be called every time the
+    # draw status changes (see BrickletEPaper296x128#get_draw_status).
+    CALLBACK_DRAW_STATUS = 11
+
+    FUNCTION_DRAW = 1 # :nodoc:
+    FUNCTION_GET_DRAW_STATUS = 2 # :nodoc:
+    FUNCTION_WRITE_BLACK_WHITE_LOW_LEVEL = 3 # :nodoc:
+    FUNCTION_READ_BLACK_WHITE_LOW_LEVEL = 4 # :nodoc:
+    FUNCTION_WRITE_COLOR_LOW_LEVEL = 5 # :nodoc:
+    FUNCTION_READ_COLOR_LOW_LEVEL = 6 # :nodoc:
+    FUNCTION_FILL_DISPLAY = 7 # :nodoc:
+    FUNCTION_DRAW_TEXT = 8 # :nodoc:
+    FUNCTION_DRAW_LINE = 9 # :nodoc:
+    FUNCTION_DRAW_BOX = 10 # :nodoc:
+    FUNCTION_SET_UPDATE_MODE = 12 # :nodoc:
+    FUNCTION_GET_UPDATE_MODE = 13 # :nodoc:
+    FUNCTION_SET_DISPLAY_TYPE = 14 # :nodoc:
+    FUNCTION_GET_DISPLAY_TYPE = 15 # :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:
+
+    DRAW_STATUS_IDLE = 0 # :nodoc:
+    DRAW_STATUS_COPYING = 1 # :nodoc:
+    DRAW_STATUS_DRAWING = 2 # :nodoc:
+    COLOR_BLACK = 0 # :nodoc:
+    COLOR_WHITE = 1 # :nodoc:
+    COLOR_RED = 2 # :nodoc:
+    COLOR_GRAY = 2 # :nodoc:
+    FONT_6X8 = 0 # :nodoc:
+    FONT_6X16 = 1 # :nodoc:
+    FONT_6X24 = 2 # :nodoc:
+    FONT_6X32 = 3 # :nodoc:
+    FONT_12X16 = 4 # :nodoc:
+    FONT_12X24 = 5 # :nodoc:
+    FONT_12X32 = 6 # :nodoc:
+    FONT_18X24 = 7 # :nodoc:
+    FONT_18X32 = 8 # :nodoc:
+    FONT_24X32 = 9 # :nodoc:
+    ORIENTATION_HORIZONTAL = 0 # :nodoc:
+    ORIENTATION_VERTICAL = 1 # :nodoc:
+    UPDATE_MODE_DEFAULT = 0 # :nodoc:
+    UPDATE_MODE_BLACK_WHITE = 1 # :nodoc:
+    UPDATE_MODE_DELTA = 2 # :nodoc:
+    DISPLAY_TYPE_BLACK_WHITE_RED = 0 # :nodoc:
+    DISPLAY_TYPE_BLACK_WHITE_GRAY = 1 # :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_DRAW] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_DRAW_STATUS] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_WRITE_BLACK_WHITE_LOW_LEVEL] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_READ_BLACK_WHITE_LOW_LEVEL] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_WRITE_COLOR_LOW_LEVEL] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_READ_COLOR_LOW_LEVEL] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_FILL_DISPLAY] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_DRAW_TEXT] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_DRAW_LINE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_DRAW_BOX] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_SET_UPDATE_MODE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_UPDATE_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_DISPLAY_TYPE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_DISPLAY_TYPE] = 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_DRAW_STATUS] = 'C'
+
+    end
+
+    # Draws the current black/white and red or gray buffer to the e-paper display.
+    # 
+    # The Bricklet does not have any double-buffering. You should not call
+    # this function while writing to the buffer. See BrickletEPaper296x128#get_draw_status.
+    def draw
+      send_request FUNCTION_DRAW, [], '', 0, ''
+    end
+
+    # Returns one of three draw statuses:
+    # 
+    # * Idle
+    # * Copying: Data is being copied from the buffer of the Bricklet to the buffer of the display.
+    # * Drawing: The display is updating its content (during this phase the flickering etc happens).
+    # 
+    # You can write to the buffer (through one of the write or draw functions) when the status is
+    # either *idle* or *drawing*. You should not write to the buffer while it is being *copied* to the
+    # display. There is no double-buffering.
+    def get_draw_status
+      send_request FUNCTION_GET_DRAW_STATUS, [], '', 1, 'C'
+    end
+
+    # Writes black/white pixels to the specified window into the buffer.
+    # 
+    # The x-axis goes from 0 to 295 and the y-axis from 0 to 127. The pixels are written
+    # into the window line by line top to bottom and each line is written from left to
+    # right.
+    # 
+    # The value 0 (false) corresponds to a black pixel and the value 1 (true) to a
+    # white pixel.
+    # 
+    # This function writes the pixels into the black/white pixel buffer, to draw the
+    # buffer to the display use BrickletEPaper296x128#draw.
+    # 
+    # Use BrickletEPaper296x128#write_color to write red or gray pixels.
+    def write_black_white_low_level(x_start, y_start, x_end, y_end, pixels_length, pixels_chunk_offset, pixels_chunk_data)
+      send_request FUNCTION_WRITE_BLACK_WHITE_LOW_LEVEL, [x_start, y_start, x_end, y_end, pixels_length, pixels_chunk_offset, pixels_chunk_data], 'S C S C S S ?432', 0, ''
+    end
+
+    # Returns the current content of the black/white pixel buffer for the specified window.
+    # 
+    # The x-axis goes from 0 to 295 and the y-axis from 0 to 127. The pixels are written
+    # into the window line by line top to bottom and each line is written from left to
+    # right.
+    # 
+    # The current content of the buffer does not have to be the current content of the display.
+    # It is possible that the data was not drawn to the display yet and after a restart of
+    # the Bricklet the buffer will be reset to black, while the display retains its content.
+    def read_black_white_low_level(x_start, y_start, x_end, y_end)
+      send_request FUNCTION_READ_BLACK_WHITE_LOW_LEVEL, [x_start, y_start, x_end, y_end], 'S C S C', 468, 'S S ?464'
+    end
+
+    # The E-Paper 296x128 Bricklet is available with the colors black/white/red and
+    # black/white/gray. Depending on the model this function writes either red or
+    # gray pixels to the specified window into the buffer.
+    # 
+    # The x-axis goes from 0 to 295 and the y-axis from 0 to 127. The pixels are written
+    # into the window line by line top to bottom and each line is written from left to
+    # right.
+    # 
+    # The value 0 (false) means that this pixel does not have color. It will be either black
+    # or white (see BrickletEPaper296x128#write_black_white). The value 1 (true) corresponds to a red or gray
+    # pixel, depending on the Bricklet model.
+    # 
+    # This function writes the pixels into the red or gray pixel buffer, to draw the buffer
+    # to the display use BrickletEPaper296x128#draw.
+    # 
+    # Use BrickletEPaper296x128#write_black_white to write black/white pixels.
+    def write_color_low_level(x_start, y_start, x_end, y_end, pixels_length, pixels_chunk_offset, pixels_chunk_data)
+      send_request FUNCTION_WRITE_COLOR_LOW_LEVEL, [x_start, y_start, x_end, y_end, pixels_length, pixels_chunk_offset, pixels_chunk_data], 'S C S C S S ?432', 0, ''
+    end
+
+    # Returns the current content of the red or gray pixel buffer for the specified window.
+    # 
+    # The x-axis goes from 0 to 295 and the y-axis from 0 to 127. The pixels are written
+    # into the window line by line top to bottom and each line is written from left to
+    # right.
+    # 
+    # The current content of the buffer does not have to be the current content of the display.
+    # It is possible that the data was not drawn to the display yet and after a restart of
+    # the Bricklet the buffer will be reset to black, while the display retains its content.
+    def read_color_low_level(x_start, y_start, x_end, y_end)
+      send_request FUNCTION_READ_COLOR_LOW_LEVEL, [x_start, y_start, x_end, y_end], 'S C S C', 468, 'S S ?464'
+    end
+
+    # Fills the complete content of the display with the given color.
+    def fill_display(color)
+      send_request FUNCTION_FILL_DISPLAY, [color], 'C', 0, ''
+    end
+
+    # Draws a text with up to 50 characters at the pixel position (x, y).
+    # 
+    # The x values have to be within the range of 0 to 295 and the y
+    # values have to be within the range of 0 to 127.
+    # 
+    # You can use one of 9 different font sizes and draw the text in
+    # black/white/red|gray. The text can be drawn horizontal or vertical.
+    def draw_text(position_x, position_y, font, color, orientation, text)
+      send_request FUNCTION_DRAW_TEXT, [position_x, position_y, font, color, orientation, text], 'S C C C C Z50', 0, ''
+    end
+
+    # Draws a line from (x, y)-start to (x, y)-end in the given color.
+    # The x values have to be within the range of 0 to 295 and the y
+    # values have t be within the range of 0 to 127.
+    def draw_line(position_x_start, position_y_start, position_x_end, position_y_end, color)
+      send_request FUNCTION_DRAW_LINE, [position_x_start, position_y_start, position_x_end, position_y_end, color], 'S C S C C', 0, ''
+    end
+
+    # Draws a box from (x, y)-start to (x, y)-end in the given color.
+    # The x values have to be within the range of 0 to 295 and the y
+    # values have to be within the range of 0 to 127.
+    # 
+    # If you set fill to true, the box will be filled with the
+    # color. Otherwise only the outline will be drawn.
+    def draw_box(position_x_start, position_y_start, position_x_end, position_y_end, fill, color)
+      send_request FUNCTION_DRAW_BOX, [position_x_start, position_y_start, position_x_end, position_y_end, fill, color], 'S C S C ? C', 0, ''
+    end
+
+    # .. note::
+    #  The default update mode corresponds to the default e-paper display
+    #  manufacturer settings. All of the other modes are experimental and
+    #  will result in increased ghosting and possibly other long-term
+    #  side effects.
+    # 
+    #  If you want to know more about the inner workings of an e-paper display
+    #  take a look at this excellent video from Ben Krasnow:
+    #  `https://www.youtube.com/watch?v=MsbiO8EAsGw <https://www.youtube.com/watch?v=MsbiO8EAsGw>`__.
+    # 
+    #  If you are not sure about this option, leave the update mode at default.
+    # 
+    # Currently there are three update modes available:
+    # 
+    # * Default: Settings as given by the manufacturer. An update will take about
+    #   7.5 seconds and during the update the screen will flicker several times.
+    # * Black/White: This will only update the black/white pixel. It uses the manufacturer
+    #   settings for black/white and ignores the red or gray pixel buffer. With this mode the
+    #   display will flicker once and it takes about 2.5 seconds. Compared to the default settings
+    #   there is more ghosting.
+    # * Delta: This will only update the black/white pixel. It uses an aggressive method where
+    #   the changes are not applied for a whole buffer but only for the delta between the last
+    #   and the next buffer. With this mode the display will not flicker during an update and
+    #   it takes about 900-950ms. Compared to the other two settings there is more ghosting. This
+    #   mode can be used for something like a flicker-free live update of a text.
+    # 
+    # With the black/white/red display if you use either the black/white or the delta mode,
+    # after a while of going back and forth between black and white the white color will
+    # start to appear red-ish or pink-ish.
+    # 
+    # If you use the aggressive delta mode and rapidly change the content, we recommend that you
+    # change back to the default mode every few hours and in the default mode cycle between the
+    # three available colors a few times. This will get rid of the ghosting and after that you can
+    # go back to the delta mode with flicker-free updates.
+    def set_update_mode(update_mode)
+      send_request FUNCTION_SET_UPDATE_MODE, [update_mode], 'C', 0, ''
+    end
+
+    # Returns the update mode as set by BrickletEPaper296x128#set_update_mode.
+    def get_update_mode
+      send_request FUNCTION_GET_UPDATE_MODE, [], '', 1, 'C'
+    end
+
+    # Sets the type of the display. The e-paper display is available
+    # in black/white/red and black/white/gray. This will be factory set
+    # during the flashing and testing phase. The value is saved in
+    # non-volatile memory and will stay after a power cycle.
+    def set_display_type(display_type)
+      send_request FUNCTION_SET_DISPLAY_TYPE, [display_type], 'C', 0, ''
+    end
+
+    # Returns the type of the e-paper display. It can either be
+    # black/white/red or black/white/gray.
+    def get_display_type
+      send_request FUNCTION_GET_DISPLAY_TYPE, [], '', 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,
+    # * 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.
+    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 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.
+    def set_bootloader_mode(mode)
+      send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 1, 'C'
+    end
+
+    # Returns the current bootloader mode, see BrickletEPaper296x128#set_bootloader_mode.
+    def get_bootloader_mode
+      send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 1, 'C'
+    end
+
+    # Sets the firmware pointer for BrickletEPaper296x128#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
+    # BrickletEPaper296x128#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 BrickletEPaper296x128#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 black/white pixels to the specified window into the buffer.
+    # 
+    # The x-axis goes from 0 to 295 and the y-axis from 0 to 127. The pixels are written
+    # into the window line by line top to bottom and each line is written from left to
+    # right.
+    # 
+    # The value 0 (false) corresponds to a black pixel and the value 1 (true) to a
+    # white pixel.
+    # 
+    # This function writes the pixels into the black/white pixel buffer, to draw the
+    # buffer to the display use BrickletEPaper296x128#draw.
+    # 
+    # Use BrickletEPaper296x128#write_color to write red or gray pixels.
+    def write_black_white(x_start, y_start, x_end, y_end, pixels)
+      if pixels.length > 65535
+        raise ArgumentError, 'Pixels can be at most 65535 items long'
+      end
+
+      pixels_length = pixels.length
+      pixels_chunk_offset = 0
+
+      if pixels_length == 0
+        pixels_chunk_data = [false] * 432
+        ret = write_black_white_low_level x_start, y_start, x_end, y_end, pixels_length, pixels_chunk_offset, pixels_chunk_data
+      else
+        ret = nil # assigned in block
+
+        @stream_mutex.synchronize {
+          while pixels_chunk_offset < pixels_length
+            pixels_chunk_data = pixels[pixels_chunk_offset, 432]
+
+            if pixels_chunk_data.length < 432
+              pixels_chunk_data += [false] * (432 - pixels_chunk_data.length)
+            end
+
+            ret = write_black_white_low_level x_start, y_start, x_end, y_end, pixels_length, pixels_chunk_offset, pixels_chunk_data
+            pixels_chunk_offset += 432
+          end
+        }
+      end
+
+      ret
+    end
+
+    # Returns the current content of the black/white pixel buffer for the specified window.
+    # 
+    # The x-axis goes from 0 to 295 and the y-axis from 0 to 127. The pixels are written
+    # into the window line by line top to bottom and each line is written from left to
+    # right.
+    # 
+    # The current content of the buffer does not have to be the current content of the display.
+    # It is possible that the data was not drawn to the display yet and after a restart of
+    # the Bricklet the buffer will be reset to black, while the display retains its content.
+    def read_black_white(x_start, y_start, x_end, y_end)
+      pixels_length = nil # assigned in block
+      pixels_data = nil # assigned in block
+
+      @stream_mutex.synchronize {
+        ret = read_black_white_low_level x_start, y_start, x_end, y_end
+        pixels_length = ret[0]
+        pixels_chunk_offset = ret[1]
+        pixels_out_of_sync = pixels_chunk_offset != 0
+        pixels_data = ret[2]
+
+        while not pixels_out_of_sync and pixels_data.length < pixels_length
+          ret = read_black_white_low_level x_start, y_start, x_end, y_end
+          pixels_length = ret[0]
+          pixels_chunk_offset = ret[1]
+          pixels_out_of_sync = pixels_chunk_offset != pixels_data.length
+          pixels_data += ret[2]
+        end
+
+        if pixels_out_of_sync # discard remaining stream to bring it back in-sync
+          while pixels_chunk_offset + 464 < pixels_length
+            ret = read_black_white_low_level x_start, y_start, x_end, y_end
+            pixels_length = ret[0]
+            pixels_chunk_offset = ret[1]
+          end
+
+          raise StreamOutOfSyncException, 'Pixels stream is out-of-sync'
+        end
+      }
+
+      pixels_data[0, pixels_length]
+    end
+
+    # The E-Paper 296x128 Bricklet is available with the colors black/white/red and
+    # black/white/gray. Depending on the model this function writes either red or
+    # gray pixels to the specified window into the buffer.
+    # 
+    # The x-axis goes from 0 to 295 and the y-axis from 0 to 127. The pixels are written
+    # into the window line by line top to bottom and each line is written from left to
+    # right.
+    # 
+    # The value 0 (false) means that this pixel does not have color. It will be either black
+    # or white (see BrickletEPaper296x128#write_black_white). The value 1 (true) corresponds to a red or gray
+    # pixel, depending on the Bricklet model.
+    # 
+    # This function writes the pixels into the red or gray pixel buffer, to draw the buffer
+    # to the display use BrickletEPaper296x128#draw.
+    # 
+    # Use BrickletEPaper296x128#write_black_white to write black/white pixels.
+    def write_color(x_start, y_start, x_end, y_end, pixels)
+      if pixels.length > 65535
+        raise ArgumentError, 'Pixels can be at most 65535 items long'
+      end
+
+      pixels_length = pixels.length
+      pixels_chunk_offset = 0
+
+      if pixels_length == 0
+        pixels_chunk_data = [false] * 432
+        ret = write_color_low_level x_start, y_start, x_end, y_end, pixels_length, pixels_chunk_offset, pixels_chunk_data
+      else
+        ret = nil # assigned in block
+
+        @stream_mutex.synchronize {
+          while pixels_chunk_offset < pixels_length
+            pixels_chunk_data = pixels[pixels_chunk_offset, 432]
+
+            if pixels_chunk_data.length < 432
+              pixels_chunk_data += [false] * (432 - pixels_chunk_data.length)
+            end
+
+            ret = write_color_low_level x_start, y_start, x_end, y_end, pixels_length, pixels_chunk_offset, pixels_chunk_data
+            pixels_chunk_offset += 432
+          end
+        }
+      end
+
+      ret
+    end
+
+    # Returns the current content of the red or gray pixel buffer for the specified window.
+    # 
+    # The x-axis goes from 0 to 295 and the y-axis from 0 to 127. The pixels are written
+    # into the window line by line top to bottom and each line is written from left to
+    # right.
+    # 
+    # The current content of the buffer does not have to be the current content of the display.
+    # It is possible that the data was not drawn to the display yet and after a restart of
+    # the Bricklet the buffer will be reset to black, while the display retains its content.
+    def read_color(x_start, y_start, x_end, y_end)
+      pixels_length = nil # assigned in block
+      pixels_data = nil # assigned in block
+
+      @stream_mutex.synchronize {
+        ret = read_color_low_level x_start, y_start, x_end, y_end
+        pixels_length = ret[0]
+        pixels_chunk_offset = ret[1]
+        pixels_out_of_sync = pixels_chunk_offset != 0
+        pixels_data = ret[2]
+
+        while not pixels_out_of_sync and pixels_data.length < pixels_length
+          ret = read_color_low_level x_start, y_start, x_end, y_end
+          pixels_length = ret[0]
+          pixels_chunk_offset = ret[1]
+          pixels_out_of_sync = pixels_chunk_offset != pixels_data.length
+          pixels_data += ret[2]
+        end
+
+        if pixels_out_of_sync # discard remaining stream to bring it back in-sync
+          while pixels_chunk_offset + 464 < pixels_length
+            ret = read_color_low_level x_start, y_start, x_end, y_end
+            pixels_length = ret[0]
+            pixels_chunk_offset = ret[1]
+          end
+
+          raise StreamOutOfSyncException, 'Pixels stream is out-of-sync'
+        end
+      }
+
+      pixels_data[0, pixels_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