Merge branch 'doc/hw-reference/esp32-devkits-r-guide' into 'master'

ESP32-DevKitS-R User Guide

See merge request espressif/esp-idf!7790
This commit is contained in:
Krzysztof Budzynski 2020-03-11 06:43:31 +08:00
commit b9abb78546
13 changed files with 539 additions and 2 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 265 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 380 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 241 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 290 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 413 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 263 KiB

View file

@ -63,7 +63,7 @@ If you have one of ESP32 development boards listed below, you can click on the l
ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit> ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit>
ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit> ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit>
ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit> ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit>
ESP32-DevKit-S(-R) <../hw-reference/esp32/user-guide-devkits-r-v1.1>
.. _get-started-step-by-step-legacy: .. _get-started-step-by-step-legacy:
Installation Step by Step Installation Step by Step

View file

@ -70,12 +70,12 @@ If you have one of {IDF_TARGET_NAME} development boards listed below, you can cl
ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit> ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit>
ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit> ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit>
ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit> ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit>
ESP32-DevKit-S(-R) <../hw-reference/esp32/user-guide-devkits-r-v1.1>
.. only:: esp32s2 .. only:: esp32s2
There are currently no hardware guides available for ESP32-S2. There are currently no hardware guides available for ESP32-S2.
.. _get-started-step-by-step: .. _get-started-step-by-step:
Installation Step by Step Installation Step by Step

View file

