Skip to content

Commit 32eed78

Browse files
committed
Merge branch 'docs/get_started_devkitc' into 'master'
Add get-started-devkitc.rst document See merge request sdk/ESP8266_RTOS_SDK!385
2 parents a964b60 + 1c1aa0d commit 32eed78

File tree

3 files changed

+102
-0
lines changed

3 files changed

+102
-0
lines changed
Loading
Loading
+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
ESP8266-DevKitC Getting Started Guide
2+
======================================
3+
4+
This user guide shows how to get started with ESP8266-DevKitC development board.
5+
6+
7+
What You Need
8+
-------------
9+
10+
* 1 × ESP8266-DevKitC board
11+
* 1 × USB A / micro USB B cable
12+
* 1 × PC loaded with Windows, Linux or Mac OS
13+
14+
15+
Overview
16+
--------
17+
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.
19+
20+
Functional Description
21+
----------------------
22+
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)
34+
35+
USB-UART Bridge
36+
A single chip USB-UART bridge provides up to 3 Mbps transfers rates.
37+
Boot Button
38+
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.
39+
Micro USB Port
40+
USB interface. It functions as the power supply for the board and the communication interface between PC and the board.
41+
EN Button
42+
Reset button: pressing this button resets the system.
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>`_ .
46+
47+
.. _get-started-esp8266-devkitc-board-front:
48+
49+
.. figure:: ../../_static/esp8266-devkitc-functional-overview.jpg
50+
:align: center
51+
:alt: ESP8266-DevKitC with ESP-WROOM-02D module soldered
52+
:figclass: align-center
53+
54+
ESP8266-DevKitC with ESP-WROOM-02D module soldered
55+
56+
57+
Power Supply Options
58+
--------------------
59+
60+
There following options are available to provide power supply to this board:
61+
62+
1. Micro USB port, this is default power supply connection
63+
2. 5V / GND header pins
64+
3. 3V3 / GND header pins
65+
66+
.. warning::
67+
68+
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.
69+
70+
71+
Start Application Development
72+
------------------------------
73+
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.
75+
76+
To start development of applications, you may walk through the following steps:
77+
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
82+
83+
84+
Board Dimensions
85+
----------------
86+
87+
.. figure:: ../../_static/esp8266-devkitc-dimensions-back.jpg
88+
:align: center
89+
:alt: ESP8266 DevKitC board dimensions - back
90+
:figclass: align-center
91+
92+
ESP8266 DevKitC board dimensions - back
93+
94+
95+
Related Documents
96+
-----------------
97+
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)