TCP/IP - NFC/RFID Bricklet

Dies ist die Beschreibung des TCP/IP Protokolls für das NFC/RFID Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des NFC/RFID Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletNFCRFID.request_tag_id
Funktions-ID:
  • 1
Anfrage:
  • tag_type – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • keine Antwort

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 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 CALLBACK_STATE_CHANGED Callback zu registrieren oder den Zustand über 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 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 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 request_tag_id muss erneut aufgerufen werden.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für tag_type:

  • 0 = Mifare Classic
  • 1 = Type1
  • 2 = Type2
BrickletNFCRFID.get_tag_id
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • tag_type – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • tid_length – Typ: uint8, Wertebereich: [4, 7]
  • tid – Typ: uint8[7], Wertebereich: [0 bis 255]

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 request_tag_id gefunden wurde.

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

  1. Rufe request_tag_id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe get_state oder CALLBACK_STATE_CHANGED Callback)
  3. Rufe get_tag_id auf

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für tag_type:

  • 0 = Mifare Classic
  • 1 = Type1
  • 2 = Type2
BrickletNFCRFID.get_state
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • state – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • idle – Typ: bool

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 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 get_page abgerufen werden.

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für state:

  • 0 = Initialization
  • 128 = Idle
  • 192 = Error
  • 2 = Request Tag ID
  • 130 = Request Tag ID Ready
  • 194 = Request Tag ID Error
  • 3 = Authenticating Mifare Classic Page
  • 131 = Authenticating Mifare Classic Page Ready
  • 195 = Authenticating Mifare Classic Page Error
  • 4 = Write Page
  • 132 = Write Page Ready
  • 196 = Write Page Error
  • 5 = Request Page
  • 133 = Request Page Ready
  • 197 = Request Page Error
BrickletNFCRFID.authenticate_mifare_classic_page
Funktions-ID:
  • 4
Anfrage:
  • page – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • key_number – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • key – Typ: uint8[6], Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

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 request_tag_id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe get_state oder CALLBACK_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe get_tag_id auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe authenticate_mifare_classic_page mit Page und Schlüssel für die Page auf
  5. Warte auf einen Zustandswechsel auf AuthenticatingMifareClassicPageReady (siehe get_state oder CALLBACK_STATE_CHANGED Callback)
  6. Rufe request_page oder write_page zum Lesen/Schreiben einer Page auf

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für key_number:

  • 0 = A
  • 1 = B
BrickletNFCRFID.write_page
Funktions-ID:
  • 5
Anfrage:
  • page – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • data – Typ: uint8[16], Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

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 request_tag_id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe get_state oder CALLBACK_STATE_CHANGED callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe get_tag_id auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe write_page mit der Page sowie den zu schreibenden Daten auf
  5. Warte auf einen Zustandswechsel auf WritePageReady (siehe get_state oder CALLBACK_STATE_CHANGED Callback)

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

BrickletNFCRFID.request_page
Funktions-ID:
  • 6
Anfrage:
  • page – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort

Liest 16 Bytes startend von der übergebenen Page und speichert sie in einem Buffer. Dieser Buffer kann mit 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 request_tag_id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe get_state oder CALLBACK_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe get_tag_id auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe request_page mit der zu lesenden Page auf
  5. Warte auf einen Zustandswechsel auf RequestPageReady (siehe get_state oder CALLBACK_STATE_CHANGED Callback)
  6. Rufe 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 authenticate_mifare_classic_page.

BrickletNFCRFID.get_page
Funktions-ID:
  • 7
Anfrage:
  • keine Nutzdaten
Antwort:
  • data – Typ: uint8[16], Wertebereich: [0 bis 255]

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

Fortgeschrittene Funktionen

BrickletNFCRFID.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]

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. 

Callbacks

BrickletNFCRFID.CALLBACK_STATE_CHANGED
Funktions-ID:
  • 8
Antwort:
  • state – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • idle – Typ: bool

Dieser Callback wird ausgelöst, wenn der Zustand des NFC/RFID Bricklets sich verändert. Siehe get_state für mehr Informationen über die möglichen Zustände des Bricklets.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für state:

  • 0 = Initialization
  • 128 = Idle
  • 192 = Error
  • 2 = Request Tag ID
  • 130 = Request Tag ID Ready
  • 194 = Request Tag ID Error
  • 3 = Authenticating Mifare Classic Page
  • 131 = Authenticating Mifare Classic Page Ready
  • 195 = Authenticating Mifare Classic Page Error
  • 4 = Write Page
  • 132 = Write Page Ready
  • 196 = Write Page Error
  • 5 = Request Page
  • 133 = Request Page Ready
  • 197 = Request Page Error