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.
Query Next Image Response Command - ( PH:0x0B, SH:0x02 )
The Query Next Image Response frame is sent from the Host to the Module and prompts the Module to prepare its external flash memory to receive a new image. Any existing firmware image in flash is erased.
Payload for Query Next Image Response Command
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Node ID | 0xFFFF indicates that the EUI64 is used. |
2..9 | EUI64 Address | |
10 | Endpoint ID | 0xFF indicates a request on all endpoints. |
11 | Status | 8-bit Enumeration: 0x00 = Success |
12,13 | Manufacturer Code | For local bootloading, this field must be 0x109A. |
14,15 | Image Type | Unused - for backwards compatibility. Set to 0x0000 |
16..19 | File Version | Optional. Number used here will be echoed back in all subsequent frames for the transaction. For example, this field can be used by the Host to differentiate multiple concurrent updates, or for any other purpose the Host requires. |
20..23 | Image Size |
| Allowed Context | Sent By Host/Module |
|---|---|
| All Contexts | Host |
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.
Payload for Image Block Request Command
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Node ID | 0xFFFF indicates that the EUI64 is used. |
2..9 | EUI64 Address | |
10 | Endpoint ID | 0xFF indicates a request on all endpoints. |
11 | Field Control | Bit 0 – Request node’s IEEE address present |
12,13 | Manufacturer Code | |
14,15 | Image Type | Unused - for backwards compatibility. Set to 0x0000 |
16..19 | File Version | Will contain the value initially set in the Query Next Image Response / OTA Query Next Image Response frames by the Host. |
20..23 | File Offset | |
24 | Maximum Data Size | N <= 128, where N is data size in octets. |
| Allowed Context | Sent By Host/Module |
|---|---|
| All Contexts | Module |
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.
Payload for Image Block Response Command
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Node ID | 0xFFFF indicates that the EUI64 is used. |
2..9 | EUI64 Address | |
10 | Endpoint ID | 0xFF indicates a request on all endpoints. |
11 | Status | |
12,13 | Manufacturer Code | |
14,15 | Image Type | Unused - for backwards compatibility. Set to 0x0000 |
16..19 | File Version | Will contain the value initially set in the Query Next Image Response / OTA Query Next Image Response frames by the Host. |
20..23 | File Offset | |
24 | Data Size | N <= 128, where N is data size in octets. |
25..(24+N) | Data |
| Allowed Context | Sent By Host/Module |
|---|---|
| All Contexts | Host |
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.
Payload for Upgrade End Request Command
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Node ID | Node ID of Module |
2..9 | EUI64 | EUI64 of Module |
10 | Endpoint ID | Endpoint of Module |
11 | Status | 0x00 = Success |
12,13 | Manufacturer Code | |
14,15 | Image Type | Unused - for backwards compatibility. Set to 0x0000 |
16..19 | File Version | Will contain the value initially set in the Query Next Image Response / OTA Query Next Image Response frames by the Host. |
| Allowed Context | Sent By Host/Module |
|---|---|
| All Contexts | Module |
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 Request and serves to specify the time at which the Module will switch to the new image.
Payload for Upgrade End Response Command
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Node ID | Node ID of Module |
2..9 | EUI64 | EUI64 of Module |
10 | Endpoint ID | Endpoint of Module |
11,12 | Manufacturer Code | |
13,14 | Image Type | Unused - for backwards compatibility. Set to 0x0000 |
15..18 | File Version | Will contain the value initially set in the Query Next Image Response / OTA Query Next Image Response frames by the Host. |
19..22 | Current Time | UTC Time, where 0x00000000 = Now |
23..26 | Upgrade Time | UTC Time, where 0x00000000 = Now |
| Allowed Context | Sent By Host/Module |
|---|---|
| All Contexts | Host |