tinkerforge 2.1.22 → 2.1.27

data/lib/tinkerforge/bricklet_nfc.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-05-21.      #
+# This file was automatically generated on 2020-11-02.      #
 #                                                           #
-# Ruby Bindings Version 2.1.22                              #
+# Ruby Bindings Version 2.1.27                              #
 #                                                           #
 # 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
   # NFC tag read/write, NFC P2P and Card Emulation
   class BrickletNFC < Device
@@ -147,7 +149,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]
 
@@ -189,10 +191,11 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_READER_STATE_CHANGED] = 'C ?'
-      @callback_formats[CALLBACK_CARDEMU_STATE_CHANGED] = 'C ?'
-      @callback_formats[CALLBACK_P2P_STATE_CHANGED] = 'C ?'
+      @callback_formats[CALLBACK_READER_STATE_CHANGED] = [10, 'C ?']
+      @callback_formats[CALLBACK_CARDEMU_STATE_CHANGED] = [10, 'C ?']
+      @callback_formats[CALLBACK_P2P_STATE_CHANGED] = [10, 'C ?']
 
+      @ipcon.add_device self
     end
 
     # Sets the mode. The NFC Bricklet supports four modes:
@@ -205,30 +208,19 @@ module Tinkerforge
     # If you change a mode, the Bricklet will reconfigure the hardware for this mode.
     # Therefore, you can only use functions corresponding to the current mode. For
     # example, in Reader mode you can only use Reader functions.
-    # 
-    # The default mode is "off".
     def set_mode(mode)
-      send_request FUNCTION_SET_MODE, [mode], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MODE, [mode], 'C', 8, ''
     end
 
     # Returns the mode as set by BrickletNFC#set_mode.
     def get_mode
-      send_request FUNCTION_GET_MODE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_MODE, [], '', 9, 'C'
     end
 
-    # To read or write a tag that is in proximity of the NFC Bricklet you
-    # first have to call this function with the expected tag type as parameter.
-    # It is no problem if you don't know the tag type. You can cycle through
-    # the available tag types until the tag answers the request.
-    # 
-    # Currently the following tag types are supported:
-    # 
-    # * Mifare Classic
-    # * NFC Forum Type 1
-    # * NFC Forum Type 2
-    # * NFC Forum Type 3
-    # * NFC Forum Type 4
-    # 
     # After you call BrickletNFC#reader_request_tag_id the NFC Bricklet will try to read
     # the tag ID from the tag. After this process is done the state will change.
     # You can either register the CALLBACK_READER_STATE_CHANGED callback or you can poll
@@ -247,7 +239,9 @@ module Tinkerforge
     # In case of any *ReaderError* state the selection is lost and you have to
     # start again by calling BrickletNFC#reader_request_tag_id.
     def reader_request_tag_id
-      send_request FUNCTION_READER_REQUEST_TAG_ID, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_READER_REQUEST_TAG_ID, [], '', 8, ''
     end
 
     # Returns the tag type and the tag ID. This function can only be called if the
@@ -261,7 +255,9 @@ module Tinkerforge
     #    CALLBACK_READER_STATE_CHANGED callback)
     # 3. Call BrickletNFC#reader_get_tag_id
     def reader_get_tag_id_low_level
-      send_request FUNCTION_READER_GET_TAG_ID_LOW_LEVEL, [], '', 34, 'C C C32'
+      check_validity
+
+      send_request FUNCTION_READER_GET_TAG_ID_LOW_LEVEL, [], '', 42, 'C C C32'
     end
 
     # Returns the current reader state of the NFC Bricklet.
@@ -281,10 +277,12 @@ module Tinkerforge
     # 
     # The same approach is used analogously for the other API functions.
     def reader_get_state
-      send_request FUNCTION_READER_GET_STATE, [], '', 2, 'C ?'
+      check_validity
+
+      send_request FUNCTION_READER_GET_STATE, [], '', 10, 'C ?'
     end
 
-    # Writes NDEF formated data with a maximum of 255 bytes.
+    # Writes NDEF formated data.
     # 
     # This function currently supports NFC Forum Type 2 and 4.
     # 
