aiosonos 0.1.0__tar.gz

aiosonos-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

aiosonos-0.1.0/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.1
+Name: aiosonos
+Version: 0.1.0
+Summary: Async python library to communicate with Sonos devices.
+Author-email: AIOSonos <m.vanderveldt@users.noreply.github.com>
+License: Apache-2.0
+Platform: any
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.4
+Requires-Dist: orjson>=3.8.9
+Provides-Extra: speedups
+Requires-Dist: faust-cchardet>=2.1.18; extra == "speedups"
+Requires-Dist: aiodns>=3.0.0; extra == "speedups"
+Requires-Dist: Brotli>=1.0.9; extra == "speedups"
+Provides-Extra: test
+Requires-Dist: codespell==2.2.6; extra == "test"
+Requires-Dist: mypy==1.8.0; extra == "test"
+Requires-Dist: pre-commit==3.6.1; extra == "test"
+Requires-Dist: pre-commit-hooks==4.5.0; extra == "test"
+Requires-Dist: pytest==8.0.0; extra == "test"
+Requires-Dist: pytest-aiohttp==1.0.5; extra == "test"
+Requires-Dist: pytest-cov==4.1.0; extra == "test"
+Requires-Dist: ruff==0.2.1; extra == "test"
+
+# aiosonos
+Async python library to communicate with Sonos devices

aiosonos-0.1.0/README.md

@@ -0,0 +1,2 @@
+# aiosonos
+Async python library to communicate with Sonos devices

aiosonos-0.1.0/aiosonos/__init__.py

@@ -0,0 +1,2 @@
+"""Provide a package for AIOSonos."""
+from .client import SonosLocalApiClient  # noqa: F401

aiosonos-0.1.0/aiosonos/client.py

@@ -0,0 +1,238 @@
+"""
+Sonos API Client to manage a single Sonos speaker, using the local websockets api.
+
+Although the only connection method that is implemented,
+is the local websockets connection, the cloud API shares the same models and
+namespaces so this client could be extended to support the cloud API as well.
+"""
+
+from __future__ import annotations
+
+import asyncio
+from collections.abc import Callable
+from typing import TYPE_CHECKING, Self
+
+from aiosonos.const import EventType, GroupEvent, SonosEvent
+from aiosonos.utils import get_discovery_info
+
+from .api.websockets import SonosLocalWebSocketsApi
+from .group import SonosGroup
+from .player import SonosPlayer
+
+if TYPE_CHECKING:
+    from types import TracebackType
+
+    from aiohttp import ClientSession
+
+    from aiosonos.api.models import GroupInfo
+
+    from .api.models import Group as GroupData
+    from .api.models import Groups as GroupsData
+
+
+EventCallBackType = Callable[[SonosEvent], None]
+EventSubscriptionType = tuple[
+    EventCallBackType,
+    tuple[EventType, ...] | None,
+    tuple[str, ...] | None,
+]
+
+
+class SonosLocalApiClient:
+    """Sonos API Client to manage a single Sonos speaker, using the local websockets api."""
+
+    api: SonosLocalWebSocketsApi
+    _loop = asyncio.BaseEventLoop
+    _household_id: str = ""
+    _player_id: str
+    _player: SonosPlayer
+
+    def __init__(self, player_ip: str, aiohttp_session: ClientSession) -> None:
+        """Initialize the Sonos API client."""
+        self.player_ip = player_ip
+        self._aiohttp_session = aiohttp_session
+        self._groups: dict[str, SonosGroup] = {}
+        self._subscribers: list[EventSubscriptionType] = []
+
+    @property
+    def player_id(self) -> str:
+        """Return the player id."""
+        return self._player_id
+
+    @property
+    def player(self) -> SonosPlayer:
+        """Return the player."""
+        return self._player
+
+    @property
+    def household_id(self) -> str:
+        """Return the household id."""
+        return self._household_id
+
+    @property
+    def groups(self) -> list[SonosGroup]:
+        """Return all groups available in the Sonos household."""
+        return list(self._groups.values())
+
+    def get_group(self, group_id: str) -> SonosGroup:
+        """Return a group."""
+        return self._groups[group_id]
+
+    def subscribe(
+        self,
+        cb_func: EventSubscriptionType,
+        event_filter: EventType | tuple[EventType] | None = None,
+        object_id_filter: str | tuple[str] | None = None,
+    ) -> Callable[[], None]:
+        """Add callback to event listeners.
+
+        Returns function to remove the listener.
+
+        Parameters:
+            - cb_func: callback function or coroutine
+            - event_filter: Optionally only listen for these events
+            - object_id_filter: Optionally only listen for these id's (player id, etc.)
+        """
+        if isinstance(event_filter, EventType):
+            event_filter = (event_filter,)
+        if isinstance(object_id_filter, str):
+            object_id_filter = (object_id_filter,)
+        listener = (cb_func, event_filter, object_id_filter)
+        self._subscribers.append(listener)
+
+        def remove_listener() -> None:
+            self._subscribers.remove(listener)
+
+        return remove_listener
+
+    def signal_event(self, event: SonosEvent) -> None:
+        """Forward event to subscribers."""
+        for cb_func, event_filter, id_filter in self._subscribers:
+            if not (event_filter is None or event.event_type in event_filter):
+                continue
+            if not (id_filter is None or event.object_id in id_filter):
+                continue
+            self._loop.call_soon_threadsafe(cb_func, event)
+
+    async def connect(self) -> None:
+        """Connect to the API."""
+        self._loop = asyncio.get_running_loop()
+        # retrieve discovery details from player first
+        discovery_info = await get_discovery_info(self._aiohttp_session, self.player_ip)
+        self._player_id = discovery_info["playerId"]
+        self._household_id = discovery_info["householdId"]
+        # Connect to the local websocket API
+        self.api = SonosLocalWebSocketsApi(
+            discovery_info["websocketUrl"],
+            self._aiohttp_session,
+        )
+        # NOTE: connect will raise when connecting failed
+        await self.api.connect()
+
+    async def disconnect(self) -> None:
+        """Disconnect the client and cleanup."""
+        await self.api.disconnect()
+
+    async def start_listening(self, init_ready: asyncio.Event | None = None) -> None:
+        """Fetch initial state keep listening to messages until stopped."""
+        listen_task = asyncio.create_task(self.api.start_listening())
+        # fetch all initial data and setup subscriptions
+        groups_data = await self.api.groups.get_groups(
+            self.household_id,
+            include_device_info=True,
+        )
+        for group_data in groups_data["groups"]:
+            await self._setup_group(group_data)
+        # Although all players are returned in the groups data,
+        # the local api can only process the player that it is connected to
+        # so we ignore all other player objects. For each Sonos player,
+        # an individual api connection should be set-up to manage the player.
+        # The Cloud API however is able to manage all players in the household.
+        player_data = next(x for x in groups_data["players"] if x["id"] == self._player_id)
+        self._player = player = SonosPlayer(self, player_data)
+        await player.async_init()
+        # setup global groups/player subscription
+        await self.api.groups.subscribe(self._household_id, self._handle_groups_event)
+        # set event that initial setup is done
+        init_ready.set()
+        # wait (forever) for incoming messages
+        await listen_task
+
+    async def create_group(
+        self,
+        player_ids: list[str],
+        music_context_group_id: str | None = None,
+    ) -> GroupInfo:
+        """
+        Create a new group.
+
+        Use the createGroup command in the groups namespace to
+        create a new group from a list of players. The player returns
+        a group object with the group ID. This may be an existing
+        group ID if an existing group is a subset of the new group.
+        In this case, Sonos may build the new group by adding new
+        players to the existing group.
+
+        musicContextGroupId (Optional): The group containing the audio
+        that you want to use. If empty or not provided,
+        the new group will not contain any audio.
+        """
+        await self.api.groups.create_group(
+            self._household_id,
+            player_ids,
+            music_context_group_id,
+        )
+
+    def _handle_groups_event(self, groups_data: GroupsData) -> None:
+        """Handle a groups event."""
+        # handle group updates
+        for group_data in groups_data["groups"]:
+            if group_data["id"] in self._groups:
+                # existing group object
+                self._groups[group_data["id"]].update_data(group_data)
+                continue
+            # a new group was added
+            self._loop.create_task(self._setup_group(group_data))
+        # check if any groups are removed
+        removed_groups = set(self._groups.keys()) - {g["id"] for g in groups_data["groups"]}
+        for group_id in removed_groups:
+            group = self._groups.pop(group_id)
+            self.signal_event(
+                GroupEvent(
+                    EventType.GROUP_REMOVED,
+                    group_id,
+                    group,
+                ),
+            )
+        # handle player updates
+        for player_data in groups_data["players"]:
+            if player_data["id"] != self._player_id:
+                continue
+            self._player.update_data(player_data)
+
+    async def _setup_group(self, group_data: GroupData) -> None:
+        """Register/setup a (new) group."""
+        group = SonosGroup(self, group_data)
+        self._groups[group.id] = group
+        await group.async_init()
+        self.signal_event(
+            GroupEvent(
+                EventType.GROUP_ADDED,
+                group.id,
+                group,
+            ),
+        )
+
+    async def __aenter__(self) -> Self:
+        """Initialize and connect."""
+        await self.connect()
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_val: BaseException | None,
+        exc_tb: TracebackType | None,
+    ) -> bool | None:
+        """Exit and disconnect."""
+        await self.disconnect()

