ZigBee Cluster Library Specification...ZigBee is not responsible and shall not be held responsible...

ZigBee Cluster Library Document – 075123

Copyright 2007-2016, The ZigBee Alliance. All rights reserved. Page 1

ZigBee Cluster Library Specification Revision 6 Draft Version 1.0 Chapter Document: 14-0125

ZigBee Document: 07-5123-06

ZigBee Document 07-5123

Date of release 14 January 2016

Sponsored by ZigBee Alliance

Accepted by This document has been accepted for release by the ZigBee Alliance Board of Directors.

Abstract This document defines the ZigBee Cluster Library revision 6 (ZCL6).

Keywords ZigBee Cluster Library, ZCL, ZCL6, Application Framework

ZigBee Cluster Library Specification ZigBee Document – 075123

Page 2 Copyright 2007-2016, The ZigBee Alliance. All rights reserved.

Notice of Use and Disclosure

Copyright © ZigBee Alliance, Inc. (1996-2016). All rights Reserved. This information within this document

is the property of the ZigBee Alliance and its use and disclosure are restricted.

Elements of ZigBee Alliance specifications may be subject to third party intellectual property rights, in-

cluding without limitation, patent, copyright or trademark rights (such a third party may or may not be a

member of ZigBee). ZigBee is not responsible and shall not be held responsible in any manner for identifying

or failing to identify any or all such third party intellectual property rights.

No right to use any ZigBee name, logo or trademark is conferred herein. Use of any ZigBee name, logo or

trademark requires membership in the ZigBee Alliance and compliance with the ZigBee Logo and Trade-

mark Policy and related ZigBee policies.

This document and the information contained herein are provided on an “AS IS” basis and ZigBee DIS-

CLAIMS ALL WARRANTIES EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO (A)

ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY

RIGHTS OF THIRD PARTIES (INCLUDING WITHOUT LIMITATION ANY INTELLECTUAL

PROPERTY RIGHTS INCLUDING PATENT, COPYRIGHT OR TRADEMARK RIGHTS) OR (B) ANY

IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,

TITLE OR NONINFRINGEMENT. IN NO EVENT WILL ZIGBEE BE LIABLE FOR ANY LOSS OF

PROFITS, LOSS OF BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF BUSINESS, OR FOR

ANY OTHER DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTIAL, PUNITIVE OR

CONSEQUENTIAL DAMAGES OF ANY KIND, IN CONTRACT OR IN TORT, IN CONNECTION

WITH THIS DOCUMENT OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF

THE POSSIBILITY OF SUCH LOSS OR DAMAGE. All Company, brand and product names may be

trademarks that are the sole property of their respective owners.

The above notice and this paragraph must be included on all copies of this document that are made.



Participants

The following is a list of ZigBee members who contributed to this document:

Cam Williams - Chair of the Foundation Working Group

Rob Alexander Jared Lemke

Shane Almeida Christopher Leidigh

Casey Anderson Yingbo Li

Skip Ashton Marco Naeve

Wally Barnum Alexis Martin

Ettore Colicchio Juan Agui Martin

Jeff Cooper Jeff Mathews

Damon Corbin Tony Mauro

John Cowburn Leslie Mulder

Robert Cragie Luca Negri

Jonathan Cressman Ivan O’Neill

Tim Gillman Isaac Pinhas

Drew Gislason Andrea Ranalli

Ezra Hale Jonas Riska

Jesper Haee Zachary Smith

Robert Hall Robby Simpson

Jon Harros Sumit Singh

Jim Hartman David Smith

Arasch Honarbacht Matt Smith

Ted Humpal Michael Stuber

Phil Jamieson Don Sturek

William Keith Mads Westergreen

Larry Kohrmann Urban Wicklander

Tom Klein Cam Williams

John Knuth Ian Winterburn

Cristian Kuster Kenny York

Zin Kyaw Walter Young

Gary Lee



Document Control

The ZigBee Cluster Library is made of individual chapters such as this one. See Chapter 1 for the list of all

chapters. References between chapters are made using a X.Y notation where X is the chapter and Y is the

sub-section within that chapter. References to external documents are contained in Chapter 1 and are made

using [Rn] notation.

An update to any of these chapters will be reflected in an update to the source document list below.

Chapter 1 – Introduction Document 14-0125-12

Chapter 2 – Foundation Document 14-0126-15

Chapter 3 – General Document 14-0127-17

Chapter 4 – Measurement and Sensing Document 14-0128-10

Chapter 5 – Lighting Document 14-0129-12

Chapter 6 – HVAC Document 14-0130-11

Chapter 7 – Closures Document 14-0131-14

Chapter 8 – Security and Safety Document 14-0132-12

Chapter 9 – Protocol Interfaces Document 14-0133-07

Chapter 10 – Smart Energy Document 14-0134-10

Chapter 11 – Over the Air Upgrades Document 14-0135-13

Chapter 12 – Telecommunications Document 14-0136-09

Chapter 13 – Commissioning Document 14-0137-10

Chapter 14 – Retail Document 14-0138-07

Chapter 15 – Appliances Document 14-0139-11

Approved Errata for this ZCL revision Document 15-0180

Source files for drawings in this ZCL revision Document 14-0141-00



Document History

Revision Number Date Comments

00 11th July 2007 Document created

01 19th Oct 2007 First release

02 29th May 2008 Added Commissioning Cluster from 064699r12.

Added material from annex of CBA Profile 053516r10

Structured types (arrays etc) and structured R/W com-mands

Input / Output / Value clusters (Basic)

Input / Output / Value clusters (BACnet Regular & Ex-tended)

Generic Tunnel cluster

BACnet Protocol Tunnel cluster

Made changes to the Color Control cluster re. CCB 870

