tinkerforge 2.0.11 → 2.0.12

data/lib/tinkerforge/bricklet_sound_intensity.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 for sensing sound intensity
+  class BrickletSoundIntensity < Device
+    DEVICE_IDENTIFIER = 238 # :nodoc:
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletSoundIntensity#set_intensity_callback_period. The parameter is the intensity of
+    # the encoder.
+    # 
+    # CALLBACK_INTENSITY is only triggered if the intensity has changed since the
+    # last triggering.
+    CALLBACK_INTENSITY = 8
+
+    # This callback is triggered when the threshold as set by
+    # BrickletSoundIntensity#set_intensity_callback_threshold is reached.
+    # The parameter is the intensity of the encoder.
+    # 
+    # If the threshold keeps being reached, the callback is triggered periodically
+    # with the period as set by BrickletSoundIntensity#set_debounce_period.
+    CALLBACK_INTENSITY_REACHED = 9
+
+    FUNCTION_GET_INTENSITY = 1 # :nodoc:
+    FUNCTION_SET_INTENSITY_CALLBACK_PERIOD = 2 # :nodoc:
+    FUNCTION_GET_INTENSITY_CALLBACK_PERIOD = 3 # :nodoc:
+    FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD = 4 # :nodoc:
+    FUNCTION_GET_INTENSITY_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_INTENSITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_INTENSITY_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_INTENSITY_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_INTENSITY_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_INTENSITY] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_INTENSITY_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_INTENSITY] = 'S'
+      @callback_formats[CALLBACK_INTENSITY_REACHED] = 'S'
+    end
+
+    # Returns the current sound intensity. The value has a range of
+    # 0 to 4095.
+    # 
+    # The value corresponds to the `upper envelop <http://en.wikipedia.org/wiki/Envelope_(waves)>`__
+    # of the signal of the microphone capsule.
+    # 
+    # If you want to get the intensity periodically, it is recommended to use the
+    # callback CALLBACK_INTENSITY and set the period with 
+    # BrickletSoundIntensity#set_intensity_callback_period.
+    def get_intensity
+      send_request(FUNCTION_GET_INTENSITY, [], '', 2, 'S')
+    end
+
+    # Sets the period in ms with which the CALLBACK_INTENSITY callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_INTENSITY is only triggered if the intensity has changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_intensity_callback_period(period)
+      send_request(FUNCTION_SET_INTENSITY_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletSoundIntensity#set_intensity_callback_period.
+    def get_intensity_callback_period
+      send_request(FUNCTION_GET_INTENSITY_CALLBACK_PERIOD, [], '', 4, 'L')
+    end
+
+    # Sets the thresholds for the CALLBACK_INTENSITY_REACHED callback. 
+    # 
+    # The following options are possible:
+    # 
+    #  "Option", "Description"
+    # 
+    #  "'x'",    "Callback is turned off"
+    #  "'o'",    "Callback is triggered when the intensity is *outside* the min and max values"
+    #  "'i'",    "Callback is triggered when the intensity is *inside* the min and max values"
+    #  "'<'",    "Callback is triggered when the intensity is smaller than the min value (max is ignored)"
+    #  "'>'",    "Callback is triggered when the intensity is greater than the min value (max is ignored)"
+    # 
+    # The default value is ('x', 0, 0).
+    def set_intensity_callback_threshold(option, min, max)
+      send_request(FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, '')
+    end
+
+    # Returns the threshold as set by BrickletSoundIntensity#set_intensity_callback_threshold.
+    def get_intensity_callback_threshold
+      send_request(FUNCTION_GET_INTENSITY_CALLBACK_THRESHOLD, [], '', 5, 'k S S')
+    end
+
+    # Sets the period in ms with which the threshold callback
+    # 
+    # * CALLBACK_INTENSITY_REACHED
+    # 
+    # is triggered, if the thresholds
+    # 
+    # * BrickletSoundIntensity#set_intensity_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 BrickletSoundIntensity#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_temperature.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_temperature_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_tilt.rb

@@ -0,0 +1,99 @@
+# -*- 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 tilt and vibration
+  class BrickletTilt < Device
+    DEVICE_IDENTIFIER = 239 # :nodoc:
+
+    # This callback provides the current tilt state. It is called every time the
+    # state changes.
+    # 
+    # See BrickletTilt#get_tilt_state for a description of the states.
+    CALLBACK_TILT_STATE = 5
+
+    FUNCTION_GET_TILT_STATE = 1 # :nodoc:
+    FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2 # :nodoc:
+    FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3 # :nodoc:
+    FUNCTION_IS_TILT_STATE_CALLBACK_ENABLED = 4 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :nodoc:
+
+    TILT_STATE_CLOSED = 0 # :nodoc:
+    TILT_STATE_OPEN = 1 # :nodoc:
+    TILT_STATE_CLOSED_VIBRATING = 2 # :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_TILT_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_ENABLE_TILT_STATE_CALLBACK] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_DISABLE_TILT_STATE_CALLBACK] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_IS_TILT_STATE_CALLBACK_ENABLED] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_TILT_STATE] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_TILT_STATE] = 'C'
+    end
+
+    # Returns the current tilt state. The state can either be
+    # 
+    # * 0 = Closed: The ball in the tilt switch closes the circuit.
+    # * 1 = Open: The ball in the tilt switch does not close the circuit.
+    # * 2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).
+    # 
+    # .. image:: /Images/Bricklets/bricklet_tilt_mechanics.jpg
+    #    :scale: 100 %
+    #    :alt: Tilt states
+    #    :align: center
+    #    :target: ../../_images/Bricklets/bricklet_tilt_mechanics.jpg
+    def get_tilt_state
+      send_request(FUNCTION_GET_TILT_STATE, [], '', 1, 'C')
+    end
+
+    # Enables the CALLBACK_TILT_STATE callback.
+    def enable_tilt_state_callback
+      send_request(FUNCTION_ENABLE_TILT_STATE_CALLBACK, [], '', 0, '')
+    end
+
+    # Disables the CALLBACK_TILT_STATE callback.
+    def disable_tilt_state_callback
+      send_request(FUNCTION_DISABLE_TILT_STATE_CALLBACK, [], '', 0, '')
+    end
+
+    # Returns *true* if the CALLBACK_TILT_STATE callback is enabled.
+    def is_tilt_state_callback_enabled
+      send_request(FUNCTION_IS_TILT_STATE_CALLBACK_ENABLED, [], '', 1, '?')
+    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_voltage.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_voltage_current.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  #
@@ -144,7 +144,7 @@ module Tinkerforge
     end
 
     # Returns the current. The value is in mA
-    # and between 0mA and 20000mA.
+    # and between -20000mA and 20000mA.
     # 
     # If you want to get the current periodically, it is recommended to use the
     # callback CALLBACK_CURRENT and set the period with 

data/lib/tinkerforge/version.rb

@@ -1,4 +1,4 @@
 
 module Tinkerforge
-  VERSION = '2.0.11'
+  VERSION = '2.0.12'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tinkerforge
 version: !ruby/object:Gem::Version
-  version: 2.0.11
+  version: 2.0.12
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-11-27 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: matthias@tinkerforge.com
@@ -23,6 +23,9 @@ files:
 - lib/tinkerforge/bricklet_industrial_digital_out_4.rb
 - lib/tinkerforge/bricklet_temperature.rb
 - lib/tinkerforge/bricklet_current25.rb
+- lib/tinkerforge/bricklet_piezo_speaker.rb
+- lib/tinkerforge/bricklet_rotary_encoder.rb
+- lib/tinkerforge/bricklet_led_strip.rb
 - lib/tinkerforge/bricklet_lcd_20x4.rb
 - lib/tinkerforge/bricklet_ptc.rb
 - lib/tinkerforge/bricklet_current12.rb
@@ -30,20 +33,31 @@ files:
 - lib/tinkerforge/bricklet_ambient_light.rb
 - lib/tinkerforge/bricklet_distance_ir.rb
 - lib/tinkerforge/bricklet_rotary_poti.rb
+- lib/tinkerforge/bricklet_hall_effect.rb
+- lib/tinkerforge/bricklet_moisture.rb
+- lib/tinkerforge/bricklet_multi_touch.rb
 - lib/tinkerforge/bricklet_analog_out.rb
 - lib/tinkerforge/brick_imu.rb
 - lib/tinkerforge/brick_dc.rb
+- lib/tinkerforge/bricklet_motion_detector.rb
+- lib/tinkerforge/bricklet_line.rb
 - lib/tinkerforge/bricklet_joystick.rb
 - lib/tinkerforge/ip_connection.rb
 - lib/tinkerforge/bricklet_lcd_16x2.rb
 - lib/tinkerforge/bricklet_dual_relay.rb
+- lib/tinkerforge/bricklet_remote_switch.rb
+- lib/tinkerforge/bricklet_sound_intensity.rb
 - lib/tinkerforge/brick_servo.rb
 - lib/tinkerforge/brick_master.rb
 - lib/tinkerforge/bricklet_industrial_digital_in_4.rb
+- lib/tinkerforge/bricklet_tilt.rb
 - lib/tinkerforge/brick_stepper.rb
 - lib/tinkerforge/bricklet_io4.rb
 - lib/tinkerforge/bricklet_analog_in.rb
 - lib/tinkerforge/bricklet_temperature_ir.rb
+- lib/tinkerforge/bricklet_dual_button.rb
+- lib/tinkerforge/bricklet_segment_display_4x7.rb
+- lib/tinkerforge/bricklet_distance_us.rb
 - lib/tinkerforge/bricklet_industrial_dual_0_20ma.rb
 - lib/tinkerforge/bricklet_humidity.rb
 - lib/tinkerforge/bricklet_piezo_buzzer.rb