Added example Sketch.

Author: hennikul

libraries/Zigbee/examples/Zigbee_Window_Covering/README.md

@@ -0,0 +1,69 @@
+# Arduino-ESP32 Widnow Covering Example
+
+This example shows how to configure the Zigbee end device and use it as a Home Automation (HA) window covering or port.
+
+To see if the communication with your Zigbee network works, use the Serial monitor and watch for output there.
+
+# Supported Targets
+
+Currently, this example supports the following targets.
+
+| Supported Targets | ESP32-C6 | ESP32-H2 |
+| ----------------- | -------- | -------- |
+
+## Hardware Required
+
+* A USB cable for power supply and programming
+* Board (ESP32-H2 or ESP32-C6) as Zigbee end device and upload the Zigbee_Window_Covering example
+* Zigbee network / coordinator (Other board with switch examples or Zigbee2mqtt or ZigbeeHomeAssistant like application)
+
+### Configure the Project
+
+#### 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 ED (end device)`
+* Select Tools / USB CDC On Boot: "Enabled"
+* Select Partition Scheme for Zigbee: `Tools -> Partition Scheme: Zigbee 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)

libraries/Zigbee/examples/Zigbee_Window_Covering/Zigbee_Window_Covering.ino.ino

@@ -0,0 +1,113 @@
+#ifndef ZIGBEE_MODE_ED
+#error "Zigbee end device mode is not selected in Tools->Zigbee mode"
+#endif
+
+#include "ZigbeeCore.h"
+#include "ep/ZigbeeWindowCovering.h"
+
+
+#define ZIGBEE_COVERING_ENDPOINT 10
+#define BUTTON_PIN                9  // ESP32-C6/H2 Boot button
+
+#define MAX_LIFT 200 // centimeters from open position
+#define MIN_LIFT   0
+
+uint8_t currentLift = MAX_LIFT;
+uint8_t reportedLift = MIN_LIFT;
+
+ZigbeeWindowCovering zbCovering = ZigbeeWindowCovering(ZIGBEE_COVERING_ENDPOINT);
+
+void setup() {
+  Serial.begin(115200); 
+
+  Serial.println("ESP32S3 initialization completed!");
+
+  // Init button for factory reset
+  pinMode(BUTTON_PIN, INPUT_PULLUP);
+
+  //Optional: set Zigbee device name and model
+  zbCovering.setManufacturerAndModel("Espriff", "Arduino");
+  zbCovering.setCoveringType(ROLLERSHADE);
+
+  // operational, online, not commands_reversed, closed_loop, encoder_controlled
+  zbCovering.setConfigStatus(true, true, false, true, true, true, true);
+
+  // not motor_reversed, calibration_mode, not maintenance_mode, not leds_on
+  zbCovering.setMode(false, true, false, false);
+
+  zbCovering.setLimits(MIN_LIFT, MAX_LIFT, 0, 0);
+
+  // Set callback function for light change
+  zbCovering.onGoToLiftPercentage(goToLiftPercentage);
+  zbCovering.onStop(stopMotor);
+
+  //Add endpoint to Zigbee Core
+  Serial.println("Adding ZigbeeWindowCovering endpoint to Zigbee Core");
+  Zigbee.addEndpoint(&zbCovering);
+
+  // When all EPs are registered, start Zigbee. By default acts as ZIGBEE_END_DEVICE
+  Serial.println("Calling Zigbee.begin()");
+  if (!Zigbee.begin()) {
+    Serial.println("Zigbee failed to start!");
+    Serial.println("Rebooting...");
+    ESP.restart();
+  }
+  Serial.println("Connecting to network");
+  while (!Zigbee.connected()) {
+    Serial.print(".");
+    delay(100);
+  }
+  reportState();
+  Serial.println(); 
+}
+
+void loop() {
+  // Checking button for factory reset
+  if (digitalRead(BUTTON_PIN) == LOW) {  // Push button pressed
+    // Key debounce handling
+    delay(100);
+    int startTime = millis();
+    while (digitalRead(BUTTON_PIN) == LOW) {
+      delay(50);
+      if ((millis() - startTime) > 3000) {
+        // If key pressed for more than 3secs, factory reset Zigbee and reboot
+        Serial.printf("Resetting Zigbee to factory settings, reboot.\n");
+        Zigbee.factoryReset();
+        delay(30000);
+      }
+    }
+  } 
+
+  reportState();
+
+  delay(500);
+}
+
+void goToLiftPercentage(uint8_t liftPercentage) {
+  /* This is where you would trigger your motor to go towards liftPercentage, currentLift should
+     be updated until liftPercentage has been reached in order to provide feedback to controller */
+
+  // Our cover updates instantly!
+  currentLift = (liftPercentage * MAX_LIFT) / 100;
+
+  Serial.printf("New requsted lift from Zigbee: %d (%d)\n", currentLift, liftPercentage);
+}
+
+void reportState() {
+  if (reportedLift == currentLift) {
+    return;
+  }
+
+  Serial.printf("Reporting new state: %d (%d)\n", currentLift, reportedLift);
+
+  reportedLift = currentLift;
+
+  // This is where current state is reported to controller, to provide feedback on where the shade is at currently
+  zbCovering.setLiftPosition((uint16_t) reportedLift);
+}
+
+
+void stopMotor() {
+  // Motor can be stopped while moving cover toward current target
+  Serial.println("Stopping motor"); 
+}

libraries/Zigbee/examples/Zigbee_Window_Covering/ci.json

@@ -0,0 +1,6 @@
+{
+  "fqbn_append": "PartitionScheme=zigbee,ZigbeeMode=ed",
+  "requires": [
+    "CONFIG_SOC_IEEE802154_SUPPORTED=y"
+  ]
+}