Plugin Commands: Price Client#
The identify plugin contributes a CLI command to the application framework to be used for printing information related to identification.
Macros#
plugin price-client bill-period printCurrent [endpoint:1]
plugin price-client block-period printEvent [endpoint:1] [issuerEventId:4]
plugin price-client calf-value printEvent [endpoint:1] [issuerEventId:4]
plugin price-client co2-value printCurrent [endpoint:1]
plugin price-client consol-bill print [endpoint:1] [index:1]
plugin price-client consol-bill printCurrent [endpoint:1]
plugin price-client consol-bill printEvent [endpoint:1] [issuerEventId:4]
plugin price-client conv-factor printEvent [endpoint:1] [issuerEventId:4]
plugin price-client cpp-event print [endpoint:1]
plugin price-client cpp-event setAuth [cppEventAuth:1]
plugin price-client credit-pmt print [endpoint:1] [index:1]
plugin price-client credit-pmt printEvent [endpoint:1] [issuerEventId:4]
plugin price-client currency-convers printCurrent [endpoint:1]
plugin price-client currency-convers printEvent [endpoint:1] [issuerEventId:4]
plugin price-client init [endpoint:1]
plugin price-client print [endpoint:1]
plugin price-client printEvent [endpoint:1] [issuerEventId:4]
plugin price-client table-clear [endpoint:1]
plugin price-client tier-label printTariff [endpoint:1] [issuerTariffId:4]
Macro Definition Documentation#
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_BILL_PERIOD_PRINT_CURRENT#
#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
4982 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_BLOCK_PERIOD_PRINT_EVENT#
#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.
4989 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CALF_VALUE_PRINT_EVENT#
#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
4996 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CO2_VALUE_PRINT_CURRENT#
#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
5002 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CONSOL_BILL_PRINT#
#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.
5009 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CONSOL_BILL_PRINT_CURRENT#
#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.
5015 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CONSOL_BILL_PRINT_EVENT#
#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.
5022 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CONV_FACTOR_PRINT_EVENT#
#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
5029 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CPP_EVENT_PRINT#
#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
5035 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CPP_EVENT_SET_AUTH#
#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.
5041 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CREDIT_PMT_PRINT#
#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.
5048 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CREDIT_PMT_PRINT_EVENT#
#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.
5055 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CURRENCY_CONVERS_PRINT_CURRENT#
#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.
5061 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_CURRENCY_CONVERS_PRINT_EVENT#
#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.
5068 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_INIT#
#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
5074 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_PRINT#
#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
5080 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_PRINT_EVENT#
#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
5087 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_TABLE_CLEAR#
#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
5093 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_PRICE_CLIENT_PLUGIN_PRICE_CLIENT_TIER_LABEL_PRINT_TARIFF#
#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
5100 of file ./app/framework/test/headers/cli.doc