espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-04 21:24:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'update/docs_h2_network_proto' into 'master'

Browse Source 
docs: Update Network & Protocols sections for H2

See merge request espressif/esp-idf!22866
This commit is contained in:
David Čermák
2023-03-29 16:19:41 +08:00
parent e86864c621 d864c6df5a
commit 6643bc9704
2 changed files with 21 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/docs_not_updated/esp32h2.txt
View File

@@ -55,15 +55,12 @@ api-reference/peripherals/sd_pullup_requirements
api-reference/peripherals/index api-reference/peripherals/index
api-reference/peripherals/sdmmc_host api-reference/peripherals/sdmmc_host
api-reference/network/esp_openthread 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_dpp
api-reference/network/esp_now api-reference/network/esp_now
api-reference/network/esp-wifi-mesh api-reference/network/esp-wifi-mesh
api-reference/network/esp_smartconfig api-reference/network/esp_smartconfig
api-reference/network/esp_wifi api-reference/network/esp_wifi
api-reference/network/index api-reference/network/index
api-reference/network/esp_netif
api-reference/system/sleep_modes api-reference/system/sleep_modes
api-reference/system/efuse api-reference/system/efuse
api-reference/system/chip_revision api-reference/system/chip_revision
@@ -101,9 +98,7 @@ api-reference/bluetooth/esp-ble-mesh
api-reference/bluetooth/index api-reference/bluetooth/index
api-reference/bluetooth/esp_gap_ble api-reference/bluetooth/esp_gap_ble
api-reference/bluetooth/classic_bt api-reference/bluetooth/classic_bt
api-reference/protocols/icmp_echo
api-reference/protocols/esp_serial_slave_link api-reference/protocols/esp_serial_slave_link
api-reference/protocols/mqtt
api-reference/protocols/mbedtls api-reference/protocols/mbedtls
api-reference/protocols/esp_http_server api-reference/protocols/esp_http_server
api-reference/protocols/esp_sdio_slave_protocol 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/esp_spi_slave_protocol
api-reference/protocols/modbus api-reference/protocols/modbus
api-reference/protocols/esp_tls api-reference/protocols/esp_tls
api-reference/protocols/mdns
api-reference/protocols/index api-reference/protocols/index
api-reference/protocols/asio
about about
resources resources
migration-guides/release-5.x/5.1/index migration-guides/release-5.x/5.1/index

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

@@ -324,7 +324,9 @@ ESP-NETIF programmer's manual
Please refer to the example section for basic initialization of default interfaces: 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` - Ethernet: :example_file:`ethernet/basic/main/ethernet_example_main.c`
@@ -337,24 +339,26 @@ 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`. 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()`
.. only:: CONFIG_ESP_WIFI_SOFTAP_SUPPORT
* :cpp:func:`esp_netif_create_default_wifi_ap()` * :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: 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()`. * 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()`. * These *default* interfaces must not be created multiple times, unless the created handle is deleted using :cpp:func:`esp_netif_destroy()`.
.. only:: CONFIG_ESP_WIFI_SOFTAP_SUPPORT .. only:: CONFIG_ESP_WIFI_SOFTAP_SUPPORT
* When using Wifi in ``AP+STA`` mode, both these interfaces has to be created. * When using Wifi in ``AP+STA`` mode, both these interfaces has to be created.
@@ -369,7 +373,9 @@ API Reference
.. include-build-file:: inc/esp_vfs_l2tap.inc .. 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