Set of APIs for ota-broadcast-bootloader-client. More...

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

Set of APIs for ota-broadcast-bootloader-client.

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-broadcast-bootloader-client.h for source code.

Function Documentation

EmberAfOtaBootloaderStatus emberAfPluginOtaBootloaderClientAbortImageDownload	(	uint8_t	`imageTag,`
		uint8_t	`applicationErrorStatus`
	)

Aborts an ongoing image download process.

Parameters

[in]	`imageTag`	A 1-byte tag that identifies the image the client should no longer download.
[in]	`applicationErrorStatus`	A 1-byte error code reported to the server.

Returns

An EmberAfOtaBootloaderStatus value of:

EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_SUCCESS If the ongoing image download process was successfully aborted.
EMBER_OTA_BROADCAST_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 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

[in]	`status`	An EmberAfOtaBootloaderStatus value of: EMBER_OTA_BROADCAST_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 emberAfPluginOtaBootloaderClientIncomingImageSegmentCallback() callback. EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_FAILED indicating that the client failed to fully download the image and the download process was terminated. EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_TIMEOUT indicating that the client timed out waiting for a message from the server. EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_ABORTED indicating that the application aborted the ongoing image download process as result of calling the API emberAfPluginOtaBootloaderClientAbortImageDownload() .
[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_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

[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 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

[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.
[out]	`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

[in]	`serverId`	The ID of the server the request came from.
[in]	`applicationServerStatus`	The server application status.
[out]	`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

[in]	`serverId`	The node ID of the server that initiated the new image distribution process.
[out]	`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.
[in]	`imageTag`	A 1-byte tag that identifies the incoming image.

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

Functions

Detailed Description

License

Function Documentation

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