Ota Unicast Bootloader Client Plugin#

APIs/callbacks for ota-unicast-bootloader clients.

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.

See ota-unicast-bootloader-client.h and ota-unicast-bootloader-client.c for source code.

Callbacks#

bool
emberAfPluginOtaUnicastBootloaderClientNewIncomingImageCallback(EmberNodeId serverId, uint8_t imageTag, uint32_t imageSize, uint32_t *startIndex)

A callback invoked when the client starts receiving a new image. The application can choose to start receiving the image or ignore it. If the application chooses to receive the image, other images sent out by other servers shall be ignored until the client completes the download.

void
emberAfPluginOtaUnicastBootloaderClientIncomingImageSegmentCallback(EmberNodeId serverId, uint32_t startIndex, uint32_t endIndex, uint8_t imageTag, uint8_t *imageSegment)

A callback invoked when an image segment that is part of an image the application chose to download was received.

void
emberAfPluginOtaUnicastBootloaderClientImageDownloadCompleteCallback(EmberAfOtaUnicastBootloaderStatus status, uint8_t imageTag, uint32_t imageSize)

A callback invoked to indicate that an image download has completed.

bool
emberAfPluginOtaUnicastBootloaderClientIncomingRequestBootloadCallback(EmberNodeId serverId, uint8_t imageTag, uint32_t bootloadDelayMs)

A callback invoked to indicate that a server has requested to perform a bootload operation at a certain point in time in the future.

Functions#

An API for aborting an ongoing image download process.

Callbacks Documentation#

emberAfPluginOtaUnicastBootloaderClientNewIncomingImageCallback#

bool emberAfPluginOtaUnicastBootloaderClientNewIncomingImageCallback (EmberNodeId serverId, uint8_t imageTag, uint32_t imageSize, uint32_t *startIndex)

A callback invoked when the client starts receiving a new image. The application can choose to start receiving the image or ignore it. If the application chooses to receive the image, other images sent out by other servers shall be ignored until the client completes the download.

Parameters
[in]serverId

The node ID of the server that initiated the new image distribution process.

[in]imageTag

A 1-byte tag that identifies the incoming image.

[in]imageSize

The size in bytes of the new image.

[out]startIndex

The index of the first byte at which the image download shall be started/resumed. The client can use this argument to resume a partially downloaded image. If this value is not set, it defaults to 0 (that is, the download starts at the beginning of the image). Note, this is ignored in case the server does not support download resume.

Returns

  • Return true to accept the image or false to ignore it.


Definition at line 88 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/ota-unicast-bootloader/ota-unicast-bootloader-client/ota-unicast-bootloader-client.h

emberAfPluginOtaUnicastBootloaderClientIncomingImageSegmentCallback#

void emberAfPluginOtaUnicastBootloaderClientIncomingImageSegmentCallback (EmberNodeId serverId, uint32_t startIndex, uint32_t endIndex, uint8_t imageTag, uint8_t *imageSegment)

A callback invoked when an image segment that is part of an image the application chose to download was received.

Parameters
[in]serverId

The node ID of the server that initiated the image distribution process.

[in]startIndex

The index of the first byte of the passed segment.

[in]endIndex

The index of the last byte of the passed segment.

[in]imageTag

A 1-byte tag of the image the passed segment belongs to.

[in]imageSegment

An array containing the image segment.


Definition at line 110 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/ota-unicast-bootloader/ota-unicast-bootloader-client/ota-unicast-bootloader-client.h

emberAfPluginOtaUnicastBootloaderClientImageDownloadCompleteCallback#

void emberAfPluginOtaUnicastBootloaderClientImageDownloadCompleteCallback (EmberAfOtaUnicastBootloaderStatus status, uint8_t imageTag, uint32_t imageSize)

A callback invoked to indicate that an image download has completed.

Parameters
[in]status

An EmberAfOtaUnicastBootloaderStatus value of:

[in]imageTag

A 1-byte tag of the image this callback refers to.

[in]imageSize

The total size of the downloaded image in bytes. This parameter is meaningful only in case the status parameter is set to EMBER_OTA_UNICAST_BOOTLOADER_STATUS_SUCCESS.


Definition at line 140 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/ota-unicast-bootloader/ota-unicast-bootloader-client/ota-unicast-bootloader-client.h

emberAfPluginOtaUnicastBootloaderClientIncomingRequestBootloadCallback#

bool emberAfPluginOtaUnicastBootloaderClientIncomingRequestBootloadCallback (EmberNodeId serverId, uint8_t imageTag, uint32_t bootloadDelayMs)

A callback invoked to indicate that a server has requested to perform a bootload operation at a certain point in time in the future.

Parameters
[in]serverId

The ID of the server the request came from.

[in]imageTag

A 1-byte tag of the image this callback refers to.

[in]bootloadDelayMs

The delay in milliseconds after which the client has been requested to perform a bootload operation.

Returns

  • Return true if the application accepted the request of bootloading the specified image at the requested time, false otherwise.


Definition at line 159 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/ota-unicast-bootloader/ota-unicast-bootloader-client/ota-unicast-bootloader-client.h

Function Documentation#

emberAfPluginOtaUnicastBootloaderClientAbortImageDownload#

EmberAfOtaUnicastBootloaderStatus emberAfPluginOtaUnicastBootloaderClientAbortImageDownload (uint8_t imageTag)

An API for aborting an ongoing image download process.

Parameters
[in]imageTag

A 1-byte tag that identifies the image the client should no longer download.

Returns


Definition at line 59 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/ota-unicast-bootloader/ota-unicast-bootloader-client/ota-unicast-bootloader-client.h