Documentation update

igrr · igrr · commit e03efe3b5d74 · 2015-07-22T17:22:04.000+03:00
add jekyll front matters, update links
diff --git a/README.md b/README.md
@@ -9,20 +9,20 @@ Starting with 1.6.4, Arduino allows installation of third-party platform package
 
 - Install Arduino 1.6.5 from the [Arduino website](http://www.arduino.cc/en/main/software).
 - Start Arduino and open Perferences window.
-- Enter ```http://arduino.esp8266.com/package_esp8266com_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas.
+- Enter ```http://arduino.esp8266.com/stable/package_esp8266com_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas.
 - Open Boards Manager from Tools > Board menu and install *esp8266* platform (and don't forget to select your ESP8266 board from Tools > Board menu after installation).
 
 #### Available versions
 
-##### Stable version ![](http://arduino.esp8266.com/badge.svg)
-Boards manager link: `http://arduino.esp8266.com/package_esp8266com_index.json`
+##### Stable version ![](http://arduino.esp8266.com/stable/badge.svg)
+Boards manager link: `http://arduino.esp8266.com/stable/package_esp8266com_index.json`
 
-Documentation: [Reference](http://arduino.esp8266.com/doc/README.md)
+Documentation: [Reference](http://arduino.esp8266.com/stable/doc/reference.html)
 
 ##### Staging version ![](http://arduino.esp8266.com/staging/badge.svg)
 Boards manager link: `http://arduino.esp8266.com/staging/package_esp8266com_index.json`
 
-Documentation: [Reference](http://arduino.esp8266.com/staging/doc/README.md)
+Documentation: [Reference](http://arduino.esp8266.com/staging/doc/reference.html)
 
 
 ### Building latest version from source [![Linux build status](http://img.shields.io/travis/igrr/Arduino.svg)](https://travis-ci.org/igrr/Arduino)
@@ -34,15 +34,11 @@ $ ant dist
 ```
 
 ### Documentation ###
-Latest development version: [Reference](hardware/esp8266com/esp8266/doc/README.md)
-
-### Supported boards ###
-- Generic ESP8266 modules (without auto-reset support)
-- NodeMCU 0.9
-- NodeMCU 1.0
-- Olimex MOD-WIFI-ESP8266
-- Adafruit HUZZAH ESP8266 (ESP-12)
-- SweetPea ESP-210
+Latest development version:
+
+- [Reference](hardware/esp8266com/esp8266/doc/reference.md)
+- [Supported boards](hardware/esp8266com/esp8266/doc/boards.md)
+- [Change log](hardware/esp8266com/esp8266/doc/changes.md)
 
 ### Issues and support ###
 
diff --git a/doc/boards.md b/doc/boards.md
@@ -0,0 +1,28 @@
+---
+title: Supported Hardware
+layout: page
+---
+
+- [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](#olimex-mod-wifi-esp8266)
+- [SweetPea ESP-210](#sweetpea-esp-210)
+- [Generic ESP8266 modules](#generic-esp8266-modules)
+
+### Adafruit HUZZAH ESP8266 (ESP-12)
+
+### NodeMCU 0.9 <a name="nodemcu-0-9"></a>
+
+### NodeMCU 1.0 <a name="nodemcu-1-0"></a>
+
+### Olimex MOD-WIFI-ESP8266
+
+### SweetPea ESP-210
+
+### 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).
+
+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.
diff --git a/doc/changes.md b/doc/changes.md
@@ -1,14 +1,16 @@
-# Change log
+---
+title: Change log
+---
+
 
-## Current version
 
 ### Core
 
 - Updated I2C library to better handle repeated start for certain devices.
 
 ### Libraries
 
-- ESP8266WebServer: add gzip streaming, fix sendContent behaviour, 
+- ESP8266WebServer: add gzip streaming, fix sendContent behaviour,
   add setContentSize method.
 - ESP8266WiFi: add BSSID, channel, isHidden methods, fix AP/STA mode
   selection (#28).
@@ -31,8 +33,8 @@ May 22, 2015
 - Better connection handling in ESP8266WebServer.
   The server now sends Content-Length and Connection: close headers,
   then waits for the client to disconnect. By not closing the connection
-  actively, server avoids TIME_WAIT TCP state, and TCP stack is able to 
-  release the memory immediately, without waiting for 2xMSL period. 
+  actively, server avoids TIME_WAIT TCP state, and TCP stack is able to
+  release the memory immediately, without waiting for 2xMSL period.
   If the client doesn't disconnect in 2000ms, the server closes the connection
   actively.
 - Add Hash library, which has a function to calculate SHA1 hash.
@@ -45,4 +47,3 @@ May 22, 2015
 May 19, 2015
 
 - Initial release of Boards Manager package for ESP8266 platform.
-
diff --git a/doc/generic.md b/doc/generic.md
@@ -0,0 +1,85 @@
+
+## Upload via serial port
+Pick the correct serial port.
+You need to put ESP8266 into bootloader mode before uploading code.
+
+## Power Supply
+
+For stable use of the ESP8266 a power supply with 3.3V and >= 250mA is required.
+
+* Note
+ - Using the Power available from the USB to Serial adapter is not reccomended, these adapters typically do not supply enough current to run the ESP8266 reliably in every situation, an external supply or regulator is preferred.
+
+## Serial Adapter
+
+There are many different USB to Serial adapters / boards.
+
+* Note
+ - for full upload management you need RTS and DTR
+ - the chip need to have 3.3V TTL (5V may damage the chip)
+ - not all board have all pins of the ICs as breakout (check before order)
+ - CTS and DSR are not useful for upload (they are Inputs)
+
+* Working ICs
+ - FT232RL
+ - CP2102
+ - may others (drop a comment)
+
+## Minimal Hardware Setup for Bootloading and Usage
+
+ESPxx Hardware
+
+| PIN           | Resistor | Serial Adapter |
+| ------------- | -------- | -------------- |
+| VCC           |          | VCC (3.3V)     |
+| GND           |          | GND            |
+| TX or GPIO2*  |          | RX             |
+| RX            |          | TX             |
+| GPIO0         | PullUp   | DTR            |
+| Reset*        | PullUp   | RTS            |
+| GPIO15*       | PullDown |                |
+| CH_PD         | PullUp   |                |
+
+* Note
+ - GPIO15 is also named MTDO
+ - Reset is also named RSBT or REST (adding PullUp improves the stability of the Module)
+ - 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](https://raw.githubusercontent.com/Links2004/Arduino/esp8266/docs/ESP_to_serial.png)
+
+## Minimal Hardware Setup for Bootloading only ##
+ESPxx Hardware
+
+| PIN           | Resistor | Serial Adapter  |
+| ------------- | -------- | --------------- |
+| VCC           |          | VCC (3.3V)      |
+| GND           |          | GND             |
+| TX or GPIO2   |          | RX              |
+| RX            |          | TX              |
+| GPIO0         |          | GND             |
+| Reset         |          | RTS*            |
+| GPIO15        | PullDown |                 |
+| CH_PD         | PullUp   |                 |
+
+* Note
+	- if no RTS is used a manual power toggle is needed
+
+## Minimal Hardware Setup for Running only ##
+
+ESPxx Hardware
+
+| PIN           | Resistor | Power supply    |
+| ------------- | -------- | --------------- |
+| VCC           |          | VCC (3.3V)      |
+| GND           |          | GND             |
+| GPIO0         | PullUp   |                 |
+| GPIO15        | PullDown |                 |
+| CH_PD         | PullUp   |                 |
+
+### Minimal
+![ESP min](https://raw.githubusercontent.com/Links2004/Arduino/esp8266/docs/ESP_min.png)
+
+### Improved Stability
+![ESP improved stability](https://raw.githubusercontent.com/Links2004/Arduino/esp8266/docs/ESP_improved_stability.png)
diff --git a/doc/reference.md b/doc/reference.md
