add embedded PowerTopology handling

Author: hcarter-775

drivers/SmartThings/matter-switch/src/embedded_clusters/PowerTopology/init.lua

@@ -0,0 +1,73 @@
+local cluster_base = require "st.matter.cluster_base"
+local PowerTopologyServerAttributes = require "embedded_clusters.PowerTopology.server.attributes"
+local PowerTopologyTypes = require "embedded_clusters.PowerTopology.types"
+
+local PowerTopology = {}
+
+PowerTopology.ID = 0x009C
+PowerTopology.NAME = "PowerTopology"
+PowerTopology.server = {}
+PowerTopology.client = {}
+PowerTopology.server.attributes = PowerTopologyServerAttributes:set_parent_cluster(PowerTopology)
+PowerTopology.types = PowerTopologyTypes
+
+function PowerTopology:get_attribute_by_id(attr_id)
+  local attr_id_map = {
+    [0x0000] = "AvailableEndpoints",
+    [0x0001] = "ActiveEndpoints",
+    [0xFFF9] = "AcceptedCommandList",
+    [0xFFFA] = "EventList",
+    [0xFFFB] = "AttributeList",
+  }
+  local attr_name = attr_id_map[attr_id]
+  if attr_name ~= nil then
+    return self.attributes[attr_name]
+  end
+  return nil
+end
+
+function PowerTopology:get_server_command_by_id(command_id)
+  local server_id_map = {
+  }
+  if server_id_map[command_id] ~= nil then
+    return self.server.commands[server_id_map[command_id]]
+  end
+  return nil
+end
+
+
+PowerTopology.attribute_direction_map = {
+  ["AvailableEndpoints"] = "server",
+  ["ActiveEndpoints"] = "server",
+  ["AcceptedCommandList"] = "server",
+  ["EventList"] = "server",
+  ["AttributeList"] = "server",
+}
+
+PowerTopology.command_direction_map = {
+}
+
+PowerTopology.FeatureMap = PowerTopology.types.Feature
+
+function PowerTopology.are_features_supported(feature, feature_map)
+  if (PowerTopology.FeatureMap.bits_are_valid(feature)) then
+    return (feature & feature_map) == feature
+  end
+  return false
+end
+
+local attribute_helper_mt = {}
+attribute_helper_mt.__index = function(self, key)
+  local direction = PowerTopology.attribute_direction_map[key]
+  if direction == nil then
+    error(string.format("Referenced unknown attribute %s on cluster %s", key, PowerTopology.NAME))
+  end
+  return PowerTopology[direction].attributes[key]
+end
+PowerTopology.attributes = {}
+setmetatable(PowerTopology.attributes, attribute_helper_mt)
+
+setmetatable(PowerTopology, {__index = cluster_base})
+
+return PowerTopology
+

drivers/SmartThings/matter-switch/src/embedded_clusters/PowerTopology/server/attributes/AvailableEndpoints.lua

@@ -0,0 +1,75 @@
+local cluster_base = require "st.matter.cluster_base"
+local data_types = require "st.matter.data_types"
+local TLVParser = require "st.matter.TLV.TLVParser"
+
+local AvailableEndpoints = {
+  ID = 0x0000,
+  NAME = "AvailableEndpoints",
+  base_type = require "st.matter.data_types.Array",
+  element_type = require "st.matter.data_types.Uint16",
+}
+
+function AvailableEndpoints:augment_type(data_type_obj)
+  for i, v in ipairs(data_type_obj.elements) do
+    data_type_obj.elements[i] = data_types.validate_or_build_type(v, AvailableEndpoints.element_type)
+  end
+end
+
+function AvailableEndpoints:new_value(...)
+  local o = self.base_type(table.unpack({...}))
+
+  return o
+end
+
+function AvailableEndpoints:read(device, endpoint_id)
+  return cluster_base.read(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    nil
+  )
+end
+
+function AvailableEndpoints:subscribe(device, endpoint_id)
+  return cluster_base.subscribe(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    nil
+  )
+end
+
+function AvailableEndpoints:set_parent_cluster(cluster)
+  self._cluster = cluster
+  return self
+end
+
+function AvailableEndpoints:build_test_report_data(
+  device,
+  endpoint_id,
+  value,
+  status
+)
+  local data = data_types.validate_or_build_type(value, self.base_type)
+
+  return cluster_base.build_test_report_data(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    data,
+    status
+  )
+end
+
+function AvailableEndpoints:deserialize(tlv_buf)
+  local data = TLVParser.decode_tlv(tlv_buf)
+
+  return data
+end
+
+setmetatable(AvailableEndpoints, {__call = AvailableEndpoints.new_value, __index = AvailableEndpoints.base_type})
+return AvailableEndpoints
+

