tinkerforge 2.0.7

data/lib/tinkerforge/bricklet_analog_out.rb

@@ -0,0 +1,90 @@
+# -*- 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 output of voltage between 0 and 5V
+  class BrickletAnalogOut < Device
+    DEVICE_IDENTIFIER = 220 # :nodoc:
+
+    FUNCTION_SET_VOLTAGE = 1 # :nodoc:
+    FUNCTION_GET_VOLTAGE = 2 # :nodoc:
+    FUNCTION_SET_MODE = 3 # :nodoc:
+    FUNCTION_GET_MODE = 4 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :nodoc:
+
+    MODE_ANALOG_VALUE = 0 # :nodoc:
+    MODE_1K_TO_GROUND = 1 # :nodoc:
+    MODE_100K_TO_GROUND = 2 # :nodoc:
+    MODE_500K_TO_GROUND = 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_VOLTAGE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_VOLTAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_MODE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+    end
+
+    # Sets the voltage in mV. The possible range is 0V to 5V (0-5000).
+    # Calling this function will set the mode to 0 (see BrickletAnalogOut#set_mode).
+    # 
+    # The default value is 0 (with mode 1).
+    def set_voltage(voltage)
+      send_request(FUNCTION_SET_VOLTAGE, [voltage], 'S', 0, '')
+    end
+
+    # Returns the voltage as set by BrickletAnalogOut#set_voltage.
+    def get_voltage
+      send_request(FUNCTION_GET_VOLTAGE, [], '', 2, 'S')
+    end
+
+    # Sets the mode of the analog value. Possible modes:
+    # 
+    # * 0: Normal Mode (Analog value as set by BrickletAnalogOut#set_voltage is applied)
+    # * 1: 1k Ohm resistor to ground
+    # * 2: 100k Ohm resistor to ground
+    # * 3: 500k Ohm resistor to ground
+    # 
+    # Setting the mode to 0 will result in an output voltage of 0. You can jump
+    # to a higher output voltage directly by calling BrickletAnalogOut#set_voltage.
+    # 
+    # The default mode is 1.
+    def set_mode(mode)
+      send_request(FUNCTION_SET_MODE, [mode], 'C', 0, '')
+    end
+
+    # Returns the mode as set by BrickletAnalogOut#set_mode.
+    def get_mode
+      send_request(FUNCTION_GET_MODE, [], '', 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
+
+  end
+end

data/lib/tinkerforge/bricklet_barometer.rb

@@ -0,0 +1,313 @@
+# -*- 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 sensing air pressure and altitude changes
+  class BrickletBarometer < Device
+    DEVICE_IDENTIFIER = 221 # :nodoc:
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletBarometer#set_air_pressure_callback_period. The parameter is the air pressure of the
+    # air pressure sensor.
+    # 
+    # CALLBACK_AIR_PRESSURE is only triggered if the air pressure has changed since the
+    # last triggering.
+    CALLBACK_AIR_PRESSURE = 15
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletBarometer#set_altitude_callback_period. The parameter is the altitude of the
+    # air pressure sensor.
+    # 
+    # CALLBACK_ALTITUDE is only triggered if the altitude has changed since the
+    # last triggering.
+    CALLBACK_ALTITUDE = 16
+
+    # This callback is triggered when the threshold as set by
+    # BrickletBarometer#set_air_pressure_callback_threshold is reached.
+    # The parameter is the air pressure of the air pressure sensor.
+    # 
+    # If the threshold keeps being reached, the callback is triggered periodically
+    # with the period as set by BrickletBarometer#set_debounce_period.
+    CALLBACK_AIR_PRESSURE_REACHED = 17
+
+    # This callback is triggered when the threshold as set by
+    # BrickletBarometer#set_altitude_callback_threshold is reached.
+    # The parameter is the altitude of the air pressure sensor.
+    # 
+    # If the threshold keeps being reached, the callback is triggered periodically
+    # with the period as set by BrickletBarometer#set_debounce_period.
+    CALLBACK_ALTITUDE_REACHED = 18
+
+    FUNCTION_GET_AIR_PRESSURE = 1 # :nodoc:
+    FUNCTION_GET_ALTITUDE = 2 # :nodoc:
+    FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3 # :nodoc:
+    FUNCTION_GET_AIR_PRESSURE_CALLBACK_PERIOD = 4 # :nodoc:
+    FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5 # :nodoc:
+    FUNCTION_GET_ALTITUDE_CALLBACK_PERIOD = 6 # :nodoc:
+    FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7 # :nodoc:
+    FUNCTION_GET_AIR_PRESSURE_CALLBACK_THRESHOLD = 8 # :nodoc:
+    FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9 # :nodoc:
+    FUNCTION_GET_ALTITUDE_CALLBACK_THRESHOLD = 10 # :nodoc:
+    FUNCTION_SET_DEBOUNCE_PERIOD = 11 # :nodoc:
+    FUNCTION_GET_DEBOUNCE_PERIOD = 12 # :nodoc:
+    FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13 # :nodoc:
+    FUNCTION_GET_CHIP_TEMPERATURE = 14 # :nodoc:
+    FUNCTION_GET_REFERENCE_AIR_PRESSURE = 19 # :nodoc:
+    FUNCTION_SET_AVERAGING = 20 # :nodoc:
+    FUNCTION_GET_AVERAGING = 21 # :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, 1]
+
+      @response_expected[FUNCTION_GET_AIR_PRESSURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_ALTITUDE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_AIR_PRESSURE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_ALTITUDE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_AIR_PRESSURE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_ALTITUDE_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[FUNCTION_SET_REFERENCE_AIR_PRESSURE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_AIR_PRESSURE] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_ALTITUDE] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_AIR_PRESSURE_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_ALTITUDE_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_REFERENCE_AIR_PRESSURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_AVERAGING] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_AVERAGING] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_AIR_PRESSURE] = 'l'
+      @callback_formats[CALLBACK_ALTITUDE] = 'l'
+      @callback_formats[CALLBACK_AIR_PRESSURE_REACHED] = 'l'
+      @callback_formats[CALLBACK_ALTITUDE_REACHED] = 'l'
+    end
+
+    # Returns the air pressure of the air pressure sensor. The value
+    # has a range of 10000 to 1200000 and is given in mbar/1000, i.e. a value
+    # of 1001092 means that an air pressure of 1001.092 mbar is measured.
+    # 
+    # If you want to get the air pressure periodically, it is recommended to use the
+    # callback CALLBACK_AIR_PRESSURE and set the period with
+    # BrickletBarometer#set_air_pressure_callback_period.
+    def get_air_pressure
+      send_request(FUNCTION_GET_AIR_PRESSURE, [], '', 4, 'l')
+    end
+
+    # Returns the relative altitude of the air pressure sensor. The value is given in
+    # cm and is calculated based on the difference between the current air pressure
+    # and the reference air pressure that can be set with BrickletBarometer#set_reference_air_pressure.
+    # 
+    # If you want to get the altitude periodically, it is recommended to use the
+    # callback CALLBACK_ALTITUDE and set the period with
+    # BrickletBarometer#set_altitude_callback_period.
+    def get_altitude
+      send_request(FUNCTION_GET_ALTITUDE, [], '', 4, 'l')
+    end
+
+    # Sets the period in ms with which the CALLBACK_AIR_PRESSURE callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_AIR_PRESSURE is only triggered if the air pressure has changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_air_pressure_callback_period(period)
+      send_request(FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletBarometer#set_air_pressure_callback_period.
+    def get_air_pressure_callback_period
+      send_request(FUNCTION_GET_AIR_PRESSURE_CALLBACK_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the period in ms with which the CALLBACK_ALTITUDE callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_ALTITUDE is only triggered if the altitude has changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_altitude_callback_period(period)
+      send_request(FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletBarometer#set_altitude_callback_period.
+    def get_altitude_callback_period
+      send_request(FUNCTION_GET_ALTITUDE_CALLBACK_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the thresholds for the CALLBACK_AIR_PRESSURE_REACHED callback.
+    # 
+    # The following options are possible:
+    # 
+    #  "Option", "Description"
+    # 
+    #  "'x'",    "Callback is turned off"
+    #  "'o'",    "Callback is triggered when the air pressure is *outside* the min and max values"
+    #  "'i'",    "Callback is triggered when the air pressure is *inside* the min and max values"
+    #  "'<'",    "Callback is triggered when the air pressure is smaller than the min value (max is ignored)"
+    #  "'>'",    "Callback is triggered when the air pressure is greater than the min value (max is ignored)"
+    # 
+    # The default value is ('x', 0, 0).
+    def set_air_pressure_callback_threshold(option, min, max)
+      send_request(FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD, [option, min, max], 'k l l', 0, '')
+    end
+
+    # Returns the threshold as set by BrickletBarometer#set_air_pressure_callback_threshold.
+    def get_air_pressure_callback_threshold
+      send_request(FUNCTION_GET_AIR_PRESSURE_CALLBACK_THRESHOLD, [], '', 9, 'k l l')
+    end
+
+    # Sets the thresholds for the CALLBACK_ALTITUDE_REACHED callback.
+    # 
+    # The following options are possible:
+    # 
+    #  "Option", "Description"
+    # 
+    #  "'x'",    "Callback is turned off"
+    #  "'o'",    "Callback is triggered when the altitude is *outside* the min and max values"
+    #  "'i'",    "Callback is triggered when the altitude is *inside* the min and max values"
+    #  "'<'",    "Callback is triggered when the altitude is smaller than the min value (max is ignored)"
+    #  "'>'",    "Callback is triggered when the altitude is greater than the min value (max is ignored)"
+    # 
+    # The default value is ('x', 0, 0).
+    def set_altitude_callback_threshold(option, min, max)
+      send_request(FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD, [option, min, max], 'k l l', 0, '')
+    end
+
+    # Returns the threshold as set by BrickletBarometer#set_altitude_callback_threshold.
+    def get_altitude_callback_threshold
+      send_request(FUNCTION_GET_ALTITUDE_CALLBACK_THRESHOLD, [], '', 9, 'k l l')
+    end
+
+    # Sets the period in ms with which the threshold callbacks
+    # 
+    #  CALLBACK_AIR_PRESSURE_REACHED, CALLBACK_ALTITUDE_REACHED
+    # 
+    # are triggered, if the thresholds
+    # 
+    #  BrickletBarometer#set_air_pressure_callback_threshold, BrickletBarometer#set_altitude_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 BrickletBarometer#set_debounce_period.
+    def get_debounce_period
+      send_request(FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the reference air pressure in mbar/1000 for the altitude calculation.
+    # Setting the reference to the current air pressure results in a calculated
+    # altitude of 0cm. Passing 0 is a shortcut for passing the current air pressure as
+    # reference.
+    # 
+    # Well known reference values are the Q codes
+    # `QNH <http://en.wikipedia.org/wiki/QNH>`__ and
+    # `QFE <http://en.wikipedia.org/wiki/Mean_sea_level_pressure#Mean_sea_level_pressure>`__
+    # used in aviation.
+    # 
+    # The default value is 1013.25mbar.
+    # 
+    # .. versionadded:: 1.1.0~(Plugin)
+    def set_reference_air_pressure(air_pressure)
+      send_request(FUNCTION_SET_REFERENCE_AIR_PRESSURE, [air_pressure], 'l', 0, '')
+    end
+
+    # Returns the temperature of the air pressure sensor. The value
+    # has a range of -4000 to 8500 and is given in °C/100, i.e. a value
+    # of 2007 means that a temperature of 20.07 °C is measured.
+    # 
+    # This temperature is used internally for temperature compensation of the air
+    # pressure measurement. It is not as accurate as the temperature measured by the
+    # :ref:`temperature_bricklet` or the :ref:`temperature_ir_bricklet`.
+    def get_chip_temperature
+      send_request(FUNCTION_GET_CHIP_TEMPERATURE, [], '', 2, 's')
+    end
+
+    # Returns the reference air pressure as set by BrickletBarometer#set_reference_air_pressure.
+    # 
+    # .. versionadded:: 1.1.0~(Plugin)
+    def get_reference_air_pressure
+      send_request(FUNCTION_GET_REFERENCE_AIR_PRESSURE, [], '', 4, 'l')
+    end
+
+    # Sets the different averaging parameters. It is possible to set
+    # the length of a normal averaging for the temperature and pressure,
+    # as well as an additional length of a 
+    # `moving average <http://en.wikipedia.org/wiki/Moving_average>`__ 
+    # for the pressure. The moving average is calculated from the normal 
+    # averages.  There is no moving average for the temperature.
+    # 
+    # The maximum length for the pressure average is 10, for the
+    # temperature average is 255 and for the moving average is 25.
+    # 
+    # Setting the all three parameters to 0 will turn the averaging
+    # completely off. If the averaging is off, there is lots of noise
+    # on the data, but the data is without delay. Thus we recommend
+    # to turn the averaging off if the Barometer Bricklet data is
+    # to be used for sensor fusion with other sensors.
+    # 
+    # The default values are 10 for the normal averages and 25 for the
+    # moving average.
+    # 
+    # .. versionadded:: 2.0.1~(Plugin)
+    def set_averaging(moving_average_pressure, average_pressure, average_temperature)
+      send_request(FUNCTION_SET_AVERAGING, [moving_average_pressure, average_pressure, average_temperature], 'C C C', 0, '')
+    end
+
+    # Returns the averaging configuration as set by BrickletBarometer#set_averaging.
+    # 
+    # .. versionadded:: 2.0.1~(Plugin)
+    def get_averaging
+      send_request(FUNCTION_GET_AVERAGING, [], '', 3, 'C C 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_current12.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
+  # Device for sensing current of up to 12.5A
+  class BrickletCurrent12 < Device
+    DEVICE_IDENTIFIER = 23 # :nodoc:
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletCurrent12#set_current_callback_period. The parameter is the current of the
+    # sensor.
+    # 
+    # CALLBACK_CURRENT is only triggered if the current has changed since the
+    # last triggering.
+    CALLBACK_CURRENT = 15
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletCurrent12#set_analog_value_callback_period. The parameter is the analog value
+    # of the sensor.
+    # 
+    # CALLBACK_ANALOG_VALUE is only triggered if the current has changed since the
+    # last triggering.
+    CALLBACK_ANALOG_VALUE = 16
+
+    # This callback is triggered when the threshold as set by
+    # BrickletCurrent12#set_current_callback_threshold is reached.
+    # The parameter is the current of the sensor.
+    # 
+    # If the threshold keeps being reached, the callback is triggered periodically
+    # with the period as set by BrickletCurrent12#set_debounce_period.
+    CALLBACK_CURRENT_REACHED = 17
+
+    # This callback is triggered when the threshold as set by
+    # BrickletCurrent12#set_analog_value_callback_threshold is reached.
+    # The parameter is the analog value of the sensor.
+    # 
+    # If the threshold keeps being reached, the callback is triggered periodically
+    # with the period as set by BrickletCurrent12#set_debounce_period.
+    CALLBACK_ANALOG_VALUE_REACHED = 18
+
+    # This callback is triggered when an over current is measured
+    # (see BrickletCurrent12#is_over_current).
+    CALLBACK_OVER_CURRENT = 19
+
+    FUNCTION_GET_CURRENT = 1 # :nodoc:
+    FUNCTION_CALIBRATE = 2 # :nodoc:
+    FUNCTION_IS_OVER_CURRENT = 3 # :nodoc:
+    FUNCTION_GET_ANALOG_VALUE = 4 # :nodoc:
+    FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5 # :nodoc:
+    FUNCTION_GET_CURRENT_CALLBACK_PERIOD = 6 # :nodoc:
+    FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7 # :nodoc:
+    FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD = 8 # :nodoc:
+    FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9 # :nodoc:
+    FUNCTION_GET_CURRENT_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_CURRENT] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_CALIBRATE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_IS_OVER_CURRENT] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_CURRENT_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_CURRENT_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_CURRENT_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_CURRENT_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_CURRENT] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_CURRENT_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_ANALOG_VALUE_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_OVER_CURRENT] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_CURRENT] = 's'
+      @callback_formats[CALLBACK_ANALOG_VALUE] = 'S'
+      @callback_formats[CALLBACK_CURRENT_REACHED] = 's'
+      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S'
+      @callback_formats[CALLBACK_OVER_CURRENT] = ''
+    end
+
+    # Returns the current of the sensor. The value is in mA
+    # and between -12500mA and 12500mA.
+    # 
+    # If you want to get the current periodically, it is recommended to use the
+    # callback CALLBACK_CURRENT and set the period with 
+    # BrickletCurrent12#set_current_callback_period.
+    def get_current
+      send_request(FUNCTION_GET_CURRENT, [], '', 2, 's')
+    end
+
+    # Calibrates the 0 value of the sensor. You have to call this function
+    # when there is no current present. 
+    # 
+    # The zero point of the current sensor
+    # is depending on the exact properties of the analog-to-digital converter,
+    # the length of the Bricklet cable and the temperature. Thus, if you change
+    # the Brick or the environment in which the Bricklet is used, you might
+    # have to recalibrate.
+    # 
+    # The resulting calibration will be saved on the EEPROM of the Current
+    # Bricklet.
+    def calibrate
+      send_request(FUNCTION_CALIBRATE, [], '', 0, '')
+    end
+
+    # Returns *true* if more than 12.5A were measured.
+    # 
+    # .. note::
+    #  To reset this value you have to power cycle the Bricklet.
+    def is_over_current
+      send_request(FUNCTION_IS_OVER_CURRENT, [], '', 1, '?')
+    end
+
+    # Returns the value as read by a 12-bit analog-to-digital converter.
+    # The value is between 0 and 4095.
+    # 
+    # .. note::
+    #  The value returned by BrickletCurrent12#get_current is averaged over several samples
+    #  to yield less noise, while BrickletCurrent12#get_analog_value gives back raw
+    #  unfiltered analog values. The only reason to use BrickletCurrent12#get_analog_value is,
+    #  if you need the full resolution of the analog-to-digital converter.
+    # 
+    # If you want the analog value periodically, it is recommended to use the 
+    # callback CALLBACK_ANALOG_VALUE and set the period with 
+    # BrickletCurrent12#set_analog_value_callback_period.
+    def get_analog_value
+      send_request(FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S')
+    end
+
+    # Sets the period in ms with which the CALLBACK_CURRENT callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_CURRENT is only triggered if the current has changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_current_callback_period(period)
+      send_request(FUNCTION_SET_CURRENT_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletCurrent12#set_current_callback_period.
+    def get_current_callback_period
+      send_request(FUNCTION_GET_CURRENT_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 value has 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 BrickletCurrent12#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_CURRENT_REACHED callback. 
+    # 
+    # The following options are possible:
+    # 
+    #  "Option", "Description"
+    # 
+    #  "'x'",    "Callback is turned off"
+    #  "'o'",    "Callback is triggered when the current is *outside* the min and max values"
+    #  "'i'",    "Callback is triggered when the current is *inside* the min and max values"
+    #  "'<'",    "Callback is triggered when the current is smaller than the min value (max is ignored)"
+    #  "'>'",    "Callback is triggered when the current is greater than the min value (max is ignored)"
+    # 
+    # The default value is ('x', 0, 0).
+    def set_current_callback_threshold(option, min, max)
+      send_request(FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 0, '')
+    end
+
+    # Returns the threshold as set by BrickletCurrent12#set_current_callback_threshold.
+    def get_current_callback_threshold
+      send_request(FUNCTION_GET_CURRENT_CALLBACK_THRESHOLD, [], '', 5, 'k 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 value is *outside* the min and max values"
+    #  "'i'",    "Callback is triggered when the analog value is *inside* the min and max values"
+    #  "'<'",    "Callback is triggered when the analog value is smaller than the min value (max is ignored)"
+    #  "'>'",    "Callback is triggered when the analog value is greater than the min value (max is ignored)"
+    # 
+    # The default value is ('x', 0, 0).
+    def set_analog_value_callback_threshold(option, min, max)
+      send_request(FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, '')
+    end
+
+    # Returns the threshold as set by BrickletCurrent12#set_analog_value_callback_threshold.
+    def get_analog_value_callback_threshold
+      send_request(FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD, [], '', 5, 'k S S')
+    end
+
+    # Sets the period in ms with which the threshold callbacks
+    # 
+    #  CALLBACK_CURRENT_REACHED, CALLBACK_ANALOG_VALUE_REACHED
+    # 
+    # are triggered, if the thresholds
+    # 
+    #  BrickletCurrent12#set_current_callback_threshold, BrickletCurrent12#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 BrickletCurrent12#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