Plugin Commands: Green Power Client#

The Green Power Client plugin contributes CLI commands to the application framework to be used for getting, setting, and displaying information relevant to the Green Power Client cluster.

Macros#

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_ADD_GROUP_SINK

plugin green-power-client add-group-sink [sourceID:4] [sinkGroup:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_ADD_SINK

plugin green-power-client add-sink [sourceID:4] [sinkIeee:8]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_DUPLICATE_FILTER_TEST

plugin green-power-client duplicate-filter-test [endpoint:1] [sourceId:4] [sequenceNumber:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_RM_SINK

plugin green-power-client rm-sink [sourceID:4] [sinkIeee:8]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_SET_KEY

plugin green-power-client set-key [index:1] [key:16]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_SET_PROXY_ENTRY

plugin green-power-client set-proxy-entry [index:1] [sourceID:4] [sinkNodeId:2] [options:4]

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_ADD_GROUP_SINK#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_ADD_GROUP_SINK

plugin green-power-client add-group-sink [sourceID:4] [sinkGroup:2]

  • Add a groupcast sink for a given GPD

    • sourceID - INT32U - GPD Source ID

    • sinkGroup - INT16U - Sink group


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_ADD_SINK#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_ADD_SINK

plugin green-power-client add-sink [sourceID:4] [sinkIeee:8]

  • Add a sink for a given GPD

    • sourceID - INT32U - GPD Source ID

    • sinkIeee - IEEE_ADDRESS - Sink's IEEE address


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_CLEAR_PROXY_TABLE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_CLEAR_PROXY_TABLE

plugin green-power-client clear-proxy-table

  • clear the proxy table


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_DUPLICATE_FILTER_TEST#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_DUPLICATE_FILTER_TEST

plugin green-power-client duplicate-filter-test [endpoint:1] [sourceId:4] [sequenceNumber:1]

  • This is used to instrument the current device receiving a message in order to test the duplicate message filtering functionality.

    • endpoint - INT8U

    • sourceId - INT32U - source Id of the fake incoming message

    • sequenceNumber - INT8U


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_PRINT_PROXY_TABLE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_PRINT_PROXY_TABLE

plugin green-power-client print-proxy-table

  • Print the proxy table


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_RM_GPD#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_RM_GPD

plugin green-power-client rm-gpd [sourceID:4]

  • Remove a given GPD from the proxy table

    • sourceID - INT32U - GPD Source ID


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_RM_SINK#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_RM_SINK

plugin green-power-client rm-sink [sourceID:4] [sinkIeee:8]

  • remove a sink for a given GPD. If that's the last sink, remove the proxy table entry

    • sourceID - INT32U - GPD Source ID

    • sinkIeee - IEEE_ADDRESS - Sink's IEEE address


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_SET_KEY#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_SET_KEY

plugin green-power-client set-key [index:1] [key:16]

  • This is used to set the key for a proxy table entry

    • index - INT8U

    • key - SECURITY_KEY - source Id of the fake incoming message


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_SET_PROXY_ENTRY#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GREEN_POWER_CLIENT_PLUGIN_GREEN_POWER_CLIENT_SET_PROXY_ENTRY

plugin green-power-client set-proxy-entry [index:1] [sourceID:4] [sinkNodeId:2] [options:4]

  • Set a proxy table entry

    • index - INT8U - index to proxy table

    • sourceID - INT32U - GPD Source ID

    • sinkNodeId - INT16U - Sink's node address

    • options - INT32U


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