Show Z2M docs link in final step of hardware config flow (home-assistant#155736)

Author: puddly

homeassistant/components/homeassistant_connect_zbt2/strings.json

@@ -62,6 +62,10 @@
         },
         "title": "[%key:component::homeassistant_hardware::firmware_picker::options::step::pick_firmware::title%]"
       },
+      "show_z2m_docs_url": {
+        "description": "[%key:component::homeassistant_hardware::firmware_picker::options::step::show_z2m_docs_url::description%]",
+        "title": "[%key:component::homeassistant_hardware::firmware_picker::options::step::show_z2m_docs_url::title%]"
+      },
       "start_otbr_addon": {
         "title": "[%key:component::homeassistant_hardware::firmware_picker::options::step::start_otbr_addon::title%]"
       },
@@ -204,6 +208,10 @@
       "reconfigure_addon": {
         "title": "[%key:component::homeassistant_hardware::silabs_multiprotocol_hardware::options::step::reconfigure_addon::title%]"
       },
+      "show_z2m_docs_url": {
+        "description": "[%key:component::homeassistant_hardware::firmware_picker::options::step::show_z2m_docs_url::description%]",
+        "title": "[%key:component::homeassistant_hardware::firmware_picker::options::step::show_z2m_docs_url::title%]"
+      },
       "start_addon": {
         "title": "[%key:component::homeassistant_hardware::silabs_multiprotocol_hardware::options::step::start_addon::title%]"
       },

homeassistant/components/homeassistant_hardware/const.py

@@ -35,3 +35,5 @@
 
 SILABS_MULTIPROTOCOL_ADDON_SLUG = "core_silabs_multiprotocol"
 SILABS_FLASHER_ADDON_SLUG = "core_silabs_flasher"
+
+Z2M_EMBER_DOCS_URL = "https://www.zigbee2mqtt.io/guide/adapters/emberznet.html"

homeassistant/components/homeassistant_hardware/firmware_config_flow.py

@@ -33,7 +33,7 @@
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 from homeassistant.helpers.hassio import is_hassio
 
-from .const import OTBR_DOMAIN, ZHA_DOMAIN
+from .const import OTBR_DOMAIN, Z2M_EMBER_DOCS_URL, ZHA_DOMAIN
 from .util import (
     ApplicationType,
     FirmwareInfo,
@@ -456,7 +456,7 @@ async def async_step_continue_zigbee(
         assert self._hardware_name is not None
 
         if self._zigbee_integration == ZigbeeIntegration.OTHER:
-            return self._async_flow_finished()
+            return await self.async_step_show_z2m_docs_url()
 
         result = await self.hass.config_entries.flow.async_init(
             ZHA_DOMAIN,
@@ -475,6 +475,21 @@ async def async_step_continue_zigbee(
         )
         return self._continue_zha_flow(result)
 
+    async def async_step_show_z2m_docs_url(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Show Zigbee2MQTT documentation link."""
+        if user_input is not None:
+            return self._async_flow_finished()
+
+        return self.async_show_form(
+            step_id="show_z2m_docs_url",
+            description_placeholders={
+                **self._get_translation_placeholders(),
+                "z2m_docs_url": Z2M_EMBER_DOCS_URL,
+            },
+        )
+
     @callback
     def _continue_zha_flow(self, zha_result: ConfigFlowResult) -> ConfigFlowResult:
         """Continue the ZHA flow."""

homeassistant/components/homeassistant_hardware/strings.json

@@ -53,6 +53,10 @@
           },
           "title": "Pick your protocol"
         },
+        "show_z2m_docs_url": {
+          "description": "Your {model} is now running the latest Zigbee firmware.\nPlease read the Zigbee2MQTT documentation for EmberZNet adapters and copy the config for your {model}: {z2m_docs_url}",
+          "title": "Set up Zigbee2MQTT"
+        },
         "start_otbr_addon": {
           "title": "Configuring Thread"
         },

homeassistant/components/homeassistant_sky_connect/strings.json

@@ -62,6 +62,10 @@
         },
         "title": "[%key:component::homeassistant_hardware::firmware_picker::options::step::pick_firmware::title%]"
       },
+      "show_z2m_docs_url": {
+        "description": "[%key:component::homeassistant_hardware::firmware_picker::options::step::show_z2m_docs_url::description%]",
+        "title": "[%key:component::homeassistant_hardware::firmware_picker::options::step::show_z2m_docs_url::title%]"
+      },
       "start_otbr_addon": {
         "title": "[%key:component::homeassistant_hardware::firmware_picker::options::step::start_otbr_addon::title%]"
       },
@@ -204,6 +208,10 @@
       "reconfigure_addon": {
         "title": "[%key:component::homeassistant_hardware::silabs_multiprotocol_hardware::options::step::reconfigure_addon::title%]"
       },
+      "show_z2m_docs_url": {
+        "description": "[%key:component::homeassistant_hardware::firmware_picker::options::step::show_z2m_docs_url::description%]",
+        "title": "[%key:component::homeassistant_hardware::firmware_picker::options::step::show_z2m_docs_url::title%]"
+      },
       "start_addon": {
         "title": "[%key:component::homeassistant_hardware::silabs_multiprotocol_hardware::options::step::start_addon::title%]"
       },

homeassistant/components/homeassistant_yellow/strings.json

@@ -138,6 +138,10 @@
       "reconfigure_addon": {
         "title": "[%key:component::homeassistant_hardware::silabs_multiprotocol_hardware::options::step::reconfigure_addon::title%]"
       },
+      "show_z2m_docs_url": {
+        "description": "[%key:component::homeassistant_hardware::firmware_picker::options::step::show_z2m_docs_url::description%]",
+        "title": "[%key:component::homeassistant_hardware::firmware_picker::options::step::show_z2m_docs_url::title%]"
+      },
       "start_addon": {
         "title": "[%key:component::homeassistant_hardware::silabs_multiprotocol_hardware::options::step::start_addon::title%]"
       },

tests/components/homeassistant_hardware/test_config_flow.py

@@ -16,6 +16,7 @@
 import pytest
 from yarl import URL
 
+from homeassistant.components.homeassistant_hardware.const import Z2M_EMBER_DOCS_URL
 from homeassistant.components.homeassistant_hardware.firmware_config_flow import (
     STEP_PICK_FIRMWARE_THREAD,
     STEP_PICK_FIRMWARE_ZIGBEE,
@@ -577,12 +578,26 @@ async def test_config_flow_zigbee_custom_other(hass: HomeAssistant) -> None:
         assert pick_result["progress_action"] == "install_firmware"
         assert pick_result["step_id"] == "install_zigbee_firmware"
 
-        create_result = await consume_progress_flow(
+        show_z2m_result = await consume_progress_flow(
             hass,
             flow_id=pick_result["flow_id"],
             valid_step_ids=("install_zigbee_firmware",),
         )
 
+        # After firmware installation, Z2M docs link is shown
+        assert show_z2m_result["type"] is FlowResultType.FORM
+        assert show_z2m_result["step_id"] == "show_z2m_docs_url"
+        assert (
+            show_z2m_result["description_placeholders"]["z2m_docs_url"]
+            == Z2M_EMBER_DOCS_URL
+        )
+
+        # Submit the form to complete the flow
+        create_result = await hass.config_entries.flow.async_configure(
+            show_z2m_result["flow_id"],
+            user_input={},
+        )
+
         assert create_result["type"] is FlowResultType.CREATE_ENTRY
 
     config_entry = create_result["result"]