Add experimental features to initial config flow

- Add experimental_features toggle to initial setup (not just options)
- Add two-step flow: connection settings → experimental config
- Add translations/ directory with en.json for proper HA translations
- Both config and options flows now support experimental features

Author: ashleigh-hopkins

custom_components/mitsubishi/config_flow.py

@@ -40,6 +40,7 @@
         vol.Optional(CONF_SCAN_INTERVAL, default=DEFAULT_SCAN_INTERVAL): vol.All(
             vol.Coerce(int), vol.Range(min=10, max=300)
         ),
+        vol.Optional(CONF_EXPERIMENTAL_FEATURES, default=False): bool,
     }
 )
 
@@ -84,6 +85,12 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
     VERSION = 1
     MINOR_VERSION = 1
 
+    def __init__(self) -> None:
+        """Initialize the config flow."""
+        self._connection_data: dict[str, Any] = {}
+        self._experimental_features: bool = False
+        self._device_info: dict[str, Any] = {}
+
     @staticmethod
     def async_get_options_flow(
         config_entry: config_entries.ConfigEntry,
@@ -99,6 +106,9 @@ async def async_step_user(self, user_input: dict[str, Any] | None = None) -> Any
         if user_input is not None:
             _LOGGER.debug("Processing user input for config flow")
             try:
+                # Extract experimental features flag
+                self._experimental_features = user_input.pop(CONF_EXPERIMENTAL_FEATURES, False)
+
                 _LOGGER.debug("Calling validate_input")
                 info = await validate_input(self.hass, user_input)
                 _LOGGER.debug("Validation successful, info: %s", info)
@@ -107,8 +117,16 @@ async def async_step_user(self, user_input: dict[str, Any] | None = None) -> Any
                 await self.async_set_unique_id(info["unique_id"])
                 self._abort_if_unique_id_configured()
 
-                _LOGGER.debug("Creating config entry")
-                return self.async_create_entry(title=info["title"], data=user_input)
+                # Store for later
+                self._connection_data = user_input
+                self._device_info = info
+
+                # If experimental features enabled, go to step 2
+                if self._experimental_features:
+                    return await self.async_step_experimental()
+
+                # Otherwise, create entry directly
+                return self._create_entry(external_temp_entity=None)
 
             except CannotConnect:
                 _LOGGER.error("Cannot connect to device")
@@ -127,6 +145,41 @@ async def async_step_user(self, user_input: dict[str, Any] | None = None) -> Any
             step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
         )
 
+    async def async_step_experimental(self, user_input: dict[str, Any] | None = None) -> Any:
+        """Step 2: Configure experimental features (external temperature sensor)."""
+        if user_input is not None:
+            external_temp_entity = user_input.get(CONF_EXTERNAL_TEMP_ENTITY)
+            return self._create_entry(external_temp_entity=external_temp_entity)
+
+        experimental_schema = vol.Schema(
+            {
+                vol.Optional(CONF_EXTERNAL_TEMP_ENTITY): selector.EntitySelector(
+                    selector.EntitySelectorConfig(
+                        domain=["sensor", "input_number", "number"],
+                    )
+                ),
+            }
+        )
+
+        return self.async_show_form(step_id="experimental", data_schema=experimental_schema)
+
+    def _create_entry(self, external_temp_entity: str | None) -> Any:
+        """Create the config entry with options."""
+        _LOGGER.debug("Creating config entry")
+
+        # Build options
+        options: dict[str, Any] = {
+            CONF_EXPERIMENTAL_FEATURES: self._experimental_features,
+        }
+        if self._experimental_features and external_temp_entity:
+            options[CONF_EXTERNAL_TEMP_ENTITY] = external_temp_entity
+
+        return self.async_create_entry(
+            title=self._device_info["title"],
+            data=self._connection_data,
+            options=options,
+        )
+
 
 class OptionsFlowHandler(config_entries.OptionsFlow):
     """Handle options flow for the Mitsubishi integration."""

custom_components/mitsubishi/strings.json

@@ -10,7 +10,20 @@
           "admin_username": "Admin Username (default: admin)",
           "admin_password": "Admin Password (default: me1debug@0567)",
           "scan_interval": "Update Interval (seconds, 10-300)",
