diff --git a/.coveragerc b/.coveragerc index 32d9f345..80716d3d 100644 --- a/.coveragerc +++ b/.coveragerc @@ -12,11 +12,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -[run] -omit = - platformio/builder/* -source = platformio - [report] # Regexes for lines to exclude from consideration exclude_lines = diff --git a/HISTORY.rst b/HISTORY.rst index 4b679f84..7fd48653 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -4,6 +4,66 @@ Release Notes PlatformIO 3.0 -------------- +3.1.0 (2016-09-19) +~~~~~~~~~~~~~~~~~~ + +* New! Dynamic variables/templates for `Project Configuration File "platformio.ini" `__ + (`issue #705 `_) +* Summary about processed environments + (`issue #777 `_) +* Implemented LocalCache system for API and improved a work in off-line mode +* Improved Project Generator when custom ``--project-option`` is passed to + `platformio init `__ + command +* Deprecated ``lib_force`` option, please use `lib_deps `__ instead +* Return valid exit code from ``plaformio test`` command +* Fixed Project Generator for CLion IDE using Windows OS + (`issue #785 `_) +* Fixed SSL Server-Name-Indication for Python < 2.7.9 + (`issue #774 `_) + +------- + +* Development platform `Espressif 8266 `__ + + + Add support for `SparkFun Blynk Board `_ + + Created `staging `__ + branch to work with development version of Arduino Framework + +* Development platform `Freescale Kinetis `__ + + + Added support for new boards: FRDM-KL26Z, FRDM-KL27Z, FRDM-KL43Z, Hexiwear + +* Development platform `Nordic nRF51 `__ + + + Added support for new boards: Seeed Arch BLE, Seeed Arch Link, Switch + Science mbed TY51822r3, y5 nRF51822 mbug, JKSoft Wallbot BLE + +* Development platform `NXP LPC `__ + + + Added support for new boards: ARM mbed LPC11U24 (+CAN), Bambino-210E, + CoCo-ri-Co!, DipCortex M3, LPCXpresso11U68, LPCXpresso824-MAX, mBuino, + MicroNFCBoard, NXP LPC11C24, NXP LPC11U34, EA LPC11U35 QuickStart Board, + NXP LPC11U37, NXP LPC2368, NXP LPC2460, NXP LPC800-MAX, Seeed Arch GPRS V2, + Seeed Xadow M0, Smeshlink xbed LPC1768, Switch Science mbed LPC824 + +* Development platform `ST STM32 `__ + + + New Arduino framework for ST STM32 - + `STM32Duino `__. + Supported boards: BluePill F103C8, Generic STM32F103C8, Generic STM32F103R8, + Generic STM32F103RB, Generic STM32F103RC, Generic STM32F103RE, Olimexino STM32 + + + Added support for new ARM mbed based boards: ST 32F746GDISCOVER, + MultiTech mDot, ST Nucleo F207ZG, ST Nucleo F429ZI, ST Nucleo F446ZE, + ST Nucleo F746ZG, ST Nucleo F767ZI, ST Nucleo L011K4, ST Nucleo L432KC, + Seeed Arch Max + +* Development platform `Teensy `__ + + + Added support for Teensy 3.5 and 3.6 boards + + Updated Arduino Framework for Teensy to v130 + 3.0.1 (2016-09-08) ~~~~~~~~~~~~~~~~~~ diff --git a/README.rst b/README.rst index 0505c762..a5e512d5 100644 --- a/README.rst +++ b/README.rst @@ -18,7 +18,7 @@ PlatformIO .. image:: https://img.shields.io/pypi/l/platformio.svg :target: https://pypi.python.org/pypi/platformio/ :alt: License -.. image:: https://img.shields.io/community/PlatformIO.png +.. image:: https://img.shields.io/PlatformIO/Community.png :alt: Community Forums :target: https://community.platformio.org .. image:: https://img.shields.io/PlatformIO/Plus.png?color=orange diff --git a/docs/articles.rst b/docs/articles.rst index 294922c7..89a2318e 100644 --- a/docs/articles.rst +++ b/docs/articles.rst @@ -23,6 +23,7 @@ Here are recent articles/reviews about PlatformIO: 2016 ^^^^ +* Sep 12, 2016 - **Pedro Minatel** - `OTA – Como programar o ESP8266 pelo WiFi no platformIO (OTA programming for ESP8266 via Wi-Fi using PlatformIO, Portuguese) `_ * Sep 2, 2016 - **Tinkerman** `ESP8266: Optimizing files for SPIFFS with Gulp `_ * Aug 28, 2016 - **Tom Parker** `Using the BBC micro:bit with PlatformIO `_ * Aug 24, 2016 - **Primal Cortex** `Cloud based continuous integration and delivery for IOT using PlatformIO `_ diff --git a/docs/demo.rst b/docs/demo.rst index b44a2c69..fe828233 100644 --- a/docs/demo.rst +++ b/docs/demo.rst @@ -55,7 +55,7 @@ Library Manager Used in demo ~~~~~~~~~~~~ -1. :ref:`userguide_lib` +1. :ref:`cmd_lib` 2. :ref:`platformio lib search 1-wire ` command 3. :ref:`platformio lib install 54 ` command 4. :ref:`platformio lib search -f mbed ` command diff --git a/docs/envvars.rst b/docs/envvars.rst index 7749e9ce..b66813ee 100644 --- a/docs/envvars.rst +++ b/docs/envvars.rst @@ -163,6 +163,6 @@ Allows to override setting :ref:`setting_enable_telemetry`. Allows to override setting :ref:`setting_force_verbose`. -.. envvar:: PLATFORMIO_SETTING_DISABLE_SSL +.. envvar:: PLATFORMIO_SETTING_ENABLE_SSL -Allows to override setting :ref:`setting_disable_ssl`. +Allows to override setting :ref:`setting_enable_ssl`. diff --git a/docs/frameworks/arduino.rst b/docs/frameworks/arduino.rst index d53926b3..3f48a7c4 100644 --- a/docs/frameworks/arduino.rst +++ b/docs/frameworks/arduino.rst @@ -45,6 +45,9 @@ Platforms * - :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_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_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 USB cable and a PC or Macintosh with a USB port. @@ -856,7 +859,7 @@ Espressif - ESP8266 - 80 MHz - 4096 Kb - - 50 Kb + - 80 Kb * - ``phoenix_v1`` - `Phoenix 1.0 `_ @@ -906,6 +909,68 @@ Fubarino - 512 Kb - 128 Kb +Generic +~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``bluepill_f103c8`` + - `BluePill F103C8 `_ + - STM32F103C8T6 + - 72 MHz + - 64 Kb + - 20 Kb + + * - ``genericSTM32F103C8`` + - `STM32F103C8 (20k RAM. 64k Flash) `_ + - STM32F103C8 + - 72 MHz + - 64 Kb + - 20 Kb + + * - ``genericSTM32F103CB`` + - `STM32F103CB (20k RAM. 128k Flash) `_ + - STM32F103CB + - 72 MHz + - 128 Kb + - 20 Kb + + * - ``genericSTM32F103R8`` + - `STM32F103R8 (20k RAM. 64 Flash) `_ + - STM32F103R8 + - 72 MHz + - 64 Kb + - 20 Kb + + * - ``genericSTM32F103RB`` + - `STM32F103RB (20k RAM. 128k Flash) `_ + - STM32F103RB + - 72 MHz + - 128 Kb + - 20 Kb + + * - ``genericSTM32F103RC`` + - `STM32F103RC (48k RAM. 256k Flash) `_ + - STM32F103RC + - 72 MHz + - 256 Kb + - 48 Kb + + * - ``genericSTM32F103RE`` + - `STM32F103RE (64k RAM. 512k Flash) `_ + - STM32F103RE + - 72 MHz + - 512 Kb + - 64 Kb + Generic ATTiny ~~~~~~~~~~~~~~ @@ -1233,6 +1298,13 @@ Olimex - Flash - RAM + * - ``maple`` + - `Olimexino STM32 `_ + - STM32F103RB_MAPLE + - 72 MHz + - 128 Kb + - 16.6015625 Kb + * - ``modwifi`` - `Olimex MOD-WIFI-ESP8266(-DEV) `_ - ESP8266 @@ -1590,6 +1662,13 @@ SparkFun - Flash - RAM + * - ``sparkfunBlynk`` + - `SparkFun Blynk Board `_ + - ESP8266 + - 80 MHz + - 4096 Kb + - 80 Kb + * - ``sparkfun_digitalsandbox`` - `SparkFun Digital Sandbox `_ - ATMEGA328P @@ -1749,6 +1828,20 @@ Teensy - 256 Kb - 64 Kb + * - ``teensy35`` + - `Teensy 3.5 `_ + - MK64FX512 + - 120 MHz + - 512 Kb + - 192 Kb + + * - ``teensy36`` + - `Teensy 3.6 `_ + - MK66FX1M0 + - 180 MHz + - 1024 Kb + - 256 Kb + * - ``teensylc`` - `Teensy LC `_ - MKL26Z64 diff --git a/docs/frameworks/mbed.rst b/docs/frameworks/mbed.rst index fb45d9a6..7a408511 100644 --- a/docs/frameworks/mbed.rst +++ b/docs/frameworks/mbed.rst @@ -170,6 +170,26 @@ Delta - 256 Kb - 32 Kb +Elektor Labs +~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``elektor_cocorico`` + - `CoCo-ri-Co! `_ + - LPC812 + - 30 MHz + - 16 Kb + - 4 Kb + Embedded Artists ~~~~~~~~~~~~~~~~ @@ -184,7 +204,7 @@ Embedded Artists - RAM * - ``lpc11u35`` - - `Embedded Artists LPC11U35 QuickStart Board `_ + - `EA LPC11U35 QuickStart Board `_ - LPC11U35 - 48 MHz - 64 Kb @@ -259,6 +279,27 @@ Freescale - 128 Kb - 16 Kb + * - ``frdm_kl26z`` + - `Freescale Kinetis FRDM-KL26Z `_ + - MKL26Z128VLH4 + - 48 MHz + - 128 Kb + - 16 Kb + + * - ``frdm_kl27z`` + - `Freescale Kinetis FRDM-KL27Z `_ + - MKL27Z64VLH4 + - 48 MHz + - 64 Kb + - 16 Kb + + * - ``frdm_kl43z`` + - `Freescale Kinetis FRDM-KL43Z `_ + - MKL43Z256VLH4 + - 48 MHz + - 256 Kb + - 32 Kb + * - ``frdm_kl46z`` - `Freescale Kinetis FRDM-KL46Z `_ - MKL46Z256VLL4 @@ -266,6 +307,26 @@ Freescale - 256 Kb - 32 Kb +GHI Electronics +~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``oc_mbuino`` + - `mBuino `_ + - LPC11U24 + - 50 MHz + - 32 Kb + - 10 Kb + Generic ~~~~~~~ @@ -299,13 +360,53 @@ JKSoft - Flash - RAM - * - ``wallBotBLE`` + * - ``wallbot_ble`` - `JKSoft Wallbot BLE `_ - NRF51822 - 16 MHz - 128 Kb - 16 Kb +Micromint +~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``lpc4330_m4`` + - `Bambino-210E `_ + - LPC4330 + - 204 MHz + - 8192 Kb + - 264 Kb + +MikroElektronika +~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``hexiwear`` + - `Hexiwear `_ + - MK64FN1M0VDC12 + - 120 MHz + - 1024 Kb + - 256 Kb + MultiTech ~~~~~~~~~ @@ -319,6 +420,13 @@ MultiTech - Flash - RAM + * - ``mts_mdot_f405rg`` + - `MultiTech mDot `_ + - STM32F411RET6 + - 100 MHz + - 512 Kb + - 128 Kb + * - ``mts_mdot_f411re`` - `MultiTech mDot F411 `_ - STM32F411RET6 @@ -359,6 +467,13 @@ NXP - Flash - RAM + * - ``lpc11c24`` + - `NXP LPC11C24 `_ + - LPC11C24 + - 48 MHz + - 32 Kb + - 8 Kb + * - ``lpc11u24`` - `NXP mbed LPC11U24 `_ - LPC11U24 @@ -366,6 +481,34 @@ NXP - 32 Kb - 8 Kb + * - ``lpc11u24_301`` + - `ARM mbed LPC11U24 (+CAN) `_ + - LPC11U24 + - 48 MHz + - 32 Kb + - 8 Kb + + * - ``lpc11u34_421`` + - `NXP LPC11U34 `_ + - LPC11U34 + - 48 MHz + - 64 Kb + - 8 Kb + + * - ``lpc11u37_501`` + - `NXP LPC11U37 `_ + - LPC11U37 + - 48 MHz + - 128 Kb + - 10 Kb + + * - ``lpc11u68`` + - `LPCXpresso11U68 `_ + - LPC11U68 + - 50 MHz + - 256 Kb + - 36 Kb + * - ``lpc1549`` - `NXP LPCXpresso1549 `_ - LPC1549 @@ -380,6 +523,41 @@ NXP - 512 Kb - 64 Kb + * - ``lpc2368`` + - `NXP LPC2368 `_ + - LPC2368 + - 72 MHz + - 512 Kb + - 58 Kb + + * - ``lpc2460`` + - `NXP LPC2460 `_ + - LPC2460 + - 72 MHz + - 64 Kb + - 16 Kb + + * - ``lpc812`` + - `NXP LPC800-MAX `_ + - LPC812 + - 30 MHz + - 16 Kb + - 4 Kb + + * - ``lpc824`` + - `LPCXpresso824-MAX `_ + - LPC824 + - 30 MHz + - 32 Kb + - 8 Kb + + * - ``micronfcboard`` + - `MicroNFCBoard `_ + - LPC11U34 + - 48 MHz + - 64 Kb + - 10 Kb + Nordic ~~~~~~ @@ -530,6 +708,13 @@ ST - 1024 Kb - 384 Kb + * - ``disco_f746ng`` + - `ST 32F746GDISCOVERY `_ + - STM32F746NGH6 + - 216 MHz + - 1024 Kb + - 320 Kb + * - ``disco_l053c8`` - `ST 32L0538DISCOVERY `_ - STM32L053C8T6 @@ -593,6 +778,13 @@ ST - 128 Kb - 20 Kb + * - ``nucleo_f207zg`` + - `ST Nucleo F207ZG `_ + - STM32F207ZGT6 + - 120 MHz + - 1024 Kb + - 128 Kb + * - ``nucleo_f302r8`` - `ST Nucleo F302R8 `_ - STM32F302R8T6 @@ -642,6 +834,13 @@ ST - 512 Kb - 128 Kb + * - ``nucleo_f429zi`` + - `ST Nucleo F429ZI `_ + - STM32F429ZIT6 + - 180 MHz + - 2048 Kb + - 256 Kb + * - ``nucleo_f446re`` - `ST Nucleo F446RE `_ - STM32F446RET6 @@ -649,6 +848,34 @@ ST - 512 Kb - 128 Kb + * - ``nucleo_f446ze`` + - `ST Nucleo F446ZE `_ + - STM32F446ZET6 + - 180 MHz + - 512 Kb + - 128 Kb + + * - ``nucleo_f746zg`` + - `ST Nucleo F746ZG `_ + - STM32F746ZGT6 + - 216 MHz + - 1024 Kb + - 320 Kb + + * - ``nucleo_f767zi`` + - `ST Nucleo F767ZI `_ + - STM32F746ZGT6 + - 216 MHz + - 2048 Kb + - 512 Kb + + * - ``nucleo_l011k4`` + - `ST Nucleo L011K4 `_ + - STM32L011K4T6 + - 32 MHz + - 16 Kb + - 2 Kb + * - ``nucleo_l031k6`` - `ST Nucleo L031K6 `_ - STM32L031K6T6 @@ -677,6 +904,13 @@ ST - 512 Kb - 80 Kb + * - ``nucleo_l432kc`` + - `ST Nucleo L432KC `_ + - STM32L432KCU6 + - 80 MHz + - 256 Kb + - 64 Kb + * - ``nucleo_l476rg`` - `ST Nucleo L476RG `_ - STM32L476RGT6 @@ -697,27 +931,55 @@ SeeedStudio - Flash - RAM - * - ``seeedArchMax`` - - `SeeedStudio Arch Max `_ - - STM32F407VET6 - - 168 MHz - - 512 Kb - - 192 Kb + * - ``seeedArchBLE`` + - `Seeed Arch BLE `_ + - NRF51822 + - 16 MHz + - 128 Kb + - 16 Kb - * - ``seeedTinyBLE`` - - `SeeedStudio Seeed Tiny BLE `_ + * - ``seeedArchGPRS`` + - `Seeed Arch GPRS V2 `_ + - LPC11U37 + - 48 MHz + - 128 Kb + - 10 Kb + + * - ``seeedArchLink`` + - `Seeed Arch Link `_ - NRF51822 - 16 MHz - 256 Kb - 16 Kb - * - ``seeeduinoArchPro`` - - `SeeedStudio Seeeduino-Arch-Pro `_ + * - ``seeedArchMax`` + - `Seeed Arch Max `_ + - STM32F407VET6 + - 168 MHz + - 512 Kb + - 192 Kb + + * - ``seeedArchPro`` + - `Seeed Arch Pro `_ - LPC1768 - 96 MHz - 512 Kb - 64 Kb + * - ``seeedTinyBLE`` + - `Seeed Tiny BLE `_ + - NRF51822 + - 16 MHz + - 256 Kb + - 16 Kb + + * - ``xadow_m0`` + - `Seeed Xadow M0 `_ + - LPC11U35 + - 48 MHz + - 64 Kb + - 10 Kb + Silicon Labs ~~~~~~~~~~~~ @@ -773,6 +1035,26 @@ Silicon Labs - 32 Kb - 4 Kb +Smeshlink +~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``xbed_lpc1768`` + - `Smeshlink xbed LPC1768 `_ + - LPC1768 + - 96 MHz + - 512 Kb + - 32 Kb + Solder Splash Labs ~~~~~~~~~~~~~~~~~~ @@ -793,6 +1075,26 @@ Solder Splash Labs - 32 Kb - 8 Kb +SolderSplash Labs +~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``lpc1347`` + - `DipCortex M3 `_ + - LPC1347 + - 72 MHz + - 64 Kb + - 12 Kb + Switch Science ~~~~~~~~~~~~~~ @@ -820,6 +1122,20 @@ Switch Science - 32 Kb - 4 Kb + * - ``ssci824`` + - `Switch Science mbed LPC824 `_ + - LPC824 + - 30 MHz + - 32 Kb + - 8 Kb + + * - ``ty51822r3`` + - `Switch Science mbed TY51822r3 `_ + - NRF51822 + - 32 MHz + - 256 Kb + - 32 Kb + Teensy ~~~~~~ @@ -860,4 +1176,24 @@ u-blox - 512 Kb - 64 Kb +y5 design +~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``nrf51822_y5_mbug`` + - `y5 nRF51822 mbug `_ + - NRF51822 + - 16 MHz + - 256 Kb + - 16 Kb + .. include:: mbed_extra.rst diff --git a/docs/ide/_platformio_ide_extra.rst b/docs/ide/_platformio_ide_extra.rst index cf446adf..3b30d1d4 100644 --- a/docs/ide/_platformio_ide_extra.rst +++ b/docs/ide/_platformio_ide_extra.rst @@ -15,8 +15,8 @@ * Cross-platform build system without external dependencies to the OS software: - - 250+ embedded boards - - 20+ development platforms + - 300+ embedded boards + - 15+ development platforms - 10+ frameworks * C/C++ Intelligent code completion diff --git a/docs/ide/atom.rst b/docs/ide/atom.rst index dc907b24..e5d0de98 100644 --- a/docs/ide/atom.rst +++ b/docs/ide/atom.rst @@ -18,8 +18,8 @@ PlatformIO IDE is the next-generation integrated development environment for IoT * Cross-platform build system without external dependencies to the OS software: - - 250+ embedded boards - - 20+ development platforms + - 300+ embedded boards + - 15+ development platforms - 10+ frameworks * C/C++ Intelligent Code Completion diff --git a/docs/installation.rst b/docs/installation.rst index 81af129a..22717b4b 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -167,6 +167,8 @@ For upgrading ``platformio`` to the latest version: pip install -U platformio +.. _installation_develop: + Development Version ~~~~~~~~~~~~~~~~~~~ diff --git a/docs/librarymanager/config.rst b/docs/librarymanager/config.rst index 67a5e6bb..a3a2edc1 100644 --- a/docs/librarymanager/config.rst +++ b/docs/librarymanager/config.rst @@ -196,7 +196,7 @@ dash. `Semantic Versioning `_ IS RECOMMENDED. field is defined. |PIOAPICR| will use the - `CVS `_ revision from + `VCS `_ revision from the latest commit as "current version". For example, ``13`` (*SVN*) or first 10 chars of *SHA* digest ``e4564b7da4`` (*Git*). If :ref:`libjson_repository` ``branch`` is not specified, then default branch will be used. diff --git a/docs/librarymanager/creating.rst b/docs/librarymanager/creating.rst index 8bdbf5b9..16051a8d 100644 --- a/docs/librarymanager/creating.rst +++ b/docs/librarymanager/creating.rst @@ -44,34 +44,63 @@ If a library source code is located at `GitHub `_, then you **need to specify** only these fields in the :ref:`library_config`: * :ref:`libjson_name` +* :ref:`libjson_version` (is not required, but highly recommended for new :ref:`librarymanager`) * :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*. +|PIOAPICR| will populate the rest fields, like :ref:`libjson_authors` with an +actual information from *GitHub*. -Example: +Example, `DallasTemperature `_: .. code-block:: javascript { - "name": "IRremote", - "keywords": "infrared, ir, remote", - "description": "Send and receive infrared signals with multiple protocols", - "repository": + "name": "DallasTemperature", + "keywords": "onewire, 1-wire, bus, sensor, temperature", + "description": "Arduino Library for Dallas Temperature ICs (DS18B20, DS18S20, DS1822, DS1820)", + "repository": + { + "type": "git", + "url": "https://github.com/milesburton/Arduino-Temperature-Control-Library.git" + }, + "authors": + [ { - "type": "git", - "url": "https://github.com/shirriff/Arduino-IRremote.git" + "name": "Miles Burton", + "email": "miles@mnetcs.com", + "url": "http://www.milesburton.com", + "maintainer": true }, - "frameworks": "arduino", - "platforms": "atmelavr" + { + "name": "Tim Newsome", + "email": "nuisance@casualhacker.net" + }, + { + "name": "Guil Barros", + "email": "gfbarros@bappos.com" + }, + { + "name": "Rob Tillaart", + "email": "rob.tillaart@gmail.com" + } + ], + "dependencies": + { + "name": "OneWire", + "authors": "Paul Stoffregen", + "frameworks": "arduino" + }, + "version": "3.7.7", + "frameworks": "arduino", + "platforms": "*" } -Under CVS (SVN/GIT) +Under VCS (SVN/GIT) ^^^^^^^^^^^^^^^^^^^ -|PIOAPICR| can operate with a library source code that is under *CVS* control. +|PIOAPICR| can operate with a library source code that is under *VCS* control. The list of **required** fields in the :ref:`library_config` will look like: * :ref:`libjson_name` diff --git a/docs/librarymanager/index.rst b/docs/librarymanager/index.rst index 52d8ec87..df03b8b4 100644 --- a/docs/librarymanager/index.rst +++ b/docs/librarymanager/index.rst @@ -20,14 +20,16 @@ Hg, SVN). It makes it exceedingly simple to find, install and keep libraries up-to-date. PlatformIO Library Manager supports `Semantic Versioning `_ and its rules. -There 2 options how to find library: +There are 2 options how to find library: +* `Web Library Search `__ * :ref:`Command Line Interface ` -* `Web-based Library Search `__ -*PlatformIO Library Manager* allows to manage different library storages using +You can manage different library storages using :option:`platformio lib --global` or :option:`platformio lib --storage-dir` -options. +options. If you change current working directory in terminal to project folder, +then :ref:`platformio lib ` command will manage automatically dependency +storage in :ref:`projectconf_pio_libdeps_dir`. Project dependencies -------------------- diff --git a/docs/librarymanager/ldf.rst b/docs/librarymanager/ldf.rst index ed56dc39..5399009f 100644 --- a/docs/librarymanager/ldf.rst +++ b/docs/librarymanager/ldf.rst @@ -32,7 +32,6 @@ Library Dependency Finder has controls that can be set up in :ref:`projectconf`: * :ref:`projectconf_lib_deps` * :ref:`projectconf_lib_extra_dirs` - * :ref:`projectconf_lib_force` * :ref:`projectconf_lib_ignore` * :ref:`projectconf_lib_compat_mode` * :ref:`projectconf_lib_ldf_mode` diff --git a/docs/platforms/atmelavr.rst b/docs/platforms/atmelavr.rst index 88d545f0..798dfd6f 100644 --- a/docs/platforms/atmelavr.rst +++ b/docs/platforms/atmelavr.rst @@ -40,9 +40,6 @@ Packages * - ``tool-micronucleus`` - `Micronucleus `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-atmelavr`` - `avr-gcc `_, `GDB `_, `AVaRICE `_, `SimulAVR `_ diff --git a/docs/platforms/atmelsam.rst b/docs/platforms/atmelsam.rst index a73ab057..e4bf5842 100644 --- a/docs/platforms/atmelsam.rst +++ b/docs/platforms/atmelsam.rst @@ -46,9 +46,6 @@ Packages * - ``tool-openocd`` - `OpenOCD `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-gccarmnoneeabi`` - `gcc-arm-embedded `_, `GDB `_ diff --git a/docs/platforms/creating_platform.rst b/docs/platforms/creating_platform.rst index 44fe48f0..5118fcd1 100644 --- a/docs/platforms/creating_platform.rst +++ b/docs/platforms/creating_platform.rst @@ -74,6 +74,9 @@ Packages * - ``framework-arduinosam`` - `Arduino Wiring-based Framework (SAM Core, 1.6) `_ + * - ``framework-arduinoststm32`` + - `Arduino Wiring-based Framework (STM32 Core) `_ + * - ``framework-arduinoteensy`` - `Arduino Wiring-based Framework `_ diff --git a/docs/platforms/embedded_boards.rst b/docs/platforms/embedded_boards.rst index 8353ed67..15ca4a6b 100644 --- a/docs/platforms/embedded_boards.rst +++ b/docs/platforms/embedded_boards.rst @@ -890,6 +890,26 @@ ESPino - 4096 Kb - 80 Kb +Elektor Labs +~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``elektor_cocorico`` + - `CoCo-ri-Co! `_ + - LPC812 + - 30 MHz + - 16 Kb + - 4 Kb + Embedded Artists ~~~~~~~~~~~~~~~~ @@ -904,7 +924,7 @@ Embedded Artists - RAM * - ``lpc11u35`` - - `Embedded Artists LPC11U35 QuickStart Board `_ + - `EA LPC11U35 QuickStart Board `_ - LPC11U35 - 48 MHz - 64 Kb @@ -1011,7 +1031,7 @@ Espressif - ESP8266 - 80 MHz - 4096 Kb - - 50 Kb + - 80 Kb * - ``phoenix_v1`` - `Phoenix 1.0 `_ @@ -1089,6 +1109,27 @@ Freescale - 128 Kb - 16 Kb + * - ``frdm_kl26z`` + - `Freescale Kinetis FRDM-KL26Z `_ + - MKL26Z128VLH4 + - 48 MHz + - 128 Kb + - 16 Kb + + * - ``frdm_kl27z`` + - `Freescale Kinetis FRDM-KL27Z `_ + - MKL27Z64VLH4 + - 48 MHz + - 64 Kb + - 16 Kb + + * - ``frdm_kl43z`` + - `Freescale Kinetis FRDM-KL43Z `_ + - MKL43Z256VLH4 + - 48 MHz + - 256 Kb + - 32 Kb + * - ``frdm_kl46z`` - `Freescale Kinetis FRDM-KL46Z `_ - MKL46Z256VLL4 @@ -1123,6 +1164,26 @@ Fubarino - 512 Kb - 128 Kb +GHI Electronics +~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``oc_mbuino`` + - `mBuino `_ + - LPC11U24 + - 50 MHz + - 32 Kb + - 10 Kb + Generic ~~~~~~~ @@ -1143,6 +1204,48 @@ Generic - 64 Kb - 20 Kb + * - ``genericSTM32F103C8`` + - `STM32F103C8 (20k RAM. 64k Flash) `_ + - STM32F103C8 + - 72 MHz + - 64 Kb + - 20 Kb + + * - ``genericSTM32F103CB`` + - `STM32F103CB (20k RAM. 128k Flash) `_ + - STM32F103CB + - 72 MHz + - 128 Kb + - 20 Kb + + * - ``genericSTM32F103R8`` + - `STM32F103R8 (20k RAM. 64 Flash) `_ + - STM32F103R8 + - 72 MHz + - 64 Kb + - 20 Kb + + * - ``genericSTM32F103RB`` + - `STM32F103RB (20k RAM. 128k Flash) `_ + - STM32F103RB + - 72 MHz + - 128 Kb + - 20 Kb + + * - ``genericSTM32F103RC`` + - `STM32F103RC (48k RAM. 256k Flash) `_ + - STM32F103RC + - 72 MHz + - 256 Kb + - 48 Kb + + * - ``genericSTM32F103RE`` + - `STM32F103RE (64k RAM. 512k Flash) `_ + - STM32F103RE + - 72 MHz + - 512 Kb + - 64 Kb + Generic ATTiny ~~~~~~~~~~~~~~ @@ -1238,7 +1341,7 @@ JKSoft - Flash - RAM - * - ``wallBotBLE`` + * - ``wallbot_ble`` - `JKSoft Wallbot BLE `_ - NRF51822 - 16 MHz @@ -1470,6 +1573,46 @@ Microduino - 64 Kb - 4 Kb +Micromint +~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``lpc4330_m4`` + - `Bambino-210E `_ + - LPC4330 + - 204 MHz + - 8192 Kb + - 264 Kb + +MikroElektronika +~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``hexiwear`` + - `Hexiwear `_ + - MK64FN1M0VDC12 + - 120 MHz + - 1024 Kb + - 256 Kb + MultiTech ~~~~~~~~~ @@ -1483,6 +1626,13 @@ MultiTech - Flash - RAM + * - ``mts_mdot_f405rg`` + - `MultiTech mDot `_ + - STM32F411RET6 + - 100 MHz + - 512 Kb + - 128 Kb + * - ``mts_mdot_f411re`` - `MultiTech mDot F411 `_ - STM32F411RET6 @@ -1523,6 +1673,13 @@ NXP - Flash - RAM + * - ``lpc11c24`` + - `NXP LPC11C24 `_ + - LPC11C24 + - 48 MHz + - 32 Kb + - 8 Kb + * - ``lpc11u24`` - `NXP mbed LPC11U24 `_ - LPC11U24 @@ -1530,6 +1687,34 @@ NXP - 32 Kb - 8 Kb + * - ``lpc11u24_301`` + - `ARM mbed LPC11U24 (+CAN) `_ + - LPC11U24 + - 48 MHz + - 32 Kb + - 8 Kb + + * - ``lpc11u34_421`` + - `NXP LPC11U34 `_ + - LPC11U34 + - 48 MHz + - 64 Kb + - 8 Kb + + * - ``lpc11u37_501`` + - `NXP LPC11U37 `_ + - LPC11U37 + - 48 MHz + - 128 Kb + - 10 Kb + + * - ``lpc11u68`` + - `LPCXpresso11U68 `_ + - LPC11U68 + - 50 MHz + - 256 Kb + - 36 Kb + * - ``lpc1549`` - `NXP LPCXpresso1549 `_ - LPC1549 @@ -1544,6 +1729,41 @@ NXP - 512 Kb - 64 Kb + * - ``lpc2368`` + - `NXP LPC2368 `_ + - LPC2368 + - 72 MHz + - 512 Kb + - 58 Kb + + * - ``lpc2460`` + - `NXP LPC2460 `_ + - LPC2460 + - 72 MHz + - 64 Kb + - 16 Kb + + * - ``lpc812`` + - `NXP LPC800-MAX `_ + - LPC812 + - 30 MHz + - 16 Kb + - 4 Kb + + * - ``lpc824`` + - `LPCXpresso824-MAX `_ + - LPC824 + - 30 MHz + - 32 Kb + - 8 Kb + + * - ``micronfcboard`` + - `MicroNFCBoard `_ + - LPC11U34 + - 48 MHz + - 64 Kb + - 10 Kb + NodeMCU ~~~~~~~ @@ -1618,6 +1838,13 @@ Olimex - Flash - RAM + * - ``maple`` + - `Olimexino STM32 `_ + - STM32F103RB_MAPLE + - 72 MHz + - 128 Kb + - 16.6015625 Kb + * - ``modwifi`` - `Olimex MOD-WIFI-ESP8266(-DEV) `_ - ESP8266 @@ -1997,6 +2224,13 @@ ST - 1024 Kb - 384 Kb + * - ``disco_f746ng`` + - `ST 32F746GDISCOVERY `_ + - STM32F746NGH6 + - 216 MHz + - 1024 Kb + - 320 Kb + * - ``disco_l053c8`` - `ST 32L0538DISCOVERY `_ - STM32L053C8T6 @@ -2067,6 +2301,13 @@ ST - 128 Kb - 20 Kb + * - ``nucleo_f207zg`` + - `ST Nucleo F207ZG `_ + - STM32F207ZGT6 + - 120 MHz + - 1024 Kb + - 128 Kb + * - ``nucleo_f302r8`` - `ST Nucleo F302R8 `_ - STM32F302R8T6 @@ -2116,6 +2357,13 @@ ST - 512 Kb - 128 Kb + * - ``nucleo_f429zi`` + - `ST Nucleo F429ZI `_ + - STM32F429ZIT6 + - 180 MHz + - 2048 Kb + - 256 Kb + * - ``nucleo_f446re`` - `ST Nucleo F446RE `_ - STM32F446RET6 @@ -2123,6 +2371,34 @@ ST - 512 Kb - 128 Kb + * - ``nucleo_f446ze`` + - `ST Nucleo F446ZE `_ + - STM32F446ZET6 + - 180 MHz + - 512 Kb + - 128 Kb + + * - ``nucleo_f746zg`` + - `ST Nucleo F746ZG `_ + - STM32F746ZGT6 + - 216 MHz + - 1024 Kb + - 320 Kb + + * - ``nucleo_f767zi`` + - `ST Nucleo F767ZI `_ + - STM32F746ZGT6 + - 216 MHz + - 2048 Kb + - 512 Kb + + * - ``nucleo_l011k4`` + - `ST Nucleo L011K4 `_ + - STM32L011K4T6 + - 32 MHz + - 16 Kb + - 2 Kb + * - ``nucleo_l031k6`` - `ST Nucleo L031K6 `_ - STM32L031K6T6 @@ -2151,6 +2427,13 @@ ST - 512 Kb - 80 Kb + * - ``nucleo_l432kc`` + - `ST Nucleo L432KC `_ + - STM32L432KCU6 + - 80 MHz + - 256 Kb + - 64 Kb + * - ``nucleo_l476rg`` - `ST Nucleo L476RG `_ - STM32L476RGT6 @@ -2260,27 +2543,55 @@ SeeedStudio - 512 Kb - 128 Kb - * - ``seeedArchMax`` - - `SeeedStudio Arch Max `_ - - STM32F407VET6 - - 168 MHz - - 512 Kb - - 192 Kb + * - ``seeedArchBLE`` + - `Seeed Arch BLE `_ + - NRF51822 + - 16 MHz + - 128 Kb + - 16 Kb - * - ``seeedTinyBLE`` - - `SeeedStudio Seeed Tiny BLE `_ + * - ``seeedArchGPRS`` + - `Seeed Arch GPRS V2 `_ + - LPC11U37 + - 48 MHz + - 128 Kb + - 10 Kb + + * - ``seeedArchLink`` + - `Seeed Arch Link `_ - NRF51822 - 16 MHz - 256 Kb - 16 Kb - * - ``seeeduinoArchPro`` - - `SeeedStudio Seeeduino-Arch-Pro `_ + * - ``seeedArchMax`` + - `Seeed Arch Max `_ + - STM32F407VET6 + - 168 MHz + - 512 Kb + - 192 Kb + + * - ``seeedArchPro`` + - `Seeed Arch Pro `_ - LPC1768 - 96 MHz - 512 Kb - 64 Kb + * - ``seeedTinyBLE`` + - `Seeed Tiny BLE `_ + - NRF51822 + - 16 MHz + - 256 Kb + - 16 Kb + + * - ``xadow_m0`` + - `Seeed Xadow M0 `_ + - LPC11U35 + - 48 MHz + - 64 Kb + - 10 Kb + Silicon Labs ~~~~~~~~~~~~ @@ -2336,6 +2647,26 @@ Silicon Labs - 32 Kb - 4 Kb +Smeshlink +~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``xbed_lpc1768`` + - `Smeshlink xbed LPC1768 `_ + - LPC1768 + - 96 MHz + - 512 Kb + - 32 Kb + Solder Splash Labs ~~~~~~~~~~~~~~~~~~ @@ -2356,6 +2687,26 @@ Solder Splash Labs - 32 Kb - 8 Kb +SolderSplash Labs +~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``lpc1347`` + - `DipCortex M3 `_ + - LPC1347 + - 72 MHz + - 64 Kb + - 12 Kb + SparkFun ~~~~~~~~ @@ -2369,6 +2720,13 @@ SparkFun - Flash - RAM + * - ``sparkfunBlynk`` + - `SparkFun Blynk Board `_ + - ESP8266 + - 80 MHz + - 4096 Kb + - 80 Kb + * - ``sparkfun_digitalsandbox`` - `SparkFun Digital Sandbox `_ - ATMEGA328P @@ -2514,6 +2872,20 @@ Switch Science - 32 Kb - 4 Kb + * - ``ssci824`` + - `Switch Science mbed LPC824 `_ + - LPC824 + - 30 MHz + - 32 Kb + - 8 Kb + + * - ``ty51822r3`` + - `Switch Science mbed TY51822r3 `_ + - NRF51822 + - 32 MHz + - 256 Kb + - 32 Kb + TI ~~ @@ -2652,6 +3024,20 @@ Teensy - 256 Kb - 64 Kb + * - ``teensy35`` + - `Teensy 3.5 `_ + - MK64FX512 + - 120 MHz + - 512 Kb + - 192 Kb + + * - ``teensy36`` + - `Teensy 3.6 `_ + - MK66FX1M0 + - 180 MHz + - 1024 Kb + - 256 Kb + * - ``teensylc`` - `Teensy LC `_ - MKL26Z64 @@ -2866,3 +3252,23 @@ ubIQio - 16 MHz - 32 Kb - 2 Kb + +y5 design +~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``nrf51822_y5_mbug`` + - `y5 nRF51822 mbug `_ + - NRF51822 + - 16 MHz + - 256 Kb + - 16 Kb diff --git a/docs/platforms/espressif8266.rst b/docs/platforms/espressif8266.rst index 8530ea18..53d6214b 100644 --- a/docs/platforms/espressif8266.rst +++ b/docs/platforms/espressif8266.rst @@ -43,9 +43,6 @@ Packages * - ``tool-mkspiffs`` - `Tool to build and unpack SPIFFS images `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-xtensa`` - `xtensa-gcc `_, `GDB `_ @@ -222,7 +219,7 @@ Espressif - ESP8266 - 80 MHz - 4096 Kb - - 50 Kb + - 80 Kb * - ``phoenix_v1`` - `Phoenix 1.0 `_ @@ -305,6 +302,13 @@ SparkFun - Flash - RAM + * - ``sparkfunBlynk`` + - `SparkFun Blynk Board `_ + - ESP8266 + - 80 MHz + - 4096 Kb + - 80 Kb + * - ``thing`` - `SparkFun ESP8266 Thing `_ - ESP8266 diff --git a/docs/platforms/espressif8266_extra.rst b/docs/platforms/espressif8266_extra.rst index 02db956f..e48d4395 100644 --- a/docs/platforms/espressif8266_extra.rst +++ b/docs/platforms/espressif8266_extra.rst @@ -220,25 +220,27 @@ Demo Using Arduino Framework with Staging version -------------------------------------------- -1. Clone/Copy `main repository `_ to - :ref:`projectconf_pio_home_dir` + ``packages/framework-arduinoespressif8266`` - and create new file ``packages/framework-arduinoespressif8266/package.json`` - with the next contents (you can specify own version if you want) +1. Install :ref:`installation_develop` of PlatformIO +2. Install Espressif 8266 (Stage) development platform - .. code-block:: json + .. code:: - { - "description":"Arduino Wiring-based Framework (ESP8266 Core)", - "name":"framework-arduinoespressif8266", - "system":"all", - "url":"https://github.com/esp8266/Arduino", - "version":"1.20300.0" - } + platformio platform install https://github.com/platformio/platform-espressif8266.git#feature/stage -2. Try to build project -3. If you see build errors, then try to build this project using the same +3. Set :ref:`projectconf_env_platform` to ``espressif8266_stage`` in + :ref:`projectconf`. For example, + + .. code-block:: ini + + [env:nodemcuv2] + platform = espressif8266_stage + board = nodemcuv2 + framework = arduino + +4. Try to build project +5. If you see build errors, then try to build this project using the same ``stage`` on Arduino IDE -4. If it works with Arduino IDE but doesn't work with PlatformIO, then please +6. If it works with Arduino IDE but doesn't work with PlatformIO, then please `open new issue `_ with attached information: @@ -251,6 +253,7 @@ Using Arduino Framework with Staging version Articles -------- +* Sep 12, 2016 - **Pedro Minatel** - `OTA – Como programar o ESP8266 pelo WiFi no platformIO (OTA programming for ESP8266 via Wi-Fi using PlatformIO, Portuguese) `_ * Sep 2, 2016 - **Tinkerman** `Optimizing files for SPIFFS with Gulp `_ * Jul 15, 2016 - **Jaime** - `ESP8266 Mobile Rick Roll Captive Portal `_ * Jun 13, 2016 - **Daniel Eichhorn** - `New Weather Station Demo on Github `_ diff --git a/docs/platforms/freescalekinetis.rst b/docs/platforms/freescalekinetis.rst index 29323287..494e8527 100644 --- a/docs/platforms/freescalekinetis.rst +++ b/docs/platforms/freescalekinetis.rst @@ -31,9 +31,6 @@ Packages * - ``framework-mbed`` - `mbed Framework `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-gccarmnoneeabi`` - `gcc-arm-embedded `_, `GDB `_ @@ -122,9 +119,50 @@ Freescale - 128 Kb - 16 Kb + * - ``frdm_kl26z`` + - `Freescale Kinetis FRDM-KL26Z `_ + - MKL26Z128VLH4 + - 48 MHz + - 128 Kb + - 16 Kb + + * - ``frdm_kl27z`` + - `Freescale Kinetis FRDM-KL27Z `_ + - MKL27Z64VLH4 + - 48 MHz + - 64 Kb + - 16 Kb + + * - ``frdm_kl43z`` + - `Freescale Kinetis FRDM-KL43Z `_ + - MKL43Z256VLH4 + - 48 MHz + - 256 Kb + - 32 Kb + * - ``frdm_kl46z`` - `Freescale Kinetis FRDM-KL46Z `_ - MKL46Z256VLL4 - 48 MHz - 256 Kb - 32 Kb + +MikroElektronika +~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``hexiwear`` + - `Hexiwear `_ + - MK64FN1M0VDC12 + - 120 MHz + - 1024 Kb + - 256 Kb diff --git a/docs/platforms/intel_arc32.rst b/docs/platforms/intel_arc32.rst index dbfe8f16..3127fd76 100644 --- a/docs/platforms/intel_arc32.rst +++ b/docs/platforms/intel_arc32.rst @@ -34,9 +34,6 @@ Packages * - ``tool-arduino101load`` - `Genuino101 uploader `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-intelarc32`` - `GCC for Intel ARC `_ diff --git a/docs/platforms/lattice_ice40.rst b/docs/platforms/lattice_ice40.rst index d4e60376..fd54c760 100644 --- a/docs/platforms/lattice_ice40.rst +++ b/docs/platforms/lattice_ice40.rst @@ -28,9 +28,6 @@ Packages * - Name - Contents - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-icestorm`` - `GCC for FPGA IceStorm `_ diff --git a/docs/platforms/linux_arm.rst b/docs/platforms/linux_arm.rst index 1e01001d..0b69a2d3 100644 --- a/docs/platforms/linux_arm.rst +++ b/docs/platforms/linux_arm.rst @@ -31,9 +31,6 @@ Packages * - ``framework-wiringpi`` - `GPIO Interface library for the Raspberry Pi `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-gccarmlinuxgnueabi`` - `GCC for Linux ARM GNU EABI `_, `GDB `_ diff --git a/docs/platforms/linux_i686.rst b/docs/platforms/linux_i686.rst index 386c8dd5..fb1f3dd7 100644 --- a/docs/platforms/linux_i686.rst +++ b/docs/platforms/linux_i686.rst @@ -28,8 +28,5 @@ Packages * - Name - Contents - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-gcclinux32`` - `GCC for Linux i686 `_ \ No newline at end of file diff --git a/docs/platforms/linux_x86_64.rst b/docs/platforms/linux_x86_64.rst index 91068819..425f0e41 100644 --- a/docs/platforms/linux_x86_64.rst +++ b/docs/platforms/linux_x86_64.rst @@ -28,8 +28,5 @@ Packages * - Name - Contents - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-gcclinux64`` - `GCC for Linux x86_64 `_ \ No newline at end of file diff --git a/docs/platforms/microchippic32.rst b/docs/platforms/microchippic32.rst index 91269d85..8d4cf12d 100644 --- a/docs/platforms/microchippic32.rst +++ b/docs/platforms/microchippic32.rst @@ -34,9 +34,6 @@ Packages * - ``tool-pic32prog`` - `pic32prog `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-microchippic32`` - `GCC for Microchip PIC32 `_ diff --git a/docs/platforms/native.rst b/docs/platforms/native.rst index a6794951..a4174222 100644 --- a/docs/platforms/native.rst +++ b/docs/platforms/native.rst @@ -17,16 +17,4 @@ Native development platform is intended to be used for desktop OS. This platform For more detailed information please visit `vendor site `_. -.. contents:: - -Packages --------- - -.. list-table:: - :header-rows: 1 - - * - Name - - Contents - - * - ``tool-scons`` - - `SCons software construction tool `_ \ No newline at end of file +.. contents:: \ No newline at end of file diff --git a/docs/platforms/nordicnrf51.rst b/docs/platforms/nordicnrf51.rst index b7f8c8d9..683bdebe 100644 --- a/docs/platforms/nordicnrf51.rst +++ b/docs/platforms/nordicnrf51.rst @@ -37,9 +37,6 @@ Packages * - ``tool-rfdloader`` - `rfdloader `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``tool-sreccat`` - `Merging tool `_ @@ -132,7 +129,7 @@ JKSoft - Flash - RAM - * - ``wallBotBLE`` + * - ``wallbot_ble`` - `JKSoft Wallbot BLE `_ - NRF51822 - 16 MHz @@ -233,8 +230,22 @@ SeeedStudio - Flash - RAM + * - ``seeedArchBLE`` + - `Seeed Arch BLE `_ + - NRF51822 + - 16 MHz + - 128 Kb + - 16 Kb + + * - ``seeedArchLink`` + - `Seeed Arch Link `_ + - NRF51822 + - 16 MHz + - 256 Kb + - 16 Kb + * - ``seeedTinyBLE`` - - `SeeedStudio Seeed Tiny BLE `_ + - `Seeed Tiny BLE `_ - NRF51822 - 16 MHz - 256 Kb @@ -260,4 +271,31 @@ Switch Science - 256 Kb - 16 Kb + * - ``ty51822r3`` + - `Switch Science mbed TY51822r3 `_ + - NRF51822 + - 32 MHz + - 256 Kb + - 32 Kb + +y5 design +~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``nrf51822_y5_mbug`` + - `y5 nRF51822 mbug `_ + - NRF51822 + - 16 MHz + - 256 Kb + - 16 Kb + .. include:: nordicnrf51_extra.rst diff --git a/docs/platforms/nxplpc.rst b/docs/platforms/nxplpc.rst index 3b76506c..e9a4764e 100644 --- a/docs/platforms/nxplpc.rst +++ b/docs/platforms/nxplpc.rst @@ -31,9 +31,6 @@ Packages * - ``framework-mbed`` - `mbed Framework `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-gccarmnoneeabi`` - `gcc-arm-embedded `_, `GDB `_ @@ -87,6 +84,26 @@ CQ Publishing - 64 Kb - 10 Kb +Elektor Labs +~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``elektor_cocorico`` + - `CoCo-ri-Co! `_ + - LPC812 + - 30 MHz + - 16 Kb + - 4 Kb + Embedded Artists ~~~~~~~~~~~~~~~~ @@ -101,7 +118,7 @@ Embedded Artists - RAM * - ``lpc11u35`` - - `Embedded Artists LPC11U35 QuickStart Board `_ + - `EA LPC11U35 QuickStart Board `_ - LPC11U35 - 48 MHz - 64 Kb @@ -121,6 +138,46 @@ Embedded Artists - 512 Kb - 96 Kb +GHI Electronics +~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``oc_mbuino`` + - `mBuino `_ + - LPC11U24 + - 50 MHz + - 32 Kb + - 10 Kb + +Micromint +~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``lpc4330_m4`` + - `Bambino-210E `_ + - LPC4330 + - 204 MHz + - 8192 Kb + - 264 Kb + NGX Technologies ~~~~~~~~~~~~~~~~ @@ -154,6 +211,13 @@ NXP - Flash - RAM + * - ``lpc11c24`` + - `NXP LPC11C24 `_ + - LPC11C24 + - 48 MHz + - 32 Kb + - 8 Kb + * - ``lpc11u24`` - `NXP mbed LPC11U24 `_ - LPC11U24 @@ -161,6 +225,34 @@ NXP - 32 Kb - 8 Kb + * - ``lpc11u24_301`` + - `ARM mbed LPC11U24 (+CAN) `_ + - LPC11U24 + - 48 MHz + - 32 Kb + - 8 Kb + + * - ``lpc11u34_421`` + - `NXP LPC11U34 `_ + - LPC11U34 + - 48 MHz + - 64 Kb + - 8 Kb + + * - ``lpc11u37_501`` + - `NXP LPC11U37 `_ + - LPC11U37 + - 48 MHz + - 128 Kb + - 10 Kb + + * - ``lpc11u68`` + - `LPCXpresso11U68 `_ + - LPC11U68 + - 50 MHz + - 256 Kb + - 36 Kb + * - ``lpc1549`` - `NXP LPCXpresso1549 `_ - LPC1549 @@ -175,6 +267,41 @@ NXP - 512 Kb - 64 Kb + * - ``lpc2368`` + - `NXP LPC2368 `_ + - LPC2368 + - 72 MHz + - 512 Kb + - 58 Kb + + * - ``lpc2460`` + - `NXP LPC2460 `_ + - LPC2460 + - 72 MHz + - 64 Kb + - 16 Kb + + * - ``lpc812`` + - `NXP LPC800-MAX `_ + - LPC812 + - 30 MHz + - 16 Kb + - 4 Kb + + * - ``lpc824`` + - `LPCXpresso824-MAX `_ + - LPC824 + - 30 MHz + - 32 Kb + - 8 Kb + + * - ``micronfcboard`` + - `MicroNFCBoard `_ + - LPC11U34 + - 48 MHz + - 64 Kb + - 10 Kb + Outrageous Circuits ~~~~~~~~~~~~~~~~~~~ @@ -208,13 +335,47 @@ SeeedStudio - Flash - RAM - * - ``seeeduinoArchPro`` - - `SeeedStudio Seeeduino-Arch-Pro `_ + * - ``seeedArchGPRS`` + - `Seeed Arch GPRS V2 `_ + - LPC11U37 + - 48 MHz + - 128 Kb + - 10 Kb + + * - ``seeedArchPro`` + - `Seeed Arch Pro `_ - LPC1768 - 96 MHz - 512 Kb - 64 Kb + * - ``xadow_m0`` + - `Seeed Xadow M0 `_ + - LPC11U35 + - 48 MHz + - 64 Kb + - 10 Kb + +Smeshlink +~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``xbed_lpc1768`` + - `Smeshlink xbed LPC1768 `_ + - LPC1768 + - 96 MHz + - 512 Kb + - 32 Kb + Solder Splash Labs ~~~~~~~~~~~~~~~~~~ @@ -235,6 +396,26 @@ Solder Splash Labs - 32 Kb - 8 Kb +SolderSplash Labs +~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``lpc1347`` + - `DipCortex M3 `_ + - LPC1347 + - 72 MHz + - 64 Kb + - 12 Kb + Switch Science ~~~~~~~~~~~~~~ @@ -255,6 +436,13 @@ Switch Science - 32 Kb - 4 Kb + * - ``ssci824`` + - `Switch Science mbed LPC824 `_ + - LPC824 + - 30 MHz + - 32 Kb + - 8 Kb + u-blox ~~~~~~ diff --git a/docs/platforms/siliconlabsefm32.rst b/docs/platforms/siliconlabsefm32.rst index ac92c554..c1ccc8a5 100644 --- a/docs/platforms/siliconlabsefm32.rst +++ b/docs/platforms/siliconlabsefm32.rst @@ -31,9 +31,6 @@ Packages * - ``framework-mbed`` - `mbed Framework `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-gccarmnoneeabi`` - `gcc-arm-embedded `_, `GDB `_ diff --git a/docs/platforms/ststm32.rst b/docs/platforms/ststm32.rst index d66e1f71..3c21951e 100644 --- a/docs/platforms/ststm32.rst +++ b/docs/platforms/ststm32.rst @@ -28,6 +28,9 @@ Packages * - Name - Contents + * - ``framework-arduinoststm32`` + - `Arduino Wiring-based Framework (STM32 Core) `_ + * - ``framework-cmsis`` - `Vendor-independent hardware abstraction layer for the Cortex-M processor series `_ @@ -40,9 +43,6 @@ Packages * - ``framework-spl`` - `Standard Peripheral Library for STM32 MCUs `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``tool-stlink`` - `ST-Link `_ @@ -67,6 +67,9 @@ Frameworks * - Name - Description + * - :ref:`framework_arduino` + - Arduino Wiring-based 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_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. @@ -162,6 +165,48 @@ Generic - 64 Kb - 20 Kb + * - ``genericSTM32F103C8`` + - `STM32F103C8 (20k RAM. 64k Flash) `_ + - STM32F103C8 + - 72 MHz + - 64 Kb + - 20 Kb + + * - ``genericSTM32F103CB`` + - `STM32F103CB (20k RAM. 128k Flash) `_ + - STM32F103CB + - 72 MHz + - 128 Kb + - 20 Kb + + * - ``genericSTM32F103R8`` + - `STM32F103R8 (20k RAM. 64 Flash) `_ + - STM32F103R8 + - 72 MHz + - 64 Kb + - 20 Kb + + * - ``genericSTM32F103RB`` + - `STM32F103RB (20k RAM. 128k Flash) `_ + - STM32F103RB + - 72 MHz + - 128 Kb + - 20 Kb + + * - ``genericSTM32F103RC`` + - `STM32F103RC (48k RAM. 256k Flash) `_ + - STM32F103RC + - 72 MHz + - 256 Kb + - 48 Kb + + * - ``genericSTM32F103RE`` + - `STM32F103RE (64k RAM. 512k Flash) `_ + - STM32F103RE + - 72 MHz + - 512 Kb + - 64 Kb + MultiTech ~~~~~~~~~ @@ -175,6 +220,13 @@ MultiTech - Flash - RAM + * - ``mts_mdot_f405rg`` + - `MultiTech mDot `_ + - STM32F411RET6 + - 100 MHz + - 512 Kb + - 128 Kb + * - ``mts_mdot_f411re`` - `MultiTech mDot F411 `_ - STM32F411RET6 @@ -182,6 +234,26 @@ MultiTech - 512 Kb - 128 Kb +Olimex +~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Type ``board`` + - Name + - Microcontroller + - Frequency + - Flash + - RAM + + * - ``maple`` + - `Olimexino STM32 `_ + - STM32F103RB_MAPLE + - 72 MHz + - 128 Kb + - 16.6015625 Kb + ST ~~ @@ -251,6 +323,13 @@ ST - 1024 Kb - 384 Kb + * - ``disco_f746ng`` + - `ST 32F746GDISCOVERY `_ + - STM32F746NGH6 + - 216 MHz + - 1024 Kb + - 320 Kb + * - ``disco_l053c8`` - `ST 32L0538DISCOVERY `_ - STM32L053C8T6 @@ -321,6 +400,13 @@ ST - 128 Kb - 20 Kb + * - ``nucleo_f207zg`` + - `ST Nucleo F207ZG `_ + - STM32F207ZGT6 + - 120 MHz + - 1024 Kb + - 128 Kb + * - ``nucleo_f302r8`` - `ST Nucleo F302R8 `_ - STM32F302R8T6 @@ -370,6 +456,13 @@ ST - 512 Kb - 128 Kb + * - ``nucleo_f429zi`` + - `ST Nucleo F429ZI `_ + - STM32F429ZIT6 + - 180 MHz + - 2048 Kb + - 256 Kb + * - ``nucleo_f446re`` - `ST Nucleo F446RE `_ - STM32F446RET6 @@ -377,6 +470,34 @@ ST - 512 Kb - 128 Kb + * - ``nucleo_f446ze`` + - `ST Nucleo F446ZE `_ + - STM32F446ZET6 + - 180 MHz + - 512 Kb + - 128 Kb + + * - ``nucleo_f746zg`` + - `ST Nucleo F746ZG `_ + - STM32F746ZGT6 + - 216 MHz + - 1024 Kb + - 320 Kb + + * - ``nucleo_f767zi`` + - `ST Nucleo F767ZI `_ + - STM32F746ZGT6 + - 216 MHz + - 2048 Kb + - 512 Kb + + * - ``nucleo_l011k4`` + - `ST Nucleo L011K4 `_ + - STM32L011K4T6 + - 32 MHz + - 16 Kb + - 2 Kb + * - ``nucleo_l031k6`` - `ST Nucleo L031K6 `_ - STM32L031K6T6 @@ -405,6 +526,13 @@ ST - 512 Kb - 80 Kb + * - ``nucleo_l432kc`` + - `ST Nucleo L432KC `_ + - STM32L432KCU6 + - 80 MHz + - 256 Kb + - 64 Kb + * - ``nucleo_l476rg`` - `ST Nucleo L476RG `_ - STM32L476RGT6 @@ -426,7 +554,7 @@ SeeedStudio - RAM * - ``seeedArchMax`` - - `SeeedStudio Arch Max `_ + - `Seeed Arch Max `_ - STM32F407VET6 - 168 MHz - 512 Kb diff --git a/docs/platforms/teensy.rst b/docs/platforms/teensy.rst index ef95fc5b..03bc41c9 100644 --- a/docs/platforms/teensy.rst +++ b/docs/platforms/teensy.rst @@ -34,9 +34,6 @@ Packages * - ``framework-mbed`` - `mbed Framework `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``tool-teensy`` - `Teensy Loader `_ @@ -123,6 +120,20 @@ Teensy - 256 Kb - 64 Kb + * - ``teensy35`` + - `Teensy 3.5 `_ + - MK64FX512 + - 120 MHz + - 512 Kb + - 192 Kb + + * - ``teensy36`` + - `Teensy 3.6 `_ + - MK66FX1M0 + - 180 MHz + - 1024 Kb + - 256 Kb + * - ``teensylc`` - `Teensy LC `_ - MKL26Z64 diff --git a/docs/platforms/timsp430.rst b/docs/platforms/timsp430.rst index 2218f8c8..91ab1e8b 100644 --- a/docs/platforms/timsp430.rst +++ b/docs/platforms/timsp430.rst @@ -37,9 +37,6 @@ Packages * - ``tool-mspdebug`` - `MSPDebug `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-timsp430`` - `msp-gcc `_, `GDB `_ diff --git a/docs/platforms/titiva.rst b/docs/platforms/titiva.rst index 2dae6a51..ff67ab16 100644 --- a/docs/platforms/titiva.rst +++ b/docs/platforms/titiva.rst @@ -37,9 +37,6 @@ Packages * - ``tool-lm4flash`` - `Flash Programmer `_ - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-gccarmnoneeabi`` - `gcc-arm-embedded `_, `GDB `_ diff --git a/docs/platforms/windows_x86.rst b/docs/platforms/windows_x86.rst index a35f48d6..690c955b 100644 --- a/docs/platforms/windows_x86.rst +++ b/docs/platforms/windows_x86.rst @@ -28,8 +28,5 @@ Packages * - Name - Contents - * - ``tool-scons`` - - `SCons software construction tool `_ - * - ``toolchain-gccmingw32`` - `MinGW `_ \ No newline at end of file diff --git a/docs/projectconf.rst b/docs/projectconf.rst index 832c2571..13b49702 100644 --- a/docs/projectconf.rst +++ b/docs/projectconf.rst @@ -21,13 +21,73 @@ The Project configuration file is named ``platformio.ini``. This is a key / value pairs within the sections. Lines beginning with ``;`` are ignored and may be used to provide comments. -The sections and their allowable values are described below. +There are 2 system reserved sections: + +* Base PlatformIO settings: :ref:`projectconf_section_platformio` +* Build Environment settings: :ref:`projectconf_section_env` + +The other sections can be used by users, for example, for +:ref:`projectconf_dynamic_vars`. The sections and their allowable values are +described below. .. contents:: + :depth: 2 + +.. _projectconf_dynamic_vars: + +Dynamic variables +----------------- + +.. versionadded:: 3.1 + +Dynamic variables/templates are useful when you have common configuration data +between build environments. For examples, common :ref:`projectconf_build_flags` +or project dependencies :ref:`projectconf_lib_deps`. + +Each variable should have a next format: ``${
.