Modules#

EmberAfPriceClientCommonInfo

EmberAfPriceClientBillingPeriod

EmberAfPriceClientBlockPeriod

EmberAfPriceClientBlockThreshold

EmberAfPriceClientCalorificValue

EmberAfPriceClientCo2Value

EmberAfPriceClientConversionFactor

EmberAfPriceClientCppEvent

EmberAfPriceClientCreditPayment

EmberAfPriceClientCurrencyConversion

EmberAfPriceClientTierLabels

EmberAfPriceClientBillingPeriodTable

EmberAfPriceClientBlockPeriodTable

EmberAfPriceClientBlockThresholdTable

EmberAfPriceClientCalorificValueTable

EmberAfPriceClientCo2ValueTable

EmberAfPriceClientConversionFactorTable

EmberAfPriceClientCppEventTable

EmberAfPriceClientCreditPaymentTable

EmberAfPriceClientCurrencyConversionTable

EmberAfPriceClientTierLabelsTable

EmberAfPriceClientInfo

Price Client

Price Client#

API and Callbacks for the Price Cluster Client Component.

This component provides an implementation of a Price client. It simply stores the prices received over-the-air. This component requires extending to act on the price changes.

API#

void
emberAfPriceInitConsolidatedBillsTable(uint8_t endpoint)

Initialize the consolidated bills table.

uint8_t
emberAfPriceClusterGetActiveCo2ValueIndex(uint8_t endpoint)

Return the index of the currently active CO2 entry, or 0xFF if no active entry can be found.

void
emberAfPricePrintCppEvent(uint8_t endpoint)

Print information about the CPP event.

uint8_t
emberAfPriceClusterCurrencyConversionTableGetIndexByEventId(uint8_t endpoint, uint32_t issuerEventId)

Return the currency conversion table index with a matching eventId.

uint8_t
emberAfPriceClusterGetActiveCurrencyIndex(uint8_t endpoint)

Return the index of the currently active currency conversion entry, or 0xFF if no active entry can be found.

Functions#

void
emAfPluginPriceClientPrintInfo(uint8_t endpoint)
void
emAfPluginPriceClientPrintByEventId(uint8_t endpoint, uint32_t issuerEventId)
void
emAfPriceClearPriceTable(uint8_t endpoint)
uint8_t
emAfPriceGetBlockPeriodTableIndexByEventId(uint8_t endpoint, uint32_t issuerEventId)

Return the block period table index with a matching eventId.

void
emAfPricePrintBlockPeriodTableIndex(uint8_t endpoint, uint8_t index)

Print the information at the specified index of the block period table.

uint8_t
emAfPriceGetConversionFactorIndexByEventId(uint8_t endpoint, uint32_t issuerEventId)

Return the conversion factor table index with a matching eventId.

void
emAfPricePrintConversionFactorEntryIndex(uint8_t endpoint, uint8_t index)

Print the information at the specified index of the conversion factor table.

uint8_t
emAfPriceGetCalorificValueIndexByEventId(uint8_t endpoint, uint32_t issuerEventId)

Return the calorific value table index with a matching eventId.

void
emAfPricePrintCalorificValueEntryIndex(uint8_t endpoint, uint8_t index)

Print the information at the specified index of the calorific value table.

uint8_t
emAfPriceGetActiveTierLabelTableIndexByTariffId(uint8_t endpoint, uint32_t tariffId)

Return the index of the currently active tier label table entry, or 0xFF if no active entry can be found.

void
emAfPricePrintTierLabelTableEntryIndex(uint8_t endpoint, uint8_t index)

Print the information at the specified index of the tier label table.

void
emAfPricePrintCo2ValueTablePrintIndex(uint8_t endpoint, uint8_t index)

Print the information at the specified index of the CO2 value table.

uint8_t
emAfPriceConsolidatedBillTableGetIndexWithEventId(uint8_t endpoint, uint32_t issuerEventId)

