This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit 24ce51f137702cdcd04a91dab8bbf9df10f35191
Author: Tiago Medicci Serrano <tiago.medi...@espressif.com>
AuthorDate: Thu Apr 27 18:04:49 2023 -0300
documentation/esp32_esp32s3: update informations about Wi-Fi
Add links for `wapi` referencing and links through documentation
pages that indicate Wi-Fi behavior on ESP32 and ESP32-S3.
---
.../platforms/xtensa/esp32/boards/esp32-audio-kit/index.rst | 5 ++++-
.../platforms/xtensa/esp32/boards/esp32-devkitc/index.rst | 11 +++++++++--
.../xtensa/esp32/boards/esp32-ethernet-kit/index.rst | 5 ++++-
.../platforms/xtensa/esp32/boards/esp32-lyrat/index.rst | 5 ++++-
.../xtensa/esp32/boards/esp32-wrover-kit/index.rst | 5 ++++-
Documentation/platforms/xtensa/esp32/index.rst | 13 +++++++++++++
.../xtensa/esp32s3/boards/esp32s3-devkit/index.rst | 7 +++++++
Documentation/platforms/xtensa/esp32s3/index.rst | 7 +++++++
8 files changed, 52 insertions(+), 6 deletions(-)
diff --git
a/Documentation/platforms/xtensa/esp32/boards/esp32-audio-kit/index.rst
b/Documentation/platforms/xtensa/esp32/boards/esp32-audio-kit/index.rst
index e352fb1f47..1e486dbef4 100644
--- 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
index 45c5a017af..13cb2c4b13 100644
--- 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
index efdb2a3779..da8cd3dada 100644
--- 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
\ No newline at end of file
+ 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
index 4cbd1f9d29..799619df47 100644
--- 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
index 1b8253c587..dcd731416a 100644
--- 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
\ No newline at end of file
+ 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
index 362ae750b6..3789f98307 100644
--- 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
index 060d5d03fb..d20a113aff 100644
--- 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
index fc53d34d10..d1db3e79f0 100644
--- 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
