Shell - NFC Bricklet

Dies ist die Beschreibung der Shell 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 Shell API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

Der call Befehl wird verwendet um eine Funktion des NFC 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 Bricklet an und endet dann
tinkerforge dispatch nfc-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> -- string
  • <callback> -- string

Der dispatch Befehl wird verwendet um eingehende Callbacks des NFC 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 Bricklet an und endet dann
tinkerforge call nfc-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- 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-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> -- string
  • <callback> -- 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-bricklet <uid> set-mode <mode>
Parameter:
  • <mode> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

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

  • mode-off = 0, für <mode>
  • mode-cardemu = 1, für <mode>
  • mode-p2p = 2, für <mode>
  • mode-reader = 3, für <mode>
tinkerforge call nfc-bricklet <uid> get-mode
Ausgabe:
  • mode -- int (hat Symbole)

Gibt den aktuellen Modus zurück, wie von set-mode gesetzt.

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

  • mode-off = 0, für mode
  • mode-cardemu = 1, für mode
  • mode-p2p = 2, für mode
  • mode-reader = 3, für mode
tinkerforge call nfc-bricklet <uid> reader-request-tag-id
Ausgabe:keine Ausgabe

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 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 reader-state-changed Callback zu registrieren oder den Zustand über 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 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 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 reader-request-tag-id muss erneut aufgerufen werden.

tinkerforge call nfc-bricklet <uid> reader-get-tag-id-low-level
Ausgabe:
  • tag-type -- int (hat Symbole)
  • tag-id-length -- int
  • tag-id-data -- int,int,..29x..,int

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 reader-request-tag-id gefunden wurde.

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

  1. Rufe reader-request-tag-id auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe reader-get-state oder reader-state-changed Callback)
  3. Rufe reader-get-tag-id auf

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

  • tag-type-mifare-classic = 0, für tag-type
  • tag-type-type1 = 1, für tag-type
  • tag-type-type2 = 2, für tag-type
  • tag-type-type3 = 3, für tag-type
  • tag-type-type4 = 4, für tag-type
tinkerforge call nfc-bricklet <uid> reader-get-state
Ausgabe:
  • state -- int (hat Symbole)
  • idle -- bool

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 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 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 reader-read-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:

  • reader-state-initialization = 0, für state
  • reader-state-idle = 128, für state
  • reader-state-error = 192, für state
  • reader-state-request-tag-id = 2, für state
  • reader-state-request-tag-id-ready = 130, für state
  • reader-state-request-tag-id-error = 194, für state
  • reader-state-authenticate-mifare-classic-page = 3, für state
  • reader-state-authenticate-mifare-classic-page-ready = 131, für state
  • reader-state-authenticate-mifare-classic-page-error = 195, für state
  • reader-state-write-page = 4, für state
  • reader-state-write-page-ready = 132, für state
  • reader-state-write-page-error = 196, für state
  • reader-state-request-page = 5, für state
  • reader-state-request-page-ready = 133, für state
  • reader-state-request-page-error = 197, für state
  • reader-state-write-ndef = 6, für state
  • reader-state-write-ndef-ready = 134, für state
  • reader-state-write-ndef-error = 198, für state
  • reader-state-request-ndef = 7, für state
  • reader-state-request-ndef-ready = 135, für state
  • reader-state-request-ndef-error = 199, für state
tinkerforge call nfc-bricklet <uid> reader-write-ndef-low-level <ndef-length> <ndef-chunk-offset> <ndef-chunk-data>
Parameter:
  • <ndef-length> -- int
  • <ndef-chunk-offset> -- int
  • <ndef-chunk-data> -- int,int,..57x..,int
Ausgabe:

keine Ausgabe

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 reader-request-tag-id auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe reader-get-state oder reader-state-changed Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe 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 reader-write-ndef mit der zu schreibenden NDEF Nachricht auf
  5. Warte auf einen Zustandswechsel auf ReaderWriteNDEFReady (siehe reader-get-state oder reader-state-changed Callback)
tinkerforge call nfc-bricklet <uid> reader-request-ndef
Ausgabe:keine Ausgabe

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 reader-request-tag-id auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe reader-get-state oder reader-state-changed Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe 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 reader-request-ndef auf
  5. Warte auf einen Zustandswechsel auf ReaderRequestNDEFReady (siehe reader-get-state oder reader-state-changed Callback)
  6. Rufe reader-read-ndef auf um die gespeicherte NDEF Nachricht abzufragen
tinkerforge call nfc-bricklet <uid> reader-read-ndef-low-level
Ausgabe:
  • ndef-length -- int
  • ndef-chunk-offset -- int
  • ndef-chunk-data -- int,int,..57x..,int

Gibt NDEF Daten aus einem internen Buffer zurück. Der Buffer kann zuvor mit einer NDEF Nachricht über einen Aufruf von reader-request-ndef gefüllt werden.

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

tinkerforge call nfc-bricklet <uid> reader-authenticate-mifare-classic-page <page> <key-number> <key>
Parameter:
  • <page> -- int
  • <key-number> -- int (hat Symbole)
  • <key> -- int,int,..3x..,int
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 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 reader-request-tag-id auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe reader-get-state oder reader-state-changed Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe 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 reader-authenticate-mifare-classic-page mit Page und Schlüssel für die Page auf
  5. Warte auf einen Zustandswechsel auf ReaderAuthenticatingMifareClassicPageReady (siehe reader-get-state oder reader-state-changed Callback)
  6. Rufe reader-request-page oder reader-write-page zum Lesen/Schreiben einer Page auf

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

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

  • key-a = 0, für <key-number>
  • key-b = 1, für <key-number>
tinkerforge call nfc-bricklet <uid> reader-write-page-low-level <page> <data-length> <data-chunk-offset> <data-chunk-data>
Parameter:
  • <page> -- int (hat Symbole)
  • <data-length> -- int
  • <data-chunk-offset> -- int
  • <data-chunk-data> -- int,int,..55x..,int
Ausgabe:

keine Ausgabe

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 reader-request-tag-id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe reader-get-state oder reader-state-changed callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe 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 reader-write-page mit der Page sowie den zu schreibenden Daten auf
  5. Warte auf einen Zustandswechsel auf ReaderWritePageReady (siehe reader-get-state oder reader-state-changed Callback)

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

  • reader-write-type4-capability-container = 3, für <page>
  • reader-write-type4-ndef = 4, für <page>
tinkerforge call nfc-bricklet <uid> reader-request-page <page> <length>
Parameter:
  • <page> -- int (hat Symbole)
  • <length> -- int
Ausgabe:

keine Ausgabe

Liest maximal 8192 Bytes beginnend von der übergebenen Page und speichert sie in einem Buffer. Dieser Buffer kann mit 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 reader-request-tag-id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe reader-get-state oder reader-state-changed Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe 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 reader-request-page mit der zu lesenden Page auf
  5. Warte auf einen Zustandswechsel auf ReaderRequestPageReady (siehe reader-get-state oder reader-state-changed Callback)
  6. Rufe 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 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 Symbole sind für diese Funktion verfügbar:

  • reader-request-type4-capability-container = 3, für <page>
  • reader-request-type4-ndef = 4, für <page>
tinkerforge call nfc-bricklet <uid> reader-read-page-low-level
Ausgabe:
  • data-length -- int
  • data-chunk-offset -- int
  • data-chunk-data -- int,int,..57x..,int

Gibt Daten aus einem internen Buffer zurück. Der Buffer kann zuvor mit spezifischen Pages über einen Aufruf von reader-request-page gefüllt werden.

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

tinkerforge call nfc-bricklet <uid> cardemu-get-state
Ausgabe:
  • state -- int (hat Symbole)
  • idle -- bool

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

  • cardemu-state-initialization = 0, für state
  • cardemu-state-idle = 128, für state
  • cardemu-state-error = 192, für state
  • cardemu-state-discover = 2, für state
  • cardemu-state-discover-ready = 130, für state
  • cardemu-state-discover-error = 194, für state
  • cardemu-state-transfer-ndef = 3, für state
  • cardemu-state-transfer-ndef-ready = 131, für state
  • cardemu-state-transfer-ndef-error = 195, für state
tinkerforge call nfc-bricklet <uid> cardemu-start-discovery
Ausgabe:keine Ausgabe

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 cardemu-write-ndef und cardemu-start-transfer übertragen werden.

tinkerforge call nfc-bricklet <uid> cardemu-write-ndef-low-level <ndef-length> <ndef-chunk-offset> <ndef-chunk-data>
Parameter:
  • <ndef-length> -- int
  • <ndef-chunk-offset> -- int
  • <ndef-chunk-data> -- int,int,..57x..,int
