Перейти к содержанию

Навигация

Wb-mqtt-serial driver: различия между версиями

Wb-mqtt-serial driver (просмотреть исходный код)

Версия 11:49, 5 октября 2023

4256 байт добавлено ,  7 месяцев назад
→‎Полезные ссылки
 
(не показано 237 промежуточных версий 9 участников)
Строка 1: Строка 1:
В настоящее время поддерживается работа с устройствами
{{DISPLAYTITLE: Драйвер wb-mqtt-serial}}
Modbus RTU, подключаемыми через RS-485.
== Описание ==
[[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]]
=== Общая информация ===
''wb-mqtt-serial'' — драйвер master-slave протоколов для устройств, подключённых:
* к шине RS-485 — протокол Modbus RTU и других;
* через Ethernet — протоколы Modbus TCP, Modbus over TCP и другие;
* к разъёмам MOD1–MOD3 — при наличии модулей расширения, использующих обмен по UART.


Конфигурация драйвера задаётся в файле /etc/wb-homa-modbus.conf
Драйвер опрашивает serial-устройства и публикует данные в топики [[MQTT|MQTT]]-брокера. Устройства и порты настраиваются через веб-интерфейс, подробнее в статье [[RS-485:Configuration via Web Interface | Начальное конфигурирование устройств через веб-интерфейс]].


Останов драйвера: - <code>service wb-homa-modbus stop</code>
Wb-mqtt-serial использует систему JSON-шаблонов, которые описывают подключённые устройства: тип протокола, номера регистров, название параметров и контролов в веб-интерфейсе контроллера. В стандартной поставке есть шаблоны для всех устройств Wiren Board, а также некоторых сторонних устройств: счётчики электроэнергии, частотные преобразователи, холодильные контроллеры и другие.


Запуск драйвера: <code>service wb-homa-modbus start</code>
Если ваше устройство работает по поддерживаемому драйвером протоколу, но в стандартной поставке под него нет шаблона — можете написать шаблон сами: [[Connecting_Third_Party_Devices_to_Wiren_Board | Подключение стороннего Modbus-устройства к контроллеру Wiren Board]].


Запуск драйвера в принудительном отладочном режиме:
Файлы и папки:
* <code>/etc/wb-mqtt-serial.conf</code> — файл настроек драйвера, редактировать вручную не рекомендуем;
* <code>/usr/share/wb-mqtt-serial/templates</code> — папка с предустановленными шаблонами;
* <code>/etc/wb-mqtt-serial.conf.d/templates</code> — папка для пользовательских шаблонов, которые имеют приоритет над предустановленными.


<code>wb-homa-modbus -c /etc/wb-homa-modbus.conf -d</code>
Если вы добавили свой шаблон или изменили существующий, подождите 20 секунд, а потом перезагрузите страницу конфигуратора в веб-интерфейсе клавишами <kbd>Ctrl</kbd>+<kbd>F5</kbd> или перезапустите сервис: <syntaxhighlight lang="bash>systemctl restart wb-mqtt-confed</syntaxhighlight>


====MSU34+TLP, MSU24 и MSU21 и подобные устройства====
О том, как получить доступ к файлам и папкам, читайте в статье [[View controller files from your computer|Просмотр файлов контроллера с компьютера]].


Сайт производителя - http://www.razumdom.ru/
Полное описание драйвера, список поддерживаемых протоколов и примеры шаблонов, смотрите '''[https://github.com/contactless/wb-mqtt-serial в репозитории на Github]'''.


Документация:
=== Особенности ===
При работе с Modbus-устройствами, драйвер оптимизирует запросы к устройствам: считывает несколько регистров подряд, не выдерживает некоторые задержки, рекомендованные стандартом.


http://www.razumdom.ru/userfiles/file/Modbus/MSU21.pdf
Поэтому при написании шаблона для сторонних Modbus-устройств, нужно указать параметр ''guard_interval_us'', который рассчитывается по формуле:
<syntaxhighlight lang="js">
guard_interval_us = (3.5*11*10^6)/(скорость в бит/с)
</syntaxhighlight>
Так же этот параметр можно установить через веб-интерфейс:
* Guard interval (us) — для порта.
* Additional delay before each writing to port (us) — для устройства.


http://www.razumdom.ru/userfiles/file/Modbus/MSU24.pdf
Если при чтении регистра устройства возникла ошибка, то соответствующий контрол в веб-интерфейсе  будет окрашен в красный цвет. Аналогично с устройством — если оно давно не отвечает, то все его контролы будут окрашены красным.


http://www.razumdom.ru/userfiles/file/Modbus/MSU34.pdf
== Управление драйвером ==


Устройства выдают значения с датчиков через
Обычно драйвер запускается автоматически при загрузке контроллера и перезапускается при сохранении файла конфигурации в веб-интерфейсе.
input-регистры. Для значений температуры используются
8-битные знаковые значения без расширения знака
на старшие 8 бит input-регистра, вследствие
чего для значений температуры в конфигурационном
файле необходимо указывать "format": "s8".


