Skip to content

Commit 1ccee23

Browse files
lboueagners
andauthored
Explain how to start the server with debug log-level (#999)
Co-authored-by: Stefan Agner <stefan@agner.ch>
1 parent 5205f31 commit 1ccee23

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,15 @@ Development is only possible on a (recent) Linux or MacOS machine. Other operati
158158
- Download/clone the repo to your local machine.
159159
- Set-up the development environment: `scripts/setup.sh`
160160

161-
You can check out the example script in the scripts folder for generic directions to run the client and server.
161+
### Start Matter server
162162

163-
To just run the server, you can run: `python -m matter_server.server`
163+
You can check out the [example script](/scripts/example.py) in the scripts folder for generic directions to run the client and server.
164+
165+
* To run the server in `info` log-level, you can run: `python -m matter_server.server`
166+
* To start the server in `debug` log-level, you can run: `python -m matter_server.server --log-level debug`
167+
* 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.
168+
169+
Use `--help` to get a list of possible log levels and other command line arguments.
164170

165171
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).
166172

0 commit comments

Comments
 (0)