Go - NFC Bricklet

Dies ist die Beschreibung der Go API Bindings für das NFC Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des NFC 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
package main

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

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

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

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

    nfc.RegisterReaderStateChangedCallback(func(state nfc_bricklet.ReaderState, idle bool) {
        if state == nfc_bricklet.ReaderStateRequestTagIDReady {
            tagID, tagType, _ := nfc.ReaderGetTagID()
            fmt.Printf("Found tag of type %d with ID %v", tagType, tagID)
        } else if state == nfc_bricklet.ReaderStateRequestTagIDError {
            fmt.Println("Request tag ID error")
        }
        if idle {
            nfc.ReaderRequestTagID()
        }
    })

    // Enable reader mode
    nfc.SetMode(nfc_bricklet.ModeReader)

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

Emulate Ndef

Download (example_emulate_ndef.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
45
46
47
package main

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

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your NFC Bricklet.
const NDEF_URI = "www.tinkerforge.com"

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

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

    nfc.RegisterCardemuStateChangedCallback(func(state nfc_bricklet.CardemuState, idle bool) {
        switch state {
        case nfc_bricklet.CardemuStateIdle:
            ndefRecordUDI := []uint8{0xd1, 0x01, uint8(len(NDEF_URI)) + 1, uint8('U'), 0x04}
            ndefRecordUDI = append(ndefRecordUDI, []byte(NDEF_URI)...)

            err := nfc.CardemuWriteNDEF(ndefRecordUDI)
            if err != nil {
                fmt.Printf("Error while writing ndef %s", err)
            }
            nfc.CardemuStartDiscovery()
        case nfc_bricklet.CardemuStateDiscoverReady:
            nfc.CardemuStartTransfer(nfc_bricklet.CardemuTransferWrite)
        case nfc_bricklet.CardemuStateDiscoverError:
            fmt.Println("Discover error")
        case nfc_bricklet.CardemuStateTransferNDEFError:
            fmt.Println("Transfer NDEF error")
        }
    })

    // Enable cardemu mode
    nfc.SetMode(nfc_bricklet.ModeCardemu)

    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
45
46
47
48
49
50
51
package main

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

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

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

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

    nfc.RegisterReaderStateChangedCallback(func(state nfc_bricklet.ReaderState, idle bool) {
        switch state {
        case nfc_bricklet.ReaderStateIdle:
            nfc.ReaderRequestTagID()
        case nfc_bricklet.ReaderStateRequestTagIDReady:
            tagID, tagType, _ := nfc.ReaderGetTagID()
            if tagType != nfc_bricklet.TagTypeType2 {
                fmt.Println("Tag is not type-2")
                return
            }

            fmt.Printf("Found tag of type %d with ID %v", tagType, tagID)
        case nfc_bricklet.ReaderStateRequestPageReady:
            page, _ := nfc.ReaderReadPage()
            fmt.Printf("Page read: % x", page)
            nfc.ReaderWritePage(1, page)
        case nfc_bricklet.ReaderStateWritePageReady:
            fmt.Println("Write page ready")
        case nfc_bricklet.ReaderStateRequestPageError:
            fmt.Println("Request page error")
        case nfc_bricklet.ReaderStateWritePageError:
            fmt.Println("Write page error")
        }
    })

    // Enable reader mode
    nfc.SetMode(nfc_bricklet.ModeReader)

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

API

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

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

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

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

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func nfc_bricklet.New(uid string, ipcon *IPConnection) (device NFCBricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: NFCBricklet
  • err – Typ: error

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

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

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

func (*NFCBricklet) SetMode(mode uint8) (err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • err – Typ: error

Setzt den Modus. Das NFC Bricklet unterstützt vier Modi:

  • Off (Aus)
  • Card Emulation (Cardemu): Emuliert einen Tag für andere Reader
  • Peer to Peer (P2P): Datenaustausch mit anderen Readern
  • Reader: Liest und schreibt Tags

Wenn der Modus geändert wird, dann rekonfiguriert das Bricklet die Hardware für den gewählten Modus. Daher können immer nur die dem Modus zugehörigen Funktionen verwendet werden. Es können also im Reader Modus nur die Reader Funktionen verwendet werden.

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

Für mode:

  • nfc_bricklet.ModeOff = 0
  • nfc_bricklet.ModeCardemu = 1
  • nfc_bricklet.ModeP2P = 2
  • nfc_bricklet.ModeReader = 3
func (*NFCBricklet) GetMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • err – Typ: error

Gibt den aktuellen Modus zurück, wie von SetMode() gesetzt.

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

Für mode:

  • nfc_bricklet.ModeOff = 0
  • nfc_bricklet.ModeCardemu = 1
  • nfc_bricklet.ModeP2P = 2
  • nfc_bricklet.ModeReader = 3
func (*NFCBricklet) ReaderRequestTagID() (err error)
Rückgabe:
  • err – Typ: error

Um ein Tag welches sich in der nähe des NFC 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 verfü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
  • NFC Forum Type 3
  • NFC Forum Type 4

Beim Aufruf von ReaderRequestTagID() versucht das NFC Bricklet die Tag ID eines Tags auszulesen. Nachdem dieser Prozess beendet ist ändert sich der Zustand des Bricklets. Es ist möglich den RegisterReaderStateChangedCallback Callback zu registrieren oder den Zustand über ReaderGetState() zu pollen.

Wenn der Zustand auf ReaderRequestTagIDError wechselt ist ein Fehler aufgetreten. Dies bedeutet, dass entweder kein Tag oder kein Tag vom passenden Typ gefunden werden konnte. Wenn der Zustand auf ReaderRequestTagIDReady wechselt ist ein kompatibles Tag gefunden worden und die Tag ID wurde gespeichert. Die Tag ID kann nun über ReaderGetTagID() ausgelesen werden.

Wenn sich zwei Tags gleichzeitig in der Nähe des NFC Bricklets befinden werden diese nacheinander ausgelesen. Um ein spezifisches Tag zu selektieren muss ReaderRequestTagID() so lange aufgerufen werden bis das korrekte Tag gefunden wurde.

Falls sich das NFC Bricklet in einem der ReaderError Zustände befindet ist die Selektion aufgehoben und ReaderRequestTagID() muss erneut aufgerufen werden.

func (*NFCBricklet) ReaderGetTagID() (tagID []uint8, tagType uint8, err error)
Rückgabe:
  • tagType – Typ: uint8, Wertebereich: Siehe Konstanten
  • tagID – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255]
  • err – Typ: error

Gibt den Tag Typ und die Tag ID zurück. Diese Funktion kann nur aufgerufen werden wenn sich das Bricklet gerade in einem der ReaderReady-Zustände befindet. Die zurückgegebene tag ID ist die letzte tag ID die durch einen Aufruf von ReaderRequestTagID() gefunden wurde.

Der Ansatz um die Tag ID eines Tags zu bekommen sieht wie folgt aus:

  1. Rufe ReaderRequestTagID() auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe ReaderGetState() oder RegisterReaderStateChangedCallback Callback)
  3. Rufe ReaderGetTagID() auf

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

Für tagType:

  • nfc_bricklet.TagTypeMifareClassic = 0
  • nfc_bricklet.TagTypeType1 = 1
  • nfc_bricklet.TagTypeType2 = 2
  • nfc_bricklet.TagTypeType3 = 3
  • nfc_bricklet.TagTypeType4 = 4
func (*NFCBricklet) ReaderGetState() (state uint8, idle bool, err error)
Rückgabe:
  • state – Typ: uint8, Wertebereich: Siehe Konstanten
  • idle – Typ: bool
  • err – Typ: error

Gibt den aktuellen Reader Zustand des NFC Bricklets aus.

Während der Startphase ist der Zustand ReaderInitialization. Die Initialisierung dauert etwa 20ms. Danach ändert sich der Zustand zu ReaderIdle.

Das Bricklet wird auch neu initialisiert wenn der Modus geändert wird, siehe SetMode().

Die Funktionen dieses Bricklets können aufgerufen werden wenn der Zustand entweder ReaderIdle ist oder einer der ReaderReady oder ReaderError-Zustände erreicht wurde.

Beispiel: Wenn ReaderRequestPage() aufgerufen wird, ändert sich der Zustand zu ReaderRequestPage solange der Leseprozess noch nicht abgeschlossen ist. Danach ändert sich der Zustand zu ReaderRequestPageReady wenn das Lesen funktioniert hat oder zu ReaderRequestPageError wenn nicht. Wenn die Anfrage erfolgreich war kann die Page mit ReaderReadPage() 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:

  • nfc_bricklet.ReaderStateInitialization = 0
  • nfc_bricklet.ReaderStateIdle = 128
  • nfc_bricklet.ReaderStateError = 192
  • nfc_bricklet.ReaderStateRequestTagID = 2
  • nfc_bricklet.ReaderStateRequestTagIDReady = 130
  • nfc_bricklet.ReaderStateRequestTagIDError = 194
  • nfc_bricklet.ReaderStateAuthenticateMifareClassicPage = 3
  • nfc_bricklet.ReaderStateAuthenticateMifareClassicPageReady = 131
  • nfc_bricklet.ReaderStateAuthenticateMifareClassicPageError = 195
  • nfc_bricklet.ReaderStateWritePage = 4
  • nfc_bricklet.ReaderStateWritePageReady = 132
  • nfc_bricklet.ReaderStateWritePageError = 196
  • nfc_bricklet.ReaderStateRequestPage = 5
  • nfc_bricklet.ReaderStateRequestPageReady = 133
  • nfc_bricklet.ReaderStateRequestPageError = 197
  • nfc_bricklet.ReaderStateWriteNDEF = 6
  • nfc_bricklet.ReaderStateWriteNDEFReady = 134
  • nfc_bricklet.ReaderStateWriteNDEFError = 198
  • nfc_bricklet.ReaderStateRequestNDEF = 7
  • nfc_bricklet.ReaderStateRequestNDEFReady = 135
  • nfc_bricklet.ReaderStateRequestNDEFError = 199
func (*NFCBricklet) ReaderWriteNDEF(ndef []uint8) (err error)
Parameter:
  • ndef – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Schreibt NDEF formatierte Daten.

Diese Funktion unterstützt aktuell NFC Forum Type 2 und 4.

Der Ansatz um eine NDEF Nachricht zu schreiben sieht wie folgt aus:

  1. Rufe ReaderRequestTagID() auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe ReaderGetState() oder RegisterReaderStateChangedCallback Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe ReaderGetTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe ReaderWriteNDEF() mit der zu schreibenden NDEF Nachricht auf
  5. Warte auf einen Zustandswechsel auf ReaderWriteNDEFReady (siehe ReaderGetState() oder RegisterReaderStateChangedCallback Callback)
func (*NFCBricklet) ReaderRequestNDEF() (err error)
Rückgabe:
  • err – Typ: error

Liest NDEF formatierten Daten von einem Tag.

Diese Funktion unterstützt aktuell NFC Forum Type 1, 2, 3 und 4.

Der Ansatz um eine NDEF Nachricht zu lesen sieht wie folgt aus:

  1. Rufe ReaderRequestTagID() auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe ReaderGetState() oder RegisterReaderStateChangedCallback Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe ReaderGetTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe ReaderRequestNDEF() auf
  5. Warte auf einen Zustandswechsel auf ReaderRequestNDEFReady (siehe ReaderGetState() oder RegisterReaderStateChangedCallback Callback)
  6. Rufe ReaderReadNDEF() auf um die gespeicherte NDEF Nachricht abzufragen
func (*NFCBricklet) ReaderReadNDEF() (ndef []uint8, err error)
Rückgabe:
  • ndef – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255]
  • err – Typ: error

