Page Comparison

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.

...

...

Anchor
Reset Reset

Reset Command - ( PH:0x55 SH:0x00 )

The Reset command is sent from the Host to the Module, and prompts the Module to reboot. The command has no payload.

...

Anchor
Module Info Request Module Info Request

Module Info Request Command - ( PH:0x55 SH:0x02 )

The Module Info Request commandis sent from the Hostto the Module to query the Module’s version and application type. This command has no payload.

...

Anchor
Module Info Response Module Info Response

Module Info Response Command - ( PH:0x55, SH:0x03 ) 

The Module Info Responsecommand is sent from the Module to the Hostin response to a Module Info Request command.

...

Anchor
Bootloader Version Request Bootloader Version Request

Bootloader Version Request Command - ( PH:0x55, SH:0x04 )

The Bootloader Version Request command is sent from the Host to the Module and queries the module’s application bootloader version.  The Module responds with a Bootloader Version Response. The command has no payload.

...

 

Anchor
Bootloader Version Response Bootloader Version Response

Bootloader Version Response Command - ( PH:0x55, SH:0x05 )

The Bootloader Version Response is sent by the Module after it is queried by the Host with a Bootloader Version Request. The Response contains advanced information about the current application bootloader running on the Module.

...

Anchor
Application Version Count Request Application Version Count Request

Application Version Count Request - ( PH:0x55, SH:0x06 )

The Application Version Count Request is sent from the Host to the Module to query the number of Application Version Strings available from the running application. The command has no payload.

...

Anchor
Application Version Count Response Application Version Count Response

Application Version Count Response - ( PH:0x55, SH:0x07 )

 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

Anchor
Antenna Configuration Request Antenna Configuration Request

Antenna Configuration Request Command - ( PH:0x55, SH:0x23 )

The Antenna Configuration Request is sent by the Host to the Module and serves to query the Module about the hardware antenna configuration when the application is operating on the MMB Hornet platform. The command has no payload.

...

Anchor
Antenna Configuration Response Antenna Configuration Response

Antenna Configuration Response Command - ( PH:0x55, SH:0x24 )

The Antenna Configuration Response is sent by the Module after it is queried by the Host with an Antenna Configuration Request. The payload contains the hardware antenna configuration of the MMB Hornet platform. If the application is not operating on that platform, the response indicates that antenna configuration is not supported.

...

Expected Host Action

None.

 

Anchor
Antenna Configuration Write Antenna Configuration Write

Antenna Configuration Write Command - ( PH:0x55, SH:0x25 )

The Antenna Configuration Write command is sent by the Host to the Module to select the hardware antenna configuration of the MMB Hornet platform.

...

Anchor
LED Configuration Request LED Configuration Request

LED Configuration Request Command - ( PH:0x55, SH:0x26 )

The LED Configuration Request is sent by the Host to the Module and serves to query the LED behavior configuration of the Telegesis LRS USB Stick or the MMB Hornet-based MMB USB Stick platforms. On these platforms, the LED may be configured to act as an indicator of the application Network State. The Module responds with an LED Configuration Response. The command has no payload.

...

Anchor
LED Configuration Response LED Configuration Response

LED Configuration Response Command - ( PH:0x55, SH:0x27 )

The LED Configuration Response is received from the Module once queried by the Host with an LED Configuration Request. It conveys the LED behavior configuration of the Telegesis LRS USB Stick or MMB Hornet-based MMB USB Stick platforms. On these platforms, the LED may be configured to act as an indicator of the application Network State.

...

Anchor
LED Configuration Write LED Configuration Write

LED Configuration Write Command - ( PH:0x55, SH:0x28 )

The LED Configuration Write command is sent by the Host to the Module to set the LED behavior behaviour configuration of the Telegesis LRS USB Stick or Hornet-based MMB USB Stick platforms. On these platforms, the LED may be configured to act as an indicator of the application Network State.

...

Anchor
Serial ACK Config Write Serial ACK Config Write

Serial ACK Config Write Command - ( PH:0x55, SH:0x30 )

The Serial ACK Config Write command is sent by the Host to the Module in order to enable or disable mandatory serial acknowledgements.

...

Anchor
Serial ACK Config Request Serial ACK Config Request

Serial ACK Config Request Command - ( PH:0x55, SH:0x31 )

The Serial ACK Config Request command is sent by the Host to the Module in order to query the application Serial ACK Configuration. The command has no payload.

