diff --git a/docs/ci/appveyor.rst b/docs/ci/appveyor.rst index af246a86..2341c0e3 100644 --- a/docs/ci/appveyor.rst +++ b/docs/ci/appveyor.rst @@ -56,7 +56,7 @@ Put ``appveyor.yml`` to the root directory of the GitHub repository. - cmd: pip install -U platformio test_script: - - cmd: platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N + - cmd: platformio ci --board=ID_1 --board=ID_2 --board=ID_N For more details as for PlatformIO build process please look into :ref:`cmd_ci` diff --git a/docs/ci/circleci.rst b/docs/ci/circleci.rst index c159a4ef..d3e09fa9 100644 --- a/docs/ci/circleci.rst +++ b/docs/ci/circleci.rst @@ -49,9 +49,9 @@ guide first. test: override: - - platformio ci path/to/test/file.c --board=TYPE_1 --board=TYPE_2 --board=TYPE_N - - platformio ci examples/file.ino --board=TYPE_1 --board=TYPE_2 --board=TYPE_N - - platformio ci path/to/test/directory --board=TYPE_1 --board=TYPE_2 --board=TYPE_N + - platformio ci path/to/test/file.c --board=ID_1 --board=ID_2 --board=ID_N + - platformio ci examples/file.ino --board=ID_1 --board=ID_2 --board=ID_N + - platformio ci path/to/test/directory --board=ID_1 --board=ID_2 --board=ID_N For more details as for PlatformIO build process please look into :ref:`cmd_ci`. @@ -65,7 +65,7 @@ it), please use ``--lib="."`` option for :ref:`cmd_ci` command .. code-block:: yaml script: - - platformio ci --lib="." --board=TYPE_1 --board=TYPE_2 --board=TYPE_N + - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N Library dependecies ~~~~~~~~~~~~~~~~~~~ @@ -87,7 +87,7 @@ Install dependent library using :ref:`librarymanager` test: override: - - platformio ci path/to/test/file.c --board=TYPE_1 --board=TYPE_2 --board=TYPE_N + - platformio ci path/to/test/file.c --board=ID_1 --board=ID_2 --board=ID_N Manually download dependent library and include in build process via ``--lib`` option ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -105,7 +105,7 @@ Manually download dependent library and include in build process via ``--lib`` o test: override: - - platformio ci path/to/test/file.c --lib="/tmp/OneWire-master" --board=TYPE_1 --board=TYPE_2 --board=TYPE_N + - platformio ci path/to/test/file.c --lib="/tmp/OneWire-master" --board=ID_1 --board=ID_2 --board=ID_N Custom Build Flags ~~~~~~~~~~~~~~~~~~ diff --git a/docs/ci/drone.rst b/docs/ci/drone.rst index 8156a449..ec9d1118 100644 --- a/docs/ci/drone.rst +++ b/docs/ci/drone.rst @@ -51,7 +51,7 @@ Please fill all fields for your project in the Drone control panel: .. code-block:: bash pip install -U platformio - platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N + platformio ci --board=ID_1 --board=ID_2 --board=ID_N .. image:: ../_static/droneci-platformio-integration-1.png diff --git a/docs/ci/shippable.rst b/docs/ci/shippable.rst index aafc2d07..4a71e7a7 100644 --- a/docs/ci/shippable.rst +++ b/docs/ci/shippable.rst @@ -58,7 +58,7 @@ GitHub repository. - pip install -U platformio script: - - platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N + - platformio ci --board=ID_1 --board=ID_2 --board=ID_N For more details as for PlatformIO build process please look into :ref:`cmd_ci` diff --git a/docs/ci/travis.rst b/docs/ci/travis.rst index 53ff0f06..df48556a 100644 --- a/docs/ci/travis.rst +++ b/docs/ci/travis.rst @@ -72,7 +72,7 @@ PlatformIO is written in Python and is recommended to be run within - pip install -U platformio script: - - platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N + - platformio ci --board=ID_1 --board=ID_2 --board=ID_N Then perform steps 1, 2 and 4 from http://docs.travis-ci.com/user/getting-started/ @@ -87,7 +87,7 @@ it), please use ``--lib="."`` option for :ref:`cmd_ci` command .. code-block:: yaml script: - - platformio ci --lib="." --board=TYPE_1 --board=TYPE_2 --board=TYPE_N + - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N Library dependecies ~~~~~~~~~~~~~~~~~~~ @@ -121,7 +121,7 @@ Manually download dependent library and include in build process via ``--lib`` o - unzip /tmp/onewire_source.zip -d /tmp/ script: - - platformio ci --lib="/tmp/OneWire-master" --board=TYPE_1 --board=TYPE_2 --board=TYPE_N + - platformio ci --lib="/tmp/OneWire-master" --board=ID_1 --board=ID_2 --board=ID_N Custom Build Flags ~~~~~~~~~~~~~~~~~~ diff --git a/docs/ide/clion.rst b/docs/ide/clion.rst index 01600f2e..2d04fbbd 100644 --- a/docs/ide/clion.rst +++ b/docs/ide/clion.rst @@ -31,12 +31,12 @@ page for more detailed information. Integration ----------- -Choose board ``type`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ +Choose board ``ID`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide clion --board %TYPE% + platformio init --ide clion --board %ID% # For example, generate project for Arduino UNO platformio init --ide clion --board uno diff --git a/docs/ide/codeblocks.rst b/docs/ide/codeblocks.rst index dd1857dd..7ac5b3c6 100644 --- a/docs/ide/codeblocks.rst +++ b/docs/ide/codeblocks.rst @@ -30,12 +30,12 @@ CodeBlocks IDE can be downloaded from `here `_ +Choose board ``ID`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide codeblocks --board %TYPE% + platformio init --ide codeblocks --board %ID% # For example, generate project for Arduino UNO platformio init --ide codeblocks --board uno diff --git a/docs/ide/eclipse.rst b/docs/ide/eclipse.rst index 558117c8..418cdec7 100644 --- a/docs/ide/eclipse.rst +++ b/docs/ide/eclipse.rst @@ -35,12 +35,12 @@ page for more detailed information. Integration ----------- -Choose board ``type`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ +Choose board ``ID`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide eclipse --board %TYPE% + platformio init --ide eclipse --board %ID% # For example, generate project for Arduino UNO platformio init --ide eclipse --board uno diff --git a/docs/ide/emacs.rst b/docs/ide/emacs.rst index 769a64ce..768c6333 100644 --- a/docs/ide/emacs.rst +++ b/docs/ide/emacs.rst @@ -45,12 +45,12 @@ Code completion can optionally be provided by installing `irony-mode `_ +Choose board ``ID`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide emacs --board %TYPE% + platformio init --ide emacs --board %ID% There are 6 predefined targets for building. diff --git a/docs/ide/netbeans.rst b/docs/ide/netbeans.rst index d4a95e98..dfe96f35 100644 --- a/docs/ide/netbeans.rst +++ b/docs/ide/netbeans.rst @@ -33,12 +33,12 @@ install the C/C++ development plugins). Integration ----------- -Choose board ``type`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ +Choose board ``ID`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide netbeans --board %TYPE% + platformio init --ide netbeans --board %ID% # For example, generate project for Arduino UNO platformio init --ide netbeans --board uno diff --git a/docs/ide/qtcreator.rst b/docs/ide/qtcreator.rst index a40f910a..2cacc2c8 100644 --- a/docs/ide/qtcreator.rst +++ b/docs/ide/qtcreator.rst @@ -35,12 +35,12 @@ Integration Project Generator ^^^^^^^^^^^^^^^^^ -Choose board ``type`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ +Choose board ``ID`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide qtcreator --board %TYPE% + platformio init --ide qtcreator --board %ID% # For example, generate project for Arduino UNO platformio init --ide qtcreator --board uno diff --git a/docs/ide/sublimetext.rst b/docs/ide/sublimetext.rst index 3342f5d4..150c7a96 100644 --- a/docs/ide/sublimetext.rst +++ b/docs/ide/sublimetext.rst @@ -42,12 +42,12 @@ steps and documentation. Project Generator ^^^^^^^^^^^^^^^^^ -Choose board ``type`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ +Choose board ``ID`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide sublimetext --board %TYPE% + platformio init --ide sublimetext --board %ID% # For example, generate project for Arduino UNO platformio init --ide sublimetext --board uno diff --git a/docs/ide/visualstudio.rst b/docs/ide/visualstudio.rst index ae58d2f5..ddcd2d54 100644 --- a/docs/ide/visualstudio.rst +++ b/docs/ide/visualstudio.rst @@ -35,12 +35,12 @@ Integration Project Generator ^^^^^^^^^^^^^^^^^ -Choose board ``type`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ +Choose board ``ID`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide sublimetext --board %TYPE% + platformio init --ide sublimetext --board %ID% # For example, generate project for Arduino UNO platformio init --ide visualstudio --board uno diff --git a/docs/userguide/cmd_init.rst b/docs/userguide/cmd_init.rst index 6605d9a0..eb001fdd 100644 --- a/docs/userguide/cmd_init.rst +++ b/docs/userguide/cmd_init.rst @@ -52,7 +52,7 @@ A path to the directory where *PlatformIO* will initialize new project. .. option:: -b, --board -If you specify board ``type`` (you can pass multiple ``--board`` options), then +If you specify board ``ID`` (you can pass multiple ``--board`` options), then *PlatformIO* will automatically generate environment for :ref:`projectconf` and pre-fill these data: diff --git a/examples b/examples index 67f0e894..8c4de49a 160000 --- a/examples +++ b/examples @@ -1 +1 @@ -Subproject commit 67f0e8946a680b17e2a49a8994713fe099306ae8 +Subproject commit 8c4de49a532ad1903a845b4b34d8fd4b244cb063 diff --git a/platformio/commands/platform.py b/platformio/commands/platform.py index c69c8ceb..7934ebe9 100644 --- a/platformio/commands/platform.py +++ b/platformio/commands/platform.py @@ -56,10 +56,9 @@ def platform_search(query, json_output): if query and query.lower() not in search_data.lower(): continue - # @TODO update API with NAME/TITLE platforms.append({ - "name": platform['type'], - "title": platform['name'], + "name": platform['name'], + "title": platform['title'], "description": platform['description'], "packages": platform['packages'] }) diff --git a/platformio/managers/platform.py b/platformio/managers/platform.py index fcfe3038..c4642365 100644 --- a/platformio/managers/platform.py +++ b/platformio/managers/platform.py @@ -117,12 +117,7 @@ class PlatformManager(BasePkgManager): @staticmethod @util.memoized def get_registered_boards(): - boards = util.get_api_result("/boards") - for item in boards: - # @TODO remove type from API - item['id'] = item['type'] - del item['type'] - return boards + return util.get_api_result("/boards") class PlatformFactory(object):