Skip to content

Commit 5205f31

Browse files
authored
Change name in readme + pyproject to reflect the certified name (#998)
1 parent 22fe9ff commit 5205f31

File tree

2 files changed

+16
-17
lines changed

2 files changed

+16
-17
lines changed

README.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
1-
# Python Matter Server
1+
# Open Home Foundation Matter Server
2+
3+
The Open Home Foundation Matter Server is an [officially certified](https://csa-iot.org/csa_product/open-home-foundation-matter-server/) Software Component to create a Matter controller. It serves as the foundation to provide Matter support to [Home Assistant](https://home-assistant.io) but its universal approach makes it suitable to be used in other projects too.
24

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

7-
The goal of this project is primarily to have Matter support in Home Assistant
8-
but its universal approach makes it suitable to be used in other projects too.
9-
10-
[![Python Matter Server - A library from the Open Home Foundation](https://www.openhomefoundation.org/badges/python-matter-server.png)](https://www.openhomefoundation.org/)
9+
The Open Home Foundation Matter Server software component is funded by [Nabu Casa](https://www.nabucasa.com/) (a member of the CSA) and donated to [The Open Home Foundation](<(https://www.openhomefoundation.org/)>).
1110

1211
## Support
1312

14-
Got questions?
15-
16-
You have several options to get them answered:
13+
For users of Home Assistant, seek support in the official Home Assistant support channels.
1714

1815
- The Home Assistant [Community Forum](https://community.home-assistant.io/).
1916
- The Home Assistant [Discord Chat Server](https://discord.gg/c5DvZ4e).
@@ -22,8 +19,9 @@ You have several options to get them answered:
2219
If you experience issues using Matter with Home Assistant, please open an issue
2320
report in the [Home Assistant Core repository](https://github.com/home-assistant/core/issues/new/choose).
2421

25-
You may also open issues in this repository if you are absolutely sure that your
26-
issue is related to the Matter Server component.
22+
Please do not create Home Assistant enduser support issues in the issue tracker of this repository.
23+
24+
For developers, making use of this component, use the issue tracker within this repository and/or reach out on discord.
2725

2826
## Installation
2927

@@ -112,6 +110,7 @@ docker run -d \
112110
> The container has a default command line set (see Dockerfile). If you intend to pass additional arguments, you have to pass the default command line as well.
113111
114112
To use local commissioning with Bluetooth, make sure to pass the D-Bus socket as well:
113+
115114
```
116115
docker run -d \
117116
--name matter-server \
@@ -136,12 +135,12 @@ NOTE: Both Matter and this implementation are in an early state and features are
136135

137136
> [!NOTE]
138137
> When communicating with Thread devices through a non-local Thread border router,
139-
your host must process ICMPv6 Router Advertisements. See the [openthread.io
140-
Bidirectional IPv6 Connectivity code labs](https://openthread.io/codelabs/openthread-border-router#6)
141-
on how-to setup your host correctly. Note that NetworkManager has its own ICMPv6
142-
Router Advertisement processing. A recent version of NetworkManager is
143-
necessary, and there are still known issues (see NetworkManager issue
144-
[#1232](https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/issues/1232)).
138+
> your host must process ICMPv6 Router Advertisements. See the [openthread.io
139+
> Bidirectional IPv6 Connectivity code labs](https://openthread.io/codelabs/openthread-border-router#6)
140+
> on how-to setup your host correctly. Note that NetworkManager has its own ICMPv6
141+
> Router Advertisement processing. A recent version of NetworkManager is
142+
> necessary, and there are still known issues (see NetworkManager issue
143+
> [#1232](https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/issues/1232)).
145144
146145
The Home Assistant Operating System 10 and newer correctly processes ICMPv6
147146
Router Advertisements.

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ dependencies = [
2222
"orjson",
2323
"home-assistant-chip-clusters==2024.11.4",
2424
]
25-
description = "Python Matter WebSocket Server"
25+
description = "Open Home Foundation Matter Server"
2626
license = {text = "Apache-2.0"}
2727
name = "python-matter-server"
2828
readme = "README.md"

0 commit comments

Comments
 (0)