tinkerforge 2.1.11 → 2.1.12

data/lib/tinkerforge/bricklet_analog_in_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -19,16 +19,16 @@ module Tinkerforge
     # BrickletAnalogInV2#set_voltage_callback_period. The parameter is the voltage of the
     # sensor.
     # 
-    # CALLBACK_VOLTAGE is only triggered if the voltage has changed since the
-    # last triggering.
+    # Der CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since
+    # the last triggering.
     CALLBACK_VOLTAGE = 15
 
     # This callback is triggered periodically with the period that is set by
-    # BrickletAnalogInV2#set_analog_value_callback_period. The parameter is the analog value of the
-    # sensor.
+    # BrickletAnalogInV2#set_analog_value_callback_period. The parameter is the analog
+    # value of the sensor.
     # 
-    # CALLBACK_ANALOG_VALUE is only triggered if the voltage has changed since the
-    # last triggering.
+    # The CALLBACK_ANALOG_VALUE callback is only triggered if the voltage has changed
+    # since the last triggering.
     CALLBACK_ANALOG_VALUE = 16
 
     # This callback is triggered when the threshold as set by
@@ -106,7 +106,7 @@ module Tinkerforge
     # between 0V and 42V. The resolution is approximately 10mV.
     # 
     # If you want to get the voltage periodically, it is recommended to use the
-    # callback CALLBACK_VOLTAGE and set the period with
+    # CALLBACK_VOLTAGE callback and set the period with
     # BrickletAnalogInV2#set_voltage_callback_period.
     def get_voltage
       send_request(FUNCTION_GET_VOLTAGE, [], '', 2, 'S')
@@ -116,7 +116,7 @@ module Tinkerforge
     # The value is between 0 and 4095.
     # 
     # If you want the analog value periodically, it is recommended to use the
-    # callback CALLBACK_ANALOG_VALUE and set the period with
+    # 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')
@@ -125,8 +125,8 @@ module Tinkerforge
     # Sets the period in ms with which the CALLBACK_VOLTAGE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_VOLTAGE is only triggered if the voltage has changed since the
-    # last triggering.
+    # 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)
@@ -141,8 +141,8 @@ module Tinkerforge
     # Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_ANALOG_VALUE is only triggered if the analog value has changed since the
-    # last triggering.
+    # 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)
@@ -238,7 +238,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_MOVING_AVERAGE, [], '', 1, 'C')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_analog_out.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -74,7 +74,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_MODE, [], '', 1, 'C')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_analog_out_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -50,7 +50,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_INPUT_VOLTAGE, [], '', 2, 'S')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_barometer.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -16,19 +16,19 @@ module Tinkerforge
     DEVICE_DISPLAY_NAME = 'Barometer Bricklet' # :nodoc:
 
     # This callback is triggered periodically with the period that is set by
-    # BrickletBarometer#set_air_pressure_callback_period. The parameter is the air pressure of the
-    # air pressure sensor.
+    # BrickletBarometer#set_air_pressure_callback_period. The parameter is the air
+    # pressure of the air pressure sensor.
     # 
-    # CALLBACK_AIR_PRESSURE is only triggered if the air pressure has changed since the
-    # last triggering.
+    # The CALLBACK_AIR_PRESSURE callback is only triggered if the air pressure has
+    # changed since the last triggering.
     CALLBACK_AIR_PRESSURE = 15
 
     # This callback is triggered periodically with the period that is set by
-    # BrickletBarometer#set_altitude_callback_period. The parameter is the altitude of the
-    # air pressure sensor.
+    # BrickletBarometer#set_altitude_callback_period. The parameter is the altitude of
+    # the air pressure sensor.
     # 
-    # CALLBACK_ALTITUDE is only triggered if the altitude has changed since the
-    # last triggering.
+    # The CALLBACK_ALTITUDE callback is only triggered if the altitude has changed since
+    # the last triggering.
     CALLBACK_ALTITUDE = 16
 
     # This callback is triggered when the threshold as set by
@@ -113,7 +113,7 @@ module Tinkerforge
     # of 1001092 means that an air pressure of 1001.092 mbar is measured.
     # 
     # If you want to get the air pressure periodically, it is recommended to use the
-    # callback CALLBACK_AIR_PRESSURE and set the period with
+    # CALLBACK_AIR_PRESSURE callback and set the period with
     # BrickletBarometer#set_air_pressure_callback_period.
     def get_air_pressure
       send_request(FUNCTION_GET_AIR_PRESSURE, [], '', 4, 'l')
@@ -124,7 +124,7 @@ module Tinkerforge
     # and the reference air pressure that can be set with BrickletBarometer#set_reference_air_pressure.
     # 
     # If you want to get the altitude periodically, it is recommended to use the
-    # callback CALLBACK_ALTITUDE and set the period with
+    # CALLBACK_ALTITUDE callback and set the period with
     # BrickletBarometer#set_altitude_callback_period.
     def get_altitude
       send_request(FUNCTION_GET_ALTITUDE, [], '', 4, 'l')
@@ -133,8 +133,8 @@ module Tinkerforge
     # Sets the period in ms with which the CALLBACK_AIR_PRESSURE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_AIR_PRESSURE is only triggered if the air pressure has changed since the
-    # last triggering.
+    # The CALLBACK_AIR_PRESSURE callback is only triggered if the air pressure has
+    # changed since the last triggering.
     # 
     # The default value is 0.
     def set_air_pressure_callback_period(period)
@@ -149,8 +149,8 @@ module Tinkerforge
     # Sets the period in ms with which the CALLBACK_ALTITUDE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_ALTITUDE is only triggered if the altitude has changed since the
-    # last triggering.
+    # The CALLBACK_ALTITUDE callback is only triggered if the altitude has changed since
+    # the last triggering.
     # 
     # The default value is 0.
     def set_altitude_callback_period(period)
@@ -262,9 +262,9 @@ module Tinkerforge
 
     # Sets the different averaging parameters. It is possible to set
     # the length of a normal averaging for the temperature and pressure,
-    # as well as an additional length of a 
+    # as well as an additional length of a
     # `moving average <https://en.wikipedia.org/wiki/Moving_average>`__
-    # for the pressure. The moving average is calculated from the normal 
+    # for the pressure. The moving average is calculated from the normal
     # averages.  There is no moving average for the temperature.
     # 
     # The maximum length for the pressure average is 10, for the
@@ -291,7 +291,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_AVERAGING, [], '', 3, 'C C C')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_can.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -18,6 +18,9 @@ module Tinkerforge
     # This callback is triggered if a data or remote frame was received by the CAN
     # transceiver.
     # 
+    # The ``identifier`` return value follows the identifier format described for
+    # BrickletCAN#write_frame.
+    # 
     # For remote frames the ``data`` return value always contains invalid values.
     # 
     # A configurable read filter can be used to define which frames should be
@@ -85,8 +88,13 @@ module Tinkerforge
     # Writes a data or remote frame to the write buffer to be transmitted over the
     # CAN transceiver.
     # 
-    # The Bricklet supports the standard 11-bit (CAN 2.0A) and the extended 29-bit
-    # (CAN 2.0B) identifiers. For remote frames the ``data`` parameter is ignored.
+    # The Bricklet supports the standard 11-bit (CAN 2.0A) and the additional extended
+    # 18-bit (CAN 2.0B) identifiers. For standard frames the Bricklet uses bit 0 to 10
+    # from the ``identifier`` parameter as standard 11-bit identifier. For extended
+    # frames the Bricklet additionally uses bit 11 to 28 from the ``identifier``
+    # parameter as extended 18-bit identifier.
+    # 
+    # For remote frames the ``data`` parameter is ignored.
     # 
     # Returns *true* if the frame was successfully added to the write buffer. Returns
     # *false* if the frame could not be added because write buffer is already full.
@@ -108,6 +116,9 @@ module Tinkerforge
     # empty and no frame could be read, then the ``success`` return value is set to
     # *false* and the other return values contain invalid data.
     # 
+    # The ``identifier`` return value follows the identifier format described for
+    # BrickletCAN#write_frame.
+    # 
     # For remote frames the ``data`` return value always contains invalid data.
     # 
     # A configurable read filter can be used to define which frames should be
@@ -198,8 +209,10 @@ module Tinkerforge
     #   to match the 11-bit identifier of standard frames. Bit 11 to 18 (8 bits) and
     #   bit 19 to 26 (8 bits) of mask and filters are used to match the first and
     #   second data byte (if present) of standard frames.
-    # * Match-Extended: Bit 0 to 28 (29 bits) of mask and filters are used to match
-    #   the 29-bit identifier of extended frames.
+    # * Match-Extended: Bit 0 to 10 (11 bits) of mask and filters are used
+    #   to match the standard 11-bit identifier part of extended frames. Bit 11 to 28
+    #   (18 bits) of mask and filters are used to match the extended 18-bit identifier
+    #   part of extended frames.
     # 
     # The mask and filters are applied in this way: The mask is used to select the
     # identifier and data bits that should be compared to the corresponding filter
@@ -270,7 +283,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_ERROR_LOG, [], '', 15, 'C C ? L L L')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_co2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -16,11 +16,11 @@ module Tinkerforge
     DEVICE_DISPLAY_NAME = 'CO2 Bricklet' # :nodoc:
 
     # This callback is triggered periodically with the period that is set by
-    # BrickletCO2#set_co2_concentration_callback_period. The parameter is the CO2 concentration of the
-    # sensor.
+    # BrickletCO2#set_co2_concentration_callback_period. The parameter is the CO2
+    # concentration of the sensor.
     # 
-    # CALLBACK_CO2_CONCENTRATION is only triggered if the CO2 concentration has changed since the
-    # last triggering.
+    # The CALLBACK_CO2_CONCENTRATION callback is only triggered if the CO2 concentration
+    # has changed since the last triggering.
     CALLBACK_CO2_CONCENTRATION = 8
 
     # This callback is triggered when the threshold as set by
@@ -68,22 +68,22 @@ module Tinkerforge
       @callback_formats[CALLBACK_CO2_CONCENTRATION_REACHED] = 'S'
     end
 
-    # Returns the measured CO2 concentration. The value is in 
+    # Returns the measured CO2 concentration. The value is in
     # `ppm (parts per million) <https://en.wikipedia.org/wiki/Parts-per_notation>`__
     # and between 0 to 10000.
     # 
-    # If you want to get the CO2 concentration periodically, it is recommended to use the
-    # callback CALLBACK_CO2_CONCENTRATION and set the period with
+    # If you want to get the CO2 concentration periodically, it is recommended to use
+    # the CALLBACK_CO2_CONCENTRATION callback and set the period with
     # BrickletCO2#set_co2_concentration_callback_period.
     def get_co2_concentration
       send_request(FUNCTION_GET_CO2_CONCENTRATION, [], '', 2, 'S')
     end
 
-    # Sets the period in ms with which the CALLBACK_CO2_CONCENTRATION callback is triggered
-    # periodically. A value of 0 turns the callback off.
+    # Sets the period in ms with which the CALLBACK_CO2_CONCENTRATION callback is
+    # triggered periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_CO2_CONCENTRATION is only triggered if the CO2 concentration has changed since the
-    # last triggering.
+    # The CALLBACK_CO2_CONCENTRATION callback is only triggered if the CO2 concentration
+    # has changed since the last triggering.
     # 
     # The default value is 0.
     def set_co2_concentration_callback_period(period)
@@ -137,7 +137,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_color.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -19,7 +19,7 @@ module Tinkerforge
     # BrickletColor#set_color_callback_period. The parameter is the color
     # of the sensor as RGBC.
     # 
