Ruby - NFC Bricklet¶

Scan For Tags¶

Download (example_scan_for_tags.rb)

 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

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_nfc'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your NFC Bricklet

ipcon = IPConnection.new # Create IP connection
nfc = BrickletNFC.new 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
nfc.register_callback(BrickletNFC::CALLBACK_READER_STATE_CHANGED) do |state, idle|
  if state == BrickletNFC::READER_STATE_REQUEST_TAG_ID_READY
    ret = nfc.reader_get_tag_id
    tag_id = Array.new

    ret[1].each do |value|
      tag_id.push "0x%02X" % value
    end

    puts "Found tag of type #{ret[0]} with ID [#{tag_id.join(" ")}]"
  end

  if idle
    nfc.reader_request_tag_id
  end
end

# Enable reader mode
nfc.set_mode BrickletNFC::MODE_READER

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Emulate Ndef¶

Download (example_emulate_ndef.rb)

 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

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_nfc'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your NFC Bricklet
NDEF_URI = 'www.tinkerforge.com'

ipcon = IPConnection.new # Create IP connection
nfc = BrickletNFC.new 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
nfc.register_callback(BrickletNFC::CALLBACK_CARDEMU_STATE_CHANGED) do |state, idle|
  if state == BrickletNFC::CARDEMU_STATE_IDLE
    # Only short records are supported.
    ndef_record_uri = [
        0xD1,                # MB/ME/CF/SR=1/IL/TNF
        0x01,                # TYPE LENGTH
        NDEF_URI.length + 1, # Length
        'U'.ord,             # Type
        4                    # Status
    ]

    NDEF_URI.split('').each do |c|
      ndef_record_uri.push c.ord
    end

    nfc.cardemu_write_ndef ndef_record_uri
    nfc.cardemu_start_discovery
  elsif state == BrickletNFC::CARDEMU_STATE_DISCOVER_READY
    nfc.cardemu_start_transfer BrickletNFC::CARDEMU_TRANSFER_WRITE
  elsif state == BrickletNFC::CARDEMU_STATE_DISCOVER_ERROR
    puts "Discover error"
  elsif state == BrickletNFC::CARDEMU_STATE_TRANSFER_NDEF_ERROR
    puts "Transfer NDEF error"
  end
end

# Enable cardemu mode
nfc.set_mode BrickletNFC::MODE_CARDEMU

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Write Read Type2¶

Download (example_write_read_type2.rb)

 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

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_nfc'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your NFC Bricklet

ipcon = IPConnection.new # Create IP connection
nfc = BrickletNFC.new 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
nfc.register_callback(BrickletNFC::CALLBACK_READER_STATE_CHANGED) do |state, idle|
  if state == BrickletNFC::READER_STATE_IDLE
    nfc.reader_request_tag_id
  elsif state == BrickletNFC::READER_STATE_REQUEST_TAG_ID_READY
    ret = nfc.reader_get_tag_id

    if ret[0] != BrickletNFC::TAG_TYPE_TYPE2
      puts "Tag is not type-2"
      return
    end

    printf "Found tag of type #{ret[0]} with ID [0x%X 0x%X 0x%X 0x%X]\n",
           ret[0],
           ret[1][0],
           ret[1][1],
           ret[1][2],
           ret[1][3]

    nfc.reader_request_page 1, 4
  elsif state == BrickletNFC::READER_STATE_REQUEST_TAG_ID_ERROR
    puts "Request tag ID error"
  elsif state == BrickletNFC::READER_STATE_REQUEST_PAGE_READY
    page = nfc.reader_read_page
    printf "Page read: 0x%X 0x%X 0x%X 0x%X\n", page[0], page[1], page[2], page[3]
    nfc.reader_write_page 1, page
  elsif state == BrickletNFC::READER_STATE_WRITE_PAGE_READY
    puts "Write page ready"
  elsif state == BrickletNFC::READER_STATE_REQUEST_PAGE_ERROR
    puts "Request page error"
  elsif state == BrickletNFC::READER_STATE_WRITE_PAGE_ERROR
    puts "Write page error"
  end
end

# Enable reader mode
nfc.set_mode BrickletNFC::MODE_READER

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Grundfunktionen¶

BrickletNFC::new(uid, ipcon) → nfc¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	nfc – Typ: BrickletNFC

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

nfc = BrickletNFC.new 'YOUR_DEVICE_UID', ipcon

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

BrickletNFC#set_mode(mode) → nil¶

Parameter:	mode – Typ: int, 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

BrickletNFC#get_mode → int¶

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

Gibt den aktuellen Modus zurück, wie von #set_mode 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

BrickletNFC#reader_request_tag_id → nil¶

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 #reader_request_tag_id 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 ::CALLBACK_READER_STATE_CHANGED Callback zu registrieren oder den Zustand über #reader_get_state 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 #reader_get_tag_id 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 #reader_request_tag_id 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 #reader_request_tag_id muss erneut aufgerufen werden.

BrickletNFC#reader_get_tag_id → [int, [int, ...]]¶

Rückgabe-Array:	0: tag_type – Typ: int, Wertebereich: Siehe Konstanten 1: tag_id – Typ: [int, ...], 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 #reader_request_tag_id gefunden wurde.

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

1. Rufe #reader_request_tag_id auf
2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe #reader_get_state oder ::CALLBACK_READER_STATE_CHANGED Callback)
3. Rufe #reader_get_tag_id auf

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

Für tag_type:

• 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

BrickletNFC#reader_get_state → [int, bool]¶

Rückgabe-Array:	0: state – Typ: int, Wertebereich: Siehe Konstanten 1: idle – Typ: bool

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 #set_mode.

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 #reader_request_page 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 #reader_read_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:

• 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

BrickletNFC#reader_write_ndef(ndef) → nil¶

