tinkerforge 2.1.23 → 2.1.24

data/lib/tinkerforge/bricklet_color.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  #
@@ -42,7 +42,7 @@ module Tinkerforge
 
     # This callback is triggered periodically with the period that is set by
     # BrickletColor#set_color_temperature_callback_period. The parameter is the
-    # color temperature in Kelvin.
+    # color temperature.
     # 
     # The CALLBACK_COLOR_TEMPERATURE callback is only triggered if the color temperature
     # has changed since the last triggering.
@@ -119,8 +119,7 @@ module Tinkerforge
 
     end
 
-    # Returns the measured color of the sensor. The values
-    # have a range of 0 to 65535.
+    # Returns the measured color of the sensor.
     # 
     # The red (r), green (g), blue (b) and clear (c) colors are measured
     # with four different photodiodes that are responsive at different
@@ -139,13 +138,11 @@ module Tinkerforge
       send_request FUNCTION_GET_COLOR, [], '', 8, 'S S S S'
     end
 
-    # Sets the period in ms with which the CALLBACK_COLOR callback is triggered
+    # Sets the period with which the CALLBACK_COLOR callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_COLOR callback is only triggered if the color has changed since the
     # last triggering.
-    # 
-    # The default value is 0.
     def set_color_callback_period(period)
       send_request FUNCTION_SET_COLOR_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -166,8 +163,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the temperature is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the temperature is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the temperature is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0, 0, 0, 0, 0, 0, 0).
     def set_color_callback_threshold(option, min_r, max_r, min_g, max_g, min_b, max_b, min_c, max_c)
       send_request FUNCTION_SET_COLOR_CALLBACK_THRESHOLD, [option, min_r, max_r, min_g, max_g, min_b, max_b, min_c, max_c], 'k S S S S S S S S', 0, ''
     end
@@ -177,7 +172,7 @@ module Tinkerforge
       send_request FUNCTION_GET_COLOR_CALLBACK_THRESHOLD, [], '', 17, 'k S S S S S S S S'
     end
 
-    # Sets the period in ms with which the threshold callback
+    # Sets the period with which the threshold callback
     # 
     # * CALLBACK_COLOR_REACHED
     # 
@@ -186,8 +181,6 @@ module Tinkerforge
     # * BrickletColor#set_color_callback_threshold
     # 
     # keeps being reached.
-    # 
-    # The default value is 100.
     def set_debounce_period(debounce)
       send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, ''
     end
@@ -240,8 +233,6 @@ module Tinkerforge
     # and accuracy. With a longer integration time the values read will
     # be more accurate but it will take longer time to get the conversion
     # results.
-    # 
-    # The default values are 60x gain and 154ms integration time.
     def set_config(gain, integration_time)
       send_request FUNCTION_SET_CONFIG, [gain, integration_time], 'C C', 0, ''
     end
@@ -264,7 +255,7 @@ module Tinkerforge
       send_request FUNCTION_GET_ILLUMINANCE, [], '', 4, 'L'
     end
 
-    # Returns the color temperature in Kelvin.
+    # Returns the color temperature.
     # 
     # To get a correct color temperature measurement make sure that the color
     # values themselves are not saturated. The color value (R, G or B)
@@ -274,13 +265,11 @@ module Tinkerforge
       send_request FUNCTION_GET_COLOR_TEMPERATURE, [], '', 2, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_ILLUMINANCE callback is triggered
+    # Sets the period with which the CALLBACK_ILLUMINANCE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_ILLUMINANCE callback is only triggered if the illuminance has changed
     # since the last triggering.
-    # 
-    # The default value is 0.
     def set_illuminance_callback_period(period)
       send_request FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -290,13 +279,11 @@ module Tinkerforge
       send_request FUNCTION_GET_ILLUMINANCE_CALLBACK_PERIOD, [], '', 4, 'L'
     end
 
-    # Sets the period in ms with which the CALLBACK_COLOR_TEMPERATURE callback is
+    # Sets the period with which the CALLBACK_COLOR_TEMPERATURE callback is
     # triggered periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_COLOR_TEMPERATURE callback is only triggered if the color temperature
     # has changed since the last triggering.
