Plugin Commands: OTA Client
Detailed Description
The OTA Client plugin provides Over-the-air commands for upgrading firmware and downloading specific files on the client side.
Macro Definition Documentation
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_BLOCK_TEST |
plugin ota-client block-test
- Sends an image block request for a file the server should not have. Test harness only (test case 9.5.6 - Missing File)
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_BOOTLOAD |
plugin ota-client bootload [index:1]
-
Bootloads the image at the specified index by calling the OTA bootload callback.
- index - INT8U - The index at which to begin bootloading the image
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_DISABLE_DOWNGRADES |
plugin ota-client disable-downgrades
- Disable OTA downgrades
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_ENABLE_DOWNGRADES |
plugin ota-client enable-downgrades
- Enable OTA downgrades
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_INFO |
plugin ota-client info
- Prints the manufacturer ID, Image Type ID, and Version information that are used when a query next image is sent to the server by the client
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_PAGE_REQUEST |
plugin ota-client page-request [pageRequest:1]
-
- pageRequest - INT8U - boolean value turning on (1) or off (0) the page request flag
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_PAUSE_AT |
plugin ota-client pause-at [stopDownloadPercentage:1]
-
- stopDownloadPercentage - INT8U
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_START |
plugin ota-client start
- Starts the ota client state machine. The state machine discovers the OTA server, queries for new images, downloads the images and waits for the server command to upgrade
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_STATUS |
plugin ota-client status
- Prints information on the current state of the OTA client download.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_STOP |
plugin ota-client stop
- Stops the OTA state machine
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_UPGRADE_REQUEST |
plugin ota-client upgrade-request
- Send an OTA server an UpgradeEndRequest
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_VERIFY |
plugin ota-client verify [index:1]
-
Perform signature verification on the image at the specified index
- index - INT8U - The index at which to begin verification of the image