Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge branch 'feature/update_board_guides_for_headers' into 'master'

Browse source 
Feature/update board guides for headers

See merge request idf/esp-idf!3590
This commit is contained in:
Angus Gratton 2018-11-12 09:15:29 +08:00
commit 521fb5d906
8 changed files with 49 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/_static/esp32-devkitc-functional-overview-f.jpeg vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 227 KiB

BIN
docs/_static/esp32-devkitc-v4-dimensions-back.jpeg vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 172 KiB

BIN
docs/_static/esp32-pico-kit-v4.1-dimensions-back.jpeg vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 246 KiB

BIN
docs/_static/esp32-pico-kit-v4.1-f-layout.jpeg vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 216 KiB

23
docs/en/get-started/get-started-devkitc.rst
View file

@ -16,18 +16,22 @@ What You Need
Overview
--------
ESP32-DevKitC V4 is a small-sized ESP32-based development board produced by `Espressif <https://espressif.com>`_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can connect these pins to peripherals as needed. Standard headers also make development easy and convenient when using a breadboard.
ESP32-DevKitC V4 is a small-sized ESP32-based development board produced by `Espressif <https://espressif.com>`_. Most of the I/O pins are broken out to the female pin headers on both sides for easy interfacing. Developers can connect these pins to peripherals as needed. Standard female headers also make development easy and convenient when using Dupont wires.
The board supports various ESP32 modules, including :ref:`esp-modules-and-boards-esp32-wroom-32`, :ref:`ESP32-WROOM-32U <esp-modules-and-boards-esp32-wroom-32d-and-u>`, :ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>`, :ref:`esp-modules-and-boards-esp32-solo-1`, and :ref:`esp-modules-and-boards-esp32-wrover` series.
.. note::
Espressif also provides several variants of ESP32-DevKitC that come with specific ESP32 module and female or male pin headers, supporting different requirements of different users. For details please refer to `Espressif Product Ordering Information`_.
Functional Description
----------------------
The following list and figure below describe key components, interfaces and controls of ESP32-DevKitC V4 board.
ESP32-WROOM-32
:ref:`esp-modules-and-boards-esp32-wroom-32` module soldered to the ESP32-DevKitC V4 board.
ESP32-WROOM-32D
:ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>` soldered to the ESP32-DevKitC V4 board.
Optional Space for ESP32-WROVER
Longer :ref:`esp-modules-and-boards-esp32-wrover` modules may be soldered instead of the ESP32-WROOM-32.
USB-to-UART Bridge
@ -38,10 +42,10 @@ EN Button
Reset button: pressing this button resets the system.
Micro USB Port
USB interface. It functions as the power supply for the board and the communication interface between PC and the ESP module.
5V Power On LED
This LED lights when the USB or an external 5V power supply is applied to the board. For details see schematic in `Related Documents`_.
Power On LED
Turns on when the power supply is applied to the board. For details see schematic in `Related Documents`_.
I/O Connector
Most of the pins on the ESP module are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
Most of the pins on the ESP module are broken out to the female pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
.. note::
@ -49,12 +53,12 @@ I/O Connector
.. _get-started-esp32-devkitc-board-front:
.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg
.. figure:: ../../_static/esp32-devkitc-functional-overview-f.jpeg
:align: center
:alt: ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
:figclass: align-center
ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
ESP32-DevKitC V4 with ESP32-WROOM-32D module soldered
Power Supply Options
@ -106,7 +110,7 @@ To start development of applications, proceed to section :doc:`index`, that will
Board Dimensions
----------------
.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg
.. figure:: ../../_static/esp32-devkitc-v4-dimensions-back.jpeg
:align: center
:alt: ESP32-DevKitC board dimensions - back
:figclass: align-center
@ -121,6 +125,7 @@ Related Documents
* `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/U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_en.pdf>`_ (PDF)
* `Espressif Product Ordering Information <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf>`_ (PDF)
.. toctree::

28
docs/en/get-started/get-started-pico-kit.rst
View file

