esp_wifi.rst 1.3 KB

1234567891011121314151617181920212223242526272829303132333435
  1. Wi-Fi
  2. =====
  3. :link_to_translation:`zh_CN:[中文]`
  4. Introduction
  5. ------------
  6. The Wi-Fi libraries provide support for configuring and monitoring the {IDF_TARGET_NAME} Wi-Fi networking functionality. This includes configuration for:
  7. - Station mode (aka STA mode or Wi-Fi client mode). {IDF_TARGET_NAME} connects to an access point.
  8. - AP mode (aka Soft-AP mode or Access Point mode). Stations connect to the {IDF_TARGET_NAME}.
  9. - Station/AP-coexistence mode ({IDF_TARGET_NAME} is concurrently an access point and a station connected to another access point).
  10. - Various security modes for the above (WPA, WPA2, WPA3, etc.)
  11. - Scanning for access points (active & passive scanning).
  12. - Promiscuous mode for monitoring of IEEE802.11 Wi-Fi packets.
  13. Application Examples
  14. --------------------
  15. Several application examples demonstrating the functionality of Wi-Fi library are provided in :example:`wifi` directory of ESP-IDF repository. Please check the :example_file:`README <wifi/README.md>` for more details.
  16. API Reference
  17. -------------
  18. .. include-build-file:: inc/esp_wifi.inc
  19. .. include-build-file:: inc/esp_wifi_types.inc
  20. .. include-build-file:: inc/esp_eap_client.inc
  21. .. include-build-file:: inc/esp_wps.inc
  22. .. include-build-file:: inc/esp_rrm.inc
  23. .. include-build-file:: inc/esp_wnm.inc
  24. .. include-build-file:: inc/esp_mbo.inc