From 79a4b922faa05b19c33549680814f205b6d81df3 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Tue, 15 Dec 2015 20:38:31 +0200 Subject: [PATCH 1/3] Add "Contents" block --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index a78c655fe..fdb199842 100644 --- a/README.md +++ b/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. +# 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 ### 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). From 7e1a04a41b1b4fa94f59a463391685ac00840f98 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Tue, 15 Dec 2015 20:45:40 +0200 Subject: [PATCH 2/3] More explanations about OTA uploading --- doc/platformio.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/doc/platformio.md b/doc/platformio.md index a03500bb3..b086c1313 100644 --- a/doc/platformio.md +++ b/doc/platformio.md @@ -28,6 +28,8 @@ platformio boards espressif # Initialise base project # 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 # platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-| @@ -39,16 +41,28 @@ platformio init --board %TYPE%(see above) - Place your source code to `src` directory - Build/Upload project -``` +```bash # process/build project platformio run # build+upload firmware platformio run --target upload +``` -# build+upload firmware via OTA +## OTA firmware uploading + +There are 2 options: + +1. Directly specify `--upoad-port` in command line +```bash platformio run --target upload --upload-port IP_ADDRESS_HERE ``` +2. Specify [upload_port](http://docs.platformio.org/en/latest/projectconf.html#upload-port) option in `platformio.ini` +```ini +[env:***] +... +upload_port = IP_ADDRESS_HERE +``` ## 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 From 94fd0333febc180461b684a25bb7d5eed3aab1ef Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Tue, 15 Dec 2015 22:28:57 +0200 Subject: [PATCH 3/3] Add authentication and upload options --- doc/platformio.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/doc/platformio.md b/doc/platformio.md index b086c1313..c03edae7e 100644 --- a/doc/platformio.md +++ b/doc/platformio.md @@ -53,17 +53,33 @@ platformio run --target upload There are 2 options: -1. Directly specify `--upoad-port` in command line +- Directly specify `--upoad-port` in command line ```bash platformio run --target upload --upload-port IP_ADDRESS_HERE ``` -2. Specify [upload_port](http://docs.platformio.org/en/latest/projectconf.html#upload-port) option in `platformio.ini` +- 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 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 ```