tinkerforge 2.1.23 → 2.1.24

data/lib/tinkerforge/bricklet_lcd_16x2.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  #
@@ -16,11 +16,11 @@ module Tinkerforge
     DEVICE_DISPLAY_NAME = 'LCD 16x2 Bricklet' # :nodoc:
 
     # This callback is triggered when a button is pressed. The parameter is
-    # the number of the button (0 to 2).
+    # the number of the button.
     CALLBACK_BUTTON_PRESSED = 9
 
     # This callback is triggered when a button is released. The parameter is
-    # the number of the button (0 to 2).
+    # the number of the button.
     CALLBACK_BUTTON_RELEASED = 10
 
     FUNCTION_WRITE_LINE = 1 # :nodoc:
@@ -60,8 +60,8 @@ module Tinkerforge
 
     end
 
-    # Writes text to a specific line (0 to 1) with a specific position
-    # (0 to 15). The text can have a maximum of 16 characters.
+    # Writes text to a specific line with a specific position.
+    # The text can have a maximum of 16 characters.
     # 
     # For example: (0, 5, "Hello") will write *Hello* in the middle of the
     # first line of the display.
@@ -99,8 +99,6 @@ module Tinkerforge
     # should be blinking (shown as a blinking block). The cursor position
     # is one character behind the the last text written with
     # BrickletLCD16x2#write_line.
-    # 
-    # The default is (false, false).
     def set_config(cursor, blinking)
       send_request FUNCTION_SET_CONFIG, [cursor, blinking], '? ?', 0, ''
     end
@@ -110,7 +108,7 @@ module Tinkerforge
       send_request FUNCTION_GET_CONFIG, [], '', 2, '? ?'
     end
 
-    # Returns *true* if the button (0 to 2) is pressed.
+    # Returns *true* if the button is pressed.
     # 
     # If you want to react on button presses and releases it is recommended to use the
     # CALLBACK_BUTTON_PRESSED and CALLBACK_BUTTON_RELEASED callbacks.

data/lib/tinkerforge/bricklet_lcd_20x4.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,8 @@ module Tinkerforge
 
     end
 
-    # Writes text to a specific line (0 to 3) with a specific position
-    # (0 to 19). The text can have a maximum of 20 characters.
+    # Writes text to a specific line with a specific position.
+    # The text can have a maximum of 20 characters.
     # 
     # For example: (0, 7, "Hello") will write *Hello* in the middle of the
     # first line of the display.
@@ -107,8 +107,6 @@ module Tinkerforge
     # should be blinking (shown as a blinking block). The cursor position
     # is one character behind the the last text written with
     # BrickletLCD20x4#write_line.
-    # 
-    # The default is (*false*, *false*).
     def set_config(cursor, blinking)
       send_request FUNCTION_SET_CONFIG, [cursor, blinking], '? ?', 0, ''
     end
@@ -196,8 +194,6 @@ module Tinkerforge
     # 
     # A negative counter turns the default text functionality off.
     # 
-    # The default is -1.
-    # 
     # .. versionadded:: 2.0.2$nbsp;(Plugin)
     def set_default_text_counter(counter)
       send_request FUNCTION_SET_DEFAULT_TEXT_COUNTER, [counter], 'l', 0, ''

data/lib/tinkerforge/bricklet_led_strip.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  #
@@ -16,7 +16,7 @@ module Tinkerforge
     DEVICE_DISPLAY_NAME = 'LED Strip Bricklet' # :nodoc:
 
     # This callback is triggered directly after a new frame is rendered. The
-    # parameter is the number of LEDs in that frame.
+    # parameter is the number of RGB or RGBW LEDs in that frame.
     # 
     # You should send the data for the next frame directly after this callback
     # was triggered.
@@ -107,16 +107,12 @@ module Tinkerforge
 
     end
 
-    # Sets the RGB values for the LEDs with the given *length* starting
-    # from *index*.
+    # Sets *length* RGB values for the LEDs starting from *index*.
     # 
     # To make the colors show correctly you need to configure the chip type
     # (BrickletLEDStrip#set_chip_type) and a 3-channel channel mapping (BrickletLEDStrip#set_channel_mapping)
     # according to the connected LEDs.
     # 
-    # The maximum length is 16, the index goes from 0 to 319 and the rgb values
-    # have 8 bits each.
-    # 
     # Example: If you set
     # 
     # * index to 5,
@@ -153,38 +149,35 @@ module Tinkerforge
       send_request FUNCTION_SET_RGB_VALUES, [index, length, r, g, b], 'S C C16 C16 C16', 0, ''
     end
 
-    # Returns RGB value with the given *length* starting from the
-    # given *index*.
+    # Returns *length* R, G and B values starting from the
+    # given LED *index*.
     # 
     # The values are the last values that were set by BrickletLEDStrip#set_rgb_values.
     def get_rgb_values(index, length)
       send_request FUNCTION_GET_RGB_VALUES, [index, length], 'S C', 48, 'C16 C16 C16'
     end
 
