Meter Snapshot Server#

Callbacks for Meter Snapshot Server Component.

Callbacks#

void

emberAfPluginMeterSnapshotServerScheduleSnapshotCallback(uint8_t srcEndpoint, uint8_t dstEndpoint, EmberNodeId dest, uint8_t *snapshotPayload, uint8_t *responsePayload)

Schedule Snapshot.

uint32_t

emberAfPluginMeterSnapshotServerTakeSnapshotCallback(uint8_t endpoint, uint32_t snapshotCause, uint8_t *snapshotConfirmation)

Take Snapshot.

void

emberAfPluginMeterSnapshotServerGetSnapshotCallback(uint8_t srcEndpoint, uint8_t dstEndpoint, EmberNodeId dest, uint8_t *snapshotCriteria)

Get Snapshot.

Callbacks Documentation#

emberAfPluginMeterSnapshotServerScheduleSnapshotCallback#

void emberAfPluginMeterSnapshotServerScheduleSnapshotCallback (uint8_t srcEndpoint, uint8_t dstEndpoint, EmberNodeId dest, uint8_t *snapshotPayload, uint8_t *responsePayload)

Schedule Snapshot.

Parameters

N/A	srcEndpoint	Ver.: always
N/A	dstEndpoint	Ver.: always
N/A	dest	Ver.: always
N/A	snapshotPayload	Ver.: always
N/A	responsePayload	Ver.: always

This function is called by the Meter Snapshot server plugin whenever a ScheduleSnapshot command is received. A plugin implementing backhaul functionality for the snapshot mechanism should proceed to schedule the snapshot as required.

Definition at line 60 of file app/framework/plugin/meter-snapshot-server/meter-snapshot-server.h

emberAfPluginMeterSnapshotServerTakeSnapshotCallback#

uint32_t emberAfPluginMeterSnapshotServerTakeSnapshotCallback (uint8_t endpoint, uint32_t snapshotCause, uint8_t *snapshotConfirmation)

Take Snapshot.

Parameters

N/A	endpoint	Ver.: always
N/A	snapshotCause	Ver.: always
N/A	snapshotConfirmation	Ver.: always

This function is called by the Meter Snapshot server plugin whenever a TakeSnapshot command is received. A plugin implementing backhaul functionality for the snapshot mechanism should proceed to manually take a snapshot as required. If for some reason the snapshot could not be taken, this should be reflected in the snapshotConfirmation argument.

Definition at line 77 of file app/framework/plugin/meter-snapshot-server/meter-snapshot-server.h

emberAfPluginMeterSnapshotServerGetSnapshotCallback#

void emberAfPluginMeterSnapshotServerGetSnapshotCallback (uint8_t srcEndpoint, uint8_t dstEndpoint, EmberNodeId dest, uint8_t *snapshotCriteria)

Get Snapshot.

Parameters

N/A	srcEndpoint	Ver.: always
N/A	dstEndpoint	Ver.: always
N/A	dest	Ver.: always
N/A	snapshotCriteria	Ver.: always

This function is called by the Meter Snapshot server plugin whenever a GetSnapshot command is received. A plugin implementing backhaul functionality for the snapshot mechanism should proceed to retrieve the snapshot and send a PublishSnapshot command to the requesting client.

Definition at line 92 of file app/framework/plugin/meter-snapshot-server/meter-snapshot-server.h