Gibt NDEF Daten aus einem internen Buffer zurück. Der Buffer kann zuvor mit einer NDEF Nachricht über einen Aufruf von ReaderRequestNDEF() gefüllt werden.

func (*NFCBricklet) ReaderAuthenticateMifareClassicPage(page uint16, keyNumber uint8, key [6]uint8) (err error)
Parameter:
  • page – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • keyNumber – Typ: uint8, Wertebereich: Siehe Konstanten
  • key – Typ: [6]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: 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 neuer 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 ReaderRequestTagID() auf
  2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe ReaderGetState() oder RegisterReaderStateChangedCallback Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe ReaderGetTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe ReaderAuthenticateMifareClassicPage() mit Page und Schlüssel für die Page auf
  5. Warte auf einen Zustandswechsel auf ReaderAuthenticatingMifareClassicPageReady (siehe ReaderGetState() oder RegisterReaderStateChangedCallback Callback)
  6. Rufe ReaderRequestPage() oder ReaderWritePage() zum Lesen/Schreiben einer Page auf

Die Authentifizierung bezieht sich immer auf einen ganzen Sektor (4 Pages).

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

Für keyNumber:

  • nfc_bricklet.KeyA = 0
  • nfc_bricklet.KeyB = 1
func (*NFCBricklet) ReaderWritePage(page uint16, data []uint8) (err error)
Parameter:
  • page – Typ: uint16, Wertebereich: Siehe Konstanten
  • data – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Schreibt maximal 8192 Bytes beginnend 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
  • NFC Forum Type 1 Pagegröße: 8 byte
  • NFC Forum Type 2 Pagegröße: 4 byte
  • NFC Forum Type 3 Pagegröße: 16 byte
  • NFC Forum Type 4: Keine Pages, Page = Dateiwahl (CC oder NDEF, siehe unten)

