tinkerforge 2.0.13 → 2.1.0

data/lib/tinkerforge/bricklet_gps.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-12-19.      #
+# This file was automatically generated on 2014-04-08.      #
 #                                                           #
-# Bindings Version 2.0.13                                    #
+# Bindings Version 2.1.0                                    #
 #                                                           #
 # 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  #
@@ -288,9 +288,8 @@ module Tinkerforge
     # 
     # The position can be 'a', 'b', 'c' or 'd'.
     # 
-    # The device identifiers can be found :ref:`here <device_identifier>`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
     def get_identity
       send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
     end

data/lib/tinkerforge/bricklet_hall_effect.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-12-19.      #
+# This file was automatically generated on 2014-04-08.      #
 #                                                           #
-# Bindings Version 2.0.13                                    #
+# Bindings Version 2.1.0                                    #
 #                                                           #
 # 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  #
@@ -89,6 +89,8 @@ module Tinkerforge
     # 
     # The debounce time is given in ms.
     # 
+    # Configuring an edge counter resets its value to 0.
+    # 
     # If you don't know what any of this means, just leave it at default. The
     # default configuration is very likely OK for you.
     # 
@@ -147,9 +149,8 @@ module Tinkerforge
     # 
     # The position can be 'a', 'b', 'c' or 'd'.
     # 
-    # The device identifiers can be found :ref:`here <device_identifier>`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
     def get_identity
       send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
     end

data/lib/tinkerforge/bricklet_humidity.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-12-19.      #
+# This file was automatically generated on 2014-04-08.      #
 #                                                           #
-# Bindings Version 2.0.13                                    #
+# Bindings Version 2.1.0                                    #
 #                                                           #
 # 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  #
@@ -231,9 +231,8 @@ module Tinkerforge
     # 
     # The position can be 'a', 'b', 'c' or 'd'.
     # 
-    # The device identifiers can be found :ref:`here <device_identifier>`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
     def get_identity
       send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
     end

data/lib/tinkerforge/bricklet_industrial_digital_in_4.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-12-19.      #
+# This file was automatically generated on 2014-04-08.      #
 #                                                           #
-# Bindings Version 2.0.13                                    #
+# Bindings Version 2.1.0                                    #
 #                                                           #
 # 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  #
@@ -165,7 +165,8 @@ module Tinkerforge
       send_request(FUNCTION_GET_EDGE_COUNT, [pin, reset_counter], 'C ?', 4, 'L')
     end
 
-    # Configures the edge counter for the selected pins.
+    # Configures the edge counter for the selected pins. A bitmask of 9 or 0b1001 will
+    # enable the edge counter for pins 0 and 3.
     # 
     # The edge type parameter configures if rising edges, falling edges or
     # both are counted if the pin is configured for input. Possible edge types are:
@@ -176,6 +177,8 @@ module Tinkerforge
     # 
     # The debounce time is given in ms.
     # 
+    # Configuring an edge counter resets its value to 0.
+    # 
     # If you don't know what any of this means, just leave it at default. The
     # default configuration is very likely OK for you.
     # 
@@ -200,9 +203,8 @@ module Tinkerforge
     # 
     # The position can be 'a', 'b', 'c' or 'd'.
     # 
-    # The device identifiers can be found :ref:`here <device_identifier>`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
     def get_identity
       send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
     end

data/lib/tinkerforge/bricklet_industrial_digital_out_4.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-12-19.      #
+# This file was automatically generated on 2014-04-08.      #
 #                                                           #
-# Bindings Version 2.0.13                                    #
+# Bindings Version 2.1.0                                    #
 #                                                           #
 # 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  #
@@ -51,9 +51,8 @@ module Tinkerforge
       @callback_formats[CALLBACK_MONOFLOP_DONE] = 'S S'
     end
 
-    # Sets the output value with a bitmask. The bitmask
-    # is 16 bit long, *true* refers to high and *false* refers to 
-    # low.
+    # Sets the output value with a bitmask (16bit). A 1 in the bitmask means high
+    # and a 0 in the bitmask means low.
     # 
     # For example: The value 3 or 0b0011 will turn pins 0-1 high and the other pins
     # low.