Print the tier label table.

uint8_t
emAfPriceConsolidatedBillTableGetCurrentIndex(uint8_t endpoint)

Return the index of the active consolidated bill table.

void
emAfPricePrintConsolidatedBillTableIndex(uint8_t endpoint, uint8_t index)

Print the information at the specified index of the consolidated bill table.

uint8_t
emAfPriceCreditPaymentTableGetIndexWithEventId(uint8_t endpoint, uint32_t issuerEventId)

Return the credit payment table index with a matching eventId.

void
emAfPricePrintCreditPaymentTableEventId(uint32_t issuerEventId)

Print the credit payment table entry data of the index with a valid matching eventId.

void
emAfPricePrintCreditPaymentTableIndex(uint8_t endpoint, uint8_t index)

Print the information at the specified index of the credit payment table.

void
emAfPricePrintCurrencyConversionTableIndex(uint8_t endpoint, uint8_t index)

Print the information at the specified index of the currency conversion table.

uint8_t
emAfPriceGetActiveBillingPeriodIndex(uint8_t endpoint)

Return the index of the currently active billing period entry, or 0xFF if no active entry can be found.

void
emAfPricePrintBillingPeriodTableEntryIndex(uint8_t endpoint, uint8_t index)

Print the information at the specified index of the billing period table.

Macros#

#define
UNSPECIFIED_PROVIDER_ID 0xFFFFFFFF
#define
UNSPECIFIED_DURATION 0xFFFFFFFF

API Documentation#

emberAfPriceInitConsolidatedBillsTable#

void emberAfPriceInitConsolidatedBillsTable (uint8_t endpoint)

Initialize the consolidated bills table.

Parameters
N/Aendpoint

The relevant endpoint.


Definition at line 233 of file app/framework/plugin/price-client/price-client.h

emberAfPriceClusterGetActiveCo2ValueIndex#

uint8_t emberAfPriceClusterGetActiveCo2ValueIndex (uint8_t endpoint)

Return the index of the currently active CO2 entry, or 0xFF if no active entry can be found.

Parameters
N/Aendpoint

The relevant endpoint.

Returns

  • The index of the active CO2 entry.


Definition at line 243 of file app/framework/plugin/price-client/price-client.h

emberAfPricePrintCppEvent#

void emberAfPricePrintCppEvent (uint8_t endpoint)

Print information about the CPP event.

Parameters
N/Aendpoint

THe relevant endpoint.


Definition at line 251 of file app/framework/plugin/price-client/price-client.h

emberAfPriceClusterCurrencyConversionTableGetIndexByEventId#

uint8_t emberAfPriceClusterCurrencyConversionTableGetIndexByEventId (uint8_t endpoint, uint32_t issuerEventId)

Return the currency conversion table index with a matching eventId.

Parameters
N/Aendpoint

The relevant endpoint.

N/AissuerEventId

The eventId that should be searched for in the currency conversion table.

Returns

  • The index with a valid matching event ID.


Definition at line 261 of file app/framework/plugin/price-client/price-client.h

emberAfPriceClusterGetActiveCurrencyIndex#

uint8_t emberAfPriceClusterGetActiveCurrencyIndex (uint8_t endpoint)

Return the index of the currently active currency conversion entry, or 0xFF if no active entry can be found.

Parameters
N/Aendpoint

The relevant endpoint.

Returns

  • The index of the active currency conversion entry.


Definition at line 271 of file app/framework/plugin/price-client/price-client.h

Function Documentation#

emAfPluginPriceClientPrintInfo#

void emAfPluginPriceClientPrintInfo (uint8_t endpoint)
Parameters
N/Aendpoint

Definition at line 277 of file app/framework/plugin/price-client/price-client.h

emAfPluginPriceClientPrintByEventId#

void emAfPluginPriceClientPrintByEventId (uint8_t endpoint, uint32_t issuerEventId)
Parameters
N/Aendpoint
N/AissuerEventId

