C/C++ für Mikrocontroller - NFC Bricklet¶

Scan For Tags¶

Download (example_scan_for_tags.c)

 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
68
69
70
71
72
73
74
75
76
77
78

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_nfc.h"
#include "src/bindings/errors.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static uint8_t nfc_state;
static bool nfc_idle;
static bool valid = false;

// Callback function for reader state changed callback
static void reader_state_changed_handler(TF_NFC *device, uint8_t state, bool idle,
                                         void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    nfc_state = state;
    nfc_idle = idle;
    valid = true;
}

static TF_NFC nfc;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_nfc_create(&nfc, NULL, hal), "create device object");

    // Register reader state changed callback to function reader_state_changed_handler
    tf_nfc_register_reader_state_changed_callback(&nfc,
                                                  reader_state_changed_handler,
                                                  NULL);

    // Enable reader mode
    check(tf_nfc_set_mode(&nfc, TF_NFC_MODE_READER), "call set_mode");
}

static int ret = 0;
static uint8_t ret_tag_type = 0;
static uint8_t ret_tag_id_length = 0;
static uint8_t ret_tag_id[32];

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    // Polling with 0 will process one packet at most, so we can't miss a state change.
    tf_hal_callback_tick(hal, 0);
    if (!valid) {
        return;
    }

    valid = false;

    if(nfc_state == TF_NFC_READER_STATE_REQUEST_TAG_ID_READY) {
        ret = tf_nfc_reader_get_tag_id(&nfc, &ret_tag_type, ret_tag_id, &ret_tag_id_length);

        if(ret == TF_E_OK) {
            tf_hal_printf("Found tag of type %I8d with ID [", ret_tag_type);

            for(uint8_t i = 0; i < ret_tag_id_length; i++) {
                tf_hal_printf("%I8X", ret_tag_id[i]);

                if (i < ret_tag_id_length - 1) {
                    tf_hal_printf(" ");
                }
            }

            tf_hal_printf("]\n");
        }
    }

    if(nfc_idle) {
        tf_nfc_reader_request_tag_id(&nfc);
    }
}

Emulate Ndef¶

Download (example_emulate_ndef.c)

 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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include <string.h>
#include <stdio.h>
#include <stdint.h>
#include <stdbool.h>

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_nfc.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static const char *ndef_uri = "www.tinkerforge.com";

static uint8_t nfc_state;
static bool nfc_idle;
static bool valid = false;

// Callback function for cardemu state changed callback
static void cardemu_state_changed_handler(TF_NFC *device, uint8_t state, bool idle,
                                          void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    nfc_state = state;
    nfc_idle = idle;
    valid = true;
}

static TF_NFC nfc;

static char ndef_record_uri[255] = {0};
static uint8_t ndef_record_size = 0;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_nfc_create(&nfc, NULL, hal), "create device object");

    // Register cardemu state changed callback to function cardemu_state_changed_handler
    tf_nfc_register_cardemu_state_changed_callback(&nfc,
                                                   cardemu_state_changed_handler,
                                                   NULL);

    // Enable cardemu mode
    check(tf_nfc_set_mode(&nfc, TF_NFC_MODE_CARDEMU), "call set_mode");

    // Prepare ndef record buffer
    uint8_t header_size = 5;
    uint8_t uri_len = (uint8_t)(strlen(ndef_uri)) + 1; // + 1 for the null terminator
    ndef_record_size = header_size + uri_len;

    // Only short records are supported
    ndef_record_uri[0] = (char) 0xD1;
    ndef_record_uri[1] = 0x01;
    ndef_record_uri[2] = (char) uri_len;
    ndef_record_uri[3] = 'U';
    ndef_record_uri[4] = 0x04;

    snprintf(ndef_record_uri + header_size, 255 - header_size, "%s", ndef_uri);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    // Polling with 0 will process one packet at most, so we can't miss a state change.
    tf_hal_callback_tick(hal, 0);

    if (!valid) {
        return;
    }

    valid = false;

    if(nfc_state == TF_NFC_CARDEMU_STATE_IDLE) {
        tf_nfc_cardemu_write_ndef(&nfc, (uint8_t *)ndef_record_uri, ndef_record_size);
        tf_nfc_cardemu_start_discovery(&nfc);
    }
    else if(nfc_state == TF_NFC_CARDEMU_STATE_DISCOVER_READY) {
        tf_nfc_cardemu_start_transfer(&nfc, TF_NFC_CARDEMU_TRANSFER_WRITE);
    }
    else if(nfc_state == TF_NFC_CARDEMU_STATE_DISCOVER_ERROR) {
        tf_hal_printf("Discover error\n");
    }
    else if(nfc_state == TF_NFC_CARDEMU_STATE_TRANSFER_NDEF_ERROR) {
        tf_hal_printf("Transfer NDEF error\n");
    }
}

Write Read Type2¶

Download (example_write_read_type2.c)

  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
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_nfc.h"
#include "src/bindings/errors.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static uint8_t nfc_state;
static bool nfc_idle;
static bool valid = false;

// Callback function for reader state changed callback
static void reader_state_changed_handler(TF_NFC *device, uint8_t state, bool idle,
                                         void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    nfc_state = state;
    nfc_idle = idle;
    valid = true;
}

