( PH:0x05, SH:0x00 ) - Send ZCL Unicast CommandOverviewThe 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. PayloadByte 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 Bit 1: Enable reception of APS ACK status messages Bit 2: Enable reception of ZCL Response Received with corresponding Transaction Sequence Number | 7 | Encryption Level | 0x00 = Network Encryption Only 0x01 = Network + APS Encryption | 8 | Frame Control | 8-Bit Bitmap: Bits 0-1: 00 = ZCL General Command 01 = Cluster-Specific Command Bit 2: 1 = Manufacturer-Specific Command Bit 3: 0 = Client to Server 1 = Server to Client Bit 4: 1 = Disable Default Response Bit 5-7: Reserved | 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 ReceiptThe 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 ContextNetwork Up. Sent By Host/ModuleHost. |