-    # 
-    # The default value is 0.
     def set_color_temperature_callback_period(period)
       send_request FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end

data/lib/tinkerforge/bricklet_color_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  #
@@ -130,8 +130,7 @@ module Tinkerforge
 
     end
 
-    # Returns the measured color of the sensor. The values
-    # have a range of 0 to 65535.
+    # Returns the measured color of the sensor.
     # 
     # The red (r), green (g), blue (b) and clear (c) colors are measured
     # with four different photodiodes that are responsive at different
@@ -150,7 +149,7 @@ module Tinkerforge
       send_request FUNCTION_GET_COLOR, [], '', 8, 'S S S S'
     end
 
-    # The period in ms is the period with which the CALLBACK_COLOR
+    # The period is the period with which the CALLBACK_COLOR
     # 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
@@ -159,8 +158,6 @@ module Tinkerforge
     # 
     # If it is set to false, the callback is continuously triggered with the period,
     # independent of the value.
-    # 
-    # The default value is (0, false).
     def set_color_callback_configuration(period, value_has_to_change)
       send_request FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
     end
@@ -189,7 +186,7 @@ module Tinkerforge
       send_request FUNCTION_GET_ILLUMINANCE, [], '', 4, 'L'
     end
 
-    # The period in ms is the period with which the CALLBACK_ILLUMINANCE callback is triggered
+    # The period is the period with which the CALLBACK_ILLUMINANCE 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
@@ -214,8 +211,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_illuminance_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k L L', 0, ''
     end
@@ -225,7 +220,7 @@ module Tinkerforge
       send_request FUNCTION_GET_ILLUMINANCE_CALLBACK_CONFIGURATION, [], '', 14, 'L ? k L L'
     end
 
-    # Returns the color temperature in Kelvin.
+    # Returns the color temperature.
     # 
     # To get a correct color temperature measurement make sure that the color
     # values themselves are not saturated. The color value (R, G or B)
@@ -240,7 +235,7 @@ module Tinkerforge
       send_request FUNCTION_GET_COLOR_TEMPERATURE, [], '', 2, 'S'
     end
 
-    # The period in ms is the period with which the CALLBACK_COLOR_TEMPERATURE callback is triggered
+    # The period is the period with which the CALLBACK_COLOR_TEMPERATURE 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
@@ -265,8 +260,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_color_temperature_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 0, ''
     end
@@ -311,8 +304,6 @@ module Tinkerforge
     # and accuracy. With a longer integration time the values read will
     # be more accurate but it will take longer to get the conversion
     # results.
-    # 
-    # The default values are 60x gain and 154ms integration time.
     def set_configuration(gain, integration_time)
       send_request FUNCTION_SET_CONFIGURATION, [gain, integration_time], 'C C', 0, ''
     end

data/lib/tinkerforge/bricklet_compass.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  #
@@ -110,7 +110,7 @@ module Tinkerforge
 
     end
 
-    # Returns the heading in 1/10 degree (north = 0 degree, east = 90 degree).
+    # Returns the heading (north = 0 degree, east = 90 degree).
     # 
     # Alternatively you can use BrickletCompass#get_magnetic_flux_density and calculate the
     # heading with ``heading = atan2(y, x) * 180 / PI``.
@@ -123,7 +123,7 @@ module Tinkerforge
       send_request FUNCTION_GET_HEADING, [], '', 2, 's'
     end
 
-    # The period in ms is the period with which the CALLBACK_HEADING callback is triggered
+    # The period is the period with which the CALLBACK_HEADING 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
@@ -148,8 +148,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_heading_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k s s', 0, ''
     end
@@ -160,7 +158,7 @@ module Tinkerforge
     end
 
     # Returns the `magnetic flux density (magnetic induction) <https://en.wikipedia.org/wiki/Magnetic_flux>`__
-    # for all three axis in 1/10 `mG (milli Gauss) <https://en.wikipedia.org/wiki/Gauss_(unit)>`__.
+    # for all three axis.
     # 
     # If you want to get the value periodically, it is recommended to use the
     # CALLBACK_MAGNETIC_FLUX_DENSITY callback. You can set the callback configuration
