tinkerforge 2.1.23 → 2.1.28

data/lib/tinkerforge/bricklet_led_strip_v2.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2021-01-15.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.28                              #
 #                                                           #
 # 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  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################
 
+require_relative './ip_connection'
+
 module Tinkerforge
   # Controls up to 2048 RGB(W) LEDs
   class BrickletLEDStripV2 < Device
@@ -104,7 +106,7 @@ module Tinkerforge
     # Creates an object with the unique device ID <tt>uid</tt> and adds it to
     # the IP Connection <tt>ipcon</tt>.
     def initialize(uid, ipcon)
-      super uid, ipcon
+      super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME
 
       @api_version = [2, 0, 0]
 
@@ -134,12 +136,13 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_FRAME_STARTED] = 'S'
+      @callback_formats[CALLBACK_FRAME_STARTED] = [10, 'S']
 
+      @ipcon.add_device self
     end
 
     # Sets the RGB(W) values for the LEDs starting from *index*.
-    # You can set at most 2048 RGB values or 1536 RGBW values.
+    # You can set at most 2048 RGB values or 1536 RGBW values (6144 byte each).
     # 
     # To make the colors show correctly you need to configure the chip type
     # (see BrickletLEDStripV2#set_chip_type) and a channel mapping (see BrickletLEDStripV2#set_channel_mapping)
@@ -164,15 +167,25 @@ module Tinkerforge
     # 
     # This approach ensures that you can change the LED colors with a fixed frame rate.
     def set_led_values_low_level(index, value_length, value_chunk_offset, value_chunk_data)
-      send_request FUNCTION_SET_LED_VALUES_LOW_LEVEL, [index, value_length, value_chunk_offset, value_chunk_data], 'S S S C58', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_LED_VALUES_LOW_LEVEL, [index, value_length, value_chunk_offset, value_chunk_data], 'S S S C58', 8, ''
     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'
+      check_validity
+
+      send_request FUNCTION_GET_LED_VALUES_LOW_LEVEL, [index, length], 'S S', 72, 'S S C60'
     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).
@@ -181,21 +194,26 @@ module Tinkerforge
     # 
     # Default value: 100ms (10 frames per second).
     def set_frame_duration(duration)
-      send_request FUNCTION_SET_FRAME_DURATION, [duration], 'S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_FRAME_DURATION, [duration], 'S', 8, ''
     end
 
-    # Returns the frame duration in ms as set by BrickletLEDStripV2#set_frame_duration.
+    # Returns the frame duration as set by BrickletLEDStripV2#set_frame_duration.
     def get_frame_duration
-      send_request FUNCTION_GET_FRAME_DURATION, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_FRAME_DURATION, [], '', 10, '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'
+      check_validity
+
+      send_request FUNCTION_GET_SUPPLY_VOLTAGE, [], '', 10, '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
@@ -207,15 +225,17 @@ module Tinkerforge
     # 
     # With a decreasing frequency your maximum frames per second will decrease
     # too.
-    # 
-    # The default value is 1.66MHz.
     def set_clock_frequency(frequency)
-      send_request FUNCTION_SET_CLOCK_FREQUENCY, [frequency], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CLOCK_FREQUENCY, [frequency], 'L', 8, ''
     end
 
     # Returns the currently used clock frequency as set by BrickletLEDStripV2#set_clock_frequency.
     def get_clock_frequency
-      send_request FUNCTION_GET_CLOCK_FREQUENCY, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_CLOCK_FREQUENCY, [], '', 12, 'L'
     end
 
     # Sets the type of the LED driver chip. We currently support the chips
@@ -224,17 +244,20 @@ module Tinkerforge
     # * WS2811,
     # * WS2812 / SK6812 / NeoPixel RGB,
     # * SK6812RGBW / NeoPixel RGBW (Chip Type = WS2812),
+    # * WS2813 / WS2815 (Chip Type = WS2812)
     # * LPD8806 and
     # * APA102 / DotStar.
-    # 
-    # The default value is WS2801 (2801).
     def set_chip_type(chip)
