16 808
правок
(Новая страница: «If you need more features, you can set up automatic data export to Grafana.») |
|||
(не показана 41 промежуточная версия 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}} | ||
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 == | ||
{{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}} | ||
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}} | ||
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 | 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]]. | ||
[[SVG-Dashboards | How to make an SVG | |||
<gallery mode="packed" heights="150px"> | <gallery mode="packed" heights="150px"> | ||
Image: Web-Dashboards-2.0.png | Dashboards | Image: Web-Dashboards-2.0.png | Dashboards list | ||
Image: Text-Dashboard Example.png | | Image: Text-Dashboard Example.png | Dashboard | ||
Image: SVG Dashboard Example.png | SVG | Image: SVG-Dashboard Example.png | SVG Dashboard | ||
</gallery> | </gallery> | ||
=== Widgets === | === Widgets === | ||
{{ | {{Anchor|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. | ||
Строка 66: | Строка 64: | ||
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 == | ||
Строка 91: | Строка 115: | ||
</gallery> | </gallery> | ||
== Automation scripts == | |||
{{Anchor|rules}} | {{Anchor|rules}} | ||
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. | |||
The editor is available in the '''Rules''' section. | |||
<gallery mode="packed" heights="150px"> | <gallery mode="packed" heights="150px"> | ||
Image: Web-Rules-2.0.png | | Image: Web-Rules-2.0.png | Script editor | ||
Image: Web-Rules-2.0 errors.png | | Image: Web-Rules-2.0 errors.png | Error highlighting | ||
</gallery> | </gallery> | ||
== Configuring the controller and connected devices == | |||
{{Anchor|settings}} | {{Anchor|settings}} | ||
[[Image: Web-Configs-2.0.png |300px|thumb|right| | [[Image: Web-Configs-2.0.png |300px|thumb|right| Configuration files ]] | ||
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. | |||
The list of available settings can be found in the section '''Settings''' → '''Confgs'''. | |||
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. | |||
== Event notifications == | |||
{{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]]. | |||
You can also send notifications to Telegram, for this you need to write a small script on wb-rules, [[Rule_Examples#telegram | example]]. | |||
== Firmware update and collect diagnostic data == | |||
{{Anchor|diagnostic}} | {{Anchor|diagnostic}} | ||
[[Image: Web-Configs-2.0 system.png |300px|thumb|right| | [[Image: Web-Configs-2.0 system.png |300px|thumb|right| Updating software and downloading diagnostics ]] | ||
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]]. | |||
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]. | |||
== View MQTT channels and syslog == | |||
{{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'''. | |||
The Linux system log can be viewed using the [[journalctl]] utility or in the controller web interface in the '''Settings''' → '''Logs''' section. | |||
<gallery mode="packed" heights="120px"> | <gallery mode="packed" heights="120px"> | ||
Image:Web-Configs-2.0 mqtt.png| MQTT | Image:Web-Configs-2.0 mqtt.png| MQTT channels | ||
Image:Web-Configs-2.0 logs.png| | Image:Web-Configs-2.0 logs.png| Logs | ||
</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> | ||
== Previous version == | |||
* [[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| | |||