Merge pull request #177 from plugwise/revert_debugs

Revert removal of error-logging

Author: bouwew

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+# v0.17.6: Smile: revert removing LOGGER.error messages
+
 # v0.17.5: Smile: rework to raise instead of return
 - raise in error-cases, move LOGGER.debug messages into raise
 - clean up code

plugwise/__init__.py

@@ -1,6 +1,6 @@
 """Plugwise module."""
 
-__version__ = "0.17.5"
+__version__ = "0.17.6"
 
 from plugwise.smile import Smile
 from plugwise.stick import Stick

plugwise/helper.py

@@ -227,18 +227,22 @@ async def _request_validate(self, resp: ClientResponse, method: str) -> etree:
             return
 
         if resp.status == 401:
-            raise InvalidAuthentication(
-                "Invalid login, please retry with the correct credentials."
-            )
+            msg = "Invalid Plugwise login, please retry with the correct credentials."
+            LOGGER.error("%s", msg)
+            raise InvalidAuthentication(f"{msg}")
 
         if not (result := await resp.text()) or "<error>" in result:
-            raise ResponseError(f"Smile response empty or error in {result}.")
+            LOGGER.error("Smile response empty or error in %s", result)
+            raise ResponseError("Plugwise response error, check log for more info.")
 
         try:
             # Encode to ensure utf8 parsing
             xml = etree.XML(escape_illegal_xml_characters(result).encode())
         except etree.ParseError:
-            raise InvalidXMLError(f"Smile returns invalid XML for {self._endpoint}.")
+            LOGGER.error("Smile returns invalid XML for %s", self._endpoint)
+            raise InvalidXMLError(
+                "Plugwise invalid XML error, check log for more info."
+            )
 
         return xml
 
@@ -271,8 +275,9 @@ async def _request(
                 )
         except ServerTimeoutError:
             if retry < 1:
+                LOGGER.error("Timed out sending %s command to Plugwise", command)
                 raise DeviceTimeoutError(
-                    f"Timed out sending {command} command to Plugwise"
+                    "Plugwise timeout error, check log for more info."
                 )
             return await self._request(command, retry - 1)
 

plugwise/smile.py

@@ -275,17 +275,20 @@ async def connect(self) -> bool:
         dsmrmain = result.find("./module/protocols/dsmrmain")
         if "Plugwise" not in names:
             if dsmrmain is None:  # pragma: no cover
-                raise ConnectionFailedError(
-                    f"Connected but expected text not returned, \
-                    we got {result}. Please create an issue on \
-                    http://github.com/plugwise/python-plugwise"
+                LOGGER.error(
+                    "Connected but expected text not returned, we got %s. Please create \
+                    an issue on http://github.com/plugwise/python-plugwise",
+                    result,
                 )
+                raise ConnectionFailedError("Plugwise error, check log for more info.")
 
         # Check if Anna is connected to an Adam
         if "159.2" in models:
+            LOGGER.error(
+                "Your Anna is connected to an Adam, make sure to only add the Adam as integration."
+            )
             raise InvalidSetupError(
-                "Your Anna is connected to an Adam, make \
-                sure to only add the Adam as integration."
+                "Plugwise invalid setup error, check log for more info."
             )
 
         # Determine smile specifics
@@ -337,10 +340,11 @@ async def _smile_detect_legacy(self, result: etree, dsmrmain: etree) -> str:
 
             else:  # pragma: no cover
                 # No cornercase, just end of the line
-                raise ConnectionFailedError(
+                LOGGER.error(
                     "Connected but no gateway device information found, please create \
                      an issue on http://github.com/plugwise/python-plugwise"
                 )
+                raise ConnectionFailedError("Plugwise error, check log for more info.")
 
         return model
 
@@ -360,20 +364,22 @@ async def _smile_detect(self, result: etree, dsmrmain: etree) -> None:
 
         if model is None or self.smile_fw_version is None:  # pragma: no cover
             # Corner case check
-            raise UnsupportedDeviceError(
+            LOGGER.error(
                 "Unable to find model or version information, please create \
                  an issue on http://github.com/plugwise/python-plugwise"
             )
+            raise UnsupportedDeviceError("Plugwise error, check log for more info.")
 
         ver = semver.VersionInfo.parse(self.smile_fw_version)
         target_smile = f"{model}_v{ver.major}"
         LOGGER.debug("Plugwise identified as %s", target_smile)
         if target_smile not in SMILES:
-            raise UnsupportedDeviceError(
-                "Your version Smile identified as {target_smile} seems\
-                 unsupported by our plugin, please create an issue\
-                 on http://github.com/plugwise/python-plugwise"
+            LOGGER.error(
+                'Your version Smile identified as "%s" seems unsupported by our plugin, please \
+                create an issue on http://github.com/plugwise/python-plugwise',
+                target_smile,
             )
+            raise UnsupportedDeviceError("Plugwise error, check log for more info.")
 
         self.smile_name = SMILES[target_smile]["friendly_name"]
         self.smile_type = SMILES[target_smile]["type"]
@@ -467,7 +473,7 @@ async def _set_schedule_state_legacy(self, name: str, status: str) -> None:
                 schedule_rule_id = rule.attrib["id"]
 
         if schedule_rule_id is None:
-            raise PlugwiseError("No schedule available.")
+            raise PlugwiseError("Plugwise: no schedule available.")
 
         state = "false"
         if status == "on":
@@ -495,7 +501,7 @@ async def set_schedule_state(self, loc_id: str, name: str, state: str) -> None:
 
         schedule_rule = self._rule_ids_by_name(name, loc_id)
         if not schedule_rule or schedule_rule is None:
-            raise PlugwiseError("No schedule with this name available.")
+            raise PlugwiseError("Plugwise: no schedule with this name available.")
 
         schedule_rule_id: str = next(iter(schedule_rule))
 
@@ -534,7 +540,7 @@ async def _set_preset_legacy(self, preset: str) -> None:
         """Set the given Preset on the relevant Thermostat - from DOMAIN_OBJECTS."""
         locator = f'rule/directives/when/then[@icon="{preset}"].../.../...'
         if (rule := self._domain_objects.find(locator)) is None:
-            raise PlugwiseError("Invalid preset.")
+            raise PlugwiseError("Plugwise: invalid preset.")
 
         uri = RULES
         data = f'<rules><rule id="{rule.attrib["id"]}"><active>true</active></rule></rules>'
@@ -552,7 +558,7 @@ async def set_preset(self, loc_id: str, preset: str) -> None:
         location_type = current_location.find("type").text
 
         if preset not in self._presets(loc_id):
-            raise PlugwiseError("Invalid preset.")
+            raise PlugwiseError("Plugwise: invalid preset.")
 
         uri = f"{LOCATIONS};id={loc_id}"
         data = (
@@ -639,14 +645,14 @@ async def set_switch_state(
             lock_state: str = self._appliances.find(locator).text
             # Don't bother switching a relay when the corresponding lock-state is true
             if lock_state == "true":
-                raise PlugwiseError("Cannot switch a locked Relay.")
+                raise PlugwiseError("Plugwise: the locked Relay was not switched.")
 
         await self._request(uri, method="put", data=data)
 
     async def set_regulation_mode(self, mode: str) -> None:
         """Set the heating regulation mode."""
         if mode not in self._allowed_modes:
-            raise PlugwiseError("Invalid regulation mode.")
+            raise PlugwiseError("Plugwise: invalid regulation mode.")
 
         uri = f"{APPLIANCES};type=gateway/regulation_mode_control"
         duration = ""