tinkerforge 2.1.22 → 2.1.27

data/lib/tinkerforge/bricklet_uv_light.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 UV light
   class BrickletUVLight < 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,14 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_UV_LIGHT] = 'L'
-      @callback_formats[CALLBACK_UV_LIGHT_REACHED] = 'L'
+      @callback_formats[CALLBACK_UV_LIGHT] = [12, 'L']
+      @callback_formats[CALLBACK_UV_LIGHT_REACHED] = [12, 'L']
 
+      @ipcon.add_device self
     end
 
-    # Returns the UV light intensity of the sensor, the intensity is given
-    # in 1/10 mW/m². The sensor has already weighted the intensity with the erythemal
+    # Returns the UV light intensity of the sensor.
+    # The sensor has already weighted the intensity with the erythemal
     # action spectrum to get the skin-affecting irradiation.
     # 
     # To get UV index you just have to divide the value by 250. For example, a UV
@@ -78,23 +81,27 @@ module Tinkerforge
     # CALLBACK_UV_LIGHT callback and set the period with
     # BrickletUVLight#set_uv_light_callback_period.
     def get_uv_light
-      send_request FUNCTION_GET_UV_LIGHT, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_UV_LIGHT, [], '', 12, 'L'
     end
 
-    # Sets the period in ms with which the CALLBACK_UV_LIGHT callback is triggered
+    # Sets the period with which the CALLBACK_UV_LIGHT callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_UV_LIGHT callback is only triggered if the intensity has changed since
     # the last triggering.
-    # 
-    # The default value is 0.
     def set_uv_light_callback_period(period)
-      send_request FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletUVLight#set_uv_light_callback_period.
     def get_uv_light_callback_period
-      send_request FUNCTION_GET_UV_LIGHT_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_UV_LIGHT_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the thresholds for the CALLBACK_UV_LIGHT_REACHED callback.
@@ -108,18 +115,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_uv_light_callback_threshold(option, min, max)
-      send_request FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD, [option, min, max], 'k L L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD, [option, min, max], 'k L L', 8, ''
     end
 
     # Returns the threshold as set by BrickletUVLight#set_uv_light_callback_threshold.
     def get_uv_light_callback_threshold
-      send_request FUNCTION_GET_UV_LIGHT_CALLBACK_THRESHOLD, [], '', 9, 'k L L'
+      check_validity
+
+      send_request FUNCTION_GET_UV_LIGHT_CALLBACK_THRESHOLD, [], '', 17, 'k L L'
     end
 
-    # Sets the period in ms with which the threshold callbacks
+    # Sets the period with which the threshold callbacks
     # 
     # * CALLBACK_UV_LIGHT_REACHED,
     # 
@@ -128,27 +137,31 @@ module Tinkerforge
     # * BrickletUVLight#set_uv_light_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 BrickletUVLight#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>.

data/lib/tinkerforge/bricklet_uv_light_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 UV-A, UV-B and UV index
   class BrickletUVLightV2 < Device
@@ -86,7 +88,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]
 
@@ -114,14 +116,15 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_UVA] = 'l'
-      @callback_formats[CALLBACK_UVB] = 'l'
-      @callback_formats[CALLBACK_UVI] = 'l'
+      @callback_formats[CALLBACK_UVA] = [12, 'l']
+      @callback_formats[CALLBACK_UVB] = [12, 'l']
+      @callback_formats[CALLBACK_UVI] = [12, 'l']
 
+      @ipcon.add_device self
     end
 
-    # Returns the UVA intensity of the sensor, the intensity is given
-    # in 1/10 mW/m². The sensor has not weighted the intensity with the erythemal
+    # Returns the UVA intensity of the sensor.
+    # The sensor has not weighted the intensity with the erythemal
     # action spectrum to get the skin-affecting irradiation. Therefore, you cannot
     # just divide the value by 250 to get the UVA index. To get the UV index use
     # BrickletUVLightV2#get_uvi.
@@ -137,10 +140,12 @@ module Tinkerforge
     # CALLBACK_UVA callback. You can set the callback configuration
     # with BrickletUVLightV2#set_uva_callback_configuration.
     def get_uva
-      send_request FUNCTION_GET_UVA, [], '', 4, 'l'
+      check_validity
+
+      send_request FUNCTION_GET_UVA, [], '', 12, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_UVA callback is triggered
+    # The period is the period with which the CALLBACK_UVA 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,19 +170,21 @@ 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_uva_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_UVA_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_UVA_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletUVLightV2#set_uva_callback_configuration.
     def get_uva_callback_configuration
-      send_request FUNCTION_GET_UVA_CALLBACK_CONFIGURATION, [], '', 14, 'L ? k l l'
+      check_validity
+
+      send_request FUNCTION_GET_UVA_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
     end
 
-    # Returns the UVB intensity of the sensor, the intensity is given
-    # in 1/10 mW/m². The sensor has not weighted the intensity with the erythemal
+    # Returns the UVB intensity of the sensor.
+    # The sensor has not weighted the intensity with the erythemal
     # action spectrum to get the skin-affecting irradiation. Therefore, you cannot
     # just divide the value by 250 to get the UVB index. To get the UV index use
     # BrickletUVLightV2#get_uvi.
@@ -193,10 +200,12 @@ module Tinkerforge
     # CALLBACK_UVB callback. You can set the callback configuration
     # with BrickletUVLightV2#set_uvb_callback_configuration.
     def get_uvb
-      send_request FUNCTION_GET_UVB, [], '', 4, 'l'
+      check_validity
+
+      send_request FUNCTION_GET_UVB, [], '', 12, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_UVB callback is triggered
+    # The period is the period with which the CALLBACK_UVB 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
@@ -221,15 +230,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_uvb_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_UVB_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_UVB_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletUVLightV2#set_uvb_callback_configuration.
     def get_uvb_callback_configuration
-      send_request FUNCTION_GET_UVB_CALLBACK_CONFIGURATION, [], '', 14, 'L ? k l l'
+      check_validity
+
+      send_request FUNCTION_GET_UVB_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
     end
 
     # Returns the UV index of the sensor, the index is given in 1/10.
@@ -245,10 +256,12 @@ module Tinkerforge
     # CALLBACK_UVI callback. You can set the callback configuration
     # with BrickletUVLightV2#set_uvi_callback_configuration.
     def get_uvi
-      send_request FUNCTION_GET_UVI, [], '', 4, 'l'
+      check_validity
+
+      send_request FUNCTION_GET_UVI, [], '', 12, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_UVI callback is triggered
+    # The period is the period with which the CALLBACK_UVI 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
@@ -273,15 +286,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_uvi_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_UVI_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_UVI_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletUVLightV2#set_uvi_callback_configuration.
     def get_uvi_callback_configuration
-      send_request FUNCTION_GET_UVI_CALLBACK_CONFIGURATION, [], '', 14, 'L ? k l l'
+      check_validity
+
+      send_request FUNCTION_GET_UVI_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
     end
 
     # Sets the configuration of the sensor. The integration time can be configured
@@ -292,15 +307,17 @@ module Tinkerforge
     # With a longer integration time (especially 800 ms) and a higher UV intensity the
     # sensor can be saturated. If this happens the UVA/UVB/UVI readings are all -1.
     # In this case you need to choose a shorter integration time.
-    # 
-    # Default value: 400 ms.
     def set_configuration(integration_time)
-      send_request FUNCTION_SET_CONFIGURATION, [integration_time], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CONFIGURATION, [integration_time], 'C', 8, ''
     end
 
     # Returns the configuration as set by BrickletUVLightV2#set_configuration.
     def get_configuration
-      send_request FUNCTION_GET_CONFIGURATION, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_CONFIGURATION, [], '', 9, 'C'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -315,7 +332,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
@@ -328,12 +347,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 BrickletUVLightV2#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 BrickletUVLightV2#write_firmware. The pointer has
@@ -343,7 +366,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
@@ -355,7 +380,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
@@ -366,22 +393,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 BrickletUVLightV2#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
@@ -391,7 +424,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
@@ -400,25 +435,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>.