tinkerforge 2.0.7

data/lib/tinkerforge/bricklet_dual_relay.rb

@@ -0,0 +1,127 @@
+# -*- 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 two relays
+  class BrickletDualRelay < Device
+    DEVICE_IDENTIFIER = 26 # :nodoc:
+
+    # This callback is triggered whenever a monoflop timer reaches 0. The 
+    # parameter contain the relay (1 or 2) and the current state of the relay 
+    # (the state after the monoflop).
+    # 
+    # .. versionadded:: 1.1.1~(Plugin)
+    CALLBACK_MONOFLOP_DONE = 5
+
+    FUNCTION_SET_STATE = 1 # :nodoc:
+    FUNCTION_GET_STATE = 2 # :nodoc:
+    FUNCTION_SET_MONOFLOP = 3 # :nodoc:
+    FUNCTION_GET_MONOFLOP = 4 # :nodoc:
+    FUNCTION_SET_SELECTED_STATE = 6 # :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_SET_STATE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_MONOFLOP] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_MONOFLOP] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_MONOFLOP_DONE] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_SET_SELECTED_STATE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_MONOFLOP_DONE] = 'C ?'
+    end
+
+    # Sets the state of the relays, *true* means on and *false* means off. 
+    # For example: (true, false) turns relay 1 on and relay 2 off.
+    # 
+    # If you just want to set one of the relays and don't know the current state
+    # 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.
+    # 
+    # The default value is (*false*, *false*).
+    def set_state(relay1, relay2)
+      send_request(FUNCTION_SET_STATE, [relay1, relay2], '? ?', 0, '')
+    end
+
+    # Returns the state of the relays, *true* means on and *false* means off.
+    def get_state
+      send_request(FUNCTION_GET_STATE, [], '', 2, '? ?')
+    end
+
+    # The first parameter can be 1 or 2 (relay 1 or relay 2). The second parameter 
+    # is the desired state of the relay (*true* means on and *false* means off).
+    # The third parameter indicates the time (in ms) that the relay should hold 
+    # the state.
+    # 
+    # If this function is called with the parameters (1, true, 1500):
+    # Relay 1 will turn on and in 1.5s it will turn off again.
+    # 
+    # A monoflop can be used as a failsafe mechanism. For example: Lets assume you 
+    # have a RS485 bus and a Dual Relay Bricklet connected to one of the slave 
+    # stacks. You can now call this function every second, with a time parameter
+    # of two seconds. The relay will be on all the time. If now the RS485 
+    # connection is lost, the relay will turn off in at most two seconds.
+    # 
+    # .. versionadded:: 1.1.1~(Plugin)
+    def set_monoflop(relay, state, time)
+      send_request(FUNCTION_SET_MONOFLOP, [relay, state, time], 'C ? L', 0, '')
+    end
+
+    # Returns (for the given relay) the current state and the time as set by 
+    # BrickletDualRelay#set_monoflop as well as the remaining time until the state flips.
+    # 
+    # If the timer is not running currently, the remaining time will be returned
+    # as 0.
+    # 
+    # .. versionadded:: 1.1.1~(Plugin)
+    def get_monoflop(relay)
+      send_request(FUNCTION_GET_MONOFLOP, [relay], 'C', 9, '? L L')
+    end
+
+    # Sets the state of the selected relay (1 or 2), *true* means on and *false* means off. 
+    # 
+    # The other relay remains untouched.
+    # 
+    # .. versionadded:: 2.0.0~(Plugin)
+    def set_selected_state(relay, state)
+      send_request(FUNCTION_SET_SELECTED_STATE, [relay, state], 'C ?', 0, '')
+    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_gps.rb

