Dies ist die Beschreibung der Perl 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 Perl API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example_write_read_type2.pl)
1#!/usr/bin/perl
2
3use strict;
4use Tinkerforge::IPConnection;
5use Tinkerforge::BrickletNFCRFID;
6
7use constant HOST => 'localhost';
8use constant PORT => 4223;
9use constant UID => 'XYZ'; # Change XYZ to the UID of your NFC/RFID Bricklet
10
11my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
12our $nr = Tinkerforge::BrickletNFCRFID->new(&UID, $ipcon); # Create device object
13
14# Callback subroutine for state changed callback
15sub cb_state_changed
16{
17 my ($state, $idle) = @_;
18
19 if($state == Tinkerforge::BrickletNFCRFID->STATE_REQUEST_TAG_ID_READY) {
20 print "Tag found\n";
21
22 # Write 16 byte to pages 5-8
23 my @data_write = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
24
25 $nr->write_page(5, @data_write);
26 print "Writing data...\n";
27 } elsif($state == Tinkerforge::BrickletNFCRFID->STATE_WRITE_PAGE_READY) {
28 # Request pages 5-8
29 $nr->request_page(5);
30 print "Requesting data...\n";
31 } elsif($state == Tinkerforge::BrickletNFCRFID->STATE_REQUEST_PAGE_READY) {
32 # Get and print pages
33 my @data = $nr->get_page();
34 my $s = "Read data: [" . $data[0];
35
36 for(my $i = 1; $i < scalar @data; $i++) {
37 $s = $s . " " . $data[$i];
38 }
39
40 $s = $s . "]\n";
41
42 print $s;
43 } elsif(($state & (1 << 6)) == (1 << 6)) {
44 # All errors have bit 6 set
45 print "Error: " . $state . "\n";
46 }
47}
48
49$ipcon->connect(&HOST, &PORT); # Connect to brickd
50# Don't use device before ipcon is connected
51
52# Register state changed callback to subroutine cb_state_changed
53$nr->register_callback($nr->CALLBACK_STATE_CHANGED, 'cb_state_changed');
54
55# Select NFC Forum Type 2 tag
56$nr->request_tag_id($nr->TAG_TYPE_TYPE2);
57
58print "Press key to exit\n";
59<STDIN>;
60$ipcon->disconnect();
Allgemein kann jede Subroutine der Perl Bindings Fehler als
Tinkerforge::Error Objekt mittels croak() melden. Das Objekt hat eine
get_code() und eine get_message() Subroutine. Es sind verschiedene
Fehlercodes definiert:
Error->ALREADY_CONNECTED = 11
Error->NOT_CONNECTED = 12
Error->CONNECT_FAILED = 13
Error->INVALID_FUNCTION_ID = 21
Error->TIMEOUT = 31
Error->INVALID_PARAMETER = 41
Error->FUNCTION_NOT_SUPPORTED = 42
Error->UNKNOWN_ERROR = 43
Error->STREAM_OUT_OF_SYNC = 51
Error->INVALID_UID = 61
Error->NON_ASCII_CHAR_IN_SECRET = 71
Error->WRONG_DEVICE_TYPE = 81
Error->DEVICE_REPLACED = 82
Error->WRONG_RESPONSE_LENGTH = 83
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid:
$nfc_rfid = BrickletNFCRFID->new("YOUR_DEVICE_UID", $ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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 request_tag_id() probiert das NFC/RFID Bricklet die Tag ID
eines Tags auszulesen. Nachdem dieser Prozess beendet ist ändert sich
der Zustand des Bricklets. Es ist möglich den CALLBACK_STATE_CHANGED Callback zu
registrieren oder den Zustand über get_state() zu pollen.
Wenn der Zustand auf RequestTagIDError wechselt ist ein Fehler aufgetreten.
Dies bedeutet, dass entweder kein Tag oder kein Tag vom passenden Typ gefunden
werden konnte. Wenn der Zustand auf RequestTagIDReady wechselt ist ein
kompatibles Tag gefunden worden und die Tag ID wurde gespeichert. Die
Tag ID kann nun über get_tag_id() ausgelesen werden.
Wenn sich zwei Tags gleichzeitig in der Nähe des NFC/RFID Bricklets befinden
werden diese nacheinander ausgelesen. Um ein spezifisches Tag zu selektieren
muss request_tag_id() so lange aufgerufen werden bis das korrekte Tag
gefunden wurde.
Falls sich das NFC/RFID Bricklet in einem der Error Zustände befindet
ist die Selektion aufgehoben und request_tag_id() muss erneut
aufgerufen werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $tag_type:
BrickletNFCRFID->TAG_TYPE_MIFARE_CLASSIC = 0
BrickletNFCRFID->TAG_TYPE_TYPE1 = 1
BrickletNFCRFID->TAG_TYPE_TYPE2 = 2
| Rückgabe-Array: |
|
|---|
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
request_tag_id() gefunden wurde.
Der Ansatz um die Tag ID eines Tags zu bekommen sieht wie folgt aus:
Rufe request_tag_id() auf
Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe
get_state() oder CALLBACK_STATE_CHANGED Callback)
Rufe get_tag_id() auf
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $tag_type:
BrickletNFCRFID->TAG_TYPE_MIFARE_CLASSIC = 0
BrickletNFCRFID->TAG_TYPE_TYPE1 = 1
BrickletNFCRFID->TAG_TYPE_TYPE2 = 2
| Rückgabe-Array: |
|
|---|
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 request_page() aufgerufen wird, änder sich der
Zustand zu RequestPage solange der Leseprozess noch nicht abgeschlossen
ist. Danach ändert sich der Zustand zu RequestPageReady wenn das lesen
funktioniert hat oder zu RequestPageError wenn nicht. Wenn die Anfrage
erfolgreich war kann die Page mit get_page() abgerufen werden.
Der gleiche Ansatz kann analog für andere API Funktionen verwendet werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $state:
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
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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:
Rufe request_tag_id() auf
Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe get_state()
oder CALLBACK_STATE_CHANGED Callback)
Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe
get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde,
wenn er nicht gefunden wurde mit Schritt 1 fortfahren
Rufe authenticate_mifare_classic_page() mit Page und Schlüssel für die
Page auf
Warte auf einen Zustandswechsel auf AuthenticatingMifareClassicPageReady
(siehe get_state() oder CALLBACK_STATE_CHANGED Callback)
Rufe request_page() oder write_page() zum Lesen/Schreiben einer
Page auf
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $key_number:
BrickletNFCRFID->KEY_A = 0
BrickletNFCRFID->KEY_B = 1
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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:
Rufe request_tag_id() auf
Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe
get_state() oder CALLBACK_STATE_CHANGED callback)
Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe
get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde,
wenn er nicht gefunden wurde mit Schritt 1 fortfahren
Rufe write_page() mit der Page sowie den zu schreibenden Daten auf
Warte auf einen Zustandswechsel auf WritePageReady (siehe
get_state() oder CALLBACK_STATE_CHANGED Callback)
Wenn ein Mifare Classic Tag verwendet wird muss die Page authentifiziert
werden bevor sie geschrieben werden kann. Siehe
authenticate_mifare_classic_page().
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Liest 16 Bytes startend von der übergebenen Page und speichert sie in
einem Buffer. Dieser Buffer kann mit get_page() ausgelesen werden.
Wie viele Pages dadurch gelesen werden hängt vom Typ des Tags ab.
Die Pagegrößen verhalten sich wie folgt:
Mifare Classic Pagegröße: 16 byte (eine Page wird gelesen)
NFC Forum Type 1 Pagegröße: 8 byte (zwei Pages werden gelesen)
NFC Forum Type 2 Pagegröße: 4 byte (vier Pages werden gelesen)
Der generelle Ansatz zum Lesen eines Tags sieht wie folgt aus:
Rufe request_tag_id() auf
Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe
get_state() oder CALLBACK_STATE_CHANGED Callback)
Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe
get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde,
wenn er nicht gefunden wurde mit Schritt 1 fortfahren
Rufe request_page() mit der zu lesenden Page auf
Warte auf einen Zustandswechsel auf RequestPageReady (siehe
get_state() oder CALLBACK_STATE_CHANGED Callback)
Rufe get_page() auf um die gespeicherte Page abzufragen
Wenn ein Mifare Classic Tag verwendet wird muss die Page authentifiziert
werden bevor sie gelesen werden kann. Siehe authenticate_mifare_classic_page().
| Rückgabe: |
|
|---|
Gibt 16 Bytes Daten aus einem internen Buffer zurück. Der Buffer
kann zuvor mit spezifischen Pages über einen Aufruf von
request_page() gefüllt werden.
| Rückgabe-Array: |
|
|---|
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 kann
mit der Funktion register_callback() des
Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID
und der zweite Parameter ist der Name der Callback-Funktion:
sub my_callback
{
print "@_[0]";
}
$nfc_rfid->register_callback(BrickletNFCRFID->CALLBACK_EXAMPLE, 'my_callback')
Die Callback Funktion wird dann von einem internen Thread der IP Connection
aufgerufen werden. Im Gegensatz zu vielen anderen Programmiersprachen werden
Variablen nicht automatisch zwischen Threads geteilt. Wenn eine Variable
gleichzeitig in einer Callback Funktion und dem Rest des Programms genutzt
werden soll, dann muss diese als :shared markiert werden. Siehe dazu auch
die Dokumentation des threads::shared Perl Moduls für weitere
Details.
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.
| Callback-Parameter: |
|
|---|
Dieser Callback wird ausgelöst, wenn der Zustand des NFC/RFID Bricklets
sich verändert. Siehe get_state() für mehr Informationen
über die möglichen Zustände des Bricklets.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $state:
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
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.
| Rückgabe-Array: |
|
|---|
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.
| 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 set_response_expected(). Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $function_id:
BrickletNFCRFID->FUNCTION_REQUEST_TAG_ID = 1
BrickletNFCRFID->FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
BrickletNFCRFID->FUNCTION_WRITE_PAGE = 5
BrickletNFCRFID->FUNCTION_REQUEST_PAGE = 6
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $function_id:
BrickletNFCRFID->FUNCTION_REQUEST_TAG_ID = 1
BrickletNFCRFID->FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
BrickletNFCRFID->FUNCTION_WRITE_PAGE = 5
BrickletNFCRFID->FUNCTION_REQUEST_PAGE = 6
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Diese Konstante wird verwendet um ein NFC/RFID Bricklet zu identifizieren.
Die get_identity() Funktion und der
IPConnection->CALLBACK_ENUMERATE
Callback der IP Connection haben ein device_identifier Parameter um den Typ
des Bricks oder Bricklets anzugeben.
Diese Konstante stellt den Anzeigenamen eines NFC/RFID Bricklet dar.