Python - NFC/RFID Bricklet

Dies ist die Beschreibung der Python API Bindings für das NFC/RFID Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des NFC/RFID Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Python API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Scan For Tags

Download (example_scan_for_tags.py)

 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
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your NFC/RFID Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_nfc_rfid import BrickletNFCRFID

tag_type = 0

# Callback function for state changed callback
def cb_state_changed(state, idle, nr):
    if state == nr.STATE_REQUEST_TAG_ID_READY:
        ret = nr.get_tag_id()
        print("Found tag of type " + str(ret.tag_type) + " with ID [" +
              " ".join(map(str, map(hex, ret.tid[:ret.tid_length]))) + "]")

    # Cycle through all types
    if idle:
        global tag_type
        tag_type = (tag_type + 1) % 3
        nr.request_tag_id(tag_type)

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    nr = BrickletNFCRFID(UID, ipcon) # Create device object

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

    # Register state changed callback to function cb_state_changed
    nr.register_callback(nr.CALLBACK_STATE_CHANGED,
                         lambda x, y: cb_state_changed(x, y, nr))

    # Start scan loop
    nr.request_tag_id(nr.TAG_TYPE_MIFARE_CLASSIC)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Write Read Type2

Download (example_write_read_type2.py)

 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
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your NFC/RFID Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_nfc_rfid import BrickletNFCRFID

# Callback function for state changed callback
def cb_state_changed(state, idle, nr):
    if state == nr.STATE_REQUEST_TAG_ID_READY:
        print("Tag found")

        # Write 16 byte to pages 5-8
        data_write = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
        nr.write_page(5, data_write)
        print("Writing data...")
    elif state == nr.STATE_WRITE_PAGE_READY:
        # Request pages 5-8
        nr.request_page(5)
        print("Requesting data...")
    elif state == nr.STATE_REQUEST_PAGE_READY:
        # Get and print pages
        data = nr.get_page()
        print("Read data: [" + " ".join(map(str, data)) + "]")
    elif state & (1 << 6):
        # All errors have bit 6 set
        print("Error: " + str(state))

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    nr = BrickletNFCRFID(UID, ipcon) # Create device object

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

    # Register state changed callback to function cb_state_changed
    nr.register_callback(nr.CALLBACK_STATE_CHANGED,
                         lambda x, y: cb_state_changed(x, y, nr))

    # Select NFC Forum Type 2 tag
    nr.request_tag_id(nr.TAG_TYPE_TYPE2)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Write Ndef Message

Download (example_write_ndef_message.py)

  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
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
#!/usr/bin/env python
# -*- coding: utf-8 -*-

# The following specifications have been used
# as a basis for writing this example.
#
# NFC Data Exchange Format (NDEF), NDEF 1.0:
# https://github.com/Tinkerforge/nfc-rfid-bricklet/raw/master/datasheets/specification_ndef.pdf
#
# Type 1 Tag Operation Specification, T1TOP 1.1:
# https://github.com/Tinkerforge/nfc-rfid-bricklet/raw/master/datasheets/specification_type1.pdf
#
# Type 2 Tag Operation Specification, T2TOP 1.1:
# https://github.com/Tinkerforge/nfc-rfid-bricklet/raw/master/datasheets/specification_type2.pdf

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_nfc_rfid import BrickletNFCRFID

try:
    from queue import Queue
except ImportError:
    from Queue import Queue

from pprint import pprint
import os

