Created Zigbee Endpoint for Window Covering. #10914

hennikul · 2025-01-28T17:56:57Z

Description of Change

This PR implements a Zigbee Endpoint for Window Covering. It was implemented during the weekend for a hobby project where I try to create a Zigbee controller for my garage door, which can then be controlled from Home Assistant.

UPDATE by @P-R-O-C-H-Y:

Added full support of Window Covering device (lift + tilt)
Fixed unsupported reporting of attributes, added a setter instead. HA is automatically getting the values.
Minor adjustments

Tests scenarios

The code has been tested on a ESP32-C6 Dev module running code to control a garage door. It has been added as a
device in Home Assistant, and all relevant controllers have been tested with expected result, both on the device and feedback in Home Assistant (current lift position).

The garage door does not support tilt, so this is not fully implemented, and not tested at all. Only lift is working.

UPDATE by @P-R-O-C-H-Y:
Tested with the updated example demonstrating a Window Blinders (lift+tilt) with ESP32-C6 connected to HomeAssistant.

Related links

Closes #10913

CLAassistant · 2025-01-28T17:57:07Z

All committers have signed the CLA.

github-actions · 2025-01-28T17:57:36Z

	Warnings
⚠️	Some issues found for the commit messages in this PR: the commit message `"Added example Sketch."`: summary should not end with a period (full stop) summary looks empty type/action looks empty the commit message `"Added window covering to CMakeLists.txt."`: summary should not end with a period (full stop) summary looks empty type/action looks empty the commit message `"fix(zigbee): Fix typos"`: summary looks too short Please fix these commit messages - here are some basic tips: follow Conventional Commits style correct format of commit message should be: `<type/action>(<scope/component>): <summary>`, for example `fix(esp32): Fixed startup timeout issue` allowed types are: `change,ci,docs,feat,fix,refactor,remove,revert,test` sufficiently descriptive message summary should be between 10 to 72 characters and start with upper case letter avoid Jira references in commit messages (unavailable/irrelevant for our customers) `TIP:` Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello hennikul, we appreciate your contribution to this project!

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...

This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...

We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 78eb461

P-R-O-C-H-Y · 2025-01-30T14:22:10Z

Hi @hennikul, can you please sign the CLA and also if you have an example, it will be great if you can share it. Thanks

hennikul · 2025-01-30T19:33:49Z

I have added a small example that shows up as a cover in Home Assistant and prints out the position I choose in Home assistant to the serial console.

github-actions · 2025-01-31T10:34:14Z

Test Results

62 files 62 suites 5m 40s ⏱️
21 tests 21 ✅ 0 💤 0 ❌
153 runs 153 ✅ 0 💤 0 ❌

Results for commit 78eb461.

♻️ This comment has been updated with latest results.

me-no-dev · 2025-01-31T12:56:53Z

@hennikul to pass CI, you need to add ZigbeeWindowCovering.cpp to this list

P-R-O-C-H-Y · 2025-01-31T13:19:54Z

@hennikul Are you ok If I take over the PR and do some adjustments and fixes?

hennikul · 2025-02-01T07:59:27Z

Please do! :)

github-actions · 2025-02-04T09:12:42Z

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

Memory	FLASH [bytes]		FLASH [%]		RAM [bytes]		RAM [%]
Target	DEC	INC	DEC	INC	DEC	INC	DEC	INC
ESP32C6	0	⚠️ +90	0.00	⚠️ +0.02	0	0	0.00	0.00
ESP32H2	0	⚠️ +90	0.00	⚠️ +0.02	0	0	0.00	0.00

Click to expand the detailed deltas report [usage change in BYTES]

Target	ESP32C6		ESP32H2
Example	FLASH	RAM	FLASH	RAM
Zigbee/examples/Zigbee_CarbonDioxide_Sensor	⚠️ +88	0	⚠️ +88	0
Zigbee/examples/Zigbee_Color_Dimmable_Light	⚠️ +88	0	⚠️ +88	0
Zigbee/examples/Zigbee_Color_Dimmer_Switch	⚠️ +90	0	⚠️ +90	0
Zigbee/examples/Zigbee_Contact_Switch	⚠️ +88	0	⚠️ +88	0
Zigbee/examples/Zigbee_Dimmable_Light	⚠️ +88	0	⚠️ +88	0
Zigbee/examples/Zigbee_Occupancy_Sensor	⚠️ +88	0	⚠️ +88	0
Zigbee/examples/Zigbee_On_Off_Light	⚠️ +88	0	⚠️ +88	0
Zigbee/examples/Zigbee_On_Off_Switch	⚠️ +90	0	⚠️ +90	0
Zigbee/examples/Zigbee_Pressure_Flow_Sensor	⚠️ +88	0	⚠️ +88	0
Zigbee/examples/Zigbee_Scan_Networks	⚠️ +58	0	⚠️ +58	0
Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy	⚠️ +88	0	⚠️ +88	0
Zigbee/examples/Zigbee_Temperature_Sensor	⚠️ +88	0	⚠️ +88	0
Zigbee/examples/Zigbee_Thermostat	⚠️ +88	0	⚠️ +88	0
Zigbee/examples/Zigbee_Window_Covering	-	-	-	-

P-R-O-C-H-Y · 2025-02-04T14:14:09Z

@hennikul Please take a look and adjust your application code, as there were few changes that may brake your code.
The Open/Close commands now have their own callbacks - onOpen, onClose. As the commands may be set to be inverted, it was not done correctly to use the percentage there :)

hennikul mentioned this pull request Jan 28, 2025

Zigbee Window Covering support #10913

Closed

1 task

P-R-O-C-H-Y added Area: Zigbee Issues and Feature Request about Zigbee Status: Review needed Issue or PR is awaiting review labels Jan 28, 2025

P-R-O-C-H-Y self-requested a review January 28, 2025 18:08

feat(zigbee): Added Endpoint for Window Covering (espressif#10913)

1d2c6c1

hennikul force-pushed the window_covering branch from 721e874 to 1d2c6c1 Compare January 28, 2025 18:12

P-R-O-C-H-Y added the Status: Pending CLA ⚠️ Contributor is required to sign the CLA label Jan 30, 2025

Added example Sketch.

5f8c8e2

P-R-O-C-H-Y removed the Status: Pending CLA ⚠️ Contributor is required to sign the CLA label Jan 31, 2025

Merge branch 'master' into window_covering

9fa8b54

Added window covering to CMakeLists.txt.

cfb7ca4

P-R-O-C-H-Y added Status: In Progress Issue is in progress and removed Status: Review needed Issue or PR is awaiting review labels Feb 4, 2025

P-R-O-C-H-Y added 2 commits February 4, 2025 12:32

Merge branch 'master' into window_covering

e5aeb58

feat(zigbee): Window covering tilt support and fixes

de2cd4a

P-R-O-C-H-Y added Status: Review needed Issue or PR is awaiting review and removed Status: In Progress Issue is in progress labels Feb 4, 2025

fix(zigbee): Fix typos

38f5a8e

P-R-O-C-H-Y requested review from me-no-dev, lucasssvaz and SuGlider February 4, 2025 14:07

P-R-O-C-H-Y approved these changes Feb 4, 2025

View reviewed changes

me-no-dev approved these changes Feb 4, 2025

View reviewed changes

me-no-dev added the Status: Pending Merge Pull Request is ready to be merged label Feb 4, 2025

ci(pre-commit): Apply automatic fixes

a73abd7

fix(ci): Fixes of typos

78eb461

me-no-dev merged commit db0bbad into espressif:master Feb 4, 2025
55 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Created Zigbee Endpoint for Window Covering. #10914

Created Zigbee Endpoint for Window Covering. #10914

hennikul commented Jan 28, 2025 •

edited by P-R-O-C-H-Y

Loading

CLAassistant commented Jan 28, 2025 •

edited

Loading

github-actions bot commented Jan 28, 2025 •

edited

Loading

P-R-O-C-H-Y commented Jan 30, 2025

hennikul commented Jan 30, 2025

github-actions bot commented Jan 31, 2025 •

edited

Loading

me-no-dev commented Jan 31, 2025

P-R-O-C-H-Y commented Jan 31, 2025

hennikul commented Feb 1, 2025

github-actions bot commented Feb 4, 2025 •

edited

Loading

P-R-O-C-H-Y commented Feb 4, 2025

Created Zigbee Endpoint for Window Covering. #10914

Created Zigbee Endpoint for Window Covering. #10914

Conversation

hennikul commented Jan 28, 2025 • edited by P-R-O-C-H-Y Loading

Description of Change

Tests scenarios

Related links

CLAassistant commented Jan 28, 2025 • edited Loading

github-actions bot commented Jan 28, 2025 • edited Loading

P-R-O-C-H-Y commented Jan 30, 2025

hennikul commented Jan 30, 2025

github-actions bot commented Jan 31, 2025 • edited Loading

Test Results

me-no-dev commented Jan 31, 2025

P-R-O-C-H-Y commented Jan 31, 2025

hennikul commented Feb 1, 2025

github-actions bot commented Feb 4, 2025 • edited Loading

Memory usage test (comparing PR against master branch)

P-R-O-C-H-Y commented Feb 4, 2025

hennikul commented Jan 28, 2025 •

edited by P-R-O-C-H-Y

Loading

CLAassistant commented Jan 28, 2025 •

edited

Loading

github-actions bot commented Jan 28, 2025 •

edited

Loading

github-actions bot commented Jan 31, 2025 •

edited

Loading

github-actions bot commented Feb 4, 2025 •

edited

Loading