Zigbee examples update (#9627)

Author: P-R-O-C-H-Y

boards.txt

@@ -1,6 +1,6 @@
 # Arduino-ESP32 Zigbee Light Bulb Example
 
-This example shows how to configure the Zigbee end device and use it as a HA on/off light bulb.
+This example shows how to configure the Zigbee end device and use it as a Home Automation (HA) on/off light bulb.
 
 **This example is based on ESP-Zigbee-SDK example esp_zigbee_HA_sample/HA_on_off_light.**
 
@@ -39,6 +39,9 @@ You can do the following:
 * In the Arduino IDE go to the Tools menu and set `Erase All Flash Before Sketch Upload` to `Enabled`
 * In the sketch uncomment function `esp_zb_nvram_erase_at_start(true);` located in `esp_zb_task` function.
 
+By default, the coordinator network is open for 180s after rebooting or flashing new firmware. After that, the network is closed for adding new devices.
+You can change it by editing `esp_zb_bdb_open_network(180);` in `esp_zb_app_signal_handler` function.
+
 ***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.

libraries/ESP32/examples/Zigbee/Zigbee_Light_Bulb/README.md

@@ -49,10 +49,10 @@
   }
 
 #define ESP_ZB_DEFAULT_RADIO_CONFIG() \
-  { .radio_mode = RADIO_MODE_NATIVE, }
+  { .radio_mode = ZB_RADIO_MODE_NATIVE, }
 
 #define ESP_ZB_DEFAULT_HOST_CONFIG() \
-  { .host_connection_mode = HOST_CONNECTION_MODE_NONE, }
+  { .host_connection_mode = ZB_HOST_CONNECTION_MODE_NONE, }
 
 /* Zigbee configuration */
 #define INSTALLCODE_POLICY_ENABLE   false /* enable the install code policy for security */
