Ruby - NFC Bricklet

This is the description of the Ruby API bindings for the NFC Bricklet. General information and technical specifications for the NFC Bricklet are summarized in its hardware description.

An installation guide for the Ruby API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Scan For Tags

Download (example_scan_for_tags.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_nfc'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your NFC Bricklet

ipcon = IPConnection.new # Create IP connection
nfc = BrickletNFC.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register reader state changed callback
nfc.register_callback(BrickletNFC::CALLBACK_READER_STATE_CHANGED) do |state, idle|
  if state == BrickletNFC::READER_STATE_IDLE
    nfc.reader_request_tag_id
  elsif state == BrickletNFC::READER_STATE_REQUEST_TAG_ID_READY
    tag_id = Array.new
    ret = nfc.reader_get_tag_id

    ret[1].each do |v|
      tag_id.push "0x%X" % v
    end

    puts ret.class
    puts "Found tag of type #{ret[0]} with ID [#{tag_id.join(" ")}]"
  elsif state == BrickletNFC::READER_STATE_REQUEST_TAG_ID_ERROR
    puts 'Request tag ID error'
  end
end

# Enable reader mode
nfc.set_mode BrickletNFC::MODE_READER

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Emulate Ndef

Download (example_emulate_ndef.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_nfc'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your NFC Bricklet
NDEF_URI = 'www.tinkerforge.com'

ipcon = IPConnection.new # Create IP connection
nfc = BrickletNFC.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register cardemu state changed callback
nfc.register_callback(BrickletNFC::CALLBACK_CARDEMU_STATE_CHANGED) do |state, idle|
  if state == BrickletNFC::CARDEMU_STATE_IDLE
    # Only short records are supported.
    ndef_record_uri = [
                        0xD1,                # MB/ME/CF/SR=1/IL/TNF
                        0x01,                # TYPE LENGTH
                        NDEF_URI.length + 1, # Length
                        'U'.ord,             # Type
                        4                    # Status
                      ]

    NDEF_URI.split('').each do |c|
      ndef_record_uri.push c.ord
    end

    nfc.cardemu_write_ndef ndef_record_uri
    nfc.cardemu_start_discovery
  elsif state == BrickletNFC::CARDEMU_STATE_DISCOVER_READY
    nfc.cardemu_start_transfer BrickletNFC::CARDEMU_TRANSFER_WRITE
  elsif state == BrickletNFC::CARDEMU_STATE_DISCOVER_ERROR
    puts "Discover error"
  elsif state == BrickletNFC::CARDEMU_STATE_TRANSFER_NDEF_ERROR
    puts "Transfer NDEF error"
  end
end

# Enable cardemu mode
nfc.set_mode BrickletNFC::MODE_CARDEMU

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Write Read Type2

Download (example_write_read_type2.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_nfc'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your NFC Bricklet

ipcon = IPConnection.new # Create IP connection
nfc = BrickletNFC.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register reader state changed callback
nfc.register_callback(BrickletNFC::CALLBACK_READER_STATE_CHANGED) do |state, idle|
  if state == BrickletNFC::READER_STATE_IDLE
    nfc.reader_request_tag_id
  elsif state == BrickletNFC::READER_STATE_REQUEST_TAG_ID_READY
    ret = nfc.reader_get_tag_id

    if ret[0] != BrickletNFC::TAG_TYPE_TYPE2
      puts "Tag is not type-2"

      return
    end

    printf "Found tag of type #{ret[0]} with ID [0x%X 0x%X 0x%X 0x%X]\n",
           ret[0],
           ret[1][0],
           ret[1][1],
           ret[1][2],
           ret[1][3]

    nfc.reader_request_page 1, 4
  elsif state == BrickletNFC::READER_STATE_REQUEST_TAG_ID_ERROR
    puts "Request tag ID error"
  elsif state == BrickletNFC::READER_STATE_REQUEST_PAGE_READY
    page = nfc.reader_read_page
    printf "Page read: 0x%X 0x%X 0x%X 0x%X\n", page[0], page[1], page[2], page[3]
    nfc.reader_write_page 1, page
  elsif state == BrickletNFC::READER_STATE_WRITE_PAGE_READY
    puts "Write page ready"
  elsif state == BrickletNFC::READER_STATE_REQUEST_PAGE_ERROR
    puts "Request page error"
  elsif state == BrickletNFC::READER_STATE_WRITE_PAGE_ERROR
    puts "Write page error"
  end
end

# Enable reader mode
nfc.set_mode BrickletNFC::MODE_READER

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

All methods listed below are thread-safe.

Basic Functions

BrickletNFC::new(uid, ipcon) → nfc
Parameters:
  • uid -- str
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

nfc = BrickletNFC.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected (see examples above).

BrickletNFC#set_mode(mode) → nil
Parameters:mode -- int

Sets the mode. The NFC Bricklet supports four modes:

  • Off
  • Card Emulation (Cardemu): Emulates a tag for other readers
  • Peer to Peer (P2P): Exchange data with other readers
  • Reader: Reads and writes tags

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".

The following constants are available for this function:

  • BrickletNFC::MODE_OFF = 0
  • BrickletNFC::MODE_CARDEMU = 1
  • BrickletNFC::MODE_P2P = 2
  • BrickletNFC::MODE_READER = 3
BrickletNFC#get_mode → int

Returns the mode as set by #set_mode.

The following constants are available for this function:

  • BrickletNFC::MODE_OFF = 0
  • BrickletNFC::MODE_CARDEMU = 1
  • BrickletNFC::MODE_P2P = 2
  • BrickletNFC::MODE_READER = 3
BrickletNFC#reader_request_tag_id → nil

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 #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 #reader_get_state to find out about the state change.

If the state changes to ReaderRequestTagIDError it means that either there was no tag present or that the tag has an incompatible type. If the state changes to ReaderRequestTagIDReady it means that a compatible tag was found and that the tag ID has been saved. You can now read out the tag ID by calling #reader_get_tag_id.

If two tags are in the proximity of the NFC Bricklet, this function will cycle through the tags. To select a specific tag you have to call #reader_request_tag_id until the correct tag ID is found.

In case of any ReaderError state the selection is lost and you have to start again by calling #reader_request_tag_id.

BrickletNFC#reader_get_tag_id → [int, [int, int, ...]]

Returns the tag type and the tag ID. This function can only be called if the NFC Bricklet is currently in one of the ReaderReady states. The returned tag ID is the tag ID that was saved through the last call of #reader_request_tag_id.

To get the tag ID of a tag the approach is as follows:

  1. Call #reader_request_tag_id
  2. Wait for state to change to ReaderRequestTagIDReady (see #reader_get_state or ::CALLBACK_READER_STATE_CHANGED callback)
  3. Call #reader_get_tag_id

The following constants are available for this function:

  • BrickletNFC::TAG_TYPE_MIFARE_CLASSIC = 0
  • BrickletNFC::TAG_TYPE_TYPE1 = 1
  • BrickletNFC::TAG_TYPE_TYPE2 = 2
  • BrickletNFC::TAG_TYPE_TYPE3 = 3
  • BrickletNFC::TAG_TYPE_TYPE4 = 4

The returned array has the values tag_type and tag_id.

BrickletNFC#reader_get_state → [int, bool]

Returns the current reader state of the NFC Bricklet.

On startup the Bricklet will be in the ReaderInitialization state. The initialization will only take about 20ms. After that it changes to ReaderIdle.

The Bricklet is also reinitialized if the mode is changed, see #set_mode.

The functions of this Bricklet can be called in the ReaderIdle state and all of the ReaderReady and ReaderError states.

Example: If you call #reader_request_page, the state will change to ReaderRequestPage until the reading of the page is finished. Then it will change to either ReaderRequestPageReady if it worked or to ReaderRequestPageError if it didn't. If the request worked you can get the page by calling #reader_read_page.

The same approach is used analogously for the other API functions.

The following constants are available for this function:

  • BrickletNFC::READER_STATE_INITIALIZATION = 0
  • BrickletNFC::READER_STATE_IDLE = 128
  • BrickletNFC::READER_STATE_ERROR = 192
  • BrickletNFC::READER_STATE_REQUEST_TAG_ID = 2
  • BrickletNFC::READER_STATE_REQUEST_TAG_ID_READY = 130
  • BrickletNFC::READER_STATE_REQUEST_TAG_ID_ERROR = 194
  • BrickletNFC::READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 3
  • BrickletNFC::READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_READY = 131
  • BrickletNFC::READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_ERROR = 195
  • BrickletNFC::READER_STATE_WRITE_PAGE = 4
  • BrickletNFC::READER_STATE_WRITE_PAGE_READY = 132
  • BrickletNFC::READER_STATE_WRITE_PAGE_ERROR = 196
  • BrickletNFC::READER_STATE_REQUEST_PAGE = 5
  • BrickletNFC::READER_STATE_REQUEST_PAGE_READY = 133
  • BrickletNFC::READER_STATE_REQUEST_PAGE_ERROR = 197
  • BrickletNFC::READER_STATE_WRITE_NDEF = 6
  • BrickletNFC::READER_STATE_WRITE_NDEF_READY = 134
  • BrickletNFC::READER_STATE_WRITE_NDEF_ERROR = 198
  • BrickletNFC::READER_STATE_REQUEST_NDEF = 7
  • BrickletNFC::READER_STATE_REQUEST_NDEF_READY = 135
  • BrickletNFC::READER_STATE_REQUEST_NDEF_ERROR = 199

The returned array has the values state and idle.

BrickletNFC#reader_write_ndef(ndef) → nil
Parameters:ndef -- [int, int, ...]

Writes NDEF formated data with a maximum of 255 bytes.

This function currently supports NFC Forum Type 2 and 4.

The general approach for writing a NDEF message is as follows:

  1. Call #reader_request_tag_id
  2. Wait for state to change to ReaderRequestTagIDReady (see #reader_get_state or ::CALLBACK_READER_STATE_CHANGED callback)
  3. If looking for a specific tag then call #reader_get_tag_id and check if the expected tag was found, if it was not found got back to step 1
  4. Call #reader_write_ndef with the NDEF message that you want to write
  5. Wait for state to change to ReaderWriteNDEFReady (see #reader_get_state or ::CALLBACK_READER_STATE_CHANGED callback)
BrickletNFC#reader_request_ndef → nil

Reads NDEF formated data from a tag.

This function currently supports NFC Forum Type 1, 2, 3 and 4.

The general approach for reading a NDEF message is as follows:

  1. Call #reader_request_tag_id
  2. Wait for state to change to RequestTagIDReady (see #reader_get_state or ::CALLBACK_READER_STATE_CHANGED callback)
  3. If looking for a specific tag then call #reader_get_tag_id and check if the expected tag was found, if it was not found got back to step 1
  4. Call #reader_request_ndef
  5. Wait for state to change to ReaderRequestNDEFReady (see #reader_get_state or ::CALLBACK_READER_STATE_CHANGED callback)
  6. Call #reader_read_ndef to retrieve the NDEF message from the buffer
BrickletNFC#reader_read_ndef → [int, int, ...]

Returns the NDEF data from an internal buffer. To fill the buffer with a NDEF message you have to call #reader_request_ndef beforehand.

The buffer can have a size of up to 8192 bytes.

BrickletNFC#reader_authenticate_mifare_classic_page(page, key_number, key) → nil
Parameters:
  • page -- int
  • key_number -- int
  • key -- [int, int, ..3x.., int]

Mifare Classic tags use authentication. If you want to read from or write to a Mifare Classic page you have to authenticate it beforehand. Each page can be authenticated with two keys: A (key_number = 0) and B (key_number = 1). A new Mifare Classic tag that has not yet been written to can be accessed with key A and the default key [0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF].

The approach to read or write a Mifare Classic page is as follows:

  1. Call #reader_request_tag_id
  2. Wait for state to change to ReaderRequestTagIDReady (see #reader_get_state or ::CALLBACK_READER_STATE_CHANGED callback)
  3. If looking for a specific tag then call #reader_get_tag_id and check if the expected tag was found, if it was not found got back to step 1
  4. Call #reader_authenticate_mifare_classic_page with page and key for the page
  5. Wait for state to change to ReaderAuthenticatingMifareClassicPageReady (see #reader_get_state or ::CALLBACK_READER_STATE_CHANGED callback)
  6. Call #reader_request_page or #reader_write_page to read/write page

The authentication will always work for one whole sector (4 pages).

The following constants are available for this function:

  • BrickletNFC::KEY_A = 0
  • BrickletNFC::KEY_B = 1
BrickletNFC#reader_write_page(page, data) → nil
Parameters:
  • page -- int
  • data -- [int, int, ...]

Writes a maximum of 8192 bytes starting from the given page. How many pages are written depends on the tag type. The page sizes are as follows:

  • Mifare Classic page size: 16 byte
  • NFC Forum Type 1 page size: 8 byte
  • NFC Forum Type 2 page size: 4 byte
  • NFC Forum Type 3 page size: 16 byte
  • NFC Forum Type 4: No pages, page = file selection (CC or NDEF, see below)

The general approach for writing to a tag is as follows:

  1. Call #reader_request_tag_id
  2. Wait for state to change to ReaderRequestTagIDReady (see #reader_get_state or ::CALLBACK_READER_STATE_CHANGED callback)
  3. If looking for a specific tag then call #reader_get_tag_id and check if the expected tag was found, if it was not found got back to step 1
  4. Call #reader_write_page with page number and data
  5. Wait for state to change to ReaderWritePageReady (see #reader_get_state or ::CALLBACK_READER_STATE_CHANGED callback)

If you use a Mifare Classic tag you have to authenticate a page before you can write to it. See #reader_authenticate_mifare_classic_page.

NFC Forum Type 4 tags are not organized into pages but different files. We currently support two files: Capability Container file (CC) and NDEF file.

Choose CC by setting page to 3 or NDEF by setting page to 4.

The following constants are available for this function:

  • BrickletNFC::READER_WRITE_TYPE4_CAPABILITY_CONTAINER = 3
  • BrickletNFC::READER_WRITE_TYPE4_NDEF = 4
BrickletNFC#reader_request_page(page, length) → nil
Parameters:
  • page -- int
  • length -- int

Reads a maximum of 8192 bytes starting from the given page and stores them into a buffer. The buffer can then be read out with #reader_read_page. How many pages are read depends on the tag type. The page sizes are as follows:

  • Mifare Classic page size: 16 byte
  • NFC Forum Type 1 page size: 8 byte
  • NFC Forum Type 2 page size: 4 byte
  • NFC Forum Type 3 page size: 16 byte
  • NFC Forum Type 4: No pages, page = file selection (CC or NDEF, see below)

The general approach for reading a tag is as follows:

  1. Call #reader_request_tag_id
  2. Wait for state to change to RequestTagIDReady (see #reader_get_state or ::CALLBACK_READER_STATE_CHANGED callback)
  3. If looking for a specific tag then call #reader_get_tag_id and check if the expected tag was found, if it was not found got back to step 1
  4. Call #reader_request_page with page number
  5. Wait for state to change to ReaderRequestPageReady (see #reader_get_state or ::CALLBACK_READER_STATE_CHANGED callback)
  6. Call #reader_read_page to retrieve the page from the buffer

If you use a Mifare Classic tag you have to authenticate a page before you can read it. See #reader_authenticate_mifare_classic_page.

NFC Forum Type 4 tags are not organized into pages but different files. We currently support two files: Capability Container file (CC) and NDEF file.

Choose CC by setting page to 3 or NDEF by setting page to 4.

The following constants are available for this function:

  • BrickletNFC::READER_REQUEST_TYPE4_CAPABILITY_CONTAINER = 3
  • BrickletNFC::READER_REQUEST_TYPE4_NDEF = 4
BrickletNFC#reader_read_page → [int, int, ...]

Returns the page data from an internal buffer. To fill the buffer with specific pages you have to call #reader_request_page beforehand.

The buffer can have a size of up to 8192 bytes.

BrickletNFC#cardemu_get_state → [int, bool]

Returns the current cardemu state of the NFC Bricklet.

On startup the Bricklet will be in the CardemuInitialization state. The initialization will only take about 20ms. After that it changes to CardemuIdle.

The Bricklet is also reinitialized if the mode is changed, see #set_mode.

The functions of this Bricklet can be called in the CardemuIdle state and all of the CardemuReady and CardemuError states.

Example: If you call #cardemu_start_discovery, the state will change to CardemuDiscover until the discovery is finished. Then it will change to either CardemuDiscoverReady if it worked or to CardemuDiscoverError if it didn't.

The same approach is used analogously for the other API functions.

The following constants are available for this function:

  • BrickletNFC::CARDEMU_STATE_INITIALIZATION = 0
  • BrickletNFC::CARDEMU_STATE_IDLE = 128
  • BrickletNFC::CARDEMU_STATE_ERROR = 192
  • BrickletNFC::CARDEMU_STATE_DISCOVER = 2
  • BrickletNFC::CARDEMU_STATE_DISCOVER_READY = 130
  • BrickletNFC::CARDEMU_STATE_DISCOVER_ERROR = 194
  • BrickletNFC::CARDEMU_STATE_TRANSFER_NDEF = 3
  • BrickletNFC::CARDEMU_STATE_TRANSFER_NDEF_READY = 131
  • BrickletNFC::CARDEMU_STATE_TRANSFER_NDEF_ERROR = 195

The returned array has the values state and idle.

BrickletNFC#cardemu_start_discovery → nil

Starts the discovery process. If you call this function while a NFC reader device is near to the NFC Bricklet the state will change from CardemuDiscovery to CardemuDiscoveryReady.

If no NFC reader device can be found or if there is an error during discovery the cardemu state will change to CardemuDiscoveryError. In this case you have to restart the discovery process.

If the cardemu state changes to CardemuDiscoveryReady you can start the NDEF message transfer with #cardemu_write_ndef and #cardemu_start_transfer.

BrickletNFC#cardemu_write_ndef(ndef) → nil
Parameters:ndef -- [int, int, ...]

Writes the NDEF messages that is to be transferred to the NFC peer.

The maximum supported NDEF message size in Cardemu mode is 255 byte.

You can call this function at any time in Cardemu mode. The internal buffer will not be overwritten until you call this function again or change the mode.

BrickletNFC#cardemu_start_transfer(transfer) → nil
Parameters:transfer -- int

You can start the transfer of a NDEF message if the cardemu state is CardemuDiscoveryReady.

Before you call this function to start a write transfer, the NDEF message that is to be transferred has to be written via #cardemu_write_ndef first.

After you call this function the state will change to CardemuTransferNDEF. It will change to CardemuTransferNDEFReady if the transfer was successful or CardemuTransferNDEFError if it wasn't.

The following constants are available for this function:

  • BrickletNFC::CARDEMU_TRANSFER_ABORT = 0
  • BrickletNFC::CARDEMU_TRANSFER_WRITE = 1
BrickletNFC#p2p_get_state → [int, bool]

Returns the current P2P state of the NFC Bricklet.

On startup the Bricklet will be in the P2PInitialization state. The initialization will only take about 20ms. After that it changes to P2PIdle.

The Bricklet is also reinitialized if the mode is changed, see #set_mode.

The functions of this Bricklet can be called in the P2PIdle state and all of the P2PReady and P2PError states.

Example: If you call #p2p_start_discovery, the state will change to P2PDiscover until the discovery is finished. Then it will change to either P2PDiscoverReady* if it worked or to P2PDiscoverError if it didn't.

The same approach is used analogously for the other API functions.

The following constants are available for this function:

  • BrickletNFC::P2P_STATE_INITIALIZATION = 0
  • BrickletNFC::P2P_STATE_IDLE = 128
  • BrickletNFC::P2P_STATE_ERROR = 192
  • BrickletNFC::P2P_STATE_DISCOVER = 2
  • BrickletNFC::P2P_STATE_DISCOVER_READY = 130
  • BrickletNFC::P2P_STATE_DISCOVER_ERROR = 194
  • BrickletNFC::P2P_STATE_TRANSFER_NDEF = 3
  • BrickletNFC::P2P_STATE_TRANSFER_NDEF_READY = 131
  • BrickletNFC::P2P_STATE_TRANSFER_NDEF_ERROR = 195

The returned array has the values state and idle.

BrickletNFC#p2p_start_discovery → nil

Starts the discovery process. If you call this function while another NFC P2P enabled device is near to the NFC Bricklet the state will change from P2PDiscovery to P2PDiscoveryReady.

If no NFC P2P enabled device can be found or if there is an error during discovery the P2P state will change to P2PDiscoveryError. In this case you have to restart the discovery process.

If the P2P state changes to P2PDiscoveryReady you can start the NDEF message transfer with #p2p_start_transfer.

BrickletNFC#p2p_write_ndef(ndef) → nil
Parameters:ndef -- [int, int, ...]

Writes the NDEF messages that is to be transferred to the NFC peer.

The maximum supported NDEF message size for P2P transfer is 255 byte.

You can call this function at any time in P2P mode. The internal buffer will not be overwritten until you call this function again, change the mode or use P2P to read an NDEF messages.

BrickletNFC#p2p_start_transfer(transfer) → nil
Parameters:transfer -- int

You can start the transfer of a NDEF message if the P2P state is P2PDiscoveryReady.

Before you call this function to start a write transfer, the NDEF message that is to be transferred has to be written via #p2p_write_ndef first.

After you call this function the P2P state will change to P2PTransferNDEF. It will change to P2PTransferNDEFReady if the transfer was successfull or P2PTransferNDEFError if it wasn't.

If you started a write transfer you are now done. If you started a read transfer you can now use #p2p_read_ndef to read the NDEF message that was written by the NFC peer.

The following constants are available for this function:

  • BrickletNFC::P2P_TRANSFER_ABORT = 0
  • BrickletNFC::P2P_TRANSFER_WRITE = 1
  • BrickletNFC::P2P_TRANSFER_READ = 2
BrickletNFC#p2p_read_ndef → [int, int, ...]

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 #p2p_start_transfer with a read transfer and the P2P state changed to P2PTransferNDEFReady.

Advanced Functions

BrickletNFC#set_detection_led_config(config) → nil
Parameters:config -- int

Sets the detection LED configuration. By default the LED shows if a card/reader is detected.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

  • BrickletNFC::DETECTION_LED_CONFIG_OFF = 0
  • BrickletNFC::DETECTION_LED_CONFIG_ON = 1
  • BrickletNFC::DETECTION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletNFC::DETECTION_LED_CONFIG_SHOW_DETECTION = 3
BrickletNFC#get_detection_led_config → int

Returns the configuration as set by #set_detection_led_config

The following constants are available for this function:

  • BrickletNFC::DETECTION_LED_CONFIG_OFF = 0
  • BrickletNFC::DETECTION_LED_CONFIG_ON = 1
  • BrickletNFC::DETECTION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletNFC::DETECTION_LED_CONFIG_SHOW_DETECTION = 3
BrickletNFC#set_maximum_timeout(timeout) → nil
Parameters:timeout -- int

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 #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.

New in version 2.0.1 (Plugin).

BrickletNFC#get_maximum_timeout → int

Returns the timeout as set by #set_maximum_timeout

New in version 2.0.1 (Plugin).

BrickletNFC#get_api_version → [int, int, int]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletNFC#get_response_expected(function_id) → bool
Parameters:function_id -- int

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by #set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See #set_response_expected for the list of function ID constants available for this function.

BrickletNFC#set_response_expected(function_id, response_expected) → nil
Parameters:
  • function_id -- int
  • response_expected -- bool

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletNFC::FUNCTION_SET_MODE = 1
  • BrickletNFC::FUNCTION_READER_REQUEST_TAG_ID = 3
  • BrickletNFC::FUNCTION_READER_WRITE_NDEF = 6
  • BrickletNFC::FUNCTION_READER_REQUEST_NDEF = 7
  • BrickletNFC::FUNCTION_READER_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 9
  • BrickletNFC::FUNCTION_READER_WRITE_PAGE = 10
  • BrickletNFC::FUNCTION_READER_REQUEST_PAGE = 11
  • BrickletNFC::FUNCTION_CARDEMU_START_DISCOVERY = 15
  • BrickletNFC::FUNCTION_CARDEMU_WRITE_NDEF = 16
  • BrickletNFC::FUNCTION_CARDEMU_START_TRANSFER = 17
  • BrickletNFC::FUNCTION_P2P_START_DISCOVERY = 20
  • BrickletNFC::FUNCTION_P2P_WRITE_NDEF = 21
  • BrickletNFC::FUNCTION_P2P_START_TRANSFER = 22
  • BrickletNFC::FUNCTION_SET_DETECTION_LED_CONFIG = 25
  • BrickletNFC::FUNCTION_SET_MAXIMUM_TIMEOUT = 27
  • BrickletNFC::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletNFC::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletNFC::FUNCTION_RESET = 243
  • BrickletNFC::FUNCTION_WRITE_UID = 248
BrickletNFC#set_response_expected_all(response_expected) → nil
Parameters:response_expected -- bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

BrickletNFC#get_spitfp_error_count → [int, int, int, int]

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.

The returned array has the values error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

BrickletNFC#set_bootloader_mode(mode) → int
Parameters:mode -- int

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.

The following constants are available for this function:

  • BrickletNFC::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletNFC::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletNFC::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletNFC::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletNFC::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletNFC::BOOTLOADER_STATUS_OK = 0
  • BrickletNFC::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletNFC::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletNFC::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletNFC::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletNFC::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletNFC#get_bootloader_mode → int

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

  • BrickletNFC::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletNFC::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletNFC::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletNFC::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletNFC::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletNFC#set_write_firmware_pointer(pointer) → nil
Parameters:pointer -- int

Sets the firmware pointer for #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.

BrickletNFC#write_firmware(data) → int
Parameters:data -- [int, int, ..61x.., int]

Writes 64 Bytes of firmware at the position as written by #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.

BrickletNFC#set_status_led_config(config) → nil
Parameters:config -- int

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.

The following constants are available for this function:

  • BrickletNFC::STATUS_LED_CONFIG_OFF = 0
  • BrickletNFC::STATUS_LED_CONFIG_ON = 1
  • BrickletNFC::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletNFC::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletNFC#get_status_led_config → int

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

  • BrickletNFC::STATUS_LED_CONFIG_OFF = 0
  • BrickletNFC::STATUS_LED_CONFIG_ON = 1
  • BrickletNFC::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletNFC::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletNFC#get_chip_temperature → int

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.

BrickletNFC#reset → nil

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!

BrickletNFC#write_uid(uid) → nil
Parameters:uid -- int

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.

BrickletNFC#read_uid → int

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

BrickletNFC#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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 here. There is also a constant for the device identifier of this Bricklet.

The returned array has the values uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

BrickletNFC#register_callback(callback_id) { |param [, ...]| block } → nil
Parameters:callback_id -- int

Registers the given block with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the #register_callback function of the device object. The first parameter is the callback ID and the second parameter is a block:

nfc.register_callback BrickletNFC::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

BrickletNFC::CALLBACK_READER_STATE_CHANGED
Parameters:
  • state -- int
  • idle -- bool

This callback is called if the reader state of the NFC Bricklet changes. See #reader_get_state for more information about the possible states.

The following constants are available for this function:

  • BrickletNFC::READER_STATE_INITIALIZATION = 0
  • BrickletNFC::READER_STATE_IDLE = 128
  • BrickletNFC::READER_STATE_ERROR = 192
  • BrickletNFC::READER_STATE_REQUEST_TAG_ID = 2
  • BrickletNFC::READER_STATE_REQUEST_TAG_ID_READY = 130
  • BrickletNFC::READER_STATE_REQUEST_TAG_ID_ERROR = 194
  • BrickletNFC::READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 3
  • BrickletNFC::READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_READY = 131
  • BrickletNFC::READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_ERROR = 195
  • BrickletNFC::READER_STATE_WRITE_PAGE = 4
  • BrickletNFC::READER_STATE_WRITE_PAGE_READY = 132
  • BrickletNFC::READER_STATE_WRITE_PAGE_ERROR = 196
  • BrickletNFC::READER_STATE_REQUEST_PAGE = 5
  • BrickletNFC::READER_STATE_REQUEST_PAGE_READY = 133
  • BrickletNFC::READER_STATE_REQUEST_PAGE_ERROR = 197
  • BrickletNFC::READER_STATE_WRITE_NDEF = 6
  • BrickletNFC::READER_STATE_WRITE_NDEF_READY = 134
  • BrickletNFC::READER_STATE_WRITE_NDEF_ERROR = 198
  • BrickletNFC::READER_STATE_REQUEST_NDEF = 7
  • BrickletNFC::READER_STATE_REQUEST_NDEF_READY = 135
  • BrickletNFC::READER_STATE_REQUEST_NDEF_ERROR = 199
BrickletNFC::CALLBACK_CARDEMU_STATE_CHANGED
Parameters:
  • state -- int
  • idle -- bool

This callback is called if the cardemu state of the NFC Bricklet changes. See #cardemu_get_state for more information about the possible states.

The following constants are available for this function:

  • BrickletNFC::CARDEMU_STATE_INITIALIZATION = 0
  • BrickletNFC::CARDEMU_STATE_IDLE = 128
  • BrickletNFC::CARDEMU_STATE_ERROR = 192
  • BrickletNFC::CARDEMU_STATE_DISCOVER = 2
  • BrickletNFC::CARDEMU_STATE_DISCOVER_READY = 130
  • BrickletNFC::CARDEMU_STATE_DISCOVER_ERROR = 194
  • BrickletNFC::CARDEMU_STATE_TRANSFER_NDEF = 3
  • BrickletNFC::CARDEMU_STATE_TRANSFER_NDEF_READY = 131
  • BrickletNFC::CARDEMU_STATE_TRANSFER_NDEF_ERROR = 195
BrickletNFC::CALLBACK_P2P_STATE_CHANGED
Parameters:
  • state -- int
  • idle -- bool

This callback is called if the P2P state of the NFC Bricklet changes. See #p2p_get_state for more information about the possible states.

The following constants are available for this function:

  • BrickletNFC::P2P_STATE_INITIALIZATION = 0
  • BrickletNFC::P2P_STATE_IDLE = 128
  • BrickletNFC::P2P_STATE_ERROR = 192
  • BrickletNFC::P2P_STATE_DISCOVER = 2
  • BrickletNFC::P2P_STATE_DISCOVER_READY = 130
  • BrickletNFC::P2P_STATE_DISCOVER_ERROR = 194
  • BrickletNFC::P2P_STATE_TRANSFER_NDEF = 3
  • BrickletNFC::P2P_STATE_TRANSFER_NDEF_READY = 131
  • BrickletNFC::P2P_STATE_TRANSFER_NDEF_ERROR = 195

Constants

BrickletNFC::DEVICE_IDENTIFIER

This constant is used to identify a NFC Bricklet.

The #get_identity() function and the ::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletNFC::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a NFC Bricklet.