tinkerforge 2.1.23 → 2.1.28

data/lib/tinkerforge/bricklet_air_quality.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 IAQ index, temperature, humidity and air pressure
   class BrickletAirQuality < Device
@@ -108,7 +110,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]
 
@@ -145,16 +147,17 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_ALL_VALUES] = 'l C l l l'
-      @callback_formats[CALLBACK_IAQ_INDEX] = 'l C'
-      @callback_formats[CALLBACK_TEMPERATURE] = 'l'
-      @callback_formats[CALLBACK_HUMIDITY] = 'l'
-      @callback_formats[CALLBACK_AIR_PRESSURE] = 'l'
+      @callback_formats[CALLBACK_ALL_VALUES] = [25, 'l C l l l']
+      @callback_formats[CALLBACK_IAQ_INDEX] = [13, 'l C']
+      @callback_formats[CALLBACK_TEMPERATURE] = [12, 'l']
+      @callback_formats[CALLBACK_HUMIDITY] = [12, 'l']
+      @callback_formats[CALLBACK_AIR_PRESSURE] = [12, 'l']
 
+      @ipcon.add_device self
     end
 
     # Returns all values measured by the Air Quality Bricklet. The values are
-    # IAQ (Indoor Air Quality) Index, IAQ Index Accuracy, Temperature, Humidity and
+    # IAQ (Indoor Air Quality) Index (higher value means greater level of air pollution), IAQ Index Accuracy, Temperature, Humidity and
     # Air Pressure.
     # 
     # .. image:: /Images/Misc/bricklet_air_quality_iaq_index.png
@@ -162,20 +165,13 @@ module Tinkerforge
     #    :alt: Air Quality Index description
     #    :align: center
     #    :target: ../../_images/Misc/bricklet_air_quality_iaq_index.png
-    # 
-    # The values have these ranges and units:
-    # 
-    # * IAQ Index: 0 to 500, higher value means greater level of air pollution
-    # * IAQ Index Accuracy: 0 = unreliable to 3 = high
-    # * Temperature: in steps of 0.01 °C
-    # * Humidity: in steps of 0.01 %RH
-    # * Air Pressure: in steps of 0.01 mbar
     def get_all_values
-      send_request FUNCTION_GET_ALL_VALUES, [], '', 17, 'l C l l l'
+      check_validity
+
+      send_request FUNCTION_GET_ALL_VALUES, [], '', 25, 'l C l l l'
     end
 
-    # Sets a temperature offset with resolution 1/100°C. A offset of 10 will decrease
-    # the measured temperature by 0.1°C.
+    # Sets a temperature offset. A offset of 10 will decrease the measured temperature by 0.1 °C.
     # 
     # If you install this Bricklet into an enclosure and you want to measure the ambient
     # temperature, you may have to decrease the measured temperature by some value to
@@ -187,19 +183,23 @@ module Tinkerforge
     # 
     # This temperature offset is used to calculate the relative humidity and
     # IAQ index measurements. In case the Bricklet is installed in an enclosure, we
-    # recommend to measure and set the temperature offset to imporve the accuracy of
+    # recommend to measure and set the temperature offset to improve the accuracy of
     # the measurements.
     def set_temperature_offset(offset)
-      send_request FUNCTION_SET_TEMPERATURE_OFFSET, [offset], 'l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_TEMPERATURE_OFFSET, [offset], 'l', 8, ''
     end
 
     # Returns the temperature offset as set by
     # BrickletAirQuality#set_temperature_offset.
     def get_temperature_offset
-      send_request FUNCTION_GET_TEMPERATURE_OFFSET, [], '', 4, 'l'
+      check_validity
+
+      send_request FUNCTION_GET_TEMPERATURE_OFFSET, [], '', 12, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_ALL_VALUES
+    # The period is the period with which the CALLBACK_ALL_VALUES
     # 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
@@ -208,20 +208,21 @@ module Tinkerforge
     # 
     # If it is set to false, the callback is continuously triggered with the period,
     # independent of the value.
-    # 
-    # The default value is (0, false).
     def set_all_values_callback_configuration(period, value_has_to_change)
-      send_request FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, ''
     end
 
     # Returns the callback configuration as set by
     # BrickletAirQuality#set_all_values_callback_configuration.
     def get_all_values_callback_configuration
-      send_request FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
+      check_validity
+
+      send_request FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
     end
 
-    # Returns the IAQ index and accuracy. The IAQ index goes from
-    # 0 to 500. The higher the IAQ index, the greater the level of air pollution.
+    # Returns the IAQ index and accuracy. The higher the IAQ index, the greater the level of air pollution.
     # 
     # .. image:: /Images/Misc/bricklet_air_quality_iaq_index.png
     #    :scale: 100 %
@@ -233,10 +234,12 @@ module Tinkerforge
     # CALLBACK_IAQ_INDEX callback. You can set the callback configuration
     # with BrickletAirQuality#set_iaq_index_callback_configuration.
     def get_iaq_index
