HOW TO: Add, remove or replace ZigBee Client clusters (including Manufacturer Specific Clusters or MSC) on the Smart Energy network of a ConnectPort X2 or X2e for Smart Energy Gateway


This article discusses how to manually add, remove, or change ZigBee clusters on a Digi Smart Energy Profile 1.1 certified gateway.

Digi Smart Energy Plug-In Drivers:

Digi has created Plug-in drivers for some of the more popular Smart Energy devices in use by our customers.  Plug-In drivers allow a customer to forego adding the necessary clusters to talk with a device manually (RE: the examples at the end of this article), since that content is added at time of driver installation.  Click on the ConnectPort X2 for Smart Energy or ConnectPort X2e for Smart Energy to access the Smart Energy Plug-In Driver page for your Digi Smart Energy gateway, or continue with the guidance below and learn how to to manually add a Client cluster to your Gateway...

Obtain the Developer documentation for your Smart Energy device, if possible:

Developer documentation should be obtained from the Device manufacturer if possible, for any devices which don't currently have a Digi Smart Energy Plug-in driver.  Within the Manufacturer's developer documentation should be found a list of the clusters which your chosen Smart Energy device contains, as well as any commands that can be used with the device.  The developer-level documentation is necessary in order to allow your Digi Smart Energy Gateway to access the Manufacturer Specific Clusters (and additional content) of your device using the examples below.

When developer documentation isn't readily available from the Smart Energy device manufacturer, you might be able to figure out which Client cluster(s) need to be added to the Gateway by first adding the Smart Energy device to your Gateway's network, finding out which Server Clusters you aren't able to read, then using the examples below (in order) to add a corresponding Client cluster.  In lieu of Manufacturer-provided developer documentation, the examples below should allow you to read the Server cluster, despite the ad hoc nature of this method.


ZigBee Cluster Overview:

NOTE:  It is not the intent of this article to provide SEP 1.1 specification info beyond a level needed to understand the article below. Please visit to download the latest copy of the Smart Energy Profile 1.1 and ZigBee Cluster Library specification for details, especially if the terminology in this article is unfamiliar to you. The Digi Smart Energy Gateway User Guide can be consulted for supplemental information specific to Digi's Smart Energy gateway implementation.

The ZigBee Cluster Library (ZCL) document is a repository of standard cluster functionality developed by the ZigBee Alliance.  The ZCL cluster specification defines mandatory and optional attributes, cluster specific commands, and a functional description for ZigBee clusters.  ZigBee Application Profiles extend the ZCL with device specifications that define mandatory and optional cluster usage, the value of "free" parameters in the ZCL, and giving an additional functional description.  Together, the ZCL and ZigBee Application Profile specifications allow ZigBee devices to be customized for use on different types of ZigBee networks, such as Smart Energy Profile (SEP).

The ZigBee Smart Energy Profile 1.1 specification (REF:  ZigBee Energy Profile Specification, profile 0x0109, Revision 16, Version 1.1, date:  Mar 23, 2011, Copyright © ZigBee Alliance, Inc. (2007-2010)) is the ZigBee Application Profile that defines standard devices and interfaces to allow interoperability between devices which become ZigBee SEP 1.1 certified.  Digi's Smart Energy Gateways are certified as SEP 1.1 Smart Energy devices.


ZigBee Clusters:

The ZCL states that a cluster is a related collection of commands and attributes, which together define an interface to specific functionality. Typically, the entity that stores the attributes of a cluster is referred to as the Server of that cluster, and an entity that affects or manipulates those attributes is referred to as the Client of that cluster

Common Clusters
ZigBee SEP 1.1 specifies that Common clusters exist, which are common to all Smart Energy devices.  Some of the Common Clusters are mandatory, but most are optional.  The spec also defines that a device endpoint contains Server or Client Clusters (or both), depending on the device's role on a Smart Energy network.

Manufacturer Specific Clusters:
The Smart Energy 1.1 spec states that the ZCL provides a range of cluster IDs which are reserved for Manufacturer-specific Clusters (MSC).  Manufacturers can utilize MSC as long as the clusters conform to the requirements given in the ZCL. A number of Smart Energy devices available on the market today contain Manufacturer Specific Clusters, which are used to provide additional content specific to a manufactured device.  It is sometimes the additional content/features that set one device apart from another on the market.

HOWTO:  Add a Client Cluster Examples:

Key:  The first example shows how to add a non-encrypted Client cluster in order to access an unreadable Server cluster.  If unable to read the Server cluster from a non-encrypted Client cluster, the second example shows how to remove a Client cluster, then re-add it (i.e. replace it) as an APS-encrypted Client cluster instead:

HOW TO: Add missing ZigBee Smart Energy Client clusters for a device (Example: RToA CT-22/30/80 thermostat)
HOW TO: Remove non-encrypted ZigBee Smart Energy clusters for a device and re-add them as APS Enrcypted clusters (Example: 2D2C Inc Model 1313 Load Controller)
Last updated: Aug 08, 2017

Recently Viewed

No recently viewed articles