16 281
правка
м (→Включение отладки: Обновил информацию по поиску отладочных сообщений) |
(Добавил диаграмму таймаутов опроса, взял на гитхабе) |
||
(не показаны 42 промежуточные версии 3 участников) | |||
Строка 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]] | |||
== Описание == | |||
{{note|note| Драйвер ''wb-mqtt-serial'' ранее назывался ''wb-homa-modbus'', а конфигурационный файл <code>/etc/wb-mqtt-serial.conf</code> — <code>/etc/wb-homa-modbus.conf</code>. Учитывайте это, если используете устаревшие прошивки.}} | |||
Драйвер <code>wb-mqtt-serial</code> служит для работы с подключенными по последовательным портам, в том числе [[RS-485|RS-485]], устройствами через систему [[MQTT|MQTT]]-сообщений. | |||
Полное описание драйвера смотрите [https://github.com/contactless/wb-mqtt-serial в репозитории на Github]. | Полное описание драйвера смотрите [https://github.com/contactless/wb-mqtt-serial в репозитории на Github]. | ||
==Поддерживаемые устройства== | == Поддерживаемые устройства == | ||
=== Перечень === | |||
Драйвер поддерживает некоторые устройства, который работают по протоколам: | |||
* [[Modbus | Modbus RTU и Modbus TCP]], | |||
* [http://smart.uniel.ru Uniel], | |||
* [http://www.eksis.ru/catalog/measures-of-relative-humidity-and-temperature/ ИВТМ], | |||
* [https://www.incotexcom.ru/catalogue Меркурий], | |||
* [https://miluris.ru/ Милур], | |||
* [[GOST MEK 61107 | Энергомера ГОСТ МЭК 61107]], | |||
* [[GOST MEK 61107 |НЕВА МТ 32х ГОСТ МЭК 61107]], | |||
* [[DLMS/COSEM | DLMS/COSEM, СПОДЭС (ГОСТ Р 58940-2020)]], | |||
* [[Somfy SDN | Somfy SDN]], | |||
* [[WinDeco | WinDeco]], | |||
* [[Dooya DT82 | Dooya DT82]]. | |||
Полный список поддерживаемых устройств и особенности подключения, смотрите в таблице [[Supported devices#Таблица | Поддерживаемые контроллером Wiren Board протоколы и устройства]]. | |||
Учитывайте, что сторонние производители устройств могут вносить недокументированные изменения в протокол, поэтому перед покупкой устройства желательно убедиться в работоспособности выбранного решения. | |||
=== Поддержка устройств различных протоколов на одной шине === | === Поддержка устройств различных протоколов на одной шине === | ||
Строка 18: | Строка 30: | ||
Использовать устройства с разными протоколами на одной шине возможно, но необходимо учитывать особенности конкретных протоколов. | Использовать устройства с разными протоколами на одной шине возможно, но необходимо учитывать особенности конкретных протоколов. | ||
Например, фреймы устройств | Например, фреймы устройств Uniel начинаются с байта <code>0xff</code>, а устройств ИВТМ — с байта <code>0x24</code>. В случае с протоколами Modbus, Меркурий 230 и Милур первым байтом фрейма является идентификатор ''slave'', поэтому при совмещении таких устройств нужно внимательно подходить к выбору ''slave id''. | ||
У устройств Милур slave id по умолчанию равен <code>0xff</code>, что приведет к конфликту с устройствами | У устройств Милур ''slave id'' по умолчанию равен <code>0xff</code>, что приведет к конфликту с устройствами Uniel. Также устройства Милур требуют дополнительных задержек при опросе и при использовании на одной шине с другими устройствами могут снизить общую скорость опроса устройств. | ||
Иногда устройства, работающие на разных протоколах могут конфликтовать между собой | Иногда устройства, работающие на разных протоколах могут конфликтовать между собой. | ||
=== Широковещательные сообщения === | |||
[[Image:Broadcast Energometa CE102M.png |400px|thumb|right| Включение широковещательных сообщений в настройках счётчика Энергомера CE102M]] | |||
Протоколы Меркурий 230, Энергомера ГОСТ МЭК 61107, НЕВА МТ 32х ГОСТ МЭК 61107 поддерживают отправку широковещательных сообщений, если не указывать идентификатор устройства, или указать вместо него пустую строку. Это можно использовать, если на шине только одно устройство такого типа, и его адрес неизвестен. | |||
При этом нельзя на одном порту одновременно использовать широковещательные сообщения Энергомера ГОСТ МЭК 61107 и НЕВА МТ 32х ГОСТ МЭК 61107. | |||
=== Доработка драйвера для поддержки новых устройств === | === Доработка драйвера для поддержки новых устройств === | ||
Вы можете самостоятельно добавить поддержку новых | Вы можете самостоятельно добавить поддержку новых устройств, которые работают по Modbus или по другим известным драйверу протоколам, при помощи [[Wb-mqtt-serial templates|шаблонов]]. | ||
Если у вас возникли проблемы с составлением шаблона или выбранное вами устройство имеет свой протокол обмена данными — [https://wirenboard.com/ru/pages/contacts свяжитесь с нами] и мы постараемся помочь. | Если у вас возникли проблемы с составлением шаблона или выбранное вами устройство имеет свой протокол обмена данными — [https://wirenboard.com/ru/pages/contacts свяжитесь с нами] и мы постараемся помочь. | ||
Строка 44: | Строка 60: | ||
service wb-mqtt-serial restart #перезапустить драйвер | service wb-mqtt-serial restart #перезапустить драйвер | ||
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> | ||
== Файл конфигурации драйвера == | == Файл конфигурации драйвера == | ||
[[Image: wb-mqtt-serial working diagram.png|500px|thumb|right| Диаграмма таймаутов цикла опроса]] | |||
Перед использованием драйвер нужно настроить. Конфигурация драйвера хранится в файле <code>/etc/wb-mqtt-serial.conf</code>. | Перед использованием драйвер нужно настроить. Конфигурация драйвера хранится в файле <code>/etc/wb-mqtt-serial.conf</code>. | ||
=== Структура файла === | === Структура файла === | ||
Файл <code>/etc/wb-mqtt-serial.conf</code> имеет структуру <code>порты (ports)</code> → <code>устройства (devices)</code> → <code>каналы (channels)</code>: в файле есть описание физических портов контроллера, внутри них — список | Файл <code>/etc/wb-mqtt-serial.conf</code> имеет структуру <code>порты (ports)</code> → <code>устройства (devices)</code> → <code>каналы (channels)</code>: в файле есть описание физических портов контроллера, внутри них — список подключенных к этому порту устройств, а внутри устройств описаны их каналы. | ||
Для каждого порта указываются настройки: скорость, четность и т.п., а также протокол: Modbus, Uniel и т.п. Для каждого устройства обязательно указывается его уникальный адрес на шине — <code>slave_id</code>, остальные параметры указываются по необходимости. | Для каждого порта указываются настройки: скорость, четность и т.п., а также протокол: Modbus, Uniel и т.п. Для каждого устройства обязательно указывается его уникальный адрес на шине — <code>slave_id</code>, остальные параметры указываются по необходимости. Если параметр не указан — будет подставлено значение по умолчанию. | ||
Структура файла: | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
{ | { | ||
// основные настройки драйвера | |||
"параметр": "значение", | |||
... | |||
// порты | |||
"ports": [ | "ports": [ | ||
{ | { | ||
// настройки порта | |||
"параметр": "значение", | |||
... | |||
// список устройств на этом порту | |||
// список устройств на | |||
"devices" : [ | "devices" : [ | ||
{ | { | ||
// описание первого устройства на канале | |||
" | "параметр": "значение", | ||
... | |||
// список каналов устройства | // список каналов устройства | ||
"channels": [ | "channels": [ | ||
{ | { | ||
//описание канала 1 | |||
"параметр": "значение", | |||
... | |||
}, | }, | ||
{ | { | ||
//описание канала 2 | |||
"параметр": "значение", | |||
... | |||
}, | }, | ||
... | |||
] | ] | ||
}, | }, | ||
{ | { | ||
// | // описание второго устройства на канале | ||
" | "параметр": "значение", | ||
... | |||
// секция инициализации | // секция инициализации второго устройства | ||
"setup": [ | "setup": [ | ||
{ | { | ||
// | // описание регистра настройки | ||
"параметр": "значение", | |||
... | |||
}, | }, | ||
... | |||
], | ], | ||
// секция параметров второго устройства, значение указанных здесь параметров можно менять в веб-интерфейсе | |||
"parameters": { | |||
"param1": { | |||
// описание регистра настройки | |||
"параметр": "значение", | |||
... | |||
}, | |||
"param2": { | |||
// описание регистра настройки | |||
"параметр": "значение", | |||
... | |||
}, | |||
... | |||
}, | |||
// каналы второго устройства | |||
"channels": [ | "channels": [ | ||
{ | { | ||
//первый канал | |||
"параметр": "значение", | |||
... | |||
}, | }, | ||
... | |||
] | ] | ||
} | } | ||
Строка 387: | Строка 150: | ||
}, | }, | ||
{ | { | ||
// ещё один порт со своим набором устройств | // ещё один порт со своим набором устройств | ||
"devices" : [ | "devices" : [ | ||
{ | { | ||
" | "параметр": "значение", | ||
... | |||
"channels": [ | "channels": [ | ||
{ | |||
"параметр": "значение", | |||
... | |||
} | |||
] | ] | ||
} | } | ||
... | |||
] | ] | ||
} | } | ||
Строка 417: | Строка 169: | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Пример конфигурационного файла можете посмотреть [https://github.com/wirenboard/wb-mqtt-serial/blob/master/README.md в репозитории]. | |||
==== Основные настройки драйвера ==== | |||
* debug — опция включает отладочный режим драйвера. Доступные значения: ''true'', ''false''. | |||
* max_unchanged_interval — Задаёт интервал в секундах, в течение которого неизменяющиеся значения не будут публиковаться в MQTT. По истечении интервала значения будут опубликованы, даже если они не изменились. Помимо интервала в секундах можно указать специальные значения: | |||
** <code>0</code> — публиковать все значения; | |||
** <code>-1</code> — публиковать только при изменении. Значение по умолчанию. | |||
==== Порты (ports) ==== | |||
* port_type — можно указать один из трех типов порта: | |||
** serial — последовательные порты RS-485 или RS-232. Значение по умолчанию. | |||
** tcp — serial over TCP/IP. Пакеты, формируемые для работы с последовательными портами, передаются без изменений через TCP/IP. | |||
** modbus tcp — передача по Modbus TCP. В секции устройств с таким типом порта могут использоваться только те, что поддерживают Modbus. | |||
* path — если выбран тип ''serial'': устройство в системе, которое соответствует порту RS-485. | |||
* address — если выбран тип ''tcp'' или ''modbus tcp'': IP-адрес или имя хоста. | |||
* port — если выбран тип ''tcp'' или ''modbus tcp'': TCP-порт. | |||
* baud_rate — скорость порта. | |||
* parity — четность: | |||
** N — none, без бита четности. Значение по умолчанию; | |||
** O — odd, нечетный; | |||
** E — even, четный. | |||
* data_bits — количество бит данных, по умолчанию — 8. | |||
* stop_bits — количество стоп-бит, по умолчанию — 2. | |||
* poll_interval — минимальный интервал опроса каждого регистра в миллисекундах. | |||
* response_timeout_ms — максимальное время ожидания ответа устройств в миллисекундах. По умолчанию — 500 мс. | |||
* guard_interval_us — дополнительная задержка перед отправкой данных в порт, микросекунды. | |||
* connection_timeout_ms — если выбран тип ''tcp'' или ''modbus tcp'': таймаут соединения. Если в течение указанного времени ни по одному из устройств на порту не поступило данных и истек ''connection_max_fail_cycles'' — разорвать соединение и переподключиться. | |||
* connection_max_fail_cycles — если выбран тип ''tcp'' или ''modbus tcp'': количество неудачных циклов опроса. | |||
* enabled — включает или отключает порт. Доступные значения: ''true'', ''false''. По умолчанию — ''true''. | |||
==== Устройства, их каналы и параметры (devices, channels, setup и parameters) ==== | |||
Раздел '''devices''' содержит описание устройств, подключенных к порту и имеет структуру: | |||
<syntaxhighlight lang="javascript"> | |||
"devices" : | |||
[ | |||
{ | |||
// описание устройства | |||
... | |||
"channels" : | |||
[ | |||
// описание каналов | |||
... | |||
] | |||
}, | |||
{ | |||
// описание второго устройства | |||
... | |||
}, | |||
... | |||
] | |||
</syntaxhighlight> | |||
Описание устройства '''device''' может быть задано двумя способами: вручную прописать все параметры или задать только несколько параметров, а остальные вынести в шаблон: | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
// По DeviceType драйвер будет искать в папках с шаблонами описаний устройств | |||
"device_type" : "DeviceType", | |||
// отображаемое имя устройства. Публикуется как | |||
// .../meta/name в MQTT | |||
// По умолчанию name берется из шаблона и добавляется slave_id, т.е. | |||
// "name" + " " + "slave_id" | |||
"name" : "somename", | |||
// уникальный идентификатор устройства в MQTT. | |||
// каждый элемент в devices должен иметь уникальный id | |||
// topic'и, относящиеся в MQTT к данному устройству, | |||
// имеют общий префикс /devices/<идентификатор топика>/... | |||
// также по умолчанию берется из шаблона с добавлением slave_id: | |||
// "deviceID" + "_" + slave_id | |||
"id" : "deviceID", | |||
// идентификатор slave | |||
"slave_id" : slaveID, | |||
// включить/выключить устройство. В случае задания | |||
// "enabled": false опрос устройства и запись значений | |||
// его каналов не происходит. По умолчанию - true. | |||
"enabled" : true, | |||
// если используется шаблон устройства, определения | |||
// каналов совмещаются. Если имя (name) в определении | |||
// канала устройства совпадает с именем канала в шаблоне, | |||
// свойства каналов из шаблона и определения устройства | |||
// совмещаются, при этом значения свойств из определения | |||
// устройства (в файле конфигурации) имеют преимущество. | |||
// Это можно использовать, например, для задания индивидуальных | |||
// интервалов опроса каналов. Если канал с таким же | |||
// именем, как канал в определении устройства, отсутствует | |||
// в шаблоне, создаётся новый канал. | |||
"channels": [ | |||
{ | |||
// имя канала. topic'и, соответствующие каналу, | |||
"name" : "Temp 1", | |||
"poll_interval": 10000 | |||
} | |||
] | |||
} | |||
</syntaxhighlight> | |||
Подробное описание разделов '''device''', '''channels''', '''setup''' и '''parameters''' вы найдете [[Wb-mqtt-serial templates | в статье о шаблонах]]. | |||
=== Редактирование через веб-интерфейс === | === Редактирование через веб-интерфейс === | ||
Строка 430: | Строка 284: | ||
service wb-mqtt-serial restart | service wb-mqtt-serial restart | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== Поиск ошибок === | |||
Если возникли проблемы с запуском драйвера, например, новое устройство не появилось, то можно узнать причину: выполните команду <code>systemctl status wb-mqtt-serial</code> и в последних двух строчках ответа будет подсказка. | |||
В примере файл конфигурации содержит синтаксическую ошибку во второй строке на 14 позиции: | |||
<syntaxhighlight lang="bash"> | |||
~# systemctl status wb-mqtt-serial | ~# systemctl status wb-mqtt-serial | ||
● wb-mqtt-serial.service - MQTT Driver for serial devices | ● wb-mqtt-serial.service - MQTT Driver for serial devices | ||
Строка 631: | Строка 489: | ||
[[Файл:Serial Web config.png|400px|thumb|right|Веб-интерфейс. Флажок ''Enable debug logging'' установлен, отладка включена]] | [[Файл:Serial Web config.png|400px|thumb|right|Веб-интерфейс. Флажок ''Enable debug logging'' установлен, отладка включена]] | ||
Иногда нужно включить отладочный режим драйвера. Это можно сделать из [[#Управление драйвером | командной строки]] или через веб-интерфейс. | Иногда нужно включить отладочный режим драйвера. Это можно сделать из [[#Управление драйвером | командной строки]] или через веб-интерфейс. | ||
'''ВНИМАНИЕ: ''' при включенной отладке размер системного журнала будет быстро расти, поэтому не забудьте отключить отладку, когда необходимость в ней отпадет. | |||
Включение отладки через веб-интерфейс: | Включение отладки через веб-интерфейс: | ||
Строка 656: | Строка 516: | ||
Подробнее о возможностях утилиты <code>journalctl</code> можете почитать в [https://habr.com/ru/company/ruvds/blog/533918/ статье на Хабре]. | Подробнее о возможностях утилиты <code>journalctl</code> можете почитать в [https://habr.com/ru/company/ruvds/blog/533918/ статье на Хабре]. | ||
== Полезные ссылки == | |||
* [[Wb-mqtt-serial templates| Описание шаблонов и примеры]] | |||
* [[RS-485:Configuration via Web Interface | Настройка драйвера wb-mqtt-serial в веб-интерфейсе]] | |||
* [https://github.com/wirenboard/wb-mqtt-serial/blob/master/README.md Описание драйвера в репозитории на Github] |