Symbian3/SDK/Source/GUID-35D49549-1F4D-583F-A45D-9B557A207DD2.dita
author Dominic Pinkman <dominic.pinkman@nokia.com>
Tue, 20 Jul 2010 12:00:49 +0100
changeset 13 48780e181b38
parent 7 51a74ef9ed63
permissions -rw-r--r--
Week 28 contribution of SDK documentation content. See release notes for details. Fixes bugs Bug 1897 and Bug 1522.

<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
<!-- This component and the accompanying materials are made available under the terms of the License 
"Eclipse Public License v1.0" which accompanies this distribution, 
and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
<!-- Initial Contributors:
    Nokia Corporation - initial contribution.
Contributors: 
-->
<!DOCTYPE concept
  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="GUID-35D49549-1F4D-583F-A45D-9B557A207DD2" xml:lang="en"><title>GlassTerm: glass teletype terminal</title><prolog><metadata><keywords/></metadata></prolog><conbody>
<section id="GUID-1D23EC68-021A-43E5-8584-28D8E85C0E62"><title>Download</title> <p>Click on the following link to download the example: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/zips/guid-e132f025-ded6-4ae4-8a4d-dc50d344b55b.zip" scope="external">GlassTerm.zip</xref></p>Download some additional
files required by the example: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/zips/guid-16f2a07d-2ace-4a32-b383-6f1352dfd72e.zip" scope="external">CommonFiles</xref><p>Click: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/guid-e132f025-ded6-4ae4-8a4d-dc50d344b55b.html" scope="peer">browse</xref> to view the example code. </p>View the
additional files: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/guid-16f2a07d-2ace-4a32-b383-6f1352dfd72e.html" scope="peer">browse</xref>. </section>
<section id="GUID-A2E5D50F-2DD3-4A5A-8433-13B8BADEB77B"><title>Description</title> <p>GlassTerm is a terminal application with configurable handshaking
that illustrates the use of the Serial Communications API. </p> </section>
<section id="GUID-5DDD6F0D-50FA-4887-A61F-2E6C8074E168"><title>Class
Summary</title><p><xref href="GUID-3B4E8ED5-72F7-3E51-B188-3C1045526DDF.dita"><apiname>RComm</apiname></xref>: serial port</p><p><xref href="GUID-6B3CA99B-ABF2-32EA-935D-23AE5AE2C306.dita"><apiname>RCommServ</apiname></xref>: Comms server</p><p><xref href="GUID-076DD315-CE3F-3640-BAB4-0FC51C906820.dita"><apiname>TCommCaps</apiname></xref>: serial port capabilities (in package buffer) </p><p><xref href="GUID-BF099B27-4E8A-3765-A6A8-DB88DB4F4F2E.dita"><apiname>TCommConfig</apiname></xref>: serial port configuration (in package buffer)  </p><p><xref href="GUID-E0B34F3E-D4C4-3232-B8B1-7DB35B454646.dita"><apiname>TRequestStatus</apiname></xref>: asynchronous request status </p><p><xref href="GUID-A6E4627A-A3AE-3B64-9E5C-710EE15C5595.dita"><apiname>TSerialInfo</apiname></xref>: serial protocol information </p></section>
<section id="GUID-2925258F-CF25-46F7-B6B6-761615C7526B"><title>Build</title> <p>The source code for this example application can be found in
the directory: </p> <p> <filepath>examples\SerialComms\ServerClientSide\GlassTerm</filepath>  </p> <p>The source code may be in the directory in which you installed
the Symbian platform, or it may be in <filepath>src\common\developerlibrary\</filepath>. The source code includes the two project files needed for building
the example: <filepath>bld.inf</filepath> and the <filepath>.mmp</filepath> file. </p> <p>The Symbian build process describes how to build this
application, which results in an executable called <filepath>\epoc32\release\&lt;target&gt;\&lt;urel
or udeb&gt;\GLASSTERM.EXE</filepath>. </p> </section>
<section id="GUID-13E2D7B4-19BD-4EF5-BD11-96858ED96A9C"><title>Usage</title> <ol id="GUID-1DB8E591-3818-51E6-BDE0-89FFE8B6F96A">
<li id="GUID-A399AF4D-E821-5341-9645-B7F0FA42B76A"><p>Run the executable <filepath>GLASSTERM.EXE</filepath>. </p> <p>Executables for the emulator targets <filepath>wins</filepath> and <filepath>winscw</filepath> can be run on your
PC. Executables for ARM targets must be copied to your target platform
before being run. </p> </li>
<li id="GUID-BD9D8050-474C-5FD0-8485-08CED5D8AEEF"><p>Once running,
the glass teletype application performs two simple functions: </p> <ul>
<li id="GUID-3384ABA3-13A8-57F7-BE4F-7CC322BDA464"><p>Read any key
presses and send the characters to the serial port. </p> </li>
<li id="GUID-A44E9991-D87A-5E20-BC01-91454379BFF8"><p>Receive any
incoming characters from the serial port and display them on screen. </p> </li>
</ul> <p>It sends and receives at 19200 baud, 8 data bits, no parity,
1 stop bit. </p> </li>
</ol> <p>In order to see the application working, you must make a
suitable serial port connection. A simple way is to connect a PC and
a Symbian device, and run the application on both machines simultaneously.
(Before doing this, make sure to close down any other applications
using the serial port on the PC, and set the device's <systemoutput>Link To Desktop</systemoutput> option to <systemoutput>Off</systemoutput>). Characters typed on one machine are then echoed to the application
on the other. </p> </section>
</conbody></concept>