tinkerforge 2.1.23 → 2.1.24

data/lib/tinkerforge/bricklet_industrial_digital_in_4.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  #
@@ -27,6 +27,8 @@ module Tinkerforge
     #   currently pin 0 is high and pins 1-3 are low.
     # * (9, 14) or (0b1001, 0b1110) means that interrupts on pins 0 and 3
     #   occurred and currently pin 0 is low and pins 1-3 are high.
+    # 
+    # The interrupts use the grouping as set by BrickletIndustrialDigitalIn4#set_group.
     CALLBACK_INTERRUPT = 9
 
     FUNCTION_GET_VALUE = 1 # :nodoc:
@@ -120,13 +122,11 @@ module Tinkerforge
       send_request FUNCTION_GET_AVAILABLE_FOR_GROUP, [], '', 1, 'C'
     end
 
-    # Sets the debounce period of the CALLBACK_INTERRUPT callback in ms.
+    # Sets the debounce period of the CALLBACK_INTERRUPT callback.
     # 
     # For example: If you set this value to 100, you will get the interrupt
     # maximal every 100ms. This is necessary if something that bounces is
     # connected to the Digital In 4 Bricklet, such as a button.
-    # 
-    # The default value is 100.
     def set_debounce_period(debounce)
       send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, ''
     end
@@ -161,6 +161,8 @@ module Tinkerforge
     # If you set the reset counter to *true*, the count is set back to 0
     # directly after it is read.
     # 
+    # The edge counters use the grouping as set by BrickletIndustrialDigitalIn4#set_group.
+    # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def get_edge_count(pin, reset_counter)
       send_request FUNCTION_GET_EDGE_COUNT, [pin, reset_counter], 'C ?', 4, 'L'
@@ -172,18 +174,16 @@ module Tinkerforge
     # The edge type parameter configures if rising edges, falling edges or
     # both are counted if the pin is configured for input. Possible edge types are:
     # 
-    # * 0 = rising (default)
+    # * 0 = rising
     # * 1 = falling
     # * 2 = both
     # 
-    # The debounce time is given in ms.
-    # 
     # Configuring an edge counter resets its value to 0.
     # 
     # 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)
+    # The edge counters use the grouping as set by BrickletIndustrialDigitalIn4#set_group.
     # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def set_edge_count_config(selection_mask, edge_type, debounce)

data/lib/tinkerforge/bricklet_industrial_digital_in_4_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  #
@@ -123,7 +123,7 @@ module Tinkerforge
 
     # This callback can be configured per channel.
     # 
-    # The period in ms is the period with which the CALLBACK_VALUE
+    # The period is the period with which the CALLBACK_VALUE
     # callback is triggered periodically. A value of 0 turns the callback off.
     # 
     # If the `value has to change`-parameter is set to true, the callback is only
@@ -132,8 +132,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_value_callback_configuration(channel, period, value_has_to_change)
       send_request FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION, [channel, period, value_has_to_change], 'C L ?', 0, ''
     end
@@ -144,7 +142,7 @@ module Tinkerforge
       send_request FUNCTION_GET_VALUE_CALLBACK_CONFIGURATION, [channel], 'C', 5, 'L ?'
     end
 
-    # The period in ms is the period with which the CALLBACK_ALL_VALUE
+    # The period is the period with which the CALLBACK_ALL_VALUE
     # callback is triggered periodically. A value of 0 turns the callback off.
     # 
     # If the `value has to change`-parameter is set to true, the callback is only
@@ -153,8 +151,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_value_callback_configuration(period, value_has_to_change)
       send_request FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
     end
@@ -179,18 +175,14 @@ module Tinkerforge
     # The edge type parameter configures if rising edges, falling edges or both are
     # counted. Possible edge types are:
     # 
-    # * 0 = rising (default)
+    # * 0 = rising
     # * 1 = falling
     # * 2 = both
     # 
-    # The debounce time is given in ms.
-    # 
     # Configuring an edge counter resets its value to 0.
     # 
     # 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_configuration(channel, edge_type, debounce)
       send_request FUNCTION_SET_EDGE_COUNT_CONFIGURATION, [channel, edge_type, debounce], 'C C C', 0, ''
     end

data/lib/tinkerforge/bricklet_industrial_digital_out_4.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,7 +81,7 @@ module Tinkerforge
     # The second parameter is a bitmask with the desired value of the specified
     # pins. A 1 in the bitmask means high and a 0 in the bitmask means low.
     # 
-    # The third parameter indicates the time (in ms) that the pins should hold
+    # The third parameter indicates the time that the pins should hold
     # the value.
     # 
     # If this function is called with the parameters (9, 1, 1500) or

