Merge branch 'fix_example_readme' into 'main'

Minor updates to the examples README files

See merge request app-frameworks/esp-matter!181
This commit is contained in:
Hrishikesh Dhayagude
2022-08-27 10:35:17 +08:00
4 changed files with 17 additions and 18 deletions
+5 -5
View File
@@ -1,11 +1,11 @@
# ESP Matter
# Espressif's SDK for Matter
## Introduction
ESP Matter is the official Matter development framework for Espressifs ESP32 series SoCs. It is built on top of the [open source Matter SDK](https://github.com/project-chip/connectedhomeip/), and provides simplified APIs, commonly used peripherals, tools and utilities for security, manufacturing and production accompanied by exhaustive documentation. It includes rich production references, aimed to simplify the development process of Matter products and enable the users to go to production in the shortest possible time.
Espressif's SDK for Matter is the official Matter development framework for ESP32 series SoCs. It is built on top of the [open source Matter SDK](https://github.com/project-chip/connectedhomeip/), and provides simplified APIs, commonly used peripherals, tools and utilities for security, manufacturing and production accompanied by exhaustive documentation. It includes rich production references, aimed to simplify the development process of Matter products and enable the users to go to production in the shortest possible time.
## Get ESP Matter
## Get the repository
Please clone this repository using the below command:
@@ -18,11 +18,11 @@ git clone --recursive https://github.com/espressif/esp-matter.git
## Supported ESP-IDF and connectedhomeip versions
- ESP Matter currently works with [commit 68dbb8f](https://github.com/project-chip/connectedhomeip/tree/68dbb8f) of connectedhomeip.
- This SDK currently works with [commit 069b09b](https://github.com/espressif/connectedhomeip/tree/069b09b5f31d07d0772cfef91ba8010237f81b49) of connectedhomeip.
- For Wi-Fi devices (ESP32, ESP32-C3, ESP32-S3), ESP-IDF [v4.4.2 release](https://github.com/espressif/esp-idf/releases/tag/v4.4.2) is required.
- For Thread devices (ESP32-H2) and Zigbee Bridge example, ESP-IDF release/v5.0 branch at [commit ccdeb43](https://github.com/espressif/esp-idf/tree/ccdeb43) should be used.
## Documentation
Refer [ESP Matter Programming Guide](https://docs.espressif.com/projects/esp-matter/en/main/) for the latest version of the documentation.
Refer the [Programming Guide](https://docs.espressif.com/projects/esp-matter/en/main/) for the latest version of the documentation.
+4 -4
View File
@@ -16,7 +16,7 @@ You can read the parts list from the Bridge to get the number of the
bridged devices.
```
chip-tool descriptor read parts-list 0x7283 0x0
descriptor read parts-list 0x7283 0x0
```
If there is no other BLE Mesh device on the BLE Mesh Network, you will get
@@ -43,7 +43,7 @@ endpoint will be added on the Bridge device. You can read the parts list
again to get the dynamic endpoint ID.
```
chip-tool descriptor read parts-list 0x7283 0
descriptor read parts-list 0x7283 0
```
The data will now contain the information of the connected BLE Mesh
@@ -59,7 +59,7 @@ It means that the BLE Mesh Node is added as Endpoint 1 on the Bridge
device. You can read the cluster servers list on the dynamic endpoint.
```
chip-tool descriptor read server-list 0x7283 1
descriptor read server-list 0x7283 1
```
This will give the list of supported server clusters. Example:
@@ -77,7 +77,7 @@ OnDescriptorServerListListAttributeResponse: 4 entries
Now you can control the BLE Mesh Node on chip tool.
```
./out/chip-tool onoff toggle 0x7283 1
onoff toggle 0x7283 1
```
## 3. Device Performance
+4 -5
View File
@@ -1,7 +1,6 @@
# Light Switch
This example creates an On/Off Light Switch device using the ESP Matter
data model.
This example creates an On/Off Light Switch device using the data model.
It creates the On/Off client and other devices can be bound to the
switch and then controlled from the switch.
@@ -31,13 +30,13 @@ For the commands below:
Update the light's acl attribute to add the entry of remote device
(switch) in the access control list:
```
chip-tool accesscontrol write acl '[{"fabricIndex": 1, "privilege": 5, "authMode": 2, "subjects": [ 112233, 29315 ], "targets": null}]' 0x5164 0x0
accesscontrol write acl '[{"fabricIndex": 1, "privilege": 5, "authMode": 2, "subjects": [ 112233, 29315 ], "targets": null}]' 0x5164 0x0
```
Update the switch's binding attribute to add the entry of remote device
(light) in the binding table:
```
chip-tool binding write binding '[{"fabricIndex": 1, "node":20836, "endpoint":1, "cluster":6}]' 0x7283 0x1
binding write binding '[{"fabricIndex": 1, "node":20836, "endpoint":1, "cluster":6}]' 0x7283 0x1
```
### 2.2 Device console
@@ -98,7 +97,7 @@ Applications that do not require BLE post commissioning, can disable it using ap
My light is not getting bound to my switch:
- Make sure the light's acl is updated. You can read it again to make
sure it is correct: `chip-tool accesscontrol read acl 0x5164 0x0`.
sure it is correct: `accesscontrol read acl 0x5164 0x0`.
- If you are still facing issues, reproduce the issue on the default
example for the device and then raise an [issue](https://github.com/espressif/esp-matter/issues).
Make sure to share these:
+4 -4
View File
@@ -41,7 +41,7 @@ You can read the parts list from the Bridge to get the number of the
bridged devices.
```
chip-tool descriptor read parts-list 0x7283 0x0
descriptor read parts-list 0x7283 0x0
```
If there is no other Zigbee device on the Zigbee Network, you will get
@@ -68,7 +68,7 @@ endpoint will be added on the Bridge device. You can read the parts list
again to get the dynamic endpoint ID.
```
chip-tool descriptor read parts-list 0x7283 0x0
descriptor read parts-list 0x7283 0x0
```
The data will now contain the information of the connected Zigbee
@@ -84,7 +84,7 @@ It means that the Zigbee Bulb is added as Endpoint 1 on the Bridge
device. You can read the cluster servers list on the dynamic endpoint.
```
chip-tool descriptor read server-list 0x7283 0x1
descriptor read server-list 0x7283 0x1
```
This will give the list of supported server clusters. Example:
@@ -102,7 +102,7 @@ OnDescriptorServerListListAttributeResponse: 4 entries
Now you can control the Zigbee bulb using the chip tool.
```
chip-tool onoff toggle 0x7283 0x1
onoff toggle 0x7283 0x1
```
## 3. Device Performance