Skip to content

Commit a1fa03f

Browse files
committed
Update supported boards description
1 parent d93f05f commit a1fa03f

File tree

2 files changed

+111
-85
lines changed

2 files changed

+111
-85
lines changed

doc/boards.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,128 @@ layout: page
1212

1313
### Adafruit HUZZAH ESP8266 (ESP-12)
1414

15+
*TODO: add notes*
16+
1517
### NodeMCU 0.9 <a name="nodemcu-0-9"></a>
1618

19+
#### Pin mapping
20+
21+
Pin numbers written on the board itself do not correspond to ESP8266 GPIO pin numbers. Constants are defined to make using this board easier:
22+
23+
```C++
24+
static const uint8_t D0 = 16;
25+
static const uint8_t D1 = 5;
26+
static const uint8_t D2 = 4;
27+
static const uint8_t D3 = 0;
28+
static const uint8_t D4 = 2;
29+
static const uint8_t D5 = 14;
30+
static const uint8_t D6 = 12;
31+
static const uint8_t D7 = 13;
32+
static const uint8_t D8 = 15;
33+
static const uint8_t D9 = 3;
34+
static const uint8_t D10 = 1;
35+
```
36+
37+
If you want to use NodeMCU pin 5, use D5 for pin number, and it will be translated to 'real' GPIO pin 14.
38+
1739
### NodeMCU 1.0 <a name="nodemcu-1-0"></a>
1840

41+
*TODO: add notes*
42+
1943
### Olimex MOD-WIFI-ESP8266
2044

45+
*TODO: add notes*
46+
2147
### SweetPea ESP-210
2248

49+
*TODO: add notes*
50+
2351
### Generic ESP8266 modules
2452

2553
These modules come in different form factors and pinouts. See the page at ESP8266 community wiki for more info:
2654
[ESP8266 Module Family](http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family).
2755

2856
Usually these modules have no bootstapping resistors on board, insufficient decoupling capacitors, no voltage regulator, no reset circuit, and no USB-serial adapter. This makes using them somewhat tricky, compared to development boards which add these features.
57+
58+
In order to use these modules, make sure to observe the following:
59+
60+
- **Provide sufficient power to the module.** For stable use of the ESP8266 a power supply with 3.3V and >= 250mA is required. Using the power available from USB to Serial adapter is not recommended, these adapters typically do not supply enough current to run ESP8266 reliably in every situation. An external supply or regulator along with filtering capacitors is preferred.
61+
62+
- **Connect bootstapping resistors** to GPIO0, GPIO2, GPIO15 according to the schematics below.
63+
64+
- **Put ESP8266 into bootloader mode** before uploading code.
65+
66+
### Serial Adapter
67+
68+
There are many different USB to Serial adapters / boards.
69+
70+
* Note
71+
- for full upload management you need RTS and DTR
72+
- the chip need to have 3.3V TTL (5V may damage the chip)
73+
- not all board have all pins of the ICs as breakout (check before order)
74+
- CTS and DSR are not useful for upload (they are Inputs)
75+
76+
* Working ICs
77+
- FT232RL
78+
- CP2102
79+
- CH340G
80+
- maybe others (drop a comment)
81+
82+
### Minimal Hardware Setup for Bootloading and Usage
83+
84+
ESPxx Hardware
85+
86+
| PIN | Resistor | Serial Adapter |
87+
| ------------- | -------- | -------------- |
88+
| VCC | | VCC (3.3V) |
89+
| GND | | GND |
90+
| TX or GPIO2* | | RX |
91+
| RX | | TX |
92+
| GPIO0 | PullUp | DTR |
93+
| Reset* | PullUp | RTS |
94+
| GPIO15* | PullDown | |
95+
| CH_PD | PullUp | |
96+
97+
* Note
98+
- GPIO15 is also named MTDO
99+
- Reset is also named RSBT or REST (adding PullUp improves the stability of the Module)
100+
- GPIO2 is alternative TX for the boot loader mode
101+
- **Directly connecting a pin to VCC or GND is not a substitute for a PullUp or PullDown resistor, doing this can break upload management and the serial console, instability has also been noted in some cases.**
102+
103+
### ESP to Serial
104+
![ESP to Serial](https://raw.githubusercontent.com/Links2004/Arduino/esp8266/docs/ESP_to_serial.png)
105+
106+
#### Minimal Hardware Setup for Bootloading only ##
107+
ESPxx Hardware
108+
109+
| PIN | Resistor | Serial Adapter |
110+
| ------------- | -------- | --------------- |
111+
| VCC | | VCC (3.3V) |
112+
| GND | | GND |
113+
| TX or GPIO2 | | RX |
114+
| RX | | TX |
115+
| GPIO0 | | GND |
116+
| Reset | | RTS* |
117+
| GPIO15 | PullDown | |
118+
| CH_PD | PullUp | |
119+
120+
* Note
121+
- if no RTS is used a manual power toggle is needed
122+
123+
#### Minimal Hardware Setup for Running only ##
124+
125+
ESPxx Hardware
126+
127+
| PIN | Resistor | Power supply |
128+
| ------------- | -------- | --------------- |
129+
| VCC | | VCC (3.3V) |
130+
| GND | | GND |
131+
| GPIO0 | PullUp | |
132+
| GPIO15 | PullDown | |
133+
| CH_PD | PullUp | |
134+
135+
### Minimal
136+
![ESP min](https://raw.githubusercontent.com/Links2004/Arduino/esp8266/docs/ESP_min.png)
137+
138+
### Improved Stability
139+
![ESP improved stability](https://raw.githubusercontent.com/Links2004/Arduino/esp8266/docs/ESP_improved_stability.png)

doc/generic.md

Lines changed: 0 additions & 85 deletions
This file was deleted.

0 commit comments

Comments
 (0)