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.

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

Developer documentation: /data & IPv4 group limits #1081

Merged
Changes from 1 commit
Commits
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: 7 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ 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`
- Create the `/data` directory if it does not exist with permissions for the user running the python-matter-server.

## Start Matter server

Expand All @@ -19,6 +20,12 @@ Use `--help` to get a list of possible log levels and other command line argumen

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

If you happen to get `OSError: [Errno 105] No buffer space available.`, increase the IPv4 group limits with:
```
echo "net.ipv4.igmp_max_memberships=1024" >> sysctl.conf
sudo sysctl -p sysctl.conf
```

## Python client library only

There is also a Python client library hosted in this repository (used by Home Assistant), which consumes the Websockets API published from the server.
Expand Down