python-linkplay 0.2.3__py3-none-any.whl → 0.2.5__py3-none-any.whl

linkplay/__version__.py

@@ -1 +1 @@
-__version__ = '0.2.3'
+__version__ = '0.2.5'

linkplay/bridge.py

@@ -7,12 +7,15 @@ from linkplay.consts import (
     INPUT_MODE_MAP,
     LOGGER,
     PLAY_MODE_SEND_MAP,
+    AudioOutputHwMode,
     ChannelType,
     DeviceAttribute,
     EqualizerMode,
     InputMode,
     LinkPlayCommand,
     LoopMode,
+    MetaInfo,
+    MetaInfoMetaData,
     MultiroomAttribute,
     MuteMode,
     PlayerAttribute,
@@ -128,6 +131,7 @@ class LinkPlayPlayer:
     bridge: LinkPlayBridge
     properties: dict[PlayerAttribute, str]
     custom_properties: dict[PlayerAttribute, str]
+    metainfo: dict[MetaInfo, dict[MetaInfoMetaData, str]]
 
     previous_playing_mode: PlayingMode | None = None
 
@@ -135,6 +139,7 @@ class LinkPlayPlayer:
         self.bridge = bridge
         self.properties = dict.fromkeys(PlayerAttribute.__members__.values(), "")
         self.custom_properties = dict.fromkeys(PlayerAttribute.__members__.values(), "")
+        self.metainfo = dict.fromkeys(MetaInfo.__members__.values(), {})
 
     def to_dict(self):
         """Return the state of the LinkPlayPlayer."""
@@ -147,6 +152,18 @@ class LinkPlayPlayer:
         )  # type: ignore[assignment]
 
         self.properties = fixup_player_properties(properties)
+        if self.bridge.device.manufacturer == MANUFACTURER_WIIM:
+            try:
+                self.metainfo: dict[
+                    MetaInfo, dict[MetaInfoMetaData, str]
+                ] = await self.bridge.json_request(LinkPlayCommand.META_INFO)  # type: ignore[assignment]
+            except LinkPlayInvalidDataException as exc:
+                if getattr(exc, "data", None) == "Failed":
+                    self.metainfo = {}
+                else:
+                    raise
+        else:
+            self.metainfo = {}
 
         # handle multiroom changes
         if self.bridge.device.controller is not None and (
@@ -277,6 +294,14 @@ class LinkPlayPlayer:
         ):
             await self.bridge.request(LinkPlayCommand.SEEK.format(position))
 
+    async def set_audio_output_hw_mode(self, mode: AudioOutputHwMode) -> None:
+        """Set the audio hardware output."""
+        await self.bridge.request(LinkPlayCommand.AUDIO_OUTPUT_HW_MODE_SET.format(mode))
+
+    async def get_audio_output_hw_mode(self) -> None:
+        """Get the audio hardware output."""
+        await self.bridge.json_request(LinkPlayCommand.AUDIO_OUTPUT_HW_MODE)
+
     @property
     def muted(self) -> bool:
         """Returns if the player is muted."""
@@ -300,6 +325,13 @@ class LinkPlayPlayer:
         """Returns if the currently playing album."""
         return self.properties.get(PlayerAttribute.ALBUM, "")
 
+    @property
+    def album_art(self) -> str:
+        """Returns the url to the album art."""
+        return self.metainfo.get(MetaInfo.METADATA, {}).get(
+            MetaInfoMetaData.ALBUM_ART, ""
+        )
+
     @property
     def volume(self) -> int:
         """Returns the player volume, expressed in %."""

linkplay/consts.py

@@ -100,6 +100,9 @@ class LinkPlayCommand(StrEnum):
     PLAY_PRESET = "MCUKeyShortClick:{}"
     TIMESYNC = "timeSync:{}"
     WIIM_EQ_LOAD = "EQLoad:{}"
+    META_INFO = "getMetaInfo"
+    AUDIO_OUTPUT_HW_MODE_SET = "setAudioOutputHardwareMode:{}"
+    AUDIO_OUTPUT_HW_MODE = "getNewAudioOutputHardwareMode"
 
 
 class LinkPlayTcpUartCommand(StrEnum):
@@ -470,3 +473,50 @@ class MultiroomAttribute(StrEnum):
 
     def __repr__(self):
         return self.value
