denonavr 0.11.6__py3-none-any.whl → 1.0.1__py3-none-any.whl

denonavr/const.py

@@ -43,6 +43,17 @@ ReceiverURLs = namedtuple(
         "command_set_all_zone_stereo",
         "command_pause",
         "command_play",
+        "command_cusor_up",
+        "command_cusor_down",
+        "command_cusor_left",
+        "command_cusor_right",
+        "command_cusor_enter",
+        "command_back",
+        "command_info",
+        "command_options",
+        "command_setup_open",
+        "command_setup_close",
+        "command_setup_query",
     ],
 )
 TelnetCommands = namedtuple(
@@ -68,6 +79,17 @@ TelnetCommands = namedtuple(
         "command_tonecontrol",
         "command_bass",
         "command_treble",
+        "command_cusor_up",
+        "command_cusor_down",
+        "command_cusor_left",
+        "command_cusor_right",
+        "command_cusor_enter",
+        "command_back",
+        "command_info",
+        "command_options",
+        "command_setup_open",
+        "command_setup_close",
+        "command_setup_query",
     ],
 )
 
@@ -168,40 +190,40 @@ ALL_ZONE_STEREO = "ALL ZONE STEREO"
 
 SOUND_MODE_MAPPING = {
     "MUSIC": [
-        "PLII MUSIC",
-        "DTS NEO:6 MUSIC",
+        "DOLBY D +NEO:X M",
+        "DOLBY PL2 M",
+        "DOLBY PL2 MUSIC",
+        "DOLBY PL2 X MUSIC",
         "DTS NEO:6 M",
+        "DTS NEO:6 MUSIC",
         "DTS NEO:X M",
-        "DOLBY D +NEO:X M",
         "DTS NEO:X MUSIC",
-        "DOLBY PL2 MUSIC",
-        "DOLBY PL2 M",
+        "PLII MUSIC",
         "PLIIX MUSIC",
-        "DOLBY PL2 X MUSIC",
     ],
     "MOVIE": [
-        "PLII MOVIE",
-        "PLII CINEMA",
-        "DTS NEO:X CINEMA",
-        "DTS NEO:X C",
-        "DTS NEO:6 CINEMA",
-        "DTS NEO:6 C",
         "DOLBY D +NEO:X C",
-        "PLIIX CINEMA",
-        "DOLBY PLII MOVIE",
-        "MULTI IN + VIRTUAL:X",
-        "DOLBY PL2 CINEMA",
         "DOLBY PL2 C",
-        "DOLBY PL2 X MOVIE",
+        "DOLBY PL2 CINEMA",
         "DOLBY PL2 MOVIE",
+        "DOLBY PL2 X MOVIE",
+        "DOLBY PLII MOVIE",
+        "DTS NEO:6 C",
+        "DTS NEO:6 CINEMA",
+        "DTS NEO:X C",
+        "DTS NEO:X CINEMA",
+        "MULTI IN + VIRTUAL:X",
+        "PLII CINEMA",
+        "PLII MOVIE",
+        "PLIIX CINEMA",
     ],
     "GAME": [
-        "PLII GAME",
         "DOLBY D +NEO:X G",
-        "DOLBY PL2 GAME",
         "DOLBY PL2 G",
+        "DOLBY PL2 GAME",
         "DOLBY PL2 X GAME",
         "DOLBY PLII GAME",
+        "PLII GAME",
     ],
     "AUTO": ["None"],
     "STANDARD": ["None2"],
@@ -214,64 +236,74 @@ SOUND_MODE_MAPPING = {
     "DIRECT": ["DIRECT"],
     "PURE DIRECT": ["PURE_DIRECT", "PURE DIRECT"],
     "DOLBY DIGITAL": [
-        "DOLBY DIGITAL",
-        "DOLBY D + DOLBY SURROUND",
-        "DOLBY D+DS",
-        "DOLBY D+ +DS",
-        "DOLBY DIGITAL +",
-        "STANDARD(DOLBY)",
-        "DOLBY SURROUND",
-        "DOLBY D + +DOLBY SURROUND",
-        "NEURAL",
-        "NEURAL:X",
-        "DOLBY HD",
-        "DOLBY HD + DOLBY SURROUND",
-        "MULTI IN + DSUR",
-        "MULTI IN + NEURAL:X",
-        "MULTI IN + DOLBY SURROUND",
-        "DOLBY D + NEURAL:X",
-        "DOLBY DIGITAL + NEURAL:X",
-        "DOLBY DIGITAL + + NEURAL:X",
         "DOLBY ATMOS",
-        "DOLBY AUDIO - DOLBY SURROUND",
-        "DOLBY TRUEHD",
+        "DOLBY AUDIO - DD + DSUR",
+        "DOLBY AUDIO - DD + NEURAL:X",
+        "DOLBY AUDIO - DD+   + DSUR",
+        "DOLBY AUDIO - DD+   + NEURAL:X",
         "DOLBY AUDIO - DOLBY DIGITAL PLUS",
-        "DOLBY AUDIO - TRUEHD + DSUR",
+        "DOLBY AUDIO - DOLBY DIGITAL",
+        "DOLBY AUDIO - DOLBY SURROUND",
         "DOLBY AUDIO - DOLBY TRUEHD",
+        "DOLBY AUDIO - TRUEHD + DSUR",
         "DOLBY AUDIO - TRUEHD + NEURAL:X",
-        "DOLBY AUDIO - DD + NEURAL:X",
-        "DOLBY AUDIO - DD + DSUR",
-        "DOLBY AUDIO - DD+   + NEURAL:X",
-        "DOLBY AUDIO - DD+   + DSUR",
+        "DOLBY AUDIO-DD",
         "DOLBY AUDIO-DD+ +DSUR",
-        "DOLBY AUDIO - DOLBY DIGITAL",
-        "DOLBY AUDIO-DSUR",
+        "DOLBY AUDIO-DD+ +NEURAL:X",
+        "DOLBY AUDIO-DD+",
         "DOLBY AUDIO-DD+DSUR",
+        "DOLBY AUDIO-DSUR",
+        "DOLBY AUDIO-TRUEHD",
+        "DOLBY AUDIO-TRUEHD+DSUR",
+        "DOLBY AUDIO-TRUEHD+NEURAL:X",
+        "DOLBY D + +DOLBY SURROUND",
+        "DOLBY D + DOLBY SURROUND",
+        "DOLBY D + NEURAL:X",
+        "DOLBY D+ +DS",
+        "DOLBY D+",
+        "DOLBY D+DS",
+        "DOLBY DIGITAL + + NEURAL:X",
+        "DOLBY DIGITAL + NEURAL:X",
+        "DOLBY DIGITAL +",
+        "DOLBY DIGITAL",
+        "DOLBY HD + DOLBY SURROUND",
+        "DOLBY HD",
         "DOLBY PRO LOGIC",
+        "DOLBY SURROUND",
+        "DOLBY TRUEHD",
+        "MULTI IN + DOLBY SURROUND",
+        "MULTI IN + DSUR",
+        "MULTI IN + NEURAL:X",
+        "NEURAL",
+        "STANDARD(DOLBY)",
     ],
     "DTS SURROUND": [
-        "DTS SURROUND",
-        "DTS NEURAL:X",
-        "STANDARD(DTS)",
+        "DTS + DOLBY SURROUND",
         "DTS + NEURAL:X",
-        "MULTI CH IN",
-        "DTS-HD MSTR",
-        "DTS VIRTUAL:X",
-        "DTS-HD + NEURAL:X",
-        "DTS-HD",
         "DTS + VIRTUAL:X",
-        "DTS + DOLBY SURROUND",
+        "DTS NEURAL:X",
+        "DTS SURROUND",
+        "DTS VIRTUAL:X",
         "DTS-HD + DOLBY SURROUND",
         "DTS-HD + DSUR",
+        "DTS-HD + NEURAL:X",
+        "DTS-HD MSTR",
+        "DTS-HD",
         "DTS:X MSTR",
+        "DTS:X",
+        "M CH IN+DSUR",
+        "MULTI CH IN",
+        "NEURAL:X",
+        "STANDARD(DTS)",
+        "VIRTUAL:X",
     ],
-    "AURO3D": ["AURO-3D"],
-    "AURO2DSURR": ["AURO-2D SURROUND"],
+    "AURO3D": ["AURO-3D", "AURO3D"],
+    "AURO2DSURR": ["AURO-2D SURROUND", "AURO2DSURR"],
     "MCH STEREO": [
-        "MULTI CH STEREO",
-        "MULTI_CH_STEREO",
         "MCH STEREO",
         "MULTI CH IN 7.1",
+        "MULTI CH STEREO",
+        "MULTI_CH_STEREO",
     ],
     "STEREO": ["STEREO"],
     ALL_ZONE_STEREO: ["ALL ZONE STEREO"],
@@ -327,6 +359,17 @@ COMMAND_MUTE_ON_URL = "/goform/formiPhoneAppMute.xml?1+MuteOn"
 COMMAND_MUTE_OFF_URL = "/goform/formiPhoneAppMute.xml?1+MuteOff"
 COMMAND_SEL_SM_URL = "/goform/formiPhoneAppDirect.xml?MS"
 COMMAND_SET_ZST_URL = "/goform/formiPhoneAppDirect.xml?MN"
+COMMAND_CURSOR_UP = "/goform/formiPhoneAppDirect.xml?MNCUP"
+COMMAND_CURSOR_DOWN = "/goform/formiPhoneAppDirect.xml?MNCDN"
+COMMAND_CURSOR_LEFT = "/goform/formiPhoneAppDirect.xml?MNCLT"
+COMMAND_CURSOR_RIGHT = "/goform/formiPhoneAppDirect.xml?MNCRT"
+COMMAND_CURSOR_ENTER = "/goform/formiPhoneAppDirect.xml?MNENT"
+COMMAND_BACK = "/goform/formiPhoneAppDirect.xml?MNRTN"
+COMMAND_INFO = "/goform/formiPhoneAppDirect.xml?MNINF"
+COMMAND_OPTIONS = "/goform/formiPhoneAppDirect.xml?MNOPT"
+COMMAND_SETUP_OPEN = "/goform/formiPhoneAppDirect.xml?MNMEN%20ON"
+COMMAND_SETUP_CLOSE = "/goform/formiPhoneAppDirect.xml?MNMEN%20OFF"
+COMMAND_SETUP_QUERY = "/goform/formiPhoneAppDirect.xml?MNMEN?"
 
 # Zone 2 URLs
 STATUS_Z2_URL = "/goform/formZone2_Zone2XmlStatus.xml"
@@ -375,6 +418,17 @@ DENONAVR_URLS = ReceiverURLs(
     command_set_all_zone_stereo=COMMAND_SET_ZST_URL,
     command_pause=COMMAND_PAUSE,
     command_play=COMMAND_PLAY,
+    command_cusor_up=COMMAND_CURSOR_UP,
+    command_cusor_down=COMMAND_CURSOR_DOWN,
+    command_cusor_left=COMMAND_CURSOR_LEFT,
+    command_cusor_right=COMMAND_CURSOR_RIGHT,
+    command_cusor_enter=COMMAND_CURSOR_ENTER,
+    command_back=COMMAND_BACK,
+    command_info=COMMAND_INFO,
+    command_options=COMMAND_OPTIONS,
+    command_setup_open=COMMAND_SETUP_OPEN,
+    command_setup_close=COMMAND_SETUP_CLOSE,
+    command_setup_query=COMMAND_SETUP_QUERY,
 )
 
 ZONE2_URLS = ReceiverURLs(
@@ -400,6 +454,17 @@ ZONE2_URLS = ReceiverURLs(
     command_set_all_zone_stereo=COMMAND_SET_ZST_URL,
     command_pause=COMMAND_PAUSE,
     command_play=COMMAND_PLAY,
+    command_cusor_up=COMMAND_CURSOR_UP,
+    command_cusor_down=COMMAND_CURSOR_DOWN,
+    command_cusor_left=COMMAND_CURSOR_LEFT,
+    command_cusor_right=COMMAND_CURSOR_RIGHT,
+    command_cusor_enter=COMMAND_CURSOR_ENTER,
+    command_back=COMMAND_BACK,
+    command_info=COMMAND_INFO,
+    command_options=COMMAND_OPTIONS,
+    command_setup_open=COMMAND_SETUP_OPEN,
+    command_setup_close=COMMAND_SETUP_CLOSE,
+    command_setup_query=COMMAND_SETUP_QUERY,
 )
 
 ZONE3_URLS = ReceiverURLs(
@@ -425,6 +490,17 @@ ZONE3_URLS = ReceiverURLs(
     command_set_all_zone_stereo=COMMAND_SET_ZST_URL,
     command_pause=COMMAND_PAUSE,
     command_play=COMMAND_PLAY,
+    command_cusor_up=COMMAND_CURSOR_UP,
+    command_cusor_down=COMMAND_CURSOR_DOWN,
+    command_cusor_left=COMMAND_CURSOR_LEFT,
+    command_cusor_right=COMMAND_CURSOR_RIGHT,
+    command_cusor_enter=COMMAND_CURSOR_ENTER,
+    command_back=COMMAND_BACK,
+    command_info=COMMAND_INFO,
+    command_options=COMMAND_OPTIONS,
+    command_setup_open=COMMAND_SETUP_OPEN,
+    command_setup_close=COMMAND_SETUP_CLOSE,
+    command_setup_query=COMMAND_SETUP_QUERY,
 )
 
 # Telnet Events
@@ -503,6 +579,17 @@ DENONAVR_TELNET_COMMANDS = TelnetCommands(
     command_tonecontrol="PSTONE CTRL ",
     command_bass="PSBAS ",
     command_treble="PSTRE ",
+    command_cusor_up="MNCUP",
+    command_cusor_down="MNCDN",
+    command_cusor_left="MNCLT",
+    command_cusor_right="MNCRT",
+    command_cusor_enter="MNENT",
+    command_back="MNRTN",
+    command_info="MNINF",
+    command_options="MNOPT",
+    command_setup_open="MNMEN ON",
+    command_setup_close="MNMEN OFF",
+    command_setup_query="MNMEN?",
 )
 
 ZONE2_TELNET_COMMANDS = TelnetCommands(
@@ -526,6 +613,17 @@ ZONE2_TELNET_COMMANDS = TelnetCommands(
     command_tonecontrol="PSTONE CTRL ",
     command_bass="PSBAS ",
     command_treble="PSTRE ",
+    command_cusor_up="MNCUP",
+    command_cusor_down="MNCDN",
+    command_cusor_left="MNCLT",
+    command_cusor_right="MNCRT",
+    command_cusor_enter="MNENT",
+    command_back="MNRTN",
+    command_info="MNINF",
+    command_options="MNOPT",
+    command_setup_open="MNMEN ON",
+    command_setup_close="MNMEN OFF",
+    command_setup_query="MNMEN?",
 )
 
 ZONE3_TELNET_COMMANDS = TelnetCommands(
@@ -549,6 +647,17 @@ ZONE3_TELNET_COMMANDS = TelnetCommands(
     command_tonecontrol="PSTONE CTRL ",
     command_bass="PSBAS ",
     command_treble="PSTRE ",
+    command_cusor_up="MNCUP",
+    command_cusor_down="MNCDN",
+    command_cusor_left="MNCLT",
+    command_cusor_right="MNCRT",
+    command_cusor_enter="MNENT",
+    command_back="MNRTN",
+    command_info="MNINF",
+    command_options="MNOPT",
+    command_setup_open="MNMEN ON",
+    command_setup_close="MNMEN OFF",
+    command_setup_query="MNMEN?",
 )
 
 # States

denonavr/decorators.py

@@ -7,18 +7,14 @@ This module implements the REST API to Denon AVR receivers.
 :license: MIT, see LICENSE for more details.
 """
 
-import asyncio
 import inspect
 import logging
 import time
-import xml.etree.ElementTree as ET
 from functools import wraps
-from typing import Callable, Coroutine, TypeVar
+from typing import Callable, TypeVar
 
 import httpx
 from asyncstdlib import lru_cache
-from defusedxml import DefusedXmlException
-from defusedxml.ElementTree import ParseError
 
 from .exceptions import (
     AvrForbiddenError,
@@ -34,118 +30,55 @@ AnyT = TypeVar("AnyT")
 
 
 def async_handle_receiver_exceptions(func: Callable[..., AnyT]) -> Callable[..., AnyT]:
-    """
-    Handle exceptions raised when calling a Denon AVR endpoint asynchronously.
-
-    The decorated function must either have a string variable as second
-    argument or as "request" keyword argument.
-    """
+    """Handle exceptions raised when calling a Denon AVR endpoint asynchronously."""
 
     @wraps(func)
     async def wrapper(*args, **kwargs):
         try:
             return await func(*args, **kwargs)
         except httpx.HTTPStatusError as err:
-            _LOGGER.debug("HTTP status error on request %s", err.request, exc_info=True)
+            _LOGGER.debug("HTTP status error on request %s: %s", err.request, err)
             # Separate handling of 403 errors
             if err.response.status_code == 403:
                 raise AvrForbiddenError(f"HTTPStatusError: {err}", err.request) from err
             raise AvrRequestError(f"HTTPStatusError: {err}", err.request) from err
         except httpx.TimeoutException as err:
-            _LOGGER.debug(
-                "HTTP timeout exception on request %s", err.request, exc_info=True
-            )
+            _LOGGER.debug("HTTP timeout exception on request %s: %s", err.request, err)
             raise AvrTimoutError(f"TimeoutException: {err}", err.request) from err
         except httpx.NetworkError as err:
-            _LOGGER.debug(
-                "Network error exception on request %s", err.request, exc_info=True
-            )
+            _LOGGER.debug("Network error exception on request %s: %s", err.request, err)
             raise AvrNetworkError(f"NetworkError: {err}", err.request) from err
         except httpx.RemoteProtocolError as err:
             _LOGGER.debug(
                 "Remote protocol error exception on request %s",
                 err.request,
-                exc_info=True,
             )
             raise AvrInvalidResponseError(
                 f"RemoteProtocolError: {err}", err.request
             ) from err
-        except (
-            ET.ParseError,
-            DefusedXmlException,
-            ParseError,
-            UnicodeDecodeError,
-        ) as err:
-            _LOGGER.debug(
-                "Defusedxml parse error on request %s", (args, kwargs), exc_info=True
-            )
-            raise AvrInvalidResponseError(
-                f"XMLParseError: {err}", (args, kwargs)
-            ) from err
 
     return wrapper
 
 
 def cache_result(func: Callable[..., AnyT]) -> Callable[..., AnyT]:
     """
-    Decorate a function to cache its results with an lru_cache of maxsize 16.
+    Decorate a function to cache its results with an lru_cache of maxsize 32.
 
     This decorator also sets an "cache_id" keyword argument if it is not set yet.
-    When an exception occurs it clears lru_cache to prevent memory leaks in
-    home-assistant when receiver instances are created and deleted right
-    away in case the device is offline on setup.
     """
     if inspect.signature(func).parameters.get("cache_id") is None:
         raise AttributeError(
             f"Function {func} does not have a 'cache_id' keyword parameter"
         )
 
-    lru_decorator = lru_cache(maxsize=16)
+    lru_decorator = lru_cache(maxsize=32)
     cached_func = lru_decorator(func)
 
     @wraps(func)
     async def wrapper(*args, **kwargs):
         if kwargs.get("cache_id") is None:
             kwargs["cache_id"] = time.time()
-        try:
-            return await cached_func(*args, **kwargs)
-        except Exception as err:
-            _LOGGER.debug("Exception %s raised, clearing cache", err)
-            cached_func.cache_clear()
-            raise
 
-    return wrapper
-
-
-def run_async_synchronously(async_func: Coroutine) -> Callable:
-    """
-    Decorate to run the configured asynchronous function synchronously instead.
-
-    If available the corresponding function with async_ prefix is called in an
-    own event loop. This is not efficient but it ensures backwards
-    compatibility of this library.
-    """
+        return await cached_func(*args, **kwargs)
 
-    def decorator(func: Callable):
-        # Check if function is a coroutine
-        if not inspect.iscoroutinefunction(async_func):
-            raise AttributeError(f"Function {async_func} is not a coroutine function")
-        # Check if the signature of both functions is equal
-        if inspect.signature(func) != inspect.signature(async_func):
-            raise AttributeError(
-                f"Functions {func} and {async_func} have different signatures"
-            )
-
-        @wraps(func)
-        def wrapper(*args, **kwargs):
-            # Run async function in own event loop
-            loop = asyncio.new_event_loop()
-
-            try:
-                return loop.run_until_complete(async_func(*args, **kwargs))
-            finally:
-                loop.close()
-
-        return wrapper
-
-    return decorator
+    return wrapper