Skip to content

Commit 83b7060

Browse files
committed
feat(matter): Adds doc URL ref to examples README.md files
1 parent 731aee2 commit 83b7060

File tree

21 files changed

+116
-242
lines changed

21 files changed

+116
-242
lines changed

libraries/Matter/examples/MatterColorLight/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,12 @@ The MatterColorLight example consists of the following main components:
159159
- **Failed to commission**: Try factory resetting the device by long-pressing the button. Other option would be to erase the SoC Flash Memory by using `Arduino IDE Menu` -> `Tools` -> `Erase All Flash Before Sketch Upload: "Enabled"` or directly with `esptool.py --port <PORT> erase_flash`
160160
- **No serial output**: Check baudrate (115200) and USB connection
161161
162+
## Related Documentation
163+
164+
- [Matter Overview](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter.html)
165+
- [Matter Endpoint Base Class](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter_ep.html)
166+
- [Matter Color Light Endpoint](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/ep_color_light.html)
167+
162168
## License
163169
164170
This example is licensed under the Apache License, Version 2.0.

libraries/Matter/examples/MatterCommissionTest/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,10 @@ The MatterCommissionTest example consists of the following main components:
146146
- **No serial output**: Check baudrate (115200) and USB connection
147147
- **Device keeps decommissioning**: This is expected behavior - the device automatically decommissions after 30 seconds to allow continuous testing
148148

149+
## Related Documentation
150+
151+
- [Matter Overview](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter.html)
152+
149153
## License
150154

151155
This example is licensed under the Apache License, Version 2.0.

libraries/Matter/examples/MatterComposedLights/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,14 @@ The MatterComposedLights example consists of the following main components:
170170
- **Failed to commission**: Try factory resetting the device by long-pressing the button. Other option would be to erase the SoC Flash Memory by using `Arduino IDE Menu` -> `Tools` -> `Erase All Flash Before Sketch Upload: "Enabled"` or directly with `esptool.py --port <PORT> erase_flash`
171171
- **No serial output**: Check baudrate (115200) and USB connection
172172

173+
## Related Documentation
174+
175+
- [Matter Overview](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter.html)
176+
- [Matter Endpoint Base Class](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter_ep.html)
177+
- [Matter On/Off Light Endpoint](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/ep_on_off_light.html)
178+
- [Matter Dimmable Light Endpoint](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/ep_dimmable_light.html)
179+
- [Matter Color Light Endpoint](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/ep_color_light.html)
180+
173181
## License
174182

175183
This example is licensed under the Apache License, Version 2.0.

libraries/Matter/examples/MatterContactSensor/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,12 @@ The MatterContactSensor example consists of the following main components:
167167
- **Failed to commission**: Try factory resetting the device by long-pressing the button. Other option would be to erase the SoC Flash Memory by using `Arduino IDE Menu` -> `Tools` -> `Erase All Flash Before Sketch Upload: "Enabled"` or directly with `esptool.py --port <PORT> erase_flash`
168168
- **No serial output**: Check baudrate (115200) and USB connection
169169

170+
## Related Documentation
171+
172+
- [Matter Overview](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter.html)
173+
- [Matter Endpoint Base Class](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter_ep.html)
174+
- [Matter Contact Sensor Endpoint](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/ep_contact_sensor.html)
175+
170176
## License
171177

172178
This example is licensed under the Apache License, Version 2.0.

libraries/Matter/examples/MatterDimmableLight/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,12 @@ The MatterDimmableLight example consists of the following main components:
165165
- **Failed to commission**: Try factory resetting the device by long-pressing the button. Other option would be to erase the SoC Flash Memory by using `Arduino IDE Menu` -> `Tools` -> `Erase All Flash Before Sketch Upload: "Enabled"` or directly with `esptool.py --port <PORT> erase_flash`
166166
- **No serial output**: Check baudrate (115200) and USB connection
167167

