mirror of
https://github.com/esp8266/Arduino.git
synced 2025-04-21 10:26:06 +03:00
Merge pull request #1726 from ivankravets/master
Keep only main information about @PlatformIO
This commit is contained in:
Ivan Grokhotkov
commit
46bd4fcc07
20
README.md
20
README.md
@ -9,7 +9,7 @@ ESP8266 Arduino core comes with libraries to communicate over WiFi using TCP and
|
|||||||
- Installing options:
|
- Installing options:
|
||||||
- [Using Boards Manager](#installing-with-boards-manager)
|
- [Using Boards Manager](#installing-with-boards-manager)
|
||||||
- [Using git version](#using-git-version)
|
- [Using git version](#using-git-version)
|
||||||
- [Using stable version with PlatformIO](#using-stable-version-with-platformio)
|
- [Using PlatformIO](#using-platformio)
|
||||||
- [Building with make](#building-with-make)
|
- [Building with make](#building-with-make)
|
||||||
- [Documentation](#documentation)
|
- [Documentation](#documentation)
|
||||||
- [Issues and support](#issues-and-support)
|
- [Issues and support](#issues-and-support)
|
||||||
@ -41,7 +41,7 @@ Boards manager link: `http://arduino.esp8266.com/staging/package_esp8266com_inde
|
|||||||
|
|
||||||
Documentation: [http://esp8266.github.io/Arduino/versions/2.1.0-rc2/](http://esp8266.github.io/Arduino/versions/2.1.0-rc2/)
|
Documentation: [http://esp8266.github.io/Arduino/versions/2.1.0-rc2/](http://esp8266.github.io/Arduino/versions/2.1.0-rc2/)
|
||||||
|
|
||||||
### Using git version
|
### Using git version
|
||||||
[](https://travis-ci.org/esp8266/Arduino) [](https://codecov.io/github/esp8266/Arduino?branch=master)
|
[](https://travis-ci.org/esp8266/Arduino) [](https://codecov.io/github/esp8266/Arduino?branch=master)
|
||||||
|
|
||||||
- Install Arduino 1.6.7
|
- Install Arduino 1.6.7
|
||||||
@ -60,11 +60,21 @@ python get.py
|
|||||||
```
|
```
|
||||||
- Restart Arduino
|
- Restart Arduino
|
||||||
|
|
||||||
### Using stable version with PlatformIO
|
### Using PlatformIO
|
||||||
|
|
||||||
[PlatformIO](http://platformio.org) is a cross-platform code-builder and library manager for embedded development with no external dependencies. Works on the popular host OS: Mac OS X, Windows, Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard). More details in documentation [What is PlatformIO? How does it work?](http://docs.platformio.org/en/latest/faq.html#general).
|
[PlatformIO](http://platformio.org) is an open source ecosystem for IoT
|
||||||
|
development with cross platform build system, library manager and full support
|
||||||
|
for Espressif (ESP8266) development. It works on the popular host OS: Mac OS X, Windows,
|
||||||
|
Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).
|
||||||
|
|
||||||
See [detailed instructions on how to use Espressif platform with PlatformIO](doc/platformio.md).
|
- [What is PlatformIO?](http://docs.platformio.org/en/latest/what-is-platformio.html)
|
||||||
|
- [PlatformIO IDE](http://platformio.org/#!/platformio-ide)
|
||||||
|
- Quick Start with [PlatformIO IDE](http://docs.platformio.org/en/latest/ide/atom.html#quick-start) or [PlatformIO CLI](http://docs.platformio.org/en/latest/quickstart.html)
|
||||||
|
- [Advanced using](http://docs.platformio.org/en/latest/platforms/espressif.html) -
|
||||||
|
custom settings, uploading to SPIFFS, Over-the-Air (OTA) or using stage version
|
||||||
|
- [Integration with other IDE](http://docs.platformio.org/en/latest/ide.html) -
|
||||||
|
Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM and Visual Studio
|
||||||
|
- [Project Examples](http://docs.platformio.org/en/latest/platforms/espressif.html#examples)
|
||||||
|
|
||||||
### Building with make
|
### Building with make
|
||||||
|
|
||||||
|
|||||||
@ -1,78 +0,0 @@
|
|||||||
## Using PlatformIO
|
|
||||||
|
|
||||||
- Install [PlatformIO](http://platformio.org)
|
|
||||||
- Initialise new project
|
|
||||||
|
|
||||||
```bash
|
|
||||||
#
|
|
||||||
# Create empty directory
|
|
||||||
#
|
|
||||||
mkdir myproject
|
|
||||||
cd myproject
|
|
||||||
|
|
||||||
#
|
|
||||||
# Find type of supported boards
|
|
||||||
#
|
|
||||||
platformio boards espressif
|
|
||||||
|
|
||||||
# Platform: espressif
|
|
||||||
# --------------------------------------------------------------------------------------------------------
|
|
||||||
# Type MCU Frequency Flash RAM Name
|
|
||||||
# --------------------------------------------------------------------------------------------------------
|
|
||||||
# huzzah esp8266 80Mhz 4096Kb 80Kb Adafruit HUZZAH ESP8266
|
|
||||||
# espino esp8266 80Mhz 4096Kb 80Kb ESPino
|
|
||||||
# esp12e esp8266 80Mhz 4096Kb 80Kb Espressif ESP8266 ESP-12E
|
|
||||||
# esp01_1m esp8266 80Mhz 1024Kb 80Kb Espressif Generic ESP8266 ESP-01 1M
|
|
||||||
# esp01 esp8266 80Mhz 512Kb 80Kb Espressif Generic ESP8266 ESP-01 512k
|
|
||||||
# nodemcu esp8266 80Mhz 4096Kb 80Kb NodeMCU 0.9 & 1.0
|
|
||||||
# modwifi esp8266 80Mhz 2048Kb 80Kb Olimex MOD-WIFI-ESP8266(-DEV)
|
|
||||||
# thing esp8266 80Mhz 512Kb 80Kb SparkFun ESP8266 Thing
|
|
||||||
# esp210 esp8266 80Mhz 4096Kb 80Kb SweetPea ESP-210
|
|
||||||
# d1 esp8266 80Mhz 4096Kb 80Kb WeMos D1
|
|
||||||
# d1_mini esp8266 80Mhz 4096Kb 80Kb WeMos D1 mini
|
|
||||||
# ...
|
|
||||||
#
|
|
||||||
# The rest of Board/MCU variations with the different Flash/SPIFFS can be customized using extra LD Script.
|
|
||||||
# PlatformIO contains the popular LD scripts.
|
|
||||||
# See http://docs.platformio.org/en/latest/platforms/espressif.html#custom-flash-size
|
|
||||||
#
|
|
||||||
|
|
||||||
#
|
|
||||||
# Initialise base project
|
|
||||||
#
|
|
||||||
platformio init --board %TYPE%(see above)
|
|
||||||
# for example, initialise project for Espressif Generic ESP8266 ESP-01
|
|
||||||
platformio init --board esp01
|
|
||||||
|
|
||||||
# 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
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# process/build project
|
|
||||||
platformio run
|
|
||||||
|
|
||||||
# build+upload firmware
|
|
||||||
platformio run --target upload
|
|
||||||
```
|
|
||||||
|
|
||||||
## Advanced documentation
|
|
||||||
|
|
||||||
- [OTA update](http://docs.platformio.org/en/latest/platforms/espressif.html#ota-update)
|
|
||||||
* [Authentication and upload options](http://docs.platformio.org/en/latest/platforms/espressif.html#authentication-and-upload-options)
|
|
||||||
- [Custom CPU Frequency and Upload Speed](http://docs.platformio.org/en/latest/platforms/espressif.html#custom-cpu-frequency-and-upload-speed)
|
|
||||||
- [Custom Flash Size](http://docs.platformio.org/en/latest/platforms/espressif.html#custom-flash-size)
|
|
||||||
- [IDE Integration](http://docs.platformio.org/en/latest/ide.html) (Atom, CLion, Eclipse, Qt Creator, Sublime Text, VIM, Visual Studio)
|
|
||||||
- [Project Examples](http://docs.platformio.org/en/latest/platforms/espressif.html#examples)
|
|
||||||
|
|
||||||
## Demo of Over-the-Air (OTA) ESP8266 programming using PlatformIO
|
|
||||||
|
|
||||||
http://www.penninkhof.com/2015/12/1610-over-the-air-esp8266-programming-using-platformio/
|
|
||||||
|
|
||||||
[](http://www.youtube.com/watch?v=lXchL3hpDO4 "Over-the-Air ESP8266 programming using PlatformIO")
|
|
||||||
Loading…
x
Reference in New Issue
Block a user