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

...

 

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.

...

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.

...

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

...

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.

...

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.

...

 

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.

...

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:

...

• (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 )

...