Ota Unicast Bootloader Common

Connect Application Framework API Reference

Macros and types defined for ota-unicast-bootloaders. More...

Enumerations
enum	EmberAfOtaUnicastBootloaderStatus { EMBER_OTA_UNICAST_BOOTLOADER_STATUS_SUCCESS = 0x00, EMBER_OTA_UNICAST_BOOTLOADER_STATUS_INVALID_CALL = 0x01, EMBER_OTA_UNICAST_BOOTLOADER_STATUS_BUSY = 0x02, EMBER_OTA_UNICAST_BOOTLOADER_STATUS_DATA_UNDERFLOW = 0x03, EMBER_OTA_UNICAST_BOOTLOADER_STATUS_STACK_ERROR = 0x04, EMBER_OTA_UNICAST_BOOTLOADER_STATUS_TIMEOUT = 0x05, EMBER_OTA_UNICAST_BOOTLOADER_STATUS_FAILED = 0x06, EMBER_OTA_UNICAST_BOOTLOADER_STATUS_ABORTED = 0x07, EMBER_OTA_UNICAST_BOOTLOADER_STATUS_REFUSED = 0x08, EMBER_OTA_UNICAST_BOOTLOADER_STATUS_UNREACHABLE = 0x09 }
	OTA Unicast Bootloader return status codes. More...

Detailed Description

Macros and types defined for ota-unicast-bootloaders.

OTA bootloading plugins are usable to send firmware images Over The Air when the application is running. When the firmware is downloaded to a device, a bootloader can be started to replace the application in the flash to the one just downloaded.

All Connect bootloader related code relies on the Gecko Bootloader for bootloading and it must be installed on the device for these plugins to work. For details on the Gecko Bootloader, see UG266.

The Unicast OTA plugins implement the OTA download operation in a unicast, addressed way, so only a single client can be addressed from a server in an OTA session, and downloading images to multiple devices will require the server to send the image multiple times. Communication relies on standard unicast data messages, which also means that the routing provided by the Connect stack is availble.

Although bootloading sleepy end devices is theoretically possible with polling, it is not very effective, and it's probably simpler to reconnect as a normal end device while the OTA is active.

Unicast OTA uses a plugin configurable endpoint, which is 13 by default.

Security can be also enabled as plugin configuration on the server, as well as the interval of the messages. The client has a timeout plugin configuration after which it stops the OTA session with an error.

See UG235.06 for further details.

Note

OTA Unicast Bootloading plugins are not available in MAC mode due to the lack of endpoints.

Enumeration Type Documentation

◆ EmberAfOtaUnicastBootloaderStatus