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, WEP, 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
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 16:18:25 +00:00			`Wi-Fi`
			`=====`
Initial list of Wi-Fi API 2016-10-24 18:44:57 +00: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 13:05:44 +00:00			:link_to_translation:`zh_CN:[中文]`

docs: Add introduction section for WiFi, replace boilerplate 2017-09-27 01:13:20 +00:00			`Introduction`
			`------------`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 19:08:36 +00:00
update wifi docs 2021-02-02 03:41:52 +00: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 19:08:36 +00:00
update wifi docs 2021-02-02 03:41:52 +00: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-09 03:01:09 +00: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 07:33:32 +00: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-27 01:13:20 +00:00
			`- Various security modes for the above (WPA, WPA2, WEP, etc.)`
			`- Scanning for access points (active & passive scanning).`
update wifi docs 2021-02-02 03:41:52 +00:00			`- Promiscuous mode for monitoring of IEEE802.11 Wi-Fi packets.`
Doc/review api reference indexes 2019-04-29 02:53:42 +00:00
Added links to examples in API documentation 2017-01-17 18:12:48 +00: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 08:36:01 +00:00			`Application Examples`
			`--------------------`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 19:08:36 +00:00
docs: update wifi application examples 2022-08-19 10:41:57 +00: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 18:44:57 +00: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 08:36:01 +00: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 16:18:25 +00:00
docs: add new top-level docs builder that builds docs for a single chip 2019-11-13 03:46:16 +00:00			`.. include-build-file:: inc/esp_wifi.inc`
			`.. include-build-file:: inc/esp_wifi_types.inc`