Added x,y control according to CIE 1931 Color Space

Added long data types (as required by SE profile 075356r12

etc)

40-64bit integers etc, long strings

Made changes to time cluster (as required by CCBs 890, 914)

Added time zone & DST + UTCtime type

Made minor changes as requested by the following CCBs

627, 714, 781, 853, 854, 867, 878, 879, 880, 881, 883, 893, 897, 898, 919, 958

03

18th Sept 2009

The following changes were made to the Editor’s Copy of the ZCL,

095254r00.

Made change to the Basic cluster, re CCB comment #606

Added optional attribute DisableLocalConfig.

Updated Pressure Measurement cluster re CCB comment

#961

Added extra attributes to allow wider range of pressure.

Updated Color Control cluster re CCB comment #1006

Clarification of stop commands, color mode switching etc.

Made changes to RSSI Location cluster, re CCB comment

#1053

Added mechanism for centralized location.

Made change to Generic Tunnel cluster, re CCB comment

#1068

Added extra fields to Match Protocol Address Response Command

24th Dec 2009

Made minor changes and clarifications re the following CCBs

960, 1001, 1004, 1061, 1097.

Added Door Lock cluster.



Revision Number Date Comments

Updated Occupancy Sensor re CCB comments 1092, 1093,

1094

04

2010

CCB 1174: Fixed references

CCB 1176: Added new status codes

CCB 1202: Corrected default value in thermostat cluster

April 2012

CCB 1381: Default Response clarification

CCB 1260: Generic Tune l cluster clarification

CCB 1377: Commissioning Cluster minor change

CCB 1146: Report Attributes without Configuration

CCB 1169: Dependencies on Optional Attributes

CCB 1379: Generic Tunnel ProtocolAddress attribute

ReadOnly Option

CCB 1420: Time cluster ESI bit

CCB 1390: Reporting destination clarification

05 18 March 2015

Move to individual chapters

Added all approved Clusters from other Application Speci-

fications

Included CCBs

Editorial cleanup of document

06 14 January 2016

Chapter 1:New terms for ZigBee 3.0

Chapter 2: ZigBee 3.0 & Application Architecture changes

Broadcast Endpoint Rules

Global discovery commands from ZHA 1.2

CCB 1277 1444 1505 1923 2092

Chapter 3:ZCLVersion attribute of Basic cluster is 0x02

CCB 1480 1555 1647 1745 1809 1815 1822 1833 2100

Chapter 4: CCB 2048 2049 2050

Chapter 5: ZLL 1.0 errata CCB 2028 2106

Chapter 6: CCB 1823

Chapter 7: CCB 1811 1812 1821 1994 1995 1996 1997 2086

Chapter 8: ZHA 1.2 & 1.2.1 & errata CCB 1977 2045 2044

Chapter 11: CCB 1374 1470 1477 1540 1594 2046 2056

Chapter 15: CCB 1893



TABLE OF CONTENTS

ZigBee Cluster Library Specification .............................................................................................................. 1 Notice of Use and Disclosure ................................................................................................................... 2 Participants ............................................................................................................................................... 3 Document Control .................................................................................................................................... 4 Document History .................................................................................................................................... 5

Table of Contents ............................................................................................................................................ 7

List of Figures ............................................................................................................................................... 17

List of Tables ................................................................................................................................................. 26

Chapter 1 Introduction .............................................................................................................................1-1 1.1 Scope and Purpose .......................................................................................................................1-1 1.2 Acronyms and Abbreviations .......................................................................................................1-1 1.3 Definitions ....................................................................................................................................1-4 1.4 Conformance Levels ....................................................................................................................1-5 1.5 References ....................................................................................................................................1-5

1.5.1 ZigBee Alliance Documents ............................................................................................1-5 1.5.2 International Standards Documents .................................................................................1-5 1.5.3 National Standards Documents ........................................................................................1-5 1.5.4 IEEE Documents .............................................................................................................1-6 1.5.5 ASHRAE Documents ......................................................................................................1-6 1.5.6 Health Care Documents ...................................................................................................1-6 1.5.7 Other Documents .............................................................................................................1-7

1.6 Conventions..................................................................................................................................1-7 1.6.1 Enumerations and Reserved Values .................................................................................1-7 1.6.2 Reserved Bit Fields ..........................................................................................................1-7 1.6.3 Number Format ................................................................................................................1-7

Chapter 2 Foundation ..............................................................................................................................2-1 2.1 Scope and Purpose .......................................................................................................................2-1 2.2 Cluster Library Overview .............................................................................................................2-1

2.2.1 Architecture Model ..........................................................................................................2-1 2.2.2 Client/Server Model .........................................................................................................2-2

2.3 Functional Description .................................................................................................................2-3 2.3.1 Transmission ....................................................................................................................2-3 2.3.2 Reception .........................................................................................................................2-3 2.3.3 Manufacturer Specific Extensions ...................................................................................2-4 2.3.4 Dependencies on Optional Attribute ................................................................................2-4 2.3.5 Attribute Access...............................................................................................................2-4 2.3.6 Persistent Data .................................................................................................................2-5

2.4 Command Frame Formats ............................................................................................................2-6 2.4.1 General ZCL Frame Format ............................................................................................2-6

2.5 General Command Frames ...........................................................................................................2-8 2.5.1 Read Attributes Command ...............................................................................................2-9 2.5.2 Read Attributes Response Command ............................................................................2-10 2.5.3 Write Attributes Command ............................................................................................2-12 2.5.4 Write Attributes Undivided Command ..........................................................................2-13 2.5.5 Write Attributes Response Command ...........................................................................2-13 2.5.6 Write Attributes No Response Command ......................................................................2-14 2.5.7 Configure Reporting Command .....................................................................................2-15



