25.06.00

MCUXpresso SDK Project v: latest

Document Release Versions: 25.06.00; 25.06.00-pvw2; 25.06.00-pvw1; 25.03.00; 25.03.00-pvw2; latest

Introduction

MCUXPresso SDK

Getting Started

Github Repository
Zip Package

User Guide

Drivers
Examples
Middleware
RTOS
Boards

Development

Build And Configuration System
Developing with MCUXpresso SDK

Releases

Release Notes

mcuxsdk

Docs / 25.06.00 »
Middleware »
Wireless »
NXP Wireless Framework and Stacks »
Wireless Zigbee »
JNUG3132
Open on Repo Report an issue with this page

JNUG3132

Table of Contents

Preface
- Introduction
- Prerequisites
- Chip Compatibility
- Organization
- Conventions
- Acronyms
- Related Documents
- Support Resources
Part I: Fundamentals
ZigBee Cluster Library (ZCL)
- ZCL Member Clusters
- General ZCL Resources
- ZCL Compile-time Options
ZCL Fundamentals and Features
- Initializing the ZCL
- Shared Device Structures
- Accessing Attributes
- Global Attributes
  - ClusterRevision
  - AttributeReportingStatus
- Default Responses
- Handling Commands for Unsupported Clusters
- Handling Commands from Other Manufacturers
- Bound Transmission Management
  - Compile-time Options
- Command Discovery
  - Discovering Command Sets
    - Discovering commands that can be received
    - Discovering commands that can be generated
  - Compile-time Options
Event Handling
- Event Structure
- Processing Events
- Events
Error Handling
- Last Stack Error
- Error/Command Status on Receiving Command
Part II: Common Resources
ZCL Functions
- General Functions
- Attribute Access Functions
- Command Discovery Functions
  - eZCL_SendDiscoverCommandReceivedRequest
  - eZCL_SendDiscoverCommandGeneratedRequest
ZCL Structures
- General Structures
- Event Structure (tsZCL_CallBackEvent)
Enumerations and Status Codes
- General Enumerations
- General Return codes (ZCL Status)
- ZCL Event Enumerations
Part III: General Clusters
Basic Cluster
- Overview
- Basic Cluster structure and attributes
- Mandatory Attribute Settings
- Functions
  - eCLD_BasicCreateBasic
  - eCLD_BasicCommandResetToFactoryDefaultsSend
- Enumerations
- Compile-time options
Power Configuration Cluster
- Overview
- Power Configuration Cluster structure and attributes
- Attributes for Default Reporting
- Functions
  - eCLD_PowerConfigurationCreatePowerConfiguration
- Enumerations and Defines
- Compile-time options
  - Optional Attributes
  - Global Attributes
Device Temperature Configuration Cluster
Identify Cluster
- Overview
- Identify Cluster Structure and Attribute
- Initialization
- Sending Commands
- Sleeping Devices in Identification Mode
- Functions
- Structures
- Enumerations
  - teCLD_Identify_ClusterID
- Compile-time options
Groups Cluster
- Overview
- Groups Cluster structure and attributes
- Initialization
- Sending Commands
- Functions
- Structures
- Enumerations
  - teCLD_Groups_ClusterID
- Compile-time Options
Scenes Cluster
- Overview
- Scenes Cluster structure and attributes
- Initialization
- Sending Remote Commands
- Issuing Local Commands
  - Creating a Scene
  - Applying a Scene
- Functions
- Structures
- Enumerations
  - teCLD_Scenes_ClusterID
- Compile-time options
On/Off Cluster
- Overview
- On/Off Cluster Structure and Attribute
- Attributes for Default Reporting
- Initialization
- Sending Commands
- Saving Light Settings
- Functions
- Structures
  - Custom Data Structure
  - Custom Command Payloads
    - Off With Effect Request Payload
    - On With Timed Off Request Payload
- Enumerations
- Compile-time options
On/Off Switch Configuration Cluster
- Overview
- On/Off Switch Config Cluster Structure and Attribute
- Initialisation
- Functions
  - eCLD_OOSCCreateOnOffSwitchConfig
- Enumerations
- Compile-time options
Level Control Cluster
- Overview
- Level Control Cluster structure and attributes
- Attributes for Default Reporting
- Initialization
- Sending Remote Commands
  - Changing Level
  - Stopping a Level Change