aiosonos-0.1.0/aiosonos/const.py

@@ -0,0 +1,56 @@
+"""Constants/Models for the SonosApiClient."""
+from __future__ import annotations
+
+from dataclasses import dataclass
+from enum import StrEnum
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from .group import SonosGroup
+    from .player import SonosPlayer
+
+CLOUD_BASE_URL = "api.ws.sonos.com/control/api/v1"
+LOCAL_API_TOKEN = "123e4567-e89b-12d3-a456-426655440000"  # noqa: S105
+LOG_LEVEL_VERBOSE = 5
+
+
+class EventType(StrEnum):
+    """Event types for the Sonos Client."""
+
+    GROUP_ADDED = "group_added"
+    GROUP_UPDATED = "group_updated"
+    GROUP_REMOVED = "group_removed"
+    PLAYER_ADDED = "player_added"
+    PLAYER_UPDATED = "player_updated"
+    PLAYER_REMOVED = "player_removed"
+    CONNECTED = "connected"
+    DISCONNECTED = "disconnected"
+
+    # special event type to match all events
+    MATCH_ALL = "match_all"
+
+
+@dataclass
+class SonosEventBase:
+    """Representation of an Event emitted in/by Sonos."""
+
+    event_type: EventType
+    object_id: str | None = None  # optional identifier such as player id or group id
+    data: Any | None = None  # optional data
+
+
+@dataclass
+class PlayerEvent(SonosEventBase):
+    """Representation of an Event emitted when a player was added, updated or removed."""
+
+    data: SonosPlayer
+
+
+@dataclass
+class GroupEvent(SonosEventBase):
+    """Representation of an Event emitted when a group was added, updated or removed."""
+
+    data: SonosGroup
+
+
+SonosEvent = PlayerEvent | GroupEvent

aiosonos-0.1.0/aiosonos/exceptions.py

@@ -0,0 +1,67 @@
+"""Exceptions for AIOSonos."""
+
+from __future__ import annotations
+
+# ruff: noqa: N818
+
+
+class SonosException(Exception):
+    """Generic Sonos exception."""
+
+
+class TransportError(SonosException):
+    """Exception raised to represent transport errors."""
+
+    def __init__(self, message: str, error: Exception | None = None) -> None:
+        """Initialize a transport error."""
+        super().__init__(message)
+        self.error = error
+
+
+class ConnectionClosed(TransportError):
+    """Exception raised when the connection is closed."""
+
+
+class CannotConnect(TransportError):
+    """Exception raised when failed to connect the client."""
+
+    def __init__(self, error: Exception) -> None:
+        """Initialize a cannot connect error."""
+        super().__init__(f"{error}", error)
+
+
+class ConnectionFailed(TransportError):
+    """Exception raised when an established connection fails."""
+
+    def __init__(self, error: Exception | None = None) -> None:
+        """Initialize a connection failed error."""
+        if error is None:
+            super().__init__("Connection failed.")
+            return
+        super().__init__(f"{error}", error)
+
+
+class NotConnected(SonosException):
+    """Exception raised when not connected to the socket."""
+
+
+class InvalidState(SonosException):
+    """Exception raised when data gets in invalid state."""
+
+
+class InvalidMessage(SonosException):
+    """Exception raised when an invalid message is received."""
+
+
+class FailedCommand(SonosException):
+    """When a command has failed."""
+
+    def __init__(self, error_code: str, details: str | None = None) -> None:
+        """Initialize a failed command error."""
+        super().__init__(f"Command failed: {details or error_code}")
+        self.error_code = error_code
+        self.details = details
+
+
+class AlreadySubscribed(SonosException):
+    """Raised when trying to subscribe to a target for which a subscription already exists."""