Plugin Commands: Simple Metering Client
Zigbee Application Framework Command Line Interface (CLI)

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SIMPLE_METERING_CLIENT_PLUGIN_SIMPLE_METERING_CLIENT_GET_SAMPLED_DATA
plugin simple-metering-client get-sampled-data [server:2] [clientEndpoint:1] [serverEndpoint:1] [sampleId:2] [startTime:4] [sampleType:1] [numberOfSamples:2]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SIMPLE_METERING_CLIENT_PLUGIN_SIMPLE_METERING_CLIENT_LOCAL_CHANGE_SUPPLY
plugin simple-metering-client local-change-supply [server:2] [clientEndpoint:1] [serverEndpoint:1] [proposedSupplyStatus:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SIMPLE_METERING_CLIENT_PLUGIN_SIMPLE_METERING_CLIENT_SCH_SNAPSHOT
plugin simple-metering-client sch-snapshot [server:2] [clientEndpoint:1] [serverEndpoint:1] [issuerId:4] [commandIndex:1] [numberofCommands:1] [snapshotScheduleId:1] [snapshotStartDate:4] [snapshotSchedule:4] [snapshotType:1] [snapshotCause:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SIMPLE_METERING_CLIENT_PLUGIN_SIMPLE_METERING_CLIENT_START_SAMPLING
plugin simple-metering-client start-sampling [server:2] [clientEndpoint:1] [serverEndpoint:1] [issuerId:4] [startTime:4] [sampleType:1] [SampleRequestInterval:2] [maxNumberOfSamples:2]

Detailed Description

The simple-metering-client plugin contributes CLI commands to the application framework to be used in conjunction with the Simple Metering cluster in a client context.

Macro Definition Documentation

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SIMPLE_METERING_CLIENT_PLUGIN_SIMPLE_METERING_CLIENT_GET_SAMPLED_DATA

plugin simple-metering-client get-sampled-data [server:2] [clientEndpoint:1] [serverEndpoint:1] [sampleId:2] [startTime:4] [sampleType:1] [numberOfSamples:2]

  • Send a start sampling command to a metering server.
    • server - INT16U - The network address of the server to which the request will be sent.
    • clientEndpoint - INT8U - The local endpoint from which the request will be sent.
    • serverEndpoint - INT8U - The remote endpoint to which the request will be sent.
    • sampleId - INT16U - The sample id as received in a previous startSamplingResponse
    • startTime - INT32U - The earliest start time sampling
    • sampleType - INT8U - An 8 bit enumeration that identifies the required type of sampled data
    • numberOfSamples - INT16U - The total number of samples.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SIMPLE_METERING_CLIENT_PLUGIN_SIMPLE_METERING_CLIENT_LOCAL_CHANGE_SUPPLY

plugin simple-metering-client local-change-supply [server:2] [clientEndpoint:1] [serverEndpoint:1] [proposedSupplyStatus:1]

  • Send a start sampling command to a metering server.
    • server - INT16U - The network address of the server to which the request will be sent.
    • clientEndpoint - INT8U - The local endpoint from which the request will be sent.
    • serverEndpoint - INT8U - The remote endpoint to which the request will be sent.
    • proposedSupplyStatus - INT8U - The proposed supply status: either ON(2) or OFF/ARMED(1)
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SIMPLE_METERING_CLIENT_PLUGIN_SIMPLE_METERING_CLIENT_SCH_SNAPSHOT

plugin simple-metering-client sch-snapshot [server:2] [clientEndpoint:1] [serverEndpoint:1] [issuerId:4] [commandIndex:1] [numberofCommands:1] [snapshotScheduleId:1] [snapshotStartDate:4] [snapshotSchedule:4] [snapshotType:1] [snapshotCause:4]

  • Schedule a snapshot.
    • server - INT16U - The network address of the server to which the request will be sent.
    • clientEndpoint - INT8U - The local endpoint from which the request will be sent.
    • serverEndpoint - INT8U - The remote endpoint to which the request will be sent.
    • issuerId - INT32U - The issuerId.
    • commandIndex - INT8U - The commandIndex.
    • numberofCommands - INT8U - The total number of commands
    • snapshotScheduleId - INT8U - The snapshot schedule Id.
    • snapshotStartDate - INT32U - The start time.
    • snapshotSchedule - INT32U - The snapshot schedule. 3 bytes
    • snapshotType - INT8U - The snapshot Type.
    • snapshotCause - INT32U - The snapshot schedule cause.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SIMPLE_METERING_CLIENT_PLUGIN_SIMPLE_METERING_CLIENT_START_SAMPLING

plugin simple-metering-client start-sampling [server:2] [clientEndpoint:1] [serverEndpoint:1] [issuerId:4] [startTime:4] [sampleType:1] [SampleRequestInterval:2] [maxNumberOfSamples:2]

  • Send a start sampling command to a metering server.
    • server - INT16U - The network address of the server to which the request will be sent.
    • clientEndpoint - INT8U - The local endpoint from which the request will be sent.
    • serverEndpoint - INT8U - The remote endpoint to which the request will be sent.
    • issuerId - INT32U - The issuerId.
    • startTime - INT32U - The time to start sampling
    • sampleType - INT8U - An 8 bit enumeration that identifies the type of data being sampled
    • SampleRequestInterval - INT16U - An unsigned 16-bit field representing the interval or time in seconds between samples.
    • maxNumberOfSamples - INT16U - A 16 bit unsigned integer that represents the number of samples to be taken.