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

denonavr/foundation.py

@@ -10,8 +10,9 @@ This module implements the foundation classes for Denon AVR receivers.
 import asyncio
 import logging
 import xml.etree.ElementTree as ET
+from collections.abc import Hashable
 from copy import deepcopy
-from typing import Dict, Hashable, List, Optional
+from typing import Dict, List, Optional, Union
 
 import attr
 import httpx
@@ -25,19 +26,24 @@ from .const import (
     AVR_X,
     AVR_X_2016,
     DENON_ATTR_SETATTR,
+    DENONAVR_TELNET_COMMANDS,
     DENONAVR_URLS,
     DESCRIPTION_TYPES,
     DEVICEINFO_AVR_X_PATTERN,
     DEVICEINFO_COMMAPI_PATTERN,
     MAIN_ZONE,
+    POWER_STATES,
     VALID_RECEIVER_TYPES,
     VALID_ZONES,
     ZONE2,
+    ZONE2_TELNET_COMMANDS,
     ZONE2_URLS,
     ZONE3,
+    ZONE3_TELNET_COMMANDS,
     ZONE3_URLS,
     ReceiverType,
     ReceiverURLs,
+    TelnetCommands,
 )
 from .exceptions import (
     AvrForbiddenError,
@@ -70,6 +76,9 @@ class DenonAVRDeviceInfo:
         validator=attr.validators.optional(attr.validators.in_(VALID_RECEIVER_TYPES)),
         default=None,
     )
+    telnet_commands: TelnetCommands = attr.ib(
+        validator=attr.validators.instance_of(TelnetCommands), init=False
+    )
     urls: ReceiverURLs = attr.ib(
         validator=attr.validators.instance_of(ReceiverURLs), init=False
     )
@@ -95,26 +104,29 @@ class DenonAVRDeviceInfo:
         converter=attr.converters.optional(str), default=None
     )
     _is_setup: bool = attr.ib(converter=bool, default=False, init=False)
-    _allow_recovery: bool = attr.ib(converter=bool, default=False, init=False)
+    _allow_recovery: bool = attr.ib(converter=bool, default=True, init=True)
     _setup_lock: asyncio.Lock = attr.ib(default=attr.Factory(asyncio.Lock))
 
     def __attrs_post_init__(self) -> None:
         """Initialize special attributes and callbacks."""
         # URLs depending from value of self.zone attribute
         if self.zone == MAIN_ZONE:
+            self.telnet_commands = DENONAVR_TELNET_COMMANDS
             self.urls = DENONAVR_URLS
         elif self.zone == ZONE2:
+            self.telnet_commands = ZONE2_TELNET_COMMANDS
             self.urls = ZONE2_URLS
         elif self.zone == ZONE3:
+            self.telnet_commands = ZONE3_TELNET_COMMANDS
             self.urls = ZONE3_URLS
         else:
-            raise ValueError("Invalid zone {}".format(self.zone))
+            raise ValueError(f"Invalid zone {self.zone}")
 
     async def _async_power_callback(
         self, zone: str, event: str, parameter: str
     ) -> None:
         """Handle a power change event."""
-        if self.zone == zone:
+        if self.zone == zone and parameter in POWER_STATES:
             self._power = parameter
 
     def get_own_zone(self) -> str:
@@ -146,7 +158,12 @@ class DenonAVRDeviceInfo:
             # Add tags for a potential AppCommand.xml update
             self.api.add_appcommand_update_tag(AppCommands.GetAllZonePowerStatus)
 
-            self.telnet_api.register_callback("PW", self._async_power_callback)
+            power_event = "ZM"
+            if self.zone == ZONE2:
+                power_event = "Z2"
+            elif self.zone == ZONE3:
+                power_event = "Z3"
+            self.telnet_api.register_callback(power_event, self._async_power_callback)
 
             self._is_setup = True
 
@@ -155,7 +172,7 @@ class DenonAVRDeviceInfo:
     ) -> None:
         """Update status asynchronously."""
         # Ensure instance is setup before updating
-        if self._is_setup is False:
+        if not self._is_setup:
             await self.async_setup()
 
         # Update power status
@@ -163,7 +180,7 @@ class DenonAVRDeviceInfo:
 
     async def async_identify_receiver(self) -> None:
         """Identify receiver asynchronously."""
-        # Test Deviceinfo.xml if receiver is a AVR-X with port 80 for pre 2016
+        # Test Deviceinfo.xml if receiver is an AVR-X with port 80 for pre 2016
         # devices and port 8080 devices 2016 and later
         # 2016 models has also some of the XML but not all, try first 2016
         r_types = [AVR_X, AVR_X_2016]
@@ -184,15 +201,17 @@ class DenonAVRDeviceInfo:
                     exc_info=err,
                 )
 