Parameter:	ndef – Typ: [int, ...], 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 #reader_request_tag_id auf
2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe #reader_get_state oder ::CALLBACK_READER_STATE_CHANGED Callback)
3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe #reader_get_tag_id auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
4. Rufe #reader_write_ndef mit der zu schreibenden NDEF Nachricht auf
5. Warte auf einen Zustandswechsel auf ReaderWriteNDEFReady (siehe #reader_get_state oder ::CALLBACK_READER_STATE_CHANGED Callback)

BrickletNFC#reader_request_ndef → nil¶

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 #reader_request_tag_id auf
2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe #reader_get_state oder ::CALLBACK_READER_STATE_CHANGED Callback)
3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe #reader_get_tag_id auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
4. Rufe #reader_request_ndef auf
5. Warte auf einen Zustandswechsel auf ReaderRequestNDEFReady (siehe #reader_get_state oder ::CALLBACK_READER_STATE_CHANGED Callback)
6. Rufe #reader_read_ndef auf um die gespeicherte NDEF Nachricht abzufragen

BrickletNFC#reader_read_ndef → [int, ...]¶

Rückgabe:	ndef – Typ: [int, ...], 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 #reader_request_ndef gefüllt werden.

BrickletNFC#reader_authenticate_mifare_classic_page(page, key_number, key) → nil¶

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]

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 #reader_request_tag_id auf
2. Warte auf einen Zustandswechsel auf ReaderRequestTagIDReady (siehe #reader_get_state oder ::CALLBACK_READER_STATE_CHANGED Callback)
3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe #reader_get_tag_id auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
4. Rufe #reader_authenticate_mifare_classic_page mit Page und Schlüssel für die Page auf
5. Warte auf einen Zustandswechsel auf ReaderAuthenticatingMifareClassicPageReady (siehe #reader_get_state oder ::CALLBACK_READER_STATE_CHANGED Callback)
6. Rufe #reader_request_page oder #reader_write_page 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 key_number:

• BrickletNFC::KEY_A = 0
• BrickletNFC::KEY_B = 1

BrickletNFC#reader_write_page(page, data) → nil¶

Parameter:	page – Typ: int, Wertebereich: Siehe Konstanten data – Typ: [int, ...], 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 #reader_request_tag_id auf
2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe #reader_get_state oder ::CALLBACK_READER_STATE_CHANGED callback)
3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe #reader_get_tag_id auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
4. Rufe #reader_write_page mit der Page sowie den zu schreibenden Daten auf
5. Warte auf einen Zustandswechsel auf ReaderWritePageReady (siehe #reader_get_state oder ::CALLBACK_READER_STATE_CHANGED Callback)

Wenn ein Mifare Classic Tag verwendet wird muss die Page authentifiziert werden bevor sie geschrieben werden kann. Siehe #reader_authenticate_mifare_classic_page.

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

BrickletNFC#reader_request_page(page, length) → nil¶

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

Liest maximal 8192 Bytes beginnend von der übergebenen Page und speichert sie in einem Buffer. Dieser Buffer kann mit #reader_read_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
• 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 #reader_request_tag_id auf
2. Warte auf einen Zustandswechsel auf RequestTagIDReady (siehe #reader_get_state oder ::CALLBACK_READER_STATE_CHANGED Callback)
3. Wenn mit einem bestimmten Tag gearbeitet werden soll, dann rufe #reader_get_tag_id auf und überprüfe, ob der erwartete Tag gefunden wurde, wenn er nicht gefunden wurde mit Schritt 1 fortfahren
4. Rufe #reader_request_page mit der zu lesenden Page auf
5. Warte auf einen Zustandswechsel auf ReaderRequestPageReady (siehe #reader_get_state oder ::CALLBACK_READER_STATE_CHANGED Callback)
6. Rufe #reader_read_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 #reader_authenticate_mifare_classic_page.

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

BrickletNFC#reader_read_page → [int, ...]¶

Rückgabe:	data – Typ: [int, ...], 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 #reader_request_page gefüllt werden.

BrickletNFC#cardemu_get_state → [int, bool]¶

Rückgabe-Array:	0: state – Typ: int, Wertebereich: Siehe Konstanten 1: idle – Typ: bool

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 #set_mode.

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 #cardemu_start_discovery 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

BrickletNFC#cardemu_start_discovery → nil¶

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 #cardemu_write_ndef und #cardemu_start_transfer übertragen werden.

BrickletNFC#cardemu_write_ndef(ndef) → nil¶

Parameter:	ndef – Typ: [int, ...], 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.

BrickletNFC#cardemu_start_transfer(transfer) → nil¶

Parameter:	transfer – Typ: int, 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 #cardemu_write_ndef 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

BrickletNFC#p2p_get_state → [int, bool]¶

Rückgabe-Array:	0: state – Typ: int, Wertebereich: Siehe Konstanten 1: idle – Typ: bool

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 #set_mode.

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 #p2p_start_discovery 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

BrickletNFC#p2p_start_discovery → nil¶

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 #p2p_write_ndef und #p2p_start_transfer übertragen werden.

BrickletNFC#p2p_write_ndef(ndef) → nil¶

Parameter:	ndef – Typ: [int, ...], 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.

BrickletNFC#p2p_start_transfer(transfer) → nil¶

Parameter:	transfer – Typ: int, 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 #p2p_write_ndef 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 #p2p_read_ndef 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

BrickletNFC#p2p_read_ndef → [int, ...]¶

Rückgabe:	ndef – Typ: [int, ...], 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 #p2p_start_transfer Aufruf mit einem Lese-Transfer der P2P Zustand zu P2PTransferNDEFReady ändert.

BrickletNFC#simple_get_tag_id(index) → [int, [int, ...], int]¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 7]
Rückgabe-Array:	0: tag_type – Typ: int, Wertebereich: Siehe Konstanten 1: tag_id – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255] 2: last_seen – Typ: int, 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 tag_type:

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

BrickletNFC#cardemu_set_tag_id(tag_id_length, tag_id_data) → nil¶

Parameter:	tag_id_length – Typ: int, Wertebereich: [0 bis 7] tag_id_data – Typ: [int, ...], 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).

BrickletNFC#cardemu_get_tag_id → [int, [int, ...]]¶

Rückgabe-Array:	0: tag_id_length – Typ: int, Wertebereich: [0 bis 7] 1: tag_id_data – Typ: [int, ...], Länge: 7, Wertebereich: [0 bis 255]

Gibt die Tag ID und Länge zurück, wie von #cardemu_set_tag_id gesetzt.

Neu in Version 2.1.0 (Plugin).

Fortgeschrittene Funktionen¶

BrickletNFC#set_detection_led_config(config) → nil¶

Parameter:	config – Typ: int, 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

BrickletNFC#get_detection_led_config → int¶

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

Gibt die Konfiguration zurück, wie von #set_detection_led_config 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

BrickletNFC#set_maximum_timeout(timeout) → nil¶

Parameter:	timeout – Typ: int, 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 #reader_request_tag_id 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).

BrickletNFC#get_maximum_timeout → int¶

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

Gibt das Timeout zurück, wie von #set_maximum_timeout gesetzt.

Neu in Version 2.0.1 (Plugin).

BrickletNFC#get_spitfp_error_count → [int, int, int, int]¶

Rückgabe-Array:	0: error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] 2: error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1] 3: error_count_overflow – Typ: int, 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.

BrickletNFC#set_status_led_config(config) → nil¶

Parameter:	config – Typ: int, 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

BrickletNFC#get_status_led_config → int¶

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

Gibt die Konfiguration zurück, wie von #set_status_led_config 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

BrickletNFC#get_chip_temperature → int¶

Rückgabe:	temperature – Typ: int, 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.

BrickletNFC#reset → nil¶

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.

BrickletNFC#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Rückgabe-Array:

0: uid – Typ: str, Länge: bis zu 8 1: connected_uid – Typ: str, Länge: bis zu 8 2: position – Typ: chr, Wertebereich: ['a' bis 'h', 'z'] 3: 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] 4: 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] 5: 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 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.