Der generelle Ansatz zum Schreiben eines Tags sieht wie folgt aus:

  1. Rufe ReaderRequestTagID() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe ReaderGetState() oder RegisterReaderStateChangedCallback callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe ReaderGetTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe ReaderWritePage() mit der Page sowie den zu schreibenden Daten auf
  5. Warte auf einen Zustandswechsel auf ReaderWritePageReady (siehe ReaderGetState() oder RegisterReaderStateChangedCallback Callback)

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

NFC Forum Type 4 Tags sind nicht in Pages organisiert sondern Dateien. Wir unterstützten aktuell zwei Dateien: Capability Container (CC) und NDEF.

Setze Page auf 3 um CC zu wählen und auf 4 um NDEF zu wählen.

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

Für page:

  • nfc_bricklet.ReaderWriteType4CapabilityContainer = 3
  • nfc_bricklet.ReaderWriteType4NDEF = 4
func (*NFCBricklet) ReaderRequestPage(page uint16, length uint16) (err error)
Parameter:
  • page – Typ: uint16, Wertebereich: Siehe Konstanten
  • length – Typ: uint16, Wertebereich: [0 bis 8192]
Rückgabe:
  • err – Typ: error

Liest maximal 8192 Bytes beginnend von der übergebenen Page und speichert sie in einem Buffer. Dieser Buffer kann mit ReaderReadPage() 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
  • NFC Forum Type 1 Pagegröße: 8 byte
  • NFC Forum Type 2 Pagegröße: 4 byte
  • NFC Forum Type 3 Pagegröße: 16 byte
  • NFC Forum Type 4: Keine Pages, Page = Dateiwahl (CC oder NDEF, siehe unten)

