tinkerforge 2.1.16 → 2.1.17

data/lib/tinkerforge/bricklet_multi_touch.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2018-02-28.      #
+# This file was automatically generated on 2018-06-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.16                              #
+# Ruby Bindings Version 2.1.17                              #
 #                                                           #
 # 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_nfc.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2018-02-28.      #
+# This file was automatically generated on 2018-06-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.16                              #
+# Ruby Bindings Version 2.1.17                              #
 #                                                           #
 # 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,6 +50,8 @@ module Tinkerforge
     FUNCTION_P2P_READ_NDEF_LOW_LEVEL = 23 # :nodoc:
     FUNCTION_SET_DETECTION_LED_CONFIG = 25 # :nodoc:
     FUNCTION_GET_DETECTION_LED_CONFIG = 26 # :nodoc:
+    FUNCTION_SET_MAXIMUM_TIMEOUT = 27 # :nodoc:
+    FUNCTION_GET_MAXIMUM_TIMEOUT = 28 # :nodoc:
     FUNCTION_GET_SPITFP_ERROR_COUNT = 234 # :nodoc:
     FUNCTION_SET_BOOTLOADER_MODE = 235 # :nodoc:
     FUNCTION_GET_BOOTLOADER_MODE = 236 # :nodoc:
@@ -147,7 +149,7 @@ module Tinkerforge
     def initialize(uid, ipcon)
       super uid, ipcon
 
-      @api_version = [2, 0, 0]
+      @api_version = [2, 0, 1]
 
       @response_expected[FUNCTION_SET_MODE] = RESPONSE_EXPECTED_FALSE
       @response_expected[FUNCTION_GET_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
@@ -172,6 +174,8 @@ module Tinkerforge
       @response_expected[FUNCTION_P2P_READ_NDEF_LOW_LEVEL] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_SET_DETECTION_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
       @response_expected[FUNCTION_GET_DETECTION_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_MAXIMUM_TIMEOUT] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_MAXIMUM_TIMEOUT] = 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
@@ -564,6 +568,38 @@ module Tinkerforge
       send_request FUNCTION_GET_DETECTION_LED_CONFIG, [], '', 1, 'C'
     end
 
+    # Sets the maximum timeout in ms.
+    # 
+    # This is a global maximum used for all internal state timeouts. The timeouts depend heavily
+    # on the used tags etc. For example: If you use a Type 2 tag and you want to detect if
+    # it is present, you have to use BrickletNFC#reader_request_tag_id and wait for the state
+    # to change to either the error state or the ready state.
+    # 
+    # With the default configuration this takes 2-3 seconds. By setting the maximum timeout to
+    # 100ms you can reduce this time to ~150-200ms. For Type 2 this would also still work
+    # with a 20ms timeout (a Type 2 tag answers usually within 10ms). A type 4 tag can take
+    # up to 500ms in our tests.
+    # 
+    # If you need a fast response time to discover if a tag is present or not you can find
+    # a good timeout value by trial and error for your specific tag.
+    # 
+    # By default we use a very conservative timeout, to be sure that any Tag can always
+    # answer in time.
+    # 
+    # Default timeout: 2000ms.
+    # 
+    # .. versionadded:: 2.0.1$nbsp;(Plugin)
+    def set_maximum_timeout(timeout)
+      send_request FUNCTION_SET_MAXIMUM_TIMEOUT, [timeout], 'S', 0, ''
+    end
+
+    # Returns the timeout as set by BrickletNFC#set_maximum_timeout
+    # 
+    # .. versionadded:: 2.0.1$nbsp;(Plugin)
+    def get_maximum_timeout
+      send_request FUNCTION_GET_MAXIMUM_TIMEOUT, [], '', 2, 'S'
+    end
+
     # Returns the error count for the communication between Brick and Bricklet.
     # 
     # The errors are divided into

data/lib/tinkerforge/bricklet_nfc_rfid.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2018-02-28.      #
+# This file was automatically generated on 2018-06-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.16                              #
+# Ruby Bindings Version 2.1.17                              #
 #                                                           #
 # 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_oled_128x64.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2018-02-28.      #
+# This file was automatically generated on 2018-06-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.16                              #
+# Ruby Bindings Version 2.1.17                              #
 #                                                           #
 # 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_oled_64x48.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2018-02-28.      #
+# This file was automatically generated on 2018-06-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.16                              #
+# Ruby Bindings Version 2.1.17                              #
 #                                                           #
 # 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_outdoor_weather.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2018-02-28.      #
+# This file was automatically generated on 2018-06-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.16                              #
+# Ruby Bindings Version 2.1.17                              #
 #                                                           #
 # 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_particulate_matter.rb

