tinkerforge 2.0.12 → 2.0.13

data/lib/tinkerforge/bricklet_industrial_quad_relay.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-11-27.      #
+# This file was automatically generated on 2013-12-19.      #
 #                                                           #
-# Bindings Version 2.0.12                                    #
+# Bindings Version 2.0.13                                    #
 #                                                           #
 # 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  #
@@ -55,8 +55,8 @@ module Tinkerforge
     # is 16 bit long, *true* refers to a closed relay and *false* refers to 
     # an open relay.
     # 
-    # For example: The value 0b0000000000000011 will close the relay 
-    # of pins 0-1 and open the other pins.
+    # For example: The value 0b0011 will close the relay of pins 0-1 and open the
+    # other pins.
     # 
     # If no groups are used (see BrickletIndustrialQuadRelay#set_group), the pins correspond to the
     # markings on the Quad Relay Bricklet.
@@ -82,10 +82,9 @@ module Tinkerforge
     # The third parameter indicates the time (in ms) that the pins should hold
     # the value.
     # 
-    # If this function is called with the parameters 
-    # ((1 << 0) | (1 << 3), (1 << 0), 1500):
-    # Pin 0 will close and pin 3 will open. In 1.5s pin 0 will open and pin
-    # 3 will close again.
+    # If this function is called with the parameters (9, 1, 1500) or
+    # (0b1001, 0b0001, 1500): Pin 0 will close and pin 3 will open. In 1.5s pin 0
+    # will open and pin 3 will close again.
     # 
     # A monoflop can be used as a fail-safe mechanism. For example: Lets assume you
     # have a RS485 bus and a Quad Relay Bricklet connected to one of the slave
@@ -115,7 +114,7 @@ module Tinkerforge
     # not be used.
     # 
     # For example: If you have two Quad Relay Bricklets connected to port A and
-    # port B respectively, you could call with "['a', 'b', 'n', 'n']".
+    # port B respectively, you could call with ``['a', 'b', 'n', 'n']``.
     # 
     # Now the pins on the Quad Relay on port A are assigned to 0-3 and the
     # pins on the Quad Relay on port B are assigned to 4-7. It is now possible
@@ -130,7 +129,7 @@ module Tinkerforge
     end
 
     # Returns a bitmask of ports that are available for grouping. For example the
-    # value 0b0101 means: Port *A* and Port *C* are connected to Bricklets that
+    # value 5 or 0b0101 means: Port A and port C are connected to Bricklets that
     # can be grouped together.
     def get_available_for_group
       send_request(FUNCTION_GET_AVAILABLE_FOR_GROUP, [], '', 1, 'C')
@@ -140,8 +139,8 @@ module Tinkerforge
     # The bitmask is 16 bit long, *true* refers to a closed relay and 
     # *false* refers to an open relay.
     # 
-    # For example: The values 00b0000000000000011, b0000000000000001 will close 
-    # the relay of pin 0, open the relay of pin 1 and leave the others untouched.
+    # For example: The values (3, 1) or (0b0011, 0b0001) will close the relay of
+    # pin 0, open the relay of pin 1 and leave the others untouched.
     # 
     # If no groups are used (see BrickletIndustrialQuadRelay#set_group), the pins correspond to the
     # markings on the Quad Relay Bricklet.

data/lib/tinkerforge/bricklet_io16.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-11-27.      #
+# This file was automatically generated on 2013-12-19.      #
 #                                                           #
-# Bindings Version 2.0.12                                    #
+# Bindings Version 2.0.13                                    #
 #                                                           #
 # 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  #
@@ -22,10 +22,11 @@ module Tinkerforge
     # 
     # For example:
     # 
