Skip to content

Commit af017d1

Browse files
committed
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
2 parents ed5f75a + 5af6124 commit af017d1

File tree

5 files changed

+32
-0
lines changed

5 files changed

+32
-0
lines changed

docs/en/api-guides/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,5 @@ API Guides
4747
:SOC_USB_SERIAL_JTAG_SUPPORTED: usb-serial-jtag-console
4848
:SOC_WIFI_SUPPORTED: wifi
4949
:SOC_WIFI_SUPPORTED: wifi-security
50+
wifi-expansion
5051
:SOC_WIFI_SUPPORTED or SOC_BT_SUPPORTED or SOC_IEEE802154_SUPPORTED: phy
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Wi-Fi Expansion
2+
===============
3+
4+
:link_to_translation:`zh_CN:[中文]`
5+
6+
.. only:: not SOC_WIFI_SUPPORTED
7+
8+
{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.
9+
10+
.. only:: SOC_WIFI_SUPPORTED
11+
12+
{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.
13+
14+
15+
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:
16+
17+
.. code:: bash
18+
19+
idf.py add-dependency esp_wifi_remote
20+
21+
22+
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>`_.
23+
24+
25+
.. only:: not SOC_WIFI_SUPPORTED
26+
27+
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.

docs/en/libraries-and-frameworks/libs-frameworks.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@ ESP-Protocols components:
9696

9797
* `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>`_.
9898

99+
* `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`.
100+
99101
ESP-BSP
100102
-------
101103

docs/zh_CN/api-guides/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,5 @@ API 指南
4747
:SOC_USB_SERIAL_JTAG_SUPPORTED: usb-serial-jtag-console
4848
:SOC_WIFI_SUPPORTED: wifi
4949
:SOC_WIFI_SUPPORTED: wifi-security
50+
wifi-expansion
5051
:SOC_WIFI_SUPPORTED or SOC_BT_SUPPORTED or SOC_IEEE802154_SUPPORTED: phy
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../en/api-guides/wifi-expansion.rst

0 commit comments

Comments
 (0)