tinkerforge 2.1.23 → 2.1.28

data/lib/tinkerforge/bricklet_thermocouple.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 temperature with thermocouples
   class BrickletThermocouple < Device
@@ -73,7 +75,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,36 +91,40 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_ERROR_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_TEMPERATURE] = 'l'
-      @callback_formats[CALLBACK_TEMPERATURE_REACHED] = 'l'
-      @callback_formats[CALLBACK_ERROR_STATE] = '? ?'
+      @callback_formats[CALLBACK_TEMPERATURE] = [12, 'l']
+      @callback_formats[CALLBACK_TEMPERATURE_REACHED] = [12, 'l']
+      @callback_formats[CALLBACK_ERROR_STATE] = [10, '? ?']
 
+      @ipcon.add_device self
     end
 
-    # Returns the temperature of the thermocouple. The value is given in °C/100,
-    # e.g. a value of 4223 means that a temperature of 42.23 °C is measured.
+    # Returns the temperature of the thermocouple.
     # 
     # If you want to get the temperature periodically, it is recommended
     # to use the CALLBACK_TEMPERATURE callback and set the period with
     # BrickletThermocouple#set_temperature_callback_period.
     def get_temperature
-      send_request FUNCTION_GET_TEMPERATURE, [], '', 4, 'l'
+      check_validity
+
+      send_request FUNCTION_GET_TEMPERATURE, [], '', 12, 'l'
     end
 
-    # Sets the period in ms with which the CALLBACK_TEMPERATURE callback is triggered
+    # Sets the period with which the CALLBACK_TEMPERATURE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_TEMPERATURE callback is only triggered if the temperature has changed
     # since the last triggering.
-    # 
-    # The default value is 0.
     def set_temperature_callback_period(period)
-      send_request FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletThermocouple#set_temperature_callback_period.
     def get_temperature_callback_period
-      send_request FUNCTION_GET_TEMPERATURE_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_TEMPERATURE_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the thresholds for the CALLBACK_TEMPERATURE_REACHED callback.
@@ -132,18 +138,20 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the temperature is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the temperature is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the temperature is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_temperature_callback_threshold(option, min, max)
-      send_request FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD, [option, min, max], 'k l l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD, [option, min, max], 'k l l', 8, ''
     end
 
     # Returns the threshold as set by BrickletThermocouple#set_temperature_callback_threshold.
     def get_temperature_callback_threshold
-      send_request FUNCTION_GET_TEMPERATURE_CALLBACK_THRESHOLD, [], '', 9, 'k l l'
+      check_validity
+
+      send_request FUNCTION_GET_TEMPERATURE_CALLBACK_THRESHOLD, [], '', 17, 'k l l'
     end
 
-    # Sets the period in ms with which the threshold callback
+    # Sets the period with which the threshold callback
     # 
     # * CALLBACK_TEMPERATURE_REACHED
     # 
@@ -152,15 +160,17 @@ module Tinkerforge
     # * BrickletThermocouple#set_temperature_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 BrickletThermocouple#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
 
     # You can configure averaging size, thermocouple type and frequency
@@ -186,15 +196,17 @@ module Tinkerforge
     # 
     # * 60Hz: ``time = 82 + (samples - 1) * 16.67``
     # * 50Hz: ``time = 98 + (samples - 1) * 20``
-    # 
-    # The default configuration is 16 samples, K type and 50Hz.
     def set_configuration(averaging, thermocouple_type, filter)
-      send_request FUNCTION_SET_CONFIGURATION, [averaging, thermocouple_type, filter], 'C C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CONFIGURATION, [averaging, thermocouple_type, filter], 'C C C', 8, ''
     end
 
     # Returns the configuration as set by BrickletThermocouple#set_configuration.
     def get_configuration
-      send_request FUNCTION_GET_CONFIGURATION, [], '', 3, 'C C C'
+      check_validity
+
+      send_request FUNCTION_GET_CONFIGURATION, [], '', 11, 'C C C'
     end
 
     # Returns the current error state. There are two possible errors:
@@ -209,19 +221,23 @@ module Tinkerforge
     # You can use the CALLBACK_ERROR_STATE callback to automatically get triggered
     # when the error state changes.
     def get_error_state
-      send_request FUNCTION_GET_ERROR_STATE, [], '', 2, '? ?'
+      check_validity
+
+      send_request FUNCTION_GET_ERROR_STATE, [], '', 10, '? ?'
     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_thermocouple_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
   # Measures temperature with thermocouples
   class BrickletThermocoupleV2 < Device
@@ -85,7 +87,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]
 
