Merge branch 'master' into add-water-heater-management-to-all-clusters-app

Author: PeterC1965

examples/chip-tool/templates/ComplexArgumentParser-src.zapt

@@ -5,6 +5,8 @@
 {{#zcl_structs}}
 {{#if has_more_than_one_cluster}}
 {{> struct_parser_impl namespace="detail"}}
+{{else if has_no_clusters}}
+{{> struct_parser_impl namespace="Globals"}}
 {{/if}}
 {{/zcl_structs}}
 

examples/chip-tool/templates/ComplexArgumentParser.zapt

@@ -8,6 +8,8 @@
 {{#zcl_structs}}
 {{#if has_more_than_one_cluster}}
 {{> struct_parser_decl namespace="detail"}}
+{{else if has_no_clusters}}
+{{> struct_parser_decl namespace="Globals"}}
 {{/if}}
 {{/zcl_structs}}
 

examples/chip-tool/templates/logging/DataModelLogger-src.zapt

@@ -7,6 +7,8 @@ using namespace chip::app::Clusters;
 {{#zcl_structs}}
 {{#if has_more_than_one_cluster}}
 {{> struct_logger_impl namespace="detail"}}
+{{else if has_no_clusters}}
+{{> struct_logger_impl namespace="Globals"}}
 {{/if}}
 {{/zcl_structs}}
 

examples/chip-tool/templates/logging/DataModelLogger.zapt

@@ -6,6 +6,8 @@
 {{#zcl_structs}}
 {{#if has_more_than_one_cluster}}
 {{> struct_logger_decl namespace="detail"}}
+{{else if has_no_clusters}}
+{{> struct_logger_decl namespace="Globals"}}
 {{/if}}
 {{/zcl_structs}}
 

scripts/py_matter_idl/matter_idl/backwards_compatibility.py

@@ -54,9 +54,9 @@ def attribute_name(attribute: Attribute) -> str:
 
 def not_stable(maturity: ApiMaturity):
     """Determine if the given api maturity allows binary/api changes or not."""
-    # TODO: internal and deprecated not currently widely used,
-    #       so we enforce stability on them for now.
-    return maturity == ApiMaturity.PROVISIONAL
+    # NOTE: deprecated are not to be used, so we expect no changes. They were
+    #       probably "stable" at some point
+    return (maturity == ApiMaturity.PROVISIONAL) or (maturity == ApiMaturity.INTERNAL)
 
 
 class CompatibilityChecker:

scripts/py_matter_idl/matter_idl/test_backwards_compatibility.py

@@ -188,6 +188,13 @@ def test_provisional_cluster(self):
             "provisional server cluster A = 16 { enum X : ENUM8 { A = 1; B = 3; } info event A = 2 { int16u x = 1;} }",
             Compatibility.ALL_OK)
 
+    def test_internal_cluster(self):
+        self.ValidateUpdate(
+            "Internal cluster changes are ok.",
+            "internal server cluster A = 16 { enum X : ENUM8 { A = 1; B = 2; } info event A = 1 { int8u x = 1;} }",
+            "internal server cluster A = 16 { enum X : ENUM8 { A = 1; B = 3; } info event A = 2 { int16u x = 1;} }",
+            Compatibility.ALL_OK)
+
     def test_clusters_enum_code(self):
         self.ValidateUpdate(
             "Adding an enum is ok. Also validates code formatting",

src/app/common/templates/templates.json

@@ -25,6 +25,10 @@
             "name": "cluster_enums_enum",
             "path": "../../zap-templates/partials/cluster-enums-enum.zapt"
         },
+        {
+            "name": "cluster_enums_ensure_known_value",
+            "path": "../../zap-templates/partials/cluster-enums-ensure-known-value.zapt"
+        },
         {
             "name": "cluster_objects_field_init",
             "path": "../../zap-templates/partials/cluster-objects-field-init.zapt"

src/app/zap-templates/partials/cluster-enums-ensure-known-value.zapt

@@ -0,0 +1,14 @@
+{{#unless (isInConfigList (concat ns "::" label) "EnumsNotUsedAsTypeInXML")}}
+static auto __attribute__((unused)) EnsureKnownEnumValue({{ns}}::{{asType label}} val)
+{
+    using EnumType = {{ns}}::{{asType label}};
+    switch (val) {
+    {{#zcl_enum_items}}
+    case EnumType::k{{asUpperCamelCase label}}:
+    {{/zcl_enum_items}}
+        return val;
+    default:
+        return EnumType::kUnknownEnumValue;
+    }
+}
+{{/unless}}

src/app/zap-templates/templates/app/cluster-enums-check.zapt

@@ -9,40 +9,17 @@ namespace app {
 namespace Clusters {
 {{#zcl_enums}}
 {{#if has_more_than_one_cluster}}
-{{#unless (isInConfigList (concat "::" label) "EnumsNotUsedAsTypeInXML")}}
-static auto __attribute__((unused)) EnsureKnownEnumValue(detail::{{asType label}} val)
-{
-    using EnumType = detail::{{asType label}};
-    switch (val) {
-    {{#zcl_enum_items}}
-    case EnumType::k{{asUpperCamelCase label}}:
-    {{/zcl_enum_items}}
-        return val;
-    default:
-        return EnumType::kUnknownEnumValue;
-    }
-}
-{{/unless}}
+{{> cluster_enums_ensure_known_value ns="detail"}}
+{{else if has_no_clusters}}
+{{> cluster_enums_ensure_known_value ns="Globals"}}
+
 {{/if}}
 {{/zcl_enums}}
 
 {{#zcl_clusters}}
 {{#zcl_enums}}
 {{#unless has_more_than_one_cluster}}
-{{#unless (isInConfigList (concat (asUpperCamelCase ../name) "::" label) "EnumsNotUsedAsTypeInXML")}}
-static auto __attribute__((unused)) EnsureKnownEnumValue({{asUpperCamelCase ../name}}::{{asType label}} val)
-{
-    using EnumType = {{asUpperCamelCase ../name}}::{{asType label}};
-    switch (val) {
-    {{#zcl_enum_items}}
-    case EnumType::k{{asUpperCamelCase label}}:
-    {{/zcl_enum_items}}
-        return val;
-    default:
-        return EnumType::kUnknownEnumValue;
-    }
-}
-{{/unless}}
+{{> cluster_enums_ensure_known_value ns=(asUpperCamelCase ../name)}}
 {{/unless}}
 {{/zcl_enums}}
 

src/app/zap-templates/templates/app/cluster-enums.zapt

@@ -37,6 +37,37 @@ k{{asUpperCamelCase label}} = {{asHex mask}},
 
 } // namespace detail
 
+namespace Globals {
+// Global enums.
+{{#zcl_enums}}
+
+{{#if has_no_clusters}}
+
+{{> cluster_enums_enum ns=""}}
+
+{{/if}}
+{{/zcl_enums}}
+
+// Global bitmaps.
+{{#zcl_bitmaps}}
+
+{{#if has_no_clusters}}
+{{! Work around https://github.com/project-chip/zap/issues/1370 and manually filter out built-in bitmap types. }}
+{{#if_is_atomic label}}
+{{else}}
+
+// Bitmap for {{label}}
+enum class {{asType label}} : {{asUnderlyingZclType name}} {
+{{#zcl_bitmap_items}}
+k{{asUpperCamelCase label}} = {{asHex mask}},
+{{/zcl_bitmap_items}}
+};
+
+{{/if_is_atomic}}
+{{/if}}
+{{/zcl_bitmaps}}
+
+} // namespace Globals
 
 {{#zcl_clusters}}
 namespace {{asUpperCamelCase name}} {

src/app/zap-templates/templates/app/cluster-objects-src.zapt

@@ -64,6 +64,18 @@ namespace Structs {
 } // namespace Structs
 } // namespace detail
 
+namespace Globals {
+// Global structs
+namespace Structs {
+{{#zcl_structs}}
+{{#if has_no_clusters}}
+{{> cluster_objects_struct header=false}}
+
+{{/if}}
+{{/zcl_structs}}
+} // namespace Structs
+} // namespace Globals
+
 {{#zcl_clusters}}
 namespace {{asUpperCamelCase name}} {
 {{#zcl_structs}}

src/app/zap-templates/templates/app/cluster-objects.zapt

@@ -35,6 +35,18 @@ namespace Structs {
 } // namespace detail
 
 namespace Globals {
+
+// Global structs.
+namespace Structs {
+
+{{#zcl_structs}}
+{{#if has_no_clusters}}
+{{> cluster_objects_struct header=true}}
+
+{{/if}}
+{{/zcl_structs}}
+} // namespace Structs
+
 namespace Attributes {
 {{#zcl_attributes_server}}
 {{#unless clusterRef}}

src/controller/python/chip/clusters/Attribute.py

@@ -288,7 +288,7 @@ def _BuildClusterIndex():
     ''' Build internal cluster index for locating the corresponding cluster object by path in the future.
     '''
     for clusterName, obj in inspect.getmembers(sys.modules['chip.clusters.Objects']):
-        if ('chip.clusters.Objects' in str(obj)) and inspect.isclass(obj):
+        if ('chip.clusters.Objects' in str(obj)) and inspect.isclass(obj) and issubclass(obj, Cluster):
             _ClusterIndex[obj.id] = obj