static TF_NFC nfc;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_nfc_create(&nfc, NULL, hal), "create device object");

    // Register reader state changed callback to function reader_state_changed_handler
    tf_nfc_register_reader_state_changed_callback(&nfc,
                                                  reader_state_changed_handler,
                                                  NULL);

    // Enable reader mode
    check(tf_nfc_set_mode(&nfc, TF_NFC_MODE_READER), "call set_mode");
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);

    if (!valid) {
        return;
    }

    valid = false;

    if(nfc_state == TF_NFC_READER_STATE_IDLE) {
        tf_nfc_reader_request_tag_id(&nfc);
    }
    else if(nfc_state == TF_NFC_READER_STATE_REQUEST_TAG_ID_READY) {
        int ret = 0;
        uint8_t ret_tag_type = 0;
        uint8_t ret_tag_id_length = 0;
        uint8_t ret_tag_id[32] = {0};

        ret = tf_nfc_reader_get_tag_id(&nfc, &ret_tag_type, ret_tag_id, &ret_tag_id_length);

        if(ret != TF_E_OK) {
            return;
        }

        if(ret_tag_type != TF_NFC_TAG_TYPE_TYPE2) {
            tf_hal_printf("Tag is not type-2\n");
            return;
        }

        tf_hal_printf("Found tag of type %d with ID [0x%I8X 0x%I8X 0x%I8X 0x%I8X]\n",
               ret_tag_type,
               ret_tag_id[0],
               ret_tag_id[1],
               ret_tag_id[2],
               ret_tag_id[3]);
        tf_nfc_reader_request_page(&nfc, 1, 4);
    }
    else if(nfc_state == TF_NFC_READER_STATE_REQUEST_TAG_ID_ERROR) {
        tf_hal_printf("Request tag ID error\n");
    }
    else if(nfc_state == TF_NFC_READER_STATE_REQUEST_PAGE_READY) {
        int ret = 0;
        uint16_t ret_data_length = 0;
        uint8_t ret_data[4] = {0};

        ret = tf_nfc_reader_read_page(&nfc, ret_data, &ret_data_length);

        if(ret != TF_E_OK) {
            return;
        }
        tf_hal_printf("Page read: 0x%I8X 0x%I8X 0x%I8X 0x%I8X\n",
               ret_data[0],
               ret_data[1],
               ret_data[2],
               ret_data[3]);
        tf_nfc_reader_write_page(&nfc, 1, ret_data, ret_data_length);
    }
    else if(nfc_state == TF_NFC_READER_STATE_WRITE_PAGE_READY) {
        tf_hal_printf("Write page ready\n");
    }
    else if(nfc_state == TF_NFC_READER_STATE_REQUEST_PAGE_ERROR) {
        tf_hal_printf("Request page error\n");
    }
    else if(nfc_state == TF_NFC_READER_STATE_WRITE_PAGE_ERROR) {
        tf_hal_printf("Write page error\n");
    }
}

Grundfunktionen¶

int tf_nfc_create(TF_NFC *nfc, const char *uid, TF_HAL *hal)¶

Parameter:	nfc – Typ: TF_NFC * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

Erzeugt ein Geräteobjekt nfc mit der optionalen eindeutigen Geräte ID oder dem Portnamen uid_or_port_name und fügt es dem HAL hal hinzu:

TF_NFC nfc;
tf_nfc_create(&nfc, NULL, &ipcon);

Im Normalfall kann uid_or_port_name auf NULL belassen werden. Für weitere Details siehe Abschnitt UID oder Port-Name.

int tf_nfc_destroy(TF_NFC *nfc)¶

Parameter:	nfc – Typ: TF_NFC *
Rückgabe:	e_code – Typ: int

Entfernt das Geräteobjekt nfc von dessen HAL und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int tf_nfc_set_mode(TF_NFC *nfc, uint8_t mode)¶

Parameter:	nfc – Typ: TF_NFC * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt den Modus. Das NFC Bricklet unterstützt vier Modi:

• Off (Aus)
• Card Emulation (Cardemu): Emuliert einen Tag für andere Reader
• Peer to Peer (P2P): Datenaustausch mit anderen Readern
• Reader: Liest und schreibt Tags
• Simple: Liest automatisch Tag-IDs

Wenn der Modus geändert wird, dann rekonfiguriert das Bricklet die Hardware für den gewählten Modus. Daher können immer nur die dem Modus zugehörigen Funktionen verwendet werden. Es können also im Reader Modus nur die Reader Funktionen verwendet werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

• TF_NFC_MODE_OFF = 0
• TF_NFC_MODE_CARDEMU = 1
• TF_NFC_MODE_P2P = 2
• TF_NFC_MODE_READER = 3
• TF_NFC_MODE_SIMPLE = 4

int tf_nfc_get_mode(TF_NFC *nfc, uint8_t *ret_mode)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Modus zurück, wie von tf_nfc_set_mode() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_mode:

• TF_NFC_MODE_OFF = 0
• TF_NFC_MODE_CARDEMU = 1
• TF_NFC_MODE_P2P = 2
• TF_NFC_MODE_READER = 3
• TF_NFC_MODE_SIMPLE = 4

int tf_nfc_reader_request_tag_id(TF_NFC *nfc)¶

Parameter:	nfc – Typ: TF_NFC *
Rückgabe:	e_code – Typ: int

Um ein Tag welches sich in der nähe des NFC Bricklets befindet zu lesen oder zu schreiben muss zuerst diese Funktion mit dem erwarteten Tag Typ aufgerufen werden. Es ist kein Problem wenn der Typ nicht bekannt ist. Es ist möglich die verfügbaren Tag Typen einfach nacheinander durchzutesten bis das Tag antwortet.

Aktuell werden die folgenden Tag Typen unterstützt:

• Mifare Classic
• NFC Forum Type 1
• NFC Forum Type 2
• NFC Forum Type 3
• NFC Forum Type 4
• NFC Forum Type 5

Beim Aufruf von tf_nfc_reader_request_tag_id() versucht das NFC Bricklet die Tag ID eines Tags auszulesen. Nachdem dieser Prozess beendet ist ändert sich der Zustand des Bricklets. Es ist möglich den Reader State Changed Callback zu registrieren oder den Zustand über tf_nfc_reader_get_state() zu pollen.

Wenn der Zustand auf ReaderRequestTagIDError wechselt ist ein Fehler aufgetreten. Dies bedeutet, dass entweder kein Tag oder kein Tag vom passenden Typ gefunden werden konnte. Wenn der Zustand auf ReaderRequestTagIDReady wechselt ist ein kompatibles Tag gefunden worden und die Tag ID wurde gespeichert. Die Tag ID kann nun über tf_nfc_reader_get_tag_id() ausgelesen werden.

Wenn sich zwei Tags gleichzeitig in der Nähe des NFC Bricklets befinden werden diese nacheinander ausgelesen. Um ein spezifisches Tag zu selektieren muss tf_nfc_reader_request_tag_id() so lange aufgerufen werden bis das korrekte Tag gefunden wurde.

Falls sich das NFC Bricklet in einem der ReaderError Zustände befindet ist die Selektion aufgehoben und tf_nfc_reader_request_tag_id() muss erneut aufgerufen werden.

int tf_nfc_reader_get_tag_id(TF_NFC *nfc, uint8_t *ret_tag_type, uint8_t *ret_tag_id, uint8_t *ret_tag_id_length)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_tag_type – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_tag_id – Typ: uint8_t *, Wertebereich: [0 bis 255] ret_tag_id_length – Typ: uint8_t
Rückgabe:	e_code – Typ: int

Gibt den Tag Typ und die Tag ID zurück. Diese Funktion kann nur aufgerufen werden wenn sich das Bricklet gerade in einem der ReaderReady-Zustände befindet. Die zurückgegebene tag ID ist die letzte tag ID die durch einen Aufruf von tf_nfc_reader_request_tag_id() gefunden wurde.