@ -26,11 +26,12 @@ ESP32-PICO-KIT is a mini development board produced by `Espressif <https://espre
The development board integrates a USB-UART Bridge circuit, allowing the developers to connect the board to a PC's USB port for downloads and debugging.
For easy interfacing, all the IO signals and system power on ESP32-PICO-D4 are led out through two rows of 20 x 0.1" pitch header pads on both sides of the development board. To make the ESP32-PICO-KIT fit into mini breadboards, the header pads are populated with two rows of 17 pin headers. Remaining 2 x 3 pads grouped on each side of the board besides the antenna are not populated. The remaining 2 x 3 pin headers may be soldered later by the user.
For easy interfacing, all the IO signals and system power on ESP32-PICO-D4 are led out through two rows of 20 x 0.1" pitch header pads on both sides of the development board. To make the ESP32-PICO-KIT easier for Dupont wires, 2 x 17 header pads are populated with two rows of female pin headers. The remaining 2 x 3 header pads grouped on each side of the board besides the antenna are not populated, and may be populated later by the user if required.
.. note::
The 2 x 3 pads not populated with pin headers are internally connected to the flash memory embedded in the ESP32-PICO-D4 SiP module. For more details see module's datasheet in `Related Documents`_.
1. The 2 x 3 pads not populated with female pin headers are internally connected to the flash memory embedded in the ESP32-PICO-D4 SiP module. For more details see module's datasheet in `Related Documents`_.
2. Earlier versions of ESP32-PICO-KIT come with male headers by default.
The board dimensions are 52 x 20.3 x 10 mm (2.1" x 0.8" x 0.4"), see section `Board Dimensions`_. An overview functional block diagram is shown below.
@ -55,18 +56,18 @@ USB-UART Bridge
A single chip USB-UART bridge: CP2102 in V4 of the board and CP2102N in V4.1. The first provides up to 1 Mbps transfer rates, while the latter up to 3 Mbps transfers rates.
Micro USB Port
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32-PICO-KIT.
5V Power On LED
This light emitting diode lits when the USB or an external 5V power supply is applied to the board. For details see schematic in `Related Documents`_.
Power On LED
Turns on when the power supply is applied to the board. For details see schematic in `Related Documents`_.
I/O
All the pins on ESP32-PICO-D4 are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc. For details please see section `Pin Descriptions`_.
All the pins on ESP32-PICO-D4 are broken out to the female pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc. For details please see section `Pin Descriptions`_.
BOOT Button
Holding down the Boot button and pressing the EN button initiates the firmware download mode. Then user can download firmware through the serial port.
EN Button
Reset button; pressing this button resets the system.
Reset button: pressing this button resets the system.
.. _get-started-pico-kit-v4-board-front:
.. figure:: ../../_static/esp32-pico-kit-v4.1-layout.jpg
.. figure:: ../../_static/esp32-pico-kit-v4.1-f-layout.jpeg
:align: center
:alt: ESP32-PICO-KIT board layout
:figclass: align-center
@ -104,7 +105,7 @@ To start development of applications, proceed to section :doc:`index`, that will
Pin Descriptions
----------------
The two tables below provide the **Name** and **Function** of I/O headers on both sides of the board, see :ref:`get-started-pico-kit-v4-board-front`. The pin numbering and header names are the same as on a schematic in `Related Documents`_.
The two tables below provide the **Name** and **Function** of I/O female headers on both sides of the board, see :ref:`get-started-pico-kit-v4-board-front`. The pin numbering and header names are the same as on a schematic in `Related Documents`_.
Header J2
@ -187,21 +188,14 @@ No. Name Type Function
Board Dimensions
----------------
.. figure:: ../../_static/esp32-pico-kit-v4.1-dimensions-back.jpg
.. figure:: ../../_static/esp32-pico-kit-v4.1-dimensions-back.jpeg
:align: center
:alt: ESP32-PICO-KIT dimensions - back
:figclass: align-center
ESP32-PICO-KIT dimensions - back
.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-side.jpg
:align: center
:alt: ESP32-PICO-KIT dimensions - side
:figclass: align-center
ESP32-PICO-KIT dimensions - side
For the board physical construction details please refer to Reference Design listed below.
For the board physical construction details, please refer to Reference Design listed below.
Related Documents

21
docs/zh_CN/get-started/get-started-devkitc.rst
View file

@ -2,7 +2,7 @@ ESP32-DevKitC V4 入门指南
======================================
:link_to_translation:`en:[English]`
本指南介绍了如何开始使用 ESP32-DevKitC V4 开发板。有关 ESP32-DevKitC 其他版本的介绍，请见：`../hw-reference/index`。
本指南介绍了如何开始使用 ESP32-DevKitC V4 开发板。有关 ESP32-DevKitC 其他版本的介绍，请见：:doc:`../hw-reference/index`。
准备工作
-------------
@ -15,16 +15,20 @@ ESP32-DevKitC V4 入门指南
简介
--------
ESP32-DevKitC V4 是一款来自 `乐鑫 <https://espressif.com>`_ 的迷你开发板，板上模组的绝大部分管脚均已引出，可根据用户需求，轻松连接多种外围器件。此外，本开发板还采用了标准排针，可便利面包板的使用。
ESP32-DevKitC V4 是一款来自 `乐鑫 <https://espressif.com>`_ 的迷你开发板，板上模组的绝大部分管脚均已引出，可根据用户需求，轻松连接多种外围器件。此外，本开发板还采用了标准排母，可便利杜邦线的使用。
本开发板可支持多款 ESP32 模组，包括 :ref:`esp-modules-and-boards-esp32-wroom-32`，:ref:`ESP32-WROOM-32U <esp-modules-and-boards-esp32-wroom-32d-and-u>`，:ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>`，:ref:`esp-modules-and-boards-esp32-solo-1` 及 :ref:`esp-modules-and-boards-esp32-wrover` 系列。
.. note::
乐鑫还同时提供多种 ESP32-DevKitC 型号，采用不同模组或排针/排母设计，用户可按需选择。更多详情，请见 `乐鑫产品订购信息`_ 。
功能说明
----------------------
ESP32-DevKitC V4 开发板的主要组件、接口及控制方式如下文所示。
ESP32-WROOM-32
ESP32-DevKitC V4 开发板上焊接的标准 :ref:`esp-modules-and-boards-esp32-wroom-32` 模组。
ESP32-WROOM-32D
ESP32-DevKitC V4 开发板上焊接的标准 :ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>` 模组。
额外空间
本开发板的还预留了部分额外空间，用于焊接其他 ESP32-WROOM-32 之外的较长模组，比如 :ref:`esp-modules-and-boards-esp32-wrover` 模组。
@ -41,8 +45,8 @@ EN 按键
Micro USB 端口
USB 接口，可用作电路板的供电电源，或连接 PC 端的通信接口。
5V LED 电源指示灯
更多信息，请见 `相关文档`_ 中的原理图。
LED 电源指示灯
开发板通电后（USB 或外部 5 V），该指示灯将亮起。更多信息，请见 `相关文档`_ 中的原理图。
I/O 连接器
ESP32-DevKitC V4 迷你开发板，板上模组的绝大部分管脚均已引出。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。
@ -53,12 +57,12 @@ I/O 连接器
.. _get-started-esp32-devkitc-board-front:
.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg
.. figure:: ../../_static/esp32-devkitc-functional-overview-f.jpeg
:align: center
:alt: ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
:figclass: align-center
图为 ESP32-DevKitC V4（贴 ESP32-WROOM-32）
图为 ESP32-DevKitC V4（贴 ESP32-WROOM-32D）
电源选项
@ -124,6 +128,7 @@ ESP32-DevKitC 上电前，请首先确认电路板完好无损。
* `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/U 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_cn.pdf>`_ (PDF)
* `乐鑫产品订购信息 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`_ (PDF)
.. toctree::

