This section describes a wide range of command functionality that works on a system-wide level under the Primary Header 0x55.

Secondary Headers

Primary Headers

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

Overview

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

Payload

The command has no payload.

Effect on Receipt

The Module reboots.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

The Module Info Request command is sent from the Host to the Module to query the Module’s version and application type.

Payload

The command has no payload.

Effect on Receipt

The Module will respond with a Module Info Response command.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

The Module Info Response command is sent from the Module to the Host in response to a Module Info Request command.

Payload

Byte Index	Field Name	Notes
0	Major Firmware Version
1	Minor Firmware Version
2	Build Firmware Version
3,4	Application Information	Indicates the serial protocol spoken by the application, 16-bit Enumeration: 0x0000 - 0x0001 = Reserved 0x0002 = RapidHA 0x0003 = RapidConnect 0x0004 - 0xFFFF = Reserved
5..12	EUI64	Extended Unique Identifier, 64 bits in length, LSB First
13	Hardware Version	0x00 = Hardware Version Unknown 0x01 = EM250 0x02 = EM357 0x03 = STM32W108 0x04 = KW41Z 0x05 = EFR32MG1B232F256GM32 0x06 = EFR32MG1B132F256GM32 0x07 = EFR32MG1V132F256GM32 0x08 = EFR32MG13P732F512GM32 0x09 = EFR32MG13P732F512GM48
14	Bootloader Type	0x00 = EM35x Standalone Bootloader 0x01 = EM35x Application Bootloader 0x02 = Gecko Standalone Bootloader 0x03 = Gecko Application Bootloader (XMODEM Transfer) 0x04 = Gecko Application Bootloader (Serial Protocol Transfer) 0x05 - 0xFE = Reserved 0xFF = No Bootloader

Effect on Receipt

None.

Allowed Context

Same context as the request.

Sent By Host/Module

Module.

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

Overview

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.

Payload

The command has no payload.

Effect on Receipt

The Module will respond with an Application Version Count Response.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

The Application Version Count Response is sent from the Module to the Host. The response payload length is 1 octet.

Payload

Byte Index	Field Name	Notes
0	Version String Count	A count of the total number of Application Version Strings available from the running application.

Effect on Receipt

None.

Allowed Context

Same context as the request.

Sent By Host/Module

Module.

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

Overview

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 RapidConnect Version or the Virtual Host Application Version. The request payload length is 1 octet.

Payload

Byte Index	Field Name	Notes
0	Version Index	0x00 - Retrieve Bootloader Version 0x01 - Retrieve RapidConnect Version 0x02 - 0xFF - Retrieve Virtual Host Version

Effect on Receipt

The Module will respond with an Application Version Response.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

The Application Version Response is sent from the Module to the Host. The response payload length is variable.

Payload

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 table below.
2	Version Length	The Length of the version
3..n	Version	The version being returned. A total of n shall be interpreted based on the Version Type.

Version Types

Type ID	Type Name	Length (Octets)
0x00	LSB Binary Type	4
0x01	MSB Binary Type	4
0x02	String Type	Variable
0x03 - 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.

Effect on Receipt

None.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

( PH:0x55, SH:0x10 ) - Restore Defaults Command

Overview

The Restore Defaults frame is sent from the Host to the Module and serves to restore the Module to its factory default settings.

Payload

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.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

( PH:0x55, SH:0x20 ) - Host Startup Ready Command

Overview

The Host shall send the Host Startup Ready command to the Module after it starts up and is ready for communication.

Payload

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

Allowed Context

All Contexts.

Sent By Host/Module

Host.

( PH:0x55, SH:0x21 ) - Startup Sync Request Command

Overview

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, signalling the completion of the configuration and update process.

Payload

Byte Index	Field Name	Notes
0	Running State	0x00 = Starting Up 0x01 = Already Running
1	Configuration State	0x00 = Factory Default 0x01 = Needs Endpoint Configuration 0x02 = Fully Configured

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.

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.

Effect on Receipt

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.

Allowed Context

