androidtvremote2 0.3.2__tar.gz → 0.3.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: androidtvremote2
-Version: 0.3.2
+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
@@ -26,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.2 → 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.2 → androidtvremote2-0.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "androidtvremote2"
-version = "0.3.2"
+version = "0.3.3"
 license = "Apache-2.0"
 authors = [
     { name="tronikos", email="tronikos@gmail.com" },

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

@@ -77,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.
@@ -210,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.
         """
@@ -244,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:
@@ -271,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",
@@ -317,12 +324,15 @@ 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:
             self._remote_message_protocol.close()
             self._remote_message_protocol = None

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

@@ -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,

{androidtvremote2-0.3.2 → 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.2 → androidtvremote2-0.3.3}/src/androidtvremote2/pairing.py

@@ -34,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]
@@ -113,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()
 

{androidtvremote2-0.3.2 → androidtvremote2-0.3.3}/src/androidtvremote2/remote.py

@@ -112,6 +112,8 @@ class RemoteProtocol(ProtobufProtocol):
         self.volume_info: VolumeInfo | None = None
         self.ime_counter: int = 0
         self.ime_field_counter: int = 0
+        self._has_ime_counter = False
+        self._has_ime_field_counter = False
         self._loop = loop
         self._idle_disconnect_task: asyncio.Task[None] | None = None
         self._reset_idle_disconnect_task()
@@ -170,9 +172,10 @@ class RemoteProtocol(ProtobufProtocol):
     def send_text(self, text: str) -> None:
         """Send a text string to Android TV via the input method.
 
-        The text length minus one is used for both `start` and `end` in the RemoteImeObject.
-        The `ime_counter` and `ime_field_counter` values are taken from self (batch_edit_info response),
-        which is populated when a message with a remote_ime_batch_edit field is received.
+        The text is inserted at the cursor, which is left after it: `start` and `end` are the text's length.
+        `ime_counter` and `ime_field_counter` come from the focused field's status (`remote_ime_key_inject`
+        and `remote_ime_show_request`), falling back to `remote_ime_batch_edit` when the key inject carries
+        no counter.
 
         :param text: The text string to be sent.
         """
@@ -181,8 +184,7 @@ class RemoteProtocol(ProtobufProtocol):
 
         self._reset_idle_disconnect_task()
         msg = RemoteMessage()
-        param_value = len(text) - 1
-        ime_object = RemoteImeObject(start=param_value, end=param_value, value=text)
+        ime_object = RemoteImeObject(start=len(text), end=len(text), value=text)
         edit_info = RemoteEditInfo(insert=1, text_field_status=ime_object)
         batch_edit = RemoteImeBatchEdit(
             ime_counter=self.ime_counter,
@@ -311,11 +313,22 @@ class RemoteProtocol(ProtobufProtocol):
         elif msg.HasField("remote_set_active"):
             new_msg.remote_set_active.active = self._active_features
         elif msg.HasField("remote_ime_key_inject"):
-            self.current_app = msg.remote_ime_key_inject.app_info.app_package
+            inject = msg.remote_ime_key_inject
+            self.current_app = inject.app_info.app_package
             self._on_current_app_updated(self.current_app)
+            self.ime_counter = inject.app_info.counter
+            self.ime_field_counter = inject.text_field_status.counter_field
+            self._has_ime_counter = bool(self.ime_counter)
+            self._has_ime_field_counter = bool(self.ime_field_counter)
+        elif msg.HasField("remote_ime_show_request"):
+            if msg.remote_ime_show_request.HasField("remote_text_field_status"):
+                self.ime_field_counter = msg.remote_ime_show_request.remote_text_field_status.counter_field
+                self._has_ime_field_counter = True
         elif msg.HasField("remote_ime_batch_edit"):
-            self.ime_counter = msg.remote_ime_batch_edit.ime_counter
-            self.ime_field_counter = msg.remote_ime_batch_edit.field_counter
+            if not self._has_ime_counter:
+                self.ime_counter = msg.remote_ime_batch_edit.ime_counter
+            if not self._has_ime_field_counter:
+                self.ime_field_counter = msg.remote_ime_batch_edit.field_counter
         elif msg.HasField("remote_set_volume_level"):
             self.volume_info = {
                 "level": msg.remote_set_volume_level.volume_level,

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: androidtvremote2
-Version: 0.3.2
+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
@@ -26,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.2 → androidtvremote2-0.3.3}/tests/test_androidtv_remote.py

@@ -17,6 +17,8 @@ from androidtvremote2.exceptions import ConnectionClosed, InvalidAuth
 from androidtvremote2.remote import VOICE_CHUNK_MIN_SIZE
 from androidtvremote2.remotemessage_pb2 import RemoteDirection, RemoteKeyCode, RemoteMessage
 
+from .conftest import FakeTransport, parse_written
+
 if TYPE_CHECKING:
     from collections.abc import Callable
     from pathlib import Path
@@ -232,6 +234,58 @@ async def test_disconnect_cancels_the_reconnect_task(remote: AndroidTVRemote, co
     await asyncio.sleep(0)
 
     assert reconnect_task.cancelled() or reconnect_task.done()
+    assert remote._reconnect_task is None
+
+
+async def test_keep_reconnecting_cancels_previous_reconnect_task(remote: AndroidTVRemote, connected: RemoteHarness) -> None:
+    """Calling keep_reconnecting() twice cancels the previous reconnect task."""
+    remote.keep_reconnecting()
+    first_task = remote._reconnect_task
+    assert first_task is not None
+
+    remote.keep_reconnecting()
+    second_task = remote._reconnect_task
+    await asyncio.sleep(0)
+
+    assert first_task.cancelled()
+    assert second_task is not None
+    assert not second_task.done()
+    remote.disconnect()
+
+
+async def test_cancelling_async_connect_closes_protocol_and_idle_task(
+    remote: AndroidTVRemote, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    """Cancelling async_connect while waiting for remote_start closes the transport and idle timer."""
+    await remote.async_generate_cert_if_missing()
+    fake_transport = FakeTransport()
+    connected_event = asyncio.Event()
+
+    async def fake_create_connection(
+        protocol_factory: Callable[[], object], *_args: object, **_kwargs: object
+    ) -> tuple[object, object]:
+        proto = protocol_factory()
+        proto.connection_made(fake_transport)  # type: ignore[attr-defined]
+        connected_event.set()
+        return fake_transport, proto
+
+    monkeypatch.setattr(remote._loop, "create_connection", fake_create_connection)
+
+    connect_task = asyncio.create_task(remote.async_connect())
+    await connected_event.wait()
+    await asyncio.sleep(0)
+
+    assert remote._remote_message_protocol is not None
+    idle_task = remote._remote_message_protocol._idle_disconnect_task
+    assert idle_task is not None
+
+    connect_task.cancel()
+    with pytest.raises(asyncio.CancelledError):
+        await connect_task
+
+    assert fake_transport.is_closing()
+    assert idle_task.cancelled()
+    assert parse_written(fake_transport.written, RemoteMessage) == []
 
 
 async def test_disconnect_is_idempotent(remote: AndroidTVRemote, connected: RemoteHarness) -> None:

{androidtvremote2-0.3.2 → androidtvremote2-0.3.3}/tests/test_pairing.py

@@ -74,10 +74,8 @@ def expected_pin(client_cert_pem: bytes, server_cert_pem: bytes, nonce: str) ->
     client_n, client_e = modulus_and_exponent(client_cert_pem)
     server_n, server_e = modulus_and_exponent(server_cert_pem)
     h = hashlib.sha256()
-    h.update(bytes.fromhex(f"{client_n:X}"))
-    h.update(bytes.fromhex(f"0{client_e:X}"))
-    h.update(bytes.fromhex(f"{server_n:X}"))
-    h.update(bytes.fromhex(f"0{server_e:X}"))
+    for val in (client_n, client_e, server_n, server_e):
+        h.update(val.to_bytes((val.bit_length() + 7) // 8, "big"))
     h.update(bytes.fromhex(nonce))
     return f"{h.digest()[0]:02X}{nonce}"
 
@@ -147,6 +145,29 @@ async def test_finish_pairing_sends_the_secret(
     assert secret.secret.secret[0] == int(pin[0:2], 16)
 
 
+async def test_finish_pairing_handles_odd_hex_length_modulus_and_even_hex_exponent(
+    pairing: PairingHarness, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    """Moduli with an odd number of hex digits or 2-nibble exponents don't fail bytes conversion."""
+    await run_start_pairing(pairing)
+    pairing.clear()
+    # 0xabc has 3 hex digits (odd); 0x11 (17) has 2 hex digits (would be 3 with a leading '0').
+    monkeypatch.setattr("androidtvremote2.pairing._get_modulus_and_exponent", lambda _cert: (0xABC, 0x11))
+    h = hashlib.sha256()
+    for val in (0xABC, 0x11, 0xABC, 0x11):
+        h.update(val.to_bytes((val.bit_length() + 7) // 8, "big"))
+    h.update(bytes.fromhex("ABCD"))
+    pin = f"{h.digest()[0]:02X}ABCD"
+
+    task = asyncio.ensure_future(pairing.protocol.async_finish_pairing(pin))
+    await wait_until_sent(pairing, 1)
+    pairing.receive(device_msg("secret_ack", secret=b"\x00" * 32))
+    await task
+
+    (secret,) = pairing.sent()
+    assert secret.secret.secret == h.digest()
+
+
 async def test_duplicate_acks_do_not_raise(pairing: PairingHarness) -> None:
     """A repeated acknowledgement doesn't blow up inside data_received.
 

{androidtvremote2-0.3.2 → androidtvremote2-0.3.3}/tests/test_remote.py

@@ -167,22 +167,65 @@ async def test_volume_level_updates_volume_info(remote_factory: Callable[..., Re
     assert harness.volume_info_updates == [{"level": 12, "max": 100, "muted": True}]
 
 
-async def test_ime_batch_edit_updates_the_counters_used_by_send_text(
+async def test_send_text_uses_the_focused_fields_counters(
     remote_factory: Callable[..., RemoteHarness],
 ) -> None:
-    """The counters echoed back in send_text come from the device."""
+    """ime_counter and ime_field_counter come from remote_ime_key_inject, not overwritten by batch_edit."""
     harness = remote_factory()
-    msg = RemoteMessage()
-    msg.remote_ime_batch_edit.ime_counter = 9
-    msg.remote_ime_batch_edit.field_counter = 4
-    harness.receive(msg)
+    inject = RemoteMessage()
+    inject.remote_ime_key_inject.app_info.app_package = "org.jellyfin.androidtv"
+    inject.remote_ime_key_inject.app_info.counter = 5
+    inject.remote_ime_key_inject.text_field_status.counter_field = 141
+    harness.receive(inject)
+    batch = RemoteMessage()
+    batch.remote_ime_batch_edit.ime_counter = 1
+    batch.remote_ime_batch_edit.field_counter = 1
+    harness.receive(batch)
 
-    assert (harness.protocol.ime_counter, harness.protocol.ime_field_counter) == (9, 4)
+    assert (harness.protocol.ime_counter, harness.protocol.ime_field_counter) == (5, 141)
 
     harness.protocol.send_text("hi")
     (sent,) = harness.sent()
-    assert sent.remote_ime_batch_edit.ime_counter == 9
-    assert sent.remote_ime_batch_edit.field_counter == 4
+    assert sent.remote_ime_batch_edit.ime_counter == 5
+    assert sent.remote_ime_batch_edit.field_counter == 141
+
+
+async def test_ime_show_request_updates_the_field_counter(
+    remote_factory: Callable[..., RemoteHarness],
+) -> None:
+    """A focused field announces updated counter_field in remote_ime_show_request."""
+    harness = remote_factory()
+    msg = RemoteMessage()
+    msg.remote_ime_show_request.remote_text_field_status.counter_field = 7
+    harness.receive(msg)
+
+    assert harness.protocol.ime_field_counter == 7
+
+
+async def test_ime_batch_edit_is_used_when_key_inject_has_no_counters(
+    remote_factory: Callable[..., RemoteHarness],
+) -> None:
+    """When key_inject carries zero counters, batch_edit counters are used and stale counters are cleared."""
+    harness = remote_factory()
+    inject = RemoteMessage()
+    inject.remote_ime_key_inject.app_info.app_package = "com.android.vending"
+    inject.remote_ime_key_inject.app_info.counter = 3
+    inject.remote_ime_key_inject.text_field_status.counter_field = 38
+    harness.receive(inject)
+    assert (harness.protocol.ime_counter, harness.protocol.ime_field_counter) == (3, 38)
+
+    # Switching to an app that reports 0 counters clears the previous app's counters.
+    youtube = RemoteMessage()
+    youtube.remote_ime_key_inject.app_info.app_package = "com.google.android.youtube.tv"
+    harness.receive(youtube)
+    assert (harness.protocol.ime_counter, harness.protocol.ime_field_counter) == (0, 0)
+
+    # A subsequent batch_edit populates the counters as fallback.
+    batch = RemoteMessage()
+    batch.remote_ime_batch_edit.ime_counter = 9
+    batch.remote_ime_batch_edit.field_counter = 4
+    harness.receive(batch)
+    assert (harness.protocol.ime_counter, harness.protocol.ime_field_counter) == (9, 4)
 
 
 async def test_remote_error_is_logged_as_an_error(
@@ -206,7 +249,7 @@ async def test_unhandled_message_is_logged_and_ignored(
     """A message this library has no branch for doesn't produce a reply."""
     harness = remote_factory()
     msg = RemoteMessage()
-    msg.remote_ime_show_request.SetInParent()
+    msg.remote_app_link_launch_request.app_link = "https://example.com"
     with caplog.at_level(logging.DEBUG, logger="androidtvremote2"):
         harness.receive(msg)
 
@@ -283,7 +326,7 @@ async def test_send_key_command_dispatches_the_text_prefix(remote_factory: Calla
 
 
 async def test_send_text_builds_the_batch_edit(remote_factory: Callable[..., RemoteHarness]) -> None:
-    """send_text uses len(text) - 1 for start and end, as the device expects."""
+    """send_text puts the cursor after the text: start and end are its length."""
     harness = remote_factory()
     harness.protocol.send_text("abcd")
 
@@ -291,8 +334,8 @@ async def test_send_text_builds_the_batch_edit(remote_factory: Callable[..., Rem
     edit = sent.remote_ime_batch_edit.edit_info[0]
     assert edit.insert == 1
     assert edit.text_field_status.value == "abcd"
-    assert edit.text_field_status.start == 3
-    assert edit.text_field_status.end == 3
+    assert edit.text_field_status.start == 4
+    assert edit.text_field_status.end == 4
 
 
 async def test_send_text_rejects_empty_text(remote_factory: Callable[..., RemoteHarness]) -> None: