Add support for Irrigation System device type

This adds support for the Irrigation System device type, introduced with
Matter 1.5.

Author: nickolas-deboom

drivers/SmartThings/matter-switch/fingerprints.yml

@@ -3566,6 +3566,11 @@ matterGeneric:
     deviceTypes:
       - id: 0x0110 # Mounted Dimmable Load Control
     deviceProfileName: switch-level
+  - id: "matter/irrigation-system"
+    deviceLabel: Matter Irrigation System
+    deviceTypes:
+      - id: 0x0040 # Irrigation System
+    deviceProfileName: irrigation-system
   - id: "matter/water-valve"
     deviceLabel: Matter Water Valve
     deviceTypes:

drivers/SmartThings/matter-switch/profiles/irrigation-system-level.yml

@@ -0,0 +1,19 @@
+name: irrigation-system-level
+components:
+- id: main
+  capabilities:
+    - id: valve
+      version: 1
+    - id: level
+      version: 1
+      config:
+        values:
+          - key: "level.value"
+            range: [0, 100]
+    - id: firmwareUpdate
+      version: 1
+    - id: refresh
+      version: 1
+  categories:
+  - name: IrrigationSystem
+

drivers/SmartThings/matter-switch/profiles/irrigation-system.yml

@@ -0,0 +1,13 @@
+name: irrigation-system
+components:
+- id: main
+  capabilities:
+    - id: valve
+      version: 1
+    - id: firmwareUpdate
+      version: 1
+    - id: refresh
+      version: 1
+  categories:
+  - name: IrrigationSystem
+

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

@@ -101,7 +101,7 @@ function SwitchLifecycleHandlers.device_init(driver, device)
     end
     device:subscribe()
 
-    -- device energy reporting must be handled cumulatively, periodically, or by both simulatanously.
+    -- device energy reporting must be handled cumulatively, periodically, or by both simultaneously.
     -- To ensure a single source of truth, we only handle a device's periodic reporting if cumulative reporting is not supported.
     if #embedded_cluster_utils.get_endpoints(device, clusters.ElectricalEnergyMeasurement.ID,
       {feature_bitmap = clusters.ElectricalEnergyMeasurement.types.Feature.CUMULATIVE_ENERGY}) > 0 then

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

@@ -18,6 +18,7 @@ end
 local DeviceConfiguration = {}
 local SwitchDeviceConfiguration = {}
 local ButtonDeviceConfiguration = {}
+local ValveDeviceConfiguration = {}
 
 function SwitchDeviceConfiguration.assign_profile_for_onoff_ep(device, server_onoff_ep_id, is_child_device)
   local ep_info = switch_utils.get_endpoint_info(device, server_onoff_ep_id)
@@ -156,6 +157,48 @@ function ButtonDeviceConfiguration.configure_buttons(device)
   end
 end
 
+function ValveDeviceConfiguration.assign_profile_for_valve_ep(device, valve_ep_id)
+  local profile = "irrigation-system"
+
+  for _, ep in ipairs(device.endpoints) do
+    if ep.endpoint_id == valve_ep_id then
+      if switch_utils.find_cluster_on_ep(ep, clusters.ValveConfigurationAndControl.ID) then
+        for _, cluster in ipairs(ep.clusters) do
+          if cluster.cluster_id == clusters.ValveConfigurationAndControl.ID and
+            cluster.feature_map and (cluster.feature_map & clusters.ValveConfigurationAndControl.types.Feature.LEVEL) ~= 0 then
+            profile = profile .. "-level"
+            break
+          end
+        end
+      end
+      break
+    end
+  end
+
+  return profile
+end
+
+function ValveDeviceConfiguration.create_child_devices(driver, device, valve_ep_ids, default_endpoint_id)
+  for device_num, ep_id in ipairs(valve_ep_ids) do
+    local label_and_name = string.format("%s Valve %d", device.label, device_num)
+    local child_profile = ValveDeviceConfiguration.assign_profile_for_valve_ep(device, ep_id)
+    driver:try_create_device(
+      {
+        type = "EDGE_CHILD",
+        label = label_and_name,
+        profile = child_profile,
+        parent_device_id = device.id,
+        parent_assigned_child_key = string.format("%d", ep_id),
+        vendor_provided_label = label_and_name
+      }
+    )
+  end
+
+  -- Persist so that the find_child function is always set on each driver init.
+  device:set_field(fields.IS_PARENT_CHILD_DEVICE, true, {persist = true})
+  device:set_find_child(switch_utils.find_child)
+end
+
 
 -- [[ PROFILE MATCHING AND CONFIGURATIONS ]] --
 
@@ -174,7 +217,40 @@ function DeviceConfiguration.match_profile(driver, device)
   local default_endpoint_id = switch_utils.find_default_endpoint(device)
   local updated_profile
 
