Skip to content

Commit 41c2164

Browse files
committed
Merge branch 'release/v2.6.1'
2 parents b3d5ced + ee87b55 commit 41c2164

30 files changed

+553
-90
lines changed

HISTORY.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,30 @@ Release History
44
PlatformIO 2.0
55
--------------
66

7+
2.6.1 (2015-12-18)
8+
~~~~~~~~~~~~~~~~~~
9+
10+
* Added support for the new ESP8266-based boards (SparkFun ESP8266 Thing,
11+
NodeMCU 0.9 & 1.0, Olimex MOD-WIFI-ESP8266(-DEV), Adafruit HUZZAH ESP8266,
12+
ESPino, SweetPea ESP-210, WeMos D1, WeMos D1 mini) to
13+
`Espressif <http://docs.platformio.org/en/latest/platforms/espressif.html>`__
14+
development platform
15+
* Created public `platformio-pkg-ldscripts <https://github.com/platformio/platformio-pkg-ldscripts.git>`_
16+
repository for LD scripts. Moved common configuration for ESP8266 MCU to
17+
``esp8266.flash.common.ld``
18+
(`issue #379 <https://github.com/platformio/platformio/issues/379>`_)
19+
* Improved documentation for `Espressif <http://docs.platformio.org/en/latest/platforms/espressif.html>`__
20+
development platform: OTA update, custom Flash Size, Upload Speed and CPU
21+
frequency
22+
* Fixed reset method for Espressif NodeMCU (ESP-12E Module)
23+
(`issue #380 <https://github.com/platformio/platformio/issues/380>`_)
24+
* Fixed issue with code builder when build path contains spaces
25+
(`issue #387 <https://github.com/platformio/platformio/issues/387>`_)
26+
* Fixed project generator for Eclipse IDE and "duplicate path entries found
27+
in project path"
28+
(`issue #383 <https://github.com/platformio/platformio/issues/383>`_)
29+
30+
731
2.6.0 (2015-12-15)
832
~~~~~~~~~~~~~~~~~~
933

docs/articles.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Here are recent articles about PlatformIO:
2323
2015
2424
^^^^
2525

26+
* 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/>`_
2627
* 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/>`_
2728
* Nov 29, 2015 - **Keith Hughes** - `Using PlatformIO for Embedded Projects <http://smartspacestuff.blogspot.com/2015/11/using-platformio-for-embedded-projects.html>`_
2829
* 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/>`_

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969

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

7474
# The reST default role (used for this markup: `text`) to use for all
7575
# documents.

docs/faq.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,3 +245,8 @@ Archlinux: libncurses.so.5: cannot open shared object file
245245
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
246246

247247
Answered in `issue #291 <https://github.com/platformio/platformio/issues/291>`_.
248+
249+
Monitoring a serial port breaks upload
250+
''''''''''''''''''''''''''''''''''''''
251+
252+
Answered in `issue #384 <https://github.com/platformio/platformio/issues/384>`_.

docs/frameworks/arduino.rst

Lines changed: 59 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ BQ
363363
- RAM
364364

365365
* - ``zumbt328``
366-
- `BQ ZUM BT-328 board <http://www.bq.com/gb/products/zum.html>`_
366+
- `BQ ZUM BT-328 <http://www.bq.com/gb/products/zum.html>`_
367367
- ATMEGA328P
368368
- 16 MHz
369369
- 32 Kb
@@ -484,26 +484,75 @@ Espressif
484484
- Flash
485485
- RAM
486486

487+
* - ``d1``
488+
- `WeMos D1 <http://www.wemos.cc/wiki/doku.php?id=en:d1>`_
489+
- ESP8266
490+
- 80 MHz
491+
- 1024 Kb
492+
- 80 Kb
493+
494+
* - ``d1_mini``
495+
- `WeMos D1 mini <http://www.wemos.cc/wiki/doku.php?id=en:d1_mini>`_
496+
- ESP8266
497+
- 80 MHz
498+
- 1024 Kb
499+
- 80 Kb
500+
487501
* - ``esp01``
488-
- `Espressif ESP8266 ESP-01 board <https://nurdspace.nl/ESP8266>`_
502+
- `Espressif Generic ESP8266 ESP-01 <https://nurdspace.nl/ESP8266>`_
489503
- ESP8266
490504
- 80 MHz
491505
- 512 Kb
492-
- 32 Kb
506+
- 80 Kb
493507

