Cluster Commands: Price#

The PublishPrice command is generated in response to receiving a Get Current Price command, in response to a Get Scheduled Prices command, and when an update to the pricing information is available from the commodity provider, either before or when a TOU price becomes active.

• providerId - INT32U

• rateLabel - OCTET_STRING

• issuerEventId - INT32U

• currentTime - UTC_TIME

• unitOfMeasure - AmiUnitOfMeasure [ENUM8]

• currency - INT16U

• priceTrailingDigitAndPriceTier - PriceTrailingDigitAndPriceTier [BITMAP8]

• numberOfPriceTiersAndRegisterTier - PriceNumberOfPriceTiersAndRegisterTier [BITMAP8]

• startTime - UTC_TIME

• durationInMinutes - INT16U

• price - INT32U

• priceRatio - INT8U

• generationPrice - INT32U

• generationPriceRatio - INT8U

• alternateCostDelivered - INT32U

• alternateCostUnit - AlternateCostUnit [ENUM8]

• alternateCostTrailingDigit - AlternateCostTrailingDigit [BITMAP8]

• numberOfBlockThresholds - INT8U

• priceControl - PriceControlMask [BITMAP8]

• numberOfGenerationTiers - INT8U

• generationTier - GenerationTier [ENUM8]

• extendedNumberOfPriceTiers - ExtendedNumberOfPriceTiers [ENUM8]

• extendedPriceTier - ExtendedPriceTier [ENUM8]

• extendedRegisterTier - ExtendedRegisterTier [ENUM8] See Also

  • sl_zigbee_af_ami_unit_of_measure_tsl_zigbee_af_alternate_cost_unit_tsl_zigbee_af_generation_tier_tsl_zigbee_af_extended_number_of_price_tiers_tsl_zigbee_af_extended_price_tier_tsl_zigbee_af_extended_register_tier_t

The PublishBlockPeriod command is generated in response to receiving a GetBlockPeriod(s) command or when an update to the block tariff schedule is available from the commodity provider.

• providerId - INT32U

• issuerEventId - INT32U

• blockPeriodStartTime - UTC_TIME

• blockPeriodDuration - INT24U

• numberOfPriceTiersAndNumberOfBlockThresholds - BITMAP8

• blockPeriodControl - BlockPeriodControl [BITMAP8]

• blockPeriodDurationType - BlockPeriodDurationType [BITMAP8]

• tariffType - TariffType [ENUM8]

• tariffResolutionPeriod - TariffResolutionPeriod [ENUM8] See Also

  • sl_zigbee_af_tariff_type_tsl_zigbee_af_tariff_resolution_period_t

The PublishConversionFactor command is sent in response to a GetConversionFactor command or if a new Conversion factor is available.

• issuerEventId - INT32U

• startTime - UTC_TIME

• conversionFactor - INT32U

• conversionFactorTrailingDigit - ConversionFactorTrailingDigit [BITMAP8]

The PublishCalorificValue command is sent in response to a GetCalorificValue command or if a new calorific value is available.

• issuerEventId - INT32U

• startTime - UTC_TIME

• calorificValue - INT32U

• calorificValueUnit - CalorificValueUnit [ENUM8]

• calorificValueTrailingDigit - CalorificValueTrailingDigit [BITMAP8] See Also

  • sl_zigbee_af_calorific_value_unit_t

The PublishTariffInformation command is sent in response to a GetTariffInformation command or if new tariff information is available (including price matrix and block thresholds).

• providerId - INT32U

• issuerEventId - INT32U

• issuerTariffId - INT32U

• startTime - UTC_TIME

• tariffTypeChargingScheme - TariffTypeChargingScheme [BITMAP8]

• tariffLabel - OCTET_STRING

• numberOfPriceTiersInUse - INT8U

• numberOfBlockThresholdsInUse - INT8U

• unitOfMeasure - AmiUnitOfMeasure [ENUM8]

• currency - INT16U

• priceTrailingDigit - PriceTrailingDigit [BITMAP8]

• standingCharge - INT32U

• tierBlockMode - TierBlockMode [ENUM8]

• blockThresholdMultiplier - INT24U

• blockThresholdDivisor - INT24U See Also

  • sl_zigbee_af_ami_unit_of_measure_tsl_zigbee_af_tier_block_mode_t

