Skip to content

Latest commit

 

History

History
148 lines (108 loc) · 6.83 KB

README.md

File metadata and controls

148 lines (108 loc) · 6.83 KB
Raw

Arduino core for ESP8266 WiFi chip

This project brings support for ESP8266 chip to the Arduino environment. It lets you write sketches using familiar Arduino functions and libraries, and run them directly on ESP8266, 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, work with SD cards, servos, SPI and I2C peripherals.

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 Arduino 1.6.5 from the Arduino website.
  • 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 install esp8266 platform (and don't forget to select your ESP8266 board from Tools > Board menu after installation).

The best place to ask questions related to this core is ESP8266 community forum: http://www.esp8266.com/arduino. If you find this ESP8266 board manager useful, please consider supporting it with a donation. The ESP8266 Community Forum and IGRR have made this wonderful port available. Donate

Available versions

Stable version

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

Documentation: http://esp8266.github.io/Arduino/versions/2.0.0/

Staging version

Boards manager link: http://arduino.esp8266.com/staging/package_esp8266com_index.json

Documentation: http://esp8266.github.io/Arduino/versions/2.0.0-rc2/

Using git version Linux build status

  • Install Arduino 1.6.5
  • Go to Arduino directory
  • 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
  • Download binary tools (you need Python 2.7)
cd esp8266/tools
python get.py
  • Restart Arduino

Using PlatformIO

PlatformIO is a cross-platform code-builder and library manager for embedded development with no external dependencies and support for Espressif platform. Works on the popular host OS: Mac OS X, Windows, Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).

# 
# Create empty directory
#
mkdir myproject
cd myproject

# 
# Find type of supported boards
#
platformio boards espressif

# Platform: espressif
# --------------------------------------------------------------------------------------------------------
# Type                  MCU            Frequency  Flash   RAM    Name
# --------------------------------------------------------------------------------------------------------
# esp01                 esp8266        80Mhz     512Kb   32Kb   Espressif ESP8266 ESP-01 board
# esp01_1m              esp8266        80Mhz     1024Kb  32Kb   Espressif ESP8266 ESP-01-1MB board
# esp12e                esp8266        80Mhz     4096Kb  32Kb   Espressif ESP8266 ESP-12E board (NodeMCU)
# ...

#
# Initialise base project
#
platformio init --board %TYPE%(see above)

# The next files/directories will be created in myproject
# platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
# src - Put your source files here
# lib - Put here project specific (private) libraries
# Do you want to continue? [y/N]: Y
  • Place your source code to src directory
  • Build/Upload project
# process/build project
platformio run

# build+upload firmware
platformio run --target upload

# build+upload firmware via OTA
platformio run --target upload --upload-port IP_ADDRESS_HERE

IDE Integration

In addition, PlatformIO can be integrated into the popular IDEs. For example, initialise project for Espressif ESP8266 ESP-01 board and Eclipse IDE

platformio init --board esp01 --ide eclipse

Then import project using Eclipse Menu: File > Import... > General > Existing Projects into Workspace.

Demo of OTA firmware uploading

PlatformIO and OTA firmware uploading to Espressif ESP8266 ESP-01

Documentation

Documentation for latest development version:

Issues and support

If you encounter an issue, you are welcome to submit it here on Github: https://github.com/esp8266/Arduino/issues. Please provide as much context as possible: version which you are using (you can check it in Boards Manager), your sketch code, serial output, board model, IDE settings (board selection, flash size, etc).

Contributing

For minor fixes of code and documentation, go ahead and submit a pull request.

Larger changes (rewriting parts of existing code from scratch, adding new functions to the core, adding new libraries) should generally be discussed in the chat 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 MIT license.