Ruby - NFC/RFID Bricklet

Dies ist die Beschreibung der Ruby 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 Ruby 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.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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_nfc_rfid'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
nr = BrickletNFCRFID.new UID, ipcon # Create device object
current_tag_type = 0

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

# Register state changed callback
nr.register_callback(BrickletNFCRFID::CALLBACK_STATE_CHANGED) do |state, idle|
  if state == BrickletNFCRFID::STATE_REQUEST_TAG_ID_READY
    tag_type, tid_length, tid = nr.get_tag_id
    puts "Found tag of type #{tag_type} with ID " +
         "#{tid.take(tid_length).each.map { |b| b.to_s(16) }.join ' '}"
  end

  # Cycle through all types
  if idle
    current_tag_type = (current_tag_type + 1) % 3
    nr.request_tag_id current_tag_type
  end
end

# Start scan loop
nr.request_tag_id BrickletNFCRFID::TAG_TYPE_MIFARE_CLASSIC

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_nfc_rfid'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
nr = BrickletNFCRFID.new UID, ipcon # Create device object

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

# Register state changed callback
nr.register_callback(BrickletNFCRFID::CALLBACK_STATE_CHANGED) do |state, idle|
  if state == BrickletNFCRFID::STATE_REQUEST_TAG_ID_READY
    puts "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
    puts "Writing data..."
  elsif state == BrickletNFCRFID::STATE_WRITE_PAGE_READY
    # Request pages 5-8
    nr.request_page 5
    puts "Requesting data..."
  elsif state == BrickletNFCRFID::STATE_REQUEST_PAGE_READY
    # Get and print pages
    data = nr.get_page
    puts "Read data: #{data}"
  elsif (state & (1 << 6)) == (1 << 6)
    # All errors have bit 6 set
    puts "Error: #{state}"
  end
end

# Select NFC Forum Type 2 tag
nr.request_tag_id BrickletNFCRFID::TAG_TYPE_TYPE2

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletNFCRFID::new(uid, ipcon) → nfc_rfid
Parameter:
  • uid -- str
  • ipcon -- IPConnection

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

nfc_rfid = BrickletNFCRFID.new 'YOUR_DEVICE_UID', ipcon

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

BrickletNFCRFID#request_tag_id(tag_type) → nil
Parameter:tag_type -- int

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:

  • BrickletNFCRFID::TAG_TYPE_MIFARE_CLASSIC = 0
  • BrickletNFCRFID::TAG_TYPE_TYPE1 = 1
  • BrickletNFCRFID::TAG_TYPE_TYPE2 = 2
BrickletNFCRFID#get_tag_id → [int, int, [int, int, ..4x.., int]]

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:

  • BrickletNFCRFID::TAG_TYPE_MIFARE_CLASSIC = 0
  • BrickletNFCRFID::TAG_TYPE_TYPE1 = 1
  • BrickletNFCRFID::TAG_TYPE_TYPE2 = 2

Das zurückgegebene Array enthält die Werte tag_type, tid_length und tid.

BrickletNFCRFID#get_state → [int, 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:

  • 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

Das zurückgegebene Array enthält die Werte state und idle.

BrickletNFCRFID#authenticate_mifare_classic_page(page, key_number, key) → nil
Parameter:
  • page -- int
  • key_number -- int
  • key -- [int, int, ..3x.., int]

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:

  • BrickletNFCRFID::KEY_A = 0
  • BrickletNFCRFID::KEY_B = 1
BrickletNFCRFID#write_page(page, data) → nil
Parameter:
  • page -- int
  • data -- [int, int, ..13x.., int]

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) → nil
Parameter:page -- int

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 → [int, int, ..13x.., int]

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_api_version → [int, int, int]

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletNFCRFID#get_response_expected(function_id) → bool
Parameter:function_id -- int

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.

Siehe #set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletNFCRFID#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id -- int
  • response_expected -- 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • 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) → nil
Parameter:response_expected -- bool

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

BrickletNFCRFID#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Das zurückgegebene Array enthält die Werte uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

BrickletNFCRFID#register_callback(callback_id) { |param [, ...]| block } → nil
Parameter:callback_id -- 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_rfid.register_callback BrickletNFCRFID::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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
Parameter:
  • state -- int
  • idle -- 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:

  • 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

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.