Skip to content
ESP8266 core for Arduino
C C++ Python Shell HTML Makefile Assembly
Branch: master
Clone or download
earlephilhower Add memmove_P, use it in String to ensure F() safety (#6514)
memmove_P is now in libc, so use it to allow WString to handle F()
pointers without errors.

Supercedes #6368

Fixes #6384
Latest commit 8dd068e Sep 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bootloaders/eboot cleanup/unify flash sector size define value (#5327) Nov 24, 2018
cores/esp8266 Add memmove_P, use it in String to ensure F() safety (#6514) Sep 13, 2019
doc Edited OTA readme, added Stream Interface snippet (#6487) Sep 10, 2019
libraries add or improve some debug messages (#6508) Sep 12, 2019
package Fix tool name to point to proper JSON entry (#6513) Sep 13, 2019
tests Add memmove_P, use it in String to ensure F() safety (#6514) Sep 13, 2019
tools Add memmove_P, use it in String to ensure F() safety (#6514) Sep 13, 2019
variants boards: Invent One: fix analog pin (#5741) Feb 8, 2019
.gitignore Add Python3 dir to .gitignore (#6474) Aug 31, 2019
.gitmodules Add LittleFS as an optional filesystem, API compatible w/SPIFFS (but … May 25, 2019
.travis.yml Add Win32 build to CI system (#6493) Sep 10, 2019
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md (#4474) Mar 7, 2018
LICENSE add missing LICENSE file (GNU Library Public License, version 2) Oct 31, 2015
POLICY.md Update POLICY.md Nov 3, 2017
README.md Grammar edits in documentation (#6401) Aug 9, 2019
boards.txt MDNS: fix random crash on startup (#6261) Sep 5, 2019
keywords.txt Minimal file with a few ESP8266-specific keywords - github issue #3701 Oct 22, 2017
package.json bump version number Jan 1, 2018
platform.txt Run makecorever.py before specific prebuild hooks. (#6504) Sep 13, 2019
programmers.txt remove the need to set programmer, by setting upload tool Apr 1, 2015

README.md

Arduino core for ESP8266 WiFi chip

Quick links

Arduino on ESP8266

This project brings support for the ESP8266 chip to the Arduino environment. It lets you write sketches, using familiar Arduino functions and libraries, and run them directly on ESP8266, with no external microcontroller required.

ESP8266 Arduino core comes with libraries to communicate over WiFi using TCP and UDP, set up HTTP, mDNS, SSDP, and DNS servers, do OTA updates, use a file system in flash memory, and work with SD cards, servos, SPI and I2C peripherals.

Contents

Installing with Boards Manager

Starting with 1.6.4, Arduino allows installation of third-party platform packages using Boards Manager. We have packages available for Windows, Mac OS, and Linux (32 and 64 bit).

  • Install the current upstream Arduino IDE at the 1.8.7 level or later. The current version is on the Arduino website.
  • Start Arduino and open the Preferences window.
  • Enter https://arduino.esp8266.com/stable/package_esp8266com_index.json into the Additional Board Manager URLs field. You can add multiple URLs, separating them with commas.
  • Open Boards Manager from Tools > Board menu and install esp8266 platform (and don't forget to select your ESP8266 board from Tools > Board menu after installation).

Latest release Latest release

Boards manager link: https://arduino.esp8266.com/stable/package_esp8266com_index.json

Documentation: https://arduino-esp8266.readthedocs.io/en/2.5.2/

Using git version (basic instructions)

Linux build status

  • Install the current upstream Arduino IDE at the 1.8 level or later. The current version is on the Arduino website.
  • Go to Arduino directory
    • For Mac OS X, it is Arduino.app showing as the Arduino icon.
      This location may be your ~/Downloads, ~/Desktop or even /Applications.
      cd <application-directory>/Arduino.app/Contents/Java
    • For Linux, it is ~/Arduino by default.
      cd ~/Arduino
  • Clone this repository into hardware/esp8266com/esp8266 directory (or clone it elsewhere and create a symlink)
cd hardware
mkdir esp8266com
cd esp8266com
git clone https://github.com/esp8266/Arduino.git esp8266
cd esp8266
git submodule update --init
  • Download binary tools (you need Python 2.7)
cd esp8266/tools
python get.py
  • Restart Arduino

Using PlatformIO

PlatformIO is an open source ecosystem for IoT development with a cross-platform build system, a library manager, and full support for Espressif (ESP8266) development. It works on the following popular host operating systems: macOS, Windows, Linux 32/64, and Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).

Building with make

makeEspArduino is a generic makefile for any ESP8266 Arduino project. Using make instead of the Arduino IDE makes it easier to do automated and production builds.

Documentation

Documentation for latest development version: https://arduino-esp8266.readthedocs.io/en/latest/

Issues and support

ESP8266 Community Forum is a well-established community for questions and answers about Arduino for ESP8266. If you need help, have a "How do I..." type question, have a problem with a 3rd party library not hosted in this repo, or just want to discuss how to approach a problem, please ask there.

If you find the forum useful, please consider supporting it with a donation.
Donate

If you encounter an issue which you think is a bug in the ESP8266 Arduino Core or the associated libraries, or if you want to propose an enhancement, you are welcome to submit it here on Github: https://github.com/esp8266/Arduino/issues.

Please provide as much context as possible, as well as the information requested in the issue template:

  • ESP8266 Arduino core version which you are using (you can check it in Boards Manager)
  • your sketch code; please wrap it into a code block, see Github markdown manual
  • when encountering an issue that happens at run time, attach the serial output. Wrap it into a code block, just like the code.
  • for issues that happen at compile time, enable verbose compiler output in the IDE preferences, and attach that output (also inside a code block)
  • ESP8266 development board model
  • IDE settings (board choice, flash size)
  • etc

Contributing

For minor fixes of code and documentation, please go ahead and submit a pull request. A gentle introduction to the process can be found here.

Check out the list of issues that are easy to fix — easy issues pending. Working on them is a great way to move the project forward.

Larger changes (rewriting parts of existing code from scratch, adding new functions to the core, adding new libraries) should generally be discussed by opening an issue first.

Feature branches with lots of small commits (especially titled "oops", "fix typo", "forgot to add file", etc.) should be squashed before opening a pull request. At the same time, please refrain from putting multiple unrelated changes into a single pull request.

License and credits

Arduino IDE is developed and maintained by the Arduino team. The IDE is licensed under GPL.

ESP8266 core includes an xtensa gcc toolchain, which is also under GPL.

Esptool written by Christian Klippel is licensed under GPLv2, currently maintained by Ivan Grokhotkov: https://github.com/igrr/esptool-ck.

Espressif SDK included in this build is under Espressif MIT License.

ESP8266 core files are licensed under LGPL.

SPI Flash File System (SPIFFS) written by Peter Andersson is used in this project. It is distributed under the MIT license.

umm_malloc memory management library written by Ralph Hempel is used in this project. It is distributed under the MIT license.

SoftwareSerial library and examples written by Peter Lerup. Distributed under LGPL 2.1.

axTLS library written by Cameron Rich, built from https://github.com/igrr/axtls-8266, is used in this project. It is distributed under BSD license.

BearSSL library written by Thomas Pornin, built from https://github.com/earlephilhower/bearssl-esp8266, is used in this project. It is distributed under the MIT License.

LittleFS library written by ARM Limited and released under the BSD 3-clause license.

You can’t perform that action at this time.