feat: manual setup mode (#18)

Allow to enter an IP address during setup. If left empty, auto-discovery
is started, otherwise the setup process tries to retrieve device
information from the entered address.

Author: zehnm

README.md

@@ -69,7 +69,7 @@ To do that, we need to compile it on the target architecture as `pyinstaller` do
 
 On x86-64 Linux we need Qemu to emulate the aarch64 target platform:
 ```bash
-sudo apt-get install qemu binfmt-support qemu-user-static
+sudo apt install qemu binfmt-support qemu-user-static
 docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
 ```
 
@@ -81,8 +81,7 @@ docker run --rm --name builder \
     -v "$PWD":/workspace \
     docker.io/unfoldedcircle/r2-pyinstaller:3.11.6  \
     bash -c \
-      "cd /workspace && \
-      python -m pip install -r requirements.txt && \
+      "python -m pip install -r requirements.txt && \
       pyinstaller --clean --onefile --name intg-androidtv intg-androidtv/driver.py"
 ```
 
@@ -95,8 +94,7 @@ docker run --rm --name builder \
     -v "$PWD":/workspace \
     docker.io/unfoldedcircle/r2-pyinstaller:3.11.6  \
     bash -c \
-      "cd /workspace && \
-      python -m pip install -r requirements.txt && \
+      "python -m pip install -r requirements.txt && \
       pyinstaller --clean --onefile --name intg-androidtv intg-androidtv/driver.py"
 ```
 

driver.json

@@ -1,6 +1,6 @@
 {
 	"driver_id": "uc_androidtv_driver",
-	"version": "0.4.3",
+	"version": "0.4.4",
 	"min_core_api": "0.20.0",
 	"name": { "en": "Android TV" },
 	"icon": "uc:integration",
@@ -28,7 +28,7 @@
 				"field": {
 					"label": {
 						"value": {
-							"en": "The integration will discover your Android TV on your network. Only devices running the [Android TV Remote Service](https://play.google.com/store/apps/details?id=com.google.android.tv.remote.service) are supported.\nDuring the process, you might need to enter a PIN that is shown on your Android TV. Please make sure that your Android TV is powered on and that no old paring request is shown.\nIf paring continuously fails, reboot your Android TV device and try again."
+							"en": "The integration will discover your Android TV on your network. Only devices running the [Android TV Remote Service](https://play.google.com/store/apps/details?id=com.google.android.tv.remote.service) are supported.\nDuring the process, you might need to enter a PIN that is shown on your Android TV. Please make sure that your Android TV is powered on and that no old pairing request is shown.\nIf pairing continuously fails, reboot your Android TV device and try again."
 						}
 					}
 				}

intg-androidtv/setup_flow.py

@@ -28,8 +28,9 @@ class SetupSteps(IntEnum):
     """Enumeration of setup steps to keep track of user data responses."""
 
     INIT = 0
-    DEVICE_CHOICE = 1
-    PAIRING_PIN = 2
+    CONFIGURATION_MODE = 1
+    DEVICE_CHOICE = 2
+    PAIRING_PIN = 3
 
 
 _setup_step = SetupSteps.INIT
@@ -54,8 +55,10 @@ async def driver_setup_handler(msg: SetupDriver) -> SetupAction:
         return await handle_driver_setup(msg)
     if isinstance(msg, UserDataResponse):
         _LOG.debug("UserDataResponse: %s", msg)
+        if _setup_step == SetupSteps.CONFIGURATION_MODE and "address" in msg.input_values:
+            return await handle_configuration_mode(msg)
         if _setup_step == SetupSteps.DEVICE_CHOICE and "choice" in msg.input_values:
-            return await handle_user_data_choice(msg)
+            return await handle_device_choice(msg)
         if _setup_step == SetupSteps.PAIRING_PIN and "pin" in msg.input_values:
             return await handle_user_data_pin(msg)
         _LOG.error("No or invalid user response was received: %s", msg)
@@ -78,31 +81,76 @@ async def handle_driver_setup(_msg: DriverSetupRequest) -> RequestUserInput | Se
     Start driver setup.
 
     Initiated by Remote Two to set up the driver.
-    Start Android TV discovery and present the found devices to the user to choose from.
+    Ask user to enter ip-address for manual configuration, otherwise auto-discovery is used.
 
     :param _msg: not used, we don't have any input fields in the first setup screen.
     :return: the setup action on how to continue
     """
+    global _setup_step
+
+    _LOG.debug("Starting driver setup")
+    _setup_step = SetupSteps.CONFIGURATION_MODE
+    return RequestUserInput(
+        {"en": "Setup mode", "de": "Setup Modus"},
+        [
+            {"field": {"text": {"value": ""}}, "id": "address", "label": {"en": "IP address", "de": "IP-Adresse"}},
+            {
+                "id": "info",
+                "label": {"en": ""},
+                "field": {
+                    "label": {
+                        "value": {
+                            "en": "Leave blank to use auto-discovery.",
+                            "de": "Leer lassen, um automatische Erkennung zu verwenden.",
+                            "fr": "Laissez le champ vide pour utiliser la découverte automatique.",
+                        }
+                    }
+                },
+            },
+        ],
+    )
+
+
+async def handle_configuration_mode(msg: UserDataResponse) -> RequestUserInput | SetupError:
+    """
+    Process user data response in a setup process.
+
+    If ``address`` field is set by the user: try connecting to device and retrieve model information.
+    Otherwise, start Android TV discovery and present the found devices to the user to choose from.
+
+    :param msg: response data from the requested user data
+    :return: the setup action on how to continue
+    """
     global _discovered_android_tvs
     global _pairing_android_tv
     global _setup_step
 
-    _LOG.info("Starting driver setup with Android TV discovery")
-
     # clear all configured devices and any previous pairing attempt
     if _pairing_android_tv:
         _pairing_android_tv.disconnect()
         _pairing_android_tv = None
     config.devices.clear()  # triggers device instance removal
 
-    # start discovery
-    _discovered_android_tvs = await discover.android_tvs()
-
     dropdown_items = []
-    for discovered_tv in _discovered_android_tvs:
-        tv_data = {"id": discovered_tv["address"], "label": {"en": discovered_tv["label"]}}
-
-        dropdown_items.append(tv_data)
+    address = msg.input_values["address"]
+
+    if address:
+        _LOG.debug("Starting manual driver setup for %s", address)
+        # Connect to device and retrieve name
+        android_tv = tv.AndroidTv(config.devices.data_path, address, "")
+        res = await android_tv.init(20)
+        if res is False:
+            return SetupError(error_type=IntegrationSetupError.TIMEOUT)
+        dropdown_items.append({"id": address, "label": {"en": f"{android_tv.name} [{address}]"}})
+    else:
+        _LOG.debug("Starting driver setup with Android TV discovery")
+        # start discovery
+        _discovered_android_tvs = await discover.android_tvs()
+
+        for discovered_tv in _discovered_android_tvs:
+            tv_data = {"id": discovered_tv["address"], "label": {"en": discovered_tv["label"]}}
+
+            dropdown_items.append(tv_data)
 
     if not dropdown_items:
         _LOG.warning("No Android TVs found")
@@ -126,7 +174,7 @@ async def handle_driver_setup(_msg: DriverSetupRequest) -> RequestUserInput | Se
     )
 
 
-async def handle_user_data_choice(msg: UserDataResponse) -> RequestUserInput | SetupError:
+async def handle_device_choice(msg: UserDataResponse) -> RequestUserInput | SetupError:
     """
     Process user data device choice response in a setup process.
 

intg-androidtv/tv.py

@@ -318,6 +318,7 @@ async def _handle_connection_failure(self, connect_duration: float, ex):
 
     def disconnect(self) -> None:
         """Disconnect from Android TV."""
+        self._reconnect_delay = MIN_RECONNECT_DELAY
         self._atv.disconnect()
         self.events.emit(Events.DISCONNECTED, self._identifier)