tinkerforge 2.1.24 → 2.1.29

data/lib/tinkerforge/bricklet_distance_ir.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 distance up to 150cm with infrared light
   class BrickletDistanceIR < 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_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_DISTANCE] = 'S'
-      @callback_formats[CALLBACK_ANALOG_VALUE] = 'S'
-      @callback_formats[CALLBACK_DISTANCE_REACHED] = 'S'
-      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S'
+      @callback_formats[CALLBACK_DISTANCE] = [10, 'S']
+      @callback_formats[CALLBACK_ANALOG_VALUE] = [10, 'S']
+      @callback_formats[CALLBACK_DISTANCE_REACHED] = [10, 'S']
+      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = [10, 'S']
 
+      @ipcon.add_device self
     end
 
     # Returns the distance measured by the sensor. Possible
@@ -107,7 +110,9 @@ module Tinkerforge
     # CALLBACK_DISTANCE callback and set the period with
     # BrickletDistanceIR#set_distance_callback_period.
     def get_distance
-      send_request FUNCTION_GET_DISTANCE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_DISTANCE, [], '', 10, 'S'
     end
 
     # Returns the value as read by a 12-bit analog-to-digital converter.
@@ -122,7 +127,9 @@ module Tinkerforge
     # CALLBACK_ANALOG_VALUE callback and set the period with
     # BrickletDistanceIR#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 a sampling point value to a specific position of the lookup table.
@@ -144,13 +151,17 @@ module Tinkerforge
     #  implemented in the Brick Viewer. If you want to calibrate your Bricklet it is
     #  highly recommended to use this implementation.
     def set_sampling_point(position, distance)
-      send_request FUNCTION_SET_SAMPLING_POINT, [position, distance], 'C S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_SAMPLING_POINT, [position, distance], 'C S', 8, ''
     end
 
     # Returns the distance to a sampling point position as set by
     # BrickletDistanceIR#set_sampling_point.
     def get_sampling_point(position)
-      send_request FUNCTION_GET_SAMPLING_POINT, [position], 'C', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_SAMPLING_POINT, [position], 'C', 10, 'S'
     end
 
     # Sets the period with which the CALLBACK_DISTANCE callback is triggered
@@ -159,12 +170,16 @@ module Tinkerforge
     # The CALLBACK_DISTANCE callback is only triggered if the distance has changed since the
     # last triggering.
     def set_distance_callback_period(period)
-      send_request FUNCTION_SET_DISTANCE_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DISTANCE_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletDistanceIR#set_distance_callback_period.
     def get_distance_callback_period
-      send_request FUNCTION_GET_DISTANCE_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_DISTANCE_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the period with which the CALLBACK_ANALOG_VALUE callback is triggered
@@ -173,12 +188,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 BrickletDistanceIR#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_DISTANCE_REACHED callback.
@@ -193,12 +212,16 @@ module Tinkerforge
     #  "'<'",    "Callback is triggered when the distance is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the distance is greater than the min value (max is ignored)"
     def set_distance_callback_threshold(option, min, max)
-      send_request FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, ''
     end
 
     # Returns the threshold as set by BrickletDistanceIR#set_distance_callback_threshold.
     def get_distance_callback_threshold
-      send_request FUNCTION_GET_DISTANCE_CALLBACK_THRESHOLD, [], '', 5, 'k S S'
+      check_validity
+
+      send_request FUNCTION_GET_DISTANCE_CALLBACK_THRESHOLD, [], '', 13, 'k S S'
     end
 
     # Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.
@@ -213,12 +236,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 BrickletDistanceIR#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
@@ -233,24 +260,30 @@ 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 BrickletDistanceIR#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>.

data/lib/tinkerforge/bricklet_distance_ir_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 distance up to 150cm with infrared light
   class BrickletDistanceIRV2 < Device
@@ -83,7 +85,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]
 
@@ -112,9 +114,10 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_DISTANCE] = 'S'
-      @callback_formats[CALLBACK_ANALOG_VALUE] = 'L'
+      @callback_formats[CALLBACK_DISTANCE] = [10, 'S']
+      @callback_formats[CALLBACK_ANALOG_VALUE] = [12, 'L']
 
+      @ipcon.add_device self
     end
 
     # Returns the distance measured by the sensor. Possible
@@ -126,7 +129,9 @@ module Tinkerforge
     # CALLBACK_DISTANCE callback. You can set the callback configuration
     # with BrickletDistanceIRV2#set_distance_callback_configuration.
     def get_distance
-      send_request FUNCTION_GET_DISTANCE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_DISTANCE, [], '', 10, 'S'
     end
 
     # The period is the period with which the CALLBACK_DISTANCE callback is triggered
@@ -155,12 +160,16 @@ module Tinkerforge
     # 
     # If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
     def set_distance_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletDistanceIRV2#set_distance_callback_configuration.
     def get_distance_callback_configuration
-      send_request FUNCTION_GET_DISTANCE_CALLBACK_CONFIGURATION, [], '', 10, 'L ? k S S'
+      check_validity
+
+      send_request FUNCTION_GET_DISTANCE_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k S S'
     end
 
     # Returns the analog value as read by a analog-to-digital converter.
@@ -177,7 +186,9 @@ module Tinkerforge
     # CALLBACK_ANALOG_VALUE callback. You can set the callback configuration
     # with BrickletDistanceIRV2#set_analog_value_callback_configuration.
     def get_analog_value
-      send_request FUNCTION_GET_ANALOG_VALUE, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_ANALOG_VALUE, [], '', 12, 'L'
     end
 
     # The period is the period with which the CALLBACK_ANALOG_VALUE callback is triggered
@@ -206,12 +217,16 @@ module Tinkerforge
     # 
     # If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
     def set_analog_value_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k L L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k L L', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletDistanceIRV2#set_analog_value_callback_configuration.
     def get_analog_value_callback_configuration
-      send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_CONFIGURATION, [], '', 14, 'L ? k L L'
+      check_validity
+
+      send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k L L'
     end
 
     # Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__
@@ -224,23 +239,31 @@ module Tinkerforge
     # resulting averaging window has a length of approximately 10s. If you want to do
     # long term measurements the longest moving average will give the cleanest results.
     def set_moving_average_configuration(moving_average_length)
-      send_request FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION, [moving_average_length], 'S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION, [moving_average_length], 'S', 8, ''
     end
 
     # Returns the moving average configuration as set by BrickletDistanceIRV2#set_moving_average_configuration.
     def get_moving_average_configuration
-      send_request FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION, [], '', 10, 'S'
     end
 
     # Configures the distance LED to be either turned off, turned on, blink in
     # heartbeat mode or show the distance (brighter = object is nearer).
     def set_distance_led_config(config)
-      send_request FUNCTION_SET_DISTANCE_LED_CONFIG, [config], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DISTANCE_LED_CONFIG, [config], 'C', 8, ''
     end
 
     # Returns the LED configuration as set by BrickletDistanceIRV2#set_distance_led_config
     def get_distance_led_config
-      send_request FUNCTION_GET_DISTANCE_LED_CONFIG, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_DISTANCE_LED_CONFIG, [], '', 9, 'C'
     end
 
     # Sets the sensor type.
@@ -252,12 +275,16 @@ module Tinkerforge
     # If you want to change the sensor you can set the type in Brick Viewer,
     # you will likely never need to call this function from your program.
     def set_sensor_type(sensor)
-      send_request FUNCTION_SET_SENSOR_TYPE, [sensor], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_SENSOR_TYPE, [sensor], 'C', 8, ''
     end
 
     # Returns the sensor type as set by BrickletDistanceIRV2#set_sensor_type.
     def get_sensor_type
-      send_request FUNCTION_GET_SENSOR_TYPE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_SENSOR_TYPE, [], '', 9, 'C'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -272,7 +299,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
@@ -285,12 +314,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 BrickletDistanceIRV2#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 BrickletDistanceIRV2#write_firmware. The pointer has
@@ -300,7 +333,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
@@ -312,7 +347,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
@@ -323,22 +360,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 BrickletDistanceIRV2#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
@@ -348,7 +391,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
@@ -357,25 +402,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>.