Plugin Commands: Idle/Sleep#

The Sleep plugin contributes several commands to the application framework's CLI. These commands are used to control the idling and sleeping behavior of the device.

Macros#

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IDLE_SLEEP_PLUGIN_IDLE_SLEEP_AWAKE_WHEN_NOT_JOINED

plugin idle-sleep awake-when-not-joined [stayAwakeWhenNotJoined:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IDLE_SLEEP_PLUGIN_IDLE_SLEEP_FORCE_AWAKE

plugin idle-sleep force-awake [stayAwake:1]

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IDLE_SLEEP_PLUGIN_IDLE_SLEEP_AWAKE_WHEN_NOT_JOINED#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IDLE_SLEEP_PLUGIN_IDLE_SLEEP_AWAKE_WHEN_NOT_JOINED

plugin idle-sleep awake-when-not-joined [stayAwakeWhenNotJoined:1]

  • Sets whether the device stays awake when not joined to a ZigBee network.

    • stayAwakeWhenNotJoined - BOOLEAN - The value indicating whether the device should stay awake when not joined to a ZigBee network.


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IDLE_SLEEP_PLUGIN_IDLE_SLEEP_FORCE_AWAKE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IDLE_SLEEP_PLUGIN_IDLE_SLEEP_FORCE_AWAKE

plugin idle-sleep force-awake [stayAwake:1]

  • Sets whether the device is forced to stay awake.

    • stayAwake - BOOLEAN - The value indicating whether the device should stay awake.


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IDLE_SLEEP_PLUGIN_IDLE_SLEEP_STATUS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IDLE_SLEEP_PLUGIN_IDLE_SLEEP_STATUS

plugin idle-sleep status

  • Display the status of the sleeping behavior.


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