Cluster Commands: Prepayment

Zigbee Application Framework Command Line Interface (CLI)

zcl prepayment chg-debt [issuerEventId:4] [debtLabel:-1] [debtAmount:4] [debtRecoveryMethod:1] [debtAmountType:1] [debtRecoveryStartTime:4] [debtRecoveryCollectionTime:2] [debtRecoveryFrequency:1] [debtRecoveryAmount:4] [debtRecoveryBalancePercentage:2]

• The ChangeDebt command is send to the Metering Device to change the fuel or Non fuel debt values.
  • issuerEventId - INT32U
  • debtLabel - OCTET_STRING
  • debtAmount - INT32U
  • debtRecoveryMethod - DebtRecoveryMethod [ENUM8]
  • debtAmountType - DebtAmountType [ENUM8]
  • debtRecoveryStartTime - UTC_TIME
  • debtRecoveryCollectionTime - INT16U
  • debtRecoveryFrequency - DebtRecoveryFrequency [ENUM8]
  • debtRecoveryAmount - INT32U
  • debtRecoveryBalancePercentage - INT16U

    See also

    EmberAfDebtRecoveryMethod EmberAfDebtAmountType EmberAfDebtRecoveryFrequency

zcl prepayment chg-pmt-mode [providerId:4] [issuerEventId:4] [implementationDateTime:4] [proposedPaymentControlConfiguration:2] [cutOffValue:4]

• This command is sent to a Metering Device to instruct it to change its mode of operation. i.e. from Credit to Prepayment.
  • providerId - INT32U
  • issuerEventId - INT32U
  • implementationDateTime - UTC_TIME
  • proposedPaymentControlConfiguration - PaymentControlConfiguration [BITMAP16]
  • cutOffValue - INT32U

zcl prepayment chg-pmt-mode-resp [friendlyCredit:1] [friendlyCreditCalendarId:4] [emergencyCreditLimit:4] [emergencyCreditThreshold:4]

• This command is send in response to the ChangePaymentMode Command.
  • friendlyCredit - FriendlyCredit [BITMAP8]
  • friendlyCreditCalendarId - INT32U
  • emergencyCreditLimit - INT32U
  • emergencyCreditThreshold - INT32U

zcl prepayment cons-top-up [originatingDevice:1] [topUpCode:-1]

• The ConsumerTopUp command is used by the IPD and the ESI as a method of applying credit top up values to the prepayment meter.
  • originatingDevice - OriginatingDevice [ENUM8]
  • topUpCode - OCTET_STRING

    See also

    EmberAfOriginatingDevice

zcl prepayment cons-top-up-resp [resultType:1] [topUpValue:4] [sourceOfTopUp:1] [creditRemaining:4]

• This command is send in response to the ConsumerTopUp Command.
  • resultType - ResultType [ENUM8]
  • topUpValue - INT32U
  • sourceOfTopUp - OriginatingDevice [ENUM8]
  • creditRemaining - INT32U

    See also

    EmberAfResultType EmberAfOriginatingDevice

zcl prepayment cred-adj [issuerEventId:4] [startTime:4] [creditAdjustmentType:1] [creditAdjustmentValue:4]

• The CreditAdjustment command is sent to update the accounting base for the Prepayment meter.
  • issuerEventId - INT32U
  • startTime - UTC_TIME
  • creditAdjustmentType - CreditAdjustmentType [ENUM8]
  • creditAdjustmentValue - INT32U

    See also

    EmberAfCreditAdjustmentType

zcl prepayment em-cred-setup [issuerEventId:4] [startTime:4] [emergencyCreditLimit:4] [emergencyCreditThreshold:4]

• This command is a method to set up the parameters for the emergency credit.
  • issuerEventId - INT32U
  • startTime - UTC_TIME
  • emergencyCreditLimit - INT32U
  • emergencyCreditThreshold - INT32U

zcl prepayment get-debt-repmt-log [latestEndTime:4] [numberOfDebts:1] [debtType:1]

