fix(zigbee): Add connected(), minor fixes, example update (espressif#10636)

* fix(zigbee): Add connected and minor fixes, example update

* fix(example): Use correct API call for connected

* fix(zigbee): Increase timeout and add semaphore to begin

* feat(zigbee): Add option to select debug libs for zigbee

* fix(example): fix warning by double percentage symbol

* fix(example): Fix serial prints for Windows os

Co-authored-by: Rodrigo Garcia <[email protected]>

* ci(pre-commit): Apply automatic fixes

* fix(example): Fix precommit spelling

---------

Co-authored-by: Rodrigo Garcia <[email protected]>
Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

Author: 3 people

boards.txt

@@ -531,7 +531,15 @@ esp32h2.menu.ZigbeeMode.zczr.build.zigbee_libs=-lesp_zb_api_zczr -lesp_zb_cli_co
 esp32h2.menu.ZigbeeMode.rcp=Zigbee RCP (radio co-processor)
 esp32h2.menu.ZigbeeMode.rcp.build.zigbee_mode=-DZIGBEE_MODE_RCP
 esp32h2.menu.ZigbeeMode.rcp.build.zigbee_libs=-lesp_zb_api_rcp -lesp_zb_cli_command -lzboss_stack.rcp -lzboss_port
-
+esp32h2.menu.ZigbeeMode.ed_debug=Zigbee ED (end device) - Debug
+esp32h2.menu.ZigbeeMode.ed_debug.build.zigbee_mode=-DZIGBEE_MODE_ED
+esp32h2.menu.ZigbeeMode.ed_debug.build.zigbee_libs=-lesp_zb_api_ed.debug -lesp_zb_cli_command -lzboss_stack.ed.debug -lzboss_port.debug
+esp32h2.menu.ZigbeeMode.zczr_debug=Zigbee ZCZR (coordinator/router) - Debug
+esp32h2.menu.ZigbeeMode.zczr_debug.build.zigbee_mode=-DZIGBEE_MODE_ZCZR
+esp32h2.menu.ZigbeeMode.zczr_debug.build.zigbee_libs=-lesp_zb_api_zczr.debug -lesp_zb_cli_command -lzboss_stack.zczr.debug -lzboss_port.debug
+esp32h2.menu.ZigbeeMode.rcp_debug=Zigbee RCP (radio co-processor) - Debug
+esp32h2.menu.ZigbeeMode.rcp_debug.build.zigbee_mode=-DZIGBEE_MODE_RCP
+esp32h2.menu.ZigbeeMode.rcp_debug.build.zigbee_libs=-lesp_zb_api_rcp.debug -lesp_zb_cli_command -lzboss_stack.rcp.debug -lzboss_port.debug
 
 ##############################################################
 
@@ -723,6 +731,15 @@ esp32c6.menu.ZigbeeMode.zczr.build.zigbee_libs=-lesp_zb_api_zczr -lesp_zb_cli_co
 esp32c6.menu.ZigbeeMode.rcp=Zigbee RCP (radio co-processor)
 esp32c6.menu.ZigbeeMode.rcp.build.zigbee_mode=-DZIGBEE_MODE_RCP
 esp32c6.menu.ZigbeeMode.rcp.build.zigbee_libs=-lesp_zb_api_rcp -lesp_zb_cli_command -lzboss_stack.rcp -lzboss_port
+esp32c6.menu.ZigbeeMode.ed_debug=Zigbee ED (end device) - Debug
+esp32c6.menu.ZigbeeMode.ed_debug.build.zigbee_mode=-DZIGBEE_MODE_ED
+esp32c6.menu.ZigbeeMode.ed_debug.build.zigbee_libs=-lesp_zb_api_ed.debug -lesp_zb_cli_command -lzboss_stack.ed.debug -lzboss_port.debug
+esp32c6.menu.ZigbeeMode.zczr_debug=Zigbee ZCZR (coordinator/router) - Debug
+esp32c6.menu.ZigbeeMode.zczr_debug.build.zigbee_mode=-DZIGBEE_MODE_ZCZR
+esp32c6.menu.ZigbeeMode.zczr_debug.build.zigbee_libs=-lesp_zb_api_zczr.debug -lesp_zb_cli_command -lzboss_stack.zczr.debug -lzboss_port.debug
+esp32c6.menu.ZigbeeMode.rcp_debug=Zigbee RCP (radio co-processor) - Debug
+esp32c6.menu.ZigbeeMode.rcp_debug.build.zigbee_mode=-DZIGBEE_MODE_RCP
+esp32c6.menu.ZigbeeMode.rcp_debug.build.zigbee_libs=-lesp_zb_api_rcp.debug -lesp_zb_cli_command -lzboss_stack.rcp.debug -lzboss_port.debug
 
 ##############################################################
 

libraries/Zigbee/examples/Zigbee_Color_Dimmable_Light/Zigbee_Color_Dimmable_Light.ino

@@ -64,6 +64,11 @@ void identify(uint16_t time) {
 
 /********************* Arduino functions **************************/
 void setup() {
+  Serial.begin(115200);
+  while (!Serial) {
+    delay(10);
+  }
+
   // Init RMT and leave light OFF
   rgbLedWrite(LED_PIN, 0, 0, 0);
 
@@ -80,12 +85,21 @@ void setup() {
   zbColorLight.setManufacturerAndModel("Espressif", "ZBColorLightBulb");
 
   // Add endpoint to Zigbee Core
-  log_d("Adding ZigbeeLight endpoint to Zigbee Core");
+  Serial.println("Adding ZigbeeLight endpoint to Zigbee Core");
   Zigbee.addEndpoint(&zbColorLight);
 
-  // When all EPs are registered, start Zigbee. By default acts as ZIGBEE_END_DEVICE
-  log_d("Calling Zigbee.begin()");
-  Zigbee.begin();
+  // When all EPs are registered, start Zigbee in End Device mode
+  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);
+  }
+  Serial.println();
 }
 
 void loop() {
@@ -98,7 +112,8 @@ void loop() {
       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");
+        Serial.println("Resetting Zigbee to factory and rebooting in 1s.");
+        delay(1000);
         Zigbee.factoryReset();
       }
     }

libraries/Zigbee/examples/Zigbee_Color_Dimmer_Switch/Zigbee_Color_Dimmer_Switch.ino

@@ -46,7 +46,6 @@ ZigbeeColorDimmerSwitch zbSwitch = ZigbeeColorDimmerSwitch(SWITCH_ENDPOINT_NUMBE
 
 /********************* Arduino functions **************************/
 void setup() {
-
   Serial.begin(115200);
   while (!Serial) {
     delay(10);
@@ -68,11 +67,15 @@ void setup() {
   Zigbee.setRebootOpenNetwork(180);
 
   //When all EPs are registered, start Zigbee with ZIGBEE_COORDINATOR mode
-  Zigbee.begin(ZIGBEE_COORDINATOR);
+  if (!Zigbee.begin(ZIGBEE_COORDINATOR)) {
+    Serial.println("Zigbee failed to start!");
+    Serial.println("Rebooting...");
+    ESP.restart();
+  }
 
   Serial.println("Waiting for Light to bound to the switch");
   //Wait for switch to bound to a light:
-  while (!zbSwitch.isBound()) {
+  while (!zbSwitch.bound()) {
     Serial.printf(".");
     delay(500);
   }

libraries/Zigbee/examples/Zigbee_On_Off_Light/Zigbee_On_Off_Light.ino

@@ -45,6 +45,10 @@ void setLED(bool value) {
 
 /********************* Arduino functions **************************/
 void setup() {
+  Serial.begin(115200);
+  while (!Serial) {
+    delay(10);
+  }
   // Init LED and turn it OFF (if LED_PIN == RGB_BUILTIN, the rgbLedWrite() will be used under the hood)
   pinMode(LED_PIN, OUTPUT);
   digitalWrite(LED_PIN, LOW);
@@ -59,12 +63,21 @@ void setup() {
   zbLight.onLightChange(setLED);
 
   //Add endpoint to Zigbee Core
-  log_d("Adding ZigbeeLight endpoint to Zigbee Core");
+  Serial.println("Adding ZigbeeLight endpoint to Zigbee Core");
   Zigbee.addEndpoint(&zbLight);
 
   // When all EPs are registered, start Zigbee. By default acts as ZIGBEE_END_DEVICE
-  log_d("Calling Zigbee.begin()");
-  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);
+  }
+  Serial.println();
 }
 
 void loop() {
@@ -77,7 +90,8 @@ void loop() {
       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");
+        Serial.println("Resetting Zigbee to factory and rebooting in 1s.");
+        delay(1000);
         Zigbee.factoryReset();
       }
     }

libraries/Zigbee/examples/Zigbee_On_Off_Switch/Zigbee_On_Off_Switch.ino

@@ -70,6 +70,7 @@ ZigbeeSwitch zbSwitch = ZigbeeSwitch(SWITCH_ENDPOINT_NUMBER);
 static void onZbButton(SwitchData *button_func_pair) {
   if (button_func_pair->func == SWITCH_ONOFF_TOGGLE_CONTROL) {
     // Send toggle command to the light
+    Serial.println("Toggling light");
     zbSwitch.lightToggle();
   }
 }
@@ -93,7 +94,6 @@ static void enableGpioInterrupt(bool enabled) {
 
 /********************* Arduino functions **************************/
 void setup() {
-
   Serial.begin(115200);
   while (!Serial) {
     delay(10);
@@ -106,7 +106,7 @@ void setup() {
   zbSwitch.allowMultipleBinding(true);
 
   //Add endpoint to Zigbee Core
-  log_d("Adding ZigbeeSwitch endpoint to Zigbee Core");
+  Serial.println("Adding ZigbeeSwitch endpoint to Zigbee Core");
   Zigbee.addEndpoint(&zbSwitch);
 
   //Open network for 180 seconds after boot
@@ -118,19 +118,22 @@ void setup() {
     /* create a queue to handle gpio event from isr */
     gpio_evt_queue = xQueueCreate(10, sizeof(SwitchData));
     if (gpio_evt_queue == 0) {
-      log_e("Queue was not created and must not be used");
-      while (1);
+      Serial.println("Queue creating failed, rebooting...");
+      ESP.restart();
     }
     attachInterruptArg(buttonFunctionPair[i].pin, onGpioInterrupt, (void *)(buttonFunctionPair + i), FALLING);
   }
 
   // When all EPs are registered, start Zigbee with ZIGBEE_COORDINATOR mode
-  log_d("Calling Zigbee.begin()");
-  Zigbee.begin(ZIGBEE_COORDINATOR);
+  if (!Zigbee.begin(ZIGBEE_COORDINATOR)) {
+    Serial.println("Zigbee failed to start!");
+    Serial.println("Rebooting...");
+    ESP.restart();
+  }
 
   Serial.println("Waiting for Light to bound to the switch");
   //Wait for switch to bound to a light:
-  while (!zbSwitch.isBound()) {
+  while (!zbSwitch.bound()) {
     Serial.printf(".");
     delay(500);
   }

libraries/Zigbee/examples/Zigbee_Scan_Networks/Zigbee_Scan_Networks.ino

@@ -32,7 +32,7 @@
 #include "Zigbee.h"
 
 #ifdef ZIGBEE_MODE_ZCZR
-zigbee_role_t role = ZIGBEE_ROUTER;  // or can be ZIGBEE_COORDINATOR, but it wont scan itself
+zigbee_role_t role = ZIGBEE_ROUTER;  // or can be ZIGBEE_COORDINATOR, but it won't scan itself
 #else
 zigbee_role_t role = ZIGBEE_END_DEVICE;
 #endif
@@ -81,14 +81,13 @@ void setup() {
   }
 
   // Initialize Zigbee stack without any EPs just for scanning
-  Zigbee.begin(role);
-
-  // Waint until Zigbee stack is ready
-  while (!Zigbee.isStarted()) {
-    delay(100);
+  if (!Zigbee.begin(role)) {
+    Serial.println("Zigbee failed to start!");
+    Serial.println("Rebooting...");
+    ESP.restart();
   }
 
-  Serial.println("Setup done");
+  Serial.println("Setup done, starting Zigbee network scan...");
   // Start Zigbee Network Scan with default parameters (all channels, scan time 5)
   Zigbee.scanNetworks();
 }
@@ -98,7 +97,7 @@ void loop() {
   int16_t ZigbeeScanStatus = Zigbee.scanComplete();
   if (ZigbeeScanStatus < 0) {  // it is busy scanning or got an error
     if (ZigbeeScanStatus == ZB_SCAN_FAILED) {
-      Serial.println("WiFi Scan has failed. Starting again.");
+      Serial.println("Zigbee scan has failed. Starting again.");
       Zigbee.scanNetworks();
     }
     // other option is status ZB_SCAN_RUNNING - just wait.

libraries/Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy/Zigbee_Temp_Hum_Sensor_Sleepy.ino

@@ -27,7 +27,7 @@
  */
 
 #ifndef ZIGBEE_MODE_ED
-#error "Zigbee coordinator mode is not selected in Tools->Zigbee mode"
+#error "Zigbee end device mode is not selected in Tools->Zigbee mode"
 #endif
 
 #include "Zigbee.h"
@@ -56,14 +56,19 @@ void meausureAndSleep() {
   zbTempSensor.reportTemperature();
   zbTempSensor.reportHumidity();
 
-  log_d("Temperature: %.2f°C, Humidity: %.2f%", temperature, humidity);
+  Serial.printf("Reported temperature: %.2f°C, Humidity: %.2f%%\r\n", temperature, humidity);
 
   // Put device to deep sleep
+  Serial.println("Going to sleep now");
   esp_deep_sleep_start();
 }
 
 /********************* Arduino functions **************************/
 void setup() {
+  Serial.begin(115200);
+  while (!Serial) {
+    delay(10);
+  }
   // Init button switch
   pinMode(BUTTON_PIN, INPUT_PULLUP);
 
@@ -94,14 +99,20 @@ void setup() {
   zigbeeConfig.nwk_cfg.zed_cfg.keep_alive = 10000;
 
   // When all EPs are registered, start Zigbee in End Device mode
-  Zigbee.begin(&zigbeeConfig, false);
-
-  // Wait for Zigbee to start
-  while (!Zigbee.isStarted()) {
+  if (!Zigbee.begin(&zigbeeConfig, false)) {
+    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();
+  Serial.println("Successfully connected to Zigbee network");
 
-  // Delay 5s to allow establishing connection with coordinator, needed for sleepy devices
+  // Delay 5s (may be adjusted) to allow establishing proper connection with coordinator, needed for sleepy devices
   delay(5000);
 }
 
@@ -115,7 +126,8 @@ void loop() {
       delay(50);
       if ((millis() - startTime) > 3000) {
         // If key pressed for more than 3secs, factory reset Zigbee and reboot
-        Zigbee.factoryReset();
+        Serial.println("Resetting Zigbee to factory and rebooting in 1s.");
+        delay(1000);
       }
     }
   }

libraries/Zigbee/examples/Zigbee_Temperature_Sensor/Zigbee_Temperature_Sensor.ino

@@ -27,7 +27,7 @@
  */
 
 #ifndef ZIGBEE_MODE_ED
-#error "Zigbee coordinator mode is not selected in Tools->Zigbee mode"
+#error "Zigbee end device mode is not selected in Tools->Zigbee mode"
 #endif
 
 #include "Zigbee.h"
@@ -42,7 +42,7 @@ static void temp_sensor_value_update(void *arg) {
   for (;;) {
     // Read temperature sensor value
     float tsens_value = temperatureRead();
-    log_v("Temperature sensor value: %.2f°C", tsens_value);
+    Serial.printf("Updated temperature sensor value to %.2f°C\r\n", tsens_value);
     // Update temperature value in Temperature sensor EP
     zbTempSensor.setTemperature(tsens_value);
     delay(1000);
@@ -51,12 +51,10 @@ static void temp_sensor_value_update(void *arg) {
 
 /********************* Arduino functions **************************/
 void setup() {
-
   Serial.begin(115200);
   while (!Serial) {
     delay(10);
   }
-
   // Init button switch
   pinMode(BUTTON_PIN, INPUT_PULLUP);
 
@@ -72,8 +70,21 @@ void setup() {
   // Add endpoint to Zigbee Core
   Zigbee.addEndpoint(&zbTempSensor);
 
+  Serial.println("Starting Zigbee...");
   // When all EPs are registered, start Zigbee in End Device mode
-  Zigbee.begin();
+  if (!Zigbee.begin()) {
+    Serial.println("Zigbee failed to start!");
+    Serial.println("Rebooting...");
+    ESP.restart();
+  } else {
+    Serial.println("Zigbee started successfully!");
+  }
+  Serial.println("Connecting to network");
+  while (!Zigbee.connected()) {
+    Serial.print(".");
+    delay(100);
+  }
+  Serial.println();
 
   // Start Temperature sensor reading task
   xTaskCreate(temp_sensor_value_update, "temp_sensor_update", 2048, NULL, 10, NULL);
@@ -96,7 +107,8 @@ void loop() {
       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");
+        Serial.println("Resetting Zigbee to factory and rebooting in 1s.");
+        delay(1000);
         Zigbee.factoryReset();
       }
     }