How to manage a Z-Wave network through the abstraction layer provided by the HDM Module using the Web Admin Console.

Prerequisites

Follow the instructions in the Setup Guide to Set up the environment for the Z-Wave Module by executing the zwave-hdm.txt install script or by manually installing (and starting) the necessary bundles.

You need also to install the Device Access with Web Console support  by executing the hdm.web.txt install script or by manually installing (and starting) the necessary bundles. See HDM Setup guide for details.

Managing Devices through HDM

Accessing Z-Wave Devices

After setting up the environment, open the Web Admin Console page in a browser and log in. Serch for the IoT -> HDM tab and click on it. This opens the Home Devices page with the Devices tab selected by default. You can filter out only the available devices that communicate over the Z-Wave protocol by selecting Z-Wave from the Protocol Adapter box.

The Devices tab of the Home Devices page shows the devices registered in the Home Device Manager. Here, the capabilities of the relevant protocol adapter are limited. It does not support "add", "search" and "remove" operations. The initialization of information from a device is automatically performed through the explicitly set actions of the Z-Wave Network Controller.

Examining and Changing Device Details

To view detailed information about a device, click the Details icon (i).

The Device Details dialog will appear.

You can change the device attributes, as well as define additional properties in the Properties list, if required.

Besides the details of the device itself, under Device Classes, it shows the device class objects that the device has. There you can launch an operation on or modify a property of a device class object.

--+

Z-Wave Network Controller

In order to add a Z-Wave device to an existing network, the Z-Wave controller must be set in adding/removing mode, or reset in cases when you need to have its defaults.

Adding Mode

To set the Z-Wave controller device in adding mode so that a device/node can be added to the network, follow these steps:

1. Navigate to the Home Devices tab of the Web Admin Console.
2. From the Protocol Adapter combo box select the Z-Wave adapter.

   To get more details on the protocol adapter select the Info button, which opens the Protocol Adapter Info window:

   

3. Select the button of the Z-Wave Local Controller from the Devices tab.

   In the Device Information window that appears, locate the Device Classes section which lists the contained ZWaveNetworkController device class object and its properties. The device class object's mode options are available in the mode box.

   The available modes are as follows:

   • Adding: Allows you to instruct the controller to allow adding of nodes to the network. The controller will stay in this mode until one device is added to the network. Then it will go to normal mode.
   • Normal: The normal operation mode for the devices. It allows you to cancel adding or removing of nodes to and from the network.
   • Controller Shift: Allows you to permit adding another controller to the network. The controller will stay in this mode until a controller is added to the network. Then it will go in normal mode. The added controller should take the primary role.
   • Process Control Event: Internal mode - please do not use.
   • Learn: Allows you to instruct the controller to enter learn mode. In learn mode the controller is supposed to be added in other network. It will be reset and all current network information will be lost. The controller will adopt the home ID of the adding controller.
   • Removing: Allows you to instruct the controller to allow removing of nodes from the network. The controller will stay in this mode until one device is removed from the network. Then it will go in normal mode.
   • Replacing: This mode can not be set explicitly via the drop down menu but it is a possible mode. The controller enters Replacing mode if the replaceFailedNode command is executed successfully.
   • Net Maintenance: Allows you to instruct the controller to enter network maintenance. In this mode the controller starts a procedure of full network maintenance/rediscovery of all devices. The network maintenance is used to rebuild the routing table in the primary controller. This helps to rediscover devices that has been moved or to reduce communication latency due to routing through invalid routes. The use of network maintenance should be kept to a minimum as it may create extensive traffic in the network. While in state of network maintenance the controller is not accessible for anything else.
4. From the mode drop box select the Adding property.

   

   1. To execute the operation select the button next to the mode drop box.

      If the operation returns some result it will appear in a pop-up:

      

   2. Select Save to keep the changes.

Including a Slave/End Device to the Network

Now that the controller is in the correct "Adding" mode, it's time for you to join your Z-Wave device to your controller.

While in Adding mode you should be able to connect your slave Z-Wave device by associating it to the controller - this is normally achieved by pressing the button on your end device. Your end-device might have a different adding method, so please consult the user documentation of the device for further information. After the adding operation the controller will switch to Normal mode automatically.

Notice that if the slave device has already been joined to some other network, it first needs to be removed from it or reset - for that purpose we direct the user to execute the "Removing Mode" steps first and then get back to "Adding Mode"

Removing Mode

To set the Z-Wave controller device in a state for removing a node from the Z-Wave network, follow steps 1 through 6 from the Adding Mode section. Here the only difference is in step 4 - select the Removing property from the mode drop box.

Replacing Mode

This section describes the Z-Wave Network Controller Replacing mode. It is not allowed to set this mode explicitly via the drop down menu. The controller enters Replacing mode if the replaceFailedNode command is executed successfully.

1. Follow steps 1 through 3 of the Adding Mode section.
2. From the Operations drop box select the isFailedNode action, to check that the specific node has failed.
3. Pass the Arguments e.g the <nodeId>.
4. To execute the operation, click on the button.

   

5. If the result of this operation is "true", from the Operations drop box select the replaceFailedNode action and execute it.

   

6. As a result the Z-Wave Network Controller enters Replacing mode.

Resetting Mode

This section describes the steps to reset the Z-Wave Network Controller. Once this operation is performed, the controller is set to its factory defaults. As a result, all network information such as node IDs and routing tables will be lost without the option to be recovered.

1. Follow steps 1 through 3 of the Adding Mode section.
2. From the Operations drop box select the resetController action.

   

3. To execute the operation, click on the button.
4. To save the changes, select the Save button.

Operating a Multilevel Switch

To execute an operation on a device class object of a device, e.g. to change the level of a Multilevel Switch:

1. Click the Home Devices tab of the Web Admin Console.
2. Make sure you have Z-Wave Switch device added to the network and therefore present in the devices list. Open its information window through a click on the button from within the Actions column.
3. In the shown Device Information dialog, locate the Device Classes section which lists the contained device class objects.

   The device class object's operations are available in the Operations box underneath the device class label.

4. Choose a percentage number from 0% to 99% for the level of the switch operation and click the button. (e.g. If you choose 0% the Multilevel Switch will go off).