Arduino README

The project's README from github.com/esp8266/Arduino. As one markdown file: 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).

Latest release Latest release

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

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

Using git version

Also known as latest git or master branch.

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. Stackoverflow is also an alternative. 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:

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. PRs with such changes require testing and approval.

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.py was initially created by Fredrik Ahlberg (@themadinventor, @kongo), and is currently maintained by Angus Gratton (@projectgus) under GPL 2.0 license.

Espressif's NONOS 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.

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.

uzlib library written and (c) 2014-2018 Paul Sokolovsky, licensed under the ZLib license (https://www.zlib.net/zlib_license.html). uzlib is based on: tinf library by Joergen Ibsen (Deflate decompression); Deflate Static Huffman tree routines by Simon Tatham; LZ77 compressor by Paul Sokolovsky; with library integrated and maintained by Paul Sokolovsky.

Toolchain repo

Lwip link layer repo

SoftwareSerial repo

Serial Monitor Arduino IDE plugin Original discussion here, quick download there.

FTP Client/Server Library

Arduino (esp8266/Arduino)

Searching Database…

16.7K ·GitHub
Arduino
What is this?This is the ESP8266 core for the Arduino IDE. It brings support for the ESP8266 WiFi chip to the Arduino environment, so you can write sketches with familiar Arduino functions and run them directly on the ESP8266 without an external microcontroller.
Is this a standalone app or an add-on for the Arduino IDE?It is a hardware core/platform package that plugs into the Arduino IDE (or PlatformIO) as a board definition, adding ESP8266 support alongside your existing Arduino sketches.
How do I install it and start building for ESP8266?Install the Arduino IDE, then add the ESP8266 boards manager URL under File > Preferences > Additional Boards Manager URLs, open Boards Manager from Tools > Board and install the esp8266 platform, then pick your ESP8266 board. Alternatively use PlatformIO, build from git sources, or build with the makeEspArduino makefile.
Do I need anything besides the Arduino IDE to use this?You just need Arduino IDE 1.x or 2.x (or PlatformIO) plus an ESP8266-based board; no external microcontroller is required since the core runs sketches directly on the chip.
Is the git/master version safe to use for production builds?The git version (master branch) is the latest development version and is distinct from the stable release installed via Boards Manager; larger core changes require discussion and testing before merging, implying master can be less stable than tagged releases.
Which operating systems can I develop on?Packages are provided for Windows, Mac OS, and Linux (32 and 64 bit), and PlatformIO additionally supports Linux ARM boards like Raspberry Pi.
What networking and peripheral features does the core provide out of the box?It includes libraries for WiFi over TCP/UDP, HTTP, mDNS, SSDP and DNS servers, OTA firmware updates, a flash-based filesystem, SD cards, servos, SPI and I2C peripherals.
Can I use something other than the Arduino IDE to build projects?Yes, you can use PlatformIO (a cross-platform IoT build system with library manager and IDE integrations), or build with the makeEspArduino makefile for automated/production builds instead of the Arduino IDE.
What are similar projects?esp8266_deauther, arduino-esp32, tiny-engineer, WLED, ESP32Marauder, esp32-c3-adblock, esphome, espectre
Which topics is it in?esp8266, arduino, wifi, microcontroller, firmware, iot, ocr, embedded, hardware, http, cpp, sdk
Creator
esp8266
Size
219.3 MB
Stars
16.7K
Updated
CommitAug 27Release3.1.2Mar 20
Age
11y
Commits · 90 Days