Plugin Commands: Price Client
Zigbee Application Framework Command Line Interface (CLI)

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_BILL_PERIOD_PRINT_CURRENT
plugin price-client bill-period printCurrent [endpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_BLOCK_PERIOD_PRINT_EVENT
plugin price-client block-period printEvent [endpoint:1] [issuerEventId:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CALF_VALUE_PRINT_EVENT
plugin price-client calf-value printEvent [endpoint:1] [issuerEventId:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CO2_VALUE_PRINT_CURRENT
plugin price-client co2-value printCurrent [endpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CONSOL_BILL_PRINT
plugin price-client consol-bill print [endpoint:1] [index:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CONSOL_BILL_PRINT_CURRENT
plugin price-client consol-bill printCurrent [endpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CONSOL_BILL_PRINT_EVENT
plugin price-client consol-bill printEvent [endpoint:1] [issuerEventId:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CONV_FACTOR_PRINT_EVENT
plugin price-client conv-factor printEvent [endpoint:1] [issuerEventId:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CPP_EVENT_PRINT
plugin price-client cpp-event print [endpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CPP_EVENT_SET_AUTH
plugin price-client cpp-event setAuth [cppEventAuth:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CREDIT_PMT_PRINT
plugin price-client credit-pmt print [endpoint:1] [index:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CREDIT_PMT_PRINT_EVENT
plugin price-client credit-pmt printEvent [endpoint:1] [issuerEventId:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CURRENCY_CONVERS_PRINT_CURRENT
plugin price-client currency-convers printCurrent [endpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CURRENCY_CONVERS_PRINT_EVENT
plugin price-client currency-convers printEvent [endpoint:1] [issuerEventId:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_INIT
plugin price-client init [endpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_PRINT
plugin price-client print [endpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_PRINT_EVENT
plugin price-client printEvent [endpoint:1] [issuerEventId:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_TABLE_CLEAR
plugin price-client table-clear [endpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_TIER_LABEL_PRINT_TARIFF
plugin price-client tier-label printTariff [endpoint:1] [issuerTariffId:4]

Detailed Description

The identify plugin contributes a CLI command to the application framework to be used for printing information related to identification.

Macro Definition Documentation

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_BILL_PERIOD_PRINT_CURRENT

plugin price-client bill-period printCurrent [endpoint:1]

  • Prints the billing period table entry that is currently active.
    • endpoint - INT8U - The relevant endpoint
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_BLOCK_PERIOD_PRINT_EVENT

plugin price-client block-period printEvent [endpoint:1] [issuerEventId:4]

  • Prints the entry of the Block Period table with a matching event ID.
    • endpoint - INT8U - The relevant endpoint.
    • issuerEventId - INT32U - The event ID whose information in the block period table should be printed.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CALF_VALUE_PRINT_EVENT

plugin price-client calf-value printEvent [endpoint:1] [issuerEventId:4]

  • Prints the calorific value table entry with a matching event ID.
    • endpoint - INT8U - The relevant endpoint
    • issuerEventId - INT32U - The event ID that should be printed if found in the calorific value table
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CO2_VALUE_PRINT_CURRENT

plugin price-client co2-value printCurrent [endpoint:1]

  • Prints the active CO2 value.
    • endpoint - INT8U - The relevant endpoint
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CONSOL_BILL_PRINT

plugin price-client consol-bill print [endpoint:1] [index:1]

  • Prints the entry of the consolidated bill table.
    • endpoint - INT8U - The relevant endpoint.
    • index - INT8U - The index of the consolidated bill table that should be printed.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CONSOL_BILL_PRINT_CURRENT

plugin price-client consol-bill printCurrent [endpoint:1]

  • Prints the entry of the active consolidated bill in the consolidated bills table.
    • endpoint - INT8U - The relevant endpoint.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CONSOL_BILL_PRINT_EVENT

plugin price-client consol-bill printEvent [endpoint:1] [issuerEventId:4]

  • Prints the entry of the consolidated bill table with a matching event ID.
    • endpoint - INT8U - The relevant endpoint.
    • issuerEventId - INT32U - The event ID whose information in the consolidated bill table should be printed.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CONV_FACTOR_PRINT_EVENT

plugin price-client conv-factor printEvent [endpoint:1] [issuerEventId:4]

  • Prints the conversion factor table entry with a matching event ID.
    • endpoint - INT8U - The relevant endpoint
    • issuerEventId - INT32U - The event ID that should be printed if found in the conversion factor table
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CPP_EVENT_PRINT

plugin price-client cpp-event print [endpoint:1]

  • Prints the entry of the cpp event table.
    • endpoint - INT8U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CPP_EVENT_SET_AUTH

plugin price-client cpp-event setAuth [cppEventAuth:1]

  • Sets the authorization status for future CPP events.
    • cppEventAuth - INT8U - The authorization status for future CPP events.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CREDIT_PMT_PRINT

plugin price-client credit-pmt print [endpoint:1] [index:1]

  • Prints the entry of the credit payment table.
    • endpoint - INT8U - The relevant endpoint.
    • index - INT8U - The index of the credit payment table entry that should be printed.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CREDIT_PMT_PRINT_EVENT

plugin price-client credit-pmt printEvent [endpoint:1] [issuerEventId:4]

  • Prints the entry of the credit payment table with a matching issuer event ID.
    • endpoint - INT8U - The relevant endpoint.
    • issuerEventId - INT32U - The issuerEventId of the credit payment table entry that should be printed.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CURRENCY_CONVERS_PRINT_CURRENT

plugin price-client currency-convers printCurrent [endpoint:1]

  • Prints the active entry of the currency conversion table.
    • endpoint - INT8U - The relevant endpoint.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CURRENCY_CONVERS_PRINT_EVENT

plugin price-client currency-convers printEvent [endpoint:1] [issuerEventId:4]

  • Prints the entry of the currency conversion table with a matching issuer event ID.
    • endpoint - INT8U - The relevant endpoint.
    • issuerEventId - INT32U - The issuerEventId of the currency conversion table entry that should be printed.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_INIT

plugin price-client init [endpoint:1]

  • Initialize the price info for the provided endpoint.
    • endpoint - INT8U - The relevant endpoint
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_PRINT

plugin price-client print [endpoint:1]

  • Print the price info for the provided endpoint.
    • endpoint - INT8U - The relevant endpoint
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_PRINT_EVENT

plugin price-client printEvent [endpoint:1] [issuerEventId:4]

  • Print the price info for the provided endpoint and event ID.
    • endpoint - INT8U - The relevant endpoint
    • issuerEventId - INT32U - The event ID that should be printed if found in the price table
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_TABLE_CLEAR

plugin price-client table-clear [endpoint:1]

  • Clears out the currently set price for the supplied endpoint.
    • endpoint - INT8U - The relevant endpoint
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_TIER_LABEL_PRINT_TARIFF

plugin price-client tier-label printTariff [endpoint:1] [issuerTariffId:4]

  • Prints the tier label table entry with a matching tariff ID.
    • endpoint - INT8U - The relevant endpoint.
    • issuerTariffId - INT32U - The issuer tariff ID that should be looked for in the tier label table