Merge pull request #29 from addshore/updatedLogin

Update for new hOn login

.pylintrc

@@ -4,6 +4,6 @@ disable=missing-docstring
 
 [FORMAT]
 
-max-args=6
+max-args=7
 max-attributes=8
 max-line-length=88

pyhon/__main__.py

@@ -38,9 +38,7 @@ def get_arguments() -> Dict[str, Any]:
         "translate", help="language (de, en, fr...)", metavar="LANGUAGE"
     )
     translation.add_argument("--json", help="print as json", action="store_true")
-    parser.add_argument(
-        "-i", "--import", help="import pyhon data", nargs="?", default=Path().cwd()
-    )
+    parser.add_argument("-i", "--import", help="import pyhon data", nargs="?")
     return vars(parser.parse_args())
 
 
@@ -73,9 +71,8 @@ async def main() -> None:
     if language := args.get("translate"):
         await translate(language, json_output=args.get("json", ""))
         return
-    async with Hon(
-        *get_login_data(args), test_data_path=Path(args.get("import", ""))
-    ) as hon:
+    test_data_path = Path(path) if (path := args.get("import", "")) else None
+    async with Hon(*get_login_data(args), test_data_path=test_data_path) as hon:
         for device in hon.appliances:
             if args.get("export"):
                 anonymous = args.get("anonymous", False)

pyhon/appliance.py

@@ -43,6 +43,10 @@ class HonAppliance:
         self._additional_data: Dict[str, Any] = {}
         self._last_update: Optional[datetime] = None
         self._default_setting = HonParameter("", {}, "")
+        self._connection = (
+            not self._attributes.get("lastConnEvent", {}).get("category", "")
+            == "DISCONNECTED"
+        )
 
         try:
             self._extra: Optional[ApplianceBase] = importlib.import_module(
@@ -72,12 +76,10 @@ class HonAppliance:
         return self.info[item]
 
     @overload
-    def get(self, item: str, default: None = None) -> Any:
-        ...
+    def get(self, item: str, default: None = None) -> Any: ...
 
     @overload
-    def get(self, item: str, default: T) -> T:
-        ...
+    def get(self, item: str, default: T) -> T: ...
 
     def get(self, item: str, default: Optional[T] = None) -> Any:
         try:
@@ -92,6 +94,14 @@ class HonAppliance:
             return f"{attribute}{zone}{self._zone}"
         return attribute
 
+    @property
+    def connection(self) -> bool:
+        return self._connection
+
+    @connection.setter
+    def connection(self, connection: bool) -> None:
+        self._connection = connection
+
     @property
     def appliance_model_id(self) -> str:
         return str(self._info.get("applianceModelId", ""))

pyhon/appliances/dw.py

@@ -7,7 +7,7 @@ from pyhon.appliances.base import ApplianceBase
 class Appliance(ApplianceBase):
     def attributes(self, data: Dict[str, Any]) -> Dict[str, Any]:
         data = super().attributes(data)
-        if data.get("lastConnEvent", {}).get("category", "") == "DISCONNECTED":
+        if not self.parent.connection:
             data["parameters"]["machMode"].value = "0"
         data["active"] = bool(data.get("activity"))
         return data

pyhon/appliances/ov.py

@@ -6,7 +6,7 @@ from pyhon.appliances.base import ApplianceBase
 class Appliance(ApplianceBase):
     def attributes(self, data: Dict[str, Any]) -> Dict[str, Any]:
         data = super().attributes(data)
-        if data.get("lastConnEvent", {}).get("category", "") == "DISCONNECTED":
+        if not self.parent.connection:
             data["parameters"]["temp"].value = 0
             data["parameters"]["onOffStatus"].value = 0
             data["parameters"]["remoteCtrValid"].value = 0

pyhon/appliances/td.py

@@ -8,7 +8,7 @@ from pyhon.parameter.fixed import HonParameterFixed
 class Appliance(ApplianceBase):
     def attributes(self, data: Dict[str, Any]) -> Dict[str, Any]:
         data = super().attributes(data)
-        if data.get("lastConnEvent", {}).get("category", "") == "DISCONNECTED":
+        if not self.parent.connection:
             data["parameters"]["machMode"].value = "0"
         data["active"] = bool(data.get("activity"))
         data["pause"] = data["parameters"]["machMode"] == "3"

pyhon/appliances/wd.py

@@ -7,7 +7,7 @@ from pyhon.appliances.base import ApplianceBase
 class Appliance(ApplianceBase):
     def attributes(self, data: Dict[str, Any]) -> Dict[str, Any]:
         data = super().attributes(data)
-        if data.get("lastConnEvent", {}).get("category", "") == "DISCONNECTED":
+        if not self.parent.connection:
             data["parameters"]["machMode"].value = "0"
         data["active"] = bool(data.get("activity"))
         data["pause"] = data["parameters"]["machMode"] == "3"

pyhon/command_loader.py

@@ -109,7 +109,7 @@ class HonCommandLoader:
         categories: Optional[Dict[str, "HonCommand"]] = None,
         category_name: str = "",
     ) -> Optional[HonCommand]:
-        """Try to crate HonCommand object"""
+        """Try to create HonCommand object"""
         if not isinstance(data, dict):
             self._additional_data[command_name] = data
             return None

pyhon/commands.py

@@ -89,8 +89,11 @@ class HonCommand:
     def parameter_value(self) -> Dict[str, Union[str, float]]:
         return {n: p.value for n, p in self._parameters.items()}
 
-    def _load_parameters(self, attributes: Dict[str, Dict[str, Any]]) -> None:
+    def _load_parameters(self, attributes: Dict[str, Dict[str, Any] | Any]) -> None:
         for key, items in attributes.items():
+            if not isinstance(items, dict):
+                _LOGGER.info("Loading Attributes - Skipping %s", str(items))
+                continue
             for name, data in items.items():
                 self._create_parameters(data, name, key)
         for rule in self._rules:

pyhon/connection/api.py

@@ -18,18 +18,23 @@ from pyhon.connection.handler.hon import HonConnectionHandler
 _LOGGER = logging.getLogger(__name__)
 
 
+# pylint: disable=too-many-instance-attributes
 class HonAPI:
     def __init__(
         self,
         email: str = "",
         password: str = "",
         anonymous: bool = False,
+        mobile_id: str = "",
+        refresh_token: str = "",
         session: Optional[ClientSession] = None,
     ) -> None:
         super().__init__()
         self._email: str = email
         self._password: str = password
         self._anonymous: bool = anonymous
+        self._mobile_id: str = mobile_id
+        self._refresh_token: str = refresh_token
         self._hon_handler: Optional[HonConnectionHandler] = None
         self._hon_anonymous_handler: Optional[HonAnonymousConnectionHandler] = None
         self._session: Optional[ClientSession] = session
@@ -69,7 +74,11 @@ class HonAPI:
         ).create()
         if not self._anonymous:
             self._hon_handler = await HonConnectionHandler(
-                self._email, self._password, self._session
+                self._email,
+                self._password,
+                session=self._session,
+                mobile_id=self._mobile_id,
+                refresh_token=self._refresh_token,
             ).create()
         return self
 
@@ -184,6 +193,13 @@ class HonAPI:
             maintenance: Dict[str, Any] = (await response.json()).get("payload", {})
         return maintenance
 
