androidtvremote2 0.2.1__tar.gz → 0.2.3__tar.gz

{androidtvremote2-0.2.1/src/androidtvremote2.egg-info → androidtvremote2-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: androidtvremote2
-Version: 0.2.1
+Version: 0.2.3
 Summary: A Python library for interacting with Android TV using the Android TV Remote protocol v2
 Author-email: tronikos <tronikos@gmail.com>
 License: Apache-2.0
@@ -19,7 +19,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 [here](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/b4c49ac03043b1b9c40c2f2960e466d5a3b8bd67/src/androidtvremote2/remotemessage.proto#L90).
 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.
 
 ## Credits

{androidtvremote2-0.2.1 → androidtvremote2-0.2.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 [here](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/b4c49ac03043b1b9c40c2f2960e466d5a3b8bd67/src/androidtvremote2/remotemessage.proto#L90).
 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.
 
 ## Credits

{androidtvremote2-0.2.1 → androidtvremote2-0.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "androidtvremote2"
-version = "0.2.1"
+version = "0.2.3"
 license = {text = "Apache-2.0"}
 authors = [
     { name="tronikos", email="tronikos@gmail.com" },
@@ -32,12 +32,11 @@ combine_as_imports = true
 extend_skip_glob = ["*_pb2.py", "*_pb2_grpc.py"]
 
 [tool.ruff]
-target-version = "py311"
+target-version = "py310"
 exclude = ["*_pb2.py", "*_pb2_grpc.py", "*.pyi"]
 line-length = 127
 
-[tool.ruff.lint]
-select = [
+lint.select = [
     "B007", # Loop control variable {name} not used within loop body
     "B014", # Exception handler with duplicate exception
     "C",  # complexity
@@ -61,7 +60,7 @@ select = [
     "W",  # pycodestyle
 ]
 
-ignore = [
+lint.ignore = [
     "D203",  # 1 blank line required before class docstring
     "D213",  # Multi-line docstring summary should start at the second line
     # keep-runtime-annotations

{androidtvremote2-0.2.1 → androidtvremote2-0.2.3}/src/androidtvremote2/__init__.py

@@ -2,10 +2,13 @@
 
 from .androidtv_remote import AndroidTVRemote
 from .exceptions import CannotConnect, ConnectionClosed, InvalidAuth
+from .model import DeviceInfo, VolumeInfo
 
 __all__ = [
     "AndroidTVRemote",
     "CannotConnect",
     "ConnectionClosed",
+    "DeviceInfo",
     "InvalidAuth",
+    "VolumeInfo",
 ]

{androidtvremote2-0.2.1 → androidtvremote2-0.2.3}/src/androidtvremote2/androidtv_remote.py

@@ -14,6 +14,7 @@ from cryptography import x509
 from .certificate_generator import generate_selfsigned_cert
 from .const import LOGGER
 from .exceptions import CannotConnect, ConnectionClosed, InvalidAuth
+from .model import DeviceInfo, VolumeInfo
 from .pairing import PairingProtocol
 from .remote import RemoteProtocol
 from .remotemessage_pb2 import RemoteDirection
@@ -64,12 +65,12 @@ class AndroidTVRemote:
         self._transport: asyncio.Transport | None = None
         self._remote_message_protocol: RemoteProtocol | None = None
         self._pairing_message_protocol: PairingProtocol | None = None
-        self._reconnect_task: asyncio.Task | None = None
+        self._reconnect_task: asyncio.Task[None] | None = None
         self._ssl_context: ssl.SSLContext | None = None
-        self._is_on_updated_callbacks: list[Callable] = []
-        self._current_app_updated_callbacks: list[Callable] = []
-        self._volume_info_updated_callbacks: list[Callable] = []
-        self._is_available_updated_callbacks: list[Callable] = []
+        self._is_on_updated_callbacks: list[Callable[[bool], None]] = []
+        self._current_app_updated_callbacks: list[Callable[[str], None]] = []
+        self._volume_info_updated_callbacks: list[Callable[[VolumeInfo], None]] = []
+        self._is_available_updated_callbacks: list[Callable[[bool], None]] = []
 
         def is_on_updated(is_on: bool) -> None:
             for callback in self._is_on_updated_callbacks:
@@ -79,7 +80,7 @@ class AndroidTVRemote:
             for callback in self._current_app_updated_callbacks:
                 callback(current_app)
 
-        def volume_info_updated(volume_info: dict[str, str | bool]) -> None:
+        def volume_info_updated(volume_info: VolumeInfo) -> None:
             for callback in self._volume_info_updated_callbacks:
                 callback(volume_info)
 
@@ -107,57 +108,67 @@ class AndroidTVRemote:
         return self._remote_message_protocol.current_app
 
     @property
-    def device_info(self) -> dict[str, str] | None:
+    def device_info(self) -> DeviceInfo | None:
         """Device info (manufacturer, model, sw_version)."""
         if not self._remote_message_protocol:
             return None
         return self._remote_message_protocol.device_info
 
     @property
-    def volume_info(self) -> dict[str, str | bool | int] | None:
+    def volume_info(self) -> VolumeInfo | None:
         """Volume info (level, max, muted)."""
         if not self._remote_message_protocol:
             return None
         return self._remote_message_protocol.volume_info
 
-    def add_is_on_updated_callback(self, callback: Callable) -> None:
+    def add_is_on_updated_callback(self, callback: Callable[[bool], None]) -> None:
         """Add a callback for when is_on is updated."""
         self._is_on_updated_callbacks.append(callback)
 
-    def remove_is_on_updated_callback(self, callback: Callable) -> None:
+    def remove_is_on_updated_callback(self, callback: Callable[[bool], None]) -> None:
         """Remove a callback previously added via add_is_on_updated_callback.
 
         :raises ValueError: if callback not previously added.
         """
         self._is_on_updated_callbacks.remove(callback)
 
-    def add_current_app_updated_callback(self, callback: Callable) -> None:
+    def add_current_app_updated_callback(self, callback: Callable[[str], None]) -> None:
         """Add a callback for when current_app is updated."""
         self._current_app_updated_callbacks.append(callback)
 
-    def remove_current_app_updated_callback(self, callback: Callable) -> None:
+    def remove_current_app_updated_callback(
+        self, callback: Callable[[str], None]
+    ) -> None:
         """Remove a callback previously added via add_current_app_updated_callback.
 
         :raises ValueError: if callback not previously added.
         """
         self._current_app_updated_callbacks.remove(callback)
 
-    def add_volume_info_updated_callback(self, callback: Callable) -> None:
+    def add_volume_info_updated_callback(
+        self, callback: Callable[[VolumeInfo], None]
+    ) -> None:
         """Add a callback for when volume_info is updated."""
         self._volume_info_updated_callbacks.append(callback)
 
-    def remove_volume_info_updated_callback(self, callback: Callable) -> None:
+    def remove_volume_info_updated_callback(
+        self, callback: Callable[[VolumeInfo], None]
+    ) -> None:
         """Remove a callback previously added via add_volume_info_updated_callback.
 
         :raises ValueError: if callback not previously added.
         """
         self._volume_info_updated_callbacks.remove(callback)
 
-    def add_is_available_updated_callback(self, callback: Callable) -> None:
+    def add_is_available_updated_callback(
+        self, callback: Callable[[bool], None]
+    ) -> None:
         """Add a callback for when the Android TV is ready to receive commands or is unavailable."""
         self._is_available_updated_callbacks.append(callback)
 
-    def remove_is_available_updated_callback(self, callback: Callable) -> None:
+    def remove_is_available_updated_callback(
+        self, callback: Callable[[bool], None]
+    ) -> None:
         """Remove a callback previously added via add_is_available_updated_callback.
 
         :raises ValueError: if callback not previously added.
@@ -245,7 +256,7 @@ class AndroidTVRemote:
             raise ConnectionClosed("Connection closed") from con_lost_exc
 
     async def _async_reconnect(
-        self, invalid_auth_callback: Callable | None = None
+        self, invalid_auth_callback: Callable[[], None] | None = None
     ) -> None:
         while self._remote_message_protocol:
             exc = await self._remote_message_protocol.on_con_lost
@@ -279,7 +290,9 @@ class AndroidTVRemote:
                         invalid_auth_callback()
                     return
 
-    def keep_reconnecting(self, invalid_auth_callback: Callable | None = None) -> None:
+    def keep_reconnecting(
+        self, invalid_auth_callback: Callable[[], None] | None = None
+    ) -> None:
         """Create a task to keep reconnecting whenever connection is lost."""
         self._reconnect_task = self._loop.create_task(
             self._async_reconnect(invalid_auth_callback)
@@ -384,7 +397,8 @@ class AndroidTVRemote:
         This does not block; it buffers the data and arranges for it to be sent out asynchronously.
 
         :param key_code: int (e.g. 26) or str (e.g. "KEYCODE_POWER" or just "POWER") from the enum
-                         RemoteKeyCode in remotemessage.proto.
+                         RemoteKeyCode in remotemessage.proto or str prefixed with "text:" to pass
+                         to send_text.
         :param direction: "SHORT" (default) or "START_LONG" or "END_LONG".
         :raises ValueError: if key_code in str or direction isn't known.
         :raises ConnectionClosed: if client is disconnected.

{androidtvremote2-0.2.1 → androidtvremote2-0.2.3}/src/androidtvremote2/base.py

@@ -16,7 +16,7 @@ from .const import LOGGER
 class ProtobufProtocol(asyncio.Protocol):
     """Protocol for receiving and sending protobuf messages."""
 
-    def __init__(self, on_con_lost: asyncio.Future) -> None:
+    def __init__(self, on_con_lost: asyncio.Future[Exception | None]) -> None:
         """Initialize.
 
         :param on_con_lost: callback for when the connection is lost or closed.

androidtvremote2-0.2.3/src/androidtvremote2/model.py

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

{androidtvremote2-0.2.1 → androidtvremote2-0.2.3}/src/androidtvremote2/pairing.py

@@ -9,6 +9,7 @@ from __future__ import annotations
 
 import asyncio
 import hashlib
+from typing import Any
 
 import aiofiles
 from cryptography import x509
@@ -45,7 +46,7 @@ class PairingProtocol(ProtobufProtocol):
 
     def __init__(
         self,
-        on_con_lost: asyncio.Future,
+        on_con_lost: asyncio.Future[Exception | None],
         client_name: str,
         certfile: str,
         loop: asyncio.AbstractEventLoop,
@@ -62,8 +63,8 @@ class PairingProtocol(ProtobufProtocol):
         self._client_name = client_name
         self._certfile = certfile
         self._loop = loop
-        self._on_pairing_started: asyncio.Future | None = None
-        self._on_pairing_finished: asyncio.Future | None = None
+        self._on_pairing_started: asyncio.Future[bool] | None = None
+        self._on_pairing_finished: asyncio.Future[bool] | None = None
 
     async def async_start_pairing(self) -> None:
         """Start the pairing process.
@@ -130,7 +131,9 @@ class PairingProtocol(ProtobufProtocol):
         finally:
             self._on_pairing_finished = None
 
-    async def _async_wait_for_future_or_con_lost(self, future: asyncio.Future) -> 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

{androidtvremote2-0.2.1 → androidtvremote2-0.2.3}/src/androidtvremote2/remote.py

@@ -15,6 +15,7 @@ from google.protobuf.message import DecodeError
 
 from .base import ProtobufProtocol
 from .const import LOGGER
+from .model import DeviceInfo, VolumeInfo
 from .remotemessage_pb2 import (
     RemoteDirection,
     RemoteEditInfo,
@@ -30,6 +31,8 @@ ERROR_SUGGESTION_MSG = (
     "On the Android TV device, go to Settings > Apps > See all apps > Show system apps. "
     "Then, select Android TV Remote Service > Storage > Clear data/storage."
 )
+KEYCODE_PREFIX = "KEYCODE_"
+TEXT_PREFIX = "text:"
 
 
 class Feature(IntFlag):
@@ -53,11 +56,11 @@ class RemoteProtocol(ProtobufProtocol):
 
     def __init__(
         self,
-        on_con_lost: asyncio.Future,
-        on_remote_started: asyncio.Future,
-        on_is_on_updated: Callable,
-        on_current_app_updated: Callable,
-        on_volume_info_updated: Callable,
+        on_con_lost: asyncio.Future[Exception | None],
+        on_remote_started: asyncio.Future[bool],
+        on_is_on_updated: Callable[[bool], None],
+        on_current_app_updated: Callable[[str], None],
+        on_volume_info_updated: Callable[[VolumeInfo], None],
         loop: asyncio.AbstractEventLoop,
         enable_ime: bool,
     ) -> None:
@@ -87,12 +90,12 @@ class RemoteProtocol(ProtobufProtocol):
         )
         self.is_on = False
         self.current_app = ""
-        self.device_info: dict[str, str] = {}
-        self.volume_info: dict[str, str | bool | int] = {}
+        self.device_info: DeviceInfo | None = None
+        self.volume_info: VolumeInfo | None = None
         self.ime_counter: int = 0
         self.ime_field_counter: int = 0
         self._loop = loop
-        self._idle_disconnect_task: asyncio.Task | None = None
+        self._idle_disconnect_task: asyncio.Task[None] | None = None
         self._reset_idle_disconnect_task()
 
     def send_key_command(
@@ -102,16 +105,19 @@ class RemoteProtocol(ProtobufProtocol):
 
         This does not block; it buffers the data and arranges for it to be sent out asynchronously.
 
-        :param key_code: int (e.g. 26) or str (e.g. KEYCODE_POWER or just "POWER") from the enum
-                         RemoteKeyCode in remotemessage.proto.
+        :param key_code: int (e.g. 26) or str (e.g. "KEYCODE_POWER" or just "POWER") from the enum
+                         RemoteKeyCode in remotemessage.proto or str prefixed with "text:" to pass
+                         to send_text.
         :param direction: "SHORT" (default) or "START_LONG" or "END_LONG".
         :raises ValueError: if key_code in str or direction isn't known.
         """
         self._reset_idle_disconnect_task()
         msg = RemoteMessage()
         if isinstance(key_code, str):
-            if not key_code.startswith("KEYCODE_"):
-                key_code = "KEYCODE_" + key_code
+            if key_code.lower().startswith(TEXT_PREFIX):
+                return self.send_text(key_code[len(TEXT_PREFIX) :])
+            if not key_code.startswith(KEYCODE_PREFIX):
+                key_code = KEYCODE_PREFIX + key_code
             key_code = RemoteKeyCode.Value(key_code)
         if isinstance(direction, str):
             direction = RemoteDirection.Value(direction)

{androidtvremote2-0.2.1 → androidtvremote2-0.2.3/src/androidtvremote2.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: androidtvremote2
-Version: 0.2.1
+Version: 0.2.3
 Summary: A Python library for interacting with Android TV using the Android TV Remote protocol v2
 Author-email: tronikos <tronikos@gmail.com>
 License: Apache-2.0
@@ -19,7 +19,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 [here](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/b4c49ac03043b1b9c40c2f2960e466d5a3b8bd67/src/androidtvremote2/remotemessage.proto#L90).
 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.
 
 ## Credits

{androidtvremote2-0.2.1 → androidtvremote2-0.2.3}/src/androidtvremote2.egg-info/SOURCES.txt

@@ -9,9 +9,11 @@ src/androidtvremote2/base.py
 src/androidtvremote2/certificate_generator.py
 src/androidtvremote2/const.py
 src/androidtvremote2/exceptions.py
+src/androidtvremote2/model.py
 src/androidtvremote2/pairing.py
 src/androidtvremote2/polo_pb2.py
 src/androidtvremote2/polo_pb2.pyi
+src/androidtvremote2/py.typed
 src/androidtvremote2/remote.py
 src/androidtvremote2/remotemessage_pb2.py
 src/androidtvremote2/remotemessage_pb2.pyi

{androidtvremote2-0.2.1 → androidtvremote2-0.2.3}/src/demo.py

@@ -14,6 +14,7 @@ from androidtvremote2 import (
     CannotConnect,
     ConnectionClosed,
     InvalidAuth,
+    VolumeInfo,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -51,8 +52,8 @@ async def _bind_keyboard(remote: AndroidTVRemote) -> None:
         keyboard.Key.delete: "POWER",
     }
 
-    def transmit_keys() -> asyncio.Queue:
-        queue: asyncio.Queue = asyncio.Queue()
+    def transmit_keys() -> asyncio.Queue[keyboard.Key | keyboard.KeyCode | None]:
+        queue: asyncio.Queue[keyboard.Key | keyboard.KeyCode | None] = asyncio.Queue()
         loop = asyncio.get_event_loop()
 
         def on_press(key: keyboard.Key | keyboard.KeyCode | None) -> None:
@@ -64,30 +65,33 @@ async def _bind_keyboard(remote: AndroidTVRemote) -> None:
     key_queue = transmit_keys()
     while True:
         key = await key_queue.get()
+        if key is None:
+            continue
         if key in key_mappings:
             remote.send_key_command(key_mappings[key])
-        if hasattr(key, "char"):
-            if key.char == "q":
-                remote.disconnect()
-                return
-            elif key.char == "m":
-                remote.send_key_command("MUTE")
-            elif key.char == "+":
-                remote.send_key_command("VOLUME_UP")
-            elif key.char == "-":
-                remote.send_key_command("VOLUME_DOWN")
-            elif key.char == "y":
-                remote.send_launch_app_command("https://www.youtube.com")
-            elif key.char == "n":
-                remote.send_launch_app_command("com.netflix.ninja")
-            elif key.char == "d":
-                remote.send_launch_app_command("com.disney.disneyplus")
-            elif key.char == "a":
-                remote.send_launch_app_command("com.amazon.amazonvideo.livingroom")
-            elif key.char == "k":
-                remote.send_launch_app_command("org.xbmc.kodi")
-            elif key.char == "t":
-                remote.send_text("Hello World!")
+        if not isinstance(key, keyboard.KeyCode):
+            continue
+        if key.char == "q":
+            remote.disconnect()
+            return
+        elif key.char == "m":
+            remote.send_key_command("MUTE")
+        elif key.char == "+":
+            remote.send_key_command("VOLUME_UP")
+        elif key.char == "-":
+            remote.send_key_command("VOLUME_DOWN")
+        elif key.char == "y":
+            remote.send_launch_app_command("https://www.youtube.com")
+        elif key.char == "n":
+            remote.send_launch_app_command("com.netflix.ninja")
+        elif key.char == "d":
+            remote.send_launch_app_command("com.disney.disneyplus")
+        elif key.char == "a":
+            remote.send_launch_app_command("com.amazon.amazonvideo.livingroom")
+        elif key.char == "k":
+            remote.send_launch_app_command("org.xbmc.kodi")
+        elif key.char == "t":
+            remote.send_text("Hello World!")
 
 
 async def _host_from_zeroconf(timeout: float) -> str:
@@ -114,7 +118,7 @@ async def _host_from_zeroconf(timeout: float) -> str:
                 for addr in info.parsed_scoped_addresses()
             ]
             print(f"  Name: {name}")
-            print(f"  Addresses: {", ".join(addresses)}")
+            print(f"  Addresses: {', '.join(addresses)}")
             if info.properties:
                 print("  Properties:")
                 for key, value in info.properties.items():
@@ -227,7 +231,7 @@ async def _main() -> None:
     def current_app_updated(current_app: str) -> None:
         _LOGGER.info("Notified that current_app: %s", current_app)
 
-    def volume_info_updated(volume_info: dict[str, str | bool]) -> None:
+    def volume_info_updated(volume_info: VolumeInfo) -> None:
         _LOGGER.info("Notified that volume_info: %s", volume_info)
 
     def is_available_updated(is_available: bool) -> None: