Wiren Board Web Interface: различия между версиями

Материал из Wiren Board
(не показано 115 промежуточных версий 3 участников)
Строка 1: Строка 1:
{{DISPLAYTITLE: Веб-интерфейс Wiren Board}}
<languages/><translate>
[[Файл:Web-Home-2.0.png|thumb|700 px|Главная страница веб-интерфейса]]
{{DISPLAYTITLE: Веб-интерфейс контроллеров Wiren Board}}
== Возможности ==
== Общая информация == <!--T:1-->
Контроллер Wiren Board имеет встроенный веб-интерфейс.
{{Anchor|features}}
Через интерфейс можно:
В контроллерах Wiren Board есть встроенный веб-интерфейс, который позволяет выполнить большинство задач по настройке контроллера, встроенного ПО и подключённых устройств. Исходный код открыт и доступен в [https://github.com/wirenboard/ нашем репозитории].
*следить за состоянием контроллера и подключённых устройств и управлять ими;
*подключать устройства к контроллеру;
*настраивать контроллер и обновлять его ПО;
*писать правила на встроенном движке;
*настраивать SMS и email-уведомления;
*смотреть на графике историю значений (например, температуры).


Веб-интерфейс работает непосредственно на Wiren Board. В качестве веб-сервера работает [http://nginx.org nginx], сайт взаимодействует с MQTT через [http://en.wikipedia.org/wiki/WebSocket WebSocket].
<!--T:2-->
В качестве веб-сервера работает [http://nginx.org nginx], сайт взаимодействует с MQTT через [http://en.wikipedia.org/wiki/WebSocket WebSocket].


Ниже дано описание версии 2.0. Про предыдущую версию можно найти на странице [[Веб-интерфейс_Wiren_Board_1.0| Веб-интерфейс Wiren Board 1.0]].
<!--T:3-->
[https://wirenboard.com/ru/pages/wb-software/ Обзор возможностей веб-интерфейса контроллеров Wiren Board].


== Как зайти в веб-интерфейс ==  
== Как зайти в веб-интерфейс == <!--T:4-->
{{Anchor|how-to-enter}}
{{Wbincludes:How to enter}}
{{Wbincludes:How to enter}}


== Работа с веб-интерфейсом ==  
== Смена уровня доступа == <!--T:5-->
[[File:Web-Acess_Level-2.0.png|thumb|center|600 px|Выбор уровня доступа]]
{{Anchor|change-access-level}}
{{Wbincludes:WebUI Change Access Level}}


Для начала работы с веб-интерфейсом выберите уровень доступа. Для этого на вкладке '''Settings -> Change access level -> Acess Level''' выберите один из пунктов '''User, Operator''' или '''Administrator'''.  
== Настройка подключения к MQTT и выбор языка == <!--T:6-->
Уровни ограничивают доступ к функционалу веб-интерфейса: например, пользователь '''User''' может просматривать только настроенные виджеты, их редактирование и изменение настроек контроллера недоступно. Пользователь '''Operator''' получает доступ к контролам устройств, управляемых контроллером, может добавлять виджеты в панели (dashboards) (см. далее). Пользователь '''Administrator''' обладает всеми правами. Изменение текущего уровня доступа может быть изменено любым пользователем и предназначено больше для защиты от неверных действий, чем для разграничения прав.  
{{Anchor|webui}}
[[Image: Web-Configs-2.0 webui.png |300px|thumb|right| Настройки веб-интерфейса ]]
В разделе '''Настройки''' → '''Веб-интерфейс''' можно настроить подключение к MQTT-брокеру, выбрать панель для домашней страницы и сменить язык веб-интерфейса.


В дальнейшем изложении мы предполагаем, что все действия выполняются пользователем '''Administrator'''.  
<!--T:7-->
Веб-интерфейс не поддерживает авторизацию пользователя, но вы можете настроить http-авторизацию сервера nginx. Подробные инструкции смотрите в статье [[WebUI_Password| Защита веб-интерфейса контроллера паролем]].


Чтобы получить уровень доступа '''Administrator''', на вкладке '''Access Level''' выберите опцию '''Administrator''', подтвердите выбор, установив флажок в поле '''"I take full responsibility for my actions"''', и нажмите кнопку '''Apply''' (как показано на рисунке "Выбор уровня доступа").
== Список устройств == <!--T:8-->
{{Anchor|devices}}
На странице '''Устройства''' находятся виртуальные представления физически подключённых к контроллеру устройств или виртуальных устройств, созданных скриптами [[wb-rules]].  


== Разделы интерфейса ==
<!--T:9-->
Каждое устройства представлено карточкой, которая содержит каналы устройства — контролы. Если нажать на название контрола, то вы получите путь вида <code>device/control</code>, который можно использовать при написании скриптов на wb-rules.


=== Домашняя страница ===
<!--T:10-->
{{Anchor|home}}
Не используйте эту страницу для управления системой автоматизацией, для этого есть панели.
На домашнюю страницу можно вывести один из текстовых дашбордов, которые могут содержать показания датчиков, элементы управления и т.п. Дашборд, который нужно показывать на этой странице указывается в настройках веб-интерфейса.
[[File:Web-Home-2.0.png|thumb|center|500px|Домашняя страница]]


=== Панели ===  
<!--T:11-->
<gallery mode="packed" heights="150px">
Image: Web-Devices-2.0.png | Список устройств, подключённых к контроллеру
Image: Web-Devices-Delete-Device-2.0.png | Удаление карточки устройства
</gallery>
 
== Интерактивные панели и виджеты == <!--T:12-->
{{Anchor|dashboards-and-widgets}}
=== Панели ===
{{Anchor|dashboards}}
{{Anchor|dashboards}}
Каналы различных устройств можно объединять в виджеты, из которых потом создаются текстовые панели. Например, можно сделать один виджет «Климат», в котором будут: температура, влажность, переключатели управления вентиляцией, обогревом и кондиционером.
Вы можете создавать текстовые и графические SVG-панели для отображения данных и управления системой автоматизации.


Также веб-интерфейс позволяет создавать интерактивные [[SVG-Dashboards | интерактивные графические SVG-панели]], которые можно вывести на планшет и использовать как пульт управления автоматизацией.
<!--T:13-->
Текстовая панель состоит из виджетов, а графическая — из фонового изображения с привязками к MQTT-каналам контроллера. [[SVG-Dashboards | Как сделать SVG-панель]].


<!--T:41-->
<gallery mode="packed" heights="150px">
<gallery mode="packed" heights="150px">
Image: Web-Dashboards-2.0.png | Список панелей
Image: Web-Dashboards-2.0.png | Список панелей
Строка 47: Строка 59:
</gallery>
</gallery>


=== Устройства ===  
=== Виджеты === <!--T:16-->
{{Anchor|devices}}
{{Anchor|widgets}}
На странице «Устройства» находятся виртуальные представления физически подключённых к контроллеру устройств или виртуальных устройств, созданных скриптами [[wb-rules]].  
С помощью виджетов удобно объединять контролы разных устройств по смыслу, или местонахождению. Например, можно сделать виджет для управления освещением в спальне, или виджет климата в магазине. Виджеты группируются в панели, один виджет может быть добавлен в несколько панелей.
 
<!--T:17-->
Создавать виджеты можно в разделе '''Виджеты''', или прямо из панели. Есть визуальный конструктор и редактор JSON.
 
<!--T:18-->
<gallery mode="packed" heights="150px">
Image: webui-widgets.png | Список виджетов
Image: widget-create-1.png | Создание нового виджета из панели
Image: widget-create-2.png | Конструктор виджета
Image: widget-create-2.2.png | Вид JSON
Image: widget-create-3.png | Готовый виджет
Image: widget-create-4.png | Кнопки редактирования
</gallery>
 
== Полноэкранный и HMI режимы ==
 
<!--T:43-->
{{Anchor|fullscreen-and-hmi}}
{{SupportedSinceRelease
| release = wb-2210
|content=
В обычном режиме в веб-интерфейсе много ненужных в повседневной работе пунктов меню, а верхняя панель и заголовок браузера отъедают много места по вертикали.
 
Мы добавили несколько режимов, которые позволят изменить компоновку веб-интерфейса в зависимости от задач.
 
=== Полноэкранный режим ===
Режим позволяет оперативно переключаться между видами с помощью кнопки. Удобно использовать, например, при просмотре панелей с мобильного телефона или при создании дашбордов.
 
В этом режиме остаётся ''список панелей'' и вкладка ''История'', а верхняя панель веб-интерфейса скрывается, экономя место на экране. Режим удобно использовать, если у вас большая и сложная система с несколькими дашбордами и там нужна аналитика исторических данных.
 
Чтобы перейти в полноэкранный режим, откройте любую панель и нажмите справа вверху кнопку '''Открыть окно в полноэкранном виде'''.


Каждое устройства представлено карточкой, которая содержит каналы устройства — контролы. Если нажать на название контрола, то вы получите путь вида <code>device/control</code>, который можно использовать при написании скриптов на wb-rules.
Учитывайте, что из-за политики безопасности браузеров скрыть заголовок браузера параметром командной строки невозможно, поэтому запускайте браузер в режиме киоска или используйте специальную сборку, читайте об этом ниже.


Не используйте эту страницу для управления системой автоматизацией, для этого есть панели.
Чтобы скрыть заголовок браузера автоматически при старте, запустите его в режиме «Киоск»: [[#kiosk-mode|Переключение браузера в режим киоска]].


<gallery mode="packed" heights="150px">
<gallery mode="packed" heights="150px" caption="Полноэкранный режим">
Image: Web-Devices-2.0.png | Список устройств, подключённых к контроллеру
Image: WebUI Fullscreen Button.png | Компьютер
Image: Web-Devices-Delete-Device-2.0.png | Удаление карточки устройства
Image: WebUI Fullscreen.png | Компьютер, во весь экран
Image: WebUI Fullscreen Mobile off.png | Телефон
Image: WebUI Fullscreen Mobile on.png | Телефон, во весь экран
</gallery>
</gallery>


=== Виджеты ===  
=== Рабочее место оператора ===
{{Anchor|widgets}}
[[Image: WebUI Workplace Mode.png |300px|thumb|right| Рабочее место оператора, параметр <code>?fullscreen</code> ]]
С помощью виджетов удобно объединять контролы разных устройств по смыслу, или местонахождению. Например, можно сделать виджет для управление освещением в спальне, или виджет климата в магазине.
Режим похож на полноэкранный, но в при его активации нет кнопки выхода из режима. Это позволяет в комбинации с [[#kiosk-mode|режимом браузера «Киоск»]] сделать рабочее место оператора, из которого он не сможет выйти в другие приложения или получить доступ к адресной строке и отключить режим.
 
Чтобы открыть панели в этом режиме, добавьте в адресную строку параметр <code>?fullscreen</code>:
<syntaxhighlight lang="ini">
# Для текстовой панели
http://192.168.2.108/#!/dashboards/dashboard1?fullscreen
 
# Для svg-панели
http://192.168.2.108/#!/dashboards/svg/view/dashboard3?fullscreen
</syntaxhighlight>
 
=== Режим HMI ===
Если вы используете для управления системой автоматизации планшет или сенсорный экран и вам не нужны левое меню и верхняя панель со статусом подключения, то вы можете их убрать, включив режим HMI.
 
Чтобы открыть панель в режиме HMI, добавьте в адресную строку параметр <code>?hmi</code>. Примеры, где ''dashboard1'' — ID текстовой панели, а ''dashboard3'' — svg:
<syntaxhighlight lang="ini">
# Для текстовой панели
http://192.168.2.108/#!/dashboards/dashboard1?hmi
 
# Для svg-панели
http://192.168.2.108/#!/dashboards/svg/view/dashboard3?hmi
</syntaxhighlight>
 
Иногда надо сменить фон панели, сделать это можно с помощью параметра <code>hmicolor=%23abcdef</code>. Пример ниже сделает фон панели светло-синим, где <code>%23abcdef</code> — код цвета в шестнадцатеричном виде <code>#abcdef</code>:
<syntaxhighlight lang="ini">
# Для текстовой панели
http://192.168.2.108/#!/dashboards/dashboard1?hmi&hmicolor=%23abcdef
 
# Для svg-панели
http://192.168.2.108/#!/dashboards/svg/view/dashboard3?hmi&hmicolor=%23abcdef
</syntaxhighlight>


Проще всего виджеты добавлять сразу на панель управления кнопкой «Добавить виджет», а потом воспользоваться конструктором или описать виджет в формате JSON.
Чтобы скрыть заголовок браузера автоматически при старте, запустите его в режиме «Киоск»: [[#kiosk-mode|Переключение браузера в режим киоска]].


<gallery mode="packed" heights="100px">
<gallery mode="packed" heights="150px" caption="Режим HMI">
Image: widget-create-1.png | Добавление виджета на панель
Image: WebUI HMI.png | Без параметров
Image: widget-create-2.png | Конструктор виджета
Image: WebUI HMI hmi.png | Параметр <code>?hmi</code>
Image: widget-create-2.2.png | Вид JSON
Image: WebUI HMI hmi_hmicolor.png | Параметры <code>?hmi&hmicolor=%23abcdef</code>
Image: widget-create-3.png | Готовый виджет
Image: WebUI SVG.png | Без параметров
Image: widget-create-4.png | Кнопки редактирования
Image: WebUI SVG HMI hmi.png | Параметр <code>?hmi</code>
Image: WebUI SVG HMI mode.png | Параметры <code>?hmi&hmicolor=%231a1a1a</code>
</gallery>
</gallery>


=== История ===
=== Переключение браузера в режим киоска ===
{{Anchor|kiosk-mode}}
Режим киоска браузера аналогичен режиму, который включается при нажатии на кнопку F11, с той лишь разницей, что из режима киоска пользователь выйти не может.
 
Этот режим удобно использовать при создании рабочего места оператора: добавляете в автозагрузку запуск браузера в режиме киоска у вас получается панель управления системой без возможности свернуть или закрыть окно.
 
Как это сделать:
# Откройте веб-интерфейс контроллера.
# Скопируйте в адресной строке браузера URL.
# Запустите браузер без панелей:
#* На компьютерах и планшетах с ОС Windows/Linux запустите браузер в режиме киоска и передайте ему параметром URL панели, примеры:
#*:<syntaxhighlight lang="bash">
firefox -kiosk 'http://wirenboard-ascmdm6q.local/#!/dashboards/dashboard1'
chromium -kiosk 'http://wirenboard-ascmdm6q.local/#!/dashboards/dashboard1'
</syntaxhighlight>
#* На планшетах с Android используйте специальные версии браузеров, например, [https://www.fully-kiosk.com/ Fully Kiosk Browser].
 
Этот режим можно комбинировать с полноэкранным режимом и режимом HMI, описанными выше.
 
}}
 
== История полученных данных == <!--T:19-->
{{Anchor|history}}
{{Anchor|history}}
[[Image: Web-History-Web-2.0 channel.png  |300px|thumb|right| Кнопка перехода к истории измерений ]]


По умолчанию стандартное ПО контроллера хранит все полученные данные, которые вы можете посмотреть в виде графиков или таблицы. Данные можно выгрузить в csv, для этого нажмите на кнопку под графиком, или воспользуйтесь утилитой [[Wb-mqtt-db-cli|wb-mqtt-db-cli]].
<!--T:20-->
По умолчанию стандартное ПО контроллера хранит все полученные данные, которые вы можете посмотреть в виде графиков или таблицы. Данные можно выгрузить в csv, для этого нажмите на кнопку под графиком, или воспользуйтесь утилитой [https://github.com/wirenboard/wb-mqtt-db-cli wb-mqtt-db-cli].


<!--T:21-->
Для просмотра истории перейдите в раздел '''История''' и выберите нужные каналы, или наведите курсор на канал виджета и нажмите кнопку с изображением гистограммы.
<!--T:22-->
Возможности отображения:
Возможности отображения:
* выбор периода;
* выбор периода;
Строка 84: Строка 187:
* масштабирование;
* масштабирование;
* снятие скриншота;
* снятие скриншота;
* два графика на каждый канал — значения в базе и «дельта».
* курсорные измерения.
* курсорные измерения.


Если вам надо больше возможностей, вы можете настроить автоматический экспорт данных в [[Grafana]].
<!--T:23-->
Если нужно больше возможностей, можете настроить автоматический экспорт данных в [[Grafana]].
=== Как работает история ===
Драйвер wb-mqtt-db записывает значение величины через указанный пользователем интервал времени.
 
На графике для каждого канала есть:
* яркая цветная линия — это средние значения за период;
* и полупрозрачные области того же цвета — это «дельта», которая показывает максимум и минимум значений за период между записями в базу.
 
Например, если сигнал быстро меняется, но нам не нужна информация обо всех значениях — увеличиваем интервал записи и экономим на размере БД. А «Дельта» позволит нам не потерять информацию о максимальных и минимальных значениях величины между записями.
 
Если вас не устраивает «Дельта» и вы хотите писать больше точек в базу, то:
* для сигналов, которые меняются быстро — уменьшите значение в параметре «Минимальный интервал записи значений»;
* для сигналов, которые меняются медленно — настройте параметр «Максимальное количество внеочередных записей».
 
Кроме этого можно настраивать «глубину» хранения истории, для этого есть параметры «Максимальное количество записей на канал» и «Максимальное количество записей на группу». Работает это так:
# Группируете каналы по группам. По умолчанию создана группа ''all'', куда включены все существующие mqtt-каналы по маске <code>+/+</code>.
# Далее настраиваете параметр «Максимальное количество записей на канал» для каждого канала.
# И, чтобы не было сюрпризов, вроде заполненной памяти контроллера, ограничиваете «Максимальное количество записей на группу».
 
Значения для построения графиков получаются следующим образом:
*В БД записываются средние, минимальные и максимальные значения за период между записями в базу.
*Далее выбранный для отображения временной интервал разбивается на участки, количество которых зависит от разрешения экрана. Значения из БД группируются по этим интервалам.
*Если в интервал попадает несколько значений из БД, то для каждого интервала рассчитывается среднее.


<gallery mode="packed" heights="100px">
 
<!--T:24-->
<gallery mode="packed" heights="100px" caption="Примеры скриншотов">
Image: Web-History-Web-2.0.png | График
Image: Web-History-Web-2.0.png | График
Image: Web-History-Web-2.0 1.png | Табличное представление
Image: Web-History-Web-2.0 1.png | Табличное представление
Строка 95: Строка 224:
</gallery>
</gallery>


=== Редактор скриптов ===  
== Скрипты автоматизации == <!--T:25-->
{{Anchor|wb-rules-editor}}
{{Anchor|rules}}


<!--T:26-->
В веб-интерфейсе контроллера есть редактор скриптов [[wb-rules]], который позволяет создавать, редактировать и удалять правила. Если в скрипте есть ошибки, то редактор сообщит вам об этом и укажет место в скрипте.
В веб-интерфейсе контроллера есть редактор скриптов [[wb-rules]], который позволяет создавать, редактировать и удалять правила. Если в скрипте есть ошибки, то редактор сообщит вам об этом и укажет место в скрипте.


<!--T:27-->
Редактор доступен в разделе '''Правила''', используется CodeMirror, горячие клавиши:
{{SupportedSinceRelease
| release = wb-2307
|content=
<pre>
Ctrl + D — множественное редактирование
Ctrl + / — закомментировать / раскомментировать строки
Ctrl + [ — убрать отступ
Ctrl + ] — добавить отступ
Ctrl + C — копировать в буфер обмена
Ctrl + V — вставить из буфера обмена
Ctrl + Z — отмена последнего действия
Ctrl + Shift + Z — повторить последнее отменённое действие
Ctrl + U — повторить последнее выделение
Ctrl + I — выделить всё между парными скобками, если повторить — выделяется уровень выше
Ctrl + пробел — показать подсказку ввода
Ctrl + Shift + Left — выделить слово слева
Ctrl + Shift + Right — выделить слово справа
Ctrl + Shift + K — удалить строку
Ctrl + Backspace — удалить часть слова до курсора
Ctrl + Delete — удалить часть слова после курсора
</pre>
}}
<!--T:28-->
<gallery mode="packed" heights="150px">
<gallery mode="packed" heights="150px">
Image: Web-Rules-2.0.png | Редактор скриптов
Image: Web-Rules-2.0.png | Редактор скриптов
Строка 105: Строка 261:
</gallery>
</gallery>


=== Настройки ===  
== Настройка контроллера и подключённых устройств == <!--T:29-->
{{Anchor|settings}}
{{Anchor|settings}}
[[Image: Web-Configs-2.0.png |300px|thumb|right| Конфигурационные файлы ]]
Контроллер Wiren Board работает на Linux, поэтому почти все настройки хранятся в конфигурационных файлах. Файлы можно редактировать через [[SSH]] или с помощью веб-конфигуратора.


В разделе настроек вы сможете:
<!--T:30-->
* настроить контроллер и подключённые к нему устройства и модули: Modbus-устройства, модули расширения, шлюз KNX и т.п;
Список доступных настроек вы найдёте в разделе ''' Настройки''' → '''Конфигурационные файлы'''.
* установить параметры веб-интерфейса: выбрать язык, панель для домашней страницы и настроить подключение к MQTT;
* обновить ПО контроллера и выгрузить диагностический архив;
* посмотреть список MQTT-каналов;
* изменить уровень доступа и посмотреть системный журнал.


<gallery mode="packed" heights="120px">
<!--T:31-->
Image:Web-Configs-2.0.png| Настройки контроллера и подключённых устройств
Например, через веб-интерфейс можно настроить подключённые [[RS-485:Configuration via Web Interface| Modbus-устройства]], шлюзы [[KNX | KNX]] и [[Modbus RTU/TCP Slave]] и другие параметры.
Image:Web-Configs-2.0 webui.png| Выбор языка веб-интерфейса и настройка подключения к MQTT
Image:Web-Configs-2.0 system.png| Обновление прошивки контроллера и выгрузка диагностической информации
Image:Web-Configs-2.0 mqtt.png| MQTT-каналы
Image:Web-Configs-2.0 access.png| Смена уровня доступа
Image:Web-Configs-2.0 logs.png| Просмотр логов
</gallery>


=== Settings -> WebUI (Настройки -> Веб-интерфейс) ===  
== Поиск устройств Wiren Board на шине RS-485 ==  
[[File:Web-Settings_WebUI-2.0.png|center|thumb|600 px|Страница Settings]]
[[Image: Scan-screen.png |300px|thumb|right| Сканирование устройств ]]
В разделе '''Настройки''' → '''Сканирование''' можно получить список всех устройств Wiren Board подключенных к шине RS-485 с их серийными номерами, настройками соединения и версиями прошивок.


На странице '''Web UI''' настраиваются параметры веб-интерфейса и контроллера. Здесь можно:
Возможности функции сканирования:
* Выбрать подключение к MQTT-брокеру (Web-sockets), если используется нелокальный брокер, а, например, облачный сервис
* отображение всех устройств Wiren Board, подключенных к контроллеру,
* При необходимости указать учетные данные на удаленном MQTT-брокере
* обнаружение устройств с одинаковыми адресами на одной шине,
* Указать префикс всех топиков, с которым данные охраняются в облачном сервисе
* обнаружение устройств с разными параметрами связи на одной шине.
* Выбрать панель (Default Dashboard), которая будет отображаться на главной странице (Home)
{{SupportedSinceRelease
| release = wb-2110
|content=
* Выбрать язык веб-интерфейса.
}}


=== Settings -> System (Настройки -> Системные) ===
Благодаря функции сканирования можно собирать шкаф управления не обращая внимания на адреса устройств — все адреса и параметры можно будет получить после сборки и сконфигурировать устройства не отключая от шины.
<div id="system"></div>


[[File:Web-Settings_System-2.0.png|center|thumb|600 px|Страница System]]
== Уведомления о событиях == <!--T:32-->
{{Anchor|alarms}}
В веб-интерфейсе контроллера можно настроить отправку уведомления о событиях по SMS или Email, например, при срабатывании тревоги в модуле [[WB-MWAC Modbus Water Consumption Metering and Leak Monitoring| WB-MWAC]], отправить SMS на заданный номер. [[Notification module | Настройка модуля уведомлений]].


На этой странице можно:
<!--T:33-->
* Обновить прошивку контроллера, предварительно скачав ее на компьютер.
Также вы можете отправлять уведомления в Телеграм, для этого нужно написать небольшой скрипт на wb-rules, [[Rule_Examples#telegram | пример]].
{{SupportedSinceRelease
| release = wb-2110
|content=
* Загрузить архив с диагностической информацией для отправки в техподдержку.
}}


=== Settings -> MQTT Channels (Настройки -> MQTT-каналы) ===
== Обновление прошивки и выгрузка диагностического архива == <!--T:34-->
{{Anchor|mqtt-channels}}
{{Anchor|diagnostic}}
[[File:Web-Settings_MQTT_Channels-2.0.png|center|thumb|600 px|MQTT Channels]]
[[Image: Web-Configs-2.0 system.png |300px|thumb|right| Обновление ПО и выгрузка диагностики ]]
Обновить ПО контроллера без доступа к интернету можно через веб-интерфейс, для этого вам понадобится компьютер и заранее загруженный fit-файл прошивки. Подробнее про обновление ПО контроллера читайте на странице [[Wiren_Board_Software| Программное обеспечение Wiren Board]].


'''Settings → MQTT Channels'''. На этой странице приводится справочная информация о всех MQTT-топиках, полученных веб-интерфейсом контроллера, а также статус их получения ('''ОК''' или '''ERR''' в последнем столбце).
<!--T:35-->
Если в работе контроллера возникли ошибки, то при обращении в техническую поддержку рекомендуем выгрузить диагностический архив — это поможет нам быстрее разобраться в проблеме.  


=== Settings -> Change access level (Настройки -> Права доступа) ===
Выгрузить диагностический архив можно двумя способами:
[[Файл:WebUI 2.0 — changing user rights.png|300px|thumb|right|Web UI 2.0 — смена уровня доступа текущего пользователя]]
* Перейдите в веб-интерфейсе на вкладку '''Настройки''' → '''Система''' и найдите раздел '''Сбор данных для диагностики'''. Сформируйте, а затем скачайте архив.
* Подключитесь к контроллеру по [[SSH]] и введите команду:
*:<pre>wb-diag-collect diag</pre>
*: архив будет сохранён в текущую папку, обычно это /root — оттуда его можно [[View_controller_files_from_your_computer|сохранить на компьютер]].


Уровни доступа призваны защитить пользователя от ошибок при регулярной работе с контроллером. Важно понимать, что это не полноценное разграничение прав, а способ защитить себя от необдуманных действий. Новых пользователей создавать нельзя.
== Просмотр MQTT-каналов и системного журнала == <!--T:36-->
{{Anchor|mqtt-channels}}
Список MQTT-каналов пригодится при диагностике неисправностей, или при настройке интеграции со сторонним ПО, например, [[Rapid SCADA]] или [[Home Assistant]]. Список доступен в разделе '''Настройки''' → '''MQTT-каналы'''. Описание структуры топиков и общие рекомендации, смотрите в статье [[MQTT]].


Доступны следующие уровни:
<!--T:37-->
* User — дашборды, виджеты, история, базовые настройки.
Системный журнал ОС Linux можно посмотреть с помощью утилиты [[journalctl]] или в веб-интерфейсе контроллера в разделе '''Настройки''' → '''Системный журнал'''.
* Operator — права уровня User и раздел Devices.
* Administrator — полный доступ ко всем функциям.


Чтобы изменить уровень доступа к настройкам веб-интерфейса:
<!--T:38-->
* Зайдите в веб-интерфейс.
<gallery mode="packed" heights="120px">
* Перейдите в раздел '''Settings''' и выберите пункт '''Change access level'''. Установите нужное значение и нажмите кнопку '''Apply'''.
Image:Web-Configs-2.0 mqtt.png| MQTT-каналы
Image:Web-Configs-2.0 logs.png| Системный журнал
</gallery>


<div id="logs"></div>
== Управление с телефона == <!--T:45-->
=== Settings -> Logs (Настройки -> Логи) ===
{{Anchor|mobile}}
[[Image: WebUI 2.0 — logs.png |600px|thumb|none| Просмотр лог-файлов контроллера ]]
Веб-интерфейс адаптируется под размер экрана, поэтому управлять системой автоматизации можно с мобильного устройства или планшета.  
Чтобы открыть инструмент, перейдите '''Settings''' → '''Logs'''.


После выбора параметров, нажмите '''Load''' для запроса данных из системного журнала.
<!--T:46-->
Альтернативой может быть использование сторонних приложений: [[MQTT_Dash]], [[Home Assistant]], [[SberDevices|Салют! Умный дом]] и других, полный список смотрите в [[Supported_devices |таблице поддерживаемых устройств и программ]].


Загруженные сообщения можно сохранить в файл, для этого нажмите кнопку '''Save loaded log to file''' и укажите куда сохранить. Строки из системного журнала подгружаются во время прокрутки списка сообщений, поэтому сперва прокрутите список до нужного места, а потом сохраняйте вывод в файл.
<!--T:47-->
 
<gallery mode="packed" heights="350px" caption="Веб-интерфейс контроллера в телефоне">
Для отправки сообщений системного журнала в техподдержку удобно использовать [[#system | выгрузку диагностической информации]].
Image: web-ui mobile 1.png | Список устройств
 
Image: web-ui mobile 2.png | Боковая панель
== Стандартные задачи, решаемые через веб-интерфейс ==
Image: web-ui mobile 5.png | SVG-панель
 
Image: web-ui mobile 3.png | Просмотр системного журнала
=== Подключить устройство RS-485 Modbus и создать кнопки управления на главной панели ===
Image: web-ui mobile 4.png | Настройка Modbus-устройства
[[RS-485:Настройка через веб-интерфейс]]
</gallery>
 
===Обновить прошивку контроллера===
[[Wiren_Board_Firmware_Update#Обновление через веб-интерфейс|Обновление прошивки через веб-интерфейс]]
 
== Облачный интерфейс ==  
 
Веб-интерфейс Wiren Board можно разместить не только на самом контроллере, но и на специальном сервере. Тогда на интерфейс можно будет заходить, используя всегда один и тот же IP-адрес.
 
Чтобы контроллер начал работать с веб-интерфейсом, размещённым на сервере, нужно внести некоторые изменения в конфигурацию контроллера.
 
Такой вариант удобен, если ваш контроллер находится за роутером и не имеет глобального IP-адреса, или если он подключён по GPRS - тогда он тоже, скорее всего, не имеет глобального IP, да ещё и работа с удалённым веб-интерфейсом израсходует слишком много трафика.
 
'''Пока что такой вариант доступен только корпоративным клиентам по запросу.'''
 
== Настройка авторизованного доступа к веб-интерфейсу контроллера ==
В статье [[Защита_паролем|Защита паролем]] приводятся краткие инструкции по перенастройке контроллера, обеспечивающие авторизованный доступ к веб-интерфейсу контроллера.
 
== Основные отличия версии 2.x от 1.0 ==


* Каждый виджет может содержать произвольное число каналов, в виджете каналы можно переименовывать
== Предыдущая версия == <!--T:39-->
* Отдельные устройства теперь автоматически сворачиваются в виде плиток, если не помещаются на экране. Плитки можно развернуть или свернуть
* [[Wiren_Board_Web_Interface 1.0| Веб-интерфейс Wiren Board 1.0]], заменён на 2.0 в начале 2021 года.
* Появились уровни доступа к интерфейсу (пользователь, оператор, администратор). Текущий уровень доступа отображается в правом верхнем углу интерфейса, рядом со значком состояния подключения
</translate>
* Улучшенный интерфейс для мобильных устройств
* По клику на канал или значение название канала или его значение копируются в буфер обмена
* Историю значений можно посмотреть, нажав на кнопку, появляющуюся рядом со значением при наведении
* Историю значений можно скачивать в виде текстового файла
* Исторические данные загружаются постепенно; возможно сравнивать значения нескольких каналов
* Удаление лишних MQTT-топиков из интерфейса
* Все настройки отображения теперь хранятся в конфиг-файле /etc/wb-ui.conf в формате JSON. Теперь их можно редактировать и генерировать из сторонних программ и очень просто копировать с одного контроллера на другой
* Отсутствуют "Комнаты"
* Сохранение конфигурации интерфейса при обновлении предыдущей версии веб-интерфейса.

Версия 17:05, 17 апреля 2024

Другие языки:

Общая информация

В контроллерах Wiren Board есть встроенный веб-интерфейс, который позволяет выполнить большинство задач по настройке контроллера, встроенного ПО и подключённых устройств. Исходный код открыт и доступен в нашем репозитории.

В качестве веб-сервера работает nginx, сайт взаимодействует с MQTT через WebSocket.

Обзор возможностей веб-интерфейса контроллеров Wiren Board.

Как зайти в веб-интерфейс

Чтобы зайти в веб-интерфейс контроллера Wiren Board, подключитесь к контроллеру через Wi-Fi или Ethernet и введите в адресную строку браузера IP-адрес контроллера.

Если вы находитесь в одной сети с контроллером и используете компьютер с Linux, Windows 10 и выше или macOS, или любое устройство Apple, то можно использовать mDNS. Вместо IP-адреса введите в адресную строку http://wirenboard-XXXXXXXX.local, где ХХХХХХХХ — серийный номер контроллера.

Также доступ можно получить через Wiren Board Cloud, если контроллер к нему подключен.

Смена уровня доступа

Уровень «Администратор»

Для изменения настроек контроллера вам нужен уровень доступа Администратор, который можно выставить в разделе Настройки → Права доступа.

После завершения настроек рекомендуем поставить уровень доступа Пользователь или Оператор — это поможет не совершить случайных ошибок при ежедневной работе с веб-интерфейсом.

Настройка подключения к MQTT и выбор языка

Настройки веб-интерфейса

В разделе Настройки → Веб-интерфейс можно настроить подключение к MQTT-брокеру, выбрать панель для домашней страницы и сменить язык веб-интерфейса.

Веб-интерфейс не поддерживает авторизацию пользователя, но вы можете настроить http-авторизацию сервера nginx. Подробные инструкции смотрите в статье Защита веб-интерфейса контроллера паролем.

Список устройств

На странице Устройства находятся виртуальные представления физически подключённых к контроллеру устройств или виртуальных устройств, созданных скриптами wb-rules.

Каждое устройства представлено карточкой, которая содержит каналы устройства — контролы. Если нажать на название контрола, то вы получите путь вида device/control, который можно использовать при написании скриптов на wb-rules.

Не используйте эту страницу для управления системой автоматизацией, для этого есть панели.

  • Список устройств, подключённых к контроллеру

  • Удаление карточки устройства

Интерактивные панели и виджеты

Панели

Вы можете создавать текстовые и графические SVG-панели для отображения данных и управления системой автоматизации.

Текстовая панель состоит из виджетов, а графическая — из фонового изображения с привязками к MQTT-каналам контроллера. Как сделать SVG-панель.

  • Список панелей

  • Текстовая панель

  • SVG-панель

Виджеты

С помощью виджетов удобно объединять контролы разных устройств по смыслу, или местонахождению. Например, можно сделать виджет для управления освещением в спальне, или виджет климата в магазине. Виджеты группируются в панели, один виджет может быть добавлен в несколько панелей.

Создавать виджеты можно в разделе Виджеты, или прямо из панели. Есть визуальный конструктор и редактор JSON.

  • Список виджетов

  • Создание нового виджета из панели

  • Конструктор виджета

  • Вид JSON

  • Готовый виджет

  • Кнопки редактирования

Полноэкранный и HMI режимы

В обычном режиме в веб-интерфейсе много ненужных в повседневной работе пунктов меню, а верхняя панель и заголовок браузера отъедают много места по вертикали.

Мы добавили несколько режимов, которые позволят изменить компоновку веб-интерфейса в зависимости от задач.

Полноэкранный режим

Режим позволяет оперативно переключаться между видами с помощью кнопки. Удобно использовать, например, при просмотре панелей с мобильного телефона или при создании дашбордов.

В этом режиме остаётся список панелей и вкладка История, а верхняя панель веб-интерфейса скрывается, экономя место на экране. Режим удобно использовать, если у вас большая и сложная система с несколькими дашбордами и там нужна аналитика исторических данных.

Чтобы перейти в полноэкранный режим, откройте любую панель и нажмите справа вверху кнопку Открыть окно в полноэкранном виде.

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

Чтобы скрыть заголовок браузера автоматически при старте, запустите его в режиме «Киоск»: Переключение браузера в режим киоска.

  • Полноэкранный режим

  • Компьютер

  • Компьютер, во весь экран

  • Телефон

  • Телефон, во весь экран

Рабочее место оператора

Рабочее место оператора, параметр ?fullscreen

Режим похож на полноэкранный, но в при его активации нет кнопки выхода из режима. Это позволяет в комбинации с режимом браузера «Киоск» сделать рабочее место оператора, из которого он не сможет выйти в другие приложения или получить доступ к адресной строке и отключить режим.

Чтобы открыть панели в этом режиме, добавьте в адресную строку параметр ?fullscreen: 

# Для текстовой панели
http://192.168.2.108/#!/dashboards/dashboard1?fullscreen

# Для svg-панели
http://192.168.2.108/#!/dashboards/svg/view/dashboard3?fullscreen

Режим HMI

Если вы используете для управления системой автоматизации планшет или сенсорный экран и вам не нужны левое меню и верхняя панель со статусом подключения, то вы можете их убрать, включив режим HMI.

Чтобы открыть панель в режиме HMI, добавьте в адресную строку параметр ?hmi. Примеры, где dashboard1 — ID текстовой панели, а dashboard3 — svg: 

# Для текстовой панели
http://192.168.2.108/#!/dashboards/dashboard1?hmi

# Для svg-панели
http://192.168.2.108/#!/dashboards/svg/view/dashboard3?hmi

Иногда надо сменить фон панели, сделать это можно с помощью параметра hmicolor=%23abcdef. Пример ниже сделает фон панели светло-синим, где %23abcdef — код цвета в шестнадцатеричном виде #abcdef: 

# Для текстовой панели
http://192.168.2.108/#!/dashboards/dashboard1?hmi&hmicolor=%23abcdef

# Для svg-панели
http://192.168.2.108/#!/dashboards/svg/view/dashboard3?hmi&hmicolor=%23abcdef

Чтобы скрыть заголовок браузера автоматически при старте, запустите его в режиме «Киоск»: Переключение браузера в режим киоска.

  • Режим HMI

  • Без параметров

  • Параметр ?hmi

  • Параметры ?hmi&hmicolor=%23abcdef

  • Без параметров

  • Параметр ?hmi

  • Параметры ?hmi&hmicolor=%231a1a1a

Переключение браузера в режим киоска

Режим киоска браузера аналогичен режиму, который включается при нажатии на кнопку F11, с той лишь разницей, что из режима киоска пользователь выйти не может.

Этот режим удобно использовать при создании рабочего места оператора: добавляете в автозагрузку запуск браузера в режиме киоска у вас получается панель управления системой без возможности свернуть или закрыть окно.

Как это сделать:

  1. Откройте веб-интерфейс контроллера.
  2. Скопируйте в адресной строке браузера URL.
  3. Запустите браузер без панелей:
    • На компьютерах и планшетах с ОС Windows/Linux запустите браузер в режиме киоска и передайте ему параметром URL панели, примеры: 
      firefox -kiosk 'http://wirenboard-ascmdm6q.local/#!/dashboards/dashboard1' 
chromium -kiosk 'http://wirenboard-ascmdm6q.local/#!/dashboards/dashboard1'
    • На планшетах с Android используйте специальные версии браузеров, например, Fully Kiosk Browser.

Этот режим можно комбинировать с полноэкранным режимом и режимом HMI, описанными выше.

История полученных данных

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

По умолчанию стандартное ПО контроллера хранит все полученные данные, которые вы можете посмотреть в виде графиков или таблицы. Данные можно выгрузить в csv, для этого нажмите на кнопку под графиком, или воспользуйтесь утилитой wb-mqtt-db-cli.

Для просмотра истории перейдите в раздел История и выберите нужные каналы, или наведите курсор на канал виджета и нажмите кнопку с изображением гистограммы.

Возможности отображения:

  • выбор периода;
  • одновременный просмотр нескольких каналов;
  • масштабирование;
  • снятие скриншота;
  • два графика на каждый канал — значения в базе и «дельта».
  • курсорные измерения.

Если нужно больше возможностей, можете настроить автоматический экспорт данных в Grafana.

Как работает история

Драйвер wb-mqtt-db записывает значение величины через указанный пользователем интервал времени.

На графике для каждого канала есть:

  • яркая цветная линия — это средние значения за период;
  • и полупрозрачные области того же цвета — это «дельта», которая показывает максимум и минимум значений за период между записями в базу.

Например, если сигнал быстро меняется, но нам не нужна информация обо всех значениях — увеличиваем интервал записи и экономим на размере БД. А «Дельта» позволит нам не потерять информацию о максимальных и минимальных значениях величины между записями.

Если вас не устраивает «Дельта» и вы хотите писать больше точек в базу, то:

  • для сигналов, которые меняются быстро — уменьшите значение в параметре «Минимальный интервал записи значений»;
  • для сигналов, которые меняются медленно — настройте параметр «Максимальное количество внеочередных записей».

Кроме этого можно настраивать «глубину» хранения истории, для этого есть параметры «Максимальное количество записей на канал» и «Максимальное количество записей на группу». Работает это так:

  1. Группируете каналы по группам. По умолчанию создана группа all, куда включены все существующие mqtt-каналы по маске +/+.
  2. Далее настраиваете параметр «Максимальное количество записей на канал» для каждого канала.
  3. И, чтобы не было сюрпризов, вроде заполненной памяти контроллера, ограничиваете «Максимальное количество записей на группу».

Значения для построения графиков получаются следующим образом:

  • В БД записываются средние, минимальные и максимальные значения за период между записями в базу.
  • Далее выбранный для отображения временной интервал разбивается на участки, количество которых зависит от разрешения экрана. Значения из БД группируются по этим интервалам.
  • Если в интервал попадает несколько значений из БД, то для каждого интервала рассчитывается среднее.


  • Примеры скриншотов

  • График

  • Табличное представление

  • Данные, выгруженные в CSV

  • Настройка хранения истории

Скрипты автоматизации

В веб-интерфейсе контроллера есть редактор скриптов wb-rules, который позволяет создавать, редактировать и удалять правила. Если в скрипте есть ошибки, то редактор сообщит вам об этом и укажет место в скрипте.

Редактор доступен в разделе Правила, используется CodeMirror, горячие клавиши: 

Ctrl + D — множественное редактирование
Ctrl + / — закомментировать / раскомментировать строки
Ctrl + [ — убрать отступ
Ctrl + ] — добавить отступ
Ctrl + C — копировать в буфер обмена
Ctrl + V — вставить из буфера обмена
Ctrl + Z — отмена последнего действия
Ctrl + Shift + Z — повторить последнее отменённое действие
Ctrl + U — повторить последнее выделение
Ctrl + I — выделить всё между парными скобками, если повторить — выделяется уровень выше
Ctrl + пробел — показать подсказку ввода
Ctrl + Shift + Left — выделить слово слева
Ctrl + Shift + Right — выделить слово справа
Ctrl + Shift + K — удалить строку
Ctrl + Backspace — удалить часть слова до курсора
Ctrl + Delete — удалить часть слова после курсора

  • Редактор скриптов

  • Подсветка ошибок

Настройка контроллера и подключённых устройств

Конфигурационные файлы

Контроллер Wiren Board работает на Linux, поэтому почти все настройки хранятся в конфигурационных файлах. Файлы можно редактировать через SSH или с помощью веб-конфигуратора.

Список доступных настроек вы найдёте в разделе Настройки → Конфигурационные файлы.

Например, через веб-интерфейс можно настроить подключённые Modbus-устройства, шлюзы KNX и Modbus RTU/TCP Slave и другие параметры.

Поиск устройств Wiren Board на шине RS-485

Сканирование устройств

В разделе Настройки → Сканирование можно получить список всех устройств Wiren Board подключенных к шине RS-485 с их серийными номерами, настройками соединения и версиями прошивок.

Возможности функции сканирования:

  • отображение всех устройств Wiren Board, подключенных к контроллеру,
  • обнаружение устройств с одинаковыми адресами на одной шине,
  • обнаружение устройств с разными параметрами связи на одной шине.

Благодаря функции сканирования можно собирать шкаф управления не обращая внимания на адреса устройств — все адреса и параметры можно будет получить после сборки и сконфигурировать устройства не отключая от шины.

Уведомления о событиях

В веб-интерфейсе контроллера можно настроить отправку уведомления о событиях по SMS или Email, например, при срабатывании тревоги в модуле WB-MWAC, отправить SMS на заданный номер. Настройка модуля уведомлений.

Также вы можете отправлять уведомления в Телеграм, для этого нужно написать небольшой скрипт на wb-rules, пример.

Обновление прошивки и выгрузка диагностического архива

Обновление ПО и выгрузка диагностики

Обновить ПО контроллера без доступа к интернету можно через веб-интерфейс, для этого вам понадобится компьютер и заранее загруженный fit-файл прошивки. Подробнее про обновление ПО контроллера читайте на странице Программное обеспечение Wiren Board.

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

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

  • Перейдите в веб-интерфейсе на вкладку Настройки → Система и найдите раздел Сбор данных для диагностики. Сформируйте, а затем скачайте архив.
  • Подключитесь к контроллеру по SSH и введите команду: 
    wb-diag-collect diag
    архив будет сохранён в текущую папку, обычно это /root — оттуда его можно сохранить на компьютер.

Просмотр MQTT-каналов и системного журнала

Список MQTT-каналов пригодится при диагностике неисправностей, или при настройке интеграции со сторонним ПО, например, Rapid SCADA или Home Assistant. Список доступен в разделе Настройки → MQTT-каналы. Описание структуры топиков и общие рекомендации, смотрите в статье MQTT.

Системный журнал ОС Linux можно посмотреть с помощью утилиты journalctl или в веб-интерфейсе контроллера в разделе Настройки → Системный журнал.

  • MQTT-каналы

  • Системный журнал

Управление с телефона

Веб-интерфейс адаптируется под размер экрана, поэтому управлять системой автоматизации можно с мобильного устройства или планшета.

Альтернативой может быть использование сторонних приложений: MQTT_Dash, Home Assistant, Салют! Умный дом и других, полный список смотрите в таблице поддерживаемых устройств и программ.

  • Веб-интерфейс контроллера в телефоне

  • Список устройств

  • Боковая панель

  • SVG-панель

  • Просмотр системного журнала

  • Настройка Modbus-устройства

Предыдущая версия

Источник — https://wirenboard.com/wiki/index.php?title=Wiren_Board_Web_Interface&oldid=80436