JavaScript - NFC/RFID Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Scan For Tags (Node.js)

Download (ExampleScanForTags.js)

 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
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var nr = new Tinkerforge.BrickletNFCRFID(UID, ipcon); // Create device object
var tagType = 0;

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Start scan loop
        nr.requestTagID(Tinkerforge.BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC);
    }
);

// Register state changed callback
nr.on(Tinkerforge.BrickletNFCRFID.CALLBACK_STATE_CHANGED,
    // Callback function for state changed callback
    function (state, idle) {
        if(state == Tinkerforge.BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY) {
            nr.getTagID(
                function (tagType, tidLength, tid) {
                    var s = 'Found tag of type ' + tagType +
                            ' with ID [' + tid[0].toString(16);

                    for(var i = 1; i < tidLength; i++) {
                        s += ' ' + tid[i].toString(16);
                    }

                    s += ']';
                    console.log(s);
                },
                function (error) {
                    console.log('Error: ' + error);
                }
            )
        }

        // Cycle through all types
        if(idle) {
            tagType = (tagType + 1) % 3;
            nr.requestTagID(tagType);
        }
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Write Read Type 2 (Node.js)

Download (ExampleWriteReadType2.js)

 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
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var nr = new Tinkerforge.BrickletNFCRFID(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Select NFC Forum Type 2 tag
        nr.requestTagID(Tinkerforge.BrickletNFCRFID.TAG_TYPE_TYPE2);
    }
);

// Register state changed callback
nr.on(Tinkerforge.BrickletNFCRFID.CALLBACK_STATE_CHANGED,
    // Callback function for state changed callback
    function (state, idle) {
        if(state == Tinkerforge.BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY) {
            console.log('Tag found');

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

            nr.writePage(5, dataWrite);
            console.log('Writing data...');
        } else if(state == Tinkerforge.BrickletNFCRFID.STATE_WRITE_PAGE_READY) {
            // Request pages 5-8
            nr.requestPage(5);
            console.log('Requesting data...');
        } else if(state == Tinkerforge.BrickletNFCRFID.STATE_REQUEST_PAGE_READY) {
            // Get and print pages
            nr.getPage(
                function (data) {
                    var s = 'Read data: [' + data[0];

                    for(var i = 1; i < data.length; i++) {
                        s += ' ' + data[i].toString();
                    }

                    s += ']';
                    console.log(s);
                }
            );
        } else if((state & (1 << 6)) == (1 << 6)) {
            // All errors have bit 6 set
            console.log('Error: ' + state);
        }
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Scan For Tags (HTML)

Download (ExampleScanForTags.html), Test (ExampleScanForTags.html)

 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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>NFC/RFID Bricklet Scan For Tags Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var nr = new Tinkerforge.BrickletNFCRFID(UID, ipcon); // Create device object
                var tagType = 0;

                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Start scan loop
                        nr.requestTagID(Tinkerforge.BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC);
                    }
                );

                // Register state changed callback
                nr.on(Tinkerforge.BrickletNFCRFID.CALLBACK_STATE_CHANGED,
                    // Callback function for state changed callback
                    function (state, idle) {
                        if(state == Tinkerforge.BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY) {
                            nr.getTagID(
                                function (tagType, tidLength, tid) {
                                    var s = 'Found tag of type ' + tagType +
                                            ' with ID [' + tid[0].toString(16);

                                    for(var i = 1; i < tidLength; i++) {
                                        s += ' ' + tid[i].toString(16);
                                    }

                                    s += ']\n';
                                    textArea.value += s
                                },
                                function (error) {
                                    textArea.value += 'Error: ' + error + '\n';
                                }
                            )
                        }

                        // Cycle through all types
                        if(idle) {
                            tagType = (tagType + 1) % 3;
                            nr.requestTagID(tagType);
                        }
                    }
                );
            }
        </script>
    </body>
</html>

Write Read Type 2 (HTML)

Download (ExampleWriteReadType2.html), Test (ExampleWriteReadType2.html)

 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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>NFC/RFID Bricklet Write Read Type2 Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var nr = new Tinkerforge.BrickletNFCRFID(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Select NFC Forum Type 2 tag
                        nr.requestTagID(Tinkerforge.BrickletNFCRFID.TAG_TYPE_TYPE2);
                    }
                );

                // Register state changed callback
                nr.on(Tinkerforge.BrickletNFCRFID.CALLBACK_STATE_CHANGED,
                    // Callback function for state changed callback
                    function (state, idle) {
                        if(state == Tinkerforge.BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY) {
                            textArea.value += 'Tag found\n';

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

                            nr.writePage(5, dataWrite);
                            textArea.value += 'Writing data...\n';
                        } else if(state == Tinkerforge.BrickletNFCRFID.STATE_WRITE_PAGE_READY) {
                            // Request pages 5-8
                            nr.requestPage(5);
                            textArea.value += 'Requesting data...\n';
                        } else if(state == Tinkerforge.BrickletNFCRFID.STATE_REQUEST_PAGE_READY) {
                            // Get and print pages
                            nr.getPage(
                                function (data) {
                                    var s = 'Read data: [' + data[0];

                                    for(var i = 1; i < data.length; i++) {
                                        s += ' ' + data[i].toString();
                                    }

                                    s += ']\n';
                                    textArea.value += s;
                                }
                            );
                        } else if((state & (1 << 6)) == (1 << 6)) {
                            // All errors have bit 6 set
                            textArea.value += 'Error: ' + state + '\n';
                        }
                    }
                );
            }
        </script>
    </body>
