tinkerforge 2.1.23 → 2.1.28

data/lib/tinkerforge/bricklet_analog_in.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 DC voltage between 0V and 45V
   class BrickletAnalogIn < Device
@@ -80,7 +82,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, 3]
 
@@ -102,26 +104,27 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_AVERAGING] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_VOLTAGE] = 'S'
-      @callback_formats[CALLBACK_ANALOG_VALUE] = 'S'
-      @callback_formats[CALLBACK_VOLTAGE_REACHED] = 'S'
-      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S'
+      @callback_formats[CALLBACK_VOLTAGE] = [10, 'S']
+      @callback_formats[CALLBACK_ANALOG_VALUE] = [10, 'S']
+      @callback_formats[CALLBACK_VOLTAGE_REACHED] = [10, 'S']
+      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = [10, 'S']
 
+      @ipcon.add_device self
     end
 
-    # Returns the voltage of the sensor. The value is in mV and
-    # between 0V and 45V. The resolution between 0 and 6V is about 2mV.
+    # Returns the voltage of the sensor. The resolution between 0 and 6V is about 2mV.
     # Between 6 and 45V the resolution is about 10mV.
     # 
     # If you want to get the voltage periodically, it is recommended to use the
     # CALLBACK_VOLTAGE callback and set the period with
     # BrickletAnalogIn#set_voltage_callback_period.
     def get_voltage
-      send_request FUNCTION_GET_VOLTAGE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE, [], '', 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 BrickletAnalogIn#get_voltage is averaged over several samples
@@ -133,39 +136,45 @@ module Tinkerforge
     # CALLBACK_ANALOG_VALUE callback and set the period with
     # BrickletAnalogIn#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_VOLTAGE callback is triggered
+    # Sets the period with which the CALLBACK_VOLTAGE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since
     # the last triggering.
-    # 
-    # The default value is 0.
     def set_voltage_callback_period(period)
-      send_request FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletAnalogIn#set_voltage_callback_period.
     def get_voltage_callback_period
-      send_request FUNCTION_GET_VOLTAGE_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE_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 BrickletAnalogIn#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_VOLTAGE_REACHED callback.
@@ -179,15 +188,17 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the voltage is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the voltage is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the voltage is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_voltage_callback_threshold(option, min, max)
-      send_request FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, ''
     end
 
     # Returns the threshold as set by BrickletAnalogIn#set_voltage_callback_threshold.
     def get_voltage_callback_threshold
-      send_request FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD, [], '', 5, 'k S S'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD, [], '', 13, 'k S S'
     end
 
     # Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.
@@ -201,18 +212,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 BrickletAnalogIn#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_VOLTAGE_REACHED,
     # * CALLBACK_ANALOG_VALUE_REACHED
@@ -223,15 +236,17 @@ module Tinkerforge
     # * BrickletAnalogIn#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 BrickletAnalogIn#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 measurement range. Possible ranges:
@@ -243,18 +258,20 @@ module Tinkerforge
     # * 4: 0V - 45.00V, ~11.25mV resolution
     # * 5: 0V - 3.3V, ~0.81mV resolution, new in version 2.0.3$nbsp;(Plugin)
     # 
-    # The default measurement range is 0.
-    # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def set_range(range)
-      send_request FUNCTION_SET_RANGE, [range], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_RANGE, [range], 'C', 8, ''
     end
 
     # Returns the measurement range as set by BrickletAnalogIn#set_range.
     # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def get_range
-      send_request FUNCTION_GET_RANGE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_RANGE, [], '', 9, 'C'
     end
 
     # Set the length of a averaging for the voltage value.
@@ -263,30 +280,34 @@ module Tinkerforge
     # averaging is off, there is more noise on the data, but the data is without
     # delay.
     # 
-    # The default value is 50.
-    # 
     # .. versionadded:: 2.0.3$nbsp;(Plugin)
     def set_averaging(average)
-      send_request FUNCTION_SET_AVERAGING, [average], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_AVERAGING, [average], 'C', 8, ''
     end
 
     # Returns the averaging configuration as set by BrickletAnalogIn#set_averaging.
     # 
     # .. versionadded:: 2.0.3$nbsp;(Plugin)
     def get_averaging
-      send_request FUNCTION_GET_AVERAGING, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_AVERAGING, [], '', 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>.

data/lib/tinkerforge/bricklet_analog_in_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 DC voltage between 0V and 42V
   class BrickletAnalogInV2 < 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, 1]
 
@@ -92,63 +94,70 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_MOVING_AVERAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_VOLTAGE] = 'S'
-      @callback_formats[CALLBACK_ANALOG_VALUE] = 'S'
-      @callback_formats[CALLBACK_VOLTAGE_REACHED] = 'S'
-      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S'
+      @callback_formats[CALLBACK_VOLTAGE] = [10, 'S']
+      @callback_formats[CALLBACK_ANALOG_VALUE] = [10, 'S']
+      @callback_formats[CALLBACK_VOLTAGE_REACHED] = [10, 'S']
+      @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = [10, 'S']
 
+      @ipcon.add_device self
     end
 
-    # Returns the measured voltage. The value is in mV and
-    # between 0V and 42V. The resolution is approximately 10mV.
+    # Returns the measured voltage. The resolution is approximately 10mV.
     # 
     # If you want to get the voltage periodically, it is recommended to use the
     # CALLBACK_VOLTAGE callback and set the period with
     # BrickletAnalogInV2#set_voltage_callback_period.
     def get_voltage
-      send_request FUNCTION_GET_VOLTAGE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE, [], '', 10, 'S'
     end
 
     # Returns the value as read by a 12-bit analog-to-digital converter.
-    # The value is between 0 and 4095.
     # 
     # If you want the analog value periodically, it is recommended to use the
     # CALLBACK_ANALOG_VALUE callback and set the period with
     # BrickletAnalogInV2#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_VOLTAGE callback is triggered
+    # Sets the period with which the CALLBACK_VOLTAGE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since
     # the last triggering.
-    # 
-    # The default value is 0.
     def set_voltage_callback_period(period)
-      send_request FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletAnalogInV2#set_voltage_callback_period.
     def get_voltage_callback_period
-      send_request FUNCTION_GET_VOLTAGE_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE_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 BrickletAnalogInV2#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_VOLTAGE_REACHED callback.
@@ -162,15 +171,17 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the voltage is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the voltage is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the voltage is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_voltage_callback_threshold(option, min, max)
-      send_request FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, ''
     end
 
     # Returns the threshold as set by BrickletAnalogInV2#set_voltage_callback_threshold.
     def get_voltage_callback_threshold
-      send_request FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD, [], '', 5, 'k S S'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD, [], '', 13, 'k S S'
     end
 
     # Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.
@@ -184,18 +195,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 BrickletAnalogInV2#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_VOLTAGE_REACHED,
     # * CALLBACK_ANALOG_VALUE_REACHED
@@ -206,15 +219,17 @@ module Tinkerforge
     # * BrickletAnalogInV2#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 BrickletAnalogInV2#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 length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__
@@ -222,29 +237,31 @@ module Tinkerforge
     # 
     # Setting the length to 1 will turn the averaging off. With less
     # averaging, there is more noise on the data.
-    # 
-    # The range for the averaging is 1-50.
-    # 
-    # The default value is 50.
     def set_moving_average(average)
-      send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'C', 8, ''
     end
 
     # Returns the length of the moving average as set by BrickletAnalogInV2#set_moving_average.
     def get_moving_average
-      send_request FUNCTION_GET_MOVING_AVERAGE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_MOVING_AVERAGE, [], '', 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>.