tinkerforge 2.1.21 → 2.1.22

data/lib/tinkerforge/brick_imu.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/brick_imu_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/brick_master.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #
@@ -456,7 +456,8 @@ module Tinkerforge
       send_request FUNCTION_GET_EXTENSION_TYPE, [extension], 'C', 4, 'L'
     end
 
-    # Returns *true* if a Chibi Extension is available to be used by the Master Brick.
+    # Returns *true* if the Master Brick is at position 0 in the stack and a Chibi
+    # Extension is available.
     def is_chibi_present
       send_request FUNCTION_IS_CHIBI_PRESENT, [], '', 1, '?'
     end
@@ -572,7 +573,8 @@ module Tinkerforge
       send_request FUNCTION_GET_CHIBI_CHANNEL, [], '', 1, 'C'
     end
 
-    # Returns *true* if a RS485 Extension is available to be used by the Master Brick.
+    # Returns *true* if the Master Brick is at position 0 in the stack and a RS485
+    # Extension is available.
     def is_rs485_present
       send_request FUNCTION_IS_RS485_PRESENT, [], '', 1, '?'
     end
@@ -648,7 +650,8 @@ module Tinkerforge
       send_request FUNCTION_GET_RS485_CONFIGURATION, [], '', 6, 'L k C'
     end
 
-    # Returns *true* if a WIFI Extension is available to be used by the Master Brick.
+    # Returns *true* if the Master Brick is at position 0 in the stack and a WIFI
+    # Extension is available.
     def is_wifi_present
       send_request FUNCTION_IS_WIFI_PRESENT, [], '', 1, '?'
     end
@@ -1058,8 +1061,8 @@ module Tinkerforge
       send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L'
     end
 
-    # Returns *true* if a Ethernet Extension is available to be used by the Master
-    # Brick.
+    # Returns *true* if the Master Brick is at position 0 in the stack and an Ethernet
+    # Extension is available.
     # 
     # .. versionadded:: 2.1.0$nbsp;(Firmware)
     def is_ethernet_present
@@ -1224,8 +1227,8 @@ module Tinkerforge
       send_request FUNCTION_GET_CONNECTION_TYPE, [], '', 1, 'C'
     end
 
-    # Returns *true* if a WIFI Extension 2.0 is available to be used by the Master
-    # Brick.
+    # Returns *true* if the Master Brick is at position 0 in the stack and a WIFI
+    # Extension 2.0 is available.
     # 
     # .. versionadded:: 2.4.0$nbsp;(Firmware)
     def is_wifi2_present

data/lib/tinkerforge/brick_red.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/brick_servo.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/brick_silent_stepper.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/brick_stepper.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/bricklet_accelerometer.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/bricklet_accelerometer_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #
@@ -10,7 +10,7 @@
 #############################################################
 
 module Tinkerforge
-  # 
+  # Measures acceleration in three axis
   class BrickletAccelerometerV2 < Device
     DEVICE_IDENTIFIER = 2130 # :nodoc:
     DEVICE_DISPLAY_NAME = 'Accelerometer Bricklet 2.0' # :nodoc:
@@ -25,6 +25,8 @@ module Tinkerforge
     # be configured with BrickletAccelerometerV2#set_configuration and this callback can be
     # enabled with BrickletAccelerometerV2#set_continuous_acceleration_configuration.
     # 
+    # The unit of the values is g/10000.
+    # 
     # The data is formated in the sequence "x, y, z, x, y, z, ..." depending on
     # the enabled axis. Examples:
     # 
@@ -37,6 +39,8 @@ module Tinkerforge
     # be configured with BrickletAccelerometerV2#set_configuration and this callback can be
     # enabled with BrickletAccelerometerV2#set_continuous_acceleration_configuration.
     # 
+    # The unit of the values is g*256/10000.
+    # 
     # The data is formated in the sequence "x, y, z, x, y, z, ..." depending on
     # the enabled axis. Examples:
     # 
@@ -152,16 +156,16 @@ module Tinkerforge
       send_request FUNCTION_GET_ACCELERATION, [], '', 12, 'l l l'
     end
 
-    # Configures the data rate, full scale range and filter bandwidth.
+    # Configures the data rate and full scale range.
     # Possible values are:
     # 
     # * Data rate of 0.781Hz to 25600Hz.
-    # * Full scale range of -2G to +2G up to -8G to +8G.
+    # * Full scale range of -2g to +2g up to -8g to +8g.
     # 
     # Decreasing data rate or full scale range will also decrease the noise on
     # the data.
     # 
-    # The default values are 100Hz data rate and -2G to +2G range.
+    # The default values are 100Hz data rate and -2g to +2g range.
     def set_configuration(data_rate, full_scale)
       send_request FUNCTION_SET_CONFIGURATION, [data_rate, full_scale], 'C C', 0, ''
     end
@@ -181,6 +185,9 @@ module Tinkerforge
     # If it is set to false, the callback is continuously triggered with the period,
     # independent of the value.
     # 
+    # If this callback is enabled, the CALLBACK_CONTINUOUS_ACCELERATION_16_BIT callback
+    # and CALLBACK_CONTINUOUS_ACCELERATION_8_BIT callback will automatically be disabled.
+    # 
     # The default value is (0, false).
     def set_acceleration_callback_configuration(period, value_has_to_change)
       send_request FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
