(0x0B) Serial Bootload Frames

(0x0B) Serial Bootload Frames

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.

Secondary Headers
Primary Headers

 

 


 

 

(PH:0x0B, SH:0x01) - Trigger Bootloader Request Command

Overview

The Trigger Bootloader Request is sent from the Host to the Module. The request payload is empty.

Payload

This command has no payload

Effect on Receipt

The module shall respond with a Status Response of Success and will subsequently reboot the module and initiate the bootloader CLI. 

Allowed Context

All contexts

Sent By Host/Module

Host

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

Overview

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.

Payload

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
0x95 = Abort
0x7E = Not Authorized
0x96 = Invalid Image
0x97 = Wait for Data
0x98 = No Image Available
0x80 = Malformed Command
0x81 = Unsupported Cluster Command
0x99 = Require Mode Image

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


Effect on Receipt

Any existing firmware image in flash is erased.

Allowed Context

All contexts.

Sent By Host/Module

Host.

 

 


 

 

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

Overview

The Image Block Request frame is sent from the Module to the Host.

Payload

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
Bits 1-7 – Reserved

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.

Effect on Receipt

The Module expects to receive an Image Block Response from the Host in return.

Allowed Context

All contexts.

Sent By Host/Module

Module.

 

 


 

 

 

Legal Notices

Copyright © 2020 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.