@@ -299,7 +297,9 @@ module Tinkerforge
     # 5. Wait for state to change to *ReaderWriteNDEFReady* (see BrickletNFC#reader_get_state
     #    or CALLBACK_READER_STATE_CHANGED callback)
     def reader_write_ndef_low_level(ndef_length, ndef_chunk_offset, ndef_chunk_data)
-      send_request FUNCTION_READER_WRITE_NDEF_LOW_LEVEL, [ndef_length, ndef_chunk_offset, ndef_chunk_data], 'S S C60', 0, ''
+      check_validity
+
+      send_request FUNCTION_READER_WRITE_NDEF_LOW_LEVEL, [ndef_length, ndef_chunk_offset, ndef_chunk_data], 'S S C60', 8, ''
     end
 
     # Reads NDEF formated data from a tag.
@@ -318,15 +318,17 @@ module Tinkerforge
     #    or CALLBACK_READER_STATE_CHANGED callback)
     # 6. Call BrickletNFC#reader_read_ndef to retrieve the NDEF message from the buffer
     def reader_request_ndef
-      send_request FUNCTION_READER_REQUEST_NDEF, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_READER_REQUEST_NDEF, [], '', 8, ''
     end
 
     # Returns the NDEF data from an internal buffer. To fill the buffer
     # with a NDEF message you have to call BrickletNFC#reader_request_ndef beforehand.
-    # 
-    # The buffer can have a size of up to 8192 bytes.
     def reader_read_ndef_low_level
-      send_request FUNCTION_READER_READ_NDEF_LOW_LEVEL, [], '', 64, 'S S C60'
+      check_validity
+
+      send_request FUNCTION_READER_READ_NDEF_LOW_LEVEL, [], '', 72, 'S S C60'
     end
 
     # Mifare Classic tags use authentication. If you want to read from or write to
@@ -350,7 +352,9 @@ module Tinkerforge
     # 
     # The authentication will always work for one whole sector (4 pages).
     def reader_authenticate_mifare_classic_page(page, key_number, key)
-      send_request FUNCTION_READER_AUTHENTICATE_MIFARE_CLASSIC_PAGE, [page, key_number, key], 'S C C6', 0, ''
+      check_validity
+
+      send_request FUNCTION_READER_AUTHENTICATE_MIFARE_CLASSIC_PAGE, [page, key_number, key], 'S C C6', 8, ''
     end
 
     # Writes a maximum of 8192 bytes starting from the given page. How many pages are written
@@ -381,7 +385,9 @@ module Tinkerforge
     # 
     # Choose CC by setting page to 3 or NDEF by setting page to 4.
     def reader_write_page_low_level(page, data_length, data_chunk_offset, data_chunk_data)
-      send_request FUNCTION_READER_WRITE_PAGE_LOW_LEVEL, [page, data_length, data_chunk_offset, data_chunk_data], 'S S S C58', 0, ''
+      check_validity
+
+      send_request FUNCTION_READER_WRITE_PAGE_LOW_LEVEL, [page, data_length, data_chunk_offset, data_chunk_data], 'S S S C58', 8, ''
     end
 
     # Reads a maximum of 8192 bytes starting from the given page and stores them into a buffer.
@@ -415,15 +421,17 @@ module Tinkerforge
     # 
     # Choose CC by setting page to 3 or NDEF by setting page to 4.
     def reader_request_page(page, length)
-      send_request FUNCTION_READER_REQUEST_PAGE, [page, length], 'S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_READER_REQUEST_PAGE, [page, length], 'S S', 8, ''
     end
 
     # Returns the page data from an internal buffer. To fill the buffer
     # with specific pages you have to call BrickletNFC#reader_request_page beforehand.
-    # 
-    # The buffer can have a size of up to 8192 bytes.
     def reader_read_page_low_level
-      send_request FUNCTION_READER_READ_PAGE_LOW_LEVEL, [], '', 64, 'S S C60'
+      check_validity
+
+      send_request FUNCTION_READER_READ_PAGE_LOW_LEVEL, [], '', 72, 'S S C60'
     end
 
     # Returns the current cardemu state of the NFC Bricklet.
@@ -443,7 +451,9 @@ module Tinkerforge
     # 
     # The same approach is used analogously for the other API functions.
     def cardemu_get_state
-      send_request FUNCTION_CARDEMU_GET_STATE, [], '', 2, 'C ?'
+      check_validity
+
+      send_request FUNCTION_CARDEMU_GET_STATE, [], '', 10, 'C ?'
     end
 
     # Starts the discovery process. If you call this function while a NFC