@@ -108,9 +110,10 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_TEMPERATURE] = 'l'
-      @callback_formats[CALLBACK_ERROR_STATE] = '? ?'
+      @callback_formats[CALLBACK_TEMPERATURE] = [12, 'l']
+      @callback_formats[CALLBACK_ERROR_STATE] = [10, '? ?']
 
+      @ipcon.add_device self
     end
 
     # Returns the temperature of the thermocouple. The value is given in °C/100,
@@ -125,10 +128,12 @@ module Tinkerforge
     # CALLBACK_TEMPERATURE callback. You can set the callback configuration
     # with BrickletThermocoupleV2#set_temperature_callback_configuration.
     def get_temperature
-      send_request FUNCTION_GET_TEMPERATURE, [], '', 4, 'l'
+      check_validity
+
+      send_request FUNCTION_GET_TEMPERATURE, [], '', 12, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_TEMPERATURE callback is triggered
+    # The period is the period with which the CALLBACK_TEMPERATURE 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
@@ -153,15 +158,17 @@ 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_temperature_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletThermocoupleV2#set_temperature_callback_configuration.
     def get_temperature_callback_configuration
-      send_request FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION, [], '', 14, 'L ? k l l'
+      check_validity
+
+      send_request FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
     end
 
     # You can configure averaging size, thermocouple type and frequency
@@ -187,15 +194,17 @@ module Tinkerforge
     # 
     # * 60Hz: ``time = 82 + (samples - 1) * 16.67``
     # * 50Hz: ``time = 98 + (samples - 1) * 20``
-    # 
-    # The default configuration is 16 samples, K type and 50Hz.
     def set_configuration(averaging, thermocouple_type, filter)
-      send_request FUNCTION_SET_CONFIGURATION, [averaging, thermocouple_type, filter], 'C C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CONFIGURATION, [averaging, thermocouple_type, filter], 'C C C', 8, ''
     end
 
     # Returns the configuration as set by BrickletThermocoupleV2#set_configuration.
     def get_configuration
-      send_request FUNCTION_GET_CONFIGURATION, [], '', 3, 'C C C'
+      check_validity
+
+      send_request FUNCTION_GET_CONFIGURATION, [], '', 11, 'C C C'
     end
 
     # Returns the current error state. There are two possible errors:
@@ -210,7 +219,9 @@ module Tinkerforge
     # You can use the CALLBACK_ERROR_STATE callback to automatically get triggered
     # when the error state changes.
     def get_error_state
-      send_request FUNCTION_GET_ERROR_STATE, [], '', 2, '? ?'
+      check_validity
+
+      send_request FUNCTION_GET_ERROR_STATE, [], '', 10, '? ?'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -225,7 +236,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
@@ -238,12 +251,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 BrickletThermocoupleV2#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 BrickletThermocoupleV2#write_firmware. The pointer has
@@ -253,7 +270,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
@@ -265,7 +284,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
@@ -276,22 +297,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 BrickletThermocoupleV2#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
@@ -301,7 +328,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
@@ -310,25 +339,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_tilt.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
   # Detects inclination of Bricklet (tilt switch open/closed)
   class BrickletTilt < Device
@@ -34,7 +36,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]
 
@@ -44,8 +46,9 @@ module Tinkerforge
       @response_expected[FUNCTION_IS_TILT_STATE_CALLBACK_ENABLED] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_TILT_STATE] = 'C'
+      @callback_formats[CALLBACK_TILT_STATE] = [9, 'C']
 
+      @ipcon.add_device self
     end
 
     # Returns the current tilt state. The state can either be
@@ -60,34 +63,44 @@ module Tinkerforge
     #    :align: center
     #    :target: ../../_images/Bricklets/bricklet_tilt_mechanics.jpg
     def get_tilt_state
-      send_request FUNCTION_GET_TILT_STATE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_TILT_STATE, [], '', 9, 'C'
     end
 
     # Enables the CALLBACK_TILT_STATE callback.
     def enable_tilt_state_callback
-      send_request FUNCTION_ENABLE_TILT_STATE_CALLBACK, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_ENABLE_TILT_STATE_CALLBACK, [], '', 8, ''
     end
 
     # Disables the CALLBACK_TILT_STATE callback.
     def disable_tilt_state_callback
-      send_request FUNCTION_DISABLE_TILT_STATE_CALLBACK, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_DISABLE_TILT_STATE_CALLBACK, [], '', 8, ''
     end
 
     # Returns *true* if the CALLBACK_TILT_STATE callback is enabled.
     def is_tilt_state_callback_enabled
-      send_request FUNCTION_IS_TILT_STATE_CALLBACK_ENABLED, [], '', 1, '?'
+      check_validity
+
+      send_request FUNCTION_IS_TILT_STATE_CALLBACK_ENABLED, [], '', 9, '?'
     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>.