From 0a19730fa66a27f3578f5780b182b48a4959e436 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Sat, 29 Oct 2016 00:17:55 +0300 Subject: [PATCH] Access to Serial Ports (USB/UART) information for dev platform --- docs/frameworks/arduino.rst | 20 +++++++++++++++++++ docs/installation.rst | 29 +++++++++++++-------------- docs/platforms/atmelavr.rst | 31 +++++++++++++++++++++++++++-- docs/platforms/atmelsam.rst | 11 ++++++++-- docs/platforms/embedded_boards.rst | 20 +++++++++++++++++++ docs/platforms/espressif8266.rst | 11 ++++++++-- docs/platforms/freescalekinetis.rst | 11 ++++++++-- docs/platforms/intel_arc32.rst | 11 ++++++++-- docs/platforms/lattice_ice40.rst | 11 ++++++++-- docs/platforms/microchippic32.rst | 11 ++++++++-- docs/platforms/nordicnrf51.rst | 11 ++++++++-- docs/platforms/nxplpc.rst | 11 ++++++++-- docs/platforms/siliconlabsefm32.rst | 11 ++++++++-- docs/platforms/ststm32.rst | 11 ++++++++-- docs/platforms/teensy.rst | 11 ++++++++-- docs/platforms/timsp430.rst | 11 ++++++++-- docs/platforms/titiva.rst | 11 ++++++++-- scripts/docspregen.py | 13 ++++++++++-- 18 files changed, 211 insertions(+), 45 deletions(-) diff --git a/docs/frameworks/arduino.rst b/docs/frameworks/arduino.rst index ee63864d..83855bf5 100644 --- a/docs/frameworks/arduino.rst +++ b/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 `_ + - ATMEGA256RFR2 + - 16 MHz + - 256 Kb + - 32 Kb + ubIQio ~~~~~~ diff --git a/docs/installation.rst b/docs/installation.rst index b0fc232e..193d84f4 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -43,27 +43,26 @@ System requirements :Terminal Application: - .. attention:: - All commands below should be executed in - `Command-line `_ - application (Terminal). For Mac OS X and Linux OS - *Terminal* application, - for Windows OS – ``cmd.exe`` application. + All commands below should be executed in + `Command-line `_ + application (Terminal). For Mac OS X and Linux OS - *Terminal* application, + for Windows OS – ``cmd.exe`` application. :Access to Serial Ports (USB/UART): - **Windows Users:** Please check that you have correctly installed USB - driver from board manufacturer + **Windows Users:** Please check that you have correctly installed USB + driver from board manufacturer - **Linux Users**: + **Linux Users**: - * 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 `_ - (an instruction is located in the file). - * Raspberry Pi users, please read this article - `Enable serial port on Raspberry Pi `__. + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. Installation Methods diff --git a/docs/platforms/atmelavr.rst b/docs/platforms/atmelavr.rst index 798dfd6f..8c0a211f 100644 --- a/docs/platforms/atmelavr.rst +++ b/docs/platforms/atmelavr.rst @@ -44,8 +44,15 @@ Packages - `avr-gcc `_, `GDB `_, `AVaRICE `_, `SimulAVR `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `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 `_ + - ATMEGA256RFR2 + - 16 MHz + - 256 Kb + - 32 Kb + ubIQio ~~~~~~ diff --git a/docs/platforms/atmelsam.rst b/docs/platforms/atmelsam.rst index e4bf5842..9ba08c47 100644 --- a/docs/platforms/atmelsam.rst +++ b/docs/platforms/atmelsam.rst @@ -50,8 +50,15 @@ Packages - `gcc-arm-embedded `_, `GDB `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Please check that you have correctly installed USB diff --git a/docs/platforms/embedded_boards.rst b/docs/platforms/embedded_boards.rst index 4323a690..a9bc657b 100644 --- a/docs/platforms/embedded_boards.rst +++ b/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 `_ + - ATMEGA256RFR2 + - 16 MHz + - 256 Kb + - 32 Kb + u-blox ~~~~~~ diff --git a/docs/platforms/espressif8266.rst b/docs/platforms/espressif8266.rst index 6b0ce2c6..0d10c773 100644 --- a/docs/platforms/espressif8266.rst +++ b/docs/platforms/espressif8266.rst @@ -47,8 +47,15 @@ Packages - `xtensa-gcc `_, `GDB `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Please check that you have correctly installed USB diff --git a/docs/platforms/freescalekinetis.rst b/docs/platforms/freescalekinetis.rst index 494e8527..ebace7ee 100644 --- a/docs/platforms/freescalekinetis.rst +++ b/docs/platforms/freescalekinetis.rst @@ -35,8 +35,15 @@ Packages - `gcc-arm-embedded `_, `GDB `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Please check that you have correctly installed USB diff --git a/docs/platforms/intel_arc32.rst b/docs/platforms/intel_arc32.rst index 3127fd76..96f2ec13 100644 --- a/docs/platforms/intel_arc32.rst +++ b/docs/platforms/intel_arc32.rst @@ -38,8 +38,15 @@ Packages - `GCC for Intel ARC `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Please check that you have correctly installed USB diff --git a/docs/platforms/lattice_ice40.rst b/docs/platforms/lattice_ice40.rst index b0c77346..e377a91f 100644 --- a/docs/platforms/lattice_ice40.rst +++ b/docs/platforms/lattice_ice40.rst @@ -35,8 +35,15 @@ Packages - `Verilog simulation and synthesis tool `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Please check that you have correctly installed USB diff --git a/docs/platforms/microchippic32.rst b/docs/platforms/microchippic32.rst index 8d4cf12d..bf41cca6 100644 --- a/docs/platforms/microchippic32.rst +++ b/docs/platforms/microchippic32.rst @@ -38,8 +38,15 @@ Packages - `GCC for Microchip PIC32 `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Please check that you have correctly installed USB diff --git a/docs/platforms/nordicnrf51.rst b/docs/platforms/nordicnrf51.rst index 683bdebe..89111c94 100644 --- a/docs/platforms/nordicnrf51.rst +++ b/docs/platforms/nordicnrf51.rst @@ -44,8 +44,15 @@ Packages - `gcc-arm-embedded `_, `GDB `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Please check that you have correctly installed USB diff --git a/docs/platforms/nxplpc.rst b/docs/platforms/nxplpc.rst index e9a4764e..c4caeb4b 100644 --- a/docs/platforms/nxplpc.rst +++ b/docs/platforms/nxplpc.rst @@ -35,8 +35,15 @@ Packages - `gcc-arm-embedded `_, `GDB `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Please check that you have correctly installed USB diff --git a/docs/platforms/siliconlabsefm32.rst b/docs/platforms/siliconlabsefm32.rst index c1ccc8a5..70dfe4b2 100644 --- a/docs/platforms/siliconlabsefm32.rst +++ b/docs/platforms/siliconlabsefm32.rst @@ -35,8 +35,15 @@ Packages - `gcc-arm-embedded `_, `GDB `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Please check that you have correctly installed USB diff --git a/docs/platforms/ststm32.rst b/docs/platforms/ststm32.rst index fe35e766..93fe8f59 100644 --- a/docs/platforms/ststm32.rst +++ b/docs/platforms/ststm32.rst @@ -53,8 +53,15 @@ Packages - `gcc-arm-embedded `_, `GDB `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Please check that you have correctly installed USB diff --git a/docs/platforms/teensy.rst b/docs/platforms/teensy.rst index 98e00096..fa398a36 100644 --- a/docs/platforms/teensy.rst +++ b/docs/platforms/teensy.rst @@ -44,8 +44,15 @@ Packages - `gcc-arm-embedded `_, `GDB `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Teensy programming uses only Windows built-in HID diff --git a/docs/platforms/timsp430.rst b/docs/platforms/timsp430.rst index 91ab1e8b..40d02ef4 100644 --- a/docs/platforms/timsp430.rst +++ b/docs/platforms/timsp430.rst @@ -41,8 +41,15 @@ Packages - `msp-gcc `_, `GDB `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Please check that you have correctly installed USB diff --git a/docs/platforms/titiva.rst b/docs/platforms/titiva.rst index ff67ab16..6cb2d571 100644 --- a/docs/platforms/titiva.rst +++ b/docs/platforms/titiva.rst @@ -41,8 +41,15 @@ Packages - `gcc-arm-embedded `_, `GDB `_ .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. **Windows Users:** Please check that you have correctly installed USB diff --git a/scripts/docspregen.py b/scripts/docspregen.py index 832e5291..e9040b8a 100644 --- a/scripts/docspregen.py +++ b/scripts/docspregen.py @@ -107,9 +107,17 @@ Packages if is_embedded: lines.append(""" .. warning:: - **Linux Users:** Don't forget to install "udev" rules file - `99-platformio-udev.rules `_ (an instruction is located in the file). + **Linux Users**: + + * 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 `_ + (an instruction is located in the file). + * Raspberry Pi users, please read this article + `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)