Der generelle Ansatz zum Lesen eines Tags sieht wie folgt aus:

  1. Rufe ReaderRequestTagID() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe ReaderGetState() oder RegisterReaderStateChangedCallback Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe ReaderGetTagID() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe ReaderRequestPage() mit der zu lesenden Page auf
  5. Warte auf einen Zustandswechsel auf ReaderRequestPageReady (siehe ReaderGetState() oder RegisterReaderStateChangedCallback Callback)
  6. Rufe ReaderReadPage() auf um die gespeicherte Page abzufragen

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

NFC Forum Type 4 Tags sind nicht in Pages organisiert sondern Dateien. Wir unterstützten aktuell zwei Dateien: Capability Container (CC) und NDEF.

Setze Page auf 3 um CC zu wählen und auf 4 um NDEF zu wählen.

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

Für page:

  • nfc_bricklet.ReaderRequestType4CapabilityContainer = 3
  • nfc_bricklet.ReaderRequestType4NDEF = 4
func (*NFCBricklet) ReaderReadPage() (data []uint8, err error)
Rückgabe:
  • data – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255]
  • err – Typ: error

Gibt Daten aus einem internen Buffer zurück. Der Buffer kann zuvor mit spezifischen Pages über einen Aufruf von ReaderRequestPage() gefüllt werden.

func (*NFCBricklet) CardemuGetState() (state uint8, idle bool, err error)
Rückgabe:
  • state – Typ: uint8, Wertebereich: Siehe Konstanten
  • idle – Typ: bool
  • err – Typ: error

Gibt den aktuellen Cardemu-Zustand des NFC Bricklets aus.

Während der Startphase ist der Zustand CardemuInitialization. Die Initialisierung dauert etwa 20ms. Danach ändert sich der Zustand zu CardmeuIdle.

Das Bricklet wird auch neu initialisiert wenn der Modus geändert wird, siehe SetMode().

Die Funktionen dieses Bricklets können aufgerufen werden wenn der Zustand entweder CardemuIdle ist oder einer der CardemuReady oder CardemuError-Zustände erreicht wurde.

Beispiel: Wenn CardemuStartDiscovery() aufgerufen wird, änder sich der Zustand zu CardemuDiscover solange der Discover-Prozess noch nicht abgeschlossen ist. Danach ändert sich der Zustand zu CardemuDiscoverReady wenn der Discover-Prozess funktioniert hat oder zu CardemuDiscoverError wenn nicht.

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:

  • nfc_bricklet.CardemuStateInitialization = 0
  • nfc_bricklet.CardemuStateIdle = 128
  • nfc_bricklet.CardemuStateError = 192
  • nfc_bricklet.CardemuStateDiscover = 2
  • nfc_bricklet.CardemuStateDiscoverReady = 130
  • nfc_bricklet.CardemuStateDiscoverError = 194
  • nfc_bricklet.CardemuStateTransferNDEF = 3
  • nfc_bricklet.CardemuStateTransferNDEFReady = 131
  • nfc_bricklet.CardemuStateTransferNDEFError = 195
func (*NFCBricklet) CardemuStartDiscovery() (err error)
Rückgabe:
  • err – Typ: error