-    # * ("a", 1, 1) means that on port a an interrupt on pin 0 occurred and
-    #   currently pin 0 is high and pins 1-7 are low.
-    # * ("b", 128, 254) means that on port b interrupts on pins 0 and 7
-    #   occurred and currently pin 0 is low and pins 1-7 are high.
+    # * ('a', 1, 1) or ('a', 0b00000001, 0b00000001) means that on port A an
+    #   interrupt on pin 0 occurred and currently pin 0 is high and pins 1-7 are low.
+    # * ('b', 129, 254) or ('b', 0b10000001, 0b11111110) means that on port B
+    #   interrupts on pins 0 and 7 occurred and currently pin 0 is low and pins 1-7
+    #   are high.
     CALLBACK_INTERRUPT = 9
 
     # This callback is triggered whenever a monoflop timer reaches 0. The
@@ -107,7 +108,7 @@ module Tinkerforge
     end
 
     # Configures the value and direction of a specified port. Possible directions
-    # are "i" and "o" for input and output.
+    # are 'i' and 'o' for input and output.
     # 
     # If the direction is configured as output, the value is either high or low
     # (set as *true* or *false*).
@@ -117,17 +118,17 @@ module Tinkerforge
     # 
     # For example:
     # 
-    # * ("a", 255, 'i', true) will set all pins of port a as input pull-up.
-    # * ("a", 128, 'i', false) will set pin 7 of port a as input default (floating if nothing is connected).
-    # * ("b", 3, 'o', false) will set pins 0 and 1 of port b as output low.
-    # * ("b", 4, 'o', true) will set pin 2 of port b as output high.
+    # * ('a', 255, 'i', true) or ('a', 0b11111111, 'i', true) will set all pins of port A as input pull-up.
+    # * ('a', 128, 'i', false) or ('a', 0b10000000, 'i', false) will set pin 7 of port A as input default (floating if nothing is connected).
+    # * ('b', 3, 'o', false) or ('b', 0b00000011, 'o', false) will set pins 0 and 1 of port B as output low.
+    # * ('b', 4, 'o', true) or ('b', 0b00000100, 'o', true) will set pin 2 of port B as output high.
     def set_port_configuration(port, selection_mask, direction, value)
       send_request(FUNCTION_SET_PORT_CONFIGURATION, [port, selection_mask, direction, value], 'k C k ?', 0, '')
     end
 
     # Returns a direction bitmask and a value bitmask for the specified port.
     # 
-    # For example: A return value of 0b00001111 and 0b00110011 for
+    # For example: A return value of (15, 51) or (0b00001111, 0b00110011) for
     # direction and value means that:
     # 
     # * pins 0 and 1 are configured as input pull-up,
@@ -158,8 +159,8 @@ module Tinkerforge
     # Interrupts are triggered on changes of the voltage level of the pin,
     # i.e. changes from high to low and low to high.
     # 
-    # For example: ('a', 129) will enable the interrupt for pins 0 and 7 of
-    # port a.
+    # For example: ('a', 129) or (a, 0b10000001) will enable the interrupt for
+    # pins 0 and 7 of port a.
     # 
     # The interrupt is delivered with the callback CALLBACK_INTERRUPT.
     def set_port_interrupt(port, interrupt_mask)
@@ -182,9 +183,9 @@ module Tinkerforge
     # The forth parameter indicates the time (in ms) that the pins should hold
     # the value.
     # 
-    # If this function is called with the parameters ('a', (1 << 0) | (1 << 3), (1 << 0), 1500):
-    # Pin 0 will get high and pin 3 will get low on port 'a'. In 1.5s pin 0 will get
-    # low and pin 3 will get high again.
+    # If this function is called with the parameters ('a', 9, 1, 1500) or
+    # ('a', 0b00001001, 0b00000001, 1500): Pin 0 will get high and pin 3 will get
+    # low on port 'a'. In 1.5s pin 0 will get low and pin 3 will get high again.
     # 
     # A monoflop can be used as a fail-safe mechanism. For example: Lets assume you
     # have a RS485 bus and an IO-16 Bricklet connected to one of the slave
