Digi XBee3 802.15.4 User Manual

OTA firmware upgrade process for 802.15.4 OTA/OTB file
Digi XBee3® 802.15.4 RF Module User Guide
166
OTA/OTB file
The .ota file extension is for a file which contains an OTA Firmware upgrade image. The .otb file
extension is for a file which contains an OTA combined upgrade image containing both the bootloader
as well as the firmware. However, the way we process both the files remain the same.
The OTA header
The OTA firmware uses a specific firmware file with a .ota extension. We recommend parsing the OTA
header from the OTA file first to obtain the firmware version, manufacturer code, image type and the
size of the GBL file. These parameters are required to generate the rest of the OTA firmware upgrade
messages. The format of the OTA header is:
Bytes Field name Description
4 OTA upgrade file
identifier
Has to match 0x0BEEF11E in little endian. If it is not, then the OTA file
is not a valid upgrade file.
2 OTA Header version 0x0001
2 OTA Header length Length of the OTA Header.
2 OTA Header Field
control
Bit mask that indicates if additional information is included in the
image. (Read the Security Credential Version in this table).
2 Manufacturer Code 0x101E
2 Image Type 0x0000
4 File Version The version of the firmware upgrade image.
2 Stack Version This is set to 2 by default.
32 OTA Header String Usually contains the Firmware image name followed by 0xFFs. For
example, FFFFFFFFFFFFFFFlbg.10F3_42MD_3BX which is XB3_DM24-
3F01.gblFFFFFFFFFFFFFFF in little endian
4 Image Size Contains the size of the .gbl file for the firmware.
0/1 Security Credential
version
If bit 0 of the OTA Header Field Control is set to 1, this indicates the
security credential version type that the client is required to have,
before it will install the image (set to 2).
0/8 Upgrade File
Destination
If bit 1 of the OTA Header Field Control is set to 1, this indicates that
this OTA file contains security credential/certificate 577 data or other
type of information that is specific to a particular device. Currently,
we do not use this feature.
0/2 Hardware/Software
Compatibility
If bit 2 of the OTA Header Field Control is set to 1.
The file version field contains additional hardware/software compatibility information. We recommend
that if you intend to perform an OTA update, you use the OTA header extracted from the file so that
you can avoid undesired behavior.

Digi XBee3 802.15.4 Specifications

General

Brand	Digi
Model	XBee3 802.15.4
Category	Control Unit
Language	English