Merge branch 'release/v2.7.1'

This commit is contained in:
Ivan Kravets
2016-01-06 14:56:30 +02:00
272 changed files with 993 additions and 534 deletions

View File

@ -4,6 +4,27 @@ Release History
PlatformIO 2.0 PlatformIO 2.0
-------------- --------------
2.7.1 (2016-01-06)
~~~~~~~~~~~~~~~~~~
* Initial support for Arduino Zero board
(`issue #356 <https://github.com/platformio/platformio/issues/356>`_)
* Generate default targets for `supported IDE <http://docs.platformio.org/en/latest/ide.html>`__
(CLion, Eclipse IDE, Emacs, Sublime Text, VIM): Build,
Clean, Upload, Upload SPIFFS image, Upload using Programmer, Update installed
platforms and libraries
(`issue #427 <https://github.com/platformio/platformio/issues/427>`_)
* Updated Teensy Arduino Framework to 1.27
(`issue #434 <https://github.com/platformio/platformio/issues/434>`_)
* Fixed uploading of EEPROM data using ``uploadeep`` target for Atmel AVR
development platform
* Fixed project generator for CLion IDE
(`issue #422 <https://github.com/platformio/platformio/issues/422>`_)
* Fixed package ``shasum`` validation on Mac OS X 10.11.2
(`issue #429 <https://github.com/platformio/platformio/issues/429>`_)
* Fixed CMakeLists.txt ``add_executable`` has only one source file
(`issue #421 <https://github.com/platformio/platformio/issues/421>`_)
2.7.0 (2015-12-30) 2.7.0 (2015-12-30)
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
@ -26,7 +47,7 @@ PlatformIO 2.0
Programmers <http://docs.platformio.org/en/latest/platforms/atmelavr.html#upload-using-programmer>`_: Programmers <http://docs.platformio.org/en/latest/platforms/atmelavr.html#upload-using-programmer>`_:
AVR ISP, AVRISP mkII, USBtinyISP, USBasp, Parallel Programmer and Arduino as ISP AVR ISP, AVRISP mkII, USBtinyISP, USBasp, Parallel Programmer and Arduino as ISP
* Fixed issue with current Python interpreter for Python-based tools * Fixed issue with current Python interpreter for Python-based tools
(`pull #417 <https://github.com/platformio/platformio/pull/417>`_) (`issue #417 <https://github.com/platformio/platformio/issue/417>`_)
2.6.3 (2015-12-21) 2.6.3 (2015-12-21)
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~

View File

@ -28,9 +28,6 @@ PlatformIO
.. image:: https://badges.gitter.im/Join%20Chat.svg .. image:: https://badges.gitter.im/Join%20Chat.svg
:alt: Join the chat at https://gitter.im/platformio/platformio :alt: Join the chat at https://gitter.im/platformio/platformio
:target: https://gitter.im/platformio/platformio :target: https://gitter.im/platformio/platformio
.. image:: https://img.shields.io/PlatformIO/donate.png?color=yellow
:alt: Support PlatformIO Team
:target: https://www.bountysource.com/teams/platformio
`Home & Demo <http://platformio.org>`_ | `Home & Demo <http://platformio.org>`_ |
`Project Examples <https://github.com/platformio/platformio/tree/develop/examples>`_ | `Project Examples <https://github.com/platformio/platformio/tree/develop/examples>`_ |
@ -177,10 +174,29 @@ Frameworks:
For further details, please refer to `What is PlatformIO? <http://docs.platformio.org/en/latest/faq.html#what-is-platformio>`_ For further details, please refer to `What is PlatformIO? <http://docs.platformio.org/en/latest/faq.html#what-is-platformio>`_
Contributing
------------
1. Fork the repository on GitHub.
2. Make a branch off of ``develop``
3. Run ``pip install tox``
4. Go to the root of project where is located ``tox.ini`` and run ``tox -e develop``
5. Activate current development environment:
* Windows: ``.tox\develop\Scripts\activate``
* Bash/ZSH: ``source .tox/develop/bin/activate``
* Fish: ``source .tox/bin/activate.fish``
6. Make changes to code, documentation, etc.
7. Lint source code ``tox -e lint``
8. Run the tests ``tox -e py27``
9. Commit changes to your forked repository
10. Submit a Pull Request on GitHub.
Licence Licence
------- -------
Copyright 2014-2015 Ivan Kravets <me@ikravets.com> Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
The PlatformIO is licensed under the permissive Apache 2.0 licence, The PlatformIO is licensed under the permissive Apache 2.0 licence,
so you can use it in both commercial and personal projects with confidence. so you can use it in both commercial and personal projects with confidence.

