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

Macros
#define	EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_STACK_ERRORS 8
	The number of consecutive stack message submission errors or stack-related errors, such as CSMA failures, after which the plugin gives up. More...

#define	EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_UNICAST_ERRORS 4
	The number of consecutive unicast attempts after which a target is declared unreachable. Legal values for this are in the [0,7] range. More...

#define	EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_RESPONSE_TIMEOUT_MS 250
	The time in milliseconds after which the server gives up waiting for a response from a client. More...

#define	EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_BROADCAST_ROUNDS 5
	The maximum number of image broadcast rounds the server performs before declaring an image distribution process failed. More...

Functions
EmberAfOtaBootloaderStatus	emberAfPluginOtaBootloaderServerInitiateImageDistribution (uint32_t imageSize, uint8_t imageTag, EmberNodeId *targetList, uint16_t targetListLength)
	Initiate the image distribution process. The application can use the emberAfPluginBootloaderServerGetTargetStatus() API at any time during the image distribution process to check the status of each target. More...

EmberAfOtaBootloaderStatus	emberAfPluginBootloaderServerInitiateRequestTargetsStatus ( EmberNodeId *targetList, uint16_t targetListLength, uint8_t applicationServerStatus)
	Initiate the process to request the status of a set of target devices. The application can use the emberAfPluginBootloaderServerGetTargetStatus() API at any time during the target status request process to check the status of each target. More...

EmberAfOtaBootloaderStatus	emberAfPluginBootloaderServerInitiateRequestTargetsBootload (uint32_t bootloadDelayMs, uint8_t imageTag, EmberNodeId *targetList, uint16_t targetListLength)
	Start the process where a server requests a set of target devices to initiate the bootload of a received image at some point in the future. The application can use the emberAfPluginBootloaderServerGetTargetStatus() API at any time during the bootload request process to check the status of each target. More...

EmberAfOtaBootloaderTargetStatus	emberAfPluginBootloaderServerGetTargetStatus ( EmberNodeId targetId, uint8_t *applicationTargetStatus)
	Retrieve the locally stored status of an individual target in the distribution list. The locally stored status can be updated by calling emberAfPluginBootloaderServerInitiateRequestTargetsStatus() . More...

EmberAfOtaBootloaderStatus	emberAfPluginOtaBootloaderServerAbortCurrentProcess (void)
	Abort the ongoing process (image distribution, status request or bootload request). Note that aborting a bootload request process likely results in some targets performing the bootload while some others do not. More...

Callbacks
bool	emberAfPluginOtaBootloaderServerGetImageSegmentCallback (uint32_t startIndex, uint32_t endIndex, uint8_t imageTag, uint8_t *imageSegment)
	A callback invoked on the OTA Bootloader Server during an image distribution process to retrieve a contiguous segment of the image being distributed. More...

void	emberAfPluginOtaBootloaderServerImageDistributionCompleteCallback ( EmberAfOtaBootloaderStatus status)
	A callback invoked on the OTA Bootloader Server when the image distribution process is terminated. The application can use the emberAfPluginBootloaderServerGetTargetStatus() API to retrieve the status reported by each target device. More...

void	emberAfPluginBootloaderServerRequestTargetsStatusCompleteCallback ( EmberAfOtaBootloaderStatus status)
	A callback invoked on the OTA Bootloader Server when bootload request process has completed. Within this callback, the application should use the emberAfPluginBootloaderServerGetTargetStatus() API to retrieve the status and application status reported by each target. More...

void	emberAfPluginBootloaderServerRequestTargetsBootloadCompleteCallback ( EmberAfOtaBootloaderStatus status)
	A callback invoked on the OTA Bootloader Server when a bootload request process has completed. Within this callback, the application should use the emberAfPluginBootloaderServerGetTargetStatus() API to retrieve the status and the application status reported by each target. More...

Detailed Description

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

