Plugin Commands: Price Server

Zigbee Application Framework Command Line Interface (CLI)

plugin price-server ack [req:1]

• Turn price acknowledgement on or off depending on passed bool value.
  • req - INT8U - bool acknowledgement required

plugin price-server alternate [alternateCostDelivered:4] [alternateCostUnit:1] [alternateCostTrailingDigit:1]

• Set the alternate values for the price.
  • alternateCostDelivered - INT32U - alternate cost delivered
  • alternateCostUnit - INT8U - alternate cost unit
  • alternateCostTrailingDigit - INT8U - alternate cost trailing digit

plugin price-server billing-period add [endpoint:1] [startTime:4] [issuerEventId:4] [providerId:4] [billingPeriodDuration:4] [billingPeriodDurationType:1] [tariffType :1]

• Set specific info for billing period
  • endpoint - INT8U
  • startTime - UTC_TIME
  • issuerEventId - INT32U
  • providerId - INT32U
  • billingPeriodDuration - INT32U
  • billingPeriodDurationType - INT8U
  • tariffType - INT8U

plugin price-server billing-period print [endpoint:1]

• Print out the table.
  • endpoint - INT8U

plugin price-server billing-period pub [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [index:1]

• Publish billing period entry.
  • nodeId - INT16U - the destination node id
  • srcEndpoint - INT8U - the source endpoint
  • dstEndpoint - INT8U - the destination endpoint
  • index - INT8U - index of the billing period entry to publish

plugin price-server billing-period repeat [repeat:1]

• Set whether or not a billing period should repeat after it finishes. Per the SE spec, the billing period is supposed to repeat, but this command can be used to turn that feature off for debugging.
  • repeat - INT8U - Whether or not a billing period should repeat. 0 can be passed to stop all billing periods from repeating.

plugin price-server block-period add [endpoint:1] [providerId:4] [issuerEventId:4] [blockPeriodStartTime:4] [blockPeriodDuration:4] [blockPeriodControl:1] [blockPeriodDurationType:1] [thresholdMultiplier:4] [thresholdDivisor:4] [tariffType:1] [tariffResolutionPeriod:1]

• Set the block period value in the table.
  • endpoint - INT8U
  • providerId - INT32U
  • issuerEventId - INT32U
  • blockPeriodStartTime - INT32U
  • blockPeriodDuration - INT32U
  • blockPeriodControl - INT8U
  • blockPeriodDurationType - INT8U
  • thresholdMultiplier - INT32U
  • thresholdDivisor - INT32U
  • tariffType - INT8U
  • tariffResolutionPeriod - INT8U

plugin price-server block-period clear [endpoint:1]

• Clears the local Block Period table.
  • endpoint - INT8U

plugin price-server block-period print [endpoint:1] [index:1]

• Print the block period table.
  • endpoint - INT8U
  • index - INT8U

plugin price-server block-period pub [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [index:1]

• Sends a Publish Block Period command.
  • nodeId - INT16U
  • srcEndpoint - INT8U
  • dstEndpoint - INT8U
  • index - INT8U

plugin price-server calorific-value add [endpoint:1] [issuerEventId:4] [startTime:4] [calorificValue:4] [calorificValueUnit:1] [calorificValueTrailingDigit:1]

• Set the calorific value in table.
  • endpoint - INT8U
  • issuerEventId - INT32U
  • startTime - UTC_TIME
  • calorificValue - INT32U
  • calorificValueUnit - INT8U
  • calorificValueTrailingDigit - INT8U

plugin price-server calorific-value clear [endpoint:1]

• Clear the table.
  • endpoint - INT8U

plugin price-server calorific-value print [endpoint:1]

• Print out the table.
  • endpoint - INT8U

plugin price-server clear [endpoint:1]

• Clears out the currently set price for the supplied endpoint.
  • endpoint - INT8U - The relevant endpoint

plugin price-server co2-val add [endpoint:1] [issuerEventId:4] [startTime:4] [providerId:4] [tariffType:1] [co2Value:4] [co2ValueUnit:1] [co2ValueTrailingDigit:1]

• Set the CO2 value in table.
  • endpoint - INT8U
  • issuerEventId - INT32U
  • startTime - UTC_TIME
  • providerId - INT32U
  • tariffType - INT8U
  • co2Value - INT32U
  • co2ValueUnit - INT8U
  • co2ValueTrailingDigit - INT8U

plugin price-server co2-val clear [endpoint:1]

• Clear the table.
  • endpoint - INT8U

plugin price-server co2-val print [endpoint:1]

• Print out the table.
  • endpoint - INT8U

plugin price-server co2-val pub [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [tariffIndex:1]

• Publish table entry.
  • nodeId - INT16U - the destination node id
  • srcEndpoint - INT8U - the source endpoint
  • dstEndpoint - INT8U - the destination endpoint
  • tariffIndex - INT8U - index of the tariff to publish

plugin price-server consol-bill add [endpoint:1] [startTime:4] [issuerEventId:4] [providerId:4] [billingPeriodDuration:4] [billingPeriodDurationType:1] [tariffType :1] [consolidatedBill:4] [currency:2] [billTrailingDigit:1]

• Set specific info for consolidated bill
  • endpoint - INT8U
  • startTime - UTC_TIME
  • issuerEventId - INT32U
  • providerId - INT32U
  • billingPeriodDuration - INT32U
  • billingPeriodDurationType - INT8U
  • tariffType - INT8U
  • consolidatedBill - INT32U
  • currency - INT16U
  • billTrailingDigit - INT8U

plugin price-server consol-bill print [endpoint:1] [index:1]

• Print out the consolidated bills table.
  • endpoint - INT8U
  • index - INT8U

plugin price-server consol-bill pub [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [index:1]

• Publish billing period entry.
  • nodeId - INT16U - the destination node id
  • srcEndpoint - INT8U - the source endpoint
  • dstEndpoint - INT8U - the destination endpoint
  • index - INT8U - index of the consolidated bill entry to publish

plugin price-server conversion-factor add [endpoint:1] [issuerEventId:4] [startTime:4] [conversionFactor:4] [conversionFactorTrailingDigit:1]

• Set the conversion factor information in the conversion factor table.
  • endpoint - INT8U
  • issuerEventId - INT32U
  • startTime - UTC_TIME
  • conversionFactor - INT32U
  • conversionFactorTrailingDigit - INT8U

plugin price-server conversion-factor clear [endpoint:1]

• Clear conversion factor table.
  • endpoint - INT8U

plugin price-server conversion-factor print [endpoint:1]

• Print out conversion factor table.
  • endpoint - INT8U

plugin price-server conversion-factor pub [tableIndex:1] [server:2] [clientEndpoint:1] [serverEndpoint:1]

• publish specified conversion factor entry
  • tableIndex - INT8U - The network address of the server to which the request will be sent.
  • server - INT16U - The network address of the server to which the request will be sent.
  • clientEndpoint - INT8U - The local endpoint from which the request will be sent.
  • serverEndpoint - INT8U - The remote endpoint to which the request will be sent.

plugin price-server cpp-event print [endpoint:1]

• Print the current CPP event values.
  • endpoint - INT8U

plugin price-server cpp-event pub [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]

• Publish a CPP event command using the configured values for the CPP event.
  • nodeId - INT16U
  • srcEndpoint - INT8U
  • dstEndpoint - INT8U

plugin price-server cpp-event set [endpoint:1] [valid:1] [providerId:4] [issuerEventId:4] [startTime:4] [durationInMins:2] [tariffType:1] [cppPriceTier:1] [cppAuth:1]

• Configure values for a CPP event.
  • endpoint - INT8U
  • valid - INT8U
  • providerId - INT32U
  • issuerEventId - INT32U
  • startTime - INT32U
  • durationInMins - INT16U
  • tariffType - INT8U
  • cppPriceTier - INT8U
  • cppAuth - INT8U

plugin price-server credit-pmt pub [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [index:1]

• Publish Credit Payment command.
  • nodeId - INT16U - the destination node id
  • srcEndpoint - INT8U - the source endpoint
  • dstEndpoint - INT8U - the destination endpoint
  • index - INT8U - index of the credit payment table entry to publish

plugin price-server credit-pmt set [endpoint:1] [index:1] [valid:1] [providerId:4] [issuerEventId:4] [creditPaymentDueDate:4] [creditPaymentOverdueAmount:4] [creditPaymentStatus:1] [creditPayment:4] [creditPaymentDate:4] [creditPaymentRef:-1]

• Set specific info for credit payment
  • endpoint - INT8U
  • index - INT8U
  • valid - INT8U
  • providerId - INT32U
  • issuerEventId - INT32U
  • creditPaymentDueDate - UTC_TIME
  • creditPaymentOverdueAmount - INT32U
  • creditPaymentStatus - INT8U
  • creditPayment - INT32U
  • creditPaymentDate - UTC_TIME
  • creditPaymentRef - OCTET_STRING

plugin price-server currency-conv pub [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]

• Publish the currency conversion command.
  • nodeId - INT16U - the destination node id
  • srcEndpoint - INT8U - the source endpoint
  • dstEndpoint - INT8U - the destination endpoint

plugin price-server currency-conv set [endpoint:1] [valid:1] [providerId:4] [issuerEventId:4] [startTime:4] [oldCurrency:2] [newCurrency:2] [conversionFactor:4] [conversionFactorTrailingDigit:1] [currencyChangeControlFlags:4]

• Configure the currency conversion settings.
  • endpoint - INT8U
  • valid - INT8U
  • providerId - INT32U
  • issuerEventId - INT32U
  • startTime - UTC_TIME
  • oldCurrency - INT16U
  • newCurrency - INT16U
  • conversionFactor - INT32U
  • conversionFactorTrailingDigit - INT8U
  • currencyChangeControlFlags - INT32U

plugin price-server get [endpoint:1] [index:1]

• Retrieve a price from a given index into the price buffer for editing.
  • endpoint - INT8U - the relevant endpoint
  • index - INT8U - index of the price to retrieve

plugin price-server init [endpoint:1]

• Initialize the price info for the provided endpoint.
  • endpoint - INT8U - The relevant endpoint

plugin price-server invalid [endpoint:1] [index:1]

• Make a price at a given index invalid.
  • endpoint - INT8U - the relevant endpoint
  • index - INT8U - index in the price table

plugin price-server price [price:4] [ratio:1] [genPrice:4] [genRatio:1]

• Set the single price held within the price plugin server
  • price - INT32U - price
  • ratio - INT8U - ratio
  • genPrice - INT32U - generation price
  • genRatio - INT8U - generation price ratio

plugin price-server print [endpoint:1]

• Print the price info for the provided endpoint.
  • endpoint - INT8U - The relevant endpoint

plugin price-server pub-tariff-info [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [tariffIndex:1]

• Publish the tariff info.
  • nodeId - INT16U - the destination node id
  • srcEndpoint - INT8U - the source endpoint
  • dstEndpoint - INT8U - the destination endpoint
  • tariffIndex - INT8U - index of the tariff to publish

plugin price-server publish [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [priceIndex:1]

• Publish the current price.
  • nodeId - INT16U - the destination node id
  • srcEndpoint - INT8U - the source endpoint
  • dstEndpoint - INT8U - the destination endpoint
  • priceIndex - INT8U - index of the price to publish

plugin price-server sprint [endpoint:1]

• Print the contents of the price buffer for the provided endpoint.
  • endpoint - INT8U - the relevant endpoint

plugin price-server tariff-cancel pub [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]

• Send a Tariff Cancellation command using the values of the Tariff Cancellation structure.
  • nodeId - INT16U
  • srcEndpoint - INT8U
  • dstEndpoint - INT8U

plugin price-server tariff-cancel set [endpoint:1] [valid:1] [providerId:4] [issuerTariffId:4] [tariffType:1]

• Set the values of the Tariff Cancellation structure.
  • endpoint - INT8U
  • valid - INT8U
  • providerId - INT32U
  • issuerTariffId - INT32U
  • tariffType - INT8U

plugin price-server tier-label add-label [endpoint:1] [issuerTariffId:4] [tierId:1] [tierLabel:-1]

• Add additional tier labels to a given tier.
  • endpoint - INT8U
  • issuerTariffId - INT32U
  • tierId - INT8U
  • tierLabel - OCTET_STRING

plugin price-server tier-label print [endpoint:1]

• Print out the table.
  • endpoint - INT8U

plugin price-server tier-label pub [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [tariffIndex:1]

• Publish the table.
  • nodeId - INT16U - the destination node id
  • srcEndpoint - INT8U - the source endpoint
  • dstEndpoint - INT8U - the destination endpoint
  • tariffIndex - INT8U - index of the tariff to publish

plugin price-server tier-label set [endpoint:1] [index:1] [valid:1] [providerId:4] [issuerEventId:4] [issuerTariffId:4] [tierId:1] [tierLabel:-1]

• Set specific info for tier label
  • endpoint - INT8U
  • index - INT8U
  • valid - INT8U
  • providerId - INT32U
  • issuerEventId - INT32U
  • issuerTariffId - INT32U
  • tierId - INT8U
  • tierLabel - OCTET_STRING

plugin price-server valid [endpoint:1] [index:1]

• Make a price at a given index valid.
  • endpoint - INT8U - the relevant endpoint
  • index - INT8U - index in the price table

plugin price-server what [unitOfMeas:1] [curr:2] [ptd:1] [prt:1] [bt:1]

• Indicates what units the price is presented in.
  • unitOfMeas - INT8U - unit of measure
  • curr - INT16U - currency
  • ptd - INT8U - price trailing digit and tier
  • prt - INT8U - number of price tiers and tier
  • bt - INT8U - number of block thresholds

plugin price-server when [startTime:4] [duration:2]

• Sets start time and duration for the price.
  • startTime - UTC_TIME
  • duration - INT16U

plugin price-server who [provId:4] [label:-1] [eventId:4]

• Sets identifying information about the price.
  • provId - INT32U - provider id
  • label - OCTET_STRING - rate label
  • eventId - INT32U - issuer event id