Пример: логи и отчёты с ODNFC | UnitX - электронные устройства

Способ зависит от задачи: rsyslog подходит для централизованного сбора, локальный файл — для автономной диагностики, а Telegram и электронная почта — для уведомлений и отчётов.

Способы отправки

Ниже — четыре независимых варианта. Не записывайте секреты, пароли и полные идентификаторы пропусков в журналы.

rsyslog — служба централизованного сбора журналов для UNIX-систем. Устройство может отправлять сообщения на сервер rsyslog. Ниже показана только настройка клиента; сервер настройте по документации своего дистрибутива.

-- устанавливаем сервер
os.rsyslog("192.168.0.160")

-- устанавливаем уровень
os.loglevel(os.LOG_ALL)

-- отправляем сообщение
os.syslog("hi", os.LOG_INFO)

Библиотека logger.lua в прошивку ODNFC не входит. Для небольшого диагностического журнала достаточно стандартного io.open.

Чтобы временные метки были верными, настройте синхронизацию времени и часовой пояс. Ограничивайте размер файла или удаляйте старые записи: бесконечный журнал со временем заполнит файловую систему.

local function log(message)
    local file, err = io.open("/public/events.log", "a")
    if not file then
        return nil, err
    end

    file:write(
        string.format("[%s] %s\n", os.date("%Y-%m-%d %H:%M:%S"), message)
    )
    file:close()
    return true
end

local ok, err = log("test")
if not ok then
    print("Не удалось записать журнал:", err)
end

В каталоге /public появится файл events.log:

[2024-02-09 13:19:38] test

Каталог /public доступен из браузера по адресу http://<ip>/public/. Учитывайте это при выборе содержимого журнала и ограничьте доступ к устройству в сети. Для долгой автономной работы добавьте ротацию: переименовывайте заполненный файл и храните ограниченное число архивов.

Список файлов журнала ODNFC — Файл журнала в списке файлов устройства.

Содержимое файла журнала ODNFC — Просмотр содержимого журнала.

telegram.lua позволяет устройству обращаться к Telegram Bot API напрямую. Эта библиотека в прошивку ODNFC не входит: загрузите проверенный файл telegram.lua вместе с проектом. Для примера нужны версия PRO, доступ в интернет и токен бота. Не записывайте настоящий токен в публикуемый исходный код или журнал.

-- загружаем библиотеку
telegram = require("telegram")
-- инициализация
local token = "ваш_токен_от_бота"
local bot = telegram(token,
    function(chat_id, text, sendMessage, sendDocument)
        -- обрабатываем входящие команды, например отвечаем
        sendMessage(chat_id, "Вы сказали: " .. text)
    end,
    function(chat_id, document, sendMessage, saveDocument)
        -- обрабатываем полученные файлы, например сохраняем
        local res, msg = saveDocument(document.file_id, "/downloads/"..document.file_name)
        sendMessage(chat_id, "Загрузка документа: " .. (res and "успешно" or msg))
    end
)
-- цикл
while true do
    bot.getUpdates()
    thread.sleepms(200)
end

Журнал или отчёт можно отправлять по электронной почте. Пример рассчитан на версию PRO: TLS-соединение и вложения требуют дополнительной памяти.

-- имя и порт почтового сервера
net.curl.mailserver("smtp.адрес.сервера", 465)

options = {
    user = "логин",
    pass = "пароль",
    to = {"получатель1", "получатель2"},
    subj = "Тема",
    msg = "Тестовая посылка",
    secure = true,
    attach = {"picture.jpg"}
}

ret, msg = net.curl.sendmail(options)

Дополнительные материалы

История обновлений ODNFC на Lua

Если установлена версия ниже 1.7.0, сначала обновите её до 1.7.0, а затем до более новой версии. Перед обновлением отключите сторожевой таймер и сотрите пользовательскую программу.

1.8.2

Улучшена работа устройства и исправлены ошибки.
Для устройств, работающих с метками 125 кГц, добавлено обнаружение типовых клонов EM-Marine.

1.8.1

Улучшения:

