ZigBeeForDomoticZ plugin Wiki

The Web interface - Management section

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

The Management menu opens the Devices page. A tab bar at the top switches between its two pages:

Before plugin 9.1.009, Management is a drop-down menu with Device Management and Group Management.


Device Management

The Device Management page (Management > Devices) lists all the devices paired with the plugin. From it you rename a device, set its parameters, enable or disable it, and open its details.

Plugin 9.1.009 and later. This section describes the Device Management page available since plugin 9.1.009. In older versions, the page is a wide table with a Del. (trash) column, an Optimized icon to copy the device data, names typed in the table and saved with Validate, and a parameter window where the parameters are typed as one text.

Device Management

This picture may have changed since this documentation was written.

The list

Column Content
Friendly Name The name you gave the device (the model, in italics, when it has none). Below it, its Domoticz widget, or the number of widgets and the first one, or No Domoticz widget. Click the name to rename the device (see below).
Model The model name reported by the device, and below it Optimized (in green) when the plugin has a certified configuration for this model, or Not optimized (in orange) when it hasn’t (see Dealing with a non-optimized device).
Address The network address (short id, NwkId), which can change when the device rejoins, and below it the IEEE, the unique and permanent address of the device.
Power Mains, or the battery level (in red at 15 % and below), and the role of the device in the mesh: Router or End device.
LQI The link quality (0 to 255) of the last message received from this device, with a bar: green from 100, orange from 40, red below. When the coordinator reports it, the RSSI is shown below. Both are measured on the last hop only (see What the LQI and RSSI measure).
Health Live, Not seen recently, Not reachable, Timed out, Disabled, Unknown. A device whose pairing is not complete shows a warning below: Pairing failed, Not in Domoticz, or Status: followed by the pairing state of the plugin.
Parameters The number of parameters set for the device (None when there is none). An orange dot means the last saved parameters wait for the device’s next heartbeat. Click it to open the parameter panel (see below).

Above the list:

Click a column header to sort the list. The page remembers your sort order and page size.

Rename a device

The friendly name is used by the WebUI to show the device, in the network pages for example, instead of its four-digit short id.

Rename a device

  1. Click the name of the device: it becomes an input field.
  2. Type the new name.
  3. Press Enter, or click ✓. Only this device is saved, at once.

Esc, ✕ or a click elsewhere cancels the change.

Parameters

The Parameters button of a row (or the Parameters button of the device details) opens a side panel:

Device parameters, Fields

If the parameters stored by the plugin can’t be read, the panel opens on the JSON view with the stored text, so you can fix it.

Device details

Click anywhere else on a row (or press Enter on a selected row) to open the details of the device:

Device details, LQI and RSSI

A router with RSSI readings: both charts are shown.

Device details, LQI only

A battery device with no RSSI reading: only the LQI chart is shown.

The buttons at the bottom:

What the LQI and RSSI measure

Two different measures. The LQI and the RSSI both describe a received frame, but they don’t measure the same thing:

So a link can show a good RSSI and a poor LQI (a strong but disturbed signal), and the two numbers don’t convert into each other.

Only the last hop. The LQI column and the charts of the device details are not a measure of the whole route from the device to the coordinator. They describe only the last hop: the radio link between the coordinator and the node it received the message from.

How Zigbee measures them. The radio (the IEEE 802.15.4 layer) of a node measures the LQI, and often the RSSI, of each frame it receives, and only for that frame. When a router relays a message, it sends a new frame, and the next node measures that new frame. Zigbee does not add the hops up: the network layer passes the LQI of the received frame unchanged to the application (NLDE-DATA.indication and APSDE-DATA.indication in the Zigbee specification). So the value the coordinator reports is the quality of the frame its own radio heard. Silicon Labs radios name it accordingly: last hop LQI and last hop RSSI.

How the plugin files them. The plugin records the value under the device that sent the message (its network source address), not under the router that relayed it:

To see the quality of each link in the mesh, including the device’s own link to its parent, use the neighbour tables of a topology scan: Network > Mesh. For the path a device’s messages take, see Computed routes.

For a worked example, from a low LQI in the device list to the link that is actually weak, see A device shows a low LQI: a worked case.

Where the values come from.

