Support Soil Sensor device type

nickolas-deboom · nickolas-deboom · commit eb50abd876f3 · 2026-02-05T09:25:58.000-06:00
diff --git a/drivers/SmartThings/matter-sensor/fingerprints.yml b/drivers/SmartThings/matter-sensor/fingerprints.yml
@@ -350,3 +350,8 @@ matterGeneric:
     deviceTypes:
       - id: 0x0306 # Flow Sensor
     deviceProfileName: flow-battery
+  - id: "matter/soil/sensor"
+    deviceLabel: Matter Soil Sensor
+    deviceTypes:
+      - id: 0x0045 # Soil Sensor
+    deviceProfileName: humidity
diff --git a/drivers/SmartThings/matter-sensor/src/embedded_clusters/SoilMeasurement/init.lua b/drivers/SmartThings/matter-sensor/src/embedded_clusters/SoilMeasurement/init.lua
@@ -0,0 +1,46 @@
+local cluster_base = require "st.matter.cluster_base"
+local SoilMeasurementServerAttributes = require "embedded_clusters.SoilMeasurement.server.attributes"
+
+local SoilMeasurement = {}
+
+SoilMeasurement.ID = 0x0430
+SoilMeasurement.NAME = "SoilMeasurement"
+SoilMeasurement.server = {}
+SoilMeasurement.client = {}
+SoilMeasurement.server.attributes = SoilMeasurementServerAttributes:set_parent_cluster(SoilMeasurement)
+
+function SoilMeasurement:get_attribute_by_id(attr_id)
+  local attr_id_map = {
+    [0x0000] = "SoilMoistureMeasurementLimits",
+    [0x0001] = "SoilMoistureMeasuredValue",
+    [0xFFF9] = "AcceptedCommandList",
+    [0xFFFB] = "AttributeList",
+  }
+  local attr_name = attr_id_map[attr_id]
+  if attr_name ~= nil then
+    return self.attributes[attr_name]
+  end
+  return nil
+end
+
+SoilMeasurement.attribute_direction_map = {
+  ["SoilMoistureMeasurementLimits"] = "server",
+  ["SoilMoistureMeasuredValue"] = "server",
+  ["AcceptedCommandList"] = "server",
+  ["AttributeList"] = "server",
+}
+
+local attribute_helper_mt = {}
+attribute_helper_mt.__index = function(self, key)
+  local direction = SoilMeasurement.attribute_direction_map[key]
+  if direction == nil then
+    error(string.format("Referenced unknown attribute %s on cluster %s", key, SoilMeasurement.NAME))
+  end
+  return SoilMeasurement[direction].attributes[key]
+end
+SoilMeasurement.attributes = {}
+setmetatable(SoilMeasurement.attributes, attribute_helper_mt)
+
+setmetatable(SoilMeasurement, {__index = cluster_base})
+
+return SoilMeasurement
diff --git a/drivers/SmartThings/matter-sensor/src/embedded_clusters/SoilMeasurement/server/attributes/AcceptedCommandList.lua b/drivers/SmartThings/matter-sensor/src/embedded_clusters/SoilMeasurement/server/attributes/AcceptedCommandList.lua
@@ -0,0 +1,74 @@
+local cluster_base = require "st.matter.cluster_base"
+local data_types = require "st.matter.data_types"
+local TLVParser = require "st.matter.TLV.TLVParser"
+
+local AcceptedCommandList = {
+  ID = 0xFFF9,
+  NAME = "AcceptedCommandList",
+  base_type = require "st.matter.data_types.Array",
+  element_type = require "st.matter.data_types.Uint32",
+}
+
+function AcceptedCommandList: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, AcceptedCommandList.element_type)
+  end
+end
+
+function AcceptedCommandList:new_value(...)
+  local o = self.base_type(table.unpack({...}))
+
+  return o
+end
+
+function AcceptedCommandList:read(device, endpoint_id)
+  return cluster_base.read(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    nil
+  )
+end
+
+function AcceptedCommandList:subscribe(device, endpoint_id)
+  return cluster_base.subscribe(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    nil
+  )
+end
+
+function AcceptedCommandList:set_parent_cluster(cluster)
+  self._cluster = cluster
+  return self
+end
+
+function AcceptedCommandList: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 AcceptedCommandList:deserialize(tlv_buf)
+  local data = TLVParser.decode_tlv(tlv_buf)
+
+  return data
+end
+
+setmetatable(AcceptedCommandList, {__call = AcceptedCommandList.new_value, __index = AcceptedCommandList.base_type})
+return AcceptedCommandList
diff --git a/drivers/SmartThings/matter-sensor/src/embedded_clusters/SoilMeasurement/server/attributes/AttributeList.lua b/drivers/SmartThings/matter-sensor/src/embedded_clusters/SoilMeasurement/server/attributes/AttributeList.lua
@@ -0,0 +1,74 @@
+local cluster_base = require "st.matter.cluster_base"
+local data_types = require "st.matter.data_types"
+local TLVParser = require "st.matter.TLV.TLVParser"
+
+local AttributeList = {
+  ID = 0xFFFB,
+  NAME = "AttributeList",
+  base_type = require "st.matter.data_types.Array",
+  element_type = require "st.matter.data_types.Uint32",
+}
+
+function AttributeList: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, AttributeList.element_type)
+  end
+end
+
+function AttributeList:new_value(...)
+  local o = self.base_type(table.unpack({...}))
+
+  return o
+end
+
+function AttributeList:read(device, endpoint_id)
+  return cluster_base.read(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    nil
+  )
+end
+
+function AttributeList:subscribe(device, endpoint_id)
+  return cluster_base.subscribe(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    nil
+  )
+end
+
+function AttributeList:set_parent_cluster(cluster)
+  self._cluster = cluster
+  return self
+end
+
+function AttributeList: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 AttributeList:deserialize(tlv_buf)
+  local data = TLVParser.decode_tlv(tlv_buf)
+
+  return data
+end
+
+setmetatable(AttributeList, {__call = AttributeList.new_value, __index = AttributeList.base_type})
+return AttributeList
diff --git a/drivers/SmartThings/matter-sensor/src/embedded_clusters/SoilMeasurement/server/attributes/SoilMoistureMeasuredValue.lua b/drivers/SmartThings/matter-sensor/src/embedded_clusters/SoilMeasurement/server/attributes/SoilMoistureMeasuredValue.lua
@@ -0,0 +1,67 @@
+local cluster_base = require "st.matter.cluster_base"
+local data_types = require "st.matter.data_types"
+local TLVParser = require "st.matter.TLV.TLVParser"
+
+local SoilMoistureMeasuredValue = {
+  ID = 0x0001,
+  NAME = "SoilMoistureMeasuredValue",
+  base_type = require "st.matter.data_types.Uint8",
+}
+
+function SoilMoistureMeasuredValue:new_value(...)
+  local o = self.base_type(table.unpack({...}))
+
+  return o
+end
+
+function SoilMoistureMeasuredValue:read(device, endpoint_id)
+  return cluster_base.read(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    nil
+  )
+end
+
+function SoilMoistureMeasuredValue:subscribe(device, endpoint_id)
+  return cluster_base.subscribe(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    nil
+  )
+end
+
+function SoilMoistureMeasuredValue:set_parent_cluster(cluster)
+  self._cluster = cluster
+  return self
+end
+
+function SoilMoistureMeasuredValue: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 SoilMoistureMeasuredValue:deserialize(tlv_buf)
+  local data = TLVParser.decode_tlv(tlv_buf)
+
+  return data
+end
+
+setmetatable(SoilMoistureMeasuredValue, {__call = SoilMoistureMeasuredValue.new_value, __index = SoilMoistureMeasuredValue.base_type})
+return SoilMoistureMeasuredValue
diff --git a/drivers/SmartThings/matter-sensor/src/embedded_clusters/SoilMeasurement/server/attributes/SoilMoistureMeasurementLimits.lua b/drivers/SmartThings/matter-sensor/src/embedded_clusters/SoilMeasurement/server/attributes/SoilMoistureMeasurementLimits.lua
@@ -0,0 +1,67 @@
+local cluster_base = require "st.matter.cluster_base"
+local data_types = require "st.matter.data_types"
+local TLVParser = require "st.matter.TLV.TLVParser"
+
+local SoilMoistureMeasurementLimits = {
+  ID = 0x0000,
+  NAME = "SoilMoistureMeasurementLimits",
+  base_type = require "st.matter.clusters.Global.types.MeasurementAccuracyStruct",
+}
+
+function SoilMoistureMeasurementLimits:new_value(...)
+  local o = self.base_type(table.unpack({...}))
+  self:augment_type(o)
+  return o
+end
+
+function SoilMoistureMeasurementLimits:read(device, endpoint_id)
+  return cluster_base.read(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    nil
+  )
+end
+
+function SoilMoistureMeasurementLimits:subscribe(device, endpoint_id)
+  return cluster_base.subscribe(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    nil
+  )
+end
+
+function SoilMoistureMeasurementLimits:set_parent_cluster(cluster)
+  self._cluster = cluster
+  return self
+end
+
+function SoilMoistureMeasurementLimits:build_test_report_data(
+  device,
+  endpoint_id,
+  value,
+  status
+)
+  local data = data_types.validate_or_build_type(value, self.base_type)
+  self:augment_type(data)
+  return cluster_base.build_test_report_data(
+    device,
+    endpoint_id,
+    self._cluster.ID,
+    self.ID,
+    data,
+    status
+  )
+end
+
+function SoilMoistureMeasurementLimits:deserialize(tlv_buf)
+  local data = TLVParser.decode_tlv(tlv_buf)
+  self:augment_type(data)
+  return data
+end
+
+setmetatable(SoilMoistureMeasurementLimits, {__call = SoilMoistureMeasurementLimits.new_value, __index = SoilMoistureMeasurementLimits.base_type})
+return SoilMoistureMeasurementLimits
diff --git a/drivers/SmartThings/matter-sensor/src/embedded_clusters/SoilMeasurement/server/attributes/init.lua b/drivers/SmartThings/matter-sensor/src/embedded_clusters/SoilMeasurement/server/attributes/init.lua
@@ -0,0 +1,19 @@
+local attr_mt = {}
+attr_mt.__index = function(self, key)
+  local req_loc = string.format("embedded_clusters.SoilMeasurement.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 SoilMeasurementServerAttributes = {}
+
+function SoilMeasurementServerAttributes:set_parent_cluster(cluster)
+  self._cluster = cluster
+  return self
+end
+
+setmetatable(SoilMeasurementServerAttributes, attr_mt)
+
+return SoilMeasurementServerAttributes
diff --git a/drivers/SmartThings/matter-sensor/src/init.lua b/drivers/SmartThings/matter-sensor/src/init.lua
@@ -16,6 +16,12 @@ if not pcall(function(cluster) return clusters[cluster] end,
   clusters.PressureMeasurement = require "embedded_clusters.PressureMeasurement"
 end
 
+-- This can be removed once LuaLibs supports the SoilMeasurement cluster
+if not pcall(function(cluster) return clusters[cluster] end,
+  "SoilMeasurement") then
+  clusters.SoilMeasurement = require "embedded_clusters.SoilMeasurement"
+end
+
 -- Include driver-side definitions when lua libs api version is < 10
 if version.api < 10 then
   clusters.AirQuality = require "embedded_clusters.AirQuality"
@@ -117,6 +123,9 @@ local matter_driver_template = {
       [clusters.RelativeHumidityMeasurement.ID] = {
         [clusters.RelativeHumidityMeasurement.attributes.MeasuredValue.ID] = attribute_handlers.humidity_measured_value_handler
       },
+      [clusters.SoilMeasurement.ID] = {
+        [clusters.SoilMeasurement.attributes.SoilMoistureMeasuredValue.ID] = attribute_handlers.soil_moisture_measured_value_handler
+      },
       [clusters.TemperatureMeasurement.ID] = {
         [clusters.TemperatureMeasurement.attributes.MeasuredValue.ID] = attribute_handlers.temperature_measured_value_handler,
         [clusters.TemperatureMeasurement.attributes.MinMeasuredValue.ID] = attribute_handlers.temperature_measured_value_bounds_factory(fields.TEMP_MIN),
@@ -164,7 +173,8 @@ local matter_driver_template = {
       clusters.BooleanState.attributes.StateValue,
     },
     [capabilities.relativeHumidityMeasurement.ID] = {
-      clusters.RelativeHumidityMeasurement.attributes.MeasuredValue
+      clusters.RelativeHumidityMeasurement.attributes.MeasuredValue,
+      clusters.SoilMeasurement.attributes.SoilMoistureMeasuredValue
     },
     [capabilities.temperatureAlarm.ID] = {
       clusters.BooleanState.attributes.StateValue,
diff --git a/drivers/SmartThings/matter-sensor/src/sensor_handlers/attribute_handlers.lua b/drivers/SmartThings/matter-sensor/src/sensor_handlers/attribute_handlers.lua