drivers/SmartThings/matter-switch/src/embedded_clusters/PowerTopology/server/attributes/init.lua

@@ -0,0 +1,20 @@
+local attr_mt = {}
+attr_mt.__index = function(self, key)
+  local req_loc = string.format("embedded_clusters.PowerTopology.server.attributes.%s", key)
+  local raw_def = require(req_loc)
+  local cluster = rawget(self, "_cluster")
+  raw_def:set_parent_cluster(cluster)
+  return raw_def
+end
+
+local PowerTopologyServerAttributes = {}
+
+function PowerTopologyServerAttributes:set_parent_cluster(cluster)
+  self._cluster = cluster
+  return self
+end
+
+setmetatable(PowerTopologyServerAttributes, attr_mt)
+
+return PowerTopologyServerAttributes
+

drivers/SmartThings/matter-switch/src/embedded_clusters/PowerTopology/types/Feature.lua

@@ -0,0 +1,117 @@
+local data_types = require "st.matter.data_types"
+local UintABC = require "st.matter.data_types.base_defs.UintABC"
+
+local Feature = {}
+local new_mt = UintABC.new_mt({NAME = "Feature", ID = data_types.name_to_id_map["Uint32"]}, 4)
+
+Feature.BASE_MASK = 0xFFFF
+Feature.NODE_TOPOLOGY = 0x0001
+Feature.TREE_TOPOLOGY = 0x0002
+Feature.SET_TOPOLOGY = 0x0004
+Feature.DYNAMIC_POWER_FLOW = 0x0008
+
+Feature.mask_fields = {
+  BASE_MASK = 0xFFFF,
+  NODE_TOPOLOGY = 0x0001,
+  TREE_TOPOLOGY = 0x0002,
+  SET_TOPOLOGY = 0x0004,
+  DYNAMIC_POWER_FLOW = 0x0008,
+}
+
+Feature.is_node_topology_set = function(self)
+  return (self.value & self.NODE_TOPOLOGY) ~= 0
+end
+
+Feature.set_node_topology = function(self)
+  if self.value ~= nil then
+    self.value = self.value | self.NODE_TOPOLOGY
+  else
+    self.value = self.NODE_TOPOLOGY
+  end
+end
+
+Feature.unset_node_topology = function(self)
+  self.value = self.value & (~self.NODE_TOPOLOGY & self.BASE_MASK)
+end
+Feature.is_tree_topology_set = function(self)
+  return (self.value & self.TREE_TOPOLOGY) ~= 0
+end
+
+Feature.set_tree_topology = function(self)
+  if self.value ~= nil then
+    self.value = self.value | self.TREE_TOPOLOGY
+  else
+    self.value = self.TREE_TOPOLOGY
+  end
+end
+
+Feature.unset_tree_topology = function(self)
+  self.value = self.value & (~self.TREE_TOPOLOGY & self.BASE_MASK)
+end
+Feature.is_set_topology_set = function(self)
+  return (self.value & self.SET_TOPOLOGY) ~= 0
+end
+
+Feature.set_set_topology = function(self)
+  if self.value ~= nil then
+    self.value = self.value | self.SET_TOPOLOGY
+  else
+    self.value = self.SET_TOPOLOGY
+  end
+end
+
+Feature.unset_set_topology = function(self)
+  self.value = self.value & (~self.SET_TOPOLOGY & self.BASE_MASK)
+end
+Feature.is_dynamic_power_flow_set = function(self)
+  return (self.value & self.DYNAMIC_POWER_FLOW) ~= 0
+end
+
+Feature.set_dynamic_power_flow = function(self)
+  if self.value ~= nil then
+    self.value = self.value | self.DYNAMIC_POWER_FLOW
+  else
+    self.value = self.DYNAMIC_POWER_FLOW
+  end
+end
+
+Feature.unset_dynamic_power_flow = function(self)
+  self.value = self.value & (~self.DYNAMIC_POWER_FLOW & self.BASE_MASK)
+end
+
+function Feature.bits_are_valid(feature)
+  local max =
+    Feature.NODE_TOPOLOGY |
+    Feature.TREE_TOPOLOGY |
+    Feature.SET_TOPOLOGY |
+    Feature.DYNAMIC_POWER_FLOW
+  if (feature <= max) and (feature >= 1) then
+    return true
+  else
+    return false
+  end
+end
+
+Feature.mask_methods = {
+  is_node_topology_set = Feature.is_node_topology_set,
+  set_node_topology = Feature.set_node_topology,
+  unset_node_topology = Feature.unset_node_topology,
+  is_tree_topology_set = Feature.is_tree_topology_set,
+  set_tree_topology = Feature.set_tree_topology,
+  unset_tree_topology = Feature.unset_tree_topology,
+  is_set_topology_set = Feature.is_set_topology_set,
+  set_set_topology = Feature.set_set_topology,
+  unset_set_topology = Feature.unset_set_topology,
+  is_dynamic_power_flow_set = Feature.is_dynamic_power_flow_set,
+  set_dynamic_power_flow = Feature.set_dynamic_power_flow,
+  unset_dynamic_power_flow = Feature.unset_dynamic_power_flow,
+}
+
+Feature.augment_type = function(cls, val)
+  setmetatable(val, new_mt)
+end
+
+setmetatable(Feature, new_mt)
+
+return Feature
+

