Add switch as entity platform on MQTT subentries

jbouwh · jbouwh · commit 5747703b58c7 · 2025-03-25T18:58:58.000Z
diff --git a/homeassistant/components/mqtt/config_flow.py b/homeassistant/components/mqtt/config_flow.py
@@ -33,6 +33,7 @@
     SensorDeviceClass,
     SensorStateClass,
 )
+from homeassistant.components.switch import SwitchDeviceClass
 from homeassistant.config_entries import (
     SOURCE_RECONFIGURE,
     ConfigEntry,
@@ -55,6 +56,7 @@
     CONF_DISCOVERY,
     CONF_HOST,
     CONF_NAME,
+    CONF_OPTIMISTIC,
     CONF_PASSWORD,
     CONF_PAYLOAD,
     CONF_PLATFORM,
@@ -233,7 +235,7 @@
 )
 
 # Subentry selectors
-SUBENTRY_PLATFORMS = [Platform.NOTIFY, Platform.SENSOR]
+SUBENTRY_PLATFORMS = [Platform.NOTIFY, Platform.SENSOR, Platform.SWITCH]
 SUBENTRY_PLATFORM_SELECTOR = SelectSelector(
     SelectSelectorConfig(
         options=[platform.value for platform in SUBENTRY_PLATFORMS],
@@ -286,6 +288,15 @@
     NumberSelectorConfig(mode=NumberSelectorMode.BOX, min=0)
 )
 
+# Switch specific selectors
+SWITCH_DEVICE_CLASS_SELECTOR = SelectSelector(
+    SelectSelectorConfig(
+        options=[device_class.value for device_class in SwitchDeviceClass],
+        mode=SelectSelectorMode.DROPDOWN,
+        translation_key="device_class_switch",
+    )
+)
+
 
 @dataclass(frozen=True)
 class PlatformField:
@@ -352,6 +363,9 @@ def unit_of_measurement_selector(user_data: dict[str, Any | None]) -> Selector:
             conditions=({"device_class": "enum"},),
         ),
     },
+    Platform.SWITCH.value: {
+        CONF_DEVICE_CLASS: PlatformField(SWITCH_DEVICE_CLASS_SELECTOR, False, str),
+    },
 }
 PLATFORM_MQTT_FIELDS = {
     Platform.NOTIFY.value: {
@@ -381,13 +395,30 @@ def unit_of_measurement_selector(user_data: dict[str, Any | None]) -> Selector:
             EXIRE_AFTER_SELECTOR, False, cv.positive_int, section="advanced_settings"
         ),
     },
+    Platform.SWITCH.value: {
+        CONF_COMMAND_TOPIC: PlatformField(
+            TEXT_SELECTOR, True, valid_publish_topic, "invalid_publish_topic"
+        ),
+        CONF_COMMAND_TEMPLATE: PlatformField(
+            TEMPLATE_SELECTOR, False, cv.template, "invalid_template"
+        ),
+        CONF_STATE_TOPIC: PlatformField(
+            TEXT_SELECTOR, False, valid_subscribe_topic, "invalid_subscribe_topic"
+        ),
+        CONF_VALUE_TEMPLATE: PlatformField(
+            TEMPLATE_SELECTOR, False, cv.template, "invalid_template"
+        ),
+        CONF_RETAIN: PlatformField(BOOLEAN_SELECTOR, False, bool),
+        CONF_OPTIMISTIC: PlatformField(BOOLEAN_SELECTOR, False, bool),
+    },
 }
 ENTITY_CONFIG_VALIDATOR: dict[
     str,
     Callable[[dict[str, Any], dict[str, str], list[str] | None], dict[str, Any]] | None,
 ] = {
     Platform.NOTIFY.value: None,
     Platform.SENSOR.value: validate_sensor_state_and_device_class_config,
+    Platform.SWITCH.value: None,
 }
 
 MQTT_DEVICE_SCHEMA = vol.Schema(
diff --git a/homeassistant/components/mqtt/strings.json b/homeassistant/components/mqtt/strings.json
@@ -235,6 +235,7 @@
             "value_template": "Value template",
             "last_reset_value_template": "Last reset value template",
             "force_update": "Force update",
+            "optimistic": "Optimistic",
             "retain": "Retain",
             "qos": "QoS"
           },
