OTA Bootload Server Callbacks


bool emberZclOtaBootloadServerGetImageNotifyInfoCallback (EmberIpv6Address *address, EmberZclOtaBootloadFileSpec_t *fileSpec)
EmberZclStatus_t emberZclOtaBootloadServerGetNextImageCallback (const EmberIpv6Address *source, const EmberZclOtaBootloadFileSpec_t *currentFileSpec, EmberZclOtaBootloadFileSpec_t *nextFileSpec)
uint32_t emberZclOtaBootloadServerUpgradeEndRequestCallback (const EmberIpv6Address *source, const EmberZclOtaBootloadFileSpec_t *fileSpec, EmberZclStatus_t status)

Detailed Description

These callbacks are contributed by the OTA Bootload Server plugin.

Function Documentation

bool emberZclOtaBootloadServerGetImageNotifyInfoCallback ( EmberIpv6Address address,
EmberZclOtaBootloadFileSpec_t fileSpec 

Get the information needed to send an ImageNotify command.

addressAddress to which to send the ImageNotify command
fileSpecThe OTA file specification data contained in the ImageNotify command payload. See OTA specification for more details.
true if the ImageNotify command should be sent, false otherwise.
If false is returned, then the ImageNotify command will be rescheduled to be sent at a later time.
EmberZclStatus_t emberZclOtaBootloadServerGetNextImageCallback ( const EmberIpv6Address source,
const EmberZclOtaBootloadFileSpec_t currentFileSpec,
EmberZclOtaBootloadFileSpec_t nextFileSpec 

Get the next OTA file to send in response to a QueryNextImage command.

currentFileSpecThe current file spec from the QueryNextImage command
nextFileSpecThe next file spec to be downloaded by the client
One of the following EmberZclStatus_t values.


uint32_t emberZclOtaBootloadServerUpgradeEndRequestCallback ( const EmberIpv6Address source,
const EmberZclOtaBootloadFileSpec_t fileSpec,
EmberZclStatus_t  status 

Get the status to send to an OTA client after a download has completed.

sourceThe source address of the OTA client that has completed a download
fileSpecThe file specification of the OTA file that the client has downloaded
statusThe status reported by the client upon completing the download
The time at which the client should upgrade to the newly downloaded image.
This callback is called regardless of whether or not the client completed the download successfully. If the status parameter is not equal to EMBER_ZCL_STATUS_SUCCESS, then the server will not tell the client to proceed with the upgrade.