494-
* - ``esp01_1m``
495-
- `Espressif ESP8266 ESP-01-1MB board <https://nurdspace.nl/ESP8266>`_
508+
* - ``esp12e``
509+
- `Espressif ESP8266 ESP-12E <https://nurdspace.nl/ESP8266>`_
496510
- ESP8266
497511
- 80 MHz
498512
- 1024 Kb
499-
- 32 Kb
513+
- 80 Kb
500514

501-
* - ``esp12e``
502-
- `Espressif ESP8266 ESP-12E board (NodeMCU) <https://nurdspace.nl/ESP8266>`_
515+
* - ``esp210``
516+
- `SweetPea ESP-210 <http://wiki.sweetpeas.se/index.php?title=ESP-210>`_
503517
- ESP8266
504518
- 80 MHz
505-
- 4096 Kb
506-
- 32 Kb
519+
- 1024 Kb
520+
- 80 Kb
521+
522+
* - ``espino``
523+
- `ESPino <http://www.espino.io>`_
524+
- ESP8266
525+
- 80 MHz
526+
- 1024 Kb
527+
- 80 Kb
528+
529+
* - ``huzzah``
530+
- `Adafruit HUZZAH ESP8266 <https://www.adafruit.com/products/2471>`_
531+
- ESP8266
532+
- 80 MHz
533+
- 1024 Kb
534+
- 80 Kb
535+
536+
* - ``modwifi``
537+
- `Olimex MOD-WIFI-ESP8266(-DEV) <https://www.olimex.com/Products/IoT/MOD-WIFI-ESP8266-DEV/open-source-hardware>`_
538+
- ESP8266
539+
- 80 MHz
540+
- 1024 Kb
541+
- 80 Kb
542+
543+
* - ``nodemcu``
544+
- `NodeMCU 0.9 & 1.0 <http://www.nodemcu.com/>`_
545+
- ESP8266
546+
- 80 MHz
547+
- 1024 Kb
548+
- 80 Kb
549+
550+
* - ``thing``
551+
- `SparkFun ESP8266 Thing <https://www.sparkfun.com/products/13231>`_
552+
- ESP8266
553+
- 80 MHz
554+
- 512 Kb
555+
- 80 Kb
507556

508557
LightUp
509558
~~~~~~~

docs/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ The Missing Library Manager. *It's here!*
7171
* Automatic library updating
7272
* It runs on Windows, Mac OS X, and Linux (+ARM).
7373

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

7677
Contents
7778
--------
@@ -94,7 +95,7 @@ Contents
9495

9596
.. toctree::
9697
:caption: Instruments
97-
:maxdepth: 2
98+
:maxdepth: 3
9899

99100
Platforms & Boards <platforms/index>
100101
frameworks/index

docs/platforms/atmelavr.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ BQ
368368
- RAM
369369

370370
* - ``zumbt328``
371-
- `BQ ZUM BT-328 board <http://www.bq.com/gb/products/zum.html>`_
371+
- `BQ ZUM BT-328 <http://www.bq.com/gb/products/zum.html>`_
372372
- ATMEGA328P
373373
- 16 MHz
374374
- 32 Kb

docs/platforms/espressif.rst

Lines changed: 60 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -85,23 +85,74 @@ Espressif
8585
- Flash
8686
- RAM
8787