...

Anchor
Serial ACK Config Response Serial ACK Config Response

Serial ACK Config Response Command - ( PH:0x55, SH:0x32 )

The Serial Ack Config Response is sent by the Module to the Host in response to a Serial ACK Config Request. The command conveys the current Serial ACK Configuration of the application indicating whether serial acknowledgements between the Host and Module are mandatory or not.

...

Anchor
Manufacturer ID Request Manufacturer ID Request

Manufacturer ID Request Command - ( PH:0x55, SH:0x40 )

The Manufacturer ID Request is sent by the Host to the Module to query the application Manufacturer ID. This ID is included in the application Node Descriptor and is also applied when querying an OTA server for new firmware images. This command has no payload.

...

Anchor
Manufacturer ID Response Manufacturer ID Response

Manufacturer ID Response Command - ( PH:0x55, SH:0x41 )

The Manufacturer ID Response is sent by the Module to the Host in response to a Manufacturer ID Request. The command conveys the Manufacturer ID of the application.

...

Anchor
Manufacturer ID Write Manufacturer ID Write

Manufacturer ID Write Command - ( PH:0x55, SH:0x42 )

The Manufacturer ID Write command is sent by the Host to the Module to set the Manufacturer ID of the application. This ID is included in the application Node Descriptor and is also applied when querying an OTA server for new firmware images. The command payload is equivalent to the Manufacturer ID Response.

...

Anchor
Sleepy Parameters Request CMD Sleepy Parameters Request CMD

Sleepy Parameters Request CMD Command - ( PH:0x55, SH:0x50 )

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.

...

Anchor
Sleepy Parameters Response CMD Sleepy Parameters Response CMD

Sleepy Parameters Response CMD Command - ( PH:0x55, SH:0x51 )

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.

...

Anchor
Sleepy Parameters Write CMD Sleepy Parameters Write CMD

Sleepy Parameters Write CMD Command - ( PH:0x55, SH:0x52 )

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 behaviorbehaviour.

Payload for Sleepy Parameters Write CMD Command

...

Anchor
Sleepy Hibernate Duration Request CMD Sleepy Hibernate Duration Request CMD

Sleepy Hibernate Duration Request CMD Command - ( PH:0x55, SH:0x53 )

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.

...

Anchor
Sleepy Hibernate Duration Response CMD Sleepy Hibernate Duration Response CMD

Sleepy Hibernate Duration Response CMD Command - ( PH:0x55, SH:0x54 )

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.

...

 

Anchor
Sleepy Hibernate Duration Write CMD Sleepy Hibernate Duration Write CMD

Sleepy Hibernate Duration Write CMD Command - ( PH:0x55, SH:0x55 )

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.

...

Anchor
Sleep Control Stay Awake Duration Write Sleep Control Stay Awake Duration Write

Sleep Control Stay Awake Duration Write - ( PH:0x55, SH:0x58 )

The Sleep Control Stay Awake Duration Write command is issued by the Host to the Module and serves to impose a duration for which the application will stay awake. This allows the Host to override the standard sleep cycle of the application when desired.

...

Anchor
Sleep Control Stay Awake Duration Read Sleep Control Stay Awake Duration Read

Sleep Control Stay Awake Duration Read - ( PH:0x55, SH:0x59 )

The Sleep Control Stay Awake Duration Read command is issued by the Host to the Module to query the Stay Awake Duration of the application. The command has no payload.

Anchor
Sleep Control Stay Awake Duration Response Sleep Control Stay Awake Duration Response

Sleep Control Stay Awake Duration Response - ( PH:0x55, SH:0x5A )

The Sleep Control Stay Awake Duration Read Response is issued by the Module to the Host in response to a Sleep Control Stay Awake Duration Read command. It conveys the remaining Stay Awake Duration of the application, in milliseconds.

...

Anchor
Status Response Status Response

Status Response Command - ( PH:0x55, SH:0x80 )

The Status Response command may be issued either by the Module to the Host, or by the Host to the Module, in order to acknowledge the reception of a command.

...

Anchor
Sleep Control Wakeup Sleep Control Wakeup

Sleep Control Wakeup - ( PH:0x55, SH:0xA0 )

The Sleep Control Wakeup frame is issued by the Host to the Module to wake the application when it is sleeping. On reception, the application will stay awake for a default duration of 50ms. It is expected that the Host will stuff the 19-byte payload with all 0xFF’s.

...

