MATLAB/Octave - NFC Bricklet

Dies ist die Beschreibung der MATLAB/Octave API Bindings für das NFC Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des NFC Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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 nfc;

    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletNFC;

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

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

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

    % Register reader state changed callback to function cb_reader_state_changed
    set(nfc, 'ReaderStateChangedCallback', @(h, e) cb_reader_state_changed(e));

    % Enable reader mode
    nfc.setMode(BrickletNFC.MODE_READER);

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

% Callback function for reader state changed callback
function cb_reader_state_changed(e)
    import com.tinkerforge.BrickletNFC;
    global nfc;

    if e.state == BrickletNFC.READER_STATE_IDLE
        nfc.readerRequestTagID();
    elseif e.state == BrickletNFC.READER_STATE_REQUEST_TAG_ID_READY
        tag = '';
        ret = nfc.readerGetTagID();

        for i = 1:length(ret.tagID)
          tmp_tag = sprintf('0x%x', ret.tagID(i));

          if i < length(ret.tagID)
            tmp_tag = strcat(tmp_tag, " ");
          end

          tag = strcat(tag, tmp_tag);
        end

        fprintf('Found tag of type %d with ID [%s]\n', ret.tagType, tag);
    elseif e.state == BrickletNFC.READER_STATE_REQUEST_TAG_ID_ERROR
        disp('Request tag ID error');
    end
end

Emulate Ndef (MATLAB)

