MATLAB/Octave - NFC/RFID Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Write Read Type2 (MATLAB)

Download (matlab_example_write_read_type2.m)

 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
function matlab_example_write_read_type2()
    global nr;

    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletNFCRFID;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your NFC/RFID Bricklet

    ipcon = IPConnection(); % Create IP connection
    nr = handle(BrickletNFCRFID(UID, ipcon), 'CallbackProperties'); % Create device object

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

    % Register state changed callback to function cb_state_changed
    set(nr, 'StateChangedCallback', @(h, e) cb_state_changed(e));

    % Select NFC Forum Type 2 tag
    nr.requestTagID(BrickletNFCRFID.TAG_TYPE_TYPE2);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for state changed callback
function cb_state_changed(e)
    global nr;
    
    if e.state == nr.STATE_REQUEST_TAG_ID_READY
        fprintf('Tag found\n');
        
        % Write 16 byte to pages 5-8
        data_write = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
        nr.writePage(5, data_write);
        fprintf('Writing data...\n');
    elseif e.state == nr.STATE_WRITE_PAGE_READY
        % Request pages 5-8
        nr.requestPage(5);
        fprintf('Requesting data...\n');
    elseif e.state == nr.STATE_REQUEST_PAGE_READY
        % Get and print pages
        data = nr.getPage();
        fprintf('Read data: [%d]\n', data);
    elseif (bitand(e.state, 64) == 64)
        % All errors have bit 6 set
        fprintf('Error: %d\n', e.state);
    end
end

Scan For Tags (MATLAB)

Download (matlab_example_scan_for_tags.m)

 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
function matlab_example_scan_for_tags()
    global nr;
    global tag_type;

    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletNFCRFID;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your NFC/RFID Bricklet

    ipcon = IPConnection(); % Create IP connection
    nr = handle(BrickletNFCRFID(UID, ipcon), 'CallbackProperties'); % Create device object
    tag_type = 0;

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

    % Register state changed callback to function cb_state_changed
    set(nr, 'StateChangedCallback', @(h, e) cb_state_changed(e));

    % Start scan loop
    nr.requestTagID(BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for state changed callback
function cb_state_changed(e)
    global nr;
    global tag_type;

    if e.state == nr.STATE_REQUEST_TAG_ID_READY
        ret = nr.getTagID();

        if ret.tidLength == 4
            fprintf('Found tag of type %d with ID [%x %x %x %x]\n', ...
                    ret.tagType, ret.tid(1), ret.tid(2), ret.tid(3), ret.tid(4));
        else
            fprintf('Found tag of type %d with ID [%x %x %x %x %x %x %x]\n', ...
                    ret.tagType, ret.tid(1), ret.tid(2), ret.tid(3), ret.tid(4), ...
                    ret.tid(5), ret.tid(6), ret.tid(7));
        end
    end

    % Cycle through all types
    if e.idle
        tag_type = mod((tag_type + 1), 3);
        nr.requestTagID(tag_type);
    end
end

Write Read Type2 (Octave)

Download (octave_example_write_read_type2.m)

 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
56
57
58
59
60
61
function octave_example_write_read_type2()
    more off;

    global nr;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your NFC/RFID Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    nr = javaObject("com.tinkerforge.BrickletNFCRFID", UID, ipcon); % Create device object

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

    % Register state changed callback to function cb_state_changed
    nr.addStateChangedCallback(@cb_state_changed);

    % Select NFC Forum Type 2 tag
    nr.requestTagID(nr.TAG_TYPE_TYPE2);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for state changed callback
function cb_state_changed(e)
    global nr;

    if java2int(e.state) == java2int(nr.STATE_REQUEST_TAG_ID_READY)
        fprintf("Tag found\n");

        % Write 16 byte to pages 5-8
        data_write = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
        nr.writePage(5, data_write);
        fprintf("Writing data...\n");
    elseif java2int(e.state) == java2int(nr.STATE_WRITE_PAGE_READY)
        % Request pages 5-8
        nr.requestPage(5);
        fprintf("Requesting data...\n");
    elseif java2int(e.state) == java2int(nr.STATE_REQUEST_PAGE_READY)
        % Get and print pages
        data = nr.getPage();
        fprintf("Read data: [%d %d %d %d %d %d %d %d %d %d %d %d %d %d %d %d]\n",
                java2int(data(1)), java2int(data(2)), java2int(data(3)), java2int(data(4)),
                java2int(data(5)), java2int(data(6)), java2int(data(7)), java2int(data(8)),
                java2int(data(9)), java2int(data(10)), java2int(data(11)), java2int(data(12)),
                java2int(data(13)), java2int(data(14)), java2int(data(15)), java2int(data(16)));
    elseif (bitand(java2int(e.state), 64) == 64)
        % All errors have bit 6 set
        fprintf("Error: %d\n", java2int(e.state));
    end
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

Scan For Tags (Octave)

Download (octave_example_scan_for_tags.m)

 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
56
57
58
59
60
61
62
function octave_example_scan_for_tags()
    more off;

    global nr;
    global tag_type;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your NFC/RFID Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    nr = javaObject("com.tinkerforge.BrickletNFCRFID", UID, ipcon); % Create device object
    tag_type = 0;

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

    % Register state changed callback to function cb_state_changed
    nr.addStateChangedCallback(@cb_state_changed);

    % Start scan loop
    nr.requestTagID(nr.TAG_TYPE_MIFARE_CLASSIC);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for state changed callback
function cb_state_changed(e)
    global nr;
    global tag_type;

    if java2int(e.state) == java2int(nr.STATE_REQUEST_TAG_ID_READY)
        ret = nr.getTagID();
        tid = ret.tid;

        if java2int(ret.tidLength) == 4
            fprintf("Found tag of type %d with ID [%02x %02x %02x %02x]\n", ...
                    java2int(ret.tagType), java2int(tid(1)), java2int(tid(2)), ...
                    java2int(tid(3)), java2int(tid(4)));
        else
            fprintf("Found tag of type %d with ID [%02x %02x %02x %02x %02x %02x %02x]\n", ...
                    java2int(ret.tagType), java2int(tid(1)), java2int(tid(2)), ...
                    java2int(tid(3)), java2int(tid(4)), java2int(tid(5)), ...
                    java2int(tid(6)), java2int(tid(7)));
        end
    end

    % Cycle through all types
    if e.idle
        tag_type = mod((tag_type + 1), 3);
        nr.requestTagID(tag_type);
    end
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

API

Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletNFCRFID(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • nfcRFID – Typ: BrickletNFCRFID

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid.

In MATLAB:

import com.tinkerforge.BrickletNFCRFID;

nfcRFID = BrickletNFCRFID("YOUR_DEVICE_UID", ipcon);

In Octave:

nfcRFID = java_new("com.tinkerforge.BrickletNFCRFID", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

void BrickletNFCRFID.requestTagID(short tagType)
Parameter:
  • tagType – Typ: short, 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 requestTagID() 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 StateChangedCallback Callback zu registrieren oder den Zustand über getState() 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 getTagID() 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 requestTagID() 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 requestTagID() muss erneut aufgerufen werden.

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

Für tagType:

  • BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC = 0
  • BrickletNFCRFID.TAG_TYPE_TYPE1 = 1
  • BrickletNFCRFID.TAG_TYPE_TYPE2 = 2
BrickletNFCRFID.TagID BrickletNFCRFID.getTagID()
Rückgabeobjekt:
  • tagType – Typ: short, Wertebereich: Siehe Konstanten
  • tidLength – Typ: short, Wertebereich: [4, 7]
  • tid – Typ: short[], Länge: 7, Wertebereich: [0 bis 255]

Gibt den Tag Typ, die Tag ID und die Länge der Tag ID (4 oder 7 Byte möglich) zurück. Diese Funktion kann nur aufgerufen werden wenn sich das Bricklet gerade in einem der Ready-Zustände befindet. Die zurückgegebene ID ist die letzte ID die durch einen Aufruf von requestTagID() gefunden wurde.

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

  1. Rufe requestTagID() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe getState() oder StateChangedCallback Callback)
  3. Rufe getTagID() auf

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

Für tagType:

  • BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC = 0
  • BrickletNFCRFID.TAG_TYPE_TYPE1 = 1
  • BrickletNFCRFID.TAG_TYPE_TYPE2 = 2
BrickletNFCRFID.State BrickletNFCRFID.getState()
Rückgabeobjekt:
  • state – Typ: short, Wertebereich: Siehe Konstanten
  • idle – Typ: boolean

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 requestPage() 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 getPage() 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:

  • BrickletNFCRFID.STATE_INITIALIZATION = 0
  • BrickletNFCRFID.STATE_IDLE = 128
  • BrickletNFCRFID.STATE_ERROR = 192
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID = 2
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY = 130
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID_ERROR = 194
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE = 3
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY = 131
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR = 195
  • BrickletNFCRFID.STATE_WRITE_PAGE = 4
  • BrickletNFCRFID.STATE_WRITE_PAGE_READY = 132
  • BrickletNFCRFID.STATE_WRITE_PAGE_ERROR = 196
  • BrickletNFCRFID.STATE_REQUEST_PAGE = 5
  • BrickletNFCRFID.STATE_REQUEST_PAGE_READY = 133
  • BrickletNFCRFID.STATE_REQUEST_PAGE_ERROR = 197
void BrickletNFCRFID.authenticateMifareClassicPage(int page, short keyNumber, short[] key)
Parameter:
  • page – Typ: int, Wertebereich: [0 bis 216 - 1]
  • keyNumber – Typ: short, Wertebereich: Siehe Konstanten
  • key – Typ: short[], Länge: 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 requestTagID() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe getState() oder StateChangedCallback Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe getTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe authenticateMifareClassicPage() mit Page und Schlüssel für die Page auf
  5. Warte auf einen Zustandswechsel auf AuthenticatingMifareClassicPageReady (siehe getState() oder StateChangedCallback Callback)
  6. Rufe requestPage() oder writePage() zum Lesen/Schreiben einer Page auf

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

Für keyNumber:

  • BrickletNFCRFID.KEY_A = 0
  • BrickletNFCRFID.KEY_B = 1
void BrickletNFCRFID.writePage(int page, short[] data)
Parameter:
  • page – Typ: int, Wertebereich: [0 bis 216 - 1]
  • data – Typ: short[], Länge: 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 requestTagID() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe getState() oder StateChangedCallback callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe getTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe writePage() mit der Page sowie den zu schreibenden Daten auf
  5. Warte auf einen Zustandswechsel auf WritePageReady (siehe getState() oder StateChangedCallback Callback)

Wenn ein Mifare Classic Tag verwendet wird muss die Page authentifiziert werden bevor sie geschrieben werden kann. Siehe authenticateMifareClassicPage().

void BrickletNFCRFID.requestPage(int page)
Parameter:
  • page – Typ: int, Wertebereich: [0 bis 216 - 1]

Liest 16 Bytes startend von der übergebenen Page und speichert sie in einem Buffer. Dieser Buffer kann mit getPage() 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 requestTagID() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe getState() oder StateChangedCallback Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe getTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe requestPage() mit der zu lesenden Page auf
  5. Warte auf einen Zustandswechsel auf RequestPageReady (siehe getState() oder StateChangedCallback Callback)
  6. Rufe getPage() auf um die gespeicherte Page abzufragen

Wenn ein Mifare Classic Tag verwendet wird muss die Page authentifiziert werden bevor sie gelesen werden kann. Siehe authenticateMifareClassicPage().

short[] BrickletNFCRFID.getPage()
Rückgabe:
  • data – Typ: short[], Länge: 16, Wertebereich: [0 bis 255]

Gibt 16 Bytes Daten aus einem internen Buffer zurück. Der Buffer kann zuvor mit spezifischen Pages über einen Aufruf von requestPage() gefüllt werden.

Fortgeschrittene Funktionen

BrickletNFCRFID.Identity BrickletNFCRFID.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. 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 wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb 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.

callback BrickletNFCRFID.StateChangedCallback
Event-Objekt:
  • state – Typ: short, Wertebereich: Siehe Konstanten
  • idle – Typ: boolean

Dieser Callback wird ausgelöst, wenn der Zustand des NFC/RFID Bricklets sich verändert. Siehe getState() 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:

  • BrickletNFCRFID.STATE_INITIALIZATION = 0
  • BrickletNFCRFID.STATE_IDLE = 128
  • BrickletNFCRFID.STATE_ERROR = 192
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID = 2
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY = 130
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID_ERROR = 194
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE = 3
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY = 131
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR = 195
  • BrickletNFCRFID.STATE_WRITE_PAGE = 4
  • BrickletNFCRFID.STATE_WRITE_PAGE_READY = 132
  • BrickletNFCRFID.STATE_WRITE_PAGE_ERROR = 196
  • BrickletNFCRFID.STATE_REQUEST_PAGE = 5
  • BrickletNFCRFID.STATE_REQUEST_PAGE_READY = 133
  • BrickletNFCRFID.STATE_REQUEST_PAGE_ERROR = 197

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addStateChangedCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeStateChangedCallback() wieder entfernt werden.

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.

short[] BrickletNFCRFID.getAPIVersion()
Rückgabeobjekt:
  • apiVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, 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.

boolean BrickletNFCRFID.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

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 setResponseExpected(). 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 functionId:

  • BrickletNFCRFID.FUNCTION_REQUEST_TAG_ID = 1
  • BrickletNFCRFID.FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
  • BrickletNFCRFID.FUNCTION_WRITE_PAGE = 5
  • BrickletNFCRFID.FUNCTION_REQUEST_PAGE = 6
void BrickletNFCRFID.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

Ä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 functionId:

  • BrickletNFCRFID.FUNCTION_REQUEST_TAG_ID = 1
  • BrickletNFCRFID.FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
  • BrickletNFCRFID.FUNCTION_WRITE_PAGE = 5
  • BrickletNFCRFID.FUNCTION_REQUEST_PAGE = 6
void BrickletNFCRFID.setResponseExpectedAll(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

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

Konstanten

int BrickletNFCRFID.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein NFC/RFID Bricklet zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

String BrickletNFCRFID.DEVICE_DISPLAY_NAME

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