tinkerforge 2.1.23 → 2.1.24

data/lib/tinkerforge/bricklet_distance_ir.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -99,7 +99,7 @@ module Tinkerforge
 
     end
 
-    # Returns the distance measured by the sensor. The value is in mm and possible
+    # Returns the distance measured by the sensor. Possible
     # distance ranges are 40 to 300, 100 to 800 and 200 to 1500, depending on the
     # selected IR sensor.
     # 
@@ -111,7 +111,6 @@ module Tinkerforge
     end
 
     # Returns the value as read by a 12-bit analog-to-digital converter.
-    # The value is between 0 and 4095.
     # 
     # .. note::
     #  The value returned by BrickletDistanceIR#get_distance is averaged over several samples
@@ -154,13 +153,11 @@ module Tinkerforge
       send_request FUNCTION_GET_SAMPLING_POINT, [position], 'C', 2, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_DISTANCE callback is triggered
+    # Sets the period with which the CALLBACK_DISTANCE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_DISTANCE callback is only triggered if the distance has changed since the
     # last triggering.
-    # 
-    # The default value is 0.
     def set_distance_callback_period(period)
       send_request FUNCTION_SET_DISTANCE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -170,13 +167,11 @@ module Tinkerforge
       send_request FUNCTION_GET_DISTANCE_CALLBACK_PERIOD, [], '', 4, 'L'
     end
 
-    # Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered
+    # Sets the period with which the CALLBACK_ANALOG_VALUE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # 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)
       send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -197,8 +192,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the distance is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the distance is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the distance is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_distance_callback_threshold(option, min, max)
       send_request FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
     end
@@ -219,8 +212,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the analog value is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the analog value is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the analog value is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_analog_value_callback_threshold(option, min, max)
       send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
     end
@@ -230,7 +221,7 @@ module Tinkerforge
       send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD, [], '', 5, 'k S S'
     end
 
-    # Sets the period in ms with which the threshold callbacks
+    # Sets the period with which the threshold callbacks
     # 
     # * CALLBACK_DISTANCE_REACHED,
     # * CALLBACK_ANALOG_VALUE_REACHED
@@ -241,8 +232,6 @@ module Tinkerforge
     # * BrickletDistanceIR#set_analog_value_callback_threshold
     # 
     # keep being reached.
-    # 
-    # The default value is 100.
     def set_debounce_period(debounce)
       send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, ''
     end

data/lib/tinkerforge/bricklet_distance_ir_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -117,7 +117,7 @@ module Tinkerforge
 
     end
 
-    # Returns the distance measured by the sensor. The value is in mm and possible
+    # Returns the distance measured by the sensor. Possible
     # distance ranges are 40 to 300, 100 to 800 and 200 to 1500, depending on the
     # selected IR sensor.
     # 
@@ -129,7 +129,7 @@ module Tinkerforge
       send_request FUNCTION_GET_DISTANCE, [], '', 2, 'S'
     end
 
-    # The period in ms is the period with which the CALLBACK_DISTANCE callback is triggered
+    # The period is the period with which the CALLBACK_DISTANCE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # If the `value has to change`-parameter is set to true, the callback is only
@@ -154,8 +154,6 @@ module Tinkerforge
     #  "'>'",    "Threshold is triggered when the value is greater than the min value (max is ignored)"
     # 
     # If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
-    # 
-    # The default value is (0, false, 'x', 0, 0).
     def set_distance_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 0, ''
     end
@@ -166,7 +164,6 @@ module Tinkerforge
     end
 
     # Returns the analog value as read by a analog-to-digital converter.
-    # The value has 21 bit with a range of 0 to 2097151.
     # 
     # This is unfiltered raw data. We made sure that the integration time
     # of the ADC is shorter then the measurement interval of the sensor
@@ -183,7 +180,7 @@ module Tinkerforge
       send_request FUNCTION_GET_ANALOG_VALUE, [], '', 4, 'L'
     end
 
-    # The period in ms is the period with which the CALLBACK_ANALOG_VALUE callback is triggered
+    # The period is the period with which the CALLBACK_ANALOG_VALUE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # If the `value has to change`-parameter is set to true, the callback is only
@@ -208,8 +205,6 @@ module Tinkerforge
     #  "'>'",    "Threshold is triggered when the value is greater than the min value (max is ignored)"
     # 
     # If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
-    # 
-    # The default value is (0, false, 'x', 0, 0).
     def set_analog_value_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k L L', 0, ''
     end
@@ -225,13 +220,9 @@ module Tinkerforge
     # Setting the length to 1 will turn the averaging off. With less averaging, there
     # is more noise on the data.
     # 