Der Ansatz um die Tag ID eines Tags zu bekommen sieht wie folgt aus:

1. Rufe tf_nfc_reader_request_tag_id() auf
2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe tf_nfc_reader_get_state() oder Reader State Changed Callback)
3. Rufe tf_nfc_reader_get_tag_id() auf

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_tag_type:

• TF_NFC_TAG_TYPE_MIFARE_CLASSIC = 0
• TF_NFC_TAG_TYPE_TYPE1 = 1
• TF_NFC_TAG_TYPE_TYPE2 = 2
• TF_NFC_TAG_TYPE_TYPE3 = 3
• TF_NFC_TAG_TYPE_TYPE4 = 4
• TF_NFC_TAG_TYPE_TYPE5 = 5

int tf_nfc_reader_get_state(TF_NFC *nfc, uint8_t *ret_state, bool *ret_idle)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_state – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_idle – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Reader Zustand des NFC Bricklets aus.

Während der Startphase ist der Zustand ReaderInitialization. Die Initialisierung dauert etwa 20ms. Danach ändert sich der Zustand zu ReaderIdle.

Das Bricklet wird auch neu initialisiert wenn der Modus geändert wird, siehe tf_nfc_set_mode().

Die Funktionen dieses Bricklets können aufgerufen werden wenn der Zustand entweder ReaderIdle ist oder einer der ReaderReady oder ReaderError-Zustände erreicht wurde.

Beispiel: Wenn tf_nfc_reader_request_page() aufgerufen wird, ändert sich der Zustand zu ReaderRequestPage solange der Leseprozess noch nicht abgeschlossen ist. Danach ändert sich der Zustand zu ReaderRequestPageReady wenn das Lesen funktioniert hat oder zu ReaderRequestPageError wenn nicht. Wenn die Anfrage erfolgreich war kann die Page mit tf_nfc_reader_read_page() abgerufen werden.

Der gleiche Ansatz kann analog für andere API Funktionen verwendet werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_state:

• TF_NFC_READER_STATE_INITIALIZATION = 0
• TF_NFC_READER_STATE_IDLE = 128
• TF_NFC_READER_STATE_ERROR = 192
• TF_NFC_READER_STATE_REQUEST_TAG_ID = 2
• TF_NFC_READER_STATE_REQUEST_TAG_ID_READY = 130
• TF_NFC_READER_STATE_REQUEST_TAG_ID_ERROR = 194
• TF_NFC_READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 3
• TF_NFC_READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_READY = 131
• TF_NFC_READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_ERROR = 195
• TF_NFC_READER_STATE_WRITE_PAGE = 4
• TF_NFC_READER_STATE_WRITE_PAGE_READY = 132
• TF_NFC_READER_STATE_WRITE_PAGE_ERROR = 196
• TF_NFC_READER_STATE_REQUEST_PAGE = 5
• TF_NFC_READER_STATE_REQUEST_PAGE_READY = 133
• TF_NFC_READER_STATE_REQUEST_PAGE_ERROR = 197
• TF_NFC_READER_STATE_WRITE_NDEF = 6
• TF_NFC_READER_STATE_WRITE_NDEF_READY = 134
• TF_NFC_READER_STATE_WRITE_NDEF_ERROR = 198
• TF_NFC_READER_STATE_REQUEST_NDEF = 7
• TF_NFC_READER_STATE_REQUEST_NDEF_READY = 135
• TF_NFC_READER_STATE_REQUEST_NDEF_ERROR = 199

int tf_nfc_reader_write_ndef(TF_NFC *nfc, const uint8_t *ndef, uint16_t ndef_length)¶

Parameter:	nfc – Typ: TF_NFC * ndef – Typ: const uint8_t *, Wertebereich: [0 bis 255] ndef_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Schreibt NDEF formatierte Daten.

Diese Funktion unterstützt aktuell NFC Forum Type 2, 4, 5 und Mifare Classic.

Der Ansatz um eine NDEF Nachricht zu schreiben sieht wie folgt aus:

1. Rufe tf_nfc_reader_request_tag_id() auf
2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe tf_nfc_reader_get_state() oder Reader State Changed Callback)
3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe tf_nfc_reader_get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
4. Rufe tf_nfc_reader_write_ndef() mit der zu schreibenden NDEF Nachricht auf
5. Warte auf einen Zustandswechsel auf ReaderWriteNDEFReady (siehe tf_nfc_reader_get_state() oder Reader State Changed Callback)

int tf_nfc_reader_request_ndef(TF_NFC *nfc)¶

Parameter:	nfc – Typ: TF_NFC *
Rückgabe:	e_code – Typ: int

Liest NDEF formatierten Daten von einem Tag.

Diese Funktion unterstützt aktuell NFC Forum Type 1, 2, 3, 4, 5 and Mifare Classic.

Der Ansatz um eine NDEF Nachricht zu lesen sieht wie folgt aus:

1. Rufe tf_nfc_reader_request_tag_id() auf
2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe tf_nfc_reader_get_state() oder Reader State Changed Callback)
3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe tf_nfc_reader_get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
4. Rufe tf_nfc_reader_request_ndef() auf
5. Warte auf einen Zustandswechsel auf ReaderRequestNDEFReady (siehe tf_nfc_reader_get_state() oder Reader State Changed Callback)
6. Rufe tf_nfc_reader_read_ndef() auf um die gespeicherte NDEF Nachricht abzufragen

int tf_nfc_reader_read_ndef(TF_NFC *nfc, uint8_t *ret_ndef, uint16_t *ret_ndef_length)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_ndef – Typ: uint8_t *, Wertebereich: [0 bis 255] ret_ndef_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Gibt NDEF Daten aus einem internen Buffer zurück. Der Buffer kann zuvor mit einer NDEF Nachricht über einen Aufruf von tf_nfc_reader_request_ndef() gefüllt werden.

int tf_nfc_reader_authenticate_mifare_classic_page(TF_NFC *nfc, uint16_t page, uint8_t key_number, const uint8_t key[6])¶

Parameter:	nfc – Typ: TF_NFC * page – Typ: uint16_t, Wertebereich: [0 bis 216 - 1] key_number – Typ: uint8_t, Wertebereich: Siehe Konstanten key – Typ: const uint8_t[6], Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Mifare Classic Tags nutzen Authentifizierung. Wenn eine Page eines Mifare Classic Tags gelesen oder geschrieben werden soll muss diese zuvor authentifiziert werden. Jede Page kann mit zwei Schlüsseln, A (key_number = 0) und B (key_number = 1), authentifiziert werden. Ein neuer Mifare Classic Tag welches noch nicht beschrieben wurde kann über Schlüssel A mit dem Standardschlüssel [0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF] genutzt werden.

