(0x05) ZCL Message Frames
This section describes the three ways, unicast, multicast and broadcast, available to the Host to send a ZCL command. In addition, it describes the commands used by the Host to read and write attributes that were previously configured using the ZigBee Support Configurations commands. This section also includes commands sent from the Module to convey responses and statuses from commands previously sent by the Host. It also describes the command used by the Module to pass through ZCL commands that have been registered by the Host using the Register Commands Passthru command.
( PH:0x05, SH:0x00 ) - Send ZCL Unicast Command
Overview
The Send ZCL Unicast command is sent by the Host to the Module in order to transmit a custom ZCL message to a target node. The command provides facilities for configuring the Encryption Level of the message, either with Network or Network + APS Encryption, as well as available Response Options, including custom sequence numbers, requiring an APS ACK or enabling processing of a corresponding response with a matching transaction sequence number.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Destination Node ID | |
2 | Destination Endpoint ID | |
3 | Local Endpoint ID | |
4,5 | Cluster ID | |
6 | Response Options | 8-Bit Bitmap: Bit 0: Custom Sequence Number |
7 | Encryption Level | 0x00 = Network Encryption Only |
8 | Frame Control | 8-Bit Bitmap: Bits 0-1: 00 = ZCL General Command |
9,10 | Manufacturer Code | Applicable if Bit 2 of Frame Control is enabled. |
11 | Transaction Sequence Number | Only used if bit 0 in the Response Options field is set. The Host must apply a number in the range of 0-127. The range 128-255 is reserved for commands generated by the Module. |
12 | Command ID | |
13 | Payload Length | |
14..n | Payload |
Effect on Receipt
The Module will attempt to issue the ZCL message over the network. The status of the transmission and its assigned sequence number will be relayed to the Host via a ZCL Send Status command.
If the Host wishes to know whether the Destination Node has successfully received a message, it should enable reception of APS ACK status messages via the Response Options field. On reception the Module relays these messages to the Host as ZCL APS Ack commands.
If the given message is a request (e.g., Read Attribute Request, Add Group, etc.) and the Host expects a response, it should enable the option to receive a ZCL Response Received command, via the same field. On reception of a message with a matching sequence number, the Module will relay the response to the Host via the ZCL Response Received command. If no response is received within a given interval, the Module will instead issue a ZCL Response Timeout command to the Host.
Allowed Context
Network Up.
Sent By Host/Module
Host.
( PH:0x05, SH:0x01 ) - Send ZCL Multicast Command
Overview
The Send ZCL Multicast command is sent by the Host to the Module in order to prompt the latter to multicast a ZCL Message to a select Group of target devices on the network. Unlike Send ZCL Unicast messages, multicast messages cannot be APS-encrypted; that is, they are encrypted on the Network layer only.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Group ID | The Group ID of the Group to which the target devices belong. |
2 | Local Endpoint ID | |
3,4 | Cluster ID | |
5 | Radius | Number of Network Hops that this message may travel. 0 = Maximum |
6 | Non-Member Radius | Number of Network Hops that this message will be forwarded to by devices not in the target Group. 0x07 or higher indicates an infinite Non-Member Radius. |
7 | Response Options | 8-bit Bitmap: Bit 0: Custom Sequence Number |
8 | Frame Control | 8-bit Bitmap: Bits 0-1: 00 = ZCL General Command |
9,10 | Manufacturer Code | Applicable if Bit 2 of Frame Control is enabled. |
11 | Transaction Sequence Number | Only used if bit 0 in the Response Options field is set. Otherwise, the application ignores this value and automatically assigns the next outgoing sequence number. The Host must apply a number in the range of 0-127. The range 128-255 is reserved for commands generated by the Module. |
12 | Command ID | |
13 | Payload Length | |
14..n | Payload |
Effect on Receipt
The Module will try to transmit the message over the network, for reception and processing by the devices in the target Group. The status of the transmission and its assigned sequence number will be relayed to the Host via a ZCL Send Status command.
Allowed Context
Network Up.
Sent By Host/Module
Host.
( PH:0x05, SH:0x02 ) - Send ZCL Broadcast Command
Overview
The Send ZCL Broadcast command is sent by the Host to the Module in order to prompt the latter to broadcast a ZCL Message to the network. Unlike Send ZCL Unicast messages, broadcast messages cannot be APS-encrypted; they are encrypted on the Network layer only.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0 | Broadcast Address | 0xFF = All Devices Any other address entered will default to 0xFD |
1 | Enable reception of APS ACK status messages (not used) | |
2 | Destination Endpoint ID | |
3 | Local Endpoint ID | |
4,5 | Cluster ID | |
6 | Radius | Number of Network Hops that this message may travel. 0 = Maximum |
7 | Response Options | 8-bit Bitmap: Bit 0: Custom Sequence Number |
8 | Frame Control | 8-bit Bitmap: Bits 0-1: 00 = ZCL General Command Bit 2: 1 = Manufacturer-Specific Command Bit 3: 0 = Client to Server Bit 4: 1 = Disable Default Response |
9,10 | Manufacturer Code | Applicable if Bit 2 of Frame Control is enabled. |
11 | Transaction Sequence Number | Only used if bit 0 in the Response Options field is set. Otherwise, the application ignores this value and automatically assigns the next outgoing sequence number. The Host must apply a number in the range of 0-127. The range 128-255 is reserved for commands generated by the Module. |
12 | Command ID | |
13 | Payload Length | |
14..n | Payload |
Effect on Receipt
The Module will try to broadcast the message over the network. The status of the transmission and its assigned sequence number will be relayed to the Host via a ZCL Send Status command.
Allowed Context
Network Up.
Sent By Host/Module
Host.
Legal Notices
Copyright © 2020 MMB Networks, Inc. All rights reserved.
Confidential materials prepared and delivered by MMB Networks for receipt and review only by any partner subject to a valid and enforceable MMB Networks confidentiality agreement. Any receipt, review, or misuse of any of the content exchanged hereunder by any party not a party to this confidential exchange shall be subject to any and all rights available under the law. All rights, title and interest to the materials shall remain with MMB Networks.
Any suggestions provided to MMB Networks with respect to MMB Networks' products or services shall be collectively deemed “Feedback.” You, on behalf of yourself, or if you are providing Feedback on behalf of your employer or another entity, represent and warrant that you have full legal authority to bind such entity to these terms, agree to grant and hereby grant to MMB Networks a nonexclusive, perpetual, irrevocable, royalty free, worldwide license to use and otherwise exploit such Feedback within any MMB Networks products and services.