tinkerforge 2.1.23 → 2.1.24

data/lib/tinkerforge/bricklet_load_cell_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  #
@@ -119,7 +119,7 @@ module Tinkerforge
       send_request FUNCTION_GET_WEIGHT, [], '', 4, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_WEIGHT callback is triggered
+    # The period is the period with which the CALLBACK_WEIGHT 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
@@ -144,8 +144,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_weight_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_WEIGHT_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
     end
@@ -160,10 +158,6 @@ 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-100.
-    # 
-    # The default value is 4.
     def set_moving_average(average)
       send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'S', 0, ''
     end
@@ -187,8 +181,7 @@ module Tinkerforge
     # To calibrate your Load Cell Bricklet 2.0 you have to
     # 
     # * empty the scale and call this function with 0 and
-    # * add a known weight to the scale and call this function with the weight in
-    #   grams.
+    # * add a known weight to the scale and call this function with the weight.
     # 
     # The calibration is saved in the flash of the Bricklet and only
     # needs to be done once.
@@ -216,8 +209,6 @@ module Tinkerforge
     # means the voltage range is ±15mV for most load cells (i.e. gain of 128x
     # is best). If you don't know what all of this means you should keep it at
     # 128x, it will most likely be correct.
-    # 
-    # The default rate is 10Hz and the default gain is 128x.
     def set_configuration(rate, gain)
       send_request FUNCTION_SET_CONFIGURATION, [rate, gain], 'C C', 0, ''
     end

data/lib/tinkerforge/bricklet_moisture.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  #
@@ -71,8 +71,8 @@ module Tinkerforge
 
     end
 
-    # Returns the current moisture value. The value has a range of
-    # 0 to 4095. A small value corresponds to little moisture, a big
+    # Returns the current moisture value.
+    # A small value corresponds to little moisture, a big
     # value corresponds to much moisture.
     # 
     # If you want to get the moisture value periodically, it is recommended
@@ -82,13 +82,11 @@ module Tinkerforge
       send_request FUNCTION_GET_MOISTURE_VALUE, [], '', 2, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_MOISTURE callback is triggered
+    # Sets the period with which the CALLBACK_MOISTURE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_MOISTURE callback is only triggered if the moisture value has changed
     # since the last triggering.
-    # 
-    # The default value is 0.
     def set_moisture_callback_period(period)
       send_request FUNCTION_SET_MOISTURE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -109,8 +107,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the moisture value is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the moisture value is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the moisture value is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_moisture_callback_threshold(option, min, max)
       send_request FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
     end
@@ -120,7 +116,7 @@ module Tinkerforge
       send_request FUNCTION_GET_MOISTURE_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_MOISTURE_REACHED
     # 
@@ -129,8 +125,6 @@ module Tinkerforge
     # * BrickletMoisture#set_moisture_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
@@ -145,10 +139,6 @@ module Tinkerforge
     # 
     # Setting the length to 0 will turn the averaging completely off. With less
     # averaging, there is more noise on the data.
-    # 
-    # The range for the averaging is 0-100.
-    # 
-    # The default value is 100.
     def set_moving_average(average)
       send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'C', 0, ''
     end

data/lib/tinkerforge/bricklet_motion_detector.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_motion_detector_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  #
@@ -98,7 +98,7 @@ module Tinkerforge
       send_request FUNCTION_GET_MOTION_DETECTED, [], '', 1, 'C'
     end
 
-    # Sets the sensitivity of the PIR sensor. The range is 0-100. At full
+    # Sets the sensitivity of the PIR sensor. At full
     # sensitivity (100), the Bricklet can detect motion in a range of approximately 12m.
     # 
     # The actual range depends on many things in the environment (e.g. reflections) and the
@@ -106,8 +106,6 @@ module Tinkerforge
     # of 10m a cat may only be detected at 2m distance with the same setting.
     # 
     # So you will have to find a good sensitivity for your application by trial and error.
-    # 
-    # The default value is 50.
     def set_sensitivity(sensitivity)
       send_request FUNCTION_SET_SENSITIVITY, [sensitivity], 'C', 0, ''
     end
@@ -121,8 +119,6 @@ module Tinkerforge
     # three LEDs. The brightness of each LED can be controlled with a 8-bit value
     # (0-255). A value of 0 turns the LED off and a value of 255 turns the LED
     # to full brightness.
-    # 
-    # The default value is 0, 0, 0.
     def set_indicator(top_left, top_right, bottom)
       send_request FUNCTION_SET_INDICATOR, [top_left, top_right, bottom], 'C C C', 0, ''
     end

