Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
@igrr
igrr committed Nov 23, 2015
1 parent 3d26810 commit 866921c
Show file tree
Hide file tree
Showing 9 changed files with 643 additions and 520 deletions.
83 changes: 48 additions & 35 deletions doc/boards.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,36 @@
title: Supported Hardware
---

- [Adafruit HUZZAH ESP8266 (ESP-12)](#adafruit-huzzah-esp8266-esp-12)
- [NodeMCU 0.9](#nodemcu-0-9)
- [NodeMCU 1.0](#nodemcu-1-0)
- [Olimex MOD-WIFI-ESP8266-DEV](#olimex-mod-wifi-esp8266-dev)
- [Olimex MOD-WIFI-ESP8266](#olimex-mod-wifi-esp8266)
- [SparkFun ESP8266 Thing](#sparkfun-esp8266-thing)
- [SweetPea ESP-210](#sweetpea-esp-210)
- [Generic ESP8266 modules](#generic-esp8266-modules)
- [WeMos D1](#wemos-d1)
- [WeMos D1 mini](#wemos-d1-mini)

### Adafruit HUZZAH ESP8266 (ESP-12)
## Table of contents
* [Adafruit HUZZAH ESP8266 (ESP\-12)](#adafruit-huzzah-esp8266-esp-12)

This comment has been minimized.

Sign in to view

Copy link
@Links2004

Links2004 Nov 24, 2015

Collaborator

looks like this change make problems with the github md view.
* [NodeMCU 0\.9 <a name="user\-content\-nodemcu\-0\-9"></a>](#nodemcu-09-)
* [Pin mapping](#pin-mapping)
* [NodeMCU 1\.0](#nodemcu-10)
* [Olimex MOD\-WIFI\-ESP8266\-DEV](#olimex-mod-wifi-esp8266-dev)
* [Olimex MOD\-WIFI\-ESP8266](#olimex-mod-wifi-esp8266)
* [SparkFun ESP8266 Thing](#sparkfun-esp8266-thing)
* [SweetPea ESP\-210](#sweetpea-esp-210)
* [Generic ESP8266 modules](#generic-esp8266-modules)
* [Serial Adapter](#serial-adapter)
* [Minimal Hardware Setup for Bootloading and Usage](#minimal-hardware-setup-for-bootloading-and-usage)
* [ESP to Serial](#esp-to-serial)
* [Minimal Hardware Setup for Bootloading only](#minimal-hardware-setup-for-bootloading-only)
* [Minimal Hardware Setup for Running only](#minimal-hardware-setup-for-running-only)
* [Minimal](#minimal)
* [Improved Stability](#improved-stability)
* [Boot Messages and Modes](#boot-messages-and-modes)
* [rst cause](#rst-cause)
* [boot mode](#boot-mode)
* [WeMos D1](#wemos-d1)
* [WeMos D1 mini](#wemos-d1-mini)

## Adafruit HUZZAH ESP8266 (ESP-12)

*TODO: add notes*

### NodeMCU 0.9 <a name="nodemcu-0-9"></a>
## NodeMCU 0.9

#### Pin mapping
### Pin mapping

Pin numbers written on the board itself do not correspond to ESP8266 GPIO pin numbers. Constants are defined to make using this board easier:

Expand All @@ -39,7 +51,7 @@ static const uint8_t D10 = 1;

If you want to use NodeMCU pin 5, use D5 for pin number, and it will be translated to 'real' GPIO pin 14.

### NodeMCU 1.0
## NodeMCU 1.0

This module is sold under many names for around $6.50 on AliExpress and it's one of the cheapest, fully integrated ESP8266 solutions.

Expand All @@ -51,7 +63,7 @@ The board also features a NCP1117 voltage regulator, a blue LED on GPIO16 and a

Full pinout and PDF schematics can be found [here](https://github.com/nodemcu/nodemcu-devkit-v1.0)

### Olimex MOD-WIFI-ESP8266-DEV
## Olimex MOD-WIFI-ESP8266-DEV

This board comes with 2 MB of SPI flash and optional accessories (e.g. evaluation board ESP8266-EVB or BAT-BOX for batteries).

Expand All @@ -65,21 +77,21 @@ UART pins for programming and serial I/O are GPIO1 (TXD, pin 3) and GPIO3 (RXD,

Get the board schematics [here](https://github.com/OLIMEX/ESP8266/blob/master/HARDWARE/MOD-WIFI-ESP8266-DEV/MOD-WIFI-ESP8266-DEV_schematic.pdf)

### Olimex MOD-WIFI-ESP8266
## Olimex MOD-WIFI-ESP8266

This is a stripped down version of the above. Behaves identically in terms of jumpers but has less pins readily available for I/O. Still 2 MB of SPI flash.

### SparkFun ESP8266 Thing ###
## SparkFun ESP8266 Thing ###

Product page: https://www.sparkfun.com/products/13231

*TODO: add notes*

### SweetPea ESP-210
## SweetPea ESP-210

*TODO: add notes*

### Generic ESP8266 modules
## Generic ESP8266 modules

These modules come in different form factors and pinouts. See the page at ESP8266 community wiki for more info:
[ESP8266 Module Family](http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family).
Expand All @@ -94,10 +106,10 @@ In order to use these modules, make sure to observe the following:

- **Put ESP8266 into bootloader mode** before uploading code.

### Serial Adapter
## Serial Adapter

There are many different USB to Serial adapters / boards.
To be able to put ESP8266 into bootloader mode using serial handshaking lines, you need the adapter which breaks out RTS and DTR outputs. CTS and DSR are not useful for upload (they are inputs). Make sure the adapter can work with 3.3V IO voltage: it should have a jumper or a switch to select between 5V and 3.3V, or be marked as 3.3V only.
To be able to put ESP8266 into bootloader mode using serial handshaking lines, you need the adapter which breaks out RTS and DTR outputs. CTS and DSR are not useful for upload (they are inputs). Make sure the adapter can work with 3.3V IO voltage: it should have a jumper or a switch to select between 5V and 3.3V, or be marked as 3.3V only.

Adapters based around the following ICs should work:

Expand All @@ -107,7 +119,7 @@ Adapters based around the following ICs should work:

PL2303-based adapters are known not to work on Mac OS X. See https://github.com/igrr/esptool-ck/issues/9 for more info.

### Minimal Hardware Setup for Bootloading and Usage
## Minimal Hardware Setup for Bootloading and Usage


| PIN | Resistor | Serial Adapter |
Expand All @@ -127,10 +139,10 @@ PL2303-based adapters are known not to work on Mac OS X. See https://github.com/
- GPIO2 is alternative TX for the boot loader mode
- **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.**

### ESP to Serial
## ESP to Serial
![ESP to Serial](ESP_to_serial.png)

#### Minimal Hardware Setup for Bootloading only ##
### Minimal Hardware Setup for Bootloading only ##
ESPxx Hardware

| PIN | Resistor | Serial Adapter |
Expand All @@ -147,7 +159,7 @@ ESPxx Hardware
* Note
- if no RTS is used a manual power toggle is needed

#### Minimal Hardware Setup for Running only ##
### Minimal Hardware Setup for Running only ##

ESPxx Hardware

Expand All @@ -159,13 +171,13 @@ ESPxx Hardware
| GPIO15 | PullDown | |
| CH_PD | PullUp | |

### Minimal
## Minimal
![ESP min](ESP_min.png)

### Improved Stability
## Improved Stability
![ESP improved stability](ESP_improved_stability.png)

### Boot Messages and Modes
## Boot Messages and Modes

The ESP module checks at every boot the Pins 0, 2 and 15.
based on them its boots in different modes:
Expand All @@ -182,21 +194,21 @@ at startup the ESP prints out the current boot mode example:
rst cause:2, boot mode:(3,6)
```

note:
note:
- GPIO2 is used as TX output and the internal Pullup is enabled on boot.

#### rst cause
### rst cause

| Number | Description |
| ------ | ---------------------- |
| 0 | unknown |
| 1 | normal boot |
| 2 | reset pin |
| 3 | software reset |
| 4 | watchdog reset |
| 4 | watchdog reset |


#### boot mode
### boot mode

the first value respects the pin setup of the Pins 0, 2 and 15.

Expand All @@ -214,7 +226,8 @@ the first value respects the pin setup of the Pins 0, 2 and 15.
note:
- number = ((GPIO15 << 2) | (GPIO0 << 1) | GPIO2);

### WeMos D1
## WeMos D1
Product page: http://wemos.cc
### WeMos D1 mini

## WeMos D1 mini
Product page: http://wemos.cc
2 changes: 1 addition & 1 deletion doc/changes.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Change log
title: Change Log
---

*Current release*
Expand Down
Loading

4 comments on commit 866921c

@igrr
Copy link
Member Author

@igrr igrr commented on 866921c Nov 25, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry guys, it seems that it's quite hard to write markdown which will give the same result in two different markdown parsers :(
I was "fixing" this to make output look correctly in web version (http://esp8266.github.io/Arduino/versions/2.0.0-rc2/), apparently need to make a few iterations to find the right amount of spacing so both versions look the same.

@krzychb
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@igrr,

Frankly saying I was not aware that three is a separate version of documentation attached to each release until I checked this commit.

Did you consider using only one type of documentation for s/w releases and for github repository?

I am not sure what it takes to maintain two versions but I believe they will never be the same 😄

I would appeal that instead of bothering how to fix it, drop one of them and allocate your time to strategic development of this cool s/w 👍

Web version looks nicer to me than md. Is it possible to drop all md files except readme.md and provide a link under https://github.com/esp8266/Arduino/wiki to the latest html documentation?

Krzysztof

@igrr
Copy link
Member Author

@igrr igrr commented on 866921c Nov 25, 2015 via email

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@igrr
Copy link
Member Author

@igrr igrr commented on 866921c Nov 30, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed tables of contents and images, please let me know if i missed anything.

Turns out, GFM needs an empty line before an image, while kmarkdown doesn't. Just something to remember when writing future docs.

Please sign in to comment.