tinkerforge 2.1.22 → 2.1.27

data/lib/tinkerforge/bricklet_hall_effect_v2.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-05-21.      #
+# This file was automatically generated on 2020-11-02.      #
 #                                                           #
-# Ruby Bindings Version 2.1.22                              #
+# Ruby Bindings Version 2.1.27                              #
 #                                                           #
 # 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 magnetic flux density between -7mT and +7mT
   class BrickletHallEffectV2 < 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, 0]
 
@@ -97,23 +99,25 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_MAGNETIC_FLUX_DENSITY] = 's'
-      @callback_formats[CALLBACK_COUNTER] = 'L'
+      @callback_formats[CALLBACK_MAGNETIC_FLUX_DENSITY] = [10, 's']
+      @callback_formats[CALLBACK_COUNTER] = [12, 'L']
 
+      @ipcon.add_device self
     end
 
-    # Returns the `magnetic flux density (magnetic induction) <https://en.wikipedia.org/wiki/Magnetic_flux>`__
-    # in `µT (micro Tesla) <https://en.wikipedia.org/wiki/Tesla_(unit)>`__.
+    # Returns the `magnetic flux density (magnetic induction) <https://en.wikipedia.org/wiki/Magnetic_flux>`__.
     # 
     # 
     # 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 BrickletHallEffectV2#set_magnetic_flux_density_callback_configuration.
     def get_magnetic_flux_density
-      send_request FUNCTION_GET_MAGNETIC_FLUX_DENSITY, [], '', 2, 's'
+      check_validity
+
+      send_request FUNCTION_GET_MAGNETIC_FLUX_DENSITY, [], '', 10, 's'
     end
 
-    # The period in ms is the period with which the CALLBACK_MAGNETIC_FLUX_DENSITY callback is triggered
+    # 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
@@ -138,21 +142,23 @@ 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_magnetic_flux_density_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k s s', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k s s', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletHallEffectV2#set_magnetic_flux_density_callback_configuration.
     def get_magnetic_flux_density_callback_configuration
-      send_request FUNCTION_GET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION, [], '', 10, 'L ? k s s'
+      check_validity
+
+      send_request FUNCTION_GET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k s s'
     end
 
     # Returns the current value of the counter.
     # 
-    # You can configure the low/high thresholds in µT and the debounce time
-    # in us with BrickletHallEffectV2#set_counter_config.
+    # You can configure the low/high thresholds and the debounce time
+    # with BrickletHallEffectV2#set_counter_config.
     # 
     # If you set reset counter to *true*, the count is set back to 0
     # directly after it is read.
@@ -161,31 +167,31 @@ module Tinkerforge
     # CALLBACK_COUNTER callback. You can set the callback configuration
     # with BrickletHallEffectV2#set_counter_callback_configuration.
     def get_counter(reset_counter)
-      send_request FUNCTION_GET_COUNTER, [reset_counter], '?', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_COUNTER, [reset_counter], '?', 12, 'L'
     end
 
-    # Sets a high and a low threshold in µT as well as a debounce time in µs.
+    # Sets a high and a low threshold as well as a debounce time.
     # 
     # If the measured magnetic flux density goes above the high threshold or
     # below the low threshold, the count of the counter is increased by 1.
     # 
     # The debounce time is the minimum time between two count increments.
-    # 
-    # The default values are
-    # 
-    # * High Threshold: 2000µT
-    # * Low Threshold: -2000µT
-    # * Debounce: 100000µs (100ms)
     def set_counter_config(high_threshold, low_threshold, debounce)
-      send_request FUNCTION_SET_COUNTER_CONFIG, [high_threshold, low_threshold, debounce], 's s L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_COUNTER_CONFIG, [high_threshold, low_threshold, debounce], 's s L', 8, ''
     end
 
     # Returns the counter config as set by BrickletHallEffectV2#set_counter_config.
     def get_counter_config
-      send_request FUNCTION_GET_COUNTER_CONFIG, [], '', 8, 's s L'
+      check_validity
+
+      send_request FUNCTION_GET_COUNTER_CONFIG, [], '', 16, 's s L'
     end
 
