home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / vrac / elda20.zip / ELDA.DOC < prev    next >
Text File  |  1994-08-06  |  14KB  |  356 lines
  1. ===========================================================
  2.  ELDA v2.0               (c)1994 Brian E. Kelly
  3. ===========================================================
  4.  
  5. Enhanced Line Diagnostics Analyser.  E.L.D.A.
  6.  
  7.  
  8. What it does:
  9. -------------
  10.  
  11. ELDA is a small program which sends commands to a modem
  12. to request diagnostic information about its last call. The
  13. data returned from the modem is then filtered and either
  14. displayed or written to a logging file.
  15.  
  16. Although originaly intended to be used with a Wildcat! BBS
  17. using US Robotics Dual Standard modems, it will work with
  18. almost all other BBS and compatible modem types. It can
  19. also be run as a stand-alone program or in conjunction with
  20. dial out communications programs.
  21.  
  22. Why I wrote it:
  23. ---------------
  24.  
  25. I run a multi-node Wildcat! BBS under OS/2. Sometimes I get
  26. complaints that the system is running slow or the predicted
  27. time for file downloads is inaccurate. I have not been able
  28. to replicate the problem myself and therefore have to assume
  29. that poor telephone lines are responsible. I use U.S.Robotics
  30. modems which have an "ARQ" indicator on their front panels
  31. and I note that sometimes this flickers while a user is
  32. connected. The flicker tells me that an error has been
  33. detected and is being corrected. These errors are hidden from
  34. the user because the modem asks for a block of data to be
  35. repeated and only passes it through its DTE connector when
  36. all the errors have been removed. However, this resending
  37. takes time and gives the user the impression that the BBS
  38. is running slower than it should. All USR modems have an
  39. in-built facility to report details of the last call by
  40. sending the ATI6 command to them. By sending this command
  41. and disecting the reply before the BBS resets the modem it
  42. is possible to see what really did happen during the call.
  43.  
  44. How to use it:
  45. --------------
  46.  
  47. The program expects to run at a DOS prompt, the prompt in
  48. an OS/2 DOS session or in a batch file. The syntax is:
  49.  
  50. ELDA <com port> <baud rate> <irq> <TERM _or_ logging file name>
  51.  
  52. All parameters must be provided but entering 0 for the baud
  53. rate or IRQ will not change the ports present settings.
  54. If a com port other than 1, 2, 3 or 4 is specified or an IRQ
  55. that is already in use, an error will be reported and the
  56. program will terminate.
  57.  
  58. The baud rate can be 300, 600, 1200, 2400, 4800, 9600, 19200
  59. 38400, 57600 or 115200. If a value of zero is entered, the
  60. divider register in the UART is left untouched and the port
  61. remains    at whatever speed it was previously used at. For BBS use,
  62. leave the value    at zero as the DTE speed should be kept locked
  63. anyway.
  64.  
  65. Any valid logging file name can be used. You can enter a full
  66. path and name or just the name itself. In no path is given,
  67. the file will be written in the current directory. The file is
  68. opened in 'append' mode so the log can be added to the end of
  69. an existing file. If the file doesn't exist it will be created.
  70. I give the name of the activity log for the Wildcat! nodes it
  71. runs on so the information is written after the call details.
  72. If you find the activity log becomes too large to handle, you
  73. can log to a different file. The date, time and port number
  74. are logged to allow matching against your activity log files.
  75.  
  76. DOS treats devices and files in the same way, if the log is
  77. written to "CON" it will appear on the screen. Specifying "PRN"
  78. will send it to the parallel printer port. Be very careful if
  79. you send it to a serial device, writing to the com port you
  80. are monitoring will cause a black hole to form and suck you in.
  81.  
  82. If the word "TERM" is entered instead of a file name, the
  83. program becomes a very simple ASCII terminal. This is to help
  84. when configuring the modem or checking its responses. I do not
  85. recommend using it to make outgoing calls via the modem, it
  86. may work but the risk is yours. You can exit from terminal
  87. mode by pressing the [Esc] key.
  88.  
  89. Examples: (taken from my own system )
  90. --------------------------------------
  91.  
  92. QM.BAT   (runs QmodemPro)
  93.  
  94.     @echo off        <- don't want to see all this
  95.     c:            <- QmodemPro is on C: drive
  96.     cd \qmpro        <- the QmodemPro home directory
  97.     qmpro /nologo %1    <- quick start
  98.     elda 2 38400 3 con    <- report to screen when finished
  99.  
  100.  
  101. POSTCALL.RUN (logs details after a Wildcat 4 BBS call)
  102.  
  103.     elda 1 38400 4 \wildcat\activity.1
  104.  
  105.  
  106. (there is a postcall.run in each nodes work directory, some use
  107.  non-standard IRQ lines so I specify all the parameters just for
  108.  consistency. You could also call it POSTCALL.BAT in the home
  109.  directory and use
  110.  
  111.  "elda %wcportid% 0 0 \wildcat\activity.%wcnodeid%"
  112.  
  113.  but you must specify the apropriate environment variables and
  114.  paths correctly if you do this)
  115.  
  116.  
  117. Modem types:
  118. ------------
  119.  
  120. Modems manufactured by US Robotics and Practical Peripherals
  121. both return connection details on request. Other manufacturers
  122. probably also do the same but each has their own way of quoting
  123. the results. I have provided two sample config files called
  124. USR.CFG and PPI.CFG, you must rename one of these to ELDA.CFG
  125. before running the program. You can have a different modem on
  126. each port but you must take care that the correct .CFG is used
  127. or the log file will be incomplete or incorrect.
  128.  
  129.  
  130. The Commands file, ELDA.CMD:
  131. ----------------------------
  132.  
  133. Is simply a file containing the command that make your modem
  134. reveal the last connection details. For USR and PPI modems the
  135. normal diagnostic command is ATI6. On the USR DS V34 ready
  136. model the command to return VFC information is ATI11. If your
  137. modem requires a different command you can change it with a
  138. text editor. Instructions are in the files header section.
  139.  
  140.  
  141. The Configuration file, ELDA.CFG:
  142. ---------------------------------
  143.  
  144. This is a text file containing all the parameters that can
  145. be returned by the modem. The file must be in the same
  146. directory as ELDA is executed from. On a Wildcat! system this
  147. will probably be the "wcwork\node*" directory for the node
  148. being logged. By using this location, a different configuration
  149. can be defined for each node.
  150.  
  151. Use any text editor to modify the the files contents. Any line
  152. starting with a ";" (semi-colon) is ignored, delete the ";" to
  153. make the line active. Only one parameter is allowed on each line.
  154. Note there are lines for "Equalisation" and "Equalization" as both
  155. spellings are used depending on the modems intended country
  156. of use. If new parameters are introduced in later models
  157. they can be added to the config file, there is no limit to the
  158. files length.
  159.  
  160. The special entry "[VFast]" is used to separate any response
  161. which is applicable to speeds of 21,600 bauds or faster. Lines
  162. following "[VFast]" are ignored unless a fast speed is reported
  163. by the modem.
  164.  
  165. The text in the config file must exactly match that which the modem
  166. reports. It is case sensitive and spaces between words are important.
  167.  
  168.  
  169. What you should get:
  170. --------------------
  171.  
  172. is something like this-
  173.  
  174.  
  175.  ┌---- Connection report from ELDA v2.0  on Sat Aug 06 00:17:11 1994  --─┐
  176.  │ Chars sent               247                                          │
  177.  │ Chars Received           179828                                       │
  178.  │ Chars lost               0                                            │
  179.  │ Octets sent              310                                          │
  180.  │ Octets Received          146657                                       │
  181.  │ Blocks sent              103                                          │
  182.  │ Blocks Received          2044                                         │
  183.  │ Blocks resent            0                                            │
  184.  │ Retrains Requested       0                                            │
  185.  │ Retrains Granted         0                                            │
  186.  │ Line Reversals           0                                            │
  187.  │ Blers                    2                                            │
  188.  │ Link Timeouts            0                                            │
  189.  │ Link Naks                0                                            │
  190.  │ Data Compression         V42BIS 2048/32                               │
  191.  │ Equalisation             Long                                         │
  192.  │ Equalization             Not Reported                                 │
  193.  │ Fallback                 Disabled                                     │
  194.  │ Protocol                 LAPM                                         │
  195.  │ Speed                    21600                                        │
  196.  │ Last Call                00:04:52                                     │
  197.  │ Disconnect Reason        is DISC Received                             │
  198.  │ Modulation               V.FC                                         │
  199.  │ Carrier Freq (Hz)        1920/1920                                    │
  200.  │ Symbol Rate              3200/3200                                    │
  201.  │ Trellis Code             32S-2D/32S-2D                                │
  202.  │ Nonlinear Encoding       OFF                                          │
  203.  │ Precoding                ON                                           │
  204.  │ Shaping                  OFF                                          │
  205.  │ Preemphasis (-dB)        7/4                                          │
  206.  │ Recv/Xmit Level (-dB)    35/18                                        │
  207.  │ Roundtrip Delay (msec)   18                                           │
  208.  └-------------------------------------------------------[Port 2]--------┘
  209.  
  210.  
  211. This is taken from an actual call and with all the lines in
  212. the config file active. The modem used was a USR Dual Standard
  213. V34 ready model. The call was in V.FC mode, be aware that some
  214. lines are meaningless unless in HST mode.
  215.  
  216. The report is probably much longer than you would ever need
  217. but editing the config file would of course make it smaller.
  218. The box closes after the "Disconnect Reason" line if V.FC isn't
  219. detected.
  220.  
  221. Exit codes and error messages:
  222. ------------------------------
  223.  
  224. ELDA displays help whenever it cannot run for some reason.
  225. It also sets the DOS errorlevel to a non-zero value if an
  226. error occurs. Zero errorlevel indicates normal operation.
  227.  
  228. Likely errors and messages are -
  229.  
  230. [1] Command line syntax was wrong.
  231. [2] There was an error opening the ELDA.CMD file.
  232. [3] There was an error opening the ELDA.CFG file.
  233. [4] The Log file could not be created or updated.
  234. [5] No "OK" from modem after 30 seconds after Link diag request.
  235. [6] No "OK" from modem after 30 seconds after Fast diag request.
  236. [7] An invalid speed was detected or specified in command line.
  237.  
  238. Other exit codes refer to internal problems with the com ports
  239. or UART chips, if you see them please report as many details as
  240. possible about your system so I can investigate. Unless you are
  241. using a 16550 UART I suggest you keep speeds down below 19200 or
  242. errors are inevitable, this is not a limitation of ELDA, it is
  243. a processing speed problem with PCs.
  244.  
  245.  
  246. Feedback:
  247. ---------
  248.  
  249. I hope you find ELDA meets your requirements. Suggestions for
  250. future versions are always welcomed.
  251.  
  252. I do not have access to    a PPI modem to try its version of config
  253. file so please let me know if it suffers problems. I am indebted
  254. to Ray Tackett for his help with the PPI responses.
  255.  
  256. I have tested the program and used it on my own BBS, it seems
  257. to run fine. If you find any bugs I would like to hear about
  258. them as quickly as possible. My BBS and CIS numbers are later
  259. in this text. I also monitor MSI supportnet and the US Robotics
  260. modem net but may take up to 7 days to get a reply back to you.
  261.  
  262.  
  263. Registration:
  264. -------------
  265.  
  266. Try it out and if you think it deserves some of your hard earned
  267. cash, send a small donation toward my BBS running costs.
  268.  
  269. I suggest $10, 5 UK pounds or its equivalent in your own currency.
  270.  
  271. I can accept cheques (checks) from UK banks only. For other
  272. currencies, put paper cash in an envelope and mail it to me. Make
  273. sure the contents can't be seen through    the envelope. I will try
  274. to confirm its arrival by Email if you give me a return address.
  275. If you make a donation it will also cover any future releases of
  276. the program.
  277.  
  278. I consider continual use without registration to be unethical and
  279. dishonest. If I catch you doing so, I will send a gremlin to crash
  280. your hard disk.
  281.  
  282.  
  283. Disclaimer:
  284. -----------
  285.  
  286. (sorry about this but I have to say it)
  287.  
  288. The program is released without warranty or guarantee of any
  289. kind. The author will not be held liable for damage caused by
  290. this program or as consequence of it being used on any system.
  291. It is released in good faith and is believed to be bug free.
  292.  
  293. Acknowledgements:
  294. -----------------
  295.  
  296. The program is written in Borland Turbo C++ version 3.0.
  297. Serial routines are from PCL4C by Marshallsoft Computing Inc.
  298.  
  299.  
  300. Future Plans:
  301. -------------
  302.  
  303. Logging Caller ID (ANI) would be rather neat but my local telco
  304. doesn't offer it so theres no way I could verify it worked.
  305. It would mean another section in the .CMD file to specify the
  306. "AT" command to report the callers number. If enough people
  307. ask for it I'll add code to support it.
  308.  
  309.  
  310. Contacting me:
  311. --------------
  312.  
  313. My BBS details are -
  314.  
  315. BetWiXt BBS. +44 1633 614765  (from the UK it is 01633 614765)
  316. U.S. Robotics Dual Standard V34/VF.C modems - 2 lines.
  317.  
  318. My CIS number is -  71141,2757
  319.  
  320. My mail address is -
  321.  
  322. Brian E. Kelly.
  323. 12 Cotswold Way
  324. Risca
  325. Gwent.  NP1 6QT
  326. United Kingdom.
  327.  
  328.  
  329.  
  330. BBS note:
  331. ---------
  332.  
  333. BetWiXt has been running since 1990. It started in Palatine, IL.
  334. but moved with me to South Wales, UK in 1991.
  335. It concentrates on programming files and utilities and has sections
  336. covering Ham radio and television. It is adopted by the B.A.T.C.
  337. (British Amateur Television Club.) to support their activities.
  338.  
  339. Limited access on the first call but full access is given within
  340. 48 hours subject to confirmation of log-in details.
  341.  
  342.  
  343. Release History:
  344. -------------------
  345.  
  346. V1.00    Released as USRATI6. Support for US Robotics modems only.
  347.     ( 3 July 1994 )
  348.  
  349. V2.00    Rewritten and released as Enhanced Line Diagnostic Analyser.
  350.     Added support for 115200 baud rate and non-standard IRQs.
  351.     V.FC / V34 functions added.
  352.     Support for PPI modems added.
  353.     Improved error trapping and reporting.
  354.     Faster operation at high DTE speeds and timeout bug fixed
  355.     at 300 baud. ( 29 July 1994 )
  356.