This page describes the commands supported by the RapidHA serial protocol. The payload byte values are detailed in the command descriptions. Some commands have no payloads.
...
| Note | ||
|---|---|---|
| ||
New sleep control frames under the Utility command group (PH: 0x55) provide the user with a wake-up handshaking scheme, as well as total and accurate control of application sleep cycles. |
| Table of Contents | ||||
|---|---|---|---|---|
|
...
| Anchor | ||||
|---|---|---|---|---|
|
The Reset command is sent from the Host to the Module, and prompts the Module to reboot. The command has no payload.
...
The Application Version Count Response is sent from the Module to the Host. The response payload length is 1 octet.
Payload for Application Version Count Response Command
Byte Index | Field Name | Notes |
|---|---|---|
0 | Version String Count | A count of the total number of Application Version Strings available from the running application. |
Expected Host Action
None.
| Anchor | ||||
|---|---|---|---|---|
|
The Application Version Request is sent from the Host to the Module to query a given Application Version String describing either the Application Bootloader Version, the core RapidHA Version or the Virtual Host Application Version. The request payload length is 1 octet.
Payload for Application Version Request Command
Byte Index | Field Name | Notes |
|---|---|---|
0 | Version Index | 0x00 - Retrieve Bootloader Version |
Effect on Receipt
The Module will respond with an Application Version Response.
| Anchor | ||||
|---|---|---|---|---|
|
The Application Version Response is sent from the Module to the Host. The response payload length is variable.
Payload of Application Version Response Command
Byte Index | Field Name | Notes |
|---|---|---|
0 | Version String Index | The array index (0 based) that this command relates to. |
| 1 | Version Type | The type of version string returned. See Version Types. |
| 2..(n + 3) | Version | The version being returned. The length n is specified in the first octet of the field. A total of n bytes will follow this length byte containing data which shall be interpreted based on the Version Type. |
Expected Host Action
None.
Anchor Application Version Types Application Version Types
Version Types
| Application Version Types | |
| Application Version Types |
Type ID | Type Name | Length (Octets) |
|---|---|---|
0x00 | LSB Binary Type | 4 |
| 0x01 | MSB Binary Type | 4 |
| 0x02 | String Type | Variable |
| 0x03 | LSB Binary Type | 2 |
| 0x04 | MSB Binary Type | 2 |
| 0x05 - 0xFE | Reserved | N/A |
| 0xFF | Invalid | N/A |
LSB Binary Type
A type value of LSB Binary Type indicates that the version string is being provided as a series of binary encoded bytes that represent the version string in a dotted version format with the least significant byte provided first. For example, a binary value of 0x01,0x02,0x03,0x04 provided using this encoding would be translated to 4.3.2.1 (or possibly 4.3.2rc1) when displayed to the user. This is the default encoding for version numbers.
MSB Binary Type
A type value of MSB Binary Type indicates that the version string is being provided as a series of binary encoded bytes that represent the version string in a dotted version format with the most significant byte provided first. For example, a binary value of 0x05,0x06,0x07, 0x08 provided using this encoding would be translated to 5.6.7.8 (or possibly 5.6.7rc8) when displayed to the user.
String Type
A type value of String Type indicates that the version string is being provided as an ASCII encoded string of length n. The value will not be null terminated as the length is provided. For example, a binary value of 0x31,0x2e,0x32,0x2e,0x30,0x72,0x63,0x31 provided using this encoding would be translated to 1.2.0rc1.
Invalid
A type value of Invalid indicates that the requested element is invalid. Typically this indicates that a request was made for an index which lies outside of the valid range of version string indices.
| Anchor | ||||
|---|---|---|---|---|
|
The Restore Defaults frame is sent from the Host to the Module and serves to restore the Module to its factory default settings. The command has no payload.
Effect on Receipt
The Module restores all non-volatile elements to their factory default settings, leaves the network if it is joined to one or dissolves the network if it has formed one, and then reboots.
| Anchor | ||||
|---|---|---|---|---|
|
The Host shall send the Host Startup Ready command to the Module after it starts up and is ready for communication. The command has no payload.
Effect on Receipt
On receiving the command, the Module will respond with the Startup Sync Request command. If the Module is in the Already Running state (see payload for Startup Sync Request ), it signifies that this command was received due to an unexpected reset of the Host. In this case, the Module will have retained all its application cache and attribute values, but will suspend network operations and return to the Startup Synchronization phase.
| Anchor | ||||
|---|---|---|---|---|
|
The Startup Sync Request command is sent by the Module on startup or as a response to the Host Startup Ready command. Upon issuing this command, the Module suspends execution of the full application until the Host has completed all desired configuration and updates against it.
The Module resends this command every five seconds until the Host sends the Startup Sync Complete command in response, signaling the completion of the configuration and update process.
Payload for Startup Sync Request Command
Byte Index | Field Name | Notes |
|---|---|---|
0 | Running State | 0x00 = Starting Up |
1 | Configuration State | 0x00 = Factory Default |
The Running State indicates whether the Module has just powered up or is already running. If the Running State indicates the latter, it signifies that the Host experienced a unilateral reset.
The Configuration State indicates the application configuration state of the Module. The Factory Default state indicates that the Module is operating for the first time post-production, or subsequent to the reception of the Restore to Default command from the Host. The Needs Endpoint Configuration state indicates that the Module has restored all default configurations (Manufacturer ID, etc.), but still requires the Host to configure application endpoints, clusters and attributes. This state will occur after a soft or hard reset of the Module, regardless of the amount of non-volatile memory available.
Expected Host Action
The Host may receive the Startup Sync Request either during a synchronized power up or after a unilateral reset of the Module. The Host shall process both scenarios in the same manner.
If the Running State of the Module is Already Running the Host is not required to configure endpoints, clusters and attributes and perform updates on the values of the latter. Instead, the Host should query attribute values and cached event data from the Module in order to synchronize its internal state with that of the application.
If the Configuration State of the Module is Factory Default, the Host shall perform a full configuration of the application, specifying the IEEE functional device type, security configuration, endpoints, etc. If the Configuration State is Needs Endpoint Configuration, the Host shall configure the application endpoints, clusters and attributes accordingly. If Configuration State is Fully Configured, no further configuration action is required of the Host.
| Anchor | ||||
|---|---|---|---|---|
|
The Host shall send the Startup Sync Complete command to the Module in response to a Startup Sync Request and upon completion of all startup configurations and updates to the latter. The command has no payload.
Effect on Receipt
The Module acknowledges reception of the command with a Status Response indicating Success, after which it runs the full application. If the Module was previously joined to a network it will rejoin that network. Additionally, application configurations are backed up to non-volatile memory for restoration on the next startup.
Please note that Host configurations for endpoints, clusters and attributes are not preserved in non-volatile memory; thus they must be reconfigured after any soft or hard reset of the Module.
Status Response to Startup Sync Complete Command
Status Response | Enum | Description |
|---|---|---|
Success | 0x00 | Module received the command and will start the full application. |
...
Expected Host Action
None.
Anchor Antenna Configuration Write Antenna Configuration Write
Antenna Configuration Write Command - ( PH:0x55, SH:0x25 )
| Antenna Configuration Write | |
| Antenna Configuration Write |
...
The Sleepy Parameters Request CMD command is sent by the Host to the Module to query the application’s sleepy parameters. The command has no payload. See Sleepy Devices for more information about the Module’s sleepy behavior.
...
The Sleepy Parameters Response CMD command is sent by the Module to the Host in response to a Sleepy Parameters Request CMD. The command conveys the sleepy parameters of the application. See Sleepy Devices for more information about the Module’s sleepy behavior.
...
The Sleepy Parameters Write CMD command is sent by the Host to the Module to modify the sleepy parameters. The command allows for multiple attributes to be written for a device in one operation. The value 0xFF is an invalid parameter for all byte fields in the payload; it will not be written. See Sleepy Devices for more information about the Module’s sleepy behaviour.
...
The Sleepy Hibernate Duration Request CMD command is sent by the Host to the Module to query only the App Hibernate Duration parameter. This command is provided to read the App Hibernate Duration parameter without reading the other sleepy parameters. The command has no payload. See Sleepy Devices for more information about the Module’s sleepy behavior.
...
The Sleepy Hibernate Duration Response CMD is sent by the Module to the Host in response to a Sleepy Hibernate Duration Request CMD. The command conveys the Module's hibernation duration; i.e., the App Hibernate Duration parameter. See Sleepy Devices for more information about the Module’s sleepy behavior.
...
The Sleep Hibernate Duration Write Command is sent by the Host to the Module to modify the parameter App Hibernate Duration. See Sleepy Devices for more information about the Module’s sleepy behavior.
...
Byte Index | Field Name | Notes |
|---|---|---|
0..3 | Channel Mask | Four-byte channel mask. Each bit represents channels 0 – 31. Example: Channel 11 = 0x00000800 or interpreted as a 32-bit bitmap - 0000 0000 0000 0000 0000 1000 0000 0000 - bit 11 would be flipped Channel 13 = 0x00002000 or interpreted as a 32-bit bitmap - 0000 0000 0000 0000 0010 0000 0000 0000 - bit 13 would be flipped ZigBee HA and SE operate on only channels 11 through 26. It should be noted that channel 26 is restricted. |
4 | Auto Options | Bit 0 = 1 – Auto PAN ID If both bits are “1” and multiple networks exist on the channel, |
5,6 | Short PAN ID | The Short PAN ID of the network that the Module must join. |
7..14 | Extended PAN ID | The Extended PAN ID of the network Module must join to. |
...
Byte Index | Field Name | Notes |
|---|---|---|
0..3 | Channel Mask | 4-byte channel mask. Each bit represents channels 0 – 31. The least significant bit, bit 0, corresponds to channel 0, bit 1 to channel 1, etc. Example: Channel 11 = 0x00000800 or interpreted as a 32-bit bitmap - 0000 0000 0000 0000 0000 1000 0000 0000 - bit 11 would be flipped Channel 13 = 0x00002000 or interpreted as a 32-bit bitmap - 0000 0000 0000 0000 0010 0000 0000 0000 - bit 13 would be flipped ZigBee HA and SE only operate on channels 11-26 (inclusive). If multiple channels are selected, the Module will form a network on the channel with the least interference. Please note: channel 26 is restricted. Networks formed on this channel are in violation of FCC rules and regulations. : In order to comply with FCC regulations, MMB Networks devices operate at a reduced power level on channel 26 to stay within FCC regulations. It's not recommended to form a network on this channel as it will have a reduced range. |
4 | Auto Options | Bit 0 = 1 – Auto PAN ID |
5,6 | Short PAN ID | The Short PAN ID of the new network. |
7..14 | Extended PAN ID | The Extended PAN ID of the new network. |
...
Byte Index | Field Name | Notes |
|---|---|---|
0 | Network State | 0x00 = Network Down |
1 | ZigBee Device Type | 0x00 = Coordinator |
2 | Channel | 0xFF = Unknown |
3,4 | Node ID | 0xFFFF = Unknown |
5,6 | PAN ID | 0xFFFF = Unknown |
7..14 | Extended PAN ID | All 0’s = Unknown |
15 | Permit Join Time | The remaining Permit Join Duration at the time of issuance. |
...
Byte Index | Field Name | Notes | |||
|---|---|---|---|---|---|
0,1 | Node ID | Node ID of the device attempting to join or leave the network | |||
2..9 | EUI64 | EUI64 of the device attempting to join or leave the network | |||
10 | Device Update Event | Event that triggered the update. 0x00 = MAC Association | 11,12 | Parent Node ID | Node ID of the device’s parent0x00 = MAC Association |
11,12 | Parent Node ID | Node ID of the device’s parent |
Event Triggers explained:
MAC Association -- a device's attempt to join the network. Seeing this does not mean that a device successfully joined, however. The indication for when the device joining successfully is when you see Device Announce.
Secure Rejoin -- this is a device rejoining the network using the network key
Trust Center Rejoin -- this is a device rejoining the network without the network key. It needs to get the network key from the Trust Center, which sends the network key encrypted using the trust center key.
Network Leave -- a device leaving the network.
| Anchor | ||||
|---|---|---|---|---|
|
...
| Frame Name | Secondary Header Byte | Allowed Context | Sent By Host/Module |
|---|---|---|---|
| Device Type Write | 0x00 | Startup Config Only | Host |
| Device Type Request | 0x01 | All Contexts | Host |
| Device Type Response | 0x02 | All Contexts | Module |
| Add Endpoint | 0x10 | Startup Config Only | Host |
| Endpoint List Request | 0x11 | All Contexts | Host |
| Endpoint List Response | 0x12 | All Contexts | Module |
| Endpoint Descriptor Request | 0x13 | All Contexts | Host |
| Endpoint Descriptor Response | 0x14 | All Contexts | Module |
| Add Attributes to Cluster | 0x20 | Startup Config Only | Host |
| Attribute List Request | 0x21 | All Contexts | Host |
| Attribute List Response | 0x22 | All Contexts | Module |
| Attribute Request | 0x23 | All Contexts | Host |
| Attribute Response | 0x24 | All Contexts | Module |
| Attribute Write | 0x25 | All Contexts | Host |
| Attribute Report Passthrough Control | 0x26 | All Contexts | Host |
| Clear Endpoint Config | 0x30 | Startup Config Only | Host |
| Register Commands Passthrough | 0x80 | Startup Config Only | Host |
| Anchor | ||||
|---|---|---|---|---|
|
...
| Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint ID | Valid range 1 - 240 |
1,2 | Profile ID | 0x0104 |
3,4 | Device ID | See /wiki/spaces/SPRHA17/pages/37093556 this page for a list of Device IDs used in the HA profile. |
5 | Device Version | |
6 | Number of Server Clusters | The number of server clusters, n |
7..6+2n | List of Server Clusters | List of 2-byte Cluster IDs, LSB first |
7+2n | Number of Client Clusters | The number of client clusters, m |
8+2n..7+2(n+m) | List of Client Clusters | List of 2-byte Cluster IDs, LSB first |
...
The Module will verify that the Endpoint ID is valid and that there is sufficient memory for the new endpoint and its associated clusters. Likewise, the application will automatically configure all mandatory attributes for specified known clusters. The following table lists the possible Status Responses on reception of the command.
...
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint ID | Valid range 1 - 240 |
1,2 | Profile ID | |
3,4 | Device ID | See /wiki/spaces/SPRHA17/pages/37093556 this page for a list of Device IDs used in the HA profile. |
5 | Device Version | |
6 | Number of Server Clusters | The number of server clusters, n |
7..6+2n | List of Server Clusters | List of 2-byte Cluster IDs, LSB first |
7+2n | Number of Client Clusters | The number of client clusters, m |
8+2n..7+2n+2m | List of Client Clusters | List of 2-byte Cluster IDs, LSB first |
...
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint ID | |
1,2 | Cluster ID | |
3 | Cluster Server/Client | 0x00 = Client |
4 | Number of Attributes to Add | |
5..n | Attribute Definition Records | Record format is shown in the following table. |
Anchor Attribute Definition Record Format Attribute Definition Record Format
Attribute Definition Record Format
| Attribute Definition Record Format | |
| Attribute Definition Record Format |
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Attribute ID | |
2 | Attribute Type | See the ZCL Data TypesSpecification References page for possible values. |
3 | Attribute Property Bitmask | Bit Description 0 0 = Not Readable |
...
The Attribute List Request is sent by the Host to the Module in order to query the attributes on a given application cluster and endpoint.
Payload for Attribute List Request Command
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint ID | The target endpoint to query. |
1,2 | Cluster ID | The target cluster to query on the given endpoint. |
3 | Cluster Server/Client | 0x00 = Client |
Effect on Receipt
If the Module supports the target endpoint and cluster, it will relay an appropriate number of AttributeList Response commandsto the Host. Otherwise, a Status Response is generated indicating an error, as described in the following table.
...
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint ID | |
1,2 | Cluster ID | |
3 | Cluster Server/Client | 0x00 = Client |
4 | Total Number of Pages | The total number of pages (i.e., command frames) that will be sent to complete the response. |
5 | Current Page | The current page of a multi-page response. The first page is 1, a second page, if any, is 2, etc. |
6 | Number of Attributes | Number of attributes in the current page. |
7…n | List of Attribute IDs | Each Attribute ID is sent LSB first |
Expected Host Action
None.
Anchor Attribute Request Attribute Request
Attribute Request Command - ( PH:0x03, SH:0x23 )
| Attribute Request | |
| Attribute Request |
...
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint ID | The target endpoint to query. |
1,2 | Cluster ID | The target cluster to query on the given endpoint. |
3 | Cluster Server/Client | 0x00 = Client |
4,5 | Attribute ID | The ID of the attribute to query. |
Effect on Receipt
If the Module supports the requested attribute, it will respond with an Attribute Response. Otherwise, the application will relay a Status Response indicating an error, as described in the following table.
...
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint ID | |
1,2 | Cluster ID | |
3 | Cluster Server/Client | 0x00 = Client |
4,5 | Attribute ID | |
6 | Attribute Property Bitmask | Bit Description 0 0 = Not Readable |
7 | Attribute Type | See the ZCL Data TypesSpecification References page for possible values. |
8..n | Attribute Value | Size dependent on Attribute Type. For strings, the length of the string will immediately precede the string itself. |
Expected Host Action
None.
...
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint ID | |
1,2 | Cluster ID | |
3 | Cluster Server/Client | 0x00 = Client |
4,5 | Attribute ID | |
6 | Attribute Type | See the ZCL Data TypesSpecification References page for possible values. |
7..n | Attribute Value | Size dependent on Attribute Type. For strings, the length of the string must immediately precede the string itself. |
Effect on Receipt
If the attribute is supported, the specified Attribute Type matches and the Attribute Value is the correct size, the Module will return a Status Response indicating Success. Otherwise, the response will indicate an error. The possible Status Responses are listed in the following table.
...
The Attribute Report Passthrough Control message is sent from the Host to the Module. The payload length is 1 octet.
Payload for Attribute Report Passthrough Control
Byte Index | Field Name | Notes |
|---|---|---|
0 | Attribute Passthrough Control | 0x00 = Disabled |
...
| Frame Name | Secondary Header Byte | Allowed Context | Sent By Host/Module |
|---|---|---|---|
| Send ZDO Unicast | 0x01 | Network Up Only | Host |
| Send ZDO Broadcast | 0x02 | Network Up Only | Host |
| ZDO Send Status | 0x03 | All Contexts | Module |
| ZDO APS Ack | 0x04 | All Contexts | Module |
| ZDO Response Received | 0x05 | All Contexts | Module |
| ZDO Response Timeout | 0x06 | All Contexts | Module |
| ZDO Device Announce Received | 0x1E | All Contexts | Module |
...
| Anchor | ||||
|---|---|---|---|---|
|
The Send ZDO Broadcast command is sent by the Host to the Module to prompt the Module to broadcast a ZDO Message across the network.
...
| Anchor | ||||
|---|---|---|---|---|
|
The ZDO Send Status message is sent by the Module to the Host after the transmission of a Send ZDO Unicast or Send ZDO Broadcast. The message conveys the success or failure of the transmission. If the Status indicates Success, the message will also convey a value for the Transaction Sequence Number assigned to it.
...
| Anchor | ||||
|---|---|---|---|---|
|
The ZDO APS Ack command is sent by the Module to the Host on reception of an equivalent acknowledgement from the network, triggered by the initial transmission of a ZDO message that required an APS Ack among its Response Options. The Module will also generate the command when a given acknowledgment is not received and therefore times out.
...
| Anchor | ||||
|---|---|---|---|---|
|
The ZDO Response Received command is sent by the Module to the Host on reception of ZDO Message from the network. That is, the command is generated if the Host configured an outgoing Send ZDO Unicast or Broadcast request with Response Optionsindicating that a response is expected (i.e. enable reception of ZDO Response Received with corresponding Transaction Sequence Number, though the application will also verify the Source Node ID and Command ID).
...
| Anchor | ||||
|---|---|---|---|---|
|
The ZDO Response Timeout command is sent by the Module to the Host when an expected ZDO Response Received command to an outgoing Send ZDO Unicast or Send ZDO Broadcast is not received within a given interval after transmission. The fixed timeout period is 10 seconds.
...
| Anchor | ||||
|---|---|---|---|---|
|
The ZDO Device Announce Received frame is sent by the Module to the Host when a new device announces itself on the network.
...
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Node ID | Node ID of the new device. |
2..9 | EUI64 | The 64 bit Extended Universal Identifier of the new device. |
10 | Capability | MAC capability bitmap of the device. Bit Description |
...
Back to Top
| Anchor | ||||
|---|---|---|---|---|
|
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.
...
| Anchor | ||||
|---|---|---|---|---|
|
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.
...
| Anchor | ||||
|---|---|---|---|---|
|
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.
...
Byte Index | Field Name | Notes | ||
|---|---|---|---|---|
0,1 | Group ID | The Group ID of the Group to which the target devices belong. | 1 | Enable reception of APS ACK status messages (not used) |
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 |
...
| Anchor | ||||
|---|---|---|---|---|
|
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.
...
| Anchor | ||||
|---|---|---|---|---|
|
The ZCL Send Status message is sent by the Module to the Host after the transmission of a Send ZCL Unicast, Send ZCL MulticastorSend ZCL Broadcast. The message conveys the success or failure of the preceding transmission. If the Status indicates success, the message will also convey a value for the Transaction Sequence Numberassigned to it.
...
| Anchor | ||||
|---|---|---|---|---|
|
The ZCL APS Ack command is sent by the Module to the Host on reception of an equivalent acknowledgement from the network, triggered by the initial transmission of a ZCL message that required an APS Ack among its Response Options. The Module will also generate the command when a given acknowledgment is not received and therefore times out.
...
| Anchor | ||||
|---|---|---|---|---|
|
The ZCL Response Received command is sent by the Module to the Host on reception of ZCL message from the network. That is, the command is generated if the Host had configured an outgoing Send ZCL Unicast or Send ZCL Broadcast with Response Optionsindicating that a response is expected (i.e. enable reception of ZCL Response Received with corresponding Transaction Sequence Number, though the application will also verify the Source Node ID and Command ID).
...
| Anchor | ||||
|---|---|---|---|---|
|
The ZCL Response Timeout command is sent by the Module to the Host when an expected ZCL Response Received to an outgoing Send ZCL Unicast or Broadcast request is not received within a given interval after transmission. The fixed timeout period is 10 seconds.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Received Attribute Write command is sent by the Module to the Host on reception of a Attribute Write command from the source node on the network. The command serves to inform the Host of a change to the value of an attribute along with source of the change and the value itself.
Payload for Received Attribute Write Command
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Source Node ID | The Source Node ID of the received Attribute Write command. |
2 | Source Endpoint ID | The source Endpoint ID of the received Attribute Write command. |
3 | Local Endpoint ID | The target local Endpoint ID to which the received Attribute Write command was directed. |
4,5 | Cluster ID | |
6 | Cluster Client/Server | 0x00 = Client |
7,8 | Attribute ID | |
9 | Attribute Type | See the ZCL Data TypesSpecification References page for possible values. |
10..n | New Attribute Value | The new value of the target attribute, as modified by the received Attribute Write command. For strings, the length of the string will immediately precede the string itself. |
...
Anchor ZCL Passthru Message ZCL Passthru Message
ZCL Passthru Message Command - ( PH:0x05, SH:0x20 )
| ZCL Passthru Message | |
| ZCL Passthru Message |
The ZCL Passthru Message command is sent by the Module to the Host on reception of a ZCL Message which has been registered by the Host using the Register Commands Passthru facility (that is, to prevent the application from processing the command in order to pass it directly to the Host; see the Register Commands Passthru command).
Payload for ZCL Passthru Message Command
...
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Source Node ID | |
2 | Source Endpoint ID | |
3 | Local Endpoint ID | |
4,5 | Cluster ID | |
6 | Encryption Level | 0x00 = Network Encryption Only |
7 | Frame Control | 8-bit Bitmap: Bits 0-1: 00 = ZCL General Command |
8,9 | Manufacturer Code | Applicable if Bit 2 of Frame Control is enabled. |
10 | Transaction Sequence Number | The Transaction Sequence Number of the original request. |
11 | Command ID | |
12 | Payload Length | |
13..n | Payload |
| Anchor | ||||
|---|---|---|---|---|
|
The ZCL Read Attribute Request command is sent from the Host to the Module to query attributes on a target network device. The command may be used to query multiple attributes on a cluster, with the subsequent responses relayed to the Host one attribute at a time.
...
| Anchor | ||||
|---|---|---|---|---|
|
The ZCL Read Attribute Response command is sent by the Module to the Host in response to a successful ZCL Read Attribute Request. A response conveys the properties of a single queried attribute. As such, if the request successfully queried multiple attributes, the Host will in turn receive multiple responses.
...
Byte Index | Field Name | Notes |
|---|---|---|
0 | Source Node ID | Address of the responding device |
2 | Source Endpoint ID | Endpoint where attribute is hosted |
3,4 | Source Cluster ID | Cluster of the attribute |
5 | Client/Server Cluster | 0x00 = Client |
6,7 | Attribute ID | Corresponds to Attribute ID in request |
8 | ZCL Status | 0x00 = Success See /wiki/spaces/SPRHA17/pages/37093554 this page for ZCL Status values |
9 | Attribute Data Type | See this page for valid values |
10..n | Attribute Value | Byte length of the Value dependent on Attribute Data Type. For strings, the length of the string will immediately precede the string itself. |
...
| Anchor | ||||
|---|---|---|---|---|
|
The ZCLAttribute Write Request is sent by the Host to the Module to modify the value of an attribute on a target network device. The command allows for multiple attributes on the same endpoint and cluster to be written to in one operation.
...
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Attribute ID | The target attribute to write to |
2 | Attribute Data Type | See this page for details on the ZCL Data Types used in this field |
3..2 + m | Attribute Value | Byte length of the Attribute Value where m ≥ 1 is dependent on Attribute Data Type. For strings, the length of the string will immediately precede the string itself. |
...
| Anchor | ||||
|---|---|---|---|---|
|
The ZCL Write Attribute Response is sent by the Module to the Host in response to a successful ZCL Write Attribute Request. The frame conveys the Overall Status of the write request. Note that if the Overall Status indicates success no Attribute Write Failed Records are included in the payload.
...
Expected Host Action
None.
...
Back to Top
| Anchor | ||||
|---|---|---|---|---|
|
The General Clusters command set encompasses the following mandatory ZCL clusters in the general domain:
...
| Anchor | ||||
|---|---|---|---|---|
|
The Received Reset to Factory Default command is sent by the Module to the Host on reception of a Basic cluster Reset to Factory Default command from the network. The command has no payload.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Identify Start command is sent by the Module to the Host on reception of an Identify cluster Identify command from the network. Specifically, the command conveys the ID of the endpoint on which the Identify action should occur and will only be passed to the Host at its required time of execution.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Identify Stop command is sent by the Module to the Host on expiration of a preceding Identify Start command (i.e., when the Identify Time duration of that command has been expended) or on reception of an explicit command from the network prompting the application to stop identifying on the given endpoint.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Time Client Get Time command is sent by the Host to the Module to query the UTC and Local Time attributes of the application. Appending the Time cluster to the application endpoint configuration enables the application Time client, which automatically synchronizes its time with the network Time server. The command has no payload.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Time Client Get Time Response command is sent by the Module to the Host in response to a Time Client Get Time request. The command conveys both the current UTC and Local Time, as maintained by the application in synchronization with the network Time Server.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Time Client Time Changed command is sent by the Module to the Host to inform the Host of a change to the Current UTC Time and/or Current Local Time, as retrieved from the network Time Server. The command is also generated when the application first synchronizes its time with the Time Server. The command has no payload.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Network Time Sync Period Write command is sent from the Host to the Module to modify how often the Time Server will be polled by the device. The command conveys the time sync period in minutes.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Network Time Sync Period Request command is sent from the Host to the Module to read the current value for the time sync period. The command has no payload.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Network Time Sync Period Response command is sent from the Module to the Host in response to a Network Time Sync Period Request command. The command conveys the time sync period currently set on the module.
...
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Sync Period | The time period, in minutes, for the Time client to sync with the Time server 0x0001-0xFFFF: Valid range for time period |
...
Back to Top
| Anchor | ||||
|---|---|---|---|---|
|
The HA clusters command set encompasses the following ZCL clusters for common HA applications:
...
| Anchor | ||||
|---|---|---|---|---|
|
The On/Off State Update command is sent by the Module to the Host on reception of a network command that modifies the On/Off attribute value on the given endpoint(i.e. that which supports the On/Off server cluster). The command contains the current On/Offstate and indicates if it was updated by a local or remote source.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Move to Level command is sent by the Module to the Host on reception of a Move to Level command from the network, targeted to an endpoint on which the application supports the Level Control server cluster.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Level Move command is sent by the Module to the Host on reception of a Move command from the network, targeted to an endpoint on which the application supports the Level Control server cluster. The command conveys both the expected Direction and Rate of movement.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Level Step command is sent by the Module to the Host on reception of a Step command from the network, targeted to an endpoint on which the application supports the Level Control server cluster. The command conveys both the expected direction of movement (up or down) and unit size of each step.
...
If the withOnOff flag is “True” the Host must update the CurrentLevel attribute of the Level Control server cluster and the OnOff attribute of the On/Off cluster.
| Anchor | ||||
|---|---|---|---|---|
|
The Level Stop command is sent by the Module to the Host on reception of a Stop command from the network, targeted to an endpoint on which the application supports the Level Control server cluster.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Check Battery Attribute command is sent from the Host to the Module which triggers the Module to check the battery voltage. The command has no payload. It is recommended that this command be called after updating the battery voltage attribute.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Move to Level with On/Off status command is sent by the Module to the Host whenever the Current Level and OnOff status change as a result of incoming Level Control cluster commands.
...
- (Indicating Level 100, Transition Time 0, On/Off Status ON) F1 12 25 BB 05 16 64 00 00 01 72 01 [RHAMoveToLevel]
| Anchor | ||||
|---|---|---|---|---|
|
The Lock Door command is sent by the Module to the Host on reception of Lock command from the network (Lock Door, Toggle, Recall Scene, etc.). The command has no payload.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Lock Confirm command is sent by the Host to the Module in order to confirm the current Lock State after reception of a Lock Door or Unlock Door command.
...
The Module will update the value of the application Lock State attribute and report the success of the Lock or Unlock action to the network device that issued the original command.
...
Back to Top
| Anchor | ||||
|---|---|---|---|---|
|
The commands in this section facilitate serial bootload upgrade of the application operating on the Module. These commands have been implemented per HA 1.2 guidelines.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Query Next Image Response frame is sent from the Host to the Moduleand prompts the Module to prepare its external flash memory to receive a new image. Any existing firmware image in flash is erased.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Image Block Request frame is sent from the Module to the Host. The Module expects to receive an Image Block Response from the Host in return.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Image Block Response frame is sent from the Host to the Module. The Module will store this data to external flash memory at the offset provided.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Upgrade End Request frame is sent from the Module to the Host to indicate that it has received the new image and is awaiting an Upgrade End Response from the Host to switch to that image.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Upgrade End Response frame is sent from the Host to Module in response to an Upgrade End Requestand serves to specify the time at which the Module will switch to the new image.
...
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Node ID | Node ID of Module |
2..9 | EUI64 | EUI64 of Module |
10 | Endpoint ID | Endpoint of Module |
11,12 | Manufacturer Code | |
13,14 | Image Type | Unused - for backwards compatibility. Set to 0x0000 |
15..18 | File Version | Will contain the value initially set in the Query Next Image Response / OTA Query Next Image Response frames by the Host. |
19..22 | Current Time | UTC Time, where 0x00000000 = Now |
23..26 | Upgrade Time | UTC Time, where 0x00000000 = Now |
...
Back to Top
| Anchor | ||||
|---|---|---|---|---|
|
The commands in this section facilitate over-the-air (OTA) client of the application operating on the Module. These commands have been implemented per the ZigBee HA 1.2 guidelines.
...
| Anchor | ||||
|---|---|---|---|---|
|
The OTA Query Configuration Request frame is sent from the Host to the Moduleto request the intervals at which the Modulequeries the OTA server for data. The Module will respond with an OTA Query Configuration Response frame. The command has no payload.
| Anchor | ||||
|---|---|---|---|---|
|
The OTA Query Configuration Response frame is sent from the Module to the Host in response to an OTA Query Configuration Request.
...
| Anchor | ||||
|---|---|---|---|---|
|
The OTA Query Configuration Write frame is sent from the Host to the Moduleto set the various intervals at which the Modulequeries the OTA server for data. These settings may not be modified during an OTA upgrade and will persist in non-volatilememory.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Image Progress Notification frame is sent from the Module to the Host to notify the Host of the reception of every 512 bytes of firmware downloaded through the OTA Bootload cluster. The frame is also sent on completion of the download.
...
| Anchor | ||||
|---|---|---|---|---|
|
The OTA Version Configuration Request frame is sent from the Host to the Moduleto query the version and image type information used to verify a new OTA image. The Module will respond with an OTA Version Configuration Response frame. The command has no payload.
...
| Anchor | ||||
|---|---|---|---|---|
|
The OTA Version Configuration Write frame is sent from the Host to the Moduleto configure the version and image type information used to verify an OTA image.
...
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Image Type | Unused - for backwards compatibility. Set to 0x0000 |
2..5 | Firmware Version | Set to 0xFFFFFFFF to retain default. |
6,7 | Hardware Version | Set to 0xFFFF to retain default (EM357) 0x00 = Reserved |
8..15 | Signer EUI | Set to 0xFFFFFFFF to retain default (0x0024460000078074). |
...
Back to Top
| Anchor | ||||
|---|---|---|---|---|
|
The commands in this section facilitate over the air (OTA) server of the application operating on the Module. These commands have been implemented per the ZigBee HA 1.2 guidelines.
...
| Anchor | ||||
|---|---|---|---|---|
|
The OTA Image Notification Command frame is sent from the Host to the Module. The Module will send an Image Notify ZCL command either broadcast or unicast depending on the received serial frame.
NOTE: Allow a wait time of 5000ms for the Image Notification Command Frame
Payload for OTA Image Notification Command
...
| Anchor | ||||
|---|---|---|---|---|
|
The OTA Query Next Image Request frame is sent from the Module to the Host. The Module expects to receive an OTA Query Next Image Response frame in return.
...
| Anchor | ||||
|---|---|---|---|---|
|
The OTA Query Next Image Response frame is sent from the Host to the Module. The Module relays the frame to the OTA target device. If the target EUI64 is the module’s own EUI64, the module will process it locally.
...
| Anchor | ||||
|---|---|---|---|---|
|
The OTA Image Block Request frame is sent from the Module to the Host. The Module expects to receive an OTA Image Block Response frame in response.
...
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Node ID | Request OTA Device Node ID |
2..9 | EUI64 Address | Request OTA Device EUI64 |
10 | Endpoint | Request OTA Device Endpoint |
11 | Field Control | 8-bit Bitmap |
12,13 | Manufacturer Code | |
14,15 | Image Type | Unused - for backwards compatibility. Set to 0x0000 |
16..19 | File Version | Will contain the value initially set in the Query Next Image Response / OTA Query Next Image Response frames by the Host. |
20..23 | File Offset | |
24 | Maximum Data Size | N < 50 |
Expected Host Action
The Host must process and respond to Image Block Request messages until the Module sends a Upgrade End Request
The Host must set status to MALFORMED_COMMAND (0x80) and return a 0 length data block if the Image Offset is outside the range of the file length.
| Anchor | ||||
|---|---|---|---|---|
|
The OTA Image Block Response frame is sent from the Host to the Module. The Module relays the frame to the OTA target device. If the target EUI64 is the module’s own EUI64, the module will process it locally.
There are three possible return values for the OTA Image Block Response: Success, Wait for Data, and Abort. The payload differs for each one.
NOTE: Allow a wait time of 250ms for the Image Block Response Frame(except for last reponse in the sequence!)
Allow a wait time of 15000ms for the Last Image Block Response Frame
Payload for OTA Image Block Response Command on Success
...
| Anchor | ||||
|---|---|---|---|---|
|
The Upgrade End Request frame is sent from the Module to the Host. The Module expects to receive an Upgrade End Response frame in response.
NOTE: Allow a wait time of 30000ms for the Upgrade End Request Command Frame
Payload for OTA Upgrade End Request Command
...
| Anchor | ||||
|---|---|---|---|---|
|
The OTA Upgrade End Response frame is sent from the Host to the Module in response to an OTA Upgrade End Request with success status. The Module relays the frame to the OTA target device. If the target EUI64 is the module’s own EUI64, the module will process it locally,
...
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Node ID | Target Device Node ID. 0xFFFF indicates that the EUI64 is used. |
2..9 | EUI64 Address | Target Device EUI64. All 0xFF indicates broadcast |
10 | Endpoint | 0xFF indicates a request on all endpoints. |
11,12 | Manufacturer Code | |
13,14 | Image Type | Unused - for backwards compatibility. Set to 0x0000 |
15..18 | File Version | Will contain the value initially set in the Query Next Image Response / OTA Query Next Image Response frames by the Host. |
19..22 | Current Time | |
23..26 | Upgrade Time |
...
Back to Top
| Anchor | ||||
|---|---|---|---|---|
|
This section describes the commands that initiate and respond to network scans.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Network Scan Request is sent by the Host to the Module and serves to initiate Network Discovery. This command may only be transmitted when the application is in the Network Down state. The Module will respond with a Network Scan Response for each available network discovered and will also respond with a Network Scan Complete command once the scan request is complete.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Network Scan Response is sent by the Module to the Host for every response retrieved subsequent to the issuance of a Network Scan Request. Each response represents a beacon from a node within an active network that is in communications range of the Module.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Modulesends theNetwork Scan Completecommand to the Host on completion of a Network Scan Request. It should be noted that the issuance of the Network Scan Complete command does not necessarily indicate that all Network Scan Responses have yet been retrieved for the aforementioned request.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Latency Request frame is sent from Host to Module to test the round-trip latency between the Module and a destination node on the network. Upon receipt of this frame, the Module will send a packet to the destination node, and measure the time it takes to receive the acknowledgement.
...
| Anchor | ||||
|---|---|---|---|---|
|
The Latency Response frame is sent from the Module to the Host with the result of the latency test initiated with a Latency Request.
...