Setting up the Environment for using the HDM plugin

Set up the environment for the ZigBee Module by executing one of the "ZigBee <coordinator_brand> with DA HDM Support" install scripts and then install the Working with web console with the HDM or plugin. For example:

• Execute the following command in the runtime console, depending on your Coordinator device type.

  kitman.i "ZigBee Freescale with DA HDM Support"

  or

  kitman.i "ZigBee Telegesis with DA HDM Support"

  or

  kitman.i "ZigBee TI with DA HDM Support"

  or

  kitman.i "ZigBee Ember with DA HDM Support"

• To install the Working with web console with the Web plugin for HDM. Execute the following command in the runtime console:

  kitman.i "Device Access HDM Web Admin"

Displaying Devices

• To load the ZigBee devices, from the Protocol Adapter box, select ZigBee or All.
• To get information about the capabilities of the ZigBee adapter, click the Info button.
• Initially, the Home Devices page will show the physical devices.

• The endpoints are available as child devices and the clusters - as device class objects. To view the endpoint devices, double-click on the parent physical device.

Adding Devices

To add end devices to the coordinator, set it to "pairing" mode.

• Go to the Home Devices page.
• Find the target coordinator in the ZigBee device set.
• Click the button and locate the Advanced Network Controller device class object.
• Specify the duration of the pairing mode if needed.
  1. Select setModeDuration from the Operations list.
  2. In the first field underneath, set 2 for "pairing" mode.
  3. In the second field underneath, set the pairing mode duration in milliseconds.
  4. Click the button to execute the operation.

• Then set the Advanced Network Controller object in "pairing" mode
  1. Select Pairing from the mode list.
  2. Click the button to apply the change.

• Join the end device to the coordinator according to the device manual.
• On success, the device will appear as a home device instance in the Home Devices pages.

Controlling Devices

Once the devices are registered in HDM, you can use their device class objects (DCO). Functional commands can be launched through the device class objects of the endpoint home devices.

To send a command to a ZigBee device:

• Go to the Home Devices page.
• From the Protocol Adapter box select All or ZigBee to view the registered ZigBee devices.
• Locate the end point Home Device under its parent and click the button.
• In the Device Information dialog, locate Device Classes section and select the proper operation or property change of the device class object corresponding to the cluster. For example, select Binary Switch -> toggle for the toggle command of the On/Off Cluster.

• Click the icon to execute the command.

Removing Devices

You can unregister from the OSGi platform only a parent ZigBee home device, which stands for the physical device. Removing an endpoint home device is not allowed. To remove a parent home device:

1. Go to the Home Devices page.
2. From the Protocol Adapter box select All or ZigBee to view the registered ZigBee devices.
3. Use the button to unregister the device.

EZ-Mode Commissioning

The EZ-Mode Commissioning process consists of two basic stages - Network Steering and Find and Bind.

Network Steering

The objective of the Network Steering stage is to join a device to a network, therefore the steps taken in this stage depend on whether the device was already a member of a network or not.

• Not a Network Member

  If the device is a coordinator it attempts to form a network. After successfully forming a network, the coordinator enables its 'permit joining' functionality for a duration of the EZ-Mode time (default is 3 minutes) and broadcasts this 'permit joining' time. This allows other devices to join the network during this time.

  If the device is a Router or an End Device it will join the network with the best RSSI (Received Signal Strength Indicator) value. After successfully joining a network, a router enables its 'permit joining' functionality and broadcasts this 'permit joining' time.

• Already a Network Member

  If the device is already a member of a network, the Network Steering process involves opening the network to allow other nodes to join it.

Find and Bind

Once a new node has been introduced into a network, the 'Find and Bind' stage allows to bind the node with another node - for example, a new lamp can be paired with a controller device, to allow controlling this lamp.

The objective of this phase is to bind an endpoint on a device to a compatible endpoint on a device in the network (depending on the supported clusters). In the Find and Bind stage, a device can have one of two roles in the EZ-Mode Commissioning:

• Initiator: This device can either create a local binding with a remote endpoint or request the remote endpoint to be added to a group.
• Target: This device identifies itself through responses to the requests from the initiator.

The intended outcome is a binding between the initiator and the target. Usually, the initiator is a controller device. During the Find and Bind stage, it is necessary to put into 'identification' mode (of the Identify cluster) all of the target devices with which the initiator will be paired. For example, if a light-switch is to control three new lamps then all three lamps must be put into identification mode (e.g. by pressing buttons). At this stage both devices must support Identify Cluster.

The following steps describe the 'Find and Bind' process:

1. On the target device(s), put the device(s) into identification mode. This can be achieved through pressing a button. The device(s) will remain in this mode for a certain period of time.
2. On the initiator device, enter the 'Find and Bind' stage. This can be achieved through pressing a button. The device will remain in this mode for a certain period of time.
3. The initiator and target devices will then exchange messages as follows:
   • The initiator will broadcast an Identify Query request and wait for Identify Query responses. If no response is received within this time, the initiator will repeatedly broadcast an Identify Query request every 10 seconds until either a response is received or the EZ-Mode timeout has expired.
   • On receiving an Identify Query response, the initiator checks whether the device has already been joined or discovered by the ZigBee module. If the device is not a network member yet or is in progress of network pairing then the response of the next Identify Query request will be received and handled.
   • If a target device is a network member, the initiator will check for client/server matches between its clusters and those supported by the target device. If there is a cluster match, the Initiator (Coordinator) creates a local Binding table entry for the target/cluster. The binding source shall be the Initiator's matching cluster. The binding's destination shall address (unicast or group) the Target's matching cluster.

   When a remote device is paired to the controller, if necessary, it provides binding entries to the remote device, which is a reverse direction of binding and is used for attribute reporting.

   When a controller performs EZ-mode commissioning as Initiator it is required to specify the ZCL clusters exposed for binding. It can be done by specifying the device type of coordinator with which it participates in the EZ-mode commissioning. The "initiatorType" property is relevant only when EZ-mode commissioning is activated as Initiator.

The following picture represents commissioning EZ-mode as initiator.

The following picture represents commissioning EZ-mode as initiator.