@@ -77,7 +76,7 @@ module Tinkerforge
     # bitmask.
     # 
     # The second parameter is a bitmask with the desired value of the specified
-    # pins (*true* means high and *false* means low).
+    # pins. A 1 in the bitmask means high and a 0 in the bitmask means low.
     # 
     # The third parameter indicates the time (in ms) that the pins should hold
     # the value.
@@ -148,8 +147,6 @@ module Tinkerforge
     # If groups are used, the pins correspond to the element in the group.
     # Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3
     # pins 8-11 and element 4 pins 12-15.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
     def set_selected_values(selection_mask, value_mask)
       send_request(FUNCTION_SET_SELECTED_VALUES, [selection_mask, value_mask], 'S S', 0, '')
     end
@@ -160,9 +157,8 @@ module Tinkerforge
     # 
     # The position can be 'a', 'b', 'c' or 'd'.
     # 
-    # The device identifiers can be found :ref:`here <device_identifier>`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
     def get_identity
       send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
     end

data/lib/tinkerforge/bricklet_industrial_dual_0_20ma.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-12-19.      #
+# This file was automatically generated on 2014-04-08.      #
 #                                                           #
-# Bindings Version 2.0.13                                    #
+# Bindings Version 2.1.0                                    #
 #                                                           #
 # 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  #
@@ -177,9 +177,8 @@ module Tinkerforge
     # 
     # The position can be 'a', 'b', 'c' or 'd'.
     # 
-    # The device identifiers can be found :ref:`here <device_identifier>`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
     def get_identity
       send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
     end

data/lib/tinkerforge/bricklet_industrial_quad_relay.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-12-19.      #
+# This file was automatically generated on 2014-04-08.      #
 #                                                           #
-# Bindings Version 2.0.13                                    #
+# Bindings Version 2.1.0                                    #
 #                                                           #
 # 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  #
@@ -51,12 +51,11 @@ module Tinkerforge
       @callback_formats[CALLBACK_MONOFLOP_DONE] = 'S S'
     end
 
-    # Sets the output value with a bitmask. The bitmask
-    # is 16 bit long, *true* refers to a closed relay and *false* refers to 
-    # an open relay.
+    # Sets the output value with a bitmask (16bit). A 1 in the bitmask means relay
+    # closed and a 0 means relay open.
     # 
-    # For example: The value 0b0011 will close the relay of pins 0-1 and open the
-    # other pins.
+    # For example: The value 3 or 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.
@@ -77,7 +76,7 @@ module Tinkerforge
     # bitmask.
     # 
     # The second parameter is a bitmask with the desired value of the specified
-    # pins (*true* means relay closed and *false* means relay open).
+    # pins. A 1 in the bitmask means relay closed and a 0 means relay open.
     # 
     # The third parameter indicates the time (in ms) that the pins should hold
     # the value.
@@ -148,8 +147,6 @@ module Tinkerforge
     # If groups are used, the pins correspond to the element in the group.
     # Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3
     # pins 8-11 and element 4 pins 12-15.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
     def set_selected_values(selection_mask, value_mask)
       send_request(FUNCTION_SET_SELECTED_VALUES, [selection_mask, value_mask], 'S S', 0, '')
     end
@@ -160,9 +157,8 @@ module Tinkerforge
     # 
     # The position can be 'a', 'b', 'c' or 'd'.
     # 
-    # The device identifiers can be found :ref:`here <device_identifier>`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
     def get_identity
       send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
     end

data/lib/tinkerforge/bricklet_io16.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-12-19.      #
+# This file was automatically generated on 2014-04-08.      #
 #                                                           #
-# Bindings Version 2.0.13                                    #
+# Bindings Version 2.1.0                                    #
 #                                                           #
 # 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  #
@@ -32,8 +32,6 @@ module Tinkerforge
     # This callback is triggered whenever a monoflop timer reaches 0. The
     # parameters contain the port, the involved pins and the current value of
     # the pins (the value after the monoflop).
