Add autodiscovery feature

Author: roleoroleo

custom_components/yi_hack/config_flow.py

@@ -4,10 +4,15 @@
 
 import voluptuous as vol
 from homeassistant import config_entries
+from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
+from homeassistant.components import zeroconf
 from homeassistant.components.ffmpeg import CONF_EXTRA_ARGUMENTS
 from homeassistant.const import (CONF_HOST, CONF_MAC, CONF_NAME, CONF_PASSWORD,
                                  CONF_PORT, CONF_USERNAME)
 from homeassistant.helpers.device_registry import format_mac
+from homeassistant.helpers.service_info.zeroconf import ZeroconfServiceInfo
+
+from typing import Any
 
 from .common import get_status
 from .const import (ALLWINNER, ALLWINNER_R, ALLWINNERV2, ALLWINNERV2_R,
@@ -35,97 +40,183 @@
     ): vol.In(["auto", "disabled", "x 2", "x 3", "x 4", "x 5"])
 }
 
+DATA_SCHEMA_ZC = {
+    vol.Optional(CONF_USERNAME, default=DEFAULT_USERNAME): str,
+    vol.Optional(CONF_PASSWORD, default=DEFAULT_PASSWORD): str,
+    vol.Optional(CONF_EXTRA_ARGUMENTS, default=DEFAULT_EXTRA_ARGUMENTS): str,
+    vol.Required(
+        CONF_BOOST_SPEAKER,
+        default="auto",
+    ): vol.In(["auto", "disabled", "x 2", "x 3", "x 4", "x 5"])
+}
+
 class YiHackFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
     """Handle a yi-hack config flow."""
 
     VERSION = 1
     CONNECTION_CLASS = config_entries.CONN_CLASS_LOCAL_PUSH
 