Download (matlab_example_emulate_ndef.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
function matlab_example_emulate_ndef()
    global nfc;
    global NDEF_URI;

    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletNFC;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your NFC Bricklet
    NDEF_URI = 'www.tinkerforge.com';

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

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

    % Register cardemu state changed callback to function cb_cardemu_state_changed
    set(nfc, 'CardemuStateChangedCallback', @(h, e) cb_cardemu_state_changed(e));

    % Enable cardemu mode
    nfc.setMode(BrickletNFC.MODE_CARDEMU);

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

% Callback function for cardemu state changed callback
function cb_cardemu_state_changed(e)
    import com.tinkerforge.BrickletNFC;
    global nfc;
    global NDEF_URI;

    if e.state == BrickletNFC.CARDEMU_STATE_IDLE
        ndef_record_uri = [];

        % Only short records are supported
        ndef_record_uri(1) = hex2dec('D1');        % MB/ME/CF/SR=1/IL/TNF
        ndef_record_uri(2) = hex2dec('01');        % TYPE LENGTH
        ndef_record_uri(3) = length(NDEF_URI) + 1; % Length
        ndef_record_uri(4) = double('U');          % Type
        ndef_record_uri(5) = hex2dec('04');        % Status

        for i = 1:length(NDEF_URI)
            ndef_record_uri(5 + i) = double(NDEF_URI(i));
        end

        nfc.cardemuWriteNDEF(ndef_record_uri);
        nfc.cardemuStartDiscovery();
    elseif e.state == BrickletNFC.CARDEMU_STATE_DISCOVER_READY
        nfc.cardemuStartTransfer(BrickletNFC.CARDEMU_TRANSFER_WRITE);
    elseif e.state == BrickletNFC.CARDEMU_STATE_DISCOVER_ERROR
        disp('Discover error');
    elseif e.state == BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF_ERROR
        disp('Transfer NDEF error');
    end
end

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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
function matlab_example_write_read_type2()
    global nfc;

    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletNFC;

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

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

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

    % Register reader state changed callback to function cb_reader_state_changed
    set(nfc, 'ReaderStateChangedCallback', @(h, e) cb_reader_state_changed(e));

    % Enable reader mode
    nfc.setMode(BrickletNFC.MODE_READER);

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

% Callback function for reader state changed callback
function cb_reader_state_changed(e)
    import com.tinkerforge.BrickletNFC;
    global nfc;

    if e.state == BrickletNFC.READER_STATE_IDLE
        nfc.readerRequestTagID();
    elseif e.state == BrickletNFC.READER_STATE_REQUEST_TAG_ID_READY
        ret = nfc.readerGetTagID();

        if ret.tagType ~= BrickletNFC.TAG_TYPE_TYPE2
            disp('Tag is not type-2');

            return;
        end

        fprintf('Found tag of type %d with ID [0x%X 0x%X 0x%X 0x%X]\n', ...
                ret.tagType, ...
                ret.tagID(1), ...
                ret.tagID(2), ...
                ret.tagID(3), ...
                ret.tagID(4));
        nfc.readerRequestPage(1, 4);
    elseif e.state == BrickletNFC.READER_STATE_REQUEST_TAG_ID_ERROR
        disp('Request tag ID error');
    elseif e.state == BrickletNFC.READER_STATE_REQUEST_PAGE_READY
        page = nfc.readerReadPage();
        fprintf('Page read: 0x%X 0x%X 0x%X 0x%X\n', ...
                page(1), ...
                page(2), ...
                page(3), ...
                page(4));
        nfc.readerWritePage(1, page);
    elseif e.state == BrickletNFC.READER_STATE_WRITE_PAGE_READY
        disp('Write page ready');
    elseif e.state == BrickletNFC.READER_STATE_REQUEST_PAGE_ERROR
        disp('Request page error');
    elseif e.state == BrickletNFC.READER_STATE_WRITE_PAGE_ERROR
        disp('Write page error');
    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
function octave_example_scan_for_tags()
    more off;

    global nfc;

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

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

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

    % Register reader state changed callback to function cb_reader_state_changed
    nfc.addReaderStateChangedCallback(@cb_reader_state_changed);

    % Enable reader mode
    nfc.setMode(nfc.MODE_READER);

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

% Callback function for reader state changed callback
function cb_reader_state_changed(e)
    global nfc;

    if e.state == nfc.READER_STATE_IDLE
        nfc.readerRequestTagID();
    elseif e.state == nfc.READER_STATE_REQUEST_TAG_ID_READY
        tag = "";
        ret = nfc.readerGetTagID();

        for i = 1:length(java_get(ret, "tagID"))
            tmp_tag = sprintf("0x%X", java_get(ret, "tagID")(i));

            if i < length(java_get(ret, "tagID"))
              tmp_tag = cstrcat(tmp_tag, " ");
            end

            tag = cstrcat(tag, tmp_tag);
        end

        fprintf("Found tag of type %d with ID [%s]\n", java_get(ret, "tagType"), tag);
    elseif e.state == nfc.READER_STATE_REQUEST_TAG_ID_ERROR
        disp("Request tag ID error");
    end
end

Emulate Ndef (Octave)

Download (octave_example_emulate_ndef.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
function octave_example_emulate_ndef()
    more off;

    global nfc;
    global NDEF_URI;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your NFC Bricklet
    NDEF_URI = "www.tinkerforge.com";

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

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

    % Register cardemu state changed callback to function cb_cardemu_state_changed
    nfc.addCardemuStateChangedCallback(@cb_cardemu_state_changed);

    % Enable cardemu mode
    nfc.setMode(nfc.MODE_CARDEMU);

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

% Callback function for cardemu state changed callback
function cb_cardemu_state_changed(e)
    global nfc;
    global NDEF_URI;

    if e.state == nfc.CARDEMU_STATE_IDLE
        ndef_record_uri = [];

        % Only short records are supported
        ndef_record_uri(1) = hex2dec('D1');        % MB/ME/CF/SR=1/IL/TNF
        ndef_record_uri(2) = hex2dec('01');        % TYPE LENGTH
        ndef_record_uri(3) = length(NDEF_URI) + 1; % Length
        ndef_record_uri(4) = double('U');          % Type
        ndef_record_uri(5) = hex2dec('04');        % Status

        for i = 1:length(NDEF_URI)
            ndef_record_uri(5 + i) = double(NDEF_URI(i));
        end

        nfc.cardemuWriteNDEF(ndef_record_uri);
        nfc.cardemuStartDiscovery();
    elseif e.state == nfc.CARDEMU_STATE_DISCOVER_READY
        nfc.cardemuStartTransfer(nfc.CARDEMU_TRANSFER_WRITE);
    elseif e.state == nfc.CARDEMU_STATE_DISCOVER_ERROR
        disp("Discover error");
    elseif e.state == nfc.CARDEMU_STATE_TRANSFER_NDEF_ERROR
        disp("Transfer NDEF error");
    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
62
63
64
65
function octave_example_write_read_type2()
    more off;

    global nfc;

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

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

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

    % Register reader state changed callback to function cb_reader_state_changed
    nfc.addReaderStateChangedCallback(@cb_reader_state_changed);

    % Enable reader mode
    nfc.setMode(nfc.MODE_READER);

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

% Callback function for reader state changed callback
function cb_reader_state_changed(e)
    global nfc;

    if e.state == nfc.READER_STATE_IDLE
        nfc.readerRequestTagID();
    elseif e.state == nfc.READER_STATE_REQUEST_TAG_ID_READY
        ret = nfc.readerGetTagID();

        if java_get(ret, "tagType") ~= nfc.TAG_TYPE_TYPE2
          disp("Tag is not type-2");

          return;
        end

        fprintf("Found tag of type %d with ID [0x%X 0x%X 0x%X 0x%X]\n", ...
                java_get(ret, "tagType"), ...
                java_get(ret, "tagID")(1), ...
                java_get(ret, "tagID")(2), ...
                java_get(ret, "tagID")(3), ...
                java_get(ret, "tagID")(4));
        nfc.readerRequestPage(1, 4);
    elseif e.state == nfc.READER_STATE_REQUEST_TAG_ID_ERROR
        disp("Request tag ID error");
    elseif e.state == nfc.READER_STATE_REQUEST_PAGE_READY
        page = nfc.readerReadPage();
        fprintf("Page read: 0x%X 0x%X 0x%X 0x%X\n", ...
                page(1), ...
                page(2), ...
                page(3), ...
                page(4));
        nfc.readerWritePage(1, page);
    elseif e.state == nfc.READER_STATE_WRITE_PAGE_READY
        disp("Write page ready");
    elseif e.state == nfc.READER_STATE_REQUEST_PAGE_ERROR
        disp("Request page error");
    elseif e.state == nfc.READER_STATE_WRITE_PAGE_ERROR
        disp("Write page error");
    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

public class BrickletNFC(String uid, IPConnection ipcon)

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

In MATLAB:

import com.tinkerforge.BrickletNFC;

nfc = BrickletNFC("YOUR_DEVICE_UID", ipcon);

In Octave:

nfc = java_new("com.tinkerforge.BrickletNFC", "YOUR_DEVICE_UID", ipcon);

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

public void setMode(int mode)

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

  • BrickletNFC.MODE_OFF = 0
  • BrickletNFC.MODE_CARDEMU = 1
  • BrickletNFC.MODE_P2P = 2
  • BrickletNFC.MODE_READER = 3
public int getMode()

Gibt den aktuellen Modus zurück, wie von setMode() gesetzt.

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

  • BrickletNFC.MODE_OFF = 0
  • BrickletNFC.MODE_CARDEMU = 1
  • BrickletNFC.MODE_P2P = 2
  • BrickletNFC.MODE_READER = 3
public void readerRequestTagID()

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 readerRequestTagID() 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 ReaderStateChangedCallback Callback zu registrieren oder den Zustand über readerGetState() 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 readerGetTagID() 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 readerRequestTagID() 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 readerRequestTagID() muss erneut aufgerufen werden.

public BrickletNFC.ReaderGetTagID readerGetTagID()

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 readerRequestTagID() gefunden wurde.

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

  1. Rufe readerRequestTagID() auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe readerGetState() oder ReaderStateChangedCallback Callback)
  3. Rufe readerGetTagID() auf

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

  • BrickletNFC.TAG_TYPE_MIFARE_CLASSIC = 0
  • BrickletNFC.TAG_TYPE_TYPE1 = 1
  • BrickletNFC.TAG_TYPE_TYPE2 = 2
  • BrickletNFC.TAG_TYPE_TYPE3 = 3
  • BrickletNFC.TAG_TYPE_TYPE4 = 4

Das zurückgegebene Objekt enthält die Public-Member-Variablen int tagType und int[] tagID.

public BrickletNFC.ReaderGetState readerGetState()

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

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 readerRequestPage() 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 readerReadPage() abgerufen werden.

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

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

  • BrickletNFC.READER_STATE_INITIALIZATION = 0
  • BrickletNFC.READER_STATE_IDLE = 128
  • BrickletNFC.READER_STATE_ERROR = 192
  • BrickletNFC.READER_STATE_REQUEST_TAG_ID = 2
  • BrickletNFC.READER_STATE_REQUEST_TAG_ID_READY = 130
  • BrickletNFC.READER_STATE_REQUEST_TAG_ID_ERROR = 194
  • BrickletNFC.READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 3
  • BrickletNFC.READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_READY = 131
  • BrickletNFC.READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_ERROR = 195
  • BrickletNFC.READER_STATE_WRITE_PAGE = 4
  • BrickletNFC.READER_STATE_WRITE_PAGE_READY = 132
  • BrickletNFC.READER_STATE_WRITE_PAGE_ERROR = 196
  • BrickletNFC.READER_STATE_REQUEST_PAGE = 5
  • BrickletNFC.READER_STATE_REQUEST_PAGE_READY = 133
  • BrickletNFC.READER_STATE_REQUEST_PAGE_ERROR = 197
  • BrickletNFC.READER_STATE_WRITE_NDEF = 6
  • BrickletNFC.READER_STATE_WRITE_NDEF_READY = 134
  • BrickletNFC.READER_STATE_WRITE_NDEF_ERROR = 198
  • BrickletNFC.READER_STATE_REQUEST_NDEF = 7
  • BrickletNFC.READER_STATE_REQUEST_NDEF_READY = 135
  • BrickletNFC.READER_STATE_REQUEST_NDEF_ERROR = 199

Das zurückgegebene Objekt enthält die Public-Member-Variablen int state und boolean idle.

public void readerWriteNDEF(int[] ndef)

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 readerRequestTagID() auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe readerGetState() oder ReaderStateChangedCallback Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe readerGetTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe readerWriteNDEF() mit der zu schreibenden NDEF Nachricht auf
  5. Warte auf einen Zustandswechsel auf ReaderWriteNDEFReady (siehe readerGetState() oder ReaderStateChangedCallback Callback)
public void readerRequestNDEF()

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 readerRequestTagID() auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe readerGetState() oder ReaderStateChangedCallback Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe readerGetTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe readerRequestNDEF() auf
  5. Warte auf einen Zustandswechsel auf ReaderRequestNDEFReady (siehe readerGetState() oder ReaderStateChangedCallback Callback)
  6. Rufe readerReadNDEF() auf um die gespeicherte NDEF Nachricht abzufragen
public int[] readerReadNDEF()

Gibt NDEF Daten aus einem internen Buffer zurück. Der Buffer kann zuvor mit einer NDEF Nachricht über einen Aufruf von readerRequestNDEF() gefüllt werden.

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

public void readerAuthenticateMifareClassicPage(int page, int keyNumber, int[] key)

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 readerRequestTagID() auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe readerGetState() oder ReaderStateChangedCallback Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe readerGetTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe readerAuthenticateMifareClassicPage() mit Page und Schlüssel für die Page auf
  5. Warte auf einen Zustandswechsel auf ReaderAuthenticatingMifareClassicPageReady (siehe readerGetState() oder ReaderStateChangedCallback Callback)
  6. Rufe readerRequestPage() oder readerWritePage() zum Lesen/Schreiben einer Page auf

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

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

  • BrickletNFC.KEY_A = 0
  • BrickletNFC.KEY_B = 1
public void readerWritePage(int page, int[] data)

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 readerRequestTagID() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe readerGetState() oder ReaderStateChangedCallback callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe readerGetTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe readerWritePage() mit der Page sowie den zu schreibenden Daten auf
  5. Warte auf einen Zustandswechsel auf ReaderWritePageReady (siehe readerGetState() oder ReaderStateChangedCallback Callback)

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

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

  • BrickletNFC.READER_WRITE_TYPE4_CAPABILITY_CONTAINER = 3
  • BrickletNFC.READER_WRITE_TYPE4_NDEF = 4
public void readerRequestPage(int page, int length)

Liest maximal 8192 Bytes beginnend von der übergebenen Page und speichert sie in einem Buffer. Dieser Buffer kann mit readerReadPage() 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 readerRequestTagID() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe readerGetState() oder ReaderStateChangedCallback Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe readerGetTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe readerRequestPage() mit der zu lesenden Page auf
  5. Warte auf einen Zustandswechsel auf ReaderRequestPageReady (siehe readerGetState() oder ReaderStateChangedCallback Callback)
  6. Rufe readerReadPage() auf um die gespeicherte Page abzufragen

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

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

  • BrickletNFC.READER_REQUEST_TYPE4_CAPABILITY_CONTAINER = 3
  • BrickletNFC.READER_REQUEST_TYPE4_NDEF = 4
public int[] readerReadPage()

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

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

public BrickletNFC.CardemuGetState cardemuGetState()

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

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 cardemuStartDiscovery() 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 Konstanten sind für diese Funktion verfügbar:

  • BrickletNFC.CARDEMU_STATE_INITIALIZATION = 0
  • BrickletNFC.CARDEMU_STATE_IDLE = 128
  • BrickletNFC.CARDEMU_STATE_ERROR = 192
  • BrickletNFC.CARDEMU_STATE_DISCOVER = 2
  • BrickletNFC.CARDEMU_STATE_DISCOVER_READY = 130
  • BrickletNFC.CARDEMU_STATE_DISCOVER_ERROR = 194
  • BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF = 3
  • BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF_READY = 131
  • BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF_ERROR = 195

Das zurückgegebene Objekt enthält die Public-Member-Variablen int state und boolean idle.

public void cardemuStartDiscovery()

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 cardemuWriteNDEF() und cardemuStartTransfer() übertragen werden.

public void cardemuWriteNDEF(int[] ndef)

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.

public void cardemuStartTransfer(int transfer)

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 cardemuWriteNDEF() 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 Konstanten sind für diese Funktion verfügbar:

  • BrickletNFC.CARDEMU_TRANSFER_ABORT = 0
  • BrickletNFC.CARDEMU_TRANSFER_WRITE = 1
public BrickletNFC.P2PGetState p2pGetState()

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

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 p2pStartDiscovery() 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 Konstanten sind für diese Funktion verfügbar:

  • BrickletNFC.P2P_STATE_INITIALIZATION = 0
  • BrickletNFC.P2P_STATE_IDLE = 128
  • BrickletNFC.P2P_STATE_ERROR = 192
  • BrickletNFC.P2P_STATE_DISCOVER = 2
  • BrickletNFC.P2P_STATE_DISCOVER_READY = 130
  • BrickletNFC.P2P_STATE_DISCOVER_ERROR = 194
  • BrickletNFC.P2P_STATE_TRANSFER_NDEF = 3
  • BrickletNFC.P2P_STATE_TRANSFER_NDEF_READY = 131
  • BrickletNFC.P2P_STATE_TRANSFER_NDEF_ERROR = 195

Das zurückgegebene Objekt enthält die Public-Member-Variablen int state und boolean idle.

public void p2pStartDiscovery()

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 p2pWriteNDEF() und p2pStartTransfer() übertragen werden.

public void p2pWriteNDEF(int[] ndef)

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.

public void p2pStartTransfer(int transfer)

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 p2pWriteNDEF() 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 p2pReadNDEF() ausgelesen werden.

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

  • BrickletNFC.P2P_TRANSFER_ABORT = 0
  • BrickletNFC.P2P_TRANSFER_WRITE = 1
  • BrickletNFC.P2P_TRANSFER_READ = 2
public int[] p2pReadNDEF()

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 p2pStartTransfer() Aufruf mit einem Lese-Transfer der P2P Zustand zu P2PTransferNDEFReady ändert.

Fortgeschrittene Funktionen

public void setDetectionLEDConfig(int config)

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

  • BrickletNFC.DETECTION_LED_CONFIG_OFF = 0
  • BrickletNFC.DETECTION_LED_CONFIG_ON = 1
  • BrickletNFC.DETECTION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletNFC.DETECTION_LED_CONFIG_SHOW_DETECTION = 3
public int getDetectionLEDConfig()

Gibt die Konfiguration zurück, wie von setDetectionLEDConfig() gesetzt.

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

  • BrickletNFC.DETECTION_LED_CONFIG_OFF = 0
  • BrickletNFC.DETECTION_LED_CONFIG_ON = 1
  • BrickletNFC.DETECTION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletNFC.DETECTION_LED_CONFIG_SHOW_DETECTION = 3
public void setMaximumTimeout(int timeout)

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

public int getMaximumTimeout()

Gibt das Timeout zurück, wie von setMaximumTimeout() gesetzt.

Neu in Version 2.0.1 (Plugin).

public int[] getAPIVersion()

Gibt die Version der API Definition (Major, Minor, Revision) 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.

public boolean getResponseExpected(int functionId)

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.

Siehe setResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

public void setResponseExpected(int functionId, boolean responseExpected)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletNFC.FUNCTION_SET_MODE = 1
  • BrickletNFC.FUNCTION_READER_REQUEST_TAG_ID = 3
  • BrickletNFC.FUNCTION_READER_WRITE_NDEF = 6
  • BrickletNFC.FUNCTION_READER_REQUEST_NDEF = 7
  • BrickletNFC.FUNCTION_READER_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 9
  • BrickletNFC.FUNCTION_READER_WRITE_PAGE = 10
  • BrickletNFC.FUNCTION_READER_REQUEST_PAGE = 11
  • BrickletNFC.FUNCTION_CARDEMU_START_DISCOVERY = 15
  • BrickletNFC.FUNCTION_CARDEMU_WRITE_NDEF = 16
  • BrickletNFC.FUNCTION_CARDEMU_START_TRANSFER = 17
  • BrickletNFC.FUNCTION_P2P_START_DISCOVERY = 20
  • BrickletNFC.FUNCTION_P2P_WRITE_NDEF = 21
  • BrickletNFC.FUNCTION_P2P_START_TRANSFER = 22
  • BrickletNFC.FUNCTION_SET_DETECTION_LED_CONFIG = 25
  • BrickletNFC.FUNCTION_SET_MAXIMUM_TIMEOUT = 27
  • BrickletNFC.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletNFC.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletNFC.FUNCTION_RESET = 243
  • BrickletNFC.FUNCTION_WRITE_UID = 248
public void setResponseExpectedAll(boolean responseExpected)

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

public BrickletNFC.SPITFPErrorCount getSPITFPErrorCount()

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.

Das zurückgegebene Objekt enthält die Public-Member-Variablen long errorCountAckChecksum, long errorCountMessageChecksum, long errorCountFrame und long errorCountOverflow.

public int setBootloaderMode(int mode)

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

  • BrickletNFC.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletNFC.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletNFC.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletNFC.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletNFC.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletNFC.BOOTLOADER_STATUS_OK = 0
  • BrickletNFC.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletNFC.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletNFC.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletNFC.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletNFC.BOOTLOADER_STATUS_CRC_MISMATCH = 5
public int getBootloaderMode()

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

  • BrickletNFC.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletNFC.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletNFC.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletNFC.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletNFC.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
public void setWriteFirmwarePointer(long pointer)

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

public int writeFirmware(int[] data)

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

public void setStatusLEDConfig(int config)

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

  • BrickletNFC.STATUS_LED_CONFIG_OFF = 0
  • BrickletNFC.STATUS_LED_CONFIG_ON = 1
  • BrickletNFC.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletNFC.STATUS_LED_CONFIG_SHOW_STATUS = 3
public int getStatusLEDConfig()

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

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

  • BrickletNFC.STATUS_LED_CONFIG_OFF = 0
  • BrickletNFC.STATUS_LED_CONFIG_ON = 1
  • BrickletNFC.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletNFC.STATUS_LED_CONFIG_SHOW_STATUS = 3
public int getChipTemperature()

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.

public void reset()

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.

public void writeUID(long uid)

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.

public long readUID()

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

public BrickletNFC.Identity getIdentity()

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, int[] hardwareVersion, int[] firmwareVersion und int deviceIdentifier.

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.

public callback BrickletNFC.ReaderStateChangedCallback
Parameter:
  • state -- int
  • idle -- boolean

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

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

  • BrickletNFC.READER_STATE_INITIALIZATION = 0
  • BrickletNFC.READER_STATE_IDLE = 128
  • BrickletNFC.READER_STATE_ERROR = 192
  • BrickletNFC.READER_STATE_REQUEST_TAG_ID = 2
  • BrickletNFC.READER_STATE_REQUEST_TAG_ID_READY = 130
  • BrickletNFC.READER_STATE_REQUEST_TAG_ID_ERROR = 194
  • BrickletNFC.READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 3
  • BrickletNFC.READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_READY = 131
  • BrickletNFC.READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_ERROR = 195
  • BrickletNFC.READER_STATE_WRITE_PAGE = 4
  • BrickletNFC.READER_STATE_WRITE_PAGE_READY = 132
  • BrickletNFC.READER_STATE_WRITE_PAGE_ERROR = 196
  • BrickletNFC.READER_STATE_REQUEST_PAGE = 5
  • BrickletNFC.READER_STATE_REQUEST_PAGE_READY = 133
  • BrickletNFC.READER_STATE_REQUEST_PAGE_ERROR = 197
  • BrickletNFC.READER_STATE_WRITE_NDEF = 6
  • BrickletNFC.READER_STATE_WRITE_NDEF_READY = 134
  • BrickletNFC.READER_STATE_WRITE_NDEF_ERROR = 198
  • BrickletNFC.READER_STATE_REQUEST_NDEF = 7
  • BrickletNFC.READER_STATE_REQUEST_NDEF_READY = 135
  • BrickletNFC.READER_STATE_REQUEST_NDEF_ERROR = 199

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

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

public callback BrickletNFC.CardemuStateChangedCallback
Parameter:
  • state -- int
  • idle -- boolean

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

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

  • BrickletNFC.CARDEMU_STATE_INITIALIZATION = 0
  • BrickletNFC.CARDEMU_STATE_IDLE = 128
  • BrickletNFC.CARDEMU_STATE_ERROR = 192
  • BrickletNFC.CARDEMU_STATE_DISCOVER = 2
  • BrickletNFC.CARDEMU_STATE_DISCOVER_READY = 130
  • BrickletNFC.CARDEMU_STATE_DISCOVER_ERROR = 194
  • BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF = 3
  • BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF_READY = 131
  • BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF_ERROR = 195

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

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

public callback BrickletNFC.P2PStateChangedCallback
Parameter:
  • state -- int
  • idle -- boolean

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

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

  • BrickletNFC.P2P_STATE_INITIALIZATION = 0
  • BrickletNFC.P2P_STATE_IDLE = 128
  • BrickletNFC.P2P_STATE_ERROR = 192
  • BrickletNFC.P2P_STATE_DISCOVER = 2
  • BrickletNFC.P2P_STATE_DISCOVER_READY = 130
  • BrickletNFC.P2P_STATE_DISCOVER_ERROR = 194
  • BrickletNFC.P2P_STATE_TRANSFER_NDEF = 3
  • BrickletNFC.P2P_STATE_TRANSFER_NDEF_READY = 131
  • BrickletNFC.P2P_STATE_TRANSFER_NDEF_ERROR = 195

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

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

Konstanten

public static final int BrickletNFC.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein NFC 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.

public static final String BrickletNFC.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines NFC Bricklet dar.