@ -0,0 +1,267 @@
=================
ESP32-DevKitS(-R)
=================
:link_to_translation:`zh_CN:[中文]`
This user guide provides information on ESP32-DevKitS(-R), an ESP32-based flashing board produced by Espressif.
ESP32-DevKitS(-R) is a combination of two board names: ESP32-DevKitS and ESP32-DevKitS-R. S stands for springs, and R stands for WROVER.
+-----------------+-------------------+
| |ESP32-DevKitS| | |ESP32-DevKitS-R| |
+-----------------+-------------------+
| ESP32-DevKitS | ESP32-DevKitS-R |
+-----------------+-------------------+
.. |ESP32-DevKitS| image:: ../../../_static/esp32-devkits-v1.1-layout-isometric-raw.png
.. |ESP32-DevKitS-R| image:: ../../../_static/esp32-devkits-r-v1.1-layout-isometric-raw.png
The document consists of the following major sections:
- `Getting Started`_: Provides an overview of ESP32-DevKitS(-R) and hardware/software setup instructions to get started.
- `Hardware Reference`_: Provides more detailed information about ESP32-DevKitS(-R)'s hardware.
- `Related Documents`_: Gives links to related documentation.
Getting Started
===============
This section describes how to get started with ESP32-DevKitS(-R). It begins with a few introductory sections about ESP32-DevKitS(-R), then Section `How to Flash a Board`_ provides instructions on how to mount a module onto ESP32-DevKitS(-R), get it ready, and flash firmware onto it.
Overview
--------
ESP32-DevKitS(-R) is Espressif's flashing board designed specifically for ESP32. It can be used to flash an ESP32 module without soldering the module to the power supply and signal lines. With a module mounted, ESP32-DevKitS(-R) can also be used as a mini development board like ESP32-DevKitC.
ESP32-DevKitS and ESP32-DevKitS-R boards vary only in layout of spring pins to fit the following ESP32 modules.
- ESP32-DevKitS:
- :ref:`esp-modules-and-boards-esp32-wroom-32`
- :ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>`
- :ref:`ESP32-WROOM-32U <esp-modules-and-boards-esp32-wroom-32d-and-u>`
- :ref:`esp-modules-and-boards-esp32-solo-1`
- `ESP32-WROOM-32E <https://www.espressif.com/en/products/hardware/modules>`_
- `ESP32-WROOM-32UE <https://www.espressif.com/en/products/hardware/modules>`_
- ESP32-DevKitS-R:
- :ref:`ESP32-WROVER (PCB & IPEX) <esp-modules-and-boards-esp32-wrover>`
- :ref:`ESP32-WROVER-B (PCB & IPEX) <esp-modules-and-boards-esp32-wrover>`
- `ESP32-WROVER-E <https://www.espressif.com/en/products/hardware/modules>`_
- `ESP32-WROVER-IE <https://www.espressif.com/en/products/hardware/modules>`_
Description of Components
-------------------------
.. figure:: ../../../_static/esp32-devkits-v1.1-layout-front.png
:align: center
:alt: ESP32-DevKitS - front
:figclass: align-center
ESP32-DevKitS - front
.. figure:: ../../../_static/esp32-devkits-r-v1.1-layout-front.png
:align: center
:alt: ESP32-DevKitS-R - front
:figclass: align-center
ESP32-DevKitS-R - front
.. list-table::
:widths: 30 70
:header-rows: 1
* - Key Component
- Description
* - Spring Pins
- Click the module in. The pins will fit into the module's castellated holes.
* - 2.54 mm Female Headers
- These female headers are connected to pins of the module mounted on this board. For description of female headers, please refer to `Header Blocks`_.
* - USB-to-UART Bridge
- Single-chip USB to UART bridge provides transfer rates of up to 3 Mbps.
* - LDO
- 5V-to-3.3V low-dropout voltage regulator (LDO).
* - Micro-USB Connector/Micro USB Port
- USB interface. Power supply for the board as well as the communication interface between a computer and the board.
* - EN Button
- Reset button.
* - Boot Button
- Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port.
* - Power On LED
- Turns on when the USB or power supply is connected to the board.
How to Flash a Board
--------------------
Before powering up your ESP32-DevKitS(-R), please make sure that it is in good condition with no obvious signs of damage.
Required Hardware
^^^^^^^^^^^^^^^^^
- An ESP32 module of your choice
- USB 2.0 cable (Standard-A to Micro-B)
- Computer running Windows, Linux, or macOS
Hardware Setup
^^^^^^^^^^^^^^
Please mount a module of your choice onto your ESP32-DevKitS(-R) according to the following steps:
- Gently put your module on the ESP32-DevKitS(-R) board. Make sure that castellated holes on your module are aligned with spring pins on the board.
- Press your module down into the board until it clicks.
- Check whether all spring pins are inserted into castellated holes. If there are some misaligned spring pins, place them into castellated holes with tweezers.
Software Setup
^^^^^^^^^^^^^^
Preferred Method
++++++++++++++++
The ESP-IDF development framework provides a preferred way of flashing binaries onto ESP32-DevKitS(-R). 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 onto your ESP32-DevKitS(-R).
Alternative Method
++++++++++++++++++
As an alternative, Windows users can flash binaries using the `Flash Download Tool <https://www.espressif.com/en/support/download/other-tools?keys=flash+download+tools>`_. Just download it, unzip it, and follow the instructions inside the *doc* folder.
.. note::
1. To flash binary files, ESP32 should be set to Firmware Download mode. This can be done either by the flash tool automatically, or by holding down the Boot button and tapping the EN button.
2. After flashing binary files, the Flash Download Tool restarts your ESP32 module and boots the flashed application by default.
Board Dimensions
----------------
.. figure:: ../../../_static/esp32-devkits-v1.1-dimensions-back.png
:align: center
:alt: ESP32-DevKitS
:figclass: align-center
ESP32-DevKitS board dimensions - back
.. figure:: ../../../_static/esp32-devkits-r-v1.1-dimensions-back.png
:align: center
:alt: ESP32-DevKitS-R
:figclass: align-center
ESP32-DevKitS-R board dimensions - back
Contents and Packaging
----------------------
Retail orders
^^^^^^^^^^^^^
If you order a few samples, each ESP32-DevKitS(-R) comes in an individual package in either antistatic bag or any packaging depending on a retailer.
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
Wholesale Orders
^^^^^^^^^^^^^^^^
If you order in bulk, the boards come in large cardboard boxes.
For wholesale orders, please check `Espressif Product Ordering Information <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf>`_ (PDF).
Hardware Reference
==================
Block Diagram
-------------
A block diagram below shows the components of ESP32-DevKitS(-R) and their interconnections.
.. figure:: ../../../_static/esp32-devkits-r-v1.1-block_diagram.png
:align: center
:scale: 70%
:alt: ESP32-DevKitS(-R) - block diagram (click to enlarge)
:figclass: align-center
ESP32-DevKitS(-R) (click to enlarge)
Power Supply Options
^^^^^^^^^^^^^^^^^^^^
There are three mutually exclusive ways to provide power to the board:
- Micro USB port, default power supply
- 5V and GND header pins
- 3V3 and GND header pins
It is advised to use the first option: micro USB port.
Header Blocks
-------------
======= ================ ======================================
. Label Signal
======= ================ ======================================
L1 3V3 VDD 3V3
L2 EN CHIP_PU
L3 VP SENSOR_VP
L4 VN SENSOR_VN
L5 34 GPIO34
L6 35 GPIO35
L7 32 GPIO32
L8 33 GPIO33
L9 25 GPIO25
L10 26 GPIO26
L11 27 GPIO27
L12 14 GPIO14
L13 12 GPIO12
L14 GND GND
L15 13 GPIO13
L16 D2 SD_DATA2
L17 D3 SD_DATA3
L18 CMD SD_CMD
L19 5V External 5V
R1 GND GND
R2 23 GPIO23
R3 22 GPIO22
R4 TX U0TXD
R5 RX U0RXD
R6 21 GPIO21
R7 GND GND
R8 19 GPIO19
R9 18 GPIO18
R10 5 GPIO5
R11 17 GPIO17
R12 16 GPIO16
R13 4 GPIO4
R14 0 GPIO0
R15 2 GPIO2
R16 15 GPIO15
R17 D1 SD_DATA1
R18 D0 SD_DATA0
R19 CLK SD_CLK
======= ================ ======================================
For the image of header blocks, please refer to `Description of Components`_.
Related Documents
=================
- `ESP32-DevKitS(-R) Schematics <https://dl.espressif.com/dl/ESP32_DEVKITS_20190621.pdf>`_ (PDF)
- `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
- `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ (PDF)
- `ESP32-WROOM-32D & ESP32-WROOM-32U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_en.pdf>`_ (PDF)
- `ESP32-SOLO-1 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-solo-1_datasheet_en.pdf>`_ (PDF)
- `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
- `ESP32-WROVER-B Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_en.pdf>`_ (PDF)
- `Espressif Product Ordering Information <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf>`_ (PDF)

View file

@ -61,6 +61,7 @@ ESP32 采用 40 nm 工艺制成,具有最佳的功耗性能、射频性能、
ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit> ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit>
ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit> ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit>
ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit> ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit>
ESP32-DevKit-S(-R) <../hw-reference/esp32/user-guide-devkits-r-v1.1>
.. _get-started-step-by-step-legacy: .. _get-started-step-by-step-legacy:

View file

@ -72,6 +72,7 @@
ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit> ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit>
ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit> ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit>
ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit> ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit>
ESP32-DevKit-S(-R) <../hw-reference/esp32/user-guide-devkits-r-v1.1>
.. _get-started-step-by-step: .. _get-started-step-by-step:

View file

@ -0,0 +1,268 @@
=================
ESP32-DevKitS(-R)
=================
:link_to_translation:`en: [English]`
本指南介绍了乐鑫专为 ESP32 设计的烧录底板 ESP32-DevKitS(-R)。
ESP32-DevKitS(-R) 包括两款开发板,分别是 ESP32-DevKitS 和 ESP32-DevKitS-R。S 代表弹簧 (spring)R 代表 WROVER 模组。
+-----------------+-------------------+
| |ESP32-DevKitS| | |ESP32-DevKitS-R| |
+-----------------+-------------------+
| ESP32-DevKitS | ESP32-DevKitS-R |
+-----------------+-------------------+
.. |ESP32-DevKitS| image:: ../../../_static/esp32-devkits-v1.1-layout-isometric-raw.png
.. |ESP32-DevKitS-R| image:: ../../../_static/esp32-devkits-r-v1.1-layout-isometric-raw.png
本指南包括如下内容:
- `入门指南`_: 简要介绍了 ESP32-DevKitS(-R) 和硬件、软件设置指南。
- `硬件参考`_: 详细介绍了 ESP32-DevKitS(-R) 的硬件。
- `相关文档`_: 列出了相关文档的链接。
入门指南
========
本节介绍了如何快速上手 ESP32-DevKitS(-R)。 开头部分介绍了 ESP32-DevKitS(-R)`如何烧录开发板`_ 小节介绍了怎样在 ESP32-DevKitS(-R) 上安装模组、配置及烧录固件。
概述
----
ESP32-DevKitS(-R) 是乐鑫专为 ESP32 设计的烧录底板,无需将 ESP32 模组与电源和信号线焊接便可进行烧录。ESP32-DevKitS(-R) 搭载模组后,可作为类似 ESP32-DevKitC 的小型开发板使用。
ESP32-DevKitS 和 ESP32-DevKitS-R 仅在弹簧布局上有所不同,用于适配不同的 ESP32 模组。
- ESP32-DevKitS:
- :ref:`esp-modules-and-boards-esp32-wroom-32`
- :ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>`
- :ref:`ESP32-WROOM-32U <esp-modules-and-boards-esp32-wroom-32d-and-u>`
- :ref:`esp-modules-and-boards-esp32-solo-1`
- `ESP32-WROOM-32E <https://www.espressif.com/en/products/hardware/modules>`_
- `ESP32-WROOM-32UE <https://www.espressif.com/en/products/hardware/modules>`_
- ESP32-DevKitS-R:
- :ref:`ESP32-WROVER (PCB & IPEX) <esp-modules-and-boards-esp32-wrover>`
- :ref:`ESP32-WROVER-B (PCB & IPEX) <esp-modules-and-boards-esp32-wrover>`
- `ESP32-WROVER-E <https://www.espressif.com/en/products/hardware/modules>`_
- `ESP32-WROVER-IE <https://www.espressif.com/en/products/hardware/modules>`_
组件介绍
--------
.. figure:: ../../../_static/esp32-devkits-v1.1-layout-front.png
:align: center
:alt: ESP32-DevKitS - 正面
:figclass: align-center
ESP32-DevKitS - 正面
.. figure:: ../../../_static/esp32-devkits-r-v1.1-layout-front.png
:align: center
:alt: ESP32-DevKitS-R - 正面
:figclass: align-center
ESP32-DevKitS-R - 正面
.. list-table::
:widths: 30 70
:header-rows: 1
* - 主要组件
- 介绍
* - 引脚弹簧
- 适配模组上的邮票孔,用于连接和固定模组。
* - 2.54 mm 排母
- 连接板上搭载模组的引脚。关于排母的描述,请见 `针座`_ 小节。
* - USB-to-UART 桥接器
- 单芯片 USB 转 UART 桥接器,可提供高达 3 Mbps 的传输速率。
* - LDO
- 5V-to-3.3V 低压差线型稳压器 (LDO)。
* - Micro-USB 连接器/Micro USB 端口
- USB 接口。可用作开发板的供电电源或连接电脑和开发板的通信接口。
* - EN 键
- 复位按键。
* - Boot 键
- 下载按键。按住 **Boot** 键的同时按一下 **EN** 键进入“固件下载”模式,通过串口下载固件。
* - 电源指示 LED
- 开发板通电后USB 或供电电源),该指示灯亮起。
如何烧录开发板
--------------
通电前,请确保 ESP32-DevKitS(-R) 完好无损。
必备硬件
^^^^^^^^
- 任选一款 ESP32 模组
- USB 2.0 数据线(标准 A 型转 Micro-B 型)
- 电脑 Windows、Linux 或 macOS
硬件设置
^^^^^^^^
请按照下列步骤将模组安装到 ESP32-DevKitS(-R) 烧录底板上:
- 将模组轻放到 ESP32-DevKitS(-R) 烧录底板上。确保模组上方的邮票孔与底板上的引脚弹簧对齐。
- 将模组向下压,听到“咔哒”一声即说明模组已经压入底板。
- 检查所有引脚弹簧是否均已卡进邮票孔中。如发现错位,可使用镊子将引脚弹簧拨入邮票孔中。
软件设置
^^^^^^^^
首选方式
++++++++
使用 ESP-IDF 开发框架是将二进制文件 (\*.bin) 烧录到 ESP32-DevKitS(-R) 的首选方式。请前往 :doc:`../../get-started/index`,在 :ref:`get-started-step-by-step` 一节查看如何快速设置开发环境,将应用程序烧录至 ESP32-DevKitS(-R)。
备选方式
++++++++
Windows 用户也可以使用 `Flash 下载工具 <https://www.espressif.com/zh-hans/support/download/other-tools?keys=FLASH+>`_ 烧录二进制文件。请下载该工具、解压并参照 *doc* 文件夹内的使用指南。
.. 注解::
1. 烧录二进制文件时需将 ESP32 芯片设置成固件下载模式。这一步骤可由烧录工具自动执行,也可按住 Boot 按键并点按 EN 按键手动执行。
2. 烧录完成后,烧录工具默认情况下会重启模组,运行已烧录的程序。
底板尺寸
--------
.. figure:: ../../../_static/esp32-devkits-v1.1-dimensions-back.png
:align: center
:alt: ESP32-DevKitS - 背面
:figclass: align-center
ESP32-DevKitS 尺寸 - 背面
.. figure:: ../../../_static/esp32-devkits-r-v1.1-dimensions-back.png
:align: center
:alt: ESP32-DevKitS-R - 背面
:figclass: align-center
ESP32-DevKitS-R 尺寸 - 背面
内含组件和包装
--------------
零售订单
^^^^^^^^
如购买样品,每个 ESP32-DevKitS(-R) 底板将以防静电袋或零售商选择的其他方式包装。
零售订单请前往 https://www.espressif.com/zh-hans/company/contact/buy-a-sample。
批量订单
^^^^^^^^
如批量购买ESP32-DevKitS(-R) 烧录底板将以大纸板箱包装。
批量订单请参考 `乐鑫产品订购信息 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf>`__ (PDF)。
硬件参考
========
功能框图
--------
ESP32-DevKitS(-R) 的主要组件和连接方式如下图所示。
.. figure:: ../../../_static/esp32-devkits-r-v1.1-block_diagram.png
:align: center
:scale: 70%
:alt: ESP32-DevKitS(-R)(点击放大)
:figclass: align-center
ESP32-DevKitS(-R)(点击放大)
电源选项
^^^^^^^^
您可从以下三种供电方式中任选其一给 ESP32-DevKitS(-R) 供电:
- Micro USB 端口供电(默认)
- 5V 和 GND 管脚供电
- 3V3 和 GND 管脚供电
建议选择第一种供电方式Micro USB 端口供电。
针座
----
======= ================ ================================
. 标签 信号
======= ================ ================================
L1 3V3 VDD 3V3
L2 EN CHIP_PU
L3 VP SENSOR_VP
L4 VN SENSOR_VN
L5 34 GPIO34
L6 35 GPIO35
L7 32 GPIO32
L8 33 GPIO33
L9 25 GPIO25
L10 26 GPIO26
L11 27 GPIO27
L12 14 GPIO14
L13 12 GPIO12
L14 GND GND
L15 13 GPIO13
L16 D2 SD_DATA2
L17 D3 SD_DATA3
L18 CMD SD_CMD
L19 5V External 5V
R1 GND GND
R2 23 GPIO23
R3 22 GPIO22
R4 TX U0TXD
R5 RX U0RXD
R6 21 GPIO21
R7 GND GND
R8 19 GPIO19
R9 18 GPIO18
R10 5 GPIO5
R11 17 GPIO17
R12 16 GPIO16
R13 4 GPIO4
R14 0 GPIO0
R15 2 GPIO2
R16 15 GPIO15
R17 D1 SD_DATA1
R18 D0 SD_DATA0
R19 CLK SD_CLK
======= ================ ================================
针座图片请参照 `组件介绍`_
相关文档
========
- `ESP32-DevKitS(-R) 原理图 <https://dl.espressif.com/dl/ESP32_DEVKITS_20190621.pdf>`_ (PDF)
- `ESP32 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)
- `ESP32-WROOM-32 技术规格书 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.pdf>`_ (PDF)
- `ESP32-WROOM-32D & ESP32-WROOM-32U 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_cn.pdf>`_ (PDF)
- `ESP32-SOLO-1 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-solo-1_datasheet_cn.pdf>`_ (PDF)
- `ESP32-WROVER 技术规格书 <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_cn.pdf>`_ (PDF)
- `ESP32-WROVER-B 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_cn.pdf>`_ (PDF)
- `乐鑫产品订购信息 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`__ (PDF)