tinkerforge 2.1.11 → 2.1.12

data/lib/tinkerforge/bricklet_remote_switch.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.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  #
@@ -143,7 +143,7 @@ module Tinkerforge
       send_request(FUNCTION_SWITCH_SOCKET_C, [system_code, device_code, switch_to], 'k C C', 0, '')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # 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_rgb_led.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.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  #
@@ -43,7 +43,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_RGB_VALUE, [], '', 3, 'C C C')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # 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_rotary_encoder.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.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  #
@@ -19,7 +19,7 @@ module Tinkerforge
     # BrickletRotaryEncoder#set_count_callback_period. The parameter is the count of
     # the encoder.
     # 
-    # CALLBACK_COUNT is only triggered if the count has changed since the
+    # The CALLBACK_COUNT callback is only triggered if the count has changed since the
     # last triggering.
     CALLBACK_COUNT = 8
 
@@ -95,7 +95,7 @@ module Tinkerforge
     # Sets the period in ms with which the CALLBACK_COUNT callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_COUNT is only triggered if the count has changed since the
+    # The CALLBACK_COUNT callback is only triggered if the count has changed since the
     # last triggering.
     # 
     # The default value is 0.
@@ -108,7 +108,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_COUNT_CALLBACK_PERIOD, [], '', 4, 'L')
     end
 
-    # Sets the thresholds for the CALLBACK_COUNT_REACHED callback. 
+    # Sets the thresholds for the CALLBACK_COUNT_REACHED callback.
     # 
     # The following options are possible:
     # 
@@ -158,7 +158,7 @@ module Tinkerforge
       send_request(FUNCTION_IS_PRESSED, [], '', 1, '?')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # 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_rotary_poti.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.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  #
@@ -16,24 +16,24 @@ module Tinkerforge
     DEVICE_DISPLAY_NAME = 'Rotary Poti Bricklet' # :nodoc:
 
     # This callback is triggered periodically with the period that is set by
-    # BrickletRotaryPoti#set_position_callback_period. The parameter is the position of the
-    # Rotary Potentiometer.
+    # BrickletRotaryPoti#set_position_callback_period. The parameter is the position of
+    # the rotary potentiometer.
     # 
-    # CALLBACK_POSITION is only triggered if the position has changed since the
-    # last triggering.
+    # The CALLBACK_POSITION callback is only triggered if the position has changed since
+    # the last triggering.
     CALLBACK_POSITION = 13
 
     # This callback is triggered periodically with the period that is set by
-    # BrickletRotaryPoti#set_analog_value_callback_period. The parameter is the analog value of the
-    # Rotary Potentiometer.
+    # BrickletRotaryPoti#set_analog_value_callback_period. The parameter is the
+    # analog value of the rotary potentiometer.
     # 
-    # CALLBACK_ANALOG_VALUE is only triggered if the position has changed since the
-    # last triggering.
+    # The CALLBACK_ANALOG_VALUE callback is only triggered if the position has changed
+    # since the last triggering.
     CALLBACK_ANALOG_VALUE = 14
 
     # This callback is triggered when the threshold as set by
     # BrickletRotaryPoti#set_position_callback_threshold is reached.
-    # The parameter is the position of the Rotary Potentiometer.
+    # The parameter is the position of the rotary potentiometer.
     # 
     # If the threshold keeps being reached, the callback is triggered periodically
     # with the period as set by BrickletRotaryPoti#set_debounce_period.
@@ -41,7 +41,7 @@ module Tinkerforge
 
     # This callback is triggered when the threshold as set by
     # BrickletRotaryPoti#set_analog_value_callback_threshold is reached.
-    # The parameter is the analog value of the Rotary Potentiometer.
+    # The parameter is the analog value of the rotary potentiometer.
     # 
     # If the threshold keeps being reached, the callback is triggered periodically
     # with the period as set by BrickletRotaryPoti#set_debounce_period.