PublishPriceMatrix command is used to publish the Block Price Information Set (up to 15 tiers x 15 blocks) and the Extended Price Information Set (up to 48 tiers). The PublishPriceMatrix command is sent in response to a GetPriceMatrix command.

• providerId - INT32U

• issuerEventId - INT32U

• startTime - UTC_TIME

• issuerTariffId - INT32U

• commandIndex - INT8U

• numberOfCommands - INT8U

• subPayloadControl - PriceMatrixSubPayloadControl [BITMAP8]

• payload - struct sl_zigbee_zcl_price_matrix_sub_payload_t

The PublishBlockThreshold command is sent in response to a GetBlockThreshold command.

• providerId - INT32U

• issuerEventId - INT32U

• startTime - UTC_TIME

• issuerTariffId - INT32U

• commandIndex - INT8U

• numberOfCommands - INT8U

• subPayloadControl - BlockThresholdSubPayloadControl [BITMAP8]

• payload - struct sl_zigbee_zcl_block_threshold_sub_payload_t

The PublishCO2Value command is sent in response to a GetCO2Value command or if a new CO2 conversion factor is available.

• providerId - INT32U

• issuerEventId - INT32U

• startTime - UTC_TIME

• tariffType - TariffType [ENUM8]

• cO2Value - INT32U

• cO2ValueUnit - CO2Unit [ENUM8]

• cO2ValueTrailingDigit - CO2TrailingDigit [BITMAP8] See Also

  • sl_zigbee_af_tariff_type_tsl_zigbee_af_co2_unit_t

The PublishTierLabels command is generated in response to receiving a GetTierLabels command or when there is a tier label change.

• providerId - INT32U

• issuerEventId - INT32U

• issuerTariffId - INT32U

• commandIndex - INT8U

• numberOfCommands - INT8U

• numberOfLabels - INT8U

• tierLabelsPayload - INT8U

The PublishBillingPeriod command is generated in response to receiving a GetBillingPeriod(s) command or when an update to the Billing schedule is available from the commodity Supplier.

• providerId - INT32U

• issuerEventId - INT32U

• billingPeriodStartTime - UTC_TIME

• billingPeriodDuration - BillingPeriodDuration [BITMAP24]

• billingPeriodDurationType - BillingPeriodDurationType [BITMAP8]

• tariffType - TariffType [ENUM8] See Also

  • sl_zigbee_af_tariff_type_t

The PublishConsolidatedBill command is used to make consolidated billing information of previous billing periods available to other end devices. This command is issued in response to a GetConsolidatedBill command or if new billing information is available.

• providerId - INT32U

• issuerEventId - INT32U

• billingPeriodStartTime - UTC_TIME

• billingPeriodDuration - BillingPeriodDuration [BITMAP24]

• billingPeriodDurationType - BillingPeriodDurationType [BITMAP8]

• tariffType - TariffType [ENUM8]

• consolidatedBill - INT32U

• currency - INT16U

• billTrailingDigit - BillTrailingDigit [BITMAP8] See Also

  • sl_zigbee_af_tariff_type_t

The PublishCPPEvent command is sent from an ESI to its price clients to notify them of a Critical Peak Pricing event.

• providerId - INT32U

• issuerEventId - INT32U

• startTime - UTC_TIME

• durationInMinutes - INT16U

• tariffType - TariffType [ENUM8]

• cppPriceTier - CppPriceTier [ENUM8]

• cppAuth - PublishCppEventCppAuth [ENUM8] See Also

  • sl_zigbee_af_tariff_type_tsl_zigbee_af_cpp_price_tier_tsl_zigbee_af_publish_cpp_event_cpp_auth_t

The PublishCreditPayment command is used to update the credit payment information is available.

• providerId - INT32U

• issuerEventId - INT32U

• creditPaymentDueDate - UTC_TIME

• creditPaymentOverDueAmount - INT32U

• creditPaymentStatus - CreditPaymentStatus [ENUM8]

• creditPayment - INT32U

• creditPaymentDate - UTC_TIME

• creditPaymentRef - OCTET_STRING See Also

  • sl_zigbee_af_credit_payment_status_t

The PublishCurrencyConversion command is sent in response to a GetCurrencyConversion command or when a new currency becomes available.

