Matter prepare for ICD cluster (#23158)

Author: s-hadinger

CHANGELOG.md

@@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file.
 - Berry load `.tapp` files in `/.extensions/` then in `/` (#23113)
 - Support Vango Technologies V924x ultralow power, single-phase, power measurement (#23127)
 - Support for HLK-LD2402 24GHz smart wave motion sensor (#23133)
+- Matter prepare for ICD cluster
 
 ### Breaking Changed
 - Berry remove `Leds.create_matrix` from the standard library waiting for reimplementation (#23114)

lib/libesp32/berry_matter/src/embedded/Matter_0_Inspect.be

@@ -87,9 +87,18 @@ matter.inspect = inspect
 #
 # Build a consolidated map of all the `CLUSTERS` static vars
 # from the inheritance hierarchy
+#
+# `cl` can be a the class to get the superclass, or a `map`
 #@ solidify:matter.consolidate_clusters,weak
 def consolidate_clusters(cl, m)
-  var cl_parent = (super(cl) != nil) ? super(cl).CLUSTERS : {}
+  var cl_parent
+  if cl == nil
+    cl_parent = {}
+  elif type(cl) == 'class'
+    cl_parent = (super(cl) != nil) ? super(cl).CLUSTERS : {}
+  elif type(cl) == 'instance'
+    cl_parent = cl
+  end
   var ret = {}
   # clone cl_parent
   for k: cl_parent.keys()

lib/libesp32/berry_matter/src/embedded/Matter_Plugin_0.be

@@ -48,6 +48,7 @@ class Matter_Plugin
   # `FEATURE_MAPS` contains any non-zero value per cluster, if not present default to `0`
   static var FEATURE_MAPS = {               # feature map per cluster
     0x0031: 0x04,                           # Put Eth for now which should work for any on-network
+    # 0x0046: 0x04,                           # LITS: LongIdleTimeSupport
     0x0102: 1 + 4,                          # Lift + PA_LF
     0x0202: 2,                              # Fan: Auto
   }
@@ -77,6 +78,7 @@ class Matter_Plugin
     # 0x0040: 1,                            # Initial Release
     # 0x0041: 1,                            # Initial Release
     # 0x0042: 1,                            # Initial Release
+    # 0x0046: 3,                              # ICD v3
     # 0x005B: 1,                            # Initial Release
     # 0x005C: 1,                            # Initial Release
     0x0101: 7,                              # Added support for European door locks (unbolt feature)
@@ -283,20 +285,20 @@ matter_device.events.dump()
     return self.endpoint
   end
   def get_cluster_list_sorted()
-    return self.device.k2l(self.CLUSTERS)
+    return self.device.k2l(self.get_clusters())
   end
   def contains_cluster(cluster)
-    return self.CLUSTERS.contains(cluster)
+    return self.get_clusters().contains(cluster)
   end
   # def get_attribute_list(cluster)
   #   return self.clusters.find(cluster, [])
   # end
   # returns as a constant bytes of 16-bit ints, big endian
   def get_attribute_list_bytes(cluster)
-    return self.CLUSTERS.find(cluster, nil)
+    return self.get_clusters().find(cluster, nil)
   end
   def contains_attribute(cluster, attribute)
-    var attr_list = self.CLUSTERS.find(cluster)
+    var attr_list = self.get_clusters().find(cluster)
     # log(f"MTR: contains_attribute {cluster=} {attribute=} {attr_list=}")
     if attr_list != nil
       var idx = 0

lib/libesp32/berry_matter/src/embedded/Matter_Plugin_1_Root.be

@@ -43,16 +43,42 @@ class Matter_Plugin_Root : Matter_Plugin
     0x003E: [0,1,2,3,4,5],            # Node Operational Credentials Cluster 11.17 p.704
     0x003F: []                        # Group Key Management Cluster 11.2 p.572
   })
+  # static var CLUSTERS_ICD = matter.consolidate_clusters(_class.CLUSTERS, {
+  #   0x0046: [0,1,2]                   # ICD Management Cluster
+  # })
   static var TYPES = { 0x0016: 1 }       # Root node
 
+  # # ICD options
+  # var icd_idle, icd_active, icd_threshold
+
   #############################################################
   # Constructor
   def init(device, endpoint, config)
     super(self).init(device, endpoint, config)
+    # # check if we have ICD parameters
+    # self.icd_idle = config.find("icd_idle", nil)
+    # if (self.icd_idle != nil)
+    #   self.icd_active = config.find("icd_active", 5000)       # default 5s
+    #   self.icd_threshold = config.find("icd_threshold", 300)     # default 300ms
+    # end
+    # publish mandatory events
     self.publish_event(0x0028, 0x00, matter.EVENT_CRITICAL, matter.TLV.Matter_TLV_item().set(matter.TLV.U4, tasmota.version()))   # Event StartUp - Software Version
     self.publish_event(0x0033, 0x03, matter.EVENT_CRITICAL, matter.TLV.Matter_TLV_item().set(matter.TLV.U1, 1))   # Event BootReason - PowerOnReboot - TODO if we need to refine
   end
 
+  #############################################################
+  # consolidate_clusters
+  #
+  # Build a consolidated map of all the `CLUSTERS` static vars
+  # from the inheritance hierarchy
+  # def get_clusters()
+  #   if (self.icd_idle == nil)
+  #     return self.CLUSTERS
+  #   else
+  #     return self.CLUSTERS_ICD
+  #   end
+  # end
+
   #############################################################
   # read an attribute
   #
@@ -323,6 +349,17 @@ class Matter_Plugin_Root : Matter_Plugin
         return pl
       end
 
+    # ====================================================================================================
+    # elif cluster == 0x0046              # ========== ICD Management Cluster ==========
+
+    #   if   attribute == 0x0000          #  ---------- IdleModeDuration / uint32 (seconds) ----------
+    #     return tlv_solo.set_or_nil(TLV.U4, self.icd_idle)
+    #   elif attribute == 0x0001          #  ---------- ActiveModeDuration / uint32 (milliseconds) ----------
+    #     return tlv_solo.set_or_nil(TLV.U4, self.icd_active)
+    #   elif attribute == 0x0002          #  ---------- ActiveModeThreshold / uint16 (milliseconds) ----------
+    #     return tlv_solo.set_or_nil(TLV.U2, self.icd_threshold)
+    #   end
+
     end
     return super(self).read_attribute(session, ctx, tlv_solo)
   end

lib/libesp32/berry_matter/src/embedded/Matter_z_Autoconf.be

@@ -40,7 +40,7 @@ class Matter_Autoconf
     var plugins = self.device.plugins
 
     # start with mandatory endpoint 0 for root node
-    plugins.push(matter.Plugin_Root(self.device, 0, {}))
+    plugins.push(matter.Plugin_Root(self.device, 0, config.find("0", {})))
     log("MTR: Configuring endpoints", 2)
     log(format("MTR:   endpoint = %5i type:%s%s", 0, 'root', ''), 2)
 

lib/libesp32/berry_matter/src/embedded/Matter_zz_Device.be

@@ -732,11 +732,7 @@ class Matter_Device
     var keys = []
     for k: self.plugins_config.keys()   keys.push(int(k))    end
     for ep: keys
-      if ep == 0
-        log("MTR: invalid entry with ep '0'", 2)
-        self.plugins_config.remove(str(ep))
-        dirty = true
-      elif ep == matter.AGGREGATOR_ENDPOINT
+      if ep == matter.AGGREGATOR_ENDPOINT
         dirty = true
         log(f"MTR: endpoint {ep} collides wit aggregator, relocating to {self.next_ep}", 2)
         self.plugins_config[str(self.next_ep)] = self.plugins_config[str(ep)]