@@ -0,0 +1,320 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2018-06-08.      #
+#                                                           #
+# Ruby Bindings Version 2.1.17                              #
+#                                                           #
+# 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       #
+#############################################################
+
+module Tinkerforge
+  # Measures Particulate Matter concentration (PM1.0, PM2.5 and PM10)
+  class BrickletParticulateMatter < Device
+    DEVICE_IDENTIFIER = 2110 # :nodoc:
+    DEVICE_DISPLAY_NAME = 'Particulate Matter Bricklet' # :nodoc:
+
+    # This callback is triggered periodically according to the configuration set by
+    # BrickletParticulateMatter#set_pm_concentration_callback_configuration.
+    # 
+    # The parameters are the same as BrickletParticulateMatter#get_pm_concentration.
+    CALLBACK_PM_CONCENTRATION = 10
+
+    # This callback is triggered periodically according to the configuration set by
+    # BrickletParticulateMatter#set_pm_count_callback_configuration.
+    # 
+    # The parameters are the same as BrickletParticulateMatter#get_pm_count.
+    CALLBACK_PM_COUNT = 11
+
+    FUNCTION_GET_PM_CONCENTRATION = 1 # :nodoc:
+    FUNCTION_GET_PM_COUNT = 2 # :nodoc:
+    FUNCTION_SET_ENABLE = 3 # :nodoc:
+    FUNCTION_GET_ENABLE = 4 # :nodoc:
+    FUNCTION_GET_SENSOR_INFO = 5 # :nodoc:
+    FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 6 # :nodoc:
+    FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 7 # :nodoc:
+    FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION = 8 # :nodoc:
+    FUNCTION_GET_PM_COUNT_CALLBACK_CONFIGURATION = 9 # :nodoc:
+    FUNCTION_GET_SPITFP_ERROR_COUNT = 234 # :nodoc:
+    FUNCTION_SET_BOOTLOADER_MODE = 235 # :nodoc:
+    FUNCTION_GET_BOOTLOADER_MODE = 236 # :nodoc:
+    FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237 # :nodoc:
+    FUNCTION_WRITE_FIRMWARE = 238 # :nodoc:
+    FUNCTION_SET_STATUS_LED_CONFIG = 239 # :nodoc:
+    FUNCTION_GET_STATUS_LED_CONFIG = 240 # :nodoc:
+    FUNCTION_GET_CHIP_TEMPERATURE = 242 # :nodoc:
+    FUNCTION_RESET = 243 # :nodoc:
+    FUNCTION_WRITE_UID = 248 # :nodoc:
+    FUNCTION_READ_UID = 249 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :nodoc:
+
+    BOOTLOADER_MODE_BOOTLOADER = 0 # :nodoc:
+    BOOTLOADER_MODE_FIRMWARE = 1 # :nodoc:
+    BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2 # :nodoc:
+    BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3 # :nodoc:
+    BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4 # :nodoc:
+    BOOTLOADER_STATUS_OK = 0 # :nodoc:
+    BOOTLOADER_STATUS_INVALID_MODE = 1 # :nodoc:
+    BOOTLOADER_STATUS_NO_CHANGE = 2 # :nodoc:
+    BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3 # :nodoc:
+    BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4 # :nodoc:
+    BOOTLOADER_STATUS_CRC_MISMATCH = 5 # :nodoc:
+    STATUS_LED_CONFIG_OFF = 0 # :nodoc:
+    STATUS_LED_CONFIG_ON = 1 # :nodoc:
+    STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2 # :nodoc:
+    STATUS_LED_CONFIG_SHOW_STATUS = 3 # :nodoc:
+
+    # 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
+
+      @api_version = [2, 0, 0]
+
+      @response_expected[FUNCTION_GET_PM_CONCENTRATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_PM_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_ENABLE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_ENABLE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_SENSOR_INFO] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_PM_COUNT_CALLBACK_CONFIGURATION] = 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
+      @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_PM_CONCENTRATION] = 'S S S'
+      @callback_formats[CALLBACK_PM_COUNT] = 'S S S S S S'
+
+    end
+
+    # Returns the particulate matter concentration in µg/m³, broken down as:
+    # 
+    # * PM\ :sub:`1.0`\ ,
+    # * PM\ :sub:`2.5`\  and
+    # * PM\ :sub:`10.0`\ .
+    # 
+    # If the sensor is disabled (see BrickletParticulateMatter#set_enable) then the last known good
+    # values from the sensor are returned.
+    def get_pm_concentration
+      send_request FUNCTION_GET_PM_CONCENTRATION, [], '', 6, 'S S S'
+    end
+
+    # Returns the number of particulates in 100 ml of air, broken down by their
+    # diameter:
+    # 
+    # * greater 0.3µm,
+    # * greater 0.5µm,
+    # * greater 1.0µm,
+    # * greater 2.5µm,
+    # * greater 5.0µm and
+    # * greater 10.0µm.
+    # 
+    # If the sensor is disabled (see BrickletParticulateMatter#set_enable) then the last known good
+    # value from the sensor is returned.
+    def get_pm_count
+      send_request FUNCTION_GET_PM_COUNT, [], '', 12, 'S S S S S S'
+    end
+
+    # Enables/Disables the fan and the laser diode of the sensors. The sensor is
+    # enabled by default.
+    # 
+    # The sensor takes about 30 after it is enabled to settle and produce stable
+    # values.
+    def set_enable(enable)
+      send_request FUNCTION_SET_ENABLE, [enable], '?', 0, ''
+    end
+
+    # Returns the state of the sensor as set by BrickletParticulateMatter#set_enable.
+    def get_enable
+      send_request FUNCTION_GET_ENABLE, [], '', 1, '?'
+    end
+
+    # Returns information about the sensor:
+    # 
+    # * the sensor version number,
+    # * the last error code reported by the sensor (0 means no error) and
+    # * the number of framing and checksum errors that occurred in the communication
+    #   with the sensor.
+    def get_sensor_info
+      send_request FUNCTION_GET_SENSOR_INFO, [], '', 4, 'C C C C'
+    end
+
+    # The period in ms is the period with which the CALLBACK_PM_CONCENTRATION
+    # 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
+    # triggered after the value has changed. If the value didn't change within the
+    # period, the callback is triggered immediately on change.
+    # 
+    # 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_pm_concentration_callback_configuration(period, value_has_to_change)
+      send_request FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
+    end
+
+    # Returns the callback configuration as set by
+    # BrickletParticulateMatter#set_pm_concentration_callback_configuration.
+    def get_pm_concentration_callback_configuration
+      send_request FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
+    end
+
+    # The period in ms is the period with which the CALLBACK_PM_COUNT 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
+    # triggered after the value has changed. If the value didn't change within the
+    # period, the callback is triggered immediately on change.
+    # 
+    # 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_pm_count_callback_configuration(period, value_has_to_change)
+      send_request FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
+    end
+
+    # Returns the callback configuration as set by
+    # BrickletParticulateMatter#set_pm_count_callback_configuration.
+    def get_pm_count_callback_configuration
+      send_request FUNCTION_GET_PM_COUNT_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
+    end
+
+    # Returns the error count for the communication between Brick and Bricklet.
+    # 
+    # The errors are divided into
+    # 
+    # * ack checksum errors,
+    # * message checksum errors,
+    # * frameing errors and
+    # * overflow errors.
+    # 
+    # 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'
+    end
+
+    # Sets the bootloader mode and returns the status after the requested
+    # mode change was instigated.
+    # 
+    # You can change from bootloader mode to firmware mode and vice versa. A change
+    # from bootloader mode to firmware mode will only take place if the entry function,
+    # device identifier und crc are present and correct.
+    # 
+    # 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'
+    end
+
+    # Returns the current bootloader mode, see BrickletParticulateMatter#set_bootloader_mode.
+    def get_bootloader_mode
+      send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 1, 'C'
+    end
+
+    # Sets the firmware pointer for BrickletParticulateMatter#write_firmware. The pointer has
+    # to be increased by chunks of size 64. The data is written to flash
+    # every 4 chunks (which equals to one page of size 256).
+    # 
+    # 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, ''
+    end
+
+    # Writes 64 Bytes of firmware at the position as written by
+    # BrickletParticulateMatter#set_write_firmware_pointer before. The firmware is written
+    # to flash every 4 chunks.
+    # 
+    # You can only write firmware in bootloader mode.
+    # 
+    # 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'
+    end
+
+    # Sets the status LED configuration. By default the LED shows
+    # communication traffic between Brick and Bricklet, it flickers once
+    # for every 10 received data packets.
+    # 
+    # You can also turn the LED permanently on/off or show a heartbeat.
+    # 
+    # 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, ''
+    end
+
+    # Returns the configuration as set by BrickletParticulateMatter#set_status_led_config
+    def get_status_led_config
+      send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 1, 'C'
+    end
+
+    # Returns the temperature in °C 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'
+    end
+
+    # Calling this function will reset the Bricklet. All configurations
+    # will be lost.
+    # 
+    # After a reset you have to create new device objects,
+    # calling functions on the existing ones will result in
+    # undefined behavior!
+    def reset
+      send_request FUNCTION_RESET, [], '', 0, ''
+    end
+
+    # Writes a new UID into flash. If you want to set a new UID
+    # you have to decode the Base58 encoded UID string into an
+    # integer first.
+    # 
+    # We recommend that you use Brick Viewer to change the UID.
+    def write_uid(uid)
+      send_request FUNCTION_WRITE_UID, [uid], 'L', 0, ''
+    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'
+    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 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'
+    end
+
+    # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.
+    def register_callback(id, &block)
+      callback = block
+      @registered_callbacks[id] = callback
+    end
+  end
+end