• providerId - INT32U

• issuerEventId - INT32U

• startTime - UTC_TIME

• oldCurrency - INT16U

• newCurrency - INT16U

• conversionFactor - INT32U

• conversionFactorTrailingDigit - ConversionFactorTrailingDigit [BITMAP8]

• currencyChangeControlFlags - CurrencyChangeControl [BITMAP32]

The CancelTariff command indicates that all data associated with a particular tariff instance should be discarded.

• providerId - INT32U

• issuerTariffId - INT32U

• tariffType - TariffType [ENUM8] See Also

  • sl_zigbee_af_tariff_type_t

The GetCurrentPrice command initiates a PublishPrice command for the current time.

• commandOptions - AmiCommandOptions [BITMAP8]

The GetScheduledPrices command initiates a PublishPrice command for available price events.

• startTime - UTC_TIME

• numberOfEvents - INT8U

The PriceAcknowledgement command described provides the ability to acknowledge a previously sent PublishPrice command.

• providerId - INT32U

• issuerEventId - INT32U

• priceAckTime - UTC_TIME

• control - PriceControlMask [BITMAP8]

The GetBlockPeriods command initiates a PublishBlockPeriod command for the currently scheduled block periods.

• startTime - UTC_TIME

• numberOfEvents - INT8U

• tariffType - TariffType [ENUM8] See Also

  • sl_zigbee_af_tariff_type_t

The GetConversionFactor command initiates a PublishConversionFactor command for the scheduled conversion factor updates.

• earliestStartTime - UTC_TIME

• minIssuerEventId - INT32U

• numberOfCommands - INT8U

The GetCalorificValue command initiates a PublishCalorificValue command for the scheduled conversion factor updates.

• earliestStartTime - UTC_TIME

• minIssuerEventId - INT32U

• numberOfCommands - INT8U

The GetTariffInformation command initiates a PublishTariffInformation command for the scheduled tariff updates.

• earliestStartTime - UTC_TIME

• minIssuerEventId - INT32U

• numberOfCommands - INT8U

• tariffType - TariffType [ENUM8] See Also

  • sl_zigbee_af_tariff_type_t

The GetPriceMatrix command initiates a PublishPriceMatrix command for the scheduled Price Matrix updates.

• issuerTariffId - INT32U

The GetBlockThresholds command initiates a PublishBlockThreshold command for the scheduled Block Threshold updates.

• issuerTariffId - INT32U

The GetCO2Value command initiates a PublishCO2Value command for the scheduled CO2 conversion factor updates.

• earliestStartTime - UTC_TIME

• minIssuerEventId - INT32U

• numberOfCommands - INT8U

• tariffType - TariffType [ENUM8] See Also

  • sl_zigbee_af_tariff_type_t

The GetTierLabels command allows a client to retrieve the tier labels associated with a given tariff; this command initiates a PublishTierLabels command from the server.

• issuerTariffId - INT32U

The GetBillingPeriod command initiates one or more PublishBillingPeriod commands for the currently scheduled billing periods.

• earliestStartTime - UTC_TIME

• minIssuerEventId - INT32U

• numberOfCommands - INT8U

• tariffType - TariffType [ENUM8] See Also

  • sl_zigbee_af_tariff_type_t

The GetConsolidatedBill command initiates one or more PublishConsolidatedBill commands with the requested billing information.

• earliestStartTime - UTC_TIME

• minIssuerEventId - INT32U

• numberOfCommands - INT8U

• tariffType - TariffType [ENUM8] See Also

  • sl_zigbee_af_tariff_type_t

The CPPEventResponse command is sent from a Client (IHD) to the ESI to notify it of a Critical Peak Pricing event authorization.

• issuerEventId - INT32U

• cppAuth - CppEventResponseCppAuth [ENUM8] See Also

  • sl_zigbee_af_cpp_event_response_cpp_auth_t

The GetCreditPayment command initiates PublishCreditPayment commands for the requested credit payment information.

• latestEndTime - UTC_TIME

• numberOfRecords - INT8U

The GetCurrencyConversionCommand command initiates a PublishCurrencyConversion command for the currency conversion factor updates. A server shall be capable of storing both the old and the new currencies.

The GetTariffCancellation command initiates the return of the last CancelTariff command held on the associated server.