Skip to content

Commit

Permalink
Merge branch 'release/v2.6.1'
Browse files Browse the repository at this point in the history
  • Loading branch information
ivankravets committed Dec 18, 2015
2 parents b3d5ced + ee87b55 commit 41c2164
Show file tree
Hide file tree
Showing 30 changed files with 553 additions and 90 deletions.
24 changes: 24 additions & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,30 @@ Release History
PlatformIO 2.0
--------------

2.6.1 (2015-12-18)
~~~~~~~~~~~~~~~~~~

* Added support for the new ESP8266-based boards (SparkFun ESP8266 Thing,
NodeMCU 0.9 & 1.0, Olimex MOD-WIFI-ESP8266(-DEV), Adafruit HUZZAH ESP8266,
ESPino, SweetPea ESP-210, WeMos D1, WeMos D1 mini) to
`Espressif <http://docs.platformio.org/en/latest/platforms/espressif.html>`__
development platform
* Created public `platformio-pkg-ldscripts <https://github.com/platformio/platformio-pkg-ldscripts.git>`_
repository for LD scripts. Moved common configuration for ESP8266 MCU to
``esp8266.flash.common.ld``
(`issue #379 <https://github.com/platformio/platformio/issues/379>`_)
* Improved documentation for `Espressif <http://docs.platformio.org/en/latest/platforms/espressif.html>`__
development platform: OTA update, custom Flash Size, Upload Speed and CPU
frequency
* Fixed reset method for Espressif NodeMCU (ESP-12E Module)
(`issue #380 <https://github.com/platformio/platformio/issues/380>`_)
* Fixed issue with code builder when build path contains spaces
(`issue #387 <https://github.com/platformio/platformio/issues/387>`_)
* Fixed project generator for Eclipse IDE and "duplicate path entries found
in project path"
(`issue #383 <https://github.com/platformio/platformio/issues/383>`_)


2.6.0 (2015-12-15)
~~~~~~~~~~~~~~~~~~

Expand Down
1 change: 1 addition & 0 deletions docs/articles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Here are recent articles about PlatformIO:
2015
^^^^

* Dec 01, 2015 - **JetBrains CLion Blog** - `C++ Annotated: Fall 2015. Arduino Support in CLion using PlatformIO <http://blog.jetbrains.com/clion/2015/12/cpp-annotated-fall-2015/>`_
* Dec 01, 2015 - **Tateno Yuichi** - `ESP8266 を CUI で開発する (Develop a ESP8266 in CUI, Japanese) <http://jaywiggins.com/platformio/arduino/avr/es8266/2015/09/30/platformio-investigation/>`_
* Nov 29, 2015 - **Keith Hughes** - `Using PlatformIO for Embedded Projects <http://smartspacestuff.blogspot.com/2015/11/using-platformio-for-embedded-projects.html>`_
* Nov 22, 2015 - **Michał Seroczyński** - `Using PlatformIO to get started with Arduino in CLion IDE <http://www.ches.pl/using-platformio-get-started-arduino-clion-ide/>`_
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
exclude_patterns = ['_build', '**/*_extra.rst']

# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand Down
5 changes: 5 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -245,3 +245,8 @@ Archlinux: libncurses.so.5: cannot open shared object file
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

Answered in `issue #291 <https://github.com/platformio/platformio/issues/291>`_.

Monitoring a serial port breaks upload
''''''''''''''''''''''''''''''''''''''

Answered in `issue #384 <https://github.com/platformio/platformio/issues/384>`_.
69 changes: 59 additions & 10 deletions docs/frameworks/arduino.rst
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ BQ
- RAM

* - ``zumbt328``
- `BQ ZUM BT-328 board <http://www.bq.com/gb/products/zum.html>`_
- `BQ ZUM BT-328 <http://www.bq.com/gb/products/zum.html>`_
- ATMEGA328P
- 16 MHz
- 32 Kb
Expand Down Expand Up @@ -484,26 +484,75 @@ Espressif
- Flash
- RAM

* - ``d1``
- `WeMos D1 <http://www.wemos.cc/wiki/doku.php?id=en:d1>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``d1_mini``
- `WeMos D1 mini <http://www.wemos.cc/wiki/doku.php?id=en:d1_mini>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``esp01``
- `Espressif ESP8266 ESP-01 board <https://nurdspace.nl/ESP8266>`_
- `Espressif Generic ESP8266 ESP-01 <https://nurdspace.nl/ESP8266>`_
- ESP8266
- 80 MHz
- 512 Kb
- 32 Kb
- 80 Kb