@@ -169,7 +167,7 @@ module Tinkerforge
       send_request FUNCTION_GET_MAGNETIC_FLUX_DENSITY, [], '', 12, 'l l l'
     end
 
-    # The period in ms is the period with which the CALLBACK_MAGNETIC_FLUX_DENSITY callback
+    # The period is the period with which the CALLBACK_MAGNETIC_FLUX_DENSITY 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
@@ -178,8 +176,6 @@ module Tinkerforge
     # 
     # If it is set to false, the callback is continuously triggered with the period,
     # independent of the value.
-    # 
-    # The default value is (0, false).
     def set_magnetic_flux_density_callback_configuration(period, value_has_to_change)
       send_request FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
     end
@@ -202,8 +198,6 @@ module Tinkerforge
     #   you will not get new data for a period of 20ms. We highly recommend that
     #   you keep the background calibration enabled and only disable it if the 20ms
     #   off-time is a problem in your application.
-    # 
-    # Default values: Data rate of 100Hz and background calibration enabled.
     def set_configuration(data_rate, background_calibration)
       send_request FUNCTION_SET_CONFIGURATION, [data_rate, background_calibration], 'C ?', 0, ''
     end

data/lib/tinkerforge/bricklet_current12.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  #
@@ -104,8 +104,7 @@ module Tinkerforge
 
     end
 
-    # Returns the current of the sensor. The value is in mA
-    # and between -12500mA and 12500mA.
+    # Returns the current of the sensor.
     # 
     # If you want to get the current periodically, it is recommended to use the
     # CALLBACK_CURRENT callback and set the period with
@@ -138,7 +137,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 BrickletCurrent12#get_current is averaged over several samples
@@ -153,13 +151,11 @@ module Tinkerforge
       send_request FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_CURRENT callback is triggered
+    # Sets the period with which the CALLBACK_CURRENT callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_CURRENT callback is only triggered if the current has changed since
     # the last triggering.
-    # 
-    # The default value is 0.
     def set_current_callback_period(period)
       send_request FUNCTION_SET_CURRENT_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -169,13 +165,11 @@ module Tinkerforge
       send_request FUNCTION_GET_CURRENT_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
@@ -196,8 +190,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the current is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the current is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the current is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_current_callback_threshold(option, min, max)
       send_request FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 0, ''
     end
@@ -218,8 +210,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
@@ -229,7 +219,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_CURRENT_REACHED,
     # * CALLBACK_ANALOG_VALUE_REACHED
@@ -240,8 +230,6 @@ module Tinkerforge
     # * BrickletCurrent12#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_current25.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  #
@@ -104,8 +104,7 @@ module Tinkerforge
 
     end
 
-    # Returns the current of the sensor. The value is in mA
-    # and between -25000mA and 25000mA.
+    # Returns the current of the sensor.
     # 
     # If you want to get the current periodically, it is recommended to use the
     # CALLBACK_CURRENT callback and set the period with
@@ -138,7 +137,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 BrickletCurrent25#get_current is averaged over several samples
@@ -153,13 +151,11 @@ module Tinkerforge
       send_request FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_CURRENT callback is triggered
+    # Sets the period with which the CALLBACK_CURRENT callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_CURRENT callback is only triggered if the current has changed since
     # the last triggering.
-    # 
-    # The default value is 0.
     def set_current_callback_period(period)
       send_request FUNCTION_SET_CURRENT_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -169,13 +165,11 @@ module Tinkerforge
       send_request FUNCTION_GET_CURRENT_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
@@ -196,8 +190,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the current is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the current is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the current is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_current_callback_threshold(option, min, max)
       send_request FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 0, ''
     end
@@ -218,8 +210,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
@@ -229,7 +219,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_CURRENT_REACHED,
     # * CALLBACK_ANALOG_VALUE_REACHED
@@ -240,8 +230,6 @@ module Tinkerforge
     # * BrickletCurrent25#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