-    async def async_step_user(self, user_input=None):
+    def __init__(self) -> None:
+        """Set up the instance."""
+        self.connection_data: dict[str, Any] = {}
+
+    async def async_process_input(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle and complete a flow."""
+        errors = {}
+
+        host = user_input[CONF_HOST]
+        port = user_input[CONF_PORT]
+        user = user_input[CONF_USERNAME]
+        password = user_input[CONF_PASSWORD]
+        extra_arguments = user_input[CONF_EXTRA_ARGUMENTS]
+        boost_speaker = user_input[CONF_BOOST_SPEAKER]
+
+        response = await self.hass.async_add_executor_job(get_status, user_input)
+        if response is not None:
+            try:
+                serial_number = response["serial_number"]
+            except KeyError:
+                serial_number = None
+
+            try:
+                mac = response["mac_addr"]
+            except KeyError:
+                mac = None
+
+            try:
+                ptz = response["ptz"]
+            except KeyError:
+                ptz = "no"
+
+            try:
+                hackname = response["name"]
+            except KeyError:
+                hackname = DEFAULT_BRAND
+
+            try:
+                privacy = response["privacy"]
+                _LOGGER.error("Unsupported hack version, please update your cam")
+                return self.async_abort(reason="wrong_hack_version")
+            except KeyError:
+                privacy = None
+
+            if serial_number is not None and mac is not None:
+                user_input[CONF_SERIAL] = serial_number
+                user_input[CONF_MAC] = format_mac(mac)
+                user_input[CONF_PTZ] = ptz
+                user_input[CONF_HACK_NAME] = hackname
+                if hackname == MSTAR:
+                    user_input[CONF_NAME] = MSTAR_R + "_" + user_input[CONF_MAC].replace(':', '')[6:]
+                elif hackname == ALLWINNER:
+                    user_input[CONF_NAME] = ALLWINNER_R + "_" + user_input[CONF_MAC].replace(':', '')[6:]
+                elif hackname == ALLWINNERV2:
+                    user_input[CONF_NAME] = ALLWINNERV2_R + "_" + user_input[CONF_MAC].replace(':', '')[6:]
+                elif hackname == V5:
+                    user_input[CONF_NAME] = V5_R + "_" + user_input[CONF_MAC].replace(':', '')[6:]
+                elif hackname == SONOFF:
+                    user_input[CONF_NAME] = SONOFF_R + "_" + user_input[CONF_MAC].replace(':', '')[6:]
+                else:
+                    user_input[CONF_NAME] = DEFAULT_BRAND_R + "_" + user_input[CONF_MAC].replace(':', '')[6:]
+            else:
+                _LOGGER.error("Unable to get mac address or serial number from device %s", host)
+                errors["base"] = "cannot_get_mac_or_serial"
+
+            if not errors:
+                await self.async_set_unique_id(user_input[CONF_MAC])
+                self._abort_if_unique_id_configured()
+
+                for entry in self._async_current_entries():
+                    if entry.data[CONF_MAC] == user_input[CONF_MAC]:
+                        _LOGGER.error("Device already configured: %s", host)
+                        return self.async_abort(reason="already_configured")
+
+                user_input[CONF_RTSP_PORT] = None
+                user_input[CONF_MQTT_PREFIX] = None
+                user_input[CONF_TOPIC_STATUS] = None
+                user_input[CONF_TOPIC_MOTION_DETECTION] = None
+                user_input[CONF_TOPIC_SOUND_DETECTION] = None
+                user_input[CONF_TOPIC_MOTION_DETECTION_IMAGE] = None
+
+                return self.async_create_entry(
+                    title=user_input[CONF_NAME],
+                    data=user_input
+                )
+
+    async def async_step_user(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
         """Handle a flow initiated by the user."""
         errors = {}
 
         if user_input is not None:
-            host = user_input[CONF_HOST]
-            port = user_input[CONF_PORT]
-            user = user_input[CONF_USERNAME]
-            password = user_input[CONF_PASSWORD]
-            extra_arguments = user_input[CONF_EXTRA_ARGUMENTS]
-            boost_speaker = user_input[CONF_BOOST_SPEAKER]
-
-            response = await self.hass.async_add_executor_job(get_status, user_input)
-            if response is not None:
-                try:
-                    serial_number = response["serial_number"]
-                except KeyError:
-                    serial_number = None
-
-                try:
-                    mac = response["mac_addr"]
-                except KeyError:
-                    mac = None
-
-                try:
-                    ptz = response["ptz"]
-                except KeyError:
-                    ptz = "no"
-
-                try:
-                    hackname = response["name"]
-                except KeyError:
-                    hackname = DEFAULT_BRAND
-
-                try:
-                    privacy = response["privacy"]
-                    _LOGGER.error("Unsupported hack version, please update your cam")
-                    return self.async_abort(reason="wrong_hack_version")
-                except KeyError:
-                    privacy = None
-
-                if serial_number is not None and mac is not None:
-                    user_input[CONF_SERIAL] = serial_number
-                    user_input[CONF_MAC] = format_mac(mac)
-                    user_input[CONF_PTZ] = ptz
-                    user_input[CONF_HACK_NAME] = hackname
-                    if hackname == MSTAR:
-                        user_input[CONF_NAME] = MSTAR_R + "_" + user_input[CONF_MAC].replace(':', '')[6:]
-                    elif hackname == ALLWINNER:
-                        user_input[CONF_NAME] = ALLWINNER_R + "_" + user_input[CONF_MAC].replace(':', '')[6:]
-                    elif hackname == ALLWINNERV2:
-                        user_input[CONF_NAME] = ALLWINNERV2_R + "_" + user_input[CONF_MAC].replace(':', '')[6:]
-                    elif hackname == V5:
-                        user_input[CONF_NAME] = V5_R + "_" + user_input[CONF_MAC].replace(':', '')[6:]
-                    elif hackname == SONOFF:
-                        user_input[CONF_NAME] = SONOFF_R + "_" + user_input[CONF_MAC].replace(':', '')[6:]
-                    else:
-                        user_input[CONF_NAME] = DEFAULT_BRAND_R + "_" + user_input[CONF_MAC].replace(':', '')[6:]
-                else:
-                    _LOGGER.error("Unable to get mac address or serial number from device %s", host)
-                    errors["base"] = "cannot_get_mac_or_serial"
-
-                if not errors:
-                    await self.async_set_unique_id(user_input[CONF_MAC])
-                    self._abort_if_unique_id_configured()
-
-                    for entry in self._async_current_entries():
-                        if entry.data[CONF_MAC] == user_input[CONF_MAC]:
-                            _LOGGER.error("Device already configured: %s", host)
-                            return self.async_abort(reason="already_configured")
-
-                    user_input[CONF_RTSP_PORT] = None
-                    user_input[CONF_MQTT_PREFIX] = None
-                    user_input[CONF_TOPIC_STATUS] = None
-                    user_input[CONF_TOPIC_MOTION_DETECTION] = None
-                    user_input[CONF_TOPIC_SOUND_DETECTION] = None
-                    user_input[CONF_TOPIC_MOTION_DETECTION_IMAGE] = None
-
-                    return self.async_create_entry(
-                        title=user_input[CONF_NAME],
-                        data=user_input
-                    )
+            return await self.async_process_input(user_input)
 
         return self.async_show_form(
             step_id="user",
             data_schema=vol.Schema(DATA_SCHEMA),
             errors=errors,
         )
+
+    async def async_step_zeroconf(
+        self, discovery_info: ZeroconfServiceInfo
+    ) -> ConfigFlowResult:
+        """Handle a flow initialized by zeroconf discovery."""
+        errors = {}
+
+        host = discovery_info.host
+        if discovery_info.port is not None and discovery_info.port != 0:
+            port = discovery_info.port
+        else:
+            port = 80
+
+        hostname = discovery_info.hostname
+        name = discovery_info.name.split(".", 1)[0]
+        mac = discovery_info.properties["mac"]
+
+        mac = format_mac(mac)
+
+        if hostname is None:
+            return self.async_abort(reason="not_yi-hack_device")
+
+        _LOGGER.info("Device with MAC %s already exists, update IP to %s and port to %s", mac, host, port)
+        await self.async_set_unique_id(mac)
+        self._abort_if_unique_id_configured(updates={CONF_HOST: host, CONF_PORT: port})
+
+        self.context.update(
+            {
+                "title_placeholders": {"name": name},
+            }
+        )
+
+        self.connection_data.update(
+            {
+                CONF_HOST: host,
+                CONF_PORT: port,
+                CONF_USERNAME: "",
+                CONF_PASSWORD: "",
+                CONF_EXTRA_ARGUMENTS: DEFAULT_EXTRA_ARGUMENTS,
+                CONF_BOOST_SPEAKER: "auto",
+            }
+        )
+
+        return await self.async_step_zeroconf_confirm()
+
+    async def async_step_zeroconf_confirm(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle a confirmation flow initiated by zeroconf."""
+        errors = {}
+
+        if user_input is not None:
+            user_input[CONF_HOST] = self.connection_data[CONF_HOST]
+            user_input[CONF_PORT] = self.connection_data[CONF_PORT]
+
+            return await self.async_process_input(user_input)
+
+        return self.async_show_form(
+            step_id="zeroconf_confirm",
+            data_schema=vol.Schema(DATA_SCHEMA_ZC),
+            errors=errors,
+        )

custom_components/yi_hack/manifest.json

@@ -7,5 +7,6 @@
   "documentation": "https://github.com/roleoroleo/yi-hack_ha_integration",
   "iot_class": "local_push",
   "issue_tracker": "https://github.com/roleoroleo/yi-hack_ha_integration/issues",
-  "version": "0.5.3"
+  "version": "0.5.3",
+  "zeroconf": ["_yi-hack._tcp.local."]
 }

