python-linkplay 0.1.3__tar.gz → 0.2.1__tar.gz

{python_linkplay-0.1.3/src/python_linkplay.egg-info → python_linkplay-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: python_linkplay
-Version: 0.1.3
+Version: 0.2.1
 Summary: A Python Library for Seamless LinkPlay Device Control
 Author: Velleman Group nv
 License: MIT
@@ -24,12 +24,13 @@ Requires-Dist: ruff>=0.5.4; extra == "testing"
 Requires-Dist: tox>=4.6.0; extra == "testing"
 Requires-Dist: typing-extensions>=4.6.3; extra == "testing"
 Requires-Dist: pre-commit>=3.8.0; extra == "testing"
-
+Dynamic: license-file
 
 [![PyPI package](https://badge.fury.io/py/python-linkplay.svg)](https://pypi.org/project/python-linkplay/)
 [![Release](https://github.com/velleman/python-linkplay/actions/workflows/release.yaml/badge.svg)](https://github.com/velleman/python-linkplay/actions/workflows/release.yaml)
 
 # python-linkplay
+
 A Python Library for Seamless LinkPlay Device Control
 
 ## Intro
@@ -54,6 +55,9 @@ Welcome to python-linkplay, a powerful and user-friendly Python library designed
 - 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
+- https://github.com/DanBrezeanu/wiim-extended-http-api
+- https://github.com/cvdlinden/wiim-httpapi
 
 ## Multiroom
 

{python_linkplay-0.1.3 → python_linkplay-0.2.1}/README.md

@@ -1,8 +1,8 @@
-
 [![PyPI package](https://badge.fury.io/py/python-linkplay.svg)](https://pypi.org/project/python-linkplay/)
 [![Release](https://github.com/velleman/python-linkplay/actions/workflows/release.yaml/badge.svg)](https://github.com/velleman/python-linkplay/actions/workflows/release.yaml)
 
 # python-linkplay
+
 A Python Library for Seamless LinkPlay Device Control
 
 ## Intro
@@ -27,6 +27,9 @@ Welcome to python-linkplay, a powerful and user-friendly Python library designed
 - 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
+- https://github.com/DanBrezeanu/wiim-extended-http-api
+- https://github.com/cvdlinden/wiim-httpapi
 
 ## Multiroom
 

python_linkplay-0.2.1/src/linkplay/__version__.py

@@ -0,0 +1 @@
+__version__ = '0.2.1'

{python_linkplay-0.1.3 → python_linkplay-0.2.1}/src/linkplay/bridge.py

@@ -22,7 +22,12 @@ from linkplay.consts import (
 )
 from linkplay.endpoint import LinkPlayEndpoint
 from linkplay.exceptions import LinkPlayInvalidDataException
-from linkplay.utils import fixup_player_properties
+from linkplay.manufacturers import MANUFACTURER_WIIM, get_info_from_project
+from linkplay.utils import (
+    equalizer_mode_from_number_mapping,
+    equalizer_mode_to_number_mapping,
+    fixup_player_properties,
+)
 
 
 class LinkPlayDevice:
@@ -57,6 +62,22 @@ class LinkPlayDevice:
         """The name of the device."""
         return self.properties.get(DeviceAttribute.DEVICE_NAME, "")
 
+    @property
+    def manufacturer(self) -> str:
+        """The manufacturer of the device."""
+        manufacturer, _ = get_info_from_project(
+            self.properties.get(DeviceAttribute.PROJECT, "")
+        )
+        return manufacturer
+
+    @property
+    def model(self) -> str:
+        """The model of the device."""
+        _, model = get_info_from_project(
+            self.properties.get(DeviceAttribute.PROJECT, "")
+        )
+        return model
+
     @property
     def playmode_support(self) -> list[PlayingMode]:
         """Returns the player playmode support."""
@@ -100,10 +121,12 @@ class LinkPlayPlayer:
 
     bridge: LinkPlayBridge
     properties: dict[PlayerAttribute, str]
+    custom_properties: dict[PlayerAttribute, str]
 
     def __init__(self, bridge: LinkPlayBridge):
         self.bridge = bridge
         self.properties = dict.fromkeys(PlayerAttribute.__members__.values(), "")
+        self.custom_properties = dict.fromkeys(PlayerAttribute.__members__.values(), "")
 
     def to_dict(self):
         """Return the state of the LinkPlayPlayer."""
@@ -170,7 +193,37 @@ class LinkPlayPlayer:
 
     async def set_equalizer_mode(self, mode: EqualizerMode) -> None:
         """Set the equalizer mode."""
-        await self.bridge.request(LinkPlayCommand.EQUALIZER_MODE.format(mode))  # type: ignore[str-format]
+        if self.bridge.device.manufacturer == MANUFACTURER_WIIM:
+            await self._set_wiim_equalizer_mode(mode)
+        else:
+            await self._set_normal_equalizer_mode(mode)
+
+    async def _set_wiim_equalizer_mode(self, mode: EqualizerMode) -> None:
+        # WiiM devices have a different equalizer mode handling
+        # and don't support the general equalizer mode command
+        if mode not in self.available_equalizer_modes:
+            raise ValueError(
+                f"Invalid equalizer mode {mode}. Allowed equalizer modes are {self.available_equalizer_modes}."
+            )
+
+        if mode == EqualizerMode.NONE:
+            await self.bridge.json_request(LinkPlayCommand.WIIM_EQUALIZER_OFF)
+        else:
+            await self.bridge.json_request(LinkPlayCommand.WIIM_EQ_LOAD.format(mode))
+        # WiiM doesn't update the property after setting it
+        self.custom_properties[PlayerAttribute.EQUALIZER_MODE] = mode
+
+    async def _set_normal_equalizer_mode(self, mode: EqualizerMode) -> None:
+        """Set the equalizer mode."""
+        equalizer_mode_as_number = equalizer_mode_to_number_mapping(mode)
+        if equalizer_mode_as_number is None:
+            raise ValueError(
+                f"Invalid equalizer mode {mode}. Allowed equalizer modes are {self.available_equalizer_modes}."
+            )
+
+        await self.bridge.request(
+            LinkPlayCommand.EQUALIZER_MODE.format(equalizer_mode_as_number)
+        )
 
     async def set_loop_mode(self, mode: LoopMode) -> None:
         """Set the loop mode."""
@@ -260,9 +313,62 @@ class LinkPlayPlayer:
     @property
     def equalizer_mode(self) -> EqualizerMode:
         """Returns the current equalizer mode."""
-        return EqualizerMode(
-            self.properties.get(PlayerAttribute.EQUALIZER_MODE, EqualizerMode.CLASSIC)
-        )
+        try:
+            if self.bridge.device.manufacturer == MANUFACTURER_WIIM:
+                # WiiM devices have a different equalizer mode handling
+                # and will never ever return what equalizer mode they are in
+                return EqualizerMode(
+                    self.custom_properties.get(
+                        PlayerAttribute.EQUALIZER_MODE, EqualizerMode.NONE
+                    )
+                )
+
+            return EqualizerMode(
+                equalizer_mode_from_number_mapping(
+                    self.properties.get(PlayerAttribute.EQUALIZER_MODE)
+                )
+                or EqualizerMode.NONE
+            )
+        except ValueError:
+            return EqualizerMode.NONE
+
+    @property
+    def available_equalizer_modes(self) -> list[EqualizerMode]:
+        """Returns the available equalizer modes."""
+        if self.bridge.device.manufacturer == MANUFACTURER_WIIM:
+            return [
+                EqualizerMode.NONE,
+                EqualizerMode.FLAT,
+                EqualizerMode.ACOUSTIC,
+                EqualizerMode.BASS_BOOSTER,
+                EqualizerMode.BASS_REDUCER,
+                EqualizerMode.CLASSICAL,
+                EqualizerMode.DANCE,
+                EqualizerMode.DEEP,
+                EqualizerMode.ELECTRONIC,
+                EqualizerMode.HIP_HOP,
+                EqualizerMode.JAZZ,
+                EqualizerMode.LATIN,
+                EqualizerMode.LOUDNESS,
+                EqualizerMode.LOUNGE,
+                EqualizerMode.PIANO,
+                EqualizerMode.POP,
+                EqualizerMode.R_B,
+                EqualizerMode.ROCK,
+                EqualizerMode.SMALL_SPEAKERS,
+                EqualizerMode.SPOKEN_WORD,
+                EqualizerMode.TREBLE_BOOSTER,
+                EqualizerMode.TREBLE_REDUCER,
+                EqualizerMode.VOCAL_BOOSTER,
+            ]
+
+        return [
+            EqualizerMode.NONE,
+            EqualizerMode.CLASSIC,
+            EqualizerMode.POP,
+            EqualizerMode.JAZZ,
+            EqualizerMode.VOCAL,
+        ]
 
     @property
     def speaker_type(self) -> SpeakerType:

{python_linkplay-0.1.3 → python_linkplay-0.2.1}/src/linkplay/consts.py

@@ -85,6 +85,8 @@ class LinkPlayCommand(StrEnum):
     STOP = "setPlayerCmd:stop"
     TOGGLE = "setPlayerCmd:onepause"
     EQUALIZER_MODE = "setPlayerCmd:equalizer:{}"
+    WIIM_EQUALIZER_ON = "EQOn"
+    WIIM_EQUALIZER_OFF = "EQOff"
     LOOP_MODE = "setPlayerCmd:loopmode:{}"
     SWITCH_MODE = "setPlayerCmd:switchmode:{}"
     M3U_PLAYLIST = "setPlayerCmd:m3u:play:{}"
@@ -97,6 +99,7 @@ class LinkPlayCommand(StrEnum):
     MULTIROOM_JOIN = "ConnectMasterAp:JoinGroupMaster:eth{}:wifi0.0.0.0"
     PLAY_PRESET = "MCUKeyShortClick:{}"
     TIMESYNC = "timeSync:{}"
+    WIIM_EQ_LOAD = "EQLoad:{}"
 
 
 class LinkPlayTcpUartCommand(StrEnum):
@@ -219,11 +222,33 @@ class LoopMode(StrEnum):
 class EqualizerMode(StrEnum):
     """Defines the equalizer mode."""
 
-    NONE = "0"
-    CLASSIC = "1"
-    POP = "2"
-    JAZZ = "3"
-    VOCAL = "4"
+    NONE = "None"
+    CLASSIC = "Classic"
+    POP = "Pop"
+    JAZZ = "Jazz"
+    VOCAL = "Vocal"
+
+    # Custom equalizer modes specificly for WiiM devices
+    FLAT = "Flat"
+    ACOUSTIC = "Acoustic"
+    BASS_BOOSTER = "Bass Booster"
+    BASS_REDUCER = "Bass Reducer"
+    CLASSICAL = "Classical"
+    DANCE = "Dance"
+    DEEP = "Deep"
+    ELECTRONIC = "Electronic"
+    HIP_HOP = "Hip-Hop"
+    LATIN = "Latin"
+    LOUDNESS = "Loudness"
+    LOUNGE = "Lounge"
+    PIANO = "Piano"
+    R_B = "R&B"
+    ROCK = "Rock"
+    SMALL_SPEAKERS = "Small Speakers"
+    SPOKEN_WORD = "Spoken Word"
+    TREBLE_BOOSTER = "Treble Booster"
+    TREBLE_REDUCER = "Treble Reducer"
+    VOCAL_BOOSTER = "Vocal Booster"
 
 
 class PlayingStatus(StrEnum):

python_linkplay-0.2.1/src/linkplay/manufacturers.py

@@ -0,0 +1,74 @@
+"""Manufacturers and their devices for the LinkPlay component."""
+
+from typing import Final
+
+MANUFACTURER_ARTSOUND: Final[str] = "ArtSound"
+MANUFACTURER_ARYLIC: Final[str] = "Arylic"
+MANUFACTURER_IEAST: Final[str] = "iEAST"
+MANUFACTURER_WIIM: Final[str] = "WiiM"
+MANUFACTURER_GGMM: Final[str] = "GGMM"
+MANUFACTURER_MEDION: Final[str] = "Medion"
+MANUFACTURER_GENERIC: Final[str] = "Generic"
+MODELS_ARTSOUND_SMART_ZONE4: Final[str] = "Smart Zone 4 AMP"
+MODELS_ARTSOUND_SMART_HYDE: Final[str] = "Smart Hyde"
+MODELS_ARYLIC_S50: Final[str] = "S50+"
+MODELS_ARYLIC_S50_PRO: Final[str] = "S50 Pro"
+MODELS_ARYLIC_A30: Final[str] = "A30"
+MODELS_ARYLIC_A50: Final[str] = "A50"
+MODELS_ARYLIC_A50S: Final[str] = "A50+"
+MODELS_ARYLIC_UP2STREAM_AMP: Final[str] = "Up2Stream Amp 2.0"
+MODELS_ARYLIC_UP2STREAM_AMP_2P1: Final[str] = "Up2Stream Amp 2.1"
+MODELS_ARYLIC_UP2STREAM_AMP_V3: Final[str] = "Up2Stream Amp v3"
+MODELS_ARYLIC_UP2STREAM_AMP_V4: Final[str] = "Up2Stream Amp v4"
+MODELS_ARYLIC_UP2STREAM_PRO: Final[str] = "Up2Stream Pro v1"
+MODELS_ARYLIC_UP2STREAM_PRO_V3: Final[str] = "Up2Stream Pro v3"
+MODELS_ARYLIC_S10P: Final[str] = "Arylic S10+"
+MODELS_ARYLIC_UP2STREAM_PLATE_AMP: Final[str] = "Up2Stream Plate Amp"
+MODELS_IEAST_AUDIOCAST_M5: Final[str] = "AudioCast M5"
+MODELS_WIIM_AMP: Final[str] = "WiiM Amp"
+MODELS_WIIM_MINI: Final[str] = "WiiM Mini"
+MODELS_WIIM_PRO: Final[str] = "WiiM Pro"
+MODELS_GGMM_GGMM_E2: Final[str] = "GGMM E2"
+MODELS_MEDION_MD_43970: Final[str] = "Life P66970 (MD 43970)"
+MODELS_GENERIC: Final[str] = "Generic"
+
+PROJECTID_LOOKUP: Final[dict[str, tuple[str, str]]] = {
+    "SMART_ZONE4_AMP": (MANUFACTURER_ARTSOUND, MODELS_ARTSOUND_SMART_ZONE4),
+    "SMART_HYDE": (MANUFACTURER_ARTSOUND, MODELS_ARTSOUND_SMART_HYDE),
+    "ARYLIC_S50": (MANUFACTURER_ARYLIC, MODELS_ARYLIC_S50),
+    "RP0016_S50PRO_S": (MANUFACTURER_ARYLIC, MODELS_ARYLIC_S50_PRO),
+    "RP0011_WB60_S": (MANUFACTURER_ARYLIC, MODELS_ARYLIC_A30),
+    "X-50": (MANUFACTURER_ARYLIC, MODELS_ARYLIC_A50),
+    "ARYLIC_A50S": (MANUFACTURER_ARYLIC, MODELS_ARYLIC_A50S),
+    "RP0011_WB60": (MANUFACTURER_ARYLIC, MODELS_ARYLIC_UP2STREAM_AMP),
+    "UP2STREAM_AMP_V3": (MANUFACTURER_ARYLIC, MODELS_ARYLIC_UP2STREAM_AMP_V3),
+    "UP2STREAM_AMP_V4": (MANUFACTURER_ARYLIC, MODELS_ARYLIC_UP2STREAM_AMP_V4),
+    "UP2STREAM_PRO_V3": (MANUFACTURER_ARYLIC, MODELS_ARYLIC_UP2STREAM_PRO_V3),
+    "S10P_WIFI": (MANUFACTURER_ARYLIC, MODELS_ARYLIC_S10P),
+    "ARYLIC_V20": (MANUFACTURER_ARYLIC, MODELS_ARYLIC_UP2STREAM_PLATE_AMP),
+    "UP2STREAM_MINI_V3": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "UP2STREAM_AMP_2P1": (MANUFACTURER_ARYLIC, MODELS_ARYLIC_UP2STREAM_AMP_2P1),
+    "RP0014_A50C_S": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "ARYLIC_A30": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "ARYLIC_SUBWOOFER": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "ARYLIC_S50A": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "RP0010_D5_S": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "RP0001": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "RP0013_WA31S": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "RP0010_D5": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "RP0013_WA31S_S": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "RP0014_A50D_S": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "ARYLIC_A50TE": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "ARYLIC_A50N": (MANUFACTURER_ARYLIC, MODELS_GENERIC),
+    "iEAST-02": (MANUFACTURER_IEAST, MODELS_IEAST_AUDIOCAST_M5),
+    "WiiM_Amp_4layer": (MANUFACTURER_WIIM, MODELS_WIIM_AMP),
+    "WiiM_Pro_with_gc4a": (MANUFACTURER_WIIM, MODELS_WIIM_PRO),
+    "Muzo_Mini": (MANUFACTURER_WIIM, MODELS_WIIM_MINI),
+    "GGMM_E2A": (MANUFACTURER_GGMM, MODELS_GGMM_GGMM_E2),
+    "A16": (MANUFACTURER_MEDION, MODELS_MEDION_MD_43970),
+}
+
+
+def get_info_from_project(project: str) -> tuple[str, str]:
+    """Get manufacturer and model info based on given project."""
+    return PROJECTID_LOOKUP.get(project, (MANUFACTURER_GENERIC, MODELS_GENERIC))

{python_linkplay-0.1.3 → python_linkplay-0.2.1}/src/linkplay/utils.py

@@ -19,6 +19,7 @@ from linkplay.consts import (
     API_TIMEOUT,
     MTLS_CERTIFICATE_CONTENTS,
     TCP_MESSAGE_LENGTH,
+    EqualizerMode,
     PlayerAttribute,
     PlayingStatus,
 )
@@ -241,3 +242,35 @@ def fixup_player_properties(
         properties[PlayerAttribute.PLAYING_STATUS] = PlayingStatus.STOPPED
 
     return properties
+
+
+def equalizer_mode_to_number_mapping(equalizer_mode: EqualizerMode) -> str | None:
+    """Converts EqualizerMode to a number mapping."""
+    match equalizer_mode:
+        case EqualizerMode.NONE:
+            return "0"
+        case EqualizerMode.CLASSIC:
+            return "1"
+        case EqualizerMode.POP:
+            return "2"
+        case EqualizerMode.JAZZ:
+            return "3"
+        case EqualizerMode.VOCAL:
+            return "4"
+    return None
+
+
+def equalizer_mode_from_number_mapping(value: str | None) -> EqualizerMode | None:
+    """Converts a number mapping to EqualizerMode."""
+    match value:
+        case "0":
+            return EqualizerMode.NONE
+        case "1":
+            return EqualizerMode.CLASSIC
+        case "2":
+            return EqualizerMode.POP
+        case "3":
+            return EqualizerMode.JAZZ
+        case "4":
+            return EqualizerMode.VOCAL
+    return None

{python_linkplay-0.1.3 → python_linkplay-0.2.1/src/python_linkplay.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: python_linkplay
-Version: 0.1.3
+Version: 0.2.1
 Summary: A Python Library for Seamless LinkPlay Device Control
 Author: Velleman Group nv
 License: MIT
@@ -24,12 +24,13 @@ Requires-Dist: ruff>=0.5.4; extra == "testing"
 Requires-Dist: tox>=4.6.0; extra == "testing"
 Requires-Dist: typing-extensions>=4.6.3; extra == "testing"
 Requires-Dist: pre-commit>=3.8.0; extra == "testing"
-
+Dynamic: license-file
 
 [![PyPI package](https://badge.fury.io/py/python-linkplay.svg)](https://pypi.org/project/python-linkplay/)
 [![Release](https://github.com/velleman/python-linkplay/actions/workflows/release.yaml/badge.svg)](https://github.com/velleman/python-linkplay/actions/workflows/release.yaml)
 
 # python-linkplay
+
 A Python Library for Seamless LinkPlay Device Control
 
 ## Intro
@@ -54,6 +55,9 @@ Welcome to python-linkplay, a powerful and user-friendly Python library designed
 - 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
+- https://github.com/DanBrezeanu/wiim-extended-http-api
+- https://github.com/cvdlinden/wiim-httpapi
 
 ## Multiroom
 

{python_linkplay-0.1.3 → python_linkplay-0.2.1}/src/python_linkplay.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ src/linkplay/controller.py
 src/linkplay/discovery.py
 src/linkplay/endpoint.py
 src/linkplay/exceptions.py
+src/linkplay/manufacturers.py
 src/linkplay/utils.py
 src/python_linkplay.egg-info/PKG-INFO
 src/python_linkplay.egg-info/SOURCES.txt

python_linkplay-0.1.3/src/linkplay/__version__.py

@@ -1 +0,0 @@
-__version__ = '0.1.3'