Matter 1.4 #1657

lauckhart · 2025-01-24T08:49:29Z

This includes application-level upgrades to Matter 1.4. Upgrades the model, cluster definitions, endpoint types and behaviors. Some protocol-level features are still TODO.

One notable change is that Basic Information "unique ID" is mandatory in 1.4. We now generate one unconditionally unless provided as input. This required tweaking current and deprecated codepaths and numerous tests but should be largely transparent to users.

Extends conformance and constraint parsers with new flags and syntax, plus a couple of bits that were used previously but we didn't support. Some of these were complicated and consisted of ad-hoc syntax only used in one or two places... But validation of the final model now sits at 100%.

Includes many upgrades to spec ingestion to handle special cases, mostly due to malformatting. Replaces some hard-coded fixes with automatic detection/repair of errors that have become more prevalent as the spec grows.

Tweaks codegen for derived enums to generate union types that accept values from extended enums. This appears to have been unnecessary because the specification was changed to include the redundant values, possibly because the equivalent fix was deemed infeasible in CHIP and/or alchemy. However it does improve consistency so leaving in.

Includes a few minor CHIP test tweaks. The new changes appear to have been transparent to CHIP but some test edits were no longer necessary and I fixed a few tests that had been broken previously.

Finally, includes a large chunk of code to handle ANSI text processing. A bit of a rathole... Came about because I wanted to make test error reporting more legible, which requires complex nested merging of styled text from multiple sources. And I'd gotten tired of the mix of hand-coded styling and use of a 3rd-party library that has typing issues. Over time we can migrate to this new code and drop the 3rd-party dependency, but will require some package reorganization because it currently lives in "tooling" which is not available everywhere. So just approaching on an "as needed" basis for now.

semanticdiff-com · 2025-01-24T08:49:32Z

Review changes with

packages/tools/src/ansi-text/style.ts

packages/tools/src/ansi-text/wrapper.ts

packages/types/src/clusters/thread-border-router-management.ts

This includes application-level upgrades to Matter 1.4. Upgrades the model, cluster definitions, endpoint types and behaviors. Some protocol-level features are still TODO. One notable change is that Basic Information "unique ID" is mandatory in 1.4. We now generate one unconditionally unless provided as input. This required tweaking current and deprecated codepaths and numerous tests but should be largely transparent to users. Extends conformance and constraint parsers with new flags and syntax, plus a couple of bits that were used previously but we didn't support. Some of these were complicated and consisted of ad-hoc syntax only used in one or two places... But validation of the final model now sits at 100%. Includes many upgrades to spec ingestion to handle special cases, mostly due to malformatting. Replaces some hard-coded fixes with automatic detection/repair of errors that have become more prevalent as the spec grows. Tweaks codegen for derived enums to generate union types that accept values from extended enums. This appears to have been unnecessary because the specification was changed to include the redundant values, possibly because the equivalent fix was deemed infeasible in CHIP and/or alchemy. However it does improve consistency so leaving in. Includes a few minor CHIP test tweaks. The new changes appear to have been transparent to CHIP but some test edits were no longer necessary and I fixed a few tests that had been broken previously. Finally, includes a large chunk of code to handle ANSI text processing. A bit of a rathole... Came about because I wanted to make test error reporting more legible, which requires complex nested merging of styled text from multiple sources. And I'd gotten tired of the mix of hand-coded styling and use of a 3rd-party library that has typing issues. Over time we can migrate to this new code and drop the 3rd-party dependency, but will require some package reorganization because it currently lives in "tooling" which is not available everywhere. So just approaching on an "as needed" basis for now.

Apollon77 · 2025-01-27T09:01:14Z

models/src/local/ColorControlOverrides.ts

            children: [
                { tag: "field", name: "Decrement", id: 0 },
                { tag: "field", name: "Increment", id: 1 },
            ],
        },

+        // In 1.4 they created ColorLoopDirectionEnum but left the type of ColorLoopDirection attribute as uint8


Opened Spec issue https://github.com/CHIP-Specifications/connectedhomeip-spec/issues/10820

Apollon77 · 2025-01-27T09:03:28Z

models/src/local/ColorControlOverrides.ts

@@ -135,14 +140,30 @@ LocalMatter.children.push({
            ],
        },

+        // In 1.4 the spec removed default values for these.  Unsure why but bring them back as they are mandatory


In fact was removed because of the fact that no one changed it and in fact these defaults make o sense because no light will ever be able to support these values this. So the default was removed to ensure manufactuers set meaningful values here. So I would also tend to remove to make sure implementors set meaningful values here

Apollon77 · 2025-01-27T09:06:27Z

models/src/local/ColorControlOverrides.ts

        // Set the correct type of MoveMode because just in the description
        {
            tag: "command",
            id: 0x4b,
            name: "MoveColorTemperature",

            children: [
-                { tag: "field", name: "MoveMode", id: 0x0, type: "MoveMode", conformance: "M", constraint: "desc" },
+                { tag: "field", name: "MoveMode", id: 0x0, type: "MoveModeEnum", conformance: "M", constraint: "desc" },


should this not be in specs in 1.4 correct?

I only edited these lines because the types changed and they otherwise break the model. I generally don't review the overrides to see which are unnecessary anymore

Ok, see my comment ... we can also do that after merging here or incorporate it ... both ok for me

Apollon77 · 2025-01-27T09:06:44Z

models/src/local/ColorControlOverrides.ts

@@ -153,7 +174,7 @@ LocalMatter.children.push({
            name: "StepColorTemperature",

            children: [
-                { tag: "field", name: "StepMode", id: 0x0, type: "StepMode", conformance: "M", constraint: "desc" },
+                { tag: "field", name: "StepMode", id: 0x0, type: "StepModeEnum", conformance: "M", constraint: "desc" },


also this should be correct in 1.4 specs

Apollon77 · 2025-01-27T09:12:13Z

models/src/local/ElectricalPowerMeasurementOverrides.ts

@@ -21,7 +21,7 @@ LocalMatter.children.push({
                    tag: "field",
                    name: "Ranges",

-                    // 1.3 spec mislabels the "access" column as "default"
+                    // 1.3 spec mislabels the "access" column as "default" (still present in 1.4 as well)


Addressed as Spec issue https://github.com/CHIP-Specifications/connectedhomeip-spec/issues/10821

Apollon77 · 2025-01-27T09:59:45Z

packages/node/src/devices/occupancy-sensor.ts

    requirements: OccupancySensorRequirements,
-    behaviors: SupportedBehaviors(
-        OccupancySensorRequirements.server.mandatory.Identify,
-        OccupancySensorRequirements.server.mandatory.OccupancySensing


Why this is removed? it should be still mandatory

Apollon77 · 2025-01-27T10:02:23Z

packages/node/src/endpoints/power-source.ts

@@ -37,7 +40,7 @@ export const PowerSourceEndpointDefinition = MutableEndpoint({
    deviceRevision: 1,
    deviceClass: DeviceClassification.Utility,
    requirements: PowerSourceRequirements,
-    behaviors: SupportedBehaviors(PowerSourceRequirements.server.mandatory.PowerSource)


or this? Or has definition changed?

Apollon77 · 2025-01-27T11:28:33Z

@lauckhart For overrides I also assume:

https://github.com/project-chip/matter.js/blob/791d87a86c8c31f9f97fd9881e9c9e268d498b6c/models/src/local/BasicInformationOverrides.ts can be removed because should be in specs now
Remove themhttps://github.com/project-chip/matter.js/blob/791d87a86c8c31f9f97fd9881e9c9e268d498b6c/models/src/local/DoorLockOverrides.ts#L19-L56 please ... they were likely Zigbee leftovers
1.4 has a DoorStateEnum defined

matter.js/models/src/local/DoorLockOverrides.ts

Line 61 in 791d87a

{ tag: "attribute", id: 0x3, name: "DoorState", type: "DoorStateEnum" },
same for OperatingModeEnum in DoorLock, I think both overrides can be removed?

we can also remove this override I think

matter.js/models/src/local/GroupKeyManagementOverrides.ts

Lines 23 to 32 in 791d87a

    
           { 
        
               tag: "command", 
        
               id: 0x4, 
        
               name: "KeySetReadAllIndices", 
        
               children: [ 
        
                   // The presence of this field is a CHIP bug in 1.1 branch. 
        
                   // They fixed in their main branch...  Remove via conformance 
        
                   { tag: "field", id: 0x1, name: "GroupKeySetIDs", conformance: "X" }, 
        
               ],

I think

matter.js/models/src/local/OperationalCredentialsOverrides.ts

Line 14 in 791d87a

// Spec specifies uint8, assuming this is actually fabric-idx

is unint8 becazse fabricindex formally forbids 0 as a value datatype wise?
remove https://github.com/project-chip/matter.js/blob/791d87a86c8c31f9f97fd9881e9c9e268d498b6c/models/src/local/ScenesOverrides.ts because scenes are dead?
matter.js/models/src/local/ThermostatOverrides.ts

Line 20 in 791d87a

name: "OccupancyBitmap",

should be fixed too because they redefined the enum locally in Thermostat
I think https://github.com/project-chip/matter.js/blob/791d87a86c8c31f9f97fd9881e9c9e268d498b6c/models/src/local/WildcardPathFlagsBitmap.ts can be removed because should be in 1.4

github-advanced-security bot found potential problems Jan 24, 2025

View reviewed changes

packages/tools/src/ansi-text/style.ts Fixed Show fixed Hide fixed

packages/tools/src/ansi-text/wrapper.ts Fixed Show fixed Hide fixed

packages/types/src/clusters/thread-border-router-management.ts Fixed Show fixed Hide fixed

lauckhart force-pushed the matter-1.4 branch from 77f5283 to e00b916 Compare January 24, 2025 09:05

pullapprove bot requested review from Apollon77, turon, vves and woody-apple January 24, 2025 09:05

pullapprove bot added the review - pending label Jan 24, 2025

lauckhart mentioned this pull request Jan 24, 2025

Update copyright to 2025 🎉 #1659

Merged

lauckhart force-pushed the matter-1.4 branch 3 times, most recently from 81345ae to 1f5e1a7 Compare January 25, 2025 02:17

lauckhart force-pushed the matter-1.4 branch from 1f5e1a7 to 791d87a Compare January 25, 2025 02:17

Apollon77 reviewed Jan 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Matter 1.4 #1657

Matter 1.4 #1657

lauckhart commented Jan 24, 2025

semanticdiff-com bot commented Jan 24, 2025 •

edited

Loading

Apollon77 Jan 27, 2025

Apollon77 Jan 27, 2025

Apollon77 Jan 27, 2025

lauckhart Jan 27, 2025

Apollon77 Jan 27, 2025

Apollon77 Jan 27, 2025

Apollon77 Jan 27, 2025

Apollon77 Jan 27, 2025

Apollon77 Jan 27, 2025

Apollon77 commented Jan 27, 2025

Matter 1.4 #1657

Are you sure you want to change the base?

Matter 1.4 #1657

Conversation

lauckhart commented Jan 24, 2025

semanticdiff-com bot commented Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Apollon77 commented Jan 27, 2025

semanticdiff-com bot commented Jan 24, 2025 •

edited

Loading