Versions Compared

Old Version 3

changes.mady.by.user Doug Alguire (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Tracy W (Deactivated)

Saved on

Key

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

The commands in this section facilitate over the air (OTA) server of the application operating on the Module. These commands have been implemented per the ZigBee HA 1.2 guidelines.

Section Columnwidth50%


Panel
borderStylesolid
titleSecondary Headers

Table of Contents
maxLevel2
minLevel2

Columnwidth

20% Column
width30%



Panel
borderStylesolid
titleIn This Space

Page Tree
rootFrame Payload Definitions
spacesSPRC2







Section


Effect on Receipt

The Module will send an Image Notify ZCL command either broadcast or unicast depending on the received serial frame.

Allowed Context

All Contexts.

Sent By Host/Module

Host.

Column
width60%100%

( PH:0xB0, SH:0x00 ) - OTA Image Notification Command

Overview

The OTA Image Notification Command frame is sent from the Host to the Module

. The Module will send an Image Notify ZCL command either broadcast or unicast depending on the received serial frame

.

Payload

for OTA Image Notification Command

Byte Index

Field Name

Notes

0,1

Node ID

Target Device Node ID
 0xFFFF means the EUI64 is used.

2..9

EUI64 Address

Target Device EUI64. All 0xFF indicates broadcast

10

Endpoint

0xFF indicates a request on all endpoints.

11

Payload Type

0x00 = Query jitter
0x01 = Query jitter & manufacturer code
0x02 = Query jitter, manufacturer code & image type
0x03 = Query jitter, manufacturer code, image type &
             new file version
0x04-0xFF Reserved

*Manufacturer Code, Payload Type, and File Version fields are omitted or included depending on the value of this field.

i.e 0x00 - all must be omitted, 0x01 - image type and file version are omitted, 0x02 - only file version is omitted

12

Query Jitter


(13,14)

Manufacturer Code

Optional field, it is needed for payload type 0x01-0x03

(15,16)

Image Type

Unused - for backwards compatibility. Set to 0x0000

(17..20)

File Version

Will contain the value initially set in the Query Next Image Response / OTA Query Next Image Response frames by the Host.

Column
width10%
Column
width30%
Allowed ContextAll Contexts








Section


Column
width60%100%

( PH:0xB0, SH:0x01 ) - OTA Query Next Image Request Command

Overview

The OTA Query Next Image Request frame is sent from the Module to the Host.

The Module expects to receive an OTA Query Next Image Response frame in return.

Payload

for OTA Query Next Image Request Command

Byte Index

Field Name

Notes

0,1

Node ID

Request OTA Device Node ID

2..9

EUI64 Address

Request OTA Device EUI64

10

Endpoint

Request OTA Device Endpoint

11

Field Control

8-bit Bitmap
Bit 0 : Hardware Version
            0=unavailable
            1=present
Bit 1-7: Reserved

12,13

Manufacturer Code


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,21)

Hardware Version

Optional. Bit 0 of "Field Control" must equal "1" to use this optional field.

Column
width10%
Column
width30%
Allowed Context

Effect on Receipt

The Host shall send an OTA Query Next Image Response frame in return.

Allowed Context

All Contexts.

Sent By Host/Module

All Contexts

Module.



Section


30%

Host.

Column
width60%100%
Column
width

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

Overview

The OTA Query Next Image Response frame is sent from the Host to the Module. The Module relays the frame to the OTA target device. If the target EUI64 is the module’s own EUI64, the module will process it locally.

Payload

for OTA Query Next Image Response Command

Byte Index

Field Name

Notes

0,1

Node ID

Target Device Node ID. 0xFFFF indicates that the EUI64 is used

2..9

EUI64 Address

Target Device EUI64

10

Endpoint

Target Device Endpoint

11

Status

0x00 – Success
0x80 – Malformed Command
0x81 – Unsupported Cluster Command
0x95 – Abort
0x96 – Invalid Image
0x97 – Wait for Data
0x98 – No Image Available
0x99 – Require

Mode

More Image
0x7E – Not Authorized

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

Image Size

Column
width10%

Effect on Receipt

None

Allowed Context

All Contexts.

Sent By Host/Module

All Contexts








Section


Column
width60%100%
Column
width30%

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

