Skip to content

Commit ae052f4

Browse files
lboueSuGlider
andauthored
Update Matter Light README.md (#10357)
* Update Matter Light README.md Update Matter Light README.md * fix(matter): information in the commentaries from SuGlider * feat(matter): extended formating used the same formatting for the whole document and changed a few expresssions. * fix(matter): missing option idf.py --------- Co-authored-by: Rodrigo Garcia <[email protected]>
1 parent 7018cd1 commit ae052f4

File tree

1 file changed

+44
-21
lines changed
  • idf_component_examples/esp_matter_light

1 file changed

+44
-21
lines changed

idf_component_examples/esp_matter_light/README.md

+44-21
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
# Managed Component Light
66

7-
This example is configured by default to work with the ESP32-S3, which has the RGB LED GPIO set as pin 48 and the BOOT button on GPIO 0.
7+
This example sets automatically the RGB LED GPIO and BOOT Button GPIO based on the default pin used by the selected Devkit Board.
88

99
This example creates a Color Temperature Light device using the esp_matter component downloaded from the [Espressif Component Registry](https://components.espressif.com/) instead of an extra component locally, so the example can work without setting up the esp-matter environment.
1010

11-
See the [docs](https://docs.espressif.com/projects/esp-matter/en/latest/esp32/developing.html) for more information about building and flashing the firmware.
11+
Read the [documentation](https://docs.espressif.com/projects/esp-matter/en/latest/esp32/developing.html) for more information about building and flashing the firmware.
1212

1313
The code is based on the Arduino API and uses Arduino as an IDF Component.
1414

@@ -23,12 +23,13 @@ Possible Matter Environments are:
2323

2424
(*) Google Home Assistant requires the user to set up a Matter Light using the [Google Home Developer Console](https://developers.home.google.com/codelabs/matter-device#2). It is necessary to create a Matter Light device with VID = 0xFFF1 and PID = 0x8000. Otherwise, the Light won't show up in the GHA APP. This action is necessary because the Firmware uses Testing credentials and Google requires the user to create the testing device before using it.
2525

26-
There is no QR Code to be used when the Smartphone APP wants to add the Matter Device.
26+
**There is no QR Code** to be used when the Smartphone APP wants to add the Matter Device.
2727
Please enter the code manually: `34970112332`
2828

29-
The devboard has a built-in LED that will be used as the Matter Light.
30-
The default setting of the code uses pin 48 for the ESP32-S3.
31-
Please change it in `main/matter_accessory_driver.h` or in the `sdkconfig.defaults.<SOC>` file.
29+
Each Devkit Board has a built-in LED that will be used as the Matter Light.
30+
The default setting for ESP32-S3 is pin 48, for ESP32-C3 and ESP32-C6, it is pin 8.
31+
The BOOT Button pin of ESP32-S3 is GPIO 0, by toher hand, the ESP32-C3 and ESP32-C6 use GPIO 9.
32+
Please change it in using the MenuConfig executing `idf.py menuconfig` and selecting `Menu->Light Matter Accessory` options.
3233

3334
## LED Status and Factory Mode
3435

@@ -49,42 +50,64 @@ The built-in BOOT button will toggle On/Off and replicate the new state to the M
4950

5051
## Returning to the Factory State
5152

52-
Holding the BOOT button pressed for more than 10 seconds and then releasing it will erase all Matter and Wi-Fi configuration, forcing it to reset to factory state. After that, the device needs to be commissioned again. Previous setups done in the Smartphone APP won't work again; therefore, the virtual device shall be removed from the APP.
53+
Holding the BOOT button pressed for more than 10 seconds and then releasing it will erase all Matter and Wi-Fi configuration, forcing it to reset to factory state. After that, the device needs to be commissioned again.
54+
Previous setups done in the Smartphone APP won't work again; therefore, the virtual device shall be removed from the APP.
5355

5456
## Building the Application using Wi-Fi and Matter
5557

5658
Use ESP-IDF 5.1.4 from https://github.com/espressif/esp-idf/tree/release/v5.1
5759
This example has been tested with Arduino Core 3.0.4
5860

5961
The project will download all necessary components, including the Arduino Core.
60-
Run `idf.py SDKCONFIG_DEFAULTS="sdkconfig.defaults.<SOC>.idf" -p <PORT> flash monitor`
62+
Run `idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults.<SOC>.idf" -p <PORT> flash monitor`
6163

6264
Example for ESP32-S3/Linux | macOS:
63-
`idf.py SDKCONFIG_DEFAULTS="sdkconfig.defaults.esp32s3" -p /dev/ttyACM0 flash monitor`
65+
```
66+
idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults.esp32s3" -p /dev/ttyACM0 flash monitor
67+
```
6468
Example for ESP32-C3/Windows:
65-
`idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults.esp32c3" -p com3 flash monitor`
69+
```
70+
idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults.esp32c3" -p com3 flash monitor
71+
```
6672

6773
It may be necessary to delete some folders and files before running `idf.py`
68-
Linux/macOS: `rm -rf build managed_components sdkconfig dependencies.lock`
69-
Windows: `rmdir /s/q build managed_components` and `del sdkconfig dependencies.lock`
74+
- Linux/macOS:
75+
```
76+
rm -rf build managed_components sdkconfig dependencies.lock
77+
```
78+
- Windows:
79+
```
80+
rmdir /s/q build managed_components && del sdkconfig dependencies.lock
81+
```
7082

7183
There is a configuration file for these SoC: esp32s3, esp32c3, esp32c6.
7284
Those are the tested devices that have a WS2812 RGB LED and can run BLE, Wi-Fi and Matter.
7385

7486
In case it is necessary to change the Button Pin or the REG LED Pin, please use the `menuconfig`
7587
`idf.py menuconfig` and change the Menu Option `Light Matter Accessory`
7688

77-
## Using OpenThread with Matter
89+
## Building the Application using OpenThread and Matter
7890

79-
This is possible with the ESP32-C6.
80-
It is neessasy to have a Thread Border Routed in the Matter Environment. Check you matter hardware provider.
91+
This is possible with the ESP32-C6.
92+
It is necessary to have a Thread Border Router in the Matter Environment.
93+
Check your Matter hardware provider.
8194
In order to build the application that will use Thread Networking instead of Wi-Fi, please execute:
8295

83-
Example for ESP32-S3/Linux | macOS:
84-
`idf.py SDKCONFIG_DEFAULTS="sdkconfig.defaults.c6_thread" -p /dev/ttyACM0 flash monitor`
85-
Example for ESP32-C3/Windows:
86-
`idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults.c6_thread" -p com3 flash monitor`
96+
Example for ESP32-C6/Linux | macOS:
97+
```
98+
idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults.c6_thread" -p /dev/ttyACM0 flash monitor
99+
```
100+
Example for ESP32-C6/Windows:
101+
```
102+
idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults.c6_thread" -p com3 flash monitor
103+
```
87104

88105
It may be necessary to delete some folders and files before running `idf.py`
89-
Linux/macOS: `rm -rf build managed_components sdkconfig dependencies.lock`
90-
Windows: `rmdir /s/q build managed_components` and `del sdkconfig dependencies.lock`
106+
- Linux/macOS
107+
```
108+
rm -rf build managed_components sdkconfig dependencies.lock
109+
```
110+
- Windows
111+
```
112+
rmdir /s/q build managed_components && del sdkconfig dependencies.lock
113+
```

0 commit comments

Comments
 (0)