APIs/callbacks for ota-unicast-bootloader clients. More...

Functions
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. More...

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. More...

void	emberAfPluginOtaUnicastBootloaderClientImageDownloadCompleteCallback (EmberAfOtaUnicastBootloaderStatus status, uint8_t imageTag, uint32_t imageSize)
	A callback invoked to indicate that an image download has completed. More...

EmberAfOtaUnicastBootloaderStatus	emberAfPluginOtaUnicastBootloaderClientAbortImageDownload (uint8_t imageTag)
	An API for aborting an ongoing image download process. More...

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. More...

Detailed Description

APIs/callbacks for ota-unicast-bootloader clients.

License

The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code.

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

Function Documentation

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

An EmberAfOtaUnicastBootloaderStatus value of:

EMBER_OTA_UNICAST_BOOTLOADER_STATUS_SUCCESS If the ongoing image download process was successfully aborted.
EMBER_OTA_UNICAST_BOOTLOADER_STATUS_INVALID_CALL If the client was not currently involved in an image download process or it was currently downloading an image with a different tag.

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: EMBER_OTA_UNICAST_BOOTLOADER_STATUS_SUCCESS indicating that the full image corresponding to the passed tag has been received. If this is the case, the client previously handed all the image segments to the application using the emberAfPluginOtaUnicastBootloaderClientIncomingImageSegmentCallback() callback. EMBER_OTA_UNICAST_BOOTLOADER_STATUS_FAILED indicating that the client failed to fully download the image and the download process was terminated. EMBER_OTA_UNICAST_BOOTLOADER_STATUS_TIMEOUT indicating that the client timed out waiting for a message from the server. EMBER_OTA_UNICAST_BOOTLOADER_STATUS_ABORTED indicating that the application aborted the ongoing image download process as result of calling the API emberAfPluginOtaUnicastBootloaderClientAbortImageDownload().
[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.

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 new 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.

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: 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,`
		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. 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: true if the application accepted to start downloading the new image, false otherwise.

Ota Unicast Bootloader Client PluginSilicon Labs Connect Application Framework API Reference

Functions

Detailed Description

License

Function Documentation

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