@matter/model 0.13.0-alpha.0-20250318-c1aa38b08 → 0.13.0-alpha.0-20250323-770919c6a

package/src/standard/elements/DoorLockDT.ts

@@ -12,8 +12,8 @@ import { DeviceTypeElement as DeviceType, RequirementElement as Requirement } fr
 export const DoorLockDt = DeviceType(
     {
         name: "DoorLock", id: 0xa, category: "Closure", classification: "simple",
-        details: "A Door Lock is a device used to secure a door. It is possible to actuate a door lock either by " +
-            "means of a manual or a remote method.",
+        details: "A Door Lock is a device used to secure a door. It is possible to actuate a door lock either by means " +
+            "of a manual or a remote method.",
         xref: { document: "device", section: "8.1" }
     },
 

package/src/standard/elements/EcosystemInformation.ts

@@ -10,8 +10,8 @@ import { MatterDefinition } from "../MatterDefinition.js";
 import {
     ClusterElement as Cluster,
     AttributeElement as Attribute,
-    DatatypeElement as Datatype,
-    FieldElement as Field
+    FieldElement as Field,
+    DatatypeElement as Datatype
 } from "../../elements/index.js";
 
 export const EcosystemInformation = Cluster(
@@ -21,8 +21,8 @@ export const EcosystemInformation = Cluster(
         details: "The Ecosystem Information Cluster provides extended device information for all the logical devices " +
             "represented by a Bridged Node. The Ecosystem Information Cluster presents the view of device name " +
             "and location metadata for presentation by a client of the cluster to a user. This cluster is " +
-            "intended to support Fabric Synchronization and be present on an endpoint with the BridgedNode " +
-            "device type listed in the DeviceTypeList of the endpoint’s Descriptor cluster." +
+            "intended to support Fabric Synchronization and be present on an endpoint with the BridgedNode device " +
+            "type listed in the DeviceTypeList of the endpoint’s Descriptor cluster." +
             "\n" +
             "This augments the Bridged Device Basic Information Cluster in the following ways:" +
             "\n" +
@@ -52,13 +52,47 @@ export const EcosystemInformation = Cluster(
 
     Attribute({ name: "ClusterRevision", id: 0xfffd, type: "ClusterRevision", default: 1 }),
 
+    Attribute(
+        {
+            name: "DeviceDirectory", id: 0x0, type: "list", access: "R F M", conformance: "M", quality: "N",
+            details: "This attribute shall contain the list of logical devices represented by a Bridged Node. Most of the " +
+                "time this will contain a single entry, but may grow with more complex device compositions (e.g. " +
+                "another bridge.)" +
+                "\n" +
+                "An empty list indicates that the information is not available.",
+            xref: { document: "core", section: "9.18.5.1" }
+        },
+
+        Field({ name: "entry", type: "EcosystemDeviceStruct" })
+    ),
+
+    Attribute(
+        {
+            name: "LocationDirectory", id: 0x1, type: "list", access: "R F M", conformance: "M", quality: "N",
+
+            details: "This attribute shall contain the list of rooms, areas and groups associated with the DeviceDirectory " +
+                "entries, and shall NOT contain locations which are dynamically generated and removed by an " +
+                "ecosystem. (E.g. a location that is generated and removed based on the user being home is not " +
+                "permitted. However, an initially generated location name that does not quickly change is " +
+                "acceptable.)" +
+                "\n" +
+                "An empty list indicates that the information is not available." +
+                "\n" +
+                "LocationDirectory entries shall be removed if there is no DeviceDirectory that references it.",
+
+            xref: { document: "core", section: "9.18.5.2" }
+        },
+
+        Field({ name: "entry", type: "EcosystemLocationStruct" })
+    ),
+
     Datatype(
         { name: "EcosystemDeviceStruct", type: "struct", xref: { document: "core", section: "9.18.4.1" } },
 
         Field({
             name: "DeviceName", id: 0x0, type: "string", access: "S", conformance: "O", constraint: "max 64",
-            details: "This field shall indicate the device’s name, which is provided externally if the user consents. " +
-                "(For example, provided by the user in an ecosystem specific interface.)",
+            details: "This field shall indicate the device’s name, which is provided externally if the user consents. (For " +
+                "example, provided by the user in an ecosystem specific interface.)",
             xref: { document: "core", section: "9.18.4.1.1" }
         }),
 
@@ -83,19 +117,19 @@ export const EcosystemInformation = Cluster(
         Field({
             name: "OriginalEndpoint", id: 0x3, type: "endpoint-no", access: "S", conformance: "desc",
             constraint: "desc",
-            details: "This field shall indicate the endpoint this EcosystemDeviceStruct is associated with on the " +
-                "original device represented by this bridge’s Bridged Node. If this bridge is receiving the device " +
-                "from another bridge, then the OriginalEndpoint field value would be the same on both bridges. This " +
-                "field shall be present and set to a valid endpoint on the original device if that device is a " +
-                "Matter device.",
+            details: "This field shall indicate the endpoint this EcosystemDeviceStruct is associated with on the original " +
+                "device represented by this bridge’s Bridged Node. If this bridge is receiving the device from " +
+                "another bridge, then the OriginalEndpoint field value would be the same on both bridges. This field " +
+                "shall be present and set to a valid endpoint on the original device if that device is a Matter " +
+                "device.",
             xref: { document: "core", section: "9.18.4.1.4" }
         }),
 
         Field(
             {
                 name: "DeviceTypes", id: 0x4, type: "list", access: "S", conformance: "M", constraint: "desc",
-                details: "This field shall indicate all of the DeviceTypes within the DeviceTypeList in the Descriptor " +
-                    "Cluster associated with this EcosystemDeviceStruct entry." +
+                details: "This field shall indicate all of the DeviceTypes within the DeviceTypeList in the Descriptor Cluster " +
+                    "associated with this EcosystemDeviceStruct entry." +
                     "\n" +
                     "This field shall contain a list of valid device type ids.",
                 xref: { document: "core", section: "9.18.4.1.5" }
@@ -124,10 +158,10 @@ export const EcosystemInformation = Cluster(
                 "\n" +
                 "NOTE" +
                 "\n" +
-                "If multiple server instances update the UniqueLocationIDs field at the same time, it is possible " +
-                "one of the updates will be missed. This is considered an acceptable limitation to reduce the " +
-                "complexity of the design. Since this is meant to be provided from user input, it is unlikely these " +
-                "signals would be happening at one time.",
+                "If multiple server instances update the UniqueLocationIDs field at the same time, it is possible one " +
+                "of the updates will be missed. This is considered an acceptable limitation to reduce the complexity " +
+                "of the design. Since this is meant to be provided from user input, it is unlikely these signals " +
+                "would be happening at one time.",
 
             xref: { document: "core", section: "9.18.4.1.7" }
         }),
@@ -148,24 +182,24 @@ export const EcosystemInformation = Cluster(
                 "UniqueLocationID can be used by the client to determine if the change is a relocation of the device " +
                 "or just a renaming of the location." +
                 "\n" +
-                "No guarantees are given for consistency of the ID between server instances. The same location may " +
-                "be represented by different IDs on different Ecosystem Information Cluster server instances, so " +
-                "only the history from a single server instance should be considered when evaluating a change." +
+                "No guarantees are given for consistency of the ID between server instances. The same location may be " +
+                "represented by different IDs on different Ecosystem Information Cluster server instances, so only " +
+                "the history from a single server instance should be considered when evaluating a change." +
                 "\n" +
                 "UniqueLocationID shall be changed when the LocationDescriptor changes from one existing location to " +
-                "another location as a result of an external interaction. (For example, the user changes the " +
-                "location assignment.)" +
+                "another location as a result of an external interaction. (For example, the user changes the location " +
+                "assignment.)" +
                 "\n" +
-                "UniqueLocationID shall NOT be changed when the LocationDescriptor changes name, but still " +
-                "represents the same location. (For example, the user renames a room.)" +
+                "UniqueLocationID shall NOT be changed when the LocationDescriptor changes name, but still represents " +
+                "the same location. (For example, the user renames a room.)" +
                 "\n" +
                 "UniqueLocationID shall be changed when LocationDescriptor changes as a result of another Ecosystem " +
                 "Information Cluster server instance changing and the UniqueLocationID on the remote server instance " +
                 "also changes." +
                 "\n" +
                 "UniqueLocationID shall NOT be changed when LocationDescriptor changes as a result of another " +
-                "Ecosystem Information Cluster server instance changing and the UniqueLocationID on the remote " +
-                "server instance does not change.",
+                "Ecosystem Information Cluster server instance changing and the UniqueLocationID on the remote server " +
+                "instance does not change.",
 
             xref: { document: "core", section: "9.18.4.2.1" }
         }),
@@ -183,7 +217,13 @@ export const EcosystemInformation = Cluster(
             xref: { document: "core", section: "9.18.4.2.2" }
         }),
 
-        Field({ name: "LocationDescriptorLastEdit", id: 0x2, type: "epoch-us", access: "S", conformance: "M", default: 0 }),
+        Field({
+            name: "LocationDescriptorLastEdit", id: 0x2, type: "epoch-us", access: "S", conformance: "M",
+            default: 0,
+            details: "This field shall indicate the timestamp of when the LocationDescriptor was last modified.",
+            xref: { document: "core", section: "9.18.4.2.3" }
+        }),
+
         Field({ name: "FabricIndex", id: 0xfe, type: "FabricIndex" })
     )
 );

package/src/standard/elements/ElectricalEnergyMeasurement.ts

@@ -18,8 +18,8 @@ import {
 export const ElectricalEnergyMeasurement = Cluster(
     {
         name: "ElectricalEnergyMeasurement", id: 0x91, classification: "application", pics: "EEM",
-        details: "This cluster provides a mechanism for querying data about the electrical energy imported or " +
-            "provided by the server.",
+        details: "This cluster provides a mechanism for querying data about the electrical energy imported or provided " +
+            "by the server.",
         xref: { document: "cluster", section: "2.12" }
     },
 
@@ -208,8 +208,8 @@ export const ElectricalEnergyMeasurement = Cluster(
 
             details: "This struct shall indicate the amount of energy measured during a given measurement period." +
                 "\n" +
-                "A server which does not have the ability to determine the time in UTC, or has not yet done so, " +
-                "shall use the system time fields to specify the measurement period and observation times." +
+                "A server which does not have the ability to determine the time in UTC, or has not yet done so, shall " +
+                "use the system time fields to specify the measurement period and observation times." +
                 "\n" +
                 "A server which has determined the time in UTC shall use the timestamp fields to specify the " +
                 "measurement period. Such a server may also include the systime fields to indicate how many seconds " +
@@ -238,8 +238,8 @@ export const ElectricalEnergyMeasurement = Cluster(
         Field({
             name: "StartTimestamp", id: 0x1, type: "epoch-s", conformance: "desc",
 
-            details: "This field shall indicate the timestamp in UTC of the beginning of the period during which the " +
-                "value of the Energy field was measured." +
+            details: "This field shall indicate the timestamp in UTC of the beginning of the period during which the value " +
+                "of the Energy field was measured." +
                 "\n" +
                 "If this EnergyMeasurementStruct represents cumulative energy, this field shall be omitted." +
                 "\n" +
@@ -247,8 +247,8 @@ export const ElectricalEnergyMeasurement = Cluster(
                 "measurement period, this field shall be indicated." +
                 "\n" +
                 "Otherwise, if the server had not yet determined the time in UTC at or before the beginning of the " +
-                "measurement period, or does not have the capability of determining the time in UTC, this field " +
-                "shall be omitted.",
+                "measurement period, or does not have the capability of determining the time in UTC, this field shall " +
+                "be omitted.",
 
             xref: { document: "cluster", section: "2.12.5.1.2" }
         }),
@@ -309,8 +309,8 @@ export const ElectricalEnergyMeasurement = Cluster(
     Datatype(
         {
             name: "CumulativeEnergyResetStruct", type: "struct",
-            details: "This struct shall represent the times at which cumulative measurements were last zero, either due " +
-                "to initialization of the device, or an internal reset of the cumulative value.",
+            details: "This struct shall represent the times at which cumulative measurements were last zero, either due to " +
+                "initialization of the device, or an internal reset of the cumulative value.",
             xref: { document: "cluster", section: "2.12.5.2" }
         },
 
@@ -325,11 +325,11 @@ export const ElectricalEnergyMeasurement = Cluster(
                 "CumulativeEnergyImported attribute was most recently zero, this field shall be indicated." +
                 "\n" +
                 "Otherwise, if the server had not yet determined the time in UTC when the value of the Energy field " +
-                "on the CumulativeEnergyImported attribute was most recently zero, or does not have the capability " +
-                "of determining the time in UTC, this field shall be omitted." +
+                "on the CumulativeEnergyImported attribute was most recently zero, or does not have the capability of " +
+                "determining the time in UTC, this field shall be omitted." +
                 "\n" +
-                "If the timestamp in UTC when the value of the Energy field on the CumulativeEnergyImported " +
-                "attribute was most recently zero cannot currently be determined, a value of null shall be returned.",
+                "If the timestamp in UTC when the value of the Energy field on the CumulativeEnergyImported attribute " +
+                "was most recently zero cannot currently be determined, a value of null shall be returned.",
 
             xref: { document: "cluster", section: "2.12.5.2.1" }
         }),
@@ -345,11 +345,11 @@ export const ElectricalEnergyMeasurement = Cluster(
                 "CumulativeEnergyExported attribute was most recently zero, this field shall be indicated." +
                 "\n" +
                 "Otherwise, if the server had not yet determined the time in UTC when the value of the Energy field " +
-                "on the CumulativeEnergyExported attribute was most recently zero, or does not have the capability " +
-                "of determining the time in UTC, this field shall be omitted." +
+                "on the CumulativeEnergyExported attribute was most recently zero, or does not have the capability of " +
+                "determining the time in UTC, this field shall be omitted." +
                 "\n" +
-                "If the timestamp in UTC when the value of the Energy field on the CumulativeEnergyExported " +
-                "attribute was most recently zero cannot currently be determined, a value of null shall be returned.",
+                "If the timestamp in UTC when the value of the Energy field on the CumulativeEnergyExported attribute " +
+                "was most recently zero cannot currently be determined, a value of null shall be returned.",
 
             xref: { document: "cluster", section: "2.12.5.2.2" }
         }),

package/src/standard/elements/ElectricalMeasurementNS.ts

@@ -15,8 +15,8 @@ import {
 export const ElectricalMeasurementNs = SemanticNamespace(
     {
         name: "ElectricalMeasurement", id: 0xa,
-        details: "The tags contained in this namespace are restricted for use in the electrical measurement domain " +
-            "and shall NOT be used in any other domain or context.",
+        details: "The tags contained in this namespace are restricted for use in the electrical measurement domain and " +
+            "shall NOT be used in any other domain or context.",
         xref: { document: "namespace", section: "12" }
     },
 

package/src/standard/elements/ElectricalPowerMeasurement.ts

@@ -60,8 +60,8 @@ export const ElectricalPowerMeasurement = Cluster(
 
     Attribute({
         name: "PowerMode", id: 0x0, type: "PowerModeEnum", access: "R V", conformance: "M",
-        details: "This shall indicate the current mode of the server. For some servers, such as an EV, this may " +
-            "change depending on the mode of charging or discharging.",
+        details: "This shall indicate the current mode of the server. For some servers, such as an EV, this may change " +
+            "depending on the mode of charging or discharging.",
         xref: { document: "cluster", section: "2.13.6.1" }
     }),
 
@@ -90,9 +90,9 @@ export const ElectricalPowerMeasurement = Cluster(
             name: "Ranges", id: 0x3, type: "list", access: "R V", conformance: "O",
             constraint: "0 to numberOfMeasurementTypes", default: [], quality: "Q",
 
-            details: "This shall indicate a list of measured ranges for different measurement types. Each measurement " +
-                "type shall have at most one entry in this list, representing the range of measurements in the most " +
-                "recent measurement period." +
+            details: "This shall indicate a list of measured ranges for different measurement types. Each measurement type " +
+                "shall have at most one entry in this list, representing the range of measurements in the most recent " +
+                "measurement period." +
                 "\n" +
                 "The reporting interval of this attribute shall be manufacturer dependent. The server may choose to " +
                 "omit publication of deltas considered not meaningful." +
@@ -474,8 +474,8 @@ export const ElectricalPowerMeasurement = Cluster(
             details: "This struct shall indicate the maximum and minimum values of a given measurement type during a " +
                 "measurement period, along with the observation times of these values." +
                 "\n" +
-                "A server which does not have the ability to determine the time in UTC, or has not yet done so, " +
-                "shall use the system time fields to specify the measurement period and observation times." +
+                "A server which does not have the ability to determine the time in UTC, or has not yet done so, shall " +
+                "use the system time fields to specify the measurement period and observation times." +
                 "\n" +
                 "A server which has determined the time in UTC shall use the timestamp fields to specify the " +
                 "measurement period and observation times. Such a server may also include the systime fields to " +
@@ -502,8 +502,8 @@ export const ElectricalPowerMeasurement = Cluster(
         Field({
             name: "Max", id: 0x2, type: "int64", conformance: "M",
             details: "This field shall be the largest measured value for the associated measurement over the period " +
-                "between either StartTimestamp and EndTimestamp or the period between StartSystime and EndSystime, " +
-                "or both.",
+                "between either StartTimestamp and EndTimestamp or the period between StartSystime and EndSystime, or " +
+                "both.",
             xref: { document: "cluster", section: "2.13.5.2.3" }
         }),
 
@@ -530,17 +530,17 @@ export const ElectricalPowerMeasurement = Cluster(
             name: "MinTimestamp", id: 0x5, type: "epoch-s", conformance: "EndTimestamp",
             details: "This field shall be the most recent timestamp in UTC that the value in the Min field was measured." +
                 "\n" +
-                "This field shall be greater than or equal to the value of the StartTimestamp field. This field " +
-                "shall be less than or equal to the value of the EndTimestamp field.",
+                "This field shall be greater than or equal to the value of the StartTimestamp field. This field shall " +
+                "be less than or equal to the value of the EndTimestamp field.",
             xref: { document: "cluster", section: "2.13.5.2.6" }
         }),
 
         Field({
             name: "MaxTimestamp", id: 0x6, type: "epoch-s", conformance: "EndTimestamp",
             constraint: "min minTimestamp + 1",
-            details: "This field shall be the most recent timestamp in UTC of the value in the Max field. This field " +
-                "shall be greater than or equal to the value of the StartTimestamp field. This field shall be less " +
-                "than or equal to the value of the EndTimestamp field.",
+            details: "This field shall be the most recent timestamp in UTC of the value in the Max field. This field shall " +
+                "be greater than or equal to the value of the StartTimestamp field. This field shall be less than or " +
+                "equal to the value of the EndTimestamp field.",
             xref: { document: "cluster", section: "2.13.5.2.7" }
         }),
 
@@ -558,15 +558,15 @@ export const ElectricalPowerMeasurement = Cluster(
             constraint: "min startSystime + 1",
             details: "This field shall be the time since boot of the end of the measurement period." +
                 "\n" +
-                "If the server had determined the time in UTC at the end of the measurement period, this field may " +
-                "be omitted along with the StartSystime field, MinSystime, and MaxSystime fields.",
+                "If the server had determined the time in UTC at the end of the measurement period, this field may be " +
+                "omitted along with the StartSystime field, MinSystime, and MaxSystime fields.",
             xref: { document: "cluster", section: "2.13.5.2.9" }
         }),
 
         Field({
             name: "MinSystime", id: 0x9, type: "systime-ms", conformance: "EndSystime",
-            details: "This field shall be the measurement time since boot of the value in the Min field was measured. " +
-                "This field shall be greater than or equal to the value of the StartSystime field." +
+            details: "This field shall be the measurement time since boot of the value in the Min field was measured. This " +
+                "field shall be greater than or equal to the value of the StartSystime field." +
                 "\n" +
                 "This field shall be less than or equal to the value of the EndSystime field.",
             xref: { document: "cluster", section: "2.13.5.2.10" }