kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-16 10:03:50 +01:00
Code Releases Activity
RIOT/boards/esp32s2-devkit/doc.md
krzysztof-cabaj b912b981eb boards: move licenses to SPDX format for doc.md files
2025-08-07 15:40:47 +02:00

8.9 KiB
Raw Blame History

@defgroup boards_esp32s2_devkit ESP32-S2-DevKit Board @ingroup boards_esp32s2 @brief Support for generic ESP32S2 boards @author Gunar Schorcht gunar@schorcht.net

\section esp32s2_devkit ESP32-S2-DevKit

Table of Contents

  1. Overview
  2. Hardware
    1. MCU
    2. Board Configuration
    3. Board Pinout
  3. Flashing the Device

Overview

The Espressif ESP32-S2-DevKit boards are a couple of boards that use one of the following modules:

  • ESP32-S2-MINI-1x-N4 module (ESP32-S2-DevKitM-1 board)
  • ESP32-S2-MINI-1x-N4R2 module (ESP32-S2-DevKitM-1R board)
  • ESP32-S2-SOLO-N4 module (ESP32-S2-DevKitC-1 board)
  • ESP32-S2-SOLO-N4R2 module (ESP32-S2-DevKitC-1R board)
  • ESP32-S2-WROOM module (ESP32-S2-Saola-1 board)
  • ESP32-S2-WROVER-N4R2 module (ESP32-S2-Saola-1R board)

\image html "https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s2/_images/esp32-s2-devkitm-1-v1-annotated-photo.png" "Espressif ESP32-S2-DevKitM-1" width=600px


Due to the different modules used, the available versions of the ESP32-S2-DevKit board differ regarding the Flash size, the integrated SPI RAM and the SPI voltage. To be able to use all these different versions of the board with a single board definition, used board version can be specified by the variable `BOARD_VERSION` during compilation, for example: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ BOARD=esp32s2-devkit BOARD_VERSION=esp32s2-devkitc-1r make ... ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The following table shows the available board versions, the size of the Flash and the SPI RAM as well as the value of the variable BOARD_VERSION that is used to specify the board version.

| Board Version | Flash (Mode) | SPI RAM (Mode) | `BOARD_VERSION` |:----------------------|:-------------|:---------------|:----------------- | ESP32-S2-DevKitM-1 | 4 MB (Quad) | - | `esp32s2-devkitm-1` (default) | ESP32-S2-DevKitM-1U | 4 MB (Quad) | - | `esp32s2-devkitm-1u` | ESP32-S2-DevKitM-1R | 4 MB (Quad) | 2 MB (Quad) | `esp32s2-devkitm-1r` | ESP32-S2-DevKitM-1RU | 4 MB (Quad) | 2 MB (Quad) | `esp32s2-devkitm-1ru` | ESP32-S2-DevKitC-1 | 4 MB (Quad) | - | `esp32s2-devkitc-1` | ESP32-S2-DevKitC-1U | 4 MB (Quad) | - | `esp32s2-devkitc-1u` | ESP32-S2-DevKitC-1R | 4 MB (Quad) | 2 MB (Quad) | `esp32s2-devkitc-1r` | ESP32-S2-DevKitC-1RU | 4 MB (Quad) | 2 MB (Quad) | `esp32s2-devkitc-1ru` | ESP32-S2-Saola-1M | 4 MB (Quad) | - | `esp32s2-saola-1m` | ESP32-S2-Saola-1MI | 4 MB (Quad) | - | `esp32s2-saola-1mi` | ESP32-S2-Saola-1R | 4 MB (Quad) | 2 MB (Quad) | `esp32s2-saola-1r` | ESP32-S2-Saola-1RI | 4 MB (Quad) | 2 MB (Quad) | `esp32s2-saola-1ri`

@note

  • If the board version is not specified, ESP32-S2-DevKitM-1 with 4 MByte Flash is assumed and BOARD_VERSION is set to esp32s2-devkitm-1 by default.
  • Using a board version with embedded SPI RAM (BOARD_VERSION is any of esp32s2-*-1r* values) enables the \ref esp32_spi_ram "esp_spi_ram" feature. The SPI RAM can then be used as heap by enabling the \ref esp32_spi_ram "esp_spi_ram" pseudomodule.

Back to table of contents

Hardware

This section describes

Back to table of contents

MCU

Most features of the board are provided by the ESP32-S2 SoC. For detailed information about the ESP32-S2 SoC variant (family) and ESP32x SoCs, see section \ref esp32_mcu_esp32 "ESP32 SoC Series".