class NdefMessage:
    tag_type = None
    records = []
    capability_container = [0, 0, 0, 0]

    def __init__(self, tag_type):
        self.tag_type = tag_type

    def add_record(self, record):
        self.records.append(record)

        # Set end and begin flags as needed
        if len(self.records) == 1:
            record.begin = True
            record.end = True
        else:
            self.records[-2].end = False
            self.records[-1].end = True

    def set_capability_container(self, version, tag_size, read_write_access):
        # Magic number to indicate NFC Forum defined data is stored
        self.capability_container[0] = 0xE1
        self.capability_container[1] = version

        if self.tag_type == BrickletNFCRFID.TAG_TYPE_TYPE1:
            self.capability_container[2] = tag_size/8 - 1
        else:
            self.capability_container[2] = tag_size/8

        self.capability_container[3] = read_write_access

    def get_raw_data_in_chunks(self):
        raw_data = []

        for record in self.records:
            raw_data.extend(record.get_raw_data())

        # Use three consecutive byte format if necessary, see 2.3 TLV blocks
        data_len = len(raw_data)

        if data_len < 0xFF:
            tlv_ndef = [0x03, data_len]
        else:
            tlv_ndef = [0x03, 0xFF, data_len >> 8, data_len % 256]

        if self.tag_type == BrickletNFCRFID.TAG_TYPE_TYPE1:
            # CC set by set_capability_container
            # default lock and memory TLVs
            # NDEF TLV
            # NDEF message
            # Terminator TLV
            raw_data = self.capability_container + \
                       [0x01, 0x03, 0xF2, 0x30, 0x33, 0x02, 0x03, 0xF0, 0x02, 0x03] + \
                       tlv_ndef + \
                       raw_data + \
                       [0xFE]
        elif self.tag_type == BrickletNFCRFID.TAG_TYPE_TYPE2:
            # CC set by set_capability_container
            # NDEF TLV
            # NDEF message
            # Terminator TLV
            raw_data = self.capability_container + \
                       tlv_ndef + \
                       raw_data + \
                       [0xFE]
        else:
            # TODO: We could support TAG_TYPE_MIFARE_CLASSIC here, but Mifare
            # Classic it is not supported in modern smart phones anyway.
            return [[]]

        chunks = []

        for i in range(0, len(raw_data), 16):
            chunks.append(raw_data[i:i+16])

        last_chunk_length = len(chunks[-1])

        if last_chunk_length < 16:
            chunks[-1].extend([0]*(16-last_chunk_length))

        return chunks