88+
* - ``d1``
89+
- `WeMos D1 <http://www.wemos.cc/wiki/doku.php?id=en:d1>`_
90+
- ESP8266
91+
- 80 MHz
92+
- 1024 Kb
93+
- 80 Kb
94+
95+
* - ``d1_mini``
96+
- `WeMos D1 mini <http://www.wemos.cc/wiki/doku.php?id=en:d1_mini>`_
97+
- ESP8266
98+
- 80 MHz
99+
- 1024 Kb
100+
- 80 Kb
101+
88102
* - ``esp01``
89-
- `Espressif ESP8266 ESP-01 board <https://nurdspace.nl/ESP8266>`_
103+
- `Espressif Generic ESP8266 ESP-01 <https://nurdspace.nl/ESP8266>`_
90104
- ESP8266
91105
- 80 MHz
92106
- 512 Kb
93-
- 32 Kb
107+
- 80 Kb
94108

95-
* - ``esp01_1m``
96-
- `Espressif ESP8266 ESP-01-1MB board <https://nurdspace.nl/ESP8266>`_
109+
* - ``esp12e``
110+
- `Espressif ESP8266 ESP-12E <https://nurdspace.nl/ESP8266>`_
97111
- ESP8266
98112
- 80 MHz
99113
- 1024 Kb
100-
- 32 Kb
114+
- 80 Kb
101115

102-
* - ``esp12e``
103-
- `Espressif ESP8266 ESP-12E board (NodeMCU) <https://nurdspace.nl/ESP8266>`_
116+
* - ``esp210``
117+
- `SweetPea ESP-210 <http://wiki.sweetpeas.se/index.php?title=ESP-210>`_
118+
- ESP8266
119+
- 80 MHz
120+
- 1024 Kb
121+
- 80 Kb
122+
123+
* - ``espino``
124+
- `ESPino <http://www.espino.io>`_
125+
- ESP8266
126+
- 80 MHz
127+
- 1024 Kb
128+
- 80 Kb
129+
130+
* - ``huzzah``
131+
- `Adafruit HUZZAH ESP8266 <https://www.adafruit.com/products/2471>`_
132+
- ESP8266
133+
- 80 MHz
134+
- 1024 Kb
135+
- 80 Kb
136+
137+
* - ``modwifi``
138+
- `Olimex MOD-WIFI-ESP8266(-DEV) <https://www.olimex.com/Products/IoT/MOD-WIFI-ESP8266-DEV/open-source-hardware>`_
139+
- ESP8266
140+
- 80 MHz
141+
- 1024 Kb
142+
- 80 Kb
143+
144+
* - ``nodemcu``
145+
- `NodeMCU 0.9 & 1.0 <http://www.nodemcu.com/>`_
146+
- ESP8266
147+
- 80 MHz
148+
- 1024 Kb
149+
- 80 Kb
150+
151+
* - ``thing``
152+
- `SparkFun ESP8266 Thing <https://www.sparkfun.com/products/13231>`_
104153
- ESP8266
105154
- 80 MHz
106-
- 4096 Kb
107-
- 32 Kb
155+
- 512 Kb
156+
- 80 Kb
157+
158+
.. include:: espressif_extra.rst

