From 41d08cf0332676e2bcd881049f368d2bf72e30f7 Mon Sep 17 00:00:00 2001 From: Andre Hartmann Date: Tue, 15 Oct 2019 22:02:16 +0200 Subject: [PATCH] Doc: Describe the serial terminal plugin MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit For connecting devices by serial ports. Change-Id: Ie391a98c2964a48e42a74148130f691a661e39e3 Reviewed-by: André Hartmann --- doc/images/qtcreator-serial-terminal.png | Bin 0 -> 5924 bytes .../creator-only/creator-serialterminal.qdoc | 82 ++++++++++++++++++ doc/src/howto/creator-ui.qdoc | 6 +- .../creator-only/creator-mobile-targets.qdoc | 11 ++- .../creator-projects-builds-customizing.qdoc | 2 +- doc/src/qnx/creator-developing-qnx.qdoc | 2 +- doc/src/qtcreator-toc.qdoc | 1 + 7 files changed, 99 insertions(+), 5 deletions(-) create mode 100644 doc/images/qtcreator-serial-terminal.png create mode 100644 doc/src/howto/creator-only/creator-serialterminal.qdoc diff --git a/doc/images/qtcreator-serial-terminal.png b/doc/images/qtcreator-serial-terminal.png new file mode 100644 index 0000000000000000000000000000000000000000..dc087e1261ebcb18917552d0665c660186e0ffa6 GIT binary patch literal 5924 zcmeAS@N?(olHy`uVBq!ia0y~yU}|SzVEDmY|N1B2LWPZ!6Kid%2*-tU)w zy7&0UE#a|SRi|un*wu2Ew?${k6LFK}ky;KpLJ5r}oLi<|3dv>m^bnEdTd^u^>MAqw zt6gjtSJ{U?jd58uX>r__=e4f?_}-n1FFJR<&gSvQik$v(^T^x3f4!JH^>2lZb-(S* z?=|x)-`xE;siUK#$F1zh{#Yd?B_pQ9rx#DX^X&=`a%q{`I@Q&sW$JOW_xpb9X?J&U zX!p;Ynm#KrwYvLU*M?0w8>b#VzW?9X_4faMJf4-bZa<^H-One#w$<#&j ztc3LY6_0y={`~2C^Zu{&yV~<-&yJ3W*sz;R+key4#|!ICH?O{@QGWLRz8yOxqzfJ# zXiPM>o+sqrvpj#=q~P}*GpDkbncccy_xo-7{Ms_*-?#t&dy~#AnU!DjVqtsI&vyAb zi@f=^)!+QW%qi!HpC=|Ni|fTieCI28bfmLeT;J~V8Dr^s!DY*r2fu&R z7Q3jwO8xw)*Dv1ej@C&a^Yo2OHXFLt~1hZqg|NOcy7v1-NU7P<` z`?P=kuggF9y^U{MzTOcKl=}3;&E;!(zD4Q(EZri0Eu#Lcbje$m$e$aJ%l$s-UpMLB z{Nuelb~|d@e>@`me$VG~v-9^^zInK2iU#W<7mNCTf7sR==ASs_9)64c<4bNuPI+lq>XqKF|Nr;nl=#1|!vAYM`TPC8`m>FGduj_0#N3}fBYyVl$$5t5 z(Le9>ZZkZ8cSm8KvG>*8nWsEA7R`7szW;~o$Jn0T%+G7S{_Iu!D*x|8`~9Ei$}gF2 z;8hC~V(xr?Ztm^fF*a_E5ln;qx2)nPe+t& zn?E(U?nAS@&EGGV%P*grINLn`-R{op8jGd=M8^mCHl>Qgr!Xb4)o>6~=J(`&3(uX&Uo zo%GnW>24+G-jqAnB2Q~XRVKM@=x)FDCu8=l`&F;k-v9S)duB@XvA~mo^2hx|lP4FN z*R{=9oT_2?{9f;Jm%EeX*Cj{!Z{f**y64rKYth?9K403lI8Z|d1^U5k&+IR9yPN6utA~g^IUam;bNPn{fQ{)_vY5ky%T?@T&c3Uo%uBIhuFlBk89SheHt$(^trVD|L^*icSRXt^O*$-X#a_c{J^5d|1a;J=E&R6S)ZLz` z$IqYoX|q0wG4}K1z(c33s?|RQ7?%a!tca*Qv*yiv?e2~Zo9-;#u&IMXn;Tq>c6W4m zTs-x0=KdL%Ev&7rjTd&Vb7hwo7Zj9yYqCb>Sl4^Ex_>{P$5%d``n1!#L~EDW{OB8- z)BC?iySTXBJr(HHw*67}>pq{1McEe*zDVn^^mCM(dBkP^oU)D%pQfqFJ?31el!fQM zNGLJZdX{{=Pu9Nf&yf_>Dv`fNatcaDieY^d@15LMRAR78@>SKlozM4Kb#~UdzK^jJ z7o0gE>gNX+^{b}>gX>C*g!gtY%=x_qRPnb@P2N!6v{q(sa;l(USXyeB7>r6x4NFTE z6uhYyW>@m!La@JWXjYH?3+ei;2Kzp=OpT0mX_@*y>)ZSL@gkoOHnZ>l(5nCD#zy6T z9WPZPE&WWrbU&^;GXGHDd5evp@aYfOxo5)$P)nd>`^UL=&)WR?aCmacQ}uZji!`2D zi2wZa++P0foO$y=Hio^M`#rCA*7IxCE8l+Edb{%W+wA4HeQz?YeZEyrd(EN^4)cpD z-{0G-_)KE!zccA}!s}+un#I-bdxPWKzS`f5mcRVg%x^ct&+d^<%T!mFh@DoxSGT$T zy0`Y&TeoEI?W{lDUcZgro|n#V^6p;VU2p%>QJ>SldFCY5OiYp5z3=(F>O;2WHQTOF zo&9!l|LpLf+bj9)Pu{ls`5|PtX7qxud#)w7hKh*22-Z7((tS?ukrky@KY!eLZYM6A z4hp|_s!#Je+uE$9F9)5S|33D#>z|ivv+thIGua=0c$wntojZ3*Z0!@gTVwM3T;$G` zx3+n#zmsz(&tzLk^o0B^bw!__so!Mo-93K`xGwx@{99#>OnlBURAb-7!`^U8H@njX0O{ZbLnlV$c3WG;0j-m}hm>IHX0xZN4oKQGVn z@1B1*V_(qwS4CDocl`hNd-wBtaJ2AiO=XYRS<1W9^iu4`Ck=vc0*WHEvW^RcYE*8U zdE-&W{@}1Yk)yFfwpR~tUHk3O+dkFZY&)ve&zU79Ra*V*aD4Ms^wb(1rA@hOVstOo zDc@M$Em}793Oiq-`&$X|$ntl0X4)x?H>Gsl#xNa_aWTAD! zebbS**2Yb-nqd37VD^8Q^elZV=!mU%qdX<=fZw5wOkvFg+0Kv0pi?&rZ3 zD@5cg9yH$FUEaR*kdJ>_=hdu3iwoRwkDF_p-_T7Uw(3t>-VC+AnXvuf9kaDc4T) z-BeVwGx^V)1XX$4sxMDYPVN`qXXfqVlEQL%Ls85mpZdj_O>6)3=GQ#__4W0CbtNUE zLzxjjKh|yP@b;w&&4>cbX&lOb(x7VAx>9z_8}b zDF%j|om2I}BH&)a_1Tv7|7^6G88)PbotqjXVyw-~P_TV%&BsSaU&nG9e&7D-(U+xH zWwW!buZ1n2e%@#8yqV|aX4!Av_4v}KW82q%ubNiAZmsX!$S-2w5^Un;ANzg#M*X#A zdb-E=Z7JTlCEm5VczM*mIq%ZAOSZ{G-`lxs+PilVdu<-yW#3?%UVS#Et2yEHk>11E z2T%33n;kwid#hZJT(>dr*L8mK+3)OqPn#{>ZL#-O#pUPGr(3e67v=uky|v$T`bj_Q zOMaK)_HB@7I`C~{(d!qHkxSodOwtu*zqWGC#!zO_>HD|XOx9X*_4HZg(*0kjMBVD0 zes0O*(ruH}j-T6-y;5xTTX*f%+h2Vxxt4NVDm(A%ipyfP*Wx$YR_gD%ZlCb;)wfgE zm+xltef|FW{d-P#e^kvnEgrx0n74SC-rRdjzir6Bx3X>LW~ZIm1`Sgga~?-oT3f91 zi``|jcaMcn?`^9qWjg!AR&;H8{w>n~yYtzpYnJI|%HNs&DCh6GRC%CY*}_V?fNYi#$5t*DEB zeBE^V{5-Gig?g8+)F+CcI{z>%drm0B0hg$qFL%E5p1wS+`)iW_>~rSpY`16c*3%9@ zQIw(mT$eX8txsR>@8)m24nI5kbxPLvX|=PZ>?U_TyZX|Y`TG3pm$QRcueLs~bACG4 zoln13Pk(>+-s7*D<$G$s1>C$p@AiJr*OBw5KEFME@@e(5wR;Og*YYI1S-VH_e)Ha% z%2ff<+qXEVgFV)YWgSlfu^3C5636fBe~0ujRbHe*6CNxU6{Xx10Z+dir~NfBV$c zuWr>T-{}2z^vv$iu)Mcvr&1XnpL%z9_w(0FZ=ZTu5F=BVE8jYM@rBF;vs2Tr9=o`? zaz>t<-eZpH%B;21rfOd^UNZH%Wz*ec+nXnHlgloJq%D3k=~dA#!-QwW%gvsh=ZUJ{ z|8(`O*L?}=%X)0CZ~wGx?egSp;abJB^<&@Pj0@fNu0~cYeU;eiRrA_&*&B8roM&5o zEmr&ZMN2*P_;bswr>1>>B0N3pb7!pa&EqSUolChq<&vX~^t3fWQAew+)SFT#S9Ax@ z@tVAWYxAO{4cpy#uV>pHy&2K^Hj|h6iuRRHrR%=V_no$O|MgF`*Mh(PN|`RbDKcvH z+|66Ge&62AJ$uW%zQW%x@)Ha89amo*byxF?ZQQpT>u+u5=-&J!Lh?XGRHbw+e_8KM z9|ndEpXM%(2%DCz$-odH3C+7a5Ox?F1H&2~1_o_r28J*;hK8w(VD^Di3}ALbDpU}Y z0n&m{#=rn#gGz;jREWtSHppa&FoH=vmIyb0rPoFt^cCa=xgMm|6SuDigAYUFh z5%u%Y(eCTJi~jwo3}a(R;Ldu=Ev`3Z${G;owA+SaLv>Y9wXObk=G?iy zTV==8j>?DUMOtpFC@Xt+@%T3;27|nj5jk?&%naKmPEFoXVX{_6`q(LkhTL#%d*exg+RO|QGpD{+iMReG|Gxf% zXKWCq|cf?VRl)b|F=) zi&BHlKIv&pp30bDp}qg-#kaTR_s)zqd{-BB=Kr7T*P?#<$=q?jaH_Or?@Q^Erx*;B z!s6oM>?Rfcy7l(v&Mz65MMq9Z!}=cK^0a{X!3AHQ7qW%cgUUv|XSBt^ZsbNl_5TWxvT;^OD5 zZ~Wa|Rk`cS?q4OVcGS$hzHrO^C$?u-|12$+VKCqddnZ=Bbkgf6OTNDg8~?biJAY-; zo=LZt)_=XZHzF!}Qdm^_|EBdjcu#tMG}evZ5_0m?($?4g3Cmk|*N4yd6P^D4v(*yT zLkC}O)&2La#Cq%Z$e#!Lm>IOz&iU_p^swjQcK+?}%X$*-SH1tR?CH+u^SCAB_t)9h z9eaB!HR*6xZ-Tmci+WdU+Qurq*zUKbg4>HWhRA+f8MgcM!AC|r*Lmqqy{oAklg_fc z=xnXkRqx)Z`?suk_~)z6tR3f1v6sm(7;Kr^U2blz_;_{r`fov>1j796{I;#wQY0_= zB`_iGAD@i#xz(TJv~D?RU*BUCd-;^B`SqI;VQdYFYh~)M{s=fFy?;;b@9Ft6Rw1?D z*QuMWnKpH@%_r^yKNsI^UNP0|)Y0Ib5q50zs<(%4oy+w)PV3b53DZ_)KDFDwdjHhw z(pCLachA3M+cbCn+z`ID>u)ObZ!$Az`!`MXzFxcAec^9^3$M+Sy*AJBvO1sr@zJNH zrYwbvr%$~s^(i&$+VrLOui9qB$Z)QxNt%E0tJQkv)TuGESgxnP*thBN8Xkt)H8R(% zXKea(`cUhW=>Iz}ZTNKRpsx3&j}P(%Pi7|_Uc%6Da^t6trR%0%E(I0t8$Ml&mSkw? z+*tHS^)WLjg-)9)UC(#xHXFl?0I6BoX=P>KZl=$#eb_4Q=6iCZ=f=d1mAu;L&z?Pd z?p)<<28PM*9D0-1$e4e7b93{K9Tks`bWT>Dd}GFqB{w$w{Q2`gd&;WE{C_51S;)Y^ Oz~JfX=d#Wzp$PzRHmbz{ literal 0 HcmV?d00001 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 00000000000..82c69ff2a7a --- /dev/null +++ b/doc/src/howto/creator-only/creator-serialterminal.qdoc @@ -0,0 +1,82 @@ +/**************************************************************************** +** +** Copyright (C) 2019 Andre Hartmann +** 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 adc38a0cf3b..0f2925cee13 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 9cc50396568..e6c985d809c 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 08e894f9194..c98e36ce1a4 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 115e552bc90..a9fe97b89da 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 331a5a8091b..c849b71b669 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