tinkerforge 2.1.23 → 2.1.24

data/lib/tinkerforge/bricklet_segment_display_4x7.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_segment_display_4x7_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  #
@@ -109,7 +109,7 @@ module Tinkerforge
       send_request FUNCTION_GET_SEGMENTS, [], '', 35, '?8 ?8 ?8 ?8 ?2 ?'
     end
 
-    # The brightness can be set between 0 (dark) and 7 (bright). 
+    # The brightness can be set between 0 (dark) and 7 (bright).
     # 
     # The default value is 7.
     def set_brightness(brightness)

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

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

data/lib/tinkerforge/bricklet_sound_intensity.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_INTENSITY, [], '', 2, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_INTENSITY callback is triggered
+    # Sets the period with which the CALLBACK_INTENSITY callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # 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)
       send_request FUNCTION_SET_INTENSITY_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -119,7 +117,7 @@ module Tinkerforge
       send_request FUNCTION_GET_INTENSITY_CALLBACK_THRESHOLD, [], '', 5, 'k S S'
     end
 
-    # Sets the period in ms with which the threshold callback
+    # Sets the period with which the threshold callback
     # 
     # * CALLBACK_INTENSITY_REACHED
     # 
@@ -128,8 +126,6 @@ module Tinkerforge
     # * BrickletSoundIntensity#set_intensity_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_sound_pressure_level.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  #
@@ -21,16 +21,16 @@ module Tinkerforge
     # The parameter is the same as BrickletSoundPressureLevel#get_decibel.
     CALLBACK_DECIBEL = 4
 
-    # This callback is triggered periodically according to the configuration set by
-    # BrickletSoundPressureLevel#set_spectrum_callback_configuration.
-    # 
-    # The parameter is the same as BrickletSoundPressureLevel#get_spectrum.
+    # See CALLBACK_SPECTRUM
     CALLBACK_SPECTRUM_LOW_LEVEL = 8
 
     # This callback is triggered periodically according to the configuration set by
     # BrickletSoundPressureLevel#set_spectrum_callback_configuration.
     # 
     # The parameter is the same as BrickletSoundPressureLevel#get_spectrum.
+    # 
+    # .. note::
+    #  If reconstructing the value fails, the callback is triggered with nil for spectrum.
     CALLBACK_SPECTRUM = -8
 
     FUNCTION_GET_DECIBEL = 1 # :nodoc:
@@ -135,7 +135,7 @@ module Tinkerforge
       send_request FUNCTION_GET_DECIBEL, [], '', 2, 'S'
     end
 
-    # The period in ms is the period with which the CALLBACK_DECIBEL callback is triggered
+    # The period is the period with which the CALLBACK_DECIBEL 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
@@ -160,8 +160,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_decibel_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 0, ''
     end
@@ -193,13 +191,11 @@ module Tinkerforge
       send_request FUNCTION_GET_SPECTRUM_LOW_LEVEL, [], '', 64, 'S S S30'
     end
 
-    # The period in ms is the period with which the CALLBACK_SPECTRUM callback is
+    # The period is the period with which the CALLBACK_SPECTRUM callback is
     # triggered periodically. A value of 0 turns the callback off.
     # 
     # Every new measured spectrum will be send at most once. Set the period to 1 to
     # make sure that you get every spectrum.
-    # 
-    # The default value is 0.
     def set_spectrum_callback_configuration(period)
       send_request FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION, [period], 'L', 0, ''
     end

data/lib/tinkerforge/bricklet_temperature.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  #
@@ -73,9 +73,7 @@ module Tinkerforge
 
     end
 
-    # Returns the temperature of the sensor. The value
-    # has a range of -2500 to 8500 and is given in °C/100,
-    # e.g. a value of 4223 means that a temperature of 42.23 °C is measured.
+    # Returns the temperature of the sensor.
     # 
     # If you want to get the temperature periodically, it is recommended
     # to use the CALLBACK_TEMPERATURE callback and set the period with
@@ -84,13 +82,11 @@ module Tinkerforge
       send_request FUNCTION_GET_TEMPERATURE, [], '', 2, 's'
     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
@@ -111,8 +107,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).
     def set_temperature_callback_threshold(option, min, max)
       send_request FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 0, ''
     end
@@ -122,7 +116,7 @@ module Tinkerforge
       send_request FUNCTION_GET_TEMPERATURE_CALLBACK_THRESHOLD, [], '', 5, 'k s s'
     end
 
-    # Sets the period in ms with which the threshold callback
+    # Sets the period with which the threshold callback
     # 
     # * CALLBACK_TEMPERATURE_REACHED
     # 
@@ -131,8 +125,6 @@ module Tinkerforge
     # * BrickletTemperature#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
@@ -144,7 +136,7 @@ module Tinkerforge
 
     # Sets the I2C mode. Possible modes are:
     # 
-    # * 0: Fast (400kHz, default)
+    # * 0: Fast (400kHz)
     # * 1: Slow (100kHz)
     # 
     # If you have problems with obvious outliers in the

data/lib/tinkerforge/bricklet_temperature_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,10 +99,7 @@ module Tinkerforge
 
     end
 
-    # Returns the ambient temperature of the sensor. The value
-    # has a range of -400 to 1250 and is given in °C/10,
-    # e.g. a value of 423 means that an ambient temperature of 42.3 °C is
-    # measured.
+    # Returns the ambient temperature of the sensor.
     # 
     # If you want to get the ambient temperature periodically, it is recommended
     # to use the CALLBACK_AMBIENT_TEMPERATURE callback and set the period with
@@ -112,10 +109,7 @@ module Tinkerforge
     end
 
     # Returns the object temperature of the sensor, i.e. the temperature
