-
-
Notifications
You must be signed in to change notification settings - Fork 800
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
30 changed files
with
553 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
.. Copyright 2014-2015 Ivan Kravets <[email protected]> | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
OTA update | ||
---------- | ||
|
||
There are 2 options: | ||
|
||
* Directly specify :option:`platformio run --upload-port` in command line | ||
|
||
.. code-block:: bash | ||
platformio run --target upload --upload-port IP_ADDRESS_HERE | ||
* Specify ``upload_port`` option in :ref:`projectconf` | ||
|
||
.. code-block:: ini | ||
[env:myenv] | ||
... | ||
upload_port = IP_ADDRESS_HERE | ||
Authentication and upload options | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
You can pass additional options/flags to OTA uploader using | ||
``upload_flags`` option in :ref:`projectconf` | ||
|
||
.. code-block:: ini | ||
[env:myenv] | ||
upload_flags = --port=8266 | ||
Available 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 available options please run | ||
|
||
.. code-block:: bash | ||
~/.platformio/packages/framework-arduinoespressif/tools/espota.py -h | ||
Usage: espota.py [options] | ||
Transmit image over the air to the esp8266 module with OTA support. | ||
Options: | ||
-h, --help show this help message and exit | ||
Destination: | ||
-i ESP_IP, --ip=ESP_IP | ||
ESP8266 IP Address. | ||
-p ESP_PORT, --port=ESP_PORT | ||
ESP8266 ota Port. Default 8266 | ||
Authentication: | ||
-a AUTH, --auth=AUTH | ||
Set authentication password. | ||
Image: | ||
-f FILE, --file=FILE | ||
Image file. | ||
-s, --spiffs Use this option to transmit a SPIFFS image and do not | ||
flash the module. | ||
Output: | ||
-d, --debug Show debug output. And override loglevel with debug. | ||
-r, --progress Show progress output. Does not work for ArduinoIDE | ||
Custom CPU Frequency and Upload Speed | ||
------------------------------------- | ||
|
||
See :ref:`projectconf_board_f_cpu` and :ref:`projectconf_upload_speed` options | ||
from :ref:`projectconf` | ||
|
||
.. code-block:: ini | ||
[env:myenv] | ||
# set frequency to 40MHz | ||
board_f_cpu = 40000000L | ||
upload_speed = 9600 | ||
Custom Flash Size | ||
----------------- | ||
|
||
The list with preconfigured LD scripts is located in public repository | ||
`platformio-pkg-ldscripts <https://github.com/platformio/platformio-pkg-ldscripts>`_. | ||
|
||
* ``esp8266.flash.512k0.ld`` 512K (no SPIFFS) | ||
* ``esp8266.flash.512k64.ld`` 512K (64K SPIFFS) | ||
* ``esp8266.flash.1m64.ld`` 1M (64K SPIFFS) | ||
* ``esp8266.flash.1m128.ld`` 1M (128K SPIFFS) | ||
* ``esp8266.flash.1m256.ld`` 1M (256K SPIFFS) | ||
* ``esp8266.flash.1m512.ld`` 1M (512K SPIFFS) | ||
* ``esp8266.flash.2m.ld`` 2M (1M SPIFFS) | ||
* ``esp8266.flash.4m1.ld`` 4M (1M SPIFFS) | ||
* ``esp8266.flash.4m.ld`` 4M (3M SPIFFS) | ||
* ``esp8266.flash.8m.ld`` 8M (7M SPIFFS) | ||
* ``esp8266.flash.16m.ld`` 16M (15M SPIFFS) | ||
|
||
To override default LD script please use :ref:`projectconf_build_flags` from | ||
:ref:`projectconf`. | ||
|
||
.. code-block:: ini | ||
[env:myenv] | ||
build_flags = -Wl,-Tesp8266.flash.4m.ld | ||
Examples | ||
-------- | ||
|
||
All project examples are located in PlatformIO repository | ||
`Examples for Espressif platform <https://github.com/platformio/platformio/tree/develop/examples/espressif>`_. | ||
|
||
* `Native SDK <https://github.com/platformio/platformio/tree/develop/examples/espressif/esp8266-native>`_ | ||
* `WebServer <https://github.com/platformio/platformio/tree/develop/examples/espressif/esp8266-webserver>`_ | ||
* `WiFiScan <https://github.com/platformio/platformio/tree/develop/examples/espressif/esp8266-wifiscan>`_ |
Oops, something went wrong.