From 2a0a080c9f13b0f40d6b6d3d32287783e3578689 Mon Sep 17 00:00:00 2001 From: xuxiao Date: Thu, 31 Aug 2023 11:31:07 +0800 Subject: [PATCH] feat(doc): update wifi sections for H2 --- docs/conf_common.py | 7 ++++++- docs/docs_not_updated/esp32h2.txt | 8 -------- docs/en/api-guides/partition-tables.rst | 6 +++++- docs/en/api-reference/network/index.rst | 24 ++++++++++++---------- docs/zh_CN/api-guides/partition-tables.rst | 6 +++++- docs/zh_CN/api-reference/network/index.rst | 24 ++++++++++++---------- 6 files changed, 42 insertions(+), 33 deletions(-) diff --git a/docs/conf_common.py b/docs/conf_common.py index e83e425b27..77e65071e3 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -60,7 +60,12 @@ BLUFI_DOCS = ['api-guides/blufi.rst', WIFI_DOCS = ['api-guides/wifi.rst', 'api-guides/wifi-security.rst', - 'api-guides/wireshark-user-guide.rst'] + 'api-guides/wireshark-user-guide.rst', + 'api-reference/network/esp_nan.rst', + 'api-reference/network/esp_now.rst', + 'api-reference/network/esp_smartconfig.rst', + 'api-reference/network/esp_wifi.rst', + 'api-reference/network/esp_dpp.rst'] WIFI_MESH_DOCS = ['api-guides/esp-wifi-mesh.rst', 'api-reference/network/esp-wifi-mesh.rst'] diff --git a/docs/docs_not_updated/esp32h2.txt b/docs/docs_not_updated/esp32h2.txt index 0932d8a4e1..a0fd1f872f 100644 --- a/docs/docs_not_updated/esp32h2.txt +++ b/docs/docs_not_updated/esp32h2.txt @@ -1,10 +1,7 @@ api-guides/RF_calibration api-guides/coexist -api-guides/wifi -api-guides/esp-wifi-mesh api-guides/cplusplus api-guides/dfu -api-guides/wifi-security api-guides/index api-reference/peripherals/i2s api-reference/peripherals/spi_features @@ -14,11 +11,6 @@ api-reference/peripherals/dedic_gpio api-reference/peripherals/sd_pullup_requirements api-reference/peripherals/index api-reference/peripherals/sdmmc_host -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/system/sleep_modes api-reference/system/power_management diff --git a/docs/en/api-guides/partition-tables.rst b/docs/en/api-guides/partition-tables.rst index 1fc14b04a9..16e8db91bb 100644 --- a/docs/en/api-guides/partition-tables.rst +++ b/docs/en/api-guides/partition-tables.rst @@ -114,7 +114,11 @@ See enum :cpp:type:`esp_partition_subtype_t` for the full list of subtypes defin - ``nvs`` (2) is for the :doc:`Non-Volatile Storage (NVS) API <../api-reference/storage/nvs_flash>`. - NVS is used to store per-device PHY calibration data (different to initialisation data). - - NVS is used to store WiFi data if the :doc:`esp_wifi_set_storage(WIFI_STORAGE_FLASH) <../api-reference/network/esp_wifi>` initialisation function is used. + + .. only:: SOC_WIFI_SUPPORTED + + - NVS is used to store Wi-Fi data if the :doc:`esp_wifi_set_storage(WIFI_STORAGE_FLASH) <../api-reference/network/esp_wifi>` initialization function is used. + - The NVS API can also be used for other application data. - It is strongly recommended that you include an NVS partition of at least 0x3000 bytes in your project. - If using NVS API to store a lot of data, increase the NVS partition size from the default 0x6000 bytes. diff --git a/docs/en/api-reference/network/index.rst b/docs/en/api-reference/network/index.rst index da467c760f..04c49068ae 100644 --- a/docs/en/api-reference/network/index.rst +++ b/docs/en/api-reference/network/index.rst @@ -3,20 +3,22 @@ Networking APIs :link_to_translation:`zh_CN:[中文]` -Wi-Fi -===== +.. only:: SOC_WIFI_SUPPORTED -.. toctree:: - :maxdepth: 1 + Wi-Fi + ===== - esp_now - :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh - esp_smartconfig - esp_wifi - esp_dpp - esp_nan + .. toctree:: + :maxdepth: 1 -Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples. + esp_now + :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh + esp_smartconfig + esp_wifi + esp_dpp + esp_nan + + Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples. .. only:: SOC_WIFI_MESH_SUPPORT diff --git a/docs/zh_CN/api-guides/partition-tables.rst b/docs/zh_CN/api-guides/partition-tables.rst index b828789189..b8f97f664d 100644 --- a/docs/zh_CN/api-guides/partition-tables.rst +++ b/docs/zh_CN/api-guides/partition-tables.rst @@ -114,7 +114,11 @@ SubType 字段长度为 8 bit，内容与具体分区 Type 有关。目前，esp - ``nvs`` (2) 是专门给 :doc:`非易失性存储 (NVS) API <../api-reference/storage/nvs_flash>` 使用的分区。 - 用于存储每台设备的 PHY 校准数据（注意，并不是 PHY 初始化数据）。 - - 用于存储 Wi-Fi 数据（如果使用了 :doc:`esp_wifi_set_storage(WIFI_STORAGE_FLASH) <../api-reference/network/esp_wifi>` 初始化函数）。 + + .. only:: SOC_WIFI_SUPPORTED + + - 用于存储 Wi-Fi 数据（如果使用了 :doc:`esp_wifi_set_storage(WIFI_STORAGE_FLASH) <../api-reference/network/esp_wifi>` 初始化函数）。 + - NVS API 还可以用于其他应用程序数据。 - 强烈建议您应为 NVS 分区分配至少 0x3000 字节空间。 - 如果使用 NVS API 存储大量数据，请增加 NVS 分区的大小（默认是 0x6000 字节）。 diff --git a/docs/zh_CN/api-reference/network/index.rst b/docs/zh_CN/api-reference/network/index.rst index 6c33e14f74..224b6573b3 100644 --- a/docs/zh_CN/api-reference/network/index.rst +++ b/docs/zh_CN/api-reference/network/index.rst @@ -3,20 +3,22 @@ :link_to_translation:`en:[English]` -Wi-Fi -===== +.. only:: SOC_WIFI_SUPPORTED -.. toctree:: - :maxdepth: 1 + Wi-Fi + ===== - esp_now - :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh - esp_smartconfig - esp_wifi - esp_dpp - esp_nan + .. toctree:: + :maxdepth: 1 -本部分的 Wi-Fi API 示例代码存放在 ESP-IDF 示例项目的 :example:`wifi` 目录下。 + esp_now + :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh + esp_smartconfig + esp_wifi + esp_dpp + esp_nan + + 本部分的 Wi-Fi API 示例代码存放在 ESP-IDF 示例项目的 :example:`wifi` 目录下。 .. only:: SOC_WIFI_MESH_SUPPORT