</html>

API

Allgemein kann jede Methode der JavaScript Bindings zwei optionale Parameter haben, returnCallback und errorCallback. Dies sind benutzerdefinierte Callback-Funktionen. Der returnCallback wird aufgerufen mit den Rückgabewerten der Methode, sofern vorhanden. Der errorCallback wird im Fehlerfall mit einem Fehlercode aufgerufen. Der Fehlercode kann einer der folgenden Werte sein:

  • IPConnection.ERROR_ALREADY_CONNECTED = 11
  • IPConnection.ERROR_NOT_CONNECTED = 12
  • IPConnection.ERROR_CONNECT_FAILED = 13
  • IPConnection.ERROR_INVALID_FUNCTION_ID = 21
  • IPConnection.ERROR_TIMEOUT = 31
  • IPConnection.ERROR_INVALID_PARAMETER = 41
  • IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
  • IPConnection.ERROR_UNKNOWN_ERROR = 43
  • IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen

new BrickletNFCRFID(uid, ipcon)
Parameter:
  • uid -- string
  • ipcon -- IPConnection

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

var nfcRFID = new BrickletNFCRFID("YOUR_DEVICE_UID", ipcon)

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

BrickletNFCRFID.requestTagID(tagType[, returnCallback][, errorCallback])
Parameter:
  • tagType -- int
Callback:

undefined

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 CALLBACK_STATE_CHANGED 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:

  • BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC = 0
  • BrickletNFCRFID.TAG_TYPE_TYPE1 = 1
  • BrickletNFCRFID.TAG_TYPE_TYPE2 = 2
BrickletNFCRFID.getTagID([returnCallback][, errorCallback])
Callback:
  • tagType -- int
  • tidLength -- int
  • tid -- [int, int, ..4x.., int]

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 CALLBACK_STATE_CHANGED Callback)
  3. Rufe getTagID() auf

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

  • BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC = 0
  • BrickletNFCRFID.TAG_TYPE_TYPE1 = 1
  • BrickletNFCRFID.TAG_TYPE_TYPE2 = 2
BrickletNFCRFID.getState([returnCallback][, errorCallback])
Callback:
  • state -- int
  • idle -- 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:

  • 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
BrickletNFCRFID.authenticateMifareClassicPage(page, keyNumber, key[, returnCallback][, errorCallback])
Parameter:
  • page -- int
  • keyNumber -- int
  • key -- [int, int, ..3x.., int]
Callback:

undefined

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 CALLBACK_STATE_CHANGED 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 CALLBACK_STATE_CHANGED Callback)
  6. Rufe requestPage() oder writePage() zum Lesen/Schreiben einer Page auf

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

  • BrickletNFCRFID.KEY_A = 0
  • BrickletNFCRFID.KEY_B = 1
BrickletNFCRFID.writePage(page, data[, returnCallback][, errorCallback])
Parameter:
  • page -- int
  • data -- [int, int, ..13x.., int]
Callback:

undefined

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 CALLBACK_STATE_CHANGED 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 CALLBACK_STATE_CHANGED Callback)

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

BrickletNFCRFID.requestPage(page[, returnCallback][, errorCallback])
Parameter:
  • page -- int
Callback:

undefined

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

BrickletNFCRFID.getPage([returnCallback][, errorCallback])
Callback:
  • data -- [int, int, ..13x.., int]

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.getAPIVersion()
Rückgabetyp:[int, int, int]

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.

BrickletNFCRFID.getResponseExpected(functionId[, errorCallback])
Parameter:
  • functionId -- int
Rückgabetyp:

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.

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

BrickletNFCRFID.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameter:
  • functionId -- int
  • responseExpected -- 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

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

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

BrickletNFCRFID.getIdentity([returnCallback][, errorCallback])
Callback:
  • uid -- string
  • connectedUid -- string
  • position -- char
  • hardwareVersion -- [int, int, int]
  • firmwareVersion -- [int, int, int]
  • deviceIdentifier -- int

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.

Konfigurationsfunktionen für Callbacks

BrickletNFCRFID.on(callback_id, function)
Parameter:
  • callback_id -- int
  • function -- function

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion on() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

nfcRFID.on(BrickletNFCRFID.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten 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.

BrickletNFCRFID.CALLBACK_STATE_CHANGED
Parameter:
  • state -- int
  • idle -- 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:

  • 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

Konstanten

BrickletNFCRFID.DEVICE_IDENTIFIER

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

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

BrickletNFCRFID.DEVICE_DISPLAY_NAME

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