* - ``esp01_1m``
- `Espressif ESP8266 ESP-01-1MB board <https://nurdspace.nl/ESP8266>`_
* - ``esp12e``
- `Espressif ESP8266 ESP-12E <https://nurdspace.nl/ESP8266>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 32 Kb
- 80 Kb

* - ``esp12e``
- `Espressif ESP8266 ESP-12E board (NodeMCU) <https://nurdspace.nl/ESP8266>`_
* - ``esp210``
- `SweetPea ESP-210 <http://wiki.sweetpeas.se/index.php?title=ESP-210>`_
- ESP8266
- 80 MHz
- 4096 Kb
- 32 Kb
- 1024 Kb
- 80 Kb

* - ``espino``
- `ESPino <http://www.espino.io>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``huzzah``
- `Adafruit HUZZAH ESP8266 <https://www.adafruit.com/products/2471>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``modwifi``
- `Olimex MOD-WIFI-ESP8266(-DEV) <https://www.olimex.com/Products/IoT/MOD-WIFI-ESP8266-DEV/open-source-hardware>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``nodemcu``
- `NodeMCU 0.9 & 1.0 <http://www.nodemcu.com/>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``thing``
- `SparkFun ESP8266 Thing <https://www.sparkfun.com/products/13231>`_
- ESP8266
- 80 MHz
- 512 Kb
- 80 Kb

LightUp
~~~~~~~
Expand Down
5 changes: 3 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ The Missing Library Manager. *It's here!*
* Automatic library updating
* It runs on Windows, Mac OS X, and Linux (+ARM).

For further details, please refer to :ref:`faq_what_is_platformio`
For further details, please refer to
:ref:`What is PlatformIO? How does it work? <faq_what_is_platformio>`

Contents
--------
Expand All @@ -94,7 +95,7 @@ Contents

.. toctree::
:caption: Instruments
:maxdepth: 2
:maxdepth: 3

Platforms & Boards <platforms/index>
frameworks/index
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/atmelavr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ BQ
- RAM

* - ``zumbt328``
- `BQ ZUM BT-328 board <http://www.bq.com/gb/products/zum.html>`_
- `BQ ZUM BT-328 <http://www.bq.com/gb/products/zum.html>`_
- ATMEGA328P
- 16 MHz
- 32 Kb
Expand Down
69 changes: 60 additions & 9 deletions docs/platforms/espressif.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,23 +85,74 @@ Espressif
- Flash
- RAM

* - ``d1``
- `WeMos D1 <http://www.wemos.cc/wiki/doku.php?id=en:d1>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``d1_mini``
- `WeMos D1 mini <http://www.wemos.cc/wiki/doku.php?id=en:d1_mini>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``esp01``
- `Espressif ESP8266 ESP-01 board <https://nurdspace.nl/ESP8266>`_
- `Espressif Generic ESP8266 ESP-01 <https://nurdspace.nl/ESP8266>`_
- ESP8266
- 80 MHz
- 512 Kb
- 32 Kb
- 80 Kb

* - ``esp01_1m``
- `Espressif ESP8266 ESP-01-1MB board <https://nurdspace.nl/ESP8266>`_
* - ``esp12e``
- `Espressif ESP8266 ESP-12E <https://nurdspace.nl/ESP8266>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 32 Kb
- 80 Kb

* - ``esp12e``
- `Espressif ESP8266 ESP-12E board (NodeMCU) <https://nurdspace.nl/ESP8266>`_
* - ``esp210``
- `SweetPea ESP-210 <http://wiki.sweetpeas.se/index.php?title=ESP-210>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``espino``
- `ESPino <http://www.espino.io>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``huzzah``
- `Adafruit HUZZAH ESP8266 <https://www.adafruit.com/products/2471>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``modwifi``
- `Olimex MOD-WIFI-ESP8266(-DEV) <https://www.olimex.com/Products/IoT/MOD-WIFI-ESP8266-DEV/open-source-hardware>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``nodemcu``
- `NodeMCU 0.9 & 1.0 <http://www.nodemcu.com/>`_
- ESP8266
- 80 MHz
- 1024 Kb
- 80 Kb

* - ``thing``
- `SparkFun ESP8266 Thing <https://www.sparkfun.com/products/13231>`_
- ESP8266
- 80 MHz
- 4096 Kb
- 32 Kb
- 512 Kb
- 80 Kb

.. include:: espressif_extra.rst
131 changes: 131 additions & 0 deletions docs/platforms/espressif_extra.rst
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>`_
Loading

0 comments on commit 41c2164

Please sign in to comment.