Skip to content

Commit b99af4c

Browse files
author
Marek Matej
committed
boards: Update all vendors documentation related with Espressif SoCs
Update the documentation of ESP32 related boards: * use included sections for common parts * fix the `References` links if applicable. Signed-off-by: Marek Matej <[email protected]>
1 parent 727c15a commit b99af4c

File tree

69 files changed

+1505
-6984
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+1505
-6984
lines changed

boards/01space/esp32c3_042_oled/doc/index.rst

Lines changed: 15 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Overview
44
********
55

6-
ESP32C3 0.42 OLED is a mini development board based on the `Espressif ESP32-C3`_
6+
ESP32-C3 0.42 OLED is a mini development board based on the `Espressif ESP32-C3`_
77
RISC-V WiFi/Bluetooth dual-mode chip.
88

99
For more details see the `01space ESP32C3 0.42 OLED`_ Github repo.
@@ -31,10 +31,8 @@ It features:
3131
The ESP32-C3 does not have native USB, it has an on-chip USB-serial converter
3232
instead.
3333

34-
Supported Features
35-
==================
36-
37-
.. zephyr:board-supported-hw::
34+
.. include:: ../../../espressif/common/soc-esp32c3-features.rst
35+
:start-after: espressif-soc-esp32c3-features
3836

3937
Connections and IOs
4038
===================
@@ -50,87 +48,28 @@ See the following image:
5048
It also features a 0.42 inch OLED display, driven by a SSD1306-compatible chip.
5149
It is connected over I2C: SDA on GPIO5, SCL on GPIO6.
5250

53-
Prerequisites
54-
=============
55-
56-
Espressif HAL requires WiFi and Bluetooth binary blobs. Run the command below to
57-
retrieve those files.
58-
59-
.. code-block:: console
60-
61-
west blobs fetch hal_espressif
62-
63-
.. note::
51+
System Requirements
52+
*******************
6453

65-
It is recommended running the command above after :file:`west update`.
54+
.. include:: ../../../espressif/common/system-requirements.rst
55+
:start-after: espressif-system-requirements
6656

6757
Programming and Debugging
6858
*************************
6959

7060
.. zephyr:board-supported-runners::
7161
72-
Standalone application
73-
======================
74-
75-
The board can be loaded using a single binary image, without 2nd stage bootloader.
76-
It is the default option when building the application without additional configuration.
77-
78-
.. note::
79-
80-
This mode does not provide any security features nor OTA updates.
81-
82-
Use the following command to build a sample hello_world application:
83-
84-
.. zephyr-app-commands::
85-
:zephyr-app: samples/hello_world
86-
:board: esp32c3_042_oled
87-
:goals: build
88-
89-
Sysbuild
90-
========
91-
92-
:ref:`sysbuild` makes it possible to build and flash all necessary images needed to
93-
bootstrap the board.
94-
95-
By default, the ESP32 sysbuild configuration creates bootloader (MCUboot) and
96-
application images.
97-
98-
To build the sample application using sysbuild, use this command:
99-
100-
.. zephyr-app-commands::
101-
:tool: west
102-
:zephyr-app: samples/hello_world
103-
:board: esp32c3_042_oled
104-
:goals: build
105-
:west-args: --sysbuild
106-
:compact:
107-
108-
Flashing
109-
========
110-
111-
For the :code:`Hello, world!` application, follow the instructions below.
112-
Assuming the board is connected to ``/dev/ttyACM0`` on Linux.
113-
114-
.. zephyr-app-commands::
115-
:zephyr-app: samples/hello_world
116-
:board: esp32c3_042_oled
117-
:goals: flash
118-
:flash-args: --esp-device /dev/ttyACM0
119-
120-
Since the Zephyr console is by default on the ``usb_serial`` device, we use
121-
the espressif monitor utility to connect to the console.
122-
123-
.. code-block:: console
124-
125-
$ west espressif monitor -p /dev/ttyACM0
62+
.. include:: ../../../espressif/common/building-flashing.rst
63+
:start-after: espressif-building-flashing
12664

127-
After the board has automatically reset and booted, you should see the following
128-
message in the monitor:
65+
.. include:: ../../../espressif/common/board-variants.rst
66+
:start-after: espressif-board-variants
12967

130-
.. code-block:: console
68+
Debugging
69+
=========
13170

132-
***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
133-
Hello World! esp32c3_042_oled
71+
.. include:: ../../../espressif/common/openocd-debugging.rst
72+
:start-after: espressif-openocd-debugging
13473

13574
References
13675
**********

boards/adafruit/feather_esp32/doc/index.rst

Lines changed: 34 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ Overview
66
The Adafruit ESP32 Feather is an ESP32-based development board using the
77
Feather standard layout.
88

9+
Hardware
10+
********
11+
912
It features the following integrated components:
1013

