tinkerforge 2.1.23 → 2.1.28

data/lib/tinkerforge/bricklet_compass.rb

@@ -1,16 +1,18 @@
 # -*- 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
-  # 3-axis compass with 0.1mG (milli Gauss) and 0.1° resolution
+  # 3-axis compass with 10 nanotesla and 0.1° resolution
   class BrickletCompass < Device
     DEVICE_IDENTIFIER = 2153 # :nodoc:
     DEVICE_DISPLAY_NAME = 'Compass Bricklet' # :nodoc:
@@ -78,7 +80,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]
 
@@ -105,12 +107,13 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_HEADING] = 's'
-      @callback_formats[CALLBACK_MAGNETIC_FLUX_DENSITY] = 'l l l'
+      @callback_formats[CALLBACK_HEADING] = [10, 's']
+      @callback_formats[CALLBACK_MAGNETIC_FLUX_DENSITY] = [20, 'l l l']
 
+      @ipcon.add_device self
     end
 
-    # Returns the heading in 1/10 degree (north = 0 degree, east = 90 degree).
+    # Returns the heading (north = 0 degree, east = 90 degree).
     # 
     # Alternatively you can use BrickletCompass#get_magnetic_flux_density and calculate the
     # heading with ``heading = atan2(y, x) * 180 / PI``.
@@ -120,10 +123,12 @@ module Tinkerforge
     # CALLBACK_HEADING callback. You can set the callback configuration
     # with BrickletCompass#set_heading_callback_configuration.
     def get_heading
-      send_request FUNCTION_GET_HEADING, [], '', 2, 's'
+      check_validity
+
+      send_request FUNCTION_GET_HEADING, [], '', 10, 's'
     end
 
-    # The period in ms is the period with which the CALLBACK_HEADING callback is triggered
+    # The period is the period with which the CALLBACK_HEADING 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
@@ -148,28 +153,32 @@ 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_heading_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k s s', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k s s', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletCompass#set_heading_callback_configuration.
     def get_heading_callback_configuration
-      send_request FUNCTION_GET_HEADING_CALLBACK_CONFIGURATION, [], '', 10, 'L ? k s s'
+      check_validity
+
+      send_request FUNCTION_GET_HEADING_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k s s'
     end
 
     # Returns the `magnetic flux density (magnetic induction) <https://en.wikipedia.org/wiki/Magnetic_flux>`__
-    # for all three axis in 1/10 `mG (milli Gauss) <https://en.wikipedia.org/wiki/Gauss_(unit)>`__.
+    # for all three axis.
     # 
     # If you want to get the value periodically, it is recommended to use the
     # CALLBACK_MAGNETIC_FLUX_DENSITY callback. You can set the callback configuration
     # with BrickletCompass#set_magnetic_flux_density_callback_configuration.
     def get_magnetic_flux_density
-      send_request FUNCTION_GET_MAGNETIC_FLUX_DENSITY, [], '', 12, 'l l l'
+      check_validity
+
+      send_request FUNCTION_GET_MAGNETIC_FLUX_DENSITY, [], '', 20, 'l l l'
     end
 
-    # The period in ms is the period with which the CALLBACK_MAGNETIC_FLUX_DENSITY callback
+    # The period is the period with which the CALLBACK_MAGNETIC_FLUX_DENSITY 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
@@ -178,16 +187,18 @@ module Tinkerforge
     # 
     # If it is set to false, the callback is continuously triggered with the period,
     # independent of the value.
-    # 
-    # The default value is (0, false).
     def set_magnetic_flux_density_callback_configuration(period, value_has_to_change)
-      send_request FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, ''
     end
 
     # Returns the callback configuration as set by
     # BrickletCompass#set_magnetic_flux_density_callback_configuration.
     def get_magnetic_flux_density_callback_configuration
-      send_request FUNCTION_GET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
+      check_validity
+
+      send_request FUNCTION_GET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
     end
 
     # Configures the data rate and background calibration.
@@ -202,15 +213,17 @@ module Tinkerforge
     #   you will not get new data for a period of 20ms. We highly recommend that
     #   you keep the background calibration enabled and only disable it if the 20ms
     #   off-time is a problem in your application.
-    # 
-    # Default values: Data rate of 100Hz and background calibration enabled.
     def set_configuration(data_rate, background_calibration)
-      send_request FUNCTION_SET_CONFIGURATION, [data_rate, background_calibration], 'C ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CONFIGURATION, [data_rate, background_calibration], 'C ?', 8, ''
     end
 
     # Returns the configuration as set by BrickletCompass#set_configuration.
     def get_configuration
-      send_request FUNCTION_GET_CONFIGURATION, [], '', 2, 'C ?'
+      check_validity
+
+      send_request FUNCTION_GET_CONFIGURATION, [], '', 10, 'C ?'
     end
 
     # Sets offset and gain for each of the three axes.
@@ -221,12 +234,16 @@ module Tinkerforge
     # The calibration is saved in non-volatile memory and only has to be
     # done once.
     def set_calibration(offset, gain)
-      send_request FUNCTION_SET_CALIBRATION, [offset, gain], 's3 s3', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CALIBRATION, [offset, gain], 's3 s3', 8, ''
     end
 
     # Returns the calibration parameters as set by BrickletCompass#set_calibration.
     def get_calibration