-                # Raise error only when occured at both types
+                # Raise error only when occurred at both types
                 timeout_errors += 1
                 if timeout_errors == len(r_types):
                     raise
 
             except AvrRequestError as err:
                 _LOGGER.debug(
-                    "Request error on port %s when identifying receiver, "
-                    "device is not a %s receivers",
+                    (
+                        "Request error on port %s when identifying receiver, "
+                        "device is not a %s receivers"
+                    ),
                     r_type.port,
                     r_type.type,
                     exc_info=err,
@@ -204,13 +223,13 @@ class DenonAVRDeviceInfo:
                     # Receiver identified, return
                     return
 
-        # If check of Deviceinfo.xml was not successfull, receiver is type AVR
+        # If check of Deviceinfo.xml was not successful, receiver is type AVR
         self.receiver = AVR
         self.api.port = AVR.port
 
     @staticmethod
     def _is_avr_x(deviceinfo: ET.Element) -> bool:
-        """Evaluate Deviceinfo.xml if the device is a AVR-X device."""
+        """Evaluate Deviceinfo.xml if the device is an AVR-X device."""
         # First test by CommApiVers
         try:
             if bool(
@@ -270,7 +289,7 @@ class DenonAVRDeviceInfo:
                 _LOGGER.info("AVR-X device, using AppCommand.xml interface")
                 self._set_friendly_name(xml)
 
-        if self.use_avr_2016_update is False:
+        if not self.use_avr_2016_update:
             try:
                 xml = await self.api.async_get_xml(self.urls.mainzone)
             except (AvrTimoutError, AvrNetworkError) as err:
@@ -294,7 +313,7 @@ class DenonAVRDeviceInfo:
     ) -> None:
         """Verify if avr 2016 update method is working."""
         # Nothing to do if Appcommand.xml interface is not supported
-        if self.use_avr_2016_update is False:
+        if self._is_setup and not self.use_avr_2016_update:
             return
 
         try:
@@ -306,7 +325,7 @@ class DenonAVRDeviceInfo:
         except AvrForbiddenError:
             # Recovery in case receiver changes port from 80 to 8080 which
             # might happen at Denon AVR-X 2016 receivers
-            if self._allow_recovery is True:
+            if self._allow_recovery:
                 self._allow_recovery = False
                 _LOGGER.warning(
                     "AppCommand.xml returns HTTP status 403. Running setup"
@@ -328,7 +347,7 @@ class DenonAVRDeviceInfo:
                 )
                 self.use_avr_2016_update = False
         else:
-            if self._allow_recovery is False:
+            if not self._allow_recovery:
                 _LOGGER.info("AppCommand.xml recovered from HTTP status 403 error")
             self._allow_recovery = True
 
@@ -353,9 +372,7 @@ class DenonAVRDeviceInfo:
         """Get device information."""
         port = DESCRIPTION_TYPES[self.receiver.type].port
         command = DESCRIPTION_TYPES[self.receiver.type].url
-        url = "http://{host}:{port}{command}".format(
-            host=self.api.host, port=port, command=command
-        )
+        url = f"http://{self.api.host}:{port}{command}"
 
         device_info = None
         try:
@@ -368,8 +385,10 @@ class DenonAVRDeviceInfo:
             raise
         except AvrRequestError as err:
             _LOGGER.error(
-                "During DenonAVR device identification, when trying to request"
-                " %s the following error occurred: %s",
+                (
+                    "During DenonAVR device identification, when trying to request"
+                    " %s the following error occurred: %s"
+                ),
                 url,
                 err,
             )
@@ -381,9 +400,11 @@ class DenonAVRDeviceInfo:
             self.model_name = "Unknown"
             self.serial_number = None
             _LOGGER.warning(
-                "Unable to get device information of host %s, Device might be "
-                "in a corrupted state. Continuing without device information. "
-                "Disconnect and reconnect power to the device and try again.",
+                (
+                    "Unable to get device information of host %s, Device might be "
+                    "in a corrupted state. Continuing without device information. "
+                    "Disconnect and reconnect power to the device and try again."
+                ),
                 self.api.host,
             )
             return
@@ -398,16 +419,17 @@ class DenonAVRDeviceInfo:
         self, global_update: bool = False, cache_id: Optional[Hashable] = None
     ) -> None:
         """Update power status of device."""
-        if self.use_avr_2016_update is True:
+        if self.use_avr_2016_update is None:
+            raise AvrProcessingError(
+                "Device is not setup correctly, update method not set"
+            )
+
+        if self.use_avr_2016_update:
             await self.async_update_power_appcommand(
                 global_update=global_update, cache_id=cache_id
             )
-        elif self.use_avr_2016_update is False:
-            await self.async_update_power_status_xml(cache_id=cache_id)
         else:
-            raise AvrProcessingError(
-                "Device is not setup correctly, update method not set"
-            )
+            await self.async_update_power_status_xml(cache_id=cache_id)
 
     async def async_update_power_appcommand(
         self, global_update: bool = False, cache_id: Optional[Hashable] = None
@@ -430,14 +452,12 @@ class DenonAVRDeviceInfo:
 
         # Search for power tag
         power_tag = xml.find(
-            "./cmd[@{attribute}='{cmd}']/{zone}".format(
-                attribute=APPCOMMAND_CMD_TEXT, cmd=power_appcommand.cmd_text, zone=zone
-            )
+            f"./cmd[@{APPCOMMAND_CMD_TEXT}='{power_appcommand.cmd_text}']/{zone}"
         )
 
         if power_tag is None:
             raise AvrProcessingError(
-                "Power attribute of zone {} not found on update".format(self.zone)
+                f"Power attribute of zone {self.zone} not found on update"
             )
 
         self._power = power_tag.text
@@ -451,7 +471,7 @@ class DenonAVRDeviceInfo:
         if self.zone == MAIN_ZONE:
             urls.append(self.urls.mainzone)
         else:
-            urls.append("{}?ZoneName={}".format(self.urls.mainzone, self.zone))
+            urls.append(f"{self.urls.mainzone}?ZoneName={self.zone}")
         # Tags in XML which might contain information about zones power status
         # ordered by their priority
         tags = ["./ZonePower/value", "./Power/value"]
@@ -473,7 +493,7 @@ class DenonAVRDeviceInfo:
                     return
 
         raise AvrProcessingError(
-            "Power attribute of zone {} not found on update".format(self.zone)
+            f"Power attribute of zone {self.zone} not found on update"
         )
 
     ##############
@@ -488,17 +508,32 @@ class DenonAVRDeviceInfo:
         """
         return self._power
 
+    @property
+    def telnet_available(self) -> bool:
+        """Return true if telnet is connected and healthy."""
+        return self.telnet_api.connected and self.telnet_api.healthy
+
     ##########
     # Setter #
     ##########
 
     async def async_power_on(self) -> None:
         """Turn on receiver via HTTP get command."""
-        await self.api.async_get_command(self.urls.command_power_on)
+        if self.telnet_available:
+            await self.telnet_api.async_send_commands(
+                self.telnet_commands.command_power_on
+            )
+        else:
+            await self.api.async_get_command(self.urls.command_power_on)
 
     async def async_power_off(self) -> None:
         """Turn off receiver via HTTP get command."""
-        await self.api.async_get_command(self.urls.command_power_standby)
+        if self.telnet_available:
+            await self.telnet_api.async_send_commands(
+                self.telnet_commands.command_power_standby
+            )
+        else:
+            await self.api.async_get_command(self.urls.command_power_standby)
 
 
 @attr.s(auto_attribs=True, on_setattr=DENON_ATTR_SETATTR)
@@ -592,13 +627,12 @@ class DenonAVRFoundation:
                 update_attrs.pop(app_command, None)
 
         # Check if each attribute was updated
-        if update_attrs and ignore_missing_response is False:
+        if update_attrs and not ignore_missing_response:
             raise AvrProcessingError(
-                "Some attributes of zone {} not found on update: {}".format(
-                    self._device.zone, update_attrs
-                )
+                f"Some attributes of zone {self._device.zone} not found on update:"
+                f" {update_attrs}"
             )
-        if update_attrs and ignore_missing_response is True:
+        if update_attrs and ignore_missing_response:
             _LOGGER.debug(
                 "Some attributes of zone %s not found on update: %s",
                 self._device.zone,
@@ -660,11 +694,10 @@ class DenonAVRFoundation:
                 break
 
         # Check if each attribute was updated
-        if update_attrs and ignore_missing_response is False:
+        if update_attrs and not ignore_missing_response:
             raise AvrProcessingError(
-                "Some attributes of zone {} not found on update: {}".format(
-                    self._device.zone, update_attrs
-                )
+                f"Some attributes of zone {self._device.zone} not found on update:"
+                f" {update_attrs}"
             )
 
     @staticmethod
@@ -678,17 +711,15 @@ class DenonAVRFoundation:
             string = "./cmd"
             # Text of cmd tag in query was added as attribute to response
             if app_command_cmd.cmd_text:
-                string = string + "[@{}='{}']".format(
-                    APPCOMMAND_CMD_TEXT, app_command_cmd.cmd_text
+                string = (
+                    string + f"[@{APPCOMMAND_CMD_TEXT}='{app_command_cmd.cmd_text}']"
                 )
             # Text of name tag in query was added as attribute to response
             if app_command_cmd.name:
-                string = string + "[@{}='{}']".format(
-                    APPCOMMAND_NAME, app_command_cmd.name
-                )
+                string = string + f"[@{APPCOMMAND_NAME}='{app_command_cmd.name}']"
             # Some results include a zone tag
             if resp.add_zone:
-                string = string + "/{}".format(zone)
+                string = string + f"/{zone}"
             # Suffix like /status, /volume
             string = string + resp.suffix
 
@@ -722,8 +753,10 @@ def set_api_timeout(
     return value
 
 
-def convert_string_int_bool(value: str) -> bool:
+def convert_string_int_bool(value: Union[str, bool]) -> bool:
     """Convert an integer from string format to bool."""
     if value is None:
         return None
+    if isinstance(value, bool):
+        return value
     return bool(int(value))