feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Docs/esp_netif: Make WiFi AP docs available only if enabled

Browse Source 
Prepare support for ESP8684
This commit is contained in:
David Cermak
2021-12-15 10:22:56 +01:00
committed by David Čermák
parent c04803e88b
commit 264d00fc64
1 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/en/api-reference/network/esp_netif.rst
View File

@@ -227,26 +227,38 @@ ESP-NETIF programmer's manual
Please refer to the example section for basic initialization of default interfaces:
- WiFi Station: :example_file:`wifi/getting_started/station/main/station_example_main.c`
- WiFi Access Point: :example_file:`wifi/getting_started/softAP/main/softap_example_main.c`
- Ethernet: :example_file:`ethernet/basic/main/ethernet_example_main.c`
.. only:: CONFIG_ESP_WIFI_SOFTAP_SUPPORT
- WiFi Access Point: :example_file:`wifi/getting_started/softAP/main/softap_example_main.c`
For more specific cases please consult this guide: :doc:`/api-reference/network/esp_netif_driver`.
WiFi default initialization
^^^^^^^^^^^^^^^^^^^^^^^^^^^
The initialization code as well as registering event handlers for default interfaces, such as softAP and station, are provided in two separate APIs to facilitate simple startup code for most applications:
The initialization code as well as registering event handlers for default interfaces, such as softAP and station, are provided in separate APIs to facilitate simple startup code for most applications:
* :cpp:func:`esp_netif_create_default_wifi_ap()`
* :cpp:func:`esp_netif_create_default_wifi_sta()`
.. only:: CONFIG_ESP_WIFI_SOFTAP_SUPPORT
* :cpp:func:`esp_netif_create_default_wifi_ap()`
Please note that these functions return the ``esp_netif`` handle, i.e. a pointer to a network interface object allocated and configured with default settings, which as a consequence, means that:
* The created object has to be destroyed if a network de-initialization is provided by an application using :cpp:func:`esp_netif_destroy_default_wifi()`.
* These *default* interfaces must not be created multiple times, unless the created handle is deleted using :cpp:func:`esp_netif_destroy()`.
* When using Wifi in ``AP+STA`` mode, both these interfaces has to be created.
.. only:: CONFIG_ESP_WIFI_SOFTAP_SUPPORT
* When using Wifi in ``AP+STA`` mode, both these interfaces has to be created.
API Reference