Modules#

Price Server#

API and Callbacks for the Price Cluster Server Component.

This component provides an implementation of a Smart Energy price server. The price server holds a table of prices locally and answers requests to retrieve the list of commodity prices. It requires extension to add / remove prices from the table and to send out new prices to those devices that have subscribed to the ESI for price updates.

API#

void

emberAfPriceServerSendGetScheduledPrices(uint8_t endpoint)

Send the next get scheduled prices command.

uint32_t

emberAfPriceServerSecondsUntilGetScheduledPricesEvent(void)

Return the number of seconds until the next get scheduled prices command should be sent.

void

emberAfPriceClearPriceTable(uint8_t endpoint)

Clear all prices in the price table.

void

emberAfPriceClearTariffTable(uint8_t endpoint)

Clear all tariffs in the tariff table.

void

emberAfPriceClearPriceMatrixTable(uint8_t endpoint)

Clear all price matrices in the price matrix table.

void

emberAfPriceClearBlockThresholdsTable(uint8_t endpoint)

Clear all block thresholds in the block thresholds table.

bool

emberAfPriceGetPriceTableEntry(uint8_t endpoint, uint8_t index, EmberAfScheduledPrice *price)

Get a price used by the price server plugin.

void

emberAfPluginPriceServerBlockPeriodAdd(uint8_t endpoint, uint32_t providerId, uint32_t issuerEventId, uint32_t blockPeriodStartTime, uint32_t blockPeriodDuration, uint8_t blockPeriodControl, uint8_t blockPeriodDurationType, uint32_t thresholdMultiplier, uint32_t thresholdDivisor, uint8_t tariffType, uint8_t tariffResolutionPeriod)

Set values in the block period table.

void

emberAfPluginPriceServerBlockPeriodPub(uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)

Send a publish block period command.

void

emberAfPluginPriceServerBlockPeriodPrint(uint8_t endpoint, uint8_t index)

Print data in the specified index of the block period table.

uint32_t

emberAfPriceServerSecondsUntilBlockPeriodEvent(uint8_t endpoint)

Return the number of seconds until the next block period event occurs.

void

emberAfPriceServerRefreshBlockPeriod(uint8_t endpoint, bool repeat)

Update block period attributes to match the current block period.

bool

emberAfPriceGetTariffTableEntry(uint8_t endpoint, uint8_t index, EmberAfPriceCommonInfo *info, EmberAfScheduledTariff *tariff)

Get a tariff used by the price server plugin.

bool

emberAfPriceGetPriceMatrix(uint8_t endpoint, uint8_t index, EmberAfPriceCommonInfo *info, EmberAfScheduledPriceMatrix *pm)

Retrieve a price matrix entry by index.

bool

emberAfPriceGetBlockThresholdsTableEntry(uint8_t endpoint, uint8_t index, EmberAfScheduledBlockThresholds *bt)

Get the block thresholds used by the Price server plugin.

bool

emberAfPriceGetTariffByIssuerTariffId(uint8_t endpoint, uint32_t issuerTariffId, EmberAfPriceCommonInfo *info, EmberAfScheduledTariff *tariff)

Get a tariff by issuer tariff ID and endpoint.

bool

emberAfPriceGetPriceMatrixByIssuerTariffId(uint8_t endpoint, uint32_t issuerTariffId, EmberAfPriceCommonInfo *info, EmberAfScheduledPriceMatrix *pm)

Get a price matrix by issuer tariff ID and endpoint.

bool

emberAfPriceGetBlockThresholdsByIssuerTariffId(uint8_t endpoint, uint32_t issuerTariffId, EmberAfPriceCommonInfo *info, EmberAfScheduledBlockThresholds *bt)

Get the block thresholds by issuer tariff ID and endpoint.

bool

emberAfPriceSetPriceTableEntry(uint8_t endpoint, uint8_t index, const EmberAfScheduledPrice *price)

Set a price used by the price server plugin.

bool

emberAfPriceSetTariffTableEntry(uint8_t endpoint, uint8_t index, EmberAfPriceCommonInfo *info, const EmberAfScheduledTariff *tariff)

Set a tariff used by the price server plugin.

bool

emberAfPriceSetPriceMatrix(uint8_t endpoint, uint8_t index, EmberAfPriceCommonInfo *info, const EmberAfScheduledPriceMatrix *pm)

Set a price matrix entry by index.

bool

emberAfPriceSetBlockThresholdsTableEntry(uint8_t endpoint, uint8_t index, const EmberAfPriceCommonInfo *info, const EmberAfScheduledBlockThresholds *bt)

Set the block thresholds used by the price server plugin.

bool

emberAfGetCurrentPrice(uint8_t endpoint, EmberAfScheduledPrice *price)

Get the current price used by the price server plugin.

uint8_t

emberAfPriceFindFreePriceIndex(uint8_t endpoint)

Find the first free index in the price table.

void

emberAfPricePrint(const EmberAfScheduledPrice *price)

function to print price

void

emberAfPricePrintPriceTable(uint8_t endpoint)

void

emberAfPricePrintTariff(const EmberAfPriceCommonInfo *info, const EmberAfScheduledTariff *tariff)

void

emberAfPricePrintTariffTable(uint8_t endpoint)

print tarrig table

void

emberAfPricePrintPriceMatrix(uint8_t endpoint, const EmberAfPriceCommonInfo *info, const EmberAfScheduledPriceMatrix *pm)

print price matrix

void

emberAfPricePrintPriceMatrixTable(uint8_t endpoint)

print price matrix table

void

emberAfPricePrintBlockThresholds(uint8_t endpoint, const EmberAfPriceCommonInfo *info, const EmberAfScheduledBlockThresholds *bt)

Print block thresholds.

void

emberAfPricePrintBlockThresholdsTable(uint8_t endpoint)

Print block threshold table.

void

emberAfPluginPriceServerPublishPriceMessage(EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t priceIndex)

Publish price message.

EmberAfStatus

emberAfPluginPriceServerConversionFactorAdd(uint8_t endpoint, uint32_t issuerEventId, uint32_t startTime, uint32_t conversionFactor, uint8_t conversionFactorTrailingDigit)

Set parameters in the conversion factors table.

void

emberAfPluginPriceServerConversionFactorClear(uint8_t endpoint)

Clear the conversion factors table and invalidates all entries.

void

