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
Updated README.md for MatterWindowCovering example to clarify ESP32-C6 and ESP32-C5 Thread support and improved descriptions for lift and tilt controls.
Copy file name to clipboardExpand all lines: libraries/Matter/examples/MatterWindowCovering/README.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,20 +17,20 @@ This example demonstrates how to create a Matter-compatible window covering devi
17
17
### Note on Commissioning:
18
18
19
19
-**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.
22
22
23
23
## Features
24
24
25
25
- Matter protocol implementation for a window covering device
26
26
- 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
29
29
- Multiple window covering types support
30
30
- State persistence using `Preferences` library
31
31
- Button control for manual lift adjustment and factory reset
32
32
- 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)
34
34
- Matter commissioning via QR code or manual pairing code
35
35
- Integration with Apple HomeKit, Amazon Alexa, and Google Home
36
36
(*) It is necessary to compile the project using Arduino as IDF Component.
@@ -146,7 +146,7 @@ For production use with a motorized window covering:
146
146
147
147
2.**Position Feedback**:
148
148
- 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
150
150
- For tilt: Update `currentTiltPercent` (rotation percentage) based on actual motor rotation
151
151
- Call `setLiftPercentage()` and `setTiltPercentage()` to update `CurrentPosition` attributes (these methods update the device's actual position, not the target)
152
152
- 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:
200
200
3.**Callbacks**:
201
201
-`fullOpen()`: Handles open command - moves window covering to fully open (100% lift), updates `CurrentPosition`, and sets operational state to `STALL`
202
202
-`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
204
204
-`goToTiltPercentage()`: Handles tilt rotation percentage changes (0-100%), updates `CurrentPosition`, and sets operational state to `STALL` when movement is complete
205
205
-`stopMotor()`: Handles stop command - stops any ongoing movement, updates `CurrentPosition` for both lift and tilt, and sets operational state to `STALL` for both
206
206
-`visualizeWindowBlinds()`: Updates RGB LED to reflect current lift and tilt positions
@@ -225,3 +225,4 @@ The MatterWindowCovering example consists of the following main components:
225
225
## License
226
226
227
227
This example is licensed under the Apache License, Version 2.0.
0 commit comments