tinkerforge 2.1.23 → 2.1.24

data/lib/tinkerforge/bricklet_hall_effect.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  #
@@ -95,8 +95,6 @@ module Tinkerforge
     # 
     # If you don't know what any of this means, just leave it at default. The
     # default configuration is very likely OK for you.
-    # 
-    # Default values: 0 (edge type) and 100ms (debounce time)
     def set_edge_count_config(edge_type, debounce)
       send_request FUNCTION_SET_EDGE_COUNT_CONFIG, [edge_type, debounce], 'C C', 0, ''
     end
@@ -122,13 +120,11 @@ module Tinkerforge
       send_request FUNCTION_GET_EDGE_INTERRUPT, [], '', 4, 'L'
     end
 
-    # Sets the period in ms with which the CALLBACK_EDGE_COUNT callback is triggered
+    # Sets the period with which the CALLBACK_EDGE_COUNT callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_EDGE_COUNT callback is only triggered if the edge count has changed
     # since the last triggering.
-    # 
-    # The default value is 0.
     def set_edge_count_callback_period(period)
       send_request FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD, [period], 'L', 0, ''
     end

data/lib/tinkerforge/bricklet_hall_effect_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,8 +102,7 @@ module Tinkerforge
 
     end
 
-    # Returns the `magnetic flux density (magnetic induction) <https://en.wikipedia.org/wiki/Magnetic_flux>`__
-    # in `µT (micro Tesla) <https://en.wikipedia.org/wiki/Tesla_(unit)>`__.
+    # Returns the `magnetic flux density (magnetic induction) <https://en.wikipedia.org/wiki/Magnetic_flux>`__.
     # 
     # 
     # If you want to get the value periodically, it is recommended to use the
@@ -113,7 +112,7 @@ module Tinkerforge
       send_request FUNCTION_GET_MAGNETIC_FLUX_DENSITY, [], '', 2, 's'
     end
 
-    # The period in ms is the period with which the CALLBACK_MAGNETIC_FLUX_DENSITY callback is triggered
+    # 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
@@ -138,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_magnetic_flux_density_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k s s', 0, ''
     end
@@ -151,8 +148,8 @@ module Tinkerforge
 
     # Returns the current value of the counter.
     # 
-    # You can configure the low/high thresholds in µT and the debounce time
-    # in us with BrickletHallEffectV2#set_counter_config.
+    # You can configure the low/high thresholds and the debounce time
+    # with BrickletHallEffectV2#set_counter_config.
     # 
     # If you set reset counter to *true*, the count is set back to 0
     # directly after it is read.
@@ -164,18 +161,12 @@ module Tinkerforge
       send_request FUNCTION_GET_COUNTER, [reset_counter], '?', 4, 'L'
     end
 
-    # Sets a high and a low threshold in µT as well as a debounce time in µs.
+    # Sets a high and a low threshold as well as a debounce time.
     # 
     # If the measured magnetic flux density goes above the high threshold or
     # below the low threshold, the count of the counter is increased by 1.
     # 
     # The debounce time is the minimum time between two count increments.
-    # 
-    # The default values are
-    # 
-    # * High Threshold: 2000µT
-    # * Low Threshold: -2000µT
-    # * Debounce: 100000µs (100ms)
     def set_counter_config(high_threshold, low_threshold, debounce)
       send_request FUNCTION_SET_COUNTER_CONFIG, [high_threshold, low_threshold, debounce], 's s L', 0, ''
     end
@@ -185,7 +176,7 @@ module Tinkerforge
       send_request FUNCTION_GET_COUNTER_CONFIG, [], '', 8, 's s L'
     end
 
-    # The period in ms is the period with which the CALLBACK_COUNTER
+    # The period is the period with which the CALLBACK_COUNTER
     # 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 +185,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_counter_callback_configuration(period, value_has_to_change)
       send_request FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
     end

data/lib/tinkerforge/bricklet_humidity.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  #
@@ -95,9 +95,7 @@ module Tinkerforge
 
     end
 
-    # Returns the humidity of the sensor. The value
-    # has a range of 0 to 1000 and is given in %RH/10 (Relative Humidity),
-    # i.e. a value of 421 means that a humidity of 42.1 %RH is measured.
+    # Returns the humidity of the sensor.
     # 
     # If you want to get the humidity periodically, it is recommended to use the
     # CALLBACK_HUMIDITY callback and set the period with
