Skip to content

Commit db1472d

Browse files
authored
fix(matter_docs): CI Vale check
Updated README.md for MatterWindowCovering example to clarify ESP32-C6 and ESP32-C5 Thread support and improved descriptions for lift and tilt controls.
1 parent b6132b4 commit db1472d

File tree

1 file changed

+8
-7
lines changed
  • libraries/Matter/examples/MatterWindowCovering

1 file changed

+8
-7
lines changed

libraries/Matter/examples/MatterWindowCovering/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,20 @@ This example demonstrates how to create a Matter-compatible window covering devi
1717
### Note on Commissioning:
1818

1919
- **ESP32 & ESP32-S2** do not support commissioning over Bluetooth LE. For these chips, you must provide Wi-Fi credentials directly in the sketch code so they can connect to your network manually.
20-
- **ESP32-C6** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using Wi-Fi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter Wi-Fi station feature.
21-
- **ESP32-C5** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using Wi-Fi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter Wi-Fi station feature.
20+
- **ESP32-C6** Although it has Thread support, the ESP32 Arduino Matter Library has been precompiled using Wi-Fi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter Wi-Fi station feature.
21+
- **ESP32-C5** Although it has Thread support, the ESP32 Arduino Matter Library has been precompiled using Wi-Fi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter Wi-Fi station feature.
2222

2323
## Features
2424

2525
- Matter protocol implementation for a window covering device
2626
- Support for both Wi-Fi and Thread(*) connectivity
27-
- Lift position and percentage control Lift can be specified either as a physical position (in centimeters) or as a percentage (0–100%).
28-
- Tilt rotation and percentage control — Lift can be specified either as a physical position (in centimeters) or as a percentage (0–100%).
27+
- Lift position and percentage control (0-100%) - Lift represents the physical position (centimeters)
28+
- Tilt rotation and percentage control (0-100%) - Tilt represents rotation of the shade, not a linear measurement
2929
- Multiple window covering types support
3030
- State persistence using `Preferences` library
3131
- Button control for manual lift adjustment and factory reset
3232
- RGB LED visualization of lift (brightness) and tilt (color) positions
33-
- Installed limit configuration for lift (in cm) and tilt (absolute values)
33+
- Installed limit configuration for lift (cm) and tilt (absolute values)
3434
- Matter commissioning via QR code or manual pairing code
3535
- Integration with Apple HomeKit, Amazon Alexa, and Google Home
3636
(*) It is necessary to compile the project using Arduino as IDF Component.
@@ -146,7 +146,7 @@ For production use with a motorized window covering:
146146

147147
2. **Position Feedback**:
148148
- Use encoders or limit switches to provide position feedback
149-
- For lift: Update `currentLift` (in cm) based on actual motor position
149+
- For lift: Update `currentLift` (cm) based on actual motor position
150150
- For tilt: Update `currentTiltPercent` (rotation percentage) based on actual motor rotation
151151
- Call `setLiftPercentage()` and `setTiltPercentage()` to update `CurrentPosition` attributes (these methods update the device's actual position, not the target)
152152
- Call `setOperationalState(LIFT, STALL)` or `setOperationalState(TILT, STALL)` when movement is complete to indicate the device has reached the target position
@@ -200,7 +200,7 @@ The MatterWindowCovering example consists of the following main components:
200200
3. **Callbacks**:
201201
- `fullOpen()`: Handles open command - moves window covering to fully open (100% lift), updates `CurrentPosition`, and sets operational state to `STALL`
202202
- `fullClose()`: Handles close command - moves window covering to fully closed (0% lift), updates `CurrentPosition`, and sets operational state to `STALL`
203-
- `goToLiftPercentage()`: Handles lift percentage changes (0-100%), calculates absolute position in cm based on installed limits, updates `CurrentPosition`, and sets operational state to `STALL` when movement is complete
203+
- `goToLiftPercentage()`: Handles lift percentage changes (0-100%), calculates absolute position (cm) based on installed limits, updates `CurrentPosition`, and sets operational state to `STALL` when movement is complete
204204
- `goToTiltPercentage()`: Handles tilt rotation percentage changes (0-100%), updates `CurrentPosition`, and sets operational state to `STALL` when movement is complete
205205
- `stopMotor()`: Handles stop command - stops any ongoing movement, updates `CurrentPosition` for both lift and tilt, and sets operational state to `STALL` for both
206206
- `visualizeWindowBlinds()`: Updates RGB LED to reflect current lift and tilt positions
@@ -225,3 +225,4 @@ The MatterWindowCovering example consists of the following main components:
225225
## License
226226

227227
This example is licensed under the Apache License, Version 2.0.
228+

0 commit comments

Comments
 (0)