Initial version of docs

2014-08-09 16:31:20 +03:00
parent f006561113
commit 9a99409ae1
21 changed files with 1597 additions and 28 deletions
@@ -0,0 +1,320 @@
+.. _platform_atmelavr:
+
+Platform ``atmelavr``
+=====================
+
+`Atmel AVR® 8- and 32-bit MCUs <http://www.atmel.com/products/microcontrollers/avr/default.aspx>`_
+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 industry's most code-efficient architecture for
+C and assembly programming.
+
+.. contents::
+
+Packages
+--------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Alias
+      - Contents
+    * - ``toolchain-atmelavr``
+      - toolchain
+      - `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``
+      - uploader
+      - `AVRDUDE <http://www.nongnu.org/avrdude/>`_
+    * - ``framework-arduinoavr``
+      -
+      - See below in :ref:`atmelavr_frameworks`
+
+
+.. note::
+    You can install ``atmelavr`` platform with these packages
+    via :ref:`cmd_install` command.
+
+
+.. _atmelavr_frameworks:
+
+Frameworks
+----------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``framework``
+      - Name
+      - Reference
+    * - ``arduino``
+      - Arduino Wiring-based Framework (AVR Core, 1.5.x branch)
+      - `Documentation <http://arduino.cc/en/Reference/HomePage>`_
+
+
+Boards
+------
+
+.. note::
+   For more detailed ``board`` information please scroll tables below by
+   horizontal.
+
+Arduino
+~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller ``board_mcu``
+      - Frequency ``board_f_cpu``
+      - Flash
+      - RAM
+    * - ``diecimilaatmega168``
+      - `Arduino Diecimila or Duemilanove (ATmega168)
+        <http://arduino.cc/en/Main/ArduinoBoardDiecimila>`_
+      - ATmega168 ``atmega168``
+      - 16 MHz ``16000000L``
+      - 16 Kb
+      - 1 Kb
+    * - ``diecimilaatmega328``
+      - `Arduino Diecimila or Duemilanove (ATmega328)
+        <http://arduino.cc/en/Main/ArduinoBoardDiecimila>`_
+      - ATmega328 ``atmega328``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2 Kb
+    * - ``fio``
+      - `Arduino Fio
+        <http://arduino.cc/en/Main/ArduinoBoardFio>`_
+      - ATmega328P ``atmega328p``
+      - 8 MHz ``8000000L``
+      - 32 Kb
+      - 2 Kb
+    * - ``leonardo``
+      - `Arduino Leonardo <http://arduino.cc/en/Main/arduinoBoardLeonardo>`_
+      - ATmega32u4 ``atmega32u4``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2.5 Kb
+    * - ``LilyPadUSB``
+      - `Arduino LilyPad USB
+        <http://arduino.cc/en/Main/ArduinoBoardLilyPadUSB>`_
+      - ATmega32u4 ``atmega32u4``
+      - 8 MHz ``8000000L``
+      - 32 Kb
+      - 2.5 Kb
+    * - ``lilypadatmega168``
+      - `Arduino LilyPad (ATmega168)
+        <http://arduino.cc/en/Main/ArduinoBoardLilyPad>`_
+      - ATmega168 ``atmega168``
+      - 8 MHz ``8000000L``
+      - 16 Kb
+      - 1 Kb
+    * - ``lilypadatmega328``
+      - `Arduino LilyPad (ATmega328)
+        <http://arduino.cc/en/Main/ArduinoBoardLilyPad>`_
+      - ATmega328P ``atmega328p``
+      - 8 MHz ``8000000L``
+      - 32 Kb
+      - 2 Kb
+    * - ``megaatmega1280``
+      - `Arduino Mega (ATmega1280)
+        <http://arduino.cc/en/Main/arduinoBoardMega>`_
+      - ATmega1280 ``atmega1280``
+      - 16 MHz ``16000000L``
+      - 128 Kb
+      - 8 Kb
+    * - ``megaatmega2560``
+      - `Arduino Mega (ATmega2560)
+        <http://arduino.cc/en/Main/arduinoBoardMega2560>`_
+      - ATmega2560 ``atmega2560``
+      - 16 MHz ``16000000L``
+      - 256 Kb
+      - 8 Kb
+    * - ``megaADK``
+      - `Arduino Mega ADK
+        <http://arduino.cc/en/Main/ArduinoBoardMegaADK>`_
+      - ATmega2560 ``atmega2560``
+      - 16 MHz ``16000000L``
+      - 256 Kb
+      - 8 Kb
+    * - ``micro``
+      - `Arduino Micro
+        <http://arduino.cc/en/Main/ArduinoBoardMicro>`_
+      - ATmega32u4 ``atmega32u4``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2.5 Kb
+    * - ``miniatmega168``
+      - `Arduino Mini (ATmega168)
+        <http://arduino.cc/en/Main/ArduinoBoardMini>`_
+      - ATmega168 ``atmega168``
+      - 16 MHz ``16000000L``
+      - 16 Kb
+      - 1 Kb
+    * - ``miniatmega328``
+      - `Arduino Mini (ATmega328P)
+        <http://arduino.cc/en/Main/ArduinoBoardMini>`_
+      - ATmega328P ``atmega328p``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2 Kb
+    * - ``nanoatmega168``
+      - `Arduino Nano (ATmega168)
+        <http://arduino.cc/en/Main/ArduinoBoardNano>`_
+      - ATmega168 ``atmega168``
+      - 16 MHz ``16000000L``
+      - 16 Kb
+      - 1 Kb
+    * - ``nanoatmega328``
+      - `Arduino Nano (ATmega328P)
+        <http://arduino.cc/en/Main/ArduinoBoardNano>`_
+      - ATmega328P ``atmega328p``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2 Kb
+    * - ``pro8MHzatmega168``
+      - `Arduino Pro or Pro Mini (ATmega168, 3.3V)
+        <http://arduino.cc/en/Main/ArduinoBoardProMini>`_
+      - ATmega168 ``atmega168``
+      - 8 MHz ``8000000L``
+      - 16 Kb
+      - 1 Kb
+    * - ``pro16MHzatmega168``
+      - `Arduino Pro or Pro Mini (ATmega168, 5V)
+        <http://arduino.cc/en/Main/ArduinoBoardProMini>`_
+      - ATmega168 ``atmega168``
+      - 16 MHz ``16000000L``
+      - 16 Kb
+      - 1 Kb
+    * - ``pro8MHzatmega328``
+      - `Arduino Pro or Pro Mini (ATmega328P, 3.3V)
+        <http://arduino.cc/en/Main/ArduinoBoardProMini>`_
+      - ATmega328P ``atmega328p``
+      - 8 MHz ``8000000L``
+      - 32 Kb
+      - 2 Kb
+    * - ``pro16MHzatmega328``
+      - `Arduino Pro or Pro Mini (ATmega328P, 5V)
+        <http://arduino.cc/en/Main/ArduinoBoardProMini>`_
+      - ATmega328P ``atmega328p``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2 Kb
+    * - ``uno``
+      - `Arduino Uno
+        <http://arduino.cc/en/Main/ArduinoBoardUno>`_
+      - ATmega328P ``atmega328p``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2 Kb
+
+More detailed information you can find here
+`Arduino boards <http://arduino.cc/en/Main/Products>`_.
+
+
+Microduino
+~~~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller ``board_mcu``
+      - Frequency ``board_f_cpu``
+      - Flash
+      - RAM
+    * - ``168pa8m``
+      - `Microduino Core (ATmega168P, 3.3V)
+        <http://www.microduino.cc/wiki/index.php?title=Microduino-Core>`_
+      - ATmega168P ``atmega168p``
+      - 8 MHz ``8000000L``
+      - 16 Kb
+      - 1 Kb
+    * - ``168pa16m``
+      - `Microduino Core (ATmega168P, 5V)
+        <http://www.microduino.cc/wiki/index.php?title=Microduino-Core>`_
+      - ATmega168P ``atmega168p``
+      - 16 MHz ``16000000L``
+      - 16 Kb
+      - 1 Kb
+    * - ``328p8m``
+      - `Microduino Core (ATmega328P, 3.3V)
+        <http://www.microduino.cc/wiki/index.php?title=Microduino-Core>`_
+      - ATmega328P ``atmega328p``
+      - 8 MHz ``8000000L``
+      - 32 Kb
+      - 2 Kb
+    * - ``328p16m``
+      - `Microduino Core (ATmega328P, 5V)
+        <http://www.microduino.cc/wiki/index.php?title=Microduino-Core>`_
+      - ATmega328P ``atmega328p``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2 Kb
+    * - ``644pa8m``
+      - `Microduino Core+ (ATmega644PA, 3.3V)
+        <http://www.microduino.cc/wiki/index.php?title=Microduino-Core%2B>`_
+      - ATmega644PA ``atmega644p``
+      - 8 MHz ``8000000L``
+      - 64 Kb
+      - 4 Kb
+    * - ``644pa16m``
+      - `Microduino Core+ (ATmega644PA, 5V)
+        <http://www.microduino.cc/wiki/index.php?title=Microduino-Core%2B>`_
+      - ATmega644PA ``atmega644p``
+      - 16 MHz ``16000000L``
+      - 64 Kb
+      - 4 Kb
+    * - ``1284p8m``
+      - `Microduino Core+ (Atmega1284P, 3.3V)
+        <http://www.microduino.cc/wiki/index.php?title=Microduino-Core%2B>`_
+      - Atmega1284P ``atmega1284p``
+      - 8 MHz ``8000000L``
+      - 128 Kb
+      - 16 Kb
+    * - ``1284p16m``
+      - `Microduino Core+ (Atmega1284P, 5V)
+        <http://www.microduino.cc/wiki/index.php?title=Microduino-Core%2B>`_
+      - Atmega1284P ``atmega1284p``
+      - 16 MHz ``16000000L``
+      - 128 Kb
+      - 16 Kb
+    * - ``32u416m``
+      - `Microduino-Core USB
+        <http://www.microduino.cc/wiki/index.php?title=Microduino-CoreUSB>`_
+      - ATmega32u4 ``atmega32u4``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2.5 Kb
+
+
+More detailed information you can find here
+`Microduino boards <http://www.microduino.cc/wiki/index.php?title=Main_Page>`_.
+
+
+Miscellaneous
+~~~~~~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller ``board_mcu``
+      - Frequency ``board_f_cpu``
+      - Flash
+      - RAM
+    * - ``raspduino``
+      - `Raspduino
+        <http://www.bitwizard.nl/wiki/index.php/Raspduino>`_
+      - ATmega328P ``atmega328p``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2 Kb
@@ -0,0 +1,19 @@
+.. _platforms:
+
+Platforms & Embedded Boards
+===========================
+
+*PlatformIO* has pre-built different development platforms for popular OS (Mac,
+Linux 32/64/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
+    timsp430
+    titiva
@@ -0,0 +1,119 @@
+.. _platform_timsp430:
+
+Platform ``timsp430``
+=====================
+
+`MSP430 microcontrollers (MCUs) from Texas Instruments (TI) <http://www.ti.com/lsds/ti/microcontrollers_16-bit_32-bit/msp/overview.page>`_
+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.
+
+.. contents::
+
+Packages
+--------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Alias
+      - Contents
+    * - ``toolchain-timsp430``
+      - toolchain
+      - `msp-gcc <http://sourceforge.net/projects/mspgcc/>`_,
+        `GDB <http://www.gnu.org/software/gdb/>`_
+    * - ``tool-mspdebug``
+      - uploader
+      - `MSPDebug <http://mspdebug.sourceforge.net>`_
+    * - ``framework-energiamsp430``
+      -
+      - See below in :ref:`timsp430_frameworks`
+
+
+.. note::
+    You can install ``atmelavr`` platform with these packages
+    via :ref:`cmd_install` command.
+
+
+.. _timsp430_frameworks:
+
+Frameworks
+----------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``framework``
+      - Name
+      - Reference
+    * - ``energia``
+      - Energia Wiring-based Framework (MSP430 Core)
+      - `Documentation <http://energia.nu/reference/>`_
+
+
+Boards
+------
+
+.. note::
+   For more detailed ``board`` information please scroll table below by
+   horizontal.
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller ``board_mcu``
+      - Frequency ``board_f_cpu``
+      - Flash
+      - RAM
+    * - ``lpmsp430g2231``
+      - `MSP430G2231 LaunchPad <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430g2.html>`_
+      - MSP430G2231 ``msp430g2231``
+      - 16 MHz ``16000000L``
+      - 2 Kb
+      - 128 B
+    * - ``lpmsp430g2452``
+      - `MSP430G2452 LaunchPad <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430g2.html>`_
+      - MSP430G2452 ``msp430g2452``
+      - 16 MHz ``16000000L``
+      - 8 Kb
+      - 256 B
+    * - ``lpmsp430g2553``
+      - `MSP430G2553 LaunchPad <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430g2.html>`_
+      - MSP430G2553 ``msp430g2553``
+      - 16 MHz ``16000000L``
+      - 16 Kb
+      - 512 B
+    * - ``lpmsp430f5529``
+      - `MSP430F5529 LaunchPad (16 Mhz) <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430f5529lp.html>`_
+      - MSP430F5529 ``msp430f5529``
+      - 16 MHz ``16000000L``
+      - 128 Kb
+      - 8 KB
+    * - ``lpmsp430f5529_25``
+      - `MSP430F5529 LaunchPad (25 Mhz) <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430f5529lp.html>`_
+      - MSP430F5529 ``msp430f5529``
+      - 25 MHz ``25000000L``
+      - 128 Kb
+      - 8 KB
+    * - ``lpmsp430fr5739``
+      - `MSP430FR5739 Experimenter Board <http://www.ti.com/tool/msp-exp430fr5739>`_
+      - MSP430FR5739 ``msp430fr5739``
+      - 16 MHz ``16000000L``
+      - 16 Kb
+      - 1 KB
+    * - ``lpmsp430fr5969``
+      - `MSP430FR5969 LaunchPad <http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430fr5969.html>`_
+      - MSP430FR5969 ``msp430fr5969``
+      - 16 MHz ``16000000L``
+      - 64 Kb
+      - 2 KB
+
+
+More detailed information you can find here
+`MSP430 LaunchPads <http://www.ti.com/ww/en/launchpad/launchpads-msp430.html>`_.
+
+
+
@@ -0,0 +1,93 @@
+.. _platform_titiva:
+
+Platform ``titiva``
+===================
+
+`Texas Instruments TM4C12x MCUs <http://www.ti.com/lsds/ti/microcontrollers_16-bit_32-bit/c2000_performance/control_automation/tm4c12x/overview.page>`_
+offer the industry’s 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.
+
+.. contents::
+
+Packages
+--------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Alias
+      - Contents
+    * - ``toolchain-gccarmnoneeabi``
+      - toolchain
+      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded/>`_,
+        `GDB <http://www.gnu.org/software/gdb/>`_
+    * - ``tool-lm4flash``
+      - uploader
+      - `Flash Programmer <http://www.ti.com/tool/lmflashprogrammer>`_
+    * - ``framework-energiativa``
+      -
+      - See below in :ref:`titiva_frameworks`
+
+.. note::
+    You can install ``titiva`` platform with these packages
+    via :ref:`cmd_install` command.
+
+
+.. _titiva_frameworks:
+
+Frameworks
+----------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``framework``
+      - Name
+      - Reference
+    * - ``energia``
+      - Energia Wiring-based Framework (LM4F Core)
+      - `Documentation <http://energia.nu/reference/>`_
+
+
+Boards
+------
+
+.. note::
+   For more detailed ``board`` information please scroll table below by
+   horizontal.
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller ``board_mcu``
+      - Frequency ``board_f_cpu``
+      - Flash
+      - RAM
+    * - ``lplm4f120h5qr``
+      - `Stellaris LM4F120 LaunchPad <http://www.ti.com/tool/ek-lm4f120xl>`_
+      - LM4F120H5QR ``cortex-m4``
+      - 80 MHz ``80000000L``
+      - 256 Kb
+      - 32 Kb
+    * - ``lptm4c1230c3pm``
+      - `Tiva C Series TM4C123G LaunchPad
+        <http://www.ti.com/ww/en/launchpad/launchpads-connected-ek-tm4c123gxl.html>`_
+      - TM4C123GH6PM ``cortex-m4``
+      - 80 MHz ``80000000L``
+      - 256 Kb
+      - 32 Kb
+    * - ``lptm4c1294ncpdt``
+      - `Tiva C Series TM4C1294 Connected LaunchPad
+        <http://www.ti.com/ww/en/launchpad/launchpads-connected-ek-tm4c1294xl.html>`_
+      - TM4C1294NCPDT ``cortex-m4``
+      - 120 Mhz ``120000000L``
+      - 1 Mb
+      - 256 Kb
+
+More detailed information you can find here
+`TIVA C Series LaunchPads <http://www.ti.com/ww/en/launchpad/launchpads-connected.html>`_.