@@ -98,11 +98,11 @@ module Tinkerforge
       @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S'
     end
 
-    # Returns the position of the Rotary Potentiometer. The value is in degree 
+    # Returns the position of the rotary potentiometer. The value is in degree
     # and between -150° (turned left) and 150° (turned right).
     # 
     # If you want to get the position periodically, it is recommended to use the
-    # callback CALLBACK_POSITION and set the period with 
+    # CALLBACK_POSITION callback and set the period with
     # BrickletRotaryPoti#set_position_callback_period.
     def get_position
       send_request(FUNCTION_GET_POSITION, [], '', 2, 's')
@@ -117,8 +117,8 @@ module Tinkerforge
     #  unfiltered analog values. The only reason to use BrickletRotaryPoti#get_analog_value is,
     #  if you need the full resolution of the analog-to-digital converter.
     # 
-    # If you want the analog value periodically, it is recommended to use the 
-    # callback CALLBACK_ANALOG_VALUE and set the period with 
+    # If you want the analog value periodically, it is recommended to use the
+    # CALLBACK_ANALOG_VALUE callback and set the period with
     # BrickletRotaryPoti#set_analog_value_callback_period.
     def get_analog_value
       send_request(FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S')
@@ -127,8 +127,8 @@ module Tinkerforge
     # Sets the period in ms with which the CALLBACK_POSITION callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_POSITION is only triggered if the position has changed since the
-    # last triggering.
+    # The CALLBACK_POSITION callback is only triggered if the position has changed since
+    # the last triggering.
     # 
     # The default value is 0.
     def set_position_callback_period(period)
@@ -143,8 +143,8 @@ module Tinkerforge
     # Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_ANALOG_VALUE is only triggered if the analog value has changed since the
-    # last triggering.
+    # The CALLBACK_ANALOG_VALUE callback is only triggered if the analog value has
+    # changed since the last triggering.
     # 
     # The default value is 0.
     def set_analog_value_callback_period(period)
@@ -156,7 +156,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD, [], '', 4, 'L')
     end
 
-    # Sets the thresholds for the CALLBACK_POSITION_REACHED callback. 
+    # Sets the thresholds for the CALLBACK_POSITION_REACHED callback.
     # 
     # The following options are possible:
     # 
@@ -178,7 +178,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_POSITION_CALLBACK_THRESHOLD, [], '', 5, 'k s s')
     end
 
-    # Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback. 
+    # Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.
     # 
     # The following options are possible:
     # 
@@ -222,7 +222,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # 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_rs232.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.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  #
@@ -20,13 +20,16 @@ module Tinkerforge
     # is given in addition.
     # 
     # To enable this callback, use BrickletRS232#enable_read_callback.
-    CALLBACK_READ_CALLBACK = 8
+    CALLBACK_READ = 8
 
-    # This callback is called if an error occurs. 
+    # This callback is called if an error occurs.
     # Possible errors are overrun, parity or framing error.
     # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
-    CALLBACK_ERROR_CALLBACK = 9
+    CALLBACK_ERROR = 9
+
+    CALLBACK_READ_CALLBACK = 8 # :nodoc: for backward compatibility
+    CALLBACK_ERROR_CALLBACK = 9 # :nodoc: for backward compatibility
 
     FUNCTION_WRITE = 1 # :nodoc:
     FUNCTION_READ = 2 # :nodoc:
@@ -84,13 +87,13 @@ module Tinkerforge
       @response_expected[FUNCTION_IS_READ_CALLBACK_ENABLED] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_SET_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
       @response_expected[FUNCTION_GET_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
-      @response_expected[CALLBACK_READ_CALLBACK] = RESPONSE_EXPECTED_ALWAYS_FALSE
-      @response_expected[CALLBACK_ERROR_CALLBACK] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_READ] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_ERROR] = RESPONSE_EXPECTED_ALWAYS_FALSE
       @response_expected[FUNCTION_SET_BREAK_CONDITION] = RESPONSE_EXPECTED_FALSE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_READ_CALLBACK] = 'k60 C'
