Functions

bool emberAfPluginOtaUnicastBootloaderClientNewIncomingImageCallback ( EmberNodeId serverId, uint8_t imageTag)
A callback invoked by the OTA Unicast Client plugin when the client starts receiving a new image. The application can choose to start receiving the image or ignore(refuse) it. If the application chooses to receive the image, other images sent out by another server are ignored until the client completes this download. More...
void emberAfPluginOtaUnicastBootloaderClientIncomingImageSegmentCallback ( EmberNodeId serverId, uint32_t startIndex, uint32_t endIndex, uint8_t imageTag, uint8_t *imageSegment)
A callback invoked by the OTA Unicast Bootloader Client plugin when an image segment that is part of an image the application chose to download was received. More...
void emberAfPluginOtaUnicastBootloaderClientImageDownloadCompleteCallback ( EmberAfOtaUnicastBootloaderStatus status, uint8_t imageTag, uint32_t imageSize)
A callback invoked by the OTA Bootloader Client plugin to indicate that an image download has completed. More...
EmberAfOtaUnicastBootloaderStatus emberAfPluginOtaUnicastBootloaderClientAbortImageDownload (uint8_t imageTag, uint8_t applicationErrorStatus)
An API for aborting an ongoing image download process. More...
bool emberAfPluginOtaUnicastBootloaderClientIncomingRequestBootloadCallback ( EmberNodeId serverId, uint8_t imageTag, uint32_t bootloadDelayMs, uint8_t *applicationStatus)
A callback invoked by the OTA Unicast Bootloader Client plugin to indicate that an OTA Unicast Bootloader Server has requested to perform a bootload operation at a certain point in time in the future. More...

Detailed Description

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

Function Documentation

EmberAfOtaUnicastBootloaderStatus emberAfPluginOtaUnicastBootloaderClientAbortImageDownload ( uint8_t imageTag,
uint8_t applicationErrorStatus
)

An API for aborting 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 that shall be reported to the server.
Returns
An EmberAfOtaUnicastBootloaderStatus value of:
void emberAfPluginOtaUnicastBootloaderClientImageDownloadCompleteCallback ( EmberAfOtaUnicastBootloaderStatus status,
uint8_t imageTag,
uint32_t imageSize
)

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

Parameters
status An EmberAfOtaUnicastBootloaderStatus 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_UNICAST_BOOTLOADER_STATUS_SUCCESS .
void emberAfPluginOtaUnicastBootloaderClientIncomingImageSegmentCallback ( EmberNodeId serverId,
uint32_t startIndex,
uint32_t endIndex,
uint8_t imageTag,
uint8_t * imageSegment
)

A callback invoked by the OTA Unicast Bootloader Client plugin when an image segment that is part of an image the application chose 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 emberAfPluginOtaUnicastBootloaderClientIncomingRequestBootloadCallback ( EmberNodeId serverId,
uint8_t imageTag,
uint32_t bootloadDelayMs,
uint8_t * applicationStatus
)

A callback invoked by the OTA Unicast Bootloader Client plugin to indicate that an OTA Unicast 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 shall be reported to the server.
Returns
TRUE if the application accepted the request of bootloading the specified image at the requested time, FALSE otherwise.
bool emberAfPluginOtaUnicastBootloaderClientNewIncomingImageCallback ( EmberNodeId serverId,
uint8_t imageTag
)

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

Parameters
serverId The node ID of the server that initiated the new image distribution process.
imageTag A 1-byte tag that identifies the incoming image.