Cluster Commands: Simple Metering#

This group describes the CLI commands for the Simple Metering cluster. Listed below is a description of the cluster: The Metering Cluster provides a mechanism to retrieve usage information from Electric, Gas, Water, and potentially Thermal metering devices.

Macros#

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_REQUEST_MIRROR

zcl metering request-mirror

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_REMOVE_MIRROR

zcl metering remove-mirror

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_SCH_SNAPSHOT_RESP

zcl metering sch-snapshot-resp [issuerEventId:4] [snapshotResponsePayload:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_TAKE_SNAPSHOT_RESP

zcl metering take-snapshot-resp [snapshotId:4] [snapshotConfirmation:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_PUB_SS

zcl metering pub-ss [snapshotId:4] [snapshotTime:4] [totalSnapshotsFound:1] [commandIndex:1] [totalCommands:1] [snapshotCause:4] [snapshotPayloadType:1] [snapshotPayload:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_CFG_MIRROR

zcl metering cfg-mirror [issuerEventId:4] [reportingInterval:3] [mirrorNotificationReporting:1] [notificationScheme:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_CFG_NFT_SCHEME

zcl metering cfg-nft-scheme [issuerEventId:4] [notificationScheme:1] [notificationFlagOrder:4]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_CFG_NFT_FLAGS

zcl metering cfg-nft-flags [issuerEventId:4] [notificationScheme:1] [notificationFlagAttributeId:2] [clusterId:2] [manufacturerCode:2] [numberOfCommands:1] [commandIds:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_GET_NTFY_MSG

zcl metering get-ntfy-msg [notificationScheme:1] [notificationFlagAttributeId:2] [notificationFlagsN:4]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_SUP_STAT_RSP

zcl metering sup-stat-rsp [providerId:4] [issuerEventId:4] [implementationDateTime:4] [supplyStatus:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_START_SAMP_RSP

zcl metering start-samp-rsp [sampleId:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_GET_PROFILE

zcl metering get-profile [intervalChannel:1] [endTime:4] [numberOfPeriods:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_MIRROR_REMOVED

zcl metering mirror-removed [endpointId:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_REQ_FAST_POLL_MODE

zcl metering req-fast-poll-mode [fastPollUpdatePeriod:1] [duration:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_SCH_SNAPSHOT

zcl metering sch-snapshot [issuerEventId:4] [commandIndex:1] [commandCount:1] [snapshotSchedulePayload:13]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_TAKE_SNAPSHOT

zcl metering take-snapshot [snapshotCause:4]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_GET_SNAPSHOT

zcl metering get-snapshot [earliestStartTime:4] [latestEndTime:4] [snapshotOffset:1] [snapshotCause:4]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_START_SAMPLING

zcl metering start-sampling [issuerEventId:4] [startSamplingTime:4] [sampleType:1] [sampleRequestInterval:2] [maxNumberOfSamples:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_GET_SAMPLED_DATA

zcl metering get-sampled-data [sampleId:2] [earliestSampleTime:4] [sampleType:1] [numberOfSamples:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_RST_LOAD_LIMIT_CTR

zcl metering rst-load-limit-ctr [providerId:4] [issuerEventId:4]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_CHG_SUPPLY

zcl metering chg-supply [providerId:4] [issuerEventId:4] [requestDateTime:4] [implementationDateTime:4] [proposedSupplyStatus:1] [supplyControlBits:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_LOCAL_CHG_SUPPLY

zcl metering local-chg-supply [proposedSupplyStatus:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_SET_SUPPLY_STATUS

zcl metering set-supply-status [issuerEventId:4] [supplyTamperState:1] [supplyDepletionState:1] [supplyUncontrolledFlowState:1] [loadLimitSupplyState:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_SIMPLE_METERING_SET_UNCNTRL_FLOW_THRESHOLD

zcl metering set-uncntrl-flow-threshold [providerId:4] [issuerEventId:4] [uncontrolledFlowThreshold:2] [unitOfMeasure:1] [multiplier:2] [divisor:2] [stabilisationPeriod:1] [measurementPeriod:2]