1692896e5e
1. add network channel switch function. - users can obtain the new channel through the event MESH_EVENT_CHANNEL_SWITCH. - the entire network will be moved to the same channel as the router without user intervention. - if no router is in the network, users can call esp_mesh_switch_channel() on the root side to move the entire network to their desired channel. 2. support not configuring the network channel. 3. support not configuring the router BSSID even if the router is hidden. 4. add allow_channel_switch to mesh configuration. - if the channel is not specified, this value will be ignored. - if the channel is specified and this value is set, when "fail" (mesh_attempts_t) times of parent selection or look for networks are reached, device will change to perform a full channel scan for networks that could join. - if the channel is specified and this value is set to 0, when a root is not elected, channel switch is not allowed. but when a root appears, the root performs a full channel scan during the process of connecting to the router, so even allow_channel_switch is set to 0, the root may still switch channel and eventually the entire network changes channel. 5. add allow_router_switch to mesh router configuration. - if the BSSID of router is not specified, this value will be ignored. - if the BSSID of router is specified and this value is set, when the router of this specified BSSID fails to be found after "fail" (mesh_attempts_t) times, the entire network is allowed to switch to another router with the same SSID. 6. modify the root to perform a full channel scan when esp_wifi_connect(). 7. support handling beacon without DS Paramter Set. |
||
---|---|---|
.. | ||
_static | ||
en | ||
zh_CN | ||
check_doc_warnings.sh | ||
check_lang_folder_sync.sh | ||
conf_common.py | ||
docs_common.mk | ||
Doxyfile | ||
gen-dxd.py | ||
gen-toolchain-links.py | ||
gen-version-specific-includes.py | ||
issue_template.md | ||
link-roles.py | ||
local_util.py | ||
README.md | ||
requirements.txt | ||
sphinx-known-warnings.txt | ||
TEMPLATE_EXAMPLE_README.md |
Documentation Source Folder
This folder contains source files of ESP-IDF documentation available in English and 中文.
The sources do not render well in GitHub and some information is not visible at all.
Use actual documentation generated within about 20 minutes on each commit:
Hosted Documentation
- English: https://docs.espressif.com/projects/esp-idf/en/latest/
- 中文: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.
Building Documentation
- Install
make
anddoxygen
for your platform (make
may already be installed as an ESP-IDF prerequisite). - Change to either the docs/en or docs/zh_CN subdirectory and run
make html
make
will probably prompt you to run a python pip install step to get some other Python-related prerequisites. Run the command as shown, then re-runmake html
to build the docs.
For MSYS2 MINGW32 on Windows
If using Windows and the MSYS2 MINGW32 terminal, run this command before running "make html" the first time:
pacman -S doxygen mingw-w64-i686-python2-pillow
Note: Currently it is not possible to build docs on Windows without using a Unix-on-Windows layer such as MSYS2 MINGW32.