@@ -215,6 +222,9 @@ module Tinkerforge
     # one of the axis is enabled and the resolution is set to 16 bit,
     # the CALLBACK_CONTINUOUS_ACCELERATION_16_BIT callback is activated.
     # 
+    # If a resolution of 8 bit is used, only the 8 most significant bits will be
+    # transferred. This means that the unit changes from g/10000 to g*256/10000.
+    # 
     # If no axis is enabled, both callbacks are disabled. If one of the continuous
     # callbacks is enabled, the CALLBACK_ACCELERATION callback is disabled.
     # 

data/lib/tinkerforge/bricklet_air_quality.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #
@@ -62,6 +62,9 @@ module Tinkerforge
     FUNCTION_GET_AIR_PRESSURE = 19 # :nodoc:
     FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20 # :nodoc:
     FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 21 # :nodoc:
+    FUNCTION_REMOVE_CALIBRATION = 23 # :nodoc:
+    FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24 # :nodoc:
+    FUNCTION_GET_BACKGROUND_CALIBRATION_DURATION = 25 # :nodoc:
     FUNCTION_GET_SPITFP_ERROR_COUNT = 234 # :nodoc:
     FUNCTION_SET_BOOTLOADER_MODE = 235 # :nodoc:
     FUNCTION_GET_BOOTLOADER_MODE = 236 # :nodoc:
@@ -84,6 +87,8 @@ module Tinkerforge
     THRESHOLD_OPTION_INSIDE = 'i' # :nodoc:
     THRESHOLD_OPTION_SMALLER = '<' # :nodoc:
     THRESHOLD_OPTION_GREATER = '>' # :nodoc:
+    DURATION_4_DAYS = 0 # :nodoc:
+    DURATION_28_DAYS = 1 # :nodoc:
     BOOTLOADER_MODE_BOOTLOADER = 0 # :nodoc:
     BOOTLOADER_MODE_FIRMWARE = 1 # :nodoc:
     BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2 # :nodoc:
@@ -105,7 +110,7 @@ module Tinkerforge
     def initialize(uid, ipcon)
       super uid, ipcon
 
-      @api_version = [2, 0, 0]
+      @api_version = [2, 0, 1]
 
       @response_expected[FUNCTION_GET_ALL_VALUES] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_SET_TEMPERATURE_OFFSET] = RESPONSE_EXPECTED_FALSE
@@ -124,6 +129,9 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_AIR_PRESSURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
       @response_expected[FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_REMOVE_CALIBRATION] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_BACKGROUND_CALIBRATION_DURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
@@ -387,6 +395,54 @@ module Tinkerforge
       send_request FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION, [], '', 14, 'L ? k l l'
     end
 
+    # Deletes the calibration from flash. After you call this function,
+    # you need to power cycle the Air Quality Bricklet.
+    # 
+    # On the next power up the Bricklet will start a new calibration, as
+    # if it was started for the very first time.
+    # 
+    # The calibration is based on the data of the last four days, so it takes
+    # four days until a full calibration is re-established.
+    # 
+    # .. versionadded:: 2.0.3$nbsp;(Plugin)
+    def remove_calibration
+      send_request FUNCTION_REMOVE_CALIBRATION, [], '', 0, ''
+    end
+
+    # The Air Quality Bricklet uses an automatic background calibration mechanism to
+    # calculate the IAQ Index. This calibration mechanism considers a history of
+    # measured data. The duration of this history can be configured to either be
+    # 4 days or 28 days.
+    # 
+    # If you keep the Bricklet mostly at one place and it does not get moved around
+    # to different environments, we recommend that you use a duration of 28 days.
+    # 
+    # If you change the duration, the current calibration will be discarded and
+    # the calibration will start from beginning again. The configuration of the
+    # 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 
+    # for a duration change to take effect.
+    # 
+    # Before firmware version 2.0.3 this was not configurable and the duration was
+    # 4 days.
+    # 
+    # The default value (since firmware version 2.0.3) is 28 days.
+    # 
+    # .. versionadded:: 2.0.3$nbsp;(Plugin)
+    def set_background_calibration_duration(duration)
+      send_request FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION, [duration], 'C', 0, ''
+    end
+
+    # 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'
+    end
+
     # Returns the error count for the communication between Brick and Bricklet.
     # 
     # The errors are divided into

data/lib/tinkerforge/bricklet_ambient_light.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/bricklet_ambient_light_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/bricklet_ambient_light_v3.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #
@@ -10,7 +10,7 @@
 #############################################################
 
 module Tinkerforge
-  # 
+  # Measures ambient light up to 64000lux
   class BrickletAmbientLightV3 < Device
     DEVICE_IDENTIFIER = 2131 # :nodoc:
     DEVICE_DISPLAY_NAME = 'Ambient Light Bricklet 3.0' # :nodoc:

data/lib/tinkerforge/bricklet_analog_in.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/bricklet_analog_in_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/bricklet_analog_in_v3.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/bricklet_analog_out.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/bricklet_analog_out_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/bricklet_analog_out_v3.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/bricklet_barometer.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-01-29.      #
+# This file was automatically generated on 2019-05-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.21                              #
+# Ruby Bindings Version 2.1.22                              #
 #                                                           #
 # 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  #