feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'feat/docs_esp_extconn_on_wifiless_chips' into 'master'

Browse Source 
Feat/docs esp extconn on wifiless chips

Closes IDF-7763 and IDF-11328

See merge request espressif/esp-idf!32456
This commit is contained in:
Mu Hai Dong
2024-12-09 11:40:40 +08:00
parent cb3ac7429c d5d1bcb9f0
commit d30af2fbdc
3 changed files with 22 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs_not_updated/esp32p4.txt
View File

@@ -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

22
docs/en/api-guides/wifi-expansion.rst
View File

@@ -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 <https://components.espressif.com/components/espressif/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 <https://components.espressif.com/components/espressif/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 <https://components.espressif.com/components/espressif/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 <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.
.. 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 <https://components.espressif.com/components/espressif/esp-extconn>`_ component using:
.. code:: bash
idf.py add-dependency esp-extconn
Please follow the instructions described in the `esp-extconn documentation <https://github.com/espressif/esp-extconn/blob/master/README.md>`_.
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.

2
docs/en/libraries-and-frameworks/libs-frameworks.rst
View File

@@ -98,6 +98,8 @@ ESP-Protocols components:
* `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-extconn <https://components.espressif.com/component/espressif/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
-------