Skip to content

Commit 644ad4c

Browse files
authored
fix(example): Update readme
1 parent 3b7c3a8 commit 644ad4c

File tree

1 file changed

+4
-12
lines changed
  • libraries/Zigbee/examples/Zigbee_Power_Outlet

1 file changed

+4
-12
lines changed

libraries/Zigbee/examples/Zigbee_Power_Outlet/README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
@ -0,0 +1,68 @@
22
# Arduino-ESP32 Zigbee On/Off Power Outlet Example
33

4-
This example shows how to configure Zigbee Coordinator and use it as a Home Automation (HA) on/off power outlet.
4+
This example shows how to configure Zigbee Router device and use it as a Home Automation (HA) on/off power outlet.
55

66
# Supported Targets
77

@@ -12,38 +12,30 @@ Currently, this example supports the following targets.
1212

1313
## Hardware Required
1414

15-
* One development board (ESP32-H2 or ESP32-C6) acting as Zigbee end device (loaded with Zigbee_Power_Outlet example).
1615
* A USB cable for power supply and programming.
17-
* Choose another board (ESP32-H2 or ESP32-C6) as Zigbee coordinator and upload the Zigbee_On_Off_Switch example.
1816

1917
### Configure the Project
2018

21-
Set the Button Switch GPIO by changing the `GPIO_INPUT_IO_TOGGLE_SWITCH` definition. By default, it's the pin `9` (BOOT button on ESP32-C6 and ESP32-H2).
19+
Set the Button GPIO by changing the `button` definition. By default, it's the pin `9` (BOOT button on ESP32-C6 and ESP32-H2).
2220

2321
#### Using Arduino IDE
2422

2523
To get more information about the Espressif boards see [Espressif Development Kits](https://www.espressif.com/en/products/devkits).
2624

2725
* Before Compile/Verify, select the correct board: `Tools -> Board`.
2826
* Select the Coordinator Zigbee mode: `Tools -> Zigbee mode: Zigbee ZCZR (coordinator/router)`.
29-
* Select Partition Scheme for Zigbee: `Tools -> Partition Scheme: Zigbee 4MB with spiffs`.
27+
* Select Partition Scheme for Zigbee: `Tools -> Partition Scheme: Zigbee ZCZR 4MB with spiffs`.
3028
* Select the COM port: `Tools -> Port: xxx where the `xxx` is the detected COM port.
3129
* Optional: Set debug level to verbose to see all logs from Zigbee stack: `Tools -> Core Debug Level: Verbose`.
3230

3331
## Troubleshooting
3432

35-
If the End device flashed with the example `Zigbee_Power_Outlet` 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.
33+
If the device flashed with the example `Zigbee_Power_Outlet` is not connecting to the coordinator, erase the flash of the device before flashing the example to the board. It is recommended to do this if you re-flash the coordinator or do some big changes in the appication code.
3634
You can do the following:
3735

3836
* In the Arduino IDE go to the Tools menu and set `Erase All Flash Before Sketch Upload` to `Enabled`.
3937
* In the `Zigbee_Power_Outlet` example sketch call `Zigbee.factoryReset();`.
4038

41-
By default, the coordinator network is closed after rebooting or flashing new firmware.
42-
To open the network you have 2 options:
43-
44-
* Open network after reboot by setting `Zigbee.setRebootOpenNetwork(time);` before calling `Zigbee.begin();`.
45-
* In application you can anytime call `Zigbee.openNetwork(time);` to open the network for devices to join.
46-
4739
***Important: Make sure you are using a good quality USB cable and that you have a reliable power source***
4840

4941
* **LED not blinking:** Check the wiring connection and the IO selection.

0 commit comments

Comments
 (0)