uFR Shell est une interface logicielle en ligne de commande pour l’exécution de commandes matérielles de la série μFR sur plusieurs systèmes d’exploitation. Comme le titre du logiciel le suggère, il s’agit d’un environnement shell avec un ensemble de variables définies par les bibliothèques de lecteurs μFR.
Docs & Software Download
Présentation du logiciel
Fonctions logicielles :
- Ensemble de fonctions définies par les bibliothèques de la série μFR et l’API (Application Programming Interface).
Langages de programmation disponibles :
- Logiciel exécutable
Systèmes d’exploitation, plates-formes et environnements pris en charge :
- Système d’exploitation Windows
- Système d’exploitation Linux
- MAC OS
- Pi framboise
Balises, étiquettes, cartes prises en charge :
- MIFARE Mini®
- MIFARE Classic® (1K, 4K, EV1)
- MIFARE Ultraléger®
- MIFARE Ultralight C®
- MIFARE Plus® (2K, 4K)
- MIFARE DESFire® (Léger, 2K, 4K, 8K, EV1, EV2)
- NXP NTAG® 21x (210, 213, 215, 216, Tag Tamper)
- ADN NXP NTAG® 4xx (413, 424)
Matériel recommandé :
- μFR Nano
- μFR Nano en ligne
- μFR Classique
- μFR Classic CS
- μFR Avance
- μFR XL
- HD de base (mode de compatibilité μFR)
Téléchargement de logiciels
Description
Le logiciel exécutable uFR Shell permet l’exécution en ligne de commande pour les périphériques de la série μFR en mode console.
Manuel du logiciel
1. uFR Shell – Installer et exécuter
Télécharger: ufr-shell
Téléchargez et décompressez le fichier logiciel.
Le dossier racine du fichier extrait contient les sous-dossiers contenant les fichiers exécutifs du logiciel uFR Shell pour les systèmes d’exploitation pris en charge.
Le dossier racine contient également la liste des fonctions logicielles et des instructions supplémentaires.
Si vous avez correctement installé votre matériel et les pilotes associés, vous pouvez maintenant sélectionner et exécuter le fichier exécutable pour votre système d’exploitation actuel.
2. uFR Shell – Interface de ligne de commande
Quel que soit le système d’exploitation, le logiciel uFR Shell s’exécute en tant que terminal de commande. La version du logiciel s’affiche dans la première ligne de l’écran.
3. uFR Shell – Fonctions logicielles
Pour utiliser le logiciel uFR Shell pour l’exécution des commandes sur votre appareil uFR, vous devez avoir un aperçu de toutes les fonctions disponibles. Vous pouvez trouver la liste des fonctions dans le dossier racine du logiciel, le fichier UFR-Shell_list-of-functions.txt.
Vous trouverez plus de détails, ainsi que des instructions pour l’implémentation et l’application des fonctions dans API Docs.
3.1 – uFR Shell – Exécution en ligne de commande
Pour sélectionner la fonction adaptée à votre ligne de commande, nous vous recommandons d’étudier d’abord l’aide de la fonction avec toutes les descriptions des fonctions.
3.2 – uFR Shell – Exemples d’exécution en ligne de commande
Voyons maintenant comment cela fonctionne.
Tout d’abord, nous devons établir une communication avec le lecteur μFR connecté. Donc, notre première commande va être ReaderOpen.
Tapez la commande :
- ReaderOuvrir
Si le statut du lecteur est OK, nous pouvons continuer. Sinon, veuillez vérifier si vous avez installé votre matériel correctement.
EXAMPLE 1
Pour obtenir le numéro de série du matériel, utilisez la commande :
- GetReaderSerialNumber
Si aucun paramètre supplémentaire n’est défini dans la commande, la sortie par défaut a un format HEX.
EXAMPLE 2
Pour obtenir la sortie de données dans un autre format, vous devez spécifier le mode de format de sortie parmi les disponibles:
- Hexadécimal (paramètre h),
- Chaîne (paramètre s)
- Décimal (paramètre d).
La ligne de commande pour le format de sortie spécifié aura maintenant deux éléments :
- 'Fonction' ' mode paramètre.'
EXAMPLE 3
Comme pour le numéro de série du lecteur, pour obtenir la sortie par défaut de l’ID de carte, utilisez simplement la commande:
- GetCardIdEx
Pour cette ligne de commande, la console affiche le type de carte, l’UID et la sortie UID au format HEX par défaut.
EXAMPLE 4
La sortie CARD ID a des valeurs de sortie d’arborescence. L’exemple précédent montre la sortie Card ID sans mode de paramètre défini dans la ligne
de commandeCet exemple explique comment obtenir un format de sortie mixte. uFR Shell vous permet de définir le mode de paramètre spécifique pour chaque valeur de sortie.
La ligne de commande doit ressembler à ceci :
- 'Fonction' '1. mode paramètre' '2. mode paramètre' '3. mode paramètre'
EXAMPLE 5
Si vous ne définissez pas tous les paramètres dans votre ligne de commande, le format de volume de sortie sans le mode de paramètre attribué conservera le format HEX (par défaut).
La ligne de commande pour les modes d’arborescence attendus et les modes à deux paramètres prédéfinis a la structure suivante :
- 'Fonction' '1. mode paramètre' '2. mode paramètre'
La section 3.2 explique comment définir le format de la valeur de sortie pour un paramètre spécifié. Toutefois, si vous devez obtenir fréquemment la sortie dans un format non hexadécimal, vous pouvez modifier le format par défaut pour toutes les valeurs de sortie au lieu de définir chaque paramètre séparément.
Pour le changement permanent de format de sortie (jusqu’à ce que la console actuelle soit fermée), exécutez la ligne de commande :
- Définir le mode des nouveaux paramètres de sortie
La capture d’écran ci-dessus montre le format de valeur d’entrée par défaut prédéfini sur String (paramètre s).
EXAMPLE 1
Exécutons maintenant le test avec la ligne de commande simple:
- GetCardIdEx
Maintenant, les résultats de sortie sont des valeurs de chaîne même si la ligne de commande n’a pas de mode de paramètre supplémentaire défini.
Comme vous pouvez le voir, toutes les valeurs de sortie sont des valeurs de chaîne avec la barre oblique inverse () à l’endroit de leur premier caractère. Le logiciel ajoute automatiquement ce caractère aux valeurs de sortie contenant les caractères non imprimables.
EXAMPLE 2
L’exemple suivant présente la sortie de chaîne lorsque la valeur est imprimable.
Écrivons le contenu dans la carte avec des caractères imprimables uniquement.
L’exemple de ligne de commande est :
- WriteUserData « Exemple-Test »
Remarque : Le contenu de la chaîne à enregistrer est écrit entre guillemets dans la ligne de commande.
Maintenant, lisez la sortie de contenu. La ligne de commande est :
- ReadUserData
Dans ce cas, la sortie n’a pas de barre oblique inverse au début. Le reste du contenu de sortie (après le contenu précédemment enregistré) sont des valeurs par défaut – des octets inutilisés affichés sous forme de valeurs xFF.
4. uFR Shell – Différences d’implémentation dans les environnements de système d’exploitation pris en charge
- Système d’exploitation Windows – L’implémentation sur le système Windows ne nécessite pas d’autorisations supplémentaires pour fonctionner avec les fonctions uFR Shell. Il suffit d’installer correctement le lecteur ufr et ses bibliothèques.
- Système d’exploitation Linux – Comme d’habitude dans le système Linux, la fonctionnalité complète du logiciel uFR Shell en communication avec l’appareil nécessite l’autorisation appropriée de l’utilisateur.
- MacOS – Pour garantir la fonctionnalité logicielle instantanée sur ce système d’exploitation, copiez la bibliothèque libuRCoder.dylib dans le dossier des bibliothèques système.
Ce manuel présente des exemples de logiciels avec plusieurs fonctions essentielles. Une liste de toutes les fonctions prises en charge est incluse dans le package de téléchargement du logiciel.