2.5.8 Configure Reporting Response Command .................................................................... 2-18 2.5.9 Read Reporting Configuration Command ..................................................................... 2-19 2.5.10 Read Reporting Configuration Response Command .................................................... 2-20 2.5.11 Report Attributes Command ......................................................................................... 2-22 2.5.12 Default Response Command ......................................................................................... 2-25 2.5.13 Discover Attributes Command ...................................................................................... 2-26 2.5.14 Discover Attributes Response Command ..................................................................... 2-27 2.5.15 Read Attributes Structured Command .......................................................................... 2-28 2.5.16 Write Attributes Structured Command ......................................................................... 2-30 2.5.17 Write Attributes Structured Response Command ......................................................... 2-32 2.5.18 Discover Commands Received Command .................................................................... 2-33 2.5.19 Discover Commands Received Response ..................................................................... 2-34 2.5.20 Discover Commands Generated Command .................................................................. 2-35 2.5.21 Discover Commands Generated Response ................................................................... 2-36 2.5.22 Discover Attributes Extended Command ...................................................................... 2-36 2.5.23 Discover Attributes Extended Response Command ..................................................... 2-37

2.6 Addressing, Types and Enumerations ....................................................................................... 2-39 2.6.1 Addressing .................................................................................................................... 2-39 2.6.2 Data Types .................................................................................................................... 2-40 2.6.3 Status Enumerations ...................................................................................................... 2-50

Chapter 3 General ................................................................................................................................... 3-1 3.1 General Description ..................................................................................................................... 3-1

3.1.1 Introduction ..................................................................................................................... 3-1 3.1.2 Cluster List ...................................................................................................................... 3-1

3.2 Basic ............................................................................................................................................ 3-5 3.2.1 Overview ......................................................................................................................... 3-5 3.2.2 Server .............................................................................................................................. 3-6 3.2.3 Client ............................................................................................................................. 3-13

3.3 Power Configuration ................................................................................................................. 3-13 3.3.1 Overview ....................................................................................................................... 3-13 3.3.2 Server ............................................................................................................................ 3-14 3.3.3 Client ............................................................................................................................. 3-22

3.4 Device Temperature Configuration ........................................................................................... 3-22 3.4.1 Overview ....................................................................................................................... 3-22 3.4.2 Server ............................................................................................................................ 3-23 3.4.3 Client ............................................................................................................................. 3-26

3.5 Identify ...................................................................................................................................... 3-26 3.5.1 Overview ....................................................................................................................... 3-26 3.5.2 Server ............................................................................................................................ 3-26 3.5.3 Client ............................................................................................................................. 3-30

3.6 Groups ....................................................................................................................................... 3-30 3.6.1 Overview ....................................................................................................................... 3-30 3.6.2 Server ............................................................................................................................ 3-31 3.6.3 Client ............................................................................................................................. 3-37

3.7 Scenes ........................................................................................................................................ 3-37 3.7.1 Overview ....................................................................................................................... 3-37 3.7.2 Server ............................................................................................................................ 3-38 3.7.3 Client ............................................................................................................................. 3-51

3.8 On/Off ....................................................................................................................................... 3-51 3.8.1 Overview ....................................................................................................................... 3-51 3.8.2 Server ............................................................................................................................ 3-51 3.8.3 Client ............................................................................................................................. 3-58

3.9 On/Off Switch Configuration .................................................................................................... 3-58 3.9.1 Overview ....................................................................................................................... 3-58 3.9.2 Server ............................................................................................................................ 3-58



3.9.3 Client .............................................................................................................................3-60 3.10 Level Control .............................................................................................................................3-60

3.10.1 Overview .......................................................................................................................3-60 3.10.2 Server .............................................................................................................................3-61 3.10.3 Client .............................................................................................................................3-67

3.11 Alarms ........................................................................................................................................3-67 3.11.1 Overview .......................................................................................................................3-67 3.11.2 Server .............................................................................................................................3-67 3.11.3 Client .............................................................................................................................3-70

3.12 Time ...........................................................................................................................................3-71 3.12.1 Overview .......................................................................................................................3-71 3.12.2 Server .............................................................................................................................3-71 3.12.3 Client .............................................................................................................................3-75

3.13 RSSI Location ............................................................................................................................3-75 3.13.1 Overview .......................................................................................................................3-75 3.13.2 Server .............................................................................................................................3-76 3.13.3 Client .............................................................................................................................3-89

3.14 Input, Output and Value Clusters ...............................................................................................3-89 3.14.1 Overview .......................................................................................................................3-89 3.14.2 Analog Input (Basic) ......................................................................................................3-89 3.14.3 Analog Output (Basic) ...................................................................................................3-90 3.14.4 Analog Value (Basic) ....................................................................................................3-92 3.14.5 Binary Input (Basic) ......................................................................................................3-94 3.14.6 Binary Output (Basic) ....................................................................................................3-95 3.14.7 Binary Value (Basic) .....................................................................................................3-97 3.14.8 Multistate Input (Basic) .................................................................................................3-98 3.14.9 Multistate Output (Basic)............................................................................................. 3-100 3.14.10 Multistate Value (Basic) .............................................................................................. 3-101 3.14.11 Attribute Descriptions .................................................................................................. 3-102

3.15 Diagnostics ............................................................................................................................... 3-138 3.15.1 Overview ..................................................................................................................... 3-138 3.15.2 Server ........................................................................................................................... 3-139 3.15.3 Client ........................................................................................................................... 3-142