-  if #embedded_cluster_utils.get_endpoints(device, clusters.ValveConfigurationAndControl.ID) > 0 then
+  local is_irrigation_system = false
+  for _, ep in ipairs(device.endpoints) do
+    for _, dt in ipairs(ep.device_types) do
+      if dt.device_type_id == fields.DEVICE_TYPE_ID.IRRIGATION_SYSTEM then
+        is_irrigation_system = true
+        break
+      end
+    end
+  end
+
+  local valve_ep_ids = device:get_endpoints(clusters.ValveConfigurationAndControl.ID)
+
+  if is_irrigation_system then
+    updated_profile = "irrigation-system"
+    table.sort(valve_ep_ids)
+    for _, ep in ipairs(device.endpoints) do
+      if ep.endpoint_id == valve_ep_ids[1] then
+        if switch_utils.find_cluster_on_ep(ep, clusters.ValveConfigurationAndControl.ID) then
+          for _, cluster in ipairs(ep.clusters) do
+            if cluster.cluster_id == clusters.ValveConfigurationAndControl.ID and
+              cluster.feature_map and (cluster.feature_map & clusters.ValveConfigurationAndControl.types.Feature.LEVEL) ~= 0 then
+              updated_profile = updated_profile .. "-level"
+              break
+            end
+          end
+        end
+        break
+      end
+    end
+    if #valve_ep_ids > 1 then
+      table.remove(valve_ep_ids, 1) -- the first valve ep is accounted for in the main irrigation system profile
+      ValveDeviceConfiguration.create_child_devices(driver, device, valve_ep_ids, default_endpoint_id)
+    end
+  elseif #valve_ep_ids > 0 then
     updated_profile = "water-valve"
     if #embedded_cluster_utils.get_endpoints(device, clusters.ValveConfigurationAndControl.ID,
       {feature_bitmap = clusters.ValveConfigurationAndControl.types.Feature.LEVEL}) > 0 then
@@ -221,5 +297,6 @@ end
 return {
   DeviceCfg = DeviceConfiguration,
   SwitchCfg = SwitchDeviceConfiguration,
-  ButtonCfg = ButtonDeviceConfiguration
+  ButtonCfg = ButtonDeviceConfiguration,
+  ValveCfg = ValveDeviceConfiguration
 }

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

@@ -43,9 +43,11 @@ SwitchFields.DEVICE_TYPE_ID = {
   DOORBELL = 0x0143,
   ELECTRICAL_SENSOR = 0x0510,
   GENERIC_SWITCH = 0x000F,
+  IRRIGATION_SYSTEM = 0x0040,
   MOUNTED_ON_OFF_CONTROL = 0x010F,
   MOUNTED_DIMMABLE_LOAD_CONTROL = 0x0110,
   ON_OFF_PLUG_IN_UNIT = 0x010A,
+  WATER_VALVE = 0x0042,
   LIGHT = {
     ON_OFF = 0x0100,
     DIMMABLE = 0x0101,
@@ -148,7 +150,7 @@ SwitchFields.switch_category_vendor_overrides = {
 SwitchFields.ELECTRICAL_SENSOR_EPS = "__electrical_sensor_eps"
 
 --- used in tandem with an EP ID. Stores the required electrical tags "-power", "-energy-powerConsumption", etc.
---- for an Electrical Sensor EP with a "primary" endpoint, used during device profling.
+--- for an Electrical Sensor EP with a "primary" endpoint, used during device profiling.
 SwitchFields.ELECTRICAL_TAGS = "__electrical_tags"
 
 SwitchFields.profiling_data = {
@@ -299,6 +301,10 @@ SwitchFields.device_type_attribute_map = {
     clusters.ElectricalPowerMeasurement.attributes.ActivePower,
     clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported,
     clusters.ElectricalEnergyMeasurement.attributes.PeriodicEnergyImported
+  },
+  [SwitchFields.DEVICE_TYPE_ID.WATER_VALVE] = {
+    clusters.ValveConfigurationAndControl.attributes.CurrentState,
+    clusters.ValveConfigurationAndControl.attributes.CurrentLevel
   }
 }
 

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

@@ -187,6 +187,11 @@ function utils.find_default_endpoint(device)
     end
   end
 
+  local water_valve_eps = utils.get_endpoints_by_device_type(device, fields.DEVICE_TYPE_ID.WATER_VALVE)
+  if #water_valve_eps > 0 then
+    return get_first_non_zero_endpoint(water_valve_eps)
+  end
+
   device.log.warn(string.format("Did not find default endpoint, will use endpoint %d instead", device.MATTER_DEFAULT_ENDPOINT))
   return device.MATTER_DEFAULT_ENDPOINT
 end