Coordinator LQI RSSI
ZiGate yes, from the ZiGate firmware no
Texas Instruments (zigpy-znp) yes no
Silicon Labs (bellows) yes yes
deCONZ (zigpy-deconz) yes yes
Bouffalo Lab (zigpy-blz) yes no

Comparing values. Because each radio maker computes the LQI its own way, an LQI from one coordinator family can’t be compared with an LQI from another, and the colour bands of the list are a rough guide only. The RSSI, in dBm, is a physical measure and compares better across radios, though not exactly.

ZDO and ZCL messages

The Messages received since plugin start counters of the device details sort the messages of a device into two kinds:

What to look at:

The counters count what the plugin received, repeats included (a device that retries a message because it did not get the acknowledgement counts twice). The Mgmt Permit Join and Mgmt Leave responses are not counted. With a ZiGate, only the messages the firmware forwards as raw data (0x8002) are counted.


Group Management

The Groups & Scenes page (Management > Groups & Scenes, Groups before plugin 9.1.010) is where you create and edit the Zigbee groups. Groups must be enabled first with the enablegroupmanagement setting (see Group management settings): until then, the page only shows Group management is off and a link to the settings.

Plugin 9.1.009 and later. This section describes the Groups page available since plugin 9.1.009. In older versions, the page (Management > Group Management) is one table of all the groups, with the devices of each group picked in a drop-down, a Coordinator (in the group) tick box, a trash icon to delete a group, Add a new Group, and one Validate button that saves every group at once.

Group Management

This picture may have changed since this documentation was written.

The page has the key figures on top, the list of the groups on the left, and the editor of one group on the right. Help on the wiki opens this section.

Key figures

Figure Content
Groups The number of groups, and below it how many have the coordinator as a member.
Devices in a group The number of devices that belong to at least one group, and below it how many devices that can join a group are in no group yet.
Needs attention The number of groups with at least one member that is Not reachable, Timed out or Not seen recently. The figure turns yellow when it isn’t 0.
Scenes With Zigbee scenes enabled: the number of scenes, the groups that have some, and how many need a look.
Membership scan Ready, or Running while the plugin asks the routers which groups they belong to. Scan all starts the scan, and the link opens Admin > Group.

The group list

Each group shows its name, its group id (4 hexadecimal digits), its number of members, coordinator when the coordinator is a member, and a status:

The list is sorted by group id. Search keeps the groups whose name or id, or the name, model, short id (NwkId) or widget of a member, contains what you type.

Click a group to open it in the editor. New opens an empty group.

The group editor

The members

Adding a member to a group

Adding a member to an existing group: the new member is marked in green until you save.

Column Content
Widget The Domoticz widget(s) of the member endpoint, or the device name when it has none.
Device The model of the device, and below it its short id (NwkId).
Ep The endpoint of the device that is in the group. A device with several endpoints (a double switch, for example) can have each one in a different group.
Health The health of the device, as in the device list.

Add a member: click the field under the members. It lists every device endpoint that can still join the group, sorted by name, with its model, short id and endpoint. Type part of a name, model or short id to narrow the list. Click a row, or move with the arrow keys and press Enter, to add it: it shows in green, added when you save, and the list stays open for the next one. Esc closes the list. Undo takes an added member back out.

The list offers lights, plugs, switches, covers and thermostats paired with the plugin. Battery devices only appear with the GroupOnBattery setting (see How Zigbee groups work). Every device that can join is already in this group means there is nothing left to add.

Save, discard, delete

Creating a group

Creating a group: the group id is given when you save.

The editor counts your changes (Unsaved changes: n: name, coordinator, each member added or removed). The buttons act on this group only:

If you click another group, or New, with unsaved changes, the page asks first: Keep editing or Discard.

After saving

The plugin sends the change to each member. A membership changes when the device answers, so the page reads the groups again just after saving, then after 3 and 8 seconds, and says so: Sent to the devices…. A device that is off keeps its old membership until it answers. To check what each router really has, run a membership scan in Admin > Group.

When the change needs a plugin restart, the message says so and the Restart needed indicator blinks in the menu bar until you restart the plugin.

Scenes

With Zigbee scenes enabled, the editor of a group has a Scenes section under its members, and a By group / By scene switch shows the page from the scenes. The page on Zigbee scenes describes them.

Refer to the section How to manage groups for more information.


Look at the other pages of the plugin Web interface.