(0x0B) OTA Upgrade Client Frames
The commands in this section facilitate over-the-air (OTA) client of the application operating on the Module. These commands have been implemented per the ZigBee HA 1.2 guidelines.
( PH:0x0B, SH:0x20 ) - OTA Query Configuration Request Command
Overview
The OTA Query Configuration Request frame is sent from the Host to the Module to request the intervals at which the Module queries the OTA server for data.
Payload
This command has no payload.
Effect on Receipt
The Module will respond with an OTA Query Configuration Response frame.
Allowed Context
All Contexts.
Sent By Host/Module
Host.
( PH:0x0B, SH:0x21 ) - OTA Query Configuration Response Command
Overview
The OTA Query Configuration Response frame is sent from the Module to the Host in response to an OTA Query Configuration Request.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Discovery Retry Rate | The rate, in minutes, at which the Module performs discovery for an OTA server when it has knowledge of none. Default = 15 minutes |
2..5 | First Image Query Delay | The delay, in milliseconds, after discovery of an OTA server and prior to the first Next Image Request (i.e., querying the server to determine if a new image is available). Default = 1 minute. |
6..9 | Image Query Rate | The delay, in milliseconds, between consecutive Next Image Request queries (i.e., querying the server to determine if a new image is available). Default = 15 minutes. |
10..13 | Block Request Rate | The delay, in milliseconds, between Image Block Requests (i.e., the rate at which a new image will be retrieved from the server). Default = 1 millisecond. |
Effect on Receipt
None.
Allowed Context
All Contexts.
Sent By Host/Module
Module.
( PH:0x0B, SH:0x22 ) - OTA Query Configuration Write Command
Overview
The OTA Query Configuration Write frame is sent from the Host to the Module to set the various intervals at which the Module queries the OTA server for data. These settings may not be modified during an OTA upgrade and will persist in non-volatile memory.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Discovery Retry Rate | The rate, in minutes, at which the Module performs discovery for an OTA server when it has knowledge of none. Set to 0xFFFF to retain default (15 minutes). |
2..5 | First Image Query Delay | The delay, in milliseconds, after discovery of an OTA server and prior to the first Next Image Request (i.e. querying the server to determine if a new image is available). Set to 0xFFFFFFFF to retain default (1 minute). |
6..9 | Image Query Rate | The delay, in milliseconds, between consecutive Next Image Request queries (i.e. querying the server to determine if a new image is available). Set to 0xFFFFFFFF to retain default (15 minutes). |
10..13 | Block Request Rate | The delay, in milliseconds, between Image Block Requests (i.e. the rate at which a new image will be retrieved from the server). Set to 0xFFFFFFFF to retain default (1 millisecond). |
Effect on Receipt
None.
Allowed Context
All Contexts.
Sent By Host/Module
Host.
( PH:0x0B, SH:0x23 ) - Image Progress Notification Command
Overview
The Image Progress Notification frame is sent from the Module to the Host to notify the Host of the reception of every 512 bytes of firmware downloaded through the OTA Bootload cluster. The frame is also sent on completion of the download.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0 | Status | Maps to ZCL Status codes: 0x00 = Success See /wiki/spaces/SPRHA17/pages/37093554 for all ZCL Status values. |
1,2 | Manufacturer Code | |
3,4 | Image Type | Unused - for backwards compatibility. Set to 0x0000 |
5..8 | File Version | Will contain the value initially set in the Query Next Image Response / OTA Query Next Image Response frames by the Host. |
9..12 | File Offset | |
13..16 | File Size |
Effect on Receipt
None.
Allowed Context
All Contexts.
Sent By Host/Module
Module.
( PH:0x0B, SH:0x24 ) - OTA Version Configuration Request Command
Overview
The OTA Version Configuration Request frame is sent from the Host to the Module to query the version and image type information used to verify a new OTA image.
Payload
This command has no payload.
Effect on Receipt
The Module will respond with an OTA Version Configuration Response frame.
Allowed Context
All Contexts.
Sent By Host/Module
Host.
( PH:0x0B, SH:0x25 ) - OTA Version Configuration Response Command
Overview
The OTA Version Configuration Response frame is sent from the Module to the Host in response to an OTA Version Configuration Request.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Image Type | Unused - for backwards compatibility. Set to 0x0000 |
2..5 | Firmware Version | Default value corresponds to that of the Application Version attribute of the Basic cluster. |
6,7 | Hardware Version | 0x00 = Reserved |
8..15 | Signer EUI | Default 0x0024460000078074 |
Effect on Receipt
None.
Allowed Context
All Contexts.
Sent By Host/Module
Module.
( PH:0x0B, SH:0x26 ) - OTA Version Configuration Write Command
Overview
The OTA Version Configuration Write frame is sent from the Host to the Module to configure the version and image type information used to verify an OTA image.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Image Type | Unused - for backwards compatibility. Set to 0x0000 |
2..5 | Firmware Version | Set to 0xFFFFFFFF to retain default. |
6,7 | Hardware Version | Set to 0xFFFF to retain default (EM357) 0x00 = Reserved |
8..15 | Signer EUI | Set to 0xFFFFFFFF to retain default (0x0024460000078074). |
Effect on Receipt
None.
Allowed Context
All Contexts.
Sent By Host/Module
Host.
( PH:0x0B, SH:0x27 ) - OTA Client Download Policy Request Command
Overview
The OTA Client Download Policy Request frame is sent from the Host to the Module to query the OTA Client download policy if the OTA Client download is enabled or disabled
Payload
This command has no payload.
Effect on Receipt
The Module will respond with an OTA Client Download Policy Response frame
Allowed Context
All Contexts
Sent By Host/Module
Host
( PH:0x0B, SH:0x28 ) - OTA Client Download Policy Response Command
Overview
The OTA Client Download Policy Response frame is sent from the Module to the Host in response to the OTA Client Download Policy Request.
Payload
| Byte Index | Field Name | Notes |
|---|---|---|
| 0 | Download Policy | 0x00 = Disable 0x01 = Enable (Default) The Download Policy field is reset to the default 0x01 (Enable) upon power-cycling. |
Effect on Receipt
None
Allowed Context
All Contexts
Sent By Host/Module
Module
(PH:0x0B, SH:0x29) - OTA Client Download Policy Write Command
Overview
The OTA Client Download Policy Write frame is sent from the Host to the Module to set the OTA Download Policy to enable/disable OTA Client download
If there's an OTA downgrade in process, changing the download policy to disable would terminate the in-process and future download.
Payload
| Byte Index | Field Name | Notes |
|---|---|---|
| 0 | Download Policy | 0x00 = Disable 0x01 = Enable (Default) The Download Policy field is reset to the default 0x01 (Enable) upon power-cycling. |
Effect on Receipt
None
Allowed Context
All Contexts
Sent By Host/Module
Host.
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.