Подключаемые к устройству датчики конфигурируются
Также можно управлять драйвером в ручном режиме — это может быть полезно для поиска ошибок в конфигурационном файле или если вам нужно освободить порт для использования [[modbus-client | modbus_client]].
через holding-регистры (см. описание). Для конфигурации
датчиков можно использовать команду <code>modbus_client</code>,
или сделать setup-секцию в конфигурации драйвера.


Для установки адреса slave можно использовать скрипт
Для выполнения команд подключитесь к контроллеру по [[SSH]]. Доступны команды:
set-rd-address.sh. При этом необходимо убедиться, что к
<syntaxhighlight lang="bash">
порту RS-485 было подлкючено только то устройство,
systemctl stop wb-mqtt-serial # остановить
у которого необходимо сменить адрес, затем выполнить
systemctl start wb-mqtt-serial # запустить
команду:
systemctl restart wb-mqtt-serial # перезапустить
<pre>
wb-mqtt-serial -c /etc/wb-mqtt-serial.conf -d # запустить в отладочном режиме с указанием пути к конфигурационному файлу
set-rd.address.sh /dev/ttyNSC0 0x16
</syntaxhighlight>
</pre>
Вместо 0x16 можно задать любой другой адрес
в диапазоне от 0 до 247 (0xf7).


Пример конфигурации:
== Диагностика неполадок ==
<pre>
Если возникли проблемы с запуском драйвера, например, новое устройство не появилось, то можно узнать причину: выполните команду <code>systemctl status wb-mqtt-serial</code> и в последних двух строчках ответа будет подсказка.
{
    "debug": false,
    "ports": [
        {
            "path" : "/dev/ttyNSC0",
            "baud_rate": 9600,
            "parity": "N",
            "data_bits": 8,
            "stop_bits": 2,
            "poll_interval": 10,
            "enabled": true,
            "devices" : [
                {
                    "name": "MSU34+TLP",
                    "id": "msu34tlp",
                    "slave_id": 2,
                    "enabled": false,
                    "channels": [
                        {
                            "name" : "Temp 1",
                            "reg_type" : "input",
                            "address" : 0,
                            "type": "temperature",
                            "format": "s8"
                        },
                        {
                            "name" : "Illuminance",
                            "reg_type" : "input",
                            "address" : 1,
                            "type": "text"
                        },
                        {
                            "name" : "Pressure",
                            "reg_type" : "input",
                            "address" : 2,
                            "type": "text",
                            "scale": 0.075
                        },
                        {
                            "name" : "Temp 2",
                            "reg_type" : "input",
                            "address" : 3,
                            "type": "temperature",
                            "format": "s8"
                        }
                    ]
                }
            ]
        }
    ]
}
</pre>


Пример конфигурации MSU21 с секцией инициализации ("setup"):
В примере файл конфигурации содержит синтаксическую ошибку во второй строке на 14 позиции:
<pre>
<syntaxhighlight lang="console">
                {
# systemctl status wb-mqtt-serial
                    "name": "MSU21",
● wb-mqtt-serial.service - MQTT Driver for serial devices
                    "id": "msu21",
  Loaded: loaded (/lib/systemd/system/wb-mqtt-serial.service; enabled; vendor preset: enabled)
                    "slave_id": 24,
  Active: inactive (dead) since Thu 2021-01-28 15:10:51 +04; 4s ago
                    "enabled": true,
  Process: 23682 ExecStart=/usr/bin/wb-mqtt-serial (code=exited, status=0/SUCCESS)
                    "setup": [
Main PID: 23682 (code=exited, status=0/SUCCESS)
                        {
                            "title": "Input 0 type",
                            "address": 1,
                            "value": 2
                        },
                        {
                            "title": "Input 0 module",
                            "address": 3,
                            "value": 6
                        }
                    ],
                    "channels": [
                        {
                            "name" : "Temperature",
                            "reg_type" : "input",
                            "address" : 0,
                            "type": "temperature",
                            "format": "s8"
                        }
                    ]
                }
</pre>


====4-канальный (RGBW) диммер светодиодов DDL24====
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.
</syntaxhighlight>


Сайт производителя - http://www.razumdom.ru/
Проверить только шаблоны, в том числе и не подключённые в файле конфигурации, можно командой:
<syntaxhighlight lang="console">
# wb-mqtt-serial -g
<3>ERROR: [serial config] Failed to parse /usr/share/wb-mqtt-serial/templates/config-bac-6000-series.json
Failed to parse JSON /usr/share/wb-mqtt-serial/templates/config-bac-6000-series.json:* Line 12, Column 5
  Missing ',' or '}' in object declaration
</syntaxhighlight>