@@ -212,8 +213,8 @@ module Tinkerforge
     # according to the selection mask. The bitmask is 8 bit long, *true* refers 
     # to high and *false* refers to low.
     # 
-    # For example: The values 0b11000000, 0b10000000 will turn pin 7 high and
-    # pin 6 low, pins 0-6 will remain untouched.
+    # For example: The parameters ('a', 192, 128) or ('a', 0b11000000, 0b10000000)
+    # will turn pin 7 high and pin 6 low on port A, pins 0-6 will remain untouched.
     # 
     # .. note::
     #  This function does nothing for pins that are configured as input.

data/lib/tinkerforge/bricklet_io4.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-11-27.      #
+# This file was automatically generated on 2013-12-19.      #
 #                                                           #
-# Bindings Version 2.0.12                                    #
+# Bindings Version 2.0.13                                    #
 #                                                           #
 # 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  #
@@ -22,9 +22,9 @@ module Tinkerforge
     # 
     # For example:
     # 
-    # * (1, 1) means that an interrupt on pin 0 occurred and
+    # * (1, 1) or (0b0001, 0b0001) means that an interrupt on pin 0 occurred and
     #   currently pin 0 is high and pins 1-3 are low.
-    # * (9, 14) means that interrupts on pins 0 and 3
+    # * (9, 14) or (0b1001, 0b1110) means that interrupts on pins 0 and 3
     #   occurred and currently pin 0 is low and pins 1-3 are high.
     CALLBACK_INTERRUPT = 9
 
@@ -87,9 +87,9 @@ module Tinkerforge
     end
 
     # Sets the output value (high or low) with a bitmask. The bitmask
-    # is 4 bit long, *true* refers to high and *false* refers to low.
+    # is 4bit long, *true* refers to high and *false* refers to low.
     # 
-    # For example: The value 0b0011 will turn the pins 0-1 high and the
+    # For example: The value 3 or 0b0011 will turn the pins 0-1 high and the
     # pins 2-3 low.
     # 
     # .. note::
@@ -107,7 +107,7 @@ module Tinkerforge
     end
 
     # Configures the value and direction of the specified pins. Possible directions
-    # are "i" and "o" for input and output.
+    # are 'i' and 'o' for input and output.
     # 
     # If the direction is configured as output, the value is either high or low
     # (set as *true* or *false*).
@@ -117,23 +117,23 @@ module Tinkerforge
     # 
     # For example:
     # 
-    # * (15, 'i', true) will set all pins of as input pull-up.
-    # * (8, 'i', false) will set pin 3 of as input default (floating if nothing is connected).
-    # * (3, 'o', false) will set pins 0 and 1 as output low.
-    # * (4, 'o', true) will set pin 2 of as output high.
+    # * (15, 'i', true) or (0b1111, 'i', true) will set all pins of as input pull-up.
+    # * (8, 'i', false) or (0b1000, 'i', false) will set pin 3 of as input default (floating if nothing is connected).
+    # * (3, 'o', false) or (0b0011, 'o', false) will set pins 0 and 1 as output low.
+    # * (4, 'o', true) or (0b0100, 'o', true) will set pin 2 of as output high.
     def set_configuration(selection_mask, direction, value)
       send_request(FUNCTION_SET_CONFIGURATION, [selection_mask, direction, value], 'C k ?', 0, '')
     end
 
     # Returns a value bitmask and a direction bitmask.
     # 
-    # For example: A return value of 0b0011 and 0b0101 for
-    # direction and value means that:
+    # For example: A return value of (3, 5) or (0b0011, 0b0101) for direction and
+    # value means that:
     # 
     # * pin 0 is configured as input pull-up,
     # * pin 1 is configured as input default,
-    # * pin 2 is configured as output high
-    # * and pin 3 is are configured as output low.
+    # * pin 2 is configured as output high and
+    # * pin 3 is are configured as output low.
     def get_configuration
       send_request(FUNCTION_GET_CONFIGURATION, [], '', 2, 'C C')
     end
