tinkerforge 2.1.23 → 2.1.28

data/lib/tinkerforge/bricklet_sound_pressure_level.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 Sound Pressure Level in dB(A/B/C/D/Z)
   class BrickletSoundPressureLevel < Device
@@ -21,16 +23,16 @@ module Tinkerforge
     # The parameter is the same as BrickletSoundPressureLevel#get_decibel.
     CALLBACK_DECIBEL = 4
 
-    # This callback is triggered periodically according to the configuration set by
-    # BrickletSoundPressureLevel#set_spectrum_callback_configuration.
-    # 
-    # The parameter is the same as BrickletSoundPressureLevel#get_spectrum.
+    # See CALLBACK_SPECTRUM
     CALLBACK_SPECTRUM_LOW_LEVEL = 8
 
     # This callback is triggered periodically according to the configuration set by
     # BrickletSoundPressureLevel#set_spectrum_callback_configuration.
     # 
     # The parameter is the same as BrickletSoundPressureLevel#get_spectrum.
+    # 
+    # .. note::
+    #  If reconstructing the value fails, the callback is triggered with nil for spectrum.
     CALLBACK_SPECTRUM = -8
 
     FUNCTION_GET_DECIBEL = 1 # :nodoc:
@@ -88,7 +90,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]
 
@@ -113,14 +115,14 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_DECIBEL] = 'S'
-      @callback_formats[CALLBACK_SPECTRUM_LOW_LEVEL] = 'S S S30'
+      @callback_formats[CALLBACK_DECIBEL] = [10, 'S']
+      @callback_formats[CALLBACK_SPECTRUM_LOW_LEVEL] = [72, 'S S S30']
 
       @high_level_callbacks[CALLBACK_SPECTRUM] = [['stream_length', 'stream_chunk_offset', 'stream_chunk_data'], {'fixed_length' => nil, 'single_chunk' => false}, nil]
+      @ipcon.add_device self
     end
 
-    # Returns the measured sound pressure in decibels. The values are given in
-    # dB/10 (tenths dB).
+    # Returns the measured sound pressure in decibels.
     # 
     # The Bricklet supports the weighting standards dB(A), dB(B), dB(C), dB(D),
     # dB(Z) and ITU-R 468. You can configure the weighting with BrickletSoundPressureLevel#set_configuration.
@@ -132,10 +134,12 @@ module Tinkerforge
     # CALLBACK_DECIBEL callback. You can set the callback configuration
     # with BrickletSoundPressureLevel#set_decibel_callback_configuration.
     def get_decibel
-      send_request FUNCTION_GET_DECIBEL, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_DECIBEL, [], '', 10, 'S'
     end
 
-    # The period in ms is the period with which the CALLBACK_DECIBEL callback is triggered
+    # The period is the period with which the CALLBACK_DECIBEL 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
@@ -160,15 +164,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_decibel_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletSoundPressureLevel#set_decibel_callback_configuration.
     def get_decibel_callback_configuration
-      send_request FUNCTION_GET_DECIBEL_CALLBACK_CONFIGURATION, [], '', 10, 'L ? k S S'
+      check_validity
+
+      send_request FUNCTION_GET_DECIBEL_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k S S'
     end
 
     # Returns the frequency spectrum. The length of the spectrum is between
@@ -190,24 +196,28 @@ module Tinkerforge
     # spectrum you have to apply the formula f(x) = 20*log10(max(1, x/sqrt(2)))
     # on each value.
     def get_spectrum_low_level
-      send_request FUNCTION_GET_SPECTRUM_LOW_LEVEL, [], '', 64, 'S S S30'
+      check_validity
+
+      send_request FUNCTION_GET_SPECTRUM_LOW_LEVEL, [], '', 72, 'S S S30'
     end
 
-    # The period in ms is the period with which the CALLBACK_SPECTRUM callback is
+    # The period is the period with which the CALLBACK_SPECTRUM callback is
     # triggered periodically. A value of 0 turns the callback off.
     # 
     # Every new measured spectrum will be send at most once. Set the period to 1 to
     # make sure that you get every spectrum.
-    # 
-    # The default value is 0.
     def set_spectrum_callback_configuration(period)
-      send_request FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION, [period], 'L', 8, ''
     end
 
     # Returns the callback configuration as set by
     # BrickletSoundPressureLevel#get_spectrum_callback_configuration.
     def get_spectrum_callback_configuration