OTA bootloading plugins are usable to send firmware images Over The Air when the application is running. When the firmware is downloaded to a device, a bootloader can be started to replace the application in the flash to the one just downloaded.

All Connect bootloader related code relies on the Gecko Bootloader for bootloading and it must be installed on the device for these plugins to work. For details on the Gecko Bootloader, see UG266.

The Broadcast OTA plugins implement the OTA download operation in broadcast, so the same image can be sent to many devices at the same time. The server however requires to know the clients downloading the image, because it implements error handling by querying all clients for missing segments, and then the server will re-broadcast those segments.

Communication relies on standard broadcast data messages, which means routing is not available, and only clients that are in the range of the server can download. However, the same device can be both client and server, i.e. after downloading the image, a client can configure itself to be a server, and provide the image to another part of the network.

Sleepy end devices cannot be addressed in broadcast, but a sleepy end device can reconnect as a normal end device while the OTA is active.

Broadcast OTA uses a plugin configurable endpoint, which is 14 by default.

Security can be also enabled as plugin configuration on the server, as well as the interval of the messages. The client has a timeout plugin configuration after which it stops the OTA session with an error.

See UG235.06 for further details.

Note: OTA Broadcast Bootloading plugins are not available in MAC mode due to the lack of endpoints.

See ota-broadcast-bootloader-server.h and ota-broadcast-bootloader-server.c for source code.

Macro Definition Documentation

◆ EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_BROADCAST_ROUNDS

#define EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_BROADCAST_ROUNDS 5

The maximum number of image broadcast rounds the server performs before declaring an image distribution process failed.

Definition at line 69 of file ota-broadcast-bootloader-server.h .

◆ EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_STACK_ERRORS

#define EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_STACK_ERRORS 8

The number of consecutive stack message submission errors or stack-related errors, such as CSMA failures, after which the plugin gives up.

Definition at line 51 of file ota-broadcast-bootloader-server.h .

◆ EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_UNICAST_ERRORS

#define EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_UNICAST_ERRORS 4

The number of consecutive unicast attempts after which a target is declared unreachable. Legal values for this are in the [0,7] range.

Definition at line 57 of file ota-broadcast-bootloader-server.h .

◆ EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_RESPONSE_TIMEOUT_MS

#define EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_RESPONSE_TIMEOUT_MS 250

The time in milliseconds after which the server gives up waiting for a response from a client.

Definition at line 63 of file ota-broadcast-bootloader-server.h .

Function Documentation

◆ emberAfPluginBootloaderServerGetTargetStatus()

EmberAfOtaBootloaderTargetStatus emberAfPluginBootloaderServerGetTargetStatus	(	EmberNodeId	`targetId,`
		uint8_t *	`applicationTargetStatus`
	)

Retrieve the locally stored status of an individual target in the distribution list. The locally stored status can be updated by calling emberAfPluginBootloaderServerInitiateRequestTargetsStatus() .

Parameters

[in]	`targetId`	The node ID of the target device whose status is being requested.
[out]	`applicationTargetStatus`	The application status reported by the client side application. This parameter is valid only for certain return status codes (see return status documentation).

Returns

An EmberAfOtaBootloaderTargetStatus value of:

EMBER_OTA_BROADCAST_BOOTLOADER_TARGET_STATUS_INVALID if the passed node ID does not appear in the current server target list of the current ongoing process or if there is no current ongoing process.
EMBER_OTA_BROADCAST_BOOTLOADER_TARGET_STATUS_UNREACHABLE if the target has not responded to any of the server's unicast messages.
EMBER_OTA_BROADCAST_BOOTLOADER_TARGET_STATUS_DISTRIBUTION_COMPLETED if the server is currently performing an image distribution process and the target confirmed that it received the full image.
EMBER_OTA_BROADCAST_BOOTLOADER_TARGET_STATUS_DISTRIBUTION_ONGOING if the server is currently performing an image distribution process and the target has partially received the image and distribution is continuing.
EMBER_OTA_BROADCAST_BOOTLOADER_TARGET_STATUS_DISTRIBUTION_REFUSED if the target has refused the current image.
EMBER_OTA_BROADCAST_BOOTLOADER_TARGET_STATUS_DISTRIBUTION_FAILED if the server is currently performing an image distribution process and the target reported that an error was encountered.
EMBER_OTA_BROADCAST_BOOTLOADER_TARGET_STATUS_DISTRIBUTION_ABORTED if the server is currently performing an image distribution process and the target decided to abort the image download process. In this case, the client also reports an application status. Therefore, the applicationTargetStatus parameter is valid.
EMBER_OTA_BROADCAST_BOOTLOADER_TARGET_STATUS_STATUS_REQUEST_COMPLETED if the server is currently performing a target status request process and the target has responded to the server's inquiry. In this case, the client also reports an application status. Therefore, the applicationTargetStatus parameter is valid.
EMBER_OTA_BROADCAST_BOOTLOADER_TARGET_STATUS_STATUS_REQUEST_ONGOING if the server is currently performing a target status request process and the target is not yet queried by the server.
EMBER_OTA_BROADCAST_BOOTLOADER_TARGET_STATUS_BOOTLOAD_REQUEST_ACCEPTED if the server is currently performing a bootload request process and the target has accepted to perform the requested image bootload.
EMBER_OTA_BROADCAST_BOOTLOADER_TARGET_STATUS_BOOTLOAD_REQUEST_REFUSED if the server is currently performing a bootload request process and the target has refused to perform the requested image bootload.
EMBER_OTA_BROADCAST_BOOTLOADER_TARGET_STATUS_BOOTLOAD_REQUEST_ONGOING if the server is currently performing a bootload request process and the target is not yet reached by the server.

◆ emberAfPluginBootloaderServerInitiateRequestTargetsBootload()

EmberAfOtaBootloaderStatus emberAfPluginBootloaderServerInitiateRequestTargetsBootload	(	uint32_t	`bootloadDelayMs,`
		uint8_t	`imageTag,`
		EmberNodeId *	`targetList,`
		uint16_t	`targetListLength`
	)

Start the process where a server requests a set of target devices to initiate the bootload of a received image at some point in the future. The application can use the emberAfPluginBootloaderServerGetTargetStatus() API at any time during the bootload request process to check the status of each target.

Parameters

[in]	`bootloadDelayMs`	The delay in milliseconds after which all the targets should perform an image bootload.
[in]	`imageTag`	A 1-byte tag that identifies the image to be bootloaded at the target devices.
[in]	`targetList`	An array of EmberNodeId indicating the node IDs of the target devices that is requested to bootload an image.
[in]	`targetListLength`	The length of the passed `targetlist` .

Returns

An EmberAfOtaBootloaderStatus value of:

EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_SUCCESS if the plugin successfully initiated the process of requesting a set of targets to initiate a bootload. If this is the case, the corresponding callback emberAfPluginBootloaderServerRequestTargetsBootloadCompleteCallback() shall be invoked when the request process to all targets has completed.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_INVALID_CALL if some of the passed parameters are invalid.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_BUSY if the server is currently involved in another over-the-air process.

◆ emberAfPluginBootloaderServerInitiateRequestTargetsStatus()

EmberAfOtaBootloaderStatus emberAfPluginBootloaderServerInitiateRequestTargetsStatus	(	EmberNodeId *	`targetList,`
		uint16_t	`targetListLength,`
		uint8_t	`applicationServerStatus`
	)

Initiate the process to request the status of a set of target devices. The application can use the emberAfPluginBootloaderServerGetTargetStatus() API at any time during the target status request process to check the status of each target.

Parameters

