feat(zigbee): Add Fan Control endpoint support #11559

P-R-O-C-H-Y · 2025-07-07T08:28:31Z

Description of Change

This pull request introduces a new Zigbee Fan control endpoint + minor updates to keywords.txt.

Tests scenarios

Tested using HomeAssistant ZHA and ESP32C6 flashed with the new example.

Related links

github-actions · 2025-07-07T08:29:57Z

	Messages
📖	🎉 Good Job! All checks are passing!

👋 Hello P-R-O-C-H-Y, 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.
- 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 f76554f

github-actions · 2025-07-07T08:46:16Z

Test Results

76 files 76 suites 16m 23s ⏱️
38 tests 38 ✅ 0 💤 0 ❌
241 runs 241 ✅ 0 💤 0 ❌

Results for commit f76554f.

♻️ This comment has been updated with latest results.

Copilot

Pull Request Overview

This PR adds support for a Zigbee fan control endpoint, registers its keywords, and provides an example sketch.

Introduce ZigbeeFanControl class (header and implementation) to manage fan modes and sequences.
Update core Zigbee registry (Zigbee.h, CMakeLists.txt, keywords.txt) to include the new endpoint.
Provide a complete example (CI config, sketch, and README) demonstrating fan control usage.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
libraries/Zigbee/src/ep/ZigbeeFanControl.h	Define fan control endpoint interface
libraries/Zigbee/src/ep/ZigbeeFanControl.cpp	Implement fan control logic and callbacks
libraries/Zigbee/src/Zigbee.h	Include new fan control endpoint
libraries/Zigbee/keywords.txt	Register `ZigbeeFanControl` and related enums
CMakeLists.txt	Add `ZigbeeFanControl.cpp` to build list
libraries/Zigbee/examples/Zigbee_Fan_Control/ci.json	CI config for fan control example
libraries/Zigbee/examples/Zigbee_Fan_Control/Zigbee_Fan_Control.ino	Example sketch for fan control
libraries/Zigbee/examples/Zigbee_Fan_Control/README.md	Documentation for the fan control example

Comments suppressed due to low confidence (2)

libraries/Zigbee/src/ep/ZigbeeFanControl.h:1

The class comment references a Pressure sensor but this file implements Fan Control. Please update the comment to describe the Fan Control endpoint.

/* Class of Zigbee Pressure sensor endpoint inherited from common EP class */

libraries/Zigbee/examples/Zigbee_Fan_Control/README.md:32

The fan mode list in the README omits AUTO and SMART. Please document the colors or behavior for those modes.

- ON: White

Copilot · 2025-07-07T08:57:46Z

libraries/Zigbee/src/ep/ZigbeeFanControl.cpp

+#if CONFIG_ZB_ENABLED
+
+ZigbeeFanControl::ZigbeeFanControl(uint8_t endpoint) : ZigbeeEP(endpoint) {
+  _device_id = ESP_ZB_HA_SIMPLE_SENSOR_DEVICE_ID;


The device ID is set to SIMPLE_SENSOR but this is a fan control device. Use the appropriate constant (e.g., ESP_ZB_HA_FAN_CONTROL_DEVICE_ID).

Suggested change

_device_id = ESP_ZB_HA_SIMPLE_SENSOR_DEVICE_ID;

_device_id = ESP_ZB_HA_FAN_CONTROL_DEVICE_ID;

libraries/Zigbee/src/ep/ZigbeeFanControl.cpp

libraries/Zigbee/examples/Zigbee_Fan_Control/Zigbee_Fan_Control.ino

github-actions · 2025-07-07T09:10:26Z

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
ESP32S3	0	0	0.00	0.00	0	0	0.00	0.00
ESP32S2	0	0	0.00	0.00	0	0	0.00	0.00
ESP32C3	0	0	0.00	0.00	0	0	0.00	0.00
ESP32C6	0	0	0.00	0.00	0	0	0.00	0.00
ESP32H2	0	0	0.00	0.00	0	0	0.00	0.00
ESP32	0	0	0.00	0.00	0	0	0.00	0.00

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

Target	ESP32S3		ESP32S2		ESP32C3		ESP32C6		ESP32H2		ESP32
Example	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM
libraries/Zigbee/examples/Zigbee_Analog_Input_Output	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Color_Dimmer_Switch	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Electrical_AC_Sensor	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Electrical_AC_Sensor_MultiPhase	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Fan_Control	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Gateway	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_On_Off_Switch	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Range_Extender	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Thermostat	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Binary_Input	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_CarbonDioxide_Sensor	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Color_Dimmable_Light	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Contact_Switch	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Dimmable_Light	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Electrical_DC_Sensor	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Illuminance_Sensor	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_OTA_Client	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Occupancy_Sensor	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_On_Off_Light	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_On_Off_MultiSwitch	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_PM25_Sensor	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Power_Outlet	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Pressure_Flow_Sensor	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Scan_Networks	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Temperature_Sensor	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Vibration_Sensor	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Wind_Speed_Sensor	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Window_Covering	-	-	-	-	-	-	-	-	-	-	-	-

lucasssvaz · 2025-07-07T13:41:28Z

libraries/Zigbee/examples/Zigbee_Fan_Control/Zigbee_Fan_Control.ino

+
+#include "Zigbee.h"
+
+/* Zigbee light bulb configuration */


Suggested change

/* Zigbee light bulb configuration */

/* Zigbee fan configuration */

P-R-O-C-H-Y requested review from lucasssvaz, SuGlider and me-no-dev as code owners July 7, 2025 08:28

P-R-O-C-H-Y self-assigned this Jul 7, 2025

P-R-O-C-H-Y added the Area: Zigbee Issues and Feature Request about Zigbee label Jul 7, 2025

feat(zigbee): Add Fan Control endpoint support

46e9353

P-R-O-C-H-Y force-pushed the feat/zigbee-fan-control branch from baaff35 to 46e9353 Compare July 7, 2025 08:50

me-no-dev approved these changes Jul 7, 2025

View reviewed changes

me-no-dev requested a review from Copilot July 7, 2025 08:55

Copilot AI reviewed Jul 7, 2025

View reviewed changes

fix(zigbee): Update logs and change device_id

305299d

P-R-O-C-H-Y added the Status: Review needed Issue or PR is awaiting review label Jul 7, 2025

lucasssvaz reviewed Jul 7, 2025

View reviewed changes

lucasssvaz approved these changes Jul 7, 2025

View reviewed changes

me-no-dev added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Jul 7, 2025

ci(pre-commit): Apply automatic fixes

f76554f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(zigbee): Add Fan Control endpoint support #11559

feat(zigbee): Add Fan Control endpoint support #11559

P-R-O-C-H-Y commented Jul 7, 2025

Uh oh!

github-actions bot commented Jul 7, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 7, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 7, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jul 7, 2025

Uh oh!

lucasssvaz Jul 7, 2025

Uh oh!

Uh oh!

	_device_id = ESP_ZB_HA_SIMPLE_SENSOR_DEVICE_ID;
	_device_id = ESP_ZB_HA_FAN_CONTROL_DEVICE_ID;

	/* Zigbee light bulb configuration */
	/* Zigbee fan configuration */

feat(zigbee): Add Fan Control endpoint support #11559

Are you sure you want to change the base?

feat(zigbee): Add Fan Control endpoint support #11559

Conversation

P-R-O-C-H-Y commented Jul 7, 2025

Description of Change

Tests scenarios

Related links

Uh oh!

github-actions bot commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jul 7, 2025

Memory usage test (comparing PR against master branch)

Uh oh!

lucasssvaz Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Jul 7, 2025 •

edited

Loading

github-actions bot commented Jul 7, 2025 •

edited

Loading