Startet den Discovery Prozess. Wenn diese Funktion aufgerufen wird während ein NFC Lesegerät sich in Reichweite befindet, dann wechselt der Cardemu Zustand von CardemuDiscovery nach CardemuDiscoveryReady.

Falls kein NFC Lesegerät gefunden werden kann oder während des Discovery Prozesses ein Fehler auftritt dann wechselt der Cardemu Zustand zu CardemuDiscoveryReady. In diesem Fall muss der Discovery Prozess.

Wenn der Cardemu Zustand zu CardemuDiscoveryReady wechselt kann eine NDEF Nachricht mittels CardemuWriteNDEF() und CardemuStartTransfer() übertragen werden.

func (*NFCBricklet) CardemuWriteNDEF(ndef []uint8) (err error)
Parameter:
  • ndef – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Schreibt eine NDEF Nachricht die an einen NFC Peer übertragen werden soll.

Die maximale NDEF Nachrichtengröße im Cardemu-Modus beträgt 255 Byte.

Diese Funktion kann im Cardemu-Modus jederzeit aufgerufen werden. Der interne Buffer wird nicht überschrieben solange diese Funktion nicht erneut aufgerufen oder der Modus nicht gewechselt wird.

func (*NFCBricklet) CardemuStartTransfer(transfer uint8) (err error)
Parameter:
  • transfer – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

Der Transfer einer NDEF Nachricht kann im Cardemu-Zustand CardemuDiscoveryReady gestartet werden.

Bevor ein Schreib-Transfer gestartet werden kann muss zuerst die zu übertragenden NDEF Nachricht mittels CardemuWriteNDEF() geschrieben werden.

Nach einem Aufruf dieser Funktion ändert sich der Cardemu-Zustand zu CardemuTransferNDEF. Danach ändert sich der P2P Zustand zu CardemuTransferNDEFReady wenn der Transfer erfolgreich war oder zu CardemuTransferNDEFError falls nicht.

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

Für transfer:

  • nfc_bricklet.CardemuTransferAbort = 0
  • nfc_bricklet.CardemuTransferWrite = 1
func (*NFCBricklet) P2PGetState() (state uint8, idle bool, err error)
Rückgabe:
  • state – Typ: uint8, Wertebereich: Siehe Konstanten
  • idle – Typ: bool
  • err – Typ: error

Gibt den aktuellen P2P-Zustand des NFC Bricklets aus.

Während der Startphase ist der Zustand P2PInitialization. Die Initialisierung dauert etwa 20ms. Danach ändert sich der Zustand zu P2PIdle.

Das Bricklet wird auch neu Initialisiert wenn der Modus geändert wird, siehe SetMode().

Die Funktionen dieses Bricklets können aufgerufen werden wenn der Zustand entweder P2PIdle ist oder einer der P2PReady oder P2PError-Zustände erreicht wurde.

Beispiel: Wenn P2PStartDiscovery() aufgerufen wird, änder sich der Zustand zu P2PDiscover solange der Discover-Prozess noch nicht abgeschlossen ist. Danach ändert sich der Zustand zu P2PDiscoverReady wenn der Discover-Prozess funktioniert hat oder zu P2PDiscoverError wenn nicht.

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:

  • nfc_bricklet.P2PStateInitialization = 0
  • nfc_bricklet.P2PStateIdle = 128
  • nfc_bricklet.P2PStateError = 192
  • nfc_bricklet.P2PStateDiscover = 2
  • nfc_bricklet.P2PStateDiscoverReady = 130
  • nfc_bricklet.P2PStateDiscoverError = 194
  • nfc_bricklet.P2PStateTransferNDEF = 3
  • nfc_bricklet.P2PStateTransferNDEFReady = 131
  • nfc_bricklet.P2PStateTransferNDEFError = 195
func (*NFCBricklet) P2PStartDiscovery() (err error)
Rückgabe:
  • err – Typ: error

Startet den Discovery Prozess. Wenn diese Funktion aufgerufen wird während ein anderes NFC P2P fähiges Gerät sich in Reichweite befindet, dann wechselt der P2P Zustand von P2PDiscovery nach P2PDiscoveryReady.

Falls kein NFC P2P fähiges Gerät gefunden werden kann oder während des Discovery Prozesses ein Fehler auftritt dann wechselt der P2P Zustand zu P2PDiscoveryError. In diesem Fall muss der Discovery Prozess.

Wenn der P2P Zustand zu P2PDiscoveryReady wechselt kann eine NDEF Nachricht mittels P2PWriteNDEF() und P2PStartTransfer() übertragen werden.