Overview

The OTA Image Block Request frame is sent from the Module to the Host. The Module expects to receive an OTA Image Block Response frame in response.

Payload

for OTA Image Block Request Command

Byte Index

Field Name

Notes

0,1

Node ID

Request OTA Device Node ID

2..9

EUI64 Address

Request OTA Device EUI64

10

Endpoint

Request OTA Device Endpoint

11

Field Control

8-bit Bitmap
Bit 0 : Request node’s IEEE address
           0=unavailable
           1=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 < 50

Expected Host Action

Effect on Receipt

The Host must process and respond to Image Block Request messages until the Module sends a Upgrade End Request

The  Host must set status to MALFORMED_COMMAND (0x80) and return a 0 length data block if the Image Offset is outside the range of the file length.

Column
width10%

Allowed Context

All Contexts.

Sent By Host/Module

All Contexts

Module.



Section


Host.

Column
width60%

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

Overview

The OTA Image Block Response frame is sent from the Host to the Module. The Module relays the frame to the OTA target device. If the target EUI64 is the module’s own EUI64, the module will process it locally.

There are three possible return values for the OTA Image Block Response: Success, Wait for Data, and Abort. The payload differs for each one.

Payload

for

For OTA Image Block Response Command on Success

Byte Index

Field Name

Notes

0,1

Node ID

Target Device Node ID. 0xFFFF indicates that the EUI64 is used.

2..9

EUI64 Address

Target Device EUI64.

10

Endpoint

0xFF indicates a request on all endpoints.

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.

20..23

File Offset


24

Data Size

N < 50

25..(24+N)

Data

Payload for


For OTA Image Block Response Command on Wait for Data

Byte Index

Field Name

Notes

0,1

Node ID

Target Device Node ID. 0xFFFF indicates that the EUI64 is used.

2..9

EUI64 Address

Target Device EUI64.

10

Endpoint

Target Device Endpoint

11

Status

0x97 = Wait for Data

12..15

Current UTC Time

The current UTC time

16..19

Request Time

The UTC time the client should retry the request

20

Checksum LSB

The least significant byte of the 16-bit CS.

21

Checksum MSB

The most significant byte of the 16-bit CS.

Payload for

For OTA Image Block Response Command on Abort

Byte Index

Field Name

Notes

0,1

Node ID

Target Device Node ID. 0xFFFF indicates that the EUI64 is used

2..9

EUI64 Address

Target Device EUI64

10

Endpoint

Target Device Endpoint

11

Status

0x95 = Abort

Column
width10%
Column
width30%

Effect on Receipt

None.

Allowed Context

All Contexts.

Sent By Host/Module

All Contexts








Section


30%
Column
width60%100%
Column
width

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

Overview

The Upgrade End Request frame is sent from the Module to the Host

. The Module expects to receive an Upgrade End Response frame in response

.

Payload

for OTA Upgrade End Request Command

Byte Index

Field Name

Notes

0,1

Node ID

Request OTA Device Node ID

2..9

EUI64 Address

Request OTA Device EUI64

10

Endpoint

Request OTA Device Endpoint

11

Status

0x00 – Success
0x95 – Abort
0x96 – Invalid Image
0x99 – Require

Mode

More Image

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.

Column
width10%

Effect on Receipt

The Host shall send an Upgrade End Response frame in response.

Allowed Context

All Contexts.

Sent By Host/Module

All Contexts

Module.



Section


30%
Column
width60%100%
Column
width

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

Overview

The OTA Upgrade End Response frame is sent from the Host to the Module in response to an OTA Upgrade End Request with success status. The Module relays the frame to the OTA target device. If the target EUI64 is the module’s own EUI64, the module will process it locally,

Payload

for OTA Upgrade End Response Command

Byte Index

Field Name

Notes

0,1

Node ID

Target Device Node ID. 0xFFFF indicates that the EUI64 is used.

2..9

EUI64 Address

Target Device EUI64. All 0xFF indicates broadcast

10

Endpoint

0xFF indicates a request on all endpoints.

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


23..26

Upgrade Time

Column
width10%


Effect on Receipt

None.

Allowed Context

All Contexts.

Sent By Host/Module

All Contexts

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;
}
wiki-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}