tinkerforge 2.0.7

data/lib/tinkerforge/bricklet_joystick.rb

@@ -0,0 +1,274 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2013-05-16.      #
+#                                                           #
+# Bindings Version 2.0.7                                    #
+#                                                           #
+# 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 generator git on tinkerforge.com                   #
+#############################################################
+
+module Tinkerforge
+  # Dual-Axis Joystick with Button
+  class BrickletJoystick < Device
+    DEVICE_IDENTIFIER = 210 # :nodoc:
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletJoystick#set_position_callback_period. The parameter is the position of the
+    # Joystick.
+    # 
+    # CALLBACK_POSITION is only triggered if the position has changed since the
+    # last triggering.
+    CALLBACK_POSITION = 15
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletJoystick#set_analog_value_callback_period. The parameters are the analog values
+    # of the Joystick.
+    # 
+    # CALLBACK_ANALOG_VALUE is only triggered if the values have changed since the
+    # last triggering.
+    CALLBACK_ANALOG_VALUE = 16
+
+    # This callback is triggered when the threshold as set by
+    # BrickletJoystick#set_position_callback_threshold is reached.
+    # The parameters are the position of the Joystick.
+    # 
+    # If the threshold keeps being reached, the callback is triggered periodically
+    # with the period as set by BrickletJoystick#set_debounce_period.
+    CALLBACK_POSITION_REACHED = 17
+
+    # This callback is triggered when the threshold as set by
+    # BrickletJoystick#set_analog_value_callback_threshold is reached.
+    # The parameters are the analog values of the Joystick.
+    # 
+    # If the threshold keeps being reached, the callback is triggered periodically
+    # with the period as set by BrickletJoystick#set_debounce_period.
+    CALLBACK_ANALOG_VALUE_REACHED = 18
+
+    # This callback is triggered when the button is pressed.
+    CALLBACK_PRESSED = 19
+
+    # This callback is triggered when the button is released.
+    CALLBACK_RELEASED = 20
+
+    FUNCTION_GET_POSITION = 1 # :nodoc:
+    FUNCTION_IS_PRESSED = 2 # :nodoc:
+    FUNCTION_GET_ANALOG_VALUE = 3 # :nodoc:
+    FUNCTION_CALIBRATE = 4 # :nodoc:
+    FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5 # :nodoc:
+    FUNCTION_GET_POSITION_CALLBACK_PERIOD = 6 # :nodoc:
+    FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7 # :nodoc:
+    FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD = 8 # :nodoc:
+    FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9 # :nodoc:
+    FUNCTION_GET_POSITION_CALLBACK_THRESHOLD = 10 # :nodoc:
+    FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11 # :nodoc:
+    FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD = 12 # :nodoc:
+    FUNCTION_SET_DEBOUNCE_PERIOD = 13 # :nodoc:
+    FUNCTION_GET_DEBOUNCE_PERIOD = 14 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :nodoc:
+
+    THRESHOLD_OPTION_OFF = 'x' # :nodoc:
+    THRESHOLD_OPTION_OUTSIDE = 'o' # :nodoc:
+    THRESHOLD_OPTION_INSIDE = 'i' # :nodoc:
+    THRESHOLD_OPTION_SMALLER = '<' # :nodoc:
+    THRESHOLD_OPTION_GREATER = '>' # :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_POSITION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_IS_PRESSED] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_CALIBRATE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_SET_POSITION_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_POSITION_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_POSITION_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_POSITION_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_POSITION] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_POSITION_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_ANALOG_VALUE_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_PRESSED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_RELEASED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_POSITION] = 's s'
+      @callback_formats[CALLBACK_ANALOG_VALUE] = 'S S'
+      @callback_formats[CALLBACK_POSITION_REACHED] = 's s'
+      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S S'
+      @callback_formats[CALLBACK_PRESSED] = ''
+      @callback_formats[CALLBACK_RELEASED] = ''
+    end
+
+    # Returns the position of the Joystick. The value ranges between -100 and
+    # 100 for both axis. The middle position of the joystick is x=0, y=0. The
+    # returned values are averaged and calibrated (see BrickletJoystick#calibrate).
+    # 
+    # If you want to get the position periodically, it is recommended to use the
+    # callback CALLBACK_POSITION and set the period with 
+    # BrickletJoystick#set_position_callback_period.
+    def get_position
+      send_request(FUNCTION_GET_POSITION, [], '', 4, 's s')
+    end
+
+    # Returns *true* if the button is pressed and *false* otherwise.
+    # 
+    # It is recommended to use the CALLBACK_PRESSED and CALLBACK_RELEASED callbacks
+    # to handle the button.
+    def is_pressed
+      send_request(FUNCTION_IS_PRESSED, [], '', 1, '?')
+    end
+
+    # Returns the values as read by a 12-bit analog-to-digital converter.
+    # The values are between 0 and 4095 for both axis.
+    # 
+    # .. note::
+    #  The values returned by BrickletJoystick#get_position are averaged over several samples
+    #  to yield less noise, while BrickletJoystick#get_analog_value gives back raw
+    #  unfiltered analog values. The only reason to use BrickletJoystick#get_analog_value is,
+    #  if you need the full resolution of the analog-to-digital converter.
+    # 
+    # If you want the analog values periodically, it is recommended to use the 
+    # callback CALLBACK_ANALOG_VALUE and set the period with 
+    # BrickletJoystick#set_analog_value_callback_period.
+    def get_analog_value
+      send_request(FUNCTION_GET_ANALOG_VALUE, [], '', 4, 'S S')
+    end
+
+    # Calibrates the middle position of the Joystick. If your Joystick Bricklet
+    # does not return x=0 and y=0 in the middle position, call this function
+    # while the Joystick is standing still in the middle position.
+    # 
+    # The resulting calibration will be saved on the EEPROM of the Joystick
+    # Bricklet, thus you only have to calibrate it once.
+    def calibrate
+      send_request(FUNCTION_CALIBRATE, [], '', 0, '')
+    end
+
+    # Sets the period in ms with which the CALLBACK_POSITION callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_POSITION is only triggered if the position has changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_position_callback_period(period)
+      send_request(FUNCTION_SET_POSITION_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletJoystick#set_position_callback_period.
+    def get_position_callback_period
+      send_request(FUNCTION_GET_POSITION_CALLBACK_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_ANALOG_VALUE is only triggered if the analog values have changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_analog_value_callback_period(period)
+      send_request(FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletJoystick#set_analog_value_callback_period.
+    def get_analog_value_callback_period
+      send_request(FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the thresholds for the CALLBACK_POSITION_REACHED callback. 
+    # 
+    # The following options are possible:
+    # 
+    #  "Option", "Description"
+    # 
+    #  "'x'",    "Callback is turned off"
+    #  "'o'",    "Callback is triggered when the position is *outside* the min and max values"
+    #  "'i'",    "Callback is triggered when the position is *inside* the min and max values"
+    #  "'<'",    "Callback is triggered when the position is smaller than the min values (max is ignored)"
+    #  "'>'",    "Callback is triggered when the position is greater than the min values (max is ignored)"
+    # 
+    # The default value is ('x', 0, 0, 0, 0).
+    def set_position_callback_threshold(option, min_x, max_x, min_y, max_y)
+      send_request(FUNCTION_SET_POSITION_CALLBACK_THRESHOLD, [option, min_x, max_x, min_y, max_y], 'k s s s s', 0, '')
+    end
+
+    # Returns the threshold as set by BrickletJoystick#set_position_callback_threshold.
+    def get_position_callback_threshold
+      send_request(FUNCTION_GET_POSITION_CALLBACK_THRESHOLD, [], '', 9, 'k s s s s')
+    end
+
+    # Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback. 
+    # 
+    # The following options are possible:
+    # 
+    #  "Option", "Description"
+    # 
+    #  "'x'",    "Callback is turned off"
+    #  "'o'",    "Callback is triggered when the analog values are *outside* the min and max values"
+    #  "'i'",    "Callback is triggered when the analog values are *inside* the min and max values"
+    #  "'<'",    "Callback is triggered when the analog values are smaller than the min values (max is ignored)"
+    #  "'>'",    "Callback is triggered when the analog values are greater than the min values (max is ignored)"
+    # 
+    # The default value is ('x', 0, 0, 0, 0).
+    def set_analog_value_callback_threshold(option, min_x, max_x, min_y, max_y)
+      send_request(FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD, [option, min_x, max_x, min_y, max_y], 'k S S S S', 0, '')
+    end
+
+    # Returns the threshold as set by BrickletJoystick#set_analog_value_callback_threshold.
+    def get_analog_value_callback_threshold
+      send_request(FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD, [], '', 9, 'k S S S S')
+    end
+
+    # Sets the period in ms with which the threshold callbacks
+    # 
+    #  CALLBACK_POSITION_REACHED, CALLBACK_ANALOG_VALUE_REACHED
+    # 
+    # are triggered, if the thresholds
+    # 
+    #  BrickletJoystick#set_position_callback_threshold, BrickletJoystick#set_analog_value_callback_threshold
+    # 
+    # keep being reached.
+    # 
+    # The default value is 100.
+    def set_debounce_period(debounce)
+      send_request(FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, '')
+    end
+
+    # Returns the debounce period as set by BrickletJoystick#set_debounce_period.
+    def get_debounce_period
+      send_request(FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 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 identifiers can be found :ref:`here <device_identifier>`.
+    # 
+    # .. versionadded:: 2.0.0~(Plugin)
+    def get_identity
+      send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
+    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

data/lib/tinkerforge/bricklet_lcd_16x2.rb

@@ -0,0 +1,175 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2013-05-16.      #
+#                                                           #
+# Bindings Version 2.0.7                                    #
+#                                                           #
+# 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 generator git on tinkerforge.com                   #
+#############################################################
+
+module Tinkerforge
+  # Device for controlling a LCD with 2 lines a 16 characters
+  class BrickletLCD16x2 < Device
+    DEVICE_IDENTIFIER = 211 # :nodoc:
+
+    # This callback is triggered when a button is pressed. The parameter is
+    # the number of the button (0 to 2).
+    CALLBACK_BUTTON_PRESSED = 9
+
+    # This callback is triggered when a button is released. The parameter is
+    # the number of the button (0 to 2).
+    CALLBACK_BUTTON_RELEASED = 10
+
+    FUNCTION_WRITE_LINE = 1 # :nodoc:
+    FUNCTION_CLEAR_DISPLAY = 2 # :nodoc:
+    FUNCTION_BACKLIGHT_ON = 3 # :nodoc:
+    FUNCTION_BACKLIGHT_OFF = 4 # :nodoc:
+    FUNCTION_IS_BACKLIGHT_ON = 5 # :nodoc:
+    FUNCTION_SET_CONFIG = 6 # :nodoc:
+    FUNCTION_GET_CONFIG = 7 # :nodoc:
+    FUNCTION_IS_BUTTON_PRESSED = 8 # :nodoc:
+    FUNCTION_SET_CUSTOM_CHARACTER = 11 # :nodoc:
+    FUNCTION_GET_CUSTOM_CHARACTER = 12 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :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_WRITE_LINE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_CLEAR_DISPLAY] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_BACKLIGHT_ON] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_BACKLIGHT_OFF] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_IS_BACKLIGHT_ON] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_IS_BUTTON_PRESSED] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_BUTTON_PRESSED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_BUTTON_RELEASED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_SET_CUSTOM_CHARACTER] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_CUSTOM_CHARACTER] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_BUTTON_PRESSED] = 'C'
+      @callback_formats[CALLBACK_BUTTON_RELEASED] = 'C'
+    end
+
+    # Writes text to a specific line (0 to 1) with a specific position 
+    # (0 to 15). The text can have a maximum of 16 characters.
+    # 
+    # For example: (0, 5, "Hello") will write *Hello* in the middle of the
+    # first line of the display.
+    # 
+    # The display uses a special charset that includes all ASCII characters except
+    # backslash and tilde. The LCD charset also includes several other non-ASCII characters, see
+    # the `charset specification <https://github.com/Tinkerforge/lcd-16x2-bricklet/raw/master/datasheets/standard_charset.pdf>`__
+    # for details. The Unicode example above shows how to specify non-ASCII characters
+    # and how to translate from Unicode to the LCD charset.
+    def write_line(line, position, text)
+      send_request(FUNCTION_WRITE_LINE, [line, position, text], 'C C Z16', 0, '')
+    end
+
+    # Deletes all characters from the display.
+    def clear_display
+      send_request(FUNCTION_CLEAR_DISPLAY, [], '', 0, '')
+    end
+
+    # Turns the backlight on.
+    def backlight_on
+      send_request(FUNCTION_BACKLIGHT_ON, [], '', 0, '')
+    end
+
+    # Turns the backlight off.
+    def backlight_off
+      send_request(FUNCTION_BACKLIGHT_OFF, [], '', 0, '')
+    end
+
+    # Returns *true* if the backlight is on and *false* otherwise.
+    def is_backlight_on
+      send_request(FUNCTION_IS_BACKLIGHT_ON, [], '', 1, '?')
+    end
+
+    # Configures if the cursor (shown as "_") should be visible and if it
+    # should be blinking (shown as a blinking block). The cursor position
+    # is one character behind the the last text written with 
+    # BrickletLCD16x2#write_line.
+    # 
+    # The default is (false, false).
+    def set_config(cursor, blinking)
+      send_request(FUNCTION_SET_CONFIG, [cursor, blinking], '? ?', 0, '')
+    end
+
+    # Returns the configuration as set by BrickletLCD16x2#set_config.
+    def get_config
+      send_request(FUNCTION_GET_CONFIG, [], '', 2, '? ?')
+    end
+
+    # Returns *true* if the button (0 to 2) is pressed. If you want to react
+    # on button presses and releases it is recommended to use the
+    # CALLBACK_BUTTON_PRESSED and CALLBACK_BUTTON_RELEASED callbacks.
+    def is_button_pressed(button)
+      send_request(FUNCTION_IS_BUTTON_PRESSED, [button], 'C', 1, '?')
+    end
+
+    # The LCD 16x2 Bricklet can store up to 8 custom characters. The characters
+    # consist of 5x8 pixels and can be addressed with the index 0-7. To describe
+    # the pixels, the first 5 bits of 8 bytes are used. For example, to make
+    # a custom character "H", you should transfer the following:
+    # 
+    # * character[0] = 0b00010001 (decimal value 17)
+    # * character[1] = 0b00010001 (decimal value 17)
+    # * character[2] = 0b00010001 (decimal value 17)
+    # * character[3] = 0b00011111 (decimal value 31)
+    # * character[4] = 0b00010001 (decimal value 17)
+    # * character[5] = 0b00010001 (decimal value 17)
+    # * character[6] = 0b00010001 (decimal value 17)
+    # * character[7] = 0b00000000 (decimal value 0)
+    # 
+    # The characters can later be written with BrickletLCD16x2#write_line by using the
+    # characters with the byte representation 8 to 15.
+    # 
+    # You can play around with the custom characters in Brick Viewer version
+    # >= 2.0.1.
+    # 
+    # Custom characters are stored by the LCD in RAM, so they have to be set
+    # after each startup.
+    # 
+    # .. versionadded:: 2.0.1~(Plugin)
+    def set_custom_character(index, character)
+      send_request(FUNCTION_SET_CUSTOM_CHARACTER, [index, character], 'C C8', 0, '')
+    end
+
+    # Returns the custom character for a given index, as set with
+    # BrickletLCD16x2#set_custom_character.
+    # 
+    # .. versionadded:: 2.0.1~(Plugin)
+    def get_custom_character(index)
+      send_request(FUNCTION_GET_CUSTOM_CHARACTER, [index], 'C', 8, 'C8')
+    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 identifiers can be found :ref:`here <device_identifier>`.
+    # 
+    # .. versionadded:: 2.0.0~(Plugin)
+    def get_identity
+      send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
+    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

