Skip to content

Commit a23cb9c

Browse files
committed
Merge pull request #1197 from ivankravets/master
Add PlatformIO as alternative option to use ESP8266 core for Arduino
2 parents e7024fb + c1e60ab commit a23cb9c

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

README.md

+63
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,69 @@ python get.py
4848
```
4949
- Restart Arduino
5050

51+
### Using PlatformIO
52+
53+
[PlatformIO](http://platformio.org) 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). More details in documentation [What is PlatformIO? How does it work?](http://docs.platformio.org/en/latest/faq.html#general).
54+
55+
- Install [PlatformIO](http://platformio.org)
56+
- Initialise new project
57+
```bash
58+
#
59+
# Create empty directory
60+
#
61+
mkdir myproject
62+
cd myproject
63+
64+
#
65+
# Find type of supported boards
66+
#
67+
platformio boards espressif
68+
69+
# Platform: espressif
70+
# --------------------------------------------------------------------------------------------------------
71+
# Type MCU Frequency Flash RAM Name
72+
# --------------------------------------------------------------------------------------------------------
73+
# esp01 esp8266 80Mhz 512Kb 32Kb Espressif ESP8266 ESP-01 board
74+
# esp01_1m esp8266 80Mhz 1024Kb 32Kb Espressif ESP8266 ESP-01-1MB board
75+
# esp12e esp8266 80Mhz 4096Kb 32Kb Espressif ESP8266 ESP-12E board (NodeMCU)
76+
# ...
77+
78+
#
79+
# Initialise base project
80+
#
81+
platformio init --board %TYPE%(see above)
82+
83+
# The next files/directories will be created in myproject
84+
# platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
85+
# src - Put your source files here
86+
# lib - Put here project specific (private) libraries
87+
# Do you want to continue? [y/N]: Y
88+
```
89+
- Place your source code to `src` directory
90+
- Build/Upload project
91+
```
92+
# process/build project
93+
platformio run
94+
95+
# build+upload firmware
96+
platformio run --target upload
97+
98+
# build+upload firmware via OTA
99+
platformio run --target upload --upload-port IP_ADDRESS_HERE
100+
```
101+
102+
### IDE Integration
103+
In addition, PlatformIO [can be integrated into the popular IDEs](http://docs.platformio.org/en/latest/ide.html). For example, initialise project for Espressif ESP8266 ESP-01 board and Eclipse IDE
104+
```
105+
platformio init --board esp01 --ide eclipse
106+
```
107+
Then [import project](http://docs.platformio.org/en/latest/ide/eclipse.html) using `Eclipse Menu: File > Import... > General > Existing Projects into Workspace`.
108+
109+
### Demo of OTA firmware uploading
110+
[![PlatformIO and OTA firmware uploading to Espressif ESP8266 ESP-01](http://img.youtube.com/vi/W8wWjvQ8ZQs/0.jpg)](http://www.youtube.com/watch?v=W8wWjvQ8ZQs "PlatformIO and OTA firmware uploading to Espressif ESP8266 ESP-01")
111+
112+
### Documentation
113+
51114
Documentation for latest development version:
52115

53116
- [Reference](doc/reference.md)

0 commit comments

Comments
 (0)