From 37a7528af4b78961a124fb073415b2d14a1180c1 Mon Sep 17 00:00:00 2001 From: muhaidong Date: Tue, 8 Oct 2024 15:58:50 +0800 Subject: [PATCH 1/2] feat(wifi): Add exp-extconn to document WiFi expansion on wifi-less chips --- docs/en/api-guides/wifi-expansion.rst | 22 +++++++++++++++++-- .../libs-frameworks.rst | 2 ++ 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/docs/en/api-guides/wifi-expansion.rst b/docs/en/api-guides/wifi-expansion.rst index 8c11b7704ba..164a7270507 100644 --- a/docs/en/api-guides/wifi-expansion.rst +++ b/docs/en/api-guides/wifi-expansion.rst @@ -9,9 +9,12 @@ Wi-Fi Expansion .. only:: SOC_WIFI_SUPPORTED - {IDF_TARGET_NAME} does support Wi-Fi functionality natively, please refer to :doc:`wifi` documentation. Even though Wi-Fi is supported on {IDF_TARGET_NAME}, it is possible to expand it and use another instance of Wi-Fi expansion interfaces using esp_wifi_remote `_ component. + {IDF_TARGET_NAME} does support Wi-Fi functionality natively, please refer to :doc:`wifi` documentation. Even though Wi-Fi is supported on {IDF_TARGET_NAME}, it is possible to expand it and use another instance of Wi-Fi expansion interfaces using `esp_wifi_remote `_ component. +{IDF_TARGET_NAME} esp_wifi_remote +--------------------------------- + The principle of Wi-Fi Expansion operation is to add another ESP32 series, Wi-Fi capable, target connected to the {IDF_TARGET_NAME} in a pre-defined way. Your project could then include the `esp_wifi_remote `_ component using: .. code:: bash @@ -21,7 +24,22 @@ The principle of Wi-Fi Expansion operation is to add another ESP32 series, Wi-Fi Please follow the instructions described in the `esp_wifi_remote documentation `_. - .. only:: not SOC_WIFI_SUPPORTED To explore the Wi-Fi Expansion functionality on {IDF_TARGET_NAME}, you can get started with this example: :idf_file:`examples/protocols/mqtt/tcp/README.md` and choose Wi-Fi connection in the project configuration menu. + +.. only:: SOC_WIRELESS_HOST_SUPPORTED + + {IDF_TARGET_NAME} esp-extconn + ----------------------------------------- + + The principle of esp-extconn operation is to add another supported target series connected to the {IDF_TARGET_NAME} in a pre-defined way. Compared to the esp_wifi_remote approach, the target side can operate without flash, as the firmware is delivered by the hosted side. Your project could then include the `esp-extconn `_ component using: + + .. code:: bash + + idf.py add-dependency esp-extconn + + + Please follow the instructions described in the `esp-extconn documentation `_. + + To explore the esp-extconn functionality on {IDF_TARGET_NAME}, you can get started with this example: :idf_file:`examples/wifi/iperf/README.md` and choose Wi-Fi connection in the project configuration menu. diff --git a/docs/en/libraries-and-frameworks/libs-frameworks.rst b/docs/en/libraries-and-frameworks/libs-frameworks.rst index 5c18c5b1364..5da641982e9 100644 --- a/docs/en/libraries-and-frameworks/libs-frameworks.rst +++ b/docs/en/libraries-and-frameworks/libs-frameworks.rst @@ -98,6 +98,8 @@ ESP-Protocols components: * `esp_wifi_remote `_ is a Wi-Fi communication library that provides standard Wi-Fi API and networking of an external, Wi-Fi capable ESP32 chipset connected to the target device via a specified transport interface. See the :doc:`../api-guides/wifi-expansion`. +* `esp-extconn `_ is a Wi-Fi communication library that provides external wireless connectivity(Wi-Fi & Bluetooth) for ESP chips that do not have built-in wireless capabilities. See the :doc:`../api-guides/wifi-expansion`. + ESP-BSP ------- From d5d1bcb9f009b51234a031dbc879fd61602bc17c Mon Sep 17 00:00:00 2001 From: muhaidong Date: Tue, 8 Oct 2024 15:58:02 +0800 Subject: [PATCH 2/2] fix(docs): remove wifi related docs from docs_not_updated for esp32p4 --- docs/docs_not_updated/esp32p4.txt | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/docs/docs_not_updated/esp32p4.txt b/docs/docs_not_updated/esp32p4.txt index fff012c1189..dc5c69dde7a 100644 --- a/docs/docs_not_updated/esp32p4.txt +++ b/docs/docs_not_updated/esp32p4.txt @@ -1,18 +1,6 @@ api-guides/partition-tables.rst -api-guides/RF_calibration.rst -api-guides/coexist.rst -api-guides/wifi.rst api-guides/usb-otg-console.rst -api-guides/esp-wifi-mesh.rst api-guides/dfu.rst -api-guides/wifi-security.rst api-reference/peripherals/adc_calibration.rst api-reference/peripherals/parlio.rst api-reference/peripherals/sd_pullup_requirements.rst -api-reference/network/esp_dpp.rst -api-reference/network/esp_now.rst -api-reference/network/esp-wifi-mesh.rst -api-reference/network/esp_smartconfig.rst -api-reference/network/esp_nan.rst -api-reference/network/esp_wifi.rst -api-reference/network/index.rst