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

Материал из Wiren Board
(не показаны 42 промежуточные версии 2 участников)
Строка 1: Строка 1:
<languages/>{{DISPLAYTITLE: Web Interface of Wiren Board Controllers}}
<languages/>{{DISPLAYTITLE: Web Interface of Wiren Board Controllers}}
== General information ==
== General information ==
{{Anchor|features}}
{{Anchors|features}}
Wiren Board controllers have a built-in web interface that allows you to perform most of the tasks for configuring the controller, firmware and connected devices. The source code is open and available in [https://github.com/wirenboard/ our repository].
Wiren Board controllers have a built-in web interface that allows you to perform most of the tasks for configuring the controller, firmware and connected devices. The source code is open and available in [https://github.com/wirenboard/ our repository].


Строка 12: Строка 12:
{{Wbincludes:How to enter}}
{{Wbincludes:How to enter}}


== Change access level ==
== СChange access level ==
{{Anchor|change-access-level}}
{{Anchor|change-access-level}}
{{Wbincludes:WebUI Change Access Level}}
{{Wbincludes:WebUI Change Access Level}}
Строка 24: Строка 24:


== List of devices ==
== List of devices ==
{{Anchor|devices}}
{{Anchors|devices}}
The '''Devices''' page contains virtual representations of devices physically connected to the controller or virtual devices created by [[wb-rules]] scripts.  
The '''Devices''' page contains virtual representations of devices physically connected to the controller or virtual devices created by [[wb-rules]] scripts.  


Строка 39: Строка 39:
{{Anchor|dashboards-and-widgets}}
{{Anchor|dashboards-and-widgets}}
===Panels===
===Panels===
{{Anchor|dashboards}}
{{Anchors|dashboards}}
You can create text and graphic SVG dashboards to display data and control your automation system.
You can create text and graphic SVG dashboards to display data and control your automation system.


The text dashboard consists of widgets, and the graphic panel consists of a background image with bindings to the MQTT channels of the controller. [[SVG-Dashboards | How to make an SVG panel]].
The text dashboard consists of widgets, and the graphic dashboard consists of a background image with bindings to the MQTT channels of the controller.  
 
[[SVG-Dashboards | How to make an SVG dashboard]].


<gallery mode="packed" heights="150px">
<gallery mode="packed" heights="150px">
Image: Web-Dashboards-2.0.png | Dashboards list
Image: Web-Dashboards-2.0.png | Dashboards List
Image: Text-Dashboard Example.png | Dashboard
Image: Text-Dashboard Example.png | Text dashboard
Image: SVG-Dashboard Example.png | SVG Dashboard
Image: SVG Dashboard Example.png | SVG dashboard
</gallery>
</gallery>


=== Widgets ===
=== Widgets ===
{{Anchor|widgets}}
{{Anchors|widgets}}
With the help of widgets, it is convenient to combine controls of different devices by meaning or location. For example, you can make a widget to control the lighting in a bedroom, or a climate widget in a store. Widgets are grouped into dashboards, one widget can be added to several dashboards.
With the help of widgets, it is convenient to combine controls of different devices by meaning or location. For example, you can make a widget to control the lighting in a bedroom, or a climate widget in a store. Widgets are grouped into dashboards, one widget can be added to several dashboards.


Строка 64: Строка 66:
Image: widget-create-4.png | Edit buttons
Image: widget-create-4.png | Edit buttons
</gallery>
</gallery>
=== Kiosk mode ===
{{Anchor|kiosk}}
{{SupportedSinceRelease|en=true
| release = wb-2207
|content=
If you use a regular tablet as a control panel and display the controller's web interface on it, then it will be useful to hide unnecessary elements and the browser window:
# Open the text or SVG dashboard and click the '''Enter fullscreen mode''' button.
# Copy the URL bar in the address bar of the browser, at the end there should be a <code>?fullscreen</code> parameter.
# Start a browser without panels:
#* On computers and tablets with Windows/linux OS, launch the browser in kiosk mode and pass it the panel URL parameter, examples:
#*:<syntaxhighlight lang="bash">
irefox -kiosk 'http://wirenboard-ascmdm6q.local/#!/dashboards/dashboard1?fullscreen'
chromium -kiosk 'http://wirenboard-ascmdm6q.local/#!/dashboards/dashboard1?fullscreen'
</syntaxhighlight>
#* On Android tablets, use dedicated browser versions such as Fully Kiosk Browser
This works for all dashboard types.
<gallery mode="packed" heights="150px">
Image: Text-Dashboard full screen.png | Enter to full screen mode
Image: Text-Dashboard full screen 2.png | Full screen mode
Image: Text-Dashboard full screen 3.png | Kiosk mode
</gallery>
}}


== History ==
== History ==
Строка 106: Строка 82:
* cursor measurements.
* cursor measurements.


If you need more features, you can set up automatic data export to [[Grafana]].
<div lang="ru" dir="ltr" class="mw-content-ltr">
Если вам надо больше возможностей, вы можете настроить автоматический экспорт данных в [[Grafana]].
</div>


<div lang="ru" dir="ltr" class="mw-content-ltr">
<gallery mode="packed" heights="100px">
<gallery mode="packed" heights="100px">
Image: Web-History-Web-2.0.png | Schedule
Image: Web-History-Web-2.0.png | График
Image: Web-History-Web-2.0 1.png | Table View
Image: Web-History-Web-2.0 1.png | Табличное представление
Image: Web-History-Web-2.0 2.png | Data uploaded to CSV
Image: Web-History-Web-2.0 2.png | Данные, выгруженные в CSV
Image: Web-History-Web-2.0 3.png | Setting up history storage
Image: Web-History-Web-2.0 3.png | Настройка хранения истории
</gallery>
</gallery>
</div>


== Automation scripts ==
<div lang="ru" dir="ltr" class="mw-content-ltr">
== Скрипты автоматизации ==
{{Anchor|rules}}
{{Anchor|rules}}
</div>


The controller's web interface has a script editor [[wb-rules]] that allows you to create, edit, and delete rules. If there are errors in the script, the editor will inform you about it and indicate the place in the script.
<div lang="ru" dir="ltr" class="mw-content-ltr">
В веб-интерфейсе контроллера есть редактор скриптов [[wb-rules]], который позволяет создавать, редактировать и удалять правила. Если в скрипте есть ошибки, то редактор сообщит вам об этом и укажет место в скрипте.
</div>


The editor is available in the '''Rules''' section.
<div lang="ru" dir="ltr" class="mw-content-ltr">
Редактор доступен в разделе '''Правила'''.
</div>


<div lang="ru" dir="ltr" class="mw-content-ltr">
<gallery mode="packed" heights="150px">
<gallery mode="packed" heights="150px">
Image: Web-Rules-2.0.png | Script editor
Image: Web-Rules-2.0.png | Редактор скриптов
Image: Web-Rules-2.0 errors.png | Error highlighting
Image: Web-Rules-2.0 errors.png | Подсветка ошибок
</gallery>
</gallery>
</div>


== Configuring the controller and connected devices ==
<div lang="ru" dir="ltr" class="mw-content-ltr">
== Настройка контроллера и подключённых устройств ==
{{Anchor|settings}}
{{Anchor|settings}}
[[Image: Web-Configs-2.0.png |300px|thumb|right| Configuration files ]]
[[Image: Web-Configs-2.0.png |300px|thumb|right| Конфигурационные файлы ]]
The Wiren Board controller runs on Linux, so almost all settings are stored in configuration files. Files can be edited via [[SSH]] or using the web configurator.
Контроллер Wiren Board работает на Linux, поэтому почти все настройки хранятся в конфигурационных файлах. Файлы можно редактировать через [[SSH]] или с помощью веб-конфигуратора.
</div>


The list of available settings can be found in the section '''Settings''' → '''Confgs'''.
<div lang="ru" dir="ltr" class="mw-content-ltr">
Список доступных настроек вы найдёте в разделе ''' Настройки''' → '''Конфигурационные файлы'''.
</div>


For example, via the web interface, you can configure: connected [[RS-485:Configuration via Web Interface| Modbus devices]], gateways [[KNX | KNX]] and [[Modbus RTU/TCP Slave]] and other parameters.
<div lang="ru" dir="ltr" class="mw-content-ltr">
Например, через веб-интерфейс можно настроить подключённые [[RS-485:Configuration via Web Interface| Modbus-устройства]], шлюзы [[KNX | KNX]] и [[Modbus RTU/TCP Slave]] и другие параметры.
</div>


== Event notifications ==
<div lang="ru" dir="ltr" class="mw-content-ltr">
== Уведомления о событиях ==
{{Anchor|alarms}}
{{Anchor|alarms}}
In the web interface of the controller, you can configure the event notification to be sent via SMS or Email, for example, when an alarm is triggered in the [[WB-MWAC Modbus Water Consumption Metering and Leak Monitoring| WB-MWAC]], send an SMS to the specified number. [[Notification module | Notification module settings]].
В веб-интерфейсе контроллера можно настроить отправку уведомления о событиях по SMS или Email, например, при срабатывании тревоги в модуле [[WB-MWAC Modbus Water Consumption Metering and Leak Monitoring| WB-MWAC]], отправить SMS на заданный номер. [[Notification module | Настройка модуля уведомлений]].
</div>


You can also send notifications to Telegram, for this you need to write a small script on wb-rules, [[Rule_Examples#telegram | example]].
<div lang="ru" dir="ltr" class="mw-content-ltr">
Также вы можете отправлять уведомления в Телеграм, для этого нужно написать небольшой скрипт на wb-rules, [[Rule_Examples#telegram | пример]].
</div>


== Firmware update and collect diagnostic data ==
<div lang="ru" dir="ltr" class="mw-content-ltr">
== Обновление прошивки и выгрузка диагностического архива ==
{{Anchor|diagnostic}}
{{Anchor|diagnostic}}
[[Image: Web-Configs-2.0 system.png |300px|thumb|right| Updating software and downloading diagnostics ]]
[[Image: Web-Configs-2.0 system.png |300px|thumb|right| Обновление ПО и выгрузка диагностики ]]
You can update the controller software without access to the Internet through the web interface, for this you will need a computer and a pre-loaded firmware fit-file. For more information about updating the controller software, see [[Wiren Board Firmware Update| instruction]].
Обновить ПО контроллера без доступа к интернету можно через веб-интерфейс, для этого вам понадобится компьютер и заранее загруженный fit-файл прошивки. Подробнее про обновление ПО контроллера читайте в [[Wiren Board Firmware Update| инструкции]].
</div>


If the controller works with errors, then when contacting technical support, we recommend uploading a diagnostic archive - this will help us quickly understand the problem. If for some reason you cannot upload the archive from the web interface, use the console utility [https://github.com/wirenboard/wb-diag-collect wb-diag-collect].
<div lang="ru" dir="ltr" class="mw-content-ltr">
Если в работе контроллера возникли ошибки, то при обращении в техническую поддержку рекомендуем выгрузить диагностический архив — это поможет нам быстрее разобраться в проблеме. Если по какой-то причине выгрузить архив из веб-интерфейса не получается, воспользуйтесь консольной утилитой [https://github.com/wirenboard/wb-diag-collect wb-diag-collect].
</div>


== View MQTT channels and syslog ==
<div lang="ru" dir="ltr" class="mw-content-ltr">
== Просмотр MQTT-каналов и системного журнала ==
{{Anchor|mqtt-channels}}
{{Anchor|mqtt-channels}}
The list of MQTT channels is useful when troubleshooting, or when setting up integration with third-party software, such as [[Rapid SCADA]] or [[Home Assistant]]. The list is available in the section '''Settings''' → '''MQTT channels'''.
Список MQTT-каналов пригодится при диагностике неисправностей, или при настройке интеграции со сторонним ПО, например, [[Rapid SCADA]] или [[Home Assistant]]. Список доступен в разделе '''Настройки''' → '''MQTT-каналы'''.
</div>


The Linux system log can be viewed using the [[journalctl]] utility or in the controller web interface in the '''Settings''' → '''Logs''' section.
<div lang="ru" dir="ltr" class="mw-content-ltr">
Системный журнал ОС Linux можно посмотреть с помощью утилиты [[journalctl]] или в веб-интерфейсе контроллера в разделе '''Настройки''' → '''Системный журнал'''.
</div>


<div lang="ru" dir="ltr" class="mw-content-ltr">
<gallery mode="packed" heights="120px">
<gallery mode="packed" heights="120px">
Image:Web-Configs-2.0 mqtt.png| MQTT channels
Image:Web-Configs-2.0 mqtt.png| MQTT-каналы
Image:Web-Configs-2.0 logs.png| Logs
Image:Web-Configs-2.0 logs.png| Системный журнал
</gallery>
 
== Phone control ==
{{Anchor|mobile}}
The web interface adapts to the screen size, so you can control the automation system from a mobile device or tablet.
 
An alternative would be to use third-party applications: [[MQTT_Dash]], [[Home Assistant]], [[Apple HomeKit|Apple Home]] and others, see [[Supported_devices |table of supported devices and programs]] for a complete list.
 
<gallery mode="packed" heights="350px" caption="Phone controller web interface">
Image: web-ui mobile 1.png | Device List
Image: web-ui mobile 2.png | Side panel
Image: web-ui mobile 5.png | SVG dashboard
Image: web-ui mobile 3.png | Viewing the system log
Image: web-ui mobile 4.png | Modbus device setup
</gallery>
</gallery>
</div>


== Previous version ==
<div lang="ru" dir="ltr" class="mw-content-ltr">
* [[Wiren_Board_Web_Interface 1.0| Wiren Board Web Interface 1.0]], replaced by 2.0 in early 2021.
== Предыдущая версия ==
* [[Wiren_Board_Web_Interface 1.0| Веб-интерфейс Wiren Board 1.0]], заменён на 2.0 в начале 2021 года.
</div>

Версия 16:51, 2 августа 2022

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

General information

Шаблон:Anchors Wiren Board controllers have a built-in web interface that allows you to perform most of the tasks for configuring the controller, firmware and connected devices. The source code is open and available in our repository.

nginx works as a web server, the site interacts with MQTT via WebSocket.

Overview of the web interface of Wiren Board controllers.

How to enter the web interface

To access the Web Interface of a Wiren Board controller, connect to the controller via Wi-Fi or Ethernet and enter IP address of the controller into the browser's address bar.

If you are on the same network as the controller and use Apple devices, a computer with Linux or Windows 10 and higher, then you can use mDNS instead of an IP address: enter http://wirenboard-XXXXXXXX.local into the address bar, where ХХХХХХХХ — eight-digit serial number of the controller.

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

СChange access level

Administrator level

To change the settings of the controller, you need the Administrator access level, which can be set in the Settings → Permissions section.

After completing the settings, we recommend that you set the access level to User or Operator - this will help you avoid making random mistakes when working with the web interface every day.

MQTT connection setup and language selection

Web interface settings

In the Settings → Web UI section, you can configure the connection to the MQTT broker, select a panel for the home page and change the language of the web interface.

The web interface does not support user authorization, but you can configure nginx server http authorization. For detailed instructions, see Protecting the web interface of the controller with a password.

List of devices

Шаблон:Anchors The Devices page contains virtual representations of devices physically connected to the controller or virtual devices created by wb-rules scripts.

Each device is represented by a card that contains device channels - controls. If you click on the name of the control, you will get a path like device/control, which can be used when writing scripts on wb-rules.

Do not use this page to manage your automation system, there are dashboards for that.

  • List of devices connected to the controller

  • Removing a device card

Dashboards and widgets

Panels

Шаблон:Anchors You can create text and graphic SVG dashboards to display data and control your automation system.

The text dashboard consists of widgets, and the graphic dashboard consists of a background image with bindings to the MQTT channels of the controller.

How to make an SVG dashboard.

  • Dashboards List

  • Text dashboard

  • SVG Dashboard Example.png

    SVG dashboard

Widgets

Шаблон:Anchors With the help of widgets, it is convenient to combine controls of different devices by meaning or location. For example, you can make a widget to control the lighting in a bedroom, or a climate widget in a store. Widgets are grouped into dashboards, one widget can be added to several dashboards.

You can create widgets in the Widgets section, or directly from the dashboard. There is a visual designer and a JSON editor.

  • Widget List

  • Creating a new widget from a dashboard

  • Widget constructor

  • JSON view

  • Ready widget

  • Edit buttons

History

Button to go to the measurement history

By default, the standard controller software stores all received data, which you can view in the form of graphs or tables. The data can be uploaded to csv, to do this, click on the button below the graph, or use the wb-mqtt-db-cli utility.

To view the history, go to the History section and select the desired channels, or hover over the widget's channel and click the histogram button.

Display options:

  • choice of period;
  • simultaneous viewing of several channels;
  • scaling;
  • taking a screenshot;
  • cursor measurements.

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

  • График

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

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

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

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

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

Редактор доступен в разделе Правила.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • MQTT-каналы

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

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

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