@@ -158,8 +158,8 @@ module Tinkerforge
     # Interrupts are triggered on changes of the voltage level of the pin,
     # i.e. changes from high to low and low to high.
     # 
-    # For example: An interrupt bitmask of 9 will enable the interrupt for
-    # pins 0 and 3.
+    # For example: An interrupt bitmask of 10 or 0b1010 will enable the interrupt for
+    # pins 1 and 3.
     # 
     # The interrupt is delivered with the callback CALLBACK_INTERRUPT.
     def set_interrupt(interrupt_mask)
@@ -181,9 +181,9 @@ module Tinkerforge
     # The third parameter indicates the time (in ms) that the pins should hold
     # the value.
     # 
-    # If this function is called with the parameters ((1 << 0) | (1 << 3), (1 << 0), 1500):
-    # Pin 0 will get high and pin 3 will get low. In 1.5s pin 0 will get low and pin
-    # 3 will get high again.
+    # If this function is called with the parameters (9, 1, 1500) or
+    # (0b1001, 0b0001, 1500): Pin 0 will get high and pin 3 will get low. In 1.5s pin
+    # 0 will get low and pin 3 will get high again.
     # 
     # A monoflop can be used as a fail-safe mechanism. For example: Lets assume you
     # have a RS485 bus and an IO-4 Bricklet connected to one of the slave
@@ -211,8 +211,8 @@ module Tinkerforge
     # the selection mask. The bitmask is 4 bit long, *true* refers to high 
     # and *false* refers to low.
     # 
-    # For example: The values 0b0110, 0b0011 will turn pin 2 high and
-    # pin 1 low, pin 0 and 3 will remain untouched.
+    # For example: The parameters (9, 4) or (0b0110, 0b0100) will turn
+    # pin 1 low and pin 2 high, pin 0 and 3 will remain untouched.
     # 
     # .. note::
     #  This function does nothing for pins that are configured as input.

data/lib/tinkerforge/bricklet_joystick.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-11-27.      #
+# This file was automatically generated on 2013-12-19.      #
 #                                                           #
-# Bindings Version 2.0.12                                    #
+# Bindings Version 2.0.13                                    #
 #                                                           #
 # 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-11-27.      #
+# This file was automatically generated on 2013-12-19.      #
 #                                                           #
-# Bindings Version 2.0.12                                    #
+# Bindings Version 2.0.13                                    #
 #                                                           #
 # 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-11-27.      #
+# This file was automatically generated on 2013-12-19.      #
 #                                                           #
-# Bindings Version 2.0.12                                    #
+# Bindings Version 2.0.13                                    #
 #                                                           #
 # 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

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-11-27.      #
+# This file was automatically generated on 2013-12-19.      #
 #                                                           #
-# Bindings Version 2.0.12                                    #
+# Bindings Version 2.0.13                                    #
 #                                                           #
 # 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  #
@@ -27,6 +27,8 @@ module Tinkerforge
     FUNCTION_SET_FRAME_DURATION = 3 # :nodoc:
     FUNCTION_GET_FRAME_DURATION = 4 # :nodoc:
     FUNCTION_GET_SUPPLY_VOLTAGE = 5 # :nodoc:
+    FUNCTION_SET_CLOCK_FREQUENCY = 7 # :nodoc:
+    FUNCTION_GET_CLOCK_FREQUENCY = 8 # :nodoc:
     FUNCTION_GET_IDENTITY = 255 # :nodoc:
 
 
@@ -35,7 +37,7 @@ module Tinkerforge
     def initialize(uid, ipcon)
       super uid, ipcon
 
-      @api_version = [2, 0, 0]
+      @api_version = [2, 0, 1]
 
       @response_expected[FUNCTION_SET_RGB_VALUES] = RESPONSE_EXPECTED_FALSE
       @response_expected[FUNCTION_GET_RGB_VALUES] = RESPONSE_EXPECTED_ALWAYS_TRUE
