Skip to content

Improve README readability #964

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

Merged
merged 2 commits into from
Nov 25, 2024
Merged
Changes from all commits
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
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ NOTE: Both Matter and this implementation are in an early state and features are
This list is not intended to be complete, for a complete oversight see the client implementation.

**Set WiFi credentials**

Inform the controller about the WiFi credentials it needs to send when commissioning a new device.

```json
Expand All @@ -151,6 +152,7 @@ Inform the controller about the WiFi credentials it needs to send when commissio
```

**Set Thread dataset**

Inform the controller about the Thread credentials it needs to use when commissioning a new device.

```json
Expand All @@ -164,6 +166,7 @@ Inform the controller about the Thread credentials it needs to use when commissi
```

**Commission with code**

Commission a new device. For WiFi or Thread based devices, the credentials need to be set upfront, otherwise, commissioning will fail. Supports both QR-code syntax (MT:...) and manual pairing code as string.
The controller will use bluetooth for the commissioning of wireless devices. If the machine running the Python Matter Server controller lacks Bluetooth support, commissioning will only work for devices already connected to the network (by cable or another controller).

Expand All @@ -178,6 +181,7 @@ The controller will use bluetooth for the commissioning of wireless devices. If
```

**Open Commissioning window**

Open a commissioning window to commission a device present on this controller to another.
Returns code to use as discriminator.

Expand All @@ -192,6 +196,7 @@ Returns code to use as discriminator.
```

**Get Nodes**

Get all nodes already commissioned on the controller.

```json
Expand All @@ -202,6 +207,7 @@ Get all nodes already commissioned on the controller.
```

**Get Node**

Get info of a single Node.

```json
Expand All @@ -215,6 +221,7 @@ Get info of a single Node.
```

**Start listening**

When the start_listening command is issued, the server will dump all existing nodes. From that moment on all events (including node attribute changes) will be forwarded.

```json
Expand All @@ -225,6 +232,7 @@ When the start_listening command is issued, the server will dump all existing no
```

**Send a command**

Because we use the datamodels of the Matter SDK, this is a little bit more involved. Here is an example of turning on a switch:

```python
Expand Down Expand Up @@ -271,7 +279,7 @@ print(json.dumps(message, indent=2))

You can also provide parameters for the cluster commands. Here's how to change the brightness for example:

```
```python
command = clusters.LevelControl.Commands.MoveToLevelWithOnOff(
level=int(value), # provide a percentage
transitionTime=0, # in seconds
Expand Down
Loading