Add lawn_mower platform to MQTT (#98831)

* Add MQTT lawn_mower platform

* Use separate command topics and templates

* Remove unrelated change

homeassistant/components/mqtt/abbreviations.py

@@ -3,6 +3,8 @@
 ABBREVIATIONS = {
     "act_t": "action_topic",
     "act_tpl": "action_template",
+    "act_stat_t": "activity_state_topic",
+    "act_val_tpl": "activity_value_template",
     "atype": "automation_type",
     "aux_cmd_t": "aux_command_topic",
     "aux_stat_tpl": "aux_state_template",
@@ -54,6 +56,8 @@ ABBREVIATIONS = {
     "dir_val_tpl": "direction_value_template",
     "dock_t": "docked_topic",
     "dock_tpl": "docked_template",
+    "dock_cmd_t": "dock_command_topic",
+    "dock_cmd_tpl": "dock_command_template",
     "e": "encoding",
     "en": "enabled_by_default",
     "ent_cat": "entity_category",
@@ -121,6 +125,8 @@ ABBREVIATIONS = {
     "osc_cmd_tpl": "oscillation_command_template",
     "osc_stat_t": "oscillation_state_topic",
     "osc_val_tpl": "oscillation_value_template",
+    "pause_cmd_t": "pause_command_topic",
+    "pause_mw_cmd_tpl": "pause_command_template",
     "pct_cmd_t": "percentage_command_topic",
     "pct_cmd_tpl": "percentage_command_template",
     "pct_stat_t": "percentage_state_topic",
@@ -215,6 +221,8 @@ ABBREVIATIONS = {
     "stat_tpl": "state_template",
     "stat_val_tpl": "state_value_template",
     "step": "step",
+    "strt_mw_cmd_t": "start_mowing_command_topic",
+    "strt_mw_cmd_tpl": "start_mowing_command_template",
     "stype": "subtype",
     "sug_dsp_prc": "suggested_display_precision",
     "sup_dur": "support_duration",

homeassistant/components/mqtt/config_integration.py

@@ -26,6 +26,7 @@ from . import (
     fan as fan_platform,
     humidifier as humidifier_platform,
     image as image_platform,
+    lawn_mower as lawn_mower_platform,
     light as light_platform,
     lock as lock_platform,
     number as number_platform,
@@ -99,6 +100,10 @@ CONFIG_SCHEMA_BASE = vol.Schema(
             cv.ensure_list,
             [image_platform.PLATFORM_SCHEMA_MODERN],  # type: ignore[has-type]
         ),
+        Platform.LAWN_MOWER.value: vol.All(
+            cv.ensure_list,
+            [lawn_mower_platform.PLATFORM_SCHEMA_MODERN],  # type: ignore[has-type]
+        ),
         Platform.LOCK.value: vol.All(
             cv.ensure_list,
             [lock_platform.PLATFORM_SCHEMA_MODERN],  # type: ignore[has-type]

homeassistant/components/mqtt/const.py

@@ -134,6 +134,7 @@ PLATFORMS = [
     Platform.FAN,
     Platform.HUMIDIFIER,
     Platform.IMAGE,
+    Platform.LAWN_MOWER,
     Platform.LIGHT,
     Platform.LOCK,
     Platform.NUMBER,
@@ -161,6 +162,7 @@ RELOADABLE_PLATFORMS = [
     Platform.HUMIDIFIER,
     Platform.IMAGE,
     Platform.LIGHT,
+    Platform.LAWN_MOWER,
     Platform.LOCK,
     Platform.NUMBER,
     Platform.SCENE,

homeassistant/components/mqtt/discovery.py

@@ -61,6 +61,7 @@ SUPPORTED_COMPONENTS = [
     "fan",
     "humidifier",
     "image",
+    "lawn_mower",
     "light",
     "lock",
     "number",

homeassistant/components/mqtt/lawn_mower.py

@@ -0,0 +1,254 @@
+"""Support for MQTT lawn mowers."""
+from __future__ import annotations
+
+from collections.abc import Callable
+import contextlib
+import functools
+import logging
+
+import voluptuous as vol
+
+from homeassistant.components import lawn_mower
+from homeassistant.components.lawn_mower import (
+    LawnMowerActivity,
+    LawnMowerEntity,
+    LawnMowerEntityFeature,
+)
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import CONF_NAME, CONF_OPTIMISTIC
+from homeassistant.core import HomeAssistant, callback
+from homeassistant.helpers import config_validation as cv
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.helpers.restore_state import RestoreEntity
+from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
+
+from . import subscription
+from .config import MQTT_BASE_SCHEMA
+from .const import (
+    CONF_ENCODING,
+    CONF_QOS,
+    CONF_RETAIN,
+    DEFAULT_OPTIMISTIC,
+    DEFAULT_RETAIN,
+)
+from .debug_info import log_messages
+from .mixins import MQTT_ENTITY_COMMON_SCHEMA, MqttEntity, async_setup_entry_helper
+from .models import (
+    MqttCommandTemplate,
+    MqttValueTemplate,
+    PublishPayloadType,
+    ReceiveMessage,
+    ReceivePayloadType,
+)
+from .util import get_mqtt_data, valid_publish_topic, valid_subscribe_topic
+
+_LOGGER = logging.getLogger(__name__)
+
+CONF_ACTIVITY_STATE_TOPIC = "activity_state_topic"
+CONF_ACTIVITY_VALUE_TEMPLATE = "activity_value_template"
+CONF_DOCK_COMMAND_TOPIC = "dock_command_topic"
+CONF_DOCK_COMMAND_TEMPLATE = "dock_command_template"
+CONF_PAUSE_COMMAND_TOPIC = "pause_command_topic"
+CONF_PAUSE_COMMAND_TEMPLATE = "pause_command_template"
+CONF_START_MOWING_COMMAND_TOPIC = "start_mowing_command_topic"
+CONF_START_MOWING_COMMAND_TEMPLATE = "start_mowing_command_template"
+
+DEFAULT_NAME = "MQTT Lawn Mower"
+ENTITY_ID_FORMAT = lawn_mower.DOMAIN + ".{}"
+
+MQTT_LAWN_MOWER_ATTRIBUTES_BLOCKED: frozenset[str] = frozenset()
+
+FEATURE_DOCK = "dock"
+FEATURE_PAUSE = "pause"
+FEATURE_START_MOWING = "start_mowing"
+
+PLATFORM_SCHEMA_MODERN = MQTT_BASE_SCHEMA.extend(
+    {
+        vol.Optional(CONF_ACTIVITY_VALUE_TEMPLATE): cv.template,
+        vol.Optional(CONF_ACTIVITY_STATE_TOPIC): valid_subscribe_topic,
+        vol.Optional(CONF_DOCK_COMMAND_TEMPLATE): cv.template,
+        vol.Optional(CONF_DOCK_COMMAND_TOPIC): valid_publish_topic,
+        vol.Optional(CONF_NAME): vol.Any(cv.string, None),
+        vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
+        vol.Optional(CONF_PAUSE_COMMAND_TEMPLATE): cv.template,
+        vol.Optional(CONF_PAUSE_COMMAND_TOPIC): valid_publish_topic,
+        vol.Optional(CONF_RETAIN, default=DEFAULT_RETAIN): cv.boolean,
+        vol.Optional(CONF_START_MOWING_COMMAND_TEMPLATE): cv.template,
+        vol.Optional(CONF_START_MOWING_COMMAND_TOPIC): valid_publish_topic,
+    },
+).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)
+
+DISCOVERY_SCHEMA = vol.All(PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA))
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up MQTT lawn mower through YAML and through MQTT discovery."""
+    setup = functools.partial(
+        _async_setup_entity, hass, async_add_entities, config_entry=config_entry
+    )
+    await async_setup_entry_helper(hass, lawn_mower.DOMAIN, setup, DISCOVERY_SCHEMA)
+
+
+async def _async_setup_entity(
+    hass: HomeAssistant,
+    async_add_entities: AddEntitiesCallback,
+    config: ConfigType,
+    config_entry: ConfigEntry,
+    discovery_data: DiscoveryInfoType | None = None,
+) -> None:
+    """Set up the MQTT lawn mower."""
+    async_add_entities([MqttLawnMower(hass, config, config_entry, discovery_data)])
+
+
+class MqttLawnMower(MqttEntity, LawnMowerEntity, RestoreEntity):
+    """Representation of an MQTT lawn mower."""
+
+    _default_name = DEFAULT_NAME
+    _entity_id_format = ENTITY_ID_FORMAT
+    _attributes_extra_blocked = MQTT_LAWN_MOWER_ATTRIBUTES_BLOCKED
+    _command_templates: dict[str, Callable[[PublishPayloadType], PublishPayloadType]]
+    _command_topics: dict[str, str]
+    _value_template: Callable[[ReceivePayloadType], ReceivePayloadType]
+    _optimistic: bool = False
+
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        config: ConfigType,
+        config_entry: ConfigEntry,
+        discovery_data: DiscoveryInfoType | None,
+    ) -> None:
+        """Initialize the MQTT lawn mower."""
+        self._attr_current_option = None
+        LawnMowerEntity.__init__(self)
+        MqttEntity.__init__(self, hass, config, config_entry, discovery_data)
+
+    @staticmethod
+    def config_schema() -> vol.Schema:
+        """Return the config schema."""
+        return DISCOVERY_SCHEMA
+
+    def _setup_from_config(self, config: ConfigType) -> None:
+        """(Re)Setup the entity."""
+        self._optimistic = config[CONF_OPTIMISTIC]
+
+        self._value_template = MqttValueTemplate(
+            config.get(CONF_ACTIVITY_VALUE_TEMPLATE), entity=self
+        ).async_render_with_possible_json_value
+        supported_features = LawnMowerEntityFeature(0)
+        self._command_topics = {}
+        if CONF_DOCK_COMMAND_TOPIC in config:
+            self._command_topics[FEATURE_DOCK] = config[CONF_DOCK_COMMAND_TOPIC]
+            supported_features |= LawnMowerEntityFeature.DOCK
+        if CONF_PAUSE_COMMAND_TOPIC in config:
+            self._command_topics[FEATURE_PAUSE] = config[CONF_PAUSE_COMMAND_TOPIC]
+            supported_features |= LawnMowerEntityFeature.PAUSE
+        if CONF_START_MOWING_COMMAND_TOPIC in config:
+            self._command_topics[FEATURE_START_MOWING] = config[
+                CONF_START_MOWING_COMMAND_TOPIC
+            ]
+            supported_features |= LawnMowerEntityFeature.START_MOWING
+        self._attr_supported_features = supported_features
+        self._command_templates = {}
+        self._command_templates[FEATURE_DOCK] = MqttCommandTemplate(
+            config.get(CONF_DOCK_COMMAND_TEMPLATE), entity=self
+        ).async_render
+        self._command_templates[FEATURE_PAUSE] = MqttCommandTemplate(
+            config.get(CONF_PAUSE_COMMAND_TEMPLATE), entity=self
+        ).async_render
+        self._command_templates[FEATURE_START_MOWING] = MqttCommandTemplate(
+            config.get(CONF_START_MOWING_COMMAND_TEMPLATE), entity=self
+        ).async_render
+
+    def _prepare_subscribe_topics(self) -> None:
+        """(Re)Subscribe to topics."""
+
+        @callback
+        @log_messages(self.hass, self.entity_id)
+        def message_received(msg: ReceiveMessage) -> None:
+            """Handle new MQTT messages."""
+            payload = str(self._value_template(msg.payload))
+            if not payload:
+                _LOGGER.debug(
+                    "Invalid empty activity payload from topic %s, for entity %s",
+                    msg.topic,
+                    self.entity_id,
+                )
+                return
+            if payload.lower() == "none":
+                self._attr_activity = None
+                get_mqtt_data(self.hass).state_write_requests.write_state_request(self)
+                return
+
+            try:
+                self._attr_activity = LawnMowerActivity(payload)
+            except ValueError:
+                _LOGGER.error(
+                    "Invalid activity for %s: '%s' (valid activies: %s)",
+                    self.entity_id,
+                    payload,
+                    [option.value for option in LawnMowerActivity],
+                )
+                return
+            get_mqtt_data(self.hass).state_write_requests.write_state_request(self)
+
+        if self._config.get(CONF_ACTIVITY_STATE_TOPIC) is None:
+            # Force into optimistic mode.
+            self._optimistic = True
+        else:
+            self._sub_state = subscription.async_prepare_subscribe_topics(
+                self.hass,
+                self._sub_state,
+                {
+                    CONF_ACTIVITY_STATE_TOPIC: {
+                        "topic": self._config.get(CONF_ACTIVITY_STATE_TOPIC),
+                        "msg_callback": message_received,
+                        "qos": self._config[CONF_QOS],
+                        "encoding": self._config[CONF_ENCODING] or None,
+                    }
+                },
+            )
+
+    async def _subscribe_topics(self) -> None:
+        """(Re)Subscribe to topics."""
+        await subscription.async_subscribe_topics(self.hass, self._sub_state)
+
+        if self._optimistic and (last_state := await self.async_get_last_state()):
+            with contextlib.suppress(ValueError):
+                self._attr_activity = LawnMowerActivity(last_state.state)
+
+    @property
+    def assumed_state(self) -> bool:
+        """Return true if we do optimistic updates."""
+        return self._optimistic
+
+    async def _async_operate(self, option: str, activity: LawnMowerActivity) -> None:
+        """Execute operation."""
+        payload = self._command_templates[option](option)
+        if self._optimistic:
+            self._attr_activity = activity
+            self.async_write_ha_state()
+
+        await self.async_publish(
+            self._command_topics[option],
+            payload,
+            self._config[CONF_QOS],
+            self._config[CONF_RETAIN],
+            self._config[CONF_ENCODING],
+        )
+
+    async def async_start_mowing(self) -> None:
+        """Start or resume mowing."""
+        await self._async_operate("start_mowing", LawnMowerActivity.MOWING)
+
+    async def async_dock(self) -> None:
+        """Dock the mower."""
+        await self._async_operate("dock", LawnMowerActivity.DOCKED)
+
+    async def async_pause(self) -> None:
+        """Pause the lawn mower."""
+        await self._async_operate("pause", LawnMowerActivity.PAUSED)

tests/components/mqtt/test_lawn_mower.py

@@ -0,0 +1,888 @@
+"""The tests for mqtt lawn_mower component."""
+import copy
+import json
+from typing import Any
+from unittest.mock import patch
+
+import pytest
+
+from homeassistant.components import lawn_mower, mqtt
+from homeassistant.components.lawn_mower import (
+    DOMAIN as LAWN_MOWER_DOMAIN,
+    SERVICE_DOCK,
+    SERVICE_PAUSE,
+    SERVICE_START_MOWING,
+    LawnMowerEntityFeature,
+)
+from homeassistant.components.mqtt.lawn_mower import MQTT_LAWN_MOWER_ATTRIBUTES_BLOCKED
+from homeassistant.const import (
+    ATTR_ASSUMED_STATE,
+    ATTR_ENTITY_ID,
+    STATE_UNKNOWN,
+    Platform,
+)
+from homeassistant.core import HomeAssistant, State
+
+from .test_common import (
+    help_test_availability_when_connection_lost,
+    help_test_availability_without_topic,
+    help_test_custom_availability_payload,
+    help_test_default_availability_payload,
+    help_test_discovery_broken,
+    help_test_discovery_removal,
+    help_test_discovery_setup,
+    help_test_discovery_update,
+    help_test_discovery_update_attr,
+    help_test_discovery_update_unchanged,
+    help_test_encoding_subscribable_topics,
+    help_test_entity_debug_info_message,
+    help_test_entity_device_info_remove,
+    help_test_entity_device_info_update,
+    help_test_entity_device_info_with_connection,
+    help_test_entity_device_info_with_identifier,
+    help_test_entity_id_update_discovery_update,
+    help_test_entity_id_update_subscriptions,
+    help_test_publishing_with_custom_encoding,
+    help_test_reloadable,
+    help_test_setting_attribute_via_mqtt_json_message,
+    help_test_setting_attribute_with_template,
+    help_test_setting_blocked_attribute_via_mqtt_json_message,
+    help_test_unique_id,
+    help_test_unload_config_entry_with_platform,
+    help_test_update_with_json_attrs_bad_json,
+    help_test_update_with_json_attrs_not_dict,
+)
+
+from tests.common import async_fire_mqtt_message, mock_restore_cache
+from tests.typing import MqttMockHAClientGenerator, MqttMockPahoClient
+
+ATTR_ACTIVITY = "activity"
+
+DEFAULT_FEATURES = (
+    LawnMowerEntityFeature.START_MOWING
+    | LawnMowerEntityFeature.PAUSE
+    | LawnMowerEntityFeature.DOCK
+)
+
+DEFAULT_CONFIG = {
+    mqtt.DOMAIN: {
+        lawn_mower.DOMAIN: {
+            "name": "test",
+            "dock_command_topic": "dock-test-topic",
+            "pause_command_topic": "pause-test-topic",
+            "start_mowing_command_topic": "start_mowing-test-topic",
+        }
+    }
+}
+
+
+@pytest.fixture(autouse=True)
+def lawn_mower_platform_only():
+    """Only setup the lawn_mower platform to speed up tests."""
+    with patch("homeassistant.components.mqtt.PLATFORMS", [Platform.LAWN_MOWER]):
+        yield
+
+
+@pytest.mark.parametrize(
+    "hass_config",
+    [
+        {
+            mqtt.DOMAIN: {
+                lawn_mower.DOMAIN: {
+                    "activity_state_topic": "test/lawn_mower_stat",
+                    "dock_command_topic": "dock-test-topic",
+                    "pause_command_topic": "pause-test-topic",
+                    "start_mowing_command_topic": "start_mowing-test-topic",
+                    "name": "Test Lawn Mower",
+                }
+            }
+        }
+    ],
+)
+async def test_run_lawn_mower_setup_and_state_updates(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+) -> None:
+    """Test that it sets up correctly fetches the given payload."""
+    await mqtt_mock_entry()
+
+    async_fire_mqtt_message(hass, "test/lawn_mower_stat", "mowing")
+
+    await hass.async_block_till_done()
+
+    state = hass.states.get("lawn_mower.test_lawn_mower")
+    assert state.state == "mowing"
+
+    async_fire_mqtt_message(hass, "test/lawn_mower_stat", "docked")
+
+    await hass.async_block_till_done()
+
+    state = hass.states.get("lawn_mower.test_lawn_mower")
+    assert state.state == "docked"
+
+    # empty payloads are ignored
+    async_fire_mqtt_message(hass, "test/lawn_mower_stat", "")
+
+    await hass.async_block_till_done()
+
+    state = hass.states.get("lawn_mower.test_lawn_mower")
+    assert state.state == "docked"
+
+
+@pytest.mark.parametrize(
+    ("hass_config", "expected_features"),
+    [
+        (
+            DEFAULT_CONFIG,
+            DEFAULT_FEATURES,
+        ),
+        (
+            {
+                mqtt.DOMAIN: {
+                    lawn_mower.DOMAIN: {
+                        "pause_command_topic": "pause-test-topic",
+                        "name": "test",
+                    }
+                }
+            },
+            LawnMowerEntityFeature.PAUSE,
+        ),
+        (
+            {
+                mqtt.DOMAIN: {
+                    lawn_mower.DOMAIN: {
+                        "dock_command_topic": "dock-test-topic",
+                        "start_mowing_command_topic": "start_mowing-test-topic",
+                        "name": "test",
+                    }
+                }
+            },
+            LawnMowerEntityFeature.START_MOWING | LawnMowerEntityFeature.DOCK,
+        ),
+    ],
+)
+async def test_supported_features(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+    expected_features: LawnMowerEntityFeature | None,
+) -> None:
+    """Test conditional enablement of supported features."""
+    await mqtt_mock_entry()
+    assert (
+        hass.states.get("lawn_mower.test").attributes["supported_features"]
+        == expected_features
+    )
+
+
+@pytest.mark.parametrize(
+    "hass_config",
+    [
+        {
+            mqtt.DOMAIN: {
+                lawn_mower.DOMAIN: {
+                    "activity_state_topic": "test/lawn_mower_stat",
+                    "name": "Test Lawn Mower",
+                    "activity_value_template": "{{ value_json.val }}",
+                }
+            }
+        }
+    ],
+)
+async def test_value_template(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test that it fetches the given payload with a template."""
+    await mqtt_mock_entry()
+
+    async_fire_mqtt_message(hass, "test/lawn_mower_stat", '{"val":"mowing"}')
+
+    await hass.async_block_till_done()
+
+    state = hass.states.get("lawn_mower.test_lawn_mower")
+    assert state.state == "mowing"
+
+    async_fire_mqtt_message(hass, "test/lawn_mower_stat", '{"val":"paused"}')
+
+    await hass.async_block_till_done()
+
+    state = hass.states.get("lawn_mower.test_lawn_mower")
+    assert state.state == "paused"
+
+    async_fire_mqtt_message(hass, "test/lawn_mower_stat", '{"val": null}')
+
+    await hass.async_block_till_done()
+
+    state = hass.states.get("lawn_mower.test_lawn_mower")
+    assert state.state == STATE_UNKNOWN
+
+
+@pytest.mark.parametrize(
+    "hass_config",
+    [DEFAULT_CONFIG],
+)
+async def test_run_lawn_mower_service_optimistic(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test that service calls work in optimistic mode."""
+
+    fake_state = State("lawn_mower.test", "docked")
+    mock_restore_cache(hass, (fake_state,))
+
+    mqtt_mock = await mqtt_mock_entry()
+
+    state = hass.states.get("lawn_mower.test")
+    assert state.state == "docked"
+    assert state.attributes.get(ATTR_ASSUMED_STATE)
+
+    await hass.services.async_call(
+        lawn_mower.DOMAIN,
+        SERVICE_START_MOWING,
+        {ATTR_ENTITY_ID: "lawn_mower.test"},
+        blocking=True,
+    )
+
+    mqtt_mock.async_publish.assert_called_once_with(
+        "start_mowing-test-topic", "start_mowing", 0, False
+    )
+    mqtt_mock.async_publish.reset_mock()
+    state = hass.states.get("lawn_mower.test")
+    assert state.state == "mowing"
+
+    await hass.services.async_call(
+        lawn_mower.DOMAIN,
+        SERVICE_PAUSE,
+        {ATTR_ENTITY_ID: "lawn_mower.test"},
+        blocking=True,
+    )
+
+    mqtt_mock.async_publish.assert_called_once_with(
+        "pause-test-topic", "pause", 0, False
+    )
+    mqtt_mock.async_publish.reset_mock()
+    state = hass.states.get("lawn_mower.test")
+    assert state.state == "paused"
+
+    await hass.services.async_call(
+        lawn_mower.DOMAIN,
+        SERVICE_DOCK,
+        {ATTR_ENTITY_ID: "lawn_mower.test"},
+        blocking=True,
+    )
+
+    mqtt_mock.async_publish.assert_called_once_with("dock-test-topic", "dock", 0, False)
+    mqtt_mock.async_publish.reset_mock()
+    state = hass.states.get("lawn_mower.test")
+    assert state.state == "docked"
+
+
+@pytest.mark.parametrize(
+    "hass_config",
+    [
+        {
+            mqtt.DOMAIN: {
+                lawn_mower.DOMAIN: {
+                    "pause_command_topic": "test/lawn_mower_pause_cmd",
+                    "name": "Test Lawn Mower",
+                }
+            }
+        }
+    ],
+)
+async def test_restore_lawn_mower_from_invalid_state(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test that restoring the state skips invalid values."""
+    fake_state = State("lawn_mower.test_lawn_mower", "unknown")
+    mock_restore_cache(hass, (fake_state,))
+
+    await mqtt_mock_entry()
+
+    state = hass.states.get("lawn_mower.test_lawn_mower")
+    assert state.state == STATE_UNKNOWN
+
+
+@pytest.mark.parametrize(
+    "hass_config",
+    [
+        {
+            mqtt.DOMAIN: {
+                lawn_mower.DOMAIN: {
+                    "name": "Test Lawn Mower",
+                    "dock_command_topic": "test/lawn_mower_dock_cmd",
+                    "dock_command_template": '{"action": "{{ value }}"}',
+                    "pause_command_topic": "test/lawn_mower_pause_cmd",
+                    "pause_command_template": '{"action": "{{ value }}"}',
+                    "start_mowing_command_topic": "test/lawn_mower_start_mowing_cmd",
+                    "start_mowing_command_template": '{"action": "{{ value }}"}',
+                }
+            }
+        }
+    ],
+)
+async def test_run_lawn_mower_service_optimistic_with_command_templates(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test that service calls work in optimistic mode and with a command_template."""
+    fake_state = State("lawn_mower.test_lawn_mower", "docked")
+    mock_restore_cache(hass, (fake_state,))
+
+    mqtt_mock = await mqtt_mock_entry()
+
+    state = hass.states.get("lawn_mower.test_lawn_mower")
+    assert state.state == "docked"
+    assert state.attributes.get(ATTR_ASSUMED_STATE)
+
+    await hass.services.async_call(
+        lawn_mower.DOMAIN,
+        SERVICE_START_MOWING,
+        {ATTR_ENTITY_ID: "lawn_mower.test_lawn_mower"},
+        blocking=True,
+    )
+
+    mqtt_mock.async_publish.assert_called_once_with(
+        "test/lawn_mower_start_mowing_cmd", '{"action": "start_mowing"}', 0, False
+    )
+    mqtt_mock.async_publish.reset_mock()
+    state = hass.states.get("lawn_mower.test_lawn_mower")
+    assert state.state == "mowing"
+
+    await hass.services.async_call(
+        lawn_mower.DOMAIN,
+        SERVICE_PAUSE,
+        {ATTR_ENTITY_ID: "lawn_mower.test_lawn_mower"},
+        blocking=True,
+    )
+
+    mqtt_mock.async_publish.assert_called_once_with(
+        "test/lawn_mower_pause_cmd", '{"action": "pause"}', 0, False
+    )
+    mqtt_mock.async_publish.reset_mock()
+    state = hass.states.get("lawn_mower.test_lawn_mower")
+    assert state.state == "paused"
+
+    await hass.services.async_call(
+        lawn_mower.DOMAIN,
+        SERVICE_DOCK,
+        {ATTR_ENTITY_ID: "lawn_mower.test_lawn_mower"},
+        blocking=True,
+    )
+
+    mqtt_mock.async_publish.assert_called_once_with(
+        "test/lawn_mower_dock_cmd", '{"action": "dock"}', 0, False
+    )
+    mqtt_mock.async_publish.reset_mock()
+    state = hass.states.get("lawn_mower.test_lawn_mower")
+    assert state.state == "docked"
+
+
+@pytest.mark.parametrize("hass_config", [DEFAULT_CONFIG])
+async def test_availability_when_connection_lost(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test availability after MQTT disconnection."""
+    await help_test_availability_when_connection_lost(
+        hass, mqtt_mock_entry, lawn_mower.DOMAIN
+    )
+
+
+@pytest.mark.parametrize("hass_config", [DEFAULT_CONFIG])
+async def test_availability_without_topic(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test availability without defined availability topic."""
+    await help_test_availability_without_topic(
+        hass, mqtt_mock_entry, lawn_mower.DOMAIN, DEFAULT_CONFIG
+    )
+
+
+async def test_default_availability_payload(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test availability by default payload with defined topic."""
+    await help_test_default_availability_payload(
+        hass, mqtt_mock_entry, lawn_mower.DOMAIN, DEFAULT_CONFIG
+    )
+
+
+async def test_custom_availability_payload(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test availability by custom payload with defined topic."""
+    await help_test_custom_availability_payload(
+        hass, mqtt_mock_entry, lawn_mower.DOMAIN, DEFAULT_CONFIG
+    )
+
+
+async def test_setting_attribute_via_mqtt_json_message(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test the setting of attribute via MQTT with JSON payload."""
+    await help_test_setting_attribute_via_mqtt_json_message(
+        hass, mqtt_mock_entry, lawn_mower.DOMAIN, DEFAULT_CONFIG
+    )
+
+
+async def test_setting_blocked_attribute_via_mqtt_json_message(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test the setting of attribute via MQTT with JSON payload."""
+    await help_test_setting_blocked_attribute_via_mqtt_json_message(
+        hass,
+        mqtt_mock_entry,
+        lawn_mower.DOMAIN,
+        DEFAULT_CONFIG,
+        MQTT_LAWN_MOWER_ATTRIBUTES_BLOCKED,
+    )
+
+
+async def test_setting_attribute_with_template(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test the setting of attribute via MQTT with JSON payload."""
+    await help_test_setting_attribute_with_template(
+        hass, mqtt_mock_entry, lawn_mower.DOMAIN, DEFAULT_CONFIG
+    )
+
+
+async def test_update_with_json_attrs_not_dict(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    """Test attributes get extracted from a JSON result."""
+    await help_test_update_with_json_attrs_not_dict(
+        hass,
+        mqtt_mock_entry,
+        caplog,
+        lawn_mower.DOMAIN,
+        DEFAULT_CONFIG,
+    )
+
+
+async def test_update_with_json_attrs_bad_json(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    """Test attributes get extracted from a JSON result."""
+    await help_test_update_with_json_attrs_bad_json(
+        hass,
+        mqtt_mock_entry,
+        caplog,
+        lawn_mower.DOMAIN,
+        DEFAULT_CONFIG,
+    )
+
+
+async def test_discovery_update_attr(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    """Test update of discovered MQTTAttributes."""
+    await help_test_discovery_update_attr(
+        hass,
+        mqtt_mock_entry,
+        caplog,
+        lawn_mower.DOMAIN,
+        DEFAULT_CONFIG,
+    )
+
+
+@pytest.mark.parametrize(
+    "hass_config",
+    [
+        {
+            mqtt.DOMAIN: {
+                lawn_mower.DOMAIN: [
+                    {
+                        "name": "Test 1",
+                        "activity_state_topic": "test-topic",
+                        "unique_id": "TOTALLY_UNIQUE",
+                    },
+                    {
+                        "name": "Test 2",
+                        "activity_state_topic": "test-topic",
+                        "unique_id": "TOTALLY_UNIQUE",
+                    },
+                ]
+            }
+        }
+    ],
+)
+async def test_unique_id(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test unique id action only creates one lawn_mower per unique_id."""
+    await help_test_unique_id(hass, mqtt_mock_entry, lawn_mower.DOMAIN)
+
+
+async def test_discovery_removal_lawn_mower(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    """Test removal of discovered lawn_mower."""
+    data = json.dumps(DEFAULT_CONFIG[mqtt.DOMAIN][lawn_mower.DOMAIN])
+    await help_test_discovery_removal(
+        hass, mqtt_mock_entry, caplog, lawn_mower.DOMAIN, data
+    )
+
+
+async def test_discovery_update_lawn_mower(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    """Test update of discovered lawn_mower."""
+    config1 = {
+        "name": "Beer",
+        "activity_state_topic": "test-topic",
+        "command_topic": "test-topic",
+        "actions": ["milk", "beer"],
+    }
+    config2 = {
+        "name": "Milk",
+        "activity_state_topic": "test-topic",
+        "command_topic": "test-topic",
+        "actions": ["milk"],
+    }
+
+    await help_test_discovery_update(
+        hass, mqtt_mock_entry, caplog, lawn_mower.DOMAIN, config1, config2
+    )
+
+
+async def test_discovery_update_unchanged_lawn_mower(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    """Test update of discovered lawn_mower."""
+    data1 = '{ "name": "Beer", "activity_state_topic": "test-topic", "command_topic": "test-topic", "actions": ["milk", "beer"]}'
+    with patch(
+        "homeassistant.components.mqtt.lawn_mower.MqttLawnMower.discovery_update"
+    ) as discovery_update:
+        await help_test_discovery_update_unchanged(
+            hass,
+            mqtt_mock_entry,
+            caplog,
+            lawn_mower.DOMAIN,
+            data1,
+            discovery_update,
+        )
+
+
+@pytest.mark.no_fail_on_log_exception
+async def test_discovery_broken(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    """Test handling of bad discovery message."""
+    data1 = '{ "invalid" }'
+    data2 = '{ "name": "Milk", "activity_state_topic": "test-topic", "pause_command_topic": "test-topic"}'
+
+    await help_test_discovery_broken(
+        hass, mqtt_mock_entry, caplog, lawn_mower.DOMAIN, data1, data2
+    )
+
+
+async def test_entity_device_info_with_connection(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test MQTT lawn_mower device registry integration."""
+    await help_test_entity_device_info_with_connection(
+        hass, mqtt_mock_entry, lawn_mower.DOMAIN, DEFAULT_CONFIG
+    )
+
+
+async def test_entity_device_info_with_identifier(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test MQTT lawn_mower device registry integration."""
+    await help_test_entity_device_info_with_identifier(
+        hass, mqtt_mock_entry, lawn_mower.DOMAIN, DEFAULT_CONFIG
+    )
+
+
+async def test_entity_device_info_update(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test device registry update."""
+    await help_test_entity_device_info_update(
+        hass, mqtt_mock_entry, lawn_mower.DOMAIN, DEFAULT_CONFIG
+    )
+
+
+async def test_entity_device_info_remove(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test device registry remove."""
+    await help_test_entity_device_info_remove(
+        hass, mqtt_mock_entry, lawn_mower.DOMAIN, DEFAULT_CONFIG
+    )
+
+
+async def test_entity_id_update_subscriptions(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test MQTT subscriptions are managed when entity_id is updated."""
+    config = {
+        mqtt.DOMAIN: {
+            lawn_mower.DOMAIN: {
+                "name": "test",
+                "activity_state_topic": "test-topic",
+                "availability_topic": "avty-topic",
+            }
+        }
+    }
+    await help_test_entity_id_update_subscriptions(
+        hass, mqtt_mock_entry, lawn_mower.DOMAIN, config, ["avty-topic", "test-topic"]
+    )
+
+
+async def test_entity_id_update_discovery_update(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test MQTT discovery update when entity_id is updated."""
+    await help_test_entity_id_update_discovery_update(
+        hass, mqtt_mock_entry, lawn_mower.DOMAIN, DEFAULT_CONFIG
+    )
+
+
+@pytest.mark.parametrize(
+    ("service", "command_payload", "state_payload", "state_topic", "command_topic"),
+    [
+        (
+            SERVICE_START_MOWING,
+            "start_mowing",
+            "mowing",
+            "test/lawn_mower_stat",
+            "start_mowing-test-topic",
+        ),
+        (
+            SERVICE_PAUSE,
+            "pause",
+            "paused",
+            "test/lawn_mower_stat",
+            "pause-test-topic",
+        ),
+        (
+            SERVICE_DOCK,
+            "dock",
+            "docked",
+            "test/lawn_mower_stat",
+            "dock-test-topic",
+        ),
+    ],
+)
+async def test_entity_debug_info_message(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+    service: str,
+    command_payload: str,
+    state_payload: str,
+    state_topic: str,
+    command_topic: str,
+) -> None:
+    """Test MQTT debug info."""
+    config = {
+        mqtt.DOMAIN: {
+            lawn_mower.DOMAIN: {
+                "activity_state_topic": "test/lawn_mower_stat",
+                "dock_command_topic": "dock-test-topic",
+                "pause_command_topic": "pause-test-topic",
+                "start_mowing_command_topic": "start_mowing-test-topic",
+                "name": "test",
+            }
+        }
+    }
+    await help_test_entity_debug_info_message(
+        hass,
+        mqtt_mock_entry,
+        lawn_mower.DOMAIN,
+        config,
+        service=service,
+        command_payload=command_payload,
+        state_payload=state_payload,
+        state_topic=state_topic,
+        command_topic=command_topic,
+    )
+
+
+@pytest.mark.parametrize(
+    "hass_config",
+    [
+        {
+            mqtt.DOMAIN: {
+                lawn_mower.DOMAIN: {
+                    "dock_command_topic": "dock-test-topic",
+                    "pause_command_topic": "pause-test-topic",
+                    "start_mowing_command_topic": "start_mowing-test-topic",
+                    "activity_state_topic": "test/lawn_mower_stat",
+                    "name": "Test Lawn Mower",
+                }
+            }
+        }
+    ],
+)
+async def test_mqtt_payload_not_a_valid_activity_warning(
+    hass: HomeAssistant,
+    caplog: pytest.LogCaptureFixture,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+) -> None:
+    """Test warning for MQTT payload which is not a valid activity."""
+    await mqtt_mock_entry()
+
+    async_fire_mqtt_message(hass, "test/lawn_mower_stat", "painting")
+
+    await hass.async_block_till_done()
+
+    assert (
+        "Invalid activity for lawn_mower.test_lawn_mower: 'painting' (valid activies: ['error', 'paused', 'mowing', 'docked'])"
+        in caplog.text
+    )
+
+
+@pytest.mark.parametrize(
+    ("service", "topic", "parameters", "payload", "template"),
+    [
+        (
+            SERVICE_START_MOWING,
+            "start_mowing_command_topic",
+            {},
+            "start_mowing",
+            "start_mowing_command_template",
+        ),
+        (
+            SERVICE_PAUSE,
+            "pause_command_topic",
+            {},
+            "pause",
+            "pause_command_template",
+        ),
+        (
+            SERVICE_DOCK,
+            "dock_command_topic",
+            {},
+            "dock",
+            "dock_command_template",
+        ),
+    ],
+)
+async def test_publishing_with_custom_encoding(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+    caplog: pytest.LogCaptureFixture,
+    service: str,
+    topic: str,
+    parameters: dict[str, Any],
+    payload: str,
+    template: str | None,
+) -> None:
+    """Test publishing MQTT payload with different encoding."""
+    domain = lawn_mower.DOMAIN
+    config = DEFAULT_CONFIG
+
+    await help_test_publishing_with_custom_encoding(
+        hass,
+        mqtt_mock_entry,
+        caplog,
+        domain,
+        config,
+        service,
+        topic,
+        parameters,
+        payload,
+        template,
+    )
+
+
+async def test_reloadable(
+    hass: HomeAssistant,
+    mqtt_client_mock: MqttMockPahoClient,
+) -> None:
+    """Test reloading the MQTT platform."""
+    domain = lawn_mower.DOMAIN
+    config = DEFAULT_CONFIG
+    await help_test_reloadable(hass, mqtt_client_mock, domain, config)
+
+
+@pytest.mark.parametrize(
+    ("topic", "value", "attribute", "attribute_value"),
+    [
+        ("activity_state_topic", "paused", None, "paused"),
+        ("activity_state_topic", "docked", None, "docked"),
+        ("activity_state_topic", "mowing", None, "mowing"),
+    ],
+)
+async def test_encoding_subscribable_topics(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+    topic: str,
+    value: str,
+    attribute: str | None,
+    attribute_value: Any,
+) -> None:
+    """Test handling of incoming encoded payload."""
+    config = copy.deepcopy(DEFAULT_CONFIG[mqtt.DOMAIN][lawn_mower.DOMAIN])
+    config["actions"] = ["milk", "beer"]
+    await help_test_encoding_subscribable_topics(
+        hass,
+        mqtt_mock_entry,
+        lawn_mower.DOMAIN,
+        config,
+        topic,
+        value,
+        attribute,
+        attribute_value,
+    )
+
+
+@pytest.mark.parametrize(
+    "hass_config",
+    [DEFAULT_CONFIG, {"mqtt": [DEFAULT_CONFIG["mqtt"]]}],
+    ids=["platform_key", "listed"],
+)
+async def test_setup_manual_entity_from_yaml(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test setup manual configured MQTT entity."""
+    await mqtt_mock_entry()
+    platform = lawn_mower.DOMAIN
+    assert hass.states.get(f"{platform}.test")
+
+
+async def test_unload_entry(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+) -> None:
+    """Test unloading the config entry."""
+    domain = lawn_mower.DOMAIN
+    config = DEFAULT_CONFIG
+    await help_test_unload_config_entry_with_platform(
+        hass, mqtt_mock_entry, domain, config
+    )
+
+
+async def test_persistent_state_after_reconfig(
+    hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
+) -> None:
+    """Test of the state is persistent after reconfiguring the lawn_mower activity."""
+    await mqtt_mock_entry()
+    discovery_data = '{ "name": "Garden", "activity_state_topic": "test-topic", "command_topic": "test-topic"}'
+    await help_test_discovery_setup(hass, LAWN_MOWER_DOMAIN, discovery_data, "garden")
+
+    # assign an initial state
+    async_fire_mqtt_message(hass, "test-topic", "docked")
+    state = hass.states.get("lawn_mower.garden")
+    assert state.state == "docked"
+
+    # change the config
+    discovery_data = '{ "name": "Garden", "activity_state_topic": "test-topic2", "command_topic": "test-topic"}'
+    await help_test_discovery_setup(hass, LAWN_MOWER_DOMAIN, discovery_data, "garden")
+
+    # assert the state persistent
+    state = hass.states.get("lawn_mower.garden")
+    assert state.state == "docked"