C/C++ - NFC/RFID Bricklet

Dies ist die Beschreibung der C/C++ API Bindings für das NFC/RFID Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des NFC/RFID 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).

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

#include "ip_connection.h"
#include "bricklet_nfc_rfid.h"

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

uint8_t current_tag_type = NFC_RFID_TAG_TYPE_MIFARE_CLASSIC;

// Callback function for state changed callback
void cb_state_changed(uint8_t state, bool idle, void *user_data) {
    NFCRFID *nr = (NFCRFID *)user_data;

    if(state == NFC_RFID_STATE_REQUEST_TAG_ID_READY) {
        uint8_t tag_type;
        uint8_t tid_length;
        uint8_t tid[7];

        nfc_rfid_get_tag_id(nr, &tag_type, &tid_length, tid);

        if(tid_length == 4) {
            printf("Found tag of type %d with ID [%x %x %x %x]\n", 
                   tag_type, tid[0], tid[1], tid[2], tid[3]);
        } else {
            printf("Found tag of type %d with ID [%x %x %x %x %x %x %x]\n", 
                   tag_type, tid[0], tid[1], tid[2], tid[3], tid[4], tid[5], tid[6]);
        }
    }

    // Cycle through all types
    if(idle) {
        current_tag_type = (current_tag_type + 1) % 3;

        nfc_rfid_request_tag_id(nr, current_tag_type);
    }
}

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

    // Create device object
    NFCRFID nr;
    nfc_rfid_create(&nr, 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 state changed callback to function cb_state_changed
    nfc_rfid_register_callback(&nr,
                               NFC_RFID_CALLBACK_STATE_CHANGED,
                               (void (*)(void))cb_state_changed,
                               &nr);

    // Start scan loop
    nfc_rfid_request_tag_id(&nr, NFC_RFID_TAG_TYPE_MIFARE_CLASSIC);

    printf("Press key to exit\n");
    getchar();
    nfc_rfid_destroy(&nr);
    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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_nfc_rfid.h"

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

// Callback function for state changed callback
void cb_state_changed(uint8_t state, bool idle, void *user_data) {
    NFCRFID *nr = (NFCRFID *)user_data;

    (void)idle; // avoid unused parameter warning

    if(state == NFC_RFID_STATE_REQUEST_TAG_ID_READY) {
        printf("Tag found\n");

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

        nfc_rfid_write_page(nr, 5, data_write);

        printf("Writing data...\n");
    } else if(state == NFC_RFID_STATE_WRITE_PAGE_READY) {
        // Request pages 5-8
        nfc_rfid_request_page(nr, 5);

        printf("Requesting data...\n");
    } else if(state == NFC_RFID_STATE_REQUEST_PAGE_READY) {
        uint8_t data_read[16];

        // Get and print pages 5-8
        nfc_rfid_get_page(nr, data_read);
        printf("Read data: [%d", data_read[0]);

        int i;
        for(i = 1; i < 16; i++) {
            printf(" %d", data_read[i]);
        }

        printf("]\n");
    } else if(state & (1 << 6)) {
        // All errors have bit 6 set
        printf("Error: %d\n", state);
    }
}

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

    // Create device object
    NFCRFID nr;
    nfc_rfid_create(&nr, 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 state changed callback to function cb_state_changed
    nfc_rfid_register_callback(&nr,
                               NFC_RFID_CALLBACK_STATE_CHANGED,
                               (void (*)(void))cb_state_changed,
                               &nr);

    // Select NFC Forum Type 2 tag
    nfc_rfid_request_tag_id(&nr, NFC_RFID_TAG_TYPE_TYPE2);

    printf("Press key to exit\n");
    getchar();
    nfc_rfid_destroy(&nr);
    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 C/C++ 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
  • E_NON_ASCII_CHAR_IN_SECRET = -14

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void nfc_rfid_create(NFCRFID *nfc_rfid, const char *uid, IPConnection *ipcon)
Parameter:
  • nfc_rfid – Typ: NFCRFID *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

NFCRFID nfc_rfid;
nfc_rfid_create(&nfc_rfid, "YOUR_DEVICE_UID", &ipcon);

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

void nfc_rfid_destroy(NFCRFID *nfc_rfid)
Parameter:
  • nfc_rfid – Typ: NFCRFID *

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

int nfc_rfid_request_tag_id(NFCRFID *nfc_rfid, uint8_t tag_type)
Parameter:
  • nfc_rfid – Typ: NFCRFID *
  • tag_type – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

Um ein Tag welches sich in der nähe des NFC/RFID 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 verü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

Beim Aufruf von nfc_rfid_request_tag_id() probiert das NFC/RFID Bricklet die Tag ID eines Tags auszulesen. Nachdem dieser Prozess beendet ist ändert sich der Zustand des Bricklets. Es ist möglich den NFC_RFID_CALLBACK_STATE_CHANGED Callback zu registrieren oder den Zustand über nfc_rfid_get_state() zu pollen.

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

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

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

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

Für tag_type:

  • NFC_RFID_TAG_TYPE_MIFARE_CLASSIC = 0
  • NFC_RFID_TAG_TYPE_TYPE1 = 1
  • NFC_RFID_TAG_TYPE_TYPE2 = 2
int nfc_rfid_get_tag_id(NFCRFID *nfc_rfid, uint8_t *ret_tag_type, uint8_t *ret_tid_length, uint8_t ret_tid[7])
Parameter:
  • nfc_rfid – Typ: NFCRFID *
Ausgabeparameter:
  • ret_tag_type – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • ret_tid_length – Typ: uint8_t, Wertebereich: [4, 7]
  • ret_tid – Typ: uint8_t[7], Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt den Tag Typ, die Tag ID und die Länge der Tag ID (4 oder 7 Byte möglich) zurück. Diese Funktion kann nur aufgerufen werden wenn sich das Bricklet gerade in einem der Ready-Zustände befindet. Die zurückgegebene ID ist die letzte ID die durch einen Aufruf von nfc_rfid_request_tag_id() gefunden wurde.

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

  1. Rufe nfc_rfid_request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe nfc_rfid_get_state() oder NFC_RFID_CALLBACK_STATE_CHANGED Callback)
  3. Rufe nfc_rfid_get_tag_id() auf

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

Für ret_tag_type:

  • NFC_RFID_TAG_TYPE_MIFARE_CLASSIC = 0
  • NFC_RFID_TAG_TYPE_TYPE1 = 1
  • NFC_RFID_TAG_TYPE_TYPE2 = 2
int nfc_rfid_get_state(NFCRFID *nfc_rfid, uint8_t *ret_state, bool *ret_idle)
Parameter:
  • nfc_rfid – Typ: NFCRFID *
Ausgabeparameter:
  • ret_state – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • ret_idle – Typ: bool
Rückgabe:
  • error_code – Typ: int

Gibt den aktuellen Zustand des NFC/RFID Bricklets aus.

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

Die Funktionen dieses Bricklets können aufgerufen werden wenn der Zustand entweder Idle ist oder einer der Ready oder Error-Zustände erreicht wurde.

Beispiel: Wenn nfc_rfid_request_page() aufgerufen wird, änder sich der Zustand zu RequestPage solange der Leseprozess noch nicht abgeschlossen ist. Danach ändert sich der Zustand zu RequestPageReady wenn das lesen funktioniert hat oder zu RequestPageError wenn nicht. Wenn die Anfrage erfolgreich war kann die Page mit nfc_rfid_get_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:

  • NFC_RFID_STATE_INITIALIZATION = 0
  • NFC_RFID_STATE_IDLE = 128
  • NFC_RFID_STATE_ERROR = 192
  • NFC_RFID_STATE_REQUEST_TAG_ID = 2
  • NFC_RFID_STATE_REQUEST_TAG_ID_READY = 130
  • NFC_RFID_STATE_REQUEST_TAG_ID_ERROR = 194
  • NFC_RFID_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE = 3
  • NFC_RFID_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY = 131
  • NFC_RFID_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR = 195
  • NFC_RFID_STATE_WRITE_PAGE = 4
  • NFC_RFID_STATE_WRITE_PAGE_READY = 132
  • NFC_RFID_STATE_WRITE_PAGE_ERROR = 196
  • NFC_RFID_STATE_REQUEST_PAGE = 5
  • NFC_RFID_STATE_REQUEST_PAGE_READY = 133
  • NFC_RFID_STATE_REQUEST_PAGE_ERROR = 197
int nfc_rfid_authenticate_mifare_classic_page(NFCRFID *nfc_rfid, uint16_t page, uint8_t key_number, uint8_t key[6])
Parameter:
  • nfc_rfid – Typ: NFCRFID *
  • page – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • key_number – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • key – Typ: uint8_t[6], Wertebereich: [0 bis 255]
Rückgabe:
  • error_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 neues 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_rfid_request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe nfc_rfid_get_state() oder NFC_RFID_CALLBACK_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe nfc_rfid_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_rfid_authenticate_mifare_classic_page() mit Page und Schlüssel für die Page auf
  5. Warte auf einen Zustandswechsel auf AuthenticatingMifareClassicPageReady (siehe nfc_rfid_get_state() oder NFC_RFID_CALLBACK_STATE_CHANGED Callback)
  6. Rufe nfc_rfid_request_page() oder nfc_rfid_write_page() zum Lesen/Schreiben einer Page auf

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

Für key_number:

  • NFC_RFID_KEY_A = 0
  • NFC_RFID_KEY_B = 1
int nfc_rfid_write_page(NFCRFID *nfc_rfid, uint16_t page, uint8_t data[16])
Parameter:
  • nfc_rfid – Typ: NFCRFID *
  • page – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • data – Typ: uint8_t[16], Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Schreibt 16 Bytes startend 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 (eine Page wird geschrieben)
  • NFC Forum Type 1 Pagegröße: 8 byte (zwei Pages werden geschrieben)
  • NFC Forum Type 2 Pagegröße: 4 byte (vier Pages werden geschrieben)

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

  1. Rufe nfc_rfid_request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe nfc_rfid_get_state() oder NFC_RFID_CALLBACK_STATE_CHANGED callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe nfc_rfid_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_rfid_write_page() mit der Page sowie den zu schreibenden Daten auf
  5. Warte auf einen Zustandswechsel auf WritePageReady (siehe nfc_rfid_get_state() oder NFC_RFID_CALLBACK_STATE_CHANGED Callback)

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

int nfc_rfid_request_page(NFCRFID *nfc_rfid, uint16_t page)
Parameter:
  • nfc_rfid – Typ: NFCRFID *
  • page – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Liest 16 Bytes startend von der übergebenen Page und speichert sie in einem Buffer. Dieser Buffer kann mit nfc_rfid_get_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 (eine Page wird gelesen)
  • NFC Forum Type 1 Pagegröße: 8 byte (zwei Pages werden gelesen)
  • NFC Forum Type 2 Pagegröße: 4 byte (vier Pages werden gelesen)

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

  1. Rufe nfc_rfid_request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe nfc_rfid_get_state() oder NFC_RFID_CALLBACK_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe nfc_rfid_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_rfid_request_page() mit der zu lesenden Page auf
  5. Warte auf einen Zustandswechsel auf RequestPageReady (siehe nfc_rfid_get_state() oder NFC_RFID_CALLBACK_STATE_CHANGED Callback)
  6. Rufe nfc_rfid_get_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_rfid_authenticate_mifare_classic_page().

int nfc_rfid_get_page(NFCRFID *nfc_rfid, uint8_t ret_data[16])
Parameter:
  • nfc_rfid – Typ: NFCRFID *
Ausgabeparameter:
  • ret_data – Typ: uint8_t[16], Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

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

Fortgeschrittene Funktionen

int nfc_rfid_get_identity(NFCRFID *nfc_rfid, 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_rfid – Typ: NFCRFID *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', '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:
  • error_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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

void nfc_rfid_register_callback(NFCRFID *nfc_rfid, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • nfc_rfid – Typ: NFCRFID *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

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 nfc_rfid_register_callback() Funktion durchgeführt werden:

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

nfc_rfid_register_callback(&nfc_rfid,
                           NFC_RFID_CALLBACK_EXAMPLE,
                           (void (*)(void))my_callback,
                           NULL);

Die verfügbaren Konstanten mit den zugehörigen 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_RFID_CALLBACK_STATE_CHANGED
void callback(uint8_t state, bool idle, void *user_data)
Callback-Parameter:
  • state – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • idle – Typ: bool
  • user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Zustand des NFC/RFID Bricklets sich verändert. Siehe nfc_rfid_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:

  • NFC_RFID_STATE_INITIALIZATION = 0
  • NFC_RFID_STATE_IDLE = 128
  • NFC_RFID_STATE_ERROR = 192
  • NFC_RFID_STATE_REQUEST_TAG_ID = 2
  • NFC_RFID_STATE_REQUEST_TAG_ID_READY = 130
  • NFC_RFID_STATE_REQUEST_TAG_ID_ERROR = 194
  • NFC_RFID_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE = 3
  • NFC_RFID_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY = 131
  • NFC_RFID_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR = 195
  • NFC_RFID_STATE_WRITE_PAGE = 4
  • NFC_RFID_STATE_WRITE_PAGE_READY = 132
  • NFC_RFID_STATE_WRITE_PAGE_ERROR = 196
  • NFC_RFID_STATE_REQUEST_PAGE = 5
  • NFC_RFID_STATE_REQUEST_PAGE_READY = 133
  • NFC_RFID_STATE_REQUEST_PAGE_ERROR = 197

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int nfc_rfid_get_api_version(NFCRFID *nfc_rfid, uint8_t ret_api_version[3])
Parameter:
  • nfc_rfid – Typ: NFCRFID *
Ausgabeparameter:
  • ret_api_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]
Rückgabe:
  • error_code – Typ: int

Gibt die Version der API Definition 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_rfid_get_response_expected(NFCRFID *nfc_rfid, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • nfc_rfid – Typ: NFCRFID *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_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 nfc_rfid_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:

  • NFC_RFID_FUNCTION_REQUEST_TAG_ID = 1
  • NFC_RFID_FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
  • NFC_RFID_FUNCTION_WRITE_PAGE = 5
  • NFC_RFID_FUNCTION_REQUEST_PAGE = 6
int nfc_rfid_set_response_expected(NFCRFID *nfc_rfid, uint8_t function_id, bool response_expected)
Parameter:
  • nfc_rfid – Typ: NFCRFID *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_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:

  • NFC_RFID_FUNCTION_REQUEST_TAG_ID = 1
  • NFC_RFID_FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
  • NFC_RFID_FUNCTION_WRITE_PAGE = 5
  • NFC_RFID_FUNCTION_REQUEST_PAGE = 6
int nfc_rfid_set_response_expected_all(NFCRFID *nfc_rfid, bool response_expected)
Parameter:
  • nfc_rfid – Typ: NFCRFID *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

Konstanten

NFC_RFID_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein NFC/RFID Bricklet zu identifizieren.

Die nfc_rfid_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_RFID_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines NFC/RFID Bricklet dar.