-    # The range for the averaging is 1-1000.
-    # 
     # New data is gathered every ~10ms. With a moving average of length 1000 the
     # resulting averaging window has a length of approximately 10s. If you want to do
     # long term measurements the longest moving average will give the cleanest results.
-    # 
-    # The default value is 25.
     def set_moving_average_configuration(moving_average_length)
       send_request FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION, [moving_average_length], 'S', 0, ''
     end
@@ -243,8 +234,6 @@ module Tinkerforge
 
     # Configures the distance LED to be either turned off, turned on, blink in
     # heartbeat mode or show the distance (brighter = object is nearer).
-    # 
-    # The default value is 3 (show distance).
     def set_distance_led_config(config)
       send_request FUNCTION_SET_DISTANCE_LED_CONFIG, [config], 'C', 0, ''
     end

data/lib/tinkerforge/bricklet_distance_us.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -71,8 +71,8 @@ module Tinkerforge
 
     end
 
-    # Returns the current distance value measured by the sensor. The value has a
-    # range of 0 to 4095. A small value corresponds to a small distance, a big
+    # Returns the current distance value measured by the sensor.
+    # A small value corresponds to a small distance, a big
     # value corresponds to a big distance. The relation between the measured distance
     # value and the actual distance is affected by the 5V supply voltage (deviations
     # in the supply voltage result in deviations in the distance values) and is
@@ -85,13 +85,11 @@ module Tinkerforge
       send_request FUNCTION_GET_DISTANCE_VALUE, [], '', 2, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_DISTANCE callback is triggered
+    # Sets the period with which the CALLBACK_DISTANCE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # Der CALLBACK_DISTANCE callback is only triggered if the distance value has changed
     # since the last triggering.
-    # 
-    # The default value is 0.
     def set_distance_callback_period(period)
       send_request FUNCTION_SET_DISTANCE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -112,8 +110,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the distance value is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the distance value is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the distance value is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_distance_callback_threshold(option, min, max)
       send_request FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
     end
@@ -123,7 +119,7 @@ module Tinkerforge
       send_request FUNCTION_GET_DISTANCE_CALLBACK_THRESHOLD, [], '', 5, 'k S S'
     end
 
-    # Sets the period in ms with which the threshold callbacks
+    # Sets the period with which the threshold callbacks
     # 
     # * CALLBACK_DISTANCE_REACHED,
     # 
@@ -132,8 +128,6 @@ module Tinkerforge
     # * BrickletDistanceUS#set_distance_callback_threshold,
     # 
     # keep being reached.
-    # 
-    # The default value is 100.
     def set_debounce_period(debounce)
       send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, ''
     end
@@ -148,10 +142,6 @@ module Tinkerforge
     # 
     # Setting the length to 0 will turn the averaging completely off. With less
     # averaging, there is more noise on the data.
-    # 
-    # The range for the averaging is 0-100.
-    # 
-    # The default value is 20.
     def set_moving_average(average)
       send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'C', 0, ''
     end

data/lib/tinkerforge/bricklet_distance_us_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -99,7 +99,7 @@ module Tinkerforge
 
     end
 
-    # Returns the distance in mm.
+    # Returns the distance.
     # 
     # 
     # If you want to get the value periodically, it is recommended to use the
@@ -109,7 +109,7 @@ module Tinkerforge
       send_request FUNCTION_GET_DISTANCE, [], '', 2, 'S'
     end
 
-    # The period in ms is the period with which the CALLBACK_DISTANCE callback is triggered
+    # The period is the period with which the CALLBACK_DISTANCE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # If the `value has to change`-parameter is set to true, the callback is only
@@ -134,8 +134,6 @@ module Tinkerforge
     #  "'>'",    "Threshold is triggered when the value is greater than the min value (max is ignored)"
     # 
     # If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
-    # 
-    # The default value is (0, false, 'x', 0, 0).
     def set_distance_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 0, ''
     end
@@ -149,8 +147,6 @@ module Tinkerforge
     # 
     # With 2 Hz update rate the noise is about ±1mm, while with 10 Hz update rate the noise
     # increases to about ±5mm.
-    # 
-    # The default update rate is 2 Hz.
     def set_update_rate(update_rate)
       send_request FUNCTION_SET_UPDATE_RATE, [update_rate], 'C', 0, ''
     end
@@ -162,8 +158,6 @@ module Tinkerforge
 
     # Configures the distance LED to be either turned off, turned on, blink in
     # heartbeat mode or show the distance (brighter = object is nearer).
-    # 
-    # The default value is 3 (show distance).
     def set_distance_led_config(config)
       send_request FUNCTION_SET_DISTANCE_LED_CONFIG, [config], 'C', 0, ''
     end

data/lib/tinkerforge/bricklet_dmx.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -37,15 +37,7 @@ module Tinkerforge
     # This callback can only be triggered in slave mode.
     CALLBACK_FRAME_AVAILABLE = 15
 
