Initial revision

2000-02-07 10:38:55 +00:00
commit fdc6b051c9
846 changed files with 230218 additions and 0 deletions
--- a/doc/user/ctrl.htm
+++ b/doc/user/ctrl.htm
@ -0,0 +1,49 @@
+<HTML>
+<HEAD>
+<TITLE>Serial Port Direct Access</TITLE>
+</HEAD>
+<BODY>
+<H1>Serial Port Direct Access</H1>
+<P>
+ At SINQ serial devices are connected to a Macintosh computer. This Mac runs
+ a serial port server which allows to read and write data through TCP/IP 
+ sockets to a serial port connected to the Mac. This document describes a simple
+ interface for communicating with such serial devices. 
+</p>
+<H2>Invocation</H2>
+<P>
+ The interface to a serial device connected to a Mac is initialised with the
+ following command given at the Tcl prompt:<BR>
+<EM>Controller name computer port channel</EM><BR>
+This command opens a connection to the serial port on the Mac and
+ installs a new command in order to interact with it. The parameters:
+<UL>
+<LI>name: is the name of the new command to generate for the connection in Tcl.
+<LI> computer: is the computer name of the Macintosh.
+<LI> port: is the TCP/IP port number at which the Macintosh 
+ serial port server is is listening. Usually this is 4000.
+<LI>channel: is the number of the RS-232 port to connect to.
+</UL>
+<p>
+<H2>Usage</H2>
+<P>
+ Once the connection has been initialised name is available as a new command
+ in Tcl. Let us assume, MC as the name for the purpose of this description.
+  MC then can be used as follows:<BR>
+ <EM>MC -tmo value</EM><BR>
+  Configures the timeout for the connection to value. 
+  Value is in microseconds.<BR>
+  <EM>MC arg1 arg2 ..... argn</EM><BR>
+  Everything after MC is written to the serial port. The reply received from
+  the port is returned. 
+</p>
+
+<P>
+ All these commands can return errors. Mostly these refer to the wrong device
+ being specified on initialisation. The others are network problems.
+</P>
+
+
+
+</BODY>
+</HTML>