-    # Sets the frame duration in ms.
+    # Sets the frame duration.
     # 
     # Example: If you want to achieve 20 frames per second, you should
     # set the frame duration to 50ms (50ms * 20 = 1 second).
     # 
     # For an explanation of the general approach see BrickletLEDStrip#set_rgb_values.
-    # 
-    # Default value: 100ms (10 frames per second).
     def set_frame_duration(duration)
       send_request FUNCTION_SET_FRAME_DURATION, [duration], 'S', 0, ''
     end
 
-    # Returns the frame duration in ms as set by BrickletLEDStrip#set_frame_duration.
+    # Returns the frame duration as set by BrickletLEDStrip#set_frame_duration.
     def get_frame_duration
       send_request FUNCTION_GET_FRAME_DURATION, [], '', 2, 'S'
     end
 
-    # Returns the current supply voltage of the LEDs. The voltage is given in mV.
+    # Returns the current supply voltage of the LEDs.
     def get_supply_voltage
       send_request FUNCTION_GET_SUPPLY_VOLTAGE, [], '', 2, 'S'
     end
 
-    # Sets the frequency of the clock in Hz. The range is 10000Hz (10kHz) up to
-    # 2000000Hz (2MHz).
+    # Sets the frequency of the clock.
     # 
     # The Bricklet will choose the nearest achievable frequency, which may
     # be off by a few Hz. You can get the exact frequency that is used by
@@ -197,8 +190,6 @@ module Tinkerforge
     # With a decreasing frequency your maximum frames per second will decrease
     # too.
     # 
-    # The default value is 1.66MHz.
-    # 
     # .. note::
     #  The frequency in firmware version 2.0.0 is fixed at 2MHz.
     # 
@@ -223,8 +214,6 @@ module Tinkerforge
     # * LPD8806 and
     # * APA102 / DotStar.
     # 
-    # The default value is WS2801 (2801).
-    # 
     # .. versionadded:: 2.0.2$nbsp;(Plugin)
     def set_chip_type(chip)
       send_request FUNCTION_SET_CHIP_TYPE, [chip], 'S', 0, ''
@@ -237,8 +226,7 @@ module Tinkerforge
       send_request FUNCTION_GET_CHIP_TYPE, [], '', 2, 'S'
     end
 
-    # Sets the RGBW values for the LEDs with the given *length* starting
-    # from *index*.
+    # Sets *length* RGBW values for the LEDs starting from *index*.
     # 
     # To make the colors show correctly you need to configure the chip type
     # (BrickletLEDStrip#set_chip_type) and a 4-channel channel mapping (BrickletLEDStrip#set_channel_mapping)
@@ -296,8 +284,7 @@ module Tinkerforge
       send_request FUNCTION_SET_RGBW_VALUES, [index, length, r, g, b, w], 'S C C12 C12 C12 C12', 0, ''
     end
 
-    # Returns RGBW values with the given *length* starting from the
-    # given *index*.
+    # Returns *length* RGBW values starting from the given *index*.
     # 
     # The values are the last values that were set by BrickletLEDStrip#set_rgbw_values.
     # 
@@ -326,8 +313,6 @@ module Tinkerforge
     # BrickletLEDStrip#set_rgbw_values has to be used. Calling BrickletLEDStrip#set_rgb_values with a
     # 4-channel mapping will produce incorrect results.
     # 
-    # The default value is BGR (36).
-    # 
     # .. versionadded:: 2.0.6$nbsp;(Plugin)
     def set_channel_mapping(mapping)
       send_request FUNCTION_SET_CHANNEL_MAPPING, [mapping], 'C', 0, ''

data/lib/tinkerforge/bricklet_led_strip_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  #
@@ -167,7 +167,13 @@ module Tinkerforge
       send_request FUNCTION_SET_LED_VALUES_LOW_LEVEL, [index, value_length, value_chunk_offset, value_chunk_data], 'S S S C58', 0, ''
     end
 
-    # Returns the RGB(W) values as set by BrickletLEDStripV2#set_led_values.
+    # Returns *length* RGB(W) values starting from the
+    # given *index*.
+    # 
+    # If the channel mapping has 3 colors, you will get the data in the sequence
+    # RGBRGBRGB... if the channel mapping has 4 colors you will get the data in the
+    # sequence RGBWRGBWRGBW...
+    # (assuming you start at an index divisible by 3 (RGB) or 4 (RGBW)).
     def get_led_values_low_level(index, length)
       send_request FUNCTION_GET_LED_VALUES_LOW_LEVEL, [index, length], 'S S', 64, 'S S C60'
     end
@@ -224,6 +230,7 @@ module Tinkerforge
     # * WS2811,
     # * WS2812 / SK6812 / NeoPixel RGB,
     # * SK6812RGBW / NeoPixel RGBW (Chip Type = WS2812),