Der Ansatz um eine Mifare Classic Page zu lesen oder zu schreiben sieht wie folgt aus:

1. Rufe tf_nfc_reader_request_tag_id() auf
2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe tf_nfc_reader_get_state() oder Reader State Changed Callback)
3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe tf_nfc_reader_get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
4. Rufe tf_nfc_reader_authenticate_mifare_classic_page() mit Page und Schlüssel für die Page auf
5. Warte auf einen Zustandswechsel auf ReaderAuthenticatingMifareClassicPageReady (siehe tf_nfc_reader_get_state() oder Reader State Changed Callback)
6. Rufe tf_nfc_reader_request_page() oder tf_nfc_reader_write_page() zum Lesen/Schreiben einer Page auf

Die Authentifizierung bezieht sich immer auf einen ganzen Sektor (4 Pages).

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für key_number:

• TF_NFC_KEY_A = 0
• TF_NFC_KEY_B = 1

int tf_nfc_reader_write_page(TF_NFC *nfc, uint16_t page, const uint8_t *data, uint16_t data_length)¶

Parameter:	nfc – Typ: TF_NFC * page – Typ: uint16_t, Wertebereich: Siehe Konstanten data – Typ: const uint8_t *, Wertebereich: [0 bis 255] data_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Schreibt maximal 8192 Bytes beginnend von der übergebenen Page. Wie viele Pages dadurch geschrieben werden hängt vom Typ des Tags ab. Die Pagegrößen verhalten sich wie folgt:

• Mifare Classic Pagegröße: 16 byte
• NFC Forum Type 1 Pagegröße: 8 byte
• NFC Forum Type 2 Pagegröße: 4 byte
• NFC Forum Type 3 Pagegröße: 16 byte
• NFC Forum Type 4: Keine Pages, Page = Dateiwahl (CC oder NDEF, siehe unten)
• NFC Forum Type 5 Pagegröße: 4 byte

Der generelle Ansatz zum Schreiben eines Tags sieht wie folgt aus:

1. Rufe tf_nfc_reader_request_tag_id() auf
2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe tf_nfc_reader_get_state() oder Reader State Changed callback)
3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe tf_nfc_reader_get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
4. Rufe tf_nfc_reader_write_page() mit der Page sowie den zu schreibenden Daten auf
5. Warte auf einen Zustandswechsel auf ReaderWritePageReady (siehe tf_nfc_reader_get_state() oder Reader State Changed Callback)

Wenn ein Mifare Classic Tag verwendet wird muss die Page authentifiziert werden bevor sie geschrieben werden kann. Siehe tf_nfc_reader_authenticate_mifare_classic_page().

NFC Forum Type 4 Tags sind nicht in Pages organisiert sondern Dateien. Wir unterstützten aktuell zwei Dateien: Capability Container (CC) und NDEF.

Setze Page auf 3 um CC zu wählen und auf 4 um NDEF zu wählen.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für page:

• TF_NFC_READER_WRITE_TYPE4_CAPABILITY_CONTAINER = 3
• TF_NFC_READER_WRITE_TYPE4_NDEF = 4

int tf_nfc_reader_request_page(TF_NFC *nfc, uint16_t page, uint16_t length)¶

Parameter:	nfc – Typ: TF_NFC * page – Typ: uint16_t, Wertebereich: Siehe Konstanten length – Typ: uint16_t, Wertebereich: [0 bis 213]
Rückgabe:	e_code – Typ: int

Liest maximal 8192 Bytes beginnend von der übergebenen Page und speichert sie in einem Buffer. Dieser Buffer kann mit tf_nfc_reader_read_page() ausgelesen werden. Wie viele Pages dadurch gelesen werden hängt vom Typ des Tags ab. Die Pagegrößen verhalten sich wie folgt:

• Mifare Classic Pagegröße: 16 byte
• NFC Forum Type 1 Pagegröße: 8 byte
• NFC Forum Type 2 Pagegröße: 4 byte
• NFC Forum Type 3 Pagegröße: 16 byte
• NFC Forum Type 4: Keine Pages, Page = Dateiwahl (CC oder NDEF, siehe unten)
• NFC Forum Type 5 Pagegröße: 4 byte

Der generelle Ansatz zum Lesen eines Tags sieht wie folgt aus:

1. Rufe tf_nfc_reader_request_tag_id() auf
2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe tf_nfc_reader_get_state() oder Reader State Changed Callback)
3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe tf_nfc_reader_get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
4. Rufe tf_nfc_reader_request_page() mit der zu lesenden Page auf
5. Warte auf einen Zustandswechsel auf ReaderRequestPageReady (siehe tf_nfc_reader_get_state() oder Reader State Changed Callback)
6. Rufe tf_nfc_reader_read_page() auf um die gespeicherte Page abzufragen

Wenn ein Mifare Classic Tag verwendet wird muss die Page authentifiziert werden bevor sie gelesen werden kann. Siehe tf_nfc_reader_authenticate_mifare_classic_page().

NFC Forum Type 4 Tags sind nicht in Pages organisiert sondern Dateien. Wir unterstützten aktuell zwei Dateien: Capability Container (CC) und NDEF.

Setze Page auf 3 um CC zu wählen und auf 4 um NDEF zu wählen.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für page:

• TF_NFC_READER_REQUEST_TYPE4_CAPABILITY_CONTAINER = 3
• TF_NFC_READER_REQUEST_TYPE4_NDEF = 4

int tf_nfc_reader_read_page(TF_NFC *nfc, uint8_t *ret_data, uint16_t *ret_data_length)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_data – Typ: uint8_t *, Wertebereich: [0 bis 255] ret_data_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Gibt Daten aus einem internen Buffer zurück. Der Buffer kann zuvor mit spezifischen Pages über einen Aufruf von tf_nfc_reader_request_page() gefüllt werden.

int tf_nfc_cardemu_get_state(TF_NFC *nfc, uint8_t *ret_state, bool *ret_idle)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_state – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_idle – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Cardemu-Zustand des NFC Bricklets aus.

Während der Startphase ist der Zustand CardemuInitialization. Die Initialisierung dauert etwa 20ms. Danach ändert sich der Zustand zu CardmeuIdle.

Das Bricklet wird auch neu initialisiert wenn der Modus geändert wird, siehe tf_nfc_set_mode().

Die Funktionen dieses Bricklets können aufgerufen werden wenn der Zustand entweder CardemuIdle ist oder einer der CardemuReady oder CardemuError-Zustände erreicht wurde.

