C/C++ - NFC Bricklet

Dies ist die Beschreibung der C/C++ API Bindings für das NFC Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des NFC Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_nfc.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your NFC Bricklet
#define NDEF_URI "www.tinkerforge.com"

// Callback function for cardemu state changed callback
void cb_cardemu_state_changed(uint8_t state, bool idle, void *user_data) {
    NFC *nfc = (NFC *)user_data;

    (void)idle; // avoid unused parameter warning

    if(state == NFC_CARDEMU_STATE_IDLE) {
        uint8_t i = 0;
        uint8_t ndef_record_uri[512];
        const char *ptr_ndef_uri = NDEF_URI;

        memset(ndef_record_uri, 0, 512);

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

        while (*ptr_ndef_uri) {
            ndef_record_uri[5 + i] = *ptr_ndef_uri;
            i++;
            ptr_ndef_uri++;
        }

        nfc_cardemu_write_ndef(nfc, ndef_record_uri, strlen(NDEF_URI) + 5);
        nfc_cardemu_start_discovery(nfc);
    }
    else if(state == NFC_CARDEMU_STATE_DISCOVER_READY) {
        nfc_cardemu_start_transfer(nfc, NFC_CARDEMU_TRANSFER_WRITE);
    }
    else if(state == NFC_CARDEMU_STATE_DISCOVER_ERROR) {
        printf("Discover error\n");
    }
    else if(state == NFC_CARDEMU_STATE_TRANSFER_NDEF_ERROR) {
        printf("Transfer NDEF error\n");
    }
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    NFC nfc;
    nfc_create(&nfc, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");

        return 1;
    }
    // Don't use device before ipcon is connected

    // Register cardemu state changed callback to function cb_cardemu_state_changed
    nfc_register_callback(&nfc,
                          NFC_CALLBACK_CARDEMU_STATE_CHANGED,
                          (void (*)(void))cb_cardemu_state_changed,
                          &nfc);

    // Enable cardemu mode
    nfc_set_mode(&nfc, NFC_MODE_CARDEMU);

    printf("Press key to exit\n");
    getchar();
    nfc_destroy(&nfc);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

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
79
80
81
82
83
84
85
86
87
88
89
90
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_nfc.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your NFC Bricklet

// Callback function for reader state changed callback
void cb_reader_state_changed(uint8_t state, bool idle, void *user_data) {
    NFC *nfc = (NFC *)user_data;

    (void)idle; // avoid unused parameter warning

    if(state == NFC_READER_STATE_IDLE) {
        nfc_reader_request_tag_id(nfc);
    }
    else if(state == NFC_READER_STATE_REQUEST_TAG_ID_READY) {
        int ret = 0;
        char tag_byte[8];
        char tag_info[256];
        uint8_t ret_tag_type = 0;
        uint8_t ret_tag_id_length = 0;
        uint8_t *ret_tag_id = (uint8_t *)malloc(32);

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

        if(ret != E_OK) {
            free(ret_tag_id);

            return;
        }

        memset(tag_info, 0, 256);
        sprintf(tag_info, "Found tag of type %d with ID [", ret_tag_type);

        for(uint8_t i = 0; i < ret_tag_id_length; i++) {
            memset(tag_byte, 0, 8);

            if(i < ret_tag_id_length - 1){
                sprintf(tag_byte, "0x%X ", ret_tag_id[i]);
            }
            else {
                sprintf(tag_byte, "0x%X", ret_tag_id[i]);
                strcat(tag_byte, "]");
            }

            strcat(tag_info, tag_byte);
        }

        free(ret_tag_id);
        printf("%s\n", tag_info);
    }
    else if(state == NFC_READER_STATE_REQUEST_TAG_ID_ERROR) {
        printf("Request tag ID error\n");
    }
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    NFC nfc;
    nfc_create(&nfc, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register reader state changed callback to function cb_reader_state_changed
    nfc_register_callback(&nfc,
                          NFC_CALLBACK_READER_STATE_CHANGED,
                          (void (*)(void))cb_reader_state_changed,
                          &nfc);

    // Enable reader mode
    nfc_set_mode(&nfc, NFC_MODE_READER);

    printf("Press key to exit\n");
    getchar();
    nfc_destroy(&nfc);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

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
110
111
112
113
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_nfc.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your NFC Bricklet

// Callback function for reader state changed callback
void cb_reader_state_changed(uint8_t state, bool idle, void *user_data) {
    NFC *nfc = (NFC *)user_data;

    (void)idle; // avoid unused parameter warning

    if(state == NFC_READER_STATE_IDLE) {
        nfc_reader_request_tag_id(nfc);
    }
    else if(state == 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 = (uint8_t *)malloc(32);

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

        if(ret != E_OK) {
            free(ret_tag_id);

            return;
        }

        if(ret_tag_type != NFC_TAG_TYPE_TYPE2) {
            printf("Tag is not type-2\n");
            free(ret_tag_id);

            return;
        }

        printf("Found tag of type %d with ID [0x%X 0x%X 0x%X 0x%X]\n",
               ret_tag_type,
               ret_tag_id[0],
               ret_tag_id[1],
               ret_tag_id[2],
               ret_tag_id[3]);
        free(ret_tag_id);
        nfc_reader_request_page(nfc, 1, 4);
    }
    else if(state == NFC_READER_STATE_REQUEST_TAG_ID_ERROR) {
        printf("Request tag ID error\n");
    }
    else if(state == NFC_READER_STATE_REQUEST_PAGE_READY) {
        int ret = 0;
        uint16_t ret_data_length = 0;
        uint8_t *ret_data = (uint8_t *)malloc(4);

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

        if(ret != E_OK) {
            free(ret_data);

            return;
        }
        printf("Page read: 0x%X 0x%X 0x%X 0x%X\n",
               ret_data[0],
               ret_data[1],
               ret_data[2],
               ret_data[3]);
        nfc_reader_write_page(nfc, 1, ret_data, ret_data_length);
        free(ret_data);
    }
    else if(state == NFC_READER_STATE_WRITE_PAGE_READY) {
        printf("Write page ready\n");
    }
    else if(state == NFC_READER_STATE_REQUEST_PAGE_ERROR) {
        printf("Request page error\n");
    }
    else if(state == NFC_READER_STATE_WRITE_PAGE_ERROR) {
        printf("Write page error\n");
    }
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    NFC nfc;
    nfc_create(&nfc, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register reader state changed callback to function cb_reader_state_changed
    nfc_register_callback(&nfc,
                          NFC_CALLBACK_READER_STATE_CHANGED,
                          (void (*)(void))cb_reader_state_changed,
                          &nfc);

    // Enable reader mode
    nfc_set_mode(&nfc, NFC_MODE_READER);

    printf("Press key to exit\n");
    getchar();
    nfc_destroy(&nfc);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (wird seit Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void nfc_create(NFC *nfc, const char *uid, IPConnection *ipcon)

Erzeugt ein Geräteobjekt nfc mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

NFC nfc;
nfc_create(&nfc, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden wurde (siehe Beispiele oben).

void nfc_destroy(NFC *nfc)

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

int nfc_set_mode(NFC *nfc, uint8_t mode)

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: Ließt und schreibt Tags

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.

Der Standardwert ist "Off".

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

  • NFC_MODE_OFF = 0
  • NFC_MODE_CARDEMU = 1
  • NFC_MODE_P2P = 2
  • NFC_MODE_READER = 3
int nfc_get_mode(NFC *nfc, uint8_t *ret_mode)

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

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

  • NFC_MODE_OFF = 0
  • NFC_MODE_CARDEMU = 1
  • NFC_MODE_P2P = 2
  • NFC_MODE_READER = 3
int nfc_reader_request_tag_id(NFC *nfc)

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

Beim Aufruf von 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 NFC_CALLBACK_READER_STATE_CHANGED Callback zu registrieren oder den Zustand über 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 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 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 nfc_reader_request_tag_id() muss erneut aufgerufen werden.

int nfc_reader_get_tag_id(NFC *nfc, uint8_t *ret_tag_type, uint8_t *ret_tag_id, uint8_t *ret_tag_id_length)

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 nfc_reader_request_tag_id() gefunden wurde.

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

  1. Rufe nfc_reader_request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe nfc_reader_get_state() oder NFC_CALLBACK_READER_STATE_CHANGED Callback)
  3. Rufe nfc_reader_get_tag_id() auf

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

  • NFC_TAG_TYPE_MIFARE_CLASSIC = 0
  • NFC_TAG_TYPE_TYPE1 = 1
  • NFC_TAG_TYPE_TYPE2 = 2
  • NFC_TAG_TYPE_TYPE3 = 3
  • NFC_TAG_TYPE_TYPE4 = 4
int nfc_reader_get_state(NFC *nfc, uint8_t *ret_state, bool *ret_idle)

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 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 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 nfc_reader_read_page() abgerufen werden.

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

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

  • NFC_READER_STATE_INITIALIZATION = 0
  • NFC_READER_STATE_IDLE = 128
  • NFC_READER_STATE_ERROR = 192
  • NFC_READER_STATE_REQUEST_TAG_ID = 2
  • NFC_READER_STATE_REQUEST_TAG_ID_READY = 130
  • NFC_READER_STATE_REQUEST_TAG_ID_ERROR = 194
  • NFC_READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 3
  • NFC_READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_READY = 131
  • NFC_READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_ERROR = 195
  • NFC_READER_STATE_WRITE_PAGE = 4
  • NFC_READER_STATE_WRITE_PAGE_READY = 132
  • NFC_READER_STATE_WRITE_PAGE_ERROR = 196
  • NFC_READER_STATE_REQUEST_PAGE = 5
  • NFC_READER_STATE_REQUEST_PAGE_READY = 133
  • NFC_READER_STATE_REQUEST_PAGE_ERROR = 197
  • NFC_READER_STATE_WRITE_NDEF = 6
  • NFC_READER_STATE_WRITE_NDEF_READY = 134
  • NFC_READER_STATE_WRITE_NDEF_ERROR = 198
  • NFC_READER_STATE_REQUEST_NDEF = 7
  • NFC_READER_STATE_REQUEST_NDEF_READY = 135
  • NFC_READER_STATE_REQUEST_NDEF_ERROR = 199
int nfc_reader_write_ndef(NFC *nfc, uint8_t *ndef, uint16_t ndef_length)

Schreibt bis zu 255 Bytes and NDEF formatierten Daten.

Diese Funktion unterstützt aktuell NFC Forum Type 2 und 4.

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

  1. Rufe nfc_reader_request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe nfc_reader_get_state() oder NFC_CALLBACK_READER_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe 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 nfc_reader_write_ndef() mit der zu schreibenden NDEF Nachricht auf
  5. Warte auf einen Zustandswechsel auf ReaderWriteNDEFReady (siehe nfc_reader_get_state() oder NFC_CALLBACK_READER_STATE_CHANGED Callback)
int nfc_reader_request_ndef(NFC *nfc)

Ließt NDEF formatierten Daten von einem Tag.

Diese Funktion unterstützt aktuell NFC Forum Type 1, 2, 3 und 4.

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

  1. Rufe nfc_reader_request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe nfc_reader_get_state() oder NFC_CALLBACK_READER_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe 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 nfc_reader_request_ndef() auf
  5. Warte auf einen Zustandswechsel auf ReaderRequestNDEFReady (siehe nfc_reader_get_state() oder NFC_CALLBACK_READER_STATE_CHANGED Callback)
  6. Rufe nfc_reader_read_ndef() auf um die gespeicherte NDEF Nachricht abzufragen
int nfc_reader_read_ndef(NFC *nfc, uint8_t *ret_ndef, uint16_t *ret_ndef_length)

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

Der Buffer kann eine Größe von bis zu 8192 Bytes haben.

int nfc_reader_authenticate_mifare_classic_page(NFC *nfc, uint16_t page, uint8_t key_number, uint8_t key[6])

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 nfc_reader_request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe nfc_reader_get_state() oder NFC_CALLBACK_READER_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe 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 nfc_reader_authenticate_mifare_classic_page() mit Page und Schlüssel für die Page auf
  5. Warte auf einen Zustandswechsel auf ReaderAuthenticatingMifareClassicPageReady (siehe nfc_reader_get_state() oder NFC_CALLBACK_READER_STATE_CHANGED Callback)
  6. Rufe nfc_reader_request_page() oder nfc_reader_write_page() zum Lesen/Schreiben einer Page auf

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

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

  • NFC_KEY_A = 0
  • NFC_KEY_B = 1
int nfc_reader_write_page(NFC *nfc, uint16_t page, uint8_t *data, uint16_t data_length)

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)

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

  1. Rufe nfc_reader_request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe nfc_reader_get_state() oder NFC_CALLBACK_READER_STATE_CHANGED callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe 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 nfc_reader_write_page() mit der Page sowie den zu schreibenden Daten auf
  5. Warte auf einen Zustandswechsel auf ReaderWritePageReady (siehe nfc_reader_get_state() oder NFC_CALLBACK_READER_STATE_CHANGED Callback)

Wenn ein Mifare Classic Tag verwendet wird muss die Page authentifiziert werden bevor sie geschrieben werden kann. Siehe 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 Defines sind für diese Funktion verfügbar:

  • NFC_READER_WRITE_TYPE4_CAPABILITY_CONTAINER = 3
  • NFC_READER_WRITE_TYPE4_NDEF = 4
int nfc_reader_request_page(NFC *nfc, uint16_t page, uint16_t length)

Liest maximal 8192 Bytes beginnend von der übergebenen Page und speichert sie in einem Buffer. Dieser Buffer kann mit 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)

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

  1. Rufe nfc_reader_request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe nfc_reader_get_state() oder NFC_CALLBACK_READER_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe 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 nfc_reader_request_page() mit der zu lesenden Page auf
  5. Warte auf einen Zustandswechsel auf ReaderRequestPageReady (siehe nfc_reader_get_state() oder NFC_CALLBACK_READER_STATE_CHANGED Callback)
  6. Rufe 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 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 Defines sind für diese Funktion verfügbar:

  • NFC_READER_REQUEST_TYPE4_CAPABILITY_CONTAINER = 3
  • NFC_READER_REQUEST_TYPE4_NDEF = 4
int nfc_reader_read_page(NFC *nfc, uint8_t *ret_data, uint16_t *ret_data_length)

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

Der Buffer kann eine Größe von bis zu 8192 Bytes haben.

int nfc_cardemu_get_state(NFC *nfc, uint8_t *ret_state, bool *ret_idle)

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 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 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 Defines sind für diese Funktion verfügbar:

  • NFC_CARDEMU_STATE_INITIALIZATION = 0
  • NFC_CARDEMU_STATE_IDLE = 128
  • NFC_CARDEMU_STATE_ERROR = 192
  • NFC_CARDEMU_STATE_DISCOVER = 2
  • NFC_CARDEMU_STATE_DISCOVER_READY = 130
  • NFC_CARDEMU_STATE_DISCOVER_ERROR = 194
  • NFC_CARDEMU_STATE_TRANSFER_NDEF = 3
  • NFC_CARDEMU_STATE_TRANSFER_NDEF_READY = 131
  • NFC_CARDEMU_STATE_TRANSFER_NDEF_ERROR = 195
int nfc_cardemu_start_discovery(NFC *nfc)

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 nfc_cardemu_write_ndef() und nfc_cardemu_start_transfer() übertragen werden.

int nfc_cardemu_write_ndef(NFC *nfc, uint8_t *ndef, uint16_t ndef_length)

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 nfc_cardemu_start_transfer(NFC *nfc, uint8_t transfer)

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 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 Defines sind für diese Funktion verfügbar:

  • NFC_CARDEMU_TRANSFER_ABORT = 0
  • NFC_CARDEMU_TRANSFER_WRITE = 1
int nfc_p2p_get_state(NFC *nfc, uint8_t *ret_state, bool *ret_idle)

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 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 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 Defines sind für diese Funktion verfügbar:

  • NFC_P2P_STATE_INITIALIZATION = 0
  • NFC_P2P_STATE_IDLE = 128
  • NFC_P2P_STATE_ERROR = 192
  • NFC_P2P_STATE_DISCOVER = 2
  • NFC_P2P_STATE_DISCOVER_READY = 130
  • NFC_P2P_STATE_DISCOVER_ERROR = 194
  • NFC_P2P_STATE_TRANSFER_NDEF = 3
  • NFC_P2P_STATE_TRANSFER_NDEF_READY = 131
  • NFC_P2P_STATE_TRANSFER_NDEF_ERROR = 195
int nfc_p2p_start_discovery(NFC *nfc)

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 nfc_p2p_write_ndef() und nfc_p2p_start_transfer() übertragen werden.

int nfc_p2p_write_ndef(NFC *nfc, uint8_t *ndef, uint16_t ndef_length)

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

Die maximale NDEF Nachrichtngröß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 nfc_p2p_start_transfer(NFC *nfc, uint8_t transfer)

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 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 nfc_p2p_read_ndef() ausgelesen werden.

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

  • NFC_P2P_TRANSFER_ABORT = 0
  • NFC_P2P_TRANSFER_WRITE = 1
  • NFC_P2P_TRANSFER_READ = 2
int nfc_p2p_read_ndef(NFC *nfc, uint8_t *ret_ndef, uint16_t *ret_ndef_length)

Gibt die NDEF Nachricht zurück, die von einem NFC Peer im P2P Modus geschrieben wurde. Der maximale NDEF Länge beträgt 8192 Bytes.

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

Fortgeschrittene Funktionen

int nfc_set_detection_led_config(NFC *nfc, uint8_t config)

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 Bootlodermodus befindet ist die LED aus.

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

  • NFC_DETECTION_LED_CONFIG_OFF = 0
  • NFC_DETECTION_LED_CONFIG_ON = 1
  • NFC_DETECTION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • NFC_DETECTION_LED_CONFIG_SHOW_DETECTION = 3
int nfc_get_detection_led_config(NFC *nfc, uint8_t *ret_config)

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

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

  • NFC_DETECTION_LED_CONFIG_OFF = 0
  • NFC_DETECTION_LED_CONFIG_ON = 1
  • NFC_DETECTION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • NFC_DETECTION_LED_CONFIG_SHOW_DETECTION = 3
int nfc_set_maximum_timeout(NFC *nfc, uint16_t timeout)

Setzt das maximale Timeout in ms.

Dies ist das globale Maximum für die internenn 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 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.

Standardwert: 2000ms.

Neu in Version 2.0.1 (Plugin).

int nfc_get_maximum_timeout(NFC *nfc, uint16_t *ret_timeout)

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

Neu in Version 2.0.1 (Plugin).

int nfc_get_api_version(NFC *nfc, uint8_t ret_api_version[3])

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

int nfc_get_response_expected(NFC *nfc, uint8_t function_id, bool *ret_response_expected)

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

Siehe nfc_set_response_expected() für die Liste der verfügbaren Funktions ID Defines für diese Funktion.

int nfc_set_response_expected(NFC *nfc, uint8_t function_id, bool response_expected)

Ä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 Funktions ID Defines sind für diese Funktion verfügbar:

  • NFC_FUNCTION_SET_MODE = 1
  • NFC_FUNCTION_READER_REQUEST_TAG_ID = 3
  • NFC_FUNCTION_READER_WRITE_NDEF = 6
  • NFC_FUNCTION_READER_REQUEST_NDEF = 7
  • NFC_FUNCTION_READER_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 9
  • NFC_FUNCTION_READER_WRITE_PAGE = 10
  • NFC_FUNCTION_READER_REQUEST_PAGE = 11
  • NFC_FUNCTION_CARDEMU_START_DISCOVERY = 15
  • NFC_FUNCTION_CARDEMU_WRITE_NDEF = 16
  • NFC_FUNCTION_CARDEMU_START_TRANSFER = 17
  • NFC_FUNCTION_P2P_START_DISCOVERY = 20
  • NFC_FUNCTION_P2P_WRITE_NDEF = 21
  • NFC_FUNCTION_P2P_START_TRANSFER = 22
  • NFC_FUNCTION_SET_DETECTION_LED_CONFIG = 25
  • NFC_FUNCTION_SET_MAXIMUM_TIMEOUT = 27
  • NFC_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • NFC_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • NFC_FUNCTION_RESET = 243
  • NFC_FUNCTION_WRITE_UID = 248
int nfc_set_response_expected_all(NFC *nfc, bool response_expected)

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

int nfc_get_spitfp_error_count(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)

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 nfc_set_bootloader_mode(NFC *nfc, uint8_t mode, uint8_t *ret_status)

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 Bootlodaer- 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 Defines sind für diese Funktion verfügbar:

  • NFC_BOOTLOADER_MODE_BOOTLOADER = 0
  • NFC_BOOTLOADER_MODE_FIRMWARE = 1
  • NFC_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • NFC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • NFC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • NFC_BOOTLOADER_STATUS_OK = 0
  • NFC_BOOTLOADER_STATUS_INVALID_MODE = 1
  • NFC_BOOTLOADER_STATUS_NO_CHANGE = 2
  • NFC_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • NFC_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • NFC_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int nfc_get_bootloader_mode(NFC *nfc, uint8_t *ret_mode)

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

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

  • NFC_BOOTLOADER_MODE_BOOTLOADER = 0
  • NFC_BOOTLOADER_MODE_FIRMWARE = 1
  • NFC_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • NFC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • NFC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int nfc_set_write_firmware_pointer(NFC *nfc, uint32_t pointer)

Setzt den Firmware-Pointer für 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 nfc_write_firmware(NFC *nfc, uint8_t data[64], uint8_t *ret_status)

Schreibt 64 Bytes Firmware an die Position die vorher von 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 nfc_set_status_led_config(NFC *nfc, uint8_t config)

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 Defines sind für diese Funktion verfügbar:

  • NFC_STATUS_LED_CONFIG_OFF = 0
  • NFC_STATUS_LED_CONFIG_ON = 1
  • NFC_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • NFC_STATUS_LED_CONFIG_SHOW_STATUS = 3
int nfc_get_status_led_config(NFC *nfc, uint8_t *ret_config)

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

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

  • NFC_STATUS_LED_CONFIG_OFF = 0
  • NFC_STATUS_LED_CONFIG_ON = 1
  • NFC_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • NFC_STATUS_LED_CONFIG_SHOW_STATUS = 3
int nfc_get_chip_temperature(NFC *nfc, int16_t *ret_temperature)

Gibt die Temperatur in °C, 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 nfc_reset(NFC *nfc)

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 nfc_write_uid(NFC *nfc, uint32_t uid)

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 nfc_read_uid(NFC *nfc, uint32_t *ret_uid)

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

int nfc_get_identity(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)

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 kann 'a', 'b', 'c' oder 'd' sein.

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

void nfc_register_callback(NFC *nfc, int16_t callback_id, void (*function)(void), void *user_data)

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion nfc_register_callback() durchgeführt werden. Die Parameter bestehen aus dem Geräteobjekt, der Callback ID, der Callback Funktion und optionalen Benutzer Daten:

void my_callback(int p, void *user_data) {
    printf("parameter: %d\n", p);
}

nfc_register_callback(&nfc, NFC_CALLBACK_EXAMPLE, (void *)my_callback, NULL);

Die verfügbaren IDs mit den zugehörigen Callback Funktionssignaturen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

NFC_CALLBACK_READER_STATE_CHANGED
void callback(uint8_t state, bool idle, void *user_data)

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

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

  • NFC_READER_STATE_INITIALIZATION = 0
  • NFC_READER_STATE_IDLE = 128
  • NFC_READER_STATE_ERROR = 192
  • NFC_READER_STATE_REQUEST_TAG_ID = 2
  • NFC_READER_STATE_REQUEST_TAG_ID_READY = 130
  • NFC_READER_STATE_REQUEST_TAG_ID_ERROR = 194
  • NFC_READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 3
  • NFC_READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_READY = 131
  • NFC_READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_ERROR = 195
  • NFC_READER_STATE_WRITE_PAGE = 4
  • NFC_READER_STATE_WRITE_PAGE_READY = 132
  • NFC_READER_STATE_WRITE_PAGE_ERROR = 196
  • NFC_READER_STATE_REQUEST_PAGE = 5
  • NFC_READER_STATE_REQUEST_PAGE_READY = 133
  • NFC_READER_STATE_REQUEST_PAGE_ERROR = 197
  • NFC_READER_STATE_WRITE_NDEF = 6
  • NFC_READER_STATE_WRITE_NDEF_READY = 134
  • NFC_READER_STATE_WRITE_NDEF_ERROR = 198
  • NFC_READER_STATE_REQUEST_NDEF = 7
  • NFC_READER_STATE_REQUEST_NDEF_READY = 135
  • NFC_READER_STATE_REQUEST_NDEF_ERROR = 199
NFC_CALLBACK_CARDEMU_STATE_CHANGED
void callback(uint8_t state, bool idle, void *user_data)

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

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

  • NFC_CARDEMU_STATE_INITIALIZATION = 0
  • NFC_CARDEMU_STATE_IDLE = 128
  • NFC_CARDEMU_STATE_ERROR = 192
  • NFC_CARDEMU_STATE_DISCOVER = 2
  • NFC_CARDEMU_STATE_DISCOVER_READY = 130
  • NFC_CARDEMU_STATE_DISCOVER_ERROR = 194
  • NFC_CARDEMU_STATE_TRANSFER_NDEF = 3
  • NFC_CARDEMU_STATE_TRANSFER_NDEF_READY = 131
  • NFC_CARDEMU_STATE_TRANSFER_NDEF_ERROR = 195
NFC_CALLBACK_P2P_STATE_CHANGED
void callback(uint8_t state, bool idle, void *user_data)

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

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

  • NFC_P2P_STATE_INITIALIZATION = 0
  • NFC_P2P_STATE_IDLE = 128
  • NFC_P2P_STATE_ERROR = 192
  • NFC_P2P_STATE_DISCOVER = 2
  • NFC_P2P_STATE_DISCOVER_READY = 130
  • NFC_P2P_STATE_DISCOVER_ERROR = 194
  • NFC_P2P_STATE_TRANSFER_NDEF = 3
  • NFC_P2P_STATE_TRANSFER_NDEF_READY = 131
  • NFC_P2P_STATE_TRANSFER_NDEF_ERROR = 195

Konstanten

NFC_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein NFC Bricklet zu identifizieren.

Die nfc_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

NFC_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines NFC Bricklet dar.