tinkerforge 2.1.22 → 2.1.27

data/lib/tinkerforge/bricklet_ptc_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
   # Reads temperatures from Pt100 und Pt1000 sensors
   class BrickletPTCV2 < Device
@@ -90,7 +92,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]
 
@@ -122,25 +124,26 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_TEMPERATURE] = 'l'
-      @callback_formats[CALLBACK_RESISTANCE] = 'l'
-      @callback_formats[CALLBACK_SENSOR_CONNECTED] = '?'
+      @callback_formats[CALLBACK_TEMPERATURE] = [12, 'l']
+      @callback_formats[CALLBACK_RESISTANCE] = [12, 'l']
+      @callback_formats[CALLBACK_SENSOR_CONNECTED] = [9, '?']
 
+      @ipcon.add_device self
     end
 
-    # Returns the temperature of the connected sensor. The value
-    # has a range of -246 to 849 °C 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 connected sensor.
     # 
     # 
     # If you want to get the value periodically, it is recommended to use the
     # CALLBACK_TEMPERATURE callback. You can set the callback configuration
     # with BrickletPTCV2#set_temperature_callback_configuration.
     def get_temperature
-      send_request FUNCTION_GET_TEMPERATURE, [], '', 4, 'l'
+      check_validity
+
+      send_request FUNCTION_GET_TEMPERATURE, [], '', 12, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_TEMPERATURE callback is triggered
+    # The period is the period with which the CALLBACK_TEMPERATURE 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
@@ -165,15 +168,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_temperature_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletPTCV2#set_temperature_callback_configuration.
     def get_temperature_callback_configuration
-      send_request FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION, [], '', 14, 'L ? k l l'
+      check_validity
+
+      send_request FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
     end
 
     # Returns the value as measured by the MAX31865 precision delta-sigma ADC.
@@ -188,10 +193,12 @@ module Tinkerforge
     # CALLBACK_RESISTANCE callback. You can set the callback configuration
     # with BrickletPTCV2#set_resistance_callback_configuration.
     def get_resistance
-      send_request FUNCTION_GET_RESISTANCE, [], '', 4, 'l'
+      check_validity
+
+      send_request FUNCTION_GET_RESISTANCE, [], '', 12, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_RESISTANCE callback is triggered
+    # The period is the period with which the CALLBACK_RESISTANCE 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
@@ -216,31 +223,35 @@ 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_resistance_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletPTCV2#set_resistance_callback_configuration.
     def get_resistance_callback_configuration
-      send_request FUNCTION_GET_RESISTANCE_CALLBACK_CONFIGURATION, [], '', 14, 'L ? k l l'
+      check_validity
+
+      send_request FUNCTION_GET_RESISTANCE_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
     end
 
     # Sets the noise rejection filter to either 50Hz (0) or 60Hz (1).
     # Noise from 50Hz or 60Hz power sources (including
     # harmonics of the AC power's fundamental frequency) is
     # attenuated by 82dB.
-    # 
-    # Default value is 0 = 50Hz.
     def set_noise_rejection_filter(filter)
-      send_request FUNCTION_SET_NOISE_REJECTION_FILTER, [filter], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_NOISE_REJECTION_FILTER, [filter], 'C', 8, ''
     end
 
     # Returns the noise rejection filter option as set by
     # BrickletPTCV2#set_noise_rejection_filter
     def get_noise_rejection_filter
-      send_request FUNCTION_GET_NOISE_REJECTION_FILTER, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_NOISE_REJECTION_FILTER, [], '', 9, 'C'
     end
 
     # Returns *true* if the sensor is connected correctly.
@@ -253,21 +264,25 @@ module Tinkerforge
     # CALLBACK_SENSOR_CONNECTED callback. You can set the callback configuration
     # with BrickletPTCV2#set_sensor_connected_callback_configuration.
     def is_sensor_connected
-      send_request FUNCTION_IS_SENSOR_CONNECTED, [], '', 1, '?'
+      check_validity
+
+      send_request FUNCTION_IS_SENSOR_CONNECTED, [], '', 9, '?'
     end
 
     # Sets the wire mode of the sensor. Possible values are 2, 3 and 4 which
     # correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper
     # configuration on the Bricklet.
-    # 
-    # The default value is 2 = 2-wire.
     def set_wire_mode(mode)
-      send_request FUNCTION_SET_WIRE_MODE, [mode], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_WIRE_MODE, [mode], 'C', 8, ''
     end
 
     # Returns the wire mode as set by BrickletPTCV2#set_wire_mode
     def get_wire_mode
-      send_request FUNCTION_GET_WIRE_MODE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_WIRE_MODE, [], '', 9, 'C'
     end
 
     # Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__
@@ -276,34 +291,37 @@ 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-1000.
-    # 
     # New data is gathered every 20ms. With a moving average of length 1000 the resulting
     # averaging window has a length of 20s. If you want to do long term measurements the longest
     # moving average will give the cleanest results.
     # 
-    # The default value is 1 for resistance and 40 for temperature. The default values match
-    # the non-changeable averaging settings of the old PTC Bricklet 1.0
+    # The default values match the non-changeable averaging settings of the old PTC Bricklet 1.0
     def set_moving_average_configuration(moving_average_length_resistance, moving_average_length_temperature)
-      send_request FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION, [moving_average_length_resistance, moving_average_length_temperature], 'S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION, [moving_average_length_resistance, moving_average_length_temperature], 'S S', 8, ''
     end
 
     # Returns the moving average configuration as set by BrickletPTCV2#set_moving_average_configuration.
     def get_moving_average_configuration