data/lib/tinkerforge/bricklet_motorized_linear_poti.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,7 +115,7 @@ module Tinkerforge
       send_request FUNCTION_GET_POSITION, [], '', 2, 'S'
     end
 
-    # The period in ms is the period with which the CALLBACK_POSITION callback is triggered
+    # The period is the period with which the CALLBACK_POSITION 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 +140,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_position_callback_configuration(period, value_has_to_change, option, min, max)
       send_request FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 0, ''
     end
@@ -190,8 +188,6 @@ module Tinkerforge
     end
 
     # Enables/Disables CALLBACK_POSITION_REACHED callback.
-    # 
-    # By default the callback is enabled.
     def set_position_reached_callback_configuration(enabled)
       send_request FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION, [enabled], '?', 0, ''
     end

data/lib/tinkerforge/bricklet_multi_touch.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,10 +109,6 @@ module Tinkerforge
     # 
     # After a new sensitivity is set, you likely want to call BrickletMultiTouch#recalibrate
     # to calibrate the electrodes with the newly defined sensitivity.
-    # 
-    # The valid sensitivity value range is 5-201.
-    # 
-    # The default sensitivity value is 181.
     def set_electrode_sensitivity(sensitivity)
       send_request FUNCTION_SET_ELECTRODE_SENSITIVITY, [sensitivity], 'C', 0, ''
     end

data/lib/tinkerforge/bricklet_multi_touch_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
       send_request FUNCTION_GET_TOUCH_STATE, [], '', 13, '?13'
     end
 
-    # The period in ms is the period with which the CALLBACK_TOUCH_STATE callback
+    # The period is the period with which the CALLBACK_TOUCH_STATE 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
@@ -131,8 +131,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_touch_state_callback_configuration(period, value_has_to_change)
       send_request FUNCTION_SET_TOUCH_STATE_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
     end
@@ -161,8 +159,6 @@ module Tinkerforge
     # traffic that is produced by the CALLBACK_TOUCH_STATE callback.
     # 
     # Disabling electrodes will also reduce power consumption.
-    # 
-    # Default: All electrodes enabled.
     def set_electrode_config(enabled_electrodes)
       send_request FUNCTION_SET_ELECTRODE_CONFIG, [enabled_electrodes], '?13', 0, ''
     end
@@ -181,10 +177,6 @@ module Tinkerforge
     # 
     # After a new sensitivity is set, you likely want to call BrickletMultiTouchV2#recalibrate
     # to calibrate the electrodes with the newly defined sensitivity.
-    # 
-    # The valid sensitivity value range is 5-201.
-    # 
-    # The default sensitivity value is 181.
     def set_electrode_sensitivity(sensitivity)
       send_request FUNCTION_SET_ELECTRODE_SENSITIVITY, [sensitivity], 'C', 0, ''
     end
@@ -196,8 +188,6 @@ module Tinkerforge
 
     # Configures the touch LED to be either turned off, turned on, blink in
     # heartbeat mode or show the touch state (electrode touched = LED on).
-    # 
-    # The default value is 3 (show touch state).
     def set_touch_led_config(config)
       send_request FUNCTION_SET_TOUCH_LED_CONFIG, [config], 'C', 0, ''
     end

data/lib/tinkerforge/bricklet_nfc.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  #
@@ -205,8 +205,6 @@ module Tinkerforge
     # If you change a mode, the Bricklet will reconfigure the hardware for this mode.
     # Therefore, you can only use functions corresponding to the current mode. For
     # example, in Reader mode you can only use Reader functions.
-    # 
-    # The default mode is "off".
     def set_mode(mode)
       send_request FUNCTION_SET_MODE, [mode], 'C', 0, ''
     end
@@ -284,7 +282,7 @@ module Tinkerforge
       send_request FUNCTION_READER_GET_STATE, [], '', 2, 'C ?'
     end
 
-    # Writes NDEF formated data with a maximum of 255 bytes.
+    # Writes NDEF formated data.
     # 
     # This function currently supports NFC Forum Type 2 and 4.
     # 
@@ -323,8 +321,6 @@ module Tinkerforge
 
     # Returns the NDEF data from an internal buffer. To fill the buffer
     # with a NDEF message you have to call BrickletNFC#reader_request_ndef beforehand.
-    # 
-    # The buffer can have a size of up to 8192 bytes.
     def reader_read_ndef_low_level
       send_request FUNCTION_READER_READ_NDEF_LOW_LEVEL, [], '', 64, 'S S C60'
     end
@@ -420,8 +416,6 @@ module Tinkerforge
 
     # Returns the page data from an internal buffer. To fill the buffer
     # with specific pages you have to call BrickletNFC#reader_request_page beforehand.
