@matter/model 0.12.6-alpha.0-20250304-03716637c → 0.13.0-alpha.0-20250307-ebf84a05a

package/src/standard/elements/RvcCleanMode.ts

@@ -10,31 +10,43 @@ 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 RvcCleanMode = Cluster(
     {
         name: "RvcCleanMode", id: 0x55, type: "ModeBase", classification: "application", pics: "RVCCLEANM",
-        details: "This cluster is derived from the Mode Base cluster to define specifics for Robotic Vacuum Cleaner " +
-            "devices. It also defines a namespace for the cleaning type for these devices.",
+        details: "This cluster is derived from the Mode Base cluster and defines additional mode tags and namespaced " +
+            "enumerated values for the cleaning type of robotic vacuum cleaner devices.",
         xref: { document: "cluster", section: "7.3" }
     },
 
-    Attribute({ name: "ClusterRevision", id: 0xfffd, type: "ClusterRevision", default: 2 }),
-    Attribute({ name: "SupportedModes", id: 0x0, xref: { document: "cluster", section: "7.3.6" } }),
+    Attribute({ name: "ClusterRevision", id: 0xfffd, type: "ClusterRevision", default: 3 }),
+
+    Attribute(
+        { name: "FeatureMap", id: 0xfffc, type: "FeatureMap", xref: { document: "cluster", section: "7.3.4" } },
+        Field({
+            name: "DEPONOFF", conformance: "X", constraint: "0", description: "OnOff",
+            details: "Dependency with the OnOff cluster"
+        })
+    ),
+
+    Attribute({
+        name: "SupportedModes", id: 0x0,
+        details: "At least one entry in the SupportedModes attribute shall include the Vacuum and/or the Mop mode tag " +
+            "in the ModeTags field list.",
+        xref: { document: "cluster", section: "7.3.6.1" }
+    }),
+
     Attribute({ name: "CurrentMode", id: 0x1, xref: { document: "cluster", section: "7.3.6" } }),
     Attribute({ name: "StartUpMode", id: 0x2, conformance: "X", xref: { document: "cluster", section: "7.3.6" } }),
-    Attribute({ name: "OnMode", id: 0x3, conformance: "D", xref: { document: "cluster", section: "7.3.6" } }),
+    Attribute({ name: "OnMode", id: 0x3, conformance: "X", xref: { document: "cluster", section: "7.3.6" } }),
 
     Datatype({
         name: "ModeOptionStruct", type: "ModeOptionStruct",
         details: "The table below lists the changes relative to the Mode Base cluster for the fields of the " +
-            "ModeOptionStruct type. A blank field indicates no change." +
-            "\n" +
-            "At least one entry in the SupportedModes attribute shall include the Vacuum and/or the Mop mode tag " +
-            "in the ModeTags field list.",
+            "ModeOptionStruct type. A blank field indicates no change.",
         xref: { document: "cluster", section: "7.3.5.1" }
     }),
 
@@ -45,6 +57,16 @@ export const RvcCleanMode = Cluster(
 
     Datatype(
         { name: "ModeTag", type: "enum16" },
+        Field({ name: "Auto", id: 0x0, xref: { document: "cluster", section: "7.3.7.2" } }),
+        Field({ name: "Quick", id: 0x1, xref: { document: "cluster", section: "7.3.7.2" } }),
+        Field({ name: "Quiet", id: 0x2, xref: { document: "cluster", section: "7.3.7.2" } }),
+        Field({ name: "LowNoise", id: 0x3, xref: { document: "cluster", section: "7.3.7.2" } }),
+        Field({ name: "LowEnergy", id: 0x4, xref: { document: "cluster", section: "7.3.7.2" } }),
+        Field({ name: "Vacation", id: 0x5, xref: { document: "cluster", section: "7.3.7.2" } }),
+        Field({ name: "Min", id: 0x6, xref: { document: "cluster", section: "7.3.7.2" } }),
+        Field({ name: "Max", id: 0x7, xref: { document: "cluster", section: "7.3.7.2" } }),
+        Field({ name: "Night", id: 0x8, xref: { document: "cluster", section: "7.3.7.2" } }),
+        Field({ name: "Day", id: 0x9, xref: { document: "cluster", section: "7.3.7.2" } }),
         Field({ name: "DeepClean", id: 0x4000, xref: { document: "cluster", section: "7.3.7.2" } }),
         Field({
             name: "Vacuum", id: 0x4001,

package/src/standard/elements/RvcOperationalState.ts

@@ -19,19 +19,20 @@ export const RvcOperationalState = Cluster(
     {
         name: "RvcOperationalState", id: 0x61, type: "OperationalState", classification: "application",
         pics: "RVCOPSTATE",
-        details: "This cluster provides an interface for monitoring the operational state of a Robotic Vacuum Cleaner.",
+        details: "This cluster is derived from the Operational State cluster and provides an interface for monitoring " +
+            "the operational state of a robotic vacuum cleaner.",
         xref: { document: "cluster", section: "7.4" }
     },
 
     Attribute({ name: "ClusterRevision", id: 0xfffd, type: "ClusterRevision", default: 2 }),
     Command({ name: "Pause", id: 0x0, xref: { document: "cluster", section: "7.4.5" } }),
-    Command({ name: "Stop", id: 0x1, conformance: "D", xref: { document: "cluster", section: "7.4.5" } }),
-    Command({ name: "Start", id: 0x2, conformance: "D", xref: { document: "cluster", section: "7.4.5" } }),
+    Command({ name: "Stop", id: 0x1, conformance: "X", xref: { document: "cluster", section: "7.4.5" } }),
+    Command({ name: "Start", id: 0x2, conformance: "X", xref: { document: "cluster", section: "7.4.5" } }),
     Command({ name: "Resume", id: 0x3, xref: { document: "cluster", section: "7.4.5" } }),
     Command({ name: "OperationalCommandResponse", id: 0x4, xref: { document: "cluster", section: "7.4.5" } }),
 
     Command({
-        name: "GoHome", id: 0x80, access: "O", conformance: "P, O", direction: "request",
+        name: "GoHome", id: 0x80, access: "O", conformance: "O", direction: "request",
         response: "OperationalCommandResponse",
 
         details: "On receipt of this command, the device shall start seeking the charging dock, if possible in the " +
@@ -65,12 +66,12 @@ export const RvcOperationalState = Cluster(
                 "RVC Pause Compatibility defines the compatibility of the states this cluster defines with the Pause " +
                 "command." +
                 "\n" +
-                "### Table 39. RVC Pause Compatibility" +
+                "### Table 13. RVC Pause Compatibility" +
                 "\n" +
                 "RVC Resume Compatibility defines the compatibility of the states this cluster defines with the " +
                 "Resume command." +
                 "\n" +
-                "### Table 40. RVC Resume Compatibility" +
+                "### Table 14. RVC Resume Compatibility" +
                 "\n" +
                 "While in the Charging or Docked states, the device shall NOT attempt to resume unless it " +
                 "transitioned to those states while operating and can resume, such as, for example, if it is " +
@@ -82,6 +83,10 @@ export const RvcOperationalState = Cluster(
             xref: { document: "cluster", section: "7.4.4.1" }
         },
 
+        Field({ name: "Stopped", id: 0x0, conformance: "M", description: "The device is stopped" }),
+        Field({ name: "Running", id: 0x1, conformance: "M", description: "The device is operating" }),
+        Field({ name: "Paused", id: 0x2, conformance: "M", description: "The device is paused during an operation" }),
+        Field({ name: "Error", id: 0x3, conformance: "M", description: "The device is in an error state" }),
         Field({
             name: "SeekingCharger", id: 0x40, conformance: "M",
             description: "The device is en route to the charging dock"
@@ -98,6 +103,19 @@ export const RvcOperationalState = Cluster(
             xref: { document: "cluster", section: "7.4.4.2" }
         },
 
+        Field({ name: "NoError", id: 0x0, conformance: "M", description: "The device is not in an error state" }),
+        Field({
+            name: "UnableToStartOrResume", id: 0x1, conformance: "M",
+            description: "The device is unable to start or resume operation"
+        }),
+        Field({
+            name: "UnableToCompleteOperation", id: 0x2, conformance: "M",
+            description: "The device was unable to complete the current operation"
+        }),
+        Field({
+            name: "CommandInvalidInState", id: 0x3, conformance: "M",
+            description: "The device cannot process the command in its current state"
+        }),
         Field({
             name: "FailedToFindChargingDock", id: 0x40, conformance: "M",
             description: "The device has failed to find or reach the charging dock"

package/src/standard/elements/RvcRunMode.ts

@@ -10,31 +10,32 @@ 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 RvcRunMode = Cluster(
     {
         name: "RvcRunMode", id: 0x54, type: "ModeBase", classification: "application", pics: "RVCRUNM",
-        details: "This cluster is derived from the Mode Base cluster to define specifics for Robotic Vacuum Cleaner " +
-            "devices. It also defines a namespace for the running modes of these devices.",
+        details: "This cluster is derived from the Mode Base cluster and defines additional mode tags and namespaced " +
+            "enumerated values for the running modes of robotic vacuum cleaner devices.",
         xref: { document: "cluster", section: "7.2" }
     },
 
-    Attribute({ name: "ClusterRevision", id: 0xfffd, type: "ClusterRevision", default: 2 }),
-    Attribute({ name: "SupportedModes", id: 0x0, xref: { document: "cluster", section: "7.2.6" } }),
-    Attribute({ name: "CurrentMode", id: 0x1, xref: { document: "cluster", section: "7.2.6" } }),
-    Attribute({ name: "StartUpMode", id: 0x2, conformance: "X", xref: { document: "cluster", section: "7.2.6" } }),
-    Attribute({ name: "OnMode", id: 0x3, conformance: "D", xref: { document: "cluster", section: "7.2.6" } }),
+    Attribute({ name: "ClusterRevision", id: 0xfffd, type: "ClusterRevision", default: 3 }),
 
-    Datatype({
-        name: "ModeOptionStruct", type: "ModeOptionStruct",
+    Attribute(
+        { name: "FeatureMap", id: 0xfffc, type: "FeatureMap", xref: { document: "cluster", section: "7.2.4" } },
+        Field({
+            name: "DEPONOFF", conformance: "X", constraint: "0", description: "OnOff",
+            details: "Dependency with the OnOff cluster"
+        })
+    ),
 
-        details: "The table below lists the changes relative to the Mode Base cluster for the fields of the " +
-            "ModeOptionStruct type. A blank field indicates no change." +
-            "\n" +
-            "At least one entry in the SupportedModes attribute shall include the Idle mode tag in the ModeTags " +
+    Attribute({
+        name: "SupportedModes", id: 0x0,
+
+        details: "At least one entry in the SupportedModes attribute shall include the Idle mode tag in the ModeTags " +
             "field." +
             "\n" +
             "At least one entry in the SupportedModes attribute (different from the one above) shall include the " +
@@ -43,6 +44,17 @@ export const RvcRunMode = Cluster(
             "The Mapping, Cleaning, and Idle mode tags are mutually exclusive and shall NOT be used together in " +
             "a mode’s ModeTags.",
 
+        xref: { document: "cluster", section: "7.2.6.1" }
+    }),
+
+    Attribute({ name: "CurrentMode", id: 0x1, xref: { document: "cluster", section: "7.2.6" } }),
+    Attribute({ name: "StartUpMode", id: 0x2, conformance: "X", xref: { document: "cluster", section: "7.2.6" } }),
+    Attribute({ name: "OnMode", id: 0x3, conformance: "X", xref: { document: "cluster", section: "7.2.6" } }),
+
+    Datatype({
+        name: "ModeOptionStruct", type: "ModeOptionStruct",
+        details: "The table below lists the changes relative to the Mode Base cluster for the fields of the " +
+            "ModeOptionStruct type. A blank field indicates no change.",
         xref: { document: "cluster", section: "7.2.5.1" }
     }),
 
@@ -60,6 +72,16 @@ export const RvcRunMode = Cluster(
 
     Datatype(
         { name: "ModeTag", type: "enum16" },
+        Field({ name: "Auto", id: 0x0, xref: { document: "cluster", section: "7.2.7.2" } }),
+        Field({ name: "Quick", id: 0x1, xref: { document: "cluster", section: "7.2.7.2" } }),
+        Field({ name: "Quiet", id: 0x2, xref: { document: "cluster", section: "7.2.7.2" } }),
+        Field({ name: "LowNoise", id: 0x3, xref: { document: "cluster", section: "7.2.7.2" } }),
+        Field({ name: "LowEnergy", id: 0x4, xref: { document: "cluster", section: "7.2.7.2" } }),
+        Field({ name: "Vacation", id: 0x5, xref: { document: "cluster", section: "7.2.7.2" } }),
+        Field({ name: "Min", id: 0x6, xref: { document: "cluster", section: "7.2.7.2" } }),
+        Field({ name: "Max", id: 0x7, xref: { document: "cluster", section: "7.2.7.2" } }),
+        Field({ name: "Night", id: 0x8, xref: { document: "cluster", section: "7.2.7.2" } }),
+        Field({ name: "Day", id: 0x9, xref: { document: "cluster", section: "7.2.7.2" } }),
 
         Field({
             name: "Idle", id: 0x4000,

package/src/standard/elements/ScenesManagement.ts

@@ -26,7 +26,7 @@ export const ScenesManagement = Cluster(
             "In most cases scenes are associated with a particular group identifier. Scenes may also exist " +
             "without a group, in which case the value 0 replaces the group identifier. Note that extra care is " +
             "required in these cases to avoid a scene identifier collision, and that commands related to scenes " +
-            "without a group may only be unicast, i.e., they may not be multicast or broadcast." +
+            "without a group may only be unicast, i.e., they shall NOT be multicast or broadcast." +
             "\n" +
             "NOTE Support for Scenes Management cluster is provisional.",
 
@@ -480,8 +480,7 @@ export const ScenesManagement = Cluster(
 
         Field({
             name: "SceneIdentifierFrom", id: 0x2, type: "uint8", conformance: "M", constraint: "max 254",
-            details: "This field shall be set to the same values as in the corresponding fields of the received CopyScene" +
-                "\n" +
+            details: "This field shall be set to the same values as in the corresponding fields of the received CopyScene " +
                 "command.",
             xref: { document: "cluster", section: "1.4.9.16.3" }
         })
@@ -564,17 +563,19 @@ export const ScenesManagement = Cluster(
 
             details: "This field shall be present for all instances in a given ExtensionFieldSetStruct." +
                 "\n" +
-                "The data type of AttributeValue shall be the data type of the attribute indicated by AttributeID." +
+                "Which Value* field is used shall be determined based on the data type of the attribute indicated by " +
+                "AttributeID, as described in the Value* Fields subsection." +
                 "\n" +
                 "The AttributeID field shall NOT refer to an attribute without the Scenes (\"S\") designation in the " +
                 "Quality column of the cluster specification." +
                 "\n" +
-                "  1.4.7.3.2. ValueUnsigned8, ValueSigned8, ValueUnsigned16, ValueSigned16, ValueUnsigned32, " +
-                "             ValueSigned32, ValueUnsigned64, ValueSigned64 Fields" +
+                "### 1.4.7.3.2. ValueUnsigned8, ValueSigned8, ValueUnsigned16, ValueSigned16, ValueUnsigned32, " +
+                "ValueSigned32, ValueUnsigned64, ValueSigned64 Fields" +
                 "\n" +
                 "These fields shall indicate the attribute value as part of an extension field set, associated with " +
-                "a given AttributeID under an ExtensionFieldSetStruct’s ClusterID. The proper field shall be present " +
-                "that maps to the data type of the attribute indicated." +
+                "a given AttributeID under an ExtensionFieldSetStruct’s ClusterID. Which of the fields is used shall" +
+                "\n" +
+                "be determined by the type of the attribute indicated by AttributeID as follows:" +
                 "\n" +
                 "  • Data types bool, map8, and uint8 shall map to ValueUnsigned8." +
                 "\n" +
@@ -588,33 +589,51 @@ export const ScenesManagement = Cluster(
                 "\n" +
                 "  • Data types int24 and int32 shall map to ValueSigned32." +
                 "\n" +
-                "  • Data types map64, uint48, uint56 and uint64 shall map to ValueUnsigned64." +
+                "  • Data types map64, uint40, uint48, uint56 and uint64 shall map to ValueUnsigned64." +
+                "\n" +
+                "  • Data types int40, int48, int56 and int64 shall map to ValueSigned64." +
+                "\n" +
+                "  • For derived types, the mapping shall be based on the base type. For example, an attribute of " +
+                "    type percent shall be treated as if it were of type uint8, whereas an attribute of type " +
+                "    percent100ths shall be treated as if it were of type uint16." +
+                "\n" +
+                "  • For boolean nullable attributes, any value that is not 0 or 1 shall be considered to have the " +
+                "    null value." +
+                "\n" +
+                "  • For boolean non-nullable attributes, any value that is not 0 or 1 shall be considered to have " +
+                "    the value FALSE." +
+                "\n" +
+                "  • For non-boolean nullable attributes, any value that is not a valid numeric value for the " +
+                "    attribute’s type after accounting for range reductions due to being nullable and constraints " +
+                "    shall be considered to have the null value for the type." +
                 "\n" +
-                "  • Data types int48, int56 and int64 shall map to ValueSigned64." +
+                "  • For non-boolean non-nullable attributes, any value that is not a valid numeric value for the " +
+                "    attribute’s type after accounting for constraints shall be considered to be the valid attribute " +
+                "    value that is closest to the provided value." +
                 "\n" +
-                "  • For nullable attributes, any value that is not a valid numeric value for the attribute’s type " +
-                "    after accounting for range reductions due to being nullable and constraints shall be considered " +
-                "    to have the null value for the type." +
+                "    ◦ In the event that an invalid provided value is of equal numerical distance to the two closest " +
+                "      valid values, the lowest of those values shall be considered the closest valid attribute " +
+                "      value." +
                 "\n" +
-                "  • For non-nullable attributes, any value that is not a valid numeric value for the attribute’s " +
-                "    type after accounting for constraints shall be considered to have the maximum legal value in " +
-                "    the attribute’s constrained range." +
+                "If the used field does not match the data type of the attribute indicated by AttributeID, the " +
+                "AttributeValuePairStruct shall be considered invalid." +
                 "\n" +
                 "Examples of processing are:" +
                 "\n" +
                 "  • ColorControl cluster CurrentX (AttributeID 0x0003) has a type of uint16 and is not nullable." +
                 "\n" +
-                "    ◦ AttributeValue of 0xAB12 would be used as-is, as it is in range." +
+                "    ◦ ValueUnsigned16 of 0xAB12 would be used as-is, as it is in range." +
                 "\n" +
-                "    ◦ AttributeValue of 0xAA0011 is outside of the range of uint16, and would be saturated to the " +
-                "      maximum of the attribute’s constraint range: 0xFEFF." +
+                "    ◦ ValueUnsigned16 of 0xFF80 is outside of the range allowed for attribute CurrentX, and would " +
+                "      be saturated to the closest valid value, which is the maximum of the attribute’s constraint " +
+                "      range: 0xFEFF." +
                 "\n" +
                 "  • LevelControl cluster CurrentLevel (AttributeID 0x0000) has a type of uint8 and is nullable." +
                 "\n" +
-                "    ◦ AttributeValue of 0xA1 would be used as-is, as it is in range." +
+                "    ◦ ValueUnsigned8 of 0xA1 would be used as-is, as it is in range." +
                 "\n" +
-                "    ◦ AttributeValue of 0xBB12 is outside the range of nullable uint8, and would be considered as " +
-                "      the null value.",
+                "    ◦ ValueUnsigned8 of 0xFF is outside the range allowed for nullable attribute CurrentLevel, and " +
+                "      would be considered as the null value.",
 
             xref: { document: "cluster", section: "1.4.7.3.1" }
         }),
@@ -659,7 +678,7 @@ export const ScenesManagement = Cluster(
 
     Datatype(
         {
-            name: "Logical Scene Table", type: "struct",
+            name: "LogicalSceneTable", type: "struct",
 
             details: "The Scene Table is used to store information for each scene capable of being invoked on the server. " +
                 "Each scene is defined for a particular group. The Scene Table is defined here as a conceptual " +

package/src/standard/elements/SecondaryNetworkInterfaceDT.ts

@@ -0,0 +1,49 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/*** THIS FILE IS GENERATED, DO NOT EDIT ***/
+
+import { MatterDefinition } from "../MatterDefinition.js";
+import { DeviceTypeElement as DeviceType, RequirementElement as Requirement } from "../../elements/index.js";
+
+export const SecondaryNetworkInterfaceDt = DeviceType(
+    {
+        name: "SecondaryNetworkInterface", id: 0x19, category: "Utility", classification: "utility",
+
+        details: "A Secondary Network Interface device provides an additional network interface supported by the " +
+            "Node, supplementing the primary interface hosted by the Root Node endpoint." +
+            "\n" +
+            "A Node supporting multiple network interfaces shall include the primary interface on the Root Node " +
+            "endpoint, along with secondary interfaces on other endpoints. The priorities of these network " +
+            "interfaces are determined by the order of their endpoints, where interfaces with smaller endpoint " +
+            "numbers are higher priority.",
+
+        xref: { document: "device", section: "2.8" }
+    },
+
+    Requirement(
+        { name: "Descriptor", id: 0x1d, element: "serverCluster" },
+        Requirement({ name: "DeviceTypeList", default: [ { deviceType: 25, revision: 1 } ], element: "attribute" })
+    ),
+    Requirement({
+        name: "NetworkCommissioning", id: 0x31, conformance: "M", element: "serverCluster",
+        xref: { document: "device", section: "2.8.3" }
+    }),
+    Requirement({
+        name: "EthernetNetworkDiagnostics", id: 0x37, conformance: "[Ethernet]", element: "serverCluster",
+        xref: { document: "device", section: "2.8.3" }
+    }),
+    Requirement({
+        name: "WiFiNetworkDiagnostics", id: 0x36, conformance: "[Wi, Fi]", element: "serverCluster",
+        xref: { document: "device", section: "2.8.3" }
+    }),
+    Requirement({
+        name: "ThreadNetworkDiagnostics", id: 0x35, conformance: "[Thread]", element: "serverCluster",
+        xref: { document: "device", section: "2.8.3" }
+    })
+);
+
+MatterDefinition.children.push(SecondaryNetworkInterfaceDt);