diff --git a/docs/docs_not_updated/esp32h2.txt b/docs/docs_not_updated/esp32h2.txt index 841d05ac1e..53a42d03bd 100644 --- a/docs/docs_not_updated/esp32h2.txt +++ b/docs/docs_not_updated/esp32h2.txt @@ -55,15 +55,12 @@ api-reference/peripherals/sd_pullup_requirements api-reference/peripherals/index api-reference/peripherals/sdmmc_host api-reference/network/esp_openthread -api-reference/network/esp_eth -api-reference/network/esp_netif_driver api-reference/network/esp_dpp api-reference/network/esp_now api-reference/network/esp-wifi-mesh api-reference/network/esp_smartconfig api-reference/network/esp_wifi api-reference/network/index -api-reference/network/esp_netif api-reference/system/sleep_modes api-reference/system/efuse api-reference/system/chip_revision @@ -101,9 +98,7 @@ api-reference/bluetooth/esp-ble-mesh api-reference/bluetooth/index api-reference/bluetooth/esp_gap_ble api-reference/bluetooth/classic_bt -api-reference/protocols/icmp_echo api-reference/protocols/esp_serial_slave_link -api-reference/protocols/mqtt api-reference/protocols/mbedtls api-reference/protocols/esp_http_server api-reference/protocols/esp_sdio_slave_protocol @@ -114,9 +109,7 @@ api-reference/protocols/esp_https_server api-reference/protocols/esp_spi_slave_protocol api-reference/protocols/modbus api-reference/protocols/esp_tls -api-reference/protocols/mdns api-reference/protocols/index -api-reference/protocols/asio about resources migration-guides/release-5.x/5.1/index diff --git a/docs/en/api-reference/network/esp_netif.rst b/docs/en/api-reference/network/esp_netif.rst index f0a3aef403..4158166958 100644 --- a/docs/en/api-reference/network/esp_netif.rst +++ b/docs/en/api-reference/network/esp_netif.rst @@ -324,7 +324,9 @@ 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` +.. only:: SOC_WIFI_SUPPORTED + + - WiFi Station: :example_file:`wifi/getting_started/station/main/station_example_main.c` - Ethernet: :example_file:`ethernet/basic/main/ethernet_example_main.c` @@ -337,26 +339,28 @@ Please refer to the example section for basic initialization of default interfac For more specific cases please consult this guide: :doc:`/api-reference/network/esp_netif_driver`. -WiFi default initialization -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. only:: SOC_WIFI_SUPPORTED -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: + WiFi default initialization + ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* :cpp:func:`esp_netif_create_default_wifi_sta()` + 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: -.. only:: CONFIG_ESP_WIFI_SOFTAP_SUPPORT + * :cpp:func:`esp_netif_create_default_wifi_sta()` - * :cpp:func:`esp_netif_create_default_wifi_ap()` + .. only:: CONFIG_ESP_WIFI_SOFTAP_SUPPORT -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: + * :cpp:func:`esp_netif_create_default_wifi_ap()` -* 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()`. + 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: -* These *default* interfaces must not be created multiple times, unless the created handle is deleted using :cpp:func:`esp_netif_destroy()`. + * 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()`. -.. only:: CONFIG_ESP_WIFI_SOFTAP_SUPPORT + * 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 @@ -369,7 +373,9 @@ API Reference .. include-build-file:: inc/esp_vfs_l2tap.inc -WiFi default API reference -^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. only:: SOC_WIFI_SUPPORTED -.. include-build-file:: inc/esp_wifi_default.inc + WiFi default API reference + ^^^^^^^^^^^^^^^^^^^^^^^^^^ + + .. include-build-file:: inc/esp_wifi_default.inc