Anchor
Error Error

Error Command - ( PH:0x55, SH:0xE0 )

The Error frame is sent by the Module to the Host to report an application error.

...

Error conditions are reported for diagnostic purposes. Depending on the given error received, there may or may not be an expected action for the Host to take in response.

...

 Back to Top

Anchor
Network Commissioning Frames Network Commissioning Frames

Network Commissioning Frames (0x01)

The Network Commissioning command set allows the Host to prompt the Module to either form a network or join an existing network. A third option exists for performing HA 1.2 EZ-Mode Commissioning, defined as an automated process that prompts the application to join an existing network and, failing to find one, to form its own.

...

Anchor
Join Network Join Network

Join Network Command - ( PH:0x01, SH:0x00 )

The Join Network command is sent by the Host to the Module to prompt the Module to scan for and join an existing network.

...

...

Anchor
Form Network Form Network

Form Network Command - ( PH:0x01, SH:0x01 )

The Form Network command is sent by the Host to the Module to prompt the latter to form a network. Additionally on reception of this command, the application ZigBee Device Type is set to Coordinator.

...

...

Anchor
Permit Join Permit Join

Permit Join Command - ( PH:0x01, SH:0x03 )

The Permit Join command is sent by the Host to the Module in order to prompt the Module to open its Permit Join window for a given duration.

...

Anchor
Leave Network Leave Network

Leave Network Command - ( PH:0x01, SH:0x04 )

The Leave Network command is sent by the Host to the Module in order to prompt the Module to leave the network to which it is currently joined. The command has no payload.

...

Anchor
Rejoin Network Rejoin Network

Rejoin Network Command - ( PH:0x01, SH:0x05 )

The Rejoin Network command is sent by the Host to the Module in order to prompt the latter to rejoin the network to which it is currently joined. Though the Module may automatically engage in Rejoin behavior when having lost the connection to the network (i.e., as determined by the Network Heartbeat), this command provides facilities for the Host to manually engage the process (i.e., to re-initiate Service Discovery and Binding). The command has no payload.

...

Anchor
Network Status Request Network Status Request

Network Status Request Command - ( PH:0x01, SH:0x08 )

The Network Status Request is sent by the Host to the Module to query the application Network State. The Host is not required to issue this command, as the Module will automatically issue a Network Status Response on any change of the application Network State. The command has no payload.

...

Anchor
Network Status Response Network Status Response

Network Status Response Command - ( PH:0x01, SH:0x09 )

The Network Status Response is sent by the Module to the Host, either as a response to the Network Status Requestcommand, or automatically upon a change to the application Network State or Permit Join Duration (i.e., on transition from non-zero to zero or vice versa).

...

Anchor
Trust Center Device Update Trust Center Device Update

Trust Center Device Update Command - ( PH:0x01, SH:0x10 )

When the application ZigBee device type is configured as a coordinator and a network has been formed, the Trust Center Device Update command is sent by the Module to the Host when any device attempts to join or leave that network.

...

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
Network Auto Join Network Auto Join

Network Auto Join Command - ( PH:0x01, SH:0x11 )

The Network Auto Join command is sent by the Host to the Module to prompt the Module to scan all channels for X number of retries and with Y number of seconds delay between each scan.

...

Anchor
Network Reset Auto Join Network Reset Auto Join

Network Reset Auto Join Command - ( PH:0x01, SH:0x12 )

The Network Reset Auto Join command is sent by the Host to the Module to prompt it to leave any network to which it may be joined and then scan all channels for X number of retries and with Y number of seconds of delay between each scan.

...

...

Back to Top

Anchor
Security Configuration Frames Security Configuration Frames

Security Configuration Frames (0x02) 

This section describes commands that set and report on security keys.

...

Anchor
Preconfigured Key Option Write Preconfigured Key Option Write

Preconfigured Key Option Write Command - ( PH:0x02, SH:0x00 )

The Preconfigured Key Option Write command is sent by the Host to the Module and serves to dictate which key the application will use when attempting to join a network; either the Preconfigured Link Key or the key derived from Installation Code.

...

Anchor
Preconfigured Key Option Request Preconfigured Key Option Request

Preconfigured Key Option Request Command - ( PH:0x02, SH:0x01 )

The Preconfigured Key Option Request is sent by the Host to the Module to query the current application Preconfigured Key Option. The Module will respond with a Preconfigured Key Option Response. The command has no payload.

