![Zigbee Cluster Library Specification
Zigbee Document – 075123
Page 4 Copyright 2007-2018, The Zigbee Alliance. All rights reserved.
Document Control
40
The Zigbee Cluster Library is made of individual chapters such as this one. See Chapter 1 for the list of all chapters.
41
References between chapters are made using a X.Y notation where X is the chapter and Y is the sub-section within that
42
chapter. References to external documents are contained in Chapter 1 and are made using [Rn] notation.
43
An update to any of these chapters will be reflected in an update to the source document list below.
44
Chapter 1 – Introduction Document 14-0125-13
Chapter 2 – Foundation Document 14-0126-16
Chapter 3 – General Document 14-0127-20
Chapter 4 – Measurement and Sensing Document 14-0128-11
Chapter 5 – Lighting Document 14-0129-15
Chapter 6 – HVAC Document 14-0130-12
Chapter 7 – Closures Document 14-0131-15
Chapter 8 – Security and Safety Document 14-0132-13
Chapter 9 – Protocol Interfaces Document 14-0133-08
Chapter 10 – Smart Energy Document 14-0134-11
Chapter 11 – Over the Air Upgrades Document 14-0135-15
Chapter 12 – Telecommunications Document 14-0136-10
Chapter 13 – Commissioning Document 14-0137-13
Chapter 14 – Retail Services Document 14-0138-08
Chapter 15 – Appliances Document 14-0139-12
Approved Errata for this ZCL revision Document 17-2017
Source files for drawings in this ZCL revision Document 14-0141-00
45](https://image.slidesharecdn.com/23749237-250519191535-c803f084/85/Zigbee-Cluster-Library-Specification-7th-Zigbee-Alliance-8-320.jpg)
![Zigbee Cluster Library Specification Chapter 1
Zigbee Alliance Document – 075123 Introduction
Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 1-1
CHAPTER 1 INTRODUCTION
1668
The Zigbee Cluster Library is made of individual chapters such as this one. See Document Control in the Zigbee
1669
Cluster Library for a list of all chapters and documents. References between chapters are made using a X.Y notation
1670
where X is the chapter and Y is the sub-section within that chapter. References to external documents are contained in
1671
Chapter 1 and are made using [Rn] notation.
1672
1.1 Scope and Purpose
1673
This document specifies the Zigbee Cluster Library (ZCL). The ZCL is a repository for cluster functionality that is
1674
developed by the Zigbee Alliance, and is a working library with regular updates as new functionality is added.
1675
A developer constructing a new application should use the ZCL to find relevant cluster functionality that can be
1676
incorporated into the new application. Correspondingly, new clusters that are defined for applications should be
1677
considered for inclusion in the ZCL.
1678
The ZCL consists of the ZCL Foundation, a set of elements that apply across the entire library (such as frame
1679
structures, attribute access commands and data types), and a number of sets of clusters. Clusters that are generally
1680
useful across many application domains are included in the General set. Clusters that are intended for use mainly in
1681
specific application domains are grouped together in domain oriented sets.
1682
1.2 Acronyms and Abbreviations
1683
Table 1-1. Acronyms and Abbreviations
1684
Acronym Definition
Acc Access
ACE Ancillary Control Equipment
AES Advanced Encryption Standard
AIB Application support sub-layer Information Base
AMI Advanced Metering Infrastructure or Advanced Metering Initiative
AP Access Point
APS Application support Sub-layer
BPL Broadband over Power Lines
CA Certificate Authority
CBA Commercial Building Automation
CBKE Certificate-based Key Establishment
CIE Control and Indicating Equipment
CT Commissioning Tool
D Deprecated
Def Default
ECDSA Elliptic Curve Digital Signature Algorithm](https://image.slidesharecdn.com/23749237-250519191535-c803f084/85/Zigbee-Cluster-Library-Specification-7th-Zigbee-Alliance-43-320.jpg)
![Chapter 1 Zigbee Cluster Library Specification
Introduction Zigbee Alliance Document – 075123
Page 1-4 Copyright 2007-2018, The Zigbee Alliance. All rights reserved.
Acronym Definition
ZED Zigbee End Device (equivalent to IEEE’s RFD – Reduced Functionality Device)
ZR Zigbee Router (equivalent to IEEE’s FFD – Full Functionality Device)
1.3 Definitions
1685
Many of these terms are described in more detail in the core stack specification [Z1], or the Application Architecture
1686
specification [Z5].
1687
Application Cluster: An application cluster generates persistent functional application transactions between client
1688
and server.
1689
Attribute: A data entity which represents a physical quantity or state. This data is communicated to other devices
1690
using commands.
1691
Binding: A persistent mapping of a local cluster instance to one or more corresponding remote cluster instances. A
1692
binding can be broadcast, groupcast, or unicast. A unicast binding includes an address (IEEE or network) and endpoint.
1693
Cluster: A cluster is a specification defining one or more attributes, commands, behaviors and dependencies, that
1694
supports an independent utility or application function. The term may also be used for an implementation or instance
1695
of such a specification on an endpoint.
1696
Cluster identifier: The cluster identifier is a 16-bit number that maps to (identifies) a single cluster specification.
1697
More than one cluster identifier may map to a cluster specification, each defining a different scope and purpose.
1698
Cluster identifiers are designated as inputs or outputs in the simple descriptor for use in creating a binding table.
1699
Client: A cluster interface which is listed in the output cluster list of the simple descriptor on an endpoint. Typically
1700
this interface sends commands that manipulate the attributes on the corresponding server cluster. A client cluster
1701
communicates with a corresponding remote server cluster with the same cluster identifier.
1702
Corresponding cluster: The opposite side of a cluster (client to a server, or server to a client).
1703
Device: A specification which defines a unique device identifier and a set of mandatory and optional clusters to be
1704
implemented on a single endpoint. The term may also be used for an implementation or instance of the device
1705
specification on an endpoint.
1706
Node: A Zigbee node (or node) is a single testable implementation of a Zigbee application on a single Zigbee stack,
1707
with a single network address, on a single network.
1708
Product: A product is a node that is intended to be marketed.
1709
Server: A cluster interface which is listed in the input cluster list of the simple descriptor on an endpoint. Typically,
1710
this interface supports all or most of the attributes of the cluster. A server cluster communicates with a corresponding
1711
remote client cluster with the same cluster identifier.
1712
Service discovery: The ability of a device to locate services of interest.
1713
Sleepy End Device: A Zigbee End Device with rxOnWhenIdle set to FALSE.
1714
Utility Cluster: A utility cluster is not part of the application function of the product. It may be used for
1715
commissioning, configuration, discovery, addressing, diagnostics, etc.
1716
Type 1 Cluster: A type 1 cluster’s primary function is to initiate transactions from the client to the server.
1717
Type 2 Cluster: A type 2 cluster’s primary function is to initiate transactions from the server to the client.
1718
Zigbee Coordinator: An IEEE 802.15.4-2003 PAN coordinator.
1719
Zigbee End Device: an IEEE 802.15.4-2003 RFD or FFD participating in a Zigbee network, which is neither the
1720
Zigbee coordinator nor a Zigbee router.
1721](https://image.slidesharecdn.com/23749237-250519191535-c803f084/85/Zigbee-Cluster-Library-Specification-7th-Zigbee-Alliance-46-320.jpg)
![Zigbee Cluster Library Specification Chapter 1
Zigbee Alliance Document – 075123 Introduction
Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 1-5
Zigbee Router: an IEEE 802.15.4-2003 FFD participating in a Zigbee network, which is not the Zigbee coordinator
1722
but may act as an IEEE 802.15.4-2003 coordinator within its personal operating space, that is capable of routing
1723
messages between devices and supporting associations.
1724
1.4 Conformance Levels
1725
Expected: A key word used to describe the behavior of the hardware or software in the design models assumed by
1726
this Draft. Other hardware and software design models may also be implemented.
1727
May: A key word that indicates flexibility of choice with no implied preference.
1728
Shall: A key word indicating a mandatory requirement. Designers are required to implement all such mandatory
1729
requirements.
1730
Should: A key word indicating flexibility of choice with a strongly preferred alternative. Equivalent to the phrase is
1731
recommended.
1732
1.5 References
1733
The following standards and specifications contain provisions, which through reference in this document constitute
1734
provisions of this specification. All the standards and specifications listed are normative references. At the time of
1735
publication, the editions indicated were valid. All standards and specifications are subject to revision, and parties to
1736
agreements based on this specification are encouraged to investigate the possibility of applying the most recent
1737
editions of the standards and specifications indicated below.
1738
1.5.1 Zigbee Alliance Documents
1739
[Z1] Zigbee 053474, Zigbee Specification
1740
[Z2] Zigbee 064321, Zigbee Stack Profile
1741
[Z3] Zigbee 074855, Zigbee PRO Stack Profile
1742
[Z4] Zigbee 08006, Zigbee-2007 Layer PICs and Stack Profiles
1743
[Z5] Zigbee 130589, Application Architecture
1744
[Z6] Zigbee 130402, Base Device Behavior Specification
1745
[Z7] Zigbee 053298, Profile Identifier Database
1746
[Z8] Zigbee 106050, Zigbee Device internetworking, list of Device IDs
1747
[Z9] Zigbee 075356, Smart Energy Profile Specification
1748
[Z10] Zigbee 03084, Zigbee Key Establishment Proposal
1749
[Z11] Zigbee 095343, Installation Code Sample Source Code
1750
[Z12] Zigbee 053874, Manufacturer Code Database
1751
[Z13] Zigbee 115456, Master Cluster List
1752
[Z14] Zigbee 1602867, Zigbee 3.0 Cluster List
1753
1.5.2 International Standards Documents
1754
[I1] CIE 1931 Color Space. Commission Internationale de l'Eclairage Proceedings. Cambridge University
1755
Press, Cambridge
1756
[I2] ISO 7816 International Standard for Electronic Identification Cards with Contacts (Smart Cards)
1757](https://image.slidesharecdn.com/23749237-250519191535-c803f084/85/Zigbee-Cluster-Library-Specification-7th-Zigbee-Alliance-47-320.jpg)
![Chapter 1 Zigbee Cluster Library Specification
Introduction Zigbee Alliance Document – 075123
Page 1-6 Copyright 2007-2018, The Zigbee Alliance. All rights reserved.
1.5.3 National Standards Documents
1758
[N1] EN 50131 European Standards Series for Intruder Alarm Systems
1759
[N2] BSI British Standards, document BS EN 50523-2:2009, “Household Appliances interworking – Part 2:
1760
Data Structures”. July 2009
1761
[N3] NIST Special Publication 800-38C, Recommendation for Block Cipher Modes of Operation: CCM Mode
1762
for Authentication and Confidentiality, May 2004
1763
[N4] FIPS Pub 197, Advanced Encryption Standard (AES), Processing Standards Publication 197, US
1764
Department of Commerce/NIST Springfield, Virginia, November 26, 2001
1765
[N5] FIPS Pub 198, The Keyed-Hash Message Authentication Code (HMAC), Federal Information, Processing
1766
Standards Publication 198, US Department of Commerce/NIST Springfield, Virginia, March 6, 2002
1767
1.5.4 IEEE Documents
1768
[E1] IEEE Standards 802, Part 15.4: Wireless Medium Access Control (MAC) and Physical Layer (PHY)
1769
specifications for Low Rate Wireless Personal Area Networks (LR-WPANs), IEEE, October 2003.
1770
[E2] IEEE 754-1985, IEEE Standard for Binary Floating-Point Arithmetic, IEEE, 1985.
1771
1.5.5 ASHRAE Documents
1772
[A1] ASHRAE 135-2004 standard, Data Communication Protocol for Building Automation and Control
1773
Networks
1774
1.5.6 Health Care Documents
1775
[H1] ISO/IEEE 11073-20601: Health Informatics - Personal Health Device Communication - Application Profile
1776
- Optimized Exchange Protocol - version 1.0 or later.
1777
[H2] ISO/IEEE P11073-10404, Health informatics – Personal health device communication – Device
1778
specialization – Pulse oximeter.
1779
[H3] ISO/IEEE P11073-10407, Health informatics – Personal health device communication – Device
1780
specialization – Blood pressure monitor.
1781
[H4] ISO/IEEE P11073-10408, Health informatics – Personal health device communication – Device
1782
specialization – Thermometer.
1783
[H5] ISO/IEEE P11073-10415, Health informatics – Personal health device communication – Device
1784
specialization – Weighing scale.
1785
[H6] ISO/IEEE P11073-10417, Health informatics – Personal health device communication – Device
1786
specialization – Glucose meter.
1787
[H7] ISO/IEEE P11073-10419, Health informatics – Personal health device communication – Device
1788
specialization – Insulin Pump
1789
[H8] ISO/IEEE P11073-10421, Health informatics – Personal health device communication – Device
1790
specialization – Peak Expiratory Flow Monitor
1791
[H9] ISO/IEEE P11073-10441, Health informatics – Personal health device communication – Device
1792
specialization – Cardiovascular Fitness and Activity Monitor.
1793
[H10] ISO/IEEE P11073-10442, Health informatics – Personal health device communication – Device
1794
specialization – Strength Fitness Equipment.
1795
[H11] ISO/IEEE P11073-10471, Health informatics – Personal health device communication – Device
1796
specialization – Independent living activity hub.
1797](https://image.slidesharecdn.com/23749237-250519191535-c803f084/85/Zigbee-Cluster-Library-Specification-7th-Zigbee-Alliance-48-320.jpg)
![Zigbee Cluster Library Specification Chapter 1
Zigbee Alliance Document – 075123 Introduction
Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 1-7
[H12] ISO/IEEE P11073-10472, Health informatics – Personal health device communication – Device
1798
specialization – Medication Monitor.
1799
1.5.7 Other Documents
1800
[O1] Standards for Efficient Cryptography: SEC 1 (working draft) ver 1.7: Elliptic Curve Cryptography,
1801
Certicom Research, www.secg.org, November 13, 2006
1802
[O2] Standards for Efficient Cryptography: SEC 4 (draft) ver 1.0: Elliptic Curve Cryptography, Certicom
1803
Research, www.secg.org, January 24, 2013
1804
[O3] RFC 3280: Internet X.509 Public Key Infrastructure: Certificate and Certificate Revocation List (CRL)
1805
Profile, IETF, www.ietf.org, April 2002
1806
1.6 Conventions
1807
The following conventions are used in this document.
1808
1.6.1 Enumerations and Reserved Values
1809
Each undefined value or range of an enumeration, field, or identifier SHALL be considered reserved for future
1810
revisions of this standard and SHALL not be available for implementation.
1811
Each value or range of an enumeration, field, or identifier that is available for non-standard implementation SHALL
1812
be described as “manufacturer specific”, “vendor specific”, “ms”, or “MS”.
1813
Each value or range of an enumeration, field, or identifier that is available for other parts of this standard SHALL be
1814
described as such.
1815
Each value or range of an enumeration, field, or identifier that is obsolete, and not available for implementation,
1816
SHALL be described as “Obsolete”.
1817
1.6.2 Reserved Bit Fields
1818
Each full or partial data field (e.g., message data field), of any bit length, that is undefined, SHALL be considered
1819
reserved for future revisions of this standard and SHALL not be available for implementation.
1820
Please see Section Chapter 2, Transmission and Reception, regarding rules for setting and interpreting reserved fields.
1821
1.6.3 Number Format
1822
In this specification, hexadecimal numbers are prefixed with the designation “0x” and binary numbers are prefixed
1823
with the designation “0b”. All other numbers are assumed to be decimal unless indicated otherwise within the
1824
associated text.
1825
Binary numbers are specified as successive groups of 4 bits, separated by a space (“ “) character from the most
1826
significant bit (next to the 0b prefix and left most on the page) to the least significant bit (rightmost on the page), e.g.
1827
the binary number 0b0000 1111 represents the decimal number 15. Where individual bits are indicated (e.g. bit 3) the
1828
bit numbers are relative to the least significant bit which is bit 0.
1829
When a bit is specified as having a value of either 0 or 1 it is specified with an “x”, e.g. “0b0000 0xxx” indicates that
1830
the lower 3 bits can take any value but the upper 5 bits must each be set to 0.
1831](https://image.slidesharecdn.com/23749237-250519191535-c803f084/85/Zigbee-Cluster-Library-Specification-7th-Zigbee-Alliance-49-320.jpg)
![Chapter 1 Zigbee Cluster Library Specification
Introduction Zigbee Alliance Document – 075123
Page 1-8 Copyright 2007-2018, The Zigbee Alliance. All rights reserved.
1.7 Testing, Validation and Certification
1832
The text of this document has been balloted and approved according to the procedures existing at the time of each
1833
release. However, not all cluster specifications have undergone a complete and successful specification validation
1834
event (SVE), which requires the testing of multiple diverse implementations to verify a common interpretation of the
1835
text.
1836
New features may be added to new releases of this document, but only if the specification text has passed an SVE.
1837
Old releases did not follow this rule, hence the statement above. Even a successful SVE for a cluster specification may
1838
not test or validate all cluster specification text.
1839
This is a living document. Erroneous or ambiguous text is discovered regularly, reviewed, approved and added as
1840
errata to this document. Testing and validation of errata may lag the release of errata text.
1841
Not all clusters in this specification are certifiable under a current certification program. A certification program
1842
defines a testing process that may require reference implementations, test fixtures, and/or test scripts. A certification
1843
program may also be frozen or inactive. A frozen certification program does not support new errata or new features.
1844
If there is no active certification program or the testing process requirements are not in place to test a cluster
1845
specification, then the cluster specification is not able to be certified.
1846
As of the writing of this section, the active and unfrozen certification programs for this specification are for Zigbee
1847
3.0 and Smart Energy. Please see documents [Z13] and [Z14] which track the status of criteria for cluster specification
1848
certification
1849](https://image.slidesharecdn.com/23749237-250519191535-c803f084/85/Zigbee-Cluster-Library-Specification-7th-Zigbee-Alliance-50-320.jpg)
![Zigbee Cluster Library Specification Chapter 2
Zigbee Alliance Document – 075123 Foundation
Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 2-1
CHAPTER 2 FOUNDATION
1850
The Zigbee Cluster Library is made of individual chapters such as this one. See Document Control in the Zigbee
1851
Cluster Library for a list of all chapters and documents. References between chapters are made using a X.Y notation
1852
where X is the chapter and Y is the sub-section within that chapter. References to external documents are contained in
1853
Chapter 1 and are made using [Rn] notation.
1854
2.1 Scope and Purpose
1855
This chapter provides an entry point into the documentation for the Zigbee Cluster Library (ZCL), and specifies the
1856
elements that are general across the entire library.
1857
The ZCL frame structure is specified along with ZCL wide commands used to manipulate attributes from all the
1858
clusters defined throughout the ZCL. In addition, a set of data types is defined that can be used to represent attributes
1859
and a common set of status values returned by commands throughout the ZCL.
1860
An overview is included which lists all the domains specified in the ZCL and the clusters contained therein.
1861
2.2 Cluster Library Overview
1862
The Zigbee Cluster Library (ZCL) is intended to act as a repository for cluster functionality and it is a working library
1863
with regular updates as new functionality is added. A developer constructing a new application SHOULD use the ZCL
1864
to find relevant cluster functionality that can be incorporated into the new application so as not to “re-invent the
1865
wheel”. This also allows applications to be developed with more of an object-oriented style approach.
1866
2.2.1 Architecture and Data Model
1867
Each cluster specification in this document defines an independent functional entity. Each cluster specification is
1868
agnostic regarding functions beyond its purpose and scope, including overall requirements of the application or device.
1869
An application cluster SHOULD have no dependencies outside its application domain. A utility cluster MAY provide
1870
an interface to other layers (e.g. Groups cluster for group addressing).
1871
Please see [Z5] Application Architecture for more details.
1872
2.2.1.1 Cluster Identifier
1873
A cluster identifier SHALL map to a single cluster specification. A cluster identifier also defines the purpose of a
1874
cluster instance. More than one cluster identifier, each with a unique purpose, MAY map to a single more abstract
1875
cluster specification. For example: A Concentration Measurement cluster specification MAY be quite abstract, but
1876
have many mapped cluster identifiers each with a more concrete purpose, such as CO2 measurement in air, by volume.
1877
Please see [Z5] Application Architecture for more details.
1878
2.2.1.2 Extensibility Model
1879
A cluster specification MAY be derived from a base cluster specification. A derived cluster specification SHALL add
1880
specific requirements (attributes, commands, behavior, dependencies, etc) to the base specification. A derived
1881
specification MAY reduce optionality by limiting the optional requirements from the base specification.
1882
All new attribute and command definitions for the derived cluster SHALL be specified in the base cluster specification
1883
as optional, to maintain, in one specification, the identifier name space and communication behavior. Other behavior
1884
and dependencies that are specific to the derived cluster MAY also be specified in the base cluster, if it is deemed
1885
reusable by future derived clusters.
1886](https://image.slidesharecdn.com/23749237-250519191535-c803f084/85/Zigbee-Cluster-Library-Specification-7th-Zigbee-Alliance-51-320.jpg)
![Chapter 2 Zigbee Cluster Library Specification
Foundation Zigbee Alliance Document – 075123
Page 2-2 Copyright 2007-2018, The Zigbee Alliance. All rights reserved.
A derived cluster specification SHALL have the same mandatory requirements as the base cluster specification. A
1887
derived specification MAY have mandatory requirements that are optional in the base specification.
1888
A derived cluster specification defines its own revision (ClusterRevision attribute) that is independent of the base
1889
specification.
1890
Conversely, a base cluster may be defined from an original more specific cluster, which then becomes a derived
1891
cluster.
1892
When considering the addition of one or more clusters to this specification, one SHALL explore the possibility of
1893
either deriving a cluster from an existing cluster, or creating a base cluster to map or derive new and existing cluster
1894
identifiers. This allows the reuse of approved and validated specifications and test plans.
1895
Please see [Z5] Application Architecture for more details.
1896
2.2.1.3 Instance Model
1897
If a device endpoint supports both a derived server cluster identifier and its base server cluster identifier, then both
1898
SHALL represent a single instance and operate as a single entity. This makes it possible to deploy a new device
1899
endpoint with both a base and derived cluster identifiers, which SHALL remain backward compatible to legacy
1900
devices that support only the original cluster identifier.
1901
Cluster identifiers that are mapped to a single base cluster specification, but are defined for distinctly different
1902
purposes, MAY exist together on a device endpoint. If there is no base cluster identifier defined, or no base cluster
1903
identifier exists on the same endpoint, then each cluster identifier SHALL represent a separate instance.
1904
Please see [Z5] Application Architecture for more details.
1905
2.2.1.4 Conformance Model
1906
Specified behavior SHALL be Mandatory (M), Optional (O), or Deprecated (D). Mandatory behavior is usually
1907
dependent on other factors. For example: The mandatory behavior defined in a cluster server specification, is only
1908
mandatory, if the cluster id is discoverable as a server on the device. Attributes and commands MAY also be dependent
1909
on the support of other optional attributes. This is true when a feature of a cluster requires a complete set of attributes
1910
and commands.
1911
Deprecated attributes and commands SHALL be noted as deprecated and description text SHALL be deleted.
1912
2.2.2 Client/Server Model
1913
Throughout the ZCL, a client/server model is employed. This model is illustrated in Figure 2-1.
1914](https://image.slidesharecdn.com/23749237-250519191535-c803f084/85/Zigbee-Cluster-Library-Specification-7th-Zigbee-Alliance-52-320.jpg)
![Zigbee Cluster Library Specification Chapter 2
Zigbee Alliance Document – 075123 Foundation
Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 2-3
Figure 2-1. The ZCL Client Server Model
1915
1916
A cluster is a related collection of commands and attributes, which together define an interface to specific
1917
functionality. Typically, the entity that stores the attributes of a cluster is referred to as the server of that cluster and
1918
an entity that affects or manipulates those attributes is referred to as the client of that cluster. However, if required,
1919
attributes MAY also be present on the client of a cluster.
1920
Commands that allow devices to manipulate attributes, e.g., in this document the read attribute (see 2.5.1) or write
1921
attribute (see 2.5.3) commands, are (typically) sent from a client device and received by the server device. Any
1922
response to those commands, e.g., in this document the read attribute response (see 2.5.2) or the write attribute
1923
response (see 2.5.5 commands), are sent from the server device and received by the client device.
1924
Conversely, the command that facilitates dynamic attribute reporting, i.e., the report attribute command (see 2.5.11)
1925
is (typically) sent from the server device (as typically this is where the attribute data itself is stored) and sent to the
1926
client device that has been bound to the server device.
1927
A type 1 cluster’s primary function is to initiate transactions from the client to the server. For example: An On/Off
1928
client sends commands (data) to the On/Off server. A type 2 cluster’s primary function is to initiate transactions from
1929
the server to the client. For example: A Temperature Measurement server reports to the Temperature Measurement
1930
client. Please see [Z5] Application Architecture for more details.
1931
The clusters supported by an application are identified through the simple descriptor (see [Z1]), specified on each
1932
active endpoint of a device. In the simple descriptor, the application input cluster list SHALL contain the list of server
1933
clusters supported on the device and the application output cluster list SHALL contain the list of client clusters
1934
supported on the device.
1935
2.3 Functional Description
1936
Global requirements for all clusters and commands are described here.
1937
2.3.1 Transmission
1938
ZCL frames are transmitted via the APS sub-layer by issuing the APSDE-DATA.request primitive.
1939
All sub-fields of ZCL frames, including individual bits, that are unspecified, or specified as reserved, SHALL be set
1940
to zero for transmission. This applies to all ZCL frames, including cluster-specific frames. Similarly, all reserved or
1941
unspecified bits of attributes of data type class Bitmap SHALL be set to zero for transmission.
1942
2.3.2 Reception
1943
ZCL frames are received via the APS sub-layer by the reception of the APSDE-DATA.indication primitive.
1944](https://image.slidesharecdn.com/23749237-250519191535-c803f084/85/Zigbee-Cluster-Library-Specification-7th-Zigbee-Alliance-53-320.jpg)
Zigbee Cluster Library Specification 7th Zigbee Alliance
- 1. Zigbee Cluster Library Specification 7th Zigbee Alliance download https://ebookbell.com/product/zigbee-cluster-library- specification-7th-zigbee-alliance-47498474 Explore and download more ebooks at ebookbell.com
- 2. Here are some recommended products that we believe you will be interested in. You can click the link to download. Zigbee Wireless Sensor And Control Network Elahi Atagschwender https://ebookbell.com/product/zigbee-wireless-sensor-and-control- network-elahi-atagschwender-22136222 Zigbee Wireless Networks And Transceivers Shahin Farahani https://ebookbell.com/product/zigbee-wireless-networks-and- transceivers-shahin-farahani-4110180 Zigbee Wireless Networking Pappsc Drew Gislason https://ebookbell.com/product/zigbee-wireless-networking-pappsc-drew- gislason-1629792 Handson Zigbee Implementing 802154 With Microcontrollers Embedded Technology Fred Eady https://ebookbell.com/product/handson-zigbee-implementing-802154-with- microcontrollers-embedded-technology-fred-eady-2426402
- 3. Building Wireless Sensor Networks With Zigbee Xbee Arduino And Processing Robert Faludi https://ebookbell.com/product/building-wireless-sensor-networks-with- zigbee-xbee-arduino-and-processing-robert-faludi-4098288 Ieee 802154 And Zigbee As Enabling Technologies For Lowpower Wireless Systems With Qualityofservice Constraints 1st Edition Stefano Tennina https://ebookbell.com/product/ieee-802154-and-zigbee-as-enabling- technologies-for-lowpower-wireless-systems-with-qualityofservice- constraints-1st-edition-stefano-tennina-4231356 Signal Interference In Wifi And Zigbee Networks 1st Edition Gaotao Shi https://ebookbell.com/product/signal-interference-in-wifi-and-zigbee- networks-1st-edition-gaotao-shi-5675872 Advanced Pic Microcontroller Projects In C From Usb To Zigbee With The Pic 18f Series 1st Edition Dogan Ibrahim https://ebookbell.com/product/advanced-pic-microcontroller-projects- in-c-from-usb-to-zigbee-with-the-pic-18f-series-1st-edition-dogan- ibrahim-1123344 Advanced Pic Microcontroller Projects In C From Usb To Zigbee With The 18f Series Dogan Ibrahim https://ebookbell.com/product/advanced-pic-microcontroller-projects- in-c-from-usb-to-zigbee-with-the-18f-series-dogan-ibrahim-1255354
- 5. Copyright 2007-2018 by the Zigbee Alliance. http://www.zigbee.org All rights reserved. Permission is granted to members of the Zigbee Alliance to reproduce this document for their own use or the use of other Zigbee Alliance members only, provided this notice is included. All other rights reserved. Duplication for sale, or for commercial or for-profit use is strictly prohibited without the prior written consent of the Zigbee Alliance. 1 2 3 Zigbee Cluster Library Specification 4 5 Chapter Document 14-0125 6 Cluster Library 07-5123 Revision 7 7 8 9 10 11 Zigbee Document 075123 Date of release Feb 2018 Sponsored by Zigbee Alliance Accepted by This document has been accepted for release by the Zigbee Alliance Board of Directors. Abstract This document defines the Zigbee Cluster Library. Keywords Zigbee, Application Layer, Data Model, Cluster Library, ZCL, Dotdot Catalog 12
- 6. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 2 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Notice of Use and Disclosure 13 Copyright © Zigbee Alliance, Inc. (1996-2018). All rights Reserved. This information within this document is the 14 property of the Zigbee Alliance and its use and disclosure are restricted. 15 Elements of Zigbee Alliance specifications may be subject to third party intellectual property rights, including without 16 limitation, patent, copyright or trademark rights (such a third party may or may not be a member of Zigbee). Zigbee 17 is not responsible and shall not be held responsible in any manner for identifying or failing to identify any or all such 18 third party intellectual property rights. 19 No right to use any Zigbee name, logo or trademark is conferred herein. Use of any Zigbee name, logo or trademark 20 requires membership in the Zigbee Alliance and compliance with the Zigbee Logo and Trademark Policy and related 21 Zigbee policies. 22 This document and the information contained herein are provided on an “AS IS” basis and Zigbee DISCLAIMS ALL 23 WARRANTIES EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO (A) ANY WARRANTY THAT 24 THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OF THIRD PARTIES 25 (INCLUDING WITHOUT LIMITATION ANY INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT, 26 COPYRIGHT OR TRADEMARK RIGHTS) OR (B) ANY IMPLIED WARRANTIES OF MERCHANTABILITY, 27 FITNESS FOR A PARTICULAR PURPOSE, TITLE OR NONINFRINGEMENT. IN NO EVENT WILL ZIGBEE 28 BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF BUSINESS, LOSS OF USE OF DATA, INTERRUPTION 29 OF BUSINESS, OR FOR ANY OTHER DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTIAL, 30 PUNITIVE OR CONSEQUENTIAL DAMAGES OF ANY KIND, IN CONTRACT OR IN TORT, IN 31 CONNECTION WITH THIS DOCUMENT OR THE INFORMATION CONTAINED HEREIN, EVEN IF 32 ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. All Company, brand and product names may 33 be trademarks that are the sole property of their respective owners. 34 The above notice and this paragraph must be included on all copies of this document that are made. 35
- 7. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 3 Participants 36 The following is a list of Zigbee members who contributed to this document: 37 Cam Williams - Chair of the Foundation Working Group and ZCL Editor 38 Rob Alexander Jared Lemke Shane Almeida Christopher Leidigh Casey Anderson Yingbo Li Skip Ashton Marco Naeve Wally Barnum Juan Agui Martin Alex Chu Christian P. Garcia Ettore Colicchio Jeff Mathews Jeff Cooper Tony Mauro Damon Corbin Leslie Mulder John Cowburn Luca Negri Robert Cragie Ivan O’Neill Jonathan Cressman Isaac Pinhas Tim Gillman Andrea Ranalli Drew Gislason Jonas Riska Ezra Hale Zachary Smith Jesper Haee Robby Simpson Robert Hall Sumit Singh Jon Harros David Smith Jim Hartman Matt Smith Arasch Honarbacht Michael Stuber Ted Humpal Don Sturek Phil Jamieson Mads Westergreen William Keith Urban Wicklander Larry Kohrmann Cam Williams Tom Klein Ian Winterburn John Knuth Kenny York Cristian Kuster Walter Young Zin Kyaw Juan Agui Martin Gary Lee Jeff Mathews 39
- 8. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 4 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Document Control 40 The Zigbee Cluster Library is made of individual chapters such as this one. See Chapter 1 for the list of all chapters. 41 References between chapters are made using a X.Y notation where X is the chapter and Y is the sub-section within that 42 chapter. References to external documents are contained in Chapter 1 and are made using [Rn] notation. 43 An update to any of these chapters will be reflected in an update to the source document list below. 44 Chapter 1 – Introduction Document 14-0125-13 Chapter 2 – Foundation Document 14-0126-16 Chapter 3 – General Document 14-0127-20 Chapter 4 – Measurement and Sensing Document 14-0128-11 Chapter 5 – Lighting Document 14-0129-15 Chapter 6 – HVAC Document 14-0130-12 Chapter 7 – Closures Document 14-0131-15 Chapter 8 – Security and Safety Document 14-0132-13 Chapter 9 – Protocol Interfaces Document 14-0133-08 Chapter 10 – Smart Energy Document 14-0134-11 Chapter 11 – Over the Air Upgrades Document 14-0135-15 Chapter 12 – Telecommunications Document 14-0136-10 Chapter 13 – Commissioning Document 14-0137-13 Chapter 14 – Retail Services Document 14-0138-08 Chapter 15 – Appliances Document 14-0139-12 Approved Errata for this ZCL revision Document 17-2017 Source files for drawings in this ZCL revision Document 14-0141-00 45
- 9. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 5 Document History 46 Rev Date Comments 00 11-Jul-2007 Document created 01 19-Oct-2007 First release 02 29-May-2008 Added Commissioning Cluster from 064699r12. • Added material from annex of CBA Profile 053516r10 • Structured types (arrays etc) and structured R/W commands • Input / Output / Value clusters (Basic) • Input / Output / Value clusters (BACnet Regular & Extended) • Generic Tunnel cluster • BACnet Protocol Tunnel cluster Made changes to the Color Control cluster re. CCB 870 • Added x,y control according to CIE 1931 Color Space Added long data types (as required by SE profile 075356r12 etc) • 40-64bit integers etc, long strings Made changes to time cluster (as required by CCBs 890, 914) • Added time zone & DST + UTCtime type Made minor changes as requested by the following CCBs • 627, 714, 781, 853, 854, 867, 878, 879, 880, 881, 883, 893, 897, 898, 919, 958 03 18-Sep-2009 The following changes were made to the Editor’s Copy of the ZCL, 095254r00. Made change to the Basic cluster, re CCB comment #606 • Added optional attribute DisableLocalConfig. Updated Pressure Measurement cluster re CCB comment #961 • Added extra attributes to allow wider range of pressure. Updated Color Control cluster re CCB comment #1006 • Clarification of stop commands, color mode switching etc. Made changes to RSSI Location cluster, re CCB comment #1053 • Added mechanism for centralized location. Made change to Generic Tunnel cluster, re CCB comment #1068 • Added extra fields to Match Protocol Address Response Command 24-Dec-2009 Made minor changes and clarifications re the following CCBs • 960, 1001, 1004, 1061, 1097. • Added Door Lock cluster. Updated Occupancy Sensor re CCB comments 1092, 1093, 1094 04 2010 CCB 1174: Fixed references CCB 1176: Added new status codes CCB 1202: Corrected default value in thermostat cluster Apr-2012 CCB 1381: Default Response clarification
- 10. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 6 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Rev Date Comments CCB 1260: Generic Tune l cluster clarification CCB 1377: Commissioning Cluster minor change CCB 1146: Report Attributes without Configuration CCB 1169: Dependencies on Optional Attributes CCB 1379: Generic Tunnel ProtocolAddress attribute ReadOnly Option CCB 1420: Time cluster ESI bit CCB 1390: Reporting destination clarification 05 18-Mar-2015 Move to individual chapters Added all approved Clusters from other Application Specifications Included CCBs Editorial cleanup of document 06 14-Jan-2016 Chapter 1: New terms for Zigbee 3.0 Chapter 2: Zigbee 3.0 & Application Architecture changes Broadcast Endpoint Rules Global discovery commands from ZHA 1.2 CCB 1277 1319 1444 1485 1505 1578 1923 2029 2092 Chapter 3: ZCLVersion attribute of Basic cluster is 0x02 CCB 1480 1555 1647 1745 1809 1815 1822 1833 2100 Chapter 4: CCB 2048 2049 2050 2055 Chapter 5: ZLL 1.0 errata CCB 2028 2106 Chapter 6: CCB 1485 1823 Chapter 7: CCB 1811 1812 1821 1994 1995 1996 1997 2086 2094 2095 2096 2097 Chapter 8: ZHA 1.2 & 1.2.1 & errata CCB 1977 2044 2045 Chapter 11: CCB 1374 1470 1477 1540 1594 2046 2056 Chapter 15: CCB 1893 07 Jan-2018 Removed the extraneous word “ZigBee” to describe items. CCB 2288 Chapter 1: reference for Manufacture Code database Chapter 2: clarified cluster Instance Model CCB 2327 2266 2338 2213 2318 Define Deprecation New data type: Fixed ASCII Chapter 3: Level Control cluster State Change Table New Basic attributes; ZCLVersion is 0x03 Transition time to Recall Scene NFR Quality of Goods clusters: PWM, Level ZLO 1.0 changes to Level Control for Lighting CCB 1499 1584 1775 2085 2147 2197 2211 2212 2229 2281 2289 CCB 2329 2330 2333 2309 2319 Chapter 4: NFR Quality of Goods Measurement clusters: Wind Speed, Concentration, pH, Electrical Conductivity
- 11. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 7 Rev Date Comments Physical Contact Occupancy CCB 2167 2236 2241 2370 Chapter 5: ZLO 1.0; Options Attribute; CCB 2085 2104 2124 2193 2230 2393 Deprecate some attributes Chapter 6: CCB 1981 2186 2249 2250 2251 Thermostat Setback Chapter 7: CCB 2328 2340 2316 Chapter 8: CCB 2341 2350 2352 Door-Window Position feature Chapter 10: CCB 2288 CCB 2339 Chapter 11: alternative Image Activation Policies; 128-bit Crypto suite CCB 2019 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 CCB 2296 2307 2315 2339 2342 2398 2464 Chapter 13: Touchlink Profile Interop bit; CCB 2115 2105 Chapter 15: Cleaned up ranges to follow reserved value rules 47 48
- 12. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 8 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. TABLE OF CONTENTS 49 Zigbee Cluster Library Specification .............................................................................................1 50 Notice of Use and Disclosure..............................................................................................................2 51 Participants.........................................................................................................................................3 52 Document Control ..............................................................................................................................4 53 Document History ..............................................................................................................................5 54 Table of Contents......................................................................................................................................8 55 List of Figures.........................................................................................................................................19 56 List of Tables ..........................................................................................................................................28 57 Chapter 1 Introduction...................................................................................................................... 1-1 58 1.1 Scope and Purpose ................................................................................................................. 1-1 59 1.2 Acronyms and Abbreviations ................................................................................................. 1-1 60 1.3 Definitions............................................................................................................................. 1-4 61 1.4 Conformance Levels .............................................................................................................. 1-5 62 1.5 References............................................................................................................................. 1-5 63 1.5.1 Zigbee Alliance Documents........................................................................................ 1-5 64 1.5.2 International Standards Documents............................................................................. 1-5 65 1.5.3 National Standards Documents................................................................................... 1-6 66 1.5.4 IEEE Documents........................................................................................................ 1-6 67 1.5.5 ASHRAE Documents................................................................................................. 1-6 68 1.5.6 Health Care Documents.............................................................................................. 1-6 69 1.5.7 Other Documents....................................................................................................... 1-7 70 1.6 Conventions........................................................................................................................... 1-7 71 1.6.1 Enumerations and Reserved Values............................................................................ 1-7 72 1.6.2 Reserved Bit Fields.................................................................................................... 1-7 73 1.6.3 Number Format.......................................................................................................... 1-7 74 1.7 Testing, Validation and Certification ...................................................................................... 1-8 75 Chapter 2 Foundation........................................................................................................................ 2-1 76 2.1 Scope and Purpose ................................................................................................................. 2-1 77 2.2 Cluster Library Overview....................................................................................................... 2-1 78 2.2.1 Architecture and Data Model...................................................................................... 2-1 79 2.2.2 Client/Server Model................................................................................................... 2-2 80 2.3 Functional Description........................................................................................................... 2-3 81 2.3.1 Transmission.............................................................................................................. 2-3 82 2.3.2 Reception................................................................................................................... 2-3 83 2.3.3 Manufacturer Specific Extensions .............................................................................. 2-4 84 2.3.4 Attributes................................................................................................................... 2-5 85 2.3.5 Persistent Data ........................................................................................................... 2-7 86 2.4 Command Frame Formats...................................................................................................... 2-7 87 2.4.1 General ZCL Frame Format ....................................................................................... 2-7 88 2.5 General Command Frames..................................................................................................... 2-9 89 2.5.1 Read Attributes Command ........................................................................................2-10 90 2.5.2 Read Attributes Response Command.........................................................................2-11 91 2.5.3 Write Attributes Command........................................................................................2-13 92 2.5.4 Write Attributes Undivided Command.......................................................................2-15 93 2.5.5 Write Attributes Response Command........................................................................2-15 94 2.5.6 Write Attributes No Response Command...................................................................2-16 95 2.5.7 Configure Reporting Command.................................................................................2-17 96 2.5.8 Configure Reporting Response Command .................................................................2-20 97
- 13. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 9 2.5.9 Read Reporting Configuration Command ..................................................................2-21 98 2.5.10 Read Reporting Configuration Response Command...................................................2-22 99 2.5.11 Report Attributes Command......................................................................................2-24 100 2.5.12 Default Response Command .....................................................................................2-27 101 2.5.13 Discover Attributes Command...................................................................................2-28 102 2.5.14 Discover Attributes Response Command...................................................................2-29 103 2.5.15 Read Attributes Structured Command........................................................................2-30 104 2.5.16 Write Attributes Structured Command.......................................................................2-31 105 2.5.17 Write Attributes Structured Response Command .......................................................2-34 106 2.5.18 Discover Commands Received Command .................................................................2-35 107 2.5.19 Discover Commands Received Response...................................................................2-36 108 2.5.20 Discover Commands Generated Command................................................................2-37 109 2.5.21 Discover Commands Generated Response .................................................................2-38 110 2.5.22 Discover Attributes Extended Command ...................................................................2-38 111 2.5.23 Discover Attributes Extended Response Command....................................................2-39 112 2.6 Addressing, Types and Enumerations....................................................................................2-41 113 2.6.1 Addressing................................................................................................................2-41 114 2.6.2 Data Types................................................................................................................2-43 115 2.6.3 Status Enumerations..................................................................................................2-52 116 Chapter 3 General............................................................................................................................. 3-1 117 3.1 General Description ............................................................................................................... 3-1 118 3.1.1 Introduction ............................................................................................................... 3-1 119 3.1.2 Cluster List ................................................................................................................ 3-1 120 3.2 Basic ..................................................................................................................................... 3-6 121 3.2.1 Overview................................................................................................................... 3-6 122 3.2.2 Server ........................................................................................................................ 3-6 123 3.2.3 Client........................................................................................................................3-17 124 3.3 Power Configuration.............................................................................................................3-17 125 3.3.1 Overview..................................................................................................................3-17 126 3.3.2 Server .......................................................................................................................3-17 127 3.3.3 Client........................................................................................................................3-26 128 3.4 Device Temperature Configuration........................................................................................3-26 129 3.4.1 Overview..................................................................................................................3-26 130 3.4.2 Server .......................................................................................................................3-27 131 3.4.3 Client........................................................................................................................3-29 132 3.5 Identify.................................................................................................................................3-29 133 3.5.1 Overview..................................................................................................................3-29 134 3.5.2 Server .......................................................................................................................3-30 135 3.5.3 Client........................................................................................................................3-33 136 3.6 Groups..................................................................................................................................3-33 137 3.6.1 Overview..................................................................................................................3-33 138 3.6.2 Server .......................................................................................................................3-35 139 3.6.3 Client........................................................................................................................3-42 140 3.7 Scenes ..................................................................................................................................3-42 141 3.7.1 Overview..................................................................................................................3-42 142 3.7.2 Server .......................................................................................................................3-42 143 3.7.3 Client........................................................................................................................3-56 144 3.8 On/Off..................................................................................................................................3-56 145 3.8.1 Overview..................................................................................................................3-56 146 3.8.2 Server .......................................................................................................................3-56 147 3.8.3 Client........................................................................................................................3-63 148 3.9 On/Off Switch Configuration ................................................................................................3-64 149 3.9.1 Overview..................................................................................................................3-64 150 3.9.2 Server .......................................................................................................................3-64 151 3.9.3 Client........................................................................................................................3-66 152
- 14. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 10 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. 3.10 Level ....................................................................................................................................3-66 153 3.10.1 Overview..................................................................................................................3-66 154 3.10.2 Server .......................................................................................................................3-67 155 3.10.3 Client........................................................................................................................3-76 156 3.11 Alarms..................................................................................................................................3-76 157 3.11.1 Overview..................................................................................................................3-76 158 3.11.2 Server .......................................................................................................................3-77 159 3.11.3 Client........................................................................................................................3-80 160 3.12 Time.....................................................................................................................................3-80 161 3.12.1 Overview..................................................................................................................3-80 162 3.12.2 Server .......................................................................................................................3-81 163 3.12.3 Client........................................................................................................................3-84 164 3.13 RSSI Location.......................................................................................................................3-84 165 3.13.1 Overview..................................................................................................................3-84 166 3.13.2 Server .......................................................................................................................3-86 167 3.13.3 Client........................................................................................................................3-99 168 3.14 Input, Output and Value Clusters...........................................................................................3-99 169 3.14.1 Overview..................................................................................................................3-99 170 3.14.2 Analog Input (Basic).................................................................................................3-99 171 3.14.3 Analog Output (Basic).............................................................................................3-101 172 3.14.4 Analog Value (Basic)..............................................................................................3-102 173 3.14.5 Binary Input (Basic)................................................................................................3-104 174 3.14.6 Binary Output (Basic) .............................................................................................3-105 175 3.14.7 Binary Value (Basic)...............................................................................................3-107 176 3.14.8 Multistate Input (Basic)...........................................................................................3-108 177 3.14.9 Multistate Output (Basic) ........................................................................................3-110 178 3.14.10 Multistate Value (Basic)..........................................................................................3-111 179 3.14.11 Attribute Descriptions .............................................................................................3-112 180 3.15 Diagnostics.........................................................................................................................3-149 181 3.15.1 Overview................................................................................................................3-149 182 3.15.2 Server .....................................................................................................................3-149 183 3.15.3 Client......................................................................................................................3-154 184 3.16 Poll Control ........................................................................................................................3-154 185 3.16.1 Overview................................................................................................................3-154 186 3.16.2 Terminology...........................................................................................................3-155 187 3.16.3 Commissioning Process ..........................................................................................3-155 188 3.16.4 Server .....................................................................................................................3-155 189 3.16.5 Client......................................................................................................................3-158 190 3.16.6 Poll Control Cluster Sequence Diagram...................................................................3-161 191 3.17 Power Profile......................................................................................................................3-163 192 3.17.1 Overview................................................................................................................3-163 193 3.17.2 References ..............................................................................................................3-164 194 3.17.3 General Description ................................................................................................3-164 195 3.17.4 Server Attributes.....................................................................................................3-165 196 3.17.5 Server Commands Received....................................................................................3-166 197 3.17.6 Server Commands Generated ..................................................................................3-174 198 3.17.7 Client Attributes......................................................................................................3-185 199 3.17.8 Client Commands Received.....................................................................................3-185 200 3.17.9 Client Commands Generated...................................................................................3-185 201 3.17.10 Example of Device Interactions Using the Power Profile (Informative Section)........3-185 202 3.18 Meter Identification.............................................................................................................3-188 203 3.18.1 Overview................................................................................................................3-188 204 3.18.2 Server .....................................................................................................................3-189 205 3.18.3 Client......................................................................................................................3-192 206 3.19 Level Control for Lighting ..................................................................................................3-192 207 3.19.1 Overview................................................................................................................3-192 208
- 15. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 11 3.19.2 Server .....................................................................................................................3-193 209 3.19.3 Client......................................................................................................................3-195 210 3.19.4 State Change Table for Lighting..............................................................................3-195 211 3.20 Pulse Width Modulation......................................................................................................3-197 212 3.20.1 Overview................................................................................................................3-197 213 3.20.2 Server .....................................................................................................................3-197 214 3.20.3 Client......................................................................................................................3-198 215 Chapter 4 Measurement and Sensing................................................................................................. 4-1 216 4.1 General Description ............................................................................................................... 4-1 217 4.1.1 Introduction ............................................................................................................... 4-1 218 4.1.2 Cluster List ................................................................................................................ 4-1 219 4.1.3 Measured Value......................................................................................................... 4-4 220 4.2 Illuminance Measurement ...................................................................................................... 4-5 221 4.2.1 Overview................................................................................................................... 4-5 222 4.2.2 Server ........................................................................................................................ 4-5 223 4.2.3 Client......................................................................................................................... 4-7 224 4.3 Illuminance Level Sensing ..................................................................................................... 4-7 225 4.3.1 Overview................................................................................................................... 4-7 226 4.3.2 Server ........................................................................................................................ 4-7 227 4.3.3 Client......................................................................................................................... 4-9 228 4.4 Temperature Measurement....................................................................................................4-10 229 4.4.1 Overview..................................................................................................................4-10 230 4.4.2 Server .......................................................................................................................4-10 231 4.4.3 Client........................................................................................................................4-12 232 4.5 Pressure Measurement...........................................................................................................4-12 233 4.5.1 Overview..................................................................................................................4-12 234 4.5.2 Server .......................................................................................................................4-12 235 4.5.3 Client........................................................................................................................4-15 236 4.6 Flow Measurement................................................................................................................4-15 237 4.6.1 Overview..................................................................................................................4-15 238 4.6.2 Server .......................................................................................................................4-16 239 4.6.3 Client........................................................................................................................4-17 240 4.7 Water Content Measurement .................................................................................................4-17 241 4.7.1 Overview..................................................................................................................4-17 242 4.7.2 Server .......................................................................................................................4-18 243 4.7.3 Client........................................................................................................................4-19 244 4.8 Occupancy Sensing...............................................................................................................4-19 245 4.8.1 Overview..................................................................................................................4-19 246 4.8.2 Server .......................................................................................................................4-19 247 4.8.3 Client........................................................................................................................4-23 248 4.9 Electrical Measurement.........................................................................................................4-23 249 4.9.1 Overview..................................................................................................................4-23 250 4.9.2 Server .......................................................................................................................4-24 251 4.10 Electrical Conductivity Measurement....................................................................................4-46 252 4.10.1 Overview..................................................................................................................4-46 253 4.10.2 Server .......................................................................................................................4-46 254 4.10.3 Client........................................................................................................................4-47 255 4.11 pH Measurement...................................................................................................................4-47 256 4.11.1 Overview..................................................................................................................4-47 257 4.11.2 Server .......................................................................................................................4-48 258 4.11.3 Client........................................................................................................................4-49 259 4.12 Wind Speed Measurement.....................................................................................................4-49 260 4.12.1 Overview..................................................................................................................4-49 261 4.12.2 Server .......................................................................................................................4-49 262 4.12.3 Client........................................................................................................................4-50 263
- 16. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 12 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. 4.13 Concentration Measurement..................................................................................................4-50 264 4.13.1 Overview..................................................................................................................4-50 265 4.13.2 Server .......................................................................................................................4-53 266 4.13.3 Client........................................................................................................................4-53 267 Chapter 5 Lighting............................................................................................................................ 5-1 268 5.1 General Description ............................................................................................................... 5-1 269 5.1.1 Introduction ............................................................................................................... 5-1 270 5.1.2 Terms ........................................................................................................................ 5-1 271 5.1.3 Cluster List ................................................................................................................ 5-1 272 5.2 Color Control Cluster............................................................................................................. 5-2 273 5.2.1 Overview................................................................................................................... 5-2 274 5.2.2 Server ........................................................................................................................ 5-3 275 5.2.3 Client........................................................................................................................5-35 276 5.3 Ballast Configuration Cluster ................................................................................................5-35 277 5.3.1 Overview..................................................................................................................5-35 278 5.3.2 Server .......................................................................................................................5-35 279 5.3.3 Client........................................................................................................................5-40 280 5.3.4 The Dimming Light Curve ........................................................................................5-40 281 Chapter 6 HVAC .............................................................................................................................. 6-1 282 6.1 General Description ............................................................................................................... 6-1 283 6.1.1 Introduction ............................................................................................................... 6-1 284 6.1.2 Terms ........................................................................................................................ 6-1 285 6.1.3 Cluster List ................................................................................................................ 6-1 286 6.2 Pump Configuration and Control............................................................................................ 6-3 287 6.2.1 Overview................................................................................................................... 6-3 288 6.2.2 Server ........................................................................................................................ 6-3 289 6.2.3 Client........................................................................................................................6-13 290 6.3 Thermostat............................................................................................................................6-13 291 6.3.1 Overview..................................................................................................................6-13 292 6.3.2 Server .......................................................................................................................6-14 293 6.3.3 Client........................................................................................................................6-37 294 6.4 Fan Control...........................................................................................................................6-37 295 6.4.1 Overview..................................................................................................................6-37 296 6.4.2 Server .......................................................................................................................6-37 297 6.4.3 Client........................................................................................................................6-38 298 6.5 Dehumidification Control......................................................................................................6-39 299 6.5.1 Overview..................................................................................................................6-39 300 6.5.2 Server .......................................................................................................................6-39 301 6.5.3 Client........................................................................................................................6-41 302 6.6 Thermostat User Interface Configuration...............................................................................6-42 303 6.6.1 Overview..................................................................................................................6-42 304 6.6.2 Server .......................................................................................................................6-42 305 6.6.3 Client........................................................................................................................6-45 306 Chapter 7 Closures............................................................................................................................ 7-1 307 7.1 General Description ............................................................................................................... 7-1 308 7.1.1 Introduction ............................................................................................................... 7-1 309 7.1.2 Cluster List ................................................................................................................ 7-1 310 7.2 Shade Configuration .............................................................................................................. 7-2 311 7.2.1 Overview................................................................................................................... 7-2 312 7.2.2 Server ........................................................................................................................ 7-3 313 7.2.3 Client......................................................................................................................... 7-5 314 7.3 Door Lock ............................................................................................................................. 7-5 315 7.3.1 Overview................................................................................................................... 7-5 316
- 17. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 13 7.3.2 Server ........................................................................................................................ 7-5 317 7.3.3 Client.........................................................................................................................7-49 318 7.4 Window Covering.................................................................................................................7-49 319 7.4.1 Overview..................................................................................................................7-49 320 7.4.2 Server .......................................................................................................................7-49 321 7.4.3 Client........................................................................................................................7-58 322 Chapter 8 Security and Safety ........................................................................................................... 8-1 323 8.1 General Description ............................................................................................................... 8-1 324 8.1.1 Introduction ............................................................................................................... 8-1 325 8.1.2 Cluster List ................................................................................................................ 8-1 326 8.2 IAS Zone............................................................................................................................... 8-2 327 8.2.1 Overview................................................................................................................... 8-2 328 8.2.2 Server ........................................................................................................................ 8-3 329 8.2.3 Client........................................................................................................................8-13 330 8.3 IAS ACE ..............................................................................................................................8-13 331 8.3.1 Overview..................................................................................................................8-13 332 8.3.2 Server .......................................................................................................................8-13 333 8.3.3 Client........................................................................................................................8-27 334 8.4 IAS WD................................................................................................................................8-27 335 8.4.1 Overview..................................................................................................................8-27 336 8.4.2 Server .......................................................................................................................8-28 337 8.4.3 Client........................................................................................................................8-32 338 Chapter 9 Protocol Interfaces ............................................................................................................ 9-1 339 9.1 General Description ............................................................................................................... 9-1 340 9.1.1 Introduction ............................................................................................................... 9-1 341 9.1.2 Cluster List ................................................................................................................ 9-1 342 9.2 Generic Tunnel ...................................................................................................................... 9-3 343 9.2.1 Overview................................................................................................................... 9-3 344 9.2.2 Server ........................................................................................................................ 9-3 345 9.2.3 Client......................................................................................................................... 9-6 346 9.3 BACnet Protocol Tunnel........................................................................................................ 9-6 347 9.3.1 Overview................................................................................................................... 9-6 348 9.3.2 Server ........................................................................................................................ 9-6 349 9.3.3 Client......................................................................................................................... 9-7 350 9.4 BACnet Input, Output and Value Clusters .............................................................................. 9-8 351 9.4.1 Overview................................................................................................................... 9-8 352 9.4.2 Analog Input (BACnet Regular)................................................................................. 9-8 353 9.4.3 Analog Input (BACnet Extended)............................................................................... 9-9 354 9.4.4 Analog Output (BACnet Regular)..............................................................................9-11 355 9.4.5 Analog Output (BACnet Extended) ...........................................................................9-12 356 9.4.6 Analog Value (BACnet Regular)...............................................................................9-13 357 9.4.7 Analog Value (BACnet Extended).............................................................................9-14 358 9.4.8 Binary Input (BACnet Regular).................................................................................9-16 359 9.4.9 Binary Input (BACnet Extended)...............................................................................9-17 360 9.4.10 Binary Output (BACnet Regular) ..............................................................................9-19 361 9.4.11 Binary Output (BACnet Extended)............................................................................9-20 362 9.4.12 Binary Value (BACnet Regular)................................................................................9-21 363 9.4.13 Binary Value (BACnet Extended)..............................................................................9-23 364 9.4.14 Multistate Input (BACnet Regular)............................................................................9-24 365 9.4.15 Multistate Input (BACnet Extended)..........................................................................9-25 366 9.4.16 Multistate Output (BACnet Regular) .........................................................................9-26 367 9.4.17 Multistate Output (BACnet Extended).......................................................................9-28 368 9.4.18 Multistate Value (BACnet Regular)...........................................................................9-29 369 9.4.19 Multistate Value (BACnet Extended).........................................................................9-30 370
- 18. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 14 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. 9.4.20 Attributes of BACnet Regular Clusters......................................................................9-31 371 9.4.21 Attributes of BACnet Extended Clusters....................................................................9-33 372 9.5 ISO 7818 Protocol Tunnel.....................................................................................................9-35 373 9.5.1 Scope and Purpose ....................................................................................................9-35 374 9.5.2 Definitions................................................................................................................9-35 375 9.5.3 General Description ..................................................................................................9-36 376 9.5.4 Overview..................................................................................................................9-36 377 9.5.5 Server .......................................................................................................................9-36 378 9.5.6 Client........................................................................................................................9-39 379 9.6 Partition................................................................................................................................9-39 380 9.6.1 Scope and Purpose ....................................................................................................9-39 381 9.6.2 Introduction ..............................................................................................................9-39 382 9.6.3 Server .......................................................................................................................9-42 383 9.6.4 Client........................................................................................................................9-48 384 9.6.5 General Use of Partition Cluster ................................................................................9-48 385 9.7 11073 Protocol Tunnel..........................................................................................................9-49 386 9.7.1 Overview..................................................................................................................9-49 387 9.7.2 Server .......................................................................................................................9-50 388 9.7.3 Client........................................................................................................................9-57 389 Chapter 10 Smart Energy.................................................................................................................10-1 390 10.1 General Description ..............................................................................................................10-1 391 10.1.1 Introduction ..............................................................................................................10-1 392 10.1.2 Cluster List ...............................................................................................................10-1 393 10.2 Price......................................................................................................................................10-1 394 10.2.1 Overview..................................................................................................................10-1 395 10.2.2 Server .......................................................................................................................10-2 396 10.2.3 Client......................................................................................................................10-22 397 10.2.4 Application Guidelines............................................................................................10-24 398 10.3 DemandResponse andLoadControl......................................................................................10-26 399 10.3.1 Overview................................................................................................................10-26 400 10.3.2 Server .....................................................................................................................10-26 401 10.3.3 Client......................................................................................................................10-33 402 10.3.4 Application Guidelines............................................................................................10-38 403 10.3.5 Rules and Guidelines for Overlapping Events..........................................................10-42 404 10.4 Metering.............................................................................................................................10-49 405 10.4.1 Overview................................................................................................................10-49 406 10.4.2 Server .....................................................................................................................10-53 407 10.4.3 Metering Application Guidelines.............................................................................10-87 408 10.5 Messaging ..........................................................................................................................10-89 409 10.5.1 Overview................................................................................................................10-89 410 10.5.2 Server .....................................................................................................................10-89 411 10.5.3 Client......................................................................................................................10-92 412 10.5.4 Application Guidelines............................................................................................10-94 413 10.6 Tunneling ...........................................................................................................................10-94 414 10.6.1 Overview................................................................................................................10-95 415 10.6.2 Server .....................................................................................................................10-99 416 10.6.3 Client....................................................................................................................10-109 417 10.7 Key Establishment ............................................................................................................10-109 418 10.7.1 ScopeandPurpose .................................................................................................10-109 419 10.7.2 General Description ..............................................................................................10-109 420 10.7.3 Cluster List............................................................................................................10-112 421 10.7.4 Application Implementation ..................................................................................10-123 422 10.7.5 Key Establishment Test Vectors ............................................................................10-129 423 Chapter 11 Over-the-Air Upgrade....................................................................................................11-1 424
- 19. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 15 11.1 Introduction ..........................................................................................................................11-1 425 11.1.1 Purpose.....................................................................................................................11-1 426 11.1.2 Scope........................................................................................................................11-1 427 11.1.3 Terminology.............................................................................................................11-1 428 11.2 General Description ..............................................................................................................11-1 429 11.2.1 Introduction ..............................................................................................................11-1 430 11.2.2 Cluster List ...............................................................................................................11-2 431 11.3 OTA Upgrade.......................................................................................................................11-3 432 11.3.1 Overview..................................................................................................................11-3 433 11.3.2 Security ....................................................................................................................11-4 434 11.3.3 Image Verification ....................................................................................................11-4 435 11.3.4 Image Transport........................................................................................................11-5 436 11.3.5 Image Signature........................................................................................................11-5 437 11.3.6 Image Integrity Code.................................................................................................11-5 438 11.4 OTA File Format ..................................................................................................................11-6 439 11.4.1 General Structure......................................................................................................11-6 440 11.4.2 OTA Header Format .................................................................................................11-6 441 11.4.3 Sub-element Format................................................................................................11-11 442 11.4.4 Tag Identifiers.........................................................................................................11-11 443 11.4.5 Crypto Suites ..........................................................................................................11-12 444 11.4.6 ECDSA Signature Sub-element (Crypto Suite 1) .....................................................11-12 445 11.4.7 ECDSA Signing Certificate Sub-element.................................................................11-12 446 11.4.8 Image Integrity Code Sub-element...........................................................................11-13 447 11.4.9 ECDSA Signature Sub-element (Crypto Suite 2) .....................................................11-13 448 11.4.10 ECDSA Signing Certificate Sub-element (Crypto Suite 2) .......................................11-14 449 11.5 OTA File Naming...............................................................................................................11-14 450 11.6 Signatures...........................................................................................................................11-14 451 11.7 ECDSA Signature Calculation.............................................................................................11-14 452 11.7.1 ECDSA Signature Verification................................................................................11-15 453 11.7.2 Image Integrity Code...............................................................................................11-16 454 11.8 Discovery of the Upgrade Server.........................................................................................11-17 455 11.8.1 Server and Client ....................................................................................................11-18 456 11.8.2 Sleepy Devices........................................................................................................11-18 457 11.9 Dependencies......................................................................................................................11-18 458 11.10 OTA Cluster Attributes..................................................................................................11-19 459 11.10.1 UpgradeServerID Attribute .....................................................................................11-20 460 11.10.2 FileOffset Attribute.................................................................................................11-20 461 11.10.3 CurrentFileVersion Attribute...................................................................................11-20 462 11.10.4 CurrentZigBeeStackVersion Attribute .....................................................................11-20 463 11.10.5 DownloadedFileVersion Attribute...........................................................................11-20 464 11.10.6 DownloadedZigBeeStackVersion Attribute .............................................................11-20 465 11.10.7 ImageUpgradeStatus Attribute.................................................................................11-20 466 11.10.8 Manufacturer ID Attribute.......................................................................................11-21 467 11.10.9 Image Type ID Attribute .........................................................................................11-21 468 11.10.10...............................................................................MinimumBlockPeriod Attribute 469 11-21 470 11.10.11............................................................................................Image Stamp Attribute 471 11-22 472 11.10.12...........................................................................UpgradeActivationPolicy Attribute 473 11-22 474 11.10.13..............................................................................UpgradeTimeoutPolicy Attribute 475 11-22 476 11.11 OTA Cluster Parameters ................................................................................................11-23 477 11.11.1 QueryJitter Parameter..............................................................................................11-24 478 11.11.2 DataSize Parameter.................................................................................................11-24 479 11.11.3 OTAImageData Parameter ......................................................................................11-24 480
- 20. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 16 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. 11.11.4 CurrentTime and UpgradeTime/RequestTime Parameters........................................11-24 481 11.12 OTA Upgrade Diagram..................................................................................................11-26 482 11.13 Command Frames..........................................................................................................11-27 483 11.13.1 OTA Cluster Command Identifiers..........................................................................11-27 484 11.13.2 OTA Cluster Status Codes.......................................................................................11-28 485 11.13.3 Image Notify Command..........................................................................................11-28 486 11.13.4 Query Next Image Request Command.....................................................................11-31 487 11.13.5 Query Next Image Response Command...................................................................11-33 488 11.13.6 Image Block Request Command..............................................................................11-35 489 11.13.7 Image Page Request Command ...............................................................................11-37 490 11.13.8 Image Block Response Command ...........................................................................11-40 491 11.13.9 Upgrade End Request Command.............................................................................11-44 492 11.13.10.......................................................... Query Device Specific File Request Command 493 11-48 494 11.13.11........................................................ Query Device Specific File Response Command 495 11-49 496 11.14 Multiple Files Required for a Bootload...........................................................................11-51 497 11.14.1 Single OTA File with multiple sub-elements............................................................11-51 498 11.14.2 Separate OTA Files Upgraded Independently ..........................................................11-51 499 11.14.3 Multiple OTA Files Dependent on Each Other.........................................................11-52 500 11.15 OTA Upgrade Cluster Management ...............................................................................11-52 501 11.15.1 Query Upgrade Status .............................................................................................11-52 502 11.15.2 Query Downloaded ZigBee Stack and File Versions................................................11-52 503 11.15.3 Rate Limiting..........................................................................................................11-53 504 11.15.4 Current Time, Request Time, and MinimumBlockPeriod .........................................11-54 505 11.16 OTA Upgrade Process....................................................................................................11-55 506 11.17 Application Standard Specific Decisions ........................................................................11-55 507 11.17.1 SE Profile Standard: OTA Upgrade from SE 1.x to SE 2.0.......................................11-56 508 11.18 OTA Upgrade Recovery.................................................................................................11-56 509 Chapter 12 Telecommunication .......................................................................................................12-1 510 12.1 General Description ..............................................................................................................12-1 511 12.1.1 Introduction ..............................................................................................................12-1 512 12.1.2 Cluster List ...............................................................................................................12-1 513 12.2 Information...........................................................................................................................12-1 514 12.2.1 Scope and Purpose ....................................................................................................12-1 515 12.2.2 Cluster List ...............................................................................................................12-2 516 12.2.3 Overview..................................................................................................................12-4 517 12.2.4 Server .......................................................................................................................12-4 518 12.2.5 Client......................................................................................................................12-21 519 12.2.6 Payload Formats for Contents Data..........................................................................12-21 520 12.3 Chatting..............................................................................................................................12-25 521 12.3.1 Introduction ............................................................................................................12-25 522 12.3.2 Server .....................................................................................................................12-26 523 12.3.3 Client......................................................................................................................12-36 524 12.4 Voice Over ZigBee .............................................................................................................12-37 525 12.4.1 Scope and Purpose ..................................................................................................12-37 526 12.4.2 Overview................................................................................................................12-37 527 12.4.3 Server .....................................................................................................................12-38 528 12.4.4 Client......................................................................................................................12-45 529 Chapter 13 Commissioning..............................................................................................................13-1 530 13.1 General Description ..............................................................................................................13-1 531 13.1.1 13.1.1 Introduction....................................................................................................13-1 532 13.1.2 13.1.2 Cluster List.....................................................................................................13-1 533 13.2 Commissioning.....................................................................................................................13-1 534
- 21. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 17 13.2.1 Overview..................................................................................................................13-1 535 13.2.2 Server .......................................................................................................................13-2 536 13.2.3 Client......................................................................................................................13-16 537 13.2.4 Commissioning EUI-64s .........................................................................................13-17 538 13.3 Touchlink Commissioning ..................................................................................................13-17 539 13.3.1 Overview................................................................................................................13-18 540 13.3.2 Server .....................................................................................................................13-19 541 13.3.3 Client......................................................................................................................13-44 542 13.3.4 Functional Description ............................................................................................13-45 543 Chapter 14 Retail.............................................................................................................................14-1 544 14.1 General Description ..............................................................................................................14-1 545 14.1.1 Introduction ..............................................................................................................14-1 546 14.1.2 Cluster List ...............................................................................................................14-1 547 14.2 Retail Tunnel (MSP Tunnel) .................................................................................................14-1 548 14.2.1 Overview..................................................................................................................14-1 549 14.2.2 Server .......................................................................................................................14-2 550 14.2.3 Client........................................................................................................................14-4 551 14.3 Mobile Device Configuration ................................................................................................14-4 552 14.3.1 Overview..................................................................................................................14-4 553 14.3.2 Server .......................................................................................................................14-5 554 14.3.3 Client........................................................................................................................14-7 555 14.4 Neighbor Cleaning................................................................................................................14-7 556 14.4.1 Overview..................................................................................................................14-7 557 14.4.2 Server .......................................................................................................................14-8 558 14.4.3 Client........................................................................................................................14-9 559 14.5 Nearest Gateway.................................................................................................................14-10 560 14.5.1 Overview................................................................................................................14-10 561 14.5.2 Server .....................................................................................................................14-10 562 14.5.3 Client......................................................................................................................14-11 563 14.5.4 Examples of Use .....................................................................................................14-11 564 Chapter 15 Appliance......................................................................................................................15-1 565 15.1 General Description ..............................................................................................................15-1 566 15.1.1 Introduction ..............................................................................................................15-1 567 15.1.2 Cluster List ...............................................................................................................15-1 568 15.2 EN50523 Appliance Control .................................................................................................15-1 569 15.2.1 Overview..................................................................................................................15-1 570 15.2.2 General Description ..................................................................................................15-2 571 15.2.3 Server Attributes.......................................................................................................15-2 572 15.2.4 Server Commands Received......................................................................................15-4 573 15.2.5 Server Commands Generated ....................................................................................15-8 574 15.2.6 Client......................................................................................................................15-10 575 15.3 EN50523 Appliance Identification.......................................................................................15-11 576 15.3.1 Overview................................................................................................................15-11 577 15.3.2 Server .....................................................................................................................15-11 578 15.3.3 Client......................................................................................................................15-15 579 15.4 EN50523 Appliance Events and Alerts................................................................................15-15 580 15.4.1 Overview................................................................................................................15-15 581 15.4.2 Server .....................................................................................................................15-17 582 15.4.3 Client......................................................................................................................15-21 583 15.5 Appliance Statistics.............................................................................................................15-21 584 15.5.1 Overview................................................................................................................15-21 585 15.5.2 Server .....................................................................................................................15-22 586 15.5.3 Client......................................................................................................................15-25 587 15.5.4 Appliance Statistics Cluster Sequence Diagram .......................................................15-26 588
- 22. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 18 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. 589
- 23. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 19 LIST OF FIGURES 590 Figure 2-1. The ZCL Client Server Model.............................................................................................. 2-3 591 Figure 2-2. Format of the General ZCL Frame ....................................................................................... 2-7 592 Figure 2-3. Format of the Frame Control Field....................................................................................... 2-7 593 Figure 2-4. Values of the Frame Type Sub-field..................................................................................... 2-8 594 Figure 2-5. Format of the Read Attributes Command Frame..................................................................2-10 595 Figure 2-6. Format of Read Attributes Response Command Frame........................................................2-11 596 Figure 2-7. Format of the Read Attributes Status Record Field ..............................................................2-11 597 Figure 2-8. Format of the Attribute Value Field for an Array, Set or Bag...............................................2-12 598 Figure 2-9. Format of the Attribute Value Field for a Structure..............................................................2-12 599 Figure 2-10. Format of the Write Attributes Command Frame...............................................................2-13 600 Figure 2-11. Format of the Write Attribute Record Field .......................................................................2-13 601 Figure 2-12. Format of Write Attributes Response Command Frame.....................................................2-15 602 Figure 2-13. Format of the Write Attribute Status Record Field.............................................................2-15 603 Figure 2-14. Write Attributes No Response Command Frame ...............................................................2-16 604 Figure 2-15. Format of the Configure Reporting Command Frame ........................................................2-17 605 Figure 2-16. Format of the Attribute Reporting Configuration Record ...................................................2-17 606 Figure 2-17. Format of the Configure Reporting Response Command Frame.........................................2-20 607 Figure 2-18. Format of the Attribute Status Record Field.......................................................................2-20 608 Figure 2-19. Read Reporting Configuration Command Frame ...............................................................2-21 609 Figure 2-20. Format of the Attribute Status Record Field.......................................................................2-22 610 Figure 2-21. Format of the Read Reporting Configuration Response Command Frame..........................2-22 611 Figure 2-22. Attribute Reporting Configuration Record Field................................................................2-23 612 Figure 2-23. Format of the Report Attributes Command Frame .............................................................2-24 613 Figure 2-24. Format of the Attribute Report Fields................................................................................2-25 614 Figure 2-25. Format of the Default Response Command Frame.............................................................2-27 615 Figure 2-26. Format of the Discover Attributes Command Frame..........................................................2-28 616 Figure 2-27. Discover Attributes Response Command Frame................................................................2-29 617 Figure 2-28. Format of the Attribute Report Fields................................................................................2-29 618 Figure 2-29. Format of Read Attributes Structured Command Frame.....................................................2-30 619 Figure 2-30. Format of the Selector Field..............................................................................................2-30 620 Figure 2-31. Write Attributes Structured Command Frame....................................................................2-31 621 Figure 2-32. Format of the Write Attribute Record Field .......................................................................2-32 622 Figure 2-33. Format of the Selector Field..............................................................................................2-32 623 Figure 2-34. Write Attributes Structured Response Command Frame ....................................................2-34 624 Figure 2-35. Format of the Write Attribute Status Record Field.............................................................2-34 625 Figure 2-36. Format of the Discover Server Commands Command Frame.............................................2-36 626 Figure 2-37. Format of the Discover Commands Received Response Frame..........................................2-37 627 Figure 2-38. Format of the Discover Attributes Extended Command Frame...........................................2-38 628 Figure 2-39. Format of the Discover Attributes Extended Response Command Frame ...........................2-39 629 Figure 2-40. Format of the Extended Attribute Information Fields.........................................................2-40 630 Figure 2-41. Format of the Attribute Access Control Field ....................................................................2-40 631 Figure 2-42. Format of the Semi-precision Number...............................................................................2-47 632 Figure 2-43. Format of the Octet String Type........................................................................................2-48 633 Figure 2-44. Format of the Character String Type .................................................................................2-48 634 Figure 2-45. Format of the Long Octet String Type...............................................................................2-49 635 Figure 2-46. Format of the Long Character String Type ........................................................................2-49 636 Figure 2-47. Format of the Time of Day Type.......................................................................................2-51 637 Figure 2-48. Format of the Date Type ...................................................................................................2-51 638 Figure 3-1. Typical Usage of Device Configuration and Installation Clusters.......................................... 3-2 639 Figure 3-2. Typical Usage of On/Off and Level Control Clusters............................................................ 3-3 640 Figure 3-3. Typical Usage of the Alarms Cluster.................................................................................... 3-3 641 Figure 3-4. Typical Usage of the Location Cluster with Centralized Device............................................ 3-4 642 Figure 3-5. Example Usage of the Input, Output and Value Clusters....................................................... 3-5 643 Figure 3-6. Format of the ProductCode attribute....................................................................................3-10 644
- 24. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 20 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Figure 3-7. Format of Identify Query Response Command Payload.......................................................3-31 645 Figure 3-8. Format of the Trigger Effect Command...............................................................................3-32 646 Figure 3-9. Format of Identify Query Response Command Payload.......................................................3-33 647 Figure 3-10. Format of the Add Group Command Payload ....................................................................3-36 648 Figure 3-11. Format of the View Group Command Payload ..................................................................3-37 649 Figure 3-12. Format of Get Group Membership Command Payload.......................................................3-37 650 Figure 3-13. Format of the Remove Group Command Payload..............................................................3-38 651 Figure 3-14. Add Group If Identifying Command Payload ....................................................................3-39 652 Figure 3-15. Format of the Add Group Response Command Payload.....................................................3-40 653 Figure 3-16. Format of the View Group Response Command Payload...................................................3-40 654 Figure 3-17. Format of the Get Group Membership Response Command Payload .................................3-41 655 Figure 3-18. Format of Remove Group Response Command Payload....................................................3-41 656 Figure 3-19. Format of the Add Scene Command Payload.....................................................................3-46 657 Figure 3-20. Format of the View Scene Command Payload...................................................................3-46 658 Figure 3-21. Format of the Remove Scene Command Payload...............................................................3-47 659 Figure 3-22. Format of the Remove All Scenes Command Payload .......................................................3-47 660 Figure 3-23. Format of the Store Scene Command Payload ...................................................................3-48 661 Figure 3-24. Format of the Recall Scene Command Payload..................................................................3-48 662 Figure 3-25. Format of Get Scene Membership Command Payload .......................................................3-49 663 Figure 3-26. Format of the Copy Scene Command................................................................................3-50 664 Figure 3-27. Format of the Mode Field of the Copy Scene Command....................................................3-50 665 Figure 3-28. Format of the Add Scene Response Command Payload .....................................................3-52 666 Figure 3-29. Format of the View Scene Response Command Payload....................................................3-52 667 Figure 3-30. Format of Remove Scene Response Command Payload.....................................................3-53 668 Figure 3-31. Format of the Remove All Scenes Response Command Payload........................................3-53 669 Figure 3-32. Format of the Store Scene Response Command Payload....................................................3-53 670 Figure 3-33. Format of the Get Scene Membership Response CommandPayload ...................................3-54 671 Figure 3-34. Format of the Copy Scene Response Command.................................................................3-55 672 Figure 3-35. State Behavior of Store and Recall Global Scene...............................................................3-58 673 Figure 3-36. Format of the Off With Effect Command ..........................................................................3-60 674 Figure 3-37. Format of the On With Timed Off Command....................................................................3-61 675 Figure 3-38. Format of the On/Off Control Field of the On With Timed Off Command .........................3-62 676 Figure 3-39. On/Off Cluster Operation State Machine...........................................................................3-63 677 Figure 3-40. Format of the Move to Level Command Payload...............................................................3-72 678 Figure 3-41. Format of the Move Command Payload ............................................................................3-73 679 Figure 3-42. Format of the Step Command Payload ..............................................................................3-74 680 Figure 3-43. Format of the Command Payload ......................................................................................3-75 681 Figure 3-44. Format of the Command Payload ......................................................................................3-75 682 Figure 3-45. Format of the Reset Alarm Command Payload ..................................................................3-79 683 Figure 3-46. Format of the Alarm Command Payload ...........................................................................3-80 684 Figure 3-47. Format of the Get Alarm Response Command Payload......................................................3-80 685 Figure 3-48. Example of Usage of RSSI Location Cluster .....................................................................3-85 686 Figure 3-49. Format of the Set Absolute Location Command Payload ...................................................3-90 687 Figure 3-50. Format of the Set Device Configuration Payload ...............................................................3-90 688 Figure 3-51. Format of the Get Device Configuration Payload...............................................................3-91 689 Figure 3-52. Format of the Get Location Data Payload..........................................................................3-91 690 Figure 3-53. Format of the RSSI Response Command Payload..............................................................3-93 691 Figure 3-54. Format of the Send Pings Command Payload ....................................................................3-93 692 Figure 3-55. Format of the Anchor Node Announce Command Payload ................................................3-94 693 Figure 3-56. Format of the Device Configuration Response Payload......................................................3-95 694 Figure 3-57. Format of the Location Data Response Payload.................................................................3-96 695 Figure 3-58. Format of the Location Data Notification Payload.............................................................3-96 696 Figure 3-59. Format of the RSSI Ping Command Payload .....................................................................3-97 697 Figure 3-60. Format of the Report RSSI Measurements Command Payload ...........................................3-98 698 Figure 3-61. Neighbor Info Structure ....................................................................................................3-98 699 Figure 3-62. Format of the Request Own Location Command Payload...................................................3-99 700
- 25. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 21 Figure 3-63. Format of the Check-in Response Payload.......................................................................3-159 701 Figure 3-64. Format of the Set Long Poll Interval Command Payload..................................................3-160 702 Figure 3-65. Format of the Set Short Poll Interval Command Payload .................................................3-161 703 Figure 3-66. Poll Control Cluster Sequence Diagram ..........................................................................3-162 704 Figure 3-67. Typical Usage of the Power Profile Cluster .....................................................................3-164 705 Figure 3-68. Format of the PowerProfileRequest Command Payload...................................................3-167 706 Figure 3-69. Format of the GetPowerProfilePriceResponse Command.................................................3-168 707 Figure 3-70. Format of the GetOverallSchedulePriceResponse Command ...........................................3-169 708 Figure 3-71. Format of the EnergyPhasesScheduleNotification Command Payload..............................3-170 709 Figure 3-72. Format of the PowerProfileNotification Command Payload (1 of 2).................................3-175 710 Figure 3-73. Format of the PowerProfileStateResponse Command Frame............................................3-177 711 Figure 3-74. Format of the Power Profile Record Field .......................................................................3-177 712 Figure 3-75. Power Profile States........................................................................................................3-179 713 Figure 3-76. Power Profile State Diagram...........................................................................................3-179 714 Figure 3-77. Format of EnergyPhasesScheduleStateResponse in Case of No Scheduled Phases............3-182 715 Figure 3-78. Format of the PowerProfileScheduleConstraintsNotification Command Frame ................3-183 716 Figure 3-79. Format of the GetPowerProfilePriceExtended Command Payload....................................3-184 717 Figure 3-80. Visualization of Price Associated to a Power Profile........................................................3-186 718 Figure 3-81. Energy Remote Disabled: Example of Sequence Diagram with User Interaction ..............3-187 719 Figure 3-82. Energy Remote Enabled: Example of Sequence Diagram with User Interaction ...............3-188 720 Figure 3-83. Typical Usage of the Meter Identification Cluster............................................................3-189 721 Figure 4-1. Typical Usage of Illuminance Measurement and Level Sensing Clusters............................... 4-2 722 Figure 4-2. Typical Usage of Temperature, Pressure and Flow Measurement Clusters ............................ 4-3 723 Figure 4-3. Typical Usage of Occupancy Sensing Cluster....................................................................... 4-4 724 Figure 4-4. The DC Overload Alarm Mask ...........................................................................................4-35 725 Figure 4-5. The ACAlarmsMask Attribute ............................................................................................4-36 726 Figure 4-6. Format of the Get Profile Info Response Command.............................................................4-43 727 Figure 4-7. ProfileIntervalPeriod...........................................................................................................4-43 728 Figure 4-8. Format of the Get Measurement Profile Response Command...............................................4-44 729 Figure 4-9. Format of the Get Measurement Profile Command..............................................................4-45 730 Figure 5-1. Typical Usage of Ballast Configuration and Color Control Clusters...................................... 5-2 731 Figure 5-2. Format of the Move to Hue Command Payload ...................................................................5-16 732 Figure 5-3. Format of the Move Hue Command Payload.......................................................................5-17 733 Figure 5-4. Format of the Step Hue Command Payload.........................................................................5-18 734 Figure 5-5. Format of the Move to Saturation Command Payload..........................................................5-19 735 Figure 5-6. Format of the Move Saturation Command Payload..............................................................5-20 736 Figure 5-7. Format of the Step Saturation Command Payload................................................................5-21 737 Figure 5-8. Move to Hue and Saturation Command Payload..................................................................5-22 738 Figure 5-9. Format of the Move to Color Command Payload.................................................................5-23 739 Figure 5-10. Format of the Move Color Command Payload...................................................................5-23 740 Figure 5-11. Format of the Step Color Command Payload.....................................................................5-24 741 Figure 5-12. Move to Color Temperature Command Payload ................................................................5-25 742 Figure 5-13. Format of the Enhanced Move to Hue Command ..............................................................5-25 743 Figure 5-14. Format of the Enhanced Move Hue Command ..................................................................5-26 744 Figure 5-15. Format of the Enhanced Step Hue Command ....................................................................5-27 745 Figure 5-16. Format of the Enhanced Move to Hue and Saturation Command........................................5-28 746 Figure 5-17. Format of the Color Loop Set Command...........................................................................5-29 747 Figure 5-18. Format of the Update Flags Field of the Color Loop Set Command....................................5-29 748 Figure 5-19. Format of the Stop Move Step Command Payload.............................................................5-31 749 Figure 5-20. Format of the Move Color Temperature Command............................................................5-31 750 Figure 5-21. Format of the Step Color Temperature Command..............................................................5-33 751 Figure 6-1. Typical Usage of Pump Configuration and Control Cluster................................................... 6-2 752 Figure 6-2. Example Usage of the Thermostat and Related Clusters ....................................................... 6-2 753 Figure 6-3. Priority Scheme of Pump Operation and Control.................................................................6-10 754 Figure 6-4. Format of the Setpoint Raise/Lower Command Payload ......................................................6-30 755 Figure 6-5. Set Weekly Schedule Command Payload Format (1 of 2)....................................................6-30 756
- 26. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 22 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Figure 6-6. Set Weekly Schedule Command Payload Format (2 of 2)....................................................6-30 757 Figure 6-7. Set Heat Weekly Schedule Command Payload Format (1 of 2)............................................6-32 758 Figure 6-8. Set Heat Weekly Schedule Command Payload Format (2 of 2)............................................6-32 759 Figure 6-9. Set Cool Weekly Schedule Command Payload Format (1 of 2)............................................6-32 760 Figure 6-10. Set Cool Weekly Schedule Command Payload Format (2 of 2)..........................................6-32 761 Figure 6-11. Set Heat & Cool Weekly Schedule Command Payload Format (1 of 2)..............................6-32 762 Figure 6-12. Set Heat & Cool Weekly Schedule Command Payload Format (2 of 2)..............................6-33 763 Figure 6-13. Format of the Get Weekly Schedule Command Payload ....................................................6-34 764 Figure 6-14. Format of the Relay Status Log Payload............................................................................6-36 765 Figure 7-1. Typical Usage of the Closures Clusters ................................................................................ 7-2 766 Figure 7-2. Format of the Alarm Cluster ................................................................................................ 7-6 767 Figure 7-3. Format of the Lock Door Command....................................................................................7-20 768 Figure 7-4. Format of the Unlock Door Command ................................................................................7-20 769 Figure 7-5. Format of the Toggle Command .........................................................................................7-20 770 Figure 7-6. Format of the Unlock with Timeout Command....................................................................7-21 771 Figure 7-7. Format of the Get Log Record Command............................................................................7-21 772 Figure 7-8. Format of the Set PIN Code Command ...............................................................................7-22 773 Figure 7-9. Format of the Get PIN Code Command...............................................................................7-23 774 Figure 7-10. Format of the Clear PIN Code Command..........................................................................7-23 775 Figure 7-11. Format of the Set User Status Command ...........................................................................7-23 776 Figure 7-12. Format of the Get User Status Command...........................................................................7-24 777 Figure 7-13. Format of the Set Week Day Schedule Command..............................................................7-24 778 Figure 7-14. Format of Days Mask Bits ................................................................................................7-24 779 Figure 7-15. Format of the Get Week Day Schedule Command.............................................................7-25 780 Figure 7-16. Format of the Clear Week Day Schedule Command ..........................................................7-25 781 Figure 7-17. Format of the Set Year Day Schedule Command ...............................................................7-25 782 Figure 7-18. Format of the Get Year Day Schedule Command ..............................................................7-26 783 Figure 7-19. Format of the Clear Year Day Schedule Command............................................................7-26 784 Figure 7-20. Format of the Set Holiday Schedule Command .................................................................7-26 785 Figure 7-21. Format of the Get Holiday Schedule Command.................................................................7-27 786 Figure 7-22. Format of the Clear Holiday Schedule Command ..............................................................7-27 787 Figure 7-23. Format of the Set User Type Command.............................................................................7-27 788 Figure 7-24. Format of the Get User Type Command............................................................................7-27 789 Figure 7-25. Format of the Set RFID Code Command...........................................................................7-28 790 Figure 7-26. Format of the Get RFID Code Command ..........................................................................7-28 791 Figure 7-27. Format of the Clear RFID Code Command........................................................................7-29 792 Figure 7-28. Format of the Lock Door Response Command Payload .....................................................7-31 793 Figure 7-29. Format of the Unlock Door Response Command Payload..................................................7-31 794 Figure 7-30. Format of the Get Log Record Response Command ..........................................................7-32 795 Figure 7-31. Format of the Set PIN Code Response Command..............................................................7-33 796 Figure 7-32. Format of the Get PIN Code Response Command .............................................................7-33 797 Figure 7-33. Format of the Clear PIN Code Response Command...........................................................7-33 798 Figure 7-34. Format of the Clear All PIN Codes Response Command ...................................................7-34 799 Figure 7-35. Format of the Set User Status Response Command............................................................7-34 800 Figure 7-36. Format of the Get User Status Response Command...........................................................7-34 801 Figure 7-37. Format of the Set Week Day Schedule Response Command ..............................................7-35 802 Figure 7-38. Format of the Get Week Day Schedule Response Command..............................................7-35 803 Figure 7-39. Format of Days Mask Bits ................................................................................................7-35 804 Figure 7-40. Format of the Clear Week Day Schedule ID Response Command......................................7-36 805 Figure 7-41. Format of the Set Year Day Schedule Response Command................................................7-36 806 Figure 7-42. Format of the Get Year Day Schedule Response Command...............................................7-37 807 Figure 7-43. Format of the Clear Year Day Schedule Response Command ............................................7-37 808 Figure 7-44. Format of the Set Holiday Schedule Response Command..................................................7-38 809 Figure 7-45. Format of the Get Holiday Schedule Response Command .................................................7-38 810 Figure 7-46. Format of the Clear Holiday Schedule Response Command...............................................7-39 811 Figure 7-47. Format of the Set User Type Response Command .............................................................7-39 812
- 27. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 23 Figure 7-48. Format of the Get User Type Response Command.............................................................7-39 813 Figure 7-49. Format of the Set RFID Code Response Command ...........................................................7-40 814 Figure 7-50. Format of the Get RFID Code Response Command...........................................................7-40 815 Figure 7-51. Format of the Clear RIFD Code Response Command........................................................7-40 816 Figure 7-52. Format of the Clear All RFID Codes Response Command.................................................7-41 817 Figure 7-53. Format of the Operation Event Notification Command ......................................................7-41 818 Figure 7-54. Format of the Programming Event Notification Command ................................................7-45 819 Figure 7-55. Format of the Go To Lift Value Command........................................................................7-56 820 Figure 7-56. Format of the Go To Lift Percentage Command ................................................................7-56 821 Figure 7-57. Format of the Go To Tilt Value Command........................................................................7-57 822 Figure 7-58. Format of the Go To Lift Percentage Command ................................................................7-57 823 Figure 8-1. Typical Usage of the IAS Clusters ....................................................................................... 8-2 824 Figure 8-2. Format of the Zone Enroll Response Command Payload ...................................................... 8-9 825 Figure 8-3. Payload format of Initiate Test Mode command ..................................................................8-10 826 Figure 8-4. Format of the Zone Status Change Notification Command Payload .....................................8-12 827 Figure 8-5. Format of the Zone Enroll Request Command Payload........................................................8-12 828 Figure 8-6. Format of the Arm Command Payload ................................................................................8-15 829 Figure 8-7. Format of the Bypass Command Payload ............................................................................8-16 830 Figure 8-8. Format of the Get Zone Information Command Payload......................................................8-17 831 Figure 8-9. Format of the Get Zone Status command.............................................................................8-18 832 Figure 8-10. Format of the Arm Response Command Payload...............................................................8-19 833 Figure 8-11. Get Zone ID Map Response Command Payload ................................................................8-20 834 Figure 8-12. Format of the Get Zone Information Response Command Payload ....................................8-20 835 Figure 8-13. Format of the Zone Status Changed Command Payload.....................................................8-21 836 Figure 8-14. Audible Notification field value........................................................................................8-21 837 Figure 8-15. Format of the Panel Status Changed Command Payload ....................................................8-22 838 Figure 8-16. Alarm Status field value....................................................................................................8-23 839 Figure 8-17. Get Panel Status Response command ................................................................................8-24 840 Figure 8-18. Set Bypassed Zone List Command payload format............................................................8-24 841 Figure 8-19. Bypass Response command format ...................................................................................8-25 842 Figure 8-20. Format of the Get Zone Status Response command ...........................................................8-26 843 Figure 8-21. Format of the Start Siren Command Payload .....................................................................8-29 844 Figure 8-22. Format of the Start Siren Command Payload .....................................................................8-31 845 Figure 9-1. Format of Match Protocol Address Command Payload......................................................... 9-4 846 Figure 9-2. Match Protocol Address Response Command Payload ......................................................... 9-5 847 Figure 9-3. Advertise Protocol Address Command Payload.................................................................... 9-5 848 Figure 9-4. Format of the Transfer NPDU Command Payload................................................................ 9-7 849 Figure 9-5. Format of the Transfer APDU command.............................................................................9-37 850 Figure 9-6. Typical Usage of the Partition Cluster.................................................................................9-40 851 Figure 9-7. Client and Server in Partition Cluster ..................................................................................9-41 852 Figure 9-8. Format of the TransferPartitionedFrame Command.............................................................9-44 853 Figure 9-9. Format of the FragmentationOptions Field..........................................................................9-45 854 Figure 9-10. ReadHandshakeParam Frame............................................................................................9-45 855 Figure 9-11. WriteHandshakeParam Frame...........................................................................................9-46 856 Figure 9-12. Format of Write Attribute Record Field.............................................................................9-46 857 Figure 9-13. Format of the MultipleACK Command .............................................................................9-46 858 Figure 9-14. Format of the ACK Options Field .....................................................................................9-46 859 Figure 9-15. ReadHandshakeParamResponse Frame.............................................................................9-47 860 Figure 9-16. Format of Read Attribute Status Record Field ...................................................................9-48 861 Figure 9-17. Example of Partition Cluster Use ......................................................................................9-49 862 Figure 9-18 Typical Usage of the 11073 Protocol Tunnel cluster...........................................................9-50 863 Figure 9-19 – Transfer APDU payload..................................................................................................9-53 864 Figure 9-20 – Connect Request command payload ................................................................................9-54 865 Figure 9-21 – Connect control field format ...........................................................................................9-54 866 Figure 9-22 – Disconnect Request command payload............................................................................9-55 867 Figure 9-23 – Connect Status Notification command payload................................................................9-56 868
- 28. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 24 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Figure 10-1. Price Cluster Client Server Example..................................................................................10-2 869 Figure 10-2. The Format of the Get Current Price Command Payload..................................................10-11 870 Figure 10-3. Get Current Price Command Options Field .....................................................................10-11 871 Figure 10-4. Format of the Get Scheduled Prices Command Payload...................................................10-12 872 Figure 10-5. Format of the Price Acknowledgement Command Payload ..............................................10-13 873 Figure 10-6. Format of the Get Block Period(s) Command Payload .....................................................10-13 874 Figure 10-7. Format of the GetConversionFactor Command Payload...................................................10-14 875 Figure 10-8. Format of the GetCalorificValue Command Payload.......................................................10-15 876 Figure 10-9. Format of the Publish Price Command Payload ...............................................................10-16 877 Figure 10-10. Format of the Publish Block Period Command Payload .................................................10-20 878 Figure 10-11. Format of the PublishConversionFactor Command Payload...........................................10-21 879 Figure 10-12. Format of the PublishCalorificValue Command Payload................................................10-22 880 Figure 10-13. Demand Response/Load Control Cluster Client Server Example....................................10-26 881 Figure 10-14. Format of the Load Control Event Command Payload ...................................................10-27 882 Figure 10-15. Format of the Cancel Load Control Event Payload.........................................................10-31 883 Figure 10-16. Format of the Report Event Status Command Payload ...................................................10-35 884 Figure 10-17. Format of the Get Scheduled Events Command Payload ................................................10-37 885 Figure 10-18. Example of Both a Successful and an Overridden Load Curtailment Event.....................10-41 886 Figure 10-19. Example of a Load Curtailment Superseded and Another Cancelled...............................10-42 887 Figure 10-20. Smart Energy Device Class Reference Example.............................................................10-45 888 Figure 10-21. Correctly Overlapping Events........................................................................................10-45 889 Figure 10-22. Correct Superseding of Events.......................................................................................10-46 890 Figure 10-23. Superseded Event for a Subset of Device Classes...........................................................10-47 891 Figure 10-24. Ending Randomization Between Events ........................................................................10-47 892 Figure 10-25. Start Randomization Between Events ............................................................................10-48 893 Figure 10-26. Acceptable Gaps with Start and Stop Randomization .....................................................10-49 894 Figure 10-27. Standalone ESI Model with Mains Powered Metering Device........................................10-50 895 Figure 10-28. Standalone ESI Model with Battery Powered Metering Device......................................10-51 896 Figure 10-29. ESI Model with Integrated Metering Device..................................................................10-52 897 Figure 10-30. Format of the Get Profile Response Command Payload..................................................10-82 898 Figure 10-31. Format of the Request Fast Poll Mode Response Command Payload..............................10-84 899 Figure 10-32. Format of the Get Profile Command Payload.................................................................10-85 900 Figure 10-33. Format of the Request Mirror Response Command Payload...........................................10-86 901 Figure 10-34. Format of the Mirror Removed Command Payload........................................................10-86 902 Figure 10-35. Format of the Request Fast Poll Mode Command Payload .............................................10-87 903 Figure 10-36. Messaging Cluster Client/Server Example.....................................................................10-89 904 Figure 10-37. Format of the Display Message Command Payload........................................................10-90 905 Figure 10-38. Format of the Cancel Message Command Payload.........................................................10-92 906 Figure 10-39. Format of the Message Confirmation Command Payload...............................................10-93 907 Figure 10-40. Client/Server Message Command Exchanges ................................................................10-94 908 Figure 10-41. A Client Requests a Tunnel from a Server to Exchange Complex Data in Both Directions10-95 909 Figure 10-42. SE Device 1 (Client) Requests a Tunnel from SE Device 2 (Server) to Transfer Data Without Flow 910 Control (Default) ........................................................................................................................10-97 911 Figure 10-43. SE Device 1 (Client) Requests a Tunnel from SE Device 2 (Server) to Transfer Data with Flow Control 912 ...................................................................................................................................................10-97 913 Figure 10-44. Format of the RequestTunnel Command Payload.........................................................10-100 914 Figure 10-45. Format of the CloseTunnel Command Payload ............................................................10-101 915 Figure 10-46. Format of the TransferData Command Payload ...........................................................10-102 916 Figure 10-47. Format of the TransferDataError Command Payload....................................................10-102 917 Figure 10-48. Format of the AckTransferData Command Payload .....................................................10-103 918 Figure 10-49. Format of the ReadyData Command Payload...............................................................10-104 919 Figure 10-50. Format of the Get Supported Tunnel Protocols Command Payload...............................10-105 920 Figure 10-51. Format of the RequestTunnelResponse Command Payload..........................................10-106 921 Figure 10-52. Format of the TransferData Command Payload ...........................................................10-107 922 Figure 10-53. Format of the Supported Tunnel Protocols Response Command Payload......................10-107 923 Figure 10-54. Format of the Supported Tunnel Protocols Response Command Protocol Fields ..........10-108 924
- 29. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 25 Figure 10-55. Format of the TunnelClosureNotification Command Payload.......................................10-108 925 Figure 10-56. Overview of General Exchange...................................................................................10-111 926 Figure 10-57. Typical Usage of the Key Establishment Cluster..........................................................10-113 927 Figure 10-58. Key Establishment Command Exchange .....................................................................10-114 928 Figure 10-59. Format of the Initiate Key Establishment Request Command Payload..........................10-116 929 Figure 10-60. Format of the Ephemeral Data Request Command Payload..........................................10-117 930 Figure 10-61. Format of the Confirm Key Request Command Payload..............................................10-117 931 Figure 10-62. Format of the Terminate Key Establishment Command Payload ..................................10-118 932 Figure 10-63. Format of the Initiate Key Establishment Response Command Payload........................10-120 933 Figure 10-64. Format of the Ephemeral Data Response Command Payload .......................................10-121 934 Figure 10-65. Format of the Confirm Key Response Command Payload ............................................10-121 935 Figure 10-66. Format of the Terminate Key Establishment Command Payload ..................................10-122 936 Figure 10-67. Key Establishment Command Exchange .....................................................................10-132 937 Figure 11-1. Typical Usage of OTA Upgrade Cluster............................................................................11-2 938 Figure 11-2. Sample OTA File..............................................................................................................11-6 939 Figure 11-3. Sub-element Format........................................................................................................11-11 940 Figure 11-4. ECDSA Signature...........................................................................................................11-12 941 Figure 11-5. ECDSA Signing Certificate Sub-element ........................................................................11-13 942 Figure 11-6. Hash Value Sub-element.................................................................................................11-13 943 Figure 11-7. ECDSA Signature...........................................................................................................11-13 944 Figure 11-8. ECDSA Signing Certificate Sub-element ........................................................................11-14 945 Figure 11-9. OTA Upgrade Message Diagram ....................................................................................11-26 946 Figure 11-10. Format of Image Notify Command Payload...................................................................11-29 947 Figure 11-11. Format of Query Next Image Request Command Payload..............................................11-31 948 Figure 11-12. Format of Query Next Image Response Command Payload ...........................................11-33 949 Figure 11-13. Format of Image Block Request Command Payload ......................................................11-35 950 Figure 11-14. Image Page Request Command Payload........................................................................11-37 951 Figure 11-15. Image Block Response Command Payload with SUCCESS status .................................11-40 952 Figure 11-16. Image Block Response Command Payload with WAIT_FOR_DATA status ..................11-41 953 Figure 11-17. Image Block Response Command Payload with ABORT status.....................................11-41 954 Figure 11-18. Format of Upgrade End Request Command Payload......................................................11-44 955 Figure 11-19. Format of Upgrade End Response Command Payload ...................................................11-46 956 Figure 11-20. Format of Query Device Specific File Request Command Payload ................................11-48 957 Figure 11-21. Format of Query Device Specific File Response Command Payload ..............................11-49 958 Figure 11-22. Rate Limiting Exchange................................................................................................11-54 959 Figure 12-1. Typical Content Data Structure.........................................................................................12-2 960 Figure 12-2. Typical Usage of the Information Cluster..........................................................................12-3 961 Figure 12-3. Typical Usage of the Information Cluster – with Proxy Function .......................................12-4 962 Figure 12-4. An Example Sequence......................................................................................................12-5 963 Figure 12-5. Preference Scenarios (Triggered by the Client or by the Server).........................................12-6 964 Figure 12-6. Payload Format of Request Information Command ...........................................................12-9 965 Figure 12-7. Payload Format for Request a Content by a Content ID ...................................................12-10 966 Figure 12-8. Request Information Payload for Request Contents by Multiple IDs ................................12-10 967 Figure 12-9. Request Information Payload for Request by Depth.........................................................12-11 968 Figure 12-10. Payload Format of Push Information Response Command.............................................12-11 969 Figure 12-11. Payload Format for Send Preference Command.............................................................12-12 970 Figure 12-12. Payload Format for Preference Is Multiple Content ID (0x0000)....................................12-12 971 Figure 12-13. Payload Format for Preference Is Multiple Octet Strings (0x0001).................................12-12 972 Figure 12-14. Payload Format of Request Preference Response Command..........................................12-13 973 Figure 12-15. Payload Format for Update Command...........................................................................12-13 974 Figure 12-16. Format for Redirection Control Field.............................................................................12-14 975 Figure 12-17. An Example Sequence of Forwarding Case ...................................................................12-15 976 Figure 12-18. An Example Sequence of Redirecting Case ...................................................................12-16 977 Figure 12-19. Payload Format for Delete Command............................................................................12-16 978 Figure 12-20. Format for Deletion Option Field ..................................................................................12-17 979 Figure 12-21. Payload Format for Configure Node Description Command ..........................................12-17 980
- 30. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 26 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Figure 12-22. Payload Format for Configure Delivery Enable Command.............................................12-18 981 Figure 12-23. Payload Format for Configure Push Information Timer Command.................................12-18 982 Figure 12-24. Payload Format for Configure Set Root ID Command ...................................................12-18 983 Figure 12-25. Payload Format of Request Information Response Command........................................12-19 984 Figure 12-26. Payload Format of Push Information Command ............................................................12-19 985 Figure 12-27. Payload Format for Send Preference Response Command and Request Preference Confirmation 986 Command...................................................................................................................................12-20 987 Figure 12-28. Payload Format of Update Response and Delete Response command.............................12-21 988 Figure 12-29. Payload Format for Multiple Contents...........................................................................12-22 989 Figure 12-30. Format for Single Content.............................................................................................12-22 990 Figure 12-31. Format for Title String..................................................................................................12-23 991 Figure 12-32. Format for Long Octet String........................................................................................12-23 992 Figure 12-33. Format for Long Character String..................................................................................12-23 993 Figure 12-34. Format for RSS Feed ....................................................................................................12-23 994 Figure 12-35. Typical Usage of the Chatting Cluster ...........................................................................12-26 995 Figure 12-36. Format of the Join Chat Request Command...................................................................12-29 996 Figure 12-37. Format of the Leave Chat Request Command................................................................12-29 997 Figure 12-38. Format of the Switch Chairman Response Command.....................................................12-30 998 Figure 12-39. Format of the Start Chat Request Command..................................................................12-30 999 Figure 12-40. Format of the ChatMessage Command..........................................................................12-31 1000 Figure 12-41. Format of the Get Node Information Request Command................................................12-31 1001 Figure 12-42. Format of an Item of the Chatting Table........................................................................12-31 1002 Figure 12-43. Format of the Start Chat Response Command................................................................12-32 1003 Figure 12-44. Format of the Join Chat Response Command.................................................................12-33 1004 Figure 12-45. Format of the User Left Command................................................................................12-33 1005 Figure 12-46. Format of the User Joined Command ............................................................................12-34 1006 Figure 12-47. Format of the Search Chat Response command .............................................................12-34 1007 Figure 12-48. Format of the Switch Chairman Request Command.......................................................12-35 1008 Figure 12-49. Format of the Switch Chairman Confirm Command......................................................12-35 1009 Figure 12-50. Format of the NodeInformation Field............................................................................12-35 1010 Figure 12-51. Format of the Switch Chairman Notification Command.................................................12-36 1011 Figure 12-52. Format of the Get Node Information Response Command .............................................12-36 1012 Figure 12-53. Typical Usage of the VoZ Cluster .................................................................................12-37 1013 Figure 12-54. Format of the OptionFlags Attribute..............................................................................12-40 1014 Figure 12-55. Format of the Establishment Request Command............................................................12-41 1015 Figure 12-56. Format of the Flag ........................................................................................................12-41 1016 Figure 12-57. Format of the Voice Transmission Command................................................................12-42 1017 Figure 12-58. Format of the Voice Transmission Completion Command .............................................12-42 1018 Figure 12-59. Format of the Control Response Command ...................................................................12-42 1019 Figure 12-60. Format of the Voice Transmission Response Command.................................................12-43 1020 Figure 12-61. Format of the Establishment Response Command .........................................................12-44 1021 Figure 12-62. Format of the Control Command...................................................................................12-45 1022 Figure 13-1. Format of the Restart Device Command Payload.............................................................13-12 1023 Figure 13-2. Format of the Options Field ............................................................................................13-12 1024 Figure 13-3. Format of Save Startup Parameters Command Payload....................................................13-14 1025 Figure 13-4. Restore Startup Parameters Command Payload ...............................................................13-14 1026 Figure 13-5. Format of Reset Startup Parameters Command Payload...................................................13-15 1027 Figure 13-6. Format of the Options Field ............................................................................................13-15 1028 Figure 13-7. Format of Reset Startup Parameters Command Payload...................................................13-16 1029 Figure 13-8. Format of the Scan Request Command Frame.................................................................13-20 1030 Figure 13-9. Format of the ZigBee Information Field..........................................................................13-21 1031 Figure 13-10. Format of the Scan Request Touchlink Information Field ..............................................13-21 1032 Figure 13-11. Format of the Device Information Request Command Frame.........................................13-22 1033 Figure 13-12. Format of the Identify Request Command Frame...........................................................13-23 1034 Figure 13-13. Format of the Reset to Factory New Request Command Frame......................................13-24 1035 Figure 13-14. Format of the Network Start Request Command Frame .................................................13-24 1036
- 31. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 27 Figure 13-15. Format of the Network Join Router Request Command Frame.......................................13-26 1037 Figure 13-16. Format of the Network Join End Device Request Command Frame ...............................13-28 1038 Figure 13-17. Format of the Network Update Request Command Frame..............................................13-30 1039 Figure 13-18. Format of the Get Group Identifiers Request Command.................................................13-31 1040 Figure 13-19. Format of the Get Endpoint List Request Command......................................................13-31 1041 Figure 13-20. Format of the Scan Response Command Frame.............................................................13-32 1042 Figure 13-21. Format of the ZigBee Information Field ........................................................................13-33 1043 Figure 13-22. Format of the Scan Response Touchlink Information Field............................................13-34 1044 Figure 13-23. Format of the Device Information Response Command Frame.......................................13-36 1045 Figure 13-24. Format of the Device Information Record Field.............................................................13-36 1046 Figure 13-25. Format of the Network Start Response Command Frame...............................................13-38 1047 Figure 13-26. Format of the Network Join Router Response Command Frame.....................................13-39 1048 Figure 13-27. Format of the Network Join End Device Response Command Frame .............................13-40 1049 Figure 13-28. Format of the Endpoint Information Command .............................................................13-41 1050 Figure 13-29. Format of the Get Group Identifiers Response Command ..............................................13-42 1051 Figure 13-30. Format of a Group Information Record Entry................................................................13-42 1052 Figure 13-31. Format of the Get Endpoint List Response Command....................................................13-43 1053 Figure 13-32. Format of an Endpoint Information Record Entry..........................................................13-43 1054 Figure 13-33. Format of the device information table ..........................................................................13-46 1055 Figure 13-34. General format of an inter-PAN frame...........................................................................13-48 1056 Figure 13-35. Scope of a touchlink commissioning inter-PAN transaction...........................................13-49 1057 Figure 13-36. Overview of Touchlink Security....................................................................................13-53 1058 Figure 13-37. Steps Required to Encrypt/Decrypt the Network Key.....................................................13-56 1059 Figure 14-1. Typical Usage of the Retail Tunnel Cluster .......................................................................14-2 1060 Figure 14-2. Format of the Transfer APDU Command ..........................................................................14-3 1061 Figure 14-3. Typical Usage of the Mobile Device Configuration Cluster ...............................................14-5 1062 Figure 14-4. Format of the Keep Alive Notification Command..............................................................14-6 1063 Figure 14-5. Typical Usage of the Neighbor Cleaning Cluster ...............................................................14-8 1064 Figure 14-6. Typical Usage of the Nearest Gateway Cluster ................................................................14-10 1065 Figure 14-7. Sequence Diagram..........................................................................................................14-12 1066 Figure 15-1. Typical Usage of the Appliance Control Cluster................................................................15-2 1067 Figure 15-2. Format of the Execution of a Command Payload ...............................................................15-4 1068 Figure 15-3. Format of the Write Functions Command Frame ...............................................................15-6 1069 Figure 15-4. Format of the Write Functions Record Field......................................................................15-6 1070 Figure 15-5. Format of the Overload Warning Payload..........................................................................15-7 1071 Figure 15-6. Format of the Signal State Response Command Payload....................................................15-8 1072 Figure 15-7. Typical Usage of the Appliance Events and Alerts Cluster...............................................15-16 1073 Figure 15-8. Format of the Get Alerts Response Command Payload....................................................15-18 1074 Figure 15-9. Format of the Alerts Notification Command Payload.......................................................15-20 1075 Figure 15-10. Format of the Event Notification Command Payload .....................................................15-20 1076 Figure 15-11. Format of the Log Notification Payload.........................................................................15-24 1077 Figure 15-12. Format of the Log Queue Response Payload..................................................................15-25 1078 Figure 15-13. Format of the Log Request Payload...............................................................................15-26 1079 Figure 15-14. Appliance Statistics Cluster Sequence Diagram.............................................................15-27 1080 1081
- 32. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 28 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. LIST OF TABLES 1082 Table 1-1. Acronyms and Abbreviations ................................................................................................ 1-1 1083 Table 2-1. Global Attributes .................................................................................................................. 2-6 1084 Table 2-2. AttributeReportingStatus Enumerations................................................................................. 2-6 1085 Table 2-3. ZCL Command Frames......................................................................................................... 2-9 1086 Table 2-4. Destination of Reporting Based on Direction Field ...............................................................2-18 1087 Table 2-5. Valid Profile Identifier Values..............................................................................................2-41 1088 Table 2-6. Valid Device Identifier Values .............................................................................................2-41 1089 Table 2-7. Valid Cluster Identifier Values.............................................................................................2-42 1090 Table 2-8. Valid ZCL Defined Attribute Identifier Values.....................................................................2-42 1091 Table 2-9. Valid ZCL-Defined Command Identifier Values...................................................................2-42 1092 Table 2-10. Data Types.........................................................................................................................2-43 1093 Table 2-11. Enumerated Status Values Used in the ZCL........................................................................2-52 1094 Table 3-1. Device Configuration and Installation Clusters...................................................................... 3-1 1095 Table 3-2. Groups and Scenes Clusters .................................................................................................. 3-2 1096 Table 3-3. On/Off and Level Control Clusters........................................................................................ 3-2 1097 Table 3-4. Alarms Cluster...................................................................................................................... 3-3 1098 Table 3-5. Other Clusters....................................................................................................................... 3-4 1099 Table 3-6. Generic Clusters ................................................................................................................... 3-4 1100 Table 3-7. Attributes of the Basic Cluster............................................................................................... 3-6 1101 Table 3-8. Values of the PowerSource Attribute..................................................................................... 3-8 1102 Table 3-9. Values of the GenericDeviceClass attribute ........................................................................... 3-9 1103 Table 3-10. Values of the GenericDeviceType attribute for the lighting class.......................................... 3-9 1104 Table 3-11. Values of the CodeId field of the ProductCode attribute......................................................3-11 1105 Table 3-12. Values of the PhysicalEnvironment Attribute......................................................................3-12 1106 Table 3-13. Values of the DeviceEnable Attribute.................................................................................3-15 1107 Table 3-14. Values of the AlarmMask Attribute....................................................................................3-16 1108 Table 3-15. Values of the DisableLocalConfig Attribute .......................................................................3-16 1109 Table 3-16. Received Command IDs for the Basic Cluster ....................................................................3-16 1110 Table 3-17. Power Configuration Attribute Sets....................................................................................3-18 1111 Table 3-18. Attributes of the Mains Information Attribute Set ...............................................................3-18 1112 Table 3-19. Attributes of the Mains Settings Attribute Set.....................................................................3-19 1113 Table 3-20. Values of the MainsAlarmMask Attribute...........................................................................3-19 1114 Table 3-21. Attributes of the Battery Information Attribute Set..............................................................3-20 1115 Table 3-22. Attributes of the Battery Settings Attribute Set ...................................................................3-21 1116 Table 3-23. Values of the BatterySize Attribute ....................................................................................3-21 1117 Table 3-24. Values of the BatteryAlarmMask Attribute.........................................................................3-22 1118 Table 3-25. Alarm Code Field Enumerations for Battery Alarms...........................................................3-23 1119 Table 3-26. BatteryAlarmState Enumerations .......................................................................................3-25 1120 Table 3-27. Device Temperature Configuration Attribute Sets...............................................................3-27 1121 Table 3-28. Device Temperature Information Attribute Set ...................................................................3-27 1122 Table 3-29. Device Temperature Settings Attribute Set .........................................................................3-28 1123 Table 3-30. Values of the DeviceTempAlarmMask Attribute ................................................................3-28 1124 Table 3-31. Attributes of the Identify Server Cluster .............................................................................3-30 1125 Table 3-32. Received Command IDs for the Identify Cluster.................................................................3-31 1126 Table 3-33. Values of the Effect Identifier Field of the Trigger Effect Command...................................3-32 1127 Table 3-34. Values of the Effect Variant Field of the Trigger Effect Command......................................3-32 1128 Table 3-35. Generated Command IDs for the Identify Cluster ...............................................................3-33 1129 Table 3-36. Attributes of the Groups Server Cluster ..............................................................................3-35 1130 Table 3-37. Received Command IDs for the Groups Cluster..................................................................3-36 1131 Table 3-38. Generated Command IDs for the Groups Cluster ................................................................3-39 1132 Table 3-39. Scenes Attribute Sets .........................................................................................................3-43 1133 Table 3-40. Scene Management Information Attribute Set.....................................................................3-43 1134 Table 3-41. Fields of a Scene Table Entry.............................................................................................3-44 1135 Table 3-42. Received Command IDs for the Scenes Cluster ..................................................................3-45 1136
- 33. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 29 Table 3-43. Generated Command IDs for the Scenes Cluster.................................................................3-51 1137 Table 3-44. Values of the Status Field of the Copy Scene Response Command......................................3-55 1138 Table 3-45. Attributes of the On/Off Server Cluster ..............................................................................3-57 1139 Table 3-46. Values of the StartUpOnOff Attribute ................................................................................3-59 1140 Table 3-47. Command IDs for the On/Off Cluster.................................................................................3-59 1141 Table 3-48. Values of the Effect Identifier Field of the Off With Effect Command ................................3-60 1142 Table 3-49. Values of the Effect Variant Field of the Off With Effect Command...................................3-60 1143 Table 3-50. On/Off Switch Configuration Attribute Sets .......................................................................3-64 1144 Table 3-51. Attributes of the Switch Information Attribute Set ..............................................................3-65 1145 Table 3-52. Values of the SwitchType Attribute....................................................................................3-65 1146 Table 3-53. Attributes of the Switch Settings Attribute Set....................................................................3-65 1147 Table 3-54. Values of the SwitchActions Attribute................................................................................3-66 1148 Table 3-55. Actions on Receipt for On/Off Commands, when Associated with Level Control................3-67 1149 Table 3-56. Attributes of the Level Control Server Cluster ....................................................................3-68 1150 Table 3-57. Options Attribute ...............................................................................................................3-70 1151 Table 3-58. Values of the StartUpCurrentLevel attribute .......................................................................3-71 1152 Table 3-59. Command IDs for the Level Control Cluster.......................................................................3-71 1153 Table 3-60. Values of the Move Mode Field .........................................................................................3-73 1154 Table 3-61. Actions on Receipt for Move Command.............................................................................3-73 1155 Table 3-62. Values of the Step Mode Field ...........................................................................................3-74 1156 Table 3-63. Actions on Receipt for Step Command...............................................................................3-74 1157 Table 3-64. Alarms Cluster Attribute Sets.............................................................................................3-77 1158 Table 3-65. Attributes of the Alarm Information Attribute Set...............................................................3-77 1159 Table 3-66. Format of the Alarm Table.................................................................................................3-78 1160 Table 3-67. Received Command IDs for the Alarms Cluster..................................................................3-78 1161 Table 3-68. Generated Command IDs for the Alarms Cluster ................................................................3-79 1162 Table 3-69. Attributes of the Time Server Cluster .................................................................................3-81 1163 Table 3-70. Bit Values of the TimeStatus Attribute ...............................................................................3-82 1164 Table 3-71. Location Attribute Sets.......................................................................................................3-86 1165 Table 3-72. Attributes of the Location Information Attribute Set ...........................................................3-86 1166 Table 3-73. Bit Values of the LocationType Attribute ...........................................................................3-86 1167 Table 3-74. Values of the LocationMethod Attribute.............................................................................3-87 1168 Table 3-75. Attributes of the Location Settings Attribute Set.................................................................3-88 1169 Table 3-76. Received Command IDs for the Location Cluster ...............................................................3-89 1170 Table 3-77. Generated Command IDs for the RSSI Location Cluster.....................................................3-94 1171 Table 3-78. Attributes of the Analog Input (Basic) Server Cluster .......................................................3-100 1172 Table 3-79. Attributes of the Analog Output (Basic) Server Cluster.....................................................3-101 1173 Table 3-80. Attributes of the Analog Value (Basic) Server Cluster ......................................................3-103 1174 Table 3-81. Attributes of the Binary Input (Basic) Server Cluster ........................................................3-105 1175 Table 3-82. Attributes of the Binary Output (Basic) Server Cluster......................................................3-106 1176 Table 3-83. Attributes of the Binary Value (Basic) Server Cluster .......................................................3-107 1177 Table 3-84. Attributes of the Multistate Input (Basic) Server Cluster ...................................................3-109 1178 Table 3-85. Attributes of the Multistate Output (Basic) Server Cluster.................................................3-110 1179 Table 3-86. Attributes of the Multistate Value (Basic) Server Cluster ..................................................3-112 1180 Table 3-87. AI Types, Type = 0x00: Temperature in Degrees C ..........................................................3-117 1181 Table 3-88. AI Types, Type = 0x01: Relative Humidity in % ..............................................................3-119 1182 Table 3-89. AI Types, Type = 0x02: Pressure in Pascal.......................................................................3-120 1183 Table 3-90. AI Types, Type = 0x03: Flow in Liters/Second.................................................................3-121 1184 Table 3-91. AI Types, Type = 0x04: Percentage %..............................................................................3-122 1185 Table 3-92. AI types, Type = 0x05: Parts per Million PPM .................................................................3-122 1186 Table 3-93. AI Types, Type = 0x06: Rotational Speed in RPM............................................................3-123 1187 Table 3-94. AI Types, Type = 0x07: Current in Amps.........................................................................3-123 1188 Table 3-95. AI Types, Type = 0x08: Frequency in Hz .........................................................................3-123 1189 Table 3-96. AI Types, Type = 0x09: Power in Watts...........................................................................3-124 1190 Table 3-97. AI Types, Type = 0x0A: Power in kW..............................................................................3-124 1191 Table 3-98. AI Types, Type = 0x0B: Energy in kWH..........................................................................3-124 1192
- 34. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 30 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Table 3-99. AI Types, Type = 0x0C: Count - Unitless.........................................................................3-124 1193 Table 3-100. AI Types, Type = 0x0D: Enthalpy in KJoules/Kg ...........................................................3-125 1194 Table 3-101. AI types, Type = 0x0E: Time in Seconds........................................................................3-125 1195 Table 3-102. AO Types, Type = 0x00: Temperature in Degrees C.......................................................3-125 1196 Table 3-103. AO Types, Type = 0x01: Relative Humidity in %...........................................................3-126 1197 Table 3-104. AO Types, Type = 0x02: Pressure Pascal........................................................................3-126 1198 Table 3-105. AO Types, Type = 0x03: Flow in Liters/Second .............................................................3-126 1199 Table 3-106. AO Types, Type = 0x04: Percentage % ..........................................................................3-127 1200 Table 3-107. AO Types, Type = 0x05: Parts per Million PPM.............................................................3-129 1201 Table 3-108. AO Types, Type = 0x06: Rotational Speed RPM ............................................................3-129 1202 Table 3-109. AO Types, Type = 0x07: Current in Amps......................................................................3-129 1203 Table 3-110. AO Types, Type = 0x08: Frequency in Hz......................................................................3-129 1204 Table 3-111. AO Types, Type = 0x09: Power in Watts........................................................................3-130 1205 Table 3-112. AO Types, Type = 0x0A: Power in kW..........................................................................3-130 1206 Table 3-113. AO Types, Type = 0x0B: Energy in kWh .......................................................................3-130 1207 Table 3-114. AO Types, Type = 0x0C: Count - Unitless......................................................................3-130 1208 Table 3-115. AO Types, Type = 0x0D: Enthalpy in KJoules/Kg..........................................................3-131 1209 Table 3-116. AO Types, Type = 0x0E: Time in Seconds.....................................................................3-131 1210 Table 3-117. AV Types, Type = 0x00: Temperature in Degrees C.......................................................3-131 1211 Table 3-118. AV Types, Type = 0x01: Area in Square Metres.............................................................3-132 1212 Table 3-119. AV Types, Type = 0x02: Multiplier - Number................................................................3-132 1213 Table 3-120. AV Types, Type = 0x03: Flow in Litres/Second .............................................................3-133 1214 Table 3-121. BI Types, Type = 0x00: Application Domain HVAC......................................................3-133 1215 Table 3-122. BI Types, Type = 0x01: Application Domain Security....................................................3-139 1216 Table 3-123. BO Types, Type = 0x00: Application Domain HVAC.....................................................3-140 1217 Table 3-124. BO Types, Type = 0x02: Application Domain Security...................................................3-145 1218 Table 3-125. BV Types, Type = 0x00 .................................................................................................3-146 1219 Table 3-126. MI Types, Type = 0x00: Application Domain HVAC .....................................................3-146 1220 Table 3-127. MO Types, Type = 0x00: Application Domain HVAC....................................................3-147 1221 Table 3-128. MV Types, Type = 0x00: Application Domain HVAC....................................................3-148 1222 Table 3-129. Server Attribute Sets of the Diagnostics Cluster..............................................................3-150 1223 Table 3-130. Hardware Information Attribute Set................................................................................3-150 1224 Table 3-131. Stack / Network Information Attribute Set......................................................................3-150 1225 Table 3-132. Server Attributes............................................................................................................3-155 1226 Table 3-133. Commands Generated by the Poll Control Server............................................................3-158 1227 Table 3-134. Commands Generated by the Poll Control Client ............................................................3-158 1228 Table 3-135. Attributes of the Power Profile Cluster ...........................................................................3-165 1229 Table 3-136. EnergyRemote Attribute.................................................................................................3-166 1230 Table 3-137. ScheduleMode Attribute.................................................................................................3-166 1231 Table 3-138. Cluster-Specific Commands Received by the Server.......................................................3-166 1232 Table 3-139. Cluster-Specific Commands Sent by the Server ..............................................................3-174 1233 Table 3-140. PowerProfileState Enumeration Field .............................................................................3-178 1234 Table 3-141. Options Field .................................................................................................................3-184 1235 Table 3-142. Attributes of the Meter Identification Server Cluster .......................................................3-190 1236 Table 3-143. Meter Type IDs..............................................................................................................3-190 1237 Table 3-144. Data Quality IDs ............................................................................................................3-191 1238 Table 3-145. Attributes of the Level Control for Lighting server cluster ..............................................3-193 1239 Table 3-146. Options Attribute ...........................................................................................................3-194 1240 Table 3-147. Commands for the Pulse Width Modulation cluster.........................................................3-194 1241 Table 3-148. Lighting Device State Change ........................................................................................3-195 1242 Table 3-149. Attributes of the Pulse Width Modulation server cluster..................................................3-197 1243 Table 3-150. Commands for the Pulse Width Modulation cluster.........................................................3-198 1244 Table 4-1. Illuminance Measurement and Level Sensing Clusters........................................................... 4-1 1245 Table 4-2. Pressure and Flow Measurement Clusters.............................................................................. 4-2 1246 Table 4-3. Occupancy Sensing Clusters ................................................................................................. 4-3 1247 Table 4-4. Electrical Measurement Clusters ........................................................................................... 4-4 1248
- 35. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 31 Table 4-5. Illuminance Measurement Attributes..................................................................................... 4-5 1249 Table 4-6. Values of the LightSensorType Attribute............................................................................... 4-6 1250 Table 4-7. Illuminance Level Sensing Attribute Sets .............................................................................. 4-8 1251 Table 4-8. Illuminance Level Sensing Information Attribute Set............................................................. 4-8 1252 Table 4-9. Values of the LevelStatus Attribute....................................................................................... 4-8 1253 Table 4-10. Values of the LightSensorType Attribute............................................................................. 4-8 1254 Table 4-11. Illuminance Level Sensing Settings Attribute Set................................................................. 4-9 1255 Table 4-12. Temperature Measurement Attribute Sets ...........................................................................4-10 1256 Table 4-13. Temperature Measurement Information Attribute Set .........................................................4-11 1257 Table 4-14. Pressure Measurement Attribute Sets..................................................................................4-12 1258 Table 4-15. Pressure Measurement Information Attribute Set................................................................4-13 1259 Table 4-16. Extended Pressure Measurement Information Attribute Set.................................................4-14 1260 Table 4-17. Flow Measurement Attribute Sets.......................................................................................4-16 1261 Table 4-18. Flow Measurement Information Attribute Set.....................................................................4-16 1262 Table 4-19. Attributes of the Water Content cluster...............................................................................4-18 1263 Table 4-20. Occupancy Sensor Attribute Sets........................................................................................4-20 1264 Table 4-21. Occupancy Sensor Information Attribute Set ......................................................................4-20 1265 Table 4-22. Values of the OccupancySensorType Attribute...................................................................4-20 1266 Table 4-23. The OccupancySensorTypeBitmap Attribute ......................................................................4-21 1267 Table 4-24. Mapping between OccupancySensorType and OccupancySensorTypeBitmap Attributes.....4-21 1268 Table 4-25. Attributes of the PIR Configuration Attribute Set................................................................4-21 1269 Table 4-26. Attributes of the Ultrasonic Configuration Attribute Set......................................................4-22 1270 Table 4-27. Attributes of the Physical Contact Configuration Attribute Set............................................4-22 1271 Table 4-28. Attributes of the Electrical Measurement Cluster ................................................................4-24 1272 Table 4-29. Electrical Measurement Cluster Basic Information..............................................................4-25 1273 Table 4-30. MeasurementType Attribute...............................................................................................4-25 1274 Table 4-31. DC Measurement Attributes...............................................................................................4-26 1275 Table 4-32. DC Formatting Attributes...................................................................................................4-27 1276 Table 4-33. AC (Non-phase Specific) Measurement Attributes..............................................................4-28 1277 Table 4-34. AC (Non-phase Specific) Formatting Attributes..................................................................4-30 1278 Table 4-35. AC (Single Phase or Phase A) Measurement Attributes ......................................................4-31 1279 Table 4-36. AC Formatting Attributes...................................................................................................4-33 1280 Table 4-37. DC Manufacturer Threshold Alarms Attributes...................................................................4-34 1281 Table 4-38. AC Manufacturer Threshold Alarms Attributes...................................................................4-35 1282 Table 4-39. AC Phase B Measurements Attributes ................................................................................4-37 1283 Table 4-40. AC Phase C Measurements Attributes ................................................................................4-40 1284 Table 4-41. Generated Command ID’s for the Electrical Measurement Server.......................................4-43 1285 Table 4-42. List of Status Valid Values.................................................................................................4-44 1286 Table 4-43. Generated Command IDs for the Electrical Measurement Client.........................................4-45 1287 Table 4-44. Attributes of the Electrical Conductivity Measurement server cluster ..................................4-46 1288 Table 4-45. Attributes of the pH Measurement server cluster.................................................................4-48 1289 Table 4-46. Attributes of the Wind Speed Measurement server cluster...................................................4-49 1290 Table 4-47. Attributes of the Concentration Measurement server cluster................................................4-53 1291 Table 5-1. Clusters Specified for the Lighting Functional Domain.......................................................... 5-1 1292 Table 5-2. Hue Control Attribute Sets.................................................................................................... 5-3 1293 Table 5.3. Attributes of the Color Information Attribute Set ................................................................... 5-4 1294 Table 5-4. Values of the DriftCompensation Attribute............................................................................ 5-6 1295 Table 5-5. Values of the ColorMode Attribute........................................................................................ 5-7 1296 Table 5-6. Options Attribute.................................................................................................................. 5-8 1297 Table 5-7. Values of the EnhancedColorMode Attribute......................................................................... 5-8 1298 Table 5-8. Bit Values of the ColorCapabilities Attribute......................................................................... 5-9 1299 Table 5-9. Values of the StartUpColorTemperatureMireds attribute.......................................................5-11 1300 Table 5-10. Defined Primaries Information Attribute Set.......................................................................5-11 1301 Table 5-11. Additional Defined Primaries Information Attribute Set......................................................5-12 1302 Table 5-12. Defined Color Points Settings Attribute Set ........................................................................5-13 1303 Table 5-13. Command IDs for the Color Control Cluster.......................................................................5-14 1304
- 36. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 32 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Table 5-14. Values of the Direction Field..............................................................................................5-16 1305 Table 5-15. Values of the Move Mode Field .........................................................................................5-17 1306 Table 5-16. Actions on Receipt for Move Hue Command......................................................................5-18 1307 Table 5-17. Values of the Step Mode Field ...........................................................................................5-18 1308 Table 5-18. Actions on Receipt for Step Hue Command........................................................................5-19 1309 Table 5-19. Values of the Move Mode Field .........................................................................................5-20 1310 Table 5-20. Actions on Receipt for Move Saturation Command ............................................................5-21 1311 Table 5-21. Values of the Step Mode Field ...........................................................................................5-21 1312 Table 5-22. Actions on Receipt for Step Saturation Command...............................................................5-22 1313 Table 5-23. Actions on Receipt of the Enhanced Move Hue Command .................................................5-26 1314 Table 5-24. Actions on Receipt for the Enhanced Step Hue Command ..................................................5-28 1315 Table 5-25. Values of the Action Field of the Color Loop Set Command...............................................5-29 1316 Table 5-26. Values of the Direction Field of the Color Loop Set Command...........................................5-30 1317 Table 5-27. Actions on Receipt of the Move Color Temperature Command...........................................5-32 1318 Table 5-28. Actions on Receipt of the Step Color Temperature Command.............................................5-34 1319 Table 5-29. Ballast Configuration Attribute Sets ...................................................................................5-36 1320 Table 5-30. Attributes of the Ballast Information Attribute Set ..............................................................5-36 1321 Table 5-31. Bit Usage of the BallastStatus Attribute..............................................................................5-37 1322 Table 5-32. Attributes of the Ballast Settings Attribute Set....................................................................5-37 1323 Table 5-33. Attributes of the Lamp Information Attribute Set................................................................5-38 1324 Table 5-34. Attributes of the Lamp Settings Attribute Set......................................................................5-38 1325 Table 5-35. Values of the MainsAlarmMode Attribute..........................................................................5-39 1326 Table 5-36. Examples of The Dimming Light Curve .............................................................................5-40 1327 Table 6-1. Clusters Specified in the HVAC Functional Domain.............................................................. 6-1 1328 Table 6-2. Pump Configuration Attribute Sets........................................................................................ 6-4 1329 Table 6-3. Attributes of the Pump Information Attribute Set................................................................... 6-4 1330 Table 6-4. Attributes of the Pump Dynamic Information Attribute Set.................................................... 6-7 1331 Table 6-5. Values of the PumpStatus Attribute....................................................................................... 6-7 1332 Table 6-6. Attributes of the Pump Settings Attribute Set......................................................................... 6-9 1333 Table 6-7. Values of the OperationMode Attribute................................................................................6-11 1334 Table 6-8. Values of the ControlMode Attribute....................................................................................6-11 1335 Table 6-9. Alarm Codes........................................................................................................................6-12 1336 Table 6-10. Currently Defined Thermostat Attribute Sets ......................................................................6-14 1337 Table 6-11. Attributes of the Thermostat Information Attribute Set .......................................................6-14 1338 Table 6-12. HVAC System Type Configuration Values.........................................................................6-16 1339 Table 6-13. Attributes of the Thermostat Settings Attribute Set .............................................................6-17 1340 Table 6-14. RemoteSensing Attribute Bit Values ..................................................................................6-19 1341 Table 6-15. ControlSequenceOfOperation Attribute Values...................................................................6-19 1342 Table 6-16. SystemMode Attribute Values............................................................................................6-20 1343 Table 6-17. Interpretation of SystemMode Values.................................................................................6-20 1344 Table 6-18. Alarm Codes......................................................................................................................6-20 1345 Table 6.19 Thermostat Running Mode Attribute Values........................................................................6-21 1346 Table 6-20. Thermostat Schedule & HVAC Relay Attribute Set ............................................................6-21 1347 Table 6-21. StartofWeek Enumeration Values.......................................................................................6-21 1348 Table 6-22. TemperatureSetpointHold Attribute Values ........................................................................6-22 1349 Table 6-23. ThermostatProgrammingOperationMode Attribute Values..................................................6-23 1350 Table 6-24. HVAC Relay State Values .................................................................................................6-23 1351 Table 6-25. Thermostat Setpoint Change Tracking Attribute Set............................................................6-23 1352 Table 6-26. SetpointChangeSource Values............................................................................................6-24 1353 Table 6-27. SetpointChangeAmount Values..........................................................................................6-24 1354 Table 6-28. Attributes of the AC Information Attribute Set ...................................................................6-27 1355 Table 6-29. ACType Enumeration ........................................................................................................6-27 1356 Table 6-30. ACRefrigerantType Enumeration .......................................................................................6-27 1357 Table 6-31. ACCompressorType Enumeration......................................................................................6-28 1358 Table 6-32. ACErrorCode Values.........................................................................................................6-28 1359 Table 6-33. ACLouverPosition Values..................................................................................................6-28 1360
- 37. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 33 Table 6-34. ACCapacity Enumeration...................................................................................................6-29 1361 Table 6-35. Command IDs for the Thermostat Cluster...........................................................................6-29 1362 Table 6-36. Mode Field Values for Setpoint Raise/Lower Command.....................................................6-30 1363 Table 6-37. Day Of Week for Sequence Values.....................................................................................6-31 1364 Table 6-38. Mode for Sequence Values.................................................................................................6-31 1365 Table 6-39. Server Commands Send Command ID................................................................................6-35 1366 Table 6-40. Attributes of the Fan Control Cluster..................................................................................6-37 1367 Table 6-41. FanMode Attribute Values .................................................................................................6-38 1368 Table 6-42. FanSequenceOperation Attribute Values ............................................................................6-38 1369 Table 6-43. Dehumidification Control Attribute Sets.............................................................................6-39 1370 Table 6-44. Dehumidification Information Attribute Set........................................................................6-40 1371 Table 6-45. Dehumidification Settings Attribute Set..............................................................................6-40 1372 Table 6-46. RelativeHumidityMode Attribute Values............................................................................6-40 1373 Table 6-47. DehumidificationLockout Attribute Values ........................................................................6-41 1374 Table 6-48. RelativeHumidityMode Attribute Values............................................................................6-41 1375 Table 6-49. Thermostat User Interface Configuration Cluster................................................................6-42 1376 Table 6-50. DisplayMode Attribute Values ...........................................................................................6-43 1377 Table 6-51. KeypadLockout Attribute Values .......................................................................................6-43 1378 Table 6-52. ScheduleProgrammingVisibility Attribute Values...............................................................6-43 1379 Table 7-1. Clusters Specified in the Closures Functional Domain ........................................................... 7-1 1380 Table 7-2. Shade Configuration Attribute Sets ....................................................................................... 7-3 1381 Table 7-3. Attributes of the Shade Information Attribute Set .................................................................. 7-3 1382 Table 7-4. Bit Values for the Status Attribute......................................................................................... 7-4 1383 Table 7-5. Attributes of the Shade Settings Attribute Set ........................................................................ 7-4 1384 Table 7-6. Values of the Mode Attribute ................................................................................................ 7-4 1385 Table 7-7. Attribute Sets Description ..................................................................................................... 7-8 1386 Table 7-8. Current Information Attribute Set.......................................................................................... 7-8 1387 Table 7-9. LockState Attribute Values ................................................................................................... 7-8 1388 Table 7-10. LockType Attribute Values ................................................................................................. 7-9 1389 Table 7-11. ActuatorEnabled Attribute Values....................................................................................... 7-9 1390 Table 7-12. DoorState Attribute Values ................................................................................................7-10 1391 Table 7-13. User, PIN, Schedule, Log Information Attribute Set............................................................7-10 1392 Table 7-14. Operational Settings Attribute Set ......................................................................................7-12 1393 Table 7-15. Operating Modes ...............................................................................................................7-13 1394 Table 7-16. Bit Values for the SupportedOperatingModes Attribute ......................................................7-14 1395 Table 7-17. Modes for the LEDSettings Attribute .................................................................................7-14 1396 Table 7-18. Settings for the SoundVolume Attribute .............................................................................7-14 1397 Table 7-19. DefaultConfigurationRegister Attribute..............................................................................7-15 1398 Table 7-20. Security Settings Attribute Set............................................................................................7-16 1399 Table 7-21. Alarm and Event Masks Attribute Set.................................................................................7-17 1400 Table 7-22. Alarm Code Table..............................................................................................................7-17 1401 Table 7-23. Commands Received by the Server Cluster.........................................................................7-19 1402 Table 7-24. User Status Value...............................................................................................................7-21 1403 Table 7-25. User Type Value................................................................................................................7-22 1404 Table 7-26. User Status Byte Values for Set RFID Code Command.......................................................7-28 1405 Table 7-27. Commands Generated by the Server Cluster .......................................................................7-29 1406 Table 7-28. Operation Event Source Value ...........................................................................................7-41 1407 Table 7-29. Operation Event Code Value..............................................................................................7-42 1408 Table 7-30. Keypad Operation Event Value ..........................................................................................7-43 1409 Table 7-31. RF Operation Event Value .................................................................................................7-43 1410 Table 7-32. Manual Operation Event Value ..........................................................................................7-44 1411 Table 7-33. RFID Operation Event Value .............................................................................................7-44 1412 Table 7-34. Operation Event Source Value ...........................................................................................7-45 1413 Table 7-35. Programming Event Codes.................................................................................................7-46 1414 Table 7-36. Keypad Programming Event Value.....................................................................................7-47 1415 Table 7-37. RF Programming Event Value............................................................................................7-47 1416
- 38. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 34 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Table 7-38. RFID Programming Event Value........................................................................................7-48 1417 Table 7-39. Window Covering Attribute Set .........................................................................................7-50 1418 Table 7-40. Window Covering Information Attribute Set ......................................................................7-50 1419 Table 7-41. Window Covering Type .....................................................................................................7-51 1420 Table 7-42. Bit Meanings for the Config/Status Attribute......................................................................7-52 1421 Table 7-43. Window Covering Settings Attribute Set ............................................................................7-53 1422 Table 7-44. Bit Meanings for the Mode Attribute..................................................................................7-54 1423 Table 7-45. Commands Received by the Window Covering Server Cluster............................................7-55 1424 Table 8-1. Clusters of the Security and Safety Functional Domain.......................................................... 8-1 1425 Table 8-2. Attribute Sets for the IAS Zone Cluster ................................................................................. 8-3 1426 Table 8-3. Attributes of the Zone Information Attribute Set.................................................................... 8-3 1427 Table 8-4. Values of the ZoneState Attribute.......................................................................................... 8-3 1428 Table 8-5. Values of the ZoneType Attribute ......................................................................................... 8-4 1429 Table 8-6. Values of the ZoneStatus Attribute........................................................................................ 8-4 1430 Table 8-7. Usage of alarm bits of ZoneStatus Attribute for door/window handle zone type (0x0016)....... 8-5 1431 Table 8-8. Attributes of the Zone Settings Attribute Set.......................................................................... 8-6 1432 Table 8-9. Received Command IDs for the IAS Zone Cluster................................................................. 8-8 1433 Table 8-10. Values of the Enroll Response Code.................................................................................... 8-9 1434 Table 8-11. Generated Command IDs for the IAS Zone Cluster.............................................................8-11 1435 Table 8-12. Format of the Zone Table...................................................................................................8-14 1436 Table 8-13. Received Command IDs for the IAS ACE Cluster ..............................................................8-14 1437 Table 8-14. Arm Mode Field Values.....................................................................................................8-15 1438 Table 8-15. Generated Command IDs for the IAS ACE Cluster.............................................................8-19 1439 Table 8-16. Arm Notification Values ....................................................................................................8-19 1440 Table 8-17. PanelStatus Field Values....................................................................................................8-22 1441 Table 8-18. Values of Bypass Result Field............................................................................................8-26 1442 Table 8-19. Attributes of the IAS WD (Server) Cluster .........................................................................8-28 1443 Table 8-20. Received Command IDs for the IAS WD Server Cluster.....................................................8-28 1444 Table 8-21. Warning Modes .................................................................................................................8-29 1445 Table 8-22. Values of the Strobe Field ..................................................................................................8-29 1446 Table 8-23. Siren Level Field Values....................................................................................................8-30 1447 Table 8-24. Strobe Level Field Values ..................................................................................................8-30 1448 Table 8-25. Squawk Mode Field...........................................................................................................8-31 1449 Table 8-26. Strobe Bit ..........................................................................................................................8-31 1450 Table 8-27. Squawk Level Field Values................................................................................................8-31 1451 Table 9-1. Clusters of the Protocol Interfaces Functional........................................................................ 9-1 1452 Table 9-2. Attributes of the Generic Tunnel Cluster ............................................................................... 9-3 1453 Table 9-3. Command IDs Received by the Generic Tunnel Cluster......................................................... 9-4 1454 Table 9-4. Command IDs Generated by the Generic Tunnel Cluster ....................................................... 9-5 1455 Table 9-5. Command IDs for the BACnet Protocol Tunnel Cluster......................................................... 9-7 1456 Table 9-6. Attributes of the Analog Input (BACnet Regular) Server ....................................................... 9-9 1457 Table 9-7. Attributes of the Analog Input (BACnet Extended) Server....................................................9-10 1458 Table 9-8. Attributes of the Analog Output (BACnet Regular) Server....................................................9-11 1459 Table 9-9. Attributes of the Analog Output (BACnet Extended) Server .................................................9-13 1460 Table 9-10. Attributes of the Analog Value (BACnet Regular) Server ...................................................9-14 1461 Table 9-11. Attributes of the Analog Value (BACnet Extended) Server.................................................9-15 1462 Table 9-12. Attributes of the Binary Input (BACnet Regular) Server .....................................................9-16 1463 Table 9-13. Attributes of the Binary Input (BACnet Extended) Server...................................................9-18 1464 Table 9-14. Attributes of the Binary Output (BACnet Regular) Server...................................................9-19 1465 Table 9-15. Attributes of the Binary Output (BACnet Extended) Server ................................................9-21 1466 Table 9-16. Attributes of the Binary Value (BACnet Regular) Server ....................................................9-22 1467 Table 9-17. Attributes of the Binary Value (BACnet Extended) Server..................................................9-23 1468 Table 9-18. Attributes of the Multistate Input (BACnet Regular) Server ................................................9-25 1469 Table 9-19. Attributes of Multistate Input (BACnet Extended) Server ...................................................9-26 1470 Table 9-20. Attributes of Multistate Output (BACnet Regular) Server ...................................................9-27 1471 Table 9-21. Attributes of Multistate Output (BACnet Extended) Server.................................................9-28 1472
- 39. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 35 Table 9-22. Attributes of Multistate Value (BACnet Regular) Server.....................................................9-30 1473 Table 9-23. Attributes of Multistate Value (BACnet Extended) Server ..................................................9-31 1474 Table 9-24. Definitions Used in ISO 7816 Protocol Tunnel Description.................................................9-35 1475 Table 9-25. Attributes for the ISO7816 Tunnel Cluster..........................................................................9-37 1476 Table 9-26. Status Values.....................................................................................................................9-37 1477 Table 9-27. Received Command IDs for the ISO7816 Tunnel Cluster ...................................................9-37 1478 Table 9-28. Generated Command IDs for the ISO7816 Tunnel Cluster..................................................9-38 1479 Table 9-29. Attributes of the Partition Cluster .......................................................................................9-42 1480 Table 9-30. Server Received Command IDs for the Partition Cluster.....................................................9-44 1481 Table 9-31. Generated Command IDs for the Partition Cluster ..............................................................9-46 1482 Table 9-32. Registration Table of Clusters Using the Partition Cluster...................................................9-48 1483 Table 9-33 – Attributes of the 11073 Protocol Tunnel server cluster ......................................................9-51 1484 Table 9-34 – Command IDs for the 11073 protocol tunnel cluster .........................................................9-52 1485 Table 9-35 – Connect status values.......................................................................................................9-56 1486 Table 10-1. Smart Energy Clusters........................................................................................................10-1 1487 Table 10-2. Price Cluster Attribute Sets.................................................................................................10-3 1488 Table 10-3. Tier Label Attribute Set......................................................................................................10-3 1489 Table 10-4. Block Threshold Attribute Set............................................................................................10-4 1490 Table 10-5. Block Period Attribute Set..................................................................................................10-5 1491 Table 10-6. Commodity Attribute Set ...................................................................................................10-6 1492 Table 10-7. Values and Descriptions for the CalorificValueUnit Attribute..............................................10-7 1493 Table 10-8. Block Price Information Attribute Set.................................................................................10-7 1494 Table 10-9. Billing Information Attribute Set......................................................................................10-10 1495 Table 10-10. Received Command IDs for the Price Cluster..................................................................10-11 1496 Table 10-11. Generated Command IDs for the Price Cluster ................................................................10-15 1497 Table 10-12. Price Tier Sub-field Enumerations..................................................................................10-17 1498 Table 10-13. Register Tier Sub-field Enumerations .............................................................................10-18 1499 Table 10-14. Alternate Cost Unit Enumerations ..................................................................................10-19 1500 Table 10-15. Price Control Field BitMap.............................................................................................10-20 1501 Table 10-16. Block Period Control Field BitMap.................................................................................10-21 1502 Table 10-17. Price Client Cluster Attributes ........................................................................................10-23 1503 Table 10-18. Command IDs for the Demand Response and Load Control Server..................................10-27 1504 Table 10-19. Device Class Field BitMap/Encoding.............................................................................10-28 1505 Table 10-20. Criticality Levels............................................................................................................10-29 1506 Table 10-21. Event Control Field BitMap............................................................................................10-31 1507 Table 10-22. Cancel Control...............................................................................................................10-32 1508 Table 10-23. Format of the Cancel All Load Control Events Command Payload..................................10-33 1509 Table 10-24. Cancel All Command Cancel Control Field ....................................................................10-33 1510 Table 10-25. Demand Response Client Cluster Attributes....................................................................10-34 1511 Table 10-26. Generated Command IDs for the Demand Response and Load Control Client..................10-35 1512 Table 10-27. Event Status Field Values...............................................................................................10-36 1513 Table 10-28. Enumerated Values of Signature Types ..........................................................................10-37 1514 Table 10-29. Metering Cluster Attribute Sets ......................................................................................10-53 1515 Table 10-30. Reading Information Attribute Set ..................................................................................10-54 1516 Table 10-31. Block Enumerations.......................................................................................................10-57 1517 Table 10-32. Supply Status Attribute Enumerations............................................................................10-58 1518 Table 10-33. TOU Information Attribute Set.......................................................................................10-59 1519 Table 10-34. Meter Status Attribute Set ..............................................................................................10-62 1520 Table 10-35. Mapping of the Status Attribute (Electricity)...................................................................10-62 1521 Table 10-36. Meter Status Attribute (Gas)...........................................................................................10-63 1522 Table 10-37. Meter Status Attribute (Water)........................................................................................10-63 1523 Table 10-38. Meter Status Attribute (Heat and Cooling)......................................................................10-63 1524 Table 10-39. Formatting Examples.....................................................................................................10-65 1525 Table 10-40. Formatting Attribute Set.................................................................................................10-65 1526 Table 10-41. UnitofMeasure Attribute Enumerations...........................................................................10-66 1527
- 40. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 36 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Table 10-42. MeteringDeviceType Attribute .......................................................................................10-68 1528 Table 10-43. TemperatureUnitOfMeasureEnumeration.......................................................................10-70 1529 Table 10-44. Historical Consumption Attribute Set..............................................................................10-71 1530 Table 10-45. Load Profile Configuration Attribute Set........................................................................10-74 1531 Table 10-46. Supply Limit Attribute Set .............................................................................................10-74 1532 Table 10-47. Block Information Attribute Set......................................................................................10-75 1533 Table 10-48. Alarm Attribute Set ........................................................................................................10-79 1534 Table 10-49. Alarm Code Groups .......................................................................................................10-79 1535 Table 10-50. Generic Alarm Group.....................................................................................................10-80 1536 Table 10-51. Electricity Alarm Group .................................................................................................10-80 1537 Table 10-52. Generic Flow/Pressure Alarm Group ..............................................................................10-81 1538 Table 10-53. Water Specific Alarm Group ..........................................................................................10-81 1539 Table 10-54. Heat and Cooling Specific Alarm Group.........................................................................10-82 1540 Table 10-55. Gas Specific Alarm Group..............................................................................................10-82 1541 Table 10-56. Generated Command IDs for the Metering Server...........................................................10-82 1542 Table 10-57. Status Field Values.........................................................................................................10-83 1543 Table 10-58. ProfileIntervalPeriod Timeframes...................................................................................10-83 1544 Table 10-59. Generated Command IDs for the Metering Client ...........................................................10-85 1545 Table 10-60. Interval Channel Values .................................................................................................10-85 1546 Table 10-61. Generated Command IDs for the Messaging Server.........................................................10-90 1547 Table 10-62. Message Control Field Bit Map ......................................................................................10-90 1548 Table 10-63. Messaging Client Commands.........................................................................................10-92 1549 Table 10-64. Tunneling Cluster Attributes ..........................................................................................10-99 1550 Table 10-65. Cluster Parameters Passed Through Commands..............................................................10-99 1551 Table 10-66. Cluster-specific Commands Received by the Server......................................................10-100 1552 Table 10-67. ProtocolID Enumerations .............................................................................................10-100 1553 Table 10-68. TransferDataStatus Values ...........................................................................................10-103 1554 Table 10-69. Cluster-Specific Commands Sent by the Server.............................................................10-105 1555 Table 10-70. TunnelStatus Values ....................................................................................................10-106 1556 Table 10-71. Clusters Specified for the Secure Communication Functional Domain ..........................10-112 1557 Table 10-72. Key Establishment Attribute Sets .................................................................................10-115 1558 Table 10-73. Information Attribute Sets............................................................................................10-115 1559 Table 10-74. Values of the KeyEstablishmentSuite Attribute.............................................................10-116 1560 Table 10-75. Received Command IDs for the Key Establishment Cluster Server ................................10-116 1561 Table 10-76. Terminate Key Establishment Command Status Field ...................................................10-118 1562 Table 10-77. Key Establishment Attribute Sets.................................................................................10-119 1563 Table 10-78. Attributes of the Information Attribute Set....................................................................10-119 1564 Table 10-79. Values of the KeyEstablishmentSuite Attribute.............................................................10-119 1565 Table 10-80. Received Command IDs for the Key Establishment Cluster Client.................................10-120 1566 Table 10-81. Terminate Key Establishment Command Status Field...................................................10-122 1567 Table 10-82. Parameters Used by Methods of the CBKE Protocol .....................................................10-127 1568 Table 11-1. Clusters Specified in This Document..................................................................................11-2 1569 Table 11-2. OTA Header Fields............................................................................................................11-6 1570 Table 11-3. OTA Header Field Control Bitmask ...................................................................................11-7 1571 Table 11-4. Image Type Values ............................................................................................................11-8 1572 Table 11-5. Recommended File Version Definition...............................................................................11-8 1573 Table 11-6. ZigBee Stack Version Values.............................................................................................11-9 1574 Table 11-7. Security Credential Version..............................................................................................11-10 1575 Table 11-8. Hardware Version Format................................................................................................11-10 1576 Table 11-9. Tag Identifiers .................................................................................................................11-11 1577 Table 11-10. Attributes of OTA Upgrade Cluster ................................................................................11-19 1578 Table 11-11. Image Upgrade Status Attribute Values ..........................................................................11-21 1579 Table 11-12. UpgradeActivationPolicy Enumerations .........................................................................11-22 1580 Table 11-13. UpgradeTimeoutPolicy Enumerations ............................................................................11-23 1581 Table 11-14. Parameters of OTA Upgrade Cluster ..............................................................................11-23 1582
- 41. Zigbee Cluster Library Specification Zigbee Document – 075123 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 37 Table 11-15. Meaning of CurrentTime and UpgradeTime Parameters..................................................11-24 1583 Table 11-16. OTA Upgrade Cluster Command Frames .......................................................................11-27 1584 Table 11-17. Status Code Defined and Used by OTA Upgrade Cluster ................................................11-28 1585 Table 11-18. Image Notify Command Payload Type ...........................................................................11-29 1586 Table 11-19. Query Next Image Request Field Control Bitmask..........................................................11-31 1587 Table 11-20. Image Block Request Field Control Bitmask...................................................................11-35 1588 Table 11-21. Image Page Request Field Control Bitmask ....................................................................11-38 1589 Table 12-1. Telecom Cluster List..........................................................................................................12-1 1590 Table 12-2. Clusters Specified for the Information Delivery..................................................................12-3 1591 Table 12-3. Information Cluster Attribute Sets......................................................................................12-7 1592 Table 12-4. Node Information Attribute Set ..........................................................................................12-7 1593 Table 12-5. Contents Information Attribute Set.....................................................................................12-8 1594 Table 12-6. Received Command IDs for the Information Cluster...........................................................12-8 1595 Table 12-7. Inquiry ID..........................................................................................................................12-9 1596 Table 12-8. Data Type IDs....................................................................................................................12-9 1597 Table 12-9. Preference Type...............................................................................................................12-12 1598 Table 12-10. Value of the Access Control Field ..................................................................................12-14 1599 Table 12-11. Generated Command IDs for the Information Cluster .....................................................12-18 1600 Table 12-12. Enumerated Status Values Used in the ZCL....................................................................12-24 1601 Table 12-13. Chatting Attributes Sets..................................................................................................12-27 1602 Table 12-14. Attributes of the User Related Attribute Set ....................................................................12-27 1603 Table 12-15. Attributes of Chat Session Related Attribute Set .............................................................12-28 1604 Table 12-16. Command IDs for the Chatting Cluster...........................................................................12-28 1605 Table 12-17. Generated Command IDs for the Chatting Cluster ..........................................................12-32 1606 Table 12-18. VoZ Attribute Sets.........................................................................................................12-38 1607 Table 12-19. Attributes of the Voice Information Attribute Set............................................................12-38 1608 Table 12-20. Command IDs for the VoZ Cluster.................................................................................12-40 1609 Table 12-21. Generated Command IDs for the VoZ Cluster.................................................................12-43 1610 Table 12-22. The Error Flag of Voice Transmission Response.............................................................12-44 1611 Table 13-1. Commissioning Attribute Sets............................................................................................13-3 1612 Table 13-2. Attributes of the Startup Parameters Attribute Set...............................................................13-3 1613 Table 13-3. Stack Profile Compatibility for the ShortAddress Attribute .................................................13-5 1614 Table 13-4. Stack Profile Compatibility for the PANId Attribute...........................................................13-5 1615 Table 13-5. StartupControl Attribute Usage ..........................................................................................13-7 1616 Table 13-6. Stack Profile Compatibility for the StartupControl Attribute...............................................13-8 1617 Table 13-7. Attributes of the Join Parameters Attribute Set....................................................................13-9 1618 Table 13-8. Attributes of the End Device Parameters Attribute Set ......................................................13-10 1619 Table 13-9. Attributes of the Concentrator Parameters Attribute Set ....................................................13-11 1620 Table 13-10. Commands Received by the Commissioning Cluster Server............................................13-12 1621 Table 13-11. Startup Mode Sub-field Values.......................................................................................13-13 1622 Table 13-12. Commands Generated by the Commissioning Cluster Server ..........................................13-16 1623 Table 13-13. Commands Received by the Server Side of the Touchlink Commissioning Cluster..........13-20 1624 Table 13-14. Values of the Identify Duration Field..............................................................................13-23 1625 Table 13-15. Commands Generated by the Server Side of the Touchlink Commissioning Cluster ........13-32 1626 Table 13-16. Values of the Status Field of the Network Start Response Command Frame....................13-38 1627 Table 13-17. Values of the Status Field of the Network Join Router Response Command Frame..........13-39 1628 Table 13-18. Values of the Status Field of the Network Join End Device Response Command Frame ..13-41 1629 Table 13-19. Commands Received by the Client Side of the ZLL Commissioning Cluster ...................13-44 1630 Table 13-20. Commands Generated by the Client Side of the ZLL Commissioning Cluster..................13-44 1631 Table 13-21. Touchlink Commissioning Constants..............................................................................13-45 1632 Table 13-22. Touchlink Commissioning Attributes .............................................................................13-45 1633 Table 13-23. Key Encryption Algorithms............................................................................................13-53 1634 Table 14-1. Clusters Specified in this Chapter.......................................................................................14-1 1635 Table 14-2. Attributes of the Retail Tunnel cluster ................................................................................14-3 1636 Table 14-3. Cluster-specific Commands Received by the Server............................................................14-3 1637 Table 14-4. Attributes of the Mobile Device Cleaning Cluster...............................................................14-6 1638
- 42. Zigbee Cluster Library Specification Zigbee Document – 075123 Page 38 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Table 14-5. Cluster-specific Commands Generated by the Server ..........................................................14-6 1639 Table 14-6. Attributes of the Neighbor Cleaning Cluster .......................................................................14-9 1640 Table 14-7. Cluster-specific Commands Generated by the Server ..........................................................14-9 1641 Table 14-8. Attributes of the Nearest Gateway Cluster ........................................................................14-11 1642 Table 15-1. Appliance Management Clusters ........................................................................................15-1 1643 Table 15-2. Appliance Control Attribute Set .........................................................................................15-2 1644 Table 15-3. Attributes of the Appliance Functions Attribute Set ............................................................15-3 1645 Table 15-4. Time Encoding ..................................................................................................................15-3 1646 Table 15-5. Cluster-specific Commands Received by the Server............................................................15-4 1647 Table 15-6. Command Identification Values .........................................................................................15-4 1648 Table 15-7. Format of the Event ID Enumerator....................................................................................15-7 1649 Table 15-8. Cluster-specific Commands Sent by the Server...................................................................15-8 1650 Table 15-9. Appliance Status Values.....................................................................................................15-9 1651 Table 15-10. Remote Enable Flags Values............................................................................................15-9 1652 Table 15-11. Appliance Identification Attribute Sets ...........................................................................15-11 1653 Table 15-12. Attributes of the Appliance Identification Attribute Set...................................................15-12 1654 Table 15-13. Basic Appliance Identification Content Specification......................................................15-12 1655 Table 15-14. Product Type IDs...........................................................................................................15-12 1656 Table 15-15. Attributes of the Extended Appliance Identification Attribute Set....................................15-13 1657 Table 15-16. CECED Specification Version........................................................................................15-15 1658 Table 15-17. Received Commands IDs for the Events and Alerts Cluster.............................................15-17 1659 Table 15-18. Generated Commands IDs for the Appliance Events and Alerts Cluster...........................15-17 1660 Table 15-19. Alert Count Organization ...............................................................................................15-18 1661 Table 15-20. Alerts Structure Organization .........................................................................................15-19 1662 Table 15-21. Event Identification........................................................................................................15-20 1663 Table 15-22. Server Attributes............................................................................................................15-23 1664 Table 15-23. Commands Generated by the Appliance Statistics Server................................................15-23 1665 Table 15-24. Commands Generated by the Appliance Statistics Client.................................................15-26 1666 1667
- 43. Zigbee Cluster Library Specification Chapter 1 Zigbee Alliance Document – 075123 Introduction Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 1-1 CHAPTER 1 INTRODUCTION 1668 The Zigbee Cluster Library is made of individual chapters such as this one. See Document Control in the Zigbee 1669 Cluster Library for a list of all chapters and documents. References between chapters are made using a X.Y notation 1670 where X is the chapter and Y is the sub-section within that chapter. References to external documents are contained in 1671 Chapter 1 and are made using [Rn] notation. 1672 1.1 Scope and Purpose 1673 This document specifies the Zigbee Cluster Library (ZCL). The ZCL is a repository for cluster functionality that is 1674 developed by the Zigbee Alliance, and is a working library with regular updates as new functionality is added. 1675 A developer constructing a new application should use the ZCL to find relevant cluster functionality that can be 1676 incorporated into the new application. Correspondingly, new clusters that are defined for applications should be 1677 considered for inclusion in the ZCL. 1678 The ZCL consists of the ZCL Foundation, a set of elements that apply across the entire library (such as frame 1679 structures, attribute access commands and data types), and a number of sets of clusters. Clusters that are generally 1680 useful across many application domains are included in the General set. Clusters that are intended for use mainly in 1681 specific application domains are grouped together in domain oriented sets. 1682 1.2 Acronyms and Abbreviations 1683 Table 1-1. Acronyms and Abbreviations 1684 Acronym Definition Acc Access ACE Ancillary Control Equipment AES Advanced Encryption Standard AIB Application support sub-layer Information Base AMI Advanced Metering Infrastructure or Advanced Metering Initiative AP Access Point APS Application support Sub-layer BPL Broadband over Power Lines CA Certificate Authority CBA Commercial Building Automation CBKE Certificate-based Key Establishment CIE Control and Indicating Equipment CT Commissioning Tool D Deprecated Def Default ECDSA Elliptic Curve Digital Signature Algorithm
- 44. Chapter 1 Zigbee Cluster Library Specification Introduction Zigbee Alliance Document – 075123 Page 1-2 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Acronym Definition ECMQV Elliptic Curve Menezes-Qu-Vanstone EFT Electronic Funds Transfer EMS Energy Management System EOF End of File EPID Extended PAN Identifier ESI Energy Service Interface ESP Energy Service Portal EUI64 Extended Universal Identifier-64 GPRS General Packet Radio Service HA Home Automation (Application Profile) HAN Home Area Network HVAC Heating, Ventilation, Air Conditioning IAS Intruder Alarm System ID Information delivery ID Identifier (or Id) IHD In-Home Display IN Information node IPD In-Premises Display (Same as IHD) or Inter-PAN Device IVR Interactive Voice Response M Mandatory M/O Mandatory or Optional MAC Medium Access Control (referring to protocol stack sublayer) MAC Message Authentication Code (referring to cryptographic operation) MAC PIB Medium Access Control sub-layer PAN Information Base m-commerce Mobile commerce MRD Market Requirements Document MT Mobile Terminal NAN Neighborhood Area Network NIB Network layer Information Base NWK Network layer O Optional OTA Over the Air P Mandates that an attribute is reportable P2P Peer to Peer
- 45. Zigbee Cluster Library Specification Chapter 1 Zigbee Alliance Document – 075123 Introduction Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 1-3 Acronym Definition PAN Personal Area Network PCT Programmable Communicating Thermostat PD Payment Device PHHC Personal Home and hospital Health Care PID PAN Identifier PIR Pyroelectric Infra-Red (a type of motion detection sensor) PKKE Public Key Key Establishment POS Point of Sales R Readable (Read) or Read only if not also designated as Writable (W) R*W Readable and optionally writable RAN RSSI Anchor Node RFD Reduced Functionality Device RLG RSSI Location Gateway RLN RSSI Location node RSSI Received Signal Strength Indication R/W Readable and Writable (same as RW) S Mandates that an attribute is part of a scene, if the Scene cluster is on the same endpoint SAS Startup Attribute Set SE Smart Energy (Application Profile) SED Sleepy End Device is a Zigbee End Device with rxOnWhenIdle set to FALSE SKKE Symmetric Key Key Exchange SVE Specification Validation Event TC Trust Center TOU Time of Use TRD Technical Requirements Document UKE Unprotected Key Establishment UTF-8 8-bit Unicode Transformation Format W Writable (Write) or Write only if not also designated as Readable WD Warning Device ZCL Zigbee Cluster Library ZCLn A revision of the ZCL. For example: ZCL6 is the Zigbee Cluster Library revision 6 ZDO Zigbee Device Object ZDP Zigbee Device Profile
- 46. Chapter 1 Zigbee Cluster Library Specification Introduction Zigbee Alliance Document – 075123 Page 1-4 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Acronym Definition ZED Zigbee End Device (equivalent to IEEE’s RFD – Reduced Functionality Device) ZR Zigbee Router (equivalent to IEEE’s FFD – Full Functionality Device) 1.3 Definitions 1685 Many of these terms are described in more detail in the core stack specification [Z1], or the Application Architecture 1686 specification [Z5]. 1687 Application Cluster: An application cluster generates persistent functional application transactions between client 1688 and server. 1689 Attribute: A data entity which represents a physical quantity or state. This data is communicated to other devices 1690 using commands. 1691 Binding: A persistent mapping of a local cluster instance to one or more corresponding remote cluster instances. A 1692 binding can be broadcast, groupcast, or unicast. A unicast binding includes an address (IEEE or network) and endpoint. 1693 Cluster: A cluster is a specification defining one or more attributes, commands, behaviors and dependencies, that 1694 supports an independent utility or application function. The term may also be used for an implementation or instance 1695 of such a specification on an endpoint. 1696 Cluster identifier: The cluster identifier is a 16-bit number that maps to (identifies) a single cluster specification. 1697 More than one cluster identifier may map to a cluster specification, each defining a different scope and purpose. 1698 Cluster identifiers are designated as inputs or outputs in the simple descriptor for use in creating a binding table. 1699 Client: A cluster interface which is listed in the output cluster list of the simple descriptor on an endpoint. Typically 1700 this interface sends commands that manipulate the attributes on the corresponding server cluster. A client cluster 1701 communicates with a corresponding remote server cluster with the same cluster identifier. 1702 Corresponding cluster: The opposite side of a cluster (client to a server, or server to a client). 1703 Device: A specification which defines a unique device identifier and a set of mandatory and optional clusters to be 1704 implemented on a single endpoint. The term may also be used for an implementation or instance of the device 1705 specification on an endpoint. 1706 Node: A Zigbee node (or node) is a single testable implementation of a Zigbee application on a single Zigbee stack, 1707 with a single network address, on a single network. 1708 Product: A product is a node that is intended to be marketed. 1709 Server: A cluster interface which is listed in the input cluster list of the simple descriptor on an endpoint. Typically, 1710 this interface supports all or most of the attributes of the cluster. A server cluster communicates with a corresponding 1711 remote client cluster with the same cluster identifier. 1712 Service discovery: The ability of a device to locate services of interest. 1713 Sleepy End Device: A Zigbee End Device with rxOnWhenIdle set to FALSE. 1714 Utility Cluster: A utility cluster is not part of the application function of the product. It may be used for 1715 commissioning, configuration, discovery, addressing, diagnostics, etc. 1716 Type 1 Cluster: A type 1 cluster’s primary function is to initiate transactions from the client to the server. 1717 Type 2 Cluster: A type 2 cluster’s primary function is to initiate transactions from the server to the client. 1718 Zigbee Coordinator: An IEEE 802.15.4-2003 PAN coordinator. 1719 Zigbee End Device: an IEEE 802.15.4-2003 RFD or FFD participating in a Zigbee network, which is neither the 1720 Zigbee coordinator nor a Zigbee router. 1721
- 47. Zigbee Cluster Library Specification Chapter 1 Zigbee Alliance Document – 075123 Introduction Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 1-5 Zigbee Router: an IEEE 802.15.4-2003 FFD participating in a Zigbee network, which is not the Zigbee coordinator 1722 but may act as an IEEE 802.15.4-2003 coordinator within its personal operating space, that is capable of routing 1723 messages between devices and supporting associations. 1724 1.4 Conformance Levels 1725 Expected: A key word used to describe the behavior of the hardware or software in the design models assumed by 1726 this Draft. Other hardware and software design models may also be implemented. 1727 May: A key word that indicates flexibility of choice with no implied preference. 1728 Shall: A key word indicating a mandatory requirement. Designers are required to implement all such mandatory 1729 requirements. 1730 Should: A key word indicating flexibility of choice with a strongly preferred alternative. Equivalent to the phrase is 1731 recommended. 1732 1.5 References 1733 The following standards and specifications contain provisions, which through reference in this document constitute 1734 provisions of this specification. All the standards and specifications listed are normative references. At the time of 1735 publication, the editions indicated were valid. All standards and specifications are subject to revision, and parties to 1736 agreements based on this specification are encouraged to investigate the possibility of applying the most recent 1737 editions of the standards and specifications indicated below. 1738 1.5.1 Zigbee Alliance Documents 1739 [Z1] Zigbee 053474, Zigbee Specification 1740 [Z2] Zigbee 064321, Zigbee Stack Profile 1741 [Z3] Zigbee 074855, Zigbee PRO Stack Profile 1742 [Z4] Zigbee 08006, Zigbee-2007 Layer PICs and Stack Profiles 1743 [Z5] Zigbee 130589, Application Architecture 1744 [Z6] Zigbee 130402, Base Device Behavior Specification 1745 [Z7] Zigbee 053298, Profile Identifier Database 1746 [Z8] Zigbee 106050, Zigbee Device internetworking, list of Device IDs 1747 [Z9] Zigbee 075356, Smart Energy Profile Specification 1748 [Z10] Zigbee 03084, Zigbee Key Establishment Proposal 1749 [Z11] Zigbee 095343, Installation Code Sample Source Code 1750 [Z12] Zigbee 053874, Manufacturer Code Database 1751 [Z13] Zigbee 115456, Master Cluster List 1752 [Z14] Zigbee 1602867, Zigbee 3.0 Cluster List 1753 1.5.2 International Standards Documents 1754 [I1] CIE 1931 Color Space. Commission Internationale de l'Eclairage Proceedings. Cambridge University 1755 Press, Cambridge 1756 [I2] ISO 7816 International Standard for Electronic Identification Cards with Contacts (Smart Cards) 1757
- 48. Chapter 1 Zigbee Cluster Library Specification Introduction Zigbee Alliance Document – 075123 Page 1-6 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. 1.5.3 National Standards Documents 1758 [N1] EN 50131 European Standards Series for Intruder Alarm Systems 1759 [N2] BSI British Standards, document BS EN 50523-2:2009, “Household Appliances interworking – Part 2: 1760 Data Structures”. July 2009 1761 [N3] NIST Special Publication 800-38C, Recommendation for Block Cipher Modes of Operation: CCM Mode 1762 for Authentication and Confidentiality, May 2004 1763 [N4] FIPS Pub 197, Advanced Encryption Standard (AES), Processing Standards Publication 197, US 1764 Department of Commerce/NIST Springfield, Virginia, November 26, 2001 1765 [N5] FIPS Pub 198, The Keyed-Hash Message Authentication Code (HMAC), Federal Information, Processing 1766 Standards Publication 198, US Department of Commerce/NIST Springfield, Virginia, March 6, 2002 1767 1.5.4 IEEE Documents 1768 [E1] IEEE Standards 802, Part 15.4: Wireless Medium Access Control (MAC) and Physical Layer (PHY) 1769 specifications for Low Rate Wireless Personal Area Networks (LR-WPANs), IEEE, October 2003. 1770 [E2] IEEE 754-1985, IEEE Standard for Binary Floating-Point Arithmetic, IEEE, 1985. 1771 1.5.5 ASHRAE Documents 1772 [A1] ASHRAE 135-2004 standard, Data Communication Protocol for Building Automation and Control 1773 Networks 1774 1.5.6 Health Care Documents 1775 [H1] ISO/IEEE 11073-20601: Health Informatics - Personal Health Device Communication - Application Profile 1776 - Optimized Exchange Protocol - version 1.0 or later. 1777 [H2] ISO/IEEE P11073-10404, Health informatics – Personal health device communication – Device 1778 specialization – Pulse oximeter. 1779 [H3] ISO/IEEE P11073-10407, Health informatics – Personal health device communication – Device 1780 specialization – Blood pressure monitor. 1781 [H4] ISO/IEEE P11073-10408, Health informatics – Personal health device communication – Device 1782 specialization – Thermometer. 1783 [H5] ISO/IEEE P11073-10415, Health informatics – Personal health device communication – Device 1784 specialization – Weighing scale. 1785 [H6] ISO/IEEE P11073-10417, Health informatics – Personal health device communication – Device 1786 specialization – Glucose meter. 1787 [H7] ISO/IEEE P11073-10419, Health informatics – Personal health device communication – Device 1788 specialization – Insulin Pump 1789 [H8] ISO/IEEE P11073-10421, Health informatics – Personal health device communication – Device 1790 specialization – Peak Expiratory Flow Monitor 1791 [H9] ISO/IEEE P11073-10441, Health informatics – Personal health device communication – Device 1792 specialization – Cardiovascular Fitness and Activity Monitor. 1793 [H10] ISO/IEEE P11073-10442, Health informatics – Personal health device communication – Device 1794 specialization – Strength Fitness Equipment. 1795 [H11] ISO/IEEE P11073-10471, Health informatics – Personal health device communication – Device 1796 specialization – Independent living activity hub. 1797
- 49. Zigbee Cluster Library Specification Chapter 1 Zigbee Alliance Document – 075123 Introduction Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 1-7 [H12] ISO/IEEE P11073-10472, Health informatics – Personal health device communication – Device 1798 specialization – Medication Monitor. 1799 1.5.7 Other Documents 1800 [O1] Standards for Efficient Cryptography: SEC 1 (working draft) ver 1.7: Elliptic Curve Cryptography, 1801 Certicom Research, www.secg.org, November 13, 2006 1802 [O2] Standards for Efficient Cryptography: SEC 4 (draft) ver 1.0: Elliptic Curve Cryptography, Certicom 1803 Research, www.secg.org, January 24, 2013 1804 [O3] RFC 3280: Internet X.509 Public Key Infrastructure: Certificate and Certificate Revocation List (CRL) 1805 Profile, IETF, www.ietf.org, April 2002 1806 1.6 Conventions 1807 The following conventions are used in this document. 1808 1.6.1 Enumerations and Reserved Values 1809 Each undefined value or range of an enumeration, field, or identifier SHALL be considered reserved for future 1810 revisions of this standard and SHALL not be available for implementation. 1811 Each value or range of an enumeration, field, or identifier that is available for non-standard implementation SHALL 1812 be described as “manufacturer specific”, “vendor specific”, “ms”, or “MS”. 1813 Each value or range of an enumeration, field, or identifier that is available for other parts of this standard SHALL be 1814 described as such. 1815 Each value or range of an enumeration, field, or identifier that is obsolete, and not available for implementation, 1816 SHALL be described as “Obsolete”. 1817 1.6.2 Reserved Bit Fields 1818 Each full or partial data field (e.g., message data field), of any bit length, that is undefined, SHALL be considered 1819 reserved for future revisions of this standard and SHALL not be available for implementation. 1820 Please see Section Chapter 2, Transmission and Reception, regarding rules for setting and interpreting reserved fields. 1821 1.6.3 Number Format 1822 In this specification, hexadecimal numbers are prefixed with the designation “0x” and binary numbers are prefixed 1823 with the designation “0b”. All other numbers are assumed to be decimal unless indicated otherwise within the 1824 associated text. 1825 Binary numbers are specified as successive groups of 4 bits, separated by a space (“ “) character from the most 1826 significant bit (next to the 0b prefix and left most on the page) to the least significant bit (rightmost on the page), e.g. 1827 the binary number 0b0000 1111 represents the decimal number 15. Where individual bits are indicated (e.g. bit 3) the 1828 bit numbers are relative to the least significant bit which is bit 0. 1829 When a bit is specified as having a value of either 0 or 1 it is specified with an “x”, e.g. “0b0000 0xxx” indicates that 1830 the lower 3 bits can take any value but the upper 5 bits must each be set to 0. 1831
- 50. Chapter 1 Zigbee Cluster Library Specification Introduction Zigbee Alliance Document – 075123 Page 1-8 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. 1.7 Testing, Validation and Certification 1832 The text of this document has been balloted and approved according to the procedures existing at the time of each 1833 release. However, not all cluster specifications have undergone a complete and successful specification validation 1834 event (SVE), which requires the testing of multiple diverse implementations to verify a common interpretation of the 1835 text. 1836 New features may be added to new releases of this document, but only if the specification text has passed an SVE. 1837 Old releases did not follow this rule, hence the statement above. Even a successful SVE for a cluster specification may 1838 not test or validate all cluster specification text. 1839 This is a living document. Erroneous or ambiguous text is discovered regularly, reviewed, approved and added as 1840 errata to this document. Testing and validation of errata may lag the release of errata text. 1841 Not all clusters in this specification are certifiable under a current certification program. A certification program 1842 defines a testing process that may require reference implementations, test fixtures, and/or test scripts. A certification 1843 program may also be frozen or inactive. A frozen certification program does not support new errata or new features. 1844 If there is no active certification program or the testing process requirements are not in place to test a cluster 1845 specification, then the cluster specification is not able to be certified. 1846 As of the writing of this section, the active and unfrozen certification programs for this specification are for Zigbee 1847 3.0 and Smart Energy. Please see documents [Z13] and [Z14] which track the status of criteria for cluster specification 1848 certification 1849
- 51. Zigbee Cluster Library Specification Chapter 2 Zigbee Alliance Document – 075123 Foundation Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 2-1 CHAPTER 2 FOUNDATION 1850 The Zigbee Cluster Library is made of individual chapters such as this one. See Document Control in the Zigbee 1851 Cluster Library for a list of all chapters and documents. References between chapters are made using a X.Y notation 1852 where X is the chapter and Y is the sub-section within that chapter. References to external documents are contained in 1853 Chapter 1 and are made using [Rn] notation. 1854 2.1 Scope and Purpose 1855 This chapter provides an entry point into the documentation for the Zigbee Cluster Library (ZCL), and specifies the 1856 elements that are general across the entire library. 1857 The ZCL frame structure is specified along with ZCL wide commands used to manipulate attributes from all the 1858 clusters defined throughout the ZCL. In addition, a set of data types is defined that can be used to represent attributes 1859 and a common set of status values returned by commands throughout the ZCL. 1860 An overview is included which lists all the domains specified in the ZCL and the clusters contained therein. 1861 2.2 Cluster Library Overview 1862 The Zigbee Cluster Library (ZCL) is intended to act as a repository for cluster functionality and it is a working library 1863 with regular updates as new functionality is added. A developer constructing a new application SHOULD use the ZCL 1864 to find relevant cluster functionality that can be incorporated into the new application so as not to “re-invent the 1865 wheel”. This also allows applications to be developed with more of an object-oriented style approach. 1866 2.2.1 Architecture and Data Model 1867 Each cluster specification in this document defines an independent functional entity. Each cluster specification is 1868 agnostic regarding functions beyond its purpose and scope, including overall requirements of the application or device. 1869 An application cluster SHOULD have no dependencies outside its application domain. A utility cluster MAY provide 1870 an interface to other layers (e.g. Groups cluster for group addressing). 1871 Please see [Z5] Application Architecture for more details. 1872 2.2.1.1 Cluster Identifier 1873 A cluster identifier SHALL map to a single cluster specification. A cluster identifier also defines the purpose of a 1874 cluster instance. More than one cluster identifier, each with a unique purpose, MAY map to a single more abstract 1875 cluster specification. For example: A Concentration Measurement cluster specification MAY be quite abstract, but 1876 have many mapped cluster identifiers each with a more concrete purpose, such as CO2 measurement in air, by volume. 1877 Please see [Z5] Application Architecture for more details. 1878 2.2.1.2 Extensibility Model 1879 A cluster specification MAY be derived from a base cluster specification. A derived cluster specification SHALL add 1880 specific requirements (attributes, commands, behavior, dependencies, etc) to the base specification. A derived 1881 specification MAY reduce optionality by limiting the optional requirements from the base specification. 1882 All new attribute and command definitions for the derived cluster SHALL be specified in the base cluster specification 1883 as optional, to maintain, in one specification, the identifier name space and communication behavior. Other behavior 1884 and dependencies that are specific to the derived cluster MAY also be specified in the base cluster, if it is deemed 1885 reusable by future derived clusters. 1886
- 52. Chapter 2 Zigbee Cluster Library Specification Foundation Zigbee Alliance Document – 075123 Page 2-2 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. A derived cluster specification SHALL have the same mandatory requirements as the base cluster specification. A 1887 derived specification MAY have mandatory requirements that are optional in the base specification. 1888 A derived cluster specification defines its own revision (ClusterRevision attribute) that is independent of the base 1889 specification. 1890 Conversely, a base cluster may be defined from an original more specific cluster, which then becomes a derived 1891 cluster. 1892 When considering the addition of one or more clusters to this specification, one SHALL explore the possibility of 1893 either deriving a cluster from an existing cluster, or creating a base cluster to map or derive new and existing cluster 1894 identifiers. This allows the reuse of approved and validated specifications and test plans. 1895 Please see [Z5] Application Architecture for more details. 1896 2.2.1.3 Instance Model 1897 If a device endpoint supports both a derived server cluster identifier and its base server cluster identifier, then both 1898 SHALL represent a single instance and operate as a single entity. This makes it possible to deploy a new device 1899 endpoint with both a base and derived cluster identifiers, which SHALL remain backward compatible to legacy 1900 devices that support only the original cluster identifier. 1901 Cluster identifiers that are mapped to a single base cluster specification, but are defined for distinctly different 1902 purposes, MAY exist together on a device endpoint. If there is no base cluster identifier defined, or no base cluster 1903 identifier exists on the same endpoint, then each cluster identifier SHALL represent a separate instance. 1904 Please see [Z5] Application Architecture for more details. 1905 2.2.1.4 Conformance Model 1906 Specified behavior SHALL be Mandatory (M), Optional (O), or Deprecated (D). Mandatory behavior is usually 1907 dependent on other factors. For example: The mandatory behavior defined in a cluster server specification, is only 1908 mandatory, if the cluster id is discoverable as a server on the device. Attributes and commands MAY also be dependent 1909 on the support of other optional attributes. This is true when a feature of a cluster requires a complete set of attributes 1910 and commands. 1911 Deprecated attributes and commands SHALL be noted as deprecated and description text SHALL be deleted. 1912 2.2.2 Client/Server Model 1913 Throughout the ZCL, a client/server model is employed. This model is illustrated in Figure 2-1. 1914
- 53. Zigbee Cluster Library Specification Chapter 2 Zigbee Alliance Document – 075123 Foundation Copyright 2007-2018, The Zigbee Alliance. All rights reserved. Page 2-3 Figure 2-1. The ZCL Client Server Model 1915 1916 A cluster is a related collection of commands and attributes, which together define an interface to specific 1917 functionality. Typically, the entity that stores the attributes of a cluster is referred to as the server of that cluster and 1918 an entity that affects or manipulates those attributes is referred to as the client of that cluster. However, if required, 1919 attributes MAY also be present on the client of a cluster. 1920 Commands that allow devices to manipulate attributes, e.g., in this document the read attribute (see 2.5.1) or write 1921 attribute (see 2.5.3) commands, are (typically) sent from a client device and received by the server device. Any 1922 response to those commands, e.g., in this document the read attribute response (see 2.5.2) or the write attribute 1923 response (see 2.5.5 commands), are sent from the server device and received by the client device. 1924 Conversely, the command that facilitates dynamic attribute reporting, i.e., the report attribute command (see 2.5.11) 1925 is (typically) sent from the server device (as typically this is where the attribute data itself is stored) and sent to the 1926 client device that has been bound to the server device. 1927 A type 1 cluster’s primary function is to initiate transactions from the client to the server. For example: An On/Off 1928 client sends commands (data) to the On/Off server. A type 2 cluster’s primary function is to initiate transactions from 1929 the server to the client. For example: A Temperature Measurement server reports to the Temperature Measurement 1930 client. Please see [Z5] Application Architecture for more details. 1931 The clusters supported by an application are identified through the simple descriptor (see [Z1]), specified on each 1932 active endpoint of a device. In the simple descriptor, the application input cluster list SHALL contain the list of server 1933 clusters supported on the device and the application output cluster list SHALL contain the list of client clusters 1934 supported on the device. 1935 2.3 Functional Description 1936 Global requirements for all clusters and commands are described here. 1937 2.3.1 Transmission 1938 ZCL frames are transmitted via the APS sub-layer by issuing the APSDE-DATA.request primitive. 1939 All sub-fields of ZCL frames, including individual bits, that are unspecified, or specified as reserved, SHALL be set 1940 to zero for transmission. This applies to all ZCL frames, including cluster-specific frames. Similarly, all reserved or 1941 unspecified bits of attributes of data type class Bitmap SHALL be set to zero for transmission. 1942 2.3.2 Reception 1943 ZCL frames are received via the APS sub-layer by the reception of the APSDE-DATA.indication primitive. 1944
- 54. Chapter 2 Zigbee Cluster Library Specification Foundation Zigbee Alliance Document – 075123 Page 2-4 Copyright 2007-2018, The Zigbee Alliance. All rights reserved. On receipt of a command (including both general and cluster-specific commands) the device SHALL attempt to parse 1945 and execute the command. During the parsing process for a non-manufacturer-specific command, it SHALL ignore 1946 all reserved sub-fields of the ZCL frame, including individual reserved bits. 1947 Note that, if any of these sub-fields are not set to zero, this MAY indicate that the format or interpretation of the frame 1948 has been updated. However, it is the responsibility of the specifier of such an updated format that it be backward 1949 compatible, i.e., any new format will result in the same functionality as before when parsed by a device that supports 1950 the previous version of the cluster. Any additional octets found appended to the frame SHALL also be ignored, as 1951 these MAY be added as part of such an updated frame format. 1952 If the command is manufacturer-specific, handling of reserved sub-fields is determined by the manufacturer. 1953 If required, the device SHALL then generate a response to the command. Responses are detailed in the specification 1954 of each command. If there is no response specified for a particular set of circumstances, (e.g., if the command has 1955 been rejected or is not recognized, or the command has succeeded but there is no response specified to indicate 1956 success), the Default Response command SHALL be generated, taking into account the conditions in 2.5.12.2. The 1957 status code returned by the Default Response command SHALL be one of the status enumerations listed in Table 1958 2-11. 1959 2.3.2.1 Broadcast Endpoint 1960 The device processing a message sent to the broadcast endpoint (0xff) SHALL: 1961 1. only deliver a copy of the message to the endpoints supporting the cluster indicated in the APS Header. 1962 2. follow the Default Response command behavior described in section 2.5.12.2 (no response for non-unicast 1963 messages). 1964 3. not generate error response messages, except when required by the Default Response command behavior. 1965 2.3.2.2 Broadcast Endpoint Recommendations 1966 Broadcast Endpoint Behavior Recommendations for Avoiding Network Congestion: 1967 1968 1. A device SHOULD NOT send a broadcast message to the broadcast endpoint where a response is expected from 1969 every active endpoint. It is recommended to use discovery to determine the specific endpoint(s) per device and then 1970 send individual messages that target those specific endpoints. 1971 2. A device processing a message sent to the broadcast endpoint SHOULD jitter messages that are sent in response, 1972 especially when the nature of the message is such that it generates many responses (i.e. synchronization message). 1973 1974 NOTE: Multicast group messages do not include an endpoint 1975 2.3.3 Manufacturer Specific Extensions 1976 Manufacturers are free to extend the standard in the following ways: 1977 • Add manufacturer specific clusters to a standard device endpoint. 1978 • Add manufacturer specific commands to a standard cluster. 1979 • Add manufacturer specific attributes to a standard cluster. 1980 All communications regarding manufacturer specific extensions SHALL be transmitted with the manufacturer specific 1981 sub-field of the frame control field set to 1 and the manufacturer code included in the frame. 1982 If the manufacturer code in a command frame is not recognized, the command is not carried out. 1983
- 55. Random documents with unrelated content Scribd suggests to you:
- 56. — Mitäpä iloa täällä lieneekään, — hän arveli vihdoin, otti tyhjän vakan kainaloonsa ja läksi astumaan pihaan päin. Aurinko oli jo kohonnut suurten vaarain takaa ja paistoi lämpimän herttaisesti suvannon välkkyvään veteen ja heinävien saarten seljille. Sieltä siinsi kahden leveimmän vuopion välistä Hopeasaarikin, sileä hyväheinäinen niitty… Mutta ylempää hän näki jo ensimmäisten tukkilauttojen olevan tulossa joen kiivasta virtaa pitkin… Kuului lauttamiesten huutoja ja kirouksia, kun leveä ja raskas lautta ei oikein ottanut totellakseen kiivaissa korvavirroissa. Ajatuksissaan Perttu asteli pihaan ja kävi suoraan omaan huoneeseensa, joka oli tuvan mäkipäässä. Siinä olivat hänen aarteensa ja omaisuutensa. Pienellä kirjahyllyllä oli kirjoja ja vanhan kaapin päällä sanomalehtiä, joita hän tilasi useita. Niitä yksin ollessaan ja joutohetkinä luki ja tutki, kirjoittipa joskus itsekin jonkun uutisen omaan lehteensä. Seinällä riippuivat hänen uudet vaatteensa, jotka vain sunnuntaisin raski päälleen pukea, ja uusi hattu, jonka Hanna oli lahjoittanut… Hän tunsi raukaisevaa väsymystä jäsenissään, niin uuvuttavaa, ettei tahtonut jaksaa riisua kenkiä jalastaan… Ja kun hän laskeutui vuoteelleen, lensivät ajatukset entisyyteen ja palasivat samalla nykyhetkeen, joka hänestä nyt tuntui raskaammalta kuin koskaan ennen. Hän teki suunnitelmiaan ja päätöksiään, että niin ja niin hänen nyt täytyy tehdä… niin ja niin toimittaa… Hänen täytyy ruveta ankarammaksi, täytyy ottaa isäntävalta pois muilta… niinkuin Jokijalka oli neuvonut…
- 57. Sellaisia päätöksiä hän oli ennenkin tehnyt, aikonut ja aikonut, mutta kun tuli tosi eteen, ei hän voinut panna vastaan kenellekään… Ja siihen hän nukkui raskaasti, tiedottomasti niinkuin nukkuisi monen pitkän vuoden kuluttua. Kun hän herättyään meni pirttiin, näki hän äidin liikkeellä, vaikka heikkona vielä. Isä istui sänkynsä laidalla ja veteli verkkaan kämmenellään pitkää, harmajaa partaansa. Penkillä istui kaksi miestä, tukkilaisia. Junnon-Iikka, kotikylän mies, ja toinen nuori, etelän puolen mies. Perttu tervehti Iikkaa, joka oli tuttava. "Tekö sitä yöllä lautalla tulitte?" tiedusti Perttu. "Me. Mutta otimme maihin tässä Viraniemen rannassa, kun näytti rupeavan tuulemaan eikä suvannolle ole panemista", alkoi Iikka selittää. Äidin silmät olivat itkettyneet, ja ennenkuin Iikka kerkesi jatkaa, sanoi äiti: "Ikäviä terveisiä sillä on Iikalla meillekin. Kuuluu hukkuneen Kustaavan mies…" Perttu ei puhunut mitään, mutta kenkä, jota hän oli jalkaansa vetämässä, jäi lattialle. Salamana lensi hänen ajatustensa läpi: Kustaava ja lapset joutuvat sinun elätettäviksesi… "Niinhän se kävi", alkoi Junnon-Iikka selittää. "Siinä kun tukit olivat tulossa Sipulikosken niskaan ja päällempänä Peurasuvannolla oli
- 58. suma, niin siihen suman rakoon oli pudonnut… eikä löydetty vielä ruumista… Eikö kulkene valtaväylää, jos eivät tukit survo palasiksi…" "Helvettiin meni sekin mies", lausui vanha Israel tuomionsa, ankara katse silmissään. "Kukapa sen niin varmaan tietää", arveli nuori etelän puolen mies, Junnon-Iikan kumppani. Onneksi ei vanha saarnamies sitä kuullut. Höpistyään hetken itsekseen hän kallistui vuoteelleen, ummisti silmänsä ja näytti nukkuvan. "Jäi viisi pientä lasta eikä minkäänlaista elämistä", sanoi emäntä hetken kuluttua, mutta sitten hän ratkesi valtavaan valitukseen: "Herra, Herra, miksi minua näin kovasti koettelet!" Eikä tyyntynyt sittenkään, vaikka Perttu kantoi hänet vuoteeseen ja koetti parhaansa mukaan lohduttaa. * * * * * Viinamäen pellon karhittuaan Perttu palasi pihasalle ja alkoi korjailla kyntöneuvoja kesäsijoilleen. Kevätkylvöt olivat nyt tehdyt, ja vähän keveämmin mielin Perttu valmisti apetta Laukilleen. Lauttamiehet, jotka aamulla olivat tulleet taloon, olivat menneet tuulta makaamaan karjalatoon. Herättyään he alkoivat tahtoa Perttua avuksi saattamaan lauttaa koskenniskaan. Eivät sanoneet uskaltavansa kahden lähteä suvannolle, kun tuulenhenki oli idässä. Semmoisia saattomatkoja oli Perttukin silloin tällöin tehnyt, vaikka hän ei muuten ollut koskaan vasiten ollut tukkihommissa. Mutta kun
- 59. oli sopiva vesi eikä tuuli haitannut, oli lauttojen saattaminen koskenniskaan hauska matka, ja hyvä palkka siitä maksettiin. Perttu vähin kielteli, kun Junnon-Iikka pyysi. Olisi ollut niin kovin monenlaista talon työtä, ja Karhunsuolla odottivat ojamullat hajoittajaa. "Lähde pois vain… On nyt kesää vielä maatöitä tehdä, ja me maksamme hyvän palkan… Näillä tukeilla on kiire meren suulle", kehoitti Junnon-Iikka uudelleen. Perttu mietti hetkisen. Samalla matkalla hänen sopisi käydä Lommankin puheilla ja palatessa poiketa Hannaa puhuttelemassa… Hän lupasi lähteä, pistäysi huoneeseensa ja veti uudet pitkävartiset tukkisaappaat jalkaansa. "Nyt lähdemme", sanoi hän sitten pihalle tultuaan. Hänen liikkeissään ja koko olennossaan ilmeni jotakin reippaampaa, ja äskeinen alakuloinen katsekin oli kirkastunut ja ikäänkuin avartunut. "Sinusta se tukkimies olisi tullut", sanoi Junnon-Iikka ihastuksissaan. Perttu olikin nyt, pitkävarsisaappaissa ja mustassa hatussa, joka oli hieman kallellaan, niinkuin tukkilaisilla on, aivan erinäköinen kuin äsken pellollaan. Miehet kävelivät rantaan, jossa suuri tukkilautta oli vankalla trossilla kiinnitetty maahan lyötyyn paaluun. "Onko näkynyt lauttoja alas meneviksi?" kysyi Junnon-Iikka, kun alkoivat päästellä lauttaa irti.
- 60. "On niitä joku näkynyt menneen", vastasi Perttu. Kun lautta oli irtautunut maista ja he kukin asettuneet airoihinsa, alkoivat he soutaa suvannon selälle, josta laimea virta hiljalleen kuljetti raskasta lauttaa virtavampia vesiä kohden. "Tänä kevännä oli puute miehistä tukinlaskussa", puheli Junnon- Iikka lautan etupäästä Pertulle. "Siellä olisit sinäkin napannut sievät rahat… Mutta sinähän et pidä tukkilaisen elämästä… Kumma ettet sinä, ja toiset veljesi vain… Kemijokivarteen kai ovat menneet…?" "Sinne ovat kai menneet." Hetken vaiti oltuaan sanoi Junnon-Iikka niinkuin kauan mietittyä asiaa: "Kumma se on, että tyydyt maatyötä tekemään, vaikkei ole palkasta mitään tietoa…" Se nyt oli taas viittaus siihen, että talo oli niin velassa, että kun velkamiehet omansa ottivat, ei Pertulle jäisi mitään. Koko maailma sen muuten tiesikin. Jotakin Junnon-Iikalle vastatakseen Perttu sanoi: "Siinäpä tuota on elänyt, ja tuskinpa niillä kaikilla tukkilaisilla on paljoa enempää säästössä kuin minullakaan…" Ei väittänyt Junnon-Iikka sitä vastaan, mutta arveli kuitenkin: "Semmoinen mies kuin sinä, joka olet juomaton ja muutenkin hoksaava, sinä siellä panisit kesän pitkään rahaa säästöön kuin puita pinoon…"
- 61. "Niin vain tekisikin", arveli etelänpuolen mieskin. "Taitaisivat tulla minullekin suuremmat menot sitten", naurahti Perttu miesten puheisiin. Lautta soljui hitaasti eteenpäin. Tuuli oli iltapuoleen päivää kokonaan tyyntynyt, niin että suvannolla oli nyt helppo ohjailla raskasta lauttaa. Ei ollut muuta miehillä tekemistä kuin katsella vain. Etelänpuolen mies siirtyikin lautan kupeelle, jossa heillä oli tulisija ja kahvinkeittovehkeet. "Keitäpä oikein jätkän kahvia", varoitteli häntä Junnon-Iikka. "No niinkuin tervaa", vakuutti toinen ja pilkkoi honkapalasesta lastuja kahvin keittämistä varten. Junno ja Perttu ohjailivat sillä välin lauttaa, joka jo oli kulkenut suvannon selälle ja oli nyt parhaalla väylän kurkulla. Junno ohjaili etupäätä, Perttu jälkipäätä. Junno hyräili tukkilaisen lauluja, mutta Pertun ajatukset eivät hänen laulujaan seuranneet. Mutta keveämmältä, vapaammalta ja hauskemmalta tuntui Pertustakin elämä täällä vesillä. Maailma huolineen oli tuolla etempänä, täällä ei niistä mitään tiennyt… täällä valtaväylän kirkkaan veden päällä… joka virtaili meren suulle ja sieltä avaraan maailmaan. Oli kuin keveämpää hengitys, ja niinkuin raskas elämä olisi haihtunut. Tänne kuului selvään rannalla olijoiden puhelu, ja korva otti pienenkin äänen, joka lähti maalta päin… "Hauskat ja helpot ne ovat välistä sentään tukkipojan päivät", arveli laulunsa lomasta Iikka.
- 62. Korkealla rantatörmällä olevat talot paistoivat joelle, ilta-auringon niitä kullatessa, kuin kiillotetut majat vaaran kupeelta. Pertun silmät kääntyivät kotia päin, joka niemen nenässä kyyrötti vanhoine maalaamattomine rakennuksineen. Se olikin ainoa kylän talo, jota ei ollut punattu, sillä isä oli pitänyt sitä maallisena ja synnillisenä koreutena. Mutta kaikkein kauneimmalla paikalla se sittenkin oli, ja joelle asti rehoittivat Pertun puutarhan puut, joissa lehti jo vihotti… Kauempaa talon takaa näkyivät pellot ja jo vihannoivia ketoja, joihin Perttu vuosi sitten oli timoteitä kylvänyt… Viinamäenkin eroitti mustine multineen ja sen takaa korkean tuoreoksaisen kuusikon, hänen säästömetsänsä… Kylän alapäässä mäen harjalla näkyi pienoinen punainen talo pitkän petäjikön laidasta. Se oli kaikkein etäimmällä joen rannasta ja kaikkein korkeimmalla vaaran kupeella. Mutta pellot olivat sieviä mäen laitaan tehtyjä neliöitä ja vankkojen kiviraunioiden ympäröimiä. Talo näytti muutenkin siistiltä ja somalta valkoisine nurkkalautoineen ja ikkunanpielineen… Nyt varsinkin, kun lännen ilta-aurinko kultaili sitä tuonne miellyttävään mäenrintaan… Se oli Hannan koti. Pertun sydän sykki kuumasti. Mitähän Hannalla siellä oli tekeillä? Muistiko häntä? Odottiko niinkuin oli luvannut? Muisti kyllä ja odotti. Niin oli vakuuttanut, kun viime kerran kohtasivat, hangen aikana, kun Perttu metsästä tullen oli käynyt Hannaa tervehtimässä. Varhainen, kirkas kevätaamu oli silloin… Ei ollut sittemmin Hannaa kohdannut… Kun ei mitään hauskaa ollut kerrottavana, niin ei tahtonut liian usein puhellakaan.
- 63. Eikä ollut hänellä nytkään mitään ilosanomaa vietävänä… melkein päinvastoin… Mutta aina kun puhui Hannalle huolistaan ja päätteli yhtä ja toista heidän tulevaisuudestaan, osasi Hanna kääntää hänen huolensa parhain päin ja ennustaa hauskaa tulevaisuutta. Ja vaikka niin peräti vähän oli toivoa siitä, että Perttu pääsisi velattomaksi eläjäksi, uskoi Hanna kuitenkin… ja lupasi odottaa… eihän heillä niin kiirettä ollut… Lautta oli Pertun miettiessä solunut jo lähelle saaria, ja suvanto välkkyi takanapäin kuin suuri järvi. Ei ollut enää kaukana Hopeasaarikaan, Viraniemen ja koko kylän heinävin ja paras niitty. Rannoilla jo eroitti pitkää, polviin asti ulottuvaa luhtaa, vaikka kesä oli vasta alussa. Etelänpuolen mies, joka oli kahvinkeittohommissa, huusi: "Kahvi on valmista." Junnon-Iikka kehoitti Pertun ensiksi juomaan, jolla aikaa etelän mies kävi Pertun airoon, sillä yksin ei lauttaa nyt sopinut jättää kulkemaan, kun saaret lähestyivät ja oli osattava oikealle väylälle. "Siellä olisi minun laukussani hokmannia, jos tahtoisit panna kahvin sekaan", tarjosi Iikka. Ja kun lautta näytti olevan menossa oikealle väylälle, pisti Iikka aironsa rinkkoon ja kävi kahvin juontiin. "Mutta jo on siinä leveää selkää", sanoi hän ja löi Perttua hartioille kämmenellään. "On siinä voimaakin. Minä sinuna ostaisin ensi talveksi vankan hevosen ja lähtisin tukkimetsään. Nyt tulee paljon tukinajoja ensi talveksi… Kun menneenä talvena Airiselän ajossa
- 64. Savukylän Hermanni ansaitsi kolmatta tuhatta markkaa, vaikkei ollut ajoissa kuin joulusta Marianpäivään. Minä tiedän, minä olin Hermannilla hakkuumiehenä…" "Kolmatta tuhatta…?" kysyi Perttu kummissaan. "Puhtaita rahoja… Paksu pinkka oli kuin virsikirja seteleitä, kun kotiaan läksi. Mitä arvelet? Eikö kannata talvisydämen ajaksi lähteä tukinajoon?" Perttu ei vastannut. "Eikä siellä talvella niin jumalatonta elämää pidetä, jos sitä pelkäät… Kun laittaa oman kämpän ja tallin, niin saapi olla aivan rauhassa… Joskus, kun sattuu viinakauppias liikkeelle, niin vähin huutavat ja tappelevat. Mutta mitäpä sinun tarvitsee joukkoon sekaantua." Perttu katsoi Iikan ruskeihin, vilkkaisiin silmiin, että näkyisikö vilppiä silmänurkassa, mutta kun toinen näytti vakavalta, ymmärsi Perttu, että hän tarkoitti totta. Lautta oli heidän jutellessaan jo lipunut vuopioon, jonka toisella puolella oli Hopeasaari ja toisella Törmänki, hyvä maaheinäniitty sekin. "Siinä se sitten on Hopeasaari… maailman paras niitty…" Iikka tuntui sen sanovan Pertulle, ja hänestä näytti kuin Iikka olisi tahtonut siihen vielä jotakin lisätä. Hopeasaaren ranta oli syvä ja virtava, ja lautta kulki siinä nopeampaan. Saaren taakse jäi kotikylä, ja katosi näkyvistä tapulin
- 65. risti ja kirkon eteläinen pääty. Edessäpäin näkyi vain niittyjä, joita putaat ja vuopiot halkoivat. "Siinä se olisi talon turva tuossa Hopeasaaressa", arveli hetken kuluttua taas Iikka. "Olisi se… joka sen omaksensa kerran saisi", sanoi Perttu hiljaisella äänellä, ja näytti kuin hänen silmänsä eivät koskaan kyllääntyisi katsomaan Hopesaaren tummaa, nyt jo pitkää luhikkoa. "Siitä saapi Lomma liian rajun rahankoron", arveli Iikka taas, ja kun ei Perttu siihen vastannut, lisäsi hän: "Kumma mies se isäsi, kun antoi ruuan suustansa." "Pakosta kai se oli, kun ei muuten kyennyt maksamaan korkoa", sanoi Perttukin nyt. "Eikä taida se asia meidän puhelemalla parata." "No lauletaan sitte!" kiljaisi Iikka ja alkoi rallattaa, niin että kaiku kierteli kaukaisissa vaaroissa. Jo oli lautta saapumassa koskenniskaan. Etäältä näkyivät jo toisen kylän talot ja kuului kovien koskien pauhua. Sieltä näkyi korkealta törmältä kauppias Lommankin komea valkoinen talo yli muiden ja asuinrakennuksen suuret ikkunat, jotka välkkyivät iltapäivän paisteessa kuin kulta. Tarkkaa oli nyt lautan kuljetus, sillä virta eneni ja väylät olivat mutkaisempia. Jo näkyi koskenniskan lauttahamina suurine lauttoineen ja tukkilaisineen, joita vilisi maalla ruokakojujen ympärillä ja kulki edestakaisin lautoilta maihin ja taas takaisin. Kuului lauluja,
- 66. kirouksia ja huutoja, ja ihan jo silmän alla näkyivät ensimmäisen kosken vihaiset laineet ja kuului mahtavan kosken varoittava pauhu.
- 67. III. Erottuaan Iikasta ja etelänpuolen miehestä Perttu nousi maihin lauttahaminaan. Hän päätti joutua Lomman puheille heti, eikä aikonut käydä tukkilaisten ravintolassa ensinkään. Mutta kun hän ehti ensimmäisen "kämpän" luo, huusi sieltä joku avonaisesta ovesta: "Mies hoi, tule kortille!" Hän näki tutun miehen kasvot etempää ja kuuli tämän sanovan: "Ei se ala kortilla. Se on sen Viraniemen saarnamiehen poika…" Perttu käveli nopein askelin eikä ollut kuulevinaankaan kysymyksiä eikä pistosanoja, joita sateli jätkäjoukosta kuin rakeita. Mikä tahtoi vaihtaa kelloja, saappaita, lakkia, mikä vaati kortille ja mikä kiroili, että mikä tuo on, joka ei kenellekään vastaa… Pian Perttu ehti pois lauttahaminan kuuluvilta ja lähti astumaan Lommalle päin. Hänen mielessään olivat nyt kypsyneet uudet tuumat, ja hän päätti käydä kaikkien velkamiesten luona tiedustelemassa, jos hyvinkin uskoisivat velkansa hänelle, jotta hän saisi talon omiin nimiinsä. Niin oli naapurikin, Jokijalka, neuvonut.
- 68. Hän uskoi, että hän kykenisi vuosittain maksamaan korot ja pystyisi raivaamaan Karhusuon viljelykselle. Ja jos hän saisi Hopeasaaren itse tehdä… niin voisi karjaa lisätä ja saada myös siten tulot enenemään. Vilkkaissa ja hauskoissa tulevaisuuden tuumissa hän asteli reippaasti Lommalle. Lomma oli pitäjän rikkain kauppias ja toimelias maanviljelijä, joka oli köyhästä miehestä kohonnut varallisuuteen ja hyvinvointiin. Oli kyllä paljon huhuja liikkeellä, ettei hän ollut rehellisellä pelillä koonnut kaikkea omaisuuttaan. Tukkikaupoissa hän oli voittanut tuhansia. Lomma oli hyvä mies auttamaan vähävaraisia, antoi velkaa, mutta kiskoi takaisin, suuria korkoja perien. Toiset häntä kirosivat, toiset kiittivät. Mutta siitä olivat kaikki yksimielisiä, että sen nimi, joka kerran hänen kirjoihinsa joutui, ei niistä päässyt erilleen maksamallakaan. Aina sieltä löytyi joku pienoinen rästi, ellei muuta. Lomma sattuikin olemaan kotosalla ja hyvällä tuulella. Poltellen pahanhajuista sikaaria hän käski Pertun tulla konttoriinsa. Lomma oli jo ikämies. Hänen parrattomat, pulleat kasvonsa olivat savun väriset ja silmät vedenharmaat. Mutta ne kiiluivat kuin mitkäkin kissansilmät ja vilkuivat aina joka haaralle. "Vai olet sinä Viraniemen Israelin nuorin poika", puheli hän Pertulle sikaaria tarjotessaan. "En minä olisi tuntenut. Ei ole näkynyt sinua täällä kosken soudussakaan. No, miten siellä isä vanhus jaksaa? On kuulunut, että alkaa vanhuus voittaa…" "Eipä saata enää pitkäikäinen olla. Toisinaan jo tuntuu, että puheissaan höpisee", selitti Perttu.
- 69. "Olet sinä tullut enemmän isääsi kuin toiset velimiehet… Joko sinä olet nainut?" Perttu punastui ja arveli: "En ole nainut…" Lomma ei näyttänyt isosti kuulevankaan, mitä Perttu puhui, kysyi itse vain minkä kerkisi. Tiedusteli pelloista ja niityistä, karjasta ja minkä mistäkin. "Niityistä ei ole paljon puhetta, kun Hopeasaari on teillä", sanoi Perttu. "Joo. Olenhan siitä heinän tehnyt rahan korosta…" "Paljonko on näinä vuosina tullut heiniä?" kysyi Perttu. Hän näki selvään, ettei Lomma tahtonut siihen suoraan vastata. "Liekö niitä koskaan niin tarkoin arvioitu, mutta kai ne suunnilleen koroksi riittävät, enkä minäkään ole tahtonut olla kovin ankara isääsi kohtaan, vaikka kyllä kipeä tarve on välistä minuakin hätyyttänyt", selitti hän. Perttu kävi nyt suoraan asiaan ja kysyi, saisiko velka olla uloshakematta, jos se tulisi hänen nimeensä… Lomma heristeli korviaan. Mitä tämä mies oikein alkoikaan? "Miksei, kun minä saan koroista tehdä Hopeasaaren niityn", vastasi hän sitten, mutta hänen äänensä helähti kylmemmältä kuin äsken. "Sitä minä, että eikö kelpaisi raha koroksi", esitteli Perttu.
- 70. Mutta siitä ei Lomma näyttänyt pitävän. Hän nousi istumaan, kävi sytyttämään sikaariaan, vaikka se parhaillaan palaa roihusi, ja ärähti: "Niin… se on sovittu sillä lailla isäsi kanssa… siksi kunnes velka on maksettu… Mitäpä siitä…" Ja hetken oltuaan vaiti hän kysyi tikaisemalla: "Sinäkö se aikoisit ottaa kaikki velat päällesi?" "Olen ajatellut, että jos tyytyisivät velkamiehet siihen, että saisivat vuosittain korot, niin koettaisin", sanoi Perttu alakuloisena ja melkein rukoilevan äänellä. Mutta Lomma oli toista mieltä. "Älä, hyvä mies, ota niin suurta velkataakkaa hartioillesi! Et sinä jaksa korkojakaan maksaa! On annettu isäsi siinä nyt olla rauhassa vanhoillaan, vaan kyllä minä luulen, että velkojat alkavat omiaan tahtoa, niin…" Pertun herkkä mieli kävi katkeraksi. Ei näyttänyt täältä päin olevan mitään toivoa. Hän luki Lomman harmaista, kiiluvista silmistä sen, ettei tämä mies helpottaisi eikä lahjoittaisi penniäkään, vaikka olisi paikalla rahat pöytään lyödä. Perttu ei ollut koskaan nähnyt isän Lommalle antamaa velkakirjaa eikä tiennyt, oliko velkakirjaan erityisesti merkitty, että korko oli maksettava Hopeasaaren heinillä. Ja vaikka hänen mielensä oli käynyt apeaksi ja äskeiset valoisat tulevaisuudentuumat olivat rauenneet, kysyi hän: "Onko se sitten velkakirjaan merkitty, ettei raha kelpaa koron maksuksi, vaan ainoastaan Hopeasaaren heinät?"
- 71. Lomma kivahti: "Oli tai ei, vaan se on niin sovittu, ja saapi isäsi kiittää, etten ole ruvennut velkaa uloshakemaan." Mitähän tämä mies oikeastaan onkaan? Tiedustelee velkakirjasta kuin mikäkin isäntä! Eivätpä ole toiset veljet huolehtineet isänsä velkakirjoista! Lommalla pyöri jo huulilla monta kysymystä, mutta kun Perttu näytti aikovan lähteä, ei hän ehtinyt muuta kysyä kuin: "Osaatko sinä sitten lukea kirjoitusta?" "Osaan kyllä ja ymmärrän luetun sisällönkin", vastasi Perttu vähän kylmemmällä äänellä ja kääntyi mennäkseen. "Vai niin", sanoi Lomma ja kääntyi hänkin selin. Mutta Pertun mentyä hän höpisi itsekseen: "Oletpa vain mikä olet… mutta minulla on takanani sellaiset paperit, jotka pitävät." Jälestäpäin hän usein muisti Pertun silmiä ja niiden ilmettä, kookasta vartta ja leveitä kämmeniä. Alakuloisin mielin lähti Perttu maantietä pitkin kotia päin kävelemään. Vaikka oli jo myöhäinen ilta, melkein yö, valvoivat kaikki ihmiset vielä kylässä. Kesän alussa nukkuvat peräpohjalaiset hyvin vähän, ja koko yön näkee ihmisiä liikkeellä. Tuskin yhdessäkään talossa tapaa koko talonväkeä nukkumassa yhtaikaa.
- 72. Kylän läpi kulkiessaan Perttu käveli nopeaan, aivan kuin hänellä olisi ollut tavaton kiire, mutta ehdittyään taipaleelle, joka eroitti kylät toisistaan, hän hiljensi kävelyään ja vaipui mietteisiinsä. Yö oli kaunis ja tie hauska, kulkien korkean Visavaaran yli, jossa milloin nousi mäen harjalle, milloin laskeusi laaksoon. Koivut jo vihannoivat, ja etelän rinteillä näkyi joku melkein täydessä lehdessä. Eräässä laakson pohjassa Visavaaran alla Perttu tiesi olevan lähteen lähellä tietä. Hän poikkesi lähteelle, joka kirkkaana silmänä pulppusi suuren, tiirakylkisen kiven luomesta. Hän heitti takin päältään ja hatun päästään ja rupesi pesemään kasvojaan. Kotia palatessaan hän oli päättänyt poiketa Hannaa tervehtimässä ja muisti nyt, että hänellä kai oli pölyiset kasvot. Pestyään hän pyyhkäisi hiuksiaan vähäisen ja solmisi kaulaansa huivin, jonka Hanna oli viime talvena antanut. Reippaasti hän sitten lähti astumaan ja nousi pian Visavaaran korkeimmalle harjalle, jonka yli tie vei ja joka oli kahden kylän rajaharju. Harjun toiselta puolen leveni kotikylän suvanto ja suuret, vihannoivat saaret kuin tauluun maalattuina hänen eteensä. Kaitaiselta palstalta näyttivät viljellyt maat kotikylän vaaran kupeella mitättömältä viirulta, verrattuina siihen äärettömään näköalaan, jonka etäisiä taivaanrantoja yön lempeä hohde kirkasti. Oli maita ja metsiä, korpia ja lihavia soita! Olisi siinä leivälle sijaa kasvaa, olisi työtä tuhansille! Ja Pertusta näytti siltä kuin ikävöisi erämaa jo asukastaan, kuin kuiskisi korpi kuokkijaansa ja kova kiveliö raivaajaansa…!
- 73. Milloin ehtisi sinne kuokka, milloin aukaisisi aura soiden selkiä ja halkoisi karhi korven lihavaa mätästä! Olisi työtä, olisi elämää Pohjolassa… kun parhaiden poikien hiki ei valuisi vieraalle maalle… Aina tätä harjua kulkiessaan joutui Perttu samoihin mietteisiin, ja aina silloin tuntui hänestä Pohjola niin rakkaalta, ettei hän voinut käsittää, kuinka toiset voivat siirtyä täältä valtameren taakse ja siellä työtä tehdä… työtä tehdä ahtaassa, pimeässä kaivannossa, kun täällä oli valoisaa ja lämmintä ja lintujen laulua ja työtä… työtä tuhansille… Isänmaa ei ollut heille muuta kuin vilunarka syntymäpaikka, jossa kuoli nälkään tai paleltui ja eli köyhänä ja nälkäisenä… Niin oli. Oliko hän itse sitten muuta saanut tähän asti kuin työtä, vilua ja nälkää? Hän lähti kävelemään jyrkkää mäkeä alas, mutta vielä keksi silmä Hopeasaaren, jonka pohjoispäästä pohotti sankkaa pajukkoa, turvana kevätjäitä vastaan, ja heinälatoja pitkin saaren korkeinta kamaraa. Oliko hän sitten itse muuta tuntenut kuin nälkää, vilua ja puutetta? Oli, oli! Mitä hän oli oppinut talven pakkasaamuina, kun revontulten hulmutessa yksinäistä metsätietään kulki! Mitä oli miettinyt valoisina kevätöinä, kun kylvi peltoaan ja käet kukkuivat! Ja mitä tuntenut illan hämärässä, kun seisoi vastatäytetyn hyvänhajuisen heinäladon kynnyksellä! Ja hänen mielensä, joka äsken oli apea ja toivoton, kirkastui taas, ja hänen käyntinsäkin kävi reippaammaksi… Olipa kuin oli ja kävipä kuinka kävi, mutta tätä maata hän rakasti… tämä antoi leivän, välisti kyllä mustaa ja vähäisen, mutta elätti miehensä kuitenkin… Eikä tämä maa irvistellyt vastaan eikä näyttänyt oudon naamaa
- 74. milloinkaan! Aina hymysi taivas, talviaamuinakin! Aina naurussa suin oli kolkko korpi, ja aina ilomielin ja lintujen laulaessa kiveliö kulkijaansa kohteli! Entäpä kesäiset, kastekirkkaat aamut niityn laitaan mennessä, ja elokuun hämyillat, kun vilja kypsyneenä kuhilaillaan seisoi… Ja rivakasti, melkein kuin peläten, ettei häntä hänen hyvä mielensä jättäisi, hän käveli hauskaa tietä pitkin. Uusista tuumistaan, jotka tällä matkalla olivat hänen sydämessään syttyneet, hän tahtoi joutua Hannallekin puhumaan… Hänen elämässään täytyi tulla nyt joku muutos. Hän tunsi sen, niinkuin olisi joku siitä korvaan kuiskinut. Jo näkyi Hannan koti, Vaarala, mäen kukkulalla somana ja sievänä. Kohta oli hän tiehaarassa, josta tie kääntyi taloon. Hän nousi maantiestä lähtevää kaitaista talontietä; siitä näkyi nurmen välissä vain kaksi rattaan raitiota ja ura, jota hevonen asteli. Naapurissa vielä valvottiin, mutta Vaaralassa ei näkynyt liikettä. Joko olisi Hanna ehtinyt mennä levolle? Mutta ehtiessään kujalle hän näki isännän tulevan mäkikujasta suitset kädessä ja pienoinen laukku selässä. Perttu jäi odottamaan isännän tuloa. Hevostaan oli Vaaralan isäntä käynyt metsään viemässä. Hänkin oli jo ikämies, mutta teki yksin talossaan työt, sillä molemmat pojat kulkivat puulaakin töissä kesät ja talvet. "Vai jo ovat saaneet sinutkin lauttahommiin", arveli hän Pertulle, kun Perttu teki matkastaan selvää.
- 75. "Olen minä toisinaan lauttoja tuttujen miesten kanssa koskenniskaan saattanut." Vaaralan isäntä oli vanhan ajan kristittyjä. Hän oli totisesti herännyt, eikä hänen väkevä uskonsa ollut laimennut vuosien kuluessa. Yksi niitä samoja kuin Viraniemen Israelikin. "Ei meitä enää monta vanhempaa kristittyä olekaan tässä kylässä… isäsi, Korven Antti ja minä… Ehkäpä Herra kohta meidätkin korjaa." Isännän vakavilla kasvoilla kuvastui kuin kaiken maailman suru tai niinkuin ikävä, että pääsisi pois iankaikkiseen iloon, Herran luo… pois tästä pahasta maailmasta, synnin, lankeemusten ja saastan keskeltä. "Kyllä Herra meidät heti korjaa", vakuutti hän vielä. "Minä olen nähnyt isällesi kuoleman unen… Kuinka se on sinun uskosi, poika parka?" hän kysyi sitten äkkiä ja katsoi terävästi Perttua. Mutta silloin juuri Hanna juoksi navetasta päin ja käteltyään Perttua käski tämän sisälle. Hanna oli kaunis, vähän yli kahdenkymmenen ikäinen, verevä tyttö, mutta hänen silmissään oli surullinen ilme, joka harvoin hänen nauraessaankaan muuttui iloisemmaksi. Ja koko olemuksessa oli jotakin vakavaa, niin että hän näytti vanhemmalta kuin olikaan. Hiukset olivat vaalean kellertävät ja ohimoilta sievinä laineina. Pertun tulosta hän näytti erinomaisesti riemastuvan. Perttu näki sen hänen silmistään ja siitä innosta, jolla Hanna alkoi Pertulle toimittaa illallista taikka oikeammin aamiaista, sillä oli jo aamupuoli yötä.
- 76. Päivän noustessa ja lintujen alkaessa laulella Hanna ja Perttu istuivat Hannan kamarissa, avonaisen ikkunan luona, josta oli laaja ja avara näköala vuolaalle virralle, suurille, vihannoiville saarille ja vuorisiin maailmoihin länteen päin… Istuivat siinä, hiljaa keskenään puhellen, toinen toisessa päässä pöytää. Molemmin puolin oli paljon puhumista tulevaisuudentoiveista. Ja he haastelivat tulevasta yhteiselämästään niinkuin haastelevat nuoret, joiden elämä ei ole ollut päivänpaistetta eikä menestystä. Perttu kertoi uudesta tuumastaan, ja Hanna tuntui ihastuvan ja hyväksyvän. Hän lähtisi ensi talveksi tukinajoon, kun ansiot olivat niin tavattoman hyvät. Hän maksaisi ensi vuonna Lommalle rahassa koron, saadakseen itse tehdä Hopeasaaren ja myydä heinät. Muut velkamiehet eivät hätyyttelisi. Isän ja hänen välillään tehtäisiin kauppakirja ja hän ottaisi velat maksaakseen. Ja ensi keväänä, vuoden päästä, he viettäisivät häänsä. Sitä oli Pertun äitikin toivonut. "Kunhan saamme itse tehdä Hopeasaaren, voimme pitää kaksikymmentä lypsävää lehmää, ja kun meijeriin viemme maidon, niin jo alkaa velka lyhetä… Ja kun Karhusuo alkaa oikein heinää työntää, niin… Kunpa se aika kerran koittaisi…!" Perttu lämpeni tulevaisuudentuumissa ja toimiansa ajatellessaan niin ettei surun päivää muistanut ollenkaan. Hänen vakavat kasvonsa kirkastuivat, ja silmissä hehkui nuoruuden ja voiman tuli. Hän oli kaunis mies, kun hän oikein innostui, sillä silloin hän sai virkkua elämää joka soluunsa. Hänestä olikin sanottu, että hän oli Israeli- vanhuksen lapsista lahjakkain ja että hänen luonteensa oli enimmin isäänsä siinä, että hän innostuttuansa oli hyvä puhumaan. Semmoisena häntä Hannakin rakasti, mutta vielä enemmän hänen
- 77. lempeän ja hyvän sydämensä ja puhtaiden tapojensa vuoksi, joista kenelläkään ei ollut mitään pahaa puhumista. Hanna kuunteli Pertun puhetta nousevalla ihastuksella, ja hänen kauniit siniset silmänsä kuin sulivat Pertun katseisiin. Ja kun Perttu huomaamatta tarttui Hannaa olkapäästä niin lujasti, että Hanna kivusta äännähti, tuntui se Hannasta sittenkin niin hyvältä, ettei kertoa osannut. "Voi, jos sinä tietäisit kaikki", hän sanoi Pertulle ja istui nyt vastustelematta hänen polvelleen ja pyytämättä laski kätensä Pertun leveille hartioille. Ja Hanna kertoi, että hänellä kevään kuluessa oli käynyt kaksikin kosijaa, jotka kumpikin olivat saaneet mennä menojaan. Hanna näki, että Pertun suupielissä kerran värähti ja että silmissä leimahti. "Toisen sinä arvaat", jutteli Hanna silitellen Pertun vaaleita hiuksia, jotka olivat ohimoilta ja niskasta kiharaiset; "se oli Laurilan Mikko toisesta kylästä. Mutta toista et arvaa…" "En arvaa vähääkään", vastasi Perttu, vaikka tuntui aivan muuta ajattelevan. Laurilan Mikko oli talonomistaja, hyvävarainen vanhapoika ja jotenkin komea mies. "Mikä pani Mikon liikkeelle?" sanoi hän kummastellen, sillä ei ollut koskaan kuultu, että Mikko olisi ketään kosinut. Hanna kertoi Mikon käynnistä yhtä ja toista. Lopuksi oli Mikko nimitellyt Perttua hölmöksi… Mutta sitten, kun oli nähnyt, että Hanna suuttui, oli hän lähtenyt.
- 78. "Niinpä niin. Hölmö olenkin, mutta minun on hauska elää, kun olen tehnyt minkä olen tiennyt oikein olevan", sanoi Perttu vähän alakuloisena. Häntä ei mikään enempää loukannut kuin se, että häntä sanottiin hölmöksi. "Jos et olisi semmoinen kuin olet, en minä sinua rakastaisi niinkuin rakastan… niinkuin olen rakastanut jo monta vuotta… Muistatko mistä asti?" Ja Hanna painoi kätensä Pertun kaulaan ja veti hänen päänsä povelleen. "En minä oikein." Pertun ilo oli niin suuri, että hän melkein vapisi pitäessään Hannaa sylissään. Hanna kertoi: "Silloin minä ensi kerran sinuun ihastuin, kun kansakoululla oli arpajaiset… Se sinun puheesi… ja muutenkin…" "Ja minä olen sinua katsellut jo poikasena, silloin jo kun sinä pikkutyttönä paimensit lehmiä Lomporannalla…" "Silloinko jo?" Heidän keskustelunsa kääntyi lapsuudenmuistoihin ja niihin leikkitovereihin, jotka silloin olivat lapsia. Niistä ei ollut monta enää kotikylässä. Useimmat olivat Amerikassa, Hannan lapsuustoverit varsinkin. Pertun ikäiset miehet olivat mikä Amerikassa, mikä muuten kulkusalla. Ja kuta pitemmältä he puhelivat ja toistensa ajatuksiin syventyivät, sitä ikävämmältä alkoi heistä kummastakin ero tuntua. He olivatkin niin kovin vähän olleet yksissä. Minkä vuoksi? Hanna olisi tahtonut, että Perttu olisi usein käynyt heillä.
- 79. "Niin ujoko sinä olet?" hän kysyi. "Ikävä minun on sinua joka hetki, ja aina tahtoisin olla luonasi, mutta kun minulla on niin velkainen koti, niin… Joka-ikisen työn, jonka teen, teen sinua muistellessa, ja aina ajattelen, että Hannalle tämäkin tulee… Jospa olisit nähnyt sydämeeni nytkin öillä, kun olen peltoja kylvänyt… Sinun rakkautesi on antanut minulle voimia tehdä työtä, ja sinun kuvasi pelastanut minut kiusauksista ja kaikesta pahasta… Sinun vuoksesi olen raatanut ja yrittänyt, että saisin kerran sinulle sanoa… Ja arvaatko miltä tuntuu työnteko, kun toivo aineellisesta palkinnosta on niin pieni! Tarkoitan, että voihan olla, etten saa kotoa mitään, vaikka olen koettanut uurastaa… Mutta iloisin mielin olen yrittänyt, tietäessäni, että sinä hyväksyt… enkä ole voinut jättää kahta vanhaa yksin kuolemaan… Ymmärrätkö oikein minua?" Hanna pyyhki kyyneliä silmistään. "Ymmärrän minä sinun tilasi, ja jos vanhurskas Jumala meitä muistaa, niin ei meillä hätäpäivää ole." Ja Hanna kertoi, että hänellä oli vähän säästöjä, ja sitäpaitsi hän oli jo parina vuonna toimitellut minkä mitäkin uuden kodin aloittamista varten. "Ja minulla kun ei ole ihan mitään", tunnusti Perttu puolestaan. "Ei ihan mitään, jota voisin sanoa omakseni…" "Onhan sinulla kirjasi kuitenkin", lohdutti Hanna. "Ne olet ostanut omilla rahoillasi… Mutta oletpa muuten tuhansien arvoinen… En vaihtaisi sinua Lomman rikkauteen!"
- 80. He vaikenivat hetkeksi molemmin. Sitten Hanna sanoi: "Miksemme voisi aloittaa elämäämme milloin hyvänsä…! Ostaisimme vain torpan ja siinä sitten…" "Mutta minun on niin hirveän vaikea erota kotitalosta, jossa olen niin kovin paljon työtä tehnyt… Jos nyt lähtisin, niin kaikki työni olisi hukkaan mennyttä." Ja Perttu melkein pillahti itkuun. "Niin rakkaaksiko se on sinulle tullut?" kysyi Hanna. "Niin on. Siinä tahtoisin elää ja kuolla." Hannankin koti oli kiinnitetty suurista summista, ja kun talo muutenkin oli pieni ja pikkuetuinen, oli aivan varmaa, ettei Hannalle jäisi mitään kodin perintöä. Sen tiesivätkin veljet eivätkä viitsineet kotonaan mitään työtä tehdä silloinkaan, kun talon ruokaa söivät. Hanna oli äitinsä kuoleman jälkeen tullut palveluksesta kotiinsa vanhan isän taloutta hoitamaan. Aurinko oli kohonnut korkeammalle ja paistoi jo vaaran takaa joelle, saarien selille ja lännen alle korkeiden vuorien kalpeille huipuille. He katselivat alas suvannolle, jossa lauttoja nyt kulki peräkkäin. Perttu näytti nauttivan näköalasta, joka lännessä päin kylpi auringon kullassa. "Sinä rakastat tätä luontoa ja valoisia öitä… Ei kukaan muu tästä luonnosta osaa puhua niinkuin sinä…" "Niin teenkin. Kesäyönä voin unhottaa suruni ja huoleni… ja olla vain ja elää… olla niinkuin ei minulla koskaan olisikaan mitään
- 81. murhetta…" Hanna kietoi molemmat kätensä hänen kaulaansa, katsoi pitkään hänen rehellisiin kasvoihinsa, jotka olivat niin puhtaat ja himottomat ja terveen kevätahvan peittämät, katsoi kauan ja sanoi sitten: "Sinä puhdas, rakas Perttuni!" Kun Hanna jo oli hyvästellyt Perttua ja aikoi kiviaidan luota, pellon laidasta, pyörtää takaisin, muisti Perttu vielä kysyä pidellen tytön kättä omassaan: "Niin, mutta… Kuka se toinen kosija oli?" Hanna ratkesi nauramaan. "Se oli Junnon-Iikka…" "Junnon-Iikka", kertasi Perttu kummissaan. Hanna kertoi: "Junnon-Iikka ei ole mikään tyhmä poika, vaikka onkin juoppo ja retkale. Kuullessaan vastaukseni arveli hän: 'No semmoisen miehen, kuin Viraniemen Perttu on, minä sinulle soisin…'" "Vai Junnon-Iikka!" kummasteli Perttu yhä. "Aina minä Iikasta paljon olen pitänyt", hän lisäsi sitten, painoi kerran vielä Hannan kättä ja lähti tielle vievää polkua astelemaan. Hanna seisoi hetken kiviaitaan nojaten ja katsoi hänen jälkeensä ja palasi sitten kamariinsa, sanaton ikävä sydämessään. Omissa, omituisissa mietteissään Perttu käveli kotiaan päin tietä pitkin. Nyt vasta, auringon noustua, näyttivät kyläläiset käyneen
- 82. levolle. Sillä missään ei näkynyt liikettä, ei ollut tielläkään vastaantulijoita. Perttu kulki kuin unessa. Toisinaan ilo ja riemu valloitti hänen sydämensä, kun hän tunsi saavuttaneensa Hannan rakkauden. Mutta sitten taas sukelsi mieleen Lomma velkakirjoineen… Hopeasaari… ja kivuloiset vanhukset… Ja kesken kaikkea johtui hänen mieleensä, että Junnon-Iikka oli kosinut Hannaa…! Ei ollut Iikka sanallakaan sinnepäin puhunut äsken, kun lautan päällä sitä tätä juttelivat… Miksei ollut? Oli vain toimitellut Perttua tukinajoon! Mitä hän lieneekään miettinyt? Mutta ei hänen katseessaan näyttänyt petosta olevan… Oli vain ollut Pertun mielestä ystävällisempi ja osanottavampi kuin ennen… Eihän Iikka muuten huono mies ollutkaan… Ei muuta vikaa, kuin ettei osannut säästää, vaan kulutti hyvät ansionsa kortilla ja juominkeihin… Miesten komeimpia oli Iikka tummine hiuksineen ja solakkoine vartaloineen, joka oli kuin luotu tukkipoikaa varten. Helluja hänellä sanottiin olevan joka kylässä, ja joka paikkaan hän oli tervetullut… Ei ollut heillä, Pertulla ja Iikalla, koskaan ollut mitään riitaa keskenään lapsinakaan ollessa. Ja kun olivat miehiksi kumpikin varttuneet, niin harvoin yksiin sattuivat Iikan elämä kun oli vesillä ja vetten päällä, ja Perttu kiskoi maan karusta kamarasta jokapäiväistä leipäänsä. Mutta talvisin, kun Iikkakin sattui kotosalla olemaan, lainaili Perttu hänelle kirjoja luettavaksi. Mielellään Iikka niitä lukikin. Perttu oli tullut kotitien haaraan. Hän näki ilokseen jo tuomenkukkia puhjenneen puutarhassaan ja ensimmäisen ohrakylvönsä nousseen oraalle.
- 83. Welcome to our website – the perfect destination for book lovers and knowledge seekers. We believe that every book holds a new world, offering opportunities for learning, discovery, and personal growth. That’s why we are dedicated to bringing you a diverse collection of books, ranging from classic literature and specialized publications to self-development guides and children's books. More than just a book-buying platform, we strive to be a bridge connecting you with timeless cultural and intellectual values. With an elegant, user-friendly interface and a smart search system, you can quickly find the books that best suit your interests. Additionally, our special promotions and home delivery services help you save time and fully enjoy the joy of reading. Join us on a journey of knowledge exploration, passion nurturing, and personal growth every day! ebookbell.com