ZigBeeForDomoticZ plugin Wiki

The Web interface - Dashboard page

Please refer to STEP 3 Plugin Configuration to get access to the Web interface administration.

The Dashboard is the home page of the WebUI (the first item of the menu bar, with the name of your plugin hardware). It shows at a glance whether the plugin, the coordinator and the devices are doing well, and what needs your attention.

Plugin 9.1.009 and later. This page describes the Dashboard available since plugin 9.1.009. Older versions show a single row of pie charts (Plugin devices, Send & Receive, Statistics, then Type of devices, Battery, Optimized devices) instead of the key figures, the Needs attention list and the bars described below.

Dashboard

This picture may have changed since this documentation was written.

Key figures (top row)

Figure What it shows
Devices live The devices in Live health, out of all the devices known to the plugin, and how many are not live.
Received / min The messages received per minute, and below them the messages sent per minute, both averaged since the plugin started.
Delivery The share of unicast messages acknowledged by the device (APS ack), out of those acknowledged or failed, since the plugin started, with both counts below. Green from 98 %, orange from 90 %, red below.
Coordinator The coordinator model, its firmware version and the Zigbee channel.
Plugin The plugin version when it runs from a stable branch. On any other branch, the branch name and its commit, shown in orange: useful when you test a fix branch.
Uptime How long the plugin has been running, and when it started.
Firmware updates Only while an OTA firmware transfer runs: the device(s) being updated and the progress, with a link to Admin > Firmware (see Update device firmware).

Needs attention

This list gathers what may need an action. Only the items that apply are shown; when there are none, the Dashboard says Nothing needs attention.

Item Meaning
Not reachable Devices the plugin could not reach (health Not reachable), or that left the network.
New errors in the plugin log The plugin has logged new errors. They are also signalled by the warning icon in the menu bar. Viewing or downloading them marks them as read.
Battery below 15 % Battery devices that need a new battery soon, lowest first.
Not seen for n h Devices that sent nothing for the delay set by the HealthTimeOut setting.
Groups with a member not reachable or not seen Zigbee groups with at least one member that is not reachable or not seen: a command sent to the group may not reach every member.
Not optimized Devices without a certified configuration, handled generically by the plugin. See Dealing with a non-optimized device.
Firmware update available Devices for which the plugin found a newer firmware online than the one they run. From plugin 9.1.010 it opens Firmware updates found online, with the download links; Admin > Firmware then starts the update.

Each item has two buttons:

Export all saves every item in one file, z4d-needs-attention.json. Each file also carries the plugin version, branch and commit, and the coordinator model, firmware and channel: it is ready to attach to a request for support (see Reporting a problem). It contains no network key or password.

Plugin Status

Click the ⓘ next to a title to see how the figure is defined.

Devices

Each family of devices is a bar, split by state. Click a part of a bar, or one of the labels below it, to open the list of the matching devices (short id, IEEE, model, name, status, battery, health). Device Management → opens the Device Management page.

Type of devices, Battery and Optimized devices leave out the disabled devices.

Refreshing

The dashboard is not refreshed automatically: click Refresh to update it. To have it refresh every 10 seconds, press Alt+Z (or type z, i, g); press it again to stop.

The bar at the bottom of every WebUI page gives, from left to right:


Look at the other pages of the plugin Web interface.