esp-idf/docs/en/api-reference/network/esp_wifi.rst

Wi-Fi
=====

:link_to_translation:`zh_CN:[中文]`

Introduction
------------

The Wi-Fi libraries provide support for configuring and monitoring the {IDF_TARGET_NAME} Wi-Fi networking functionality. This includes configuration for:

- Station mode (aka STA mode or Wi-Fi client mode). {IDF_TARGET_NAME} connects to an access point.
- AP mode (aka Soft-AP mode or Access Point mode). Stations connect to the {IDF_TARGET_NAME}.
- Station/AP-coexistence mode ({IDF_TARGET_NAME} is concurrently an access point and a station connected to another access point).

- Various security modes for the above (WPA, WPA2, WPA3, etc.)
- Scanning for access points (active & passive scanning).
- Promiscuous mode for monitoring of IEEE802.11 Wi-Fi packets.


Application Examples
--------------------

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.


API Reference
-------------

.. include-build-file:: inc/esp_wifi.inc
.. include-build-file:: inc/esp_wifi_types.inc
.. include-build-file:: inc/esp_eap_client.inc
.. include-build-file:: inc/esp_wps.inc
.. include-build-file:: inc/esp_rrm.inc
.. include-build-file:: inc/esp_wnm.inc
.. include-build-file:: inc/esp_mbo.inc
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs> 2016-11-05 12:18:25 -04:00			`Wi-Fi`
			`=====`
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00
Add Chinese translation for index.rst files and esp_wifi.rst file in api-reference following Kirill's English review, including: -network/index.rst -network/esp_wifi.rst -peripherals/index.rst -provisioning/index.rst 2019-05-15 09:05:44 -04:00			:link_to_translation:`zh_CN:[中文]`

docs: Add introduction section for WiFi, replace boilerplate 2017-09-26 21:13:20 -04:00			`Introduction`
			`------------`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 15:08:36 -04:00
update wifi docs 2021-02-01 22:41:52 -05:00			`The Wi-Fi libraries provide support for configuring and monitoring the {IDF_TARGET_NAME} Wi-Fi networking functionality. This includes configuration for:`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 15:08:36 -04:00
update wifi docs 2021-02-01 22:41:52 -05:00			`- Station mode (aka STA mode or Wi-Fi client mode). {IDF_TARGET_NAME} connects to an access point.`
doc: Update English pages with generic target name 2019-12-08 22:01:09 -05:00			`- AP mode (aka Soft-AP mode or Access Point mode). Stations connect to the {IDF_TARGET_NAME}.`
docs: update CN translation for esp_wifi and jtag-dubugging/index, and fix typos in esp_spi_slave_protocol 2021-11-26 02:33:32 -05:00			`- Station/AP-coexistence mode ({IDF_TARGET_NAME} is concurrently an access point and a station connected to another access point).`
docs: Add introduction section for WiFi, replace boilerplate 2017-09-26 21:13:20 -04:00
fix(wifi): Add bugfixes and improvements 1. Update wifi security mode 2. Add check for memory allocation in tx buffers 3. Fix association refused temporarily comeback time set to zero issue 2023-05-26 05:24:18 -04:00			`- Various security modes for the above (WPA, WPA2, WPA3, etc.)`
docs: Add introduction section for WiFi, replace boilerplate 2017-09-26 21:13:20 -04:00			`- Scanning for access points (active & passive scanning).`
update wifi docs 2021-02-01 22:41:52 -05:00			`- Promiscuous mode for monitoring of IEEE802.11 Wi-Fi packets.`
Doc/review api reference indexes 2019-04-28 22:53:42 -04:00
Added links to examples in API documentation 2017-01-17 13:12:48 -05:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 04:36:01 -04:00			`Application Examples`
			`--------------------`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 15:08:36 -04:00
docs: update wifi application examples 2022-08-19 06:41:57 -04:00			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.
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00

docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 04:36:01 -04:00			`API Reference`
			`-------------`
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs> 2016-11-05 12:18:25 -04:00
docs: add new top-level docs builder that builds docs for a single chip 2019-11-12 22:46:16 -05:00			`.. include-build-file:: inc/esp_wifi.inc`
			`.. include-build-file:: inc/esp_wifi_types.inc`
change(wifi): Add supplicant's public API header files to doc 2023-09-12 04:46:44 -04:00			`.. include-build-file:: inc/esp_eap_client.inc`
			`.. include-build-file:: inc/esp_wps.inc`
			`.. include-build-file:: inc/esp_rrm.inc`
			`.. include-build-file:: inc/esp_wnm.inc`
			`.. include-build-file:: inc/esp_mbo.inc`