Implement 'boards' command // Resolve #11

2014-12-27 23:59:20 +02:00
parent 01bbfcced0
commit 2aa4d0af33
16 changed files with 1251 additions and 105 deletions
@@ -0,0 +1,87 @@
+.. _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
+    ---------------------------------------------------------------------------
+    bt                    atmega168     16Mhz     14Kb    1Kb    Arduino BT
+    btatmega168           atmega168     16Mhz     14Kb    1Kb    Arduino BT ATmega168
+    btatmega328           atmega168     16Mhz     14Kb    1Kb    Arduino BT ATmega328
+    diecimila             atmega168     16Mhz     14Kb    1Kb    Arduino Duemilanove or Diecimila
+    diecimilaatmega168    atmega168     16Mhz     14Kb    1Kb    Arduino Duemilanove or Diecimila ATmega168
+    diecimilaatmega328    atmega168     16Mhz     14Kb    1Kb    Arduino Duemilanove or Diecimila ATmega328
+    esplora               atmega32u4    16Mhz     28Kb    2Kb    Arduino Esplora
+    ethernet              atmega328p    16Mhz     31Kb    2Kb    Arduino Ethernet
+    ...
+
+2. Show boards which are based on ``ATmega168`` MCU
+
+.. code-block:: bash
+
+    $ platformio boards atmega168
+
+    Platform: atmelavr
+    ---------------------------------------------------------------------------
+    Type                  MCU           Frequency  Flash   RAM    Name
+    ---------------------------------------------------------------------------
+    bt                    atmega168     16Mhz     14Kb    1Kb    Arduino BT
+    btatmega168           atmega168     16Mhz     14Kb    1Kb    Arduino BT ATmega168
+    ...
+    pro                   atmega168     8Mhz      14Kb    1Kb    Arduino Pro or Pro Mini
+    ...
+    lilypad               atmega168     8Mhz      14Kb    1Kb    LilyPad Arduino
+    lilypadatmega168      atmega168     8Mhz      14Kb    1Kb    LilyPad Arduino ATmega168
+    lilypadatmega328      atmega168     8Mhz      14Kb    1Kb    LilyPad Arduino ATmega328
+    168pa16m              atmega168p    16Mhz     15Kb    1Kb    Microduino Core (Atmega168PA@16M,5V)
+    168pa8m               atmega168p    8Mhz      15Kb    1Kb    Microduino Core (Atmega168PA@8M,3.3V)
+
+3. 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)
+
@@ -14,6 +14,7 @@ To print all available commands and options use:
 .. toctree::
    :maxdepth: 2

+    cmd_boards
    cmd_init
    cmd_install
    platformio lib <lib/index>