Merge branch 'release/v4.1.0'

* Skip broken examples declaration

* Allow dots in keywords

* Allow "+" in keywords

.appveyor.yml

@@ -0,0 +1,29 @@
+build: off
+
+platform:
+  - x64
+
+environment:
+  matrix:
+    - TOXENV: "py27"
+      PLATFORMIO_BUILD_CACHE_DIR: C:\Temp\PIO_Build_Cache_P2_{build}
+
+    - TOXENV: "py36"
+      PLATFORMIO_BUILD_CACHE_DIR: C:\Temp\PIO_Build_Cache_P3_{build}
+
+install:
+  - cmd: git submodule update --init --recursive
+  - cmd: SET PATH=C:\MinGW\bin;%PATH%
+  - cmd: SET PLATFORMIO_CORE_DIR=C:\.pio
+  - cmd: pip install --force-reinstall tox
+
+test_script:
+  - cmd: tox
+
+notifications:
+  - provider: Slack
+    incoming_webhook:
+      secure: E9H0SU0Ju7WLDvgxsV8cs3J62T3nTTX7QkEjsczN0Sto/c9hWkVfhc5gGWUkxhlD975cokHByKGJIdwYwCewqOI+7BrcT8U+nlga4Uau7J8=
+    on_build_success: false
+    on_build_failure: true
+    on_build_status_changed: true

.coveragerc

@@ -0,0 +1,21 @@
+# Copyright (c) 2014-present PlatformIO <contact@platformio.org>
+#
+# 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.
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    pragma: no cover
+    def __repr__
+    raise AssertionError
+    raise NotImplementedError

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: https://platformio.org/donate

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,64 @@
+What kind of issue is this?
+
+- [ ] **Question**.
+      This issue tracker is not the place for questions. If you want to ask how to do something,
+      or to understand why something isn't working the way you expect it to, 
+      use [Community Forums](https://community.platformio.org) or [Premium Support](https://platformio.org/support)
+
+- [ ] **PlatformIO IDE**.
+      All issues related to PlatformIO IDE should be reported to appropriate repository:
+      [PlatformIO IDE for Atom](https://github.com/platformio/platformio-atom-ide/issues) or
+      [PlatformIO IDE for VSCode](https://github.com/platformio/platformio-vscode-ide/issues)
+
+- [ ] **Development Platform or Board**.
+      All issues (building, uploading, adding new boards, etc.) related to PlatformIO development platforms
+      should be reported to appropriate repository related to your hardware
+      https://github.com/topics/platformio-platform
+
+- [ ] **Feature Request**.
+      Start by telling us what problem you’re trying to solve. Often a solution
+      already exists! Don’t send pull requests to implement new features without first getting our
+      support. Sometimes we leave features out on purpose to keep the project small.
+
+- [ ] **PlatformIO Core**.
+      If you’ve found a bug, please provide an information below.
+
+
+*You can erase any parts of this template not applicable to your Issue.*
+
+------------------------------------------------------------------
+
+### Configuration
+
+**Operating system**:
+
+**PlatformIO Version** (`platformio --version`):
+
+### Description of problem
+
+
+#### Steps to Reproduce
+
+1.
+2.
+3.
+
+### Actual Results
+
+
+### Expected Results
+
+
+### If problems with PlatformIO Build System:
+
+**The content of `platformio.ini`:**
+```ini
+Insert here...
+```
+
+**Source file to reproduce issue:**
+```cpp
+Insert here...
+```
+
+### Additional info

.gitignore

@@ -2,8 +2,11 @@
 *.pyc
 .pioenvs
 .tox
-.sconsign.dblite
-examples/ide-eclipse/.metadata
-examples/ide-eclipse/RemoteSystemsTempFiles
 docs/_build
 dist
+build
+.cache
+coverage.xml
+.coverage
+htmlcov
+.pytest_cache

.gitmodules

@@ -1,6 +1,7 @@
-[submodule "examples/atmelavr-and-arduino/arduino-external-libs/lib/Adafruit-PCD8544-Nokia-5110-LCD-library"]
-	path = examples/atmelavr-and-arduino/arduino-external-libs/lib/Adafruit-PCD8544-Nokia-5110-LCD-library
-	url = https://github.com/adafruit/Adafruit-PCD8544-Nokia-5110-LCD-library.git
-[submodule "examples/atmelavr-and-arduino/arduino-external-libs/lib/Adafruit-GFX-Library"]
-	path = examples/atmelavr-and-arduino/arduino-external-libs/lib/Adafruit-GFX-Library
-	url = https://github.com/adafruit/Adafruit-GFX-Library.git
+[submodule "examples"]
+	path = examples
+	url = https://github.com/platformio/platformio-examples.git
+[submodule "docs"]
+	path = docs
+	url = https://github.com/platformio/platformio-docs.git
+	branch = develop

.isort.cfg

@@ -1,3 +1,3 @@
 [settings]
-line_length=79
-known_third_party=click,requests,serial,SCons,pytest,bottle
+line_length=88
+known_third_party=SCons, twisted, autobahn, jsonrpc

.pylintrc

@@ -1,281 +1,15 @@
-[MASTER]
-
-# Specify a configuration file.
-#rcfile=
-
-# Python code to execute, usually for sys.path manipulation such as
-# pygtk.require().
-#init-hook=
-
-# Profiled execution.
-profile=no
-
-# Add files or directories to the blacklist. They should be base names, not
-# paths.
-ignore=CVS
-
-# Pickle collected data for later comparisons.
-persistent=yes
-
-# List of plugins (as comma separated values of python modules names) to load,
-# usually to register additional checkers.
-load-plugins=
-
-
 [MESSAGES CONTROL]
-
-# Enable the message, report, category or checker with the given id(s). You can
-# either give multiple identifier separated by comma (,) or put this option
-# multiple time. See also the "--disable" option for examples.
-#enable=
-
-# Disable the message, report, category or checker with the given id(s). You
-# can either give multiple identifiers separated by comma (,) or put this
-# option multiple times (only on the command line, not in the configuration
-# file where it should appear only once).You can also use "--disable=all" to
-# disable everything first and then reenable specific checks. For example, if
-# you want to run only the similarities checker, you can use "--disable=all
-# --enable=similarities". If you want to run only the classes checker, but have
-# no Warning level messages displayed, use"--disable=all --enable=classes
-# --disable=W"
-disable=C0103,C0111,E0611,F0401,I0011,R0801,R0903,R0922
-
-
-[REPORTS]
-
-# Set the output format. Available formats are text, parseable, colorized, msvs
-# (visual studio) and html. You can also give a reporter class, eg
-# mypackage.mymodule.MyReporterClass.
-output-format=text
-
-# Put messages in a separate file for each module / package specified on the
-# command line instead of printing them on stdout. Reports (if any) will be
-# written in a file name "pylint_global.[txt|html]".
-files-output=no
-
-# Tells whether to display a full report or only the messages
-reports=yes
-
-# Python expression which should return a note less than 10 (10 is the highest
-# note). You have access to the variables errors warning, statement which
-# respectively contain the number of errors / warnings messages and the total
-# number of statements analyzed. This is used by the global evaluation report
-# (RP0004).
-evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-
-# Add a comment according to your evaluation note. This is used by the global
-# evaluation report (RP0004).
-comment=no
-
-# Template used to display messages. This is a python new-style format string
-# used to format the message information. See doc for all details
-#msg-template=
-msg-template={path}:{line}: [{msg_id}({symbol}), {obj}] {msg}
-
-
-[BASIC]
-
-# Required attributes for module, separated by a comma
-required-attributes=
-
-# List of builtins function names that should not be used, separated by a comma
-bad-functions=map,filter,apply,input
-
-# Regular expression which should only match correct module names
-module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
-# Regular expression which should only match correct module level names
-const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
-# Regular expression which should only match correct class names
-class-rgx=[A-Z_][a-zA-Z0-9]+$
-
-# Regular expression which should only match correct function names
-function-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct method names
-method-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct instance attribute names
-attr-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct argument names
-argument-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct variable names
-variable-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct attribute names in class
-# bodies
-class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
-# Regular expression which should only match correct list comprehension /
-# generator expression variable names
-inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
-
-# Good variable names which should always be accepted, separated by a comma
-good-names=i,j,k,ex,Run,_
-
-# Bad variable names which should always be refused, separated by a comma
-bad-names=foo,bar,baz,toto,tutu,tata
-
-# Regular expression which should only match function or class names that do
-# not require a docstring.
-no-docstring-rgx=__.*__
-
-# Minimum line length for functions/classes that require docstrings, shorter
-# ones are exempt.
-docstring-min-length=-1
-
-
-[FORMAT]
-
-# Maximum number of characters on a single line.
-max-line-length=80
-
-# Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )?<?https?://\S+>?$
-
-# Allow the body of an if to be on the same line as the test if there is no
-# else.
-single-line-if-stmt=no
-
-# List of optional constructs for which whitespace checking is disabled
-no-space-check=trailing-comma,dict-separator
-
-# Maximum number of lines in a module
-max-module-lines=1000
-
-# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
-# tab).
-indent-string='    '
-
-
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
-
-
-[SIMILARITIES]
-
-# Minimum lines number of a similarity.
-min-similarity-lines=4
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-# Ignore imports when computing similarities.
-ignore-imports=no
-
-
-[TYPECHECK]
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# mixin class is detected if its name ends with "mixin" (case insensitive).
-ignore-mixin-members=yes
-
-# List of classes names for which member attributes should not be checked
-# (useful for classes with attributes dynamically set).
-ignored-classes=SQLObject
-
-# When zope mode is activated, add a predefined set of Zope acquired attributes
-# to generated-members.
-zope=no
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E0201 when accessed. Python regular
-# expressions are accepted.
-generated-members=REQUEST,acl_users,aq_parent
-
-
-[VARIABLES]
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
-
-# A regular expression matching the beginning of the name of dummy variables
-# (i.e. not used).
-dummy-variables-rgx=_$|dummy
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid to define new builtins when possible.
-additional-builtins=
-
-
-[CLASSES]
-
-# List of interface methods to ignore, separated by a comma. This is used for
-# instance to not check methods defines in Zope's Interface base class.
-ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,__new__,setUp
-
-# List of valid names for the first argument in a class method.
-valid-classmethod-first-arg=cls
-
-# List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=mcs
-
-
-[DESIGN]
-
-# Maximum number of arguments for function / method
-max-args=5
-
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore
-ignored-argument-names=_.*
-
-# Maximum number of locals for function / method body
-max-locals=15
-
-# Maximum number of return / yield for function / method body
-max-returns=6
-
-# Maximum number of branch for function / method body
-max-branches=12
-
-# Maximum number of statements in function / method body
-max-statements=50
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of attributes for a class (see R0902).
-max-attributes=7
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=2
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-
-[IMPORTS]
-
-# Deprecated modules which should not be used, separated by a comma
-deprecated-modules=regsub,TERMIOS,Bastion,rexec
-
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled)
-import-graph=
-
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled)
-ext-import-graph=
-
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled)
-int-import-graph=
-
-
-[EXCEPTIONS]
-
-# Exceptions that will emit a warning when being caught. Defaults to
-# "Exception"
-overgeneral-exceptions=Exception
+disable=
+    bad-continuation,
+    bad-whitespace,
+    missing-docstring,
+    ungrouped-imports,
+    invalid-name,
+    cyclic-import,
+    duplicate-code,
+    superfluous-parens,
+    too-few-public-methods,
+    useless-object-inheritance,
+    useless-import-alias,
+    fixme,
+    bad-option-value

.readthedocs.yml

@@ -0,0 +1,12 @@
+# See https://docs.readthedocs.io/en/stable/config-file/index.html
+
+version: 2
+
+sphinx:
+  configuration: docs/conf.py
+
+formats:
+  - pdf
+
+submodules:
+  include: all

.style.yapf

@@ -0,0 +1,3 @@
+[style]
+blank_line_before_nested_class_or_def = true
+allow_multiline_lambdas = true

.travis.yml

@@ -1,19 +1,39 @@
-cache:
-    directories:
-        - $HOME/.platformio
-
 language: python
-python:
-    - "2.7"
 
-env:
-    - TOX_ENV=docs
-    - TOX_ENV=lint
-    - TOX_ENV=py26
-    - TOX_ENV=py27
+matrix:
+  include:
+    - os: linux
+      sudo: false
+      python: 2.7
+      env: TOX_ENV=docs
+    - os: linux
+      sudo: required
+      python: 2.7
+      env: TOX_ENV=py27 PLATFORMIO_BUILD_CACHE_DIR=$(mktemp -d)
+    - os: linux
+      sudo: required
+      python: 3.6
+      env: TOX_ENV=py36 PLATFORMIO_BUILD_CACHE_DIR=$(mktemp -d)
+    - os: osx
+      language: generic
+      env: TOX_ENV=skipexamples
 
 install:
-    - pip install tox
+  - git submodule update --init --recursive
+  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then curl -fsSL https://bootstrap.pypa.io/get-pip.py | sudo python; fi
+  - pip install -U tox
+
+  # ChipKIT issue: install 32-bit support for GCC PIC32
+  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get install libc6-i386; fi
 
 script:
-    - tox -e $TOX_ENV
+  - tox -e $TOX_ENV
+
+notifications:
+  email: false
+
+  slack:
+    rooms:
+      secure: JD6VGfN4+SLU2CwDdiIOr1VgwD+zbYUCE/srwyGuHavnjIkPItkl6T6Bn8Y4VrU6ysbuKotfdV2TAJJ82ivFbY8BvZBc7FBcYp/AGQ4FaCCV5ySv8RDAcQgdE12oaGzMdODiLqsB85f65zOlAFa+htaXyEiRTcotn6Y2hupatrI=
+    on_failure: always
+    on_success: change

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+Contributing
+------------
+
+To get started, <a href="https://www.clahub.com/agreements/platformio/platformio-core">sign the Contributor License Agreement</a>.
+
+1. Fork the repository on GitHub.
+2. Clone repository `git clone --recursive https://github.com/YourGithubUsername/platformio-core.git`
+3. Run `pip install tox`
+4. Go to the root of project where is located `tox.ini` and run `tox -e py27`
+5. Activate current development environment:
+
+   * Windows: `.tox\py27\Scripts\activate`
+   * Bash/ZSH: `source .tox/py27/bin/activate`
+   * Fish: `source .tox/py27/bin/activate.fish`
+
+6. Make changes to code, documentation, etc.
+7. Lint source code `make lint`
+8. Run the tests `make test`
+9. Build documentation `tox -e docs` (creates a directory _build under docs where you can find the html)
+10. Commit changes to your forked repository
+11. Submit a Pull Request on GitHub.

LICENSE

@@ -1,21 +1,174 @@
-The MIT License (MIT)
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
 
-Copyright (c) 2014-2015 Ivan Kravets
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+1. Definitions.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+  Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+  stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+  that You distribute, all copyright, patent, trademark, and
+  attribution notices from the Source form of the Work,
+  excluding those notices that do not pertain to any part of
+  the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+  distribution, then any Derivative Works that You distribute must
+  include a readable copy of the attribution notices contained
+  within such NOTICE file, excluding those notices that do not
+  pertain to any part of the Derivative Works, in at least one
+  of the following places: within a NOTICE text file distributed
+  as part of the Derivative Works; within the Source form or
+  documentation, if provided along with the Derivative Works; or,
+  within a display generated by the Derivative Works, if and
+  wherever such third-party notices normally appear. The contents
+  of the NOTICE file are for informational purposes only and
+  do not modify the License. You may add Your own attribution
+  notices within Derivative Works that You distribute, alongside
+  or as an addendum to the NOTICE text from the Work, provided
+  that such additional attribution notices cannot be construed
+  as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.

Makefile

@@ -0,0 +1,34 @@
+lint:
+	pylint --rcfile=./.pylintrc ./platformio
+
+isort:
+	isort -rc ./platformio
+	isort -rc ./tests
+
+black:
+	black --target-version py27 ./platformio
+	black --target-version py27 ./tests
+
+test:
+	py.test --verbose --capture=no --exitfirst -n 3 --dist=loadscope tests --ignore tests/test_examples.py
+
+before-commit: isort black lint test
+
+clean-docs:
+	rm -rf docs/_build
+
+clean: clean-docs
+	find . -name \*.pyc -delete
+	find . -name __pycache__ -delete
+	rm -rf .cache
+	rm -rf build
+	rm -rf htmlcov
+	rm -f .coverage
+
+profile:
+	# Usage $ > make PIOARGS="boards" profile
+	python -m cProfile -o .tox/.tmp/cprofile.prof $(shell which platformio) ${PIOARGS}
+	snakeviz .tox/.tmp/cprofile.prof
+
+publish:
+	python setup.py sdist upload

README.rst

@@ -1,158 +1,150 @@
 PlatformIO
 ==========
 
-.. image:: https://travis-ci.org/platformio/platformio.svg?branch=develop
-    :target: https://travis-ci.org/platformio/platformio
+.. image:: https://travis-ci.org/platformio/platformio-core.svg?branch=develop
+    :target: https://travis-ci.org/platformio/platformio-core
     :alt: Travis.CI Build Status
-.. image:: https://ci.appveyor.com/api/projects/status/dku0h2rutfj0ctls/branch/develop?svg=true
-    :target: https://ci.appveyor.com/project/ivankravets/platformio
+.. image:: https://ci.appveyor.com/api/projects/status/unnpw0n3c5k14btn/branch/develop?svg=true
+    :target: https://ci.appveyor.com/project/ivankravets/platformio-core
     :alt: AppVeyor.CI Build Status
-.. image:: https://gemnasium.com/platformio/platformio.png
-    :target: https://gemnasium.com/platformio/platformio
-    :alt: Dependency Status
-.. image:: https://pypip.in/version/platformio/badge.png?style=flat
+.. image:: https://img.shields.io/pypi/v/platformio.svg
     :target: https://pypi.python.org/pypi/platformio/
     :alt: Latest Version
-.. image:: https://pypip.in/download/platformio/badge.png?style=flat
-    :target: https://pypi.python.org/pypi/platformio/
-    :alt: Downloads
-.. image:: https://pypip.in/license/platformio/badge.png?style=flat
+.. image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg
     :target: https://pypi.python.org/pypi/platformio/
     :alt:  License
-.. image:: https://badges.gitter.im/Join%20Chat.svg
-   :alt: Join the chat at https://gitter.im/platformio/platformio
-   :target: https://gitter.im/platformio/platformio
+.. image:: https://img.shields.io/badge/PlatformIO-Community-orange.svg
+   :alt: Community Forums
+   :target: https://community.platformio.org?utm_source=github&utm_medium=core
 
-`Website + Library Search <http://platformio.org>`_ |
-`Documentation <http://docs.platformio.org>`_ |
-`Project Examples <https://github.com/platformio/platformio/tree/develop/examples>`_ |
-`Blog <http://www.ikravets.com/category/computer-life/platformio>`_ |
-`Reddit <http://www.reddit.com/r/platformio/>`_ |
-`Twitter <https://twitter.com/PlatformIO_Org>`_
+**Quick Links:** `Web <https://platformio.org?utm_source=github&utm_medium=core>`_ |
+`PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=github&utm_medium=core>`_ |
+`Project Examples <https://github.com/platformio/platformio-examples/>`__ |
+`Docs <https://docs.platformio.org?utm_source=github&utm_medium=core>`_ |
+`Donate <https://platformio.org/donate?utm_source=github&utm_medium=core>`_ |
+`Contact Us <https://platformio.org/contact?utm_source=github&utm_medium=core>`_
 
-*Atmel AVR & SAM, Espressif, Freescale Kinetis, Nordic nRF51, NXP LPC,
-ST STM32, TI MSP430 & Tiva, Teensy, Arduino, mbed, libOpenCM3, etc.*
+**Social:** `Twitter <https://twitter.com/PlatformIO_Org>`_ |
+`LinkedIn <https://www.linkedin.com/company/platformio/>`_ |
+`Facebook <https://www.facebook.com/platformio>`_ |
+`Hackaday <https://hackaday.io/project/7980-platformio>`_ |
+`Bintray <https://bintray.com/platformio>`_ |
+`Community <https://community.platformio.org?utm_source=github&utm_medium=core>`_
 
-.. image:: https://raw.githubusercontent.com/platformio/platformio/develop/docs/_static/platformio-logo.png
-    :target: http://platformio.org
+.. image:: https://raw.githubusercontent.com/platformio/platformio-web/develop/app/images/platformio-ide-laptop.png
+    :target: https://platformio.org?utm_source=github&utm_medium=core
 
-`PlatformIO <http://platformio.org>`_ is a cross-platform code builder
-and the missing library manager.
+`PlatformIO <https://platformio.org?utm_source=github&utm_medium=core>`_ an open source ecosystem for embedded development
 
-* `Get Started <http://platformio.org/#!/get-started>`_
-* `Web 2.0 Library Search <http://platformio.org/#!/lib>`_
-* `Development Platforms <http://platformio.org/#!/platforms>`_
-* `Frameworks <http://platformio.org/#!/frameworks>`_
-* `Embedded Boards Explorer <http://platformio.org/#!/boards>`_
-* `Library Manager <http://docs.platformio.org/en/latest/librarymanager/index.html>`_
-* `User Guide <http://docs.platformio.org/en/latest/userguide/index.html>`_
-* `Continuous Integration <http://docs.platformio.org/en/latest/ci/index.html>`_
-* `IDE Integration <http://docs.platformio.org/en/latest/ide.html>`_
-* `Articles about us <http://docs.platformio.org/en/latest/articles.html>`_
-* `FAQ <http://docs.platformio.org/en/latest/faq.html>`_
-* `Release History <http://docs.platformio.org/en/latest/history.html>`_
+* **Cross-platform IDE** and **Unified Debugger**
+* **Static Code Analyzer** and **Remote Unit Testing**
+* **Multi-platform** and **Multi-architecture Build System**
+* **Firmware File Explorer** and **Memory Inspection**.
 
-You have **no need** to install any *IDE* or compile any tool chains. *PlatformIO*
-has pre-built different development platforms and pre-configured settings for
-the most popular embedded boards. For further details, please
-refer to `What is PlatformIO? <http://docs.platformio.org/en/latest/faq.html#what-is-platformio>`_
+Get Started
+-----------
 
-Use whenever. *Run everywhere.*
--------------------------------
-*PlatformIO* is written in pure *Python* and **doesn't depend** on any
-additional libraries/tools from an operation system. It allows you to use
-*PlatformIO* beginning from *PC (Mac, Linux, Win)* and ending with credit-card
-sized computers (`Raspberry Pi <http://www.raspberrypi.org>`_,
-`BeagleBone <http://beagleboard.org>`_,
-`CubieBoard <http://cubieboard.org>`_).
+* `What is PlatformIO? <https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=core>`_
 
-Embedded Development. *Easier Than Ever.*
------------------------------------------
-*PlatformIO* is well suited for embedded development and has pre-configured
-settings for most popular `Embedded Boards <http://platformio.org/#!/boards>`_.
+Instruments
+-----------
 
-* Colourful `command-line output <https://raw.githubusercontent.com/platformio/platformio/develop/examples/platformio-examples.png>`_
-* Built-in `Serial Port Monitor <http://docs.platformio.org/en/latest/userguide/cmd_serialports.html#platformio-serialports-monitor>`_
-* Configurable `build -flags/-options <http://docs.platformio.org/en/latest/projectconf.html#build-flags>`_
-* Automatic **firmware uploading**
-* Integration with `development environments (IDE) <http://docs.platformio.org/en/latest/ide.html>`_
-* Ready for **Cloud Compiling** and `Continuous Integration <http://docs.platformio.org/en/latest/ci/index.html>`_
-* Pre-built tool chains, frameworks for the popular `Hardware Platforms <http://platformio.org/#!/platforms>`_
+* `PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=github&utm_medium=core>`_
+* `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=core>`_
+* `Library Management <https://docs.platformio.org/page/librarymanager/index.html?utm_source=github&utm_medium=core>`_
+* `Project Examples <https://github.com/platformio/platformio-examples?utm_source=github&utm_medium=core>`__
+* `Desktop IDEs Integration <https://docs.platformio.org/page/ide.html?utm_source=github&utm_medium=core>`_
+* `Continuous Integration <https://docs.platformio.org/page/ci/index.html?utm_source=github&utm_medium=core>`_
+* `Advanced Scripting API <https://docs.platformio.org/page/projectconf/advanced_scripting.html?utm_source=github&utm_medium=core>`_
 
-.. image:: https://raw.githubusercontent.com/platformio/platformio-web/develop/app/images/platformio-embedded-development.png
-    :target: http://platformio.org
-    :alt:  PlatformIO Embedded Development Process
+PIO Plus
+--------
 
-The Missing Library Manager. *It's here!*
------------------------------------------
-*PlatformIO Library Manager* is the missing library manager for development
-platforms which allows you to organize and have up-to-date external libraries.
+* `PIO Check <https://docs.platformio.org/page/plus/pio-check.html?utm_source=github&utm_medium=core>`_
+* `PIO Remote <https://docs.platformio.org/page/plus/pio-remote.html?utm_source=github&utm_medium=core>`_
+* `PIO Unified Debugger <https://docs.platformio.org/page/plus/debugging.html?utm_source=github&utm_medium=core>`_
+* `PIO Unit Testing <https://docs.platformio.org/en/latest/plus/unit-testing.html?utm_source=github&utm_medium=core>`_
 
-* Friendly `Command-Line Interface <http://docs.platformio.org/en/latest/librarymanager/index.html>`_
-* Modern `Web 2.0 Library Search <http://platformio.org/#!/lib>`_
-* Open Source `Library Registry API <https://github.com/platformio/platformio-api>`_
-* Library Crawler based on `library.json <http://docs.platformio.org/en/latest/librarymanager/config.html>`_
-  specification
-* Library **dependency management**
-* Automatic library updating
+Registry
+--------
 
-.. image:: https://raw.githubusercontent.com/platformio/platformio-web/develop/app/images/platformio-library-manager.png
-    :target: http://platformio.org
-    :alt:  PlatformIO Library Manager Architecture
+* `Libraries <https://platformio.org/lib?utm_source=github&utm_medium=core>`_
+* `Development Platforms <https://platformio.org/platforms?utm_source=github&utm_medium=core>`_
+* `Frameworks <https://platformio.org/frameworks?utm_source=github&utm_medium=core>`_
+* `Embedded Boards <https://platformio.org/boards?utm_source=github&utm_medium=core>`_
 
-Smart Code Builder. *Fast and Reliable.*
-----------------------------------------
-*PlatformIO Code Builder* is built-on a next-generation software construction
-tool named `SCons <http://www.scons.org/>`_. Think of *SCons* as an improved,
-cross-platform substitute for the classic *Make* utility.
+Development Platforms
+---------------------
 
-* Reliable, automatic *dependency analysis*
-* Reliable detection of *build changes*
-* Improved support for *parallel builds*
-* Ability to share *built files in a cache*
-* Lookup for external libraries which are installed via `Library Manager <http://docs.platformio.org/en/latest/librarymanager/index.html>`_
+* `Aceinna IMU <https://platformio.org/platforms/aceinna_imu?utm_source=github&utm_medium=core>`_
+* `Atmel AVR <https://platformio.org/platforms/atmelavr?utm_source=github&utm_medium=core>`_
+* `Atmel SAM <https://platformio.org/platforms/atmelsam?utm_source=github&utm_medium=core>`_
+* `Espressif 32 <https://platformio.org/platforms/espressif32?utm_source=github&utm_medium=core>`_
+* `Espressif 8266 <https://platformio.org/platforms/espressif8266?utm_source=github&utm_medium=core>`_
+* `Freescale Kinetis <https://platformio.org/platforms/freescalekinetis?utm_source=github&utm_medium=core>`_
+* `Infineon XMC <https://platformio.org/platforms/infineonxmc?utm_source=github&utm_medium=core>`_
+* `Intel ARC32 <https://platformio.org/platforms/intel_arc32?utm_source=github&utm_medium=core>`_
+* `Intel MCS-51 (8051) <https://platformio.org/platforms/intel_mcs51?utm_source=github&utm_medium=core>`_
+* `Kendryte K210 <https://platformio.org/platforms/kendryte210?utm_source=github&utm_medium=core>`_
+* `Lattice iCE40 <https://platformio.org/platforms/lattice_ice40?utm_source=github&utm_medium=core>`_
+* `Maxim 32 <https://platformio.org/platforms/maxim32?utm_source=github&utm_medium=core>`_
+* `Microchip PIC32 <https://platformio.org/platforms/microchippic32?utm_source=github&utm_medium=core>`_
+* `Nordic nRF51 <https://platformio.org/platforms/nordicnrf51?utm_source=github&utm_medium=core>`_
+* `Nordic nRF52 <https://platformio.org/platforms/nordicnrf52?utm_source=github&utm_medium=core>`_
+* `NXP LPC <https://platformio.org/platforms/nxplpc?utm_source=github&utm_medium=core>`_
+* `RISC-V <https://platformio.org/platforms/riscv?utm_source=github&utm_medium=core>`_
+* `RISC-V GAP <https://platformio.org/platforms/riscv_gap?utm_source=github&utm_medium=core>`_
+* `Samsung ARTIK <https://platformio.org/platforms/samsung_artik?utm_source=github&utm_medium=core>`_
+* `Shakti <https://platformio.org/platforms/shakti?utm_source=github&utm_medium=core>`_
+* `Silicon Labs EFM32 <https://platformio.org/platforms/siliconlabsefm32?utm_source=github&utm_medium=core>`_
+* `ST STM32 <https://platformio.org/platforms/ststm32?utm_source=github&utm_medium=core>`_
+* `ST STM8 <https://platformio.org/platforms/ststm8?utm_source=github&utm_medium=core>`_
+* `Teensy <https://platformio.org/platforms/teensy?utm_source=github&utm_medium=core>`_
+* `TI MSP430 <https://platformio.org/platforms/timsp430?utm_source=github&utm_medium=core>`_
+* `TI Tiva <https://platformio.org/platforms/titiva?utm_source=github&utm_medium=core>`_
+* `WIZNet W7500 <https://platformio.org/platforms/wiznet7500?utm_source=github&utm_medium=core>`_
 
-.. image:: https://raw.githubusercontent.com/platformio/platformio-web/develop/app/images/platformio-scons-builder.png
-    :target: http://platformio.org
-    :alt:  PlatformIO Code Builder Architecture
+Frameworks
+----------
 
-Single source code. *Multiple platforms.*
------------------------------------------
-*PlatformIO* allows developer to compile the same code with different
-development platforms using the *Only One Command*
-`platformio run <http://docs.platformio.org/en/latest/userguide/cmd_run.html>`_.
-This happens due to
-`Project Configuration File (platformio.ini) <http://docs.platformio.org/en/latest/projectconf.html>`_
-where you can setup different environments with specific options (platform
-type, firmware uploading settings, pre-built framework, build flags and many
-more).
+* `Arduino <https://platformio.org/frameworks/arduino?utm_source=github&utm_medium=core>`_
+* `ARTIK SDK <https://platformio.org/frameworks/artik-sdk?utm_source=github&utm_medium=core>`_
+* `CMSIS <https://platformio.org/frameworks/cmsis?utm_source=github&utm_medium=core>`_
+* `Energia <https://platformio.org/frameworks/energia?utm_source=github&utm_medium=core>`_
+* `ESP-IDF <https://platformio.org/frameworks/espidf?utm_source=github&utm_medium=core>`_
+* `ESP8266 Non-OS SDK <https://platformio.org/frameworks/esp8266-nonos-sdk?utm_source=github&utm_medium=core>`_
+* `ESP8266 RTOS SDK <https://platformio.org/frameworks/esp8266-rtos-sdk?utm_source=github&utm_medium=core>`_
+* `Freedom E SDK <https://platformio.org/frameworks/freedom-e-sdk?utm_source=github&utm_medium=core>`_
+* `Kendryte Standalone SDK <https://platformio.org/frameworks/kendryte-standalone-sdk?utm_source=github&utm_medium=core>`_
+* `libOpenCM3 <https://platformio.org/frameworks/libopencm3?utm_source=github&utm_medium=core>`_
+* `mbed <https://platformio.org/frameworks/mbed?utm_source=github&utm_medium=core>`_
+* `PULP OS <https://platformio.org/frameworks/pulp-os?utm_source=github&utm_medium=core>`_
+* `Pumbaa <https://platformio.org/frameworks/pumbaa?utm_source=github&utm_medium=core>`_
+* `Shakti <https://platformio.org/frameworks/shakti?utm_source=github&utm_medium=core>`_
+* `Simba <https://platformio.org/frameworks/simba?utm_source=github&utm_medium=core>`_
+* `SPL <https://platformio.org/frameworks/spl?utm_source=github&utm_medium=core>`_
+* `STM32Cube <https://platformio.org/frameworks/stm32cube?utm_source=github&utm_medium=core>`_
+* `Tizen RT <https://platformio.org/frameworks/tizenrt?utm_source=github&utm_medium=core>`_
+* `WiringPi <https://platformio.org/frameworks/wiringpi?utm_source=github&utm_medium=core>`_
 
-It has support for the most popular embedded platforms:
+Contributing
+------------
 
