Go - NFC/RFID Bricklet

Dies ist die Beschreibung der Go 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 Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Scan For Tags

Download (example_scan_for_tags.go)

 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/nfc_rfid_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your NFC/RFID Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    nr, _ := nfc_rfid_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    currentTagType := nfc_rfid_bricklet.TagTypeMifareClassic

    nr.RegisterStateChangedCallback(func(state nfc_rfid_bricklet.State, idle bool) {
        if idle {
            currentTagType = (currentTagType + 1) % 3
            nr.RequestTagID(currentTagType)
        }
        if state == nfc_rfid_bricklet.StateRequestTagIDReady {
            tagType, IDLength, tagID, _ := nr.GetTagID()
            fmt.Printf("Found tag of type %d with ID %v\n", tagType, tagID[:IDLength])
        }
    })

    // Start scan loop
    nr.RequestTagID(nfc_rfid_bricklet.TagTypeMifareClassic)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Write Read Type2

Download (example_write_read_type2.go)

 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/nfc_rfid_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your NFC/RFID Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    nr, _ := nfc_rfid_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    nr.RegisterStateChangedCallback(func(state nfc_rfid_bricklet.State, idle bool) {
        if state == nfc_rfid_bricklet.StateRequestTagIDReady {
            fmt.Println("Tag found")

            dataWrite := [16]uint8{0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15}
            nr.WritePage(5, dataWrite)
            fmt.Println("Writing data...")
        } else if state == nfc_rfid_bricklet.StateWritePageReady {
            nr.RequestPage(5)
            fmt.Println("Requesting data...")
        } else if state == nfc_rfid_bricklet.StateRequestPageReady {
            data, _ := nr.GetPage()
            fmt.Printf("Read data: %v\n", data)
        } else if state&(1<<6) == (1 << 6) {
            fmt.Printf("Error: %v\n", state)
        }
    })

    // Select NFC Forum Type 2 tag
    nr.RequestTagID(nfc_rfid_bricklet.TagTypeType2)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

Die API des NFC/RFID Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/nfc_rfid_bricklet definiert.

Fast alle Funktionen der Go Bindings können einen DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

  • DeviceErrorSuccess = 0
  • DeviceErrorInvalidParameter = 1
  • DeviceErrorFunctionNotSupported = 2
  • DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func nfc_rfid_bricklet.New(uid string, ipcon *IPConnection) (device NFCRFIDBricklet, err error)

Erzeugt ein neues NFCRFIDBricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := nfc_rfid_bricklet.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*NFCRFIDBricklet) RequestTagID(tagType TagType) (err error)

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

  • nfc_rfid_bricklet.TagTypeMifareClassic = 0
  • nfc_rfid_bricklet.TagTypeType1 = 1
  • nfc_rfid_bricklet.TagTypeType2 = 2
func (*NFCRFIDBricklet) GetTagID() (tagType TagType, tidLength uint8, tid [7]uint8, err error)

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 RegisterStateChangedCallback Callback)
  3. Rufe GetTagID() auf

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

  • nfc_rfid_bricklet.TagTypeMifareClassic = 0
  • nfc_rfid_bricklet.TagTypeType1 = 1
  • nfc_rfid_bricklet.TagTypeType2 = 2
func (*NFCRFIDBricklet) GetState() (state State, idle bool, err error)

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:

  • nfc_rfid_bricklet.StateInitialization = 0
  • nfc_rfid_bricklet.StateIdle = 128
  • nfc_rfid_bricklet.StateError = 192
  • nfc_rfid_bricklet.StateRequestTagID = 2
  • nfc_rfid_bricklet.StateRequestTagIDReady = 130
  • nfc_rfid_bricklet.StateRequestTagIDError = 194
  • nfc_rfid_bricklet.StateAuthenticatingMifareClassicPage = 3
  • nfc_rfid_bricklet.StateAuthenticatingMifareClassicPageReady = 131
  • nfc_rfid_bricklet.StateAuthenticatingMifareClassicPageError = 195
  • nfc_rfid_bricklet.StateWritePage = 4
  • nfc_rfid_bricklet.StateWritePageReady = 132
  • nfc_rfid_bricklet.StateWritePageError = 196
  • nfc_rfid_bricklet.StateRequestPage = 5
  • nfc_rfid_bricklet.StateRequestPageReady = 133
  • nfc_rfid_bricklet.StateRequestPageError = 197
func (*NFCRFIDBricklet) AuthenticateMifareClassicPage(page uint16, keyNumber Key, key [6]uint8) (err error)

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 RegisterStateChangedCallback 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 RegisterStateChangedCallback Callback)
  6. Rufe RequestPage() oder WritePage() zum Lesen/Schreiben einer Page auf

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

  • nfc_rfid_bricklet.KeyA = 0
  • nfc_rfid_bricklet.KeyB = 1
func (*NFCRFIDBricklet) WritePage(page uint16, data [16]uint8) (err error)

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

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

func (*NFCRFIDBricklet) RequestPage(page uint16) (err error)

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

func (*NFCRFIDBricklet) GetPage() (data [16]uint8, err error)

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

func (*NFCRFIDBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)

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.

func (*NFCRFIDBricklet) GetResponseExpected(functionId Function) (responseExpected bool, err error)

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:

  • nfc_rfid_bricklet.FunctionRequestTagID = 1
  • nfc_rfid_bricklet.FunctionAuthenticateMifareClassicPage = 4
  • nfc_rfid_bricklet.FunctionWritePage = 5
  • nfc_rfid_bricklet.FunctionRequestPage = 6
func (*NFCRFIDBricklet) SetResponseExpected(functionId Function, responseExpected bool) (err error)

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

  • nfc_rfid_bricklet.FunctionRequestTagID = 1
  • nfc_rfid_bricklet.FunctionAuthenticateMifareClassicPage = 4
  • nfc_rfid_bricklet.FunctionWritePage = 5
  • nfc_rfid_bricklet.FunctionRequestPage = 6
func (*NFCRFIDBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*NFCRFIDBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

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.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden Register*Callback-Function durchgeführt werden, welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback später deregistriert werden.

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.

func (*NFCRFIDBricklet) RegisterStateChangedCallback(func(state State, idle bool)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterStateChangedCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterStateChangedCallback(registrationId uint64) wieder entfernt werden.

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:

  • nfc_rfid_bricklet.StateInitialization = 0
  • nfc_rfid_bricklet.StateIdle = 128
  • nfc_rfid_bricklet.StateError = 192
  • nfc_rfid_bricklet.StateRequestTagID = 2
  • nfc_rfid_bricklet.StateRequestTagIDReady = 130
  • nfc_rfid_bricklet.StateRequestTagIDError = 194
  • nfc_rfid_bricklet.StateAuthenticatingMifareClassicPage = 3
  • nfc_rfid_bricklet.StateAuthenticatingMifareClassicPageReady = 131
  • nfc_rfid_bricklet.StateAuthenticatingMifareClassicPageError = 195
  • nfc_rfid_bricklet.StateWritePage = 4
  • nfc_rfid_bricklet.StateWritePageReady = 132
  • nfc_rfid_bricklet.StateWritePageError = 196
  • nfc_rfid_bricklet.StateRequestPage = 5
  • nfc_rfid_bricklet.StateRequestPageReady = 133
  • nfc_rfid_bricklet.StateRequestPageError = 197

Konstanten

nfc_rfid_bricklet.DeviceIdentifier

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

Die GetIdentity() Funktion und der (*IPConnection) RegisterEnumerateCallback Callback der IPConnection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

nfc_rfid_bricklet.DeviceDisplayName

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