+    async def load_aws_token(self) -> str:
+        url: str = f"{const.API_URL}/auth/v1/introspection"
+        async with self._hon.get(url) as response:
+            introspection: Dict[str, Any] = (await response.json()).get("payload", {})
+        result: str = introspection.get("tokenSigned", "")
+        return result
+
     async def send_command(
         self,
         appliance: HonAppliance,

pyhon/connection/auth.py

@@ -120,18 +120,23 @@ class HonAuth:
         async with self._request.get(url) as response:
             text = await response.text()
             self._expires = datetime.utcnow()
-            login_url: List[str] = re.findall("url = '(.+?)'", text)
+            login_url: List[str] = re.findall("(?:url|href) ?= ?'(.+?)'", text)
             if not login_url:
                 if "oauth/done#access_token=" in text:
                     self._parse_token_data(text)
                     raise exceptions.HonNoAuthenticationNeeded()
                 await self._error_logger(response)
+            # As of July 2024 the login page has changed, and we started getting a /NewhOnLogin based relative URL in JS to parse
+            if login_url[0].startswith("/NewhOnLogin"):
+                # Force use of the old login page to avoid having to make the new one work..
+                login_url[0] = f"{const.AUTH_API}/s/login{login_url[0]}"
         return login_url[0]
 
     async def _manual_redirect(self, url: str) -> str:
         async with self._request.get(url, allow_redirects=False) as response:
-            if not (new_location := response.headers.get("Location", "")):
-                await self._error_logger(response)
+            new_location = response.headers.get("Location", "")
+            if not new_location:
+                return url
         return new_location
 
     async def _handle_redirects(self, login_url: str) -> str:
@@ -199,7 +204,7 @@ class HonAuth:
         if access_token := re.findall("access_token=(.*?)&", text):
             self._auth.access_token = access_token[0]
         if refresh_token := re.findall("refresh_token=(.*?)&", text):
-            self._auth.refresh_token = refresh_token[0]
+            self._auth.refresh_token = parse.unquote(refresh_token[0])
         if id_token := re.findall("id_token=(.*?)&", text):
             self._auth.id_token = id_token[0]
         return bool(access_token and refresh_token and id_token)
@@ -264,7 +269,9 @@ class HonAuth:
         except exceptions.HonNoAuthenticationNeeded:
             return
 
-    async def refresh(self) -> bool:
+    async def refresh(self, refresh_token: str = "") -> bool:
+        if refresh_token:
+            self._auth.refresh_token = refresh_token
         params = {
             "client_id": const.CLIENT_ID,
             "refresh_token": self._auth.refresh_token,

pyhon/connection/device.py

@@ -1,16 +1,15 @@
-import secrets
 from typing import Dict
 
 from pyhon import const
 
 
 class HonDevice:
-    def __init__(self) -> None:
+    def __init__(self, mobile_id: str = "") -> None:
         self._app_version: str = const.APP_VERSION
         self._os_version: int = const.OS_VERSION
         self._os: str = const.OS
         self._device_model: str = const.DEVICE_MODEL
-        self._mobile_id: str = secrets.token_hex(8)
+        self._mobile_id: str = mobile_id or const.MOBILE_ID
 
     @property
     def app_version(self) -> str:

pyhon/connection/handler/hon.py

@@ -19,12 +19,18 @@ _LOGGER = logging.getLogger(__name__)
 
 class HonConnectionHandler(ConnectionHandler):
     def __init__(
-        self, email: str, password: str, session: Optional[aiohttp.ClientSession] = None
+        self,
+        email: str,
+        password: str,
+        session: Optional[aiohttp.ClientSession] = None,
+        mobile_id: str = "",
+        refresh_token: str = "",
     ) -> None:
         super().__init__(session=session)
-        self._device: HonDevice = HonDevice()
+        self._device: HonDevice = HonDevice(mobile_id)
         self._email: str = email
         self._password: str = password
+        self._refresh_token: str = refresh_token
         if not self._email:
             raise HonAuthenticationError("An email address must be specified")
         if not self._password:
@@ -43,12 +49,20 @@ class HonConnectionHandler(ConnectionHandler):
 
     async def create(self) -> Self:
         await super().create()
-        self._auth = HonAuth(self.session, self._email, self._password, self._device)
+        self._auth = HonAuth(
+            self.session,
+            self._email,
+            self._password,
+            self._device,
+        )
         return self
 
     async def _check_headers(self, headers: Dict[str, str]) -> Dict[str, str]:
+        if self._refresh_token:
+            await self.auth.refresh(self._refresh_token)
         if not (self.auth.cognito_token and self.auth.id_token):
             await self.auth.authenticate()
+        self._refresh_token = self.auth.refresh_token
         headers["cognito-token"] = self.auth.cognito_token
         headers["id-token"] = self.auth.id_token
         return self._HEADERS | headers
@@ -64,7 +78,7 @@ class HonConnectionHandler(ConnectionHandler):
                 self.auth.token_expires_soon or response.status in [401, 403]
             ) and loop == 0:
                 _LOGGER.info("Try refreshing token...")
-                await self.auth.refresh()
+                await self.auth.refresh(self._refresh_token)
                 async with self._intercept(
                     method, url, *args, loop=loop + 1, **kwargs
                 ) as result:

pyhon/connection/mqtt.py

@@ -0,0 +1,146 @@
+import asyncio
+import json
+import logging
+import secrets
+from typing import TYPE_CHECKING
+
+from awscrt import mqtt5
+from awsiot import mqtt5_client_builder  # type: ignore[import-untyped]
+
+from pyhon import const
+from pyhon.appliance import HonAppliance
+
+if TYPE_CHECKING:
+    from pyhon import Hon
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class MQTTClient:
+    def __init__(self, hon: "Hon", mobile_id: str) -> None:
+        self._client: mqtt5.Client | None = None
+        self._hon = hon
+        self._mobile_id = mobile_id or const.MOBILE_ID
+        self._api = hon.api
+        self._appliances = hon.appliances
+        self._connection = False
+        self._watchdog_task: asyncio.Task[None] | None = None
+
+    @property
+    def client(self) -> mqtt5.Client:
+        if self._client is not None:
+            return self._client
+        raise AttributeError("Client is not set")
+
+    async def create(self) -> "MQTTClient":
+        await self._start()
+        self._subscribe_appliances()
+        await self.start_watchdog()
+        return self
+
+    def _on_lifecycle_stopped(
+        self, lifecycle_stopped_data: mqtt5.LifecycleStoppedData
+    ) -> None:
+        _LOGGER.info("Lifecycle Stopped: %s", str(lifecycle_stopped_data))
+
+    def _on_lifecycle_connection_success(
+        self,
+        lifecycle_connect_success_data: mqtt5.LifecycleConnectSuccessData,
+    ) -> None:
+        self._connection = True
+        _LOGGER.info(
+            "Lifecycle Connection Success: %s", str(lifecycle_connect_success_data)
+        )
+
+    def _on_lifecycle_attempting_connect(
+        self,
+        lifecycle_attempting_connect_data: mqtt5.LifecycleAttemptingConnectData,
+    ) -> None:
+        _LOGGER.info(
+            "Lifecycle Attempting Connect - %s", str(lifecycle_attempting_connect_data)
+        )
+
+    def _on_lifecycle_connection_failure(
+        self,
+        lifecycle_connection_failure_data: mqtt5.LifecycleConnectFailureData,
+    ) -> None:
+        self._connection = False
+        _LOGGER.info(
+            "Lifecycle Connection Failure - %s", str(lifecycle_connection_failure_data)
+        )
+
+    def _on_lifecycle_disconnection(
+        self,
+        lifecycle_disconnect_data: mqtt5.LifecycleDisconnectData,
+    ) -> None:
+        self._connection = False
+        _LOGGER.info("Lifecycle Disconnection - %s", str(lifecycle_disconnect_data))
+
+    def _on_publish_received(self, data: mqtt5.PublishReceivedData) -> None:
+        if not (data and data.publish_packet and data.publish_packet.payload):
+            return
+        payload = json.loads(data.publish_packet.payload.decode())
+        topic = data.publish_packet.topic
+        appliance = next(
+            a for a in self._appliances if topic in a.info["topics"]["subscribe"]
+        )
+        if topic and "appliancestatus" in topic:
+            for parameter in payload["parameters"]:
+                appliance.attributes["parameters"][parameter["parName"]].update(
+                    parameter
+                )
+            appliance.sync_params_to_command("settings")
+        elif topic and "disconnected" in topic:
+            _LOGGER.info(
+                "Disconnected %s: %s",
+                appliance.nick_name,
+                payload.get("disconnectReason"),
+            )
+            appliance.connection = False
+        elif topic and "connected" in topic:
+            appliance.connection = True
+            _LOGGER.info("Connected %s", appliance.nick_name)
+        elif topic and "discovery" in topic:
+            _LOGGER.info("Discovered %s", appliance.nick_name)
+        self._hon.notify()
+        _LOGGER.info("%s - %s", topic, payload)
+
+    async def _start(self) -> None:
+        self._client = mqtt5_client_builder.websockets_with_custom_authorizer(
+            endpoint=const.AWS_ENDPOINT,
+            auth_authorizer_name=const.AWS_AUTHORIZER,
+            auth_authorizer_signature=await self._api.load_aws_token(),
+            auth_token_key_name="token",
+            auth_token_value=self._api.auth.id_token,
+            client_id=f"{self._mobile_id}_{secrets.token_hex(8)}",
+            on_lifecycle_stopped=self._on_lifecycle_stopped,
+            on_lifecycle_connection_success=self._on_lifecycle_connection_success,
+            on_lifecycle_attempting_connect=self._on_lifecycle_attempting_connect,
+            on_lifecycle_connection_failure=self._on_lifecycle_connection_failure,
+            on_lifecycle_disconnection=self._on_lifecycle_disconnection,
+            on_publish_received=self._on_publish_received,
+        )
+        self.client.start()
+
+    def _subscribe_appliances(self) -> None:
+        for appliance in self._appliances:
+            self._subscribe(appliance)
+
+    def _subscribe(self, appliance: HonAppliance) -> None:
+        for topic in appliance.info.get("topics", {}).get("subscribe", []):
+            self.client.subscribe(
+                mqtt5.SubscribePacket([mqtt5.Subscription(topic)])
+            ).result(10)
+            _LOGGER.info("Subscribed to topic %s", topic)
+
+    async def start_watchdog(self) -> None:
+        if not self._watchdog_task or self._watchdog_task.done():
+            self._watchdog_task = asyncio.create_task(self._watchdog())
+
+    async def _watchdog(self) -> None:
+        while True:
+            await asyncio.sleep(5)
+            if not self._connection:
+                _LOGGER.info("Restart mqtt connection")
+                await self._start()
+                self._subscribe_appliances()

pyhon/const.py

@@ -1,13 +1,16 @@
 AUTH_API = "https://account2.hon-smarthome.com"
 API_URL = "https://api-iot.he.services"
 API_KEY = "GRCqFhC6Gk@ikWXm1RmnSmX1cm,MxY-configuration"
+AWS_ENDPOINT = "a30f6tqw0oh1x0-ats.iot.eu-west-1.amazonaws.com"
+AWS_AUTHORIZER = "candy-iot-authorizer"
 APP = "hon"
 CLIENT_ID = (
     "3MVG9QDx8IX8nP5T2Ha8ofvlmjLZl5L_gvfbT9."
     "HJvpHGKoAS_dcMN8LYpTSYeVFCraUnV.2Ag1Ki7m4znVO6"
 )
-APP_VERSION = "2.4.7"
-OS_VERSION = 31
+APP_VERSION = "2.6.5"
+OS_VERSION = 999
 OS = "android"
-DEVICE_MODEL = "exynos9820"
-USER_AGENT = "Chrome/110.0.5481.153"
+DEVICE_MODEL = "pyhOn"
+USER_AGENT = "Chrome/999.999.999.999"
+MOBILE_ID = "pyhOn"

pyhon/hon.py

@@ -1,8 +1,7 @@
-import asyncio
 import logging
 from pathlib import Path
 from types import TracebackType
-from typing import List, Optional, Dict, Any, Type
+from typing import List, Optional, Dict, Any, Type, Callable
 
 from aiohttp import ClientSession
 from typing_extensions import Self
@@ -10,17 +9,21 @@ from typing_extensions import Self
 from pyhon.appliance import HonAppliance
 from pyhon.connection.api import HonAPI
 from pyhon.connection.api import TestAPI
+from pyhon.connection.mqtt import MQTTClient
 from pyhon.exceptions import NoAuthenticationException
 
 _LOGGER = logging.getLogger(__name__)
 
 
+# pylint: disable=too-many-instance-attributes
 class Hon:
     def __init__(
         self,
         email: Optional[str] = "",
         password: Optional[str] = "",
         session: Optional[ClientSession] = None,
+        mobile_id: str = "",
+        refresh_token: str = "",
         test_data_path: Optional[Path] = None,
     ):
         self._email: Optional[str] = email
@@ -29,6 +32,10 @@ class Hon:
         self._appliances: List[HonAppliance] = []
         self._api: Optional[HonAPI] = None
         self._test_data_path: Path = test_data_path or Path().cwd()
+        self._mobile_id: str = mobile_id
+        self._refresh_token: str = refresh_token
+        self._mqtt_client: MQTTClient | None = None
+        self._notify_function: Optional[Callable[[Any], None]] = None
 
     async def __aenter__(self) -> Self:
         return await self.create()
@@ -61,7 +68,11 @@ class Hon:
 
     async def create(self) -> Self:
         self._api = await HonAPI(
-            self.email, self.password, session=self._session
+            self.email,
+            self.password,
+            session=self._session,
+            mobile_id=self._mobile_id,
+            refresh_token=self._refresh_token,
         ).create()
         await self.setup()
         return self
@@ -81,13 +92,9 @@ class Hon:
         if appliance.mac_address == "":
             return
         try:
-            await asyncio.gather(
-                *[
-                    appliance.load_attributes(),
-                    appliance.load_commands(),
-                    appliance.load_statistics(),
-                ]
-            )
+            await appliance.load_commands()
+            await appliance.load_attributes()
+            await appliance.load_statistics()
         except (KeyError, ValueError, IndexError) as error:
             _LOGGER.exception(error)
             _LOGGER.error("Device data - %s", appliance_data)
@@ -103,11 +110,24 @@ class Hon:
                     )
             await self._create_appliance(appliance, self.api)
         if (
-            test_data := self._test_data_path / "hon-test-data" / "test_data"
-        ).exists() or (test_data := test_data / "test_data").exists():
+            self._test_data_path
+            and (
+                test_data := self._test_data_path / "hon-test-data" / "test_data"
+            ).exists()
+            or (test_data := test_data / "..").exists()
+        ):
             api = TestAPI(test_data)
             for appliance in await api.load_appliances():
                 await self._create_appliance(appliance, api)
+        if not self._mqtt_client:
+            self._mqtt_client = await MQTTClient(self, self._mobile_id).create()
+
+    def subscribe_updates(self, notify_function: Callable[[Any], None]) -> None:
+        self._notify_function = notify_function
+
+    def notify(self) -> None:
+        if self._notify_function:
+            self._notify_function(None)
 
     async def close(self) -> None:
         await self.api.close()

pyhon/parameter/program.py

@@ -45,7 +45,7 @@ class HonParameterProgram(HonParameterEnum):
         for name, parameter in self._programs.items():
             if "iot_" in name:
                 continue
-            if parameter.parameters.get("prCode"):
+            if not parameter.parameters.get("prCode"):
                 continue
             if (fav := parameter.parameters.get("favourite")) and fav.value == "1":
                 continue

pyhon/parameter/range.py

@@ -69,4 +69,9 @@ class HonParameterRange(HonParameter):
 
     @property
     def values(self) -> List[str]:
-        return [str(i) for i in range(int(self.min), int(self.max) + 1, int(self.step))]
+        result = []
+        i = self.min
+        while i <= self.max:
+            result.append(str(i))
+            i += self.step
+        return result

pyhon/typedefs.py

@@ -14,8 +14,7 @@ if TYPE_CHECKING:
 class Callback(Protocol):  # pylint: disable=too-few-public-methods
     def __call__(
         self, url: str | URL, *args: Any, **kwargs: Any
-    ) -> aiohttp.client._RequestContextManager:
-        ...
+    ) -> aiohttp.client._RequestContextManager: ...
 
 
 Parameter = Union[

requirements.txt

@@ -1,3 +1,4 @@
-aiohttp>=3.8
+aiohttp>=3.8.6
 yarl>=1.8
 typing-extensions>=4.8
+awsiotsdk>=1.21.0

requirements_dev.txt

@@ -3,3 +3,4 @@ flake8>=6.0
 mypy>=0.991
 pylint>=2.15
 setuptools>=62.3
+types-awscrt

setup.py

@@ -7,7 +7,7 @@ with open("README.md", "r", encoding="utf-8") as f:
 
 setup(
     name="pyhOn",
-    version="0.15.14",
+    version="0.17.5",
     author="Andre Basche",
     description="Control hOn devices with python",
     long_description=long_description,
@@ -21,7 +21,12 @@ setup(
     packages=find_packages(),
     include_package_data=True,
     python_requires=">=3.10",
-    install_requires=["aiohttp>=3.8", "typing-extensions>=4.8", "yarl>=1.8"],
+    install_requires=[
+        "aiohttp>=3.8.6",
+        "typing-extensions>=4.8",
+        "yarl>=1.8",
+        "awsiotsdk>=1.21.0",
+    ],
     classifiers=[
         "Development Status :: 4 - Beta",
         "Environment :: Console",