mirror of
https://github.com/esp8266/Arduino.git
synced 2025-08-09 22:24:14 +03:00
Merge pull request #1227 from pgollor/master
merge changes from ivankravets
This commit is contained in:
10
README.md
10
README.md
@@ -5,6 +5,16 @@ This project brings support for ESP8266 chip to the Arduino environment. It lets
|
|||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
# Contents
|
||||||
|
- Installing options:
|
||||||
|
- [Using Boards Manager](#installing-with-boards-manager)
|
||||||
|
- [Using git version](#using-git-version-)
|
||||||
|
- [Using stable version with PlatformIO](#using-stable-version-with-platformio)
|
||||||
|
- [Documentation](#documentation)
|
||||||
|
- [Issues and support](#issues-and-support)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
- [License and credits](#license-and-credits)
|
||||||
|
|
||||||
### Installing with Boards Manager ###
|
### 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).
|
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).
|
||||||
|
@@ -28,6 +28,8 @@ platformio boards espressif
|
|||||||
# Initialise base project
|
# Initialise base project
|
||||||
#
|
#
|
||||||
platformio init --board %TYPE%(see above)
|
platformio init --board %TYPE%(see above)
|
||||||
|
# for example, initialise project for ESP8266 ESP-12E board (NodeMCU)
|
||||||
|
platformio init --board esp12e
|
||||||
|
|
||||||
# The next files/directories will be created in myproject
|
# The next files/directories will be created in myproject
|
||||||
# platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
|
# platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
|
||||||
@@ -39,16 +41,44 @@ platformio init --board %TYPE%(see above)
|
|||||||
- Place your source code to `src` directory
|
- Place your source code to `src` directory
|
||||||
- Build/Upload project
|
- Build/Upload project
|
||||||
|
|
||||||
```
|
```bash
|
||||||
# process/build project
|
# process/build project
|
||||||
platformio run
|
platformio run
|
||||||
|
|
||||||
# build+upload firmware
|
# build+upload firmware
|
||||||
platformio run --target upload
|
platformio run --target upload
|
||||||
|
```
|
||||||
|
|
||||||
# build+upload firmware via OTA
|
## OTA firmware uploading
|
||||||
|
|
||||||
|
There are 2 options:
|
||||||
|
|
||||||
|
- Directly specify `--upoad-port` in command line
|
||||||
|
```bash
|
||||||
platformio run --target upload --upload-port IP_ADDRESS_HERE
|
platformio run --target upload --upload-port IP_ADDRESS_HERE
|
||||||
```
|
```
|
||||||
|
- Specify [upload_port](http://docs.platformio.org/en/latest/projectconf.html#upload-port) option in `platformio.ini`
|
||||||
|
```ini
|
||||||
|
[env:***]
|
||||||
|
...
|
||||||
|
upload_port = IP_ADDRESS_HERE
|
||||||
|
```
|
||||||
|
|
||||||
|
### Authentication and upload options
|
||||||
|
|
||||||
|
You can pass additional options/flags to OTA uploader using [upload_flags](http://docs.platformio.org/en/latest/projectconf.html#upload-flags) option in `platformio.ini`
|
||||||
|
```ini
|
||||||
|
[env:***]
|
||||||
|
upload_flags = --port=8266
|
||||||
|
```
|
||||||
|
|
||||||
|
Availalbe flags
|
||||||
|
- `--port=ESP_PORT` ESP8266 ota Port. Default 8266
|
||||||
|
- `--auth=AUTH` Set authentication password
|
||||||
|
- `--spiffs` Use this option to transmit a SPIFFS image and do not flash the module
|
||||||
|
|
||||||
|
For the full list with availalbe options please run this command `~/.platformio/packages/framework-arduinoespressif/tools/espota.py -h`.
|
||||||
|
|
||||||
|
|
||||||
## IDE Integration
|
## IDE Integration
|
||||||
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
|
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
|
||||||
|
Reference in New Issue
Block a user