Definition at line 278 of file app/framework/plugin/price-client/price-client.h

emAfPriceClearPriceTable#

void emAfPriceClearPriceTable (uint8_t endpoint)
Parameters
N/Aendpoint

Definition at line 279 of file app/framework/plugin/price-client/price-client.h

emAfPriceGetBlockPeriodTableIndexByEventId#

uint8_t emAfPriceGetBlockPeriodTableIndexByEventId (uint8_t endpoint, uint32_t issuerEventId)

Return the block period table index with a matching eventId.

Parameters
N/Aendpoint

The relevant endpoint.

N/AissuerEventId

The eventId that should be searched for in the block period table.

Returns

  • The index with a valid matching event ID.


Definition at line 289 of file app/framework/plugin/price-client/price-client.h

emAfPricePrintBlockPeriodTableIndex#

void emAfPricePrintBlockPeriodTableIndex (uint8_t endpoint, uint8_t index)

Print the information at the specified index of the block period table.

Parameters
N/Aendpoint

The relevant endpoint.

N/Aindex

The index whose data should be printed.


Definition at line 299 of file app/framework/plugin/price-client/price-client.h

emAfPriceGetConversionFactorIndexByEventId#

uint8_t emAfPriceGetConversionFactorIndexByEventId (uint8_t endpoint, uint32_t issuerEventId)

Return the conversion factor table index with a matching eventId.

Parameters
N/Aendpoint

The relevant endpoint.

N/AissuerEventId

The eventId that should be searched for in the conversion factor table.

Returns

  • The index with a valid matching event ID.


Definition at line 309 of file app/framework/plugin/price-client/price-client.h

emAfPricePrintConversionFactorEntryIndex#

void emAfPricePrintConversionFactorEntryIndex (uint8_t endpoint, uint8_t index)

Print the information at the specified index of the conversion factor table.

Parameters
N/Aendpoint

The relevant endpoint.

N/Aindex

The index whose data should be printed.


Definition at line 318 of file app/framework/plugin/price-client/price-client.h

emAfPriceGetCalorificValueIndexByEventId#

uint8_t emAfPriceGetCalorificValueIndexByEventId (uint8_t endpoint, uint32_t issuerEventId)

Return the calorific value table index with a matching eventId.

Parameters
N/Aendpoint

The relevant endpoint.

N/AissuerEventId

The eventId that should be searched for in the calorific value table.

Returns

  • The index with a valid matching event ID.


Definition at line 328 of file app/framework/plugin/price-client/price-client.h

emAfPricePrintCalorificValueEntryIndex#

void emAfPricePrintCalorificValueEntryIndex (uint8_t endpoint, uint8_t index)

Print the information at the specified index of the calorific value table.

Parameters
N/Aendpoint

The relevant endpoint.

N/Aindex

The index whose data should be printed.


Definition at line 337 of file app/framework/plugin/price-client/price-client.h

emAfPriceGetActiveTierLabelTableIndexByTariffId#

uint8_t emAfPriceGetActiveTierLabelTableIndexByTariffId (uint8_t endpoint, uint32_t tariffId)

Return the index of the currently active tier label table entry, or 0xFF if no active entry can be found.

Parameters
N/Aendpoint

The relevant endpoint.

N/AtariffId

Returns

  • The index of the active tier label table entry.


Definition at line 347 of file app/framework/plugin/price-client/price-client.h

emAfPricePrintTierLabelTableEntryIndex#

void emAfPricePrintTierLabelTableEntryIndex (uint8_t endpoint, uint8_t index)

Print the information at the specified index of the tier label table.

Parameters
N/Aendpoint

The relevant endpoint.

N/Aindex

The index whose data should be printed.


Definition at line 356 of file app/framework/plugin/price-client/price-client.h

emAfPricePrintCo2ValueTablePrintIndex#

