tinkerforge 2.1.23 → 2.1.24

data/lib/tinkerforge/bricklet_thermal_imaging.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  #
@@ -15,26 +15,10 @@ module Tinkerforge
     DEVICE_IDENTIFIER = 278 # :nodoc:
     DEVICE_DISPLAY_NAME = 'Thermal Imaging Bricklet' # :nodoc:
 
-    # This callback is triggered with every new high contrast image if the transfer image
-    # config is configured for high contrast callback (see BrickletThermalImaging#set_image_transfer_config).
-    # 
-    # The data is organized as a 8-bit value 80x60 pixel matrix linearized in
-    # a one-dimensional array. The data is arranged line by line from top left to
-    # bottom right.
-    # 
-    # Each 8-bit value represents one gray-scale image pixel that can directly be
-    # shown to a user on a display.
+    # See CALLBACK_HIGH_CONTRAST_IMAGE
     CALLBACK_HIGH_CONTRAST_IMAGE_LOW_LEVEL = 12
 
-    # This callback is triggered with every new temperature image if the transfer image
-    # config is configured for temperature callback (see BrickletThermalImaging#set_image_transfer_config).
-    # 
-    # The data is organized as a 16-bit value 80x60 pixel matrix linearized in
-    # a one-dimensional array. The data is arranged line by line from top left to
-    # bottom right.
-    # 
-    # Each 16-bit value represents one temperature measurement in either
-    # Kelvin/10 or Kelvin/100 (depending on the resolution set with BrickletThermalImaging#set_resolution).
+    # See CALLBACK_TEMPERATURE_IMAGE
     CALLBACK_TEMPERATURE_IMAGE_LOW_LEVEL = 13
 
     # This callback is triggered with every new high contrast image if the transfer image
@@ -46,6 +30,9 @@ module Tinkerforge
     # 
     # Each 8-bit value represents one gray-scale image pixel that can directly be
     # shown to a user on a display.
+    # 
+    # .. note::
+    #  If reconstructing the value fails, the callback is triggered with nil for image.
     CALLBACK_HIGH_CONTRAST_IMAGE = -12
 
     # This callback is triggered with every new temperature image if the transfer image
@@ -57,6 +44,9 @@ module Tinkerforge
     # 
     # Each 16-bit value represents one temperature measurement in either
     # Kelvin/10 or Kelvin/100 (depending on the resolution set with BrickletThermalImaging#set_resolution).
+    # 
+    # .. note::
+    #  If reconstructing the value fails, the callback is triggered with nil for image.
     CALLBACK_TEMPERATURE_IMAGE = -13
 
     FUNCTION_GET_HIGH_CONTRAST_IMAGE_LOW_LEVEL = 1 # :nodoc:
@@ -276,18 +266,18 @@ module Tinkerforge
     # lower the value of N the higher the influence of the current video frame whereas
     # the higher the value of N the more influence the previous damped transfer function has.
     # 
-    # Clip Limit Index 0 (AGC HEQ Clip Limit Low): This parameter defines an artificial population that is added to
+    # Clip Limit Index 0 (AGC HEQ Clip Limit High): This parameter defines the maximum number of pixels allowed
+    # to accumulate in any given histogram bin. Any additional pixels in a given bin are clipped.
+    # The effect of this parameter is to limit the influence of highly-populated bins on the
+    # resulting HEQ transformation function.
+    # 
+    # Clip Limit Index 1 (AGC HEQ Clip Limit Low): This parameter defines an artificial population that is added to
     # every non-empty histogram bin. In other words, if the Clip Limit Low is set to L, a bin
     # with an actual population of X will have an effective population of L + X. Any empty bin
     # that is nearby a populated bin will be given an artificial population of L. The effect of
     # higher values is to provide a more linear transfer function; lower values provide a more
     # non-linear (equalized) transfer function.
     # 
-    # Clip Limit Index 1 (AGC HEQ Clip Limit High): This parameter defines the maximum number of pixels allowed
-    # to accumulate in any given histogram bin. Any additional pixels in a given bin are clipped.
-    # The effect of this parameter is to limit the influence of highly-populated bins on the
-    # resulting HEQ transformation function.
-    # 
     # Empty Counts: This parameter specifies the maximum number of pixels in a bin that will be
     # interpreted as an empty bin. Histogram bins with this number of pixels or less will be
     # processed as an empty bin.

data/lib/tinkerforge/bricklet_thermocouple.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  #
@@ -105,13 +105,11 @@ module Tinkerforge
       send_request FUNCTION_GET_TEMPERATURE, [], '', 4, 'l'
     end
 
-    # Sets the period in ms with which the CALLBACK_TEMPERATURE callback is triggered
+    # Sets the period with which the CALLBACK_TEMPERATURE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_TEMPERATURE callback is only triggered if the temperature has changed
     # since the last triggering.
-    # 
-    # The default value is 0.
     def set_temperature_callback_period(period)
       send_request FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -143,7 +141,7 @@ module Tinkerforge
       send_request FUNCTION_GET_TEMPERATURE_CALLBACK_THRESHOLD, [], '', 9, 'k l l'
     end
 
-    # Sets the period in ms with which the threshold callback
+    # Sets the period with which the threshold callback
     # 
     # * CALLBACK_TEMPERATURE_REACHED
     # 
@@ -152,8 +150,6 @@ module Tinkerforge
     # * BrickletThermocouple#set_temperature_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