emberAfPluginPriceServerConversionFactorPub(uint8_t tableIndex, EmberNodeId dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Send a Publish Conversion Factor command using data at the specified table index.

uint32_t

emberAfPriceServerSecondsUntilConversionFactorEvent(uint8_t endpoint)

Return the number of seconds until the next conversion factor event becomes active.

void

emberAfPriceServerRefreshConversionFactor(uint8_t endpoint)

Refresh the conversion factor information if necessary. If the second conversion factor event is active, the first is inactivated and the array is re-sorted.

EmberAfStatus

emberAfPluginPriceServerCalorificValueAdd(uint8_t endpoint, uint32_t issuerEventId, uint32_t startTime, uint32_t calorificValue, uint8_t calorificValueUnit, uint8_t calorificValueTrailingDigit)

Set values in the calorific value table.

uint32_t

emberAfPriceServerSecondsUntilCalorificValueEvent(uint8_t endpoint)

Return the number of seconds until the next calorific value event will become active.

void

emberAfPriceServerRefreshCalorificValue(uint8_t endpoint)

Refresh the caloric value information if necessary. If the second calorific value event is active, the first is inactivated and the array is re-sorted.

void

emberAfPluginPriceServerCalorificValueClear(uint8_t endpoint)

Clear the calorific value table and invalidates all entries.

void

emberAfPluginPriceServerPublishTariffMessage(EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t tariffIndex)

Send a publish tariff information command.

void

emberAfPrintConversionTable(uint8_t endpoint)

Print data in the conversion factor table.

void

emberAfPrintCalorificValuesTable(uint8_t endpoint)

Print data in the calorific values table.

uint32_t

emberAfPriceServerSecondsUntilCO2ValueEvent(uint8_t endpoint)

Return the number of seconds until the next CO2 value event becomes active.

void

emberAfPriceServerRefreshCO2Value(uint8_t endpoint)

Refresh the CO2 value information if necessary. If the second CO2 value event is active, the first is inactivated and the array is re-sorted.

void

emberAfPluginPriceServerCo2ValueAdd(uint8_t endpoint, uint32_t issuerEventId, uint32_t startTime, uint32_t providerId, uint8_t tariffType, uint32_t co2Value, uint8_t co2ValueUnit, uint8_t co2ValueTrailingDigit)

Set values in the CO2 value table.

void

emberAfPluginPriceServerCo2ValueClear(uint8_t endpoint)

Clear the CO2 value table and invalidates all entries.

void

emberAfPrintCo2ValuesTable(uint8_t endpoint)

Print data in the CO2 values table.

void

emberAfPluginPriceServerCo2LabelPub(uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)

Send a publish CO2 value command.

void

emberAfPluginPriceServerTierLabelSet(uint8_t endpoint, uint8_t index, uint8_t valid, uint32_t providerId, uint32_t issuerEventId, uint32_t issuerTariffId, uint8_t tierId, uint8_t *tierLabel)

Set values in the tier label table.

void

emberAfPrintPrintTierLabelsTable(void)

Send the next get scheduled prices command.

void

emberAfPluginPriceServerTierLabelAddLabel(uint8_t endpoint, uint32_t issuerTariffId, uint8_t tierId, uint8_t *tierLabel)

Add a tier label to the specified tier label table.

void

emberAfPrintTierLabelsTable(uint8_t endpoint)

Print the tier labels table.

void

emberAfPluginPriceServerTierLabelPub(uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)

Send a publish tier labels command.

uint32_t

emberAfPriceServerSecondsUntilBillingPeriodEvent(uint8_t endpoint)

Return the number of seconds until the next billing period event becomes active.

void

emberAfPriceServerRefreshBillingPeriod(uint8_t endpoint, bool force)

Refresh the billing period information if necessary. If the second billing period event is active, the first is inactivated and the array is re-sorted. If the force argument is set to true, the billing period will be forced to refresh.

EmberStatus

emberAfPluginPriceServerBillingPeriodAdd(uint8_t endpoint, uint32_t startTime, uint32_t issuerEventId, uint32_t providerId, uint32_t billingPeriodDuration, uint8_t billingPeriodDurationType, uint8_t tariffType)

Set values in the billing period table.

void

emberAfPluginPriceServerBillingPeriodPub(uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)

Send a publish billing period command.

void

emberAfPrintBillingPeriodTable(uint8_t endpoint)

Print data in the billing period table for the specified endpoint.

void

emberAfPrintConsolidatedBillTableEntry(uint8_t endpoint, uint8_t index)

Print data in the consolidated bills table at the specified index.

void

emberAfPluginPriceServerConsolidatedBillAdd(uint8_t endpoint, uint32_t startTime, uint32_t issuerEventId, uint32_t providerId, uint32_t billingPeriodDuration, uint8_t billingPeriodDurationType, uint8_t tariffType, uint32_t consolidatedBill, uint16_t currency, uint8_t billTrailingDigit)

Set values in the consolidated bills table.

void

emberAfPluginPriceServerConsolidatedBillPub(uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)

Send a publish consolidated bill command.

void

emberAfPluginPriceServerCppEventSet(uint8_t endpoint, uint8_t valid, uint32_t providerId, uint32_t issuerEventId, uint32_t startTime, uint16_t durationInMinutes, uint8_t tariffType, uint8_t cppPriceTier, uint8_t cppAuth)

Set values of the CPP event.

void

emberAfPluginPriceServerCppEventPub(uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)

Send a publish CPP event command.

void

emberAfPluginPriceServerCppEventPrint(uint8_t endpoint)

Print data in the CPP Event.

void

emberAfPluginPriceServerCreditPaymentPub(uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)

Send a publish credit payment command.

void

emberAfPluginPriceServerCreditPaymentSet(uint8_t endpoint, uint8_t index, uint8_t valid, uint32_t providerId, uint32_t issuerEventId, uint32_t creditPaymentDueDate, uint32_t creditPaymentOverdueAmount, uint8_t creditPaymentStatus, uint32_t creditPayment, uint32_t creditPaymentDate, uint8_t *creditPaymentRef)

Set values in the credit payment table.

void

emberAfPluginPriceServerCurrencyConversionPub(uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)

Send a publish currency conversion command.

void

emberAfPluginPriceServerCurrencyConversionSet(uint8_t endpoint, uint8_t valid, uint32_t providerId, uint32_t issuerEventId, uint32_t startTime, uint16_t oldCurrency, uint16_t newCurrency, uint32_t conversionFactor, uint8_t conversionFactorTrailingDigit, uint32_t currencyChangeControlFlags)

Set values for the currency conversion command.

void

emberAfPluginPriceServerTariffCancellationSet(uint8_t endpoint, uint8_t valid, uint32_t providerId, uint32_t issuerTariffId, uint8_t tariffType)

Set values in the tariff cancellation command.

void

emberAfPluginPriceServerTariffCancellationPub(uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)

Send a cancel tariff command.

uint32_t

emberAfPriceServerSecondsUntilTariffInfoEvent(uint8_t endpoint)

void

emberAfPriceServerRefreshTariffInformation(uint8_t endpoint)

Refresh tarrif information.

bool

emberAfPriceAddTariffTableEntry(uint8_t endpoint, EmberAfPriceCommonInfo *info, const EmberAfScheduledTariff *curTariff)

Add a tarrif table entry.

bool

emberAfPriceAddPriceMatrixRaw(uint8_t endpoint, uint32_t providerId, uint32_t issuerEventId, uint32_t startTime, uint32_t issuerTariffId, uint8_t commandIndex, uint8_t numberOfCommands, uint8_t subPayloadControl, uint8_t *payload)

Add price matrix (raw)

bool

emberAfPriceAddPriceMatrix(uint8_t endpoint, EmberAfPriceCommonInfo *info, EmberAfScheduledPriceMatrix *pm)

Add price matrix.

bool

emberAfPriceAddBlockThresholdsTableEntry(uint8_t endpoint, uint32_t providerId, uint32_t issuerEventId, uint32_t startTime, uint32_t issuerTariffId, uint8_t commandIndex, uint8_t numberOfCommands, uint8_t subpayloadControl, uint8_t *payload)

void

emberAfPriceClearBlockPeriodTable(uint8_t endpoint)

Clean the block period table.

void

sendValidCmdEntries(uint8_t cmdId, uint8_t endpoint, uint8_t *validEntries, uint8_t validEntryCount)

Send the next get scheduled prices command.

void

emberAfPluginPriceServerPriceUpdateBindings(void)

Update bindings.

uint32_t

emberAfPriceServerSecondsUntilActivePriceMatrixEvent(uint8_t endpoint)

get seconds until next active price matrix event

void

emberAfPriceServerRefreshPriceMatrixInformation(uint8_t endpoint)

Refresh price matrix information.

uint32_t

emberAfPriceServerSecondsUntilActiveBlockThresholdsEvent(uint8_t endpoint)

Get seconds until next active block threshold event.

void

emberAfPriceServerRefreshBlockThresholdsInformation(uint8_t endpoint)

Refresh block threshold information.

Typedefs#

typedef uint8_t

emAfPriceBlockThreshold[ZCL_PRICE_CLUSTER_BLOCK_THRESHOLDS_PAYLOAD_SIZE]

Variables#

EmberAfPriceServerInfo

priceServerInfo

Macros#

#define

EMBER_AF_PLUGIN_PRICE_SERVER_PRICE_TABLE_SIZE (5)

#define

EMBER_AF_PLUGIN_PRICE_SERVER_TARIFF_TABLE_SIZE (2)

#define

EMBER_AF_PLUGIN_PRICE_SERVER_BILLING_PERIOD_TABLE_SIZE (2)

#define

EMBER_AF_PLUGIN_PRICE_SERVER_MAX_TIERS_PER_TARIFF (2)

#define

EMBER_AF_PLUGIN_PRICE_SERVER_TIER_LABELS_TABLE_SIZE (2)

#define

EMBER_AF_PLUGIN_PRICE_SERVER_BLOCK_PERIOD_TABLE_SIZE (2)

#define

EMBER_AF_PLUGIN_PRICE_SERVER_CONSOLIDATED_BILL_TABLE_SIZE (5)

#define

EMBER_AF_PLUGIN_PRICE_SERVER_CREDIT_PAYMENT_TABLE_SIZE (5)

#define

EMBER_AF_PLUGIN_PRICE_SERVER_CALORIFIC_VALUE_TABLE_SIZE (2)

#define

EMBER_AF_PLUGIN_PRICE_SERVER_CO2_VALUE_TABLE_SIZE (2)

#define

EMBER_AF_PLUGIN_PRICE_SERVER_CONVERSION_FACTOR_TABLE_SIZE (2)

#define

ZCL_PRICE_CLUSTER_BLOCK_THRESHOLDS_PAYLOAD_SIZE (6u)

#define

ZCL_PRICE_CLUSTER_PRICE_MATRIX_SUBPAYLOAD_BLOCK_SIZE (5u)

#define

fieldLength (field)

#define

ZCL_PRICE_CLUSTER_MAX_TOU_BLOCKS (15u)

#define

ZCL_PRICE_CLUSTER_MAX_TOU_BLOCK_TIERS (15u)

#define

ZCL_PRICE_CLUSTER_MAX_TOU_TIERS (48u)

#define

ZCL_PRICE_CLUSTER_PRICE_MATRIX_SUB_PAYLOAD_ENTRY_SIZE (5u)

#define

CURRENT BIT(1)

#define

FUTURE BIT(2)

#define

PUBLISHED BIT(3)

#define

TARIFF_TYPE_MASK (0x0Fu)

#define

CHARGING_SCHEME_MASK (0xF0u)

#define

tariffIsCurrent (tariff)

#define

tariffIsFuture (tariff)

#define

tariffIsPublished (tariff)

#define

priceMatrixIsCurrent (pm)

#define

priceMatrixIsFuture (pm)

#define

priceMatrixIsPublished (pm)

#define

blockThresholdsIsCurrent (bt)

#define

blockThresholdsIsFuture (bt)

#define

blockThresholdsIsPublished (bt)

#define

CREDIT_PAYMENT_REF_STRING_LEN (20u)

#define

TIER_LABEL_SIZE (12u)

API Documentation#

emberAfPriceServerSendGetScheduledPrices#

void emberAfPriceServerSendGetScheduledPrices (uint8_t endpoint)

Send the next get scheduled prices command.

Parameters

N/A

endpoint

The endpoint in question.

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

emberAfPriceServerSecondsUntilGetScheduledPricesEvent#

uint32_t emberAfPriceServerSecondsUntilGetScheduledPricesEvent (void )

Return the number of seconds until the next get scheduled prices command should be sent.

Parameters

N/A

Returns

The number of seconds until the next get scheduled prices command should be sent.

Definition at line 388 of file app/framework/plugin/price-server/price-server.h

emberAfPriceClearPriceTable#

void emberAfPriceClearPriceTable (uint8_t endpoint)

Clear all prices in the price table.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 395 of file app/framework/plugin/price-server/price-server.h

emberAfPriceClearTariffTable#

void emberAfPriceClearTariffTable (uint8_t endpoint)

Clear all tariffs in the tariff table.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 402 of file app/framework/plugin/price-server/price-server.h

emberAfPriceClearPriceMatrixTable#

void emberAfPriceClearPriceMatrixTable (uint8_t endpoint)

Clear all price matrices in the price matrix table.

Parameters

N/A

endpoint

The endpoint in question.

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

emberAfPriceClearBlockThresholdsTable#

void emberAfPriceClearBlockThresholdsTable (uint8_t endpoint)

Clear all block thresholds in the block thresholds table.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 416 of file app/framework/plugin/price-server/price-server.h

emberAfPriceGetPriceTableEntry#

bool emberAfPriceGetPriceTableEntry (uint8_t endpoint, uint8_t index, EmberAfScheduledPrice * price)

Get a price used by the price server plugin.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	index	The index in the price table.
N/A	price	The EmberAfScheduledPrice structure describing the price.

This function gets a price and metadata that the plugin will send to clients. For "start now" prices that are current or scheduled, the duration is adjusted to reflect how many minutes remain for the price. Otherwise, the start time and duration of "start now" prices reflect the actual start and the original duration.

Returns

True if the price was found or false is the index is invalid.

Definition at line 432 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerBlockPeriodAdd#

void emberAfPluginPriceServerBlockPeriodAdd (uint8_t endpoint, uint32_t providerId, uint32_t issuerEventId, uint32_t blockPeriodStartTime, uint32_t blockPeriodDuration, uint8_t blockPeriodControl, uint8_t blockPeriodDurationType, uint32_t thresholdMultiplier, uint32_t thresholdDivisor, uint8_t tariffType, uint8_t tariffResolutionPeriod)

Set values in the block period table.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	providerId	A unique identifier for the commodity provider.
N/A	issuerEventId	The event ID of the block period data.
N/A	blockPeriodStartTime	Time at which the block period data is valid.
N/A	blockPeriodDuration	The block period duration. Units are specified by the blockPeriodDurationType.
N/A	blockPeriodControl	Identifies additional control options for the block period command.
N/A	blockPeriodDurationType	A bitmap that indicates the units used in the block period.
N/A	thresholdMultiplier	A bitmap identifying the type of tariff published in this command.
N/A	thresholdDivisor	The resolution period for the block tariff.
N/A	tariffType
N/A	tariffResolutionPeriod

Definition at line 450 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerBlockPeriodPub#

void emberAfPluginPriceServerBlockPeriodPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)

