documentation/esp32_esp32s3: update informations about Wi-Fi

tmedicci · xiaoxiang781216 · commit 24ce51f13770 · 2023-05-03T23:23:31.000+08:00
Add links for `wapi` referencing and links through documentation
pages that indicate Wi-Fi behavior on ESP32 and ESP32-S3.
diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-audio-kit/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-audio-kit/index.rst
@@ -115,7 +115,7 @@ browser:
 
 After successfully built and flashed, connect the board to the Wi-Fi network::
 
-  $ nsh> wapi psk wlan0 mypasswd 1
+  $ nsh> wapi psk wlan0 mypasswd 3
   $ nsh> wapi essid wlan0 myssid 1
   $ nsh> renew wlan0
 
@@ -153,3 +153,6 @@ at runtime::
     nsh> wapi psk wlan0 mypasswd 3
     nsh> wapi essid wlan0 myssid 1
     nsh> renew wlan0
+
+.. tip:: Please refer to :ref:`ESP32 Wi-Fi Station Mode <esp32_wi-fi_sta>`
+  for more information.
diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-devkitc/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-devkitc/index.rst
@@ -203,7 +203,7 @@ browser:
 
 After successfully built and flashed, connect the board to the Wi-Fi network::
 
-    nsh> wapi psk wlan0 mypasswd 1
+    nsh> wapi psk wlan0 mypasswd 3
     nsh> wapi essid wlan0 myssid 1
     nsh> renew wlan0
 
@@ -524,7 +524,7 @@ From the host, start the broker and subscribe to the :code:`test` topic.  Using
 
 From the NSH, connect to an access point::
 
-    nsh> wapi psk wlan0 mypasswd 1
+    nsh> wapi psk wlan0 mypasswd 3
     nsh> wapi essid wlan0 myssid 1
     nsh> renew wlan0
 
@@ -757,6 +757,10 @@ to connect your smartphone or laptop to your board::
 In this case, you are creating the access point ``nuttxapp`` in your board and to
 connect to it on your smartphone you will be required to type the password ``mypasswd``
 using WPA2.
+
+.. tip:: Please refer to :ref:`ESP32 Wi-Fi SoftAP Mode <esp32_wi-fi_softap>`
+  for more information.
+
 The ``dhcpd_start`` is necessary to let your board to associate an IP to your smartphone.
 
 tickless
@@ -833,6 +837,9 @@ at runtime::
     nsh> wapi essid wlan0 myssid 1
     nsh> renew wlan0
 
+.. tip:: Please refer to :ref:`ESP32 Wi-Fi Station Mode <esp32_wi-fi_sta>`
+  for more information.
+
 wifi_smp
 --------
 
diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-ethernet-kit/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-ethernet-kit/index.rst
@@ -317,4 +317,7 @@ at runtime::
 
     nsh> wapi psk wlan0 mypasswd 3
     nsh> wapi essid wlan0 myssid 1
-    nsh> renew wlan0
+    nsh> renew wlan0
+
+.. tip:: Please refer to :ref:`ESP32 Wi-Fi Station Mode <esp32_wi-fi_sta>`
+  for more information.
diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-lyrat/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-lyrat/index.rst
@@ -426,7 +426,7 @@ browser:
 
 After successfully built and flashed, connect the board to the Wi-Fi network::
 
-  $ nsh> wapi psk wlan0 mypasswd 1
+  $ nsh> wapi psk wlan0 mypasswd 3
   $ nsh> wapi essid wlan0 myssid 1
   $ nsh> renew wlan0
 
@@ -590,3 +590,6 @@ at runtime::
     nsh> wapi psk wlan0 mypasswd 3
     nsh> wapi essid wlan0 myssid 1
     nsh> renew wlan0
+
+.. tip:: Please refer to :ref:`ESP32 Wi-Fi Station Mode <esp32_wi-fi_sta>`
+  for more information.
diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-wrover-kit/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-wrover-kit/index.rst
@@ -273,4 +273,7 @@ at runtime::
 
     nsh> wapi psk wlan0 mypasswd 3
     nsh> wapi essid wlan0 myssid 1
-    nsh> renew wlan0
+    nsh> renew wlan0
+
+.. tip:: Please refer to :ref:`ESP32 Wi-Fi Station Mode <esp32_wi-fi_sta>`
+  for more information.
diff --git a/Documentation/platforms/xtensa/esp32/index.rst b/Documentation/platforms/xtensa/esp32/index.rst
@@ -290,6 +290,15 @@ the result by running ``ifconfig`` afterwards.
 
 .. tip:: Boards usually expose a ``wifi`` defconfig which enables Wi-Fi
 
+.. tip:: Please check :doc:`wapi </applications/wapi/index>` documentation for more
+   information about its commands and arguments.
+
+.. note:: The ``wapi psk`` command on Station mode sets a security threshold. That
+   is, it enables connecting only to an equally or more secure network than the set
+   threshold. ``wapi psk wlan0 mypasswd 3`` sets a WPA2-PSK-secured network and
+   enables the device to connect to networks that are equally or more secure than
+   that (WPA3-SAE, for instance, would be eligible for connecting to).
+
 .. _esp32_wi-fi_softap:
 
 Wi-Fi SoftAP
@@ -309,6 +318,10 @@ to connect your smartphone or laptop to your board::
 In this case, you are creating the access point ``nuttxapp`` in your board and to
 connect to it on your smartphone you will be required to type the password ``mypasswd``
 using WPA2.
+
+.. tip:: Please check :doc:`wapi </applications/wapi/index>` documentation for more
+   information about its commands and arguments.
+
 The ``dhcpd_start`` is necessary to let your board to associate an IP to your smartphone.
 
 Bluetooth
diff --git a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-devkit/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-devkit/index.rst
@@ -233,6 +233,10 @@ to connect your smartphone or laptop to your board::
 In this case, you are creating the access point ``nuttxapp`` in your board and to
 connect to it on your smartphone you will be required to type the password ``mypasswd``
 using WPA2.
+
+.. tip:: Please refer to :ref:`ESP32 Wi-Fi SoftAP Mode <esp32_wi-fi_softap>`
+  for more information.
+
 The ``dhcpd_start`` is necessary to let your board to associate an IP to your smartphone.
 
 tickless
@@ -271,6 +275,9 @@ at runtime::
     nsh> wapi essid wlan0 myssid 1
     nsh> renew wlan0
 
+.. tip:: Please refer to :ref:`ESP32 Wi-Fi Station Mode <esp32_wi-fi_sta>`
+  for more information.
+
 watchdog
 --------
 
diff --git a/Documentation/platforms/xtensa/esp32s3/index.rst b/Documentation/platforms/xtensa/esp32s3/index.rst
@@ -140,6 +140,9 @@ In this case a connection to AP with SSID ``myssid`` is done, using ``mypasswd``
 password. IP address is obtained via DHCP using ``renew`` command. You can check
 the result by running ``ifconfig`` afterwards.
 
+.. tip:: Please refer to :ref:`ESP32 Wi-Fi Station Mode <esp32_wi-fi_sta>`
+  for more information.
+
 Wi-Fi SoftAP
 ------------
 
@@ -159,6 +162,10 @@ to connect your smartphone or laptop to your board::
 In this case, you are creating the access point ``nuttxapp`` in your board and to
 connect to it on your smartphone you will be required to type the password ``mypasswd``
 using WPA2.
+
+.. tip:: Please refer to :ref:`ESP32 Wi-Fi SoftAP Mode <esp32_wi-fi_softap>`
+  for more information.
+
 The ``dhcpd_start`` is necessary to let your board to associate an IP to your smartphone.
 
 Memory Map
