Over-the-air (OTA) Upgrades provide the ability for a device to download new firmware over the network and upgrade itself. RapidConnect Desktop allows the coordinator of a network to store a firmware file and then send it wirelessly to an end device on its network. The direction of the OTA firmware upgrade always goes from server to client, more specifically, from coordinator to end device.

There are two aspects to OTA upgrades:

Storing the Firmware file on the server-side cluster.
Managing end device behaviour and client-side cluster.

Prerequisites

Configure device as a Coordinator and form a network.
Join the "target device" to that network
Obtain OTA firmware file

In This Space

Server-Side

Go to the 'Remote Devices' window.

Select the coordinator or 'Local Device' from the Node list and expand the 'OTA Upgrade : Server (0x0019)' cluster.

Figure 1: OTA Upgrade Server Side Cluster

To store the firmware file on the coordinator, click the button labeled “Upload” (shown in Figure 1).

This action brings up a file explorer window that allows you to browse for and open the appropriate file. A firmware file for OTA transfer will be named “RapidHA-1.7.9-prod.ota” or something similar.

After the .ota file is opened, it will be identified by name in the 'OTA Files' area, along with other file information like its size and version number (shown in Figure 2). The rest of the upgrade process happens automatically, depending on the selections made in the OTA Policy section.

Figure 2: Firmware file attached

Policy

There are two options for managing the automatic upgrade Policy:

- Allow Upgrade – when this option is checked, all end devices on the network will have their firmware upgraded if the version number of the .ota file is higher than the version number of the firmware already on the device.
- Allow Downgrade – when this option is checked, all end devices on the network will have their firmware downgraded if the version of the .ota file is lower than the version number of the firmware already on the device.

Client-Side

The server (coordinator) hosts the file and the client (one of the various end devices) will query the server one minute after joining the network and once every five minutes thereafter. The firmware file is detected automatically and the upgrade will proceed based on the options checked in the OTA Upgrade Policy. The upgrade progress is shown in realtime, as shown in Figure 3. The device is identified by its EUI64 and Node ID.

Figure 3: Downloads in progress tab

When a firmware upgrade has completed, the status field will hold one of the values shown in Table 1 below:

Table 1: Status of OTA Upgrade

Status	Enumeration	Notes
Success	0x00	The firmware file was successfully transferred to the end device.
Abort	0x95	Server or client decided to abort the upgrade process.
Invalid Image	0x96	Firmware image rejected, e.g., bad CRC.
Require More Image	0x99	Client requires more firmware image files to complete the upgrade successfully.

Attributes

The client-side of the OTA Upgrade cluster allows read/write access to file information about both the current firmware image running on the end device and the upgrade image. This information includes stack and file version numbers, as well as status and progress indicators regarding the over the air transfer of the upgrade image. The status attribute (0x0006) has a non-zero value when the firmware upgrade is in progress.

See Figure 4 for an example of how to reading the IEEE address of the OTA upgrade server. Click on any attribute to read and display its value.

Note: Do not write to client-side attributes while a firmware upgrade is in progress.

Figure 4: OTA Client Attributes

Browser not supported