tinkerforge 2.1.24 → 2.1.29

data/lib/tinkerforge/bricklet_rgb_led.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-11-25.      #
+# This file was automatically generated on 2021-05-06.      #
 #                                                           #
-# Ruby Bindings Version 2.1.24                              #
+# Ruby Bindings Version 2.1.29                              #
 #                                                           #
 # 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 one RGB LED
   class BrickletRGBLED < Device
@@ -23,7 +25,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]
 
@@ -32,28 +34,35 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
 
+      @ipcon.add_device self
     end
 
-    # Sets the *r*, *g* and *b* values for the LED. Each value can be between 0 and 255.
+    # Sets the *r*, *g* and *b* values for the LED.
     def set_rgb_value(r, g, b)
-      send_request FUNCTION_SET_RGB_VALUE, [r, g, b], 'C C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_RGB_VALUE, [r, g, b], 'C C C', 8, ''
     end
 
     # Returns the *r*, *g* and *b* values of the LED as set by BrickletRGBLED#set_rgb_value.
     def get_rgb_value
-      send_request FUNCTION_GET_RGB_VALUE, [], '', 3, 'C C C'
+      check_validity
+
+      send_request FUNCTION_GET_RGB_VALUE, [], '', 11, 'C C C'
     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
 
   end

data/lib/tinkerforge/bricklet_rgb_led_button.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-11-25.      #
+# This file was automatically generated on 2021-05-06.      #
 #                                                           #
-# Ruby Bindings Version 2.1.24                              #
+# Ruby Bindings Version 2.1.29                              #
 #                                                           #
 # 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
   # Push button with built-in RGB LED
   class BrickletRGBLEDButton < Device
@@ -60,7 +62,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]
 
@@ -82,43 +84,48 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_BUTTON_STATE_CHANGED] = 'C'
+      @callback_formats[CALLBACK_BUTTON_STATE_CHANGED] = [9, 'C']
 
+      @ipcon.add_device self
     end
 
     # Sets the color of the LED.
-    # 
-    # By default the LED is off (0, 0, 0).
     def set_color(red, green, blue)
-      send_request FUNCTION_SET_COLOR, [red, green, blue], 'C C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_COLOR, [red, green, blue], 'C C C', 8, ''
     end
 
     # Returns the LED color as set by BrickletRGBLEDButton#set_color.
     def get_color
-      send_request FUNCTION_GET_COLOR, [], '', 3, 'C C C'
+      check_validity
+
+      send_request FUNCTION_GET_COLOR, [], '', 11, 'C C C'
     end
 
     # Returns the current state of the button (either pressed or released).
     def get_button_state
-      send_request FUNCTION_GET_BUTTON_STATE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_BUTTON_STATE, [], '', 9, 'C'
     end
 
     # Sets a color calibration. Some colors appear brighter then others,
-    # so a calibration may be necessary for nice uniform colors.
-    # 
-    # The values range from 0% to 100%.
+    # so a calibration may be necessary for uniform colors.
     # 
     # The calibration is saved in flash. You don't need to call this
     # function on every startup.
-    # 
-    # Default value is (100, 100, 55).
     def set_color_calibration(red, green, blue)
-      send_request FUNCTION_SET_COLOR_CALIBRATION, [red, green, blue], 'C C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_COLOR_CALIBRATION, [red, green, blue], 'C C C', 8, ''
     end
 
     # Returns the color calibration as set by BrickletRGBLEDButton#set_color_calibration.
     def get_color_calibration
-      send_request FUNCTION_GET_COLOR_CALIBRATION, [], '', 3, 'C C C'
+      check_validity
+
+      send_request FUNCTION_GET_COLOR_CALIBRATION, [], '', 11, 'C C C'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -133,7 +140,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
@@ -146,12 +155,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 BrickletRGBLEDButton#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 BrickletRGBLEDButton#write_firmware. The pointer has
@@ -161,7 +174,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
@@ -173,7 +188,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
@@ -184,22 +201,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 BrickletRGBLEDButton#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
@@ -209,7 +232,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
@@ -218,25 +243,31 @@ 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
 
     # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.