data/lib/tinkerforge/bricklet_lcd_20x4.rb

@@ -0,0 +1,231 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2013-05-16.      #
+#                                                           #
+# Bindings Version 2.0.7                                    #
+#                                                           #
+# 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 generator git on tinkerforge.com                   #
+#############################################################
+
+module Tinkerforge
+  # Device for controlling a LCD with 4 lines a 20 characters
+  class BrickletLCD20x4 < Device
+    DEVICE_IDENTIFIER = 212 # :nodoc:
+
+    # This callback is triggered when a button is pressed. The parameter is
+    # the number of the button (0 to 2 or 0 to 3 with hardware version >= 1.2).
+    CALLBACK_BUTTON_PRESSED = 9
+
+    # This callback is triggered when a button is released. The parameter is
+    # the number of the button (0 to 2 or 0 to 3 with hardware version >= 1.2).
+    CALLBACK_BUTTON_RELEASED = 10
+
+    FUNCTION_WRITE_LINE = 1 # :nodoc:
+    FUNCTION_CLEAR_DISPLAY = 2 # :nodoc:
+    FUNCTION_BACKLIGHT_ON = 3 # :nodoc:
+    FUNCTION_BACKLIGHT_OFF = 4 # :nodoc:
+    FUNCTION_IS_BACKLIGHT_ON = 5 # :nodoc:
+    FUNCTION_SET_CONFIG = 6 # :nodoc:
+    FUNCTION_GET_CONFIG = 7 # :nodoc:
+    FUNCTION_IS_BUTTON_PRESSED = 8 # :nodoc:
+    FUNCTION_SET_CUSTOM_CHARACTER = 11 # :nodoc:
+    FUNCTION_GET_CUSTOM_CHARACTER = 12 # :nodoc:
+    FUNCTION_SET_DEFAULT_TEXT = 13 # :nodoc:
+    FUNCTION_GET_DEFAULT_TEXT = 14 # :nodoc:
+    FUNCTION_SET_DEFAULT_TEXT_COUNTER = 15 # :nodoc:
+    FUNCTION_GET_DEFAULT_TEXT_COUNTER = 16 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :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_WRITE_LINE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_CLEAR_DISPLAY] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_BACKLIGHT_ON] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_BACKLIGHT_OFF] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_IS_BACKLIGHT_ON] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_IS_BUTTON_PRESSED] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_BUTTON_PRESSED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_BUTTON_RELEASED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_SET_CUSTOM_CHARACTER] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_CUSTOM_CHARACTER] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_DEFAULT_TEXT] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_DEFAULT_TEXT] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_DEFAULT_TEXT_COUNTER] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_DEFAULT_TEXT_COUNTER] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_BUTTON_PRESSED] = 'C'
+      @callback_formats[CALLBACK_BUTTON_RELEASED] = 'C'
+    end
+
+    # Writes text to a specific line (0 to 3) with a specific position 
+    # (0 to 19). The text can have a maximum of 20 characters.
+    # 
+    # For example: (0, 7, "Hello") will write *Hello* in the middle of the
+    # first line of the display.
+    # 
+    # The display uses a special charset that includes all ASCII characters except
+    # backslash and tilde. The LCD charset also includes several other non-ASCII characters, see
+    # the `charset specification <https://github.com/Tinkerforge/lcd-20x4-bricklet/raw/master/datasheets/standard_charset.pdf>`__
+    # for details. The Unicode example above shows how to specify non-ASCII characters
+    # and how to translate from Unicode to the LCD charset.
+    def write_line(line, position, text)
+      send_request(FUNCTION_WRITE_LINE, [line, position, text], 'C C Z20', 0, '')
+    end
+
+    # Deletes all characters from the display.
+    def clear_display
+      send_request(FUNCTION_CLEAR_DISPLAY, [], '', 0, '')
+    end
+
+    # Turns the backlight on.
+    def backlight_on
+      send_request(FUNCTION_BACKLIGHT_ON, [], '', 0, '')
+    end
+
+    # Turns the backlight off.
+    def backlight_off
+      send_request(FUNCTION_BACKLIGHT_OFF, [], '', 0, '')
+    end
+
+    # Returns *true* if the backlight is on and *false* otherwise.
+    def is_backlight_on
+      send_request(FUNCTION_IS_BACKLIGHT_ON, [], '', 1, '?')
+    end
+
+    # Configures if the cursor (shown as "_") should be visible and if it
+    # should be blinking (shown as a blinking block). The cursor position
+    # is one character behind the the last text written with 
+    # BrickletLCD20x4#write_line.
+    # 
+    # The default is (false, false).
+    def set_config(cursor, blinking)
+      send_request(FUNCTION_SET_CONFIG, [cursor, blinking], '? ?', 0, '')
+    end
+
+    # Returns the configuration as set by BrickletLCD20x4#set_config.
+    def get_config
+      send_request(FUNCTION_GET_CONFIG, [], '', 2, '? ?')
+    end
+
+    # Returns *true* if the button (0 to 2 or 0 to 3 with hardware version >= 1.2) 
+    # is pressed. If you want to react
+    # on button presses and releases it is recommended to use the
+    # CALLBACK_BUTTON_PRESSED and CALLBACK_BUTTON_RELEASED callbacks.
+    def is_button_pressed(button)
+      send_request(FUNCTION_IS_BUTTON_PRESSED, [button], 'C', 1, '?')
+    end
+
+    # The LCD 20x4 Bricklet can store up to 8 custom characters. The characters
+    # consist of 5x8 pixels and can be addressed with the index 0-7. To describe
+    # the pixels, the first 5 bits of 8 bytes are used. For example, to make
+    # a custom character "H", you should transfer the following:
+    # 
+    # * character[0] = 0b00010001 (decimal value 17)
+    # * character[1] = 0b00010001 (decimal value 17)
+    # * character[2] = 0b00010001 (decimal value 17)
+    # * character[3] = 0b00011111 (decimal value 31)
+    # * character[4] = 0b00010001 (decimal value 17)
+    # * character[5] = 0b00010001 (decimal value 17)
+    # * character[6] = 0b00010001 (decimal value 17)
+    # * character[7] = 0b00000000 (decimal value 0)
+    # 
+    # The characters can later be written with BrickletLCD20x4#write_line by using the
+    # characters with the byte representation 8 to 15.
+    # 
+    # You can play around with the custom characters in Brick Viewer version
+    # >= 2.0.1.
+    # 
+    # Custom characters are stored by the LCD in RAM, so they have to be set
+    # after each startup.
+    # 
+    # .. versionadded:: 2.0.1~(Plugin)
+    def set_custom_character(index, character)
+      send_request(FUNCTION_SET_CUSTOM_CHARACTER, [index, character], 'C C8', 0, '')
+    end
+
+    # Returns the custom character for a given index, as set with
+    # BrickletLCD20x4#set_custom_character.
+    # 
+    # .. versionadded:: 2.0.1~(Plugin)
+    def get_custom_character(index)
+      send_request(FUNCTION_GET_CUSTOM_CHARACTER, [index], 'C', 8, 'C8')
+    end
+
+    # Sets the default text for lines 0-3. The max number of characters
+    # per line is 20.
+    # 
+    # The default text is shown on the LCD, if the default text counter
+    # expires, see BrickletLCD20x4#set_default_text_counter.
+    # 
+    # .. versionadded:: 2.0.2~(Plugin)
+    def set_default_text(line, text)
+      send_request(FUNCTION_SET_DEFAULT_TEXT, [line, text], 'C Z20', 0, '')
+    end
+
+    # Returns the default text for a given line (0-3) as set by
+    # BrickletLCD20x4#set_default_text.
+    # 
+    # .. versionadded:: 2.0.2~(Plugin)
+    def get_default_text(line)
+      send_request(FUNCTION_GET_DEFAULT_TEXT, [line], 'C', 20, 'Z20')
+    end
+
+    # Sets the default text counter in ms. This counter is decremented each
+    # ms by the LCD firmware. If the counter reaches 0, the default text
+    # (see BrickletLCD20x4#set_default_text) is shown on the LCD.
+    # 
+    # This functionality can be used to show a default text if the controlling
+    # program crashes or the connection is interrupted.
+    # 
+    # A possible approach is to call BrickletLCD20x4#set_default_text_counter every
+    # minute with the parameter 1000*60*2 (2 minutes). In this case the
+    # default text will be shown no later than 2 minutes after the
+    # controlling program crashes.
+    # 
+    # A negative counter turns the default text functionality off.
+    # 
+    # The default is -1.
+    # 
+    # .. versionadded:: 2.0.2~(Plugin)
+    def set_default_text_counter(counter)
+      send_request(FUNCTION_SET_DEFAULT_TEXT_COUNTER, [counter], 'l', 0, '')
+    end
+
+    # Returns the current value of the default text counter.
+    # 
+    # .. versionadded:: 2.0.2~(Plugin)
+    def get_default_text_counter
+      send_request(FUNCTION_GET_DEFAULT_TEXT_COUNTER, [], '', 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 identifiers can be found :ref:`here <device_identifier>`.
+    # 
+    # .. versionadded:: 2.0.0~(Plugin)
+    def get_identity
+      send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
+    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