add support for matter hrap device types

Author: hcarter-775

drivers/SmartThings/matter-hrap/config.yml

@@ -0,0 +1,6 @@
+name: 'Matter HRAP'
+packageKey: 'matter-hrap'
+permissions:
+  matter: {}
+description: "SmartThings driver for Matter HRAP devices"
+vendorSupportInformation: "https://support.smartthings.com"

drivers/SmartThings/matter-hrap/fingerprints.yml

@@ -0,0 +1,11 @@
+matterGeneric:
+  - id: "matter/network-manager"
+    deviceLabel: Matter Network Infrastructure Manager
+    deviceTypes:
+      - id: 0x0090 # NIM
+    deviceProfileName: network-infrastructure-manager
+  - id: "matter/thread-border-router"
+    deviceLabel: Matter Thread Border Router
+    deviceTypes:
+      - id: 0x0091 # TBR
+    deviceProfileName: thread-border-router

drivers/SmartThings/matter-hrap/profiles/network-infrastructure-manager.yml

@@ -0,0 +1,16 @@
+name: network-infrastructure-manager
+components:
+- id: main
+  capabilities:
+  - id: threadBorderRouter
+    version: 1
+  - id: threadNetwork
+    version: 1
+  - id: wifiInformation
+    version: 1
+  - id: firmwareUpdate
+    version: 1
+  - id: refresh
+    version: 1
+  categories:
+  - name: Networking

drivers/SmartThings/matter-hrap/profiles/thread-border-router.yml

@@ -0,0 +1,14 @@
+name: thread-border-router
+components:
+- id: main
+  capabilities:
+  - id: threadBorderRouter
+    version: 1
+  - id: threadNetwork
+    version: 1
+  - id: firmwareUpdate
+    version: 1
+  - id: refresh
+    version: 1
+  categories:
+  - name: Networking

drivers/SmartThings/matter-hrap/src/ThreadBorderRouterManagement/client/commands/DatasetResponse.lua

@@ -0,0 +1,103 @@
+local data_types = require "st.matter.data_types"
+local TLVParser = require "st.matter.TLV.TLVParser"
+
+local DatasetResponse = {}
+
+DatasetResponse.NAME = "DatasetResponse"
+DatasetResponse.ID = 0x0002
+DatasetResponse.field_defs = {
+  {
+    name = "dataset",
+    field_id = 0,
+    is_nullable = false,
+    is_optional = false,
+    data_type = require "st.matter.data_types.OctetString1",
+  },
+}
+
+function DatasetResponse:augment_type(base_type_obj)
+  local elems = {}
+  for _, v in ipairs(base_type_obj.elements) do
+    for _, field_def in ipairs(self.field_defs) do
+      if field_def.field_id == v.field_id and
+         field_def.is_nullable and
+         (v.value == nil and v.elements == nil) then
+        elems[field_def.name] = data_types.validate_or_build_type(v, data_types.Null, field_def.field_name)
+      elseif field_def.field_id == v.field_id and not
+        (field_def.is_optional and v.value == nil) then
+        elems[field_def.name] = data_types.validate_or_build_type(v, field_def.data_type, field_def.field_name)
+        if field_def.element_type ~= nil then
+          for i, e in ipairs(elems[field_def.name].elements) do
+            elems[field_def.name].elements[i] = data_types.validate_or_build_type(e, field_def.element_type)
+          end
+        end
+      end
+    end
+  end
+  base_type_obj.elements = elems
+end
+
+function DatasetResponse:build_test_command_response(device, endpoint_id, dataset, interaction_status)
+  local function init(self, device, endpoint_id, dataset)
+    local out = {}
+    local args = {dataset}
+    if #args > #self.field_defs then
+      error(self.NAME .. " received too many arguments")
+    end
+    for i,v in ipairs(self.field_defs) do
+      if v.is_optional and args[i] == nil then
+        out[v.name] = nil
+      elseif v.is_nullable and args[i] == nil then
+        out[v.name] = data_types.validate_or_build_type(args[i], data_types.Null, v.name)
+        out[v.name].field_id = v.field_id
+      elseif not v.is_optional and args[i] == nil then
+        out[v.name] = data_types.validate_or_build_type(v.default, v.data_type, v.name)
+        out[v.name].field_id = v.field_id
+      else
+        out[v.name] = data_types.validate_or_build_type(args[i], v.data_type, v.name)
+        out[v.name].field_id = v.field_id
+      end
+    end
+    setmetatable(out, {
+      __index = DatasetResponse,
+      __tostring = DatasetResponse.pretty_print
+    })
+    return self._cluster:build_cluster_command(
+      device,
+      out,
+      endpoint_id,
+      self._cluster.ID,
+      self.ID,
+      false,
+      true
+    )
+  end
+  local self_request =  init(self, device, endpoint_id, dataset)
+  return self._cluster:build_test_command_response(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    self_request.info_blocks[1].tlv,
+    interaction_status
+  )
+end
+
+function DatasetResponse:init()
+  return nil
+end
+
+function DatasetResponse:set_parent_cluster(cluster)
+  self._cluster = cluster
+  return self
+end
+
+function DatasetResponse:deserialize(tlv_buf)
+  local data = TLVParser.decode_tlv(tlv_buf)
+  self:augment_type(data)
+  return data
+end
+
+setmetatable(DatasetResponse, {__call = DatasetResponse.init})
+
+return DatasetResponse