Документация:
Проверить файл конфигурации и шаблоны на ошибки:
<syntaxhighlight lang="console">
# wb-mqtt-serial -j
<3>ERROR: [serial config] Failed to parse /usr/share/wb-mqtt-serial/templates/config-wb-mdm3.json
Failed to parse JSON /usr/share/wb-mqtt-serial/templates/config-wb-mdm3.json:* Line 8, Column 9
  Missing ',' or '}' in object declaration


http://www.razumdom.ru/userfiles/file/Modbus/DDL24.pdf
<3>ERROR: [serial] Can't find template for 'WB-MDM3'
</syntaxhighlight>


Устройство предназначено для управления светодиодными
При необходимости, можно добавить путь к файлу, который нужно проверить:
лентами RGBW сигналами ШИМ или для управления приводами
<syntaxhighlight lang="bash">
сигналами 0-10 В.
wb-mqtt-serial -c /etc/wb-mqtt-serial.conf -j
</syntaxhighlight>


Управление осуществляется записью значений в
== Включение отладки==
holding-регистры.
[[Файл:Serial Web config.png|400px|thumb|right|Веб-интерфейс. Флажок ''Enable debug logging'' установлен, отладка включена]]
Иногда нужно включить отладочный режим драйвера. Это можно сделать из [[#Управление драйвером | командной строки]] или через веб-интерфейс.


Как и в случае с устройствами MSU*, адрес
{{note|info| При включённой отладке размер системного журнала будет быстро расти, поэтому не забудьте отключить отладку, когда необходимость в ней отпадет.}}
modbus slave устанавливается командой
set-rd-address.sh.
<pre>
set-rd-address.sh /dev/ttyNSC0 0x17 0x00
</pre>
Здесь происходит установка slave-адреса
в 0x17. Дополнительное значение
0x00 нужно, т.к. DDL24 использует для
конфигурации адреса holding-регистр 0x00,
а не 0x80, используемый скриптом set-rd-address.sh
по умолчанию.


Пример конфигурации:
Включение отладки через [[Wiren Board Web Interface|веб-интерфейс]]:
<pre>
# Зайдите в веб-интерфейс контроллера
                {
# Если вы работаете под обычным пользователем, то смените [[RS-485:Configuration via Web Interface#Смена уровня доступа к веб-интерфейсу| уровень доступа]]
                    "name": "DDL24",
# Перейдите '''Settings''' → '''Configs''' → '''Serial Device Driver Configuration'''
                    "id": "ddl24",
# Установите флажок '''Enable debug logging'''
                    "enabled": true,
# Нажмите на кнопку '''Save''', чтобы сохранить настройки.
                    "slave_id": 23,
 
                    "channels": [
Теперь в системный журнал будут записываться отправленные и принятые драйвером пакеты.
                        {
 
                            "name" : "Red",
Чтобы посмотреть debug-вывод драйвера, выполните в консоли контроллера команду <code>journalctl -e -p 7</code>, где <code>-e</code> — отобразить последние записи, а <code>-p 7</code> задает уровень сообщений, где 7 — это debug. Подробнее о параметрах утилиты, читайте в статье [[journalctl]].
                            "reg_type" : "holding",
 
                            "address" : 4,
Пример вывода команды:
                            "type": "range",
<syntaxhighlight lang="bash">
                            "max": 255
~# 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
                            "name" : "Green",
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [port] Sleep 0 us
                            "reg_type" : "holding",
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [port] Write: 8e 04 14 10 00 02 6a c1
                            "address" : 5,
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [port] Sleep 10000 us
                            "type": "range",
Jan 29 14:27:24 wirenboard-A6ZZXT2R wb-mqtt-serial[1667]: DEBUG: [port] ReadFrame: 16 04 02 0f 3d 09 12
                            "max": 255
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
                        {
</syntaxhighlight>
                            "name" : "Blue",
 
                            "reg_type" : "holding",
== Полезные ссылки ==
                            "address" : 6,
* [[Connecting_Third_Party_Devices_to_Wiren_Board | Как подключить стороннее Modbus-устройство]]
                            "type": "range",
* [https://github.com/contactless/wb-mqtt-serial Описание wb-mqtt-serial на Github]
                            "max": 255
* [[Modbus|Описание протокола Modbus]]
                        },
* [[Fast_Modbus| Описание расширения Быстрый Modbus]]
                        {
* [[RS-485|Описание шины RS-485]]
                            "name" : "White",
                            "reg_type" : "holding",
                            "address" : 7,
                            "type": "range",
                            "max": 255
                        },
                        {
                            "name" : "RGB",
                            "reg_type" : "holding",
                            "address" : 8,
                            "type": "range",
                            "max": 100
                        },
                        {
                            "name" : "White1",
                            "reg_type" : "holding",
                            "address" : 9,
                            "type": "range",
                            "max": 100
                        },
                        {
                            "name" : "Voltage",
                            "reg_type" : "holding",
                            "address" : 18,
                            "type": "text"
                        }
                    ]
                }
</pre>
Matveevrj
translator, wb_editors
4234

правки

Источник — https://wirenboard.com/wiki/Служебная:Сравнение_версий/1306...76847