Skip to content

Commit 0bdd0c8

Browse files
authored
Create README.md
1 parent 778a516 commit 0bdd0c8

File tree

1 file changed

+75
-0
lines changed
  • libraries/WiFi/examples/WiFiScanAsync

1 file changed

+75
-0
lines changed
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# WiFiScanAsync Example
2+
3+
This example demonstrates how to use the WiFi library to scan available WiFi networks in asynchronous mode and print the results.
4+
5+
## Supported Targets
6+
7+
Currently this example supports the following targets.
8+
9+
| Supported Targets | ESP32 | ESP32-S2 | ESP32-C3 | ESP32-S3 | ESP32-C6 |
10+
| ----------------- | ----- | -------- | -------- | -------- | -------- |
11+
12+
## How to Use Example
13+
14+
* How to install the Arduino IDE: [Install Arduino IDE](https://github.com/espressif/arduino-esp32/tree/master/docs/arduino-ide).
15+
16+
#### Using Arduino IDE
17+
18+
* Before Compile/Verify, select the correct board: `Tools -> Board`.
19+
* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
20+
21+
#### Using Platform IO
22+
23+
* Select the COM port: `Devices` or setting the `upload_port` option on the `platformio.ini` file.
24+
25+
## Example/Log Output
26+
27+
```
28+
Setup done
29+
Scan start
30+
Loop running...
31+
Loop running...
32+
Loop running...
33+
Loop running...
34+
Loop running...
35+
Loop running...
36+
Loop running...
37+
Loop running...
38+
Loop running...
39+
40+
Scan done
41+
17 networks found
42+
Nr | SSID | RSSI | CH | Encryption
43+
1 | IoTNetwork | -62 | 1 | WPA2
44+
2 | WiFiSSID | -62 | 1 | WPA2-EAP
45+
3 | B3A7992 | -63 | 6 | WPA+WPA2
46+
4 | WiFi | -63 | 6 | WPA3
47+
5 | IoTNetwork2 | -64 | 11 | WPA2+WPA3
48+
...
49+
```
50+
51+
## Troubleshooting
52+
53+
***Important: Be sure you're using a good quality USB cable and you have enought power source for your project.***
54+
55+
* **Programming Fail:** If the programming/flash procedure fails, try to reduce the serial connection speed.
56+
* **COM port not detected:** Check the USB cable connection and the USB to Serial driver installation.
57+
58+
If the error persist, you can ask help at the official [ESP32 forum](https://esp32.com) or see [Contribute](#contribute).
59+
60+
## Contribute
61+
62+
To know how to contribute to this project, see [How to contribute.](https://github.com/espressif/arduino-esp32/blob/master/CONTRIBUTING.rst)
63+
64+
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!
65+
66+
Before creating a new issue, be sure to try the Troubleshooting and to check if the same issue was already created by someone else.
67+
68+
## Resources
69+
70+
* Arduino-ESP32 Official Repository: [espressif/arduino-esp32](https://github.com/espressif/arduino-esp32)
71+
* ESP32 Datasheet: [Link to datasheet](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf)
72+
* ESP32-S2 Datasheet: [Link to datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf)
73+
* ESP32-C3 Datasheet: [Link to datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf)
74+
* ESP32-C6 Datasheet: [Link to datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf)
75+
* Official ESP-IDF documentation: [ESP-IDF](https://idf.espressif.com)

0 commit comments

Comments
 (0)