data/lib/tinkerforge/bricklet_industrial_digital_out_4_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  #
@@ -122,7 +122,7 @@ module Tinkerforge
     end
 
     # The first parameter is the desired state of the channel (*true* means output *high*
-    # and *false* means output *low*). The second parameter indicates the time (in ms) that
+    # and *false* means output *low*). The second parameter indicates the time that
     # the channel should hold the state.
     # 
     # If this function is called with the parameters (true, 1500):
@@ -162,20 +162,17 @@ module Tinkerforge
       send_request FUNCTION_GET_CHANNEL_LED_CONFIG, [channel], 'C', 1, 'C'
     end
 
-    # Activates a PWM for the given channel with the frequency given in 1/10Hz and the duty
-    # cycle given in 1/100%.
+    # Activates a PWM for the given channel.
     # 
     # To turn the PWM off again, you can set the frequency to 0 or any other
     # function that changes a value of the channel (e.g. BrickletIndustrialDigitalOut4V2#set_selected_value).
     # 
-    # The maximum duty cycle value is 10000 (100%). The optocoupler of the Industrial Digital
+    # The optocoupler of the Industrial Digital
     # Out 4 Bricklet 2.0 has a rise time and fall time of 11.5us (each) at 24V. So the maximum
     # useful frequency value is about 400000 (40kHz).
     # 
     # A running monoflop timer for the given channel will be aborted if this function
     # is called.
-    # 
-    # The default values are 0, 0.
     def set_pwm_configuration(channel, frequency, duty_cycle)
       send_request FUNCTION_SET_PWM_CONFIGURATION, [channel, frequency, duty_cycle], 'C L S', 0, ''
     end

data/lib/tinkerforge/bricklet_industrial_dual_0_20ma.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  #
@@ -75,11 +75,10 @@ module Tinkerforge
 
     end
 
-    # Returns the current of the specified sensor (0 or 1). The value is in nA
-    # and between 0nA and 22505322nA (22.5mA).
+    # Returns the current of the specified sensor.
     # 
     # It is possible to detect if an IEC 60381-1 compatible sensor is connected
-    # and if it works probably.
+    # and if it works properly.
     # 
     # If the returned current is below 4mA, there is likely no sensor connected
     # or the sensor may be defect. If the returned current is over 20mA, there might
@@ -92,13 +91,11 @@ module Tinkerforge
       send_request FUNCTION_GET_CURRENT, [sensor], 'C', 4, 'l'
     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 for the given sensor. 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(sensor, period)
       send_request FUNCTION_SET_CURRENT_CALLBACK_PERIOD, [sensor, period], 'C L', 0, ''
     end
@@ -120,8 +117,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(sensor, option, min, max)
       send_request FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD, [sensor, option, min, max], 'C k l l', 0, ''
     end
@@ -131,7 +126,7 @@ module Tinkerforge
       send_request FUNCTION_GET_CURRENT_CALLBACK_THRESHOLD, [sensor], 'C', 9, 'k l l'
     end
 
-    # Sets the period in ms with which the threshold callback
+    # Sets the period with which the threshold callback
     # 
     # * CALLBACK_CURRENT_REACHED
     # 
@@ -140,8 +135,6 @@ module Tinkerforge
     # * BrickletIndustrialDual020mA#set_current_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
@@ -160,8 +153,6 @@ module Tinkerforge
     #  "1",    "60 samples per second, 14 bit resolution"
     #  "2",    "15 samples per second, 16 bit resolution"
     #  "3",    "4 samples per second, 18 bit resolution"
-    # 
-    # The default value is 3 (4 samples per second with 18 bit resolution).
     def set_sample_rate(rate)
       send_request FUNCTION_SET_SAMPLE_RATE, [rate], 'C', 0, ''
     end

data/lib/tinkerforge/bricklet_industrial_dual_0_20ma_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  #
@@ -115,8 +115,7 @@ module Tinkerforge
 
     end
 
-    # Returns the current of the specified channel. The value is in nA and between
-    # 0nA and 22505322nA (22.5mA).
+    # Returns the current of the specified channel.
     # 
     # It is possible to detect if an IEC 60381-1 compatible sensor is connected
     # and if it works probably.
@@ -133,7 +132,7 @@ module Tinkerforge
       send_request FUNCTION_GET_CURRENT, [channel], 'C', 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
