You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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]>
Copy file name to clipboardexpand all lines: idf_component_examples/esp_matter_light/README.md
+44-21
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,11 @@
4
4
5
5
# Managed Component Light
6
6
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.
8
8
9
9
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.
10
10
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.
12
12
13
13
The code is based on the Arduino API and uses Arduino as an IDF Component.
14
14
@@ -23,12 +23,13 @@ Possible Matter Environments are:
23
23
24
24
(*) 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.
25
25
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.
27
27
Please enter the code manually: `34970112332`
28
28
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.
32
33
33
34
## LED Status and Factory Mode
34
35
@@ -49,42 +50,64 @@ The built-in BOOT button will toggle On/Off and replicate the new state to the M
49
50
50
51
## Returning to the Factory State
51
52
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.
53
55
54
56
## Building the Application using Wi-Fi and Matter
55
57
56
58
Use ESP-IDF 5.1.4 from https://github.com/espressif/esp-idf/tree/release/v5.1
57
59
This example has been tested with Arduino Core 3.0.4
58
60
59
61
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`
0 commit comments