mirror of
https://github.com/espressif/ESP8266_RTOS_SDK.git
synced 2025-08-05 22:11:04 +08:00
docs(get_started_devkitc): Modify for ESP8266
This commit is contained in:
Dong Heng
@ -1,13 +1,13 @@
|
||||
ESP32-DevKitC V4 Getting Started Guide
|
||||
ESP8266-DevKitC Getting Started Guide
|
||||
======================================
|
||||
|
||||
This user guide shows how to get started with ESP32-DevKitC V4 development board. For description of other versions of the ESP32-DevKitC check :doc:`../hw-reference/index`.
|
||||
This user guide shows how to get started with ESP8266-DevKitC development board.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP32-DevKitC V4 board <get-started-esp32-devkitc-board-front>`
|
||||
* 1 × ESP8266-DevKitC board
|
||||
* 1 × USB A / micro USB B cable
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
@ -15,43 +15,43 @@ 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.
|
||||
|
||||
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>` and :ref:`esp-modules-and-boards-esp32-solo-1`.
|
||||
|
||||
ESP8266-DevKitC is a small-sized ESP8266-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 V4 board.
|
||||
The following list and figure below describe key components, interfaces and controls of ESP8266-DevKitC board.
|
||||
|
||||
ESP-WROOM-02D/U
|
||||
Module soldered to the ESP8266-DevKitC board. Optionally ESP-WROOM-02D or ESP-WROOM-02U module may be soldered.
|
||||
5V to 3.3V LDO
|
||||
A LDO regulator with a maximum current output of 800 mA, which provides power supply for ESP8266 module and user’s peripherals.
|
||||
Dial Switch
|
||||
A dial switch used for switching between Auto Download and Flow Control.
|
||||
|
||||
* Bit1=OFF, Bit2=ON (Auto Download)
|
||||
* Bit1=ON, Bit2=OFF (Flow Control)
|
||||
|
||||
ESP32-WROOM-32
|
||||
:ref:`esp-modules-and-boards-esp32-wroom-32` module soldered to the ESP32-DevKitC V4 board. Optionally ESP32-WROOM-32D, ESP32-WROOM-32U or ESP32-SOLO-1 module may be soldered instead of the ESP32-WROOM-32.
|
||||
USB-UART Bridge
|
||||
A single chip USB-UART bridge provides up to 3 Mbps transfers rates.
|
||||
Boot
|
||||
Boot Button
|
||||
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.
|
||||
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
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and the board.
|
||||
EN Button
|
||||
Reset button: pressing this button resets the system.
|
||||
I/O
|
||||
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.
|
||||
I/O Connector
|
||||
All of the pins on the ESP8266 module are broken out to the pin headers on the board. Users can program ESP8266 to enable multiple functions.
|
||||
For details, please refer to `ESP8266EX Datasheet <https://www.espressif.com/sites/default/files/documentation/0a-esp8266ex_datasheet_en.pdf>`_ .
|
||||
|
||||
.. note::
|
||||
.. _get-started-esp8266-devkitc-board-front:
|
||||
|
||||
Some of broken out pins are used internally by the ESP32-WROOM-32, ESP32-WROOM-32D/U and ESP32-SOLO-1 modules to communicate with SPI memory. They are grouped on one side of the board besides the USB connector and labeled CLK, D0, D1, D2, D3 and CMD (GPIO6 - GPIO11). In general these pins should be left unconnected, otherwise access to the SPI flash memory / SPI RAM may be disturbed.
|
||||
|
||||
.. _get-started-esp32-devkitc-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg
|
||||
.. figure:: ../../_static/esp8266-devkitc-functional-overview.jpg
|
||||
:align: center
|
||||
:alt: ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
|
||||
:alt: ESP8266-DevKitC with ESP-WROOM-02D module soldered
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
|
||||
ESP8266-DevKitC with ESP-WROOM-02D module soldered
|
||||
|
||||
|
||||
Power Supply Options
|
||||
@ -68,59 +68,35 @@ There following options are available to provide power supply to this board:
|
||||
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.
|
||||
|
||||
|
||||
Note on C15
|
||||
-----------
|
||||
|
||||
The C15, on the board of earlier batches of V4, may bring two issues:
|
||||
|
||||
1. The board may boot into download mode;
|
||||
2. If users output clock on GPIO0, C15 may impact the clock output.
|
||||
|
||||
As a result, if users believe that C15 will impact their use of the board, they can remove it completely (please refer to the screenshot below for the precise location of C15 that is colored in yellow). Otherwise, users do not need to concern about C15.
|
||||
|
||||
.. figure:: ../../_static/esp32-devkitc-c15-location.png
|
||||
:align: center
|
||||
:alt: Location of C15 (colored yellow) on ESP32-DevKitC V4 board
|
||||
:figclass: align-center
|
||||
:width: 30%
|
||||
|
||||
Location of C15 (colored yellow) on ESP32-DevKitC V4 board
|
||||
|
||||
|
||||
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.
|
||||
Before powering up the ESP8266-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:
|
||||
To start development of applications, you may walk 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
|
||||
* setup toolchain in your PC to develop applications for ESP8266 in C language
|
||||
* connect the module to the PC and verify if it is accessible
|
||||
* build an example application to the ESP8266
|
||||
* monitor instantly what the application is doing
|
||||
|
||||
|
||||
Board Dimensions
|
||||
----------------
|
||||
|
||||
.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg
|
||||
.. figure:: ../../_static/esp8266-devkitc-dimensions-back.jpg
|
||||
:align: center
|
||||
:alt: ESP32 DevKitC board dimensions - back
|
||||
:alt: ESP8266 DevKitC board dimensions - back
|
||||
:figclass: align-center
|
||||
|
||||
ESP32 DevKitC board dimensions - back
|
||||
ESP8266 DevKitC board dimensions - back
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP32-DevKitC V4 schematic <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch-20180607a.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/U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_en.pdf>`_ (PDF)
|
||||
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
get-started-devkitc-v2
|
||||
* `ESP-WROOM-02 PCB Design and Module Placement Guide <http://espressif.com/en/support/download/documents?keys=ESP-WROOM-02+PCB+Design+and+Module+Placement+Guide>`_ (WEB)
|
||||
* `ESP8266 Hardware Resources <http://espressif.com/en/support/download/documents?keys=reference+design>`_ (WEB)
|
||||
* `ESP8266 App <http://espressif.com/en/support/download/apps>`_ (WEB)
|
||||
* `ESP8266 BBS <http://bbs.espressif.com>`_ (WEB)
|
||||
* `ESP8266 Resources <http://www.espressif.com/en/products/hardware/esp8266ex/resources>`_ (WEB)
|
||||
|
||||
Reference in New Issue
Block a user