3.16 Poll Control .............................................................................................................................. 3-142 3.16.1 Overview ..................................................................................................................... 3-142 3.16.2 Terminology ................................................................................................................ 3-143 3.16.3 Commissioning Process ............................................................................................... 3-144 3.16.4 Server ........................................................................................................................... 3-144 3.16.5 Client ........................................................................................................................... 3-146 3.16.6 Poll Control Cluster Sequence Diagram ...................................................................... 3-149

3.17 Power Profile ............................................................................................................................ 3-151 3.17.1 Overview ..................................................................................................................... 3-151 3.17.2 References ................................................................................................................... 3-152 3.17.3 General Description ..................................................................................................... 3-152 3.17.4 Server Attributes .......................................................................................................... 3-152 3.17.5 Server Commands Received ........................................................................................ 3-154 3.17.6 Server Commands Generated ...................................................................................... 3-161 3.17.7 Client Attributes........................................................................................................... 3-173 3.17.8 Client Commands Received ......................................................................................... 3-173 3.17.9 Client Commands Generated ....................................................................................... 3-173 3.17.10 Example of Device Interactions Using the Power Profile (Informative Section) ........ 3-173

3.18 Meter Identification .................................................................................................................. 3-175 3.18.1 Overview ..................................................................................................................... 3-175 3.18.2 Server ........................................................................................................................... 3-176 3.18.3 Client ........................................................................................................................... 3-179



Chapter 4 Measurement and Sensing ...................................................................................................... 4-1 4.1 General Description ..................................................................................................................... 4-1

4.1.1 Introduction ..................................................................................................................... 4-1 4.1.2 Cluster List ...................................................................................................................... 4-1

4.2 Illuminance Measurement ........................................................................................................... 4-4 4.2.1 Overview ......................................................................................................................... 4-4 4.2.2 Server .............................................................................................................................. 4-5 4.2.3 Client ............................................................................................................................... 4-6

4.3 Illuminance Level Sensing .......................................................................................................... 4-7 4.3.1 Overview ......................................................................................................................... 4-7 4.3.2 Server .............................................................................................................................. 4-7 4.3.3 Client ............................................................................................................................... 4-9

4.4 Temperature Measurement .......................................................................................................... 4-9 4.4.1 Overview ......................................................................................................................... 4-9 4.4.2 Server ............................................................................................................................ 4-10 4.4.3 Client ............................................................................................................................. 4-11

4.5 Pressure Measurement ............................................................................................................... 4-11 4.5.1 Overview ....................................................................................................................... 4-11 4.5.2 Server ............................................................................................................................ 4-12 4.5.3 Client ............................................................................................................................. 4-15

4.6 Flow Measurement .................................................................................................................... 4-15 4.6.1 Overview ....................................................................................................................... 4-15 4.6.2 Server ............................................................................................................................ 4-15 4.6.3 Client ............................................................................................................................. 4-17

4.7 Relative Humidity Measurement ............................................................................................... 4-17 4.7.1 Overview ....................................................................................................................... 4-17 4.7.2 Server ............................................................................................................................ 4-17 4.7.3 Client ............................................................................................................................. 4-19

4.8 Occupancy Sensing ................................................................................................................... 4-19 4.8.1 Overview ....................................................................................................................... 4-19 4.8.2 Server ............................................................................................................................ 4-19 4.8.3 Client ............................................................................................................................. 4-22

4.9 Electrical Measurement ............................................................................................................. 4-22 4.9.1 Overview ....................................................................................................................... 4-22 4.9.2 Server ............................................................................................................................ 4-23

Chapter 5 Lighting .................................................................................................................................. 5-1 5.1 General Description ..................................................................................................................... 5-1

5.1.1 Introduction ..................................................................................................................... 5-1 5.1.2 Terms .............................................................................................................................. 5-1 5.1.3 Cluster List ...................................................................................................................... 5-1

5.2 Color Control Cluster .................................................................................................................. 5-2 5.2.1 Overview ......................................................................................................................... 5-2 5.2.2 Server .............................................................................................................................. 5-3 5.2.3 Client ............................................................................................................................. 5-29

5.3 Ballast Configuration Cluster .................................................................................................... 5-30 5.3.1 Overview ....................................................................................................................... 5-30 5.3.2 Server ............................................................................................................................ 5-30 5.3.3 Client ............................................................................................................................. 5-34 5.3.4 The Dimming Light Curve ............................................................................................ 5-34

Chapter 6 HVAC .................................................................................................................................... 6-1 6.1 General Description ..................................................................................................................... 6-1

6.1.1 Introduction ..................................................................................................................... 6-1 6.1.2 Terms .............................................................................................................................. 6-1 6.1.3 Cluster List ...................................................................................................................... 6-1



6.2 Pump Configuration and Control .................................................................................................6-3 6.2.1 Overview .........................................................................................................................6-3 6.2.2 Server ...............................................................................................................................6-3 6.2.3 Client .............................................................................................................................6-13

6.3 Thermostat .................................................................................................................................6-13 6.3.1 Overview .......................................................................................................................6-13 6.3.2 Server .............................................................................................................................6-13 6.3.3 Client .............................................................................................................................6-32

6.4 Fan Control ................................................................................................................................6-32 6.4.1 Overview .......................................................................................................................6-32 6.4.2 Server .............................................................................................................................6-33 6.4.3 Client .............................................................................................................................6-34

6.5 Dehumidification Control ..........................................................................................................6-34 6.5.1 Overview .......................................................................................................................6-34 6.5.2 Server .............................................................................................................................6-35 6.5.3 Client .............................................................................................................................6-37

6.6 Thermostat User Interface Configuration ...................................................................................6-37 6.6.1 Overview .......................................................................................................................6-37 6.6.2 Server .............................................................................................................................6-38 6.6.3 Client .............................................................................................................................6-40

