tinkerforge 2.1.24 → 2.1.29

data/lib/tinkerforge/bricklet_analog_in_v2.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
   # Measures DC voltage between 0V and 42V
   class BrickletAnalogInV2 < Device
@@ -72,7 +74,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, 1]
 
@@ -92,11 +94,12 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_MOVING_AVERAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_VOLTAGE] = 'S'
-      @callback_formats[CALLBACK_ANALOG_VALUE] = 'S'
-      @callback_formats[CALLBACK_VOLTAGE_REACHED] = 'S'
-      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S'
+      @callback_formats[CALLBACK_VOLTAGE] = [10, 'S']
+      @callback_formats[CALLBACK_ANALOG_VALUE] = [10, 'S']
+      @callback_formats[CALLBACK_VOLTAGE_REACHED] = [10, 'S']
+      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = [10, 'S']
 
+      @ipcon.add_device self
     end
 
     # Returns the measured voltage. The resolution is approximately 10mV.
@@ -105,7 +108,9 @@ module Tinkerforge
     # CALLBACK_VOLTAGE callback and set the period with
     # BrickletAnalogInV2#set_voltage_callback_period.
     def get_voltage
-      send_request FUNCTION_GET_VOLTAGE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE, [], '', 10, 'S'
     end
 
     # Returns the value as read by a 12-bit analog-to-digital converter.
@@ -114,7 +119,9 @@ module Tinkerforge
     # CALLBACK_ANALOG_VALUE callback and set the period with
     # BrickletAnalogInV2#set_analog_value_callback_period.
     def get_analog_value
-      send_request FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_ANALOG_VALUE, [], '', 10, 'S'
     end
 
     # Sets the period with which the CALLBACK_VOLTAGE callback is triggered
@@ -123,12 +130,16 @@ module Tinkerforge
     # The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since
     # the last triggering.
     def set_voltage_callback_period(period)
-      send_request FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletAnalogInV2#set_voltage_callback_period.
     def get_voltage_callback_period
-      send_request FUNCTION_GET_VOLTAGE_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the period with which the CALLBACK_ANALOG_VALUE callback is triggered
@@ -137,12 +148,16 @@ module Tinkerforge
     # The CALLBACK_ANALOG_VALUE callback is only triggered if the analog value has
     # changed since the last triggering.
     def set_analog_value_callback_period(period)
-      send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletAnalogInV2#set_analog_value_callback_period.
     def get_analog_value_callback_period
-      send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the thresholds for the CALLBACK_VOLTAGE_REACHED callback.
@@ -157,12 +172,16 @@ module Tinkerforge
     #  "'<'",    "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)"
     def set_voltage_callback_threshold(option, min, max)
-      send_request FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, ''
     end
 
     # Returns the threshold as set by BrickletAnalogInV2#set_voltage_callback_threshold.
     def get_voltage_callback_threshold
-      send_request FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD, [], '', 5, 'k S S'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD, [], '', 13, 'k S S'
     end
 
     # Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.
@@ -177,12 +196,16 @@ module Tinkerforge
     #  "'<'",    "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)"
     def set_analog_value_callback_threshold(option, min, max)
-      send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, ''
     end
 
     # Returns the threshold as set by BrickletAnalogInV2#set_analog_value_callback_threshold.
     def get_analog_value_callback_threshold
-      send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD, [], '', 5, 'k S S'
+      check_validity
+
+      send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD, [], '', 13, 'k S S'
     end
 
     # Sets the period with which the threshold callbacks
@@ -197,12 +220,16 @@ module Tinkerforge
     # 
     # keep being reached.
     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 BrickletAnalogInV2#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
 
     # Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__
@@ -211,24 +238,30 @@ module Tinkerforge
     # Setting the length to 1 will turn the averaging off. With less
     # averaging, there is more noise on the data.
     def set_moving_average(average)
-      send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'C', 8, ''
     end
 
     # Returns the length of the moving average as set by BrickletAnalogInV2#set_moving_average.
     def get_moving_average
-      send_request FUNCTION_GET_MOVING_AVERAGE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_MOVING_AVERAGE, [], '', 9, '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
 
     # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.

data/lib/tinkerforge/bricklet_analog_in_v3.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
   # Measures DC voltage between 0V and 42V
   class BrickletAnalogInV3 < Device
@@ -75,7 +77,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]
 
@@ -99,8 +101,9 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_VOLTAGE] = 'S'
+      @callback_formats[CALLBACK_VOLTAGE] = [10, 'S']
 
+      @ipcon.add_device self
     end
 
     # Returns the measured voltage. The resolution is approximately 10mV to 1mV
@@ -111,7 +114,9 @@ module Tinkerforge
     # CALLBACK_VOLTAGE callback. You can set the callback configuration
     # with BrickletAnalogInV3#set_voltage_callback_configuration.
     def get_voltage
-      send_request FUNCTION_GET_VOLTAGE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE, [], '', 10, 'S'
     end
 
     # The period is the period with which the CALLBACK_VOLTAGE callback is triggered
@@ -140,12 +145,16 @@ module Tinkerforge
     # 
     # If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
     def set_voltage_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletAnalogInV3#set_voltage_callback_configuration.
     def get_voltage_callback_configuration
-      send_request FUNCTION_GET_VOLTAGE_CALLBACK_CONFIGURATION, [], '', 10, 'L ? k S S'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k S S'
     end
 
     # Sets the oversampling between 32x and 16384x. The Bricklet
@@ -161,12 +170,16 @@ module Tinkerforge
     # oversampling the reaction time increases (changes in voltage will be
     # measured faster).
     def set_oversampling(oversampling)
-      send_request FUNCTION_SET_OVERSAMPLING, [oversampling], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_OVERSAMPLING, [oversampling], 'C', 8, ''
     end
 
     # Returns the oversampling value as set by BrickletAnalogInV3#set_oversampling.
     def get_oversampling
-      send_request FUNCTION_GET_OVERSAMPLING, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_OVERSAMPLING, [], '', 9, 'C'
     end
 
     # Sets a calibration for the measured voltage value.
@@ -178,12 +191,16 @@ module Tinkerforge
     # the Bricklet. The calibration will be saved internally and only
     # has to be done once.
     def set_calibration(offset, multiplier, divisor)
-      send_request FUNCTION_SET_CALIBRATION, [offset, multiplier, divisor], 's S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CALIBRATION, [offset, multiplier, divisor], 's S S', 8, ''
     end
 
     # Returns the calibration as set by BrickletAnalogInV3#set_calibration.
     def get_calibration
-      send_request FUNCTION_GET_CALIBRATION, [], '', 6, 's S S'
+      check_validity
+
+      send_request FUNCTION_GET_CALIBRATION, [], '', 14, 's S S'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -198,7 +215,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
@@ -211,12 +230,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 BrickletAnalogInV3#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 BrickletAnalogInV3#write_firmware. The pointer has
@@ -226,7 +249,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
@@ -238,7 +263,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
@@ -249,22 +276,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 BrickletAnalogInV3#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
@@ -274,7 +307,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
@@ -283,25 +318,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_analog_out.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
   # Generates configurable DC voltage between 0V and 5V
   class BrickletAnalogOut < Device
@@ -29,7 +31,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]
 
@@ -40,17 +42,22 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
 
+      @ipcon.add_device self
     end
 
     # Sets the voltage. Calling this function will set
     # the mode to 0 (see BrickletAnalogOut#set_mode).
     def set_voltage(voltage)
-      send_request FUNCTION_SET_VOLTAGE, [voltage], 'S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VOLTAGE, [voltage], 'S', 8, ''
     end
 
     # Returns the voltage as set by BrickletAnalogOut#set_voltage.
     def get_voltage
-      send_request FUNCTION_GET_VOLTAGE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE, [], '', 10, 'S'
     end
 
     # Sets the mode of the analog value. Possible modes:
@@ -63,24 +70,30 @@ module Tinkerforge
     # Setting the mode to 0 will result in an output voltage of 0 V. You can jump
     # to a higher output voltage directly by calling BrickletAnalogOut#set_voltage.
     def set_mode(mode)
-      send_request FUNCTION_SET_MODE, [mode], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MODE, [mode], 'C', 8, ''
     end
 
     # Returns the mode as set by BrickletAnalogOut#set_mode.
     def get_mode
-      send_request FUNCTION_GET_MODE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_MODE, [], '', 9, '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