Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 15 additions & 76 deletions boards/01space/esp32c3_042_oled/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Overview
********

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

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

Supported Features
==================

.. zephyr:board-supported-hw::
.. include:: ../../../espressif/common/soc-esp32c3-features.rst
:start-after: espressif-soc-esp32c3-features

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

Prerequisites
=============

Espressif HAL requires WiFi and Bluetooth binary blobs. Run the command below to
retrieve those files.

.. code-block:: console

west blobs fetch hal_espressif

.. note::
System Requirements
*******************

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

Programming and Debugging
*************************

.. zephyr:board-supported-runners::

Standalone application
======================

The board can be loaded using a single binary image, without 2nd stage bootloader.
It is the default option when building the application without additional configuration.

.. note::

This mode does not provide any security features nor OTA updates.

Use the following command to build a sample hello_world application:

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: esp32c3_042_oled
:goals: build

Sysbuild
========

:ref:`sysbuild` makes it possible to build and flash all necessary images needed to
bootstrap the board.

By default, the ESP32 sysbuild configuration creates bootloader (MCUboot) and
application images.

To build the sample application using sysbuild, use this command:

.. zephyr-app-commands::
:tool: west
:zephyr-app: samples/hello_world
:board: esp32c3_042_oled
:goals: build
:west-args: --sysbuild
:compact:

Flashing
========

For the :code:`Hello, world!` application, follow the instructions below.
Assuming the board is connected to ``/dev/ttyACM0`` on Linux.

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: esp32c3_042_oled
:goals: flash
:flash-args: --esp-device /dev/ttyACM0

Since the Zephyr console is by default on the ``usb_serial`` device, we use
the espressif monitor utility to connect to the console.

.. code-block:: console

$ west espressif monitor -p /dev/ttyACM0
.. include:: ../../../espressif/common/building-flashing.rst
:start-after: espressif-building-flashing

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

.. code-block:: console
Debugging
=========

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

References
**********
Expand Down
71 changes: 34 additions & 37 deletions boards/adafruit/feather_esp32/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ Overview
The Adafruit ESP32 Feather is an ESP32-based development board using the
Feather standard layout.

Hardware
********

It features the following integrated components:

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

.. include:: ../../../espressif/common/soc-esp32-features.rst
:start-after: espressif-soc-esp32-features

Supported Features
==================

.. zephyr:board-supported-hw::

System requirements
===================

Prerequisites
-------------

Espressif HAL requires WiFi and Bluetooth binary blobs in order to work. Run
the commands below to retrieve the files.

.. code-block:: shell
System Requirements
*******************

west update
west blobs fetch hal_espressif
.. include:: ../../../espressif/common/system-requirements.rst
:start-after: espressif-system-requirements

Building & flashing
-------------------
Programming and Debugging
*************************

Use the standard build and flash process for this board. See
:ref:`build_an_application` and :ref:`application_run` for more details.
.. zephyr:board-supported-runners::

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: adafruit_feather_esp32/esp32/procpu
:goals: build flash
.. include:: ../../../espressif/common/building-flashing.rst
:start-after: espressif-building-flashing

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

After flashing, view the serial monitor with the espressif monitor command.
Debugging
=========

.. code-block:: shell

west espressif monitor
.. include:: ../../../espressif/common/openocd-debugging.rst
:start-after: espressif-openocd-debugging

Testing
=======
*******

On-board LED
------------
============

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

NeoPixel
--------
========

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

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

User button
-----------
===========

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

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

Wi-Fi
-----
=====

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

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

References
**********
- `Adafruit ESP32 Feather V2 <https://www.adafruit.com/product/5400>`_
- `Adafruit ESP32 Feather V2 Pinouts <https://learn.adafruit.com/adafruit-esp32-feather-v2/pinouts>`_
- `Adafruit ESP32 Feather V2 Schematic <https://learn.adafruit.com/adafruit-esp32-feather-v2/downloads#schematic-and-fab-print-3112284>`_
- `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)
- `STEMMA QT <https://learn.adafruit.com/introducing-adafruit-stemma-qt>`_

.. target-notes::

.. _`Adafruit ESP32 Feather V2`: https://www.adafruit.com/product/5400
.. _`Adafruit ESP32 Feather V2 Pinouts`: https://learn.adafruit.com/adafruit-esp32-feather-v2/pinouts
.. _`Adafruit ESP32 Feather V2 Schematic`: https://learn.adafruit.com/adafruit-esp32-feather-v2/downloads#schematic-and-fab-print-3112284
.. _`ESP32-PICO-MINI-02 Datasheet`: https://cdn-learn.adafruit.com/assets/assets/000/109/588/original/esp32-pico-mini-02_datasheet_en.pdf?1646852017
.. _`STEMMA QT`: https://learn.adafruit.com/introducing-adafruit-stemma-qt
Loading
Loading