All Contexts.

Sent By Host/Module

Module.

( PH:0x55, SH:0x22 ) - Startup Sync Complete Command

Overview

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.

Payload

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.

Allowed Context

Startup Config Only.

Sent By Host/Module

Host.

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

Overview

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 Z357PA2x module. For other module versions, the antenna configuration is done in hardware and cannot be adjusted via firmware.

Payload

The command has no payload.

Effect on Receipt

The Module will respond with an Antenna Configuration Response.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

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 Z357PA2x module. If the application is not operating on that platform, the response indicates that antenna configuration is not supported.

Payload

Byte Index	Field Name	Notes
0	Active Antenna	0x00 – PCB (Default) 0x01 – External 0xFF – Antenna Configuration Not Supported

Effect on Receipt

None.

Allowed Context

Same context as the request.

Sent By Host/Module

Module.

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

Overview

The Antenna Configuration Write command is sent by the Host to the Module to select the hardware antenna configuration of the Z357PA2x module.

Payload

Byte Index	Field Name	Notes
0	Active Antenna	0x00 – PCB 0x01 – External

Effect on Receipt

The Module will respond with an Antenna Configuration Response.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

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

Payload

The command has no payload.

Effect on Receipt

The Module will respond with an LED Configuration Response.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

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 Z357PA30-USB USB Stick platforms. On these platforms, the LED may be configured to act as an indicator of the application Network State.

Payload

Byte Index	Field Name	Notes
0	LED Configuration	0x00 – Always Off (Default) 0x01 – On/Indicating Network State. Expected LED behavior is as follows: Blinking LED = Scanning Solid LED/LED On = Joined LED Off = Network Down

Byte Index

Field Name

Notes

LED Configuration

0x00 – Always Off (Default)
0x01 – On/Indicating Network State.

Expected LED behavior is as follows:

Blinking LED = Scanning
Solid LED/LED On = Joined
LED Off = Network Down

Effect on Receipt

The Module will respond with an LED Configuration Response.

Allowed Context

Same context as request.

Sent By Host/Module

Module.

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

Overview

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

Payload

Byte Index	Field Name	Notes
0	LED Configuration	0x00 – Always Off (Default Telegesis) Always On (Default MMB USB Stick) 0x01 – Indicating Network State. Expected LED behavior is as follows: Blinking LED = Scanning Solid LED/LED On = Joined LED Off = Network Down

Byte Index

Field Name

Notes

LED Configuration

0x00 – Always Off (Default Telegesis)
Always On (Default MMB USB Stick)

0x01 – Indicating Network State.

Expected LED behavior is as follows:

Blinking LED = Scanning
Solid LED/LED On = Joined
LED Off = Network Down

Effect on Receipt

If operating on the Telegesis LRS USB Stick or MMB USB Stick platform, the hardware LED will act as an indicator of the application Network State as described.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

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

Payload

Byte Index	Field Name	Notes
0	Serial ACK Configuration	0x00 = Serial ACK Disabled 0x01 = Serial ACK Enabled

Effect on Receipt

The Module shall apply the new Serial ACK Configuration.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

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.

Payload

This command has no paylaod

Effect on Receipt

The Module shall respond with a Serial ACK Config Response.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

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.

Payload

Byte Index	Field Name	Notes
0	Serial ACK Configuration	0x00 = Serial ACK Disabled 0x01 = Serial ACK Enabled

Effect on Receipt

The Module shall respond with a Serial ACK Config Response.

Allowed Context

Same context as the request

Sent By Host/Module

Module.

(PH:0x55, SH:0x33) - Serial Frame Outgoing Delay Request Command

Overview

The Serial Frame Outgoing Delay Request is sent from Host to Module to query the Serial Frame Outgoing Delay in milliseconds. This command has no payload.

Payload

This command has no payload.

Effect on Receipt

The Module shall respond with a Serial Frame Outgoing Delay Response Command.

Allowed Context

All contexts.

Sent By Host/Module

Host.

(PH:0x55, SH:0x34) - Serial Frame Outgoing Delay Response Command