@@ -0,0 +1,301 @@
+# -*- 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 receiving GPS position
+  class BrickletGPS < Device
+    DEVICE_IDENTIFIER = 222 # :nodoc:
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletGPS#set_coordinates_callback_period. The parameters are the same
+    # as for BrickletGPS#get_coordinates.
+    # 
+    # CALLBACK_COORDINATES is only triggered if the coordinates changed since the
+    # last triggering and if there is currently a fix as indicated by
+    # BrickletGPS#get_status.
+    CALLBACK_COORDINATES = 17
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletGPS#set_status_callback_period. The parameters are the same
+    # as for BrickletGPS#get_status.
+    # 
+    # CALLBACK_STATUS is only triggered if the status changed since the
+    # last triggering.
+    CALLBACK_STATUS = 18
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletGPS#set_altitude_callback_period. The parameters are the same
+    # as for BrickletGPS#get_altitude.
+    # 
+    # CALLBACK_ALTITUDE is only triggered if the altitude changed since the
+    # last triggering and if there is currently a fix as indicated by
+    # BrickletGPS#get_status.
+    CALLBACK_ALTITUDE = 19
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletGPS#set_motion_callback_period. The parameters are the same
+    # as for BrickletGPS#get_motion.
+    # 
+    # CALLBACK_MOTION is only triggered if the motion changed since the
+    # last triggering and if there is currently a fix as indicated by
+    # BrickletGPS#get_status.
+    CALLBACK_MOTION = 20
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletGPS#set_date_time_callback_period. The parameters are the same
+    # as for BrickletGPS#get_date_time.
+    # 
+    # CALLBACK_DATE_TIME is only triggered if the date or time changed since the
+    # last triggering.
+    CALLBACK_DATE_TIME = 21
+
+    FUNCTION_GET_COORDINATES = 1 # :nodoc:
+    FUNCTION_GET_STATUS = 2 # :nodoc:
+    FUNCTION_GET_ALTITUDE = 3 # :nodoc:
+    FUNCTION_GET_MOTION = 4 # :nodoc:
+    FUNCTION_GET_DATE_TIME = 5 # :nodoc:
+    FUNCTION_RESTART = 6 # :nodoc:
+    FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 7 # :nodoc:
+    FUNCTION_GET_COORDINATES_CALLBACK_PERIOD = 8 # :nodoc:
+    FUNCTION_SET_STATUS_CALLBACK_PERIOD = 9 # :nodoc:
+    FUNCTION_GET_STATUS_CALLBACK_PERIOD = 10 # :nodoc:
+    FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 11 # :nodoc:
+    FUNCTION_GET_ALTITUDE_CALLBACK_PERIOD = 12 # :nodoc:
+    FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 13 # :nodoc:
+    FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD = 14 # :nodoc:
+    FUNCTION_SET_MOTION_CALLBACK_PERIOD = 15 # :nodoc:
+    FUNCTION_GET_MOTION_CALLBACK_PERIOD = 16 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :nodoc:
+
+    FIX_NO_FIX = 1 # :nodoc:
+    FIX_2D_FIX = 2 # :nodoc:
+    FIX_3D_FIX = 3 # :nodoc:
+    RESTART_TYPE_HOT_START = 0 # :nodoc:
+    RESTART_TYPE_WARM_START = 1 # :nodoc:
+    RESTART_TYPE_COLD_START = 2 # :nodoc:
+    RESTART_TYPE_FACTORY_RESET = 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_GET_COORDINATES] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_STATUS] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_ALTITUDE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_MOTION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_DATE_TIME] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_RESTART] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_SET_COORDINATES_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_COORDINATES_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_STATUS_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_STATUS_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_DATE_TIME_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_MOTION_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_MOTION_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_COORDINATES] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_STATUS] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_ALTITUDE] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_MOTION] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_DATE_TIME] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_COORDINATES] = 'L k L k S S S S'
+      @callback_formats[CALLBACK_STATUS] = 'C C C'
+      @callback_formats[CALLBACK_ALTITUDE] = 'L L'
+      @callback_formats[CALLBACK_MOTION] = 'L L'
+      @callback_formats[CALLBACK_DATE_TIME] = 'L L'
+    end
+
+    # Returns the GPS coordinates. Latitude and longitude are given in the
+    # DD.dddddd° format, the value 57123468 means 57.123468°.
+    # The parameter ns and ew are the cardinal directions for
+    # latitude and longitude. Possible values for ns and ew are 'N', 'S', 'E'
+    # and 'W' (north, south, east and west).
+    # 
+    # PDOP, HDOP and VDOP are the dilution of precision (DOP) values. They specify
+    # the additional multiplicative effect of GPS satellite geometry on GPS 
+    # precision. See 
+    # `here <http://en.wikipedia.org/wiki/Dilution_of_precision_(GPS)>`__
+    # for more information. The values are give in hundredths.
+    # 
+    # EPE is the "Estimated Position Error". The EPE is given in cm. This is not the
+    # absolute maximum error, it is the error with a specific confidence. See
+    # `here <http://www.nps.gov/gis/gps/WhatisEPE.html>`__ for more information.
+    # 
+    # This data is only valid if there is currently a fix as indicated by
+    # BrickletGPS#get_status.
+    def get_coordinates
+      send_request(FUNCTION_GET_COORDINATES, [], '', 18, 'L k L k S S S S')
+    end
+
+    # Returns the current fix status, the number of satellites that are in view and
+    # the number of satellites that are currently used.
+    # 
+    # Possible fix status values can be:
+    # 
+    #  "Value", "Description"
+    # 
+    #  "1", "No Fix"
+    #  "2", "2D Fix"
+    #  "3", "3D Fix"
+    def get_status
+      send_request(FUNCTION_GET_STATUS, [], '', 3, 'C C C')
+    end
+
+    # Returns the current altitude and corresponding geoidal separation.
+    # 
+    # Both values are given in cm.
+    # 
+    # This data is only valid if there is currently a fix as indicated by
+    # BrickletGPS#get_status.
+    def get_altitude
+      send_request(FUNCTION_GET_ALTITUDE, [], '', 8, 'L L')
+    end
+
+    # Returns the current course and speed. Course is given in hundredths degree
+    # and speed is given in hundredths km/h. A course of 0° means the Bricklet is
+    # traveling north bound and 90° means it is traveling east bound.
+    # 
+    # Please note that this only returns useful values if an actual movement
+    # is present.
+    # 
+    # This data is only valid if there is currently a fix as indicated by
+    # BrickletGPS#get_status.
+    def get_motion
+      send_request(FUNCTION_GET_MOTION, [], '', 8, 'L L')
+    end
+
+    # Returns the current date and time. The date is
+    # given in the format ddmmyy and the time is given
+    # in the format hhmmss.sss. For example, 140713 means
+    # 14.05.13 as date and 195923568 means 19:59:23.568 as time.
+    def get_date_time
+      send_request(FUNCTION_GET_DATE_TIME, [], '', 8, 'L L')
+    end
+
+    # Restarts the GPS Bricklet, the following restart types are available:
+    # 
+    #  "Value", "Description"
+    # 
+    #  "0", "Hot start (use all available data in the NV store)"
+    #  "1", "Warm start (don't use ephemeris at restart)"
+    #  "2", "Cold start (don't use time, position, almanacs and ephemeris at restart)"
+    #  "3", "Factory reset (clear all system/user configurations at restart)"
+    def restart(restart_type)
+      send_request(FUNCTION_RESTART, [restart_type], 'C', 0, '')
+    end
+
+    # Sets the period in ms with which the CALLBACK_COORDINATES callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_COORDINATES is only triggered if the coordinates changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_coordinates_callback_period(period)
+      send_request(FUNCTION_SET_COORDINATES_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletGPS#set_coordinates_callback_period.
+    def get_coordinates_callback_period
+      send_request(FUNCTION_GET_COORDINATES_CALLBACK_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the period in ms with which the CALLBACK_STATUS callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_STATUS is only triggered if the status changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_status_callback_period(period)
+      send_request(FUNCTION_SET_STATUS_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletGPS#set_status_callback_period.
+    def get_status_callback_period
+      send_request(FUNCTION_GET_STATUS_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 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 BrickletGPS#set_altitude_callback_period.
+    def get_altitude_callback_period
+      send_request(FUNCTION_GET_ALTITUDE_CALLBACK_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the period in ms with which the CALLBACK_DATE_TIME callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_DATE_TIME is only triggered if the date or time changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_date_time_callback_period(period)
+      send_request(FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletGPS#set_date_time_callback_period.
+    def get_date_time_callback_period
+      send_request(FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the period in ms with which the CALLBACK_MOTION callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_MOTION is only triggered if the motion changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_motion_callback_period(period)
+      send_request(FUNCTION_SET_MOTION_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletGPS#set_motion_callback_period.
+    def get_motion_callback_period
+      send_request(FUNCTION_GET_MOTION_CALLBACK_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_humidity.rb

@@ -0,0 +1,245 @@
+# -*- 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 Humidity
+  class BrickletHumidity < Device
+    DEVICE_IDENTIFIER = 27 # :nodoc:
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletHumidity#set_humidity_callback_period. The parameter is the humidity of the
+    # sensor.
+    # 
+    # CALLBACK_HUMIDITY is only triggered if the humidity has changed since the
+    # last triggering.
+    CALLBACK_HUMIDITY = 13
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletHumidity#set_analog_value_callback_period. The parameter is the analog value of the
+    # sensor.
+    # 
+    # CALLBACK_ANALOG_VALUE is only triggered if the humidity has changed since the
+    # last triggering.
+    CALLBACK_ANALOG_VALUE = 14
+
+    # This callback is triggered when the threshold as set by
+    # BrickletHumidity#set_humidity_callback_threshold is reached.
+    # The parameter is the humidity of the sensor.
+    # 
+    # If the threshold keeps being reached, the callback is triggered periodically
+    # with the period as set by BrickletHumidity#set_debounce_period.
+    CALLBACK_HUMIDITY_REACHED = 15
+
+    # This callback is triggered when the threshold as set by
+    # BrickletHumidity#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 BrickletHumidity#set_debounce_period.
+    CALLBACK_ANALOG_VALUE_REACHED = 16
+
+    FUNCTION_GET_HUMIDITY = 1 # :nodoc:
+    FUNCTION_GET_ANALOG_VALUE = 2 # :nodoc:
+    FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD = 3 # :nodoc:
+    FUNCTION_GET_HUMIDITY_CALLBACK_PERIOD = 4 # :nodoc:
+    FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5 # :nodoc:
+    FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD = 6 # :nodoc:
+    FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD = 7 # :nodoc:
+    FUNCTION_GET_HUMIDITY_CALLBACK_THRESHOLD = 8 # :nodoc:
+    FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9 # :nodoc:
+    FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD = 10 # :nodoc:
+    FUNCTION_SET_DEBOUNCE_PERIOD = 11 # :nodoc:
+    FUNCTION_GET_DEBOUNCE_PERIOD = 12 # :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_HUMIDITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_HUMIDITY_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_HUMIDITY_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_HUMIDITY_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_HUMIDITY] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_HUMIDITY_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_ANALOG_VALUE_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_HUMIDITY] = 'S'
+      @callback_formats[CALLBACK_ANALOG_VALUE] = 'S'
+      @callback_formats[CALLBACK_HUMIDITY_REACHED] = 'S'
+      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S'
+    end
+
+    # Returns the humidity of the sensor. The value
+    # has a range of 0 to 1000 and is given in %RH/10 (Relative Humidity), 
+    # i.e. a value of 421 means that a humidity of 42.1 %RH is measured.
+    # 
+    # If you want to get the humidity periodically, it is recommended to use the
+    # callback CALLBACK_HUMIDITY and set the period with 
+    # BrickletHumidity#set_humidity_callback_period.
+    def get_humidity
+      send_request(FUNCTION_GET_HUMIDITY, [], '', 2, 'S')
+    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 BrickletHumidity#get_humidity is averaged over several samples
+    #  to yield less noise, while BrickletHumidity#get_analog_value gives back raw
+    #  unfiltered analog values. The returned humidity value is calibrated for
+    #  room temperatures, if you use the sensor in extreme cold or extreme
+    #  warm environments, you might want to calculate the humidity from
+    #  the analog value yourself. See the `HIH 5030 datasheet
+    #  <https://github.com/Tinkerforge/humidity-bricklet/raw/master/datasheets/hih-5030.pdf>`__.
+    # 
+    # If you want the analog value periodically, it is recommended to use the 
+    # callback CALLBACK_ANALOG_VALUE and set the period with 
+    # BrickletHumidity#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_HUMIDITY callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_HUMIDITY is only triggered if the humidity has changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_humidity_callback_period(period)
+      send_request(FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletHumidity#set_humidity_callback_period.
+    def get_humidity_callback_period
+      send_request(FUNCTION_GET_HUMIDITY_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 BrickletHumidity#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_HUMIDITY_REACHED callback. 
+    # 
+    # The following options are possible:
+    # 
+    #  "Option", "Description"
+    # 
+    #  "'x'",    "Callback is turned off"
+    #  "'o'",    "Callback is triggered when the humidity is *outside* the min and max values"
+    #  "'i'",    "Callback is triggered when the humidity is *inside* the min and max values"
+    #  "'<'",    "Callback is triggered when the humidity is smaller than the min value (max is ignored)"
+    #  "'>'",    "Callback is triggered when the humidity is greater than the min value (max is ignored)"
+    # 
+    # The default value is ('x', 0, 0).
+    def set_humidity_callback_threshold(option, min, max)
+      send_request(FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 0, '')
+    end
+
+    # Returns the threshold as set by BrickletHumidity#set_humidity_callback_threshold.
+    def get_humidity_callback_threshold
+      send_request(FUNCTION_GET_HUMIDITY_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 BrickletHumidity#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_HUMIDITY_REACHED, CALLBACK_ANALOG_VALUE_REACHED
+    # 
+    # are triggered, if the thresholds
+    # 
+    #  BrickletHumidity#set_humidity_callback_threshold, BrickletHumidity#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 BrickletHumidity#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