MQTT - NFC/RFID Bricklet

Dies ist die Beschreibung der MQTT 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 MQTT 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.txt)

 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
# Change XYZ to the UID of your NFC/RFID Bricklet

setup:
    # Handle incoming state changed callbacks
    set current_tag_type to "mifare_classic"
    
    subscribe to tinkerforge/callback/nfc_rfid_bricklet/XYZ/state_changed
        if a message is received
            # message contains the current state as int with symbols and idle as bool
            if idle
                set current_tag_type to (current_tag_type + 1) % 3
                publish '{"tag_type": current_tag_type}' to tinkerforge/request/nfc_rfid_bricklet/XYZ/request_tag_id 
            endif
            
            if state == "RequestTagIDReady"
                subscribe to tinkerforge/response/nfc_rfid_bricklet/XYZ/get_tag_id
                    if a message is received
                        # message contains tag_type, id_length and tag_id
                        print tag_type, id_length and tag_id
                    endif
                endsubscribe
                publish '' to tinkerforge/response/nfc_rfid_bricklet/XYZ/get_tag_id
            endif            
        endif
    endsubscribe
    publish '{"register": true}' to tinkerforge/register/nfc_rfid_bricklet/XYZ/state_changed
        
    # Start scan loop
    publish '{"tag_type": "mifare_classic"}' to tinkerforge/request/nfc_rfid_bricklet/XYZ/request_tag_id 

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/nfc_rfid_bricklet/<UID>/request_tag_id
Anfrage:
  • tag_type – Typ: int, Wertebereich: Siehe Symbole
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/nfc_rfid_bricklet/<UID>/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 register/nfc_rfid_bricklet/<UID>/state_changed Callback zu registrieren oder den Zustand über request/nfc_rfid_bricklet/<UID>/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 request/nfc_rfid_bricklet/<UID>/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/nfc_rfid_bricklet/<UID>/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/nfc_rfid_bricklet/<UID>/request_tag_id muss erneut aufgerufen werden.

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

Für tag_type:

  • "mifare_classic" = 0
  • "type1" = 1
  • "type2" = 2
request/nfc_rfid_bricklet/<UID>/get_tag_id
Anfrage:
  • keine Nutzdaten
Antwort:
  • tag_type – Typ: int, Wertebereich: Siehe Symbole
  • tid_length – Typ: int, Wertebereich: [4, 7]
  • tid – Typ: [int, ...], Länge: 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/nfc_rfid_bricklet/<UID>/request_tag_id gefunden wurde.

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

  1. Rufe request/nfc_rfid_bricklet/<UID>/request_tag_id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe request/nfc_rfid_bricklet/<UID>/get_state oder register/nfc_rfid_bricklet/<UID>/state_changed Callback)
  3. Rufe request/nfc_rfid_bricklet/<UID>/get_tag_id auf

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

Für tag_type:

  • "mifare_classic" = 0
  • "type1" = 1
  • "type2" = 2
request/nfc_rfid_bricklet/<UID>/get_state
Anfrage:
  • keine Nutzdaten
Antwort:
  • state – Typ: int, Wertebereich: Siehe Symbole
  • 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/nfc_rfid_bricklet/<UID>/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 request/nfc_rfid_bricklet/<UID>/get_page abgerufen werden.

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

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

Für state:

  • "initialization" = 0
  • "idle" = 128
  • "error" = 192
  • "request_tag_id" = 2
  • "request_tag_id_ready" = 130
  • "request_tag_id_error" = 194
  • "authenticating_mifare_classic_page" = 3
  • "authenticating_mifare_classic_page_ready" = 131
  • "authenticating_mifare_classic_page_error" = 195
  • "write_page" = 4
  • "write_page_ready" = 132
  • "write_page_error" = 196
  • "request_page" = 5
  • "request_page_ready" = 133
  • "request_page_error" = 197