class NdefRecord:
    FLAG_ID_LENGTH     = 1 << 3
    FLAG_SHORT_RECORD  = 1 << 4
    FLAG_CHUNK         = 1 << 5
    FLAG_MESSAGE_END   = 1 << 6
    FLAG_MESSAGE_BEGIN = 1 << 7

    TNF_EMPTY          = 0x0
    TNF_WELL_KNOWN     = 0x01
    TNF_MIME_MEDIA     = 0x02
    TNF_ABSOLUTE_URI   = 0x03
    TNF_EXTERNAL_TYPE  = 0x04
    TNF_UNKNOWN        = 0x05
    TNF_UNCHANGED      = 0x06
    TNF_RESERVED       = 0x07

    NDEF_URIPREFIX_NONE         = 0x00
    NDEF_URIPREFIX_HTTP_WWWDOT  = 0x01
    NDEF_URIPREFIX_HTTPS_WWWDOT = 0x02
    NDEF_URIPREFIX_HTTP         = 0x03
    NDEF_URIPREFIX_HTTPS        = 0x04
    NDEF_URIPREFIX_TEL          = 0x05
    NDEF_URIPREFIX_MAILTO       = 0x06
    NDEF_URIPREFIX_FTP_ANONAT   = 0x07
    NDEF_URIPREFIX_FTP_FTPDOT   = 0x08
    NDEF_URIPREFIX_FTPS         = 0x09
    NDEF_URIPREFIX_SFTP         = 0x0A
    NDEF_URIPREFIX_SMB          = 0x0B
    NDEF_URIPREFIX_NFS          = 0x0C
    NDEF_URIPREFIX_FTP          = 0x0D
    NDEF_URIPREFIX_DAV          = 0x0E
    NDEF_URIPREFIX_NEWS         = 0x0F
    NDEF_URIPREFIX_TELNET       = 0x10
    NDEF_URIPREFIX_IMAP         = 0x11
    NDEF_URIPREFIX_RTSP         = 0x12
    NDEF_URIPREFIX_URN          = 0x13
    NDEF_URIPREFIX_POP          = 0x14
    NDEF_URIPREFIX_SIP          = 0x15
    NDEF_URIPREFIX_SIPS         = 0x16
    NDEF_URIPREFIX_TFTP         = 0x17
    NDEF_URIPREFIX_BTSPP        = 0x18
    NDEF_URIPREFIX_BTL2CAP      = 0x19
    NDEF_URIPREFIX_BTGOEP       = 0x1A
    NDEF_URIPREFIX_TCPOBEX      = 0x1B
    NDEF_URIPREFIX_IRDAOBEX     = 0x1C
    NDEF_URIPREFIX_FILE         = 0x1D
    NDEF_URIPREFIX_URN_EPC_ID   = 0x1E
    NDEF_URIPREFIX_URN_EPC_TAG  = 0x1F
    NDEF_URIPREFIX_URN_EPC_PAT  = 0x20
    NDEF_URIPREFIX_URN_EPC_RAW  = 0x21
    NDEF_URIPREFIX_URN_EPC      = 0x22
    NDEF_URIPREFIX_URN_NFC      = 0x23

    NDEF_TYPE_MIME              = 0x02
    NDEF_TYPE_URI               = 0x55
    NDEF_TYPE_TEXT              = 0x54

    begin = False
    end = False

    tnf = 0
    record_type = None
    payload = None
    identifier = None

    def set_identifier(self, identifier):
        self.identifier = identifier

    def get_raw_data(self):
        if self.record_type == None or self.payload == None:
            return []

        # Construct tnf and flags (byte 0 of header)
        header = [self.tnf]

        if self.begin:
            header[0] |= NdefRecord.FLAG_MESSAGE_BEGIN

        if self.end:
            header[0] |= NdefRecord.FLAG_MESSAGE_END

        if len(self.payload) < 256:
            header[0] |= NdefRecord.FLAG_SHORT_RECORD

        if self.identifier != None:
            header[0] |= NdefRecord.FLAG_ID_LENGTH

        # Type length (byte 1 of header)
        header.append(len(self.record_type))

        # Payload length (byte 2 of header)
        # TODO: payload > 255?
        header.append(len(self.payload))

        # ID length (byte 3 of header)
        if self.identifier != None:
            header.append(len(self.identifier))

        # Record type (byte 4ff of header)
        header.extend(self.record_type)

        # ID
        if self.identifier != None:
            header.extend(self.identifier)

        return header + self.payload

class NdefTextRecord(NdefRecord):
    # Call with text and ISO/IANA language code
    def __init__(self, text, language='en'):
        self.tnf = NdefRecord.TNF_WELL_KNOWN
        self.record_type = [NdefRecord.NDEF_TYPE_TEXT]

        lang_list = map(ord, language)
        text_list = map(ord, text)

        # Text Record Content: Status byte, ISO/IANA language code, text
        # See NDEF 1.0: 3.2.1
        self.payload = [len(lang_list)] + lang_list + text_list

class NdefUriRecord(NdefRecord):
    def __init__(self, uri, uri_prefix=NdefRecord.NDEF_URIPREFIX_NONE):
        self.tnf = NdefRecord.TNF_WELL_KNOWN
        self.record_type = [NdefRecord.NDEF_TYPE_URI]

        uri_list = map(ord, uri)

        # Text Record Content: URI prefix, URI
        # See NDEF 1.0: 3.2.2
        self.payload = [uri_prefix] + uri_list

class NdefMediaRecord(NdefRecord):
    def __init__(self, mime_type, data):
        self.tnf = NdefRecord.TNF_MIME_MEDIA
        self.record_type = map(ord, mime_type)

        if isinstance(data, str):
            self.payload = map(ord, data)
        else:
            self.payload = data

class ExampleNdef:
    HOST = "localhost"
    PORT = 4223
    UID = "hjw" # Change to your UID

    state_queue = Queue()
    tag_type = None
    tag_size = None

    def __init__(self, tag_type, tag_size=512):
        self.tag_type = tag_type
        self.tag_size = tag_size
        self.ipcon = IPConnection() # Create IP connection
        self.nr = BrickletNFCRFID(self.UID, self.ipcon) # Create device object

        self.ipcon.connect(self.HOST, self.PORT) # Connect to brickd

        self.nr.register_callback(self.nr.CALLBACK_STATE_CHANGED, self.state_changed)

    def write_message(self):
        chunks = self.message.get_raw_data_in_chunks()
        print("Trying to write the follwing data to the tag:")
        pprint(chunks)

        self.nr.request_tag_id(self.tag_type)
        state = self.state_queue.get()

        if state != self.nr.STATE_REQUEST_TAG_ID:
            return -1

        state = self.state_queue.get()

        if state != self.nr.STATE_REQUEST_TAG_ID_READY:
            return -2

        # NFC Forum Type 1 start page is 1 (start of capability container)
        # NFC Forum Type 2 start page is 3 (start of capability container)
        if self.tag_type == self.nr.TAG_TYPE_TYPE1:
            current_page = 1
        else:
            current_page = 3

        for chunk in chunks:
            self.nr.write_page(current_page, chunk)
            state = self.state_queue.get()

            if state != self.nr.STATE_WRITE_PAGE:
                return -3

            state = self.state_queue.get()

            if state != self.nr.STATE_WRITE_PAGE_READY:
                return -4

            # NFC Forum Type 1 has 2 pages per chunk (16 byte)
            # NFC Forum Type 2 has 4 pages per chunk (16 byte)
            if self.tag_type == self.nr.TAG_TYPE_TYPE1:
                current_page += 2
            else:
                current_page += 4

        return 0

    def state_changed(self, state, idle):
        self.state_queue.put(state)

    def make_message_small(self):
        self.message = NdefMessage(self.tag_type)

        # Capabilities:
        # Version 1.0               (0x10)
        # Tag size bytes            (given by self.tag_size)
        # Read/write access for all (0x00)
        self.message.set_capability_container(0x10, self.tag_size, 0x00)

        record = NdefUriRecord('tinkerforge.com', NdefRecord.NDEF_URIPREFIX_HTTP_WWWDOT)
        self.message.add_record(record)

    def make_message_large(self):
        self.message = NdefMessage(self.tag_type)

        # Capabilities:
        # Version 1.0               (0x10)
        # Tag size bytes            (given by self.tag_size)
        # Read/write access for all (0x00)
        self.message.set_capability_container(0x10, self.tag_size, 0x00)

        rec1 = NdefTextRecord('Hello World', 'en')
        self.message.add_record(rec1)
        rec2 = NdefTextRecord('Hallo Welt', 'de')
        self.message.add_record(rec2)
        rec3 = NdefUriRecord('tinkerforge.com', NdefRecord.NDEF_URIPREFIX_HTTP_WWWDOT)
        self.message.add_record(rec3)
        text = '<html><head><title>Hello</title></head><body>World!</body></html>'
        rec4 = NdefMediaRecord('text/html', text)
        self.message.add_record(rec4)

        # To test an "image/png" you can can download the file from:
        # http://download.tinkerforge.com/_stuff/tf_16x16.png
        if os.path.isfile('tf_16x16.png'):
            with open('tf_16x16.png', 'rb') as f:
                logo = f.read()

            rec5 = NdefMediaRecord('image/png', map(ord, logo))
            self.message.add_record(rec5)

if __name__ == '__main__':
    example = ExampleNdef(tag_type=BrickletNFCRFID.TAG_TYPE_TYPE2, tag_size=888)
    #example.make_message_large() # Writes different texts, URI, html site and image
    example.make_message_small() # Writes simple URI record
    ret = example.write_message()

    if ret < 0:
        print('Could not write NDEF Message: ' + str(ret))
    else:
        print('NDEF Message written successfully')

