tinkerforge 2.0.11 → 2.0.12

data/lib/tinkerforge/bricklet_dual_relay.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_gps.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_hall_effect.rb

@@ -0,0 +1,163 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2013-11-27.      #
+#                                                           #
+# Bindings Version 2.0.12                                    #
+#                                                           #
+# If you have a bugfix for this file and want to commit it, #
+# please fix the bug in the generator. You can find a link  #
+# to the generator git on tinkerforge.com                   #
+#############################################################
+
+module Tinkerforge
+  # Device that detects presence of magnetic field via hall effect
+  class BrickletHallEffect < Device
+    DEVICE_IDENTIFIER = 240 # :nodoc:
+
+    # This callback is triggered periodically with the period that is set by
+    # BrickletHallEffect#set_edge_count_callback_period. The parameters are the
+    # current count and the current value (see BrickletHallEffect#get_value and BrickletHallEffect#get_edge_count).
+    # 
+    # CALLBACK_EDGE_COUNT is only triggered if the count or value changed since the
+    # last triggering.
+    CALLBACK_EDGE_COUNT = 10
+
+    FUNCTION_GET_VALUE = 1 # :nodoc:
+    FUNCTION_GET_EDGE_COUNT = 2 # :nodoc:
+    FUNCTION_SET_EDGE_COUNT_CONFIG = 3 # :nodoc:
+    FUNCTION_GET_EDGE_COUNT_CONFIG = 4 # :nodoc:
+    FUNCTION_SET_EDGE_INTERRUPT = 5 # :nodoc:
+    FUNCTION_GET_EDGE_INTERRUPT = 6 # :nodoc:
+    FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7 # :nodoc:
+    FUNCTION_GET_EDGE_COUNT_CALLBACK_PERIOD = 8 # :nodoc:
+    FUNCTION_EDGE_INTERRUPT = 9 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :nodoc:
+
+    EDGE_TYPE_RISING = 0 # :nodoc:
+    EDGE_TYPE_FALLING = 1 # :nodoc:
+    EDGE_TYPE_BOTH = 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_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_EDGE_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_EDGE_COUNT_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_EDGE_COUNT_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_EDGE_INTERRUPT] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_EDGE_INTERRUPT] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_EDGE_COUNT_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_EDGE_INTERRUPT] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_EDGE_COUNT] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_EDGE_COUNT] = 'L ?'
+    end
+
+    # Returns *true* if a magnetic field of 35 Gauss (3.5mT) or greater is detected.
+    def get_value
+      send_request(FUNCTION_GET_VALUE, [], '', 1, '?')
+    end
+
+    # Returns the current value of the edge counter. You can configure
+    # edge type (rising, falling, both) that is counted with
+    # BrickletHallEffect#set_edge_count_config.
+    # 
+    # If you set the reset counter to *true*, the count is set back to 0
+    # directly after it is read.
+    def get_edge_count(reset_counter)
+      send_request(FUNCTION_GET_EDGE_COUNT, [reset_counter], '?', 4, 'L')
+    end
+
+    # The edge type parameter configures if rising edges, falling edges or 
+    # both are counted. Possible edge types are:
+    # 
+    # * 0 = rising (default)
+    # * 1 = falling
+    # * 2 = both
+    # 
+    # A magnetic field of 35 Gauss (3.5mT) or greater causes a falling edge and a
+    # magnetic field of 25 Gauss (2.5mT) or smaller causes a rising edge.
+    # 
+    # If a magnet comes near the Bricklet the signal goes low (falling edge), if
+    # a magnet is removed from the vicinity the signal goes high (rising edge).
+    # 
+    # The debounce time is given in ms.
+    # 
+    # If you don't know what any of this means, just leave it at default. The
+    # default configuration is very likely OK for you.
+    # 
+    # Default values: 0 (edge type) and 100ms (debounce time)
+    def set_edge_count_config(edge_type, debounce)
+      send_request(FUNCTION_SET_EDGE_COUNT_CONFIG, [edge_type, debounce], 'C C', 0, '')
+    end
+
+    # Returns the edge type and debounce time as set by BrickletHallEffect#set_edge_count_config.
+    def get_edge_count_config
+      send_request(FUNCTION_GET_EDGE_COUNT_CONFIG, [], '', 2, 'C C')
+    end
+
+    # Sets the number of edges until an interrupt is invoked.
+    # 
+    # If *edges* is set to n, an interrupt is invoked for every n-th detected edge.
+    # 
+    # If *edges* is set to 0, the interrupt is disabled.
+    # 
+    # Default value is 0.
+    def set_edge_interrupt(edges)
+      send_request(FUNCTION_SET_EDGE_INTERRUPT, [edges], 'L', 0, '')
+    end
+
+    # Returns the edges as set by BrickletHallEffect#set_edge_interrupt.
+    def get_edge_interrupt
+      send_request(FUNCTION_GET_EDGE_INTERRUPT, [], '', 4, 'L')
+    end
+
+    # Sets the period in ms with which the CALLBACK_EDGE_COUNT callback is triggered
+    # periodically. A value of 0 turns the callback off.
+    # 
+    # CALLBACK_EDGE_COUNT is only triggered if the edge count has changed since the
+    # last triggering.
+    # 
+    # The default value is 0.
+    def set_edge_count_callback_period(period)
+      send_request(FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD, [period], 'L', 0, '')
+    end
+
+    # Returns the period as set by BrickletHallEffect#set_edge_count_callback_period.
+    def get_edge_count_callback_period
+      send_request(FUNCTION_GET_EDGE_COUNT_CALLBACK_PERIOD, [], '', 4, 'L')
+    end
+
+    # This callback is triggered every n-th count, as configured with
+    # BrickletHallEffect#set_edge_interrupt. The parameters are the
+    # current count and the current value (see BrickletHallEffect#get_value and BrickletHallEffect#get_edge_count).
+    def edge_interrupt
+      send_request(FUNCTION_EDGE_INTERRUPT, [], '', 5, '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

@@ -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_industrial_digital_in_4.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  #
@@ -102,7 +102,7 @@ module Tinkerforge
     # pins on the Digital In 4 on port B are assigned to 4-7. It is now possible
     # to call BrickletIndustrialDigitalIn4#get_value and read out two Bricklets at the same time.
     # 
-    # Changing the group configuration resets the alle edge counter configurations
+    # Changing the group configuration resets all edge counter configurations
     # and values.
     def set_group(group)
       send_request(FUNCTION_SET_GROUP, [group], 'k4', 0, '')

data/lib/tinkerforge/bricklet_industrial_digital_out_4.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_industrial_dual_0_20ma.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_industrial_quad_relay.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_io16.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_io4.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_joystick.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_lcd_16x2.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_lcd_20x4.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_led_strip.rb

@@ -0,0 +1,134 @@
+# -*- 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 to control up to 320 RGB LEDs
+  class BrickletLEDStrip < Device
+    DEVICE_IDENTIFIER = 231 # :nodoc:
+
+    # This callback is triggered directly after a new frame is rendered.
+    # 
+    # You should send the data for the next frame directly after this callback
+    # was triggered.
+    # 
+    # For an explanation of the general approach see BrickletLEDStrip#set_rgb_values.
+    CALLBACK_FRAME_RENDERED = 6
+
+    FUNCTION_SET_RGB_VALUES = 1 # :nodoc:
+    FUNCTION_GET_RGB_VALUES = 2 # :nodoc:
+    FUNCTION_SET_FRAME_DURATION = 3 # :nodoc:
+    FUNCTION_GET_FRAME_DURATION = 4 # :nodoc:
+    FUNCTION_GET_SUPPLY_VOLTAGE = 5 # :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_RGB_VALUES] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_RGB_VALUES] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_FRAME_DURATION] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_FRAME_DURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_SUPPLY_VOLTAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_FRAME_RENDERED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_FRAME_RENDERED] = 'S'
+    end
+
+    # Sets the *rgb* values for the LEDs with the given *length* starting 
+    # from *index*.
+    # 
+    # The maximum length is 16, the index goes from 0 to 319 and the rgb values
+    # have 8 bits each.
+    # 
+    # Example: If you set index to 5, length to 3, r to [255, 0, 0], 
+    # g to [0, 255, 0] and b to [0, 0, 255] the LEDs with index 5, 6
+    # and 7 will get the color red, green and blue respectively.
+    # 
+    # The colors will be transfered to actual LEDs when the next
+    # frame duration ends, see BrickletLEDStrip#set_frame_duration.
+    # 
+    # Generic approach: 
+    # 
+    # * Set the frame duration to a value that represents
+    #   the number of frames per second you want to achieve. 
+    # * Set all of the LED colors for one frame.
+    # * Wait for the CALLBACK_FRAME_RENDERED callback.
+    # * Set all of the LED colors for next frame.
+    # * Wait for the CALLBACK_FRAME_RENDERED callback.
+    # * and so on.
+    # 
+    # This approach ensures that you can change the LED colors with
+    # a fixed frame rate.
+    # 
+    # The actual number of controllable LEDs depends on the number of free
+    # Bricklet ports. See :ref:`here <led_strip_bricklet_ram_constraints>` for more
+    # information. A call of BrickletLEDStrip#set_rgb_values with index + length above the
+    # bounds is ignored completely.
+    def set_rgb_values(index, length, r, g, b)
+      send_request(FUNCTION_SET_RGB_VALUES, [index, length, r, g, b], 'S C C16 C16 C16', 0, '')
+    end
+
+    # Returns the rgb with the given *length* starting from the
+    # given *index*.
+    # 
+    # The values are the last values that were set by BrickletLEDStrip#set_rgb_values.
+    def get_rgb_values(index, length)
+      send_request(FUNCTION_GET_RGB_VALUES, [index, length], 'S C', 48, 'C16 C16 C16')
+    end
+
+    # Sets the frame duration in ms.
+    # 
+    # Example: If you want to achieve 20 frames per second, you should
+    # set the frame duration to 50ms (50ms * 20 = 1 second). 
+    # 
+    # For an explanation of the general approach see BrickletLEDStrip#set_rgb_values.
+    # 
+    # Default value: 100ms (10 frames per second).
+    def set_frame_duration(duration)
+      send_request(FUNCTION_SET_FRAME_DURATION, [duration], 'S', 0, '')
+    end
+
+    # Returns the frame duration as set by BrickletLEDStrip#set_frame_duration.
+    def get_frame_duration
+      send_request(FUNCTION_GET_FRAME_DURATION, [], '', 2, 'S')
+    end
+
+    # Returns the current supply voltage of the LEDs. The voltage is given in mV.
+    def get_supply_voltage
+      send_request(FUNCTION_GET_SUPPLY_VOLTAGE, [], '', 2, 'S')
+    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