tinkerforge 2.1.23 → 2.1.28

data/lib/tinkerforge/bricklet_solid_state_relay.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
   # Controls AC and DC Solid State Relays
   class BrickletSolidStateRelay < Device
@@ -30,7 +32,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]
 
@@ -40,26 +42,29 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_MONOFLOP] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_MONOFLOP_DONE] = '?'
+      @callback_formats[CALLBACK_MONOFLOP_DONE] = [9, '?']
 
+      @ipcon.add_device self
     end
 
     # Sets the state of the relays *true* means on and *false* means off.
     # 
     # A running monoflop timer will be aborted if this function is called.
-    # 
-    # The default value is *false*.
     def set_state(state)
-      send_request FUNCTION_SET_STATE, [state], '?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_STATE, [state], '?', 8, ''
     end
 
     # Returns the state of the relay, *true* means on and *false* means off.
     def get_state
-      send_request FUNCTION_GET_STATE, [], '', 1, '?'
+      check_validity
+
+      send_request FUNCTION_GET_STATE, [], '', 9, '?'
     end
 
     # The first parameter  is the desired state of the relay (*true* means on
-    # and *false* means off). The second parameter indicates the time (in ms) that
+    # and *false* means off). The second parameter indicates the time that
     # the relay should hold the state.
     # 
     # If this function is called with the parameters (true, 1500):
@@ -71,7 +76,9 @@ module Tinkerforge
     # of two seconds. The relay will be on all the time. If now the RS485
     # connection is lost, the relay will turn off in at most two seconds.
     def set_monoflop(state, time)
-      send_request FUNCTION_SET_MONOFLOP, [state, time], '? L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MONOFLOP, [state, time], '? L', 8, ''
     end
 
     # Returns the current state and the time as set by
@@ -80,19 +87,23 @@ module Tinkerforge
     # If the timer is not running currently, the remaining time will be returned
     # as 0.
     def get_monoflop
-      send_request FUNCTION_GET_MONOFLOP, [], '', 9, '? L L'
+      check_validity
+
+      send_request FUNCTION_GET_MONOFLOP, [], '', 17, '? L 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_solid_state_relay_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
   # Controls AC and DC Solid State Relays
   class BrickletSolidStateRelayV2 < Device
@@ -56,7 +58,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]
 
@@ -77,26 +79,29 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_MONOFLOP_DONE] = '?'
+      @callback_formats[CALLBACK_MONOFLOP_DONE] = [9, '?']
 
+      @ipcon.add_device self
     end
 
     # Sets the state of the relays *true* means on and *false* means off.
     # 
     # A running monoflop timer will be aborted if this function is called.
-    # 
-    # The default value is *false*.
     def set_state(state)
-      send_request FUNCTION_SET_STATE, [state], '?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_STATE, [state], '?', 8, ''
     end
 
     # Returns the state of the relay, *true* means on and *false* means off.
     def get_state
-      send_request FUNCTION_GET_STATE, [], '', 1, '?'
+      check_validity
+
+      send_request FUNCTION_GET_STATE, [], '', 9, '?'
     end
 
     # The first parameter  is the desired state of the relay (*true* means on
-    # and *false* means off). The second parameter indicates the time (in ms) that
+    # and *false* means off). The second parameter indicates the time that
     # the relay should hold the state.
     # 
     # If this function is called with the parameters (true, 1500):
@@ -108,7 +113,9 @@ module Tinkerforge
     # of two seconds. The relay will be on all the time. If now the RS485
     # connection is lost, the relay will turn off in at most two seconds.
     def set_monoflop(state, time)
-      send_request FUNCTION_SET_MONOFLOP, [state, time], '? L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MONOFLOP, [state, time], '? L', 8, ''
     end
 
     # Returns the current state and the time as set by
@@ -117,7 +124,9 @@ module Tinkerforge
     # If the timer is not running currently, the remaining time will be returned
     # as 0.
     def get_monoflop
-      send_request FUNCTION_GET_MONOFLOP, [], '', 9, '? L L'
+      check_validity
+
+      send_request FUNCTION_GET_MONOFLOP, [], '', 17, '? L L'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -132,7 +141,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
@@ -145,12 +156,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 BrickletSolidStateRelayV2#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 BrickletSolidStateRelayV2#write_firmware. The pointer has
@@ -160,7 +175,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
@@ -172,7 +189,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
@@ -183,22 +202,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 BrickletSolidStateRelayV2#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
@@ -208,7 +233,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
@@ -217,25 +244,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_sound_intensity.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 intensity
   class BrickletSoundIntensity < Device
@@ -49,7 +51,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]
 
@@ -62,13 +64,13 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_INTENSITY] = 'S'
-      @callback_formats[CALLBACK_INTENSITY_REACHED] = 'S'
+      @callback_formats[CALLBACK_INTENSITY] = [10, 'S']
+      @callback_formats[CALLBACK_INTENSITY_REACHED] = [10, 'S']
 
+      @ipcon.add_device self
     end
 
-    # Returns the current sound intensity. The value has a range of
-    # 0 to 4095.
+    # Returns the current sound intensity.
     # 
     # The value corresponds to the
     # `upper envelop <https://en.wikipedia.org/wiki/Envelope_(waves)>`__
@@ -78,23 +80,27 @@ module Tinkerforge
     # CALLBACK_INTENSITY callback and set the period with
     # BrickletSoundIntensity#set_intensity_callback_period.
     def get_intensity
-      send_request FUNCTION_GET_INTENSITY, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_INTENSITY, [], '', 10, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_INTENSITY callback is triggered
+    # Sets the period with which the CALLBACK_INTENSITY callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_INTENSITY callback is only triggered if the intensity has changed
     # since the last triggering.
-    # 
-    # The default value is 0.
     def set_intensity_callback_period(period)
-      send_request FUNCTION_SET_INTENSITY_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_INTENSITY_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletSoundIntensity#set_intensity_callback_period.
     def get_intensity_callback_period
-      send_request FUNCTION_GET_INTENSITY_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_INTENSITY_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the thresholds for the CALLBACK_INTENSITY_REACHED callback.
@@ -108,18 +114,20 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the intensity is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the intensity is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the intensity is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_intensity_callback_threshold(option, min, max)
-      send_request FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, ''
     end
 
     # Returns the threshold as set by BrickletSoundIntensity#set_intensity_callback_threshold.
     def get_intensity_callback_threshold
-      send_request FUNCTION_GET_INTENSITY_CALLBACK_THRESHOLD, [], '', 5, 'k S S'
+      check_validity
+
+      send_request FUNCTION_GET_INTENSITY_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_INTENSITY_REACHED
     # 
@@ -128,27 +136,31 @@ module Tinkerforge
     # * BrickletSoundIntensity#set_intensity_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 BrickletSoundIntensity#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>.