API

Prinzipiell kann jede Funktion der Python Bindings tinkerforge.ip_connection.Error Exception werfen, welche ein value und eine description Property hat. value kann verschiende Werte haben:

  • Error.TIMEOUT = -1
  • Error.NOT_ADDED = -6 (seit Python Bindings Version 2.0.0 nicht mehr verwendet)
  • Error.ALREADY_CONNECTED = -7
  • Error.NOT_CONNECTED = -8
  • Error.INVALID_PARAMETER = -9
  • Error.NOT_SUPPORTED = -10
  • Error.UNKNOWN_ERROR_CODE = -11
  • Error.STREAM_OUT_OF_SYNC = -12
  • Error.INVALID_UID = -13
  • Error.NON_ASCII_CHAR_IN_SECRET = -14
  • Error.WRONG_DEVICE_TYPE = -15

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletNFCRFID(uid, ipcon)
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • nfc_rfid – Typ: BrickletNFCRFID

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

nfc_rfid = BrickletNFCRFID("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletNFCRFID.request_tag_id(tag_type)
Parameter:
  • tag_type – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • None

Um ein Tag welches sich in der nähe des NFC/RFID Bricklets befindet zu lesen oder zu schreiben muss zuerst diese Funktion mit dem erwarteten Tag Typ aufgerufen werden. Es ist kein Problem wenn der Typ nicht bekannt ist. Es ist möglich die verügbaren Tag Typen einfach nacheinander durchzutesten bis das Tag antwortet.

Aktuell werden die folgenden Tag Typen unterstützt:

  • Mifare Classic
  • NFC Forum Type 1
  • NFC Forum Type 2

Beim Aufruf von request_tag_id() probiert das NFC/RFID Bricklet die Tag ID eines Tags auszulesen. Nachdem dieser Prozess beendet ist ändert sich der Zustand des Bricklets. Es ist möglich den CALLBACK_STATE_CHANGED Callback zu registrieren oder den Zustand über get_state() zu pollen.

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

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

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

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

Für tag_type:

  • BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC = 0
  • BrickletNFCRFID.TAG_TYPE_TYPE1 = 1
  • BrickletNFCRFID.TAG_TYPE_TYPE2 = 2
BrickletNFCRFID.get_tag_id()
Rückgabeobjekt:
  • tag_type – Typ: int, Wertebereich: Siehe Konstanten
  • tid_length – Typ: int, Wertebereich: [4, 7]
  • tid – Typ: [int, ...], Länge: 7, Wertebereich: [0 bis 255]

Gibt den Tag Typ, die Tag ID und die Länge der Tag ID (4 oder 7 Byte möglich) zurück. Diese Funktion kann nur aufgerufen werden wenn sich das Bricklet gerade in einem der Ready-Zustände befindet. Die zurückgegebene ID ist die letzte ID die durch einen Aufruf von request_tag_id() gefunden wurde.

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

  1. Rufe request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe get_state() oder CALLBACK_STATE_CHANGED Callback)
  3. Rufe get_tag_id() auf

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

Für tag_type:

  • BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC = 0
  • BrickletNFCRFID.TAG_TYPE_TYPE1 = 1
  • BrickletNFCRFID.TAG_TYPE_TYPE2 = 2
BrickletNFCRFID.get_state()
Rückgabeobjekt:
  • state – Typ: int, Wertebereich: Siehe Konstanten
  • idle – Typ: bool

Gibt den aktuellen Zustand des NFC/RFID Bricklets aus.

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

Die Funktionen dieses Bricklets können aufgerufen werden wenn der Zustand entweder Idle ist oder einer der Ready oder Error-Zustände erreicht wurde.

