home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR10 / COMST11.ZIP / COMST11.EXE / COMSET11.DOC < prev    next >
Text File  |  1993-08-01  |  20KB  |  404 lines

  1.                   ___________________________________________
  2.                                   C O M S E T
  3.                             Modem / Uart Setup Program
  4.                         Version 11.0..release date 8/1/93
  5.                      from Hank Volpe Copyright 1987 - 1993
  6.                              BBS Phone: 410-256-3631
  7.                            Voice Phone: 410-256-5767
  8.                   ___________________________________________
  9.  
  10.                                   Introduction
  11.  
  12.     Comset is a utility that is designed to setup a communications port
  13.     and a AT (Hayes) Compatible smartmodem. Many modems, especially
  14.     internals, do not have a method to reset the modem when it is
  15.     activated, nor does an adequate method exist to setup the serial port
  16.     for use.
  17.  
  18.     Comset will setup your serial port to any speed from 300 to 57600 bps
  19.     and then check to see if your modem is on-line. If it isn't, Comset
  20.     will perform a hardware reset to "wake" it up. Next a software reset
  21.     is performed by sending the command ATZ. If the reply OK is received,
  22.     you are informed that the modem is fine. If OK is not received, Comset
  23.     will attempt 3 times to reset the modem before informing you of an
  24.     error. If you have an external modem and it is off, Comset will abort
  25.     after setting up the serial port to the desired baud rate.
  26.  
  27.  
  28.  
  29.        Comset Version 11.0 Documentation  copyright (c) 1993 by Hank Volpe
  30.                                      Page 2
  31.  
  32.     What's new in Version 11.0 ?
  33.     ---------------------------
  34.     
  35.     Version 11 adds the ability to use any IRQ selection from 2-7 for your
  36.     modem/uart combination. Also, the shareware version now returns error
  37.     levels to your batch files. 
  38.  
  39.     You can always download the latest version of Comset, plus get user
  40.     support on the Modem Doctor BBS (410-256-3631) 24 hrs a day. All
  41.     users, registered or shareware, are always welcome. Additionally,
  42.     you can find Comset on most national BBS systems.
  43.  
  44.     Comset attempts to answer your communication utility needs with a 
  45.     product that is more flexible and more powerful than simple 
  46.     Port testers or Port speed adjusting programs. With a top speed of 57.6k,
  47.     redirectable output to a file, and errorcodes returned to batch files.
  48.     Comset 11 also contains a new uart driver that works with all types of
  49.     PC-Compatible uart chips.
  50.  
  51.              Some of the features of Comset include the following ;
  52.                       Level 1 options...Shareware Version
  53.  
  54.            ** User Selected baud rates from 300 to 57600 bps.
  55.            ** User Selected Comm port assignments [1 to 4].
  56.            ** User Selected IRQ lines (2-7)  NEW !!!
  57.            ** Modem Status register testing.
  58.               - Comset tests the registers for DTR/RTS and Carrier Detect
  59.            ** Redirectable output..can be sent to a file for logging.
  60.               or used over any serial link.
  61.            ** RTS/CTS DTR/DSR Handshake testing.
  62.            ** Ability to setup the UART alone for dumb modems or
  63.               other serial devices up to 57.6K baud
  64.            ** "s" switch allows you to swap any comm pointers in memory
  65.            ** "p" switch allows you to see your comm address assignments
  66.            ** Log in of Comm ports 3 & 4 to DOS for use by other programs
  67.               such as high level languages or applications.
  68.            ** Ability to set a uart up and raise control lines without
  69.               the need for an active serial device or modem.
  70.  
  71.            Registered users have access to this special feature;
  72.            ** Ability to send custom Hayes command strings to the modem
  73.              using a simple ASCII text file
  74.  
  75.        Comset Version 11.0 Documentation  copyright (c) 1993 by Hank Volpe
  76.                                      Page 3
  77.  
  78.                                 I. USING COMSET
  79.                                 ----------------
  80.  
  81.                     The usage syntax for Comset is simple.
  82.  
  83.                              COMSET [speed] [port] U
  84.                                        or
  85.                              COMSET [speed] [port]
  86.                                        or
  87.                              COMSET [speed] [port,irq]
  88.                                        or
  89.                                     COMSET h
  90.                                        or
  91.                                     COMSET i
  92.                                        or
  93.                                     COMSET p
  94.                                        or
  95.                             COMSET s  [port] [port]
  96.  
  97.                   [speed] and [port] are user options
  98.                   [speed] and [port,irq] are also user options
  99.                    u tells Comset to set the UART only
  100.                    h invokes runtime help for the user
  101.                    i shows you revision and program information
  102.                    p peeks at your comm port memory address assignments
  103.                    s swaps the memory address assignments between the
  104.                      first port you entered and the second.
  105.  
  106.     Comset is easy to use. Typing COMSET from the dos prompt will
  107.     automatically attempt to set up serial port Com1 to 2400 bps and
  108.     attempt to wake up its modem. Selecting a different speed involves
  109.     only adding the speed after the word Comset...ie COMSET 1200 sets
  110.     serial port COM1 to 1200 bps instead of the default 2400. Trailing
  111.     zeros are not necessary, so you could also type COMSET 12 to set up
  112.     serial port COM1 to 1200 bps. If you wish to use a different serial
  113.     port, add that after the speed...ie COMSET 24 2 will set serial port
  114.     Com2 to 2400 bps. If you accidentally enter an invalid baud rate, the
  115.     default of 2400 bps will be used. If you accidentally enter an invalid
  116.     range of comm ports, the default of COM1 will be used. Defaults are
  117.     always used if the user does not supply speed and port. Typing  a U
  118.     after any option instructs Comset to setup the  serial port only and
  119.     not to look for a modem.  This is handy for setting up  serial
  120.     printers or other dumb devices to speeds  higher than 9600 baud.
  121.     Mode.com from dos will do the same, but not at  57600 baud, and not
  122.     on all machines!.
  123.  
  124.     Typing Comset 2400 3,5 will set port 3 using IRQ 5 to 2400 bps. It
  125.     is important to use the comma (,) between the port and the IRQ line.
  126.     Valid IRQ assignments are between 2-7. If you don't include one, Comset
  127.     automatically defaults to PC industry standard selections.
  128.  
  129.        Comset Version 11.0 Documentation  copyright (c) 1993 by Hank Volpe
  130.                                      Page 4
  131.  
  132.     Typing Comset p will display all of the comm port addresses logged
  133.     into Dos. This can be handy when you are trying to configure a serial
  134.     card for proper addresses.
  135.  
  136.     Typing Comset s will swap the address assignments in memory of com1
  137.     and com2. If you entered comset s 1 4, then the address assignments
  138.     will be swapped between com1 and com4 instead of com1 and com2. Any
  139.     valid port from 1 to 4 can be used.
  140.  
  141.     Typing COMSET h will bring up a runtime summary of features and other
  142.     helpful information. Ideally, Comset should be run out of your
  143.     autoexec.bat file when you  first turn on your computer. Internal
  144.     modem users can appreciate the fact that probably 2 or 3 times out of
  145.     a 100 their internal modem does not "wake-up" properly when the
  146.     computer is first turned on, and this can hang-up some communications
  147.     programs. Also, BBS sysops sometimes experience problems with modems
  148.     when stopping the BBS and trying to use the modem to call out.  This
  149.     is why Comset was written!
  150.  
  151.                          II. SERIAL PORT INFORMATION
  152.                          ---------------------------
  153.  
  154.     Comset supports all the industry standard Serial Port address
  155.     assignments for modems.  Almost all PC-modems allow you to use COM1-4,
  156.     however only specific software  can use COM3 or COM4 on most machines.
  157.     Comset will not only use COM3 and COM4 itself, but it will log those
  158.     ports into DOS for use by other programs such as high-level languages
  159.     and applications (something that under normal conditions can't be done
  160.     with an IBM-PC or most clones without special software). Using the new
  161.     "s" feature, you can also swap COM3 to COM1's address for those
  162.     programs that cannot access a COM3 or COM4. Using the "p" feature, you
  163.     can find out what serial port assignments your computer is using.
  164.  
  165.  
  166.                         III ERROR REPORTING INFORMATION
  167.                         -------------------------------
  168.  
  169.     Comset checks your serial port in three distinct steps;
  170.     1) Set the Serial Port computer UART to the desired baud rate and
  171.     raise the DTR and RTS lines. If a serial port is not detected, Comset 
  172.     aborts and displays the message that there is no serial port with that 
  173.     COMM designation your system.
  174.     
  175.     2) Check that DSR and CTS are returning from the modem, if not report 
  176.     an error and stop testing.
  177.         
  178.     3 a)If steps 1 & 2 are successful, wake up the modem by sending the 
  179.     command string "ATZ". If OK is received, report all is  Normal and 
  180.     leave the RTS and DTR lines active.
  181.        Comset Version 11.0 Documentation  copyright (c) 1993 by Hank Volpe
  182.                                      Page 5
  183.         
  184.       b)If the modem did not wake up, issue a more advanced hardware and
  185.     software command string to reset and wake up the modem. Three attempts 
  186.     are made..if it fails, the RTS and DTR lines are turned off. This 
  187.     could happen
  188.     
  189.     if you tell Comset to test a serial port that does not have a 
  190.     compatible modem attached. In that case, a "failure" of this kind 
  191.     would be "normal" for your system.
  192.             
  193.     You can redirect the output of Comset to a file if you wish to 
  194.     maintain a log of each initialization. To do this, just use the 
  195.     command string;
  196.     
  197.                 COMSET [speed] [port] >> comset.log
  198.     
  199.     Speed and port are optional. The >> symbol tells dos to make a file  
  200.     called comset.log and append it each time Comset is run.
  201.     
  202.                             IV USING ERRORLEVELS
  203.                             --------------------
  204.  
  205.     Starting with Version 11, all users of Comset can work with the
  206.     error-code reporting feature. Error code reporting simply stated passes
  207.     "result-codes" from Comset to its calling program. This allows you to write 
  208.     some advanced batch-file procedures or to take specific actions.
  209.     This error-code information can be interpreted by Dos Batch files using 
  210.     the ERRORLEVEL function. Under normal conditions, a result code of 0 is 
  211.     returned to the calling program. If something wrong is detected, an 
  212.     error code of 99 is returned to the calling program. 
  213.       
  214.     A simple use of this can be to start a communications program if the 
  215.     modem is ok, but if not, default to some other action...an example 
  216.     batch-file program looks like this;
  217.          
  218.         echo off
  219.         comset 24 1
  220.          IF ERRORLEVEL 99 goto stop
  221.         echo passed
  222.         goto exit
  223.         :stop
  224.         echo failed!
  225.         :exit
  226.         
  227.     Other uses are left up to your imagination...you could flash up help 
  228.     screens to the user like "HEY DUMMY...TURN ON THE MODEM!!!" or 
  229.     something similar. Combined with redirecting the output to a logging 
  230.     file, you could trace a history of failures or other actions.
  231.        Comset Version 11.0 Documentation  copyright (c) 1993 by Hank Volpe
  232.                                      Page 6
  233.  
  234.     The registered version of Comset has the ability to send custom setup 
  235.     strings to your modem from a simple text file. To use this feature, 
  236.     all you need to do is the following;
  237.     
  238.          1) Make a file with valid AT commands using edlin or any ASCII
  239.              text editor and name the file Comset.cmd
  240.     
  241.           2) Place this file in the same directory that you are running
  242.              comset out of. If you are running Comset from a path, then
  243.              you must have a Comset.cmd file in the directory you are
  244.              currently in for this feature to work. The reason for this
  245.              is  so  that  you  could have multiple  comset.cmd files
  246.              in different directories for different uses.
  247.    
  248.     When  Comset starts,  it will look for Comset.cmd in  the  current 
  249.     default directory,  and if it finds it,  it will send that command 
  250.     string to the modem instead of the ATZ command. An example of such a 
  251.     command set is the following;
  252.     
  253.         From dos, type edlin comset.cmd
  254.         when edlin starts, type I for insert.
  255.         Next, type AT M0 H1 then return
  256.         Next, type control-Z
  257.         Next, type e and the file will save.
  258.     
  259.     The next time you run comset, it will find the file comset.cmd and 
  260.     tell the modem to shut off the speaker and go off-hook.
  261.     
  262.     Any valid AT command set for your brand of modem can be sent.  The 
  263.     only restriction is that all these commands fit on one line and  the
  264.     first two letters must be AT. 
  265.     
  266.     You  can  also redirect the output of this function to a  file  as 
  267.     explained above. Users of Modems can use this to capture the settings 
  268.     of their modem and save it in text form for future reference.
  269.  
  270.  
  271.        Comset Version 11.0 Documentation  copyright (c) 1993 by Hank Volpe
  272.                                      Page 7
  273.  
  274.                           V. REGISTRATION INFORMATION
  275.                            --------------------------
  276.     
  277.     You can freely make copies and distribute the shareware version of 
  278.     Comset over BBS systems or  public domain libraries as long as no fee 
  279.     for Comset is charged  (except duplication costs) and as long as 
  280.     Comset.exe is distributed along with this file Comset.doc. These may 
  281.     be archived together for use on a bbs system. Under no circumstances 
  282.     can the registered version of Comset be distributed. Each version 
  283.     displays "shareware" or "registered" when it is run from the dos 
  284.     prompt.
  285.         
  286.     Comset is copyrighted by Hank Volpe and is not public domain software.
  287.     Shareware version users are granted a limited license for its use. No 
  288.     warranties for Comset are stated, expressed or implied.
  289.         
  290.     Shareware authors continually provide computer users with low priced  
  291.     software compared to the traditional retail approach. If you register  
  292.     Comset, you will be able to use all the custom command file feature
  293.     which I think you'll find very handy.
  294.         
  295.     Registration is simple...and price is low. Comset is only $10, which  
  296.     includes the latest version and free maintenance updates. To register, 
  297.     send $10 along with your name and address to;
  298.         
  299.                                   Hank Volpe
  300.                                  PO Box 43214
  301.                                Baltimore MD 21236
  302.     
  303.  
  304.        Comset Version 11.0 Documentation  copyright (c) 1992 by Hank Volpe
  305.                                      Page 8
  306.     
  307.     
  308.                                    VI. ERROR MESSAGES
  309.     
  310.     THERE IS NO COMx IN YOUR SYSTEM -
  311.           Comset was instructed by the user to test a non-existent comm
  312.           port. This could happen automatically if you don't have a COM1
  313.           in your system. If this is the case, use the line
  314.           COMSET [speed] [port] to select your specific needs.
  315.       
  316.     
  317.     MODEM NOT RESPONDING PROPERLY -
  318.           The modem under test did not set up even after 3 extensive
  319.           hardware and software attempts to do so. Either you have a non-
  320.           compatible or non-intelligent modem, or you are using the wrong
  321.           opening baud rate. Comset's defaults are 2400 bps and COM1. If
  322.           you only  have a 1200 or 300 bps modem, use the line
  323.           COMSET [speed] [port] and use a lower speed. Valid speeds are
  324.           300 bps,  1200 bps , 2400 bps [default], 4800 bps, 9600 bps,
  325.           19200 bps, 38400 bps, and 57600 bps. Trailing zeros are not 
  326.           necessary..ie 576 is 57600 bps. Any other values default
  327.           automatically to 2400 bps.
  328.    
  329.     MODEM APPEARS TO BE OFF OR DISCONNECTED -
  330.          The hardware handshaking pairs RTS/CTS or DTR/DSR are not 
  331.          communicating properly. This should NEVER happen on internal
  332.          modems unless the CTS signal is not enabled. Internal Modems
  333.          usually keep this signal at a logic 1, so if you see this error,
  334.          check your internal modem for proper strapping of the CTS and DSR
  335.          signals.
  336.         
  337.          If you have an external modem,and the power for the modem is on,
  338.          you will see this error message if you do not have the CTS signal
  339.          at a logic 1 or you have a defective or inadequate Serial Cable.
  340.          Most external modems have Dip-switches on the back for setting
  341.          the CTS signal. Normally the CTS follows the Serial Ports RTS and
  342.          the modem  DSR (sometimes called MR) follows the Serial Ports
  343.          DTR.
  344.         
  345.          In the case of an external modem you will see this error message
  346.          every time the modem has not been turned on. This is telling you
  347.          that your serial port hardware is fine, just that your modem is
  348.          off.
  349.  
  350.        Comset Version 11.0 Documentation  copyright (c) 1993 by Hank Volpe
  351.                                      Page 9
  352.  
  353.                             VII COMSET PROGRAM HISTORY
  354.                            --------------------------
  355.  
  356.         Version 1 - Simple Assy program fixed at 300 bps. Two versions
  357.                     COM1 and COM2.
  358.  
  359.         Version 2 - Baud rate raised to 1200 bps.
  360.  
  361.         Version 3 - Baud rate raised to 2400 bps.
  362.  
  363.         Version 4 - COM1 / COM2 support in one program.
  364.  
  365.         Version 5 - Major rewrite, added interrupt support, hardware
  366.                     and software testing, COM 1-4 support, Multiple
  367.                     baud rate support, error checking and reporting,
  368.                     and support for high speed modems to 19200 bps.
  369.  
  370.         Version 6 - This version adds the U parameter to allow for testing
  371.                     and setup of dumb modems and other serial devices.
  372.                     The registered version adds the ability to send a
  373.                     custom command string from a file named comset.cmd
  374.                     to the modem in place of the normal ATZ command
  375.  
  376.         Version 7 - This version adds baud rates to 38.4K,improved Uart
  377.                     communications module.
  378.  
  379.         Version 8 - This version adds speeds to 56K baud, improved
  380.                     Uart communications module, addition of the
  381.                     comm port swap and comm address features
  382.  
  383.         Version 9 - Improves speed of routines, adds the ability for
  384.                     uart only setups not to require an active device,
  385.                     changes the top speed description to 57.6k, and
  386.                     adds a test to verify the baud rate register set
  387.                     to the desired baud rate
  388.  
  389.         Version 10- Supresses extra line feeds sent by some modems,
  390.                     shortens the sign-on banner, changes timing routines
  391.                     that properly read all data from the modem when running
  392.                     custom commands that take a long time to process..ie
  393.                     a long status report sent at 300 baud could take longer
  394.                     than 15 seconds, now the timer is reset to 0 each time
  395.                     a character is received. Includes the new Uart driver
  396.                     module used in Modem Doctor and Zboot.
  397.  
  398.         Version 11- Adds IRQ selection to the command line and allows
  399.                     the shareware version to return errorlevel codes
  400.  
  401.         Current Software release is Version 11.0
  402.  
  403.  
  404.