SAUK. Протокол WEB-API для Wi-Fi и Ethernet
Журнал версий
| Версия | Дата | Комментарий |
|---|---|---|
| V.1.0 | 20.05.2022 | Выпуск документа |
| V.1.1 | 15.08.2022 | Добавление команд группы rfidconfig |
| V.1.2 | 18.10.2022 | Добавление команд группы peripheryconfig |
| V.1.3 | 12.11.2022 | Добавление команд группы tagidentity |
| V.1.4 | 05.05.2023 | Добавление команд группы netinfo |
| V.1.5 | 22.01.2023 | Общая корректировка, актуализация синтаксиса |
Комментарии к тексту документа
В документации применяется IP-адрес системы 192.168.10.1, этот адрес может отличаться от текущих настроек Вашего прибора. Перед выполнением http запросов, описанных в настоящем документе, пожалуйста, убедитесь, что используемый IP-адрес актуален.
Терминология
| Термин \ фраза | Комментарий |
|---|---|
| Инвентаризация | Процесс чтения RFID-меток, которые попали в зону действия системы. В настоящей документации процесс инвентаризации также называется непрерывное сканирование. |
| Таблица идентификации | Внутренний буфер прибора SAUK, в котором хранится информация о прочитанной RFID-метке. |
| Хост | Устройство клиента, которое работает с RFID-системой SAUK. Хостом может выступать сервер, персональный компьютер, ноутбук, смартфон, программируемый логический контроллер, микропроцессорная плата и другие устройства, поддерживающие работу в сети Ethernet и/или Wi-Fi. |
| Вкладка меню №1 | RFID-параметры устройства. Частоты, мощность излучения и управление антеннами |
| Вкладка меню №2 | RFID-метки. Идентификация, фильтрация и каналы уведомления на хост |
| Вкладка меню №3 | Реле и цифровые порты Wiegand |
| Вкладка меню №4 | Дата и время. Настройка системного времени |
| Вкладка меню №5 | Wi-Fi и Ethernet. Параметры сети |
1. Общее описание
RFID-системы SAUK с поддержкой сетевых интерфейсов Ethernet или Wi-Fi, могут быть интегрированы в сторонние информационно-учетные системы с применением унифицированного открытого протокола «WEB API. Коммутационный протокол для RFID-систем SAUK». Протокол, описываемый в настоящем документе, является разновидностью API клиент-серверной архитектуры REST (Representational State Transfer).
1.1. Процесс инвентаризации меток и таблица идентификации
В этой главе описываются способы включения процесса инвентаризации меток (сканирования меток), а также описано, как метка и её идентификационные данные, представлены в оперативной памяти прибора. Способы включения процесса инвентаризации меток:
1 Если вы работаете в режиме непрерывной инвентаризации, то значение параметра «Считываний за 1 команду» следует установить в 1.
В том или ином случае активируется сканирование RFID-меток. При возникновении RFID-метки в зоне действия системы, она идентифицируется мгновенно, после чего попадает в буфер «Таблица идентификации», при этом, запись о каждой метке дополняется системным временем идентификации метки RTC2 , номером антенны ANT3 , силой RSSI сигнала отметка метки, счётчиком успешных сканирований метки CNT (в зависимости от настроек, может считываться дополнительная область памяти метки, например TID или USER). В большинстве случаев этой информации вполне достаточно для последующей постобработки и аналитики данных. После попадания метки в таблицу идентификации, вышеуказанные данные будут обновлены по истечению таймаута «Время сна метки». Ключевым полем для поиска метки в таблице идентификации является EPC-номер метки. 2 Если вы работаете в режиме непрерывной инвентаризации, то значение параметра «Считываний за 1 команду» следует установить в 1. 3 Для системы с одной антенной типа моноблок – номер всегда №1. Для многопортовых систем – от 1 до 4 Пример данных из таблицы идентификации:
Каждый раз при успешном сканировании RFID-метки счетчик CNT будет инкрементироваться на 1, время регистрации метки будет обновлено, значения параметров также RSSI, PHASE будут актуализироваться. Если в течение таймаута «Время удержания в таблице» метка прочитана не будет, то она будет удалена из таблицы идентификации.
Обратите внимание. После первого попадания метки в таблицу идентификации и каждый раз при последующем её сканировании, по истечению таймаута «Время сна метки» будут выполняться следующие автоматические сценарии (если они активны, то есть включены в настройках прибора – см. соответствующий раздел):
3 Для системы с одной антенной типа моноблок – номер всегда №1. Для многопортовых систем – от 1 до 4.
- Прибор SAUK начинает процесс непрерывной инвентаризации меток в тот момент, когда устанавливается флаг /rfidconfig?infiniteinventory в состояние true. В графическом пользовательском интерфейсе процесс инвентаризации меток запускается путем включения чекбокса «Непрерывное сканирование» во вкладке меню № 1. Процесс инвентаризации будет продолжаться непрерывно до тех пор, пока его не отключить.
- Инвентаризацию меток можно выполнять кратковременно путем выполнения сервисной команды /inventory_once. Соответствующая кнопка в графическом интерфейсе «Сканировать 1 раз» расположена во вкладке меню № 2. При выполнении команды произойдет кратковременное включение радиотракта. При этом процесс включения может производиться несколько раз подряд, количество включений задается параметром /rfidconfig?repeattime, соответствующий параметр графического интерфейса – Считываний за 1 команду1 во вкладке меню № 1.
- Инвентаризацию меток можно выполнять по внешнему событию – при срабатывании цифрового входа HOLD. При подаче управляющего воздействия на цифровой вход флаг непрерывного сканирования будет взведен автоматически на минимальное время, которое установлено в настройках, вплоть до полного снятия управляющего воздействия с порта Hold.
1 Если вы работаете в режиме непрерывной инвентаризации, то значение параметра «Считываний за 1 команду» следует установить в 1.
В том или ином случае активируется сканирование RFID-меток. При возникновении RFID-метки в зоне действия системы, она идентифицируется мгновенно, после чего попадает в буфер «Таблица идентификации», при этом, запись о каждой метке дополняется системным временем идентификации метки RTC2 , номером антенны ANT3 , силой RSSI сигнала отметка метки, счётчиком успешных сканирований метки CNT (в зависимости от настроек, может считываться дополнительная область памяти метки, например TID или USER). В большинстве случаев этой информации вполне достаточно для последующей постобработки и аналитики данных. После попадания метки в таблицу идентификации, вышеуказанные данные будут обновлены по истечению таймаута «Время сна метки». Ключевым полем для поиска метки в таблице идентификации является EPC-номер метки. 2 Если вы работаете в режиме непрерывной инвентаризации, то значение параметра «Считываний за 1 команду» следует установить в 1. 3 Для системы с одной антенной типа моноблок – номер всегда №1. Для многопортовых систем – от 1 до 4 Пример данных из таблицы идентификации:
{ "RTC":"01:20:59", "CNT":1, "ANT":1,
"PC":"3400", "EPC":
"7716710A1CD1000000000003","EPCLEN":12,
"BANK":2,"DATA":
"E280110C2000710A1CD108F6","DATALEN":12,
"PHASE":176, "RSSI":-42 }
Каждый раз при успешном сканировании RFID-метки счетчик CNT будет инкрементироваться на 1, время регистрации метки будет обновлено, значения параметров также RSSI, PHASE будут актуализироваться. Если в течение таймаута «Время удержания в таблице» метка прочитана не будет, то она будет удалена из таблицы идентификации.
Обратите внимание. После первого попадания метки в таблицу идентификации и каждый раз при последующем её сканировании, по истечению таймаута «Время сна метки» будут выполняться следующие автоматические сценарии (если они активны, то есть включены в настройках прибора – см. соответствующий раздел):
- коммутация реле в соответствии с правилами коммутации реле (см. раздел /peripheryconfig);
- отправка уведомлений на хост по каналам UART (см. раздел /tagidentity);
- отправка уведомлений на хост по каналам Ethernet и Wi-Fi (см. раздел /tagidentity);
- управление интерфейсными линиями Wiegand;
- иллюминация внешней светодиодной RGB индикации (на лицевой панели прибора SAUK).
3 Для системы с одной антенной типа моноблок – номер всегда №1. Для многопортовых систем – от 1 до 4.
1.2. Проверка прав доступа, свой \ чужой
Большая часть автоматических сценариев таких как управления реле, отправка данных по интерфейсам Wiegand, отправка уведомлений на хост, срабатывают после прохождения меткой процедуры проверки идентификационных параметров на соответствие ряду правил. Процесс проверки соответствия этим правилам называется «проверка прав доступа». Права доступа могут проверяться по следующим основным критериям:
- соответствие части EPC-номера фильтру (как правило это значение первых нескольких байт EPC-номера).
- Проверка пароля доступа AccessPassword к памяти EPC-метки.
- Проверка наличия EPC-номера метки в таблице доступа и проверка разрешения доступа для этой метки.
- Если метка соответствует критериям, то производится срабатывание настроенных автоматических сценариев. Также производится подсветка RGB светодиодной индикации на лицевой панели прибора или на специализированной выносной панели индикации (в зависимости от модификации прибора). Светодиодная индикация загорается зеленым цветом. Также метка попадает в таблице идентификации.
- Если метка не соответствует критериям, то выполнение автоматических сценариев блокируется, а метка не попадает в таблицу идентификации. Подсветка RGB загорается голубым цветом (за исключением единственного случая – если проверка пароля AccessPassword не была пройдена).
1.3. Обмен данными между прибором SAUK и хостом по http
Для обмена сообщениями с RFID-системой используется протокол передачи гипертекста HTTP – это протокол разметки, в соответствии с которым, формируется запрос на передачу и получение данных (или передачу команд прибору SAUK). Все функции, доступные в WEB-интерфейсе (при работе с интерфейсом пользователя из браузера) RFID-системы могут быть доступны для работы не только из браузера, но также из любой сторонней информационно-учетной системы, поддерживающий вышеуказанный протокол обмена (например, из 1С или другой WMS, ERP-системы). Данные от RFID-системы могут быть запрошены в любой произвольный момент, также конфигурационные параметры RFID-системы, могут быть изменены любой момент.
Рисунок 1. Диаграмма с потоками данных между RFID-системой и хостом
Пример запроса данных из RFID-системы. Запрос меток, которые обнаружила система (запрос меток из таблицы идентификации).
Запрос: http://192.168.10.1/taglist
Ответ:
Анализируя результат запроса видно, что в буфере прибора хранится две RFID-метки, EPC-номер первой из них 7716710A1CD1000000000003, а второй 77770021D158000000000001. Также видно, что обе метки попали в зону действия антенны №1. При этом, сигнал от метки №2 с уровнем -29 dBm более уверенный, нежели от метки №1 с уровнем -74 dBm. Также видно, что метка №2 была успешно просканирована 248 раз, а метка №1 только 110 раз. По вышеописанным данным уже можно сделать некоторые выводы и предположения о качестве беспроводной связи с метками, то есть, о качестве сканирования метки:
Запрос: http://192.168.10.1/taglist
Ответ:
{"list": [ {"RTC":"01:20:59","CNT":110,
"ANT":1,"PC":"3400",
"EPC":"7716710A1CD1000000000003",
"EPCLEN":12,"RSSI":-74},
{"RTC":"01:20:59","CNT":248,"ANT":1,"PC":
"3400", "EPC":"77770021D158000000000001
","EPCLEN":12,"RSSI":-29} ]}Анализируя результат запроса видно, что в буфере прибора хранится две RFID-метки, EPC-номер первой из них 7716710A1CD1000000000003, а второй 77770021D158000000000001. Также видно, что обе метки попали в зону действия антенны №1. При этом, сигнал от метки №2 с уровнем -29 dBm более уверенный, нежели от метки №1 с уровнем -74 dBm. Также видно, что метка №2 была успешно просканирована 248 раз, а метка №1 только 110 раз. По вышеописанным данным уже можно сделать некоторые выводы и предположения о качестве беспроводной связи с метками, то есть, о качестве сканирования метки:
- Например, зная, что обе метки одинаковые, и сканирование обоих меток начато одновременно, можно предположить, что метка №2 находится ближе к антенне, а метка №1 расположена на удалении.
- Например, если обе метки используются одинаково (допустим, они наклеены на одинаковые коробки с товарами), и метки находятся равноудалены относительно антенны. То метка №2 имеет более выгодное расположение, а метку №1 следует расположить немного иначе – тем самым попытаться улучшить качество её сканирования.
1.4. Уведомления о RFID-метках по Socket TCP\IP
При работе с системой SAUK могут быть настроены уведомления об обнаруженных RFID-метках. Уведомления – это сообщения, об обнаруженных RFID-метках, которые отправляются на хост. Уведомления о RFID-метках отправляются на хост с некоторой задержкой, которая составляет величину от 5 мс до 1000 мс после появления RFID-метки в зоне действия антенны. Уведомление отправляется по технологии сокетов (Socket TCP/IP). При работе с уведомлениями важно, чтобы на стороне хоста было серверное приложение, которое должно слушать все входящие соединения по указанному в настройках номеру порта. Формат уведомления может быть байтовым или текстовым, запакованным в строку JSON. Более подробно об уведомлениях и формате пересылки данных написано в соответствующем разделе настоящей документации.
```
```
2. Формат и структура запроса данных и отправки команды
Запросы, в соответствии протоколом WEB API, возможно отправлять не только из сторонней информационно-учетной системы, а также через адресную строку браузера. Однако целевое назначение API – работа с оборудованием не из браузера, а именно из сторонней информационно-управляющей системы. Для упрощения разъяснений и благодаря возможности быстрой проверки выполнения команд и получения результата, будем рассматривать отправку запросов через браузер.
Пример №1: «Запрос параметров настройки RFID-тракта»
| Заголовок | Регистр |
|---|---|
| http://192.168.10.1 | /rfidconfig |
Выполнение через адресную строку: http://192.168.10.1/rfidconfig Ответ: cтрока в формате JSON, которая содержит значение регистра rfidconfig. Через WEB-интерфейс: пользователь разворачивает вкладку меню №1
Пример №2: «Отключение непрерывного сканирования»
| Заголовок | Регистр | ? | Параметр |
|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | infiniteinventory=false |
Выполнение через адресную строку: http://192.168.10.1/rfidconfig?infiniteinventory=false Ответ: cтрока в формате JSON, которая содержит значение регистра rfidconfig. Через WEB-интерфейс: отключение чекбокса «Непрерывное сканирование» во вкладке меню №1
Пример №3: «Установка мощности излучения ант. 1 на 23 dBm и включение сканирования»
| Заголовок | Регистр | ? | Параметр 1 | & | Параметр 2 |
|---|---|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | pwrant1=23 | & | infiniteinventory=true |
Выполнение через адресную строку: http://192.168.10.1/rfidconfig?pwrant1=23&infiniteinventory=true Ответ: cтрока в формате JSON, которая содержит значение регистра rfidconfig. Через WEB-интерфейс: во вкладке меню №1 – пользователь настраивает мощность путем перемещения ползунка регулировки мощности для антенны №1, затем производит включение «Непрерывное сканирование».
Обратите внимание. Изменения того или иного параметра в регистре приводит к возврату JSON-строки, которая содержит все параметры регистра (в данном примере – регистра rfidconfig), но уже с обновленными значениями параметра или нескольких параметров (если они менялись при выполнении запроса). ```
Обратите внимание. Изменения того или иного параметра в регистре приводит к возврату JSON-строки, которая содержит все параметры регистра (в данном примере – регистра rfidconfig), но уже с обновленными значениями параметра или нескольких параметров (если они менялись при выполнении запроса). ```
3. Конфигурационные регистры и команды общего назначения
Параметры, которые доступны для чтения или для настройки сгруппированы по ряду критериев. Группа параметров получила название Регистр, который по сути выполняет функцию контроллера, выполнение которого происходит при получении http запроса со стороны клиента – с хоста. Относительно графического WEB-интерфейса, эти регистры также сгруппированы «по интересам» и сформированы в виде так называемых, вкладок меню. В таблице 3.1 представлено краткое описание функциональности регистров, а также представлено их сопоставление с элементами графического пользовательского интерфейса.
Таблица 3.1. Конфигурационные регистры, запрашиваемые или изменяемые посредством запроса http
| № | Название регистра | Комментарий | Соответствующая вкладка меню в графическом WEB-интерфейсе прибора SAUK |
|---|---|---|---|
| 1 | /rfidconfig | Параметры настройки RFID-тракта: включение и отключение антенн, настройка излучаемых частот, параметров антиколлизии и пр. | Вкладка меню №1 |
| 2 | /tagidentity | Параметры идентификации меток: время сна метки, время удержания в таблице идентификации, настройка фильтрации по маске EPC или по силе сигнала RSSI | Вкладка меню №2 |
| 3 | /peripheryconfig | Параметры работы с периферийными портами: правила коммутации реле, управления цифровыми выходами интерфейса Wiegand и пр. | Вкладка меню №3 |
| 4 | /datetime | Дата и время: синхронизация часов RTC или системного времени с момента запуска операционной системы прибора SAUK | Вкладка меню №4 |
| 5 | /netinfo | Параметры соединения с сетью Ethernet, Wi-Fi и аутентификации пользователя | Вкладка меню №5 |
| 6 | - | Дополнительные сервисные команды. Перезагрузка прибора, настройка Watchdog таймера и прочее | Вкладка меню №6 |
| 7 | /messagelog | Просмотр системного журнала событий | Вкладка меню №7 |
Команды, выполняемые прибором, сгруппированы аналогичным образом. В большинстве случаев в графическом пользовательском интерфейсе представлены кнопки, располагаемые во вкладках меню аналогичным образом – в той группе, к которой она наиболее близка по смыслу. Также в приборе реализован ряд команд, которые не имеют специального графического отображения в пользовательском интерфейсе.
Таблица 3.2. Команды общего назначения, выполняемые посредством http-запроса
| № | Название команды | Комментарий | Соответствующая вкладка меню в графическом WEB-интерфейсе прибора SAUK |
|---|---|---|---|
| 1 | /inventory_once | Выполнить команду инвентаризации RFID-меток один раз, без включения непрерывного процесса сканирования. После выполнения команды возвращается перечень RFID-меток, обнаруженных системой. | Вкладка меню №2 Кнопка «Сканировать 1 раз» |
| 2 | /taglist | Возвращаем только таблицу идентификации, после выполнения команды метки, которые были прочитаны из прибора будут удалены из таблицы идентификации. Метки читаются группами по 50 меток; если в буфере более 50 меток, то требуется повторное выполнение запроса | Часть буфера, ограниченная количеством меток 40 шт. отображается в таблице идентификации во вкладке меню №2. Программное ограничение 40 шт введено для ограничения обмена рутинного трафика между хостом и системой. |
| 3 | /taglist_clear | Очистка содержимого таблицы идентификации | Вкладка меню №2 Кнопка «Очистить буфер» |
| 4 | /logout | Завершить сеанс пользователя | Кнопка «Выход» в правом верхнем углу главной информационной панели |
| 5 | /messagelog | Запросить содержимое системного лога | Разворачивание вкладки меню №7 |
| 6 | /version | Запрашиваем идентификаторы устройства: серийный номер, версию оборудования, версию программного обеспечения | Вкладка меню №1 Текстовое поле «Версия RFID-чипа» |
| 7 | /reboot | Перезагрузка прибора SAUK | Вкладка меню №6 Кнопка «Перезагрузка прибора» |
| 8 | /beepdevice | Померцать светодиодами и пропищать (идентификация и поиск устройства, если на объекте используется несколько одинаковых устройств) | Вкладка меню №6 Кнопка «Подать сигнал» |
| 9 | /scan | Сканировать доступные сети Wi-Fi и вернуть перечень. Команду не следует выполнять чаще чем 1 раз в 10 секунд. | Вкладка меню №5 Кнопка «Обновить сети» |
| 10 | /relay1, /relay2 | Замкнуть реле на время, указанное в настройках коммутации реле | Не имеет графического представления в GUI |
| 11 | /rfidconfig?diagnostics | Выполнить диагностику антенно-фидерного тракта | Вкладка меню №1 Кнопка «Диагностика антенн» |
В RFID-системе SAUK предусмотрена проверка прав доступа метки по таблице доступа. Проверка прав доступа проверяется различными методами
Таблица 3.3. Сервисные команды для работы с таблицей доступа
| № | Название команды | Комментарий |
|---|---|---|
| 1 | /accessfile | Запрос таблицы доступа. Результат запроса возвращается в виде текстового файла accessfile.txt. Эта функция может быть применена для сохранения резервной копии таблицы доступа. При загрузке файла обратно – в систему, требуется переименовать файл и table.txt |
| 2 | /accesstable | Запрос на добавление новой записи в таблицу доступа, на изменение значений уже существующей записи или её удаление. Ключевое поле, используемое для поиска конкретной записи – EPC номер метки. |
| 3 | /accesstable_part | Запрос части таблицы доступа с указанием порядкового номера первой и последней запрашиваемых записей. Если запрос выполняется без параметров, то ответ будет содержать количество записей в таблице доступа. Результат возвращается в текстовом виде |
```
4. Описание конфигурационных регистров
Конфигурационные регистры могут быть просто прочитаны из внутренней памяти прибора либо значения параметров регистров могут быть изменены.
- Http-запрос без параметров. Прибор вернет значение регистра в виде строки, запакованной в формат JSON. Эта строка будет содержать все параметры регистра (в том числе, доступные для последующего изменения).
- Http-запрос с параметрами будет интерпретирован прибором SAUK как попытка внести изменения в значение того или иного параметра регистра.
4.1. Регистр rfidconfig
4.1.1. Чтение регистра целиком
| Заголовок | Регистр |
|---|---|
| http://192.168.10.1 | /rfidconfig |
Пример ответа:
{
"firmware":"1.9",
"infiniteinventory":false,
"rf":
{
"rf_session":4,
"freq_start":866300,
"freq_space":60,
"freq_quan":3,
"repeattime":1
},
"trigger":
{
"support":true,
"enable":[false,false],
"min_hold_ms":5000
},
"antennas":
{
"min_power":18,
"max_power":30,
"quantity":4,
"enable":[true,false,false,false],
"power":[22,19,19,19],
"s11":[255,255,255,255],
"triggered":[1,1,0,0]
}
} Таблица 4.1. Значение параметров в ответе
| № пп | Название параметра | Тип | R/W | Комментарий |
|---|---|---|---|---|
| 1 | firmware | str | R | Версия программного обеспечения сопроцессора, отвечающего за работу RFID-чипа. При необходимости эти данные нужно сообщить в службу техподдержки SAUK если эта информация будет запрошена специалистом. |
| 2 | infiniteinventory | bool | R/W | Флаг работы прибора в режиме непрерывного сканирования меток (инвентаризация меток). |
| 4 | rf:rf_session | byte | R/W | Параметр антиколлизии. Номер сессии 0 – 4 (где 4 означает использование автоматической сессии), 0 – S0, 1 – S1, 2 – S2, 3 – S3. |
| 5 | rf:freq_start | uint | R/W | Первая рабочая частота. Единица измерения – кГц. По умолчанию 866300. Минимальное значение параметра 866300. Максимальное значение параметра 867500. |
| 6 | rf:freq_space | byte | R/W | Смещение между излучаемыми частотами. По умолчанию 60 (означает 60 * 10 = 600 кГц) |
| 7 | rf:freq_quan | byte | R/W | Количество частот, излучаемых прибором. По умолчанию 3. |
| 8 | rf:repeattime | byte | R/W | Количество циклов кратковременного чтения меток при вызове команды /inventory_once или при нажатии на кнопку «Сканировать 1 раз» во вкладке меню №2. Если вы работаете в режиме непрерывного чтения меток (включено непрерывное сканирование), то следует установить этот параметр в 1. |
| 9 | trigger:support | bool | R | Осуществлена ли в приборе (или в прошивке прибора) поддержки цифрового входа hold. |
| 10 | trigger:enable | [bool] | R/W | Включена ли реакция прибора на изменение состояния цифрового входа hold №1 и hold №2. Размерность массива 2 |
| 11 | trigger:min_hold_ms | uint | R/W | Минимальное время включения сканирования при срабатывании цифрового входа hold. Измеряется в мс. |
| 12 | antennas:min_power | byte | R | Минимальная мощность излучения, которую поддерживает прибор. |
| 13 | antennas:max_power | byte | R | Максимальная мощность излечения, которую поддерживает прибор. |
| 14 | antennas:quantity | byte | R | Количество портов для RFID-антенн, которое поддерживает прибор 1 или 4. |
| 15 | antennas:enable | [bool] | R/W | Флаг состояния антенны: включена или отключена. Размерность массива 1 или 4. |
| 16 | antennas:power | [byte] | R/W | Мощность излучения, подаваемая на СВЧ-порт прибора, варьируется от минимального значения (min_power) до максимального значения (max_power). Единицы измерения – dBm. Размерность массива 1 или 4. |
| 17 | antennas:s11 | [byte] | R | Результат измерения параметров антенны – коэффициент отражения S11. Элементы массива – взятое по модулю значение S11 порта (например, величина 28 означает -28 dB). Размерность массива 1 или 4. Для большинства антенн SAUK величина S11 должна быть ниже -16, как правило величина составляет от -24 до -44 dB. |
| 18 | antennas:triggered | [byte] | R/W | Возможность антенны сканировать метки при срабатывании цифрового входа hold. Значения 1, 2 или 3:
|
4.1.2. Включение и отключение непрерывного сканирования (инвентаризации)
Обратите внимание! Если запущено непрерывное сканирование, то прежде чем поменять:
Обратите внимание! Если запущено непрерывное сканирование, то прежде чем поменять:
- частоты излучения, количество работающих частотных каналов, смещение частоты между каналами,
- мощность сигнала,
- конфигурацию работающих антенн,
| Заголовок | Регистр | ? | Параметр |
|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | false |
Ответ: cтрока в формате JSON, которая содержит значение регистра rfidconfig.
4.1.3. Изменение излучаемых частот RFID-системы
Настройка излучаемых частот производится в соответствии с таблицей «Типовые значения частотных настроек радиоизлучения».
4.1.3. Изменение излучаемых частот RFID-системы
Настройка излучаемых частот производится в соответствии с таблицей «Типовые значения частотных настроек радиоизлучения».
Таблица 4.2. Типовые значения частотных настроек радиоизлучения
| № пп | freq_start | freq_space | freq_quan | 866,3 МГц | 866,9 МГц | 867,5 МГц |
|---|---|---|---|---|---|---|
| 1 | 866300 | 60 | 3 | + | + | + |
| 2 | 866300 | 60 | 2 | + | + | - |
| 1 | 866300 | 60 | 1 | + | - | - |
| 1 | 866300 | 120 | 2 | + | - | + |
| 1 | 866900 | 60 | 1 | - | + | - |
| 1 | 866900 | 60 | 2 | - | + | + |
| 1 | 867500 | 60 | 1 | - | - | + |
Запрос на изменение первой частоты излучения:
| Заголовок | Регистр | ? | Параметр |
|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | freq_start=uint |
Минимальное значение параметра 866300. Максимальное значение параметра 867500. Ответ: cтрока в формате JSON, которая содержит значение регистра rfidconfig.
Запрос на изменение количества излучаемых частот:
Запрос на изменение количества излучаемых частот:
| Заголовок | Регистр | ? | Параметр |
|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | freq_quan=byte |
Минимальное значение параметра 1. Максимальное значение параметра 3. Ответ: cтрока в формате JSON, которая содержит значение регистра rfidconfig.
Запрос на изменение количества излучаемых частот:
Запрос на изменение количества излучаемых частот:
| Заголовок | Регистр | ? | Параметр |
|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | freq_space=byte |
Минимальное значение параметра 60. Максимальное значение параметра 120. Данная величина, умноженная на 10 будет являться шагом между излучаемыми частотами, в кГц. Ответ: cтрока в формате JSON, которая содержит значение регистра rfidconfig.
Изменение начальной частоты, шага частоты и количества рабочих частот могут быть выполнены в рамках одного запроса. Пример выполнения запроса: http://192.168.10.1/rfidconfig?freq_start=867500&freq_space=60&freq_quan=1 Ответ: cтрока в формате JSON, которая содержит значение регистра rfidconfig.
Изменение начальной частоты, шага частоты и количества рабочих частот могут быть выполнены в рамках одного запроса. Пример выполнения запроса: http://192.168.10.1/rfidconfig?freq_start=867500&freq_space=60&freq_quan=1 Ответ: cтрока в формате JSON, которая содержит значение регистра rfidconfig.
4.1.4. Изменение мощности, подаваемой на порт RF-антенны
| Заголовок | Регистр | ? | Параметр |
|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | pwrant1=byte |
| http://192.168.10.1 | /rfidconfig | ? | pwrant2=byte |
| http://192.168.10.1 | /rfidconfig | ? | pwrant3=byte |
| http://192.168.10.1 | /rfidconfig | ? | pwrant4=byte |
Мощность излучения, подаваемая на СВЧ-порт прибора, варьируется от минимального значения (min_power) до максимального значения (max_power). Значение мощности задается на каждый порт индивидуально.
Ответ: строка в формате JSON, которая содержит значение регистра rfidconfig.
Ответ: строка в формате JSON, которая содержит значение регистра rfidconfig.
4.1.5. Включение и отключение порта RFID-антенны
| Заголовок | Регистр | ? | Параметр |
|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | false |
| http://192.168.10.1 | /rfidconfig | ? | false |
| http://192.168.10.1 | /rfidconfig | ? | false |
| http://192.168.10.1 | /rfidconfig | ? | false |
Ответ: строка в формате JSON, которая содержит значение регистра rfidconfig.
4.1.6. Включение и отключение реакции RFID-антенны на цифровой порт hold
| Заголовок | Регистр | ? | Параметр |
|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | triggered1=byte |
| http://192.168.10.1 | /rfidconfig | ? | triggered2=byte |
| http://192.168.10.1 | /rfidconfig | ? | triggered3=byte |
| http://192.168.10.1 | /rfidconfig | ? | triggered4=byte |
Где значение byte 1, 2 или 3:
- 1 – зависит от hold №1;
- 2 – зависит от hold №2;
- 3 – зависит от обоих портов hold.
4.1.7. Включение и отключение цифрового входа hold
| Заголовок | Регистр | ? | Параметр |
|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | false |
| http://192.168.10.1 | /rfidconfig | ? | false |
Ответ: строка в формате JSON, которая содержит значение регистра rfidconfig.
4.1.8. Настройка минимального времени включения по событию цифрового порта hold
| Заголовок | Регистр | ? | Параметр |
|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | min_hold_ms=uint |
Минимальное значение параметра 1000 мс, максимальное значение параметра 50000 мс. Соответственно, время активации антенн при срабатывании цифрового входа hold может задаваться от 1 до 50 секунд. Это минимальное время, на которое включается соответствующая антенна. После снятия управляющего воздействия с цифрового входа hold, сканирование будет автоматически отключено, если прошел указанный таймаут. Ответ: строка в формате JSON, которая содержит значение регистра rfidconfig.
4.1.9. Изменение сессии чтения RFID-меток
| Заголовок | Регистр | ? | Параметр |
|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | rf_session=byte |
Значение параметра задается в диапазоне от 0 до 4, где 4 – автоматическая сессия антиколлизии. Величины от 0 до 3 соответствуют следующим значениям:
- 0 – сессия S0;
- 1 – сессия S1;
- 2 – сессия S2;
- 3 – сессия S3.
4.1.10. Изменение количества циклов кратковременного чтения меток
| Заголовок | Регистр | ? | Параметр |
|---|---|---|---|
| http://192.168.10.1 | /rfidconfig | ? | repeattime=byte |
Значение параметра задается в диапазоне от 1 до 30. При работе в режиме непрерывного сканирования данный параметр следует задать равным 1. При установке значения, отличного от 1, при нажатии на кнопку «Сканировать 1 раз» или при выполнении команды /inventory_once прибор просканирует метку заданное количество раз (то есть радиотракт будет кратковременно включаться и отключаться заданное количество раз). Ответ: строка в формате JSON, которая содержит значение регистра rfidconfig. ```
ТАБЛИЦА 7. ОПИСАНИЕ ПРОТОКОЛА WEB-API (ДЛЯ СЕТЕЙ WI-FI И ETHERNET)
ТАБЛИЦА 7.2. Настройка параметров периферийных устройств (peripheryconfig)
| Команда | Описание |
|---|---|
| /peripheryconfig | Запрос всех параметров. |
| /peripheryconfig?relay1_enable=bool | Активировать или деактивировать замыкание реле при обнаружении метки, если метка прошла процесс проверки «Свой-чужой». |
| /peripheryconfig?relay1_timer=value | Время, на которое замыкается реле, в миллисекундах. |
| /peripheryconfig?wiegand1_enable=bool | Активировать или деактивировать передачу номера метки по Wiegand, если метка прошла процесс проверки «Свой-чужой». |
| /peripheryconfig?wiegand1_type=value | Тип протокола Wiegand (26, 34 и т.д.). |
| /peripheryconfig?wiegand1_shift_bytes=value | Смещение, начиная с которого зачитывать код для Wiegand (в байтах). |
| /peripheryconfig?wiegand1_source=value | Источник данных для Wiegand (банк памяти метки EPC или TID). |
| /peripheryconfig?beep_on_start=bool | Активировать или деактивировать подачу звукового сигнала при включении прибора (сигнал подается после загрузки). |
| /peripheryconfig?timeout_logical_0=value | Ширина логического сигнала по интерфейсу Wiegand. |
| /peripheryconfig?timeout_next_bit=2000 | Период следования импульсов по интерфейсу Wiegand. |
| /peripheryconfig?temp_calibr=value | Калибровочная величина для встроенного температурного датчика, измеряется в °С. От -50 до 50. |
ТАБЛИЦА 7.3. Настройка параметров идентификации RFID-меток (tagidentity)
| Команда | Описание |
|---|---|
| /tagidentity | Возвращаем все параметры (без таблицы идентификации). |
| /tagidentity?taglist=true | Возвращаем все параметры + таблицу идентификации. |
| /tagidentity?validtime_ms=value | Новое значение "Время сна RFID-метки", миллисекунды. |
| /tagidentity?hold_time_ms=value | Новое значение "Время удержания метки в таблице инвентаризации", миллисекунды. |
| /tagidentity?rssi_filter_value=-value | Новое значение RSSI фильтра (всегда отрицательная величина), дБ. |
| /tagidentity?rssi_filter_enable=bool | Включаем или выключаем проверку уровня сигнала от метки, RSSI. |
| /tagidentity?epc_access_password=value | Пароль AccessPassord, который проверяется на метках. |
| /tagidentity?epc_filter_value1=* | Фильтр EPC-номера RFID-метки. |
| /tagidentity?epc_filter_enable1=bool | Активируем или деактивируем проверку EPC-фильтра. |
| /tagidentity?beep_on_tag=bool | Активируем или деактивируем подачу звукового сигнала при обнаружении RFID-метки, если метка прошла процесс проверки «Свой-чужой». |
| /tagidentity?extra_mem_read=bool | Чтение дополнительного сектора памяти. |
| /tagidentity?extra_mem_bank=value | Номер банка памяти, из которого будем читать данные. |
| /tagidentity?data_start_words=0 | Первый блок памяти, который будет читаться (в словах, по 2 байта). |
| /tagidentity?data_len_words=0 | Количество данных, которые будут читаться (в словах, по 2 байта). |
| /tagidentity?notify_uart=bool | Включение и отключение уведомлений по UART. |
| /tagidentity?notify_uart_json=value | Изменение протокола уведомлений: 0-байтовый, 1-JSON строки, 2-строки ASCII. |
| /tagidentity?add_ptefix=String | К посылке по UART добавить префикс, строка до 4 байт. |
| /tagidentity?add_ptefix=String | К посылке по UART добавить префикс, строка до 4 байт. |
| /tagidentity?add_epcl=bool | К посылке по UART добавить длину EPC-кода (измеряемую в байтах). |
| /tagidentity?add_epc=bool | К посылке по UART добавить код EPC. |
| /tagidentity?add_tidl=bool | К посылке по UART добавить длину TID-кода (измеряемую в байтах). |
| /tagidentity?add_tid=bool | К посылке по UART добавить код TID. |
| /tagidentity?add_suffix=String | К посылке по UART добавить суффикс, строка до 4 байт. |
| /tagidentity?add_crlf=bool | К посылке по UART добавлять «возврат каретки \r 0x0D CR» и «перевод строки \n 0x0A LF». |
| /tagidentity?add_ant=bool | К посылке по UART добавить номер антенны, которая обнаружила метку. |
| /tagidentity?add_rssi=bool | К посылке по UART добавить силу сигнала от метки RSSI. |
| /tagidentity?notify_uart_alive=true | Разрешить/Запретить отправку сообщений KeepAlive по UART. |
| /tagidentity?notify_uart_speed=115200 | Изменение скорости работы UART (RS232, RS485). |
ТАБЛИЦА 7.4. Настройка параметров уведомления хоста (tagidentity/notify)
| Команда | Описание |
|---|---|
| /tagidentity?notify_ip=value | Задаем IP адрес хоста, куда будут отправляться сообщения об обнаруженной метке RFID, если метка прошла процесс проверки «Свой-чужой». |
| /tagidentity?notify_port=value | Задаем номер порта на стороне хоста. |
| /tagidentity?notify_time_lim_ms=value | Таймаут на установление соединения от 0 до 3000 мс. |
| /tagidentity?notify_enable=bool | Активируем или деактивируем канал уведомлений. |
Если параметр
notify_enable имеет значение true, то при возникновении события (чтение RFID-метки, которая удовлетворяет критериям Свой-Чужой) на хост будет отправлено уведомление – текстовая строка в формате JSON:{
"READER": "Серийный номер считывателя",
"EPC": "Уникальный номер метки,
закодированный в память EPC",
"DATA": "Дополнительные данные из памяти
RFID-метки, например, TID-номер",
"DB": "Номер банка памяти из которого
прочитаны дополнительные данные",
"RSSI": "Сила сигнала -90 самый слабый,
30 самый сильный",
"ANT": "Номер RFID-антенны, которая
обнаружила метку"
} SAUK© 2020 – 2025. Все тексты и изображения, представленные на сайте, являются интеллектуальной собственностью SAUK. Могут быть использованы только по письменному согласию SAUK. SAUK® является зарегистрированным торговым знаком.