Docs for ESP32 DevKitC V4
This commit is contained in:
krzychb
parent
62be35c0a5
commit
c759ff3aab
BIN
docs/_static/esp32-devkitc-dimensions-back.jpg
vendored
Normal file
BIN
docs/_static/esp32-devkitc-dimensions-back.jpg
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 62 KiB |
BIN
docs/_static/esp32-devkitc-functional-overview.jpg
vendored
Normal file
BIN
docs/_static/esp32-devkitc-functional-overview.jpg
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 81 KiB |
|
Before Width: | Height: | Size: 277 KiB After Width: | Height: | Size: 277 KiB |
79
docs/get-started/get-started-devkitc-v2.rst
Normal file
79
docs/get-started/get-started-devkitc-v2.rst
Normal file
|
|
@ -0,0 +1,79 @@
|
|||
ESP32-DevKitC V2 Getting Started Guide
|
||||
======================================
|
||||
|
||||
This user guide shows how to get started with ESP32-DevKitC development board.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP32-DevKitC V2 board <get-started-esp32-devkitc-v2-board-front>`
|
||||
* 1 × USB A / micro USB B cable
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP32-DevKitC 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.
|
||||
|
||||
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following list and figure below describe key components, interfaces and controls of ESP32-DevKitC board.
|
||||
|
||||
ESP-WROOM-32
|
||||
Standard `ESP-WROOM-32 <https://www.espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ module soldered to the ESP32-DevKitC board.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
Boot
|
||||
Download 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.
|
||||
USB
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP-WROOM-32.
|
||||
I/O
|
||||
Most of the pins on the ESP-WROOM-32 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.
|
||||
|
||||
.. _get-started-esp32-devkitc-v2-board-front:
|
||||
|
||||
.. figure:: ../_static/esp32-devkitc-v2-functional-overview.png
|
||||
:align: center
|
||||
:alt: ESP32-DevKitC V2 board layout
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-DevKitC V2 board layout
|
||||
|
||||
|
||||
Power Supply Options
|
||||
--------------------
|
||||
|
||||
There following options are available to provide power supply to this board:
|
||||
|
||||
1. Micro USB port, this is default power supply connection
|
||||
2. 5V / GND header pins
|
||||
3. 3V3 / GND header pins
|
||||
|
||||
.. warning::
|
||||
|
||||
Above options are mutually exclusive, i.e. the power supply may be provided using only one of the above options. Attempt to power the board using more than one connection at a time may damage the board and/or the power supply source.
|
||||
|
||||
|
||||
Start Application Development
|
||||
------------------------------
|
||||
|
||||
Before powering up the ESP32-DevKitC, please make sure that the board has been received in good condition with no obvious signs of damage.
|
||||
|
||||
To start development of applications, proceed to section :doc:`index`, that will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
* :ref:`get-started-build-flash` an example application to the ESP32
|
||||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP32-DevKitC schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
|
|
@ -15,7 +15,9 @@ What You Need
|
|||
Overview
|
||||
--------
|
||||
|
||||
ESP32-DevKitC 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 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.
|
||||
|
||||
The board comes in two versions, either with :ref:`esp-modules-and-boards-esp-wroom-32` or :ref:`esp-modules-and-boards-esp32-wrover` module soldered.
|
||||
|
||||
|
||||
Functional Description
|
||||
|
|
@ -24,30 +26,45 @@ Functional Description
|
|||
The following list and figure below describe key components, interfaces and controls of ESP32-DevKitC board.
|
||||
|
||||
ESP-WROOM-32
|
||||
Standard `ESP-WROOM-32 <https://www.espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ module soldered to the ESP32-DevKitC board.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
:ref:`esp-modules-and-boards-esp-wroom-32` module soldered to the ESP32-DevKitC board.
|
||||
ESP32-WROVER
|
||||
Optionally :ref:`esp-modules-and-boards-esp32-wrover` module may be soldered instead of the ESP-WROOM-32.
|
||||
USB-UART Bridge
|
||||
A single chip USB-UART bridge provides up to 3 Mbps transfers rates.
|
||||
Boot
|
||||
Download 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.
|
||||
USB
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP-WROOM-32.
|
||||
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`_.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
I/O
|
||||
Most of the pins on the ESP-WROOM-32 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 pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
|
||||
.. note::
|
||||
|
||||
Some of broken out pins are used internally be the ESP32 module to communicate with SPI memory. They are grouped on one side of the board besides the USB connector and labeled D0, D1, D2, D3, CMD and CLK. In general these pins should be left unconnected or access to the SPI flash memory / SPI RAM may be disturbed.
|
||||
|
||||
.. note::
|
||||
|
||||
GPIO16 and 17 are used internally by the ESP32-WROVER module. They are broken out and avialable for use only for boards that have the ESP-WROOM-32 module installed.
|
||||
|
||||
|
||||
.. _get-started-esp32-devkitc-board-front:
|
||||
|
||||
.. figure:: ../_static/esp32-devkitc-functional-overview.png
|
||||
.. figure:: ../_static/esp32-devkitc-functional-overview.jpg
|
||||
:align: center
|
||||
:alt: ESP32-DevKitC board layout
|
||||
:alt: ESP32-DevKitC with ESP-WROOM-32 module soldered
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-DevKitC board layout
|
||||
ESP32-DevKitC with ESP-WROOM-32 module soldered
|
||||
|
||||
|
||||
Power Supply Options
|
||||
--------------------
|
||||
|
||||
There following options are available to provide power supply to the ESP32-PICO-KIT V4:
|
||||
There following options are available to provide power supply to this board:
|
||||
|
||||
1. Micro USB port, this is default power supply connection
|
||||
2. 5V / GND header pins
|
||||
|
|
@ -71,9 +88,26 @@ To start development of applications, proceed to section :doc:`index`, that will
|
|||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
Board Dimensions
|
||||
----------------
|
||||
|
||||
.. figure:: ../_static/esp32-devkitc-dimensions-back.jpg
|
||||
:align: center
|
||||
:alt: ESP32 DevKitC board dimensions - back
|
||||
:figclass: align-center
|
||||
|
||||
ESP32 DevKitC board dimensions - back
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP32-DevKitC schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)
|
||||
* `ESP32-DevKitC schematic <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch.pdf>`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
get-started-devkitc-v2
|
||||
|
|
@ -30,6 +30,28 @@ Documentation
|
|||
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
|
||||
|
||||
|
||||
.. _esp-modules-and-boards-esp32-devkitc-v2:
|
||||
|
||||
ESP32 Core Board V2 / ESP32 DevKitC
|
||||
-----------------------------------
|
||||
|
||||
Small and convenient development board with :ref:`esp-modules-and-boards-esp-wroom-32` module installed, break out pin headers and minimum additional components. Includes USB to serial programming interface, that also provides power supply for the board. Has pushbuttons to reset the board and put it in upload mode.
|
||||
|
||||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-core-board-v2.png
|
||||
:align: center
|
||||
:alt: ESP32 Core Board V2 / ESP32 DevKitC board
|
||||
:width: 50%
|
||||
|
||||
ESP32 Core Board V2 / ESP32 DevKitC board
|
||||
|
||||
Documentation
|
||||
"""""""""""""
|
||||
|
||||
* :doc:`../get-started/get-started-devkitc-v2`
|
||||
* `ESP32 DevKitC V2 Schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`__ (PDF)
|
||||
* `CP210x USB to UART Bridge VCP Drivers <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
|
||||
|
||||
|
||||
.. _esp-modules-and-boards-esp-wrover-kit-v1:
|
||||
|
||||
ESP-WROVER-KIT V1 / ESP32 DevKitJ V1
|
||||
|
|
|
|||
|
|
@ -104,6 +104,7 @@ Documentation
|
|||
|
||||
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`__ (PDF)
|
||||
* `ESP-PSRAM32 Datasheet <https://espressif.com/sites/default/files/documentation/esp-psram32_datasheet_en.pdf>`__ (PDF)
|
||||
* `ESP32-WROVER Reference Design <http://www.espressif.com/sites/default/files/documentation/esp32-wrover_reference_design.zip>`_ PDF containing OrCAD schematic, PCB layout, gerbers and BOM
|
||||
|
||||
|
||||
.. _esp-modules-and-boards-esp32-pico-pit-v4:
|
||||
|
|
@ -138,26 +139,31 @@ Previous Versions
|
|||
|
||||
.. _esp-modules-and-boards-esp32-devkitc:
|
||||
|
||||
ESP32 Core Board V2 / ESP32 DevKitC
|
||||
===================================
|
||||
ESP32 DevKitC V4
|
||||
================
|
||||
|
||||
Small and convenient development board with :ref:`esp-modules-and-boards-esp-wroom-32` module installed, break out pin headers and minimum additional components. Includes USB to serial programming interface, that also provides power supply for the board. Has pushbuttons to reset the board and put it in upload mode.
|
||||
Small and convenient development board with :ref:`esp-modules-and-boards-esp-wroom-32` module installed, break out pin headers and minimum additional components. Includes USB to serial programming interface, that also provides power supply for the board. Has pushbuttons to reset the board and put it in upload mode. Comparing to the previous :ref:`esp-modules-and-boards-esp32-devkitc-v2`, instead of ESP-WROOM-32 it can accommodate :ref:`esp-modules-and-boards-esp32-wrover` module and has CP2102N chip that supports faster baud rates.
|
||||
|
||||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-core-board-v2.png
|
||||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-devkitc-v4-front.jpg
|
||||
:align: center
|
||||
:alt: ESP32 Core Board V2 / ESP32 DevKitC board
|
||||
:alt: ESP32 DevKitC V4 board
|
||||
:width: 50%
|
||||
|
||||
ESP32 Core Board V2 / ESP32 DevKitC board
|
||||
ESP32 DevKitC V4 board
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
* :doc:`../get-started/get-started-devkitc`
|
||||
* `ESP32 DevKitC Schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`__ (PDF)
|
||||
* `ESP32 Development Board Reference Design <https://espressif.com/sites/default/files/documentation/esp32_development_board_reference_design.zip>`_ (ZIP) containing OrCAD schematic, PCB layout, gerbers and BOM
|
||||
* `ESP32-DevKitC schematic <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch.pdf>`_ (PDF)
|
||||
* `ESP32-DevKitC Reference Design <http://www.espressif.com/sites/default/files/documentation/esp32-devkitc-v4_reference_design_0.zip>`_ (ZIP) containing OrCAD schematic, PCB layout, gerbers and BOM
|
||||
* `CP210x USB to UART Bridge VCP Drivers <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
|
||||
|
||||
Previous Versions
|
||||
-----------------
|
||||
|
||||
* :ref:`esp-modules-and-boards-esp32-devkitc-v2`
|
||||
|
||||
|
||||
.. _esp-modules-and-boards-esp-wrover-kit-v3:
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue