Cluster Commands: Prepayment#

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

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

  • EmberAfDebtRecoveryMethodEmberAfDebtAmountTypeEmberAfDebtRecoveryFrequency

This command is a method to set up the parameters for the emergency credit.

• issuerEventId - INT32U

• startTime - UTC_TIME

• emergencyCreditLimit - INT32U

• emergencyCreditThreshold - INT32U

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

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

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

This command is used to request the cluster server for snapshot data.

• earliestStartTime - UTC_TIME

• latestEndTime - UTC_TIME

• snapshotOffset - INT8U

• snapshotCause - PrepaySnapshotPayloadCause [BITMAP32]

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

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

• lowCreditWarningLevel - INT32U

This command is used to request the contents of the repayment log.

• latestEndTime - UTC_TIME

• numberOfDebts - INT8U

• debtType - RepaymentDebtType [ENUM8] See Also

  • EmberAfRepaymentDebtType

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

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

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

This command is send in response to the ChangePaymentMode Command.

• friendlyCredit - FriendlyCredit [BITMAP8]

• friendlyCreditCalendarId - INT32U

• emergencyCreditLimit - INT32U

• emergencyCreditThreshold - INT32U

This command is send in response to the ConsumerTopUp Command.

• resultType - ResultType [ENUM8]

• topUpValue - INT32U

• sourceOfTopUp - OriginatingDevice [ENUM8]

• creditRemaining - INT32U See Also

  • EmberAfResultTypeEmberAfOriginatingDevice

This command is used to send the Top Up Code Log entries to the client.

• commandIndex - INT8U

• totalNumberOfCommands - INT8U

• topUpPayload - struct TopUpPayload

This command is used to send the contents of the Repayment Log.

• commandIndex - INT8U

• totalNumberOfCommands - INT8U

• debtPayload - struct DebtPayload