View File

@ -1,5 +1,5 @@
/** /**
* Copyright 2014-2015 Ivan Kravets <me@ikravets.com> * Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 265 KiB

After

Width:  |  Height:  |  Size: 341 KiB

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -20,6 +20,11 @@ Articles about us
Here are recent articles about PlatformIO: Here are recent articles about PlatformIO:
2016
^^^^
* Jan 05, 2016 - **Julien Rodrigues** - `Internet Of Things: The IDE scandal <https://medium.com/@jrodrigues/internet-of-things-the-ide-scandal-5ddb8fc9d918>`_
2015 2015
^^^^ ^^^^

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -45,7 +45,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'PlatformIO' project = u'PlatformIO'
copyright = u'2014-2015, Ivan Kravets' copyright = u'2014-2016, Ivan Kravets'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -50,12 +50,15 @@ Then:
2. Open source file from ``src`` directory (``*.c, *.cpp, *.ino, etc.``) 2. Open source file from ``src`` directory (``*.c, *.cpp, *.ino, etc.``)
3. Build project (*DO NOT RUN*): ``Menu: Run > Build``. 3. Build project (*DO NOT RUN*): ``Menu: Run > Build``.
There are 3 predefined targets for building (*NOT FOR RUNNING*, see marks on There are 6 predefined targets for building (*NOT FOR RUNNING*, see marks on
the screenshot below): the screenshot below):
* ``PLATFORMIO_BUILD`` - build project without auto-uploading * ``PLATFORMIO_BUILD`` - Build project without auto-uploading
* ``PLATFORMIO_UPLOAD`` - build and upload (if no errors) * ``PLATFORMIO_UPLOAD`` - Build and upload (if no errors).
* ``PLATFORMIO_CLEAN`` - clean compiled objects and etc. * ``PLATFORMIO_CLEAN`` - Clean compiled objects.
* ``PLATFORMIO_PROGRAM`` - Build and upload using external programmer (if no errors), see :ref:`atmelavr_upload_via_programmer`.
* ``PLATFORMIO_UPLOADFS`` - Upload files to file system SPIFFS, see :ref:`platform_espressif_uploadfs`.
* ``PLATFORMIO_UPDATE`` - Update installed platforms and libraries via :ref:`cmd_update`.
.. warning:: .. warning::
The libraries which are added, installed or used in the project The libraries which are added, installed or used in the project

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -53,7 +53,20 @@ Then:
``Menu: File > Import... > General > Existing Projects into Workspace > Next`` ``Menu: File > Import... > General > Existing Projects into Workspace > Next``
and specify root directory where is located :ref:`projectconf` and specify root directory where is located :ref:`projectconf`
2. Open source file from ``src`` directory (``*.c, *.cpp, *.ino, etc.``) 2. Open source file from ``src`` directory (``*.c, *.cpp, *.ino, etc.``)
3. Build project: ``Menu: Project > Build Project``. 3. Build project using ``Menu: Project > Build Project`` or preconfigured
Make Targets (see screenshot below):
+ ``PlatformIO: Build`` - Build project without auto-uploading
+ ``PlatformIO: Clean`` - Clean compiled objects.
+ ``PlatformIO: Upload`` - Build and upload (if no errors)
+ ``PlatformIO: Upload using Programmer`` see :ref:`atmelavr_upload_via_programmer`
+ ``PlatformIO: Upload SPIFFS image`` see :ref:`platform_espressif_uploadfs`
+ ``PlatformIO: Update platforms and libraries`` - Update installed platforms and libraries via :ref:`cmd_update`.
If you have some problems with unresolved includes, defines, etc., then
* Restart Eclipse IDE
* Rebuild index using ``Menu: Project > C/C++ Index > Rebuild``.
.. warning:: .. warning::
The libraries which are added, installed or used in the project The libraries which are added, installed or used in the project
@ -72,8 +85,10 @@ See a full list with :ref:`articles`.
Screenshot Screenshot
---------- ----------
Cross-platform `Blink Project <http://platformio.org/#!/get-started#blink-project-example>`_.
.. image:: ../_static/ide-platformio-eclipse.png .. image:: ../_static/ide-platformio-eclipse.png
:target: http://www.ikravets.com/computer-life/programming/2014/06/20/building-and-debugging-atmel-avr-arduino-based-project-using-eclipse-ideplatformio :target: http://docs.platformio.org/en/latest/_static/ide-platformio-eclipse.png
Examples Examples
-------- --------

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -40,7 +40,7 @@ An Emacs minor mode has been written to facilitate building and uploading from w
It can be installed from the MELPA repository using ``M-x package-install``. It can be installed from the MELPA repository using ``M-x package-install``.
See the MELPA `Getting Started <https://melpa.org/#/getting-started>`_ page for more information. See the MELPA `Getting Started <https://melpa.org/#/getting-started>`_ page for more information.
Setup instructions for the minor mode can be found at the `Github page <https://github.com/ZachMassia/platformio-mode>`_. Setup instructions and an example config can be found at the `Github page <https://github.com/ZachMassia/platformio-mode>`_.
Code completion can optionally be provided by installing `irony-mode <https://github.com/Sarcasm/irony-mode>`_ Code completion can optionally be provided by installing `irony-mode <https://github.com/Sarcasm/irony-mode>`_
@ -54,15 +54,16 @@ command and generate project via :option:`platformio init --ide` command:
.. code-block:: shell .. code-block:: shell
platformio init --ide emacs --board %TYPE% platformio init --ide emacs --board %TYPE%
cmake .
There are 4 predefined targets for building. There are 6 predefined targets for building.
* ``platformio_build`` - Build project without auto-uploading. (``C-c i b``) * ``platformio_build`` - Build project without auto-uploading. (``C-c i b``)
* ``platformio_upload`` - Build and upload (if no errors). (``C-c i u``) * ``platformio_clean`` - Clean compiled objects. (``C-c i c``)
* ``platformio_clean`` - Clean compiled objects. (``C-c i c``) * ``platformio_upload`` - Build and upload (if no errors). (``C-c i u``)
* ``platformio_update`` - Update installed platforms and libraries. (``C-c i d``) * ``platformio_programmer_upload`` - Build and upload using external programmer (if no errors, see :ref:`atmelavr_upload_via_programmer`). (``C-c i p``)
* ``platformio_spiffs_upload`` - Upload files to file system SPIFFS (see :ref:`platform_espressif_uploadfs`). (``C-c i s``)
* ``platformio_update`` - Update installed platforms and libraries. (``C-c i d``)
.. warning:: .. warning::
The libraries which are added, installed or used in the project The libraries which are added, installed or used in the project

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -50,6 +50,15 @@ Then:
3. Open source file from ``src`` directory (``*.c, *.cpp, *.ino, etc.``) 3. Open source file from ``src`` directory (``*.c, *.cpp, *.ino, etc.``)
4. Build project: ``Menu: Tools > Build``. 4. Build project: ``Menu: Tools > Build``.
Also, you can access to all pre-configured targets via
``Menu: Tools > Builds With...`` (ST3)
+ ``PlatformIO - Build`` - Build project without auto-uploading
+ ``PlatformIO - Clean`` - Clean compiled objects.
+ ``PlatformIO - Upload`` - Build and upload (if no errors)
+ ``PlatformIO - Upload using Programmer`` see :ref:`atmelavr_upload_via_programmer`
+ ``PlatformIO - Upload SPIFFS image`` see :ref:`platform_espressif_uploadfs`
+ ``PlatformIO - Update platforms and libraries`` - Update installed platforms and libraries via :ref:`cmd_update`.
Manual Integration Manual Integration
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -48,11 +48,33 @@ Put to the project directory ``Makefile`` wrapper with contents:
#PATH := /usr/local/bin:$(PATH) #PATH := /usr/local/bin:$(PATH)
all: all:
platformio -f -c vim run
upload:
platformio -f -c vim run --target upload platformio -f -c vim run --target upload
clean: clean:
platformio -f -c vim run --target clean platformio -f -c vim run --target clean
program:
platformio -f -c vim run --target program
uploadfs:
platformio -f -c vim run --target uploadfs
update:
platformio -f -c vim update
Pre-defined targets:
+ ``Build`` - Build project without auto-uploading
+ ``Clean`` - Clean compiled objects.
+ ``Upload`` - Build and upload (if no errors)
+ ``Upload using Programmer`` see :ref:`atmelavr_upload_via_programmer`
+ ``Upload SPIFFS image`` see :ref:`platform_espressif_uploadfs`
+ ``Update platforms and libraries`` - Update installed platforms and libraries via :ref:`cmd_update`.
Now, in VIM ``cd /path/to/this/project`` and press ``Ctrl+B`` or ``Cmd+B`` Now, in VIM ``cd /path/to/this/project`` and press ``Ctrl+B`` or ``Cmd+B``
(Mac). *PlatformIO* should compile your source code from the ``src`` directory, (Mac). *PlatformIO* should compile your source code from the ``src`` directory,

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -46,8 +46,8 @@ Embedded Development. *Easier Than Ever.*
----------------------------------------- -----------------------------------------
* Colourful command-line output * Colourful command-line output
* :ref:`IDE Integration <ide>` with *Arduino, Eclipse, Emacs, Energia, Qt Creator, * :ref:`IDE Integration <ide>` with *Arduino, Atom, CLion, Eclipse, Emacs,
Sublime Text, Vim, Visual Studio* Energia, Qt Creator, Sublime Text, Vim, Visual Studio*
* Cloud compiling and :ref:`ci` with *AppVeyor, Circle CI, Drone, Shippable, Travis CI* * Cloud compiling and :ref:`ci` with *AppVeyor, Circle CI, Drone, Shippable, Travis CI*
* Built-in :ref:`Serial Port Monitor <cmd_serialports_monitor>` and * Built-in :ref:`Serial Port Monitor <cmd_serialports_monitor>` and
configurable build :ref:`-flags/-options <projectconf_build_flags>` configurable build :ref:`-flags/-options <projectconf_build_flags>`

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -58,6 +58,10 @@ The latest stable version of PlatformIO may be installed or upgraded via
pip install -U platformio pip install -U platformio
If ``pip`` command is not available run ``easy_install pip`` or use
:ref:`installation_installer_script` which will install ``pip`` and
``platformio`` automatically.
Note that you may run into permissions issues running these commands. You have Note that you may run into permissions issues running these commands. You have
a few options here: a few options here:
@ -67,9 +71,6 @@ a few options here:
* Run the command in a `virtualenv <https://virtualenv.pypa.io>`_ local to a * Run the command in a `virtualenv <https://virtualenv.pypa.io>`_ local to a
specific project working set. specific project working set.
If ``pip`` command is not available or you have problems with it try
:ref:`installation_installer_script`.
.. _installation_installer_script: .. _installation_installer_script:
b) Installer Script b) Installer Script

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -150,18 +150,6 @@ Example:
"url": "https://github.com/foo/bar.git" "url": "https://github.com/foo/bar.git"
} }
.. _libjson_downloadurl:
``downloadUrl``
---------------
*Required* if :ref:`libjson_repository` field is not defined | Type: ``String``
It is the *HTTP URL* to the archived source code of library. It should end
with the type of archive (``.zip`` or ``.tar.gz``).
.. _libjson_version: .. _libjson_version:
``version`` ``version``
@ -173,15 +161,45 @@ with the type of archive (``.zip`` or ``.tar.gz``).
A version of the current library source code. A version of the current library source code.
* Can contain a-z, digits, dots or dash. * Can contain a-z, digits, dots or dash.
* `Semantic Versioning <http://semver.org>`_ is recommended. * `Semantic Versioning <http://semver.org>`_ IS RECOMMENDED.
* A `CVS <http://en.wikipedia.org/wiki/Concurrent_Versions_System>`_
revision from the latest commit. Example: ``13`` (*SVN*) or first 10 If :ref:`libjson_version` field is not defined and :ref:`libjson_repository`
chars of *SHA* digest ``e4564b7da4`` (*Git*). field is defined, then |PIOAPICR| will use the
`CVS <http://en.wikipedia.org/wiki/Concurrent_Versions_System>` revision from
the latest commit as "current version". For example, ``13`` (*SVN*) or first
10 chars of *SHA* digest ``e4564b7da4`` (*Git*).
If :ref:`libjson_version` and :ref:`libjson_repository` fields are defined,
then :ref:`libjson_version` has HIGHER PRIORITY. We recommend to use
:ref:`libjson_version` field and specify the real release version. In other
case, users will receive updates for library with each new commit to
:ref:`libjson_repository`.
.. note:: .. note::
You can omit :ref:`libjson_version` field and define |PIOAPICR| updates library only if:
:ref:`libjson_repository` field. In this case - the :ref:`libjson_version` is changed
|PIOAPICR| will use the *CVS*-revision from the latest commit. - ``library.json`` is modified
Example:
.. code-block:: javascript
"repository":
{
"type": "git",
"url": "https://github.com/foo/bar.git"
},
"version": "1.0.0"
.. _libjson_downloadurl:
``downloadUrl``
---------------
*Required* if :ref:`libjson_repository` field is not defined | Type: ``String``
It is the *HTTP URL* to the archived source code of library. It should end
with the type of archive (``.zip`` or ``.tar.gz``).
Example with fixed release/tag on GitHub: Example with fixed release/tag on GitHub:
@ -191,7 +209,6 @@ Example with fixed release/tag on GitHub:
"downloadUrl": "https://github.com/foo/bar/archive/v1.0.0.tar.gz", "downloadUrl": "https://github.com/foo/bar/archive/v1.0.0.tar.gz",
"include": "bar-1.0.0" "include": "bar-1.0.0"
See more ``library.json`` :ref:`library_creating_examples`. See more ``library.json`` :ref:`library_creating_examples`.
.. _libjson_url: .. _libjson_url:

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -62,12 +62,13 @@ Uploading files to file system SPIFFS
Please make sure to read `ESP8266 Flash layout <https://github.com/esp8266/Arduino/blob/master/doc/filesystem.md#flash-layout>`_ Please make sure to read `ESP8266 Flash layout <https://github.com/esp8266/Arduino/blob/master/doc/filesystem.md#flash-layout>`_
information first. information first.
1. Create :ref:`projectconf_pio_data_dir` and put files here 1. Initialise project :ref:`cmd_init` (if you have not initialized yet)
2. Run target ``uploadfs`` via :option:`platformio run --target` command. 2. Create :ref:`projectconf_pio_data_dir` and put files here
3. Run target ``uploadfs`` using :option:`platformio run --target` command.
To upload SPIFFS image using OTA update please specify ``upload_port`` / To upload SPIFFS image using OTA update please specify ``upload_port`` /
``--upload-port`` as IP address or DNS name (``*.local``). For the details ``--upload-port`` as IP address or mDNS host name (ending with the ``*.local``).
please follow to :ref:`platform_espressif_ota`. For the details please follow to :ref:`platform_espressif_ota`.
By default, will be used default LD Script for the board where is specified By default, will be used default LD Script for the board where is specified
SPIFFS offsets (start, end, page, block). You can override it using SPIFFS offsets (start, end, page, block). You can override it using
@ -88,7 +89,7 @@ There are 2 options:
.. code-block:: bash .. code-block:: bash
platformio run --target upload --upload-port IP_ADDRESS_HERE or DNS_NAME.local platformio run --target upload --upload-port IP_ADDRESS_HERE or mDNS_NAME.local
* Specify ``upload_port`` option in :ref:`projectconf` * Specify ``upload_port`` option in :ref:`projectconf`
@ -96,7 +97,7 @@ There are 2 options:
[env:myenv] [env:myenv]
... ...
upload_port = IP_ADDRESS_HERE or DNS_NAME.local upload_port = IP_ADDRESS_HERE or mDNS_NAME.local
For example, For example,

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -18,8 +18,8 @@ The Project configuration file is named ``platformio.ini``. This is a
`INI-style <http://en.wikipedia.org/wiki/INI_file>`_ file. `INI-style <http://en.wikipedia.org/wiki/INI_file>`_ file.
``platformio.ini`` has sections (each denoted by a ``[header]``) and ``platformio.ini`` has sections (each denoted by a ``[header]``) and
key / value pairs within the sections. A sign ``#`` at the beginning of the key / value pairs within the sections. Lines beginning with ``#`` or ``;``
line indicates a comment. Comment lines are ignored. are ignored and may be used to provide comments.
The sections and their allowable values are described below. The sections and their allowable values are described below.
@ -81,7 +81,8 @@ This option can be overridden by global environment variable
A path to project's source directory. PlatformIO uses it for :ref:`cmd_run` A path to project's source directory. PlatformIO uses it for :ref:`cmd_run`
command. command.
A default value is ``%project_dir%/src``. A default value is ``src`` which means that folder is located in the root of
project.
This option can be overridden by global environment variable This option can be overridden by global environment variable
:envvar:`PLATFORMIO_SRC_DIR`. :envvar:`PLATFORMIO_SRC_DIR`.
@ -105,7 +106,8 @@ fast!
then PlatformIO will remove this folder automatically. It will be created on the then PlatformIO will remove this folder automatically. It will be created on the
next build operation. next build operation.
A default value is ``%project_dir%/.pioenvs``. A default value is ``.pioenvs`` which means that folder is located in the root of
project.
This option can be overridden by global environment variable This option can be overridden by global environment variable
:envvar:`PLATFORMIO_ENVS_DIR`. :envvar:`PLATFORMIO_ENVS_DIR`.
@ -122,7 +124,8 @@ This option can be overridden by global environment variable
Data directory to store contents and :ref:`platform_espressif_uploadfs`. Data directory to store contents and :ref:`platform_espressif_uploadfs`.
A default value is ``%project_dir%/data``. A default value is ``data`` which means that folder is located in the root of
project.
This option can be overridden by global environment variable This option can be overridden by global environment variable
:envvar:`PLATFORMIO_DATA_DIR`. :envvar:`PLATFORMIO_DATA_DIR`.

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -21,23 +21,45 @@ Usage
.. code-block:: bash .. code-block:: bash
# Print all available pre-configured embedded boards platformio boards [OPTIONS] [FILTER]
platformio boards
# Filter boards by "Query"
platformio boards QUERY
Description Description
----------- -----------
List pre-configured Embedded Boards List pre-configured Embedded Boards
Options
~~~~~~~
.. program:: platformio boards
.. option::
--json-output
Return the output in `JSON <http://en.wikipedia.org/wiki/JSON>`_ format
Examples Examples
-------- --------
1. Show Arduino-based boards 1. Show all available pre-configured embedded boards
.. code-block:: bash
$ platformio boards
Platform: atmelavr
---------------------------------------------------------------------------
Type MCU Frequency Flash RAM Name
---------------------------------------------------------------------------
btatmega168 atmega168 16Mhz 14Kb 1Kb Arduino BT ATmega168
btatmega328 atmega328p 16Mhz 28Kb 2Kb Arduino BT ATmega328
diecimilaatmega168 atmega168 16Mhz 14Kb 1Kb Arduino Duemilanove or Diecimila ATmega168
diecimilaatmega328 atmega328p 16Mhz 30Kb 2Kb Arduino Duemilanove or Diecimila ATmega328
esplora atmega32u4 16Mhz 28Kb 2Kb Arduino Esplora
ethernet atmega328p 16Mhz 31Kb 2Kb Arduino Ethernet
...
2. Filter Arduino-based boards
.. code-block:: bash .. code-block:: bash
@ -56,7 +78,7 @@ Examples
... ...
2. Show mbed-enabled boards 3. Filter mbed-enabled boards
.. code-block:: bash .. code-block:: bash
@ -95,7 +117,7 @@ Examples
nucleo_f030r8 stm32f030r8t6 48Mhz 64Kb 8Kb ST Nucleo F030R8 nucleo_f030r8 stm32f030r8t6 48Mhz 64Kb 8Kb ST Nucleo F030R8
... ...
3. Show boards which are based on ``ATmega168`` MCU 4. Filter boards which are based on ``ATmega168`` MCU
.. code-block:: bash .. code-block:: bash
@ -116,7 +138,7 @@ Examples
168pa16m atmega168p 16Mhz 15Kb 1Kb Microduino Core (Atmega168PA@16M,5V) 168pa16m atmega168p 16Mhz 15Kb 1Kb Microduino Core (Atmega168PA@16M,5V)
168pa8m atmega168p 8Mhz 15Kb 1Kb Microduino Core (Atmega168PA@8M,3.3V) 168pa8m atmega168p 8Mhz 15Kb 1Kb Microduino Core (Atmega168PA@8M,3.3V)
4. Show boards by :ref:`platform_timsp430` 5. Show boards by :ref:`platform_timsp430`
.. code-block:: bash .. code-block:: bash
@ -133,4 +155,3 @@ Examples
lpmsp430g2231 msp430g2231 1Mhz 2Kb 128B LaunchPad w/ msp430g2231 (1MHz) lpmsp430g2231 msp430g2231 1Mhz 2Kb 128B LaunchPad w/ msp430g2231 (1MHz)
lpmsp430g2452 msp430g2452 16Mhz 8Kb 256B LaunchPad w/ msp430g2452 (16MHz) lpmsp430g2452 msp430g2452 16Mhz 8Kb 256B LaunchPad w/ msp430g2452 (16MHz)
lpmsp430g2553 msp430g2553 16Mhz 16Kb 512B LaunchPad w/ msp430g2553 (16MHz) lpmsp430g2553 msp430g2553 16Mhz 16Kb 512B LaunchPad w/ msp430g2553 (16MHz)

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -113,12 +113,19 @@ Can PlatformIO communicate with you via prompts?
:Default: Yes :Default: Yes
:Values: Yes/No :Values: Yes/No
Share diagnostics and usage information (PlatformIO fatal errors/exceptions, Share diagnostics and usage information to help us make PlatformIO better:
platforms, boards, frameworks, commands) to help us make PlatformIO better.
The `source code for telemetry service <https://github.com/platformio/platformio/blob/develop/platformio/telemetry.py>`_ * PlatformIO errors/exceptions
is open source. You can make sure that we DO NOT share PRIVATE information or * The name of used platforms, boards, frameworks (for example, "espressif", "arduino", "uno", etc.)
source code of your project. All information shares anonymously. Thanks a lot * The name of commands (for example, "run", "lib list", etc.)
that live this setting enabled. * The type of IDE (for example, "atom", "eclipse", etc.)
This gives us a sense of what parts of the PlatformIO is most important.
The source code of telemetry service is `open source <https://github.com/platformio/platformio/blob/develop/platformio/telemetry.py>`_. You can make sure that we DO NOT share PRIVATE information or
source code of your project. All information shares anonymously.
Thanks a lot that keep this setting enabled.
.. note:: .. note::

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -14,7 +14,7 @@
# < http://docs.platformio.org/en/latest/userguide/cmd_ci.html > # < http://docs.platformio.org/en/latest/userguide/cmd_ci.html >
# #
# #
# Please choice one of the following templates (proposed below) and uncomment # Please choose one of the following templates (proposed below) and uncomment
# it (remove "# " before each line) or use own configuration according to the # it (remove "# " before each line) or use own configuration according to the
# Travis CI documentation (see above). # Travis CI documentation (see above).
# #

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -14,7 +14,7 @@
# < http://docs.platformio.org/en/latest/userguide/cmd_ci.html > # < http://docs.platformio.org/en/latest/userguide/cmd_ci.html >
# #
# #
# Please choice one of the following templates (proposed below) and uncomment # Please choose one of the following templates (proposed below) and uncomment
# it (remove "# " before each line) or use own configuration according to the # it (remove "# " before each line) or use own configuration according to the
# Travis CI documentation (see above). # Travis CI documentation (see above).
# #

View File

@ -1,4 +1,4 @@
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com> .. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at

View File

@ -14,7 +14,7 @@
# < http://docs.platformio.org/en/latest/userguide/cmd_ci.html > # < http://docs.platformio.org/en/latest/userguide/cmd_ci.html >
# #
# #
# Please choice one of the following templates (proposed below) and uncomment # Please choose one of the following templates (proposed below) and uncomment
# it (remove "# " before each line) or use own configuration according to the # it (remove "# " before each line) or use own configuration according to the
# Travis CI documentation (see above). # Travis CI documentation (see above).
# #

Some files were not shown because too many files have changed in this diff Show More