Skip to content

Commit 66130da

Browse files
Glauber Maroto Ferreiranashif
authored andcommitted
board: esp32: update SPI RAM sample code documentation
to mention sample code support added for ESP32-S2. Signed-off-by: Glauber Maroto Ferreira <[email protected]>
1 parent 963a707 commit 66130da

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

samples/boards/esp32/spiram_test/README.rst

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,38 @@ ESP_HEAP_MIN_EXTRAM_THRESHOLD, memory is allocated from internal DRAM. If
1414
size is greater than ESP_HEAP_MIN_EXTRAM_THRESHOLD, memory is allocated from
1515
SPIRAM.
1616

17+
Supported SoCs
18+
**************
19+
20+
The following SoCs are supported by this sample code so far:
21+
22+
* ESP32
23+
* ESP32-S2
24+
1725
Building and Running
1826
********************
1927

20-
Make sure you have the ESP32_WROVER_KIT connected over USB port.
28+
Make sure you have your board connected over USB port.
2129

2230
.. code-block:: console
2331
2432
west build -b esp32 samples/boards/esp32/spiram_test
25-
west flash --esp-device /dev/ttyUSB0
33+
west flash
34+
35+
If using another supported Espressif board, replace the argument in the above
36+
command with a proper board name (e.g., `esp32s2_saola`).
2637

2738
Sample Output
2839
=============
2940

30-
To check output of this sample, any serial console program can be used (i.e. on Linux minicom, putty, screen, etc)
31-
This example uses ``picocom`` on the serial port ``/dev/ttyUS0``:
41+
To check output of this sample, run ``west espressif monitor`` or any other serial
42+
console program (e.g., minicom, putty, screen, etc).
43+
This example uses ``west espressif monitor``, which automatically detects the serial
44+
port at ``/dev/ttyUSB0``:
45+
46+
.. code-block:: console
47+
48+
$ west espressif monitor
3249
3350
.. code-block:: console
3451

0 commit comments

Comments
 (0)