Remove invalid segment ID test from vacuum clean area tests

Removed debug logging for resetting selected areas.

homeassistant/components/matter/vacuum.py

@@ -10,6 +10,7 @@ from chip.clusters import Objects as clusters
 from matter_server.client.models import device_types
 
 from homeassistant.components.vacuum import (
+    Segment,
     StateVacuumEntity,
     StateVacuumEntityDescription,
     VacuumActivity,
@@ -70,6 +71,7 @@ class MatterVacuum(MatterEntity, StateVacuumEntity):
     """Representation of a Matter Vacuum cleaner entity."""
 
     _last_accepted_commands: list[int] | None = None
+    _last_service_area_feature_map: int | None = None
     _supported_run_modes: (
         dict[int, clusters.RvcRunMode.Structs.ModeOptionStruct] | None
     ) = None
@@ -136,6 +138,16 @@ class MatterVacuum(MatterEntity, StateVacuumEntity):
                 "No supported run mode found to start the vacuum cleaner."
             )
 
+        # Reset selected areas to an unconstrained selection to ensure start
+        # performs a full clean and does not reuse a previous area-targeted
+        # selection.
+        if VacuumEntityFeature.CLEAN_AREA in self.supported_features:
+            # Matter ServiceArea: an empty NewAreas list means unconstrained
+            # operation (full clean).
+            await self.send_device_command(
+                clusters.ServiceArea.Commands.SelectAreas(newAreas=[])
+            )
+
         await self.send_device_command(
             clusters.RvcRunMode.Commands.ChangeToMode(newMode=mode.mode)
         )
@@ -144,6 +156,66 @@ class MatterVacuum(MatterEntity, StateVacuumEntity):
         """Pause the cleaning task."""
         await self.send_device_command(clusters.RvcOperationalState.Commands.Pause())
 
+    @property
+    def _current_segments(self) -> list[Segment]:
+        """Return the current cleanable segments reported by the device."""
+        supported_areas: list[clusters.ServiceArea.Structs.AreaStruct] = (
+            self.get_matter_attribute_value(
+                clusters.ServiceArea.Attributes.SupportedAreas
+            )
+        )
+
+        segments: list[Segment] = []
+        for area in supported_areas:
+            area_name = None
+            if area.areaInfo and area.areaInfo.locationInfo:
+                area_name = area.areaInfo.locationInfo.locationName
+
+            if area_name:
+                segments.append(
+                    Segment(
+                        id=str(area.areaID),
+                        name=area_name,
+                    )
+                )
+
+        return segments
+
+    async def async_get_segments(self) -> list[Segment]:
+        """Get the segments that can be cleaned.
+
+        Returns a list of segments containing their ids and names.
+        """
+        return self._current_segments
+
+    async def async_clean_segments(self, segment_ids: list[str], **kwargs: Any) -> None:
+        """Clean the specified segments.
+
+        Args:
+            segment_ids: List of segment IDs to clean.
+            **kwargs: Additional arguments (unused).
+
+        """
+        # Convert string IDs to integers
+        area_ids = [int(segment_id) for segment_id in segment_ids]
+
+        # Ensure a CLEANING run mode is available before changing device state
+        mode = self._get_run_mode_by_tag(ModeTag.CLEANING)
+        if mode is None:
+            raise HomeAssistantError(
+                "No supported run mode found to start the vacuum cleaner."
+            )
+
+        # Send the SelectAreas command to the vacuum
+        await self.send_device_command(
+            clusters.ServiceArea.Commands.SelectAreas(newAreas=area_ids)
+        )
+
+        # Start cleaning using ChangeToMode with CLEANING tag
+        await self.send_device_command(
+            clusters.RvcRunMode.Commands.ChangeToMode(newMode=mode.mode)
+        )
+
     @callback
     def _update_from_device(self) -> None:
         """Update from device."""
@@ -176,16 +248,34 @@ class MatterVacuum(MatterEntity, StateVacuumEntity):
                 state = VacuumActivity.CLEANING
         self._attr_activity = state
 
+        if (
+            VacuumEntityFeature.CLEAN_AREA in self.supported_features
+            and self.registry_entry is not None
+            and (last_seen_segments := self.last_seen_segments) is not None
+            and self._current_segments != last_seen_segments
+        ):
+            self.async_create_segments_issue()
+
     @callback
     def _calculate_features(self) -> None:
         """Calculate features for HA Vacuum platform."""
         accepted_operational_commands: list[int] = self.get_matter_attribute_value(
             clusters.RvcOperationalState.Attributes.AcceptedCommandList
         )
-        # in principle the feature set should not change, except for the accepted commands
-        if self._last_accepted_commands == accepted_operational_commands:
+        service_area_feature_map: int | None = self.get_matter_attribute_value(
+            clusters.ServiceArea.Attributes.FeatureMap
+        )
+
+        # In principle the feature set should not change, except for accepted
+        # commands and service area feature map.
+        if (
+            self._last_accepted_commands == accepted_operational_commands
+            and self._last_service_area_feature_map == service_area_feature_map
+        ):
             return