Chapter 7 Closures ..................................................................................................................................7-1 7.1 General Description......................................................................................................................7-1

7.1.1 Introduction .....................................................................................................................7-1 7.1.2 Cluster List ......................................................................................................................7-1

7.2 Shade Configuration .....................................................................................................................7-2 7.2.1 Overview .........................................................................................................................7-2 7.2.2 Server ...............................................................................................................................7-3 7.2.3 Client ...............................................................................................................................7-5

7.3 Door Lock ....................................................................................................................................7-5 7.3.1 Overview .........................................................................................................................7-5 7.3.2 Server ...............................................................................................................................7-5 7.3.3 Client ..............................................................................................................................7-47

7.4 Window Covering ......................................................................................................................7-47 7.4.1 Overview .......................................................................................................................7-47 7.4.2 Server .............................................................................................................................7-47 7.4.3 Client .............................................................................................................................7-56

Chapter 8 Security and Safety .................................................................................................................8-1 8.1 General Description......................................................................................................................8-1

8.1.1 Introduction .....................................................................................................................8-1 8.1.2 Cluster List ......................................................................................................................8-1

8.2 IAS Zone ......................................................................................................................................8-2 8.2.1 Overview .........................................................................................................................8-2 8.2.2 Server ...............................................................................................................................8-3 8.2.3 Client .............................................................................................................................8-12

8.3 IAS ACE ....................................................................................................................................8-12 8.3.1 Overview .......................................................................................................................8-12 8.3.2 Server .............................................................................................................................8-13 8.3.3 Client .............................................................................................................................8-26

8.4 IAS WD ......................................................................................................................................8-26 8.4.1 Overview .......................................................................................................................8-26 8.4.2 Server .............................................................................................................................8-27 8.4.3 Client .............................................................................................................................8-31

Chapter 9 Protocol Interfaces ..................................................................................................................9-1



9.1 General Description ..................................................................................................................... 9-1 9.1.1 Introduction ..................................................................................................................... 9-1 9.1.2 Cluster List ...................................................................................................................... 9-1

9.2 Generic Tunnel ............................................................................................................................ 9-3 9.2.1 Overview ......................................................................................................................... 9-3 9.2.2 Server .............................................................................................................................. 9-3 9.2.3 Client ............................................................................................................................... 9-5

9.3 BACnet Protocol Tunnel ............................................................................................................. 9-6 9.3.1 Overview ......................................................................................................................... 9-6 9.3.2 Server .............................................................................................................................. 9-6 9.3.3 Client ............................................................................................................................... 9-7

9.4 BACnet Input, Output and Value Clusters .................................................................................. 9-7 9.4.1 Overview ......................................................................................................................... 9-7 9.4.2 Analog Input (BACnet Regular) ..................................................................................... 9-8 9.4.3 Analog Input (BACnet Extended) ................................................................................... 9-9 9.4.4 Analog Output (BACnet Regular) ................................................................................ 9-10 9.4.5 Analog Output (BACnet Extended) .............................................................................. 9-12 9.4.6 Analog Value (BACnet Regular) .................................................................................. 9-13 9.4.7 Analog Value (BACnet Extended) ................................................................................ 9-14 9.4.8 Binary Input (BACnet Regular) .................................................................................... 9-16 9.4.9 Binary Input (BACnet Extended) .................................................................................. 9-17 9.4.10 Binary Output (BACnet Regular) ................................................................................. 9-18 9.4.11 Binary Output (BACnet Extended) ............................................................................... 9-20 9.4.12 Binary Value (BACnet Regular) ................................................................................... 9-21 9.4.13 Binary Value (BACnet Extended) ................................................................................ 9-23 9.4.14 Multistate Input (BACnet Regular) ............................................................................... 9-24 9.4.15 Multistate Input (BACnet Extended) ............................................................................ 9-25 9.4.16 Multistate Output (BACnet Regular) ............................................................................ 9-26 9.4.17 Multistate Output (BACnet Extended) .......................................................................... 9-28 9.4.18 Multistate Value (BACnet Regular) .............................................................................. 9-29 9.4.19 Multistate Value (BACnet Extended) ........................................................................... 9-30 9.4.20 Attributes of BACnet Regular Clusters ......................................................................... 9-31 9.4.21 Attributes of BACnet Extended Clusters ...................................................................... 9-33

9.5 ISO 7818 Protocol Tunnel ......................................................................................................... 9-35 9.5.1 Scope and Purpose ........................................................................................................ 9-35 9.5.2 Definitions..................................................................................................................... 9-35 9.5.3 General Description ...................................................................................................... 9-35 9.5.4 Overview ....................................................................................................................... 9-35 9.5.5 Server ............................................................................................................................ 9-36 9.5.6 Client ............................................................................................................................. 9-38

9.6 Partition ..................................................................................................................................... 9-39 9.6.1 Scope and Purpose ........................................................................................................ 9-39 9.6.2 Introduction ................................................................................................................... 9-39 9.6.3 Server ............................................................................................................................ 9-41 9.6.4 Client ............................................................................................................................. 9-47 9.6.5 General Use of Partition Cluster ................................................................................... 9-47

9.7 11073 Protocol Tunnel .............................................................................................................. 9-49 9.7.1 Overview ....................................................................................................................... 9-49 9.7.2 Server ............................................................................................................................ 9-50 9.7.3 Client ............................................................................................................................. 9-56

Chapter 10 Smart Energy ..................................................................................................................... 10-1 10.1 General Description ................................................................................................................... 10-1

10.1.1 Introduction ................................................................................................................... 10-1 10.1.2 Cluster List .................................................................................................................... 10-1

10.2 Price ........................................................................................................................................... 10-1



