Support Cozytouch, Rexel and Connexoon RTS. (#332)

Co-authored-by: Vincent Le Bourlot <[email protected]>

README.md

@@ -8,11 +8,13 @@
 
 This component builds upon the work of [@philklei](https://github.com/philklei) and is an updated version of his [original Tahoma integration](https://www.home-assistant.io/integrations/tahoma/) in Home Assistant with the goal of merging into core. The installation of this component will replace the original Tahoma integration and thus allows you to beta-test [all changes](./CHANGELOG.md).
 
-## Supported Somfy gateways
+## Supported (Somfy) hubs
 
 - Somfy TaHoma Box
 - Somfy Connexoon IO
 - Somfy Connexoon RTS
+- Cozytouch
+- Rexel
 
 ## Installation
 

custom_components/tahoma/__init__.py

@@ -22,10 +22,13 @@
 import voluptuous as vol
 
 from .const import (
+    CONF_HUB,
     CONF_UPDATE_INTERVAL,
+    DEFAULT_HUB,
     DEFAULT_UPDATE_INTERVAL,
     DOMAIN,
     IGNORED_TAHOMA_TYPES,
+    SUPPORTED_ENDPOINTS,
     TAHOMA_TYPES,
 )
 from .coordinator import TahomaDataUpdateCoordinator
@@ -86,9 +89,16 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
 
     username = entry.data.get(CONF_USERNAME)
     password = entry.data.get(CONF_PASSWORD)
+    hub = entry.data.get(CONF_HUB) or DEFAULT_HUB
+    endpoint = SUPPORTED_ENDPOINTS[hub]
 
     session = async_get_clientsession(hass)
-    client = TahomaClient(username, password, session=session)
+    client = TahomaClient(
+        username,
+        password,
+        session=session,
+        api_url=endpoint,
+    )
 
     try:
         await client.login()
@@ -137,7 +147,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
         if platform:
             entities[platform].append(device)
             _LOGGER.debug(
-                "Added Device (%s - %s - %s - %s)",
+                "Added TaHoma device (%s - %s - %s - %s)",
                 device.controllable_name,
                 device.ui_class,
                 device.widget,

custom_components/tahoma/config_flow.py

@@ -14,13 +14,24 @@
 )
 import voluptuous as vol
 
-from .const import CONF_UPDATE_INTERVAL, DEFAULT_UPDATE_INTERVAL, MIN_UPDATE_INTERVAL
+from .const import (
+    CONF_HUB,
+    CONF_UPDATE_INTERVAL,
+    DEFAULT_HUB,
+    DEFAULT_UPDATE_INTERVAL,
+    MIN_UPDATE_INTERVAL,
+    SUPPORTED_ENDPOINTS,
+)
 from .const import DOMAIN  # pylint: disable=unused-import
 
 _LOGGER = logging.getLogger(__name__)
 
 DATA_SCHEMA = vol.Schema(
-    {vol.Required(CONF_USERNAME): str, vol.Required(CONF_PASSWORD): str}
+    {
+        vol.Required(CONF_USERNAME): str,
+        vol.Required(CONF_PASSWORD): str,
+        vol.Required(CONF_HUB, default=DEFAULT_HUB): vol.In(SUPPORTED_ENDPOINTS.keys()),
+    }
 )
 
 
@@ -41,9 +52,15 @@ async def async_validate_input(self, user_input):
         username = user_input.get(CONF_USERNAME)
         password = user_input.get(CONF_PASSWORD)
 
-        async with TahomaClient(username, password) as client:
+        hub = user_input.get(CONF_HUB) or DEFAULT_HUB
+        endpoint = SUPPORTED_ENDPOINTS[hub]
+
+        async with TahomaClient(username, password, api_url=endpoint) as client:
             await client.login()
-            return self.async_create_entry(title=username, data=user_input)
+            return self.async_create_entry(
+                title=username,
+                data=user_input,
+            )
 
     async def async_step_user(self, user_input=None):
         """Handle the initial step via config flow."""

custom_components/tahoma/const.py

@@ -8,8 +8,18 @@
 from homeassistant.components.sensor import DOMAIN as SENSOR
 from homeassistant.components.switch import DOMAIN as SWITCH
 
+CONF_HUB = "hub"
 DOMAIN = "tahoma"
 
+DEFAULT_HUB = "Somfy TaHoma"
+SUPPORTED_ENDPOINTS = {
+    "Cozytouch": "https://ha110-1.overkiz.com/enduser-mobile-web/enduserAPI/",
+    "Somfy TaHoma": "https://tahomalink.com/enduser-mobile-web/enduserAPI/",
+    "Somfy Connexoon IO": "https://tahomalink.com/enduser-mobile-web/enduserAPI/",
+    "Somfy Connexoon RTS": "https://ha201-1.overkiz.com/enduser-mobile-web/enduserAPI/",
+    "Rexel": "https://ha112-1.overkiz.com/enduser-mobile-web/enduserAPI/",
+}
+
 MIN_UPDATE_INTERVAL = 30
 DEFAULT_UPDATE_INTERVAL = 30
 

custom_components/tahoma/strings.json

@@ -5,7 +5,8 @@
         "description": "Enter your TaHoma credentials for the TaHoma App or the tahomalink.com platform.",
         "data": {
           "username": "[%key:common::config_flow::data::username%]",
-          "password": "[%key:common::config_flow::data::password%]"
+          "password": "[%key:common::config_flow::data::password%]",
+          "hub": "Hub"
         }
       }
     },