@@ -43,6 +45,8 @@ module Tinkerforge
       @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_SET_CLOCK_FREQUENCY] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_CLOCK_FREQUENCY] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
       @callback_formats[CALLBACK_FRAME_RENDERED] = 'S'
@@ -54,9 +58,15 @@ module Tinkerforge
     # 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.
+    # Example: If you set
+    # 
+    # * index to 5,
+    # * length to 3,
+    # * r to [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
+    # * g to [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] and
+    # * b to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+    # 
+    # the LED with index 5 will be red, 6 will be green and 7 will be blue.
     # 
     # The colors will be transfered to actual LEDs when the next
     # frame duration ends, see BrickletLEDStrip#set_frame_duration.
@@ -112,6 +122,37 @@ module Tinkerforge
       send_request(FUNCTION_GET_SUPPLY_VOLTAGE, [], '', 2, 'S')
     end
 
+    # Sets the frequency of the clock in Hz. The range is 10000Hz (10kHz) up to
+    # 2000000Hz (2MHz).
+    # 
+    # The Bricklet will choose the nearest achievable frequency, which may
+    # be off by a few Hz. You can get the exact frequency that is used by
+    # calling BrickletLEDStrip#get_clock_frequency.
+    # 
+    # If you have problems with flickering LEDs, they may be bits flipping. You
+    # can fix this by either making the connection between the LEDs and the
+    # Bricklet shorter or by reducing the frequency.
+    # 
+    # With a decreasing frequency your maximum frames per second will decrease
+    # too.
+    # 
+    # The default value is 1.66MHz.
+    # 
+    # .. note::
+    #  The frequency in firmware version 2.0.0 is fixed at 2MHz.
+    # 
+    # .. versionadded:: 2.0.1~(Plugin)
+    def set_clock_frequency(frequency)
+      send_request(FUNCTION_SET_CLOCK_FREQUENCY, [frequency], 'L', 0, '')
+    end
+
+    # Returns the currently used clock frequency.
+    # 
+    # .. versionadded:: 2.0.1~(Plugin)
+    def get_clock_frequency
+      send_request(FUNCTION_GET_CLOCK_FREQUENCY, [], '', 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.

data/lib/tinkerforge/bricklet_line.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-11-27.      #
+# This file was automatically generated on 2013-12-19.      #
 #                                                           #
-# Bindings Version 2.0.12                                    #
+# Bindings Version 2.0.13                                    #
 #                                                           #
 # 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_linear_poti.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-11-27.      #
+# This file was automatically generated on 2013-12-19.      #
 #                                                           #
-# Bindings Version 2.0.12                                    #
+# Bindings Version 2.0.13                                    #
 #                                                           #
 # 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_moisture.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-11-27.      #
+# This file was automatically generated on 2013-12-19.      #
 #                                                           #
-# Bindings Version 2.0.12                                    #
+# Bindings Version 2.0.13                                    #
 #                                                           #
 # 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_motion_detector.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-11-27.      #
+# This file was automatically generated on 2013-12-19.      #
 #                                                           #
-# Bindings Version 2.0.12                                    #
+# Bindings Version 2.0.13                                    #
 #                                                           #
 # 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  #
@@ -46,7 +46,11 @@ module Tinkerforge
 
     # Returns 1 if a motion was detected. How long this returns 1 after a motion
     # was detected can be adjusted with one of the small potentiometers on the
-    # Motion Detector Bricklet, see :ref:`here <motion_detector_bricklet_sensitivity_delay_block_time>`.
+    # Motion Detector Bricklet, see :ref:`here
+    # <motion_detector_bricklet_sensitivity_delay_block_time>`.
+    # 
+    # There is also a blue LED on the Bricklet that is on as long as the Bricklet is
+    # in the "motion detected" state.
     def get_motion_detected
       send_request(FUNCTION_GET_MOTION_DETECTED, [], '', 1, 'C')
     end