edi
/
firebeetle2_esp32c6_zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
firebeetle2_esp32c6_zephyr/boards/espressif/esp32c3_devkitm/doc/index.rst

6.3 KiB
Raw Blame History

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> </head>

System Message: ERROR/3 (<stdin>, line 1)

Unknown directive type "zephyr:board".

.. zephyr:board:: esp32c3_devkitm

Overview

ESP32-C3-DevKitM is an entry-level development board based on ESP32-C3-MINI-1, a module named for its small size. This board integrates complete Wi-Fi and Bluetooth® Low Energy functions. For more information, check ESP32-C3-DevKitM [1].

Hardware

ESP32-C3 is a single-core Wi-Fi and Bluetooth 5 (LE) microcontroller SoC, based on the open-source RISC-V architecture. It strikes the right balance of power, I/O capabilities and security, thus offering the optimal cost-effective solution for connected devices. The availability of Wi-Fi and Bluetooth 5 (LE) connectivity not only makes the device configuration easy, but it also facilitates a variety of use-cases based on dual connectivity.

The features include the following:

  • 32-bit core RISC-V microcontroller with a maximum clock speed of 160 MHz
  • 400 KB of internal RAM
  • 802.11b/g/n/e/i
  • A Bluetooth LE subsystem that supports features of Bluetooth 5 and Bluetooth Mesh
  • Various peripherals:
    • 12-bit ADC with up to 6 channels
    • TWAI compatible with CAN bus 2.0
    • Temperature sensor
    • 3x SPI
    • 1x I2S
    • 1x I2C
    • 2x UART
    • LED PWM with up to 6 channels
  • Cryptographic hardware acceleration (RNG, ECC, RSA, SHA-2, AES)

For more information, check the datasheet at ESP32-C3 Datasheet [2] or the technical reference manual at ESP32-C3 Technical Reference Manual [3].

Supported Features

System Message: ERROR/3 (<stdin>, line 45)

Unknown directive type "zephyr:board-supported-hw".

.. zephyr:board-supported-hw::

System requirements

Prerequisites

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

System Message: WARNING/2 (<stdin>, line 56)

Cannot analyze code. Pygments package not found.

.. code-block:: console

   west blobs fetch hal_espressif

Note

It is recommended running the command above after :file:`west update`.

System Message: ERROR/3 (<stdin>, line 62); backlink

Unknown interpreted text role "file".

Building & Flashing

System Message: ERROR/3 (<stdin>, line 67)

Unknown directive type "zephyr:board-supported-runners".

.. zephyr:board-supported-runners::

Simple boot

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

Note

Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader

User may choose to use MCUboot bootloader instead. In that case the bootloader must be built (and flashed) at least once.

There are two options to be used when building an application:

  1. Sysbuild
  2. Manual build

Note

User can select the MCUboot bootloader by adding the following line to the board default configuration file.

System Message: WARNING/2 (<stdin>, line 95)

Cannot analyze code. Pygments package not found.

.. code:: cfg

   CONFIG_BOOTLOADER_MCUBOOT=y

Sysbuild

The sysbuild makes possible to build and flash all necessary images needed to bootstrap the board with the ESP32 SoC.

To build the sample application using sysbuild use the command:

System Message: ERROR/3 (<stdin>, line 107)

Unknown directive type "zephyr-app-commands".

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

By default, the ESP32 sysbuild creates bootloader (MCUboot) and application images. But it can be configured to create other kind of images.

Build directory structure created by sysbuild is different from traditional Zephyr build. Output is structured by the domain subdirectories:

build/
├── hello_world
│   └── zephyr
│       ├── zephyr.elf
│       └── zephyr.bin
├── mcuboot
│    └── zephyr
│       ├── zephyr.elf
│       └── zephyr.bin
└── domains.yaml

Note

With --sysbuild option the bootloader will be re-build and re-flash every time the pristine build is used.

For more information about the system build please read the :ref:`sysbuild` documentation.

System Message: ERROR/3 (<stdin>, line 139); backlink

Unknown interpreted text role "ref".

Manual build

During the development cycle, it is intended to build & flash as quickly possible. For that reason, images can be built one at a time using traditional build.

The instructions following are relevant for both manual build and sysbuild. The only difference is the structure of the build directory.

Note

Remember that bootloader (MCUboot) needs to be flash at least once.

Build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details).

System Message: ERROR/3 (<stdin>, line 154); backlink

Unknown interpreted text role "ref".

System Message: ERROR/3 (<stdin>, line 154); backlink

Unknown interpreted text role "ref".

System Message: ERROR/3 (<stdin>, line 157)

Unknown directive type "zephyr-app-commands".

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

The usual flash target will work with the esp32c3_devkitm board configuration. Here is an example for the :zephyr:code-sample:`hello_world` application.

System Message: ERROR/3 (<stdin>, line 162); backlink

Unknown interpreted text role "zephyr:code-sample".

System Message: ERROR/3 (<stdin>, line 166)

Unknown directive type "zephyr-app-commands".

.. zephyr-app-commands::
   :zephyr-app: samples/hello_world
   :board: esp32c3_devkitm
   :goals: flash

Open the serial monitor using the following command:

System Message: WARNING/2 (<stdin>, line 173)

Cannot analyze code. Pygments package not found.

.. code-block:: shell

   west espressif monitor

After the board has automatically reset and booted, you should see the following message in the monitor:

System Message: WARNING/2 (<stdin>, line 180)

Cannot analyze code. Pygments package not found.

.. code-block:: console

   ***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
   Hello World! esp32c3_devkitm

Debugging

As with much custom hardware, the ESP32-C3 modules require patches to OpenOCD that are not upstreamed yet. Espressif maintains their own fork of the project. The custom OpenOCD can be obtained at OpenOCD ESP32 [4].

The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite that behavior by adding the -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts> parameter when building.

Here is an example for building the :zephyr:code-sample:`hello_world` application.

System Message: ERROR/3 (<stdin>, line 196); backlink

Unknown interpreted text role "zephyr:code-sample".

System Message: ERROR/3 (<stdin>, line 198)

Unknown directive type "zephyr-app-commands".

.. zephyr-app-commands::
   :zephyr-app: samples/hello_world
   :board: esp32c3_devkitm
   :goals: build flash
   :gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>

You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.

System Message: ERROR/3 (<stdin>, line 204); backlink

Unknown interpreted text role "zephyr:code-sample".

System Message: ERROR/3 (<stdin>, line 206)

Unknown directive type "zephyr-app-commands".

.. zephyr-app-commands::
   :zephyr-app: samples/hello_world
   :board: esp32c3_devkitm
   :goals: debug

References

[1]https://docs.espressif.com/projects/esp-idf/en/latest/esp32c3/hw-reference/esp32c3/user-guide-devkitm-1.html
[2]https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
[3]https://espressif.com/sites/default/files/documentation/esp32-c3_technical_reference_manual_en.pdf
[4]https://github.com/espressif/openocd-esp32/releases
</html>