-          "enable_capability_detection": "Enable capability detection"
+          "experimental_features": "Enable experimental features"
+        },
+        "data_description": {
+          "experimental_features": "Enable experimental features like remote temperature sensor support. These features may change or be removed in future versions."
+        }
+      },
+      "experimental": {
+        "title": "Experimental Features Configuration",
+        "description": "⚠️ WARNING: The remote temperature feature should NOT be used for critical heating/cooling needs. If your Home Assistant server goes offline, your external sensor becomes unavailable, or provides invalid readings, the AC will NOT automatically revert to its internal sensor. You must manually switch back to Internal mode.",
+        "data": {
+          "external_temperature_entity": "External Temperature Sensor"
+        },
+        "data_description": {
+          "external_temperature_entity": "Select a temperature sensor to use as the room temperature when Remote mode is selected. Leave empty to only use the internal sensor. The AC must receive regular temperature updates - if updates stop, the AC continues using the last received value indefinitely."
         }
       }
     },

custom_components/mitsubishi/translations/en.json

@@ -0,0 +1,72 @@
+{
+  "config": {
+    "step": {
+      "user": {
+        "title": "Mitsubishi Air Conditioner",
+        "description": "Configure your Mitsubishi MAC-577IF-2E air conditioner. The encryption key defaults to 'unregistered' which works for most devices. Only change this if your device uses a custom key.",
+        "data": {
+          "host": "IP Address",
+          "encryption_key": "Encryption Key (default: unregistered)",
+          "admin_username": "Admin Username (default: admin)",
+          "admin_password": "Admin Password (default: me1debug@0567)",
+          "scan_interval": "Update Interval (seconds, 10-300)",
+          "experimental_features": "Enable experimental features"
+        },
+        "data_description": {
+          "experimental_features": "Enable experimental features like remote temperature sensor support. These features may change or be removed in future versions."
+        }
+      },
+      "experimental": {
+        "title": "Experimental Features Configuration",
+        "description": "⚠️ WARNING: The remote temperature feature should NOT be used for critical heating/cooling needs. If your Home Assistant server goes offline, your external sensor becomes unavailable, or provides invalid readings, the AC will NOT automatically revert to its internal sensor. You must manually switch back to Internal mode.",
+        "data": {
+          "external_temperature_entity": "External Temperature Sensor"
+        },
+        "data_description": {
+          "external_temperature_entity": "Select a temperature sensor to use as the room temperature when Remote mode is selected. Leave empty to only use the internal sensor. The AC must receive regular temperature updates - if updates stop, the AC continues using the last received value indefinitely."
+        }
+      }
+    },
+    "error": {
+      "cannot_connect": "Failed to connect to the air conditioner. Please check the IP address, encryption key, and ensure the device is accessible on your network.",
+      "unknown": "Unexpected error occurred. Please try again."
+    },
+    "abort": {
+      "already_configured": "Device is already configured"
+    }
+  },
+  "options": {
+    "step": {
+      "init": {
+        "title": "Reconfigure Mitsubishi Air Conditioner",
+        "description": "Update the configuration settings for your Mitsubishi AC. Changes will be applied after validation and the integration will be reloaded.",
+        "data": {
+          "host": "IP Address",
+          "encryption_key": "Encryption Key (default: unregistered)",
+          "admin_username": "Admin Username (default: admin)",
+          "admin_password": "Admin Password (default: me1debug@0567)",
+          "scan_interval": "Update Interval (seconds, 10-300)",
+          "enable_capability_detection": "Enable capability detection",
+          "experimental_features": "Enable experimental features"
+        },
+        "data_description": {
+          "experimental_features": "Enable experimental features like remote temperature sensor support. These features may change or be removed in future versions."
+        }
+      },
+      "experimental": {
+        "title": "Experimental Features Configuration",
+        "description": "⚠️ WARNING: The remote temperature feature should NOT be used for critical heating/cooling needs. If your Home Assistant server goes offline, your external sensor becomes unavailable, or provides invalid readings, the AC will NOT automatically revert to its internal sensor. You must manually switch back to Internal mode.",
+        "data": {
+          "external_temperature_entity": "External Temperature Sensor"
+        },
+        "data_description": {
+          "external_temperature_entity": "Select a temperature sensor to use as the room temperature when Remote mode is selected. Leave empty to only use the internal sensor. The AC must receive regular temperature updates - if updates stop, the AC continues using the last received value indefinitely."
+        }
+      }
+    },
+    "error": {
+      "cannot_connect": "Failed to connect to the air conditioner. Please check the IP address, encryption key, and ensure the device is accessible on your network.",
+      "unknown": "Unexpected error occurred. Please try again."
+    }
+  }
+}