-    # 
-    # .. versionadded:: 1.1.2~(Plugin)
     CALLBACK_MONOFLOP_DONE = 12
 
     FUNCTION_SET_PORT = 1 # :nodoc:
@@ -87,10 +85,10 @@ module Tinkerforge
       @callback_formats[CALLBACK_MONOFLOP_DONE] = 'k C C'
     end
 
-    # Sets the output value (high or low) for a port ("a" or "b") with a bitmask.
-    # The bitmask is 8 bit long, *true* refers to high and *false* refers to low.
+    # Sets the output value (high or low) for a port ("a" or "b") with a bitmask
+    # (8bit). A 1 in the bitmask means high and a 0 in the bitmask means low.
     # 
-    # For example: The value 0b00001111 will turn the pins 0-3 high and the
+    # For example: The value 15 or 0b00001111 will turn the pins 0-3 high and the
     # pins 4-7 low for the specified port.
     # 
     # .. note::
@@ -126,7 +124,8 @@ module Tinkerforge
       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.
+    # Returns a direction bitmask and a value bitmask for the specified port. A 1 in
+    # the direction bitmask means input and a 0 in the bitmask means output.
     # 
     # For example: A return value of (15, 51) or (0b00001111, 0b00110011) for
     # direction and value means that:
@@ -159,7 +158,7 @@ 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) or (a, 0b10000001) will enable the interrupt for
+    # 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.
@@ -178,7 +177,7 @@ module Tinkerforge
     # pins will be ignored.
     # 
     # The third parameter is a bitmask with the desired value of the specified
-    # output pins (*true* means high and *false* means low).
+    # output pins. A 1 in the bitmask means high and a 0 in the bitmask means low.
     # 
     # The forth parameter indicates the time (in ms) that the pins should hold
     # the value.
@@ -192,8 +191,6 @@ module Tinkerforge
     # stacks. You can now call this function every second, with a time parameter
     # of two seconds and pin 0 set to high. Pin 0 will be high all the time. If now
     # the RS485 connection is lost, then pin 0 will get low in at most two seconds.
-    # 
-    # .. versionadded:: 1.1.2~(Plugin)
     def set_port_monoflop(port, selection_mask, value_mask, time)
       send_request(FUNCTION_SET_PORT_MONOFLOP, [port, selection_mask, value_mask, time], 'k C C L', 0, '')
     end
@@ -203,15 +200,13 @@ module Tinkerforge
     # 
     # If the timer is not running currently, the remaining time will be returned
     # as 0.
-    # 
-    # .. versionadded:: 1.1.2~(Plugin)
     def get_port_monoflop(port, pin)
       send_request(FUNCTION_GET_PORT_MONOFLOP, [port, pin], 'k C', 9, 'C L L')
     end
 
     # Sets the output value (high or low) for a port ("a" or "b" with a bitmask, 
-    # according to the selection mask. The bitmask is 8 bit long, *true* refers 
-    # to high and *false* refers to low.
+    # according to the selection mask. The bitmask is 8 bit long and a 1 in the
+    # bitmask means high and a 0 in the bitmask means low.
     # 
     # 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.
@@ -219,8 +214,6 @@ module Tinkerforge
     # .. note::
     #  This function does nothing for pins that are configured as input.
     #  Pull-up resistors can be switched on with :func:`SetConfiguration`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
     def set_selected_values(port, selection_mask, value_mask)
       send_request(FUNCTION_SET_SELECTED_VALUES, [port, selection_mask, value_mask], 'k C C', 0, '')
     end
@@ -248,6 +241,8 @@ module Tinkerforge
     # 
     # The debounce time is given in ms.
     # 
+    # Configuring an edge counter resets its value to 0.
+    # 
     # If you don't know what any of this means, just leave it at default. The
     # default configuration is very likely OK for you.
     # 
@@ -272,9 +267,8 @@ module Tinkerforge
     # 
     # The position can be 'a', 'b', 'c' or 'd'.
     # 
-    # The device identifiers can be found :ref:`here <device_identifier>`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
     def get_identity
       send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
     end

