Skip to content

Commit bba65d1

Browse files
committed
Update/reword main QUICK_START and READMEs
1 parent 8cb1b1d commit bba65d1

File tree

4 files changed

+13
-9
lines changed

4 files changed

+13
-9
lines changed

docs/QUICK_START.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ and platforms.
1010
| <div style="width:200px">Controller / Admin</div> | <div style="width:200px">Node</div> | Description |
1111
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1212
| [**chip-tool**](https://github.com/project-chip/connectedhomeip/blob/master/examples/chip-tool/README.md) (Linux / Mac)<br> Includes docs for all the cluster commands supported <br> | **all-clusters-app** <li> [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)<li>[Linux](https://github.com/project-chip/connectedhomeip/tree/master/examples/all-clusters-app/linux) simulation | Use the command line tool on a laptop to pair with and control an embedded Wi-Fi platform. This demo supports the “all-clusters-app”, so it provides the basic onoff light test and more. |
13-
| [**chip-device-ctrl.py**](https://github.com/project-chip/connectedhomeip/blob/master/src/controller/python/README.md) | **all-clusters-app**<li> [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)<li> [Linux](https://github.com/project-chip/connectedhomeip/tree/master/examples/all-clusters-app/linux) simulation | Same as above, but uses the pychip tool as Controller Node. |
13+
| [**chip-repl**](https://github.com/project-chip/connectedhomeip/blob/master/src/controller/python/README.md) | **all-clusters-app**<li> [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)<li> [Linux](https://github.com/project-chip/connectedhomeip/tree/master/examples/all-clusters-app/linux) simulation | Same as above, but uses the Python CHIP REPL as Controller Node. |
1414

1515
## Thread Nodes
1616

docs/guides/python_chip_controller_building.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Working with Python CHIP Controller
22

3-
The Python CHIP Controller is a tool that allows to commission a Matter device
4-
into the network and to communicate with it.
3+
The Python CHIP controller is a library that allows to create a Matter fabric
4+
and commission Matter devices with it.
55

66
The `chip-repl` is a REPl which sets up a Python CHIP Controller and allows to
77
explore the Python CHIP Controller API and communicate with devices from the

src/controller/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The POSIX CLI chip-tool is located in
2626

2727
### Python
2828

29-
The Python chip-device-ctrl is located in
29+
The Python CHIP Controller library is located in
3030
[../controller/python/](../controller/python).
3131

3232
## Feature Overview

src/controller/python/README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
1-
# Python CHIP Device Controller
1+
# Python CHIP Controller
22

3-
The Python CHIP controller is a tool that allows to commission a Matter device
4-
into the network and to communicate with it using the Zigbee Cluster Library
5-
(ZCL) messages. The tool uses the generic [Chip Device Controller](../) library.
3+
The Python CHIP controller is a library that allows to create a Matter fabric
4+
and commission Matter devices with it, as well as communicate with commissioned
5+
devices by reading/subscribing and writing Attributes and sending Commands. The
6+
Python CHIP controller is based on the native [Chip Device Controller](../)
7+
library.
68

7-
To learn more about the tool, how to build it and use its commands and advanced
9+
The Python CHIP Controller comes with a REPL which allows to explore and use the
10+
Python CHIP controller library from a shell. To learn more about the Python CHIP
11+
Controller and the REPL, how to build it and use its commands and advanced
812
features, read the following guides:
913

1014
- [Working with Python CHIP Controller](../../../docs/guides/python_chip_controller_building.md)

0 commit comments

Comments
 (0)