第1页 / 共929页
第2页 / 共929页
第3页 / 共929页
第4页 / 共929页
第5页 / 共929页
第6页 / 共929页
第7页 / 共929页
第8页 / 共929页
07-5123-07-ZigbeeClusterLibrary_Revision_7.pdf
Zigbee Cluster Library Specification
Notice of Use and Disclosure
Participants
Document Control
Document History
Table of Contents
List of Figures
List of Tables
Chapter 1 Introduction
1.1 Scope and Purpose
1.2 Acronyms and Abbreviations
1.3 Definitions
1.4 Conformance Levels
1.5 References
1.5.1 Zigbee Alliance Documents
1.5.2 International Standards Documents
1.5.3 National Standards Documents
1.5.4 IEEE Documents
1.5.5 ASHRAE Documents
1.5.6 Health Care Documents
1.5.7 Other Documents
1.6 Conventions
1.6.1 Enumerations and Reserved Values
1.6.2 Reserved Bit Fields
1.6.3 Number Format
1.7 Testing, Validation and Certification
Chapter 2 Foundation
2.1 Scope and Purpose
2.2 Cluster Library Overview
2.2.1 Architecture and Data Model
2.2.1.1 Cluster Identifier
2.2.1.2 Extensibility Model
2.2.1.3 Instance Model
2.2.1.4 Conformance Model
2.2.2 Client/Server Model
2.3 Functional Description
2.3.1 Transmission
2.3.2 Reception
2.3.2.1 Broadcast Endpoint
2.3.2.2 Broadcast Endpoint Recommendations
2.3.3 Manufacturer Specific Extensions
2.3.4 Attributes
2.3.4.1 Variables and Attributes
2.3.4.2 Dependencies on Optional Attributes
2.3.4.3 Default Value
2.3.4.4 Attribute Access
2.3.4.5 Global Attributes
2.3.4.5.1 ClusterRevision Attribute
2.3.4.5.2 AttributeReportingStatus Attribute
2.3.5 Persistent Data
2.4 Command Frame Formats
2.4.1 General ZCL Frame Format
2.4.1.1 Frame Control Field
2.4.1.1.1 Frame Type Sub-field
2.4.1.1.2 Manufacturer Specific Sub-field
2.4.1.1.3 Direction Sub-field
2.4.1.1.4 Disable Default Response Sub-field
2.4.1.2 Manufacturer Code Field
2.4.1.3 Transaction Sequence Number
2.4.1.4 Command Identifier Field
2.4.1.5 Frame Payload Field
2.5 General Command Frames
2.5.1 Read Attributes Command
2.5.1.1 Read Attributes Command Frame Format
2.5.1.1.1 ZCL Header Fields
2.5.1.1.2 Attribute Identifier Field
2.5.1.2 When Generated
2.5.1.3 Effect on Receipt
2.5.2 Read Attributes Response Command
2.5.2.1 Read Attributes Response Command Frame Format
2.5.2.1.1 ZCL Header Fields
2.5.2.1.2 Attribute Identifier Field
2.5.2.1.3 Status Field
2.5.2.1.4 Attribute Data Type Field
2.5.2.1.5 Attribute Value Field
2.5.2.2 When Generated
2.5.2.3 Effect on Receipt
2.5.3 Write Attributes Command
2.5.3.1 Write Attributes Command Frame Format
2.5.3.1.1 ZCL Header Fields
2.5.3.1.2 Attribute Identifier Field
2.5.3.1.3 Attribute Data Type Field
2.5.3.1.4 Attribute Data Field
2.5.3.2 When Generated
2.5.3.3 Effect on Receipt
2.5.4 Write Attributes Undivided Command
2.5.5 Write Attributes Response Command
2.5.5.1 Write Attributes Response Command Frame Format
2.5.5.1.1 ZCL Header Fields
2.5.5.1.2 Status Field
2.5.5.1.3 Attribute Identifier Field
2.5.5.2 When Generated
2.5.5.3 Effect on Receipt
2.5.6 Write Attributes No Response Command
2.5.6.1 Write Attributes No Response Command Frame Format
2.5.6.1.1 ZCL Header Fields
2.5.6.1.2 Write Attribute Records
2.5.6.2 When Generated
2.5.6.3 Effect on Receipt
2.5.7 Configure Reporting Command
2.5.7.1 Configure Reporting Command Frame Format
2.5.7.1.1 ZCL Header Fields
2.5.7.1.2 Direction Field
2.5.7.1.3 Attribute Identifier Field
2.5.7.1.4 Attribute Data Type Field
2.5.7.1.5 Minimum Reporting Interval Field
2.5.7.1.6 Maximum Reporting Interval Field
2.5.7.1.7 Reportable Change Field
2.5.7.1.8 Timeout Period Field
2.5.7.2 When Generated
2.5.7.3 Effect on Receipt
2.5.8 Configure Reporting Response Command
2.5.8.1 Configure Reporting Response Command Frame Format
2.5.8.1.1 ZCL Header Fields
2.5.8.1.2 Direction Field
2.5.8.1.3 Status Field
2.5.8.2 When Generated
2.5.8.3 Effect on Receipt
2.5.9 Read Reporting Configuration Command
2.5.9.1 Read Reporting Configuration Command Frame Format
2.5.9.1.1 ZCL Header Fields
2.5.9.1.2 Direction Field
2.5.9.1.3 Attribute Identifier Field
2.5.9.2 Effect on Receipt
2.5.10 Read Reporting Configuration Response Command
2.5.10.1 Read Reporting Configuration Response Command Frame Format
2.5.10.1.1 ZCL Header Fields
2.5.10.1.2 Status Field
2.5.10.1.3 Direction Field
2.5.10.1.4 Attribute Identifier Field
2.5.10.1.5 Minimum Reporting Interval Field
2.5.10.1.6 Maximum Reporting Interval Field
2.5.10.1.7 Reportable Change Field
2.5.10.1.8 Timeout Period Field
2.5.10.2 When Generated
2.5.10.3 Effect on Receipt
2.5.11 Report Attributes Command
2.5.11.1 Report Attributes Command Frame Format
2.5.11.1.1 ZCL Header Fields
2.5.11.1.2 Attribute Identifier Field
2.5.11.1.3 Attribute Data Type Field
2.5.11.1.4 Attribute Data Field
2.5.11.2 When Generated
2.5.11.2.1 Periodic Reporting
2.5.11.2.2 Changes to 'Discrete' Attributes
2.5.11.2.3 Changes to 'Analog' Attributes
2.5.11.2.4 Cluster Specific Conditions
2.5.11.2.5 Consolidation of Attribute Reporting
2.5.11.3 Effect on Receipt
2.5.12 Default Response Command
2.5.12.1 Default Response Command Frame Format
2.5.12.1.1 ZCL Header Fields
2.5.12.1.2 Command Identifier Field
2.5.12.1.3 Status Code Field
2.5.12.2 When Generated
2.5.12.3 Effect on Receipt
2.5.13 Discover Attributes Command
2.5.13.1 Discover Attributes Command Frame Format
2.5.13.1.1 ZCL Header Fields
2.5.13.1.2 Start Attribute Identifier Field
2.5.13.1.3 Maximum Attribute Identifiers Field
2.5.13.2 When Generated
2.5.13.3 Effect on Receipt
2.5.14 Discover Attributes Response Command
2.5.14.1 Discover Attributes Response Command Frame Format
2.5.14.1.1 ZCL Header Fields
2.5.14.1.2 Discovery Complete Field
2.5.14.1.3 Attribute Identifier Field
2.5.14.1.4 Attribute Data Type Field
2.5.14.2 When Generated
2.5.14.3 Effect on Receipt
2.5.15 Read Attributes Structured Command
2.5.15.1 Read Attributes Structured Command Frame Format
2.5.15.1.1 ZCL Header Fields
2.5.15.1.2 Attribute Identifier Field
2.5.15.1.3 Selector Field
2.5.15.2 When Generated
2.5.15.3 Effect on Receipt
2.5.16 Write Attributes Structured Command
2.5.16.1 Write Attributes Structured Command Frame Format
2.5.16.1.1 ZCL Header Fields
2.5.16.1.2 Attribute Identifier Field
2.5.16.1.3 Selector Field
2.5.16.1.4 Writing an Element to an Array or Structure
2.5.16.1.5 Adding/Removing an Element to/from a Set or Bag
2.5.16.1.6 Attribute Data Type Field
2.5.16.1.7 Attribute Value Field
2.5.16.2 When Generated
2.5.16.3 Effect on Receipt
2.5.17 Write Attributes Structured Response Command
2.5.17.1 Write Attributes Structured Response Command Frame Format
2.5.17.1.1 ZCL Header Fields
2.5.17.1.2 Status Field
2.5.17.1.3 Attribute Identifier Field
2.5.17.1.4 Selector Field
2.5.17.2 When Generated
2.5.17.3 Effect on Receipt
2.5.18 Discover Commands Received Command
2.5.18.1 Discover Commands Received Command Frame Format
2.5.18.1.1 ZCL Header Fields
2.5.18.1.2 Start Command Identifier Field
2.5.18.1.3 Maximum Command Identifiers Field
2.5.18.2 When Generated
2.5.18.3 Effect on Receipt
2.5.19 Discover Commands Received Response
2.5.19.1 Discover Commands Received Response Frame
2.5.19.1.1 ZCL Header Fields
2.5.19.1.2 Discovery Complete Field
2.5.19.1.3 Command Identifier Field
2.5.19.2 When Generated
2.5.19.3 Effect on Receipt
2.5.20 Discover Commands Generated Command
2.5.20.1 Discover Commands Generated Command Frame Format
2.5.20.2 When Generated
2.5.20.3 Effect on Receipt
2.5.21 Discover Commands Generated Response
2.5.21.1 Discover Commands Generated Response Frame
2.5.21.2 When Generated
2.5.21.3 Effect on Receipt
2.5.22 Discover Attributes Extended Command
2.5.22.1 Discover Attributes Extended Command Frame Format
2.5.22.1.1 ZCL Header Fields
2.5.22.1.2 Start Attribute Identifier Field
2.5.22.1.3 Maximum Attribute Identifiers Field
2.5.22.2 When Generated
2.5.22.3 Effect on Receipt
2.5.23 Discover Attributes Extended Response Command
2.5.23.1 Discover Attributes Extended Response Command Frame Format
2.5.23.1.1 ZCL Header Fields
2.5.23.1.2 Discovery Complete Field
2.5.23.1.3 Attribute Identifier Field
2.5.23.1.4 Attribute Data Type Field
2.5.23.1.5 Attribute Access Control Field
2.5.23.2 When Generated
2.5.23.3 Effect on Receipt
2.6 Addressing, Types and Enumerations
2.6.1 Addressing
2.6.1.1 Profile Identifier
2.6.1.2 Device Identifier
2.6.1.3 Cluster Identifier
2.6.1.4 Attribute Identifier
2.6.1.5 Command Identifier
2.6.2 Data Types
2.6.2.1 No Data Type
2.6.2.2 General Data (8, 16, 24, 32, 40, 48, 56 and 64-bit)
2.6.2.3 Boolean
2.6.2.4 Bitmap (8, 16, 24, 32, 40, 48, 56 and 64-bit)
2.6.2.5 Unsigned Integer (8, 16, 24, 32, 40, 48, 56 and 64-bit)
2.6.2.6 Signed Integer (8, 16, 24, 32, 40, 48, 56 and 64-bit)
2.6.2.7 Enumeration (8-bit, 16-bit)
2.6.2.8 Semi-precision
2.6.2.9 Single Precision
2.6.2.10 Double Precision
2.6.2.11 Octet String
2.6.2.12 Character String
2.6.2.13 Long Octet String
2.6.2.14 Long Character String
2.6.2.15 Fixed ASCII
2.6.2.16 Array
2.6.2.17 Structure
2.6.2.18 Set
2.6.2.19 Bag
2.6.2.20 Time of Day
2.6.2.21 Date
2.6.2.22 UTCTime
2.6.2.23 Cluster ID
2.6.2.24 Attribute ID
2.6.2.25 BACnet OID (Object Identifier)
2.6.2.26 IEEE Address
2.6.2.27 128-bit Security Key
2.6.2.28 Opaque
2.6.2.29 Unknown
2.6.3 Status Enumerations
Chapter 3 General
3.1 General Description
3.1.1 Introduction
3.1.2 Cluster List
3.2 Basic
3.2.1 Overview
3.2.1.1 Revision History
3.2.1.2 Classification
3.2.1.3 Cluster Identifiers
3.2.2 Server
3.2.2.1 Dependencies
3.2.2.2 Attributes
3.2.2.2.1 ZCLVersion Attribute
3.2.2.2.2 ApplicationVersion Attribute
3.2.2.2.3 StackVersion Attribute
3.2.2.2.4 HWVersion Attribute
3.2.2.2.5 ManufacturerName Attribute
3.2.2.2.6 ModelIdentifier Attribute
3.2.2.2.7 DateCode Attribute
3.2.2.2.8 PowerSource Attribute
3.2.2.2.9 GenericDeviceClass Attribute
3.2.2.2.10 GenericDeviceType Attribute
3.2.2.2.11 ProductCode Attribute
3.2.2.2.12 ProductURL Attribute
3.2.2.2.13 Manufacturer VersionDetails Attribute
3.2.2.2.14 SerialNumber Attribute
3.2.2.2.15 ProductLabel Attribute
3.2.2.2.16 LocationDescription Attribute
3.2.2.2.17 PhysicalEnvironment Attribute
3.2.2.2.18 DeviceEnabled Attribute
3.2.2.2.19 AlarmMask Attribute
3.2.2.2.20 DisableLocalConfig Attribute
3.2.2.2.21 SWBuildID Attribute
3.2.2.3 Commands Received
3.2.2.3.1 Reset to Factory Defaults Command
3.2.2.3.1.1 Effect on Receipt
3.2.2.4 Commands Generated
3.2.3 Client
3.3 Power Configuration
3.3.1 Overview
3.3.1.1 Revision History
3.3.1.2 Classification
3.3.1.3 Cluster Identifiers
3.3.2 Server
3.3.2.1 Dependencies
3.3.2.2 Attributes
3.3.2.2.1 Mains Information Attribute Set
3.3.2.2.1.1 MainsVoltage Attribute
3.3.2.2.1.2 MainsFrequency Attribute
3.3.2.2.2 Mains Settings Attribute Set
3.3.2.2.2.1 MainsAlarmMask Attribute
3.3.2.2.2.2 MainsVoltageMinThreshold Attribute
3.3.2.2.2.3 MainsVoltageMaxThreshold Attribute
3.3.2.2.2.4 MainsVoltageDwellTripPoint Attribute
3.3.2.2.3 Battery Information Attribute Set
3.3.2.2.3.1 BatteryVoltage Attribute
3.3.2.2.3.2 BatteryPercentageRemaining Attribute
3.3.2.2.4 Battery Settings Attribute Set
3.3.2.2.4.1 BatteryManufacturer Attribute
3.3.2.2.4.2 BatterySize Attribute
3.3.2.2.4.3 BatteryAHrRating Attribute
3.3.2.2.4.4 BatteryQuantity Attribute
3.3.2.2.4.5 BatteryRatedVoltage Attribute
3.3.2.2.4.6 BatteryAlarmMask Attribute
3.3.2.2.4.7 BatteryVoltageMinThreshold Attribute
3.3.2.2.4.8 BatteryVoltageThreshold 1-3 Attributes
3.3.2.2.4.9 BatteryPercentageMinThreshold Attribute
3.3.2.2.4.10 BatteryPercentageThreshold 1-3 Attributes
3.3.2.2.4.11 BatteryAlarmState Attribute
3.3.2.2.5 Battery Information 2 Attribute Set
3.3.2.2.6 Battery Settings 2 Attribute Set
3.3.2.2.7 Battery Information 3 Attribute Set
3.3.2.2.8 Battery Settings 3 Attribute Set
3.3.2.3 Commands Received
3.3.2.4 Commands Generated
3.3.3 Client
3.4 Device Temperature Configuration
3.4.1 Overview
3.4.1.1 Revision History
3.4.1.2 Classification
3.4.1.3 Cluster Identifiers
3.4.2 Server
3.4.2.1 Dependencies
3.4.2.2 Attributes
3.4.2.2.1 Device Temperature Information Attribute Set
3.4.2.2.1.1 CurrentTemperature Attribute
3.4.2.2.1.2 MinTempExperienced Attribute
3.4.2.2.1.3 MaxTempExperienced Attribute
3.4.2.2.1.4 OverTempTotalDwell Attribute
3.4.2.2.2 Device Temperature Settings Attribute Set
3.4.2.2.2.1 DeviceTempAlarmMask Attribute
3.4.2.2.2.2 LowTempThreshold Attribute
3.4.2.2.2.3 HighTempThreshold Attribute
3.4.2.2.2.4 LowTempDwellTripPoint Attribute
3.4.2.2.2.5 HighTempDwellTripPoint Attribute
3.4.2.3 Commands
3.4.3 Client
3.5 Identify
3.5.1 Overview
3.5.1.1 Revision History
3.5.1.2 Classification
3.5.1.3 Cluster Identifiers
3.5.2 Server
3.5.2.1 Attributes
3.5.2.1.1 IdentifyTime Attribute
3.5.2.2 Commands Received
3.5.2.2.1 Identify Command
3.5.2.2.1.1 Payload Format
3.5.2.2.1.2 Effect on Receipt
3.5.2.2.2 Identify Query Command
3.5.2.2.2.1 Effect on Receipt
3.5.2.2.3 Trigger Effect Command
3.5.2.2.3.1 Effect Identifier Field
3.5.2.2.3.2 Effect Variant Field
3.5.2.2.3.3 Effect on Receipt
3.5.2.3 Commands Generated
3.5.2.3.1 Identify Query Response Command
3.5.2.3.1.1 Payload Format
3.5.2.3.1.2 Timeout Field
3.5.2.3.1.3 Effect on Receipt
3.5.3 Client
3.6 Groups
3.6.1 Overview
3.6.1.1 Revision History
3.6.1.2 Classification
3.6.1.3 Cluster Identifiers
3.6.2 Server
3.6.2.1 Dependencies
3.6.2.2 Attributes
3.6.2.2.1 NameSupport Attribute
3.6.2.2.2 Group Names
3.6.2.3 Commands Received
3.6.2.3.1 Generic Usage Notes
3.6.2.3.2 Add Group Command
3.6.2.3.2.1 Payload Format
3.6.2.3.2.2 Effect on Receipt
3.6.2.3.3 View Group Command
3.6.2.3.3.1 Payload Format
3.6.2.3.3.2 Effect on Receipt
3.6.2.3.4 Get Group Membership Command
3.6.2.3.4.1 Payload Format
3.6.2.3.4.2 Effect on Receipt
3.6.2.3.5 Remove Group Command
3.6.2.3.5.1 Payload Format
3.6.2.3.5.2 Effect on Receipt
3.6.2.3.6 Remove All Groups Command
3.6.2.3.6.1 Payload Format
3.6.2.3.6.2 Effect on Receipt
3.6.2.3.7 Add Group If Identifying Command
3.6.2.3.7.1 Payload Format
3.6.2.3.7.2 Effect on Receipt
3.6.2.4 Commands Generated
3.6.2.4.1 Add Group Response Command
3.6.2.4.1.1 Payload Format
3.6.2.4.1.2 When Generated
3.6.2.4.2 View Group Response Command
3.6.2.4.2.1 Payload Format
3.6.2.4.2.2 When Generated
3.6.2.4.3 Get Group Membership Response Command
3.6.2.4.3.1 Payload Format
3.6.2.4.3.2 When Generated
3.6.2.4.4 Remove Group Response Command
3.6.2.4.4.1 Payload Format
3.6.2.4.4.2 When Generated
3.6.3 Client
3.7 Scenes
3.7.1 Overview
3.7.1.1 Revision History
3.7.1.2 Classification
3.7.1.3 Cluster Identifiers
3.7.2 Server
3.7.2.1 Dependencies
3.7.2.2 Attributes
3.7.2.2.1 Scene Management Information Attribute Set
3.7.2.2.1.1 SceneCount Attribute
3.7.2.2.1.2 CurrentScene Attribute
3.7.2.2.1.3 CurrentGroup Attribute
3.7.2.2.1.4 SceneValid Attribute
3.7.2.2.1.5 NameSupport Attribute
3.7.2.2.1.6 LastConfiguredBy Attribute
3.7.2.3 Scene Table
3.7.2.3.1 Scene Names
3.7.2.3.2 Maximum Number of Scenes
3.7.2.4 Commands Received
3.7.2.4.1 Generic Usage Notes
3.7.2.4.2 Add Scene Command
3.7.2.4.2.1 Payload Format
3.7.2.4.2.2 Effect on Receipt
3.7.2.4.3 View Scene Command
3.7.2.4.3.1 Payload Format
3.7.2.4.3.2 Effect on Receipt
3.7.2.4.4 Remove Scene Command
3.7.2.4.4.1 Payload Format
3.7.2.4.4.2 Effect on Receipt
3.7.2.4.5 Remove All Scenes Command
3.7.2.4.5.1 Payload Format
3.7.2.4.5.2 Effect on Receipt
3.7.2.4.6 Store Scene Command
3.7.2.4.6.1 Payload Format
3.7.2.4.6.2 Effect on Receipt
3.7.2.4.7 Recall Scene Command
3.7.2.4.7.1 Payload Format
3.7.2.4.7.2 Effect on Receipt
3.7.2.4.8 Get Scene Membership Command
3.7.2.4.8.1 Payload Format
3.7.2.4.8.2 Effect on Receipt
3.7.2.4.9 Enhanced Add Scene Command
3.7.2.4.9.1 Effect on Receipt
3.7.2.4.10 Enhanced View Scene Command
3.7.2.4.10.1 Effect on Receipt
3.7.2.4.11 Copy Scene Command
3.7.2.4.11.1 Mode Field
3.7.2.4.11.2 Group Identifier From Field
3.7.2.4.11.3 Scene Identifier From Field
3.7.2.4.11.4 Group Identifier To Field
3.7.2.4.11.5 Scene Identifier To Field
3.7.2.4.11.6 Effect on Receipt
3.7.2.5 Commands Generated
3.7.2.5.1 Add Scene Response Command
3.7.2.5.1.1 Payload Format
3.7.2.5.1.2 When Generated
3.7.2.5.2 View Scene Response Command
3.7.2.5.2.1 Payload Format
3.7.2.5.2.2 When Generated
3.7.2.5.3 Remove Scene Response Command
3.7.2.5.3.1 Payload Format
3.7.2.5.3.2 When Generated
3.7.2.5.3.3 Remove All Scenes Response Command
3.7.2.5.3.4 Payload Format
3.7.2.5.3.5 When Generated
3.7.2.5.3.6 Store Scene Response Command
3.7.2.5.3.7 Payload Format
3.7.2.5.3.8 When Generated
3.7.2.5.3.9 Get Scene Membership Response Command
3.7.2.5.3.10 Payload Format
3.7.2.5.3.11 When Generated
3.7.2.5.4 Enhanced Add Scene Response Command
3.7.2.5.5 Enhanced View Scene Response Command
3.7.2.5.5.1 When Generated
3.7.2.5.6 Copy Scene Response Command
3.7.2.5.6.1 3.7.2.5.9.1 Status field
3.7.2.5.6.2 Group Identifier From Field
3.7.2.5.6.3 Scene Identifier From Field
3.7.2.5.6.4 When Generated
3.7.3 Client
3.8 On/Off
3.8.1 Overview
3.8.1.1 Revision History
3.8.1.2 Classification
3.8.1.3 Cluster Identifiers
3.8.2 Server
3.8.2.1 Dependencies
3.8.2.2 Attributes
3.8.2.2.1 OnOff Attribute
3.8.2.2.2 GlobalSceneControl Attribute
3.8.2.2.3 OnTime Attribute
3.8.2.2.4 OffWaitTime Attribute
3.8.2.2.5 StartUpOnOff Attribute
3.8.2.3 Commands Received
3.8.2.3.1 Off Command
3.8.2.3.1.1 Effect on Receipt
3.8.2.3.2 On Command
3.8.2.3.2.1 Effect on Receipt
3.8.2.3.3 Toggle Command
3.8.2.3.3.1 Effect on Receipt
3.8.2.3.4 Off With Effect Command
3.8.2.3.4.1 Effect Identifier Field
3.8.2.3.4.2 Effect Variant Field
3.8.2.3.4.3 Effect on Receipt
3.8.2.3.5 On With Recall Global Scene Command
3.8.2.3.5.1 Effect on Receipt
3.8.2.3.6 On With Timed Off Command
3.8.2.3.6.1 On/Off Control Field
3.8.2.3.6.2 On Time Field
3.8.2.3.6.3 Off Wait Time Field
3.8.2.3.6.4 Effect on Receipt
3.8.2.4 State Description
3.8.2.5 Commands Generated
3.8.2.6 Scene Table Extensions
3.8.2.7 Attribute Reporting
3.8.3 Client
3.9 On/Off Switch Configuration
3.9.1 Overview
3.9.1.1 Revision History
3.9.1.2 Classification
3.9.1.3 Cluster Identifiers
3.9.2 Server
3.9.2.1 Dependencies
3.9.2.2 Attributes
3.9.2.2.1 Switch Information Attribute Set
3.9.2.2.2 SwitchType Attribute
3.9.2.2.3 Switch Settings Attribute Set
3.9.2.2.3.1 SwitchActions Attribute
3.9.2.3 Commands
3.9.3 Client
3.10 Level
3.10.1 Overview
3.10.1.1 Revision History
3.10.1.2 Classification
3.10.1.3 Cluster Identifiers
3.10.2 Server
3.10.2.1 Dependencies
3.10.2.1.1 Effect of On/Off Commands on the CurrentLevel Attribute
3.10.2.1.2 Effect of Level Control Commands on the OnOff Attribute
3.10.2.1.3 GlobalSceneControl and Commands with On/Off
3.10.2.2 Attributes
3.10.2.2.1 CurrentLevel Attribute
3.10.2.2.2 RemainingTime Attribute
3.10.2.2.3 MinLevel Attribute
3.10.2.2.4 MaxLevel Attribute
1.1.1.1.1
3.10.2.2.5 CurrentFrequency Attribute
3.10.2.2.6 MinFrequency Attribute
3.10.2.2.7 MaxFrequency Attribute
3.10.2.2.8 Options Attribute
3.10.2.2.8.1 ExecuteIfOff Options Bit
3.10.2.2.9 OnOffTransitionTime Attribute
3.10.2.2.10 OnLevel Attribute
3.10.2.2.11 OnTransitionTime Attribute
3.10.2.2.12 OffTransitionTime Attribute
3.10.2.2.13 DefaultMoveRate Attribute
3.10.2.2.14 StartUpCurrentLevel Attribute
3.10.2.3 Commands Received
3.10.2.3.1 Move to Level Command
3.10.2.3.1.1 Payload Format
3.10.2.3.1.2 Effect on Receipt
3.10.2.3.2 Move Command
3.10.2.3.2.1 Payload Format
3.10.2.3.2.2 Move Mode Field
3.10.2.3.2.3 Rate Field
3.10.2.3.2.4 Effect on Receipt
3.10.2.3.3 Step Command
3.10.2.3.3.1 Payload Format
3.10.2.3.3.2 Effect on Receipt
3.10.2.3.4 Stop Command
3.10.2.3.4.1 Payload Format
3.10.2.3.4.2 Effect of Receipt
3.10.2.3.5 Move to Closest Frequency Command
3.10.2.3.5.1 Payload Format
3.10.2.3.5.2 Effect of Receipt
3.10.2.3.6 'With On/Off' Commands
3.10.2.4 Commands Generated
3.10.3 Client
3.11 Alarms
3.11.1 Overview
3.11.1.1 Revision History
3.11.1.2 Classification
3.11.1.3 Cluster Identifiers
3.11.2 Server
3.11.2.1 Dependencies
3.11.2.2 Attributes
3.11.2.2.1 Alarm Information Attribute Set
3.11.2.2.1.1 AlarmCount Attribute
3.11.2.3 Alarm Table
3.11.2.3.1 Alarm Table Format
3.11.2.4 Commands Received
3.11.2.4.1 Reset Alarm Command
3.11.2.4.1.1 Payload Format
3.11.2.4.2 Reset All Alarms Command
3.11.2.4.3 Get Alarm Command
3.11.2.4.4 Reset Alarm Log Command
3.11.2.5 Commands Generated
3.11.2.5.1 Alarm Command
3.11.2.5.1.1 Payload Format
3.11.2.5.2 Get Alarm Response Command
3.11.2.5.2.1 Payload Format
3.11.3 Client
3.12 Time
3.12.1 Overview
3.12.1.1 Revision History
3.12.1.2 Classification
3.12.1.3 Cluster Identifiers
3.12.2 Server
3.12.2.1 Attributes
3.12.2.1.1 Time Attribute
3.12.2.1.2 TimeStatus Attribute
3.12.2.1.3 TimeZone Attribute
3.12.2.1.4 DstStart Attribute
3.12.2.1.5 DstEnd Attribute
3.12.2.1.6 DstShift Attribute
3.12.2.1.7 StandardTime Attribute
3.12.2.1.8 LocalTime Attribute
3.12.2.1.9 LastSetTime Attribute
3.12.2.1.10 ValidUntilTime Attribute
3.12.2.2 Commands Received
3.12.2.3 Commands Generated
3.12.3 Client
3.13 RSSI Location
3.13.1 Overview
3.13.1.1 Revision History
3.13.1.2 Classification
3.13.1.3 Cluster Identifiers
3.13.2 Server
3.13.2.1 Attributes
3.13.2.1.1 Location Information Attribute Set
3.13.2.1.1.1 LocationType Attribute
3.13.2.1.1.2 LocationMethod Attribute
3.13.2.1.1.3 LocationAge Attribute
3.13.2.1.1.4 QualityMeasure Attribute
3.13.2.1.1.5 NumberOfDevices Attribute
3.13.2.1.2 Location Settings Attribute Set
3.13.2.1.2.1 Coordinate 1,2,3 Attributes
3.13.2.1.2.2 Power Attribute
3.13.2.1.2.3 PathLossExponent Attribute
3.13.2.1.2.4 ReportingPeriod Attribute
3.13.2.1.2.5 CalculationPeriod Attribute
3.13.2.1.2.6 NumberRSSIMeasurements Attribute
3.13.2.2 Commands Received
3.13.2.2.1 Set Absolute Location Command
3.13.2.2.1.1 Payload Format
3.13.2.2.1.2 Effect on Receipt
3.13.2.2.2 Set Device Configuration Command
3.13.2.2.2.1 Payload Format
3.13.2.2.2.2 Effect on Receipt
3.13.2.2.3 Get Device Configuration Command
3.13.2.2.3.1 Payload Format
3.13.2.2.3.2 Effect on Receipt
3.13.2.2.4 Get Location Data Command
3.13.2.2.4.1 Payload Format
3.13.2.2.4.2 Effect on Receipt
3.13.2.2.5 RSSI Response Command
3.13.2.2.5.1 Payload Format
3.13.2.2.5.2 Effect on Receipt
3.13.2.2.6 Send Pings Command
3.13.2.2.6.1 Payload Format
3.13.2.2.6.2 Effect on Receipt
3.13.2.2.7 Anchor Node Announce Command
3.13.2.2.7.1 Payload Format
3.13.2.3 Commands Generated
3.13.2.3.1 Device Configuration Response Command
3.13.2.3.1.1 Payload Format
3.13.2.3.2 Location Data Response Command
3.13.2.3.2.1 Payload Format
3.13.2.3.3 Location Data Notification Command
3.13.2.3.3.1 Payload Format
3.13.2.3.4 Compact Location Data Notification Command
3.13.2.3.5 RSSI Ping Command
3.13.2.3.5.1 Payload Format
3.13.2.3.6 RSSI Request Command
3.13.2.3.6.1 Payload Format
3.13.2.3.6.2 Effect on Receipt
3.13.2.3.7 Report RSSI Measurements Command
3.13.2.3.7.1 Payload Format
3.13.2.3.8 Request Own Location Command
3.13.2.3.8.1 Payload Format
3.13.2.3.8.2 Effect On Receipt
3.13.3 Client
3.14 Input, Output and Value Clusters
3.14.1 Overview
3.14.2 Analog Input (Basic)
3.14.2.1 Revision History
3.14.2.2 Classification
3.14.2.3 Cluster Identifiers
3.14.2.4 Server
3.14.2.4.1 Attributes
3.14.2.5 Commands
3.14.2.6 Attribute Reporting
3.14.2.7 Client
3.14.3 Analog Output (Basic)
3.14.3.1 Revision History
3.14.3.2 Classification
3.14.3.3 Cluster Identifiers
3.14.3.4 Server
3.14.3.4.1 Attributes
3.14.3.5 Commands
3.14.3.6 Attribute Reporting
3.14.3.7 Client
3.14.4 Analog Value (Basic)
3.14.4.1 Revision History
3.14.4.2 Classification
3.14.4.3 Cluster Identifiers
3.14.4.4 Server
3.14.4.4.1 Attributes
3.14.4.5 Commands
3.14.4.6 Attribute Reporting
3.14.4.7 Client
3.14.5 Binary Input (Basic)
3.14.5.1 Revision History
3.14.5.2 Classification
3.14.5.3 Cluster Identifiers
3.14.5.4 Server
3.14.5.4.1 Attributes
3.14.5.5 Commands
3.14.5.6 Attribute Reporting
3.14.5.7 Client
3.14.6 Binary Output (Basic)
3.14.6.1 Revision History
3.14.6.2 Classification
3.14.6.3 Cluster Identifiers
3.14.6.4 Server
3.14.6.4.1 Attributes
3.14.6.5 Commands
3.14.6.6 Attribute Reporting
3.14.6.7 Client
3.14.7 Binary Value (Basic)
3.14.7.1 Revision History
3.14.7.2 Classification
3.14.7.3 Cluster Identifiers
3.14.7.4 Server
3.14.7.4.1 Attributes
3.14.7.5 Commands
3.14.7.6 Attribute Reporting
3.14.7.7 Client
3.14.8 Multistate Input (Basic)
3.14.8.1 Revision History
3.14.8.2 Classification
3.14.8.3 Cluster Identifiers
3.14.8.4 Server
3.14.8.4.1 Attributes
3.14.8.5 Commands
3.14.8.6 Attribute Reporting
3.14.8.7 Client
3.14.9 Multistate Output (Basic)
3.14.9.1 Revision History
3.14.9.2 Classification
3.14.9.3 Cluster Identifiers
3.14.9.4 Server
3.14.9.4.1 Attributes
3.14.9.5 Commands
3.14.9.6 Attribute Reporting
3.14.9.7 Client
3.14.10 Multistate Value (Basic)
3.14.10.1 Revision History
3.14.10.2 Classification
3.14.10.3 Cluster Identifiers
3.14.10.4 Server
3.14.10.4.1 Attributes
3.14.10.5 Commands
3.14.10.6 Attribute Reporting
3.14.10.7 Client
3.14.11 Attribute Descriptions
3.14.11.1 OutOfService Attribute
3.14.11.2 PresentValue Attribute
3.14.11.3 StatusFlags Attribute
3.14.11.4 Description Attribute
3.14.11.5 MaxPresentValue Attribute
3.14.11.6 PriorityArray Attribute
3.14.11.7 RelinquishDefault Attribute
3.14.11.8 MinPresentValue Attribute
3.14.11.9 Reliability Attribute
3.14.11.10 EngineeringUnits Attribute
3.14.11.11 Resolution Attribute
3.14.11.12 ActiveText Attribute
3.14.11.13 InactiveText Attribute
3.14.11.14 MinimumOffTime Attribute
3.14.11.15 MinimumOnTime Attribute
3.14.11.16 Polarity Attribute
3.14.11.17 NumberOfStates Attribute
3.14.11.18 StateText Attribute
3.14.11.19 ApplicationType Attribute
3.14.11.19.1 Analog Input (AI) Types
3.14.11.19.1.1 Type = 0x00: Temperature in degrees C
3.14.11.19.1.2 Type = 0x01: Relative Humidity in %
3.14.11.19.1.3 Type = 0x02: Pressure in Pascal
3.14.11.19.1.4 Type = 0x03: Flow in Liters/Second
3.14.11.19.1.5 Type = 0x04: Percentage %
3.14.11.19.1.6 Type = 0x05: Parts per Million PPM
3.14.11.19.1.7 Type = 0x06: Rotational Speed in RPM
3.14.11.19.1.8 Type = 0x07: Current in Amps
3.14.11.19.1.9 Type = 0x08: Frequency in Hz
3.14.11.19.1.10 Type = 0x09: Power in Watts
3.14.11.19.1.11 Type = 0x0A: Power in kW
3.14.11.19.1.12 Type = 0x0B: Energy in kWH
3.14.11.19.1.13 Type = 0x0C: Count – Unitless
3.14.11.19.1.14 Type = 0x0D: Enthalpy in KJoules/Kg
3.14.11.19.1.15 Type = 0x0E: Time in Seconds
3.14.11.19.2 Analog Output (AO) types
3.14.11.19.2.1 Type = 0x00: Temperature in Degrees C
3.14.11.19.2.2 Type = 0x01: Relative Humidity in %
3.14.11.19.2.3 Type = 0x02: Pressure Pascal
3.14.11.19.2.4 Type = 0x03: Flow in Liters/Second
3.14.11.19.2.5 Type = 0x04: Percentage %
3.14.11.19.2.6 Type = 0x05: Parts per Million PPM
3.14.11.19.2.7 Type = 0x06: Rotational Speed RPM
3.14.11.19.2.8 Type = 0x07: Current in Amps
3.14.11.19.2.9 Type = 0x08: Frequency in Hz
3.14.11.19.2.10 Type = 0x09: Power in Watts
3.14.11.19.2.11 Type = 0x0A: Power in kW
3.14.11.19.2.12 Type = 0x0B: Energy in kWh
3.14.11.19.2.13 Type = 0x0C: Count – Unitless
3.14.11.19.2.14 Type = 0x0D: Enthalpy in KJoules/Kg
3.14.11.19.2.15 Type = 0x0E: Time in Seconds
3.14.11.19.3 Analog Value (AV) Types
3.14.11.19.3.1 Type = 0x00: Temperature in Degrees C
3.14.11.19.3.2 Type = 0x01: Area in Square Metres
3.14.11.19.3.3 Type = 0x02: Multiplier - Number
3.14.11.19.3.4 Type 0x03: Flow in Litres/Second
3.14.11.19.4 Binary Inputs (BI) Types
3.14.11.19.4.1 Type = 0x00: Application Domain HVAC
3.14.11.19.4.2 Type = 0x01: Application Domain Security
3.14.11.19.5 Binary Output (BO) Types
3.14.11.19.5.1 Type = 0x00: Application Domain HVAC
3.14.11.19.5.2 Type = 0x02: Application Domain Security
3.14.11.19.6 Binary Value (BV) Types
3.14.11.19.6.1 Type = 0x00
3.14.11.19.7 Multistate Input (MI) Types
3.14.11.19.7.1 Type = 0x00: Application Domain HVAC
3.14.11.19.8 Multistate Output (MO) Types
3.14.11.19.8.1 Type = 0x00: Application Domain HVAC
3.14.11.19.9 Multistate Value (MV) Types
3.14.11.19.9.1 Type = 0x00: Application Domain HVAC
3.15 Diagnostics
3.15.1 Overview
3.15.1.1 Revision History
3.15.1.2 Classification
3.15.1.3 Cluster Identifiers
3.15.2 Server
3.15.2.1 Attributes
3.15.2.1.1 Hardware Information Attribute Set
3.15.2.1.1.1 NumberOfResets Attribute
3.15.2.1.1.2 PersistentMemoryWrites Attribute
3.15.2.1.2 Stack / Network Information Attribute Set
3.15.2.1.2.1 MacRxBcast Attribute
3.15.2.1.2.2 MacTxBcast Attribute
3.15.2.1.2.3 MacRxUcast Attribute
3.15.2.1.2.4 MacTxUcast Attribute
3.15.2.1.2.5 MacTxUcastRetry Attribute
3.15.2.1.2.6 MacTxUcastFail Attribute
3.15.2.1.2.7 APSRxBcast Attribute
3.15.2.1.2.8 APSTxBcast Attribute
3.15.2.1.2.9 APSRxUcast Attribute
3.15.2.1.2.10 APSTxUcastSuccess Attribute
3.15.2.1.2.11 APSTxUcastRetry Attribute
3.15.2.1.2.12 APSTxUcastFail Attribute
3.15.2.1.2.13 RouteDiscInitiated Attribute
3.15.2.1.2.14 NeighborAdded Attribute
3.15.2.1.2.15 NeighborRemoved Attribute
3.15.2.1.2.16 NeighborStale Attribute
3.15.2.1.2.17 JoinIndication Attribute
3.15.2.1.2.18 ChildMoved Attribute
3.15.2.1.2.19 NWKFCFailure Attribute
3.15.2.1.2.20 APSFCFailure Attribute
3.15.2.1.2.21 APSUnauthorizedKey Attribute
3.15.2.1.2.22 NWKDecryptFailures Attribute
3.15.2.1.2.23 APSDecryptFailures Attribute
3.15.2.1.2.24 PacketBufferAllocateFailures Attribute
3.15.2.1.2.25 RelayedUcast Attribute
3.15.2.1.2.26 PacketValidateDropCount Attribute
3.15.2.1.2.27 AverageMACRetryPerAPSMessageSent Attribute
3.15.2.1.2.28 LastMessageLQI Attribute
3.15.2.1.2.29 LastMessageRSSI Attribute
3.15.2.2 Commands
3.15.3 Client
3.16 Poll Control
3.16.1 Overview
3.16.1.1 Revision History
3.16.1.2 Classification
3.16.1.3 Cluster Identifiers
3.16.2 Terminology
3.16.3 Commissioning Process
3.16.4 Server
3.16.4.1 Attributes
3.16.4.1.1 Check-inInterval Attribute
3.16.4.1.2 LongPollInterval Attribute
3.16.4.1.3 ShortPollInterval Attribute
3.16.4.1.4 FastPollTimeout Attribute
3.16.4.1.5 Check-inIntervalMin Attribute
3.16.4.1.6 LongPollIntervalMin Attribute
3.16.4.1.7 FastPollTimeoutMax Attribute
3.16.4.2 Attribute Settings and Battery Life Considerations
3.16.4.3 Commands
3.16.4.4 Check-in Command
3.16.4.4.1 Payload Format
3.16.4.4.2 Effect on Receipt
3.16.5 Client
3.16.5.1 Attributes
3.16.5.2 Commands
3.16.5.3 Check-in Response Command
3.16.5.3.1 Payload Format
3.16.5.3.1.1 Start Fast Polling
3.16.5.3.1.2 Fast Poll Timeout
3.16.5.4 Fast Poll Stop Command
3.16.5.5 Set Long Poll Interval Command
3.16.5.5.1 Payload Format
3.16.5.6 Set Short Poll Interval Command
3.16.5.6.1 Payload Format
3.16.6 Poll Control Cluster Sequence Diagram
3.16.6.1 Guaranteed Consistent Check-In Interval
3.16.6.2 Multiple Poll Control Client
3.16.6.3 Check-in Interval Attribute Changed
3.17 Power Profile
3.17.1 Overview
3.17.1.1 Revision History
3.17.1.2 Classification
3.17.1.3 Cluster Identifiers
3.17.2 References
3.17.3 General Description
3.17.3.1 Dependencies
3.17.4 Server Attributes
3.17.4.1 TotalProfileNum Attribute
3.17.4.2 MultipleScheduling Attribute
3.17.4.3 EnergyFormatting Attribute
3.17.4.4 EnergyRemote Attribute
3.17.4.5 ScheduleMode Attribute
3.17.4.5.1 Schedule Mode Field BitMap
3.17.5 Server Commands Received
3.17.5.1 PowerProfileRequest Command
3.17.5.1.1 Payload Format
3.17.5.1.1.1 Payload Details
3.17.5.1.2 When Generated
3.17.5.1.3 Effect on Receipt
3.17.5.2 PowerProfileStateRequest Command
3.17.5.2.1 Effect on Receipt
3.17.5.3 GetPowerProfilePriceResponse Command
3.17.5.3.1 Payload Format
3.17.5.3.1.1 Payload Details
3.17.5.3.2 When Generated
3.17.5.3.3 Effect on Receipt
3.17.5.4 GetOverallSchedulePriceResponse Command
3.17.5.4.1 Payload Format
3.17.5.4.2 Payload Details
3.17.5.4.3 When Generated
3.17.5.4.4 Effect on Receipt
3.17.5.5 Energy Phases Schedule Notification Command
3.17.5.5.1 Payload Format
3.17.5.5.1.1 Payload Details
3.17.5.5.2 When Generated
3.17.5.5.3 Effect on Receipt
3.17.5.6 EnergyPhasesScheduleResponse Command
3.17.5.6.1 Payload Format
3.17.5.6.1.1 Payload Details
3.17.5.6.2 When Generated
3.17.5.6.3 Effect on Receipt
3.17.5.7 PowerProfileScheduleConstraintsRequest Command
3.17.5.7.1 Payload Format
3.17.5.7.1.1 Payload Details
3.17.5.7.2 When Generated
3.17.5.7.3 Effect on Receipt
3.17.5.8 EnergyPhasesScheduleStateRequest Command
3.17.5.8.1 Payload Format
3.17.5.8.1.1 Payload Details
3.17.5.8.2 When Generated
3.17.5.8.3 Effect on Receipt
3.17.5.9 GetPowerProfilePriceExtendedResponse Command
3.17.5.9.1 Payload Format
3.17.5.9.2 Payload Details
3.17.5.9.3 When Generated
3.17.5.9.4 Effect on Receipt
3.17.6 Server Commands Generated
3.17.6.1 PowerProfileNotification Command
3.17.6.1.1 Payload Format
3.17.6.1.1.1 Payload Details
3.17.6.1.2 When Generated
3.17.6.1.3 Effect on Receipt
3.17.6.2 PowerProfileResponse Command
3.17.6.2.1 Payload Format
3.17.6.2.1.1 Payload Details
3.17.6.2.2 When Generated
3.17.6.2.3 Effect on Receipt
3.17.6.3 PowerProfileStateResponse Command
3.17.6.3.1 Payload Format
3.17.6.3.1.1 Payload Details
3.17.6.3.2 When Generated
3.17.6.3.3 Effect on Receipt
3.17.6.4 GetPowerProfilePrice Command
3.17.6.4.1 Effect on Receipt
3.17.6.5 PowerProfileStateNotification Command
3.17.6.5.1 Effect on Receipt
3.17.6.6 GetOverallSchedulePrice Command
3.17.6.6.1 Effect on Receipt
3.17.6.7 EnergyPhasesScheduleRequest Command
3.17.6.7.1 Effect on Receipt
3.17.6.8 EnergyPhasesScheduleStateResponse Command
3.17.6.8.1 Effect on Receipt
3.17.6.9 EnergyPhasesScheduleStateNotification Command
3.17.6.9.1 Effect on Receipt
3.17.6.10 PowerProfileScheduleConstraintsNotification Command
3.17.6.10.1 Payload Format
3.17.6.10.1.1 Payload Details
3.17.6.10.2 When Generated
3.17.6.10.3 Effect on Receipt
3.17.6.11 PowerProfileScheduleConstraintsResponse Command
3.17.6.11.1 Payload Format
3.17.6.11.2 When Generated
3.17.6.11.3 Effect on Receipt
3.17.6.12 GetPowerProfilePriceExtended Command
3.17.6.12.1 Payload Format
3.17.6.12.2 Effect on Receipt
3.17.7 Client Attributes
3.17.8 Client Commands Received
3.17.9 Client Commands Generated
3.17.10 Example of Device Interactions Using the Power Profile (Informative Section)
3.17.10.1 Price Information Retrieved by the White Goods
3.17.10.2 Interaction with Power Profile Cluster When Appliance Is Not Remotely Controllable
3.17.10.3 Interaction with Power Profile Cluster When Appliance Is Remotely Controllable (Scheduling of Appliance)
3.18 Meter Identification
3.18.1 Overview
3.18.1.1 Revision History
3.18.1.2 Classification
3.18.1.3 Cluster Identifiers
3.18.2 Server
3.18.2.1 Meter Identification Attribute Set
3.18.2.1.1 CompanyName Attribute
3.18.2.1.2 MeterTypeID Attribute
3.18.2.1.3 DataQualityID Attribute
3.18.2.1.4 CustomerName Attribute
3.18.2.1.5 Model Attribute
3.18.2.1.6 PartNumber Attribute
3.18.2.1.7 ProductRevision Attribute
3.18.2.1.8 SoftwareRevision Attribute
3.18.2.1.9 UtilityName Attribute
3.18.2.1.10 POD Attribute
3.18.2.1.11 AvailablePower Attribute
3.18.2.1.12 PowerThreshold Attribute
3.18.2.1.13 Commands Received
3.18.3 Client
3.19 Level Control for Lighting
3.19.1 Overview
3.19.1.1 Revision History
3.19.1.2 Classification
3.19.1.3 Cluster Identifiers
3.19.2 Server
3.19.2.1 Dependencies
3.19.2.2 Attributes
3.19.2.2.1 CurrentLevel Attribute for Lighting
3.19.2.2.2 CurrentFrequency Attribute
3.19.2.2.3 Options Attribute for Lighting
3.19.2.3 Commands Received
3.19.2.4 Commands Generated
3.19.3 Client
3.19.4 State Change Table for Lighting
3.20 Pulse Width Modulation
3.20.1 Overview
3.20.1.1 Revision History
3.20.1.2 Classification
3.20.1.3 Cluster Identifiers
3.20.2 Server
3.20.2.1 Attributes
3.20.2.1.1 CurrentLevel Attribute
3.20.2.1.2 CurrentFrequency Attribute
3.20.2.2 Commands Received
3.20.2.3 Commands Generated
3.20.3 Client
Chapter 4 Measurement and Sensing
4.1 General Description
4.1.1 Introduction
4.1.2 Cluster List
4.1.2.1 Illuminance Measurement and Level Sensing
4.1.2.2 Temperature, Pressure and Flow Measurement
4.1.2.3 Occupancy Sensing
4.1.2.4 Electrical Measurement
4.1.3 Measured Value
4.1.3.1 Range
4.1.3.2 Tolerance
4.2 Illuminance Measurement
4.2.1 Overview
4.2.1.1 Revision History
4.2.1.2 Classification
4.2.1.3 Cluster Identifiers
4.2.2 Server
4.2.2.1 Attributes
4.2.2.1.1 MeasuredValue Attribute
4.2.2.1.2 MinMeasuredValue Attribute
4.2.2.1.3 MaxMeasuredValue Attribute
4.2.2.1.4 Tolerance Attribute
4.2.2.1.5 LightSensorType Attribute
4.2.2.2 Commands
4.2.2.3 Attribute Reporting
4.2.3 Client
4.3 Illuminance Level Sensing
4.3.1 Overview
4.3.1.1 Revision History
4.3.1.2 Classification
4.3.1.3 Cluster Identifiers
4.3.2 Server
4.3.2.1 Attributes
4.3.2.2 Illuminance Level Sensing Information Attribute Set
4.3.2.2.1 LevelStatus Attribute
4.3.2.2.2 LightSensorType Attribute
4.3.2.3 Illuminance Level Sensing Settings Attribute Set
4.3.2.3.1 IlluminanceTargetLevel Attribute
4.3.2.4 Commands Received
4.3.2.5 Commands Generated
4.3.2.6 Attribute Reporting
4.3.3 Client
4.4 Temperature Measurement
4.4.1 Overview
4.4.1.1 Revision History
4.4.1.2 Classification
4.4.1.3 Cluster Identifiers
4.4.2 Server
4.4.2.1 Attributes
4.4.2.1.1 Temperature Measurement Information Attribute Set
4.4.2.1.1.1 MeasuredValue Attribute
4.4.2.1.1.2 MinMeasuredValue Attribute
4.4.2.1.1.3 MaxMeasuredValue Attribute
4.4.2.1.1.4 Tolerance Attribute
4.4.2.2 Commands
4.4.2.3 Attribute Reporting
4.4.3 Client
4.5 Pressure Measurement
4.5.1 Overview
4.5.1.1 Revision History
4.5.1.2 Classification
4.5.1.3 Cluster Identifiers
4.5.2 Server
4.5.2.1 Attributes
4.5.2.1.1 Pressure Measurement Information Attribute Set
4.5.2.1.1.1 MeasuredValue Attribute
4.5.2.1.1.2 MinMeasuredValue Attribute
4.5.2.1.1.3 MaxMeasuredValue Attribute
4.5.2.1.1.4 Tolerance Attribute
4.5.2.1.2 Extended Pressure Measurement Information Attribute Set
4.5.2.1.2.1 ScaledValue Attribute
4.5.2.1.2.2 MinScaledValue Attribute
4.5.2.1.2.3 MaxScaledValue Attribute
4.5.2.1.2.4 ScaledTolerance Attribute
4.5.2.1.2.5 Scale Attribute
4.5.2.2 Commands
4.5.2.3 Attribute Reporting
4.5.3 Client
4.6 Flow Measurement
4.6.1 Overview
4.6.1.1 Revision History
4.6.1.2 Classification
4.6.1.3 Cluster Identifiers
4.6.2 Server
4.6.2.1 Attributes
4.6.2.1.1 Flow Measurement Information Attribute Set
4.6.2.1.1.1 MeasuredValue Attribute
4.6.2.1.1.2 MinMeasuredValue Attribute
4.6.2.1.1.3 MaxMeasuredValue Attribute
4.6.2.1.1.4 Tolerance Attribute
4.6.2.2 Commands
4.6.2.3 Attribute Reporting
4.6.3 Client
4.7 Water Content Measurement
4.7.1 Overview
4.7.1.1 Revision History
4.7.1.2 Classification
4.7.1.3 Cluster Identifiers
4.7.2 Server
4.7.2.1 Attributes
4.7.2.1.1 MeasuredValue Attribute
4.7.2.1.2 MinMeasuredValue Attribute
4.7.2.1.3 MaxMeasuredValue Attribute
4.7.2.1.4 Tolerance Attribute
4.7.2.2 Commands
4.7.3 Client
4.8 Occupancy Sensing
4.8.1 Overview
4.8.1.1 Revision History
4.8.1.2 Classification
4.8.1.3 Cluster Identifiers
4.8.2 Server
4.8.2.1 Attributes
4.8.2.1.1 Occupancy Sensor Information Set
4.8.2.1.1.1 Occupancy Attribute
4.8.2.1.1.2 OccupancySensorType Attribute
4.8.2.1.1.3 OccupancySensorTypeBitmap Attribute
4.8.2.1.2 PIR Configuration Set
4.8.2.1.2.1 PIROccupiedToUnoccupiedDelay Attribute
4.8.2.1.2.2 PIRUnoccupiedToOccupiedDelay Attribute
4.8.2.1.2.3 PIRUnoccupiedToOccupiedThreshold Attribute
4.8.2.1.3 Ultrasonic Configuration Set
4.8.2.1.3.1 UltrasonicOccupiedToUnoccupiedDelay Attribute
4.8.2.1.3.2 UltrasonicUnoccupiedToOccupiedDelay Attribute
4.8.2.1.3.3 UltrasonicUnoccupiedToOccupiedThreshold Attribute
4.8.2.1.4 Physical Contact Configuration Set
4.8.2.1.4.1 PhysicalContactOccupiedToUnoccupiedDelay Attribute
4.8.2.1.4.2 PhysicalContactUnoccupiedToOccupiedDelay Attribute
4.8.2.1.4.3 PhysicalContactUnoccupiedToOccupiedThreshold Attribute
4.8.2.2 Commands
4.8.3 Client
4.9 Electrical Measurement
4.9.1 Overview
4.9.1.1 Revision History
4.9.1.2 Classification
4.9.1.3 Cluster Identifiers
4.9.1.4 Formatting
4.9.2 Server
4.9.2.1 Dependencies
4.9.2.2 Attributes
4.9.2.2.1 Basic Information
4.9.2.2.1.1 MeasurementType
4.9.2.2.2 DC Measurement
4.9.2.2.2.1 DCVoltage
4.9.2.2.2.2 DCVoltageMin
4.9.2.2.2.3 DCVoltageMax
4.9.2.2.2.4 DCCurrent
4.9.2.2.2.5 DCCurrentMin
4.9.2.2.2.6 DCCurrentMax
4.9.2.2.2.7 DCPower
4.9.2.2.2.8 DCPowerMin
4.9.2.2.2.9 DCPowerMax
4.9.2.2.3 DC Formatting
4.9.2.2.3.1 DCVoltageMultiplier
4.9.2.2.3.2 DCVoltageDivisor
4.9.2.2.3.3 DCCurrentMultiplier
4.9.2.2.3.4 DCCurrentDivisor
4.9.2.2.3.5 DCPowerMultiplier
4.9.2.2.3.6 DCPowerDivisor
4.9.2.2.4 AC (Non-phase Specific) Measurements
4.9.2.2.4.1 ACFrequency
4.9.2.2.4.2 ACFrequencyMin
4.9.2.2.4.3 ACFrequencyMax
4.9.2.2.4.4 NeutralCurrent
4.9.2.2.4.5 TotalActivePower
4.9.2.2.4.6 TotalReactivePower
4.9.2.2.4.7 TotalApparentPower
4.9.2.2.4.8 MeasuredNthHarmonicCurrent Attributes
4.9.2.2.4.9 MeasuredPhaseNthHarmonicCurrent Attributes
4.9.2.2.5 AC (Non-phase Specific) Formatting
4.9.2.2.5.1 ACFrequencyMultiplier
4.9.2.2.5.2 ACFrequencyDivisor
4.9.2.2.5.3 PowerMultiplier
4.9.2.2.5.4 PowerDivisor
4.9.2.2.5.5 HarmonicCurrentMultiplier
4.9.2.2.5.6 PhaseHarmonicCurrentMultiplier
4.9.2.2.6 AC (Single Phase or Phase A) Measurements
4.9.2.2.6.1 LineCurrent
4.9.2.2.6.2 ActiveCurrent
4.9.2.2.6.3 ReactiveCurrent
4.9.2.2.6.4 RMSVoltage
4.9.2.2.6.5 RMSVoltageMin
4.9.2.2.6.6 RMSVoltageMax
4.9.2.2.6.7 RMSCurrent
4.9.2.2.6.8 RMSCurrentMin
4.9.2.2.6.9 RMSCurrentMax
4.9.2.2.6.10 ActivePower
4.9.2.2.6.11 ActivePowerMin
4.9.2.2.6.12 ActivePowerMax
4.9.2.2.6.13 ReactivePower
4.9.2.2.6.14 ApparentPower
4.9.2.2.6.15 PowerFactor
4.9.2.2.6.16 AverageRMSVoltageMeasurementPeriod
4.9.2.2.6.17 AverageRMSOverVoltageCounter
4.9.2.2.6.18 AverageRMSUnderVoltageCounter
4.9.2.2.6.19 RMSExtremeOverVoltagePeriod
4.9.2.2.6.20 RMSExtremeUnderVoltagePeriod
4.9.2.2.6.21 RMSVoltageSagPeriod
4.9.2.2.6.22 RMSVoltageSwellPeriod
4.9.2.2.7 AC Formatting
4.9.2.2.7.1 ACVoltageMultiplier
4.9.2.2.7.2 ACVoltageDivisor
4.9.2.2.7.3 ACCurrentMultiplier
4.9.2.2.7.4 ACCurrentDivisor
4.9.2.2.7.5 ACPowerMultiplier
4.9.2.2.7.6 ACPowerDivisor
4.9.2.2.8 DC Manufacturer Threshold Alarms
4.9.2.2.8.1 DCOverloadAlarmsMask
4.9.2.2.8.2 DCVoltageOverload
4.9.2.2.8.3 DCCurrentOverload
4.9.2.2.9 AC Manufacturer Threshold Alarms
4.9.2.2.9.1 ACAlarmsMask
4.9.2.2.9.2 ACVoltageOverload
4.9.2.2.9.3 ACCurrentOverload
4.9.2.2.9.4 ACActivePowerOverload
4.9.2.2.9.5 ACReactivePowerOverload
4.9.2.2.9.6 AverageRMSOverVoltage
4.9.2.2.9.7 AverageRMSUnderVoltage
4.9.2.2.9.8 RMSExtremeOverVoltage
4.9.2.2.9.9 RMSExtremeUnderVoltage
4.9.2.2.9.10 RMSVoltageSag
4.9.2.2.9.11 RMSVoltageSwell
4.9.2.2.10 AC Phase B Measurements
4.9.2.2.10.1 LineCurrentPhB
4.9.2.2.10.2 ActiveCurrentPhB
4.9.2.2.10.3 ReactiveCurrentPhB
4.9.2.2.10.4 RMSVoltagePhB
4.9.2.2.10.5 RMSVoltageMinPhB
4.9.2.2.10.6 RMSVoltageMaxPhB
4.9.2.2.10.7 RMSCurrentPhB
4.9.2.2.10.8 RMSCurrentMinPhB
4.9.2.2.10.9 RMSCurrentMaxPhB
4.9.2.2.10.10 ActivePowerPhB
4.9.2.2.10.11 ActivePowerMinPhB
4.9.2.2.10.12 ActivePowerMaxPhB
4.9.2.2.10.13 ReactivePowerPhB
4.9.2.2.10.14 ApparentPowerPhB
4.9.2.2.10.15 PowerFactorPhB
4.9.2.2.10.16 AverageRMSVoltageMeasurementPeriodPhB
4.9.2.2.10.17 AverageRMSOverVoltageCounterPhB
4.9.2.2.10.18 AverageRMSUnderVoltageCounterPhB
4.9.2.2.10.19 RMSExtremeOverVoltagePeriodPhB
4.9.2.2.10.20 RMSExtremeUnderVoltagePeriodPhB
4.9.2.2.10.21 RMSVoltageSagPeriodPhB
4.9.2.2.10.22 RMSVoltageSwellPeriodPhB
4.9.2.2.11 AC Phase C Measurements
4.9.2.2.11.1 LineCurrentPhC
4.9.2.2.11.2 ActiveCurrentPhC
4.9.2.2.11.3 ReactiveCurrentPhC
4.9.2.2.11.4 RMSVoltagePhC
4.9.2.2.11.5 RMSVoltageMinPhC
4.9.2.2.11.6 RMSVoltageMaxPhC
4.9.2.2.11.7 RMSCurrentPhC
4.9.2.2.11.8 RMSCurrentMinPhC
4.9.2.2.11.9 RMSCurrentMaxPhC
4.9.2.2.11.10 ActivePowerPhC
4.9.2.2.11.11 ActivePowerMinPhC
4.9.2.2.11.12 ActivePowerMaxPhC
4.9.2.2.11.13 ReactivePowerPhC
4.9.2.2.11.14 ApparentPowerPhC
4.9.2.2.11.15 PowerFactorPhC
4.9.2.2.11.16 AverageRMSVoltageMeasurementPeriodPhC
4.9.2.2.11.17 AverageRMSOverVoltageCounterPhC
4.9.2.2.11.18 AverageRMSUnderVoltageCounterPhC
4.9.2.2.11.19 RMSExtremeOverVoltagePeriodPhC
4.9.2.2.11.20 RMSExtremeUnderVoltagePeriodPhC
4.9.2.2.11.21 RMSVoltageSagPeriodPhC
4.9.2.2.11.22 RMSVoltageSwellPeriodPhC
4.9.2.3 Server Commands
4.9.2.3.1 Commands Generated
4.9.2.3.1.1 Get Profile Info Response Command
4.9.2.3.1.2 Payload Details
4.9.2.3.1.3 When Generated
4.9.2.3.1.4 Get Measurement Profile Response Command
4.9.2.3.1.5 Payload Details
4.9.2.3.1.6 When Generated
4.9.2.4 Client Commands
4.9.2.4.1 Commands Generated
4.9.2.4.1.1 Get Profile Info Command
4.9.2.4.1.2 Effect on Receipt
4.9.2.4.1.3 Get Measurement Profile Command
4.9.2.4.1.4 Payload Details
4.9.2.4.1.5 Effect on Receipt
4.10 Electrical Conductivity Measurement
4.10.1 Overview
4.10.1.1 Revision History
4.10.1.2 Classification
4.10.1.3 Cluster Identifiers
4.10.2 Server
4.10.2.1 Attributes
4.10.2.1.1 MeasuredValue Attribute
4.10.2.1.2 MinMeasuredValue Attribute
4.10.2.1.3 MaxMeasuredValue Attribute
4.10.2.1.4 Tolerance Attribute
4.10.2.2 Commands
4.10.3 Client
4.11 pH Measurement
4.11.1 Overview
4.11.1.1 Revision History
4.11.1.2 Classification
4.11.1.3 Cluster Identifiers
4.11.2 Server
4.11.2.1 Attributes
4.11.2.1.1 MeasuredValue Attribute
4.11.2.1.2 MinMeasuredValue Attribute
4.11.2.1.3 MaxMeasuredValue Attribute
4.11.2.1.4 Tolerance Attribute
4.11.2.2 Commands
4.11.3 Client
4.12 Wind Speed Measurement
4.12.1 Overview
4.12.1.1 Revision History
4.12.1.2 Classification
4.12.1.3 Cluster Identifiers
4.12.2 Server
4.12.2.1 Attributes
4.12.2.1.1 MeasuredValue Attribute
4.12.2.1.2 MinMeasuredValue Attribute
4.12.2.1.3 MaxMeasuredValue Attribute
4.12.2.1.4 Tolerance Attribute
4.12.2.2 Commands
4.12.3 Client
4.13 Concentration Measurement
4.13.1 Overview
4.13.1.1 Revision History
4.13.1.2 Classification
4.13.1.3 Cluster Identifiers
4.13.2 Server
4.13.2.1 Attributes
4.13.2.1.1 MeasuredValue Attribute
4.13.2.1.2 MinMeasuredValue Attribute
4.13.2.1.3 MaxMeasuredValue Attribute
4.13.2.1.4 Tolerance Attribute
4.13.2.2 Commands
4.13.3 Client
Chapter 5 Lighting
5.1 General Description
5.1.1 Introduction
5.1.2 Terms
5.1.3 Cluster List
5.2 Color Control Cluster
5.2.1 Overview
5.2.1.1 Revision History
5.2.1.2 Classification
5.2.1.3 Cluster Identifiers
5.2.2 Server
5.2.2.1 Dependencies
5.2.2.1.1 Coupling color temperature to Level Control
5.2.2.2 Attributes
5.2.2.2.1 Color Information Attribute Set
5.2.2.2.1.1 CurrentHue Attribute
5.2.2.2.1.2 CurrentSaturation Attribute
5.2.2.2.1.3 RemainingTime Attribute
5.2.2.2.1.4 CurrentX Attribute
5.2.2.2.1.5 CurrentY Attribute
5.2.2.2.1.6 DriftCompensation Attribute
5.2.2.2.1.7 CompensationText Attribute
5.2.2.2.1.8 ColorTemperatureMireds Attribute
5.2.2.2.1.9 ColorMode Attribute
5.2.2.2.1.10 Options Attribute
5.2.2.2.1.11 EnhancedCurrentHue Attribute
5.2.2.2.1.12 EnhancedColorMode Attribute
5.2.2.2.1.13 ColorLoopActive Attribute
5.2.2.2.1.14 ColorLoopDirection Attribute
5.2.2.2.1.15 ColorLoopTime Attribute
5.2.2.2.1.16 ColorLoopStartEnhancedHue Attribute
5.2.2.2.1.17 ColorLoopStoredEnhancedHue Attribute
5.2.2.2.1.18 ColorCapabilities Attribute
5.2.2.2.1.19 ColorTempPhysicalMinMireds Attribute
5.2.2.2.1.20 ColorTempPhysicalMaxMireds Attribute
5.2.2.2.1.21 CoupleColorTempToLevelMinMireds Attribute
5.2.2.2.1.22 StartUpColorTemperatureMireds Attribute
5.2.2.2.2 Defined Primaries Information Attribute Set
5.2.2.2.2.1 NumberOfPrimaries Attribute
5.2.2.2.2.2 Primary1X Attribute
5.2.2.2.2.3 Primary1Y Attribute
5.2.2.2.2.4 Primary1Intensity Attribute
5.2.2.2.2.5 Remaining Attributes
5.2.2.2.3 Additional Defined Primaries Information Attribute Set
5.2.2.2.3.1 Attributes
5.2.2.2.4 Defined Color Points Settings Attribute Set
5.2.2.2.4.1 WhitePointX Attribute
5.2.2.2.4.2 WhitePointY Attribute
5.2.2.2.4.3 ColorPointRX Attribute
5.2.2.2.4.4 ColorPointRY Attribute
5.2.2.2.4.5 ColorPointRIntensity Attribute
5.2.2.2.4.6 Remaining Attributes
5.2.2.3 Commands Received
5.2.2.3.1 Generic Usage Notes
5.2.2.3.2 Note on Change of ColorMode
5.2.2.3.3 Use of the OptionsMask & OptionsOverride fields
5.2.2.3.4 Move to Hue Command
5.2.2.3.4.1 Payload Format
5.2.2.3.4.2 Hue Field
5.2.2.3.4.3 Direction Field
5.2.2.3.4.4 Transition Time Field
5.2.2.3.4.5 OptionsMask and OptionsOverride fields
5.2.2.3.4.6 Effect on Receipt
5.2.2.3.5 Move Hue Command
5.2.2.3.5.1 Payload Format
5.2.2.3.5.2 Move Mode Field
5.2.2.3.5.3 Rate Field
5.2.2.3.5.4 OptionsMask and OptionsOverride field
5.2.2.3.5.5 Effect on Receipt
5.2.2.3.6 Step Hue Command
5.2.2.3.6.1 Payload Format
5.2.2.3.6.2 Step Mode Field
5.2.2.3.6.3 Step Size Field
5.2.2.3.6.4 Transition Time Field
5.2.2.3.6.5 OptionsMask and OptionsOverride fields
5.2.2.3.6.6 Effect on Receipt
5.2.2.3.7 Move to Saturation Command
5.2.2.3.7.1 Payload Format
5.2.2.3.7.2 OptionsMask and OptionsOverride fields
5.2.2.3.7.3 Effect on Receipt
5.2.2.3.8 Move Saturation Command
5.2.2.3.8.1 Payload Format
5.2.2.3.8.2 Move Mode Field
5.2.2.3.8.3 Rate Field
5.2.2.3.8.4 OptionsMask and OptionsOverride fields
5.2.2.3.8.5 Effect on Receipt
5.2.2.3.9 Step Saturation Command
5.2.2.3.9.1 Payload Format
5.2.2.3.9.2 Step Mode Field
5.2.2.3.9.3 Step Size Field
5.2.2.3.9.4 Transition Time Field
5.2.2.3.9.5 OptionsMask and OptionsOverride fields
5.2.2.3.9.6 Effect on Receipt
5.2.2.3.10 Move to Hue and Saturation Command
5.2.2.3.10.1 Payload Format
5.2.2.3.10.2 OptionsMask and OptionsOverride fields
5.2.2.3.10.3 Effect on Receipt
5.2.2.3.11 Move to Color Command
5.2.2.3.11.1 Payload Format
5.2.2.3.11.2 OptionsMask and OptionsOverride fields
5.2.2.3.11.3 Effect on Receipt
5.2.2.3.12 Move Color Command
5.2.2.3.12.1 Payload Format
5.2.2.3.12.2 RateX Field
5.2.2.3.12.3 RateY Field
5.2.2.3.12.4 OptionsMask and OptionsOverride fields
5.2.2.3.12.5 Effect on Receipt
5.2.2.3.13 Step Color Command
5.2.2.3.13.1 Payload Format
5.2.2.3.13.2 StepX and StepY Fields
5.2.2.3.13.3 Transition Time Field
5.2.2.3.13.4 OptionsMask and OptionsOverride fields
5.2.2.3.13.5 Effect on Receipt
5.2.2.3.14 Move to Color Temperature Command
5.2.2.3.14.1 Payload Format
5.2.2.3.14.2 OptionsMask and OptionsOverride fields
5.2.2.3.14.3 Effect on Receipt
5.2.2.3.15 Enhanced Move to Hue Command
5.2.2.3.15.1 Enhanced Hue Field
5.2.2.3.15.2 Direction Field
5.2.2.3.15.3 Transition Time Field
5.2.2.3.15.4 OptionsMask and OptionsOverride fields
5.2.2.3.15.5 Effect on Receipt
5.2.2.3.16 Enhanced Move Hue Command
5.2.2.3.16.1 Move Mode Field
5.2.2.3.16.2 Rate field
5.2.2.3.16.3 OptionsMask and OptionsOverride fields
5.2.2.3.16.4 Effect on receipt
5.2.2.3.17 Enhanced Step Hue Command
5.2.2.3.17.1 Step Mode Field
5.2.2.3.17.2 Step Size Field
5.2.2.3.17.3 Transition Time Field
5.2.2.3.17.4 OptionsMask and OptionsOverride fields
5.2.2.3.17.5 Effect on Receipt
5.2.2.3.18 Enhanced Move to Hue and Saturation Command
5.2.2.3.18.1 Enhanced Hue Field
5.2.2.3.18.2 Saturation Field
5.2.2.3.18.3 Transition Time Field
5.2.2.3.18.4 OptionsMask and OptionsOverride fields
5.2.2.3.18.5 Effect on Receipt
5.2.2.3.19 Color Loop Set Command
5.2.2.3.19.1 Update Flags Field
5.2.2.3.19.2 Action Field
5.2.2.3.19.3 Direction Field
5.2.2.3.19.4 Time Field
5.2.2.3.19.5 Start Hue Field
5.2.2.3.19.6 OptionsMask and OptionsOverride fields
5.2.2.3.19.7 Effect on Receipt
5.2.2.3.20 Stop Move Step Command
5.2.2.3.20.1 OptionsMask and OptionsOverride fields
5.2.2.3.20.2 Effect on Receipt
5.2.2.3.21 Move Color Temperature Command
5.2.2.3.21.1 Move Mode Field
5.2.2.3.21.2 Rate Field
5.2.2.3.21.3 Color Temperature Minimum Mireds Field
5.2.2.3.21.4 Color Temperature Maximum Mireds Field
5.2.2.3.21.5 OptionsMask and OptionsOverride fields
5.2.2.3.21.6 Effect on Receipt
5.2.2.3.22 Step Color Temperature Command
5.2.2.3.22.1 Step Mode Field
5.2.2.3.22.2 Step Size Field
5.2.2.3.22.3 Transition Time Field
5.2.2.3.22.4 Color Temperature Minimum Mireds Field
5.2.2.3.22.5 Color Temperature Maximum Mireds Field
5.2.2.3.22.6 OptionsMask and OptionsOverride fields
5.2.2.3.22.7 Effect on Receipt
5.2.2.4 Commands Generated
5.2.2.5 Scene Table Extensions
5.2.2.6 Attribute Reporting
5.2.3 Client
5.3 Ballast Configuration Cluster
5.3.1 Overview
5.3.1.1 Revision History
5.3.1.2 Classification
5.3.1.3 Cluster Identifiers
5.3.2 Server
5.3.2.1 Dependencies
5.3.2.2 Attributes
5.3.2.2.1 Ballast Information Attribute Set
5.3.2.2.1.1 PhysicalMinLevel Attribute
5.3.2.2.1.2 PhysicalMaxLevel Attribute
5.3.2.2.1.3 BallastStatus Attribute
5.3.2.2.2 Ballast Settings Attribute Set
5.3.2.2.2.1 MinLevel Attribute
5.3.2.2.2.2 MaxLevel Attribute
5.3.2.2.2.3 IntrinsicBallastFactor Attribute
5.3.2.2.2.4 BallastFactorAdjustment Attribute
5.3.2.2.3 Lamp Information Attribute Set
5.3.2.2.3.1 LampQuantity Attribute
5.3.2.2.4 Lamp Settings Attribute Set
5.3.2.2.4.1 LampType Attribute
5.3.2.2.4.2 LampManufacturer Attribute
5.3.2.2.4.3 LampRatedHours Attribute
5.3.2.2.4.4 LampBurnHours Attribute
5.3.2.2.4.5 LampAlarmMode Attribute
5.3.2.2.4.6 LampBurnHoursTripPoint Attribute
5.3.2.3 Commands
5.3.3 Client
5.3.4 The Dimming Light Curve
Chapter 6 HVAC
6.1 General Description
6.1.1 Introduction
6.1.2 Terms
6.1.3 Cluster List
6.2 Pump Configuration and Control
6.2.1 Overview
6.2.1.1 Revision History
6.2.1.2 Classification
6.2.1.3 Cluster Identifiers
6.2.2 Server
6.2.2.1 Dependencies
6.2.2.2 Attributes
6.2.2.2.1 Pump Information Attribute Set
6.2.2.2.1.1 MaxPressure Attribute
6.2.2.2.1.2 MaxSpeed Attribute
6.2.2.2.1.3 MaxFlow Attribute
6.2.2.2.1.4 MinConstPressure Attribute
6.2.2.2.1.5 MaxConstPressure Attribute
6.2.2.2.1.6 MinCompPressure Attribute
6.2.2.2.1.7 MaxCompPressure Attribute
6.2.2.2.1.8 MinConstSpeed Attribute
6.2.2.2.1.9 MaxConstSpeed Attribute
6.2.2.2.1.10 MinConstFlow Attribute
6.2.2.2.1.11 MaxConstFlow Attribute
6.2.2.2.1.12 MinConstTemp Attribute
6.2.2.2.1.13 MaxConstTemp Attribute
6.2.2.2.2 Pump Dynamic Information Attribute Set
6.2.2.2.2.1 PumpStatus Attribute
6.2.2.2.2.2 EffectiveOperationMode Attribute
6.2.2.2.2.3 EffectiveControlMode Attribute
6.2.2.2.2.4 Capacity Attribute
6.2.2.2.2.5 Speed Attribute
6.2.2.2.2.6 LifetimeRunningHours Attribute
6.2.2.2.2.7 Power Attribute
6.2.2.2.2.8 LifetimeEnergyConsumed Attribute
6.2.2.2.3 Pump Settings Attribute Set
6.2.2.2.3.1 OperationMode Attribute
6.2.2.2.3.2 ControlMode Attribute
6.2.2.2.3.3 AlarmMask Attribute
6.2.2.3 Commands
6.2.2.4 Attribute Reporting
6.2.3 Client
6.3 Thermostat
6.3.1 Overview
6.3.1.1 Revision History
6.3.1.2 Classification
6.3.1.3 Cluster Identifiers
6.3.1.4 Thermostat Temperature Conversion
6.3.1.5 Thermostat Schedule Feature Mandatory Requirement
6.3.2 Server
6.3.2.1 Dependencies
6.3.2.2 Attributes
6.3.2.2.1 Thermostat Information Attribute Set
6.3.2.2.1.1 LocalTemperature Attribute
1.1.1.1.1.1 All setpoint attributes in the Thermostat cluster SHALL be triggered based off the LocalTemperature attribute (i.e., measured temperature and any calibration offset).
6.3.2.2.1.2 OutdoorTemperature Attribute
6.3.2.2.1.3 Occupancy Attribute
6.3.2.2.1.4 AbsMinHeatSetpointLimit Attribute
6.3.2.2.1.5 AbsMaxHeatSetpointLimit Attribute
6.3.2.2.1.6 AbsMinCoolSetpointLimit Attribute
6.3.2.2.1.7 AbsMaxCoolSetpointLimit Attribute
6.3.2.2.1.8 PICoolingDemand Attribute
6.3.2.2.1.9 PIHeatingDemand Attribute
6.3.2.2.1.10 HVACSystemTypeConfiguration Attribute
6.3.2.2.2 Thermostat Settings Attribute Set
6.3.2.2.2.1 LocalTemperatureCalibration Attribute
6.3.2.2.2.2 OccupiedCoolingSetpoint Attribute
6.3.2.2.2.3 OccupiedHeatingSetpoint Attribute
6.3.2.2.2.4 UnoccupiedCoolingSetpoint Attribute
6.3.2.2.2.5 UnoccupiedHeatingSetpoint Attribute
6.3.2.2.2.6 MinHeatSetpointLimit Attribute
6.3.2.2.2.7 MaxHeatSetpointLimit Attribute
6.3.2.2.2.8 MinCoolSetpointLimit Attribute
6.3.2.2.2.9 MaxCoolSetpointLimit Attribute
6.3.2.2.2.10 MinSetpointDeadBand Attribute
6.3.2.2.2.11 RemoteSensing Attribute
6.3.2.2.2.12 ControlSequenceOfOperation Attribute
6.3.2.2.2.13 SystemMode Attribute
6.3.2.2.2.14 AlarmMask Attribute
6.3.2.2.2.15 Thermostat Running Mode Attribute
6.3.2.2.3 Thermostat Schedule & HVAC Relay Attribute Set
6.3.2.2.3.1 StartOfWeek Attribute
6.3.2.2.3.2 NumberOfWeeklyTransitions Attribute
6.3.2.2.3.3 NumberOfDailyTransitions Attribute
6.3.2.2.3.4 TemperatureSetpointHold Attribute
6.3.2.2.3.5 TemperatureSetpointHoldDuration Attribute
6.3.2.2.3.6 ThermostatProgrammingOperationMode Attribute
6.3.2.2.3.7 ThermostatRunningState Attribute
6.3.2.2.4 Thermostat Setpoint ChangeTracking Attribute Set
6.3.2.2.4.1 SetpointChangeSource Attribute
6.3.2.2.4.2 SetpointChangeAmount Attribute
6.3.2.2.4.3 SetpointChangeSourceTimestamp Attribute
6.3.2.2.4.4 OccupiedSetback Attribute
6.3.2.2.4.5 OccupiedSetbackMin Attribute
6.3.2.2.4.6 OccupiedSetbackMax Attribute
6.3.2.2.4.7 UnoccupiedSetback Attribute
6.3.2.2.4.8 UnoccupiedSetbackMin Attribute
6.3.2.2.4.9 UnoccupiedSetbackMax Attribute
6.3.2.2.4.10 EmergencyHeatDelta Attribute
6.3.2.2.5 AC Information Attribute Set
6.3.2.2.5.1 ACType Attribute
6.3.2.2.5.2 ACCapacity Attribute
6.3.2.2.5.3 ACRefrigerantType Attribute
6.3.2.2.5.4 ACCompressorType Attribute
6.3.2.2.5.5 ACErrorCode Attribute
6.3.2.2.5.6 ACLouverPosition Attribute
6.3.2.2.5.7 ACCoilTemperature Attribute
6.3.2.2.5.8 ACCapacityFormat Attribute
6.3.2.3 Server Commands Received
6.3.2.3.1 Setpoint Raise/Lower Command
6.3.2.3.1.1 Payload Format
6.3.2.3.1.2 Mode Field
6.3.2.3.1.3 Amount Field
6.3.2.3.1.4 Effect on Receipt
6.3.2.3.2 Set Weekly Schedule Command
6.3.2.3.2.1 Payload Format
6.3.2.3.2.2 Number of Transitions for Sequence
6.3.2.3.2.3 Day of Week for Sequence
6.3.2.3.2.4 Mode for Sequence
6.3.2.3.2.5 Transition Time Field
6.3.2.3.2.6 Heat Set Point Field
6.3.2.3.2.7 Cool Set Point Field
6.3.2.3.2.8 Effect on Receipt
6.3.2.3.3 Get Weekly Schedule
6.3.2.3.3.1 Days To Return
6.3.2.3.3.2 Mode To Return
6.3.2.3.3.3 Effect on Receipt
6.3.2.3.4 Clear Weekly Schedule
6.3.2.3.4.1 Effect on Receipt
6.3.2.3.5 Get Relay Status Log
6.3.2.3.5.1 Effect on Receipt
6.3.2.4 Server Commands Sent
6.3.2.4.1 Get Weekly Schedule Response
6.3.2.4.2 Get Relay Status Log Response
6.3.2.4.2.1 Payload Format
6.3.2.4.2.2 Time of Day Field
6.3.2.4.2.3 Relay Status Field
6.3.2.4.2.4 Local Temperature Field
6.3.2.4.2.5 Humidity Field
6.3.2.4.2.6 Setpoint Field
6.3.2.4.2.7 Unread Entries Field
6.3.2.5 Attribute Reporting
6.3.2.6 Scene Table Extensions
6.3.3 Client
6.4 Fan Control
6.4.1 Overview
6.4.1.1 Revision History
6.4.1.2 Classification
6.4.1.3 Cluster Identifiers
6.4.2 Server
6.4.2.1 Attributes
6.4.2.1.1 FanMode Attribute
6.4.2.1.2 FanModeSequence Attribute
6.4.2.2 Commands
6.4.3 Client
6.5 Dehumidification Control
6.5.1 Overview
6.5.1.1 Revision History
6.5.1.2 Classification
6.5.1.3 Cluster Identifiers
6.5.2 Server
6.5.2.1 Attributes
6.5.2.1.1 Dehumidification Information Attribute Set
6.5.2.1.1.1 RelativeHumidity Attribute
6.5.2.1.1.2 DehumidificationCooling Attribute
6.5.2.1.2 Dehumidification Settings Attribute Set
6.5.2.1.2.1 RHDehumidificationSetpoint Attribute
6.5.2.1.2.2 RelativeHumidityMode Attribute
6.5.2.1.2.3 DehumidificationLockout Attribute
6.5.2.1.2.4 DehumidificationHysteresis Attribute
6.5.2.1.2.5 DehumidificationMaxCool Attribute
6.5.2.1.2.6 RelativeHumidityDisplay Attribute
6.5.2.2 Commands
6.5.2.3 Attribute Reporting
6.5.3 Client
6.6 Thermostat User Interface Configuration
6.6.1 Overview
6.6.1.1 Revision History
6.6.1.2 Classification
6.6.1.3 Cluster Identifiers
6.6.2 Server
6.6.2.1 Attributes
6.6.2.1.1 TemperatureDisplayMode Attribute
6.6.2.1.2 KeypadLockout Attribute
6.6.2.1.3 ScheduleProgrammingVisibility Attribute
6.6.2.2 Commands
6.6.2.3 Sample Conversion Code
6.6.3 Client
Chapter 7 Closures
7.1 General Description
7.1.1 Introduction
7.1.2 Cluster List
7.2 Shade Configuration
7.2.1 Overview
7.2.1.1 Revision History
7.2.1.2 Classification
7.2.1.3 Cluster Identifiers
7.2.2 Server
7.2.2.1 Attributes
7.2.2.1.1 Shade Information Attribute Set
7.2.2.1.1.1 PhysicalClosedLimit Attribute
7.2.2.1.1.2 MotorStepSize Attribute
7.2.2.1.1.3 Status Attribute
7.2.2.1.2 Shade Settings Attribute Set
7.2.2.1.2.1 ClosedLimit Attribute
7.2.2.1.2.2 Mode Attribute
7.2.2.2 Commands
7.2.3 Client
7.3 Door Lock
7.3.1 Overview
7.3.1.1 Revision History
7.3.1.2 Classification
7.3.1.3 Cluster Identifiers
7.3.2 Server
7.3.2.1 Alarms, Reports, and Events
7.3.2.1.1 Alarms
7.3.2.1.2 Reports
7.3.2.1.3 Events
7.3.2.2 Door Lock Security
7.3.2.3 Time
7.3.2.4 PIN/RFID Code Format
7.3.2.5 Process for Creating a New User with Schedule
7.3.2.6 Process for Clearing All Schedules for a User
7.3.2.7 Clarification of Changing the User Type
7.3.2.8 Clarification for Changing the User Code
7.3.2.9 Server Attributes
7.3.2.10 Basic Information Attribute Set
7.3.2.10.1 LockState Attribute
7.3.2.10.2 LockType Attribute
7.3.2.10.3 ActuatorEnabled Attribute
7.3.2.10.4 DoorState Attribute
7.3.2.10.5 DoorOpenEvents Attribute
7.3.2.10.6 DoorClosedEvents Attribute
7.3.2.10.7 OpenPeriod Attribute
7.3.2.11 User, PIN, Schedule, Log Information Attribute Set
7.3.2.11.1 NumberOfLogRecordsSupported Attribute
7.3.2.11.2 NumberOfTotalUsersSupported Attribute
7.3.2.11.3 NumberOfPINUsersSupported Attribute
7.3.2.11.4 NumberOfRFIDUsersSupported Attribute
7.3.2.11.5 NumberOfWeekDaySchedulesSupportedPerUser Attribute
7.3.2.11.6 NumberOfYearDaySchedulesSupportedPerUser Attribute
7.3.2.11.7 NumberOfHolidaySchedulesSupported Attribute
7.3.2.11.8 MaxPINCodeLength Attribute
7.3.2.11.9 MinPINCodeLength Attribute
7.3.2.11.10 MaxRFIDCodeLength Attribute
7.3.2.11.11 MinRFIDCodeLength Attribute
7.3.2.12 Operational Settings Attribute Set
7.3.2.12.1 EnableLogging Attribute
7.3.2.12.2 Language Attribute
7.3.2.12.3 OperatingMode Attribute
7.3.2.12.4 SupportedOperatingModes Attribute
7.3.2.12.5 LEDSettings Attribute
7.3.2.12.6 AutoRelockTime Attribute
7.3.2.12.7 SoundVolume Attribute
7.3.2.12.8 DefaultConfigurationRegister Attribute
7.3.2.12.9 EnableLocalProgramming Attribute
7.3.2.12.10 EnableOneTouchLocking Attribute
7.3.2.12.11 EnableInsideStatusLED Attribute
7.3.2.12.12 EnablePrivacyModeButton Attribute
7.3.2.13 Security Settings Attribute Set
7.3.2.13.1 WrongCodeEntryLimit Attribute
7.3.2.13.2 UserCodeTemporaryDisableTime Attribute
7.3.2.13.3 SendPINOverTheAir Attribute
7.3.2.13.4 RequirePINForRFOperation Attribute
7.3.2.13.5 SecurityLevel Attribute
7.3.2.14 Alarm and Event Masks Attribute Set
7.3.2.14.1 AlarmMask Attribute
7.3.2.14.2 KeypadOperationEventMask Attribute
7.3.2.14.3 RFOperationEventMask Attribute
7.3.2.14.4 ManualOperationEventMask Attribute
7.3.2.14.5 RFIDOperationEventMask Attribute
7.3.2.14.6 KeypadProgrammingEventMask Attribute
7.3.2.14.7 RFProgrammingEventMask Attribute
7.3.2.14.8 RFIDProgrammingEventMask Attribute
7.3.2.15 Server Commands Received
7.3.2.15.1 Lock Door Command
7.3.2.15.2 Unlock Door Command
7.3.2.15.3 Toggle Command
7.3.2.15.4 Unlock with Timeout Command
7.3.2.15.5 Get Log Record Command
7.3.2.15.6 User Status and User Type Values
7.3.2.15.7 Set PIN Code Command
7.3.2.15.8 Get PIN Code Command
7.3.2.15.9 Clear PIN Code Command
7.3.2.15.10 Clear All PIN Codes Command
7.3.2.15.11 Set User Status Command
7.3.2.15.12 Get User Status Command
7.3.2.15.13 Set Week Day Schedule Command
7.3.2.15.14 Get Week Day Schedule Command
7.3.2.15.15 Clear Week Day Schedule Command
7.3.2.15.16 Set Year Day Schedule Command
7.3.2.15.17 Get Year Day Schedule Command
7.3.2.15.18 Clear Year Day Schedule Command
7.3.2.15.19 Set Holiday Schedule Command
7.3.2.15.20 Get Holiday Schedule Command
7.3.2.15.21 Clear Holiday Schedule Command
7.3.2.15.22 Set User Type Command
7.3.2.15.23 Get User Type Command
7.3.2.15.24 Set RFID Code Command
7.3.2.15.25 Get RFID Code Command
7.3.2.15.26 Clear RFID Code Command
7.3.2.15.27 Clear All RFID Codes Command
7.3.2.16 Server Commands Generated
7.3.2.16.1 Lock Door Response Command
7.3.2.16.2 Unlock Door Response Command
7.3.2.16.3 Toggle Response Command
7.3.2.16.4 Unlock with Timeout Response Command
7.3.2.16.5 Get Log Record Response Command
7.3.2.16.6 Set PIN Code Response Command
7.3.2.16.7 Get PIN Code Response Command
7.3.2.16.8 Clear PIN Code Response Command
7.3.2.16.9 Clear All PIN Codes Response Command
7.3.2.16.10 Set User Status Response Command
7.3.2.16.11 Get User Status Response Command
7.3.2.16.12 Set Week Day Schedule Response Command
7.3.2.16.13 Get Week Day Schedule Response Command
7.3.2.16.13.1 Schedule ID Field
7.3.2.16.13.2 User ID Field
7.3.2.16.13.3 Status
7.3.2.16.13.4 Days Mask
7.3.2.16.13.5 Start Hour
7.3.2.16.13.6 Start Minute
7.3.2.16.13.7 End Hour
7.3.2.16.13.8 End Minute
7.3.2.16.14 Clear Week Day Schedule ID Response Command
7.3.2.16.15 Set Year Day Schedule Response Command
7.3.2.16.16 Get Year Day Schedule Response Command
7.3.2.16.16.1 Schedule ID Field
7.3.2.16.16.2 User ID Field
7.3.2.16.16.3 Status
7.3.2.16.16.4 Local Start Time
7.3.2.16.16.5 Local End Time
7.3.2.16.17 Clear Year Day Schedule Response Command
7.3.2.16.18 Set Holiday Schedule Response Command
7.3.2.16.19 Get Holiday Schedule Response Command
7.3.2.16.19.1 Holiday Schedule ID
7.3.2.16.19.2 Status
7.3.2.16.19.3 Local Start Time
7.3.2.16.19.4 Local End Time
7.3.2.16.19.5 Operating Mode
7.3.2.16.20 Clear Holiday Schedule Response Command
7.3.2.16.21 Set User Type Response Command
7.3.2.16.22 Get User Type Response Command
7.3.2.16.23 Set RFID Code Response Command
7.3.2.16.24 Get RFID Code Response Command
7.3.2.16.25 Clear RFID Code Response Command
7.3.2.16.26 Clear All RFID Codes Response Command
7.3.2.16.27 Operation Event Notification Command
7.3.2.16.27.1 Operation Event Sources
7.3.2.16.27.2 Operation Event Codes
7.3.2.16.27.3 User ID
7.3.2.16.27.4 PIN
7.3.2.16.27.5 LocalTime
7.3.2.16.27.6 Data
7.3.2.16.27.7 Keypad Operation Event Notification
7.3.2.16.27.8 RF Operation Event Notification
7.3.2.16.27.9 Manual Operation Event Notification
7.3.2.16.27.10 RFID Operation Event Notification
7.3.2.16.28 Programming Event Notification Command
7.3.2.16.28.1 Operation Event Sources
7.3.2.16.28.2 Programming Event Codes
7.3.2.16.28.3 User ID
7.3.2.16.28.4 PIN
7.3.2.16.28.5 User Type
7.3.2.16.28.6 User Status
7.3.2.16.28.7 LocalTime
7.3.2.16.28.8 Data
7.3.2.16.28.9 Keypad Programming Event Notification
7.3.2.16.28.10 RF Programming Event Notification
7.3.2.16.28.11 RFID Programming Event Notification
7.3.2.17 Scene Table Extension
7.3.3 Client
7.4 Window Covering
7.4.1 Overview
7.4.1.1 Revision History
7.4.1.2 Classification
7.4.1.3 Cluster Identifiers
7.4.2 Server
7.4.2.1 Attributes
7.4.2.1.1 Window Covering Information Attribute Set
7.4.2.1.2 WindowCoveringType Attribute
7.4.2.1.2.1 PhysicalClosedLimit - Lift Attribute
7.4.2.1.2.2 PhysicalClosedLimit - Tilt Attribute
7.4.2.1.2.3 CurrentPosition - Lift Attribute
7.4.2.1.2.4 Current Position - Tilt Attribute
7.4.2.1.2.5 Number of Actuations - Lift Attribute
7.4.2.1.2.6 Number of Actuations - Tilt Attribute
7.4.2.1.2.7 Config/Status Attribute
7.4.2.1.2.8 Current Position Lift Percentage Attribute
7.4.2.1.2.9 Current Position Tilt Percentage Attribute
7.4.2.1.3 Window Covering Settings Attribute Set
7.4.2.1.3.1 InstalledOpenLimit – Lift
7.4.2.1.3.2 InstalledClosedLimit – Lift
7.4.2.1.3.3 InstalledOpenLimit – Tilt
7.4.2.1.3.4 InstalledClosedLimit – Tilt
7.4.2.1.3.5 Velocity – Lift
7.4.2.1.3.6 Acceleration Time – Lift
7.4.2.1.3.7 Deceleration Time – Lift
7.4.2.1.3.8 Mode
7.4.2.1.3.9 Intermediate Setpoints – Lift
7.4.2.1.3.10 Intermediate Setpoints – Tilt
7.4.2.2 Commands Received
7.4.2.2.1 Up / Open Command
7.4.2.2.1.1 Payload Format
7.4.2.2.1.2 Effect on Receipt
7.4.2.2.2 Down / Close Command
7.4.2.2.2.1 Payload Format
7.4.2.2.2.2 Effect on Receipt
7.4.2.2.3 Stop Command
7.4.2.2.3.1 Payload Format
7.4.2.2.3.2 Effect on Receipt
7.4.2.2.4 Go To Lift Value
7.4.2.2.4.1 Payload Format
7.4.2.2.4.2 Effect on Receipt
7.4.2.2.5 Go to Lift Percentage
7.4.2.2.5.1 Payload Format
7.4.2.2.5.2 Effect on Receipt
7.4.2.2.6 Go to Tilt Value
7.4.2.2.6.1 Payload Format
7.4.2.2.6.2 Effect on Receipt
7.4.2.2.7 Go to Tilt Percentage
7.4.2.2.7.1 Payload Format
7.4.2.2.7.2 Effect on Receipt
7.4.2.3 Commands Generated
7.4.2.4 Scene Table Extensions
7.4.2.5 Attribute Reporting
7.4.3 Client
Chapter 8 Security and Safety
8.1 General Description
8.1.1 Introduction
8.1.2 Cluster List
8.2 IAS Zone
8.2.1 Overview
8.2.1.1 Revision History
8.2.1.2 Classification
8.2.1.3 Cluster Identifiers
8.2.2 Server
8.2.2.1 Attributes
8.2.2.1.1 Zone Information Attribute Set
8.2.2.1.1.1 ZoneState Attribute
8.2.2.1.1.2 ZoneType Attribute
8.2.2.1.1.3 ZoneStatus Attribute
8.2.2.1.1.3.1 Supervision Notify
8.2.2.1.1.3.2 Restore Notify
8.2.2.1.2 Zone Settings Attribute Set
8.2.2.1.2.1 IAS_CIE_Address Attribute
8.2.2.1.2.2 ZoneID Attribute
8.2.2.1.2.3 NumberOfZoneSensitivityLevelsSupported Attribute
8.2.2.1.2.4 CurrentZoneSensitivityLevel Attribute
8.2.2.1.3 Implementation Guidelines
8.2.2.2 Commands Received
8.2.2.2.1 Zone Enroll Response Command
8.2.2.2.1.1 Payload Format
8.2.2.2.1.2 Effect on Receipt
8.2.2.2.2 Initiate Normal Operation Mode Command
8.2.2.2.2.1 Payload Format
8.2.2.2.2.2 Effect on Receipt
8.2.2.2.2.3 Initiate Test Mode Command
8.2.2.2.2.4 Payload Format
8.2.2.2.2.5 Test Mode Duration Field
8.2.2.2.2.6 Current Zone Sensitivity Level Field
8.2.2.2.2.7 Effect on Receipt
8.2.2.3 Commands Generated
8.2.2.3.1 Zone Status Change Notification Command
8.2.2.3.1.1 Payload Format
8.2.2.3.1.2 Zone Status Parameter
8.2.2.3.1.3 Extended Status Parameter
8.2.2.3.1.4 Zone ID Parameter
8.2.2.3.1.5 Delay Parameter
8.2.2.3.1.6 When Generated
8.2.2.3.2 Zone Enroll Request Command
8.2.2.3.2.1 Payload Format
8.2.2.3.2.2 When Generated
8.2.3 Client
8.3 IAS ACE
8.3.1 Overview
8.3.1.1 Revision History
8.3.1.2 Classification
8.3.1.3 Cluster Identifiers
8.3.2 Server
8.3.2.1 Attributes
8.3.2.2 Zone Table
8.3.2.3 Commands Received
8.3.2.3.1 Arm Command
8.3.2.3.1.1 Payload Format
8.3.2.3.1.2 Arm Mode Field
8.3.2.3.1.3 Arm/Disarm Code Field
8.3.2.3.1.4 Zone ID Field
8.3.2.3.1.5 Effect on Receipt
8.3.2.3.2 Bypass Command
8.3.2.3.2.1 Payload Format
8.3.2.3.2.2 Number of Zones Field
8.3.2.3.2.3 Zone ID Field
8.3.2.3.2.4 Arm/Disarm Code Field
8.3.2.3.2.5 Effect of Receipt
8.3.2.3.3 Emergency, Fire and Panic Commands
8.3.2.3.4 Get Zone ID Map Command
8.3.2.3.4.1 Payload Format
8.3.2.3.4.2 Effect on Receipt
8.3.2.3.5 Get Zone Information Command
8.3.2.3.5.1 Payload Format
8.3.2.3.5.2 Effect on Receipt
8.3.2.3.6 Get Panel Status Command
8.3.2.3.6.1 Payload Format
8.3.2.3.6.2 Effect on Receipt
8.3.2.3.7 Get Bypassed Zone List Command
8.3.2.3.7.1 Payload Format
8.3.2.3.7.2 Effect on Receipt
8.3.2.3.8 Get Zone Status Command
8.3.2.3.8.1 Payload Format
8.3.2.3.8.2 Starting Zone ID Field
8.3.2.3.8.3 Max Number of Zone IDs Requested Field
8.3.2.3.8.4 Zone Status Mask Flag Field
8.3.2.3.8.5 Zone Status Mask Field
8.3.2.3.8.6 Effect on Receipt
8.3.2.4 Commands Generated
8.3.2.4.1 Arm Response Command
8.3.2.4.1.1 Payload Format
8.3.2.4.1.2 Arm Notification Field
8.3.2.4.2 Get Zone ID Map Response Command
8.3.2.4.2.1 Payload Format
8.3.2.4.3 Get Zone Information Response Command
8.3.2.4.3.1 Payload Format
8.3.2.4.3.2 Zone Label Field
8.3.2.4.4 Zone Status Changed Command
8.3.2.4.4.1 Payload Format
8.3.2.4.4.2 Zone ID Field
8.3.2.4.4.3 Zone Status Field
8.3.2.4.4.4 Audible Notification Field
8.3.2.4.4.5 Zone Label Field
8.3.2.4.5 Panel Status Changed Command
8.3.2.4.5.1 Payload Format
8.3.2.4.5.2 PanelStatus Parameter
8.3.2.4.5.3 Audible Notification Field
8.3.2.4.5.4 Alarm Status Field
8.3.2.4.5.5 Seconds Remaining Parameter
8.3.2.4.6 Get Panel Status Response Command
8.3.2.4.6.1 Payload Format
8.3.2.4.6.2 Panel Status Field
8.3.2.4.6.3 Seconds Remaining Field
8.3.2.4.6.4 Audible Notification Field
8.3.2.4.6.5 Alarm Status Field
8.3.2.4.7 Set Bypassed Zone List Command
8.3.2.4.7.1 Payload Format
8.3.2.4.7.2 Number of Zones Field
8.3.2.4.7.3 Zone ID 1...X Field
8.3.2.4.7.4 Implementation Guidelines
8.3.2.4.8 Bypass Response Command
8.3.2.4.8.1 Payload Format
8.3.2.4.8.2 Number of Zones Field
8.3.2.4.8.3 Bypass Result Field
8.3.2.4.9 Get Zone Status Response Command
8.3.2.4.9.1 Payload Format
8.3.2.4.9.2 Zone Status Complete Field
8.3.2.4.9.3 Number of Zones Field
8.3.2.4.9.4 Zone ID Field
8.3.2.4.9.5 Zone Status Field
8.3.3 Client
8.4 IAS WD
8.4.1 Overview
8.4.1.1 Revision History
8.4.1.2 Classification
8.4.1.3 Cluster Identifiers
8.4.2 Server
8.4.2.1 Attributes
8.4.2.1.1 MaxDuration Attribute
8.4.2.2 Commands Received
8.4.2.2.1 Start Warning Command
8.4.2.2.1.1 Payload Format
8.4.2.2.1.2 Warning Mode Field
8.4.2.2.1.3 Strobe Field
8.4.2.2.1.4 Siren Level Field
1.1.1.1.1.1
8.4.2.2.1.5 Warning Duration Field
8.4.2.2.1.6 Strobe Duty Cycle Field
8.4.2.2.1.7 Strobe Level Field
8.4.2.2.2 Squawk Command
8.4.2.2.2.1 Payload Format
8.4.2.2.2.2 Squawk Mode Field
8.4.2.2.2.3 Strobe Field
8.4.2.2.2.4 Squawk Level Field
8.4.2.3 Commands Generated
8.4.3 Client
Chapter 9 Protocol Interfaces
9.1 General Description
9.1.1 Introduction
9.1.2 Cluster List
9.2 Generic Tunnel
9.2.1 Overview
9.2.1.1 Revision History
9.2.1.2 Classification
9.2.1.3 Cluster Identifiers
9.2.2 Server
9.2.2.1 Dependencies
9.2.2.2 Attributes
9.2.2.2.1 MaximumIncomingTransferSize Attribute
9.2.2.2.2 MaximumOutgoingTransferSize Attribute
9.2.2.2.3 ProtocolAddress Attribute
9.2.2.3 Commands Received
9.2.2.3.1 Match Protocol Address Command
9.2.2.3.2 When Generated
9.2.2.3.3 Effect on Receipt
9.2.2.4 Commands Generated
9.2.2.4.1 Match Protocol Address Response Command
9.2.2.4.2 When Generated
9.2.2.4.3 Advertise Protocol Address Command
9.2.2.4.4 When Generated
9.2.3 Client
9.3 BACnet Protocol Tunnel
9.3.1 Overview
9.3.1.1 Revision History
9.3.1.2 Classification
9.3.1.3 Cluster Identifiers
9.3.2 Server
9.3.2.1 Dependencies
9.3.2.2 Attributes
9.3.2.3 Commands Received
9.3.2.3.1 Transfer NPDU Command
9.3.2.3.1.1 Payload Format
9.3.2.3.1.2 NPDU Field
9.3.2.3.1.3 When Generated
9.3.2.3.1.4 Effect on Receipt
9.3.2.4 Commands Generated
9.3.3 Client
9.4 BACnet Input, Output and Value Clusters
9.4.1 Overview
9.4.2 Analog Input (BACnet Regular)
9.4.2.1 Revision History
9.4.2.2 Classification
9.4.2.3 Cluster Identifiers
9.4.2.4 Server
9.4.2.4.1 Dependencies
9.4.2.4.2 Attributes
9.4.2.4.3 Commands
9.4.2.4.4 Attribute Reporting
9.4.2.5 Client
9.4.3 Analog Input (BACnet Extended)
9.4.3.1 Revision History
9.4.3.2 Classification
9.4.3.3 Cluster Identifiers
9.4.3.4 Server
9.4.3.4.1 Dependencies
9.4.3.4.2 Attributes
9.4.3.4.3 Commands
9.4.3.5 Client
9.4.4 Analog Output (BACnet Regular)
9.4.4.1 Revision History
9.4.4.2 Classification
9.4.4.3 Cluster Identifiers
9.4.4.4 Server
9.4.4.4.1 Dependencies
9.4.4.4.2 Attributes
9.4.4.4.3 Commands
9.4.4.4.4 Attribute Reporting
9.4.4.5 Client
9.4.5 Analog Output (BACnet Extended)
9.4.5.1 Revision History
9.4.5.2 Classification
9.4.5.3 Cluster Identifiers
9.4.5.4 Server
9.4.5.4.1 Dependencies
9.4.5.4.2 Attributes
9.4.5.4.3 Commands
9.4.5.4.4 Attribute Reporting
9.4.5.5 Client
9.4.6 Analog Value (BACnet Regular)
9.4.6.1 Revision History
9.4.6.2 Classification
9.4.6.3 Cluster Identifiers
9.4.6.4 Server
9.4.6.4.1 Dependencies
9.4.6.4.2 Attributes
9.4.6.4.3 Commands
9.4.6.5 Client
9.4.7 Analog Value (BACnet Extended)
9.4.7.1 Revision History
9.4.7.2 Classification
9.4.7.3 Cluster Identifiers
9.4.7.4 Server
9.4.7.4.1 Dependencies
9.4.7.4.2 Attributes
9.4.7.4.3 Commands
9.4.7.5 Client
9.4.8 Binary Input (BACnet Regular)
9.4.8.1 Revision History
9.4.8.2 Classification
9.4.8.3 Cluster Identifiers
9.4.8.4 Server
9.4.8.4.1 Dependencies
9.4.8.4.2 Attributes
9.4.8.4.3 Commands
9.4.8.5 Client
9.4.9 Binary Input (BACnet Extended)
9.4.9.1 Revision History
9.4.9.2 Classification
9.4.9.3 Cluster Identifiers
9.4.9.4 Server
9.4.9.4.1 Dependencies
9.4.9.4.2 Attributes
9.4.9.4.3 Commands
9.4.9.5 Client
9.4.10 Binary Output (BACnet Regular)
9.4.10.1 Revision History
9.4.10.2 Classification
9.4.10.3 Cluster Identifiers
9.4.10.4 Server
9.4.10.4.1 Dependencies
9.4.10.4.2 Attributes
9.4.10.4.3 Commands
9.4.10.4.4 Attribute Reporting
9.4.10.5 Client
9.4.11 Binary Output (BACnet Extended)
9.4.11.1 Revision History
9.4.11.2 Classification
9.4.11.3 Cluster Identifiers
9.4.11.4 Server
9.4.11.4.1 Dependencies
9.4.11.4.2 Attributes
9.4.11.4.3 Commands
9.4.11.5 Client
9.4.12 Binary Value (BACnet Regular)
9.4.12.1 Revision History
9.4.12.2 Classification
9.4.12.3 Cluster Identifiers
9.4.12.4 Server
9.4.12.4.1 Dependencies
9.4.12.4.2 Attributes
9.4.12.4.3 Commands
9.4.12.4.4 Attribute Reporting
9.4.12.5 Client
9.4.13 Binary Value (BACnet Extended)
9.4.13.1 Revision History
9.4.13.2 Classification
9.4.13.3 Cluster Identifiers
9.4.13.4 Server
9.4.13.4.1 Dependencies
9.4.13.4.2 Attributes
9.4.13.4.3 Commands
9.4.13.5 Client
9.4.14 Multistate Input (BACnet Regular)
9.4.14.1 Revision History
9.4.14.2 Classification
9.4.14.3 Cluster Identifiers
9.4.14.4 Server
9.4.14.4.1 Dependencies
9.4.14.4.2 Attributes
9.4.14.4.3 Commands
9.4.14.5 Client
9.4.15 Multistate Input (BACnet Extended)
9.4.15.1 Revision History
9.4.15.2 Classification
9.4.15.3 Cluster Identifiers
9.4.15.4 Server
9.4.15.4.1 Dependencies
9.4.15.4.2 Attributes
9.4.15.4.3 Commands
9.4.15.4.4 Attribute Reporting
9.4.15.5 Client
9.4.16 Multistate Output (BACnet Regular)
9.4.16.1 Revision History
9.4.16.2 Classification
9.4.16.3 Cluster Identifiers
9.4.16.4 Server
9.4.16.4.1 Dependencies
9.4.16.4.2 Attributes
9.4.16.4.3 Commands
9.4.16.5 Client
9.4.17 Multistate Output (BACnet Extended)
9.4.17.1 Revision History
9.4.17.2 Classification
9.4.17.3 Cluster Identifiers
9.4.17.4 Server
9.4.17.4.1 Dependencies
9.4.17.4.2 Attributes
9.4.17.4.3 Commands
9.4.17.4.4 Attribute Reporting
9.4.17.5 Client
9.4.18 Multistate Value (BACnet Regular)
9.4.18.1 Revision History
9.4.18.2 Classification
9.4.18.3 Cluster Identifiers
9.4.18.4 Server
9.4.18.4.1 Dependencies
9.4.18.4.2 Attributes
9.4.18.4.3 Commands
9.4.18.5 Client
9.4.19 Multistate Value (BACnet Extended)
9.4.19.1 Revision History
9.4.19.2 Classification
9.4.19.3 Cluster Identifiers
9.4.19.4 Server
9.4.19.4.1 Dependencies
9.4.19.4.2 Attributes
9.4.19.4.3 Commands
9.4.19.4.4 Attribute Reporting
9.4.19.5 Client
9.4.20 Attributes of BACnet Regular Clusters
9.4.20.1 ObjectIdentifier Attribute
9.4.20.2 ObjectName Attribute
9.4.20.3 ObjectType Attribute
9.4.20.4 COVIncrement Attribute
9.4.20.5 DeviceType Attribute
9.4.20.6 UpdateInterval Attribute
9.4.20.7 ChangeOfStateCount Attribute
9.4.20.8 ChangeOfStateTime Attribute
9.4.20.9 ElapsedActiveTime Attribute
9.4.20.10 TimeOfATReset Attribute
9.4.20.11 TimeOfSCReset Attribute
9.4.20.12 FeedbackValue Attribute
9.4.20.13 ProfileName Attribute
9.4.21 Attributes of BACnet Extended Clusters
9.4.21.1 AckedTransitions Attribute
9.4.21.2 AlarmValue Attribute
9.4.21.3 AlarmValues Attribute
9.4.21.4 FaultValues Attribute
9.4.21.5 NotificationClass Attribute
9.4.21.6 Deadband Attribute
9.4.21.7 EventEnable Attribute
9.4.21.8 EventState Attribute
9.4.21.9 HighLimit Attribute
9.4.21.10 LimitEnable Attribute
9.4.21.11 LowLimit Attribute
9.4.21.12 NotifyType Attribute
9.4.21.13 TimeDelay Attribute
9.4.21.14 EventTimeStamps Attribute
9.5 ISO 7818 Protocol Tunnel
9.5.1 Scope and Purpose
9.5.2 Definitions
9.5.3 General Description
9.5.4 Overview
9.5.4.1 Revision History
9.5.4.2 Classification
9.5.4.3 Cluster Identifiers
9.5.5 Server
9.5.5.1 Dependencies
9.5.5.2 Attributes
9.5.5.2.1 Status Attribute
9.5.5.3 Commands Received
9.5.5.3.1 Transfer APDU Command
9.5.5.3.1.1 Payload Format
9.5.5.3.1.2 APDU Field
9.5.5.3.1.3 When Generated
9.5.5.3.1.4 Effect on Receipt
9.5.5.3.2 Insert Smart Card
9.5.5.3.2.1 Payload Format
9.5.5.3.2.2 When Generated
9.5.5.3.2.3 Effect on Receipt
9.5.5.3.3 Extract Smart Card
9.5.5.3.3.1 Payload Format
9.5.5.3.3.2 When Generated
9.5.5.3.3.3 Effect on Receipt
9.5.5.4 Commands Generated
9.5.5.5 Transfer APDU
9.5.5.5.1.1 Payload Format
9.5.6 Client
9.5.6.1 Dependencies
9.5.6.2 Attributes
9.5.6.3 Command Received
9.5.6.4 Command Generated
9.6 Partition
9.6.1 Scope and Purpose
9.6.2 Introduction
9.6.2.1 Revision History
9.6.2.2 Classification
9.6.2.3 Cluster Identifiers
9.6.3 Server
9.6.3.1 Dependencies
9.6.3.2 Attributes
9.6.3.2.1.1 MaximumIncomingTransferSize Attribute
9.6.3.2.1.2 MaximumOutgoingTransferSize Attribute
9.6.3.2.1.3 PartionedFrameSize Attribute
9.6.3.2.1.4 LargeFrameSize Attribute
9.6.3.2.1.5 NumberOfACKFrame Attribute
9.6.3.2.1.6 NACKTimeout Attribute
9.6.3.2.1.7 InterFrameDelay Attribute
9.6.3.2.1.8 NumberOfSendRetries Attribute
9.6.3.2.1.9 SenderTimeout Attribute
9.6.3.2.1.10 ReceiverTimeout Attribute
9.6.3.3 Commands Received
9.6.3.3.1 TransferPartitionedFrame Command
9.6.3.3.1.1 Effect on Receipt
9.6.3.3.2 ReadHandshakeParam Command
9.6.3.3.3 WriteHandshakeParam Command
9.6.3.4 Commands Generated
9.6.3.4.1 MultipleACK Command
9.6.3.4.1.1 Effect on Receipt
9.6.3.4.2 ReadHandshakeParamResponse Command
9.6.4 Client
9.6.4.1 Attributes
9.6.4.2 Command Received
9.6.4.3 Command Generated
9.6.5 General Use of Partition Cluster
9.7 11073 Protocol Tunnel
9.7.1 Overview
9.7.1.1 Revision History
9.7.1.2 Classification
9.7.1.3 Cluster Identifiers
9.7.2 Server
9.7.2.1 Dependencies
9.7.2.2 Attributes
9.7.2.2.1 DeviceIDList attribute
9.7.2.2.2 ManagerTarget attribute
9.7.2.2.3 ManagerEndpoint attribute
9.7.2.2.4 Connected attribute
9.7.2.2.5 Preemptible attribute
9.7.2.2.6 Idle timeout attribute
9.7.2.3 Commands Received
9.7.2.3.1 Transfer APDU Command
9.7.2.3.1.1 When generated
9.7.2.3.1.2 Effect on Receipt
9.7.2.3.2 Connect Request Command
9.7.2.3.2.1 Connect control
9.7.2.3.2.2 Idle timeout
9.7.2.3.2.3 Manager target
9.7.2.3.2.4 Manager endpoint
9.7.2.3.2.5 When generated
9.7.2.3.2.6 Effect on Receipt
9.7.2.3.3 Disconnect Request Command
9.7.2.3.3.1 Manager IEEE address
9.7.2.3.3.2 When generated
9.7.2.3.3.3 Effect on Receipt
9.7.2.3.4 Connect Status Notification Command
9.7.2.3.4.1 Connect Status
9.7.2.3.4.2 When generated
9.7.2.3.4.3 Effect on Receipt
9.7.2.4 Commands Generated
9.7.3 Client
9.7.3.1 Dependencies
9.7.3.2 Attributes
9.7.3.3 Commands Received
9.7.3.4 Commands Generated
Chapter 10 Smart Energy
10.1 General Description
10.1.1 Introduction
10.1.2 Cluster List
10.2 Price
10.2.1 Overview
10.2.1.1 Revision History
10.2.1.2 Classification
10.2.1.3 Cluster Identifiers
10.2.2 Server
10.2.2.1 Dependencies
10.2.2.2 Attributes
10.2.2.2.1 Tier Label Set
10.2.2.2.1.1 TierNPriceLabel Attributes
10.2.2.2.2 Block Threshold Set
10.2.2.2.2.1 BlockNThreshold
10.2.2.2.3 Block Period Set
10.2.2.2.3.1 StartofBlockPeriod Attribute
10.2.2.2.3.2 BlockPeriodDuration Attribute
10.2.2.2.3.3 ThresholdMultiplier Attribute
10.2.2.2.3.4 ThresholdDivisor Attribute
10.2.2.2.4 Commodity Set
10.2.2.2.4.1 CommodityType Attribute
10.2.2.2.4.2 Standing Charge Attribute
10.2.2.2.4.3 ConversionFactor Attribute
10.2.2.2.4.4 ConversionFactorTrailingDigit Attribute
10.2.2.2.4.5 CalorificValue Attribute
10.2.2.2.4.6 CalorificValueUnit Attribute
10.2.2.2.4.7 CalorificValueTrailingDigit Attribute
10.2.2.2.5 Block Price Information Set
10.2.2.2.5.1 TierNBlockNPrice Attributes
10.2.2.2.6 Billing Information Attribute Set
10.2.2.2.6.1 CurrentBillingPeriodStart Attribute
10.2.2.2.6.2 CurrentBillingPeriodDuration Attribute
10.2.2.3 Commands Received
10.2.2.3.1 Get Current Price Command
10.2.2.3.1.1 Payload Format
10.2.2.3.1.1.1 Payload Details
10.2.2.3.1.2 Effect on Receipt
10.2.2.3.2 Get Scheduled Prices Command
10.2.2.3.2.1 Payload Details
10.2.2.3.2.2 When Generated
10.2.2.3.2.3 Effect on Receipt
10.2.2.3.3 Price Acknowledgement Command
10.2.2.3.3.1 Payload Format
10.2.2.3.3.1.1 Payload Details
10.2.2.3.3.2 When Generated
10.2.2.3.4 Get Block Period(s) Command
10.2.2.3.4.1 Payload Format
10.2.2.3.4.1.1 Payload Details
10.2.2.3.4.2 When Generated
10.2.2.3.4.3 Effect on Receipt
10.2.2.3.5 GetConversionFactor Command
10.2.2.3.5.1 Payload Format
10.2.2.3.5.2 Payload Details
10.2.2.3.6 GetCalorificValue Command
10.2.2.3.6.1 Payload Format
10.2.2.3.6.2 Payload Details
10.2.2.4 Commands Generated
10.2.2.4.1 Publish Price Command
10.2.2.4.1.1 Payload Format
10.2.2.4.1.2 Effect on Receipt
10.2.2.4.2 Publish Block Period Command
10.2.2.4.2.1 Payload Format
10.2.2.4.3 PublishConversionFactor Command
10.2.2.4.3.1 Payload Format
10.2.2.4.3.2 Payload Details
10.2.2.4.4 PublishCalorificValue Command
10.2.2.4.4.1 Payload Format
10.2.2.4.4.2 Payload Details
10.2.3 Client
10.2.3.1 Dependencies
10.2.3.2 Attributes
10.2.3.2.1 PriceIncreaseRandomizeMinutes Attribute
10.2.3.2.2 PriceDecreaseRandomizeMinutes Attribute
10.2.3.2.3 CommodityType Attribute
10.2.3.3 Commands Received
10.2.3.4 Commands Generated
10.2.4 Application Guidelines
10.2.4.1 Registering for Commands
10.2.4.2 Attribute Reporting
10.2.4.3 Block Tariffs
10.2.4.3.1 TOU Charging Only
10.2.4.3.2 Block Charging Only
10.2.4.3.3 Block/TOU Combination Charging
10.2.4.3.4 Application Guidelines for Block Pricing Under Specific Events
10.3 Demand Response and Load Control
10.3.1 Overview
10.3.1.1 Revision History
10.3.1.2 Classification
10.3.1.3 Cluster Identifiers
10.3.2 Server
10.3.2.1 Dependencies
10.3.2.2 Attributes
10.3.2.3 Commands Generated
10.3.2.3.1 Load Control Event Command
10.3.2.3.1.1 Payload Format
10.3.2.3.1.1.1 Payload Details
10.3.2.3.1.1.2 When Generated
10.3.2.3.1.1.3 Responses to Load Control Event
10.3.2.3.2 Cancel Load Control Event Command
10.3.2.3.2.1 Payload Format
10.3.2.3.2.1.1 Payload Details
10.3.2.3.2.1.2 When Generated
10.3.2.3.2.1.3 Responses to Cancel Load Control Event
10.3.2.3.3 Cancel All Load Control Events Command
10.3.2.3.3.1 Payload Format
10.3.2.3.3.1.1 Payload Details
10.3.2.3.3.2 When Generated
10.3.2.3.3.3 Responses to Cancel All Load Control Events
10.3.2.4 Commands Received
10.3.3 Client
10.3.3.1 Dependencies
10.3.3.2 Client Cluster Attributes
10.3.3.2.1 UtilityEnrollmentGroup Attribute
10.3.3.2.2 StartRandomizationMinutes Attribute
10.3.3.2.3 EndRandomizationMinutes Attribute
10.3.3.2.4 DeviceClassValue Attribute
10.3.3.3 Commands Generated
10.3.3.3.1 Report Event Status Command
10.3.3.3.1.1 Payload Format
10.3.3.3.1.1.1 Payload Details
10.3.3.3.1.2 When Generated
10.3.3.3.2 Get Scheduled Events Command
10.3.3.3.2.1 Payload Format
10.3.3.3.2.2 When Generated
10.3.3.4 Commands Received
10.3.3.5 Attribute Reporting
10.3.4 Application Guidelines
10.3.4.1 Load Control Rules, Server
10.3.4.1.1 Load Control Server, Identifying Use of SetPoint and Offset Fields
10.3.4.1.2 Load Control Server, Editing of Scheduled Events
10.3.4.2 Load Control Rules, Client
10.3.4.2.1 Start and Stop Randomization
10.3.4.2.2 Editing of DR Control Parameters
10.3.4.2.3 Response to Price Events + Load Control Events
10.3.4.2.4 Opt-Out Messages
10.3.4.2.5 Thermostat/HVAC Controls
10.3.4.2.6 Demand Response and Load Control Transaction Examples
10.3.5 Rules and Guidelines for Overlapping Events
10.3.5.1 Definitions
10.3.5.2 Rules and Guidelines
10.3.5.3 Event Examples
10.3.5.3.1 Correct Overlapping Events for Different Device Classes
10.3.5.3.2 Correct Superseded Event for a Device Class
10.3.5.3.3 Superseding Events for Subsets of Device Classes
10.3.5.3.4 Ending Randomization Between Events
10.3.5.3.5 Start Randomization Between Events
10.3.5.3.6 Acceptable Gaps Caused by Start and Stop Randomization of Events
10.4 Metering
10.4.1 Overview
10.4.1.1 Revision History
10.4.1.2 Classification
10.4.1.3 Cluster Identifiers
10.4.2 Server
10.4.2.1 Dependencies
10.4.2.2 Attributes
10.4.2.2.1 Reading Information Set
10.4.2.2.1.1 CurrentSummationDelivered Attribute
10.4.2.2.1.2 CurrentSummationReceived Attribute
10.4.2.2.1.3 CurrentMaxDemandDelivered Attribute
10.4.2.2.1.4 CurrentMaxDemandReceived Attribute
10.4.2.2.1.5 DFTSummation Attribute
10.4.2.2.1.6 DailyFreezeTime Attribute
10.4.2.2.1.7 PowerFactor Attribute
10.4.2.2.1.8 ReadingSnapShotTime Attribute
10.4.2.2.1.9 CurrentMaxDemandDeliveredTime Attribute
10.4.2.2.1.10 CurrentMaxDemandReceivedTime Attribute
10.4.2.2.1.11 DefaultUpdatePeriod Attribute
10.4.2.2.1.12 FastPollUpdatePeriod Attribute
10.4.2.2.1.13 CurrentBlockPeriodConsumptionDelivered Attribute
10.4.2.2.1.14 DailyConsumptionTarget Attribute
10.4.2.2.1.15 CurrentBlock Attribute
10.4.2.2.1.16 ProfileIntervalPeriod Attribute
10.4.2.2.1.17 IntervalReadReportingPeriod Attribute
10.4.2.2.1.18 PresetReadingTime Attribute
10.4.2.2.1.19 VolumePerReport Attribute
10.4.2.2.1.20 FlowRestriction Attribute
10.4.2.2.1.21 SupplyStatus Attribute
10.4.2.2.1.22 CurrentInletEnergyCarrierSummation Attribute
10.4.2.2.1.23 CurrentOutletEnergyCarrierSummation Attribute
10.4.2.2.1.24 InletTemperature Attribute
10.4.2.2.1.25 OutletTemperature Attribute
10.4.2.2.1.26 ControlTemperature Attribute
10.4.2.2.1.27 CurrentInletEnergyCarrierDemand Attribute
10.4.2.2.1.28 CurrentOutletEnergyCarrierDemand Attribute
10.4.2.2.1.29 PreviousBlockPeriodConsumptionDelivered Attribute
10.4.2.2.2 Summation TOU Information Set
10.4.2.2.2.1 CurrentTierNSummationDelivered Attributes
10.4.2.2.2.2 CurrentTierNSummationReceived Attributes
10.4.2.2.3 Meter Status Attribute Set
10.4.2.2.3.1 Status Attribute
10.4.2.2.3.2 RemainingBatteryLife Attribute
10.4.2.2.3.3 HoursInOperation Attribute
10.4.2.2.3.4 HoursInFault Attribute
10.4.2.2.4 Formatting
10.4.2.2.4.1 UnitofMeasure Attribute
10.4.2.2.4.2 Multiplier Attribute
10.4.2.2.4.3 Divisor Attribute
10.4.2.2.4.4 SummationFormatting Attribute
10.4.2.2.4.5 DemandFormatting Attribute
10.4.2.2.4.6 HistoricalConsumptionFormatting Attribute
10.4.2.2.4.7 MeteringDeviceType Attribute
10.4.2.2.4.8 SiteID Attribute
10.4.2.2.4.9 MeterSerialNumber Attribute
10.4.2.2.4.10 EnergyCarrierUnitOfMeasure Attribute
10.4.2.2.4.11 EnergyCarrierSummationFormatting Attribute
10.4.2.2.4.12 EnergyCarrierDemandFormatting Attribute
10.4.2.2.4.13 TemperatureUnitOfMeasure Attribute
10.4.2.2.4.14 TemperatureFormatting Attribute
10.4.2.2.5 Historical Consumption Attribute
10.4.2.2.5.1 InstantaneousDemand Attribute
10.4.2.2.5.2 CurrentDayConsumptionDelivered Attribute
10.4.2.2.5.3 CurrentDayConsumptionReceived Attribute
10.4.2.2.5.4 PreviousDayConsumptionDelivered Attribute
10.4.2.2.5.5 PreviousDayConsumptionReceived Attribute
10.4.2.2.5.6 CurrentPartialProfileIntervalStartTimeDelivered Attribute
10.4.2.2.5.7 CurrentPartialProfileIntervalStartTimeReceived Attribute
10.4.2.2.5.8 CurrentPartialProfileIntervalValueDelivered Attribute
10.4.2.2.5.9 CurrentPartialProfileIntervalValueReceived Attribute
10.4.2.2.5.10 CurrentDayMaxPressure Attribute
10.4.2.2.5.11 PreviousDayMaxPressure Attribute
10.4.2.2.5.12 CurrentDayMinPressure Attribute
10.4.2.2.5.13 PreviousDayMinPressure Attribute
10.4.2.2.5.14 CurrentDayMaxDemand Attribute
10.4.2.2.5.15 PreviousDayMaxDemand Attribute
10.4.2.2.5.16 CurrentMonthMaxDemand Attribute
10.4.2.2.5.17 CurrentYearMaxDemand Attribute
10.4.2.2.5.18 CurrentDayMaxEnergyCarrierDemand Attribute
10.4.2.2.5.19 PreviousDayMaxEnergyCarrierDemand Attribute
10.4.2.2.5.20 CurrentMonthMaxEnergyCarrierDemand Attribute
10.4.2.2.5.21 CurrentMonthMinEnergyCarrierDemand Attribute
10.4.2.2.5.22 CurrentYearMaxEnergyCarrierDemand Attribute
10.4.2.2.5.23 CurrentYearMinEnergyCarrierDemand Attribute
10.4.2.2.6 Load Profile Configuration
10.4.2.2.6.1 MaxNumberOfPeriodsDelivered Attribute
10.4.2.2.7 Supply Limit Attributes
10.4.2.2.7.1 CurrentDemandDelivered Attribute
10.4.2.2.7.2 DemandLimit Attribute
10.4.2.2.7.3 DemandIntegrationPeriod Attribute
10.4.2.2.7.4 NumberOfDemandSubintervals Attribute
10.4.2.2.8 Block Information Set
10.4.2.2.8.1 CurrentTierNBlockNSummationDelivered Attributes
10.4.2.2.9 Alarms Set
10.4.2.2.9.1 AlarmMask Attributes
10.4.2.2.9.2 Alarm Codes
10.4.2.3 Server Commands
10.4.2.3.1 Commands Generated
10.4.2.3.1.1 Get Profile Response Command
10.4.2.3.1.1.1 Payload Format
10.4.2.3.1.1.2 Payload Details
10.4.2.3.1.1.3 When Generated
10.4.2.3.1.2 Request Mirror Command
10.4.2.3.1.2.1 Payload Details
10.4.2.3.1.2.2 Effect on Receipt
10.4.2.3.1.3 Remove Mirror Command
10.4.2.3.1.3.1 Payload Details
10.4.2.3.1.3.2 Effect on Receipt
10.4.2.3.1.4 Request Fast Poll Mode Response Command
10.4.2.3.1.4.1 Payload Format
10.4.2.3.1.4.2 Payload Details
10.4.2.3.1.4.3 When Generated
10.4.2.3.1.4.4 Effect on Receipt
10.4.2.4 Client Commands
10.4.2.4.1 Commands Generated
10.4.2.4.1.1 Get Profile Command
10.4.2.4.1.1.1 Payload Details
10.4.2.4.1.1.2 When Generated
10.4.2.4.1.1.3 Command Processing Response
10.4.2.4.1.1.4 Effect on Receipt
10.4.2.4.1.2 Request Mirror Response Command
10.4.2.4.1.2.1 Payload Format
10.4.2.4.1.2.2 Payload Details
10.4.2.4.1.3 Mirror Removed Command
10.4.2.4.1.3.1 Payload Format
10.4.2.4.1.3.2 Payload Details
10.4.2.4.1.4 Request Fast Poll Mode Command
10.4.2.4.1.4.1 Payload Format
10.4.2.4.1.4.2 Payload Details
10.4.2.4.1.4.3 When Generated
10.4.2.4.1.4.4 Effect on Receipt
10.4.3 Metering Application Guidelines
10.4.3.1 Attribute Reporting
10.4.3.2 Fast Polling or Reporting for Monitoring Energy Savings
10.4.3.3 Metering Data Updates
10.4.3.3.1 Fast Polling Periods
10.4.3.4 Mirroring
10.4.3.4.1 Discovery
10.4.3.4.2 Mirror Attributes
10.5 Messaging
10.5.1 Overview
10.5.1.1 Revision History
10.5.1.2 Classification
10.5.1.3 Cluster Identifiers
10.5.2 Server
10.5.2.1 Dependencies
10.5.2.2 Attributes
10.5.2.3 Commands Generated
10.5.2.3.1 Display Message Command
10.5.2.3.1.1 Payload Format
10.5.2.3.1.1.1 Payload Details
10.5.2.3.2 Cancel Message Command
10.5.2.3.2.1 Payload Details
10.5.3 Client
10.5.3.1 Dependencies
10.5.3.2 Attributes
10.5.3.3 Commands Generated
10.5.3.3.1 GetLastMessage Command
10.5.3.3.1.1 Effect on Receipt
10.5.3.3.2 MessageConfirmation Command
10.5.3.3.2.1 Payload Details
10.5.4 Application Guidelines
10.6 Tunneling
10.6.1 Overview
10.6.1.1 Revision History
10.6.1.2 Classification
10.6.1.3 Cluster Identifiers
10.6.2 Server
10.6.2.1 Dependencies
10.6.2.2 Attributes
10.6.2.2.1 CloseTunnelTimeout Attribute
10.6.2.3 Parameters
10.6.2.4 Commands Received
10.6.2.4.1 RequestTunnel Command
10.6.2.4.1.1 Payload Format
10.6.2.4.1.2 Payload Details
10.6.2.4.1.3 When Generated
10.6.2.4.1.4 Effect on Receipt
10.6.2.4.2 CloseTunnel Command
10.6.2.4.2.1 Payload Format
10.6.2.4.2.2 Payload Details
10.6.2.4.2.3 When Generated
10.6.2.4.2.4 Effect on Receipt
10.6.2.4.3 TransferData Command
10.6.2.4.3.1 Payload Format
10.6.2.4.3.2 Payload Details
10.6.2.4.3.3 When Generated
10.6.2.4.3.4 Effect on Receipt
10.6.2.4.4 TransferDataError Command
10.6.2.4.4.1 Payload Format
10.6.2.4.4.2 Payload Details
10.6.2.4.4.3 When Generated
10.6.2.4.4.4 Effect on Receipt
10.6.2.4.5 AckTransferData Command
10.6.2.4.5.1 Payload Format
10.6.2.4.5.2 Payload Details
10.6.2.4.5.3 When Generated
10.6.2.4.5.4 Effect on Receipt
10.6.2.4.6 ReadyData Command
10.6.2.4.6.1 Payload Format
10.6.2.4.6.2 Payload Details
10.6.2.4.6.3 When Generated
10.6.2.4.6.4 Effect on Receipt
10.6.2.4.7 Get Supported Tunnel Protocols Command
10.6.2.4.7.1 Payload Format
10.6.2.4.7.2 Payload Details
10.6.2.4.7.3 Effect on Receipt
10.6.2.5 Commands Generated
10.6.2.5.1 RequestTunnelResponse Command
10.6.2.5.1.1 Payload Format
10.6.2.5.1.2 Payload Details
10.6.2.5.1.3 When Generated
10.6.2.5.1.4 Effect on Receipt
10.6.2.5.2 TransferData Command
10.6.2.5.2.1 Payload Format
10.6.2.5.2.2 Payload Details
10.6.2.5.2.3 When Generated
10.6.2.5.2.4 Effect on Receipt
10.6.2.5.3 TransferDataError Command
10.6.2.5.4 AckTransferData Command
10.6.2.5.5 ReadyData Command
10.6.2.5.6 Supported Tunnel Protocols Response Command
10.6.2.5.6.1 Payload Format
10.6.2.5.6.2 Payload Details
10.6.2.5.6.3 When Generated
10.6.2.5.7 TunnelClosureNotification Command
10.6.2.5.7.1 Payload Format
10.6.2.5.7.2 Payload Details
10.6.2.5.7.3 When Generated
10.6.3 Client
10.6.3.1 Dependencies
10.6.3.2 Attributes
10.6.3.3 Commands Received
10.6.3.4 Commands Generated
10.7 Key Establishment
10.7.1 Scope and Purpose
10.7.2 General Description
10.7.2.1 Introduction
10.7.2.2 Network Security
10.7.2.3 Key Establishment
10.7.2.4 Symmetric Key Key Establishment
10.7.2.5 Public Key Key Establishment
10.7.2.6 General Exchange
10.7.2.6.1 Exchange Static and Ephemeral Data
10.7.2.6.2 Generate Key Bitstream
10.7.2.6.3 Derive MAC Key and Key Data
10.7.2.6.4 Confirm Key Using MAC
10.7.3 Cluster List
10.7.3.1 Key Establishment Cluster
10.7.3.1.1 Overview
10.7.3.1.1.1 Revision History
10.7.3.1.1.2 Classification
10.7.3.1.1.3 Cluster Identifiers
10.7.3.1.2 Server
10.7.3.1.2.1 Dependencies
10.7.3.1.2.2 Attributes
10.7.3.1.2.2.1 Information
10.7.3.1.2.2.1.1 KeyEstablishmentSuite Attribute
10.7.3.1.2.3 Commands Received
10.7.3.1.2.3.1 Initiate Key Establishment Request Command
10.7.3.1.2.3.1.1 Payload Format
10.7.3.1.2.3.1.2 Effect on Receipt
10.7.3.1.2.3.2 Ephemeral Data Request Command
10.7.3.1.2.3.2.1 Payload Format
10.7.3.1.2.3.2.2 Effect on Receipt
10.7.3.1.2.3.3 Confirm Key Request Command
10.7.3.1.2.3.3.1 Payload Format
10.7.3.1.2.3.3.2 Effect on Receipt
10.7.3.1.2.3.4 Terminate Key Establishment Command
10.7.3.1.2.3.4.1 Payload Format
10.7.3.1.2.3.4.2 Effect on Receipt
10.7.3.1.2.4 Commands Generated
10.7.3.1.3 Client
10.7.3.1.3.1 Dependencies
10.7.3.1.3.2 Attributes
10.7.3.1.3.2.1 Information
10.7.3.1.3.2.1.1 KeyEstablishmentSuite Attribute
10.7.3.1.3.3 Commands Received
10.7.3.1.3.3.1 Initiate Key Establishment Response Command
10.7.3.1.3.3.1.1 Payload Format
10.7.3.1.3.3.1.2 Effect on Receipt
10.7.3.1.3.3.2 Ephemeral Data Response Command
10.7.3.1.3.3.2.1 Payload Format
10.7.3.1.3.3.2.2 Effect on Receipt
10.7.3.1.3.3.3 Confirm Key Response Command
10.7.3.1.3.3.3.1 Payload Format
10.7.3.1.3.3.3.2 Effect on Receipt
10.7.3.1.3.3.4 Terminate Key Establishment Command
10.7.3.1.3.3.4.1 Payload Format
10.7.3.1.3.3.4.2 Effect on Receipt
10.7.3.1.3.4 Commands Generated
10.7.4 Application Implementation
10.7.4.1 Network Security for Smart Energy Networks
10.7.4.2 Certificate-Based Key Establishment
10.7.4.2.1 Notation and Representation
10.7.4.2.1.1 Strings and String Operations
10.7.4.2.1.2 Integers and Their Representation
10.7.4.2.1.3 Entities
10.7.4.2.2 Cryptographic Building Blocks
10.7.4.2.2.1 Elliptic-Curve Domain Parameters
10.7.4.2.2.2 Elliptic-Curve Point Representation
10.7.4.2.2.3 Elliptic-Curve Key Pair
10.7.4.2.2.4 ECC Implicit Certificates
10.7.4.2.2.5 Block-Cipher
10.7.4.2.2.6 Cryptographic Hash Function
10.7.4.2.2.7 Keyed Hash Function for Message Authentication
10.7.4.2.2.8 Derived Shared Secret
10.7.4.2.3 Certificate-Based Key-Establishment
10.7.4.2.3.1 Exchange Ephemeral Data
10.7.4.2.3.1.1 Initiator
10.7.4.2.3.1.2 Responder
10.7.4.2.3.2 Validate Implicit Certificates
10.7.4.2.3.2.1 Initiator
10.7.4.2.3.2.2 Responder
10.7.4.2.3.3 Derive Keying Material
10.7.4.2.3.3.1 Initiator
10.7.4.2.3.3.2 Responder
10.7.4.2.3.4 Confirm Keys
10.7.4.2.3.4.1 Initiator
10.7.4.2.3.4.2 Responder
10.7.5 Key Establishment Test Vectors
10.7.5.1 Preconfigured Data
10.7.5.1.1 CA Public Key
10.7.5.1.2 Responder Data
10.7.5.1.3 Initiator Data
10.7.5.2 Key Establishment Messages
10.7.5.2.1 Initiate Key Establishment Request
10.7.5.2.2 Initiate Key Establishment Response
10.7.5.2.3 Ephemeral Data Request
10.7.5.2.4 Ephemeral Data Response
10.7.5.2.5 Confirm Key Request
10.7.5.2.6 Confirm Key Response
10.7.5.3 Data Transformation
10.7.5.3.1 ECMQV Primitives
10.7.5.3.2 Key Derivation Function (KDF)
10.7.5.3.3 Initiator Transform
10.7.5.3.3.1 Ephemeral Data
10.7.5.3.3.2 Step Summary
10.7.5.3.3.3 Detailed Steps
10.7.5.3.4 Responder Transform
10.7.5.3.4.1 Ephemeral Data
10.7.5.3.4.2 Step Summary
10.7.5.3.4.3 Detailed Steps
Chapter 11 Over-the-Air Upgrade
11.1 Introduction
11.1.1 Purpose
11.1.2 Scope
11.1.3 Terminology
11.2 General Description
11.2.1 Introduction
11.2.2 Cluster List
11.3 OTA Upgrade
11.3.1 Overview
11.3.1.1 Revision History
11.3.1.2 Classification
11.3.1.3 Cluster Identifiers
11.3.2 Security
11.3.2.1 Terminology
11.3.3 Image Verification
11.3.3.1 Asymmetric Verification of Authenticity and Integrity
11.3.3.2 Verification of Integrity by Hash Value
11.3.4 Image Transport
11.3.5 Image Signature
11.3.6 Image Integrity Code
11.4 OTA File Format
11.4.1 General Structure
11.4.2 OTA Header Format
11.4.2.1 OTA Upgrade File Identifier
11.4.2.2 OTA Header Version
11.4.2.3 OTA Header Length
11.4.2.4 OTA Header Field Control
11.4.2.5 Manufacturer Code
11.4.2.6 Image Type
11.4.2.7 File Version
11.4.2.8 ZigBee Stack Version
11.4.2.9 OTA Header String
11.4.2.10 Total Image Size
11.4.2.11 Security Credential Version
11.4.2.12 Upgrade File Destination
11.4.2.13 Minimum Hardware Version
11.4.2.14 Maximum Hardware Version
11.4.3 Sub-element Format
11.4.3.1 Tag ID
11.4.3.2 Length Field
11.4.3.3 Data
11.4.4 Tag Identifiers
11.4.5 Crypto Suites
11.4.6 ECDSA Signature Sub-element (Crypto Suite 1)
11.4.6.1 Signer IEEE Address
11.4.6.2 Signature Data
11.4.7 ECDSA Signing Certificate Sub-element
11.4.7.1 ECDSA Certificate (Crypto Suite 1)
11.4.8 Image Integrity Code Sub-element
11.4.8.1 Hash Value
11.4.9 ECDSA Signature Sub-element (Crypto Suite 2)
11.4.9.1 Signer IEEE Address
11.4.9.2 Signature Data
11.4.10 ECDSA Signing Certificate Sub-element (Crypto Suite 2)
11.4.10.1 ECDSA Certificate (Crypto Suite 2)
11.5 OTA File Naming
11.6 Signatures
11.7 ECDSA Signature Calculation
11.7.1 ECDSA Signature Verification
11.7.2 Image Integrity Code
11.7.2.1 Hash Value Calculation
11.7.2.2 Hash Value Verification
11.8 Discovery of the Upgrade Server
11.8.1 Server and Client
11.8.2 Sleepy Devices
11.9 Dependencies
11.10 OTA Cluster Attributes
11.10.1 UpgradeServerID Attribute
11.10.2 FileOffset Attribute
11.10.3 CurrentFileVersion Attribute
11.10.4 CurrentZigBeeStackVersion Attribute
11.10.5 DownloadedFileVersion Attribute
11.10.6 DownloadedZigBeeStackVersion Attribute
11.10.7 ImageUpgradeStatus Attribute
11.10.8 Manufacturer ID Attribute
11.10.9 Image Type ID Attribute
11.10.10 MinimumBlockPeriod Attribute
11.10.11 Image Stamp Attribute
11.10.12 UpgradeActivationPolicy Attribute
11.10.13 UpgradeTimeoutPolicy Attribute
11.11 OTA Cluster Parameters
11.11.1 QueryJitter Parameter
11.11.2 DataSize Parameter
11.11.3 OTAImageData Parameter
11.11.4 CurrentTime and UpgradeTime/RequestTime Parameters
11.12 OTA Upgrade Diagram
11.13 Command Frames
11.13.1 OTA Cluster Command Identifiers
11.13.2 OTA Cluster Status Codes
11.13.3 Image Notify Command
11.13.3.1 Payload Format
11.13.3.2 Payload Field Definitions
11.13.3.2.1 Image Notify Command Payload Type
11.13.3.2.2 Query Jitter
11.13.3.2.3 Manufacturer Code
11.13.3.2.4 Image Type
11.13.3.2.5 (new) File Version
11.13.3.3 When Generated
11.13.3.4 Effect on Receipt
11.13.3.5 Handling Error Cases
11.13.3.5.1 Malformed Command
11.13.4 Query Next Image Request Command
11.13.4.1 Payload Format
11.13.4.2 Payload Field Definitions
11.13.4.2.1 Query Next Image Request Command Field Control
11.13.4.2.2 Manufacturer Code
11.13.4.2.3 Image Type
11.13.4.2.4 File Version (current)
11.13.4.2.5 Hardware Version (optional)
11.13.4.3 When Generated
11.13.4.4 Effect on Receipt
11.13.4.5 Handling Error Cases
11.13.4.5.1 Malformed Command
11.13.5 Query Next Image Response Command
11.13.5.1 Payload Format
11.13.5.2 Payload Field Definitions
11.13.5.2.1 Query Next Image Response Status
11.13.5.2.2 Manufacturer Code
11.13.5.2.3 Image Type
11.13.5.2.4 File Version
11.13.5.2.5 Image Size
11.13.5.3 When Generated
11.13.5.4 Effect on Receipt
11.13.5.5 Handling Error Cases
11.13.5.5.1 Malformed Command
11.13.6 Image Block Request Command
11.13.6.1 Payload Format
11.13.6.2 Payload Field Definitions
11.13.6.2.1 Image Block Request Command Field Control
11.13.6.2.2 Manufacturer Code
11.13.6.2.3 Image Type
11.13.6.2.4 File Version
11.13.6.2.5 File Offset
11.13.6.2.6 Maximum Data Size
11.13.6.2.7 Request Node Address (optional)
11.13.6.2.8 MinimumBlockPeriod (optional)
11.13.6.3 When Generated
11.13.6.4 Effect on Receipt
11.13.6.5 Handling Error Cases
11.13.6.5.1 Malformed Command
11.13.6.5.2 No Image Available
11.13.6.5.3 Command Not Supported
11.13.7 Image Page Request Command
11.13.7.1 Payload Format
11.13.7.2 Payload Field Definitions
11.13.7.2.1 Image Page Request Command Field Control
11.13.7.2.2 Manufacturer Code
11.13.7.2.3 Image Type
11.13.7.2.4 File Version
11.13.7.2.5 File Offset
11.13.7.2.6 Maximum Data Size
11.13.7.2.7 Page Size
11.13.7.2.8 Response Spacing
11.13.7.2.9 Request Node Address (optional)
11.13.7.3 When Generated
11.13.7.4 Effect on Receipt
11.13.7.5 Handling Error Cases
11.13.7.5.1 Malformed Command
11.13.7.5.2 No Image Available
11.13.7.5.3 Command Not Supported
11.13.8 Image Block Response Command
11.13.8.1 Payload Format
11.13.8.2 Payload Field Definitions
11.13.8.2.1 Image Block Response Status
11.13.8.2.2 Manufacturer Code
11.13.8.2.3 Image Type
11.13.8.2.4 File Version
11.13.8.2.5 File Offset
11.13.8.2.6 Data Size
11.13.8.2.7 Image Data
11.13.8.2.8 Current Time and Request Time
11.13.8.2.9 MinimumBlockPeriod
11.13.8.3 When Generated
11.13.8.4 Effect on Receipt
11.13.8.5 Handling Error Cases
11.13.8.5.1 Malformed Command
11.13.9 Upgrade End Request Command
11.13.9.1 Payload Format
11.13.9.2 Payload Field Definitions
11.13.9.2.1 Upgrade End Request Command Status
11.13.9.2.2 Manufacturer Code
11.13.9.2.3 Image Type
11.13.9.2.4 File Version
11.13.9.3 When Generated
11.13.9.4 Effect on Receipt
11.13.9.5 Handling Error Cases
11.13.9.5.1 Malformed Command
11.13.9.6 Upgrade End Response Command
11.13.9.6.1 Payload Format
11.13.9.6.2 Payload Field Definitions
11.13.9.6.3 Manufacturer Code
11.13.9.6.4 Image Type
11.13.9.6.5 File Version
11.13.9.7 When Generated
11.13.9.8 Effect on Receipt
11.13.9.9 Handling Error Cases
11.13.9.9.1 Malformed Command
11.13.10 Query Device Specific File Request Command
11.13.10.1 Payload Format
11.13.10.2 Payload Field Definitions
11.13.10.2.1 Request Node Address
11.13.10.2.2 Manufacturer Code
11.13.10.2.3 Image Type
11.13.10.2.4 File Version
11.13.10.2.5 (current) ZigBee Stack Version
11.13.10.3 When Generated
11.13.10.4 Effect on Receipt
11.13.10.5 Handling Error Cases
11.13.10.5.1 Malformed Command
11.13.10.5.2 Command Not Supported
11.13.11 Query Device Specific File Response Command
11.13.11.1 Payload Format
11.13.11.2 Payload Field Definitions
11.13.11.2.1 Query Device Specific File Response Status
11.13.11.2.2 Manufacturer Code
11.13.11.2.3 Image Type
11.13.11.2.4 File Version
11.13.11.2.5 Image Size
11.13.11.3 When Generated
11.13.11.4 Effect on Receipt
11.13.11.5 Handling Error Cases
11.13.11.5.1 Malformed Command
11.14 Multiple Files Required for a Bootload
11.14.1 Single OTA File with multiple sub-elements
11.14.2 Separate OTA Files Upgraded Independently
11.14.3 Multiple OTA Files Dependent on Each Other
11.15 OTA Upgrade Cluster Management
11.15.1 Query Upgrade Status
11.15.2 Query Downloaded ZigBee Stack and File Versions
11.15.3 Rate Limiting
11.15.4 Current Time, Request Time, and MinimumBlockPeriod
11.16 OTA Upgrade Process
11.17 Application Standard Specific Decisions
11.17.1 SE Profile Standard: OTA Upgrade from SE 1.x to SE 2.0
11.18 OTA Upgrade Recovery
Chapter 12 Telecommunication
12.1 General Description
12.1.1 Introduction
12.1.2 Cluster List
12.2 Information
12.2.1 Scope and Purpose
12.2.1.1 Data Structure of Contents Data
12.2.2 Cluster List
12.2.3 Overview
12.2.3.1 Revision History
12.2.3.2 Classification
12.2.3.3 Cluster Identifiers
12.2.4 Server
12.2.4.1 Dependencies
12.2.4.2 Attributes
12.2.4.2.1 Node Information Attribute Set
12.2.4.2.1.1 NodeDescription Attribute
12.2.4.2.1.2 DeliveryEnable Attribute
12.2.4.2.1.3 PushInformationTimer Attribute
12.2.4.2.1.4 EnableSecureConfiguration Attribute
12.2.4.2.2 Contents Information Attribute Set
12.2.4.2.2.1 NumberOfContents Attribute
12.2.4.2.2.2 ContentRootID Attribute
12.2.4.3 Commands Received
12.2.4.3.1 Request Information Command
12.2.4.3.1.1.1 Frame Format
12.2.4.3.1.2 Request Information Payload
12.2.4.3.1.3 Inquiry ID
12.2.4.3.1.3.1 Format for Request a Content by a Content ID
12.2.4.3.1.3.2 Format for Request Contents by Multiple IDs
12.2.4.3.1.3.3 Format for Request All
12.2.4.3.1.3.4 Format for Request by Depth
12.2.4.3.2 Push Information Response Command
12.2.4.3.3 Send Preference Command
12.2.4.3.4 Request Preference Response Command
12.2.4.3.5 Update Command
12.2.4.3.5.1 Access Control Field
12.2.4.3.5.2 Option Field
12.2.4.3.6 Delete Command
12.2.4.3.6.1 Deletion Option Field
12.2.4.3.7 Configure Node Description
12.2.4.3.8 Configure Delivery Enable
12.2.4.3.9 Configure Push Information Timer
12.2.4.3.10 Configure Set Root ID
12.2.4.4 Commands Generated
12.2.4.4.1 Request Information Response Command
12.2.4.4.2 Push Information Command
12.2.4.4.3 Send Preference Response Command
12.2.4.4.4 Server Request Preference Command
12.2.4.4.5 Request Preference Confirmation Command
12.2.4.4.6 Update Response Command
12.2.4.4.7 Delete Response Command
12.2.5 Client
12.2.5.1 Command Received
12.2.5.2 Command Generated
12.2.6 Payload Formats for Contents Data
12.2.6.1 Payload Format for Multiple Contents
12.2.6.2 Contents Data Types
12.2.6.2.1 Title String
12.2.6.2.2 Long Octet String
12.2.6.2.3 Long Character String
12.2.6.2.4 RSS Feed
12.2.6.3 Status Codes for the Information Cluster
12.3 Chatting
12.3.1 Introduction
12.3.1.1 Scope and Purpose
12.3.1.2 Revision History
12.3.1.3 Classification
12.3.1.4 Cluster Identifiers
12.3.2 Server
12.3.2.1 Dependencies
12.3.2.2 Attributes
12.3.2.2.1 User Related Attribute Set
12.3.2.2.1.1 U_ID Attribute
12.3.2.2.1.2 Nickname Attribute
12.3.2.2.2 Chat Session Related Attribute Set
12.3.2.2.2.1 C_ID Attribute
12.3.2.2.2.2 Name Attribute
12.3.2.2.2.3 EnableAddChat Attribute
12.3.2.3 Commands Received
12.3.2.3.1 Join Chat Request Command
12.3.2.3.2 Leave Chat Request Command
12.3.2.3.3 Search Chat Request Command
12.3.2.3.4 Switch Chairman Response Command
12.3.2.3.5 Start Chat Request Command
12.3.2.3.6 ChatMessage Command
12.3.2.3.7 Get Node Information Request Command
12.3.2.4 Commands Generated
12.3.2.4.1 Start Chat Response Command
12.3.2.4.2 Join Chat Response Command
12.3.2.4.3 User Left Command
12.3.2.4.4 User Joined Command
12.3.2.4.5 Search Chat Response Command
12.3.2.4.6 Switch Chairman Request Command
12.3.2.4.7 Switch Chairman Confirm Command
12.3.2.4.8 Switch Chairman Notification Command
12.3.2.4.9 Get Node Information Response Command
12.3.3 Client
12.3.3.1 Commands Received
12.3.3.2 Commands Generated
12.4 Voice Over ZigBee
12.4.1 Scope and Purpose
12.4.2 Overview
12.4.2.1 Revision History
12.4.2.2 Classification
12.4.2.3 Cluster Identifiers
12.4.3 Server
12.4.3.1 Dependencies
12.4.3.2 Attributes
12.4.3.2.1 Establishment Information Attribute Set
12.4.3.2.1.1 CodecType Attribute
12.4.3.2.1.2 SamplingFrequency Attribute
12.4.3.2.1.3 CodecRate Attribute
12.4.3.2.1.4 EstablishmentTimeout Attribute
12.4.3.2.1.5 CodecTypeSub1, CodecTypeSub2, CodecTypeSub3 Attribute
12.4.3.2.1.6 CompressionType Attribute
12.4.3.2.1.7 CompressionRate Attribute
12.4.3.2.1.8 OptionFlags Attribute
12.4.3.2.1.9 Threshold Attribute
12.4.3.3 Commands Received
12.4.3.3.1 Establishment Request Command
12.4.3.3.2 Voice Transmission Command
12.4.3.3.3 Voice Transmission Completion
12.4.3.3.4 Control Response Command
12.4.3.4 Commands Generated
12.4.3.4.1 Voice Transmission Response Command
12.4.3.4.2 Establishment Response Command
12.4.3.4.3 Control Command
12.4.4 Client
12.4.4.1 Command Received
12.4.4.2 Command Generated
Chapter 13 Commissioning
13.1 General Description
13.1.1 13.1.1 Introduction
13.1.2 13.1.2 Cluster List
13.2 Commissioning
13.2.1 Overview
13.2.1.1 Security and Authorization
13.2.1.2 Revision History
13.2.1.3 Classification
13.2.1.4 Cluster Identifiers
13.2.2 Server
13.2.2.1 Dependencies
13.2.2.2 Attributes
13.2.2.2.1 Startup Parameters Attribute Set
13.2.2.2.1.1 ShortAddress Attribute
13.2.2.2.1.2 ExtendedPANId Attribute
13.2.2.2.1.3 PANId Attribute
13.2.2.2.1.4 ChannelMask Attribute
13.2.2.2.1.5 ProtocolVersion Attribute
13.2.2.2.1.6 StackProfile Attribute
13.2.2.2.1.7 StartupControl Attribute
13.2.2.2.1.8 TrustCenterAddress Attribute
13.2.2.2.1.9 TrustCenterMasterKey Attribute
13.2.2.2.1.10 NetworkKey Attribute
13.2.2.2.1.11 UseInsecureJoin Attribute
13.2.2.2.1.12 PreconfiguredLinkKey Attribute
13.2.2.2.1.13 NetworkKeySeqNum Attribute
13.2.2.2.1.14 NetworkKeyType Attribute
13.2.2.2.1.15 NetworkManagerAddress Attribute
13.2.2.2.2 Join Parameters Attribute Set
13.2.2.2.2.1 ScanAttempts Attribute
13.2.2.2.2.2 TimeBetweenScans Attribute
13.2.2.2.2.3 RejoinInterval Attribute
13.2.2.2.2.4 MaxRejoinInterval Attribute
13.2.2.2.3 End Device Parameters Attribute Set
13.2.2.2.3.1 IndirectPollRate Attribute
13.2.2.2.3.2 ParentRetryThreshold Attribute
13.2.2.2.4 Concentrator Parameters Attribute Set
13.2.2.2.4.1 ConcentratorFlag Attribute
13.2.2.2.4.2 ConcentratorRadius Attribute
13.2.2.2.4.3 ConcentratorDiscoveryTime Attribute
13.2.2.3 Commands Received
13.2.2.3.1 Restart Device Command
13.2.2.3.1.1 Payload Format
13.2.2.3.1.2 Effect on Receipt
13.2.2.3.2 Save Startup Parameters Command
13.2.2.3.2.1 Payload Format
13.2.2.3.2.2 Effect on Receipt
13.2.2.3.3 Restore Startup Parameters Command
13.2.2.3.3.1 Payload Format
13.2.2.3.3.2 Effect on Receipt
13.2.2.3.4 Reset Startup Parameters Command
13.2.2.3.4.1 Payload Format
13.2.2.3.4.2 Effect on Receipt
13.2.2.4 Commands Generated
13.2.2.4.1 Payload Format
13.2.2.4.2 Effect on Receipt
13.2.3 Client
13.2.3.1 Dependencies
13.2.3.2 Attributes
13.2.3.3 Commands Received
13.2.3.4 Commands Generated
13.2.4 Commissioning EUI-64s
13.2.4.1 Global Commissioning EPID
13.2.4.2 EUI-64s Reserved for Other Uses
13.3 Touchlink Commissioning
13.3.1 Overview
13.3.1.1 Revision History
13.3.1.2 Classification
13.3.1.3 Cluster Identifiers
13.3.2 Server
13.3.2.1 Attributes
13.3.2.2 Commands Received
13.3.2.2.1 Scan Request Command Frame
13.3.2.2.1.1 Inter-PAN Transaction Identifier Field
13.3.2.2.1.2 ZigBee Information Field
13.3.2.2.1.3 Touchlink information field
13.3.2.2.2 Device Information Request Command Frame
13.3.2.2.2.1 Inter-PAN Transaction Identifier Field
13.3.2.2.2.2 Start Index Field
13.3.2.2.3 Identify Request Command Frame
13.3.2.2.3.1 Inter-PAN Transaction Identifier Field
13.3.2.2.3.2 Identify Duration Field
13.3.2.2.4 Reset to Factory New Request Command Frame
13.3.2.2.4.1 Inter-PAN Transaction Identifier Field
13.3.2.2.5 Network Start Request Command Frame
13.3.2.2.5.1 Inter-PAN Transaction Identifier Field
13.3.2.2.5.2 Extended PAN Identifier Field
13.3.2.2.5.3 Key Index Field
13.3.2.2.5.4 Encrypted Network Key Field
13.3.2.2.5.5 Logical Channel Field
13.3.2.2.5.6 PAN Identifier Field
13.3.2.2.5.7 Network Address Field
13.3.2.2.5.8 Group Identifiers Begin Field
13.3.2.2.5.9 Group Identifiers End Field
13.3.2.2.5.10 Free Network Address Range Begin Field
13.3.2.2.5.11 Free Network Address Range End Field
13.3.2.2.5.12 Free Group Identifier Range Begin Field
13.3.2.2.5.13 Free Group Identifier Range End Field
13.3.2.2.5.14 Initiator IEEE Address
13.3.2.2.5.15 Initiator Network Address Field
13.3.2.2.6 Network Join Router Request Command Frame
13.3.2.2.6.1 Inter-PAN Transaction Identifier Field
13.3.2.2.6.2 Extended PAN Identifier Field
13.3.2.2.6.3 Key Index Field
13.3.2.2.6.4 Encrypted Network Key Field
13.3.2.2.6.5 Network Update Identifier Field
13.3.2.2.6.6 Logical Channel Field
13.3.2.2.6.7 PAN Identifier Field
13.3.2.2.6.8 Network Address Field
13.3.2.2.6.9 Group Identifiers Begin Field
13.3.2.2.6.10 Group Identifiers End Field
13.3.2.2.6.11 Free Network Address Range Begin Field
13.3.2.2.6.12 Free Network Address Range End Field
13.3.2.2.6.13 Free Group Identifier Range Begin Field
13.3.2.2.6.14 Free Group Identifier Range End Field
13.3.2.2.7 Network Join End Device Request Command Frame
13.3.2.2.7.1 Inter-PAN Transaction Identifier Field
13.3.2.2.7.2 Extended PAN Identifier Field
13.3.2.2.7.3 Key Index Field
13.3.2.2.7.4 Encrypted Network Key Field
13.3.2.2.7.5 Network Update Identifier Field
13.3.2.2.7.6 Logical Channel Field
13.3.2.2.7.7 PAN Identifier Field
13.3.2.2.7.8 Network Address Field
13.3.2.2.7.9 Group Identifiers Begin Field
13.3.2.2.7.10 Group Identifiers End Field
13.3.2.2.7.11 Free Network Address Range Begin Field
13.3.2.2.7.12 Free Network Address Range End Field
13.3.2.2.7.13 Free Group Identifier Range Begin Field
13.3.2.2.7.14 Free Group Identifier Range End Field
13.3.2.2.8 Network Update Request Command Frame
13.3.2.2.8.1 Inter-PAN Transaction Identifier Field
13.3.2.2.8.2 Extended PAN Identifier Field
13.3.2.2.8.3 Network Update Identifier Field
13.3.2.2.8.4 Logical Channel Field
13.3.2.2.8.5 PAN Identifier Field
13.3.2.2.8.6 Network Address Field
13.3.2.2.9 Get Group Identifiers Request Command
13.3.2.2.9.1 Start Index Field
13.3.2.2.10 Get Endpoint List Request Command
13.3.2.2.10.1 Start Index Field
13.3.2.3 Commands Generated
13.3.2.3.1 Scan Response Command Frame
13.3.2.3.1.1 Inter-PAN Transaction Identifier Field
13.3.2.3.1.2 RSSI Correction Field
13.3.2.3.1.3 ZigBee Information Field
13.3.2.3.1.4 Touchlink Information Field
13.3.2.3.1.5 Key Bitmask Field
13.3.2.3.1.6 Response Identifier Field
13.3.2.3.1.7 Extended PAN Identifier Field
13.3.2.3.1.8 Network Update Identifier Field
13.3.2.3.1.9 Logical Channel Field
13.3.2.3.1.10 PAN Identifier Field
13.3.2.3.1.11 Network Address Field
13.3.2.3.1.12 Number of Sub-devices Field
13.3.2.3.1.13 Total Group Identifiers Field
13.3.2.3.1.14 Endpoint Identifier Field
13.3.2.3.1.15 Profile Identifier Field
13.3.2.3.1.16 Device Identifier Field
13.3.2.3.1.17 Version Field
13.3.2.3.1.18 Group Identifier Count Field
13.3.2.3.2 Device Information Response Command Frame
13.3.2.3.2.1 Inter-PAN Transaction Identifier Field
13.3.2.3.2.2 Number of Sub-devices Field
13.3.2.3.2.3 Start Index Field
13.3.2.3.2.4 Device Information Record Count Field
13.3.2.3.2.5 IEEE Address Field
13.3.2.3.2.6 Endpoint Identifier Field
13.3.2.3.2.7 Profile Identifier
13.3.2.3.2.8 Device Identifier Field
13.3.2.3.2.9 Version Field
13.3.2.3.2.10 Group Identifier Count Field
13.3.2.3.2.11 Sort Field
13.3.2.3.3 Network Start Response Command Frame
13.3.2.3.3.1 Inter-PAN Transaction Identifier Field
13.3.2.3.3.2 Status Field
13.3.2.3.3.3 Extended PAN Identifier Field
13.3.2.3.3.4 Network Update Identifier Field
13.3.2.3.3.5 Logical Channel Field
13.3.2.3.3.6 PAN Identifier Field
13.3.2.3.4 Network Join Router Response Command Frame
13.3.2.3.4.1 Inter-PAN Transaction Identifier Field
13.3.2.3.4.2 Status Field
13.3.2.3.5 Network Join End Device Response Command Frame
13.3.2.3.5.1 Transaction Identifier Field
13.3.2.3.5.2 Status Field
13.3.2.3.6 Endpoint Information Command
13.3.2.3.6.1 IEEE Address Field
13.3.2.3.6.2 Network Address Field
13.3.2.3.6.3 Endpoint Identifier Field
13.3.2.3.6.4 Profile Identifier Field
13.3.2.3.6.5 Device Identifier Field
13.3.2.3.6.6 Version Field
13.3.2.3.7 Get Group Identifiers Response Command
13.3.2.3.7.1 Total Field
13.3.2.3.7.2 Start Index Field
13.3.2.3.7.3 Count Field
13.3.2.3.7.4 Group Information Record List Field
13.3.2.3.8 Get Endpoint List Response Command
13.3.2.3.8.1 Total Field
13.3.2.3.8.2 Start Index Field
13.3.2.3.8.3 Count Field
13.3.2.3.8.4 Network Address Field
13.3.2.3.8.5 Endpoint Identifier Field
13.3.2.3.8.6 Profile Identifier Field
13.3.2.3.8.7 Device Identifier Field
13.3.2.3.8.8 Version Field
13.3.3 Client
13.3.3.1 Attributes
13.3.3.2 Commands Received
13.3.3.3 Commands Generated
13.3.4 Functional Description
13.3.4.1 Profile Identifier
13.3.4.2 Constants
13.3.4.3 Attributes
13.3.4.3.1 aplFreeNwkAddrRangeBegin Attribute
13.3.4.3.2 aplFreeNwkAddrRangeEnd Attribute
13.3.4.3.3 aplFreeGroupIDRangeBegin Attribute
13.3.4.3.4 aplFreeGroupIDRangeEnd Attribute
13.3.4.4 Device Information Table
13.3.4.4.1 IEEE Address Field
13.3.4.4.2 Endpoint Identifier Field
13.3.4.4.3 Profile Identifier Field
13.3.4.4.4 Device Identifier Field
13.3.4.4.5 Device Version Field
13.3.4.4.6 Number of Group Identifiers Field
13.3.4.4.7 Sort Tag Field
13.3.4.5 Inter-PAN frame format
13.3.4.6 Inter-PAN Transaction Identifier
13.3.4.7 Commissioning Scenarios
13.3.4.8 Address Assignment
13.3.4.8.1 Network Address Assignment
13.3.4.8.2 Group Identifier Assignment
13.3.4.9 Network Update
13.3.4.9.1 Initiator Procedure
13.3.4.9.2 Target Procedure
13.3.4.10 Frequency Agility
13.3.4.11 Security
13.3.4.11.1 Transferring the Network Key during Touchlink Commissioning
13.3.4.11.2 Transferring the Network Key during Classical ZigBee Commissioning
13.3.4.11.3 ZigBee Settings
13.3.4.11.4 Key Index 0
13.3.4.11.5 Key Index 4 and 15
13.3.4.11.5.1 Key Usage
13.3.4.11.5.1.1 Master Key (key index 4)
13.3.4.11.5.1.2 Certification Key (key index 15)
13.3.4.11.5.2 Algorithm
13.3.4.11.5.2.1 Encrypting Network Keys for Touchlink Initiator
13.3.4.11.5.2.2 Decrypting network keys for touchlink target
13.3.4.11.5.2.3 Calculations Required for the Encryption/Decryption of the Network Key
13.3.4.11.6 Touchlink Security Test Vectors
13.3.4.11.6.1 Touchlink initiator operation
13.3.4.11.6.2 Touchlink target operation
Chapter 14 Retail
14.1 General Description
14.1.1 Introduction
14.1.2 Cluster List
14.2 Retail Tunnel (MSP Tunnel)
14.2.1 Overview
14.2.1.1 Revision History
14.2.1.2 Classification
14.2.1.3 Cluster Identifiers
14.2.2 Server
14.2.2.1 Dependencies
14.2.2.2 Attributes
14.2.2.2.1 ManufacturerCode Attribute
14.2.2.2.2 MSProfile Attribute
14.2.2.3 Commands Received
14.2.2.3.1 Transfer APDU Command
14.2.2.3.1.1 Payload Format
14.2.2.3.1.2 APDU Field
14.2.2.3.1.3 When Generated
14.2.2.3.1.4 Effect on Receipt
14.2.2.4 Commands Generated
14.2.3 Client
14.3 Mobile Device Configuration
14.3.1 Overview
14.3.1.1 Revision History
14.3.1.2 Classification
14.3.1.3 Cluster Identifiers
14.3.2 Server
14.3.2.1 Dependencies
14.3.2.2 Attributes
14.3.2.2.1 KeepAliveTime Attribute
14.3.2.2.2 RejoinTimeout Attribute
14.3.2.3 Commands Received
14.3.2.4 Commands Generated
14.3.2.4.1 Keep Alive Notification Command
14.3.2.4.1.1 Payload Format
14.3.2.4.1.1.1 KeepAliveTime Field
14.3.2.4.1.1.2 RejoinTimeout Field
14.3.2.4.1.2 When Generated
14.3.2.4.1.3 Effect on Receipt
14.3.3 Client
14.4 Neighbor Cleaning
14.4.1 Overview
14.4.1.1 Revision History
14.4.1.2 Classification
14.4.1.3 Cluster Identifiers
14.4.2 Server
14.4.2.1 Dependencies
14.4.2.2 Attributes
14.4.2.2.1 NeighborCleaningTimeout Attribute
14.4.2.3 Commands Received
14.4.2.3.1 PurgeEntries Command
14.4.2.3.1.1 Payload Format
14.4.2.3.1.2 When Generated
14.4.2.3.1.3 Effect on Receipt
14.4.2.4 Commands Generated
14.4.3 Client
14.5 Nearest Gateway
14.5.1 Overview
14.5.1.1 Revision History
14.5.1.2 Classification
14.5.1.3 Cluster Identifiers
14.5.2 Server
14.5.2.1 Dependencies
14.5.2.2 Attributes
14.5.2.2.1 Nearest Gateway Attribute
14.5.2.2.2 New Mobile Node Attribute
14.5.2.3 Commands Received
14.5.2.4 Commands Generated
14.5.3 Client
14.5.4 Examples of Use
Chapter 15 Appliance
15.1 General Description
15.1.1 Introduction
15.1.2 Cluster List
15.2 EN50523 Appliance Control
15.2.1 Overview
15.2.1.1 Revision History
15.2.1.2 Classification
15.2.1.3 Cluster Identifiers
15.2.2 General Description
15.2.3 Server Attributes
15.2.3.1 Appliance Functions Attribute Set
15.2.3.2 StartTime Attribute
15.2.3.3 FinishTime Attribute
15.2.3.4 RemainingTime Attribute
15.2.4 Server Commands Received
15.2.4.1 Execution of a Command
15.2.4.1.1 Payload Format
15.2.4.1.1.1 Payload Details
15.2.4.1.2 Effects on Receipt
15.2.4.2 Signal State Command
15.2.4.2.1 Effects on Receipt
15.2.4.3 Write Functions Command
15.2.4.3.1 Payload Format
15.2.4.3.2 Payload Details
15.2.4.3.3 Effects on Receipt
15.2.4.4 Overload Pause Resume Command
15.2.4.4.1 Payload Format
15.2.4.4.2 Effects on Receipt
15.2.4.5 Overload Pause Command
15.2.4.5.1 Payload Format
15.2.4.5.2 Effects on Receipt
15.2.4.6 Overload Warning Command
15.2.4.6.1 Payload Format
15.2.4.6.2 Payload Details
15.2.4.6.3 Effects on Receipt
15.2.5 Server Commands Generated
15.2.5.1 Signal State Response Command
15.2.5.1.1 Payload Format
15.2.5.1.1.1 Payload Details
15.2.5.1.2 Effect on Receipt
15.2.5.2 Signal State Notification Command
15.2.5.2.1 Payload Format
15.2.5.2.2 Effects on Receipt
15.2.6 Client
15.3 EN50523 Appliance Identification
15.3.1 Overview
15.3.1.1 Revision History
15.3.1.2 Classification
15.3.1.3 Cluster Identifiers
15.3.2 Server
15.3.2.1 Attributes
15.3.2.2 Basic Appliance Identification Attribute Set
15.3.2.3 BasicIdentification Attribute
15.3.2.4 Extended Appliance Identification Attribute Set
15.3.2.5 CompanyName Attribute
15.3.2.6 CompanyID Attribute
15.3.2.7 BrandName Attribute
15.3.2.8 BrandID Attribute
15.3.2.9 Model Attribute
15.3.2.10 PartNumber Attribute
15.3.2.11 ProductRevision Attribute
15.3.2.12 SoftwareRevision Attribute
15.3.2.13 ProductTypeName Attribute
15.3.2.14 ProductTypeID Attribute
15.3.2.15 CECEDSpecificationVersion Attribute
15.3.2.16 Commands Received
15.3.2.17 Commands Generated
15.3.3 Client
15.4 EN50523 Appliance Events and Alerts
15.4.1 Overview
15.4.1.1 Revision History
15.4.1.2 Classification
15.4.1.3 Cluster Identifiers
15.4.2 Server
15.4.2.1 Attributes
15.4.2.2 Commands Received
15.4.2.2.1 Get Alerts Command
15.4.2.2.1.1 Payload Format
15.4.2.2.1.2 Effects on Receipt
15.4.2.3 Commands Generated
15.4.2.3.1 Get Alerts Response Command
15.4.2.3.1.1 Payload Format
15.4.2.3.1.1.1 Payload Details
15.4.2.3.1.2 Effects on Receipt
15.4.2.3.2 Alerts Notification Command
15.4.2.3.2.1 Payload Format
15.4.2.3.2.1.1 Payload Details
15.4.2.3.2.2 Effects on Receipt
15.4.2.3.3 Event Notification Command
15.4.2.3.3.1 Payload Format
15.4.2.3.3.1.1 Payload Details
15.4.2.3.3.2 Effects on Receipt
15.4.3 Client
15.5 Appliance Statistics
15.5.1 Overview
15.5.1.1 Revision History
15.5.1.2 Classification
15.5.1.3 Cluster Identifiers
15.5.2 Server
15.5.2.1 Attributes
15.5.2.1.1 LogMaxSize Attribute
15.5.2.1.2 LogQueueMaxSize Attribute
15.5.2.2 Commands
15.5.2.2.1 Log Notification
15.5.2.2.1.1 Payload Format
15.5.2.2.1.2 When Generated
15.5.2.2.1.3 Effect Upon Receipt
15.5.2.2.2 Log Response
15.5.2.2.2.1 Payload Format
15.5.2.2.2.2 When Generated
15.5.2.2.2.3 Effect Upon Receipt
15.5.2.2.3 Log Queue Response
15.5.2.2.3.1 Payload Format
15.5.2.2.3.2 When Generated
15.5.2.2.3.3 Effect Upon Receipt
15.5.2.2.4 Statistics Available
15.5.2.2.4.1 Payload Format
15.5.2.2.4.2 When Generated
15.5.2.2.4.3 Effect Upon Receipt
15.5.3 Client
15.5.3.1 Attributes
15.5.3.2 Commands
15.5.3.2.1 Log Request
15.5.3.2.1.1 Payload Format
15.5.3.2.1.2 When Generated
15.5.3.2.1.3 Effect Upon Receipt
15.5.3.2.2 Log Queue Request
15.5.3.2.2.1 Payload Format
15.5.4 Appliance Statistics Cluster Sequence Diagram
Zigbee Cluster Library Specification
Chapter Document 14-0125
Cluster Library 07-5123 Revision 7
Zigbee Document 075123
Date of release
Feb 2018
Sponsored by
Zigbee Alliance
1
2
3
4
5
6
7
8
9
10
11
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
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.
Zigbee Cluster Library Specification
Zigbee Document – 075123
Notice of Use and Disclosure
Copyright © Zigbee Alliance, Inc. (1996-2018). All rights Reserved. This information within this document is the
property of the Zigbee Alliance and its use and disclosure are restricted.
Elements of Zigbee Alliance specifications may be subject to third party intellectual property rights, including without
limitation, patent, copyright or trademark rights (such a third party may or may not be a member of Zigbee). Zigbee
is not responsible and shall not be held responsible in any manner for identifying or failing to identify any or all such
third party intellectual property rights.
No right to use any Zigbee name, logo or trademark is conferred herein. Use of any Zigbee name, logo or trademark
requires membership in the Zigbee Alliance and compliance with the Zigbee Logo and Trademark Policy and related
Zigbee policies.
This document and the information contained herein are provided on an “AS IS” basis and Zigbee DISCLAIMS ALL
WARRANTIES EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO (A) ANY WARRANTY THAT
THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OF THIRD PARTIES
(INCLUDING WITHOUT LIMITATION ANY INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT,
COPYRIGHT OR TRADEMARK RIGHTS) OR (B) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE OR NONINFRINGEMENT. IN NO EVENT WILL ZIGBEE
BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF BUSINESS, LOSS OF USE OF DATA, INTERRUPTION
OF BUSINESS, OR FOR ANY OTHER DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTIAL,
PUNITIVE OR CONSEQUENTIAL DAMAGES OF ANY KIND, IN CONTRACT OR IN TORT, IN
CONNECTION WITH THIS DOCUMENT OR THE INFORMATION CONTAINED HEREIN, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. All Company, brand and product names may
be trademarks that are the sole property of their respective owners.
The above notice and this paragraph must be included on all copies of this document that are made.
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Page 2
Copyright 2007-2018, The Zigbee Alliance. All rights reserved.
Participants
Zigbee Cluster Library Specification
Zigbee Document – 075123
The following is a list of Zigbee members who contributed to this document:
Cam Williams - Chair of the Foundation Working Group and ZCL Editor
36
37
38
Rob Alexander
Shane Almeida
Casey Anderson
Skip Ashton
Wally Barnum
Alex Chu
Ettore Colicchio
Jeff Cooper
Damon Corbin
John Cowburn
Robert Cragie
Jonathan Cressman
Tim Gillman
Drew Gislason
Ezra Hale
Jesper Haee
Robert Hall
Jon Harros
Jim Hartman
Arasch Honarbacht
Ted Humpal
Phil Jamieson
William Keith
Larry Kohrmann
Tom Klein
John Knuth
Cristian Kuster
Zin Kyaw
Gary Lee
Jared Lemke
Christopher Leidigh
Yingbo Li
Marco Naeve
Juan Agui Martin
Christian P. Garcia
Jeff Mathews
Tony Mauro
Leslie Mulder
Luca Negri
Ivan O’Neill
Isaac Pinhas
Andrea Ranalli
Jonas Riska
Zachary Smith
Robby Simpson
Sumit Singh
David Smith
Matt Smith
Michael Stuber
Don Sturek
Mads Westergreen
Urban Wicklander
Cam Williams
Ian Winterburn
Kenny York
Walter Young
Juan Agui Martin
Jeff Mathews
39
Copyright 2007-2018, The Zigbee Alliance. All rights reserved.
Page 3
40
41
42
43
44
Zigbee Cluster Library Specification
Zigbee Document – 075123
Document Control
The Zigbee Cluster Library is made of individual chapters such as this one. See Chapter 1 for the list of all chapters.
References between chapters are made using a X.Y notation where X is the chapter and Y is the sub-section within that
chapter. References to external documents are contained in Chapter 1 and are made using [Rn] notation.
An update to any of these chapters will be reflected in an update to the source document list below.
Chapter 1 – Introduction
Chapter 2 – Foundation
Chapter 3 – General
Document 14-0125-13
Document 14-0126-16
Document 14-0127-20
Chapter 4 – Measurement and Sensing
Document 14-0128-11
Chapter 5 – Lighting
Chapter 6 – HVAC
Chapter 7 – Closures
Chapter 8 – Security and Safety
Chapter 9 – Protocol Interfaces
Chapter 10 – Smart Energy
Chapter 11 – Over the Air Upgrades
Chapter 12 – Telecommunications
Chapter 13 – Commissioning
Chapter 14 – Retail Services
Chapter 15 – Appliances
Document 14-0129-15
Document 14-0130-12
Document 14-0131-15
Document 14-0132-13
Document 14-0133-08
Document 14-0134-11
Document 14-0135-15
Document 14-0136-10
Document 14-0137-13
Document 14-0138-08
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
Page 4
Copyright 2007-2018, The Zigbee Alliance. All rights reserved.
Zigbee Cluster Library Specification
Zigbee Document – 075123
46
Document History
Rev
Date
Comments
00
01
02
03
11-Jul-2007
Document created
19-Oct-2007
First release
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
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
18-Sep-2009
• 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
Made minor changes and clarifications re the following CCBs
24-Dec-2009
•
960, 1001, 1004, 1061, 1097.
• Added Door Lock cluster.
Updated Occupancy Sensor re CCB comments 1092, 1093, 1094
CCB 1174: Fixed references
04
2010
CCB 1176: Added new status codes
CCB 1202: Corrected default value in thermostat cluster
Apr-2012
CCB 1381: Default Response clarification
Copyright 2007-2018, The Zigbee Alliance. All rights reserved.
Page 5
Zigbee Cluster Library Specification
Zigbee Document – 075123
Rev
Date
Comments
05
18-Mar-2015
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
Move to individual chapters
Added all approved Clusters from other Application Specifications
Included CCBs
Editorial cleanup of document
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
06
14-Jan-2016
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
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
07
Jan-2018
Page 6
Copyright 2007-2018, The Zigbee Alliance. All rights reserved.
Zigbee Cluster Library Specification
Zigbee Document – 075123
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
Copyright 2007-2018, The Zigbee Alliance. All rights reserved.
Page 7
Zigbee Cluster Library Specification
Zigbee Document – 075123
TABLE OF CONTENTS
Zigbee Cluster Library Specification .............................................................................................1
Notice of Use and Disclosure ..............................................................................................................2
Participants.........................................................................................................................................3
Document Control ..............................................................................................................................4
Document History ..............................................................................................................................5
49
50
51
52
53
54
55
Table of Contents ......................................................................................................................................8
56
List of Figures ......................................................................................................................................... 19
57
List of Tables .......................................................................................................................................... 28
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
Chapter 1
Introduction ...................................................................................................................... 1-1
1.1 Scope and Purpose ................................................................................................................. 1-1
1.2 Acronyms and Abbreviations ................................................................................................. 1-1
1.3 Definitions ............................................................................................................................. 1-4
1.4 Conformance Levels .............................................................................................................. 1-5
1.5 References ............................................................................................................................. 1-5
1.5.1 Zigbee Alliance Documents........................................................................................ 1-5
1.5.2
International Standards Documents............................................................................. 1-5
1.5.3 National Standards Documents ................................................................................... 1-6
1.5.4
IEEE Documents ........................................................................................................ 1-6
1.5.5 ASHRAE Documents ................................................................................................. 1-6
1.5.6 Health Care Documents .............................................................................................. 1-6
1.5.7 Other Documents ....................................................................................................... 1-7
1.6 Conventions ........................................................................................................................... 1-7
1.6.1 Enumerations and Reserved Values ............................................................................ 1-7
1.6.2 Reserved Bit Fields .................................................................................................... 1-7
1.6.3 Number Format .......................................................................................................... 1-7
1.7 Testing, Validation and Certification ...................................................................................... 1-8
Chapter 2
Foundation........................................................................................................................ 2-1
2.1 Scope and Purpose ................................................................................................................. 2-1
2.2 Cluster Library Overview ....................................................................................................... 2-1
2.2.1 Architecture and Data Model ...................................................................................... 2-1
2.2.2 Client/Server Model ................................................................................................... 2-2
2.3 Functional Description ........................................................................................................... 2-3
2.3.1 Transmission .............................................................................................................. 2-3
2.3.2 Reception ................................................................................................................... 2-3
2.3.3 Manufacturer Specific Extensions .............................................................................. 2-4
2.3.4 Attributes ................................................................................................................... 2-5
2.3.5 Persistent Data ........................................................................................................... 2-7
2.4 Command Frame Formats ...................................................................................................... 2-7
2.4.1 General ZCL Frame Format ....................................................................................... 2-7
2.5 General Command Frames ..................................................................................................... 2-9
2.5.1 Read Attributes Command ........................................................................................2-10
2.5.2 Read Attributes Response Command .........................................................................2-11
2.5.3 Write Attributes Command........................................................................................2-13
2.5.4 Write Attributes Undivided Command .......................................................................2-15
2.5.5 Write Attributes Response Command ........................................................................2-15
2.5.6 Write Attributes No Response Command...................................................................2-16
2.5.7 Configure Reporting Command .................................................................................2-17
2.5.8 Configure Reporting Response Command .................................................................2-20
Page 8
Copyright 2007-2018, The Zigbee Alliance. All rights reserved.
相关推荐
2023年江西萍乡中考道德与法治真题及答案.doc
2012年重庆南川中考生物真题及答案.doc
2013年江西师范大学地理学综合及文艺理论基础考研真题.doc
2020年四川甘孜小升初语文真题及答案I卷.doc
2020年注册岩土工程师专业基础考试真题及答案.doc
2023-2024学年福建省厦门市九年级上学期数学月考试题及答案.doc
2021-2022学年辽宁省沈阳市大东区九年级上学期语文期末试题及答案.doc
2022-2023学年北京东城区初三第一学期物理期末试卷及答案.doc
2018上半年江西教师资格初中地理学科知识与教学能力真题及答案.doc
2012年河北国家公务员申论考试真题及答案-省级.doc
2020-2021学年江苏省扬州市江都区邵樊片九年级上学期数学第一次质量检测试题及答案.doc
2022下半年黑龙江教师资格证中学综合素质真题及答案.doc