drivers/SmartThings/matter-hrap/src/ThreadBorderRouterManagement/client/commands/init.lua

@@ -0,0 +1,23 @@
+local command_mt = {}
+command_mt.__command_cache = {}
+command_mt.__index = function(self, key)
+  if command_mt.__command_cache[key] == nil then
+    local req_loc = string.format("ThreadBorderRouterManagement.client.commands.%s", key)
+    local raw_def = require(req_loc)
+    local cluster = rawget(self, "_cluster")
+    command_mt.__command_cache[key] = raw_def:set_parent_cluster(cluster)
+  end
+  return command_mt.__command_cache[key]
+end
+
+local ThreadBorderRouterManagementClientCommands = {}
+
+function ThreadBorderRouterManagementClientCommands:set_parent_cluster(cluster)
+  self._cluster = cluster
+  return self
+end
+
+setmetatable(ThreadBorderRouterManagementClientCommands, command_mt)
+
+return ThreadBorderRouterManagementClientCommands
+

drivers/SmartThings/matter-hrap/src/ThreadBorderRouterManagement/init.lua

@@ -0,0 +1,148 @@
+local cluster_base = require "st.matter.cluster_base"
+local ThreadBorderRouterManagementServerAttributes = require "ThreadBorderRouterManagement.server.attributes"
+local ThreadBorderRouterManagementServerCommands = require "ThreadBorderRouterManagement.server.commands"
+local ThreadBorderRouterManagementClientCommands = require "ThreadBorderRouterManagement.client.commands"
+local ThreadBorderRouterManagementTypes = require "ThreadBorderRouterManagement.types"
+
+local ThreadBorderRouterManagement = {}
+
+ThreadBorderRouterManagement.ID = 0x0452
+ThreadBorderRouterManagement.NAME = "ThreadBorderRouterManagement"
+ThreadBorderRouterManagement.server = {}
+ThreadBorderRouterManagement.client = {}
+ThreadBorderRouterManagement.server.attributes = ThreadBorderRouterManagementServerAttributes:set_parent_cluster(ThreadBorderRouterManagement)
+ThreadBorderRouterManagement.server.commands = ThreadBorderRouterManagementServerCommands:set_parent_cluster(ThreadBorderRouterManagement)
+ThreadBorderRouterManagement.client.commands = ThreadBorderRouterManagementClientCommands:set_parent_cluster(ThreadBorderRouterManagement)
+ThreadBorderRouterManagement.types = ThreadBorderRouterManagementTypes
+
+function ThreadBorderRouterManagement:get_attribute_by_id(attr_id)
+  local attr_id_map = {
+    [0x0000] = "BorderRouterName",
+    [0x0001] = "BorderAgentID",
+    [0x0002] = "ThreadVersion",
+    [0x0003] = "InterfaceEnabled",
+    [0x0004] = "ActiveDatasetTimestamp",
+    [0x0005] = "PendingDatasetTimestamp",
+    [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 ThreadBorderRouterManagement:get_server_command_by_id(command_id)
+  local server_id_map = {
+    [0x0000] = "GetActiveDatasetRequest",
+    [0x0001] = "GetPendingDatasetRequest",
+    [0x0003] = "SetActiveDatasetRequest",
+    [0x0004] = "SetPendingDatasetRequest",
+  }
+  if server_id_map[command_id] ~= nil then
+    return self.server.commands[server_id_map[command_id]]
+  end
+  return nil
+end
+
+function ThreadBorderRouterManagement:get_client_command_by_id(command_id)
+  local client_id_map = {
+    [0x0002] = "DatasetResponse",
+  }
+  if client_id_map[command_id] ~= nil then
+    return self.client.commands[client_id_map[command_id]]
+  end
+  return nil
+end
+
+ThreadBorderRouterManagement.attribute_direction_map = {
+  ["BorderRouterName"] = "server",
+  ["BorderAgentID"] = "server",
+  ["ThreadVersion"] = "server",
+  ["InterfaceEnabled"] = "server",
+  ["ActiveDatasetTimestamp"] = "server",
+  ["PendingDatasetTimestamp"] = "server",
+  ["AcceptedCommandList"] = "server",
+  ["EventList"] = "server",
+  ["AttributeList"] = "server",
+}
+
+do
+  local has_aliases, aliases = pcall(require, "st.matter.clusters.aliases.ThreadBorderRouterManagement.server.attributes")
+  if has_aliases then
+    for alias, _ in pairs(aliases) do
+      ThreadBorderRouterManagement.attribute_direction_map[alias] = "server"
+    end
+  end
+end
+
+ThreadBorderRouterManagement.command_direction_map = {
+  ["GetActiveDatasetRequest"] = "server",
+  ["GetPendingDatasetRequest"] = "server",
+  ["SetActiveDatasetRequest"] = "server",
+  ["SetPendingDatasetRequest"] = "server",
+  ["DatasetResponse"] = "client",
+}
+
+do
+  local has_aliases, aliases = pcall(require, "st.matter.clusters.aliases.ThreadBorderRouterManagement.server.commands")
+  if has_aliases then
+    for alias, _ in pairs(aliases) do
+      ThreadBorderRouterManagement.command_direction_map[alias] = "server"
+    end
+  end
+end
+
+do
+  local has_aliases, aliases = pcall(require, "st.matter.clusters.aliases.ThreadBorderRouterManagement.client.commands")
+  if has_aliases then
+    for alias, _ in pairs(aliases) do
+      ThreadBorderRouterManagement.command_direction_map[alias] = "client"
+    end
+  end
+end
+
+ThreadBorderRouterManagement.FeatureMap = ThreadBorderRouterManagement.types.Feature
+
+function ThreadBorderRouterManagement.are_features_supported(feature, feature_map)
+  if (ThreadBorderRouterManagement.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 = ThreadBorderRouterManagement.attribute_direction_map[key]
+  if direction == nil then
+    error(string.format("Referenced unknown attribute %s on cluster %s", key, ThreadBorderRouterManagement.NAME))
+  end
+  return ThreadBorderRouterManagement[direction].attributes[key]
+end
+ThreadBorderRouterManagement.attributes = {}
+setmetatable(ThreadBorderRouterManagement.attributes, attribute_helper_mt)
+
+local command_helper_mt = {}
+command_helper_mt.__index = function(self, key)
+  local direction = ThreadBorderRouterManagement.command_direction_map[key]
+  if direction == nil then
+    error(string.format("Referenced unknown command %s on cluster %s", key, ThreadBorderRouterManagement.NAME))
+  end
+  return ThreadBorderRouterManagement[direction].commands[key]
+end
+ThreadBorderRouterManagement.commands = {}
+setmetatable(ThreadBorderRouterManagement.commands, command_helper_mt)
+
+local event_helper_mt = {}
+event_helper_mt.__index = function(self, key)
+  return ThreadBorderRouterManagement.server.events[key]
+end
+ThreadBorderRouterManagement.events = {}
+setmetatable(ThreadBorderRouterManagement.events, event_helper_mt)
+
+setmetatable(ThreadBorderRouterManagement, {__index = cluster_base})
+
+return ThreadBorderRouterManagement
+

drivers/SmartThings/matter-hrap/src/ThreadBorderRouterManagement/server/attributes/ActiveDatasetTimestamp.lua

@@ -0,0 +1,68 @@
+local cluster_base = require "st.matter.cluster_base"
+local data_types = require "st.matter.data_types"
+local TLVParser = require "st.matter.TLV.TLVParser"
+
+local ActiveDatasetTimestamp = {
+  ID = 0x0004,
+  NAME = "ActiveDatasetTimestamp",
+  base_type = require "st.matter.data_types.Uint64",
+}
+
+function ActiveDatasetTimestamp:new_value(...)
+  local o = self.base_type(table.unpack({...}))
+
+  return o
+end
+
+function ActiveDatasetTimestamp:read(device, endpoint_id)
+  return cluster_base.read(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    nil
+  )
+end
+
+function ActiveDatasetTimestamp:subscribe(device, endpoint_id)
+  return cluster_base.subscribe(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    nil
+  )
+end
+
+function ActiveDatasetTimestamp:set_parent_cluster(cluster)
+  self._cluster = cluster
+  return self
+end
+
+function ActiveDatasetTimestamp: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 ActiveDatasetTimestamp:deserialize(tlv_buf)
+  local data = TLVParser.decode_tlv(tlv_buf)
+
+  return data
+end
+
+setmetatable(ActiveDatasetTimestamp, {__call = ActiveDatasetTimestamp.new_value, __index = ActiveDatasetTimestamp.base_type})
+return ActiveDatasetTimestamp
+