tinkerforge 2.0.11 → 2.0.12

data/lib/tinkerforge/bricklet_line.rb

@@ -0,0 +1,160 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2013-11-27.      #
+#                                                           #
+# Bindings Version 2.0.12                                    #
+#                                                           #
+# 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 that measures reflectivity to allow following a line
+  class BrickletLine < Device
+    DEVICE_IDENTIFIER = 241 # :nodoc:
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletLine#set_reflectivity_callback_period. The parameter is the reflectivity
+    # of the sensor.
+    # 
+    # CALLBACK_REFLECTIVITY is only triggered if the reflectivity has changed since the
+    # last triggering.
+    CALLBACK_REFLECTIVITY = 8
+
+    # This callback is triggered when the threshold as set by
+    # BrickletLine#set_reflectivity_callback_threshold is reached.
+    # The parameter is the reflectivity of the sensor.
+    # 
+    # If the threshold keeps being reached, the callback is triggered periodically
+    # with the period as set by BrickletLine#set_debounce_period.
+    CALLBACK_REFLECTIVITY_REACHED = 9
+
+    FUNCTION_GET_REFLECTIVITY = 1 # :nodoc:
+    FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD = 2 # :nodoc:
+    FUNCTION_GET_REFLECTIVITY_CALLBACK_PERIOD = 3 # :nodoc:
+    FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD = 4 # :nodoc:
+    FUNCTION_GET_REFLECTIVITY_CALLBACK_THRESHOLD = 5 # :nodoc:
+    FUNCTION_SET_DEBOUNCE_PERIOD = 6 # :nodoc:
+    FUNCTION_GET_DEBOUNCE_PERIOD = 7 # :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_REFLECTIVITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_REFLECTIVITY_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_REFLECTIVITY_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_REFLECTIVITY] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_REFLECTIVITY_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_REFLECTIVITY] = 'S'
+      @callback_formats[CALLBACK_REFLECTIVITY_REACHED] = 'S'
+    end
+
+    # Returns the currently measured reflectivity. The reflectivity is
+    # a value between 0 (not reflective) and 4095 (very reflective).
+    # 
+    # Usually black has a low reflectivity while white has a high
+    # reflectivity.
+    # 
+    # If you want to get the reflectivity periodically, it is recommended 
+    # to use the callback CALLBACK_REFLECTIVITY and set the period with 
+    # BrickletLine#set_reflectivity_callback_period.
+    def get_reflectivity
+      send_request(FUNCTION_GET_REFLECTIVITY, [], '', 2, 'S')
+    end
+
+    # Sets the period in ms with which the CALLBACK_REFLECTIVITY callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_REFLECTIVITY is only triggered if the reflectivity has changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_reflectivity_callback_period(period)
+      send_request(FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletLine#set_reflectivity_callback_period.
+    def get_reflectivity_callback_period
+      send_request(FUNCTION_GET_REFLECTIVITY_CALLBACK_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the thresholds for the CALLBACK_REFLECTIVITY_REACHED callback. 
+    # 
+    # The following options are possible:
+    # 
+    #  "Option", "Description"
+    # 
+    #  "'x'",    "Callback is turned off"
+    #  "'o'",    "Callback is triggered when the reflectivity is *outside* the min and max values"
+    #  "'i'",    "Callback is triggered when the reflectivity is *inside* the min and max values"
+    #  "'<'",    "Callback is triggered when the reflectivity is smaller than the min value (max is ignored)"
+    #  "'>'",    "Callback is triggered when the reflectivity is greater than the min value (max is ignored)"
+    # 
+    # The default value is ('x', 0, 0).
+    def set_reflectivity_callback_threshold(option, min, max)
+      send_request(FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, '')
+    end
+
+    # Returns the threshold as set by BrickletLine#set_reflectivity_callback_threshold.
+    def get_reflectivity_callback_threshold
+      send_request(FUNCTION_GET_REFLECTIVITY_CALLBACK_THRESHOLD, [], '', 5, 'k S S')
+    end
+
+    # Sets the period in ms with which the threshold callback
+    # 
+    # * CALLBACK_REFLECTIVITY_REACHED
+    # 
+    # is triggered, if the threshold
+    # 
+    # * BrickletLine#set_reflectivity_callback_threshold
+    # 
+    # keeps 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 BrickletLine#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_linear_poti.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-09-11.      #
+# This file was automatically generated on 2013-11-27.      #
 #                                                           #
-# Bindings Version 2.0.11                                    #
+# Bindings Version 2.0.12                                    #
 #                                                           #
 # 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_moisture.rb

@@ -0,0 +1,180 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2013-11-27.      #
+#                                                           #
+# Bindings Version 2.0.12                                    #
+#                                                           #
+# 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 sensing Moisture
+  class BrickletMoisture < Device
+    DEVICE_IDENTIFIER = 232 # :nodoc:
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletMoisture#set_moisture_callback_period. The parameter is the moisture value
+    # of the sensor.
+    # 
+    # CALLBACK_MOISTURE is only triggered if the moisture value has changed since the
+    # last triggering.
+    CALLBACK_MOISTURE = 8
+
+    # This callback is triggered when the threshold as set by
+    # BrickletMoisture#set_moisture_callback_threshold is reached.
+    # The parameter is the moisture value of the sensor.
+    # 
+    # If the threshold keeps being reached, the callback is triggered periodically
+    # with the period as set by BrickletMoisture#set_debounce_period.
+    CALLBACK_MOISTURE_REACHED = 9
+
+    FUNCTION_GET_MOISTURE_VALUE = 1 # :nodoc:
+    FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2 # :nodoc:
+    FUNCTION_GET_MOISTURE_CALLBACK_PERIOD = 3 # :nodoc:
+    FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4 # :nodoc:
+    FUNCTION_GET_MOISTURE_CALLBACK_THRESHOLD = 5 # :nodoc:
+    FUNCTION_SET_DEBOUNCE_PERIOD = 6 # :nodoc:
+    FUNCTION_GET_DEBOUNCE_PERIOD = 7 # :nodoc:
+    FUNCTION_SET_MOVING_AVERAGE = 10 # :nodoc:
+    FUNCTION_GET_MOVING_AVERAGE = 11 # :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_MOISTURE_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_MOISTURE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_MOISTURE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_MOISTURE_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_MOISTURE] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_MOISTURE_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_SET_MOVING_AVERAGE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_MOVING_AVERAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_MOISTURE] = 'S'
+      @callback_formats[CALLBACK_MOISTURE_REACHED] = 'S'
+    end
+
+    # Returns the current moisture value. The value has a range of
+    # 0 to 4095. A small value corresponds to little moisture, a big
+    # value corresponds to much moisture.
+    # 
+    # If you want to get the moisture value periodically, it is recommended 
+    # to use the callback CALLBACK_MOISTURE and set the period with 
+    # BrickletMoisture#set_moisture_callback_period.
+    def get_moisture_value
+      send_request(FUNCTION_GET_MOISTURE_VALUE, [], '', 2, 'S')
+    end
+
+    # Sets the period in ms with which the CALLBACK_MOISTURE callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_MOISTURE is only triggered if the moisture value has changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_moisture_callback_period(period)
+      send_request(FUNCTION_SET_MOISTURE_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletMoisture#set_moisture_callback_period.
+    def get_moisture_callback_period
+      send_request(FUNCTION_GET_MOISTURE_CALLBACK_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the thresholds for the CALLBACK_MOISTURE_REACHED callback. 
+    # 
+    # The following options are possible:
+    # 
+    #  "Option", "Description"
+    # 
+    #  "'x'",    "Callback is turned off"
+    #  "'o'",    "Callback is triggered when the moisture value is *outside* the min and max values"
+    #  "'i'",    "Callback is triggered when the moisture value is *inside* the min and max values"
+    #  "'<'",    "Callback is triggered when the moisture value is smaller than the min value (max is ignored)"
+    #  "'>'",    "Callback is triggered when the moisture value is greater than the min value (max is ignored)"
+    # 
+    # The default value is ('x', 0, 0).
+    def set_moisture_callback_threshold(option, min, max)
+      send_request(FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, '')
+    end
+
+    # Returns the threshold as set by BrickletMoisture#set_moisture_callback_threshold.
+    def get_moisture_callback_threshold
+      send_request(FUNCTION_GET_MOISTURE_CALLBACK_THRESHOLD, [], '', 5, 'k S S')
+    end
+
+    # Sets the period in ms with which the threshold callback
+    # 
+    # * CALLBACK_MOISTURE_REACHED
+    # 
+    # is triggered, if the threshold
+    # 
+    # * BrickletMoisture#set_moisture_callback_threshold
+    # 
+    # keeps 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 BrickletMoisture#set_debounce_period.
+    def get_debounce_period
+      send_request(FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the length of a `moving averaging <http://en.wikipedia.org/wiki/Moving_average>`__ 
+    # for the moisture value.
+    # 
+    # Setting the length to 0 will turn the averaging completely off. With less
+    # averaging, there is more noise on the data.
+    # 
+    # The range for the averaging is 0-100.
+    # 
+    # The default value is 100.
+    def set_moving_average(average)
+      send_request(FUNCTION_SET_MOVING_AVERAGE, [average], 'C', 0, '')
+    end
+
+    # Returns the length moving average as set by BrickletMoisture#set_moving_average.
+    def get_moving_average
+      send_request(FUNCTION_GET_MOVING_AVERAGE, [], '', 1, 'C')
+    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_motion_detector.rb

@@ -0,0 +1,73 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2013-11-27.      #
+#                                                           #
+# Bindings Version 2.0.12                                    #
+#                                                           #
+# 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 that reads out PIR motion detector
+  class BrickletMotionDetector < Device
+    DEVICE_IDENTIFIER = 233 # :nodoc:
+
+    # This callback is called after a motion was detected.
+    CALLBACK_MOTION_DETECTED = 2
+
+    # This callback is called when the detection cycle ended. When this
+    # callback is called, a new motion can be detected again after approximately 2
+    # seconds.
+    CALLBACK_DETECTION_CYCLE_ENDED = 3
+
+    FUNCTION_GET_MOTION_DETECTED = 1 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :nodoc:
+
+    MOTION_NOT_DETECTED = 0 # :nodoc:
+    MOTION_DETECTED = 1 # :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_MOTION_DETECTED] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_MOTION_DETECTED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_DETECTION_CYCLE_ENDED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_MOTION_DETECTED] = ''
+      @callback_formats[CALLBACK_DETECTION_CYCLE_ENDED] = ''
+    end
+
+    # Returns 1 if a motion was detected. How long this returns 1 after a motion
+    # was detected can be adjusted with one of the small potentiometers on the
+    # Motion Detector Bricklet, see :ref:`here <motion_detector_bricklet_sensitivity_delay_block_time>`.
+    def get_motion_detected
+      send_request(FUNCTION_GET_MOTION_DETECTED, [], '', 1, 'C')
+    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_multi_touch.rb

@@ -0,0 +1,143 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2013-11-27.      #
+#                                                           #
+# Bindings Version 2.0.12                                    #
+#                                                           #
+# 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 with 12 touch sensors
+  class BrickletMultiTouch < Device
+    DEVICE_IDENTIFIER = 234 # :nodoc:
+
+    # Returns the current touch state, see BrickletMultiTouch#get_touch_state for
+    # information about the state.
+    # 
+    # This callback is triggered every time the touch state changes.
+    CALLBACK_TOUCH_STATE = 5
+
+    FUNCTION_GET_TOUCH_STATE = 1 # :nodoc:
+    FUNCTION_RECALIBRATE = 2 # :nodoc:
+    FUNCTION_SET_ELECTRODE_CONFIG = 3 # :nodoc:
+    FUNCTION_GET_ELECTRODE_CONFIG = 4 # :nodoc:
+    FUNCTION_SET_ELECTRODE_SENSITIVITY = 6 # :nodoc:
+    FUNCTION_GET_ELECTRODE_SENSITIVITY = 7 # :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_GET_TOUCH_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_RECALIBRATE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_SET_ELECTRODE_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_ELECTRODE_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_TOUCH_STATE] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_SET_ELECTRODE_SENSITIVITY] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_ELECTRODE_SENSITIVITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_TOUCH_STATE] = 'S'
+    end
+
+    # Returns the current touch state. The state is given as a bitfield.
+    # 
+    # Bits 0 to 11 represent the 12 electrodes and bit 12 represents
+    # the proximity.
+    # 
+    # If an electrode is touched, the corresponding bit is true. If
+    # a hand or similar is in proximity to the electrodes, bit 12 is
+    # *true*.
+    # 
+    # Example: The state 4103 = 0x1007 = 0b1000000000111 means that
+    # electrodes 0, 1 and 2 are touched and that something is in the
+    # proximity of the electrodes.
+    # 
+    # The proximity is activated with a distance of 1-2cm. An electrode
+    # is already counted as touched if a finger is nearly touching the
+    # electrode. This means that you can put a piece of paper or foil
+    # or similar on top of a electrode to build a touch panel with
+    # a professional look.
+    def get_touch_state
+      send_request(FUNCTION_GET_TOUCH_STATE, [], '', 2, 'S')
+    end
+
+    # Recalibrates the electrodes. Call this function whenever you changed
+    # or moved you electrodes.
+    def recalibrate
+      send_request(FUNCTION_RECALIBRATE, [], '', 0, '')
+    end
+
+    # Enables/disables electrodes with a bitfield (see BrickletMultiTouch#get_touch_state).
+    # 
+    # *True* enables the electrode, *false* disables the electrode. A
+    # disabled electrode will always return *false* as its state. If you
+    # don't need all electrodes you can disable the electrodes that are
+    # not needed.
+    # 
+    # It is recommended that you disable the proximity bit (bit 12) if
+    # the proximity feature is not needed. This will reduce the amount of
+    # traffic that is produced by the CALLBACK_TOUCH_STATE callback.
+    # 
+    # Disabling electrodes will also reduce power consumption.
+    # 
+    # Default: 8191 = 0x1FFF = 0b1111111111111 (all electrodes enabled)
+    def set_electrode_config(enabled_electrodes)
+      send_request(FUNCTION_SET_ELECTRODE_CONFIG, [enabled_electrodes], 'S', 0, '')
+    end
+
+    # Returns the electrode configuration, as set by BrickletMultiTouch#set_electrode_config.
+    def get_electrode_config
+      send_request(FUNCTION_GET_ELECTRODE_CONFIG, [], '', 2, 'S')
+    end
+
+    # Sets the sensitivity of the electrodes. An electrode with a high sensitivity
+    # will register a touch earlier then an electrode with a low sensitivity.
+    # 
+    # If you build a big electrode you might need to decrease the sensitivity, since
+    # the area that can be charged will get bigger. If you want to be able to
+    # activate an electrode from further away you need to increase the sensitivity.
+    # 
+    # After a new sensitivity is set, you likely want to call BrickletMultiTouch#recalibrate
+    # to calibrate the electrodes with the newly defined sensitivity.
+    # 
+    # The valid sensitivity value range is 5-201.
+    # 
+    # The default sensitivity value is 181.
+    def set_electrode_sensitivity(sensitivity)
+      send_request(FUNCTION_SET_ELECTRODE_SENSITIVITY, [sensitivity], 'C', 0, '')
+    end
+
+    # Returns the current sensitivity, as set by BrickletMultiTouch#set_electrode_sensitivity.
+    def get_electrode_sensitivity
+      send_request(FUNCTION_GET_ELECTRODE_SENSITIVITY, [], '', 1, 'C')
+    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