feat: first commit

custom_components/xiaomi_home/miot/common.py

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+"""
+Copyright (C) 2024 Xiaomi Corporation.
+
+The ownership and intellectual property rights of Xiaomi Home Assistant
+Integration and related Xiaomi cloud service API interface provided under this
+license, including source code and object code (collectively, "Licensed Work"),
+are owned by Xiaomi. Subject to the terms and conditions of this License, Xiaomi
+hereby grants you a personal, limited, non-exclusive, non-transferable,
+non-sublicensable, and royalty-free license to reproduce, use, modify, and
+distribute the Licensed Work only for your use of Home Assistant for
+non-commercial purposes. For the avoidance of doubt, Xiaomi does not authorize
+you to use the Licensed Work for any other purpose, including but not limited
+to use Licensed Work to develop applications (APP), Web services, and other
+forms of software.
+
+You may reproduce and distribute copies of the Licensed Work, with or without
+modifications, whether in source or object form, provided that you must give
+any other recipients of the Licensed Work a copy of this License and retain all
+copyright and disclaimers.
+
+Xiaomi provides the Licensed Work on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied, including, without
+limitation, any warranties, undertakes, or conditions of TITLE, NO ERROR OR
+OMISSION, CONTINUITY, RELIABILITY, NON-INFRINGEMENT, MERCHANTABILITY, or
+FITNESS FOR A PARTICULAR PURPOSE. In any event, you are solely responsible
+for any direct, indirect, special, incidental, or consequential damages or
+losses arising from the use or inability to use the Licensed Work.
+
+Xiaomi reserves all rights not expressly granted to you in this License.
+Except for the rights expressly granted by Xiaomi under this License, Xiaomi
+does not authorize you in any form to use the trademarks, copyrights, or other
+forms of intellectual property rights of Xiaomi and its affiliates, including,
+without limitation, without obtaining other written permission from Xiaomi, you
+shall not use "Xiaomi", "Mijia" and other words related to Xiaomi or words that
+may make the public associate with Xiaomi in any form to publicize or promote
+the software or hardware devices that use the Licensed Work.
+
+Xiaomi has the right to immediately terminate all your authorization under this
+License in the event:
+1. You assert patent invalidation, litigation, or other claims against patents
+or other intellectual property rights of Xiaomi or its affiliates; or,
+2. You make, have made, manufacture, sell, or offer to sell products that knock
+off Xiaomi or its affiliates' products.
+
+Common utilities.
+"""
+import json
+import random
+from typing import Optional
+import hashlib
+from paho.mqtt.client import MQTTMatcher
+
+
+def calc_group_id(uid: str, home_id: str) -> str:
+    """Calculate the group ID based on a user ID and a home ID."""
+    return hashlib.sha1(
+        f'{uid}central_service{home_id}'.encode('utf-8')).hexdigest()[:16]
+
+
+def load_json_file(json_file: str) -> dict:
+    """Load a JSON file."""
+    with open(json_file, 'r', encoding='utf-8') as f:
+        return json.load(f)
+
+
+def randomize_int(value: int, ratio: float) -> int:
+    """Randomize an integer value."""
+    return int(value * (1 - ratio + random.random()*2*ratio))
+
+
+class MIoTMatcher(MQTTMatcher):
+    """MIoT Pub/Sub topic matcher."""
+
+    def iter_all_nodes(self) -> any:
+        """Return an iterator on all nodes with their paths and contents."""
+        def rec(node, path):
+            # pylint: disable=protected-access
+            if node._content:
+                yield ('/'.join(path), node._content)
+            for part, child in node._children.items():
+                yield from rec(child, path + [part])
+        return rec(self._root, [])
+
+    def get(self, topic: str) -> Optional[any]:
+        try:
+            return self[topic]
+        except KeyError:
+            return None