Новый веб-интерфейс.
Улучшена работа RFID-модулей MFRC и EM-Marine.
Улучшена работа Modbus.
Оптимизирована работа устройства.

1.7.0

Улучшения:

улучшена работа MFRC и EM-Marine;
в раздел «Редактор» добавлен простой файловый менеджер;
улучшена работа сетевых модулей;
оптимизирована работа устройства.

Исправлена ошибка в HTTP-заголовке Content-Length, из-за которой интерфейс не работал в некоторых операционных системах.

1.6.2

Улучшена работа MFRC и EM-Marine.
Улучшена библиотека Modbus.
Оптимизирована работа устройства.
В ODNFC-LAN-LUA добавлена регистрация обработчика успешного чтения.

1.6.1

Добавлена запись в зашифрованные карты MIFARE Classic.
Упрощена инициализация RFID: используются значения по умолчанию для каждой платы, поэтому изменён вызов основного класса и больше не требуются многие Lua-обёртки из rfid.lua.
Добавлена функция mfrc522.scan() — упрощённая версия базового класса для типовых операций.
Исправлены библиотеки EM-Marine и HID.
Оптимизирована библиотека Modbus.
Исправлена работа TCP-сервера.

1.6.0

Улучшения:

обновлён редактор кода: устранена проблема с переводами строк в новых версиях Firefox;
в веб-сервер добавлена поддержка HTTPS и WebSocket;
добавлены новые классы для работы с RFID-метками;
добавлена работа с NDEF и счётчиками Ultralight;
добавлены встроенные библиотеки cbor, cobs, mlib, Heatshrink и microtar;
расширены библиотеки osc, net, cutils, utils, cpu и emmarine;
LuaSocket больше не входит в прошивку;
добавлена загрузка сжатых Heatshrink-библиотек Lua;
добавлен WebSocket REPL для отладки через веб-IDE или расширение VS Code;
улучшена консоль: Unicode, автодополнение и история;
расширена поддержка Modbus;
Paho MQTT заменён собственной реализацией uMqtt;
ускорена работа устройства и веб-интерфейса;
выполнены другие небольшие исправления и оптимизации.

Исправлены ошибки, из-за которых после мягкой перезагрузки Wi-Fi запускался через раз, а RFID-модуль мог не инициализироваться.

1.5.0

Улучшения:

новый интерфейс и редактор кода;
добавлена библиотека tinycobs;
добавлены функции net.tcp.*;
добавлены функции eprint, hprint и wprint для вывода в окно «Инфо»;
трассировка ошибки загрузки теперь показывается в окне «Инфо»;
расширены возможности Telnet, SSH отключён;
в режиме восстановления Wi-Fi работает без пароля;
добавлена поддержка BLE-маяков на устройствах с BLE;
NTP запускается с задержкой 15 секунд, чтобы сеть успела установиться.

Исправлены режим статического Ethernet-адреса и установка яркости NeoPixel.

1.4.0

Улучшен встроенный веб-сервер.
Выполнены небольшие изменения для повышения стабильности.
Исправлена утечка памяти при HTTP-запросах из Windows.

Известная проблема этой версии: режим статического Ethernet-адреса в настройках не работает. Для обхода проблемы в начало пользовательской программы добавляли:

net.en.setup(
  net.packip(Settings.get("net_ip")),
  net.packip(Settings.get("net_mask")),
  net.packip(Settings.get("net_gw")),
  net.packip(Settings.get("net_dns"))
)
net.en.start()

1.3.2

В os.df() добавлен дополнительный параметр.
Выполнены небольшие изменения для повышения стабильности.
Исправлена утечка памяти при запросе метрики в интерфейсе.

Известная проблема этой версии: HTTP-запросы из Windows приводят к утечке памяти. После изменения настроек рекомендовалось закрыть браузер, перезагрузить устройство и не выполнять периодические HTTP-запросы.

1.3.1

Серийный номер синхронизирован с DataMatrix на корпусе модуля, если он есть.

1.3

Библиотека Telegram.lua добавлена в прошивку.
Библиотека LuaSocket теперь распространяется отдельно.