Wb-mqtt-serial driver: различия между версиями
(Убрал старый текст, и поменял ссылку на ssh) |
Brainroot (обсуждение | вклад) |
||
(не показано 98 промежуточных версий 7 участников) | |||
Строка 1: | Строка 1: | ||
<languages/> | |||
<translate> | |||
<!--T:1--> | |||
'''Внимание!''' Драйвер ''wb-mqtt-serial'' ранее назывался ''wb-homa-modbus'', а конфигурационный файл <code>/etc/wb-mqtt-serial.conf</code> как <code>/etc/wb-homa-modbus.conf</code>. Учитывайте это, если используете устаревшие прошивки. | |||
Драйвер | <!--T:2--> | ||
'''Драйвер wb-mqtt-serial''' отвечает за работу с подключёнными по [[Special:MyLanguage/RS-485|RS-485]] устройствами в Wiren Board. Он обеспечивает работу с подключёнными устройствами через систему [[Special:MyLanguage/MQTT|MQTT]]-сообщений. В этой статье даётся упрощённое описание драйвера, полное смотрите [https://github.com/contactless/wb-mqtt-serial в описании драйвера на нашем Github]. | |||
==Поддерживаемые устройства== <!--T:3--> | |||
<!--T:4--> | |||
В настоящее время поддерживается работа с [[Special:MyLanguage/Периферийные устройства с интерфейсом RS-485 серии WB-xxxx | устройствами с интерфейсом Modbus нашего производства]], счётчиками Меркурий и Милур, а также с некоторыми другими устройствами, в том числе работающими по протоколу Modbus. Полный список протестированных устройств: [[Special:MyLanguage/Поддерживаемые устройства#Подключаемые по RS-485|Поддерживаемые устройства#Подключаемые по RS-485]]. | |||
=== Поддержка устройств различных протоколов на одной шине === <!--T:5--> | |||
<!--T:6--> | |||
Использовать устройства с разными протоколами на одной шине возможно, но необходимо учитывать особенности конкретных протоколов. | |||
<!--T:7--> | |||
Например, фреймы устройств Uniel начинаются с байта 0xff, устройств ИВТМ - с байта 0x24 ('$'), в случае же протоколов Modbus, Меркурий 230 и Милур первым байтом фрейма является идентификатор slave, поэтому при совмещении подобных устройств следует внимательно подходить к выбору slave id - у устройств Милур, например, slave id по умолчанию равен 0xff, что приводит к конфликту с устройствами Uniel. Устройства Милур требуют дополнительных задержек при опросе (заданы в шаблоне) и при использовании на одной шине с другими устройствами могут снизить скорость опроса. Некоторые устройства, поддерживающие дополнительные протоколы, могут оказаться несовместимыми с теми или иными протоколами на той же шине, например, было замечено, что устройства с поддержкой протокола A-BUS производства "Разумный дом" не могут работать на одной шине с устройствами Uniel. Работа устройств ИВТМ на одной шине с устройствами, работающими по другим протоколам, не проверялась. Проверенная рабочая комбинация: Modbus + Milur (slave_id != 0xff) + Uniel на одной шине. | |||
=== Доработка драйвера для поддержки новых устройств === <!--T:8--> | |||
<!--T:9--> | |||
В качестве отправной точки смотрите статью [[Драйвер wb-mqtt-serial:Примеры написания шаблонов|Драйвер wb-mqtt-serial:Примеры написания шаблонов]], для дальнейшей поддержки [mailto:info@contactless.ru свяжитесь с нами]. | |||
==Конфигурирование и запуск драйвера== <!--T:10--> | |||
< | |||
<!--T:11--> | |||
Конфигурация драйвера задаётся в файле <code>/etc/wb-mqtt-serial.conf</code>. Если такой файл создан, драйвер запускается при загрузке контроллера автоматически. Также драйвером можно управлять в ручном режиме из консоли: | |||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
service wb-mqtt-serial stop #остановить драйвер | |||
service wb-mqtt-serial start #запустить драйвер | |||
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 #запустить драйвер в принудительном отладочном режиме с указанием пути к конфигурационному файлу | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== | == Конфигурационный файл драйвера == <!--T:12--> | ||
<!--T:13--> | |||
Для работы драйвера нужно отредактировать файл <code>/etc/wb-mqtt-serial.conf</code>. Обычный пользователь может воспользоваться способом [[RS-485:Настройка через веб-интерфейс|RS-485:Настройка через веб-интерфейс]], который тоже приводит к правильному заполнению файла конфигурации. Однако отредактировать файл можно и вручную, для этого: | |||
#Ознакомьтесь с инструкцией [[Special:MyLanguage/Просмотр файлов контроллера с компьютера|Просмотр файлов контроллера с компьютера]] | |||
#Файл <code>/etc/wb-mqtt-serial.conf</code> имеет структуру ''порты (ports) -> устройства (devices)'': в файле есть описания физических портов контроллера, а внутри них - список устройств, которые подключены к этому порту. | |||
#:Для каждого порта указываются настройки (скорость, чётность и т.п.), а также протокол (Modbus, RTU, etc.) | |||
#:Для каждого устройства обязательно указывается его уникальный адрес на шине - ''slave_id''. Также можно указать другие необязательные параметры - смотрите полное описание формата [https://github.com/wirenboard/wb-mqtt-serial/blob/master/README.md в описании драйвера на нашем Github]. | |||
#Впишите конфигурацию для портов и подключённых устройств в файл, используя примеры ниже. | |||
#Перезагрузите устройство ИЛИ выполните из консоли команду | |||
#: <syntaxhighlight lang="bash"> | |||
service wb-mqtt-serial restart | |||
</syntaxhighlight> | </syntaxhighlight> | ||
#:Она перезапустит драйвер, и подключённое устройство появится в веб-интерфейсе. | |||
#Если устройство не появилось, выполните команду <syntaxhighlight lang="bash">tail /var/log/messages</syntaxhighlight> или откройте файл <code>/var/log/messages</code> и промотайте его до конца. Если там будет строчка такого типа: | |||
#:<code>May 6 17:50:58 wirenboard user.notice modbus: FATAL: Error parsing config file: Failed to parse JSON: * Line <b>15</b>, Column 17</code> | |||
#:- ищите ошибку в 15-й строке конфигурационного файла. | |||
===Пример конфигурации для [[Special:MyLanguage/WB-MRM2 Реле 2х канальное | модуля реле WB-MRM2]], подключённого к изолированному порту (RS-485-ISO) Wiren Board 4=== <!--T:14--> | |||
<!--T:15--> | |||
<syntaxhighlight lang="javascript">{ | |||
"ports": [ | |||
{ | |||
"path" : "/dev/ttyNSC0", //псевдофайл, соответствующий порту | |||
"baud_rate": 9600, //скорость порта, 9600 почти для всех устройств, но проверьте документацию к ним | |||
"parity": "N", //четность | |||
"data_bits": 8, //битов данных в посылке | |||
"stop_bits": 2, //количество стоп-битов. Чётность, количество битов и стоп-битов тоже редко меняются | |||
"poll_interval": 10, //интервал опроса устройств на порту в миллисекундах | |||
"devices" : [ | |||
{ | |||
"device_type" : "WB-MRM2", //тип устройства, распознаваемый драйвером | |||
"slave_id": 25 //адрес устройства | |||
} | |||
] | |||
} | |||
] | |||
}</syntaxhighlight> | |||
<!--T:16--> | |||
Полный список поддерживаемых типов устройств см. в статье [[Special:MyLanguage/Поддерживаемые устройства|Поддерживаемые устройства]], а также [https://github.com/contactless/wb-homa-drivers/blob/master/wb-homa-modbus/README.md#%D0%A2%D0%B0%D0%B1%D0%BB%D0%B8%D1%86%D0%B0-%D1%88%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%D0%BE%D0%B2-device_type здесь]. | |||
# | |||
=== Пример конфигурационного файла для нескольких подключённых устройств === <!--T:17--> | |||
<!--T:18--> | |||
<syntaxhighlight lang="javascript"> | |||
<!--T:19--> | |||
< | // Configuration options | ||
{ | |||
"debug": false, | |||
"ports": [ | |||
{ | |||
"path" : "/dev/ttyNSC1", | |||
"baud_rate": 9600, | |||
"parity": "N", | |||
"data_bits": 8, | |||
"stop_bits": 2, | |||
"poll_interval": 0, | |||
"enabled": true, | |||
"devices" : [ | |||
{ | |||
"name": "DRB88", | |||
"id": "drb88", | |||
"enabled": true, | |||
"slave_id": "0x23", | |||
"device_type" : "DRB88" | |||
}, | |||
{ | |||
"slave_id": "0x26", | |||
"device_type" : "MSU24" | |||
}, | |||
{ | |||
"slave_id": "0x31", | |||
"device_type" : "MSU34" | |||
}, | |||
{ | |||
"slave_id": "0x04", | |||
"device_type" : "LC-103" | |||
}, | |||
{ | |||
"device_type" : "DDL24", | |||
"slave_id" : "0x20" | |||
}, | |||
{ | |||
"enabled": true, | |||
"slave_id": "0x06", | |||
"device_type" : "WB-MRM2" | |||
}, | |||
{ | |||
"slave_id" : 16, | |||
"device_type" : "WB-MRGB" | |||
} | |||
] | |||
}, | |||
{ | |||
"path" : "/dev/ttyNSC0", | |||
"type": "uniel", | |||
"poll_interval": 10, | |||
"enabled": true, | |||
"devices" : [ | |||
{ | |||
"device_type" : "UCH-M141RC", | |||
"slave_id": 1 | |||
} | |||
] | |||
} | |||
] | |||
} | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</translate> | |||
== | == Включение отладки через веб-интерфейс == | ||
Заходим в веб-интерфейс '''Configs - Serial Device Driver Configuration''' | |||
[[Файл:Serial Web config.png|400px|thumb|center|Вид интерфейса]] | |||
Ставим галочку '''Enable debug logging''' | |||
[[Файл:Serial_Web_config_Enable_debug.png |400px|thumb|center|Включение Debug]] | |||
После нажатия кнопки '''Save''' | |||
В файл /var/log/messages будут записываться отправленные и принятые пакеты [[%D0%9F%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB_Modbus | Modbus]]. | |||
<blockquote>Не забудьте '''отключить''' отладку. Иначе логи займут все доступное место.</blockquote> |
Версия 16:32, 21 сентября 2020
Внимание! Драйвер wb-mqtt-serial ранее назывался wb-homa-modbus, а конфигурационный файл /etc/wb-mqtt-serial.conf
как /etc/wb-homa-modbus.conf
. Учитывайте это, если используете устаревшие прошивки.
Драйвер wb-mqtt-serial отвечает за работу с подключёнными по RS-485 устройствами в Wiren Board. Он обеспечивает работу с подключёнными устройствами через систему MQTT-сообщений. В этой статье даётся упрощённое описание драйвера, полное смотрите в описании драйвера на нашем Github.
Поддерживаемые устройства
В настоящее время поддерживается работа с устройствами с интерфейсом Modbus нашего производства, счётчиками Меркурий и Милур, а также с некоторыми другими устройствами, в том числе работающими по протоколу Modbus. Полный список протестированных устройств: Поддерживаемые устройства#Подключаемые по RS-485.
Поддержка устройств различных протоколов на одной шине
Использовать устройства с разными протоколами на одной шине возможно, но необходимо учитывать особенности конкретных протоколов.
Например, фреймы устройств Uniel начинаются с байта 0xff, устройств ИВТМ - с байта 0x24 ('$'), в случае же протоколов Modbus, Меркурий 230 и Милур первым байтом фрейма является идентификатор slave, поэтому при совмещении подобных устройств следует внимательно подходить к выбору slave id - у устройств Милур, например, slave id по умолчанию равен 0xff, что приводит к конфликту с устройствами Uniel. Устройства Милур требуют дополнительных задержек при опросе (заданы в шаблоне) и при использовании на одной шине с другими устройствами могут снизить скорость опроса. Некоторые устройства, поддерживающие дополнительные протоколы, могут оказаться несовместимыми с теми или иными протоколами на той же шине, например, было замечено, что устройства с поддержкой протокола A-BUS производства "Разумный дом" не могут работать на одной шине с устройствами Uniel. Работа устройств ИВТМ на одной шине с устройствами, работающими по другим протоколам, не проверялась. Проверенная рабочая комбинация: Modbus + Milur (slave_id != 0xff) + Uniel на одной шине.
Доработка драйвера для поддержки новых устройств
В качестве отправной точки смотрите статью Драйвер wb-mqtt-serial:Примеры написания шаблонов, для дальнейшей поддержки свяжитесь с нами.
Конфигурирование и запуск драйвера
Конфигурация драйвера задаётся в файле /etc/wb-mqtt-serial.conf
. Если такой файл создан, драйвер запускается при загрузке контроллера автоматически. Также драйвером можно управлять в ручном режиме из консоли:
service wb-mqtt-serial stop #остановить драйвер
service wb-mqtt-serial start #запустить драйвер
service wb-mqtt-serial restart #перезапустить драйвер
wb-mqtt-serial -c /etc/wb-mqtt-serial.conf -d #запустить драйвер в принудительном отладочном режиме с указанием пути к конфигурационному файлу
Конфигурационный файл драйвера
Для работы драйвера нужно отредактировать файл /etc/wb-mqtt-serial.conf
. Обычный пользователь может воспользоваться способом RS-485:Настройка через веб-интерфейс, который тоже приводит к правильному заполнению файла конфигурации. Однако отредактировать файл можно и вручную, для этого:
- Ознакомьтесь с инструкцией Просмотр файлов контроллера с компьютера
- Файл
/etc/wb-mqtt-serial.conf
имеет структуру порты (ports) -> устройства (devices): в файле есть описания физических портов контроллера, а внутри них - список устройств, которые подключены к этому порту.- Для каждого порта указываются настройки (скорость, чётность и т.п.), а также протокол (Modbus, RTU, etc.)
- Для каждого устройства обязательно указывается его уникальный адрес на шине - slave_id. Также можно указать другие необязательные параметры - смотрите полное описание формата в описании драйвера на нашем Github.
- Впишите конфигурацию для портов и подключённых устройств в файл, используя примеры ниже.
- Перезагрузите устройство ИЛИ выполните из консоли команду
service wb-mqtt-serial restart
- Она перезапустит драйвер, и подключённое устройство появится в веб-интерфейсе.
- Если устройство не появилось, выполните команду или откройте файл
tail /var/log/messages
/var/log/messages
и промотайте его до конца. Если там будет строчка такого типа:May 6 17:50:58 wirenboard user.notice modbus: FATAL: Error parsing config file: Failed to parse JSON: * Line 15, Column 17
- - ищите ошибку в 15-й строке конфигурационного файла.
Пример конфигурации для модуля реле WB-MRM2, подключённого к изолированному порту (RS-485-ISO) Wiren Board 4
{
"ports": [
{
"path" : "/dev/ttyNSC0", //псевдофайл, соответствующий порту
"baud_rate": 9600, //скорость порта, 9600 почти для всех устройств, но проверьте документацию к ним
"parity": "N", //четность
"data_bits": 8, //битов данных в посылке
"stop_bits": 2, //количество стоп-битов. Чётность, количество битов и стоп-битов тоже редко меняются
"poll_interval": 10, //интервал опроса устройств на порту в миллисекундах
"devices" : [
{
"device_type" : "WB-MRM2", //тип устройства, распознаваемый драйвером
"slave_id": 25 //адрес устройства
}
]
}
]
}
Полный список поддерживаемых типов устройств см. в статье Поддерживаемые устройства, а также здесь.
Пример конфигурационного файла для нескольких подключённых устройств
// Configuration options
{
"debug": false,
"ports": [
{
"path" : "/dev/ttyNSC1",
"baud_rate": 9600,
"parity": "N",
"data_bits": 8,
"stop_bits": 2,
"poll_interval": 0,
"enabled": true,
"devices" : [
{
"name": "DRB88",
"id": "drb88",
"enabled": true,
"slave_id": "0x23",
"device_type" : "DRB88"
},
{
"slave_id": "0x26",
"device_type" : "MSU24"
},
{
"slave_id": "0x31",
"device_type" : "MSU34"
},
{
"slave_id": "0x04",
"device_type" : "LC-103"
},
{
"device_type" : "DDL24",
"slave_id" : "0x20"
},
{
"enabled": true,
"slave_id": "0x06",
"device_type" : "WB-MRM2"
},
{
"slave_id" : 16,
"device_type" : "WB-MRGB"
}
]
},
{
"path" : "/dev/ttyNSC0",
"type": "uniel",
"poll_interval": 10,
"enabled": true,
"devices" : [
{
"device_type" : "UCH-M141RC",
"slave_id": 1
}
]
}
]
}
Включение отладки через веб-интерфейс
Заходим в веб-интерфейс Configs - Serial Device Driver Configuration
Ставим галочку Enable debug logging
После нажатия кнопки Save В файл /var/log/messages будут записываться отправленные и принятые пакеты Modbus.
Не забудьте отключить отладку. Иначе логи займут все доступное место.