Developing with ZBOSS for Zigbee
zb_zcl_metering_publish_snapshot_payload_s Struct Reference

#include <zb_zcl_metering.h>

Data Fields

zb_uint32_t snapshot_id
 
zb_uint32_t snapshot_time
 
zb_uint8_t total_snapshots_found
 
zb_uint8_t command_index
 
zb_uint8_t total_number_of_commands
 
zb_uint32_t snapshot_cause
 
zb_uint8_t snapshot_payload_type
 
zb_zcl_metering_snapshot_sub_payload_t snapshot_sub_payload
 

Detailed Description

PublishSnapshot command payload

See also
SE spec, subclause D.3.2.3.1.7

Field Documentation

◆ command_index

zb_uint8_t zb_zcl_metering_publish_snapshot_payload_s::command_index

The CommandIndex is used to count the payload fragments in the case where the entire payload (snapshot) does not fit into one message

◆ snapshot_cause

zb_uint32_t zb_zcl_metering_publish_snapshot_payload_s::snapshot_cause

A 32-bit BitMap indicating the cause of the snapshot

◆ snapshot_id

zb_uint32_t zb_zcl_metering_publish_snapshot_payload_s::snapshot_id

Unique identifier allocated by the device creating the snapshot.

◆ snapshot_payload_type

zb_uint8_t zb_zcl_metering_publish_snapshot_payload_s::snapshot_payload_type

The SnapshotPayloadType is an 8-bit enumerator defining the format of the Snapshot Sub-Payload in this message.

◆ snapshot_sub_payload

zb_zcl_metering_snapshot_sub_payload_t zb_zcl_metering_publish_snapshot_payload_s::snapshot_sub_payload

◆ snapshot_time

zb_uint32_t zb_zcl_metering_publish_snapshot_payload_s::snapshot_time

This is a 32-bit value (in UTC Time) representing the time at which the data snapshot was taken.

◆ total_number_of_commands

zb_uint8_t zb_zcl_metering_publish_snapshot_payload_s::total_number_of_commands

In the case where the entire payload (snapshot) does not fit into one message, the Total Number of Commands field indicates the total number of sub-commands that will be returned.

◆ total_snapshots_found

zb_uint8_t zb_zcl_metering_publish_snapshot_payload_s::total_snapshots_found

An 8-bit Integer indicating the number of snapshots found, based on the search criteria defined in the associated GetSnapshot command.


The documentation for this struct was generated from the following file: