Refactor into single package

Author: balloob

README.md

@@ -34,14 +34,16 @@ mkdir $HOME/.chip-storage/
 With the following command the server can be run directly from the source tree.
 
 ```
-python3 -m chip_ws_server
+python3 -m matter_server.server
 ```
 
+_On MacOs you will have to run above command with 'sudo' as it requires to interact with BLE._
+
 The client does not need to be run in the Python CHIP Controller environment. It
 can be run from the source tree using:
 
 ```
-python3 -m chip_ws_server
+python3 -m matter_server.client
 ```
 
 ### Build and install
@@ -64,9 +66,11 @@ Instruction on how to create a test device can be found [here](https://nabucasa.
 Currently the easiest way to set up a test device is using the Python CHIP REPL. Start it by pointing it at the same storage location as the servier will run off:
 
 ```
-sudo chip-repl --storagepath=$HOME/.chip-storage/python-kv.json
+chip-repl --storagepath=$HOME/.chip-storage/python-kv.json
 ```
 
+_On MacOs you will have to run above command with 'sudo' as it requires to interact with BLE._
+
 Inside the Python REPL, configure your Wi-Fi credentials:
 
 ```python

main.py

@@ -1,6 +1,6 @@
 import sys
 
-from chip_ws_server.__main__ import main
+from matter_server.server.__main__ import main
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     sys.exit(main())

chip_ws_client/__init__.py matter_server/__init__.py

@@ -4,9 +4,9 @@
 import sys
 
 import aiohttp
-from chip.clusters import Objects as Clusters
+from matter_server.vendor.chip.clusters import Objects as Clusters
 
-from chip_ws_client.client import Client
+from matter_server.client.client import Client
 
 logging.basicConfig(level=logging.DEBUG)
 _LOGGER = logging.getLogger(__name__)
@@ -44,20 +44,20 @@ async def toggle_happiness(client: Client, is_initialized: asyncio.Event):
         nodeid = 4335
 
         # This (now) throws exceptions if it fails
-        await client.driver.device_controller.ResolveNode(nodeid)
+        # await client.driver.device_controller.ResolveNode(nodeid)
 
-        node = await client.driver.device_controller.Read(
-            nodeid, attributes=[Clusters.OnOff], events="*", returnClusterObject=True
-        )
-        await asyncio.sleep(1)
+        # node = await client.driver.device_controller.Read(
+        #     nodeid, attributes=[Clusters.OnOff], events="*", returnClusterObject=True
+        # )
+        # await asyncio.sleep(1)
 
-        node = await client.driver.device_controller.Read(
-            nodeid, attributes="*", events="*", returnClusterObject=True
-        )
+        # node = await client.driver.device_controller.Read(
+        #     nodeid, attributes="*", events="*", returnClusterObject=True
+        # )
 
-        from pprint import pprint
+        # from pprint import pprint
 
-        pprint(node)
+        # pprint(node)
 
         while True:
             await asyncio.sleep(5)

chip_ws_client/model/__init__.py matter_server/client/__init__.py

@@ -15,17 +15,23 @@
 from types import TracebackType
 from typing import Any, DefaultDict, Dict, List, cast
 
-from aiohttp import (ClientSession, ClientWebSocketResponse, WSMsgType,
-                     client_exceptions)
-from chip_ws_common.json_utils import CHIPJSONEncoder
+from aiohttp import ClientSession, ClientWebSocketResponse, WSMsgType, client_exceptions
 
-from chip_ws_client.model.version import VersionInfoDataType
 
+from ..common.json_utils import CHIPJSONEncoder
+from .model.version import VersionInfoDataType
 from .const import MAX_SERVER_SCHEMA_VERSION, MIN_SERVER_SCHEMA_VERSION
 from .event import Event
-from .exceptions import (CannotConnect, ConnectionClosed, ConnectionFailed,
-                         FailedCommand, InvalidMessage, InvalidServerVersion,
-                         InvalidState, NotConnected)
+from .exceptions import (
+    CannotConnect,
+    ConnectionClosed,
+    ConnectionFailed,
+    FailedCommand,
+    InvalidMessage,
+    InvalidServerVersion,
+    InvalidState,
+    NotConnected,
+)
 from .model.driver import Driver
 from .model.version import VersionInfo
 
@@ -383,6 +389,12 @@ async def _send_json_message(self, message: Dict[str, Any]) -> None:
                     cmd_dict = asdict(value)
                     cls = type(value)
                     cmd_dict["_type"] = f"{cls.__module__}.{cls.__qualname__}"
+
+                    # Currently in client we have vendorized chip. Strip vendor prefix.
+                    strip_prefix = "matter_server.vendor."
+                    if cmd_dict["_type"].startswith(strip_prefix):
+                        cmd_dict["_type"] = cmd_dict["_type"][len(strip_prefix) :]
+
                     message["args"][arg] = cmd_dict
 
         if self._record_messages and message["messageId"] not in LISTEN_MESSAGE_IDS:
@@ -398,7 +410,9 @@ async def _send_json_message(self, message: Dict[str, Any]) -> None:
             )
 
         try:
-            await self._client.send_json(message, dumps=partial(json.dumps, cls=CHIPJSONEncoder))
+            await self._client.send_json(
+                message, dumps=partial(json.dumps, cls=CHIPJSONEncoder)
+            )
         except:
             self._logger.exception("Error sending JSON")
 

chip_ws_client/__main__.py matter_server/client/__main__.py

@@ -4,7 +4,7 @@
 if TYPE_CHECKING:
     from .. import client
 
-from chip.clusters import Objects as Clusters
+from matter_server.vendor.chip.clusters import Objects as Clusters
 
 from .device_controller import DeviceController
 

chip_ws_client/client.py matter_server/client/client.py

@@ -3,8 +3,14 @@
 import sys
 from enum import Enum
 
-import chip.clusters.Objects
-from chip.clusters.Types import Nullable
+# Compatible both with vendorized and not-vendorized
+try:
+    from chip.clusters import Objects as Clusters
+    from chip.clusters.Types import Nullable
+except ImportError:
+    from ..vendor.chip.clusters import Objects as Clusters
+    from ..vendor.chip.clusters.Types import Nullable
+
 
 CLUSTER_TYPE_NAMESPACE = "chip.clusters.Objects"
 
@@ -15,7 +21,7 @@ def default(self, obj):
             return None
         elif isinstance(obj, type):
             # Maybe we should restrict this to CHIP cluster types (see deserialization?)
-            return { "_class": f"{obj.__module__}.{obj.__qualname__}"}
+            return {"_class": f"{obj.__module__}.{obj.__qualname__}"}
         elif isinstance(obj, Enum):
             # Works for chip.clusters.Attributes.EventPriority,
             # might need more sophisticated solution for other Enums
@@ -39,19 +45,19 @@ def _get_class(self, type: str):
 
         cluster_type = type.removeprefix(f"{CLUSTER_TYPE_NAMESPACE}.")
 
-        cluster_cls = sys.modules[CLUSTER_TYPE_NAMESPACE]
+        cluster_cls = Clusters
         for cluster_subtype in cluster_type.split("."):
             cluster_cls = getattr(cluster_cls, cluster_subtype)
 
         return cluster_cls
 
     def object_hook(self, obj: dict):
-        if type := obj.get('_type'):
+        if type := obj.get("_type"):
             cls = self._get_class(type)
             # Delete the `_type` key as it isn't used in the dataclasses
-            del obj['_type']
+            del obj["_type"]
             return cls(**obj)
-        elif cls := obj.get('_class'):
+        elif cls := obj.get("_class"):
             return self._get_class(cls)
 
         return obj

chip_ws_client/const.py matter_server/client/const.py

@@ -10,17 +10,19 @@
 import aiohttp
 import aiohttp.web
 from chip.exceptions import ChipStackError
-from chip_ws_common.json_utils import CHIPJSONDecoder, CHIPJSONEncoder
 
-from chip_ws_server.server import CHIPControllerServer
+from .server import CHIPControllerServer
+from ..common.json_utils import CHIPJSONDecoder, CHIPJSONEncoder
 
 logging.basicConfig(level=logging.WARN)
 _LOGGER = logging.getLogger(__name__)
 _LOGGER.setLevel(logging.DEBUG)
 
 HOST = os.getenv("CHIP_WS_SERVER_HOST", "0.0.0.0")
 PORT = int(os.getenv("CHIP_WS_SERVER_PORT", 8080))
-STORAGE_PATH = os.getenv("CHIP_WS_STORAGE", Path.joinpath(Path.home(), ".chip-storage/python-kv.json"))
+STORAGE_PATH = os.getenv(
+    "CHIP_WS_STORAGE", Path.joinpath(Path.home(), ".chip-storage/python-kv.json")
+)
 
 
 def create_success_response(message, result):

chip_ws_client/event.py matter_server/client/event.py

@@ -1,16 +1,14 @@
 import logging
 
-import chip.clusters.Objects as Clusters
-import chip.FabricAdmin
+from chip.FabricAdmin import FabricAdmin
 import chip.logging
 import chip.native
 import coloredlogs
-from chip.ChipStack import *
-from chip.tlv import float32, uint
-from chip_ws_common.json_utils import CHIPJSONDecoder
+from chip.ChipStack import ChipStack
 
 _LOGGER = logging.getLogger(__name__)
 
+
 class CHIPControllerServer:
     def __init__(self):
         pass
@@ -22,7 +20,7 @@ def setup(self, storage_path):
         coloredlogs.install(level=logging.INFO)
         self._stack = ChipStack(persistentStoragePath=storage_path)
 
-        self._fabricAdmin = chip.FabricAdmin.FabricAdmin()
+        self._fabricAdmin = FabricAdmin()
 
         self.device_controller = self._fabricAdmin.NewController()
         _LOGGER.info("CHIP Controller Stack initialized")
@@ -31,16 +29,3 @@ def shutdown(self):
         _LOGGER.info("Shutdown CHIP Controller Server")
         self.device_controller.Shutdown()
         self._stack.Shutdown()
-
-    # async def send_command(
-    #     self,
-    #     nodeid: int,
-    #     endpoint: int,
-    #     payload: Clusters.ClusterCommand,
-    #     responseType=None,
-    #     timedRequestTimeoutMs: int = None,
-    # ):
-    #     _LOGGER.info(
-    #         "Sending command to node id %d, endpoint %d: %s", nodeid, endpoint, payload
-    #     )
-    #     await self.device_controller.SendCommand(nodeid, endpoint, payload)