OTA Server#

Callbacks for OTA Server Component.

Callbacks#

void

emberAfOtaServerSendUpgradeCommandCallback(EmberNodeId dest, uint8_t endpoint, const EmberAfOtaImageId *id)

Call when a block is sent to a device.

void

emberAfPluginOtaServerBlockSentCallback(uint8_t actualLength, uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion)

Call when a block is sent to a device.

void

emberAfPluginOtaServerUpdateStartedCallback(uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion, uint8_t maxDataSize, uint32_t offset)

Call when an update has started.

void

emberAfPluginOtaServerUpdateCompleteCallback(uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion, EmberNodeId source, uint8_t status)

Call when an OTA update has finished.

Callbacks Documentation#

emberAfOtaServerSendUpgradeCommandCallback#

void emberAfOtaServerSendUpgradeCommandCallback (EmberNodeId dest, uint8_t endpoint, const EmberAfOtaImageId *id)

Call when a block is sent to a device.

Parameters

N/A	dest	The block length.
N/A	endpoint	The manufacturer ID.
N/A	id	The image Type ID.
N/A	firmwareVersion	Firmware Version.

This function will be called when a block is sent to a device.

Definition at line 70 of file app/framework/plugin/ota-server/ota-server.h

emberAfPluginOtaServerBlockSentCallback#

void emberAfPluginOtaServerBlockSentCallback (uint8_t actualLength, uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion)

Call when a block is sent to a device.

Parameters

N/A	actualLength	The block length.
N/A	manufacturerId	The manufacturer ID.
N/A	imageTypeId	The image Type ID.
N/A	firmwareVersion	Firmware Version.

This function will be called when a block is sent to a device.

Definition at line 83 of file app/framework/plugin/ota-server/ota-server.h

emberAfPluginOtaServerUpdateStartedCallback#

void emberAfPluginOtaServerUpdateStartedCallback (uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion, uint8_t maxDataSize, uint32_t offset)

Call when an update has started.

Parameters

N/A	manufacturerId	The manufacturer ID.
N/A	imageTypeId	The image Type ID.
N/A	firmwareVersion	Firmware Version.
N/A	maxDataSize	Maximum data size.
N/A	offset	Offset.

This function will be called when an update has started.

Definition at line 99 of file app/framework/plugin/ota-server/ota-server.h

emberAfPluginOtaServerUpdateCompleteCallback#

void emberAfPluginOtaServerUpdateCompleteCallback (uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion, EmberNodeId source, uint8_t status)

Call when an OTA update has finished.

Parameters

N/A	manufacturerId	The manufacturer ID.
N/A	imageTypeId	The image Type ID.
N/A	firmwareVersion	Firmware Version.
N/A	source	The source node ID.
N/A	status	An update status.

This function will be called when an OTA update has finished.

Definition at line 115 of file app/framework/plugin/ota-server/ota-server.h