Prepayment Server#
API and Callbacks for the Prepayment Cluster Server Component.
This component implements the server-side functionality of the Smart Energy 1.2 Prepayment cluster.
Modules#
API#
Send a publish prepay snapshot command sent in response to the get prepay snapshot command.
Send a publish top up log command, sent when a top up is performed or in response to a get top up log command.
Send a publish debt log command.
Enumerations#
Macros#
API Documentation#
emberAfPluginPrepaymentServerPublishPrepaySnapshot#
void emberAfPluginPrepaymentServerPublishPrepaySnapshot (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint32_t snapshotId, uint32_t snapshotTime, uint8_t totalSnapshotsFound, uint8_t commandIndex, uint8_t totalNumberOfCommands, uint32_t snapshotCause, uint8_t snapshotPayloadType, uint8_t *snapshotPayload)
Send a publish prepay snapshot command sent in response to the get prepay snapshot command.
| N/A | nodeId | The short address of the destination device. |
| N/A | srcEndpoint | The source endpoint used in the ZigBee transmission. |
| N/A | dstEndpoint | The destination endpoint used in the ZigBee transmission. |
| N/A | snapshotId | A unique identifier allocated by the device that created the snapshot. |
| N/A | snapshotTime | The UTC time when the snapshot was taken. |
| N/A | totalSnapshotsFound | The number of snapshots that matched the criteria in the received Get Prepay Snapshot command. |
| N/A | commandIndex | Indicates a fragment number if the entire payload won't fit into 1 message. |
| N/A | totalNumberOfCommands | The total number of subcommands that will be sent. |
| N/A | snapshotCause | A 32-bit bitmap that indicates the cause of the snapshot. |
| N/A | snapshotPayloadType | An 8-bit enumeration that defines the format of the snapshot payload. |
| N/A | snapshotPayload | Data that was created with the snapshot. |
70 of file app/framework/plugin/prepayment-server/prepayment-server.hemberAfPluginPrepaymentServerPublishTopUpLog#
void emberAfPluginPrepaymentServerPublishTopUpLog (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t commandIndex, uint8_t totalNumberOfCommands, TopUpPayload *topUpPayload)
Send a publish top up log command, sent when a top up is performed or in response to a get top up log command.
| N/A | nodeId | The short address of the destination device. |
| N/A | srcEndpoint | The source endpoint used in the ZigBee transmission. |
| N/A | dstEndpoint | The destination endpoint used in the ZigBee transmission. |
| N/A | commandIndex | Indicates a fragment number if the entire payload won't fit into 1 message. |
| N/A | totalNumberOfCommands | The total number of subcommands that will be sent. |
| N/A | topUpPayload | Information that is sent from each top up log entry. |
89 of file app/framework/plugin/prepayment-server/prepayment-server.hemberAfPluginPrepaymentServerPublishDebtLog#
void emberAfPluginPrepaymentServerPublishDebtLog (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t commandIndex, uint8_t totalNumberOfCommands, DebtPayload *debtPayload)
Send a publish debt log command.
| N/A | nodeId | The short address of the destination device. |
| N/A | srcEndpoint | The source endpoint used in the ZigBee transmission. |
| N/A | dstEndpoint | The destination endpoint used in the ZigBee transmission. |
| N/A | commandIndex | Indicates a fragment number if the entire payload won't fit into 1 message. |
| N/A | totalNumberOfCommands | The total number of subcommands that will be sent. |
| N/A | debtPayload | Includes the contents of a debt record from the log. |
103 of file app/framework/plugin/prepayment-server/prepayment-server.h