Anchor
Preconfigured Key Option Response Preconfigured Key Option Response

Preconfigured Key Option Response Command - ( PH:0x02, SH:0x02 )

The Preconfigured Key Option Response is sent by the Module to the Host when queried with a Preconfigured Key Option Request. The command has the same payload as the Preconfigured Key Option Writecommand.

...

Anchor
Install Code Request Install Code Request

Install Code Request Command - ( PH:0x02, SH:0x03 )

The Install Code Request frame is sent by the Host to the Module to query the application Installation Code. The Module responds with an Install Code Response. It should be noted that the Installation Code is assigned to the Module at production time and cannot be modified. The command has no payload.

Anchor
Install Code Response Install Code Response

Install Code Response Command - ( PH:0x02, SH:0x04 )

The Install Code Response frame is sent by the Module to the Host when queried with an Install Code Request. 

...

Anchor
Link Key Write Link Key Write

Link Key Write Command - ( PH:0x02, SH:0x05 )

The Link Key Write command is sent by the Host to the Module in order to set the application Preconfigured Link Key. The Host may only set the Preconfigured Link Key while the application is in the Network Down state.

...

Anchor
Link Key Request Link Key Request

Link Key Request Command - ( PH:0x02, SH:0x06 )

The Link Key Request is sent by the Host to the Module to request the current application Link Key. The Module responds with a Link Key Response. When the Module is configured as a coordinator, it will return the Global Trust Center Link Key. When the Module is otherwise configured and not joined to a network, it will return the Preconfigured Link Key and likewise, when joined to a network, it returns the current Trust Center Link Key assigned to it. The command has no payload.

Anchor
Link Key Response Link Key Response

Link Key Response Command - ( PH:0x02, SH:0x07 )

The Link Key Response is sent by the Module to the Host when queried with a Link Key Request. The command has the same payload as the Link Key Write command.

...

Anchor
Network Key Write Network Key Write

Network Key Write Command - ( PH:0x02, SH:0x08 )

The Network Key Write command is sent by the Host to the Module in order to set the application Preconfigured Network Key. The Host may only set the Network Key while the application is in the Network Down state, after which the key will be automatically randomized.

...

Anchor
Network Key Request Network Key Request

Network Key Request Command - ( PH:0x02, SH:0x09 )

The Network Key Request command is sent by the Host to the Module to query the application Network Key. The Module will respond with a Network Key Response. If the application has not formed a network, the response will convey the Preconfigured Network Key. Otherwise, the response will convey the current Network Key. The command has no payload.  

Anchor
Network Key Response Network Key Response

Network Key Response Command - ( PH:0x02, SH:0x0A )

The Network Key Response command is sent by the Module to the Host when queried with a Network Key Request. The command has the same payload as Network Key Write command.

...

...

Back to Top

Anchor
ZigBee Support Configuration Frames ZigBee Support Configuration Frames

ZigBee Support Configuration Frames (0x03)

This section describes the commands used to configure RapidHA’s IEEE functional device type, as well as the endpoints, clusters and attributes that will logically exist on that device.

Anchor
Device Type Write Device Type Write

Device Type Write Command - ( PH:0x03, SH:0x00 )

The Device Type Write command is sent by the Host to the Module in order to configure the application’s IEEE functional device type. The Host is only required to issue this command once after synchronizing with a factory default Module for the first time, as the configuration is preserved in the application’s non-volatile memory.

...

Anchor
Device Type Request Device Type Request

Device Type Request Command - ( PH:0x03, SH:0x01 )

The Device Type Requestis sent by the Host to the Module in order to query the application IEEE functional device type. The command has no payload.

...

Anchor
Device Type Response Device Type Response

Device Type Response Command - ( PH:0x03, SH:0x02 )

The Device Type Response is sent by the Module to the Host in response to a Device Type Request.

...

 

Anchor
Add Endpoint Add Endpoint

Add Endpoint Command - ( PH:0x03, SH:0x10 )

The Add Endpoint command is sent by the Host to the Module in order to configure an application endpoint. This includes defining the Endpoint ID, Profile ID, Device ID, Device Version and the lists of server and client clusters supported on that endpoint.

...

...

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.

...

Anchor
Endpoint List Request Endpoint List Request

Endpoint List Request Command - ( PH:0x03, SH:0x11 )

The Endpoint List Request is sent by the Host to the Module in order to query the application endpoint list. The Host may apply this command to verify the configuration of application endpoints after having created them. The command has no payload.