@@ -107,7 +105,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 BrickletHumidity#get_humidity is averaged over several samples
@@ -125,13 +122,11 @@ module Tinkerforge
       send_request FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_HUMIDITY callback is triggered
+    # Sets the period with which the CALLBACK_HUMIDITY callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_HUMIDITY callback is only triggered if the humidity has changed
     # since the last triggering.
-    # 
-    # The default value is 0.
     def set_humidity_callback_period(period)
       send_request FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -141,13 +136,11 @@ module Tinkerforge
       send_request FUNCTION_GET_HUMIDITY_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
@@ -168,8 +161,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the humidity is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the humidity is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the humidity is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_humidity_callback_threshold(option, min, max)
       send_request FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
     end
@@ -190,8 +181,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
@@ -201,7 +190,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_HUMIDITY_REACHED,
     # * CALLBACK_ANALOG_VALUE_REACHED
@@ -212,8 +201,6 @@ module Tinkerforge
     # * BrickletHumidity#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_humidity_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  #
@@ -118,9 +118,7 @@ module Tinkerforge
 
     end
 
-    # Returns the humidity measured by the sensor. The value
-    # has a range of 0 to 10000 and is given in %RH/100 (Relative Humidity),
-    # i.e. a value of 4223 means that a humidity of 42.23 %RH is measured.
+    # Returns the humidity measured by the sensor.
     # 
     # 
     # If you want to get the value periodically, it is recommended to use the
@@ -130,7 +128,7 @@ module Tinkerforge
       send_request FUNCTION_GET_HUMIDITY, [], '', 2, 'S'
     end
 
-    # The period in ms is the period with which the CALLBACK_HUMIDITY callback is triggered
+    # The period is the period with which the CALLBACK_HUMIDITY 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
@@ -155,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_humidity_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 0, ''
     end
@@ -166,9 +162,7 @@ module Tinkerforge
       send_request FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION, [], '', 10, 'L ? k S S'
     end
 
-    # Returns the temperature measured by the sensor. The value
-    # has a range of -4000 to 16500 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
@@ -178,7 +172,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
@@ -203,8 +197,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
@@ -216,8 +208,6 @@ module Tinkerforge
 
     # Enables/disables the heater. The heater can be used to dry the sensor in
     # extremely wet conditions.
-    # 
-    # By default the heater is disabled.
     def set_heater_configuration(heater_config)
       send_request FUNCTION_SET_HEATER_CONFIGURATION, [heater_config], 'C', 0, ''
     end
@@ -233,14 +223,10 @@ 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 50ms*. With a moving average of length 1000 the resulting
     # averaging window has a length of 50s. If you want to do long term measurements the longest
     # moving average will give the cleanest results.
     # 
-    # The default value is 5.
-    # 
     # \* In firmware version 2.0.3 we added the BrickletHumidityV2#set_samples_per_second function. It
     # configures the measurement frequency. Since high frequencies can result in self-heating
     # of th IC, changed the default value from 20 samples per second to 1. With 1 sample per second

data/lib/tinkerforge/bricklet_industrial_analog_out.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  #
@@ -72,7 +72,7 @@ module Tinkerforge
       send_request FUNCTION_IS_ENABLED, [], '', 1, '?'
     end
 
-    # Sets the output voltage in mV.
+    # Sets the output voltage.
     # 
     # The output voltage and output current are linked. Changing the output voltage
     # also changes the output current.
@@ -85,7 +85,7 @@ module Tinkerforge
       send_request FUNCTION_GET_VOLTAGE, [], '', 2, 'S'
     end
 
-    # Sets the output current in µA.
+    # Sets the output current.
     # 
     # The output current and output voltage are linked. Changing the output current
     # also changes the output voltage.
@@ -103,11 +103,11 @@ module Tinkerforge
     # Possible voltage ranges are:
     # 
     # * 0V to 5V
-    # * 0V to 10V (default)
+    # * 0V to 10V
     # 
     # Possible current ranges are:
     # 
-    # * 4mA to 20mA (default)
+    # * 4mA to 20mA
     # * 0mA to 20mA
     # * 0mA to 24mA
     # 