data/lib/tinkerforge/bricklet_rgb_led_matrix.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-11-25.      #
+# This file was automatically generated on 2021-05-06.      #
 #                                                           #
-# Ruby Bindings Version 2.1.24                              #
+# Ruby Bindings Version 2.1.29                              #
 #                                                           #
 # 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
   # RGB LED Matrix with 8x8 pixel
   class BrickletRGBLEDMatrix < Device
@@ -62,7 +64,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]
 
@@ -89,41 +91,54 @@ 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] = 'L'
+      @callback_formats[CALLBACK_FRAME_STARTED] = [12, 'L']
 
+      @ipcon.add_device self
     end
 
     # Sets the 64 red LED values of the matrix.
     def set_red(red)
-      send_request FUNCTION_SET_RED, [red], 'C64', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_RED, [red], 'C64', 8, ''
     end
 
     # Returns the red LED values as set by BrickletRGBLEDMatrix#set_red.
     def get_red
-      send_request FUNCTION_GET_RED, [], '', 64, 'C64'
+      check_validity
+
+      send_request FUNCTION_GET_RED, [], '', 72, 'C64'
     end
 
     # Sets the 64 green LED values of the matrix.
     def set_green(green)
-      send_request FUNCTION_SET_GREEN, [green], 'C64', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_GREEN, [green], 'C64', 8, ''
     end
 
     # Returns the green LED values as set by BrickletRGBLEDMatrix#set_green.
     def get_green
-      send_request FUNCTION_GET_GREEN, [], '', 64, 'C64'
+      check_validity
+
+      send_request FUNCTION_GET_GREEN, [], '', 72, 'C64'
     end
 
     # Sets the 64 blue LED values of the matrix.
     def set_blue(blue)
-      send_request FUNCTION_SET_BLUE, [blue], 'C64', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_BLUE, [blue], 'C64', 8, ''
     end
 
     # Returns the blue LED values as set by BrickletRGBLEDMatrix#set_blue.
     def get_blue
-      send_request FUNCTION_GET_BLUE, [], '', 64, 'C64'
+      check_validity
+
+      send_request FUNCTION_GET_BLUE, [], '', 72, 'C64'
     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).
@@ -140,15 +155,17 @@ module Tinkerforge
     # * and so on.
     # 
     # For frame duration of 0 see BrickletRGBLEDMatrix#draw_frame.
-    # 
-    # Default value: 0 = off.
     def set_frame_duration(frame_duration)
-      send_request FUNCTION_SET_FRAME_DURATION, [frame_duration], 'S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_FRAME_DURATION, [frame_duration], 'S', 8, ''
     end
 
-    # Returns the frame duration in ms as set by BrickletRGBLEDMatrix#set_frame_duration.
+    # Returns the frame duration as set by BrickletRGBLEDMatrix#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
 
     # If you set the frame duration to 0 (see BrickletRGBLEDMatrix#set_frame_duration), you can use this
@@ -165,12 +182,16 @@ module Tinkerforge
     # * Wait for CALLBACK_FRAME_STARTED callback.
     # * and so on.
     def draw_frame
-      send_request FUNCTION_DRAW_FRAME, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_DRAW_FRAME, [], '', 8, ''
     end
 
-    # Returns the current supply voltage of the Bricklet. The voltage is given in mV.
+    # Returns the current supply voltage of the Bricklet.
     def get_supply_voltage
-      send_request FUNCTION_GET_SUPPLY_VOLTAGE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_SUPPLY_VOLTAGE, [], '', 10, 'S'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -185,7 +206,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
@@ -198,12 +221,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 BrickletRGBLEDMatrix#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 BrickletRGBLEDMatrix#write_firmware. The pointer has
@@ -213,7 +240,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
@@ -225,7 +254,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
@@ -236,22 +267,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 BrickletRGBLEDMatrix#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
@@ -261,7 +298,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
@@ -270,25 +309,31 @@ 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
 
     # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.