odrfid: опрос считывателей ODRFID-RS485
Lua-библиотека odrfid для контроллера С3: опрос считывателей ODRFID-RS485 по Modbus RTU, события метки, несколько считывателей на линии, AT-команды.
Библиотека odrfid подключает к С3 RFID-считыватели
ODRFID-RS485 по линии RS485. Она работает поверх
модуля modbus: опрашивает считыватель,
сообщает о поднесённой и снятой метке и передаёт AT-команды для настройки.
Контроллер обычно обслуживает несколько считывателей на одной линии: у каждого свой адрес Modbus, а опрос идёт через общий master.
local modbus = require("modbus")
local odrfid = require("odrfid")
local bus = assert(modbus.rtu_master{baudrate = 115200, timeout = 100})
for _, unit in ipairs({1, 2, 3}) do
local rfid = assert(odrfid.open{master = bus, unit = unit})
rfid:watch{
on_tag = function(uid) print("считыватель", unit, "метка", uid) end,
on_remove = function(uid) print("считыватель", unit, "метка убрана", uid) end,
}
end
Установка
Библиотека состоит из двух файлов. Загрузите их в разделе «Файлы» веб-интерфейса:
| Файл | Куда загрузить | Назначение |
|---|---|---|
odrfid.lua | /lfs/lua/odrfid.lua | опрос: метка в поле, последняя метка, время работы, watch |
at.lua | /lfs/lua/odrfid/at.lua | AT-команды через регистры; нужен только для настройки |
Каталоги lua и lua/odrfid создайте кнопкой «Новая папка». Пример
программы с этой библиотекой — контроллер доступа на несколько
считывателей.
Считыватель должен работать в автоматическом режиме сканирования (AT+SCAN1):
в ручном режиме регистры присутствия и последней метки не обновляются.
Открытие считывателя
odrfid.open{...} возвращает объект считывателя или nil, errno, сообщение.
| Опция | По умолчанию | Значение |
|---|---|---|
unit | 0x5F (odrfid.UNIT) | адрес считывателя, 1–247 |
master | — | уже открытый modbus.rtu_master; остальные опции линии тогда не нужны |
baudrate, parity, stop_bits | 115200 (odrfid.BAUDRATE), без чётности, 1 стоп-бит | параметры линии |
timeout | 300 мс | тайм-аут ответа |
retries | 1 | число повторов чтения после ошибки связи |
Несколько считывателей на одной линии используют общий master:
local modbus = require("modbus")
local odrfid = require("odrfid")
local bus = assert(modbus.rtu_master{baudrate = 115200, timeout = 300})
local door = assert(odrfid.open{master = bus, unit = 1})
local gate = assert(odrfid.open{master = bus, unit = 2})
Перед этим задайте считывателям разные адреса.
Методы
| Метод | Результат |
|---|---|
status() | {present, minutes, odometer_fault, rfid_fault} за один запрос; нужна прошивка считывателя 3.4 или новее |
last_tag() | uid, type последней метки: UID — строка в шестнадцатеричном виде ("04A1B2C3"), type — код типа; false, если регистры пусты |
clear_last_tag() | true; очищает регистры последней метки |
read(kind, address, count) | регистры "input" или "holding" с повтором при ошибке связи |
watch{...} | номер задачи опроса |
close() | true; останавливает watch и закрывает master, если его создал open |
minutes — полные минуты работы считывателя. Ошибки возвращаются как у
modbus: nil, errno, сообщение, а при исключении Modbus четвёртым значением
идёт его код. Чтение повторяется до retries раз после любой ошибки, кроме
исключения Modbus; запись не повторяется.
Последняя метка сохраняется в регистрах, пока не будет поднесена следующая или
не вызван clear_last_tag().
watch: события метки
local id = rfid:watch{
interval = 100, -- мс между опросами
on_tag = function(uid, type) end, -- метка поднесена или сменилась
on_remove = function(uid) end, -- метка убрана
on_error = function(errno, message, exception) end,
}
watch запускает задачу, которая раз в interval мс проверяет, есть ли метка
в поле, и при её наличии читает UID.
on_tagприходит черезinterval…2 × intervalпосле того, как считыватель увидел метку: новое присутствие подтверждается следующим опросом.- Смена метки без паузы даёт
on_removeдля старой иon_tagдля новой. - Повторно поднесённая метка снова вызывает
on_tag, потому что между поднесениями былоon_remove. - Ошибка связи вызывает
on_errorи не меняет состояние:on_removeпридёт только после того, как считыватель ответит, что метки в поле нет. - Обработчики выполняются в задаче опроса и могут вызывать методы считывателя
и
task.sleep(). Необработанная ошибка в них перезапускает программу.
Опрос останавливают rfid:close() или task.cancel(id).
Запрос Modbus ждёт ответа, не отдавая управление другим задачам. Если
считыватель не отвечает, каждый опрос занимает до (retries + 1) × timeout мс,
поэтому для отключённого считывателя уменьшайте timeout и retries.
AT-команды
local at = require("odrfid.at")
local lines, errno, message, exception = at(rfid, "ATI")
local tags = at(rfid, "AT+I", 3000) -- {"+UID=...", ...}
at(reader, command [, wait_ms]) возвращает таблицу строк ответа без \r\n.
- Команда начинается с
AT, без завершающего\r, длиной до 246 байт. Несколько команд после одногоATразделяются;. - Ответ на синхронные команды —
ATI,AT+SCAN?,AT+T?— читается сразу. - Асинхронные команды —
AT+I,AT+i,AT+S,AT+SELECT,AT+R,AT+W— отвечают позже:wait_msзадаёт, сколько ждать ответа. Их ошибка приходит строкой+CME ERROR: <код>. Команда без ответа ждёт весьwait_msи возвращает пустую таблицу. - Исключение Modbus означает
ERROR: обычно код 4, код 3 — строка не является AT-командой. - Пока выполняется
AT+I, считыватель занят, иatбезwait_msвернётEPROTO. Сwait_msбиблиотека подождёт освобождения в пределах этого времени. - Саму команду
atне повторяет: при потерянном ответе она могла выполниться.
Одновременно выполняйте только одну AT-команду на считыватель. watch с
AT-командами не конфликтует.
Список команд — в руководстве ODRFID-RS485.
Память
odrfid занимает около 5 КБ памяти программы, odrfid.at — около 3,5 КБ, а
при загрузке временно нужно до 9 КБ. Загружайте odrfid.at только для
настройки и затем освобождайте:
do
local at = require("odrfid.at")
print(at(rfid, "ATI")[1])
assert(at(rfid, "AT+SCAN1")) -- автоматический режим до перезагрузки
end
package.loaded["odrfid.at"] = nil -- модуль будет удалён сборщиком мусора
Текущий расход памяти показывает require("zephyr.sys").memory().
Регистры считывателя
| Регистр | Назначение |
|---|---|
| input 0 | число байтов в буфере ответа AT; 0, пока выполняется AT+I |
| input 1 | метка в поле |
| input 2, 3 | время работы в полных минутах, старшее слово первым |
| input 4 | ошибка сохранения времени работы |
| input 5 | ошибка RFID-модуля |
| holding 0–125 | AT-команда (запись) и ответ (чтение) |
| holding 126 | запись: сбросить буфер ответа |
| holding 127 | запись: перезагрузка |
| holding 130, 131 | длина UID последней метки и её тип |
| holding 132–141 | байты UID, по одному в младшем байте регистра |
| holding 143 | запись 0x4242: заводские настройки линии, адреса и RFID, затем перезагрузка |