@@ -78,8 +78,13 @@ void esp_zb_app_signal_handler(esp_zb_app_signal_t *signal_struct) {
     case ESP_ZB_BDB_SIGNAL_DEVICE_FIRST_START:
     case ESP_ZB_BDB_SIGNAL_DEVICE_REBOOT:
       if (err_status == ESP_OK) {
-        log_i("Start network steering");
-        esp_zb_bdb_start_top_level_commissioning(ESP_ZB_BDB_MODE_NETWORK_STEERING);
+        log_i("Device started up in %s factory-reset mode", esp_zb_bdb_is_factory_new() ? "" : "non");
+        if (esp_zb_bdb_is_factory_new()) {
+          log_i("Start network formation");
+          esp_zb_bdb_start_top_level_commissioning(ESP_ZB_BDB_MODE_NETWORK_STEERING);
+        } else {
+          log_i("Device rebooted");
+        }
       } else {
         /* commissioning failed */
         log_w("Failed to initialize Zigbee stack (status: %s)", esp_err_to_name(err_status));
@@ -122,7 +127,7 @@ static void esp_zb_task(void *pvParameters) {
   esp_zb_set_primary_network_channel_set(ESP_ZB_PRIMARY_CHANNEL_MASK);
 
   //Erase NVRAM before creating connection to new Coordinator
-  //esp_zb_nvram_erase_at_start(true); //Comment out this line to erase NVRAM data if you are conneting to new Coordinator
+  esp_zb_nvram_erase_at_start(true);  //Comment out this line to erase NVRAM data if you are conneting to new Coordinator
 
   ESP_ERROR_CHECK(esp_zb_start(false));
   esp_zb_main_loop_iteration();

libraries/ESP32/examples/Zigbee/Zigbee_Light_Bulb/Zigbee_Light_Bulb.ino

@@ -1,6 +1,6 @@
 # Arduino-ESP32 Zigbee Light Switch Example
 
-This example shows how to configure Zigbee Coordinator and use it as an HA on/off light switch.
+This example shows how to configure Zigbee Coordinator and use it as a Home Automation (HA) on/off light switch.
 
 **This example is based on ESP-Zigbee-SDK example esp_zigbee_HA_sample/HA_on_off_switch.**
 
@@ -39,6 +39,9 @@ You can do the following:
 * In the Arduino IDE go to the Tools menu and set `Erase All Flash Before Sketch Upload` to `Enabled`.
 * In the `Zigbee_Light_Bulb` example sketch uncomment function `esp_zb_nvram_erase_at_start(true);` located in `esp_zb_task` function.
 
+By default, the coordinator network is open for 180s after rebooting or flashing new firmware. After that, the network is closed for adding new devices.
+You can change it by editing `esp_zb_bdb_open_network(180);` in `esp_zb_app_signal_handler` function.
+
 ***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.

libraries/ESP32/examples/Zigbee/Zigbee_Light_Switch/README.md

@@ -75,10 +75,10 @@ static switch_func_pair_t button_func_pair[] = {{GPIO_INPUT_IO_TOGGLE_SWITCH, SW
   }
 
 #define ESP_ZB_DEFAULT_RADIO_CONFIG() \
-  { .radio_mode = RADIO_MODE_NATIVE, }
+  { .radio_mode = ZB_RADIO_MODE_NATIVE, }
 
 #define ESP_ZB_DEFAULT_HOST_CONFIG() \
-  { .host_connection_mode = HOST_CONNECTION_MODE_NONE, }
+  { .host_connection_mode = ZB_HOST_CONNECTION_MODE_NONE, }
 
 typedef struct light_bulb_device_params_s {
   esp_zb_ieee_addr_t ieee_addr;
@@ -92,7 +92,7 @@ typedef struct light_bulb_device_params_s {
 #define HA_ONOFF_SWITCH_ENDPOINT    1                                    /* esp light switch device endpoint */
 #define ESP_ZB_PRIMARY_CHANNEL_MASK ESP_ZB_TRANSCEIVER_ALL_CHANNELS_MASK /* Zigbee primary channel mask use in the example */
 
-/********************* Define functions **************************/
+/********************* Zigbee functions **************************/
 static void esp_zb_buttons_handler(switch_func_pair_t *button_func_pair) {
   if (button_func_pair->func == SWITCH_ONOFF_TOGGLE_CONTROL) {
     /* implemented light switch toggle functionality */
@@ -153,8 +153,15 @@ void esp_zb_app_signal_handler(esp_zb_app_signal_t *signal_struct) {
     case ESP_ZB_BDB_SIGNAL_DEVICE_FIRST_START:
     case ESP_ZB_BDB_SIGNAL_DEVICE_REBOOT:
       if (err_status == ESP_OK) {
-        log_i("Start network formation");
-        esp_zb_bdb_start_top_level_commissioning(ESP_ZB_BDB_MODE_NETWORK_FORMATION);
+        log_i("Device started up in %s factory-reset mode", esp_zb_bdb_is_factory_new() ? "" : "non");
+        if (esp_zb_bdb_is_factory_new()) {
+          log_i("Start network formation");
+          esp_zb_bdb_start_top_level_commissioning(ESP_ZB_BDB_MODE_NETWORK_FORMATION);
+        } else {
+          log_i("Device rebooted");
+          log_i("Openning network for joining for %d seconds", 180);
+          esp_zb_bdb_open_network(180);
+        }
       } else {
         log_e("Failed to initialize Zigbee stack (status: %s)", esp_err_to_name(err_status));
       }
@@ -187,6 +194,15 @@ void esp_zb_app_signal_handler(esp_zb_app_signal_t *signal_struct) {
       cmd_req.addr_of_interest = dev_annce_params->device_short_addr;
       esp_zb_zdo_find_on_off_light(&cmd_req, user_find_cb, NULL);
       break;
+    case ESP_ZB_NWK_SIGNAL_PERMIT_JOIN_STATUS:
+      if (err_status == ESP_OK) {
+        if (*(uint8_t *)esp_zb_app_signal_get_params(p_sg_p)) {
+          log_i("Network(0x%04hx) is open for %d seconds", esp_zb_get_pan_id(), *(uint8_t *)esp_zb_app_signal_get_params(p_sg_p));
+        } else {
+          log_w("Network(0x%04hx) closed, devices joining not allowed.", esp_zb_get_pan_id());
+        }
+      }
+      break;
     default: log_i("ZDO signal: %s (0x%x), status: %s", esp_zb_zdo_signal_to_string(sig_type), sig_type, esp_err_to_name(err_status)); break;
   }
 }