This automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here using GitHub Flavored Markdown, select a template crafted by a designer, and publish. After your page is generated, you can check out the new gh-pages branch locally. If you’re using GitHub Desktop, simply sync your repository and you’ll see the new branch.
+
+
+Designer Templates
+
+
We’ve crafted some handsome templates for you to use. Go ahead and click 'Continue to layouts' to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved.
+
+
+Creating pages manually
+
+
If you prefer to not use the automatic generator, push a branch named gh-pages to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.
+
+
+Authors and Contributors
+
+
You can @mention a GitHub username to generate a link to their profile. The resulting <a> element will link to the contributor’s GitHub Profile. For example: In 2007, Chris Wanstrath (@defunkt), PJ Hyett (@pjhyett), and Tom Preston-Werner (@mojombo) founded GitHub.
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
+
+
This module is sold under many names for around $6.50 on AliExpress and it's one of the cheapest, fully integrated ESP8266 solutions.
+
+
It's an open hardware design with an ESP-12E core and 4 MB of SPI flash.
+
+
Acording to the manufacturer, "with a micro USB cable, you can connect NodeMCU devkit to your laptop and flash it without any trouble". This is more or less true: the board comes with a CP2102 onboard USB to serial adapter which just works, well, the majority of the time. Sometimes flashing fails and you have to reset the board by holding down FLASH + RST, then releasing FLASH, then releasing RST. This forces the CP2102 device to power cycle and to be re-numbered by Linux.
+
+
The board also features a NCP1117 voltage regulator, a blue LED on GPIO16 and a 220k/100k Ohm voltage divider on the ADC input pin.
This board comes with 2 MB of SPI flash and optional accessories (e.g. evaluation board ESP8266-EVB or BAT-BOX for batteries).
+
+
The basic module has three solder jumpers that allow you to switch the operating mode between SDIO, UART and FLASH.
+
+
The board is shipped for FLASH operation mode, with jumpers TD0JP=0, IO0JP=1, IO2JP=1.
+
+
Since jumper IO0JP is tied to GPIO0, which is PIN 21, you'll have to ground it before programming with a USB to serial adapter and reset the board by power cycling it.
+
+
UART pins for programming and serial I/O are GPIO1 (TXD, pin 3) and GPIO3 (RXD, pin 4).
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.
These modules come in different form factors and pinouts. See the page at ESP8266 community wiki for more info:
+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.
+
+
In order to use these modules, make sure to observe the following:
+
+
+
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.
+
Connect bootstapping resistors to GPIO0, GPIO2, GPIO15 according to the schematics below.
+
Put ESP8266 into bootloader mode before uploading code.
+
+
+
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.
+
+
Adapters based around the following ICs should work:
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
+
+
+
+
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
+
+
+
+
Improved Stability
+
+
+
+
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:
+
+
+
+
GPIO15
+
GPIO0
+
GPIO2
+
Mode
+
+
+
+
0V
+
0V
+
3.3V
+
Uart Bootloader
+
+
+
0V
+
3.3V
+
3.3V
+
Boot sketch (SPI flash)
+
+
+
3.3V
+
x
+
x
+
SDIO mode (not used for Arduino)
+
+
+
+
at startup the ESP prints out the current boot mode example:
+
+rst cause:2, boot mode:(3,6)
+
+
+
note:
+ - GPIO2 is used as TX output and the internal Pullup is enabled on boot.
+
+
rst cause
+
+
+
+
Number
+
Description
+
+
+
+
0
+
unknown
+
+
+
1
+
normal boot
+
+
+
2
+
reset pin
+
+
+
3
+
software reset
+
+
+
4
+
watchdog reset
+
+
+
+
boot mode
+
+
the first value respects the pin setup of the Pins 0, 2 and 15.
I2C library updated to better handle repeated start for certain devices,
+improved waveforms, higher frequencies for 160MHz core clock, fix case where
+using different pins would not work with libs calling begin internally.
+
Add Adafruit HUZZAH board
+
Add SparkFun Thing board
+
Add SweetPea ESP-210 board
+
Add eboot bootloader
+
Timer0 support
+
Add PWM range and frequency control
+
Add ESP.eraseConfig method
+
Fix pin change interrupt handling (#322)
+
Add SLC and I2S register definitions
+
Fix math functions calling themselves recursively (#233, #354)
Rebuild toolchain and esptool with support for OS X down to 10.6.
+
+
+
Libraries
+
+
+
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.
+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.
+
SD, Adafruit_ILI9341, and OneWire libraries are now bundled.
+
Fix incorrect sector calculation in EEPROM library.
+
+
+
+
+
1.6.4-628-g545ffde
+
+
May 19, 2015
+
+
+
Initial release of Boards Manager package for ESP8266 platform.
+
+
+
+
+
diff --git a/versions/2.0.0-rc2/doc/eclipse/1_Install_New_Software.png b/versions/2.0.0-rc2/doc/eclipse/1_Install_New_Software.png
new file mode 100644
index 0000000000..a3e9d3619e
Binary files /dev/null and b/versions/2.0.0-rc2/doc/eclipse/1_Install_New_Software.png differ
diff --git a/versions/2.0.0-rc2/doc/eclipse/2_Install_software.png b/versions/2.0.0-rc2/doc/eclipse/2_Install_software.png
new file mode 100644
index 0000000000..b7baadaa9a
Binary files /dev/null and b/versions/2.0.0-rc2/doc/eclipse/2_Install_software.png differ
diff --git a/versions/2.0.0-rc2/doc/eclipse/eclipse.md b/versions/2.0.0-rc2/doc/eclipse/eclipse.md
new file mode 100644
index 0000000000..8c4c1dcb48
--- /dev/null
+++ b/versions/2.0.0-rc2/doc/eclipse/eclipse.md
@@ -0,0 +1,38 @@
+using Eclipse with Arduino ESP8266
+===========================================
+
+### What to Download ###
+- [arduino IDE](https://www.arduino.cc/en/Main/Software)
+- [Eclipse IDE for C/C++ Developers](http://www.eclipse.org/downloads/packages/eclipse-ide-cc-developers/marsr)
+- [Java](http://www.java.com/)
+
+### Setup Arduino ###
+ see the [Readme](https://github.com/esp8266/Arduino#installing-with-boards-manager)
+
+### Setup Eclipse ###
+- [step 1](http://www.baeyens.it/eclipse/how_to.shtml#/c)
+- [step 2](http://www.baeyens.it/eclipse/how_to.shtml#/e)
+- go to Window --> preferences --> Arduino
+- add as private hardware path the Part to the ESP8266
+
+###### example private hardware path
+ Windows: C:\Users\[username]\AppData\Roaming\Arduino15\packages\esp8266\hardware
+ Linux: /home/[username]/.arduino15/packages/esp8266/hardware
+
+### Eclipse wont build ###
+if eclipse dont find the path to the Compiler add to the platform.txt
+after:
+```
+version=1.6.4
+```
+this:
+```
+runtime.tools.xtensa-lx106-elf-gcc.path={runtime.platform.path}/../../../tools/xtensa-lx106-elf-gcc/1.20.0-26-gb404fb9
+runtime.tools.esptool.path={runtime.platform.path}/../../../tools/esptool/0.4.4
+```
+Note:
+ - the path may changed, check the current version.
+ - each update over the Arduino IDE will remove the fix
+ - may not needed in future if Eclipse Plugin get an Update
+
+
\ No newline at end of file
diff --git a/versions/2.0.0-rc2/doc/esp12.png b/versions/2.0.0-rc2/doc/esp12.png
new file mode 100644
index 0000000000..8ec371016a
Binary files /dev/null and b/versions/2.0.0-rc2/doc/esp12.png differ
diff --git a/versions/2.0.0-rc2/doc/esp12.svg b/versions/2.0.0-rc2/doc/esp12.svg
new file mode 100644
index 0000000000..107073dfae
--- /dev/null
+++ b/versions/2.0.0-rc2/doc/esp12.svg
@@ -0,0 +1,1187 @@
+
+
+
+
diff --git a/versions/2.0.0-rc2/doc/esp8266_tcp_active_close.png b/versions/2.0.0-rc2/doc/esp8266_tcp_active_close.png
new file mode 100644
index 0000000000..f9dad09873
Binary files /dev/null and b/versions/2.0.0-rc2/doc/esp8266_tcp_active_close.png differ
diff --git a/versions/2.0.0-rc2/doc/exception_causes.md b/versions/2.0.0-rc2/doc/exception_causes.md
new file mode 100644
index 0000000000..ae3a712633
--- /dev/null
+++ b/versions/2.0.0-rc2/doc/exception_causes.md
@@ -0,0 +1,38 @@
+Exception Causes (EXCCAUSE)
+===========================================
+
+| EXC-CAUSE Code | Cause Name | Cause Description | Required Option | EXC-VADDR Loaded |
+|:--------------:|:---------------------------|:------------------------------------------------------------------------------------------------------------|:-------------------------|:----------------:|
+| 0 | IllegalInstructionCause | Illegal instruction | Exception | No |
+| 1 | SyscallCause | SYSCALL instruction | Exception | No |
+| 2 | InstructionFetchErrorCause | Processor internal physical address or data error during instruction fetch | Exception | Yes |
+| 3 | LoadStoreErrorCause | Processor internal physical address or data error during load or store | Exception | Yes |
+| 4 | Level1InterruptCause | Level-1 interrupt as indicated by set level-1 bits in the INTERRUPT register | Interrupt | No |
+| 5 | AllocaCause | MOVSP instruction, if callers registers are not in the register file | Windowed Register | No |
+| 6 | IntegerDivideByZeroCause | QUOS, QUOU, REMS, or REMU divisor operand is zero | 32-bit Integer Divide | No |
+| 7 | Reserved for Tensilica | | | |
+| 8 | PrivilegedCause | Attempt to execute a privileged operation when CRING ? 0 | MMU | No |
+| 9 | LoadStoreAlignmentCause | Load or store to an unaligned address | Unaligned Exception | Yes |
+| 10..11 | Reserved for Tensilica | | | |
+| 12 | InstrPIFDataErrorCause | PIF data error during instruction fetch | Processor Interface | Yes |
+| 13 | LoadStorePIFDataErrorCause | Synchronous PIF data error during LoadStore access | Processor Interface | Yes |
+| 14 | InstrPIFAddrErrorCause | PIF address error during instruction fetch | Processor Interface | Yes |
+| 15 | LoadStorePIFAddrErrorCause | Synchronous PIF address error during LoadStore access | Processor Interface | Yes |
+| 16 | InstTLBMissCause | Error during Instruction TLB refill | MMU | Yes |
+| 17 | InstTLBMultiHitCause | Multiple instruction TLB entries matched | MMU | Yes |
+| 18 | InstFetchPrivilegeCause | An instruction fetch referenced a virtual address at a ring level less than CRING | MMU | Yes |
+| 19 | Reserved for Tensilica | | | |
+| 20 | InstFetchProhibitedCause | An instruction fetch referenced a page mapped with an attribute that does not permit instruction fetch | Region Protection or MMU | Yes |
+| 21..23 | Reserved for Tensilica | | | |
+| 24 | LoadStoreTLBMissCause | Error during TLB refill for a load or store | MMU | Yes |
+| 25 | LoadStoreTLBMultiHitCause | Multiple TLB entries matched for a load or store | MMU | Yes |
+| 26 | LoadStorePrivilegeCause | A load or store referenced a virtual address at a ring level less than CRING | MMU | Yes |
+| 27 | Reserved for Tensilica | | | |
+| 28 | LoadProhibitedCause | A load referenced a page mapped with an attribute that does not permit loads | Region Protection or MMU | Yes |
+| 29 | StoreProhibitedCause | A store referenced a page mapped with an attribute that does not permit stores | Region Protection or MMU | Yes |
+| 30..31 | Reserved for Tensilica | | | |
+| 32..39 | CoprocessornDisabled | Coprocessor n instruction when cpn disabled. n varies 0..7 as the cause varies 32..39 | Coprocessor | No |
+| 40..63 | Reserved | | | |
+
+
+Infos from Xtensa Instruction Set Architecture (ISA) Reference Manual
\ No newline at end of file
diff --git a/versions/2.0.0-rc2/doc/filesystem.html b/versions/2.0.0-rc2/doc/filesystem.html
new file mode 100644
index 0000000000..37e0c782cc
--- /dev/null
+++ b/versions/2.0.0-rc2/doc/filesystem.html
@@ -0,0 +1,497 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ File System · ESP8266 Arduino Core
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This documentation is for version 2.0.0-rc2. Other versions.
+
Even though file system is stored on the same flash chip as the program, programming new sketch will not modify file system contents. This allows to use file system to store sketch data, configuration files, or content for Web server.
+
+
The following diagram illustrates flash layout used in Arduino environment:
+
|--------------|-------|---------------|--|--|--|--|--|
+^ ^ ^ ^ ^
+Sketch OTA update File system EEPROM WiFi config (SDK)
+
+
File system size depends on the flash chip size. Depending on the board which is selected in IDE, you have the following options for flash size:
+
+
+
+
Board
+
Flash chip size, bytes
+
File system size, bytes
+
+
+
+
Generic module
+
512k
+
64k
+
+
+
Generic module
+
1M
+
64k, 128k, 256k, 512k
+
+
+
Generic module
+
2M
+
1M
+
+
+
Generic module
+
4M
+
3M
+
+
+
Adafruit HUZZAH
+
4M
+
1M, 3M
+
+
+
NodeMCU 0.9
+
4M
+
1M, 3M
+
+
+
NodeMCU 1.0
+
4M
+
1M, 3M
+
+
+
Olimex MOD-WIFI-ESP8266(-DEV)
+
2M
+
1M
+
+
+
SparkFun Thing
+
512k
+
64k
+
+
+
SweetPea ESP-210
+
4M
+
1M, 3M
+
+
+
WeMos D1 & D1 mini
+
4M
+
1M, 3M
+
+
+
+
Note: to use any of file system functions in the sketch, add the following include to the sketch:
+
#include "FS.h"
+
+
Uploading files to file system
+
+
ESP8266FS is a tool which integrates into the Arduino IDE. It adds a menu item to Tools menu for uploading the contents of sketch data directory into ESP8266 flash file system.
In your Arduino sketchbook directory, create tools directory if it doesn't exist yet
+
Unpack the tool into tools directory (the path will look like <home_dir>/Arduino/tools/ESP8266FS/tool/esp8266fs.jar)
+
Restart Arduino IDE
+
Open a sketch (or create a new one and save it)
+
Go to sketch directory (choose Sketch > Show Sketch Folder)
+
Create a directory named data and any files you want in the file system there
+
Make sure you have selected a board, port, and closed Serial Monitor
+
Select Tools > ESP8266 Sketch Data Upload. This should start uploading the files into ESP8266 flash file system. When done, IDE status bar will display SPIFFS Image Uploaded message.
+
+
+
File system object (SPIFFS)
+
+
begin
+
SPIFFS.begin()
+
+
This method mounts SPIFFS file system. It must be called before any other
+FS APIs are used. Returns true if file system was mounted successfully, false
+otherwise.
+
+
format
+
SPIFFS.format()
+
+
Formats the file system. May be called either before or after calling begin.
+Returns true if formatting was successful.
+
+
open
+
SPIFFS.open(path,mode)
+
+
Opens a file. path should be an absolute path starting with a slash
+(e.g. /dir/filename.txt). mode is a string specifying access mode. It can be
+one of "r", "w", "a", "r+", "w+", "a+". Meaning of these modes is the same as
+for fopen C function.
+
+
Returns File object. To check whether the file was opened successfully, use
+the boolean operator.
+
Filef=SPIFFS.open("/f.txt","w");
+if(!f){
+ Serial.println("file open failed");
+}
+
+
exists
+
SPIFFS.exists(path)
+
+
Returns true if a file with given path exists, false otherwise.
+
+
openDir
+
SPIFFS.openDir(path)
+
+
Opens a directory given its absolute path. Returns a Dir object. To check if
+directory was opened successfully, use the boolean operator, similar to opening
+a file.
+
+
remove
+
SPIFFS.remove(path)
+
+
Deletes the file given its absolute path. Returns true if file was deleted successfully.
+
+
rename
+
SPIFFS.rename(pathFrom,pathTo)
+
+
Renames file from pathFrom to pathTo. Paths must be absolute. Returns true
+if file was renamed successfully.
+
+
info
+
FSInfofs_info;
+SPIFFS.info(fs_info);
+
+
Fills FSInfo structure with information about
+the file system. Returns true is successful, false otherwise.
dir.next() returns true while there are files in the directory to iterate over.
+It must be called before calling fileName and openFile functions.
+
+
openFile method takes mode argument which has the same meaning as for SPIFFS.open function.
+
+
File object
+
+
SPIFFS.open and dir.openFile functions return a File object. This object
+supports all the functions of Stream, so you can use readBytes, findUntil,
+parseInt, println, and all other Stream methods.
+
+
There are also some functions which are specific to File object.
+
+
seek
+
file.seek(offset,mode)
+
+
This function behaves like fseek C function. Depending on the value of mode,
+it moves current position in a file as follows:
+
+
+
if mode is SeekSet, position is set to offset bytes from the beginning.
+
if mode is SeekCur, current position is moved by offset bytes.
+
if mode is SeekEnd, position is set to offset bytes from the end of the
+file.
+
+
+
Returns true if position was set successfully.
+
+
position
+
file.position()
+
+
Returns the current position inside the file, in bytes.
+
+
size
+
file.size()
+
+
Returns file size, in bytes.
+
+
name
+
Stringname=file.name();
+
+
Returns file name, as const char*. Convert it to String for storage.
+
+
close
+
file.close()
+
+
Close the file. No other operations should be performed on File object after close function was called.
Documentation for ESP8266 Arduino Core. Installation instructions, functions and classes reference.
+
+
+
+
+
+
+
Boards Manager
+
+
This is the suggested installation method for end users.
+
+
Prerequisites
+
+
+
Arduino 1.6.5, get it from Arduino website. Arduino 1.6.6 has several issues, so we recommend to stick with 1.6.5 for now.
+
Internet connection
+
+
+
Instructions
+
+
+
Start Arduino and open Preferences window.
+
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 find esp8266 platform.
+
Select the version you need from a drop-down box.
+
Click install button.
+
Don't forget to select your ESP8266 board from Tools > Board menu after installation.
+
+
+
You may optionally use staging boards manager package link:
+http://arduino.esp8266.com/staging/package_esp8266com_index.json. This may contain some new features, but at the same time, some things might be broken.
+
+
Using git version
+
+
This is the suggested installation method for contributors and library developers.
+
+
Prerequisites
+
+
+
Arduino 1.6.5 (or newer, if you know what you are doing)
+
git
+
python 2.7
+
terminal, console, or command prompt (depending on you OS)
+
Internet connection
+
+
+
Instructions
+
+
+
Open the console and go to Arduino directory. This can be either your sketchbook directory (usually <Documents>/Arduino), or the directory of Arduino application itself, the choice is up to you.
+
Clone this repository into hardware/esp8266com/esp8266 directory. Alternatively, clone it elsewhere and create a symlink, if your OS supports them.
Documentation for ESP8266 Arduino Core. Installation instructions, functions and classes reference.
+
+
+
+
+
+
+
Table of Contents
+
* [WiFi(ESP8266WiFi library)](#wifiesp8266wifi-library)
+* [Ticker](#ticker)
+* [EEPROM](#eeprom)
+* [I2C (Wire library)](#i2c-wire-library)
+* [SPI](#spi)
+* [SoftwareSerial](#softwareserial)
+* [ESP\-specific APIs](#esp-specific-apis)
+* [OneWire](#onewire)
+* [mDNS and DNS\-SD responder (ESP8266mDNS library)](#mdns-and-dns-sd-responder-esp8266mdns-library)
+* [SSDP responder (ESP8266SSDP)](#ssdp-responder-esp8266ssdp)
+* [DNS server (DNSServer library)](#dns-server-dnsserver-library)
+* [Servo](#servo)
+* [Other libraries (not included with the IDE)](#other-libraries-not-included-with-the-ide)
+
+
WiFi(ESP8266WiFi library)
+
+
This is mostly similar to WiFi shield library. Differences include:
+
+
+
WiFi.mode(m): set mode to WIFI_AP, WIFI_STA, WIFI_AP_STA or WIFI_OFF.
+
call WiFi.softAP(ssid) to set up an open network
+
call WiFi.softAP(ssid, password) to set up a WPA2-PSK network (password should be at least 8 characters)
+
WiFi.macAddress(mac) is for STA, WiFi.softAPmacAddress(mac) is for AP.
+
WiFi.localIP() is for STA, WiFi.softAPIP() is for AP.
+
WiFi.printDiag(Serial) will print out some diagnostic info
+
WiFiUDP class supports sending and receiving multicast packets on STA interface.
+When sending a multicast packet, replace udp.beginPacket(addr, port) with
+udp.beginPacketMulticast(addr, port, WiFi.localIP()).
+When listening to multicast packets, replace udp.begin(port) with
+udp.beginMulticast(WiFi.localIP(), multicast_ip_addr, port).
+You can use udp.destinationIP() to tell whether the packet received was
+sent to the multicast or unicast address.
+
+
+
WiFiServer, WiFiClient, and WiFiUDP behave mostly the same way as with WiFi shield library.
+Four samples are provided for this library.
+You can see more commands here: http://www.arduino.cc/en/Reference/WiFi
+
+
Ticker
+
+
Library for calling functions repeatedly with a certain period. Two examples included.
+
+
It is currently not recommended to do blocking IO operations (network, serial, file) from Ticker
+callback functions. Instead, set a flag inside the ticker callback and check for that flag inside the loop function.
+
+
EEPROM
+
+
This is a bit different from standard EEPROM class. You need to call EEPROM.begin(size)
+before you start reading or writing, size being the number of bytes you want to use.
+Size can be anywhere between 4 and 4096 bytes.
+
+
EEPROM.write does not write to flash immediately, instead you must call EEPROM.commit()
+whenever you wish to save changes to flash. EEPROM.end() will also commit, and will
+release the RAM copy of EEPROM contents.
+
+
EEPROM library uses one sector of flash located just after the SPIFFS.
+
+
Three examples included.
+
+
I2C (Wire library)
+
+
Wire library currently supports master mode up to approximately 450KHz.
+Before using I2C, pins for SDA and SCL need to be set by calling
+Wire.begin(int sda, int scl), i.e. Wire.begin(0, 2) on ESP-01,
+else they default to pins 4(SDA) and 5(SCL).
+
+
SPI
+
+
SPI library supports the entire Arduino SPI API including transactions, including setting phase (CPHA).
+Setting the Clock polarity (CPOL) is not supported, yet (SPI_MODE2 and SPI_MODE3 not working).
+
+
SoftwareSerial
+
+
An ESP8266 port of SoftwareSerial library done by Peter Lerup (@plerup) supports baud rate up to 115200 and multiples SoftwareSerial instances. See https://github.com/plerup/espsoftwareserial if you want to suggest an improvement or open an issue related to SoftwareSerial.
+
+
ESP-specific APIs
+
+
APIs related to deep sleep and watchdog timer are available in the ESP object, only available in Alpha version.
+
+
ESP.deepSleep(microseconds, mode) will put the chip into deep sleep. mode is one of WAKE_RF_DEFAULT, WAKE_RFCAL, WAKE_NO_RFCAL, WAKE_RF_DISABLED. (GPIO16 needs to be tied to RST to wake from deepSleep.)
+
+
ESP.restart() restarts the CPU.
+
+
ESP.getFreeHeap() returns the free heap size.
+
+
ESP.getChipId() returns the ESP8266 chip ID as a 32-bit integer.
+
+
Several APIs may be used to get flash chip info:
+
+
ESP.getFlashChipId() returns the flash chip ID as a 32-bit integer.
+
+
ESP.getFlashChipSize() returns the flash chip size, in bytes, as seen by the SDK (may be less than actual size).
+
+
ESP.getFlashChipSpeed(void) returns the flash chip frequency, in Hz.
+
+
ESP.getCycleCount() returns the cpu instruction cycle count since start as an unsigned 32-bit. This is useful for accurate timing of very short actions like bit banging.
+
+
ESP.getVcc() may be used to measure supply voltage. ESP needs to reconfigure the ADC
+at startup in order for this feature to be available. Add the following line to the top
+of your sketch to use getVcc:
+
ADC_MODE(ADC_VCC);
+
+
TOUT pin has to be disconnected in this mode.
+
+
Note that by default ADC is configured to read from TOUT pin using analogRead(A0), and
+ESP.getVCC() is not available.
+
+
OneWire
+
+
Library was adapted to work with ESP8266 by including register definitions into OneWire.h
+Note that if you already have OneWire library in your Arduino/libraries folder, it will be used
+instead of the one that comes with this package.
+
+
mDNS and DNS-SD responder (ESP8266mDNS library)
+
+
Allows the sketch to respond to multicast DNS queries for domain names like "foo.local", and DNS-SD (service dicovery) queries.
+See attached example for details.
+
+
SSDP responder (ESP8266SSDP)
+
+
SSDP is another service discovery protocol, supported on Windows out of the box. See attached example for reference.
+
+
DNS server (DNSServer library)
+
+
Implements a simple DNS server that can be used in both STA and AP modes. The DNS server currently supports only one domain (for all other domains it will reply with NXDOMAIN or custom status code). With it clients can open a web server running on ESP8266 using a domain name, not an IP address.
+See attached example for details.
+
+
Servo
+
+
This library exposes the ability to control RC (hobby) servo motors. It will support upto 24 servos on any available output pin. By defualt the first 12 servos will use Timer0 and currently this will not interfere with any other support. Servo counts above 12 will use Timer1 and features that use it will be effected.
+While many RC servo motors will accept the 3.3V IO data pin from a ESP8266, most will not be able to run off 3.3v and will require another power source that matches their specifications. Make sure to connect the grounds between the ESP8266 and the servo motor power supply.
+
+
Other libraries (not included with the IDE)
+
+
Libraries that don't rely on low-level access to AVR registers should work well. Here are a few libraries that were verified to work:
+
+
+
arduinoWebSockets - WebSocket Server and Client compatible with ESP8266 (RFC6455)
DHT-sensor-library - Arduino library for the DHT11/DHT22 temperature and humidity sensors. Download latest v1.1.1 library and no changes are necessary. Older versions should initialize DHT as follows: DHT dht(DHTPIN, DHTTYPE, 15)
+
NeoPixel - Adafruit's NeoPixel library, now with support for the ESP8266 (use version 1.0.2 or higher from Arduino's library manager).
+
NeoPixelBus - Arduino NeoPixel library compatible with ESP8266. Use the "NeoPixelAnimator" branch for ESP8266 to get HSL color support and more.
RTC - Arduino Library for Ds1307 & Ds3231 compatible with ESP8266.
+
Souliss, Smart Home - Framework for Smart Home based on Arduino, Android and openHAB.
+
ST7735 - Adafruit's ST7735 library modified to be compatible with ESP8266. Just make sure to modify the pins in the examples as they are still AVR specific.
+
+
+
+
+
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-ide-module-joined-wifi.png b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-module-joined-wifi.png
new file mode 100644
index 0000000000..34b93e3d20
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-module-joined-wifi.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-ide-ota-port-selection.png b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-ota-port-selection.png
new file mode 100644
index 0000000000..18bbc72102
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-ota-port-selection.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-ide-ota-upload-complete.png b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-ota-upload-complete.png
new file mode 100644
index 0000000000..76e24efb30
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-ota-upload-complete.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-ide-ota-upload-configuration.png b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-ota-upload-configuration.png
new file mode 100644
index 0000000000..0b8cc4584e
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-ota-upload-configuration.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-ide-python-configuration.png b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-python-configuration.png
new file mode 100644
index 0000000000..0e78f72a12
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-python-configuration.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-ide-serial-upload-configuration.png b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-serial-upload-configuration.png
new file mode 100644
index 0000000000..1116a0cad2
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-serial-upload-configuration.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-ide-sketch-selection.png b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-sketch-selection.png
new file mode 100644
index 0000000000..1c9053c53b
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-sketch-selection.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-ide-ssid-pass-entry.png b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-ssid-pass-entry.png
new file mode 100644
index 0000000000..8aae132aa1
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-ide-ssid-pass-entry.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-web-browser-form-ok.png b/versions/2.0.0-rc2/doc/ota_updates/ota-web-browser-form-ok.png
new file mode 100644
index 0000000000..ed44e9cbba
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-web-browser-form-ok.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-web-browser-form.png b/versions/2.0.0-rc2/doc/ota_updates/ota-web-browser-form.png
new file mode 100644
index 0000000000..87872393f6
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-web-browser-form.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-web-path-to-binary.png b/versions/2.0.0-rc2/doc/ota_updates/ota-web-path-to-binary.png
new file mode 100644
index 0000000000..9237d87805
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-web-path-to-binary.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-web-serial-monitor-ready.png b/versions/2.0.0-rc2/doc/ota_updates/ota-web-serial-monitor-ready.png
new file mode 100644
index 0000000000..5ce011170c
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-web-serial-monitor-ready.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-web-serial-monitor-reboot.png b/versions/2.0.0-rc2/doc/ota_updates/ota-web-serial-monitor-reboot.png
new file mode 100644
index 0000000000..0fd469e116
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-web-serial-monitor-reboot.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota-web-show-verbose-compilation.png b/versions/2.0.0-rc2/doc/ota_updates/ota-web-show-verbose-compilation.png
new file mode 100644
index 0000000000..00ac3871fe
Binary files /dev/null and b/versions/2.0.0-rc2/doc/ota_updates/ota-web-show-verbose-compilation.png differ
diff --git a/versions/2.0.0-rc2/doc/ota_updates/ota_updates.html b/versions/2.0.0-rc2/doc/ota_updates/ota_updates.html
new file mode 100644
index 0000000000..d30a3cd466
--- /dev/null
+++ b/versions/2.0.0-rc2/doc/ota_updates/ota_updates.html
@@ -0,0 +1,630 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ OTA Update · ESP8266 Arduino Core
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This documentation is for version 2.0.0-rc2. Other versions.
+
OTA (Over the Air) update is the process of loading the firmware to ESP module using Wi-Fi connection rather that a serial port. Such functionality became extremely useful in case of limited or no physical access to the module.
Arduino IDE option is intended primarily for software development phase. The two other options would be more useful after deployment, to provide module with application updates manually with a web browser or automatically using a http server.
+
+
In any case first firmware upload have to be done over a serial port. If OTA routines are correctly implemented in a sketch, then all subsequent uploads may be done over the air.
+
+
There is no imposed security on OTA process from being hacked. It is up to developer to ensure that updates are allowed only from legitimate / trusted source. Once update is complete, module restarts and new code is executed. Developer should ensure that application running on module is shut down and restarted in a safe manner. Chapters below provide additional information regarding security and safety of OTA process.
+
+
Security
+
+
Module has to be exposed wirelessly to get it updated with a new sketch. That poses chances of module being violently hacked and loaded with some other code. To reduce likelihood of being hacked consider protecting your uploads with a password, selecting certain OTA port, etc.
+
+
Check functionality provided with ArduinoOTA library that may improve security:
Certain protection functionality is already built in and do not require any additional coding by developer. ArduinoOTA and espota.py use Digest-MD5 to authenticate upload. Integrity of transferred data is verified on ESP side using MD5 checksum.
+
+
Make your own risk analysis and depending on application decide what library functions to implement. If required consider implementation of other means of protection from being hacked, e.g. exposing module for uploads only according to specific schedule, trigger OTA only be user pressing dedicated “Update” button, etc.
+
+
Safety
+
+
OTA process takes ESP’s resources and bandwidth during upload. Then module is restarted and a new sketch executed. Analyse and test how it affects functionality of your existing and new sketch.
+
+
If ESP is placed in remote location and controlling some equipment, you should put additional attention what happens if operation of this equipment is suddenly interrupted by update process. Therefore decide how to put this equipment into safe state before starting the update. For instance your module may be controlling a garden watering system in a sequence. If this sequence is not properly shut down and a water valve left open, your garden may be flooded if this valve is not closed after OTA is finished and module restarts.
+
+
The following functions are provided with ArduinoOTA library and intended to handle functionality of your application during specific stages of OTA or on an OTA error:
The following chapters provide more details and specific methods of doing OTA.
+
+
Arduino IDE
+
+
Uploading modules wirelessly from Arduino IDE is intended for the following typical scenarios:
+- during firmware development as a quicker alternative to loading over a serial
+- for updating small quantity of modules
+- only if modules are available on the same network as the computer with Arduino IDE
+
+
Requirements
+
+
+
The ESP and the computer must be connected to the same network.
+
+
+
Application Example
+
+
Currently there are two software configurations that support OTA updates.
+
+
+
Classic OTA: Arduino IDE 1.6.5 and 1.6.5-947-g39819f0 (of July 23, 2015) or 1.6.5-1160-gef26c5f (of Sep 30, 2015) version of platform package that provides first OTA implementation, yet without support for ArduinoOTA library. This particular configuration is easier to configure in Arduino IDE and therefore suggested for less experienced users. It soon will be depreciated once implementation below is fully released.
+
ArduinoOTA: Arduino-PR-4107-BUILD-421 and latest git version of platform package that includes ArduinoOTA library. This configuration features preliminary build of Arduino IDE and is intended for more experienced users. Please mid your step.
+
+
+
Instructions below demonstrate how to configure both Classic OTA and ArduinoOTA using NodeMCU 1.0 (ESP-12E Module) board.
+
+
Classic OTA
+
+
+
Before you begin, please make sure that you have the following installed:
Python 2.7 (do not install Python 3.5 that is not supported):
+
+
Note: Windows users should select “Add python.exe to Path” (see below – this option is not selected by default).
+
+
+
+
Now prepare the sketch and configuration for the upload over a serial port.
+
+
+
Start Arduino IDE and load sketch DNS_SD_Arduino_OTA.ino available under File > Examples > ESP8266mDNS
+
+ Note: This sketch is available only for 1.6.5-947-g39819f0 (of July 23, 2015) and 1.6.5-1160-gef26c5f (of Sep 30, 2015) versions of platform packages installed in Arduino IDE using https://github.com/esp8266/Arduino#installing-with-boards-manager. It was removed in #980 from GitHub repository.
+
Update ssid and pass in the sketch so the module can join your Wi-Fi network
+
+
Configure upload parameters as below (you may need to adjust configuration if you are using a different module):
+
+
+
Upload the sketch (Ctrl+U). Once done open Serial Monitor (Ctrl+Shift+M) and check if module has joined your Wi-Fi network.
+
+
+
Only if module is connected to network, after a couple of seconds, the esp8266-ota port will show up in Arduino IDE:
+
+
+
Now get ready for your first OTA upload by changing configuration settings as follows:
+
+
+
+
Note: If you do not see “Upload Using: OTA” option available for “NodeMCU 1.0 (ESP-12E Module)” board, please upload the latest boards.txt file from GitHub repository, replace existing file and restart Arduino IDE.
+
If you have successfully completed all the above steps, you can upload (Ctrl+U) the same (or any other) sketch over OTA:
+
+
+
+
+
Note To be able to upload your sketch over and over again using OTA, you need to embed OTA routines inside. Please use DNS_SD_Arduino_OTA.ino as an example.
Updates described in this chapter are done with a web browser that can be useful in the following typical scenarios:
+
+
+
after application deployment if loading directly from Arduino IDE is inconvenient or not possible
+
after deployment if user is unable to expose module for OTA from external update server
+
to provide updates after deployment to small quantity of modules when setting an update server is not practicable
+
+
+
Requirements
+
+
+
The ESP and the computer must be connected to the same network.
+
+
+
Implementation Overview
+
+
Updates with a web browswer are implemented using ESP8266HTTPUpdateServer class together with ESP8266WebServer and ESP8266mDNS classes. The following code is required to get it work:
Mac OSX and iOS - support is already built in / no any extra s/w is required
+
+
+
Prepare the sketch and configuration for initial upload with a serial port.
+
+
+
Start Arduino IDE and load sketch WebUpdater.ino available under File > Examples > ESP8266HTTPUpdateServer.
+
Update ssid and pass in the sketch so the module can join your Wi-Fi network.
+
Open File > Preferences, look for “Show verbose output during:” and check out “compilation” option.
+
+Note: This setting will be required in step 5 below. You can uncheck this setting afterwards.
+
+
Upload sketch (Ctrl+U). Once done open Serial Monitor (Ctrl+Shift+M) and check if you see the following message displayed, that contains url for OTA update.
+
+Note: Such message will be shown only after module successfully joins network and is ready for an OTA upload:
+
Now open web browser and enter the url provided on Serial Monitor, i.e. http://esp8266-webupdate.local/update. Once entered, browser should display a form like below that has been served by your module. The form invites you to choose a file for update.
+
+Note: If entering “http://esp8266-webupdate.local/update” does not work, try replacing “esp8266-webupdate” with module’s IP address. For example, if your module IP is “192.168.1.100” then url should be “http://192.168.1.100/update”. This workaround is useful in case the host software installed in step 2 does not work. If still nothing works and there are no clues on Serial Monitor, try to diagnose issue by opening provided url in Google Chrome, pressing F12 and checking contents of “Console” and “Network” tabs. Chrome provides some advanced logging on these tabs.
+
To obtain the file navigate to directory used by Arduino IDE to store results of compilation. You can check the path to this file in compilation log shown in IDE debug window as marked below.
+
+
+
Now press “Choose File” in web browser, go to directory identified in step 5 above, find the file “WebUpdater.cpp.bin” and upload it. If upload is successful you will see “OK” on web browser like below.
+
+
+
+
Module will reboot that should be visible on Serial Monitor:
+
+
+
+
+
Just after reboot you should see exactly the same message “HTTPUpdateServer ready! Open http:// esp8266-webupdate.local /update in your browser” like in step 3. This is because module has been loaded again with the same code – first using serial port, and then using OTA.
+
+
Once you are comfortable with this procedure go ahead and modify WebUpdater.ino sketch to print some additional messages, compile it, locate new binary file and upload it using web browser to see entered changes on a Serial Monitor.
+
+
You can also add OTA routines to your own sketch following guidelines in Implementation Overview above. If this is done correctly you should be always able to upload new sketch over the previous one using a web browser.
+
+
In case OTA update fails dead after entering modifications in your sketch, you can always recover module by loading it over a serial port. Then diagnose the issue with sketch using Serial Monitor. Once the issue is fixed try OTA again.
+
+
HTTP Server
+
+
ESPhttpUpdate class can check for updates and download a binary file from HTTP web server.
+It is possible to download updates from every IP or domain address on the network or Internet.
+
+
Requirements
+
+
+
web server
+
+
+
Arduino code
+
+
Simple updater
+
+
Simple updater downloads the file every time the function is called.
Its possible to point update function to a script at the server.
+If version string argument is given, it will be sent to the server.
+Server side script can use this to check if update should be performed.
+
+
Server side script can respond as follows:
+- response code 200, and send the firmware image,
+- or response code 304 to notify ESP that no update is required.
+
t_httpUpdate_returnret=ESPhttpUpdate.update("192.168.0.2",80,"/esp/update/arduino.php","optional current version string here");
+switch(ret){
+ caseHTTP_UPDATE_FAILED:
+ Serial.println("[update] Update failed.");
+ break;
+ caseHTTP_UPDATE_NO_UPDATES:
+ Serial.println("[update] Update no Update.");
+ break;
+ caseHTTP_UPDATE_OK:
+ Serial.println("[update] Update ok.");// may not called we reboot the ESP
+ break;
+}
+
+
Server request handling
+
+
Simple updater
+
+
For the simple updater the server only needs to deliver the binary file for update.
+
+
Advanced updater
+
+
For advanced update management a script needs to run at the server side, for example a PHP script.
+At every update request the the ESP sends some information in HTTP headers to the server.
With this information the script now can check if a update is needed. It is also possible to deliver different binaries based on the MAC address for example.
The Stream Interface is the base for all other update modes like OTA, http Server / client.
+
+
Updater class
+
+
TODO describe Updater class
+
+
Updater is in the Core and deals with writing the firmware to the flash, checking its integrity and telling the bootloader to load the new firmware on the next boot.
Pin numbers in Arduino correspond directly to the ESP8266 GPIO pin numbers. pinMode, digitalRead, and digitalWrite functions work as usual, so to read GPIO2, call digitalRead(2).
+
+
Digital pins 0—15 can be INPUT, OUTPUT, or INPUT_PULLUP.
+Pin 16 can be INPUT, OUTPUT or INPUT_PULLDOWN_16. At startup, pins are configured as INPUT.
+
+
Pins may also serve other functions, like Serial, I2C, SPI. These functions are normally activated by the corresponding library. The diagram below shows pin mapping for the popular ESP-12 module.
+
+
+
+
Digital pins 6—11 are not shown on this diagram because they are used to connect flash memory chip on most modules. Trying to use these pins as IOs will likely cause the program to crash.
+
+
Note that some boards and modules (ESP-12ED, NodeMCU 1.0) also break out pins 9 and 11. These may be used as IO if flash chip works in DIO mode (as opposed to QIO, which is the default one).
+
+
Pin interrupts are supported through attachInterrupt, detachInterrupt functions.
+Interrupts may be attached to any GPIO pin, except GPIO16. Standard Arduino interrupt
+types are supported: CHANGE, RISING, FALLING.
+
+
Analog input
+
+
ESP8266 has a single ADC channel available to users. It may be used either to read voltage at ADC pin, or to read module supply voltage (VCC).
+
+
To read external voltage applied to ADC pin, use analogRead(A0). Input voltage range is 0 — 1.0V.
+
+
To read VCC voltage, ADC pin must be kept unconnected. Additionally, the following line has to be added to the sketch:
+
ADC_MODE(ADC_VCC);
+
+
This line has to appear outside of any functions, for instance right after the #include lines of your sketch.
+
+
Analog output
+
+
analogWrite(pin, value) enables software PWM on the given pin. PWM may be used on pins 0 to 16.
+Call analogWrite(pin, 0) to disable PWM on the pin. value may be in range from 0 to PWMRANGE, which is equal to 1023 by default. PWM range may be changed by calling analogWriteRange(new_range).
+
+
PWM frequency is 1kHz by default. Call analogWriteFreq(new_frequency) to change the frequency.
+
+
Timing and delays
+
+
millis() and micros() return the number of milliseconds and microseconds elapsed after reset, respectively.
+
+
delay(ms) pauses the sketch for a given number of milliseconds and allows WiFi and TCP/IP tasks to run.
+delayMicroseconds(us) pauses for a given number of microseconds.
+
+
Remember that there is a lot of code that needs to run on the chip besides the sketch
+when WiFi is connected. WiFi and TCP/IP libraries get a chance to handle any pending
+events each time the loop() function completes, OR when delay is called.
+If you have a loop somewhere in your sketch that takes a lot of time (>50ms) without
+calling delay, you might consider adding a call to delay function to keep the WiFi
+stack running smoothly.
+
+
There is also a yield() function which is equivalent to delay(0). The delayMicroseconds
+function, on the other hand, does not yield to other tasks, so using it for delays
+more than 20 milliseconds is not recommended.
+
+
Serial
+
+
Serial object works much the same way as on a regular Arduino. Apart from hardware FIFO (128 bytes for TX and RX) HardwareSerial has additional 256-byte TX and RX buffers. Both transmit and receive is interrupt-driven. Write and read functions only block the sketch execution when the respective FIFO/buffers are full/empty.
+
+
Serial uses UART0, which is mapped to pins GPIO1 (TX) and GPIO3 (RX). Serial may be remapped to GPIO15 (TX) and GPIO13 (RX) by calling Serial.swap() after Serial.begin. Calling swap again maps UART0 back to GPIO1 and GPIO3.
+
+
Serial1 uses UART1, TX pin is GPIO2. UART1 can not be used to receive data because normally it's RX pin is occupied for flash chip connection. To use Serial1, call Serial1.begin(baudrate).
+
+
By default the diagnostic output from WiFi libraries is disabled when you call Serial.begin. To enable debug output again, call Serial.setDebugOutput(true). To redirect debug output to Serial1 instead, call Serial1.setDebugOutput(true).
+
+
You also need to use Serial.setDebugOutput(true) to enable output from printf() function.
+
+
Both Serial and Serial1 objects support 5, 6, 7, 8 data bits, odd (O), even (E), and no (N) parity, and 1 or 2 stop bits. To set the desired mode, call Serial.begin(baudrate, SERIAL_8N1), Serial.begin(baudrate, SERIAL_6E2), etc.
+
+
Progmem
+
+
The Program memory features work much the same way as on a regular Arduino; placing read only data and strings in read only memory and freeing heap for your application.
+The important difference is that on the ESP8266 the literal strings are not pooled. This means that the same literal string defined inside a F("") and/or PSTR("") will take up space for each instance in the code. So you will need to manage the duplicate strings yourself.
+
+
There is one additional helper macro to make it easier to pass const PROGMEM strings to methods that take a __FlashStringHelper called FPSTR(). The use of this will help make it easier to pool strings.
+Not pooling strings...
" + header.innerHTML + "";
+ else if (this_level <= level){ // higher level than before; end parent ol
+ for(i = this_level; i < level; i++) {
+ html += "
"
+ }
+ html += "
" + header.innerHTML + "";
+ }
+ else if (this_level > level) { // lower level than before; expand the previous to contain a ol
+ for(i = this_level; i > level; i--) {
+ html += "<"+settings.listType+">
"
+ }
+ html += "" + header.innerHTML + "";
+ }
+ level = this_level; // update for the next one
+ });
+ html += "";
+ if (!settings.noBackToTopLinks) {
+ $(document).on('click', '.back-to-top', function() {
+ $(window).scrollTop(0);
+ window.location.hash = '';
+ });
+ }
+
+ render[settings.showEffect]();
+ };
+})(jQuery);
diff --git a/versions/2.0.0-rc2/ver_index.html b/versions/2.0.0-rc2/ver_index.html
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/versions/2.0.0/badge.svg b/versions/2.0.0/badge.svg
new file mode 100644
index 0000000000..1fb731712f
--- /dev/null
+++ b/versions/2.0.0/badge.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/versions/2.0.0/doc/ESP01_connect.jpg b/versions/2.0.0/doc/ESP01_connect.jpg
new file mode 100644
index 0000000000..6b0c240881
Binary files /dev/null and b/versions/2.0.0/doc/ESP01_connect.jpg differ
diff --git a/versions/2.0.0/doc/ESP_improved_stability.png b/versions/2.0.0/doc/ESP_improved_stability.png
new file mode 100644
index 0000000000..74a7e01eeb
Binary files /dev/null and b/versions/2.0.0/doc/ESP_improved_stability.png differ
diff --git a/versions/2.0.0/doc/ESP_min.png b/versions/2.0.0/doc/ESP_min.png
new file mode 100644
index 0000000000..59dc10c15a
Binary files /dev/null and b/versions/2.0.0/doc/ESP_min.png differ
diff --git a/versions/2.0.0/doc/ESP_to_serial.png b/versions/2.0.0/doc/ESP_to_serial.png
new file mode 100644
index 0000000000..9dd116be74
Binary files /dev/null and b/versions/2.0.0/doc/ESP_to_serial.png differ
diff --git a/versions/2.0.0/doc/boards.html b/versions/2.0.0/doc/boards.html
new file mode 100644
index 0000000000..60ef5b65d2
--- /dev/null
+++ b/versions/2.0.0/doc/boards.html
@@ -0,0 +1,702 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Supported Hardware · ESP8266 Arduino Core
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This documentation is for version 2.0.0. Other versions.
+
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
+
+
This module is sold under many names for around $6.50 on AliExpress and it's one of the cheapest, fully integrated ESP8266 solutions.
+
+
It's an open hardware design with an ESP-12E core and 4 MB of SPI flash.
+
+
Acording to the manufacturer, "with a micro USB cable, you can connect NodeMCU devkit to your laptop and flash it without any trouble". This is more or less true: the board comes with a CP2102 onboard USB to serial adapter which just works, well, the majority of the time. Sometimes flashing fails and you have to reset the board by holding down FLASH + RST, then releasing FLASH, then releasing RST. This forces the CP2102 device to power cycle and to be re-numbered by Linux.
+
+
The board also features a NCP1117 voltage regulator, a blue LED on GPIO16 and a 220k/100k Ohm voltage divider on the ADC input pin.
This board comes with 2 MB of SPI flash and optional accessories (e.g. evaluation board ESP8266-EVB or BAT-BOX for batteries).
+
+
The basic module has three solder jumpers that allow you to switch the operating mode between SDIO, UART and FLASH.
+
+
The board is shipped for FLASH operation mode, with jumpers TD0JP=0, IO0JP=1, IO2JP=1.
+
+
Since jumper IO0JP is tied to GPIO0, which is PIN 21, you'll have to ground it before programming with a USB to serial adapter and reset the board by power cycling it.
+
+
UART pins for programming and serial I/O are GPIO1 (TXD, pin 3) and GPIO3 (RXD, pin 4).
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.
These modules come in different form factors and pinouts. See the page at ESP8266 community wiki for more info:
+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.
+
+
In order to use these modules, make sure to observe the following:
+
+
+
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.
+
Connect bootstapping resistors to GPIO0, GPIO2, GPIO15 according to the schematics below.
+
Put ESP8266 into bootloader mode before uploading code.
+
+
+
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.
+
+
Adapters based around the following ICs should work:
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
+
+
+
+
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
+
+
+
+
Improved Stability
+
+
+
+
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:
+
+
+
+
GPIO15
+
GPIO0
+
GPIO2
+
Mode
+
+
+
+
0V
+
0V
+
3.3V
+
Uart Bootloader
+
+
+
0V
+
3.3V
+
3.3V
+
Boot sketch (SPI flash)
+
+
+
3.3V
+
x
+
x
+
SDIO mode (not used for Arduino)
+
+
+
+
at startup the ESP prints out the current boot mode example:
+
+rst cause:2, boot mode:(3,6)
+
+
+
note:
+ - GPIO2 is used as TX output and the internal Pullup is enabled on boot.
+
+
rst cause
+
+
+
+
Number
+
Description
+
+
+
+
0
+
unknown
+
+
+
1
+
normal boot
+
+
+
2
+
reset pin
+
+
+
3
+
software reset
+
+
+
4
+
watchdog reset
+
+
+
+
boot mode
+
+
the first value respects the pin setup of the Pins 0, 2 and 15.
I2C library updated to better handle repeated start for certain devices,
+improved waveforms, higher frequencies for 160MHz core clock, fix case where
+using different pins would not work with libs calling begin internally.
+
Add Adafruit HUZZAH board
+
Add SparkFun Thing board
+
Add SweetPea ESP-210 board
+
Add eboot bootloader
+
Timer0 support
+
Add PWM range and frequency control
+
Add ESP.eraseConfig method
+
Fix pin change interrupt handling (#322)
+
Add SLC and I2S register definitions
+
Fix math functions calling themselves recursively (#233, #354)
Rebuild toolchain and esptool with support for OS X down to 10.6.
+
+
+
Libraries
+
+
+
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.
+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.
+
SD, Adafruit_ILI9341, and OneWire libraries are now bundled.
+
Fix incorrect sector calculation in EEPROM library.
+
+
+
+
+
1.6.4-628-g545ffde
+
+
May 19, 2015
+
+
+
Initial release of Boards Manager package for ESP8266 platform.
+
+
+
+
+
diff --git a/versions/2.0.0/doc/eclipse/1_Install_New_Software.png b/versions/2.0.0/doc/eclipse/1_Install_New_Software.png
new file mode 100644
index 0000000000..a3e9d3619e
Binary files /dev/null and b/versions/2.0.0/doc/eclipse/1_Install_New_Software.png differ
diff --git a/versions/2.0.0/doc/eclipse/2_Install_software.png b/versions/2.0.0/doc/eclipse/2_Install_software.png
new file mode 100644
index 0000000000..b7baadaa9a
Binary files /dev/null and b/versions/2.0.0/doc/eclipse/2_Install_software.png differ
diff --git a/versions/2.0.0/doc/eclipse/eclipse.md b/versions/2.0.0/doc/eclipse/eclipse.md
new file mode 100644
index 0000000000..8c4c1dcb48
--- /dev/null
+++ b/versions/2.0.0/doc/eclipse/eclipse.md
@@ -0,0 +1,38 @@
+using Eclipse with Arduino ESP8266
+===========================================
+
+### What to Download ###
+- [arduino IDE](https://www.arduino.cc/en/Main/Software)
+- [Eclipse IDE for C/C++ Developers](http://www.eclipse.org/downloads/packages/eclipse-ide-cc-developers/marsr)
+- [Java](http://www.java.com/)
+
+### Setup Arduino ###
+ see the [Readme](https://github.com/esp8266/Arduino#installing-with-boards-manager)
+
+### Setup Eclipse ###
+- [step 1](http://www.baeyens.it/eclipse/how_to.shtml#/c)
+- [step 2](http://www.baeyens.it/eclipse/how_to.shtml#/e)
+- go to Window --> preferences --> Arduino
+- add as private hardware path the Part to the ESP8266
+
+###### example private hardware path
+ Windows: C:\Users\[username]\AppData\Roaming\Arduino15\packages\esp8266\hardware
+ Linux: /home/[username]/.arduino15/packages/esp8266/hardware
+
+### Eclipse wont build ###
+if eclipse dont find the path to the Compiler add to the platform.txt
+after:
+```
+version=1.6.4
+```
+this:
+```
+runtime.tools.xtensa-lx106-elf-gcc.path={runtime.platform.path}/../../../tools/xtensa-lx106-elf-gcc/1.20.0-26-gb404fb9
+runtime.tools.esptool.path={runtime.platform.path}/../../../tools/esptool/0.4.4
+```
+Note:
+ - the path may changed, check the current version.
+ - each update over the Arduino IDE will remove the fix
+ - may not needed in future if Eclipse Plugin get an Update
+
+
\ No newline at end of file
diff --git a/versions/2.0.0/doc/esp12.png b/versions/2.0.0/doc/esp12.png
new file mode 100644
index 0000000000..8ec371016a
Binary files /dev/null and b/versions/2.0.0/doc/esp12.png differ
diff --git a/versions/2.0.0/doc/esp12.svg b/versions/2.0.0/doc/esp12.svg
new file mode 100644
index 0000000000..107073dfae
--- /dev/null
+++ b/versions/2.0.0/doc/esp12.svg
@@ -0,0 +1,1187 @@
+
+
+
+
diff --git a/versions/2.0.0/doc/esp8266_tcp_active_close.png b/versions/2.0.0/doc/esp8266_tcp_active_close.png
new file mode 100644
index 0000000000..f9dad09873
Binary files /dev/null and b/versions/2.0.0/doc/esp8266_tcp_active_close.png differ
diff --git a/versions/2.0.0/doc/exception_causes.md b/versions/2.0.0/doc/exception_causes.md
new file mode 100644
index 0000000000..ae3a712633
--- /dev/null
+++ b/versions/2.0.0/doc/exception_causes.md
@@ -0,0 +1,38 @@
+Exception Causes (EXCCAUSE)
+===========================================
+
+| EXC-CAUSE Code | Cause Name | Cause Description | Required Option | EXC-VADDR Loaded |
+|:--------------:|:---------------------------|:------------------------------------------------------------------------------------------------------------|:-------------------------|:----------------:|
+| 0 | IllegalInstructionCause | Illegal instruction | Exception | No |
+| 1 | SyscallCause | SYSCALL instruction | Exception | No |
+| 2 | InstructionFetchErrorCause | Processor internal physical address or data error during instruction fetch | Exception | Yes |
+| 3 | LoadStoreErrorCause | Processor internal physical address or data error during load or store | Exception | Yes |
+| 4 | Level1InterruptCause | Level-1 interrupt as indicated by set level-1 bits in the INTERRUPT register | Interrupt | No |
+| 5 | AllocaCause | MOVSP instruction, if callers registers are not in the register file | Windowed Register | No |
+| 6 | IntegerDivideByZeroCause | QUOS, QUOU, REMS, or REMU divisor operand is zero | 32-bit Integer Divide | No |
+| 7 | Reserved for Tensilica | | | |
+| 8 | PrivilegedCause | Attempt to execute a privileged operation when CRING ? 0 | MMU | No |
+| 9 | LoadStoreAlignmentCause | Load or store to an unaligned address | Unaligned Exception | Yes |
+| 10..11 | Reserved for Tensilica | | | |
+| 12 | InstrPIFDataErrorCause | PIF data error during instruction fetch | Processor Interface | Yes |
+| 13 | LoadStorePIFDataErrorCause | Synchronous PIF data error during LoadStore access | Processor Interface | Yes |
+| 14 | InstrPIFAddrErrorCause | PIF address error during instruction fetch | Processor Interface | Yes |
+| 15 | LoadStorePIFAddrErrorCause | Synchronous PIF address error during LoadStore access | Processor Interface | Yes |
+| 16 | InstTLBMissCause | Error during Instruction TLB refill | MMU | Yes |
+| 17 | InstTLBMultiHitCause | Multiple instruction TLB entries matched | MMU | Yes |
+| 18 | InstFetchPrivilegeCause | An instruction fetch referenced a virtual address at a ring level less than CRING | MMU | Yes |
+| 19 | Reserved for Tensilica | | | |
+| 20 | InstFetchProhibitedCause | An instruction fetch referenced a page mapped with an attribute that does not permit instruction fetch | Region Protection or MMU | Yes |
+| 21..23 | Reserved for Tensilica | | | |
+| 24 | LoadStoreTLBMissCause | Error during TLB refill for a load or store | MMU | Yes |
+| 25 | LoadStoreTLBMultiHitCause | Multiple TLB entries matched for a load or store | MMU | Yes |
+| 26 | LoadStorePrivilegeCause | A load or store referenced a virtual address at a ring level less than CRING | MMU | Yes |
+| 27 | Reserved for Tensilica | | | |
+| 28 | LoadProhibitedCause | A load referenced a page mapped with an attribute that does not permit loads | Region Protection or MMU | Yes |
+| 29 | StoreProhibitedCause | A store referenced a page mapped with an attribute that does not permit stores | Region Protection or MMU | Yes |
+| 30..31 | Reserved for Tensilica | | | |
+| 32..39 | CoprocessornDisabled | Coprocessor n instruction when cpn disabled. n varies 0..7 as the cause varies 32..39 | Coprocessor | No |
+| 40..63 | Reserved | | | |
+
+
+Infos from Xtensa Instruction Set Architecture (ISA) Reference Manual
\ No newline at end of file
diff --git a/versions/2.0.0/doc/filesystem.html b/versions/2.0.0/doc/filesystem.html
new file mode 100644
index 0000000000..57559de577
--- /dev/null
+++ b/versions/2.0.0/doc/filesystem.html
@@ -0,0 +1,504 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ File System · ESP8266 Arduino Core
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This documentation is for version 2.0.0. Other versions.
+
Even though file system is stored on the same flash chip as the program, programming new sketch will not modify file system contents. This allows to use file system to store sketch data, configuration files, or content for Web server.
+
+
The following diagram illustrates flash layout used in Arduino environment:
+
|--------------|-------|---------------|--|--|--|--|--|
+^ ^ ^ ^ ^
+Sketch OTA update File system EEPROM WiFi config (SDK)
+
+
File system size depends on the flash chip size. Depending on the board which is selected in IDE, you have the following options for flash size:
+
+
+
+
Board
+
Flash chip size, bytes
+
File system size, bytes
+
+
+
+
Generic module
+
512k
+
64k
+
+
+
Generic module
+
1M
+
64k, 128k, 256k, 512k
+
+
+
Generic module
+
2M
+
1M
+
+
+
Generic module
+
4M
+
3M
+
+
+
Adafruit HUZZAH
+
4M
+
1M, 3M
+
+
+
NodeMCU 0.9
+
4M
+
1M, 3M
+
+
+
NodeMCU 1.0
+
4M
+
1M, 3M
+
+
+
Olimex MOD-WIFI-ESP8266(-DEV)
+
2M
+
1M
+
+
+
SparkFun Thing
+
512k
+
64k
+
+
+
SweetPea ESP-210
+
4M
+
1M, 3M
+
+
+
WeMos D1 & D1 mini
+
4M
+
1M, 3M
+
+
+
+
Note: to use any of file system functions in the sketch, add the following include to the sketch:
+
#include "FS.h"
+
+
Uploading files to file system
+
+
ESP8266FS is a tool which integrates into the Arduino IDE. It adds a menu item to Tools menu for uploading the contents of sketch data directory into ESP8266 flash file system.
In your Arduino sketchbook directory, create tools directory if it doesn't exist yet
+
Unpack the tool into tools directory (the path will look like <home_dir>/Arduino/tools/ESP8266FS/tool/esp8266fs.jar)
+
Restart Arduino IDE
+
Open a sketch (or create a new one and save it)
+
Go to sketch directory (choose Sketch > Show Sketch Folder)
+
Create a directory named data and any files you want in the file system there
+
Make sure you have selected a board, port, and closed Serial Monitor
+
Select Tools > ESP8266 Sketch Data Upload. This should start uploading the files into ESP8266 flash file system. When done, IDE status bar will display SPIFFS Image Uploaded message.
+
+
+
File system object (SPIFFS)
+
+
begin
+
SPIFFS.begin()
+
+
This method mounts SPIFFS file system. It must be called before any other
+FS APIs are used. Returns true if file system was mounted successfully, false
+otherwise.
+
+
format
+
SPIFFS.format()
+
+
Formats the file system. May be called either before or after calling begin.
+Returns true if formatting was successful.
+
+
open
+
SPIFFS.open(path,mode)
+
+
Opens a file. path should be an absolute path starting with a slash
+(e.g. /dir/filename.txt). mode is a string specifying access mode. It can be
+one of "r", "w", "a", "r+", "w+", "a+". Meaning of these modes is the same as
+for fopen C function.
+
+
Returns File object. To check whether the file was opened successfully, use
+the boolean operator.
+
Filef=SPIFFS.open("/f.txt","w");
+if(!f){
+ Serial.println("file open failed");
+}
+
+
exists
+
SPIFFS.exists(path)
+
+
Returns true if a file with given path exists, false otherwise.
+
+
openDir
+
SPIFFS.openDir(path)
+
+
Opens a directory given its absolute path. Returns a Dir object.
+
+
remove
+
SPIFFS.remove(path)
+
+
Deletes the file given its absolute path. Returns true if file was deleted successfully.
+
+
rename
+
SPIFFS.rename(pathFrom,pathTo)
+
+
Renames file from pathFrom to pathTo. Paths must be absolute. Returns true
+if file was renamed successfully.
+
+
info
+
FSInfofs_info;
+SPIFFS.info(fs_info);
+
+
Fills FSInfo structure with information about
+the file system. Returns true is successful, false otherwise.
dir.next() returns true while there are files in the directory to iterate over.
+It must be called before calling fileName and openFile functions.
+
+
openFile method takes mode argument which has the same meaning as for SPIFFS.open function.
+
+
File object
+
+
SPIFFS.open and dir.openFile functions return a File object. This object
+supports all the functions of Stream, so you can use readBytes, findUntil,
+parseInt, println, and all other Stream methods.
+
+
There are also some functions which are specific to File object.
+
+
seek
+
file.seek(offset,mode)
+
+
This function behaves like fseek C function. Depending on the value of mode,
+it moves current position in a file as follows:
+
+
+
if mode is SeekSet, position is set to offset bytes from the beginning.
+
if mode is SeekCur, current position is moved by offset bytes.
+
if mode is SeekEnd, position is set to offset bytes from the end of the
+file.
+
+
+
Returns true if position was set successfully.
+
+
position
+
file.position()
+
+
Returns the current position inside the file, in bytes.
+
+
size
+
file.size()
+
+
Returns file size, in bytes.
+
+
name
+
Stringname=file.name();
+
+
Returns file name, as const char*. Convert it to String for storage.
+
+
close
+
file.close()
+
+
Close the file. No other operations should be performed on File object after close function was called.
Documentation for ESP8266 Arduino Core. Installation instructions, functions and classes reference.
+
+
+
+
+
+
+
Boards Manager
+
+
This is the suggested installation method for end users.
+
+
Prerequisites
+
+
+
Arduino 1.6.5, get it from Arduino website. Arduino 1.6.6 has several issues, so we recommend to stick with 1.6.5 for now.
+
Internet connection
+
+
+
Instructions
+
+
+
Start Arduino and open Preferences window.
+
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 find esp8266 platform.
+
Select the version you need from a drop-down box.
+
Click install button.
+
Don't forget to select your ESP8266 board from Tools > Board menu after installation.
+
+
+
You may optionally use staging boards manager package link:
+http://arduino.esp8266.com/staging/package_esp8266com_index.json. This may contain some new features, but at the same time, some things might be broken.
+
+
Using git version
+
+
This is the suggested installation method for contributors and library developers.
+
+
Prerequisites
+
+
+
Arduino 1.6.5 (or newer, if you know what you are doing)
+
git
+
python 2.7
+
terminal, console, or command prompt (depending on you OS)
+
Internet connection
+
+
+
Instructions
+
+
+
Open the console and go to Arduino directory. This can be either your sketchbook directory (usually <Documents>/Arduino), or the directory of Arduino application itself, the choice is up to you.
+
Clone this repository into hardware/esp8266com/esp8266 directory. Alternatively, clone it elsewhere and create a symlink, if your OS supports them.
This is mostly similar to WiFi shield library. Differences include:
+
+
+
WiFi.mode(m): set mode to WIFI_AP, WIFI_STA, WIFI_AP_STA or WIFI_OFF.
+
call WiFi.softAP(ssid) to set up an open network
+
call WiFi.softAP(ssid, password) to set up a WPA2-PSK network (password should be at least 8 characters)
+
WiFi.macAddress(mac) is for STA, WiFi.softAPmacAddress(mac) is for AP.
+
WiFi.localIP() is for STA, WiFi.softAPIP() is for AP.
+
WiFi.printDiag(Serial) will print out some diagnostic info
+
WiFiUDP class supports sending and receiving multicast packets on STA interface.
+When sending a multicast packet, replace udp.beginPacket(addr, port) with
+udp.beginPacketMulticast(addr, port, WiFi.localIP()).
+When listening to multicast packets, replace udp.begin(port) with
+udp.beginMulticast(WiFi.localIP(), multicast_ip_addr, port).
+You can use udp.destinationIP() to tell whether the packet received was
+sent to the multicast or unicast address.
+
+
+
WiFiServer, WiFiClient, and WiFiUDP behave mostly the same way as with WiFi shield library.
+Four samples are provided for this library.
+You can see more commands here: http://www.arduino.cc/en/Reference/WiFi
+
+
Ticker
+
+
Library for calling functions repeatedly with a certain period. Two examples included.
+
+
It is currently not recommended to do blocking IO operations (network, serial, file) from Ticker
+callback functions. Instead, set a flag inside the ticker callback and check for that flag inside the loop function.
+
+
EEPROM
+
+
This is a bit different from standard EEPROM class. You need to call EEPROM.begin(size)
+before you start reading or writing, size being the number of bytes you want to use.
+Size can be anywhere between 4 and 4096 bytes.
+
+
EEPROM.write does not write to flash immediately, instead you must call EEPROM.commit()
+whenever you wish to save changes to flash. EEPROM.end() will also commit, and will
+release the RAM copy of EEPROM contents.
+
+
EEPROM library uses one sector of flash located just after the SPIFFS.
+
+
Three examples included.
+
+
I2C (Wire library)
+
+
Wire library currently supports master mode up to approximately 450KHz.
+Before using I2C, pins for SDA and SCL need to be set by calling
+Wire.begin(int sda, int scl), i.e. Wire.begin(0, 2) on ESP-01,
+else they default to pins 4(SDA) and 5(SCL).
+
+
SPI
+
+
SPI library supports the entire Arduino SPI API including transactions, including setting phase (CPHA).
+Setting the Clock polarity (CPOL) is not supported, yet (SPI_MODE2 and SPI_MODE3 not working).
+
+
SoftwareSerial
+
+
An ESP8266 port of SoftwareSerial library done by Peter Lerup (@plerup) supports baud rate up to 115200 and multiples SoftwareSerial instances. See https://github.com/plerup/espsoftwareserial if you want to suggest an improvement or open an issue related to SoftwareSerial.
+
+
ESP-specific APIs
+
+
APIs related to deep sleep and watchdog timer are available in the ESP object, only available in Alpha version.
+
+
ESP.deepSleep(microseconds, mode) will put the chip into deep sleep. mode is one of WAKE_RF_DEFAULT, WAKE_RFCAL, WAKE_NO_RFCAL, WAKE_RF_DISABLED. (GPIO16 needs to be tied to RST to wake from deepSleep.)
+
+
ESP.restart() restarts the CPU.
+
+
ESP.getFreeHeap() returns the free heap size.
+
+
ESP.getChipId() returns the ESP8266 chip ID as a 32-bit integer.
+
+
Several APIs may be used to get flash chip info:
+
+
ESP.getFlashChipId() returns the flash chip ID as a 32-bit integer.
+
+
ESP.getFlashChipSize() returns the flash chip size, in bytes, as seen by the SDK (may be less than actual size).
+
+
ESP.getFlashChipSpeed(void) returns the flash chip frequency, in Hz.
+
+
ESP.getCycleCount() returns the cpu instruction cycle count since start as an unsigned 32-bit. This is useful for accurate timing of very short actions like bit banging.
+
+
ESP.getVcc() may be used to measure supply voltage. ESP needs to reconfigure the ADC
+at startup in order for this feature to be available. Add the following line to the top
+of your sketch to use getVcc:
+
ADC_MODE(ADC_VCC);
+
+
TOUT pin has to be disconnected in this mode.
+
+
Note that by default ADC is configured to read from TOUT pin using analogRead(A0), and
+ESP.getVCC() is not available.
+
+
OneWire
+
+
Library was adapted to work with ESP8266 by including register definitions into OneWire.h
+Note that if you already have OneWire library in your Arduino/libraries folder, it will be used
+instead of the one that comes with this package.
+
+
mDNS and DNS-SD responder (ESP8266mDNS library)
+
+
Allows the sketch to respond to multicast DNS queries for domain names like "foo.local", and DNS-SD (service dicovery) queries.
+See attached example for details.
+
+
SSDP responder (ESP8266SSDP)
+
+
SSDP is another service discovery protocol, supported on Windows out of the box. See attached example for reference.
+
+
DNS server (DNSServer library)
+
+
Implements a simple DNS server that can be used in both STA and AP modes. The DNS server currently supports only one domain (for all other domains it will reply with NXDOMAIN or custom status code). With it clients can open a web server running on ESP8266 using a domain name, not an IP address.
+See attached example for details.
+
+
Servo
+
+
This library exposes the ability to control RC (hobby) servo motors. It will support upto 24 servos on any available output pin. By defualt the first 12 servos will use Timer0 and currently this will not interfere with any other support. Servo counts above 12 will use Timer1 and features that use it will be effected.
+While many RC servo motors will accept the 3.3V IO data pin from a ESP8266, most will not be able to run off 3.3v and will require another power source that matches their specifications. Make sure to connect the grounds between the ESP8266 and the servo motor power supply.
+
+
Other libraries (not included with the IDE)
+
+
Libraries that don't rely on low-level access to AVR registers should work well. Here are a few libraries that were verified to work:
+
+
+
arduinoWebSockets - WebSocket Server and Client compatible with ESP8266 (RFC6455)
DHT-sensor-library - Arduino library for the DHT11/DHT22 temperature and humidity sensors. Download latest v1.1.1 library and no changes are necessary. Older versions should initialize DHT as follows: DHT dht(DHTPIN, DHTTYPE, 15)
+
NeoPixel - Adafruit's NeoPixel library, now with support for the ESP8266 (use version 1.0.2 or higher from Arduino's library manager).
+
NeoPixelBus - Arduino NeoPixel library compatible with ESP8266. Use the "NeoPixelAnimator" branch for ESP8266 to get HSL color support and more.
RTC - Arduino Library for Ds1307 & Ds3231 compatible with ESP8266.
+
Souliss, Smart Home - Framework for Smart Home based on Arduino, Android and openHAB.
+
ST7735 - Adafruit's ST7735 library modified to be compatible with ESP8266. Just make sure to modify the pins in the examples as they are still AVR specific.
+
+
+
+
+
diff --git a/versions/2.0.0/doc/ota_updates/ota-ide-module-joined-wifi.png b/versions/2.0.0/doc/ota_updates/ota-ide-module-joined-wifi.png
new file mode 100644
index 0000000000..34b93e3d20
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-ide-module-joined-wifi.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-ide-ota-port-selection.png b/versions/2.0.0/doc/ota_updates/ota-ide-ota-port-selection.png
new file mode 100644
index 0000000000..18bbc72102
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-ide-ota-port-selection.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-ide-ota-upload-complete.png b/versions/2.0.0/doc/ota_updates/ota-ide-ota-upload-complete.png
new file mode 100644
index 0000000000..76e24efb30
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-ide-ota-upload-complete.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-ide-ota-upload-configuration.png b/versions/2.0.0/doc/ota_updates/ota-ide-ota-upload-configuration.png
new file mode 100644
index 0000000000..0b8cc4584e
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-ide-ota-upload-configuration.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-ide-python-configuration.png b/versions/2.0.0/doc/ota_updates/ota-ide-python-configuration.png
new file mode 100644
index 0000000000..0e78f72a12
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-ide-python-configuration.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-ide-serial-upload-configuration.png b/versions/2.0.0/doc/ota_updates/ota-ide-serial-upload-configuration.png
new file mode 100644
index 0000000000..1116a0cad2
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-ide-serial-upload-configuration.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-ide-sketch-selection.png b/versions/2.0.0/doc/ota_updates/ota-ide-sketch-selection.png
new file mode 100644
index 0000000000..1c9053c53b
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-ide-sketch-selection.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-ide-ssid-pass-entry.png b/versions/2.0.0/doc/ota_updates/ota-ide-ssid-pass-entry.png
new file mode 100644
index 0000000000..8aae132aa1
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-ide-ssid-pass-entry.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-web-browser-form-ok.png b/versions/2.0.0/doc/ota_updates/ota-web-browser-form-ok.png
new file mode 100644
index 0000000000..ed44e9cbba
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-web-browser-form-ok.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-web-browser-form.png b/versions/2.0.0/doc/ota_updates/ota-web-browser-form.png
new file mode 100644
index 0000000000..87872393f6
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-web-browser-form.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-web-path-to-binary.png b/versions/2.0.0/doc/ota_updates/ota-web-path-to-binary.png
new file mode 100644
index 0000000000..9237d87805
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-web-path-to-binary.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-web-serial-monitor-ready.png b/versions/2.0.0/doc/ota_updates/ota-web-serial-monitor-ready.png
new file mode 100644
index 0000000000..5ce011170c
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-web-serial-monitor-ready.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-web-serial-monitor-reboot.png b/versions/2.0.0/doc/ota_updates/ota-web-serial-monitor-reboot.png
new file mode 100644
index 0000000000..0fd469e116
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-web-serial-monitor-reboot.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota-web-show-verbose-compilation.png b/versions/2.0.0/doc/ota_updates/ota-web-show-verbose-compilation.png
new file mode 100644
index 0000000000..00ac3871fe
Binary files /dev/null and b/versions/2.0.0/doc/ota_updates/ota-web-show-verbose-compilation.png differ
diff --git a/versions/2.0.0/doc/ota_updates/ota_updates.html b/versions/2.0.0/doc/ota_updates/ota_updates.html
new file mode 100644
index 0000000000..a786d535b9
--- /dev/null
+++ b/versions/2.0.0/doc/ota_updates/ota_updates.html
@@ -0,0 +1,662 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ OTA Update · ESP8266 Arduino Core
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This documentation is for version 2.0.0. Other versions.
+
OTA (Over the Air) update is the process of loading the firmware to ESP module using Wi-Fi connection rather that a serial port. Such functionality became extremely useful in case of limited or no physical access to the module.
Arduino IDE option is intended primarily for software development phase. The two other options would be more useful after deployment, to provide module with application updates manually with a web browser or automatically using a http server.
+
+
In any case first firmware upload have to be done over a serial port. If OTA routines are correctly implemented in a sketch, then all subsequent uploads may be done over the air.
+
+
There is no imposed security on OTA process from being hacked. It is up to developer to ensure that updates are allowed only from legitimate / trusted source. Once update is complete, module restarts and new code is executed. Developer should ensure that application running on module is shut down and restarted in a safe manner. Chapters below provide additional information regarding security and safety of OTA process.
+
+
Security
+
+
Module has to be exposed wirelessly to get it updated with a new sketch. That poses chances of module being violently hacked and loaded with some other code. To reduce likelihood of being hacked consider protecting your uploads with a password, selecting certain OTA port, etc.
+
+
Check functionality provided with ArduinoOTA library that may improve security:
Certain protection functionality is already built in and do not require any additional coding by developer. ArduinoOTA and espota.py use Digest-MD5 to authenticate upload. Integrity of transferred data is verified on ESP side using MD5 checksum.
+
+
Make your own risk analysis and depending on application decide what library functions to implement. If required consider implementation of other means of protection from being hacked, e.g. exposing module for uploads only according to specific schedule, trigger OTA only be user pressing dedicated “Update” button, etc.
+
+
Safety
+
+
OTA process takes ESP’s resources and bandwidth during upload. Then module is restarted and a new sketch executed. Analyse and test how it affects functionality of your existing and new sketch.
+
+
If ESP is placed in remote location and controlling some equipment, you should put additional attention what happens if operation of this equipment is suddenly interrupted by update process. Therefore decide how to put this equipment into safe state before starting the update. For instance your module may be controlling a garden watering system in a sequence. If this sequence is not properly shut down and a water valve left open, your garden may be flooded if this valve is not closed after OTA is finished and module restarts.
+
+
The following functions are provided with ArduinoOTA library and intended to handle functionality of your application during specific stages of OTA or on an OTA error:
The following chapters provide more details and specific methods of doing OTA.
+
+
Arduino IDE
+
+
Uploading modules wirelessly from Arduino IDE is intended for the following typical scenarios:
+- during firmware development as a quicker alternative to loading over a serial
+- for updating small quantity of modules
+- only if modules are available on the same network as the computer with Arduino IDE
+
+
Requirements
+
+
+
The ESP and the computer must be connected to the same network.
+
+
+
Application Example
+
+
Currently there are two software configurations that support OTA updates.
+
+
+
Classic OTA: Arduino IDE 1.6.5 and 1.6.5-947-g39819f0 (of July 23, 2015) or 1.6.5-1160-gef26c5f (of Sep 30, 2015) version of platform package that provides first OTA implementation, yet without support for ArduinoOTA library. This particular configuration is easier to configure in Arduino IDE and therefore suggested for less experienced users. It soon will be depreciated once implementation below is fully released.
+
ArduinoOTA: Arduino-PR-4107-BUILD-421 and latest git version of platform package that includes ArduinoOTA library. This configuration features preliminary build of Arduino IDE and is intended for more experienced users. Please mid your step.
+
+
+
Instructions below demonstrate how to configure both Classic OTA and ArduinoOTA using NodeMCU 1.0 (ESP-12E Module) board.
+
+
Classic OTA
+
+
+
Before you begin, please make sure that you have the following installed:
Python 2.7 (do not install Python 3.5 that is not supported):
+
+
Note: Windows users should select “Add python.exe to Path” (see below – this option is not selected by default).
+
+
+
+
Now prepare the sketch and configuration for the upload over a serial port.
+
+
+
Start Arduino IDE and load sketch DNS_SD_Arduino_OTA.ino available under File > Examples > ESP8266mDNS
+
+
+
Note: This sketch is available only for 1.6.5-947-g39819f0 (of July 23, 2015) and 1.6.5-1160-gef26c5f (of Sep 30, 2015) versions of platform packages installed in Arduino IDE using https://github.com/esp8266/Arduino#installing-with-boards-manager. It was removed in #980 from GitHub repository.
+
Update SSID and password in the sketch so the module can join your Wi-Fi network
+
+
Configure upload parameters as below (you may need to adjust configuration if you are using a different module):
+
+
+
Upload the sketch (Ctrl+U). Once done open Serial Monitor (Ctrl+Shift+M) and check if module has joined your Wi-Fi network.
+
+
+
Only if module is connected to network, after a couple of seconds, the esp8266-ota port will show up in Arduino IDE:
+
+
+
Now get ready for your first OTA upload by changing configuration settings as follows:
+
+
+
+
Note: If you do not see “Upload Using: OTA” option available for “NodeMCU 1.0 (ESP-12E Module)” board, please upload the latest boards.txt file from GitHub repository, replace existing file and restart Arduino IDE.
+
If you have successfully completed all the above steps, you can upload (Ctrl+U) the same (or any other) sketch over OTA:
+
+
+
+
+
Note: To be able to upload your sketch over and over again using OTA, you need to embed OTA routines inside. Please use DNS_SD_Arduino_OTA.ino as an example.
Updates described in this chapter are done with a web browser that can be useful in the following typical scenarios:
+
+
+
after application deployment if loading directly from Arduino IDE is inconvenient or not possible
+
after deployment if user is unable to expose module for OTA from external update server
+
to provide updates after deployment to small quantity of modules when setting an update server is not practicable
+
+
+
Requirements
+
+
+
The ESP and the computer must be connected to the same network.
+
+
+
Implementation Overview
+
+
Updates with a web browswer are implemented using ESP8266HTTPUpdateServer class together with ESP8266WebServer and ESP8266mDNS classes. The following code is required to get it work:
Mac OSX and iOS - support is already built in / no any extra s/w is required
+
+
+
Prepare the sketch and configuration for initial upload with a serial port.
+
+
+
Start Arduino IDE and load sketch WebUpdater.ino available under File > Examples > ESP8266HTTPUpdateServer.
+
Update ssid and pass in the sketch so the module can join your Wi-Fi network.
+
Open File > Preferences, look for “Show verbose output during:” and check out “compilation” option.
+
+
+
+
Note: This setting will be required in step 5 below. You can uncheck this setting afterwards.
+
+
Upload sketch (Ctrl+U). Once done open Serial Monitor (Ctrl+Shift+M) and check if you see the following message displayed, that contains url for OTA update.
+
+
+
+
Note: Such message will be shown only after module successfully joins network and is ready for an OTA upload.
+
Now open web browser and enter the url provided on Serial Monitor, i.e. http://esp8266-webupdate.local/update. Once entered, browser should display a form like below that has been served by your module. The form invites you to choose a file for update.
+
+
+
+
Note: If entering “http://esp8266-webupdate.local/update” does not work, try replacing “esp8266-webupdate” with module’s IP address. For example, if your module IP is “192.168.1.100” then url should be “http://192.168.1.100/update”. This workaround is useful in case the host software installed in step 2 does not work. If still nothing works and there are no clues on Serial Monitor, try to diagnose issue by opening provided url in Google Chrome, pressing F12 and checking contents of “Console” and “Network” tabs. Chrome provides some advanced logging on these tabs.
+
To obtain the file navigate to directory used by Arduino IDE to store results of compilation. You can check the path to this file in compilation log shown in IDE debug window as marked below.
+
+
+
Now press “Choose File” in web browser, go to directory identified in step 5 above, find the file “WebUpdater.cpp.bin” and upload it. If upload is successful you will see “OK” on web browser like below.
+
+
+
+
Module will reboot that should be visible on Serial Monitor:
+
+
+
+
Just after reboot you should see exactly the same message “HTTPUpdateServer ready! Open http:// esp8266-webupdate.local /update in your browser” like in step 3. This is because module has been loaded again with the same code – first using serial port, and then using OTA.
+
+
+
Once you are comfortable with this procedure go ahead and modify WebUpdater.ino sketch to print some additional messages, compile it, locate new binary file and upload it using web browser to see entered changes on a Serial Monitor.
+
+
You can also add OTA routines to your own sketch following guidelines in Implementation Overview above. If this is done correctly you should be always able to upload new sketch over the previous one using a web browser.
+
+
In case OTA update fails dead after entering modifications in your sketch, you can always recover module by loading it over a serial port. Then diagnose the issue with sketch using Serial Monitor. Once the issue is fixed try OTA again.
+
+
HTTP Server
+
+
ESPhttpUpdate class can check for updates and download a binary file from HTTP web server.
+It is possible to download updates from every IP or domain address on the network or Internet.
+
+
Requirements
+
+
+
web server
+
+
+
Arduino code
+
+
Simple updater
+
+
Simple updater downloads the file every time the function is called.
Its possible to point update function to a script at the server.
+If version string argument is given, it will be sent to the server.
+Server side script can use this to check if update should be performed.
+
+
Server side script can respond as follows:
+- response code 200, and send the firmware image,
+- or response code 304 to notify ESP that no update is required.
+
t_httpUpdate_returnret=ESPhttpUpdate.update("192.168.0.2",80,"/esp/update/arduino.php","optional current version string here");
+switch(ret){
+ caseHTTP_UPDATE_FAILED:
+ Serial.println("[update] Update failed.");
+ break;
+ caseHTTP_UPDATE_NO_UPDATES:
+ Serial.println("[update] Update no Update.");
+ break;
+ caseHTTP_UPDATE_OK:
+ Serial.println("[update] Update ok.");// may not called we reboot the ESP
+ break;
+}
+
+
Server request handling
+
+
Simple updater
+
+
For the simple updater the server only needs to deliver the binary file for update.
+
+
Advanced updater
+
+
For advanced update management a script needs to run at the server side, for example a PHP script.
+At every update request the the ESP sends some information in HTTP headers to the server.
With this information the script now can check if a update is needed. It is also possible to deliver different binaries based on the MAC address for example.
The Stream Interface is the base for all other update modes like OTA, http Server / client.
+
+
Updater class
+
+
TODO describe Updater class
+
+
Updater is in the Core and deals with writing the firmware to the flash, checking its integrity and telling the bootloader to load the new firmware on the next boot.
Pin numbers in Arduino correspond directly to the ESP8266 GPIO pin numbers. pinMode, digitalRead, and digitalWrite functions work as usual, so to read GPIO2, call digitalRead(2).
+
+
Digital pins 0—15 can be INPUT, OUTPUT, or INPUT_PULLUP.
+Pin 16 can be INPUT, OUTPUT or INPUT_PULLDOWN_16. At startup, pins are configured as INPUT.
+
+
Pins may also serve other functions, like Serial, I2C, SPI. These functions are normally activated by the corresponding library. The diagram below shows pin mapping for the popular ESP-12 module.
+
+
+
+
Digital pins 6—11 are not shown on this diagram because they are used to connect flash memory chip on most modules. Trying to use these pins as IOs will likely cause the program to crash.
+
+
Note that some boards and modules (ESP-12ED, NodeMCU 1.0) also break out pins 9 and 11. These may be used as IO if flash chip works in DIO mode (as opposed to QIO, which is the default one).
+
+
Pin interrupts are supported through attachInterrupt, detachInterrupt functions.
+Interrupts may be attached to any GPIO pin, except GPIO16. Standard Arduino interrupt
+types are supported: CHANGE, RISING, FALLING.
+
+
Analog input
+
+
ESP8266 has a single ADC channel available to users. It may be used either to read voltage at ADC pin, or to read module supply voltage (VCC).
+
+
To read external voltage applied to ADC pin, use analogRead(A0). Input voltage range is 0 — 1.0V.
+
+
To read VCC voltage, ADC pin must be kept unconnected. Additionally, the following line has to be added to the sketch:
+
ADC_MODE(ADC_VCC);
+
+
This line has to appear outside of any functions, for instance right after the #include lines of your sketch.
+
+
Analog output
+
+
analogWrite(pin, value) enables software PWM on the given pin. PWM may be used on pins 0 to 16.
+Call analogWrite(pin, 0) to disable PWM on the pin. value may be in range from 0 to PWMRANGE, which is equal to 1023 by default. PWM range may be changed by calling analogWriteRange(new_range).
+
+
PWM frequency is 1kHz by default. Call analogWriteFreq(new_frequency) to change the frequency.
+
+
Timing and delays
+
+
millis() and micros() return the number of milliseconds and microseconds elapsed after reset, respectively.
+
+
delay(ms) pauses the sketch for a given number of milliseconds and allows WiFi and TCP/IP tasks to run.
+delayMicroseconds(us) pauses for a given number of microseconds.
+
+
Remember that there is a lot of code that needs to run on the chip besides the sketch
+when WiFi is connected. WiFi and TCP/IP libraries get a chance to handle any pending
+events each time the loop() function completes, OR when delay is called.
+If you have a loop somewhere in your sketch that takes a lot of time (>50ms) without
+calling delay, you might consider adding a call to delay function to keep the WiFi
+stack running smoothly.
+
+
There is also a yield() function which is equivalent to delay(0). The delayMicroseconds
+function, on the other hand, does not yield to other tasks, so using it for delays
+more than 20 milliseconds is not recommended.
+
+
Serial
+
+
Serial object works much the same way as on a regular Arduino. Apart from hardware FIFO (128 bytes for TX and RX) HardwareSerial has additional 256-byte TX and RX buffers. Both transmit and receive is interrupt-driven. Write and read functions only block the sketch execution when the respective FIFO/buffers are full/empty.
+
+
Serial uses UART0, which is mapped to pins GPIO1 (TX) and GPIO3 (RX). Serial may be remapped to GPIO15 (TX) and GPIO13 (RX) by calling Serial.swap() after Serial.begin. Calling swap again maps UART0 back to GPIO1 and GPIO3.
+
+
Serial1 uses UART1, TX pin is GPIO2. UART1 can not be used to receive data because normally it's RX pin is occupied for flash chip connection. To use Serial1, call Serial1.begin(baudrate).
+
+
By default the diagnostic output from WiFi libraries is disabled when you call Serial.begin. To enable debug output again, call Serial.setDebugOutput(true). To redirect debug output to Serial1 instead, call Serial1.setDebugOutput(true).
+
+
You also need to use Serial.setDebugOutput(true) to enable output from printf() function.
+
+
Both Serial and Serial1 objects support 5, 6, 7, 8 data bits, odd (O), even (E), and no (N) parity, and 1 or 2 stop bits. To set the desired mode, call Serial.begin(baudrate, SERIAL_8N1), Serial.begin(baudrate, SERIAL_6E2), etc.
+
+
Progmem
+
+
The Program memory features work much the same way as on a regular Arduino; placing read only data and strings in read only memory and freeing heap for your application.
+The important difference is that on the ESP8266 the literal strings are not pooled. This means that the same literal string defined inside a F("") and/or PSTR("") will take up space for each instance in the code. So you will need to manage the duplicate strings yourself.
+
+
There is one additional helper macro to make it easier to pass const PROGMEM strings to methods that take a __FlashStringHelper called FPSTR(). The use of this will help make it easier to pool strings.
+Not pooling strings...
" + header.innerHTML + "";
+ else if (this_level <= level){ // higher level than before; end parent ol
+ for(i = this_level; i < level; i++) {
+ html += "
"
+ }
+ html += "
" + header.innerHTML + "";
+ }
+ else if (this_level > level) { // lower level than before; expand the previous to contain a ol
+ for(i = this_level; i > level; i--) {
+ html += "<"+settings.listType+">
"
+ }
+ html += "" + header.innerHTML + "";
+ }
+ level = this_level; // update for the next one
+ });
+ html += "";
+ if (!settings.noBackToTopLinks) {
+ $(document).on('click', '.back-to-top', function() {
+ $(window).scrollTop(0);
+ window.location.hash = '';
+ });
+ }
+
+ render[settings.showEffect]();
+ };
+})(jQuery);
diff --git a/versions/2.0.0/ver_index.html b/versions/2.0.0/ver_index.html
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/versions/index.md b/versions/index.md
new file mode 100644
index 0000000000..5d003dbcdf
--- /dev/null
+++ b/versions/index.md
@@ -0,0 +1,4 @@
+---
+layout: page
+title: Versions
+---
+
+ Note: This sketch is available only for 1.6.5-947-g39819f0 (of July 23, 2015) and 1.6.5-1160-gef26c5f (of Sep 30, 2015) versions of platform packages installed in Arduino IDE using https://github.com/esp8266/Arduino#installing-with-boards-manager. It was removed in #980 from GitHub repository.
+
+
+
+
+
+
+Note: This setting will be required in step 5 below. You can uncheck this setting afterwards.
+
+Note: Such message will be shown only after module successfully joins network and is ready for an OTA upload:
+
+Note: If entering “http://esp8266-webupdate.local/update” does not work, try replacing “esp8266-webupdate” with module’s IP address. For example, if your module IP is “192.168.1.100” then url should be “http://192.168.1.100/update”. This workaround is useful in case the host software installed in step 2 does not work. If still nothing works and there are no clues on Serial Monitor, try to diagnose issue by opening provided url in Google Chrome, pressing F12 and checking contents of “Console” and “Network” tabs. Chrome provides some advanced logging on these tabs.
+
+
+