Skip to content

Commit 1c1aa0d

Browse files
committed
docs(get_started_devkitc): Modify for ESP8266
1 parent 4180376 commit 1c1aa0d

File tree

3 files changed

+39
-63
lines changed

3 files changed

+39
-63
lines changed
Loading
Loading
+39-63
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,57 @@
1-
ESP32-DevKitC V4 Getting Started Guide
1+
ESP8266-DevKitC Getting Started Guide
22
======================================
33

4-
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`.
4+
This user guide shows how to get started with ESP8266-DevKitC development board.
55

66

77
What You Need
88
-------------
99

10-
* 1 × :ref:`ESP32-DevKitC V4 board <get-started-esp32-devkitc-board-front>`
10+
* 1 × ESP8266-DevKitC board
1111
* 1 × USB A / micro USB B cable
1212
* 1 × PC loaded with Windows, Linux or Mac OS
1313

1414

1515
Overview
1616
--------
1717

18-
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.
19-
20-
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`.
21-
18+
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.
2219

2320
Functional Description
2421
----------------------
2522

26-
The following list and figure below describe key components, interfaces and controls of ESP32-DevKitC V4 board.
23+
The following list and figure below describe key components, interfaces and controls of ESP8266-DevKitC board.
24+
25+
ESP-WROOM-02D/U
26+
Module soldered to the ESP8266-DevKitC board. Optionally ESP-WROOM-02D or ESP-WROOM-02U module may be soldered.
27+
5V to 3.3V LDO
28+
A LDO regulator with a maximum current output of 800 mA, which provides power supply for ESP8266 module and user’s peripherals.
29+
Dial Switch
30+
A dial switch used for switching between Auto Download and Flow Control.
31+
32+
* Bit1=OFF, Bit2=ON (Auto Download)
33+
* Bit1=ON, Bit2=OFF (Flow Control)
2734

28-
ESP32-WROOM-32
29-
: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.
3035
USB-UART Bridge
3136
A single chip USB-UART bridge provides up to 3 Mbps transfers rates.
32-
Boot
37+
Boot Button
3338
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.
3439
Micro USB Port
35-
USB interface. It functions as the power supply for the board and the communication interface between PC and the ESP module.
36-
5V Power On LED
37-
This LED lights when the USB or an external 5V power supply is applied to the board. For details see schematic in `Related Documents`_.
38-
EN
40+
USB interface. It functions as the power supply for the board and the communication interface between PC and the board.
41+
EN Button
3942
Reset button: pressing this button resets the system.
40-
I/O
41-
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.
42-
43-
.. note::
43+
I/O Connector
44+
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.
45+
For details, please refer to `ESP8266EX Datasheet <https://www.espressif.com/sites/default/files/documentation/0a-esp8266ex_datasheet_en.pdf>`_ .
4446

45-
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.
47+
.. _get-started-esp8266-devkitc-board-front:
4648

47-
.. _get-started-esp32-devkitc-board-front:
48-
49-
.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg
49+
.. figure:: ../../_static/esp8266-devkitc-functional-overview.jpg
5050
:align: center
51-
:alt: ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
51+
:alt: ESP8266-DevKitC with ESP-WROOM-02D module soldered
5252
:figclass: align-center
5353

54-
ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
54+
ESP8266-DevKitC with ESP-WROOM-02D module soldered
5555

5656

5757
Power Supply Options
@@ -68,59 +68,35 @@ There following options are available to provide power supply to this board:
6868
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.
6969

7070

71-
Note on C15
72-
-----------
73-
74-
The C15, on the board of earlier batches of V4, may bring two issues:
75-
76-
1. The board may boot into download mode;
77-
2. If users output clock on GPIO0, C15 may impact the clock output.
78-
79-
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.
80-
81-
.. figure:: ../../_static/esp32-devkitc-c15-location.png
82-
:align: center
83-
:alt: Location of C15 (colored yellow) on ESP32-DevKitC V4 board
84-
:figclass: align-center
85-
:width: 30%
86-
87-
Location of C15 (colored yellow) on ESP32-DevKitC V4 board
88-
89-
9071
Start Application Development
9172
------------------------------
9273

93-
Before powering up the ESP32-DevKitC, please make sure that the board has been received in good condition with no obvious signs of damage.
74+
Before powering up the ESP8266-DevKitC, please make sure that the board has been received in good condition with no obvious signs of damage.
9475

95-
To start development of applications, proceed to section :doc:`index`, that will walk you through the following steps:
76+
To start development of applications, you may walk through the following steps:
9677

97-
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
98-
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
99-
* :ref:`get-started-build-flash` an example application to the ESP32
100-
* :ref:`get-started-build-monitor` instantly what the application is doing
78+
* setup toolchain in your PC to develop applications for ESP8266 in C language
79+
* connect the module to the PC and verify if it is accessible
80+
* build an example application to the ESP8266
81+
* monitor instantly what the application is doing
10182

10283

10384
Board Dimensions
10485
----------------
10586

106-
.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg
87+
.. figure:: ../../_static/esp8266-devkitc-dimensions-back.jpg
10788
:align: center
108-
:alt: ESP32 DevKitC board dimensions - back
89+
:alt: ESP8266 DevKitC board dimensions - back
10990
:figclass: align-center
11091

111-
ESP32 DevKitC board dimensions - back
92+
ESP8266 DevKitC board dimensions - back
11293

11394

11495
Related Documents
11596
-----------------
11697

117-
* `ESP32-DevKitC V4 schematic <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch-20180607a.pdf>`_ (PDF)
118-
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
119-
* `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ (PDF)
120-
* `ESP32-WROOM-32D/U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_en.pdf>`_ (PDF)
121-
122-
123-
.. toctree::
124-
:hidden:
125-
126-
get-started-devkitc-v2
98+
* `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)
99+
* `ESP8266 Hardware Resources <http://espressif.com/en/support/download/documents?keys=reference+design>`_ (WEB)
100+
* `ESP8266 App <http://espressif.com/en/support/download/apps>`_ (WEB)
101+
* `ESP8266 BBS <http://bbs.espressif.com>`_ (WEB)
102+
* `ESP8266 Resources <http://www.espressif.com/en/products/hardware/esp8266ex/resources>`_ (WEB)

0 commit comments

Comments
 (0)