drivers/SmartThings/matter-switch/src/embedded_clusters/PowerTopology/types/init.lua

@@ -0,0 +1,11 @@
+local types_mt = {}
+types_mt.__index = function(self, key)
+  return require("embedded_clusters.PowerTopology.types." .. key)
+end
+
+local PowerTopologyTypes = {}
+
+setmetatable(PowerTopologyTypes, types_mt)
+
+return PowerTopologyTypes
+

drivers/SmartThings/matter-switch/src/generic_handlers/attribute_handlers.lua

@@ -25,6 +25,14 @@ local color_utils = require "utils.color_utils"
 local cfg = require "utils.device_configuration"
 local device_cfg = cfg.DeviceCfg
 
+-- Include driver-side definitions when lua libs api version is < 11
+if version.api < 11 then
+  clusters.ElectricalEnergyMeasurement.ID = 0x0091
+  clusters.ElectricalPowerMeasurement.ID = 0x0090
+  clusters.PowerTopology = require "embedded_clusters.PowerTopology"
+end
+
+
 local AttributeHandlers = {}
 
 -- [[ ON OFF CLUSTER ATTRIBUTES ]] --

drivers/SmartThings/matter-switch/src/init.lua

@@ -34,6 +34,7 @@ local capability_handlers = require "generic_handlers.capability_handlers"
 if version.api < 11 then
   clusters.ElectricalEnergyMeasurement = require "embedded_clusters.ElectricalEnergyMeasurement"
   clusters.ElectricalPowerMeasurement = require "embedded_clusters.ElectricalPowerMeasurement"
+  clusters.PowerTopology = require "embedded_clusters.PowerTopology"
   clusters.ValveConfigurationAndControl = require "embedded_clusters.ValveConfigurationAndControl"
 end
 

drivers/SmartThings/matter-switch/src/test/test_electrical_sensor.lua

@@ -22,6 +22,7 @@ local version = require "version"
 if version.api < 11 then
   clusters.ElectricalEnergyMeasurement = require "embedded_clusters.ElectricalEnergyMeasurement"
   clusters.ElectricalPowerMeasurement = require "embedded_clusters.ElectricalPowerMeasurement"
+  clusters.PowerTopology = require "embedded_clusters.PowerTopology"
 end
 
 local mock_device = test.mock_device.build_test_matter_device({

drivers/SmartThings/matter-switch/src/utils/switch_utils.lua

@@ -14,11 +14,19 @@
 
 local fields = require "utils.switch_fields"
 local st_utils = require "st.utils"
+local version = require "version"
 local clusters = require "st.matter.clusters"
 local capabilities = require "st.capabilities"
 local im = require "st.matter.interaction_model"
 local log = require "log"
 
+-- Include driver-side definitions when lua libs api version is < 11
+if version.api < 11 then
+  clusters.ElectricalEnergyMeasurement.ID = 0x0091
+  clusters.ElectricalPowerMeasurement.ID = 0x0090
+  clusters.PowerTopology = require "embedded_clusters.PowerTopology"
+end
+
 local utils = {}
 
 function utils.tbl_contains(array, value)