androidtvremote2 0.3.1__tar.gz → 0.3.3__tar.gz

{androidtvremote2-0.3.1/src/androidtvremote2.egg-info → androidtvremote2-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: androidtvremote2
-Version: 0.3.1
+Version: 0.3.3
 Summary: A Python library for interacting with Android TV using the Android TV Remote protocol v2
 Author-email: tronikos <tronikos@gmail.com>
 License-Expression: Apache-2.0
@@ -14,6 +14,7 @@ Requires-Dist: cryptography>=3
 Requires-Dist: protobuf>=4.21
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
 Provides-Extra: demo
 Requires-Dist: pyaudio; extra == "demo"
 Requires-Dist: pynput; extra == "demo"
@@ -25,7 +26,7 @@ Dynamic: license-file
 A Python library for interacting with Android TV using the Android TV Remote protocol v2. This is the same protocol the Google TV mobile app is using. It doesn't require ADB or enabling developer tools on the Android TV device. It only requires the [Android TV Remote Service](https://play.google.com/store/apps/details?id=com.google.android.tv.remote.service) that comes pre-installed on most Android TV devices.
 
 For a list of the most common commands you can send to the Android TV see: [TvKeys](https://github.com/tronikos/androidtvremote2/blob/main/TvKeys.txt).
-For a full list see [remotemessage.proto](https://github.com/tronikos/androidtvremote2/blob/b4c49ac03043b1b9c40c2f2960e466d5a3b8bd67/src/androidtvremote2/remotemessage.proto#L90).
+For a full list see [remotemessage.proto](https://github.com/tronikos/androidtvremote2/blob/main/src/androidtvremote2/remotemessage.proto).
 In addition to commands you can send URLs to open apps registered to handle them. See [this guide](https://community.home-assistant.io/t/android-tv-remote-app-links-deep-linking-guide/567921) for how to find deep links for apps.
 
 Voice commands can also be sent as PCM 16-bit mono 8 kHz audio data.

{androidtvremote2-0.3.1 → androidtvremote2-0.3.3}/README.md

@@ -3,7 +3,7 @@
 A Python library for interacting with Android TV using the Android TV Remote protocol v2. This is the same protocol the Google TV mobile app is using. It doesn't require ADB or enabling developer tools on the Android TV device. It only requires the [Android TV Remote Service](https://play.google.com/store/apps/details?id=com.google.android.tv.remote.service) that comes pre-installed on most Android TV devices.
 
 For a list of the most common commands you can send to the Android TV see: [TvKeys](https://github.com/tronikos/androidtvremote2/blob/main/TvKeys.txt).
-For a full list see [remotemessage.proto](https://github.com/tronikos/androidtvremote2/blob/b4c49ac03043b1b9c40c2f2960e466d5a3b8bd67/src/androidtvremote2/remotemessage.proto#L90).
+For a full list see [remotemessage.proto](https://github.com/tronikos/androidtvremote2/blob/main/src/androidtvremote2/remotemessage.proto).
 In addition to commands you can send URLs to open apps registered to handle them. See [this guide](https://community.home-assistant.io/t/android-tv-remote-app-links-deep-linking-guide/567921) for how to find deep links for apps.
 
 Voice commands can also be sent as PCM 16-bit mono 8 kHz audio data.

{androidtvremote2-0.3.1 → androidtvremote2-0.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "androidtvremote2"
-version = "0.3.1"
+version = "0.3.3"
 license = "Apache-2.0"
 authors = [
     { name="tronikos", email="tronikos@gmail.com" },
@@ -17,6 +17,7 @@ dependencies = [
 [project.optional-dependencies]
 test = [
     "pytest",
+    "pytest-asyncio",
 ]
 demo = [
     "pyaudio",
@@ -33,6 +34,15 @@ demo = [
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
+# Explicit discovery. Without it setuptools also picks up src/demo.py and installs it
+# as a top level "demo" module.
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
 [tool.ruff]
 target-version = "py310"
 line-length = 127
@@ -70,6 +80,7 @@ ignore = [
     "D203",  # 1 blank line required before class docstring
     "D213",  # Multi-line docstring summary should start at the second line
     "PLR0913",  # Too many arguments in function definition
+    "PLR0917",  # Too many positional arguments in function definition
     "PLR1714",  # Consider merging multiple comparisons
     "PLR2004",  # Magic value used in comparison
     "TRY003",  # Avoid specifying long messages outside the exception class

{androidtvremote2-0.3.1 → androidtvremote2-0.3.3}/src/androidtvremote2/__init__.py

@@ -1,7 +1,7 @@
 """Library implementing the Android TV Remote protocol."""
 
 from .androidtv_remote import AndroidTVRemote
-from .exceptions import CannotConnect, ConnectionClosed, InvalidAuth
+from .exceptions import CannotConnect, ConnectionClosed, InvalidAuth, VoiceSessionInProgress
 from .model import DeviceInfo, VolumeInfo
 from .voice_stream import VoiceStream
 
@@ -11,6 +11,7 @@ __all__ = [
     "ConnectionClosed",
     "DeviceInfo",
     "InvalidAuth",
+    "VoiceSessionInProgress",
     "VoiceStream",
     "VolumeInfo",
 ]

{androidtvremote2-0.3.1 → androidtvremote2-0.3.3}/src/androidtvremote2/androidtv_remote.py

@@ -25,6 +25,31 @@ if TYPE_CHECKING:
     from .model import DeviceInfo, VolumeInfo
 
 
+def _parse_name_and_mac(server_cert: x509.Certificate) -> tuple[str, str]:
+    """Extract the name and MAC address from the subject of an Android TV certificate.
+
+    NVIDIA SHIELD example:
+    CN=atvremote/darcy/darcy/SHIELD Android TV/XX:XX:XX:XX:XX:XX
+    Nexus Player example:
+    dnQualifier=fugu/fugu/Nexus Player/CN=atvremote/XX:XX:XX:XX:XX:XX
+    """
+    common_name = server_cert.subject.get_attributes_for_oid(x509.OID_COMMON_NAME)
+    common_name_str = str(common_name[0].value) if common_name else ""
+    dn_qualifier = server_cert.subject.get_attributes_for_oid(x509.OID_DN_QUALIFIER)
+    dn_qualifier_str = str(dn_qualifier[0].value) if dn_qualifier else ""
+    common_name_parts = common_name_str.split("/")
+    dn_qualifier_parts = dn_qualifier_str.split("/")
+    if dn_qualifier_str:
+        name = dn_qualifier_parts[-1]
+    elif len(common_name_parts) > 1:
+        name = common_name_parts[-2]
+    else:
+        # Unexpected subject, e.g. a common name without any "/" separator.
+        name = common_name_str
+    mac = common_name_parts[-1]
+    return name, mac
+
+
 def _load_cert_chain(certfile: str, keyfile: str) -> ssl.SSLContext:
     ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
     ssl_context.check_hostname = False
@@ -52,7 +77,7 @@ class AndroidTVRemote:
 
         :param client_name: client name. Will be shown on the Android TV during pairing.
         :param certfile: filename that contains the client certificate in PEM format.
-        :param keyfile: filename that contains the public key in PEM format.
+        :param keyfile: filename that contains the private key in PEM format.
         :param host: IP address of the Android TV.
         :param api_port: port for connecting and sending commands.
         :param pair_port: port for pairing.
@@ -185,7 +210,7 @@ class AndroidTVRemote:
         self._is_available_updated_callbacks.remove(callback)
 
     async def async_generate_cert_if_missing(self) -> bool:
-        """Generate client certificate and public key if missing.
+        """Generate client certificate and private key if missing.
 
         :returns: True if a new certificate was generated.
         """
@@ -196,6 +221,8 @@ class AndroidTVRemote:
             await out.write(cert_pem.decode("utf-8"))
         async with aiofiles.open(self._keyfile, "w", encoding="utf-8") as out:
             await out.write(key_pem.decode("utf-8"))
+        # The cached context, if any, was loaded from the previous certificate.
+        self._ssl_context = None
         return True
 
     async def _create_ssl_context(self) -> ssl.SSLContext:
@@ -217,6 +244,8 @@ class AndroidTVRemote:
         :raises InvalidAuth: if pairing is needed first.
         """
         ssl_context = await self._create_ssl_context()
+        if self._remote_message_protocol:
+            self._remote_message_protocol.close()
         on_con_lost = self._loop.create_future()
         on_remote_started = self._loop.create_future()
         try:
@@ -244,8 +273,13 @@ class AndroidTVRemote:
                 raise InvalidAuth("Need to pair") from exc
             raise CannotConnect(f"Couldn't connect to {self.host}:{self._api_port}") from exc
 
-        await asyncio.wait((on_con_lost, on_remote_started), return_when=asyncio.FIRST_COMPLETED)
+        try:
+            await asyncio.wait((on_con_lost, on_remote_started), return_when=asyncio.FIRST_COMPLETED)
+        except BaseException:
+            self._remote_message_protocol.close()
+            raise
         if on_con_lost.done():
+            self._remote_message_protocol.close()
             con_lost_exc = on_con_lost.result()
             LOGGER.debug(
                 "Couldn't connect to %s:%s. Error: %s",
@@ -290,15 +324,17 @@ class AndroidTVRemote:
 
     def keep_reconnecting(self, invalid_auth_callback: Callable[[], None] | None = None) -> None:
         """Create a task to keep reconnecting whenever connection is lost."""
+        if self._reconnect_task:
+            self._reconnect_task.cancel()
         self._reconnect_task = self._loop.create_task(self._async_reconnect(invalid_auth_callback))
 
     def disconnect(self) -> None:
         """Disconnect any open connections."""
         if self._reconnect_task:
             self._reconnect_task.cancel()
+            self._reconnect_task = None
         if self._remote_message_protocol:
-            if self._remote_message_protocol.transport:
-                self._remote_message_protocol.transport.close()
+            self._remote_message_protocol.close()
             self._remote_message_protocol = None
         if self._pairing_message_protocol:
             if self._pairing_message_protocol.transport:
@@ -318,20 +354,11 @@ class AndroidTVRemote:
             raise CannotConnect from exc
         server_cert_bytes = writer.transport.get_extra_info("ssl_object").getpeercert(True)
         writer.close()
-        server_cert = x509.load_der_x509_certificate(server_cert_bytes)
-        # NVIDIA SHIELD example:
-        # CN=atvremote/darcy/darcy/SHIELD Android TV/XX:XX:XX:XX:XX:XX
-        # Nexus Player example:
-        # dnQualifier=fugu/fugu/Nexus Player/CN=atvremote/XX:XX:XX:XX:XX:XX
-        common_name = server_cert.subject.get_attributes_for_oid(x509.OID_COMMON_NAME)
-        common_name_str = str(common_name[0].value) if common_name else ""
-        dn_qualifier = server_cert.subject.get_attributes_for_oid(x509.OID_DN_QUALIFIER)
-        dn_qualifier_str = str(dn_qualifier[0].value) if dn_qualifier else ""
-        common_name_parts = common_name_str.split("/")
-        dn_qualifier_parts = dn_qualifier_str.split("/")
-        name = dn_qualifier_parts[-1] if dn_qualifier_str else common_name_parts[-2]
-        mac = common_name_parts[-1]
-        return name, mac
+        try:
+            await writer.wait_closed()
+        except OSError as exc:
+            LOGGER.debug("Error closing connection to %s:%s. %s", self.host, self._pair_port, exc)
+        return _parse_name_and_mac(x509.load_der_x509_certificate(server_cert_bytes))
 
     async def async_start_pairing(self) -> None:
         """Start the pairing process.
@@ -426,8 +453,8 @@ class AndroidTVRemote:
 
         :param timeout: optional timeout for session readiness. Defaults to 2 seconds.
         :raises ConnectionClosed: if client is disconnected.
-        :raises asyncio.TimeoutError: if the device does not begin voice in time, or a voice
-                                      session is already in progress.
+        :raises VoiceSessionInProgress: if a voice session is already in progress.
+        :raises asyncio.TimeoutError: if the device does not begin voice in time.
         """
         if not self._remote_message_protocol:
             LOGGER.debug("Called start_voice after disconnect")

{androidtvremote2-0.3.1 → androidtvremote2-0.3.3}/src/androidtvremote2/base.py

@@ -8,6 +8,7 @@ from typing import TYPE_CHECKING, cast
 from google.protobuf import text_format
 from google.protobuf.internal.decoder import _DecodeVarint  # type: ignore[attr-defined]
 from google.protobuf.internal.encoder import _EncodeVarint  # type: ignore[attr-defined]
+from google.protobuf.message import DecodeError
 
 from .const import LOGGER
 
@@ -25,8 +26,7 @@ class ProtobufProtocol(asyncio.Protocol):
         """
         self.on_con_lost = on_con_lost
         self.transport: asyncio.Transport | None = None
-        self._raw_msg_len = -1
-        self._raw_msg = b""
+        self._buffer = bytearray()
 
     def connection_made(self, transport: asyncio.BaseTransport) -> None:
         """Store transport when a connection is made."""
@@ -40,27 +40,37 @@ class ProtobufProtocol(asyncio.Protocol):
             self.on_con_lost.set_result(exc)
 
     def data_received(self, data: bytes) -> None:
-        """Receive data until a full protobuf is received and pass it to _handle_message."""
+        """Buffer data and pass every complete protobuf message to _handle_message.
+
+        Messages are length delimited by a varint. A single call may deliver a partial
+        message, several messages, or anything in between, and the split can happen
+        anywhere, including in the middle of the varint.
+        """
         if not data:
             LOGGER.debug("No data received")
             return
-        if self._raw_msg_len < 0:
-            self._raw_msg_len, pos = _DecodeVarint(data, 0)
-            pos_end = pos + self._raw_msg_len
-            self._raw_msg += data[pos:pos_end]
-            remaining_data = data[pos_end:]
-        else:
-            pos_end = self._raw_msg_len - len(self._raw_msg)
-            self._raw_msg += data[:pos_end]
-            remaining_data = data[pos_end:]
-        if self._raw_msg_len == len(self._raw_msg):
-            raw_msg = self._raw_msg
-            self._raw_msg_len = -1
-            self._raw_msg = b""
+        self._buffer += data
+        while self._buffer:
+            try:
+                msg_len, pos = _DecodeVarint(self._buffer, 0)
+            except IndexError:
+                # The varint with the message length was not fully received yet.
+                return
+            except DecodeError as exc:
+                # The stream cannot be resynchronized after a corrupt length.
+                LOGGER.debug("Couldn't decode the message length. %s", exc)
+                self._buffer.clear()
+                if self.transport and not self.transport.is_closing():
+                    self.transport.close()
+                return
+            pos_end = pos + msg_len
+            if len(self._buffer) < pos_end:
+                # The message was not fully received yet.
+                return
+            raw_msg = bytes(self._buffer[pos:pos_end])
+            del self._buffer[:pos_end]
             # LOGGER.debug("Received: %s", raw_msg)
             self._handle_message(raw_msg)
-            if remaining_data:
-                self.data_received(remaining_data)
 
     def _handle_message(self, raw_msg: bytes) -> None:
         """Handle a message from the server. Message needs to be parsed to the appropriate protobuf."""

{androidtvremote2-0.3.1 → androidtvremote2-0.3.3}/src/androidtvremote2/certificate_generator.py

@@ -6,7 +6,7 @@
 
 from __future__ import annotations
 
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 
 from cryptography import x509
 from cryptography.hazmat.backends import default_backend
@@ -18,7 +18,7 @@ from cryptography.x509.oid import NameOID
 def generate_selfsigned_cert(hostname: str) -> tuple[bytes, bytes]:
     """Generate self signed certificate for a hostname.
 
-    :return: self signed certificate and public key in PEM format
+    :return: self signed certificate and private key in PEM format
     """
     key = rsa.generate_private_key(
         public_exponent=65537,
@@ -29,7 +29,7 @@ def generate_selfsigned_cert(hostname: str) -> tuple[bytes, bytes]:
     alt_names = [x509.DNSName(hostname)]
     san = x509.SubjectAlternativeName(alt_names)
     basic_constraints = x509.BasicConstraints(ca=True, path_length=0)
-    now = datetime.utcnow()
+    now = datetime.now(timezone.utc)
     cert = (
         x509.CertificateBuilder()
         .subject_name(name)

{androidtvremote2-0.3.1 → androidtvremote2-0.3.3}/src/androidtvremote2/exceptions.py

@@ -11,3 +11,7 @@ class ConnectionClosed(Exception):
 
 class InvalidAuth(Exception):
     """Error to indicate there is invalid auth."""
+
+
+class VoiceSessionInProgress(Exception):
+    """Error to indicate a voice session is already in progress."""

{androidtvremote2-0.3.1 → androidtvremote2-0.3.3}/src/androidtvremote2/model.py

@@ -1,21 +1,21 @@
-"""Data models for AndroidTVRemote."""
-
-from __future__ import annotations
-
-from typing import TypedDict
-
-
-class DeviceInfo(TypedDict):
-    """A TypedDict for device information."""
-
-    manufacturer: str
-    model: str
-    sw_version: str
-
-
-class VolumeInfo(TypedDict):
-    """A TypedDict for volume information."""
-
-    level: int
-    max: int
-    muted: bool
+"""Data models for AndroidTVRemote."""
+
+from __future__ import annotations
+
+from typing import TypedDict
+
+
+class DeviceInfo(TypedDict):
+    """A TypedDict for device information."""
+
+    manufacturer: str
+    model: str
+    sw_version: str
+
+
+class VolumeInfo(TypedDict):
+    """A TypedDict for volume information."""
+
+    level: int
+    max: int
+    muted: bool

{androidtvremote2-0.3.1 → androidtvremote2-0.3.3}/src/androidtvremote2/pairing.py

@@ -21,6 +21,10 @@ from .const import LOGGER
 from .exceptions import ConnectionClosed, InvalidAuth
 from .polo_pb2 import Options, OuterMessage
 
+# Timeout in seconds to wait for a response from the Android TV. Every step of the
+# pairing handshake is answered by the device itself, so this doesn't wait on a human.
+PAIRING_TIMEOUT = 10.0
+
 
 def _create_message() -> OuterMessage:
     """Create an OuterMessage with default values."""
@@ -30,6 +34,11 @@ def _create_message() -> OuterMessage:
     return msg
 
 
+def _int_to_bytes(val: int) -> bytes:
+    """Convert a positive integer to big-endian bytes."""
+    return val.to_bytes((val.bit_length() + 7) // 8, "big")
+
+
 def _get_modulus_and_exponent(cert: x509.Certificate) -> tuple[int, int]:
     """Extract modulus and exponent from a certificate."""
     public_numbers = cert.public_key().public_numbers()  # type: ignore[union-attr]
@@ -69,7 +78,7 @@ class PairingProtocol(ProtobufProtocol):
     async def async_start_pairing(self) -> None:
         """Start the pairing process.
 
-        :raises ConnectionClosed: if connection was lost.
+        :raises ConnectionClosed: if connection was lost or the device didn't respond in time.
         """
         self._raise_if_not_connected()
         msg = _create_message()
@@ -86,7 +95,7 @@ class PairingProtocol(ProtobufProtocol):
         """Finish the pairing process.
 
         :param pairing_code: pairing code shown on the Android TV.
-        :raises ConnectionClosed: if connection was lost.
+        :raises ConnectionClosed: if connection was lost or the device didn't respond in time.
         :raises InvalidAuth: if pairing was unsuccessful.
         """
         self._raise_if_not_connected()
@@ -109,10 +118,10 @@ class PairingProtocol(ProtobufProtocol):
         server_modulus, server_exponent = _get_modulus_and_exponent(server_cert)
 
         h = hashlib.sha256()
-        h.update(bytes.fromhex(f"{client_modulus:X}"))
-        h.update(bytes.fromhex(f"0{client_exponent:X}"))
-        h.update(bytes.fromhex(f"{server_modulus:X}"))
-        h.update(bytes.fromhex(f"0{server_exponent:X}"))
+        h.update(_int_to_bytes(client_modulus))
+        h.update(_int_to_bytes(client_exponent))
+        h.update(_int_to_bytes(server_modulus))
+        h.update(_int_to_bytes(server_exponent))
         h.update(bytes.fromhex(pairing_code[2:]))
         hash_result = h.digest()
 
@@ -129,9 +138,18 @@ class PairingProtocol(ProtobufProtocol):
         finally:
             self._on_pairing_finished = None
 
-    async def _async_wait_for_future_or_con_lost(self, future: asyncio.Future[Any]) -> None:
-        """Wait for future to finish or connection to be lost."""
-        await asyncio.wait((self.on_con_lost, future), return_when=asyncio.FIRST_COMPLETED)
+    async def _async_wait_for_future_or_con_lost(self, future: asyncio.Future[Any], timeout: float = PAIRING_TIMEOUT) -> None:
+        """Wait for future to finish, connection to be lost, or timeout to elapse.
+
+        :raises ConnectionClosed: if the connection was lost or the device stopped responding.
+        """
+        done, _pending = await asyncio.wait((self.on_con_lost, future), timeout=timeout, return_when=asyncio.FIRST_COMPLETED)
+        if not done:
+            LOGGER.debug("Timeout after %s seconds waiting for a response while pairing", timeout)
+            future.cancel()
+            if self.transport:
+                self.transport.close()
+            raise ConnectionClosed(f"No response from the Android TV within {timeout} seconds")
         if future.done():
             if future.exception():
                 raise ConnectionClosed(future.exception())
@@ -177,11 +195,11 @@ class PairingProtocol(ProtobufProtocol):
             new_msg.configuration.encoding.type = Options.Encoding.ENCODING_TYPE_HEXADECIMAL
             new_msg.configuration.encoding.symbol_length = 6
         elif msg.HasField("configuration_ack"):
-            if self._on_pairing_started:
+            if self._on_pairing_started and not self._on_pairing_started.done():
                 self._on_pairing_started.set_result(True)
             return
         elif msg.HasField("secret_ack"):
-            if self._on_pairing_finished:
+            if self._on_pairing_finished and not self._on_pairing_finished.done():
                 self._on_pairing_finished.set_result(True)
             return
         else: