Access to Serial Ports (USB/UART) information for dev platform

docs/frameworks/arduino.rst

@@ -2037,6 +2037,26 @@ element14
       - 128 Kb
       - 32 Kb
 
+makerlab.mx
+~~~~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``altair``
+      - `Altair <http://www.aquila.io/en>`_
+      - ATMEGA256RFR2
+      - 16 MHz
+      - 256 Kb
+      - 32 Kb
+
 ubIQio
 ~~~~~~
 

docs/installation.rst

@@ -43,27 +43,26 @@ System requirements
 
 :Terminal Application:
 
-    .. attention::
+    All commands below should be executed in
-        All commands below should be executed in
+    `Command-line <http://en.wikipedia.org/wiki/Command-line_interface>`_
-        `Command-line <http://en.wikipedia.org/wiki/Command-line_interface>`_
+    application (Terminal). For Mac OS X and Linux OS - *Terminal* application,
-        application (Terminal). For Mac OS X and Linux OS - *Terminal* application,
+    for Windows OS – ``cmd.exe`` application.
-        for Windows OS – ``cmd.exe`` application.
 
 
 :Access to Serial Ports (USB/UART):
 
-        **Windows Users:** Please check that you have correctly installed USB
+    **Windows Users:** Please check that you have correctly installed USB
-        driver from board manufacturer
+    driver from board manufacturer
 
-        **Linux Users**:
+    **Linux Users**:
 
-        * Ubuntu/Debian users may need to add own "username" to the "dialout"
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
-          group if they are not "root", doing this issuing a
+      group if they are not "root", doing this issuing a
-          ``sudo usermod -a -G dialout yourusername``.
+      ``sudo usermod -a -G dialout yourusername``.
-        * Install "udev" rules file `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_
+    * 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).
+      (an instruction is located in the file).
-        * Raspberry Pi users, please read this article
+    * Raspberry Pi users, please read this article
-          `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
 Installation Methods

docs/platforms/atmelavr.rst

@@ -44,8 +44,15 @@ Packages
       - `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/>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB
@@ -1158,6 +1165,26 @@ Wicked Device
       - 128 Kb
       - 16 Kb
 
+makerlab.mx
+~~~~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``altair``
+      - `Altair <http://www.aquila.io/en>`_
+      - ATMEGA256RFR2
+      - 16 MHz
+      - 256 Kb
+      - 32 Kb
+
 ubIQio
 ~~~~~~
 

docs/platforms/atmelsam.rst

@@ -50,8 +50,15 @@ Packages
       - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB

docs/platforms/embedded_boards.rst

@@ -3253,6 +3253,26 @@ element14
       - 128 Kb
       - 32 Kb
 
+makerlab.mx
+~~~~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``altair``
+      - `Altair <http://www.aquila.io/en>`_
+      - ATMEGA256RFR2
+      - 16 MHz
+      - 256 Kb
+      - 32 Kb
+
 u-blox
 ~~~~~~
 

docs/platforms/espressif8266.rst

@@ -47,8 +47,15 @@ Packages
       - `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
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB

docs/platforms/freescalekinetis.rst

@@ -35,8 +35,15 @@ Packages
       - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB

docs/platforms/intel_arc32.rst

@@ -38,8 +38,15 @@ Packages
       - `GCC for Intel ARC <https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB

docs/platforms/lattice_ice40.rst

@@ -35,8 +35,15 @@ Packages
       - `Verilog simulation and synthesis tool <http://iverilog.icarus.com>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB

docs/platforms/microchippic32.rst

@@ -38,8 +38,15 @@ Packages
       - `GCC for Microchip PIC32 <https://github.com/chipKIT32/chipKIT-cxx>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB

docs/platforms/nordicnrf51.rst

@@ -44,8 +44,15 @@ Packages
       - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB

docs/platforms/nxplpc.rst

@@ -35,8 +35,15 @@ Packages
       - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB

docs/platforms/siliconlabsefm32.rst

@@ -35,8 +35,15 @@ Packages
       - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB

docs/platforms/ststm32.rst

@@ -53,8 +53,15 @@ Packages
       - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB

docs/platforms/teensy.rst

@@ -44,8 +44,15 @@ Packages
       - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Teensy programming uses only Windows built-in HID

docs/platforms/timsp430.rst

@@ -41,8 +41,15 @@ Packages
       - `msp-gcc <http://sourceforge.net/projects/mspgcc/>`_, `GDB <http://www.gnu.org/software/gdb/>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB

docs/platforms/titiva.rst

@@ -41,8 +41,15 @@ Packages
       - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
 
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 
 
     **Windows Users:** Please check that you have correctly installed USB

scripts/docspregen.py

@@ -107,9 +107,17 @@ Packages
     if is_embedded:
         lines.append("""
 .. warning::
-    **Linux Users:** Don't forget to install "udev" rules file
+    **Linux Users**:
-    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+      group if they are not "root", doing this issuing a
+      ``sudo usermod -a -G dialout yourusername``.
+    * 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).
+    * Raspberry Pi users, please read this article
+      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 """)
+
         if platform == "teensy":
             lines.append("""
     **Windows Users:** Teensy programming uses only Windows built-in HID
@@ -125,6 +133,7 @@ Packages
     driver from board manufacturer
 
 """)
+
     return "\n".join(lines)