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.
Modules#
EmberAfPriceCurrencyConversion
EmberAfPriceBillingPeriodTable
EmberAfPriceConsolidatedBillsTable
EmberAfPriceCreditPaymentTable
EmberAfPriceConversionFactorTable
EmberAfPriceCalorificValueTable
EmberAfPriceCurrencyConversionTable
EmberAfScheduledBlockThresholds
EmberAfScheduledBlockThresholdsTable
EmberAfScheduledPriceMatrixTable
API#
Send the next get scheduled prices command.
Return the number of seconds until the next get scheduled prices command should be sent.
Clear all prices in the price table.
Clear all tariffs in the tariff table.
Clear all price matrices in the price matrix table.
Clear all block thresholds in the block thresholds table.
Get a price used by the price server plugin.
Set values in the block period table.
Send a publish block period command.
Print data in the specified index of the block period table.
Return the number of seconds until the next block period event occurs.
Update block period attributes to match the current block period.
Get a tariff used by the price server plugin.
Retrieve a price matrix entry by index.
Get the block thresholds used by the Price server plugin.
Get a tariff by issuer tariff ID and endpoint.
Get a price matrix by issuer tariff ID and endpoint.
Get the block thresholds by issuer tariff ID and endpoint.
Set a price used by the price server plugin.
Set a tariff used by the price server plugin.
Set a price matrix entry by index.
Set the block thresholds used by the price server plugin.
Get the current price used by the price server plugin.
Find the first free index in the price table.
function to print price
Print tariff table.
Print price matrix.
Print price matrix table.
Print block thresholds.
Print block threshold table.
Publish price message.
Set parameters in the conversion factors table.
Clear the conversion factors table and invalidates all entries.
Send a Publish Conversion Factor command using data at the specified table index.
Return the number of seconds until the next conversion factor event becomes active.
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.
Set values in the calorific value table.
Return the number of seconds until the next calorific value event will become active.
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.
Clear the calorific value table and invalidates all entries.
Send a publish tariff information command.
Print data in the conversion factor table.
Print data in the calorific values table.
Return the number of seconds until the next CO2 value event becomes active.
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.
Set values in the CO2 value table.
Clear the CO2 value table and invalidates all entries.
Print data in the CO2 values table.
Send a publish CO2 value command.
Set values in the tier label table.
Send the next get scheduled prices command.
Add a tier label to the specified tier label table.
Print the tier labels table.
Send a publish tier labels command.
Return the number of seconds until the next billing period event becomes active.
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.
Set values in the billing period table.
Send a publish billing period command.
Print data in the billing period table for the specified endpoint.
Print data in the consolidated bills table at the specified index.
Set values in the consolidated bills table.
Send a publish consolidated bill command.
Set values of the CPP event.
Send a publish CPP event command.
Print data in the CPP Event.
Send a publish credit payment command.
Set values in the credit payment table.
Send a publish currency conversion command.
Set values for the currency conversion command.
Set values in the tariff cancellation command.
Send a cancel tariff command.
Refresh tariff information.
Add a tariff table entry.
Add price matrix (raw).
Add price matrix.
Clean the block period table.
Send the next get scheduled prices command.
Update bindings.
Get seconds until next active price matrix event.
Refresh price matrix information.
Get seconds until next active block threshold event.
Refresh block threshold information.
Typedefs#
Macros#
API Documentation#
emberAfPriceServerSendGetScheduledPrices#
void emberAfPriceServerSendGetScheduledPrices (uint8_t endpoint)
Send the next get scheduled prices command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPriceServerSecondsUntilGetScheduledPricesEvent#
uint32_t emberAfPriceServerSecondsUntilGetScheduledPricesEvent (void )
Return the number of seconds until the next get scheduled prices command should be sent.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
The number of seconds until the next get scheduled prices command should be sent.
emberAfPriceClearPriceTable#
void emberAfPriceClearPriceTable (uint8_t endpoint)
Clear all prices in the price table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPriceClearTariffTable#
void emberAfPriceClearTariffTable (uint8_t endpoint)
Clear all tariffs in the tariff table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPriceClearPriceMatrixTable#
void emberAfPriceClearPriceMatrixTable (uint8_t endpoint)
Clear all price matrices in the price matrix table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPriceClearBlockThresholdsTable#
void emberAfPriceClearBlockThresholdsTable (uint8_t endpoint)
Clear all block thresholds in the block thresholds table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPriceGetPriceTableEntry#
bool emberAfPriceGetPriceTableEntry (uint8_t endpoint, uint8_t index, EmberAfScheduledPrice * price)
Get a price used by the price server plugin.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index in the price table. |
| EmberAfScheduledPrice * | 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.
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint32_t | N/A | providerId | A unique identifier for the commodity provider. |
| uint32_t | N/A | issuerEventId | The event ID of the block period data. |
| uint32_t | N/A | blockPeriodStartTime | Time at which the block period data is valid. |
| uint32_t | N/A | blockPeriodDuration | The block period duration. Units are specified by the blockPeriodDurationType. |
| uint8_t | N/A | blockPeriodControl | Identifies additional control options for the block period command. |
| uint8_t | N/A | blockPeriodDurationType | A bitmap that indicates the units used in the block period. |
| uint32_t | N/A | thresholdMultiplier | A bitmap identifying the type of tariff published in this command. |
| uint32_t | N/A | thresholdDivisor | The resolution period for the block tariff. |
| uint8_t | N/A | tariffType | |
| uint8_t | N/A | tariffResolutionPeriod |
emberAfPluginPriceServerBlockPeriodPub#
void emberAfPluginPriceServerBlockPeriodPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)
Send a publish block period command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | nodeId | The destination address to which the command should be sent. |
| uint8_t | N/A | srcEndpoint | The source endpoint used in the transmission. |
| uint8_t | N/A | dstEndpoint | The destination endpoint used in the transmission. |
| uint8_t | N/A | index | The index of the table whose data will be used in the command. |
emberAfPluginPriceServerBlockPeriodPrint#
void emberAfPluginPriceServerBlockPeriodPrint (uint8_t endpoint, uint8_t index)
Print data in the specified index of the block period table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index of the table whose index will be printed. |
emberAfPriceServerSecondsUntilBlockPeriodEvent#
uint32_t emberAfPriceServerSecondsUntilBlockPeriodEvent (uint8_t endpoint)
Return the number of seconds until the next block period event occurs.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
Returns
Returns the number of seconds until the next block period event.
emberAfPriceServerRefreshBlockPeriod#
void emberAfPriceServerRefreshBlockPeriod (uint8_t endpoint, bool repeat)
Update block period attributes to match the current block period.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| bool | 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. |
emberAfPriceGetTariffTableEntry#
bool emberAfPriceGetTariffTableEntry (uint8_t endpoint, uint8_t index, EmberAfPriceCommonInfo * info, EmberAfScheduledTariff * tariff)
Get a tariff used by the price server plugin.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index in the tariff table. |
| EmberAfPriceCommonInfo * | N/A | info | The EmberAfPriceCommonInfo structure describing the tariff. |
| EmberAfScheduledTariff * | 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.
emberAfPriceGetPriceMatrix#
bool emberAfPriceGetPriceMatrix (uint8_t endpoint, uint8_t index, EmberAfPriceCommonInfo * info, EmberAfScheduledPriceMatrix * pm)
Retrieve a price matrix entry by index.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index in the price matrix table. |
| EmberAfPriceCommonInfo * | N/A | info | The EmberAfScheduledPriceMatrix structure describing the price matrix. |
| EmberAfScheduledPriceMatrix * | 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.
emberAfPriceGetBlockThresholdsTableEntry#
bool emberAfPriceGetBlockThresholdsTableEntry (uint8_t endpoint, uint8_t index, EmberAfScheduledBlockThresholds * bt)
Get the block thresholds used by the Price server plugin.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index in the block thresholds table. |
| EmberAfScheduledBlockThresholds * | 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.
emberAfPriceGetTariffByIssuerTariffId#
bool emberAfPriceGetTariffByIssuerTariffId (uint8_t endpoint, uint32_t issuerTariffId, EmberAfPriceCommonInfo * info, EmberAfScheduledTariff * tariff)
Get a tariff by issuer tariff ID and endpoint.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint32_t | N/A | issuerTariffId | The issuer tariff ID. |
| EmberAfPriceCommonInfo * | N/A | info | The EmberAfPriceCommonInfo structure describing the tariff. |
| EmberAfScheduledTariff * | N/A | tariff | The EmberAfScheduledTariff structure describing the tariff. |
Returns
True if the tariff was found.
emberAfPriceGetPriceMatrixByIssuerTariffId#
bool emberAfPriceGetPriceMatrixByIssuerTariffId (uint8_t endpoint, uint32_t issuerTariffId, EmberAfPriceCommonInfo * info, EmberAfScheduledPriceMatrix * pm)
Get a price matrix by issuer tariff ID and endpoint.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint32_t | N/A | issuerTariffId | The issuer tariff ID. |
| EmberAfPriceCommonInfo * | N/A | info | The EmberAfScheduledPriceMatrix structure describing the price matrix. |
| EmberAfScheduledPriceMatrix * | N/A | pm |
Returns
True if the price matrix was found.
emberAfPriceGetBlockThresholdsByIssuerTariffId#
bool emberAfPriceGetBlockThresholdsByIssuerTariffId (uint8_t endpoint, uint32_t issuerTariffId, EmberAfPriceCommonInfo * info, EmberAfScheduledBlockThresholds * bt)
Get the block thresholds by issuer tariff ID and endpoint.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint32_t | N/A | issuerTariffId | The issuer tariff ID. |
| EmberAfPriceCommonInfo * | N/A | info | The EmberAfScheduledBlockThresholds structure describing the block thresholds. |
| EmberAfScheduledBlockThresholds * | N/A | bt |
Returns
True if the block thresholds were found.
emberAfPriceSetPriceTableEntry#
bool emberAfPriceSetPriceTableEntry (uint8_t endpoint, uint8_t index, const EmberAfScheduledPrice * price)
Set a price used by the price server plugin.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index in the price table. |
| const EmberAfScheduledPrice * | 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.
emberAfPriceSetTariffTableEntry#
bool emberAfPriceSetTariffTableEntry (uint8_t endpoint, uint8_t index, EmberAfPriceCommonInfo * info, const EmberAfScheduledTariff * tariff)
Set a tariff used by the price server plugin.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index in the tariff table. |
| EmberAfPriceCommonInfo * | N/A | info | The EmberAfScheduledTariff structure describing the tariff. If NULL, the tariff is removed from the server. |
| const EmberAfScheduledTariff * | 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.
emberAfPriceSetPriceMatrix#
bool emberAfPriceSetPriceMatrix (uint8_t endpoint, uint8_t index, EmberAfPriceCommonInfo * info, const EmberAfScheduledPriceMatrix * pm)
Set a price matrix entry by index.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index in the price matrix table. |
| EmberAfPriceCommonInfo * | N/A | info | The EmberAfScheduledPriceMatrix structure describing the price matrix. If NULL, the price matrix is removed from the server. |
| const EmberAfScheduledPriceMatrix * | 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.
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index in the block thresholds table. |
| const EmberAfPriceCommonInfo * | N/A | info | The EmberAfScheduledBlockThresholds structure describing the block thresholds. If NULL, the block thresholds entry is removed from the table. |
| const EmberAfScheduledBlockThresholds * | 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.
emberAfGetCurrentPrice#
bool emberAfGetCurrentPrice (uint8_t endpoint, EmberAfScheduledPrice * price)
Get the current price used by the price server plugin.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| EmberAfScheduledPrice * | 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.
emberAfPriceFindFreePriceIndex#
uint8_t emberAfPriceFindFreePriceIndex (uint8_t endpoint)
Find the first free index in the price table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | 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.
emberAfPricePrint#
void emberAfPricePrint (const EmberAfScheduledPrice * price)
function to print price
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| const EmberAfScheduledPrice * | N/A | price |
emberAfPricePrintPriceTable#
void emberAfPricePrintPriceTable (uint8_t endpoint)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
Print the price table.
emberAfPricePrintTariff#
void emberAfPricePrintTariff (const EmberAfPriceCommonInfo * info, const EmberAfScheduledTariff * tariff)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| const EmberAfPriceCommonInfo * | N/A | info | pointer to the common info struct |
| const EmberAfScheduledTariff * | N/A | tariff | pointer to the scheduled tariff struct |
Print tariff.
emberAfPricePrintTariffTable#
void emberAfPricePrintTariffTable (uint8_t endpoint)
Print tariff table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
emberAfPricePrintPriceMatrix#
void emberAfPricePrintPriceMatrix (uint8_t endpoint, const EmberAfPriceCommonInfo * info, const EmberAfScheduledPriceMatrix * pm)
Print price matrix.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
| const EmberAfPriceCommonInfo * | N/A | info | pointer to common info struct |
| const EmberAfScheduledPriceMatrix * | N/A | pm | pointer to scheduled price matrix struct |
emberAfPricePrintPriceMatrixTable#
void emberAfPricePrintPriceMatrixTable (uint8_t endpoint)
Print price matrix table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
emberAfPricePrintBlockThresholds#
void emberAfPricePrintBlockThresholds (uint8_t endpoint, const EmberAfPriceCommonInfo * info, const EmberAfScheduledBlockThresholds * bt)
Print block thresholds.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
| const EmberAfPriceCommonInfo * | N/A | info | pointer to common info struct |
| const EmberAfScheduledBlockThresholds * | N/A | bt | pointer to block threshold struct |
emberAfPricePrintBlockThresholdsTable#
void emberAfPricePrintBlockThresholdsTable (uint8_t endpoint)
Print block threshold table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
emberAfPluginPriceServerPublishPriceMessage#
void emberAfPluginPriceServerPublishPriceMessage (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t priceIndex)
Publish price message.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNodeId | N/A | nodeId | |
| uint8_t | N/A | srcEndpoint | |
| uint8_t | N/A | dstEndpoint | |
| uint8_t | N/A | priceIndex |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
| uint32_t | N/A | issuerEventId | The event ID of the conversion factor data. |
| uint32_t | N/A | startTime | The time when the conversion factor data is valid. |
| uint32_t | N/A | conversionFactor | Accounts for changes in the volume of gas based on temperature and pressure. |
| uint8_t | N/A | conversionFactorTrailingDigit | Determines where the decimal point is located in the conversion factor. |
emberAfPluginPriceServerConversionFactorClear#
void emberAfPluginPriceServerConversionFactorClear (uint8_t endpoint)
Clear the conversion factors table and invalidates all entries.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | tableIndex | The index of the conversion factor table whose data should be used in the publish conversion factor command. |
| EmberNodeId | N/A | dstAddr | The destination address to which the command should be sent. |
| uint8_t | N/A | srcEndpoint | The source endpoint used in the transmission. |
| uint8_t | N/A | dstEndpoint | The destination endpoint used in the transmission. |
emberAfPriceServerSecondsUntilConversionFactorEvent#
uint32_t emberAfPriceServerSecondsUntilConversionFactorEvent (uint8_t endpoint)
Return the number of seconds until the next conversion factor event becomes active.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question |
Returns
The number of seconds until the next conversion factor event becomes active.
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | 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. |
| uint32_t | N/A | issuerEventId | |
| uint32_t | N/A | startTime | |
| uint32_t | N/A | calorificValue | |
| uint8_t | N/A | calorificValueUnit | |
| uint8_t | N/A | calorificValueTrailingDigit |
emberAfPriceServerSecondsUntilCalorificValueEvent#
uint32_t emberAfPriceServerSecondsUntilCalorificValueEvent (uint8_t endpoint)
Return the number of seconds until the next calorific value event will become active.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question |
Returns
The number of seconds until the next calorific value event becomes active.
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPluginPriceServerCalorificValueClear#
void emberAfPluginPriceServerCalorificValueClear (uint8_t endpoint)
Clear the calorific value table and invalidates all entries.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPluginPriceServerPublishTariffMessage#
void emberAfPluginPriceServerPublishTariffMessage (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t tariffIndex)
Send a publish tariff information command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNodeId | N/A | nodeId | The destination address to which the command should be sent. |
| uint8_t | N/A | srcEndpoint | The source endpoint used in the transmission. |
| uint8_t | N/A | dstEndpoint | The destination endpoint used in the transmission. |
| uint8_t | N/A | tariffIndex | The index of the tariff table whose data will be used in the Publish Tariff Information command. |
emberAfPrintConversionTable#
void emberAfPrintConversionTable (uint8_t endpoint)
Print data in the conversion factor table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPrintCalorificValuesTable#
void emberAfPrintCalorificValuesTable (uint8_t endpoint)
Print data in the calorific values table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPriceServerSecondsUntilCO2ValueEvent#
uint32_t emberAfPriceServerSecondsUntilCO2ValueEvent (uint8_t endpoint)
Return the number of seconds until the next CO2 value event becomes active.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
Returns
The number of seconds until the next CO2 value event becomes active.
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
| uint32_t | N/A | issuerEventId | The event ID of the CO2 value table data. |
| uint32_t | N/A | startTime | The time at which the CO2 value data is valid. |
| uint32_t | N/A | providerId | A unique identifier for the commodity provider. |
| uint8_t | N/A | tariffType | Bitmap identifying the type of tariff published in this command. |
| uint32_t | N/A | co2Value | Used to calculate the amount of carbon dioxide produced from energy use. |
| uint8_t | N/A | co2ValueUnit | An enumeration which defines the unit of the co2Value attribute. |
| uint8_t | N/A | co2ValueTrailingDigit | Determines where the decimal point is located in the co2Value. |
emberAfPluginPriceServerCo2ValueClear#
void emberAfPluginPriceServerCo2ValueClear (uint8_t endpoint)
Clear the CO2 value table and invalidates all entries.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPrintCo2ValuesTable#
void emberAfPrintCo2ValuesTable (uint8_t endpoint)
Print data in the CO2 values table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPluginPriceServerCo2LabelPub#
void emberAfPluginPriceServerCo2LabelPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)
Send a publish CO2 value command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | nodeId | The destination address to which the command should be sent. |
| uint8_t | N/A | srcEndpoint | The source endpoint used in the transmission. |
| uint8_t | N/A | dstEndpoint | The destination endpoint used in the transmission. |
| uint8_t | N/A | index | The index of the CO2 values table whose data will be used in the command. |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
| uint8_t | N/A | index | The index of the billing period table whose data will be modified. |
| uint8_t | N/A | valid | Indicates if data at this index is valid or not. |
| uint32_t | N/A | providerId | A unique identifier for the commodity provider. |
| uint32_t | N/A | issuerEventId | The event ID of the tier labels table data. |
| uint32_t | N/A | issuerTariffId | A unique identifier that identifies which tariff the labels apply to. |
| uint8_t | N/A | tierId | The tier number that associated tier label applies to. |
| uint8_t * | N/A | tierLabel | A character string descriptor for this tier. |
emberAfPrintPrintTierLabelsTable#
void emberAfPrintPrintTierLabelsTable (void )
Send the next get scheduled prices command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A | The endpoint in question. |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
| uint32_t | N/A | issuerTariffId | A unique identifier that identifies which tariff the labels apply to. |
| uint8_t | N/A | tierId | The tier number that associated tier label applies to. |
| uint8_t * | N/A | tierLabel | Character string descriptor for this tier. |
emberAfPrintTierLabelsTable#
void emberAfPrintTierLabelsTable (uint8_t endpoint)
Print the tier labels table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPluginPriceServerTierLabelPub#
void emberAfPluginPriceServerTierLabelPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)
Send a publish tier labels command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | nodeId | The destination address to which the command should be sent. |
| uint8_t | N/A | srcEndpoint | The source endpoint used in the transmission. |
| uint8_t | N/A | dstEndpoint | The destination endpoint used in the transmission. |
| uint8_t | N/A | index | The index of the tier labels table whose data will be used in the Publish Tier Labels command. |
emberAfPriceServerSecondsUntilBillingPeriodEvent#
uint32_t emberAfPriceServerSecondsUntilBillingPeriodEvent (uint8_t endpoint)
Return the number of seconds until the next billing period event becomes active.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
Returns
The number of seconds until the next billing period event becomes active.
emberAfPriceServerRefreshBillingPeriod#
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
| bool | N/A | force | Whether or not the billing period should be forced to refresh. |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
| uint32_t | N/A | startTime | The time at which the billing period data is valid. |
| uint32_t | N/A | issuerEventId | The event ID of the billing period data. |
| uint32_t | N/A | providerId | A unique identifier for the commodity provider. |
| uint32_t | N/A | billingPeriodDuration | The billing period duration. Units are specified by the billingPeriodDurationType. |
| uint8_t | N/A | billingPeriodDurationType | A bitmap that indicates the units used in the billing period. |
| uint8_t | N/A | tariffType | Bitmap identifying the type of tariff published in this command. |
emberAfPluginPriceServerBillingPeriodPub#
void emberAfPluginPriceServerBillingPeriodPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)
Send a publish billing period command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | nodeId | The destination address to which the command should be sent. |
| uint8_t | N/A | srcEndpoint | The source endpoint used in the transmission. |
| uint8_t | N/A | dstEndpoint | The destination endpoint used in the transmission. |
| uint8_t | N/A | index | The index of the table whose data will be used in the command. |
emberAfPrintBillingPeriodTable#
void emberAfPrintBillingPeriodTable (uint8_t endpoint)
Print data in the billing period table for the specified endpoint.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPrintConsolidatedBillTableEntry#
void emberAfPrintConsolidatedBillTableEntry (uint8_t endpoint, uint8_t index)
Print data in the consolidated bills table at the specified index.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
| uint8_t | N/A | index | The index of the consolidated bills table whose data should be printed. |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
| uint32_t | N/A | startTime | The time at which the consolidated bills data is valid. |
| uint32_t | N/A | issuerEventId | The event ID of the consolidated bills data. |
| uint32_t | N/A | providerId | A unique identifier for the commodity provider. |
| uint32_t | N/A | billingPeriodDuration | The billing period duration. Units are specified by the billingPeriodDurationType. |
| uint8_t | N/A | billingPeriodDurationType | A bitmap that indicates the units used in the billing period. |
| uint8_t | N/A | tariffType | Bitmap identifying the type of tariff published in this command. |
| uint32_t | N/A | consolidatedBill | The consolidated bill value for the specified billing period. |
| uint16_t | N/A | currency | The currency used in the consolidatedBill field. |
| uint8_t | N/A | billTrailingDigit | Determines where the decimal point is located in the consolidatedBill field. |
emberAfPluginPriceServerConsolidatedBillPub#
void emberAfPluginPriceServerConsolidatedBillPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)
Send a publish consolidated bill command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | nodeId | The destination address to which the command should be sent. |
| uint8_t | N/A | srcEndpoint | The source endpoint used in the transmission. |
| uint8_t | N/A | dstEndpoint | The destination endpoint used in the transmission. |
| uint8_t | N/A | index | The index of the table whose data will be used in the command. |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
| uint8_t | N/A | valid | Indicates if the CPP Event data is valid or not. |
| uint32_t | N/A | providerId | A unique identifier for the commodity provider. |
| uint32_t | N/A | issuerEventId | The event ID of the CPP Event. |
| uint32_t | N/A | startTime | The time at which the CPP Event data is valid. |
| uint16_t | N/A | durationInMinutes | Defines the duration of the CPP Event. |
| uint8_t | N/A | tariffType | Bitmap identifying the type of tariff published in this command. |
| uint8_t | N/A | cppPriceTier | Indicates which CPP price tier should be used for the event. |
| uint8_t | N/A | cppAuth | The status of the CPP event. |
emberAfPluginPriceServerCppEventPub#
void emberAfPluginPriceServerCppEventPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)
Send a publish CPP event command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | nodeId | The destination address to which the command should be sent. |
| uint8_t | N/A | srcEndpoint | The source endpoint used in the transmission. |
| uint8_t | N/A | dstEndpoint | The destination endpoint used in the transmission. |
emberAfPluginPriceServerCppEventPrint#
void emberAfPluginPriceServerCppEventPrint (uint8_t endpoint)
Print data in the CPP Event.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
emberAfPluginPriceServerCreditPaymentPub#
void emberAfPluginPriceServerCreditPaymentPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t index)
Send a publish credit payment command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | nodeId | The destination address to which the command should be sent. |
| uint8_t | N/A | srcEndpoint | The source endpoint used in the transmission. |
| uint8_t | N/A | dstEndpoint | The destination endpoint used in the transmission. |
| uint8_t | N/A | index | The index of the table whose data will be used in the command. |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
| uint8_t | N/A | index | The index of the credit payment table whose data will be modified. |
| uint8_t | N/A | valid | Indicates if data at this index is valid or not. |
| uint32_t | N/A | providerId | A unique identifier for the commodity provider. |
| uint32_t | N/A | issuerEventId | The event ID of the credit payment data. |
| uint32_t | N/A | creditPaymentDueDate | The time the next credit payment is due. |
| uint32_t | N/A | creditPaymentOverdueAmount | The current amount that is overdue from the customer. |
| uint8_t | N/A | creditPaymentStatus | Indicates the current credit payment status. |
| uint32_t | N/A | creditPayment | The amount of the last credit payment. |
| uint32_t | N/A | creditPaymentDate | The time at which the last credit payment was made. |
| uint8_t * | N/A | creditPaymentRef | A string used to denote the last credit payment reference used by the energy supplier. |
emberAfPluginPriceServerCurrencyConversionPub#
void emberAfPluginPriceServerCurrencyConversionPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)
Send a publish currency conversion command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | nodeId | The destination address to which the command should be sent. |
| uint8_t | N/A | srcEndpoint | The source endpoint used in the transmission. |
| uint8_t | N/A | dstEndpoint | The destination endpoint used in the transmission. |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
| uint8_t | N/A | valid | Indicates if the currency conversion data is valid or not. |
| uint32_t | N/A | providerId | A unique identifier for the commodity provider. |
| uint32_t | N/A | issuerEventId | The event ID of the currency conversion data. |
| uint32_t | N/A | startTime | The time at which the currency conversion data is valid. |
| uint16_t | N/A | oldCurrency | Information about the old unit of currency. |
| uint16_t | N/A | newCurrency | Information about the new unit of currency. |
| uint32_t | N/A | conversionFactor | Accounts for changes in the volume of gas based on temperature and pressure. |
| uint8_t | N/A | conversionFactorTrailingDigit | Determines where the decimal point is located in the conversion factor. |
| uint32_t | N/A | currencyChangeControlFlags | Denotes functions that are required to be carried out by the client. |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint in question. |
| uint8_t | N/A | valid | Indicates if the tariff cancellation command is valid or not. |
| uint32_t | N/A | providerId | A unique identifier for the commodity provider. |
| uint32_t | N/A | issuerTariffId | Unique identifier that identifies which tariff should be canceled. |
| uint8_t | N/A | tariffType | A bitmap identifying the type of tariff to be canceled. |
emberAfPluginPriceServerTariffCancellationPub#
void emberAfPluginPriceServerTariffCancellationPub (uint16_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)
Send a cancel tariff command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | nodeId | The destination address to which the command should be sent. |
| uint8_t | N/A | srcEndpoint | The source endpoint used in the transmission. |
| uint8_t | N/A | dstEndpoint | The destination endpoint used in the transmission. |
emberAfPriceServerSecondsUntilTariffInfoEvent#
uint32_t emberAfPriceServerSecondsUntilTariffInfoEvent (uint8_t endpoint)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
Get seconds until the next tariff info event.
Returns
unit32_t seconds until next tariff info event
emberAfPriceServerRefreshTariffInformation#
void emberAfPriceServerRefreshTariffInformation (uint8_t endpoint)
Refresh tariff information.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
emberAfPriceAddTariffTableEntry#
bool emberAfPriceAddTariffTableEntry (uint8_t endpoint, EmberAfPriceCommonInfo * info, const EmberAfScheduledTariff * curTariff)
Add a tariff table entry.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
| EmberAfPriceCommonInfo * | N/A | info | pointer to common info struct |
| const EmberAfScheduledTariff * | N/A | curTariff | pointer to scheduled tariff struct |
Returns
bool true is success
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).
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
| uint32_t | N/A | providerId | |
| uint32_t | N/A | issuerEventId | |
| uint32_t | N/A | startTime | |
| uint32_t | N/A | issuerTariffId | |
| uint8_t | N/A | commandIndex | |
| uint8_t | N/A | numberOfCommands | |
| uint8_t | N/A | subPayloadControl | |
| uint8_t * | N/A | payload |
Returns
bool true is success
emberAfPriceAddPriceMatrix#
bool emberAfPriceAddPriceMatrix (uint8_t endpoint, EmberAfPriceCommonInfo * info, EmberAfScheduledPriceMatrix * pm)
Add price matrix.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
| EmberAfPriceCommonInfo * | N/A | info | pointer to the common info struct |
| EmberAfScheduledPriceMatrix * | N/A | pm | pointer to the scheduled price matrix struct |
Returns
bool true is success
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)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
| uint32_t | N/A | providerId | |
| uint32_t | N/A | issuerEventId | |
| uint32_t | N/A | startTime | |
| uint32_t | N/A | issuerTariffId | |
| uint8_t | N/A | commandIndex | |
| uint8_t | N/A | numberOfCommands | |
| uint8_t | N/A | subpayloadControl | |
| uint8_t * | N/A | payload |
Add a table entry for block threshold table.
Returns
bool true is success
emberAfPriceClearBlockPeriodTable#
void emberAfPriceClearBlockPeriodTable (uint8_t endpoint)
Clean the block period table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
sendValidCmdEntries#
void sendValidCmdEntries (uint8_t cmdId, uint8_t endpoint, uint8_t * validEntries, uint8_t validEntryCount)
Send the next get scheduled prices command.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | cmdId | The endpoint in question. |
| uint8_t | N/A | endpoint | |
| uint8_t * | N/A | validEntries | |
| uint8_t | N/A | validEntryCount |
emberAfPluginPriceServerPriceUpdateBindings#
void emberAfPluginPriceServerPriceUpdateBindings (void )
Update bindings.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
emberAfPriceServerSecondsUntilActivePriceMatrixEvent#
uint32_t emberAfPriceServerSecondsUntilActivePriceMatrixEvent (uint8_t endpoint)
Get seconds until next active price matrix event.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
Returns
uint32_t seconds until next price matrix event
emberAfPriceServerRefreshPriceMatrixInformation#
void emberAfPriceServerRefreshPriceMatrixInformation (uint8_t endpoint)
Refresh price matrix information.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
emberAfPriceServerSecondsUntilActiveBlockThresholdsEvent#
uint32_t emberAfPriceServerSecondsUntilActiveBlockThresholdsEvent (uint8_t endpoint)
Get seconds until next active block threshold event.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
Returns
uint32_t seconds until next block threshold event
emberAfPriceServerRefreshBlockThresholdsInformation#
void emberAfPriceServerRefreshBlockThresholdsInformation (uint8_t endpoint)
Refresh block threshold information.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | relevant endpoint |
Typedef Documentation#
sli_zigbee_af_price_block_threshold#
typedef uint8_t sli_zigbee_af_price_block_threshold[ZCL_PRICE_CLUSTER_BLOCK_THRESHOLDS_PAYLOAD_SIZE] [ZCL_PRICE_CLUSTER_BLOCK_THRESHOLDS_PAYLOAD_SIZE]