@@ -245,6 +246,7 @@
             "value_template": "Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt) to extract the {platform} entity value.",
             "last_reset_value_template": "Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt) to extract the last reset. When Last reset template is set, the State class option must be Total. [Learn more.]({url}#last_reset_value_template)",
             "force_update": "Sends update events even if the value hasn’t changed. Useful if you want to have meaningful value graphs in history. [Learn more.]({url}#force_update)",
+            "optimistic": "Flag that defines if the {platform} entity works in optimistic mode. [Learn more.]({url}#optimistic)",
             "retain": "Select if values published by the {platform} entity should be retained at the MQTT broker.",
             "qos": "The QoS value {platform} entity should use."
           },
@@ -452,10 +454,17 @@
         "wind_speed": "[%key:component::sensor::entity_component::wind_speed::name%]"
       }
     },
+    "device_class_switch": {
+      "options": {
+        "outlet": "[%key:component::switch::entity_component::outlet::name%]",
+        "switch": "[%key:component::switch::title%]"
+      }
+    },
     "platform": {
       "options": {
         "notify": "Notify",
-        "sensor": "Sensor"
+        "sensor": "Sensor",
+        "switch": "Switch"
       }
     },
     "set_ca_cert": {
diff --git a/tests/components/mqtt/common.py b/tests/components/mqtt/common.py
@@ -131,6 +131,20 @@
         "qos": 0,
     },
 }
+MOCK_SUBENTRY_SWITCH_COMPONENT = {
+    "3faf1318016c46c5aea26707eeb6f12e": {
+        "platform": "switch",
+        "name": "Outlet",
+        "device_class": "outlet",
+        "qos": 0,
+        "command_topic": "test-topic",
+        "state_topic": "test-topic",
+        "command_template": "{{ value }}",
+        "value_template": "{{ value_json.value }}",
+        "entity_picture": "https://example.com/3faf1318016c46c5aea26707eeb6f12e",
+        "optimistic": True,
+    },
+}
 
 # Bogus light component just for code coverage
 # Note that light cannot be setup through the UI yet
@@ -230,7 +244,17 @@
     },
     "components": MOCK_SUBENTRY_SENSOR_COMPONENT_LAST_RESET,
 }
-
+MOCK_SWITCH_SUBENTRY_DATA_SINGLE_STATE_CLASS = {
+    "device": {
+        "name": "Test switch",
+        "sw_version": "1.0",
+        "hw_version": "2.1 rev a",
+        "model": "Model XL",
+        "model_id": "mn002",
+        "configuration_url": "https://example.com",
+    },
+    "components": MOCK_SUBENTRY_SWITCH_COMPONENT,
+}
 MOCK_SUBENTRY_DATA_BAD_COMPONENT_SCHEMA = {
     "device": {
         "name": "Milk notifier",
@@ -253,7 +277,8 @@
     },
     "components": MOCK_SUBENTRY_NOTIFY_COMPONENT1
     | MOCK_SUBENTRY_NOTIFY_COMPONENT2
-    | MOCK_SUBENTRY_LIGHT_COMPONENT,
+    | MOCK_SUBENTRY_LIGHT_COMPONENT
+    | MOCK_SUBENTRY_SWITCH_COMPONENT,
 } | MOCK_SUBENTRY_AVAILABILITY_DATA
 _SENTINEL = object()
 
diff --git a/tests/components/mqtt/test_config_flow.py b/tests/components/mqtt/test_config_flow.py
@@ -39,6 +39,7 @@
     MOCK_SENSOR_SUBENTRY_DATA_SINGLE,
     MOCK_SENSOR_SUBENTRY_DATA_SINGLE_LAST_RESET_TEMPLATE,
     MOCK_SENSOR_SUBENTRY_DATA_SINGLE_STATE_CLASS,
+    MOCK_SWITCH_SUBENTRY_DATA_SINGLE_STATE_CLASS,
 )
 
 from tests.common import MockConfigEntry, MockMqttReasonCode
@@ -2616,6 +2617,7 @@ async def test_migrate_of_incompatible_config_entry(
 @pytest.mark.parametrize(
     (
         "config_subentries_data",
+        "mock_device_user_input",
         "mock_entity_user_input",
         "mock_entity_details_user_input",
         "mock_entity_details_failed_user_input",
@@ -2626,6 +2628,7 @@ async def test_migrate_of_incompatible_config_entry(
     [
         (
             MOCK_NOTIFY_SUBENTRY_DATA_SINGLE,
+            {"name": "Milk notifier"},
             {"name": "Milkman alert"},
             None,
             None,
@@ -2645,6 +2648,7 @@ async def test_migrate_of_incompatible_config_entry(
         ),
         (
             MOCK_NOTIFY_SUBENTRY_DATA_NO_NAME,
+            {"name": "Milk notifier"},
             {},
             None,
             None,
@@ -2664,6 +2668,7 @@ async def test_migrate_of_incompatible_config_entry(
         ),
         (
             MOCK_SENSOR_SUBENTRY_DATA_SINGLE,
+            {"name": "Test sensor"},
             {"name": "Energy"},
             {"device_class": "enum", "options": ["low", "medium", "high"]},
             (
@@ -2720,6 +2725,7 @@ async def test_migrate_of_incompatible_config_entry(
         ),
         (
             MOCK_SENSOR_SUBENTRY_DATA_SINGLE_STATE_CLASS,
+            {"name": "Test sensor"},
             {"name": "Energy"},
             {
                 "state_class": "measurement",
@@ -2731,18 +2737,48 @@ async def test_migrate_of_incompatible_config_entry(
             (),
             "Test sensor Energy",
         ),
+        (
+            MOCK_SWITCH_SUBENTRY_DATA_SINGLE_STATE_CLASS,
+            {"name": "Test switch"},
+            {"name": "Outlet"},
+            {"device_class": "outlet"},
+            (),
+            {
+                "command_topic": "test-topic",
+                "command_template": "{{ value }}",
+                "state_topic": "test-topic",
+                "value_template": "{{ value_json.value }}",
+                "optimistic": True,
+            },
+            (
+                (
+                    {"command_topic": "test-topic#invalid"},
+                    {"command_topic": "invalid_publish_topic"},
+                ),
+                (
+                    {
+                        "command_topic": "test-topic",
+                        "state_topic": "test-topic#invalid",
+                    },
+                    {"state_topic": "invalid_subscribe_topic"},
+                ),
+            ),
+            "Test switch Outlet",
+        ),
     ],
     ids=[
         "notify_with_entity_name",
         "notify_no_entity_name",
         "sensor_options",
         "sensor_total",
+        "switch",
     ],
 )
 async def test_subentry_configflow(
     hass: HomeAssistant,
     mqtt_mock_entry: MqttMockHAClientGenerator,
     config_subentries_data: dict[str, Any],
+    mock_device_user_input: dict[str, Any],
     mock_entity_user_input: dict[str, Any],
     mock_entity_details_user_input: dict[str, Any],
     mock_entity_details_failed_user_input: tuple[
@@ -2753,7 +2789,7 @@ async def test_subentry_configflow(
     entity_name: str,
 ) -> None:
     """Test the subentry ConfigFlow."""
-    device_name = config_subentries_data["device"]["name"]
+    device_name = mock_device_user_input["name"]
     component = next(iter(config_subentries_data["components"].values()))
 
     await mqtt_mock_entry()
@@ -2780,14 +2816,7 @@ async def test_subentry_configflow(
 
     result = await hass.config_entries.subentries.async_configure(
         result["flow_id"],
-        user_input={
-            "name": device_name,
-            "sw_version": "1.0",
-            "hw_version": "2.1 rev a",
-            "model": "Model XL",
-            "model_id": "mn002",
-            "configuration_url": "https://example.com",
-        },
+        user_input=mock_device_user_input,
     )
     assert result["type"] is FlowResultType.FORM
     assert result["step_id"] == "entity"
