docs(esp8266): Modify for ESP8266 platform

This commit is contained in:
Dong Heng
2018-11-13 14:48:21 +08:00
parent 0a0290c5ef
commit 3cc752b654
35 changed files with 343 additions and 626 deletions

View File

@ -4,11 +4,11 @@ Wi-Fi
Introduction
------------
The WiFi libraries provide support for configuring and monitoring the ESP32 WiFi networking functionality. This includes configuration for:
The WiFi libraries provide support for configuring and monitoring the ESP8266 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).
- Station mode (aka STA mode or WiFi client mode). ESP8266 connects to an access point.
- AP mode (aka Soft-AP mode or Access Point mode). Stations connect to the ESP8266.
- Combined AP-STA mode (ESP8266 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).
@ -17,11 +17,9 @@ The WiFi libraries provide support for configuring and monitoring the ESP32 WiFi
Application Examples
--------------------
See :example:`wifi` directory of ESP-IDF examples that contains the following applications:
See :example:`wifi` directory of ESP8266_RTOS_SDK 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`.
* Simple application showing how to connect ESP8266 module to an Access Point - `template <https://github.com/espressif/esp-idf-template>`_.
API Reference

View File

@ -6,7 +6,6 @@ Wi-Fi API
Wi-Fi <esp_wifi>
Smart Config <esp_smartconfig>
ESPNOW <esp_now>
Example code for this API section is provided in :example:`wifi` directory of ESP-IDF examples.
Example code for this API section is provided in :example:`wifi` directory of SDK examples.