void emAfPricePrintCo2ValueTablePrintIndex (uint8_t endpoint, uint8_t index)

Print the information at the specified index of the CO2 value table.

Parameters
N/Aendpoint

The relevant endpoint.

N/Aindex

The index whose data should be printed.


Definition at line 365 of file app/framework/plugin/price-client/price-client.h

emAfPriceConsolidatedBillTableGetIndexWithEventId#

uint8_t emAfPriceConsolidatedBillTableGetIndexWithEventId (uint8_t endpoint, uint32_t issuerEventId)

Print the tier label table.

Parameters
N/Aendpoint

The relevant endpoint.

N/AissuerEventId

The eventId that should be searched for in the consolidated bill table.

Return the consolidated bill table index with a matching eventId.

Returns

  • The index with a valid matching event ID.


Definition at line 381 of file app/framework/plugin/price-client/price-client.h

emAfPriceConsolidatedBillTableGetCurrentIndex#

uint8_t emAfPriceConsolidatedBillTableGetCurrentIndex (uint8_t endpoint)

Return the index of the active consolidated bill table.

Parameters
N/Aendpoint

The relevant endpoint.

Returns

  • The index of the consolidated bills table with a valid matching event ID, or 0xFF if no valid match is found.


Definition at line 391 of file app/framework/plugin/price-client/price-client.h

emAfPricePrintConsolidatedBillTableIndex#

void emAfPricePrintConsolidatedBillTableIndex (uint8_t endpoint, uint8_t index)

Print the information at the specified index of the consolidated bill table.

Parameters
N/Aendpoint

The relevant endpoint.

N/Aindex

The index whose data should be printed.


Definition at line 400 of file app/framework/plugin/price-client/price-client.h

emAfPriceCreditPaymentTableGetIndexWithEventId#

uint8_t emAfPriceCreditPaymentTableGetIndexWithEventId (uint8_t endpoint, uint32_t issuerEventId)

Return the credit payment table index with a matching eventId.

Parameters
N/Aendpoint

The eventId that should be searched for in the credit payment table.

N/AissuerEventId

Returns

  • The index with a valid matching event ID.


Definition at line 409 of file app/framework/plugin/price-client/price-client.h

emAfPricePrintCreditPaymentTableEventId#

void emAfPricePrintCreditPaymentTableEventId (uint32_t issuerEventId, issuerEventId)

Print the credit payment table entry data of the index with a valid matching eventId.

Parameters
N/AissuerEventId

The relevant endpoint.

N/AissuerEventId

The eventId that should be found in the credit payment table.


Definition at line 418 of file app/framework/plugin/price-client/price-client.h

emAfPricePrintCreditPaymentTableIndex#

void emAfPricePrintCreditPaymentTableIndex (uint8_t endpoint, uint8_t index)

Print the information at the specified index of the credit payment table.

Parameters
N/Aendpoint

The relevant endpoint.

N/Aindex

The index whose data should be printed.


Definition at line 427 of file app/framework/plugin/price-client/price-client.h

emAfPricePrintCurrencyConversionTableIndex#

void emAfPricePrintCurrencyConversionTableIndex (uint8_t endpoint, uint8_t index)

Print the information at the specified index of the currency conversion table.

Parameters
N/Aendpoint

The relevant endpoint.

N/Aindex

The index whose data should be printed.


Definition at line 436 of file app/framework/plugin/price-client/price-client.h

emAfPriceGetActiveBillingPeriodIndex#

uint8_t emAfPriceGetActiveBillingPeriodIndex (uint8_t endpoint)

Return the index of the currently active billing period entry, or 0xFF if no active entry can be found.

Parameters
N/Aendpoint

The relevant endpoint.

Returns

  • The index of the active billing period entry.


Definition at line 446 of file app/framework/plugin/price-client/price-client.h

emAfPricePrintBillingPeriodTableEntryIndex#