Beispiel: Wenn request_page() aufgerufen wird, änder sich der Zustand zu RequestPage solange der Leseprozess noch nicht abgeschlossen ist. Danach ändert sich der Zustand zu RequestPageReady wenn das lesen funktioniert hat oder zu RequestPageError wenn nicht. Wenn die Anfrage erfolgreich war kann die Page mit get_page() abgerufen werden.

Der gleiche Ansatz kann analog für andere API Funktionen verwendet werden.

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

Für state:

  • BrickletNFCRFID.STATE_INITIALIZATION = 0
  • BrickletNFCRFID.STATE_IDLE = 128
  • BrickletNFCRFID.STATE_ERROR = 192
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID = 2
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY = 130
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID_ERROR = 194
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE = 3
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY = 131
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR = 195
  • BrickletNFCRFID.STATE_WRITE_PAGE = 4
  • BrickletNFCRFID.STATE_WRITE_PAGE_READY = 132
  • BrickletNFCRFID.STATE_WRITE_PAGE_ERROR = 196
  • BrickletNFCRFID.STATE_REQUEST_PAGE = 5
  • BrickletNFCRFID.STATE_REQUEST_PAGE_READY = 133
  • BrickletNFCRFID.STATE_REQUEST_PAGE_ERROR = 197
BrickletNFCRFID.authenticate_mifare_classic_page(page, key_number, key)
Parameter:
  • page – Typ: int, Wertebereich: [0 bis 216 - 1]
  • key_number – Typ: int, Wertebereich: Siehe Konstanten
  • key – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
Rückgabe:
  • None

Mifare Classic Tags nutzen Authentifizierung. Wenn eine Page eines Mifare Classic Tags gelesen oder geschrieben werden soll muss diese zuvor Authentifiziert werden. Jede Page kann mit zwei Schlüsseln, A (key_number = 0) und B (key_number = 1), authentifiziert werden. Ein neues Mifare Classic Tag welches noch nicht beschrieben wurde kann über Schlüssel A mit dem Standardschlüssel [0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF] genutzt werden.

Der Ansatz um eine Mifare Classic Page zu lesen oder zu schreiben sieht wie folgt aus:

  1. Rufe request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe get_state() oder CALLBACK_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe authenticate_mifare_classic_page() mit Page und Schlüssel für die Page auf
  5. Warte auf einen Zustandswechsel auf AuthenticatingMifareClassicPageReady (siehe get_state() oder CALLBACK_STATE_CHANGED Callback)
  6. Rufe request_page() oder write_page() zum Lesen/Schreiben einer Page auf

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

Für key_number:

  • BrickletNFCRFID.KEY_A = 0
  • BrickletNFCRFID.KEY_B = 1
BrickletNFCRFID.write_page(page, data)
Parameter:
  • page – Typ: int, Wertebereich: [0 bis 216 - 1]
  • data – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255]
Rückgabe:
  • None

Schreibt 16 Bytes startend von der übergebenen Page. Wie viele Pages dadurch geschrieben werden hängt vom Typ des Tags ab. Die Pagegrößen verhalten sich wie folgt:

  • Mifare Classic Pagegröße: 16 byte (eine Page wird geschrieben)
  • NFC Forum Type 1 Pagegröße: 8 byte (zwei Pages werden geschrieben)
  • NFC Forum Type 2 Pagegröße: 4 byte (vier Pages werden geschrieben)

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

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

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

BrickletNFCRFID.request_page(page)
Parameter:
  • page – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • None

