espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2026-05-19 23:45:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update Network & Protocols sections for H2

Browse Source
This commit is contained in:
David Cermak
2023-03-21 19:20:23 +01:00
parent f1c03f0dda
commit d864c6df5a
2 changed files with 21 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/network/esp_netif.rst
+21 -15
View File
@@ -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