Rust - NFC/RFID Bricklet

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Scan For Tags

Download (example_scan_for_tags.rs)

 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
35
36
37
38
39
40
41
42
43
44
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, nfc_rfid_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your NFC/RFID Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let nr = NfcRfidBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let state_changed_receiver = nr.get_state_changed_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `nr` object
    // is dropped, so there is no need for manual cleanup.
    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.
    thread::spawn(move || {
        let mut current_tag_type = NFC_RFID_BRICKLET_TAG_TYPE_MIFARE_CLASSIC;
        for state_changed in state_changed_receiver {
            if state_changed.idle {
                current_tag_type = (current_tag_type + 1) % 3;
                nr_copy.request_tag_id(current_tag_type);
            }

            if state_changed.state == NFC_RFID_BRICKLET_STATE_REQUEST_TAG_ID_READY {
                let tag_id = nr_copy.get_tag_id().recv().unwrap();
                println!("Found tag of type {} with ID {:x?}", tag_id.tag_type, tag_id.tid[0..tag_id.tid_length as usize].to_vec());
            }
        }
    });

    // Start scan loop
    nr.request_tag_id(NFC_RFID_BRICKLET_TAG_TYPE_MIFARE_CLASSIC);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Write Read Type2

Download (example_write_read_type2.rs)

 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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, nfc_rfid_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your NFC/RFID Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let nr = NfcRfidBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let state_changed_receiver = nr.get_state_changed_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `nr` object
    // is dropped, so there is no need for manual cleanup.
    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.
    thread::spawn(move || {
        for state_changed in state_changed_receiver {
            if state_changed.state == NFC_RFID_BRICKLET_STATE_REQUEST_TAG_ID_READY {
                println!("Tag found");

                // Write 16 byte to pages 5-8
                let data_write = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];

                nr_copy.write_page(5, data_write);
                println!("Writing data...");
            } else if state_changed.state == NFC_RFID_BRICKLET_STATE_WRITE_PAGE_READY {
                // Request pages 5-8
                nr_copy.request_page(5);
                println!("Requesting data...");
            } else if state_changed.state == NFC_RFID_BRICKLET_STATE_REQUEST_PAGE_READY {
                // Get and print pages
                let data = nr_copy.get_page().recv().unwrap();

                println!("Read data: {:x?}", data);
            } else if (state_changed.state & (1 << 6)) == (1 << 6) {
                // All errors have bit 6 set
                println!("Error: {}", state_changed.state);
            }
        }
    });

    // Select NFC Forum Type 2 tag
    nr.request_tag_id(NFC_RFID_BRICKLET_TAG_TYPE_TYPE2);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API

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.

Grundfunktionen

pub fn NfcRfidBricklet::new(uid: &str, ip_connection: &IpConnection) → NfcRfidBricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • nfc_rfid – Typ: NfcRfidBricklet

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.

pub fn NfcRfidBricklet::request_tag_id(&self, tag_type: u8) → ConvertingReceiver<()>
Parameter:
  • tag_type – Typ: u8, Wertebereich: Siehe Konstanten

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
pub fn NfcRfidBricklet::get_tag_id(&self) → ConvertingReceiver<TagId>
Rückgabeobjekt:
  • tag_type – Typ: u8, Wertebereich: Siehe Konstanten
  • tid_length – Typ: u8, Wertebereich: [4, 7]
  • tid – Typ: [u8; 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 NfcRfidBricklet::request_tag_id gefunden wurde.

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

  1. Rufe NfcRfidBricklet::request_tag_id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe NfcRfidBricklet::get_state oder NfcRfidBricklet::get_state_changed_callback_receiver Callback)
  3. 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
pub fn NfcRfidBricklet::get_state(&self) → ConvertingReceiver<State>
Rückgabeobjekt:
  • state – Typ: u8, Wertebereich: Siehe Konstanten
  • 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 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
pub fn NfcRfidBricklet::authenticate_mifare_classic_page(&self, page: u16, key_number: u8, key: [u8; 6]) → ConvertingReceiver<()>
Parameter:
  • page – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • key_number – Typ: u8, Wertebereich: Siehe Konstanten
  • key – Typ: [u8; 6], Wertebereich: [0 bis 255]

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 NfcRfidBricklet::request_tag_id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe NfcRfidBricklet::get_state oder NfcRfidBricklet::get_state_changed_callback_receiver Callback)
  3. 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
  4. Rufe NfcRfidBricklet::authenticate_mifare_classic_page mit Page und Schlüssel für die Page auf
  5. Warte auf einen Zustandswechsel auf AuthenticatingMifareClassicPageReady (siehe NfcRfidBricklet::get_state oder NfcRfidBricklet::get_state_changed_callback_receiver Callback)
  6. 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
pub fn NfcRfidBricklet::write_page(&self, page: u16, data: [u8; 16]) → ConvertingReceiver<()>
Parameter:
  • page – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • data – Typ: [u8; 16], Wertebereich: [0 bis 255]

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 NfcRfidBricklet::request_tag_id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe NfcRfidBricklet::get_state oder NfcRfidBricklet::get_state_changed_callback_receiver callback)
  3. 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
  4. Rufe NfcRfidBricklet::write_page mit der Page sowie den zu schreibenden Daten auf
  5. 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.

pub fn NfcRfidBricklet::request_page(&self, page: u16) → ConvertingReceiver<()>
Parameter:
  • page – Typ: u16, Wertebereich: [0 bis 216 - 1]

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:

  1. Rufe NfcRfidBricklet::request_tag_id auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe NfcRfidBricklet::get_state oder NfcRfidBricklet::get_state_changed_callback_receiver Callback)
  3. 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
  4. Rufe NfcRfidBricklet::request_page mit der zu lesenden Page auf
  5. Warte auf einen Zustandswechsel auf RequestPageReady (siehe NfcRfidBricklet::get_state oder NfcRfidBricklet::get_state_changed_callback_receiver Callback)
  6. 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.

pub fn NfcRfidBricklet::get_page(&self) → ConvertingReceiver<[u8; 16]>
Rückgabe:
  • data – Typ: [u8; 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 NfcRfidBricklet::request_page gefüllt werden.

Fortgeschrittene Funktionen

pub fn NfcRfidBricklet::get_identity(&self) → ConvertingReceiver<Identity>
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connected_uid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
  • hardware_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: u16, 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 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

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.

pub fn NfcRfidBricklet::get_state_changed_callback_receiver(&self) → ConvertingCallbackReceiver<StateChangedEvent>
Event-Objekt:
  • state – Typ: u8, Wertebereich: Siehe Konstanten
  • idle – Typ: bool

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

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.

pub fn NfcRfidBricklet::get_api_version(&self) → [u8; 3]
Rückgabeobjekt:
  • api_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]

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.

pub fn NfcRfidBricklet::get_response_expected(&mut self, function_id: u8) → bool
Parameter:
  • function_id – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: bool

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
pub fn NfcRfidBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()
Parameter:
  • function_id – Typ: u8, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool

Ä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
pub fn NfcRfidBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()
Parameter:
  • response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

pub const NfcRfidBricklet::DEVICE_IDENTIFIER

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.

pub const NfcRfidBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines NFC/RFID Bricklet dar.