-      send_request FUNCTION_GET_SPECTRUM_CALLBACK_CONFIGURATION, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_SPECTRUM_CALLBACK_CONFIGURATION, [], '', 12, 'L'
     end
 
     # Sets the Sound Pressure Level Bricklet configuration.
@@ -231,15 +241,17 @@ module Tinkerforge
     # often used to measure volumes at concerts etc. dB(Z) has a
     # flat response, no weighting is applied. ITU-R 468 is an ITU
     # weighting standard mostly used in the UK and Europe.
-    # 
-    # The defaults are FFT size 1024 and weighting standard dB(A).
     def set_configuration(fft_size, weighting)
-      send_request FUNCTION_SET_CONFIGURATION, [fft_size, weighting], 'C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CONFIGURATION, [fft_size, weighting], 'C C', 8, ''
     end
 
     # Returns the configuration as set by BrickletSoundPressureLevel#set_configuration.
     def get_configuration
-      send_request FUNCTION_GET_CONFIGURATION, [], '', 2, 'C C'
+      check_validity
+
+      send_request FUNCTION_GET_CONFIGURATION, [], '', 10, 'C C'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -254,7 +266,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
@@ -267,12 +281,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 BrickletSoundPressureLevel#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 BrickletSoundPressureLevel#write_firmware. The pointer has
@@ -282,7 +300,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
@@ -294,7 +314,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
@@ -305,22 +327,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 BrickletSoundPressureLevel#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
@@ -330,7 +358,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
@@ -339,25 +369,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
 
     # Returns the frequency spectrum. The length of the spectrum is between

data/lib/tinkerforge/bricklet_temperature.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 ambient temperature with 0.5°C accuracy
   class BrickletTemperature < Device
@@ -53,7 +55,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]
 
@@ -68,36 +70,39 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_I2C_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_TEMPERATURE] = 's'
-      @callback_formats[CALLBACK_TEMPERATURE_REACHED] = 's'
+      @callback_formats[CALLBACK_TEMPERATURE] = [10, 's']
+      @callback_formats[CALLBACK_TEMPERATURE_REACHED] = [10, 's']
 
+      @ipcon.add_device self
     end
 
-    # Returns the temperature of the sensor. The value
-    # has a range of -2500 to 8500 and 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 sensor.
     # 
     # If you want to get the temperature periodically, it is recommended
     # to use the CALLBACK_TEMPERATURE callback and set the period with
     # BrickletTemperature#set_temperature_callback_period.
     def get_temperature
-      send_request FUNCTION_GET_TEMPERATURE, [], '', 2, 's'
+      check_validity
+
+      send_request FUNCTION_GET_TEMPERATURE, [], '', 10, 's'
     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 BrickletTemperature#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.
@@ -111,18 +116,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 s s', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 8, ''
     end
 
     # Returns the threshold as set by BrickletTemperature#set_temperature_callback_threshold.
     def get_temperature_callback_threshold
-      send_request FUNCTION_GET_TEMPERATURE_CALLBACK_THRESHOLD, [], '', 5, 'k s s'
+      check_validity
+
+      send_request FUNCTION_GET_TEMPERATURE_CALLBACK_THRESHOLD, [], '', 13, 'k s s'
     end
 
-    # Sets the period in ms with which the threshold callback
+    # Sets the period with which the threshold callback
     # 
     # * CALLBACK_TEMPERATURE_REACHED
     # 
@@ -131,20 +138,22 @@ module Tinkerforge
     # * BrickletTemperature#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 BrickletTemperature#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 I2C mode. Possible modes are:
     # 
-    # * 0: Fast (400kHz, default)
+    # * 0: Fast (400kHz)
     # * 1: Slow (100kHz)
     # 
     # If you have problems with obvious outliers in the
@@ -156,26 +165,32 @@ module Tinkerforge
     # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def set_i2c_mode(mode)
-      send_request FUNCTION_SET_I2C_MODE, [mode], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_I2C_MODE, [mode], 'C', 8, ''
     end
 
     # Returns the I2C mode as set by BrickletTemperature#set_i2c_mode.
     # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def get_i2c_mode
-      send_request FUNCTION_GET_I2C_MODE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_I2C_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
 
     # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.