- Issuing Local Commands
  - Setting Level
  - Obtaining Level
- Functions
- Structures
- Enumerations
- Compile-time options
  - Optional Attributes
  - Global Attributes
Alarms Cluster
- Overview
- Alarms Cluster structure and attributes
- Initialization
- Alarm Operations
  - Raising an Alarm
  - Resetting Alarms (from Client)
- Alarms Events
- Functions
- Structures
- Enumerations
  - teCLD_Alarms_AttributeID
Time Cluster and ZCL Time
- Overview
  - Time Attribute
  - ZCL Time
- Time Cluster structure and attributes
- Attribute Settings
  - Mandatory Attributes
    - utctTime
    - u8TimeStatus
  - Optional Attributes
- Maintaining ZCL Time
  - Updating ZCL Time Following Sleep
  - ZCL Time Synchronization
- Time-Synchronization of Devices
- Time Event
- Functions
- Return codes
- Enumerations
  - teCLD_TM_AttributeID
- Compile-time Options
Input and Output Clusters
- Analogue Input (Basic)
- Analogue Output (Basic)
- Binary Input (Basic) Cluster
- Binary Output (Basic)
- Multistate Input (Basic)
- Multistate Output (Basic)
Poll Control Cluster
- Overview
- Cluster structure and attributes
- Attribute Settings
- Poll Control Operations
- Poll Control Events
- Functions
- Return codes
- Enumerations
  - ‘Attribute ID’ enumerations
  - ‘Command’ Enumerations
- Structures
- Compile-time Options
Power Profile Cluster
- Overview
- Cluster structure and attributes
- Attributes for default reporting
- Power profiles
- Power profile operations
- Power Profile Events
- Functions
- Return codes
- Enumerations
- Structures
- Compile-time Options
Diagnostics Cluster
- Overview
- Diagnostics Structure and Attributes
- Functions
  - eCLD_DiagnosticsCreateDiagnostics
  - eCLD_DiagnosticsUpdate
- Enumerations
  - teCLD_Diagnostics_AttributeId
- Compile-time Options
  - Optional Attributes
  - Global Attributes
Part IV: Measurement and Sensing Clusters
Illuminance Measurement Cluster
- Overview
- Illuminance Measurement Structure and Attributes
- Attributes for Default Reporting
- Functions
  - eCLD_IlluminanceMeasurementCreateIlluminanceMeasurement
- Enumerations
  - teCLD_IM_ClusterID
- Compile-time options
  - Optional Attributes
  - Global Attributes
Illuminance Level Sensing Cluster
Temperature Measurement Cluster
- Overview
- Temperature Measurement Structure and Attributes
- Attributes for Default Reporting
- Functions
  - eCLD_TemperatureMeasurementCreateTemperatureMeasurement
- Enumerations
  - teCLD_TemperatureMeasurement_AttributeID
- Compile-time Options
  - Optional Attribute
  - Global Attributes
Pressure Measurement Cluster
- Overview
- Cluster structure and attributes
  - ‘Pressure Measurement Information’ Attribute Set
  - Global Attributes
- Initialization and Operation
- Pressure Measurement Events
- Functions
  - eCLD_PressureMeasurementCreatePressureMeasurement
- Return codes
- Enumerations
  - ‘Attribute ID’ Enumerations
- Structures
- Compile-time Options
  - Optional Attributes
  - Global Attributes
Flow Measurement Cluster
- Overview
- Cluster structure and attributes
  - ‘Flow Measurement Information’ Attribute Set
  - Global Attributes
- Initialization and Operation
- Flow Measurement Events
- Functions
  - eCLD_FlowMeasurementCreateFlowMeasurement
- Return codes
- Enumerations
  - ‘Attribute ID’ Enumerations
- Structures
- Compile-time Options
  - Optional Attributes
  - Global Attributes
Relative Humidity Measurement Cluster
- Overview
- RH Measurement Structure and Attributes
- Attributes for Default Reporting
- Functions
  - eCLD_RelativeHumidityMeasurementCreateRelativeHumidityMeasurement
- Enumerations
  - teCLD_RHM_ClusterID
