Doc: Describe the serial terminal plugin

For connecting devices by serial ports.

Change-Id: Ie391a98c2964a48e42a74148130f691a661e39e3
Reviewed-by: André Hartmann <aha_1980@gmx.de>

7 files changed, 99 insertions, 5 deletions

diff --git a/doc/images/qtcreator-serial-terminal.png b/doc/images/qtcreator-serial-terminal.png
new file mode 100644
index 0000000000..dc087e1261
--- /dev/null
+++ b/doc/images/qtcreator-serial-terminal.png
diff --git a/doc/src/howto/creator-only/creator-serialterminal.qdoc b/doc/src/howto/creator-only/creator-serialterminal.qdoc
new file mode 100644
index 0000000000..82c69ff2a7
--- /dev/null
+++ b/doc/src/howto/creator-only/creator-serialterminal.qdoc
@@ -0,0 +1,82 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 Andre Hartmann <aha_1980@gmx.de>
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt Creator documentation.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+**
+****************************************************************************/
+
+    /*!
+
+    \contentspage index.html
+    \previouspage creator-developing-qnx.html
+    \page creator-serialterminal.html
+    \nextpage creator-build-process-customizing.html
+
+    \title Connecting Devices by Serial Ports
+
+    You can use the \uicontrol {Serial Terminal} output pane to connect devices
+    by serial ports. These ports can be real RS-232 ports, or virtual serial
+    ports provided by USB chipsets.
+
+    \image qtcreator-serial-terminal.png "Serial Terminal output pane"
+
+    To set up a connection:
+
+    \list 1
+        \li Select \uicontrol Help > \uicontrol {About Plugins} >
+            \uicontrol {Utilities} > \uicontrol {Serial Terminal}
+            to enable the plugin.
+        \li Restart \QC to load the plugin.
+        \li In the \uicontrol {Serial Terminal} output pane, select a
+            COM port. The list is updated when ports become available.
+        \li Select the bitrate for the communication.
+        \li To establish the connection, select the \inlineimage run_small.png
+            (\uicontrol Connect) button.
+    \endlist
+
+    To create additional connections, select the \inlineimage plus.png
+    (\uicontrol {Add New Terminal}) button.
+
+    To close a connection, select the \inlineimage stop_small.png
+    (\uicontrol Stop) button.
+
+    The \inlineimage reload_gray.png
+    (\uicontrol {Reset Board}) button toggles the DTR (Data Terminal Ready)
+    line, which causes a board reset on Arduino compatible boards.
+
+    Incoming data is displayed in the output pane.
+
+    Use the command line at the bottom to send commands to the remote station.
+
+    Select the line endings in the list next to the command line:
+
+    \list
+        \li None - the lines have no special termination
+        \li LF - the lines are terminated by a line feed (ASCII 0xA) character
+        \li CR - the lines are terminated by a carriage return (ASCII 0xD)
+            character
+        \li CRLF - the lines are terminated by a carriage return and a line feed
+            character
+    \endlist
+
+    \note On Linux, you need the appropriate rights to access serial ports.
+    Often, it is sufficient to add your user account to the group dialout.
+*/
diff --git a/doc/src/howto/creator-ui.qdoc b/doc/src/howto/creator-ui.qdoc
index adc38a0cf3..0f2925cee1 100644
--- a/doc/src/howto/creator-ui.qdoc
+++ b/doc/src/howto/creator-ui.qdoc
@@ -360,6 +360,8 @@
        \li \uicontrol{Test Results}
 
        \li \uicontrol {To-Do Entries}
+
+       \li \uicontrol {Serial Terminal}
        \endif
 
     \endlist
@@ -389,7 +391,9 @@
     \endif
      panes, select \uicontrol {Window > Output Panes}.
     \if defined(qtcreator)
-    To display the \uicontrol {To-Do Entries} pane, enable the Todo plugin.
+    To display the \l{To-Do Entries} or
+    \l{Connecting Devices by Serial Ports}{Serial Terminal}
+    pane, enable the respective plugin.
     \endif
 
     For more information about the \uicontrol {QML Debugger Console} view, see
diff --git a/doc/src/overview/creator-only/creator-mobile-targets.qdoc b/doc/src/overview/creator-only/creator-mobile-targets.qdoc
index 9cc5039656..e6c985d809 100644
--- a/doc/src/overview/creator-only/creator-mobile-targets.qdoc
+++ b/doc/src/overview/creator-only/creator-mobile-targets.qdoc
@@ -95,8 +95,15 @@
 
     \list
 
-        \li \l{http://doc.qt.io/qtcreator/creator-overview-qtasam.html}
-            {Qt Application Manager}
+        \li \l{Connecting Devices by Serial Ports}
+
+            You can connect devices by serial ports in the
+            \uicontrol {Serial Terminal} output pane. These
+            ports can be real RS-232 ports, or virtual serial
+            ports provided by USB chipsets.
+
+        \li \l{https://doc.qt.io/qtcreator/creator-overview-qtasam.html}
+            {Qt Creator Plugin for Qt Application Manager}
 
             You can use the experimental Qt Application Manager plugin
             (commercial only) to deploy, run, and debug applications on the
diff --git a/doc/src/projects/creator-only/creator-projects-builds-customizing.qdoc b/doc/src/projects/creator-only/creator-projects-builds-customizing.qdoc
index 08e894f919..c98e36ce1a 100644
--- a/doc/src/projects/creator-only/creator-projects-builds-customizing.qdoc
+++ b/doc/src/projects/creator-only/creator-projects-builds-customizing.qdoc
@@ -36,7 +36,7 @@
     \previouspage creator-developing-generic-linux.html
     \nextpage studio-advanced.html
     \else
-    \previouspage creator-developing-qnx.html
+    \previouspage creator-serialterminal.html
     \nextpage creator-testing.html
     \endif
 
diff --git a/doc/src/qnx/creator-developing-qnx.qdoc b/doc/src/qnx/creator-developing-qnx.qdoc
index 115e552bc9..a9fe97b89d 100644
--- a/doc/src/qnx/creator-developing-qnx.qdoc
+++ b/doc/src/qnx/creator-developing-qnx.qdoc
@@ -32,7 +32,7 @@
     \contentspage index.html
     \previouspage creator-developing-ios.html
     \page creator-developing-qnx.html
-    \nextpage creator-build-process-customizing.html
+    \nextpage creator-serialterminal.html
 
     \title Connecting QNX Devices
 
diff --git a/doc/src/qtcreator-toc.qdoc b/doc/src/qtcreator-toc.qdoc
index 331a5a8091..c849b71b66 100644
--- a/doc/src/qtcreator-toc.qdoc
+++ b/doc/src/qtcreator-toc.qdoc
@@ -176,6 +176,7 @@
                 \li \l{Connecting Embedded Linux Devices}
                 \li \l{Connecting iOS Devices}
                 \li \l{Connecting QNX Devices}
+                \li \l{Connecting Devices by Serial Ports}
             \endlist
             \li \l{Customizing the Build Process}
         \endlist