uFR Shell — это программный интерфейс командной строки для выполнения аппаратных команд серии μFR в нескольких операционных системах. Как следует из названия программного обеспечения, это среда оболочки с набором переменных, определенных библиотеками чтения μFR.
Docs & Software Download
Обзор программного обеспечения
Функции программного обеспечения:
- Набор функций, определенных библиотеками серии μFR и API (интерфейс прикладного программирования).
Доступные языки программирования:
- Исполняемое программное обеспечение
Поддерживаемые операционные системы, платформы и среды:
- ОС Windows
- ОС Linux
- MAC OS
- Малина Пи
Поддерживаемые теги, наклейки, карты:
- МИФАРЕ Мини®
- МИФАРЕ Классик® (1K, 4K, EV1)
- МИФАРЕ Ультралайт®
- МИФАРЕ Ультралайт С®
- МИФАРЕ Плюс® (2K, 4K)
- MIFARE DESFire® (Легкий, 2K, 4K, 8K, EV1, EV2)
- NXP NTAG® 21x (210, 213, 215, 216, Tag Tamper)
- NXP NTAG® 4xx ДНК (413, 424)
Рекомендуемое оборудование:
- мкФР Нано
- μFR Нано Онлайн
- мкФР Классик
- мкФР Классик КС
- μFR Аванс
- мкФР XL
- Базовый HD (режим совместимости с мкФР)
Загрузка программного обеспечения
Описание
Исполняемое программное обеспечение uFR Shell позволяет выполнять командную строку для устройств серии μFR в консольном режиме.
Руководство по программному обеспечению
1. оболочка uFR — Установка и выполнение
Скачать: ufr-shell
Загрузите и распакуйте файл программного обеспечения.
Извлеченная корневая папка содержит вложенные папки с исполнительными файлами программного обеспечения uFR Shell для поддерживаемых операционных систем.
Корневая папка также содержит список функций программного обеспечения и дополнительные инструкции.
Если оборудование и связанные с ним драйверы установлены правильно, теперь можно выбрать и запустить исполняемый файл для текущей операционной системы.
2. uFR Shell — Интерфейс командной строки
Независимо от операционной системы, программное обеспечение uFR Shell работает как командный терминал. Версия программного обеспечения отображается в первой строке экрана.
3. uFR Shell — Программные функции
Чтобы использовать программное обеспечение uFR Shell для выполнения команд на вашем устройстве uFR, вам необходимо иметь представление обо всех доступных функциях. Вы можете найти список функций в корневой папке программного обеспечения, файле UFR-Shell_list-of-functions.txt.
Более подробную информацию, а также инструкции по реализации и применению функций можно найти в ДОКУМЕНТАЦИИ ПО API.
3.1 — uFR Shell — Выполнение командной строки
Чтобы выбрать правильную функцию для командной строки, мы рекомендуем сначала изучить справку по функциям с описанием всех функций.
3.2 — оболочка uFR — Примеры выполнения командной строки
Теперь давайте посмотрим, как это работает.
Во-первых, нам нужно установить связь с подключенным считывателем μFR. Итак, нашей первой командой будет ReaderOpen.
Введите команду:
- ЧитательОткрыть
Если состояние читателя в порядке, мы можем продолжить. В противном случае проверьте, правильно ли вы установили оборудование.
EXAMPLE 1
Чтобы получить серийный номер оборудования, используйте команду:
- GetReaderSerialNumber
Если команда не имеет определенных дополнительных параметров, выходные данные по умолчанию имеют формат HEX.
EXAMPLE 2
Чтобы получить вывод данных в каком-либо другом формате, необходимо указать режим формата вывода среди доступных:
- Шестнадцатеричный (параметр h),
- Строка (параметр s)
- Десятичная дробь (параметр d).
Командная строка для указанного формата вывода теперь будет иметь два элемента:
- 'Функция' 'режим параметров''
EXAMPLE 3
Как и в случае с серийным номером Reader, чтобы получить выходные данные Card ID по умолчанию, просто используйте команду:
- GetCardIdEx
Для этой командной строки консоль отобразит выходные данные Card type, UID и UID в формате HEX по умолчанию.
EXAMPLE 4
Выходные данные Card ID имеют древовидные выходные значения. В предыдущем примере показаны выходные данные Card ID без определенного режима параметра в команднойстроке В этом примере объясняется, как получить смешанный выходной формат. uFR Shell позволяет определить конкретный режим параметра для каждого выходного значения.
Командная строка должна выглядеть следующим образом:
-
- 'Функция' '1. режим параметра' '2. режим параметра' '3. режим параметра'
EXAMPLE 5
Если в командной строке не определены все параметры, формат выходного тома без режима назначенных параметров сохранит формат HEX (по умолчанию).
Командная строка для ожидаемых значений дерева и предопределенных двухпараметрических режимов имеет следующую структуру:
- 'Функция' '1. режим параметра' '2. режим параметра'
В разделе 3.2 объясняется, как определить формат выходного значения для указанного параметра. Однако если необходимо часто получать выходные данные в негексадимальном формате, можно изменить формат по умолчанию для всех выходных значений вместо определения каждого параметра отдельно.
Для постоянного изменения формата вывода (пока текущая консоль не будет закрыта), запустите командную строку:
- Установить режим вывода 'новые параметры'
На снимке экрана выше показан формат входного значения по умолчанию, предустановленный в String (параметр s).
EXAMPLE 1
Теперь давайте запустим тест с помощью простой командной строки:
- GetCardIdEx
Теперь выходные результаты являются строковыми значениями, даже если в командной строке не определен режим дополнительных параметров.
Как видите, все выходные значения являются строковыми значениями с символом Обратной косой черты () в месте их первого символа. Программа автоматически добавляет этот символ к выходным значениям, содержащим непечатаемые символы.
EXAMPLE 2
В следующем примере представлены строковые выходные данные, когда значение можно распечатать.
Давайте запишем содержимое в карточку только печатными символами.
Пример командной строки:
- WriteUserData "Пример-Тест"
Примечание: Строковое содержимое записывается в кавычках в командной строке.
Теперь прочитайте выходные данные контента. Командная строка:
-
- ЧтениеПользовательскиеданные
В этом случае выходные данные не имеют символа обратной косой черты в начале. Остальная часть выходного содержимого (после ранее записанного содержимого) является значениями по умолчанию — неиспользуемыми байтами, отображаемыми как значения xFF.
4. uFR Shell — Различия в реализации в поддерживаемых средах ОС
- ОС Windows — реализация в системе Windows не требует дополнительных разрешений для работы с функциями uFR Shell. Достаточно правильно установить ufr reader и его библиотеки.
- ОС Linux — как обычно в системе Linux, полная функциональность программного обеспечения uFR Shell при взаимодействии с устройством требует соответствующего разрешения пользователя.
- MacOS — чтобы обеспечить мгновенную работу программного обеспечения в этой ОС, скопируйте библиотеку libuRCoder.dylib в папку системных библиотек.
В этом руководстве представлены примеры программного обеспечения с несколькими основными функциями. Список всех поддерживаемых функций включен в пакет загрузки программного обеспечения.
