Improv documentation for Espressif platform
This commit is contained in:
@@ -9,8 +9,8 @@
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
OTA firmware uploading
|
||||
----------------------
|
||||
OTA update
|
||||
----------
|
||||
|
||||
There are 2 options:
|
||||
|
||||
@@ -24,7 +24,7 @@ There are 2 options:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[env:***]
|
||||
[env:myenv]
|
||||
...
|
||||
upload_port = IP_ADDRESS_HERE
|
||||
|
||||
@@ -36,17 +36,17 @@ You can pass additional options/flags to OTA uploader using
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[env:***]
|
||||
[env:myenv]
|
||||
upload_flags = --port=8266
|
||||
|
||||
Availalbe flags
|
||||
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 availalbe options please run
|
||||
For the full list with available options please run
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@@ -79,6 +79,47 @@ For the full list with availalbe options please run
|
||||
-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
|
||||
--------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user