From 71538ff108b1c46294f7a120c409ffcd151f00e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludovic=20BOU=C3=89?= Date: Tue, 10 Dec 2024 16:22:50 +0100 Subject: [PATCH 1/2] Update README.md Start the server in debug log-level --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8df68204..7320cfb9 100644 --- a/README.md +++ b/README.md @@ -158,9 +158,12 @@ Development is only possible on a (recent) Linux or MacOS machine. Other operati - Download/clone the repo to your local machine. - Set-up the development environment: `scripts/setup.sh` -You can check out the example script in the scripts folder for generic directions to run the client and server. +### Start Matter server -To just run the server, you can run: `python -m matter_server.server` +You can check out the [example script](/scripts/example.py) in the scripts folder for generic directions to run the client and server. + +* To run the server in `info` log-level, you can run: `python -m matter_server.server` +* To start the server in `debug` log-level, you can run: `python -m matter_server.server --log-level debug` The server runs a Matter Controller and includes all logic for storing node information, interviews and subscriptions. To interact with this controller we've created a small Websockets API with an RPC-like interface. The library contains a client as reference implementation which in turn is used by Home Assistant. Splitting the server from the client allows the scenario where multiple consumers can communicate to the same Matter fabric and the Matter fabric can keep running while the consumer (e.g. Home Assistant is down). From 00e96a37799a377c811bbcfc5d320c9ff4d9f32e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludovic=20BOU=C3=89?= Date: Wed, 11 Dec 2024 15:12:35 +0100 Subject: [PATCH 2/2] Update README.md Co-authored-by: Stefan Agner --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 7320cfb9..0b65ae73 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,9 @@ You can check out the [example script](/scripts/example.py) in the scripts folde * To run the server in `info` log-level, you can run: `python -m matter_server.server` * To start the server in `debug` log-level, you can run: `python -m matter_server.server --log-level debug` +* To start the server with SDK in `progress` log-level, you can run: `python -m matter_server.server --log-level-sdk progress`. This will display more information from the Matter SDK (C++) side of the Matter Server. + +Use `--help` to get a list of possible log levels and other command line arguments. The server runs a Matter Controller and includes all logic for storing node information, interviews and subscriptions. To interact with this controller we've created a small Websockets API with an RPC-like interface. The library contains a client as reference implementation which in turn is used by Home Assistant. Splitting the server from the client allows the scenario where multiple consumers can communicate to the same Matter fabric and the Matter fabric can keep running while the consumer (e.g. Home Assistant is down).