Prepayment Snapshot Storage#
API and Callbacks for the Prepayment Snapshot Storage Component.
This component implements storage for the prepayment snapshots.
Modules#
EmberAfPrepaymentSnapshotPayload
EmberAfPrepaymentSnapshotSchedulePayload
API#
EmberStatus
emberAfPluginPrepaymentSnapshotStoragePublishSnapshot(EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint32_t snapshotTableIndex)
Publish prepayment snapshot.
uint32_t
emberAfPluginPrepaymentSnapshotStorageTakeSnapshot(uint8_t endpoint, uint32_t snapshotCause)
Take prepayment snapshot.
Enumerations#
enum
SNAPSHOT_CAUSE_GENERAL = ( ((uint32_t)1) << 0)
SNAPSHOT_CAUSE_END_OF_BILLING_PERIOD = ( ((uint32_t)1) << 1)
SNAPSHOT_CAUSE_CHANGE_OF_TARIFF_INFO = ( ((uint32_t)1) << 3)
SNAPSHOT_CAUSE_CHANGE_OF_PRICE_MATRIX = ( ((uint32_t)1) << 4)
SNAPSHOT_CAUSE_MANUALLY_TRIGGERED_FROM_CLIENT = ( ((uint32_t)1) << 10)
SNAPSHOT_CAUSE_CHANGE_OF_TENANCY = ( ((uint32_t)1) << 12)
SNAPSHOT_CAUSE_CHANGE_OF_SUPPLIER = ( ((uint32_t)1) << 13)
SNAPSHOT_CAUSE_CHANGE_OF_METER_MODE = ( ((uint32_t)1) << 14)
SNAPSHOT_CAUSE_TOP_UP_ADDITION = ( ((uint32_t)1) << 18)
SNAPSHOT_CAUSE_DEBT_OR_CREDIT_ADDITION = ( ((uint32_t)1) << 19)
}
Defined snapshot causes.
API Documentation#
emberAfPluginPrepaymentSnapshotStoragePublishSnapshot#
EmberStatus emberAfPluginPrepaymentSnapshotStoragePublishSnapshot (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint32_t snapshotTableIndex)
Publish prepayment snapshot.
Parameters
| N/A | nodeId | Ver.: always |
| N/A | srcEndpoint | Ver.: always |
| N/A | dstEndpoint | Ver.: always |
| N/A | snapshotTableIndex | Ver.: always |
Returns
EmberStatus status code
Definition at line
101 of file app/framework/plugin/prepayment-snapshot-storage/prepayment-snapshot-storage.hemberAfPluginPrepaymentSnapshotStorageTakeSnapshot#
uint32_t emberAfPluginPrepaymentSnapshotStorageTakeSnapshot (uint8_t endpoint, uint32_t snapshotCause)
Take prepayment snapshot.
Parameters
| N/A | endpoint | Ver.: always |
| N/A | snapshotCause | Ver.: always |
Returns
uin32_t snapshot ID
Definition at line
114 of file app/framework/plugin/prepayment-snapshot-storage/prepayment-snapshot-storage.hEnumeration Documentation#
SnapshotCause#
SnapshotCause
Defined snapshot causes.
| Enumerator | |
|---|---|
| SNAPSHOT_CAUSE_GENERAL | |
| SNAPSHOT_CAUSE_END_OF_BILLING_PERIOD | |
| SNAPSHOT_CAUSE_CHANGE_OF_TARIFF_INFO | |
| SNAPSHOT_CAUSE_CHANGE_OF_PRICE_MATRIX | |
| SNAPSHOT_CAUSE_MANUALLY_TRIGGERED_FROM_CLIENT | |
| SNAPSHOT_CAUSE_CHANGE_OF_TENANCY | |
| SNAPSHOT_CAUSE_CHANGE_OF_SUPPLIER | |
| SNAPSHOT_CAUSE_CHANGE_OF_METER_MODE | |
| SNAPSHOT_CAUSE_TOP_UP_ADDITION | |
| SNAPSHOT_CAUSE_DEBT_OR_CREDIT_ADDITION | |
Definition at line
42 of file app/framework/plugin/prepayment-snapshot-storage/prepayment-snapshot-storage.hMacro Definition Documentation#
INVALID_SNAPSHOT_ID#
#define INVALID_SNAPSHOT_IDValue:
0
Definition at line
36 of file app/framework/plugin/prepayment-snapshot-storage/prepayment-snapshot-storage.hINVALID_SNAPSHOT_SCHEDULE_ID#
#define INVALID_SNAPSHOT_SCHEDULE_IDValue:
0
Definition at line
37 of file app/framework/plugin/prepayment-snapshot-storage/prepayment-snapshot-storage.hSNAPSHOT_CAUSE_ALL_SNAPSHOTS#
#define SNAPSHOT_CAUSE_ALL_SNAPSHOTSValue:
0xFFFFFFFF
Definition at line
58 of file app/framework/plugin/prepayment-snapshot-storage/prepayment-snapshot-storage.h