Merge pull request #5 from thomasgermain/release_1_2_0

Release 1 2 0

README.md

@@ -18,7 +18,10 @@ First release using config flow
 - Removed boiler temperature and boiler water pressure in favor of `report` entity (breaking change)
 - Better error handling
 - Automatic re-authentication in case of error
-
+### [1.2.0](https://github.com/thomasgermain/vaillant-component/releases/tag/1.2.0)
+- Adding a way to specify serial number in case you have multiple
+- some error log improvement/fix
+- adding some none check
 
 ## Provided entities
 - 1 water_heater entity, if any water heater: `water_heater.vaillant_<water heater id>`, basically `water_heater.vaillant_control_dhw`

vaillant/.translations/bg.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/ca.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/cs.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/da.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/de.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/en.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/es.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/fr.json

@@ -12,7 +12,8 @@
             "user": {
                 "data": {
                     "password": "Mot de passe",
-                    "username": "Nom d'utilisateur"
+                    "username": "Nom d'utilisateur",
+                    "serial_number": "Numéro de série"
                 },
                 "title": "Remplissez vos informations de connexion (les mêmes que l'application multiMATIC)"
             }

vaillant/.translations/it.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/ko.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/lb.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/nl.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/nn.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/no.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/pl.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Hasło",
-          "username": "Nazwa użytkownika"
+          "username": "Nazwa użytkownika",
+          "serial_number": "Serial number"
         },
         "title": "Informacje o połączeniu (takie same jak w aplikacji multiMATIC)"
       }

vaillant/.translations/pt-BR.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/pt.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/ru.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/sl.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/.translations/zh-Hant.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }

vaillant/__init__.py

@@ -6,7 +6,7 @@
 from homeassistant.const import CONF_PASSWORD, CONF_USERNAME, EVENT_HOMEASSISTANT_STOP
 from homeassistant.core import HomeAssistant
 
-from .const import DOMAIN, PLATFORMS
+from .const import CONF_SERIAL_NUMBER, DOMAIN, PLATFORMS
 from .hub import ApiHub, DomainData
 from .service import SERVICES, VaillantServiceHandler
 
@@ -23,7 +23,8 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
 
     username = entry.data[CONF_USERNAME]
     password = entry.data[CONF_PASSWORD]
-    api: ApiHub = ApiHub(hass, username, password)
+    serial = entry.data.get(CONF_SERIAL_NUMBER)
+    api: ApiHub = ApiHub(hass, username, password, serial)
     await api.authenticate()
     await api.update_system()
 

vaillant/config_flow.py

@@ -1,17 +1,24 @@
 """Config flow for vaillant integration."""
 import logging
 
+from pymultimatic.api import ApiError
 import voluptuous as vol
 
 from homeassistant import config_entries, core, exceptions
+from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
 
 from . import ApiHub
-from .const import DOMAIN  # pylint:disable=unused-import
+from .const import CONF_SERIAL_NUMBER, DOMAIN  # pylint:disable=unused-import
 
 _LOGGER = logging.getLogger(__name__)
 
-# TODO adjust the data schema to the data that you need
-DATA_SCHEMA = vol.Schema({"username": str, "password": str})
+DATA_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_USERNAME): str,
+        vol.Required(CONF_PASSWORD): str,
+        vol.Optional(CONF_SERIAL_NUMBER): str,
+    }
+)
 
 
 async def validate_input(hass: core.HomeAssistant, data):
@@ -20,17 +27,27 @@ async def validate_input(hass: core.HomeAssistant, data):
     Data has the keys from DATA_SCHEMA with values provided by the user.
     """
 
-    await validate_authentication(hass, data["username"], data["password"])
+    await validate_authentication(
+        hass, data[CONF_USERNAME], data[CONF_PASSWORD], data.get(CONF_SERIAL_NUMBER)
+    )
 
-    # TODO Return info that you want to store in the config entry.
     return {"title": "Vaillant"}
 
 
-async def validate_authentication(hass, username, password):
+async def validate_authentication(hass, username, password, serial):
     """Ensure provided credentials are working."""
-    hub: ApiHub = ApiHub(hass, username, password)
-    if not await hub.authenticate():
-        raise InvalidAuth
+    hub: ApiHub = ApiHub(hass, username, password, serial)
+    try:
+        if not await hub.authenticate():
+            raise InvalidAuth
+    except ApiError as err:
+        resp = await err.response.json()
+        _LOGGER.exception(
+            "Unable to authenticate, API says: %s, status: %s",
+            resp,
+            err.response.status,
+        )
+        raise InvalidAuth from err
 
 
 class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):

vaillant/const.py

@@ -24,6 +24,7 @@
 # configuration keys
 CONF_QUICK_VETO_DURATION = "quick_veto_duration"
 CONF_SMARTPHONE_ID = "smartphoneid"
+CONF_SERIAL_NUMBER = "serial_number"
 
 # constants for states_attributes
 ATTR_VAILLANT_MODE = "vaillant_mode"

vaillant/hub.py

@@ -22,14 +22,14 @@
 class ApiHub:
     """Vaillant entry point for home-assistant."""
 
-    def __init__(self, hass, username, password):
+    def __init__(self, hass, username, password, serial):
         """Initialize hub."""
         from pymultimatic.systemmanager import SystemManager
         from pymultimatic.model import System
 
         session = async_create_clientsession(hass)
         self._manager = SystemManager(
-            username, password, session, DEFAULT_SMART_PHONE_ID
+            username, password, session, DEFAULT_SMART_PHONE_ID, serial
         )
         self.system: System = None
         self.update_system = Throttle(DEFAULT_SCAN_INTERVAL)(self._update_system)
@@ -62,7 +62,6 @@ async def _hvac_update(self, trigger=None) -> None:
 
     async def _update_system(self):
         """Fetch vaillant system."""
-        from pymultimatic.api import ApiError
 
         try:
             self.system = await self._manager.get_system()
@@ -82,7 +81,6 @@ async def _update_system(self):
 
     async def logout(self):
         """Logout from API."""
-        from pymultimatic.api import ApiError
 
         try:
             await self._manager.logout()

vaillant/sensor.py

@@ -80,7 +80,7 @@ def __init__(self, report: Report):
         """Init entity."""
         device_class = UNIT_TO_DEVICE_CLASS.get(report.unit, None)
         if not device_class:
-            _LOGGER.warning("No device class for {}", report.unit)
+            _LOGGER.warning("No device class for %s", report.unit)
         VaillantEntity.__init__(
             self, DOMAIN, device_class, report.id, report.name, False
         )

vaillant/strings.json

@@ -5,7 +5,8 @@
       "user": {
         "data": {
           "password": "Password",
-          "username": "Username"
+          "username": "Username",
+          "serial_number": "Serial number"
         },
         "title": "Connection information (same as multiMATIC application)"
       }