documentation: update ESP32-C3 board names for legacy and new devkit
Updates the docs to the new esp32c3-devkit naming, after deprecating support for now esp32c3-legacy. Signed-off-by: Filipe Cavalcanti <filipe.cavalcanti@espressif.com>
|
Before Width: | Height: | Size: 1.0 MiB After Width: | Height: | Size: 1.0 MiB |
@@ -1,6 +1,6 @@
|
|||||||
=====================
|
==============================
|
||||||
ESP32C3 DevKit RUST-1
|
ESP32C3 DevKit RUST-1 (Legacy)
|
||||||
=====================
|
==============================
|
||||||
|
|
||||||
.. tags:: arch:riscv, vendor:espressif
|
.. tags:: arch:riscv, vendor:espressif
|
||||||
|
|
||||||
@@ -67,7 +67,7 @@ To configure NuttX for this board, you can use the following command:
|
|||||||
|
|
||||||
.. code:: console
|
.. code:: console
|
||||||
|
|
||||||
$ ./tools/configure.sh esp32c3-devkit-rust-1:<config>
|
$ ./tools/configure.sh esp32c3-legacy-devkit-rust-1:<config>
|
||||||
|
|
||||||
Where ``<config>`` is one of the configurations listed below.
|
Where ``<config>`` is one of the configurations listed below.
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 1.2 MiB After Width: | Height: | Size: 1.2 MiB |
|
Before Width: | Height: | Size: 1.5 MiB After Width: | Height: | Size: 1.5 MiB |
@@ -68,12 +68,12 @@ README
|
|||||||
directory structure. You can directly modify files under etc/ folder,
|
directory structure. You can directly modify files under etc/ folder,
|
||||||
The build system will regenerate nsh_romfsimg.h automatically.
|
The build system will regenerate nsh_romfsimg.h automatically.
|
||||||
|
|
||||||
See the esp32c3-devkit/nsh configuration for an example of the use of this file
|
See the esp32c3-legacy-devkit/nsh configuration for an example of the use of this file
|
||||||
system.
|
system.
|
||||||
|
|
||||||
Replacing the Password File
|
Replacing the Password File
|
||||||
---------------------------
|
---------------------------
|
||||||
The esp32c3-devkit/nsh configuration can also be used to create a new password file.
|
The esp32c3-legacy-devkit/nsh configuration can also be used to create a new password file.
|
||||||
First, make these configuration changes:
|
First, make these configuration changes:
|
||||||
|
|
||||||
1. Disable logins
|
1. Disable logins
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
===============
|
========================
|
||||||
ESP32-C3 DevKit
|
ESP32-C3 DevKit (Legacy)
|
||||||
===============
|
========================
|
||||||
|
|
||||||
The ESP32-C3 DevKit is an entry-level development board equipped with either
|
The ESP32-C3 DevKit is an entry-level development board equipped with either
|
||||||
an ESP32-C3-WROOM-02 or an ESP32-C3-MINI-1.
|
an ESP32-C3-WROOM-02 or an ESP32-C3-MINI-1.
|
||||||
@@ -47,7 +47,7 @@ Configurations
|
|||||||
|
|
||||||
All of the configurations presented below can be tested by running the following commands::
|
All of the configurations presented below can be tested by running the following commands::
|
||||||
|
|
||||||
$ ./tools/configure.sh esp32c3-devkit:<config_name>
|
$ ./tools/configure.sh esp32c3-legacy-devkit:<config_name>
|
||||||
$ make flash ESPTOOL_PORT=/dev/ttyUSB0 -j
|
$ make flash ESPTOOL_PORT=/dev/ttyUSB0 -j
|
||||||
|
|
||||||
Where <config_name> is the name of board configuration you want to use, i.e.: nsh, buttons, wifi...
|
Where <config_name> is the name of board configuration you want to use, i.e.: nsh, buttons, wifi...
|
||||||
@@ -92,7 +92,7 @@ First make sure that ``esptool.py`` is installed. This tool is used to convert
|
|||||||
the ELF to a compatible ESP32 image and to flash the image into the board.
|
the ELF to a compatible ESP32 image and to flash the image into the board.
|
||||||
It can be installed with: ``pip install esptool==4.8.dev4``.
|
It can be installed with: ``pip install esptool==4.8.dev4``.
|
||||||
|
|
||||||
Configure the NuttX project: ``./tools/configure.sh esp32c3-devkit:nsh``
|
Configure the NuttX project: ``./tools/configure.sh esp32c3-legacy-devkit:nsh``
|
||||||
Run ``make`` to build the project. Note that the conversion mentioned above is
|
Run ``make`` to build the project. Note that the conversion mentioned above is
|
||||||
included in the build process.
|
included in the build process.
|
||||||
The ``esptool.py`` command to flash all the binaries is::
|
The ``esptool.py`` command to flash all the binaries is::
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 1.2 MiB After Width: | Height: | Size: 1.2 MiB |
|
Before Width: | Height: | Size: 1.5 MiB After Width: | Height: | Size: 1.5 MiB |
@@ -47,7 +47,7 @@ Configurations
|
|||||||
|
|
||||||
All of the configurations presented below can be tested by running the following commands::
|
All of the configurations presented below can be tested by running the following commands::
|
||||||
|
|
||||||
$ ./tools/configure.sh esp32c3-generic:<config_name>
|
$ ./tools/configure.sh esp32c3-devkit:<config_name>
|
||||||
$ make flash ESPTOOL_PORT=/dev/ttyUSB0 -j
|
$ make flash ESPTOOL_PORT=/dev/ttyUSB0 -j
|
||||||
|
|
||||||
Where <config_name> is the name of board configuration you want to use, i.e.: nsh, buttons, wifi...
|
Where <config_name> is the name of board configuration you want to use, i.e.: nsh, buttons, wifi...
|
||||||
|
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 1.9 KiB |
@@ -138,7 +138,7 @@ This example shows how to build and flash the ``nsh`` defconfig for the ESP32-C3
|
|||||||
|
|
||||||
$ cd nuttx
|
$ cd nuttx
|
||||||
$ make distclean
|
$ make distclean
|
||||||
$ ./tools/configure.sh esp32c3-generic:nsh
|
$ ./tools/configure.sh esp32c3-devkit:nsh
|
||||||
$ make -j$(nproc)
|
$ make -j$(nproc)
|
||||||
|
|
||||||
When the build is complete, the firmware can be flashed to the board using the command::
|
When the build is complete, the firmware can be flashed to the board using the command::
|
||||||
@@ -176,7 +176,7 @@ Now opening the serial port with a terminal emulator should show the NuttX conso
|
|||||||
$ picocom -b 115200 /dev/ttyUSB0
|
$ picocom -b 115200 /dev/ttyUSB0
|
||||||
NuttShell (NSH) NuttX-12.8.0
|
NuttShell (NSH) NuttX-12.8.0
|
||||||
nsh> uname -a
|
nsh> uname -a
|
||||||
NuttX 12.8.0 759d37b97c-dirty Mar 5 2025 19:58:56 risc-v esp32c3-generic
|
NuttX 12.8.0 759d37b97c-dirty Mar 5 2025 19:58:56 risc-v esp32c3-devkit
|
||||||
|
|
||||||
Debugging
|
Debugging
|
||||||
=========
|
=========
|
||||||
@@ -424,7 +424,7 @@ This section describes how to execute OTA update using MCUBoot.
|
|||||||
|
|
||||||
1. First build the default ``mcuboot_update_agent`` config. This image defaults to the primary slot and already comes with Wi-Fi settings enabled::
|
1. First build the default ``mcuboot_update_agent`` config. This image defaults to the primary slot and already comes with Wi-Fi settings enabled::
|
||||||
|
|
||||||
./tools/configure.sh esp32c3-generic:mcuboot_update_agent
|
./tools/configure.sh esp32c3-devkit:mcuboot_update_agent
|
||||||
|
|
||||||
2. Build the MCUBoot bootloader::
|
2. Build the MCUBoot bootloader::
|
||||||
|
|
||||||
|
|||||||