Send a publish block period command.

Parameters

N/A	nodeId	The destination address to which the command should be sent.
N/A	srcEndpoint	The source endpoint used in the transmission.
N/A	dstEndpoint	The destination endpoint used in the transmission.
N/A	index	The index of the table whose data will be used in the command.

Definition at line 465 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerBlockPeriodPrint#

void emberAfPluginPriceServerBlockPeriodPrint (uint8_t endpoint, uint8_t index)

Print data in the specified index of the block period table.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	index	The index of the table whose index will be printed.

Definition at line 474 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerSecondsUntilBlockPeriodEvent#

uint32_t emberAfPriceServerSecondsUntilBlockPeriodEvent (uint8_t endpoint)

Return the number of seconds until the next block period event occurs.

Parameters

N/A

endpoint

The relevant endpoint.

Returns

Returns the number of seconds until the next block period event.

Definition at line 483 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerRefreshBlockPeriod#

void emberAfPriceServerRefreshBlockPeriod (uint8_t endpoint, bool repeat)

Update block period attributes to match the current block period.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	repeat	Indicates whether or not to try to repeat the current block period in the next block period. This is also controlled by a bit in the blockPeriodControl, saying whether or not the block period should repeat on expiry.

Definition at line 494 of file app/framework/plugin/price-server/price-server.h

emberAfPriceGetTariffTableEntry#

bool emberAfPriceGetTariffTableEntry (uint8_t endpoint, uint8_t index, EmberAfPriceCommonInfo * info, EmberAfScheduledTariff * tariff)

Get a tariff used by the price server plugin.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	index	The index in the tariff table.
N/A	info	The EmberAfPriceCommonInfo structure describing the tariff.
N/A	tariff	The EmberAfScheduledTariff structure describing the tariff.

This function gets a tariff and associated metadata that the plugin will send to clients.

Returns

True if the tariff was found.

Definition at line 508 of file app/framework/plugin/price-server/price-server.h

emberAfPriceGetPriceMatrix#

bool emberAfPriceGetPriceMatrix (uint8_t endpoint, uint8_t index, EmberAfPriceCommonInfo * info, EmberAfScheduledPriceMatrix * pm)

Retrieve a price matrix entry by index.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	index	The index in the price matrix table.
N/A	info	The EmberAfScheduledPriceMatrix structure describing the price matrix.
N/A	pm

This function gets a price matrix and associated metadata that the plugin will send to clients.

Returns

True if the price matrix was found.

Definition at line 524 of file app/framework/plugin/price-server/price-server.h

emberAfPriceGetBlockThresholdsTableEntry#

bool emberAfPriceGetBlockThresholdsTableEntry (uint8_t endpoint, uint8_t index, EmberAfScheduledBlockThresholds * bt)