1114
- ESP32-PICO-V3-02 chip (240MHz dual core, Wi-Fi + BLE)
@@ -17,51 +20,42 @@ It features the following integrated components:
1720
- Reset and user buttons
1821
- STEMMA QT I2C connector
1922

23+
.. include:: ../../../espressif/common/soc-esp32-features.rst
24+
:start-after: espressif-soc-esp32-features
25+
2026
Supported Features
2127
==================
2228

2329
.. zephyr:board-supported-hw::
2430
25-
System requirements
26-
===================
27-
28-
Prerequisites
29-
-------------
30-
31-
Espressif HAL requires WiFi and Bluetooth binary blobs in order to work. Run
32-
the commands below to retrieve the files.
33-
34-
.. code-block:: shell
31+
System Requirements
32+
*******************
3533

36-
west update
37-
west blobs fetch hal_espressif
34+
.. include:: ../../../espressif/common/system-requirements.rst
35+
:start-after: espressif-system-requirements
3836

39-
Building & flashing
40-
-------------------
37+
Programming and Debugging
38+
*************************
4139

42-
Use the standard build and flash process for this board. See
43-
:ref:`build_an_application` and :ref:`application_run` for more details.
40+
.. zephyr:board-supported-runners::
4441
45-
.. zephyr-app-commands::
46-
:zephyr-app: samples/hello_world
47-
:board: adafruit_feather_esp32/esp32/procpu
48-
:goals: build flash
42+
.. include:: ../../../espressif/common/building-flashing.rst
43+
:start-after: espressif-building-flashing
4944

50-
The baud rate of 921600bps is set by default. If experiencing issues when flashing,
51-
try using different values by using ``--esp-baud-rate <BAUD>`` option during
52-
``west flash`` (e.g. ``west flash --esp-baud-rate 115200``).
45+
.. include:: ../../../espressif/common/board-variants.rst
46+
:start-after: espressif-board-variants
5347

54-
After flashing, view the serial monitor with the espressif monitor command.
48+
Debugging
49+
=========
5550

56-
.. code-block:: shell
57-
58-
west espressif monitor
51+
.. include:: ../../../espressif/common/openocd-debugging.rst
52+
:start-after: espressif-openocd-debugging
5953

6054
Testing
61-
=======
55+
*******
6256

6357
On-board LED
64-
------------
58+
============
6559

6660
Test the functionality of the user LED connected to pin 13 with the blinky
6761
sample program.
@@ -72,7 +66,7 @@ sample program.
7266
:goals: build flash
7367

7468
NeoPixel
75-
--------
69+
========
7670

7771
Test the on-board NeoPixel using the led_strip sample program.
7872

@@ -82,7 +76,7 @@ Test the on-board NeoPixel using the led_strip sample program.
8276
:goals: build flash
8377

8478
User button
85-
-----------
79+
===========
8680

8781
Test the button labeled SW38 using the button input sample program.
8882

@@ -92,7 +86,7 @@ Test the button labeled SW38 using the button input sample program.
9286
:goals: build flash
9387

9488
Wi-Fi
95-
-----
89+
=====
9690

9791
Test ESP32 Wi-Fi functionality using the Wi-Fi shell module.
9892

@@ -106,8 +100,11 @@ Test ESP32 Wi-Fi functionality using the Wi-Fi shell module.
106100

107101
References
108102
**********
109-
- `Adafruit ESP32 Feather V2 <https://www.adafruit.com/product/5400>`_
110-
- `Adafruit ESP32 Feather V2 Pinouts <https://learn.adafruit.com/adafruit-esp32-feather-v2/pinouts>`_
111-
- `Adafruit ESP32 Feather V2 Schematic <https://learn.adafruit.com/adafruit-esp32-feather-v2/downloads#schematic-and-fab-print-3112284>`_
112-
- `ESP32-PICO-MINI-02 Datasheet <https://cdn-learn.adafruit.com/assets/assets/000/109/588/original/esp32-pico-mini-02_datasheet_en.pdf?1646852017>`_ (PDF)
113-
- `STEMMA QT <https://learn.adafruit.com/introducing-adafruit-stemma-qt>`_
103+
104+
.. target-notes::
105+
106+
.. _`Adafruit ESP32 Feather V2`: https://www.adafruit.com/product/5400
107+
.. _`Adafruit ESP32 Feather V2 Pinouts`: https://learn.adafruit.com/adafruit-esp32-feather-v2/pinouts
108+
.. _`Adafruit ESP32 Feather V2 Schematic`: https://learn.adafruit.com/adafruit-esp32-feather-v2/downloads#schematic-and-fab-print-3112284
109+
.. _`ESP32-PICO-MINI-02 Datasheet`: https://cdn-learn.adafruit.com/assets/assets/000/109/588/original/esp32-pico-mini-02_datasheet_en.pdf?1646852017
110+
.. _`STEMMA QT`: https://learn.adafruit.com/introducing-adafruit-stemma-qt

0 commit comments

Comments
 (0)