Beispiel: Wenn tf_nfc_cardemu_start_discovery() aufgerufen wird, änder sich der Zustand zu CardemuDiscover solange der Discover-Prozess noch nicht abgeschlossen ist. Danach ändert sich der Zustand zu CardemuDiscoverReady wenn der Discover-Prozess funktioniert hat oder zu CardemuDiscoverError wenn nicht.

Der gleiche Ansatz kann analog für andere API Funktionen verwendet werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_state:

• TF_NFC_CARDEMU_STATE_INITIALIZATION = 0
• TF_NFC_CARDEMU_STATE_IDLE = 128
• TF_NFC_CARDEMU_STATE_ERROR = 192
• TF_NFC_CARDEMU_STATE_DISCOVER = 2
• TF_NFC_CARDEMU_STATE_DISCOVER_READY = 130
• TF_NFC_CARDEMU_STATE_DISCOVER_ERROR = 194
• TF_NFC_CARDEMU_STATE_TRANSFER_NDEF = 3
• TF_NFC_CARDEMU_STATE_TRANSFER_NDEF_READY = 131
• TF_NFC_CARDEMU_STATE_TRANSFER_NDEF_ERROR = 195

int tf_nfc_cardemu_start_discovery(TF_NFC *nfc)¶

Parameter:	nfc – Typ: TF_NFC *
Rückgabe:	e_code – Typ: int

Startet den Discovery Prozess. Wenn diese Funktion aufgerufen wird während ein NFC Lesegerät sich in Reichweite befindet, dann wechselt der Cardemu Zustand von CardemuDiscovery nach CardemuDiscoveryReady.

Falls kein NFC Lesegerät gefunden werden kann oder während des Discovery Prozesses ein Fehler auftritt dann wechselt der Cardemu Zustand zu CardemuDiscoveryReady. In diesem Fall muss der Discovery Prozess.

Wenn der Cardemu Zustand zu CardemuDiscoveryReady wechselt kann eine NDEF Nachricht mittels tf_nfc_cardemu_write_ndef() und tf_nfc_cardemu_start_transfer() übertragen werden.

int tf_nfc_cardemu_write_ndef(TF_NFC *nfc, const uint8_t *ndef, uint16_t ndef_length)¶

Parameter:	nfc – Typ: TF_NFC * ndef – Typ: const uint8_t *, Wertebereich: [0 bis 255] ndef_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Schreibt eine NDEF Nachricht die an einen NFC Peer übertragen werden soll.

Die maximale NDEF Nachrichtengröße im Cardemu-Modus beträgt 255 Byte.

Diese Funktion kann im Cardemu-Modus jederzeit aufgerufen werden. Der interne Buffer wird nicht überschrieben solange diese Funktion nicht erneut aufgerufen oder der Modus nicht gewechselt wird.

int tf_nfc_cardemu_start_transfer(TF_NFC *nfc, uint8_t transfer)¶

Parameter:	nfc – Typ: TF_NFC * transfer – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Der Transfer einer NDEF Nachricht kann im Cardemu-Zustand CardemuDiscoveryReady gestartet werden.

Bevor ein Schreib-Transfer gestartet werden kann muss zuerst die zu übertragenden NDEF Nachricht mittels tf_nfc_cardemu_write_ndef() geschrieben werden.

Nach einem Aufruf dieser Funktion ändert sich der Cardemu-Zustand zu CardemuTransferNDEF. Danach ändert sich der P2P Zustand zu CardemuTransferNDEFReady wenn der Transfer erfolgreich war oder zu CardemuTransferNDEFError falls nicht.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für transfer:

• TF_NFC_CARDEMU_TRANSFER_ABORT = 0
• TF_NFC_CARDEMU_TRANSFER_WRITE = 1

int tf_nfc_p2p_get_state(TF_NFC *nfc, uint8_t *ret_state, bool *ret_idle)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_state – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_idle – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt den aktuellen P2P-Zustand des NFC Bricklets aus.

Während der Startphase ist der Zustand P2PInitialization. Die Initialisierung dauert etwa 20ms. Danach ändert sich der Zustand zu P2PIdle.

Das Bricklet wird auch neu Initialisiert wenn der Modus geändert wird, siehe tf_nfc_set_mode().

Die Funktionen dieses Bricklets können aufgerufen werden wenn der Zustand entweder P2PIdle ist oder einer der P2PReady oder P2PError-Zustände erreicht wurde.

Beispiel: Wenn tf_nfc_p2p_start_discovery() aufgerufen wird, änder sich der Zustand zu P2PDiscover solange der Discover-Prozess noch nicht abgeschlossen ist. Danach ändert sich der Zustand zu P2PDiscoverReady wenn der Discover-Prozess funktioniert hat oder zu P2PDiscoverError wenn nicht.

Der gleiche Ansatz kann analog für andere API Funktionen verwendet werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_state:

• TF_NFC_P2P_STATE_INITIALIZATION = 0
• TF_NFC_P2P_STATE_IDLE = 128
• TF_NFC_P2P_STATE_ERROR = 192
• TF_NFC_P2P_STATE_DISCOVER = 2
• TF_NFC_P2P_STATE_DISCOVER_READY = 130
• TF_NFC_P2P_STATE_DISCOVER_ERROR = 194
• TF_NFC_P2P_STATE_TRANSFER_NDEF = 3
• TF_NFC_P2P_STATE_TRANSFER_NDEF_READY = 131
• TF_NFC_P2P_STATE_TRANSFER_NDEF_ERROR = 195

int tf_nfc_p2p_start_discovery(TF_NFC *nfc)¶

Parameter:	nfc – Typ: TF_NFC *
Rückgabe:	e_code – Typ: int

Startet den Discovery Prozess. Wenn diese Funktion aufgerufen wird während ein anderes NFC P2P fähiges Gerät sich in Reichweite befindet, dann wechselt der P2P Zustand von P2PDiscovery nach P2PDiscoveryReady.

Falls kein NFC P2P fähiges Gerät gefunden werden kann oder während des Discovery Prozesses ein Fehler auftritt dann wechselt der P2P Zustand zu P2PDiscoveryError. In diesem Fall muss der Discovery Prozess.

Wenn der P2P Zustand zu P2PDiscoveryReady wechselt kann eine NDEF Nachricht mittels tf_nfc_p2p_write_ndef() und tf_nfc_p2p_start_transfer() übertragen werden.

int tf_nfc_p2p_write_ndef(TF_NFC *nfc, const uint8_t *ndef, uint16_t ndef_length)¶

