/
Frame Payload Definitions

Frame Payload Definitions

Sept 20, 2018

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.

New in RapidHA v1.7

New sleep control frames under the Utility command group (PH: 0x55) provide the user with a wake-up handshaking scheme, as well as total and accurate control of application sleep cycles.





Back to Top

Utility Frames ( PH: 0x55 )

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

Frame Name

Secondary Header Byte

Allowed Context

Sent By Host/Module

Frame Name

Secondary Header Byte

Allowed Context

Sent By Host/Module

Reset

0x00

All Contexts

Host

Module Info Request

0x02

All Contexts

Host

Module Info Response

0x03

N/A

Module

Bootloader Version Request

0x04

All Contexts

Host

Bootloader Version Response

0x05

N/A

Module

Application Version Count Request

0x06

All Contexts

Host

Application Version Count Response

0x07

N/A

Module

Application Version Request

0x08

All Contexts

Host

Application Version Response

0x09

N/A

Module

Restore Defaults

0x10

All Contexts

Host

Host Startup Ready

0x20

All Contexts

Host

Startup Sync Request

0x21

All Contexts

Module

Startup Sync Complete

0x22

Startup Config Only

Host

Antenna Configuration Request

0x23

All Contexts

Host

Antenna Configuration Response

0x24

N/A

Module

Antenna Configuration Write

0x25

All Contexts

Host

LED Configuration Request

0x26

All Contexts

Host

LED Configuration Response

0x27

N/A

Module

LED Configuration Write

0x28

All Contexts

Host

Serial ACK Config Write

0x30

All Contexts

Host

Serial ACK Config Request

0x31

All Contexts

Host

Serial ACK Config Response

0x32

N/A

Module

Manufacturer ID Request

0x40

All Contexts

Host

Manufacturer ID Response

0x41

N/A

Module

Manufacturer ID Write

0x42

Startup Config Only

Host

Sleepy Parameters Request CMD

0x50

All Contexts

Host

Sleepy Parameters Response CMD

0x51

N/A

Module

Sleepy Parameters Write CMD

0x52

All Contexts

Host

Sleepy Hibernate Duration Request CMD

0x53

All Contexts

Host

Sleepy Hibernate Duration Response CMD

0x54

N/A

Module

Sleepy Hibernate Duration Write CMD

0x55

All Contexts

Host

Sleep Control Stay Awake Duration Write

0x58

All Contexts

Host

Sleep Control Stay Awake Duration Read

0x59

All Contexts

Host

Sleep Control Stay Awake Duration Response

0x5A

All Contexts

Module

Status Response

0x80

N/A

Host or Module

Sleep Control Wakeup

0xA0

All Contexts

Host

Error

0xE0

All Contexts

Module

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.

Effect on Receipt

The Module reboots.

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

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

Effect on Receipt

The Module will respond with a Module Info Response command.

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

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

Payload for Module Info Response Command

Byte Index

Field Name

Notes

Byte Index

Field Name

Notes

0

Major Firmware Version



1

Minor Firmware Version



2

Build Firmware Version



3,4

Application Information

i.e. Protocol Type (RapidSE,RapidHA...)

16-bit Enumeration:
0x0000, 0x0001 = Reserved
0x0002 = RapidHA
0x0003 – 0xFFFF = Reserved

5..12

EUI64

Extended Unique Identifier, 64 bits in length

13

Hardware Type

0x00 = Reserved
0x01 = EM250
0x02 = EM357
0x03 = STM32W108

14

Bootloader Type

0x00 = Standalone Bootloader
0x01 = Application Bootloader

0x02 = No Bootloader
0x03-0xFF = Reserved


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.

Effect on Receipt

The Module will respond with a 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.

The Bootloader Type (e.g., standalone or application bootloader) is conveyed via the Module Info Response command.

Payload for Bootloader Version Response Command

Byte Index

Field Name

Notes

Byte Index

Field Name

Notes

0..3

Ember Version

4-byte Ember version identifier

4..7

MMB Version

