Dies ist die Beschreibung der PHP 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 PHP API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (ExampleScanForTags.php)
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 | <?php
require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletNFCRFID.php');
use Tinkerforge\IPConnection;
use Tinkerforge\BrickletNFCRFID;
const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your NFC/RFID Bricklet
$tag_type = 0;
// Callback function for state changed callback
function cb_stateChanged($state, $idle, $user_data)
{
$nr = $user_data;
if($state == BrickletNFCRFID::STATE_REQUEST_TAG_ID_READY) {
$ret = $nr->getTagID();
echo "Found tag of type " . $ret["tag_type"] . " with ID [" . dechex($ret["tid"][0]);
for($i = 1; $i < $ret["tid_length"]; $i++) {
echo " " . dechex($ret["tid"][$i]);
}
echo "]\n";
}
// Cycle through all types
if($idle) {
global $tag_type;
$tag_type = ($tag_type + 1) % 3;
$nr->requestTagID($tag_type);
}
}
$ipcon = new IPConnection(); // Create IP connection
$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 cb_stateChanged
$nr->registerCallback(BrickletNFCRFID::CALLBACK_STATE_CHANGED, 'cb_stateChanged', $nr);
// Start scan loop
$nr->requestTagID(BrickletNFCRFID::TAG_TYPE_MIFARE_CLASSIC);
echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever
?>
|
Download (ExampleWriteReadType2.php)
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 | <?php
require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletNFCRFID.php');
use Tinkerforge\IPConnection;
use Tinkerforge\BrickletNFCRFID;
const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your NFC/RFID Bricklet
// Callback function for state changed callback
function cb_stateChanged($state, $idle, $user_data)
{
$nr = $user_data;
if($state == BrickletNFCRFID::STATE_REQUEST_TAG_ID_READY) {
echo "Tag found\n";
// Write 16 byte to pages 5-8
$data_write = array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15);
$nr->writePage(5, $data_write);
echo "Writing data...\n";
} else if($state == BrickletNFCRFID::STATE_WRITE_PAGE_READY) {
// Request pages 5-8
$nr->requestPage(5);
echo "Requesting data...\n";
} else if($state == BrickletNFCRFID::STATE_REQUEST_PAGE_READY) {
// Get and print pages
$data = $nr->getPage();
echo "Read data: [" . $data[0];
for($i = 1; $i < count($data); $i++) {
echo " " . $data[$i];
}
echo "]\n";
} else if(($state & (1 << 6)) == (1 << 6)) {
// All errors have bit 6 set
echo "Error: " . $state . "\n";
}
}
$ipcon = new IPConnection(); // Create IP connection
$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 cb_stateChanged
$nr->registerCallback(BrickletNFCRFID::CALLBACK_STATE_CHANGED, 'cb_stateChanged', $nr);
// Select NFC Forum Type 2 tag
$nr->requestTagID(BrickletNFCRFID::TAG_TYPE_TYPE2);
echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever
?>
|
Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.
BrickletNFCRFID
(string $uid, IPConnection $ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid
:
<?php $nfc_rfid = new BrickletNFCRFID('YOUR_DEVICE_UID', $ipcon); ?>
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletNFCRFID::
requestTagID
(int $tag_type)¶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 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:
Für $tag_type:
BrickletNFCRFID::
getTagID
()¶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
requestTagID()
gefunden wurde.
Der Ansatz um die Tag ID eines Tags zu bekommen sieht wie folgt aus:
requestTagID()
aufgetState()
oder CALLBACK_STATE_CHANGED
Callback)getTagID()
aufDie folgenden Konstanten sind für diese Funktion verfügbar:
Für $tag_type:
BrickletNFCRFID::
getState
()¶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 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, int $key_number, array $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 CALLBACK_STATE_CHANGED
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 CALLBACK_STATE_CHANGED
Callback)requestPage()
oder writePage()
zum Lesen/Schreiben einer
Page aufDie folgenden Konstanten sind für diese Funktion verfügbar:
Für $key_number:
BrickletNFCRFID::
writePage
(int $page, array $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 CALLBACK_STATE_CHANGED
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 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
(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 CALLBACK_STATE_CHANGED
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 CALLBACK_STATE_CHANGED
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
()¶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.
BrickletNFCRFID::
registerCallback
(int $callback_id, callable $callback, mixed $user_data=NULL)¶Parameter: |
|
---|
Registriert die $function
für die gegebene $callback_id
. Die optionalen
$user_data
werden der Funktion als letztes Parameter mit übergeben.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der Funktion registerCallback()
des
Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID
und der zweite die Callback-Funktion:
<?php
function myCallback($param)
{
echo $param . "\n";
}
$nfc_rfid->registerCallback(BrickletNFCRFID::CALLBACK_EXAMPLE, 'myCallback');
?>
Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen 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
¶<?php void callback(int $state, bool $idle [, mixed $user_data]) ?>
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
()¶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.
BrickletNFCRFID::
getResponseExpected
(int $function_id)¶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 $function_id:
BrickletNFCRFID::
setResponseExpected
(int $function_id, bool $response_expected)¶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 $function_id:
BrickletNFCRFID::
setResponseExpectedAll
(bool $response_expected)¶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::CALLBACK_ENUMERATE
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.