Get the block thresholds used by the Price server plugin.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	index	The index in the block thresholds table.
N/A	bt	The EmberAfScheduledBlockThresholds structure describing the block thresholds.

This function gets the block thresholds and associated metadata that the plugin will send to clients.

Returns

True if the block thresholds was found.

Definition at line 540 of file app/framework/plugin/price-server/price-server.h

emberAfPriceGetTariffByIssuerTariffId#

bool emberAfPriceGetTariffByIssuerTariffId (uint8_t endpoint, uint32_t issuerTariffId, EmberAfPriceCommonInfo * info, EmberAfScheduledTariff * tariff)

Get a tariff by issuer tariff ID and endpoint.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	issuerTariffId	The issuer tariff ID.
N/A	info	The EmberAfPriceCommonInfo structure describing the tariff.
N/A	tariff	The EmberAfScheduledTariff structure describing the tariff.

Returns

True if the tariff was found.

Definition at line 553 of file app/framework/plugin/price-server/price-server.h

emberAfPriceGetPriceMatrixByIssuerTariffId#

bool emberAfPriceGetPriceMatrixByIssuerTariffId (uint8_t endpoint, uint32_t issuerTariffId, EmberAfPriceCommonInfo * info, EmberAfScheduledPriceMatrix * pm)

Get a price matrix by issuer tariff ID and endpoint.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	issuerTariffId	The issuer tariff ID.
N/A	info	The EmberAfScheduledPriceMatrix structure describing the price matrix.
N/A	pm

Returns

True if the price matrix was found.

Definition at line 566 of file app/framework/plugin/price-server/price-server.h

emberAfPriceGetBlockThresholdsByIssuerTariffId#

bool emberAfPriceGetBlockThresholdsByIssuerTariffId (uint8_t endpoint, uint32_t issuerTariffId, EmberAfPriceCommonInfo * info, EmberAfScheduledBlockThresholds * bt)

Get the block thresholds by issuer tariff ID and endpoint.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	issuerTariffId	The issuer tariff ID.
N/A	info	The EmberAfScheduledBlockThresholds structure describing the block thresholds.
N/A	bt

Returns

True if the block thresholds were found.

Definition at line 579 of file app/framework/plugin/price-server/price-server.h

emberAfPriceSetPriceTableEntry#

bool emberAfPriceSetPriceTableEntry (uint8_t endpoint, uint8_t index, const EmberAfScheduledPrice * price)

Set a price used by the price server plugin.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	index	The index in the price table.
N/A	price	The EmberAfScheduledPrice structure describing the price. If NULL, the price is removed from the server.

This function sets a price and metadata that the plugin will send to clients. Setting the start time to zero instructs clients to start the price now. For "start now" prices, the plugin will automatically adjust the duration reported to clients based on the original start time of the price.

Returns

True if the price was set or removed or false is the index is invalid.

Definition at line 599 of file app/framework/plugin/price-server/price-server.h

emberAfPriceSetTariffTableEntry#

bool emberAfPriceSetTariffTableEntry (uint8_t endpoint, uint8_t index, EmberAfPriceCommonInfo * info, const EmberAfScheduledTariff * tariff)

Set a tariff used by the price server plugin.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	index	The index in the tariff table.
N/A	info	The EmberAfScheduledTariff structure describing the tariff. If NULL, the tariff is removed from the server.
N/A	tariff

This function sets a tariff and metadata that the plugin will send to clients.

Returns

True if the tariff was set or removed, or false if the index is invalid.

Definition at line 616 of file app/framework/plugin/price-server/price-server.h

emberAfPriceSetPriceMatrix#

bool emberAfPriceSetPriceMatrix (uint8_t endpoint, uint8_t index, EmberAfPriceCommonInfo * info, const EmberAfScheduledPriceMatrix * pm)

Set a price matrix entry by index.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	index	The index in the price matrix table.
N/A	info	The EmberAfScheduledPriceMatrix structure describing the price matrix. If NULL, the price matrix is removed from the server.
N/A	pm

This function sets a price matrix and metadata that the plugin will send to clients.

Returns

True if the price matrix was set or removed, or false if the index is invalid.

Definition at line 635 of file app/framework/plugin/price-server/price-server.h

emberAfPriceSetBlockThresholdsTableEntry#

bool emberAfPriceSetBlockThresholdsTableEntry (uint8_t endpoint, uint8_t index, const EmberAfPriceCommonInfo * info, const EmberAfScheduledBlockThresholds * bt)

Set the block thresholds used by the price server plugin.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	index	The index in the block thresholds table.
N/A	info	The EmberAfScheduledBlockThresholds structure describing the block thresholds. If NULL, the block thresholds entry is removed from the table.
N/A	bt

This function sets the block thresholds and metadata that the plugin will send to clients.

Returns

True if the block thresholds was set or removed, or false if the index is invalid.

Definition at line 654 of file app/framework/plugin/price-server/price-server.h

emberAfGetCurrentPrice#

bool emberAfGetCurrentPrice (uint8_t endpoint, EmberAfScheduledPrice * price)

Get the current price used by the price server plugin.

Parameters

N/A	endpoint	The relevant endpoint.
N/A	price	The EmberAfScheduledPrice structure describing the price.

This function gets the current price and metadata that the plugin will send to clients. For "start now" prices, the duration is adjusted to reflect how many minutes remain for the price. Otherwise, the start time and duration reflect the actual start and the original duration.

Returns

True if the current price was found or false is there is no current price.

Definition at line 672 of file app/framework/plugin/price-server/price-server.h

emberAfPriceFindFreePriceIndex#

uint8_t emberAfPriceFindFreePriceIndex (uint8_t endpoint)

Find the first free index in the price table.

Parameters

N/A

endpoint

The relevant endpoint.

This function looks through the price table and determines whether the entry is in-use or scheduled to be in use. If not, it's considered "free" for the purposes of the user adding a new price entry to the server's table and the index is returned.

Returns

The index of the first free (unused/unscheduled) entry in the requested endpoint's price table, or ZCL_PRICE_INVALID_INDEX if no available entry could be found.

Definition at line 687 of file app/framework/plugin/price-server/price-server.h

emberAfPricePrint#

void emberAfPricePrint (const EmberAfScheduledPrice * price)

function to print price

Parameters

N/A price

Definition at line 693 of file app/framework/plugin/price-server/price-server.h

emberAfPricePrintPriceTable#

void emberAfPricePrintPriceTable (uint8_t endpoint)

Parameters

N/A

endpoint

relevant endpoint

Print the price table

Definition at line 700 of file app/framework/plugin/price-server/price-server.h

emberAfPricePrintTariff#

void emberAfPricePrintTariff (const EmberAfPriceCommonInfo * info, const EmberAfScheduledTariff * tariff)

Parameters

N/A	info	pointer to the common info struct
N/A	tariff	pointer to the scheduled tarrif struct

Print tarrif

Definition at line 708 of file app/framework/plugin/price-server/price-server.h

emberAfPricePrintTariffTable#

void emberAfPricePrintTariffTable (uint8_t endpoint)

print tarrig table

Parameters

N/A

endpoint

relevant endpoint

Definition at line 716 of file app/framework/plugin/price-server/price-server.h

emberAfPricePrintPriceMatrix#

void emberAfPricePrintPriceMatrix (uint8_t endpoint, const EmberAfPriceCommonInfo * info, const EmberAfScheduledPriceMatrix * pm)

print price matrix

Parameters

N/A	endpoint	relevant endpoint
N/A	info	pointer to common info struct
N/A	pm	pointer to scheduled price matrix struct

Definition at line 725 of file app/framework/plugin/price-server/price-server.h

emberAfPricePrintPriceMatrixTable#

void emberAfPricePrintPriceMatrixTable (uint8_t endpoint)

print price matrix table

Parameters

N/A

endpoint

relevant endpoint

Definition at line 734 of file app/framework/plugin/price-server/price-server.h

emberAfPricePrintBlockThresholds#

void emberAfPricePrintBlockThresholds (uint8_t endpoint, const EmberAfPriceCommonInfo * info, const EmberAfScheduledBlockThresholds * bt)

Print block thresholds.

Parameters

N/A	endpoint	relevant endpoint
N/A	info	pointer to common info struct
N/A	bt	pointer to block threshold struct