func (*NFCBricklet) P2PWriteNDEF(ndef []uint8) (err error)
Parameter:
  • ndef – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Schreibt eine NDEF Nachricht die an einen NFC Peer übertragen werden soll.

Die maximale NDEF Nachrichtengröße für P2P Übertragungen beträgt 255 Byte.

Diese Funktion kann im P2P-Modus jederzeit aufgerufen werden. Der interne Buffer wird nicht überschrieben solange diese Funktion nicht erneut aufgerufen, der Modus nicht gewechselt oder über P2P eine NDEF Nachricht gelesen wird.

func (*NFCBricklet) P2PStartTransfer(transfer uint8) (err error)
Parameter:
  • transfer – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

Der Transfer einer NDEF Nachricht kann im P2P Zustand P2PDiscoveryReady gestartet werden.

Bevor ein Schreib-Transfer gestartet werden kann muss zuerst die zu übertragenden NDEF Nachricht mittels P2PWriteNDEF() geschrieben werden.

Nach einem Aufruf dieser Funktion ändert sich der P2P Zustand zu P2PTransferNDEF. Danach ändert sich der P2P Zustand zu P2PTransferNDEFReady wenn der Transfer erfolgreich war oder zu P2PTransferNDEFError falls nicht.

Ein Schreib-Transfer ist danach abgeschlossen. Bei einem Lese-Transfer kann jetzt die vom NFC Peer geschriebene NDEF Nachricht mittels P2PReadNDEF() ausgelesen werden.

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

Für transfer:

  • nfc_bricklet.P2PTransferAbort = 0
  • nfc_bricklet.P2PTransferWrite = 1
  • nfc_bricklet.P2PTransferRead = 2
func (*NFCBricklet) P2PReadNDEF() (ndef []uint8, err error)
Rückgabe:
  • ndef – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255]
  • err – Typ: error

Gibt die NDEF Nachricht zurück, die von einem NFC Peer im P2P Modus geschrieben wurde.

Die NDEF Nachricht ist bereit sobald sich nach einem P2PStartTransfer() Aufruf mit einem Lese-Transfer der P2P Zustand zu P2PTransferNDEFReady ändert.

Fortgeschrittene Funktionen

func (*NFCBricklet) SetDetectionLEDConfig(config uint8) (err error)
Parameter:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig zeigt die LED ob eine Karte/ein Lesegerät detektiert wurde.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

  • nfc_bricklet.DetectionLEDConfigOff = 0
  • nfc_bricklet.DetectionLEDConfigOn = 1
  • nfc_bricklet.DetectionLEDConfigShowHeartbeat = 2
  • nfc_bricklet.DetectionLEDConfigShowDetection = 3
func (*NFCBricklet) GetDetectionLEDConfig() (config uint8, err error)
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

Gibt die Konfiguration zurück, wie von SetDetectionLEDConfig() gesetzt.

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

Für config:

  • nfc_bricklet.DetectionLEDConfigOff = 0
  • nfc_bricklet.DetectionLEDConfigOn = 1
  • nfc_bricklet.DetectionLEDConfigShowHeartbeat = 2
  • nfc_bricklet.DetectionLEDConfigShowDetection = 3
func (*NFCBricklet) SetMaximumTimeout(timeout uint16) (err error)
Parameter:
  • timeout – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 2000
Rückgabe:
  • err – Typ: error

Setzt den maximalen Timeout.

Dies ist das globale Maximum für die internen State-Timeouts. Der korrekte Timeout hängt vom verwendeten Tag Typ ab. Zum Beispiel: Wenn ein Typ 2 Tag verwendet wird und herausgefunden werden soll ob der Tag in Reichweite des Bricklets ist, muss ReaderRequestTagID() aufgerufen werden. Der State wechselt dann entweder auf Ready oder Error (Tag gefunden/nicht gefunden).

Mit den Standardeinstellungen dauert dies ca. 2-3 Sekunden. Wenn man das maximale Timeout auf 100ms setzt reduziert sich diese zeit auf ~150-200ms. Für Typ 2 funktioniert das auch noch mit einem Timeout von 20ms (Ein Typ 2 Tag antwortet für gewöhnlich innerhalb von 10ms). Ein Typ 4 Tag benötigte bis zu 500ms in unsren Tests.

Wenn eine schnelle reaktionszeit benötigt wird, kann das Timeout entsprechend verrigert werden einen guten Wert kann man per Trial-and-Error für einen spezfiischen Tag-Typ ermitteln.

Standardmäßig nutzen wir einen sehr konservativen Timeout um sicher zu stellen das alle Tags definitiv funktionieren.

Neu in Version 2.0.1 (Plugin).

