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

Wi-Fi
=====

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

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

- Station mode (aka STA mode or WiFi client mode). ESP32 connects to an access point.
- AP mode (aka Soft-AP mode or Access Point mode). Stations connect to the ESP32.
- Combined AP-STA mode (ESP32 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 monitoring of IEEE802.11 WiFi packets.

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

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

* Simple application showing how to connect ESP32 module to an Access Point - `esp-idf-template <https://github.com/espressif/esp-idf-template>`_.

* Using power save mode of Wi-Fi - :example:`wifi/power_save`.


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

.. include:: /_build/inc/esp_wifi.inc
.. include:: /_build/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
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
docs: Add introduction section for WiFi, replace boilerplate 2017-09-27 01:13:20 +00:00			`The WiFi libraries provide support for configuring and monitoring the ESP32 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
docs: Add introduction section for WiFi, replace boilerplate 2017-09-27 01:13:20 +00:00			`- Station mode (aka STA mode or WiFi client mode). ESP32 connects to an access point.`
			`- AP mode (aka Soft-AP mode or Access Point mode). Stations connect to the ESP32.`
			`- Combined AP-STA mode (ESP32 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 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
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			See :example:`wifi` directory of ESP-IDF examples that 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
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			* Simple application showing how to connect ESP32 module to an Access Point - `esp-idf-template <https://github.com/espressif/esp-idf-template>`_.
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			* Using power save mode of Wi-Fi - :example:`wifi/power_save`.
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: 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			`.. include:: /_build/inc/esp_wifi.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			`.. include:: /_build/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