Update READMEs + add openNetwork fucntion

P-R-O-C-H-Y · P-R-O-C-H-Y · commit 04e0f7556280 · 2024-09-27T09:31:44.000+02:00
diff --git a/libraries/Zigbee/examples/Zigbee_Color_Dimmable_Light/README.md b/libraries/Zigbee/examples/Zigbee_Color_Dimmable_Light/README.md
@@ -27,17 +27,21 @@ To get more information about the Espressif boards see [Espressif Development Ki
 * Select the End device Zigbee mode: `Tools -> Zigbee mode: Zigbee ED (end device)`
 * 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 before flashing it to the board. It is recommended to do this if you did changes to the coordinator.
+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`
-* In the sketch uncomment function `esp_zb_nvram_erase_at_start(true);` located in `esp_zb_task` function.
+* 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 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.
+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***
 
diff --git a/libraries/Zigbee/examples/Zigbee_Color_Dimmer_Switch/README.md b/libraries/Zigbee/examples/Zigbee_Color_Dimmer_Switch/README.md
@@ -27,18 +27,21 @@ To get more information about the Espressif boards see [Espressif Development Ki
 * Select the Coordinator Zigbee mode: `Tools -> Zigbee mode: Zigbee ZCZR (coordinator/router)`.
 * 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 info to see logs from Zigbee stack: `Tools -> Core Debug Level: Info`.
+* 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 the example `Zigbee_Light_Bulb` 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.
+If the End device flashed with the example `Zigbee_Color_Dimmable_Light` 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`.
-* In the `Zigbee_Light_Bulb` example sketch uncomment function `esp_zb_nvram_erase_at_start(true);` located in `esp_zb_task` function.
+* Add to the sketch `Zigbee.factoryReset();` to reset the device and Zigbee stack.
 
-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.
+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***
 
diff --git a/libraries/Zigbee/examples/Zigbee_On_Off_Light/README.md b/libraries/Zigbee/examples/Zigbee_On_Off_Light/README.md
@@ -28,17 +28,22 @@ To get more information about the Espressif boards see [Espressif Development Ki
 * Select the End device Zigbee mode: `Tools -> Zigbee mode: Zigbee ED (end device)`
 * 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 before flashing it to the board. It is recommended to do this if you did changes to the coordinator.
+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`
-* In the sketch uncomment function `esp_zb_nvram_erase_at_start(true);` located in `esp_zb_task` function.
+* 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.
 
-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***
 
diff --git a/libraries/Zigbee/examples/Zigbee_On_Off_Switch/README.md b/libraries/Zigbee/examples/Zigbee_On_Off_Switch/README.md
@@ -27,18 +27,21 @@ To get more information about the Espressif boards see [Espressif Development Ki
 * Select the Coordinator Zigbee mode: `Tools -> Zigbee mode: Zigbee ZCZR (coordinator/router)`.
 * 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 info to see logs from Zigbee stack: `Tools -> Core Debug Level: Info`.
+* 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 the example `Zigbee_Light_Bulb` 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.
+If the End device flashed with the example `Zigbee_On_Off_Light` 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`.
-* In the `Zigbee_Light_Bulb` example sketch uncomment function `esp_zb_nvram_erase_at_start(true);` located in `esp_zb_task` function.
+* In the `Zigbee_On_Off_Light` example sketch call `Zigbee.factoryReset();`.
 
-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.
+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***
 
diff --git a/libraries/Zigbee/examples/Zigbee_Scan_Networks/README.md b/libraries/Zigbee/examples/Zigbee_Scan_Networks/README.md
@@ -42,18 +42,10 @@ To get more information about the Espressif boards see [Espressif Development Ki
 * Select the End device Zigbee mode: `Tools -> Zigbee mode: Zigbee ED (end device)`
 * 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 before flashing it to the board. It is recommended to do this if you did changes to 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`
-* 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.
diff --git a/libraries/Zigbee/examples/Zigbee_Temperature_Sensor/README.md b/libraries/Zigbee/examples/Zigbee_Temperature_Sensor/README.md
@@ -38,17 +38,21 @@ To get more information about the Espressif boards see [Espressif Development Ki
 * Select the End device Zigbee mode: `Tools -> Zigbee mode: Zigbee ED (end device)`
 * 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 before flashing it to the board. It is recommended to do this if you did changes to the coordinator.
+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`
-* In the sketch uncomment function `esp_zb_nvram_erase_at_start(true);` located in `esp_zb_task` function.
+* 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 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.
+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***
 
diff --git a/libraries/Zigbee/examples/Zigbee_Thermostat/README.md b/libraries/Zigbee/examples/Zigbee_Thermostat/README.md
@@ -38,18 +38,21 @@ To get more information about the Espressif boards see [Espressif Development Ki
 * Select the Coordinator Zigbee mode: `Tools -> Zigbee mode: Zigbee ZCZR (coordinator/router)`.
 * 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 info to see logs from Zigbee stack: `Tools -> Core Debug Level: Info`.
+* 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 the example `Zigbee_Temperature_Sensor` 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`.
-* In the `Zigbee_Temperature_Sensor` example sketch uncomment function `esp_zb_nvram_erase_at_start(true);` located in `esp_zb_task` function.
+* In the `Zigbee_Temperature_Sensor` example sketch call `Zigbee.factoryReset();`.
 
-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.
+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***
 
diff --git a/libraries/Zigbee/src/ZigbeeCore.cpp b/libraries/Zigbee/src/ZigbeeCore.cpp
@@ -154,6 +154,13 @@ void ZigbeeCore::setRebootOpenNetwork(uint8_t time) {
   _open_network = time;
 }
 
+void ZigbeeCore::openNetwork(uint8_t time) {
+  if (_started) {
+    log_v("Openning network for joining for %d seconds", time);
+    esp_zb_bdb_open_network(time);
+  }
+}
+
 static void bdb_start_top_level_commissioning_cb(uint8_t mode_mask) {
   ESP_ERROR_CHECK(esp_zb_bdb_start_top_level_commissioning(mode_mask));
 }
diff --git a/libraries/Zigbee/src/ZigbeeCore.h b/libraries/Zigbee/src/ZigbeeCore.h
@@ -107,6 +107,7 @@ class ZigbeeCore {
 
         void setPrimaryChannelMask(uint32_t mask);
         void setRebootOpenNetwork(uint8_t time);
+        void openNetwork(uint8_t time);
 
         //scan_duration Time spent scanning each channel, in units of ((1 << scan_duration) + 1) * a beacon time. (15.36 microseconds)
         void scanNetworks(uint32_t channel_mask = ESP_ZB_TRANSCEIVER_ALL_CHANNELS_MASK, uint8_t scan_duration = 5);
diff --git a/libraries/Zigbee/src/ZigbeeEP.cpp b/libraries/Zigbee/src/ZigbeeEP.cpp
@@ -124,9 +124,6 @@ char* ZigbeeEP::readModel(uint8_t endpoint, uint16_t short_addr) {
     return _read_model;
 }
 
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wunused-variable"
-
 void ZigbeeEP::printBoundDevices() {
     log_i("Bound devices:");
     for(const auto& device : _bound_devices) {
@@ -135,8 +132,6 @@ void ZigbeeEP::printBoundDevices() {
     }
 }
 
-#pragma GCC diagnostic pop
-
 void ZigbeeEP::zbReadBasicCluster(const esp_zb_zcl_attribute_t *attribute) {
     /* Basic cluster attributes */
     if (attribute->id == ESP_ZB_ZCL_ATTR_BASIC_MANUFACTURER_NAME_ID && attribute->data.type == ESP_ZB_ZCL_ATTR_TYPE_CHAR_STRING && attribute->data.value) {
diff --git a/libraries/Zigbee/src/ep/ZigbeeLight.cpp b/libraries/Zigbee/src/ep/ZigbeeLight.cpp
@@ -39,4 +39,4 @@ void ZigbeeLight::lightChanged() {
     }
 }
 
-#endif //SOC_IEEE802154_SUPPORTED
+#endif //SOC_IEEE802154_SUPPORTED
diff --git a/libraries/Zigbee/src/ep/ZigbeeSwitch.cpp b/libraries/Zigbee/src/ep/ZigbeeSwitch.cpp
@@ -235,4 +235,4 @@ void ZigbeeSwitch::lightOnWithTimedOff(uint8_t on_off_control, uint16_t time_on,
     }
 }
 
-#endif //SOC_IEEE802154_SUPPORTED
+#endif //SOC_IEEE802154_SUPPORTED

Original file line number	Diff line number	Diff line change
`@@ -154,6 +154,13 @@ void ZigbeeCore::setRebootOpenNetwork(uint8_t time) {`
`154`	`154`	`_open_network = time;`
`155`	`155`	`}`
`156`	`156`
	`157`	`+void ZigbeeCore::openNetwork(uint8_t time) {`
	`158`	`+ if (_started) {`
	`159`	`+ log_v("Openning network for joining for %d seconds", time);`
	`160`	`+ esp_zb_bdb_open_network(time);`
	`161`	`+ }`
	`162`	`+}`
	`163`	`+`
`157`	`164`	`static void bdb_start_top_level_commissioning_cb(uint8_t mode_mask) {`
`158`	`165`	`ESP_ERROR_CHECK(esp_zb_bdb_start_top_level_commissioning(mode_mask));`
`159`	`166`	`}`
Original file line number	Diff line number	Diff line change
`@@ -124,9 +124,6 @@ char* ZigbeeEP::readModel(uint8_t endpoint, uint16_t short_addr) {`
`124`	`124`	`return _read_model;`
`125`	`125`	`}`
`126`	`126`
`127`		`-#pragma GCC diagnostic push`
`128`		`-#pragma GCC diagnostic ignored "-Wunused-variable"`
`129`		`-`
`130`	`127`	`void ZigbeeEP::printBoundDevices() {`
`131`	`128`	`log_i("Bound devices:");`
`132`	`129`	`for(const auto& device : _bound_devices) {`
`@@ -135,8 +132,6 @@ void ZigbeeEP::printBoundDevices() {`
`135`	`132`	`}`
`136`	`133`	`}`
`137`	`134`
`138`		`-#pragma GCC diagnostic pop`
`139`		`-`
`140`	`135`	`void ZigbeeEP::zbReadBasicCluster(const esp_zb_zcl_attribute_t *attribute) {`
`141`	`136`	`/* Basic cluster attributes */`
`142`	`137`	`if (attribute->id == ESP_ZB_ZCL_ATTR_BASIC_MANUFACTURER_NAME_ID && attribute->data.type == ESP_ZB_ZCL_ATTR_TYPE_CHAR_STRING && attribute->data.value) {`