Versions Compared

Old Version 8

changes.mady.by.user Luke Tutty

Saved on

compared with

New Version Current

changes.mady.by.user Tracy W

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.


Panel
borderStylesolid
titleSecondary Headers

Table of Contents
maxLevel2
minLevel2



Panel
borderStylesolid
titlePrimary Headers

Page Tree
rootFrame Payload Definitions
spacesSPRC2







Section


Column
width100%

(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




Section


Column
width100%

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

Overview

The Query Next Image Response frame is sent from the Host to the Moduleand 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.








Section


Column
width100%

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



Section


Column
width100%

( PH:0x0B, SH:0x05 ) - Image Block Response Command

Overview

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

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


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


Effect on Receipt

The Module will store this data to external flash memory at the offset provided.

Allowed Context

All contexts.

Sent By Host/Module

Host.








Section


Column
width100%

( PH:0x0B, SH:0x06 ) - Upgrade End Request Command

Overview

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

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.

Effect on Receipt

The Host shall send an Upgrade End Response command.

Allowed Context

All contexts.

Sent By Host/Module

Module.



Section


Column
width100%

( PH:0x0B, SH:0x07 ) - Upgrade End Response Command

Overview

The Upgrade End Response frame is sent from the Host to Module in response to an Upgrade End Requestand serves to specify the time at which the Module will switch to the new image.

Payload

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

Effect on Receipt

The Module shall switch to the new module.

Allowed Context

All contexts.

Sent By Host/Module

Host.




Style
{style}
.panel, #content .panel {
-moz-border-radius: 5px;
-webkit-border-radius: 5px;
border-radius: 5px;
}

table.confluenceTable th.confluenceTh, table.confluenceTable td.highlight {
	background-color: #7AB800 !important;
}

.sectionColumnWrapper{
margin-bottom:20px;
padding: 15px;
background-color: #f9f9f9 !important;
border-style: solid;
border-width: 1px;
-moz-border-radius: 5px;
-webkit-border-topwiki-content h1 { 
font-family: 'Helvetica Neue', sans-serif; font-size: 30px; font-weight: bold; color: #20b6e1; letter-spacing: 1px; line-height: 1; text-align: left;
#border-bottom: 1px solid #98bddd !important; 
}
.wiki-content h2 { 
font-family: 'Helvetica Neue', sans-serif; font-size: 20px; font-weight: normal; color: #00517f; letter-spacing: 1px; line-height: 1; text-align: left;
}
.wiki-content h3 { 
font-family: 'Helvetica Neue', sans-serif; font-size: 15px; font-weight: bold; color: #00517f; letter-spacing: 1px; line-height: 1; text-align: left;
}
.wiki-content h4 { 
font-family: 'Helvetica Neue', sans-serif; font-size: 15px; font-weight: normal; font-style:italic; color:#00517f; letter-spacing: 1px; line-height: 1; text-align: left;
}
#title-text{
font-family: 'Helvetica Neue', sans-serif; font-size: 40px; font-weight: 500; letter-spacing: 1px; line-height: 1; text-align: left;
}

.panel, #content .panel {
-moz-border-radius: 5px;
-webkit-border-radius: 5px;
border-radius: 5px;
}
}
.panel .panelHeader {
text-align: left;
color: #FFFFFF;
line-height: 1em;
padding: 10px 10px 5px;
margin-bottom: 0;
background-color: #7AB800#00517f;
-moz-border-radius-topleft: 5px;
-moz-border-radius-topright: 5px;
-webkit-border-top-right-radius: 5px;
-webkit-border-top-left-radius: 5px;
border-top-right-radius: 5px;
border-top-left-radius: 5px;
}

{style}