+    # * WS2813 / WS2815 (Chip Type = WS2812)
     # * LPD8806 and
     # * APA102 / DotStar.
     # 
@@ -450,7 +457,13 @@ module Tinkerforge
       ret
     end
 
-    # Returns the RGB(W) values as set by BrickletLEDStripV2#set_led_values.
+    # Returns *length* RGB(W) values starting from the
+    # given *index*.
+    # 
+    # If the channel mapping has 3 colors, you will get the data in the sequence
+    # RGBRGBRGB... if the channel mapping has 4 colors you will get the data in the
+    # sequence RGBWRGBWRGBW...
+    # (assuming you start at an index divisible by 3 (RGB) or 4 (RGBW)).
     def get_led_values(index, length)
       value_length = nil # assigned in block
       value_data = nil # assigned in block

data/lib/tinkerforge/bricklet_line.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  #
@@ -80,13 +80,11 @@ module Tinkerforge
       send_request FUNCTION_GET_REFLECTIVITY, [], '', 2, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_REFLECTIVITY callback is triggered
+    # Sets the period with which the CALLBACK_REFLECTIVITY callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_REFLECTIVITY callback is only triggered if the reflectivity has
     # changed since the last triggering.
-    # 
-    # The default value is 0.
     def set_reflectivity_callback_period(period)
       send_request FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -107,8 +105,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the reflectivity is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the reflectivity is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the reflectivity is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_reflectivity_callback_threshold(option, min, max)
       send_request FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
     end
@@ -118,7 +114,7 @@ module Tinkerforge
       send_request FUNCTION_GET_REFLECTIVITY_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_REFLECTIVITY_REACHED
     # 
@@ -127,8 +123,6 @@ module Tinkerforge
     # * BrickletLine#set_reflectivity_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_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  #
@@ -106,7 +106,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 BrickletLinearPoti#get_position is averaged over several samples
@@ -121,13 +120,11 @@ module Tinkerforge
       send_request FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_POSITION callback is triggered
+    # Sets the period with which the CALLBACK_POSITION callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_POSITION callback is only triggered if the position has changed
     # since the last triggering.
-    # 
-    # The default value is 0.
     def set_position_callback_period(period)
       send_request FUNCTION_SET_POSITION_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -137,13 +134,11 @@ module Tinkerforge
       send_request FUNCTION_GET_POSITION_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
@@ -164,8 +159,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the position is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the position is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the position is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_position_callback_threshold(option, min, max)
       send_request FUNCTION_SET_POSITION_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
     end
@@ -186,8 +179,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
@@ -197,7 +188,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_POSITION_REACHED,
     # * CALLBACK_ANALOG_VALUE_REACHED
@@ -208,8 +199,6 @@ module Tinkerforge
     # * BrickletLinearPoti#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_linear_poti_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  #
@@ -96,7 +96,7 @@ module Tinkerforge
       send_request FUNCTION_GET_POSITION, [], '', 1, 'C'
     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
@@ -121,8 +121,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 C C', 0, ''
     end

data/lib/tinkerforge/bricklet_load_cell.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  #
@@ -90,7 +90,7 @@ module Tinkerforge
 
     end
 
-    # Returns the currently measured weight in grams.
+    # Returns the currently measured weight.
     # 
     # If you want to get the weight periodically, it is recommended
     # to use the CALLBACK_WEIGHT callback and set the period with
@@ -99,13 +99,11 @@ module Tinkerforge
       send_request FUNCTION_GET_WEIGHT, [], '', 4, 'l'
     end
 
-    # Sets the period in ms with which the CALLBACK_WEIGHT callback is triggered
+    # Sets the period with which the CALLBACK_WEIGHT callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_WEIGHT callback is only triggered if the weight has changed since the
     # last triggering.
-    # 
-    # The default value is 0.
     def set_weight_callback_period(period)
       send_request FUNCTION_SET_WEIGHT_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -126,8 +124,6 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the weight is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the weight is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the weight is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_weight_callback_threshold(option, min, max)
       send_request FUNCTION_SET_WEIGHT_CALLBACK_THRESHOLD, [option, min, max], 'k l l', 0, ''
     end
@@ -137,7 +133,7 @@ module Tinkerforge
       send_request FUNCTION_GET_WEIGHT_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_WEIGHT_REACHED
     # 
@@ -146,8 +142,6 @@ module Tinkerforge
     # * BrickletLoadCell#set_weight_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
@@ -162,10 +156,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-40.
-    # 
-    # The default value is 4.
     def set_moving_average(average)
       send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'C', 0, ''
     end
@@ -193,8 +183,7 @@ module Tinkerforge
     # To calibrate your Load Cell Bricklet 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 EEPROM of the Bricklet and only
     # needs to be done once.
@@ -228,8 +217,6 @@ module Tinkerforge
     # 
     # We recommend to use the Brick Viewer for configuration, you don't need
     # to call this function in your source code.
-    # 
-    # 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