- Compile-time Options
  - Optional Attribute
  - Global Attributes
Occupancy Sensing Cluster
- Overview
- Occupancy Sensing Structure and Attributes
- Attributes for Default Reporting
- Functions
  - eCLD_OccupancySensingCreateOccupancySensing
- Enumerations
  - teCLD_OS_ClusterID
- Compile-time options
  - Optional Attributes
  - Global Attributes
Electrical Measurement Cluster
- Overview
- Cluster structure and attributes
- Initialisation and Operation
- Electrical Measurement Events
- Functions
  - eCLD_ElectricalMeasurementCreateElectricalMeasurement
- Return codes
- Enumerations
  - ‘Attribute ID’ Enumerations
- Structures
- Compile-time options
  - Optional Attributes
  - Global Attributes
Part V: Lighting Clusters
Colour Control Cluster
- Overview
- Colour Control Cluster structure and attributes
- Attributes for Default Reporting
- Initialization
- Sending Commands
- Functions
- Structures
  - Custom Data Structure
  - Custom Command Payloads
- Enumerations
  - teCLD_ColourControl_ClusterID
- Compile-time Options
Ballast Configuration Cluster
Part VI: HVAC Clusters
Thermostat Cluster
- Overview
- Thermostat Cluster structure and attributes
- Attributes for Default Reporting
- Thermostat Operations
- Thermostat Events
  - E_CLD_THERMOSTAT_CMD_SETPOINT_RAISE_LOWER
- Functions
- Return codes
- Enumerations
- Structures
- Compile-time options
Fan Control Cluster
- Overview
- Fan Control Structure and Attributes
- Initialisation
- Functions
  - eCLD_CreateFanControl
- Enumerations
- Compile-time options
Thermostat UI Configuration Cluster
- Overview
- Cluster structure and attributes
- Initialization
- Functions
  - eCLD_ThermostatUIConfigCreateThermostatUIConfig
  - eCLD_ThermostatUIConfigConvertTemp
- Return codes
- Enumerations
- Compile-time Options
Part VII: Closure Clusters
Door Lock Cluster
- Overview
- Door Lock Cluster structure and attributes
- Attributes for Default Reporting
- Door Lock Events
- Functions
- Return codes
- Enumerations
- Structures
  - tsCLD_DoorLockCallBackMessage
  - tsCLD_DoorLock_LockUnlockResponsePayload
- Compile-time options
  - Optional Attributes
  - Global Attributes
Part VIII: Security and Safety Clusters
IAS Zone Cluster
- Overview
- IAS Zone Structure and Attributes
  - ‘Zone Information’ Attribute Set
  - ‘Zone Settings’ Attribute Set
- Enrollment
- IAS Zone Events
- Functions
- Structures
  - Custom Data Structure
  - Custom Command Payloads
- Compile-time options
IAS Ancillary Control Equipment Cluster
- Overview
- IAS ACE Structure and Attributes
- Table and Parameters
- Command Summary
- IAS ACE Events
- Functions
- Structures
- Enumerations
- Compile-time options
IAS Warning Device Cluster
- Overview
- IAS WD Structure and Attribute
- Issuing Warnings
- IAS WD Events
- Functions
- Structures
- Compile-time Options
Part IX: Smart Energy Clusters
Price Cluster
- Overview
- Price cluster structure and attributes
- Attribute settings
- Initializing and maintaining price lists
- Publishing price information
- Time-synchronization via Publish Price commands
- Conversion factor and calorific value (gas only)
  - Initializing Conversion Factors and Calorific Values at Network Startup
- Price events
- Functions
- Return codes
- Structures
- Enumerations
- Compile-time options
Demand-Response and Load Control Cluster
- Overview
- DRLC Cluster structure and attributes
- Initialization
- Load Control Events (LCEs)
  - LCE Contents
  - LCE Lists
- LCE Handling
- Message Signing (Security)
- DRLC Events
  - Event and Command Types
  - Other Elements of tsSE_DRLCCallBackMessage
- Functions
- Return codes
- Enumerations
- Structures
- Compile-time options
Simple Metering Cluster
- Overview
- Simple Metering Cluster structure and attributes
- Attribute Settings
- Remotely Reading Simple Metering Attributes
- Mirroring Metering Data
- Consumption Data Archive (‘Get Profile’)
  - Updating Consumption Data on Server
  - Sending and Handling a ‘Get Profile’ Request