-    # CALLBACK_COLOR is only triggered if the color has changed since the
+    # The CALLBACK_COLOR callback is only triggered if the color has changed since the
     # last triggering.
     CALLBACK_COLOR = 8
 
@@ -36,16 +36,16 @@ module Tinkerforge
     # BrickletColor#set_illuminance_callback_period. The parameter is the illuminance.
     # See BrickletColor#get_illuminance for how to interpret this value.
     # 
-    # CALLBACK_ILLUMINANCE is only triggered if the illuminance has changed since the
-    # last triggering.
+    # The CALLBACK_ILLUMINANCE callback is only triggered if the illuminance has changed
+    # since the last triggering.
     CALLBACK_ILLUMINANCE = 21
 
     # This callback is triggered periodically with the period that is set by
-    # BrickletColor#set_color_temperature_callback_period. The parameter is the 
+    # BrickletColor#set_color_temperature_callback_period. The parameter is the
     # color temperature in Kelvin.
     # 
-    # CALLBACK_COLOR_TEMPERATURE is only triggered if the color temperature has 
-    # changed since the last triggering.
+    # The CALLBACK_COLOR_TEMPERATURE callback is only triggered if the color temperature
+    # has changed since the last triggering.
     CALLBACK_COLOR_TEMPERATURE = 22
 
     FUNCTION_GET_COLOR = 1 # :nodoc:
@@ -135,8 +135,8 @@ module Tinkerforge
     #    :align: center
     #    :target: ../../_images/Bricklets/bricklet_color_wavelength_chart_600.jpg
     # 
-    # If you want to get the color periodically, it is recommended 
-    # to use the callback CALLBACK_COLOR and set the period with 
+    # If you want to get the color periodically, it is recommended
+    # to use the CALLBACK_COLOR callback and set the period with
     # BrickletColor#set_color_callback_period.
     def get_color
       send_request(FUNCTION_GET_COLOR, [], '', 8, 'S S S S')
@@ -145,7 +145,7 @@ module Tinkerforge
     # Sets the period in ms with which the CALLBACK_COLOR callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_COLOR is only triggered if the color has changed since the
+    # The CALLBACK_COLOR callback is only triggered if the color has changed since the
     # last triggering.
     # 
     # The default value is 0.
@@ -158,7 +158,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_COLOR_CALLBACK_PERIOD, [], '', 4, 'L')
     end
 
-    # Sets the thresholds for the CALLBACK_COLOR_REACHED callback. 
+    # Sets the thresholds for the CALLBACK_COLOR_REACHED callback.
     # 
     # The following options are possible:
     # 
@@ -280,8 +280,8 @@ module Tinkerforge
     # Sets the period in ms with which the CALLBACK_ILLUMINANCE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_ILLUMINANCE is only triggered if the illuminance has changed since the
-    # last triggering.
+    # The CALLBACK_ILLUMINANCE callback is only triggered if the illuminance has changed
+    # since the last triggering.
     # 
     # The default value is 0.
     def set_illuminance_callback_period(period)
@@ -293,11 +293,11 @@ module Tinkerforge
       send_request(FUNCTION_GET_ILLUMINANCE_CALLBACK_PERIOD, [], '', 4, 'L')
     end
 
-    # Sets the period in ms with which the CALLBACK_COLOR_TEMPERATURE callback is triggered
-    # periodically. A value of 0 turns the callback off.
+    # Sets the period in ms with which the CALLBACK_COLOR_TEMPERATURE callback is
+    # triggered periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_COLOR_TEMPERATURE is only triggered if the color temperature has changed since the
-    # last triggering.
+    # The CALLBACK_COLOR_TEMPERATURE callback is only triggered if the color temperature
+    # has changed since the last triggering.
     # 
     # The default value is 0.
     def set_color_temperature_callback_period(period)
@@ -309,7 +309,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_COLOR_TEMPERATURE_CALLBACK_PERIOD, [], '', 4, 'L')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     #