-      send_request FUNCTION_GET_IAQ_INDEX, [], '', 5, 'l C'
+      check_validity
+
+      send_request FUNCTION_GET_IAQ_INDEX, [], '', 13, 'l C'
     end
 
-    # The period in ms is the period with which the CALLBACK_IAQ_INDEX
+    # The period is the period with which the CALLBACK_IAQ_INDEX
     # 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
@@ -245,29 +248,33 @@ module Tinkerforge
     # 
     # If it is set to false, the callback is continuously triggered with the period,
     # independent of the value.
-    # 
-    # The default value is (0, false).
     def set_iaq_index_callback_configuration(period, value_has_to_change)
-      send_request FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, ''
     end
 
     # Returns the callback configuration as set by
     # BrickletAirQuality#set_iaq_index_callback_configuration.
     def get_iaq_index_callback_configuration
-      send_request FUNCTION_GET_IAQ_INDEX_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
+      check_validity
+
+      send_request FUNCTION_GET_IAQ_INDEX_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
     end
 
-    # Returns temperature in steps of 0.01 °C.
+    # Returns temperature.
     # 
     # 
     # If you want to get the value periodically, it is recommended to use the
     # CALLBACK_TEMPERATURE callback. You can set the callback configuration
     # with BrickletAirQuality#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
@@ -292,28 +299,32 @@ 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 BrickletAirQuality#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 relative humidity in steps of 0.01 %RH.
+    # Returns relative humidity.
     # 
     # 
     # If you want to get the value periodically, it is recommended to use the
     # CALLBACK_HUMIDITY callback. You can set the callback configuration
     # with BrickletAirQuality#set_humidity_callback_configuration.
     def get_humidity
-      send_request FUNCTION_GET_HUMIDITY, [], '', 4, 'l'
+      check_validity
+
+      send_request FUNCTION_GET_HUMIDITY, [], '', 12, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_HUMIDITY callback is triggered
+    # The period is the period with which the CALLBACK_HUMIDITY 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
@@ -338,28 +349,32 @@ 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_humidity_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletAirQuality#set_humidity_callback_configuration.
     def get_humidity_callback_configuration
-      send_request FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION, [], '', 14, 'L ? k l l'
+      check_validity
+
+      send_request FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
     end
 
-    # Returns air pressure in steps of 0.01 mbar.
+    # Returns air pressure.
     # 
     # 
     # If you want to get the value periodically, it is recommended to use the
     # CALLBACK_AIR_PRESSURE callback. You can set the callback configuration
     # with BrickletAirQuality#set_air_pressure_callback_configuration.
     def get_air_pressure
-      send_request FUNCTION_GET_AIR_PRESSURE, [], '', 4, 'l'
+      check_validity
+
+      send_request FUNCTION_GET_AIR_PRESSURE, [], '', 12, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_AIR_PRESSURE callback is triggered
+    # The period is the period with which the CALLBACK_AIR_PRESSURE 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
@@ -384,15 +399,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_air_pressure_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletAirQuality#set_air_pressure_callback_configuration.
     def get_air_pressure_callback_configuration
-      send_request FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION, [], '', 14, 'L ? k l l'
+      check_validity
+
+      send_request FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
     end
 
     # Deletes the calibration from flash. After you call this function,
@@ -406,7 +423,9 @@ module Tinkerforge
     # 
     # .. versionadded:: 2.0.3$nbsp;(Plugin)
     def remove_calibration
-      send_request FUNCTION_REMOVE_CALIBRATION, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_REMOVE_CALIBRATION, [], '', 8, ''
     end
 
     # The Air Quality Bricklet uses an automatic background calibration mechanism to
@@ -422,7 +441,7 @@ module Tinkerforge
     # duration is saved in flash, so you should only have to call this function
     # once in the lifetime of the Bricklet.
     # 
-    # The Bricklet has to be power cycled after this function is called 
+    # The Bricklet has to be power cycled after this function is called
     # for a duration change to take effect.
     # 
     # Before firmware version 2.0.3 this was not configurable and the duration was
@@ -432,15 +451,19 @@ module Tinkerforge
     # 
     # .. versionadded:: 2.0.3$nbsp;(Plugin)
     def set_background_calibration_duration(duration)
-      send_request FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION, [duration], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION, [duration], 'C', 8, ''
     end
 
-    # Returns the background calibration duration as set by 
+    # Returns the background calibration duration as set by
     # BrickletAirQuality#set_background_calibration_duration.
     # 
     # .. versionadded:: 2.0.3$nbsp;(Plugin)
     def get_background_calibration_duration
-      send_request FUNCTION_GET_BACKGROUND_CALIBRATION_DURATION, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_BACKGROUND_CALIBRATION_DURATION, [], '', 9, 'C'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -455,7 +478,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
@@ -468,12 +493,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 BrickletAirQuality#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 BrickletAirQuality#write_firmware. The pointer has
@@ -483,7 +512,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
@@ -495,7 +526,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
@@ -506,22 +539,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 BrickletAirQuality#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
@@ -531,7 +570,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
@@ -540,25 +581,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>.