@@ -158,8 +157,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(channel, period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION, [channel, period, value_has_to_change, option, min, max], 'C L ? k l l', 0, ''
     end
@@ -178,8 +175,6 @@ module Tinkerforge
     #  "1",    "60 samples per second, 14 bit resolution"
     #  "2",    "15 samples per second, 16 bit resolution"
     #  "3",    "4 samples per second, 18 bit resolution"
-    # 
-    # The default value is 3 (4 samples per second with 18 bit resolution).
     def set_sample_rate(rate)
       send_request FUNCTION_SET_SAMPLE_RATE, [rate], 'C', 0, ''
     end
@@ -194,8 +189,6 @@ module Tinkerforge
     # 
     # Example: If you measure 0.5mA with a gain of 8x the return value will be
     # 4mA.
-    # 
-    # The default gain is 1x.
     def set_gain(gain)
       send_request FUNCTION_SET_GAIN, [gain], 'C', 0, ''
     end
@@ -211,8 +204,6 @@ module Tinkerforge
     # of the LED can change with the measured value.
     # 
     # You can configure the channel status behavior with BrickletIndustrialDual020mAV2#set_channel_led_status_config.
-    # 
-    # By default all channel LEDs are configured as "Channel Status".
     def set_channel_led_config(channel, config)
       send_request FUNCTION_SET_CHANNEL_LED_CONFIG, [channel, config], 'C C', 0, ''
     end
@@ -242,9 +233,6 @@ module Tinkerforge
     # on at 20mA and above and the brightness is linearly scaled between the values
     # 4mA and 20mA. 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=4mA and
-    # max=20mA.
     def set_channel_led_status_config(channel, min, max, config)
       send_request FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG, [channel, min, max, config], 'C l l C', 0, ''
     end

data/lib/tinkerforge/bricklet_industrial_dual_analog_in.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  #
@@ -85,7 +85,7 @@ module Tinkerforge
 
     end
 
-    # Returns the voltage for the given channel in mV.
+    # Returns the voltage for the given channel.
     # 
     # If you want to get the voltage periodically, it is recommended to use the
     # CALLBACK_VOLTAGE callback and set the period with
@@ -94,13 +94,11 @@ module Tinkerforge
       send_request FUNCTION_GET_VOLTAGE, [channel], 'C', 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 for the given channel. 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(channel, period)
       send_request FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD, [channel, period], 'C L', 0, ''
     end
@@ -122,8 +120,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the voltage is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the voltage is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the voltage is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_voltage_callback_threshold(channel, option, min, max)
       send_request FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD, [channel, option, min, max], 'C k l l', 0, ''
     end
@@ -133,7 +129,7 @@ module Tinkerforge
       send_request FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD, [channel], 'C', 9, 'k l l'
     end
 
-    # Sets the period in ms with which the threshold callback
+    # Sets the period with which the threshold callback
     # 
     # * CALLBACK_VOLTAGE_REACHED
     # 
@@ -142,8 +138,6 @@ module Tinkerforge
     # * BrickletIndustrialDualAnalogIn#set_voltage_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
@@ -156,8 +150,6 @@ module Tinkerforge
     # Sets the sample rate. The sample rate can be between 1 sample per second
     # and 976 samples per second. Decreasing the sample rate will also decrease the
     # noise on the data.
-    # 
-    # The default value is 6 (2 samples per second).
     def set_sample_rate(rate)
       send_request FUNCTION_SET_SAMPLE_RATE, [rate], 'C', 0, ''
     end

data/lib/tinkerforge/bricklet_industrial_dual_analog_in_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
@@ -117,7 +117,7 @@ module Tinkerforge
 
     end
 
-    # Returns the voltage for the given channel in mV.
+    # Returns the voltage for the given channel.
     # 
     # 
     # If you want to get the value periodically, it is recommended to use the
@@ -127,7 +127,7 @@ module Tinkerforge
       send_request FUNCTION_GET_VOLTAGE, [channel], 'C', 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
@@ -152,8 +152,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(channel, period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION, [channel, period, value_has_to_change, option, min, max], 'C L ? k l l', 0, ''
     end
@@ -166,8 +164,6 @@ module Tinkerforge
     # Sets the sample rate. The sample rate can be between 1 sample per second
     # and 976 samples per second. Decreasing the sample rate will also decrease the
     # noise on the data.
-    # 
-    # The default value is 6 (2 samples per second).
     def set_sample_rate(rate)
       send_request FUNCTION_SET_SAMPLE_RATE, [rate], 'C', 0, ''
     end
@@ -234,9 +230,6 @@ module Tinkerforge
     # and the brightness is linearly scaled between the values 4V and 20V. 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_channel_led_status_config(channel, min, max, config)
       send_request FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG, [channel, min, max, config], 'C l l C', 0, ''
     end