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

Wi-Fi
=====

:link_to_translation:`zh_CN:[中文]`

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

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

- Station mode (aka STA mode or WiFi 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}.
- Combined AP-STA 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 WiFi packets.


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

The :example:`wifi` directory of ESP-IDF examples contains the following applications:

Code examples for Wi-Fi are provided in the :example:`wifi` directory of ESP-IDF examples.

In addition, there is a simple `esp-idf-template <https://github.com/espressif/esp-idf-template>`_ application to demonstrate a minimal IDF project structure.


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
-												doc: Update English pages with generic target name

											
										
										
											2019-12-09 03:01:09 +00:00
+								The WiFi libraries provide support for configuring and monitoring the {IDF_TARGET_NAME} WiFi 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
-												doc: Update English pages with generic target name

											
										
										
											2019-12-09 03:01:09 +00:00
+								- Station mode (aka STA mode or WiFi 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}.
 								- Combined AP-STA 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).
-												Doc/review api reference indexes

											
										
										
											2019-04-29 02:53:42 +00:00
+								- Promiscuous mode for monitoring of IEEE802.11 WiFi packets.
-												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
-												Doc/review api reference indexes

											
										
										
											2019-04-29 02:53:42 +00:00
+								The :example:`wifi` directory of ESP-IDF examples contains the following applications:
-												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
-												Doc/review api reference indexes

											
										
										
											2019-04-29 02:53:42 +00:00
+								Code examples for Wi-Fi are provided in the :example:`wifi` directory of ESP-IDF examples.
-												Initial list of Wi-Fi  API

											
										
										
											2016-10-24 18:44:57 +00:00
-												docs: update wifi documentation per recent update of esp-idf-template project to use a plain hello-world application

											
										
										
											2019-11-18 21:13:07 +00:00
+								In addition, there is a simple `esp-idf-template <https://github.com/espressif/esp-idf-template>`_ application to demonstrate a minimal IDF project structure.
-												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
-												docs: Add esp_wifi_types.h items to wifi API reference

Previously only items defined esp_wifi.h in esp_wifi_crypto_types.h
were including in documentation reference.

											
										
										
											2017-09-26 07:02:52 +00:00
-												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