29
docs/zh_CN/get-started/get-started-pico-kit.rst
View file

@ -22,17 +22,18 @@ ESP32-PICO-KIT V4 是一款来自 `乐鑫 <https://espressif.com>`_ 的开发板
ESP32-PICO-KIT V4 集成了一个 USB-UART 桥接电路，可连接至 PC 的 USB 端口进行下载和调试。
为了便于连接，ESP32-PICO-D4 上的所有 IO 信号和系统电源管脚均通过开发板两侧的排针（每侧 20 个 x 0.1 英寸间隔）引出。为了方便在微型面包板上的使用，ESP32-PICO-KIT V4 开发板每侧的 20 个管脚中，有 17 个引出了排针，另外 3 个靠近天线的管脚不引出，可供用户最后焊接使用。
为了便于连接，ESP32-PICO-D4 上的所有 IO 信号和系统电源管脚均通过开发板两侧焊盘（每侧 20 个 x 0.1 英寸间隔）引出。为了方便杜邦线的使用，ESP32-PICO-KIT V4 开发板每侧的 20 个焊盘中，有 17 个引出至排母，另外 3 个靠近天线的焊盘未引出，可供用户日后焊接使用。
.. note::
每排未引出排针的 3 个管脚已连接至 ESP32-PICO-D4 SIP 模组的内置 flash 模块。更多信息，请见 `相关文档`_ 中的模组技术规格书。
1. 每排未引出至排母的 3 个管脚已连接至 ESP32-PICO-D4 SIP 模组的内置 flash 模块。更多信息，请见 `相关文档`_ 中的模组技术规格书。
2. 较早版本的 ESP32-PICO-D4 开发板默认采用排针。
ESP32-PICO-KIT V4 开发板的尺寸为 52 x 20.3 x 10 mm (2.1" x 0.8" x 0.4")，具体请见 `开发板尺寸`_ 章节。本迷你开发板的功能框图如下图所示。
.. figure:: ../../_static/esp32-pico-kit-v4-functional-block-diagram.png
:align: center
:alt: ESP32-PICO-KIT V4 functional block diagram
:alt: ESP32-PICO-KIT V4 功能框图
:figclass: align-center
ESP32-PICO-KIT V4 功能框图
@ -55,11 +56,11 @@ USB-UART 桥接器
Micro USB 接口
USB 接口，可用作电路板的供电电源及连接 PC 端的通信接口。
5V LED 电源指示灯
当开发板通电后（USB 或外部 5V），该指示灯将亮起。更多信息，请见 `相关文档`_ 中的原理图。
LED 电源指示灯
当开发板通电后（USB 或外部 5 V），该指示灯将亮起。更多信息，请见 `相关文档`_ 中的原理图。
I/O
I/O ESP32-PICO-D4 上的所有管脚均通过开发板的排针引出。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。更多信息，请见章节 `管脚说明`_。
ESP32-PICO-D4 上的所有管脚均通过开发板的排母引出。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。更多信息，请见章节 `管脚说明`_。
BOOT 键
按下 BOOT 键并保持，同时按一下 EN 键（此时不要松开 BOOT 键）进入固件下载模式，通过串口下载固件。
@ -69,9 +70,9 @@ EN 键
.. _get-started-pico-kit-v4-board-front:
.. figure:: ../../_static/esp32-pico-kit-v4-layout.jpg
.. figure:: ../../_static/esp32-pico-kit-v4.1-f-layout.jpeg
:align: center
:alt: ESP32-PICO-KIT V4 board layout
:alt: ESP32-PICO-KIT V4 开发板布局
:figclass: align-center
ESP32-PICO-KIT V4 开发板布局
@ -191,21 +192,13 @@ Header J3
开发板尺寸
----------
.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-back.jpg
.. figure:: ../../_static/esp32-pico-kit-v4.1-dimensions-back.jpeg
:align: center
:alt: ESP32-PICO-KIT V4 dimensions - back
:alt: ESP32-PICO-KIT V4 尺寸图 - 背面
:figclass: align-center
ESP32-PICO-KIT V4 尺寸图 - 背面
.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-side.jpg
:align: center
:alt: ESP32-PICO-KIT V4 dimensions - side
:figclass: align-center
ESP32-PICO-KIT V4 尺寸图 - 侧面
相关文档
-----------------