Refactor Zigbee event mapping CDDL to reuse zigbee-property definition

Author: rohitmohan96

cddl/zigbee-event-map.cddl

@@ -6,25 +6,15 @@ zigbee-event-map = zigbee-attribute-reporting / zigbee-write-event / zigbee-conn
 
 zigbee-attribute-reporting = {
   type: "attribute_reporting",
-  endpointID: uint,
-  clusterID: uint,
-  attributeID: uint,
-  attributeType: uint,
-  ? profileID: uint,
-  ? manufacturerCode: uint,
+  ~zigbee-property,
   ? minReportingInterval: uint,
   ? maxReportingInterval: uint,
   ? reportableChange: number,
 }
 
 zigbee-write-event = {
   type: "write_event",
-  endpointID: uint,
-  clusterID: uint,
-  attributeID: uint,
-  attributeType: uint,
-  ? profileID: uint,
-  ? manufacturerCode: uint,
+  ~zigbee-property,
 }
 
 zigbee-connection-event = {

draft-ietf-asdf-sdf-protocol-mapping.md

@@ -542,7 +542,9 @@ follows:
 
 An `sdfEvent` is mapped to a Zigbee cluster event such as attribute reporting
 or a device-initiated write to an attribute on the gateway. The Zigbee event
-protocol mapping structure is defined as follows:
+protocol mapping structure is defined as follows. The `"attribute_reporting"`
+and `"write_event"` variants reuse the `zigbee-property` definition from
+{{zigmap1}} to identify the underlying Zigbee attribute:
 
 ~~~ cddl
 {::include-fold cddl/zigbee-event-map.cddl}
@@ -558,21 +560,10 @@ Where:
     attribute on the gateway.
   - `"connection_events"`: the event is triggered when a Zigbee end device
     joins or leaves the Zigbee network.
-- `endpointID` is the Zigbee endpoint ID that corresponds to the SDF event.
-  It is required when `type` is `"attribute_reporting"` or `"write_event"`.
-- `clusterID` is the Zigbee cluster ID that corresponds to the SDF event.
-  It is required when `type` is `"attribute_reporting"` or `"write_event"`.
-- `attributeID` is the Zigbee attribute ID that corresponds to the SDF event.
-  It is required when `type` is `"attribute_reporting"` or `"write_event"`.
-- `attributeType` is the Zigbee data type of the attribute. It is required
-  when `type` is `"attribute_reporting"` or `"write_event"`.
-- `profileID` is the Zigbee application profile ID (optional). It only
-  applies when `type` is `"attribute_reporting"` or `"write_event"`. If not
-  provided, it defaults to the Home Automation profile (0x0104), which is the
-  default profile in Zigbee 3.0.
-- `manufacturerCode` is the Zigbee manufacturer code of the attribute
-  (optional). It only applies when `type` is `"attribute_reporting"` or
-  `"write_event"`.
+- `endpointID`, `clusterID`, `attributeID`, `attributeType`, `profileID`, and
+  `manufacturerCode` have the same meaning as described for `sdfProperty` in
+  {{zigmap1}}. These fields are present when `type` is `"attribute_reporting"`
+  or `"write_event"`, and MUST be absent when `type` is `"connection_events"`.
 - `minReportingInterval` is the minimum reporting interval in seconds
   (optional). It is the minimum time between issued attribute reports and
   only applies when `type` is `"attribute_reporting"`.
@@ -581,10 +572,12 @@ Where:
   only applies when `type` is `"attribute_reporting"`.
 - `reportableChange` is the minimum change to the attribute value that triggers
   a report (optional). It only applies when `type` is `"attribute_reporting"`
-  and to attributes with an 'analog' data type, and MUST have the same data type
-  as the reported attribute.
-
-When `type` is `"connection_events"`, no other attributes are required.
+  and to attributes whose `attributeType` is one of the "analog" data types
+  defined by the Zigbee Cluster Library, part of {{Zigbee30}} (e.g., unsigned
+  and signed integers, floating point numbers), as opposed to "discrete" data types
+  (e.g., booleans, enumerations, bitmaps), for which reporting a minimum
+  change is not meaningful. The encoded value MUST use the same Zigbee data type
+  as the reported attribute's `attributeType`.
 
 For example, a Zigbee event mapping for a temperature change report:
 

generated/combined.cddl

@@ -64,25 +64,15 @@ zigbee-event-map = zigbee-attribute-reporting / zigbee-write-event / zigbee-conn
 
 zigbee-attribute-reporting = {
   type: "attribute_reporting",
-  endpointID: uint,
-  clusterID: uint,
-  attributeID: uint,
-  attributeType: uint,
-  ? profileID: uint,
-  ? manufacturerCode: uint,
+  ~zigbee-property,
   ? minReportingInterval: uint,
   ? maxReportingInterval: uint,
   ? reportableChange: number,
 }
 
 zigbee-write-event = {
   type: "write_event",
-  endpointID: uint,
-  clusterID: uint,
-  attributeID: uint,
-  attributeType: uint,
-  ? profileID: uint,
-  ? manufacturerCode: uint,
+  ~zigbee-property,
 }
 
 zigbee-connection-event = {

openapi/ProtocolMap-Zigbee.yaml

@@ -59,6 +59,7 @@ components:
                 - endpointID
                 - clusterID
                 - attributeID
+                - attributeType
               properties:
                 type:
                   type: string
@@ -105,6 +106,7 @@ components:
                 - endpointID
                 - clusterID
                 - attributeID
+                - attributeType
               properties:
                 type:
                   type: string