Dies ist die Beschreibung der Rust 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 Rust API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf docs.rs.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example_write_read_type2.rs)
1use std::{error::Error, io, thread};
2use tinkerforge::{ip_connection::IpConnection, nfc_rfid_bricklet::*};
3
4const HOST: &str = "localhost";
5const PORT: u16 = 4223;
6const UID: &str = "XYZ"; // Change XYZ to the UID of your NFC/RFID Bricklet.
7
8fn main() -> Result<(), Box<dyn Error>> {
9 let ipcon = IpConnection::new(); // Create IP connection.
10 let nr = NfcRfidBricklet::new(UID, &ipcon); // Create device object.
11
12 ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
13 // Don't use device before ipcon is connected.
14
15 let state_changed_receiver = nr.get_state_changed_callback_receiver();
16
17 // Spawn thread to handle received callback messages.
18 // This thread ends when the `nr` object
19 // is dropped, so there is no need for manual cleanup.
20 let nr_copy = nr.clone(); //Device objects don't implement Sync, so they can't be shared between threads (by reference). So clone the device and move the copy.
21 thread::spawn(move || {
22 for state_changed in state_changed_receiver {
23 if state_changed.state == NFC_RFID_BRICKLET_STATE_REQUEST_TAG_ID_READY {
24 println!("Tag found");
25
26 // Write 16 byte to pages 5-8
27 let data_write = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
28
29 nr_copy.write_page(5, data_write);
30 println!("Writing data...");
31 } else if state_changed.state == NFC_RFID_BRICKLET_STATE_WRITE_PAGE_READY {
32 // Request pages 5-8
33 nr_copy.request_page(5);
34 println!("Requesting data...");
35 } else if state_changed.state == NFC_RFID_BRICKLET_STATE_REQUEST_PAGE_READY {
36 // Get and print pages
37 let data = nr_copy.get_page().recv().unwrap();
38
39 println!("Read data: {:x?}", data);
40 } else if (state_changed.state & (1 << 6)) == (1 << 6) {
41 // All errors have bit 6 set
42 println!("Error: {}", state_changed.state);
43 }
44 }
45 });
46
47 // Select NFC Forum Type 2 tag
48 nr.request_tag_id(NFC_RFID_BRICKLET_TAG_TYPE_TYPE2);
49
50 println!("Press enter to exit.");
51 let mut _input = String::new();
52 io::stdin().read_line(&mut _input)?;
53 ipcon.disconnect();
54 Ok(())
55}
Um eine nicht-blockierende Verwendung zu erlauben, gibt fast jede Funktion der Rust-Bindings einen Wrapper um einen mpsc::Receiver zurück. Um das Ergebnis eines Funktionsaufrufs zu erhalten und zu blockieren, bis das Gerät die Anfrage verarbeitet hat, können die recv-Varianten des Receivers verwendet werden. Diese geben entweder das vom Gerät gesendete Ergebnis, oder einen aufgetretenen Fehler zurück.
Funktionen die direkt ein Result zurückgeben, blockieren bis das Gerät die Anfrage verarbeitet hat.
Alle folgend aufgelisteten Funktionen sind Thread-sicher, diese, die einen Receiver zurückgeben, sind Lock-frei.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Erzeugt ein neues NfcRfidBricklet-Objekt mit der eindeutigen Geräte ID uid und
fügt es der IP-Connection ip_connection hinzu:
let nfc_rfid = NfcRfidBricklet::new("YOUR_DEVICE_UID", &ip_connection);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden.
| Parameter: |
|
|---|
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 NfcRfidBricklet::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 NfcRfidBricklet::get_state_changed_callback_receiver() Callback zu
registrieren oder den Zustand über NfcRfidBricklet::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 NfcRfidBricklet::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 NfcRfidBricklet::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 NfcRfidBricklet::request_tag_id() muss erneut
aufgerufen werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für tag_type:
NFC_RFID_BRICKLET_TAG_TYPE_MIFARE_CLASSIC = 0
NFC_RFID_BRICKLET_TAG_TYPE_TYPE1 = 1
NFC_RFID_BRICKLET_TAG_TYPE_TYPE2 = 2
| Rückgabeobjekt: |
|
|---|
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
NfcRfidBricklet::request_tag_id() gefunden wurde.
Der Ansatz um die Tag ID eines Tags zu bekommen sieht wie folgt aus:
Rufe NfcRfidBricklet::request_tag_id() auf
Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe
NfcRfidBricklet::get_state() oder NfcRfidBricklet::get_state_changed_callback_receiver() Callback)
Rufe NfcRfidBricklet::get_tag_id() auf
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für tag_type:
NFC_RFID_BRICKLET_TAG_TYPE_MIFARE_CLASSIC = 0
NFC_RFID_BRICKLET_TAG_TYPE_TYPE1 = 1
NFC_RFID_BRICKLET_TAG_TYPE_TYPE2 = 2
| Rückgabeobjekt: |
|
|---|
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 NfcRfidBricklet::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 NfcRfidBricklet::get_page() abgerufen werden.
Der gleiche Ansatz kann analog für andere API Funktionen verwendet werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für state:
NFC_RFID_BRICKLET_STATE_INITIALIZATION = 0
NFC_RFID_BRICKLET_STATE_IDLE = 128
NFC_RFID_BRICKLET_STATE_ERROR = 192
NFC_RFID_BRICKLET_STATE_REQUEST_TAG_ID = 2
NFC_RFID_BRICKLET_STATE_REQUEST_TAG_ID_READY = 130
NFC_RFID_BRICKLET_STATE_REQUEST_TAG_ID_ERROR = 194
NFC_RFID_BRICKLET_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE = 3
NFC_RFID_BRICKLET_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY = 131
NFC_RFID_BRICKLET_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR = 195
NFC_RFID_BRICKLET_STATE_WRITE_PAGE = 4
NFC_RFID_BRICKLET_STATE_WRITE_PAGE_READY = 132
NFC_RFID_BRICKLET_STATE_WRITE_PAGE_ERROR = 196
NFC_RFID_BRICKLET_STATE_REQUEST_PAGE = 5
NFC_RFID_BRICKLET_STATE_REQUEST_PAGE_READY = 133
NFC_RFID_BRICKLET_STATE_REQUEST_PAGE_ERROR = 197
| Parameter: |
|
|---|
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:
Rufe NfcRfidBricklet::request_tag_id() auf
Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe NfcRfidBricklet::get_state()
oder NfcRfidBricklet::get_state_changed_callback_receiver() Callback)
Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe
NfcRfidBricklet::get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde,
wenn er nicht gefunden wurde mit Schritt 1 fortfahren
Rufe NfcRfidBricklet::authenticate_mifare_classic_page() mit Page und Schlüssel für die
Page auf
Warte auf einen Zustandswechsel auf AuthenticatingMifareClassicPageReady
(siehe NfcRfidBricklet::get_state() oder NfcRfidBricklet::get_state_changed_callback_receiver() Callback)
Rufe NfcRfidBricklet::request_page() oder NfcRfidBricklet::write_page() zum Lesen/Schreiben einer
Page auf
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für key_number:
NFC_RFID_BRICKLET_KEY_A = 0
NFC_RFID_BRICKLET_KEY_B = 1
| Parameter: |
|
|---|
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:
Rufe NfcRfidBricklet::request_tag_id() auf
Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe
NfcRfidBricklet::get_state() oder NfcRfidBricklet::get_state_changed_callback_receiver() callback)
Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe
NfcRfidBricklet::get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde,
wenn er nicht gefunden wurde mit Schritt 1 fortfahren
Rufe NfcRfidBricklet::write_page() mit der Page sowie den zu schreibenden Daten auf
Warte auf einen Zustandswechsel auf WritePageReady (siehe
NfcRfidBricklet::get_state() oder NfcRfidBricklet::get_state_changed_callback_receiver() Callback)
Wenn ein Mifare Classic Tag verwendet wird muss die Page authentifiziert
werden bevor sie geschrieben werden kann. Siehe
NfcRfidBricklet::authenticate_mifare_classic_page().
| Parameter: |
|
|---|
Liest 16 Bytes startend von der übergebenen Page und speichert sie in
einem Buffer. Dieser Buffer kann mit NfcRfidBricklet::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:
Rufe NfcRfidBricklet::request_tag_id() auf
Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe
NfcRfidBricklet::get_state() oder NfcRfidBricklet::get_state_changed_callback_receiver() Callback)
Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe
NfcRfidBricklet::get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde,
wenn er nicht gefunden wurde mit Schritt 1 fortfahren
Rufe NfcRfidBricklet::request_page() mit der zu lesenden Page auf
Warte auf einen Zustandswechsel auf RequestPageReady (siehe
NfcRfidBricklet::get_state() oder NfcRfidBricklet::get_state_changed_callback_receiver() Callback)
Rufe NfcRfidBricklet::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 NfcRfidBricklet::authenticate_mifare_classic_page().
| Rückgabe: |
|
|---|
Gibt 16 Bytes Daten aus einem internen Buffer zurück. Der Buffer
kann zuvor mit spezifischen Pages über einen Aufruf von
NfcRfidBricklet::request_page() gefüllt werden.
| Rückgabeobjekt: |
|
|---|
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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.
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.
| Event-Objekt: |
|
|---|
Receiver die mit dieser Funktion erstellt werden, empfangen State Changed-Events.
Dieser Callback wird ausgelöst, wenn der Zustand des NFC/RFID Bricklets
sich verändert. Siehe NfcRfidBricklet::get_state() für mehr Informationen
über die möglichen Zustände des Bricklets.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für state:
NFC_RFID_BRICKLET_STATE_INITIALIZATION = 0
NFC_RFID_BRICKLET_STATE_IDLE = 128
NFC_RFID_BRICKLET_STATE_ERROR = 192
NFC_RFID_BRICKLET_STATE_REQUEST_TAG_ID = 2
NFC_RFID_BRICKLET_STATE_REQUEST_TAG_ID_READY = 130
NFC_RFID_BRICKLET_STATE_REQUEST_TAG_ID_ERROR = 194
NFC_RFID_BRICKLET_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE = 3
NFC_RFID_BRICKLET_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY = 131
NFC_RFID_BRICKLET_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR = 195
NFC_RFID_BRICKLET_STATE_WRITE_PAGE = 4
NFC_RFID_BRICKLET_STATE_WRITE_PAGE_READY = 132
NFC_RFID_BRICKLET_STATE_WRITE_PAGE_ERROR = 196
NFC_RFID_BRICKLET_STATE_REQUEST_PAGE = 5
NFC_RFID_BRICKLET_STATE_REQUEST_PAGE_READY = 133
NFC_RFID_BRICKLET_STATE_REQUEST_PAGE_ERROR = 197
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
| Rückgabeobjekt: |
|
|---|
Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels NfcRfidBricklet::set_response_expected(). Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für function_id:
NFC_RFID_BRICKLET_FUNCTION_REQUEST_TAG_ID = 1
NFC_RFID_BRICKLET_FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
NFC_RFID_BRICKLET_FUNCTION_WRITE_PAGE = 5
NFC_RFID_BRICKLET_FUNCTION_REQUEST_PAGE = 6
| Parameter: |
|
|---|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für function_id:
NFC_RFID_BRICKLET_FUNCTION_REQUEST_TAG_ID = 1
NFC_RFID_BRICKLET_FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
NFC_RFID_BRICKLET_FUNCTION_WRITE_PAGE = 5
NFC_RFID_BRICKLET_FUNCTION_REQUEST_PAGE = 6
| Parameter: |
|
|---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Diese Konstante wird verwendet um ein NFC/RFID Bricklet zu identifizieren.
Die NfcRfidBricklet::get_identity() Funktion und der IpConnection::get_enumerate_callback_receiver()
Callback der IP Connection haben ein device_identifier Parameter um den Typ
des Bricks oder Bricklets anzugeben.
Diese Konstante stellt den Anzeigenamen eines NFC/RFID Bricklet dar.