@@ -457,10 +467,12 @@ module Tinkerforge
     # If the cardemu state changes to *CardemuDiscoveryReady* you can start the NDEF message
     # transfer with BrickletNFC#cardemu_write_ndef and BrickletNFC#cardemu_start_transfer.
     def cardemu_start_discovery
-      send_request FUNCTION_CARDEMU_START_DISCOVERY, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_CARDEMU_START_DISCOVERY, [], '', 8, ''
     end
 
-    # Writes the NDEF messages that is to be transferred to the NFC peer.
+    # Writes the NDEF message that is to be transferred to the NFC peer.
     # 
     # The maximum supported NDEF message size in Cardemu mode is 255 byte.
     # 
@@ -468,7 +480,9 @@ module Tinkerforge
     # will not be overwritten until you call this function again or change the
     # mode.
     def cardemu_write_ndef_low_level(ndef_length, ndef_chunk_offset, ndef_chunk_data)
-      send_request FUNCTION_CARDEMU_WRITE_NDEF_LOW_LEVEL, [ndef_length, ndef_chunk_offset, ndef_chunk_data], 'S S C60', 0, ''
+      check_validity
+
+      send_request FUNCTION_CARDEMU_WRITE_NDEF_LOW_LEVEL, [ndef_length, ndef_chunk_offset, ndef_chunk_data], 'S S C60', 8, ''
     end
 
     # You can start the transfer of a NDEF message if the cardemu state is *CardemuDiscoveryReady*.
@@ -480,7 +494,9 @@ module Tinkerforge
     # change to *CardemuTransferNDEFReady* if the transfer was successful or
     # *CardemuTransferNDEFError* if it wasn't.
     def cardemu_start_transfer(transfer)
-      send_request FUNCTION_CARDEMU_START_TRANSFER, [transfer], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_CARDEMU_START_TRANSFER, [transfer], 'C', 8, ''
     end
 
     # Returns the current P2P state of the NFC Bricklet.
@@ -500,7 +516,9 @@ module Tinkerforge
     # 
     # The same approach is used analogously for the other API functions.
     def p2p_get_state
-      send_request FUNCTION_P2P_GET_STATE, [], '', 2, 'C ?'
+      check_validity
+
+      send_request FUNCTION_P2P_GET_STATE, [], '', 10, 'C ?'
     end
 
     # Starts the discovery process. If you call this function while another NFC
@@ -514,10 +532,12 @@ module Tinkerforge
     # If the P2P state changes to *P2PDiscoveryReady* you can start the NDEF message
     # transfer with BrickletNFC#p2p_start_transfer.
     def p2p_start_discovery
-      send_request FUNCTION_P2P_START_DISCOVERY, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_P2P_START_DISCOVERY, [], '', 8, ''
     end
 
-    # Writes the NDEF messages that is to be transferred to the NFC peer.
+    # Writes the NDEF message that is to be transferred to the NFC peer.
     # 
     # The maximum supported NDEF message size for P2P transfer is 255 byte.
     # 
@@ -525,7 +545,9 @@ module Tinkerforge
     # will not be overwritten until you call this function again, change the
     # mode or use P2P to read an NDEF messages.
     def p2p_write_ndef_low_level(ndef_length, ndef_chunk_offset, ndef_chunk_data)
-      send_request FUNCTION_P2P_WRITE_NDEF_LOW_LEVEL, [ndef_length, ndef_chunk_offset, ndef_chunk_data], 'S S C60', 0, ''
+      check_validity
+
+      send_request FUNCTION_P2P_WRITE_NDEF_LOW_LEVEL, [ndef_length, ndef_chunk_offset, ndef_chunk_data], 'S S C60', 8, ''
     end
 
     # You can start the transfer of a NDEF message if the P2P state is *P2PDiscoveryReady*.
@@ -541,16 +563,19 @@ module Tinkerforge
     # you can now use BrickletNFC#p2p_read_ndef to read the NDEF message that was written
     # by the NFC peer.
     def p2p_start_transfer(transfer)
-      send_request FUNCTION_P2P_START_TRANSFER, [transfer], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_P2P_START_TRANSFER, [transfer], 'C', 8, ''
     end
 
     # Returns the NDEF message that was written by a NFC peer in NFC P2P mode.