-    # of the surface of the object the sensor is aimed at. The value
-    # has a range of -700 to 3800 and is given in °C/10,
-    # e.g. a value of 3001 means that a temperature of 300.1 °C is measured
-    # on the surface of the object.
+    # of the surface of the object the sensor is aimed at.
     # 
     # The temperature of different materials is dependent on their `emissivity
     # <https://en.wikipedia.org/wiki/Emissivity>`__. The emissivity of the material
@@ -144,9 +138,6 @@ module Tinkerforge
     #  If you need a precise measurement for the object temperature, it is
     #  absolutely crucial that you also provide a precise emissivity.
     # 
-    # The default emissivity is 1.0 (value of 65535) and the minimum emissivity the
-    # sensor can handle is 0.1 (value of 6553).
-    # 
     # The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.
     def set_emissivity(emissivity)
       send_request FUNCTION_SET_EMISSIVITY, [emissivity], 'S', 0, ''
@@ -157,13 +148,11 @@ module Tinkerforge
       send_request FUNCTION_GET_EMISSIVITY, [], '', 2, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_AMBIENT_TEMPERATURE callback is
+    # Sets the period with which the CALLBACK_AMBIENT_TEMPERATURE callback is
     # triggered periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_AMBIENT_TEMPERATURE callback is only triggered if the temperature has
     # changed since the last triggering.
-    # 
-    # The default value is 0.
     def set_ambient_temperature_callback_period(period)
       send_request FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -173,13 +162,11 @@ module Tinkerforge
       send_request FUNCTION_GET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD, [], '', 4, 'L'
     end
 
-    # Sets the period in ms with which the CALLBACK_OBJECT_TEMPERATURE callback is
+    # Sets the period with which the CALLBACK_OBJECT_TEMPERATURE callback is
     # triggered periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_OBJECT_TEMPERATURE callback is only triggered if the temperature
     # has changed since the last triggering.
-    # 
-    # The default value is 0.
     def set_object_temperature_callback_period(period)
       send_request FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -200,8 +187,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the ambient temperature is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the ambient temperature is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the ambient temperature is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_ambient_temperature_callback_threshold(option, min, max)
       send_request FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 0, ''
     end
@@ -222,8 +207,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the object temperature is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the object temperature is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the object temperature is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_object_temperature_callback_threshold(option, min, max)
       send_request FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 0, ''
     end
@@ -233,7 +216,7 @@ module Tinkerforge
       send_request FUNCTION_GET_OBJECT_TEMPERATURE_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_AMBIENT_TEMPERATURE_REACHED,
     # * CALLBACK_OBJECT_TEMPERATURE_REACHED
@@ -244,8 +227,6 @@ module Tinkerforge
     # * BrickletTemperatureIR#set_object_temperature_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_temperature_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  #
@@ -102,10 +102,7 @@ module Tinkerforge
 
     end
 
-    # Returns the ambient temperature of the sensor. The value
-    # has a range of -400 to 1250 and is given in °C/10,
-    # e.g. a value of 423 means that an ambient temperature of 42.3 °C is
-    # measured.
+    # Returns the ambient temperature of the sensor.
     # 
     # 
     # If you want to get the value periodically, it is recommended to use the
@@ -115,7 +112,7 @@ module Tinkerforge
       send_request FUNCTION_GET_AMBIENT_TEMPERATURE, [], '', 2, 's'
     end
 
-    # The period in ms is the period with which the CALLBACK_AMBIENT_TEMPERATURE callback is triggered
+    # The period is the period with which the CALLBACK_AMBIENT_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
@@ -140,8 +137,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_ambient_temperature_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k s s', 0, ''
     end
@@ -152,10 +147,7 @@ module Tinkerforge
     end
 
     # Returns the object temperature of the sensor, i.e. the temperature
-    # of the surface of the object the sensor is aimed at. The value
-    # has a range of -700 to 3800 and is given in °C/10,
-    # e.g. a value of 3001 means that a temperature of 300.1 °C is measured
-    # on the surface of the object.
+    # of the surface of the object the sensor is aimed at.
     # 
     # The temperature of different materials is dependent on their `emissivity
     # <https://en.wikipedia.org/wiki/Emissivity>`__. The emissivity of the material
@@ -169,7 +161,7 @@ module Tinkerforge
       send_request FUNCTION_GET_OBJECT_TEMPERATURE, [], '', 2, 's'
     end
 
-    # The period in ms is the period with which the CALLBACK_OBJECT_TEMPERATURE callback is triggered
+    # The period is the period with which the CALLBACK_OBJECT_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
@@ -194,8 +186,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_object_temperature_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k s s', 0, ''
     end
@@ -221,9 +211,6 @@ module Tinkerforge
     #  If you need a precise measurement for the object temperature, it is
     #  absolutely crucial that you also provide a precise emissivity.
     # 
-    # The default emissivity is 1.0 (value of 65535) and the minimum emissivity the
-    # sensor can handle is 0.1 (value of 6553).
-    # 
     # The emissivity is stored in non-volatile memory and will still be
     # used after a restart or power cycle of the Bricklet.
     def set_emissivity(emissivity)

data/lib/tinkerforge/bricklet_temperature_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  #
@@ -91,9 +91,7 @@ module Tinkerforge
 
     end
 
-    # Returns the temperature measured by the sensor. The value
-    # has a range of -4500 to 13000 and is given in °C/100,
-    # i.e. a value of 3200 means that a temperature of 32.00 °C is measured.
+    # Returns the temperature measured by the sensor.
     # 
     # 
     # If you want to get the value periodically, it is recommended to use the
@@ -103,7 +101,7 @@ module Tinkerforge
       send_request FUNCTION_GET_TEMPERATURE, [], '', 2, 's'
     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
@@ -128,8 +126,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 s s', 0, ''
     end