-      @callback_formats[CALLBACK_ERROR_CALLBACK] = 'C'
+      @callback_formats[CALLBACK_READ] = 'k60 C'
+      @callback_formats[CALLBACK_ERROR] = 'C'
     end
 
     # Writes a string of up to 60 characters to the RS232 interface. The string
@@ -111,26 +114,26 @@ module Tinkerforge
     # new data available.
     # 
     # Instead of polling with this function, you can also use
-    # callbacks. See BrickletRS232#enable_read_callback and CALLBACK_READ_CALLBACK.
+    # callbacks. See BrickletRS232#enable_read_callback and CALLBACK_READ callback.
     def read
       send_request(FUNCTION_READ, [], '', 61, 'k60 C')
     end
 
-    # Enables the CALLBACK_READ_CALLBACK.
+    # Enables the CALLBACK_READ callback.
     # 
     # By default the callback is disabled.
     def enable_read_callback
       send_request(FUNCTION_ENABLE_READ_CALLBACK, [], '', 0, '')
     end
 
-    # Disables the CALLBACK_READ_CALLBACK.
+    # Disables the CALLBACK_READ callback.
     # 
     # By default the callback is disabled.
     def disable_read_callback
       send_request(FUNCTION_DISABLE_READ_CALLBACK, [], '', 0, '')
     end
 
-    # Returns *true* if the CALLBACK_READ_CALLBACK is enabled,
+    # Returns *true* if the CALLBACK_READ callback is enabled,
     # *false* otherwise.
     def is_read_callback_enabled
       send_request(FUNCTION_IS_READ_CALLBACK_ENABLED, [], '', 1, '?')
@@ -154,15 +157,15 @@ module Tinkerforge
       send_request(FUNCTION_GET_CONFIGURATION, [], '', 6, 'C C C C C C')
     end
 
-    # Sets a break condition (the TX output is forced to a logic 0 state). 
-    # The parameter sets the hold-time of the break condition (in ms). 
+    # Sets a break condition (the TX output is forced to a logic 0 state).
+    # The parameter sets the hold-time of the break condition (in ms).
     # 
     # .. versionadded:: 2.0.2$nbsp;(Plugin)
     def set_break_condition(break_time)
       send_request(FUNCTION_SET_BREAK_CONDITION, [break_time], 'S', 0, '')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # 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_segment_display_4x7.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.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  #
@@ -60,7 +60,7 @@ module Tinkerforge
       send_request(FUNCTION_SET_SEGMENTS, [segments, brightness, colon], 'C4 C ?', 0, '')
     end
 
-    # Returns the segment, brightness and color data as set by 
+    # Returns the segment, brightness and color data as set by
     # BrickletSegmentDisplay4x7#set_segments.
     def get_segments
       send_request(FUNCTION_GET_SEGMENTS, [], '', 6, 'C4 C ?')
@@ -74,7 +74,7 @@ module Tinkerforge
     # *length* to 1000, a counter that goes from 0 to 100 with one second
     # pause between each increment will be started.
     # 
-    # The maximum values for *from*, *to* and *increment* is 9999, 
+    # The maximum values for *from*, *to* and *increment* is 9999,
     # the minimum value is -999.
     # 
     # Using a negative increment allows to count backwards.
@@ -91,7 +91,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_COUNTER_VALUE, [], '', 2, 'S')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # 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_solid_state_relay.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.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  #
@@ -15,8 +15,8 @@ module Tinkerforge
     DEVICE_IDENTIFIER = 244 # :nodoc:
     DEVICE_DISPLAY_NAME = 'Solid State Relay Bricklet' # :nodoc:
 
