esp_wifi.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233343536
  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. - Combined AP-STA 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, WEP, 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. The :example:`wifi` directory of ESP-IDF examples contains the following applications:
  16. Code examples for Wi-Fi are provided in the :example:`wifi` directory of ESP-IDF examples.
  17. In addition, there is a simple `esp-idf-template <https://github.com/espressif/esp-idf-template>`_ application to demonstrate a minimal IDF project structure.
  18. API Reference
  19. -------------
  20. .. include-build-file:: inc/esp_wifi.inc
  21. .. include-build-file:: inc/esp_wifi_types.inc