Shell - NFC/RFID Bricklet

Dies ist die Beschreibung der Shell 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 Shell 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.sh)

 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
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your NFC/RFID Bricklet
tmp=$(mktemp)

# Create temporary file to keep track of current tag type
echo "0" > $tmp

# Handle incoming state changed callbacks
tinkerforge dispatch nfc-rfid-bricklet $uid state-changed\
 --execute "if [ {state} == request-tag-id-ready ]
              then tinkerforge call nfc-rfid-bricklet $uid get-tag-id
            fi;
            if [ {idle} ]
            then 
              tt=\$(cat $tmp)
              if [ \$tt -eq 0 ] 
                then tt=1
              elif [ \$tt -eq 1 ] 
                then tt=2
              elif [ \$tt -eq 2 ] 
                then tt=0
              fi
              echo \"\$tt\" > $tmp
              tinkerforge call nfc-rfid-bricklet $uid request-tag-id \$tt
            fi" &

# Start scan loop
tinkerforge call nfc-rfid-bricklet $uid request-tag-id tag-type-mifare-classic

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call nfc-rfid-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des NFC/RFID Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
  • --list-functions zeigt eine Liste der bekannten Funktionen des NFC/RFID Bricklet an und endet dann
tinkerforge dispatch nfc-rfid-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des NFC/RFID Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
  • --list-callbacks zeigt eine Liste der bekannten Callbacks des NFC/RFID Bricklet an und endet dann
tinkerforge call nfc-rfid-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

  • --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch nfc-rfid-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifische <callback> an und endet dann
  • --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen

tinkerforge call nfc-rfid-bricklet <uid> request-tag-id <tag-type>
Parameter:
  • <tag-type> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

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

Für <tag-type>:

  • tag-type-mifare-classic = 0
  • tag-type-type1 = 1
  • tag-type-type2 = 2
tinkerforge call nfc-rfid-bricklet <uid> get-tag-id
Ausgabe:
  • tag-type – Typ: Int, Wertebereich: Siehe Symbole
  • tid-length – Typ: Int, Wertebereich: [4, 7]
  • tid – Typ: Int Array, 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-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 state-changed Callback)
  3. Rufe get-tag-id auf

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

Für tag-type:

  • tag-type-mifare-classic = 0
  • tag-type-type1 = 1
  • tag-type-type2 = 2
tinkerforge call nfc-rfid-bricklet <uid> get-state
Ausgabe:
  • 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-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 Symbole sind für diese Funktion verfügbar:

Für state:

  • state-initialization = 0
  • state-idle = 128
  • state-error = 192
  • state-request-tag-id = 2
  • state-request-tag-id-ready = 130
  • state-request-tag-id-error = 194
  • state-authenticating-mifare-classic-page = 3
  • state-authenticating-mifare-classic-page-ready = 131
  • state-authenticating-mifare-classic-page-error = 195
  • state-write-page = 4
  • state-write-page-ready = 132
  • state-write-page-error = 196
  • state-request-page = 5
  • state-request-page-ready = 133
  • state-request-page-error = 197
tinkerforge call nfc-rfid-bricklet <uid> authenticate-mifare-classic-page <page> <key-number> <key>
Parameter:
  • <page> – Typ: Int, Wertebereich: [0 bis 216 - 1]
  • <key-number> – Typ: Int, Wertebereich: Siehe Symbole
  • <key> – Typ: Int Array, Länge: 6, Wertebereich: [0 bis 255]
Ausgabe:
  • keine Ausgabe

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 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 state-changed Callback)
  6. Rufe request-page oder write-page zum Lesen/Schreiben einer Page auf

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

Für <key-number>:

  • key-a = 0
  • key-b = 1
tinkerforge call nfc-rfid-bricklet <uid> write-page <page> <data>
Parameter:
  • <page> – Typ: Int, Wertebereich: [0 bis 216 - 1]
  • <data> – Typ: Int Array, Länge: 16, Wertebereich: [0 bis 255]
Ausgabe:
  • keine Ausgabe

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

tinkerforge call nfc-rfid-bricklet <uid> request-page <page>
Parameter:
  • <page> – Typ: Int, Wertebereich: [0 bis 216 - 1]
Ausgabe:
  • keine Ausgabe

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

tinkerforge call nfc-rfid-bricklet <uid> get-page
Ausgabe:
  • data – Typ: Int Array, 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-page gefüllt werden.

Fortgeschrittene Funktionen

tinkerforge call nfc-rfid-bricklet <uid> get-identity
Ausgabe:
  • 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 Array, 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 Array, 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]

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

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch nfc-rfid-bricklet <uid> example

Die verfügbaren Callbacks 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.

tinkerforge dispatch nfc-rfid-bricklet <uid> state-changed
Ausgabe:
  • state – Typ: Int, Wertebereich: Siehe Symbole
  • 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 Symbole sind für diese Funktion verfügbar:

Für state:

  • state-initialization = 0
  • state-idle = 128
  • state-error = 192
  • state-request-tag-id = 2
  • state-request-tag-id-ready = 130
  • state-request-tag-id-error = 194
  • state-authenticating-mifare-classic-page = 3
  • state-authenticating-mifare-classic-page-ready = 131
  • state-authenticating-mifare-classic-page-error = 195
  • state-write-page = 4
  • state-write-page-ready = 132
  • state-write-page-error = 196
  • state-request-page = 5
  • state-request-page-ready = 133
  • state-request-page-error = 197