docs/platforms/espressif_extra.rst

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
.. Copyright 2014-2015 Ivan Kravets <[email protected]>
2+
Licensed under the Apache License, Version 2.0 (the "License");
3+
you may not use this file except in compliance with the License.
4+
You may obtain a copy of the License at
5+
http://www.apache.org/licenses/LICENSE-2.0
6+
Unless required by applicable law or agreed to in writing, software
7+
distributed under the License is distributed on an "AS IS" BASIS,
8+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9+
See the License for the specific language governing permissions and
10+
limitations under the License.
11+
12+
OTA update
13+
----------
14+
15+
There are 2 options:
16+
17+
* Directly specify :option:`platformio run --upload-port` in command line
18+
19+
.. code-block:: bash
20+
21+
platformio run --target upload --upload-port IP_ADDRESS_HERE
22+
23+
* Specify ``upload_port`` option in :ref:`projectconf`
24+
25+
.. code-block:: ini
26+
27+
[env:myenv]
28+
...
29+
upload_port = IP_ADDRESS_HERE
30+
31+
Authentication and upload options
32+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33+
34+
You can pass additional options/flags to OTA uploader using
35+
``upload_flags`` option in :ref:`projectconf`
36+
37+
.. code-block:: ini
38+
39+
[env:myenv]
40+
upload_flags = --port=8266
41+
42+
Available flags
43+
44+
* ``--port=ESP_PORT`` ESP8266 ota Port. Default 8266
45+
* ``--auth=AUTH`` Set authentication password
46+
* ``--spiffs`` Use this option to transmit a SPIFFS image and do not flash
47+
the module
48+
49+
For the full list with available options please run
50+
51+
.. code-block:: bash
52+
53+
~/.platformio/packages/framework-arduinoespressif/tools/espota.py -h
54+
55+
Usage: espota.py [options]
56+
57+
Transmit image over the air to the esp8266 module with OTA support.
58+
59+
Options:
60+
-h, --help show this help message and exit
61+
62+
Destination:
63+
-i ESP_IP, --ip=ESP_IP
64+
ESP8266 IP Address.
65+
-p ESP_PORT, --port=ESP_PORT
66+
ESP8266 ota Port. Default 8266
67+
68+
Authentication:
69+
-a AUTH, --auth=AUTH
70+
Set authentication password.
71+
72+
Image:
73+
-f FILE, --file=FILE
74+
Image file.
75+
-s, --spiffs Use this option to transmit a SPIFFS image and do not
76+
flash the module.
77+
78+
Output:
79+
-d, --debug Show debug output. And override loglevel with debug.
80+
-r, --progress Show progress output. Does not work for ArduinoIDE
81+
82+
Custom CPU Frequency and Upload Speed
83+
-------------------------------------
84+
85+
See :ref:`projectconf_board_f_cpu` and :ref:`projectconf_upload_speed` options
86+
from :ref:`projectconf`
87+
88+
.. code-block:: ini
89+
90+
[env:myenv]
91+
# set frequency to 40MHz
92+
board_f_cpu = 40000000L
93+
94+
upload_speed = 9600
95+
96+
97+
Custom Flash Size
98+
-----------------
99+
100+
The list with preconfigured LD scripts is located in public repository
101+
`platformio-pkg-ldscripts <https://github.com/platformio/platformio-pkg-ldscripts>`_.
102+
103+
* ``esp8266.flash.512k0.ld`` 512K (no SPIFFS)
104+
* ``esp8266.flash.512k64.ld`` 512K (64K SPIFFS)
105+
* ``esp8266.flash.1m64.ld`` 1M (64K SPIFFS)
106+
* ``esp8266.flash.1m128.ld`` 1M (128K SPIFFS)
107+
* ``esp8266.flash.1m256.ld`` 1M (256K SPIFFS)
108+
* ``esp8266.flash.1m512.ld`` 1M (512K SPIFFS)
109+
* ``esp8266.flash.2m.ld`` 2M (1M SPIFFS)
110+
* ``esp8266.flash.4m1.ld`` 4M (1M SPIFFS)
111+
* ``esp8266.flash.4m.ld`` 4M (3M SPIFFS)
112+
* ``esp8266.flash.8m.ld`` 8M (7M SPIFFS)
113+
* ``esp8266.flash.16m.ld`` 16M (15M SPIFFS)
114+
115+
To override default LD script please use :ref:`projectconf_build_flags` from
116+
:ref:`projectconf`.
117+
118+
.. code-block:: ini
119+
120+
[env:myenv]
121+
build_flags = -Wl,-Tesp8266.flash.4m.ld
122+
123+
Examples
124+
--------
125+
126+
All project examples are located in PlatformIO repository
127+
`Examples for Espressif platform <https://github.com/platformio/platformio/tree/develop/examples/espressif>`_.
128+
129+
* `Native SDK <https://github.com/platformio/platformio/tree/develop/examples/espressif/esp8266-native>`_
130+
* `WebServer <https://github.com/platformio/platformio/tree/develop/examples/espressif/esp8266-webserver>`_
131+
* `WiFiScan <https://github.com/platformio/platformio/tree/develop/examples/espressif/esp8266-wifiscan>`_

0 commit comments

Comments
 (0)