Price Server#

Callbacks for Price Server Component.

Callbacks#

void

Initialize he price cluster server.

void
emberAfPluginPriceServerNewActivePriceMatrixCallback(const EmberAfPriceCommonInfo *priceCommonInfo, const EmberAfScheduledPriceMatrix *priceMatrix)

Notify the application that a new PriceMatrix has become available.

void
emberAfPluginPriceServerNewActiveTariffInformationCallback(const EmberAfPriceCommonInfo *priceCommonInfo, const EmberAfScheduledTariff *priceTariffInfo)

Notify the application that a new tariff information has become available.

void
emberAfPluginPriceServerNewActiveBlockThresholdsInformationCallback(const EmberAfPriceCommonInfo *priceCommonInfo, const EmberAfScheduledBlockThresholds *priceBlockThresholds)

Notify the application that a new block thresholds information has become available.

void
emberAfPluginPriceServerNewActiveBlockPeriodInformationCallback(const EmberAfPriceCommonInfo *priceCommonInfo, const EmberAfPriceBlockPeriod *priceBlockPeriods)

Notify the application that a new block period information has become available.

Callbacks Documentation#

emberAfPriceClusterServerInitCallback#

void emberAfPriceClusterServerInitCallback (uint8_t endpoint)

Initialize he price cluster server.

Parameters
N/Aendpoint

Endpoint that is being initialized Ver.: always


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

emberAfPluginPriceServerNewActivePriceMatrixCallback#

void emberAfPluginPriceServerNewActivePriceMatrixCallback (const EmberAfPriceCommonInfo *priceCommonInfo, const EmberAfScheduledPriceMatrix *priceMatrix)

Notify the application that a new PriceMatrix has become available.

Parameters
N/ApriceCommonInfo

Ver.: always

N/ApriceMatrix

Ver.: always

The application is responsible for updating proper ZCL attributes to reflect the necessary vendor-specific behaviors. priceCommonInfo contains common information, such as startTime. priceMatrix contains the PriceMatrix information.


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

emberAfPluginPriceServerNewActiveTariffInformationCallback#

void emberAfPluginPriceServerNewActiveTariffInformationCallback (const EmberAfPriceCommonInfo *priceCommonInfo, const EmberAfScheduledTariff *priceTariffInfo)

Notify the application that a new tariff information has become available.

Parameters
N/ApriceCommonInfo

Ver.: always

N/ApriceTariffInfo

Ver.: always

The application is responsible for updating proper ZCL attributes to reflect the necessary vendor-specific behaviors. priceCommonInfo contains common information, such as startTime. priceTariffInfo contains the price matrix information.


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

emberAfPluginPriceServerNewActiveBlockThresholdsInformationCallback#

void emberAfPluginPriceServerNewActiveBlockThresholdsInformationCallback (const EmberAfPriceCommonInfo *priceCommonInfo, const EmberAfScheduledBlockThresholds *priceBlockThresholds)

Notify the application that a new block thresholds information has become available.

Parameters
N/ApriceCommonInfo

Ver.: always

N/ApriceBlockThresholds

Ver.: always

The application is responsible for updating proper ZCL attributes to reflect the necessary vendor-specific behaviors. priceCommonInfo contains common information, such as startTime. priceTariffInfo contains the BlockThresholds information.


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

emberAfPluginPriceServerNewActiveBlockPeriodInformationCallback#

void emberAfPluginPriceServerNewActiveBlockPeriodInformationCallback (const EmberAfPriceCommonInfo *priceCommonInfo, const EmberAfPriceBlockPeriod *priceBlockPeriods)

Notify the application that a new block period information has become available.

Parameters
N/ApriceCommonInfo

Ver.: always

N/ApriceBlockPeriods

Ver.: always

The application is responsible for updating proper ZCL attributes to reflect the necessary vendor-specific behaviors. priceCommonInfo contains common information, such as startTime. priceBlockPeriod contains the BlockPeriod information.


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