From bba65d12b2b9a3fb16555ba4233c37c88f5bf031 Mon Sep 17 00:00:00 2001 From: Stefan Agner Date: Fri, 17 May 2024 11:10:56 +0200 Subject: [PATCH] Update/reword main QUICK_START and READMEs --- docs/QUICK_START.md | 2 +- docs/guides/python_chip_controller_building.md | 4 ++-- src/controller/README.md | 2 +- src/controller/python/README.md | 14 +++++++++----- 4 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/QUICK_START.md b/docs/QUICK_START.md index 97f0f76b3b0436..10833e0c0c1ed7 100644 --- a/docs/QUICK_START.md +++ b/docs/QUICK_START.md @@ -10,7 +10,7 @@ and platforms. |
Controller / Admin
|
Node
| Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [**chip-tool**](https://github.com/project-chip/connectedhomeip/blob/master/examples/chip-tool/README.md) (Linux / Mac)
Includes docs for all the cluster commands supported
| **all-clusters-app**
  • [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)
  • [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. | -| [**chip-device-ctrl.py**](https://github.com/project-chip/connectedhomeip/blob/master/src/controller/python/README.md) | **all-clusters-app**
  • [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)
  • [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. | +| [**chip-repl**](https://github.com/project-chip/connectedhomeip/blob/master/src/controller/python/README.md) | **all-clusters-app**
  • [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)
  • [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. | ## Thread Nodes diff --git a/docs/guides/python_chip_controller_building.md b/docs/guides/python_chip_controller_building.md index be520817f5b7fa..3533a2978ab820 100644 --- a/docs/guides/python_chip_controller_building.md +++ b/docs/guides/python_chip_controller_building.md @@ -1,7 +1,7 @@ # Working with Python CHIP Controller -The Python CHIP Controller is a tool that allows to commission a Matter device -into the network and to communicate with it. +The Python CHIP controller is a library that allows to create a Matter fabric +and commission Matter devices with it. The `chip-repl` is a REPl which sets up a Python CHIP Controller and allows to explore the Python CHIP Controller API and communicate with devices from the diff --git a/src/controller/README.md b/src/controller/README.md index e46c191f55489b..70a3fa5e8f8352 100644 --- a/src/controller/README.md +++ b/src/controller/README.md @@ -26,7 +26,7 @@ The POSIX CLI chip-tool is located in ### Python -The Python chip-device-ctrl is located in +The Python CHIP Controller library is located in [../controller/python/](../controller/python). ## Feature Overview diff --git a/src/controller/python/README.md b/src/controller/python/README.md index 34edea444650b1..e94a95e1585e0b 100644 --- a/src/controller/python/README.md +++ b/src/controller/python/README.md @@ -1,10 +1,14 @@ -# Python CHIP Device Controller +# Python CHIP Controller -The Python CHIP controller is a tool that allows to commission a Matter device -into the network and to communicate with it using the Zigbee Cluster Library -(ZCL) messages. The tool uses the generic [Chip Device Controller](../) library. +The Python CHIP controller is a library that allows to create a Matter fabric +and commission Matter devices with it, as well as communicate with commissioned +devices by reading/subscribing and writing Attributes and sending Commands. The +Python CHIP controller is based on the native [Chip Device Controller](../) +library. -To learn more about the tool, how to build it and use its commands and advanced +The Python CHIP Controller comes with a REPL which allows to explore and use the +Python CHIP controller library from a shell. To learn more about the Python CHIP +Controller and the REPL, how to build it and use its commands and advanced features, read the following guides: - [Working with Python CHIP Controller](../../../docs/guides/python_chip_controller_building.md)