-      send_request FUNCTION_SET_CHIP_TYPE, [chip], 'S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CHIP_TYPE, [chip], 'S', 8, ''
     end
 
     # Returns the currently used chip type as set by BrickletLEDStripV2#set_chip_type.
     def get_chip_type
-      send_request FUNCTION_GET_CHIP_TYPE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_CHIP_TYPE, [], '', 10, 'S'
     end
 
     # Sets the channel mapping for the connected LEDs.
@@ -252,28 +275,32 @@ module Tinkerforge
     # making them 4-channel chips. Internally the brightness channel is the first
     # channel, therefore one of the Wxyz channel mappings should be used. Then
     # the W channel controls the brightness.
-    # 
-    # The default value is BGR (36).
     def set_channel_mapping(mapping)
-      send_request FUNCTION_SET_CHANNEL_MAPPING, [mapping], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CHANNEL_MAPPING, [mapping], 'C', 8, ''
     end
 
     # Returns the currently used channel mapping as set by BrickletLEDStripV2#set_channel_mapping.
     def get_channel_mapping
-      send_request FUNCTION_GET_CHANNEL_MAPPING, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_CHANNEL_MAPPING, [], '', 9, 'C'
     end
 
     # Enables/disables the CALLBACK_FRAME_STARTED callback.
-    # 
-    # By default the callback is enabled.
     def set_frame_started_callback_configuration(enable)
-      send_request FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION, [enable], '?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION, [enable], '?', 8, ''
     end
 
     # Returns the configuration as set by
     # BrickletLEDStripV2#set_frame_started_callback_configuration.
     def get_frame_started_callback_configuration
-      send_request FUNCTION_GET_FRAME_STARTED_CALLBACK_CONFIGURATION, [], '', 1, '?'
+      check_validity
+
+      send_request FUNCTION_GET_FRAME_STARTED_CALLBACK_CONFIGURATION, [], '', 9, '?'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -288,7 +315,9 @@ module Tinkerforge
     # The errors counts are for errors that occur on the Bricklet side. All
     # Bricks have a similar function that returns the errors on the Brick side.
     def get_spitfp_error_count
-      send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 16, 'L L L L'
+      check_validity
+
+      send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
     end
 
     # Sets the bootloader mode and returns the status after the requested
@@ -301,12 +330,16 @@ module Tinkerforge
     # This function is used by Brick Viewer during flashing. It should not be
     # necessary to call it in a normal user program.
     def set_bootloader_mode(mode)
-      send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
     end
 
     # Returns the current bootloader mode, see BrickletLEDStripV2#set_bootloader_mode.
     def get_bootloader_mode
-      send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
     end
 
     # Sets the firmware pointer for BrickletLEDStripV2#write_firmware. The pointer has
@@ -316,7 +349,9 @@ module Tinkerforge
     # This function is used by Brick Viewer during flashing. It should not be
     # necessary to call it in a normal user program.
     def set_write_firmware_pointer(pointer)
-      send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
     end
 
     # Writes 64 Bytes of firmware at the position as written by
@@ -328,7 +363,9 @@ module Tinkerforge
     # This function is used by Brick Viewer during flashing. It should not be
     # necessary to call it in a normal user program.
     def write_firmware(data)
-      send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
     end
 
     # Sets the status LED configuration. By default the LED shows
@@ -339,22 +376,28 @@ module Tinkerforge
     # 
     # If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
     def set_status_led_config(config)
-      send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
     end
 
     # Returns the configuration as set by BrickletLEDStripV2#set_status_led_config
     def get_status_led_config
-      send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
     end
 
-    # Returns the temperature in °C as measured inside the microcontroller. The
+    # Returns the temperature as measured inside the microcontroller. The
     # value returned is not the ambient temperature!
     # 
     # The temperature is only proportional to the real temperature and it has bad
     # accuracy. Practically it is only useful as an indicator for
     # temperature changes.
     def get_chip_temperature
-      send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 2, 's'
+      check_validity
+
+      send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
     end
 
     # Calling this function will reset the Bricklet. All configurations
@@ -364,7 +407,9 @@ module Tinkerforge
     # calling functions on the existing ones will result in
     # undefined behavior!
     def reset