- Simple Metering Events
  - Event Types
  - Command Types
- Functions
- Return codes
- Enumerations
- Structures
- Compile-time options
Part X: Commissioning Clusters
Commissioning Cluster
- Overview
- Commissioning Cluster structure and attributes
- Attribute Settings
- Initialisation
- Commissioning Commands
- Commissioning Events
- Functions
- Enumerations
- Structures
- Compile-time options
  - Optional Attributes
  - Optional Commands
Touchlink Commissioning Cluster
- Overview
- Cluster structure and attributes
- Commissioning operations
- Using Touchlink
- Using the Commissioning Utility
- Touchlink Commissioning events
  - Touchlink command events
  - Commissioning Utility Command Events
- Functions
  - Touchlink functions
  - Commissioning Utility functions
- Structures
- Enumerations
  - Touchlink event enumerations
  - Commissioning utility event enumerations
- Compile-time options
Part XI: Appliances Clusters
Appliance Control Cluster
- Overview
- Cluster structure and attributes
- Attributes for default reporting
- Sending commands
- Appliance control events
- Functions
- Return codes
- Enumerations
- Structures
- Compile-time options
  - Optional attributes
  - Global Attributes
Appliance Identification Cluster
Appliance Events and Alerts Cluster
- Overview
- Cluster structure and attribute
- Sending Messages
- Appliance Events and Alerts Events
- Functions
- Return codes
- Enumerations
  - ‘Command ID’ Enumerations
- Structures
- Compile-time options
  - Maximum Number of Alerts Reported
  - Global Attributes
Appliance Statistics Cluster
- Overview
- Cluster structure and attributes
- Sending messages
- Log Operations on Server
  - Adding and Removing Logs
  - Obtaining Logs
- Appliance statistics events
- Functions
- Return codes
- Enumerations
- Structures
- Compile-time options
Part XII: Over-The-Air Upgrade
OTA Upgrade cluster
- Overview
- OTA Upgrade Images in Internal Flash Memory
- OTA Upgrade Cluster structure and attributes
- Basic Principles
  - OTA Upgrade Cluster Server
  - OTA Upgrade Cluster Client
- Application Requirements
- Initialization
- Implementing OTA Upgrade Mechanism
  - Query Jitter
- Ancillary Features and Resources for OTA Upgrade
- OTA Upgrade events
- Functions
- Structures
- Enumerations
- Compile-time options
- Build Process
- OTA Configuration for Internal Flash
  - Switching to a new image
Part XIII: Appendices
Appendix A: Mutex callbacks
Appendix B: Attribute reporting
- Appendix B.1: Automatic attribute reporting
- Appendix B.2: Default reporting
- Appendix B.3: Configuring attribute reporting
- Appendix B.4: Sending attribute reports
- Appendix B.5: Receiving attribute reports
- Appendix B.6: Querying attribute reporting configuration
- Appendix B.7: Storing an attribute reporting configuration
  - Persisting an attribute reporting configuration
  - Formatting an attribute reporting configuration record
    - Reduced Data Storage
    - Minimized Data Storage
Appendix C: Extended attribute discovery
- Appendix C.1: Compile-time options
- Appendix C.2: Application coding
Appendix D: Custom endpoints
- Appendix D.1: Devices and Endpoints
- Appendix D.2: Cluster Creation Functions
- Appendix D.3: Custom Endpoint Set-up
  - Custom Endpoint Structure
Appendix E: Manufacturer-specific attributes and commands
- Appendix E.1: Adding Manufacturer-specific Attributes
- Appendix E.2: Adding Manufacturer-specific Commands
Appendix F: OTA extension for dual-processor nodes
- Appendix F.1: Application Upgrades for Different Target Processors
- Appendix F.2: Storing Upgrade Images in Co-processor Storage on Server
- Appendix F.3: Use of Image Indices
Appendix G: Glossary
Revision history

Copyright 2025, NXP. Last generated on Jun 26, 2025 11:45+0200; branch release/25.06.00, revision 6130022abfc4696d01915519c9392d84dea6b80f.