Definition at line 743 of file app/framework/plugin/price-server/price-server.h

emberAfPricePrintBlockThresholdsTable#

void emberAfPricePrintBlockThresholdsTable (uint8_t endpoint)

Print block threshold table.

Parameters

N/A

endpoint

relevent endpoint

Definition at line 752 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerPublishPriceMessage#

void emberAfPluginPriceServerPublishPriceMessage (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t priceIndex)

Publish price message.

Parameters

N/A	nodeId
N/A	srcEndpoint
N/A	dstEndpoint
N/A	priceIndex

Definition at line 762 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerConversionFactorAdd#

EmberAfStatus emberAfPluginPriceServerConversionFactorAdd (uint8_t endpoint, uint32_t issuerEventId, uint32_t startTime, uint32_t conversionFactor, uint8_t conversionFactorTrailingDigit)

Set parameters in the conversion factors table.

Parameters

N/A	endpoint	The endpoint in question.
N/A	issuerEventId	The event ID of the conversion factor data.
N/A	startTime	The time when the conversion factor data is valid.
N/A	conversionFactor	Accounts for changes in the volume of gas based on temperature and pressure.
N/A	conversionFactorTrailingDigit	Determines where the decimal point is located in the conversion factor.

Definition at line 778 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerConversionFactorClear#

void emberAfPluginPriceServerConversionFactorClear (uint8_t endpoint)

Clear the conversion factors table and invalidates all entries.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 789 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerConversionFactorPub#

void emberAfPluginPriceServerConversionFactorPub (uint8_t tableIndex, EmberNodeId dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Send a Publish Conversion Factor command using data at the specified table index.

Parameters

N/A	tableIndex	The index of the conversion factor table whose data should be used in the publish conversion factor command.
N/A	dstAddr	The destination address to which the command should be sent.
N/A	srcEndpoint	The source endpoint used in the transmission.
N/A	dstEndpoint	The destination endpoint used in the transmission.

Definition at line 802 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerSecondsUntilConversionFactorEvent#

uint32_t emberAfPriceServerSecondsUntilConversionFactorEvent (uint8_t endpoint)

Return the number of seconds until the next conversion factor event becomes active.

Parameters

N/A

endpoint

The endpoint in question

Returns

The number of seconds until the next conversion factor event becomes active.

Definition at line 816 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerRefreshConversionFactor#

void emberAfPriceServerRefreshConversionFactor (uint8_t endpoint)

Refresh the conversion factor information if necessary. If the second conversion factor event is active, the first is inactivated and the array is re-sorted.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 826 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerCalorificValueAdd#

EmberAfStatus emberAfPluginPriceServerCalorificValueAdd (uint8_t endpoint, uint32_t issuerEventId, uint32_t startTime, uint32_t calorificValue, uint8_t calorificValueUnit, uint8_t calorificValueTrailingDigit)

Set values in the calorific value table.

Parameters

N/A	endpoint	The endpoint in question @issuerEventId The event ID of the calorific value data. @startTime The time at which the calorific value data is valid. @calorificValue The amount of heat generated when a given mass of fuel is burned. @calorificValueTrailingDigit Determines where the decimal point is located in the calorific value.
N/A	issuerEventId
N/A	startTime
N/A	calorificValue
N/A	calorificValueUnit
N/A	calorificValueTrailingDigit

Definition at line 840 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerSecondsUntilCalorificValueEvent#

uint32_t emberAfPriceServerSecondsUntilCalorificValueEvent (uint8_t endpoint)

Return the number of seconds until the next calorific value event will become active.

Parameters

N/A

endpoint

The endpoint in question

Returns

The number of seconds until the next calorific value event becomes active.

Definition at line 854 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerRefreshCalorificValue#

void emberAfPriceServerRefreshCalorificValue (uint8_t endpoint)

Refresh the caloric value information if necessary. If the second calorific value event is active, the first is inactivated and the array is re-sorted.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 864 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerCalorificValueClear#

void emberAfPluginPriceServerCalorificValueClear (uint8_t endpoint)

Clear the calorific value table and invalidates all entries.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 872 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerPublishTariffMessage#

void emberAfPluginPriceServerPublishTariffMessage (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t tariffIndex)

Send a publish tariff information command.

Parameters

N/A	nodeId	The destination address to which the command should be sent.
N/A	srcEndpoint	The source endpoint used in the transmission.
N/A	dstEndpoint	The destination endpoint used in the transmission.
N/A	tariffIndex	The index of the tariff table whose data will be used in the Publish Tariff Information command.

Definition at line 884 of file app/framework/plugin/price-server/price-server.h

emberAfPrintConversionTable#

void emberAfPrintConversionTable (uint8_t endpoint)

Print data in the conversion factor table.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 895 of file app/framework/plugin/price-server/price-server.h

emberAfPrintCalorificValuesTable#

void emberAfPrintCalorificValuesTable (uint8_t endpoint)

Print data in the calorific values table.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 903 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerSecondsUntilCO2ValueEvent#

uint32_t emberAfPriceServerSecondsUntilCO2ValueEvent (uint8_t endpoint)

Return the number of seconds until the next CO2 value event becomes active.

Parameters

N/A

endpoint

The endpoint in question.

Returns

The number of seconds until the next CO2 value event becomes active.

Definition at line 913 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerRefreshCO2Value#

void emberAfPriceServerRefreshCO2Value (uint8_t endpoint)

Refresh the CO2 value information if necessary. If the second CO2 value event is active, the first is inactivated and the array is re-sorted.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 923 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerCo2ValueAdd#

void emberAfPluginPriceServerCo2ValueAdd (uint8_t endpoint, uint32_t issuerEventId, uint32_t startTime, uint32_t providerId, uint8_t tariffType, uint32_t co2Value, uint8_t co2ValueUnit, uint8_t co2ValueTrailingDigit)

Set values in the CO2 value table.

Parameters

N/A	endpoint	The endpoint in question.
N/A	issuerEventId	The event ID of the CO2 value table data.
N/A	startTime	The time at which the CO2 value data is valid.
N/A	providerId	A unique identifier for the commodity provider.
N/A	tariffType	Bitmap identifying the type of tariff published in this command.
N/A	co2Value	Used to calculate the amount of carbon dioxide produced from energy use.
N/A	co2ValueUnit	An enumeration which defines the unit of the co2Value attribute.
N/A	co2ValueTrailingDigit	Determines where the decimal point is located in the co2Value.

Definition at line 942 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerCo2ValueClear#

void emberAfPluginPriceServerCo2ValueClear (uint8_t endpoint)

Clear the CO2 value table and invalidates all entries.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 957 of file app/framework/plugin/price-server/price-server.h

emberAfPrintCo2ValuesTable#

void emberAfPrintCo2ValuesTable (uint8_t endpoint)

Print data in the CO2 values table.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 965 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerCo2LabelPub#

void emberAfPluginPriceServerCo2LabelPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)

Send a publish CO2 value command.

Parameters

N/A	nodeId	The destination address to which the command should be sent.
N/A	srcEndpoint	The source endpoint used in the transmission.
N/A	dstEndpoint	The destination endpoint used in the transmission.
N/A	index	The index of the CO2 values table whose data will be used in the command.

Definition at line 976 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerTierLabelSet#

void emberAfPluginPriceServerTierLabelSet (uint8_t endpoint, uint8_t index, uint8_t valid, uint32_t providerId, uint32_t issuerEventId, uint32_t issuerTariffId, uint8_t tierId, uint8_t * tierLabel)

Set values in the tier label table.

Parameters

N/A	endpoint	The endpoint in question.
N/A	index	The index of the billing period table whose data will be modified.
N/A	valid	Indicates if data at this index is valid or not.
N/A	providerId	A unique identifier for the commodity provider.
N/A	issuerEventId	The event ID of the tier labels table data.
N/A	issuerTariffId	A unique identifier that identifies which tariff the labels apply to.
N/A	tierId	The tier number that associated tier label applies to.
N/A	tierLabel	A character string descriptor for this tier.

Definition at line 994 of file app/framework/plugin/price-server/price-server.h

emberAfPrintPrintTierLabelsTable#

void emberAfPrintPrintTierLabelsTable (void )

Send the next get scheduled prices command.