Overview

The Serial Frame Outgoing Delay Response is sent by the Module to the Host in response to the Serial Frame Outgoing Delay Request Command. The command conveys the application's serial frame outgoing delay in milliseconds.

Payload

Byte Index	Field Name	Notes
0	Outgoing Delay	1-byte value indicating the delay between outgoing serial frames in ms. Default is 0x32 (50ms) Allowable Range: 0x00 - 0xFF

Byte Index

Field Name

Notes

Outgoing Delay

1-byte value indicating the delay between outgoing serial frames in ms.

Default is 0x32 (50ms)

Allowable Range: 0x00 - 0xFF

Effect on Receipt

None.

Allowed Context

All contexts.

Sent By Host/Module

Module.

(PH:0x55, SH:0x35) - Serial Frame Outgoing Delay Write Command

Overview

The Serial Frame Outgoing Delay Write is sent by the Host to the Module to set the serial frame outgoing delay in milliseconds.

Payload

Byte Index	Field Name	Notes
0	Outgoing Delay	1-byte value indicating the delay between outgoing serial frames in ms. Default is 0x32 (50ms). Allowable Range: 0x00 - 0xFF

Byte Index

Field Name

Notes

Outgoing Delay

1-byte value indicating the delay between outgoing serial frames in ms.

Default is 0x32 (50ms).

Allowable Range: 0x00 - 0xFF

Effect on Receipt

The Module shall apply the new serial frame outgoing delay. The value will be used as the minimum delay between each serial frame from Module to Host.

Allowed Context

All contexts.

Sent By Host/Module

Host.

(PH:0x55, SH:0x36) - Serial Frame Outgoing Retry Delay Request Command

Overview

The Serial Frame Outgoing Retry Delay Request is sent from Host to Module to query the Serial Frame Outgoing Retry Delay in milliseconds. This command has no payload.

Payload

This command has no payload.

Effect on Receipt

The Module shall respond with a Serial Frame Outgoing Retry Delay Response Command.

Allowed Context

All contexts.

Sent By Host/Module

Host.

(PH:0x55, SH:0x37) - Serial Frame Outgoing Retry Delay Response Command

Overview

The Serial Frame Outgoing Retry Delay Response is sent from Module to Host in response to the Serial Frame Outgoing Retry Delay Request Command. The command conveys the application's serial frame outgoing retry delay in milliseconds.

Payload

Byte Index	Field Name	Notes
0,1	Outgoing Retry Delay	2-byte value indicating the retry delay between outgoing serial frames in milliseconds. Default is 0x01F4 (500ms). Allowable Range: 0x0000 - 0xFFFF

Byte Index

Field Name

Notes

0,1

Outgoing Retry Delay

2-byte value indicating the retry delay between outgoing serial frames in milliseconds.

Default is 0x01F4 (500ms).

Allowable Range: 0x0000 - 0xFFFF

Effect on Receipt

None.

Allowed Context

All contexts.

Sent By Host/Module

Module.

(PH:0x55, SH:0x38) - Serial Frame Outgoing Retry Delay Write Command

Overview

The Serial Frame Outgoing Retry Delay Write is sent by the Host to the Module to set the serial frame outgoing retry delay in milliseconds. The value is not retained through power-cycles. Adjust this number with caution. A value that is too low may trigger unnecessary retries.

Payload

Byte Index	Field Name	Notes
0,1	Outgoing Retry Delay	2-byte value indicating the retry delay between outgoing serial frames in milliseconds. Default is 0x1F4 (500ms) Allowable Range: 0x0000 - 0xFFFF

Byte Index

Field Name

Notes

0,1

Outgoing Retry Delay

2-byte value indicating the retry delay between outgoing serial frames in milliseconds.

Default is 0x1F4 (500ms)

Allowable Range: 0x0000 - 0xFFFF

Effect on Receipt

The Module shall apply the new serial frame outgoing retry delay period. This adjusts the period of Module expecting a response from Host. If Host does not respond within the expected response period, Module will perform retry on the previously sent serial frame.

Allowed Context

All contexts.

Sent By Host/Module

Host.

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

Overview

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.

Payload

This command has no payload

Effect on Receipt

The Module shall respond with a Manufacturer ID Response.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

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.

Payload

Byte Index	Field Name	Notes
0,1	Manufacturer ID	16-bit Manufacturer ID, as assigned by ZigBee Alliance. Default is the MMB Manufacturer ID, 0x109A.

Byte Index

Field Name

Notes

0,1

Manufacturer ID

16-bit Manufacturer ID, as assigned by ZigBee Alliance.

Default is the MMB Manufacturer ID, 0x109A.

Effect on Receipt

None.

Allowed Context

Same context as request.

Sent By Host/Module

Module.

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

Overview

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.

Payload

Byte Index	Field Name	Notes
0,1	Manufacturer ID	16-bit Manufacturer ID, as assigned by ZigBee Alliance. Default is the MMB Manufacturer ID, 0x109A.

Byte Index

Field Name

Notes

0,1

Manufacturer ID

16-bit Manufacturer ID, as assigned by ZigBee Alliance.

Default is the MMB Manufacturer ID, 0x109A.

The Manufacturer ID may only be configured during the Startup Synchronization phase and prior to forming or joining a network. If the Manufacturer ID Write command is issued after the network is formed or joined, the Module will send a Status Response Command to the Host with 0x01 (Invalid Call) in its payload.

The Manufacturer ID is stored in non-volatile memory and therefore only needs to be set once. If the value 0xFFFF is used as the command’s parameter, then the Manufacturer ID will be the default value, which is 0x109A, the MMB Manufacturer ID.

Effect on Receipt

The Module shall send one of the the status response values shown below and apply the new Manufacturer ID and store it to non-volatile memory if successful.

Status Responses to Manufacturer ID Write Command

Status Response	Enum	Description
Success	0x00	Module received the command and will start the full application.
Invalid Call	0x01	Already on a network. The command can only be called in state of Network Down.

Allowed Context

Startup Config Only.

Sent By Host/Module

Host.

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

Overview

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.

Payload

This command has no payload.

Effect on Receipt

The Module shall respond with a Sleepy Parameters Response CMD command.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

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.

Payload

Byte Index	Field Name	Notes
0,1	Nap Duration	2-byte (0x0000 - 0xFFFF) value indicating the interval in quarter-seconds during which time the application will nap. Default is 0x0002 (2qs)
2..5	Hibernate Duration	4-byte (0x00000000 - 0xFFFFFFFF) value indicating the interval in quarter-seconds during which time the application will hibernate. Default is 0x0014 (20qs)
6,7	Non-Sleeping Poll Interval	2-byte (0x0000 - 0xFFFF) value representing polling interval in quarter-seconds when the device is not sleeping. Default is 0x0002 (2qs)
8,9	Poll Fail Trigger Rejoin Duration	2-byte (0x0000 - 0xFFFF) value that triggers the device to rejoin the network if no response is sent from the Module. Default is 0x00F0 (240qs)

Effect on Receipt

None

Allowed Context

Same context as the request.

Sent By Host/Module

Module.

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

Overview

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.

Paylaod

Byte Index	Field Name	Notes
0,1	App Nap Duration	2-byte (0x0000 - 0xFFFF) value indicating the interval in quarter-seconds during which time the application will nap. Default is 0x0002 (2qs)
2..5	App Hibernate Duration	4-byte (0x00000000 - 0xFFFFFFFF) value indicating the interval in quarter-seconds during which time the application will hibernate. Default is 0x0014 (20qs)
6,7	Non-Sleeping Poll Interval	2-byte (0x0000 - 0xFFFF) value representing polling interval in quarter-seconds during which time the device is not sleeping. Default is 0x0002 (2qs)
8,9	Poll Fail Trigger Rejoin Duration	2-byte (0x0000 - 0xFFFF) value that triggers the device to rejoin if no response is returned from Module. Default is 0x00F0 (240qs)