...

 

Anchor
Endpoint List Response Endpoint List Response

Endpoint List Response Command - ( PH:0x03, SH:0x12 )

The Endpoint List Response is sent by the Module to the Host in response to an Endpoint List Request. The command conveys the Endpoint ID’s of all the configured endpoints supported by the application.

...

 

Anchor
Endpoint Descriptor Request Endpoint Descriptor Request

Endpoint Descriptor Request Command - ( PH:0x03, SH:0x13 )

The Endpoint Descriptor Request is sent by the Host to the Module in order to query the definition of a given application endpoint. The Host may apply this command to verify the full configuration of an application Endpoints after having creating it.

...

 

Anchor
Endpoint Descriptor Response Endpoint Descriptor Response

Endpoint Descriptor Response Command - ( PH:0x03, SH:0x14 )

The Endpoint Descriptor Response is sent by the Module to the Host in response to an Endpoint Descriptor Request.

...

...

 

Anchor
Add Attributes to Cluster Add Attributes to Cluster

Add Attributes to Cluster Command - ( PH:0x03, SH:0x20 )

The Add Attribute to Cluster command is sent by the Host to the Module in order to append attribute definitions to a configured application cluster. The command may specify as many attributes as the maximum payload capacity of a RapidHA frame allows. For a cluster with large number of attributes, the command may be issued as many times as required.

...

Anchor
Attribute Definition Record Format Attribute Definition Record Format

Attribute Definition Record Format

...

 

Anchor
Attribute List Request Attribute List Request

Attribute List Request Command - ( PH:0x03, SH:0x21 )

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

 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.

...

 Expected Host Action 

None.

Anchor
Attribute Request Attribute Request

 Attribute Request Command - ( PH:0x03, SH:0x23 )

The Attribute Request is sent by the Host to the Module in order to query the definition and value of an attribute on a given cluster and endpoint.

...

 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.

...

Anchor
Attribute Response Attribute Response

Attribute Response Command - ( PH:0x03, SH:0x24 )

An Attribute Response is sent by the Module to the Host in response to an Attribute Request.

...

 Expected Host Action 

None.

 

Anchor
Attribute Write Attribute Write

Attribute Write Command - ( PH:0x03, SH:0x25 )

The Attribute Write command is sent by the Host to the Module in order to set the value of an existing attribute residing on a target cluster and endpoint.

...

 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.

...

Anchor
Attribute Report Passthrough Control Attribute Report Passthrough Control

Attribute Report Passthrough Control - ( PH:0x03, SH:0x26 )

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

...

 

Anchor
Clear Endpoint Config Command Clear Endpoint Config Command

Clear Endpoint Config Command - ( PH:0x03, SH:0x30 )

The Clear Endpoint Config command is sent by the Host to the Module in order to wipe all applied configurations of endpoints, clusters, attributes and registered pass-through commands. The command has no payload.

...

Anchor
Register Commands Passthru Register Commands Passthru

Register Commands Passthru Command - ( PH:0x03, SH:0x80 )

The Register Commands Passthru message is sent by the Host to the Module to create an index of those cluster commands that the Module should pass through directly to the Host without additional processing. That is, the Host may specify supported commands that would otherwise result in additional action being taken by the Moduleon their reception, or commands not supported by the Module that would otherwise not be passed to the Host on their reception.

...

...

Back to Top

Anchor
ZDO Messsage Frames ZDO Messsage Frames

ZDO Message Frames (0x04)

This section describes the two ways, unicast and broadcast, for the Host to send a ZDO command. It also describes the commands sent by the Module to communicate ZDO-level information to the Host.

...

Anchor
Send ZDO Unicast Send ZDO Unicast

Send ZDO Unicast Command - ( PH:0x04, SH:0x01 )

The Send ZDO Unicast command is sent by the Host to the Module in order to prompt the Module to send a ZDO message to a single destination node. The command configures the following options:

...

Anchor
Send ZDO Broadcast Send ZDO Broadcast

Send ZDO Broadcast Command - ( PH:0x04, SH:0x02 )

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
ZDO Send Status ZDO Send Status

ZDO Send Status Command - ( PH:0x04, SH:0x03 )

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
ZDO APS Ack ZDO APS Ack

ZDO APS Ack Command - ( PH:0x04, SH:0x04 )

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
ZDO Response Received ZDO Response Received