-      send_request FUNCTION_GET_CALIBRATION, [], '', 12, 's3 s3'
+      check_validity
+
+      send_request FUNCTION_GET_CALIBRATION, [], '', 20, 's3 s3'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -241,7 +258,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
@@ -254,12 +273,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 BrickletCompass#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 BrickletCompass#write_firmware. The pointer has
@@ -269,7 +292,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
@@ -281,7 +306,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
@@ -292,22 +319,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 BrickletCompass#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
@@ -317,7 +350,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
@@ -326,25 +361,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_current12.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 AC/DC current between -12.5A and +12.5A
   class BrickletCurrent12 < Device
@@ -76,7 +78,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]
 
@@ -96,22 +98,24 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_CURRENT] = 's'
-      @callback_formats[CALLBACK_ANALOG_VALUE] = 'S'
-      @callback_formats[CALLBACK_CURRENT_REACHED] = 's'
-      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S'
-      @callback_formats[CALLBACK_OVER_CURRENT] = ''
+      @callback_formats[CALLBACK_CURRENT] = [10, 's']
+      @callback_formats[CALLBACK_ANALOG_VALUE] = [10, 'S']
+      @callback_formats[CALLBACK_CURRENT_REACHED] = [10, 's']
+      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = [10, 'S']
+      @callback_formats[CALLBACK_OVER_CURRENT] = [8, '']
 
+      @ipcon.add_device self
     end
 
-    # Returns the current of the sensor. The value is in mA
-    # and between -12500mA and 12500mA.
+    # Returns the current of the sensor.
     # 
     # If you want to get the current periodically, it is recommended to use the
     # CALLBACK_CURRENT callback and set the period with
     # BrickletCurrent12#set_current_callback_period.
     def get_current
-      send_request FUNCTION_GET_CURRENT, [], '', 2, 's'
+      check_validity
+
+      send_request FUNCTION_GET_CURRENT, [], '', 10, 's'
     end
 
     # Calibrates the 0 value of the sensor. You have to call this function
@@ -126,7 +130,9 @@ module Tinkerforge
     # The resulting calibration will be saved on the EEPROM of the Current
     # Bricklet.
     def calibrate
-      send_request FUNCTION_CALIBRATE, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_CALIBRATE, [], '', 8, ''
     end
 
     # Returns *true* if more than 12.5A were measured.
@@ -134,11 +140,12 @@ module Tinkerforge
     # .. note::
     #  To reset this value you have to power cycle the Bricklet.
     def is_over_current
-      send_request FUNCTION_IS_OVER_CURRENT, [], '', 1, '?'
+      check_validity
+
+      send_request FUNCTION_IS_OVER_CURRENT, [], '', 9, '?'
     end
 
     # Returns the value as read by a 12-bit analog-to-digital converter.
-    # The value is between 0 and 4095.
     # 
     # .. note::
     #  The value returned by BrickletCurrent12#get_current is averaged over several samples
@@ -150,39 +157,45 @@ module Tinkerforge
     # CALLBACK_ANALOG_VALUE callback and set the period with
     # BrickletCurrent12#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 in ms with which the CALLBACK_CURRENT callback is triggered
+    # Sets the period with which the CALLBACK_CURRENT callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_CURRENT callback is only triggered if the current has changed since
     # the last triggering.
-    # 
-    # The default value is 0.
     def set_current_callback_period(period)
-      send_request FUNCTION_SET_CURRENT_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CURRENT_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletCurrent12#set_current_callback_period.
     def get_current_callback_period
-      send_request FUNCTION_GET_CURRENT_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_CURRENT_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
-    # Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered
+    # Sets the period with which the CALLBACK_ANALOG_VALUE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_ANALOG_VALUE callback is only triggered if the analog value has
     # changed since the last triggering.
-    # 
-    # The default value is 0.
     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 BrickletCurrent12#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_CURRENT_REACHED callback.
@@ -196,15 +209,17 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the current is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the current is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the current is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_current_callback_threshold(option, min, max)
-      send_request FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 8, ''
     end
 
     # Returns the threshold as set by BrickletCurrent12#set_current_callback_threshold.
     def get_current_callback_threshold
-      send_request FUNCTION_GET_CURRENT_CALLBACK_THRESHOLD, [], '', 5, 'k s s'
+      check_validity
+
+      send_request FUNCTION_GET_CURRENT_CALLBACK_THRESHOLD, [], '', 13, 'k s s'
     end
 
     # Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.
@@ -218,18 +233,20 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the analog value is *inside* the min and max values"
     #  "'<'",    "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)"
-    # 
-    # The default value is ('x', 0, 0).
     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 BrickletCurrent12#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 in ms with which the threshold callbacks
+    # Sets the period with which the threshold callbacks
     # 
     # * CALLBACK_CURRENT_REACHED,
     # * CALLBACK_ANALOG_VALUE_REACHED
@@ -240,27 +257,31 @@ module Tinkerforge
     # * BrickletCurrent12#set_analog_value_callback_threshold
     # 
     # keep 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 BrickletCurrent12#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>.