+
+
+class MetaInfo(StrEnum):
+    METADATA = "metaData"
+
+    def __str__(self):
+        return self.value
+
+    def __repr__(self):
+        return self.value
+
+
+class MetaInfoMetaData(StrEnum):
+    """Defines the metadata within the metainfo."""
+
+    ALBUM_TITLE = "album"
+    TRACK_TITLE = "title"
+    TRACK_SUBTITLE = "subtitle"
+    ALBUM_ART = "albumArtURI"
+    SAMPLE_RATE = "sampleRate"
+    BIT_DEPTH = "bitDepth"
+    BIT_RATE = "bitRate"
+    TRACK_ID = "trackId"
+
+    def __str__(self):
+        return self.value
+
+    def __repr__(self):
+        return self.value
+
+
+class AudioOutputHwMode(StrEnum):
+    """Defines a output mode for the hardware."""
+
+    OPTICAL = "1"
+    LINE_OUT = "2"
+    COAXIAL = "3"
+    HEADPHONES = "4"
+
+
+# Map between a play mode and how to activate the play mode
+AUDIO_OUTPUT_HW_MODE_MAP: dict[AudioOutputHwMode, str] = {  # case sensitive!
+    AudioOutputHwMode.OPTICAL: "optical",
+    AudioOutputHwMode.LINE_OUT: "line-out",
+    AudioOutputHwMode.COAXIAL: "co-axial",
+    AudioOutputHwMode.HEADPHONES: "headphones",
+}

linkplay/exceptions.py

@@ -7,4 +7,6 @@ class LinkPlayRequestException(LinkPlayException):
 
 
 class LinkPlayInvalidDataException(LinkPlayException):
-    pass
+    def __init__(self, message: str = "Invalid data received", data: str | None = None):
+        super().__init__(message)
+        self.data = data

linkplay/utils.py

