home *** CD-ROM | disk | FTP | other *** search
/ Share Gallery 1 / share_gal_1.zip / share_gal_1 / CO / CO032.ZIP / SPM.DOC < prev    next >
Text File  |  1991-07-17  |  13KB  |  367 lines
  1.  
  2.  
  3.           SPM.DOC    Copyright (c) 1991 Information Technology, Ltd.
  4.  
  5.  
  6.  
  7.           What is LiteSPM?
  8.           ---------------
  9.  
  10.           LiteSPM(tm), or SPM for short, is a background(TSR) Serial Port
  11.           Monitor. Once started, it sits quietly in the background, and
  12.           listens to one of the system's serial ports. SPM writes the
  13.           information that it receives to a disk file at either intervals
  14.           you choose, or at a predefined, by SPM, point, whichever comes
  15.           first.
  16.  
  17.           Why Use LiteSPM?
  18.           ----------------
  19.  
  20.           We originally designed LiteSPM for use with the newer generation
  21.           of telephone systems. Many telephone systems in use today have a
  22.           provision for periodically sending data to a serial (RS232)
  23.           device. Frequently, a standard printer records this information.
  24.           At some later time, the printed information will be entered into
  25.           a computer for the purposes of analysis and billing.
  26.  
  27.           With SPM you can bypass the data entry step. SPM records the
  28.           information directly on your disk, but doesn't tie up your
  29.           system. The result is a saving in both time and money.
  30.  
  31.           SPM has other uses. Since SPM will record anything, it can
  32.           monitor and record any type of serial information. The
  33.           information does not have to be ASCII characters. And SPM does
  34.           not interpret or alter the data it receives in any way. It can
  35.           monitor and record information from laboratory systems,
  36.           manufacturing equipment, scales, or anything, in fact, that can
  37.           produce serial (RS232) output.
  38.  
  39.           IMPORTANT NOTE:
  40.           ----------------
  41.           The above does not apply to modems. In general, modems require
  42.           special initialization sequences to function properly. Modem
  43.           support MAY be added in a future version of SPM.
  44.  
  45.           What Is Required?
  46.           -----------------
  47.           SPM requires about 24K of free memory and 1 serial port and at
  48.           least MS-DOS 2.1, nothing more, nothing less. If you are
  49.           fortunate and have MS-DOS 5.XX, you may load SPM into upper
  50.           memory. See your MS-DOS documentation for details on the LOADHIGH
  51.           command.
  52.  
  53.           SPM is flexible as well. You can configure SPM using command line
  54.           switches, selecting the serial port, baud rate, parity, end of
  55.           line characters, and path name of the file that SPM should use.
  56.           Once SPM is running, you can instruct SPM to rename its file so
  57.           that you can process it. Of course, SPM can be unloaded on
  58.           command.
  59.  
  60.           Installation Instructions
  61.  
  62.                                      Page 1
  63.  
  64.           SPM.DOC    Copyright (c) 1991 Information Technology, Ltd.
  65.  
  66.  
  67.  
  68.           -------------------------
  69.           You may install SPM by copying the file SPM.EXE into any
  70.           directory on your system's disk. We recommend that you place SPM
  71.           in a directory that is usually on the DOS path, but that is not a
  72.           requirement, it will just make your life somewhat easier. Once
  73.           you have copied SPM.EXE, you are ready to go.
  74.  
  75.           Starting SPM
  76.           ------------
  77.           To use SPM, you may simply type
  78.  
  79.                     SPM
  80.  
  81.           to start SPM with its default parameters. Normally, however, you
  82.           will want to change one or more of these parameters. The command
  83.           line switches to do this are described below.
  84.  
  85.           The more general form of the SPM command is
  86.  
  87.                SPM -cn -bnnnn -pX -eXXX -hX -fXXXXXXXXXXXXXXX | -u
  88.  
  89.           where:
  90.  
  91.  
  92.                  -a      turns on the optional alert signal. As each log
  93.                     record is written, a tone is sounded. Once activated,
  94.                     the alert signal can only be deactivated by unloading
  95.                     and reloading SPM.
  96.                  -cn     specifies the COM port SPM is to monitor, values
  97.                     of n may range from 1 to 4. If you intend to use COM3
  98.                     or COM4, please see the information about these ports
  99.                     below.  The default value is 1.
  100.  
  101.  
  102.                  -bnnnn  specifies the baud rate SPM is to use. The rate
  103.                     may range from 300 to 9600. The default value is 2400.
  104.  
  105.  
  106.                  -pX     specifies the parity of the data that SPM will
  107.                     monitor. Values of X may be E - even parity, O - odd
  108.                     parity, or N - no parity.  The default value is N.
  109.  
  110.                  -eXXX   defines the character string that SPM is recognize
  111.                     as the end of a record. By default, SPM recognizes
  112.                     CR-LF as the end of record. To specify a new end of
  113.                     record string, use the -e switch followed by up to 6
  114.                     characters enclosed in quotes ("). Control characters
  115.                     are specified by using the common notation ^ followed
  116.                     by the ASCII character to be used.  To specify a CR,
  117.                     for example, you would use ^M. Control sequences like
  118.                     ^M count as a single character.
  119.  
  120.  
  121.  
  122.  
  123.                                      Page 2
  124.  
  125.           SPM.DOC    Copyright (c) 1991 Information Technology, Ltd.
  126.  
  127.  
  128.  
  129.                  -hX     specifies the type of handshaking that SPM is to
  130.                     use. By default, there is no handshaking. If you wish
  131.                     to use XON-XOFF handshaking, specify X. To use DSR/DTR
  132.                     handshaking specify D. To use RTS/CTS handshaking
  133.                     specify R. Note that to use handshaking, the device
  134.                     that SPM is monitoring must support handshaking.
  135.  
  136.  
  137.                  -fXXXXXXXXXXXX defines the full path name of the file
  138.                     into which SPM will place the information it captures.
  139.                     By default, the name of the file is SPM.LOG. SPM.LOG
  140.                     will be placed in the default directory in use when
  141.                     SPM was started. We STRONGLY recommend that you
  142.                     specify a full path name to avoid problems.
  143.  
  144.                  -u Unload SPM from memory. As with any TSR, SPM will only
  145.                     unload successfully if it is the last TSR in memory.
  146.  
  147.           Examples
  148.           --------
  149.  
  150.                     SPM -c1 -b1200
  151.  
  152.           This command starts SPM on COM1 using 1200 baud. All other
  153.           parameters are defaulted.
  154.  
  155.  
  156.                     SPM -c3
  157.  
  158.           This command starts SPM on COM3, with all parameters defaulted.
  159.           If you intend to use COM3 or COM4, please review the section on
  160.           COM3 and COM4.
  161.  
  162.  
  163.                SPM -c1 -fd:\logfiles\spm.log
  164.  
  165.           In this example, SPM will monitor COM1 at 2400 baud. The data
  166.           that SPM receives will be placed in SPM.LOG in the logfiles
  167.           directory on drive D.
  168.  
  169.  
  170.                SPM -c1 -e"^M"
  171.  
  172.           Start SPM on COM1. The end of line string is Ctrl-M (or Carriage
  173.           Return).
  174.  
  175.  
  176.                SPM -c2 -hr -f\logfiles\spm0630.log
  177.  
  178.           Here,  SPM is started on COM2.  The device that SPM is monitoring
  179.           recognizes RTS/CTS hardware flow control.  All data is placed in
  180.           the file spm0630.log in the logfiles directory of the current
  181.           drive.
  182.  
  183.  
  184.                                      Page 3
  185.  
  186.           SPM.DOC    Copyright (c) 1991 Information Technology, Ltd.
  187.  
  188.  
  189.  
  190.  
  191.  
  192.                SPM -fC:\logfiles\spm0630.old
  193.  
  194.           With SPM already running, the -f argument renames the existing
  195.           logfile to SPM0630.old. We specify the full path name in case the
  196.           logfile is in another working directory or on another drive. The
  197.           next time SPM needs to write data, a new log file with the
  198.           original path name will be created.
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.                                      Page 4
  246.  
  247.           SPM.DOC    Copyright (c) 1991 Information Technology, Ltd.
  248.  
  249.  
  250.  
  251.  
  252.                SPM -u
  253.  
  254.           Unload SPM when it is safe to do so. Flush any unwritten data to
  255.           the log file.
  256.  
  257.  
  258.           Using COM3 and COM4
  259.           -------------------
  260.  
  261.           SPM can be used with COM3 and COM4.  To do so successfully, your
  262.           serial ports must be setup so that the base port address of COM3
  263.           is 3e8H (2e8H for COM4); In addition, the COM3 interrupt must be
  264.           IRQ4 (IRQ3 for COM4). If your serial ports can be set to these
  265.           values, then you should have no difficulty using COM3 or COM4.
  266.  
  267.           Tips and Techniques
  268.           -------------------
  269.  
  270.           In general, the loading of SPM is best done in your system's
  271.           autoexec.bat file. If this is not convenient or not sufficiently
  272.           flexible, you may use another method to load SPM.
  273.  
  274.           If the data you are attempting to capture with SPM is
  275.           identifiable as discreet records, we STRONGLY urge you to use the
  276.           -e switch to define the characters that identify the end of the
  277.           record. While SPM will never loose information, including the -e
  278.           switch helps insure that SPM will place discreet records in the
  279.           log file. Put another way, when you use the -e switch correctly,
  280.           the log file should never contain partial records.
  281.  
  282.           SPM can survive in a network environment. In a network
  283.           environment, you may specify that the SPM log file be placed on a
  284.           network drive.
  285.  
  286.           DO NOT attempt to directly process the current SPM log file. We
  287.           have included the rename facility so that you can keep SPM
  288.           active, yet access the data in a convenient fashion.  Of course,
  289.           the simplest way to accomplish this is through the use of a .bat
  290.           file. Typically, the bat file would instruct SPM to rename the
  291.           log file, process the data, then delete the file. 
  292.  
  293.           DO specify the complete path name of the SPM log file when using
  294.           the -f pathname switch. This is particularly important when you
  295.           use the -f switch to rename the current log file.
  296.  
  297.           DO NOT delete the current SPM log file while SPM is active. While
  298.           you might do so successfully, on occasion, there is no way to
  299.           insure that SPM will not attempt to write to the file while you
  300.           are deleting it. If this should happen, the results are
  301.           unpredictable. At best there would be some data loss. At worst, a
  302.           system hang might result.
  303.  
  304.  
  305.  
  306.                                      Page 5
  307.  
  308.           SPM.DOC    Copyright (c) 1991 Information Technology, Ltd.
  309.  
  310.  
  311.  
  312.           DO pay attention to the hardware flow control signal restrictions
  313.           when you select either DTR/DSR or RTS/CTS flow control. LiteSPM
  314.           assumes that these signals are active HIGH signals. Check your
  315.           hardware reference carefully if you have difficulty that seems to
  316.           be related to hardware flow control.
  317.  
  318.           Serial port wiring can be one of the most difficult areas to
  319.           understand, since some equipment manufacturers have chosen to
  320.           bend the standards. If you plan to do a lot of work in this area,
  321.           we recommend that you acquire a good quality breakout box to help
  322.           you make the right connections. A breakout box will let you
  323.           monitor and experiment with the various RS232 signals quickly and
  324.           conveniently without spending time soldering unknown connections.
  325.           One such device that we use is the Blue Box 100, manufactured by
  326.           International Data Sciences, 7 Wellington Road, Lincoln, RI
  327.           02865. You can contact them at (401) 333-6200 for current pricing
  328.           and availability.
  329.  
  330.           Problems And Questions
  331.           ------------------------
  332.           If you are having difficulty using LiteSPM, and you are a
  333.           registered user, please feel free to contact us by telephone. If
  334.           you want to register LiteSPM, see the file REGISTER.DOC for
  335.           additional information. We will also respond to Electronic Mail
  336.           on Compuserve (ID 70166,1152) or GEnie (ID I.TECH). Finally, we
  337.           will be happy to respond to mail inquiries by conventional
  338.           first-class mail. Regrettably, we are not equipped for FAX
  339.           service at this time.
  340.  
  341.           And if you have special requirements for SPM, please feel free to
  342.           contact us as well.
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.                                      Page 6