C# - NFC/RFID Bricklet

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

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

Examples

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

Scan For Tags

Download (ExampleScanForTags.cs)

 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
61
62
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your NFC/RFID Bricklet

    private static byte currentTagType = BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC;

    // Callback function for state changed callback
    static void StateChangedCB(BrickletNFCRFID sender, byte state, bool idle)
    {
        if(state == BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY)
        {
            byte tagType;
            byte tidLength;
            byte[] tid;

            sender.GetTagID(out tagType, out tidLength, out tid);

            if(tidLength == 7)
            {
                Console.WriteLine("Found tag of type {0} with ID " +
                                  "[{1:X} {2:X} {3:X} {4:X} {5:X} {6:X} {7:X}]",
                                  tagType, tid[0], tid[1], tid[2], tid[3], tid[4], tid[5], tid[6]);
            }
            else
            {
                Console.WriteLine("Found tag of type {0} with ID [{1:X} {2:X} {3:X} {4:X}]",
                                  tagType, tid[0], tid[1], tid[2], tid[3]);
            }
        }

        // Cycle through all types
        if(idle)
        {
            currentTagType = (byte)((currentTagType + 1) % 3);
            sender.RequestTagID(currentTagType);
        }
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletNFCRFID nr = new BrickletNFCRFID(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Register state changed callback to function StateChangedCB
        nr.StateChangedCallback += StateChangedCB;

        // Start scan loop
        nr.RequestTagID(BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Write Read Type 2

Download (ExampleWriteReadType2.cs)

 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
61
62
63
64
65
66
67
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your NFC/RFID Bricklet

    // Callback function for state changed callback
    static void StateChangedCB(BrickletNFCRFID sender, byte state, bool idle)
    {
        if(state == BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY)
        {
            Console.WriteLine("Tag found");

            // Write 16 byte to pages 5-8
            byte[] dataWrite = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15};

            sender.WritePage(5, dataWrite);
            Console.WriteLine("Writing data...");
        }
        else if(state == BrickletNFCRFID.STATE_WRITE_PAGE_READY)
        {
            // Request pages 5-8
            sender.RequestPage(5);
            Console.WriteLine("Requesting data...");
        }
        else if(state == BrickletNFCRFID.STATE_REQUEST_PAGE_READY)
        {
            // Get and print pages
            byte[] data = sender.GetPage();
            string str = "" + data[0];

            for(int i = 1; i < data.Length; i++)
            {
                str += " " + data[i];
            }

            Console.Write("Read data: [" + str + "]");
        }
        else if((state & (1 << 6)) == (1 << 6))
        {
            // All errors have bit 6 set
            Console.WriteLine("Error: " + state);
        }
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletNFCRFID nr = new BrickletNFCRFID(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Register state changed callback to function StateChangedCB
        nr.StateChangedCallback += StateChangedCB;

        // Select NFC Forum Type 2 tag
        nr.RequestTagID(BrickletNFCRFID.TAG_TYPE_TYPE2);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

API

Generally, every method of the C# bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since C# does not support multiple return values directly, we use the out keyword to return multiple values from a method.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

All methods listed below are thread-safe.

Basic Functions

class BrickletNFCRFID(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • nfcRFID – Type: BrickletNFCRFID

Creates an object with the unique device ID uid:

BrickletNFCRFID nfcRFID = new BrickletNFCRFID("YOUR_DEVICE_UID", ipcon);

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

void BrickletNFCRFID.RequestTagID(byte tagType)
Parameters:
  • tagType – Type: byte, Range: See constants

To read or write a tag that is in proximity of the NFC/RFID 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 gives an answer to the request.

Currently the following tag types are supported:

  • Mifare Classic
  • NFC Forum Type 1
  • NFC Forum Type 2

After you call RequestTagID() the NFC/RFID 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 StateChangedCallback callback or you can poll GetState() to find out about the state change.

If the state changes to RequestTagIDError it means that either there was no tag present or that the tag is of an incompatible type. If the state changes to RequestTagIDReady it means that a compatible tag was found and that the tag ID could be read out. You can now get the tag ID by calling GetTagID().

If two tags are in the proximity of the NFC/RFID Bricklet, this function will cycle through the tags. To select a specific tag you have to call RequestTagID() until the correct tag id is found.

In case of any Error state the selection is lost and you have to start again by calling RequestTagID().

The following constants are available for this function:

For tagType:

  • BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC = 0
  • BrickletNFCRFID.TAG_TYPE_TYPE1 = 1
  • BrickletNFCRFID.TAG_TYPE_TYPE2 = 2
void BrickletNFCRFID.GetTagID(out byte tagType, out byte tidLength, out byte[] tid)
Output Parameters:
  • tagType – Type: byte, Range: See constants
  • tidLength – Type: byte, Range: [0 to 255]
  • tid – Type: byte[], Length: 7, Range: [0 to 255]

Returns the tag type, tag ID and the length of the tag ID (4 or 7 bytes are possible length). This function can only be called if the NFC/RFID is currently in one of the Ready states. The returned ID is the ID that was saved through the last call of RequestTagID().

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

  1. Call RequestTagID()
  2. Wait for state to change to RequestTagIDReady (see GetState() or StateChangedCallback callback)
  3. Call GetTagID()

The following constants are available for this function:

For tagType:

  • BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC = 0
  • BrickletNFCRFID.TAG_TYPE_TYPE1 = 1
  • BrickletNFCRFID.TAG_TYPE_TYPE2 = 2
void BrickletNFCRFID.GetState(out byte state, out bool idle)
Output Parameters:
  • state – Type: byte, Range: See constants
  • idle – Type: bool

Returns the current state of the NFC/RFID Bricklet.

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

The functions of this Bricklet can be called in the Idle state and all of the Ready and Error states.

Example: If you call RequestPage(), the state will change to RequestPage until the reading of the page is finished. Then it will change to either RequestPageReady if it worked or to RequestPageError if it didn't. If the request worked you can get the page by calling GetPage().

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

The following constants are available for this function:

For state:

  • BrickletNFCRFID.STATE_INITIALIZATION = 0
  • BrickletNFCRFID.STATE_IDLE = 128
  • BrickletNFCRFID.STATE_ERROR = 192
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID = 2
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY = 130
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID_ERROR = 194
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE = 3
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY = 131
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR = 195
  • BrickletNFCRFID.STATE_WRITE_PAGE = 4
  • BrickletNFCRFID.STATE_WRITE_PAGE_READY = 132
  • BrickletNFCRFID.STATE_WRITE_PAGE_ERROR = 196
  • BrickletNFCRFID.STATE_REQUEST_PAGE = 5
  • BrickletNFCRFID.STATE_REQUEST_PAGE_READY = 133
  • BrickletNFCRFID.STATE_REQUEST_PAGE_ERROR = 197
void BrickletNFCRFID.AuthenticateMifareClassicPage(int page, byte keyNumber, byte[] key)
Parameters:
  • page – Type: int, Range: [0 to 216 - 1]
  • keyNumber – Type: byte, Range: See constants
  • key – Type: byte[], Length: 6, Range: [0 to 255]

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 RequestTagID()
  2. Wait for state to change to RequestTagIDReady (see GetState() or StateChangedCallback callback)
  3. If looking for a specific tag then call GetTagID() and check if the expected tag was found, if it was not found go back to step 1
  4. Call AuthenticateMifareClassicPage() with page and key for the page
  5. Wait for state to change to AuthenticatingMifareClassicPageReady (see GetState() or StateChangedCallback callback)
  6. Call RequestPage() or WritePage() to read/write page

The following constants are available for this function:

For keyNumber:

  • BrickletNFCRFID.KEY_A = 0
  • BrickletNFCRFID.KEY_B = 1
void BrickletNFCRFID.WritePage(int page, byte[] data)
Parameters:
  • page – Type: int, Range: [0 to 216 - 1]
  • data – Type: byte[], Length: 16, Range: [0 to 255]

Writes 16 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 (one page is written)
  • NFC Forum Type 1 page size: 8 byte (two pages are written)
  • NFC Forum Type 2 page size: 4 byte (four pages are written)

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

  1. Call RequestTagID()
  2. Wait for state to change to RequestTagIDReady (see GetState() or StateChangedCallback callback)
  3. If looking for a specific tag then call GetTagID() and check if the expected tag was found, if it was not found got back to step 1
  4. Call WritePage() with page number and data
  5. Wait for state to change to WritePageReady (see GetState() or StateChangedCallback callback)

If you use a Mifare Classic tag you have to authenticate a page before you can write to it. See AuthenticateMifareClassicPage().

void BrickletNFCRFID.RequestPage(int page)
Parameters:
  • page – Type: int, Range: [0 to 216 - 1]

Reads 16 bytes starting from the given page and stores them into a buffer. The buffer can then be read out with GetPage(). How many pages are read depends on the tag type. The page sizes are as follows:

  • Mifare Classic page size: 16 byte (one page is read)
  • NFC Forum Type 1 page size: 8 byte (two pages are read)
  • NFC Forum Type 2 page size: 4 byte (four pages are read)

The general approach for reading a tag is as follows:

  1. Call RequestTagID()
  2. Wait for state to change to RequestTagIDReady (see GetState() or StateChangedCallback callback)
  3. If looking for a specific tag then call GetTagID() and check if the expected tag was found, if it was not found got back to step 1
  4. Call RequestPage() with page number
  5. Wait for state to change to RequestPageReady (see GetState() or StateChangedCallback callback)
  6. Call GetPage() 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 AuthenticateMifareClassicPage().

byte[] BrickletNFCRFID.GetPage()
Returns:
  • data – Type: byte[], Length: 16, Range: [0 to 255]

Returns 16 bytes of data from an internal buffer. To fill the buffer with specific pages you have to call RequestPage() beforehand.

Advanced Functions

byte[] BrickletNFCRFID.GetAPIVersion()
Returns:
  • apiVersion – Type: byte[], Length: 3, Range: [0 to 255]

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.

bool BrickletNFCRFID.GetResponseExpected(byte functionId)
Parameters:
  • functionId – Type: byte, Range: See constants
Returns:
  • responseExpected – Type: bool

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 SetResponseExpected(). 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.

The following constants are available for this function:

For functionId:

  • BrickletNFCRFID.FUNCTION_REQUEST_TAG_ID = 1
  • BrickletNFCRFID.FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
  • BrickletNFCRFID.FUNCTION_WRITE_PAGE = 5
  • BrickletNFCRFID.FUNCTION_REQUEST_PAGE = 6
void BrickletNFCRFID.SetResponseExpected(byte functionId, bool responseExpected)
Parameters:
  • functionId – Type: byte, Range: See constants
  • responseExpected – Type: 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 constants are available for this function:

For functionId:

  • BrickletNFCRFID.FUNCTION_REQUEST_TAG_ID = 1
  • BrickletNFCRFID.FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
  • BrickletNFCRFID.FUNCTION_WRITE_PAGE = 5
  • BrickletNFCRFID.FUNCTION_REQUEST_PAGE = 6
void BrickletNFCRFID.SetResponseExpectedAll(bool responseExpected)
Parameters:
  • responseExpected – Type: bool

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

void BrickletNFCRFID.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)
Output Parameters:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: char
  • hardwareVersion – Type: byte[], Length: 3, Range: [0 to 255]
  • firmwareVersion – Type: byte[], Length: 3, Range: [0 to 255]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by appending your callback handler to the corresponding event:

void MyCallback(BrickletNFCRFID sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

nfcRFID.ExampleCallback += MyCallback;

The available events 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.

event BrickletNFCRFID.StateChangedCallback(BrickletNFCRFID sender, byte state, bool idle)
Callback Parameters:
  • sender – Type: BrickletNFCRFID
  • state – Type: byte, Range: See constants
  • idle – Type: bool

This callback is called if the state of the NFC/RFID Bricklet changes. See GetState() for more information about the possible states.

The following constants are available for this function:

For state:

  • BrickletNFCRFID.STATE_INITIALIZATION = 0
  • BrickletNFCRFID.STATE_IDLE = 128
  • BrickletNFCRFID.STATE_ERROR = 192
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID = 2
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY = 130
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID_ERROR = 194
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE = 3
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY = 131
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR = 195
  • BrickletNFCRFID.STATE_WRITE_PAGE = 4
  • BrickletNFCRFID.STATE_WRITE_PAGE_READY = 132
  • BrickletNFCRFID.STATE_WRITE_PAGE_ERROR = 196
  • BrickletNFCRFID.STATE_REQUEST_PAGE = 5
  • BrickletNFCRFID.STATE_REQUEST_PAGE_READY = 133
  • BrickletNFCRFID.STATE_REQUEST_PAGE_ERROR = 197

Constants

int BrickletNFCRFID.DEVICE_IDENTIFIER

This constant is used to identify a NFC/RFID Bricklet.

The GetIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

string BrickletNFCRFID.DEVICE_DISPLAY_NAME

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