+
         self._last_accepted_commands = accepted_operational_commands
+        self._last_service_area_feature_map = service_area_feature_map
         supported_features: VacuumEntityFeature = VacuumEntityFeature(0)
         supported_features |= VacuumEntityFeature.START
         supported_features |= VacuumEntityFeature.STATE
@@ -212,6 +302,12 @@ class MatterVacuum(MatterEntity, StateVacuumEntity):
             in accepted_operational_commands
         ):
             supported_features |= VacuumEntityFeature.RETURN_HOME
+        # Check if Map feature is enabled for clean area support
+        if (
+            service_area_feature_map is not None
+            and service_area_feature_map & clusters.ServiceArea.Bitmaps.Feature.kMaps
+        ):
+            supported_features |= VacuumEntityFeature.CLEAN_AREA
 
         self._attr_supported_features = supported_features
 
@@ -228,6 +324,10 @@ DISCOVERY_SCHEMAS = [
             clusters.RvcRunMode.Attributes.CurrentMode,
             clusters.RvcOperationalState.Attributes.OperationalState,
         ),
+        optional_attributes=(
+            clusters.ServiceArea.Attributes.FeatureMap,
+            clusters.ServiceArea.Attributes.SupportedAreas,
+        ),
         device_type=(device_types.RoboticVacuumCleaner,),
         allow_none_value=True,
     ),

tests/components/matter/snapshots/test_vacuum.ambr

@@ -29,7 +29,7 @@
     'platform': 'matter',
     'previous_unique_id': None,
     'suggested_object_id': None,
-    'supported_features': <VacuumEntityFeature: 12828>,
+    'supported_features': <VacuumEntityFeature: 29212>,
     'translation_key': 'vacuum',
     'unique_id': '00000000000004D2-000000000000002F-MatterNodeDevice-1-MatterVacuumCleaner-84-1',
     'unit_of_measurement': None,
@@ -39,7 +39,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'friendly_name': 'ecodeebot',
-      'supported_features': <VacuumEntityFeature: 12828>,
+      'supported_features': <VacuumEntityFeature: 29212>,
     }),
     'context': <ANY>,
     'entity_id': 'vacuum.ecodeebot',
@@ -79,7 +79,7 @@
     'platform': 'matter',
     'previous_unique_id': None,
     'suggested_object_id': None,
-    'supported_features': <VacuumEntityFeature: 12828>,
+    'supported_features': <VacuumEntityFeature: 29212>,
     'translation_key': 'vacuum',
     'unique_id': '00000000000004D2-0000000000000028-MatterNodeDevice-1-MatterVacuumCleaner-84-1',
     'unit_of_measurement': None,
@@ -89,7 +89,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'friendly_name': '2BAVS-AB6031X-44PE',
-      'supported_features': <VacuumEntityFeature: 12828>,
+      'supported_features': <VacuumEntityFeature: 29212>,
     }),
     'context': <ANY>,
     'entity_id': 'vacuum.2bavs_ab6031x_44pe',
@@ -129,7 +129,7 @@
     'platform': 'matter',
     'previous_unique_id': None,
     'suggested_object_id': None,
-    'supported_features': <VacuumEntityFeature: 12316>,
+    'supported_features': <VacuumEntityFeature: 28700>,
     'translation_key': 'vacuum',
     'unique_id': '00000000000004D2-0000000000000042-MatterNodeDevice-1-MatterVacuumCleaner-84-1',
     'unit_of_measurement': None,
@@ -139,7 +139,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'friendly_name': 'Mock Vacuum',
-      'supported_features': <VacuumEntityFeature: 12316>,
+      'supported_features': <VacuumEntityFeature: 28700>,
     }),
     'context': <ANY>,
     'entity_id': 'vacuum.mock_vacuum',
@@ -179,7 +179,7 @@
     'platform': 'matter',
     'previous_unique_id': None,
     'suggested_object_id': None,
-    'supported_features': <VacuumEntityFeature: 12316>,
+    'supported_features': <VacuumEntityFeature: 28700>,
     'translation_key': 'vacuum',
     'unique_id': '00000000000004D2-0000000000000061-MatterNodeDevice-1-MatterVacuumCleaner-84-1',
     'unit_of_measurement': None,
@@ -189,7 +189,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'friendly_name': 'K11+',
-      'supported_features': <VacuumEntityFeature: 12316>,
+      'supported_features': <VacuumEntityFeature: 28700>,
     }),
     'context': <ANY>,
     'entity_id': 'vacuum.k11',

tests/components/matter/test_vacuum.py

@@ -1,12 +1,13 @@
 """Test Matter vacuum."""
 
