Modbus - NFC Bricklet

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

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletNFC.set_mode
Funktions ID:

1

Anfrage:
  • mode -- uint8
Antwort:

keine Antwort

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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für mode
  • 1: cardemu, für mode
  • 2: p2p, für mode
  • 3: reader, für mode
BrickletNFC.get_mode
Funktions ID:

2

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den aktuellen Modus zurück, wie von set_mode gesetzt.

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

  • 0: off, für mode
  • 1: cardemu, für mode
  • 2: p2p, für mode
  • 3: reader, für mode
BrickletNFC.reader_request_tag_id
Funktions ID:3
Anfrage:keine Nutzdaten
Antwort:keine Antwort

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

BrickletNFC.reader_get_tag_id_low_level
Funktions ID:

4

Anfrage:

keine Nutzdaten

Antwort:
  • tag_type -- uint8
  • tag_id_length -- uint8
  • tag_id_data -- uint8[32]

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 CALLBACK_READER_STATE_CHANGED Callback)
  3. Rufe reader_get_tag_id_low_level auf

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

  • 0: mifare classic, für tag_type
  • 1: type1, für tag_type
  • 2: type2, für tag_type
  • 3: type3, für tag_type
  • 4: type4, für tag_type
BrickletNFC.reader_get_state
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • state -- uint8
  • 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_low_level abgerufen werden.

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

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

  • 0: initialization, für state
  • 128: idle, für state
  • 192: error, für state
  • 2: request tag id, für state
  • 130: request tag id ready, für state
  • 194: request tag id error, für state
  • 3: authenticate mifare classic page, für state
  • 131: authenticate mifare classic page ready, für state
  • 195: authenticate mifare classic page error, für state
  • 4: write page, für state
  • 132: write page ready, für state
  • 196: write page error, für state
  • 5: request page, für state
  • 133: request page ready, für state
  • 197: request page error, für state
  • 6: write ndef, für state
  • 134: write ndef ready, für state
  • 198: write ndef error, für state
  • 7: request ndef, für state
  • 135: request ndef ready, für state
  • 199: request ndef error, für state
BrickletNFC.reader_write_ndef_low_level
Funktions ID:

6

Anfrage:
  • ndef_length -- uint16
  • ndef_chunk_offset -- uint16
  • ndef_chunk_data -- uint8[60]
Antwort:

keine Antwort

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 CALLBACK_READER_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe reader_get_tag_id_low_level auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe reader_write_ndef_low_level mit der zu schreibenden NDEF Nachricht auf
  5. Warte auf einen Zustandswechsel auf ReaderWriteNDEFReady (siehe reader_get_state oder CALLBACK_READER_STATE_CHANGED Callback)
BrickletNFC.reader_request_ndef
Funktions ID:7
Anfrage:keine Nutzdaten
Antwort:keine Antwort

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 CALLBACK_READER_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe reader_get_tag_id_low_level 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 CALLBACK_READER_STATE_CHANGED Callback)
  6. Rufe reader_read_ndef_low_level auf um die gespeicherte NDEF Nachricht abzufragen
BrickletNFC.reader_read_ndef_low_level
Funktions ID:

8

Anfrage:

keine Nutzdaten

Antwort:
  • ndef_length -- uint16
  • ndef_chunk_offset -- uint16
  • ndef_chunk_data -- uint8[60]

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.

BrickletNFC.reader_authenticate_mifare_classic_page
Funktions ID:

9

Anfrage:
  • page -- uint16
  • key_number -- uint8
  • key -- uint8[6]
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 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 CALLBACK_READER_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe reader_get_tag_id_low_level 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 CALLBACK_READER_STATE_CHANGED Callback)
  6. Rufe reader_request_page oder reader_write_page_low_level zum Lesen/Schreiben einer Page auf

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

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

  • 0: a, für key_number
  • 1: b, für key_number
BrickletNFC.reader_write_page_low_level
Funktions ID:

10

Anfrage:
  • page -- uint16
  • data_length -- uint16
  • data_chunk_offset -- uint16
  • data_chunk_data -- uint8[58]
Antwort:

keine Antwort

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 CALLBACK_READER_STATE_CHANGED callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe reader_get_tag_id_low_level auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe reader_write_page_low_level mit der Page sowie den zu schreibenden Daten auf
  5. Warte auf einen Zustandswechsel auf ReaderWritePageReady (siehe reader_get_state oder CALLBACK_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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 3: type4 capability container, für page
  • 4: type4 ndef, für page
BrickletNFC.reader_request_page
Funktions ID:

11

Anfrage:
  • page -- uint16
  • length -- uint16
Antwort:

keine Antwort

Liest maximal 8192 Bytes beginnend von der übergebenen Page und speichert sie in einem Buffer. Dieser Buffer kann mit reader_read_page_low_level 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 CALLBACK_READER_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe reader_get_tag_id_low_level 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 CALLBACK_READER_STATE_CHANGED Callback)
  6. Rufe reader_read_page_low_level 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 3: type4 capability container, für page
  • 4: type4 ndef, für page
BrickletNFC.reader_read_page_low_level
Funktions ID:

12

Anfrage:

keine Nutzdaten

Antwort:
  • data_length -- uint16
  • data_chunk_offset -- uint16
  • data_chunk_data -- uint8[60]

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.

BrickletNFC.cardemu_get_state
Funktions ID:

14

Anfrage:

keine Nutzdaten

Antwort:
  • state -- uint8
  • 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: initialization, für state
  • 128: idle, für state
  • 192: error, für state
  • 2: discover, für state
  • 130: discover ready, für state
  • 194: discover error, für state
  • 3: transfer ndef, für state
  • 131: transfer ndef ready, für state
  • 195: transfer ndef error, für state
BrickletNFC.cardemu_start_discovery
Funktions ID:15
Anfrage:keine Nutzdaten
Antwort:keine Antwort

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_low_level und cardemu_start_transfer übertragen werden.

BrickletNFC.cardemu_write_ndef_low_level
Funktions ID:

16

Anfrage:
  • ndef_length -- uint16
  • ndef_chunk_offset -- uint16
  • ndef_chunk_data -- uint8[60]
Antwort:

keine Antwort

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.

BrickletNFC.cardemu_start_transfer
Funktions ID:

17

Anfrage:
  • transfer -- uint8
Antwort:

keine Antwort

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_low_level 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: abort, für transfer
  • 1: write, für transfer
BrickletNFC.p2p_get_state
Funktions ID:

19

Anfrage:

keine Nutzdaten

Antwort:
  • state -- uint8
  • 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: initialization, für state
  • 128: idle, für state
  • 192: error, für state
  • 2: discover, für state
  • 130: discover ready, für state
  • 194: discover error, für state
  • 3: transfer ndef, für state
  • 131: transfer ndef ready, für state
  • 195: transfer ndef error, für state
BrickletNFC.p2p_start_discovery
Funktions ID:20
Anfrage:keine Nutzdaten
Antwort:keine Antwort

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_low_level und p2p_start_transfer übertragen werden.

BrickletNFC.p2p_write_ndef_low_level
Funktions ID:

21

Anfrage:
  • ndef_length -- uint16
  • ndef_chunk_offset -- uint16
  • ndef_chunk_data -- uint8[60]
Antwort:

keine Antwort

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.

BrickletNFC.p2p_start_transfer
Funktions ID:

22

Anfrage:
  • transfer -- uint8
Antwort:

keine Antwort

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_low_level 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_low_level ausgelesen werden.

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

  • 0: abort, für transfer
  • 1: write, für transfer
  • 2: read, für transfer
BrickletNFC.p2p_read_ndef_low_level
Funktions ID:

23

Anfrage:

keine Nutzdaten

Antwort:
  • ndef_length -- uint16
  • ndef_chunk_offset -- uint16
  • ndef_chunk_data -- uint8[60]

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

BrickletNFC.set_detection_led_config
Funktions ID:

25

Anfrage:
  • config -- uint8
Antwort:

keine Antwort

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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show detection, für config
BrickletNFC.get_detection_led_config
Funktions ID:

26

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

Gibt die Konfiguration zurück, wie von set_detection_led_config gesetzt.

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

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show detection, für config
BrickletNFC.set_maximum_timeout
Funktions ID:

27

Anfrage:
  • timeout -- uint16
Antwort:

keine Antwort

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

BrickletNFC.get_maximum_timeout
Funktions ID:

28

Anfrage:

keine Nutzdaten

Antwort:
  • timeout -- uint16

Gibt das Timeout zurück, wie von set_maximum_timeout gesetzt.

Neu in Version 2.0.1 (Plugin).

BrickletNFC.get_spitfp_error_count
Funktions ID:

234

Anfrage:

keine Nutzdaten

Antwort:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.

BrickletNFC.set_bootloader_mode
Funktions ID:

235

Anfrage:
  • mode -- uint8
Antwort:
  • status -- uint8

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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
  • 0: ok, für status
  • 1: invalid mode, für status
  • 2: no change, für status
  • 3: entry function not present, für status
  • 4: device identifier incorrect, für status
  • 5: crc mismatch, für status
BrickletNFC.get_bootloader_mode
Funktions ID:

236

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

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

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
BrickletNFC.set_write_firmware_pointer
Funktions ID:

237

Anfrage:
  • pointer -- uint32
Antwort:

keine Antwort

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.

BrickletNFC.write_firmware
Funktions ID:

238

Anfrage:
  • data -- uint8[64]
Antwort:
  • status -- uint8

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.

BrickletNFC.set_status_led_config
Funktions ID:

239

Anfrage:
  • config -- uint8
Antwort:

keine Antwort

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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletNFC.get_status_led_config
Funktions ID:

240

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

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

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletNFC.get_chip_temperature
Funktions ID:

242

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

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.

BrickletNFC.reset
Funktions ID:243
Anfrage:keine Nutzdaten
Antwort:keine Antwort

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.

BrickletNFC.write_uid
Funktions ID:

248

Anfrage:
  • uid -- uint32
Antwort:

keine Antwort

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.

BrickletNFC.read_uid
Funktions ID:

249

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- uint32

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

BrickletNFC.get_identity
Funktions ID:

255

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

BrickletNFC.CALLBACK_READER_STATE_CHANGED
Funktions ID:

13

Antwort:
  • state -- uint8
  • 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: initialization, für state
  • 128: idle, für state
  • 192: error, für state
  • 2: request tag id, für state
  • 130: request tag id ready, für state
  • 194: request tag id error, für state
  • 3: authenticate mifare classic page, für state
  • 131: authenticate mifare classic page ready, für state
  • 195: authenticate mifare classic page error, für state
  • 4: write page, für state
  • 132: write page ready, für state
  • 196: write page error, für state
  • 5: request page, für state
  • 133: request page ready, für state
  • 197: request page error, für state
  • 6: write ndef, für state
  • 134: write ndef ready, für state
  • 198: write ndef error, für state
  • 7: request ndef, für state
  • 135: request ndef ready, für state
  • 199: request ndef error, für state
BrickletNFC.CALLBACK_CARDEMU_STATE_CHANGED
Funktions ID:

18

Antwort:
  • state -- uint8
  • 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: initialization, für state
  • 128: idle, für state
  • 192: error, für state
  • 2: discover, für state
  • 130: discover ready, für state
  • 194: discover error, für state
  • 3: transfer ndef, für state
  • 131: transfer ndef ready, für state
  • 195: transfer ndef error, für state
BrickletNFC.CALLBACK_P2P_STATE_CHANGED
Funktions ID:

24

Antwort:
  • state -- uint8
  • 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

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