10.2.1 Overview .......................................................................................................................10-1 10.2.2 Server .............................................................................................................................10-2 10.2.3 Client............................................................................................................................ 10-21 10.2.4 Application Guidelines ................................................................................................ 10-23

10.3 Demand Response and Load Control .......................................................................................... 10-24 10.3.1 Overview ..................................................................................................................... 10-24 10.3.2 Server ........................................................................................................................... 10-25 10.3.3 Client............................................................................................................................ 10-32 10.3.4 Application Guidelines ................................................................................................ 10-37 10.3.5 Rules and Guidelines for Overlapping Events ............................................................. 10-40

10.4 Metering ................................................................................................................................... 10-47 10.4.1 Overview ..................................................................................................................... 10-47 10.4.2 Server ........................................................................................................................... 10-51 10.4.3 Metering Application Guidelines ................................................................................. 10-84

10.5 Messaging ................................................................................................................................ 10-85 10.5.1 Overview ..................................................................................................................... 10-85 10.5.2 Server ........................................................................................................................... 10-86 10.5.3 Client ........................................................................................................................... 10-89 10.5.4 Application Guidelines ................................................................................................ 10-89

10.6 Tunneling ................................................................................................................................. 10-91 10.6.1 Overview ..................................................................................................................... 10-91 10.6.2 Server ........................................................................................................................... 10-94 10.6.3 Client.......................................................................................................................... 10-103

10.7 Key Establishment ................................................................................................................. 10-103 10.7.1 Scope and Purpose ...................................................................................................... 10-103 10.7.2 General Description ................................................................................................... 10-104 10.7.3 Cluster List ................................................................................................................. 10-106 10.7.4 Application Implementation ...................................................................................... 10-117 10.7.5 Key Establishment Test Vectors ................................................................................ 10-122

Chapter 11 Over-the-Air Upgrading .....................................................................................................11-1 11.1 Introduction ................................................................................................................................11-1

11.1.1 Purpose ..........................................................................................................................11-1 11.1.2 Scope .............................................................................................................................11-1 11.1.3 Terminology ..................................................................................................................11-1

11.2 General Description....................................................................................................................11-1 11.2.1 Introduction ...................................................................................................................11-1 11.2.2 Cluster List ....................................................................................................................11-2

11.3 OTA Upgrade .............................................................................................................................11-3 11.3.1 Overview .......................................................................................................................11-3 11.3.2 Security ..........................................................................................................................11-4 11.3.3 Image Verification .........................................................................................................11-4 11.3.4 Image Transport .............................................................................................................11-5 11.3.5 Image Signature .............................................................................................................11-5 11.3.6 Image Integrity Code .....................................................................................................11-5

11.4 OTA File Format ........................................................................................................................11-6 11.4.1 General Structure ...........................................................................................................11-6 11.4.2 OTA Header Format ......................................................................................................11-6 11.4.3 Sub-element Format ..................................................................................................... 11-10 11.4.4 Tag Identifiers .............................................................................................................. 11-11 11.4.5 ECDSA Signature Sub-element ................................................................................... 11-12 11.4.6 ECDSA Signing Certificate Sub-element .................................................................... 11-12 11.4.7 Image Integrity Code Sub-element .............................................................................. 11-12

11.5 OTA File Naming .................................................................................................................... 11-13 11.6 Signatures ................................................................................................................................. 11-13 11.7 ECDSA Signature Calculation ................................................................................................. 11-13



11.7.1 ECDSA Signature Verification ................................................................................... 11-14 11.7.2 Image Integrity Code .................................................................................................. 11-15

11.8 Discovery of the Upgrade Server ............................................................................................ 11-16 11.8.1 Server and Client ......................................................................................................... 11-16 11.8.2 Sleepy Devices ............................................................................................................ 11-17

11.9 Dependencies ........................................................................................................................... 11-17 11.10 OTA Cluster Attributes ...................................................................................................... 11-17

11.10.1 UpgradeServerID Attribute ......................................................................................... 11-18 11.10.2 FileOffset Attribute ..................................................................................................... 11-18 11.10.3 CurrentFileVersion Attribute ...................................................................................... 11-18 11.10.4 CurrentZigBeeStackVersion Attribute ........................................................................ 11-19 11.10.5 DownloadedFileVersion Attribute .............................................................................. 11-19 11.10.6 DownloadedZigBeeStackVersion Attribute ................................................................. 11-19 11.10.7 ImageUpgradeStatus Attribute ................................................................................... 11-19 11.10.8 Manufacturer ID Attribute .......................................................................................... 11-20 11.10.9 Image Type ID Attribute ............................................................................................. 11-20 11.10.10 MinimumBlockPeriod Attribute .................................................................................. 11-20 11.10.11 Image Stamp Attribute ................................................................................................ 11-20

11.11 OTA Cluster Parameters .................................................................................................... 11-20 11.11.1 QueryJitter Parameter ................................................................................................. 11-21 11.11.2 DataSize Parameter ..................................................................................................... 11-21 11.11.3 OTAImageData Parameter .......................................................................................... 11-21 11.11.4 CurrentTime and UpgradeTime/RequestTime Parameters ......................................... 11-21

11.12 OTA Upgrade Diagram ...................................................................................................... 11-23 11.13 Command Frames .............................................................................................................. 11-24

11.13.1 OTA Cluster Command Identifiers ............................................................................. 11-24 11.13.2 OTA Cluster Status Codes .......................................................................................... 11-25 11.13.3 Image Notify Command .............................................................................................. 11-25 11.13.4 Query Next Image Request Command........................................................................ 11-28 11.13.5 Query Next Image Response Command ..................................................................... 11-30 11.13.6 Image Block Request Command ................................................................................. 11-32 11.13.7 Image Page Request Command .................................................................................. 11-34 11.13.8 Image Block Response Command .............................................................................. 11-37 11.13.9 Upgrade End Request Command ................................................................................ 11-41 11.13.10 Query Device Specific File Request Command .......................................................... 11-45 11.13.11 Query Device Specific File Response Command ....................................................... 11-46

