Improve handling of errors when Somfy server is in maintenance. (#306)

Co-authored-by: Thibaut Etienne <[email protected]>

Author: iMicknl

custom_components/tahoma/__init__.py

@@ -12,7 +12,11 @@
 from homeassistant.exceptions import ConfigEntryNotReady
 from homeassistant.helpers import aiohttp_client, config_validation as cv
 from pyhoma.client import TahomaClient
-from pyhoma.exceptions import BadCredentialsException, TooManyRequestsException
+from pyhoma.exceptions import (
+    BadCredentialsException,
+    MaintenanceException,
+    TooManyRequestsException,
+)
 from pyhoma.models import Command
 import voluptuous as vol
 
@@ -95,6 +99,9 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
     except (TimeoutError, ClientError, ServerDisconnectedError) as exception:
         _LOGGER.error("cannot_connect")
         raise ConfigEntryNotReady from exception
+    except MaintenanceException as exception:
+        _LOGGER.error("server_in_maintenance")
+        raise ConfigEntryNotReady from exception
     except Exception as exception:  # pylint: disable=broad-except
         _LOGGER.exception(exception)
         return False

custom_components/tahoma/config_flow.py

@@ -7,7 +7,11 @@
 from homeassistant.core import callback
 from homeassistant.helpers import config_validation as cv
 from pyhoma.client import TahomaClient
-from pyhoma.exceptions import BadCredentialsException, TooManyRequestsException
+from pyhoma.exceptions import (
+    BadCredentialsException,
+    MaintenanceException,
+    TooManyRequestsException,
+)
 import voluptuous as vol
 
 from .const import CONF_UPDATE_INTERVAL, DEFAULT_UPDATE_INTERVAL, MIN_UPDATE_INTERVAL
@@ -57,6 +61,8 @@ async def async_step_user(self, user_input=None):
                 errors["base"] = "invalid_auth"
             except (TimeoutError, ClientError):
                 errors["base"] = "cannot_connect"
+            except MaintenanceException:
+                errors["base"] = "server_in_maintenance"
             except Exception as exception:  # pylint: disable=broad-except
                 errors["base"] = "unknown"
                 _LOGGER.exception(exception)
@@ -81,6 +87,9 @@ async def async_step_import(self, import_config: dict):
         except (TimeoutError, ClientError):
             _LOGGER.error("cannot_connect")
             return self.async_abort(reason="cannot_connect")
+        except MaintenanceException:
+            _LOGGER.error("server_in_maintenance")
+            return self.async_abort(reason="server_in_maintenance")
         except Exception as exception:  # pylint: disable=broad-except
             _LOGGER.exception(exception)
             return self.async_abort(reason="unknown")

custom_components/tahoma/coordinator.py

@@ -11,6 +11,7 @@
 from pyhoma.enums import EventName, ExecutionState
 from pyhoma.exceptions import (
     BadCredentialsException,
+    MaintenanceException,
     NotAuthenticatedException,
     TooManyRequestsException,
 )
@@ -67,6 +68,8 @@ async def _async_update_data(self) -> Dict[str, Device]:
             raise UpdateFailed("invalid_auth") from exception
         except TooManyRequestsException as exception:
             raise UpdateFailed("too_many_requests") from exception
+        except MaintenanceException as exception:
+            raise UpdateFailed("server_in_maintenance") from exception
         except (ServerDisconnectedError, NotAuthenticatedException) as exception:
             _LOGGER.debug(exception)
             self.executions = {}

custom_components/tahoma/manifest.json

@@ -4,8 +4,13 @@
   "config_flow": true,
   "documentation": "https://www.home-assistant.io/integrations/tahoma",
   "requirements": [
-    "pyhoma==0.5.0"
+    "pyhoma==0.5.1"
+  ],
+  "codeowners": [
+    "@philklei",
+    "@imicknl",
+    "@vlebourl",
+    "@tetienne"
   ],
-  "codeowners": ["@philklei", "@imicknl", "@vlebourl", "@tetienne"],
   "issue_tracker": "https://github.com/imicknl/ha-tahoma/issues"
-}
+}

custom_components/tahoma/strings.json

@@ -13,6 +13,7 @@
       "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
       "too_many_requests": "Too many requests, try again later.",
       "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]",
+      "server_in_maintenance": "Server is down for maintenance",
       "unknown": "[%key:common::config_flow::error::unknown%]"
     },
     "abort": {

custom_components/tahoma/translations/en.json

@@ -13,6 +13,7 @@
       "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
       "too_many_requests": "Too many requests, try again later.",
       "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]",
+      "server_in_maintenance": "Server is down for maintenance",
       "unknown": "[%key:common::config_flow::error::unknown%]"
     },
     "abort": {

custom_components/tahoma/translations/fr.json

@@ -13,6 +13,7 @@
       "cannot_connect": "Connexion impossible",
       "too_many_requests": "Trop de reqûtees, veuillez réessayer plus tard.",
       "invalid_auth": "Mot de passe ou nom d'utilisateur incorrect",
+      "server_in_maintenance": "Le serveur est en cours de maintenance",
       "unknown": "Une erreur inconnue est survenue."
     },
     "abort": {

custom_components/tahoma/translations/nl.json

@@ -13,6 +13,7 @@
       "too_many_requests": "Te veel verzoeken, probeer het later opnieuw.",
       "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
       "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]",
+      "server_in_maintenance": "De server is offline voor onderhoud",
       "unknown": "[%key:common::config_flow::error::unknown%]"
     },
     "abort": {

requirements.test.txt

@@ -7,4 +7,4 @@ pytest-cov<3.0.0
 pytest-homeassistant
 
 # from our manifest.json for our Custom Component
-pyhoma==0.5.0
+pyhoma==0.5.1