Parameters

N/A

The endpoint in question.

Definition at line 1002 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerTierLabelAddLabel#

void emberAfPluginPriceServerTierLabelAddLabel (uint8_t endpoint, uint32_t issuerTariffId, uint8_t tierId, uint8_t * tierLabel)

Add a tier label to the specified tier label table.

Parameters

N/A	endpoint	The endpoint in question.
N/A	issuerTariffId	A unique identifier that identifies which tariff the labels apply to.
N/A	tierId	The tier number that associated tier label applies to.
N/A	tierLabel	Character string descriptor for this tier.

Definition at line 1013 of file app/framework/plugin/price-server/price-server.h

emberAfPrintTierLabelsTable#

void emberAfPrintTierLabelsTable (uint8_t endpoint)

Print the tier labels table.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 1024 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerTierLabelPub#

void emberAfPluginPriceServerTierLabelPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)

Send a publish tier labels command.

Parameters

N/A	nodeId	The destination address to which the command should be sent.
N/A	srcEndpoint	The source endpoint used in the transmission.
N/A	dstEndpoint	The destination endpoint used in the transmission.
N/A	index	The index of the tier labels table whose data will be used in the Publish Tier Labels command.

Definition at line 1036 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerSecondsUntilBillingPeriodEvent#

uint32_t emberAfPriceServerSecondsUntilBillingPeriodEvent (uint8_t endpoint)

Return the number of seconds until the next billing period event becomes active.

Parameters

N/A

endpoint

The endpoint in question.

Returns

The number of seconds until the next billing period event becomes active.

Definition at line 1046 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerRefreshBillingPeriod#

void emberAfPriceServerRefreshBillingPeriod (uint8_t endpoint, bool force)

Parameters

N/A	endpoint	The endpoint in question.
N/A	force	Whether or not the billing period should be forced to refresh.

Definition at line 1058 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerBillingPeriodAdd#

EmberStatus emberAfPluginPriceServerBillingPeriodAdd (uint8_t endpoint, uint32_t startTime, uint32_t issuerEventId, uint32_t providerId, uint32_t billingPeriodDuration, uint8_t billingPeriodDurationType, uint8_t tariffType)

Set values in the billing period table.

Parameters

N/A	endpoint	The endpoint in question.
N/A	startTime	The time at which the billing period data is valid.
N/A	issuerEventId	The event ID of the billing period data.
N/A	providerId	A unique identifier for the commodity provider.
N/A	billingPeriodDuration	The billing period duration. Units are specified by the billingPeriodDurationType.
N/A	billingPeriodDurationType	A bitmap that indicates the units used in the billing period.
N/A	tariffType	Bitmap identifying the type of tariff published in this command.

Definition at line 1074 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerBillingPeriodPub#

void emberAfPluginPriceServerBillingPeriodPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)

Send a publish billing period command.

Parameters

N/A	nodeId	The destination address to which the command should be sent.
N/A	srcEndpoint	The source endpoint used in the transmission.
N/A	dstEndpoint	The destination endpoint used in the transmission.
N/A	index	The index of the table whose data will be used in the command.

Definition at line 1090 of file app/framework/plugin/price-server/price-server.h

emberAfPrintBillingPeriodTable#

void emberAfPrintBillingPeriodTable (uint8_t endpoint)

Print data in the billing period table for the specified endpoint.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 1099 of file app/framework/plugin/price-server/price-server.h

emberAfPrintConsolidatedBillTableEntry#

void emberAfPrintConsolidatedBillTableEntry (uint8_t endpoint, uint8_t index)

Print data in the consolidated bills table at the specified index.

Parameters

N/A	endpoint	The endpoint in question.
N/A	index	The index of the consolidated bills table whose data should be printed.

Definition at line 1108 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerConsolidatedBillAdd#

void emberAfPluginPriceServerConsolidatedBillAdd (uint8_t endpoint, uint32_t startTime, uint32_t issuerEventId, uint32_t providerId, uint32_t billingPeriodDuration, uint8_t billingPeriodDurationType, uint8_t tariffType, uint32_t consolidatedBill, uint16_t currency, uint8_t billTrailingDigit)

Set values in the consolidated bills table.

Parameters

N/A	endpoint	The endpoint in question.
N/A	startTime	The time at which the consolidated bills data is valid.
N/A	issuerEventId	The event ID of the consolidated bills data.
N/A	providerId	A unique identifier for the commodity provider.
N/A	billingPeriodDuration	The billing period duration. Units are specified by the billingPeriodDurationType.
N/A	billingPeriodDurationType	A bitmap that indicates the units used in the billing period.
N/A	tariffType	Bitmap identifying the type of tariff published in this command.
N/A	consolidatedBill	The consolidated bill value for the specified billing period.
N/A	currency	The currency used in the consolidatedBill field.
N/A	billTrailingDigit	Determines where the decimal point is located in the consolidatedBill field.

Definition at line 1127 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerConsolidatedBillPub#

void emberAfPluginPriceServerConsolidatedBillPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)

Send a publish consolidated bill command.

Parameters

N/A	nodeId	The destination address to which the command should be sent.
N/A	srcEndpoint	The source endpoint used in the transmission.
N/A	dstEndpoint	The destination endpoint used in the transmission.
N/A	index	The index of the table whose data will be used in the command.

Definition at line 1142 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerCppEventSet#

void emberAfPluginPriceServerCppEventSet (uint8_t endpoint, uint8_t valid, uint32_t providerId, uint32_t issuerEventId, uint32_t startTime, uint16_t durationInMinutes, uint8_t tariffType, uint8_t cppPriceTier, uint8_t cppAuth)

Set values of the CPP event.

Parameters

N/A	endpoint	The endpoint in question.
N/A	valid	Indicates if the CPP Event data is valid or not.
N/A	providerId	A unique identifier for the commodity provider.
N/A	issuerEventId	The event ID of the CPP Event.
N/A	startTime	The time at which the CPP Event data is valid.
N/A	durationInMinutes	Defines the duration of the CPP Event.
N/A	tariffType	Bitmap identifying the type of tariff published in this command.
N/A	cppPriceTier	Indicates which CPP price tier should be used for the event.
N/A	cppAuth	The status of the CPP event.

Definition at line 1158 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerCppEventPub#

void emberAfPluginPriceServerCppEventPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)

Send a publish CPP event command.

Parameters

N/A	nodeId	The destination address to which the command should be sent.
N/A	srcEndpoint	The source endpoint used in the transmission.
N/A	dstEndpoint	The destination endpoint used in the transmission.

Definition at line 1169 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerCppEventPrint#

void emberAfPluginPriceServerCppEventPrint (uint8_t endpoint)

Print data in the CPP Event.

Parameters

N/A

endpoint

The endpoint in question.

Definition at line 1177 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerCreditPaymentPub#

void emberAfPluginPriceServerCreditPaymentPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)

Send a publish credit payment command.

Parameters

N/A	nodeId	The destination address to which the command should be sent.
N/A	srcEndpoint	The source endpoint used in the transmission.
N/A	dstEndpoint	The destination endpoint used in the transmission.
N/A	index	The index of the table whose data will be used in the command.

Definition at line 1188 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerCreditPaymentSet#

void emberAfPluginPriceServerCreditPaymentSet (uint8_t endpoint, uint8_t index, uint8_t valid, uint32_t providerId, uint32_t issuerEventId, uint32_t creditPaymentDueDate, uint32_t creditPaymentOverdueAmount, uint8_t creditPaymentStatus, uint32_t creditPayment, uint32_t creditPaymentDate, uint8_t * creditPaymentRef)

Set values in the credit payment table.

Parameters

N/A	endpoint	The endpoint in question.
N/A	index	The index of the credit payment table whose data will be modified.
N/A	valid	Indicates if data at this index is valid or not.
N/A	providerId	A unique identifier for the commodity provider.
N/A	issuerEventId	The event ID of the credit payment data.
N/A	creditPaymentDueDate	The time the next credit payment is due.
N/A	creditPaymentOverdueAmount	The current amount that is overdue from the customer.
N/A	creditPaymentStatus	Indicates the current credit payment status.
N/A	creditPayment	The amount of the last credit payment.
N/A	creditPaymentDate	The time at which the last credit payment was made.
N/A	creditPaymentRef	A string used to denote the last credit payment reference used by the energy supplier.

