Wb-mqtt-serial driver: различия между версиями
(Убрал старый текст, и поменял ссылку на ssh) |
|||
(не показаны 32 промежуточные версии 5 участников) | |||
Строка 1: | Строка 1: | ||
{{DISPLAYTITLE: Драйвер wb-mqtt-serial}} | {{DISPLAYTITLE: Драйвер wb-mqtt-serial}} | ||
[[Image: wb-mqtt-serial a few protocols.png |500px|thumb|right| Драйвер wb-mqtt-serial может одновременно опрашивать устройства, работающие по разным протоколам: <br> 1 — виртуальный порт для устройств с протоколом Modbus TCP,<br> 2 — устройство работает по протоколу Modbus RTU,<br> 3 — устройство работает по протоколу DLMS]] | |||
== Описание == | == Описание == | ||
<code>wb-mqtt-serial</code> — драйвер master-slave протоколов для устройств, работающих через последовательный порт. Драйвер работает через систему [[MQTT|MQTT]]-сообщений и [[RS-485:Configuration via Web Interface | настраивается через веб-интерфейс]]. | |||
Драйвер | |||
Драйвер использует систему JSON-шаблонов, которые описывают подключаемые устройства: тип протокола, номера регистров, название параметров и контролов в веб-интерфейсе контроллера. В стандартной поставке есть шаблоны для всех устройств Wiren Board, а также некоторых сторонних устройств: счётчики электроэнергии, частотные преобразователи, холодильные контроллеры и другие. | |||
Если ваше устройство работает по | Если ваше устройство работает по одному из поддерживаемых драйвером протоколу, но в стандартной поставке под него нет шаблона — вы можете написать шаблон сами. | ||
Файлы и папки: | Файлы и папки: | ||
* <code>/etc/wb-mqtt-serial.conf</code> — файл настроек драйвера, | * <code>/etc/wb-mqtt-serial.conf</code> — файл настроек драйвера, | ||
* <code>/usr/share/wb-mqtt-serial/templates</code> — папка с предустановленными шаблонами | * <code>/usr/share/wb-mqtt-serial/templates</code> — папка с предустановленными шаблонами, | ||
* <code>/etc/wb-mqtt-serial.conf.d/templates</code> — папка для пользовательских шаблонов, которые имеют приоритет | * <code>/etc/wb-mqtt-serial.conf.d/templates</code> — папка для пользовательских шаблонов, которые имеют приоритет на предустановленными. | ||
О том, как получить доступ к файлам и папкам, читайте в статье [[View controller files from your computer|Просмотр файлов контроллера с компьютера]]. | О том, как получить доступ к файлам и папкам, читайте в статье [[View controller files from your computer|Просмотр файлов контроллера с компьютера]]. | ||
Полное описание драйвера, список поддерживаемых протоколов и примеры шаблонов, смотрите '''[https://github.com/contactless/wb-mqtt-serial в репозитории на Github]'''. | Полное описание драйвера, список поддерживаемых протоколов и примеры шаблонов, смотрите '''[https://github.com/contactless/wb-mqtt-serial в репозитории на Github]'''. | ||
== Управление драйвером == | == Управление драйвером == | ||
Строка 50: | Строка 29: | ||
systemctl restart wb-mqtt-serial # перезапустить | systemctl restart wb-mqtt-serial # перезапустить | ||
wb-mqtt-serial -c /etc/wb-mqtt-serial.conf -d # запустить в отладочном режиме с указанием пути к конфигурационному файлу | wb-mqtt-serial -c /etc/wb-mqtt-serial.conf -d # запустить в отладочном режиме с указанием пути к конфигурационному файлу | ||
wb-mqtt-serial -j # посмотреть ошибки в конфигурационном файле | |||
</syntaxhighlight> | </syntaxhighlight> | ||
== Диагностика неполадок == | == Диагностика неполадок == | ||
Если возникли проблемы с запуском драйвера, например, новое устройство не появилось, то можно узнать причину: выполните команду <code>systemctl status wb-mqtt-serial</code> и в последних двух строчках ответа будет подсказка. | |||
В примере файл конфигурации содержит синтаксическую ошибку во второй строке на 14 позиции: | |||
Если возникли проблемы с запуском драйвера, например, новое устройство не появилось, то можно узнать причину | |||
<syntaxhighlight lang="console"> | <syntaxhighlight lang="console"> | ||
# systemctl status wb-mqtt-serial | # systemctl status wb-mqtt-serial | ||
Строка 70: | Строка 48: | ||
Jan 28 15:10:51 wirenboard-A6XXXT2R wb-mqtt-serial[23682]: Syntax error: value, object or array expected. | Jan 28 15:10:51 wirenboard-A6XXXT2R wb-mqtt-serial[23682]: Syntax error: value, object or array expected. | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== Включение отладки== | == Включение отладки== | ||
Строка 83: | Строка 56: | ||
Включение отладки через [[Wiren Board Web Interface|веб-интерфейс]]: | Включение отладки через [[Wiren Board Web Interface|веб-интерфейс]]: | ||
# Зайдите в веб-интерфейс контроллера | # Зайдите в веб-интерфейс контроллера. | ||
# Если вы работаете под обычным пользователем, то смените [[RS-485:Configuration via Web Interface#Смена уровня доступа к веб-интерфейсу| уровень доступа]] | # Если вы работаете под обычным пользователем, то смените [[RS-485:Configuration via Web Interface#Смена уровня доступа к веб-интерфейсу| уровень доступа]]. | ||
# Перейдите '''Settings''' → '''Configs''' → '''Serial Device Driver Configuration''' | # Перейдите '''Settings''' → '''Configs''' → '''Serial Device Driver Configuration''' | ||
# Установите флажок '''Enable debug logging''' | # Установите флажок '''Enable debug logging''' | ||
Строка 105: | Строка 78: | ||
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [serial port driver] register value change: input @ 3 of device modbus:22 <- 39.01 | Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [serial port driver] register value change: input @ 3 of device modbus:22 <- 39.01 | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Версия 11:43, 1 декабря 2021
Описание
wb-mqtt-serial
— драйвер master-slave протоколов для устройств, работающих через последовательный порт. Драйвер работает через систему MQTT-сообщений и настраивается через веб-интерфейс.
Драйвер использует систему JSON-шаблонов, которые описывают подключаемые устройства: тип протокола, номера регистров, название параметров и контролов в веб-интерфейсе контроллера. В стандартной поставке есть шаблоны для всех устройств Wiren Board, а также некоторых сторонних устройств: счётчики электроэнергии, частотные преобразователи, холодильные контроллеры и другие.
Если ваше устройство работает по одному из поддерживаемых драйвером протоколу, но в стандартной поставке под него нет шаблона — вы можете написать шаблон сами.
Файлы и папки:
/etc/wb-mqtt-serial.conf
— файл настроек драйвера,/usr/share/wb-mqtt-serial/templates
— папка с предустановленными шаблонами,/etc/wb-mqtt-serial.conf.d/templates
— папка для пользовательских шаблонов, которые имеют приоритет на предустановленными.
О том, как получить доступ к файлам и папкам, читайте в статье Просмотр файлов контроллера с компьютера.
Полное описание драйвера, список поддерживаемых протоколов и примеры шаблонов, смотрите в репозитории на Github.
Управление драйвером
Обычно драйвер запускается автоматически при загрузке контроллера и перезапускается при сохранении файла конфигурации в веб-интерфейсе.
Также можно управлять драйвером в ручном режиме — это может быть полезно для поиска ошибок в конфигурационном файле или если вам нужно освободить порт для использования modbus_client.
Для выполнения команд подключитесь к контроллеру по SSH. Доступны команды:
systemctl stop wb-mqtt-serial # остановить
systemctl start wb-mqtt-serial # запустить
systemctl restart wb-mqtt-serial # перезапустить
wb-mqtt-serial -c /etc/wb-mqtt-serial.conf -d # запустить в отладочном режиме с указанием пути к конфигурационному файлу
wb-mqtt-serial -j # посмотреть ошибки в конфигурационном файле
Диагностика неполадок
Если возникли проблемы с запуском драйвера, например, новое устройство не появилось, то можно узнать причину: выполните команду systemctl status wb-mqtt-serial
и в последних двух строчках ответа будет подсказка.
В примере файл конфигурации содержит синтаксическую ошибку во второй строке на 14 позиции:
# systemctl status wb-mqtt-serial
● wb-mqtt-serial.service - MQTT Driver for serial devices
Loaded: loaded (/lib/systemd/system/wb-mqtt-serial.service; enabled; vendor preset: enabled)
Active: inactive (dead) since Thu 2021-01-28 15:10:51 +04; 4s ago
Process: 23682 ExecStart=/usr/bin/wb-mqtt-serial (code=exited, status=0/SUCCESS)
Main PID: 23682 (code=exited, status=0/SUCCESS)
Jan 28 15:10:47 wirenboard-A6XXXT2R systemd[1]: Started MQTT Driver for serial devices.
Jan 28 15:10:51 wirenboard-A6XXXT2R wb-mqtt-serial[23682]: ERROR: [serial] Failed to parse JSON /etc/wb-mqtt-serial.conf:* Line 2, Column 14
Jan 28 15:10:51 wirenboard-A6XXXT2R wb-mqtt-serial[23682]: Syntax error: value, object or array expected.
Включение отладки
Иногда нужно включить отладочный режим драйвера. Это можно сделать из командной строки или через веб-интерфейс.
При включённой отладке размер системного журнала будет быстро расти, поэтому не забудьте отключить отладку, когда необходимость в ней отпадет.
Включение отладки через веб-интерфейс:
- Зайдите в веб-интерфейс контроллера.
- Если вы работаете под обычным пользователем, то смените уровень доступа.
- Перейдите Settings → Configs → Serial Device Driver Configuration
- Установите флажок Enable debug logging
- Нажмите на кнопку Save, чтобы сохранить настройки.
Теперь в системный журнал будут записываться отправленные и принятые драйвером пакеты.
Чтобы посмотреть debug-вывод драйвера, выполните в консоли контроллера команду journalctl -e -p 7
, где -e
— отобразить последние записи, а -p 7
задает уровень сообщений, где 7 — это debug. Подробнее о параметрах утилиты, читайте в статье journalctl.
Пример вывода команды:
~# journalctl -e -p 7
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [serial port driver] channel 'Urms L1' of device 'wb-modbus-0-0' <-- 224.647
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [modbus] read 2 input(s) @ 5136 of device modbus:142
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [port] Sleep 0 us
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [port] Write: 8e 04 14 10 00 02 6a c1
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [port] Sleep 10000 us
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [port] ReadFrame: 16 04 02 0f 3d 09 12
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [register handler] new val for input @ 3 of device modbus:22: f3d
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [serial port driver] register value change: input @ 3 of device modbus:22 <- 39.01