custom_components/tahoma/translations/en.json

@@ -5,7 +5,8 @@
         "description": "Enter your TaHoma credentials for the TaHoma App or the tahomalink.com platform.",
         "data": {
           "username": "Email address",
-          "password": "Password"
+          "password": "Password",
+          "hub": "Hub"
         }
       }
     },

custom_components/tahoma/translations/fr.json

@@ -5,7 +5,8 @@
         "description": "Entrez vos identifiants TaHoma.",
         "data": {
           "username": "Courriel",
-          "password": "Mot de passe"
+          "password": "Mot de passe",
+          "hub": "Hub"
         }
       }
     },
@@ -31,4 +32,4 @@
       }
     }
   }
-}
+}

custom_components/tahoma/translations/nl.json

@@ -5,7 +5,8 @@
         "description": "Voer uw TaHoma inloggegevens in voor de TaHoma-app of het tahomalink.com platform.",
         "data": {
           "username": "E-mailadres",
-          "password": "Wachtwoord"
+          "password": "Wachtwoord",
+          "hub": "Hub"
         }
       }
     },

tests/test_config_flow.py

@@ -13,6 +13,7 @@
 
 TEST_EMAIL = "[email protected]"
 TEST_PASSWORD = "test-password"
+DEFAULT_HUB = "Somfy TaHoma"
 
 
 async def test_form(hass):
@@ -30,14 +31,15 @@ async def test_form(hass):
         "custom_components.tahoma.async_setup_entry", return_value=True
     ) as mock_setup_entry:
         result2 = await hass.config_entries.flow.async_configure(
-            result["flow_id"], {"username": TEST_EMAIL, "password": TEST_PASSWORD},
+            result["flow_id"], {"username": TEST_EMAIL, "password": TEST_PASSWORD, "hub": DEFAULT_HUB},
         )
 
     assert result2["type"] == "create_entry"
     assert result2["title"] == TEST_EMAIL
     assert result2["data"] == {
         "username": TEST_EMAIL,
         "password": TEST_PASSWORD,
+        "hub": DEFAULT_HUB
     }
 
     await hass.async_block_till_done()
@@ -64,7 +66,7 @@ async def test_form_invalid(hass, side_effect, error):
 
     with patch("pyhoma.client.TahomaClient.login", side_effect=side_effect):
         result2 = await hass.config_entries.flow.async_configure(
-            result["flow_id"], {"username": TEST_EMAIL, "password": TEST_PASSWORD},
+            result["flow_id"], {"username": TEST_EMAIL, "password": TEST_PASSWORD, "hub": DEFAULT_HUB},
         )
 
     assert result2["type"] == "form"