Definition at line 1207 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerCurrencyConversionPub#

void emberAfPluginPriceServerCurrencyConversionPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)

Send a publish currency conversion command.

Parameters

N/A	nodeId	The destination address to which the command should be sent.
N/A	srcEndpoint	The source endpoint used in the transmission.
N/A	dstEndpoint	The destination endpoint used in the transmission.

Definition at line 1223 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerCurrencyConversionSet#

void emberAfPluginPriceServerCurrencyConversionSet (uint8_t endpoint, uint8_t valid, uint32_t providerId, uint32_t issuerEventId, uint32_t startTime, uint16_t oldCurrency, uint16_t newCurrency, uint32_t conversionFactor, uint8_t conversionFactorTrailingDigit, uint32_t currencyChangeControlFlags)

Set values for the currency conversion command.

Parameters

N/A	endpoint	The endpoint in question.
N/A	valid	Indicates if the currency conversion data is valid or not.
N/A	providerId	A unique identifier for the commodity provider.
N/A	issuerEventId	The event ID of the currency conversion data.
N/A	startTime	The time at which the currency conversion data is valid.
N/A	oldCurrency	Information about the old unit of currency.
N/A	newCurrency	Information about the new unit of currency.
N/A	conversionFactor	Accounts for changes in the volume of gas based on temperature and pressure.
N/A	conversionFactorTrailingDigit	Determines where the decimal point is located in the conversion factor.
N/A	currencyChangeControlFlags	Denotes functions that are required to be carried out by the client.

Definition at line 1240 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerTariffCancellationSet#

void emberAfPluginPriceServerTariffCancellationSet (uint8_t endpoint, uint8_t valid, uint32_t providerId, uint32_t issuerTariffId, uint8_t tariffType)

Set values in the tariff cancellation command.

Parameters

N/A	endpoint	The endpoint in question.
N/A	valid	Indicates if the tariff cancellation command is valid or not.
N/A	providerId	A unique identifier for the commodity provider.
N/A	issuerTariffId	Unique identifier that identifies which tariff should be canceled.
N/A	tariffType	A bitmap identifying the type of tariff to be canceled.

Definition at line 1256 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerTariffCancellationPub#

void emberAfPluginPriceServerTariffCancellationPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)

Send a cancel tariff command.

Parameters

N/A	nodeId	The destination address to which the command should be sent.
N/A	srcEndpoint	The source endpoint used in the transmission.
N/A	dstEndpoint	The destination endpoint used in the transmission.

Definition at line 1267 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerSecondsUntilTariffInfoEvent#

uint32_t emberAfPriceServerSecondsUntilTariffInfoEvent (uint8_t endpoint)

Parameters

N/A

endpoint

relevant endpoint

Get seconds until the next tarrif info event

Returns

unit32_t seconds until next tarrif info event

Definition at line 1276 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerRefreshTariffInformation#

void emberAfPriceServerRefreshTariffInformation (uint8_t endpoint)

Refresh tarrif information.

Parameters

N/A

endpoint

relevant endpoint

Definition at line 1283 of file app/framework/plugin/price-server/price-server.h

emberAfPriceAddTariffTableEntry#

bool emberAfPriceAddTariffTableEntry (uint8_t endpoint, EmberAfPriceCommonInfo * info, const EmberAfScheduledTariff * curTariff)

Add a tarrif table entry.

Parameters

N/A	endpoint	relevant endpoint
N/A	info	pointer to common info struct
N/A	curTariff	pointer to scheduled tarrif struct

Returns

bool true is success

Definition at line 1294 of file app/framework/plugin/price-server/price-server.h

emberAfPriceAddPriceMatrixRaw#

bool emberAfPriceAddPriceMatrixRaw (uint8_t endpoint, uint32_t providerId, uint32_t issuerEventId, uint32_t startTime, uint32_t issuerTariffId, uint8_t commandIndex, uint8_t numberOfCommands, uint8_t subPayloadControl, uint8_t * payload)

Add price matrix (raw)

Parameters

N/A	endpoint	relevant endpoint
N/A	providerId
N/A	issuerEventId
N/A	startTime
N/A	issuerTariffId
N/A	commandIndex
N/A	numberOfCommands
N/A	subPayloadControl
N/A	payload

Returns

bool true is success

Definition at line 1311 of file app/framework/plugin/price-server/price-server.h

emberAfPriceAddPriceMatrix#

bool emberAfPriceAddPriceMatrix (uint8_t endpoint, EmberAfPriceCommonInfo * info, EmberAfScheduledPriceMatrix * pm)

Add price matrix.

Parameters

N/A	endpoint	relevant endpoint
N/A	info	pointer to the common info struct
N/A	pm	pointer to the scheduled price matrix struct

Returns

bool true is success

Definition at line 1330 of file app/framework/plugin/price-server/price-server.h

emberAfPriceAddBlockThresholdsTableEntry#

bool emberAfPriceAddBlockThresholdsTableEntry (uint8_t endpoint, uint32_t providerId, uint32_t issuerEventId, uint32_t startTime, uint32_t issuerTariffId, uint8_t commandIndex, uint8_t numberOfCommands, uint8_t subpayloadControl, uint8_t * payload)

Parameters

N/A	endpoint	relevant endpoint
N/A	providerId
N/A	issuerEventId
N/A	startTime
N/A	issuerTariffId
N/A	commandIndex
N/A	numberOfCommands
N/A	subpayloadControl
N/A	payload

Add a table entry for block threshold table

Returns

bool true is success

Definition at line 1347 of file app/framework/plugin/price-server/price-server.h

emberAfPriceClearBlockPeriodTable#

void emberAfPriceClearBlockPeriodTable (uint8_t endpoint)

Clean the block period table.

Parameters

N/A

endpoint

relevant endpoint

Definition at line 1362 of file app/framework/plugin/price-server/price-server.h

sendValidCmdEntries#

void sendValidCmdEntries (uint8_t cmdId, uint8_t endpoint, uint8_t * validEntries, uint8_t validEntryCount)

Send the next get scheduled prices command.

Parameters

N/A	cmdId	The endpoint in question.
N/A	endpoint
N/A	validEntries
N/A	validEntryCount

Definition at line 1363 of file app/framework/plugin/price-server/price-server.h

emberAfPluginPriceServerPriceUpdateBindings#

void emberAfPluginPriceServerPriceUpdateBindings (void )

Update bindings.

Parameters

N/A

Definition at line 1371 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerSecondsUntilActivePriceMatrixEvent#

uint32_t emberAfPriceServerSecondsUntilActivePriceMatrixEvent (uint8_t endpoint)

get seconds until next active price matrix event

Parameters

N/A

endpoint

relevant endpoint

Returns

uint32_t seconds until next price matrix event

Definition at line 1380 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerRefreshPriceMatrixInformation#

void emberAfPriceServerRefreshPriceMatrixInformation (uint8_t endpoint)

Refresh price matrix information.

Parameters

N/A

endpoint

relevant endpoint

Definition at line 1387 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerSecondsUntilActiveBlockThresholdsEvent#

uint32_t emberAfPriceServerSecondsUntilActiveBlockThresholdsEvent (uint8_t endpoint)

Get seconds until next active block threshold event.

Parameters

N/A

endpoint

relevant endpoint

Returns

uint32_t seconds until next block threshold event

Definition at line 1396 of file app/framework/plugin/price-server/price-server.h

emberAfPriceServerRefreshBlockThresholdsInformation#

void emberAfPriceServerRefreshBlockThresholdsInformation (uint8_t endpoint)

Refresh block threshold information.

Parameters

N/A

endpoint

relevant endpoint

Definition at line 1403 of file app/framework/plugin/price-server/price-server.h

Typedef Documentation#

emAfPriceBlockThreshold#

typedef uint8_t emAfPriceBlockThreshold[ZCL_PRICE_CLUSTER_BLOCK_THRESHOLDS_PAYLOAD_SIZE] [ZCL_PRICE_CLUSTER_BLOCK_THRESHOLDS_PAYLOAD_SIZE]

Definition at line 297 of file app/framework/plugin/price-server/price-server.h

