Plugin Commands: Low Voltage Shutdown
Application Framework CLI Command Reference

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PLUGIN_LOW_VOLTAGE_SHUTDOWN_ENABLE
plugin low-voltage-shutdown enable [forceDisable:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PRINT_VDD
plugin low-voltage-shutdown print-vdd
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PLUGIN_LOW_VOLTAGE_SHUTDOWN_SHUTDOWN
plugin low-voltage-shutdown shutdown
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PLUGIN_LOW_VOLTAGE_SHUTDOWN_STATUS
plugin low-voltage-shutdown status

Detailed Description

The Low Voltage Shutdown plugin provides a few commands to monitor the VDD voltage or disable the checking and shutdown logic.

Macro Definition Documentation

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PLUGIN_LOW_VOLTAGE_SHUTDOWN_ENABLE

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PLUGIN_LOW_VOLTAGE_SHUTDOWN_ENABLE

plugin low-voltage-shutdown enable [forceDisable:1]

  • Sets whether the plugin's check and shutdown logic is enabled or disabled.
    • forceDisable - BOOLEAN - The value indicating whether the shutdown logic should be disabled.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PRINT_VDD

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PRINT_VDD

plugin low-voltage-shutdown print-vdd

  • Report the current VDD voltage as checked by the shutdown logic. (Doesn't do any shutdown logic if VDD is below threshold; this is just informational.)

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PLUGIN_LOW_VOLTAGE_SHUTDOWN_SHUTDOWN

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PLUGIN_LOW_VOLTAGE_SHUTDOWN_SHUTDOWN

plugin low-voltage-shutdown shutdown

  • Force the shutdown logic to engage immediately, regardless of VDD voltage.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PLUGIN_LOW_VOLTAGE_SHUTDOWN_STATUS

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_LOW_VOLTAGE_SHUTDOWN_PLUGIN_LOW_VOLTAGE_SHUTDOWN_STATUS

plugin low-voltage-shutdown status

  • Display the status of the check and shutdown behavior.