Web Interface of Wiren Board Controllers

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

English
русский

General information

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.

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

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

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. How to make an SVG panel.

Dashboards list
Dashboard
SVG Dashboard

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.

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

Kiosk mode

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 ?fullscreen 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:
  irefox -kiosk 'http://wirenboard-ascmdm6q.local/#!/dashboards/dashboard1?fullscreen' chromium -kiosk 'http://wirenboard-ascmdm6q.local/#!/dashboards/dashboard1?fullscreen'
- On Android tablets, use dedicated browser versions such as Fully Kiosk Browser

This works for all dashboard types.

Enter to full screen mode
Full screen mode
Kiosk mode

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.

If you need more features, you can set up automatic data export to Grafana.

Schedule
Table View
Data uploaded to CSV
Setting up history storage

Automation scripts

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.

Script editor
Error highlighting

Configuring the controller and connected devices

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 Modbus devices, gateways KNX and Modbus RTU/TCP Slave and other parameters.

Event notifications

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, send an SMS to the specified number. Notification module settings.

You can also send notifications to Telegram, for this you need to write a small script on wb-rules, example.

Firmware update and collect diagnostic data

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 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 wb-diag-collect.

View MQTT channels and syslog

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.