Konfigurationsfunktionen für Callbacks¶

BrickletNFC#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameter:	callback_id – Typ: int

Registriert den block 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 der Callback ID und der zweite Parameter der Block:

nfc.register_callback BrickletNFC::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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

BrickletNFC::CALLBACK_READER_STATE_CHANGED¶

Callback-Parameter:	state – Typ: int, Wertebereich: Siehe Konstanten idle – Typ: bool

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

• 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

BrickletNFC::CALLBACK_CARDEMU_STATE_CHANGED¶

Callback-Parameter:	state – Typ: int, Wertebereich: Siehe Konstanten idle – Typ: bool

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

• 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

BrickletNFC::CALLBACK_P2P_STATE_CHANGED¶

Callback-Parameter:	state – Typ: int, Wertebereich: Siehe Konstanten idle – Typ: bool

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

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

BrickletNFC#get_api_version → [int, ...]¶

Rückgabe-Array:	0: 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.

BrickletNFC#get_response_expected(function_id) → bool¶

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:

• 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

BrickletNFC#set_response_expected(function_id, response_expected) → nil¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten response_expected – Typ: bool

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

• 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

BrickletNFC#set_response_expected_all(response_expected) → nil¶

Parameter:	response_expected – Typ: bool

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

BrickletNFC#set_bootloader_mode(mode) → int¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: int, 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

BrickletNFC#get_bootloader_mode → int¶

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

Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode.

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

BrickletNFC#set_write_firmware_pointer(pointer) → nil¶

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

Setzt den Firmware-Pointer für #write_firmware. 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.

BrickletNFC#write_firmware(data) → int¶

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

Schreibt 64 Bytes Firmware an die Position die vorher von #set_write_firmware_pointer 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.

BrickletNFC#write_uid(uid) → nil¶

Parameter:	uid – Typ: int, 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.

BrickletNFC#read_uid → int¶

Rückgabe:	uid – Typ: int, 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¶

BrickletNFC::DEVICE_IDENTIFIER¶

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

BrickletNFC::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines NFC Bricklet dar.