-      send_request FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION, [], '', 4, 'S S'
+      check_validity
+
+      send_request FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION, [], '', 12, 'S S'
     end
 
     # If you enable this callback, the CALLBACK_SENSOR_CONNECTED callback is triggered
     # every time a Pt sensor is connected/disconnected.
-    # 
-    # By default this callback is disabled.
     def set_sensor_connected_callback_configuration(enabled)
-      send_request FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION, [enabled], '?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION, [enabled], '?', 8, ''
     end
 
     # Returns the configuration as set by BrickletPTCV2#set_sensor_connected_callback_configuration.
     def get_sensor_connected_callback_configuration
-      send_request FUNCTION_GET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION, [], '', 1, '?'
+      check_validity
+
+      send_request FUNCTION_GET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION, [], '', 9, '?'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -318,7 +336,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
@@ -331,12 +351,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 BrickletPTCV2#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 BrickletPTCV2#write_firmware. The pointer has
@@ -346,7 +370,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
@@ -358,7 +384,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
@@ -369,22 +397,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 BrickletPTCV2#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
@@ -394,7 +428,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
@@ -403,25 +439,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_real_time_clock.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
   # Battery-backed real-time clock
   class BrickletRealTimeClock < 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, 1]
 
@@ -71,24 +73,13 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_ALARM] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_DATE_TIME] = 'S C C C C C C C q'
-      @callback_formats[CALLBACK_ALARM] = 'S C C C C C C C q'
+      @callback_formats[CALLBACK_DATE_TIME] = [25, 'S C C C C C C C q']
+      @callback_formats[CALLBACK_ALARM] = [25, 'S C C C C C C C q']
 
+      @ipcon.add_device self
     end
 
-    # Sets the current date (including weekday) and the current time with hundredths
-    # of a second resolution.
-    # 
-    # Possible value ranges:
-    # 
-    # * Year: 2000 to 2099
-    # * Month: 1 to 12 (January to December)
-    # * Day: 1 to 31
-    # * Hour: 0 to 23
-    # * Minute: 0 to 59
-    # * Second: 0 to 59
-    # * Centisecond: 0 to 99
-    # * Weekday: 1 to 7 (Monday to Sunday)
+    # Sets the current date (including weekday) and the current time.
     # 
     # If the backup battery is installed then the real-time clock keeps date and
     # time even if the Bricklet is not powered by a Brick.
@@ -97,20 +88,26 @@ module Tinkerforge
     # accordingly. But leap seconds, time zones and daylight saving time are not
     # handled.
     def set_date_time(year, month, day, hour, minute, second, centisecond, weekday)
-      send_request FUNCTION_SET_DATE_TIME, [year, month, day, hour, minute, second, centisecond, weekday], 'S C C C C C C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DATE_TIME, [year, month, day, hour, minute, second, centisecond, weekday], 'S C C C C C C C', 8, ''
     end
 
     # Returns the current date (including weekday) and the current time of the
-    # real-time clock with hundredths of a second resolution.
+    # real-time clock.
     def get_date_time
-      send_request FUNCTION_GET_DATE_TIME, [], '', 9, 'S C C C C C C C'
+      check_validity
+
+      send_request FUNCTION_GET_DATE_TIME, [], '', 17, 'S C C C C C C C'
     end
 
-    # Returns the current date and the time of the real-time clock converted to
-    # milliseconds. The timestamp has an effective resolution of hundredths of a
-    # second.
+    # Returns the current date and the time of the real-time clock.
+    # The timestamp has an effective resolution of hundredths of a
+    # second and is an offset to 2000-01-01 00:00:00.000.
     def get_timestamp
-      send_request FUNCTION_GET_TIMESTAMP, [], '', 8, 'q'
+      check_validity
+
+      send_request FUNCTION_GET_TIMESTAMP, [], '', 16, 'q'
     end
 
     # Sets the offset the real-time clock should compensate for in 2.17 ppm steps
@@ -139,32 +136,38 @@ module Tinkerforge
     # The offset is saved in the EEPROM of the Bricklet and only needs to be
     # configured once.
     def set_offset(offset)
-      send_request FUNCTION_SET_OFFSET, [offset], 'c', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_OFFSET, [offset], 'c', 8, ''
     end
 
     # Returns the offset as set by BrickletRealTimeClock#set_offset.
     def get_offset
-      send_request FUNCTION_GET_OFFSET, [], '', 1, 'c'
+      check_validity
+
+      send_request FUNCTION_GET_OFFSET, [], '', 9, 'c'
     end
 
-    # Sets the period in ms with which the CALLBACK_DATE_TIME callback is triggered
+    # Sets the period with which the CALLBACK_DATE_TIME callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_DATE_TIME Callback is only triggered if the date or time changed
     # since the last triggering.
     # 
-    # The default value is 0.
-    # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def set_date_time_callback_period(period)
-      send_request FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletRealTimeClock#set_date_time_callback_period.
     # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def get_date_time_callback_period
-      send_request FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Configures a repeatable alarm. The CALLBACK_ALARM callback is triggered if the
@@ -194,26 +197,32 @@ module Tinkerforge
     # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def set_alarm(month, day, hour, minute, second, weekday, interval)
-      send_request FUNCTION_SET_ALARM, [month, day, hour, minute, second, weekday, interval], 'c c c c c c l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_ALARM, [month, day, hour, minute, second, weekday, interval], 'c c c c c c l', 8, ''
     end
 
     # Returns the alarm configuration as set by BrickletRealTimeClock#set_alarm.
     # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def get_alarm
-      send_request FUNCTION_GET_ALARM, [], '', 10, 'c c c c c c l'
+      check_validity
+
+      send_request FUNCTION_GET_ALARM, [], '', 18, 'c c c c c c 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>.