-* `Atmel AVR <http://platformio.org/#!/platforms/atmelavr>`_
-* `Atmel SAM <http://platformio.org/#!/platforms/atmelsam>`_
-* `Espressif <http://platformio.org/#!/platforms/espressif>`_
-* `Freescale Kinetis <http://platformio.org/#!/platforms/freescalekinetis>`_
-* `Nordic nRF51 <http://platformio.org/#!/platforms/nordicnrf51>`_
-* `NXP LPC <http://platformio.org/#!/platforms/nxplpc>`_
-* `ST STM32 <http://platformio.org/#!/platforms/ststm32>`_
-* `Teensy <http://platformio.org/#!/platforms/teensy>`_
-* `TI MSP430 <http://platformio.org/#!/platforms/timsp430>`_
-* `TI TIVA C <http://platformio.org/#!/platforms/titiva>`_
+See `contributing guidelines <https://github.com/platformio/platformio/blob/develop/CONTRIBUTING.md>`_.
 
-Frameworks:
+Telemetry / Privacy Policy
+--------------------------
 
-* `Arduino <http://platformio.org/#!/frameworks/arduino>`_
-* `CMSIS <http://platformio.org/#!/frameworks/cmsis>`_
-* `libOpenCM3 <http://platformio.org/#!/frameworks/libopencm3>`_
-* `Energia <http://platformio.org/#!/frameworks/energia>`_
-* `SPL <http://platformio.org/#!/frameworks/spl>`_
-* `mbed <http://platformio.org/#!/frameworks/mbed>`_
+Share minimal diagnostics and usage information to help us make PlatformIO better.
+It is enabled by default. For more information see:
 
+* `Telemetry Setting <https://docs.platformio.org/en/latest/userguide/cmd_settings.html?utm_source=github&utm_medium=core#enable-telemetry>`_
+* `SSL Setting <https://docs.platformio.org/en/latest/userguide/cmd_settings.html?utm_source=github&utm_medium=core#strict-ssl>`_
 
-Licence
+License
 -------
 
-Copyright (C) 2014-2015 Ivan Kravets
+Copyright (c) 2014-present PlatformIO <contact@platformio.org>
 
-Licenced under the MIT Licence.
+The PlatformIO is licensed under the permissive Apache 2.0 license,
+so you can use it in both commercial and personal projects with confidence.

appveyor.yml

@@ -1,21 +0,0 @@
-build: off
-environment:
-  global:
-    WITH_COMPILER: "cmd /E:ON /V:ON /C .\\scripts\\appveyor\\run_with_compiler.cmd"
-  matrix:
-    - TOXENV: "py27"
-      TOXPYTHON: "C:\\Python27-x64\\python.exe"
-      WINDOWS_SDK_VERSION: "v7.0"
-      PYTHON_HOME: "C:\\Python27-x64"
-      PYTHON_VERSION: "2.7"
-      PYTHON_ARCH: "64"
-init:
-  - "ECHO %TOXENV%"
-  - ps: "ls C:\\Python*"
-install:
-  - "git submodule update --init --recursive"
-  - "powershell scripts\\appveyor\\install.ps1"
-test_script:
-  - "%PYTHON_HOME%\\Scripts\\tox --version"
-  - "%PYTHON_HOME%\\Scripts\\pip --version"
-  - "%WITH_COMPILER% %PYTHON_HOME%\\Scripts\\tox"

docs/Makefile

@@ -1,177 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-PAPER         =
-BUILDDIR      = _build
-
-# User-friendly check for sphinx-build
-ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
-endif
-
-# Internal variables.
-PAPEROPT_a4     = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
-
-help:
-	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  html       to make standalone HTML files"
-	@echo "  dirhtml    to make HTML files named index.html in directories"
-	@echo "  singlehtml to make a single large HTML file"
-	@echo "  pickle     to make pickle files"
-	@echo "  json       to make JSON files"
-	@echo "  htmlhelp   to make HTML files and a HTML help project"
-	@echo "  qthelp     to make HTML files and a qthelp project"
-	@echo "  devhelp    to make HTML files and a Devhelp project"
-	@echo "  epub       to make an epub"
-	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
-	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
-	@echo "  text       to make text files"
-	@echo "  man        to make manual pages"
-	@echo "  texinfo    to make Texinfo files"
-	@echo "  info       to make Texinfo files and run them through makeinfo"
-	@echo "  gettext    to make PO message catalogs"
-	@echo "  changes    to make an overview of all changed/added/deprecated items"
-	@echo "  xml        to make Docutils-native XML files"
-	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
-	@echo "  linkcheck  to check all external links for integrity"
-	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
-
-clean:
-	rm -rf $(BUILDDIR)/*
-
-html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
-	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
-	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
-	@echo
-	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
-	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
-	@echo
-	@echo "Build finished; now you can process the pickle files."
-
-json:
-	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
-	@echo
-	@echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
-	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
-	@echo
-	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
-	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PlatformIO.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PlatformIO.qhc"
-
-devhelp:
-	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
-	@echo
-	@echo "Build finished."
-	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/PlatformIO"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PlatformIO"
-	@echo "# devhelp"
-
-epub:
-	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
-	@echo
-	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo
-	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-	@echo "Run \`make' in that directory to run these through (pdf)latex" \
-	      "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through pdflatex..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-latexpdfja:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through platex and dvipdfmx..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
-	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
-	@echo
-	@echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
-	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
-	@echo
-	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-texinfo:
-	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
-	@echo
-	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
-	@echo "Run \`make' in that directory to run these through makeinfo" \
-	      "(use \`make info' here to do that automatically)."
-
-info:
-	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
-	@echo "Running Texinfo files through makeinfo..."
-	make -C $(BUILDDIR)/texinfo info
-	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
-
-gettext:
-	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
-	@echo
-	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
-changes:
-	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
-	@echo
-	@echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
-	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
-	@echo
-	@echo "Link check complete; look for any errors in the above output " \
-	      "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
-
-xml:
-	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
-	@echo
-	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
-
-pseudoxml:
-	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
-	@echo
-	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/articles.rst

@@ -1,19 +0,0 @@
-.. _articles:
-
-Articles about us
-=================
-
-.. note::
-	If you've written article about PlatformIO and would like it listed on
-	this page, `please edit this page <https://github.com/platformio/platformio/blob/develop/docs/articles.rst>`_.
-
-Here are recent articles about PlatformIO:
-
-* May 11, 2015 - **IT Hare** - `From Web Developer to Embedded One: Interview with Ivan Kravets, The Guy Behind PlatformIO. Part II <http://ithare.com/from-web-developer-to-embedded-one-interview-with-ivan-kravets-the-guy-behind-platformio-part-ii/>`_
-* May 4, 2015 - **IT Hare** - `From Web Developer to Embedded One: Interview with Ivan Kravets, The Guy Behind PlatformIO. Part I <http://ithare.com/from-web-development-to-embedded-one-interview-with-ivan-kravets-the-guy-behind-platformio-part-i/>`_
-* April 17, 2015 - **Michael Ball** - `PlatformIO - A Cross-Platform Code Builder and Missing Library Manager <http://arduino-pi.blogspot.com.es/2015/04/platformio-cross-platform-code-builder.html>`_
-* March 23, 2015 - **Atmel** - `Cross-board and cross-vendor embedded development with PlatformIO <http://blog.atmel.com/2015/03/23/cross-board-and-cross-vendor-embedded-development-with-platformio/>`_
-* March 22, 2015 - **Mark VandeWettering** - `Discovered a new tool for embedded development: PlatformIO <http://brainwagon.org/2015/03/22/discovered-a-new-tool-for-embedded-development-platformio/>`_
-* October 7, 2014 - **Ivan Kravets** - `Integration of PlatformIO library manager to Arduino and Energia IDEs <http://www.ikravets.com/computer-life/platformio/2014/10/07/integration-of-platformio-library-manager-to-arduino-and-energia-ides>`_
-* June 20, 2014 - **Ivan Kravets** - `Building and debugging Atmel AVR (Arduino-based) project using Eclipse IDE+PlatformIO <http://www.ikravets.com/computer-life/programming/2014/06/20/building-and-debugging-atmel-avr-arduino-based-project-using-eclipse-ideplatformio>`_
-* June 17, 2014 - **Ivan Kravets** - `How was PlatformIO born or why I love Python World <http://www.ikravets.com/computer-life/programming/2014/06/17/how-was-platformio-born-or-why-i-love-python-world>`_

docs/ci/appveyor.rst

@@ -1,213 +0,0 @@
-.. _ci_appveyor:
-
-AppVeyor
-========
-
-`AppVeyor <http://www.appveyor.com/about>`_ is an open-source hosted,
-distributed continuous integration service used to build and test projects
-hosted at `GitHub <http://en.wikipedia.org/wiki/GitHub>`_ on Windows family
-systems.
-
-AppVeyor is configured by adding a file named ``appveyor.yml``, which is a
-`YAML <http://en.wikipedia.org/wiki/YAML>`_ format text file, to the root
-directory of the GitHub repository.
-
-AppVeyor automatically detects when a commit has been made and pushed to a
-GitHub repository that is using AppVeyor, and each time this happens, it will
-try to build the project using :ref:`cmd_ci` command. This includes commits to
-all branches, not just to the master branch. AppVeyor will also build and run
-pull requests. When that process has completed, it will notify a developer in
-the way it has been configured to do so — for example, by sending an email
-containing the build results (showing success or failure), or by posting a
-message on an IRC channel. It can be configured to build project on a range of
-different :ref:`platforms`.
-
-Integration
------------
-
-Put ``appveyor.yml`` to the root directory of the GitHub repository.
-
-.. code-block:: yaml
-
-    build: off
-    environment:
-        global:
-            WITH_COMPILER: "cmd /E:ON /V:ON /C .\\scripts\\appveyor\\run_with_compiler.cmd"
-        matrix:
-            - PLATFORMIO_CI_SRC: "path\\to\\source\\file.c"
-              PLATFORMIO_CI_SRC: "path\\to\\source\\file.ino"
-              PLATFORMIO_CI_SRC: "path\\to\\source\\directory"
-              WINDOWS_SDK_VERSION: "v7.0"
-              PYTHON_HOME: "C:\\Python27-x64"
-              PYTHON_VERSION: "2.7"
-              PYTHON_ARCH: "64"
-        install:
-          - "git submodule update --init --recursive"
-          - "powershell scripts\\appveyor\\install.ps1"
-        before_test:
-          - cmd: SET PATH=%PATH%;%PYTHON_HOME%;%PYTHON_HOME%\Scripts
-        test_script:
-          - '%WITH_COMPILER% %PYTHON_HOME%\\Scripts\\platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N'
-
-
-Then create ``scripts/appveyor`` folder and put these 2 scripts (they are the
-same for the all projects, don't need to modify them):
-
-1. ``scripts/appveyor/install.ps1``:
-
-.. code-block:: PowerShell
-
-    $BASE_URL = "https://www.python.org/ftp/python/"
-    $GET_PIP_URL = "https://bootstrap.pypa.io/get-pip.py"
-    $GET_PIP_PATH = "C:\get-pip.py"
-
-
-    function DownloadPython ($python_version, $platform_suffix) {
-        $webclient = New-Object System.Net.WebClient
-        $filename = "python-" + $python_version + $platform_suffix + ".msi"
-        $url = $BASE_URL + $python_version + "/" + $filename
-
-        $basedir = $pwd.Path + "\"
-        $filepath = $basedir + $filename
-        if (Test-Path $filename) {
-            Write-Host "Reusing" $filepath
-            return $filepath
-        }
-
-        # Download and retry up to 5 times in case of network transient errors.
-        Write-Host "Downloading" $filename "from" $url
-        $retry_attempts = 3
-        for($i=0; $i -lt $retry_attempts; $i++){
-            try {
-                $webclient.DownloadFile($url, $filepath)
-                break
-            }
-            Catch [Exception]{
-                Start-Sleep 1
-            }
-       }
-       Write-Host "File saved at" $filepath
-       return $filepath
-    }
-
-
-    function InstallPython ($python_version, $architecture, $python_home) {
-        Write-Host "Installing Python" $python_version "for" $architecture "bit architecture to" $python_home
-        if (Test-Path $python_home) {
-            Write-Host $python_home "already exists, skipping."
-            return $false
-        }
-        if ($architecture -eq "32") {
-            $platform_suffix = ""
-        } else {
-            $platform_suffix = ".amd64"
-        }
-        $filepath = DownloadPython $python_version $platform_suffix
-        Write-Host "Installing" $filepath "to" $python_home
-        $args = "/qn /i $filepath TARGETDIR=$python_home"
-        Write-Host "msiexec.exe" $args
-        Start-Process -FilePath "msiexec.exe" -ArgumentList $args -Wait -Passthru
-        Write-Host "Python $python_version ($architecture) installation complete"
-        return $true
-    }
-
-
-    function InstallPip ($python_home) {
-        $pip_path = $python_home + "/Scripts/pip.exe"
-        $python_path = $python_home + "/python.exe"
-        if (-not(Test-Path $pip_path)) {
-            Write-Host "Installing pip..."
-            $webclient = New-Object System.Net.WebClient
-            $webclient.DownloadFile($GET_PIP_URL, $GET_PIP_PATH)
-            Write-Host "Executing:" $python_path $GET_PIP_PATH
-            Start-Process -FilePath "$python_path" -ArgumentList "$GET_PIP_PATH" -Wait -Passthru
-        } else {
-            Write-Host "pip already installed."
-        }
-    }
-
-    function InstallPackage ($python_home, $pkg) {
-        $pip_path = $python_home + "/Scripts/pip.exe"
-        & $pip_path install -U $pkg
-    }
-
-    function InstallScons ($python_home) {
-        Write-Host "Start installing Scons"
-        $pip_path = $python_home + "/Scripts/pip.exe"
-        & $pip_path install --egg "http://sourceforge.net/projects/scons/files/latest/download"
-        Write-Host "Scons installed"
-    }
-
-    function main () {
-        InstallPython $env:PYTHON_VERSION $env:PYTHON_ARCH $env:PYTHON_HOME
-        InstallPip $env:PYTHON_HOME
-        InstallPackage $env:PYTHON_HOME setuptools
-        InstallPackage $env:PYTHON_HOME platformio
-        InstallScons $env:PYTHON_HOME
-    }
-
-    main
-
-2. ``scripts/appveyor/run_with_compiler.cmd``:
-
-.. code-block:: guess
-
-    @ECHO OFF
-
-    SET COMMAND_TO_RUN=%*
-    SET WIN_SDK_ROOT=C:\Program Files\Microsoft SDKs\Windows
-
-    SET MAJOR_PYTHON_VERSION="%PYTHON_VERSION:~0,1%"
-    IF %MAJOR_PYTHON_VERSION% == "2" (
-        SET WINDOWS_SDK_VERSION="v7.0"
-    ) ELSE IF %MAJOR_PYTHON_VERSION% == "3" (
-        SET WINDOWS_SDK_VERSION="v7.1"
-    ) ELSE (
-        ECHO Unsupported Python version: "%MAJOR_PYTHON_VERSION%"
-        EXIT 1
-    )
-
-    IF "%PYTHON_ARCH%"=="64" (
-        ECHO Configuring Windows SDK %WINDOWS_SDK_VERSION% for Python %MAJOR_PYTHON_VERSION% on a 64 bit architecture
-        SET DISTUTILS_USE_SDK=1
-        SET MSSdk=1
-        "%WIN_SDK_ROOT%\%WINDOWS_SDK_VERSION%\Setup\WindowsSdkVer.exe" -q -version:%WINDOWS_SDK_VERSION%
-        "%WIN_SDK_ROOT%\%WINDOWS_SDK_VERSION%\Bin\SetEnv.cmd" /x64 /release
-        ECHO Executing: %COMMAND_TO_RUN%
-        call %COMMAND_TO_RUN% || EXIT 1
-    ) ELSE (
-        ECHO Using default MSVC build environment for 32 bit architecture
-        ECHO Executing: %COMMAND_TO_RUN%
-        call %COMMAND_TO_RUN% || EXIT 1
-    )
-
-For more details as for PlatformIO build process please look into :ref:`cmd_ci`
-command.
-
-Examples
---------
-
-1. Integration for `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
-   project. The ``appveyor.yml`` configuration file:
-
-.. code-block:: yaml
-
-    build: off
-    environment:
-        global:
-            WITH_COMPILER: "cmd /E:ON /V:ON /C .\\scripts\\appveyor\\run_with_compiler.cmd"
-        matrix:
-            - PLATFORMIO_CI_SRC: "examples\\Bluetooth\\PS3SPP\\PS3SPP.ino"
-              PLATFORMIO_CI_SRC: "examples\\pl2303\\pl2303_gps\\pl2303_gps.ino"
-              WINDOWS_SDK_VERSION: "v7.0"
-              PYTHON_HOME: "C:\\Python27-x64"
-              PYTHON_VERSION: "2.7"
-              PYTHON_ARCH: "64"
-        install:
-          - "git submodule update --init --recursive"
-          - "powershell scripts\\appveyor\\install.ps1"
-        before_test:
-          - cmd: SET PATH=%PATH%;%PYTHON_HOME%;%PYTHON_HOME%\Scripts
-          - cmd: git clone https://github.com/xxxajk/spi4teensy3.git c:\spi4teensy
-        test_script:
-          - '%WITH_COMPILER% %PYTHON_HOME%\\Scripts\\platformio ci --lib="." --lib="c:\spi4teensy" --board=uno --board=teensy31 --board=due'

docs/ci/circleci.rst

@@ -1,72 +0,0 @@
-.. _ci_circleci:
-
-Circle CI
-=========
-
-`Circle CI <https://circleci.com/about>`_ is a hosted cloud
-platform that provides hosted continuous integration, deployment, and testing
-to `GitHub <http://en.wikipedia.org/wiki/GitHub>`_ repositories.
-
-Circle CI is configured by adding a file named ``circle.yml``, which is a
-`YAML <http://en.wikipedia.org/wiki/YAML>`_ format text file, to the root
-directory of the GitHub repository.
-
-Circle CI automatically detects when a commit has been made and pushed to a
-GitHub repository that is using Circle CI, and each time this happens, it will
-try to build the project using :ref:`cmd_ci` command. This includes commits to
-all branches, not just to the master branch. Circle CI will also build and run
-pull requests. When that process has completed, it will notify a developer in
-the way it has been configured to do so — for example, by sending an email
-containing the build results (showing success or failure), or by posting a
-message on an IRC channel. It can be configured to build project on a range of
-different :ref:`platforms`.
-
-Integration
------------
-
-Put ``circle.yml`` to the root directory of the GitHub repository.
-
-.. code-block:: yaml
-
-    machine:
-        environment:
-            - PLATFORMIO_CI_SRC=path/to/source/file.c
-            - PLATFORMIO_CI_SRC=path/to/source/file.ino
-            - PLATFORMIO_CI_SRC=path/to/source/directory
-
-    dependencies:
-        pre:
-            - sudo apt-get install python2.7-dev
-            - sudo python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
-
-    test:
-        override:
-            - platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
-
-
-For more details as for PlatformIO build process please look into :ref:`cmd_ci`
-command.
-
-Examples
---------
-
-1. Integration for `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
-   project. The ``circle.yml`` configuration file:
-
-.. code-block:: yaml
-
-    machine:
-        environment:
-            PLATFORMIO_CI_SRC: examples/Bluetooth/PS3SPP/PS3SPP.ino
-            PLATFORMIO_CI_SRC: examples/pl2303/pl2303_gps/pl2303_gps.ino
-
-    dependencies:
-        pre:
-            - sudo apt-get install python2.7-dev
-            - sudo python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
-            - wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
-            - unzip /tmp/spi4teensy3.zip -d /tmp
-
-    test:
-        override:
-            - platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due

docs/ci/drone.rst

@@ -1,70 +0,0 @@
-.. _ci_drone:
-
-Drone
-=====
-
-`Drone <https://drone.io>`_  is a hosted continuous integration service.
-It enables you to conveniently set up projects to automatically build, test,
-and deploy as you make changes to your code to
-`GitHub <http://en.wikipedia.org/wiki/GitHub>`_ and
-`BitBucket <http://en.wikipedia.org/wiki/Bitbucket>`_ repositories.
-
-Drone is configured by modifying settings in your project control panel.
-
-Drone automatically detects when a commit has been made and pushed to a
-GitHub repository that is using Drone, and each time this happens, it will
-try to build the project using :ref:`cmd_ci` command. This includes commits to
-all branches, not just to the master branch. Drone will also build and run
-pull requests. When that process has completed, it will notify a developer in
-the way it has been configured to do so — for example, by sending an email
-containing the build results (showing success or failure). It can be
-configured to build project on a range of different :ref:`platforms`.
-
-Integration
------------
-
-Please fill all fields for your project in the Drone control panel:
-
-`Environment Variables`:
-
-.. code-block:: bash
-
-    PLATFORMIO_CI_SRC=path/to/source/file.c
-    PLATFORMIO_CI_SRC=path/to/source/file.ino
-    PLATFORMIO_CI_SRC=path/to/source/directory
-
-`Commands`:
-
-.. code-block:: bash
-
-    python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
-    platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
-
-.. image:: ../_static/droneci-platformio-integration-1.png
-
-For more details as for PlatformIO build process please look into :ref:`cmd_ci`
-command.
-
-Examples
---------
-
-1. Integration for `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
-   project. The ``circle.yml`` configuration file:
-
-`Environment Variables`:
-
-.. code-block:: bash
-
-    PLATFORMIO_CI_SRC=examples/Bluetooth/PS3SPP/PS3SPP.ino
-    PLATFORMIO_CI_SRC=examples/pl2303/pl2303_gps/pl2303_gps.ino
-
-`Commands`:
-
-.. code-block:: bash
-
-    python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
-    wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
-    unzip /tmp/spi4teensy3.zip -d /tmp
-    platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due
-
-.. image:: ../_static/droneci-platformio-integration-2.png

docs/ci/index.rst

@@ -1,24 +0,0 @@
-.. _ci:
-
-Continuous Integration
-======================
-
-`Continuous Integration (CI, wiki) <http://en.wikipedia.org/wiki/Continuous_integration>`_
-is the practice, in software engineering, of merging all developer working
-copies with a shared mainline several times a day.
-
-:ref:`cmd_ci` command is intended to be used in combination with the build
-servers and the popular
-`Continuous Integration Software <http://en.wikipedia.org/wiki/Comparison_of_continuous_integration_software>`_.
-
-By integrating regularly, you can detect errors quickly, and locate them more
-easily.
-
-.. toctree::
-    :maxdepth: 2
-
-    appveyor
-    circleci
-    drone
-    shippable
-    travis

docs/ci/shippable.rst

@@ -1,76 +0,0 @@
-.. _ci_shippable:
-
-Shippable
-=========
-
-`Shippable <http://en.wikipedia.org/wiki/Shippable>`_ is a hosted cloud
-platform that provides hosted continuous integration, deployment, and testing
-to `GitHub <http://en.wikipedia.org/wiki/GitHub>`_ and
-`BitBucket <http://en.wikipedia.org/wiki/Bitbucket>`_ repositories.
-Shippable's continuous integration service is built using Docker.
-
-Shippable is configured by adding a file named ``shippable.yml``, which is a
-`YAML <http://en.wikipedia.org/wiki/YAML>`_ format text file, to the root
-directory of the GitHub repository or you can use your Travis CI configuration
-file ``.travis.yml``.
-
-Shippable automatically detects when a commit has been made and pushed to a
-GitHub repository that is using Shippable, and each time this happens, it will
-try to build the project using :ref:`cmd_ci` command. This includes commits to
-all branches, not just to the master branch. Shippable will also build and run
-pull requests. When that process has completed, it will notify a developer in
-the way it has been configured to do so — for example, by sending an email
-containing the build results (showing success or failure), or by posting a
-message on an IRC channel. It can be configured to build project on a range of
-different :ref:`platforms`.
-
-Integration
------------
-
-Please put ``shippable.yml`` or ``.travis.yml`` to the root directory of the
-GitHub repository.
-
-.. code-block:: yaml
-
-    language: python
-    python:
-        - "2.7"
-
-    env:
-        - PLATFORMIO_CI_SRC=path/to/source/file.c
-        - PLATFORMIO_CI_SRC=path/to/source/file.ino
-        - PLATFORMIO_CI_SRC=path/to/source/directory
-
-    install:
-        - python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
-
-    script:
-        - platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
-
-
-For more details as for PlatformIO build process please look into :ref:`cmd_ci`
-command.
-
-Examples
---------
-
-1. Integration for `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
-   project. The ``shippable.yml`` or ``.travis.yml`` configuration file:
-
-.. code-block:: yaml
-
-    language: python
-    python:
-        - "2.7"
-
-    env:
-        - PLATFORMIO_CI_SRC=examples/Bluetooth/PS3SPP/PS3SPP.ino
-        - PLATFORMIO_CI_SRC=examples/pl2303/pl2303_gps/pl2303_gps.ino
-
-    install:
-        - python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
-        - wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
-        - unzip /tmp/spi4teensy3.zip -d /tmp
-
-    script:
-        - platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due

docs/ci/travis.rst

@@ -1,72 +0,0 @@
-.. _ci_travis:
-
-Travis CI
-=========
-
-`Travis CI <http://en.wikipedia.org/wiki/Travis_CI>`_ is an open-source hosted,
-distributed continuous integration service used to build and test projects
-hosted at `GitHub <http://en.wikipedia.org/wiki/GitHub>`_.
-
-Travis CI is configured by adding a file named ``.travis.yml``, which is a
-`YAML <http://en.wikipedia.org/wiki/YAML>`_ format text file, to the root
-directory of the GitHub repository.
-
-Travis CI automatically detects when a commit has been made and pushed to a
-GitHub repository that is using Travis CI, and each time this happens, it will
-try to build the project using :ref:`cmd_ci` command. This includes commits to
-all branches, not just to the master branch. Travis CI will also build and run
-pull requests. When that process has completed, it will notify a developer in
-the way it has been configured to do so — for example, by sending an email
-containing the build results (showing success or failure), or by posting a
-message on an IRC channel. It can be configured to build project on a range of
-different :ref:`platforms`.
-
-Integration
------------
-
-Please put ``.travis.yml`` to the root directory of the GitHub repository.
-
-.. code-block:: yaml
-
-    language: python
-    python:
-        - "2.7"
-
-    env:
-        - PLATFORMIO_CI_SRC=path/to/source/file.c
-        - PLATFORMIO_CI_SRC=path/to/source/file.ino
-        - PLATFORMIO_CI_SRC=path/to/source/directory
-
-    install:
-        - python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
-
-    script:
-        - platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
-
-
-For more details as for PlatformIO build process please look into :ref:`cmd_ci`
-command.
-
-Examples
---------
-
-1. Integration for `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
-   project. The ``.travis.yml`` configuration file:
-
-.. code-block:: yaml
-
-    language: python
-    python:
-        - "2.7"
-
-    env:
-        - PLATFORMIO_CI_SRC=examples/Bluetooth/PS3SPP/PS3SPP.ino
-        - PLATFORMIO_CI_SRC=examples/pl2303/pl2303_gps/pl2303_gps.ino
-
-    install:
-        - python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
-        - wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
-        - unzip /tmp/spi4teensy3.zip -d /tmp
-
-    script:
-        - platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due

docs/conf.py

@@ -1,278 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# PlatformIO documentation build configuration file, created by
-# sphinx-quickstart on Sun Aug  3 19:13:49 2014.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import os
-import sys
-
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath(os.pardir))
-
-# -- General configuration ------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = []
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'PlatformIO'
-copyright = u'2014-2015, Ivan Kravets'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-import platformio
-# The short X.Y version.
-version = '.'.join(map(str, platformio.VERSION[0:2]))
-# The full version, including alpha/beta/rc tags.
-release = platformio.__version__
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-html_theme = 'default'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-#html_extra_path = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'PlatformIOdoc'
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-  ('index', 'PlatformIO.tex', u'PlatformIO Documentation',
-   u'Ivan Kravets', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'platformio', u'PlatformIO Documentation',
-     [u'Ivan Kravets'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-  ('index', 'PlatformIO', u'PlatformIO Documentation',
-   u'Ivan Kravets', 'PlatformIO', 'One line description of project.',
-   'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
-
-
-# Example configuration for intersphinx: refer to the Python standard library.
-#intersphinx_mapping = {'http://docs.python.org/': None}
-
-# Read the Docs Sphinx Theme patch
-# on_rtd is whether we are on readthedocs.org,
-# this line of code grabbed from docs.readthedocs.org
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
-if not on_rtd:  # only import and set the theme if we're building docs locally
-    import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
-# A timeout value, in seconds, for the linkcheck builder
-# http://sphinx-doc.org/config.html#confval-linkcheck_timeout
-linkcheck_timeout = 10
-linkcheck_anchors = False

docs/envvars.rst

@@ -1,120 +0,0 @@
-.. _envvars:
-
-Environment variables
-=====================
-
-`Environment variables <http://en.wikipedia.org/wiki/Environment_variable>`_
-are a set of dynamic named values that can affect the way running processes
-will behave on a computer.
-
-*PlatformIO* handles variables which start with ``PLATFORMIO_`` prefix. They
-have the **HIGHEST PRIORITY**.
-
-.. contents::
-
-General
--------
-
-PlatformIO uses *General* environment variables for the common
-operations/commands.
-
-.. _envvar_CI:
-
-CI
-~~
-
-PlatformIO handles ``CI`` variable which is setup by
-`Continuous Integration <http://en.wikipedia.org/wiki/Continuous_integration>`_
-(Travis, Circle and etc.) systems.
-Currently, PlatformIO uses it to disable prompts.
-
-In other words, ``CI=true`` automatically setup
-:ref:`PLATFORMIO_SETTING_ENABLE_PROMPTS=false <envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS>`.
-
-.. _envvar_PLATFORMIO_HOME_DIR:
-
-PLATFORMIO_HOME_DIR
-~~~~~~~~~~~~~~~~~~~
-
-Allows to override :ref:`projectconf` option
-:ref:`projectconf_pio_home_dir`.
-
-.. _envvar_PLATFORMIO_LIB_DIR:
-
-PLATFORMIO_LIB_DIR
-~~~~~~~~~~~~~~~~~~
-
-Allows to override :ref:`projectconf` option
-:ref:`projectconf_pio_lib_dir`.
-
-.. _envvar_PLATFORMIO_SRC_DIR:
-
-PLATFORMIO_SRC_DIR
-~~~~~~~~~~~~~~~~~~
-
-Allows to override :ref:`projectconf` option
-:ref:`projectconf_pio_src_dir`.
-
-.. _envvar_PLATFORMIO_ENVS_DIR:
-
-PLATFORMIO_ENVS_DIR
-~~~~~~~~~~~~~~~~~~~
-
-Allows to override :ref:`projectconf` option
-:ref:`projectconf_pio_envs_dir`.
-
-
-Builder
--------
-
-.. _envvar_PLATFORMIO_SRCBUILD_FLAGS:
-
-PLATFORMIO_SRCBUILD_FLAGS
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Allows to override :ref:`projectconf` option
-:ref:`projectconf_srcbuild_flags`.
-
-Settings
---------
-
-Allows to override PlatformIO settings. You can manage them via
-:ref:`cmd_settings` command.
-
-
-PLATFORMIO_SETTING_AUTO_UPDATE_LIBRARIES
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Allows to override setting :ref:`setting_auto_update_libraries`.
-
-PLATFORMIO_SETTING_AUTO_UPDATE_PLATFORMS
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Allows to override setting :ref:`setting_auto_update_platforms`.
-
-PLATFORMIO_SETTING_CHECK_LIBRARIES_INTERVAL
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Allows to override setting :ref:`setting_check_libraries_interval`.
-
-PLATFORMIO_SETTING_CHECK_PLATFORMIO_INTERVAL
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Allows to override setting :ref:`setting_check_platformio_interval`.
-
-PLATFORMIO_SETTING_CHECK_PLATFORMS_INTERVAL
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Allows to override setting :ref:`setting_check_platforms_interval`.
-
-.. _envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS:
-
-PLATFORMIO_SETTING_ENABLE_PROMPTS
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Allows to override setting :ref:`setting_enable_prompts`.
-
-PLATFORMIO_SETTING_ENABLE_TELEMETRY
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Allows to override setting :ref:`setting_enable_telemetry`.

docs/faq.rst

@@ -1,102 +0,0 @@
-.. _faq:
-
-Frequently Asked Questions
-==========================
-
-.. contents::
-
-General
--------
-
-.. _faq_what_is_platformio:
-
-What is PlatformIO?
-~~~~~~~~~~~~~~~~~~~
-
-`PlatformIO <http://platformio.org>`_ is a cross-platform code builder
-and the missing library manager.
-
-PlatformIO is independent from the platform, in which it is running. In fact,
-the only requirement is Python, which exists pretty much everywhere. What this
-means is that PlatformIO projects can be easily moved from one computer to
-another, as well as that PlatformIO allows for the easy sharing of projects
-between team members, regardless of operating system they prefer to work with.
-Beyond that, PlatformIO can be run not only on commonly used desktops/laptops
-but also on the servers without X Window System. While PlatformIO itself is a
-console application, it can be used in combination with one's favorite
-:ref:`ide` or text editor such as :ref:`ide_arduino`, :ref:`ide_eclipse`,
-:ref:`ide_visualstudio`, :ref:`ide_vim`,  :ref:`ide_sublimetext`, etc.
-
-Alright, so PlatformIO can run on different operating systems. But more
-importantly, from development perspective at least, is a list of supported
-boards and MCUs. To keep things short: PlatformIO supports over 100
-:ref:`Embedded Boards <platforms>` and all major
-:ref:`Development Platforms <platforms>`.
-
-PlatformIO allows users to:
-
-* Decide which operation system they want to run development process on.
-  You can even use one OS at home and another at work.
-* Choose which editor to use for writing the code. It can be pretty simple
-  editor or powerful favorite :ref:`ide`.
-* Focus on the code development, significantly simplifying support for the
-  :ref:`platforms` and MCUs.
-
-
-How does it work?
-~~~~~~~~~~~~~~~~~
-
-Without going too deep into PlatformIO implementation details, work cycle of
-the project developed using PlatformIO is as follows:
-
-* Users choose board(s) interested in :ref:`projectconf`
-* Based on this list of boards, PlatformIO downloads required toolchains and
-  installs them automatically.
-* Users develop code and PlatformIO makes sure that it is compiled, prepared
-  and uploaded to all the boards of interest.
-
-.. _faq_troubleshooting:
-
-Troubleshooting
----------------
-
-.. _faq_troubleshooting_pioblocksprompt:
-
-PlatformIO blocks command execution using user prompt
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-If you are going to run *PlatformIO* from **subprocess**, you **MUST
-DISABLE** all prompts. It will allow you to avoid blocking.
-There are a few options:
-
-- using :option:`platformio --force` option before each command
-- using environment variable :ref:`PLATFORMIO_SETTING_ENABLE_PROMPTS=No <envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS>`
-- disable global setting ``enable_prompts`` via :ref:`cmd_settings` command
-- masking under Continuous Integration system via environment variable
-  :ref:`CI=true <envvar_CI>`.
-
-
-Windows: ``UnicodeDecodeError: 'ascii' codec can't decode byte``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Answered in `issue #143 <https://github.com/platformio/platformio/issues/143#issuecomment-88060906>`_.
-
-Serial does not work with panStampAVR board
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Answered in `issue #144 <https://github.com/platformio/platformio/issues/144#issuecomment-87388038>`_.
-
-
-PlatformIO: command not found || An error ``pkg_resources.DistributionNotFound``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Please upgrade *SetupTools* package:
-
-.. code-block:: bash
-
-    $ [sudo] pip uninstall setuptools
-    $ [sudo] pip install setuptools
-
-    # Then re-install PlatformIO
-    $ [sudo] pip uninstall platformio
-    $ [sudo] pip install platformio

docs/frameworks/arduino.rst

@@ -1,951 +0,0 @@
-.. _framework_arduino:
-
-Framework ``arduino``
-=====================
-Arduino Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences.
-
-For more detailed information please visit `vendor site <http://arduino.cc/en/Reference/HomePage>`_.
-
-.. contents::
-
-Platforms
----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`platform_atmelavr`
-      - Atmel AVR 8- and 32-bit MCUs deliver a unique combination of performance, power efficiency and design flexibility. Optimized to speed time to market-and easily adapt to new ones-they are based on the industrys most code-efficient architecture for C and assembly programming.
-
-    * - :ref:`platform_atmelsam`
-      - Atmel | SMART offers Flash- based ARM products based on the ARM Cortex-M0+, Cortex-M3 and Cortex-M4 architectures, ranging from 8KB to 2MB of Flash including a rich peripheral and feature mix.
-
-    * - :ref:`platform_espressif`
-      - Espressif Systems is a privately held fabless semiconductor company. They provide wireless communications and Wi-Fi chips which are widely used in mobile devices and the Internet of Things applications.
-
-    * - :ref:`platform_teensy`
-      - Teensy is a complete USB-based microcontroller development system, in a very small footprint, capable of implementing many types of projects. All programming is done via the USB port. No special programmer is needed, only a standard "Mini-B" USB cable and a PC or Macintosh with a USB port.
-
-    * - :ref:`platform_timsp430`
-      - MSP430 microcontrollers (MCUs) from Texas Instruments (TI) are 16-bit, RISC-based, mixed-signal processors designed for ultra-low power. These MCUs offer the lowest power consumption and the perfect mix of integrated peripherals for thousands of applications.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by horizontal.
-
-Adafruit
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``flora8``
-      - `Adafruit Flora <http://www.adafruit.com/product/659>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``protrinket3``
-      - `Adafruit Pro Trinket 3V/12MHz (USB) <http://www.adafruit.com/products/2010>`_
-      - ATMEGA328P
-      - 12 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``protrinket3ftdi``
-      - `Adafruit Pro Trinket 3V/12MHz (FTDI) <http://www.adafruit.com/products/2010>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``protrinket5``
-      - `Adafruit Pro Trinket 5V/16MHz (USB) <http://www.adafruit.com/products/2000>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``protrinket5ftdi``
-      - `Adafruit Pro Trinket 5V/16MHz (USB) <http://www.adafruit.com/products/2000>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``trinket3``
-      - `Adafruit Trinket 3V/8MHz <http://www.adafruit.com/products/1500>`_
-      - ATTINY85
-      - 8 MHz
-      - 8 Kb
-      - 0.5 Kb
-
-    * - ``trinket5``
-      - `Adafruit Trinket 5V/16MHz <http://www.adafruit.com/products/1501>`_
-      - ATTINY85
-      - 16 MHz
-      - 8 Kb
-      - 0.5 Kb
-
-Arduino
-~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``LilyPadUSB``
-      - `Arduino LilyPad USB <http://arduino.cc/en/Main/ArduinoBoardLilyPadUSB>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``atmegangatmega168``
-      - `Arduino NG or older ATmega168 <http://arduino.cc/en/main/boards>`_
-      - ATMEGA168
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``atmegangatmega8``
-      - `Arduino NG or older ATmega8 <http://arduino.cc/en/main/boards>`_
-      - ATMEGA8
-      - 16 MHz
-      - 8 Kb
-      - 1 Kb
-
-    * - ``btatmega168``
-      - `Arduino BT ATmega168 <http://arduino.cc/en/main/boards>`_
-      - ATMEGA168
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``btatmega328``
-      - `Arduino BT ATmega328 <http://arduino.cc/en/main/boards>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``diecimilaatmega168``
-      - `Arduino Duemilanove or Diecimila ATmega168 <http://arduino.cc/en/Main/ArduinoBoardDiecimila>`_
-      - ATMEGA168
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``diecimilaatmega328``
-      - `Arduino Duemilanove or Diecimila ATmega328 <http://arduino.cc/en/Main/ArduinoBoardDiecimila>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``due``
-      - `Arduino Due (Programming Port) <http://arduino.cc/en/Main/arduinoBoardDue>`_
-      - AT91SAM3X8E
-      - 84 MHz
-      - 512 Kb
-      - 32 Kb
-
-    * - ``dueUSB``
-      - `Arduino Due (USB Native Port) <http://arduino.cc/en/Main/arduinoBoardDue>`_
-      - AT91SAM3X8E
-      - 84 MHz
-      - 512 Kb
-      - 32 Kb
-
-    * - ``esplora``
-      - `Arduino Esplora <http://arduino.cc/en/Main/ArduinoBoardEsplora>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``ethernet``
-      - `Arduino Ethernet <http://arduino.cc/en/Main/ArduinoBoardEthernet>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``fio``
-      - `Arduino Fio <http://arduino.cc/en/Main/ArduinoBoardFio>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``leonardo``
-      - `Arduino Leonardo <http://arduino.cc/en/Main/arduinoBoardLeonardo>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``lilypadatmega168``
-      - `Arduino LilyPad ATmega168 <http://arduino.cc/en/Main/ArduinoBoardLilyPad>`_
-      - ATMEGA168
-      - 8 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``lilypadatmega328``
-      - `Arduino LilyPad ATmega328 <http://arduino.cc/en/Main/ArduinoBoardLilyPad>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``megaADK``
-      - `Arduino Mega ADK <http://arduino.cc/en/Main/ArduinoBoardMegaADK>`_
-      - ATMEGA2560
-      - 16 MHz
-      - 256 Kb
-      - 8 Kb
-
-    * - ``megaatmega1280``
-      - `Arduino Mega or Mega 2560 ATmega1280 <http://arduino.cc/en/Main/arduinoBoardMega>`_
-      - ATMEGA1280
-      - 16 MHz
-      - 128 Kb
-      - 8 Kb
-
-    * - ``megaatmega2560``
-      - `Arduino Mega or Mega 2560 ATmega2560 (Mega 2560) <http://arduino.cc/en/Main/arduinoBoardMega2560>`_
-      - ATMEGA2560
-      - 16 MHz
-      - 256 Kb
-      - 8 Kb
-
-    * - ``micro``
-      - `Arduino Micro <http://arduino.cc/en/Main/ArduinoBoardMicro>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``miniatmega168``
-      - `Arduino Mini ATmega168 <http://arduino.cc/en/Main/ArduinoBoardMini>`_
-      - ATMEGA168
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``miniatmega328``
-      - `Arduino Mini ATmega328 <http://arduino.cc/en/Main/ArduinoBoardMini>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``nanoatmega168``
-      - `Arduino Nano ATmega168 <http://arduino.cc/en/Main/ArduinoBoardNano>`_
-      - ATMEGA168
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``nanoatmega328``
-      - `Arduino Nano ATmega328 <http://arduino.cc/en/Main/ArduinoBoardNano>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``pro16MHzatmega168``
-      - `Arduino Pro or Pro Mini ATmega168 (5V, 16 MHz) <http://arduino.cc/en/Main/ArduinoBoardProMini>`_
-      - ATMEGA168
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``pro16MHzatmega328``
-      - `Arduino Pro or Pro Mini ATmega328 (5V, 16 MHz) <http://arduino.cc/en/Main/ArduinoBoardProMini>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``pro8MHzatmega168``
-      - `Arduino Pro or Pro Mini ATmega168 (3.3V, 8 MHz) <http://arduino.cc/en/Main/ArduinoBoardProMini>`_
-      - ATMEGA168
-      - 8 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``pro8MHzatmega328``
-      - `Arduino Pro or Pro Mini ATmega328 (3.3V, 8 MHz) <http://arduino.cc/en/Main/ArduinoBoardProMini>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``robotControl``
-      - `Arduino Robot Control <http://arduino.cc/en/Main/Robot>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``robotMotor``
-      - `Arduino Robot Motor <http://arduino.cc/en/Main/Robot>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``uno``
-      - `Arduino Uno <http://arduino.cc/en/Main/ArduinoBoardUno>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``yun``
-      - `Arduino Yun <http://arduino.cc/en/Main/ArduinoBoardYun>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-BQ
-~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``zumbt328``
-      - `BQ ZUM BT-328 board <http://www.bq.com/gb/products/zum.html>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-BitWizard
-~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``raspduino``
-      - `BitWizard Raspduino <http://www.bitwizard.nl/wiki/index.php/Raspduino>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-Digistump
-~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``digispark-pro``
-      - `Digistump Digispark Pro (Default 16 MHz) <http://digistump.com/products/109>`_
-      - ATTINY167
-      - 16 MHz
-      - 16 Kb
-      - 0.5 Kb
-
-    * - ``digispark-pro32``
-      - `Digistump Digispark Pro (16 MHz) (32 byte buffer) <http://digistump.com/products/109>`_
-      - ATTINY167
-      - 16 MHz
-      - 16 Kb
-      - 0.5 Kb
-
-    * - ``digispark-pro64``
-      - `Digistump Digispark Pro (16 MHz) (64 byte buffer) <http://digistump.com/products/109>`_
-      - ATTINY167
-      - 16 MHz
-      - 16 Kb
-      - 0.5 Kb
-
-    * - ``digispark-tiny``
-      - `Digistump Digispark (Default - 16 MHz) <http://digistump.com/products/1>`_
-      - ATTINY85
-      - 16 MHz
-      - 8 Kb
-      - 0.5 Kb
-
-    * - ``digix``
-      - `Digistump DigiX <http://digistump.com/products/50>`_
-      - AT91SAM3X8E
-      - 84 MHz
-      - 512 Kb
-      - 28 Kb
-
-Engduino
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``engduinov1``
-      - `Engduino 1 <http://www.engduino.org>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``engduinov2``
-      - `Engduino 2 <http://www.engduino.org>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``engduinov3``
-      - `Engduino 3 <http://www.engduino.org>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-Espressif
-~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``esp01``
-      - `Espressif ESP8266 board <https://nurdspace.nl/ESP8266>`_
-      - ESP8266
-      - 80 MHz
-      - 512 Kb
-      - 32 Kb
-
-LightUp
-~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lightup``
-      - `LightUp <https://www.lightup.io/>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-LowPowerLab
-~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``moteino``
-      - `LowPowerLab Moteino <https://lowpowerlab.com/shop/moteino-r4>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``moteinomega``
-      - `LowPowerLab MoteinoMEGA <http://lowpowerlab.com/blog/2014/08/09/moteinomega-available-now/>`_
-      - ATMEGA1284P
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb
-
-Microduino
-~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``1284p16m``
-      - `Microduino Core+ (ATmega1284P@16M,5V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core%2B>`_
-      - ATMEGA1284P
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``1284p8m``
-      - `Microduino Core+ (ATmega1284P@8M,3.3V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core%2B>`_
-      - ATMEGA1284P
-      - 8 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``168pa16m``
-      - `Microduino Core (Atmega168PA@16M,5V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core>`_
-      - ATMEGA168P
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``168pa8m``
-      - `Microduino Core (Atmega168PA@8M,3.3V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core>`_
-      - ATMEGA168P
-      - 8 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``328p16m``
-      - `Microduino Core (Atmega328P@16M,5V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``328p8m``
-      - `Microduino Core (Atmega328P@8M,3.3V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``32u416m``
-      - `Microduino Core USB (ATmega32U4@16M,5V) <https://www.microduino.cc/wiki/index.php?title=Microduino-CoreUSB>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``644pa16m``
-      - `Microduino Core+ (Atmega644PA@16M,5V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core%2B>`_
-      - ATMEGA644P
-      - 16 MHz
-      - 64 Kb
-      - 4 Kb
-
-    * - ``644pa8m``
-      - `Microduino Core+ (Atmega644PA@8M,3.3V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core%2B>`_
-      - ATMEGA644P
-      - 8 MHz
-      - 64 Kb
-      - 4 Kb
-
-PanStamp
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``panStampAVR``
-      - `PanStamp AVR <http://www.panstamp.com/product/panstamp-avr/>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``panStampNRG``
-      - `PanStamp NRG 1.1 <http://www.panstamp.com/product/197/>`_
-      - CC430F5137
-      - 12 MHz
-      - 32 Kb
-      - 4 Kb
-
-Quirkbot
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``quirkbot``
-      - `Quirkbot <http://quirkbot.com>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-RedBearLab
-~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``blend``
-      - `RedBearLab Blend <http://redbearlab.com/blend/>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``blendmicro16``
-      - `RedBearLab Blend Micro 3.3V/16MHz (overclock) <http://redbearlab.com/blendmicro/>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``blendmicro8``
-      - `RedBearLab Blend Micro 3.3V/8MHz <http://redbearlab.com/blendmicro/>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-RepRap
-~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``reprap_rambo``
-      - `RepRap RAMBo <http://reprap.org/wiki/Rambo>`_
-      - ATMEGA2560
-      - 16 MHz
-      - 256 Kb
-      - 8 Kb
-
-SainSmart
-~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``sainSmartDue``
-      - `SainSmart Due (Programming Port) <http://www.sainsmart.com/arduino/control-boards/sainsmart-due-atmel-sam3x8e-arm-cortex-m3-board-black.html>`_
-      - AT91SAM3X8E
-      - 84 MHz
-      - 512 Kb
-      - 32 Kb
-
-    * - ``sainSmartDueUSB``
-      - `SainSmart Due (USB Native Port) <http://www.sainsmart.com/arduino/control-boards/sainsmart-due-atmel-sam3x8e-arm-cortex-m3-board-black.html>`_
-      - AT91SAM3X8E
-      - 84 MHz
-      - 512 Kb
-      - 32 Kb
-
-Sanguino
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``sanguino_atmega12848m``
-      - `Sanguino ATmega1284p (8MHz) <https://code.google.com/p/sanguino/>`_
-      - ATMEGA1284P
-      - 8 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``sanguino_atmega1284m``
-      - `Sanguino ATmega1284p (20MHz) <https://code.google.com/p/sanguino/>`_
-      - ATMEGA1284P
-      - 20 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``sanguino_atmega1284p``
-      - `Sanguino ATmega1284p (16MHz) <https://code.google.com/p/sanguino/>`_
-      - ATMEGA1284P
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``sanguino_atmega644p``
-      - `Sanguino ATmega644P <https://code.google.com/p/sanguino/>`_
-      - ATMEGA644P
-      - 16 MHz
-      - 64 Kb
-      - 4 Kb
-
-SparkFun
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``sparkfun_digitalsandbox``
-      - `SparkFun Digital Sandbox <https://www.sparkfun.com/products/12651>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``sparkfun_fiov3``
-      - `SparkFun Fio V3 3.3V/8MHz <https://www.sparkfun.com/products/11520>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``sparkfun_makeymakey``
-      - `SparkFun Makey Makey <https://www.sparkfun.com/products/11511>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``sparkfun_megamini``
-      - `SparkFun Mega Pro Mini 3.3V <https://www.sparkfun.com/products/10743>`_
-      - ATMEGA2560
-      - 8 MHz
-      - 256 Kb
-      - 8 Kb
-
-    * - ``sparkfun_megapro16MHz``
-      - `SparkFun Mega Pro 5V/16MHz <https://www.sparkfun.com/products/11007>`_
-      - ATMEGA2560
-      - 16 MHz
-      - 256 Kb
-      - 8 Kb
-
-    * - ``sparkfun_megapro8MHz``
-      - `SparkFun Mega Pro 3.3V/8MHz <https://www.sparkfun.com/products/10744>`_
-      - ATMEGA2560
-      - 8 MHz
-      - 256 Kb
-      - 8 Kb
-
-    * - ``sparkfun_promicro16``
-      - `SparkFun Pro Micro 5V/16MHz <https://www.sparkfun.com/products/12640>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``sparkfun_promicro8``
-      - `SparkFun Pro Micro 3.3V/8MHz <https://www.sparkfun.com/products/12587>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``sparkfun_redboard``
-      - `SparkFun RedBoard <https://www.sparkfun.com/products/12757>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``uview``
-      - `SparkFun MicroView <https://www.sparkfun.com/products/12923>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-Teensy
-~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``teensy20``
-      - `Teensy 2.0 <https://www.pjrc.com/store/teensy.html>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``teensy20pp``
-      - `Teensy++ 2.0 <https://www.pjrc.com/store/teensypp.html>`_
-      - AT90USB1286
-      - 16 MHz
-      - 128 Kb
-      - 8 Kb
-
-    * - ``teensy30``
-      - `Teensy 3.0 <https://www.pjrc.com/store/teensy3.html>`_
-      - MK20DX128
-      - 48 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``teensy31``
-      - `Teensy 3.1 <https://www.pjrc.com/store/teensy31.html>`_
-      - MK20DX256
-      - 72 MHz
-      - 256 Kb
-      - 64 Kb
-
-    * - ``teensylc``
-      - `Teensy LC <http://www.pjrc.com/teensy/teensyLC.html>`_
-      - MKL26Z64
-      - 48 MHz
-      - 64 Kb
-      - 8 Kb
-
-TinyCircuits
-~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``tinyduino``
-      - `TinyCircuits TinyDuino Processor Board <https://tiny-circuits.com/tinyduino-processor-board.html>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``tinylily``
-      - `TinyCircuits TinyLily Mini Processor <https://tiny-circuits.com/tiny-lily-mini-processor.html>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-WickedDevice
-~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``wildfirev2``
-      - `WickedDevice WildFire v2 [stk500] <http://shop.wickeddevice.com/resources/wildfire/#arduinoidesetup>`_
-      - ATMEGA1284P
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``wildfirev3``
-      - `WickedDevice WildFire v3 [optiboot] <http://shop.wickeddevice.com/resources/wildfire/>`_
-      - ATMEGA1284P
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb

docs/frameworks/cmsis.rst

@@ -1,96 +0,0 @@
-.. _framework_cmsis:
-
-Framework ``cmsis``
-===================
-The ARM Cortex Microcontroller Software Interface Standard (CMSIS) is a vendor-independent hardware abstraction layer for the Cortex-M processor series and specifies debugger interfaces. The CMSIS enables consistent and simple software interfaces to the processor for interface peripherals, real-time operating systems, and middleware. It simplifies software re-use, reducing the learning curve for new microcontroller developers and cutting the time-to-market for devices.
-
-For more detailed information please visit `vendor site <http://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php>`_.
-
-.. contents::
-
-Platforms
----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`platform_ststm32`
-      - The STM32 family of 32-bit Flash MCUs based on the ARM Cortex-M processor is designed to offer new degrees of freedom to MCU users. It offers a 32-bit product range that combines very high performance, real-time capabilities, digital signal processing, and low-power, low-voltage operation, while maintaining full integration and ease of development.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by horizontal.
-
-Armstrap
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``armstrap_eagle1024``
-      - `Armstrap Eagle 1024 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
-      - STM32F417VGT6
-      - 168 MHz
-      - 1024 Kb
-      - 192 Kb
-
-    * - ``armstrap_eagle2048``
-      - `Armstrap Eagle 2048 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
-      - STM32F427VIT6
-      - 168 MHz
-      - 2048 Kb
-      - 256 Kb
-
-    * - ``armstrap_eagle512``
-      - `Armstrap Eagle 512 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
-      - STM32F407VET6
-      - 168 MHz
-      - 512 Kb
-      - 192 Kb
-
-ST
-~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``disco_f303vc``
-      - `ST STM32F3DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF254044>`_
-      - STM32F303VCT6
-      - 72 MHz
-      - 256 Kb
-      - 48 Kb
-
-    * - ``disco_f407vg``
-      - `ST STM32F4DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF252419>`_
-      - STM32F407VGT6
-      - 168 MHz
-      - 1024 Kb
-      - 128 Kb
-
-    * - ``disco_l152rb``
-      - `ST STM32LDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF258515>`_
-      - STM32L152RBT6
-      - 32 MHz
-      - 128 Kb
-      - 16 Kb

docs/frameworks/energia.rst

@@ -1,114 +0,0 @@
-.. _framework_energia:
-
-Framework ``energia``
-=====================
-Energia framework enables pretty much anyone to start easily creating microcontroller-based projects and applications. Its easy-to-use libraries and functions provide developers of all experience levels to start blinking LEDs, buzzing buzzers and sensing sensors more quickly than ever before.
-
-For more detailed information please visit `vendor site <http://energia.nu/reference/>`_.
-
-.. contents::
-
-Platforms
----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`platform_timsp430`
-      - MSP430 microcontrollers (MCUs) from Texas Instruments (TI) are 16-bit, RISC-based, mixed-signal processors designed for ultra-low power. These MCUs offer the lowest power consumption and the perfect mix of integrated peripherals for thousands of applications.
-
-    * - :ref:`platform_titiva`
-      - Texas Instruments TM4C12x MCUs offer the industrys most popular ARM Cortex-M4 core with scalable memory and package options, unparalleled connectivity peripherals, advanced application functions, industry-leading analog integration, and extensive software solutions.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by horizontal.
-
-TI
-~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lplm4f120h5qr``
-      - `TI LaunchPad (Stellaris) w/ lm4f120 (80MHz) <http://www.ti.com/tool/ek-lm4f120xl>`_
-      - LPLM4F120H5QR
-      - 80 MHz
-      - 256 Kb
-      - 32 Kb
-
-    * - ``lpmsp430f5529``
-      - `TI LaunchPad w/ msp430f5529 (16MHz) <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430f5529lp.html>`_
-      - MSP430F5529
-      - 16 MHz
-      - 128 Kb
-      - 1 Kb
-
-    * - ``lpmsp430f5529_25``
-      - `TI LaunchPad w/ msp430f5529 (25MHz) <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430f5529lp.html>`_
-      - MSP430F5529
-      - 25 MHz
-      - 128 Kb
-      - 1 Kb
-
-    * - ``lpmsp430fr5739``
-      - `TI FraunchPad w/ msp430fr5739 <http://www.ti.com/tool/msp-exp430fr5739>`_
-      - MSP430FR5739
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``lpmsp430fr5969``
-      - `TI LaunchPad w/ msp430fr5969 <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430fr5969.html>`_
-      - MSP430FR5969
-      - 8 MHz
-      - 64 Kb
-      - 1 Kb
-
-    * - ``lpmsp430g2231``
-      - `TI LaunchPad w/ msp430g2231 (1 MHz) <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430g2.html>`_
-      - MSP430G2231
-      - 1 MHz
-      - 2 Kb
-      - 0.125 Kb
-
-    * - ``lpmsp430g2452``
-      - `TI LaunchPad w/ msp430g2452 (16MHz) <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430g2.html>`_
-      - MSP430G2452
-      - 16 MHz
-      - 8 Kb
-      - 0.25 Kb
-
-    * - ``lpmsp430g2553``
-      - `TI LaunchPad w/ msp430g2553 (16MHz) <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430g2.html>`_
-      - MSP430G2553
-      - 16 MHz
-      - 16 Kb
-      - 0.5 Kb
-
-    * - ``lptm4c1230c3pm``
-      - `TI LaunchPad (Tiva C) w/ tm4c123 (80MHz) <http://www.ti.com/ww/en/launchpad/launchpads-connected-ek-tm4c123gxl.html>`_
-      - LPTM4C1230C3PM
-      - 80 MHz
-      - 256 Kb
-      - 32 Kb
-
-    * - ``lptm4c1294ncpdt``
-      - `TI LaunchPad (Tiva C) w/ tm4c129 (120MHz) <http://www.ti.com/ww/en/launchpad/launchpads-connected-ek-tm4c1294xl.html>`_
-      - LPTM4C1294NCPDT
-      - 120 MHz
-      - 1024 Kb
-      - 256 Kb

docs/frameworks/index.rst

@@ -1,14 +0,0 @@
-.. _frameworks:
-
-Frameworks
-==========
-
-.. toctree::
-    :maxdepth: 2
-
-    arduino
-    cmsis
-    energia
-    libopencm3
-    mbed
-    spl

docs/frameworks/libopencm3.rst

@@ -1,99 +0,0 @@
-.. _framework_libopencm3:
-
-Framework ``libopencm3``
-========================
-The libOpenCM3 framework aims to create a free/libre/open-source firmware library for various ARM Cortex-M0(+)/M3/M4 microcontrollers, including ST STM32, Ti Tiva and Stellaris, NXP LPC 11xx, 13xx, 15xx, 17xx parts, Atmel SAM3, Energy Micro EFM32 and others.
-
-For more detailed information please visit `vendor site <http://www.libopencm3.org/wiki/Main_Page>`_.
-
-.. contents::
-
-Platforms
----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`platform_ststm32`
-      - The STM32 family of 32-bit Flash MCUs based on the ARM Cortex-M processor is designed to offer new degrees of freedom to MCU users. It offers a 32-bit product range that combines very high performance, real-time capabilities, digital signal processing, and low-power, low-voltage operation, while maintaining full integration and ease of development.
-
-    * - :ref:`platform_titiva`
-      - Texas Instruments TM4C12x MCUs offer the industrys most popular ARM Cortex-M4 core with scalable memory and package options, unparalleled connectivity peripherals, advanced application functions, industry-leading analog integration, and extensive software solutions.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by horizontal.
-
-ST
-~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``disco_f303vc``
-      - `ST STM32F3DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF254044>`_
-      - STM32F303VCT6
-      - 72 MHz
-      - 256 Kb
-      - 48 Kb
-
-    * - ``disco_f407vg``
-      - `ST STM32F4DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF252419>`_
-      - STM32F407VGT6
-      - 168 MHz
-      - 1024 Kb
-      - 128 Kb
-
-    * - ``disco_l152rb``
-      - `ST STM32LDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF258515>`_
-      - STM32L152RBT6
-      - 32 MHz
-      - 128 Kb
-      - 16 Kb
-
-TI
-~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lplm4f120h5qr``
-      - `TI LaunchPad (Stellaris) w/ lm4f120 (80MHz) <http://www.ti.com/tool/ek-lm4f120xl>`_
-      - LPLM4F120H5QR
-      - 80 MHz
-      - 256 Kb
-      - 32 Kb
-
-    * - ``lptm4c1230c3pm``
-      - `TI LaunchPad (Tiva C) w/ tm4c123 (80MHz) <http://www.ti.com/ww/en/launchpad/launchpads-connected-ek-tm4c123gxl.html>`_
-      - LPTM4C1230C3PM
-      - 80 MHz
-      - 256 Kb
-      - 32 Kb
-
-    * - ``lptm4c1294ncpdt``
-      - `TI LaunchPad (Tiva C) w/ tm4c129 (120MHz) <http://www.ti.com/ww/en/launchpad/launchpads-connected-ek-tm4c1294xl.html>`_
-      - LPTM4C1294NCPDT
-      - 120 MHz
-      - 1024 Kb
-      - 256 Kb

docs/frameworks/mbed.rst

@@ -1,568 +0,0 @@
-.. _framework_mbed:
-
-Framework ``mbed``
-==================
-The mbed framework The mbed SDK has been designed to provide enough hardware abstraction to be intuitive and concise, yet powerful enough to build complex projects. It is built on the low-level ARM CMSIS APIs, allowing you to code down to the metal if needed. In addition to RTOS, USB and Networking libraries, a cookbook of hundreds of reusable peripheral and module libraries have been built on top of the SDK by the mbed Developer Community.
-
-For more detailed information please visit `vendor site <http://mbed.org/>`_.
-
-.. contents::
-
-Platforms
----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`platform_freescalekinetis`
-      - Freescale Kinetis Microcontrollers is family of multiple hardware- and software-compatible ARM Cortex-M0+, Cortex-M4 and Cortex-M7-based MCU series. Kinetis MCUs offer exceptional low-power performance, scalability and feature integration.
-
-    * - :ref:`platform_nordicnrf51`
-      - The Nordic nRF51 Series is a family of highly flexible, multi-protocol, system-on-chip (SoC) devices for ultra-low power wireless applications. nRF51 Series devices support a range of protocol stacks including Bluetooth Smart (previously called Bluetooth low energy), ANT and proprietary 2.4GHz protocols such as Gazell.
-
-    * - :ref:`platform_nxplpc`
-      - The NXP LPC is a family of 32-bit microcontroller integrated circuits by NXP Semiconductors. The LPC chips are grouped into related series that are based around the same 32-bit ARM processor core, such as the Cortex-M4F, Cortex-M3, Cortex-M0+, or Cortex-M0. Internally, each microcontroller consists of the processor core, static RAM memory, flash memory, debugging interface, and various peripherals.
-
-    * - :ref:`platform_ststm32`
-      - The STM32 family of 32-bit Flash MCUs based on the ARM Cortex-M processor is designed to offer new degrees of freedom to MCU users. It offers a 32-bit product range that combines very high performance, real-time capabilities, digital signal processing, and low-power, low-voltage operation, while maintaining full integration and ease of development.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by horizontal.
-
-CQ Publishing
-~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lpc11u35_501``
-      - `CQ Publishing TG-LPC11U35-501 <https://developer.mbed.org/platforms/TG-LPC11U35-501/>`_
-      - LPC11U35
-      - 48 MHz
-      - 64 Kb
-      - 10 Kb
-
-Embedded Artists
-~~~~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lpc11u35``
-      - `Embedded Artists LPC11U35 QuickStart Board <https://developer.mbed.org/platforms/EA-LPC11U35/>`_
-      - LPC11U35
-      - 48 MHz
-      - 64 Kb
-      - 10 Kb
-
-    * - ``lpc4088``
-      - `Embedded Artists LPC4088 QuickStart Board <https://developer.mbed.org/platforms/EA-LPC4088/>`_
-      - LPC4088
-      - 120 MHz
-      - 512 Kb
-      - 96 Kb
-
-    * - ``lpc4088_dm``
-      - `Embedded Artists LPC4088 Display Module <https://developer.mbed.org/platforms/EA-LPC4088-Display-Module/>`_
-      - LPC4088
-      - 120 MHz
-      - 512 Kb
-      - 96 Kb
-
-Freescale
-~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``IBMEthernetKit``
-      - `Ethernet IoT Starter Kit <http://developer.mbed.org/platforms/IBMEthernetKit/>`_
-      - MK64FN1M0VLL12
-      - 120 MHz
-      - 1024 Kb
-      - 256 Kb
-
-    * - ``frdm_k20d50m``
-      - `Freescale Kinetis FRDM-K20D50M <https://developer.mbed.org/platforms/FRDM-K20D50M/>`_
-      - MK20DX128VLH5
-      - 48 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``frdm_k22f``
-      - `Freescale Kinetis FRDM-K22F <https://developer.mbed.org/platforms/FRDM-K22F/>`_
-      - MK22FN512VLH12
-      - 120 MHz
-      - 512 Kb
-      - 128 Kb
-
-    * - ``frdm_k64f``
-      - `Freescale Kinetis FRDM-K64F <https://developer.mbed.org/platforms/FRDM-K64F/>`_
-      - MK64FN1M0VLL12
-      - 120 MHz
-      - 1024 Kb
-      - 256 Kb
-
-    * - ``frdm_kl05z``
-      - `Freescale Kinetis FRDM-KL05Z <https://developer.mbed.org/platforms/FRDM-KL05Z/>`_
-      - MKL05Z32VFM4
-      - 48 MHz
-      - 32 Kb
-      - 4 Kb
-
-    * - ``frdm_kl25z``
-      - `Freescale Kinetis FRDM-KL25Z <https://developer.mbed.org/platforms/KL25Z/>`_
-      - MKL25Z128VLK4
-      - 48 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``frdm_kl46z``
-      - `Freescale Kinetis FRDM-KL46Z <https://developer.mbed.org/platforms/FRDM-KL46Z/>`_
-      - MKL46Z256VLL4
-      - 48 MHz
-      - 256 Kb
-      - 32 Kb
-
-JKSoft
-~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``wallBotBLE``
-      - `JKSoft Wallbot BLE <https://developer.mbed.org/platforms/JKSoft-Wallbot-BLE/>`_
-      - NRF51822
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb
-
-NGX Technologies
-~~~~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``blueboard_lpc11u24``
-      - `NGX Technologies BlueBoard-LPC11U24 <https://developer.mbed.org/platforms/BlueBoard-LPC11U24/>`_
-      - LPC11U24
-      - 48 MHz
-      - 32 Kb
-      - 8 Kb
-
-NXP
-~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lpc11u24``
-      - `NXP mbed LPC11U24 <https://developer.mbed.org/platforms/mbed-LPC11U24/>`_
-      - LPC11U24
-      - 48 MHz
-      - 32 Kb
-      - 8 Kb
-
-    * - ``lpc1549``
-      - `NXP LPCXpresso1549 <https://developer.mbed.org/platforms/LPCXpresso1549/>`_
-      - LPC1549
-      - 72 MHz
-      - 256 Kb
-      - 36 Kb
-
-    * - ``lpc1768``
-      - `NXP mbed LPC1768 <http://developer.mbed.org/platforms/mbed-LPC1768/>`_
-      - LPC1768
-      - 96 MHz
-      - 512 Kb
-      - 32 Kb
-
-Nordic
-~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``nrf51_dk``
-      - `Nordic nRF51-DK <https://developer.mbed.org/platforms/Nordic-nRF51-DK/>`_
-      - NRF51822
-      - 32 MHz
-      - 256 Kb
-      - 32 Kb
-
-    * - ``nrf51_dongle``
-      - `Nordic nRF51-Dongle <https://developer.mbed.org/platforms/Nordic-nRF51-Dongle/>`_
-      - NRF51822
-      - 32 MHz
-      - 256 Kb
-      - 32 Kb
-
-    * - ``nrf51_mkit``
-      - `Nordic nRF51822-mKIT <http://developer.mbed.org/platforms/Nordic-nRF51822/>`_
-      - NRF51822
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb
-
-Outrageous Circuits
-~~~~~~~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``mbuino``
-      - `Outrageous Circuits mBuino <https://developer.mbed.org/platforms/Outrageous-Circuits-mBuino/>`_
-      - LPC11U24
-      - 48 MHz
-      - 32 Kb
-      - 8 Kb
-
-RedBearLab
-~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``redBearLab``
-      - `RedBearLab nRF51822 <https://developer.mbed.org/platforms/RedBearLab-nRF51822/>`_
-      - NRF51822
-      - 16 MHz
-      - 256 Kb
-      - 16 Kb
-
-    * - ``redBearLabBLENano``
-      - `RedBearLab BLE Nano <https://developer.mbed.org/platforms/RedBearLab-BLE-Nano/>`_
-      - NRF51822
-      - 16 MHz
-      - 256 Kb
-      - 16 Kb
-
-ST
-~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``disco_f051r8``
-      - `ST STM32F0DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF253215>`_
-      - STM32F051R8T6
-      - 48 MHz
-      - 64 Kb
-      - 8 Kb
-
-    * - ``disco_f100rb``
-      - `ST STM32VLDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF250863>`_
-      - STM32F100RBT6
-      - 24 MHz
-      - 128 Kb
-      - 8 Kb
-
-    * - ``disco_f303vc``
-      - `ST STM32F3DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF254044>`_
-      - STM32F303VCT6
-      - 72 MHz
-      - 256 Kb
-      - 48 Kb
-
-    * - ``disco_f334c8``
-      - `ST 32F3348DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF260318>`_
-      - STM32F334C8T6
-      - 72 MHz
-      - 64 Kb
-      - 16 Kb
-
-    * - ``disco_f401vc``
-      - `ST 32F401CDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF259098>`_
-      - STM32F401VCT6
-      - 84 MHz
-      - 256 Kb
-      - 64 Kb
-
-    * - ``disco_f407vg``
-      - `ST STM32F4DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF252419>`_
-      - STM32F407VGT6
-      - 168 MHz
-      - 1024 Kb
-      - 128 Kb
-
-    * - ``disco_f429zi``
-      - `ST 32F429IDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF259090>`_
-      - STM32F429ZIT6
-      - 180 MHz
-      - 2048 Kb
-      - 256 Kb
-
-    * - ``nucleo_f030r8``
-      - `ST Nucleo F030R8 <https://developer.mbed.org/platforms/ST-Nucleo-F030R8/>`_
-      - STM32F030R8T6
-      - 48 MHz
-      - 64 Kb
-      - 8 Kb
-
-    * - ``nucleo_f070rb``
-      - `ST Nucleo F070RB <https://developer.mbed.org/platforms/ST-Nucleo-F070RB/>`_
-      - STM32F070RBT6
-      - 48 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``nucleo_f072rb``
-      - `ST Nucleo F072RB <https://developer.mbed.org/platforms/ST-Nucleo-F072RB/>`_
-      - STM32F072RBT6
-      - 48 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``nucleo_f091rc``
-      - `ST Nucleo F091RC <https://developer.mbed.org/platforms/ST-Nucleo-F091RC/>`_
-      - STM32F091RCT6
-      - 48 MHz
-      - 256 Kb
-      - 32 Kb
-
-    * - ``nucleo_f103rb``
-      - `ST Nucleo F103RB <https://developer.mbed.org/platforms/ST-Nucleo-F103RB/>`_
-      - STM32F103RBT6
-      - 72 MHz
-      - 128 Kb
-      - 20 Kb
-
-    * - ``nucleo_f302r8``
-      - `ST Nucleo F302R8 <https://developer.mbed.org/platforms/ST-Nucleo-F302R8/>`_
-      - STM32F302R8T6
-      - 72 MHz
-      - 64 Kb
-      - 16 Kb
-
-    * - ``nucleo_f303re``
-      - `ST Nucleo F303RE <http://developer.mbed.org/platforms/ST-Nucleo-F303RE/>`_
-      - STM32F303RET6
-      - 72 MHz
-      - 512 Kb
-      - 64 Kb
-
-    * - ``nucleo_f334r8``
-      - `ST Nucleo F334R8 <https://developer.mbed.org/platforms/ST-Nucleo-F334R8/>`_
-      - STM32F334R8T6
-      - 72 MHz
-      - 64 Kb
-      - 16 Kb
-
-    * - ``nucleo_f401re``
-      - `ST Nucleo F401RE <https://developer.mbed.org/platforms/ST-Nucleo-F401RE/>`_
-      - STM32F401RET6
-      - 84 MHz
-      - 512 Kb
-      - 96 Kb
-
-    * - ``nucleo_f411re``
-      - `ST Nucleo F411RE <https://developer.mbed.org/platforms/ST-Nucleo-F411RE/>`_
-      - STM32F411RET6
-      - 100 MHz
-      - 512 Kb
-      - 128 Kb
-
-    * - ``nucleo_l053r8``
-      - `ST Nucleo L053R8 <https://developer.mbed.org/platforms/ST-Nucleo-L053R8/>`_
-      - STM32L053R8T6
-      - 48 MHz
-      - 64 Kb
-      - 8 Kb
-
-    * - ``nucleo_l152re``
-      - `ST Nucleo L152RE <https://developer.mbed.org/platforms/ST-Nucleo-L152RE/>`_
-      - STM32L152RET6
-      - 32 MHz
-      - 512 Kb
-      - 80 Kb
-
-SeeedStudio
-~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``seeedTinyBLE``
-      - `SeeedStudio Seeed Tiny BLE <http://developer.mbed.org/platforms/Seeed-Tiny-BLE/>`_
-      - NRF51822
-      - 16 MHz
-      - 256 Kb
-      - 16 Kb
-
-    * - ``seeeduinoArchPro``
-      - `SeeedStudio Seeeduino-Arch-Pro <https://developer.mbed.org/platforms/Seeeduino-Arch-Pro/>`_
-      - LPC1768
-      - 96 MHz
-      - 512 Kb
-      - 32 Kb
-
-Solder Splash Labs
-~~~~~~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``dipcortexm0``
-      - `Solder Splash Labs DipCortex M0 <https://developer.mbed.org/platforms/DipCortex-M0/>`_
-      - LPC11U24
-      - 50 MHz
-      - 32 Kb
-      - 8 Kb
-
-Switch Science
-~~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``hrm1017``
-      - `Switch Science mbed HRM1017 <https://developer.mbed.org/platforms/mbed-HRM1017/>`_
-      - NRF51822
-      - 16 MHz
-      - 256 Kb
-      - 16 Kb
-
-    * - ``lpc1114fn28``
-      - `Switch Science mbed LPC1114FN28 <https://developer.mbed.org/platforms/LPC1114FN28/>`_
-      - LPC1114FN28
-      - 48 MHz
-      - 32 Kb
-      - 4 Kb
-
-Teensy
-~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``teensy31``
-      - `Teensy 3.1 <https://www.pjrc.com/store/teensy31.html>`_
-      - MK20DX256
-      - 72 MHz
-      - 256 Kb
-      - 64 Kb
-
-u-blox
-~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``ubloxc027``
-      - `u-blox C027 <https://developer.mbed.org/platforms/u-blox-C027/>`_
-      - LPC1768
-      - 96 MHz
-      - 512 Kb
-      - 32 Kb

docs/frameworks/spl.rst

@@ -1,96 +0,0 @@
-.. _framework_spl:
-
-Framework ``spl``
-=================
-The ST Standard Peripheral Library provides a set of functions for handling the peripherals on the STM32 Cortex-M3 family. The idea is to save the user (the new user, in particular) having to deal directly with the registers.
-
-For more detailed information please visit `vendor site <http://www.st.com/web/en/catalog/tools/FM147/CL1794/SC961/SS1743?sc=stm32embeddedsoftware>`_.
-
-.. contents::
-
-Platforms
----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`platform_ststm32`
-      - The STM32 family of 32-bit Flash MCUs based on the ARM Cortex-M processor is designed to offer new degrees of freedom to MCU users. It offers a 32-bit product range that combines very high performance, real-time capabilities, digital signal processing, and low-power, low-voltage operation, while maintaining full integration and ease of development.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by horizontal.
-
-Armstrap
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``armstrap_eagle1024``
-      - `Armstrap Eagle 1024 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
-      - STM32F417VGT6
-      - 168 MHz
-      - 1024 Kb
-      - 192 Kb
-
-    * - ``armstrap_eagle2048``
-      - `Armstrap Eagle 2048 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
-      - STM32F427VIT6
-      - 168 MHz
-      - 2048 Kb
-      - 256 Kb
-
-    * - ``armstrap_eagle512``
-      - `Armstrap Eagle 512 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
-      - STM32F407VET6
-      - 168 MHz
-      - 512 Kb
-      - 192 Kb
-
-ST
-~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``disco_f303vc``
-      - `ST STM32F3DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF254044>`_
-      - STM32F303VCT6
-      - 72 MHz
-      - 256 Kb
-      - 48 Kb
-
-    * - ``disco_f407vg``
-      - `ST STM32F4DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF252419>`_
-      - STM32F407VGT6
-      - 168 MHz
-      - 1024 Kb
-      - 128 Kb
-
-    * - ``disco_l152rb``
-      - `ST STM32LDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF258515>`_
-      - STM32L152RBT6
-      - 32 MHz
-      - 128 Kb
-      - 16 Kb

docs/history.rst

@@ -1 +0,0 @@
-.. include:: ../HISTORY.rst

docs/ide.rst

@@ -1,15 +0,0 @@
-.. _ide:
-
-IDE Integration
-===============
-
-.. toctree::
-    :maxdepth: 2
-
-    ide/arduino
-    ide/eclipse
-    ide/energia
-    ide/qtcreator
-    ide/sublimetext
-    ide/vim
-    ide/visualstudio

docs/ide/arduino.rst

@@ -1,31 +0,0 @@
-.. _ide_arduino:
-
-Arduino
-=======
-
-The open-source `Arduino Software (IDE) <http://arduino.cc/en/main/software>`_
-makes it easy to write code and upload it to the board. It runs on *Windows,
-Mac OS X, and Linux*. The environment is written in *Java* and based on
-*Processing* and other open-source software.
-
-This software can be used with:
-
-* :ref:`platform_atmelavr`
-* :ref:`platform_atmelsam`
-* :ref:`framework_arduino`
-
-Refer to the `Arduino Getting Started <http://arduino.cc/en/Guide/HomePage>`_
-page for Installation instructions.
-
-Integration
------------
-
-More detailed information is located in PlatformIO blog:
-`Integration of PlatformIO library manager to Arduino IDE <http://www.ikravets.com/computer-life/platformio/2014/10/07/integration-of-platformio-library-manager-to-arduino-and-energia-ides>`_.
-
-
-Screenshot
-----------
-
-.. image:: ../_static/ide-platformio-arduino.png
-    :target: http://www.ikravets.com/computer-life/platformio/2014/10/07/integration-of-platformio-library-manager-to-arduino-and-energia-ides

docs/ide/eclipse.rst

@@ -1,54 +0,0 @@
-.. _ide_eclipse:
-
-Eclipse
-=======
-
-The `Eclipse CDT (C/C++ Development Tooling) <https://eclipse.org/cdt/>`_
-Project provides a fully functional C and C++ Integrated Development
-Environment based on the Eclipse platform. Features include: support for
-project creation and managed build for various toolchains, standard make
-build, source navigation, various source knowledge tools, such as type
-hierarchy, call graph, include browser, macro definition browser, code editor
-with syntax highlighting, folding and hyperlink navigation, source code
-refactoring and code generation, visual debugging tools, including memory,
-registers, and disassembly viewers.
-
-This software can be used with:
-
-* all available :ref:`platforms`
-* all available :ref:`frameworks`
-
-Refer to the `CDT Documentation <https://eclipse.org/cdt/documentation.php>`_
-page for more detailed information.
-
-.. contents::
-
-Integration
------------
-
-Project Generator
-^^^^^^^^^^^^^^^^^
-
-Since PlatformIO 2.0 you can generate Eclipse compatible project using
-:option:`platformio init --ide` command:
-
-.. code-block:: shell
-
-    platformio init --ide eclipse
-
-Then import this project via ``File > Import... > General > Existing Projects
-into Workspace > Next`` and specify root directory where is located
-:ref:`projectconf`.
-
-Manual Integration
-^^^^^^^^^^^^^^^^^^
-
-More detailed information is located in PlatformIO blog: `Building and debugging Atmel AVR (Arduino-based) project using Eclipse IDE+PlatformIO <http://www.ikravets.com/computer-life/programming/2014/06/20/building-and-debugging-atmel-avr-arduino-based-project-using-eclipse-ideplatformio>`_.
-
-`More examples (TI MSP430, TI TIVA, etc.) <https://github.com/platformio/platformio/tree/develop/examples/ide-eclipse>`_
-
-Screenshot
-----------
-
-.. 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

docs/ide/energia.rst

@@ -1,30 +0,0 @@
-.. _ide_energia:
-
-Energia
-=======
-
-The open-source `Energia Software (IDE) <http://energia.nu>`_
-makes it easy to write code and upload it to the board. It runs on *Windows,
-Mac OS X, and Linux*. The environment is written in *Java* and based on
-*Processing* and other open-source software.
-
-This software can be used with:
-
-* :ref:`platform_timsp430`
-* :ref:`platform_titiva`
-* :ref:`framework_energia`
-
-Refer to the `Energia Getting Started <http://energia.nu/guide/>`_
-page for Installation instructions.
-
-Integration
------------
-
-More detailed information is located in PlatformIO blog:
-`Integration of PlatformIO library manager to Energia IDE <http://www.ikravets.com/computer-life/platformio/2014/10/07/integration-of-platformio-library-manager-to-arduino-and-energia-ides>`_.
-
-Screenshot
------------
-
-.. image:: ../_static/ide-platformio-energia.png
-    :target: http://www.ikravets.com/computer-life/platformio/2014/10/07/integration-of-platformio-library-manager-to-arduino-and-energia-ides

docs/ide/qtcreator.rst

@@ -1,129 +0,0 @@
-.. _ide_qtcreator:
-
-Qt Creator
-==========
-
-The `Qt Creator <https://github.com/qtproject/qt-creator>`_ is an open source cross-platform integrated development environment. The editor includes such features as syntax highlighting for various languages, project manager, integrated version control systems, rapid code navigation tools and code autocompletion.
-
-This software can be used with:
-
-* all available :ref:`platforms`
-* all available :ref:`frameworks`
-
-Refer to the `Qt-creator Manual <http://doc.qt.io/qtcreator/>`_
-page for more detailed information.
-
-.. contents::
-
-Integration
------------
-
-Project Generator
-^^^^^^^^^^^^^^^^^
-
-Since PlatformIO 2.0 you can generate Eclipse compatible project using
-:option:`platformio init --ide` command:
-
-.. code-block:: shell
-
-    platformio init --ide qtcreator
-
-Then import this project via ``File > New File or Project > Import Project``
-and specify root directory where is located :ref:`projectconf`.
-
-Manual Integration
-^^^^^^^^^^^^^^^^^^
-
-Setup New Project
-~~~~~~~~~~~~~~~~~
-
-First of all, let's create new project from Qt Creator Start Page: ``New Project`` or using ``Menu: File > New File or Project``, then select project with ``Empty Qt Project`` type (``Other Project > Empty Qt Project``), fill ``Name``, ``Create in``.
-
-.. image:: ../_static/ide-platformio-qtcreator-1.png
-
-On the next steps select any available kit and click Finish button.
-
-.. image:: ../_static/ide-platformio-qtcreator-2.png
-
-Secondly, we need to configure project with PlatformIO source code builder (click on Projects label on left menu or ``Ctrl+5`` shortcut):
-
-.. image:: ../_static/ide-platformio-qtcreator-3.png
-
-Thirdly, change project file by adding path to directories with header files. Please edit project file to match the following contents:
-
-.. code-block:: none
-
-    win32 {
-        HOMEDIR += $$(USERPROFILE)
-    }
-    else {
-        HOMEDIR += $$(PWD)
-    }
-
-    INCLUDEPATH += "$$HOMEDIR/.platformio/packages/framework-arduinoavr/cores/arduino"
-    INCLUDEPATH += "$$HOMEDIR/.platformio/packages/toolchain-atmelavr/avr/include"
-
-    win32:INCLUDEPATH ~= s,/,\\,g
-
-.. image:: ../_static/ide-platformio-qtcreator-4.png
-
-First program in Qt Creator
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Simple "Blink" project will consist from two files:
-1. In the console, navigate to the root of your project folder and initialize platformio project with ``platformio init``
-2. The main "C" source file named ``main.c`` must be located in the ``src`` directory.
-Let's create new text file named ``main.c`` using ``Menu: New File or Project > General > Text File``:
-
-.. image:: ../_static/ide-platformio-qtcreator-5.png
-
-Copy the source code which is described below to file ``main.c``.
-
-.. code-block:: c
-
-    #include "Arduino.h"
-    #define WLED    13  // Most Arduino boards already have an LED attached to pin 13 on the board itself
-
-    void setup()
-    {
-      pinMode(WLED, OUTPUT);  // set pin as output
-    }
-
-    void loop()
-    {
-      digitalWrite(WLED, HIGH);  // set the LED on
-      delay(1000);               // wait for a second
-      digitalWrite(WLED, LOW);   // set the LED off
-      delay(1000);               // wait for a second
-    }
-
-3. Locate the project configuration file named ``platformio.ini`` at the root of the project directory and open it.
-
-.. image:: ../_static/ide-platformio-qtcreator-6.png
-
-Edit the content to match the code described below.
-
-.. code-block:: none
-
-    #
-    # Project Configuration File
-    #
-    # A detailed documentation with the EXAMPLES is located here:
-    # http://docs.platformio.org/en/latest/projectconf.html
-    #
-
-    # A sign `#` at the beginning of the line indicates a comment
-    # Comment lines are ignored.
-
-    [env:arduino_uno]
-    platform = atmelavr
-    framework = arduino
-    board = uno
-
-
-Conclusion
-----------
-
-Taking everything into account, we can build project with shortcut ``Ctrl+Shift+B`` or using ``Menu: Build > Build All``:
-
-.. image:: ../_static/ide-platformio-qtcreator-7.png

docs/ide/sublimetext.rst

@@ -1,145 +0,0 @@
-.. _ide_sublimetext:
-
-Sublime Text
-============
-
-The `Sublime Text <http://www.sublimetext.com/>`_ is a cross-platform text and source code editor, with a Python application programming interface (API). Sublime Text is proprietary software. Its functionality is extendable with plugins. Most of the extending packages have free-software licenses and are community-built and maintained. Sublime Text lacks graphical setting dialogues and is entirely configured by editing text files.
-
-This software can be used with:
-
-* all available :ref:`platforms`
-* all available :ref:`frameworks`
-
-Refer to the `Sublime Text Documentation <http://docs.sublimetext.info/en/latest>`_
-page for more detailed information.
-
-.. contents::
-
-Integration
------------
-
-Project Generator
-^^^^^^^^^^^^^^^^^
-
-Since PlatformIO 2.0 you can generate Eclipse compatible project using
-:option:`platformio init --ide` command:
-
-.. code-block:: shell
-
-    platformio init --ide sublimetext
-
-Then import this project via ``Project > Open Project...`` and specify root
-directory where is located :ref:`projectconf`.
-
-Manual Integration
-^^^^^^^^^^^^^^^^^^
-
-Initial configuration
-~~~~~~~~~~~~~~~~~~~~~
-
-First of all, we need to create "New Build System" with name "PlatformIO"
-from ``Menu: Tools > Build System > New Build System`` and fill it like
-described below:
-
-.. code-block:: bash
-
-    {
-        "cmd": ["platformio", "run"],
-        "working_dir": "${project_path:${folder}}",
-        "variants":
-        [
-            {
-                "name": "Clean",
-                "cmd": ["platformio", "run", "-t", "clean"]
-            },
-            {
-                "name": "Upload",
-                "cmd": ["platformio", "run", "-t", "upload"]
-            }
-        ]
-    }
-
-Secondly, we need to select "PlatformIO" Build System from a list:
-
-.. image:: ../_static/ide-sublime-text-platformio-newproject-2.png
-
-After that, we can use the necessary commands from
-``Menu: Tools > Command Palette`` or with ``Ctrl+Shift+P`` (Windows/Linux)
-``Cmd+Shift+P`` (Mac) shortcut.
-
-.. image:: ../_static/ide-sublime-text-platformio-newproject-3.png
-
-Command Hotkeys
-'''''''''''''''
-
-Sublime Text allows to bind own hotkey per command. Let's setup them
-for PlatformIO commands using shortcut ``Menu: Preferences > Key-Bindings - User``:
-
-.. image:: ../_static/ide-sublime-text-platformio-newproject-4.png
-
-We are going to use these shortcuts:
-
-* ``F11`` for clean project
-* ``F12`` for upload firmware to target device
-
-In this case, the final code will look like:
-
-.. code-block:: none
-
-    [
-        { "keys": ["f11"], "command": "build", "args": {"variant": "Clean"} },
-        { "keys": ["f12"], "command": "build", "args": {"variant": "Upload"} }
-    ]
-
-First program in Sublime Text
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Simple "Blink" project will consist from two files:
-
-1. Main "C" source file named ``main.c`` must be located in the ``src`` directory.
-Let's create new file named ``main.c`` using ``Menu: File > New File`` or shortcut ``Ctrl+N`` (Windows/Linux) ``Cmd+N`` (Mac) with the next contents:
-
-.. code-block:: c
-
-    #include "Arduino.h"
-    #define WLED    13  // Most Arduino boards already have an LED attached to pin 13 on the board itself
-
-    void setup()
-    {
-      pinMode(WLED, OUTPUT);  // set pin as output
-    }
-
-    void loop()
-    {
-      digitalWrite(WLED, HIGH);  // set the LED on
-      delay(1000);               // wait for a second
-      digitalWrite(WLED, LOW);   // set the LED off
-      delay(1000);               // wait for a second
-    }
-
-2. Project Configuration File named ``platformio.ini`` must be located in the project root directory.
-Copy the source code which is described below to it.
-
-.. code-block:: none
-
-    #
-    # Project Configuration File
-    #
-    # A detailed documentation with the EXAMPLES is located here:
-    # http://docs.platformio.org/en/latest/projectconf.html
-    #
-
-    # A sign `#` at the beginning of the line indicates a comment
-    # Comment lines are ignored.
-
-    [env:arduino_uno]
-    platform = atmelavr
-    framework = arduino
-    board = uno
-
-Conclusion
-----------
-
-Taking everything into account, we can open project directory in Sublime Text using ``Menu: File > Open Folder`` and build it with shortcut ``Ctrl+B`` (Windows/Linux) or ``Cmd+B`` (Mac), clean project with shortcut ``F11`` and upload firmware to target with shortcut ``F12``.
-
-.. image:: ../_static/ide-sublime-text-platformio-newproject-5.png

docs/ide/vim.rst

@@ -1,46 +0,0 @@
-.. _ide_vim:
-
-VIM
-===
-
-`VIM <http://www.vim.org/>`_ is an open-source, powerful and configurable text
-editor. Vim is designed for use both from a command-line interface and as a
-standalone application in a graphical user interface.
-
-This software can be used with:
-
-* all available :ref:`platforms`
-* all available :ref:`frameworks`
-
-Integration
------------
-
-Recommended bundles:
-
-* Syntax highlight - `Arduino-syntax-file <https://github.com/vim-scripts/Arduino-syntax-file>`_
-* Code Completion - `YouCompleteMe <https://github.com/Valloric/YouCompleteMe>`_ (see configuration example by **Anthony Ford** `PlatformIO/YouCompleteMe Integration <https://gist.github.com/ajford/f551b2b6fd4d6b6e1ef2>`_)
-* Syntax checking - `Syntastic <https://github.com/scrooloose/syntastic>`_
-
-Put to the project directory ``Makefile`` wrapper with contents:
-
-.. code-block:: make
-
-    # Uncomment lines below if you have problems with $PATH
-    #SHELL := /bin/bash
-    #PATH := /usr/local/bin:$(PATH)
-
-    all:
-        platformio run -t upload
-
-    clean:
-        platformio run -t clean
-
-
-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,
-make firmware and upload it.
-
-Screenshot
-----------
-
-.. image:: ../_static/ide-platformio-vim.png

docs/ide/visualstudio.rst

@@ -1,124 +0,0 @@
-.. _ide_visualstudio:
-
-Visual Studio
-=============
-
-The `Microsoft Visual Studio (Free) <http://visualstudio.com/free>`_ is an integrated development environment (IDE) from Microsoft. Visual Studio includes a code editor supporting IntelliSense (the code completion component) as well as code refactoring.
-
-This software can be used with:
-
-* all available :ref:`platforms`
-* all available :ref:`frameworks`
-
-Refer to the `Visual Studio Documentation <https://msdn.microsoft.com/library/vstudio>`_
-page for more detailed information.
-
-.. contents::
-
-Integration
------------
-
-Project Generator
-^^^^^^^^^^^^^^^^^
-
-Since PlatformIO 2.0 you can generate Eclipse compatible project using
-:option:`platformio init --ide` command:
-
-.. code-block:: shell
-
-    platformio init --ide visualstudio
-
-Then import this project via ``File > Import ...`` and specify root directory
-where is located :ref:`projectconf`.
-
-Manual Integration
-^^^^^^^^^^^^^^^^^^
-
-Setup New Project
-~~~~~~~~~~~~~~~~~
-
-First of all, let's create new project from Visual Studio Start Page: ``Start > New Project`` or using ``Menu: File > New > Project``, then select project with ``Makefile`` type (``Visual C++ > General > Makefile Project``), fill ``Project name``, ``Solution name``, ``Location`` fields and press OK button.
-
-.. image:: ../_static/ide-vs-platformio-newproject.png
-
-Secondly, we need to configure project with PlatformIO source code builder:
-
-.. image:: ../_static/ide-vs-platformio-newproject-2.png
-
-If we want to use native AVR programming, we have to specify additional preprocessor symbol ("Preprocessor definitions" field) about your MCU. For example, an Arduino Uno is based on the ATmega328 MCU. In this case We will add new definition  ``__AVR_ATmega328__``.
-
-.. image:: ../_static/ide-vs-platformio-newproject-2-1.png
-
-Release Configuration is the same as Debug, so on the next step we check "Same as Debug Configuration" and click "Finish" button.
-
-.. image:: ../_static/ide-vs-platformio-newproject-3.png
-
-Thirdly, we need to add directories with header files using project properties (right click on the project name or ``Alt-Enter`` shortcut) and add two directories to ``Configuration Properties > NMake > Include Search Path``:
-
-.. code-block:: none
-
-    $(HOMEDRIVE)$(HOMEPATH)\.platformio\packages\toolchain-atmelavr\avr\include
-    $(HOMEDRIVE)$(HOMEPATH)\.platformio\packages\framework-arduinoavr\cores\arduino
-
-.. image:: ../_static/ide-vs-platformio-newproject-5.png
-
-First program in Visual Studio
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Simple "Blink" project will consist from two files:
-
-1. Main "C" source file named ``main.c`` must be located in the ``src`` directory.
-Let's create new file named ``main.c`` using ``Menu: File > New File`` or shortcut ``Ctrl+N``:
-
-.. image:: ../_static/ide-vs-platformio-newproject-6.png
-
-Copy the source code which is described below to file ``main.c``.
-
-.. code-block:: c
-
-    #include "Arduino.h"
-    #define WLED    13  // Most Arduino boards already have an LED attached to pin 13 on the board itself
-
-    void setup()
-    {
-      pinMode(WLED, OUTPUT);  // set pin as output
-    }
-
-    void loop()
-    {
-      digitalWrite(WLED, HIGH);  // set the LED on
-      delay(1000);               // wait for a second
-      digitalWrite(WLED, LOW);   // set the LED off
-      delay(1000);               // wait for a second
-    }
-
-2. Project Configuration File named ``platformio.ini`` must be located in the project root directory.
-
-.. image:: ../_static/ide-vs-platformio-newproject-7.png
-
-Copy the source code which is described below to it.
-
-.. code-block:: none
-
-    #
-    # Project Configuration File
-    #
-    # A detailed documentation with the EXAMPLES is located here:
-    # http://docs.platformio.org/en/latest/projectconf.html
-    #
-
-    # A sign `#` at the beginning of the line indicates a comment
-    # Comment lines are ignored.
-
-    [env:arduino_uno]
-    platform = atmelavr
-    framework = arduino
-    board = uno
-
-
-Conclusion
-----------
-
-Taking everything into account, we can build project with shortcut ``Ctrl+Shift+B`` or using ``Menu: Build > Build Solution``:
-
-.. image:: ../_static/ide-vs-platformio-newproject-8.png

docs/index.rst

@@ -1,71 +0,0 @@
-PlatformIO: A cross-platform code builder and the missing library manager
-=========================================================================
-
-*Atmel AVR & SAM, Espressif, Freescale Kinetis, Nordic nRF51, NXP LPC, ST STM32,
-TI MSP430 & Tiva, Teensy, Arduino, mbed, libOpenCM3, etc.*
-
-.. image:: _static/platformio-logo.png
-    :target: http://platformio.org
-
-* `Website <http://platformio.org>`_
-* `Web 2.0 Library Search <http://platformio.org/#!/lib>`_ |
-  `Embedded Boards Explorer <http://platformio.org/#!/boards>`_
-* `Project Examples <https://github.com/platformio/platformio/tree/develop/examples>`_
-* `Source Code <https://github.com/platformio/platformio>`_ |
-  `Issues <https://github.com/platformio/platformio/issues>`_
-* `Blog <http://www.ikravets.com/category/computer-life/platformio>`_ |
-  `Reddit <http://www.reddit.com/r/platformio/>`_ |
-  `Twitter <https://twitter.com/PlatformIO_Org>`_
-
-You have **no need** to install any *IDE* or compile any tool chains. *PlatformIO*
-has pre-built different development platforms and pre-configured settings for
-the most popular embedded boards. For further details, please
-refer to :ref:`faq_what_is_platformio`
-
-Embedded Development. *Easier Than Ever.*
------------------------------------------
-
-* Colourful command-line output
-* Built-in :ref:`Serial Port Monitor <cmd_serialports_monitor>`
-* Configurable build :ref:`-flags/-options <projectconf_build_flags>`
-* Integration with :ref:`development environments (IDE) <ide>`
-* Ready for Cloud Compiling and :ref:`ci`
-* Pre-built tool chains, :ref:`frameworks` for the popular Hardware Platforms
-
-Smart Code Builder. *Fast and Reliable.*
-----------------------------------------
-
-* Reliable, automatic dependency analysis and detection of build changes
-* Improved support for parallel builds
-* Ability to share built files in a cache
-* Lookup for external libraries which are installed via :ref:`librarymanager`
-
-The Missing Library Manager. *It's here!*
------------------------------------------
-
-* Friendly Command-Line Interface
-* Modern `Web 2.0 Library Search <http://platformio.org/#!/lib>`_
-* Library dependency management
-* Automatic library updating
-* It runs on Windows, Mac OS X, and Linux (+ARM).
-
-
-Contents
---------
-
-.. toctree::
-    :maxdepth: 2
-
-    quickstart
-    installation
-    projectconf
-    envvars
-    Platforms & Boards <platforms/index>
-    frameworks/index
-    librarymanager/index
-    userguide/index
-    ci/index
-    ide
-    articles
-    FAQ <faq>
-    history

docs/installation.rst

@@ -1,139 +0,0 @@
-.. _installation:
-
-Installation
-============
-
-**PlatformIO** is written in `Python <https://www.python.org/downloads/>`_ and
-works on Mac OS X, Linux, Windows OS and *ARM*-based credit-card sized
-computers (`Raspberry Pi <http://www.raspberrypi.org>`_,
-`BeagleBone <http://beagleboard.org>`_,
-`CubieBoard <http://cubieboard.org>`_).
-
-.. contents::
-
-System requirements
--------------------
-
-* **Operating systems:**
-    * Mac OS X
-    * Linux, +ARM
-    * Windows
-* `Python 2.6 or Python 2.7 <https://www.python.org/downloads/>`_
-
-All commands below should be executed in
-`Command-line <http://en.wikipedia.org/wiki/Command-line_interface>`_
-application:
-
-* *Mac OS X / Linux* this is *Terminal* application.
-* *Windows* this is
-  `Command Prompt <http://en.wikipedia.org/wiki/Command_Prompt>`_ (``cmd.exe``)
-  application.
-
-.. warning::
-    If you are going to run *PlatformIO* from **subprocess**, you
-    :ref:`MUST DISABLE <faq_troubleshooting_pioblocksprompt>` all prompts.
-    It will allow you to avoid blocking.
-
-
-Troubleshooting
----------------
-
-For further details, frequently questions, please refer to :ref:`faq`.
-
-Installation Methods
---------------------
-
-Please *choose one of* the following installation methods:
-
-Super-Quick (Mac / Linux)
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-To install or upgrade *PlatformIO* paste that at a *Terminal* prompt
-(**you might need** to run ``sudo`` first):
-
-.. code-block:: bash
-
-    python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
-
-
-Installer Script (Mac / Linux / Windows)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-To install or upgrade *PlatformIO*, download
-`get-platformio.py <https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py>`_
-script. Then run the following (you might need to run ``sudo`` first):
-
-.. code-block:: bash
-
-    python get-platformio.py
-
-
-On *Windows OS* it may look like:
-
-.. code-block:: bash
-
-    C:\Python27\python.exe get-platformio.py
-
-Full Guide
-~~~~~~~~~~
-
-1. Check a ``python`` version (only 2.6-2.7 is supported):
-
-.. code-block:: bash
-
-    $ python --version
-
-*Windows OS* Users only:
-
-    * `Download Python 2.7 <https://www.python.org/downloads/>`_ and install it.
-    * Add to PATH system variable ``;C:\Python27;C:\Python27\Scripts;`` and
-       reopen *Command Prompt* (``cmd.exe``) application. Please read this
-       article `How to set the path and environment variables in Windows
-       <http://www.computerhope.com/issues/ch000549.htm>`_.
-
-
-2. Check a ``pip`` tool for installing and managing *Python* packages:
-
-.. code-block:: bash
-
-    $ pip search platformio
-
-You should see short information about ``platformio`` package.
-
-If your computer does not recognize ``pip`` command, try to install it first
-using `these instructions <https://pip.pypa.io/en/latest/installing.html>`_.
-
-3. Install a ``platformio`` and related packages:
-
-.. code-block:: bash
-
-    $ pip install platformio && pip install --egg scons
-
-For upgrading the ``platformio`` to new version please use this command:
-
-.. code-block:: bash
-
-    $ pip install -U platformio
-
-
-Development Version
-~~~~~~~~~~~~~~~~~~~
-
-.. warning::
-    We don't recommend to use ``develop`` version in production.
-
-1. If you had have already installed PlatformIO, please uninstall it:
-
-.. code-block:: bash
-
-    $ pip uninstall platformio
-
-2. Install the latest PlatformIO from the ``develop`` branch:
-
-.. code-block:: bash
-
-    $ pip install https://github.com/platformio/platformio/archive/develop.zip
-
-If you want to be up-to-date with the latest ``develop`` version of PlatformIO,
-then you need to perform step #2 each time if you see the new commits in
-`PlatformIO GitHub repository <https://github.com/platformio/platformio/commits/develop>`_.

docs/librarymanager/config.rst

@@ -1,317 +0,0 @@
-.. |PIOAPICR| replace:: *PlatformIO Library Registry Crawler*
-.. _library_config:
-
-library.json
-============
-
-``library.json`` is a manifest file of development library.
-
-Initially it was
-developed for :ref:`librarymanager`, but later was accepted by worldwide embedded
-community like a **standard library specification**.
-
-A data in ``library.json`` should be represented
-in `JSON-style <http://en.wikipedia.org/wiki/JSON>`_ via
-`associative array <http://en.wikipedia.org/wiki/Associative_array>`_
-(name/value pairs). An order doesn't matter. The allowable fields
-(names from pairs) are described below.
-
-.. contents::
-
-.. _libjson_name:
-
-``name``
---------
-
-**Required** | Type: ``String`` | Max. Length: 50
-
-A name of the library.
-
-* Must be unique.
-* Should be slug style for simplicity, consistency and compatibility.
-  Example: *Arduino-SPI*
-* Title Case, Aa-z, can contain digits and dashes (but not start/end
-  with them).
-* Consecutive dashes are not allowed.
-
-
-.. _libjson_description:
-
-``description``
----------------
-
-**Required** | Type: ``String`` | Max. Length: 255
-
-The field helps users to identify and search for your library with a brief
-description. Describe the hardware devices (sensors, boards and etc.) which
-are suitable with it.
-
-
-.. _libjson_keywords:
-
-``keywords``
-------------
-
-**Required** | Type: ``String`` | Max. Length: 255
-
-Used for search by keyword. Helps to make your library easier to discover
-without people needing to know its name.
-
-The keyword should be lowercased, can contain a-z, digits and dash (but not
-start/end with them). A list from the keywords can be specified with
-separator ``,``
-
-
-.. _libjson_authors:
-
-``authors``
------------
-
-*Required* if :ref:`libjson_repository` field is not defined | Type: ``Object``
-or ``Array``
-
-An author contact information
-
-* ``name`` Full name (**Required**)
-* ``email``
-* ``url`` An author's contact page
-* ``maintainer`` Specify "maintainer" status
-
-Examples:
-
-.. code-block:: javascript
-
-    "authors":
-    {
-        "name": "John Smith",
-        "email": "me@john-smith.com",
-        "url": "http://www.john-smith/contact"
-    }
-
-    ...
-
-    "authors":
-    [
-        {
-            "name": "John Smith",
-            "email": "me@john-smith.com",
-            "url": "http://www.john-smith/contact"
-        },
-        {
-            "name": "Andrew Smith",
-            "email": "me@andrew-smith.com",
-            "url": "http://www.andrew-smith/contact",
-            "maintainer": true
-        }
-    ]
-
-
-.. note::
-    You can omit :ref:`libjson_authors` field and define
-    :ref:`libjson_repository` field. Only *GitHub-based* repository is
-    supported now. In this case
-    |PIOAPICR| will use information from
-    `GitHub API Users <https://developer.github.com/v3/users/>`_.
-
-
-.. _libjson_repository:
-
-``repository``
---------------
-
-*Required* if :ref:`libjson_downloadurl` field is not defined | Type: ``Object``
-
-The repository in which the source code can be found.
-
-Example:
-
-.. code-block:: javascript
-
-    "repository":
-    {
-        "type": "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:
-
-``version``
------------
-
-*Required* if :ref:`libjson_repository` field is not defined | Type: ``String``
-| Max. Length: 20
-
-A version of the current library source code.
-
-* Can contain a-z, digits, dots or dash.
-* `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
-  chars of *SHA* digest ``e4564b7da4`` (*Git*).
-
-.. note::
-    You can omit :ref:`libjson_version` field and define
-    :ref:`libjson_repository` field. In this case
-    |PIOAPICR| will use the *CVS*-revision from the latest commit.
-
-
-.. _libjson_url:
-
-``url``
--------
-
-*Optional* | Type: ``String`` | Max. Length: 255
-
-Home page of library (if is different from :ref:`libjson_repository` url).
-
-
-.. _libjson_include:
-
-``include``
------------
-
-*Optional* | Type: ``String`` or ``Array`` |
-`Glob Pattern <http://en.wikipedia.org/wiki/Glob_(programming)>`_
-
-If :ref:`libjson_include` field is a type of ``String``, then
-|PIOAPICR| will recognize it like a "relative path inside
-repository/archive to library source code". See example below where the only
-source code from the relative directory ``LibrarySourceCodeHere`` will be
-included.
-
-.. code-block:: javascript
-
-    "include": "some/child/dir/LibrarySourceCodeHere"
-
-If :ref:`libjson_include` field is a type of ``Array``, then
-|PIOAPICR| firstly will apply :ref:`libjson_exclude` filter and
-then include only directories/files which match with :ref:`libjson_include`
-patterns.
-
-Example:
-
-.. code-block:: javascript
-
-    "include":
-    [
-        "dir/*.[ch]pp",
-        "dir/examples/*",
-        "*/*/*.h"
-    ]
-
-Pattern	Meaning
-
-.. list-table::
-    :header-rows:  1
-
-    * - Pattern
-      - Meaning
-    * - ``*``
-      - matches everything
-    * - ``?``
-      - matches any single character
-    * - ``[seq]``
-      - matches any character in seq
-    * - ``[!seq]``
-      - matches any character not in seq
-
-
-.. _libjson_exclude:
-
-``exclude``
------------
-
-*Optional* | Type: ``String`` or ``Array`` |
-`Glob Pattern <http://en.wikipedia.org/wiki/Glob_(programming)>`_
-
-Exclude the directories and files which match with :ref:`libjson_exclude`
-patterns.
-
-.. _libjson_frameworks:
-
-``frameworks``
---------------
-
-*Optional* | Type: ``String`` or ``Array``
-
-A list with compatible frameworks. The available framework types are defined in
-the :ref:`platforms` section.
-
-
-.. _libjson_platforms:
-
-``platforms``
--------------
-
-*Optional* | Type: ``String`` or ``Array``
-
-A list with compatible platforms. The available platform types are
-defined in :ref:`platforms` section.
-
-
-.. _libjson_dependencies:
-
-``dependencies``
-----------------
-
-*Optional* | Type: ``Array`` or ``Object``
-
-A list of dependent libraries. They will be installed automatically with
-:ref:`cmd_lib_install` command.
-
-Allowed requirements for dependent library:
-
-* ``name`` | Type: ``String``
-* ``authors`` | Type: ``String`` or ``Array``
-* ``frameworks`` | Type: ``String`` or ``Array``
-* ``platforms`` | Type: ``String`` or ``Array``
-
-Example:
-
-.. code-block:: javascript
-
-    "dependencies":
-    [
-        {
-            "name": "Library-Foo",
-            "authors":
-            [
-                "Jhon Smith",
-                "Andrew Smith"
-            ]
-        },
-        {
-            "name": "Library-Bar",
-            "frameworks": "FrameworkFoo, FrameworkBar"
-        }
-    ]
-
-
-.. _libjson_examples:
-
-``examples``
-----------------
-
-*Optional* | Type: ``String`` or ``Array`` |
-`Glob Pattern <http://en.wikipedia.org/wiki/Glob_(programming)>`_
-
-A list of example patterns. This field is predefined with default value:
-
-.. code-block:: javascript
-
-    "examples": [
-        "[Ee]xamples/*/*.ini",
-        "[Ee]xamples/*/*.pde"
-    ]