data/lib/tinkerforge/bricklet_industrial_analog_out_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  #
@@ -103,8 +103,6 @@ module Tinkerforge
     end
 
     # Enables/disables the output of voltage and current.
-    # 
-    # The default is disabled.
     def set_enabled(enabled)
       send_request FUNCTION_SET_ENABLED, [enabled], '?', 0, ''
     end
@@ -114,7 +112,7 @@ module Tinkerforge
       send_request FUNCTION_GET_ENABLED, [], '', 1, '?'
     end
 
-    # Sets the output voltage in mV.
+    # Sets the output voltage.
     # 
     # The output voltage and output current are linked. Changing the output voltage
     # also changes the output current.
@@ -127,7 +125,7 @@ module Tinkerforge
       send_request FUNCTION_GET_VOLTAGE, [], '', 2, 'S'
     end
 
-    # Sets the output current in µA.
+    # Sets the output current.
     # 
     # The output current and output voltage are linked. Changing the output current
     # also changes the output voltage.
@@ -145,11 +143,11 @@ module Tinkerforge
     # Possible voltage ranges are:
     # 
     # * 0V to 5V
-    # * 0V to 10V (default)
+    # * 0V to 10V
     # 
     # Possible current ranges are:
     # 
-    # * 4mA to 20mA (default)
+    # * 4mA to 20mA
     # * 0mA to 20mA
     # * 0mA to 24mA
     # 
@@ -170,8 +168,6 @@ module Tinkerforge
     # of the LED can change with the output value (voltage or current).
     # 
     # You can configure the channel status behavior with BrickletIndustrialAnalogOutV2#set_out_led_status_config.
-    # 
-    # By default the LED is configured as "Out Status"
     def set_out_led_config(config)
       send_request FUNCTION_SET_OUT_LED_CONFIG, [config], 'C', 0, ''
     end
@@ -202,9 +198,6 @@ module Tinkerforge
     # 8V and above and the brightness is linearly scaled between the values 2V and 8V.
     # If the min value is greater than the max value, the LED brightness is scaled the
     # other way around.
-    # 
-    # By default the channel LED status config is set to intensity with min=0V and
-    # max=10V.
     def set_out_led_status_config(min, max, config)
       send_request FUNCTION_SET_OUT_LED_STATUS_CONFIG, [min, max, config], 'S S C', 0, ''
     end

data/lib/tinkerforge/bricklet_industrial_counter.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  #
@@ -183,26 +183,12 @@ module Tinkerforge
 
     # Returns the signal data (duty cycle, period, frequency and value) for the
     # given channel.
-    # 
-    # The units are:
-    # 
-    # * Duty Cycle: 1/100 %
-    # * Period: ns
-    # * Frequency: mHz (1/1000 Hz)
-    # * Value: true = high, false = low
     def get_signal_data(channel)
       send_request FUNCTION_GET_SIGNAL_DATA, [channel], 'C', 15, 'S Q L ?'
     end
 
     # Returns the signal data (duty cycle, period, frequency and value) for all four
     # channels.
-    # 
-    # The units are:
-    # 
-    # * Duty Cycle: 1/100 %
-    # * Period: ns
-    # * Frequency: mHz (1/1000 Hz)
-    # * Value: true = high, false = low
     def get_all_signal_data
       send_request FUNCTION_GET_ALL_SIGNAL_DATA, [], '', 60, 'S4 Q4 L4 ?4'
     end
@@ -262,7 +248,7 @@ module Tinkerforge
       send_request FUNCTION_GET_COUNTER_CONFIGURATION, [channel], 'C', 4, 'C C C C'
     end
 
-    # The period in ms is the period with which the CALLBACK_ALL_COUNTER
+    # The period is the period with which the CALLBACK_ALL_COUNTER
     # 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
@@ -271,8 +257,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_all_counter_callback_configuration(period, value_has_to_change)
       send_request FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
     end
@@ -283,7 +267,7 @@ module Tinkerforge
       send_request FUNCTION_GET_ALL_COUNTER_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
     end
 
-    # The period in ms is the period with which the CALLBACK_ALL_SIGNAL_DATA
+    # The period is the period with which the CALLBACK_ALL_SIGNAL_DATA
     # 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
@@ -292,8 +276,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_all_signal_data_callback_configuration(period, value_has_to_change)
       send_request FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
     end