Cluster Commands: Prepayment#

This group describes the CLI commands for the Prepayment cluster. Listed below is a description of the cluster:

The Prepayment Cluster provides the facility to pass messages relating to prepayment between devices on the HAN.

Macros#

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_SEL_AV_EM_CRED#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_SEL_AV_EM_CRED

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


Definition at line 1603 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_CHG_DEBT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_CHG_DEBT

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


Definition at line 1622 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_EM_CRED_SETUP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_EM_CRED_SETUP

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


Definition at line 1631 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_CONS_TOP_UP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_CONS_TOP_UP

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.


Definition at line 1640 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_CRED_ADJ#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_CRED_ADJ

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


Definition at line 1651 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_CHG_PMT_MODE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_CHG_PMT_MODE

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


Definition at line 1661 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_GET_PP_SS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_GET_PP_SS

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]


Definition at line 1670 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_GET_TOP_UP_LOG#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_GET_TOP_UP_LOG

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


Definition at line 1677 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_SET_LOW_CRED_WNG_LVL#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_SET_LOW_CRED_WNG_LVL

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


Definition at line 1683 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_GET_DEBT_REPMT_LOG#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_GET_DEBT_REPMT_LOG

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

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


Definition at line 1693 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_SET_MAX_CRED_LMT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_SET_MAX_CRED_LMT

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


Definition at line 1703 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_SET_OA_DEBT_CAP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_SET_OA_DEBT_CAP

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


Definition at line 1712 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_PUB_PREP_SS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_PUB_PREP_SS

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


Definition at line 1727 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_CHG_PMT_MODE_RESP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_CHG_PMT_MODE_RESP

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


Definition at line 1736 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_CONS_TOP_UP_RESP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_CONS_TOP_UP_RESP

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

  • This command is send in response to the ConsumerTopUp Command.


Definition at line 1748 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_PUB_TOP_UP_LOG#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_PUB_TOP_UP_LOG

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


Definition at line 1756 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_PUB_DEBT_LOG#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PREPAYMENT_PUB_DEBT_LOG

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


Definition at line 1764 of file app/framework/test/headers/cli.doc