OTA Server#
Callbacks for OTA Server Component.
Callbacks#
Call when a block is sent to a device.
Call when a block is sent to a device.
Call when an update has started.
Call when an OTA update has finished.
Callbacks Documentation#
emberAfOtaServerSendUpgradeCommandCallback#
void emberAfOtaServerSendUpgradeCommandCallback (EmberNodeId dest, uint8_t endpoint, const EmberAfOtaImageId * id, firmwareVersion)
Call when a block is sent to a device.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNodeId | N/A | dest | The block length. |
| uint8_t | N/A | endpoint | The manufacturer ID. |
| const EmberAfOtaImageId * | 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.
emberAfPluginOtaServerBlockSentCallback#
void emberAfPluginOtaServerBlockSentCallback (uint8_t actualLength, uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion)
Call when a block is sent to a device.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | actualLength | The block length. |
| uint16_t | N/A | manufacturerId | The manufacturer ID. |
| uint16_t | N/A | imageTypeId | The image Type ID. |
| uint32_t | N/A | firmwareVersion | Firmware Version. |
This function will be called when a block is sent to a device.
emberAfPluginOtaServerUpdateStartedCallback#
void emberAfPluginOtaServerUpdateStartedCallback (uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion, uint8_t maxDataSize, uint32_t offset)
Call when an update has started.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | manufacturerId | The manufacturer ID. |
| uint16_t | N/A | imageTypeId | The image Type ID. |
| uint32_t | N/A | firmwareVersion | Firmware Version. |
| uint8_t | N/A | maxDataSize | Maximum data size. |
| uint32_t | N/A | offset | Offset. |
This function will be called when an update has started.
emberAfPluginOtaServerUpdateCompleteCallback#
void emberAfPluginOtaServerUpdateCompleteCallback (uint16_t manufacturerId, uint16_t imageTypeId, uint32_t firmwareVersion, EmberNodeId source, uint8_t status)
Call when an OTA update has finished.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | manufacturerId | The manufacturer ID. |
| uint16_t | N/A | imageTypeId | The image Type ID. |
| uint32_t | N/A | firmwareVersion | Firmware Version. |
| EmberNodeId | N/A | source | The source node ID. |
| uint8_t | N/A | status | An update status. |
This function will be called when an OTA update has finished.