ZigBee Cluster Library

Document 075123r01ZB

1
2
3
4
5
6
7
8
9
10
11

ZIGBEE CLUSTER LIBRARY 12

13
14

SPECIFICATION 15
16
17
18
19
20
21
ZigBee Document 075123r01ZB 22
23
October 19, 2007 7:34 pm
24
Sponsored by: ZigBee Alliance 25
Accepted by This document has been accepted for release by the ZigBee Alliance Board 26
of Directors. 27
28
Abstract This document defines the ZigBee Cluster Library.
29
Keywords ZigBee, Profile, Application Framework, ZCL 30
31
32
33
34
35
36
October 19, 2007 37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 PARTICIPANTS 1
2
3
4
The following is a list of those who were members of the ZigBee Alliance 5
Application Framework Working Group leadership when this document was 6
released: 7
Phil Jamieson: Chair 8
9
Don Sturek: Editor-in-chief 10
Drew Gislason: Secretary 11
12
Matt Maupin: Project manager 13
David Clark: ZCL technical editor 14
15
16
Contributions were made to this document from the following members: 17
18
19
Table 1: 20
David Clark Ted Humpal Jens Klostergaard Zachary Smith 21
Lyngsø 22
Ettore Colicchio Phil Jamieson Marco Naeve Don Sturek 23
24
Kent Crouse William Keith Philip Orlik Urban Wicklander
25
Tim Gillman Tom Klein Isaac Pinhas Walter Young 26
Drew Gislason Jared Lemke Phil Rudland 27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB i

NOTICE OF USE AND DISCLOSURE 1

2
3
4
The ZigBee Specification is available to individuals, companies and institutions free of
charge for all non-commercial purposes (including university research, technical 5
evaluation, and development of non-commercial software, tools, or documentation). No 6
part of this specification may be used in development of a product for sale without 7
becoming a member of ZigBee Alliance.
8
Copyright © ZigBee Alliance, Inc. (2007). All rights Reserved. This information within this 9
document is the property of the ZigBee Alliance and its use and disclosure are restricted. 10
Elements of ZigBee Alliance specifications may be subject to third party intellectual 11
property rights, including without limitation, patent, copyright or trademark rights (such a 12
third party may or may not be a member of ZigBee). ZigBee is not responsible and shall not 13
be held responsible in any manner for identifying or failing to identify any or all such third
party intellectual property rights. 14
15
This document and the information contained herein are provided on an “AS IS” basis and 16
ZigBee DISCLAIMS ALL WARRANTIES EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO (A) ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN 17
WILL NOT INFRINGE ANY RIGHTS OF THIRD PARTIES (INCLUDING WITHOUT 18
LIMITATION ANY INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT, 19
COPYRIGHT OR TRADEMARK RIGHTS) OR (B) ANY IMPLIED WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR NON- 20
INFRINGEMENT. IN NO EVENT WILL ZIGBEE BE LIABLE FOR ANY LOSS OF 21
PROFITS, LOSS OF BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF 22
BUSINESS, OR FOR ANY OTHER DIRECT, INDIRECT, SPECIAL OR EXEMPLARY,
INCIDENTIAL, PUNITIVE OR CONSEQUENTIAL DAMAGES OF ANY KIND, IN 23
CONTRACT OR IN TORT, IN CONNECTION WITH THIS DOCUMENT OR THE 24
INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF 25
SUCH LOSS OR DAMAGE. All Company, brand and product names may be trademarks
that are the sole property of their respective owners. 26
27
The above notice and this paragraph must be included on all copies of this document that 28
are made.
29
ZigBee Alliance, Inc. 30
2400 Camino Ramon, Suite 375 31
San Ramon, CA 94583
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
ii Notice of Use and Disclosure

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
This page is intentionally blank 22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB iii

TABLE OF CONTENTS 1
2
3
4
Participants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 5
Notice of Use and Disclosure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i 6
7
List of Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix 8
List of Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv 9
10
Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 11
1.1 Scope and Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 12
1.2 Acronyms and Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 13
1.3 Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 14
1.3.1 ZigBee Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 15
16
1.3.2 Application Domain Definitions . . . . . . . . . . . . . . . . . . . . . . 2
17
1.4 Conformance Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 18
1.5 References. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 19
1.5.1 Zigbee Alliance Documents. . . . . . . . . . . . . . . . . . . . . . . . . . 3 20
1.5.2 European Standards Documents . . . . . . . . . . . . . . . . . . . . . . 3 21
1.5.3 IEEE Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 22
23
1.5.4 ASHRAE Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
24
Chapter 2 Foundation Specification . . . . . . . . . . . . . . . . . . . . . . . . . 5 25
2.1 Scope and Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 26
2.2 Cluster Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 27
28
2.2.1 Client/Server Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
29
2.2.2 Functional Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 30
2.3 Command Frame Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 31
2.3.1 General ZCL Frame Format . . . . . . . . . . . . . . . . . . . . . . . . . 11 32
2.4 General Command Frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 33
2.4.1 Read Attributes Command. . . . . . . . . . . . . . . . . . . . . . . . . . . 14 34
35
2.4.2 Read Attributes Response Command . . . . . . . . . . . . . . . . . . 16
36
2.4.3 Write Attributes Command . . . . . . . . . . . . . . . . . . . . . . . . . . 18 37
2.4.4 Write Attributes Undivided Command . . . . . . . . . . . . . . . . . 20 38
2.4.5 Write Attributes Response Command . . . . . . . . . . . . . . . . . . 20 39
2.4.6 Write Attributes No Response Command . . . . . . . . . . . . . . . 21 40
2.4.7 Configure Reporting Command. . . . . . . . . . . . . . . . . . . . . . . 23 41
42
2.4.8 Configure Reporting Response Command . . . . . . . . . . . . . . 27
43
2.4.9 Read Reporting Configuration Command . . . . . . . . . . . . . . . 28 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
iv Table of Contents

2.4.10 Read Reporting Configuration Response Command. . . . . . 29

1
2.4.11 Report Attributes Command . . . . . . . . . . . . . . . . . . . . . . . . 32
2
2.4.12 Default Response Command . . . . . . . . . . . . . . . . . . . . . . . . 35 3
2.4.13 Discover Attributes Command . . . . . . . . . . . . . . . . . . . . . . 36 4
2.4.14 Discover Attributes Response Command . . . . . . . . . . . . . . 38 5
2.5 Addressing, Types and Enumerations . . . . . . . . . . . . . . . . . . . . . . 39 6
2.5.1 Addressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 7
8
2.5.2 Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
9
2.5.3 Status Enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 10
2.6 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 11
2.6.1 Transmission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 12
2.6.2 Reception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 13
2.6.3 Manufacturer Specific Extensions . . . . . . . . . . . . . . . . . . . . . 51 14
15
Chapter 3 General Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 16
3.1 General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 17
3.1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 18
3.1.2 Cluster List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 19
20
3.2 Basic Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
21
3.2.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 22
3.2.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 23
3.2.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 24
3.3 Power Configuration Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 25
3.3.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 26
27
3.3.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
28
3.3.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 29
3.4 Device Temperature Configuration Cluster . . . . . . . . . . . . . . . . . . 70 30
3.4.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 31
3.4.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 32
3.4.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 33
34
3.5 Identify Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
35
3.5.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 36
3.5.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 37
3.5.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 38
3.6 Groups Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 39
3.6.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 40
41
3.6.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
42
3.6.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 43
3.7 Scenes Cluster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB v

3.7.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
1
3.7.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
2
3.7.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 3
3.8 On/Off Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 4
3.8.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 5
3.8.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 6
3.8.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 7
8
3.9 On/Off Switch Configuration Cluster. . . . . . . . . . . . . . . . . . . . . . . 104
9
3.9.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 10
3.9.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 11
3.9.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 12
3.10 Level Control Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 13
3.10.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 14
15
3.10.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
16
3.10.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 17
3.11 Alarms Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 18
3.11.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 19
3.11.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 20
3.11.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 21
22
3.12 Time Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
23
3.12.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 24
3.12.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 25
3.12.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 26
3.13 Rssi Location Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 27
3.13.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 28
29
3.13.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
30
Chapter 4 Measurement and Sensing Specification . . . . . . . . . . . . 137 31
4.1 General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 32
4.1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 33
34
4.1.2 Cluster List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
35
4.2 Illuminance Measurement Cluster . . . . . . . . . . . . . . . . . . . . . . . . . 140 36
4.2.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 37
4.2.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 38
4.2.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 39
4.3 Illuminance Level Sensing Cluster . . . . . . . . . . . . . . . . . . . . . . . . . 143 40
41
4.3.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
42
4.3.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 43
4.3.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
vi Table of Contents

4.4 Temperature Measurement Cluster. . . . . . . . . . . . . . . . . . . . . . . . . 147

1
4.4.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
2
4.4.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 3
4.4.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 4
4.5 Pressure Measurement Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 5
4.5.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 6
4.5.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 7
8
4.5.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
9
4.6 Flow Measurement Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 10
4.6.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 11
4.6.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 12
4.6.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 13
4.7 Relative Humidity Measurement Cluster . . . . . . . . . . . . . . . . . . . . 156 14
15
4.7.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
16
4.7.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 17
4.7.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 18
4.8 Occupancy Sensing Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 19
4.8.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 20
4.8.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 21
22
4.8.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
23
Chapter 5 Lighting Specification. . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 24
5.1 General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 25
5.1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 26
27
5.1.2 Cluster List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
28
5.2 Color Control Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 29
5.2.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 30
5.2.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 31
5.2.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 32
5.3 Ballast Configuration Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 33
34
5.3.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
35
5.3.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 36
5.3.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 37
5.3.4 The Dimming Light Curve . . . . . . . . . . . . . . . . . . . . . . . . . . 182 38
39
Chapter 6 HVAC Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
40
6.1 General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 41
6.1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 42
6.1.2 Cluster List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 43
6.2 Pump Configuration and Control Cluster . . . . . . . . . . . . . . . . . . . . 185 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB vii

6.2.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

1
6.2.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
2
6.2.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 3
6.3 Thermostat Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 4
6.3.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 5
6.3.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 6
6.3.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 7
8
6.4 Fan Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
9
6.4.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 10
6.4.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 11
6.4.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 12
6.5 Dehumidification Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 13
6.5.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 14
15
6.5.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
16
6.5.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 17
6.6 Thermostat User Interface Configuration Cluster. . . . . . . . . . . . . . 217 18
6.6.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 19
6.6.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 20
6.6.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 21
22
Chapter 7 Closures Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 23
7.1 General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 24
7.1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 25
7.1.2 Cluster List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 26
27
7.2 Shade Configuration Cluster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
28
7.2.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 29
7.2.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 30
7.2.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 31
32
Chapter 8 Security and Safety Specification . . . . . . . . . . . . . . . . . . 227
33
8.1 General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 34
8.1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 35
8.1.2 Cluster List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 36
8.2 IAS Zone Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 37
8.2.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 38
39
8.2.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
40
8.2.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 41
8.3 IAS ACE Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 42
8.3.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 43
8.3.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
viii Table of Contents

8.3.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

1
8.4 IAS WD Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
2
8.4.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 3
8.4.2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 4
8.4.3 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB ix

LIST OF TABLES 1
2
3
4
Table 2.1 Functional Domains Defined in the ZCL . . . . . . . . . . . . . . 7 5
Table 2.2 Clusters Specified by the General Functional Domain . . . 7 6
Table 2.3 Clusters Specified by the Closures Functional Domain . . . 8 7
Table 2.4 Clusters Specified by the HVAC Functional Domain . . . . 9 8
Table 2.5 Clusters Specified by the Lighting Functional Domain . . . 9 9
10
Table 2.6 Clusters Specified by the Measurement and Sensing
11
Functional Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 12
Table 2.7 Clusters Specified by the Security and Safety 13
Functional Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 14
Table 2.8 ZCL Command Frames . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 15
Table 2.9 Valid Profile Identifier Values . . . . . . . . . . . . . . . . . . . . . . 40 16
17
Table 2.10 Valid Device Identifier Values . . . . . . . . . . . . . . . . . . . . 40
18
Table 2.11 Valid Cluster Identifier Values . . . . . . . . . . . . . . . . . . . . 40 19
Table 2.12 Valid ZCL Defined Attribute Identifier Values . . . . . . . . 41 20
Table 2.13 Valid ZCL Defined Command Identifier Values . . . . . . . 41 21
Table 2.14 Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 22
Table 2.15 Enumerated Status Values Used in the ZCL . . . . . . . . . . 49 23
24
Table 3.1 Device Configuration and Installation Clusters . . . . . . . . . 53
25
Table 3.2 Groups and Scenes Clusters . . . . . . . . . . . . . . . . . . . . . . . . 54 26
Table 3.3 On/Off and Level Control Clusters . . . . . . . . . . . . . . . . . . 55 27
Table 3.4 Alarms Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 28
Table 3.5 Other Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 29
Table 3.6 General Attribute Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 30
31
Table 3.7 Attributes of the Basic Device Information Attribute Set . 57
32
Table 3.8 Values of the PowerSource Attribute . . . . . . . . . . . . . . . . . 59 33
Table 3.9 Attributes of the Device Configuration Attribute Set . . . . 60 34
Table 3.10 Values of the PhysicalEnvironment Attribute . . . . . . . . . 60 35
Table 3.11 Values of the DeviceEnable Attribute . . . . . . . . . . . . . . . 61 36
Table 3.12 Values of the AlarmMask Attribute . . . . . . . . . . . . . . . . . 61 37
38
Table 3.13 Received Command IDs for the Basic Cluster . . . . . . . . 62
39
Table 3.14 Power Configuration Attribute Sets . . . . . . . . . . . . . . . . . 63 40
Table 3.15 Attributes of the Mains Information Attribute Set . . . . . . 64 41
Table 3.16 Attributes of the Mains Settings Attribute Set . . . . . . . . . 65 42
Table 3.17 Values of the MainsAlarmMask Attribute . . . . . . . . . . . . 65 43
44
45
Copyright © 2007ZigBee Standards Organization. All rights reserved.
x List of Tables

Table 3.18 Attributes of the Battery Information Attribute Set . . . . . 67

1
Table 3.19 Attributes of the Battery Information Attribute Set . . . . . 68
2
Table 3.20 Values of the BatterySize Attribute . . . . . . . . . . . . . . . . . 68 3
Table 3.21 Values of the MainsAlarmMask Attribute . . . . . . . . . . . . 69 4
Table 3.22 Device Temperature Configuration Attribute Sets . . . . . 71 5
Table 3.23 Attributes of the Device Temperature Information 6
Attribute Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 7
8
Table 3.24 Attributes of the Device Temperature Settings
9
Attribute Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 10
Table 3.25 Values of the DeviceTempAlarmMask Attribute . . . . . . 73 11
Table 3.26 Attributes of the Identify Server Cluster . . . . . . . . . . . . . 76 12
Table 3.27 Received Command IDs for the Identify Cluster . . . . . . . 76 13
Table 3.28 Generated Command IDs for the Identify Cluster . . . . . . 77 14
15
Table 3.29 Attributes of the Groups Server Cluster . . . . . . . . . . . . . . 80
16
Table 3.30 Received Command IDs for the Groups Cluster . . . . . . . 81 17
Table 3.31 Generated Command IDs for the Groups Cluster . . . . . . 85 18
Table 3.32 Scenes Attribute Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 19
Table 3.33 Attributes of the Scene Management Information 20
Attribute Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 21
22
Table 3.34 Fields of a Scene Table Entry . . . . . . . . . . . . . . . . . . . . . 91
23
Table 3.35 Received Command IDs for the Scenes Cluster . . . . . . . 92 24
Table 3.36 Generated Command IDs for the Scenes Cluster . . . . . . . 96 25
Table 3.37 Attributes of the On/Off Server Cluster . . . . . . . . . . . . . . 102 26
Table 3.38 Command IDs for the On/Off Cluster . . . . . . . . . . . . . . . 102 27
Table 3.39 On/Off Switch Configuration Attribute Sets . . . . . . . . . . 104 28
29
Table 3.40 Attributes of the Switch Information Attribute Set . . . . . 105
30
Table 3.41 Values of the SwitchType Attribute . . . . . . . . . . . . . . . . . 105 31
Table 3.42 Attributes of the Switch Settings Attribute Set . . . . . . . . 105 32
Table 3.43 Values of the SwitchActions Attribute . . . . . . . . . . . . . . 106 33
Table 3.44 Actions on Receipt for On/Off Commands, 34
When Associated With Level Control . . . . . . . . . . . . . . . . . . . . . 108 35
36
Table 3.45 Attributes of the Level Control Server Cluster . . . . . . . . 109
37
Table 3.46 Command IDs for the Level Control Cluster . . . . . . . . . . 110 38
Table 3.47 Values of the Move Mode Field . . . . . . . . . . . . . . . . . . . 111 39
Table 3.48 Actions on Receipt for Move Command . . . . . . . . . . . . . 112 40
Table 3.49 Values of the Step Mode Field . . . . . . . . . . . . . . . . . . . . . 112 41
Table 3.50 Actions on Receipt for Step Command . . . . . . . . . . . . . . 113 42
43
Table 3.51 Alarms Cluster Attribute Sets . . . . . . . . . . . . . . . . . . . . . 115
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB xi

Table 3.52 Attributes of the Alarm Information Attribute Set . . . . . . 115

1
Table 3.53 Format of the Alarm Table . . . . . . . . . . . . . . . . . . . . . . . . 116
2
Table 3.54 Received Command IDs for the Alarms Cluster . . . . . . . 117 3
Table 3.55 Generated Command IDs for the Alarms Cluster . . . . . . 118 4
Table 3.56 Attributes of the On/Off Server Cluster . . . . . . . . . . . . . . 120 5
Table 3.57 Bit Values of the TimeStatus Attribute . . . . . . . . . . . . . . 121 6
Table 3.58 Location Attribute Sets . . . . . . . . . . . . . . . . . . . . . . . . . . 122 7
8
Table 3.59 Attributes of the Location Information Attribute Set . . . . 123
9
Table 3.60 Bit Values of the LocationType Attribute . . . . . . . . . . . . 123 10
Table 3.61 Values of the LocationMethod Attribute . . . . . . . . . . . . . 124 11
Table 3.62 Attributes of the Location Settings Attribute Set . . . . . . . 125 12
Table 3.63 Received Command IDs for the Location Cluster . . . . . . 127 13
Table 3.64 Generated Command IDs for the Location Cluster . . . . . 132 14
15
Table 4.1 Illuminance Measurement and Level Sensing Clusters . . . 138
16
Table 4.2 Pressure and Flow Measurement Clusters . . . . . . . . . . . . . 139 17
Table 4.3 Occupancy Sensing Clusters . . . . . . . . . . . . . . . . . . . . . . . 139 18
Table 4.4 Illuminance Measurement Attribute Sets . . . . . . . . . . . . . . 141 19
Table 4.5 Attributes of the Illuminance Measurement 20
Information Attribute Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 21
22
Table 4.6 Values of the LightSensorType Attribute . . . . . . . . . . . . . 142
23
Table 4.7 Illuminance Level Sensing Attribute Sets . . . . . . . . . . . . . 144 24
Table 4.8 Attributes of the Illuminance Level Sensing Information 25
Attribute Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 26
Table 4.9 Values of the LevelStatus Attribute . . . . . . . . . . . . . . . . . . 144 27
Table 4.10 Values of the LightSensorType Attribute . . . . . . . . . . . . 145 28
29
Table 4.11 Attributes of the Illuminance Level Sensing Settings
30
Attribute Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 31
Table 4.12 Temperature Measurement Attribute Sets . . . . . . . . . . . . 147 32
Table 4.13 Attributes of the Temperature Measurement 33
Information Attribute Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 34
Table 4.14 Pressure Measurement Attribute Sets . . . . . . . . . . . . . . . 150 35
36
Table 4.15 Attributes of the Pressure Measurement Information
37
Attribute Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 38
Table 4.16 Flow Measurement Attribute Sets . . . . . . . . . . . . . . . . . . 153 39
Table 4.17 Attributes of the Flow Measurement Information 40
Attribute Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 41
Table 4.18 Relative Humidity Measurement Attribute Sets . . . . . . . 156 42
43
44
45
Copyright © 2007ZigBee Standards Organization. All rights reserved.
xii List of Tables

Table 4.19 Attributes of the Relative Humidity Measurement

1
Information Attribute Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
2
Table 4.20 Occupancy Sensor Attribute Sets . . . . . . . . . . . . . . . . . . . 159 3
Table 4.21 Attributes of the Occupancy Sensor Information 4
Attribute Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 5
Table 4.22 Values of the OccupancySensorType Attribute . . . . . . . . 160 6
Table 4.23 Attributes of the PIR Configuration Attribute Set . . . . . . 161 7
8
Table 4.24 Attributes of the Ultrasonic Configuration Attribute Set . 161
9
Table 5.1 Clusters Specified for the Lighting Functional Domain . . 163 10
Table 5.2 Hue Control Attribute Sets . . . . . . . . . . . . . . . . . . . . . . . . . 165 11
Table 5.3 Attributes of the Color Information Attribute Set . . . . . . . 165 12
Table 5.4 Command IDs for the Hue Light Control Cluster . . . . . . . 166 13
Table 5.5 Values of the Direction Field . . . . . . . . . . . . . . . . . . . . . . . 167 14
15
Table 5.6 Values of the Move Mode Field . . . . . . . . . . . . . . . . . . . . 168
16
Table 5.7 Actions on Receipt for Move Command . . . . . . . . . . . . . . 169 17
Table 5.8 Values of the Step Mode Field . . . . . . . . . . . . . . . . . . . . . . 169 18
Table 5.9 Actions on Receipt for Step Command . . . . . . . . . . . . . . . 170 19
Table 5.10 Values of the Move Mode Field . . . . . . . . . . . . . . . . . . . 171 20
Table 5.11 Actions on Receipt for Move Command . . . . . . . . . . . . . 172 21
22
Table 5.12 Values of the Step Mode Field . . . . . . . . . . . . . . . . . . . . . 172
23
Table 5.13 Actions on Receipt for Step Command . . . . . . . . . . . . . . 173 24
Table 5.14 Ballast Configuration Attribute Sets . . . . . . . . . . . . . . . . 175 25
Table 5.15 Attributes of the Ballast Information Attribute Set . . . . . 176 26
Table 5.16 Bit Usage of the BallastStatus Attribute . . . . . . . . . . . . . 177 27
Table 5.17 Attributes of the Ballast Settings Attribute Set . . . . . . . . 177 28
29
Table 5.18 Values of the PowerOnLevel Attribute . . . . . . . . . . . . . . 178
30
Table 5.19 Attributes of the Lamp Information Attribute Set . . . . . . 179 31
Table 5.20 Attributes of the Lamp Settings Attribute Set . . . . . . . . . 180 32
Table 5.21 Values of the MainsAlarmMode Attribute . . . . . . . . . . . 181 33
Table 6.1 Clusters Specified in the HVAC Functional Domain . . . . 183 34
Table 6.2 Pump Configuration Attribute Sets . . . . . . . . . . . . . . . . . . 186 35
36
Table 6.3 Attributes of the Pump Information Attribute Set . . . . . . . 186
37
Table 6.4 Attributes of the Pump Dynamic Information Attribute Set 190 38
Table 6.5 Values of the PumpStatus Attribute . . . . . . . . . . . . . . . . . . 191 39
Table 6.6 Attributes of the Pump Settings Attribute Set . . . . . . . . . . 194 40
Table 6.7 Values of the OperationMode Attribute . . . . . . . . . . . . . . . 196 41
Table 6.8 Values of the ControlMode Attribute . . . . . . . . . . . . . . . . 197 42
43
Table 6.9 Alarm Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB xiii

Table 6.10 Currently Defined Thermostat Attribute Sets . . . . . . . . . 200

1
Table 6.11 Attributes of the Thermostat Information Attribute Set . . 201
2
Table 6.12 Attributes of the Thermostat Settings Attribute Set . . . . 203 3
Table 6.13 RemoteSensing Attribute Bit Values . . . . . . . . . . . . . . . . 206 4
Table 6.14 ControlSequenceOfOperation Attribute Values . . . . . . . 207 5
Table 6.15 SystemMode Attribute Values . . . . . . . . . . . . . . . . . . . . . 207 6
Table 6.16 Interpretation of SystemMode Values . . . . . . . . . . . . . . . 208 7
8
Table 6.17 Alarm Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
9
Table 6.18 Command IDs for the Thermostat Cluster . . . . . . . . . . . . 208 10
Table 6.19 Mode field Values for the Setpoint Raise/Lower 11
Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 12
Table 6.20 Attributes of the Fan Control Cluster . . . . . . . . . . . . . . . . 211 13
Table 6.21 FanMode Attribute Values . . . . . . . . . . . . . . . . . . . . . . . . 211 14
15
Table 6.22 FanSequenceOperation Attribute Values . . . . . . . . . . . . 212
16
Table 6.23 Dehumidification Control Attribute Sets . . . . . . . . . . . . . 213 17
Table 6.24 Attributes of the Dehumidification Information 18
Attribute Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 19
Table 6.25 Attributes of the Dehumidification Settings Attribute Set 215 20
Table 6.26 RelativeHumidityMode Attribute Values . . . . . . . . . . . . 215 21
22
Table 6.27 DehumidificationLockout Attribute Values . . . . . . . . . . 216
23
Table 6.28 RelativeHumidityMode Attribute Values . . . . . . . . . . . . 216 24
Table 6.29 Attributes of the Thermostat User Interface 25
Configuration Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 26
Table 6.30 DisplayMode Attribute Values . . . . . . . . . . . . . . . . . . . . 218 27
Table 6.31 KeypadLockout Attribute Values . . . . . . . . . . . . . . . . . . 219 28
29
Table 7.1 Clusters Specified in the Closures Functional Domain . . . 221
30
Table 7.2 Shade Configuration Attribute Sets . . . . . . . . . . . . . . . . . . 223 31
Table 7.3 Attributes of the Shade Information Attribute Set . . . . . . . 223 32
Table 7.4 Bit Values for the Status Attribute . . . . . . . . . . . . . . . . . . . 224 33
Table 7.5 Attributes of the Shade Settings Attribute Set . . . . . . . . . . 224 34
Table 7.6 Values of the Mode Attribute . . . . . . . . . . . . . . . . . . . . . . . 225 35
36
Table 8.1 Clusters Specified in the Security and Safety
37
Functional Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 38
Table 8.2 Attribute Sets for the IAS Zone Cluster . . . . . . . . . . . . . . . 229 39
Table 8.3 Attributes of the Zone Information Attribute Set . . . . . . . . 229 40
Table 8.4 Values of the ZoneState Attribute . . . . . . . . . . . . . . . . . . . 229 41
Table 8.5 Values of the ZoneType Attribute . . . . . . . . . . . . . . . . . . . 230 42
43
Table 8.6 Values of the ZoneStatus Attribute . . . . . . . . . . . . . . . . . . 231
44
45
Copyright © 2007ZigBee Standards Organization. All rights reserved.
xiv List of Tables

Table 8.7 Attributes of the Zone Settings Attribute Set . . . . . . . . . . . 232

1
Table 8.8 Received Command IDs for the IAS Zone Cluster . . . . . . 232
2
Table 8.9 Values of the Enroll Response Code . . . . . . . . . . . . . . . . . 233 3
Table 8.10 Generated Command IDs for the IAS Zone Cluster . . . . 234 4
Table 8.11 Format of the Zone Table . . . . . . . . . . . . . . . . . . . . . . . . . 236 5
Table 8.12 Received Command IDs for the IAS ACE Cluster . . . . . 237 6
Table 8.13 Arm Mode Field Values . . . . . . . . . . . . . . . . . . . . . . . . . . 238 7
8
Table 8.14 Generated Command IDs for the IAS ACE Cluster . . . . 240
9
Table 8.15 Arm Notification Values . . . . . . . . . . . . . . . . . . . . . . . . . 240 10
Table 8.16 Attributes of the IAS WD (Server) Cluster . . . . . . . . . . . 243 11
Table 8.17 Received Command IDs for the IAS WD Server Cluster 243 12
Table 8.18 Warning Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 13
Table 8.19 Values of the Strobe Field . . . . . . . . . . . . . . . . . . . . . . . . 244 14
15
Table 8.20 Squawk Mode Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
16
Table 8.21 Strobe Bit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 17
Table 8.22 Squawk Level Field Values . . . . . . . . . . . . . . . . . . . . . . . 246 18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB xv

LIST OF FIGURES 1
2
3
4
Figure 2.1 The ZCL client server model . . . . . . . . . . . . . . . . . . . . . . 6 5
Figure 2.2 Format of the General ZCL Frame . . . . . . . . . . . . . . . . . . 11 6
Figure 2.3 Format of the Frame Control Field . . . . . . . . . . . . . . . . . . 11 7
Figure 2.4 Values of the Frame Type Sub-field . . . . . . . . . . . . . . . . 12 8
Figure 2.5 Format of the Read Attributes Command Frame . . . . . . . 14 9
10
Figure 2.6 Format of the Read Attributes Response Command Frame 16
11
Figure 2.7 Format of the Read Attributes Status Record Field . . . . . 16 12
Figure 2.8 Format of the Write Attributes Command Frame . . . . . . 18 13
Figure 2.9 Format of the Write Attribute Record Field . . . . . . . . . . . 18 14
Figure 2.10 Format of the Write Attributes Response 15
Command Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 16
17
Figure 2.11 Format of the Write Attribute Status Record Field . . . . 20
18
Figure 2.12 Format of the Write Attributes No Response 19
Command Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 20
Figure 2.13 Format of the Configure Reporting Command Frame . . 23 21
Figure 2.14 Format of the Attribute Reporting Configuration Record 23 22
Figure 2.15 Format of the Configure Reporting Response 23
24
Command Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
25
Figure 2.16 Format of the Attribute Status Record Field . . . . . . . . . 27 26
Figure 2.17 Format of the Read Reporting Configuration 27
Command Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 28
Figure 2.18 Format of the Attribute Status Record Field . . . . . . . . . 28 29
Figure 2.19 Format of the Read Reporting Configuration Response 30
31
Command Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
32
Figure 2.20 Format of the Attribute Reporting Configuration 33
Record Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 34
Figure 2.21 Format of the Report Attributes Command Frame . . . . . 32 35
Figure 2.22 Format of the Attribute Report Fields . . . . . . . . . . . . . . 32 36
Figure 2.23 Format of the Default Response Command Frame . . . . 35 37
38
Figure 2.24 Format of the Discover Attributes Command Frame . . . 37
39
Figure 2.25 Format of the Discover Attributes Response 40
Command Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 41
Figure 2.26 Format of the Attribute Report Fields . . . . . . . . . . . . . . 38 42
Figure 2.27 Format of the ZigBee Semi-precision Number . . . . . . . 45 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
xvi List of Figures

Figure 2.28 Format of the Octet String Type . . . . . . . . . . . . . . . . . . . 47

1
Figure 2.29 Format of the Character String Type . . . . . . . . . . . . . . . 47
2
Figure 2.30 Format of the Time of Day Type . . . . . . . . . . . . . . . . . . 48 3
Figure 2.31 Format of the Date Type . . . . . . . . . . . . . . . . . . . . . . . . . 48 4
Figure 3.1 Typical Usage of Device Configuration and Installation 5
Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 6
Figure 3.2 Typical Usage of On / Off and Level Control Clusters . . 55 7
8
Figure 3.3 Typical Usage of the Alarm Clusters . . . . . . . . . . . . . . . . 56
9
Figure 3.4 Format of the Identify Query Response 10
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 11
Figure 3.5 Format of the Identify Query Response 12
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 13
Figure 3.6 Format of the Add Group Command Payload . . . . . . . . . 81 14
15
Figure 3.7 Format of the View Group Command Payload . . . . . . . . 82
16
Figure 3.8 Format of the Get Group Membership Command Payload 82 17
Figure 3.9 Format of the Remove Group Command Payload . . . . . . 83 18
Figure 3.10 Format of the Add Group If Identifying 19
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 20
Figure 3.11 Format of the Add Group Response Command Payload 85 21
22
Figure 3.12 Format of the View Group Response Command Payload 86
23
Figure 3.13 Format of the Get Group Membership Response 24
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 25
Figure 3.14 Format of the Remove Group Response 26
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 27
Figure 3.15 Format of the Add Scene Command Payload . . . . . . . . 92 28
29
Figure 3.16 Format of the View Scene Command Payload . . . . . . . . 93
30
Figure 3.17 Format of the Remove Scene Command Payload . . . . . 93 31
Figure 3.18 Format of the Remove All Scenes Command Payload . 94 32
Figure 3.19 Format of the Store Scene Command Payload . . . . . . . . 95 33
Figure 3.20 Format of the Recall Scene Command Payload . . . . . . . 95 34
Figure 3.21 Format of the Get Scene Membership 35
36
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
37
Figure 3.22 Format of the Add Scene Response Command Payload 97 38
Figure 3.23 Format of the View Scene Response Command Payload 98 39
Figure 3.24 Format of the Remove Scene Response 40
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 41
Figure 3.25 Format of the Remove All Scenes Response 42
43
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB xvii

Figure 3.26 Format of the Store Scene Response

1
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
2
Figure 3.27 Format of the Get Scene Membership Response 3
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 4
Figure 3.28 Format of the Move to Level Command Payload . . . . . 110 5
Figure 3.29 Format of the Move Command Payload . . . . . . . . . . . . 111 6
Figure 3.30 Format of the Step Command Payload . . . . . . . . . . . . . . 112 7
8
Figure 3.31 Format of the Reset Alarm Command Payload . . . . . . . 117
9
Figure 3.32 Format of the Alarm Command Payload . . . . . . . . . . . . 118 10
Figure 3.33 Format of the Get Alarm Response Command Payload 119 11
Figure 3.34 Format of the Set Absolute Location Command Payload 128 12
Figure 3.35 Format of the Set Device Configuration Payload . . . . . . 128 13
Figure 3.36 Format of the Get Device Configuration Payload . . . . . 129 14
15
Figure 3.37 Format of the Get Location Data Payload . . . . . . . . . . . 130
16
Figure 3.38 Format of the Device Configuration Response Payload 132 17
Figure 3.39 Format of the Location Data Response Payload . . . . . . 133 18
Figure 3.40 Format of the Location Data Notification Payload . . . . 134 19
Figure 3.41 Format of the RSSI Ping Payload . . . . . . . . . . . . . . . . . . 135 20
Figure 4.1 Typical Usage of Illuminance Measurement and Level 21
22
Sensing Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
23
Figure 4.2 Typical Usage of Temperature, Pressure and Flow 24
Measurement Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 25
Figure 4.3 Typical Usage of Occupancy Sensing Cluster . . . . . . . . . 140 26
Figure 5.1 Typical Usage of Ballast Configuration and Color Control 27
Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 28
29
Figure 5.2 Format of the Move to Hue Command Payload . . . . . . . . 166
30
Figure 5.3 Format of the Move Hue Command Payload . . . . . . . . . . 168 31
Figure 5.4 Format of the Step Hue Command Payload . . . . . . . . . . . 169 32
Figure 5.5 Format of the Move to Saturation Command Payload . . . 170 33
Figure 5.6 Format of the Move Saturation Command Payload . . . . . 171 34
Figure 5.7 Format of the Step Saturation Command Payload . . . . . . 172 35
36
Figure 5.8 Format of the Move to Hue and Saturation
37
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 38
Figure 6.1 Typical Usage of the Pump Configuration and 39
Control Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 40
Figure 6.2 Example Usage of the Thermostat and Related Clusters . 184 41
Figure 6.3 Priority Scheme of Pump Operation and Control . . . . . . . 195 42
43
Figure 6.4 Format of the Setpoint Raise/Lower Command Payload . 209
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
xviii List of Figures

Figure 7.1 Typical Usage of the Closures Clusters . . . . . . . . . . . . . . 222

1
Figure 8.1 Typical Usage of the IAS Clusters . . . . . . . . . . . . . . . . . . 228
2
Figure 8.2 Format of the Zone Enroll Response Command Payload 233 3
Figure 8.3 Format of the Zone Status Change Notification 4
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 5
Figure 8.4 Format of the Zone Enroll Request Command Payload . . 235 6
Figure 8.5 Format of the Arm Command Payload . . . . . . . . . . . . . . 237 7
8
Figure 8.6 Format of the Bypass Command Payload . . . . . . . . . . . . 238
9
Figure 8.7 Format of the Get Zone Information Command Payload . 239 10
Figure 8.8 Format of the Arm Response Command Payload . . . . . . 240 11
Figure 8.9 Format of the Get Zone ID Map Response 12
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 13
Figure 8.10 Format of the Get Zone Information Response 14
15
Command Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
16
Figure 8.11 Format of the Start Siren Command Payload . . . . . . . . . 244 17
Figure 8.12 Format of the Start Siren Command payload . . . . . . . . . 245 18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 1

C H A P T E R
1

1
2
3
4
5
6
7
8
9

CHAPTER 1INTRODUCTION 10
11
12
13
1.1 Scope and Purpose 14
15
This document specifies the ZigBee Cluster Library (ZCL). The ZCL is a 16
repository for cluster functionality that is developed by the ZigBee Alliance, and, 17
as a consequence, it will be a working library with regular updates as new 18
functionality is added. 19
20
A developer constructing a new application profile should use the ZCL to find 21
relevant cluster functionality that can be incorporated into the new profile. 22
Correspondingly, new clusters that are defined for application profiles should be 23
considered for inclusion in the ZCL. 24
The ZCL consists of the ZCL Foundation, a set of elements that apply across the 25
entire library (such as frame structures, attribute access commands and data 26
types), and a number of sets of clusters. Clusters that are generally useful across 27
many application domains are included in the General set. Clusters that are 28
intended for use mainly in specific application domains are grouped together in 29
domain oriented sets. 30
31
32
1.2 Acronyms and Abbreviations 33
34
35
36
Table 1: 37
38
ACE Ancillary Control Equipment 39
CIE Control and Indicating Equipment 40
41
HVAC Heating, Ventilation, Air Conditioning 42
IAS Intruder Alarm System 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 1
2 Introduction

Table 1:
1
PIR Pyroelectric Infra-Red (a type of motion detection sensor) 2
3
RSSI Received Signal Strength Indication
4
WD Warning Device 5
ZCL ZigBee Cluster Library 6
7
8
9
10
1.3 Definitions 11
12
13
1.3.1 ZigBee Definitions 14
15
Cluster:- A related collection of attributes and commands, which together define 16
a communications interface between two devices. The devices implement server 17
and client sides of the interface respectively. 18
19
Client:- A cluster interface which is listed in the output cluster list of the simple 20
descriptor on an endpoint. Typically this interface sends commands that 21
manipulate the attributes on the corresponding server cluster. 22
Server:- A cluster interface which is listed in the input cluster list of the simple 23
descriptor on an endpoint. Typically this interface supports all or most of the 24
attributes of the cluster. 25
26
27
1.3.2 Application Domain Definitions 28
29
4-pipes:- In a 4-pipe HVAC fan coil system, heated and chilled water each have 30
their own supply and return pipes, while in a 2 pipe system they share the same 31
supply and return. With a 4-pipes system, heating and cooling can take place at 32
the same time in different locations of a building. With a 2-pipes system, only 33
heating or cooling can take place in the whole building. 34
Ballast factor:- A measure of the light output (lumens) of a ballast and lamp 35
combination in comparison to an ANSI standard ballast operated with the same 36
lamp. Multiply the ballast factor by the rated lumens of the lamp to get the light 37
output of the lamp/ballast combination. 38
39
HSV:- Hue, Saturation, Value. A color space, also known as HSB (Hue, 40
Saturation, Brightness). This is a well-known transformation of the RGB (Red, 41
Green, Blue) color space. For more information see e.g. http://en.wikipedia.org/ 42
wiki/HSV_color_space. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 3

Illuminance:- The density of incident luminous flux on a surface. Illuminance is

the standard metric for lighting levels, and is measured in lux (lx). 1
2
Precooling:- Cooling a building in the early (cooler) part of the day, so that the 3
thermal mass of the building decreases cooling needs in the later (hotter) part of 4
the day. 5
6
7
8
1.4 Conformance Levels 9
10
• expected: A key word used to describe the behavior of the hardware or 11
software in the design models assumed by this Draft. Other hardware and 12
software design models may also be implemented. 13
14
• may: A key word that indicates flexibility of choice with no implied 15
preference. 16
• shall: A key word indicating a mandatory requirement. Designers are required 17
to implement all such mandatory requirements. 18
19
• should: A key word indicating flexibility of choice with a strongly preferred 20
alternative. Equivalent to the phrase is recommended. 21
22
23
1.5 References 24
25
The following standards and specifications contain provisions, which through 26
reference in this document constitute provisions of this specification. All the 27
standards and specifications listed are normative references. At the time of 28
publication, the editions indicated were valid. All standards and specifications are 29
subject to revision, and parties to agreements based on this specification are 30
encouraged to investigate the possibility of applying the most recent editions of 31
the standards and specifications indicated below. 32
33
1.5.1 Zigbee Alliance Documents 34
35
[B1] ZigBee document 053474, ZigBee Specification, ZigBee Alliance. 36
37
38
1.5.2 European Standards Documents 39
40
[B2] EN 50131 European Standards Series for Intruder Alarm Systems 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 1
4 Introduction

1.5.3 IEEE Documents 1

2
[B3] IEEE Standards 802, Part 15.4: Wireless Medium Access Control (MAC)
3
and Physical Layer (PHY) specifications for Low Rate Wireless Personal Area
4
Networks (LR-WPANs), IEEE, October 2003.
5
[B4] IEEE 754-1985, IEEE Standard for Binary Floating-Point Arithmetic, 6
IEEE, 1985. 7
8
9
1.5.4 ASHRAE Documents 10
11
[B5] ASHRAE 135-2004 standard, Data Communication Protocol for Building
12
Automation and Control Networks
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 5

C H A P T E R
1

2
2
3
4
5
6
7
8
9

CHAPTER 2FOUNDATION SPECIFICATION 10

11
12
13
2.1 Scope and Purpose 14
15
This chapter provides an entry point into the documentation for the ZigBee cluster 16
library (ZCL), and specifies the elements that are general across the entire library. 17
18
The ZCL frame structure is specified along with ZCL wide commands used to 19
manipulate attributes from all the clusters defined throughout the ZCL. In 20
addition, a set of data types is defined that can be used to represent attributes and a 21
common set of status values returned by commands throughout the ZCL. 22
An overview is included which lists all the domains specified in the ZCL and the 23
clusters contained therein. 24
25
26
2.2 Cluster Library Overview 27
28
29
The ZigBee Cluster Library (ZCL) is intended to act as a repository for cluster
30
functionality that is developed by ZigBee and, as a consequence, it will be a
31
working library with regular updates as new functionality is added. A developer
32
constructing a new application profile should use the ZCL to find relevant cluster
33
functionality that can be incorporated into the new profile so as not to “re-invent
34
the wheel”. This also allows ZigBee profiles to be developed with more of an
35
object oriented style approach.
36
37
2.2.1 Client/Server Model 38
39
Throughout the ZCL, a client/server model is employed. This model is illustrated 40
in Figure 2.1 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
6 Foundation Specification

Any device Any device 1

2
Cluster binding 3
C S 4
5
6
7
8
C = Client Cluster S = Server Cluster 9
10
11
Figure 2.1 The ZCL client server model 12
13
A cluster is a related collection of commands and attributes, which together define 14
an interface to specific functionality. Typically, the entity that stores the attributes 15
of a cluster is referred to as the server of that cluster and an entity that affects or 16
manipulates those attributes is referred to as the client of that cluster. However, if 17
required, attributes may also be present on the client of a cluster. 18
19
Commands that allow devices to manipulate attributes, e.g. in this document the 20
read attribute (see 2.4.1) or write attribute (see 2.4.3) commands, are (typically) 21
sent from a client device and received by the server device. Any response to those 22
commands, e.g. in this document the read attribute response (see 2.4.2) or the 23
write attribute response (see 2.4.5) commands, are sent from the server device and 24
received by the client device. 25
Conversely, the command that facilitates dynamic attribute reporting, i.e. the 26
report attribute command (see 2.4.11) is (typically) sent from the server device (as 27
typically this is where the attribute data itself is stored) and sent to the client 28
device that has been bound to the server device. 29
30
The clusters supported by an application object within an application profile are 31
identified through the simple descriptor (see [B1]), specified on each active 32
endpoint of a device. In the simple descriptor, the application input cluster list 33
shall contain the list of server clusters supported on the device and the application 34
output cluster list shall contain the list of client clusters supported on the device. 35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 7

2.2.2 Functional Domains 1

2
The ZCL is divided into a number of functional domains, each domain addressing
3
clusters relating to specific functionality. The functional domains defined in the
4
ZCL are listed in Table 2.1.
5
Table 2.1 Functional Domains Defined in the ZCL 6
7
Functional Domain Cluster ID Range 8
General 0x0000 – 0x00ff 9
10
Closures 0x0100 – 0x01ff 11
HVAC 0x0200 – 0x02ff 12
13
Lighting 0x0300 – 0x03ff
14
Measurement and sensing 0x0400 – 0x04ff 15
16
Security and safety 0x0500 – 0x05ff
17
Protocol interfaces 0x0600 – 0x06ff 18
19
The structure of each of these functional domains is described in the following 20
sub-clauses. 21
22
2.2.2.1 General 23
24
The general functional domain contains clusters and information that provides 25
generally applicable functions and attributes that are not specific to other 26
functional domains. 27
This functional domain specifies the clusters listed in Table 2.2. 28
29
Table 2.2 Clusters Specified by the General Functional Domain
30
31
Cluster ID Cluster Name Description
32
0x0000 Basic Attributes for determining basic information about a 33
device, setting user device information such as location, 34
and enabling a device. 35
0x0001 Power configuration Attributes for determining more detailed information 36
about a device’s power source(s), and for configuring 37
under/over voltage alarms. 38
0x0002 Device Temperature Attributes for determining information about a device’s 39
Configuration internal temperature, and for configuring under/over 40
temperature alarms. 41
0x0003 Identify Attributes and commands for putting a device into 42
Identification mode (e.g. flashing a light) 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
8 Foundation Specification

Table 2.2 Clusters Specified by the General Functional Domain

1
Cluster ID Cluster Name Description 2
3
0x0004 Groups Attributes and commands for group configuration and
manipulation.
4
5
0x0005 Scenes Attributes and commands for scene configuration and 6
manipulation. 7
0x0006 On/off Attributes and commands for switching devices between 8
‘On’ and ‘Off’ states. 9
0x0007 On/off Switch Attributes and commands for configuring On/Off
10
Configuration switching devices 11
12
0x0008 Level Control Attributes and commands for controlling devices that 13
can be set to a level between fully ‘On’ and fully ‘Off’.
14
0x0009 Alarms Attributes and commands for sending notifications and 15
configuring alarm functionality. 16
0x000a Time Attributes and commands that provide a basic interface 17
to a real-time clock. 18
19
0x000b RSSI Location Attributes and commands that provide a means for
exchanging location information and channel parameters 20
among devices. 21
22
0x000c – - Reserved.
23
0x00ff
24
25
2.2.2.2 Closures 26
The closures functional domain contains clusters and information to build devices 27
in the closure domain, e.g. shade controllers. 28
29
This functional domain specifies the clusters listed in Table 2.3. 30
Table 2.3 Clusters Specified by the Closures Functional Domain 31
32
Cluster ID Cluster Name Description 33
34
0x0100 Shade Configuration Attributes and commands for configuring a shade. 35
0x0101 – - Reserved. 36
0x01ff 37
38
2.2.2.3 HVAC 39
40
The HVAC functional domain contains clusters and information to build devices 41
in the HVAC domain, e.g. pumps. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 9

This functional domain specifies the clusters listed in Table 2.4

1
Table 2.4 Clusters Specified by the HVAC Functional Domain
2
Cluster ID Cluster Name Description 3
4
0x0200 Pump Configuration and An interface for configuring and controlling pumps. 5
Control 6
0x0201 Thermostat An interface for configuring and controlling the 7
functionality of a thermostat. 8
9
0x0202 Fan Control An interface for controlling a fan in a heating /
cooling system. 10
11
0x0203 Dehumidification Control An interface for controlling dehumidification. 12
0x0204 Thermostat User Interface An interface for configuring the user interface of a 13
Configuration thermostat (which may be remote from the 14
thermostat). 15
0x0205 – - Reserved 16
0x02ff 17
18
19
2.2.2.4 Lighting 20
The lighting functional domain contains clusters and information to build devices 21
in the lighting domain, e.g. ballast units. 22
23
This functional domain specifies the clusters listed in Table 2.5 24
Table 2.5 Clusters Specified by the Lighting Functional Domain 25
26
Cluster ID Cluster Name Description 27
28
0x0300 Color control Attributes and commands for controlling the hue and
saturation of a color-capable light 29
30
0x0301 Ballast Configuration Attributes and commands for configuring a lighting 31
ballast
32
0x0302 – - Reserved. 33
0x03ff 34
35
2.2.2.5 Measurement and Sensing 36
37
The measurement and sensing functional domain contains clusters and 38
information to build devices in the measurement and sensing domain, e.g. a 39
temperature sensor or an occupancy sensor. 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
10 Foundation Specification

This functional domain specifies the clusters listed in Table 2.6.

1
Table 2.6 Clusters Specified by the Measurement and Sensing Functional Domain
2
Cluster ID Cluster Name Description 3
4
0x0400 Illuminance measurement Attributes and commands for configuring the 5
measurement of illuminance, and reporting 6
illuminance measurements. 7
0x0401 Illuminance level sensing Attributes and commands for configuring the 8
sensing of illuminance levels, and reporting whether 9
illuminance is above, below, or on target. 10
0x0402 Temperature measurement Attributes and commands for configuring the 11
measurement of temperature, and reporting 12
temperature measurements. 13
0x0403 Pressure measurement Attributes and commands for configuring the 14
measurement of pressure, and reporting pressure 15
measurements. 16
17
0x0404 Flow measurement Attributes and commands for configuring the
measurement of flow, and reporting flow rates. 18
19
0x0405 Relative humidity Attributes and commands for configuring the 20
measurement measurement of relative humidity, and reporting
relative humidity measurements. 21
22
0x0406 Occupancy sensing Attributes and commands for configuring occupancy 23
sensing, and reporting occupancy status. 24
0x0407 – - Reserved. 25
0x04ff 26
27
2.2.2.6 Security and Safety 28
29
The security and safety functional domain contains clusters and information to 30
build devices in the security and safety domain, e.g. alarm units. 31
This functional domain specifies the clusters listed in Table 2.7. 32
33
Table 2.7 Clusters Specified by the Security and Safety Functional Domain 34
35
Cluster ID Cluster Name Description 36
0x0500 IAS Zone Attributes and commands for IAS security zone devices. 37
38
0x0501 IAS ACE Attributes and commands for IAS Ancillary Control 39
Equipment.
40
0x0502 IAS WD Attributes and commands for IAS Warning Devices. 41
0x0503 – - Reserved. 42
0x05ff 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 11

2.3 Command Frame Formats 1

2
All commands, defined in this specification, shall be transmitted to the ZigBee 3
stack using the message service. 4
5
2.3.1 General ZCL Frame Format 6
7
The ZCL frame format is composed of a ZCL header and a ZCL payload. The 8
general ZCL frame shall be formatted as illustrated in Figure 2.2. 9
10
11
Bits: 8 0/16 8 8 Variable 12
13
Frame control Manufacturer code Transaction Command Frame payload 14
sequence identifier 15
number
16
ZCL header ZCL payload 17
18
Figure 2.2 Format of the General ZCL Frame 19
20
2.3.1.1 Frame Control Field 21
22
The frame control field is 8-bits in length and contains information defining the 23
command type and other control flags. The frame control field shall be formatted 24
as illustrated in Figure 2.3. 25
26
27
Bits: 0-1 2 3 4 5-7 28
29
Frame type Manufacturer specific Direction Disable default Reserved
response 30
31
32
Figure 2.3 Format of the Frame Control Field 33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
12 Foundation Specification

2.3.1.1.1 Frame Type Sub-field

1
The frame type sub-field is 2 bits in length and shall be set to one of the non- 2
reserved values listed in Figure 2.4. 3
4
Frame Type Value 5
Description
b1b0
6
00 Command acts across the entire profile 7
8
01 Command is specific to a cluster
9
10-11 Reserved 10
11
Figure 2.4 Values of the Frame Type Sub-field 12
13
2.3.1.1.2 Manufacturer Specific Sub-field 14
15
The manufacturer specific sub-field is 1 bit in length and specifies whether this 16
command refers to a manufacturer specific extension to a profile. If this value is 17
set to 1, the manufacturer code field shall be present in the ZCL frame. If this 18
value is set to 0, the manufacturer code field shall not be included in the ZCL 19
frame. 20
2.3.1.1.3 Direction Sub-field 21
22
The direction sub-field specifies the client/server direction for this command. If 23
this value is set to 1, the command is being sent from the server side of a cluster to 24
the client side of a cluster. If this value is set to 0, the command is being sent from
25
the client side of a cluster to the server side of a cluster.
26
2.3.1.1.4 Disable Default Response Sub-field 27
28
The disable default response sub-field is 1 bit in length. If it is set to 0, the Default
29
response command will be returned as a response, under the conditions specified
30
in 2.4.12.2. If it is set to 1, the Default response command will not be returned.
31
2.3.1.2 Manufacturer Code Field 32
33
The manufacturer code field is 16-bits in length and specifies the ZigBee assigned 34
manufacturer code for proprietary extensions to a profile. This field shall only be 35
included in the ZCL frame if the manufacturer specific sub-field of the frame 36
control field is set to 1. 37
38
2.3.1.3 Transaction Sequence Number 39
40
The transaction sequence number field is 8-bits in length and specifies an 41
identification number for the transaction so that a response-style command frame 42
can be related to a request-style command frame. The application object itself 43
shall maintain an 8-bit counter that is copied into this field and incremented by 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 13

one for each command sent. When a value of 0xff is reached, the next command
shall re-start the counter with a value of 0x00. 1
2
The transaction sequence number field can be used by a controlling device, which 3
may have issued multiple commands, so that it can match the incoming responses 4
to the relevant command. 5
6
2.3.1.4 Command Identifier Field 7
The command identifier field is 8-bits in length and specifies the cluster command 8
being used. If the frame type sub-field of the frame control field is set to 0b00, the 9
command identifier corresponds to one of the non-reserved values of Table 2.9. If 10
the frame type sub-field of the frame control field is set to 0b01, the command 11
identifier corresponds to a cluster specific command. The cluster specific 12
command identifiers can be found in each individual document describing the 13
clusters (see also 2.2.1). 14
15
2.3.1.5 Frame Payload Field 16
17
The frame payload field has a variable length and contains information specific to 18
individual command types. The maximum payload length for a given command is 19
limited by the stack profile in use, in conjunction with the applicable cluster 20
specification and application profile. Fragmentation will be used where available. 21
22
23
2.4 General Command Frames 24
25
General command frames are used for manipulating attributes and other general 26
tasks that are not specific to an individual cluster. 27
28
The command frames defined in this document are listed in Table 2.8. Each
29
command frame shall be constructed with the frame type sub-field of the frame
30
control field set to 0b00.
31
All clusters (server and client) shall support generation, reception and execution 32
of the Default response command. 33
34
Each cluster (server or client) that implements attributes shall support reception
35
of, execution of, and response to all commands to discover, read, write, report,
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
14 Foundation Specification

configure reporting of, and read reporting configuration of these attributes.

Generation of these commands is application dependent. 1
2
Table 2.8 ZCL Command Frames
3
Command Identifier 4
Description Reference 5
Field Value
6
0x00 Read attributes 7.1 7
0x01 Read attributes response 7.2 8
9
0x02 Write attributes 7.3 10
0x03 Write attributes undivided 7.4 11
12
0x04 Write attributes response 7.5
13
0x05 Write attributes no response 7.6 14
15
0x06 Configure reporting 7.7
16
0x07 Configure reporting response 7.8 17
0x08 Read reporting configuration 7.9 18
19
0x09 Read reporting configuration response 7.10 20
0x0a Report attributes 7.11 21
22
0x0b Default response 7.12 23
0x0c Discover attributes 7.13 24
25
0x0d Discover attributes response 7.14
26
0x0e – 0xff Reserved - 27
28
29
2.4.1 Read Attributes Command 30
31
2.4.1.1 Read Attributes Command Frame Format 32
33
The read attributes command frame shall be formatted as illustrated in Figure 2.5.
34
35
36
Octets: Variable 2 2 … 2
37
ZCL Attribute Attribute … Attribute 38
header identifier 1 identifier 2 identifier n 39
40
Figure 2.5 Format of the Read Attributes Command Frame 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 15

2.4.1.1.1 ZCL Header Fields

1
The frame control field shall be specified as follows. The frame type sub-field 2
shall be set to indicate a profile wide command (0b00). The manufacturer specific 3
sub-field shall be set to 0 if this command is being used to read attributes defined 4
for any cluster in the ZCL or 1 if this command is being used to read manufacturer 5
specific attributes. 6
The command identifier field shall be set to indicate the read attributes command 7
(see Table 2.9). 8
9
2.4.1.1.2 Attribute Identifier Field 10
The attribute identifier field is 16-bits in length and shall contain the identifier of 11
the attribute that is to be read. 12
13
2.4.1.2 When Generated 14
15
The read attributes command is generated when a device wishes to determine the 16
values of one or more attributes located on another device. Each attribute 17
identifier field shall contain the identifier of the attribute to be read. 18
19
2.4.1.3 Effect on Receipt 20
21
On receipt of this command, the device shall process each specified attribute 22
identifier and generate a read attributes response command. The read attributes 23
response command shall contain as many read attribute status records as attribute 24
identifiers included in this command frame. Each read attribute status record shall 25
contain the corresponding attribute identifier from this command frame, a status 26
value evaluated as described below, and, depending on the status value, the value 27
of the attribute itself. 28
For each attribute identifier included in the command frame, the device shall first 29
check that it corresponds to an attribute that exists on this device. If it does not, the 30
device shall set the status field of the corresponding read attribute status record to 31
UNSUPPORTED_ATTRIBUTE and shall not include an attribute value field. The 32
device shall then move on to the next attribute identifier. 33
34
If the attribute identified by the attribute identifier is supported, the device shall 35
set the status field of the corresponding read attribute status record to SUCCESS 36
and shall set the attribute value field to its current value. The device shall then 37
move on to the next attribute identifier. 38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
16 Foundation Specification

2.4.2 Read Attributes Response Command 1

2
2.4.2.1 Read Attributes Response Command Frame Format 3
The read attributes response command frame shall be formatted as illustrated in 4
Figure 2.6. 5
6
7
Octets: 8
Variable Variable … Variable 9
Variable
10
ZCL Read attribute status Read attribute status … Read attribute status 11
header record 1 record 2 record n
12
13
Figure 2.6 Format of the Read Attributes Response Command Frame 14
15
Each read attribute status record shall be formatted as illustrated in Figure 2.7 16
17
18
Octets: 2 1 0/1 0 / Variable 19
Attribute identifier Status Attribute data type Attribute 20
data 21
22
23
Figure 2.7 Format of the Read Attributes Status Record Field
24
2.4.2.1.1 ZCL Header Fields 25
26
The frame control field shall be specified as follows. The frame type sub-field 27
shall be set to indicate a profile wide command (0b00). The manufacturer specific 28
sub-field shall be set to 0 if this command is being used as a response to reading 29
attributes defined for any cluster in the ZCL or 1 if this command is being used as 30
a response to reading manufacturer specific attributes. 31
The command identifier field shall be set to indicate the read attributes response 32
command (see Table 2.9). 33
34
2.4.2.1.2 Attribute Identifier Field 35
36
The attribute identifier field is 16-bits in length and shall contain the identifier of
37
the attribute that has been read. This field shall contain the same value that was
38
included in the corresponding attribute identifier field of the original read
39
attributes command.
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 17

2.4.2.1.3 Status Field

1
The status field is 8-bits in length and specifies the status of the read operation on 2
this attribute. This field shall be set to SUCCESS, if the operation was successful, 3
or an error code, as specified in 2.4.1.3, if the operation was not successful. 4
2.4.2.1.4 Attribute Data Type Field 5
6
The attribute data type field shall contain the data type of the attribute in the same 7
read attributes status record (see Table 2.14). This field shall only be included if 8
the associated status field contains a value of SUCCESS. 9
2.4.2.1.5 Attribute Data Field 10
11
The attribute data field is variable in length and shall contain the current value of 12
this attribute. This field shall only be included if the associated status field 13
contains a value of SUCCESS. 14
15
2.4.2.2 When Generated 16
17
The read attributes response command is generated in response to a read attributes 18
command. The command frame shall contain a read attribute status record for 19
each attribute identifier specified in the original read attributes command. For 20
each read attribute status record, the attribute identifier field shall contain the 21
identifier specified in the original read attributes command. The status field shall 22
contain a suitable status code, as detailed in Clause 2.4.1.3. The attribute data field 23
shall only be included in the read attribute status record if the associated status 24
field contains a value of SUCCESS and shall contain the current value of the 25
attribute that was read. 26
Only as many read attribute status records that will fit in the frame shall be 27
returned. 28
29
2.4.2.3 Effect on Receipt 30
31
On receipt of this command, the originator is notified of the results of its original 32
read attributes attempt and, for each successful request, the value of the requested 33
attribute. 34
If some trailing attribute status records have not been returned, due to space 35
limitations in the frame, the originator may issue a further read attributes 36
command to obtain their values. 37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
18 Foundation Specification

2.4.3 Write Attributes Command 1

2
2.4.3.1 Write Attributes Command Frame Format 3
The write attributes command frame shall be formatted as illustrated in 4
Figure 2.8. 5
6
7
Octets: 8
Variable Variable … Variable 9
Variable
10
ZCL Write attribute Write attribute … Write attribute 11
header record 1 record 2 record n
12
13
Figure 2.8 Format of the Write Attributes Command Frame 14
15
Each write attribute record shall be formatted as illustrated in Figure 2.9. 16
17
18
Octets: 2 1 Variable 19
20
Attribute identifier Attribute data type Attribute data 21
22
Figure 2.9 Format of the Write Attribute Record Field 23
24
2.4.3.1.1 ZCL Header Fields 25
The frame control field shall be specified as follows. The frame type sub-field 26
shall be set to indicate a profile wide command (0b00). The manufacturer specific 27
sub-field shall be set to 0 if this command is being used to write attributes defined 28
for any cluster in the ZCL or 1 if this command is being used to write 29
manufacturer specific attributes. 30
31
The command identifier field shall be set to indicate the write attributes command 32
(see Table 2.9). 33
2.4.3.1.2 Attribute Identifier Field 34
35
The attribute identifier field is 16-bits in length and shall contain the identifier of 36
the attribute that is to be written. 37
38
2.4.3.1.3 Attribute Data Type Field
39
The attribute data type field shall contain the data type of the attribute that is to be 40
written. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 19

2.4.3.1.4 Attribute Data Field

1
The attribute data field is variable in length and shall contain the actual value of 2
the attribute that is to be written. 3
4
2.4.3.2 When Generated 5
The write attributes command is generated when a device wishes to change the 6
values of one or more attributes located on another device. Each write attribute 7
record shall contain the identifier and the actual value of the attribute to be 8
written. 9
10
2.4.3.3 Effect on Receipt 11
12
On receipt of this command, the device shall attempt to process each specified 13
write attribute record and shall construct a write attribute response command 14
(2.4.5). Each write attribute status record of the constructed command shall 15
contain the identifier from the corresponding write attribute record and a status 16
value evaluated as described below. 17
18
For each write attribute record included in the command frame, the device shall
19
first check that it corresponds to an attribute that is implemented on this device. If
20
it does not, the device shall set the status field of the corresponding write attribute
21
status record to UNSUPPORTED_ATTRIBUTE and move on to the next write
22
attribute record.
23
If the attribute identified by the attribute identifier is supported, the device shall 24
check whether the attribute data type field is correct. If not, the device shall set the 25
status field of the corresponding write attribute status record to 26
INVALID_DATA_TYPE and move on to the next write attribute record. 27
28
If the attribute data type is correct, the device shall check whether the attribute is
29
writable. If the attribute is designated as read only, the device shall set the status
30
field of the corresponding write attribute status record to READ_ONLY and move
31
on to the next write attribute record.
32
If the attribute is writable, the device shall check that the supplied value in the 33
attribute data field is within the specified range of the attribute. If the supplied 34
value does not fall within the specified range of the attribute, the device shall set 35
the status field of the corresponding write attribute status record to 36
INVALID_VALUE and move on to the next write attribute record. 37
38
If the value supplied in the attribute data field is within the specified range of the
39
attribute, the device shall write the supplied value to the identified attribute and
40
shall move on to the next write attribute record. In this (successful) case, a write
41
attribute status record shall not be generated.
42
When all write attribute records have been processed, the device shall generate the 43
constructed write attributes response command. If there are no write attribute 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
20 Foundation Specification

status records in the constructed command, indicating that all attributes were
written successfully, a single write attribute status record shall be included in the 1
command, with the status field set to SUCCESS and the attribute identifier field 2
omitted. 3
4
5
2.4.4 Write Attributes Undivided Command 6
7
The write attributes undivided command is generated when a device wishes to 8
change the values of one or more attributes located on another device, in such a 9
way that if any attribute cannot be written (e.g. if an attribute is not implemented 10
on the device, or a value to be written is outside its valid range), no attribute 11
values are changed. 12
In all other respects, including generation of a write attributes response command, 13
the format and operation of the command is the same as that of the write attributes 14
command, except that the command identifier field shall be set to indicate the 15
write attributes undivided command (see Table 2.9). 16
17
18
2.4.5 Write Attributes Response Command 19
20
2.4.5.1 Write Attributes Response Command Frame Format 21
22
The write attributes response command frame shall be formatted as illustrated in
23
Figure 2.10.
24
25
26
Octets:
Variable 3 3 … 3 27
28
ZCL Write attribute status Write attribute status … Write attribute status 29
header record 1 record 2 record n 30
31
Figure 2.10 Format of the Write Attributes Response Command Frame 32
33
Each write attribute status record shall be formatted as illustrated in Figure 2.11. 34
35
36
Octets: 1 2 37
38
Status Attribute identifier
39
40
Figure 2.11 Format of the Write Attribute Status Record Field 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 21

2.4.5.1.1 ZCL Header Fields

1
The frame control field shall be specified as follows. The frame type sub-field 2
shall be set to indicate a profile wide command (0b00). The manufacturer specific 3
sub-field shall be set to 0 if this command is being used as a response to writing 4
attributes defined for any cluster in the ZCL or 1 if this command is being used as 5
a response to writing manufacturer specific attributes. 6
The command identifier field shall be set to indicate the write attributes response 7
command (see Table 2.9). 8
9
2.4.5.1.2 Status Field 10
The status field is 8-bits in length and specifies the status of the write operation 11
attempted on this attribute, as detailed in 2.4.3.3. 12
13
Note that write attribute status records are not included for successfully written 14
attributes, in order to save bandwidth. In the case of successful writing of all 15
attributes, only a single write attribute status record shall be included in the 16
command, with the status field set to SUCCESS and the attribute identifier field 17
omitted. 18
2.4.5.1.3 Attribute Identifier Field 19
20
The attribute identifier field is 16-bits in length and shall contain the identifier of 21
the attribute on which the write operation was attempted. 22
23
2.4.5.2 When Generated 24
25
The write attributes response command is generated in response to a write 26
attributes command. 27
28
2.4.5.3 Effect on Receipt 29
On receipt of this command, the device is notified of the results of its original 30
write attributes command. 31
32
33
2.4.6 Write Attributes No Response Command 34
35
2.4.6.1 Write Attributes No Response Command Frame 36
Format 37
38
The write attributes no response command frame shall be formatted as illustrated 39
in Figure 2.12. 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
22 Foundation Specification

1
Octets: Variable Variable Variable … Variable 2
3
ZCL Write attribute Write attribute … Write attribute 4
header record 1 record 2 record n 5
6
Figure 2.12 Format of the Write Attributes No Response Command 7
Frame 8
9
Each write attribute record shall be formatted as illustrated in Figure 2.9. 10
2.4.6.1.1 ZCL Header Fields 11
12
The frame control field shall be specified as follows. The frame type sub-field 13
shall be set to indicate a profile wide command (0b00). The manufacturer specific 14
sub-field shall be set to 0 if this command is being used to write attributes defined 15
for any cluster in the ZCL or 1 if this command is being used to write 16
manufacturer specific attributes. 17
The command identifier field shall be set to indicate the write attributes no 18
response command (see Table 2.9). 19
20
2.4.6.1.2 Write Attribute Records 21
Each write attribute record shall be formatted as illustrated in Figure 2.9 Its fields 22
have the same meaning and contents as the corresponding fields of the Write 23
attributes command. 24
25
2.4.6.2 When Generated 26
27
The write attributes no response command is generated when a device wishes to 28
change the value of one or more attributes located on another device but does not 29
require a response. Each write attribute record shall contain the identifier and the 30
actual value of the attribute to be written. 31
32
2.4.6.3 Effect on Receipt 33
34
On receipt of this command, the device shall attempt to process each specified
35
write attribute record.
36
For each write attribute record included in the command frame, the device shall 37
first check that it corresponds to an attribute that is implemented on this device. If 38
it does not, the device shall ignore the attribute and move on to the next write 39
attribute record. 40
41
If the attribute identified by the attribute identifier is supported, the device shall
42
check whether the attribute is writable. If the attribute is designated as read only,
43
the device shall ignore the attribute and move on to the next write attribute record.
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 23

If the attribute is writable, the device shall check that the supplied value in the
attribute data field is within the specified range of the attribute. If the supplied 1
value does not fall within the specified range of the attribute, the device shall 2
ignore the attribute and move on to the next write attribute record. 3
4
If the value supplied in the attribute data field is within the specified range of the 5
attribute, the device shall write the supplied value to the identified attribute and 6
move on to the next write attribute record. 7
8
2.4.7 Configure Reporting Command 9
10
The Configure Reporting command is used to configure the reporting mechanism 11
for one or more of the attributes of a cluster. 12
13
The individual cluster definitions specify which attributes shall be available to this 14
reporting mechanism, however specific implementations of a cluster may make 15
additional attributes available. 16
17
2.4.7.1 Configure Reporting Command Frame Format 18
The Configure Reporting command frame shall be formatted as illustrated in 19
Figure 2.13. 20
21
22
Octets: 23
Variable Variable … Variable 24
Variable
25
ZCL Attribute reporting Attribute reporting … Attribute reporting 26
header configuration record configuration record configuration record
27
1 2 n
28
29
Figure 2.13 Format of the Configure Reporting Command Frame 30
31
There shall be one attribute reporting configuration record for each attribute to be 32
configured. Each such record shall be formatted as illustrated in Figure 2.14. 33
34
35
Octets: 1 2 0/1 0/2 0/2 0/Variable 0/2 36
Direction Attribute Attribute Minimum Maximum Reportable Timeout 37
identifier data type reporting reporting change period 38
interval interval 39
40
Figure 2.14 Format of the Attribute Reporting Configuration Record 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
24 Foundation Specification

2.4.7.1.1 ZCL Header Fields

1
The frame control field shall be specified as follows. The frame type sub-field 2
shall be set to indicate a profile wide command (0b00). The manufacturer specific 3
sub-field shall be set to 0 if this command is being used to configure attribute 4
reports defined for any cluster in the ZCL or 1 if this command is being used to 5
configure attribute reports for manufacturer specific attributes. 6
The command identifier field shall be set to indicate the report configuration 7
command (see Table 2.9). 8
9
2.4.7.1.2 Direction Field 10
The direction field specifies whether values of the attribute are be reported, or 11
whether reports of the attribute are to be received. 12
13
If this value is set to 0x00, then the attribute data type field, the minimum 14
reporting interval field and the maximum reporting interval field are included in 15
the payload, and the timeout period field is omitted. The record is sent to a cluster 16
server (or client) to configure how it sends reports to a client (or server) of the 17
same cluster. 18
If this value is set to 0x01, then the timeout period field is included in the payload, 19
and the attribute data type field, the minimum reporting interval field and the 20
maximum reporting interval field are omitted. The record is sent to a cluster client 21
(or server) to configure how it should expect reports from a server (or client) of 22
the same cluster. 23
24
All other values of this field are reserved. 25
2.4.7.1.3 Attribute Identifier Field 26
27
If the direction field is 0x00, this field contains the identifier of the attribute that is 28
to be reported. If instead the direction field is 0x01, the device shall expect reports 29
of values of this attribute. 30
31
2.4.7.1.4 Attribute Data Type Field
32
The Attribute data type field contains the data type of the attribute that is to be 33
reported. 34
35
2.4.7.1.5 Minimum Reporting Interval Field 36
The minimum reporting interval field is 16-bits in length and shall contain the 37
minimum interval, in seconds, between issuing reports of the specified attribute. 38
39
If this value is set to 0x0000, then there is no minimum limit, unless one is 40
imposed by the specification of the cluster using this reporting mechanism or by 41
the applicable profile. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 25

2.4.7.1.6 Maximum Reporting Interval Field

1
The maximum reporting interval field is 16-bits in length and shall contain the 2
maximum interval, in seconds, between issuing reports of the specified attribute. 3
If this value is set to 0xffff, then the device shall not issue reports for the specified 4
attribute, and the configuration information for that attribute need not be 5
maintained. (Note:- in an implementation using dynamic memory allocation, the 6
memory space for that information may then be reclaimed). 7
8
2.4.7.1.7 Reportable Change Field 9
The reportable change field shall contain the minimum change to the attribute that 10
will result in a report being issued. This field is of variable length. For attributes 11
with 'analog' data type (see Table 2.14) the field has the same data type as the 12
attribute. The sign (if any) of the reportable change field is ignored. 13
14
For attributes of 'discrete' data type (see Table 2.14) this field is omitted. 15
2.4.7.1.8 Timeout Period Field 16
17
The timeout period field is 16-bits in length and shall contain the maximum 18
expected time, in seconds, between received reports for the attribute specified in 19
the attribute identifier field. If more time than this elapses between reports, this 20
may be an indication that there is a problem with reporting. 21
22
If this value is set to 0x0000, reports of the attribute are not subject to timeout.
23
Note that, for a server/client connection to work properly using automatic 24
reporting, the timeout value set for attribute reports to be received by the client (or 25
server) cluster must be set somewhat higher than the maximum reporting interval 26
set for the attribute on the server (or client) cluster. 27
28
2.4.7.2 When Generated 29
30
The report configuration command is generated when a device wishes to 31
configure a device to automatically report the values of one or more of its 32
attributes, or to receive such reports. 33
34
2.4.7.3 Effect on Receipt 35
On receipt of this command, the device shall attempt to process each attribute 36
reporting configuration record and shall construct a configure reporting response 37
command. Each attribute status record of the constructed command shall contain 38
an identifier from an attribute reporting configuration record and a status value 39
evaluated as described below. 40
41
If the direction field is 0x00, indicating that the reporting intervals and reportable 42
change are being configured, then 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
26 Foundation Specification

• If the attribute specified in the attribute identifier field is not implemented on

this device, the device shall construct an attribute status record with the status 1
field set to UNSUPPORTED_ATTRIBUTE. 2
3
• Else, if the attribute identifier in this field cannot be reported (because it is not 4
in the list of mandatory reportable attributes in the relevant cluster 5
specification, and support has also not been implemented as a manufacturer 6
option), the device shall construct an attribute status record with the status field 7
set to UNREPORTABLE_ATTRIBUTE. 8
• Else, if the attribute data type field is incorrect, the device shall construct an 9
attribute status record with the status field set to INVALID_DATA_TYPE. 10
11
Else, if the minimum reporting interval field is less than any minimum set by the 12
relevant cluster specification or application profile, or the value of the maximum 13
reporting interval field is non-zero and is less than that of the minimum reporting 14
interval field, the device shall construct an attribute status record with the status 15
field set to INVALID_VALUE. 16
Else the device shall set the minimum and maximum reporting intervals and the 17
reportable change for the attribute to the values contained in the corresponding 18
fields. 19
20
Else the direction field is 0x01, indicating that the timeout period is being 21
configured, then 22
If reports of values of the attribute identifier specified in the attribute identifier 23
field cannot be received (because it is not in the list of mandatory reportable 24
attributes in the relevant cluster specification, and support has also not been 25
implemented as a manufacturer option), or the timeout feature is not spported, the 26
device shall construct an attribute status record with the status field set to 27
UNSUPPORTED_ATTRIBUTE. 28
29
Else the device shall set the timeout value for the attribute identifier specified in 30
the attribute identifier field to the value of the timeout period field. Note that the 31
action to be taken by the device if the timeout period is exceeded is cluster and 32
device dependent, including optionally taking no actionl. 33
When all attribute reporting configuration records have been processed, the 34
device shall generate the constructed configure reporting response command. If 35
there are no attribute status records in the constructed command, indicating that 36
all attributes were configured successfully, a single attribute status record shall be 37
included in the command, with the status field set to SUCCESS and the attribute 38
identifier field omitted. 39
40
The device shall then proceed to generate attribute reports according the 41
configuration just set up, by means of the Report attributes command (see 42
2.4.11.2.1 through 2.4.11.2.4). 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 27

2.4.8 Configure Reporting Response Command 1

2
The Configure Reporting Response command is used to respond to a Configure
3
Reporting command.
4
2.4.8.1 Configure Reporting Response Command Frame Format 5
6
The Configure Reporting Response command frame shall be formatted as 7
illustrated in Figure 2.15 8
9
10
Octets: Variable 4 4 … 4 11
12
ZCL Attribute status Attribute status … Attribute status
header record 1 record 2 record n 13
14
15
Figure 2.15 Format of the Configure Reporting Response
Command Frame 16
17
Each attribute status record shall be formatted as illustrated in Figure 2.16. 18
19
20
Octets: 1 1 2 21
22
Status Direction Attribute identifier 23
24
Figure 2.16 Format of the Attribute Status Record Field 25
26
2.4.8.1.1 ZCL Header Fields 27
28
The frame control field is specified as follows. The frame type sub-field shall be 29
set to indicate a profile wide command (0b00). The manufacturer specific sub- 30
field shall be set to 0 if this command is being used as a response to configuring 31
attribute reports defined for any cluster in the ZCL or 1 if this command is being 32
used as a response to configuring attribute reports for manufacturer specific 33
attributes. 34
The command identifier field shall be set to indicate the report configuration 35
response command (see Table 2.9). 36
37
2.4.8.1.2 Direction Field 38
The direction field specifies whether values of the attribute are reported (0x00), or 39
whether reports of the attribute are received (0x01). 40
41
All other values of this field are reserved. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
28 Foundation Specification

2.4.8.1.3 Status Field

1
The status field specifies the status of the configure reporting operation attempted 2
on this attribute, as detailed in 2.4.7.3. 3
Note that attribute status records are not included for successfully configured 4
attributes, in order to save bandwidth. In the case of successful configuration of all 5
attributes, only a single attribute status record shall be included in the command, 6
with the status field set to SUCCESS and the attribute identifier field omitted. 7
8
2.4.8.2 When Generated 9
10
The Configure Reporting Response command is generated in response to a 11
Configure Reporting command. 12
13
2.4.8.3 Effect on Receipt 14
15
On receipt of this command, the device is notified of the success (or otherwise) of
16
its original configure reporting command, for each attribute.
17
18
2.4.9 Read Reporting Configuration Command 19
20
The Read Reporting Configuration command is used to read the configuration 21
details of the reporting mechanism for one or more of the attributes of a cluster. 22
23
2.4.9.1 Read Reporting Configuration Command Frame Format 24
The Read Reporting Configuration command frame shall be formatted as 25
illustrated in Figure 2.17 26
27
28
Octets: 29
3 3 … 3 30
Variable
31
ZCL Attribute record 1 Attribute record 2 … Attribute record n 32
header
33
34
Figure 2.17 Format of the Read Reporting Configuration Command Frame 35
36
Each attribute record shall be formatted as illustrated in Figure 2.18. 37
38
39
Octets: 1 2 40
Direction Attribute identifier
41
42
43
Figure 2.18 Format of the Attribute Status Record Field 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 29

2.4.9.1.1 ZCL Header Fields

1
The frame control field shall be specified as follows. The frame type sub-field 2
shall be set to indicate a profile wide command (0b00). The manufacturer specific 3
sub-field shall be set to 0 if this command is being used to read the reporting 4
configuration of attributes defined for any cluster in the ZCL or 1 if this command 5
is being used to read the reporting configuration of manufacturer specific 6
attributes. 7
The command identifier field shall be set to indicate the read reporting 8
configuration command (see Table 2.9). 9
10
2.4.9.1.2 Direction Field 11
The direction field specifies whether values of the attribute are reported (0x00), or 12
whether reports of the attribute are received (0x01). 13
14
All other values of this field are reserved. 15
2.4.9.1.3 Attribute Identifier Field 16
17
The attribute identifier field shall contain the identifier of the attribute whose 18
reporting configuration details are to be read. 19
20
2.4.9.2 Effect on Receipt 21
22
On receipt of this command, a device shall generate a read reporting configuration 23
response command containing the details of the reporting configuration for each 24
of the attributes specified in the command (see 2.4.10). 25
26
2.4.10 Read Reporting Configuration Response 27
Command 28
29
The Read Reporting Configuration Response command is used to respond to a 30
Read Reporting Configuration command. 31
32
2.4.10.1 Read Reporting Configuration Response Command Frame 33
Format 34
The read reporting configuration response command frame shall be formatted as 35
illustrated in Figure 2.19 36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
30 Foundation Specification

1
Octets: 2
Variable Variable … Variable 3
Variable
4
ZCL Attribute reporting Attribute reporting … Attribute reporting 5
header configuration record configuration record configuration record
1 2 n 6
7
8
Figure 2.19 Format of the Read Reporting Configuration Response 9
Command Frame
10
There shall be one attribute reporting configuration record for each attribute 11
record of the received read reporting configuration command. Each such record 12
shall be formatted as illustrated in Figure 2.20. 13
14
15
Octets: 1 1 2 0/1 0/2 0/2 0/Variable 0/2 16
17
Status Direction Attribute Attribute Minimum Maximum Reportable Timeout 18
identifier data type reporting reporting change period 19
interval interval 20
21
Figure 2.20 Format of the Attribute Reporting Configuration Record Field 22
23
2.4.10.1.1 ZCL Header Fields 24
The frame control field shall be specified as follows. The frame type sub-field 25
shall be set to indicate a profile wide command (0b00). The manufacturer specific 26
sub-field shall be set to 0 if this command is being used to for attributes specified 27
in the ZCL or 1 if this command is being used for manufacturer specific attributes. 28
29
The command identifier field shall be set to indicate the Read reporting 30
configuration response command (see Table 2.9). 31
2.4.10.1.2 Status Field 32
33
If the attribute is not implemented on the sender or receiver of the command, 34
whichever is relevant (depending on direction), this field shall be set to 35
UNSUPPORTED_ATTRIBUTE. If the attribute is supported, but is not capable of 36
being reported, this field shall be set to UNREPORTABLE_ATTRIBUTE. 37
Otherwise, this field shall be set to SUCCESS. 38
39
If the status field is not set to SUCCESS, all fields except the direction and
40
attribute identifier fields shall be omitted.
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 31

2.4.10.1.3 Direction Field

1
The direction field specifies whether values of the attribute are reported (0x00), or 2
whether reports of the attribute are received (0x01). 3
If this value is set to 0x00, then the attribute data type field, the minimum 4
reporting interval field, the maximum reporting interval field and the reportable 5
change field are included in the payload, and the timeout period field is omitted. If 6
this value is set to 0x01, then the timeout period field is included in the payload, 7
and the attribute data type field, the minimum reporting interval field, the 8
maximum reporting interval field and the reportable change field are omitted. 9
10
All other values of this field are reserved. 11
2.4.10.1.4 Attribute Identifier Field 12
13
The attribute identifier field is 16-bits in length and shall contain the identifier of 14
the attribute that the reporting configuration details apply to. 15
2.4.10.1.5 Minimum Reporting Interval Field 16
17
The minimum reporting interval field is 16-bits in length and shall contain the 18
minimum interval, in seconds, between issuing reports for the attribute specified 19
in the attribute identifier field. If the minimum reporting interval has not been 20
configured, this field shall contain the value 0xffff. 21
22
2.4.10.1.6 Maximum Reporting Interval Field
23
The maximum reporting interval field is 16-bits in length and shall contain the 24
maximum interval, in seconds, between issuing reports for the attribute specified 25
in the attribute identifier field. If the maximum reporting interval has not been 26
configured, this field shall contain the value 0xffff. 27
28
2.4.10.1.7 Reportable Change Field 29
The reportable change field shall contain the minimum change to the attribute that 30
will result in a report being issued. For attributes with 'analog' data type (see 31
Table 2.14) the field has the same data type as the attribute. If the reportable 32
change has not been configured, this field shall contain the invalid value for the 33
relevant data type. 34
35
For attributes of 'discrete' data type (see Table 2.14) this field is omitted. 36
2.4.10.1.8 Timeout Period Field 37
38
The timeout period field is 16-bits in length and shall contain the maximum 39
expected time, in seconds, between received reports for the attribute specified in 40
the attribute identifier field. If the timeout period has not been configured, this 41
field shall contain the value 0xffff. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
32 Foundation Specification

2.4.10.2 When Generated

1
The read reporting configuration response command is generated in response to a 2
read reporting configuration command. Only as many attribute reporting 3
configuration records as will fit in the frame shall be returned. 4
5
2.4.10.3 Effect on Receipt 6
7
On receipt of this command, the originator is notified of the results of its original 8
read reporting configuration command. 9
If some trailing attribute reporting configuration records have not been returned, 10
due to space limitations in the frame, the originator may issue a further read 11
reporting configuration command to obtain their values. 12
13
14
2.4.11 Report Attributes Command 15
16
The report attributes command is used by a device to report the values of one or 17
more of its attributes to another device, bound a priori. Individual clusters, defined 18
elsewhere in the ZCL, define which attributes are to be reported and at what 19
interval. 20
21
2.4.11.1 Report Attributes Command Frame Format 22
The report attributes command frame shall be formatted as illustrated in 23
Figure 2.21. 24
25
26
Octets: 27
Variable Variable … Variable 28
Variable
29
ZCL Attribute Attribute … Attribute
30
header report 1 report 2 report n
31
32
Figure 2.21 Format of the Report Attributes Command Frame 33
34
Each attribute report field shall be formatted as illustrated in Figure 2.22. 35
36
37
Octets: 2 1 Variable 38
Attribute identifier Attribute data type Attribute data 39
40
41
Figure 2.22 Format of the Attribute Report Fields
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 33

2.4.11.1.1 ZCL Header Fields

1
The frame control field shall be specified as follows. The frame type sub-field 2
shall be set to indicate a profile wide command (0b00). The manufacturer specific 3
sub-field shall be set to 0 if this command is being used to report attributes defined 4
for any cluster in the ZCL or 1 if this command is being used to report 5
manufacturer specific attributes. 6
The command identifier field shall be set to indicate the report attributes 7
command (see Table 2.9). 8
9
2.4.11.1.2 Attribute Identifier Field 10
The attribute identifier field is 16-bits in length and shall contain the identifier of 11
the attribute that is being reported. 12
13
2.4.11.1.3 Attribute Data Type Field 14
15
The attribute data type field contains the data type of the attribute that is being
16
reported.
17
2.4.11.1.4 Attribute Data Field 18
19
The attribute data field is variable in length and shall contain the actual value of 20
the attribute being reported. 21
22
2.4.11.2 When Generated 23
The report attributes command is generated when a device has been configured to 24
report the values of one or more of its attributes to another device., and when the 25
conditions that have been configured are satisfied. These conditions are detailed 26
in the following sections. 27
28
2.4.11.2.1 Periodic Reporting 29
A report shall be generated when the time that has elapsed since the previous 30
report of the same attribute is equal to the Maximum Reporting Interval for that 31
attribute (see 2.4.7.1.6). The time of the first report after configuration is not 32
specified. 33
34
If the Maximum Reporting Interval is set to 0x0000, there is no periodic reporting, 35
but change based reporting is still operational. 36
If the Maximum Reporting Interval is set to 0xffff, no reports shall be generated, 37
whatever other conditions are satisfied. 38
39
2.4.11.2.2 Changes to 'Discrete' Attributes 40
If the attribute has a 'discrete' data type, a report shall be generated when the 41
attribute undergoes any change of value. Discrete types are general data types 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
34 Foundation Specification

(which are often used as set of bit fields), logical types, bitmap types,
enumerations, strings, identifiers and IEEE address (see Table 2.14). 1
2
Reporting is subject to the Minimum Reporting Interval for that attribute (see 3
2.4.7.1.5). After a report, no further reports are sent during this interval. 4
2.4.11.2.3 Changes to 'Analog' Attributes 5
6
If the attribute has an 'analog' data type, a report shall be generated when the 7
attribute undergoes a change of value, in a positive or negative direction, equal to 8
or greater than the Reportable Change for that attribute (see 2.4.7.1.7). The 9
change is measured from the value of the attribute when the Reportable Change is 10
configured, and thereafter from the previously reported value of the attribute. 11
Analog types are signed and unsigned integer types, floating point types and time 12
types (see Table 2.14). 13
14
Reporting is subject to the Minimum Reporting Interval for that attribute (see 15
2.4.7.1.5). After a report, no further reports are sent during this interval. 16
2.4.11.2.4 Cluster Specific Conditions 17
18
The specification for a cluster may add additional conditions for specific attributes 19
of that cluster. 20
2.4.11.2.5 Consolidation of Attribute Reporting 21
22
In order to reduce the resources (such as the number of timers) required for 23
attribute reporting, a device may adapt the timing of reports by relaxing the 24
configured minimum and maximum periods as described below. By employing 25
these techniques a device may limit the number of timers required to any 26
manufacturer specific value, including use of only a single timer, though at the 27
cost of some side effects, such as increased network traffic in some cases. 28
29
In consolidating timers, a number of principles apply:-
30
1/ The maximum reporting interval of an attribute may be reduced, as it should 31
not normally cause a problem to devices to receive reports more frequently than 32
expected – typical reporting intervals are seconds to minutes. It may not be 33
increased, as this may be incompatible with any timeout period set. 34
35
2/ The minimum reporting interval of an attribute may also be reduced. However,
36
it may not be increased, as an application may be relying on receiving reports of
37
changes to an attribute within a given delay time. Minimum values are generally
38
used to reduce network traffic, but this is less important than ensuring that the
39
application timing needs are satisfied.
40
3/ From (1), when consolidating the maximum reporting periods of two or more 41
attributes together, the consolidated reporting period shall be equal to the lowest 42
of the configured maximum intervals of the attributes to be reported. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 35

4/ Similarly, from (2), when consolidating the minimum reporting periods of two
or more attributes together, the consolidated reporting period shall be equal to the 1
lowest of the configured minimum intervals of the attributes to be reported. 2
3
As a first step, timers for attributes on the same cluster may be consolidated. Such 4
adaptations should aim to send attribute reports for different attributes of the same 5
cluster at the same time, so that they can be consolidated into fewer attribute 6
reports, thus reducing network traffic. 7
To reduce the number of timers further, timers may be consolidated across clusters 8
and endpoints if needed. 9
10
(Note that it is not generally possible to consolidate timeout values (see 2.4.7.1.8) 11
of received attribute reports.) 12
13
2.4.11.3 Effect on Receipt 14
On receipt of this command, a device is notified of the latest values of one or more 15
of the attributes of another device. 16
17
18
2.4.12 Default Response Command 19
20
2.4.12.1 Default Response Command Frame Format 21
22
The default response command frame shall be formatted as illustrated in 23
Figure 2.23. 24
25
26
Octets: Variable 1 1 27
ZCL Command identifier Status code 28
header 29
30
Figure 2.23 Format of the Default Response Command Frame 31
32
2.4.12.1.1 ZCL Header Fields 33
34
The frame control field shall be specified as follows. The frame type sub-field 35
shall be set to indicate a profile wide command (0b00). The manufacturer specific 36
sub-field shall be set to 0 if this command is being sent in response to a command 37
defined for any cluster in the ZCL or 1 if this command is being sent in response 38
to a manufacturer specific command. 39
The command identifier sub-field shall be set to indicate the default response 40
command (see Table 2.9). 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
36 Foundation Specification

2.4.12.1.2 Command Identifier Field

1
The command identifier field is 8-bits in length and specifies the identifier of the 2
received command to which this command is a response. 3
2.4.12.1.3 Status Code Field 4
5
The status code field is 8-bits in length and specifies either SUCCESS or the 6
nature of the error that was detected in the received command. It shall be one of 7
the status enumerations listed in Table 2.15. 8
9
2.4.12.2 When Generated 10
11
The default response command is generated when a device receives a unicast
12
command with the Disable default response bit of its Frame control field set to 0
13
(see 2.3.1.1.4), and there is no other relevant response specified for the command.
14
If a device receives a command in error through a broadcast or multicast
15
transmission, the command shall be discarded and the default response command
16
not generated.
17
If the identifier of the received command is not supported on the device, it shall 18
set the command identifier field to the value of the identifier of the command 19
received in error. The error code field shall be set to the either:- 20
UNSUP_CLUSTER_COMMAND, 21
UNSUP_GENERAL_COMMAND, 22
UNSUP_MANUF_CLUSTER_COMMAND or 23
UNSUP_MANUF_GENERAL_COMMAND, as appropriate. 24
25
The default response command shall be generated in response to reception of all
26
commands, including response commands (such as the write attributes response
27
command), under the conditions specified above. However, the default response
28
command shall not be generated in response to reception of another default
29
response command.
30
2.4.12.3 Effect on Receipt 31
32
On receipt of this command, the device is notified of the success or otherwise of 33
the generated command with the same transaction sequence number (see 2.3.1.3). 34
35
36
2.4.13 Discover Attributes Command 37
38
2.4.13.1 Discover Attributes Command Frame Format 39
The discover attributes command frame shall be formatted as illustrated in 40
Figure 2.24. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 37

1
Octets: Variable 2 1 2
3
ZCL Start attribute Maximum attribute 4
header identifier identifiers 5
6
Figure 2.24 Format of the Discover Attributes Command Frame 7
8
2.4.13.1.1 ZCL Header Fields 9
10
The frame control field shall be specified as follows. The frame type sub-field
11
shall be set to indicate a profile wide command (0b00). The manufacturer specific
12
sub-field shall be set to 0 to discover standard attributes in a ZigBee cluster or 1 to
13
discover manufacturer specific attributes in either a standard or a manufacturer
14
specific cluster.
15
The command identifier field shall be set to indicate the discover attributes 16
command (see Table 2.9). 17
18
2.4.13.1.2 Start Attribute Identifier Field
19
The start attribute identifier field is 16-bits in length and specifies the value of the 20
identifier at which to begin the attribute discovery. 21
22
2.4.13.1.3 Maximum Attribute Identifiers Field
23
The maximum attribute identifiers field is 8-bits in length and specifies the 24
maximum number of attribute identifiers that are to be returned in the resulting 25
discover attributes response command. 26
27
2.4.13.2 When Generated 28
29
The discover attributes command is generated when a remote device wishes to 30
discover the identifiers and types of the attributes on a device which are supported 31
within the cluster to which this command is directed. 32
33
2.4.13.3 Effect on Receipt 34
On receipt of this command, the device shall construct an ordered list of attribute 35
information records, each containing a discovered attribute identifier and its data 36
type, in ascending order of attribute identifiers. This list shall start with the first 37
attribute that has an identifier that is equal to or greater than the identifier 38
specified in the start attribute identifier field. The number of attribute identifiers 39
included in the list shall not exceed that specified in the maximum attribute 40
identifiers field. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
38 Foundation Specification

The device shall then generate a discover attributes response command containing
the discovered attributes and their types, and shall return it to the originator of the 1
discover attributes command. 2
3
4
2.4.14 Discover Attributes Response Command 5
6
2.4.14.1 Discover Attributes Response Command Frame 7
Format 8
9
The discover attributes response command frame shall be formatted as illustrated 10
in Figure 2.25. 11
12
13
Octets: 14
1 3 3 … 3
Variable 15
ZCL Discovery Attribute Attribute … Attribute 16
header complete information 1 information 2 information n 17
18
Figure 2.25 Format of the Discover Attributes Response Command Frame 19
20
Each attribute report field shall be formatted as illustrated in Figure 2.26. 21
22
23
Octets: 2 1 24
25
Attribute identifier Attribute data type 26
27
Figure 2.26 Format of the Attribute Report Fields 28
29
2.4.14.1.1 ZCL Header Fields 30
31
The frame control field shall be specified as follows. The frame type sub-field 32
shall be set to indicate a profile wide command (0b00). The manufacturer specific 33
sub-field shall be set to the same value included in the original discover attributes 34
command. 35
The command identifier field shall be set to indicate the discover attributes 36
response command (see Table 2.9). 37
38
2.4.14.1.2 Discovery Complete Field 39
The discovery complete field is a boolean field. A value of 0 indicates that there 40
are more attributes to be discovered. A value of 1 indicates that there are no more 41
attributes to be discovered. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 39

2.4.14.1.3 Attribute Identifier Field

1
The attribute identifier field shall contain the identifier of a discovered attribute. 2
Attributes shall be included in ascending order, starting with the lowest attribute 3
identifier that is greater than or equal to the start attribute identifier field of the 4
received discover attributes command. 5
2.4.14.1.4 Attribute Data Type Field 6
7
The attribute data type field shall contain the data type of the attribute in the same 8
attribute report field (see Table 2.14). 9
10
2.4.14.2 When Generated 11
12
The discover attributes response command is generated in response to a discover
13
attributes command.
14
2.4.14.3 Effect on Receipt 15
16
On receipt of this command, the device is notified of the results of its attribute 17
discovery request. 18
19
Following the receipt of this command, if the discovery complete field indicates 20
that there are more attributes to be discovered, the device may choose to send 21
subsequent discover attribute request commands to obtain the rest of the attribute 22
identifiers. In this case, the start attribute identifier specified in the next attribute 23
discovery request command should be set equal to one plus the last attribute 24
identifier received in the discover attributes response command. 25
26
2.5 Addressing, Types and Enumerations 27
28
29
2.5.1 Addressing 30
31
ZigBee uses a number of concepts to address application profiles, clusters, device 32
descriptions, attributes and commands, each with their own constraints. This sub- 33
clause details these constraints. 34
35
2.5.1.1 Profile Identifier 36
37
A profile identifier is 16-bits long and specifies the application profile being used. 38
A profile identifier shall be set to one of the non-reserved values listed in 39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
40 Foundation Specification

Table 2.9. Within a manufacturer specific application profile, the full ranges of
clusters, device, attribute and command identifiers can be used. 1
2
Table 2.9 Valid Profile Identifier Values
3
Profile Identifier Description 4
5
0x0000 – 0x7fff Standard ZigBee application profile. 6
7
0x8000 – 0xbfff Reserved.
8
0xc000 – 0xffff Manufacturer Specific application profile. 9
10
2.5.1.2 Device Identifier 11
12
A device identifier is 16-bits in length and specifies a specific device within a 13
standard application profile. A device identifier shall be set to one of the non- 14
reserved values listed in Table 2.10. 15
Table 2.10 Valid Device Identifier Values 16
17
Device Identifier Description 18
19
0x0000 – 0xbfff Standard ZigBee device description. 20
0xc000 – 0xffff Reserved. 21
22
23
2.5.1.3 Cluster Identifier
24
A cluster identifier is 16-bits in length and specifies the set of related commands 25
and attributes within a standard application profile. It shall be set to one of the 26
non-reserved values listed in Table 2.11. 27
28
Table 2.11 Valid Cluster Identifier Values
29
Cluster Identifier Description 30
31
0x0000 – 0x7fff Standard ZigBee cluster. 32
0x8000 – 0xfbff Reserved. 33
34
0xfc00 – 0xffff Manufacturer specific cluster within a standard ZigBee 35
profile.
36
37
2.5.1.4 Attribute Identifier 38
39
An attribute identifier is 16-bits in length and specifies a single attribute within a 40
standard application profile. An attribute identifier, defined within the ZCL, shall 41
be set to one of the non-reserved values listed in Table 2.12. Manufacturer specific 42
attributes within a standard ZigBee cluster can be defined over the full 16-bit 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 41

range but any manipulation shall be applied using the appropriate manufacturer
code. 1
2
Table 2.12 Valid ZCL Defined Attribute Identifier Values
3
Attribute Identifier Description 4
5
0x0000 – 0x3fff Standard ZigBee attribute. 6
7
0x4000 – 0xffff Reserved.
8
9
2.5.1.5 Command Identifier 10
11
A command identifier is 8-bits in length and specifies a specific command within
12
the ZCL as a whole or within a specific cluster. A command identifier shall be set
13
to one of the non-reserved values listed in Table 2.13. Manufacturer specific
14
commands within a standard ZigBee cluster can be defined over the full 8-bit
15
range but each shall use the appropriate manufacturer code.
16
Table 2.13 Valid ZCL Defined Command Identifier Values 17
18
Command Identifier Description 19
0x00 – 0x7f Standard ZigBee command. 20
21
0x80 – 0xff Reserved. 22
23
2.5.2 Data Types 24
25
ZigBee devices, such as thermostats, lamps, etc., are defined in terms of the 26
attributes they contain, which can be written, read or reported using the 27
commands defined in clause 2.4. Table 2.14 details the data types and formats that 28
can be used for these attributes. Note that individual clusters, which may use 29
different or new types, show valid values, ranges, and units for the attributes they 30
represent. 31
32
Each data type is allocated an 8-bit data type ID. The most significant 5 bits of this 33
ID is used to divide the types into 32 type classes, and the least significant 3 bits 34
specify a specific data type within this class. 35
Table 2.14 also indicates for each data type whether it is considered to be 'analog' 36
or 'discrete'. Values of analog types may be added to or subtracted from other 37
values of the same type, and are typically used to measure the value of properties 38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
42 Foundation Specification

in the real world that vary continuously over a range. Values of discrete data types
only have meaning as individual values, and may not be added or subtracted. 1
2
Table 2.14 Data Types
3
Length Of 4
Data Invalid Analog / 5
Type Class Type ID Data Type Data Number Discrete
(Octets) 6
7
Null 0x00 No data 0 - - 8
0x01 – Reserved - - 9
0x7 10
General data 0x08 8-bit data 1 - D 11
12
0x09 16-bit data 2 - 13
0x0a 24-bit data 3 - 14
15
0x0b 32-bit data 4 - 16
0x0c – Reserved - - 17
0x0f 18
Logical 0x10 Boolean 1 0xff D
19
20
0x11 – Reserved - - 21
0x17 22
Bitmap 0x18 8-bit bitmap 1 - D 23
24
0x19 16-bit bitmap 2 -
25
0x1a 24-bit bitmap 3 - 26
27
0x1b 32-bit bitmap 4 -
28
0x1c – Reserved - - 29
0x1f 30
Unsigned integer 0x20 Unsigned 8-bit 1 0xff A 31
integer 32
33
0x21 Unsigned 16-bit 2 0xffff
integer 34
35
0x22 Unsigned 24-bit 3 0xffffff 36
integer
37
0x23 Unsigned 32-bit 4 0xffffffff 38
integer 39
0x24 – Reserved - - 40
0x27 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 43

Table 2.14 Data Types (Continued)

1
Signed integer 0x28 Signed 8-bit integer 1 0x80 A 2
0x29 Signed 16-bit 2 0x8000 3
integer 4
5
0x2a Signed 24-bit 3 0x800000
integer 6
7
0x2b Signed 32-bit 4 0x80000000 8
integer 9
0x2c – Reserved - - 10
0x2f 11
Enumeration 0x30 8-bit enumeration 1 0xff D 12
13
0x31 16-bit enumeration 2 0xffff 14
0x32 – Reserved - - 15
0x37 16
17
Floating point 0x38 Semi-precision 2 Not a Number A
18
0x39 Single precision 4 Not a Number 19
0x3a Double precision 8 Not a Number
20
21
0x3b – Reserved - - 22
0x3f 23
String 0x40 Reserved - - D 24
25
0x41 Octet string Defined in 0xff in first octet
first octet
26
27
0x42 Character string Defined in 0xff in first octet 28
first octet 29
0x43 – Reserved - - 30
0x47 31
Array 0x48 – Reserved - - -
32
0x4f 33
34
List 0x50 – Reserved - - - 35
0x57
36
Reserved 0x58 – - - - - 37
0xdf 38
Time 0xe0 Time of day 4 0xffffffff A 39
40
0xe1 Date 4 0xffffffff 41
0xe2 – Reserved - - 42
0xe7 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
44 Foundation Specification

Table 2.14 Data Types (Continued)

1
Identifier 0xe8 Cluster ID 2 0xffff D 2
0xe9 Attribute ID 2 0xffff 3
4
0xea BACnet OID 4 0xffffffff 5
0xeb – Reserved - - 6
0xef 7
8
Miscellaneous 0xf0 IEEE address 8 0xffffffffffffffff D
9
0xf1 – Reserved - - - 10
0xfe 11
Unknown 0xff Unknown 0 - - 12
13
14
2.5.2.1 No Data Type
15
The no data type is a special type to represent an attribute with no associated data. 16
17
2.5.2.2 General Data (8-bit, 16-bit, 24-bit and 32-bit) 18
19
This type has no rules about its use, and may be used when a data element is 20
needed but its use does not conform to any of the standard types. 21
22
2.5.2.3 Boolean 23
The Boolean type represents a logical value, either TRUE (0x00) or FALSE 24
(0x01). The value 0xff represents an invalid value of this type. All other values of 25
this type are forbidden. 26
27
2.5.2.4 Bitmap (8-bit, 16-bit, 24-bit and 32-bit) 28
29
The Bitmap type holds 8, 16, 24 or 32 logical values, one per bit, depending on its 30
length. There is no value to represent an invalid value of this type. 31
32
2.5.2.5 Unsigned Integer (8-bit, 16-bit, 24-bit and 32-bit) 33
This type represents an unsigned integer with a decimal range of 0 to 28-1, 0 to 34
216-1, 0 to 224-1, or 0 to 232-1, depending on its length. The values that represents 35
an invalid value of this type are 0xff, 0xffff, 0xffffff and 0xffffffff respectively. 36
37
2.5.2.6 Signed Integer (8-bit, 16-bit, 24-bit and 32-bit) 38
39
This type represents a signed integer with a decimal range of -(27-1) to 27-1, - 40
(215-1) to 215-1, -(223-1) to 223-1, or -(231-1) to 231-1, depending on its length. 41
The values that represents an invalid value of this type are 0x80, 0x8000, 42
0x800000 and 0x80000000 respectively. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 45

2.5.2.7 Enumeration (8-bit)

1
The Enumeration type represents an index into a lookup table to determine the 2
final value. The value 0xff represents an invalid value of this type. 3
4
2.5.2.8 Semi-precision 5
6
The ZigBee semi-precision number format is based on the IEEE 754 standard for 7
binary floating-point arithmetic [B4]. This number format should be used very 8
sparingly, when absolutely necessary, keeping in mind the code and processing 9
required supporting it. 10
The value is calculated as: 11
12
Value = -1Sign * (Hidden + Mantissa/1024) * 2 (Exponent-15) 13
14
15
Sign Exponent Hidden Mantissa 16
17
S E4 E3 E2 E1 E0 H . M9 M8 M7 M6 M5 M4 M3 M2 M1 M0 18
bit 15 10 9 0 19
20
21
Figure 2.27 Format of the ZigBee Semi-precision Number
22
23
Note: The transmission order for the format in Figure 2.27 is bit 0 first.
24
For normalized numbers (>2-14), the hidden bit = 1 and the resolution is constant 25
at 11 bits (1 in 2048). 26
27
For un-normalized numbers, the hidden bit = 0. Note that this does not maintain
28
11-bit resolution and that the resolution becomes coarser as the number gets
29
smaller.
30
The hidden bit is not sent over the link. It shall have the value ‘1’ (i.e. normalized) 31
in order to be classified as a ZigBee semi-precision number. 32
33
The sign bit is set to 0 for positive values, 1 for negative.
34
The exponent is 5 bits. The actual exponent of 2 is calculated as (exponent – 15). 35
36
Certain values are reserved for specific purposes:
37
• Not a Number: this is used for undefined values (e.g. at switch-on and before 38
initialization) and is indicated by an exponent of 31 with a non-zero mantissa. 39
40
• Infinity: this is indicated by an exponent of 31 and a zero mantissa. The sign
41
bit indicates whether this represents + infinity or – infinity, the figure of
42
0x7c00 representing +¥ and 0xfc00 representing -¥ .
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
46 Foundation Specification

• Zero: this is indicated by both a zero exponent and zero mantissa. The sign bit
indicates whether this is + or – zero, the value 0x0000 representing +zero and 1
0x8000 representing –zero. 2
3
• Un-normalised numbers: numbers < 2-14 are indicated by a value of 0 for the 4
exponent. The hidden bit is set to zero. 5
The maximum value represented by the mantissa is 0x3ff / 1024. The largest 6
number that can be represented is therefore: 7
8
-1Sign * (1 +1023/1024) * 2 (30 -15) = – 1.9990234 * 32768 = – 65504 9
10
Certain applications may choose to scale this value to allow representation of
11
larger values (with a correspondingly more coarse resolution). For details, see the
12
relevant device descriptions.
13
For example, a value of +2 is represented by +2(16-15) * 1.0 = 0x4000, while a 14
value of –2 is represented by 0xc000. 15
16
Similarly, a value of +0.625 is represented by +2(17-15) * 1.625 = 0x4680, while –
17
0.625 is represented by 0xc680.
18
19
2.5.2.9 Single Precision
20
The format of the single precision data type is based on the IEEE 754 standard for 21
binary floating-point arithmetic [B4]. This number format should be used very 22
sparingly, when absolutely necessary, keeping in mind the code and processing 23
required supporting it. 24
25
The format and interpretation of values of this data type follow the same rules as 26
given for the semi-precision data type, but with longer sub-fields, as follows. 27
Length of mantissa = 23 bits, length of exponent = 8 bits 28
29
For further details, see [B4]. 30
31
2.5.2.10 Double Precision 32
The format of the double precision data type is based on the IEEE 754 standard 33
for binary floating-point arithmetic [B4]. This number format should be used very 34
sparingly, when absolutely necessary, keeping in mind the code and processing 35
required supporting it. 36
37
The format and interpretation of values of this data type follow the same rules as 38
given for the semi-precision data type, but with longer sub-fields, as follows. 39
Length of mantissa = 52 bits, length of exponent = 11 bits 40
41
For further details, see [B4]. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 47

2.5.2.11 Octet String

1
The octet string data type contains data in an application-defined format, not 2
defined in this specification. The octet string data type shall be formatted as 3
illustrated in Figure 2.28. 4
5
6
Octets: 1 Variable 7
8
Octet count Octet data
9
10
Figure 2.28 Format of the Octet String Type 11
12
The octet count sub-field is one octet in length and specifies the number of octets 13
contained in the octet data sub-field. 14
Setting this sub-field to 0x00 represents an octet string with no octet data (an 15
"empty string"). Setting this sub-field to 0xff represents an invalid octet string 16
value. In both cases the octet data sub-field has zero length. 17
18
The octet data sub-field is n octets in length, where n is the value of the octet 19
count sub-field. This sub-field contains the application-defined data. 20
21
2.5.2.12 Character String 22
The character string data type contains data octets encoding characters according 23
to the language and character set field of the complex descriptor. The character 24
string data type shall be formatted as illustrated in Figure 2.29. 25
26
27
Octets: 1 Variable 28
29
Character count Character data 30
31
Figure 2.29 Format of the Character String Type 32
33
The character count sub-field is one octet in length and specifies the number of 34
characters, encoded according to the language and character set field of the 35
complex descriptor (see [B1]), contained in the character data sub-field. 36
37
Setting this sub-field to 0x00 represents a character string with no character data 38
(an "empty string"). Setting this sub-field to 0xff represents an invalid character 39
string value. In both cases the character data sub-field has zero length. 40
The character data sub-field is e*n octets in length, where e is the size of the 41
character, as specified by the language and character set field of the complex 42
descriptor, and n is the value of the character count sub-field. This sub-field 43
contains the encoded characters that comprise the desired character string. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
48 Foundation Specification

A character string with no contents, i.e. with the character count sub-field equal to
0x00 and a zero length character data sub-field, shall be referred to as an 'empty 1
string'. 2
3
2.5.2.13 Time of Day 4
5
The Time of Day data type shall be formatted as illustrated in Figure 2.30. 6
7
8
Octets: 1 1 1 1 9
10
Hours Minutes Seconds Hundredths
11
12
Figure 2.30 Format of the Time of Day Type 13
14
The hours subfield represents hours according to a 24 hour clock. The range is 15
from 0 to 23. 16
The minutes subfield represents minutes of the current hour. The range is from 0 17
to 59. 18
19
The seconds subfield represents seconds of the current minute. The range is from 20
0 to 59. 21
The hundredths subfield represents 100ths of the current second. The range is 22
from 0 to 99. 23
24
A value of 0xff in any subfield indicates an unused subfield. If all subfields have 25
the value 0xff, this indicates an invalid or 'don't care' value of the data type. 26
27
2.5.2.14 Date 28
The Time of day data type shall be formatted as illustrated in Figure 2.31. 29
30
31
Octets: 1 1 1 1 32
33
Year - 1900 Month Day of month Day of week 34
35
Figure 2.31 Format of the Date Type 36
37
The year - 1900 subfield has a range of 0 to 255, representing years from 1900 to 38
2155. 39
40
The month subfield has a range of 1 to 12, representing January to December.
41
The day of month subfield has a range of 1 to 31. Note that values in the range 29 42
to 31 may be invalid, depending on the month and year. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 49

The day of week subfield has a range of 1 to 7, representing Monday to Sunday.

1
A value of 0xff in any subfield indicates an unused subfield. If all subfields have 2
the value 0xff, this indicates an invalid or 'don't care' value of the data type. 3
4
2.5.2.15 Cluster ID 5
This type represents a cluster identifier as defined in 2.5.1.3. 6
7
2.5.2.16 Attribute ID 8
9
This type represents an attribute identifier as defined in 2.5.1.4. 10
11
2.5.2.17 BACnet OID (Object Identifier) 12
13
The BACnet OID data type is included to allow interworking with BACnet (see
14
[B5]). The format is described in the referenced standard.
15
16
2.5.3 Status Enumerations 17
18
Where a ZCL command contains a status field, the actual value of the enumerated 19
status values are listed in Table 2.15. 20
Table 2.15 Enumerated Status Values Used in the ZCL 21
22
Enumerated Status Value Description 23
24
SUCCESS 0x00 Operation was successful. 25
FAILURE 0x01 Operation was not successful. 26
27
- 0x02 – Reserved.
28
0x7f
29
MALFORMED_COMMAND 0x80 The command appears to contain the wrong 30
fields, as detected either by the presence of 31
one or more invalid field entries or by there
being missing fields. Command not carried
32
out. Implementer has discretion as to whether 33
to return this error or INVALID_FIELD. 34
35
UNSUP_CLUSTER_COMMAND 0x81 The specified general ZCL command is not
supported on the device. Command not 36
carried out. 37
38
UNSUP_GENERAL_COMMAND 0x82 The specified cluster command is not
39
supported on the device.
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
50 Foundation Specification

Table 2.15 Enumerated Status Values Used in the ZCL (Continued)

1
Enumerated Status Value Description 2
3
UNSUP_MANUF_CLUSTER_COMMAND 0x83 A manufacturer specific unicast, cluster
specific command was received with an
4
unknown manufacturer code, or the 5
manufacturer code was recognized but the 6
command is not supported. 7
UNSUP_MANUF_GENERAL_COMMAND 0x84 A manufacturer specific unicast, ZCL specific 8
command was received with an unknown 9
manufacturer code, or the manufacturer code 10
was recognized but the command is not 11
supported. 12
INVALID_FIELD 0x85 At least one field of the command contains an 13
incorrect value, according to the specification 14
the device is implemented to. 15
UNSUPPORTED_ATTRIBUTE 0x86 The specified attribute does not exist on the 16
device. 17
18
INVALID_VALUE 0x87 Out of range error, or set to a reserved value.
Attribute keeps its old value. 19
20
Note that an attribute value may be out of 21
range if an attribute is related to another, e.g.
with minimum and maximum attributes. See 22
the individual attribute descriptions for 23
specific details. 24
25
READ_ONLY 0x88 Attempt to write a read only attribute.
26
INSUFFICIENT_SPACE 0x89 An operation (e.g. an attempt to create an 27
entry in a table) failed due to an insufficient 28
amount of free space available.
29
DUPLICATE_EXISTS 0x8a An attempt to create an entry in a table failed 30
due to a duplicate entry already being present 31
in the table. 32
NOT_FOUND 0x8b The requested information (e.g. table entry) 33
could not be found. 34
UNREPORTABLE_ATTRIBUTE 0x8c Periodic reports cannot be issued for this
35
attribute. 36
37
INVALID_DATA_TYPE 0x8d The data type given for an attribute is 38
incorrect. Command not carried out.
39
- 0x8e – Reserved 40
0xbf 41
HARDWARE_FAILURE 0xc0 An operation was unsuccessful due to a 42
hardware failure. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 51

Table 2.15 Enumerated Status Values Used in the ZCL (Continued)

1
Enumerated Status Value Description 2
3
SOFTWARE_FAILURE 0xc1 An operation was unsuccessful due to a
software failure.
4
5
CALIBRATION_ERROR 0xc2 An error occurred during calibration. 6
- 0xc3 – Reserved. 7
0xff 8
9
10
2.6 Functional Description 11
12
13
2.6.1 Transmission 14
15
ZCL frames are transmitted via the APS sub-layer by issuing the APSDE- 16
DATA.request primitive. 17
18
19
2.6.2 Reception 20
21
ZCL frames are received via the APS sub-layer by the reception of the APSDE-
22
DATA.indication primitive.
23
On receipt of a command, the device shall attempt to parse and execute the 24
command, and, if required, generate a response to it. Responses are detailed in the 25
specification of each command. If there is no response specified for a particular 26
set of circumstances, (e.g. if the command is not recognized, or the command has 27
succeeded but there is no response specified to indicate success), the default 28
response command shall be generated, taking into account the conditions in 29
2.4.12.2. The status code returned by the default response command shall be one 30
of the status enumerations listed in Table 2.15. 31
32
On receipt of a frame containing a broadcast endpoint (0xff), the APS sub-layer
33
shall direct the frame payload to each active endpoint, through its APSDE-
34
DATA.indication primitive.
35
36
2.6.3 Manufacturer Specific Extensions 37
38
Manufacturers are free to extend a standard profile in the following ways: 39
40
• Add manufacturer specific clusters to a standard profile.
41
• Add manufacturer specific commands to a standard cluster. 42
43
• Add manufacturer specific attributes to a standard cluster.
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 2
52 Foundation Specification

All communications regarding manufacturer specific extensions shall be

transmitted with the manufacturer specific sub-field of the frame control field set 1
to 1 and the manufacturer code included in the frame. 2
3
If the manufacturer code in a command frame is not recognized, the command is 4
not carried out. 5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 53

C H A P T E R
1

3
2
3
4
5
6
7
8
9

CHAPTER 3GENERAL SPECIFICATION 10

11
12
13
3.1 General Description 14
15
16
3.1.1 Introduction 17
18
The clusters specified in this document are included here because they are 19
sufficiently general to be of use across a wide range of application domains. 20
21
22
3.1.2 Cluster List 23
24
The clusters defined in this document are listed in Table 3.1 to Table 3.5. 25
Table 3.1 Device Configuration and Installation Clusters 26
27
Cluster Name Description 28
Basic Attributes for determining basic information about a device, setting user 29
device information such as description of location, and enabling a 30
device. 31
32
Power configuration Attributes for determining more detailed information about a device’s
power source(s), and for configuring under/over voltage alarms. 33
34
Device temperature Attributes for determining information about a device’s internal 35
configuration temperature, and for configuring under/over temperature alarms.
36
Identify Attributes and commands for putting a device into Identification mode 37
(e.g. flashing a light) 38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
54 General Specification

1
2
Configuration tool Any device 3
4
Basic 5
C S 6
Power configuration 7
C S
8
Device temperature 9
C S
configuration 10
C S 11
Identify
12
13
14
C = Client S = Server 15
16
Note:- Device names are examples for illustration only 17
18
Figure 3.1 Typical Usage of Device Configuration and Installation 19
Clusters 20
21
22
Table 3.2 Groups and Scenes Clusters 23
24
Cluster Name Description 25
26
Groups Attributes and commands for allocating a device to one or more of a number
of groups of devices, where each group is addressable by a group address. 27
28
Scenes Attributes and commands for setting up and recalling a number of scenes for 29
a device. Each scene corresponds to a set of stored values of specified device
30
attributes.
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 55

1
Table 3.3 On/Off and Level Control Clusters
2
3
Cluster Name Description
4
On/off Attributes and commands for switching devices between ‘On’ 5
and ‘Off’ states. 6
7
On/off switch configuration Attributes and commands for configuring on/off switching
devices 8
9
Level control Attributes and commands for controlling a characteristic of 10
devices that can be set to a level between fully ‘On’ and fully
‘Off’. 11
12
13
14
15
16
Configuration tool On/off switch Simple lamp 17
18
On/off
C S 19
On/off switch 20
C configuration S
21
22
Dimmer switch Dimmable lamp 23
24
On/off 25
C S
On/off switch Level control 26
configuration S C S 27
28
29
C = Client S = Server 30
Note:- Device names are examples for illustration only
31
32
33
Figure 3.2 Typical Usage of On / Off and Level Control Clusters 34
35
36
Table 3.4 Alarms Cluster 37
38
Cluster Name Description 39
Alarms Attributes and commands for sending alarm notifications and 40
configuring alarm functionality. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
56 General Specification

1
2
Network management device Any device
3
Alarms 4
C S 5
Configuration
Notification 6
7
8
9
C = Client S = Server 10
Note:- Device names are examples for illustration only 11
12
13
Figure 3.3 Typical Usage of the Alarm Clusters 14
15
16
Table 3.5 Other Clusters 17
18
Cluster Name Description 19
20
Time Attributes and commands that provide a basic interface to a real-time
clock. 21
22
RSSI Location Attributes and commands that provide a means for exchanging 23
location information and channel parameters among devices.
24
25
26
3.2 Basic Cluster 27
28
29
3.2.1 Overview 30
31
Attributes and commands for determining basic information about a device,
32
setting user device information such as location, enabling a device and resetting it
33
to factory defaults.
34
Note: Where a physical ZigBee node supports multiple endpoints it will often be 35
the case that many of these settings will apply to the whole node, that is they are 36
the same for every endpoint on the device. In such cases they can be implemented 37
once for the node, and mapped to each endpoint. 38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 57

3.2.2 Server 1
2
3.2.2.1 Dependencies 3
For the alarms functionality of this cluster to be operational, the Alarms cluster 4
server shall be implemented on the same endpoint. 5
6
3.2.2.2 Attributes 7
8
For convenience, the attributes defined in this specification are arranged into sets 9
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 10
are encoded such that the most significant three nibbles specify the attribute set 11
and the least significant nibble specifies the attribute within the set. The currently 12
defined attribute sets are listed in Table 3.6. 13
Table 3.6 General Attribute Sets 14
15
Attribute Set 16
IDentifier Description
17
0x000 Basic Device Information
18
19
0x001 Basic Device Settings 20
0x002 – 0xfff Reserved 21
22
23
3.2.2.2.1 Basic Device Information Attribute Set
24
The Basic Device Information attribute set contains the attributes summarized in 25
Table 3.7. 26
27
Table 3.7 Attributes of the Basic Device Information Attribute Set
28
29
Identifier Name Type Range Access Default Mandatory
/ Optional 30
31
0x0000 ZCLVersion Unsigned 0x00 – 0xff Read only 0x00 M
8-bit integer
32
33
0x0001 ApplicationVersion Unsigned 0x00 – 0xff Read only 0x00 O 34
8-bit integer 35
0x0002 StackVersion Unsigned 0x00 – 0xff Read only 0x00 O 36
8-bit integer 37
0x0003 HWVersion Unsigned 0x00 – 0xff Read only 0x00 O
38
8-bit integer 39
40
0x0004 ManufacturerName Character 0 – 32 bytes Read only Empty O 41
string string
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
58 General Specification

Table 3.7 Attributes of the Basic Device Information Attribute Set

1
0x0005 ModelIdentifier Character 0 – 32 bytes Read only Empty O 2
string string 3
0x0006 DateCode Character 0 – 16 bytes Read only Empty O 4
string string 5
0x0007 PowerSource 8-bit 0x00 – 0xff Read only 0x00 M 6
Enumeration 7
8
3.2.2.2.2 ZCLVersion Attribute 9
10
The ZCLVersion attribute is 8-bits in length and specifies the version number of 11
the ZigBee Cluster Library that all clusters on this endpoint conform to. For the 12
initial version of the ZCL, this attribute shall be set to 0x01. 13
14
Note: It is strongly recommended that new functionality is added to the ZCL
15
either in the form of new clusters or by addition of optional attributes and optional
16
commands to existing clusters. New functionality should be added in an
17
'orthogonal' way, making use of existing clusters to perform the functions they
18
offer rather than re-implementing these functions as part of the new clusters, so
19
that devices whose functionality has been extended via the new clusters can still
20
interwork with devices using existing clusters. When increasing the version of the
21
ZCL, no changes should be made to the functionality of individual clusters that
22
prevent interworking with previous versions of the same cluster.
23
3.2.2.2.3 ApplicationVersion Attribute 24
25
The ApplicationVersion attribute is 8-bits in length and specifies the version
26
number of the application software contained in the device. The usage of this
27
attribute is manufacturer dependent.
28
3.2.2.2.4 StackVersion Attribute 29
30
The StackVersion attribute is 8-bits in length and specifies the version number of 31
the implementation of the ZigBee stack contained in the device. The usage of this 32
attribute is manufacturer dependent. 33
3.2.2.2.5 HWVersion Attribute 34
35
The HWVersion attribute is 8-bits in length and specifies the version number of 36
the hardware of the device. The usage of this attribute is manufacturer dependent.. 37
3.2.2.2.6 ManufacturerName Attribute 38
39
The ManufacturerName attribute is a maximum of 32 bytes in length and 40
specifies the name of the manufacturer as a ZigBee character string. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 59

3.2.2.2.7 ModelIdentifier Attribute

1
The ModelIdentifier attribute is a maximum of 32 bytes in length and specifies the 2
model number (or other identifier) assigned by the manufacturer as a ZigBee 3
character string. 4
3.2.2.2.8 DateCode Attribute 5
6
The DateCode attribute is a ZigBee character string with a maximum length of 16 7
bytes . The first 8 characters specify the date of manufacturer of the device in 8
international date notation according to ISO 8601, i.e. YYYYMMDD, e.g. 9
20060814. 10
The final 8 characters may include country, factory, line, shift or other related 11
information at the option of the manufacturer. The format of this information is 12
manufacturer dependent. 13
14
3.2.2.2.9 PowerSource Attribute 15
16
The PowerSource attribute is 8-bits in length and specifies the source(s) of power
17
available to the device. Bits b0–b6 of this attribute represent the primary power
18
source of the device and bit b7 indicates whether the device has a secondary power
19
source in the form of a battery backup.
20
Bits b0–b6 of this attribute shall be set to one of the non-reserved values listed in 21
Table 3.8. 22
Table 3.8 Values of the PowerSource Attribute 23
24
PowerSource 25
Description
Attribute Value b6-b0 26
27
0x00 Unknown
28
0x01 Mains (single phase) 29
30
0x02 Mains (3 phase)
31
0x03 Battery 32
0x04 DC source 33
34
0x05 Emergency mains constantly powered 35
0x06 Emergency mains and transfer switch 36
37
0x07 – 0x7f Reserved 38
39
Bit b7 of this attribute shall be set to 1 if the device has a secondary power source 40
in the form of a battery backup. Otherwise, bit b7 shall be set to 0. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
60 General Specification

3.2.2.2.10 Basic Device Settings Attribute Set

1
The device configuration attribute set contains the attributes summarized in 2
Table 3.9. 3
Table 3.9 Attributes of the Device Configuration Attribute Set 4
5
Identifier Name Type Range Access Default Mandatory 6
/ Optional 7
0x0010 LocationDescription Character 0 – 16 Read/ Empty O 8
string bytes write string 9
10
0x0011 PhysicalEnvironment 8-bit 0x00 – Read/ 0x00 O
Enumeration 0xff write 11
12
0x0012 DeviceEnabled Boolean 0x00 – Read/ 0x01 M 13
0x01 write
14
0x0013 AlarmMask 8-bit Bitmap 000000xx Read/ 0x00 O 15
write 16
17
3.2.2.2.11 LocationDescription Attribute 18
19
The LocationDescription attribute is a maximum of 16 bytes in length and 20
describes the physical location of the device as a ZigBee character string. This 21
location description may be added into the device during commissioning. 22
3.2.2.2.12 PhysicalEnvironment Attribute 23
24
The PhysicalEnvironment attribute is 8-bits in length and specifies the type of 25
physical environment in which the device will operate. This attribute shall be set 26
to one of the non-reserved values listed in Table 3.10. 27
Table 3.10 Values of the PhysicalEnvironment Attribute 28
29
PhysicalEnvironment 30
Description
Attribute Value 31
32
0x00 Unspecified environment
33
0x01 – 0x7f Specified per Profile 34
0x80 – 0xfe Reserved 35
36
0xff Unknown environment 37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 61

3.2.2.2.13 DeviceEnable Attribute

1
The DeviceEnabled attribute is a boolean and specifies whether the device is 2
enabled or disabled. This attribute shall be set to one of the non-reserved values 3
listed in Table 3.11. 4
Table 3.11 Values of the DeviceEnable Attribute 5
6
DeviceEnable Description 7
Attribute Value 8
0x00 Disabled
9
10
0x01 Enabled 11
12
'Disabled' means that the device does not send or respond to application level 13
commands, other than commands to read or write attributes. Values of attributes 14
which depend on the operation of the application may be invalid, and any 15
functionality triggered by writing to such attributes may be disabled. ZigBee 16
networking functionality remains operational. 17
18
Note that the identify cluster cannot be disabled, and remains functional 19
regardless of this setting. 20
3.2.2.2.14 AlarmMask Attribute 21
22
The AlarmMask attribute is 8-bits in length and specifies which of a number of 23
general alarms may be generated, as listed in Table 3.12. A ‘1’ in each bit position 24
enables the associated alarm. 25
Table 3.12 Values of the AlarmMask Attribute 26
27
AlarmMask 28
Attribute Bit Alarm Code Alarm 29
Number
30
0 0 General hardware fault 31
32
1 1 General software fault
33
2–7 - Reserved 34
35
These alarms are provided as basic alarms that a device may use even if no other 36
clusters with alarms are present on the device. 37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
62 General Specification

3.2.2.3 Commands Received

1
The command IDs for the Basic cluster are listed in Table 3.13. 2
Table 3.13 Received Command IDs for the Basic Cluster 3
4
Command Identifier Mandatory 5
Description
Field Value / Optional 6
7
0x00 Reset to Factory Defaults 0
8
0x01 – 0xff Reserved - 9
10
3.2.2.4 Commands Generated 11
12
No commands are generated by the server cluster. 13
14
3.2.2.4.1 Reset to Factory Defaults Command
15
This command does not have a payload. 16
17
3.2.2.4.2 Effect on Receipt 18
On receipt of this command, the device resets all the attributes of all its clusters to 19
their factory defaults. 20
21
Note that ZigBee networking functionality and any bindings are not affected by 22
this command. 23
24
3.2.3 Client 25
26
3.2.3.1 Dependencies 27
28
None 29
30
3.2.3.2 Attributes 31
32
The Client cluster has no attributes.
33
34
3.2.3.3 Commands Received
35
No cluster specific commands are received by the client cluster. 36
37
3.2.3.4 Commands Generated 38
39
The cluster specific commands generated by the client cluster are those received 40
by the server, as required by the application. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 63

3.3 Power Configuration Cluster 1

2
3.3.1 Overview 3
4
Attributes for determining detailed information about a device’s power source(s), 5
and for configuring under/over voltage alarms. 6
7
8
3.3.2 Server 9
10
3.3.2.1 Dependencies 11
12
Any endpoint that implements this server cluster shall also implement the Basic 13
server cluster. 14
For the alarm functionality described in this cluster to be operational, any 15
endpoint that implements the Power Configuration server cluster must also 16
implement the Alarms server cluster (see sub-clause 3.11). 17
18
3.3.2.2 Attributes 19
20
For convenience, the attributes defined in this specification are arranged into sets 21
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 22
are encoded such that the most significant three nibbles specify the attribute set 23
and the least significant nibble specifies the attribute within the set. The currently 24
defined attribute sets are listed in Table 3.14. 25
Table 3.14 Power Configuration Attribute Sets 26
27
Attribute Set 28
Description
Identifier 29
0x000 Mains Information 30
31
0x001 Mains Settings 32
0x002 Battery Information 33
34
0x003 Battery Settings 35
0x004 – 0xfff Reserved 36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
64 General Specification

3.3.2.2.1 Mains Information Attribute Set

1
The Mains Information attribute set contains the attributes summarized in 2
Table 3.15. 3
Table 3.15 Attributes of the Mains Information Attribute Set 4
5
Identifier Name Type Range Access Default Mandatory 6
/ Optional 7
0x0000 MainsVoltage Unsigned 0x0000 – Read only - O 8
16-bit integer 0xffff 9
10
0x0001 MainsFrequency Unsigned 0x00 – Read only - O
8-bit integer 0xff 11
12
13
3.3.2.2.1.1 MainsVoltage Attribute 14
The MainsVoltage attribute is 16-bits in length and specifies the actual (measured) 15
RMS voltage (or DC voltage in the case of a DC supply) currently applied to the 16
device, measured in units of 100mV. 17
18
3.3.2.2.1.2 MainsFrequency Attribute 19
20
The MainsFrequency attribute is 8-bits in length and represents the frequency, in 21
Hertz, of the mains as determined by the device as follows:- 22
23
MainsFrequency = 0.5 x measured frequency
24
Where 2 Hz <= measured frequency <= 506 Hz, corresponding to a 25
MainsFrequency in the range 1 to 0xfd. 26
27
The maximum resolution this format allows is 2 Hz.
28
The following special values of MainsFrequency apply. 29
30
0x00 indicates a frequency that is too low to be measured.
31
0xfe indicates a frequency that is too high to be measured. 32
33
0xff indicates that the frequency could not be measured.
34
In the case of a DC supply, this attribute shall also have the value zero. 35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 65

3.3.2.2.2 Mains Settings Attribute Set

1
The Mains Settings attribute set contains the attributes summarized in Table 3.16. 2
Table 3.16 Attributes of the Mains Settings Attribute Set 3
4

Mandatory
5

/ Optional
Identifier Name Type Range Access Default 6
7
8
0x0010 MainsAlarmMask Bitmap 0000 00xx Read/ 0000 0000 O 9
(8-bits) write 10
0x0011 MainsVoltageMinThreshold Unsigned 0x0000 – Read/ 0x0000 O 11
16-bit 0xffff write 12
integer 13
0x0012 MainsVoltageMaxThreshold Unsigned 0x0000 – Read/ 0xffff O 14
16-bit 0xffff write 15
integer 16
0x0013 MainsVoltageDwellTripPoint Unsigned 0x0000 – Read/ 0x0000 O
17
16-bit 0xffff write 18
integer 19
20
The alarm settings in this table require the Alarms cluster to be implemented on 21
the same device - see Dependencies. If the Alarms cluster is not present on the 22
same device they may be omitted. 23
24
3.3.2.2.2.1 MainsAlarmMask Attribute 25
26
The MainsAlarmMask attribute is 8-bits in length and specifies which mains 27
alarms may be generated, as listed in Table 3.17. A ‘1’ in each bit position enables 28
the alarm. 29
Table 3.17 Values of the MainsAlarmMask Attribute 30
31
MainsAlarmMask 32
Alarm 33
Attribute Bit Number
34
0 Mains Voltage too low (7.2.2.2.2)
35
1 Mains Voltage too high (7.2.2.2.3) 36
37
2–7 Reserved
38
39
3.3.2.2.2.2 MainsVoltageMinThreshold Attribute 40
The MainsVoltageMinThreshold attribute is 16-bits in length and specifies the 41
lower alarm threshold, measured in units of 100mV, for the MainsVoltage 42
attribute. The value of this attribute shall be less than MainsVoltageMaxThreshold. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
66 General Specification

If the value of MainsVoltage drops below the threshold specified by

MainsVoltageMinThreshold, the device shall start a timer to expire after 1
MainsVoltageDwellTripPoint seconds. If the value of this attribute increases to 2
greater than or equal to MainsVoltageMinThreshold before the timer expires, the 3
device shall stop and reset the timer. If the timer expires, an alarm shall be 4
generated. 5
6
The Alarm Code field (see 3.11.2.3.1) included in the generated alarm shall be 7
0x00. 8
If this attribute takes the value 0xffff then this alarm shall not be generated. 9
10
3.3.2.2.2.3 MainsVoltageMaxThreshold Attribute 11
12
The MainsVoltageMaxThreshold attribute is 16-bits in length and specifies the 13
upper alarm threshold, measured in units of 100mV, for the MainsVoltage 14
attribute. The value of this attribute shall be greater than 15
MainsVoltageMinThreshold. 16
If the value of MainsVoltage rises above the threshold specified by 17
MainsVoltageMaxThreshold, the device shall start a timer to expire after 18
MainsVoltageDwellTripPoint seconds. If the value of this attribute drops to lower 19
than or equal to MainsVoltageMaxThreshold before the timer expires, the device 20
shall stop and reset the timer. If the timer expires, an alarm shall be generated. 21
22
The Alarm Code field (see 3.11.2.3.1) included in the generated alarm shall be 23
0x01. 24
If this attribute takes the value 0xffff then this alarm shall not be generated. 25
26
27
3.3.2.2.2.4 MainsVoltageDwellTripPoint Attribute
28
The MainsVoltageDwellTripPoint attribute is 16-bits in length and specifies the 29
length of time, in seconds that the value of MainsVoltage may exist beyond either 30
of its thresholds before an alarm is generated. 31
32
If this attribute takes the value 0xffff then the associated alarms shall not be 33
generated. 34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 67

3.3.2.2.3 Battery Information Attribute Set

1
The Battery Information attribute set contains the attributes summarized in 2
Table 3.18. 3
Table 3.18 Attributes of the Battery Information Attribute Set 4
5
Identifier Name Type Range Access Default Mandatory / 6
Optional 7
0x0020 BatteryVoltage Unsigned 0x00 – Read - O
8
8-bit integer 0xff only 9
10
11
3.3.2.2.3.1 BatteryVoltage Attribute 12
The BatteryVoltage attribute is 8-bits in length and specifies the current actual 13
(measured) battery voltage, in units of 100mV. 14
15
The value 0xff indicates an invalid or unknown reading. 16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
68 General Specification

3.3.2.2.4 Battery Settings Attribute Set

1
Table 3.19 Attributes of the Battery Information Attribute Set
2
3

Mandatory
/ Optional
4
Identifier Name Type Range Access Default 5
6
7
0x0030 BatteryManufacturer Character 0 – 16 Read/write Empty O 8
string bytes string
9
0x0031 BatterySize 8-bit 0x00 – Read/write 0xff O 10
Enumeration 0xff 11
0x0032 BatteryAHrRating Unsigned 0x0000 Read/write - O 12
16-bit integer – 0xffff 13
14
0x0033 BatteryQuantity Unsigned 0x00 – Read/write - O
8-bit integer 0xff
15
16
0x0034 BatteryRatedVoltage Unsigned 0x00 – Read/write - O 17
8-bit integer 0xff 18
0x0035 BatteryAlarmMask Bitmap 0000 Read/write 0000 0000 O 19
(8-bits) 000x 20
0x0036 BatteryVoltageMin Unsigned 0x00 – Read/write 0x0000 O
21
Threshold 8-bit integer 0xff 22
23
24
3.3.2.2.4.1 BatteryManufacturer Attribute 25
The BatteryManufacturer attribute is a maximum of 16 bytes in length and 26
specifies the name of the battery manufacturer as a ZigBee character string. 27
28
3.3.2.2.4.2 BatterySize Attribute 29
30
The BatterySize attribute is an enumeration which specifies the type of battery 31
being used by the device. This attribute shall be set to one of the non-reserved 32
values listed in Table 3.20. 33
Table 3.20 Values of the BatterySize Attribute 34
35
BatterySize 36
Attribute Value Description
37
38
0x00 No battery
39
0x01 Built in 40
0x02 Other
41
42
0x03 AA 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 69

Table 3.20 Values of the BatterySize Attribute

1
BatterySize 2
Attribute Value Description
3
0x04 AAA
4
5
0x05 C 6
0x06 D 7
8
0x07 – 0xfe Reserved 9
0xff Unknown 10
11
12
3.3.2.2.4.3 BatteryAHrRating Attribute
13
The BatteryAHrRating attribute is 16-bits in length and specifies the Ampere-hour 14
rating of the battery, measured in units of 10mAHr. 15
16
3.3.2.2.4.4 BatteryQuantity Attribute 17
18
The BatteryQuantity attribute is 8-bits in length and specifies the number of 19
battery cells used to power the device. 20
21
3.3.2.2.4.5 BatteryRatedVoltage Attribute 22
The BatteryRatedVoltage attribute is 8-bits in length and specifies the rated 23
voltage of the battery being used in the device, measured in units of 100mV. 24
25
26
3.3.2.2.4.6 BatteryAlarmMask Attribute
27
The BatteryAlarmMask attribute is 8-bits in length and specifies which mains 28
alarms may be generated, as listed in Table 3.21. A ‘1’ in each bit position enables 29
the alarm. 30
Table 3.21 Values of the MainsAlarmMask Attribute 31
32
MainsAlarmMask 33
Alarm 34
Attribute Bit Number
35
0 Battery voltage too low (7.2.2.4.7)
36
1–7 Reserved 37
38
3.3.2.2.4.7 BatteryVoltageMinThreshold Attribute 39
40
The BatteryVoltageMinThreshold attribute is 8-bits in length and specifies the low 41
voltage alarm threshold, measured in units of 100mV, for the BatteryVoltage 42
attribute. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
70 General Specification

If the value of BatteryVoltage drops below the threshold specified by

BatteryVoltageMinThreshold an alarm shall be generated. 1
2
The Alarm Code field (see 3.11.2.3.1) included in the generated alarm shall be 3
0x10. 4
If this attribute takes the value 0xff then this alarm shall not be generated. 5
6
3.3.2.3 Commands Received 7
8
No commands are received by the server. 9
10
3.3.2.4 Commands Generated 11
The server generates no commands. 12
13
14
3.3.3 Client 15
16
3.3.3.1 Dependencies 17
18
None 19
20
3.3.3.2 Attributes 21
The client has no attributes. 22
23
3.3.3.3 Commands Received 24
25
No cluster specific commands are received by the client. 26
27
3.3.3.4 Commands Generated 28
No cluster specific commands are generated by the client. 29
30
31
3.4 Device Temperature Configuration Cluster 32
33
34
3.4.1 Overview 35
36
Attributes for determining information about a device’s internal temperature, and 37
for configuring under/over temperature alarms for temperatures that are outside 38
the device's operating range. 39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 71

3.4.2 Server 1
2
3.4.2.1 Dependencies 3
For the alarm functionality described in this cluster to be operational, any 4
endpoint that implements the Device Temperature Configuration server cluster 5
shall also implement the Alarms server cluster (see 3.11). 6
7
3.4.2.2 Attributes 8
9
For convenience, the attributes defined in this specification are arranged into sets 10
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 11
are encoded such that the most significant three nibbles specify the attribute set 12
and the least significant nibble specifies the attribute within the set. The currently 13
defined attribute sets are listed in Table 3.22. 14
Table 3.22 Device Temperature Configuration Attribute Sets 15
16
Attribute Set 17
Identifier Description
18
0x000 Device Temperature Information
19
20
0x001 Device Temperature Settings 21
0x002 – 0xfff Reserved 22
23
24
3.4.2.2.1 Device Temperature Information Attribute Set
25
The Device Temperature Information attribute set contains the attributes 26
summarized in Table 3.23. 27
28
Table 3.23 Attributes of the Device Temperature Information Attribute Set
29
30
Identifier Name Type Range Access Default Mandatory
/ Optional 31
32
0x0000 CurrentTemperature Signed -200 to +200 Read - M 33
16-bit only
integer
34
35
0x0001 MinTempExperienced Signed -200 to +200 Read - O 36
16-bit only 37
integer
38
0x0002 MaxTempExperienced Signed -200 to +200 Read - O 39
16-bit only 40
integer
41
0x0003 OverTempTotalDwell Unsigned 0x0000 – Read 0 O 42
16-bit 0xffff only 43
integer 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
72 General Specification

3.4.2.2.1.1 CurrentTemperature Attribute

1
The CurrentTemperature attribute is 16 bits in length and specifies the current 2
internal temperature, in degrees Celsius, of the device. This attribute shall be 3
specified in the range –200 to +200. 4
The value 0xffff indicates an invalid reading. 5
6
3.4.2.2.1.2 MinTempExperienced Attribute 7
8
The MinTempExperienced attribute is 16 bits in length and specifies the minimum 9
internal temperature, in degrees Celsius, the device has experienced while 10
powered. This attribute shall be specified in the range –200 to +200. 11
12
The value 0xffff indicates an invalid reading.
13
14
3.4.2.2.1.3 MaxTempExperienced Attribute 15
The MaxTempExperienced attribute is 16 bits in length and specifies the 16
maximum internal temperature, in degrees Celsius, the device has experienced 17
while powered. This attribute shall be specified in the range –200 to +200. 18
19
The value 0xffff indicates an invalid reading. 20
21
3.4.2.2.1.4 OverTempTotalDwell Attribute 22
The OverTempTotalDwell attribute is 16 bits in length and specifies the length of 23
time, in hours, the device has spent above the temperature specified by the 24
HighTempThreshold attribute 3.4.2.2.2.3, cumulative over the lifetime of the 25
device. 26
27
The value 0xffff indicates an invalid time. 28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 73

3.4.2.2.2 Device Temperature Settings Attribute Set

1
The Device Temperature Settings attribute set contains the attributes summarized 2
in Table 3.24. 3
Table 3.24 Attributes of the Device Temperature Settings Attribute Set 4
5

Mandatory
6

/ Optional
Identifier Name Type Range Access Default 7
8
9
0x0010 DeviceTempAlarmMask Bitmap 0000 00xx Read/ 0000 O 10
(8-bit) write 0000 11
0x0011 LowTempThreshold Signed -200 to +200 Read/ - O 12
16-bit integer write 13
14
0x0012 HighTempThreshold Signed -200 to +200 Read/ - O
16-bit integer write 15
16
0x0013 LowTempDwellTripPoint Unsigned 0x000000 – Read/ - O 17
24-bit integer 0xffffff write
18
0x0014 HighTempDwellTripPoint Unsigned 0x000000 – Read/ - O 19
24-bit integer 0xffffff write 20
21
All attributes in this table require the Alarms cluster to be implemented on the 22
same device - see Dependencies. If the Alarms cluster is not present on the same 23
device they may be omitted. 24
25
3.4.2.2.2.1 DeviceTempAlarmMask Attribute 26
27
The DeviceTempAlarmMask attribute is 8-bits in length and specifies which 28
alarms may be generated, as listed in Table 3.25. A ‘1’ in each bit position enables 29
the corresponding alarm. 30
Table 3.25 Values of the DeviceTempAlarmMask Attribute 31
32
DeviceTempAlarmMask 33
Alarm
Attribute Bit Number 34
0 Device Temperature too low (8.2.2.2.2) 35
36
1 Device Temperature too high (8.2.2.2.3) 37
2–7 Reserved 38
39
40
3.4.2.2.2.2 LowTempThreshold Attribute 41
The LowTempThreshold attribute is 16-bits in length and specifies the lower alarm 42
threshold, measured in degrees Celsius (range -200°C to 200°C), for the 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
74 General Specification

CurrentTemperature attribute. The value of this attribute shall be less than

HighTempThreshold. 1
2
If the value of CurrentTemperature drops below the threshold specified by 3
LowTempThreshold, the device shall start a timer to expire after 4
LowTempDwellTripPoint seconds. If the value of this attribute increases to greater 5
than or equal to LowTempThreshold before the timer expires, the device shall stop 6
and reset the timer. If the timer expires, an alarm shall be generated. 7
The Alarm Code field (see 3.11.2.3.1) included in the generated alarm shall be 8
0x00. 9
10
If this attribute takes the value 0x8000 then this alarm shall not be generated. 11
12
3.4.2.2.2.3 HighTempThreshold Attribute 13
The HighTempThreshold attribute is 16-bits in length and specifies the upper 14
alarm threshold, measured in degrees Celsius (range -200°C to 200°C), for the 15
CurrentTemperature attribute. The value of this attribute shall be greater than 16
LowTempThreshold. 17
18
If the value of CurrentTemperature rises above the threshold specified by 19
HighTempThreshold, the device shall start a timer to expire after 20
HighTempDwellTripPoint seconds. If the value of this attribute drops to lower 21
than or equal to HighTempThreshold before the timer expires, the device shall stop 22
and reset the timer. If the timer expires, an alarm shall be generated. 23
The Alarm Code field (see 3.11.2.3.1) included in the generated alarm shall be 24
0x01. 25
26
If this attribute takes the value 0x8000 then this alarm shall not be generated. 27
28
3.4.2.2.2.4 LowTempDwellTripPoint Attribute 29
30
The LowTempDwellTripPoint attribute is 24-bits in length and specifies the length 31
of time, in seconds, that the value of CurrentTemperature may exist below 32
LowTempThreshold before an alarm is generated. 33
If this attribute takes the value 0xffffff then this alarm shall not be generated. 34
35
3.4.2.2.2.5 HighTempDwellTripPoint Attribute 36
37
The HighTempDwellTripPoint attribute is 24-bits in length and specifies the 38
length of time, in seconds, that the value of CurrentTemperature may exist above 39
HighTempThreshold before an alarm is generated. 40
If this attribute takes the value 0xffffff then this alarm shall not be generated. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 75

3.4.2.3 Commands Received

1
No commands are received by the server. 2
3
3.4.2.4 Commands Generated 4
5
The server generates no commands. 6
7
3.4.3 Client 8
9
3.4.3.1 Dependencies 10
11
None 12
13
3.4.3.2 Attributes 14
The client has no attributes. 15
16
3.4.3.3 Commands Received 17
18
No cluster specific commands are received by the client. 19
20
3.4.3.4 Commands Generated 21
22
No cluster specific commands are generated by the client. 23
24
3.5 Identify Cluster 25
26
27
3.5.1 Overview 28
29
Attributes and commands to put a device into an Identification mode (e.g. flashing 30
a light), that indicates to an observer – e.g. an installer - which of several devices 31
it is, also to request any device that is identifying itself to respond to the initiator. 32
33
Note that this cluster cannot be disabled, and remains functional regardless of the 34
setting of the DeviceEnable attribute in the Basic cluster. 35
36
3.5.2 Server 37
38
3.5.2.1 Dependencies 39
40
None 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
76 General Specification

3.5.2.2 Attributes
1
The server supports the attribute shown in Table 3.26. 2
Table 3.26 Attributes of the Identify Server Cluster 3
4
Mandatory 5
Identifier Name Type Range Access Default
/ Optional 6
7
0x0000 IdentifyTime Unsigned 0x0000 – Read / 0x0000 M
16-bit integer 0xffff write
8
9
10
3.5.2.2.1 IdentifyTime Attribute 11
The IdentifyTime attribute specifies the remaining length of time, in seconds, that 12
the device will continue to identify itself. 13
14
If this attribute is set to a value other than 0x0000 then the device shall enter its 15
identification procedure, in order to indicate to an observer which of several 16
devices it is. It is recommended that this procedure consists of flashing a light 17
with a period of 0.5 seconds. The IdentifyTime attribute shall be decremented 18
every second. 19
If this attribute reaches or is set to the value 0x0000 then the device shall 20
terminate its identification procedure. 21
22
3.5.2.3 Commands Received 23
24
The server side of the identify cluster is capable of receiving the commands listed 25
in Table 3.27. 26
Table 3.27 Received Command IDs for the Identify Cluster 27
28
Command Identifier Field Mandatory 29
Description
Value / Optional 30
31
0x00 Identify M
32
0x01 Identify Query M 33
0x02 – 0xff Reserved 34
35
36
3.5.2.3.1 Identify Command 37
The identify command starts or stops the receiving device identifying itself. 38
39
3.5.2.3.1.1 Payload Format 40
41
The identify query response command payload shall be formatted as illustrated in 42
Figure 3.4. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 77

1
Octets 2 2
3
Data Type Unsigned 16-bit Integer 4
Field Name Identify Time 5
6
7
Figure 3.4 Format of the Identify Query Response Command Payload
8
9
3.5.2.3.1.2 Effect on Receipt
10
On receipt of this command, the device shall set the IdentifyTime attribute to the 11
value of the Identify Time field. This then starts, continues, or stops the device's 12
identification procedure as detailed in 3.5.2.2.1. 13
14
3.5.2.3.2 Identify Query Command 15
The identify query command allows the sending device to request the target or 16
targets to respond if they are currently identifying themselves. 17
18
This command has no payload. 19
20
3.5.2.3.2.1 Effect on Receipt 21
On receipt of this command, if the device is currently identifying itself then it 22
shall generate an appropriate Identify Query Response command, see 3.5.2.4.1, 23
and unicast it to the requester. If the device is not currently identifying itself it 24
shall take no further action. 25
26
3.5.2.4 Commands Generated 27
28
The server side of the identify cluster is capable of generating the commands 29
listed in Table 3.28. 30
Table 3.28 Generated Command IDs for the Identify Cluster 31
32
Command Identifier Field Mandatory 33
Description
Value / Optional 34
35
0x00 Identify Query Response M
36
0x01 – 0xff Reserved 37
38
3.5.2.4.1 Identify Query Response Command 39
40
The identify query response command is generated in response to receiving an 41
Identify Query command, see 3.5.2.3.1, in the case that the device is currently 42
identifying itself. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
78 General Specification

3.5.2.4.1.1 Payload Format

1
The identify query response command payload shall be formatted as illustrated in 2
Figure 3.5. 3
4
5
Octets 2 6
7
Data Type Unsigned 16-bit Integer
8
Field Name Timeout 9
10
11
Figure 3.5 Format of the Identify Query Response Command Payload 12
13
3.5.2.4.1.2 Timeout Field 14
The Timeout field contains the current value of the IdentifyTime attribute, and 15
specifies the length of time, in seconds, that the device will continue to identify 16
itself. 17
18
3.5.2.4.1.3 Effect on Receipt 19
20
On receipt of this command, the device is informed of a device in the network 21
which is currently identifying itself. This information may be particularly 22
beneficial in situations where there is no commissioning tool. Note that there may 23
be multiple responses. 24
25
26
3.5.3 Client 27
28
3.5.3.1 Dependencies 29
None. 30
31
3.5.3.2 Attributes 32
33
The client has no attributes. 34
35
3.5.3.3 Commands Received 36
The client receives the cluster specific response commands detailed in 3.5.2.3. 37
38
3.5.3.4 Commands Generated 39
40
The client generates the cluster specific commands detailed in 3.5.2.4, as required 41
by the application. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 79

3.6 Groups Cluster 1

2
3.6.1 Overview 3
4
The ZigBee specification provides the capability for group addressing. That is, 5
any endpoint on any device may be assigned to one or more groups, each labeled 6
with a 16-bit identifier (0x0001 – 0xfff7), which acts for all intents and purposes 7
like a network address. Once a group is established, frames, sent using the 8
APSDE-DATA.request primitive and having a DstAddrMode of 0x01, denoting 9
group addressing, will be delivered to every endpoint assigned to the group 10
address named in the DstAddr parameter of the outgoing APSDE-DATA.request 11
primitive on every device in the network for which there are such endpoints. 12
13
Management of group membership on each device and endpoint is implemented 14
by the APS, but the over-the-air messages that allow for remote management and 15
commissioning of groups are defined here in the cluster library on the theory that, 16
while the basic group addressing facilities are integral to the operation of the 17
stack, not every device will need or want to implement this management cluster. 18
Furthermore, the placement of the management commands here allows developers 19
of proprietary profiles to avoid implementing the library cluster but still exploit 20
group addressing. 21
Commands are defined here for discovering the group membership of a device, 22
adding a group, removing a group and removing all groups. 23
24
Finally, the group cluster allows application entities to store a name string for each 25
group to which they are assigned and to report that name string in response to a 26
client request. 27
Note that configuration of group addresses for outgoing commands is achieved 28
using the APS binding mechanisms, and is not part of this cluster. 29
30
31
3.6.2 Server 32
33
Each ZigBee device that implements this cluster may be thought of as a group 34
management server in the sense that it responds to information requests and 35
configuration commands regarding the contents of its group table. 36
Note that, since these commands are simply data frames sent using the 37
APSDE_SAP, they must be addressed with respect to device and endpoint. In 38
particular the destination device and endpoint of a group management command 39
must be unambiguous at the time of the issuance of the primitive either because: 40
41
• They are explicitly spelled out in the DstAddr and DstEndpoint parameters of 42
the primitive. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
80 General Specification

• They are not explicitly spelled out but may be derived from the binding table in
the APS of the sending device. 1
2
• Broadcast addressing is being employed, either with respect to the device 3
address or the endpoint identifier. 4
• Group addressing is being employed. 5
6
On receipt of a group cluster command, the APS will, at least conceptually, 7
deliver the frame to each destination endpoint spelled out in the addressing 8
portion of the APS header and, again conceptually speaking, the application entity 9
resident at that endpoint will process the command and respond as necessary. 10
From an implementation standpoint, of course, this may be done in a more 11
economical way that does not involve duplication and separate processing, e.g by 12
providing a hook in the APS whereby group cluster commands could be delivered 13
to a special application entity without duplication. 14
15
3.6.2.1 Dependencies 16
For correct operation of the 'Add group if identifying' command, any endpoint 17
that implements the Groups server cluster shall also implement the Identify server 18
cluster. 19
20
3.6.2.2 Attributes 21
22
The server supports the attribute shown in Table 3.29. 23
Table 3.29 Attributes of the Groups Server Cluster 24
25
Mandatory 26
Identifier Name Type Range Access Default / Optional 27
28
0x0000 NameSupport 8-bit bitmap x0000000 Read only - M
29
30
The most significant bit of the NameSupport attribute indicates whether or not 31
group names are supported. A value of 1 indicates that they are supported, and a 32
value of 0 indicates that they are not supported. 33
3.6.2.2.1 Group Names 34
35
Group names are between 0 and 16 characters long. Support of group names is 36
optional, and is indicated by the NameSupport attribute. Group names, if 37
supported, must be stored in a separate data structure managed by the application 38
in which the entries correspond to group table entries. 39
3.6.2.2.2 Commands Received 40
41
The groups cluster is concerned with management of the group table on a device. 42
In practice, the group table is managed by the APS and the table itself is available 43
to the next higher layer as an AIB attribute. A command set is defined here and 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 81

the implementation details of that command set in terms of the facilities provided
by the APS is left up to the implementer of the cluster library itself. 1
2
The server side of the groups cluster is capable of receiving the commands listed 3
in Table 3.30. 4
Table 3.30 Received Command IDs for the Groups Cluster 5
6
Command Identifier Field Description Mandatory 7
Value / Optional 8
0x00 Add group M 9
10
0x01 View group M 11
0x02 Get group membership M 12
13
0x03 Remove group M 14
0x04 Remove all groups M 15
16
0x05 Add group if identifying M
17
0x06 – 0xff Reserved - 18
19
3.6.2.2.3 Add Group Command 20
21
The add group command allows the sending device to add group membership in a 22
particular group for one or more endpoints on the receiving device. 23
24
3.6.2.2.3.1 Payload Format 25
26
The Add Group command payload shall be formatted as illustrated in Figure 3.6
27
28
Variable 29
Octets
30
Data Type Unsigned 16-bit Integer Character string 31
32
Field Name Group ID Group Name 33
34
35
Figure 3.6 Format of the Add Group Command Payload
36
3.6.2.2.3.2 Effect on Receipt 37
38
On receipt of this command, the device shall (if possible) add the Group ID and 39
Group Name to its Group Table. It shall then generate an appropriate Add Group 40
Response command indicating success or failure. See 3.6.2.3.1. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
82 General Specification

3.6.2.2.4 View Group Command

1
The view group command allows the sending device to request that the receiving 2
entity or entities respond with a view group response command containing the 3
application name string for a particular group. 4
5
3.6.2.2.4.1 Payload Format 6
7
The View Group command payload shall be formatted as illustrated in Figure 3.7.
8
9
2 10
Octets
11
Data Type Unsigned 16-bit Integer 12
13
Field Name Group ID 14
15
16
Figure 3.7 Format of the View Group Command Payload
17
3.6.2.2.4.2 Effect on Receipt 18
19
On receipt of this command, the device shall generate an appropriate View Group 20
Response command. 3.6.2.3.2. 21
22
3.6.2.2.5 Get Group Membership Command
23
The get group membership command allows the sending device to inquire about 24
the group membership of the receiving device and endpoint in a number of ways. 25
26
3.6.2.2.5.1 Payload Format 27
28
The get group membership command payload shall be formatted as illustrated in 29
Figure 3.8. 30
31
32
Octets 1 Variable
33
Unsigned 8-bit Integer List of 16-bit Integer 34
Data Type
35
Field Name Group count Group list 36
37
38
Figure 3.8 Format of the Get Group Membership Command Payload 39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 83

3.6.2.2.5.2 Effect on Receipt

1
On receipt of the get group membership command, each receiving entity shall 2
respond, as necessary, with group membership information using the get group 3
membership response frame shown below. An entity shall respond if and only if: 4
• The group count field of the command frame has a value of 0 indicating that the 5
group list field is empty, or 6
7
• The group list field of the command frame contains at least one group of which 8
the entity is a member. In this case the response frame will contain the 9
identifiers of all such groups. 10
3.6.2.2.6 Remove Group Command 11
12
The remove group command allows the sender to request that the receiving entity 13
or entities remove their membership, if any, in a particular group. 14
Note that if a group is removed the scenes associated with that group should be 15
removed. 16
17
18
3.6.2.2.6.1 Payload Format
19
The Remove Group command payload shall be formatted as illustrated in 20
Figure 3.9. 21
22
23
Octets 2 24
25
Data Type Unsigned 16-bit Integer 26
27
Field Name Group ID
28
29
Figure 3.9 Format of the Remove Group Command Payload 30
31
3.6.2.2.6.2 Effect on Receipt 32
33
On receipt of this command, the device shall (if possible) remove the Group ID 34
and Group Name from its Group Table. It shall then generate an appropriate 35
Remove Group Response command indicating success or failure. See 3.6.2.3.4. 36
3.6.2.2.7 Remove All Groups Command 37
38
The remove all groups command allows the sending device to direct the receiving 39
entity or entities to remove all group associations. 40
Note that removing all groups necessitates the removal of all associated scenes as 41
well. (Note: scenes not associated with a group need not be removed). 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
84 General Specification

3.6.2.2.7.1 Payload Format

1
The Remove All Groups command has no payload. 2
3
3.6.2.2.7.2 Effect on Receipt 4
5
On receipt of this command, the device shall remove all groups on this endpoint
6
from its Group Table.
7
3.6.2.2.8 Add Group If Identifying Command 8
9
The add group if identifying command allows the sending device to add group 10
membership in a particular group for one or more endpoints on the receiving 11
device, on condition that it is identifying itself. Identifying functionality is 12
controlled using the identify cluster, (see 3.5). 13
This command might be used to assist configuring group membership in the 14
absence of a commissioning tool. 15
16
3.6.2.2.8.1 Payload Format 17
18
The Add Group If Identifying command payload shall be formatted as illustrated 19
in Figure 3.10. 20
21
22
Octets 2 Variable
23
Unsigned 16-bit Integer Character string 24
Data Type
25
Field Name Group ID Group Name 26
27
28
Figure 3.10 Format of the Add Group If Identifying Command Payload 29
30
3.6.2.2.8.2 Effect on Receipt 31
On receipt of this command, the device shall first check whether it is currently 32
identifying itself. If so then the device shall (if possible) add the Group ID and 33
Group Name to its Group Table. If the device it not currently identifying itself 34
then no action shall be taken. 35
36
No response is defined as this command is expected to be multicast or broadcast. 37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 85

3.6.2.3 Commands Generated

1
The commands generated by the server side of the groups cluster, as listed in 2
Table 3.31, are responses to the received commands listed above in sub- 3
clause 3.6.2.2.2. 4
Table 3.31 Generated Command IDs for the Groups Cluster 5
6
Command Identifier Field Mandatory 7
Description
Value / Optional 8
9
0x00 Add group response M
10
0x01 View group response M 11
12
0x02 Get group membership response M
13
0x03 Remove group response M 14
0x04 – 0xff Reserved 15
16
17
(Note:-There is no need for a response to the Remove all Groups command, as, at 18
an application level, this command always succeeds) 19
3.6.2.3.1 Add Group Response Command 20
21
The add group response is sent by the groups cluster server in response to an add 22
group command. 23
24
3.6.2.3.1.1 Payload Format 25
The Add Group Response command payload shall be formatted as illustrated in 26
Figure 3.11. 27
28
29
Octets 1 2 30
31
Data Type 8-bit Enumeration Unsigned 16-bit Integer 32
33
Field Name Status Group ID 34
35
Figure 3.11 Format of the Add Group Response Command Payload 36
37
3.6.2.3.1.2 When Generated 38
39
This command is generated in response to a received Add Group command 40
10.2.2.3. The Status field is set to SUCCESS, DUPLICATE_EXISTS, or 41
INSUFFICIENT_SPACE as appropriate. The Group ID field is set to the Group 42
ID field of the received Add Group command. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
86 General Specification

3.6.2.3.2 View Group Response Command

1
The view group response command is sent by the groups cluster server in 2
response to a view group command. 3
4
3.6.2.3.2.1 Payload Format 5
6
The View Group Response command payload shall be formatted as illustrated in
7
Figure 3.12.
8
9
1 2 Variable 10
Octets
11
Data Type 8-bit Enumeration Unsigned 16-bit Integer Character string 12
13
Field Name Status Group ID Group Name 14
15
16
Figure 3.12 Format of the View Group Response Command Payload
17
3.6.2.3.2.2 When Generated 18
19
This command is generated in response to a received View Group command 20
10.2.2.4. The Status field is set to SUCCESS or NOT_FOUND as appropriate. 21
The Group ID field is set to the Group ID field of the received View Group 22
command. If the status is SUCCESS, and group names are supported, the Group 23
Name field is set to the Group Name associated with that Group ID in the Group 24
Table; otherwise it is set to the null (empty) string, i.e. a single octet of value 0. 25
26
3.6.2.3.3 Get Group Membership Response Command
27
The get group membership response command is sent by the groups cluster server 28
in response to a get group membership command. 29
30
3.6.2.3.3.1 Payload Format 31
32
The payload of the get group membership response command is formatted as 33
shown in Figure 3.13. 34
35
36
Octets 1 1 Variable
37
Unsigned 8-bit Integer Unsigned 8-bit Integer List of 16-bit group ID 38
Data Type
39
Field Name Capacity Group count Group list 40
41
42
Figure 3.13 Format of the Get Group Membership Response 43
Command Payload
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 87

The fields of the get group membership response command have the following
semantics: 1
2
• The Capacity field shall contain the remaining capacity of the group table of 3
the device. The following values apply: 4
0No further groups may be added. 5
0 < Capacity < 0xfeCapacity holds the number of groups that may be added 6
0xfeAt least 1 further group may be added (exact number is unknown) 7
0xffIt is unknown if any further groups may be added 8
• The Group count field shall contain the number of groups contained in the 9
group list field. 10
11
• The Group list field shall contain the identifiers either of all the groups in the 12
group table (in the case where the group list field of the received get group 13
membership command was empty) or all the groups from the group list field of 14
the received get group membership command which are in the group table. 15
16
3.6.2.3.3.2 When Generated 17
When an application entity receives the get group membership command and 18
either the group list of the command payload is empty or the group list contains at 19
least one group to which the entity belongs, the entity shall respond with a get 20
group membership response command. 21
22
3.6.2.3.4 Remove Group Response Command 23
24
The remove group response command is generated by an application entity in
25
response to the receipt of a remove group command.
26
27
3.6.2.3.4.1 Payload Format 28
The Remove Group Response command payload shall be formatted as illustrated 29
in Figure 3.14. 30
31
32
Octets 1 2 33
34
Data Type 8-bit Enumeration Unsigned 16-bit Integer 35
36
Field Name Status Group ID
37
38
Figure 3.14 Format of the Remove Group Response Command Payload 39
40
3.6.2.3.4.2 When Generated 41
42
This command is generated in response to a received Remove Group command 43
3.6.2.2.6. The Status field is set to SUCCESS or NOT_FOUND as appropriate. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
88 General Specification

The Group ID field is set to the Group ID field of the received Remove Group
command. 1
2
3
3.6.3 Client 4
5
3.6.3.1 Dependencies 6
7
None.
8
3.6.3.2 Attributes 9
10
The Client cluster has no attributes. 11
12
3.6.3.3 Commands Received 13
14
The client receives the cluster specific response commands detailed in 3.6.2.3. 15
16
3.6.3.4 Commands Generated 17
The client generates the cluster specific commands detailed in 3.6.3.3. 18
19
20
3.7 Scenes Cluster 21
22
23
3.7.1 Overview 24
25
Attributes and commands for setting up and recalling scenes. Each scene 26
corresponds to a set of stored values of specified attributes. 27
28
In most cases scenes are associated with a particular group ID. Scenes may also
29
exist without a group, in which case the value 0x0000 replaces the group ID. Note
30
that extra care is required in these cases to avoid a scene ID collision, and that
31
commands related to scenes without a group may only be unicast, i.e.: they may
32
not be multicast or broadcast.
33
34
3.7.2 Server 35
36
3.7.2.1 Dependencies 37
38
Any endpoint that implements the Scenes server cluster shall also implement the 39
Groups server cluster. 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 89

3.7.2.2 Attributes
1
For convenience, the attributes defined in this specification are arranged into sets 2
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 3
are encoded such that the most significant three nibbles specify the attribute set 4
and the least significant nibble specifies the attribute within the set. The currently 5
defined attribute sets are listed in Table 3.32. 6
Table 3.32 Scenes Attribute Sets 7
8
Attribute Set 9
Description
Identifier 10
11
0x000 Scene Management Information
12
0x001 – 0xfff Reserved 13
14
3.7.2.2.1 Scene Management Information Attribute Set 15
16
The Scene Management Information attribute set contains the attributes 17
summarized in Table 3.33. 18
Table 3.33 Attributes of the Scene Management Information Attribute Set 19
20

Mandatory
21

/ Optional
22
Identifier Name Type Range Access Default
23
24
0x0000 SceneCount Unsigned 0x00 – 0xff Read only 0x00 M 25
8-bit integer (see 3.7.2.3.1) 26
27
0x0001 CurrentScene Unsigned 0x00 – 0xff Read only 0x00 M 28
8-bit integer (see 3.7.2.3.1)
29
0x0002 CurrentGroup Unsigned 0x0000 – 0xfff7 Read only 0x00 M 30
16-bit 31
integer
32
0x0003 SceneValid Boolean 0x00 – 0x01 Read only 0x00 M 33
34
0x0004 NameSupport 8-bit bitmap x0000000 Read only - M
35
0x0005 LastConfiguredBy IEEE - Read only - O 36
Address 37
38
The most significant bit of the NameSupport attribute indicates whether or not 39
group names are supported. A value of 1 indicates that they are supported, and a 40
value of 0 indicates that they are not supported. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
90 General Specification

3.7.2.2.1.1 SceneCount Attribute

1
The SceneCount attribute specifies the number of scenes currently in the device's 2
scene table. 3
4
3.7.2.2.1.2 CurrentScene Attribute 5
6
The CurrentScene attribute holds the Scene ID of the scene last invoked.
7
8
3.7.2.2.1.3 CurrentGroup Attribute 9
The CurrentGroup attribute holds the Group ID of the scene last invoked, or 10
0x0000 if the scene last invoked is not associated with a group. 11
12
3.7.2.2.1.4 SceneValid Attribute 13
14
The SceneValid attribute indicates whether the state of the device corresponds to 15
the values of the CurrentScene and CurrentGroup attributes. 0x01 indicates that 16
these attributes are valid, 0x00 indicates that they are not valid. 17
Before a scene has been stored or recalled, this attribute is set to 0x00. After a 18
successful Store Scene or Recall Scene command it is set to 0x01. If, after a scene 19
is stored or recalled, the state of the device is modified, this attribute is set to 20
0x00. 21
22
3.7.2.2.1.5 NamesSupported Attribute 23
24
The most significant bit of the NameSupport attribute indicates whether or not 25
group names are supported. A value of 1 indicates that they are supported, and a 26
value of 0 indicates that they are not supported. 27
28
3.7.2.2.1.6 LastConfiguredBy Attribute 29
30
The LastConfiguredBy attribute is 64-bits in length and specifies the IEEE address 31
of the device that last configured the scene table. 32
The value 0xffffffffffffffff indicates that the device has not been configured, or 33
that the address of the device that last configured the scenes cluster is not known. 34
35
36
37
3.7.2.3 Scene Table 38
The scene table is used to store information for each scene capable of being 39
invoked on a device. Each scene is defined for a particular group. 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 91

The fields of each scene table entry consist of a number of sets. The base set
consists of the first four fields of Table 3.34. A set of extension fields can be 1
added by each additional cluster implemented on a device. 2
3
Table 3.34 Fields of a Scene Table Entry
4
Field Type Valid Range Description 5
6
Scene group ID Unsigned 0x0000 – 0xfff7 The group ID for which this 7
16-bit integer scene applies, or 0x0000 if 8
the scene is not associated 9
with a group.
10
Scene ID Unsigned 0x00 – 0xff The identifier, unique within 11
8-bit integer (see 3.7.2.3.1) this group, which is used to 12
identify this scene.
13
Scene name Character string 0 – 16 characters The name of the scene 14
(optional) 15
Scene transition time Unsigned 0x0000 – 0xffff The amount of time, in 16
16-bit integer seconds, it will take for the 17
device to change from its 18
current state to the requested 19
scene. 20
Extension field sets Variable Variable See the Scene Table 21
Extensions subsections of 22
individual clusters. Each 23
extension field set holds a set
24
of values of attributes for a
cluster implemented on the 25
device. The sum of all such 26
sets defines a scene. 27
28
3.7.2.3.1 Scene Names 29
30
Scene names are between 0 and 16 characters long. Support of scene names is 31
optional, and is indicated by the NameSupport attribute. If scene names are not 32
supported, any commands that writes a scene name shall simply discard the name, 33
and any command that returns a scene names shall return the null string. 34
3.7.2.3.2 Maximum Number of Scenes 35
36
The number of scenes capable of being stored in the table is defined by the profile 37
in which this cluster is used. The default maximum, in the absence of specification 38
by the profile, is 16. 39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
92 General Specification

3.7.2.4 Commands Received

1
The received command IDs for the Scenes cluster are listed in Table 3.35. 2
Table 3.35 Received Command IDs for the Scenes Cluster 3
4
Command Identifier Field Mandatory 5
Description
Value / Optional 6
7
0x00 Add scene M
8
0x01 View scene M 9
10
0x02 Remove scene M
11
0x03 Remove all scenes M 12
0x04 Store scene M 13
14
0x05 Recall scene M 15
0x06 Get scene membership M 16
17
0x07 – 0xff Reserved 18
19
3.7.2.4.1 Add Scene Command 20
21
The Add Scene command shall be addressed to a single device (not a group).
22
23
3.7.2.4.1.1 Payload Format 24
The payload shall be formatted as illustrated in Figure 3.15. 25
26
27
Octets 2 1 2 Variable Variable 28
29
Unsigned 16- Unsigned 8- Unsigned 16- Character Variable (multiple 30
Data Type bit Integer bit Integer bit Integer string types) 31
Group ID Scene ID Transition time Scene Name Extension field sets, 32
Field Name one per cluster 33
34
Figure 3.15 Format of the Add Scene Command Payload 35
36
The format of each extension field set is a 16 bit field carrying the cluster ID, 37
followed by an 8 bit data length field and the set of scene extension fields 38
specified in the relevant cluster. 39
40
Extension field sets = 41
{{ClusterID 1, length 1, {extension field set 1}}, {ClusterID 2, length 2, 42
{extension field set 2 }}, ... }. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 93

3.7.2.4.1.2 Effect on Receipt

1
On receipt of this command, the device shall (if possible) create an entry in the 2
Scene Table with fields copied from the command payload. If there is already a 3
scene in the table with the same Scene ID and Group ID, it shall overwrite it. 4
It shall then generate an appropriate Add Scene Response command indicating 5
success or failure. See 3.7.2.5.1. 6
7
3.7.2.4.2 View Scene Command 8
The View Scene command shall be addressed to a single device (not a group). 9
10
11
3.7.2.4.2.1 Payload Format
12
The payload shall be formatted as illustrated in Figure 3.16. 13
14
15
Octets 2 1 16
17
Data Type Unsigned 16-bit Integer Unsigned 8-bit Integer 18
19
Field Name Group ID Scene ID
20
21
Figure 3.16 Format of the View Scene Command Payload 22
23
3.7.2.4.2.2 Effect on Receipt 24
25
On receipt of this command, the device shall generate an appropriate View Scene 26
Response command. See 3.7.2.5.2. 27
3.7.2.4.3 Remove Scene Command 28
29
The Remove Scene command may be addressed to a single device or to a group. 30
31
3.7.2.4.3.1 Payload Format 32
The Remove Scene command payload shall be formatted as illustrated in 33
Figure 3.17. 34
35
36
Octets 2 1 37
38
Data Type Unsigned 16-bit Integer Unsigned 8-bit Integer 39
40
Field Name Group ID Scene ID 41
42
Figure 3.17 Format of the Remove Scene Command Payload 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
94 General Specification

3.7.2.4.3.2 Effect on Receipt

1
On receipt of this command, the device shall (if possible) remove from its Scene 2
Table the entry with this Scene ID and group ID. If the command was addressed to 3
a single device (not a group) then it shall generate an appropriate Remove Scene 4
Response command indicating success or failure. See 3.7.2.5.3. 5
3.7.2.4.4 Remove All Scenes Command 6
7
The Remove All Scenes may be addressed to a single device or to a group. 8
9
3.7.2.4.4.1 Payload Format 10
11
The Remove All Scenes command payload shall be formatted as illustrated in 12
Figure 3.18. 13
14
15
Octets 2
16
Data Type Unsigned 16-bit Integer 17
18
Field Name Group ID 19
20
21
Figure 3.18 Format of the Remove All Scenes Command Payload
22
23
3.7.2.4.4.2 Effect on Receipt
24
On receipt of this command, the device shall, if possible, remove from its Scene 25
Table all entries with this Group ID. If the command was addressed to a single 26
device (not to a group) it shall then generate an appropriate Remove All Scenes 27
Response command indicating success or failure. See 3.7.2.5.4. 28
29
3.7.2.4.5 Store Scene Command 30
The Store Scene command may be addressed to a single device or to a group. 31
32
3.7.2.4.5.1 Payload Format 33
34
The Store Scene command payload shall be formatted as illustrated in 35
Figure 3.19. 36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 95

1
Octets 2 1 2
3
Data Type Unsigned 16-bit Integer Unsigned 8-bit Integer 4
5
Field Name Group ID Scene ID
6
7
Figure 3.19 Format of the Store Scene Command Payload 8
9
3.7.2.4.5.2 Effect on Receipt 10
11
On receipt of this command, the device shall (if possible) add an entry to the 12
Scene Table with the Scene ID and Group ID given in the command, and all 13
extension fields corresponding to the current state of other clusters on the device. 14
If an entry already exists with the same Scene ID and Group ID it will be replaced. 15
If the command was addressed to a single device (not to a group) then it shall 16
generate an appropriate Store Scene Response command indicating success or 17
failure. See 3.7.2.5.5. 18
19
3.7.2.4.6 Recall Scene Command 20
The Recall Scene command may be addressed to a single device or to a group. 21
22
3.7.2.4.6.1 Payload Format 23
24
The Recall Scene command payload shall be formatted as illustrated in 25
Figure 3.20. 26
27
28
Octets 2 1 29
30
Data Type Unsigned 16-bit Integer Unsigned 8-bit Integer
31
Group ID Scene ID 32
Field Name
33
34
Figure 3.20 Format of the Recall Scene Command Payload 35
36
3.7.2.4.6.2 Effect on Receipt 37
38
On receipt of this command, the device shall (if possible) locate the entry in its
39
Scene Table with the Group ID and Scene ID given in the command. For each
40
other cluster on the device, it shall then retrieve any corresponding extension
41
fields from the Scene Table and set the attributes and corresponding state of the
42
cluster accordingly.
43
This command does not result in a response command. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
96 General Specification

3.7.2.4.7 Get Scene Membership Command

1
The Get Scene Membership command can be used to find an unused scene 2
number within the group when no commissioning tool is in the network, or for a 3
commissioning tool to get used scenes for a group on a single device or on all 4
devices in the group. 5
6
3.7.2.4.7.1 Payload Format 7
8
The Get Scene Membership command may be addressed to a single device or to a
9
group.
10
The Get Scene Membership command payload shall be formatted as illustrated in 11
Figure 3.21. 12
13
14
Ocets 2 15
16
Data Type Unsigned 16-bit Integer
17
Group ID 18
Field Name
19
20
Figure 3.21 Format of the Get Scene Membership Command Payload 21
22
3.7.2.4.7.2 Effect on Receipt 23
24
On receipt of this command, the device shall if addressed to a single device
25
generate an appropriate Get Scene Membership Response command, otherwise it
26
shall only generate an appropriate Get Scene Membership Response command if
27
an entry within the Scene Table corresponds to the Group ID. See 3.7.2.5.6.
28
29
3.7.2.5 Commands Generated
30
The generated command IDs for the Scenes cluster are listed in Table 3.36. 31
32
Table 3.36 Generated Command IDs for the Scenes Cluster
33
Command Identifier Field Mandatory 34
Description 35
Value / Optional
36
0x00 Add scene response M 37
0x01 View scene response M 38
39
0x02 Remove scene response M
40
0x03 Remove all scenes response M 41
42
0x04 Store scene response M
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 97

Table 3.36 Generated Command IDs for the Scenes Cluster

1
Command Identifier Field Mandatory 2
Description
Value / Optional 3
0x05 Reserved -
4
5
0x06 Get scene membership response M 6
0x07 – 0xff Reserved - 7
8
9
3.7.2.5.1 Add Scene Response Command
10
11
3.7.2.5.1.1 Payload Format 12
The Add Scene Response command payload shall be formatted as illustrated in 13
Figure 3.22. 14
15
16
Octets 1 2 1 17
18
8-bit Enumeration Unsigned 16-bit Unsigned 8-bit Integer 19
Data Type Integer 20
Field Name Status Group ID Scene ID 21
22
23
Figure 3.22 Format of the Add Scene Response Command Payload 24
25
3.7.2.5.1.2 When Generated 26
This command is generated in response to a received Add Scene command 27
11.2.4.1. The Status field is set to SUCCESS, INSUFFICIENT_SPACE or 28
INVALID_FIELD (the group is not present in the Group Table) as appropriate. 29
The Group ID and Scene ID fields are set to the corresponding fields of the 30
received Add Scene command. 31
32
3.7.2.5.2 View Scene Response Command 33
34
3.7.2.5.2.1 Payload Format 35
36
The View Scene Response command payload shall be formatted as illustrated in
37
Figure 3.23.
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
98 General Specification

1
Octets 1 2 1 0/2 0 / Variable 0 / Variable 2
3
Data 8-bit Unsigned 16- Unsigned Unsigned Character Variable 4
Type Enumeration bit Integer 8-bit 16-bit string (multiple types) 5
Integer Integer
6
Field Status Group ID Scene ID Transition Scene Name Extension field 7
Name time sets, one per 8
cluster
9
10
Figure 3.23 Format of the View Scene Response Command Payload 11
12
The format of each extension field set is a 16 bit field carrying the cluster ID, 13
followed by an 8 bit data length field and the set of scene extension fields 14
specified in the relevant cluster. These fields are concatenated together in the 15
order given in the cluster. 16
Extension field sets = 17
{{ClusterID 1, length 1, {extension field set 1}}, {ClusterID 2, length 2, 18
{extension field set 2 }}, ... }. 19
20
3.7.2.5.2.2 When Generated 21
22
This command is generated in response to a received View Scene command 23
11.2.4.2. 24
25
The entry in the Scene Table with Scene ID and Group ID given in the received
26
View Scene command is located (if possible). The Status field is set to SUCCESS,
27
NOT_FOUND (the scene is not present in the Scene Table) or INVALID_FIELD
28
(the group is not present in the Group Table) as appropriate. The Group ID and
29
Scene ID fields are set to the corresponding fields in the received View Scene
30
command.
31
If the status is SUCCESS, the Transition time, Scene Name and Extension field 32
fields are copied from the corresponding fields in the table entry, otherwise they 33
are omitted. 34
35
3.7.2.5.3 Remove Scene Response Command
36
37
3.7.2.5.3.1 Payload Format 38
The Remove Scene Response command payload shall be formatted as illustrated 39
in Figure 3.24. 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 99

1
Octets 1 2 1 2
3
Data Type 8-bit Enumeration Unsigned 16-bit Integer Unsigned 8-bit Integer 4
5
Field Name Status Group ID Scene ID
6
7
Figure 3.24 Format of the Remove Scene Response Command Payload 8
9
3.7.2.5.3.2 When Generated 10
11
This command is generated in response to a received Remove Scene command 12
10.2.2.4. The Status field is set to SUCCESS, NOT_FOUND (the scene is not 13
present in the Scene Table) or INVALID_FIELD (the group is not present in the 14
Group Table) as appropriate. The Group ID and Scene ID fields are set to the 15
corresponding fields of the received Remove Scene command. 16
3.7.2.5.4 Remove All Scenes Response Command 17
18
3.7.2.5.4.1 Payload Format 19
20
The Remove All Scenes Response command payload shall be formatted as 21
illustrated in Figure 3.25. 22
23
24
Octets 1 2 25
26
Data Type 8-bit Enumeration Unsigned 16-bit Integer
27
Status Group ID 28
Field Name
29
30
Figure 3.25 Format of the Remove All Scenes Response 31
Command Payload 32
33
3.7.2.5.4.2 When Generated 34
This command is generated in response to a received Remove All Scenes 35
command, see 3.7.2.4.4. The Status field is set to SUCCESS or INVALID_FIELD 36
(the group is not present in the Group Table) as appropriate. The Group ID field is 37
set to the corresponding field of the received Remove All Scenes command. 38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
100 General Specification

3.7.2.5.5 Store Scene Response Command

1
3.7.2.5.5.1 Payload Format 2
3
The Store Scene Response command payload shall be formatted as illustrated in 4
Figure 3.26. 5
6
7
Octets 1 2 1 8
9
Data Type 8-bit Enumeration Unsigned 16-bit Integer Unsigned 8-bit Integer
10
Field Name Status Group ID Scene ID 11
12
Figure 3.26 Format of the Store Scene Response Command Payload 13
14
3.7.2.5.5.2 When Generated 15
16
This command is generated in response to a received Store Scene command 17
10.2.2.4. The Status field is set to SUCCESS, INSUFFICIENT_SPACE or 18
INVALID_FIELD (the group is not present in the Group Table) as appropriate. 19
The Group ID and Scene ID fields are set to the corresponding fields of the 20
received Store Scene command. 21
3.7.2.5.6 Get Scene Membership Response Command 22
23
24
3.7.2.5.6.1 Payload Format
25
The Get Scene Membership Response command payload shall be formatted as 26
illustrated in Figure 3.27. 27
28
29
Octets 1 1 2 0/1 Variable 30
31
Data 8-bit Unsigned Unsigned Unsigned Unsigned 32
Type Enumeration 8-bit Integer 16-bit Integer 8-bit Integer 8-bit Integer x N
33
Status Capacity Group ID Scene count Scene list 34
Field
Name 35
36
37
Figure 3.27 Format of the Get Scene Membership Response 38
Command Payload 39
40
The fields of the get scene membership response command have the following
41
semantics:
42
• The Capacity field shall contain the remaining capacity of the scene table of 43
the device. (for all groups). The following values apply: 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 101

0No further scenes may be added.

0 < Capacity < 0xfeCapacity holds the number of scenes that may be added 1
0xfeAt least 1 further scene may be added (exact number is unknown) 2
0xffIt is unknown if any further scenes may be added 3
4
• The Status field shall contain SUCCESS or INVALID_FIELD (the group is not 5
present in the Group Table) as appropriate. 6
• The Group ID field shall be set to the corresponding field of the received Get 7
Scene Membership command. 8
9
• If the status is not SUCCESS, then the Scene count and Scene list field are 10
omitted, else 11
• The Scene count field shall contain the number of scenes contained in the 12
Scene list field. 13
14
• The Scene list field shall contain the identifiers of all the scenes in the scene 15
table with the corresponding Group ID. 16
17
3.7.2.5.6.2 When Generated 18
This command is generated in response to a received Get Scene Membership 19
command, 3.7.2.4.7. 20
21
22
3.7.3 Client 23
24
3.7.3.1 Dependencies 25
26
None. 27
28
3.7.3.2 Attributes 29
The Client cluster has no attributes. 30
31
3.7.3.3 Commands Received 32
33
The client receives the cluster specific response commands detailed in 3.7.2.5. 34
35
3.7.3.4 Commands Generated 36
The client generates the cluster specific commands detailed in 3.7.2.4, as required 37
by the application. 38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
102 General Specification

3.8 On/Off Cluster 1

2
3.8.1 Overview 3
4
Attributes and commands for switching devices between ‘On’ and ‘Off’ states. 5
6
7
3.8.2 Server 8
9
3.8.2.1 Dependencies 10
11
None 12
13
3.8.2.2 Attributes 14
The server supports the attributes shown in Table 3.37. 15
16
Table 3.37 Attributes of the On/Off Server Cluster
17
18
Identifier Name Type Range Access Default Mandatory 19
/ Optional
20
0x0000 OnOff Boolean 0x00 – 0x01 Read only 0x00 M 21
22
The OnOff attribute has the following values: 0 = Off, 1 = On 23
24
3.8.2.3 Commands Received 25
26
The command IDs for the On/Off cluster are listed in Table 3.38. 27
Table 3.38 Command IDs for the On/Off Cluster 28
29
Command Identifier Field Mandatory 30
Description
Value / Optional 31
0x00 Off M 32
33
0x01 On M 34
0x02 Toggle M 35
36
0x03 – 0xff Reserved
37
38
3.8.2.3.1 Off Command 39
40
This command does not have a payload.
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 103

3.8.2.3.1.1 Effect on Receipt

1
On receipt of this command, a device shall enter its 'Off' state. This state is device 2
dependent, but it is recommended that it is used for power off or similar functions. 3
3.8.2.3.2 On Command 4
5
This command does not have a payload. 6
7
3.8.2.3.2.1 Effect on Receipt 8
9
On receipt of this command, a device shall enter its 'On' state. This state is device 10
dependent, but it is recommended that it is used for power on or similar functions. 11
3.8.2.3.3 Toggle Command 12
13
This command does not have a payload. 14
15
3.8.2.3.3.1 Effect on Receipt 16
On receipt of this command, if a device is in its ‘Off’ state it shall enter its 'On' 17
state. Otherwise, if it is in its ‘On’ state it shall enter its 'Off' state. 18
19
3.8.2.4 Commands Generated 20
21
The server generates no commands. 22
23
3.8.2.5 Scene Table Extensions 24
25
If the Scenes server cluster (11) is implemented, the following extension field is
26
added to the Scenes table:
27
OnOff 28
29
3.8.2.6 Attribute Reporting 30
This cluster shall support attribute reporting using the Report Attributes command 31
and according to the minimum and maximum reporting interval settings described 32
in the ZCL Foundation specification (see 2.4.7). The following attribute shall be 33
reported: 34
OnOff 35
36
37
3.8.3 Client 38
39
3.8.3.1 Dependencies 40
41
None.
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
104 General Specification

3.8.3.2 Attributes
1
The client has no attributes. 2
3
3.8.3.3 Commands Received 4
5
No cluster specific commands are received by the client. 6
7
3.8.3.4 Commands Generated 8
The client generates the cluster specific commands received by the server, as 9
required by the application. See 3.8.2.3 10
11
12
3.9 On/Off Switch Configuration Cluster 13
14
15
3.9.1 Overview 16
17
Attributes and commands for configuring On/Off switching devices 18
19
3.9.2 Server 20
21
22
3.9.2.1 Dependencies 23
Any endpoint that implements this server cluster shall also implement the On/Off 24
client cluster. 25
26
3.9.2.2 Attributes 27
28
For convenience, the attributes defined in this specification are arranged into sets 29
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 30
are encoded such that the most significant three nibbles specify the attribute set 31
and the least significant nibble specifies the attribute within the set. The currently 32
defined attribute sets are listed in Table 3.39. 33
Table 3.39 On/Off Switch Configuration Attribute Sets 34
35
Attribute Set 36
Description
Identifier 37
0x000 Switch Information 38
39
0x001 Switch Settings 40
0x002 – 0xfff Reserved 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 105

3.9.2.2.1 Switch Information Attribute Set

1
The switch information attribute set contains the attributes summarized in 2
Table 3.40. 3
Table 3.40 Attributes of the Switch Information Attribute Set 4
5
Identifier Name Type Range Access Default Mandatory 6
/ Optional 7
0x0000 SwitchType 8-bit 0x00 – 0x01 Read only - M
8
Enumeration 9
10
11
3.9.2.2.2 SwitchType Attribute
12
The SwitchType attribute specifies the basic functionality of the On/Off switching 13
device. This attribute shall be set to one of the non-reserved values listed in 14
Table 3.41. 15
16
Table 3.41 Values of the SwitchType Attribute
17
SwitchType 18
Description Details 19
Attribute Value
20
0x00 Toggle A switch with two physical states. An action by the 21
user (e.g. toggling a rocker switch) moves the
switch from state 1 to state 2. The switch then 22
remains in that state until another action from the 23
user returns it to state 1. 24
25
0x01 Momentary A switch with two physical states. An action by the
user (e.g. pressing a button) moves the switch from 26
state 1 to state 2. When the user ends his action (e.g. 27
releases the button) the switch returns to state 1. 28
0x02 – 0xff Reserved -
29
30
31
3.9.2.2.3 Switch Settings Attribute Set 32
The switch settings attribute set contains the attributes summarized in Table 3.42. 33
34
Table 3.42 Attributes of the Switch Settings Attribute Set
35
36
Mandatory
Identifier Name Type Range Access Default / Optional 37
38
0x0010 SwitchActions 8-bit 0x00 – 0x02 Read/ 0x00 M 39
Enumeration write 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
106 General Specification

3.9.2.2.3.1 SwitchActions Attribute

1
The SwitchActions attribute is 8-bits in length and specifies the commands of the 2
On/Off cluster (12) to be generated when the switch moves between its two states, 3
as detailed in Table 3.43. 4
Table 3.43 Values of the SwitchActions Attribute 5
6
SwitchActions Command Generated Command Generated 7
When Arriving at State 2 When Arriving at State 1 8
Attribute Value
From State 1 From State 2 9
0x00 On Off 10
11
0x01 Off On 12
0x02 Toggle Toggle 13
14
0x03 – 0xff Reserved
15
16
3.9.2.3 Commands Received 17
18
No commands are received by the server. 19
20
3.9.2.4 Commands Generated 21
The server generates no commands. 22
23
24
3.9.3 Client 25
26
3.9.3.1 Dependencies 27
None 28
29
3.9.3.2 Attributes 30
31
The client has no attributes. 32
33
3.9.3.3 Commands Received 34
35
No cluster specific commands are received by the client. 36
37
3.9.3.4 Commands Generated 38
No cluster specific commands are generated by the client. 39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 107

3.10 Level Control Cluster 1

2
3.10.1 Overview 3
4
This cluster provides an interface for controlling a characteristic of a device that 5
can be set to a level, for example the brightness of a light, the degree of closure of 6
a door, or the power output of a heater. 7
8
9
3.10.2 Server 10
11
3.10.2.1 Dependencies 12
13
For many applications, a close relationship between this cluster and the OnOff 14
cluster is needed. This section describes the dependencies that are required when 15
an endpoint that implements the Level Control server cluster also implements the 16
On/Off server cluster (12.2). 17
The OnOff attribute of the On/Off cluster and the CurrentLevel attribute of the 18
Level Control cluster are intrinsically independent variables, as they are on 19
different clusters. However, when both clusters are implemented on the same 20
endpoint, dependencies may be introduced between them. Facilities are provided 21
to introduce dependencies if required. 22
23
3.10.2.1.1 Effect of On/Off Commands on the CurrentLevel Attribute 24
The attribute OnLevel (see 3.10.2.2.4) determines whether commands of the On/ 25
Off cluster have a permanent effect on the CurrentLevel attribute or not. If this 26
attribute is defined (i.e. implemented and not 0xff) they do have a permanent 27
effect, otherwise they do not. There is always a temporary effect, due to fading up 28
/ down. 29
30
The effect on the Level Control cluster on receipt of the various commands of the 31
On/Off cluster are as detailed in Table 3.44. In this table, and throughout this 32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
108 General Specification

cluster specification, 'level' means the value of the CurrentLevel attribute (see
3.10.2.2.1). 1
2
Table 3.44 Actions on Receipt for On/Off Commands, When Associated With Level
Control 3
4
Command Action On Receipt 5
6
On Temporarily store CurrentLevel 7
Set CurrentLevel to the minimum level allowed for the device. 8
Move CurrentLevel to OnLevel, or to the stored level if OnLevel is not defined,
over the time period OnOffTransitionTime. 9
10
Off Temporarily store CurrentLevel 11
Move CurrentLevel to the minimum level allowed for the device over the time
12
period OnOffTransitionTime.
If OnLevel is not defined, set the CurrentLevel to the stored level. 13
14
Toggle If the OnOff attribute has the value Off, proceed as for the On command. 15
Otherwise proceed as for the Off command.
16
17
3.10.2.1.2 Effect of Level Control Commands on the OnOff Attribute 18
There are two sets of commands provided in the Level Control cluster. These are 19
identical, except that the first set (Move to Level, Move and Step) shall not effect 20
the OnOff attribute, whereas the second set ('with On/Off' variants) shall. 21
22
The first set is used to maintain independence between the CurrentLevel and 23
OnOff attributes, so changing CurrentLevel has no effect on the OnOff attribute. 24
As examples, this represents the behavior of a volume control with a mute button, 25
or a 'turn to set level and press to turn on/off' light dimmer. 26
The second set is used to link the CurrentLevel and OnOff attributes. When the 27
level is reduced to its minimum the OnOff attribute is automatically turned to Off, 28
and when the level is increased above its minimum the OnOff attribute is 29
automatically turned to On. As an example, this represents the behavior of a light 30
dimmer with no independent on/off switch. 31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 109

3.10.2.2 Attributes
1
The attributes of the Level Control server cluster are summarized in Table 3.45. 2
Table 3.45 Attributes of the Level Control Server Cluster 3
4
5
Identifier Name Type Range Access Default Mandatory
/ Optional 6
7
0x0000 CurrentLevel Unsigned 0x00 – Read 0x00 M
8-bit integer 0xff only
8
9
0x0001 RemainingTime Unsigned 0x0000 – Read 0x0000 O 10
16-bit 0xffff only 11
integer
12
0x0010 OnOffTransitionTime Unsigned 0x0000 – Read / 0x0000 O 13
16-bit 0xffff Write 14
integer
15
0x0011 OnLevel Unsigned 8- 0x00 – Read / 0xfe O 16
bit Integer 0xfe Write 17
18
3.10.2.2.1 CurrentLevel Attribute 19
20
The CurrentLevel attribute represents the current level of this device. The 21
meaning of 'level' is device dependent. 22
3.10.2.2.2 RemainingTime Attribute 23
24
The RemainingTime attribute represents the time remaining until the current 25
command is complete - it is specified in 1/10ths of a second. 26
3.10.2.2.3 OnOffTransitionTime Attribute 27
28
The OnOffTransitionTime attribute represents the time taken to move to or from 29
the target level when On of Off commands are received by an On/Off cluster on 30
the same endpoint. It is specified in 1/10ths of a second. 31
The actual time taken should be as close to OnOffTransitionTime as the device is 32
able. N.B. If the device is not able to move at a variable rate, the 33
OnOffTransitionTime attribute should not be implemented. 34
35
3.10.2.2.4 OnLevel Attribute 36
37
The OnLevel attribute determines the value that the CurrentLevel attribute is set to
38
when the OnOff attribute of an On/Off cluster on the same endpoint is set to On. If
39
the OnLevel attribute is not implemented, or is set to 0xff, it has no effect. For
40
more details see 3.10.2.1.1.
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
110 General Specification

3.10.2.3 Commands Received

1
The command IDs for the Level Control cluster are listed in Table 3.46. 2
Table 3.46 Command IDs for the Level Control Cluster 3
4
Command Identifier Mandatory 5
Description
Field Value / Optional 6
7
0x00 Move to Level M
8
0x01 Move M 9
10
0x02 Step M
11
0x03 Stop M 12
0x04 Move to Level (with On/Off) M 13
14
0x05 Move (with On/Off) M 15
0x06 Step (with On/Off) M 16
17
0x07 Stop M 18
0x08 – 0xff Reserved - 19
20
3.10.2.3.1 Move to Level Command 21
22
23
3.10.2.3.1.1 Payload Format
24
The Move to Level command payload shall be formatted as illustrated in 25
Figure 3.28. 26
27
28
Octets 1 2 29
30
Data Type Unsigned 8-bit Integer Unsigned 16-bit Integer 31
32
Field Name Level Transition time
33
34
Figure 3.28 Format of the Move to Level Command Payload 35
36
3.10.2.3.1.2 Effect on Receipt 37
38
On receipt of this command, a device shall move from its current level to the 39
value given in the Level field. The meaning of ‘level’ is device dependent – e.g. 40
for a light it may mean brightness level. 41
The movement shall be as continuous as technically practical, i.e. not a step 42
function, and the time taken to move to the new level shall be equal to the value of 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 111

the Transition time field, in tenths of a second, or as close to this as the device is
able. 1
2
If the Transition time field takes the value 0xffff then the time taken to move to 3
the new level shall instead be determined by the OnOffTransitionTime attribute. If 4
OnOffTransitionTime , which is an optional attribute, is not present, the device 5
shall move to its new level as fast as it is able. 6
If the device is not able to move at a variable rate, the Transition time field may be 7
disregarded. 8
9
3.10.2.3.2 Move Command 10
11
3.10.2.3.2.1 Payload Format 12
13
The Move command payload shall be formatted as illustrated in Figure 3.29.
14
15
1 2 16
Octets
17
Data Type 8-bit Enumeration Unsigned 8-bit Integer 18
19
Field Name Move mode Rate 20
21
22
Figure 3.29 Format of the Move Command Payload
23
3.10.2.3.2.2 Move Mode Field 24
25
The Move mode field shall be one of the non-reserved values in Table 3.47. 26
Table 3.47 Values of the Move Mode Field 27
28
Fade Mode Value Description 29
30
0x00 Up 31
0x01 Down 32
33
0x02 – 0xff Reserved 34
35
3.10.2.3.2.3 Rate Field 36
37
The Rate field specifies the rate of movement in units per second. The actual rate 38
of movement should be as close to this rate as the device is able. If the Rate field 39
is 0xff the device should move as fast as it is able. 40
If the device is not able to move at a variable rate, this field may be disregarded. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
112 General Specification

3.10.2.3.2.4 Effect on Receipt

1
On receipt of this command, a device shall move from its current level in an up or 2
down direction in a continuous fashion, as detailed in Table 3.48. 3
Table 3.48 Actions on Receipt for Move Command 4
5
Fade Mode Action on Receipt 6
7
Up Increase the device’s level at the rate given in the Rate
field. If the level reaches the maximum allowed for the
8
device, stop. 9
10
Down Decrease the device’s level at the rate given in the Rate 11
field. If the level reaches the minimum allowed for the
device, stop. 12
13
14
3.10.2.3.3 Step Command 15
16
3.10.2.3.3.1 Payload Format 17
The Step command payload shall be formatted as illustrated in Figure 3.30. 18
19
20
Octets 1 1 2 21
22
Data Type 8-bit Enumeration Unsigned 8-bit Integer Unsigned 16-bit Integer 23
24
Field Name Step mode Step size Transition time
25
26
Figure 3.30 Format of the Step Command Payload 27
28
The Step mode field shall be one of the non-reserved values in Table 3.49. 29
Table 3.49 Values of the Step Mode Field 30
31
Fade Mode Value Description 32
0x00 Up 33
34
0x01 Down 35
0x02 – 0xff Reserved 36
37
38
The Transition time field specifies the time that shall be taken to perform the step,
39
in tenths of a second. A step is a change in the CurrentLevel of 'Step size' units.
40
The actual time taken should be as close to this as the device is able. If the
41
Transition time field is 0xffff the device should move as fast as it is able.
42
If the device is not able to move at a variable rate, the Transition time field may be 43
disregarded. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 113

3.10.2.3.3.2 Effect on Receipt

1
On receipt of this command, a device shall move from its current level in an up or 2
down direction as detailed in Table 3.50. 3
Table 3.50 Actions on Receipt for Step Command 4
5
Fade Mode Action on Receipt 6
7
Up Increase CurrentLevel by 'Step size' units, or until it
reaches the maximum level allowed for the device if this
8
reached in the process. In the latter case, the transition 9
time shall be proportionally reduced. 10
11
Down Decrease CurrentLevel by 'Step size' units, or until it
reaches the minimum level allowed for the device if this 12
reached in the process. In the latter case, the transition 13
time shall be proportionally reduced. 14
15
3.10.2.3.4 Stop Command 16
17
This command has no payload. Upon receipt of this command, any Move to 18
Level, Move or Step command (and their 'with On/Off' variants) currently in 19
process shall be terminated. The value of CurrentLevel shall be left at its value 20
upon receipt of the Stop command, and RemainingTime shall be set to zero. 21
This command has two entries in Table 3.1, one for the Move to Level, Move and 22
Set commands, and one for their 'with On/Off' counterparts. This is solely for 23
symmetry, to allow easy choice of one or other set of commands – the Stop 24
commands are identical. 25
26
3.10.2.3.5 'With On/Off' Commands 27
28
The Move to Level (with On/Off), Move (with On/Off) and Step (with On/Off)
29
commands have identical payloads to the Move to Level, Move and Step
30
commands respectively. The also have the same effects, except for the following
31
additions.
32
• Before commencing any command that has the effect of increasing 33
CurrentLevel, the OnOff attribute of the On/Off cluster on the same endpoint, if 34
implemented, shall be set to On. 35
36
• If any command that decreases CurrentLevel reduces it to the minimum level
37
allowed by the device, the OnOff attribute of the On/Off cluster on the same
38
endpoint, if implemented, shall be set to Off.
39
3.10.2.4 Commands Generated 40
41
The server generates no commands. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
114 General Specification

3.10.2.5 Scene Table Extensions

1
If the Scenes server cluster (11) is implemented, the following extension field is 2
added to the Scenes table: 3
CurrentLevel 4
5
3.10.2.6 Attribute Reporting 6
7
This cluster shall support attribute reporting using the Report Attributes command 8
and according to the minimum and maximum reporting interval and reportable 9
change settings described in the ZCL Foundation Specification (see 2.4.7). The 10
following attribute shall be reported: 11
CurrentLevel 12
13
3.10.3 Client 14
15
3.10.3.1 Dependencies 16
17
None. 18
19
3.10.3.2 Attributes 20
21
The client has no attributes. 22
23
3.10.3.3 Commands Received 24
No cluster specific commands are received by the client. 25
26
3.10.3.4 Commands Generated 27
28
The client generates the cluster specific commands received by the server (see 29
3.10.2.3), as required by the application. 30
31
32
3.11 Alarms Cluster 33
34
35
3.11.1 Overview 36
37
Attributes and commands for sending alarm notifications and configuring alarm
38
functionality.
39
Alarm conditions and their respective alarm codes are described in individual 40
clusters, along with an alarm mask field. Where not masked, alarm notifications 41
are reported to subscribed targets using binding. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 115

Where an alarm table is implemented, all alarms, masked or otherwise, are

recorded and may be retrieved on demand. 1
2
Alarms may either reset automatically when the conditions that cause are no 3
longer active, or may need to be explicitly reset. 4
5
3.11.2 Server 6
7
3.11.2.1 Dependencies 8
9
Any endpoint which implements time stamping shall also implement the Time 10
server cluster. 11
12
3.11.2.2 Attributes 13
14
For convenience, the attributes defined in this specification are arranged into sets 15
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 16
are encoded such that the most significant three nibbles specify the attribute set 17
and the least significant nibble specifies the attribute within the set. The currently 18
defined attribute sets are listed in Table 3.51. 19
Table 3.51 Alarms Cluster Attribute Sets 20
21
Attribute Set 22
Identifier Description
23
0x000 Alarm Information 24
25
0x001 – 0xfff Reserved
26
27
3.11.2.2.1 Alarm Information Attribute Set 28
29
The Alarm Information attribute set contains the attributes summarized in
30
Table 3.52.
31
Table 3.52 Attributes of the Alarm Information Attribute Set 32
33
Mandatory 34
Identifier Name Type Range Access Default / Optional
35
0x0000 AlarmCount Unsigned 0x00 – Read 0x00 O 36
16-bit integer maximum only 37
defined in 38
profile
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
116 General Specification

3.11.2.2.1.1 AlarmCount Attribute

1
The AlarmCount attribute is 16-bits in length and specifies the number of entries 2
currently in the alarm table. This attribute shall be specified in the range 0x00 to 3
the maximum defined in the profile using this cluster. 4
If alarm logging is not implemented this attribute shall always take the value 5
0x00. 6
7
3.11.2.3 Alarm Table 8
9
The alarm table is used to store details of alarms generated within the devices. 10
Alarms are requested by clusters which have alarm functionality, e.g. when 11
attributes take on values that are outside ‘safe’ ranges. 12
The maximum number of entries in the table is device dependent. 13
14
When an alarm is generated, a corresponding entry is placed in the table. If the 15
table is full, the entry with the earliest time stamp field is replaced by the new 16
entry. 17
3.11.2.3.1 Alarm Table Format 18
19
The format of an alarm table entry is illustrated in Table 3.53. 20
Table 3.53 Format of the Alarm Table 21
22
Field Type Valid range Description 23
24
Alarm code 8-bit 0x00 – 0xff Identifying code for the cause of the alarm, 25
Enumeration as given in the specification of the cluster
whose attribute generated this alarm.
26
27
Cluster Cluster ID 0x0000 – 0xffff The identifier of the cluster whose attribute 28
identifier generated this alarm. 29
Time stamp Unsigned 0x00000000 – The time at which the alarm occurred, or 30
32-bit integer 0xffffffff 0xffffffff if no time information is available. 31
This time is taken from a Time server 32
cluster, which must be present on the same
33
endpoint.
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 117

3.11.2.4 Commands Received

1
The received command IDs for the Alarms cluster are listed in Table 3.54. 2
Table 3.54 Received Command IDs for the Alarms Cluster 3
4
Command identifier field Mandatory 5
Description
value / Optional 6
7
0x00 Reset Alarm M
8
0x01 Reset all alarms M 9
10
0x02 Get Alarm O
11
0x03 Reset alarm log O 12
0x04 – 0xff Reserved 13
14
15
3.11.2.4.1 Reset Alarm Command 16
This command resets a specific alarm. This is needed for some alarms that do not 17
reset automatically. If the alarm condition being reset was in fact still active then a 18
new notification will be generated and, where implemented, a new record added 19
to the alarm log. 20
21
3.11.2.4.1.1 Payload Format 22
23
The Reset Alarm command payload shall be formatted as illustrated in 24
Figure 3.31. 25
26
27
Octets 1 2 28
29
Data Type 8-bit Enumeration Cluster ID
30
Field Name Alarm code Cluster identifier 31
32
33
Figure 3.31 Format of the Reset Alarm Command Payload 34
35
3.11.2.4.2 Reset All Alarms Command 36
This command resets all alarms. Any alarm conditions that were in fact still active 37
will cause a new notification to be generated and, where implemented, a new 38
record added to the alarm log. 39
40
3.11.2.4.3 Get Alarm Command 41
This command causes the alarm with the earliest timestamp in the alarm table to 42
be reported in a get alarm response command 3.11.2.5.2. This command enables 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
118 General Specification

the reading of logged alarm conditions from the alarm table. Once an alarm
condition has been reported the corresponding entry in the table is removed. 1
2
This command does not have a payload. 3
3.11.2.4.4 Reset Alarm Log Command 4
5
This command causes the alarm table to be cleared, and does not have a payload. 6
7
3.11.2.5 Commands Generated 8
The generated command IDs for the Alarms cluster are listed in Table 3.55. 9
10
Table 3.55 Generated Command IDs for the Alarms Cluster 11
12
Command Identifier Mandatory
Field Value Description / Optional 13
14
0x00 Alarm M 15
16
0x01 Get alarm response O
17
0x02 – 0xff Reserved - 18
19
3.11.2.5.1 Alarm Command 20
21
The alarm command signals an alarm situation on the sending device. 22
An alarm command is generated when a cluster which has alarm functionality 23
detects an alarm condition, e.g. an attribute has taken on a value that is outside a 24
‘safe’ range. The details are given by individual cluster specifications. 25
26
3.11.2.5.1.1 Payload Format 27
28
The alarm command payload shall be formatted as illustrated in Figure 3.32. 29
30
31
Octets 1 2 32
33
Data Type 8-bit Enumeration Cluster ID
34
Alarm code Cluster identifier 35
Field Name
36
37
Figure 3.32 Format of the Alarm Command Payload 38
39
3.11.2.5.2 Get Alarm Response Command 40
The get alarm response command returns the results of a request to retrieve 41
information from the alarm log, along with a time stamp indicating when the 42
alarm situation was detected. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 119

3.11.2.5.2.1 Payload Format

1
The get alarm response command payload shall be formatted as illustrated in 2
Figure 3.33. 3
4
5
Octets 1 0/1 0/2 0/4 6
7
8-bit 8-bit Enumeration Cluster ID Unsigned 32-bit
Data Type Enumeration integer 8
9
Status Alarm code Cluster Time stamp 10
Field Name identifier
11
12
Figure 3.33 Format of the Get Alarm Response Command Payload 13
14
If there is at least one alarm record in the alarm table then the status field is set to 15
SUCCESS. The alarm code, cluster identifier and time stamp fields shall all be 16
present and shall take their values from the item in the alarm table that they are 17
reporting. 18
If there are no more alarms logged in the alarm table then the status field is set to 19
NOT_FOUND and the alarm code, cluster identifier and time stamp fields shall 20
be omitted. 21
22
23
3.11.3 Client 24
25
3.11.3.1 Dependencies 26
27
None
28
3.11.3.2 Attributes 29
30
The client has no attributes. 31
32
3.11.3.3 Commands Received 33
34
The client receives the cluster specific commands generated by the server (see 35
3.11.2.5). 36
37
3.11.3.4 Commands Generated 38
The client generates the cluster specific commands received by the server (see 39
3.11.2.4), as required by the application. 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
120 General Specification

3.12 Time Cluster 1

2
3.12.1 Overview 3
4
This cluster provides a basic interface to a real-time clock. The clock time may be 5
read and also written, in order to synchronize the clock (as close as practical) to a 6
time standard. This time standard is the number of seconds since 0 hrs 0 mins 0 7
sec on 1st January 2000 UTC. 8
9
The functionality does not include clock functions such as time zone or daylight 10
saving time. 11
12
3.12.2 Server 13
14
15
3.12.2.1 Dependencies 16
None 17
18
3.12.2.2 Attributes 19
20
The server supports the attributes shown in Table 3.56. 21
Table 3.56 Attributes of the On/Off Server Cluster 22
23
Mandatory 24
Identifier Name Type Range Access Default
/ Optional 25
0x0000 Time Unsigned 0x00000000 – Read / - M 26
32-bit integer 0xffffffff Write 27
28
0x0001 TimeStatus 8-bit bitmap 0000 00xx Read / 00000000 M
29
Write
30
31
3.12.2.2.1 Time Attribute 32
The Time attribute is 32-bits in length and holds the time value of a real time 33
clock. If the Master bit of the TimeStatus attribute has a value of 0, writing to this 34
attribute shall set the real time clock to the written value, otherwise it cannot be 35
written. The value 0xffffffff indicates an invalid time. 36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 121

3.12.2.2.2 TimeStatus Attribute

1
The TimeStatus attribute holds a number of bit fields, as detailed in Table 3.57. 2
Table 3.57 Bit Values of the TimeStatus Attribute 3
4
TimeStatus Meaning Values 5
Attribute Bit Number 6
0 Master 1 – master clock
7
8
0 – not master clock 9
1 Synchronized 1 – synchronized 10
11
0 – not synchronized
12
2-7 Reserved - 13
14
The Master and Synchronized bits together provide information on how closely 15
the Time attribute conforms to the time standard. 16
17
The Master bit specifies whether the real time clock corresponding to the Time 18
attribute is internally set to the time standard (see 3.12.1). This bit is not writeable 19
– if a value is written to the TimeStatus attribute, this bit does not change. 20
The Synchronized bit specifies whether Time has been set over the network to 21
synchronize it (as close as may be practical) to the time standard (see 3.12.1). This 22
bit must be explicitly written to indicate this – i.e. it is not set automatically on 23
writing to the Time attribute. If the Master bit is 1, the value of this bit is 0. 24
25
If both the Master and Synchronized bits are 0, the real time clock has no defined 26
relationship to the time standard (e.g. it may record the number of seconds since 27
the device was initialized). 28
29
3.12.2.3 Commands Received 30
The server receives no commands except those to read and write attributes. 31
32
3.12.2.4 Commands Generated 33
34
The server generates no commands. 35
36
3.12.3 Client 37
38
39
3.12.3.1 Dependencies 40
None. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
122 General Specification

3.12.3.2 Attributes
1
The client has no attributes. 2
3
3.12.3.3 Commands Received 4
5
No cluster specific commands are received by the client. 6
7
3.12.3.4 Commands Generated 8
The client generates no cluster specific commands. 9
10
11
3.13 Rssi Location Cluster 12
13
14
3.13.1 Overview 15
16
This cluster provides a means for exchanging Received Signal Strength Indication 17
(RSSI) based location information and channel parameters among devices. 18
19
3.13.2 Server 20
21
22
3.13.2.1 Dependencies 23
None 24
25
3.13.2.2 Attributes 26
27
For convenience, the attributes defined in this specification are arranged into sets 28
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 29
are encoded such that the most significant three nibbles specify the attribute set 30
and the least significant nibble specifies the attribute within the set. The currently 31
defined attribute sets are listed in Table 3.58. 32
Table 3.58 Location Attribute Sets 33
34
Attribute Set 35
Description
Identifier 36
0x000 Location Information 37
38
0x001 Location Settings 39
0x002 – 0xfff Reserved 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 123

3.13.2.2.1 Location Information Attribute Set

1
The Location Information attribute set contains the attributes summarized in 2
Table 3.59. 3
Table 3.59 Attributes of the Location Information Attribute Set 4
5
Identifier Name Type Range Access Default Mandatory 6
/ Optional 7
0x0000 LocationType 8-bit Data 0000xxxx Read - M
8
only 9
10
0x0001 LocationMethod 8-bit 0x00 – 0xff Read - M 11
Enumeration only
12
0x0002 LocationAge Unsigned 16- 0x0000 – Read - O 13
bit Integer 0xffff only 14
0x0003 QualityMeasure Unsigned 8- 0x00 – Read - O 15
bit Integer 0x64 only 16
17
0x0004 NumberOfDevices Unsigned 8- 0x00 – 0xff Read - O
bit Integer only 18
19
20
3.13.2.2.1.1 LocationType Attribute 21
The LocationType attribute is 8 bits long and is divided into bit fields. The 22
meanings of the individual bit fields are detailed in Table 3.60. 23
24
Table 3.60 Bit Values of the LocationType Attribute 25
26
Bit Field
(Bit Numbers) Meaning Values 27
28
0 Absolute 1 – Absolute location 29
0 – Measured location 30
31
1 2-D 1 – Two dimensional 32
0 – Three dimensional 33
2-3 Coordinate System 0 – Rectangular (installation-specific
34
origin and orientation) 35
36
1-3 – Reserved
37
4-7 Reserved - 38
39
The Absolute bit field indicates whether the location is a known absolute location 40
or is calculated. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
124 General Specification

The 2-D bit field indicates whether the location information is two- or three-
dimensional. If the location information is two-dimensional, Coordinate 3 is 1
unknown and shall be set to 0x8000. 2
3
The Coordinate System bit field indicates the geometry of the system used to 4
express the location coordinates. If the field is set to zero, the location coordinates 5
are expressed using the rectangular coordinate system. All other values are 6
reserved. 7
8
3.13.2.2.1.2 LocationMethod Attribute 9
The Location Method attribute shall be set to one of the non-reserved values in 10
Table 3.61. 11
12
Table 3.61 Values of the LocationMethod Attribute 13
14
Value Method Description
15
0x00 Lateration A method based on RSSI measurements from three or 16
more sources. 17
18
0x01 Signposting The location reported is the location of the neighboring
device with the strongest received signal. 19
20
0x02 RF fingerprinting RSSI signatures are collected into a database at 21
commissioning time. The location reported is the location
taken from the RSSI signature database that most closely 22
matches the device’s own RSSI signature. 23
24
0x03 Out of band The location is obtained by accessing an out-of-band 25
device (that is, the device providing the location is not
part of the ZigBee network). 26
27
0x04 – 0x3f - Reserved 28
0x40 – 0xff - Reserved for manufacturer specific location methods. 29
30
31
3.13.2.2.1.3 LocationAge Attribute
32
The LocationAge attribute indicates the amount of time, measured in seconds, that 33
has transpired since the location information was last calculated. This attribute is 34
not valid if the Absolute bit of the LocationType attribute is set to one. 35
36
3.13.2.2.1.4 QualityMeasure Attribute 37
38
The QualityMeasure attribute is a measure of confidence in the corresponding 39
location information. The higher the value, the more confident the transmitting 40
device is in the location information. A value of 0x64 indicates complete (100%) 41
confidence and a value of 0x00 indicates zero confidence. (Note: no fixed 42
confidence metric is mandated – the metric may be application and manufacturer 43
dependent.) 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 125

This field is not valid if the Absolute bit of the LocationType attribute is set to one.
1
3.13.2.2.1.5 NumberOfDevices Attribute 2
3
The NumberOfDevices attribute is the number of devices whose location data 4
were used to calculate the last location value. This attribute is related to the 5
QualityMeasure attribute. 6
3.13.2.2.2 Location Settings Attribute Set 7
8
The Location Settings attribute set contains the attributes summarized in 9
Table 3.62. 10
Table 3.62 Attributes of the Location Settings Attribute Set 11
12
13

Mandatory
/ Optional
14
Identifier Name Type Range Access Default 15
16
17
0x0010 Coordinate1 Signed 0x8000 – Read / - M 18
16-bit 0x7fff Write
integer 19
20
0x0011 Coordinate2 Signed 0x8000 – Read / - M 21
16-bit 0x7fff Write
22
integer
23
0x0012 Coordinate3 Signed 0x8000 – Read / - O 24
16-bit 0x7fff Write 25
integer
26
0x0013 Power Signed 0x8000 – Read / - M 27
16-bit 0x7fff Write 28
integer 29
0x0014 PathLossExponent Unsigned 0x0000 – Read / - M 30
16-bit 0xffff Write 31
integer 32
0x0015 ReportingPeriod Unsigned 0x0000 – Read / - O 33
16-bit 0xffff Write 34
integer 35
0x0016 CalculationPeriod Unsigned 0x0000 – Read / - O 36
16-bit 0xffff Write 37
integer 38
39
0x0017 NumberRSSIMeasurements Unsigned 0x01 – Read / - M
8-bit 0xff Write 40
integer 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
126 General Specification

3.13.2.2.2.1 Coordinate 1,2,3 Attributes

1
The Coordinate1, Coordinate2 and Coordinate3 attributes are signed 16-bit 2
integers, and represent orthogonal linear coordinates x, y, z in meters as follows. 3
x = Coordinate1 / 10, y = Coordinate2 / 10, z = Coordinate3 / 10 4
5
The range of x is -3276.7 to 3276.7 meters, corresponding to Coordinate1 6
between 0x8001 and 0x7fff. The same range applies to y and z. A value of 7
0x8000 for any of the coordinates indicates that the coordinate is unknown. 8
9
3.13.2.2.2.2 Power Attribute 10
11
The Power attribute specifies the value of the average power P0, measured in
12
dBm, received at a reference distance of one meter from the transmitter.
13
P0 = Power / 100 14
15
A value of 0x8000 indicates that Power is unknown.
16
17
3.13.2.2.2.3 PathLossExponent Attribute 18
The PathLossExponent attribute specifies the value of the Path Loss Exponent n, 19
an exponent that describes the rate at which the signal power decays with 20
increasing distance from the transmitter. 21
22
n = PathLossExponent / 100 23
A value of 0xffff indicates that PathLossExponent is unknown. 24
25
The signal strength in dBm at a distance d meters from the transmitter is given by 26
P = P0 – 10n x log10(d) 27
28
where 29
P is the power in dBm at the receiving device. 30
P0 is the average power in dBm received at a reference distance of 1meter from 31
the transmitter. 32
33
n is the path loss exponent. 34
d is the distance in meters between the transmitting device and the receiving 35
device. 36
37
3.13.2.2.2.4 ReportingPeriod Attribute 38
The ReportingPeriod attribute specifies the time in seconds between successive 39
reports of the device's location by means of the Location Data Notification 40
command. The minimum value this attribute can take is specified by the profile in 41
use. If ReportingPeriod is zero, the device does not automatically report its 42
location. Note that location information can always be polled at any time. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 127

3.13.2.2.2.5 CalculationPeriod Attribute

1
The CalculationPeriod attribute specifies the time in seconds between successive 2
calculations of the device's location. If CalculationPeriod is less than the 3
physically possible minimum period that the calculation can be performed, the 4
calculation will be repeated as frequently as possible. 5
6
3.13.2.2.2.6 NumberRSSIMeasurements Attribute 7
8
The NumberRSSIMeasurements attribute specifies the number of RSSI
9
measurements to be used to generate one location estimate. The measurements are
10
averaged to improve accuracy. NumberRSSIMeasurements must be greater than or
11
equal to 1.
12
3.13.2.3 Commands Received 13
14
The received command IDs for the Location cluster are listed in Table 3.63 15
Table 3.63 Received Command IDs for the Location Cluster
16
17
Command Identifier Mandatory 18
Field Value Description / Optional 19
20
0x00 Set absolute location M 21
0x01 Set device configuration M 22
23
0x02 Get device configuration M
24
0x03 Get location data M 25
26
0x04– 0xff Reserved -
27
28
3.13.2.3.1 Set Absolute Location Command 29
This command is used to set a device’s absolute (known, not calculated) location 30
and the channel parameters corresponding to that location. 31
32
3.13.2.3.1.1 Payload Format 33
34
The Set Absolute Location command payload shall be formatted as illustrated in 35
Figure 3.34. 36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
128 General Specification

1
Octets 2 2 2 2 2 2
3
Signed Integer Signed Integer Signed Integer Signed Unsigned Integer 4
Data Type Integer 5
Coordinate 1 Coordinate 2 Coordinate 3 Power Path Loss 6
Field Name Exponent 7
8
Figure 3.34 Format of the Set Absolute Location Command Payload 9
10
The fields of the payload correspond directly to the attributes with the same 11
names. For details of their meaning and ranges see the descriptions of the 12
individual attributes. 13
14
The three coordinate fields shall contain the absolute location (known, not 15
calculated) of the destination device. If any coordinate field(s) is not known, the 16
value(s) shall be set to 0x8000. 17
18
3.13.2.3.1.2 Effect on Receipt 19
On receipt of this command, the device shall update the attributes corresponding 20
to (i.e. with the same names as) the payload fields. 21
22
3.13.2.3.2 Set Device Configuration Command 23
This command is used to set a device’s location parameters, which will be used 24
for calculating and reporting measured location. This command is invalid unless 25
the Absolute bit of the LocationType attribute has a value of 0. 26
27
28
3.13.2.3.2.1 Payload Format
29
The Set Device Configuration command payload shall be formatted as illustrated 30
in Figure 3.35. 31
32
Octets 2 2 2 1 2 33
34
Signed Unsigned Unsigned Unsigned Integer Unsigned
Data Type Integer Integer Integer Integer 35
36
Power Path Loss Calculation Number RSSI Reporting 37
Field Name Exponent Period Measurements Period
38
39
Figure 3.35 Format of the Set Device Configuration Payload 40
41
The fields of the payload correspond directly to the attributes with the same 42
names. For details of their meaning and ranges see the descriptions of the 43
individual attributes. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 129

3.13.2.3.2.2 Effect on Receipt

1
On receipt of this command, the device shall update the attributes corresponding 2
to (i,.e. with the same names as) the payload fields. 3
3.13.2.3.3 Get Device Configuration Command 4
5
This command is used to request the location parameters of a device. The location 6
parameters are used for calculating and reporting measured location. 7
8
3.13.2.3.3.1 Payload Format 9
10
The Get Device Configuration command payload shall be formatted as illustrated 11
in Figure 3.36. 12
13
14
Octets 1
15
Data Type IEEE Address 16
17
Field Name Target Address 18
19
20
Figure 3.36 Format of the Get Device Configuration Payload
21
The Target Address field contains the 64-bit IEEE address of the device for which 22
the location parameters are being requested. This field may contain the address of 23
the sending device, the address of the receiving device or the address of a third 24
device. 25
26
Note:- one reason a device may request its own configuration is that there may be 27
a designated device which holds the configurations of other devices for 28
distribution at commissioning time. It is also possible that the device may lose its 29
configuration settings for some other reason (loss of power, reset). In the case of a 30
third device, that device may sleep a lot and not be easily accessible. 31
32
3.13.2.3.3.2 Effect on Receipt 33
34
On receipt of this command, the device shall generate a Device Configuration 35
Response command (3.13.2.4.1). 36
3.13.2.3.4 Get Location Data Command 37
38
This command is used to request a device’s location information and channel 39
parameters. It may be sent as a unicast, multicast or broadcast frame. When sent 40
as a broadcast frame, care should be taken to minimize the risk of a broadcast 41
'storm' - in particular, it is recommended that the broadcast radius is set to 1. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
130 General Specification

(Note: devices may or may not acquire and store information on other devices'
locations such that this information may be requested by another device. This is 1
application dependent.) 2
3
3.13.2.3.4.1 Payload Format 4
5
The Get Location Data command payload shall be formatted as illustrated in 6
Figure 3.37. 7
8
9
Bits 3 1 1 1 1 1 8 0 / 64 10
11
Data Unsigned IEEE
8-bit Bitmap Integer address 12
Type
13
Field Reserved Compact Broadcast Broadcast Re- Absolute Number Target 14
Name Response Response Indicator calculate Only Responses Address 15
16
17
Figure 3.37 Format of the Get Location Data Payload
18
The highest 3 bits of the first octet are reserved and shall be set to zero. 19
20
The Absolute Only field (bit 0 of the first octet) specifies the type of location 21
information being requested. If the Absolute Only field is set to one, the device is 22
only requesting absolute location information (a device may want to gather 23
absolute node locations for use in its own location calculations, and may not be 24
interested in neighbors with calculated values). Otherwise, if the field is set to 25
zero, the device is requesting all location information (absolute and calculated). 26
The Recalculate field (bit 1 of the first octet) indicates whether the device is 27
requesting that a new location calculation be performed. If the field is set to zero, 28
the device is requesting the currently stored location information. Otherwise, if 29
the field is set to one, the device is requesting that a new calculation be performed. 30
This field is only valid if the Absolute Only field is set to zero. 31
32
The Broadcast Indicator field (bit 2 of the first octet) indicates whether the 33
command is being sent as a unicast, multicast or broadcast frame. If the field is set 34
to one, the command is sent as a broadcast or multicast, else it is sent as a unicast. 35
The Broadcast Response field (bit 3 of the first octet)) indicates whether 36
subsequent responses after the first (where the Number Responses field is greater 37
than one) shall be unicast or broadcast. Broadcast responses can be used as a 38
'location beacon'. 39
40
The Compact Response field (bit 3 of the first octet)) indicates whether 41
subsequent responses after the first (where the Number Responses field is greater 42
than one) shall be sent using the Location Data Notification or the Compact 43
Location Data Notification command. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 131

The Number Responses field indicates the number of location responses to be

returned. The information to be returned is evaluated this number of times, with a 1
period equal to the value of the ReportingPeriod attribute, and a separate 2
response is sent for each evaluation. This field shall have a minimum value of one. 3
Values greater than one are typically used for situations where locations are 4
changing. 5
6
The Target Address field contains the 64-bit IEEE address of the device for which 7
the location information and channel parameters are being requested. If the 8
Broadcast Indicator field is set to zero (i.e. the command is sent as a unicast) this 9
field may contain the address of the receiving device, the address of the sending 10
device or the address of any other device. If the Broadcast Indicator field is set to 11
one (i.e. the command is sent as a broadcast or multicast) the target address is 12
implicitly that of the receiving device, so this field shall be omitted. 13
14
3.13.2.3.4.2 Effect on Receipt 15
On receipt of this command, if the Location Type field is set to zero, only a 16
receiving device(s) that knows its absolute location shall respond by generating a 17
Location Data Response command. If the Location Type field is set to one, all 18
devices receiving this command shall respond by generating a Location Data 19
Response command. 20
21
If the command is sent as a unicast, information for the device specified in the 22
Target Address field shall be returned, if the receiving device has or can obtain the 23
information for that device.. If the information is not available, the Status field of 24
the Location Data Response command shall be set to NOT_FOUND. 25
If the command is sent as a broadcast or multicast, receiving devices shall send 26
back their own information (there is no IEEE target address in this case). 27
28
If the Number Responses field is greater than one, the subsequent location 29
readings/calculations shall be sent using the Location Data Notification or the 30
Compact Location Data Notification command, depending on the value of the 31
Reduced Response field . 32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
132 General Specification

3.13.2.4 Commands Generated

1
Table 3.64 Generated Command IDs for the Location Cluster 2
3
Command Identifier Mandatory
Field Value Description / Optional 4
5
0x00 Device configuration response M 6
7
0x01 Location data response M
8
0x02 Location data notification M 9
0x03 Compact location data notification M 10
11
0x04 RSSI Ping M 12
0x05– 0xff Reserved M 13
14
15
3.13.2.4.1 Device Configuration Response Command
16
This command is sent by a device in response to a Get Device Configuration 17
command (3.13.2.3.3). 18
19
3.13.2.4.1.1 Payload Format 20
21
The Device Configuration Response command payload shall be formatted as 22
illustrated in Figure 3.38. All payload fields are relevant to the device for which 23
the location parameters have been requested. 24
25
Octets 1 0/2 0/2 0/2 0/1 0/2
26
Data Enumeration Signed Unsigned Unsigned Unsigned Integer Unsigned 27
Type Integer Integer Integer Integer 28
29
Field Status Power Path Loss Calculation Number RSSI Reporting 30
Name Exponent Period Measurements Period 31
32
Figure 3.38 Format of the Device Configuration Response Payload 33
34
The fields of the payload (other than Status) correspond directly to the attributes 35
with the same names. For details of their meaning and ranges see the descriptions 36
of the individual attributes. 37
38
The Status field indicates whether the response to the request was successful or
39
not. If the field is set to SUCCESS, the response was successful. If the field is set
40
to NOT_FOUND, the receiving device was unable to provide the location
41
parameters of the device for which the location parameters were requested. If the
42
field is set to NOT_FOUND, all other payload fields shall not be sent. See 2.5.3
43
for status codes.
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 133

3.13.2.4.2 Location Data Response Command

1
This command is sent by a device in response to a request for location information 2
and channel parameters. 3
4
3.13.2.4.2.1 Payload Format 5
6
The Location Data Response command payload shall be formatted as illustrated in
7
Figure 3.39. All payload fields are relevant to the device for which the location
8
parameters have been requested.
9
10
11
Octets 1 0/1 0/2 0/2 0/2 0/2 0/2 0/1 0/1 0/2
12
Data Enumeration Data Signed Signed Signed Signed Unsigned Enumeration Unsigned Unsigned 13
Type Integer Integer Integer Integer Integer Integer Integer
14
Field Status Location Coordinate Coordinate Coordinate Power Path Loss Location Quality Location 15
Name Type 1 2 3 Exponent Method Measure Age 16
17
Figure 3.39 Format of the Location Data Response Payload 18
19
The fields of the payload correspond directly to the attributes with the same 20
names. For details of their meaning and ranges see the descriptions of the 21
individual attributes. 22
23
If the Absolute bit of the Location Type field is set to 1, the Location Method,
24
Quality Measure and Location Age fields are not applicable and shall not be sent.
25
If the 2-D bit of the Location Type field is set to 1, the Coordinate 3 field shall not 26
be sent. 27
28
The Status field indicates whether the response to the request was successful or
29
not. If the field is set to SUCCESS, the response was successful. If the field is set
30
to NOT_FOUND, the receiving device was unable to provide the location
31
parameters of the device for which the location parameters were requested. If the
32
field is set to NOT_FOUND, all other payload fields shall not be sent. See 2.5.3
33
for status codes.
34
3.13.2.4.3 Location Data Notification Command 35
36
This command is sent periodically by a device to announce its location 37
information and channel parameters. The period is equal to the value of the 38
ReportingPeriod attribute. 39
The location data notification command may be sent as a unicast or as a broadcast 40
frame. When sent as a broadcast frame, it is recommended that the broadcast 41
radius is set to 1. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
134 General Specification

3.13.2.4.3.1 Payload Format

1
The Location Data Notification command payload shall be formatted as illustrated 2
in Figure 3.40. 3
4
5
Octets 1 2 2 0/2 2 2 0/1 0/1 0/2
6
Data Data Signed Signed Signed Signed Unsigned Enumeration Unsigned Unsigned 7
Type Integer Integer Integer Integer Integer Integer Integer
8
Field Location Coordinate Coordinate Coordinate Power Path Loss Location Quality Location 9
Name Type 1 2 3 Exponent Method Measure Age
10
11
Figure 3.40 Format of the Location Data Notification Payload 12
13
The fields of the payload correspond directly to the attributes with the same 14
names. For details of their meaning and ranges see the descriptions of the 15
individual attributes. 16
If the 2-D bit of the Location Type field is set to 1, the Coordinate 3 field shall not 17
be sent. 18
19
If the Absolute bit of the Location Type field is set to 1, the Location Method, 20
Quality Measure and Location Age fields are not applicable and shall not be sent. 21
3.13.2.4.4 Compact Location Data Notification Command 22
23
This command is identical in format and use to the Location Data Notification 24
command, except that the Power, Path Loss Exponent and Location Method fields 25
are not included. 26
3.13.2.4.5 RSSI Ping Command 27
28
This command is sent periodically by a device to enable listening devices to 29
measure the received signal strength in the absence of other transmissions from 30
that device. The period is given by the ReportingPeriod attribute. 31
The RSSI Ping command may be sent as a unicast or as a broadcast frame. When 32
sent as a broadcast frame, it is recommended that the broadcast radius is set to 1. 33
34
3.13.2.4.5.1 Payload Format 35
36
The RSSI Ping command payload shall be formatted as illustrated in Figure 3.41. 37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 135

1
Octets 1 2
3
Data Type Integer 4
Field Name Location Type 5
6
7
Figure 3.41 Format of the RSSI Ping Payload
8
9
The Location Type field holds the value of the LocationType attribute.
10
3.13.2.5 Client 11
12
13
3.13.2.6 Dependencies 14
None 15
16
3.13.2.7 Attributes 17
18
None 19
20
3.13.2.8 Commands Received 21
The client receives the cluster specific commands generated by the server (see 22
3.13.2.4). 23
24
3.13.2.8.1 Commands Generated 25
The client generates the cluster specific commands received by the server (see 26
3.13.2.3), as required by the application. 27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 3
136 General Specification

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
This page left intentionally blank 17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 137

C H A P T E R
1

4
2
3
4
5
6
7
8
9

CHAPTER 4MEASUREMENT AND SENSING 10

11

SPECIFICATION
12
13
14
15
4.1 General Description 16
17
18
4.1.1 Introduction 19
20
The clusters specified in this document are generic measurement and sensing 21
interfaces that are sufficiently general to be of use across a wide range of 22
application domains. 23
24
25
4.1.2 Cluster List 26
27
This section lists the clusters specified in this document, and gives examples of 28
typical usage for the purpose of clarification. 29
The clusters specified in the Measurement and sensing functional domain are 30
listed in Table 4.1 to Table 4.3. 31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
138 Measurement and Sensing Specification

4.1.2.1 Illuminance Measurement and Level Sensing

1
Table 4.1 Illuminance Measurement and Level Sensing Clusters 2
3
Cluster Name Description
4
Illuminance measurement Attributes and commands for configuring the measurement of 5
illuminance, and reporting illuminance measurements 6
7
Illuminance level sensing Attributes and commands for configuring the sensing of
illuminance levels, and reporting whether illuminance is above, 8
below, or on target. 9
10
11
12
Light measurement 13
Configuration tool / sensor
Light level controller
14
15
Illuminance 16
measurement
C
Configuration
S 17
Light level 18
comparator Lighting unit 19
Notification 20
C
Illuminance level sensing 21
C S C 22
Configuration
23
Notification 24
25
26
C = Client S = Server 27
28
Note:- Device names are examples for illustration only
29
Figure 4.1 Typical Usage of Illuminance Measurement and Level Sensing Clusters 30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 139

4.1.2.2 Temperature, Pressure and Flow Measurement

1
Table 4.2 Pressure and Flow Measurement Clusters 2
3
Cluster Name Description
4
Temperature measurement Attributes and commands for configuring the measurement 5
of temperature, and reporting temperature measurements 6
7
Pressure measurement Attributes and commands for configuring the measurement
of pressure, and reporting pressure measurements 8
9
Flow measurement Attributes and commands for configuring the measurement 10
of flow, and reporting flow rates
11
Relative Humidity Attributes and commands for configuring the measurement 12
measurement of relative humidity, and reporting relative humidity 13
measurements 14
15
16
Temperature, Pressure, 17
Configuration tool Flow or Humidity 18
sensor Heating system
Temperature, Pressure, 19
Flow or Relative 20
C Humidity measurement
Configuration
S C 21
22
23
Notification 24
25
26
C = Client S = Server
27
Note:- Device names are examples for illustration only 28
29
30
31
Figure 4.2 Typical Usage of Temperature, Pressure and Flow 32
Measurement Clusters
33
34
4.1.2.3 Occupancy Sensing 35
Table 4.3 Occupancy Sensing Clusters 36
37
Cluster Name Description 38
Occupancy sensing Attributes and commands for configuring occupancy sensing,
39
and reporting occupancy status 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
140 Measurement and Sensing Specification

1
Configuration tool Lighting control 2
Occupancy sensor system
3
4
Occupancy sensing Occupancy sensing
C S C 5
Configuration Notification 6
7
8
9
10
C = Client S = Server 11
Note:- Device names are examples for illustration only 12
13
14
Figure 4.3 Typical Usage of Occupancy Sensing Cluster 15
16
4.2 Illuminance Measurement Cluster 17
18
19
4.2.1 Overview 20
21
The server cluster provides an interface to illuminance measurement functionality, 22
including configuration and provision of notifications of illuminance 23
measurements. 24
25
26
4.2.2 Server 27
28
4.2.2.1 Dependencies 29
30
None 31
32
4.2.2.2 Attributes 33
For convenience, the attributes defined in this specification are arranged into sets 34
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 35
are encoded such that the most significant nibble specifies the attribute set and the 36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 141

least significant nibble specifies the attribute within the set. The currently defined
attribute sets are listed in Table 4.4. 1
2
Table 4.4 Illuminance Measurement Attribute Sets
3
Attribute Set Identifier Description 4
5
0x000 Illuminance Measurement Information 6
7
0x001 – 0xfff Reserved
8
9
4.2.2.2.1 Illuminance Measurement Information Attribute Set 10
The Illuminance Measurement Information attribute set contains the attributes 11
summarized in Table 4.5. 12
13
Table 4.5 Attributes of the Illuminance Measurement Information Attribute Set 14
15

Mandatory
/ Optional
16
Identifier Name Type Range Access Default 17
18
19
0x0000 MeasuredValue 16-bit Unsigned MinMeasuredValue Read 0 M 20
Integer to only 21
MaxMeasuredValue
22
0x0001 MinMeasuredValue 16-bit Unsigned 0x0002 – 0xfffd Read - M 23
Integer only 24
0x0002 MaxMeasuredValue 16-bit Unsigned 0x0001 – 0xfffe Read - M 25
Integer only 26
27
0x0003 Tolerance 16-bit Unsigned 0x0000 – 0x0800 Read - O
28
Integer only
29
0x0004 LightSensorType 8-bit 0x00 – 0xff Read - O 30
Enumeration only 31
32
4.2.2.2.1.1 MeasuredValue Attribute 33
34
MeasuredValue represents the Illuminance in Lux (symbol lx) as follows:- 35
MeasuredValue = 10,000 x log10 Illuminance + 1 36
37
Where 1 lx <= Illuminance <=3.576 Mlx, corresponding to a MeasuredValue in 38
the range 1 to 0xfffe. 39
The following special values of MeasuredValue apply. 40
41
0x0000 indicates a value of Illuminance that is too low to be measured. 42
0xffff indicates that the Illuminance measurement is invalid. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
142 Measurement and Sensing Specification

MeasuredValue is updated continuously as new measurements are made.

1
4.2.2.2.1.2 MinMeasuredValue Attribute 2
3
The MinMeasuredValue attribute indicates the minimum value of MeasuredValue 4
that can be measured. A value of 0xffff indicates that this attribute is not defined. 5
6
4.2.2.2.1.3 MaxMeasuredValue Attribute 7
8
The MaxMeasuredValue attribute indicates the maximum value of MeasuredValue 9
that can be measured. A value of 0xffff indicates that this attribute is not defined. 10
MaxMeasuredValue shall be greater than MinMeasuredValue. 11
12
MinMeasuredValue and MaxMeasuredValue define the range of the sensor. 13
14
4.2.2.2.1.4 Tolerance Attribute 15
The Tolerance attribute indicates the magnitude of the possible error that is 16
associated with MeasuredValue . The true value is located in the range 17
(MeasuredValue – Tolerance) to (MeasuredValue + Tolerance). 18
19
4.2.2.2.1.5 LightSensorType Attribute 20
21
The LightSensorType attribute specifies the electronic type of the light sensor. 22
This attribute shall be set to one of the non-reserved values listed in Table 4.6. 23
Table 4.6 Values of the LightSensorType Attribute 24
25
LightSensorType 26
Attribute Value Description
27
28
0x00 Photodiode
29
0x01 CMOS 30
0x02 – 0x3f Reserved 31
32
0x40 – 0xfe Reserved for manufacturer specific light sensor types 33
0xff Unknown 34
35
36
4.2.2.3 Commands Received 37
No cluster specific commands are received by the server cluster. 38
39
4.2.2.4 Commands Generated 40
41
No cluster specific commands are generated by the server cluster. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 143

4.2.2.5 Attribute Reporting

1
This cluster shall support attribute reporting using the Report Attributes command 2
and according to the minimum and maximum reporting intervals and reportable 3
change settings described in the ZCL Foundation specification (see 2.4.7) and, 4
where relevant, according to the MinPercentChange and MinAbsoluteChange 5
settings in this cluster. The following attributes shall be reported: 6
7
MeasuredValue
8
Tolerance 9
10
11
4.2.3 Client 12
13
4.2.3.1 Dependencies 14
None. 15
16
4.2.3.2 Attributes 17
18
The Client cluster has no attributes. 19
20
4.2.3.3 Commands Received 21
No cluster specific commands are received by the client cluster. 22
23
4.2.3.4 Commands Generated 24
25
No cluster specific commands are generated by the client cluster. 26
27
28
29
4.3 Illuminance Level Sensing Cluster 30
31
32
4.3.1 Overview 33
34
The server cluster provides an interface to illuminance level sensing functionality, 35
including configuration and provision of notifications of whether the illuminance 36
is within, above or below a target band. 37
38
39
4.3.2 Server 40
41
4.3.2.1 Dependencies 42
43
None.
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
144 Measurement and Sensing Specification

4.3.2.2 Attributes
1
For convenience, the attributes defined in this specification are arranged into sets 2
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 3
are encoded such that the most significant three nibbles specify the attribute set 4
and the least significant nibble specifies the attribute within the set. The currently 5
defined attribute sets are listed in Table 4.7. 6
Table 4.7 Illuminance Level Sensing Attribute Sets 7
8
Attribute Set 9
Description
Identifier 10
11
0x000 Illuminance Level Sensing Information
12
0x001 Illuminance Level Sensing Settings 13
14
0x002 – 0xfff Reserved
15
16
4.3.2.3 Illuminance Level Sensing Information Attribute Set 17
18
The light sensor configuration attribute set contains the attributes summarized in
19
Table 4.8.
20
Table 4.8 Attributes of the Illuminance Level Sensing Information Attribute Set 21
22
Mandatory 23
Identifier Name Type Range Access Default / Optional
24
0x0000 LevelStatus 8-bit 0x00 – 0xfe Read only - M 25
Enumeration 26
0x0001 LightSensorType 8-bit 0x00 – 0xfe Read only - O 27
Enumeration 28
29
30
4.3.2.3.1 LevelStatus Attribute
31
The LevelStatus attribute indicates whether the measured illuminance is above, 32
below, or within a band around IlluminanceTargetLevel (see 4.3.2.4.1). It may 33
have any non-reserved value shown in Table 4.9. 34
Table 4.9 Values of the LevelStatus Attribute 35
36
LevelStatus 37
Attribute Value Description 38
39
0x00 Illuminance on target
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 145

Table 4.9 Values of the LevelStatus Attribute

1
LevelStatus 2
Attribute Value Description
3
0x01 Illuminance below target
4
5
0x02 Illuminance above target 6
0x03 – 0xff Reserved 7
8
9
4.3.2.3.2 LightSensorType Attribute
10
The LightSensorType attribute specifies the electronic type of the light sensor. 11
This attribute shall be set to one of the non-reserved values listed in Table 4.10. 12
Table 4.10 Values of the LightSensorType Attribute
13
14
LightSensorType 15
Description 16
Attribute Value
17
0x00 Photodiode 18
0x01 CMOS 19
20
0x02 – 0x3f Reserved
21
0x40 – 0xfe Reserved for manufacturer specific light sensor types 22
0xff Unknown
23
24
25
4.3.2.4 Illuminance Level Sensing Settings Attribute Set 26
The light sensor configuration attribute set contains the attributes summarized in 27
Table 4.11. 28
29
Table 4.11 Attributes of the Illuminance Level Sensing Settings Attribute Set 30
31
Identifier Name Type Range Access Default Mandatory 32
/ Optional
33
0x0010 IlluminanceTargetLevel Unsigned 0x0000 – Read/ - M 34
16-bit integer 0xfffe Write 35
36
4.3.2.4.1 IlluminanceTargetLevel Attribute 37
38
The IlluminanceTargetLevel attribute specifies the target illuminance level. This 39
target level is taken as the centre of a 'dead band', which must be sufficient in 40
width, with hysteresis bands at both top and bottom, to provide reliable 41
notifications without 'chatter'. Such a dead band and hysteresis bands must be 42
provided by any implementation of this cluster. (N.B. Manufacturer specific 43
attributes may be provided to configure these). 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
146 Measurement and Sensing Specification

IlluminanceTargetLevel represents illuminance in Lux (symbol lx) as follows:

1
IlluminanceTargetLevel = 10,000 x log10 Illuminance 2
Where 1 lx <= Illuminance <=3.576 Mlx, corresponding to a MeasuredValue in 3
the range 0 to 0xfffe. 4
5
A value of 0xffff indicates that this attribute is not valid. 6
7
4.3.2.5 Commands Received 8
No cluster specific commands are received by the server. 9
10
4.3.2.6 Commands Generated 11
12
No cluster specific commands are generated by the server cluster. 13
14
4.3.2.7 Attribute Reporting 15
16
This cluster shall support attribute reporting using the Report Attributes command
17
and according to the minimum and maximum reporting interval settings described
18
in the ZCL Foundation Specification (see 2.4.7). The following attribute shall be
19
reported:
20
LevelStatus 21
22
4.3.3 Client 23
24
4.3.3.1 Dependencies 25
26
None. 27
28
4.3.3.2 Attributes 29
The client cluster has no attributes. 30
31
4.3.3.3 Commands Received 32
33
No cluster specific commands are received by the client cluster. 34
35
4.3.3.4 Commands Generated 36
37
No cluster specific commands are generated by the client cluster. 38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 147

4.4 Temperature Measurement Cluster 1

2
4.4.1 Overview 3
4
The server cluster provides an interface to temperature measurement functionality, 5
including configuration and provision of notifications of temperature 6
measurements. 7
8
9
4.4.2 Server 10
11
4.4.2.1 Dependencies 12
13
None. 14
15
4.4.2.2 Attributes 16
For convenience, the attributes defined in this specification are arranged into sets 17
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 18
are encoded such that the most significant nibble specifies the attribute set and the 19
least significant nibble specifies the attribute within the set. The currently defined 20
attribute sets are listed in Table 4.12. 21
22
Table 4.12 Temperature Measurement Attribute Sets
23
Attribute Set Identifier Description 24
25
0x000 Temperature Measurement Information 26
27
0x001 – 0xfff Reserved
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
148 Measurement and Sensing Specification

4.4.2.2.1 Temperature Measurement Information Attribute Set

1
The Temperature Measurement Information attribute set contains the attributes 2
summarized in Table 4.13 3
Table 4.13 Attributes of the Temperature Measurement Information Attribute Set 4
5

Mandatory
6

/ Optional
7
Identifier Name Type Range Access Default
8
9
10
0x0000 MeasuredValue Signed 16-bit MinMeasuredValue Read 0 M
Integer to only 11
MaxMeasuredValue 12
13
0x0001 MinMeasuredValue Signed 16-bit 0x954d – 0x7ffe Read - M
14
Integer only
15
0x0002 MaxMeasuredValue Signed 16-bit 0x954e – 0x7fff Read - M 16
Integer only 17
0x0003 Tolerance Unsigned 16- 0x0000 – 0x0800 Read - O 18
bit Integer only 19
20
4.4.2.2.1.1 MeasuredValue Attribute 21
22
MeasuredValue represents the temperature in degrees Celsius as follows:- 23
MeasuredValue = 100 x temperature in degrees Celsius. 24
25
Where -273.15°C <= temperature <= 327.67 ºC, corresponding to a 26
MeasuredValue in the range 0x954d to 0x7fff. The maximum resolution this 27
format allows is 0.01 ºC. 28
A MeasuredValue of 0x8000 indicates that the temperature measurement is 29
invalid. 30
31
MeasuredValue is updated continuously as new measurements are made. 32
33
4.4.2.2.1.2 MinMeasuredValue Attribute 34
35
The MinMeasuredValue attribute indicates the minimum value of MeasuredValue 36
that is capable of being measured. A MinMeasuredValue of 0x8000 indicates that 37
the minimum value is unknown. 38
39
4.4.2.2.1.3 MaxMeasuredValue Attribute 40
The MaxMeasuredValue attribute indicates the maximum value of MeasuredValue 41
that is capable of being measured. 42
43
MaxMeasuredValue shall be greater than MinMeasuredValue. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 149

MinMeasuredValue and MaxMeasuredValue define the range of the sensor.

1
A MaxMeasuredValue of 0x8000 indicates that the maximum value is unknown. 2
3
4.4.2.2.1.4 Tolerance Attribute 4
The Tolerance attribute indicates the magnitude of the possible error that is 5
associated with MeasuredValue . The true value is located in the range 6
(MeasuredValue – Tolerance) to (MeasuredValue + Tolerance). 7
8
4.4.2.3 Commands Received 9
10
No cluster specific commands are received by the server cluster. 11
12
4.4.2.4 Commands Generated 13
14
No cluster specific commands are generated by the server cluster. 15
16
4.4.2.5 Attribute Reporting 17
This cluster shall support attribute reporting using the Report Attributes command 18
and according to the minimum and maximum reporting interval and reportable 19
change settings described in the ZCL Foundation specification (see 2.4.7) and, 20
where relevant, according to the MinPercentChange and MinAbsoluteChange 21
settings in this cluster. The following attribute shall be reported: 22
23
MeasuredValue 24
Tolerance 25
26
27
4.4.3 Client 28
29
4.4.3.1 Dependencies 30
None. 31
32
4.4.3.2 Attributes 33
34
The Client cluster has no attributes. 35
36
4.4.3.3 Commands Received 37
38
No cluster specific commands are received by the client cluster. 39
40
4.4.3.4 Commands Generated 41
No cluster specific commands are generated by the client cluster. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
150 Measurement and Sensing Specification

4.5 Pressure Measurement Cluster 1

2
4.5.1 Overview 3
4
The server cluster provides an interface to pressure measurement functionality, 5
including configuration and provision of notifications of pressure measurements. 6
7
8
4.5.2 Server 9
10
4.5.2.1 Dependencies 11
12
None 13
14
4.5.2.2 Attributes 15
For convenience, the attributes defined in this specification are arranged into sets 16
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 17
are encoded such that the most significant three nibbles specify the attribute set 18
and the least significant nibble specifies the attribute within the set. The currently 19
defined attribute sets are listed in Table 4.14. 20
21
Table 4.14 Pressure Measurement Attribute Sets
22
Attribute Set Identifier Description 23
24
0x000 Pressure Measurement Information 25
26
0x001 – 0xfff Reserved
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 151

4.5.2.2.1 Pressure Measurement Information Attribute Set

1
The Pressure Measurement Information attribute set contains the attributes 2
summarized in Table 4.15. 3
Table 4.15 Attributes of the Pressure Measurement Information Attribute Set 4
5

Mandatory
6

/ Optional
7
Identifier Name Type Range Access Default
8
9
10
0x0000 MeasuredValue Signed MinMeasuredValue Read 0 M
16-bit Integer to only 11
MaxMeasuredValue 12
13
0x0001 MinMeasuredValue Signed 0x8001-0x7ffe Read - M
14
16-bit Integer only
15
0x0002 MaxMeasuredValue Signed 0x8002-0x7fff Read - M 16
16-bit Integer only 17
0x0003 Tolerance Unsigned 0x0000 – 0x0800 Read - O 18
16-bit Integer only 19
20
4.5.2.2.1.1 MeasuredValue Attribute 21
22
MeasuredValue represents the pressure in kPa as follows:- 23
MeasuredValue = 10 x Pressure 24
25
Where -3276.7 kPa <= Pressure <= 3276.7 kPa, corresponding to a 26
MeasuredValue in the range 0x8001 to 0x7fff. 27
Note:- The maximum resolution this format allows is 0.1 kPa,. 28
29
A MeasuredValue of 0x8000 indicates that the pressure measurement is invalid. 30
MeasuredValue is updated continuously as new measurements are made. 31
32
33
4.5.2.2.1.2 MinMeasuredValue Attribute
34
The MinMeasuredValue attribute indicates the minimum value of MeasuredValue 35
that can be measured. A value of 0x8000 means this attribute is not defined 36
37
4.5.2.2.1.3 MaxMeasuredValue Attribute 38
39
The MaxMeasuredValue attribute indicates the maximum value of MeasuredValue 40
that can be measured. A value of 0x8000 means this attribute is not defined. 41
MaxMeasuredValue shall be greater than MinMeasuredValue. 42
43
MinMeasuredValue and MaxMeasuredValue define the range of the sensor. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
152 Measurement and Sensing Specification

4.5.2.2.1.4 Tolerance Attribute

1
The Tolerance attribute indicates the magnitude of the possible error that is 2
associated with MeasuredValue . The true value is located in the range 3
(MeasuredValue – Tolerance) to (MeasuredValue + Tolerance). 4
5
4.5.2.3 Commands Received 6
No cluster specific commands are received by the server cluster. 7
8
4.5.2.4 Commands Generated 9
10
No cluster specific commands are generated by the server cluster. 11
12
4.5.2.5 Attribute Reporting 13
14
This cluster shall support attribute reporting using the Report Attributes command 15
and according to the minimum and maximum reporting interval and reportable 16
change settings described in the ZCL Foundation specification (see 2.4.7) and, 17
where relevant, according to the MinPercentChange and MinAbsoluteChange 18
settings in this cluster. The following attribute shall be reported: 19
MeasuredValue 20
Tolerance 21
22
4.5.3 Client 23
24
4.5.3.1 Dependencies 25
26
None. 27
28
4.5.3.2 Attributes 29
30
The Client cluster has no attributes. 31
32
4.5.3.3 Commands Received 33
No commands are received by the client cluster. 34
35
4.5.3.4 Commands Generated 36
37
No cluster specific commands are generated by the client cluster. 38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 153

4.6 Flow Measurement Cluster 1

2
4.6.1 Overview 3
4
The server cluster provides an interface to flow measurement functionality, 5
including configuration and provision of notifications of flow measurements. 6
7
8
4.6.2 Server 9
10
4.6.2.1 Dependencies 11
12
None 13
14
4.6.2.2 Attributes 15
For convenience, the attributes defined in this specification are arranged into sets 16
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 17
are encoded such that the most significant three nibbles specify the attribute set 18
and the least significant nibble specifies the attribute within the set. The currently 19
defined attribute sets for are listed in Table 4.16. 20
21
Table 4.16 Flow Measurement Attribute Sets
22
Attribute Set Identifier Description 23
24
0x000 Flow Measurement Information 25
26
0x001 – 0xfff Reserved
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
154 Measurement and Sensing Specification

4.6.2.2.1 Flow Measurement Information Attribute Set

1
The Flow Measurement Information attribute set contains the attributes 2
summarized in Table 4.17. 3
Table 4.17 Attributes of the Flow Measurement Information Attribute Set 4
5

Mandatory
6

/ Optional
7
Identifier Name Type Range Access Default
8
9
10
0x0000 MeasuredValue Unsigned MinMeasuredValue Read 0 M
16-bit Integer to only 11
MaxMeasuredValue 12
13
0x0001 MinMeasuredValue Unsigned 0x0000 – 0xfffd Read - M
14
16-bit Integer only
15
0x0002 MaxMeasuredValue Unsigned 0x0001 – 0xfffe Read - M 16
16-bit Integer only 17
0x0003 Tolerance Unsigned 0x0000 – 0x0800 Read - O 18
16-bit Integer only 19
20
4.6.2.2.1.1 MeasuredValue Attribute 21
22
MeasuredValue represents the flow in m3/h as follows:- 23
MeasuredValue = 10 x Flow 24
25
Where 0 m3/h <= Flow <= 6,553.4 m3/h, corresponding to a MeasuredValue in the 26
range 0 to 0xfffe. 27
The maximum resolution this format allows is 0.1 m3/h. 28
29
A MeasuredValue of 0xffff indicates that the pressure measurement is invalid. 30
MeasuredValue is updated continuously as new measurements are made. 31
32
33
4.6.2.2.1.2 MinMeasuredValue Attribute
34
The MinMeasuredValue attribute indicates the minimum value of MeasuredValue 35
that can be measured. A value of 0xffff means this attribute is not defined 36
37
4.6.2.2.1.3 MaxMeasuredValue Attribute 38
39
The MaxMeasuredValue attribute indicates the maximum value of MeasuredValue 40
that can be measured. A value of 0xffff means this attribute is not defined 41
MaxMeasuredValue shall be greater than MinMeasuredValue. 42
43
MinMeasuredValue and MaxMeasuredValue define the range of the sensor 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 155

4.6.2.2.1.4 Tolerance Attribute

1
The Tolerance attribute indicates the magnitude of the possible error that is 2
associated with MeasuredValue . The true value is located in the range 3
(MeasuredValue – Tolerance) to (MeasuredValue + Tolerance). 4
5
4.6.2.3 Commands Received 6
No cluster specific commands are received by the server cluster. 7
8
4.6.2.4 Commands Generated 9
10
No cluster specific commands are generated by the server cluster. 11
12
4.6.2.5 Attribute Reporting 13
14
This cluster shall support attribute reporting using the Report Attributes command 15
and according to the minimum and maximum reporting interval and reportable 16
change settings described in the ZCL Foundation specification (see 2.4.7) and, 17
where relevant, according to the MinPercentChange and MinAbsoluteChange 18
settings in this cluster. The following attribute shall be reported: 19
MeasuredValue 20
Tolerance 21
22
4.6.3 Client 23
24
4.6.3.1 Dependencies 25
26
None. 27
28
4.6.3.2 Attributes 29
30
The Client cluster has no attributes. 31
32
4.6.3.3 Commands Received 33
No cluster specific commands are received by the client cluster. 34
35
4.6.3.4 Commands Generated 36
37
No cluster specific commands are generated by the client cluster. 38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
156 Measurement and Sensing Specification

4.7 Relative Humidity Measurement Cluster 1

2
4.7.1 Overview 3
4
The server cluster provides an interface to relative humidity measurement 5
functionality, including configuration and provision of notifications of relative 6
humidity measurements. 7
8
9
4.7.2 Server 10
11
4.7.2.1 Dependencies 12
13
None 14
15
4.7.2.2 Attributes 16
For convenience, the attributes defined in this specification are arranged into sets 17
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 18
are encoded such that the most significant three nibbles specify the attribute set 19
and the least significant nibble specifies the attribute within the set. The currently 20
defined attribute sets are listed in Table 4.18. 21
22
Table 4.18 Relative Humidity Measurement Attribute Sets
23
Attribute Set Identifier Description 24
25
0x000 Relative Humidity Measurement Information 26
27
0x001 – 0xfff Reserved
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 157

4.7.2.2.1 Relative Humidity Measurement Information Attribute Set

1
The Relative Humidity Measurement Information attribute set contains the 2
attributes summarized in Table 4.19. 3
Table 4.19 Attributes of the Relative Humidity Measurement Information 4
Attribute Set 5
6

Mandatory
7

/ Optional
Identifier Name Type Range Access Default 8
9
10
0x0000 MeasuredValue Unsigned 16- MinMeasuredValue Read - M 11
bit Integer to only 12
MaxMeasuredValue 13
14
0x0001 MinMeasuredValue Unsigned 16- 0x0000 – 0x270f Read - M
bit Integer only 15
16
0x0002 MaxMeasuredValue Unsigned 16- 0x0001 – 0x2710 Read - M 17
bit Integer only
18
0x0003 Tolerance Unsigned 16- 0x0000 – 0x0800 Read - O 19
bit Integer only 20
21
4.7.2.2.1.1 MeasuredValue Attribute 22
23
MeasuredValue represents the relative humidity in % as follows:- 24
MeasuredValue = 100 x Relative humidity 25
26
Where 0% <= Relative humidity <= 100%, corresponding to a MeasuredValue in 27
the range 0 to 0x2710. 28
The maximum resolution this format allows is 0.01%. 29
30
A MeasuredValue of 0xffff indicates that the measurement is invalid. 31
MeasuredValue is updated continuously as new measurements are made. 32
33
4.7.2.2.1.2 MinMeasuredValue Attribute 34
35
The MinMeasuredValue attribute indicates the minimum value of MeasuredValue 36
that can be measured. A value of 0xffff means this attribute is not defined 37
38
4.7.2.2.1.3 MaxMeasuredValue Attribute 39
40
The MaxMeasuredValue attribute indicates the maximum value of MeasuredValue 41
that can be measured. A value of 0xffff means this attribute is not defined 42
MaxMeasuredValue shall be greater than MinMeasuredValue. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
158 Measurement and Sensing Specification

MinMeasuredValue and MaxMeasuredValue define the range of the sensor

1
4.7.2.2.1.4 Tolerance Attribute 2
3
The Tolerance attribute indicates the magnitude of the possible error that is 4
associated with MeasuredValue . The true value is located in the range 5
(MeasuredValue – Tolerance) to (MeasuredValue + Tolerance). 6
7
4.7.2.3 Commands Received 8
9
No cluster specific commands are received by the server cluster.
10
4.7.2.4 Commands Generated 11
12
No cluster specific commands are generated by the server cluster. 13
14
4.7.2.5 Attribute Reporting 15
16
This cluster shall support attribute reporting using the Report Attributes command 17
and according to the minimum and maximum reporting interval and reportable 18
change settings described in the ZCL Foundation specification (see 2.4.7) and, 19
where relevant, according to the MinPercentChange and MinAbsoluteChange 20
settings in this cluster. The following attribute shall be reported: 21
MeasuredValue 22
Tolerance 23
24
4.7.3 Client 25
26
27
4.7.3.1 Dependencies
28
None. 29
30
4.7.3.2 Attributes 31
32
The Client cluster has no attributes. 33
34
4.7.3.3 Commands Received 35
No cluster specific commands are received by the client cluster. 36
37
4.7.3.4 Commands Generated 38
39
No cluster specific commands are generated by the client cluster. 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 159

4.8 Occupancy Sensing Cluster 1

2
4.8.1 Overview 3
4
The server cluster provides an interface to occupancy sensing functionality, 5
including configuration and provision of notifications of occupancy status. 6
7
8
4.8.2 Server 9
10
4.8.2.1 Dependencies 11
12
None. 13
14
4.8.2.2 Attributes 15
For convenience, the attributes defined in this specification are arranged into sets 16
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 17
are encoded such that the most significant three nibbles specify the attribute set 18
and the least significant nibble specifies the attribute within the set. The currently 19
defined attribute sets are listed in Table 4.20. 20
21
Table 4.20 Occupancy Sensor Attribute Sets
22
Attribute Set 23
Description 24
Identifier
25
0x000 Occupancy sensor information 26
0x001 PIR configuration 27
28
0x002 Ultrasonic configuration 29
0x003 – 0xfff Reserved 30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
160 Measurement and Sensing Specification

4.8.2.2.1 Occupancy Sensor Information Set

1
The occupancy sensor information attribute set contains the attributes summarized 2
in Table 4.21. 3
Table 4.21 Attributes of the Occupancy Sensor Information Attribute Set 4
5

Mandatory
6

/ Optional
7
Identifier Name Type Range Access Default
8
9
10
0x0000 Occupancy 8-bit Bitmap 0000000x Read only - M
11
0x0001 OccupancySensor 8-bit 0x00 – 0xfe Read only - M 12
Type Enumeration 13
14
4.8.2.2.1.1 Occupancy Attribute 15
16
The Occupancy attribute is a bitmap. 17
Bit 0 specifies the sensed occupancy as follows: 1 = occupied, 0 = unoccupied. 18
19
All other bits are reserved. 20
21
4.8.2.2.1.2 OccupancySensorType Attribute 22
The OccupancySensorType attribute specifies the type of the occupancy sensor. 23
This attribute shall be set to one of the non-reserved values listed in Table 4.22. 24
25
Table 4.22 Values of the OccupancySensorType Attribute 26
27
OccupancySensorType
Attribute Value Description 28
29
0x00 PIR 30
0x01 Ultrasonic
31
32
0x02 PIR and ultrasonic 33
0x03 – 0xff Reserved 34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 161

4.8.2.2.2 PIR Configuration Set

1
The PIR sensor configuration attribute set contains the attributes summarized in 2
Table 4.23. 3
Table 4.23 Attributes of the PIR Configuration Attribute Set 4
5

Mandatory
6

/ Optional
7
Identifier Name Type Range Access Default
8
9
10
0x0010 PIROccupiedTo Unsigned 0x00 – Read/ 0x00 O
UnoccupiedDelay 8-bit integer 0xfe Write 11
12
0x0011 PIRUnoccupiedTo Unsigned 0x00 – Read/ 0x00 O 13
OccupiedDelay 8-bit integer 0xfe write
14
15
4.8.2.2.2.1 PIROccupiedToUnoccupiedTime Attribute 16
17
The PIROccupiedToUnoccupiedDelay attribute is 8-bits in length and specifies
18
the time delay, in seconds, before the PIR sensor changes to its occupied state
19
when the sensed area becomes unoccupied. This attribute, along with
20
PIRUnoccupiedToOccupiedTime, may be used to reduce sensor 'chatter' when
21
used in an area where occupation changes frequently.
22
23
4.8.2.2.2.2 PIRUnoccupiedToOccupiedTime Attribute 24
The PIRUnoccupiedToOccupiedDelay attribute is 8-bits in length and specifies 25
the time delay, in seconds, before the PIR sensor changes to its unoccupied state 26
when the sensed area becomes occupied. 27
28
4.8.2.2.3 Ultrasonic Configuration Set 29
The ultrasonic sensor configuration attribute set contains the attributes 30
summarized in Table 4.24. 31
32
Table 4.24 Attributes of the Ultrasonic Configuration Attribute Set 33
34
Mandatory
/ Optional

35
Identifier Name Type Range Access Default 36
37
38
0x0020 UltraSonicOccupiedTo Unsigned 0x00 – Read/ 0x00 O 39
UnoccupiedDelay 8-bit integer 0xfe Write 40
0x0021 UltraSonicUnoccupiedTo Unsigned 0x00 – Read/ 0x00 O 41
OccupiedDelay 8-bit integer 0xfe write 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 4
162 Measurement and Sensing Specification

4.8.2.2.3.1 UltraSonicOccupiedToUnoccupiedDelay Attribute

1
The UltraSonicOccupiedToUnoccupiedTime attribute specifies the time delay, in 2
seconds, before the ultrasonic sensor changes to its occupied state when the 3
sensed area becomes unoccupied. This attribute, along with 4
UltraSonicUnoccupiedToOccupiedTime, may be used to reduce sensor 'chatter' 5
when used in an area where occupation changes frequently. 6
7
4.8.2.2.3.2 UltraSonicUnoccupiedToOccupiedDelay Attribute 8
9
The UltraSonicUnoccupiedToOccupiedTime attribute specifies the time delay, in
10
seconds, before the ultrasonic sensor changes to its unoccupied state when the
11
sensed area becomes occupied.
12
4.8.2.3 Commands Received 13
14
No cluster specific commands are received by the server cluster. 15
16
4.8.2.4 Commands Generated 17
18
No cluster specific commands are generated by the server cluster. 19
20
4.8.2.5 Attribute Reporting 21
This cluster shall support attribute reporting using the Report Attributes command 22
and according to the minimum and maximum reporting interval settings described 23
in the ZCL Foundation specification (see 2.4.7). The following attribute shall be 24
reported: 25
Occupancy 26
27
28
4.8.3 Client 29
30
4.8.3.1 Dependencies 31
32
None. 33
34
4.8.3.2 Attributes 35
The client cluster has no attributes. 36
37
4.8.3.3 Commands Received 38
39
No cluster specific commands are received by the client cluster. 40
41
4.8.3.4 Commands Generated 42
No cluster specific commands are generated by the client cluster. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 163

C H A P T E R
1

5
2
3
4
5
6
7
8
9

CHAPTER 5LIGHTING SPECIFICATION 10

11
12
13
5.1 General Description 14
15
16
5.1.1 Introduction 17
18
The clusters specified in this document are for use typically in ZigBee lighting 19
applications, but may be used in any application domain. 20
21
22
5.1.2 Cluster List 23
24
This section lists the clusters specified in this document, and gives examples of 25
typical usage for the purpose of clarification. 26
The clusters specified in this document are listed in Table 5.1. 27
28
Table 5.1 Clusters Specified for the Lighting Functional Domain
29
Cluster Name Description 30
31
Color Control Attributes and commands for controlling the hue and saturation 32
of a color-capable light. 33
Ballast Configuration Attributes and commands for configuring a lighting ballast 34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 5
164 Lighting Specification

1
Configuration tool Ballast for fluorescent lamp 2
3
4
Ballast configuration
C S 5
6
7
8
Colored light controller Variable color light 9
10
Color control 11
C S
12
13
14
C = Client S = Server 15
16
Note:- Device names are examples for illustration only 17
18
Figure 5.1 Typical Usage of Ballast Configuration and Color Control 19
Clusters 20
21
22
5.2 Color Control Cluster 23
24
25
5.2.1 Overview 26
27
This cluster provides an interface for changing the color of a light by controlling
28
its hue and saturation. Control over luminance is not included, as this is provided
29
by means of the Level Control cluster of the General library (see 3.10).
30
It is recommended that the hue and saturation are interpreted according to the 31
HSV (aka HSB) color model. 32
33
34
5.2.2 Server 35
36
5.2.2.1 Dependencies 37
None 38
39
5.2.2.2 Attributes 40
41
For convenience, the attributes defined in this specification are arranged into sets 42
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 43
are encoded such that the most significant three nibbles specify the attribute set 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 165

and the least significant nibble specifies the attribute within the set. The currently
defined attribute sets are listed in Table 5.2. 1
2
Table 5.2 Hue Control Attribute Sets
3
Attribute Set 4
Description 5
Identifier
6
0x000 Color Information 7
0x001 – 0xfff Reserved 8
9
10
5.2.2.2.1 Color Information Attribute Set
11
The Color Information attribute set contains the attributes summarized in 12
Table 5.3. 13
14
Table 5.3 Attributes of the Color Information Attribute Set
15
Mandatory 16
Identifier Name Type Range Access Default / Optional 17
18
0x0000 CurrentHue Unsigned 0x00 – Read only 0x00 M 19
8-bit integer 0xfe
20
0x0001 CurrentSaturation Unsigned 0x00 – Read only 0x00 M 21
8-bit integer 0xfe 22
0x0002 RemainingTime Unsigned 0x0000 – Read only 0x00 O 23
16-bit integer 0xfffe 24
25
26
5.2.2.2.1.1 CurrentHue Attribute
27
The CurrentHue attribute contains the current hue value of the light. It is updated 28
as fast as practical during commands that change the hue. 29
30
The hue in degrees shall be related to the CurrentHue attribute by the relationship
31
Hue = CurrentHue x 360 / 254 (CurrentHue in the range 0 to 254 inclusive)
32
33
5.2.2.2.1.2 CurrentSaturation Attribute 34
The CurrentSaturation attribute holds the current saturation value of the light. It is 35
updated as fast as practical during commands that change the hue. 36
37
The saturation shall be related to the CurrentSaturation attribute by the 38
relationship 39
Saturation = CurrentSaturation / 254 (CurrentSaturation in the range 0 to 254 40
inclusive) 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 5
166 Lighting Specification

5.2.2.2.1.3 RemainingTime Attribute

1
The RemainingTime attribute holds the time remaining, in 1/10ths of a second, 2
until the currently active command will be complete. 3
4
5.2.2.3 Commands Received 5
The command IDs for the Hue Control cluster are listed in Table 5.4. 6
7
Table 5.4 Command IDs for the Hue Light Control Cluster 8
9
Command Identifier Mandatory /
Description 10
Field Value Optional
11
0x00 Move to Hue M 12
13
0x01 Move Hue M
14
0x02 Step Hue M 15
0x03 Move to Saturation M 16
17
0x04 Move Saturation M 18
0x05 Step Saturation M 19
20
0x06 Move to Hue and Saturation M 21
0x07 – 0xff Reserved 22
23
5.2.2.3.1 Move to Hue Command 24
25
26
5.2.2.3.1.1 Payload Format
27
The Move to Hue command payload shall be formatted as illustrated in 28
Figure 5.2. 29
30
Bits 8 8 16 31
32
Data Type Unsigned 8-bit Integer 8-bit Enumeration Unsigned 16-bit Integer
33
Hue Direction Transition time 34
Field Name
35
36
Figure 5.2 Format of the Move to Hue Command Payload 37
38
5.2.2.3.1.2 Hue Field 39
The Hue field specifies the hue to be moved to. 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 167

5.2.2.3.1.3 Direction Field

1
The Direction field shall be one of the non-reserved values in Table 5.5. 2
Table 5.5 Values of the Direction Field 3
4
Fade Mode Value Description 5
6
0x00 Shortest distance
7
0x01 Longest distance 8
9
0x02 Up
10
0x03 Down 11
0x04 – 0xff Reserved 12
13
14
5.2.2.3.1.4 Transition Time Field 15
The Transition time field specifies, in 1/10ths of a second, the time that shall be 16
taken to move to the new hue 17
18
5.2.2.3.1.5 Effect on Receipt 19
20
On receipt of this command, a device shall move from its current hue to the value 21
given in the Hue field. The movement shall be continuous, i.e. not a step function, 22
and the time taken to move to the new hue shall be equal to the Transition time 23
field. 24
25
As hue is effectively measured on a circle, the new hue may be moved to in either
26
direction. The direction of hue change is given by the Direction field. If Direction
27
is 'Shortest distance', the direction is taken that involves the shortest path round
28
the circle. This case corresponds to expected normal usage. If Direction is
29
'Longest distance', the direction is taken that involves the longest path round the
30
circle. This case can be used for 'rainbow effects'. In both cases, if both distances
31
are the same, the Up direction shall be taken.
32
5.2.2.3.2 Move Hue Command 33
34
5.2.2.3.2.1 Payload Format 35
36
The Move Hue command payload shall be formatted as illustrated in Figure 5.3. 37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 5
168 Lighting Specification

1
Bits 8 8 2
3
Data Type 8-bit Enumeration Unsigned 8-bit Integer 4
5
Field Name Move mode Rate
6
7
Figure 5.3 Format of the Move Hue Command Payload 8
9
5.2.2.3.2.2 Move Mode Field 10
11
The Move mode field shall be one of the non-reserved values in Table 5.6. 12
Table 5.6 Values of the Move Mode Field 13
14
Fade Mode Value Description 15
16
0x00 Stop
17
0x01 Up 18
0x02 Reserved
19
20
0x03 Down 21
0x04 – 0xff Reserved 22
23
24
5.2.2.3.2.3 Rate Field 25
The Rate field specifies the rate of movement in steps per second. A step is a 26
change in the device’s hue of one unit. If the Rate field has a value of zero, the 27
command has no effect and a default response command (see 2.4.12) is sent in 28
response, with the status code set to INVALID_FIELD. 29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 169

5.2.2.3.2.4 Effect on Receipt

1
On receipt of this command, a device shall move from its current hue in an up or 2
down direction in a continuous fashion, as detailed in Table 5.7. 3
Table 5.7 Actions on Receipt for Move Command 4
5
Fade Mode Action on Receipt 6
7
Stop If moving, stop, else ignore the command (i.e. the 8
command is accepted but has no effect).
9
Up Increase the device’s hue at the rate given in the 10
Rate field. If the hue reaches the maximum 11
allowed for the device, then proceed to its 12
minimum allowed value.
13
Down Decrease the device’s hue at the rate given in the 14
Rate field. If the hue reaches the minimum allowed 15
for the device, then proceed to its maximum
16
allowed value.
17
18
5.2.2.3.3 Step Hue Command 19
20
5.2.2.3.3.1 Payload Format 21
22
The Step Hue command payload shall be formatted as illustrated in Figure 5.4.
23
24
8 8 25
Bits
26
Data Type 8-bit Enumeration Unsigned 8-bit Integer 27
28
Field Name Step mode Transition time 29
30
31
Figure 5.4 Format of the Step Hue Command Payload
32
5.2.2.3.3.2 Step Mode Field 33
34
The Move mode field shall be one of the non-reserved values in Table 5.8. 35
Table 5.8 Values of the Step Mode Field 36
37
Fade Mode Value Description 38
39
0x00 Reserved 40
0x01 Up 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 5
170 Lighting Specification

Table 5.8 Values of the Step Mode Field (Continued)

1
Fade Mode Value Description 2
3
0x02 Reserved 4
0x03 Down 5
6
0x04 – 0xff Reserved
7
8
5.2.2.3.3.3 Transition Time Field 9
10
The Transition time field specifies, in 1/10ths of a second, the time that shall be
11
taken to perform a single step. A step is a change in the device’s hue of one unit.
12
13
5.2.2.3.3.4 Effect on Receipt
14
On receipt of this command, a device shall move from its current hue in an up or 15
down direction by one step, as detailed in Table 5.9. 16
17
Table 5.9 Actions on Receipt for Step Command
18
Fade Mode Action on Receipt 19
20
Up Increase the device’s hue by one step. If the hue 21
value is already the maximum value then 22
proceed to the minimum allowed value.
23
Down Decrease the device’s hue by one step. If the 24
hue value is already the minimum value then 25
proceed to the maximum allowed value. 26
27
5.2.2.3.4 Move to Saturation Command 28
29
5.2.2.3.4.1 Payload Format 30
31
The Move to Saturation command payload shall be formatted as illustrated in 32
Figure 5.5. 33
34
35
Bits 8 16
36
Unsigned 8-bit Integer Unsigned 16-bit Integer 37
Data Type
38
Field Name Saturation Transition time 39
40
41
Figure 5.5 Format of the Move to Saturation Command Payload 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 171

5.2.2.3.4.2 Effect on Receipt

1
On receipt of this command, a device shall move from its current saturation to the 2
value given in the Saturation field. 3
The movement shall be continuous, i.e. not a step function, and the time taken to 4
move to the new saturation shall be equal to the Transition time field, in 1/10ths of 5
a second. 6
7
5.2.2.3.5 Move Saturation Command 8
9
5.2.2.3.5.1 Payload Format 10
11
The Move Saturation command payload shall be formatted as illustrated in 12
Figure 5.6. 13
Bits 8 8 14
15
Data Type 8-bit Enumeration Unsigned 8-bit Integer 16
17
Field Name Move mode Rate 18
19
Figure 5.6 Format of the Move Saturation Command Payload 20
21
5.2.2.3.5.2 Move Mode Field 22
23
The Move mode field shall be one of the non-reserved values in Table 5.10. 24
Table 5.10 Values of the Move Mode Field 25
26
Fade Mode Value Description 27
28
0x00 Stop
29
0x01 Up 30
31
0x02 Reserved
32
0x03 Down 33
0x04 – 0xff Reserved 34
35
36
5.2.2.3.5.3 Rate Field 37
The Rate field specifies the rate of movement in steps per second. A step is a 38
change in the device’s saturation of one unit. If the Rate field has a value of zero, 39
the command has no effect and a default response command (see 2.4.12) is sent in 40
response, with the status code set to INVALID_FIELD. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 5
172 Lighting Specification

5.2.2.3.5.4 Effect on Receipt

1
On receipt of this command, a device shall move from its current saturation in an 2
up or down direction in a continuous fashion, as detailed in Table 5.11 3
Table 5.11 Actions on Receipt for Move Command 4
5
Fade Mode Action on Receipt 6
7
Stop If moving, stop, else ignore the command (i.e. the
command is accepted but has no affect).
8
9
Up Increase the device’s saturation at the rate given in the 10
Rate field. If the saturation reaches the maximum 11
allowed for the device, stop.
12
Down Decrease the device’s saturation at the rate given in the 13
Rate field. If the saturation reaches the minimum 14
allowed for the device, stop.
15
16
5.2.2.3.6 Step Saturation Command 17
18
5.2.2.3.6.1 Payload Format 19
20
The Step Saturation command payload shall be formatted as illustrated in 21
Figure 5.7. 22
23
24
Bits 8 8
25
8-bit Enumeration Unsigned 8-bit Integer 26
Data Type
27
Field Name Step mode Transition time 28
29
30
Figure 5.7 Format of the Step Saturation Command Payload
31
32
5.2.2.3.6.2 Step Mode Field 33
The Step mode field shall be one of the non-reserved values in Table 5.12. 34
35
Table 5.12 Values of the Step Mode Field
36
37
Step Mode Value Description
38
0x00 Reserved 39
40
0x01 Up
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 173

Table 5.12 Values of the Step Mode Field (Continued)

1
Step Mode Value Description 2
3
0x02 Reserved 4
0x03 Down 5
6
0x04 – 0xff Reserved
7
8
5.2.2.3.6.3 Transition Time Field 9
10
The Transition time field specifies, in 1/10ths of a second, the time that shall be
11
taken to perform a single step. A step is a change in the device’s saturation of one
12
unit.
13
14
5.2.2.3.6.4 Effect on Receipt
15
On receipt of this command, a device shall move from its current saturation in an 16
up or down direction by one step, as detailed in Table 5.13. 17
18
Table 5.13 Actions on Receipt for Step Command
19
Step Mode Action on Receipt 20
21
Up Increase the device’s saturation by one step. 22
However, if the saturation value is already the 23
maximum value then do nothing.
24
Down Decrease the device’s saturation by one step. 25
However, if the saturation value is already the 26
minimum value then do nothing. 27
28
5.2.2.3.7 Move to Hue and Saturation Command 29
30
5.2.2.3.7.1 Payload Format 31
32
The Move to Hue and Saturation command payload shall be formatted as 33
illustrated in Figure 5.8. 34
35
36
Bits 8 8 16
37
Unsigned 8-bit Integer Unsigned 8-bit Integer Unsigned 16-bit Integer 38
Data Type
39
Field Name Hue Saturation Transition time 40
41
42
Figure 5.8 Format of the Move to Hue and Saturation Command Payload 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 5
174 Lighting Specification

5.2.2.3.7.2 Effect on Receipt

1
On receipt of this command, a device shall move from its current hue and 2
saturation to the values given in the Hue and Saturation fields. 3
The movement shall be continuous, i.e. not a step function, and the time taken to 4
move to the new saturation shall be equal to the Transition time field, in 1/10ths of 5
a second. 6
7
The path through color space taken during the transition is not specified, but it is 8
recommended that the shortest path is taken though hue/saturation space, i.e. 9
movement is 'in a straight line' across the hue/saturation disk. 10
11
5.2.2.4 Commands Generated 12
The server generates no cluster specific commands 13
14
5.2.2.5 Scene Table Extensions 15
16
If the Scenes server cluster (see 3.7) is implemented, the following extension 17
fields are added to the Scenes table: 18
19
• CurrentHue
20
• CurrentSaturation 21
22
5.2.2.6 Attribute Reporting 23
24
This cluster shall support attribute reporting using the Report Attributes command 25
and according to the minimum and maximum reporting interval and reportable 26
change settings described in the ZCL Foundation specification (see 2.4.7). The 27
following attributes shall be reported: 28
CurrentHue 29
30
CurrentSaturation 31
32
5.2.3 Client 33
34
5.2.3.1 Dependencies 35
36
None 37
38
5.2.3.2 Attributes 39
None 40
41
5.2.3.3 Commands Received 42
43
No cluster specific commands are received by the server. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 175

5.2.3.4 Commands Generated

1
The client generates the commands detailed in 5.2.2.3, as required by the 2
application. 3
4
5
6
5.3 Ballast Configuration Cluster 7
8
9
5.3.1 Overview 10
11
Attributes and commands for configuring a lighting ballast. 12
13
14
5.3.2 Server 15
16
5.3.2.1 Dependencies 17
18
For the alarm functionality specified by this cluster to be operational, the Alarms
19
server cluster shall be implemented on the same endpoint.
20
5.3.2.2 Attributes 21
22
For convenience, the attributes defined in this specification are arranged into sets 23
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 24
are encoded such that the most significant three nibbles specify the attribute set 25
and the least significant nibble specifies the attribute within the set. The currently 26
defined attribute sets are listed in Table 5.14. 27
Table 5.14 Ballast Configuration Attribute Sets
28
29
Attribute Set 30
Identifier Description 31
32
0x000 Ballast information 33
0x001 Ballast settings 34
35
0x002 Lamp information
36
0x003 Lamp settings 37
38
0x004 – 0xfff Reserved
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 5
176 Lighting Specification

5.3.2.2.1 Ballast Information Attribute Set

1
The Ballast Information attribute set contains the attributes summarized in 2
Table 5.15. 3
Table 5.15 Attributes of the Ballast Information Attribute Set 4
5
Identifier Name Type Range Access Default Mandatory 6
/ Optional 7
0x0000 PhysicalMinLevel Unsigned 0x01 – Read only 0x01 O
8
8-bit integer 0xfe 9
10
0x0001 PhysicalMaxLevel Unsigned 0x01 – Read only 0xfe O 11
8-bit integer 0xfe
12
0x0002 BallastStatus 8-bit Bitmap 0000 00xx Read only 0000 0000 M 13
14
5.3.2.2.1.1 PhysicalMinLevel Attribute 15
16
The PhysicalMinLevel attribute is 8-bits in length and specifies the minimum light 17
level the ballast can achieve. This attribute shall be specified in the range 0x01 to 18
0xfe, and specifies the light output of the ballast according to the dimming light 19
curve (see 5.3.4). 20
21
5.3.2.2.1.2 PhysicalMaxLevel Attribute 22
23
The PhysicalMaxLevel attribute is 8-bits in length and specifies the maximum
24
light level the ballast can achieve. This attribute shall be specified in the range
25
0x01 to 0xfe, and specifies the light output of the ballast according to the dimming
26
light curve (see 5.3.4).
27
28
5.3.2.2.1.3 BallastStatus Attribute 29
The BallastStatus attribute is 8-bits in length and specifies the activity status of 30
the ballast functions. The usage of the bits is specified in Table 5.16. Where a 31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 177

function is active, the corresponding bit shall be set to 1. Where a function is not
active, the corresponding bit shall be set to 0. 1
2
Table 5.16 Bit Usage of the BallastStatus Attribute
3
BallastStatus 4
Attribute Ballast Function Details 5
Bit Number 6
7
0 Non-operational 0 = The ballast is fully operational 8
1 = The ballast is not fully operational
9
1 Lamp not in socket 0 = All lamps are in their sockets 10
1 = One or more lamp is not in its socket 11
2–7 Reserved - 12
13
14
5.3.2.2.2 Ballast Settings Attribute Set
15
The Ballast Settings attribute set contains the attributes summarized in Table 5.17. 16
Table 5.17 Attributes of the Ballast Settings Attribute Set
17
18
Mandatory 19
Identifier Name Type Range Access Default 20
/ Optional
21
0x0010 MinLevel Unsigned 0x01 – 0xfe Read/ Physical O 22
8-bit integer write MinLevel
23
0x0011 MaxLevel Unsigned 0x01 – 0xfe Read/ Physical O 24
8-bit integer write MaxLevel 25
0x0012 PowerOnLevel Unsigned 0x00 – 0xfe Read/ Physical O 26
8-bit integer write MaxLevel 27
28
0x0013 PowerOn Unsigned 0x0000 – Read/ 0x0000 O
FadeTime 16-bit integer 0xfffe write 29
30
0x0014 Intrinsic Unsigned 0x00 – 0xfe Read/ - O 31
BallastFactor 8-bit integer write
32
0x0015 BallastFactor Unsigned 0x64 – Read/ 0xff O 33
Adjustment 8-bit integer manufacturer write 34
dependent 35
36
5.3.2.2.2.1 MinLevel Attribute 37
38
The MinLevel attribute is 8-bits in length and specifies the minimum light level 39
the ballast is permitted to use. This attribute shall be specified in the range 0x01 to 40
0xfe, and specifies the light output of the ballast according to the dimming light 41
curve (see 7.4). 42
The value of this attribute shall be both greater than or equal to PhysicalMinLevel 43
and less than or equal to MaxLevel. If an attempt is made to set this attribute to a 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 5
178 Lighting Specification

level where these conditions are not met, a default response command shall be
returned with status code set to INVALID_VALUE, and the level shall not be set. 1
2
5.3.2.2.2.2 MaxLevel Attribute 3
4
The MaxLevel attribute is 8-bits in length and specifies the maximum light level 5
the ballast is permitted to use. This attribute shall be specified in the range 0x01 to 6
0xfe, and specifies the light output of the ballast according to the dimming light 7
curve (see 5.3.4). 8
The value of this attribute shall be both less than or equal to PhysicalMaxLevel 9
and greater than or equal to MinLevel. If an attempt is made to set this attribute to 10
a level where these conditions are not met, a default response command shall be 11
returned with status code set to INVALID_VALUE, and the level shall not be set. 12
13
14
5.3.2.2.2.3 PowerOnLevel Attribute
15
The PowerOnLevel attribute is 8-bits in length and specifies the light level to 16
which the ballast will go when power is applied (e.g. when mains power is re- 17
established after a power failure). This attribute shall be set to one of the values 18
listed in Table 5.18. 19
Table 5.18 Values of the PowerOnLevel Attribute
20
21
PowerOnLevel 22
Attribute Value Description 23
24
0x00 – 0xfe Set to this specific light level, according to the dimming 25
light curve (see 5.3.4).
26
0xff Restore the light level being used prior to power failure. 27
28
The value of this attribute shall be both less than or equal to PhysicalMaxLevel 29
and greater than or equal to MinLevel. If an attempt is made to set this attribute to 30
a level where these conditions are not met, a default response command shall be 31
returned with status code set to INVALID_VALUE, and the level shall not be set. 32
33
5.3.2.2.2.4 PowerOnFadeTime Attribute 34
35
The PowerOnFadeTime attribute is 16-bits in length and specifies the length of 36
time, in tenths of a second, that the ballast takes to move to the light level 37
specified in PowerOnLevel when power is applied (e.g. when mains power is re- 38
established after a power failure). 39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 179

5.3.2.2.2.5 IntrinsicBallastFactor Attribute

1
The IntrinsicBallastFactor attribute is 8-bits in length and specifies as a 2
percentage the ballast factor of the ballast/lamp combination (see also clause 5.3), 3
prior to any adjustment. 4
A value of 0xff indicates in invalid value. 5
6
5.3.2.2.2.6 BallastFactorAdjustment Attribute 7
8
The BallastFactorAdjustment attribute is 8-bits in length and specifies the 9
multiplication factor, as a percentage, to be applied to the configured light output 10
of the lamps (see also clause 5.3). A typical usage of this mechanism is to 11
compensate for reduction in efficiency over the lifetime of a lamp. 12
13
The light output is given by
14
Actual light output = configured light output x BallastFactorAdjustment / 100% 15
16
The range for this attribute is manufacturer dependent. If an attempt is made to set
17
this attribute to a level that cannot be supported, a default response command shall
18
be returned with status code set to INVALID_VALUE, and the level shall not be
19
set. The value 0xff indicates that ballast factor scaling is not in use.
20
5.3.2.2.3 Lamp Information Attribute Set 21
22
The lamp information attribute set contains the attributes summarized in 23
Table 5.19. 24
Table 5.19 Attributes of the Lamp Information Attribute Set 25
26
Default Mandatory
/ 27
Identifier Name Type Range Access Optional
28
0x0020 LampQuantity Unsigned 0x00 – Read only - O 29
8-bit integer 0xfe 30
31
5.3.2.2.3.1 LampQuantity Attribute 32
33
The LampQuantity attribute is 8 bits in length and specifies the number of lamps 34
connected to this ballast. (Note 1: this number does not take into account whether 35
lamps are actually in their sockets or not). 36
5.3.2.2.4 Lamp Settings Attribute Set 37
38
The Lamp Settings attribute set contains the attributes summarized in Table 5.20. 39
If LampQuantity is greater than one, each of these attributes is taken to apply to 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 5
180 Lighting Specification

the lamps as a set. For example, all lamps are taken to be of the same LampType
with the same LampBurnHours. 1
2
Table 5.20 Attributes of the Lamp Settings Attribute Set
3
4

Mandatory
/ Optional
5
Identifier Name Type Range Access Default 6
7
8
0x0030 LampType Character - Read/write Empty string O 9
string 10
0x0031 LampManufacturer Character - Read/write Empty string O 11
string 12
13
0x0032 LampRatedHours Unsigned 0x000000 Read/write 0xffffff O
24-bit – 0xfffffe 14
integer 15
16
0x0033 LampBurnHours Unsigned 0x000000 Read/write 0x000000 O
24-bit – 0xfffffe
17
integer 18
19
0x0034 LampAlarmMode Bitmap 0000 000x Read/write 0000 0000 O 20
(8-bit)
21
0x0035 LampBurnHours Unsigned 0x000000 Read/write 0xffffff O 22
TripPoint 24-bit – 0xfffffe 23
integer
24
25
5.3.2.2.4.1 LampType Attribute 26
27
The LampType attribute is an character string of up to 16 bytes in length. It
28
specifies the type of lamps (including their wattage) connected to the ballast.
29
30
5.3.2.2.4.2 LampManufacturer Attribute 31
The LampManufacturer attribute is an character string of up to 16 bytes in length. 32
It specifies the name of the manufacturer of the currently connected lamps. 33
34
5.3.2.2.4.3 LampRatedHours Attribute 35
36
The LampRatedHours attribute is 24-bits in length and specifies the number of 37
hours of use the lamps are rated for by the manufacturer. 38
A value of 0xffffff indicates an invalid or unknown time. 39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 181

5.3.2.2.4.4 LampBurnHours Attribute

1
The LampBurnHours attribute is 24-bits in length and specifies the length of time, 2
in hours, the currently connected lamps have been operated, cumulative since the 3
last re-lamping. Burn hours shall not be accumulated if the lamps are off. 4
This attribute should be reset to zero (e.g. remotely) when the lamp(s) are 5
changed. If partially used lamps are connected, LampBurnHours should be 6
updated to reflect the burn hours of the lamps. 7
8
A value of 0xffffff indicates an invalid or unknown time. 9
10
5.3.2.2.4.5 LampAlarmMode Attribute 11
12
The LampsAlarmMode attribute is 8-bits in length and specifies which attributes
13
may cause an alarm notification to be generated, as listed in Table 5.21. A ‘1’ in
14
each bit position causes its associated attribute to be able to generate an alarm.
15
(Note:-. All alarms are also logged in the alarm table – see Alarms cluster 3.11).
16
Table 5.21 Values of the MainsAlarmMode Attribute 17
18
MainsAlarmMode 19
Attribute
Attribute Bit Number
20
0 LampBurnHours 21
22
1–7 Reserved
23
24
5.3.2.2.4.6 LampBurnHoursTripPoint Attribute 25
26
The LampBurnHoursTripPoint attribute is 24-bits in length and specifies the
27
number of hours the LampBurnHours attribute may reach before an alarm is
28
generated.
29
If the Alarms cluster is not present on the same device this attribute is not used 30
and thus may be omitted (see 5.3.2.1). 31
32
The Alarm Code field included in the generated alarm shall be 0x01.
33
If this attribute takes the value 0xffffff then this alarm shall not be generated. 34
35
5.3.2.3 Commands Received 36
37
No commands are received by the server.
38
39
5.3.2.4 Commands Generated
40
The server generates no commands. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 5
182 Lighting Specification

5.3.3 Client 1
2
5.3.3.1 Dependencies 3
None 4
5
5.3.3.2 Attributes 6
7
The client has no attributes. 8
9
5.3.3.3 Commands Received 10
No cluster specific commands are received by the server. 11
12
5.3.3.4 Commands Generated 13
14
No cluster specific commands are generated by the server. 15
16
17
5.3.4 The Dimming Light Curve 18
19
The dimming curve is recommended to be logarithmic, as defined by the
20
following equation:
21
⎛ ⎞
This page is intentionally blank 22
⎜ ⎟
⎜ Level
-1⎟-1 23
⎜ ⎛253⎞ ⎟
⎜⎜ ⎟⎟ 24
%Light=10 ⎝⎝ 3 ⎠⎠ 25
26
Where:%Light is the percent light output of the ballast 27
Level is an 8-bit integer between 1 (0.1% light output) and 254 (100% output). 28
29
255 is reserved - the exact meaning of this value depends on the specific attribute
30
or command.
31
Note:-. The light output is determined by this curve together with the 32
IntrinsicBallastFactor and BallastFactorAdjustment. Attributes. 33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 183

C H A P T E R
1

6
2
3
4
5
6
7
8
9

CHAPTER 6HVAC SPECIFICATION 10

11
12
13
6.1 General Description 14
15
16
6.1.1 Introduction 17
18
The clusters specified in this document are for use typically in ZigBee HVAC 19
applications, but may be used in any application domain. 20
21
22
6.1.2 Cluster List 23
24
This section lists the clusters specified in this document, and gives examples of 25
typical usage for the purpose of clarification. 26
The clusters defined in this document are listed in Table 6.1. 27
28
Table 6.1 Clusters Specified in the HVAC Functional Domain
29
Cluster Name Description 30
31
Pump Configuration and An interface for configuring and controlling pumps. 32
Control 33
Thermostat An interface for configuring and controlling the functionality of a 34
thermostat 35
Fan Control An interface for controlling a fan in a heating / cooling system
36
37
Dehumidification An interface for controlling dehumidification 38
Control 39
Thermostat User An interface for configuring the user interface of a thermostat 40
Interface Configuration (which may be remote from the thermostat) 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
184 HVAC Specification

1
Pump controller Pump 2
3
Pump configuration and control 4
C S 5
Level control (see 3.10) 6
C S
7
On/Off (see 3.8)
C S 8
9
10
11
C = Client S = Server 12
Note:- Device names are examples for illustration only
13
14
Figure 6.1 Typical Usage of the Pump Configuration and Control Cluster 15
16
17
18
Optional temperature, 19
humidity and occupancy 20
sensors 21
22
Dehumidification 23
Notification Heating /cooling device
Heating / cooling 24
control panel Thermostat (e.g. indoor air handler)
25
26
Dehumidification 27
C S S
Configuration 28
Fan control 29
C C C S
Thermostat 30
S C S S 31
Configuration
32
33
Thermostat Thermostat 34
user interface Notification 35
configuration 36
37
C = Client S = Server
38
Configuration
tool Note:- Device names are examples for illustration only 39
40
Figure 6.2 Example Usage of the Thermostat and Related Clusters 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 185

6.2 Pump Configuration and Control Cluster 1

2
6.2.1 Overview 3
4
The Pump Configuration and Control cluster provides an interface for the setup 5
and control of pump devices, and the automatic reporting of pump status 6
information. Note that control of pump speed is not included – speed is controlled 7
by the On/Off and Level Control clusters (see Figure 6.1). 8
9
10
6.2.2 Server 11
12
6.2.2.1 Dependencies 13
14
Where external pressure, flow and temperature measurements are processed by 15
this cluster (see Table 6.8), these are provided by a Pressure Measurement cluster 16
(4.5), a Flow Measurement cluster (4.6) and a Temperature Measurement client 17
cluster (4.4) respectively. These 3 client clusters are used for connection to a 18
remote sensor device. The pump is able to use the sensor measurement provided 19
by a remote sensor for regulation of the pump speed. 20
For the alarms described in Table 6.9 to be operational, the Alarms server cluster 21
(3.11) shall be implemented on the same endpoint. 22
23
Note that control of the pump setpoint is not included in this cluster – the On/Off 24
and Level Control clusters (see Figure 6.1) may be used by a pump device to turn 25
it on and off and control its setpoint. Note that the Pump Configuration and 26
Control Cluster may override on/off/setpoint settings for specific operation modes 27
(See section 6.2.2.2.3.1 for detailed description of the operation and control of the 28
pump.). 29
30
6.2.2.2 Attributes 31
For convenience, the attributes defined in this specification are arranged into sets 32
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 33
are encoded such that the most significant three nibbles specify the attribute set 34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
186 HVAC Specification

and the least significant nibble specifies the attribute within the set. The currently
defined attribute sets are listed in Table 6.2. 1
2
Table 6.2 Pump Configuration Attribute Sets
3
Attribute Set 4
Identifier Description 5
6
0x000 Pump Information 7
0x001 Pump Dynamic Information 8
9
0x002 Pump Settings 10
0x003 – 0xfff Reserved 11
12
6.2.2.2.1 Pump Information Attribute Set 13
14
The pump information attribute set contains the attributes summarized in 15
Table 6.3. 16
Table 6.3 Attributes of the Pump Information Attribute Set 17
18
19

Mandatory
/ Optional
20
Identifier Name Type Range Access Default
21
22
23
0x0000 MaxPressure Signed 0x8001- Read only - M
16-bit integer 0x7fff 24
25
0x0001 MaxSpeed Unsigned 0x0000 – Read only - M 26
16-bit integer 0xfffe
27
0x0002 MaxFlow Unsigned 0x0000 – Read only - M 28
16-bit integer 0xfffe 29
0x0003 MinConstPressure Signed 0x8001- Read only - O 30
16-bit integer 0x7fff 31
32
0x0004 MaxConstPressure Signed 0x8001- Read only - O
33
16-bit integer 0x7fff
34
0x0005 MinCompPressure Signed 0x8001- Read only - O 35
16-bit integer 0x7fff 36
0x0006 MaxCompPressure Signed 0x8001- Read only - O 37
16-bit integer 0x7fff 38
39
0x0007 MinConstSpeed Unsigned 0x0000 – Read only - O
16-bit integer 0xfffe 40
41
0x0008 MaxConstSpeed Unsigned 0x0000 – Read only - O 42
16-bit integer 0xfffe
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 187

Table 6.3 Attributes of the Pump Information Attribute Set (Continued)

1

Mandatory
2

/ Optional
Identifier Name Type Range Access Default 3
4
5
0x0009 MinConstFlow Unsigned 0x0000 – Read only - O 6
16-bit integer 0xfffe 7
8
0x000a MaxConstFlow Unsigned 0x0000 – Read only - O
9
16-bit integer 0xfffe
10
0x000b MinConstTemp Signed 0x954d – Read only - O 11
16-bit integer 0x7fff 12
0x000c MaxConstTemp Signed 0x954d – Read only - O 13
16-bit integer 0x7fff 14
15
6.2.2.2.1.1 MaxPressure Attribute 16
17
The MaxPressure attribute specifies the maximum pressure the pump can achieve. 18
It is a physical limit, and does not apply to any specific control mode or operation 19
mode. 20
This attribute is read only, and can only be set by the manufacturer. If the value is 21
not available, this attribute will display the invalid value. 22
23
Valid range is -3,276.7 kPa to 3,276.7 kPa (steps of 0.1 kPa) 24
The value -3,276.8 kPa (0x8000) indicates that this value is invalid. 25
26
6.2.2.2.1.2 MaxSpeed Attribute 27
28
The MaxSpeed attribute specifies the maximum speed the pump can achieve. It is
29
a physical limit, and does not apply to any specific control mode or operation
30
mode.
31
This attribute is read only, and can only be set by the manufacturer. If the value is 32
not available, this attribute will display the invalid value. 33
34
Valid range is 0 to 65,534 RPM (steps of 1 RPM)
35
The value 65,535 RPM (0xffff) indicates that this value is invalid.
36
37
6.2.2.2.1.3 MaxFlow Attribute 38
The MaxFlow attribute specifies the maximum flow the pump can achieve. It is a 39
physical limit, and does not apply to any specific control mode or operation mode. 40
41
This attribute is read only, and can only be set by the manufacturer. If the value is 42
not available, this attribute will display the invalid value. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
188 HVAC Specification

Valid range is 0 m3/h to 6,553.4 m3/h (steps of 0.1 m3/h)

The value 6,553.5 m3/h (0xffff) indicates that this value is invalid. 1
2
6.2.2.2.1.4 MinConstPressure Attribute 3
4
The MinConstPressure attribute specifies the minimum pressure the pump can 5
achieve when it is running and working in control mode constant pressure 6
(ControlMode attribute of the Pump settings attribute set is set to Constant 7
pressure). 8
This attribute is read only, and can only be set by the manufacturer. If the value is 9
not available, this attribute will display the invalid value. 10
11
Valid range is –3,276.7 kPa to 3,276.7 kPa (steps of 0.1 kPa) 12
The value -3,276.8 kPa (0x8000) indicates that this value is invalid. 13
14
6.2.2.2.1.5 MaxConstPressure Attribute 15
16
The MaxConstPressure attribute specifies the maximum pressure the pump can 17
achieve when it is working in control mode constant pressure (ControlMode 18
attribute of the Pump settings attribute set is set to Constant pressure). 19
This attribute is read only, and can only be set by the manufacturer. If the value is 20
not available, this attribute will display the invalid value. 21
22
Valid range is –3,276.7 kPa to 3,276.7 kPa (steps of 0.1 kPa) 23
The value -3,276.8 kPa (0x8000) indicates that this value is invalid. 24
25
6.2.2.2.1.6 MinCompPressure Attribute 26
The MinCompPressure attribute specifies the minimum compensated pressure the 27
pump can achieve when it is running and working in control mode Proportional 28
pressure (ControlMode attribute of the Pump settings attribute set is set to 29
Proportional pressure). 30
31
This attribute is read only, and can only be set by the manufacturer. If the value is 32
not available, this attribute will display the invalid value. 33
Valid range is –3,276.7 kPa to 3,276.7 kPa (steps of 0.1 kPa) 34
The value -3,276.8 kPa (0x8000) indicates that this value is invalid. 35
36
6.2.2.2.1.7 MaxCompPressure Attribute 37
38
The MaxCompPressure attribute specifies the maximum compensated pressure 39
the pump can achieve when it is working in control mode Proportional pressure 40
(ControlMode attribute of the Pump settings attribute set is set to Proportional 41
pressure). 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 189

This attribute is read only, and can only be set by the manufacturer. If the value is
not available, this attribute will display the invalid value. 1
2
Valid range is –3,276.7 kPa to 3,276.7 kPa (steps of 0.1 kPa) 3
The value -3,276.8 kPa (0x8000) indicates that this value is invalid.. 4
5
6.2.2.2.1.8 MinConstSpeed Attribute 6
The MinConstSpeed attribute specifies the minimum speed the pump can achieve 7
when it is running and working in control mode Constant speed (ControlMode 8
attribute of the Pump settings attribute set is set to Constant speed). 9
10
This attribute is read only, and can only be set by the manufacturer. If the value is 11
not available, this attribute will display the invalid value. 12
Valid range is 0 to 65,534 RPM (steps of 1 RPM) 13
The value 65,535 RPM (0xffff) indicates that this value is invalid. 14
15
16
6.2.2.2.1.9 MaxConstSpeed Attribute
17
The MaxConstSpeed attribute specifies the maximum speed the pump can achieve 18
when it is working in control mode Constant speed (ControlMode attribute of the 19
Pump settings attribute set is set to Constant speed). 20
21
This attribute is read only, and can only be set by the manufacturer. If the value is 22
not available, this attribute will display the invalid value. 23
Valid range is 0 to 65,534 RPM (steps of 1 RPM) 24
The value 65,535 RPM (0xffff) indicates that this value is invalid. 25
26
6.2.2.2.1.10 MinConstFlow Attribute 27
28
The MinConstFlow attribute specifies the minimum flow the pump can achieve 29
when it is running and working in control mode Constant flow (ControlMode 30
attribute of the Pump settings attribute set is set to Constant flow). 31
This attribute is read only, and can only be set by the manufacturer. If the value is 32
not available, this attribute will display the invalid value. 33
34
Valid range is 0 m3/h to 6,553.4 m3/h (steps of 0.1 m3/h) 35
The value 6,553.5 m3/h (0xffff) indicates that this value is invalid. 36
37
6.2.2.2.1.11 MaxConstFlow Attribute 38
The MaxConstFlow attribute specifies the maximum flow the pump can achieve 39
when it is running and working in control mode Constant flow (ControlMode 40
attribute of the Pump settings attribute set is set to Constant flow). 41
42
This attribute is read only, and can only be set by the manufacturer. If the value is 43
not available, this attribute will display the invalid value. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
190 HVAC Specification

Valid range is 0 m3/h to 6,553.4 m3/h (steps of 0.1 m3/h).

The value 6,553.5 m3/h (0xffff) indicates that this value is invalid. 1
2
6.2.2.2.1.12 MinConstTemp Attribute 3
4
The MinConstTemp attribute specifies the minimum temperature the pump can 5
maintain in the system when it is running and working in control mode Constant 6
temperature (ControlMode attribute of the Pump settings attribute set is set to 7
Constant temperature). 8
This attribute is read only, and can only be set by the manufacturer. If the value is 9
not available, this attribute will display the invalid value. 10
11
Valid range is –273.15 C to 327.67 C (steps of 0.01 C). 12
The value -327.68 C (0x8000) indicates that this value is invalid. 13
14
6.2.2.2.1.13 MaxConstTemp Attribute 15
16
The MaxConstTemp attribute specifies the maximum temperature the pump can 17
maintain in the system when it is running and working in control mode Constant 18
temperature (ControlMode attribute of the Pump settings attribute set is set to 19
Constant temperature). 20
This attribute is read only, and can only be set by the manufacturer. If the value is 21
not available, this attribute will display the invalid value. MaxConstTemp shall be 22
greater than or equal to MinConstTemp 23
24
Valid range is –273.15 C to 327.67 C (steps of 0.01 C). 25
The value -327.68 C (0x8000) indicates that this value is invalid. 26
6.2.2.2.2 Pump Dynamic Information Attribute Set 27
28
The pump dynamic information attribute set contains the attributes summarized in 29
Table 6.4. 30
Table 6.4 Attributes of the Pump Dynamic Information Attribute Set 31
32
Mandatory
/ Optional

33
Identifier Name Type Range Access Default 34
35
36
0x0010 PumpStatus 16-bit Bitmap - Read - O 37
only 38
39
0x0011 EffectiveOperationMode 8-bit 0x00 – 0xfe Read - M
Enumeration only 40
41
0x0012 EffectiveControlMode 8-bit 0x00 – 0xfe Read - M 42
Enumeration only
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 191

Table 6.4 Attributes of the Pump Dynamic Information Attribute Set (Continued)
1

Mandatory
2

/ Optional
Identifier Name Type Range Access Default 3
4
5
0x0013 Capacity Signed 0x0000- Read - M 6
16-bit integer 0x7fff only 7
8
0x0014 Speed Unsigned 16- 0x0000 - Read - O
9
bit integer 0xfffe only
10
0x0015 LifetimeRunningHours Unsigned 24- 0x000000 - Read / 0 O 11
bit integer 0xfffffe Write 12
0x0016 Power Unsigned 24- 0x000000 - Read / - O 13
bit integer 0xfffffe Write 14
15
0x0017 LifetimeEnergyConsumed Unsigned 32- 0x00000000 Read 0 O
bit integer - 0xfffffffe only 16
17
18
6.2.2.2.2.1 PumpStatus Attribute
19
The PumpStatus attribute specifies the activity status of the pump functions listed 20
in Table 6.5. Where a pump controller function is active, the corresponding bit 21
shall be set to 1. Where a pump controller function is not active, the corresponding 22
bit shall be set to 0. 23
24
Table 6.5 Values of the PumpStatus Attribute
25
PumpStatus 26
Attribute Pump Function Remarks 27
Bit Number 28
29
0 Device fault A fault related to the pump device is detected
(Corresponds to a Alarm code in the range 6-13, see 30
Table 6.9) 31
32
1 Supply fault A fault related to the supply to the pump is detected 33
(Corresponds to a Alarm code in the range 0-5 or 13,
see Table 6.9) 34
35
2 Speed low Setpoint is too low to achieve 36
3 Speed high Setpoint is too high to achieve 37
38
4 Local override The pump is overridden by local control 39
5 Running Pump is currently running 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
192 HVAC Specification

Table 6.5 Values of the PumpStatus Attribute (Continued)

1
6 Remote Pressure A remote pressure sensor is used as the sensor for the 2
regulation of the pump. EffectiveControlMode is 3
Constant pressure, and the setpoint for the pump is
interpreted as a percentage of the range of the remote 4
sensor ([MinMeasuredValue – MaxMeasuredValue]) 5
6
7 Remote Flow A remote flow sensor is used as the sensor for the
7
regulation of the pump. EffectiveControlModeI is
Constant flow, and the setpoint for the pump is 8
interpreted as a percentage of the range of the remote 9
sensor ([MinMeasuredValue – MaxMeasuredValue]) 10
8 Remote A remote temperature sensor is used as the sensor for 11
Temperature the regulation of the pump. EffectiveControlModeI is 12
Constant temperature, and setpoint is interpreted as a 13
percentage of the range of the remote sensor 14
([MinMeasuredValue – MaxMeasuredValue]) 15
9 – 15 Reserved - 16
17
6.2.2.2.2.2 EffectiveOperationMode Attribute 18
19
The EffectiveOperationMode attribute specifies current effective operation mode 20
of the pump. The value of the EffectiveOperationMode attribute is the same as the 21
OperationMode attribute of the Pump settings attribute set, except when it is 22
overridden locally. See section 6.2.2.2.3.1 for a detailed description of the 23
operation and control of the pump. 24
25
This attribute is read only.
26
Valid range is defined by the operation modes listed in Table 6.1. 27
28
6.2.2.2.2.3 EffectiveControlMode Attribute 29
30
The EffectiveControlMode attribute specifies the current effective control mode of 31
the pump. 32
The EffectiveControlMode attribute contains the control mode that currently 33
applies to the pump. It will have the value of the ControlMode attribute, unless a 34
remote sensor is used as the sensor for regulation of the pump. In this case, 35
EffectiveControlMode will display Constant pressure, Constant flow or Constant 36
temperature if the remote sensor is a pressure sensor, a flow sensor or a 37
temperature sensor respectively, regardless of the value of the ControlMode 38
attribute. 39
40
See section 6.2.2.2.3.1 for detailed description of the operation and control of the 41
pump. This attribute is read only. 42
Valid range is defined by the control modes listed in Table 6.8. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 193

6.2.2.2.2.4 Capacity Attribute

1
The Capacity attribute specifies the actual capacity of the pump as a percentage of 2
the effective maximum setpoint value. It is updated dynamically as the speed of 3
the pump changes. 4
This attribute is read only. If the value is not available (the measurement or 5
estimation of the speed is done in the pump), this attribute will contain the invalid 6
value. 7
8
Valid range is 0 % to 163.835% (0.005 % granularity). Although the Capacity 9
attribute is a signed value, values of capacity less than zero have no physical 10
meaning. 11
The value -163.840 % (0x8000) indicates that this value is invalid. 12
13
6.2.2.2.2.5 Speed Attribute 14
15
The Speed attribute specifies the actual speed of the pump measured in RPM. It is
16
updated dynamically as the speed of the pump changes.
17
This attribute is read only. If the value is not available (the measurement or 18
estimation of the speed is done in the pump), this attribute will contain the invalid 19
value. 20
21
Valid range is 0 to 65.534 RPM
22
The value 65.535 RPM (0xffff) indicates that this value is invalid.
23
24
6.2.2.2.2.6 LifetimeRunningHours Attribute 25
The LifetimeRunningHours attribute specifies the accumulated number of hours, 26
that the pump has been powered and the motor has been running. It is updated 27
dynamically as it increases. It is preserved over power cycles of the pump. if 28
LifeTimeRunningHours rises above maximum value it “rolls over” and starts at 0 29
(zero). 30
31
This attribute is writeable, in order to allow setting to an appropriate value after 32
maintenance. If the value is not available, this attribute will contain the invalid 33
value. 34
Valid range is 0 to 16,777,214 hrs. 35
The value 16,777,215 (0xffffff) indicates that this value is unknown. 36
37
6.2.2.2.2.7 Power Attribute 38
39
The Power attribute specifies the actual power consumption of the pump in Watts. 40
The value of the Power attribute is updated dynamically as the power 41
consumption of the pump changes. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
194 HVAC Specification

This attribute is read only. If the value is not available (the measurement of power
consumption is not done in the pump), this attribute will display the invalid value. 1
2
Valid range is 0 to 16,777,214 Watts. 3
The value 16,777,215 (0xffffff) indicates that this value is unknown. 4
5
6.2.2.2.2.8 LifetimeEnergyConsumed Attribute 6
The LifetimeEnergyConsumed attribute specifies the accumulated energy 7
consumption of the pump through the entire lifetime of the pump in kWh. The 8
value of the LifetimeEnergyConsumed attribute is updated dynamically as the 9
energy consumption of the pump increases. If LifetimeEnergyConsumed rises 10
above maximum value it “rolls over” and starts at 0 (zero). 11
12
This attribute is writeable, in order to allow setting to an appropriate value after 13
maintenance. 14
Valid range is 0 kWh to 4,294,967,294 kWh. 15
The value 4,294,967,295 (0xffffffff) indicates that this value is unknown. 16
17
6.2.2.2.3 Pump Settings Attribute Set 18
19
The pump settings attribute set contains the attributes summarized in Table 6.6.
20
Table 6.6 Attributes of the Pump Settings Attribute Set 21
22
Mandatory 23
Identifier Name Type Range Access Default
/ Optional
24
0x0020 OperationMode 8-bit 0x00 – Read / 0x0 M 25
Enumeration 0xfe Write 26
0x0021 ControlMode 8-bit 0x00 – Read / 0x0 O 27
Enumeration 0xfe Write 28
29
0x0022 AlarmMask 16-bit bitmap - Read only - O
30
31
6.2.2.2.3.1 OperationMode Attribute 32
33
The OperationMode attribute specifies the operation mode of the pump. This
34
attribute shall have one of the values listed in Table 6.7.
35
The actual operating mode of the pump is a result of the setting of the attributes 36
OperationMode, ControlMode and the optional connection of a remote sensor. 37
The operation and control is prioritized as shown in the scheme in the figure 38
below: 39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 195

1
OperationMode
is Maximum, Minimum
Pump runs as defined by 2
YES OperationMode (Maximum,
or Local
?
Minimum or the Local setting) 3
4
5
NO 6
7
8
A remote sensor Pump runs in the control mode 9
is connected
?
YES as per the type of the remote
sensor
10
11
12
13
NO
14
15
16
Pump runs as defined by
ControlMode
17
18
19
20
Figure 6.3 Priority Scheme of Pump Operation and Control 21
22
If the OperationMode attribute is Maximum, Minimum or Local, the
23
OperationMode attribute decides how the pump is operated.
24
If the OperationMode attribute is Normal and a remote sensor is connected to the 25
pump, the type of the remote sensor decides the control mode of the pump. A 26
connected remote pressure sensor will make the pump run in control mode 27
Constant pressure and vice versa for flow and temperature type sensors. This is 28
regardless of the setting of the ControlMode attribute. 29
30
If the OperationMode attribute is Normal and no remote sensor is connected, the
31
control mode of the pump is decided by the ControlMode attribute.
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
196 HVAC Specification

OperationMode may be changed at any time, even when the pump is running. The
behavior of the pump at the point of changing the value of the OperationMode 1
attribute is vendor specific. 2
3
Table 6.7 Values of the OperationMode Attribute
4
OperationMode 5
Name Explanation 6
Attribute Value
7
0 Normal The pump is controlled by a setpoint, as defined by a 8
connected remote sensor or by the ControlMode 9
attribute. (N.B. The setpoint is an internal variable
which may be controlled between 0% and 100%, e.g. 10
by means of the Level Control cluster 3.10) 11
12
1 Minimum This value sets the pump to run at the minimum
13
possible speed it can without being stopped
14
2 Maximum This value sets the pump to run at its maximum 15
possible speed 16
3 Local This value sets the pump to run with the local settings 17
of the pump, regardless of what these are 18
19
4-254 Reserved Reserved for future use
20
21
6.2.2.2.3.2 ControlMode Attribute 22
The ControlMode attribute specifies the control mode of the pump. This attribute 23
shall have one of the values listed in Table 6.8. 24
25
See section 6.2.2.2.3.1 for detailed description of the operation and control of the 26
pump. 27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 197

ControlMode may be changed at any time, even when the pump is running. The
behavior of the pump at the point of changing is vendor specific. 1
2
Table 6.8 Values of the ControlMode Attribute
3
ControlMode 4
Attribute Name Explanation 5
Value 6
7
0 Constant speed The pump is running at a constant speed. The setpoint 8
is interpreted as a percentage of the MaxSpeed attribute
9
1 Constant pressure The pump will regulate its speed to maintain a constant 10
differential pressure over its flanges. The setpoint is 11
interpreted as a percentage of the range of the sensor
12
used for this control mode. In case of the internal
pressure sensor, this will be the range derived from the 13
[MinConstPressure - MaxConstPressure] attributes. In 14
case of a remote pressure sensor, this will be the range 15
derived from the [MinMeasuredValue – 16
MaxMeasuredValue] attributes of the remote pressure
17
sensor.
18
2 Proportional The pump will regulate its speed to maintain a constant 19
pressure differential pressure over its flanges. The setpoint is 20
interpreted as a percentage of the range derived of the
[MinCompPressure - MaxCompPressure] attributes. 21
The internal setpoint will be lowered (compensated) 22
dependant on the flow in the pump (lower flow => 23
lower internal setpoint) 24
3 Constant flow The pump will regulate its speed to maintain a constant 25
flow through the pump. The setpoint is interpreted as a 26
percentage of the range of the sensor used for this 27
control mode. In case of the internal flow sensor, this 28
will be the range derived from the [MinConstFlow - 29
MaxConstFlow] attributes. In case of a remote flow
sensor, this will be the range derived from the 30
[MinMeasuredValue – MaxMeasuredValue] attributes 31
of the remote flow sensor. 32
33
4 Reserved -
34
5 Constant The pump will regulate its speed to maintain a constant 35
temperature temperature. The setpoint is interpreted as a percentage 36
of the range of the sensor used for this control mode. In
case of the internal temperature sensor, this will be the 37
range derived from the [MinConstTemp - 38
MaxConstTemp] attributes. In case of a remote 39
temperature sensor, this will be the range derived from 40
the [MinMeasuredValue – MaxMeasuredValue] 41
attributes of the remote temperature sensor.
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
198 HVAC Specification

Table 6.8 Values of the ControlMode Attribute (Continued)

1
ControlMode 2
Attribute Name Explanation 3
Value 4
6 Reserved - 5
6
7 Automatic The operation of the pump is automatically optimized 7
to provide the most suitable performance with respect
to comfort and energy savings. This behavior is 8
manufacturer defined. The pump can be stopped by 9
setting the setpoint of the level control 10
cluster to 0 of by using the On/Off cluster. If the pump 11
is started (at any setpoint), the speed of the pump is 12
entirely determined by the pump. 13
14
8-254 Reserved -
15
16
6.2.2.2.3.3 AlarmMask Attribute 17
The AlarmMask attribute specifies whether each of the alarms listed in Table 6.9 18
is enabled. When the bit number corresponding to the alarm code is set to 1, the 19
alarm is enabled, else it is disabled. Bits not corresponding to a code in the table 20
(bits 14, 15) are reserved. 21
22
When the Alarms cluster is implemented on a device, and one of the alarm 23
conditions included in this table occurs, an alarm notification is generated, with 24
the alarm code field set as listed in the table. 25
Table 6.9 Alarm Codes 26
27
Alarm Code Alarm Condition 28
29
0 Supply voltage too low
30
1 Supply voltage too high 31
32
2 Power missing phase
33
3 System pressure too low 34
4 System pressure too high 35
36
5 Dry running 37
6 Motor temperature too high 38
39
7 Pump motor has fatal failure 40
8 Electronic temperature too high 41
42
9 Pump blocked
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 199

Table 6.9 Alarm Codes

1
Alarm Code Alarm Condition 2
3
10 Sensor failure
4
11 Electronic non fatal failure 5
6
12 Electronic fatal failure
7
13 General fault 8
9
6.2.2.3 Commands Received 10
11
None. 12
13
6.2.2.4 Commands Generated 14
None. 15
16
6.2.2.5 Attribute Reporting 17
18
This cluster shall support attribute reporting using the Report Attributes 19
command, according to the minimum and maximum reporting interval, reportable 20
change, and timeout period settings described in the ZCL Foundation 21
Specification (see 2.4.7). 22
23
The following attributes shall be reported:
24
PumpStatus 25
26
Capacity
27
28
6.2.3 Client 29
30
6.2.3.1 Dependencies 31
32
None 33
34
6.2.3.2 Attributes 35
The client supports no attributes. 36
37
6.2.3.3 Commands Received 38
39
The client receives no cluster specific commands. 40
41
6.2.3.4 Commands Generated 42
43
The client generates no cluster specific commands.
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
200 HVAC Specification

6.3 Thermostat Cluster 1

2
6.3.1 Overview 3
4
This cluster provides an interface to the functionality of a thermostat. 5
6
7
6.3.2 Server 8
9
6.3.2.1 Dependencies 10
11
For alarms to be generated by this cluster, the Alarms server cluster (see 3.11) 12
shall be included on the same endpoint. For remote temperature sensing, the 13
Temperature Measurement client cluster (see 4.4) may be included on the same 14
endpoint. For occupancy sensing, the Occupancy Sensing client cluster (see 4.8) 15
may be included on the same endpoint. 16
17
6.3.2.2 Attributes 18
For convenience, the attributes defined in this specification are arranged into sets 19
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 20
are encoded such that the most significant three nibbles specify the attribute set 21
and the least significant nibble specifies the attribute within the set. The currently 22
defined attribute sets for Thermostat are listed in Table 6.10. 23
24
Table 6.10 Currently Defined Thermostat Attribute Sets
25
Attribute Set 26
Description 27
Identifier
28
0x000 Thermostat Information 29
0x001 Thermostat Settings 30
31
0x002 – 0x3ff Reserved 32
0x400 – 0xfff Reserved for vendor specific attributes 33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 201

6.3.2.2.1 Thermostat Information Attribute Set

1
The Thermostat Information attribute set contains the attributes summarized in 2
Table 6.11. 3
Table 6.11 Attributes of the Thermostat Information Attribute Set 4
5

Mandatory
6

/ Optional
7
Identifier Name Type Range Access Default
8
9
10
0x0000 LocalTemperature Signed 16- 0x954d – Read - M
bit Integer 0x7fff 11
12
0x0001 OutdoorTemperature Signed 16- 0x954d – Read - O 13
bit Integer 0x7fff
14
0x0002 Ocupancy 8-bit bitmap 0000000x Read 00000000 O 15
16
0x0003 AbsMinHeatSetpointLimit Signed 16- 0x954d – Read 0x02bc O
bit Integer 0x7fff (7°C) 17
18
0x0004 AbsMaxHeatSetpointLimit Signed 16- 0x954d – Read 0x0bb8 O 19
bit Integer 0x7fff (30°C)
20
0x0005 AbsMinCoolSetpointLimit Signed 16- 0x954d – Read 0x0640 O 21
bit Integer 0x7fff (16°C) 22
0x0006 AbsMaxCoolSetpointLimit Signed 16- 0x954d – Read 0x0c80 O 23
bit Integer 0x7fff (32°C) 24
25
0x0007 PICoolingDemand Unsigned 8- 0x00 – Read - O
bit Integer 0x64
26
27
0x0008 PIHeatingDemand Unsigned 8- 0x00 – Read - O 28
bit Integer 0x64 29
30
6.3.2.2.1.1 LocalTemperature Attribute 31
32
LocalTemperature represents the temperature in degrees Celsius, as measured 33
locally or remotely (over the network) as follows:- 34
LocalTemperature = 100 x temperature in degrees Celsius. 35
36
Where -273.15°C <= temperature <= 327.67 ºC, corresponding to a 37
LocalTemperature in the range 0x954d to 0x7fff. 38
The maximum resolution this format allows is 0.01 ºC. 39
40
A LocalTemperature of 0x8000 indicates that the temperature measurement is 41
invalid. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
202 HVAC Specification

6.3.2.2.1.2 OutdoorTemperature Attribute

1
OutdoorTemperature represents the outdoor temperature in degrees Celsius, as 2
measured locally or remotely (over the network). It is measured as described for 3
LocalTemperature. 4
5
6.3.2.2.1.3 Occupancy Attribute 6
7
Occupancy specifies whether the heated/cooled space is occupied or not, as
8
measured locally or remotely (over the network). If bit 0 = 1, the space is
9
occupied, else it is unoccupied. All other bits are reserved.
10
11
6.3.2.2.1.4 AbsMinHeatSetpointLimit Attribute 12
The MinHeatSetpointLimit attribute specifies the absolute minimum level that the 13
heating setpoint may be set to. This is a limitation imposed by the manufacturer. 14
The value is calculated as described in the LocalTemperature attribute. 15
16
6.3.2.2.1.5 AbsMaxHeatSetpointLimit Attribute 17
18
The MaxHeatSetpointLimit attribute specifies the absolute maximum level that 19
the heating setpoint may be set to. This is a limitation imposed by the 20
manufacturer. The value is calculated as described in the LocalTemperature 21
attribute. 22
23
6.3.2.2.1.6 AbsMinCoolSetpointLimit Attribute 24
25
The MinCoolSetpointLimit attribute specifies the absolute minimum level that the
26
cooling setpoint may be set to. This is a limitation imposed by the manufacturer.
27
The value is calculated as described in the LocalTemperature attribute.
28
29
6.3.2.2.1.7 AbsMaxCoolSetpointLimit Attribute 30
The MaxCoolSetpointLimit attribute specifies the absolute maximum level that 31
the cooling setpoint may be set to. This is a limitation imposed by the 32
manufacturer. The value is calculated as described in the LocalTemperature 33
attribute. 34
35
6.3.2.2.1.8 PICoolingDemand Attribute 36
37
The PICoolingDemand attribute is 8-bits in length and specifies the level of 38
cooling demanded by the PI (proportional integral) control loop in use by the 39
thermostat (if any), in percent. This value is 0 when the thermostat is in “off” or 40
“heating” mode. 41
This attribute is reported regularly and may be used to control a heating device. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 203

6.3.2.2.1.9 PIHeatingDemand Attribute

1
The PIHeatingDemand attribute is 8-bits in length and specifies the level of 2
heating demanded by the PI loop in percent. This value is 0 when the thermostat is 3
in “off” or “cooling” mode. 4
This attribute is reported regularly and may be used to control a cooling device. 5
6
6.3.2.2.2 Thermostat Settings Attribute Set 7
The Thermostat settings attribute set contains the attributes summarized in 8
Table 6.12. 9
10
Table 6.12 Attributes of the Thermostat Settings Attribute Set 11
12

Mandatory
/ Optional
13
Identifier Name Type Range Access Default 14
15
16
0x0010 LocalTemperature Signed 8-bit 0xE7 – 0x19 Read / 0x00 O 17
Calibration Integer Write (0°C) 18
0x0011 OccupiedCooling Signed 16- MinCoolSetpoint Read / 0x0a28 M 19
Setpoint bit Integer Limit – Write (26°C) 20
MaxCoolSetpoint 21
Limit 22
0x0012 OccupiedHeating Signed 16- MinHeatSetpoint Read / 0x07d0 M 23
Setpoint bit Integer Limit – Write (20°C) 24
MaxHeatSetpoint 25
Limit 26
0x0013 UnoccupiedCooling Signed 16- MinCoolSetpoint Read / 0x0a28 O 27
Setpoint bit Integer Limit – Write (26°C) 28
MaxCoolSetpoint 29
Limit 30
0x0014 UnoccupiedHeating Signed 16- MinHeatSetpoint Read / 0x07d0 O 31
Setpoint bit Integer Limit – Write (20°C) 32
MaxHeatSetpoint 33
Limit 34
0x0015 MinHeatSetpoint Signed 16- 0x954d – 0x7fff Read / 0x02bc O 35
Limit bit Integer Write (7°C) 36
0x0016 MaxHeatSetpoint Signed 16- 0x954d – 0x7fff Read / 0x0bb8 O
37
Limit bit Integer Write (30°C) 38
39
0x0017 MinCoolSetpoint Signed 16- 0x954d – 0x7fff Read / 0x02bc O 40
Limit bit Integer Write (7°C)
41
0x0018 MaxCoolSetpoint Signed 16- 0x954d – 0x7fff Read / 0x0bb8 O 42
Limit bit Integer Write (30°C) 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
204 HVAC Specification

Table 6.12 Attributes of the Thermostat Settings Attribute Set (Continued)

1

Mandatory
2

/ Optional
3
Identifier Name Type Range Access Default
4
5
6
0x0019 MinSetpointDead Signed 8-bit 0x0a – 0x19 Read / 0x19 O
Band Integer Write (2.5°C) 7
8
0x001a RemoteSensing 8-bit Bitmap 00000xxx Read / 0 O 9
Write
10
0x001b ControlSequenceOf 8-bit 0x00 – 0x05 Read / 0x04 M 11
Operation Enumeration Write 12
0x001c SystemMode 8-bit 0x00 – 0x02 Read / 0x02 M 13
Enumeration Write 14
15
0x001d AlarmMask 8-bit bitmap 00000xxx Read only 0 O
16
17
6.3.2.2.2.1 LocalTemperatureCalibration Attribute 18
19
The LocalTemperatureCalibration attribute specifies the offset that can be added/
20
subtracted to the actual displayed room temperature, in steps of 0.1°C. The range
21
of this offset is –2.5 °C to +2.5 °C).
22
23
6.3.2.2.2.2 OccupiedCoolingSetpoint Attribute
24
The OccupiedCoolingSetpoint attribute is 16-bits in length and specifies the 25
cooling mode setpoint when the room is occupied. It shall be set to a value in the 26
range defined by the MinCoolSetpointLimit and MaxCoolSetpointLimit 27
attributes. The value is calculated as described in the LocalTemperature attribute. 28
29
The OccupiedHeatingSetpoint attribute shall always be below the value specified 30
in the OccupiedCoolingSetpoint by at least SetpointDeadband. If an attempt is 31
made to set it such that this condition is violated, a default response command 32
with the status code INVALID_VALUE (see 2.5.3) shall be returned. This shall 33
apply to all attempts to set values of attributes which violate similar conditions. 34
If it is unknown if the room is occupied or not, this attribute shall be used as the 35
cooling mode setpoint. 36
37
6.3.2.2.2.3 OccupiedHeatingSetpoint Attribute 38
39
The OccupiedHeatingSetpoint attribute is 16-bits in length and specifies the 40
heating mode setpoint when the room is occupied. It shall be set to a value in the 41
range defined by the MinHeatSetpointLimit and MaxHeatSetpointLimit attributes. 42
The value is calculated as described in the LocalTemperature attribute. The 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 205

OccupiedCoolingSetpoint attribute shall always be above the value specified in

the OccupiedHeatingSetpoint by at least SetpointDeadband. 1
2
If it is unknown if the room is occupied or not, this attribute shall be used as the 3
cooling mode setpoint. 4
5
6.3.2.2.2.4 UnoccupiedCoolingSetpoint Attribute 6
The UnoccupiedCoolingSetpoint attribute is 16-bits in length and specifies the 7
cooling mode setpoint when the room is unoccupied. It shall be set to a value in 8
the range defined by the MinCoolSetpointLimit and MaxCoolSetpointLimit 9
attributes. The value is calculated as described in the LocalTemperature attribute. 10
The UnoccupiedHeatingSetpoint attribute shall always be below the value 11
specified in the UnoccupiedCoolingSetpoint by at least SetpointDeadband. 12
13
If it is unknown if the room is occupied or not, this attribute shall not be used. 14
15
6.3.2.2.2.5 UnoccupiedHeatingSetpoint Attribute 16
17
The UnoccupiedHeatingSetpoint attribute is 16-bits in length and specifies the 18
heating mode setpoint when the room is unoccupied. It shall be set to a value in 19
the range defined by the MinHeatSetpointLimit and MaxHeatSetpointLimit 20
attributes. The value is calculated as described in the LocalTemperature attribute. 21
The UnoccupiedCoolingSetpoint attribute shall always be below the value 22
specified in the UnoccupiedHeatingSetpoint by at least SetpointDeadband. 23
If it is unknown if the room is occupied or not, this attribute shall not be used. 24
25
6.3.2.2.2.6 MinHeatSetpointLimit Attribute 26
27
The MinHeatSetpointLimit attribute specifies the minimum level that the heating 28
setpoint may be set to. The value is calculated as described in the 29
LocalTemperature attribute. It must be greater than or equal to 30
AbsMinHeatSetpointLimit. If this attribute is not present, it shall be taken as equal 31
to AbsMinHeatSetpointLimit. 32
This attribute, and the following three attributes, allow the user to define setpoint 33
limits more constrictive than the manufacturer imposed ones. Limiting users 34
(e.g.in a commercial building) to such setpoint limits can help conserve power. 35
36
6.3.2.2.2.7 MaxHeatSetpointLimit Attribute 37
38
The MaxHeatSetpointLimit attribute specifies the maximum level that the heating 39
setpoint may be set to. The value is calculated as described in the 40
LocalTemperature attribute. It must be less than or equal to 41
AbsMaxHeatSetpointLimit. If this attribute is not present, it shall be taken as equal 42
to AbsMaxHeatSetpointLimit. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
206 HVAC Specification

6.3.2.2.2.8 MinCoolSetpointLimit Attribute

1
The MinCoolSetpointLimit attribute specifies the minimum level that the cooling 2
setpoint may be set to. The value is calculated as described in the 3
LocalTemperature attribute. It must be greater than or equal to 4
AbsMinCoolSetpointLimit. If this attribute is not present, it shall be taken as equal 5
to AbsMinCoolSetpointLimit. 6
7
6.3.2.2.2.9 MaxCoolSetpointLimit Attribute 8
9
The MaxCoolSetpointLimit attribute specifies the maximum level that the cooling
10
setpoint may be set to. The value is calculated as described in the
11
LocalTemperature attribute. It must be less than or equal to
12
AbsMaxCoolSetpointLimit. If this attribute is not present, it shall be taken as equal
13
to AbsMaxCoolSetpointLimit.
14
15
6.3.2.2.2.10 MinSetpointDeadBand Attribute 16
The MinSetpointDeadBand attribute specifies the minimum difference between 17
the Heat Setpoint and the Cool SetPoint, in steps of 0.1°C. Its range is 0x0a to 18
0x19 (1°C to 2.5°C). 19
20
6.3.2.2.2.11 RemoteSensing Attribute 21
22
The RemoteSensing attribute is an 8-bit bitmap that specifies whether the local 23
temperature, outdoor temperature and occupancy are being sensed by internal 24
sensors or remote networked sensors. The meanings of individual bits are detailed 25
in Table 6.13. 26
Table 6.13 RemoteSensing Attribute Bit Values 27
28
Bit Number Description 29
30
0 0 – local temperature sensed internally
1 – local temperature sensed remotely
31
32
1 0 – outdoor temperature sensed internally 33
1 – outdoor temperature sensed remotely 34
2 0 – occupancy sensed internally 35
1 – occupancy sensed remotely 36
3-7 Reserved
37
38
39
6.3.2.2.2.12 ControlSequenceOfOperation Attribute 40
The ControlSequenceOfOperation attribute specifies the overall operating 41
environment of the thermostat, and thus the possible system modes that the 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 207

thermostat can operate in. It shall be set to one of the non-reserved values in
Table 6.14. (Note - it is not mandatory to support all values). 1
2
Table 6.14 ControlSequenceOfOperation Attribute Values
3
ControlSequenceOfOperation Possible Values of 4
Description 5
Attribute Value SystemMode
6
0x00 Cooling Only Heat and Emergency are not 7
possible 8
0x01 Cooling With Reheat Heat and Emergency are not 9
possible 10
0x02 Heating Only Cool and precooling (see 11
1.3.2) are not possible 12
13
0x03 Heating With Reheat Cool and precooling are not 14
possible
15
0x04 Cooling and Heating All modes are possible 16
4-pipes (see 1.3.2) 17
0x05 Cooling and Heating All modes are possible 18
4-pipes with Reheat 19
20
0x06 – 0xfe Reserved -
21
22
6.3.2.2.3 SystemMode Attribute 23
The SystemMode attribute specifies the current operating mode of the thermostat,. 24
It shall be set to one of the non-reserved values in Table 6.15, as limited by 25
Table 6.16. (Note - it is not mandatory to support all values). 26
27
Table 6.15 SystemMode Attribute Values
28
29
SystemMode
Attribute Value Description 30
31
0x00 Off 32
0x01 Auto 33
34
0x03 Cool 35
0x04 Heat 36
37
0x05 Emergency heating
38
0x06 Precooling (see 1.3.2) 39
40
0x07 Fan only
41
0x08 – 0xfe Reserved 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
208 HVAC Specification

The interpretation of the Heat, Cool and Auto values of SystemMode is shown in
Table 6.16. 1
2
Table 6.16 Interpretation of SystemMode Values
3
Temperature 4
SystemMode 5
Temperature Below Between Temperature Above
Attribute 6
Heat Setpoint Heat Setpoint and Cool Setpoint
Values
Cool Setpoint 7
8
Heat Temperature below Temperature on target Temperature on target
target 9
10
Cool Temperature on target Temperature on target Temperature above 11
target
12
Auto Temperature below Temperature on target Temperature above 13
target target 14
15
6.3.2.2.4 AlarmMask Attribute 16
17
The AlarmMask attribute specifies whether each of the alarms listed in Table 6.17 18
is enabled. When the bit number corresponding to the alarm code is set to 1, the 19
alarm is enabled, else it is disabled. Bits not corresponding to a code in the table 20
are reserved. 21
When the Alarms cluster is implemented on a device, and one of the alarm 22
conditions included in this table occurs, an alarm notification is generated, with 23
the alarm code field set as listed in the table. 24
25
Table 6.17 Alarm Codes
26
Alarm Code Alarm Condition 27
28
0 Initialization failure. The device failed to 29
complete initialization at power-up. 30
1 Hardware failure 31
32
2 Self-calibration failure 33
34
6.3.2.3 Commands Received 35
36
The command IDs for the Thermostat cluster are listed in Table 6.18. 37
Table 6.18 Command IDs for the Thermostat Cluster 38
39
Command Identifier 40
Field Value Description
41
0x00 Setpoint Raise/Lower 42
43
0x01 – 0xff Reserved 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 209

6.3.2.3.1 Setpoint Raise/Lower Command

1
6.3.2.3.1.1 Payload Format 2
3
The Setpoint Raise/Lower command payload shall be formatted as illustrated in 4
Figure 6.4. 5
6
Bits 8 8 7
8
Data Type 8-bit Enumeration Signed 8-bit Integer
9
Field Name Mode Amount 10
11
12
Figure 6.4 Format of the Setpoint Raise/Lower Command Payload 13
14
6.3.2.3.1.2 Mode Field 15
The mode field shall be set to one of the non-reserved values in Table 6.19. It 16
specifies which setpoint is to be configured. If it is set to auto, then both setpoints 17
shall be adjusted. 18
19
Table 6.19 Mode field Values for the Setpoint Raise/Lower Command
20
Mode Field Value Description 21
22
0x00 Heat (adjust Heat Setpoint) 23
24
0x01 Cool (adjust Cool Setpoint)
25
0x02 Both (adjust Heat Setpoint and Cool Setpoint) 26
0x03 – 0xff Reserved 27
28
29
6.3.2.3.1.3 Amount Field 30
The amount field is a signed 8-bit integer that specifies the amount the setpoint(s) 31
are to be a increased (or decreased) by, in steps of 0.1°C. 32
33
6.3.2.3.2 Effect on Receipt 34
The attributes for the indicated setpoint(s) shall be increased by the amount 35
specified in the Amount field. 36
37
6.3.2.4 Commands Generated 38
39
No commands are generated by the server cluster. 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
210 HVAC Specification

6.3.2.5 Attribute Reporting

1
This cluster shall support attribute reporting using the Report Attributes command 2
and according to the minimum and maximum reporting interval and reportable 3
change settings described in the ZCL Foundation specification (see 2.4.7) and 4
whenever they change. The following attributes shall be reported: 5
6
• LocalTemperature
7
• PICoolingDemand 8
9
• PIHeatingDemand
10
Other attributes may optionally be reported. 11
12
13
6.3.3 Client 14
15
6.3.3.1 Dependencies 16
None. 17
18
6.3.3.2 Attributes 19
20
The Client cluster has no attributes. 21
22
6.3.3.3 Commands Received 23
The client receives no cluster specific commands. 24
25
6.3.3.4 Commands Generated 26
27
The client cluster generates the commands received by the server cluster, i.e. those 28
detailed in 7.2.5, as required by the application. 29
30
31
6.4 Fan Control 32
33
34
6.4.1 Overview 35
36
This cluster specifies an interface to control the speed of a fan as part of a heating 37
/ cooling system. 38
39
6.4.2 Server 40
41
6.4.2.1 Dependencies 42
43
None. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 211

6.4.2.2 Attributes
1
The Fan Control Status attribute set contains the attributes summarized in 2
Table 6.20. 3
Table 6.20 Attributes of the Fan Control Cluster 4
5
6

Mandatory
/ Optional
7
Identifier Name Type Range Access Default 8
9
10
0x0000 FanMode 8-bit Enumeration 0x00 – 0x06 Read/ 0x05 M 11
Write (auto)
12
0x0001 FanModeSequence 8-bit Enumeration 0x00 – 0x04 Read/ 0x02 M 13
Write 14
15
6.4.2.2.1 FanMode Attribute 16
17
The FanMode attribute is an 8-bit value that specifies the current speed of the fan. 18
It shall be set to one of the non-reserved values in Table 6.21. 19
Table 6.21 FanMode Attribute Values 20
21
FanMode Attribute Value Description 22
0x00 Off 23
24
0x01 Low 25
0x02 Medium 26
27
0x03 High 28
0x04 On 29
30
0x05 Auto (the fan speed is self-regulated)
31
0x06 Smart (when the heated/cooled space is occupied, 32
the fan is always on) 33
0x07– 0xfe Reserved 34
35
36
Note that for Smart mode, information must be available as to whether the heated/ 37
cooled space is occupied. This may be accomplished by use of the Occupancy 38
Sensing cluster (see 4.8). 39
6.4.2.2.2 FanModeSequence Attribute 40
41
The FanModeSequence attribute is an 8-bit value that specifies the possible fan 42
speeds that the thermostat can set. It shall be set to one of the non-reserved values 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
212 HVAC Specification

in Table 6.22. (Note:-. 'Smart' is not in this table, as this mode resolves to one of
the other modes depending on occupancy). 1
2
Table 6.22 FanSequenceOperation Attribute Values
3
FanSequenceOfOperation 4
Description 5
Attribute Value
6
0x00 Low/Med/High 7
0x01 Low/High 8
9
0x02 Low/Med/High/Auto 10
0x03 Low/High/Auto 11
12
0x04 On/Auto
13
0x05 – 0xfe Reserved 14
15
6.4.2.3 Commands Received 16
17
No cluster specific commands are received by the server. 18
19
6.4.2.4 Commands Generated 20
21
No cluster specific commands are generated by the server. 22
23
6.4.3 Client 24
25
6.4.3.1 Dependencies 26
27
None. 28
29
6.4.3.2 Attributes 30
31
The Client cluster has no attributes.
32
6.4.3.3 Commands Received 33
34
No cluster specific commands are received by the server. 35
36
6.4.3.4 Commands Generated 37
38
No cluster specific commands are generated by the server. 39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 213

6.5 Dehumidification Control 1

2
6.5.1 Overview 3
4
This cluster provides an interface to dehumidification functionality. 5
6
7
6.5.2 Server 8
9
6.5.2.1 Dependencies 10
11
None. 12
13
6.5.2.2 Attributes 14
For convenience, the attributes defined in this specification are arranged into sets 15
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 16
are encoded such that the most significant nibble specifies the attribute set and the 17
least significant nibble specifies the attribute within the set. The currently defined 18
attribute set for the dehumidification control cluster is listed in Table 6.23. 19
20
Table 6.23 Dehumidification Control Attribute Sets
21
Attribute Set 22
Description 23
Identifier
24
0x000 Dehumidification Information 25
0x001 Dehumidification Settings 26
27
0x002 – 0xfff Reserved 28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
214 HVAC Specification

6.5.2.2.1 Dehumidification Information Attribute Set

1
The Dehumidification Information attribute set contains the attributes 2
summarized in Table 6.24. 3
Table 6.24 Attributes of the Dehumidification Information Attribute Set 4
5

Mandatory
6

/ Optional
7
Identifier Name Type Range Access Default
8
9
10
0x0000 RelativeHumidity Unsigned 0x00 – 0x64 Read - O
8-bit only 11
Integer 12
13
0x0001 DehumidificationCooling Unsigned 0- Read - M
14
8-bit Dehumidification only
Integer MaxCool 15
16
17
6.5.2.2.1.1 RelativeHumidity Attribute 18
The RelativeHumidity attribute is an 8-bit value that represents the current relative 19
humidity (in %) measured by a local or remote sensor. The valid range ix 0x00 – 20
0x64 (0% to 100%). 21
22
6.5.2.2.1.2 DehumidificationCooling Attribute 23
24
The DehumidificationCooling attribute is an 8-bit value that specifies the current 25
dehumidification cooling output (in %). The valid range is 0 to 26
DehumidificationMaxCool. 27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 215

6.5.2.2.2 Dehumidification Settings Attribute Set

1
The Dehumidification Settings attribute set contains the attributes summarized in 2
Table 6.25. 3
Table 6.25 Attributes of the Dehumidification Settings Attribute Set 4
5

Mandatory
6

/ Optional
7
Identifier Name Type Range Access Default
8
9
10
0x0010 RHDehumidificationSetpoint Unsigned 0x1E – Read/ 0x32 M
8-bit Integer 0x64 Write 11
12
0x0011 RelativeHumidityMode 8-bit 0x00 – Read/ 0x00 O 13
Enumeration 0x01 Write
14
0x0012 DehumidificationLockout 8-bit 0x00 – Read/ 0x01 O 15
Enumeration 0x01 Write 16
0x0013 DehumidificationHysteresis Unsigned 0x02 – Read/ 0x02 M 17
8-bit Integer 0x14 Write 18
19
0x0014 DehumidificationMaxCool Unsigned 0x14 – Read/ 0x14 M
20
8-bit Integer 0x64 Write
21
0x0015 RelativeHumidityDisplay 8-bit 0x00 – Read/ 0x00 O 22
Enumeration 0x01 Write 23
24
6.5.2.2.2.1 RHDehumidificationSetpoint Attribute 25
26
The RHDehumidificationSetpoint attribute is an 8-bit value that represents the 27
relative humidity (in %) at which dehumidification occurs. The valid range ix 28
0x1E – 0x64 (30% to 100%). 29
30
6.5.2.2.2.2 RelativeHumidityMode Attribute 31
The RelativeHumidityMode attribute is an 8-bit value that specifies how the 32
RelativeHumidity value is being updated. It shall be set to one of the non-reserved 33
values in Table 6.26. 34
35
Table 6.26 RelativeHumidityMode Attribute Values 36
37
RelativeHumidityMode
Attribute Value Description 38
39
0x00 RelativeHumidity measured locally 40
0x01 RelativeHumidity updated over the 41
network 42
43
0x02 – 0xff Reserved
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
216 HVAC Specification

6.5.2.2.2.3 DehumidificationLockout Attribute

1
The DehumidificationLockout attribute is an 8-bit value that specifies whether 2
dehumidification is allowed or not. It shall be set to one of the non-reserved 3
values in Table 6.27. 4
Table 6.27 DehumidificationLockout Attribute Values 5
6
Dehumidification Description 7
Attribute Value 8
0x00 Dehumidification is not allowed.
9
10
0x01 Dehumidification is allowed. 11
0x02 – 0xff Reserved 12
13
14
6.5.2.2.2.4 DehumidificationHysteresis Attribute 15
The DehumidificationHysteresis attribute is an 8-bit value that specifies the 16
hysteresis (in %) associated with RelativeHumidity value. The valid range ix 0x02 17
– 0x14 (2% to 20%). 18
19
6.5.2.2.2.5 DehumidificationMaxCool Attribute 20
21
The DehumidificationMaxCool attribute is an 8-bit value that specifies the 22
maximum dehumidification cooling output (in %). The valid range ix 0x14 – 0x64 23
(20% to 100%). 24
25
6.5.2.2.2.6 RelativeHumidityDisplay Attribute 26
27
The RelativeHumidityDisplay attribute is an 8-bit value that specifies whether the
28
RelativeHumidity value is displayed to the user or not. It shall be set to one of the
29
non-reserved values in Table 6.28.
30
Table 6.28 RelativeHumidityMode Attribute Values 31
32
RelativeHumidityMode 33
Description
Attribute Value
34
0x00 RelativeHumidity is not displayed 35
36
0x01 RelativeHumidity is displayed
37
0x02 – 0xff Reserved 38
39
6.5.2.3 Commands Received 40
41
No commands are received by the server cluster except those to read / write 42
attributes 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 217

6.5.2.4 Commands Generated

1
No commands are generated by the server cluster except responses to commands 2
to read/write attributes, and attribute reports. 3
4
6.5.2.5 Attribute Reporting 5
6
This cluster shall support attribute reporting using the Report Attributes command 7
and according to the minimum and maximum reporting interval settings described 8
in the ZCL Foundation specification (see 2.4.7). 9
The following attribute shall be reported: DehumidificationCooling 10
11
This attribute shall also be reported whenever it changes (a minimum change is 12
1%). 13
Reports of this attribute may be used to control a remote dehumidifier device. 14
15
16
6.5.3 Client 17
18
6.5.3.1 Dependencies 19
None 20
21
6.5.3.2 Attributes 22
23
The client cluster has no attributes. 24
25
6.5.3.3 Commands Received 26
27
No commands are received by the server cluster except responses to commands to
28
read/write attributes, and attribute reports.
29
6.5.3.4 Commands Generated 30
31
No commands are generated by the server cluster except those to read / write 32
attributes, as required by the application 33
34
35
6.6 Thermostat User Interface Configuration Cluster 36
37
38
6.6.1 Overview 39
40
This cluster provides an interface to allow configuration of the user interface for a 41
thermostat, or a thermostat controller device, that supports a keypad and LCD 42
screen. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
218 HVAC Specification

6.6.2 Server 1
2
6.6.2.1 Dependencies 3
None. 4
5
6.6.2.2 Attributes 6
7
The attributes of this cluster are summarized in Table 6.29. 8
Table 6.29 Attributes of the Thermostat User Interface Configuration Cluster 9
10

Mandatory
11

/ Optional
Identifier Name Type Range Access Default 12
13
14
0x0000 TemperatureDisplayMode 8-bit 0x00 – Read/ 0x00 M 15
Enumeration 0x01 Write (Celsius) 16
17
0x0001 KeypadLockout 8-bit 0x00 – Read/ 0x00 M
18
Enumeration 0x05 Write (no lockout)
19
20
6.6.2.2.1 TemperatureDisplayMode Attribute 21
The TemperatureDisplayMode attribute specifies the units of the temperature 22
displayed on the thermostat screen. This attribute shall be set to one of the non- 23
reserved values in Table 6.30. 24
25
Table 6.30 DisplayMode Attribute Values 26
27
TemperatureDisplayMode
Description 28
Attribute Value
29
0x00 Temperature in oC 30
0x01 Temperature in oF 31
32
0x02 – 0xff Reserved 33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 219

6.6.2.2.2 KeypadLockout Attribute

1
The KeypadLockout attribute specifies the level of functionality that is available 2
to the user via the keypad. This attribute shall be set to one of the non-reserved 3
values Table 6.31. 4
Table 6.31 KeypadLockout Attribute Values 5
6
KeypadLockout Description 7
Attribute Value 8
0x00 No lockout
9
10
0x01 Level 1 lockout 11
0x02 Level 2 lockout 12
13
0x03 Level 3 lockout 14
0x04 Level 4 lockout 15
16
0x05 Level 5 lockout (least functionality
17
available to the user)
18
0x06– 0xff Reserved 19
20
The interpretation of the various levels is device dependent. 21
22
6.6.2.3 Commands Received 23
24
No commands are received by the server except those to read and write the 25
attributes of the server. 26
27
6.6.2.4 Commands Generated 28
No commands are generated by the server except responses to commands to read 29
and write the attributes of the server. 30
31
32
6.6.3 Client 33
34
6.6.3.1 Dependencies 35
36
None. 37
38
6.6.3.2 Attributes 39
The Client cluster has no attributes. 40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 6
220 HVAC Specification

6.6.3.3 Commands Received

1
No commands are received by the server except responses to commands to read 2
and write the attributes of the server. 3
4
6.6.3.4 Commands Generated 5
6
No commands are generated by the client except those to read and write the 7
attributes of the server, as required by the application. 8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 221

C H A P T E R
1

7
2
3
4
5
6
7
8
9

CHAPTER 7CLOSURES SPECIFICATION 10

11
12
13
7.1 General Description 14
15
16
7.1.1 Introduction 17
18
The clusters specified in this document are for use typically in ZigBee 19
applications involving closures (e.g. shades, windows doors), but may be used in 20
any application domain. 21
22
23
7.1.2 Cluster List 24
25
This section lists the clusters specified in this document, and gives examples of 26
typical usage for the purpose of clarification. 27
The clusters defined in this document are listed in Table 7.1. 28
29
Table 7.1 Clusters Specified in the Closures Functional Domain
30
Cluster Name Description 31
32
Shade Configuration Attributes and commands for configuring a shade 33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 7
222 Closures Specification

1
Configuration tool Shade 2
3
Shade configuration
4
C S 5
6
7
8
C = Client S = Server 9
10
Note:- Device names are examples for illustration only 11
12
Figure 7.1 Typical Usage of the Closures Clusters 13
14
15
7.2 Shade Configuration Cluster 16
17
18
7.2.1 Overview 19
20
This cluster provides an interface for reading information about a shade, and 21
configuring its open and closed limits. 22
23
7.2.2 Server 24
25
7.2.2.1 Dependencies 26
27
None 28
29
7.2.2.2 Attributes 30
31
For convenience, the attributes defined in this specification are arranged into sets
32
of related attributes; each set can contain up to 16 attributes. Attribute identifiers
33
are encoded such that the most significant three nibbles specify the attribute set
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 223

and the least significant nibble specifies the attribute within the set. The currently
defined attribute sets are listed in Table 7.2. 1
2
Table 7.2 Shade Configuration Attribute Sets
3
Attribute Set 4
Description 5
Identifier
6
0x000 Shade information 7
0x001 Shade settings 8
9
0x002 – 0xfff Reserved 10
11
7.2.2.2.1 Shade Information Attribute Set 12
13
The Shade Information attribute set contains the attributes summarized in
14
Table 7.3.
15
Table 7.3 Attributes of the Shade Information Attribute Set 16
17

Mandatory
/ Optional
18
Identifier Name Type Range Access Default 19
20
21
0x0000 PhysicalClosedLimit Unsigned 0x0001 – Read - O 22
16-bit integer 0xfffe only 23
24
0x0001 MotorStepSize Unsigned 0x00 – Read - O
8-bit integer 0xfe only 25
26
0x0002 Status 8-bit Bitmap 0000 Read / 0000 0000 M 27
xxxx write
28
29
7.2.2.2.1.1 PhysicalClosedLimit Attribute 30
31
The PhysicalClosedLimit attribute indicates the most closed (numerically lowest)
32
position that the shade can physically move to. This position is measured in terms
33
of steps of the motor, taking the physical most open position of the shade as zero.
34
This attribute is for installation informational purposes only. 35
36
The value 0xffff indicates an invalid or unknown PhysicalClosedLimit .
37
38
7.2.2.2.1.2 MotorStepSize Attribute 39
The MotorStepSize attribute indicates the angle the shade motor moves for one 40
step, measured in 1/10ths of a degree. 41
42
This attribute is for installation informational purposes only. 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 7
224 Closures Specification

The value 0xff indicates an invalid or unknown step size.

1
7.2.2.2.1.3 Status Attribute 2
3
The Status attribute indicates the status of a number of shade functions, as shown 4
in Table 7.4 Writing a value to this attribute only affects those bits with Read / 5
Write access. 6
Table 7.4 Bit Values for the Status Attribute 7
8
Status Attribute 9
Meaning Access
Bit Number 10
11
0 Shade operational Read only
0 = no 1 = yes 12
13
1 Shade adjusting Read only 14
0 = no 1 = yes
15
2 Shade direction Read only 16
0 = closing 1 = opening 17
3 Direction corresponding to Read / write 18
forward direction of motor 19
0 = closing 1 = opening 20
21
4–7 Reserved -
22
23
7.2.2.2.2 Shade Settings Attribute Set 24
The Shade Settings attribute set contains the attributes summarized in Table 7.5. 25
26
Table 7.5 Attributes of the Shade Settings Attribute Set 27
28
Mandatory
Identifier Name Type Range Access Default / Optional 29
30
0x0010 ClosedLimit Unsigned 0x0001 – Read/write 0x0001 M 31
16-bit integer 0xfffe 32
0x0011 Mode 8-bit 0x00 – Read/write 0x00 M 33
Enumeration 0xfe 34
35
7.2.2.2.2.1 ClosedLimit Attribute 36
37
The ClosedLimit attribute indicates the most closed position that the shade can 38
move to. This position is measured in terms of steps of the motor, taking the 39
physical most open position of the shade as zero. This attribute is set either by 40
directly writing it, or by the following method. 41
When the Mode attribute is set to Configure, the shade is opening, and either the 42
shade is stopped or it reaches its physical most open limit (if there is one – the 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 225

motor may continue to turn at the top), the zero point for the motor-step
measurement system is set to the current position of the shade. 1
2
When the Mode attribute is set to Configure, the shade is closing, and either the 3
shade is stopped or it reaches its physical closed limit, the ClosedLimit attribute is 4
set to the current position of the shade, relative to the zero point set as described 5
above. 6
7
7.2.2.2.2.2 Mode Attribute 8
The Mode attribute indicates the current operating mode of the shade, as shown in 9
Table 7.6. 10
11
The value 0xff indicates an invalid or unknown mode. 12
Table 7.6 Values of the Mode Attribute 13
14
Mode Attribute Value Meaning 15
16
0x00 Normal 17
0x01 Configure 18
19
0x02 – 0xfe Reserved
20
21
In configure mode, the ClosedLimit attribute may be set as described above. 22
23
7.2.2.3 Commands Received 24
No cluster specific commands are received by the server. 25
26
7.2.2.4 Commands Generated 27
28
No cluster specific commands are generated by the server. 29
30
31
7.2.3 Client 32
33
7.2.3.1 Dependencies 34
None 35
36
7.2.3.2 Attributes 37
38
The client has no attributes. 39
40
7.2.3.3 Commands Received 41
No cluster specific commands are received by the client. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 7
226 Closures Specification

7.2.3.4 Commands Generated

1
No cluster specific commands are generated by the client. 2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 227

C H A P T E R
1

8
2
3
4
5
6
7
8
9

CHAPTER 8SECURITY AND SAFETY SPECIFICATION 10

11
12
13
8.1 General Description 14
15
16
8.1.1 Introduction 17
18
The clusters specified in this document are for use in ZigBee security and safety 19
related applications. 20
21
The clusters currently defined are those that are used by wireless Intruder Alarm 22
Systems (IAS). Intruder Alarm systems include functions for the detection of 23
intruders and/or triggering, processing of information, notification of alarms and 24
the means to operate the IAS. 25
Functions additional to those may be included in IAS providing they do not 26
influence the correct operation of the mandatory functions. Components of other 27
applications may be combined or integrated with a IAS, providing the 28
performance of the IAS components is not adversely influenced. 29
30
31
8.1.2 Cluster List 32
33
This section lists the clusters specified in this document, and gives examples of 34
typical usage for the purpose of clarification. 35
The clusters defined in this document are listed in Table 8.1. 36
37
Table 8.1 Clusters Specified in the Security and Safety Functional Domain
38
Cluster Name Description 39
40
IAS Zone Attributes and commands for IAS security zone devices. 41
IAS ACE Attributes and commands for IAS Ancillary Control Equipment. 42
43
IAS WD Attributes and commands for IAS Warning Devices 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 8
228 Security and Safety Specification

1
Ancillary Control Control and Indicating 2
Equipment Equipment Warning devices 3
4
IAS ACE IAS WD 5
C S C S
6
S S IAS Zone C S 7
8
9
10
IAS Zone Zone devices (sensors) 11
12
13
IAS Zone S 14
15
16
C = Client S = Server 17
18
Note:- Device names are examples for illustration only 19
20
Figure 8.1 Typical Usage of the IAS Clusters 21
22
23
8.2 IAS Zone Cluster 24
25
26
8.2.1 Overview 27
28
The IAS Zone cluster defines an interface to the functionality of an IAS security 29
zone device. IAS Zone supports up to two alarm types per zone, low battery 30
reports and supervision of the IAS network. 31
32
8.2.2 Server 33
34
8.2.2.1 Dependencies 35
36
None. 37
38
8.2.2.2 Attributes 39
40
For convenience, the attributes defined in this specification are arranged into sets 41
of related attributes; each set can contain up to 16 attributes. Attribute identifiers 42
are encoded such that the most significant three nibbles specify the attribute set 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 229

and the least significant nibble specifies the attribute within the set. The currently
defined attribute sets are listed in Table 8.2. 1
2
Table 8.2 Attribute Sets for the IAS Zone Cluster
3
Attribute Set 4
Description 5
Identifier
6
0x000 Zone information 7
0x001 Zone settings 8
9
0x002 – 0xfff Reserved 10
11
8.2.2.2.1 Zone Information Attribute Set 12
13
The Zone Information attribute set contains the attributes summarized in
14
Table 8.3.
15
Table 8.3 Attributes of the Zone Information Attribute Set 16
17
Identifier Name Type Range Access Default Mandatory 18
/ Optional
19
0x0000 ZoneState 8-bit All Read only 0x00 M 20
Enumeration 21
22
0x0001 ZoneType 16-bit All Read only - M
Enumeration 23
24
0x0002 ZoneStatus 16-bit bitmap All Read only 0x00 M 25
26
8.2.2.2.1.1 ZoneState Attribute 27
28
The ZoneState attribute contains the values summarized in Table 8.4. 29
Table 8.4 Values of the ZoneState Attribute 30
31
ZoneState Value Meaning 32
0x00 Not enrolled
33
34
0x01 Enrolled (the server will react to Zone 35
State Change Notification commands 36
from the client)
37
0x02-0xff Reserved 38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 8
230 Security and Safety Specification

8.2.2.2.1.2 ZoneType Attribute

1
The ZoneType attribute values are summarized in Table 8.5. The Zone Type 2
dictates the meaning of Alarm1 and Alarm2 bits of the ZoneStatus attribute, as 3
also indicated in this table. 4
Table 8.5 Values of the ZoneType Attribute 5
6
ZoneType Zone Type Alarm1 Alarm2 7
attribute value 8
0x0000 Standard CIE System Alarm -
9
10
0x000d Motion sensor Intrusion indication Presence indication 11
0x0015 Contact switch 1stportal Open- 2nd portal Open- 12
Close Close 13
14
0x0028 Fire sensor Fire indication -
15
0x002a Water sensor Water overflow - 16
indication 17
0x002b Gas sensor CO indication Cooking indication 18
19
0x002c Personal emergency Fall / Concussion Emergency button 20
device
21
0x002d Vibration / Movement Movement Vibration 22
sensor indication 23
0x010f Remote Control Panic Emergency 24
25
0x0115 Key fob Panic Emergency 26
0x021d Keypad Panic Emergency 27
28
0x0225 Standard Warning - -
29
Device
(see [B2] part 4) 30
31
Other values < 0x7fff Reserved - - 32
0x8000-0xfffe Reserved for - - 33
manufacturer specific 34
types 35
0xffff Invalid Zone Type - - 36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 231

8.2.2.2.1.3 ZoneStatus Attribute

1
The ZoneStatus attribute is a bit map. The meaning of each bit is summarized in 2
Table 8.6. 3
Table 8.6 Values of the ZoneStatus Attribute 4
5
ZoneStatus Meaning Values 6
Attribute Bit Number 7
0 Alarm1 1 – opened or alarmed
8
9
0 – closed or not alarmed 10
1 Alarm2 1 – opened or alarmed 11
12
0 – closed or not alarmed
13
2 Tamper 1 – Tampered 14
0 – Not tampered 15
16
3 Battery 1 – Low battery 17
0 – Battery OK 18
19
4 Supervision reports 1 – Reports
(Note 1) 20
0 – Does not report 21
5 Restore reports 1 – Reports restore 22
(Note 2) 23
0 – Does not report restore
24
6 Trouble 1 – Trouble/Failure 25
0 – OK
26
27
7 AC (mains) 1 – AC/Mains fault 28
0 – AC/Mains OK 29
30
8-15 Reserved -
31
32
Note 1: This bit indicates whether the Zone issues periodic Zone Status Change 33
Notification commands. The CIE device may use these periodic reports as an 34
indication that a zone is operational. Zones that do not implement the periodic 35
reporting are required to set this bit to zero (the CIE will know not to interpret the 36
lack of reports as a problem). 37
Note2: This bit indicates whether or not a Zone Status Change Notification 38
command will be sent to indicate that an alarm is no longer present. Some Zones 39
do not have the ability to detect that alarm condition is no longer present, they 40
only can tell that an alarm has occurred. These Zones must set the "Restore" bit to 41
zero, indicating to the CIE not to look for alarm-restore notifications. 42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 8
232 Security and Safety Specification

8.2.2.2.2 Zone Settings Attribute Set

1
The Zone settings attribute set contains the attributes summarized in Table 8.7. 2
Table 8.7 Attributes of the Zone Settings Attribute Set 3
4
Identifier Name Type Range Access Default Mandatory 5
/ Optional 6
0x0010 IAS_CIE_Address IEEE Valid 64bit Read/ - M
7
address IEEE address Write 8
9
10
8.2.2.2.2.1 IAS_CIE_Address Attribute 11
The IAS_CIE_Address attribute specifies the address that commands generated by 12
the server shall be sent to. All commands received by the server must also come 13
from this address. 14
15
It is up to the zone's specific implementation to permit or deny change (write) of 16
this attribute at specific times. Also, it is up to the zone's specific implementation 17
to implement some auto-detect for the CIE (example: by requesting the ZigBee 18
cluster discovery service to locate a Zone Server cluster.) or require the 19
intervention of a CT in order to configure this attribute during installation. 20
21
8.2.2.3 Commands Received 22
The command IDs received by the IAS Zone server cluster are listed in Table 8.8. 23
24
Table 8.8 Received Command IDs for the IAS Zone Cluster
25
26
Command Identifier Mandatory
Description 27
Field Value / Optional
28
0x00 Zone Enroll Response M 29
0x01 – 0xff Reserved 30
31
32
8.2.2.3.1 Zone Enroll Response Command
33
34
8.2.2.3.1.1 Payload Format 35
The Zone Enroll Response command payload shall be formatted as illustrated in 36
Figure 8.2. 37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 233

1
Bits 8 8 2
3
Data Type 8-bit Enumeration Unsigned 8-bit Integer 4
5
Field Name Enroll response code Zone ID
6
7
Figure 8.2 Format of the Zone Enroll Response Command Payload 8
9
The permitted values of the Enroll Response Code are shown in Table 8.9. 10
11
Table 8.9 Values of the Enroll Response Code
12
Code Meaning Details 13
14
0x00 Success Success 15
0x01 Not supported This specific Zone type is not known 16
to the CIE and is not supported. 17
18
0x02 No enroll permit CIE does not permit new zones to
enroll at this time.
19
20
0x03 Too many zones CIE reached its limit of number of 21
enrolled zones 22
0x04-0xfe Reserved - 23
24
The Zone ID field is the index into the zone table of the CIE (Table 8.11). This 25
field is only relevant if the response code is success. 26
27
28
8.2.2.3.1.2 Effect on Receipt
29
On receipt, the device embodying the Zone client is notified that it is now enrolled 30
as an active alarm device 31
32
The device embodying the Zone client must authenticate received messages by
33
checking the address of their sender against IAS_CIE_Address. This is to ensure
34
that only messages from the correct CIE are accepted.
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 8
234 Security and Safety Specification

8.2.2.4 Commands Generated

1
The generated command IDs for the IAS Zone server cluster are listed in 2
Table 8.10. 3
Table 8.10 Generated Command IDs for the IAS Zone Cluster 4
5
Command Identifier Mandatory 6
Description
Field Value / Optional 7
8
0x00 Zone Status Change Notification M
9
0x01 Zone Enroll Request M 10
11
0x02 – 0xff Reserved
12
13
8.2.2.4.1 Zone Status Change Notification Command 14
15
8.2.2.4.1.1 Payload Format 16
17
The Zone Status Change Notification command payload shall be formatted as
18
illustrated in Figure 8.3.
19
20
16 8 21
Bits
22
Data Type 16-bit Enumeration 8-bit Enumeration 23
24
Field Name Zone Status Extended Status 25
26
27
Figure 8.3 Format of the Zone Status Change Notification
Command Payload 28
29
The Zone Status field shall be the current value of the ZoneStatus attribute. 30
31
The Extended Status field is reserved for additional status information and shall 32
be set to zero. 33
34
8.2.2.4.1.2 When Generated 35
The Zone Status Change Notification command is generated when a change takes 36
place in one or more bits of the ZoneStatus attribute. 37
38
8.2.2.4.2 Zone Enroll Request Command 39
40
8.2.2.4.2.1 Payload Format 41
42
The Zone Enroll Request command payload shall be formatted as illustrated in 43
Figure 8.4. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 235

1
Bits 16 16 2
3
Data Type 16-bit Enumeration Unsigned 16-bit Integer 4
5
Field Name Zone Type Manufacturer Code
6
7
Figure 8.4 Format of the Zone Enroll Request Command Payload 8
9
The Zone Type field shall be the current value of the ZoneType attribute. 10
11
The Manufacturer Code field shall be the manufacturer code as held in the node 12
descriptor for the device. Manufacturer Codes are allocated by the ZigBee 13
Alliance. 14
15
8.2.2.4.2.2 When Generated 16
The Zone Enroll Request command is generated when a device embodying the 17
Zone client cluster wishes to be enrolled as an active alarm device. It must do this 18
immediately it has joined the network (during commissioning). 19
20
21
8.2.3 Client 22
23
8.2.3.1 Dependencies 24
25
None.
26
27
8.2.3.2 Attributes
28
No attributes are currently defined for this cluster. 29
30
8.2.3.3 Commands Received 31
32
The client receives the cluster specific commands detailed in 8.2.2.4. 33
34
8.2.3.4 Commands Generated 35
The client generates the cluster specific commands detailed in 8.2.2.3, as required 36
by the application. 37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 8
236 Security and Safety Specification

8.3 IAS ACE Cluster 1

2
8.3.1 Overview 3
4
The IAS ACE cluster defines an interface to the functionality of any Ancillary 5
Control Equipment of the IAS system. Using this cluster, a ZigBee enabled ACE 6
device can access a IAS CIE device and manipulate the IAS system, on behalf of a 7
level-2 user (see [B2]). 8
9
The client is usually implemented by the IAS ACE device. It allows the IAS ACE 10
device to control the IAS CIE device, which typically implements the server side. 11
12
8.3.2 Server 13
14
15
8.3.2.1 Dependencies 16
None. 17
18
8.3.2.2 Attributes 19
20
No attributes are currently defined for this cluster. 21
22
8.3.2.3 Zone Table 23
The Zone Table is used to store information for each Zone enrolled by the CIE. 24
The maximum number of entries in the table is 256. 25
26
The format of a group table entry is illustrated in Table 8.11. 27
Table 8.11 Format of the Zone Table 28
29
Field Type Valid Range Description 30
31
Zone ID Unsigned 0x00 – 0xfe The unique identifier of the
8-bit integer zone
32
33
Zone Type 16-bit 0x0000 – 0xfffe See Table 8.5. 34
Enumeration 35
Zone Address IEEE Address Valid 64bit IEEE Device address 36
address 37
38
The Zone ID is a unique reference number allocated by the CIE at zone 39
enrollment time. 40
41
The Zone ID is used by IAS devices to reference specific zones when 42
communicating with the CIE. The Zone ID of each zone stays fixed until that zone 43
is un-enrolled. 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 237

8.3.2.4 Commands Received

1
The received command IDs for the IAS ACE server cluster are listed in Table 8.12 2
Table 8.12 Received Command IDs for the IAS ACE Cluster 3
4
Command Identifier Description Mandatory / 5
Field Value Optional 6
0x00 Arm M 7
8
0x01 Bypass M 9
0x02 Emergency M 10
11
0x03 Fire M
12
0x04 Panic M 13
14
0x05 Get Zone ID Map M
15
0x06 Get Zone Information M 16
0x07 – 0xff Reserved - 17
18
19
8.3.2.4.1 Arm Command 20
21
8.3.2.4.1.1 Payload Format 22
The Arm command payload shall be formatted as illustrated in Figure 8.5. 23
24
25
Bits 8 26
27
Data Type 8-bit Enumeration 28
29
Field Name Arm Mode 30
31
Figure 8.5 Format of the Arm Command Payload 32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 8
238 Security and Safety Specification

8.3.2.4.1.2 Arm Mode Field

1
The Arm Mode field shall have one of the values shown in Table 8.13. 2
Table 8.13 Arm Mode Field Values 3
4
Arm Mode 5
Field Value Meaning
6
0x00 Disarm
7
8
0x01 Arm Day/Home Zones Only 9
0x02 Arm Night/Sleep Zones Only 10
11
0x03 Arm All Zones 12
0x08-0xff Reserved 13
14
15
8.3.2.4.1.3 Effect on Receipt
16
On receipt of this command, the receiving device sets its arm mode according to 17
the value of the Arm Mode field, as detailed in Table 8.13. It is not guaranteed that 18
an Arm command will succeed. Based on the current state of the IAS CIE, and its 19
related devices, the command can be rejected. The device shall generate an Arm 20
Response command (see 8.3.2.5.1) to indicate the resulting armed state. 21
22
8.3.2.4.2 Bypass Command 23
24
8.3.2.4.2.1 Payload Format 25
The Bypass command payload shall be formatted as illustrated in Figure 8.6. 26
27
28
Bits 8 8 ----- 8 29
30
Data Type
Unsigned 8-bit Integer Unsigned 8-bit ----- Unsigned 8-bit 31
Integer Integer 32
Field Name Number of Zones Zone ID ----- Zone ID 33
34
35
Figure 8.6 Format of the Bypass Command Payload 36
37
8.3.2.4.2.2 Number of Zones Parameter 38
This is the number of Zone IDs included in the payload. 39
40
41
8.3.2.4.2.3 Zone ID Parameter
42
Zone ID is the index of the Zone in the CIE's zone table (Table 8.11). 43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 239

8.3.2.4.3 Emergency, Fire and Panic Commands

1
These commands indicate the emergency situations inherent in their names. They 2
have no payload. 3
8.3.2.4.4 Get Zone ID Map Command 4
5
6
8.3.2.4.4.1 Payload Format
7
This command has no payload. 8
9
8.3.2.4.4.2 Effect on Receipt 10
11
On receipt of this command, the device shall generate a Get Zone ID Map 12
Response command. See 7.2.5.2 13
8.3.2.4.5 Get Zone Information Command 14
15
8.3.2.4.5.1 Payload Format 16
17
The Get Zone Information command payload shall be formatted as illustrated in 18
Figure 8.7. 19
20
21
Bits 8 22
23
Data Type Unsigned 8-bit Integer
24
Zone ID 25
Field Name
26
27
Figure 8.7 Format of the Get Zone Information Command Payload 28
29
8.3.2.4.5.2 Effect on Receipt 30
31
On receipt of this command, the device shall generate a Get Zone Information
32
Response command. See 7.2.5.3.
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 8
240 Security and Safety Specification

8.3.2.5 Commands Generated

1
The generated command IDs for the IAS ACE server cluster are listed in 2
Table 8.14. 3
Table 8.14 Generated Command IDs for the IAS ACE Cluster 4
5
Command Identifier Mandatory 6
Description
Field Value / Optional 7
8
0x00 Arm Response M
9
0x01 Get Zone ID Map Response M 10
11
0x02 Get Zone Information Response M
12
0x03 – 0xff Reserved 13
14
8.3.2.5.1 Arm Response Command 15
16
8.3.2.5.1.1 Payload Format 17
18
The Arm Response command payload shall be formatted as illustrated in 19
Figure 8.8. 20
21
22
Bits 8 23
24
Data Type 8-bit Enumeration
25
Arm Notification 26
Field Name
27
28
Figure 8.8 Format of the Arm Response Command Payload 29
30
8.3.2.5.1.2 Arm Notification Field 31
32
The Arm Notification field shall have one of the values shown in Table 8.15.
33
Table 8.15 Arm Notification Values 34
35
Arm Mode 36
Meaning
Attribute Value
37
0x00 All Zones Disarmed 38
39
0x01 Only Day/Home Zones Armed
40
0x02 Only Night/Sleep Zones Armed 41
0x03 All Zones Armed 42
43
0x04 – 0xfe Reserved 44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 241

8.3.2.5.2 Get Zone ID Map Response Command

1
8.3.2.5.2.1 Payload Format 2
3
The Get Zone ID Map Response command payload shall be formatted as 4
illustrated in Figure 8.9. 5
6
7
Bits 16 ........ 16 8
9
Data Type 16-bit bitmap ........ 16-bit bitmap
10
Zone ID Map section 0 ........ Zone ID Map section 15 11
Field Name
12
13
Figure 8.9 Format of the Get Zone ID Map Response Command 14
Payload 15
16
The 16 fields of the payload indicate whether each of the Zone IDs from 0 to 0xff 17
is allocated or not. If bit n of Zone ID Map section N is set to 1, then Zone ID (16 18
x N + n ) is allocated, else it is not allocated. 19
8.3.2.5.3 Get Zone Information Response Command 20
21
8.3.2.5.3.1 Payload Format 22
23
The Get Zone Information Response command payload shall be formatted as 24
illustrated in Figure 8.10. 25
26
27
Bits 8 16 64 28
29
Data Type Unsigned 8-bit Integer 16-bit Enumeration IEEE address
30
Zone ID Zone Type IEEE address 31
Field Name
32
33
Figure 8.10 Format of the Get Zone Information Response 34
Command Payload 35
36
The fields of the payload are equal to the fields of the Group Table entry 37
corresponding to the ZoneID field of the Get Zone Information command to 38
which this command is a response. 39
If the Zone ID is unallocated, this shall be indicated by setting the Zone Type and 40
IEEE Address fields to 0xffff (see Table 8.5) and 0xffffffffffffffff respectively. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 8
242 Security and Safety Specification

8.3.3 Client 1
2
8.3.3.1 Dependencies 3
None. 4
5
8.3.3.2 Attributes 6
7
No attributes are currently defined for this cluster. 8
9
8.3.3.3 Commands Received 10
No cluster specific commands are received by the server. 11
12
8.3.3.4 Commands Generated 13
14
The client cluster generates the commands detailed in 8.3.2.4, as required by the 15
application. 16
17
18
8.4 IAS WD Cluster 19
20
21
8.4.1 Overview 22
23
The IAS WD cluster provides an interface to the functionality of any Warning 24
Device equipment of the IAS system. Using this cluster, a ZigBee enabled CIE 25
device can access a ZigBee enabled IAS WD device and issue alarm warning 26
indications (siren, strobe lighting, etc.) when a system alarm condition is detected 27
(according to [B2]). 28
29
8.4.2 Server 30
31
8.4.2.1 Dependencies 32
33
None. 34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 243

8.4.2.2 Attributes
1
The attributes defined for the server cluster are detailed in Table 8.16. 2
Table 8.16 Attributes of the IAS WD (Server) Cluster 3
4
5
Identifier Name Type Range Access Default Mandatory
/ Optional 6
7
0x0000 MaxDuration Unsigned 0x0000 – Read/Write 240 M
16-bit integer 0fffe
8
9
0x0001-0xffff Reserved - - - - - 10
11
8.4.2.2.1 MaxDuration Attribute 12
13
The MaxDuration attribute specifies the maximum time in seconds that the siren 14
will sound continuously, regardless of start/stop commands. 15
16
8.4.2.3 Commands Received 17
The received command IDs are listed in Table 8.17. 18
19
Table 8.17 Received Command IDs for the IAS WD Server Cluster 20
21
Command Identifier Mandatory
Description 22
Field Value / Optional
23
0x00 Start warning M 24
0x01 Squawk M 25
26
0x02 – 0xff Reserved 27
28
8.4.2.3.1 Start Warning Command 29
30
This command starts the WD operation. The WD alerts the surrounding area by 31
audible (siren) and visual (strobe) signals. 32
A Start Warning command shall always terminate the effect of any previous 33
command that is still current. 34
35
8.4.2.3.1.1 Payload Format 36
37
The Start Warning command payload shall be formatted as illustrated in 38
Figure 8.11. 39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 8
244 Security and Safety Specification

1
Bits 4 2 2 16 2
3
8-bit Data Unsigned 4
Data Type 16-bit Integer 5
Field Name Warning mode Strobe Reserved Warning duration 6
7
8
Figure 8.11 Format of the Start Siren Command Payload 9
10
The Warning mode and Strobe subfields are concatenated together to a single 8-bit 11
Bitmap field. The groups of bits these subfields occupy are used as follows. 12
13
8.4.2.3.1.2 Warning Mode Field 14
The Warning Mode field is used as an 4-bit enumeration, can have one of the 15
values set in Table 8.18. The exact behavior of the WD device in each mode is 16
according to the relevant security standards. 17
18
Table 8.18 Warning Modes 19
20
Warning Mode Meaning
21
0 Stop (no warning) 22
23
1 Burglar
24
2 Fire 25
3 Emergency 26
27
4-15 Reserved 28
29
8.4.2.3.1.3 Strobe Field 30
31
The Strobe field is used as a 2-bit enumeration, and determines if the visual 32
indication is required in addition to the audible siren, as indicated in Table 8.19. If 33
the strobe field is "1" and the Warning Mode is "0" ("Stop") then only the strobe is 34
activated. 35
Table 8.19 Values of the Strobe Field 36
37
Value Meaning 38
39
0 No strobe
40
1 Use strobe in parallel to warning 41
2-3 Reserved
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 245

8.4.2.3.1.4 Warning Duration Field

1
Requested duration of warning, in seconds. If both Strobe and Warning Mode are 2
"0" this field shall be ignored. 3
8.4.2.3.2 Squawk Command 4
5
This command uses the WD capabilities to emit a quick audible/visible pulse 6
called a "squawk". The squawk command has no effect if the WD is currently 7
active (warning in progress). 8
9
8.4.2.3.2.1 Payload Format 10
11
The Squawk command payload shall be formatted as illustrated in Figure 8.12. 12
13
14
Bits 4 1 1 2
15
Data Type 8-bit Data 16
17
Field Name Squawk mode Strobe Reserved Squawk level 18
19
20
Figure 8.12 Format of the Start Siren Command payload
21
22
8.4.2.3.2.2 Squawk Mode Field
23
The Squawk Mode field is used as a 4-bit enumeration, and can have one of the 24
values shown in Table 8.20. The exact operation of each mode (how the WD 25
"squawks") is implementation specific. 26
27
Table 8.20 Squawk Mode Field
28
Warning Mode Meaning 29
30
0 Notification sound for "System is armed" 31
32
1 Notification sound for "System is disarmed"
33
2-15 Reserved 34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 8
246 Security and Safety Specification

8.4.2.3.2.3 Strobe Field

1
The strobe field is used as a boolean, and determines if the visual indication is also 2
required in addition to the audible squawk., as shown in Table 8.21. 3
Table 8.21 Strobe Bit 4
5
Value Meaning 6
7
0 No strobe
8
1 Use strobe blink in parallel to squawk 9
10
8.4.2.3.2.4 Squawk Level Field 11
12
The squawk level field is used as a 2-bit enumeration, and determines the intensity 13
of audible squawk sound as shown in Table 8.22. 14
Table 8.22 Squawk Level Field Values 15
16
Value Meaning 17
18
0 Low level sound 19
1 Medium level sound 20
21
2 High level sound
22
3 Very High level sound 23
24
8.4.2.4 Commands Generated 25
26
No cluster specific commands are generated by the server cluster. 27
28
29
8.4.3 Client 30
31
The client side is implemented by the CIE. The CIE is a client of the warning
32
service provided by this cluster. Usually a WD would implement an IAS WD
33
cluster server and an IAS Zone cluster server.
34
35
8.4.3.1 Dependencies 36
None. 37
38
8.4.3.2 Attributes 39
40
No attributes are currently defined for the client cluster. 41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 ZigBee Cluster Library
Document 075123r01ZB 247

8.4.3.3 Received Commands

1
The client receives no cluster specific commands. 2
3
8.4.3.4 Commands Generated 4
5
The client cluster generates the cluster specific commands detailed in 8.4.2.3, as 6
required by the application. 7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.
 Chapter 8
248 Security and Safety Specification

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
This page left intentionally blank 17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Copyright © 2007 ZigBee Standards Organization. All rights reserved.