-      send_request FUNCTION_RESET, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_RESET, [], '', 8, ''
     end
 
     # Writes a new UID into flash. If you want to set a new UID
@@ -373,29 +418,35 @@ module Tinkerforge
     # 
     # We recommend that you use Brick Viewer to change the UID.
     def write_uid(uid)
-      send_request FUNCTION_WRITE_UID, [uid], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
     end
 
     # Returns the current UID as an integer. Encode as
     # Base58 to get the usual string version.
     def read_uid
-      send_request FUNCTION_READ_UID, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_READ_UID, [], '', 12, 'L'
     end
 
     # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 
-    # The position can be 'a', 'b', 'c' or 'd'.
+    # The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port).
+    # A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at
+    # position 'z'.
     # 
     # The device identifier numbers can be found :ref:`here <device_identifier>`.
     # |device_identifier_constant|
     def get_identity
-      send_request FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S'
+      send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
     end
 
     # Sets the RGB(W) values for the LEDs starting from *index*.
-    # You can set at most 2048 RGB values or 1536 RGBW values.
+    # You can set at most 2048 RGB values or 1536 RGBW values (6144 byte each).
     # 
     # To make the colors show correctly you need to configure the chip type
     # (see BrickletLEDStripV2#set_chip_type) and a channel mapping (see BrickletLEDStripV2#set_channel_mapping)
@@ -450,7 +501,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,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2021-01-15.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.28                              #
 #                                                           #
 # 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  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################
 
+require_relative './ip_connection'
+
 module Tinkerforge
   # Measures reflectivity of a surface
   class BrickletLine < Device
@@ -49,7 +51,7 @@ module Tinkerforge
     # Creates an object with the unique device ID <tt>uid</tt> and adds it to
     # the IP Connection <tt>ipcon</tt>.
     def initialize(uid, ipcon)
-      super uid, ipcon
+      super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME
 
       @api_version = [2, 0, 0]
 
@@ -62,9 +64,10 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_REFLECTIVITY] = 'S'
-      @callback_formats[CALLBACK_REFLECTIVITY_REACHED] = 'S'
+      @callback_formats[CALLBACK_REFLECTIVITY] = [10, 'S']
+      @callback_formats[CALLBACK_REFLECTIVITY_REACHED] = [10, 'S']
 
+      @ipcon.add_device self
     end
 
     # Returns the currently measured reflectivity. The reflectivity is
@@ -77,23 +80,27 @@ module Tinkerforge
     # to use the CALLBACK_REFLECTIVITY callback and set the period with
     # BrickletLine#set_reflectivity_callback_period.
     def get_reflectivity
-      send_request FUNCTION_GET_REFLECTIVITY, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_REFLECTIVITY, [], '', 10, '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, ''
+      check_validity
+
+      send_request FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletLine#set_reflectivity_callback_period.
     def get_reflectivity_callback_period
-      send_request FUNCTION_GET_REFLECTIVITY_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_REFLECTIVITY_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the thresholds for the CALLBACK_REFLECTIVITY_REACHED callback.
@@ -107,18 +114,20 @@ 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, ''
+      check_validity
+
+      send_request FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, ''
     end
 
     # Returns the threshold as set by BrickletLine#set_reflectivity_callback_threshold.
     def get_reflectivity_callback_threshold
-      send_request FUNCTION_GET_REFLECTIVITY_CALLBACK_THRESHOLD, [], '', 5, 'k S S'
+      check_validity
+
+      send_request FUNCTION_GET_REFLECTIVITY_CALLBACK_THRESHOLD, [], '', 13, '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,27 +136,31 @@ 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, ''
+      check_validity
+
+      send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, ''
     end
 
     # Returns the debounce period as set by BrickletLine#set_debounce_period.
     def get_debounce_period
-      send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 12, 'L'
     end
 
     # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 
-    # The position can be 'a', 'b', 'c' or 'd'.
+    # The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port).
+    # A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at
+    # position 'z'.
     # 
     # The device identifier numbers can be found :ref:`here <device_identifier>`.
     # |device_identifier_constant|
     def get_identity
-      send_request FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S'
+      send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
     end
 
     # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.