0x00 = Build Version
0x01 = Minor Version
0x02 = Major Version
0x03 = Bootloader Family 8-bit Enumeration:
            0x00 = Biko Application Bootloader
            If the Bootloader Family is not Biko (i.e., SE 1.1 Application Bootloader or otherwise)
            the entire MMB Version field will default to 0xFFFFFFFF
0xFFFFFFFF = Unknown

Expected Host Action

None.

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.

Effect on Receipt

The Module will respond with an 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



Byte Index

Field Name

Notes

Byte Index

Field Name

Notes

0

Version String Count

A count of the total number of Application Version Strings available from the running application.

Expected Host Action

None. 

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

The Application Version Request is sent from the Host to the Module to query a given Application Version String describing either the Application Bootloader Version, the core RapidHA Version or the Virtual Host Application Version. The request payload length is 1 octet. 

Payload for Application Version Request Command

Byte Index

Field Name

Notes

Byte Index

Field Name

Notes

0

Version Index

0x00 - Retrieve Bootloader Version
0x01 - Retrieve RapidHA Version
0x02 - 0xFF - Retrieve Virtual Host Version 

Effect on Receipt

The Module will respond with an Application Version Response.

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

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

Payload of Application Version Response Command

Byte Index

Field Name

Notes

Byte Index

Field Name

Notes

0

Version String Index

The array index (0 based) that this command relates to. 

1

Version Type

The type of version string returned. See Version Types.

2..(n + 3)

Version

The version being returned. The length n is specified in the first octet of the field. A total of n bytes will follow this length byte containing data which shall be interpreted based on the Version Type.

Expected Host Action

None.

Version Types 

Type ID

Type Name

Length (Octets)

Type ID

Type Name

Length (Octets)

0x00

LSB Binary Type

4

0x01

MSB Binary Type

4

0x02

String Type

Variable

0x03

LSB Binary Type

2

0x04

MSB Binary Type

2

0x05 - 0xFE

Reserved

N/A

0xFF

Invalid

N/A 


LSB Binary Type 

A type value of LSB Binary Type indicates that the version string is being provided as a series of binary encoded bytes that represent the version string in a dotted version format with the least significant byte provided first. For example, a binary value of 0x01,0x02,0x03,0x04 provided using this encoding would be translated to 4.3.2.1 (or possibly 4.3.2rc1) when displayed to the user. This is the default encoding for version numbers.

MSB Binary Type

A type value of MSB Binary Type indicates that the version string is being provided as a series of binary encoded bytes that represent the version string in a dotted version format with the most significant byte provided first. For example, a binary value of 0x05,0x06,0x07, 0x08 provided using this encoding would be translated to 5.6.7.8 (or possibly 5.6.7rc8) when displayed to the user.

String Type

A type value of String Type indicates that the version string is being provided as an ASCII encoded string of length n. The value will not be null terminated as the length is provided. For example, a binary value of 0x31,0x2e,0x32,0x2e,0x30,0x72,0x63,0x31 provided using this encoding would be translated to 1.2.0rc1.

Invalid

A type value of Invalid indicates that the requested element is invalid. Typically this indicates that a request was made for an index which lies outside of the valid range of version string indices.

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

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

Effect on Receipt

The Module restores all non-volatile elements to their factory default settings, leaves the network if it is joined to one or dissolves the network if it has formed one, and then reboots.

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

Legal Notices

Copyright © 2017 MMB Networks, Inc. All rights reserved.
Confidential materials prepared and delivered by MMB Networks for receipt and review only by any partner subject to a valid and enforceable MMB Networks confidentiality agreement. Any receipt, review, or misuse of any of the content exchanged hereunder by any party not a party to this confidential exchange shall be subject to any and all rights available under the law. All rights, title and interest to the materials shall remain with MMB Networks.
Any suggestions provided to MMB Networks with respect to MMB Networks' products or services shall be collectively deemed “Feedback.” You, on behalf of yourself, or if you are providing Feedback on behalf of your employer or another entity, represent and warrant that you have full legal authority to bind such entity to these terms, agree to grant and hereby grant to MMB Networks a nonexclusive, perpetual, irrevocable, royalty free, worldwide license to use and otherwise exploit such Feedback within any MMB Networks products and services.