-
Notifications
You must be signed in to change notification settings - Fork 7.7k
feat(zigbee): Add Fan Control endpoint support #11559
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
P-R-O-C-H-Y
wants to merge
3
commits into
master
Choose a base branch
from
feat/zigbee-fan-control
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+393
−12
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| # Arduino-ESP32 Zigbee Fan Control Example | ||
|
|
||
| This example demonstrates how to use the Zigbee library to create a router device fan control and use it as a Home Automation (HA) fan control device. | ||
|
|
||
| # Supported Targets | ||
|
|
||
| Currently, this example supports the following targets. | ||
|
|
||
| | Supported Targets | ESP32-C6 | ESP32-H2 | | ||
| | ----------------- | -------- | -------- | | ||
|
|
||
| ## Fan Control Functions | ||
|
|
||
| 1. Initialize a Zigbee fan control device. | ||
| 2. Control fan modes (OFF, LOW, MEDIUM, HIGH, ON). | ||
| 3. Respond to fan control commands from the Zigbee network. | ||
|
|
||
| ## Hardware Required | ||
|
|
||
| * ESP32-H2 or ESP32-C6 development board | ||
| * A USB cable for power supply and programming | ||
| * RGB LED for visual feedback (built-in on most development boards) | ||
|
|
||
| ### Configure the Project | ||
|
|
||
| In this example the RGB LED is used to indicate the current fan control mode. | ||
| The LED colors represent different fan modes: | ||
| - OFF: No light | ||
| - LOW: Blue | ||
| - MEDIUM: Yellow | ||
| - HIGH: Red | ||
| - ON: White | ||
|
|
||
| Set the button GPIO by changing the `button` variable. By default, it's the pin `BOOT_PIN` (BOOT button on ESP32-C6 and ESP32-H2). | ||
|
|
||
| #### Using Arduino IDE | ||
|
|
||
| To get more information about the Espressif boards see [Espressif Development Kits](https://www.espressif.com/en/products/devkits). | ||
|
|
||
| * Before Compile/Verify, select the correct board: `Tools -> Board`. | ||
| * Select the End device Zigbee mode: `Tools -> Zigbee mode: Zigbee ZCZR (coordinator/router)` | ||
| * Select Partition Scheme for Zigbee: `Tools -> Partition Scheme: Zigbee ZCZR 4MB with spiffs` | ||
| * Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port. | ||
| * Optional: Set debug level to verbose to see all logs from Zigbee stack: `Tools -> Core Debug Level: Verbose`. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| If the End device flashed with this example is not connecting to the coordinator, erase the flash of the End device before flashing the example to the board. It is recommended to do this if you re-flash the coordinator. | ||
| You can do the following: | ||
|
|
||
| * In the Arduino IDE go to the Tools menu and set `Erase All Flash Before Sketch Upload` to `Enabled`. | ||
| * Add to the sketch `Zigbee.factoryReset();` to reset the device and Zigbee stack. | ||
|
|
||
| By default, the coordinator network is closed after rebooting or flashing new firmware. | ||
| To open the network you have 2 options: | ||
|
|
||
| * Open network after reboot by setting `Zigbee.setRebootOpenNetwork(time);` before calling `Zigbee.begin();`. | ||
| * In application you can anytime call `Zigbee.openNetwork(time);` to open the network for devices to join. | ||
|
|
||
|
|
||
| ***Important: Make sure you are using a good quality USB cable and that you have a reliable power source*** | ||
|
|
||
| * **LED not blinking:** Check the wiring connection and the IO selection. | ||
| * **Programming Fail:** If the programming/flash procedure fails, try reducing the serial connection speed. | ||
| * **COM port not detected:** Check the USB cable and the USB to Serial driver installation. | ||
|
|
||
| If the error persists, you can ask for help at the official [ESP32 forum](https://esp32.com) or see [Contribute](#contribute). | ||
|
|
||
| ## Contribute | ||
|
|
||
| To know how to contribute to this project, see [How to contribute.](https://github.com/espressif/arduino-esp32/blob/master/CONTRIBUTING.rst) | ||
|
|
||
| If you have any **feedback** or **issue** to report on this example/library, please open an issue or fix it by creating a new PR. Contributions are more than welcome! | ||
|
|
||
| Before creating a new issue, be sure to try Troubleshooting and check if the same issue was already created by someone else. | ||
|
|
||
| ## Resources | ||
|
|
||
| * Official ESP32 Forum: [Link](https://esp32.com) | ||
| * Arduino-ESP32 Official Repository: [espressif/arduino-esp32](https://github.com/espressif/arduino-esp32) | ||
| * ESP32-C6 Datasheet: [Link to datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf) | ||
| * ESP32-H2 Datasheet: [Link to datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-h2_datasheet_en.pdf) | ||
| * Official ESP-IDF documentation: [ESP-IDF](https://idf.espressif.com) |
129 changes: 129 additions & 0 deletions
129
libraries/Zigbee/examples/Zigbee_Fan_Control/Zigbee_Fan_Control.ino
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| // Copyright 2025 Espressif Systems (Shanghai) PTE LTD | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
|
|
||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| /** | ||
| * @brief This example demonstrates simple Zigbee fan control. | ||
| * | ||
| * The example demonstrates how to use Zigbee library to create a router device fan control. | ||
| * The fan control is a Zigbee router device, which is controlled by a Zigbee coordinator. | ||
| * | ||
| * Proper Zigbee mode must be selected in Tools->Zigbee mode | ||
| * and also the correct partition scheme must be selected in Tools->Partition Scheme. | ||
| * | ||
| * Please check the README.md for instructions and more detailed description. | ||
| * | ||
| * Created by Jan Procházka (https://github.com/P-R-O-C-H-Y/) | ||
| */ | ||
|
|
||
| #ifndef ZIGBEE_MODE_ZCZR | ||
| #error "Zigbee coordinator mode is not selected in Tools->Zigbee mode" | ||
| #endif | ||
|
|
||
| #include "Zigbee.h" | ||
|
|
||
| /* Zigbee light bulb configuration */ | ||
| #define ZIGBEE_FAN_CONTROL_ENDPOINT 1 | ||
|
|
||
| #ifdef RGB_BUILTIN | ||
| uint8_t led = RGB_BUILTIN; // To demonstrate the current fan control mode | ||
| #else | ||
| uint8_t led = 2; | ||
| #endif | ||
|
|
||
| uint8_t button = BOOT_PIN; | ||
|
|
||
| ZigbeeFanControl zbFanControl = ZigbeeFanControl(ZIGBEE_FAN_CONTROL_ENDPOINT); | ||
|
|
||
| /********************* fan control callback function **************************/ | ||
| void setFan(ZigbeeFanMode mode) { | ||
| switch (mode) { | ||
| case FAN_MODE_OFF: | ||
| rgbLedWrite(led, 0, 0, 0); // Off | ||
| Serial.println("Fan mode: OFF"); | ||
| break; | ||
| case FAN_MODE_LOW: | ||
| rgbLedWrite(led, 0, 0, 255); // Blue | ||
| Serial.println("Fan mode: LOW"); | ||
| break; | ||
| case FAN_MODE_MEDIUM: | ||
| rgbLedWrite(led, 255, 255, 0); // Yellow | ||
| Serial.println("Fan mode: MEDIUM"); | ||
| break; | ||
| case FAN_MODE_HIGH: | ||
| rgbLedWrite(led, 255, 0, 0); // Red | ||
| Serial.println("Fan mode: HIGH"); | ||
| break; | ||
| case FAN_MODE_ON: | ||
| rgbLedWrite(led, 255, 255, 255); // White | ||
| Serial.println("Fan mode: ON"); | ||
| break; | ||
P-R-O-C-H-Y marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| default: log_e("Unhandled fan mode: %d", mode); break; | ||
| } | ||
| } | ||
|
|
||
| /********************* Arduino functions **************************/ | ||
| void setup() { | ||
| Serial.begin(115200); | ||
|
|
||
| // Init LED that will be used to indicate the current fan control mode | ||
| rgbLedWrite(led, 0, 0, 0); | ||
|
|
||
| // Init button for factory reset | ||
| pinMode(button, INPUT_PULLUP); | ||
|
|
||
| //Optional: set Zigbee device name and model | ||
| zbFanControl.setManufacturerAndModel("Espressif", "ZBFanControl"); | ||
|
|
||
| // Set the fan mode sequence to LOW_MED_HIGH | ||
| zbFanControl.setFanModeSequence(FAN_MODE_SEQUENCE_LOW_MED_HIGH); | ||
|
|
||
| // Set callback function for fan mode change | ||
| zbFanControl.onFanModeChange(setFan); | ||
|
|
||
| //Add endpoint to Zigbee Core | ||
| Serial.println("Adding ZigbeeFanControl endpoint to Zigbee Core"); | ||
| Zigbee.addEndpoint(&zbFanControl); | ||
|
|
||
| // When all EPs are registered, start Zigbee in ROUTER mode | ||
| if (!Zigbee.begin(ZIGBEE_ROUTER)) { | ||
| Serial.println("Zigbee failed to start!"); | ||
| Serial.println("Rebooting..."); | ||
| ESP.restart(); | ||
| } | ||
| Serial.println("Connecting to network"); | ||
| while (!Zigbee.connected()) { | ||
| Serial.print("."); | ||
| delay(100); | ||
| } | ||
| Serial.println(); | ||
| } | ||
|
|
||
| void loop() { | ||
| // Checking button for factory reset | ||
| if (digitalRead(button) == LOW) { // Push button pressed | ||
| // Key debounce handling | ||
| delay(100); | ||
| int startTime = millis(); | ||
| while (digitalRead(button) == LOW) { | ||
| delay(50); | ||
| if ((millis() - startTime) > 3000) { | ||
| // If key pressed for more than 3secs, factory reset Zigbee and reboot | ||
| Serial.println("Resetting Zigbee to factory and rebooting in 1s."); | ||
| delay(1000); | ||
| Zigbee.factoryReset(); | ||
| } | ||
| } | ||
| } | ||
| delay(100); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "fqbn_append": "PartitionScheme=zigbee_zczr,ZigbeeMode=zczr", | ||
| "requires": [ | ||
| "CONFIG_ZB_ENABLED=y" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.