@@ -82,7 +82,7 @@ async def session_call_api_json(
     except json.JSONDecodeError as jsonexc:
         url = API_ENDPOINT.format(endpoint, command)
         raise LinkPlayInvalidDataException(
-            f"Unexpected JSON ({result}) received from '{url}'"
+            message=f"Unexpected JSON ({result}) received from '{url}'", data=result
         ) from jsonexc
 
 

{python_linkplay-0.2.3.dist-info → python_linkplay-0.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python_linkplay
-Version: 0.2.3
+Version: 0.2.5
 Summary: A Python Library for Seamless LinkPlay Device Control
 Author: Velleman Group nv
 License: MIT
@@ -48,16 +48,18 @@ Welcome to python-linkplay, a powerful and user-friendly Python library designed
 4. Metadata Retrieval: Retrieve essential metadata such as track information, artist details, and album data, enabling you to enhance the user interface and display relevant information in your applications.
 
 ## LinkPlay API documentation
-
-- https://github.com/n4archive/LinkPlayAPI
-- https://github.com/nagyrobi/home-assistant-custom-components-linkplay
-- https://github.com/ramikg/linkplay-cli
 - https://developer.arylic.com/httpapi/
 - http://airscope-audio.net/core2/pdf/airscope-module-http.pdf
 - https://www.wiimhome.com/pdf/HTTP%20API%20for%20WiiM%20Mini.pdf
 - https://www.wiimhome.com/pdf/HTTP%20API%20for%20WiiM%20Products.pdf
+
+## LinkPlay references
+- https://github.com/n4archive/LinkPlayAPI
+- https://github.com/nagyrobi/home-assistant-custom-components-linkplay
+- https://github.com/ramikg/linkplay-cli
 - https://github.com/DanBrezeanu/wiim-extended-http-api
 - https://github.com/cvdlinden/wiim-httpapi
+- https://community.openhab.org/t/linkplay-binding/161995
 
 ## Multiroom
 

python_linkplay-0.2.5.dist-info/RECORD

@@ -0,0 +1,16 @@
+linkplay/__init__.py,sha256=y9ZehEq-KhS3cwn-PUpwVSJGfDUx7e5wf_G6guODcTk,56
+linkplay/__main__.py,sha256=Wcza80QaWfOaHjyJEfQYhB9kiPLE0NOqIj4zVWv2Nqs,577
+linkplay/__version__.py,sha256=8f4ummWTPl6PtdE9DzSUgZhPjGioA_NDC-hDpqzB9qI,22
+linkplay/bridge.py,sha256=IGohfJbBNa4C9cgva--Uhq5iMz4eRnljLbx-SqlsYd8,21582
+linkplay/consts.py,sha256=vKlEZvo7-OIjHziimtZ3t4VkPZBoJc--Qj-7gHigxWk,15441
+linkplay/controller.py,sha256=U370dMVl-E7iIhDC1wWmsrnFcdrWso84K0vkImsgCTo,4430
+linkplay/discovery.py,sha256=NnkO9gknp3Cyff7830zBu1LwyhkkWCdhDbEDbAwF8D8,4610
+linkplay/endpoint.py,sha256=_gelW0cDWt0SC8EApwaKIVh_YJIMNiOkfrLR_RYW7aM,2677
+linkplay/exceptions.py,sha256=UHcV0Yok0hdM0MYgHRwTWnMJ612Ts0iJvMFHX-IxmNo,312
+linkplay/manufacturers.py,sha256=oddlZTbtrCBVCcy5adbXk0bhBOXEcmC6U5-a7QShLHY,3906
+linkplay/utils.py,sha256=fZHGnUM4XFrQ7MM6guHhaEmxJbVlwilbwoZXvXwSfMs,9480
+python_linkplay-0.2.5.dist-info/licenses/LICENSE,sha256=bgEtxMyjEHX_4uwaAY3GCFTm234D4AOZ5dM15sk26ms,1073
+python_linkplay-0.2.5.dist-info/METADATA,sha256=XFBM5m--r4RlIx-EkXh1MBFjxUoLelu7Cks9E2V3CaY,3260
+python_linkplay-0.2.5.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+python_linkplay-0.2.5.dist-info/top_level.txt,sha256=CpSaOVPTzJf5TVIL7MrotSCR34gcIOQy-11l4zGmxxM,9
+python_linkplay-0.2.5.dist-info/RECORD,,

{python_linkplay-0.2.3.dist-info → python_linkplay-0.2.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.4.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

python_linkplay-0.2.3.dist-info/RECORD

@@ -1,16 +0,0 @@
-linkplay/__init__.py,sha256=y9ZehEq-KhS3cwn-PUpwVSJGfDUx7e5wf_G6guODcTk,56
-linkplay/__main__.py,sha256=Wcza80QaWfOaHjyJEfQYhB9kiPLE0NOqIj4zVWv2Nqs,577
-linkplay/__version__.py,sha256=XtWUl6HPylv5jZLd2KkgtPptuzuda93kC2REmOrF-Cs,22
-linkplay/bridge.py,sha256=m_1E71dP5sftvA4ahmRvDsNrYDHXGV9CpOynuv2v29I,20262
-linkplay/consts.py,sha256=3yUX_a_wOjpVLUPK5ogSCEOwgVJs-TIPb8LPo4Ds1Ic,14242
-linkplay/controller.py,sha256=U370dMVl-E7iIhDC1wWmsrnFcdrWso84K0vkImsgCTo,4430
-linkplay/discovery.py,sha256=NnkO9gknp3Cyff7830zBu1LwyhkkWCdhDbEDbAwF8D8,4610
-linkplay/endpoint.py,sha256=_gelW0cDWt0SC8EApwaKIVh_YJIMNiOkfrLR_RYW7aM,2677
-linkplay/exceptions.py,sha256=Kow13uJPSL4y6rXMnkcl_Yp9wH1weOyKw_knd0p-Exc,173
-linkplay/manufacturers.py,sha256=oddlZTbtrCBVCcy5adbXk0bhBOXEcmC6U5-a7QShLHY,3906
-linkplay/utils.py,sha256=U6hy5KKUzeEc3RMZigTJBynT-ddNfW8KIIMHaydZGQc,9459
-python_linkplay-0.2.3.dist-info/licenses/LICENSE,sha256=bgEtxMyjEHX_4uwaAY3GCFTm234D4AOZ5dM15sk26ms,1073
-python_linkplay-0.2.3.dist-info/METADATA,sha256=Y6N8RNsgHABjHRGztEuT_Gsbv4DP2u8K-Bsce10FO7E,3179
-python_linkplay-0.2.3.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-python_linkplay-0.2.3.dist-info/top_level.txt,sha256=CpSaOVPTzJf5TVIL7MrotSCR34gcIOQy-11l4zGmxxM,9
-python_linkplay-0.2.3.dist-info/RECORD,,