Update docs for boards, platforms and frameworks

2016-10-12 18:51:47 +03:00
parent e8866c9643
commit 27e988e63a
9 changed files with 541 additions and 24 deletions
--- a/docs/frameworks/arduino.rst
+++ b/docs/frameworks/arduino.rst
@ -725,6 +725,26 @@ Doit
      - 4096 Kb
      - 80 Kb

+DycodeX
+~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``espectro``
+      - `ESPrectro Core <https://shop.makestro.com/en/product/espectro-core/>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
 ESPert
 ~~~~~~

@ -1299,7 +1319,7 @@ Olimex
      - RAM

    * - ``maple``
-      - `Olimexino STM32 <https://www.olimex.com/Products/Duino/STM32/OLIMEXINO-STM32/>`_
+      - `Olimexino STM32 (Maple) <https://www.olimex.com/Products/Duino/STM32/OLIMEXINO-STM32/>`_
      - STM32F103RB_MAPLE
      - 72 MHz
      - 128 Kb
@ -1829,14 +1849,14 @@ Teensy
      - 64 Kb

    * - ``teensy35``
-      - `Teensy 3.5 <https://www.pjrc.com>`_
+      - `Teensy 3.5 <https://www.pjrc.com/store/teensy35.html>`_
      - MK64FX512
      - 120 MHz
      - 512 Kb
      - 192 Kb

    * - ``teensy36``
-      - `Teensy 3.6 <https://www.pjrc.com>`_
+      - `Teensy 3.6 <https://www.pjrc.com/store/teensy36.html>`_
      - MK66FX1M0
      - 180 MHz
      - 1024 Kb
--- a/docs/frameworks/mbed.rst
+++ b/docs/frameworks/mbed.rst
@ -715,6 +715,13 @@ ST
      - 1024 Kb
      - 320 Kb

+    * - ``disco_f769ni``
+      - `ST 32F769IDISCOVERY <http://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-eval-tools/stm32-mcu-eval-tools/stm32-mcu-discovery-kits/32f769idiscovery.html>`_
+      - STM32F769NIH6
+      - 80 MHz
+      - 1024 Kb
+      - 512 Kb
+
    * - ``disco_l053c8``
      - `ST 32L0538DISCOVERY <http://www.st.com/web/en/catalog/tools/PF260319>`_
      - STM32L053C8T6
--- a/docs/platforms/creating_platform.rst
+++ b/docs/platforms/creating_platform.rst
@ -152,6 +152,9 @@ Packages
    * - ``tool-stlink``
      - `ST-Link <https://github.com/texane/stlink>`_

+    * - ``tool-stm32duino``
+      - `STM32Duino Tools <https://github.com/rogerclarkmelbourne/Arduino_STM32>`_
+
    * - ``tool-teensy``
      - `Teensy Loader <https://www.pjrc.com/teensy/loader.html>`_

@ -174,11 +177,14 @@ Packages
      - `MinGW <http://www.mingw.org>`_

    * - ``toolchain-icestorm``
-      - `GCC for FPGA IceStorm <http://www.clifford.at/icestorm/>`_
+      - `Tools for analyzing and creating bitstream files for FPGA IceStorm <http://www.clifford.at/icestorm/>`_

    * - ``toolchain-intelarc32``
      - `GCC for Intel ARC <https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain>`_

+    * - ``toolchain-iverilog``
+      - `Verilog simulation and synthesis tool <http://iverilog.icarus.com>`_
+
    * - ``toolchain-microchippic32``
      - `GCC for Microchip PIC32 <https://github.com/chipKIT32/chipKIT-cxx>`_

--- a/docs/platforms/embedded_boards.rst
+++ b/docs/platforms/embedded_boards.rst
@ -597,13 +597,6 @@ BQ
      - Flash
      - RAM

-    * - ``icezum``
-      - `BQ IceZUM Alhambra FPGA <https://github.com/bqlabs/icezum/wiki>`_
-      - ICE40HX1K
-      - 12 MHz
-      - 32 Kb
-      - 32 Kb
-
    * - ``zumbt328``
      - `BQ ZUM BT-328 <http://www.bq.com/gb/products/zum.html>`_
      - ATMEGA328P
@ -843,6 +836,26 @@ Doit
      - 4096 Kb
      - 80 Kb

+DycodeX
+~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``espectro``
+      - `ESPrectro Core <https://shop.makestro.com/en/product/espectro-core/>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
 ESPert
 ~~~~~~

@ -1054,6 +1067,26 @@ Espressif
      - 448 Kb
      - 80 Kb

+FPGAwars
+~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``icezum``
+      - `IceZUM Alhambra FPGA <https://github.com/FPGAwars/icezum/wiki>`_
+      - ICE40-HX1K-TQ144
+      - 12 MHz
+      - 32 Kb
+      - 32 Kb
+
 Freescale
 ~~~~~~~~~

@ -1363,7 +1396,7 @@ Lattice

    * - ``icestick``
      - `Lattice iCEstick FPGA Evaluation Kit <http://www.latticesemi.com/icestick>`_
-      - ICE40HX1K
+      - ICE40-HX1K-TQ144
      - 12 MHz
      - 32 Kb
      - 32 Kb
@ -1839,7 +1872,7 @@ Olimex
      - RAM

    * - ``maple``
-      - `Olimexino STM32 <https://www.olimex.com/Products/Duino/STM32/OLIMEXINO-STM32/>`_
+      - `Olimexino STM32 (Maple) <https://www.olimex.com/Products/Duino/STM32/OLIMEXINO-STM32/>`_
      - STM32F103RB_MAPLE
      - 72 MHz
      - 128 Kb
@ -2231,6 +2264,13 @@ ST
      - 1024 Kb
      - 320 Kb

+    * - ``disco_f769ni``
+      - `ST 32F769IDISCOVERY <http://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-eval-tools/stm32-mcu-eval-tools/stm32-mcu-discovery-kits/32f769idiscovery.html>`_
+      - STM32F769NIH6
+      - 80 MHz
+      - 1024 Kb
+      - 512 Kb
+
    * - ``disco_l053c8``
      - `ST 32L0538DISCOVERY <http://www.st.com/web/en/catalog/tools/PF260319>`_
      - STM32L053C8T6
@ -3025,14 +3065,14 @@ Teensy
      - 64 Kb

    * - ``teensy35``
-      - `Teensy 3.5 <https://www.pjrc.com>`_
+      - `Teensy 3.5 <https://www.pjrc.com/store/teensy35.html>`_
      - MK64FX512
      - 120 MHz
      - 512 Kb
      - 192 Kb

    * - ``teensy36``
-      - `Teensy 3.6 <https://www.pjrc.com>`_
+      - `Teensy 3.6 <https://www.pjrc.com/store/teensy36.html>`_
      - MK66FX1M0
      - 180 MHz
      - 1024 Kb
--- a/docs/platforms/espressif8266.rst
+++ b/docs/platforms/espressif8266.rst
@ -119,6 +119,26 @@ Doit
      - 4096 Kb
      - 80 Kb

+DycodeX
+~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``espectro``
+      - `ESPrectro Core <https://shop.makestro.com/en/product/espectro-core/>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
 ESPert
 ~~~~~~

--- a/docs/platforms/espressif8266_stage.rst
+++ b/docs/platforms/espressif8266_stage.rst
@ -0,0 +1,411 @@
+..  Copyright 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.
+
+.. _platform_espressif8266_stage:
+
+Platform ``espressif8266_stage``
+================================
+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
+
+    * - ``framework-arduinoespressif8266``
+      - `Arduino Wiring-based Framework (ESP8266 Core) <https://github.com/esp8266/Arduino>`_
+
+    * - ``framework-simba``
+      - `Simba Framework <https://github.com/eerimoq/simba>`_
+
+    * - ``sdk-esp8266``
+      - `ESP8266 SDK <http://bbs.espressif.com>`_
+
+    * - ``tool-esptool``
+      - `esptool-ck <https://github.com/igrr/esptool-ck>`_
+
+    * - ``tool-mkspiffs``
+      - `Tool to build and unpack SPIFFS images <https://github.com/igrr/mkspiffs>`_
+
+    * - ``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).
+
+
+    **Windows Users:** Please check that you have correctly installed USB
+    driver from board manufacturer
+
+
+
+Frameworks
+----------
+.. list-table::
+    :header-rows:  1
+
+    * - 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_simba`
+      - Simba is an RTOS and build framework. It aims to make embedded programming easy and portable.
+
+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
+
+    * - ``huzzah``
+      - `Adafruit HUZZAH ESP8266 <https://www.adafruit.com/products/2471>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+Doit
+~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``espduino``
+      - `ESPDuino (ESP-13 Module) <https://www.tindie.com/products/doit/espduinowifi-uno-r3/>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+DycodeX
+~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``espectro``
+      - `ESPrectro Core <https://shop.makestro.com/en/product/espectro-core/>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+ESPert
+~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``espresso_lite_v1``
+      - `ESPresso Lite 1.0 <http://www.espert.co>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+    * - ``espresso_lite_v2``
+      - `ESPresso Lite 2.0 <http://www.espert.co>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+ESPino
+~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``espino``
+      - `ESPino <http://www.espino.io>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+Espressif
+~~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``esp01``
+      - `Espressif Generic ESP8266 ESP-01 512k <http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family>`_
+      - ESP8266
+      - 80 MHz
+      - 512 Kb
+      - 80 Kb
+
+    * - ``esp01_1m``
+      - `Espressif Generic ESP8266 ESP-01 1M <http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family>`_
+      - ESP8266
+      - 80 MHz
+      - 1024 Kb
+      - 80 Kb
+
+    * - ``esp07``
+      - `Espressif Generic ESP8266 ESP-07 <http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family#esp-07>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+    * - ``esp12e``
+      - `Espressif ESP8266 ESP-12E <http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+    * - ``esp8285``
+      - `Generic ESP8285 Module <http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family>`_
+      - ESP8266
+      - 80 MHz
+      - 448 Kb
+      - 80 Kb
+
+    * - ``esp_wroom_02``
+      - `ESP-WROOM-02 <http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+    * - ``phoenix_v1``
+      - `Phoenix 1.0 <http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family>`_
+      - ESP8266
+      - 80 MHz
+      - 1024 Kb
+      - 80 Kb
+
+    * - ``phoenix_v2``
+      - `Phoenix 2.0 <http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family>`_
+      - ESP8266
+      - 80 MHz
+      - 1024 Kb
+      - 80 Kb
+
+    * - ``wifinfo``
+      - `WifInfo <http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family>`_
+      - ESP8266
+      - 80 MHz
+      - 448 Kb
+      - 80 Kb
+
+NodeMCU
+~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``nodemcu``
+      - `NodeMCU 0.9 (ESP-12 Module) <http://www.nodemcu.com/>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+    * - ``nodemcuv2``
+      - `NodeMCU 1.0 (ESP-12E Module) <http://www.nodemcu.com/>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+Olimex
+~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``modwifi``
+      - `Olimex MOD-WIFI-ESP8266(-DEV) <https://www.olimex.com/Products/IoT/MOD-WIFI-ESP8266-DEV/open-source-hardware>`_
+      - ESP8266
+      - 80 MHz
+      - 2048 Kb
+      - 80 Kb
+
+SparkFun
+~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``sparkfunBlynk``
+      - `SparkFun Blynk Board <https://www.sparkfun.com/products/13794>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+    * - ``thing``
+      - `SparkFun ESP8266 Thing <https://www.sparkfun.com/products/13231>`_
+      - ESP8266
+      - 80 MHz
+      - 512 Kb
+      - 80 Kb
+
+    * - ``thingdev``
+      - `SparkFun ESP8266 Thing Dev <https://www.sparkfun.com/products/13231>`_
+      - ESP8266
+      - 80 MHz
+      - 512 Kb
+      - 80 Kb
+
+SweetPea
+~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``esp210``
+      - `SweetPea ESP-210 <http://wiki.sweetpeas.se/index.php?title=ESP-210>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+ThaiEasyElec
+~~~~~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``espinotee``
+      - `ThaiEasyElec ESPino <http://www.thaieasyelec.com/products/wireless-modules/wifi-modules/espino-wifi-development-board-detail.html>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+WeMos
+~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``d1``
+      - `WeMos D1(Retired) <http://www.wemos.cc/wiki/doku.php?id=en:d1>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
+
+    * - ``d1_mini``
+      - `WeMos D1 R2 & mini <http://www.wemos.cc/wiki/doku.php?id=en:d1_mini>`_
+      - ESP8266
+      - 80 MHz
+      - 4096 Kb
+      - 80 Kb
--- a/docs/platforms/lattice_ice40.rst
+++ b/docs/platforms/lattice_ice40.rst
@ -29,7 +29,10 @@ Packages
      - Contents

    * - ``toolchain-icestorm``
-      - `GCC for FPGA IceStorm <http://www.clifford.at/icestorm/>`_
+      - `Tools for analyzing and creating bitstream files for FPGA IceStorm <http://www.clifford.at/icestorm/>`_
+
+    * - ``toolchain-iverilog``
+      - `Verilog simulation and synthesis tool <http://iverilog.icarus.com>`_

 .. warning::
    **Linux Users:** Don't forget to install "udev" rules file
@ -50,8 +53,8 @@ Boards
    * For more detailed ``board`` information please scroll tables below by
      horizontal.

-BQ
-~~
+FPGAwars
+~~~~~~~~

 .. list-table::
    :header-rows:  1
@ -64,8 +67,8 @@ BQ
      - RAM

    * - ``icezum``
-      - `BQ IceZUM Alhambra FPGA <https://github.com/bqlabs/icezum/wiki>`_
-      - ICE40HX1K
+      - `IceZUM Alhambra FPGA <https://github.com/FPGAwars/icezum/wiki>`_
+      - ICE40-HX1K-TQ144
      - 12 MHz
      - 32 Kb
      - 32 Kb
@ -85,7 +88,7 @@ Lattice

    * - ``icestick``
      - `Lattice iCEstick FPGA Evaluation Kit <http://www.latticesemi.com/icestick>`_
-      - ICE40HX1K
+      - ICE40-HX1K-TQ144
      - 12 MHz
      - 32 Kb
      - 32 Kb
--- a/docs/platforms/ststm32.rst
+++ b/docs/platforms/ststm32.rst
@ -46,6 +46,9 @@ Packages
    * - ``tool-stlink``
      - `ST-Link <https://github.com/texane/stlink>`_

+    * - ``tool-stm32duino``
+      - `STM32Duino Tools <https://github.com/rogerclarkmelbourne/Arduino_STM32>`_
+
    * - ``toolchain-gccarmnoneeabi``
      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_

@ -248,7 +251,7 @@ Olimex
      - RAM

    * - ``maple``
-      - `Olimexino STM32 <https://www.olimex.com/Products/Duino/STM32/OLIMEXINO-STM32/>`_
+      - `Olimexino STM32 (Maple) <https://www.olimex.com/Products/Duino/STM32/OLIMEXINO-STM32/>`_
      - STM32F103RB_MAPLE
      - 72 MHz
      - 128 Kb
@ -330,6 +333,13 @@ ST
      - 1024 Kb
      - 320 Kb

+    * - ``disco_f769ni``
+      - `ST 32F769IDISCOVERY <http://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-eval-tools/stm32-mcu-eval-tools/stm32-mcu-discovery-kits/32f769idiscovery.html>`_
+      - STM32F769NIH6
+      - 80 MHz
+      - 1024 Kb
+      - 512 Kb
+
    * - ``disco_l053c8``
      - `ST 32L0538DISCOVERY <http://www.st.com/web/en/catalog/tools/PF260319>`_
      - STM32L053C8T6
--- a/docs/platforms/teensy.rst
+++ b/docs/platforms/teensy.rst
@ -121,14 +121,14 @@ Teensy
      - 64 Kb

    * - ``teensy35``
-      - `Teensy 3.5 <https://www.pjrc.com>`_
+      - `Teensy 3.5 <https://www.pjrc.com/store/teensy35.html>`_
      - MK64FX512
      - 120 MHz
      - 512 Kb
      - 192 Kb

    * - ``teensy36``
-      - `Teensy 3.6 <https://www.pjrc.com>`_
+      - `Teensy 3.6 <https://www.pjrc.com/store/teensy36.html>`_
      - MK66FX1M0
      - 180 MHz
      - 1024 Kb