-    # This callback is triggered whenever the monoflop timer reaches 0. 
-    # The parameter is the current state of the relay 
+    # This callback is triggered whenever the monoflop timer reaches 0.
+    # The parameter is the current state of the relay
     # (the state after the monoflop).
     CALLBACK_MONOFLOP_DONE = 5
 
@@ -44,7 +44,7 @@ module Tinkerforge
       @callback_formats[CALLBACK_MONOFLOP_DONE] = '?'
     end
 
-    # Sets the state of the relays *true* means on and *false* means off. 
+    # Sets the state of the relays *true* means on and *false* means off.
     # 
     # Running monoflop timers will be overwritten if this function is called.
     # 
@@ -58,23 +58,23 @@ module Tinkerforge
       send_request(FUNCTION_GET_STATE, [], '', 1, '?')
     end
 
-    # The first parameter  is the desired state of the relay (*true* means on 
-    # and *false* means off). The second parameter indicates the time (in ms) that 
+    # The first parameter  is the desired state of the relay (*true* means on
+    # and *false* means off). The second parameter indicates the time (in ms) that
     # the relay should hold the state.
     # 
     # If this function is called with the parameters (true, 1500):
     # The relay will turn on and in 1.5s it will turn off again.
     # 
-    # A monoflop can be used as a failsafe mechanism. For example: Lets assume you 
-    # have a RS485 bus and a Solid State Relay Bricklet connected to one of the slave 
+    # A monoflop can be used as a failsafe mechanism. For example: Lets assume you
+    # have a RS485 bus and a Solid State Relay Bricklet connected to one of the slave
     # stacks. You can now call this function every second, with a time parameter
-    # of two seconds. The relay will be on all the time. If now the RS485 
+    # of two seconds. The relay will be on all the time. If now the RS485
     # connection is lost, the relay will turn off in at most two seconds.
     def set_monoflop(state, time)
       send_request(FUNCTION_SET_MONOFLOP, [state, time], '? L', 0, '')
     end
 
-    # Returns the current state and the time as set by 
+    # Returns the current state and the time as set by
     # BrickletSolidStateRelay#set_monoflop as well as the remaining time until the state flips.
     # 
     # If the timer is not running currently, the remaining time will be returned
@@ -83,7 +83,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_MONOFLOP, [], '', 9, '? L L')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # 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_sound_intensity.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.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  #
@@ -16,11 +16,11 @@ module Tinkerforge
     DEVICE_DISPLAY_NAME = 'Sound Intensity Bricklet' # :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.
+    # BrickletSoundIntensity#set_intensity_callback_period. The parameter is the intensity
+    # of the sensor.
     # 
-    # CALLBACK_INTENSITY is only triggered if the intensity has changed since the
-    # last triggering.
+    # The CALLBACK_INTENSITY callback 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
@@ -71,11 +71,12 @@ module Tinkerforge
     # Returns the current sound intensity. The value has a range of
     # 0 to 4095.
     # 
-    # The value corresponds to the `upper envelop <https://en.wikipedia.org/wiki/Envelope_(waves)>`__
+    # The value corresponds to the
+    # `upper envelop <https://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 
+    # CALLBACK_INTENSITY callback and set the period with
     # BrickletSoundIntensity#set_intensity_callback_period.
     def get_intensity
       send_request(FUNCTION_GET_INTENSITY, [], '', 2, 'S')
@@ -84,8 +85,8 @@ module Tinkerforge
     # 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 CALLBACK_INTENSITY callback is only triggered if the intensity has changed
+    # since the last triggering.
     # 
     # The default value is 0.
     def set_intensity_callback_period(period)
@@ -97,7 +98,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_INTENSITY_CALLBACK_PERIOD, [], '', 4, 'L')
     end
 
-    # Sets the thresholds for the CALLBACK_INTENSITY_REACHED callback. 
+    # Sets the thresholds for the CALLBACK_INTENSITY_REACHED callback.
     # 
     # The following options are possible:
     # 
@@ -139,7 +140,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     #