-    # 
-    # The buffer can have a size of up to 8192 bytes.
     def reader_read_page_low_level
       send_request FUNCTION_READER_READ_PAGE_LOW_LEVEL, [], '', 64, 'S S C60'
     end
@@ -545,7 +539,6 @@ module Tinkerforge
     end
 
     # Returns the NDEF message that was written by a NFC peer in NFC P2P mode.
-    # The maximum NDEF length is 8192 byte.
     # 
     # The NDEF message is ready if you called BrickletNFC#p2p_start_transfer with a
     # read transfer and the P2P state changed to *P2PTransferNDEFReady*.
@@ -568,7 +561,7 @@ module Tinkerforge
       send_request FUNCTION_GET_DETECTION_LED_CONFIG, [], '', 1, 'C'
     end
 
-    # Sets the maximum timeout in ms.
+    # Sets the maximum timeout.
     # 
     # This is a global maximum used for all internal state timeouts. The timeouts depend heavily
     # on the used tags etc. For example: If you use a Type 2 tag and you want to detect if
@@ -583,11 +576,9 @@ module Tinkerforge
     # If you need a fast response time to discover if a tag is present or not you can find
     # a good timeout value by trial and error for your specific tag.
     # 
-    # By default we use a very conservative timeout, to be sure that any Tag can always
+    # By default we use a very conservative timeout, to be sure that any tag can always
     # answer in time.
     # 
-    # Default timeout: 2000ms.
-    # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def set_maximum_timeout(timeout)
       send_request FUNCTION_SET_MAXIMUM_TIMEOUT, [timeout], 'S', 0, ''
@@ -734,7 +725,7 @@ module Tinkerforge
       [ret[0], ret[2][0, ret[1]]]
     end
 
-    # Writes NDEF formated data with a maximum of 255 bytes.
+    # Writes NDEF formated data.
     # 
     # This function currently supports NFC Forum Type 2 and 4.
     # 
@@ -781,8 +772,6 @@ module Tinkerforge
 
     # Returns the NDEF data from an internal buffer. To fill the buffer
     # with a NDEF message you have to call BrickletNFC#reader_request_ndef beforehand.
-    # 
-    # The buffer can have a size of up to 8192 bytes.
     def reader_read_ndef
       ndef_length = nil # assigned in block
       ndef_data = nil # assigned in block
@@ -876,8 +865,6 @@ module Tinkerforge
 
     # Returns the page data from an internal buffer. To fill the buffer
     # with specific pages you have to call BrickletNFC#reader_request_page beforehand.
-    # 
-    # The buffer can have a size of up to 8192 bytes.
     def reader_read_page
       data_length = nil # assigned in block
       data_data = nil # assigned in block
@@ -988,7 +975,6 @@ module Tinkerforge
     end
 
     # Returns the NDEF message that was written by a NFC peer in NFC P2P mode.
-    # The maximum NDEF length is 8192 byte.
     # 
     # The NDEF message is ready if you called BrickletNFC#p2p_start_transfer with a
     # read transfer and the P2P state changed to *P2PTransferNDEFReady*.

data/lib/tinkerforge/bricklet_nfc_rfid.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_oled_128x64.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  #
@@ -68,8 +68,6 @@ module Tinkerforge
 
     # Sets the window in which you can write with BrickletOLED128x64#write. One row
     # has a height of 8 pixels.
-    # 
-    # The columns have a range of 0 to 127 and the rows have a range of 0 to 7.
     def new_window(column_from, column_to, row_from, row_to)
       send_request FUNCTION_NEW_WINDOW, [column_from, column_to, row_from, row_to], 'C C C C', 0, ''
     end
@@ -83,8 +81,6 @@ module Tinkerforge
     # 
     # You can set a contrast value from 0 to 255 and you can invert the color
     # (black/white) of the display.
-    # 
-    # The default values are contrast 143 and inverting off.
     def set_display_configuration(contrast, invert)
       send_request FUNCTION_SET_DISPLAY_CONFIGURATION, [contrast, invert], 'C ?', 0, ''
     end
@@ -94,8 +90,8 @@ module Tinkerforge
       send_request FUNCTION_GET_DISPLAY_CONFIGURATION, [], '', 2, 'C ?'
     end
 
-    # Writes text to a specific line (0 to 7) with a specific position
-    # (0 to 25). The text can have a maximum of 26 characters.
+    # Writes text to a specific line with a specific position.
+    # The text can have a maximum of 26 characters.
     # 
     # For example: (1, 10, "Hello") will write *Hello* in the middle of the
     # second line of the display.