Skip to content

Commit

Permalink
Merge branch 'docs/upgrade_s2-devkit-m-1_user_guide_for_eco1' into 'm…
Browse files Browse the repository at this point in the history
…aster'

Docs: Updated ESP32-S2-DevKitM-1 User Guide for ECO1

See merge request espressif/esp-idf!19592
  • Loading branch information
espwangning committed Sep 20, 2022
2 parents 1cfd20c + 9246600 commit 1eea24c
Show file tree
Hide file tree
Showing 5 changed files with 177 additions and 77 deletions.
Binary file modified docs/_static/esp32-s2-devkitm-1-v1-block-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/en/get-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ If you have one of {IDF_TARGET_NAME} official development boards listed below, y
:maxdepth: 1

ESP32-S2-Saola-1 <../hw-reference/esp32s2/user-guide-saola-1-v1.2>
ESP32-S2-DevKitM-1(U) <../hw-reference/esp32s2/user-guide-devkitm-1-v1>
ESP32-S2-DevKitM-1 <../hw-reference/esp32s2/user-guide-devkitm-1-v1>
ESP32-S2-DevKitC-1 <../hw-reference/esp32s2/user-guide-s2-devkitc-1>
ESP32-S2-Kaluga-Kit <../hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit>

Expand Down
124 changes: 87 additions & 37 deletions docs/en/hw-reference/esp32s2/user-guide-devkitm-1-v1.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
=====================
ESP32-S2-DevKitM-1(U)
=====================
==================
ESP32-S2-DevKitM-1
==================

:link_to_translation:`zh_CN:[中文]`

This user guide provides information on Espressif's small-sized development board ESP32-S2-DevKitM-1(U).
This user guide provides information on Espressif's small-sized development board ESP32-S2-DevKitM-1.

ESP32-S2-DevKitM-1(U) is a general-purpose development board based on `ESP32-S2FH4 <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf>`__ chip, which falls into ESP32-S2 chip series. With a rich peripheral set and optimized pinout, this board allows rapid prototyping.

ESP32-S2-DevKitM-1 is embedded with `ESP32-S2-MINI-1 <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`__ module (on-board PCB antenna), while ESP32-S2-DevKitM-1U with `ESP32-S2-MINI-1U <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`__ module (external antenna connector).
ESP32-S2-DevKitM-1 is entry-level development board. Most of the I/O pins on the module are broken out to the pin headers on both sides for easy interfacing. Developers can either connect peripherals with jumper wires or mount ESP32-S2-DevKitM-1 on a breadboard.

+----------------------+-----------------------+
| |ESP32-S2-DevKitM-1| | |ESP32-S2-DevKitM-1U| |
Expand All @@ -22,32 +20,80 @@ ESP32-S2-DevKitM-1 is embedded with `ESP32-S2-MINI-1 <https://www.espressif.com/

The document consists of the following major sections:

- `Getting started`_: Provides an overview of the ESP32-S2-DevKitM-1(U) and hardware/software setup instructions to get started.
- `Hardware reference`_: Provides more detailed information about the ESP32-S2-DevKitM-1(U)'s hardware.
- `Hardware Revision Details`_: Revision history, known issues, and links to user guides for previous versions (if any) of ESP32-S2-DevKitM-1(U).
- `Getting started`_: Provides an overview of the ESP32-S2-DevKitM-1 and hardware/software setup instructions to get started.
- `Hardware reference`_: Provides more detailed information about the ESP32-S2-DevKitM-1's hardware.
- `Hardware Revision Details`_: Revision history, known issues, and links to user guides for previous versions (if any) of ESP32-S2-DevKitM-1.
- `Related Documents`_: Gives links to related documentation.

Getting Started
===============

This section describes how to get started with ESP32-S2-DevKitM-1(U). It begins with a few introductory sections about the ESP32-S2-DevKitM-1(U), then Section `Start Application Development`_ provides instructions on how to get the ESP32-S2-DevKitM-1(U) ready and flash firmware into it.

Overview
--------

ESP32-S2-DevKitM-1(U) is entry-level development board equipped with either ESP32-S2-MINI-1 or ESP32-S2-MINI-1U module. Most of the I/O pins on the module are broken out to the pin headers on both sides for easy interfacing. Developers can either connect peripherals with jumper wires or mount ESP32-S2-DevKitM-1(U) on a breadboard.
This section describes how to get started with ESP32-S2-DevKitM-1. It begins with a few introductory sections about the ESP32-S2-DevKitM-1, then Section `Start Application Development`_ provides instructions on how to get the ESP32-S2-DevKitM-1 ready and flash firmware into it.

Contents and Packaging
----------------------

.. _user-guide-s2-devkitm-1-v1-ordering-info:

Ordering Information
^^^^^^^^^^^^^^^^^^^^

The development board has a variety of variants to choose from, as shown in the table below.

.. list-table::
:header-rows: 1
:widths: 41 24 9 8 18

* - Ordering Code
- On-board Module [#]_
- Flash
- PSRAM
- Antenna
* - ESP32-S2-DevKitM-1-N4R2
- ESP32-S2-MINI-2

(Recommended)
- 4 MB
- 2 MB
- PCB on-board antenna
* - ESP32-S2-DevKitM-1U-N4R2
- ESP32-S2-MINI-2U

(Recommended)
- 4 MB
- 2 MB
- External antenna connector
* - ESP32-S2-DevKitM-1
- ESP32-S2-MINI-1
- 4 MB
- ---
- PCB on-board antenna
* - ESP32-S2-DevKitM-1U
- ESP32-S2-MINI-1U
- 4 MB
- ---
- External antenna connector
* - ESP32-S2-DevKitM-1R
- ESP32-S2-MINI-1
- 4 MB
- 2 MB
- PCB on-board antenna
* - ESP32-S2-DevKitM-1RU
- ESP32-S2-MINI-1U
- 4 MB
- 2 MB
- External antenna connector


.. [#] The ESP32-S2-MINI-2 and ESP32-S2-MINI-2U modules use chip revision v1.0, and the rest use chip revision v0.0. For more information about chip revisions, please refer to `ESP32-S2 Series SoC Errata`_.
Retail orders
^^^^^^^^^^^^^

If you order a few samples, each ESP32-S2-DevKitM-1(U) comes in an individual package in either antistatic bag or any packaging depending on your retailer.
If you order a few samples, each ESP32-S2-DevKitM-1 comes in an individual package in either antistatic bag or any packaging depending on your retailer.

For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.


Wholesale Orders
^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -82,8 +128,8 @@ The key components of the board are described in a clockwise direction.

* - Key Component
- Description
* - ESP32-S2-MINI-1 or ESP32-S2-MINI-1U
- ESP32-S2-MINI-1 and ESP32-S2-MINI-1U are two powerful, generic Wi-Fi MCU modules that integrate ESP32-S2FH4 chip. ESP32-S2-MINI-1 comes with a PCB antenna, and ESP32-S2-MINI-1U with an external antenna connector. They both feature a 4 MB external SPI flash.
* - On-board module (ESP32-S2-MINI-1 or ESP32-S2-MINI-1U in figures above)
- ESP32-S2-MINI series modules with an on-board PCB antenna or a connector for an external antenna. This series of modules, known for its small size, have a flash and/or a PSRAM integrated in the chip package. For more information, please refer to :ref:`user-guide-s2-devkitm-1-v1-ordering-info`.
* - Pin Headers
- All available GPIO pins (except for the SPI bus for flash) are broken out to the pin headers on the board. Users can program ESP32-S2FH4 chip to enable multiple functions such as SPI, I2S, UART, I2C, touch sensors, PWM etc. For details, please see :ref:`user-guide-devkitm-1-v1-header-blocks`.
* - 3.3 V Power On LED
Expand All @@ -101,20 +147,17 @@ The key components of the board are described in a clockwise direction.
* - 5 V to 3.3 V LDO
- Power regulator that converts a 5 V supply into a 3.3 V output.
* - External Antenna Connector
- On **ESP32-S2-MINI-1U** module only. For connector dimensions, please refer to Section External Antenna Connector Dimensions in `ESP32-S2-MINI-1 & ESP32-S2-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`_.
- On **ESP32-S2-MINI-2U** and **ESP32-S2-MINI-1U** module only. For connector dimensions, please refer to Section External Antenna Connector Dimensions in module datasheet.

Start Application Development
-----------------------------

Before powering up your ESP32-S2-DevKitM-1(U), please make sure that it is in good condition with no obvious signs of damage.
Before powering up your ESP32-S2-DevKitM-1, please make sure that it is in good condition with no obvious signs of damage.

Required Hardware
^^^^^^^^^^^^^^^^^

- ESP32-S2-DevKitM-1(U)

+ For ESP32-S2-DevKitM-1U, an antenna is also required.

- ESP32-S2-DevKitM-1
- USB 2.0 cable (Standard-A to Micro-B)
- Computer running Windows, Linux, or macOS

Expand All @@ -125,7 +168,7 @@ Required Hardware
Software Setup
^^^^^^^^^^^^^^

Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment and then flash an application example into your ESP32-S2-DevKitM-1(U).
Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment and then flash an application example into your ESP32-S2-DevKitM-1.

.. note::

Expand All @@ -142,10 +185,10 @@ A block diagram below shows the components of ESP32-S2-DevKitM-1 and their inter
.. figure:: ../../../_static/esp32-s2-devkitm-1-v1-block-diagram.png
:align: center
:scale: 70%
:alt: ESP32-S2-DevKitM-1(U) (click to enlarge)
:alt: ESP32-S2-DevKitM-1 (click to enlarge)
:figclass: align-center

ESP32-S2-DevKitM-1(U) (click to enlarge)
ESP32-S2-DevKitM-1 (click to enlarge)

Power Supply Options
^^^^^^^^^^^^^^^^^^^^
Expand All @@ -163,7 +206,7 @@ It is recommended to use the first option: Micro-USB Port.
Header Block
------------

The two tables below provide the **Name** and **Function** of the pin headers on both sides of the board (J1 and J3). The pin header names are shown in :ref:`user-guide-devkitm-1-v1-board-front`. The numbering is the same as in the `ESP32-S2-DevKitM-1(U) Schematics <https://dl.espressif.com/dl/schematics/ESP32-S2-DevKitM-1_V1_Schematics.pdf>`_ (PDF).
The two tables below provide the **Name** and **Function** of the pin headers on both sides of the board (J1 and J3). The pin header names are shown in :ref:`user-guide-devkitm-1-v1-board-front`. The numbering is the same as in the `ESP32-S2-DevKitM-1 Schematics <https://dl.espressif.com/dl/schematics/ESP32-S2-DevKitM-1_V1_Schematics.pdf>`_ (PDF).

J1
^^^
Expand Down Expand Up @@ -228,10 +271,10 @@ Pin Layout
.. figure:: ../../../_static/esp32-s2-devkitm-1-v1-pin-layout.png
:align: center
:scale: 15%
:alt: ESP32-S2-DevKitM-1(U) (click to enlarge)
:alt: ESP32-S2-DevKitM-1 (click to enlarge)
:figclass: align-center

ESP32-S2-DevKitM-1(U) Pin Layout (click to enlarge)
ESP32-S2-DevKitM-1 Pin Layout (click to enlarge)

Hardware Revision Details
=========================
Expand All @@ -240,11 +283,18 @@ This is the first revision of this board released.

Related Documents
=================
* `ESP32-S2-DevKitM-1(U) Schematics <https://dl.espressif.com/dl/schematics/ESP32-S2-DevKitM-1_V1_Schematics.pdf>`_ (PDF)
* `ESP32-S2-DevKitM-1(U) PCB Layout <https://dl.espressif.com/dl/schematics/ESP32-S2-DevKitM-1_V1_PCB_Layout.pdf>`_ (PDF)
* `ESP32-S2-DevKitM-1(U) Dimensions <https://dl.espressif.com/dl/schematics/ESP32-S2-DevKitM-1_V1_Dimensions.pdf>`_ (PDF)
* `ESP32-S2 Series Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf>`_ (PDF)
* `ESP32-S2-MINI-1 & ESP32-S2-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`_ (PDF)
* `ESP32-S2 Series Chip Revision v1.0 Datasheet`_ (PDF)
* `ESP32-S2 Series Chip Revision v0.0 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf>`_ (PDF)
* `ESP32-S2 Series SoC Errata`_ (PDF)
* `ESP32-S2-MINI-2 & ESP32-S2-MINI-2U Module Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-2_esp32-s2-mini-2u_datasheet_en.pdf>`_ (PDF)
* `ESP32-S2-MINI-1 & ESP32-S2-MINI-1U Module Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`_ (PDF)
* `ESP32-S2-DevKitM-1 Schematics <https://dl.espressif.com/dl/schematics/ESP32-S2-DevKitM-1_V1_Schematics.pdf>`_ (PDF)
* `ESP32-S2-DevKitM-1 PCB Layout <https://dl.espressif.com/dl/schematics/ESP32-S2-DevKitM-1_V1_PCB_Layout.pdf>`_ (PDF)
* `ESP32-S2-DevKitM-1 Dimensions <https://dl.espressif.com/dl/schematics/ESP32-S2-DevKitM-1_V1_Dimensions.pdf>`_ (PDF)
* `ESP Product Selector <https://products.espressif.com/#/product-selector?names=>`_

For other design documentation for the board, please contact us at `[email protected] <[email protected]>`_.

.. _NRND: https://www.espressif.com/en/products/longevity-commitment?id=nrnd
.. _ESP32-S2 Series Chip Revision v1.0 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-s2-v1.0_datasheet_en.pdf
.. _ESP32-S2 Series SoC Errata: https://espressif.com/sites/default/files/documentation/esp32-s2_errata_en.pdf
2 changes: 1 addition & 1 deletion docs/zh_CN/get-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
:maxdepth: 1

ESP32-S2-Saola-1 <../hw-reference/esp32s2/user-guide-saola-1-v1.2>
ESP32-S2-DevKitM-1(U) <../hw-reference/esp32s2/user-guide-devkitm-1-v1>
ESP32-S2-DevKitM-1 <../hw-reference/esp32s2/user-guide-devkitm-1-v1>
ESP32-S2-DevKitC-1 <../hw-reference/esp32s2/user-guide-s2-devkitc-1>
ESP32-S2-Kaluga-Kit <../hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit>

Expand Down
Loading

0 comments on commit 1eea24c

Please sign in to comment.