Ota Broadcast Bootloader Client Plugin
Silicon Labs Connect Application Framework API Reference

Functions

EmberAfOtaBootloaderStatus emberAfPluginOtaBootloaderClientAbortImageDownload (uint8_t imageTag, uint8_t applicationErrorStatus)
Aborts an ongoing image download process. More...
bool emberAfPluginOtaBootloaderClientNewIncomingImageCallback ( EmberNodeId serverId, EmberNodeId *alternateServerId, uint8_t imageTag)
A callback invoked by the OTA Client plugin when the client starts receiving a new image. The application can choose to start receiving the image or it can ignore it. If the application chooses to receive the image, other images sent out by other server are ignored until the client completes this download. More...
void emberAfPluginOtaBootloaderClientIncomingImageSegmentCallback ( EmberNodeId serverId, uint32_t startIndex, uint32_t endIndex, uint8_t imageTag, uint8_t *imageSegment)
A callback invoked by the OTA Bootloader Client plugin when an image segment, that is part of an image that the application elected to download, was received. More...
void emberAfPluginOtaBootloaderClientImageDownloadCompleteCallback ( EmberAfOtaBootloaderStatus status, uint8_t imageTag, uint32_t imageSize)
A callback invoked by the OTA Bootloader Client plugin to indicate that an image downlaod has completed. More...
void emberAfPluginOtaBootloaderClientIncomingRequestStatusCallback ( EmberNodeId serverId, uint8_t applicationServerStatus, uint8_t *applicationStatus)
A callback invoked by the OTA Bootloader Client plugin to indicate that an OTA Bootloader Server has requested the status of the client device. More...
bool emberAfPluginOtaBootloaderClientIncomingRequestBootloadCallback ( EmberNodeId serverId, uint8_t imageTag, uint32_t bootloadDelayMs, uint8_t *applicationStatus)
A callback invoked by the OTA Bootloader Client plugin to indicate that an OTA Bootloader Server has requested to perform a bootload operation at a certain point in time in the future. More...

Detailed Description

See ota-broadcast-bootloader-client.h for source code.

Function Documentation

EmberAfOtaBootloaderStatus emberAfPluginOtaBootloaderClientAbortImageDownload ( uint8_t imageTag,
uint8_t applicationErrorStatus
)

Aborts an ongoing image download process.

Parameters
imageTag A 1-byte tag that identifies the image the client should no longer download.
applicationErrorStatus A 1-byte error code reported to the server.
Returns
An EmberAfOtaBootloaderStatus value of:
void emberAfPluginOtaBootloaderClientImageDownloadCompleteCallback ( EmberAfOtaBootloaderStatus status,
uint8_t imageTag,
uint32_t imageSize
)

A callback invoked by the OTA Bootloader Client plugin to indicate that an image downlaod has completed.

Parameters
status An EmberAfOtaBootloaderStatus value of:
imageTag A 1-byte tag of the image this callback refers to.
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_BROADCAST_BOOTLOADER_STATUS_SUCCESS .
void emberAfPluginOtaBootloaderClientIncomingImageSegmentCallback ( EmberNodeId serverId,
uint32_t startIndex,
uint32_t endIndex,
uint8_t imageTag,
uint8_t * imageSegment
)

A callback invoked by the OTA Bootloader Client plugin when an image segment, that is part of an image that the application elected to download, was received.

Parameters
serverId The node ID of the server that initiated the new image distribution process.
startIndex The index of the first byte of the passed segment.
endIndex The index of the last byte of the passed segment.
imageTag A 1-byte tag of the image the passed segment belongs to.
imageSegment An array containing the image segment.
bool emberAfPluginOtaBootloaderClientIncomingRequestBootloadCallback ( EmberNodeId serverId,
uint8_t imageTag,
uint32_t bootloadDelayMs,
uint8_t * applicationStatus
)

A callback invoked by the OTA Bootloader Client plugin to indicate that an OTA Bootloader Server has requested to perform a bootload operation at a certain point in time in the future.

Parameters
serverId The ID of the server the request came from.
imageTag A 1-byte tag of the image this callback refers to.
bootloadDelayMs The delay in milliseconds after which the client has been requested to perform a bootload operation.
applicationStatus A 1-byte status set by the client application that is reported to the server.
Returns
TRUE if the application accepted the request of bootloading the specified image at the requested time, FALSE otherwise.
void emberAfPluginOtaBootloaderClientIncomingRequestStatusCallback ( EmberNodeId serverId,
uint8_t applicationServerStatus,
uint8_t * applicationStatus
)

A callback invoked by the OTA Bootloader Client plugin to indicate that an OTA Bootloader Server has requested the status of the client device.

Parameters
serverId The ID of the server the request came from.
applicationServerStatus The server application status.
applicationStatus A 1-byte status set by the client application that is reported to the server.
bool emberAfPluginOtaBootloaderClientNewIncomingImageCallback ( EmberNodeId serverId,
EmberNodeId * alternateServerId,
uint8_t imageTag
)

A callback invoked by the OTA Client plugin when the client starts receiving a new image. The application can choose to start receiving the image or it can ignore it. If the application chooses to receive the image, other images sent out by other server are ignored until the client completes this download.

Parameters
serverId The node ID of the server that initiated the new image distribution process.
alternateServerId This node ID can be set by the application to include a well-known alternate server. If this is set to a valid address, the client allows segments also from this alternate server. If this is set to EMBER_BROADCAST_ADDRESS , the client accepts segments with the same image tag from any server.
imageTag A 1-byte tag that identifies the incoming image.