Support Soil Sensor device type

Author: nickolas-deboom

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

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

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

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

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,
@@ -243,9 +253,6 @@ local matter_driver_template = {
       clusters.RadonConcentrationMeasurement.attributes.MeasuredValue,
       clusters.RadonConcentrationMeasurement.attributes.MeasurementUnit,
     },
-    [capabilities.relativeHumidityMeasurement.ID] = {
-      clusters.RelativeHumidityMeasurement.attributes.MeasuredValue
-    },
     [capabilities.tvocHealthConcern.ID] = {
       clusters.TotalVolatileOrganicCompoundsConcentrationMeasurement.attributes.LevelValue
     },

drivers/SmartThings/matter-sensor/src/sensor_handlers/attribute_handlers.lua

@@ -9,6 +9,8 @@ local fields = require "sensor_utils.fields"
 local device_cfg = require "sensor_utils.device_configuration"
 local version = require "version"
 
+clusters.SoilMeasurement = require "embedded_clusters.SoilMeasurement"
+
 local AttributeHandlers = {}
 
 
@@ -69,16 +71,24 @@ function AttributeHandlers.humidity_measured_value_handler(driver, device, ib, r
 end
 
 
+-- [[ SOIL MEASUREMENT CLUSTER ATTRIBUTES ]] --
+
+function AttributeHandlers.soil_moisture_measured_value_handler(driver, device, ib, response)
+  if ib.data.value == nil then return end
+  device:emit_event_for_endpoint(ib.endpoint_id, capabilities.relativeHumidityMeasurement.humidity(ib.data.value))
+end
+
+
 -- [[ BOOLEAN STATE CLUSTER ATTRIBUTES ]] --
 
 function AttributeHandlers.boolean_state_value_handler(driver, device, ib, response)
   local name
   for dt_name, _ in pairs(fields.BOOLEAN_DEVICE_TYPE_INFO) do
-      local dt_ep_id = device:get_field(dt_name)
-      if ib.endpoint_id == dt_ep_id then
-          name = dt_name
-          break
-      end
+    local dt_ep_id = device:get_field(dt_name)
+    if ib.endpoint_id == dt_ep_id then
+      name = dt_name
+      break
+    end
   end
   if name then
     device:emit_event_for_endpoint(ib.endpoint_id, fields.BOOLEAN_CAP_EVENT_MAP[ib.data.value][name])

drivers/SmartThings/matter-sensor/src/sensor_utils/device_configuration.lua

@@ -59,6 +59,12 @@ function DeviceConfiguration.match_profile(driver, device, battery_supported)
 
   if device:supports_capability(capabilities.relativeHumidityMeasurement) then
     profile_name = profile_name .. "-humidity"
+    -- Soil Sensor fingerprints to the humidity profile, so we should also check for
+    -- TemperatureMeasurement, which is an optional cluster for this device type.
+    if #device:get_endpoints(clusters.SoilMeasurement.ID) > 0 and
+      #device:get_endpoints(clusters.TemperatureMeasurement.ID) > 0 then
+      profile_name = "-temperature" .. profile_name
+    end
   end
 
   if device:supports_capability(capabilities.atmosphericPressureMeasurement) then
@@ -117,8 +123,7 @@ function DeviceConfiguration.match_profile(driver, device, battery_supported)
   -- remove leading "-"
   profile_name = string.sub(profile_name, 2)
 
-  device.log.info_with({hub_logs=true}, string.format("Updating device profile to %s.", profile_name))
   device:try_update_metadata({profile = profile_name})
 end
 
-return DeviceConfiguration
+return DeviceConfiguration

drivers/SmartThings/matter-sensor/src/test/test_matter_soil_sensor.lua

@@ -0,0 +1,148 @@
+-- Copyright © 2026 SmartThings, Inc.
+-- Licensed under the Apache License, Version 2.0
+
+local capabilities = require "st.capabilities"
+local clusters = require "st.matter.clusters"
+local t_utils = require "integration_test.utils"
+local test = require "integration_test"
+
+local mock_device = test.mock_device.build_test_matter_device({
+  profile = t_utils.get_profile_definition("humidity.yml"),
+  manufacturer_info = { vendor_id = 0x0000, product_id = 0x0000 },
+  endpoints = {
+    {
+      endpoint_id = 0,
+      clusters = {
+        { cluster_id = clusters.Basic.ID, cluster_type = "SERVER" },
+      },
+      device_types = {
+        { device_type_id = 0x0016, device_type_revision = 1 } -- RootNode
+      }
+    },
+    {
+      endpoint_id = 1,
+      clusters = {
+        { cluster_id = clusters.SoilMeasurement.ID, cluster_type = "SERVER" },
+        { cluster_id = clusters.TemperatureMeasurement.ID, cluster_type = "SERVER" },
+      },
+      device_types = {
+        { device_type_id = 0x0045, device_type_revision = 1 } -- Soil Sensor
+      }
+    },
+  }
+})
+
+local subscribe_request
+
+local cluster_subscribe_list = {
+  clusters.SoilMeasurement.attributes.SoilMoistureMeasuredValue,
+}
+
+local additional_subscribed_attributes = {
+  clusters.TemperatureMeasurement.attributes.MeasuredValue,
+  clusters.TemperatureMeasurement.attributes.MinMeasuredValue,
+  clusters.TemperatureMeasurement.attributes.MaxMeasuredValue
+}
+
+local function test_init()
+  subscribe_request = cluster_subscribe_list[1]:subscribe(mock_device)
+  for i, cluster in ipairs(cluster_subscribe_list) do
+    if i > 1 then
+      subscribe_request:merge(cluster:subscribe(mock_device))
+    end
+  end
+
+  test.disable_startup_messages()
+  test.mock_device.add_test_device(mock_device)
+  test.socket.device_lifecycle:__queue_receive({ mock_device.id, "added" })
+  test.socket.device_lifecycle:__queue_receive({ mock_device.id, "init" })
+  test.socket.matter:__expect_send({mock_device.id, subscribe_request})
+end
+test.set_test_init_function(test_init)
+
+local function update_device_profile()
+  test.socket.device_lifecycle:__queue_receive({ mock_device.id, "doConfigure" })
+  mock_device:expect_metadata_update({ profile = "temperature-humidity" })
+  mock_device:expect_metadata_update({ provisioning_state = "PROVISIONED" })
+
+  test.wait_for_events()
+
+  local updated_device_profile = t_utils.get_profile_definition("temperature-humidity.yml")
+  test.socket.device_lifecycle:__queue_receive(mock_device:generate_info_changed({ profile = updated_device_profile }))
+  for _, attr in ipairs(additional_subscribed_attributes) do
+    subscribe_request:merge(attr:subscribe(mock_device))
+  end
+  test.socket.matter:__expect_send({mock_device.id, subscribe_request})
+end
+
+test.register_coroutine_test(
+  "Relative humidity reports should generate correct messages",
+  function()
+    update_device_profile()
+    test.wait_for_events()
+    test.socket.matter:__queue_receive(
+      {
+        mock_device.id,
+        clusters.RelativeHumidityMeasurement.server.attributes.MeasuredValue:build_test_report_data(mock_device, 1, 4049)
+      }
+    )
+    test.socket.capability:__expect_send(
+      mock_device:generate_test_message("main", capabilities.relativeHumidityMeasurement.humidity({ value = 40 }))
+    )
+
+    test.socket.matter:__queue_receive(
+      {
+        mock_device.id,
+        clusters.RelativeHumidityMeasurement.server.attributes.MeasuredValue:build_test_report_data(mock_device, 1, 4050)
+      }
+    )
+    test.socket.capability:__expect_send(
+      mock_device:generate_test_message("main", capabilities.relativeHumidityMeasurement.humidity({ value = 41 }))
+    )
+  end
+)
+
+test.register_coroutine_test(
+  "Temperature reports should generate correct messages",
+  function()
+    update_device_profile()
+    test.wait_for_events()
+    test.socket.matter:__queue_receive(
+      {
+        mock_device.id,
+        clusters.TemperatureMeasurement.server.attributes.MeasuredValue:build_test_report_data(mock_device, 1, 40*100)
+      }
+    )
+    test.socket.capability:__expect_send(
+      mock_device:generate_test_message("main", capabilities.temperatureMeasurement.temperature({ value = 40.0, unit = "C" }))
+    )
+  end
+)
+
+test.register_coroutine_test(
+  "Min and max temperature attributes set capability constraint",
+  function()
+    update_device_profile()
+    test.wait_for_events()
+    test.socket.matter:__queue_receive(
+      {
+        mock_device.id,
+        clusters.TemperatureMeasurement.attributes.MinMeasuredValue:build_test_report_data(mock_device, 1, 500)
+      }
+    )
+    test.socket.matter:__queue_receive(
+      {
+        mock_device.id,
+        clusters.TemperatureMeasurement.attributes.MaxMeasuredValue:build_test_report_data(mock_device, 1, 4000)
+      }
+    )
+    test.socket.capability:__expect_send(
+      mock_device:generate_test_message(
+        "main",
+        capabilities.temperatureMeasurement.temperatureRange({ value = { minimum = 5.00, maximum = 40.00 }, unit = "C" })
+      )
+    )
+  end
+)
+
+test.run_registered_tests()