Ausgabe:

keine Ausgabe

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.

tinkerforge call nfc-bricklet <uid> cardemu-start-transfer <transfer>
Parameter:
  • <transfer> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

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

  • cardemu-transfer-abort = 0, für <transfer>
  • cardemu-transfer-write = 1, für <transfer>
tinkerforge call nfc-bricklet <uid> p2p-get-state
Ausgabe:
  • state -- int (hat Symbole)
  • idle -- bool

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

  • p2p-state-initialization = 0, für state
  • p2p-state-idle = 128, für state
  • p2p-state-error = 192, für state
  • p2p-state-discover = 2, für state
  • p2p-state-discover-ready = 130, für state
  • p2p-state-discover-error = 194, für state
  • p2p-state-transfer-ndef = 3, für state
  • p2p-state-transfer-ndef-ready = 131, für state
  • p2p-state-transfer-ndef-error = 195, für state
tinkerforge call nfc-bricklet <uid> p2p-start-discovery
Ausgabe:keine Ausgabe

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 p2p-write-ndef und p2p-start-transfer übertragen werden.

tinkerforge call nfc-bricklet <uid> p2p-write-ndef-low-level <ndef-length> <ndef-chunk-offset> <ndef-chunk-data>
Parameter:
  • <ndef-length> -- int
  • <ndef-chunk-offset> -- int
  • <ndef-chunk-data> -- int,int,..57x..,int
Ausgabe:

keine Ausgabe

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.

tinkerforge call nfc-bricklet <uid> p2p-start-transfer <transfer>
Parameter:
  • <transfer> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

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 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 p2p-read-ndef ausgelesen werden.

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

  • p2p-transfer-abort = 0, für <transfer>
  • p2p-transfer-write = 1, für <transfer>
  • p2p-transfer-read = 2, für <transfer>
tinkerforge call nfc-bricklet <uid> p2p-read-ndef-low-level
Ausgabe:
  • ndef-length -- int
  • ndef-chunk-offset -- int
  • ndef-chunk-data -- int,int,..57x..,int

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 p2p-start-transfer Aufruf mit einem Lese-Transfer der P2P Zustand zu P2PTransferNDEFReady ändert.

Fortgeschrittene Funktionen

tinkerforge call nfc-bricklet <uid> set-detection-led-config <config>
Parameter:
  • <config> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

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

  • detection-led-config-off = 0, für <config>
  • detection-led-config-on = 1, für <config>
  • detection-led-config-show-heartbeat = 2, für <config>
  • detection-led-config-show-detection = 3, für <config>
tinkerforge call nfc-bricklet <uid> get-detection-led-config
Ausgabe:
  • config -- int (hat Symbole)

Gibt die Konfiguration zurück, wie von set-detection-led-config gesetzt.

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

  • detection-led-config-off = 0, für config
  • detection-led-config-on = 1, für config
  • detection-led-config-show-heartbeat = 2, für config
  • detection-led-config-show-detection = 3, für config
tinkerforge call nfc-bricklet <uid> set-maximum-timeout <timeout>
Parameter:
  • <timeout> -- int
Ausgabe:

keine Ausgabe

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

tinkerforge call nfc-bricklet <uid> get-maximum-timeout
Ausgabe:
  • timeout -- int

Gibt das Timeout zurück, wie von set-maximum-timeout gesetzt.

Neu in Version 2.0.1 (Plugin).

tinkerforge call nfc-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • error-count-ack-checksum -- int
  • error-count-message-checksum -- int
  • error-count-frame -- int
  • error-count-overflow -- int

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.

tinkerforge call nfc-bricklet <uid> set-bootloader-mode <mode>
Parameter:
  • <mode> -- int (hat Symbole)
Ausgabe:
  • status -- int (hat Symbole)

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

  • bootloader-mode-bootloader = 0, für <mode>
  • bootloader-mode-firmware = 1, für <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, für <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, für <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für <mode>
  • bootloader-status-ok = 0, für status
  • bootloader-status-invalid-mode = 1, für status
  • bootloader-status-no-change = 2, für status
  • bootloader-status-entry-function-not-present = 3, für status
  • bootloader-status-device-identifier-incorrect = 4, für status
  • bootloader-status-crc-mismatch = 5, für status