ZDO Response Received Command - ( PH:0x04, SH:0x05 )

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
ZDO Response Timeout ZDO Response Timeout

ZDO Response Timeout Command - ( PH:0x04, SH:0x06 )

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
ZDO Device Announce Received ZDO Device Announce Received

ZDO Device Announce Received Command - ( PH:0x04, SH:0x1E )

The ZDO Device Announce Received frame is sent by the Module to the Host when a new device announces itself on the network.

...

...

Back to Top

Anchor
ZCL Message Frames ZCL Message Frames

ZCL Message Frames (0x05)

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
Send ZCL Unicast Send ZCL Unicast

Send ZCL Unicast Command - ( PH:0x05, SH:0x00 )

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
Send ZCL Multicast Send ZCL Multicast

Send ZCL Multicast Command - ( PH:0x05, SH:0x01 )

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.

...

...

Anchor
Send ZCL Broadcast Send ZCL Broadcast

Send ZCL Broadcast Command - ( PH:0x05, SH:0x02 )

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
ZCL Send Status ZCL Send Status

ZCL Send Status Command - ( PH:0x05, SH:0x03 )

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
ZCL APS Ack ZCL APS Ack

ZCL APS Ack Command - ( PH:0x05, SH:0x10 )

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
ZCL Response Received ZCL Response Received

ZCL Response Received Command - ( PH:0x05, SH:0x11 )

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
ZCL Response Timeout ZCL Response Timeout

ZCL Response Timeout Command - ( PH:0x05, SH:0x12 )

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
Received Attribute Write Received Attribute Write

Received Attribute Write Command - ( PH:0x05, SH:0x14 )

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

...

Anchor
ZCL Passthru Message ZCL Passthru Message

 ZCL Passthru Message Command - ( PH:0x05, SH:0x20 )

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 0x01 = Network + APS Encryption
7	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
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
ZCL Read Attribute Request ZCL Read Attribute Request

ZCL Read Attribute Request Command - ( PH:0x05, SH:0x30 )

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
ZCL Read Attribute Response ZCL Read Attribute Response

ZCL Read Attribute Response Command - ( PH:0x05, SH:0x31 )

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.

...

...

Anchor
ZCL Write Attribute Request ZCL Write Attribute Request

ZCL Write Attribute Request Command - ( PH:0x05, SH:0x32 )

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.

...

...

Anchor
ZCL Write Attribute Response ZCL Write Attribute Response

ZCL Write Attribute Response Command - ( PH:0x05, SH:0x33 )

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
General Cluster Frames General Cluster Frames

General Cluster Frames (0x11)

The General Clusters command set encompasses the following mandatory ZCL clusters in the general domain:

...

Anchor
Received Reset to Factory Default Received Reset to Factory Default

Received Reset to Factory Default Command - ( PH:0x011, SH:0x00 )

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
Identify Start Identify Start

Identify Start Command - ( PH:0x011, SH:0x10 )

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
Identify Stop Identify Stop

Identify Stop Command - ( PH:0x011, SH:0x11 )

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
Time Client Get Time Time Client Get Time

Time Client Get Time Command - ( PH:0x011, SH:0x40 )

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
Time Client Get Time Response Time Client Get Time Response

Time Client Get Time Response Command - ( PH:0x011, SH:0x41 )

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
Time Client Time Changed Time Client Time Changed

Time Client Time Changed Command - ( PH:0x011, SH:0x42 )

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
Network Time Sync Period Write Network Time Sync Period Write

Network Time Sync Period Write Command - ( PH:0x011, SH:0x43 )

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
Network Time Sync Period Request Network Time Sync Period Request

Network Time Sync Period Request Command - ( PH:0x011, SH:0x44 )

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
Network Time Sync Period Response Network Time Sync Period Response

Network Time Sync Period Response Command - ( PH:0x011, SH:0x45 )

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.

...

...

Back to Top

Anchor
HA Clusters HA Clusters

HA Clusters (0x12)

The HA clusters command set encompasses the following ZCL clusters for common HA applications:

...

Anchor
On Off State Update On Off State Update

On/Off State Update Command - ( PH:0x012, SH:0x00 )

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
Move to Level Move to Level

Move to Level Command - ( PH:0x012, SH:0x20 )

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
Level Move Level Move

Level Move Command - ( PH:0x012, SH:0x21 )

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
Level Step Level Step

Level Step Command - ( PH:0x012, SH:0x22 )

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
Level Stop Level Stop

Level Stop Command - ( PH:0x012, SH:0x23 )

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
Check Battery Attribute Check Battery Attribute

Check Battery Attribute Command - ( PH:0x012, SH:0x24 )

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
Move To Level - On Off Status Move To Level - On Off Status

Move To Level With On/Off Status   - ( PH:0x012, SH:0x25 )

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
Lock Door Lock Door

Lock Door Command  - ( PH:0x012, SH:0x60 )

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
Lock Confirm Lock Confirm

Lock Confirm Command - ( PH:0x012, SH:0x63 )

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
Serial Bootload Frames Serial Bootload Frames

Serial Bootload Frames (0x0B)

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
Query Next Image Response Query Next Image Response

Query Next Image Response Command - ( PH:0x0B, SH:0x02 )

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
Image Block Request Image Block Request

Image Block Request Command - ( PH:0x0B, SH:0x03 )

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
Image Block Response Image Block Response

Image Block Response Command - ( PH:0x0B, SH:0x05 )

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
Upgrade End Request Upgrade End Request

Upgrade End Request Command - ( PH:0x0B, SH:0x06 )

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
Upgrade End Response Upgrade End Response

Upgrade End Response Command - ( PH:0x0B, SH:0x07 )

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.

...

...

Back to Top

Anchor
OTA Upgrade Client Frames OTA Upgrade Client Frames

OTA Upgrade Client Frames (0x0B)

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
OTA Query Configuration Request OTA Query Configuration Request

OTA Query Configuration Request Command - ( PH:0x0B, SH:0x20 )

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
OTA Query Configuration Response OTA Query Configuration Response

OTA Query Configuration Response Command - ( PH:0x0B, SH:0x21 )

The OTA Query Configuration Response frame is sent from the Module to the Host in response to an OTA Query Configuration Request.

...

Anchor
OTA Query Configuration Write OTA Query Configuration Write

OTA Query Configuration Write Command - ( PH:0x0B, SH:0x22 )

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
Image Progress Notification Image Progress Notification

Image Progress Notification Command - ( PH:0x0B, SH:0x23 )

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
OTA Version Configuration Request OTA Version Configuration Request

OTA Version Configuration Request Command - ( PH:0x0B, SH:0x24 )

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
OTA Version Configuration Write OTA Version Configuration Write

OTA Version Configuration Write Command - ( PH:0x0B, SH:0x26 )

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.

...

...

Back to Top

Anchor
OTA Upgrade Server Frames OTA Upgrade Server Frames

OTA Upgrade Server Frames (0xB0)

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
OTA Image Notification OTA Image Notification

OTA Image Notification Command - ( PH:0xB0, SH:0x00 )

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
OTA Query Next Image Request OTA Query Next Image Request

OTA Query Next Image Request Command - ( PH:0xB0, SH:0x01 )

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
OTA Query Next Image Response OTA Query Next Image Response

OTA Query Next Image Response Command - ( PH:0xB0, SH:0x02 )

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
OTA Image Block Request OTA Image Block Request

OTA Image Block Request Command - ( PH:0xB0, SH:0x03 )

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.

...

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
OTA Image Block Response OTA Image Block Response

OTA Image Block Response Command - ( PH:0xB0, SH:0x05 )

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
OTA Upgrade End Request OTA Upgrade End Request

OTA Upgrade End Request Command - ( PH:0xB0, SH:0x06 )

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
OTA Upgrade End Response OTA Upgrade End Response

OTA Upgrade End Response Command - ( PH:0xB0, SH:0x07 )

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,

...

...

Back to Top

Anchor
Diagnostic Frames Diagnostic Frames

Diagnostic Frames (0xD1)

This section describes the commands that initiate and respond to network scans.

...

Anchor
Network Scan Request Network Scan Request

Network Scan Request Command - ( PH:0xD1, SH:0x00 )

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
Network Scan Response Network Scan Response

Network Scan Response Command - ( PH:0xD1, SH:0x01 )

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
Network Scan Complete Network Scan Complete

Network Scan Complete Command - ( PH:0xD1, SH:0x02 )

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
Latency Request Latency Request

Latency Request Command - ( PH:0xD1, SH:0x10 )

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
Latency Response Latency Response

Latency Response Command - ( PH:0xD1, SH:0x11 )

The Latency Response frame is sent from the Module to the Host with the result of the latency test initiated with a Latency Request.

...