Skip to content

Commit 68e85af

Browse files
authored
feat(matter): extended formating
used the same formatting for the whole document and changed a few expresssions.
1 parent 6730b10 commit 68e85af

File tree

1 file changed

+21
-9
lines changed
  • idf_component_examples/esp_matter_light

1 file changed

+21
-9
lines changed

idf_component_examples/esp_matter_light/README.md

+21-9
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This example sets automatically the RGB LED GPIO and BOOT Button GPIO based on t
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,10 +23,10 @@ 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-
Each Devkit Board has a built-in LED that will be used as the Matter Light.
29+
Each Devkit Board has a built-in LED that will be used as the Matter Light.
3030
The default setting for ESP32-S3 is pin 48, for ESP32-C3 and ESP32-C6, it is pin 8.
3131
The BOOT Button pin of ESP32-S3 is GPIO 0, by toher hand, the ESP32-C3 and ESP32-C6 use GPIO 9.
3232
Please change it in using the MenuConfig executing `idf.py menuconfig` and selecting `Menu->Light Matter Accessory` options.
@@ -50,7 +50,8 @@ The built-in BOOT button will toggle On/Off and replicate the new state to the M
5050

5151
## Returning to the Factory State
5252

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. 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.
5455

5556
## Building the Application using Wi-Fi and Matter
5657

@@ -61,13 +62,23 @@ The project will download all necessary components, including the Arduino Core.
6162
Run `idf.py SDKCONFIG_DEFAULTS="sdkconfig.defaults.<SOC>.idf" -p <PORT> flash monitor`
6263

6364
Example for ESP32-S3/Linux | macOS:
64-
`idf.py SDKCONFIG_DEFAULTS="sdkconfig.defaults.esp32s3" -p /dev/ttyACM0 flash monitor`
65+
```
66+
idf.py SDKCONFIG_DEFAULTS="sdkconfig.defaults.esp32s3" -p /dev/ttyACM0 flash monitor
67+
```
6568
Example for ESP32-C3/Windows:
66-
`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+
```
6772

6873
It may be necessary to delete some folders and files before running `idf.py`
69-
Linux/macOS: `rm -rf build managed_components sdkconfig dependencies.lock`
70-
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+
```
7182

7283
There is a configuration file for these SoC: esp32s3, esp32c3, esp32c6.
7384
Those are the tested devices that have a WS2812 RGB LED and can run BLE, Wi-Fi and Matter.
@@ -78,7 +89,8 @@ In case it is necessary to change the Button Pin or the REG LED Pin, please use
7889
## Building the Application using OpenThread and Matter
7990

8091
This is possible with the ESP32-C6.
81-
It is necessary to have a Thread Border Router in the Matter Environment. Check your Matter hardware provider.
92+
It is necessary to have a Thread Border Router in the Matter Environment.
93+
Check your Matter hardware provider.
8294
In order to build the application that will use Thread Networking instead of Wi-Fi, please execute:
8395

8496
Example for ESP32-C6/Linux | macOS:

0 commit comments

Comments
 (0)