-from unittest.mock import MagicMock, call
+from unittest.mock import MagicMock, call, patch
 
 from chip.clusters import Objects as clusters
 from matter_server.client.models.node import MatterNode
 import pytest
 from syrupy.assertion import SnapshotAssertion
 
+from homeassistant.components.vacuum import DOMAIN as VACUUM_DOMAIN, VacuumEntityFeature
 from homeassistant.const import Platform
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import HomeAssistantError
@@ -71,8 +72,13 @@ async def test_vacuum_actions(
         blocking=True,
     )
 
-    assert matter_client.send_device_command.call_count == 1
-    assert matter_client.send_device_command.call_args == call(
+    assert matter_client.send_device_command.call_count == 2
+    assert matter_client.send_device_command.call_args_list[0] == call(
+        node_id=matter_node.node_id,
+        endpoint_id=1,
+        command=clusters.ServiceArea.Commands.SelectAreas(newAreas=[]),
+    )
+    assert matter_client.send_device_command.call_args_list[1] == call(
         node_id=matter_node.node_id,
         endpoint_id=1,
         command=clusters.RvcRunMode.Commands.ChangeToMode(newMode=1),
@@ -289,5 +295,100 @@ async def test_vacuum_actions_no_supported_run_modes(
             blocking=True,
         )
 
+    component = hass.data["vacuum"]
+    entity = component.get_entity(entity_id)
+    assert entity is not None
+
+    with pytest.raises(
+        HomeAssistantError,
+        match="No supported run mode found to start the vacuum cleaner",
+    ):
+        await entity.async_clean_segments(["7"])
+
     # Ensure no commands were sent to the device
     assert matter_client.send_device_command.call_count == 0
+
+
+@pytest.mark.parametrize("node_fixture", ["mock_vacuum_cleaner"])
+async def test_vacuum_clean_area(
+    hass: HomeAssistant,
+    matter_client: MagicMock,
+    matter_node: MatterNode,
+) -> None:
+    """Test vacuum clean_area action."""
+    # Fetch translations
+    await async_setup_component(hass, "homeassistant", {})
+    entity_id = "vacuum.mock_vacuum"
+    state = hass.states.get(entity_id)
+    assert state
+
+    # Verify CLEAN_AREA feature is supported
+    # Get the entity component to access entity
+    component = hass.data["vacuum"]
+    entity = component.get_entity(entity_id)
+    assert entity is not None
+    assert VacuumEntityFeature.CLEAN_AREA in entity.supported_features
+
+    # Get segments from the entity
+    segments = await entity.async_get_segments()
+    assert len(segments) == 3
+    assert segments[0].id == "7"
+    assert segments[0].name == "My Location A"
+    assert segments[1].id == "1234567"
+    assert segments[1].name == "My Location B"
+    assert segments[2].id == "2290649224"
+    assert segments[2].name == "My Location C"
+
+    # Test clean_segments method directly
+    await entity.async_clean_segments(["7", "1234567"])
+
+    # Verify both commands were sent: SelectAreas followed by ChangeToMode
+    assert matter_client.send_device_command.call_count == 2
+
+    # First call: SelectAreas with the area IDs
+    assert matter_client.send_device_command.call_args_list[0] == call(
+        node_id=matter_node.node_id,
+        endpoint_id=1,
+        command=clusters.ServiceArea.Commands.SelectAreas(newAreas=[7, 1234567]),
+    )
+
+    # Second call: ChangeToMode to start cleaning (mode 1 is the CLEANING mode)
+    assert matter_client.send_device_command.call_args_list[1] == call(
+        node_id=matter_node.node_id,
+        endpoint_id=1,
+        command=clusters.RvcRunMode.Commands.ChangeToMode(newMode=1),
+    )
+
+
+@pytest.mark.parametrize("node_fixture", ["mock_vacuum_cleaner"])
+async def test_vacuum_create_segments_issue_when_segments_changed(
+    hass: HomeAssistant,
+    entity_registry: er.EntityRegistry,
+    matter_client: MagicMock,
+    matter_node: MatterNode,
+) -> None:
+    """Test segments issue callback is triggered when segments changed."""
+    entity_id = "vacuum.mock_vacuum"
+    component = hass.data["vacuum"]
+    entity = component.get_entity(entity_id)
+    assert entity is not None
+
+    entity_registry.async_update_entity_options(
+        entity_id,
+        VACUUM_DOMAIN,
+        {
+            "last_seen_segments": [
+                {
+                    "id": "7",
+                    "name": "Old location A",
+                    "group": None,
+                }
+            ]
+        },
+    )
+
+    with patch.object(entity, "async_create_segments_issue") as mock_create_issue:
+        set_node_attribute(matter_node, 1, 97, 4, 0x02)
+        await trigger_subscription_callback(hass, matter_client)
+
+    assert mock_create_issue.call_count >= 1