Dies ist die Beschreibung der C# 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 C# API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (ExampleScanForTags.cs)
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 | using System;
using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "XYZ"; // Change XYZ to the UID of your NFC/RFID Bricklet
private static byte currentTagType = BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC;
// Callback function for state changed callback
static void StateChangedCB(BrickletNFCRFID sender, byte state, bool idle)
{
if(state == BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY)
{
byte tagType;
byte tidLength;
byte[] tid;
sender.GetTagID(out tagType, out tidLength, out tid);
if(tidLength == 7)
{
Console.WriteLine("Found tag of type {0} with ID " +
"[{1:X} {2:X} {3:X} {4:X} {5:X} {6:X} {7:X}]",
tagType, tid[0], tid[1], tid[2], tid[3], tid[4], tid[5], tid[6]);
}
else
{
Console.WriteLine("Found tag of type {0} with ID [{1:X} {2:X} {3:X} {4:X}]",
tagType, tid[0], tid[1], tid[2], tid[3]);
}
}
// Cycle through all types
if(idle)
{
currentTagType = (byte)((currentTagType + 1) % 3);
sender.RequestTagID(currentTagType);
}
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletNFCRFID nr = new 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 StateChangedCB
nr.StateChangedCallback += StateChangedCB;
// Start scan loop
nr.RequestTagID(BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC);
Console.WriteLine("Press enter to exit");
Console.ReadLine();
ipcon.Disconnect();
}
}
|
Download (ExampleWriteReadType2.cs)
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 | using System;
using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "XYZ"; // Change XYZ to the UID of your NFC/RFID Bricklet
// Callback function for state changed callback
static void StateChangedCB(BrickletNFCRFID sender, byte state, bool idle)
{
if(state == BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY)
{
Console.WriteLine("Tag found");
// Write 16 byte to pages 5-8
byte[] dataWrite = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15};
sender.WritePage(5, dataWrite);
Console.WriteLine("Writing data...");
}
else if(state == BrickletNFCRFID.STATE_WRITE_PAGE_READY)
{
// Request pages 5-8
sender.RequestPage(5);
Console.WriteLine("Requesting data...");
}
else if(state == BrickletNFCRFID.STATE_REQUEST_PAGE_READY)
{
// Get and print pages
byte[] data = sender.GetPage();
string str = "" + data[0];
for(int i = 1; i < data.Length; i++)
{
str += " " + data[i];
}
Console.Write("Read data: [" + str + "]");
}
else if((state & (1 << 6)) == (1 << 6))
{
// All errors have bit 6 set
Console.WriteLine("Error: " + state);
}
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletNFCRFID nr = new 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 StateChangedCB
nr.StateChangedCallback += StateChangedCB;
// Select NFC Forum Type 2 tag
nr.RequestTagID(BrickletNFCRFID.TAG_TYPE_TYPE2);
Console.WriteLine("Press enter to exit");
Console.ReadLine();
ipcon.Disconnect();
}
}
|
Prinzipiell kann jede Funktion der C# Bindings, welche einen Wert zurück gibt
eine Tinkerforge.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.
Da C# nicht mehrere Rückgabewerte direkt unterstützt, wird das out
Schlüsselwort
genutzt, um mehrere Werte aus einer Funktion zurückzugeben.
Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist
Tinkerforge.*
.
Alle folgend aufgelisteten Methoden sind Thread-sicher.
BrickletNFCRFID
(string uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletNFCRFID nfcRFID = new BrickletNFCRFID("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletNFCRFID.
RequestTagID
(byte tagType)¶Parameter: |
|
---|
Um ein Tag welches sich in der nähe des NFC/RFID Bricklets befindet zu lesen oder zu schreiben muss zuerst diese Funktion mit dem erwarteten Tag Typ aufgerufen werden. Es ist kein Problem wenn der Typ nicht bekannt ist. Es ist möglich die verügbaren Tag Typen einfach nacheinander durchzutesten bis das Tag antwortet.
Aktuell werden die folgenden Tag Typen unterstützt:
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.
GetTagID
(out byte tagType, out byte tidLength, out byte[] tid)¶Ausgabeparameter: |
|
---|
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:
RequestTagID()
aufGetState()
oder StateChangedCallback
Callback)GetTagID()
aufDie folgenden Konstanten sind für diese Funktion verfügbar:
Für tagType:
BrickletNFCRFID.
GetState
(out byte state, out bool idle)¶Ausgabeparameter: |
|
---|
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.
AuthenticateMifareClassicPage
(int page, byte keyNumber, byte[] key)¶Parameter: |
|
---|
Mifare Classic Tags nutzen Authentifizierung. Wenn eine Page eines
Mifare Classic Tags gelesen oder geschrieben werden soll muss diese
zuvor Authentifiziert werden. Jede Page kann mit zwei Schlüsseln, A
(key_number
= 0) und B (key_number
= 1),
authentifiziert werden. Ein neues Mifare Classic Tag welches noch nicht
beschrieben wurde kann über Schlüssel A mit dem Standardschlüssel
[0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF]
genutzt werden.
Der Ansatz um eine Mifare Classic Page zu lesen oder zu schreiben sieht wie folgt aus:
RequestTagID()
aufGetState()
oder StateChangedCallback
Callback)GetTagID()
auf und überprüfe, ob der erwartete Tag gefunden wurde,
wenn er nicht gefunden wurde mit Schritt 1 fortfahrenAuthenticateMifareClassicPage()
mit Page und Schlüssel für die
Page aufGetState()
oder StateChangedCallback
Callback)RequestPage()
oder WritePage()
zum Lesen/Schreiben einer
Page aufDie folgenden Konstanten sind für diese Funktion verfügbar:
Für keyNumber:
BrickletNFCRFID.
WritePage
(int page, byte[] data)¶Parameter: |
|
---|
Schreibt 16 Bytes startend von der übergebenen Page. Wie viele Pages dadurch geschrieben werden hängt vom Typ des Tags ab. Die Pagegrößen verhalten sich wie folgt:
Der generelle Ansatz zum Schreiben eines Tags sieht wie folgt aus:
RequestTagID()
aufGetState()
oder StateChangedCallback
callback)GetTagID()
auf und überprüfe, ob der erwartete Tag gefunden wurde,
wenn er nicht gefunden wurde mit Schritt 1 fortfahrenWritePage()
mit der Page sowie den zu schreibenden Daten aufGetState()
oder StateChangedCallback
Callback)Wenn ein Mifare Classic Tag verwendet wird muss die Page authentifiziert
werden bevor sie geschrieben werden kann. Siehe
AuthenticateMifareClassicPage()
.
BrickletNFCRFID.
RequestPage
(int page)¶Parameter: |
|
---|
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:
Der generelle Ansatz zum Lesen eines Tags sieht wie folgt aus:
RequestTagID()
aufGetState()
oder StateChangedCallback
Callback)GetTagID()
auf und überprüfe, ob der erwartete Tag gefunden wurde,
wenn er nicht gefunden wurde mit Schritt 1 fortfahrenRequestPage()
mit der zu lesenden Page aufGetState()
oder StateChangedCallback
Callback)GetPage()
auf um die gespeicherte Page abzufragenWenn ein Mifare Classic Tag verwendet wird muss die Page authentifiziert
werden bevor sie gelesen werden kann. Siehe AuthenticateMifareClassicPage()
.
BrickletNFCRFID.
GetPage
()¶Rückgabe: |
|
---|
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.
BrickletNFCRFID.
GetIdentity
(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶Ausgabeparameter: |
|
---|
Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:
void MyCallback(BrickletNFCRFID sender, int value)
{
System.Console.WriteLine("Value: " + value);
}
nfcRFID.ExampleCallback += MyCallback;
Die verfügbaren Events 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.
StateChangedCallback
(BrickletNFCRFID sender, byte state, bool idle)¶Callback-Parameter: |
|
---|
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:
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.
BrickletNFCRFID.
GetAPIVersion
()¶Ausgabeparameter: |
|
---|
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.
BrickletNFCRFID.
GetResponseExpected
(byte functionId)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels 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.
SetResponseExpected
(byte functionId, bool responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für functionId:
BrickletNFCRFID.
SetResponseExpectedAll
(bool responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
BrickletNFCRFID.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines NFC/RFID Bricklet dar.