-    # This callback is called as soon as a new frame is available
-    # (written by the DMX master).
-    # 
-    # The size of the array is equivalent to the number of channels in
-    # the frame. Each byte represents one channel.
-    # 
-    # This callback can be enabled via BrickletDMX#set_frame_callback_config.
-    # 
-    # This callback can only be triggered in slave mode.
+    # See CALLBACK_FRAME
     CALLBACK_FRAME_LOW_LEVEL = 16
 
     # This callback is called if a new error occurs. It returns
@@ -61,6 +53,9 @@ module Tinkerforge
     # This callback can be enabled via BrickletDMX#set_frame_callback_config.
     # 
     # This callback can only be triggered in slave mode.
+    # 
+    # .. note::
+    #  If reconstructing the value fails, the callback is triggered with nil for frame.
     CALLBACK_FRAME = -16
 
     FUNCTION_SET_DMX_MODE = 1 # :nodoc:
@@ -159,8 +154,6 @@ module Tinkerforge
     # Sets the DMX mode to either master or slave.
     # 
     # Calling this function sets frame number to 0.
-    # 
-    # The default value is 0 (master).
     def set_dmx_mode(dmx_mode)
       send_request FUNCTION_SET_DMX_MODE, [dmx_mode], 'C', 0, ''
     end
@@ -217,7 +210,7 @@ module Tinkerforge
       send_request FUNCTION_READ_FRAME_LOW_LEVEL, [], '', 64, 'S S C56 L'
     end
 
-    # Sets the duration of a frame in ms.
+    # Sets the duration of a frame.
     # 
     # Example: If you want to achieve 20 frames per second, you should
     # set the frame duration to 50ms (50ms * 20 = 1 second).
@@ -226,8 +219,6 @@ module Tinkerforge
     # this value to 0.
     # 
     # This setting is only used in master mode.
-    # 
-    # Default value: 100ms (10 frames per second).
     def set_frame_duration(frame_duration)
       send_request FUNCTION_SET_FRAME_DURATION, [frame_duration], 'S', 0, ''
     end

data/lib/tinkerforge/bricklet_dual_button.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -74,8 +74,6 @@ module Tinkerforge
     # If you just want to set one of the LEDs and don't know the current state
     # of the other LED, you can get the state with BrickletDualButton#get_led_state or you
     # can use BrickletDualButton#set_selected_led_state.
-    # 
-    # The default value is (1, 1).
     def set_led_state(led_l, led_r)
       send_request FUNCTION_SET_LED_STATE, [led_l, led_r], 'C C', 0, ''
     end

data/lib/tinkerforge/bricklet_dual_button_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -117,8 +117,6 @@ module Tinkerforge
     # If you just want to set one of the LEDs and don't know the current state
     # of the other LED, you can get the state with BrickletDualButtonV2#get_led_state or you
     # can use BrickletDualButtonV2#set_selected_led_state.
-    # 
-    # The default value is (1, 1).
     def set_led_state(led_l, led_r)
       send_request FUNCTION_SET_LED_STATE, [led_l, led_r], 'C C', 0, ''
     end
@@ -136,7 +134,7 @@ module Tinkerforge
       send_request FUNCTION_GET_BUTTON_STATE, [], '', 2, 'C C'
     end
 
-    # Sets the state of the selected LED (0 or 1).
+    # Sets the state of the selected LED.
     # 
     # The other LED remains untouched.
     def set_selected_led_state(led, state)
@@ -145,8 +143,6 @@ module Tinkerforge
 
     # If you enable this callback, the CALLBACK_STATE_CHANGED callback is triggered
     # every time a button is pressed/released
-    # 
-    # By default this callback is disabled.
     def set_state_changed_callback_configuration(enabled)
       send_request FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION, [enabled], '?', 0, ''
     end

data/lib/tinkerforge/bricklet_dual_relay.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -54,8 +54,6 @@ module Tinkerforge
     # can use BrickletDualRelay#set_selected_state.
     # 
     # All running monoflop timers will be aborted if this function is called.
-    # 
-    # The default value is (*false*, *false*).
     def set_state(relay1, relay2)
       send_request FUNCTION_SET_STATE, [relay1, relay2], '? ?', 0, ''
     end
@@ -67,7 +65,7 @@ module Tinkerforge
 
     # The first parameter can be 1 or 2 (relay 1 or relay 2). The second parameter
     # is the desired state of the relay (*true* means on and *false* means off).
-    # The third parameter indicates the time (in ms) that the relay should hold
+    # The third parameter indicates the time that the relay should hold
     # the state.
     # 
     # If this function is called with the parameters (1, true, 1500):