data/lib/tinkerforge/bricklet_thermocouple_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  #
@@ -128,7 +128,7 @@ module Tinkerforge
       send_request FUNCTION_GET_TEMPERATURE, [], '', 4, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_TEMPERATURE callback is triggered
+    # The period is the period with which the CALLBACK_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
@@ -153,8 +153,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_temperature_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
     end

data/lib/tinkerforge/bricklet_tilt.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  #

data/lib/tinkerforge/bricklet_uv_light.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  #
@@ -81,13 +81,11 @@ module Tinkerforge
       send_request FUNCTION_GET_UV_LIGHT, [], '', 4, 'L'
     end
 
-    # Sets the period in ms with which the CALLBACK_UV_LIGHT callback is triggered
+    # Sets the period with which the CALLBACK_UV_LIGHT callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_UV_LIGHT callback is only triggered if the intensity has changed since
     # the last triggering.
-    # 
-    # The default value is 0.
     def set_uv_light_callback_period(period)
       send_request FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -119,7 +117,7 @@ module Tinkerforge
       send_request FUNCTION_GET_UV_LIGHT_CALLBACK_THRESHOLD, [], '', 9, 'k L L'
     end
 
-    # Sets the period in ms with which the threshold callbacks
+    # Sets the period with which the threshold callbacks
     # 
     # * CALLBACK_UV_LIGHT_REACHED,
     # 
@@ -128,8 +126,6 @@ module Tinkerforge
     # * BrickletUVLight#set_uv_light_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_uv_light_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  #
@@ -140,7 +140,7 @@ module Tinkerforge
       send_request FUNCTION_GET_UVA, [], '', 4, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_UVA callback is triggered
+    # The period is the period with which the CALLBACK_UVA 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
@@ -165,8 +165,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_uva_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_UVA_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
     end
@@ -196,7 +194,7 @@ module Tinkerforge
       send_request FUNCTION_GET_UVB, [], '', 4, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_UVB callback is triggered
+    # The period is the period with which the CALLBACK_UVB 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
@@ -221,8 +219,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_uvb_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_UVB_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
     end
@@ -248,7 +244,7 @@ module Tinkerforge
       send_request FUNCTION_GET_UVI, [], '', 4, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_UVI callback is triggered
+    # The period is the period with which the CALLBACK_UVI 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
@@ -273,8 +269,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_uvi_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_UVI_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
     end

data/lib/tinkerforge/bricklet_voltage.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  #
@@ -121,13 +121,11 @@ module Tinkerforge
       send_request FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_VOLTAGE callback is triggered
+    # Sets the period with which the CALLBACK_VOLTAGE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since
     # the last triggering.
-    # 
-    # The default value is 0.
     def set_voltage_callback_period(period)
       send_request FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -137,13 +135,11 @@ module Tinkerforge
       send_request FUNCTION_GET_VOLTAGE_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,7 +193,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_VOLTAGE_REACHED,
     # * CALLBACK_ANALOG_VALUE_REACHED
@@ -208,8 +204,6 @@ module Tinkerforge
     # * BrickletVoltage#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_voltage_current.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  #
@@ -226,13 +226,11 @@ module Tinkerforge
       send_request FUNCTION_GET_CALIBRATION, [], '', 4, 'S 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
@@ -242,13 +240,11 @@ module Tinkerforge
       send_request FUNCTION_GET_CURRENT_CALLBACK_PERIOD, [], '', 4, 'L'
     end
 
-    # Sets the period in ms with which the CALLBACK_VOLTAGE callback is triggered
+    # Sets the period with which the CALLBACK_VOLTAGE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since
     # the last triggering.
-    # 
-    # The default value is 0.
     def set_voltage_callback_period(period)
       send_request FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -258,13 +254,11 @@ module Tinkerforge
       send_request FUNCTION_GET_VOLTAGE_CALLBACK_PERIOD, [], '', 4, 'L'
     end
 
-    # Sets the period in ms with which the CALLBACK_POWER callback is triggered
+    # Sets the period with which the CALLBACK_POWER callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_POWER callback is only triggered if the power has changed since the
     # last triggering.
-    # 
-    # The default value is 0.
     def set_power_callback_period(period)
       send_request FUNCTION_SET_POWER_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -340,7 +334,7 @@ module Tinkerforge
       send_request FUNCTION_GET_POWER_CALLBACK_THRESHOLD, [], '', 9, 'k l l'
     end
 
-    # Sets the period in ms with which the threshold callbacks
+    # Sets the period with which the threshold callbacks
     # 
     # * CALLBACK_CURRENT_REACHED,
     # * CALLBACK_VOLTAGE_REACHED,
@@ -353,8 +347,6 @@ module Tinkerforge
     # * BrickletVoltageCurrent#set_power_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_voltage_current_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  #
@@ -146,7 +146,7 @@ module Tinkerforge
       send_request FUNCTION_GET_CURRENT, [], '', 4, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_CURRENT callback is triggered
+    # The period is the period with which the CALLBACK_CURRENT 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
@@ -171,8 +171,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_current_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
     end
@@ -193,7 +191,7 @@ module Tinkerforge
       send_request FUNCTION_GET_VOLTAGE, [], '', 4, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_VOLTAGE callback is triggered
+    # The period is the period with which the CALLBACK_VOLTAGE 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
@@ -218,8 +216,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_voltage_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
     end
@@ -240,7 +236,7 @@ module Tinkerforge
       send_request FUNCTION_GET_POWER, [], '', 4, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_POWER callback is triggered
+    # The period is the period with which the CALLBACK_POWER 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 +261,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_power_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_POWER_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
     end