uFR Shell ist eine Befehlszeilen-Softwareschnittstelle für die Ausführung von Hardwarebefehlen der μFR-Serie auf mehreren Betriebssystemen. Wie der Softwaretitel andeutet, handelt es sich um eine Shell-Umgebung mit einer Reihe von Variablen, die von den μFR-Reader-Bibliotheken definiert werden.
Docs & Software Download
Software-Übersicht
Software-Funktionen:
- Eine Reihe von Funktionen, die von Bibliotheken und API (Application Programming Interface) der μFR-Serie definiert werden.
Verfügbare Programmiersprachen:
- Ausführbare Software
Unterstützte Betriebssysteme, Plattformen und Umgebungen:
- Windows OS
- Linux OS
- MAC-Betriebssystem
- Raspberry Pi
Unterstützte Tags, Etiketten, Karten:
- MIFARE Mini®
- MIFARE Classic® (1K, 4K, EV1)
- MIFARE Ultraleichtflugzeug®
- MIFARE Ultraleichtflugzeug C®
- MIFARE Plus® (2K, 4K)
- MIFARE DESFire® (Licht, 2K, 4K, 8K, EV1, EV2)
- NXP NTAG® 21x (210, 213, 215, 216, Tag Tamper)
- NXP NTAG® 4xx DNA (413, 424)
Empfohlene Hardware:
- μFR Nano
- μFR Nano Online
- μFR Klassisch
- μFR Klassische CS
- μFR Vorschub
- μFR XL
- Base HD (μFR-Kompatibilitätsmodus)
Software-Download
Beschreibung
Die ausführbare uFR Shell-Software ermöglicht die Befehlszeilenausführung für Geräte der μFR-Serie im Konsolenmodus.
Software-Handbuch
1. uFR Shell – Installieren und ausführen
Download: ufr-shell
Laden Sie die Softwaredatei herunter und entpacken Sie sie.
Der extrahierte Dateistammordner enthält die Unterordner mit uFR Shell Software Executive Files für unterstützte Betriebssysteme.
Der Stammordner enthält auch die Liste der Softwarefunktionen und zusätzliche Anweisungen.
Wenn Sie Ihre Hardware und die zugehörigen Treiber korrekt installiert haben, können Sie jetzt die ausführbare Datei für Ihr aktuelles Betriebssystem auswählen und ausführen.
2. uFR Shell – Befehlszeilenschnittstelle
Unabhängig vom Betriebssystem läuft die uFR Shell Software als Command Terminal. Die Softwareversion wird in der ersten Zeile des Bildschirms angezeigt.
3. uFR Shell – Softwarefunktionen
Um die uFR Shell Software für die Ausführung der Befehle auf Ihrem uFR-Gerät nutzen zu können, benötigen Sie Einblick in alle verfügbaren Funktionen. Sie finden die Funktionsliste im Software-Stammordner, Datei UFR-Shell_list-of-functions.txt.
Weitere Details sowie Anweisungen zur Implementierung und Anwendung von Funktionen finden Sie in API Docs.
3.1 – uFR Shell – Befehlszeilenausführung
Um die richtige Funktion für Ihre Befehlszeile auszuwählen, empfehlen wir Ihnen, zuerst die Funktionshilfe mit allen Funktionsbeschreibungen zu lesen.
3.2 – uFR Shell – Beispiele für die Befehlszeilenausführung
Lassen Sie uns nun sehen, wie es funktioniert.
Zuerst müssen wir die Kommunikation mit dem angeschlossenen μFR-Lesegerät herstellen. Unser erster Befehl wird also ReaderOpen sein.
Geben Sie den folgenden Befehl ein:
- ReaderÖffnen
Wenn der Leserstatus in Ordnung ist, können wir fortfahren. Ansonsten überprüfen Sie bitte, ob Sie Ihre Hardware korrekt installiert haben.
EXAMPLE 1
Verwenden Sie den folgenden Befehl, um die Seriennummer der Hardware abzurufen:
- GetReaderSerialNumber
Wenn für den Befehl keine zusätzlichen Parameter definiert sind, hat die Standardausgabe ein HEX-Format.
EXAMPLE 2
Um die Datenausgabe in einem anderen Format zu erhalten, müssen Sie den Ausgabeformatmodus unter den verfügbaren angeben:
- Hexadezimal (Parameter h),
- Zeichenfolge (Parameter s)
- Dezimal (Parameter d).
Die Befehlszeile für das angegebene Ausgabeformat besteht nun aus zwei Elementen:
- 'Funktion' ' Parametermodus.'
EXAMPLE 3
Wie bei der Seriennummer des Lesegeräts verwenden Sie einfach den folgenden Befehl, um die Standardausgabe der Karten-ID zu erhalten:
- GetCardIdEx
Für diese Befehlszeile zeigt die Konsole den Kartentyp, die UID und die UID-Ausgabe im Standard-HEX-Format an.
EXAMPLE 4
Die Karten-ID-Ausgabe hat Baumausgabewerte. Das vorherige Beispiel zeigt die Karten-ID-Ausgabe ohne definierten Parametermodus in der Befehlszeile
In diesem Beispiel wird erläutert, wie Sie ein gemischtes Ausgabeformat erhalten. Mit der uFR Shell können Sie den spezifischen Parametermodus für jeden Ausgabewert definieren.
Die Befehlszeile sollte wie folgt aussehen:
-
- 'Funktion' '1. Parametermodus' '2. Parametermodus' '3. Parametermodus'
EXAMPLE 5
Wenn Sie nicht alle Parameter in Ihrer Befehlszeile definieren, behält das Ausgabevolumenformat ohne den zugewiesenen Parametermodus das HEX-Format (Standard) bei.
Die Befehlszeile für erwartete Baumwerte und vordefinierte Modi mit zwei Parametern hat die folgende Struktur:
- 'Funktion' '1. Parametermodus' '2. Parametermodus'
In Abschnitt 3.2 wird erläutert, wie das Ausgabewertformat für einen angegebenen Parameter definiert wird. Wenn Sie die Ausgabe jedoch häufig in einem nicht-hexadezimalen Format erhalten müssen, können Sie das Standardformat für alle Ausgabewerte ändern, anstatt jeden Parameter separat zu definieren.
Führen Sie für die permanente Änderung des Ausgabeformats (bis die aktuelle Konsole geschlossen ist) die Befehlszeile aus:
- Ausgabe ' neuen Parametermodus' einstellen
Die Abbildung oben zeigt das Standard-Eingabewertformat, das auf String (Parameter s) voreingestellt ist.
EXAMPLE 1
Lassen Sie uns nun den Test mit der einfachen Befehlszeile ausführen:
- GetCardIdEx
Jetzt sind die Ausgabeergebnisse Zeichenfolgenwerte, obwohl die Befehlszeile keinen zusätzlichen Parametermodus definiert hat.
Wie Sie sehen können, handelt es sich bei allen Ausgabewerten um Zeichenfolgenwerte mit dem umgekehrten Schrägstrich () an der Stelle ihres ersten Zeichens. Die Software fügt dieses Zeichen automatisch zu den Ausgabewerten hinzu, die die nicht druckbaren Zeichen enthalten.
EXAMPLE 2
Im nächsten Beispiel wird die Zeichenfolgenausgabe dargestellt, wenn der Wert druckbar ist.
Schreiben wir den Inhalt nur mit druckbaren Zeichen in die Karte.
Die Beispielbefehlszeile lautet:
- WriteUserData "Beispiel-Test"
Hinweis: Der aufzuzeichnende Zeichenfolgeninhalt wird in der Befehlszeile in Anführungszeichen geschrieben.
Lesen Sie nun die Inhaltsausgabe. Die Befehlszeile lautet:
-
- ReadUserData
In diesem Fall hat die Ausgabe am Anfang keinen umgekehrten Schrägstrich. Der Rest des Ausgabeinhalts (nach dem zuvor aufgezeichneten Inhalt) sind Standardwerte – nicht verwendete Bytes, die als xFF-Werte angezeigt werden.
4. uFR Shell – Implementierungsunterschiede in unterstützten Betriebssystemumgebungen
- Windows-Betriebssystem – Die Implementierung auf dem Windows-System erfordert keine zusätzlichen Berechtigungen, um mit uFR-Shell-Funktionen zu arbeiten. Es genügt, den ufr-Reader und seine Bibliotheken ordnungsgemäß zu installieren.
- Linux-Betriebssystem – Wie im Linux-System üblich, erfordert die volle Funktionalität der uFR Shell-Software in der Kommunikation mit dem Gerät eine entsprechende Benutzerberechtigung.
- MacOS – Um die sofortige Softwarefunktionalität unter diesem Betriebssystem sicherzustellen, kopieren Sie die Bibliothek libuRCoder.dylib in den Ordner der Systembibliotheken.
Dieses Handbuch stellt Softwarebeispiele mit mehreren wesentlichen Funktionen vor. Eine Liste aller unterstützten Funktionen ist im Software-Download-Paket enthalten.