Skip to content

Conversation

@P-R-O-C-H-Y
Copy link
Member

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

@P-R-O-C-H-YP-R-O-C-H-Y self-assigned this Jul 7, 2025
@P-R-O-C-H-YP-R-O-C-H-Y added the Area: Zigbee Issues and Feature Request about Zigbee label Jul 7, 2025
@github-actions
Copy link
Contributor

github-actionsbot commented Jul 7, 2025

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
Copy link
Contributor

github-actionsbot commented Jul 7, 2025

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.

@P-R-O-C-H-YP-R-O-C-H-Yforce-pushed the feat/zigbee-fan-control branch from baaff35 to 46e9353CompareJuly 7, 2025 08:50
@me-no-devme-no-dev requested a review from CopilotJuly 7, 2025 08:55
Copy link
Contributor

CopilotAI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
FileDescription
libraries/Zigbee/src/ep/ZigbeeFanControl.hDefine fan control endpoint interface
libraries/Zigbee/src/ep/ZigbeeFanControl.cppImplement fan control logic and callbacks
libraries/Zigbee/src/Zigbee.hInclude new fan control endpoint
libraries/Zigbee/keywords.txtRegister ZigbeeFanControl and related enums
CMakeLists.txtAdd ZigbeeFanControl.cpp to build list
libraries/Zigbee/examples/Zigbee_Fan_Control/ci.jsonCI config for fan control example
libraries/Zigbee/examples/Zigbee_Fan_Control/Zigbee_Fan_Control.inoExample sketch for fan control
libraries/Zigbee/examples/Zigbee_Fan_Control/README.mdDocumentation 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 

#if CONFIG_ZB_ENABLED

ZigbeeFanControl::ZigbeeFanControl(uint8_t endpoint) : ZigbeeEP(endpoint){
_device_id = ESP_ZB_HA_SIMPLE_SENSOR_DEVICE_ID;
Copy link

CopilotAIJul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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;

Copilot uses AI. Check for mistakes.
@github-actions
Copy link
Contributor

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.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32S3000.000.00000.000.00
ESP32S2000.000.00000.000.00
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32H2000.000.00000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
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------------

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

#include "Zigbee.h"

/* Zigbee light bulb configuration */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/* Zigbee light bulb configuration */
/* Zigbee fan configuration */

@me-no-devme-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
@me-no-devme-no-dev merged commit e2c7578 into masterJul 8, 2025
56 checks passed
@me-no-devme-no-dev deleted the feat/zigbee-fan-control branch November 6, 2025 22:15
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: ZigbeeIssues and Feature Request about ZigbeeStatus: Pending MergePull Request is ready to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@P-R-O-C-H-Y@me-no-dev@lucasssvaz