Parameter:	nfc – Typ: TF_NFC * ndef – Typ: const uint8_t *, Wertebereich: [0 bis 255] ndef_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Schreibt eine NDEF Nachricht die an einen NFC Peer übertragen werden soll.

Die maximale NDEF Nachrichtengröße für P2P Übertragungen beträgt 255 Byte.

Diese Funktion kann im P2P-Modus jederzeit aufgerufen werden. Der interne Buffer wird nicht überschrieben solange diese Funktion nicht erneut aufgerufen, der Modus nicht gewechselt oder über P2P eine NDEF Nachricht gelesen wird.

int tf_nfc_p2p_start_transfer(TF_NFC *nfc, uint8_t transfer)¶

Parameter:	nfc – Typ: TF_NFC * transfer – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Der Transfer einer NDEF Nachricht kann im P2P Zustand P2PDiscoveryReady gestartet werden.

Bevor ein Schreib-Transfer gestartet werden kann muss zuerst die zu übertragenden NDEF Nachricht mittels tf_nfc_p2p_write_ndef() geschrieben werden.

Nach einem Aufruf dieser Funktion ändert sich der P2P Zustand zu P2PTransferNDEF. Danach ändert sich der P2P Zustand zu P2PTransferNDEFReady wenn der Transfer erfolgreich war oder zu P2PTransferNDEFError falls nicht.

Ein Schreib-Transfer ist danach abgeschlossen. Bei einem Lese-Transfer kann jetzt die vom NFC Peer geschriebene NDEF Nachricht mittels tf_nfc_p2p_read_ndef() ausgelesen werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für transfer:

• TF_NFC_P2P_TRANSFER_ABORT = 0
• TF_NFC_P2P_TRANSFER_WRITE = 1
• TF_NFC_P2P_TRANSFER_READ = 2

int tf_nfc_p2p_read_ndef(TF_NFC *nfc, uint8_t *ret_ndef, uint16_t *ret_ndef_length)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_ndef – Typ: uint8_t *, Wertebereich: [0 bis 255] ret_ndef_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Gibt die NDEF Nachricht zurück, die von einem NFC Peer im P2P Modus geschrieben wurde.

Die NDEF Nachricht ist bereit sobald sich nach einem tf_nfc_p2p_start_transfer() Aufruf mit einem Lese-Transfer der P2P Zustand zu P2PTransferNDEFReady ändert.

int tf_nfc_simple_get_tag_id(TF_NFC *nfc, uint8_t index, uint8_t *ret_tag_type, uint8_t *ret_tag_id, uint8_t *ret_tag_id_length, uint32_t *ret_last_seen)¶

Parameter:	nfc – Typ: TF_NFC * index – Typ: uint8_t, Wertebereich: [0 bis 7]
Ausgabeparameter:	ret_tag_type – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_tag_id – Typ: uint8_t *, Wertebereich: [0 bis 255] ret_tag_id_length – Typ: uint8_t ret_last_seen – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

Gibt den Tag Typ und die Tag ID des Simple-Mode sortiert nach last_seen für den gegebenen Index zurück.

Bis zu acht Tags werden gespeichert.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_tag_type:

• TF_NFC_TAG_TYPE_MIFARE_CLASSIC = 0
• TF_NFC_TAG_TYPE_TYPE1 = 1
• TF_NFC_TAG_TYPE_TYPE2 = 2
• TF_NFC_TAG_TYPE_TYPE3 = 3
• TF_NFC_TAG_TYPE_TYPE4 = 4
• TF_NFC_TAG_TYPE_TYPE5 = 5

Neu in Version 2.0.6 (Plugin).

int tf_nfc_cardemu_set_tag_id(TF_NFC *nfc, uint8_t tag_id_length, const uint8_t tag_id_data[7])¶

Parameter:	nfc – Typ: TF_NFC * tag_id_length – Typ: uint8_t, Wertebereich: [0 bis 7] tag_id_data – Typ: const uint8_t[7], Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Setzt die Tag ID für den Caremu-Modus. Die Tag ID kann entweder eine Länge von 4 oder von 7 haben.

Wrid die Länge auf 0 gesetzt, nutzt das Bricklet eine zufällige Tag ID (Default).

Neu in Version 2.1.0 (Plugin).

int tf_nfc_cardemu_get_tag_id(TF_NFC *nfc, uint8_t *ret_tag_id_length, uint8_t ret_tag_id_data[7])¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_tag_id_length – Typ: uint8_t, Wertebereich: [0 bis 7] ret_tag_id_data – Typ: uint8_t[7], Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Gibt die Tag ID und Länge zurück, wie von tf_nfc_cardemu_set_tag_id() gesetzt.

Neu in Version 2.1.0 (Plugin).

Fortgeschrittene Funktionen¶

int tf_nfc_set_detection_led_config(TF_NFC *nfc, uint8_t config)¶

Parameter:	nfc – Typ: TF_NFC * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig zeigt die LED ob eine Karte/ein Lesegerät detektiert wurde.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

• TF_NFC_DETECTION_LED_CONFIG_OFF = 0
• TF_NFC_DETECTION_LED_CONFIG_ON = 1
• TF_NFC_DETECTION_LED_CONFIG_SHOW_HEARTBEAT = 2
• TF_NFC_DETECTION_LED_CONFIG_SHOW_DETECTION = 3

int tf_nfc_get_detection_led_config(TF_NFC *nfc, uint8_t *ret_config)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Konfiguration zurück, wie von tf_nfc_set_detection_led_config() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_config:

• TF_NFC_DETECTION_LED_CONFIG_OFF = 0
• TF_NFC_DETECTION_LED_CONFIG_ON = 1
• TF_NFC_DETECTION_LED_CONFIG_SHOW_HEARTBEAT = 2
• TF_NFC_DETECTION_LED_CONFIG_SHOW_DETECTION = 3

int tf_nfc_set_maximum_timeout(TF_NFC *nfc, uint16_t timeout)¶

Parameter:	nfc – Typ: TF_NFC * timeout – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 2000
Rückgabe:	e_code – Typ: int

Setzt den maximalen Timeout.

Dies ist das globale Maximum für die internen State-Timeouts. Der korrekte Timeout hängt vom verwendeten Tag Typ ab. Zum Beispiel: Wenn ein Typ 2 Tag verwendet wird und herausgefunden werden soll ob der Tag in Reichweite des Bricklets ist, muss tf_nfc_reader_request_tag_id() aufgerufen werden. Der State wechselt dann entweder auf Ready oder Error (Tag gefunden/nicht gefunden).