request/nfc_rfid_bricklet/<UID>/authenticate_mifare_classic_page
Anfrage:
  • page – Typ: int, Wertebereich: [0 bis 216 - 1]
  • key_number – Typ: int, Wertebereich: Siehe Symbole
  • key – Typ: [int, ...], Länge: 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/nfc_rfid_bricklet/<UID>/request_tag_id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe request/nfc_rfid_bricklet/<UID>/get_state oder register/nfc_rfid_bricklet/<UID>/state_changed Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe request/nfc_rfid_bricklet/<UID>/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/nfc_rfid_bricklet/<UID>/authenticate_mifare_classic_page mit Page und Schlüssel für die Page auf
  5. Warte auf einen Zustandswechsel auf AuthenticatingMifareClassicPageReady (siehe request/nfc_rfid_bricklet/<UID>/get_state oder register/nfc_rfid_bricklet/<UID>/state_changed Callback)
  6. Rufe request/nfc_rfid_bricklet/<UID>/request_page oder request/nfc_rfid_bricklet/<UID>/write_page zum Lesen/Schreiben einer Page auf

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

Für key_number:

  • "a" = 0
  • "b" = 1
request/nfc_rfid_bricklet/<UID>/write_page
Anfrage:
  • page – Typ: int, Wertebereich: [0 bis 216 - 1]
  • data – Typ: [int, ...], Länge: 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/nfc_rfid_bricklet/<UID>/request_tag_id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe request/nfc_rfid_bricklet/<UID>/get_state oder register/nfc_rfid_bricklet/<UID>/state_changed callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe request/nfc_rfid_bricklet/<UID>/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/nfc_rfid_bricklet/<UID>/write_page mit der Page sowie den zu schreibenden Daten auf
  5. Warte auf einen Zustandswechsel auf WritePageReady (siehe request/nfc_rfid_bricklet/<UID>/get_state oder register/nfc_rfid_bricklet/<UID>/state_changed Callback)

Wenn ein Mifare Classic Tag verwendet wird muss die Page authentifiziert werden bevor sie geschrieben werden kann. Siehe request/nfc_rfid_bricklet/<UID>/authenticate_mifare_classic_page.

request/nfc_rfid_bricklet/<UID>/request_page
Anfrage:
  • page – Typ: int, 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 request/nfc_rfid_bricklet/<UID>/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/nfc_rfid_bricklet/<UID>/request_tag_id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe request/nfc_rfid_bricklet/<UID>/get_state oder register/nfc_rfid_bricklet/<UID>/state_changed Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe request/nfc_rfid_bricklet/<UID>/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/nfc_rfid_bricklet/<UID>/request_page mit der zu lesenden Page auf
  5. Warte auf einen Zustandswechsel auf RequestPageReady (siehe request/nfc_rfid_bricklet/<UID>/get_state oder register/nfc_rfid_bricklet/<UID>/state_changed Callback)
  6. Rufe request/nfc_rfid_bricklet/<UID>/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 request/nfc_rfid_bricklet/<UID>/authenticate_mifare_classic_page.

request/nfc_rfid_bricklet/<UID>/get_page
Anfrage:
  • keine Nutzdaten
Antwort:
  • data – Typ: [int, ...], Länge: 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/nfc_rfid_bricklet/<UID>/request_page gefüllt werden.

Fortgeschrittene Funktionen

request/nfc_rfid_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des NFC/RFID.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

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.

register/nfc_rfid_bricklet/<UID>/state_changed
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • state – Typ: int, Wertebereich: Siehe Symbole
  • idle – Typ: bool

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/nfc_rfid_bricklet/<UID>/state_changed[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/nfc_rfid_bricklet/<UID>/state_changed[/<SUFFIX>]-Topic veröffentlicht.

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

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

Für state:

  • "initialization" = 0
  • "idle" = 128
  • "error" = 192
  • "request_tag_id" = 2
  • "request_tag_id_ready" = 130
  • "request_tag_id_error" = 194
  • "authenticating_mifare_classic_page" = 3
  • "authenticating_mifare_classic_page_ready" = 131
  • "authenticating_mifare_classic_page_error" = 195
  • "write_page" = 4
  • "write_page_ready" = 132
  • "write_page_error" = 196
  • "request_page" = 5
  • "request_page_ready" = 133
  • "request_page_error" = 197