11.14 Multiple Files Required for a Bootload .............................................................................. 11-48 11.14.1 Single OTA File with multiple sub-elements .............................................................. 11-48 11.14.2 Separate OTA Files Upgraded Independently............................................................. 11-48 11.14.3 Multiple OTA Files Dependent on Each Other ........................................................... 11-49

11.15 OTA Upgrade Cluster Management................................................................................... 11-49 11.15.1 Query Upgrade Status ................................................................................................. 11-49 11.15.2 Query Downloaded ZigBee Stack and File Versions .................................................. 11-49 11.15.3 Rate Limiting .............................................................................................................. 11-50 11.15.4 Current Time, Request Time, and MinimumBlockPeriod .......................................... 11-51

11.16 OTA Upgrade Process ........................................................................................................ 11-52 11.17 Application Standard Specific Decisions ........................................................................... 11-52

11.17.1 SE Profile Standard: OTA Upgrade from SE 1.x to SE 2.0 ........................................ 11-53 11.18 OTA Upgrade Recovery..................................................................................................... 11-53

Chapter 12 Telecommunications .......................................................................................................... 12-1 12.1 General Description ................................................................................................................... 12-1

12.1.1 Introduction ................................................................................................................... 12-1 12.1.2 Cluster List .................................................................................................................... 12-1

12.2 Information ................................................................................................................................ 12-1 12.2.1 Scope and Purpose ........................................................................................................ 12-1



12.2.2 Cluster List ....................................................................................................................12-2 12.2.3 Overview .......................................................................................................................12-4 12.2.4 Server .............................................................................................................................12-4 12.2.5 Client ........................................................................................................................... 12-20 12.2.6 Payload Formats for Contents Data ............................................................................. 12-20

12.3 Chatting .................................................................................................................................... 12-24 12.3.1 Introduction ................................................................................................................. 12-24 12.3.2 Server ........................................................................................................................... 12-25 12.3.3 Client ........................................................................................................................... 12-35

12.4 Voice Over ZigBee .................................................................................................................. 12-36 12.4.1 Scope and Purpose ....................................................................................................... 12-36 12.4.2 Overview ..................................................................................................................... 12-36 12.4.3 Server ........................................................................................................................... 12-37 12.4.4 Client ........................................................................................................................... 12-44

Chapter 13 Commissioning ...................................................................................................................13-1 13.1 General Description....................................................................................................................13-1

13.1.1 Introduction .......................................................................................................................13-1 13.1.2 Cluster List ........................................................................................................................13-1

13.2 Commissioning ..........................................................................................................................13-1 13.2.1 Overview .......................................................................................................................13-1 13.2.2 Server .............................................................................................................................13-3 13.2.3 Client ........................................................................................................................... 13-17 13.2.4 ZigBee Alliance EUI-64s............................................................................................. 13-17

13.3 Touchlink Commissioning ....................................................................................................... 13-18 13.3.1 Overview ..................................................................................................................... 13-19 13.3.2 Server ........................................................................................................................... 13-19 13.3.3 Client ........................................................................................................................... 13-45 13.3.4 Functional Description ................................................................................................. 13-46

Chapter 14 Retail ..................................................................................................................................14-1 14.1 General Description....................................................................................................................14-1

14.1.1 Introduction ...................................................................................................................14-1 14.1.2 Cluster List ....................................................................................................................14-1

14.2 Retail Tunnel (MSP Tunnel) ......................................................................................................14-1 14.2.1 Overview .......................................................................................................................14-1 14.2.2 Server .............................................................................................................................14-2 14.2.3 Client .............................................................................................................................14-4

14.3 Mobile Device Configuration .....................................................................................................14-4 14.3.1 Overview .......................................................................................................................14-4 14.3.2 Server .............................................................................................................................14-5 14.3.3 Client .............................................................................................................................14-6

14.4 Neighbor Cleaning .....................................................................................................................14-6 14.4.1 Overview .......................................................................................................................14-6 14.4.2 Server .............................................................................................................................14-7 14.4.3 Client .............................................................................................................................14-8

14.5 Nearest Gateway ........................................................................................................................14-9 14.5.1 Overview .......................................................................................................................14-9 14.5.2 Server .............................................................................................................................14-9 14.5.3 Client ........................................................................................................................... 14-10 14.5.4 Examples of Use .......................................................................................................... 14-10

Chapter 15 Appliances ..........................................................................................................................15-1 15.1 General Description....................................................................................................................15-1

15.1.1 Introduction ...................................................................................................................15-1 15.1.2 Cluster List ....................................................................................................................15-1



15.2 EN50523 Appliance Control ..................................................................................................... 15-1 15.2.1 Overview ....................................................................................................................... 15-1 15.2.2 General Description ...................................................................................................... 15-2 15.2.3 Server Attributes ........................................................................................................... 15-2 15.2.4 Server Commands Received ......................................................................................... 15-4 15.2.5 Server Commands Generated ........................................................................................ 15-7 15.2.6 Client ........................................................................................................................... 15-10

15.3 EN50523 Appliance Identification .......................................................................................... 15-10 15.3.1 Overview ..................................................................................................................... 15-10 15.3.2 Server .......................................................................................................................... 15-11 15.3.3 Client ........................................................................................................................... 15-14

15.4 EN50523 Appliance Events and Alerts ................................................................................... 15-15 15.4.1 Overview ..................................................................................................................... 15-15 15.4.2 Server .......................................................................................................................... 15-16 15.4.3 Client ........................................................................................................................... 15-19