Mit den Standardeinstellungen dauert dies ca. 2-3 Sekunden. Wenn man das maximale Timeout auf 100ms setzt reduziert sich diese zeit auf ~150-200ms. Für Typ 2 funktioniert das auch noch mit einem Timeout von 20ms (Ein Typ 2 Tag antwortet für gewöhnlich innerhalb von 10ms). Ein Typ 4 Tag benötigte bis zu 500ms in unsren Tests.

Wenn eine schnelle reaktionszeit benötigt wird, kann das Timeout entsprechend verrigert werden einen guten Wert kann man per Trial-and-Error für einen spezfiischen Tag-Typ ermitteln.

Standardmäßig nutzen wir einen sehr konservativen Timeout um sicher zu stellen das alle Tags definitiv funktionieren.

Neu in Version 2.0.1 (Plugin).

int tf_nfc_get_maximum_timeout(TF_NFC *nfc, uint16_t *ret_timeout)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_timeout – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 2000
Rückgabe:	e_code – Typ: int

Gibt das Timeout zurück, wie von tf_nfc_set_maximum_timeout() gesetzt.

Neu in Version 2.0.1 (Plugin).

int tf_nfc_get_spitfp_error_count(TF_NFC *nfc, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 232 - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

• ACK-Checksummen Fehler,
• Message-Checksummen Fehler,
• Framing Fehler und
• Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

int tf_nfc_set_status_led_config(TF_NFC *nfc, uint8_t config)¶

Parameter:	nfc – Typ: TF_NFC * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

• TF_NFC_STATUS_LED_CONFIG_OFF = 0
• TF_NFC_STATUS_LED_CONFIG_ON = 1
• TF_NFC_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• TF_NFC_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_nfc_get_status_led_config(TF_NFC *nfc, uint8_t *ret_config)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Konfiguration zurück, wie von tf_nfc_set_status_led_config() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_config:

• TF_NFC_STATUS_LED_CONFIG_OFF = 0
• TF_NFC_STATUS_LED_CONFIG_ON = 1
• TF_NFC_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• TF_NFC_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_nfc_get_chip_temperature(TF_NFC *nfc, int16_t *ret_temperature)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
Rückgabe:	e_code – Typ: int

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

int tf_nfc_reset(TF_NFC *nfc)¶

Parameter:	nfc – Typ: TF_NFC *
Rückgabe:	e_code – Typ: int

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

int tf_nfc_get_identity(TF_NFC *nfc, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] ret_hardware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_firmware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:	e_code – Typ: int

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_nfc_register_*_callback Funktion durchgeführt werden. Die user_data, sowie das Gerät, dass das Callback ausgelöst hat, werden dem registrierten Callback-Handler übergeben.

Nur ein Handler kann gleichzeitig auf das selbe Callback registriert werden. Um einen Handler zu deregistrieren, kann die tf_nfc_register_*_callback-Funktion mit NULL als Handler aufgerufen werden.

int tf_nfc_register_reader_state_changed_callback(TF_NFC *nfc, TF_NFC_ReaderStateChangedHandler handler, void *user_data)¶

void handler(TF_NFC *nfc, uint8_t state, bool idle, void *user_data)

Callback-Parameter:	nfc – Typ: TF_NFC * state – Typ: uint8_t, Wertebereich: Siehe Konstanten idle – Typ: bool user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Reader-Zustand des NFC Bricklets sich verändert. Siehe tf_nfc_reader_get_state() für mehr Informationen über die möglichen Zustände des Bricklets.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für state:

• TF_NFC_READER_STATE_INITIALIZATION = 0
• TF_NFC_READER_STATE_IDLE = 128
• TF_NFC_READER_STATE_ERROR = 192
• TF_NFC_READER_STATE_REQUEST_TAG_ID = 2
• TF_NFC_READER_STATE_REQUEST_TAG_ID_READY = 130
• TF_NFC_READER_STATE_REQUEST_TAG_ID_ERROR = 194
• TF_NFC_READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 3
• TF_NFC_READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_READY = 131
• TF_NFC_READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_ERROR = 195
• TF_NFC_READER_STATE_WRITE_PAGE = 4
• TF_NFC_READER_STATE_WRITE_PAGE_READY = 132
• TF_NFC_READER_STATE_WRITE_PAGE_ERROR = 196
• TF_NFC_READER_STATE_REQUEST_PAGE = 5
• TF_NFC_READER_STATE_REQUEST_PAGE_READY = 133
• TF_NFC_READER_STATE_REQUEST_PAGE_ERROR = 197
• TF_NFC_READER_STATE_WRITE_NDEF = 6
• TF_NFC_READER_STATE_WRITE_NDEF_READY = 134
• TF_NFC_READER_STATE_WRITE_NDEF_ERROR = 198
• TF_NFC_READER_STATE_REQUEST_NDEF = 7
• TF_NFC_READER_STATE_REQUEST_NDEF_READY = 135
• TF_NFC_READER_STATE_REQUEST_NDEF_ERROR = 199

int tf_nfc_register_cardemu_state_changed_callback(TF_NFC *nfc, TF_NFC_CardemuStateChangedHandler handler, void *user_data)¶

void handler(TF_NFC *nfc, uint8_t state, bool idle, void *user_data)

Callback-Parameter:	nfc – Typ: TF_NFC * state – Typ: uint8_t, Wertebereich: Siehe Konstanten idle – Typ: bool user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Cardemu-Zustand des NFC Bricklets sich verändert. Siehe tf_nfc_cardemu_get_state() für mehr Informationen über die möglichen Zustände des Bricklets.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für state:

• TF_NFC_CARDEMU_STATE_INITIALIZATION = 0
• TF_NFC_CARDEMU_STATE_IDLE = 128
• TF_NFC_CARDEMU_STATE_ERROR = 192
• TF_NFC_CARDEMU_STATE_DISCOVER = 2
• TF_NFC_CARDEMU_STATE_DISCOVER_READY = 130
• TF_NFC_CARDEMU_STATE_DISCOVER_ERROR = 194
• TF_NFC_CARDEMU_STATE_TRANSFER_NDEF = 3
• TF_NFC_CARDEMU_STATE_TRANSFER_NDEF_READY = 131
• TF_NFC_CARDEMU_STATE_TRANSFER_NDEF_ERROR = 195

int tf_nfc_register_p2p_state_changed_callback(TF_NFC *nfc, TF_NFC_P2PStateChangedHandler handler, void *user_data)¶

void handler(TF_NFC *nfc, uint8_t state, bool idle, void *user_data)

Callback-Parameter:	nfc – Typ: TF_NFC * state – Typ: uint8_t, Wertebereich: Siehe Konstanten idle – Typ: bool user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der P2P-Zustand des NFC Bricklets sich verändert. Siehe tf_nfc_p2p_get_state() für mehr Informationen über die möglichen Zustände des Bricklets.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für state:

• TF_NFC_P2P_STATE_INITIALIZATION = 0
• TF_NFC_P2P_STATE_IDLE = 128
• TF_NFC_P2P_STATE_ERROR = 192
• TF_NFC_P2P_STATE_DISCOVER = 2
• TF_NFC_P2P_STATE_DISCOVER_READY = 130
• TF_NFC_P2P_STATE_DISCOVER_ERROR = 194
• TF_NFC_P2P_STATE_TRANSFER_NDEF = 3
• TF_NFC_P2P_STATE_TRANSFER_NDEF_READY = 131
• TF_NFC_P2P_STATE_TRANSFER_NDEF_ERROR = 195

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt.

int tf_nfc_get_response_expected(TF_NFC *nfc, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	nfc – Typ: TF_NFC * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels tf_nfc_set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

• TF_NFC_FUNCTION_SET_MODE = 1
• TF_NFC_FUNCTION_READER_REQUEST_TAG_ID = 3
• TF_NFC_FUNCTION_READER_WRITE_NDEF = 6
• TF_NFC_FUNCTION_READER_REQUEST_NDEF = 7
• TF_NFC_FUNCTION_READER_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 9
• TF_NFC_FUNCTION_READER_WRITE_PAGE = 10
• TF_NFC_FUNCTION_READER_REQUEST_PAGE = 11
• TF_NFC_FUNCTION_CARDEMU_START_DISCOVERY = 15
• TF_NFC_FUNCTION_CARDEMU_WRITE_NDEF = 16
• TF_NFC_FUNCTION_CARDEMU_START_TRANSFER = 17
• TF_NFC_FUNCTION_P2P_START_DISCOVERY = 20
• TF_NFC_FUNCTION_P2P_WRITE_NDEF = 21
• TF_NFC_FUNCTION_P2P_START_TRANSFER = 22
• TF_NFC_FUNCTION_SET_DETECTION_LED_CONFIG = 25
• TF_NFC_FUNCTION_SET_MAXIMUM_TIMEOUT = 27
• TF_NFC_FUNCTION_CARDEMU_SET_TAG_ID = 30
• TF_NFC_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• TF_NFC_FUNCTION_SET_STATUS_LED_CONFIG = 239
• TF_NFC_FUNCTION_RESET = 243
• TF_NFC_FUNCTION_WRITE_UID = 248

int tf_nfc_set_response_expected(TF_NFC *nfc, uint8_t function_id, bool response_expected)¶

Parameter:	nfc – Typ: TF_NFC * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

• TF_NFC_FUNCTION_SET_MODE = 1
• TF_NFC_FUNCTION_READER_REQUEST_TAG_ID = 3
• TF_NFC_FUNCTION_READER_WRITE_NDEF = 6
• TF_NFC_FUNCTION_READER_REQUEST_NDEF = 7
• TF_NFC_FUNCTION_READER_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 9
• TF_NFC_FUNCTION_READER_WRITE_PAGE = 10
• TF_NFC_FUNCTION_READER_REQUEST_PAGE = 11
• TF_NFC_FUNCTION_CARDEMU_START_DISCOVERY = 15
• TF_NFC_FUNCTION_CARDEMU_WRITE_NDEF = 16
• TF_NFC_FUNCTION_CARDEMU_START_TRANSFER = 17
• TF_NFC_FUNCTION_P2P_START_DISCOVERY = 20
• TF_NFC_FUNCTION_P2P_WRITE_NDEF = 21
• TF_NFC_FUNCTION_P2P_START_TRANSFER = 22
• TF_NFC_FUNCTION_SET_DETECTION_LED_CONFIG = 25
• TF_NFC_FUNCTION_SET_MAXIMUM_TIMEOUT = 27
• TF_NFC_FUNCTION_CARDEMU_SET_TAG_ID = 30
• TF_NFC_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• TF_NFC_FUNCTION_SET_STATUS_LED_CONFIG = 239
• TF_NFC_FUNCTION_RESET = 243
• TF_NFC_FUNCTION_WRITE_UID = 248

int tf_nfc_set_response_expected_all(TF_NFC *nfc, bool response_expected)¶

Parameter:	nfc – Typ: TF_NFC * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int tf_nfc_set_bootloader_mode(TF_NFC *nfc, uint8_t mode, uint8_t *ret_status)¶

Parameter:	nfc – Typ: TF_NFC * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

• TF_NFC_BOOTLOADER_MODE_BOOTLOADER = 0
• TF_NFC_BOOTLOADER_MODE_FIRMWARE = 1
• TF_NFC_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• TF_NFC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• TF_NFC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

• TF_NFC_BOOTLOADER_STATUS_OK = 0
• TF_NFC_BOOTLOADER_STATUS_INVALID_MODE = 1
• TF_NFC_BOOTLOADER_STATUS_NO_CHANGE = 2
• TF_NFC_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• TF_NFC_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• TF_NFC_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_nfc_get_bootloader_mode(TF_NFC *nfc, uint8_t *ret_mode)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Bootloader-Modus zurück, siehe tf_nfc_set_bootloader_mode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_mode:

• TF_NFC_BOOTLOADER_MODE_BOOTLOADER = 0
• TF_NFC_BOOTLOADER_MODE_FIRMWARE = 1
• TF_NFC_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• TF_NFC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• TF_NFC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_nfc_set_write_firmware_pointer(TF_NFC *nfc, uint32_t pointer)¶

Parameter:	nfc – Typ: TF_NFC * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für tf_nfc_write_firmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int tf_nfc_write_firmware(TF_NFC *nfc, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	nfc – Typ: TF_NFC * data – Typ: const uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von tf_nfc_set_write_firmware_pointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int tf_nfc_write_uid(TF_NFC *nfc, uint32_t uid)¶

Parameter:	nfc – Typ: TF_NFC * uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

int tf_nfc_read_uid(TF_NFC *nfc, uint32_t *ret_uid)¶

Parameter:	nfc – Typ: TF_NFC *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

TF_NFC_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein NFC Bricklet zu identifizieren.

Die Funktionen tf_nfc_get_identity() und tf_hal_get_device_info() haben einen device_identifier Ausgabe-Parameter um den Typ des Bricks oder Bricklets anzugeben.

TF_NFC_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines NFC Bricklet dar.