tinkerforge 2.1.17 → 2.1.18

data/lib/tinkerforge/bricklet_dual_button_v2.rb

@@ -0,0 +1,283 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2018-09-28.      #
+#                                                           #
+# Ruby Bindings Version 2.1.18                              #
+#                                                           #
+# 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
+  # Two tactile buttons with built-in blue LEDs
+  class BrickletDualButtonV2 < Device
+    DEVICE_IDENTIFIER = 2119 # :nodoc:
+    DEVICE_DISPLAY_NAME = 'Dual Button Bricklet 2.0' # :nodoc:
+
+    # This callback is called whenever a button is pressed.
+    # 
+    # Possible states for buttons are:
+    # 
+    # * 0 = pressed
+    # * 1 = released
+    # 
+    # Possible states for LEDs are:
+    # 
+    # * 0 = AutoToggleOn: Auto toggle enabled and LED on.
+    # * 1 = AutoToggleOff: Auto toggle enabled and LED off.
+    # * 2 = On: LED on (auto toggle is disabled).
+    # * 3 = Off: LED off (auto toggle is disabled).
+    # 
+    # This callback can be enabled with BrickletDualButtonV2#set_state_changed_callback_configuration.
+    CALLBACK_STATE_CHANGED = 4
+
+    FUNCTION_SET_LED_STATE = 1 # :nodoc:
+    FUNCTION_GET_LED_STATE = 2 # :nodoc:
+    FUNCTION_GET_BUTTON_STATE = 3 # :nodoc:
+    FUNCTION_SET_SELECTED_LED_STATE = 5 # :nodoc:
+    FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION = 6 # :nodoc:
+    FUNCTION_GET_STATE_CHANGED_CALLBACK_CONFIGURATION = 7 # :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:
+
+    LED_STATE_AUTO_TOGGLE_ON = 0 # :nodoc:
+    LED_STATE_AUTO_TOGGLE_OFF = 1 # :nodoc:
+    LED_STATE_ON = 2 # :nodoc:
+    LED_STATE_OFF = 3 # :nodoc:
+    BUTTON_STATE_PRESSED = 0 # :nodoc:
+    BUTTON_STATE_RELEASED = 1 # :nodoc:
+    LED_LEFT = 0 # :nodoc:
+    LED_RIGHT = 1 # :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_SET_LED_STATE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_LED_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_BUTTON_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_SELECTED_LED_STATE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_GET_STATE_CHANGED_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_STATE_CHANGED] = 'C C C C'
+
+    end
+
+    # Sets the state of the LEDs. Possible states are:
+    # 
+    # * 0 = AutoToggleOn: Enables auto toggle with initially enabled LED.
+    # * 1 = AutoToggleOff: Activates auto toggle with initially disabled LED.
+    # * 2 = On: Enables LED (auto toggle is disabled).
+    # * 3 = Off: Disables LED (auto toggle is disabled).
+    # 
+    # In auto toggle mode the LED is toggled automatically at each press of a button.
+    # 
+    # If you just want to set one of the LEDs and don't know the current state
+    # of the other LED, you can get the state with BrickletDualButtonV2#get_led_state or you
+    # can use BrickletDualButtonV2#set_selected_led_state.
+    # 
+    # The default value is (1, 1).
+    def set_led_state(led_l, led_r)
+      send_request FUNCTION_SET_LED_STATE, [led_l, led_r], 'C C', 0, ''
+    end
+
+    # Returns the current state of the LEDs, as set by BrickletDualButtonV2#set_led_state.
+    def get_led_state
+      send_request FUNCTION_GET_LED_STATE, [], '', 2, 'C C'
+    end
+
+    # Returns the current state for both buttons. Possible states are:
+    # 
+    # * 0 = pressed
+    # * 1 = released
+    def get_button_state
+      send_request FUNCTION_GET_BUTTON_STATE, [], '', 2, 'C C'
+    end
+
+    # Sets the state of the selected LED (0 or 1).
+    # 
+    # The other LED remains untouched.
+    def set_selected_led_state(led, state)
+      send_request FUNCTION_SET_SELECTED_LED_STATE, [led, state], 'C C', 0, ''
+    end
+
+    # If you enable this callback, the CALLBACK_STATE_CHANGED callback is triggered
+    # every time a button is pressed/released
+    # 
+    # By default this callback is disabled.
+    def set_state_changed_callback_configuration(enabled)
+      send_request FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION, [enabled], '?', 0, ''
+    end
+
+    # Returns the configuration as set by BrickletDualButtonV2#set_state_changed_callback_configuration.
+    def get_state_changed_callback_configuration
+      send_request FUNCTION_GET_STATE_CHANGED_CALLBACK_CONFIGURATION, [], '', 1, '?'
+    end
+
+    # Returns the error count for the communication between Brick and Bricklet.
+    # 
+    # The errors are divided into
+    # 
+    # * ACK checksum errors,
+    # * message checksum errors,
+    # * framing 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 and 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 BrickletDualButtonV2#set_bootloader_mode.
+    def get_bootloader_mode
+      send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 1, 'C'
+    end
+
+    # Sets the firmware pointer for BrickletDualButtonV2#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
+    # BrickletDualButtonV2#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 BrickletDualButtonV2#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

data/lib/tinkerforge/bricklet_dual_relay.rb

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

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

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

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2018-06-08.      #
+# This file was automatically generated on 2018-09-28.      #
 #                                                           #
-# Ruby Bindings Version 2.1.17                              #
+# Ruby Bindings Version 2.1.18                              #
 #                                                           #
 # 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  #
@@ -381,7 +381,7 @@ module Tinkerforge
       send_request FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD, [], '', 4, 'L'
     end
 
-    # If `SBAS <https://en.wikipedia.org/wiki/GNSS_augmentation#Satellite-based_augmentation_system>`__ is enabled, 
+    # If `SBAS <https://en.wikipedia.org/wiki/GNSS_augmentation#Satellite-based_augmentation_system>`__ is enabled,
     # the position accuracy increases (if SBAS satellites are in view),
     # but the update rate is limited to 5Hz. With SBAS disabled the update rate is increased to 10Hz.
     # 
@@ -403,9 +403,9 @@ module Tinkerforge
     # 
     # The errors are divided into
     # 
-    # * ack checksum errors,
+    # * ACK checksum errors,
     # * message checksum errors,
-    # * frameing errors and
+    # * framing errors and
     # * overflow errors.
     # 
     # The errors counts are for errors that occur on the Bricklet side. All
@@ -419,7 +419,7 @@ module Tinkerforge
     # 
     # 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.
+    # device identifier and 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.

data/lib/tinkerforge/bricklet_hall_effect.rb

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

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

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2018-06-08.      #
+# This file was automatically generated on 2018-09-28.      #
 #                                                           #
-# Ruby Bindings Version 2.1.17                              #
+# Ruby Bindings Version 2.1.18                              #
 #                                                           #
 # 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  #
@@ -243,9 +243,9 @@ module Tinkerforge
     # 
     # The errors are divided into
     # 
-    # * ack checksum errors,
+    # * ACK checksum errors,
     # * message checksum errors,
-    # * frameing errors and
+    # * framing errors and
     # * overflow errors.
     # 
     # The errors counts are for errors that occur on the Bricklet side. All
@@ -259,7 +259,7 @@ module Tinkerforge
     # 
     # 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.
+    # device identifier and 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.

data/lib/tinkerforge/bricklet_industrial_analog_out.rb

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