docs/librarymanager/creating.rst

@@ -1,137 +0,0 @@
-.. _library_creating:
-.. |PIOAPICR| replace:: *PlatformIO Library Registry Crawler*
-
-Creating Library
-================
-
-*PlatformIO* :ref:`librarymanager` doesn't have any requirements to a library
-source code structure. The only one requirement is library's manifest file -
-:ref:`library_config`. It can be located inside your library or in the another
-location where |PIOAPICR| will have *HTTP* access.
-
-.. contents::
-
-Source Code Location
---------------------
-
-There are a several ways how to share your library with the whole world
-(see `examples <https://github.com/platformio/platformio-libmirror/tree/master/configs>`_).
-
-You can hold a lot of libraries (split into separated folders) inside one of
-the repository/archive. In this case please use :ref:`libjson_include`
-field to specify the relative path to your library's source code.
-
-
-At GitHub
-^^^^^^^^^
-
-**Recommended**
-
-If a library source code is located at `GitHub <https://github.com>`_, then
-you **need to specify** only these fields in the :ref:`library_config`:
-
-* :ref:`libjson_name`
-* :ref:`libjson_keywords`
-* :ref:`libjson_description`
-* :ref:`libjson_repository`
-
-|PIOAPICR| will populate the rest fields, like :ref:`libjson_version` or
-:ref:`libjson_authors` with an actual information from *GitHub*.
-
-Example:
-
-.. code-block:: javascript
-
-    {
-        "name": "IRremote",
-        "keywords": "infrared, ir, remote",
-        "description": "Send and receive infrared signals with multiple protocols",
-        "repository":
-        {
-            "type": "git",
-            "url": "https://github.com/shirriff/Arduino-IRremote.git"
-        },
-        "frameworks": "arduino",
-        "platforms": "atmelavr"
-    }
-
-Under CVS (SVN/GIT)
-^^^^^^^^^^^^^^^^^^^
-
-|PIOAPICR| can operate with a library source code that is under *CVS* control.
-The list of **required** fields in the :ref:`library_config` will look like:
-
-* :ref:`libjson_name`
-* :ref:`libjson_keywords`
-* :ref:`libjson_description`
-* :ref:`libjson_authors`
-* :ref:`libjson_repository`
-
-Example:
-
-.. code-block:: javascript
-
-    {
-        "name": "XBee",
-        "keywords": "xbee, protocol, radio",
-        "description": "Arduino library for communicating with XBees in API mode",
-        "authors":
-        {
-            "name": "Andrew Rapp",
-            "email": "andrew.rapp@gmail.com",
-            "url": "https://code.google.com/u/andrew.rapp@gmail.com/"
-        },
-        "repository":
-        {
-            "type": "git",
-            "url": "https://code.google.com/p/xbee-arduino/"
-        },
-        "frameworks": "arduino",
-        "platforms": "atmelavr"
-    }
-
-Self-hosted
-^^^^^^^^^^^
-
-You can manually archive (*Zip, Tar.Gz*) your library source code and host it
-in the *Internet*. Then you should specify the additional fields,
-like :ref:`libjson_version` and :ref:`libjson_downloadurl`. The final list
-of **required** fields in the :ref:`library_config` will look like:
-
-* :ref:`libjson_name`
-* :ref:`libjson_keywords`
-* :ref:`libjson_description`
-* :ref:`libjson_authors`
-* :ref:`libjson_version`
-* :ref:`libjson_downloadurl`
-
-.. code-block:: javascript
-
-    {
-        "name": "OneWire",
-        "keywords": "onewire, 1-wire, bus, sensor, temperature, ibutton",
-        "description": "Control devices (from Dallas Semiconductor) that use the One Wire protocol (DS18S20, DS18B20, DS2408 and etc)",
-        "authors":
-        {
-            "name": "Paul Stoffregen",
-            "url": "http://www.pjrc.com/teensy/td_libs_OneWire.html"
-        },
-        "version": "2.2",
-        "downloadUrl": "http://www.pjrc.com/teensy/arduino_libraries/OneWire.zip",
-        "include": "OneWire",
-        "frameworks": "arduino",
-        "platforms": "atmelavr"
-    }
-
-
-Register
---------
-
-The registration requirements:
-
-* A library must adhere to the :ref:`library_config` specification.
-* There must be public *HTTP* access to the library :ref:`library_config` file.
-
-Now, you can :ref:`register <cmd_lib_register>` your library and allow others
-to :ref:`install <cmd_lib_install>` it.
-