void emAfPricePrintBillingPeriodTableEntryIndex (uint8_t endpoint, uint8_t index)

Print the information at the specified index of the billing period table.

Parameters
N/Aendpoint

The relevant endpoint.

N/Aindex

The index whose data should be printed.


Definition at line 455 of file app/framework/plugin/price-client/price-client.h

Macro Definition Documentation#

EMBER_AF_PLUGIN_PRICE_CLIENT_TABLE_SIZE#

#define EMBER_AF_PLUGIN_PRICE_CLIENT_TABLE_SIZE
Value:
2

Definition at line 42 of file app/framework/plugin/price-client/price-client.h

ZCL_PRICE_CLUSTER_PRICE_RATIO_NOT_USED#

#define ZCL_PRICE_CLUSTER_PRICE_RATIO_NOT_USED
Value:
0xFF

Definition at line 45 of file app/framework/plugin/price-client/price-client.h

ZCL_PRICE_CLUSTER_GENERATION_PRICE_NOT_USED#

#define ZCL_PRICE_CLUSTER_GENERATION_PRICE_NOT_USED
Value:
0xFFFFFFFFUL

Definition at line 46 of file app/framework/plugin/price-client/price-client.h

ZCL_PRICE_CLUSTER_GENERATION_PRICE_RATIO_NOT_USED#

#define ZCL_PRICE_CLUSTER_GENERATION_PRICE_RATIO_NOT_USED
Value:
0xFF

Definition at line 47 of file app/framework/plugin/price-client/price-client.h

ZCL_PRICE_CLUSTER_ALTERNATE_COST_DELIVERED_NOT_USED#

#define ZCL_PRICE_CLUSTER_ALTERNATE_COST_DELIVERED_NOT_USED
Value:
0xFFFFFFFFUL

Definition at line 48 of file app/framework/plugin/price-client/price-client.h

ZCL_PRICE_CLUSTER_ALTERNATE_COST_UNIT_NOT_USED#

#define ZCL_PRICE_CLUSTER_ALTERNATE_COST_UNIT_NOT_USED
Value:
0xFF

Definition at line 49 of file app/framework/plugin/price-client/price-client.h

ZCL_PRICE_CLUSTER_ALTERNATE_COST_TRAILING_DIGIT_NOT_USED#

#define ZCL_PRICE_CLUSTER_ALTERNATE_COST_TRAILING_DIGIT_NOT_USED
Value:
0xFF

Definition at line 50 of file app/framework/plugin/price-client/price-client.h

ZCL_PRICE_CLUSTER_NUMBER_OF_BLOCK_THRESHOLDS_NOT_USED#

#define ZCL_PRICE_CLUSTER_NUMBER_OF_BLOCK_THRESHOLDS_NOT_USED
Value:
0xFF

Definition at line 51 of file app/framework/plugin/price-client/price-client.h

ZCL_PRICE_CLUSTER_PRICE_CONTROL_NOT_USED#

#define ZCL_PRICE_CLUSTER_PRICE_CONTROL_NOT_USED
Value:
0x00

Definition at line 52 of file app/framework/plugin/price-client/price-client.h

UNSPECIFIED_PROVIDER_ID#

#define UNSPECIFIED_PROVIDER_ID
Value:
0xFFFFFFFF

Definition at line 56 of file app/framework/plugin/price-client/price-client.h

UNSPECIFIED_DURATION#

#define UNSPECIFIED_DURATION
Value:
0xFFFFFFFF

Definition at line 57 of file app/framework/plugin/price-client/price-client.h

EMBER_AF_PLUGIN_PRICE_CLUSTER_MAX_CREDIT_PAYMENT_REF_LENGTH#

#define EMBER_AF_PLUGIN_PRICE_CLUSTER_MAX_CREDIT_PAYMENT_REF_LENGTH
Value:
20

Definition at line 130 of file app/framework/plugin/price-client/price-client.h