[in]	`targetList`	An array of EmberNodeId indicating the node IDs of the target devices that are queried for their status.
[in]	`targetListLength`	The length of the passed `targetlist` .
[in]	`applicationServerStatus`	The application can set a status here which will be sent to the clients in emberAfPluginOtaBootloaderClientIncomingRequestStatusCallback()

Returns

An EmberAfOtaBootloaderStatus value of:

EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_SUCCESS if the plugin successfully initiated the process of requesting the status of a set of targets. If this is the case, the corresponding callback emberAfPluginBootloaderServerRequestTargetsStatusCompleteCallback() is invoked when the request process to all targets completes.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_INVALID_CALL if some of the passed parameters are invalid.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_BUSY if the server is currently involved in another over-the-air process.

◆ emberAfPluginBootloaderServerRequestTargetsBootloadCompleteCallback()

void emberAfPluginBootloaderServerRequestTargetsBootloadCompleteCallback ( EmberAfOtaBootloaderStatus status )

A callback invoked on the OTA Bootloader Server when a bootload request process has completed. Within this callback, the application should use the emberAfPluginBootloaderServerGetTargetStatus() API to retrieve the status and the application status reported by each target.

Parameters

[in]


              status

An EmberAfOtaBootloaderStatus value of:

EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_SUCCESS if all targets have been requested to perform a bootload. Notice that some targets might have been declared unreachable.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_STACK_ERROR if the server encountered multiple consecutive transmission errors. The Server gives up the bootload request process if EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_STACK_ERRORS consecutive transmission errors are encountered.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_ABORTED if the application aborted the current bootload request process.

◆ emberAfPluginBootloaderServerRequestTargetsStatusCompleteCallback()

void emberAfPluginBootloaderServerRequestTargetsStatusCompleteCallback ( EmberAfOtaBootloaderStatus status )

A callback invoked on the OTA Bootloader Server when bootload request process has completed. Within this callback, the application should use the emberAfPluginBootloaderServerGetTargetStatus() API to retrieve the status and application status reported by each target.

Parameters

[in]


              status

An EmberAfOtaBootloaderStatus value of:

EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_SUCCESS if all the targets have been queried for their status. Notice that some targets might have been declared unreachable.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_STACK_ERROR if the server encountered multiple consecutive transmission errors. The Server gives up the targets status request process if EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_STACK_ERRORS consecutive transmission errors are encountered.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_ABORTED if the application aborted the current targets status request process.

◆ emberAfPluginOtaBootloaderServerAbortCurrentProcess()

EmberAfOtaBootloaderStatus emberAfPluginOtaBootloaderServerAbortCurrentProcess ( void )

Abort the ongoing process (image distribution, status request or bootload request). Note that aborting a bootload request process likely results in some targets performing the bootload while some others do not.

Returns

An EmberAfOtaBootloaderStatus value of:

EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_SUCCESS if the current ongoing process was successfully aborted.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_INVALID_CALL if the server is not currently involved in any process.

◆ emberAfPluginOtaBootloaderServerGetImageSegmentCallback()

bool emberAfPluginOtaBootloaderServerGetImageSegmentCallback	(	uint32_t	`startIndex,`
		uint32_t	`endIndex,`
		uint8_t	`imageTag,`
		uint8_t *	`imageSegment`
	)

A callback invoked on the OTA Bootloader Server during an image distribution process to retrieve a contiguous segment of the image being distributed.

Parameters

[in]	`startIndex`	The index of the first byte the application should copy into the passed array.
[in]	`endIndex`	The index of the last byte the application should copy into the passed array.
[in]	`imageTag`	A 1-byte tag of the image for which a segment is being requested.
[out]	`imageSegment`	An array of (endIndex - startIndex + 1) length to which the application should copy the requested image segment.

Returns: A boolean indicating whether the application successfully copied the requested bytes into the passed array. If the application returns false , the OTA Server plugin aborts the ongoing distribution process.

◆ emberAfPluginOtaBootloaderServerImageDistributionCompleteCallback()

