Documentation update

gabod2000 · Nov 23, 2015 · 866921c · 866921c
1 parent 3d26810
commit 866921c
Show file tree

Hide file tree

Showing 9 changed files with 643 additions and 520 deletions.
diff --git a/doc/boards.md b/doc/boards.md
@@ -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)
+    * [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:
 
@@ -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.
 
@@ -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).
 
@@ -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).
@@ -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:
 
@@ -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 |
@@ -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  |
@@ -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
 
@@ -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:
@@ -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.
 
@@ -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
diff --git a/doc/changes.md b/doc/changes.md
@@ -1,5 +1,5 @@
 ---
-title: Change log
+title: Change Log
 ---
 
 *Current release*