Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain how to start the server with debug log-level #999

Merged
merged 2 commits into from
Dec 11, 2024
Merged

Explain how to start the server with debug log-level #999

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71538ff
Update README.md
lboue Dec 10, 2024
00e96a3
Update README.md
lboue Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
lboue marked this conversation as resolved.
Show resolved Hide resolved

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

Expand Down
Loading