-    # The period in ms is the period with which the CALLBACK_COUNTER
+    # The period is the period with which the CALLBACK_COUNTER
     # 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
@@ -194,16 +200,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_counter_callback_configuration(period, value_has_to_change)
-      send_request FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, ''
     end
 
     # Returns the callback configuration as set by
     # BrickletHallEffectV2#set_counter_callback_configuration.
     def get_counter_callback_configuration
-      send_request FUNCTION_GET_COUNTER_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
+      check_validity
+
+      send_request FUNCTION_GET_COUNTER_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -218,7 +226,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
@@ -231,12 +241,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 BrickletHallEffectV2#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 BrickletHallEffectV2#write_firmware. The pointer has
@@ -246,7 +260,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
@@ -258,7 +274,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
@@ -269,22 +287,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 BrickletHallEffectV2#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
@@ -294,7 +318,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
@@ -303,25 +329,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_humidity.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-05-21.      #
+# This file was automatically generated on 2020-11-02.      #
 #                                                           #
-# Ruby Bindings Version 2.1.22                              #
+# Ruby Bindings Version 2.1.27                              #
 #                                                           #
 # 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 relative humidity
   class BrickletHumidity < Device
@@ -70,7 +72,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]
 
@@ -88,26 +90,26 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_HUMIDITY] = 'S'
-      @callback_formats[CALLBACK_ANALOG_VALUE] = 'S'
-      @callback_formats[CALLBACK_HUMIDITY_REACHED] = 'S'
-      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S'
+      @callback_formats[CALLBACK_HUMIDITY] = [10, 'S']
+      @callback_formats[CALLBACK_ANALOG_VALUE] = [10, 'S']
+      @callback_formats[CALLBACK_HUMIDITY_REACHED] = [10, 'S']
+      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = [10, 'S']
 
+      @ipcon.add_device self
     end
 
-    # Returns the humidity of the sensor. The value
-    # has a range of 0 to 1000 and is given in %RH/10 (Relative Humidity),
-    # i.e. a value of 421 means that a humidity of 42.1 %RH is measured.
+    # Returns the humidity of the sensor.
     # 
     # If you want to get the humidity periodically, it is recommended to use the
     # CALLBACK_HUMIDITY callback and set the period with
     # BrickletHumidity#set_humidity_callback_period.
     def get_humidity
-      send_request FUNCTION_GET_HUMIDITY, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_HUMIDITY, [], '', 10, 'S'
     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 BrickletHumidity#get_humidity is averaged over several samples
@@ -122,39 +124,45 @@ module Tinkerforge
     # CALLBACK_ANALOG_VALUE callback and set the period with
     # BrickletHumidity#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_HUMIDITY callback is triggered
+    # Sets the period with which the CALLBACK_HUMIDITY callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_HUMIDITY callback is only triggered if the humidity has changed
     # since the last triggering.
-    # 
-    # The default value is 0.
     def set_humidity_callback_period(period)
-      send_request FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletHumidity#set_humidity_callback_period.
     def get_humidity_callback_period
-      send_request FUNCTION_GET_HUMIDITY_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_HUMIDITY_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 BrickletHumidity#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_HUMIDITY_REACHED callback.
@@ -168,15 +176,17 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the humidity is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the humidity is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the humidity is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_humidity_callback_threshold(option, min, max)
-      send_request FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, ''
     end
 
     # Returns the threshold as set by BrickletHumidity#set_humidity_callback_threshold.
     def get_humidity_callback_threshold
-      send_request FUNCTION_GET_HUMIDITY_CALLBACK_THRESHOLD, [], '', 5, 'k S S'
+      check_validity
+
+      send_request FUNCTION_GET_HUMIDITY_CALLBACK_THRESHOLD, [], '', 13, 'k S S'
     end
 
     # Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.
@@ -190,18 +200,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 BrickletHumidity#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_HUMIDITY_REACHED,
     # * CALLBACK_ANALOG_VALUE_REACHED
@@ -212,27 +224,31 @@ module Tinkerforge
     # * BrickletHumidity#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 BrickletHumidity#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>.