data/lib/tinkerforge/bricklet_io4.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-12-19.      #
+# This file was automatically generated on 2014-04-08.      #
 #                                                           #
-# Bindings Version 2.0.13                                    #
+# Bindings Version 2.1.0                                    #
 #                                                           #
 # 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  #
@@ -31,8 +31,6 @@ module Tinkerforge
     # This callback is triggered whenever a monoflop timer reaches 0. The
     # parameters contain the involved pins and the current value of the pins
     # (the value after the monoflop).
-    # 
-    # .. versionadded:: 1.1.1~(Plugin)
     CALLBACK_MONOFLOP_DONE = 12
 
     FUNCTION_SET_VALUE = 1 # :nodoc:
@@ -86,8 +84,8 @@ module Tinkerforge
       @callback_formats[CALLBACK_MONOFLOP_DONE] = 'C C'
     end
 
-    # Sets the output value (high or low) with a bitmask. The bitmask
-    # is 4bit long, *true* refers to high and *false* refers to low.
+    # Sets the output value (high or low) with a bitmask (4bit). A 1 in the bitmask
+    # means high and a 0 in the bitmask means low.
     # 
     # For example: The value 3 or 0b0011 will turn the pins 0-1 high and the
     # pins 2-3 low.
@@ -125,7 +123,8 @@ module Tinkerforge
       send_request(FUNCTION_SET_CONFIGURATION, [selection_mask, direction, value], 'C k ?', 0, '')
     end
 
-    # Returns a value bitmask and a direction bitmask.
+    # Returns a value bitmask and a direction bitmask. A 1 in the direction bitmask
+    # means input and a 0 in the bitmask means output.
     # 
     # For example: A return value of (3, 5) or (0b0011, 0b0101) for direction and
     # value means that:
@@ -176,7 +175,7 @@ module Tinkerforge
     # pins will be ignored.
     # 
     # The second parameter is a bitmask with the desired value of the specified
-    # output pins (*true* means high and *false* means low).
+    # output pins. A 1 in the bitmask means high and a 0 in the bitmask means low.
     # 
     # The third parameter indicates the time (in ms) that the pins should hold
     # the value.
@@ -190,8 +189,6 @@ module Tinkerforge
     # stacks. You can now call this function every second, with a time parameter
     # of two seconds and pin 0 set to high. Pin 0 will be high all the time. If now
     # the RS485 connection is lost, then pin 0 will get low in at most two seconds.
-    # 
-    # .. versionadded:: 1.1.1~(Plugin)
     def set_monoflop(selection_mask, value_mask, time)
       send_request(FUNCTION_SET_MONOFLOP, [selection_mask, value_mask, time], 'C C L', 0, '')
     end
@@ -201,8 +198,6 @@ module Tinkerforge
     # 
     # If the timer is not running currently, the remaining time will be returned
     # as 0.
-    # 
-    # .. versionadded:: 1.1.1~(Plugin)
     def get_monoflop(pin)
       send_request(FUNCTION_GET_MONOFLOP, [pin], 'C', 9, 'C L L')
     end
@@ -217,8 +212,6 @@ module Tinkerforge
     # .. note::
     #  This function does nothing for pins that are configured as input.
     #  Pull-up resistors can be switched on with BrickletIO4#set_configuration.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
     def set_selected_values(selection_mask, value_mask)
       send_request(FUNCTION_SET_SELECTED_VALUES, [selection_mask, value_mask], 'C C', 0, '')
     end
@@ -245,6 +238,8 @@ module Tinkerforge
     # 
     # The debounce time is given in ms.
     # 
+    # Configuring an edge counter resets its value to 0.
+    # 
     # If you don't know what any of this means, just leave it at default. The
     # default configuration is very likely OK for you.
     # 
@@ -269,9 +264,8 @@ module Tinkerforge
     # 
     # The position can be 'a', 'b', 'c' or 'd'.
     # 
-    # The device identifiers can be found :ref:`here <device_identifier>`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
     def get_identity
       send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
     end