-    # The maximum NDEF length is 8192 byte.
     # 
     # The NDEF message is ready if you called BrickletNFC#p2p_start_transfer with a
     # read transfer and the P2P state changed to *P2PTransferNDEFReady*.
     def p2p_read_ndef_low_level
-      send_request FUNCTION_P2P_READ_NDEF_LOW_LEVEL, [], '', 64, 'S S C60'
+      check_validity
+
+      send_request FUNCTION_P2P_READ_NDEF_LOW_LEVEL, [], '', 72, 'S S C60'
     end
 
     # Sets the detection LED configuration. By default the LED shows
@@ -560,15 +585,19 @@ module Tinkerforge
     # 
     # If the Bricklet is in bootloader mode, the LED is off.
     def set_detection_led_config(config)
-      send_request FUNCTION_SET_DETECTION_LED_CONFIG, [config], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DETECTION_LED_CONFIG, [config], 'C', 8, ''
     end
 
     # Returns the configuration as set by BrickletNFC#set_detection_led_config
     def get_detection_led_config
-      send_request FUNCTION_GET_DETECTION_LED_CONFIG, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_DETECTION_LED_CONFIG, [], '', 9, 'C'
     end
 
-    # Sets the maximum timeout in ms.
+    # Sets the maximum timeout.
     # 
     # 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
@@ -583,21 +612,23 @@ module Tinkerforge
     # 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
+    # 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, ''
+      check_validity
+
+      send_request FUNCTION_SET_MAXIMUM_TIMEOUT, [timeout], 'S', 8, ''
     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'
+      check_validity
+
+      send_request FUNCTION_GET_MAXIMUM_TIMEOUT, [], '', 10, 'S'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -612,7 +643,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
@@ -625,12 +658,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 BrickletNFC#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 BrickletNFC#write_firmware. The pointer has
@@ -640,7 +677,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
@@ -652,7 +691,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
@@ -663,22 +704,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 BrickletNFC#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
@@ -688,7 +735,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
@@ -697,25 +746,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
 
     # Returns the tag type and the tag ID. This function can only be called if the
@@ -734,7 +789,7 @@ module Tinkerforge
       [ret[0], ret[2][0, ret[1]]]
     end
 
-    # Writes NDEF formated data with a maximum of 255 bytes.
+    # Writes NDEF formated data.
     # 
     # This function currently supports NFC Forum Type 2 and 4.
     # 
@@ -781,8 +836,6 @@ module Tinkerforge
 
     # Returns the NDEF data from an internal buffer. To fill the buffer
     # with a NDEF message you have to call BrickletNFC#reader_request_ndef beforehand.
-    # 
-    # The buffer can have a size of up to 8192 bytes.
     def reader_read_ndef
       ndef_length = nil # assigned in block
       ndef_data = nil # assigned in block
@@ -876,8 +929,6 @@ module Tinkerforge
 
     # Returns the page data from an internal buffer. To fill the buffer
     # with specific pages you have to call BrickletNFC#reader_request_page beforehand.
-    # 
-    # The buffer can have a size of up to 8192 bytes.
     def reader_read_page
       data_length = nil # assigned in block
       data_data = nil # assigned in block
@@ -911,7 +962,7 @@ module Tinkerforge
       data_data[0, data_length]
     end
 
-    # Writes the NDEF messages that is to be transferred to the NFC peer.
+    # Writes the NDEF message that is to be transferred to the NFC peer.
     # 
     # The maximum supported NDEF message size in Cardemu mode is 255 byte.
     # 
@@ -949,7 +1000,7 @@ module Tinkerforge
       ret
     end
 
-    # Writes the NDEF messages that is to be transferred to the NFC peer.
+    # Writes the NDEF message that is to be transferred to the NFC peer.
     # 
     # The maximum supported NDEF message size for P2P transfer is 255 byte.
     # 
@@ -988,7 +1039,6 @@ module Tinkerforge
     end
 
     # Returns the NDEF message that was written by a NFC peer in NFC P2P mode.
-    # The maximum NDEF length is 8192 byte.
     # 
     # The NDEF message is ready if you called BrickletNFC#p2p_start_transfer with a
     # read transfer and the P2P state changed to *P2PTransferNDEFReady*.