func (*NFCBricklet) GetMaximumTimeout() (timeout uint16, err error)
Rückgabe:
  • timeout – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 2000
  • err – Typ: error

Gibt das Timeout zurück, wie von SetMaximumTimeout() gesetzt.

Neu in Version 2.0.1 (Plugin).

func (*NFCBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
Rückgabe:
  • errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

func (*NFCBricklet) SetBootloaderMode(mode uint8) (status uint8, err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

  • nfc_bricklet.BootloaderModeBootloader = 0
  • nfc_bricklet.BootloaderModeFirmware = 1
  • nfc_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • nfc_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • nfc_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

Für status:

  • nfc_bricklet.BootloaderStatusOK = 0
  • nfc_bricklet.BootloaderStatusInvalidMode = 1
  • nfc_bricklet.BootloaderStatusNoChange = 2
  • nfc_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • nfc_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • nfc_bricklet.BootloaderStatusCRCMismatch = 5
func (*NFCBricklet) GetBootloaderMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

Für mode:

  • nfc_bricklet.BootloaderModeBootloader = 0
  • nfc_bricklet.BootloaderModeFirmware = 1
  • nfc_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • nfc_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • nfc_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*NFCBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
Parameter:
  • pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

Setzt den Firmware-Pointer für WriteFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

func (*NFCBricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
Parameter:
  • data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

func (*NFCBricklet) SetStatusLEDConfig(config uint8) (err error)
Parameter:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • nfc_bricklet.StatusLEDConfigOff = 0
  • nfc_bricklet.StatusLEDConfigOn = 1
  • nfc_bricklet.StatusLEDConfigShowHeartbeat = 2
  • nfc_bricklet.StatusLEDConfigShowStatus = 3
func (*NFCBricklet) GetStatusLEDConfig() (config uint8, err error)
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

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

Für config:

  • nfc_bricklet.StatusLEDConfigOff = 0
  • nfc_bricklet.StatusLEDConfigOn = 1
  • nfc_bricklet.StatusLEDConfigShowHeartbeat = 2
  • nfc_bricklet.StatusLEDConfigShowStatus = 3
func (*NFCBricklet) GetChipTemperature() (temperature int16, err error)
Rückgabe:
  • temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
  • err – Typ: error

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

func (*NFCBricklet) Reset() (err error)
Rückgabe:
  • err – Typ: error

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

func (*NFCBricklet) WriteUID(uid uint32) (err error)
Parameter:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

func (*NFCBricklet) ReadUID() (uid uint32, err error)
Rückgabe:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

func (*NFCBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

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 (*NFCBricklet) RegisterReaderStateChangedCallback(func(state uint8, idle bool)) (registrationId uint64)
Callback-Parameter:
  • state – Typ: uint8, Wertebereich: Siehe Konstanten
  • idle – Typ: bool
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn der Reader-Zustand des NFC Bricklets sich verändert. Siehe ReaderGetState() 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:

  • nfc_bricklet.ReaderStateInitialization = 0
  • nfc_bricklet.ReaderStateIdle = 128
  • nfc_bricklet.ReaderStateError = 192
  • nfc_bricklet.ReaderStateRequestTagID = 2
  • nfc_bricklet.ReaderStateRequestTagIDReady = 130
  • nfc_bricklet.ReaderStateRequestTagIDError = 194
  • nfc_bricklet.ReaderStateAuthenticateMifareClassicPage = 3
  • nfc_bricklet.ReaderStateAuthenticateMifareClassicPageReady = 131
  • nfc_bricklet.ReaderStateAuthenticateMifareClassicPageError = 195
  • nfc_bricklet.ReaderStateWritePage = 4
  • nfc_bricklet.ReaderStateWritePageReady = 132
  • nfc_bricklet.ReaderStateWritePageError = 196
  • nfc_bricklet.ReaderStateRequestPage = 5
  • nfc_bricklet.ReaderStateRequestPageReady = 133
  • nfc_bricklet.ReaderStateRequestPageError = 197
  • nfc_bricklet.ReaderStateWriteNDEF = 6
  • nfc_bricklet.ReaderStateWriteNDEFReady = 134
  • nfc_bricklet.ReaderStateWriteNDEFError = 198
  • nfc_bricklet.ReaderStateRequestNDEF = 7
  • nfc_bricklet.ReaderStateRequestNDEFReady = 135
  • nfc_bricklet.ReaderStateRequestNDEFError = 199
func (*NFCBricklet) RegisterCardemuStateChangedCallback(func(state uint8, idle bool)) (registrationId uint64)
Callback-Parameter:
  • state – Typ: uint8, Wertebereich: Siehe Konstanten
  • idle – Typ: bool
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn der Cardemu-Zustand des NFC Bricklets sich verändert. Siehe CardemuGetState() 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:

  • nfc_bricklet.CardemuStateInitialization = 0
  • nfc_bricklet.CardemuStateIdle = 128
  • nfc_bricklet.CardemuStateError = 192
  • nfc_bricklet.CardemuStateDiscover = 2
  • nfc_bricklet.CardemuStateDiscoverReady = 130
  • nfc_bricklet.CardemuStateDiscoverError = 194
  • nfc_bricklet.CardemuStateTransferNDEF = 3
  • nfc_bricklet.CardemuStateTransferNDEFReady = 131
  • nfc_bricklet.CardemuStateTransferNDEFError = 195
func (*NFCBricklet) RegisterP2PStateChangedCallback(func(state uint8, idle bool)) (registrationId uint64)
Callback-Parameter:
  • state – Typ: uint8, Wertebereich: Siehe Konstanten
  • idle – Typ: bool
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn der P2P-Zustand des NFC Bricklets sich verändert. Siehe P2PGetState() 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:

  • nfc_bricklet.P2PStateInitialization = 0
  • nfc_bricklet.P2PStateIdle = 128
  • nfc_bricklet.P2PStateError = 192
  • nfc_bricklet.P2PStateDiscover = 2
  • nfc_bricklet.P2PStateDiscoverReady = 130
  • nfc_bricklet.P2PStateDiscoverError = 194
  • nfc_bricklet.P2PStateTransferNDEF = 3
  • nfc_bricklet.P2PStateTransferNDEFReady = 131
  • nfc_bricklet.P2PStateTransferNDEFError = 195

Virtuelle Funktionen

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.

func (*NFCBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*NFCBricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool
  • err – Typ: 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:

Für functionId:

  • nfc_bricklet.FunctionSetMode = 1
  • nfc_bricklet.FunctionReaderRequestTagID = 3
  • nfc_bricklet.FunctionReaderWriteNDEF = 6
  • nfc_bricklet.FunctionReaderRequestNDEF = 7
  • nfc_bricklet.FunctionReaderAuthenticateMifareClassicPage = 9
  • nfc_bricklet.FunctionReaderWritePage = 10
  • nfc_bricklet.FunctionReaderRequestPage = 11
  • nfc_bricklet.FunctionCardemuStartDiscovery = 15
  • nfc_bricklet.FunctionCardemuWriteNDEF = 16
  • nfc_bricklet.FunctionCardemuStartTransfer = 17
  • nfc_bricklet.FunctionP2PStartDiscovery = 20
  • nfc_bricklet.FunctionP2PWriteNDEF = 21
  • nfc_bricklet.FunctionP2PStartTransfer = 22
  • nfc_bricklet.FunctionSetDetectionLEDConfig = 25
  • nfc_bricklet.FunctionSetMaximumTimeout = 27
  • nfc_bricklet.FunctionSetWriteFirmwarePointer = 237
  • nfc_bricklet.FunctionSetStatusLEDConfig = 239
  • nfc_bricklet.FunctionReset = 243
  • nfc_bricklet.FunctionWriteUID = 248
func (*NFCBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: 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:

Für functionId:

  • nfc_bricklet.FunctionSetMode = 1
  • nfc_bricklet.FunctionReaderRequestTagID = 3
  • nfc_bricklet.FunctionReaderWriteNDEF = 6
  • nfc_bricklet.FunctionReaderRequestNDEF = 7
  • nfc_bricklet.FunctionReaderAuthenticateMifareClassicPage = 9
  • nfc_bricklet.FunctionReaderWritePage = 10
  • nfc_bricklet.FunctionReaderRequestPage = 11
  • nfc_bricklet.FunctionCardemuStartDiscovery = 15
  • nfc_bricklet.FunctionCardemuWriteNDEF = 16
  • nfc_bricklet.FunctionCardemuStartTransfer = 17
  • nfc_bricklet.FunctionP2PStartDiscovery = 20
  • nfc_bricklet.FunctionP2PWriteNDEF = 21
  • nfc_bricklet.FunctionP2PStartTransfer = 22
  • nfc_bricklet.FunctionSetDetectionLEDConfig = 25
  • nfc_bricklet.FunctionSetMaximumTimeout = 27
  • nfc_bricklet.FunctionSetWriteFirmwarePointer = 237
  • nfc_bricklet.FunctionSetStatusLEDConfig = 239
  • nfc_bricklet.FunctionReset = 243
  • nfc_bricklet.FunctionWriteUID = 248
func (*NFCBricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameter:
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

Konstanten

nfc_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein NFC 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_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines NFC Bricklet dar.