• This command is used to request the contents of the repayment log.
  • latestEndTime - UTC_TIME
  • numberOfDebts - INT8U
  • debtType - RepaymentDebtType [ENUM8]

    See also

    EmberAfRepaymentDebtType

zcl prepayment get-pp-ss [earliestStartTime:4] [latestEndTime:4] [snapshotOffset:1] [snapshotCause:4]

• This command is used to request the cluster server for snapshot data.
  • earliestStartTime - UTC_TIME
  • latestEndTime - UTC_TIME
  • snapshotOffset - INT8U
  • snapshotCause - PrepaySnapshotPayloadCause [BITMAP32]

zcl prepayment get-top-up-log [latestEndTime:4] [numberOfRecords:1]

• This command is sent to the Metering Device to retrieve the log of Top Up codes received by the meter.
  • latestEndTime - UTC_TIME
  • numberOfRecords - INT8U

zcl prepayment pub-debt-log [commandIndex:1] [totalNumberOfCommands:1] [debtPayload:13]

• This command is used to send the contents of the Repayment Log.
  • commandIndex - INT8U
  • totalNumberOfCommands - INT8U
  • debtPayload - struct DebtPayload

zcl prepayment pub-prep-ss [snapshotId:4] [snapshotTime:4] [totalSnapshotsFound:1] [commandIndex:1] [totalNumberOfCommands:1] [snapshotCause:4] [snapshotPayloadType:1] [snapshotPayload:1]

• This command is generated in response to a GetPrepaySnapshot command. It is used to return a single snapshot to the client.
  • snapshotId - INT32U
  • snapshotTime - UTC_TIME
  • totalSnapshotsFound - INT8U
  • commandIndex - INT8U
  • totalNumberOfCommands - INT8U
  • snapshotCause - PrepaySnapshotPayloadCause [BITMAP32]
  • snapshotPayloadType - PrepaySnapshotPayloadType [ENUM8]
  • snapshotPayload - INT8U

    See also

    EmberAfPrepaySnapshotPayloadType

zcl prepayment pub-top-up-log [commandIndex:1] [totalNumberOfCommands:1] [topUpPayload:7]

• This command is used to send the Top Up Code Log entries to the client.
  • commandIndex - INT8U
  • totalNumberOfCommands - INT8U
  • topUpPayload - struct TopUpPayload

zcl prepayment sel-av-em-cred [commandIssueDateTime:4] [originatingDevice:1] [siteId:-1] [meterSerialNumber:-1]

• This command is sent to the Metering Device to activate the use of any Emergency Credit available on the Metering Device.
  • commandIssueDateTime - UTC_TIME
  • originatingDevice - OriginatingDevice [ENUM8]
  • siteId - OCTET_STRING
  • meterSerialNumber - OCTET_STRING

    See also

    EmberAfOriginatingDevice

zcl prepayment set-low-cred-wng-lvl [lowCreditWarningLevel:4]

• This command is sent from client to a Prepayment server to set the warning level for low credit.
  • lowCreditWarningLevel - INT32U

zcl prepayment set-max-cred-lmt [providerId:4] [issuerEventId:4] [implementationDateTime:4] [maximumCreditLevel:4] [maximumCreditPerTopUp:4]

• This command is sent from a client to the Prepayment server to set the maximum credit level allowed in the meter.
  • providerId - INT32U
  • issuerEventId - INT32U
  • implementationDateTime - UTC_TIME
  • maximumCreditLevel - INT32U
  • maximumCreditPerTopUp - INT32U

zcl prepayment set-oa-debt-cap [providerId:4] [issuerEventId:4] [implementationDateTime:4] [overallDebtCap:4]

• This command is sent from a client to the Prepayment server to set the overall debt cap allowed in the meter.
  • providerId - INT32U
  • issuerEventId - INT32U
  • implementationDateTime - UTC_TIME
  • overallDebtCap - INT32U