Просмотр кода страницы Custom-wiren-board-device-templates

{{DISPLAYTITLE:Пользовательские шаблоны устройств Wiren Board}}
Статья описывает пользовательские JSON-шаблоны для системной службы Wiren Board <code>wb-mqtt-serial</code>. Эта служба производителя не является драйвером XIOT: драйвер XIOT — отдельный интеграционный модуль XIOT-PLC. Если вы настраиваете модуль XIOT, начните со статьи [[Driver-setup|Настройка драйверов]].

Готовый файл шаблона с расширением <code>.json</code> скопируйте на контроллер в каталог:

<pre>
/etc/wb-mqtt-serial.conf.d/templates/
</pre>

Не копируйте пользовательский файл в <code>/usr/share/wb-mqtt-serial/templates/</code>. Там находятся штатные шаблоны, которые могут быть заменены при обновлении программного обеспечения контроллера.

== Перед началом ==

Подготовьте:

* готовый файл шаблона с расширением <code>.json</code>, например <code>config-soil-multi-sensor-v2.2.json</code>;
* IP-адрес контроллера;
* имя пользователя <code>root</code> и пароль контроллера;
* параметры связи устройства: Modbus-адрес, скорость, чётность, число бит данных и стоп-битов.

Для подключения к файлам контроллера используется SFTP, порт <code>22</code>.

Подключайтесь по SFTP или SSH только из локальной либо другой доверенной сети. Не публикуйте порт <code>22</code> контроллера в интернет и не передавайте пароль <code>root</code> посторонним.

== Шаг 1. Скопируйте файл через SFTP ==

# Откройте программу для работы с SFTP:
#* Windows — WinSCP;
#* macOS — Cyberduck;
#* Linux — файловый менеджер с поддержкой адресов вида <code>sftp://IP-КОНТРОЛЛЕРА</code>.
# Создайте подключение со следующими параметрами:
#* протокол — '''SFTP''';
#* сервер — IP-адрес контроллера;
#* порт — <code>22</code>;
#* пользователь — <code>root</code>;
#* пароль — пароль контроллера.
# После подключения откройте на контроллере каталог:
#:<pre>
/etc/wb-mqtt-serial.conf.d/templates/
</pre>
# Если каталога <code>templates</code> нет, создайте его.
# Если файл с таким именем уже существует, сначала скачайте его на компьютер как резервную копию.
# Перетащите новый файл <code>.json</code> в открытый каталог контроллера. При обновлении шаблона подтвердите замену существующего файла.

'''Ожидаемый результат:''' файл, например <code>config-soil-multi-sensor-v2.2.json</code>, виден в каталоге <code>/etc/wb-mqtt-serial.conf.d/templates/</code>.

Обычно перезапуск служб после копирования не требуется. Если страница настройки устройств уже была открыта, обновите её.

== Копирование из командной строки ==

Этот способ необязателен. На macOS или Linux тот же файл можно скопировать командой <code>scp</code>. Замените IP-адрес своим:

<pre>
scp config-soil-multi-sensor-v2.2.json root@192.168.1.10:/etc/wb-mqtt-serial.conf.d/templates/
</pre>

Если каталога ещё нет, сначала создайте его:

<pre>
ssh root@192.168.1.10 "mkdir -p /etc/wb-mqtt-serial.conf.d/templates"
</pre>

== Шаг 2. Добавьте устройство в веб-интерфейсе ==

# Откройте веб-интерфейс контроллера Wiren Board.
# Перейдите: '''Настройки → Конфигурационные файлы → Настройка драйвера Serial-устройств'''.
# Нажмите '''Добавить любые устройства вручную'''.
# Выберите порт, к которому подключён датчик.
# В поле '''Тип устройства''' выберите загруженный шаблон. В актуальном интерфейсе пользовательский шаблон отмечен как '''Пользовательский'''.
# Нажмите '''Добавить'''.
# Откройте добавленное устройство и укажите '''Адрес устройства''' — Modbus Slave ID из документации или настроек датчика.
# Нажмите '''Сохранить настройки'''.

Если нужный порт ещё не настроен, выберите его слева, включите порт и задайте скорость, чётность, число бит данных и стоп-битов точно как в документации устройства. Затем сохраните настройки.

Если устройство уже было добавлено раньше и вы только заменили файл шаблона, повторно добавлять устройство не нужно. Откройте его настройки и нажмите '''Сохранить настройки''', чтобы применить новую версию шаблона к опросу.

== Шаг 3. Проверьте устройство ==

# Откройте раздел '''Устройства''' веб-интерфейса.
# Найдите добавленное устройство.
# Убедитесь, что появились каналы из шаблона и значения обновляются.
# Подождите один-два цикла опроса.

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

== Если не получилось ==

* '''Шаблона нет в списке.''' Проверьте, что файл находится именно в <code>/etc/wb-mqtt-serial.conf.d/templates/</code>, его имя заканчивается на <code>.json</code>, затем обновите страницу настройки устройств.
* '''В журнале есть ошибка шаблона.''' Откройте '''Настройки → Системный журнал''', выберите сервис <code>wb-mqtt-serial.service</code>, тип сообщений <code>error</code> и нажмите '''Загрузить'''. В сообщении будет указана строка файла с ошибкой.
* '''Устройство есть, но значений нет.''' Проверьте адрес устройства, параметры порта и подключение RS-485. Они должны совпадать с настройками датчика.
* '''Часть каналов отсутствует.''' Откройте настройки устройства, включите нужные каналы шаблона и снова нажмите '''Сохранить настройки'''.
* '''Новый файл заменён, но изменения не применились.''' Откройте уже добавленное устройство и повторно сохраните настройки.

На старом программном обеспечении контроллера, если шаблон не появился после обновления страницы и сохранения настроек, можно один раз перезапустить драйвер:

<pre>
systemctl restart wb-mqtt-serial
</pre>

Для актуальной версии это запасной, а не обязательный шаг. Перезапуск <code>wb-mqtt-confed</code> не требуется.

== Как обновить шаблон ==

# Скачайте установленный файл на компьютер как резервную копию.
# Скопируйте новый файл в <code>/etc/wb-mqtt-serial.conf.d/templates/</code> с заменой старого.
# Откройте устройство в '''Настройке драйвера Serial-устройств''' и нажмите '''Сохранить настройки'''.
# Проверьте устройство и его каналы в разделе '''Устройства'''.

== Следующий шаг и связанные статьи ==

* [[Ensystec-leak-protect-wiren-board-template|Шаблон Wiren Board Ensystec Leak Protect для XIOT]] — пример готового пользовательского шаблона.
* [[Ensystec-wiren-board-integration|Подключение Ensystec в XIOT через Wirenboard]] — пример его использования в XIOT.

== Источники ==

* [https://wirenboard.com/wiki/Connecting_Third_Party_Devices_to_Wiren_Board Как подключать сторонние Modbus-устройства — Wiren Board]
* [https://wirenboard.com/wiki/View_controller_files_from_your_computer Просмотр и копирование файлов контроллера с компьютера — Wiren Board]
* [https://wirenboard.com/wiki/RS-485:Configuration_via_Web_Interface Настройка устройств RS-485 через веб-интерфейс — Wiren Board]
* [https://github.com/wirenboard/wb-mqtt-serial Описание и пользовательские шаблоны wb-mqtt-serial — GitHub Wiren Board]

[[Категория:Документация XIOT]]
{{DEFAULTSORT:Пользовательские шаблоны устройств Wiren Board}}