void emberAfPluginOtaBootloaderServerImageDistributionCompleteCallback ( EmberAfOtaBootloaderStatus status )

A callback invoked on the OTA Bootloader Server when the image distribution process is terminated. The application can use the emberAfPluginBootloaderServerGetTargetStatus() API to retrieve the status reported by each target device.

Parameters

[in]


              status

An EmberAfOtaBootloaderStatus value of:

EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_SUCCESS if all targets have confirmed that the full image was received except for those that have been declared "unreachable".
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_DATA_UNDERFLOW if the application failed to supply the requested image segments.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_STACK_ERROR if the server encountered multiple consecutive transmission errors. The Server gives up the image distribution process if EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_STACK_ERRORS consecutive transmission errors are encountered.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_FAILED if the distribution process terminated prematurely because all targets have been declared unreachable.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_TIMEOUT if the server performed all the allowable broadcast rounds and there are still missing segments at one or more targets. The maximum allowable rounds are defined by EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_BROADCAST_ROUNDS .
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_ABORTED if the application aborted the current image distribution process.

◆ emberAfPluginOtaBootloaderServerInitiateImageDistribution()

EmberAfOtaBootloaderStatus emberAfPluginOtaBootloaderServerInitiateImageDistribution	(	uint32_t	`imageSize,`
		uint8_t	`imageTag,`
		EmberNodeId *	`targetList,`
		uint16_t	`targetListLength`
	)

Initiate the image distribution process. The application can use the emberAfPluginBootloaderServerGetTargetStatus() API at any time during the image distribution process to check the status of each target.

Parameters

[in]	`imageSize`	The image size in bytes to be distributed.
[in]	`imageTag`	A 1-byte tag that will be embedded in the server-to-client over-the-air messages. The application can use the image tag for versioning purposes and/or for distinguishing between different image types.
[out]	`targetList`	An array of EmberNodeId indicating the node IDs of the target devices.
[in]	`targetListLength`	The length of the passed `targetList`

Returns

An EmberAfOtaBootloaderStatus value of:

EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_SUCCESS if the image distribution is successfully initiated. If this is the case, the emberAfPluginOtaBootloaderServerImageDistributionCompleteCallback() callback is invoked when the distribution process terminates.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_INVALID_CALL if some of the passed parameters are invalid.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_BUSY if the server is already performing another image distribution or some other over-the-air process.
EMBER_OTA_BROADCAST_BOOTLOADER_STATUS_NO_BUFFERS if the server can't allocate memory from the heap to store the passed target list. (See Memory Buffer for details).

Ota Broadcast Bootloader Server Plugin Connect Application Framework API Reference

Macros

Functions

Callbacks

Detailed Description

Macro Definition Documentation

◆ EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_BROADCAST_ROUNDS

◆ EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_STACK_ERRORS

◆ EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_MAX_UNICAST_ERRORS

◆ EMBER_AF_PLUGIN_OTA_BROADCAST_BOOTLOADER_SERVER_RESPONSE_TIMEOUT_MS

Function Documentation

◆ emberAfPluginBootloaderServerGetTargetStatus()

◆ emberAfPluginBootloaderServerInitiateRequestTargetsBootload()

◆ emberAfPluginBootloaderServerInitiateRequestTargetsStatus()

◆ emberAfPluginBootloaderServerRequestTargetsBootloadCompleteCallback()

◆ emberAfPluginBootloaderServerRequestTargetsStatusCompleteCallback()

◆ emberAfPluginOtaBootloaderServerAbortCurrentProcess()

◆ emberAfPluginOtaBootloaderServerGetImageSegmentCallback()

◆ emberAfPluginOtaBootloaderServerImageDistributionCompleteCallback()

◆ emberAfPluginOtaBootloaderServerInitiateImageDistribution()

Ota Broadcast Bootloader Server Plugin
Connect Application Framework API Reference