sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs/esp32s3: add documentation for Wi-Fi (STA + SoftAP)

Browse Source
This commit is contained in:
Tiago Medicci Serrano 2023-03-09 15:33:59 -03:00 committed by Petro Karashchenko
parent 0ca7ede228
commit af45eced2b
2 changed files with 45 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/platforms/xtensa/esp32s3/boards/esp32s3-devkit/index.rst
View File

@ -50,6 +50,9 @@ and USB activity. None of these are available for use by software.
Configurations Configurations
============== ==============
.. tip:: Please check commonly used configurations for
:ref:`ESP32-S3 Peripherals <esp32s3_peripheral_support>`
nsh nsh
--- ---
@ -57,7 +60,7 @@ Basic NuttShell configuration (console enabled in UART0, exposed via
USB connection by means of CP2102 converter, at 115200 bps). USB connection by means of CP2102 converter, at 115200 bps).
mcuboot_nsh mcuboot_nsh
--- -----------
Similar configuration as nsh, except that it enables booting from Similar configuration as nsh, except that it enables booting from
MCUboot and the experimental features configuration. MCUboot and the experimental features configuration.

43
Documentation/platforms/xtensa/esp32s3/index.rst
View File

@ -78,7 +78,7 @@ Once you downloaded both binaries, you can flash them by adding an ``ESPTOOL_BIN
.. note:: It is recommended that if this is the first time you are using the board with NuttX that you perform a complete SPI FLASH erase. .. note:: It is recommended that if this is the first time you are using the board with NuttX that you perform a complete SPI FLASH erase.
.. code-block:: console .. code-block:: console
$ esptool.py erase_flash $ esptool.py erase_flash
Peripheral Support Peripheral Support
@ -95,7 +95,7 @@ SPI Yes
I2C No I2C No
CAN/TWAI No CAN/TWAI No
DMA Yes DMA Yes
Wifi No Wi-Fi Yes WPA3-SAE supported
SPIFLASH Yes SPIFLASH Yes
SPIRAM Yes SPIRAM Yes
Timers Yes Timers Yes
@ -121,6 +121,45 @@ USB SERIAL Yes
USB OTG No USB OTG No
========== ======= ===== ========== ======= =====
.. _esp32s3_peripheral_support:
Wi-Fi
-----
.. tip:: Boards usually expose a ``wapi`` defconfig which enables Wi-Fi
A standard network interface will be configured and can be initialized such as::
nsh> ifup wlan0
nsh> wapi psk wlan0 mypasswd 3
nsh> wapi essid wlan0 myssid 1
nsh> renew wlan0
In this case a connection to AP with SSID ``myssid`` is done, using ``mypasswd`` as
password. IP address is obtained via DHCP using ``renew`` command. You can check
the result by running ``ifconfig`` afterwards.
Wi-Fi SoftAP
------------
It is possible to use ESP32 as an Access Point (SoftAP).
.. tip:: Boards usually expose a ``sta_softap`` defconfig which enables Wi-Fi
(STA + SoftAP)
If you are using this board config profile you can run these commands to be able
to connect your smartphone or laptop to your board::
nsh> ifup wlan1
nsh> dhcpd_start wlan1
nsh> wapi psk wlan1 mypasswd 3
nsh> wapi essid wlan1 nuttxap 1
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.
The ``dhcpd_start`` is necessary to let your board to associate an IP to your smartphone.
Memory Map Memory Map
========== ==========