@@ -76,7 +78,7 @@ async def test_abort_on_duplicate_entry(hass):
     MockConfigEntry(
         domain=config_flow.DOMAIN,
         unique_id=TEST_EMAIL,
-        data={"username": TEST_EMAIL, "password": TEST_PASSWORD},
+        data={"username": TEST_EMAIL, "password": TEST_PASSWORD, "hub": DEFAULT_HUB},
     ).add_to_hass(hass)
 
     result = await hass.config_entries.flow.async_init(
@@ -89,7 +91,7 @@ async def test_abort_on_duplicate_entry(hass):
         "custom_components.tahoma.async_setup_entry", return_value=True
     ) as mock_setup_entry:
         result2 = await hass.config_entries.flow.async_configure(
-            result["flow_id"], {"username": TEST_EMAIL, "password": TEST_PASSWORD},
+            result["flow_id"], {"username": TEST_EMAIL, "password": TEST_PASSWORD, "hub": DEFAULT_HUB},
         )
 
     assert result2["type"] == "abort"
@@ -101,7 +103,7 @@ async def test_allow_multiple_unique_entries(hass):
     MockConfigEntry(
         domain=config_flow.DOMAIN,
         unique_id="[email protected]",
-        data={"username": "[email protected]", "password": TEST_PASSWORD},
+        data={"username": "[email protected]", "password": TEST_PASSWORD, "hub": DEFAULT_HUB},
     ).add_to_hass(hass)
 
     result = await hass.config_entries.flow.async_init(
@@ -114,14 +116,15 @@ async def test_allow_multiple_unique_entries(hass):
         "custom_components.tahoma.async_setup_entry", return_value=True
     ) as mock_setup_entry:
         result2 = await hass.config_entries.flow.async_configure(
-            result["flow_id"], {"username": TEST_EMAIL, "password": TEST_PASSWORD},
+            result["flow_id"], {"username": TEST_EMAIL, "password": TEST_PASSWORD, "hub": DEFAULT_HUB},
         )
 
     assert result2["type"] == "create_entry"
     assert result2["title"] == TEST_EMAIL
     assert result2["data"] == {
         "username": TEST_EMAIL,
         "password": TEST_PASSWORD,
+        "hub": DEFAULT_HUB
     }
 
 
@@ -135,13 +138,14 @@ async def test_import(hass):
         result = await hass.config_entries.flow.async_init(
             config_flow.DOMAIN,
             context={"source": config_entries.SOURCE_IMPORT},
-            data={"username": TEST_EMAIL, "password": TEST_PASSWORD},
+            data={"username": TEST_EMAIL, "password": TEST_PASSWORD, "hub": DEFAULT_HUB},
         )
         assert result["type"] == "create_entry"
         assert result["title"] == TEST_EMAIL
         assert result["data"] == {
             "username": TEST_EMAIL,
             "password": TEST_PASSWORD,
+            "hub": DEFAULT_HUB
         }
 
         await hass.async_block_till_done()
@@ -166,7 +170,7 @@ async def test_import_failing(hass, side_effect, error):
         await hass.config_entries.flow.async_init(
             config_flow.DOMAIN,
             context={"source": config_entries.SOURCE_IMPORT},
-            data={"username": TEST_EMAIL, "password": TEST_PASSWORD},
+            data={"username": TEST_EMAIL, "password": TEST_PASSWORD, "hub": DEFAULT_HUB},
         )
 
     # Should write Exception to the log
@@ -178,7 +182,7 @@ async def test_options_flow(hass):
     entry = MockConfigEntry(
         domain=config_flow.DOMAIN,
         unique_id=TEST_EMAIL,
-        data={"username": TEST_EMAIL, "password": TEST_PASSWORD},
+        data={"username": TEST_EMAIL, "password": TEST_PASSWORD, "hub": DEFAULT_HUB},
     )
 
     with patch("pyhoma.client.TahomaClient.login", return_value=True), patch(