15.5 Appliance Statistics ................................................................................................................. 15-20 15.5.1 Overview ..................................................................................................................... 15-20 15.5.2 Server .......................................................................................................................... 15-21 15.5.3 Client ........................................................................................................................... 15-23 15.5.4 Appliance Statistics Cluster Sequence Diagram ......................................................... 15-24



LIST OF FIGURES Figure 2-1. The ZCL Client Server Model ...................................................................................................2-2 Figure 2-2. Format of the General ZCL Frame ............................................................................................2-6 Figure 2-3. Format of the Frame Control Field ............................................................................................2-6 Figure 2-4. Values of the Frame Type Sub-field ..........................................................................................2-6 Figure 2-5. Format of the Read Attributes Command Frame .......................................................................2-9 Figure 2-6. Format of Read Attributes Response Command Frame ..........................................................2-10 Figure 2-7. Format of the Read Attributes Status Record Field .................................................................2-10 Figure 2-8. Format of the Attribute Value Field for an Array, Set or Bag .................................................2-11 Figure 2-9. Format of the Attribute Value Field for a Structure .................................................................2-11 Figure 2-10. Format of the Write Attributes Command Frame ..................................................................2-12 Figure 2-11. Format of the Write Attribute Record Field ..........................................................................2-12 Figure 2-12. Format of Write Attributes Response Command Frame ........................................................2-13 Figure 2-13. Format of the Write Attribute Status Record Field ................................................................2-14 Figure 2-14. Write Attributes No Response Command Frame ..................................................................2-14 Figure 2-15. Format of the Configure Reporting Command Frame ...........................................................2-16 Figure 2-16. Format of the Attribute Reporting Configuration Record ......................................................2-16 Figure 2-17. Format of the Configure Reporting Response Command Frame ...........................................2-19 Figure 2-18. Format of the Attribute Status Record Field ..........................................................................2-19 Figure 2-19. Read Reporting Configuration Command Frame ..................................................................2-20 Figure 2-20. Format of the Attribute Status Record Field ..........................................................................2-20 Figure 2-21. Format of the Read Reporting Configuration Response Command Frame ...........................2-21 Figure 2-22. Attribute Reporting Configuration Record Field ...................................................................2-21 Figure 2-23. Format of the Report Attributes Command Frame ................................................................2-23 Figure 2-24. Format of the Attribute Report Fields ....................................................................................2-23 Figure 2-25. Format of the Default Response Command Frame ................................................................2-25 Figure 2-26. Format of the Discover Attributes Command Frame .............................................................2-26 Figure 2-27. Discover Attributes Response Command Frame ...................................................................2-27 Figure 2-28. Format of the Attribute Report Fields ....................................................................................2-27 Figure 2-29. Format of Read Attributes Structured Command Frame .......................................................2-28 Figure 2-30. Format of the Selector Field ..................................................................................................2-29 Figure 2-31. Write Attributes Structured Command Frame .......................................................................2-30 Figure 2-32. Format of the Write Attribute Record Field ..........................................................................2-30 Figure 2-33. Format of the Selector Field ..................................................................................................2-30 Figure 2-34. Write Attributes Structured Response Command Frame .......................................................2-32 Figure 2-35. Format of the Write Attribute Status Record Field ................................................................2-33 Figure 2-36. Format of the Discover Server Commands Command Frame ...............................................2-34 Figure 2-37. Format of the Discover Commands Received Response Frame ............................................2-35 Figure 2-38. Format of the Discover Attributes Extended Command Frame .............................................2-36 Figure 2-39. Format of the Discover Attributes Extended Response Command Frame ............................2-37 Figure 2-40. Format of the Extended Attribute Information Fields............................................................2-38 Figure 2-41. Format of the Attribute Access Control Field ........................................................................2-38 Figure 2-42. Format of the ZigBee Semi-precision Number ......................................................................2-44 Figure 2-43. Format of the Octet String Type ............................................................................................2-46 Figure 2-44. Format of the Character String Type .....................................................................................2-46 Figure 2-45. Format of the Long Octet String Type ...................................................................................2-46 Figure 2-46. Format of the Long Character String Type ............................................................................2-47 Figure 2-47. Format of the Time of Day Type ...........................................................................................2-48 Figure 2-48. Format of the Date Type ........................................................................................................2-49 Figure 3-1. Typical Usage of Device Configuration and Installation Clusters .............................................3-2 Figure 3-2. Typical Usage of On/Off and Level Control Clusters ...............................................................3-3 Figure 3-3. Typical Usage of the Alarms Cluster .........................................................................................3-3 Figure 3-4. Typical Usage of the Location Cluster with Centralized Device ...............................................3-4



Figure 3-5. Example Usage of the Input, Output and Value Clusters .......................................................... 3-5 Figure 3-6. Format of Identify Query Response Command Payload ......................................................... 3-27 Figure 3-7. Format of the Trigger Effect Command .................................................................................. 3-28 Figure 3-8. Format of Identify Query Response Command Payload ......................................................... 3-29 Figure 3-9. Format of the Add Group Command Payload ........................................................................ 3-33 Figure 3-10. Format of the View Group Command Payload ..................................................................... 3-33 Figure 3-11. Format of Get Group Membership Command Payload ........................................................ 3-33 Figure 3-13. Add Group If Identifying Command Payload ....................................................................... 3-35 Figure 3-14. Format of the Add Group Response Command Payload ...................................................... 3-36 Figure 3-15. Format of the View Group Response Command Payload .................................................... 3-36 Figure 3-

Date post:	10-Feb-2020
Category:	Documents
Upload:	others
View:	17 times
Download:	0 times