Variable Documentation#

priceServerInfo#

EmberAfPriceServerInfo priceServerInfo

Definition at line 369 of file app/framework/plugin/price-server/price-server.h

Macro Definition Documentation#

EMBER_AF_PLUGIN_PRICE_SERVER_PRICE_TABLE_SIZE#

#define EMBER_AF_PLUGIN_PRICE_SERVER_PRICE_TABLE_SIZE

Value:

(5)

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

EMBER_AF_PLUGIN_PRICE_SERVER_TARIFF_TABLE_SIZE#

#define EMBER_AF_PLUGIN_PRICE_SERVER_TARIFF_TABLE_SIZE

Value:

(2)

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

EMBER_AF_PLUGIN_PRICE_SERVER_BILLING_PERIOD_TABLE_SIZE#

#define EMBER_AF_PLUGIN_PRICE_SERVER_BILLING_PERIOD_TABLE_SIZE

Value:

(2)

Definition at line 60 of file app/framework/plugin/price-server/price-server.h

EMBER_AF_PLUGIN_PRICE_SERVER_MAX_TIERS_PER_TARIFF#

#define EMBER_AF_PLUGIN_PRICE_SERVER_MAX_TIERS_PER_TARIFF

Value:

(2)

Definition at line 64 of file app/framework/plugin/price-server/price-server.h

EMBER_AF_PLUGIN_PRICE_SERVER_TIER_LABELS_TABLE_SIZE#

#define EMBER_AF_PLUGIN_PRICE_SERVER_TIER_LABELS_TABLE_SIZE

Value:

(2)

Definition at line 68 of file app/framework/plugin/price-server/price-server.h

EMBER_AF_PLUGIN_PRICE_SERVER_BLOCK_PERIOD_TABLE_SIZE#

#define EMBER_AF_PLUGIN_PRICE_SERVER_BLOCK_PERIOD_TABLE_SIZE

Value:

(2)

Definition at line 72 of file app/framework/plugin/price-server/price-server.h

EMBER_AF_PLUGIN_PRICE_SERVER_CONSOLIDATED_BILL_TABLE_SIZE#

#define EMBER_AF_PLUGIN_PRICE_SERVER_CONSOLIDATED_BILL_TABLE_SIZE

Value:

(5)

Definition at line 76 of file app/framework/plugin/price-server/price-server.h

EMBER_AF_PLUGIN_PRICE_SERVER_CREDIT_PAYMENT_TABLE_SIZE#

#define EMBER_AF_PLUGIN_PRICE_SERVER_CREDIT_PAYMENT_TABLE_SIZE

Value:

(5)

Definition at line 80 of file app/framework/plugin/price-server/price-server.h

EMBER_AF_PLUGIN_PRICE_SERVER_CALORIFIC_VALUE_TABLE_SIZE#

#define EMBER_AF_PLUGIN_PRICE_SERVER_CALORIFIC_VALUE_TABLE_SIZE

Value:

(2)

Definition at line 84 of file app/framework/plugin/price-server/price-server.h

EMBER_AF_PLUGIN_PRICE_SERVER_CO2_VALUE_TABLE_SIZE#

#define EMBER_AF_PLUGIN_PRICE_SERVER_CO2_VALUE_TABLE_SIZE

Value:

(2)

Definition at line 88 of file app/framework/plugin/price-server/price-server.h

EMBER_AF_PLUGIN_PRICE_SERVER_CONVERSION_FACTOR_TABLE_SIZE#

#define EMBER_AF_PLUGIN_PRICE_SERVER_CONVERSION_FACTOR_TABLE_SIZE

Value:

(2)

Definition at line 92 of file app/framework/plugin/price-server/price-server.h

ZCL_PRICE_CLUSTER_BLOCK_THRESHOLDS_PAYLOAD_SIZE#

#define ZCL_PRICE_CLUSTER_BLOCK_THRESHOLDS_PAYLOAD_SIZE

Value:

(6u)

Definition at line 95 of file app/framework/plugin/price-server/price-server.h

ZCL_PRICE_CLUSTER_PRICE_MATRIX_SUBPAYLOAD_BLOCK_SIZE#

#define ZCL_PRICE_CLUSTER_PRICE_MATRIX_SUBPAYLOAD_BLOCK_SIZE

Value:

(5u)

Definition at line 96 of file app/framework/plugin/price-server/price-server.h

fieldLength#

#define fieldLength

Value:

(field)

Definition at line 98 of file app/framework/plugin/price-server/price-server.h

ZCL_PRICE_CLUSTER_MAX_TOU_BLOCKS#

#define ZCL_PRICE_CLUSTER_MAX_TOU_BLOCKS

Value:

(15u)

Definition at line 101 of file app/framework/plugin/price-server/price-server.h

ZCL_PRICE_CLUSTER_MAX_TOU_BLOCK_TIERS#

#define ZCL_PRICE_CLUSTER_MAX_TOU_BLOCK_TIERS

Value:

(15u)

Definition at line 102 of file app/framework/plugin/price-server/price-server.h

ZCL_PRICE_CLUSTER_MAX_TOU_TIERS#

#define ZCL_PRICE_CLUSTER_MAX_TOU_TIERS

Value:

(48u)

Definition at line 103 of file app/framework/plugin/price-server/price-server.h

ZCL_PRICE_CLUSTER_PRICE_MATRIX_SUB_PAYLOAD_ENTRY_SIZE#

#define ZCL_PRICE_CLUSTER_PRICE_MATRIX_SUB_PAYLOAD_ENTRY_SIZE

Value:

(5u)

Definition at line 104 of file app/framework/plugin/price-server/price-server.h

CURRENT#

#define CURRENT

Value:

BIT(1)

Definition at line 108 of file app/framework/plugin/price-server/price-server.h

FUTURE#

#define FUTURE

Value:

BIT(2)

Definition at line 109 of file app/framework/plugin/price-server/price-server.h

PUBLISHED#

#define PUBLISHED

Value:

BIT(3)

Definition at line 110 of file app/framework/plugin/price-server/price-server.h

TARIFF_TYPE_MASK#

#define TARIFF_TYPE_MASK

Value:

(0x0Fu)

Definition at line 112 of file app/framework/plugin/price-server/price-server.h

CHARGING_SCHEME_MASK#

#define CHARGING_SCHEME_MASK

Value:

(0xF0u)

Definition at line 113 of file app/framework/plugin/price-server/price-server.h

tariffIsCurrent#

#define tariffIsCurrent

Value:

(tariff)

Definition at line 115 of file app/framework/plugin/price-server/price-server.h

tariffIsFuture#

#define tariffIsFuture

Value:

(tariff)

Definition at line 116 of file app/framework/plugin/price-server/price-server.h

tariffIsPublished#

#define tariffIsPublished

Value:

(tariff)

Definition at line 117 of file app/framework/plugin/price-server/price-server.h

priceMatrixIsCurrent#

#define priceMatrixIsCurrent

Value:

(pm)

Definition at line 118 of file app/framework/plugin/price-server/price-server.h

priceMatrixIsFuture#

#define priceMatrixIsFuture

Value:

(pm)

Definition at line 119 of file app/framework/plugin/price-server/price-server.h

priceMatrixIsPublished#

#define priceMatrixIsPublished

Value:

(pm)

Definition at line 120 of file app/framework/plugin/price-server/price-server.h

blockThresholdsIsCurrent#

#define blockThresholdsIsCurrent

Value:

(bt)

Definition at line 121 of file app/framework/plugin/price-server/price-server.h

blockThresholdsIsFuture#

#define blockThresholdsIsFuture

Value:

(bt)

Definition at line 122 of file app/framework/plugin/price-server/price-server.h

blockThresholdsIsPublished#

#define blockThresholdsIsPublished

Value:

(bt)

Definition at line 123 of file app/framework/plugin/price-server/price-server.h

CREDIT_PAYMENT_REF_STRING_LEN#

#define CREDIT_PAYMENT_REF_STRING_LEN

Value:

(20u)

Definition at line 181 of file app/framework/plugin/price-server/price-server.h

TIER_LABEL_SIZE#

#define TIER_LABEL_SIZE

Value:

(12u)

Definition at line 227 of file app/framework/plugin/price-server/price-server.h