Effect on Receipt

The Module will send a Status Response to the Host. The table below lists the possible return values for this command.

Status Responses to Sleepy Hibernate Duration Write CMD Command

Status Response	Enum	Description
Success	0x00	Request successfully transmitted
Invalid Length	0x07	The length of the payload does not match

Allowed Context

All contexts

Sent By Host/Module

Host.

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

Overview

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.

Payload

This command has no payload.

Effect on Receipt

The Module shall respond with a Sleepy Hibernate Duration Response CMD frame.

Allowed Context

All contexts

Sent By Host/Module

Host.

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

Overview

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.

Payload

Byte Index	Field Name	Notes
0..3	App Hibernate Duration	4-byte (0x00000000 - 0xFFFFFFFF) value indicating the interval in quarter-seconds during which time the application will hibernate. Default is 0x0014 (20qs)

Byte Index

Field Name

Notes

0..3

App Hibernate Duration

4-byte (0x00000000 - 0xFFFFFFFF) value indicating the interval in quarter-seconds during which time the application will hibernate.

Default is 0x0014 (20qs)

Effect on Receipt

None.

Allowed Context

Same context as the request.

Sent By Host/Module

Module.

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

Overview

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.

Payload

Byte Index	Field Name	Notes
0..3	App Hibernate Duration	4-byte (0x00000000 - 0xFFFFFFFF) value indicating the interval in quarter-seconds during which time the application will hibernate. Default is 000x14 (20qs) 0xFFFFFFFF will not write to field.

Byte Index

Field Name

Notes

0..3

App Hibernate Duration

4-byte (0x00000000 - 0xFFFFFFFF) value indicating the interval in quarter-seconds during which time the application will hibernate.

Default is 000x14 (20qs)
0xFFFFFFFF will not write to field.

Effect on Receipt

The Module will return a Status Response to the Host. The table below lists the possible return values for this command.

Status Responses to Sleepy Hibernate Duration Write CMD Command

Status Response	Enum	Description
Success	0x00	Request successfully transmitted
Invalid Length	0x07	The length of the payload does not match

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

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.

Specifying a Stay Wake Duration of 0 will return the application to the sleep state upon the subsequent application tick, provided there are no pending tasks.

Payload

Bytes	Field Name	Notes
0.. 3	Stay Awake Duration	The duration for which the application should stay awake, in milliseconds. A value of 0 will return the application to the sleep state upon the subsequent application tick, provided there are no pending tasks.

Bytes

Field Name

Notes

0.. 3

Stay Awake Duration

The duration for which the application should stay awake, in milliseconds.

A value of 0 will return the application to the sleep state upon the subsequent application tick, provided there are no pending tasks.

Effect on Receipt

Module shall stay awake for the specified period.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

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.

Payload

This command has no payload.

Effect on Receipt

None.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

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

Overview

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.

Payload

Bytes	Field Name	Notes
0.. 3	Stay Awake Duration	Remaining stay awake duration in milliseconds at the time the Read query was received.

Effect on Receipt

None.

Allowed Context

Same context as request.

Sent By Host/Module

Module.

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

Overview

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.

Payload

Byte Index	Field Name	Notes
0	Status	0x00 = Success 0x01 = Invalid Call 0x02 = Invalid Data 0x03 = Unsupported 0x04 = Storage Full 0x05 = No Entry Found 0x06 = Invalid Data Type 0x07 = Incorrect Length 0x08 = Endpoint Not Found 0x09 = Cluster Not Found 0x0C = Out of Memory 0x0D = Send Failure 0x0E = APS Ack Timeout 0x0F = Endpoint Configuration Locked 0x10 = Duplicate Data 0x11 = Busy 0x12 = Out of Range 0x13 = Unknown Serial Command 0xFF = Unknown Failure

Effect on Receipt

None.

Allowed Context

All contexts.

Sent By Host/Module

Both.

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

Overview

The Sleep Control Wakeup frame is issued by the Host to the Module to wake the application when it is sleeping.

