tinkerforge 2.0.11 → 2.0.12

data/lib/tinkerforge/brick_dc.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/brick_imu.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/brick_master.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/brick_servo.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  #
@@ -212,7 +212,7 @@ module Tinkerforge
     end
 
     # Sets the output voltages with which the servos are driven in mV.
-    # The minimum output voltage is 5000mV and the maximum output voltage is 
+    # The minimum output voltage is 2000mV and the maximum output voltage is 
     # 9000mV.
     # 
     # .. note::

data/lib/tinkerforge/brick_stepper.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_ambient_light.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_analog_in.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_analog_out.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_barometer.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_current12.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_current25.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_distance_ir.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_distance_us.rb

@@ -0,0 +1,183 @@
+# -*- 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 distance via ultrasound
+  class BrickletDistanceUS < Device
+    DEVICE_IDENTIFIER = 229 # :nodoc:
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletDistanceUS#set_distance_callback_period. The parameter is the distance value
+    # of the sensor.
+    # 
+    # CALLBACK_DISTANCE is only triggered if the distance value has changed since the
+    # last triggering.
+    CALLBACK_DISTANCE = 8
+
+    # This callback is triggered when the threshold as set by
+    # BrickletDistanceUS#set_distance_callback_threshold is reached.
+    # The parameter is the distance value of the sensor.
+    # 
+    # If the threshold keeps being reached, the callback is triggered periodically
+    # with the period as set by BrickletDistanceUS#set_debounce_period.
+    CALLBACK_DISTANCE_REACHED = 9
+
+    FUNCTION_GET_DISTANCE_VALUE = 1 # :nodoc:
+    FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2 # :nodoc:
+    FUNCTION_GET_DISTANCE_CALLBACK_PERIOD = 3 # :nodoc:
+    FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4 # :nodoc:
+    FUNCTION_GET_DISTANCE_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_DISTANCE_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_DISTANCE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_DISTANCE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_DISTANCE_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_DISTANCE] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_DISTANCE_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_DISTANCE] = 'S'
+      @callback_formats[CALLBACK_DISTANCE_REACHED] = 'S'
+    end
+
+    # Returns the current distance value measured by the sensor. The value has a
+    # range of 0 to 4095. A small value corresponds to a small distance, a big
+    # value corresponds to a big distance. The relation between the measured distance
+    # value and the actual distance is affected by the 5V supply voltage (deviations
+    # in the supply voltage result in deviations in the distance values) and is
+    # non-linear (resolution is bigger at close range).
+    # 
+    # If you want to get the distance value periodically, it is recommended to
+    # use the callback CALLBACK_DISTANCE and set the period with 
+    # BrickletDistanceUS#set_distance_callback_period.
+    def get_distance_value
+      send_request(FUNCTION_GET_DISTANCE_VALUE, [], '', 2, 'S')
+    end
+
+    # Sets the period in ms with which the CALLBACK_DISTANCE callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_DISTANCE is only triggered if the distance value has changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_distance_callback_period(period)
+      send_request(FUNCTION_SET_DISTANCE_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletDistanceUS#set_distance_callback_period.
+    def get_distance_callback_period
+      send_request(FUNCTION_GET_DISTANCE_CALLBACK_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the thresholds for the CALLBACK_DISTANCE_REACHED callback. 
+    # 
+    # The following options are possible:
+    # 
+    #  "Option", "Description"
+    # 
+    #  "'x'",    "Callback is turned off"
+    #  "'o'",    "Callback is triggered when the distance value is *outside* the min and max values"
+    #  "'i'",    "Callback is triggered when the distance value is *inside* the min and max values"
+    #  "'<'",    "Callback is triggered when the distance value is smaller than the min value (max is ignored)"
+    #  "'>'",    "Callback is triggered when the distance value is greater than the min value (max is ignored)"
+    # 
+    # The default value is ('x', 0, 0).
+    def set_distance_callback_threshold(option, min, max)
+      send_request(FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 0, '')
+    end
+
+    # Returns the threshold as set by BrickletDistanceUS#set_distance_callback_threshold.
+    def get_distance_callback_threshold
+      send_request(FUNCTION_GET_DISTANCE_CALLBACK_THRESHOLD, [], '', 5, 'k s s')
+    end
+
+    # Sets the period in ms with which the threshold callbacks
+    # 
+    # * CALLBACK_DISTANCE_REACHED,
+    # 
+    # are triggered, if the thresholds
+    # 
+    # * BrickletDistanceUS#set_distance_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 BrickletDistanceUS#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 distance 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 20.
+    def set_moving_average(average)
+      send_request(FUNCTION_SET_MOVING_AVERAGE, [average], 'C', 0, '')
+    end
+
+    # Returns the length moving average as set by BrickletDistanceUS#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_dual_button.rb

@@ -0,0 +1,123 @@
+# -*- 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 two buttons and two LEDs
+  class BrickletDualButton < Device
+    DEVICE_IDENTIFIER = 230 # :nodoc:
+
+    # This callback is called whenever a button is pressed. 
+    # 
+    # Possible states for buttons are:
+    # 
+    # * 0 = pressed
+    # * 1 = released
+    # 
+    # Possible states for LEDs are:
+    # 
+    # * 0 = AutoToggleOn: Auto toggle enabled and LED on.
+    # * 1 = AutoToggleOff: Auto toggle enabled and LED off.
+    # * 2 = On: LED on (auto toggle is disabled).
+    # * 3 = Off: LED off (auto toggle is disabled).
+    CALLBACK_STATE_CHANGED = 4
+
+    FUNCTION_SET_LED_STATE = 1 # :nodoc:
+    FUNCTION_GET_LED_STATE = 2 # :nodoc:
+    FUNCTION_GET_BUTTON_STATE = 3 # :nodoc:
+    FUNCTION_SET_SELECTED_LED_STATE = 5 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :nodoc:
+
+    LED_STATE_AUTO_TOGGLE_ON = 0 # :nodoc:
+    LED_STATE_AUTO_TOGGLE_OFF = 1 # :nodoc:
+    LED_STATE_ON = 2 # :nodoc:
+    LED_STATE_OFF = 3 # :nodoc:
+    BUTTON_STATE_PRESSED = 0 # :nodoc:
+    BUTTON_STATE_RELEASED = 1 # :nodoc:
+    LED_LEFT = 0 # :nodoc:
+    LED_RIGHT = 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_SET_LED_STATE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_LED_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_BUTTON_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_STATE_CHANGED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_SET_SELECTED_LED_STATE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_STATE_CHANGED] = 'C C C C'
+    end
+
+    # Sets the state of the LEDs. Possible states are:
+    # 
+    # * 0 = AutoToggleOn: Enables auto toggle with initially enabled LED.
+    # * 1 = AutoToggleOff: Activates auto toggle with initially disabled LED.
+    # * 2 = On: Enables LED (auto toggle is disabled).
+    # * 3 = Off: Disables LED (auto toggle is disabled).
+    # 
+    # In auto toggle mode the LED is toggled automatically at each press of a button.
+    # 
+    # If you just want to set one of the LEDs and don't know the current state
+    # of the other LED, you can get the state with BrickletDualButton#get_led_state or you
+    # can use BrickletDualButton#set_selected_led_state.
+    # 
+    # The default value is (1, 1).
+    def set_led_state(led_l, led_r)
+      send_request(FUNCTION_SET_LED_STATE, [led_l, led_r], 'C C', 0, '')
+    end
+
+    # Returns the current state of the LEDs, as set by BrickletDualButton#set_led_state.
+    def get_led_state
+      send_request(FUNCTION_GET_LED_STATE, [], '', 2, 'C C')
+    end
+
+    # Returns the current state for both buttons. Possible states are:
+    # 
+    # * 0 = pressed
+    # * 1 = released
+    def get_button_state
+      send_request(FUNCTION_GET_BUTTON_STATE, [], '', 2, 'C C')
+    end
+
+    # Sets the state of the selected LED (0 or 1). 
+    # 
+    # The other LED remains untouched.
+    # 
+    # .. versionadded:: 2.0.0~(Plugin)
+    def set_selected_led_state(led, state)
+      send_request(FUNCTION_SET_SELECTED_LED_STATE, [led, state], 'C 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