custom_components/yi_hack/strings.json

@@ -25,7 +25,8 @@
     },
     "abort": {
       "already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
-      "wrong_hack_version": "Unsupported hack version, please update your device"
+      "wrong_hack_version": "Unsupported hack version, please update your device",
+      "not_yi-hack_device": "This is not a Yi hack camera"
     }
   }
 }

custom_components/yi_hack/translations/en.json

@@ -25,7 +25,8 @@
     },
     "abort": {
       "already_configured": "Device is already configured",
-      "wrong_hack_version": "Unsupported hack version, please update your device"
+      "wrong_hack_version": "Unsupported hack version, please update your device",
+      "not_yi-hack_device": "This is not a yi-hack camera"
     }
   }
 }

custom_components/yi_hack/translations/es.json

@@ -25,7 +25,8 @@
     },
     "abort": {
       "already_configured": "El dispositivo ya est\u00e1 configurado",
-      "wrong_hack_version": "Versi\u00f3n de yi-hack no compatible, actualice su dispositivo"
+      "wrong_hack_version": "Versi\u00f3n de yi-hack no compatible, actualice su dispositivo",
+      "not_yi-hack_device": "Esta no es una c\u00e1mara yi-hack"
     }
   }
 }

custom_components/yi_hack/translations/it.json

@@ -25,7 +25,8 @@
     },
     "abort": {
       "already_configured": "Il dispositivo \u00e8 gi\u00e0 configurato",
-      "wrong_hack_verions": "Versione di yi-hack non supportata, aggiorna il tuo dispositivo"
+      "wrong_hack_version": "Versione di yi-hack non supportata, aggiorna il tuo dispositivo",
+      "not_yi-hack_device": "Questa non \u00e8 una camera yi-hack"
     }
   }
 }

custom_components/yi_hack/translations/pl.json

@@ -25,7 +25,8 @@
     },
     "abort": {
       "already_configured": "Urządzenie już skonfigurowane",
-      "wrong_hack_version": "Nieobsługiwana wersja hakerska, zaktualizuj swoje urządzenie"
+      "wrong_hack_version": "Nieobsługiwana wersja hakerska, zaktualizuj swoje urządzenie",
+      "not_yi-hack_device": "To nie jest aparat yi-hack"
     }
   }
 }

custom_components/yi_hack/translations/pt-BR.json

@@ -25,7 +25,8 @@
     },
     "abort": {
       "already_configured": "O dispositivo já está configurado",
-      "wrong_hack_version": "Versão de yi-hack não suportada, atualize seu dispositivo"
+      "wrong_hack_version": "Versão de yi-hack não suportada, atualize seu dispositivo",
+      "not_yi-hack_device": "Esta não é uma câmera yi-hack"
     }
   }
 }