The Host may then either send a serial message within the 50ms wake window or issue the Sleepy Control Stay Awake Duration Write command to force the application stay awake for a longer specified duration.

Payload

Byte Index	Field Name	Notes
0.. 18	Filler Bytes	Stuff all payload bytes with 0xFF

Effect on Receipt

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.

Allowed Context

All contexts.

Sent By Host/Module

Host.

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

Overview

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

Payload

Byte Index	Field Name	Notes
0	Error Condition	An enumeration of Error Conditions: Network Error Conditions: 0x00 – Reserved 0x01 – Scanning Error 0x02 – Key Establishment Error 0x03 – Service Discovery and Binding Error 0x04 – Forming Network Error 0x05..0x0F – Reserved Reset Error Conditions: 0x10 – Reset Error 0x11..0x1F – Reserved Synchronization Error Conditions: 0x20 – Synchronization Error 0x21..0x2F – Reserved Bootload Error Conditions: 0xB0 – Local Bootload Error 0xB1 – OTA Client Bootload Error 0xB2..0xBF – Reserved
1	Sub-Error	Sub-Errors associated with the given Error Condition. Associated with FORMING_NETWORK_ERROR (0x04) 0xAB – SUBERR_NO_BEACON // usually means that a conflicting PAN ID exists Associated with LOCAL_BOOTLOAD_ERROR (0xB0) 0x00 – SUBERR_INVALID_MANUFACTURER_ID 0x01 – SUBERR_INVALID_TARGET_EUI64 0x02 – SUBERR_OUT_OF_ORDER_TRANSMISSION 0x03 – SUBERR_INVALID_LOCAL_IMAGE 0x04 – SUBERR_NO_APP_BOOTLOADER Associated with OTA_BOOTLOAD_ERROR (0xB1) 0x00 – SUBERR_DOWNLOAD_TIMEOUT 0x01 – SUBERR_INVALID_OTA_IMAGE 0x02 – SUBERR_SERVER_ABORTED 0x03 – SUBERR_CLIENT_ABORTED 0x04 – SUBERR_MAX_ERRORS_EXCEEDED 0x05 – SUBERR_STORAGE_FAILURE

Byte Index

Field Name

Notes

Error Condition

An enumeration of Error Conditions:

Network Error Conditions:

0x00 – Reserved
0x01 – Scanning Error
0x02 – Key Establishment Error
0x03 – Service Discovery and Binding Error
0x04 – Forming Network Error
0x05..0x0F – Reserved

Reset Error Conditions:

0x10 – Reset Error
0x11..0x1F – Reserved

Synchronization Error Conditions:

0x20 – Synchronization Error
0x21..0x2F – Reserved

Bootload Error Conditions:

0xB0 – Local Bootload Error
0xB1 – OTA Client Bootload Error
0xB2..0xBF – Reserved

Sub-Error

Sub-Errors associated with the given Error Condition.

Associated with FORMING_NETWORK_ERROR (0x04)
0xAB – SUBERR_NO_BEACON
// usually means that a conflicting PAN ID exists

Associated with LOCAL_BOOTLOAD_ERROR (0xB0)
    0x00 – SUBERR_INVALID_MANUFACTURER_ID
    0x01 – SUBERR_INVALID_TARGET_EUI64
    0x02 – SUBERR_OUT_OF_ORDER_TRANSMISSION
    0x03 – SUBERR_INVALID_LOCAL_IMAGE
    0x04 – SUBERR_NO_APP_BOOTLOADER

Associated with OTA_BOOTLOAD_ERROR (0xB1)
    0x00 – SUBERR_DOWNLOAD_TIMEOUT
    0x01 – SUBERR_INVALID_OTA_IMAGE
    0x02 – SUBERR_SERVER_ABORTED
    0x03 – SUBERR_CLIENT_ABORTED
    0x04 – SUBERR_MAX_ERRORS_EXCEEDED
    0x05 – SUBERR_STORAGE_FAILURE

Effect on Receipt

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.

Browser not supported