Plugin Commands: OTA Client#

The OTA Client plugin provides Over-the-air commands for upgrading firmware and downloading specific files on the client side.

Macros#

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_BOOTLOAD undefined

plugin ota-client bootload [index:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_PAGE_REQUEST undefined

plugin ota-client page-request [pageRequest:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_PAUSE_AT undefined

plugin ota-client pause-at [stopDownloadPercentage:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_VERIFY undefined

plugin ota-client verify [index:1]

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_BLOCK_TEST#

#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)


Definition at line 4492 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_BOOTLOAD#

#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


Definition at line 4498 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_DISABLE_DOWNGRADES#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_DISABLE_DOWNGRADES

plugin ota-client disable-downgrades

  • Disable OTA downgrades


Definition at line 4503 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_ENABLE_DOWNGRADES#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_ENABLE_DOWNGRADES

plugin ota-client enable-downgrades

  • Enable OTA downgrades


Definition at line 4508 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_INFO#

#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


Definition at line 4513 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_PAGE_REQUEST#

#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


Definition at line 4519 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_PAUSE_AT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_PAUSE_AT

plugin ota-client pause-at [stopDownloadPercentage:1]

    • stopDownloadPercentage - INT8U


Definition at line 4525 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_START#

#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


Definition at line 4530 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_STATUS#

#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.


Definition at line 4535 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_STOP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_STOP

plugin ota-client stop

  • Stops the OTA state machine


Definition at line 4540 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_UPGRADE_REQUEST#

#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


Definition at line 4545 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_OTA_CLIENT_PLUGIN_OTA_CLIENT_VERIFY#

#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


Definition at line 4551 of file ./app/framework/test/headers/cli.doc