tinkerforge call nfc-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode -- int (hat Symbole)

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

  • bootloader-mode-bootloader = 0, für mode
  • bootloader-mode-firmware = 1, für mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, für mode
  • bootloader-mode-firmware-wait-for-reboot = 3, für mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für mode
tinkerforge call nfc-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> -- int
Ausgabe:

keine Ausgabe

Setzt den Firmware-Pointer für 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.

tinkerforge call nfc-bricklet <uid> write-firmware <data>
Parameter:
  • <data> -- int,int,..61x..,int
Ausgabe:
  • status -- int

Schreibt 64 Bytes Firmware an die Position die vorher von 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.

tinkerforge call nfc-bricklet <uid> set-status-led-config <config>
Parameter:
  • <config> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

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

  • status-led-config-off = 0, für <config>
  • status-led-config-on = 1, für <config>
  • status-led-config-show-heartbeat = 2, für <config>
  • status-led-config-show-status = 3, für <config>
tinkerforge call nfc-bricklet <uid> get-status-led-config
Ausgabe:
  • config -- int (hat Symbole)

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

  • status-led-config-off = 0, für config
  • status-led-config-on = 1, für config
  • status-led-config-show-heartbeat = 2, für config
  • status-led-config-show-status = 3, für config
tinkerforge call nfc-bricklet <uid> get-chip-temperature
Ausgabe:
  • temperature -- int

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.

tinkerforge call nfc-bricklet <uid> reset
Ausgabe:keine Ausgabe

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.

tinkerforge call nfc-bricklet <uid> write-uid <uid>
Parameter:
  • <uid> -- int
Ausgabe:

keine Ausgabe

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.

tinkerforge call nfc-bricklet <uid> read-uid
Ausgabe:
  • uid -- int

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

tinkerforge call nfc-bricklet <uid> get-identity
Ausgabe:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (hat Symbole)

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. 

Callbacks

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

tinkerforge dispatch nfc-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-bricklet <uid> reader-state-changed
Ausgabe:
  • state -- int (hat Symbole)
  • idle -- bool

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

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

  • reader-state-initialization = 0, für state
  • reader-state-idle = 128, für state
  • reader-state-error = 192, für state
  • reader-state-request-tag-id = 2, für state
  • reader-state-request-tag-id-ready = 130, für state
  • reader-state-request-tag-id-error = 194, für state
  • reader-state-authenticate-mifare-classic-page = 3, für state
  • reader-state-authenticate-mifare-classic-page-ready = 131, für state
  • reader-state-authenticate-mifare-classic-page-error = 195, für state
  • reader-state-write-page = 4, für state
  • reader-state-write-page-ready = 132, für state
  • reader-state-write-page-error = 196, für state
  • reader-state-request-page = 5, für state
  • reader-state-request-page-ready = 133, für state
  • reader-state-request-page-error = 197, für state
  • reader-state-write-ndef = 6, für state
  • reader-state-write-ndef-ready = 134, für state
  • reader-state-write-ndef-error = 198, für state
  • reader-state-request-ndef = 7, für state
  • reader-state-request-ndef-ready = 135, für state
  • reader-state-request-ndef-error = 199, für state
tinkerforge dispatch nfc-bricklet <uid> cardemu-state-changed
Ausgabe:
  • state -- int (hat Symbole)
  • idle -- bool

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

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

  • cardemu-state-initialization = 0, für state
  • cardemu-state-idle = 128, für state
  • cardemu-state-error = 192, für state
  • cardemu-state-discover = 2, für state
  • cardemu-state-discover-ready = 130, für state
  • cardemu-state-discover-error = 194, für state
  • cardemu-state-transfer-ndef = 3, für state
  • cardemu-state-transfer-ndef-ready = 131, für state
  • cardemu-state-transfer-ndef-error = 195, für state
tinkerforge dispatch nfc-bricklet <uid> p2p-state-changed
Ausgabe:
  • state -- int (hat Symbole)
  • idle -- bool

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

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

  • p2p-state-initialization = 0, für state
  • p2p-state-idle = 128, für state
  • p2p-state-error = 192, für state
  • p2p-state-discover = 2, für state
  • p2p-state-discover-ready = 130, für state
  • p2p-state-discover-error = 194, für state
  • p2p-state-transfer-ndef = 3, für state
  • p2p-state-transfer-ndef-ready = 131, für state
  • p2p-state-transfer-ndef-error = 195, für state