168+
## Related Documentation
169+
170+
- [Matter Overview](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter.html)
171+
- [Matter Endpoint Base Class](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter_ep.html)
172+
- [Matter Dimmable Light Endpoint](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/ep_dimmable_light.html)
173+
168174
## License
169175

170176
This example is licensed under the Apache License, Version 2.0.

libraries/Matter/examples/MatterEnhancedColorLight/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,12 @@ The MatterEnhancedColorLight example consists of the following main components:
172172
- **Failed to commission**: Try factory resetting the device by long-pressing the button. Other option would be to erase the SoC Flash Memory by using `Arduino IDE Menu` -> `Tools` -> `Erase All Flash Before Sketch Upload: "Enabled"` or directly with `esptool.py --port <PORT> erase_flash`
173173
- **No serial output**: Check baudrate (115200) and USB connection
174174

175+
## Related Documentation
176+
177+
- [Matter Overview](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter.html)
178+
- [Matter Endpoint Base Class](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter_ep.html)
179+
- [Matter Enhanced Color Light Endpoint](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/ep_enhanced_color_light.html)
180+
175181
## License
176182

177183
This example is licensed under the Apache License, Version 2.0.

libraries/Matter/examples/MatterEvents/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,10 @@ The MatterEvents example consists of the following main components:
176176
- **No serial output**: Check baudrate (115200) and USB connection
177177
- **Device keeps decommissioning**: This is expected behavior - the device automatically decommissions after 60 seconds to allow continuous testing and event monitoring
178178

179+
## Related Documentation
180+
181+
- [Matter Overview](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter.html)
182+
179183
## License
180184

181185
This example is licensed under the Apache License, Version 2.0.

libraries/Matter/examples/MatterFan/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,12 @@ The MatterFan example consists of the following main components:
189189
- **Failed to commission**: Try factory resetting the device by long-pressing the button. Other option would be to erase the SoC Flash Memory by using `Arduino IDE Menu` -> `Tools` -> `Erase All Flash Before Sketch Upload: "Enabled"` or directly with `esptool.py --port <PORT> erase_flash`
190190
- **No serial output**: Check baudrate (115200) and USB connection
191191

192+
## Related Documentation
193+
194+
- [Matter Overview](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter.html)
195+
- [Matter Endpoint Base Class](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter_ep.html)
196+
- [Matter Fan Endpoint](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/ep_fan.html)
197+
192198
## License
193199

194200
This example is licensed under the Apache License, Version 2.0.

libraries/Matter/examples/MatterHumiditySensor/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,12 @@ The MatterHumiditySensor example consists of the following main components:
186186
- **Failed to commission**: Try factory resetting the device by long-pressing the button. Other option would be to erase the SoC Flash Memory by using `Arduino IDE Menu` -> `Tools` -> `Erase All Flash Before Sketch Upload: "Enabled"` or directly with `esptool.py --port <PORT> erase_flash`
187187
- **No serial output**: Check baudrate (115200) and USB connection
188188
189+
## Related Documentation
190+
191+
- [Matter Overview](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter.html)
192+
- [Matter Endpoint Base Class](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter_ep.html)
193+
- [Matter Humidity Sensor Endpoint](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/ep_humidity_sensor.html)
194+
189195
## License
190196
191197
This example is licensed under the Apache License, Version 2.0.

libraries/Matter/examples/MatterLambdaSingleCallbackManyEPs/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,11 @@ The MatterLambdaSingleCallbackManyEPs example consists of the following main com
200200
- **No serial output**: Check baudrate (115200) and USB connection
201201
- **Compilation errors with lambda functions**: Ensure you're using a C++11 compatible compiler (ESP32 Arduino Core 2.0+ supports this)
202202

203+
## Related Documentation
204+
205+
- [Matter Overview](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter.html)
206+
- [Matter Endpoint Base Class](https://docs.espressif.com/projects/arduino-esp32/en/latest/matter/matter_ep.html)
207+
203208
## License
204209

205210
This example is licensed under the Apache License, Version 2.0.

0 commit comments

Comments
 (0)