docs/librarymanager/index.rst

@@ -1,25 +0,0 @@
-.. _librarymanager:
-
-Library Manager
-===============
-
-..
-
-    *"The missing library manager for development platforms"* [#]_
-
-*PlatformIO Library Manager* allows you to organize external embedded libraries.
-You can search for new libraries via :ref:`Command Line interface <cmd_lib_search>`
-or `Web 2.0 Library Search <http://platformio.org/#!/lib>`_.
-
-You don't need to bother for finding the latest version of library. Due to
-:ref:`cmd_lib_update` command you will have up-to-date external libraries.
-
-.. toctree::
-    :maxdepth: 2
-
-    config
-    creating
-    User Guide <../userguide/lib/index.rst>
-
-.. [#] Inspired by `npm <https://www.npmjs.com/>`_ and `bower
-    <http://bower.io>`_ package managers for web.

docs/make.bat

@@ -1,242 +0,0 @@
-@ECHO OFF
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set BUILDDIR=_build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
-set I18NSPHINXOPTS=%SPHINXOPTS% .
-if NOT "%PAPER%" == "" (
-	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
-	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
-)
-
-if "%1" == "" goto help
-
-if "%1" == "help" (
-	:help
-	echo.Please use `make ^<target^>` where ^<target^> is one of
-	echo.  html       to make standalone HTML files
-	echo.  dirhtml    to make HTML files named index.html in directories
-	echo.  singlehtml to make a single large HTML file
-	echo.  pickle     to make pickle files
-	echo.  json       to make JSON files
-	echo.  htmlhelp   to make HTML files and a HTML help project
-	echo.  qthelp     to make HTML files and a qthelp project
-	echo.  devhelp    to make HTML files and a Devhelp project
-	echo.  epub       to make an epub
-	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
-	echo.  text       to make text files
-	echo.  man        to make manual pages
-	echo.  texinfo    to make Texinfo files
-	echo.  gettext    to make PO message catalogs
-	echo.  changes    to make an overview over all changed/added/deprecated items
-	echo.  xml        to make Docutils-native XML files
-	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
-	echo.  linkcheck  to check all external links for integrity
-	echo.  doctest    to run all doctests embedded in the documentation if enabled
-	goto end
-)
-
-if "%1" == "clean" (
-	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
-	del /q /s %BUILDDIR%\*
-	goto end
-)
-
-
-%SPHINXBUILD% 2> nul
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-if "%1" == "html" (
-	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
-	goto end
-)
-
-if "%1" == "dirhtml" (
-	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
-	goto end
-)
-
-if "%1" == "singlehtml" (
-	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
-	goto end
-)
-
-if "%1" == "pickle" (
-	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can process the pickle files.
-	goto end
-)
-
-if "%1" == "json" (
-	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can process the JSON files.
-	goto end
-)
-
-if "%1" == "htmlhelp" (
-	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in %BUILDDIR%/htmlhelp.
-	goto end
-)
-
-if "%1" == "qthelp" (
-	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PlatformIO.qhcp
-	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PlatformIO.ghc
-	goto end
-)
-
-if "%1" == "devhelp" (
-	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished.
-	goto end
-)
-
-if "%1" == "epub" (
-	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The epub file is in %BUILDDIR%/epub.
-	goto end
-)
-
-if "%1" == "latex" (
-	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
-	goto end
-)
-
-if "%1" == "latexpdf" (
-	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
-	cd %BUILDDIR%/latex
-	make all-pdf
-	cd %BUILDDIR%/..
-	echo.
-	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
-	goto end
-)
-
-if "%1" == "latexpdfja" (
-	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
-	cd %BUILDDIR%/latex
-	make all-pdf-ja
-	cd %BUILDDIR%/..
-	echo.
-	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
-	goto end
-)
-
-if "%1" == "text" (
-	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The text files are in %BUILDDIR%/text.
-	goto end
-)
-
-if "%1" == "man" (
-	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The manual pages are in %BUILDDIR%/man.
-	goto end
-)
-
-if "%1" == "texinfo" (
-	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
-	goto end
-)
-
-if "%1" == "gettext" (
-	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
-	goto end
-)
-
-if "%1" == "changes" (
-	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.The overview file is in %BUILDDIR%/changes.
-	goto end
-)
-
-if "%1" == "linkcheck" (
-	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Link check complete; look for any errors in the above output ^
-or in %BUILDDIR%/linkcheck/output.txt.
-	goto end
-)
-
-if "%1" == "doctest" (
-	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Testing of doctests in the sources finished, look at the ^
-results in %BUILDDIR%/doctest/output.txt.
-	goto end
-)
-
-if "%1" == "xml" (
-	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The XML files are in %BUILDDIR%/xml.
-	goto end
-)
-
-if "%1" == "pseudoxml" (
-	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
-	goto end
-)
-
-:end

docs/platforms/atmelavr.rst

@@ -1,844 +0,0 @@
-.. _platform_atmelavr:
-
-Platform ``atmelavr``
-=====================
-Atmel AVR 8- and 32-bit MCUs deliver a unique combination of performance, power efficiency and design flexibility. Optimized to speed time to market-and easily adapt to new ones-they are based on the industrys most code-efficient architecture for C and assembly programming.
-
-For more detailed information please visit `vendor site <http://www.atmel.com/products/microcontrollers/avr/default.aspx>`_.
-
-.. contents::
-
-Packages
---------
-
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Contents
-
-    * - ``toolchain-atmelavr``
-      - `avr-gcc <https://gcc.gnu.org/wiki/avr-gcc>`_, `GDB <http://www.gnu.org/software/gdb/>`_, `AVaRICE <http://avarice.sourceforge.net/>`_, `SimulAVR <http://www.nongnu.org/simulavr/>`_
-
-    * - ``tool-avrdude``
-      - `AVRDUDE <http://www.nongnu.org/avrdude/>`_
-
-    * - ``framework-arduinoavr``
-      - `Arduino Wiring-based Framework (AVR Core, 1.6) <http://arduino.cc/en/Reference/HomePage>`_
-
-    * - ``tool-micronucleus``
-      - `Micronucleus <https://github.com/micronucleus/micronucleus>`_
-
-.. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
-
-
-
-Frameworks
-----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`framework_arduino`
-      - Arduino Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by
-      horizontal.
-
-Adafruit
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``flora8``
-      - `Adafruit Flora <http://www.adafruit.com/product/659>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``protrinket3``
-      - `Adafruit Pro Trinket 3V/12MHz (USB) <http://www.adafruit.com/products/2010>`_
-      - ATMEGA328P
-      - 12 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``protrinket3ftdi``
-      - `Adafruit Pro Trinket 3V/12MHz (FTDI) <http://www.adafruit.com/products/2010>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``protrinket5``
-      - `Adafruit Pro Trinket 5V/16MHz (USB) <http://www.adafruit.com/products/2000>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``protrinket5ftdi``
-      - `Adafruit Pro Trinket 5V/16MHz (USB) <http://www.adafruit.com/products/2000>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``trinket3``
-      - `Adafruit Trinket 3V/8MHz <http://www.adafruit.com/products/1500>`_
-      - ATTINY85
-      - 8 MHz
-      - 8 Kb
-      - 0.5 Kb
-
-    * - ``trinket5``
-      - `Adafruit Trinket 5V/16MHz <http://www.adafruit.com/products/1501>`_
-      - ATTINY85
-      - 16 MHz
-      - 8 Kb
-      - 0.5 Kb
-
-Arduino
-~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``LilyPadUSB``
-      - `Arduino LilyPad USB <http://arduino.cc/en/Main/ArduinoBoardLilyPadUSB>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``atmegangatmega168``
-      - `Arduino NG or older ATmega168 <http://arduino.cc/en/main/boards>`_
-      - ATMEGA168
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``atmegangatmega8``
-      - `Arduino NG or older ATmega8 <http://arduino.cc/en/main/boards>`_
-      - ATMEGA8
-      - 16 MHz
-      - 8 Kb
-      - 1 Kb
-
-    * - ``btatmega168``
-      - `Arduino BT ATmega168 <http://arduino.cc/en/main/boards>`_
-      - ATMEGA168
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``btatmega328``
-      - `Arduino BT ATmega328 <http://arduino.cc/en/main/boards>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``diecimilaatmega168``
-      - `Arduino Duemilanove or Diecimila ATmega168 <http://arduino.cc/en/Main/ArduinoBoardDiecimila>`_
-      - ATMEGA168
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``diecimilaatmega328``
-      - `Arduino Duemilanove or Diecimila ATmega328 <http://arduino.cc/en/Main/ArduinoBoardDiecimila>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``esplora``
-      - `Arduino Esplora <http://arduino.cc/en/Main/ArduinoBoardEsplora>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``ethernet``
-      - `Arduino Ethernet <http://arduino.cc/en/Main/ArduinoBoardEthernet>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``fio``
-      - `Arduino Fio <http://arduino.cc/en/Main/ArduinoBoardFio>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``leonardo``
-      - `Arduino Leonardo <http://arduino.cc/en/Main/arduinoBoardLeonardo>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``lilypadatmega168``
-      - `Arduino LilyPad ATmega168 <http://arduino.cc/en/Main/ArduinoBoardLilyPad>`_
-      - ATMEGA168
-      - 8 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``lilypadatmega328``
-      - `Arduino LilyPad ATmega328 <http://arduino.cc/en/Main/ArduinoBoardLilyPad>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``megaADK``
-      - `Arduino Mega ADK <http://arduino.cc/en/Main/ArduinoBoardMegaADK>`_
-      - ATMEGA2560
-      - 16 MHz
-      - 256 Kb
-      - 8 Kb
-
-    * - ``megaatmega1280``
-      - `Arduino Mega or Mega 2560 ATmega1280 <http://arduino.cc/en/Main/arduinoBoardMega>`_
-      - ATMEGA1280
-      - 16 MHz
-      - 128 Kb
-      - 8 Kb
-
-    * - ``megaatmega2560``
-      - `Arduino Mega or Mega 2560 ATmega2560 (Mega 2560) <http://arduino.cc/en/Main/arduinoBoardMega2560>`_
-      - ATMEGA2560
-      - 16 MHz
-      - 256 Kb
-      - 8 Kb
-
-    * - ``micro``
-      - `Arduino Micro <http://arduino.cc/en/Main/ArduinoBoardMicro>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``miniatmega168``
-      - `Arduino Mini ATmega168 <http://arduino.cc/en/Main/ArduinoBoardMini>`_
-      - ATMEGA168
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``miniatmega328``
-      - `Arduino Mini ATmega328 <http://arduino.cc/en/Main/ArduinoBoardMini>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``nanoatmega168``
-      - `Arduino Nano ATmega168 <http://arduino.cc/en/Main/ArduinoBoardNano>`_
-      - ATMEGA168
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``nanoatmega328``
-      - `Arduino Nano ATmega328 <http://arduino.cc/en/Main/ArduinoBoardNano>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``pro16MHzatmega168``
-      - `Arduino Pro or Pro Mini ATmega168 (5V, 16 MHz) <http://arduino.cc/en/Main/ArduinoBoardProMini>`_
-      - ATMEGA168
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``pro16MHzatmega328``
-      - `Arduino Pro or Pro Mini ATmega328 (5V, 16 MHz) <http://arduino.cc/en/Main/ArduinoBoardProMini>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``pro8MHzatmega168``
-      - `Arduino Pro or Pro Mini ATmega168 (3.3V, 8 MHz) <http://arduino.cc/en/Main/ArduinoBoardProMini>`_
-      - ATMEGA168
-      - 8 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``pro8MHzatmega328``
-      - `Arduino Pro or Pro Mini ATmega328 (3.3V, 8 MHz) <http://arduino.cc/en/Main/ArduinoBoardProMini>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``robotControl``
-      - `Arduino Robot Control <http://arduino.cc/en/Main/Robot>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``robotMotor``
-      - `Arduino Robot Motor <http://arduino.cc/en/Main/Robot>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``uno``
-      - `Arduino Uno <http://arduino.cc/en/Main/ArduinoBoardUno>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``yun``
-      - `Arduino Yun <http://arduino.cc/en/Main/ArduinoBoardYun>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-BQ
-~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``zumbt328``
-      - `BQ ZUM BT-328 board <http://www.bq.com/gb/products/zum.html>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-BitWizard
-~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``raspduino``
-      - `BitWizard Raspduino <http://www.bitwizard.nl/wiki/index.php/Raspduino>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-Digistump
-~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``digispark-pro``
-      - `Digistump Digispark Pro (Default 16 MHz) <http://digistump.com/products/109>`_
-      - ATTINY167
-      - 16 MHz
-      - 16 Kb
-      - 0.5 Kb
-
-    * - ``digispark-pro32``
-      - `Digistump Digispark Pro (16 MHz) (32 byte buffer) <http://digistump.com/products/109>`_
-      - ATTINY167
-      - 16 MHz
-      - 16 Kb
-      - 0.5 Kb
-
-    * - ``digispark-pro64``
-      - `Digistump Digispark Pro (16 MHz) (64 byte buffer) <http://digistump.com/products/109>`_
-      - ATTINY167
-      - 16 MHz
-      - 16 Kb
-      - 0.5 Kb
-
-    * - ``digispark-tiny``
-      - `Digistump Digispark (Default - 16 MHz) <http://digistump.com/products/1>`_
-      - ATTINY85
-      - 16 MHz
-      - 8 Kb
-      - 0.5 Kb
-
-Engduino
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``engduinov1``
-      - `Engduino 1 <http://www.engduino.org>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``engduinov2``
-      - `Engduino 2 <http://www.engduino.org>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``engduinov3``
-      - `Engduino 3 <http://www.engduino.org>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-LightUp
-~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lightup``
-      - `LightUp <https://www.lightup.io/>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-LowPowerLab
-~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``moteino``
-      - `LowPowerLab Moteino <https://lowpowerlab.com/shop/moteino-r4>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``moteinomega``
-      - `LowPowerLab MoteinoMEGA <http://lowpowerlab.com/blog/2014/08/09/moteinomega-available-now/>`_
-      - ATMEGA1284P
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb
-
-Microduino
-~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``1284p16m``
-      - `Microduino Core+ (ATmega1284P@16M,5V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core%2B>`_
-      - ATMEGA1284P
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``1284p8m``
-      - `Microduino Core+ (ATmega1284P@8M,3.3V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core%2B>`_
-      - ATMEGA1284P
-      - 8 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``168pa16m``
-      - `Microduino Core (Atmega168PA@16M,5V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core>`_
-      - ATMEGA168P
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``168pa8m``
-      - `Microduino Core (Atmega168PA@8M,3.3V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core>`_
-      - ATMEGA168P
-      - 8 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``328p16m``
-      - `Microduino Core (Atmega328P@16M,5V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``328p8m``
-      - `Microduino Core (Atmega328P@8M,3.3V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``32u416m``
-      - `Microduino Core USB (ATmega32U4@16M,5V) <https://www.microduino.cc/wiki/index.php?title=Microduino-CoreUSB>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``644pa16m``
-      - `Microduino Core+ (Atmega644PA@16M,5V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core%2B>`_
-      - ATMEGA644P
-      - 16 MHz
-      - 64 Kb
-      - 4 Kb
-
-    * - ``644pa8m``
-      - `Microduino Core+ (Atmega644PA@8M,3.3V) <https://www.microduino.cc/wiki/index.php?title=Microduino-Core%2B>`_
-      - ATMEGA644P
-      - 8 MHz
-      - 64 Kb
-      - 4 Kb
-
-PanStamp
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``panStampAVR``
-      - `PanStamp AVR <http://www.panstamp.com/product/panstamp-avr/>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-Quirkbot
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``quirkbot``
-      - `Quirkbot <http://quirkbot.com>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-RedBearLab
-~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``blend``
-      - `RedBearLab Blend <http://redbearlab.com/blend/>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``blendmicro16``
-      - `RedBearLab Blend Micro 3.3V/16MHz (overclock) <http://redbearlab.com/blendmicro/>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``blendmicro8``
-      - `RedBearLab Blend Micro 3.3V/8MHz <http://redbearlab.com/blendmicro/>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-RepRap
-~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``reprap_rambo``
-      - `RepRap RAMBo <http://reprap.org/wiki/Rambo>`_
-      - ATMEGA2560
-      - 16 MHz
-      - 256 Kb
-      - 8 Kb
-
-Sanguino
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``sanguino_atmega12848m``
-      - `Sanguino ATmega1284p (8MHz) <https://code.google.com/p/sanguino/>`_
-      - ATMEGA1284P
-      - 8 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``sanguino_atmega1284m``
-      - `Sanguino ATmega1284p (20MHz) <https://code.google.com/p/sanguino/>`_
-      - ATMEGA1284P
-      - 20 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``sanguino_atmega1284p``
-      - `Sanguino ATmega1284p (16MHz) <https://code.google.com/p/sanguino/>`_
-      - ATMEGA1284P
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``sanguino_atmega644p``
-      - `Sanguino ATmega644P <https://code.google.com/p/sanguino/>`_
-      - ATMEGA644P
-      - 16 MHz
-      - 64 Kb
-      - 4 Kb
-
-SparkFun
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``sparkfun_digitalsandbox``
-      - `SparkFun Digital Sandbox <https://www.sparkfun.com/products/12651>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``sparkfun_fiov3``
-      - `SparkFun Fio V3 3.3V/8MHz <https://www.sparkfun.com/products/11520>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``sparkfun_makeymakey``
-      - `SparkFun Makey Makey <https://www.sparkfun.com/products/11511>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``sparkfun_megamini``
-      - `SparkFun Mega Pro Mini 3.3V <https://www.sparkfun.com/products/10743>`_
-      - ATMEGA2560
-      - 8 MHz
-      - 256 Kb
-      - 8 Kb
-
-    * - ``sparkfun_megapro16MHz``
-      - `SparkFun Mega Pro 5V/16MHz <https://www.sparkfun.com/products/11007>`_
-      - ATMEGA2560
-      - 16 MHz
-      - 256 Kb
-      - 8 Kb
-
-    * - ``sparkfun_megapro8MHz``
-      - `SparkFun Mega Pro 3.3V/8MHz <https://www.sparkfun.com/products/10744>`_
-      - ATMEGA2560
-      - 8 MHz
-      - 256 Kb
-      - 8 Kb
-
-    * - ``sparkfun_promicro16``
-      - `SparkFun Pro Micro 5V/16MHz <https://www.sparkfun.com/products/12640>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``sparkfun_promicro8``
-      - `SparkFun Pro Micro 3.3V/8MHz <https://www.sparkfun.com/products/12587>`_
-      - ATMEGA32U4
-      - 8 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``sparkfun_redboard``
-      - `SparkFun RedBoard <https://www.sparkfun.com/products/12757>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``uview``
-      - `SparkFun MicroView <https://www.sparkfun.com/products/12923>`_
-      - ATMEGA328P
-      - 16 MHz
-      - 32 Kb
-      - 2 Kb
-
-TinyCircuits
-~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``tinyduino``
-      - `TinyCircuits TinyDuino Processor Board <https://tiny-circuits.com/tinyduino-processor-board.html>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-    * - ``tinylily``
-      - `TinyCircuits TinyLily Mini Processor <https://tiny-circuits.com/tiny-lily-mini-processor.html>`_
-      - ATMEGA328P
-      - 8 MHz
-      - 32 Kb
-      - 2 Kb
-
-WickedDevice
-~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``wildfirev2``
-      - `WickedDevice WildFire v2 [stk500] <http://shop.wickeddevice.com/resources/wildfire/#arduinoidesetup>`_
-      - ATMEGA1284P
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``wildfirev3``
-      - `WickedDevice WildFire v3 [optiboot] <http://shop.wickeddevice.com/resources/wildfire/>`_
-      - ATMEGA1284P
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb

docs/platforms/atmelsam.rst

@@ -1,130 +0,0 @@
-.. _platform_atmelsam:
-
-Platform ``atmelsam``
-=====================
-Atmel | SMART offers Flash- based ARM products based on the ARM Cortex-M0+, Cortex-M3 and Cortex-M4 architectures, ranging from 8KB to 2MB of Flash including a rich peripheral and feature mix.
-
-For more detailed information please visit `vendor site <http://www.atmel.com/products/microcontrollers/arm/default.aspx>`_.
-
-.. contents::
-
-Packages
---------
-
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Contents
-
-    * - ``framework-arduinosam``
-      - `Arduino Wiring-based Framework (SAM Core, 1.6) <http://arduino.cc/en/Reference/HomePage>`_
-
-    * - ``ldscripts``
-      - `Linker Scripts <https://sourceware.org/binutils/docs/ld/Scripts.html>`_
-
-    * - ``toolchain-gccarmnoneeabi``
-      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-    * - ``tool-bossac``
-      - `BOSSA CLI <https://sourceforge.net/projects/b-o-s-s-a/>`_
-
-.. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
-
-
-
-Frameworks
-----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`framework_arduino`
-      - Arduino Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by
-      horizontal.
-
-Arduino
-~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``due``
-      - `Arduino Due (Programming Port) <http://arduino.cc/en/Main/arduinoBoardDue>`_
-      - AT91SAM3X8E
-      - 84 MHz
-      - 512 Kb
-      - 32 Kb
-
-    * - ``dueUSB``
-      - `Arduino Due (USB Native Port) <http://arduino.cc/en/Main/arduinoBoardDue>`_
-      - AT91SAM3X8E
-      - 84 MHz
-      - 512 Kb
-      - 32 Kb
-
-Digistump
-~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``digix``
-      - `Digistump DigiX <http://digistump.com/products/50>`_
-      - AT91SAM3X8E
-      - 84 MHz
-      - 512 Kb
-      - 28 Kb
-
-SainSmart
-~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``sainSmartDue``
-      - `SainSmart Due (Programming Port) <http://www.sainsmart.com/arduino/control-boards/sainsmart-due-atmel-sam3x8e-arm-cortex-m3-board-black.html>`_
-      - AT91SAM3X8E
-      - 84 MHz
-      - 512 Kb
-      - 32 Kb
-
-    * - ``sainSmartDueUSB``
-      - `SainSmart Due (USB Native Port) <http://www.sainsmart.com/arduino/control-boards/sainsmart-due-atmel-sam3x8e-arm-cortex-m3-board-black.html>`_
-      - AT91SAM3X8E
-      - 84 MHz
-      - 512 Kb
-      - 32 Kb

docs/platforms/creating_platform.rst

@@ -1,417 +0,0 @@
-.. _platform_creating:
-
-Creating Platform
-=================
-
-*PlatformIO* was developed like a tool which would build the same source code
-for the different development platforms via single command :ref:`cmd_run`
-without any dependent software or requirements.
-
-For this purpose *PlatformIO* uses own pre-configured platforms data:
-build scripts, tool chains, the settings for the most popular embedded
-boards and etc. These data are pre-built and packaged to the different
-``packages``. It allows *PlatformIO* to have multiple development platforms
-which can use the same packages(tool chains, frameworks), but have
-different/own build scripts, uploader and etc.
-
-.. note::
-    If you want to change some build flags for the existing
-    :ref:`Platforms <platforms>`, you don't need to create (or duplicate) own
-    development platforms! Please use :ref:`projectconf_build_flags` option.
-
-**Step-by-Step Manual**
-
-1. Chose :ref:`platform_creating_packages` for platform
-2. Create :ref:`platform_creating_manifest_file`
-3. Create :ref:`platform_creating_build_script`
-4. Finish with the :ref:`platform_creating_installation`.
-
-.. contents::
-
-.. _platform_creating_packages:
-
-Packages
---------
-
-*PlatformIO* has pre-built packages for the most popular operation systems:
-*Mac OS*, *Linux (+ARM)* and *Windows*.
-
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Contents
-
-    * - ``framework-arduinoavr``
-      - `Arduino Wiring-based Framework (AVR Core, 1.6) <http://arduino.cc/en/Reference/HomePage>`_
-
-    * - ``framework-arduinoespressif``
-      - `Arduino Wiring-based Framework (ESP8266 Core) <https://github.com/esp8266/Arduino>`_
-
-    * - ``framework-arduinomsp430``
-      - `Arduino Wiring-based Framework (MSP430 Core) <http://arduino.cc/en/Reference/HomePage>`_
-
-    * - ``framework-arduinosam``
-      - `Arduino Wiring-based Framework (SAM Core, 1.6) <http://arduino.cc/en/Reference/HomePage>`_
-
-    * - ``framework-arduinoteensy``
-      - `Arduino Wiring-based Framework <http://arduino.cc/en/Reference/HomePage>`_
-
-    * - ``framework-cmsis``
-      - `Vendor-independent hardware abstraction layer for the Cortex-M processor series <http://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php>`_
-
-    * - ``framework-energiamsp430``
-      - `Energia Wiring-based Framework (MSP430 Core) <http://energia.nu/reference/>`_
-
-    * - ``framework-energiativa``
-      - `Energia Wiring-based Framework (LM4F Core) <http://energia.nu/reference/>`_
-
-    * - ``framework-libopencm3``
-      - `libOpenCM3 Framework <http://www.libopencm3.org/>`_
-
-    * - ``framework-mbed``
-      - `mbed Framework <http://mbed.org>`_
-
-    * - ``framework-spl``
-      - `Standard Peripheral Library for STM32 MCUs <http://www.st.com/web/catalog/tools/FM147/CL1794/SC961/SS1743/PF257890>`_
-
-    * - ``ldscripts``
-      - `Linker Scripts <https://sourceware.org/binutils/docs/ld/Scripts.html>`_
-
-    * - ``sdk-esp8266``
-      - `ESP8266 SDK <http://bbs.espressif.com>`_
-
-    * - ``tool-avrdude``
-      - `AVRDUDE <http://www.nongnu.org/avrdude/>`_
-
-    * - ``tool-bossac``
-      - `BOSSA CLI <https://sourceforge.net/projects/b-o-s-s-a/>`_
-
-    * - ``tool-esptool``
-      - `esptool-ck <https://github.com/igrr/esptool-ck>`_
-
-    * - ``tool-lm4flash``
-      - `Flash Programmer <http://www.ti.com/tool/lmflashprogrammer>`_
-
-    * - ``tool-micronucleus``
-      - `Micronucleus <https://github.com/micronucleus/micronucleus>`_
-
-    * - ``tool-mspdebug``
-      - `MSPDebug <http://mspdebug.sourceforge.net/>`_
-
-    * - ``tool-stlink``
-      - `ST-Link <https://github.com/texane/stlink>`_
-
-    * - ``tool-teensy``
-      - `Teensy Loader <https://www.pjrc.com/teensy/loader.html>`_
-
-    * - ``toolchain-atmelavr``
-      - `avr-gcc <https://gcc.gnu.org/wiki/avr-gcc>`_, `GDB <http://www.gnu.org/software/gdb/>`_, `AVaRICE <http://avarice.sourceforge.net/>`_, `SimulAVR <http://www.nongnu.org/simulavr/>`_
-
-    * - ``toolchain-gccarmnoneeabi``
-      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-    * - ``toolchain-timsp430``
-      - `msp-gcc <http://sourceforge.net/projects/mspgcc/>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-    * - ``toolchain-xtensa``
-      - `xtensa-gcc <https://github.com/jcmvbkbc/gcc-xtensa>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-.. _platform_creating_manifest_file:
-
-Manifest File
--------------
-
-A platform manifest file is a `Python <https://www.python.org>`_ script with the
-next requirements:
-
-1. The file should have ``.py`` extension
-2. The **name of the file** is the **platform name** (lowercase)
-3. The source code of this file should contain a ``class`` which describes your
-   own platform. The name of the ``class`` should start with your
-   **platform name** (the first letter should be capitalized) + ``Platform``
-   ending. This ``class`` should be derived from *PlatformIO* ``BasePlatform``
-   class.
-
-.. warning::
-    If you are new to *Python* language, please read:
-
-    * `Style Guide for Python Code <https://www.python.org/dev/peps/pep-0008>`_.
-    * A hash sign (#) that is not inside a string literal begins a comment.
-      All characters after the # and up to the physical line end are part
-      of the comment and the *Python* interpreter ignores them.
-
-Example of the **test** platform (``test.py``):
-
-.. code-block:: python
-
-    from platformio.platforms.base import BasePlatform
-
-    class TestPlatform(BasePlatform):
-        # This is a description of your platform.
-        # Platformio uses it for the `platformio search / list` commands
-        """
-            My Test platform - test.py
-        """
-
-        PACKAGES = {
-
-            "toolchain-foo": {
-
-                # alias is used for quick access to package.
-                # For example,
-                # `> platformio install test --without-package=toolchain`
-                "alias": "toolchain",
-
-                # Flag which allows PlatformIO to install this package by
-                # default via `> platformio install test` command
-                "default": True
-            },
-
-            "tool-bar": {
-                "alias": "uploader",
-                "default": True
-            },
-
-            "framework-baz": {
-                "default": True
-            }
-        }
-
-        def get_build_script(self):
-            """ Returns a path to build script """
-
-            # You can return static path
-            #return "/path/to/test-builder.py"
-
-            # or detect dynamically if `test-builder.py` is located in the same
-            # folder with `test.py`
-            return os.path.join(
-                os.path.dirname(os.path.realpath(__file__)),
-                "test-builder.py"
-            )
-
-.. _platform_creating_build_script:
-
-Build Script
-------------
-
-Platform's build script is based on a next-generation build tool named
-`SCons <http://www.scons.org>`_. PlatformIO has own built-in firmware builder
-``env.BuildFirmware`` with the nested libraries search. Please look into a
-base template of ``test-builder.py``.
-
-.. code-block:: python
-
-    """
-        Build script for test.py
-        test-builder.py
-    """
-
-    from os.path import join
-    from SCons.Script import AlwaysBuild, Builder, Default, DefaultEnvironment
-
-    env = DefaultEnvironment()
-
-    # A full list with the available variables
-    # http://www.scons.org/doc/production/HTML/scons-user.html#app-variables
-    env.Replace(
-        AR="ar",
-        AS="gcc",
-        CC="gcc",
-        CXX="g++",
-        OBJCOPY="objcopy",
-        RANLIB="ranlib",
-
-        ARFLAGS=["..."],
-
-        ASFLAGS=["flag1", "flag2", "flagN"],
-        CCFLAGS=["flag1", "flag2", "flagN"],
-        CXXFLAGS=["flag1", "flag2", "flagN"],
-        LINKFLAGS=["flag1", "flag2", "flagN"],
-
-        CPPDEFINES=["DEFINE_1", "DEFINE=2", "DEFINE_N"],
-
-        LIBS=["additional", "libs", "here"],
-
-        UPLOADER=join("$PIOPACKAGES_DIR", "tool-bar", "uploader"),
-        UPLOADCMD="$UPLOADER $SOURCES"
-    )
-
-    env.Append(
-        BUILDERS=dict(
-            ElfToBin=Builder(
-                action=" ".join([
-                    "$OBJCOPY",
-                    "-O",
-                    "binary",
-                    "$SOURCES",
-                    "$TARGET"]),
-                suffix=".bin"
-            )
-        )
-    )
-
-    # The source code of "platformio-build-tool" is here
-    # https://github.com/platformio/platformio/blob/develop/platformio/builder/tools/platformio.py
-
-    #
-    # Target: Build executable and linkable firmware
-    #
-    target_elf = env.BuildFirmware()
-
-    #
-    # Target: Build the .bin file
-    #
-    target_bin = env.ElfToBin(join("$BUILD_DIR", "firmware"), target_elf)
-
-    #
-    # Target: Upload firmware
-    #
-    upload = env.Alias(["upload"], target_bin, "$UPLOADCMD")
-    AlwaysBuild(upload)
-
-    #
-    # Target: Define targets
-    #
-    Default(target_bin)
-
-
-Please look into the examples with built-in scripts for the popular
-platforms:
-
-* `baseavr.py <https://github.com/platformio/platformio/blob/develop/platformio/builder/scripts/baseavr.py>`_
-* `basearm.py <https://github.com/platformio/platformio/blob/develop/platformio/builder/scripts/basearm.py>`_
-* `atmelavr.py <https://github.com/platformio/platformio/blob/develop/platformio/builder/scripts/atmelavr.py>`_
-* `timsp430.py <https://github.com/platformio/platformio/blob/develop/platformio/builder/scripts/timsp430.py>`_
-* `ststm32.py <https://github.com/platformio/platformio/blob/develop/platformio/builder/scripts/ststm32.py>`_
-
-.. _platform_creating_installation:
-
-Installation
-------------
-
-1. Create ``platforms`` directory in :ref:`projectconf_pio_home_dir` if it
-   doesn't exists.
-2. Copy ``test.py`` and ``test-builder.py`` files to ``platforms`` directory.
-3. Search available platforms via :ref:`cmd_platforms_search` command. You should see
-   ``test`` platform.
-4. Install ``test`` platform via :ref:`cmd_platforms_install` command.
-
-Now, you can use ``test`` for the :ref:`projectconf_env_platform` option in
-:ref:`projectconf`.
-
-Example
--------
-
-Let's use the real example which was requested by our user in `issue 175 <https://github.com/platformio/platformio/issues/175>`_. Need to add support for uploading firmware using GDB to
-:ref:`platform_ststm32`.
-
-First of all, need to create new folder ``platforms`` in :ref:`projectconf_pio_home_dir`
-and copy there two files:
-
-1. Platform manifest file ``ststm32gdb.py`` with the next content:
-
-.. code-block:: python
-
-    import os
-
-    from platformio.platforms.ststm32 import Ststm32Platform
-
-
-    class Ststm32gdbPlatform(Ststm32Platform):
-
-        """
-        ST STM32 using GDB as uploader
-
-        http://www.st.com/web/en/catalog/mmc/FM141/SC1169?sc=stm32
-        """
-
-        def get_build_script(self):
-
-            return os.path.join(
-                os.path.dirname(os.path.realpath(__file__)),
-                "ststm32gdb-builder.py"
-            )
-
-2. Build script file ``ststm32gdb-builder.py`` with the next content:
-
-.. code-block:: python
-
-    """
-        Builder for ST STM32 Series ARM microcontrollers with GDB upload.
-    """
-
-    from os.path import join
-
-    from SCons.Script import (COMMAND_LINE_TARGETS, AlwaysBuild, Default,
-                              DefaultEnvironment, SConscript)
-
-
-    env = DefaultEnvironment()
-
-    SConscript(env.subst(join("$PIOBUILDER_DIR", "scripts", "basearm.py")))
-
-    env.Replace(
-        UPLOADER=join(
-            "$PIOPACKAGES_DIR", "toolchain-gccarmnoneeabi",
-            "bin", "arm-none-eabi-gdb"
-        ),
-        UPLOADERFLAGS=[
-            join("$BUILD_DIR", "firmware.elf"),
-            "-batch",
-            "-x", join("$PROJECT_DIR", "upload.gdb")
-        ],
-
-        UPLOADCMD="$UPLOADER $UPLOADERFLAGS"
-    )
-
-    env.Append(
-        CPPDEFINES=[
-            "${BOARD_OPTIONS['build']['variant'].upper()}"
-        ],
-
-        LINKFLAGS=[
-            "-nostartfiles",
-            "-nostdlib"
-        ]
-    )
-
-    #
-    # Target: Build executable and linkable firmware
-    #
-
-    target_elf = env.BuildFirmware()
-
-    #
-    # Target: Build the .bin file
-    #
-
-    if "uploadlazy" in COMMAND_LINE_TARGETS:
-        target_firm = join("$BUILD_DIR", "firmware.bin")
-    else:
-        target_firm = env.ElfToBin(join("$BUILD_DIR", "firmware"), target_elf)
-
-    #
-    # Target: Print binary size
-    #
-
-    target_size = env.Alias("size", target_elf, "$SIZEPRINTCMD")
-    AlwaysBuild(target_size)
-
-    #
-    # Target: Upload by default .bin file
-    #
-
-    upload = env.Alias(
-        ["upload", "uploadlazy"], target_firm, "$UPLOADCMD")
-    AlwaysBuild(upload)
-
-    #
-    # Target: Define targets
-    #
-
-    Default([target_firm, target_size])
-
-Now, we should see ``ststm32gdb`` platform using :ref:`cmd_platforms_search` command output
-and can install it via :ref:`platformio platforms install ststm32gdb <cmd_platforms_install>` command.

docs/platforms/espressif.rst

@@ -1,79 +0,0 @@
-.. _platform_espressif:
-
-Platform ``espressif``
-======================
-Espressif Systems is a privately held fabless semiconductor company. They provide wireless communications and Wi-Fi chips which are widely used in mobile devices and the Internet of Things applications.
-
-For more detailed information please visit `vendor site <https://espressif.com/>`_.
-
-.. contents::
-
-Packages
---------
-
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Contents
-
-    * - ``ldscripts``
-      - `Linker Scripts <https://sourceware.org/binutils/docs/ld/Scripts.html>`_
-
-    * - ``sdk-esp8266``
-      - `ESP8266 SDK <http://bbs.espressif.com>`_
-
-    * - ``tool-esptool``
-      - `esptool-ck <https://github.com/igrr/esptool-ck>`_
-
-    * - ``framework-arduinoespressif``
-      - `Arduino Wiring-based Framework (ESP8266 Core) <https://github.com/esp8266/Arduino>`_
-
-    * - ``toolchain-xtensa``
-      - `xtensa-gcc <https://github.com/jcmvbkbc/gcc-xtensa>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-.. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
-
-
-
-Frameworks
-----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`framework_arduino`
-      - Arduino Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by
-      horizontal.
-
-Espressif
-~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``esp01``
-      - `Espressif ESP8266 board <https://nurdspace.nl/ESP8266>`_
-      - ESP8266
-      - 80 MHz
-      - 512 Kb
-      - 32 Kb

docs/platforms/freescalekinetis.rst

@@ -1,112 +0,0 @@
-.. _platform_freescalekinetis:
-
-Platform ``freescalekinetis``
-=============================
-Freescale Kinetis Microcontrollers is family of multiple hardware- and software-compatible ARM Cortex-M0+, Cortex-M4 and Cortex-M7-based MCU series. Kinetis MCUs offer exceptional low-power performance, scalability and feature integration.
-
-For more detailed information please visit `vendor site <http://www.freescale.com/webapp/sps/site/homepage.jsp?code=KINETIS>`_.
-
-.. contents::
-
-Packages
---------
-
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Contents
-
-    * - ``framework-mbed``
-      - `mbed Framework <http://mbed.org>`_
-
-    * - ``toolchain-gccarmnoneeabi``
-      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-.. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
-
-
-
-Frameworks
-----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`framework_mbed`
-      - The mbed framework The mbed SDK has been designed to provide enough hardware abstraction to be intuitive and concise, yet powerful enough to build complex projects. It is built on the low-level ARM CMSIS APIs, allowing you to code down to the metal if needed. In addition to RTOS, USB and Networking libraries, a cookbook of hundreds of reusable peripheral and module libraries have been built on top of the SDK by the mbed Developer Community.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by
-      horizontal.
-
-Freescale
-~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``IBMEthernetKit``
-      - `Ethernet IoT Starter Kit <http://developer.mbed.org/platforms/IBMEthernetKit/>`_
-      - MK64FN1M0VLL12
-      - 120 MHz
-      - 1024 Kb
-      - 256 Kb
-
-    * - ``frdm_k20d50m``
-      - `Freescale Kinetis FRDM-K20D50M <https://developer.mbed.org/platforms/FRDM-K20D50M/>`_
-      - MK20DX128VLH5
-      - 48 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``frdm_k22f``
-      - `Freescale Kinetis FRDM-K22F <https://developer.mbed.org/platforms/FRDM-K22F/>`_
-      - MK22FN512VLH12
-      - 120 MHz
-      - 512 Kb
-      - 128 Kb
-
-    * - ``frdm_k64f``
-      - `Freescale Kinetis FRDM-K64F <https://developer.mbed.org/platforms/FRDM-K64F/>`_
-      - MK64FN1M0VLL12
-      - 120 MHz
-      - 1024 Kb
-      - 256 Kb
-
-    * - ``frdm_kl05z``
-      - `Freescale Kinetis FRDM-KL05Z <https://developer.mbed.org/platforms/FRDM-KL05Z/>`_
-      - MKL05Z32VFM4
-      - 48 MHz
-      - 32 Kb
-      - 4 Kb
-
-    * - ``frdm_kl25z``
-      - `Freescale Kinetis FRDM-KL25Z <https://developer.mbed.org/platforms/KL25Z/>`_
-      - MKL25Z128VLK4
-      - 48 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``frdm_kl46z``
-      - `Freescale Kinetis FRDM-KL46Z <https://developer.mbed.org/platforms/FRDM-KL46Z/>`_
-      - MKL46Z256VLL4
-      - 48 MHz
-      - 256 Kb
-      - 32 Kb

docs/platforms/index.rst

@@ -1,27 +0,0 @@
-.. _platforms:
-
-Platforms & Embedded Boards
-===========================
-
-*PlatformIO* has pre-built different development platforms for popular OS
-(*Mac OS X, Linux (+ARM) and Windows*). Each of them include compiler,
-debugger, uploader (for embedded) and many other useful tools.
-
-Also it has pre-configured settings for most popular **Embedded Platform
-Boards**. You have no need to specify in :ref:`projectconf` type or frequency of
-MCU, upload protocol or etc. Please use ``board`` option.
-
-.. toctree::
-    :maxdepth: 2
-
-    atmelavr
-    atmelsam
-    espressif
-    freescalekinetis
-    nordicnrf51
-    nxplpc
-    ststm32
-    teensy
-    timsp430
-    titiva
-    creating_platform

docs/platforms/nordicnrf51.rst

@@ -1,171 +0,0 @@
-.. _platform_nordicnrf51:
-
-Platform ``nordicnrf51``
-========================
-The Nordic nRF51 Series is a family of highly flexible, multi-protocol, system-on-chip (SoC) devices for ultra-low power wireless applications. nRF51 Series devices support a range of protocol stacks including Bluetooth Smart (previously called Bluetooth low energy), ANT and proprietary 2.4GHz protocols such as Gazell.
-
-For more detailed information please visit `vendor site <https://www.nordicsemi.com/eng/Products/nRF51-Series-SoC>`_.
-
-.. contents::
-
-Packages
---------
-
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Contents
-
-    * - ``framework-mbed``
-      - `mbed Framework <http://mbed.org>`_
-
-    * - ``toolchain-gccarmnoneeabi``
-      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-.. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
-
-
-
-Frameworks
-----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`framework_mbed`
-      - The mbed framework The mbed SDK has been designed to provide enough hardware abstraction to be intuitive and concise, yet powerful enough to build complex projects. It is built on the low-level ARM CMSIS APIs, allowing you to code down to the metal if needed. In addition to RTOS, USB and Networking libraries, a cookbook of hundreds of reusable peripheral and module libraries have been built on top of the SDK by the mbed Developer Community.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by
-      horizontal.
-
-JKSoft
-~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``wallBotBLE``
-      - `JKSoft Wallbot BLE <https://developer.mbed.org/platforms/JKSoft-Wallbot-BLE/>`_
-      - NRF51822
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb
-
-Nordic
-~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``nrf51_dk``
-      - `Nordic nRF51-DK <https://developer.mbed.org/platforms/Nordic-nRF51-DK/>`_
-      - NRF51822
-      - 32 MHz
-      - 256 Kb
-      - 32 Kb
-
-    * - ``nrf51_dongle``
-      - `Nordic nRF51-Dongle <https://developer.mbed.org/platforms/Nordic-nRF51-Dongle/>`_
-      - NRF51822
-      - 32 MHz
-      - 256 Kb
-      - 32 Kb
-
-    * - ``nrf51_mkit``
-      - `Nordic nRF51822-mKIT <http://developer.mbed.org/platforms/Nordic-nRF51822/>`_
-      - NRF51822
-      - 16 MHz
-      - 128 Kb
-      - 16 Kb
-
-RedBearLab
-~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``redBearLab``
-      - `RedBearLab nRF51822 <https://developer.mbed.org/platforms/RedBearLab-nRF51822/>`_
-      - NRF51822
-      - 16 MHz
-      - 256 Kb
-      - 16 Kb
-
-    * - ``redBearLabBLENano``
-      - `RedBearLab BLE Nano <https://developer.mbed.org/platforms/RedBearLab-BLE-Nano/>`_
-      - NRF51822
-      - 16 MHz
-      - 256 Kb
-      - 16 Kb
-
-SeeedStudio
-~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``seeedTinyBLE``
-      - `SeeedStudio Seeed Tiny BLE <http://developer.mbed.org/platforms/Seeed-Tiny-BLE/>`_
-      - NRF51822
-      - 16 MHz
-      - 256 Kb
-      - 16 Kb
-
-Switch Science
-~~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``hrm1017``
-      - `Switch Science mbed HRM1017 <https://developer.mbed.org/platforms/mbed-HRM1017/>`_
-      - NRF51822
-      - 16 MHz
-      - 256 Kb
-      - 16 Kb

docs/platforms/nxplpc.rst

@@ -1,258 +0,0 @@
-.. _platform_nxplpc:
-
-Platform ``nxplpc``
-===================
-The NXP LPC is a family of 32-bit microcontroller integrated circuits by NXP Semiconductors. The LPC chips are grouped into related series that are based around the same 32-bit ARM processor core, such as the Cortex-M4F, Cortex-M3, Cortex-M0+, or Cortex-M0. Internally, each microcontroller consists of the processor core, static RAM memory, flash memory, debugging interface, and various peripherals.
-
-For more detailed information please visit `vendor site <http://www.nxp.com/products/microcontrollers/>`_.
-
-.. contents::
-
-Packages
---------
-
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Contents
-
-    * - ``framework-mbed``
-      - `mbed Framework <http://mbed.org>`_
-
-    * - ``toolchain-gccarmnoneeabi``
-      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-.. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
-
-
-
-Frameworks
-----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`framework_mbed`
-      - The mbed framework The mbed SDK has been designed to provide enough hardware abstraction to be intuitive and concise, yet powerful enough to build complex projects. It is built on the low-level ARM CMSIS APIs, allowing you to code down to the metal if needed. In addition to RTOS, USB and Networking libraries, a cookbook of hundreds of reusable peripheral and module libraries have been built on top of the SDK by the mbed Developer Community.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by
-      horizontal.
-
-CQ Publishing
-~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lpc11u35_501``
-      - `CQ Publishing TG-LPC11U35-501 <https://developer.mbed.org/platforms/TG-LPC11U35-501/>`_
-      - LPC11U35
-      - 48 MHz
-      - 64 Kb
-      - 10 Kb
-
-Embedded Artists
-~~~~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lpc11u35``
-      - `Embedded Artists LPC11U35 QuickStart Board <https://developer.mbed.org/platforms/EA-LPC11U35/>`_
-      - LPC11U35
-      - 48 MHz
-      - 64 Kb
-      - 10 Kb
-
-    * - ``lpc4088``
-      - `Embedded Artists LPC4088 QuickStart Board <https://developer.mbed.org/platforms/EA-LPC4088/>`_
-      - LPC4088
-      - 120 MHz
-      - 512 Kb
-      - 96 Kb
-
-    * - ``lpc4088_dm``
-      - `Embedded Artists LPC4088 Display Module <https://developer.mbed.org/platforms/EA-LPC4088-Display-Module/>`_
-      - LPC4088
-      - 120 MHz
-      - 512 Kb
-      - 96 Kb
-
-NGX Technologies
-~~~~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``blueboard_lpc11u24``
-      - `NGX Technologies BlueBoard-LPC11U24 <https://developer.mbed.org/platforms/BlueBoard-LPC11U24/>`_
-      - LPC11U24
-      - 48 MHz
-      - 32 Kb
-      - 8 Kb
-
-NXP
-~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lpc11u24``
-      - `NXP mbed LPC11U24 <https://developer.mbed.org/platforms/mbed-LPC11U24/>`_
-      - LPC11U24
-      - 48 MHz
-      - 32 Kb
-      - 8 Kb
-
-    * - ``lpc1549``
-      - `NXP LPCXpresso1549 <https://developer.mbed.org/platforms/LPCXpresso1549/>`_
-      - LPC1549
-      - 72 MHz
-      - 256 Kb
-      - 36 Kb
-
-    * - ``lpc1768``
-      - `NXP mbed LPC1768 <http://developer.mbed.org/platforms/mbed-LPC1768/>`_
-      - LPC1768
-      - 96 MHz
-      - 512 Kb
-      - 32 Kb
-
-Outrageous Circuits
-~~~~~~~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``mbuino``
-      - `Outrageous Circuits mBuino <https://developer.mbed.org/platforms/Outrageous-Circuits-mBuino/>`_
-      - LPC11U24
-      - 48 MHz
-      - 32 Kb
-      - 8 Kb
-
-SeeedStudio
-~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``seeeduinoArchPro``
-      - `SeeedStudio Seeeduino-Arch-Pro <https://developer.mbed.org/platforms/Seeeduino-Arch-Pro/>`_
-      - LPC1768
-      - 96 MHz
-      - 512 Kb
-      - 32 Kb
-
-Solder Splash Labs
-~~~~~~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``dipcortexm0``
-      - `Solder Splash Labs DipCortex M0 <https://developer.mbed.org/platforms/DipCortex-M0/>`_
-      - LPC11U24
-      - 50 MHz
-      - 32 Kb
-      - 8 Kb
-
-Switch Science
-~~~~~~~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lpc1114fn28``
-      - `Switch Science mbed LPC1114FN28 <https://developer.mbed.org/platforms/LPC1114FN28/>`_
-      - LPC1114FN28
-      - 48 MHz
-      - 32 Kb
-      - 4 Kb
-
-u-blox
-~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``ubloxc027``
-      - `u-blox C027 <https://developer.mbed.org/platforms/u-blox-C027/>`_
-      - LPC1768
-      - 96 MHz
-      - 512 Kb
-      - 32 Kb

docs/platforms/ststm32.rst

@@ -1,261 +0,0 @@
-.. _platform_ststm32:
-
-Platform ``ststm32``
-====================
-The STM32 family of 32-bit Flash MCUs based on the ARM Cortex-M processor is designed to offer new degrees of freedom to MCU users. It offers a 32-bit product range that combines very high performance, real-time capabilities, digital signal processing, and low-power, low-voltage operation, while maintaining full integration and ease of development.
-
-For more detailed information please visit `vendor site <http://www.st.com/web/en/catalog/mmc/FM141/SC1169?sc=stm32>`_.
-
-.. contents::
-
-Packages
---------
-
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Contents
-
-    * - ``framework-libopencm3``
-      - `libOpenCM3 Framework <http://www.libopencm3.org/>`_
-
-    * - ``toolchain-gccarmnoneeabi``
-      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-    * - ``tool-stlink``
-      - `ST-Link <https://github.com/texane/stlink>`_
-
-    * - ``framework-spl``
-      - `Standard Peripheral Library for STM32 MCUs <http://www.st.com/web/catalog/tools/FM147/CL1794/SC961/SS1743/PF257890>`_
-
-    * - ``framework-cmsis``
-      - `Vendor-independent hardware abstraction layer for the Cortex-M processor series <http://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php>`_
-
-    * - ``framework-mbed``
-      - `mbed Framework <http://mbed.org>`_
-
-    * - ``ldscripts``
-      - `Linker Scripts <https://sourceware.org/binutils/docs/ld/Scripts.html>`_
-
-.. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
-
-
-
-Frameworks
-----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`framework_cmsis`
-      - The ARM Cortex Microcontroller Software Interface Standard (CMSIS) is a vendor-independent hardware abstraction layer for the Cortex-M processor series and specifies debugger interfaces. The CMSIS enables consistent and simple software interfaces to the processor for interface peripherals, real-time operating systems, and middleware. It simplifies software re-use, reducing the learning curve for new microcontroller developers and cutting the time-to-market for devices.
-
-    * - :ref:`framework_libopencm3`
-      - The libOpenCM3 framework aims to create a free/libre/open-source firmware library for various ARM Cortex-M0(+)/M3/M4 microcontrollers, including ST STM32, Ti Tiva and Stellaris, NXP LPC 11xx, 13xx, 15xx, 17xx parts, Atmel SAM3, Energy Micro EFM32 and others.
-
-    * - :ref:`framework_mbed`
-      - The mbed framework The mbed SDK has been designed to provide enough hardware abstraction to be intuitive and concise, yet powerful enough to build complex projects. It is built on the low-level ARM CMSIS APIs, allowing you to code down to the metal if needed. In addition to RTOS, USB and Networking libraries, a cookbook of hundreds of reusable peripheral and module libraries have been built on top of the SDK by the mbed Developer Community.
-
-    * - :ref:`framework_spl`
-      - The ST Standard Peripheral Library provides a set of functions for handling the peripherals on the STM32 Cortex-M3 family. The idea is to save the user (the new user, in particular) having to deal directly with the registers.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by
-      horizontal.
-
-Armstrap
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``armstrap_eagle1024``
-      - `Armstrap Eagle 1024 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
-      - STM32F417VGT6
-      - 168 MHz
-      - 1024 Kb
-      - 192 Kb
-
-    * - ``armstrap_eagle2048``
-      - `Armstrap Eagle 2048 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
-      - STM32F427VIT6
-      - 168 MHz
-      - 2048 Kb
-      - 256 Kb
-
-    * - ``armstrap_eagle512``
-      - `Armstrap Eagle 512 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
-      - STM32F407VET6
-      - 168 MHz
-      - 512 Kb
-      - 192 Kb
-
-ST
-~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``disco_f051r8``
-      - `ST STM32F0DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF253215>`_
-      - STM32F051R8T6
-      - 48 MHz
-      - 64 Kb
-      - 8 Kb
-
-    * - ``disco_f100rb``
-      - `ST STM32VLDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF250863>`_
-      - STM32F100RBT6
-      - 24 MHz
-      - 128 Kb
-      - 8 Kb
-
-    * - ``disco_f303vc``
-      - `ST STM32F3DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF254044>`_
-      - STM32F303VCT6
-      - 72 MHz
-      - 256 Kb
-      - 48 Kb
-
-    * - ``disco_f334c8``
-      - `ST 32F3348DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF260318>`_
-      - STM32F334C8T6
-      - 72 MHz
-      - 64 Kb
-      - 16 Kb
-
-    * - ``disco_f401vc``
-      - `ST 32F401CDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF259098>`_
-      - STM32F401VCT6
-      - 84 MHz
-      - 256 Kb
-      - 64 Kb
-
-    * - ``disco_f407vg``
-      - `ST STM32F4DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF252419>`_
-      - STM32F407VGT6
-      - 168 MHz
-      - 1024 Kb
-      - 128 Kb
-
-    * - ``disco_f429zi``
-      - `ST 32F429IDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF259090>`_
-      - STM32F429ZIT6
-      - 180 MHz
-      - 2048 Kb
-      - 256 Kb
-
-    * - ``disco_l152rb``
-      - `ST STM32LDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF258515>`_
-      - STM32L152RBT6
-      - 32 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``nucleo_f030r8``
-      - `ST Nucleo F030R8 <https://developer.mbed.org/platforms/ST-Nucleo-F030R8/>`_
-      - STM32F030R8T6
-      - 48 MHz
-      - 64 Kb
-      - 8 Kb
-
-    * - ``nucleo_f070rb``
-      - `ST Nucleo F070RB <https://developer.mbed.org/platforms/ST-Nucleo-F070RB/>`_
-      - STM32F070RBT6
-      - 48 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``nucleo_f072rb``
-      - `ST Nucleo F072RB <https://developer.mbed.org/platforms/ST-Nucleo-F072RB/>`_
-      - STM32F072RBT6
-      - 48 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``nucleo_f091rc``
-      - `ST Nucleo F091RC <https://developer.mbed.org/platforms/ST-Nucleo-F091RC/>`_
-      - STM32F091RCT6
-      - 48 MHz
-      - 256 Kb
-      - 32 Kb
-
-    * - ``nucleo_f103rb``
-      - `ST Nucleo F103RB <https://developer.mbed.org/platforms/ST-Nucleo-F103RB/>`_
-      - STM32F103RBT6
-      - 72 MHz
-      - 128 Kb
-      - 20 Kb
-
-    * - ``nucleo_f302r8``
-      - `ST Nucleo F302R8 <https://developer.mbed.org/platforms/ST-Nucleo-F302R8/>`_
-      - STM32F302R8T6
-      - 72 MHz
-      - 64 Kb
-      - 16 Kb
-
-    * - ``nucleo_f303re``
-      - `ST Nucleo F303RE <http://developer.mbed.org/platforms/ST-Nucleo-F303RE/>`_
-      - STM32F303RET6
-      - 72 MHz
-      - 512 Kb
-      - 64 Kb
-
-    * - ``nucleo_f334r8``
-      - `ST Nucleo F334R8 <https://developer.mbed.org/platforms/ST-Nucleo-F334R8/>`_
-      - STM32F334R8T6
-      - 72 MHz
-      - 64 Kb
-      - 16 Kb
-
-    * - ``nucleo_f401re``
-      - `ST Nucleo F401RE <https://developer.mbed.org/platforms/ST-Nucleo-F401RE/>`_
-      - STM32F401RET6
-      - 84 MHz
-      - 512 Kb
-      - 96 Kb
-
-    * - ``nucleo_f411re``
-      - `ST Nucleo F411RE <https://developer.mbed.org/platforms/ST-Nucleo-F411RE/>`_
-      - STM32F411RET6
-      - 100 MHz
-      - 512 Kb
-      - 128 Kb
-
-    * - ``nucleo_l053r8``
-      - `ST Nucleo L053R8 <https://developer.mbed.org/platforms/ST-Nucleo-L053R8/>`_
-      - STM32L053R8T6
-      - 48 MHz
-      - 64 Kb
-      - 8 Kb
-
-    * - ``nucleo_l152re``
-      - `ST Nucleo L152RE <https://developer.mbed.org/platforms/ST-Nucleo-L152RE/>`_
-      - STM32L152RET6
-      - 32 MHz
-      - 512 Kb
-      - 80 Kb

docs/platforms/teensy.rst

@@ -1,107 +0,0 @@
-.. _platform_teensy:
-
-Platform ``teensy``
-===================
-Teensy is a complete USB-based microcontroller development system, in a very small footprint, capable of implementing many types of projects. All programming is done via the USB port. No special programmer is needed, only a standard "Mini-B" USB cable and a PC or Macintosh with a USB port.
-
-For more detailed information please visit `vendor site <https://www.pjrc.com/teensy>`_.
-
-.. contents::
-
-Packages
---------
-
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Contents
-
-    * - ``toolchain-atmelavr``
-      - `avr-gcc <https://gcc.gnu.org/wiki/avr-gcc>`_, `GDB <http://www.gnu.org/software/gdb/>`_, `AVaRICE <http://avarice.sourceforge.net/>`_, `SimulAVR <http://www.nongnu.org/simulavr/>`_
-
-    * - ``ldscripts``
-      - `Linker Scripts <https://sourceware.org/binutils/docs/ld/Scripts.html>`_
-
-    * - ``framework-arduinoteensy``
-      - `Arduino Wiring-based Framework <http://arduino.cc/en/Reference/HomePage>`_
-
-    * - ``toolchain-gccarmnoneeabi``
-      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-    * - ``tool-teensy``
-      - `Teensy Loader <https://www.pjrc.com/teensy/loader.html>`_
-
-.. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
-
-
-
-Frameworks
-----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`framework_arduino`
-      - Arduino Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by
-      horizontal.
-
-Teensy
-~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``teensy20``
-      - `Teensy 2.0 <https://www.pjrc.com/store/teensy.html>`_
-      - ATMEGA32U4
-      - 16 MHz
-      - 32 Kb
-      - 2.5 Kb
-
-    * - ``teensy20pp``
-      - `Teensy++ 2.0 <https://www.pjrc.com/store/teensypp.html>`_
-      - AT90USB1286
-      - 16 MHz
-      - 128 Kb
-      - 8 Kb
-
-    * - ``teensy30``
-      - `Teensy 3.0 <https://www.pjrc.com/store/teensy3.html>`_
-      - MK20DX128
-      - 48 MHz
-      - 128 Kb
-      - 16 Kb
-
-    * - ``teensy31``
-      - `Teensy 3.1 <https://www.pjrc.com/store/teensy31.html>`_
-      - MK20DX256
-      - 72 MHz
-      - 256 Kb
-      - 64 Kb
-
-    * - ``teensylc``
-      - `Teensy LC <http://www.pjrc.com/teensy/teensyLC.html>`_
-      - MKL26Z64
-      - 48 MHz
-      - 64 Kb
-      - 8 Kb

docs/platforms/timsp430.rst

@@ -1,141 +0,0 @@
-.. _platform_timsp430:
-
-Platform ``timsp430``
-=====================
-MSP430 microcontrollers (MCUs) from Texas Instruments (TI) are 16-bit, RISC-based, mixed-signal processors designed for ultra-low power. These MCUs offer the lowest power consumption and the perfect mix of integrated peripherals for thousands of applications.
-
-For more detailed information please visit `vendor site <http://www.ti.com/lsds/ti/microcontrollers_16-bit_32-bit/msp/overview.page>`_.
-
-.. contents::
-
-Packages
---------
-
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Contents
-
-    * - ``toolchain-timsp430``
-      - `msp-gcc <http://sourceforge.net/projects/mspgcc/>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-    * - ``tool-mspdebug``
-      - `MSPDebug <http://mspdebug.sourceforge.net/>`_
-
-    * - ``framework-energiamsp430``
-      - `Energia Wiring-based Framework (MSP430 Core) <http://energia.nu/reference/>`_
-
-    * - ``framework-arduinomsp430``
-      - `Arduino Wiring-based Framework (MSP430 Core) <http://arduino.cc/en/Reference/HomePage>`_
-
-.. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
-
-
-
-Frameworks
-----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`framework_arduino`
-      - Arduino Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences.
-
-    * - :ref:`framework_energia`
-      - Energia framework enables pretty much anyone to start easily creating microcontroller-based projects and applications. Its easy-to-use libraries and functions provide developers of all experience levels to start blinking LEDs, buzzing buzzers and sensing sensors more quickly than ever before.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by
-      horizontal.
-
-PanStamp
-~~~~~~~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``panStampNRG``
-      - `PanStamp NRG 1.1 <http://www.panstamp.com/product/197/>`_
-      - CC430F5137
-      - 12 MHz
-      - 32 Kb
-      - 4 Kb
-
-TI
-~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lpmsp430f5529``
-      - `TI LaunchPad w/ msp430f5529 (16MHz) <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430f5529lp.html>`_
-      - MSP430F5529
-      - 16 MHz
-      - 128 Kb
-      - 1 Kb
-
-    * - ``lpmsp430f5529_25``
-      - `TI LaunchPad w/ msp430f5529 (25MHz) <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430f5529lp.html>`_
-      - MSP430F5529
-      - 25 MHz
-      - 128 Kb
-      - 1 Kb
-
-    * - ``lpmsp430fr5739``
-      - `TI FraunchPad w/ msp430fr5739 <http://www.ti.com/tool/msp-exp430fr5739>`_
-      - MSP430FR5739
-      - 16 MHz
-      - 16 Kb
-      - 1 Kb
-
-    * - ``lpmsp430fr5969``
-      - `TI LaunchPad w/ msp430fr5969 <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430fr5969.html>`_
-      - MSP430FR5969
-      - 8 MHz
-      - 64 Kb
-      - 1 Kb
-
-    * - ``lpmsp430g2231``
-      - `TI LaunchPad w/ msp430g2231 (1 MHz) <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430g2.html>`_
-      - MSP430G2231
-      - 1 MHz
-      - 2 Kb
-      - 0.125 Kb
-
-    * - ``lpmsp430g2452``
-      - `TI LaunchPad w/ msp430g2452 (16MHz) <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430g2.html>`_
-      - MSP430G2452
-      - 16 MHz
-      - 8 Kb
-      - 0.25 Kb
-
-    * - ``lpmsp430g2553``
-      - `TI LaunchPad w/ msp430g2553 (16MHz) <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430g2.html>`_
-      - MSP430G2553
-      - 16 MHz
-      - 16 Kb
-      - 0.5 Kb

docs/platforms/titiva.rst

@@ -1,96 +0,0 @@
-.. _platform_titiva:
-
-Platform ``titiva``
-===================
-Texas Instruments TM4C12x MCUs offer the industrys most popular ARM Cortex-M4 core with scalable memory and package options, unparalleled connectivity peripherals, advanced application functions, industry-leading analog integration, and extensive software solutions.
-
-For more detailed information please visit `vendor site <http://www.ti.com/lsds/ti/microcontrollers_16-bit_32-bit/c2000_performance/control_automation/tm4c12x/overview.page>`_.
-
-.. contents::
-
-Packages
---------
-
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Contents
-
-    * - ``ldscripts``
-      - `Linker Scripts <https://sourceware.org/binutils/docs/ld/Scripts.html>`_
-
-    * - ``framework-libopencm3``
-      - `libOpenCM3 Framework <http://www.libopencm3.org/>`_
-
-    * - ``toolchain-gccarmnoneeabi``
-      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-    * - ``tool-lm4flash``
-      - `Flash Programmer <http://www.ti.com/tool/lmflashprogrammer>`_
-
-    * - ``framework-energiativa``
-      - `Energia Wiring-based Framework (LM4F Core) <http://energia.nu/reference/>`_
-
-.. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
-
-
-
-Frameworks
-----------
-.. list-table::
-    :header-rows:  1
-
-    * - Name
-      - Description
-
-    * - :ref:`framework_energia`
-      - Energia framework enables pretty much anyone to start easily creating microcontroller-based projects and applications. Its easy-to-use libraries and functions provide developers of all experience levels to start blinking LEDs, buzzing buzzers and sensing sensors more quickly than ever before.
-
-    * - :ref:`framework_libopencm3`
-      - The libOpenCM3 framework aims to create a free/libre/open-source firmware library for various ARM Cortex-M0(+)/M3/M4 microcontrollers, including ST STM32, Ti Tiva and Stellaris, NXP LPC 11xx, 13xx, 15xx, 17xx parts, Atmel SAM3, Energy Micro EFM32 and others.
-
-Boards
-------
-
-.. note::
-    * You can list pre-configured boards by :ref:`cmd_boards` command or
-      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
-    * For more detailed ``board`` information please scroll tables below by
-      horizontal.
-
-TI
-~~
-
-.. list-table::
-    :header-rows:  1
-
-    * - Type ``board``
-      - Name
-      - Microcontroller
-      - Frequency
-      - Flash
-      - RAM
-
-    * - ``lplm4f120h5qr``
-      - `TI LaunchPad (Stellaris) w/ lm4f120 (80MHz) <http://www.ti.com/tool/ek-lm4f120xl>`_
-      - LPLM4F120H5QR
-      - 80 MHz
-      - 256 Kb
-      - 32 Kb
-
-    * - ``lptm4c1230c3pm``
-      - `TI LaunchPad (Tiva C) w/ tm4c123 (80MHz) <http://www.ti.com/ww/en/launchpad/launchpads-connected-ek-tm4c123gxl.html>`_
-      - LPTM4C1230C3PM
-      - 80 MHz
-      - 256 Kb
-      - 32 Kb
-
-    * - ``lptm4c1294ncpdt``
-      - `TI LaunchPad (Tiva C) w/ tm4c129 (120MHz) <http://www.ti.com/ww/en/launchpad/launchpads-connected-ek-tm4c1294xl.html>`_
-      - LPTM4C1294NCPDT
-      - 120 MHz
-      - 1024 Kb
-      - 256 Kb

docs/projectconf.rst

@@ -1,479 +0,0 @@
-.. _projectconf:
-
-Project Configuration File ``platformio.ini``
-=============================================
-
-The Project configuration file is named ``platformio.ini``. This is a
-`INI-style <http://en.wikipedia.org/wiki/INI_file>`_ file.
-
-``platformio.ini`` has sections (each denoted by a ``[header]``) and
-key / value pairs within the sections. A sign ``#`` at the beginning of the
-line indicates a comment. Comment lines are ignored.
-
-The sections and their allowable values are described below.
-
-.. contents::
-
-[platformio]
-------------
-
-A ``platformio`` section is used for overriding default configuration options
-
-.. note::
-    Relative path is allowed for directory option:
-
-    * ``~`` will be expanded to user's home directory
-    * ``../`` or ``..\`` go up to one folder
-
-Options
-~~~~~~~
-
-.. _projectconf_pio_home_dir:
-
-``home_dir``
-^^^^^^^^^^^^
-
-Is used to store platform tool chains, frameworks, external libraries,
-service data and etc.
-
-A default value is User's home directory:
-
-* Unix ``~/.platformio``
-* Windows ``%HOMEPATH%\.platformio``
-
-This option can be overridden by global environment variable
-:ref:`envvar_PLATFORMIO_HOME_DIR`.
-
-.. _projectconf_pio_lib_dir:
-
-``lib_dir``
-^^^^^^^^^^^
-
-This directory is used to store external libraries downloaded by
-:ref:`librarymanager`.
-
-A default value is ``%home_dir%/lib``.
-
-This option can be overridden by global environment variable
-:ref:`envvar_PLATFORMIO_LIB_DIR`.
-
-.. _projectconf_pio_src_dir:
-
-``src_dir``
-^^^^^^^^^^^
-
-A path to project's source directory. PlatformIO uses it for :ref:`cmd_run`
-command.
-
-A default value is ``%project_dir%/src``.
-
-This option can be overridden by global environment variable
-:ref:`envvar_PLATFORMIO_SRC_DIR`.
-
-.. note::
-    This option is useful for people who migrate from Arduino/Energia IDEs where
-    source directory should have the same name like the main source file.
-    See `example <https://github.com/platformio/platformio/tree/develop/examples/atmelavr-and-arduino/arduino-own-src_dir>`__ project with own source directory.
-
-.. _projectconf_pio_envs_dir:
-
-``envs_dir``
-^^^^^^^^^^^^
-
-*PlatformIO Builder* within :ref:`cmd_run` command uses this folder for project
-environments to store compiled object files, static libraries, firmwares and
-other cached information. It allows PlatformIO to build source code extremely
-fast!
-
-*You can delete this folder without any risk!* If you modify :ref:`projectconf`,
-then PlatformIO will remove this folder automatically. It will be created on the
-next build operation.
-
-A default value is ``%project_dir%/.pioenvs``.
-
-This option can be overridden by global environment variable
-:ref:`envvar_PLATFORMIO_ENVS_DIR`.
-
-.. note::
-    If you have any problems with building your Project environmets which
-    are defined in :ref:`projectconf`, then **TRY TO DELETE** this folder. In
-    this situation you will remove all cached files without any risk.
-
-[env:NAME]
-----------
-
-A section with ``env:`` prefix is used to define virtual environment with
-specific options that will be processed with :ref:`cmd_run` command. You can
-define unlimited numbers of environments.
-
-Each environment must have unique ``NAME``. The valid chars for ``NAME`` are
-
-* letters ``a-z``
-* numbers ``0-9``
-* special char ``_`` (underscore)
-
-For example, ``[env:hello_world]``.
-
-Options
-~~~~~~~
-
-.. _projectconf_env_platform:
-
-``platform``
-^^^^^^^^^^^^
-
-:ref:`Platform <platforms>` type.
-
-
-.. _projectconf_env_framework:
-
-``framework``
-^^^^^^^^^^^^^
-
-:ref:`Framework <frameworks>` type.
-
-The multiple frameworks are allowed, split them with comma ``,`` separator.
-
-
-.. _projectconf_env_board:
-
-``board``
-^^^^^^^^^
-
-*PlatformIO* has pre-configured settings for the most popular boards. You don't
-need to specify ``board_mcu``, ``board_f_cpu``, ``upload_protocol`` or
-``upload_speed`` options. Just define a ``board`` type and *PlatformIO* will
-pre-fill options described above with appropriate values.
-
-You can find the ``board`` type in *Boards* section of each :ref:`platforms`.
-
-
-``board_mcu``
-^^^^^^^^^^^^^
-
-``board_mcu`` is a microcontroller(MCU) type that is used by compiler to
-recognize MCU architecture. The correct type of ``board_mcu`` depends on
-platform library. For example, the list of ``board_mcu`` for "megaAVR Devices"
-is described `here <http://www.nongnu.org/avr-libc/user-manual/>`_.
-
-The full list of ``board_mcu`` for the popular embedded platforms you can find
-in *Boards* section of :ref:`platforms`. See "Microcontroller" column.
-
-
-``board_f_cpu``
-^^^^^^^^^^^^^^^
-
-An option ``board_f_cpu`` is used to define MCU frequency (Hertz, Clock). A
-format of this option is ``C-like long integer`` value with ``L`` suffix. The
-1 Hertz is equal to ``1L``, then 16 Mhz (Mega Hertz) is equal to ``16000000L``.
-
-The full list of ``board_f_cpu`` for the popular embedded platforms you can
-find in *Boards* section of :ref:`platforms`. See "Frequency" column.
-
-
-``upload_port``
-^^^^^^^^^^^^^^^
-
-This option is used by "uploader" tool when sending firmware to board via
-``upload_port``. For example,
-
-* ``/dev/ttyUSB0`` - Unix-based OS
-* ``COM3`` - Windows OS
-
-If ``upload_port`` isn't specified, then *PlatformIO* will try to detect it
-automatically.
-
-To print all available serial ports use :ref:`cmd_serialports` command.
-
-
-``upload_protocol``
-^^^^^^^^^^^^^^^^^^^
-
-A protocol that "uploader" tool uses to talk to the board.
-
-
-``upload_speed``
-^^^^^^^^^^^^^^^^
-
-A connection speed (`baud rate <http://en.wikipedia.org/wiki/Baud>`_)
-which "uploader" tool uses when sending firmware to board.
-
-
-``targets``
-^^^^^^^^^^^
-
-A list with targets which will be processed by :ref:`cmd_run` command by
-default. You can enter more then one target separated with "space".
-
-When no targets are defined, *PlatformIO* will build only sources by default.
-
-.. note::
-    This option is useful to enable "auto-uploading" after building operation
-    (``targets = upload``).
-
-
-.. _projectconf_build_flags:
-
-``build_flags``
-^^^^^^^^^^^^^^^
-
-These flags/options control preprocessing, compilation, assembly and linking
-processes:
-
-.. list-table::
-    :header-rows:  1
-
-    * - Format
-      - Scope
-      - Description
-    * - ``-Wp,option``
-      - CPPFLAGS
-      - Bypass the compiler driver and pass *option* directly  through to the
-        preprocessor
-    * - ``-D name``
-      - CPPDEFINES
-      - Predefine *name* as a macro, with definition 1.
-    * - ``-D name=definition``
-      - CPPDEFINES
-      - The contents of *definition* are tokenized and processed as if they
-        appeared during translation phase three in a ``#define`` directive.
-    * - ``-U name``
-      - CPPDEFINES
-      - Cancel any previous definition of *name*, either built in or provided
-        with a ``-D`` option.
-    * - ``-Wall``
-      - CCFLAGS
-      - Turns on all optional warnings which are desirable for normal code.
-    * - ``-Werror``
-      - CCFLAGS
-      - Make all warnings into hard errors. Source code which triggers warnings will be rejected.
-    * - ``-w``
-      - CCFLAGS
-      - Suppress all warnings, including those which GNU CPP issues by default.
-    * - ``-include file``
-      - CCFLAGS
-      - Process *file* as if ``#include "file"`` appeared as the first line of
-        the primary source file.
-    * - ``-Wa,option``
-      - ASFLAGS, CCFLAGS
-      - Pass *option* as an option to the assembler. If *option* contains
-        commas, it is split into multiple options at the commas.
-    * - ``-llibrary``
-      - LIBS
-      - Search the *library* named library when linking
-    * - ``-Ldir``
-      - LIBPATH
-      - Add directory *dir* to the list of directories to be searched for
-        ``-l``.
-    * - ``-Idir``
-      - CPPPATH
-      - Add the directory *dir* to the list of directories to be searched
-        for header files.
-
-Example:
-
-.. code-block::   ini
-
-    [env:specific_defines]
-    build_flags = -O2 -Dfoo -Dbar=1
-
-    [env:specific_inclibs]
-    build_flags = -I/opt/include -L/opt/lib -lfoo
-
-
-For more detailed information about available flags/options go to:
-
-* `Options to Request or Suppress Warnings
-  <https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html>`_
-* `Options for Debugging Your Program
-  <https://gcc.gnu.org/onlinedocs/gcc/Debugging-Options.html>`_
-* `Options That Control Optimization
-  <https://gcc.gnu.org/onlinedocs/gcc/Optimize-Options.html>`_
-* `Options Controlling the Preprocessor
-  <https://gcc.gnu.org/onlinedocs/gcc/Preprocessor-Options.html>`_
-* `Passing Options to the Assembler
-  <https://gcc.gnu.org/onlinedocs/gcc/Assembler-Options.html>`_
-* `Options for Linking <https://gcc.gnu.org/onlinedocs/gcc/Link-Options.html>`_
-* `Options for Directory Search
-  <https://gcc.gnu.org/onlinedocs/gcc/Directory-Options.html>`_
-
-.. _projectconf_srcbuild_flags:
-
-``srcbuild_flags``
-^^^^^^^^^^^^^^^^^^
-
-An option ``srcbuild_flags`` has the same behaviour like ``build_flags``
-but will be applied only for the project source code from
-:ref:`projectconf_pio_src_dir` directory.
-
-This option can be overridden by global environment variable
-:ref:`envvar_PLATFORMIO_SRCBUILD_FLAGS`.
-
-``install_libs``
-^^^^^^^^^^^^^^^^
-
-Specify dependent libraries which should be installed before environment
-process. The only library IDs are allowed. Multiple libraries can be passed
-using comma ``,`` sign.
-
-You can obtain library IDs using :ref:`cmd_lib_search` command.
-
-Example:
-
-.. code-block::   ini
-
-    [env:depends_on_some_libs]
-    install_libs = 1,13,19
-
-``use_libs``
-^^^^^^^^^^^^
-
-Specify libraries which should be used by ``Library Dependency Finder`` with
-the highest priority.
-
-Example:
-
-.. code-block::   ini
-
-    [env:libs_with_highest_priority]
-    use_libs = OneWire_ID1
-
-``ignore_libs``
-^^^^^^^^^^^^^^^
-
-Specify libraries which should be ignored by ``Library Dependency Finder``
-
-Example:
-
-.. code-block::   ini
-
-    [env:ignore_some_libs]
-    ignore_libs = SPI,EngduinoV3_ID123
-
-
-.. _projectconf_examples:
-
-Examples
---------
-
-.. note::
-    A full list with project examples can be found in
-    `PlatformIO Repository <https://github.com/platformio/platformio/tree/develop/examples>`_.
-
-1. :ref:`platform_atmelavr`: Arduino UNO board with auto pre-configured
-   ``board_*`` and ``upload_*`` options (use only ``board`` option) and Arduino
-   Wiring-based Framework
-
-.. code-block:: ini
-
-    [env:atmelavr_arduino_uno_board]
-    platform = atmelavr
-    framework = arduino
-    board = uno
-
-    # enable auto-uploading
-    targets = upload
-
-
-2. :ref:`platform_atmelavr`: Microduino Core (ATmega168P, 3.3V) board with
-   auto pre-configured ``board_*`` and ``upload_*`` options (use only
-   ``board`` option) and Arduino Wiring-based Framework
-
-.. code-block:: ini
-
-    [env:atmelavr_microduino_core_board]
-    platform = atmelavr
-    framework = arduino
-    board = 168pa8m
-
-    # enable auto-uploading
-    targets = upload
-
-
-3. :ref:`platform_atmelavr`: Raspduino board with
-   auto pre-configured ``board_*`` and ``upload_*`` options (use only
-   ``board`` option) and Arduino Wiring-based Framework
-
-.. code-block:: ini
-
-    [env:atmelavr_raspduino_board]
-    platform = atmelavr
-    framework = arduino
-    board = raspduino
-
-    upload_port = /dev/ttyS0
-
-    # enable auto-uploading
-    targets = upload
-
-
-4. :ref:`platform_atmelavr`: Embedded board that is based on ATmega168 MCU with
-   "arduino" bootloader
-
-.. code-block:: ini
-
-    [env:atmelavr_atmega168_board]
-    platform = atmelavr
-    board_mcu = atmega168
-    board_f_cpu = 16000000L
-
-    upload_port = /dev/ttyUSB0
-    # for Windows OS
-    # upload_port = COM3
-    upload_protocol = arduino
-    upload_speed = 19200
-
-    # enable auto-uploading
-    targets = upload
-
-
-5. Upload firmware via USB programmer (USBasp) to :ref:`platform_atmelavr`
-   microcontrollers
-
-.. code-block:: ini
-
-    [env:atmelavr_usbasp]
-    platform = atmelavr
-    framework = arduino
-    board = pro8MHzatmega328
-    upload_protocol = usbasp -B5
-
-
-6. :ref:`platform_timsp430`: TI MSP430G2553 LaunchPad with auto pre-configured
-   ``board_*`` and ``upload_*`` options (use only ``board`` option) and Energia
-   Wiring-based Framework
-
-.. code-block:: ini
-
-    [env:timsp430_g2553_launchpad]
-    platform = timsp430
-    framework = energia
-    board = lpmsp430g2553
-
-
-7. :ref:`platform_timsp430`: Embedded board that is based on MSP430G2553 MCU
-
-.. code-block:: ini
-
-    [env:timsp430_g2553_board]
-    platform = timsp430
-    board_mcu = msp430g2553
-    board_f_cpu = 16000000L
-
-    upload_protocol = rf2500
-
-    # enable auto-uploading
-    targets = upload
-
-
-8. :ref:`platform_titiva`: TI Tiva C ARM Series TM4C123G LaunchPad with auto
-   pre-configured ``board_*`` and ``upload_*`` options (use only ``board``
-   option) and Energia Wiring-based Framework
-
-.. code-block:: ini
-
-    [env:titiva_tm4c1230c3pm_launchpad]
-    platform = titiva
-    framework = energia
-    board = lptm4c1230c3pm
-

docs/quickstart.rst

@@ -1,64 +0,0 @@
-.. _quickstart:
-
-Quickstart
-==========
-
-.. note::
-    Please read `Get Started <http://platformio.org/#!/get-started>`_
-    article from the official WebSite.
-
-1. :ref:`Install PlatformIO <installation>`.
-
-2. Find board ``type`` using `Embedded Boards Explorer <http://platformio.org/#!/boards>`_
-   or via :ref:`cmd_boards` command.
-
-3. Initialize new PlatformIO based project via :ref:`cmd_init` command with the
-   pre-configured environments for your boards:
-
-.. code-block:: bash
-
-    $ platformio init --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
-
-    Would you like to enable firmware auto-uploading when project is successfully built using `platformio run` command?
-    Don't forget that you can upload firmware manually using `platformio run --target upload` command. [y/N]: y
-
-    The current working directory *** will be used for the new project.
-    You can specify another project directory via
-    `platformio init -d %PATH_TO_THE_PROJECT_DIR%` command.
-
-    The next files/directories will be created in ***
-    platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
-    src - Put your source code here
-    lib - Put here project specific or 3-rd party libraries
-    Do you want to continue? [y/N]: y
-    Project has been successfully initialized!
-    Useful commands:
-    `platformio run` - process/build project from the current directory
-    `platformio run --target upload` or `platformio run -t upload` - upload firmware to embedded board
-    `platformio run --target clean` - clean project (remove compiled files)
-
-Put your source code ``*.h, *.c, *.cpp or *.ino`` files to ``src`` directory.
-
-4. Process the project's environments.
-
-Change working directory to the project's root where is located
-:ref:`Project Configuration File (platformio.ini) <projectconf>` and run:
-
-.. code-block:: bash
-
-    $ platformio run
-
-    # if you don't have specified `targets = upload` option for environment,
-    # then you can upload firmware manually with this command:
-    $ platformio run --target upload
-
-    # clean project
-    $ platformio run --target clean
-
-If you don't have installed required platforms, then *PlatformIO* will propose
-you to install them automatically.
-
-Further examples can be found in `PlatformIO Repository <https://github.com/platformio/platformio/tree/develop/examples>`_.
-
-Also, for more detailed information as for commands please go to
-:ref:`userguide` sections.

docs/userguide/cmd_boards.rst

@@ -1,125 +0,0 @@
-.. _cmd_boards:
-
-platformio boards
-=================
-
-.. contents::
-
-Usage
------
-
-.. code-block:: bash
-
-    # Print all available pre-configured embedded boards
-    platformio boards
-
-    # Filter boards by "Query"
-    platformio boards QUERY
-
-
-Description
------------
-
-List pre-configured Embedded Boards
-
-
-Examples
---------
-
-1. Show Arduino-based boards
-
-.. code-block:: bash
-
-    $ platformio boards arduino
-
-    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. Show mbed-enabled boards
-
-.. code-block:: bash
-
-    $ platformio boards mbed
-
-    Platform: freescalekinetis
-    ---------------------------------------------------------------------------
-    Type                  MCU            Frequency  Flash   RAM    Name
-    ---------------------------------------------------------------------------
-    frdm_k20d50m          mk20dx128vlh5  48Mhz     128Kb   16Kb   Freescale Kinetis FRDM-K20D50M
-    frdm_k22f             mk22fn512vlh12 120Mhz    512Kb   128Kb  Freescale Kinetis FRDM-K22F
-    ...
-
-    Platform: nordicnrf51
-    ---------------------------------------------------------------------------
-    Type                  MCU            Frequency  Flash   RAM    Name
-    ---------------------------------------------------------------------------
-    wallBotBLE            nrf51822       16Mhz     128Kb   16Kb   JKSoft Wallbot BLE
-    nrf51_dk              nrf51822       32Mhz     256Kb   32Kb   Nordic nRF51-DK
-    ...
-
-    Platform: nxplpc
-    ---------------------------------------------------------------------------
-    Type                  MCU            Frequency  Flash   RAM    Name
-    ---------------------------------------------------------------------------
-    blueboard_lpc11u24    lpc11u24       48Mhz     32Kb    8Kb    BlueBoard-LPC11U24
-    dipcortexm0           lpc11u24       50Mhz     32Kb    8Kb    DipCortex M0
-    lpc11u35              lpc11u35       48Mhz     64Kb    10Kb   EA LPC11U35 QuickStart Board
-    ...
-
-    Platform: ststm32
-    ---------------------------------------------------------------------------
-    Type                  MCU            Frequency  Flash   RAM    Name
-    ---------------------------------------------------------------------------
-    disco_f401vc          stm32f401vct6  84Mhz     256Kb   64Kb   32F401CDISCOVERY
-    nucleo_f030r8         stm32f030r8t6  48Mhz     64Kb    8Kb    ST Nucleo F030R8
-    ...
-
-3. Show boards which are based on ``ATmega168`` MCU
-
-.. code-block:: bash
-
-    $ platformio boards atmega168
-
-    Platform: atmelavr
-    ---------------------------------------------------------------------------
-    Type                  MCU           Frequency  Flash   RAM    Name
-    ---------------------------------------------------------------------------
-    btatmega168           atmega168     16Mhz     14Kb    1Kb    Arduino BT ATmega168
-    diecimilaatmega168    atmega168     16Mhz     14Kb    1Kb    Arduino Duemilanove or Diecimila ATmega168
-    miniatmega168         atmega168     16Mhz     14Kb    1Kb    Arduino Mini ATmega168
-    atmegangatmega168     atmega168     16Mhz     14Kb    1Kb    Arduino NG or older ATmega168
-    nanoatmega168         atmega168     16Mhz     14Kb    1Kb    Arduino Nano ATmega168
-    pro8MHzatmega168      atmega168     8Mhz      14Kb    1Kb    Arduino Pro or Pro Mini ATmega168 (3.3V, 8 MHz)
-    pro16MHzatmega168     atmega168     16Mhz     14Kb    1Kb    Arduino Pro or Pro Mini ATmega168 (5V, 16 MHz)
-    lilypadatmega168      atmega168     8Mhz      14Kb    1Kb    LilyPad Arduino ATmega168
-    168pa16m              atmega168p    16Mhz     15Kb    1Kb    Microduino Core (Atmega168PA@16M,5V)
-    168pa8m               atmega168p    8Mhz      15Kb    1Kb    Microduino Core (Atmega168PA@8M,3.3V)
-
-4. Show boards by :ref:`platform_timsp430`
-
-.. code-block:: bash
-
-    $ platformio boards timsp430
-
-    Platform: timsp430
-    ---------------------------------------------------------------------------
-    Type                  MCU           Frequency  Flash   RAM    Name
-    ---------------------------------------------------------------------------
-    lpmsp430fr5739        msp430fr5739  16Mhz     15Kb    1Kb    FraunchPad w/ msp430fr5739
-    lpmsp430f5529         msp430f5529   16Mhz     128Kb   1Kb    LaunchPad w/ msp430f5529 (16MHz)
-    lpmsp430f5529_25      msp430f5529   25Mhz     128Kb   1Kb    LaunchPad w/ msp430f5529 (25MHz)
-    lpmsp430fr5969        msp430fr5969  8Mhz      64Kb    1Kb    LaunchPad w/ msp430fr5969
-    lpmsp430g2231         msp430g2231   1Mhz      2Kb     128B   LaunchPad w/ msp430g2231 (1MHz)
-    lpmsp430g2452         msp430g2452   16Mhz     8Kb     256B   LaunchPad w/ msp430g2452 (16MHz)
-    lpmsp430g2553         msp430g2553   16Mhz     16Kb    512B   LaunchPad w/ msp430g2553 (16MHz)
-

docs/userguide/cmd_ci.rst

@@ -1,110 +0,0 @@
-.. _cmd_ci:
-
-platformio ci
-=============
-
-.. contents::
-
-Usage
------
-
-.. code-block:: bash
-
-    platformio ci [OPTIONS] [SRC]
-
-
-Description
------------
-
-:ref:`cmd_ci` command is conceived of as "hot key" for building project with
-arbitrary source code structure. In a nutshell, using ``SRC`` and
-:option:`platformio ci --lib` contents PlatformIO initialises via
-:ref:`cmd_init` new project in :option:`platformio ci --build-dir`
-with the build environments (using :option:`platformio ci --board` or
-:option:`platformio ci --project-conf`) and processes them via :ref:`cmd_run`
-command.
-
-For more details as for integration with the popular Continuous Integration
-Systems please follow to :ref:`ci` page.
-
-.. note::
-    :ref:`cmd_ci` command accepts **multiple** ``SRC`` arguments,
-    :option:`platformio ci --lib` and :option:`platformio ci --exclude` options
-    which can be a path to directory, file or
-    `Glob Pattern <http://en.wikipedia.org/wiki/Glob_(programming)>`_.
-
-.. note::
-    You can omit ``SRC`` argument and set path (multiple paths are allowed
-    denoting with ``:``) to
-    ``PLATFORMIO_CI_SRC`` `Environment variable <http://en.wikipedia.org/wiki/Environment_variable>`_
-
-Options
--------
-
-.. program:: platformio ci
-
-.. option::
-    -l, --lib
-
-Source code which will be copied to ``%build_dir%/lib`` directly.
-
-If :option:`platformio ci --lib` is a path to file (not to directory), then
-PlatformIO will create temporary directory within ``%build_dir%/lib`` and copy
-the rest files into it.
-
-
-.. option::
-    --exclude
-
-Exclude directories and/-or files from :option:`platformio ci --build-dir`. The
-path must be relative to PlatformIO project within
-:option:`platformio ci --build-dir`.
-
-For example, exclude from project ``src`` directory:
-
-* ``examples`` folder
-* ``*.h`` files from ``foo`` folder
-
-.. code-block:: bash
-
-    platformio ci --exclude=src/examples --exclude=src/foo/*.h [SRC]
-
-.. option::
-    -b, --board
-
-Build project with automatically pre-generated environments based on board
-settings.
-
-For more details please look into :option:`platformio init --board`.
-
-.. option::
-    --build-dir
-
-Path to directory where PlatformIO will initialise new project. By default it's
-temporary directory within your operation system.
-
-.. note::
-
-    This directory will be removed at the end of build process. If you want to
-    keep it, please use :option:`platformio ci --keep-build-dir`.
-
-.. option::
-    --keep-build-dir
-
-Don't remove :option:`platformio ci --build-dir` after build process.
-
-.. option::
-    --project-conf
-
-Buid project using pre-configured :ref:`projectconf`.
-
-.. option::
-    -v, --verbose
-
-Shows details about the results of processing environments. More details
-:option:`platformio run --verbose`
-
-Examples
---------
-
-For the examples please follow to :ref:`ci` page.

docs/userguide/cmd_init.rst

@@ -1,142 +0,0 @@
-.. _cmd_init:
-
-platformio init
-===============
-
-.. contents::
-
-Usage
------
-
-.. code-block:: bash
-
-    platformio init [OPTIONS]
-
-
-Description
------------
-
-Initialize new PlatformIO based project.
-
-
-This command will create:
-
-* :ref:`projectconf`
-* ``src`` - a source directory. Put your source code here
-* ``lib`` - a directory for the project specific libraries. PlatformIO will
-  compile them to static libraries and link to executable file
-
-Options
--------
-
-.. program:: platformio init
-
-.. option::
-    -d, --project-dir
-
-A path to the directory where *PlatformIO* will initialise new project.
-
-.. option::
-    -b, --board
-
-If you specify board ``type`` (you can pass multiple ``--board`` options), then
-*PlatformIO* will automatically generate environment for :ref:`projectconf` and
-pre-fill these data:
-
-* :ref:`projectconf_env_platform`
-* :ref:`projectconf_env_framework`
-* :ref:`projectconf_env_board`
-
-The full list with pre-configured boards is available here :ref:`platforms`.
-
-.. option::
-    --ide
-
-Initialise PlatformIO project for the specified IDE which can be imported later
-via "Import Project" functionality.
-
-A list with supported IDE is available within ``platformio init --help`` command.
-Also, please look into :ref:`ide` page.
-
-.. option::
-    --disable-auto-uploading
-
-If you initialise project with the specified
-:option:`platformio init --board`, then *PlatformIO*
-will create environment with enabled firmware auto-uploading. This option
-allows you to disable firmware auto-uploading by default.
-
-.. option::
-    --env-prefix
-
-An environment prefix which will be used with pair in board type.
-
-For example, the default environment name for ``teensy_31`` board will
-be ``[env:teensy_31]``.
-
-
-Examples
---------
-
-1. Create new project in the current working directory
-
-.. code-block:: bash
-
-    $ platformio init
-
-    The current working directory *** will be used for the new project.
-    You can specify another project directory via
-    `platformio init -d %PATH_TO_THE_PROJECT_DIR%` command.
-
-    The next files/directories will be created in ***
-    platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
-    src - Put your source code here
-    lib - Put here project specific or 3-rd party libraries
-    Do you want to continue? [y/N]: y
-    Project has been successfully initialized!
-    Useful commands:
-    `platformio run` - process/build project from the current directory
-    `platformio run --target upload` or `platformio run -t upload` - upload firmware to embedded board
-    `platformio run --target clean` - clean project (remove compiled files)
-
-
-2. Create new project in the specified directory
-
-.. code-block:: bash
-
-    $ platformio init -d %PATH_TO_DIR%
-
-    The next files/directories will be created in ***
-     platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
-    src - Put your source code here
-    lib - Put here project specific or 3-rd party libraries
-    Do you want to continue? [y/N]: y
-    Project has been successfully initialized!
-    Useful commands:
-    `platformio run` - process/build project from the current directory
-    `platformio run --target upload` or `platformio run -t upload` - upload firmware to embedded board
-    `platformio run --target clean` - clean project (remove compiled files)
-
-3. Initialise project for Arduino Uno
-
-.. code-block:: bash
-
-    $ platformio init --board uno
-
-    Would you like to enable firmware auto-uploading when project is successfully built using `platformio run` command?
-    Don't forget that you can upload firmware manually using `platformio run --target upload` command. [y/N]: y
-
-    The current working directory *** will be used for the new project.
-    You can specify another project directory via
-    `platformio init -d %PATH_TO_THE_PROJECT_DIR%` command.
-
-    The next files/directories will be created in ***
-    platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
-    src - Put your source code here
-    lib - Put here project specific or 3-rd party libraries
-    Do you want to continue? [y/N]: y
-    Project has been successfully initialized!
-    Useful commands:
-    `platformio run` - process/build project from the current directory
-    `platformio run --target upload` or `platformio run -t upload` - upload firmware to embedded board
-    `platformio run --target clean` - clean project (remove compiled files)

docs/userguide/cmd_run.rst

@@ -1,153 +0,0 @@
-.. _cmd_run:
-
-platformio run
-==============
-
-.. contents::
-
-Usage
------
-
-.. code-block:: bash
-
-    platformio run [OPTIONS]
-
-
-Description
------------
-
-Process environments which are defined in :ref:`projectconf` file
-
-
-Options
--------
-
-.. program:: platformio run
-
-.. option::
-    -e, --environment
-
-Process specified environments
-
-
-.. option::
-    -t, --target
-
-Process specified targets
-
-.. option::
-    --upload-port
-
-Upload port of embedded board. To print all available ports use
-:ref:`cmd_serialports` command
-
-.. option::
-    --build-dir
-
-Specify the path to project directory. By default, ``--build-dir`` is equal to
-current working directory (``CWD``).
-
-.. option::
-    -v, --verbose
-
-Shows details about the results of processing environments. Each instance of
-``--verbose`` on the command line increases the verbosity level by one, so if
-you need more details on the output, specify it twice.
-
-There 3 levels of verbosity:
-
-1. ``-v`` - output errors only
-2. ``-vv`` - output errors and warnings
-3. ``-vvv`` - output errors, warnings and additional information
-
-By default, verbosity level is set to 3 (maximum information).
-
-Examples
---------
-
-1. Process `Wiring Blink Example <https://github.com/platformio/platformio/tree/develop/examples/wiring-blink>`_
-
-.. code-block::   bash
-
-    $ platformio run
-    Processing arduino_pro5v environment:
-    scons: `.pioenvs/arduino_pro5v/firmware.elf' is up to date.
-    scons: `.pioenvs/arduino_pro5v/firmware.hex' is up to date.
-
-    Processing launchpad_msp430g2 environment:
-    scons: `.pioenvs/launchpad_msp430g2/firmware.elf' is up to date.
-    scons: `.pioenvs/launchpad_msp430g2/firmware.hex' is up to date.
-
-    Processing launchpad_lm4f120 environment:
-    scons: `.pioenvs/launchpad_lm4f120/firmware.elf' is up to date.
-    scons: `.pioenvs/launchpad_lm4f120/firmware.hex' is up to   date
-
-
-2. Process specific environment
-
-.. code-block:: bash
-
-    $ platformio run -e arduino_pro5v -e launchpad_lm4f120
-    Processing arduino_pro5v environment:
-    scons: `.pioenvs/arduino_pro5v/firmware.elf' is up to date.
-    scons: `.pioenvs/arduino_pro5v/firmware.hex' is up to date.
-
-    Processing launchpad_lm4f120 environment:
-    scons: `.pioenvs/launchpad_lm4f120/firmware.elf' is up to date.
-    scons: `.pioenvs/launchpad_lm4f120/firmware.hex' is up to date.
-
-
-3. Process specific target
-
-.. code-block:: bash
-
-    $ platformio run -t clean
-    Processing arduino_pro5v environment:
-    Removed .pioenvs/arduino_pro5v/src/main.o
-    ...
-    Removed .pioenvs/arduino_pro5v/firmware.hex
-
-    Processing launchpad_msp430g2 environment:
-    Removed .pioenvs/launchpad_msp430g2/src/main.o
-    ...
-    Removed .pioenvs/launchpad_msp430g2/firmware.hex
-
-    Processing launchpad_lm4f120 environment:
-    Removed .pioenvs/launchpad_lm4f120/src/main.o
-    ...
-    Removed .pioenvs/launchpad_lm4f120/firmware.hex
-
-
-4. Mix environments and targets
-
-.. code-block:: bash
-
-    $ platformio run -e launchpad_msp430g2 -t upload
-    Processing launchpad_msp430g2 environment:
-    /Users/ikravets/.platformio/timsp430/tools/mspdebug/mspdebug rf2500 --force-reset "prog .pioenvs/launchpad_msp430g2/firmware.hex"
-    MSPDebug version 0.20 - debugging tool for MSP430 MCUs
-    Copyright (C) 2009-2012 Daniel Beer <dlbeer@gmail.com>
-    This is free software; see the source for copying conditions.  There is NO
-    warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-
-    Trying to open interface 1 on 009
-    Initializing FET...
-    FET protocol version is 30394216
-    Configured for Spy-Bi-Wire
-    Sending reset...
-    Set Vcc: 3000 mV
-    Device ID: 0x2553
-      Code start address: 0xc000
-      Code size         : 16384 byte = 16 kb
-      RAM  start address: 0x200
-      RAM  end   address: 0x3ff
-      RAM  size         : 512 byte = 0 kb
-    Device: MSP430G2553/G2403
-    Code memory starts at 0xc000
-    Number of breakpoints: 2
-    Chip ID data: 25 53
-    Erasing...
-    Programming...
-    Writing  646 bytes at c000...
-    Writing   32 bytes at ffe0...
-    Done, 678 bytes total

docs/userguide/cmd_serialports.rst

@@ -1,257 +0,0 @@
-.. _cmd_serialports:
-
-platformio serialports
-======================
-
-.. contents::
-
-platformio serialports list
----------------------------
-
-Usage
-~~~~~
-
-.. code-block:: bash
-
-    platformio serialports list [OPTIONS]
-
-
-Description
-~~~~~~~~~~~
-
-List available `Serial Ports <http://en.wikipedia.org/wiki/Serial_port>`_
-
-Options
-~~~~~~~
-
-.. program:: platformio serialports list
-
-.. option::
-    --json-output
-
-Return the output in `JSON <http://en.wikipedia.org/wiki/JSON>`_ format
-
-
-Examples
-~~~~~~~~
-
-1. Unix OS
-
-.. code-block:: bash
-
-    $ platformio serialports list
-    /dev/cu.SLAB_USBtoUART
-    ----------
-    Hardware ID: USB VID:PID=10c4:ea60 SNR=0001
-    Description: CP2102 USB to UART Bridge Controller
-
-    /dev/cu.uart-1CFF4676258F4543
-    ----------
-    Hardware ID: USB VID:PID=451:f432 SNR=1CFF4676258F4543
-    Description: Texas Instruments MSP-FET430UIF
-
-
-2. Windows OS
-
-.. code-block:: bash
-
-    $ platformio serialports list
-    COM4
-    ----------
-    Hardware ID: USB VID:PID=0451:F432
-    Description: MSP430 Application UART (COM4)
-
-    COM3
-    ----------
-    Hardware ID: USB VID:PID=10C4:EA60 SNR=0001
-    Description: Silicon Labs CP210x USB to UART Bridge (COM3)
-
-
-.. _cmd_serialports_monitor:
-
-platformio serialports monitor
-------------------------------
-
-Usage
-~~~~~
-
-.. code-block:: bash
-
-    platformio serialports monitor [OPTIONS]
-
-
-Description
-~~~~~~~~~~~
-
-This is a console application that provides a small terminal
-application. It is based on `Miniterm <http://pyserial.sourceforge.net/examples.html#miniterm>`_
-and itself does not implement any terminal features such
-as *VT102* compatibility. However it inherits these features from the terminal
-it is run. For example on GNU/Linux running from an *xterm* it will support the
-escape sequences of the *xterm*. On *Windows* the typical console window is dumb
-and does not support any escapes. When *ANSI.sys* is loaded it supports some
-escapes.
-
-To control *monitor* please use these "hot keys":
-
-* ``Ctrl+]`` Quit
-* ``Ctrl+T`` Menu
-* ``Ctrl+T followed by Ctrl+H`` Help
-
-Options
-~~~~~~~
-
-.. program:: platformio serialports monitor
-
-.. option::
-    -p, --port
-
-Port, a number or a device name
-
-.. option::
-    -b, --baud
-
-Set baud rate, default ``9600``
-
-.. option::
-    --parity
-
-Set parity (*None, Even, Odd, Space, Mark*), one of
-[``N``, ``E``, ``O``, ``S``, ``M``], default ``N``
-
-.. option::
-    --rtscts
-
-Enable ``RTS/CTS`` flow control, default ``Off``
-
-.. option::
-    --xonxoff
-
-Enable software flow control, default ``Off``
-
-.. option::
-    --rts
-
-Set initial ``RTS`` line state, default ``0``
-
-.. option::
-    --dtr
-
-Set initial ``DTR`` line state, default ``0``
-
-.. option::
-    --echo
-
-Enable local echo, default ``Off``
-
-.. option::
-    --cr
-
-Do not send ``CR+LF``, send ``R`` only, default ``Off``
-
-.. option::
-    --lf
-
-Do not send ``CR+LF``, send ``LF`` only, default ``Off``
-
-.. option::
-    -d, --debug
-
-Debug received data (escape non-printable chars). ``--debug`` can be given
-multiple times:
-
-0. just print what is received
-1. escape non-printable characters, do newlines as unusual
-2. escape non-printable characters, newlines too
-3. hex dump everything
-
-.. option::
-    --exit-char
-
-ASCII code of special character that is used to exit the application,
-default ``0x1d``
-
-.. option::
-    --menu-char
-
-ASCII code of special character that is used to control miniterm (menu),
-default ``0x14``
-
-.. option::
-    ---quiet
-
-Diagnostics: suppress non-error messages, default ``Off``
-
-Examples
-~~~~~~~~
-
-1. Show available options for *monitor*
-
-.. code-block:: bash
-
-    $ platformio serialports monitor --help
-    Usage: platformio serialports monitor [OPTIONS]
-
-    Options:
-      -p, --port TEXT       Port, a number or a device name
-      -b, --baud INTEGER    Set baud rate, default=9600
-      --parity [N|E|O|S|M]  Set parity, default=N
-      --rtscts              Enable RTS/CTS flow control, default=Off
-      --xonxoff             Enable software flow control, default=Off
-      --rts [0|1]           Set initial RTS line state, default=0
-      --dtr [0|1]           Set initial DTR line state, default=0
-      --echo                Enable local echo, default=Off
-      --cr                  Do not send CR+LF, send CR only, default=Off
-      --lf                  Do not send CR+LF, send LF only, default=Off
-      -d, --debug           Debug received data (escape non-printable chars)
-                            --debug can be given multiple times:
-                            0: just print what is received
-                            1: escape non-printable characters, do newlines as
-                               unusual
-                            2: escape non-printable characters, newlines too
-                            3: hex dump everything
-      --exit-char INTEGER   ASCII code of special character that is used to exit
-                            the application, default=0x1d
-      --menu-char INTEGER   ASCII code of special character that is used to
-                            control miniterm (menu), default=0x14
-      --quiet               Diagnostics: suppress non-error messages, default=Off
-      --help                Show this message and exit.
-
-2. Communicate with serial device and print help inside terminal
-
-.. code-block:: bash
-
-    $ platformio serialports monitor
-
-    --- Available ports:
-    --- /dev/cu.Bluetooth-Incoming-Port n/a
-    --- /dev/cu.Bluetooth-Modem n/a
-    --- /dev/cu.SLAB_USBtoUART CP2102 USB to UART Bridge Controller
-    --- /dev/cu.obd2ecu-SPPDev n/a
-    Enter port name:/dev/cu.SLAB_USBtoUART
-    --- Miniterm on /dev/cu.SLAB_USBtoUART: 9600,8,N,1 ---
-    --- Quit: Ctrl+]  |  Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
-    Hello PlatformIO!
-    --- pySerial (2.7) - miniterm - help
-    ---
-    --- Ctrl+]   Exit program
-    --- Ctrl+T   Menu escape key, followed by:
-    --- Menu keys:
-    ---    Ctrl+T  Send the menu character itself to remote
-    ---    Ctrl+]  Send the exit character itself to remote
-    ---    Ctrl+I  Show info
-    ---    Ctrl+U  Upload file (prompt will be shown)
-    --- Toggles:
-    ---    Ctrl+R  RTS          Ctrl+E  local echo
-    ---    Ctrl+D  DTR          Ctrl+B  BREAK
-    ---    Ctrl+L  line feed    Ctrl+A  Cycle repr mode
-    ---
-    --- Port settings (Ctrl+T followed by the following):
-    ---    p          change port
-    ---    7 8        set data bits
-    ---    n e o s m  change parity (None, Even, Odd, Space, Mark)
-    ---    1 2 3      set stop bits (1, 2, 1.5)
-    ---    b          change baud rate
-    ---    x X        disable/enable software flow control
-    ---    r R        disable/enable hardware flow control
-    --- exit ---

docs/userguide/cmd_settings.rst

@@ -1,203 +0,0 @@
-.. _cmd_settings:
-
-platformio settings
-===================
-
-Manage PlatformIO settings
-
-.. contents::
-
-platformio settings get
------------------------
-
-Usage
-~~~~~
-
-.. code-block:: bash
-
-    platformio settings get [NAME]
-
-
-Description
-~~~~~~~~~~~
-
-Get/List existing settings
-
-Settings
-~~~~~~~~
-
-.. _setting_auto_update_libraries:
-
-``auto_update_libraries``
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-:Default:   Yes
-:Values:    Yes/No
-
-Automatically update libraries.
-
-.. _setting_auto_update_platforms:
-
-``auto_update_platforms``
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-:Default:   Yes
-:Values:    Yes/No
-
-Automatically update platforms.
-
-.. _setting_check_libraries_interval:
-
-``check_libraries_interval``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-:Default:   7
-:Values:    Days (Number)
-
-Check for the library updates interval.
-
-.. _setting_check_platformio_interval:
-
-``check_platformio_interval``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-:Default:   3
-:Values:    Days (Number)
-
-Check for the new PlatformIO interval.
-
-.. _setting_check_platforms_interval:
-
-``check_platforms_interval``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-:Default:   7
-:Values:    Days (Number)
-
-Check for the platform updates interval.
-
-.. _setting_enable_prompts:
-
-``enable_prompts``
-^^^^^^^^^^^^^^^^^^
-
-:Default:   Yes
-:Values:    Yes/No
-
-Can PlatformIO communicate with you via prompts?
-
-* propose to install platforms which aren't installed yet
-* paginate over library search results
-* and etc.
-
-.. warning::
-    If you are going to run *PlatformIO* from **subprocess**, you **MUST
-    DISABLE** all prompts. It will allow you to avoid blocking.
-
-.. _setting_enable_telemetry:
-
-``enable_telemetry``
-^^^^^^^^^^^^^^^^^^^^
-
-:Default:   Yes
-:Values:    Yes/No
-
-Shares commands, platforms and libraries usage to help us make PlatformIO
-better.
-
-
-.. note::
-    * The ``Yes`` value is equl to: ``True``, ``Y``, ``1``.
-      The value is not case sensetive.
-    * You can override these settings using :ref:`envvars`.
-
-Examples
-~~~~~~~~
-
-1. List all settings and theirs current values
-
-.. code-block:: bash
-
-    $ platformio settings get
-    Name                            Value [Default]   Description
-    ------------------------------------------------------------------------------------------
-    auto_update_libraries           Yes               Automatically update libraries (Yes/No)
-    auto_update_platforms           Yes               Automatically update platforms (Yes/No)
-    check_libraries_interval        7                 Check for the library updates interval (days)
-    check_platformio_interval       3                 Check for the new PlatformIO interval (days)
-    check_platforms_interval        7                 Check for the platform updates interval (days)
-    enable_prompts                  Yes               Can PlatformIO communicate with you via prompts: propose to install platforms which aren't installed yet, paginate over library search results and etc.)? ATTENTION!!! If you call PlatformIO like subprocess, please disable prompts to avoid blocking (Yes/No)
-    enable_telemetry                Yes               Shares commands, platforms and libraries usage to help us make PlatformIO better (Yes/No)
-
-
-2. Show specified setting
-
-.. code-block:: bash
-
-    $ platformio settings get auto_update_platforms
-    Name                            Value [Default]   Description
-    ------------------------------------------------------------------------------------------
-    auto_update_platforms           Yes               Automatically update platforms (Yes/No)
-
-
-platformio settings set
------------------------
-
-Usage
-~~~~~
-
-.. code-block:: bash
-
-    platformio settings set NAME VALUE
-
-
-Description
-~~~~~~~~~~~
-
-Set new value for the setting
-
-Examples
-~~~~~~~~
-
-Change to check for the new PlatformIO each day
-
-.. code-block:: bash
-
-    $ platformio settings set check_platformio_interval 1
-    The new value for the setting has been set!
-    Name                            Value [Default]   Description
-    ------------------------------------------------------------------------------------------
-    check_platformio_interval       1 [3]             Check for the new PlatformIO interval (days)
-
-
-platformio settings reset
--------------------------
-
-Usage
-~~~~~
-
-.. code-block:: bash
-
-    platformio settings reset
-
-
-Description
-~~~~~~~~~~~
-
-Reset settings to default
-
-Examples
-~~~~~~~~
-
-.. code-block:: bash
-
-    $ platformio settings reset
-    The settings have been reseted!
-
-    Name                            Value [Default]   Description
-    ------------------------------------------------------------------------------------------
-    auto_update_libraries           Yes               Automatically update libraries (Yes/No)
-    auto_update_platforms           Yes               Automatically update platforms (Yes/No)
-    check_libraries_interval        7                 Check for the library updates interval (days)
-    check_platformio_interval       3                 Check for the new PlatformIO interval (days)
-    check_platforms_interval        7                 Check for the platform updates interval (days)

docs/userguide/cmd_update.rst

@@ -1,100 +0,0 @@
-.. _cmd_update:
-
-platformio update
-=================
-
-.. contents::
-
-Usage
------
-
-.. code-block:: bash
-
-    platformio update
-
-
-Description
------------
-
-Check or update installed :ref:`Platforms <platforms>` and
-:ref:`Libraries <librarymanager>`
-
-
-Examples
---------
-
-.. code-block:: bash
-
-    $ platformio update
-
-    Platform atmelavr
-    --------
-    Updating toolchain-atmelavr package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating tool-avrdude package:
-    Versions: Current=2, Latest=2 	 [Up-to-date]
-    Updating framework-arduinoavr package:
-    Versions: Current=12, Latest=12 	 [Up-to-date]
-    Updating tool-micronucleus package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-
-    Platform atmelsam
-    --------
-    Updating framework-arduinosam package:
-    Versions: Current=3, Latest=3 	 [Up-to-date]
-    Updating ldscripts package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating toolchain-gccarmnoneeabi package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating tool-bossac package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-
-    Platform stm32
-    --------
-    Updating toolchain-gccarmnoneeabi package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating tool-stlink package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating framework-spl package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating framework-cmsis package:
-    Versions: Current=2, Latest=2 	 [Up-to-date]
-    Updating framework-opencm3 package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating ldscripts package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-
-    Platform teensy
-    --------
-    Updating toolchain-atmelavr package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating ldscripts package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating framework-arduinoteensy package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating toolchain-gccarmnoneeabi package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating tool-teensy package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-
-    Platform timsp430
-    --------
-    Updating toolchain-timsp430 package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating tool-mspdebug package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating framework-energiamsp430 package:
-    Versions: Current=2, Latest=2 	 [Up-to-date]
-
-    Platform titiva
-    --------
-    Updating ldscripts package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating toolchain-gccarmnoneeabi package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating tool-lm4flash package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating framework-opencm3 package:
-    Versions: Current=1, Latest=1 	 [Up-to-date]
-    Updating framework-energiativa package:
-    Versions: Current=4, Latest=4 	 [Up-to-date]