Visual Basic .NET - NFC Bricklet¶

Emulate NDEF¶

Download (ExampleEmulateNDEF.vb)

 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

Imports System
Imports Tinkerforge

Module ExampleEmulateNDEF
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your NFC Bricklet
    Const NDEF_URI As String = "www.tinkerforge.com"

    ' Callback subroutine for cardemu state changed callback
    Sub CardemuStateChangedCB(ByVal sender As BrickletNFC, ByVal state As Byte, _
                              ByVal idle As Boolean)
        If state = BrickletNFC.CARDEMU_STATE_IDLE Then
            Dim i As Integer
            Dim ndefURIBytes As Byte() = Text.Encoding.ASCII.GetBytes(NDEF_URI)
            Dim ndefRecordURI(ndefURIBytes.Length + 5) As Byte

            ndefRecordURI(0) = &HD1
            ndefRecordURI(1) = &H01
            ndefRecordURI(2) = Convert.ToByte(ndefURIBytes.Length + 1)
            ndefRecordURI(3) = Text.Encoding.ASCII.GetBytes("U")(1)
            ndefRecordURI(4) = &H04

            ' Only short records are supported
            For i = 0 To ndefURIBytes.Length - 1
                ndefRecordURI(5 + i) = ndefURIBytes(i)
            Next

            sender.CardemuWriteNDEF(ndefRecordURI)
            sender.CardemuStartDiscovery()
        ElseIf state = BrickletNFC.CARDEMU_STATE_DISCOVER_READY Then
            sender.CardemuStartTransfer(BrickletNFC.CARDEMU_TRANSFER_WRITE)
        ElseIf state = BrickletNFC.CARDEMU_STATE_DISCOVER_ERROR Then
            Console.WriteLine("Discover error")
        ElseIf state = BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF_ERROR Then
            Console.WriteLine("Transfer NDEF error")
        End If
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim nfc As New BrickletNFC(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register cardemu state changed callback to subroutine CardemuStateChangedCB
        AddHandler nfc.CardemuStateChangedCallback, AddressOf CardemuStateChangedCB

        ' Enable cardemu mode
        nfc.SetMode(BrickletNFC.MODE_CARDEMU)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Scan For Tags¶

Download (ExampleScanForTags.vb)

 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

Imports System
Imports Tinkerforge

Module ExampleScanForTags
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your NFC Bricklet

    ' Callback subroutine for reader state changed callback
    Sub ReaderStateChangedCB(ByVal sender As BrickletNFC, ByVal state As Byte, _
                             ByVal idle As Boolean)
        If state = BrickletNFC.READER_STATE_REQUEST_TAG_ID_READY Then
            Dim i As Integer
            Dim tagType As Byte
            Dim tagID() As Byte
            Dim tagInfo As String

            sender.ReaderGetTagID(tagType, tagID)

            tagInfo = String.Format("Found tag of type {0} with ID [", tagType)

            For i = 0 To tagID.Length - 1
                tagInfo += String.Format("0x{0:X2}", tagID(i))

                If i < tagID.Length - 1 Then
                    tagInfo += " "
                End If
            Next

            tagInfo += "]"

            Console.WriteLine(tagInfo)
        End If

        If idle Then
            sender.ReaderRequestTagID()
        End If
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim nfc As New BrickletNFC(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register reader state changed callback to subroutine ReaderStateChangedCB
        AddHandler nfc.ReaderStateChangedCallback, AddressOf ReaderStateChangedCB

        ' Enable reader mode
        nfc.SetMode(BrickletNFC.MODE_READER)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Simple¶

Download (ExampleSimple.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

Imports System
Imports System.Threading
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your NFC Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim nfc As New BrickletNFC(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Enable simple mode
        nfc.SetMode(BrickletNFC.MODE_SIMPLE)

        ' Get current tag IDs 10 times
        Dim cycle As Integer
        Dim index As Byte
        Dim tagType As Byte
        Dim tagID As Byte()
        Dim lastSeen As Long
        Dim tagInfo As String
        Dim i As Integer

        For cycle = 1 To 10
            Console.WriteLine("Cycle: " + cycle.ToString() + " of 10")

            For index = 0 To 7
                Try
                    nfc.SimpleGetTagID(index, tagType, tagID, lastSeen)
                Catch
                    ' On error enable simple mode again
                    nfc.SetMode(BrickletNFC.MODE_SIMPLE)
                    Continue For
                End Try

                If tagID.Length = 0 Then
                    Exit For
                End If

                tagInfo = "["

                For i = 0 To tagID.Length - 1
                    tagInfo += String.Format("0x{0:X2}", tagID(i))

                    If i < tagID.Length - 1 Then
                        tagInfo += " "
                    End If
                Next

                tagInfo += "]"

                Console.WriteLine("  Index: " + index.ToString() + _
                                  ", Tag Type: " + tagType.ToString() + _
                                  ", Tag ID: " + tagInfo + _
                                  ", Last Seen: " + (lastSeen / 1000.0).ToString() + " seconds ago")
            Next index

            Console.WriteLine("")
            Thread.Sleep(1000)
        Next cycle

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Write Read Type 2¶

Download (ExampleWriteReadType2.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

Imports System
Imports Tinkerforge

Module ExampleWriteReadType2
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your NFC Bricklet

    ' Callback subroutine for reader state changed callback
    Sub ReaderStateChangedCB(ByVal sender As BrickletNFC, ByVal state As Byte, _
                             ByVal idle As Boolean)
        If state = BrickletNFC.READER_STATE_IDLE Then
            sender.ReaderRequestTagID()
        ElseIf(state = BrickletNFC.READER_STATE_REQUEST_TAG_ID_READY) Then
            Dim tagType As Byte
            Dim tagID() As Byte

            sender.ReaderGetTagID(tagType, tagID)

            If tagType <> BrickletNFC.TAG_TYPE_TYPE2 Then
                Console.WriteLine("Tag is not type-2")
                return
            End If

            Console.WriteLine("Found tag of type {0} with ID [0x{1:X} 0x{2:X} 0x{3:X} 0x{4:X}]", _
                              tagType, _
                              tagID(0), _
                              tagID(1), _
                              tagID(2), _
                              tagID(3))
            sender.ReaderRequestPage(1, 4)
        ElseIf state = BrickletNFC.READER_STATE_REQUEST_TAG_ID_ERROR Then
            Console.WriteLine("Request tag ID error")
        ElseIf state = BrickletNFC.READER_STATE_REQUEST_PAGE_READY Then
            Dim page() As Byte

            page = sender.ReaderReadPage()

            Console.WriteLine("Page read: 0x{0:X} 0x{1:X} 0x{2:X} 0x{3:X}",
                              page(0),
                              page(1),
                              page(2),
                              page(3))
            sender.ReaderWritePage(1, page)
        ElseIf state = BrickletNFC.READER_STATE_WRITE_PAGE_READY Then
            Console.WriteLine("Write page ready")
        ElseIf state = BrickletNFC.READER_STATE_REQUEST_PAGE_ERROR Then
            Console.WriteLine("Request page error")
        ElseIf state = BrickletNFC.READER_STATE_WRITE_PAGE_ERROR Then
            Console.WriteLine("Write page error")
        End If
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim nfc As New BrickletNFC(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register reader state changed callback to subroutine ReaderStateChangedCB
        AddHandler nfc.ReaderStateChangedCallback, AddressOf ReaderStateChangedCB

        ' Enable reader mode
        nfc.SetMode(BrickletNFC.MODE_READER)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Grundfunktionen¶

Class BrickletNFC(ByVal uid As String, ByVal ipcon As IPConnection)¶

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

Dim nfc As New BrickletNFC("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

Sub BrickletNFC.SetMode(ByVal mode As Byte)¶

Parameter:	mode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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
• Simple: Liest automatisch Tag-IDs

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:

• BrickletNFC.MODE_OFF = 0
• BrickletNFC.MODE_CARDEMU = 1
• BrickletNFC.MODE_P2P = 2
• BrickletNFC.MODE_READER = 3
• BrickletNFC.MODE_SIMPLE = 4

Function BrickletNFC.GetMode() As Byte¶

Rückgabe:	mode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für mode:

• BrickletNFC.MODE_OFF = 0
• BrickletNFC.MODE_CARDEMU = 1
• BrickletNFC.MODE_P2P = 2
• BrickletNFC.MODE_READER = 3
• BrickletNFC.MODE_SIMPLE = 4

Sub BrickletNFC.ReaderRequestTagID()¶

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
• NFC Forum Type 5

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 ReaderStateChangedCallback 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.

Sub BrickletNFC.ReaderGetTagID(ByRef tagType As Byte, ByRef tagID() As Byte)¶

Ausgabeparameter:	tagType – Typ: Byte, Wertebereich: Siehe Konstanten tagID – Typ: Byte Array, Länge: variabel, Wertebereich: [0 bis 255]

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 ReaderStateChangedCallback Callback)
3. Rufe ReaderGetTagID() auf

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

Für tagType:

• BrickletNFC.TAG_TYPE_MIFARE_CLASSIC = 0
• BrickletNFC.TAG_TYPE_TYPE1 = 1
• BrickletNFC.TAG_TYPE_TYPE2 = 2
• BrickletNFC.TAG_TYPE_TYPE3 = 3
• BrickletNFC.TAG_TYPE_TYPE4 = 4
• BrickletNFC.TAG_TYPE_TYPE5 = 5

Sub BrickletNFC.ReaderGetState(ByRef state As Byte, ByRef idle As Boolean)¶

Ausgabeparameter:	state – Typ: Byte, Wertebereich: Siehe Konstanten idle – Typ: Boolean

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:

• BrickletNFC.READER_STATE_INITIALIZATION = 0
• BrickletNFC.READER_STATE_IDLE = 128
• BrickletNFC.READER_STATE_ERROR = 192
• BrickletNFC.READER_STATE_REQUEST_TAG_ID = 2
• BrickletNFC.READER_STATE_REQUEST_TAG_ID_READY = 130
• BrickletNFC.READER_STATE_REQUEST_TAG_ID_ERROR = 194
• BrickletNFC.READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 3
• BrickletNFC.READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_READY = 131
• BrickletNFC.READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_ERROR = 195
• BrickletNFC.READER_STATE_WRITE_PAGE = 4
• BrickletNFC.READER_STATE_WRITE_PAGE_READY = 132
• BrickletNFC.READER_STATE_WRITE_PAGE_ERROR = 196
• BrickletNFC.READER_STATE_REQUEST_PAGE = 5
• BrickletNFC.READER_STATE_REQUEST_PAGE_READY = 133
• BrickletNFC.READER_STATE_REQUEST_PAGE_ERROR = 197
• BrickletNFC.READER_STATE_WRITE_NDEF = 6
• BrickletNFC.READER_STATE_WRITE_NDEF_READY = 134
• BrickletNFC.READER_STATE_WRITE_NDEF_ERROR = 198
• BrickletNFC.READER_STATE_REQUEST_NDEF = 7
• BrickletNFC.READER_STATE_REQUEST_NDEF_READY = 135
• BrickletNFC.READER_STATE_REQUEST_NDEF_ERROR = 199

Sub BrickletNFC.ReaderWriteNDEF(ByVal ndef() As Byte)¶

Parameter:	ndef – Typ: Byte Array, Länge: variabel, Wertebereich: [0 bis 255]

Schreibt NDEF formatierte Daten.

Diese Funktion unterstützt aktuell NFC Forum Type 2, 4, 5 und Mifare Classic.

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

Sub BrickletNFC.ReaderRequestNDEF()¶

Liest NDEF formatierten Daten von einem Tag.

Diese Funktion unterstützt aktuell NFC Forum Type 1, 2, 3, 4, 5 and Mifare Classic.

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 ReaderStateChangedCallback 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 ReaderStateChangedCallback Callback)
6. Rufe ReaderReadNDEF() auf um die gespeicherte NDEF Nachricht abzufragen

Function BrickletNFC.ReaderReadNDEF() As Byte()¶

Rückgabe:	ndef – Typ: Byte Array, Länge: variabel, Wertebereich: [0 bis 255]

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.

Sub BrickletNFC.ReaderAuthenticateMifareClassicPage(ByVal page As Integer, ByVal keyNumber As Byte, ByVal key() As Byte)¶

Parameter:	page – Typ: Integer, Wertebereich: [0 bis 216 - 1] keyNumber – Typ: Byte, Wertebereich: Siehe Konstanten key – Typ: Byte Array, Länge: 6, Wertebereich: [0 bis 255]

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

• BrickletNFC.KEY_A = 0
• BrickletNFC.KEY_B = 1

Sub BrickletNFC.ReaderWritePage(ByVal page As Integer, ByVal data() As Byte)¶

Parameter:	page – Typ: Integer, Wertebereich: Siehe Konstanten data – Typ: Byte Array, Länge: variabel, Wertebereich: [0 bis 255]

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)
• NFC Forum Type 5 Pagegröße: 4 byte

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

• BrickletNFC.READER_WRITE_TYPE4_CAPABILITY_CONTAINER = 3
• BrickletNFC.READER_WRITE_TYPE4_NDEF = 4

Sub BrickletNFC.ReaderRequestPage(ByVal page As Integer, ByVal length As Integer)¶

Parameter:	page – Typ: Integer, Wertebereich: Siehe Konstanten length – Typ: Integer, Wertebereich: [0 bis 213]

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)
• NFC Forum Type 5 Pagegröße: 4 byte

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

• BrickletNFC.READER_REQUEST_TYPE4_CAPABILITY_CONTAINER = 3
• BrickletNFC.READER_REQUEST_TYPE4_NDEF = 4

Function BrickletNFC.ReaderReadPage() As Byte()¶

Rückgabe:	data – Typ: Byte Array, Länge: variabel, Wertebereich: [0 bis 255]

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

Sub BrickletNFC.CardemuGetState(ByRef state As Byte, ByRef idle As Boolean)¶

Ausgabeparameter:	state – Typ: Byte, Wertebereich: Siehe Konstanten idle – Typ: Boolean

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:

• BrickletNFC.CARDEMU_STATE_INITIALIZATION = 0
• BrickletNFC.CARDEMU_STATE_IDLE = 128
• BrickletNFC.CARDEMU_STATE_ERROR = 192
• BrickletNFC.CARDEMU_STATE_DISCOVER = 2
• BrickletNFC.CARDEMU_STATE_DISCOVER_READY = 130
• BrickletNFC.CARDEMU_STATE_DISCOVER_ERROR = 194
• BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF = 3
• BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF_READY = 131
• BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF_ERROR = 195

Sub BrickletNFC.CardemuStartDiscovery()¶

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.

Sub BrickletNFC.CardemuWriteNDEF(ByVal ndef() As Byte)¶

Parameter:	ndef – Typ: Byte Array, Länge: variabel, Wertebereich: [0 bis 255]

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.

Sub BrickletNFC.CardemuStartTransfer(ByVal transfer As Byte)¶

Parameter:	transfer – Typ: Byte, Wertebereich: Siehe Konstanten

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:

• BrickletNFC.CARDEMU_TRANSFER_ABORT = 0
• BrickletNFC.CARDEMU_TRANSFER_WRITE = 1

Sub BrickletNFC.P2PGetState(ByRef state As Byte, ByRef idle As Boolean)¶

Ausgabeparameter:	state – Typ: Byte, Wertebereich: Siehe Konstanten idle – Typ: Boolean

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:

• BrickletNFC.P2P_STATE_INITIALIZATION = 0
• BrickletNFC.P2P_STATE_IDLE = 128
• BrickletNFC.P2P_STATE_ERROR = 192
• BrickletNFC.P2P_STATE_DISCOVER = 2
• BrickletNFC.P2P_STATE_DISCOVER_READY = 130
• BrickletNFC.P2P_STATE_DISCOVER_ERROR = 194
• BrickletNFC.P2P_STATE_TRANSFER_NDEF = 3
• BrickletNFC.P2P_STATE_TRANSFER_NDEF_READY = 131
• BrickletNFC.P2P_STATE_TRANSFER_NDEF_ERROR = 195

Sub BrickletNFC.P2PStartDiscovery()¶

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.

Sub BrickletNFC.P2PWriteNDEF(ByVal ndef() As Byte)¶

Parameter:	ndef – Typ: Byte Array, Länge: variabel, Wertebereich: [0 bis 255]

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.

Sub BrickletNFC.P2PStartTransfer(ByVal transfer As Byte)¶

Parameter:	transfer – Typ: Byte, Wertebereich: Siehe Konstanten

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:

• BrickletNFC.P2P_TRANSFER_ABORT = 0
• BrickletNFC.P2P_TRANSFER_WRITE = 1
• BrickletNFC.P2P_TRANSFER_READ = 2

Function BrickletNFC.P2PReadNDEF() As Byte()¶

Rückgabe:	ndef – Typ: Byte Array, Länge: variabel, Wertebereich: [0 bis 255]

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.

Sub BrickletNFC.SimpleGetTagID(ByVal index As Byte, ByRef tagType As Byte, ByRef tagID() As Byte, ByRef lastSeen As Long)¶

Parameter:	index – Typ: Byte, Wertebereich: [0 bis 7]
Ausgabeparameter:	tagType – Typ: Byte, Wertebereich: Siehe Konstanten tagID – Typ: Byte Array, Länge: variabel, Wertebereich: [0 bis 255] lastSeen – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt den Tag Typ und die Tag ID des Simple-Mode sortiert nach last_seen für den gegebenen Index zurück.

Bis zu acht Tags werden gespeichert.

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

Für tagType:

• BrickletNFC.TAG_TYPE_MIFARE_CLASSIC = 0
• BrickletNFC.TAG_TYPE_TYPE1 = 1
• BrickletNFC.TAG_TYPE_TYPE2 = 2
• BrickletNFC.TAG_TYPE_TYPE3 = 3
• BrickletNFC.TAG_TYPE_TYPE4 = 4
• BrickletNFC.TAG_TYPE_TYPE5 = 5

Neu in Version 2.0.6 (Plugin).

Sub BrickletNFC.CardemuSetTagID(ByVal tagIDLength As Byte, ByVal tagIDData() As Byte)¶

Parameter:	tagIDLength – Typ: Byte, Wertebereich: [0 bis 7] tagIDData – Typ: Byte Array, Länge: 7, Wertebereich: [0 bis 255]

Setzt die Tag ID für den Caremu-Modus. Die Tag ID kann entweder eine Länge von 4 oder von 7 haben.

Wrid die Länge auf 0 gesetzt, nutzt das Bricklet eine zufällige Tag ID (Default).

Neu in Version 2.1.0 (Plugin).

Sub BrickletNFC.CardemuGetTagID(ByRef tagIDLength As Byte, ByRef tagIDData() As Byte)¶

Ausgabeparameter:	tagIDLength – Typ: Byte, Wertebereich: [0 bis 7] tagIDData – Typ: Byte Array, Länge: 7, Wertebereich: [0 bis 255]

Gibt die Tag ID und Länge zurück, wie von CardemuSetTagID() gesetzt.

Neu in Version 2.1.0 (Plugin).

Fortgeschrittene Funktionen¶

Sub BrickletNFC.SetDetectionLEDConfig(ByVal config As Byte)¶

Parameter:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

• BrickletNFC.DETECTION_LED_CONFIG_OFF = 0
• BrickletNFC.DETECTION_LED_CONFIG_ON = 1
• BrickletNFC.DETECTION_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletNFC.DETECTION_LED_CONFIG_SHOW_DETECTION = 3

Function BrickletNFC.GetDetectionLEDConfig() As Byte¶

Rückgabe:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

• BrickletNFC.DETECTION_LED_CONFIG_OFF = 0
• BrickletNFC.DETECTION_LED_CONFIG_ON = 1
• BrickletNFC.DETECTION_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletNFC.DETECTION_LED_CONFIG_SHOW_DETECTION = 3

Sub BrickletNFC.SetMaximumTimeout(ByVal timeout As Integer)¶

Parameter:	timeout – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 2000

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

Function BrickletNFC.GetMaximumTimeout() As Integer¶

Rückgabe:	timeout – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 2000

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

Neu in Version 2.0.1 (Plugin).

Sub BrickletNFC.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶

Ausgabeparameter:	errorCountAckChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1] errorCountMessageChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1] errorCountFrame – Typ: Long, Wertebereich: [0 bis 232 - 1] errorCountOverflow – Typ: Long, Wertebereich: [0 bis 232 - 1]

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.

Sub BrickletNFC.SetStatusLEDConfig(ByVal config As Byte)¶

Parameter:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

• BrickletNFC.STATUS_LED_CONFIG_OFF = 0
• BrickletNFC.STATUS_LED_CONFIG_ON = 1
• BrickletNFC.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletNFC.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletNFC.GetStatusLEDConfig() As Byte¶

Rückgabe:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

• BrickletNFC.STATUS_LED_CONFIG_OFF = 0
• BrickletNFC.STATUS_LED_CONFIG_ON = 1
• BrickletNFC.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletNFC.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletNFC.GetChipTemperature() As Short¶

Rückgabe:	temperature – Typ: Short, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

Sub BrickletNFC.Reset()¶

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.

Sub BrickletNFC.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶

Ausgabeparameter:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: ["a"C bis "h"C, "z"C] hardwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

Sub MyCallback(ByVal sender As BrickletNFC, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler nfc.ExampleCallback, AddressOf MyCallback

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Event BrickletNFC.ReaderStateChangedCallback(ByVal sender As BrickletNFC, ByVal state As Byte, ByVal idle As Boolean)¶

Callback-Parameter:	sender – Typ: BrickletNFC state – Typ: Byte, Wertebereich: Siehe Konstanten idle – Typ: Boolean

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:

• BrickletNFC.READER_STATE_INITIALIZATION = 0
• BrickletNFC.READER_STATE_IDLE = 128
• BrickletNFC.READER_STATE_ERROR = 192
• BrickletNFC.READER_STATE_REQUEST_TAG_ID = 2
• BrickletNFC.READER_STATE_REQUEST_TAG_ID_READY = 130
• BrickletNFC.READER_STATE_REQUEST_TAG_ID_ERROR = 194
• BrickletNFC.READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 3
• BrickletNFC.READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_READY = 131
• BrickletNFC.READER_STATE_AUTHENTICATE_MIFARE_CLASSIC_PAGE_ERROR = 195
• BrickletNFC.READER_STATE_WRITE_PAGE = 4
• BrickletNFC.READER_STATE_WRITE_PAGE_READY = 132
• BrickletNFC.READER_STATE_WRITE_PAGE_ERROR = 196
• BrickletNFC.READER_STATE_REQUEST_PAGE = 5
• BrickletNFC.READER_STATE_REQUEST_PAGE_READY = 133
• BrickletNFC.READER_STATE_REQUEST_PAGE_ERROR = 197
• BrickletNFC.READER_STATE_WRITE_NDEF = 6
• BrickletNFC.READER_STATE_WRITE_NDEF_READY = 134
• BrickletNFC.READER_STATE_WRITE_NDEF_ERROR = 198
• BrickletNFC.READER_STATE_REQUEST_NDEF = 7
• BrickletNFC.READER_STATE_REQUEST_NDEF_READY = 135
• BrickletNFC.READER_STATE_REQUEST_NDEF_ERROR = 199

Event BrickletNFC.CardemuStateChangedCallback(ByVal sender As BrickletNFC, ByVal state As Byte, ByVal idle As Boolean)¶

Callback-Parameter:	sender – Typ: BrickletNFC state – Typ: Byte, Wertebereich: Siehe Konstanten idle – Typ: Boolean

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:

• BrickletNFC.CARDEMU_STATE_INITIALIZATION = 0
• BrickletNFC.CARDEMU_STATE_IDLE = 128
• BrickletNFC.CARDEMU_STATE_ERROR = 192
• BrickletNFC.CARDEMU_STATE_DISCOVER = 2
• BrickletNFC.CARDEMU_STATE_DISCOVER_READY = 130
• BrickletNFC.CARDEMU_STATE_DISCOVER_ERROR = 194
• BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF = 3
• BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF_READY = 131
• BrickletNFC.CARDEMU_STATE_TRANSFER_NDEF_ERROR = 195

Event BrickletNFC.P2PStateChangedCallback(ByVal sender As BrickletNFC, ByVal state As Byte, ByVal idle As Boolean)¶

Callback-Parameter:	sender – Typ: BrickletNFC state – Typ: Byte, Wertebereich: Siehe Konstanten idle – Typ: Boolean

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:

• BrickletNFC.P2P_STATE_INITIALIZATION = 0
• BrickletNFC.P2P_STATE_IDLE = 128
• BrickletNFC.P2P_STATE_ERROR = 192
• BrickletNFC.P2P_STATE_DISCOVER = 2
• BrickletNFC.P2P_STATE_DISCOVER_READY = 130
• BrickletNFC.P2P_STATE_DISCOVER_ERROR = 194
• BrickletNFC.P2P_STATE_TRANSFER_NDEF = 3
• BrickletNFC.P2P_STATE_TRANSFER_NDEF_READY = 131
• BrickletNFC.P2P_STATE_TRANSFER_NDEF_ERROR = 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.

Function BrickletNFC.GetAPIVersion() As Byte()¶

Ausgabeparameter:	apiVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255]

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.

Function BrickletNFC.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

Parameter:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: Boolean

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:

• BrickletNFC.FUNCTION_SET_MODE = 1
• BrickletNFC.FUNCTION_READER_REQUEST_TAG_ID = 3
• BrickletNFC.FUNCTION_READER_WRITE_NDEF = 6
• BrickletNFC.FUNCTION_READER_REQUEST_NDEF = 7
• BrickletNFC.FUNCTION_READER_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 9
• BrickletNFC.FUNCTION_READER_WRITE_PAGE = 10
• BrickletNFC.FUNCTION_READER_REQUEST_PAGE = 11
• BrickletNFC.FUNCTION_CARDEMU_START_DISCOVERY = 15
• BrickletNFC.FUNCTION_CARDEMU_WRITE_NDEF = 16
• BrickletNFC.FUNCTION_CARDEMU_START_TRANSFER = 17
• BrickletNFC.FUNCTION_P2P_START_DISCOVERY = 20
• BrickletNFC.FUNCTION_P2P_WRITE_NDEF = 21
• BrickletNFC.FUNCTION_P2P_START_TRANSFER = 22
• BrickletNFC.FUNCTION_SET_DETECTION_LED_CONFIG = 25
• BrickletNFC.FUNCTION_SET_MAXIMUM_TIMEOUT = 27
• BrickletNFC.FUNCTION_CARDEMU_SET_TAG_ID = 30
• BrickletNFC.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletNFC.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletNFC.FUNCTION_RESET = 243
• BrickletNFC.FUNCTION_WRITE_UID = 248

Sub BrickletNFC.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

Parameter:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten responseExpected – Typ: Boolean

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

• BrickletNFC.FUNCTION_SET_MODE = 1
• BrickletNFC.FUNCTION_READER_REQUEST_TAG_ID = 3
• BrickletNFC.FUNCTION_READER_WRITE_NDEF = 6
• BrickletNFC.FUNCTION_READER_REQUEST_NDEF = 7
• BrickletNFC.FUNCTION_READER_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 9
• BrickletNFC.FUNCTION_READER_WRITE_PAGE = 10
• BrickletNFC.FUNCTION_READER_REQUEST_PAGE = 11
• BrickletNFC.FUNCTION_CARDEMU_START_DISCOVERY = 15
• BrickletNFC.FUNCTION_CARDEMU_WRITE_NDEF = 16
• BrickletNFC.FUNCTION_CARDEMU_START_TRANSFER = 17
• BrickletNFC.FUNCTION_P2P_START_DISCOVERY = 20
• BrickletNFC.FUNCTION_P2P_WRITE_NDEF = 21
• BrickletNFC.FUNCTION_P2P_START_TRANSFER = 22
• BrickletNFC.FUNCTION_SET_DETECTION_LED_CONFIG = 25
• BrickletNFC.FUNCTION_SET_MAXIMUM_TIMEOUT = 27
• BrickletNFC.FUNCTION_CARDEMU_SET_TAG_ID = 30
• BrickletNFC.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletNFC.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletNFC.FUNCTION_RESET = 243
• BrickletNFC.FUNCTION_WRITE_UID = 248

Sub BrickletNFC.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameter:	responseExpected – Typ: Boolean

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

Function BrickletNFC.SetBootloaderMode(ByVal mode As Byte) As Byte¶

Parameter:	mode – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: Byte, Wertebereich: Siehe Konstanten

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:

• BrickletNFC.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletNFC.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletNFC.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletNFC.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletNFC.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BrickletNFC.BOOTLOADER_STATUS_OK = 0
• BrickletNFC.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletNFC.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletNFC.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletNFC.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletNFC.BOOTLOADER_STATUS_CRC_MISMATCH = 5

Function BrickletNFC.GetBootloaderMode() As Byte¶

Rückgabe:	mode – Typ: Byte, Wertebereich: Siehe Konstanten

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

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

Für mode:

• BrickletNFC.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletNFC.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletNFC.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletNFC.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletNFC.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Sub BrickletNFC.SetWriteFirmwarePointer(ByVal pointer As Long)¶

Parameter:	pointer – Typ: Long, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

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.

Function BrickletNFC.WriteFirmware(ByVal data() As Byte) As Byte¶

Parameter:	data – Typ: Byte Array, Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: Byte, Wertebereich: [0 bis 255]

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.

Sub BrickletNFC.WriteUID(ByVal uid As Long)¶

Parameter:	uid – Typ: Long, Wertebereich: [0 bis 232 - 1]

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.

Function BrickletNFC.ReadUID() As Long¶

Rückgabe:	uid – Typ: Long, Wertebereich: [0 bis 232 - 1]

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

Konstanten¶

Const BrickletNFC.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein NFC Bricklet zu identifizieren.

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

Const BrickletNFC.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines NFC Bricklet dar.