EmberAfPluginReportingEntry Struct Reference
Ember Application Framework API Reference > Application Framework Types

A structure used to store reporting configurations. If endpoint field is EMBER_AF_PLUGIN_REPORTING_UNUSED_ENDPOINT_ID , the entry is unused.

#include < af-types.h >

Data Fields

EmberAfReportingDirection direction
uint8_t endpoint
EmberAfClusterId clusterId
EmberAfAttributeId attributeId
uint8_t mask
uint16_t manufacturerCode
union {
struct {
uint16_t minInterval
uint16_t maxInterval
uint32_t reportableChange
} reported
struct {
EmberNodeId source
uint8_t endpoint
uint16_t timeout
} received
} data

A structure used to store reporting configurations. If endpoint field is EMBER_AF_PLUGIN_REPORTING_UNUSED_ENDPOINT_ID , the entry is unused.

Field Documentation

EmberAfAttributeId EmberAfPluginReportingEntry::attributeId

The id of the attribute being reported or received.

EmberAfClusterId EmberAfPluginReportingEntry::clusterId

The cluster where the attribute is located.

union { ... } EmberAfPluginReportingEntry::data
EmberAfReportingDirection EmberAfPluginReportingEntry::direction

EMBER_ZCL_REPORTING_DIRECTION_REPORTED for reports sent from the local device or EMBER_ZCL_REPORTING_DIRECTION_RECEIVED for reports received from a remote device.

uint8_t EmberAfPluginReportingEntry::endpoint

The local endpoint from which the attribute is reported or to which the report is received. If EMBER_AF_PLUGIN_REPORTING_UNUSED_ENDPOINT_ID , the entry is unused.

The remote endpoint from which the attribute is reported.

uint16_t EmberAfPluginReportingEntry::manufacturerCode

Manufacturer code associated with the cluster and/or attribute. If the cluster id is inside the manufacturer-specific range, this value indicates the manufacturer code for the cluster. Otherwise, if this value is non-zero and the cluster id is a standard ZCL cluster, it indicates the manufacturer code for attribute.

uint8_t EmberAfPluginReportingEntry::mask

CLUSTER_MASK_SERVER for server-side attributes or CLUSTER_MASK_CLIENT for client-side attributes.

uint16_t EmberAfPluginReportingEntry::maxInterval

The maximum reporting interval, measured in seconds.

uint16_t EmberAfPluginReportingEntry::minInterval

The minimum reporting interval, measured in seconds.

struct { ... } EmberAfPluginReportingEntry::received
uint32_t EmberAfPluginReportingEntry::reportableChange

The minimum change to the attribute that will result in a report being sent.

struct { ... } EmberAfPluginReportingEntry::reported
EmberNodeId EmberAfPluginReportingEntry::source

The node id of the source of the received reports.

uint16_t EmberAfPluginReportingEntry::timeout

The maximum expected time between reports, measured in seconds.

The documentation for this struct was generated from the following file:
  • af-types.h