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

Build container image on Python Matter server release #327

Merged
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,29 @@
# Python Matter Server

This project implements a Matter Controller Server over WebSockets using the [official Matter (formerly CHIP) SDK](https://github.com/project-chip/connectedhomeip) as a base and provides both a server and client implementation.
This project implements a Matter Controller Server over WebSockets using the
[official Matter (formerly CHIP) SDK](https://github.com/project-chip/connectedhomeip)
as a base and provides both a server and client implementation.

The goal of this project is primary to have Matter support in Home Assistant but its universal approach makes it suitable to be used in other projects too.
The goal of this project is primary to have Matter support in Home Assistant
but its universal approach makes it suitable to be used in other projects too.

## Support

Got questions?

You have several options to get them answered:

* The Home Assistant [Community Forum](https://community.home-assistant.io/).
* The Home Assistant [Discord Chat Server](https://discord.gg/c5DvZ4e).
* Join [the Reddit subreddit in /r/homeassistant](https://reddit.com/r/homeassistant).

If you experience issues using Matter with Home Assistant, please open an issue
report in the [Home Assistant Core repository](https://github.com/home-assistant/core/issues/new/choose).

You may also open issues in this repository if you are absolutely sure that your
issue in related to the Matter Server component.
marcelveldt marked this conversation as resolved.
Show resolved Hide resolved

## Installation

We strongly recommend to use Home Assistant OS along with the official Matter
Server add-on to use Matter with Home Assistant. The Matter integration
Expand All @@ -18,7 +39,7 @@ communication issues with Matter devices, especially Thread based devices.
This is mostly because the container installation uses host networking, and
relies on the networking managed by your operating system.

## Requirements to communicate with Wi-Fi/Ethernet based Thread devices
### Requirements to communicate with Wi-Fi/Ethernet based Thread devices

Make sure your you run the container on the host network. The host network
interface needs to be in the same network as the Android/iPhone device
Expand All @@ -27,7 +48,7 @@ which do not work accross different LANs or VLANs.

The host network interface needs IPv6 support enabled.

## Requirements to communicate with Thread devices through Thread border routers
### Requirements to communicate with Thread devices through Thread border routers

For communication through Thread border routers which are not running on the same
host as the Matter Controller server to work, IPv6 routing needs to be properly
Expand Down Expand Up @@ -67,7 +88,7 @@ sysctl -w net.ipv6.conf.wlan0.accept_ra_rt_info_max_plen=64
If your system has IPv6 forwarding enabled (not recommended, see above), you'll
have to use `2` for the accept_ra variable. See also the [Thread Border Router - Bidirectional IPv6 Connectivity and DNS-Based Service Discovery codelab](https://openthread.io/codelabs/openthread-border-router#6).

## Running the Matter Server using container image
### Running the Matter Server using container image

With the following command you can run the Matter Server in a container using
Docker. The Matter network data (fabric information) are stored in a newly
Expand Down