ESPHome use dhcp responses to update connection host of known devices (#74206)

* ESPHome use dhcp responses to update connection host of known devices

* Add test for dhcp

* Add another test to cover when there are no changes required

homeassistant/components/esphome/config_flow.py

@@ -16,7 +16,7 @@ from aioesphomeapi import (
 )
 import voluptuous as vol
 
-from homeassistant.components import zeroconf
+from homeassistant.components import dhcp, zeroconf
 from homeassistant.config_entries import ConfigFlow
 from homeassistant.const import CONF_HOST, CONF_NAME, CONF_PASSWORD, CONF_PORT
 from homeassistant.core import callback
@@ -189,6 +189,49 @@ class EsphomeFlowHandler(ConfigFlow, domain=DOMAIN):
 
         return await self.async_step_discovery_confirm()
 
+    async def async_step_dhcp(self, discovery_info: dhcp.DhcpServiceInfo) -> FlowResult:
+        """Handle DHCP discovery."""
+        node_name = discovery_info.hostname
+
+        await self.async_set_unique_id(node_name)
+        self._abort_if_unique_id_configured(updates={CONF_HOST: discovery_info.ip})
+
+        for entry in self._async_current_entries():
+            found = False
+
+            if CONF_HOST in entry.data and entry.data[CONF_HOST] in (
+                discovery_info.ip,
+                f"{node_name}.local",
+            ):
+                # Is this address or IP address already configured?
+                found = True
+            elif DomainData.get(self.hass).is_entry_loaded(entry):
+                # Does a config entry with this name already exist?
+                data = DomainData.get(self.hass).get_entry_data(entry)
+
+                # Node names are unique in the network
+                if data.device_info is not None:
+                    found = data.device_info.name == node_name
+
+            if found:
+                # Backwards compat, we update old entries
+                if not entry.unique_id:
+                    self.hass.config_entries.async_update_entry(
+                        entry,
+                        data={
+                            **entry.data,
+                            CONF_HOST: discovery_info.ip,
+                        },
+                        unique_id=node_name,
+                    )
+                    self.hass.async_create_task(
+                        self.hass.config_entries.async_reload(entry.entry_id)
+                    )
+
+                break
+
+        return self.async_abort(reason="already_configured")
+
     @callback
     def _async_get_entry(self) -> FlowResult:
         config_data = {

homeassistant/components/esphome/manifest.json

@@ -5,6 +5,7 @@
   "documentation": "https://www.home-assistant.io/integrations/esphome",
   "requirements": ["aioesphomeapi==10.10.0"],
   "zeroconf": ["_esphomelib._tcp.local."],
+  "dhcp": [{ "registered_devices": true }],
   "codeowners": ["@OttoWinter", "@jesserockz"],
   "after_dependencies": ["zeroconf", "tag"],
   "iot_class": "local_push",

homeassistant/generated/dhcp.py

@@ -28,6 +28,7 @@ DHCP: list[dict[str, str | bool]] = [
     {'domain': 'elkm1', 'macaddress': '00409D*'},
     {'domain': 'emonitor', 'hostname': 'emonitor*', 'macaddress': '0090C2*'},
     {'domain': 'emonitor', 'registered_devices': True},
+    {'domain': 'esphome', 'registered_devices': True},
     {'domain': 'flume', 'hostname': 'flume-gw-*'},
     {'domain': 'flux_led', 'registered_devices': True},
     {'domain': 'flux_led', 'hostname': '[ba][lk]*', 'macaddress': '18B905*'},

tests/components/esphome/test_config_flow.py

@@ -12,7 +12,7 @@ from aioesphomeapi import (
 import pytest
 
 from homeassistant import config_entries
-from homeassistant.components import zeroconf
+from homeassistant.components import dhcp, zeroconf
 from homeassistant.components.esphome import CONF_NOISE_PSK, DOMAIN, DomainData
 from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_PORT
 from homeassistant.data_entry_flow import (
@@ -532,3 +532,61 @@ async def test_reauth_confirm_invalid(hass, mock_client, mock_zeroconf):
     assert result["step_id"] == "reauth_confirm"
     assert result["errors"]
     assert result["errors"]["base"] == "invalid_psk"
+
+
+async def test_discovery_dhcp_updates_host(hass, mock_client):
+    """Test dhcp discovery updates host and aborts."""
+    entry = MockConfigEntry(
+        domain=DOMAIN,
+        data={CONF_HOST: "192.168.43.183", CONF_PORT: 6053, CONF_PASSWORD: ""},
+    )
+    entry.add_to_hass(hass)
+
+    mock_entry_data = MagicMock()
+    mock_entry_data.device_info.name = "test8266"
+    domain_data = DomainData.get(hass)
+    domain_data.set_entry_data(entry, mock_entry_data)
+
+    service_info = dhcp.DhcpServiceInfo(
+        ip="192.168.43.184",
+        hostname="test8266",
+        macaddress="00:00:00:00:00:00",
+    )
+    result = await hass.config_entries.flow.async_init(
+        "esphome", context={"source": config_entries.SOURCE_DHCP}, data=service_info
+    )
+
+    assert result["type"] == RESULT_TYPE_ABORT
+    assert result["reason"] == "already_configured"
+
+    assert entry.unique_id == "test8266"
+    assert entry.data[CONF_HOST] == "192.168.43.184"
+
+
+async def test_discovery_dhcp_no_changes(hass, mock_client):
+    """Test dhcp discovery updates host and aborts."""
+    entry = MockConfigEntry(
+        domain=DOMAIN,
+        data={CONF_HOST: "192.168.43.183", CONF_PORT: 6053, CONF_PASSWORD: ""},
+    )
+    entry.add_to_hass(hass)
+
+    mock_entry_data = MagicMock()
+    mock_entry_data.device_info.name = "test8266"
+    domain_data = DomainData.get(hass)
+    domain_data.set_entry_data(entry, mock_entry_data)
+
+    service_info = dhcp.DhcpServiceInfo(
+        ip="192.168.43.183",
+        hostname="test8266",
+        macaddress="00:00:00:00:00:00",
+    )
+    result = await hass.config_entries.flow.async_init(
+        "esphome", context={"source": config_entries.SOURCE_DHCP}, data=service_info
+    )
+
+    assert result["type"] == RESULT_TYPE_ABORT
+    assert result["reason"] == "already_configured"
+
+    assert entry.unique_id == "test8266"
+    assert entry.data[CONF_HOST] == "192.168.43.183"