Back to table of contents

Board Configuration

ESP32-S2-DevKit boards have no special hardware on board with the exception of a single pin RGB-LED.

All GPIOs are simply broken out for flexibility. Therefore, the board configuration is the most flexible one which provides:

  • 20 x ADC channels at maximum
  • 2 x SPI
  • 1 x I2C
  • 2 x UART
  • 1 RGB-LED

Since almost GPIOs have broken out, GPIOs can be used for different purposes in different applications. Following GPIOs are used for Flash and SPI RAM and are not broken out:

  • ESP32-S2-DevKitC-1x: GPIO27..GPIO32
  • ESP32-S2-DevKitM-1x: GPIO26..GPIO32
  • ESP32-S2-Saola-1x: GPIO26..GPIO32

For flexibility, GPIOs can be used in multiple peripheral configurations, but they can only be used for one peripheral at a time. For example, GPIO9 is used in the ADC channel definition and the definition of the SCL signal for I2C_DEV(0).

This is possible because GPIOs are only used for a specific peripheral interface when either

  • the corresponding peripheral module is used, e.g. periph_i2c, or
  • the corresponding init function is called, e.g. adc_init.

That is, the purpose for which a GPIO is used depends on which module or function is used first.

For example, if module periph_i2c is not used, the GPIOs listed in I2C configuration can be used for the other purposes, that is, GPIO9 can be used as ADC channel.

The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by \ref esp32_application_specific_configurations "application-specific configurations".

Function | GPIOs | Remarks | Configuration :---------------|:-------|:--------|:---------------------------------- BUTTON0 | GPIO0 | | | ADC_LINE(n) | GPIO1 ... GPIO10 | | \ref esp32_adc_channels "ADC Channels" DAC_LINE(n) | GPIO17, GPIO18 | GPIO18 is connected to RGB-LED | \ref esp32_dac_channels "DAC Channels" I2C_DEV(0) SCL | GPIO9 | | \ref esp32_i2c_interfaces "I2C Interfaces" I2C_DEV(0) SDA | GPIO8 | | \ref esp32_i2c_interfaces "I2C Interfaces" PWM_DEV(0) | GPIO11, GPIO12, GPIO13, GPIO14 | - | \ref esp32_pwm_channels "PWM Channels" PWM_DEV(1) | GPIO15, GPIO16 | if module `esp_rtc_timer_32k` is not used | \ref esp32_pwm_channels "PWM Channels" RGB-LED | GPIO18 | supported by driver module `ws281x` | | SPI_DEV(0) CLK | GPIO36 | SPI2_HOST (FSPI) is used | \ref esp32_spi_interfaces "SPI Interfaces" SPI_DEV(0) MISO | GPIO37 | SPI2_HOST (FSPI) is used | \ref esp32_spi_interfaces "SPI Interfaces" SPI_DEV(0) MOSI | GPIO35 | SPI2_HOST (FSPI) is used | \ref esp32_spi_interfaces "SPI Interfaces" SPI_DEV(0) CS0 | GPIO34 | SPI2_HOST (FSPI) is used | \ref esp32_spi_interfaces "SPI Interfaces" UART_DEV(0) TxD | GPIO43 | Console (configuration is fixed) | \ref esp32_uart_interfaces "UART interfaces" UART_DEV(0) RxD | GPIO44 | Console (configuration is fixed) | \ref esp32_uart_interfaces "UART interfaces" \n

For detailed information about the peripheral configurations of ESP32-S2 boards, see section \ref esp32_peripherals "Common Peripherals".

Back to table of contents

Board Pinout

The following figures show the pinouts as configured by default board definition.

@image html "https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s2/_images/esp32-s2-devkitm-1-v1-pin-layout.png" "ESP32-S2-DevKitM-1x Pinout" width=900px @image html "https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s2/_images/esp32-s2-devkitc-1-v1-pinout.png" "ESP32-S2-DevKitC-1x Pinout" width=900px @image html "https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s2/_images/esp32-s2_saola1-pinout.jpg" "ESP32-S2-Saola-1x Pinout" width=900px

The corresponding board schematics can be found:

Back to table of contents

Flashing the Device

Flashing RIOT is quite easy. The board has a Micro-USB connector with reset/boot/flash logic. Just connect the board to your host computer and type using the programming port:

BOARD=esp32s2-devkit make flash ...

For detailed information about ESP32-S2 as well as configuring and compiling RIOT for ESP32-S2 boards, see \ref esp32_riot.

Back to table of contents