Liest 16 Bytes startend von der übergebenen Page und speichert sie in einem Buffer. Dieser Buffer kann mit get_page() ausgelesen werden. Wie viele Pages dadurch gelesen werden hängt vom Typ des Tags ab. Die Pagegrößen verhalten sich wie folgt:

  • Mifare Classic Pagegröße: 16 byte (eine Page wird gelesen)
  • NFC Forum Type 1 Pagegröße: 8 byte (zwei Pages werden gelesen)
  • NFC Forum Type 2 Pagegröße: 4 byte (vier Pages werden gelesen)

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

  1. Rufe request_tag_id() auf
  2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe get_state() oder CALLBACK_STATE_CHANGED Callback)
  3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe get_tag_id() auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
  4. Rufe request_page() mit der zu lesenden Page auf
  5. Warte auf einen Zustandswechsel auf RequestPageReady (siehe get_state() oder CALLBACK_STATE_CHANGED Callback)
  6. Rufe get_page() auf um die gespeicherte Page abzufragen

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

BrickletNFCRFID.get_page()
Rückgabe:
  • data – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255]

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

Fortgeschrittene Funktionen

BrickletNFCRFID.get_identity()
Rückgabeobjekt:
  • uid – Typ: str, Länge: bis zu 8
  • connected_uid – Typ: str, Länge: bis zu 8
  • position – Typ: chr, Wertebereich: ["a" bis "h", "i", "z"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, 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 '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.

Konfigurationsfunktionen für Callbacks

BrickletNFCRFID.register_callback(callback_id, function)
Parameter:
  • callback_id – Typ: int
  • function – Typ: callable
Rückgabe:
  • None

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

def my_callback(param):
    print(param)

nfc_rfid.register_callback(BrickletNFCRFID.CALLBACK_EXAMPLE, my_callback)

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

BrickletNFCRFID.CALLBACK_STATE_CHANGED
Callback-Parameter:
  • state – Typ: int, Wertebereich: Siehe Konstanten
  • idle – Typ: bool

Dieser Callback wird ausgelöst, wenn der Zustand des NFC/RFID Bricklets sich verändert. Siehe get_state() für mehr Informationen über die möglichen Zustände des Bricklets.

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

Für state:

  • BrickletNFCRFID.STATE_INITIALIZATION = 0
  • BrickletNFCRFID.STATE_IDLE = 128
  • BrickletNFCRFID.STATE_ERROR = 192
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID = 2
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY = 130
  • BrickletNFCRFID.STATE_REQUEST_TAG_ID_ERROR = 194
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE = 3
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY = 131
  • BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR = 195
  • BrickletNFCRFID.STATE_WRITE_PAGE = 4
  • BrickletNFCRFID.STATE_WRITE_PAGE_READY = 132
  • BrickletNFCRFID.STATE_WRITE_PAGE_ERROR = 196
  • BrickletNFCRFID.STATE_REQUEST_PAGE = 5
  • BrickletNFCRFID.STATE_REQUEST_PAGE_READY = 133
  • BrickletNFCRFID.STATE_REQUEST_PAGE_ERROR = 197

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletNFCRFID.get_api_version()
Rückgabeobjekt:
  • api_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, 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.

BrickletNFCRFID.get_response_expected(function_id)
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für function_id:

  • BrickletNFCRFID.FUNCTION_REQUEST_TAG_ID = 1
  • BrickletNFCRFID.FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
  • BrickletNFCRFID.FUNCTION_WRITE_PAGE = 5
  • BrickletNFCRFID.FUNCTION_REQUEST_PAGE = 6
BrickletNFCRFID.set_response_expected(function_id, response_expected)
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • None

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für function_id:

  • BrickletNFCRFID.FUNCTION_REQUEST_TAG_ID = 1
  • BrickletNFCRFID.FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
  • BrickletNFCRFID.FUNCTION_WRITE_PAGE = 5
  • BrickletNFCRFID.FUNCTION_REQUEST_PAGE = 6
BrickletNFCRFID.set_response_expected_all(response_expected)
Parameter:
  • response_expected – Typ: bool
Rückgabe:
  • None

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

Konstanten

BrickletNFCRFID.DEVICE_IDENTIFIER

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

Die get_identity() Funktion und der IPConnection.CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletNFCRFID.DEVICE_DISPLAY_NAME

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