alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-11-01 05:21:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add some details for wifi scan description

Browse Source
This commit is contained in:
muhaidong
2022-12-13 19:48:30 +08:00
parent 36caf700c7
commit 6c4ac9ab9e
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-guides/wifi.rst
View File

@@ -1216,7 +1216,7 @@ API :cpp:func:`esp_wifi_set_config()` can be used to configure the station. And
* - bssid
- This is valid only when bssid_set is 1; see field “bssid_set”.
* - channel
- If the channel is 0, the station scans the channel 1 ~ N to search for the target AP; otherwise, the station starts by scanning the channel whose value is the same as that of the “channel” field, and then scans others to find the target AP. If you do not know which channel the target AP is running on, set it to 0.
- If the channel is 0, the station scans the channel 1 ~ N to search for the target AP; otherwise, the station starts by scanning the channel whose value is the same as that of the “channel” field, and then scans the channel 1 ~ N but skip the specific channel to find the target AP. For example, if the channel is 3, the scan order will be 3, 1, 2, 4,..., N. If you do not know which channel the target AP is running on, set it to 0.
* - sort_method
- This field is only for WIFI_ALL_CHANNEL_SCAN.