Merge branch 'feat/docs_wifi_on_wifiless_chips' into 'master'

feat(wifi): Document WiFi expansion on wifi-less chips See merge request espressif/esp-idf!31418
espressif · Sep 30, 2024 · af017d1 · af017d1
2 parents ed5f75a + 5af6124
commit af017d1
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 0 deletions.
diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst
@@ -47,4 +47,5 @@ API Guides
    :SOC_USB_SERIAL_JTAG_SUPPORTED: usb-serial-jtag-console
    :SOC_WIFI_SUPPORTED: wifi
    :SOC_WIFI_SUPPORTED: wifi-security
+   wifi-expansion
    :SOC_WIFI_SUPPORTED or SOC_BT_SUPPORTED or SOC_IEEE802154_SUPPORTED: phy
diff --git a/docs/en/api-guides/wifi-expansion.rst b/docs/en/api-guides/wifi-expansion.rst
@@ -0,0 +1,27 @@
+Wi-Fi Expansion
+===============
+
+:link_to_translation:`zh_CN:[中文]`
+
+.. only:: not SOC_WIFI_SUPPORTED
+
+  {IDF_TARGET_NAME} does not support Wi-Fi functionality natively, but it is possible to use the same Wi-Fi API and features using 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 <https://components.espressif.com/components/espressif/esp_wifi_remote>`_ component.
+
+
+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 <https://components.espressif.com/components/espressif/esp_wifi_remote>`_ component using:
+
+.. code:: bash
+
+  idf.py add-dependency esp_wifi_remote
+
+
+Please follow the instructions described in the `esp_wifi_remote documentation <https://github.com/espressif/esp-protocols/blob/master/components/esp_wifi_remote/README.md>`_.
+
+
+.. 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.
diff --git a/docs/en/libraries-and-frameworks/libs-frameworks.rst b/docs/en/libraries-and-frameworks/libs-frameworks.rst
@@ -96,6 +96,8 @@ ESP-Protocols components:
 
 * `asio <https://components.espressif.com/component/espressif/asio>`_ is a cross-platform C++ library, see https://think-async.com/Asio/. It provides a consistent asynchronous model using a modern C++ approach. See the `asio documentation <https://docs.espressif.com/projects/esp-protocols/asio/docs/latest/index.html>`_.
 
+* `esp_wifi_remote <https://components.espressif.com/component/espressif/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-BSP
 -------
 

diff --git a/docs/zh_CN/api-guides/index.rst b/docs/zh_CN/api-guides/index.rst
@@ -47,4 +47,5 @@ API 指南
    :SOC_USB_SERIAL_JTAG_SUPPORTED: usb-serial-jtag-console
    :SOC_WIFI_SUPPORTED: wifi
    :SOC_WIFI_SUPPORTED: wifi-security
+   wifi-expansion
    :SOC_WIFI_SUPPORTED or SOC_BT_SUPPORTED or SOC_IEEE802154_SUPPORTED: phy
diff --git a/docs/zh_CN/api-guides/wifi-expansion.rst b/docs/zh_CN/api-guides/wifi-expansion.rst
@@ -0,0 +1 @@
+.. include:: ../../en/api-guides/wifi-expansion.rst
-Original file line number
+Diff line change
@@ Expand Up / @@ -96,6 +96,8 @@ ESP-Protocols components: @@
     * `asio <https://components.espressif.com/component/espressif/asio>`_ is a cross-platform C++ library, see https://think-async.com/Asio/. It provides a consistent asynchronous model using a modern C++ approach. See the `asio documentation <https://docs.espressif.com/projects/esp-protocols/asio/docs/latest/index.html>`_.
+    * `esp_wifi_remote <https://components.espressif.com/component/espressif/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-BSP
     -------
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		.. include:: ../../en/api-guides/wifi-expansion.rst