home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / networks / mdfspc.zip / MDFSPC.TXT
Text File  |  1993-09-23  |  58KB  |  1,366 lines
  1.               How to write a MHS Modem Definition File
  2.                   Messaging Division, Novell, Inc.
  3.                            June 23, 1993
  4.  
  5.   This document is intended to provide documentation on how to write
  6. a Modem Definition File (MDF) for the MHS 2.x products, which includes
  7. NetWare Global MHS (GMHS). The intended audience is anyone who needs to
  8. use a modem with these products and no MDF is available for that modem.
  9.  
  10. Novell, Inc. makes no representations or warranties with respect
  11. to the contents or use of this manual, and specifically disclaims
  12. any express or implied warranties of merchantability or fitness for
  13. any particular purpose. Further, Novell, Inc. reserves the right
  14. to revise this manual and to make changes to its content, at any
  15. time, without obligation to notify any person or entity of such
  16. revisions or changes.
  17.  
  18. Further, Novell, Inc. makes no representations or warranties with
  19. respect to any NetWare software, and specifically disclaims any
  20. express or implied warranties of merchantability or fitness for any
  21. particular purpose. Further, Novell, Inc. reserves the right to
  22. make changes to any and all parts of NetWare software, at any time,
  23. without any obligation to notify any person or entity of such
  24. changes.
  25.  
  26. Trademarks
  27.  
  28. Novell, NetWare and the N design are registered trademarks and
  29. Global MHS, NetWare Global MHS, NetWare MHS, NetWare Remote MHS,
  30. and Remote MHS are trademarks of Novell, Inc.
  31.  
  32. Hayes is a registered trademark of Hayes Microcomputer Products,
  33. Inc.
  34.  
  35. Copyright (c) 1993 Novell, Inc. All rights reserved. No part of
  36. this publication may be reproduced, photocopied, stored on a
  37. retrieval system, or transmitted without the express written
  38. consent of the publisher.
  39.  
  40.  
  41. 1.0 Introduction
  42.  
  43.   The Message Handling System (MHS) is a set of products that pickup
  44. and deliver messages for users or applications or other messaging
  45. services. These MHS products can define MHS hosts and MHS users
  46. which can communicate with each other over phone lines, using
  47. asynchronous serial ports and modems.
  48.  
  49.   MHS uses asynchronous, RS-232C serial ports to connect to modems.
  50. GMHS uses the Asynchronous Input/Output (AIO) NLMs to control the
  51. serial ports; RMHS uses an internal serial driver. AIO serial ports
  52. can be COMx type ports or on intelligent multi-port serial adaptors;
  53. RMHS serial ports can be only COMx type ports. MHS uses an internal
  54. modem driver to control modems.
  55.  
  56.   MHS must configure, reset, initialize, dial, answer, connect, and
  57. hangup modems, both in dial up and leased line environments. Since
  58. there are many manufacturers and models of modems, with different
  59. features and command sets, MHS needs a mechanism for interfacing with
  60. each type of modem. This mechanism is the MDF and it works with the
  61. internal MHS modem driver to control each type of modem. Refer to
  62. section 2 for details on the MDF format and section 3 for details on
  63. MDF usage.
  64.  
  65.   Although each MHS product supplies a variety of MDFs for a variety
  66. of modem types, not all modem types can be defined by these supplied
  67. MDFs. Additional MDFs will have to be created by third parties, using
  68. this document and any ASCII-capable editor. Refer to appendix A for
  69. general guidelines on creating a MDF, appendices B-D for examples of
  70. MDFs, and appendices E-F for debugging MDFs.
  71.  
  72.  
  73. 2.0 Format
  74.  
  75.   A MDF is an ASCII file that defines a modem type using keywords
  76. and their values. A MDF keyword and its value is the definition of
  77. how MHS will control a modem for a specific task. There are 60
  78. pre-defined MDF keywords, some for defining modem capabilities,
  79. some for defining modem commands, and others for defining modem
  80. responses.
  81.  
  82.   A MDF keyword is a pre-defined ASCII string, with or without
  83. spaces, that begins each line in a MDF. An equal sign separates the
  84. MDF keyword from its value. A value can be a single character, word,
  85. number or it can be multiple characters, words, numbers or it can be
  86. nothing. Some characters, words, and numbers are pre-defined. A value
  87. is ended by carriage return, line feed(s).
  88.  
  89.   For single character or string values, ASCII control characters can
  90. be represented by special two character sequences. These sequences
  91. always begin with the ^ character, following the commonly used
  92. representation for ASCII control characters. For example, ^J is the
  93. representation for line feed and ^M is the representation for
  94. carriage return.
  95.  
  96.   There is no restriction on the order of MDF keywords in a MDF file.
  97. If the MDF keyword is irrelevant for defining how to control this
  98. modem type, the MDF keyword can be left out of the MDF. If the MDF
  99. keyword's default value already defines how to control this modem
  100. type, the MDF keyword can be left out of the MDF. MDF keywords, and
  101. pre-defined value strings, are treated as case insensitive. A
  102. semicolon as the first character of a line indicates that this line
  103. is a comment line and will be ignored.
  104.  
  105. 2.1. MDF DESCRIPTION
  106.  
  107.   This keyword is used to describe the modem(s) supported by this
  108. modem definition. The description is limited to 60 characters and
  109. there is no default description. Currently, the description is not
  110. used or displayed but should be included for documentation purposes.
  111.  
  112. 2.2. MDF TYPE
  113.  
  114.   This keyword is used to designate Hayes type command and response
  115. processing, i.e., send an ASCII command string and wait for a
  116. pre-defined ASCII response string. The default value is HAYES. This
  117. keyword is used to validate a MDF as compatible with an MHS product.
  118. If an incompatible type is found, MHS reports an error and will not
  119. use this MDF. Currently, the only compatible value is HAYES.
  120.  
  121.    Although MHS will use the default value if this keyword is not
  122. found in the MDF, this keyword should be included in each MDF as
  123. insurance against inappropriate behaviour by future versions of MHS
  124. products.
  125.  
  126.  
  127. 2.3. MDF VERSION
  128.  
  129.   This keyword is used to assign a version to a MDF. Its value can
  130. be from 1 to 65,535. The default value is currently 2. This keyword
  131. is used to validate a MDF as compatible with an MHS product. If
  132. an incompatible version is found, MHS reports an error and will not
  133. use this MDF. The compatible values for current MHS products are 1
  134. and 2; 1 was a beta version value that is no longer used.
  135.  
  136.    Although MHS will use the default value if this keyword is not
  137. found in the MDF, this keyword should be included in each MDF as
  138. insurance against inappropriate behaviour by future versions of MHS
  139. products.
  140.  
  141. 2.4. FLOW CONTROL
  142.  
  143.   This keyword is used to designate that this modem supports (or does
  144. not support) the standard RTS/CTS hardware signalling for flow control
  145. with this modem. Its value can be TRUE (support) or FALSE (not
  146. support). The default value is FALSE.
  147.  
  148.   During modem protocol connections (see below), data transfers can
  149. be temporarily disabled, by toggling CTS or RTS, to avoid data loss
  150. when buffers become full due to resending of corrupted data or
  151. expansion of compressed data. MHS enables flow control after receiving
  152. a modem CONNECTion response (see below) and before initiating a modem
  153. hangup (see below). MHS disables flow control while sending modem
  154. commands and receiving modem responses.
  155.  
  156. 2.5. MODEM SPEEDS
  157.  
  158.   This keyword is used to specify the modem speeds that can be used
  159. with this modem. It is used during configuration of a MHS product
  160. to check for errors, e.g., a 2400 bps modem should not be configured
  161. for 9600 bps. Each speed must be separated by a comma. The default
  162. is 300, 1200, 2400, 9600.
  163.  
  164.   There is no restriction on the order of speeds. If an unsupported
  165. speed is found, MHS reports an error, stops processing the speed
  166. values, but retains the already processed speeds. The supported
  167. speeds are 300, 1200, 2400, 9600, and 14400.
  168.  
  169. 2.6. MAX SPEED
  170.  
  171.   This keyword is used to specify the maximum serial port speed
  172. that will be attempted when communicating to this modem. Its value
  173. can be any serial speed, from 50 to 115200. It is also used during
  174. configuration of a MHS product to check for errors, e.g., older 2400
  175. bps modems may not support speeds higher than 2400. The default value
  176. is 2400.
  177.  
  178.   If no serial speed is specified during configuration, MHS will
  179. use either this value or the highest serial speed supported by the
  180. driver/hardware attached to this modem, whichever is smaller. For
  181. modem protocol connections (see below), it is important to have the
  182. serial speed greater than the modem speed, for better throughput.
  183.  
  184.  
  185. 2.7. ADJUST SPEED
  186.  
  187.   This keyword is used to designate that this modem supports (or
  188. does not support) the adjustment of the serial speed after the modem
  189. CONNECTion response. Its value can be TRUE (support) or FALSE (not
  190. support). The default value is TRUE.
  191.  
  192.   However, if the PROTOCOL ON keyword is specified and used, this
  193. keyword is ignored because the serial speed is assumed to be fixed,
  194. i.e., the serial speed should not be changed after the modem
  195. CONNECTion response.
  196.  
  197. 2.8. COMMAND BEGIN
  198.  
  199.   This keyword is used to specify the beginning of command strings
  200. that are sent to this modem. Its value can be any sequence of ASCII
  201. characters, including control characters, with a total length not
  202. exceeding 10 characters. The default value is AT.
  203.  
  204. 2.9. COMMAND END
  205.  
  206.   This keyword is used to specify the end of command strings that
  207. are sent to this modem. Its value can be any sequence of ASCII
  208. characters, including control characters, with a total length not
  209. exceeding 2 characters. The default value is ^M, i.e., carriage
  210. return.
  211.  
  212. 2.10. MAX COMMAND
  213.  
  214.   This keyword is used to specify the length of the maximum command
  215. string that can be sent to this modem. This length does not include
  216. the COMMAND BEGIN and the COMMAND END strings. Its value can be from
  217. 1 to 255. The default value is 40.
  218.  
  219. 2.11. RESET
  220.  
  221.   This keyword is used to specify the command string, not including
  222. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  223. reset it. This command is sent prior to initialization and after
  224. hangup. Its value can be any sequence of ASCII characters, including
  225. control characters, with a total length not exceeding 40 characters.
  226. The default value is Z.
  227.  
  228. 2.12. RESET TIME
  229.  
  230.   This keyword is used to specify the amount of time, in seconds, to
  231. wait for a modem response after sending a RESET command. Its value
  232. can be from 3 to 30 seconds. The default value is 4 seconds.
  233.  
  234.  
  235. 2.13. INIT (first)
  236.  
  237.   This keyword is used to specify the command string, not including
  238. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  239. initialize it. No valid modem response is required. This command is
  240. sent after the RESET command. Its value can be any sequence of ASCII
  241. characters, including control characters, with a total length not
  242. exceeding 40 characters. The default value is
  243. EQV1X4S0=0S2=43S3=13S4=10S7=254S12=50.
  244.  
  245. 2.14. INIT (second)
  246.  
  247.   This keyword is used to specify the command string, not including
  248. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  249. continue initializing it. A valid modem response is required. This
  250. command is sent after the first INIT command. Its value can be any
  251. sequence of ASCII characters, including control characters, with a
  252. total length not exceeding 40 characters. There is no default value.
  253.  
  254.   If this modem does not require the serial speed to be adjusted
  255. after a modem CONNECTion response, i.e., ADJUST SPEED is FALSE, then
  256. the commands to maintain a fixed serial speed should be specified
  257. in the second or third INIT strings. For modem protocol connections
  258. (see below) and for mismatched speeds between modems, it is important
  259. to have the serial speed greater than the modem speed, for better
  260. throughput.
  261.  
  262. 2.15. INIT (third)
  263.  
  264.   This keyword is used to specify the command string, not including
  265. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  266. continue initializing it. A valid modem response is required. This
  267. command is sent after the second INIT command. Its value can be any
  268. sequence of ASCII characters, including control characters, with a
  269. total length not exceeding 40 characters. There is no default value.
  270.  
  271. 2.16. SPEAKER ON
  272.  
  273.   This keyword is used to specify the command string, not including
  274. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  275. turn the modem speaker on. No valid modem response is required. This
  276. command is sent after the last INIT command. Its value can be any
  277. sequence of ASCII characters, including control characters, with a
  278. total length not exceeding 40 characters. The default value is M1.
  279.  
  280. 2.17. SPEAKER OFF
  281.  
  282.   This keyword is used to specify the command string, not including
  283. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  284. turn the modem speaker off. No valid modem response is required. This
  285. command is sent after the last INIT command. Its value can be any
  286. sequence of ASCII characters, including control characters, with a
  287. total length not exceeding 40 characters. The default value is M.
  288.  
  289.  
  290. 2.18. PROTOCOL ON
  291.  
  292.   This keyword is used to specify the command string, not including
  293. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  294. attempt a modem protocol (error-control and data compression)
  295. connection. Modem protocol connections are only attempted if specified
  296. by the MHS configuration. The remote modem will also have to attempt a
  297. modem protocol connection for this modem to actually establish a modem
  298. protocol connection. No valid modem response is required.
  299.  
  300.   Its value can be any sequence of ASCII characters, including
  301. control characters, with a total length not exceeding 40 characters.
  302. There is no default value because not all modems support this type of
  303. functionality.
  304.  
  305. 2.19. PROTOCOL OFF
  306.  
  307.   This keyword is used to specify the command string, not including
  308. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  309. not attempt a modem protocol (error-control and data compression)
  310. connection. No valid modem response is required.
  311.  
  312.   Its value can be any sequence of ASCII characters, including
  313. control characters, with a total length not exceeding 40 characters.
  314. There is no default value because not all modems support this type
  315. of functionality.
  316.  
  317. 2.20. LEASED DIAL
  318.  
  319.   This keyword is used to specify the command string, not including
  320. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  321. select leased line, dial operation. The remote modem will have to
  322. select leased line, answer operation for this modem to go on-line.
  323. Leased line operation is only selected if specified by the MHS
  324. configuration. A valid modem response is required, eventually.
  325.  
  326.   Its value can be any sequence of ASCII characters, including
  327. control characters, with a total length not exceeding 40 characters.
  328. There is no default value because not all modems support this type
  329. of functionality. If this keyword is specified, the LEASED ANSWER
  330. keyword must also be specified.
  331.  
  332. 2.21. LEASED ANSWER
  333.  
  334.   This keyword is used to specify the command string, not including
  335. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  336. select leased line, answer operation. The remote modem will have to
  337. select leased line, dial operation for this modem to go on-line.
  338. Leased line operation is only selected if specified by the MHS
  339. configuration. A valid modem response is required, eventually.
  340.  
  341.   Its value can be any sequence of ASCII characters, including
  342. control characters, with a total length not exceeding 40 characters.
  343. There is no default value because not all modems support this type
  344. of functionality. If this keyword is specified, the LEASED DIAL
  345. keyword must also be specified.
  346.  
  347.  
  348. 2.22. LEASED EXTERNAL
  349.  
  350.   This keyword is used to designate that this modem does not require
  351. any modem commands to be sent to it to select leased line operation,
  352. i.e., this is done externally, usually with physical switches. Its
  353. value can be TRUE (external, don't send modem commands) or FALSE (not
  354. external, send modem commands). The default is FALSE.
  355.  
  356.   The LEASED DIAL and LEASED ANSWER keywords should still be
  357. specified, but with no values, to indicate that this modem supports
  358. leased line operation.
  359.  
  360. 2.23. LEASED RESPONSE
  361.  
  362.   This keyword is used to designate that this modem does not return
  363. any command responses when leased line operation is selected or when
  364. the modems have successfully made a leased line connection. Instead,
  365. a successful leased line connection is indicated by an active DCD
  366. signal. Its value can be TRUE (response expected) or FALSE (no
  367. response). The default is TRUE.
  368.  
  369.   The LEASED DIAL and LEASED ANSWER keywords should still be
  370. specified, but with no values, to indicate that this modem supports
  371. leased line operation.
  372.  
  373. 2.24. DIAL TONE
  374.  
  375.   This keyword is used to specify the command string, not including
  376. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  377. tone dial a telephone number. The telephone number is specified by
  378. the MHS configuration. Valid modem response(s) are required, ending
  379. with one of the CONNECT responses (see below).
  380.  
  381.   Its value can be any sequence of ASCII characters, including
  382. control characters, with a total length not exceeding 40 characters.
  383. The default value is DT.
  384.  
  385. 2.25. DIAL PULSE
  386.  
  387.   This keyword is used to specify the command string, not including
  388. the COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  389. pulse dial a telephone number. The telephone number is specified by
  390. the MHS configuration. Valid modem response(s) are required, ending
  391. with one of the CONNECT responses (see below).
  392.  
  393.   Its value can be any sequence of ASCII characters, including
  394. control characters, with a total length not exceeding 40 characters.
  395. The default value is DP.
  396.  
  397.  
  398. 2.26. DIAL ESCAPE
  399.  
  400.   This keyword is used to specify the character that will be added to
  401. the end of a DIAL TONE/PULSE command when breaking up a phone number
  402. that exceeds the MAX COMMAND length. It is placed at the end of a
  403. DIAL TONE/PULSE command string, just before the COMMAND END, to
  404. instruct this modem to return to the command state immediately after
  405. dialing, without breaking the connection. This allows for another
  406. command string to follow, with the remaining phone number.
  407.  
  408.   Its value can be any sequence of ASCII characters, including
  409. control characters, with a total length not exceeding 40 characters.
  410. The default value is a semicolon.
  411.  
  412. 2.27. DIAL 300
  413.  
  414.   This keyword is used to specify the command string, not including
  415. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  416. attempt to initiate a connection at 300 bps. A valid modem response
  417. is required. This command is sent before the DIAL TONE/PULSE
  418. commands.
  419.  
  420.   Its value can be any sequence of ASCII characters, including
  421. control characters, with a total length not exceeding 40 characters.
  422. There is no default value because not all modems support this type of
  423. functionality.
  424.  
  425. 2.28. DIAL 1200
  426.  
  427.   This keyword is used to specify the command string, not including
  428. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  429. attempt to initiate a connection at 1200 bps. A valid modem response
  430. is required. This command is sent before the DIAL TONE/PULSE
  431. commands.
  432.  
  433.   Its value can be any sequence of ASCII characters, including
  434. control characters, with a total length not exceeding 40 characters.
  435. There is no default value because not all modems support this type
  436. of functionality.
  437.  
  438. 2.29. DIAL 2400
  439.  
  440.   This keyword is used to specify the command string, not including
  441. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  442. attempt to initiate a connection at 2400 bps. A valid modem response
  443. is required. This command is sent before the DIAL TONE/PULSE
  444. commands.
  445.  
  446.   Its value can be any sequence of ASCII characters, including
  447. control characters, with a total length not exceeding 40 characters.
  448. There is no default value because not all modems support this type
  449. of functionality.
  450.  
  451.  
  452. 2.30. DIAL 9600
  453.  
  454.   This keyword is used to specify the command string, not including
  455. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  456. attempt to initiate a connection at 9600 bps. A valid modem response
  457. is required. This command is sent before the DIAL TONE/PULSE
  458. commands.
  459.  
  460.   Its value can be any sequence of ASCII characters, including
  461. control characters, with a total length not exceeding 40 characters.
  462. There is no default value because not all modems support this type
  463. of functionality.
  464.  
  465. 2.31. DIAL 14400
  466.  
  467.   This keyword is used to specify the command string, not including
  468. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  469. attempt to initiate a connection at 14400 bps. A valid modem response
  470. is required. This command is sent before the DIAL TONE/PULSE
  471. commands.
  472.  
  473.   Its value can be any sequence of ASCII characters, including
  474. control characters, with a total length not exceeding 40 characters.
  475. There is no default value because not all modems support this type
  476. of functionality.
  477.  
  478. 2.32. ANSWER
  479.  
  480.   This keyword is used to specify the command string, not including
  481. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  482. answer a telephone call. Valid modem response(s) are required, ending
  483. with one of the CONNECT responses (see below). This command is sent
  484. after receiving a RING response.
  485.  
  486.   Its value can be any sequence of ASCII characters, including
  487. control characters, with a total length not exceeding 40 characters.
  488. The default value is A.
  489.  
  490. 2.33. ESCAPE
  491.  
  492.   This keyword is used to specify the command string, not including
  493. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  494. return it to the command state. A valid modem response is not
  495. required. This command is sent before the HANGUP command.
  496.  
  497.   Its value can be any sequence of ASCII characters, including
  498. control characters, with a total length not exceeding 40 characters.
  499. The default value is +++.
  500.  
  501. 2.34. ESCAPE TIME
  502.  
  503.   This keyword is used to specify the amount of time, in seconds, to
  504. wait before and after sending the ESCAPE command. Its value can be
  505. from 1 to 30 seconds. The default value is 1 second.
  506.  
  507.  
  508. 2.35. HANGUP
  509.  
  510.   This keyword is used to specify the command string, not including
  511. COMMAND BEGIN and COMMAND END, that will be sent to this modem to
  512. hangup a telephone call. A valid modem response is not required. This
  513. command is sent after the ESCAPE command.
  514.  
  515.   Its value can be any sequence of ASCII characters, including
  516. control characters, with a total length not exceeding 40 characters.
  517. The default value is H.
  518.  
  519. 2.36. HANGUP TIME
  520.  
  521.   This keyword is used to specify the amount of time, in seconds, to
  522. wait for a modem response after sending a HANGUP command. Its value
  523. can be from 2 to 30 seconds. The default value is 10 seconds.
  524.  
  525. 2.37. DTR TIME
  526.  
  527.   This keyword is used to specify the amount of time, in seconds,
  528. to drop the DTR signal after sending the HANGUP command. Dropping the
  529. DTR signal, for the correct amount of time, is an attempt to add more
  530. reliability to modem hangup. Its value can be from 1 to 3 seconds.
  531. The default value is 2 second.
  532.  
  533. 2.38. VERBAL RESPONSE
  534.  
  535.   This keyword is used to designate that this modem will return
  536. command responses that are verbal versus numeric. Its value can be
  537. TRUE (verbal) or FALSE (numeric). The default value is TRUE.
  538.  
  539. 2.39. RESPONSE BEGIN
  540.  
  541.   This keyword is used to specify the beginning of command responses
  542. that are received from this modem. Its value can be any sequence of
  543. ASCII characters, including control characters, with a total length
  544. not exceeding 2 characters. The default value is ^M^J, i.e., carriage
  545. return and line feed.
  546.  
  547. 2.40. RESPONSE END
  548.  
  549.   This keyword is used to specify the end of command responses that
  550. are received from this modem. Its value can be any sequence of ASCII
  551. characters, including control characters, with a total length not
  552. exceeding 2 characters. The default value is ^M^J, i.e., carriage
  553. return and line feed.
  554.  
  555. 2.41. RESPONSE TIME
  556.  
  557.   This keyword is used to specify the amount of time, in seconds, to
  558. wait for a modem response after sending a command string. This is the
  559. default response time for commands that do not have pre-defined
  560. response time keywords. Its value can be from 2 to 30 seconds. The
  561. default value is 3 seconds.
  562.  
  563.  
  564. 2.42. OK
  565.  
  566.   This keyword is used to specify the command response that indicates
  567. that a command or command string was executed by this modem. This
  568. response will be the result of a successful RESET, INIT, PROTOCOL
  569. ON/OFF, DIAL ESCAPE, DIAL 300/1200/2400/9600/14400, or ESCAPE
  570. commands.
  571.  
  572.   Its value can be any sequence of ASCII characters, including
  573. control characters, with a total length not exceeding 25 characters.
  574. The default value is OK.
  575.  
  576. 2.43. RING
  577.  
  578.   This keyword is used to specify the command response that indicates
  579. that this modem has detected a ring signal. It will only be used
  580. after completing reset and all initializations, for non-leased line
  581. operations, when MHS is monitoring for incoming calls.
  582.  
  583.   Its value can be any sequence of ASCII characters, including
  584. control characters, with a total length not exceeding 25 characters.
  585. The default value is RING.
  586.  
  587. 2.44. RINGING
  588.  
  589.   This keyword is also used to specify the command response that
  590. indicates that this modem has detected a ring signal. However, unlike
  591. the RING command response above, this command response is ignored.
  592.  
  593.   Its value can be any sequence of ASCII characters, including
  594. control characters, with a total length not exceeding 25 characters.
  595. The default value is RINGING.
  596.  
  597. 2.45. NO CARRIER
  598.  
  599.   This keyword is used to specify the command response that indicates
  600. that no carrier signal was detected by this modem, or that the
  601. carrier signal was lost. This response could be the result of an
  602. unsuccessful DIAL TONE/PULSE, ANSWER, or LEASED DIAL/ANSWER command
  603. or a successful HANGUP command.
  604.  
  605.   Its value can be any sequence of ASCII characters, including
  606. control characters, with a total length not exceeding 25 characters.
  607. The default value is NO CARRIER.
  608.  
  609. 2.46. ERROR
  610.  
  611.   This keyword is used to specify the command response that indicates
  612. that this modem has received an invalid command or there was an error
  613. in the command string. This response is not expected by MHS, which if
  614. received when a modem response is required, will abort the connection.
  615.  
  616.   Its value can be any sequence of ASCII characters, including
  617. control characters, with a total length not exceeding 25 characters.
  618. The default value is ERROR.
  619.  
  620.  
  621. 2.47. NO DIALTONE
  622.  
  623.   This keyword is used to specify the command response that indicates
  624. that no dial tone was detected when this modem went off hook. This
  625. response could be the result of an unsuccessful DIAL TONE/PULSE or
  626. ANSWER command.
  627.  
  628.   Its value can be any sequence of ASCII characters, including
  629. control characters, with a total length not exceeding 25 characters.
  630. The default value is NO DIALTONE.
  631.  
  632. 2.48. BUSY
  633.  
  634.   This keyword is used to specify the command response that indicates
  635. that this modem detected a busy signal when it attempted to connect
  636. with the remote modem at the telephone number dialed. This response
  637. could be the result of an unsuccessful DIAL TONE/PULSE command.
  638.  
  639.   Its value can be any sequence of ASCII characters, including
  640. control characters, with a total length not exceeding 25 characters.
  641. The default value is BUSY.
  642.  
  643. 2.49. NO ANSWER
  644.  
  645.   This keyword is used to specify the command response that indicates
  646. that no silence was detected by this modem when dialing a system not
  647. providing a dial tone. This response is the result of including the
  648. @ dial modifier in the telephone number of an unsuccessful DIAL
  649. TONE/PULSE command.
  650.  
  651.   Its value can be any sequence of ASCII characters, including
  652. control characters, with a total length not exceeding 25 characters.
  653. The default value is NO ANSWER.
  654.  
  655. 2.50. VOICE
  656.  
  657.   This keyword is used to specify the command response that indicates
  658. that this modem detected a (human) voice when it attempted to connect
  659. with the remote modem at the telephone number dialed. This response
  660. could be the result of an unsuccessful DIAL TONE/PULSE command.
  661.  
  662.   Its value can be any sequence of ASCII characters, including
  663. control characters, with a total length not exceeding 25 characters.
  664. The default value is VOICE.
  665.  
  666.  
  667. 2.51. CARRIER
  668.  
  669.   This keyword is used to specify the command response that indicates
  670. that this modem detected a carrier signal when it attempted to make
  671. a modem protocol connection. This response is the result of sending a
  672. DIAL TONE/PULSE, ANSWER, or LEASED DIAL/ANSWER command. Although this
  673. response is currently only used for informational purposes, its
  674. detection and reporting allows for debugging improper MHS
  675. configurations and incorrect MDF command strings.
  676.  
  677.   Its value can be any sequence of ASCII characters, including
  678. control characters, with a total length not exceeding 25 characters.
  679. The default value is CARRIER.
  680.  
  681. 2.52. PROTOCOL A
  682.  
  683.   This keyword is used to specify the command response that indicates
  684. that this modem successfully negotiated a modem protocol connection.
  685. This response is the result of sending a DIAL TONE/PULSE, ANSWER, or
  686. LEASED DIAL/ANSWER command. Although this response is currently only
  687. used for informational purposes, its detection and reporting allows
  688. for debugging improper MHS configurations and incorrect MDF command
  689. strings.
  690.  
  691.   Its value can be any sequence of ASCII characters, including
  692. control characters, with a total length not exceeding 25 characters.
  693. The default value is PROTOCOL: LAP-M.
  694.  
  695. 2.53. PROTOCOL B
  696.  
  697.   This keyword is used to specify the command response that indicates
  698. that this modem successfully negotiated a modem protocol connection.
  699. This response is the result of sending a DIAL TONE/PULSE, ANSWER, or
  700. LEASED DIAL/ANSWER command. Although this response is currently only
  701. used for informational purposes, its detection and reporting allows
  702. for debugging improper MHS configurations and incorrect MDF command
  703. strings.
  704.  
  705.   Its value can be any sequence of ASCII characters, including
  706. control characters, with a total length not exceeding 25 characters.
  707. The default value is /ARQ.
  708.  
  709. 2.54. COMPRESSION
  710.  
  711.   This keyword is used to specify the command response that indicates
  712. that this modem successfully negotiated a modem data compression
  713. connection. This response is the result of sending a DIAL TONE/PULSE,
  714. ANSWER, or LEASED DIAL/ANSWER command. Although this response is
  715. currently only used for informational purposes, its detection and
  716. reporting allows for debugging improper MHS configurations and
  717. incorrect MDF command strings.
  718.  
  719.   Its value can be any sequence of ASCII characters, including
  720. control characters, with a total length not exceeding 25 characters.
  721. The default value is COMPRESSION.
  722.  
  723.  
  724. 2.55. CONNECT
  725.  
  726.   This keyword is used to specify the command response that
  727. indicates that this modem successfully completed a connection with
  728. a remote modem. This response is the result of sending a DIAL
  729. TONE/PULSE, ANSWER, or LEASED DIAL/ANSWER command. It is used
  730. in conjunction with the CONNECT 300/1200/2400/9600/14400 responses
  731. (see below) to determine the modem connection speed.
  732.  
  733.   Its value can be any sequence of ASCII characters, including
  734. control characters, with a total length not exceeding 25 characters.
  735. The default value is CONNECT.
  736.  
  737. 2.56. CONNECT 300
  738.  
  739.   This keyword is used to specify the command response that indicates
  740. that this modem successfully completed a 300 bps connection with a
  741. remote modem. It is used in conjunction with the CONNECT response to
  742. indicate that a 300 bps serial speed is required if no modem protocol
  743. connection was attempted and ADJUST SPEED is TRUE.
  744.  
  745.   Its value can be any sequence of ASCII characters, including
  746. control characters, with a total length not exceeding 25 characters.
  747. The default value is nothing, i.e., no characters.
  748.  
  749. 2.57. CONNECT 1200
  750.  
  751.   This keyword is used to specify the command response that indicates
  752. that this modem successfully completed a 1200 bps connection with a
  753. remote modem. It is used in conjunction with the CONNECT response
  754. to indicate that a 1200 bps serial speed is required if no modem
  755. protocol connection was attempted and ADJUST SPEED is TRUE.
  756.  
  757.   Its value can be any sequence of ASCII characters, including
  758. control characters, with a total length not exceeding 25 characters.
  759. The default value is 1200.
  760.  
  761. 2.58. CONNECT 2400
  762.  
  763.   This keyword is used to specify the command response that indicates
  764. that this modem successfully completed a 2400 bps connection with a
  765. remote modem. It is used in conjunction with the CONNECT response
  766. to indicate that a 2400 bps serial speed is required if no modem
  767. protocol connection was attempted and ADJUST SPEED is TRUE.
  768.  
  769.   Its value can be any sequence of ASCII characters, including
  770. control characters, with a total length not exceeding 25 characters.
  771. The default value is 2400.
  772.  
  773.  
  774. 2.59. CONNECT 9600
  775.  
  776.   This keyword is used to specify the command response that indicates
  777. that this modem successfully completed a 9600 bps connection with a
  778. remote modem. It is used in conjunction with the CONNECT response
  779. to indicate that a 9600 bps serial speed is required if no modem
  780. protocol connection was attempted and ADJUST SPEED is TRUE.
  781.  
  782.   Its value can be any sequence of ASCII characters, including
  783. control characters, with a total length not exceeding 25 characters.
  784. The default value is 9600.
  785.  
  786. 2.60. CONNECT 14400
  787.  
  788.   This keyword is used to specify the command response that indicates
  789. that this modem successfully completed a 14400 bps connection with a
  790. remote modem. It is used in conjunction with the CONNECT response
  791. to indicate that a 14400 bps serial speed is required if no modem
  792. protocol connection was attempted and ADJUST SPEED is TRUE.
  793.  
  794.   Its value can be any sequence of ASCII characters, including
  795. control characters, with a total length not exceeding 25 characters.
  796. The default value is 14400.
  797.  
  798.  
  799. 3.0 Usage
  800.  
  801.   MDFs are used by the MHS products when they are referenced as the
  802. Modem Type in the MHS configuration. MHS uses the MDF to configure,
  803. reset, initialize, dial, answer, connect, and hangup modems, both in
  804. dial up and leased line environments. In the case of GMHS, MDFs can
  805. be referenced by more than one serial port.
  806.  
  807.   The information in a MDF is used in various stages of MHS execution
  808. and for different MHS configurations. These stages can be divided
  809. into MDF initialization, MDF verification, serial port initialization,
  810. modem initialization, modem dialing, modem answering, modem
  811. connection, leased line connection, and modem hangup. GMHS also uses
  812. MDFs slightly differently from RMHS. The following sections will
  813. present these stages and these differences.
  814.  
  815. 3.1 MDF Initialization
  816.  
  817.   When the MDF is first referenced, it is processed, i.e., the MDF is
  818. is opened, memory is allocated and initialized with the default MDF
  819. keyword values, MDF keywords are read and their values are checked and
  820. extracted, and then the MDF is closed. If an error occurs due to an
  821. invalid MDF keyword and/or value, an error may be logged and displayed
  822. and the MDF keyword and/or value will be ignored.
  823.  
  824. 3.2 MDF Verification
  825.  
  826.   MDFs can be used for validation of modem configuration. GMHS
  827. validates the following information using the MDF:
  828.  
  829.   o Is the Modem Speed valid for this modem, i.e., is it in the list
  830.     of MODEM SPEEDS? If this MDF keyword is not specified, only speeds
  831.     of 300, 1200, 2400, and 9600 are allowed.
  832.  
  833.   o If configured for Yes, is Modem Negotiation valid for this modem,
  834.     i.e., are PROTOCOL ON and PROTOCOL OFF specified?
  835.  
  836.   o If configured for Yes, is Leased Line valid for this modem, i.e.,
  837.     are LEASED DIAL and LEASED ANSWER specified?
  838.  
  839.   o If Optional Modem Commands are specified, do they exceed the
  840.     MAX COMMAND length?
  841.  
  842.   RMHS does little to verify modem configurations; the only check is
  843. to verify that the configured speed does not exceed the MAX SPEED
  844. specified by the MDF. This condition is made unlikely by the RSETUP
  845. program, which only allows users to pick from a list of valid speeds.
  846.  
  847.  
  848. 3.3 Serial Port Initialization
  849.  
  850.   Both GMHS and RMHS initializes a serial port for 8 data bits, 1
  851. stop bit, no parity, the configured speed, and with RTS/CTS flow
  852. control disabled. The RTS and DTR signals are also raised. After a
  853. modem connection (see below), both GMHS and RMHS monitor for an
  854. active DCD signal from a modem, and if FLOW CONTROL is TRUE, also
  855. the CTS signal.
  856.  
  857.   The maximum data rate supported varies, depending on the type of
  858. serial port (COMx or intelligient multi-port serial adaptors), type
  859. of CPU, clock speed, etc. GMHS, which uses AIO, generally is limited
  860. to 2400 bps for COMx ports and 38.4K bps for serial adaptors. RMHS
  861. is limited to 115K bps.
  862.  
  863. 3.4 Modem Initialization
  864.  
  865.   The modem is only initialized and used when a connection to another
  866. MHS host is required. In the case of GMHS, if a modem is configured
  867. for a Modem Mode of Answer or Answer/Dial, the modem will be
  868. initialized and monitored immediately for incoming calls. Otherwise,
  869. modem initialization is done before modem dialing (see below).
  870.  
  871.   First, a check is made for a previous off-hook, active connection
  872. which may need to be hung up. Active connections are recognized by an
  873. active DCD signal, which causes modem hangup to be initiated (see
  874. below). Second, if Modem Negotiation is configured for Yes or ADJUST
  875. SPEED is FALSE, the serial speed will be changed to either the MAX
  876. SPEED or the maximum speed of the serial port, whichever is smaller.
  877.  
  878.   Third, the RESET command is sent, waiting up to RESET TIME + 1
  879. seconds for a response. If there is no response, the speed will be
  880. changed to 1200 bps and the RESET command resent. A valid response is
  881. not required to continue initialization. Fourth, the first INIT
  882. command is sent, waiting up to RESPONSE TIME seconds for a response.
  883. If there are no or error responses, this command is resent; a valid
  884. response is not required.
  885.  
  886.   At this point, the modem should be initialized properly and should
  887. respond properly. If there are second and third INIT commands, they
  888. are sent one at a time, waiting up to RESPONSE TIME seconds for each
  889. response. If there are no or error responses, these commands are
  890. resent. If there are still no or error responses, this modem will not
  891. be used for a configured delay and an error may be logged and
  892. displayed.
  893.  
  894.   If there are valid responses, initialization continues with the
  895. speaker and protocol commands. If Modem Speaker is configured for On,
  896. the SPEAKER ON command is sent; otherwise, the SPEAKER OFF command is
  897. sent. If Modem Negotiation is configured for Yes, the PROTOCOL ON
  898. command is then sent; otherwise, the PROTOCOL OFF command is then
  899. sent. There is a wait of RESPONSE TIME seconds for responses. If
  900. there are no or error responses, these commands are resent; valid
  901. responses for speaker and protocol commands are not required.
  902.  
  903.  
  904. 3.5 Modem Dialing
  905.  
  906.   When an outgoing call is requested, the following steps are
  907. followed. In the case of GMHS, if the modem was being monitored for
  908. incoming calls and the configuration of Modem Negotiation is
  909. different, either the PROTOCOL ON or PROTOCOL OFF command are sent.
  910. GMHS waits up to RESPONSE TIME seconds for responses. If there are no
  911. or error responses, GMHS resends these commands; a valid response is
  912. not required.
  913.  
  914.   If ADJUST SPEED is TRUE, GMHS will then change the serial speed to
  915. the configured or maximum speed of the serial port, whichever is
  916. smaller. If ADJUST SPEED is FALSE, GMHS will then send the DIAL
  917. command that corresponds to the configured or maximum speed of the
  918. serial port, whichever is smaller.
  919.  
  920.   In the case of RMHS, it will change the serial speed to the
  921. configured or maximum speed of the serial port, whichever is smaller.
  922. Both GMHS and RMHS will then send any Optional Modem Commands that
  923. have been configured, waiting up to RESPONSE TIME seconds for a
  924. response. If there are no or error responses, these commands are
  925. resent; a valid response is not required.
  926.  
  927.   Finally, the configured prefix and telephone number strings are
  928. combined with either the DIAL TONE or DIAL PULSE dial command,
  929. depending on the configuration. Both GMHS and RMHS will send this
  930. combined dial command string, waiting up to the configured time for
  931. a modem connection (see below). If the MAX COMMAND length is reached,
  932. the DIAL ESCAPE character is used to break up a prefix + telephone
  933. number string into multiple dial command strings, which are sent one
  934. after another, waiting for valid responses in between dial commands.
  935.  
  936.   RMHS also supports a configured calling card string, which is added
  937. after the prefix and telephone number strings, before sending the dial
  938. command. RMHS also supports two types of manual dialing, keyboard and
  939. telephone.
  940.  
  941.   For keyboard manual dialing, RMHS reads digits from the keyboard,
  942. sending them to the modem as separate dial commands, each command
  943. followed by the DIAL ESCAPE character. The user completes keyboard
  944. manual dialing by hitting the carriage return key, which sends a dial
  945. command with no number and no DIAL ESCAPE character. For telephone
  946. manual dialing, RMHS waits for the user to manually dial the
  947. telephone number using the telephone keypad and then hit the carriage
  948. return key, before sending a dial command with no number and no
  949. DIAL ESCAPE character.
  950.  
  951.  
  952. 3.6 Modem Answering
  953.  
  954.   GMHS supports incoming calls and therefore, must answer modems;
  955. RMHS does not support incoming calls. If a modem is configured for
  956. a Modem Mode of Answer or Answer/Dial, GMHS will continually monitor
  957. the modem for incoming calls, i.e., it will poll the modem for the
  958. RING response. When a RING response has been received, GMHS sends
  959. the ANSWER command, waiting up to 60 seconds for a modem connection
  960. (see below).
  961.  
  962.   If an unknown or error response is received, the serial port and
  963. modem will be reset and re-initialized and if successful, GMHS will
  964. again start polling for the RING response.
  965.  
  966. 3.7 Modem Connection
  967.  
  968.   After modem dial, modem answer, or leased line commands are sent,
  969. both GMHS and RMHS poll for a CONNECT response. Some modems will
  970. return informational responses before the CONNECT response, i.e.,
  971. RINGING, CARRIER, COMPRESSION, and PROTOCOL A/B. Some modems will
  972. also return these informational responses as part of the CONNECT
  973. response. All these cases are handled.
  974.  
  975.   In case of errors, modems will also return responses like ERROR,
  976. NO CARRIER, NO DIALTONE, BUSY, NO ANSWER, and VOICE. All these cases
  977. are handled. After receiving the CONNECT response, if ADJUST SPEED
  978. is TRUE and the current serial speed does not match the CONNECT speed,
  979. the serial speed will be changed to the CONNECT speed.
  980.  
  981.   After modem connection, if FLOW CONTROL is TRUE, the RTS/CTS flow
  982. flow control is enabled. Both GMHS and RMHS also start monitoring for
  983. an inactive DCD to indicate lost carrier/connection. If DCD is
  984. inactive, modem hangup will be initiated (see below).
  985.  
  986. 3.8 Leased Line Connection
  987.  
  988.   GMHS supports leased lines and therefore, must initialize and
  989. monitor modems for leased line connections; RMHS does not support
  990. leased lines. If Leased Line is Yes, GMHS sends either the LEASED
  991. ANSWER or the LEASED DIAL command at the end of modem initialization,
  992. depending on if Modem Mode is Answer or Dial respectively. GMHS thens
  993. polls for a modem connection (see above) indefinitely.
  994.  
  995.   There are two special cases for leased line modems. If LEASED
  996. EXTERNAL is TRUE, GMHS does not send the LEASED ANSWER or LEASED DIAL
  997. commands; this modem was setup externally for leased line operation,
  998. usually with physical switches. If LEASED RESPONSE is FALSE, GMHS does
  999. not poll for modem connection responses; instead, the modem is polled
  1000. for an active DCD signal to indicate a modem connection.
  1001.  
  1002.  
  1003. 3.9 Modem Hangup
  1004.  
  1005.   If FLOW CONTROL is TRUE, the RTS/CTS flow control mechanism is
  1006. disabled. Then, the COMMAND END characters are sent, finishing any
  1007. previous modem commands. To make certain the modem is in its command
  1008. state, a delay of ESCAPE TIME seconds is initiated, then the ESCAPE
  1009. command is sent, and then an additional delay of ESCAPE TIME seconds
  1010. plus a minimum of RESPONSE TIME seconds or a maximum of 30 seconds
  1011. for no responses is initiated.
  1012.  
  1013.   Finally, the HANGUP command is sent, waiting up to HANGUP TIME
  1014. seconds for a response. To ensure that hangup will occur, the DTR
  1015. signal is also dropped and after DTR TIME seconds, the DTR signal is
  1016. raised.
  1017.  
  1018.  
  1019. Appendix A. General Guidelines for Creating a MDF
  1020.  
  1021.   There are some general guidelines that should be followed when
  1022. creating a MDF:
  1023.  
  1024.   (1) Do not modify a released MDF; instead, create a separate MDF.
  1025.  
  1026.   (2) Assume that the modem is in an unknown state prior to its use.
  1027.  
  1028.   (3) Try not to use &F (recall factory profile) because you may
  1029.       override a feature not specified in the MDF.
  1030.  
  1031.   (4) Try not to use &W (write active profile to memory) because you
  1032.       may affect a previous/future modem configuration and the NVRAM
  1033.       memory has a limited number of writes before it is unusable.
  1034.  
  1035.   (5) Don't rely on the Z (RESET) command to recall a previously
  1036.       saved modem configuration since this may have been overwritten
  1037.       by a previous user/application.
  1038.  
  1039.   (6) Only use the pre-defined keywords that are relevant to this
  1040.       modem and whose default's are not sufficient for this modem.
  1041.  
  1042.   (7) Where appropriate, use comment lines thoughout the MDF.
  1043.  
  1044.   (8) Each MDF name is limited to the eight character maximum of
  1045.       DOS and the NetWare file systems. MDF names should be as
  1046.       descriptive as possible since current MHS products only
  1047.       display the MDF filename for selecting a Modem Type. Generally,
  1048.       the first part of the name should be an abbreviation for the
  1049.       manufacturer of the modem, e.g., "HAYES", and the second part
  1050.       the abbreviation of model number or maximum speed, e.g., "96".
  1051.       If the eight character maximum name has not been reached, a
  1052.       single character abbreviation should be added to denote a
  1053.       series or capability, e.g., "v" for V-series or "e" for
  1054.       error-control. The extension is always MDF.
  1055.  
  1056.   (9) The MDFs must reside in special subdirectories, which are
  1057.       different for each MHS product. GMHS requires the MDFs to be
  1058.       in the <NGM-root-dir>\ASYNC\MODEMDEF directory. RMHS requires
  1059.       the MDFs to be in the <MHS-root-dir>\MHS\SYS directory.
  1060.  
  1061.  
  1062. Appendix B. Example MDF for a Hayes Smartmodem 2400
  1063.  
  1064. MDF DESCRIPTION=Hayes Smartmodem 2400 and compatibles
  1065. MDF VERSION=2
  1066. MDF TYPE=HAYES
  1067. MODEM SPEEDS=300,1200,2400
  1068. MAX SPEED=2400
  1069. MAX COMMAND=40
  1070. INIT=EQV1X4S0=0S2=43S3=13S4=10S7=254S12=50
  1071. INIT=&C1&D3&L
  1072. LEASED DIAL=&L1D
  1073. LEASED ANSWER=&L1A
  1074.  
  1075. Appendix C. Example MDF for a Hayes V-series ULTRA Smartmodem 9600
  1076.  
  1077. MDF DESCRIPTION=Hayes V-series ULTRA Smartmodem 9600
  1078. MDF VERSION=2
  1079. MDF TYPE=HAYES
  1080. MODEM SPEEDS=300,1200,2400,9600
  1081. MAX SPEED=38400
  1082. MAX COMMAND=255
  1083. FLOW CONTROL=TRUE
  1084. ADJUST SPEED=FALSE
  1085. INIT=EQV1X4S0=0S2=43S3=13S4=10S7=254S12=50
  1086. INIT=N1W1&C1&D3&K3&L
  1087. INIT=S30=0S37=0S49=8S50=16S95=32
  1088. DIAL 300=S37=3
  1089. DIAL 1200=S37=5
  1090. DIAL 2400=S37=6
  1091. DIAL 9600=S37=9
  1092. LEASED DIAL=&L1D
  1093. LEASED ANSWER=&L1A
  1094. PROTOCOL ON=&Q5S36=7S38=20S46=2S48=7
  1095. PROTOCOL OFF=&Q6
  1096. PROTOCOL A=PROTOCOL: LAP-M
  1097. PROTOCOL B=PROTOCOL: ALT
  1098.  
  1099.  
  1100. Appendix D. Example MDF for a USRobotics Courier HST
  1101.  
  1102. MDF DESCRIPTION=USRobotics Courier HST, HST dual standard, and V.32bis
  1103. MDF VERSION=2
  1104. MDF TYPE=HAYES
  1105. MODEM SPEEDS=300,1200,2400,9600,14400
  1106. MAX SPEED=38400
  1107. MAX COMMAND=40
  1108. FLOW CONTROL=TRUE
  1109. ADJUST SPEED=FALSE
  1110. INIT=EQV1X6S0=0S2=43S3=13S4=10S7=255S12=50
  1111. INIT=BC1F1&A1&C1&D2&B1&H1&L&N0&R2S19=0
  1112. LEASED DIAL=
  1113. LEASED ANSWER=
  1114. LEASED EXTERNAL=TRUE
  1115. LEASED RESPONSE=TRUE
  1116. PROTOCOL ON=&K2&M4
  1117. PROTOCOL OFF=&M
  1118. PROTOCOL A=/ARQ
  1119. ;
  1120. ; For leased line operation, do the following steps:
  1121. ; 1.  Set your terminal or communications software to 38.4K bps.
  1122. ; 2.  Send the modem the following command: AT&B1&S2&H1&L1&W
  1123. ; 3.  Set the modem to load NVRAM settings at power-on, DIP switch 10 UP.
  1124. ; 4.  If this is the answering modem, set the modem to Auto Answer,
  1125. ;     DIP switch 5 UP. If this is the calling modem, set the modem to
  1126. ;     Auto Answer suppressed, DIP switch 5 DOWN.
  1127. ; 5.  Power off the modem.
  1128. ; 6.  On the NetWare server, select a 38.4K bps capable port and
  1129. ;     attach it to the modem.
  1130. ; 7.  Configure this port for leased line operation and for a USRHST.
  1131. ; 8.  Repeat these or similiar steps for the remote modem.
  1132. ; 9.  Turn on the calling modem first, followed by the answering modem.
  1133. ; 10. The modems should then go off hook and establish the connection.
  1134. ; 11. If unsuccessful, repeat step 9.
  1135.  
  1136.  
  1137. Appendix E. Debugging MDFs with NetWare Global MHS
  1138.  
  1139.   This section contains information to assist in debugging MDFs
  1140. using the GMHS product and its NGMAMP.NLM program, which can display
  1141. information on the screen as well as in log file(s) when modem
  1142. interactions take place. This information takes the form of events,
  1143. either connection, modem, port, or error events. Events are further
  1144. divided into major events, minor events, and error codes; the
  1145. important ones for debugging MDFs are listed below. The screen
  1146. display is enabled by loading the NGMAMP.NLM with the -S command
  1147. line option.
  1148.  
  1149.   The GMHS log files can be found in a <NGM-root-dir>\LOGS directory,
  1150. referenced by the day of the week. The size of an individual log file
  1151. is controlled by an option in the GMHS configuration file, which can
  1152. be found in a SYS:\SYSTEM\NGM.CFG file. This option, Maximum-Log-Size,
  1153. has a default of 200K and GMHS will start overwriting a log file when
  1154. this maximum has been reached.
  1155.  
  1156.   The NGMAMP log files are further referenced by the type of serial
  1157. ports used to interface to the configured modems. For example, the
  1158. events for the COM1 serial port can be found in the 01-00-00 file.
  1159. The number of events is generally influenced by the verbosity level,
  1160. which can be set using another option, Log-Verbosity, in a NGM.CFG
  1161. file or via the GMHS administration program NGMADMIN.NLM.
  1162.  
  1163.   The default setting for NGMAMP is verbosity level 6, which displays
  1164. connection and error events. A verbosity level of 9 displays these
  1165. events as well as (serial) port and modem events. When debugging
  1166. modem (and MDF) problems, set the verbosity level to 9.
  1167.  
  1168. 1) Connection Events
  1169.  
  1170.   The major events are OutboundCall, PollingCall, and InboundCall.
  1171. There are many possible minor events but the important ones are
  1172. Opening, Dialing, ModemControl, LoggingIn, CallerID, LoggingOut,
  1173. HangingUp, and Closed. These events track the high level actions
  1174. that cause MHS to access serial ports and modems. Refer to the GMHS
  1175. Codes and Messages manual for details on these events.
  1176.  
  1177. 2) Modem Events
  1178.  
  1179.   The major event is Modem. The minor events are Definition, Command,
  1180. Response, Reset, Initialize, Dial, Answer, Ring, Hangup, Connect,
  1181. Leased, and Speed. A period in a Response event string implies a 1
  1182. second period of time when no characters were received. These events
  1183. track the low level actions of MHS modem control. Refer to the GMHS
  1184. Codes and Messages manual for details on these events.
  1185.  
  1186.  
  1187. 3) (Serial) Port Events
  1188.  
  1189.   The major event is Port. The minor events are PortNames, AcquirePort,
  1190. ReleasePort, ChangeSpeed, ChangePort, FlowControl, and SetDTR. These
  1191. events track the low level actions of MHS serial port control. Refer
  1192. to the GMHS Codes and Messages manual for details on these events.
  1193.  
  1194. 4) Error Events
  1195.  
  1196.   The major events are SevereError, MajorError, Error, InternalErr,
  1197. Warning, and Advisory. The modem errors are identified with #326,
  1198. followed by the range #19000 to #19999. The port errors are identified
  1199. with #256, followed by the range #20000 to #20999. Refer to the GMHS
  1200. Codes and Messages manual for details on these errors.
  1201.  
  1202.  
  1203. Appendix F. Debugging MDFs with NetWare Remote MHS
  1204.  
  1205.   This section contains information to assist in debugging MDFs
  1206. using the RMHS product, which can display information on the screen
  1207. as well as in a log file when modem interactions take place. This
  1208. information takes the form of events, either status, informational,
  1209. warning, error, or trace. The number of events is generally
  1210. influenced by the verbosity level, which can be set using the -V
  1211. command line option.
  1212.  
  1213.   The default setting for RMHS is verbosity level 8, which displays
  1214. status, informational, warning, and error events. A verbosity level
  1215. of 9, the maximum, displays these events as well as trace events.
  1216. Status events are always displayed in the second line from the bottom
  1217. of a RMHS screen.
  1218.  
  1219.   The RMHS.LOG file can be found in a <MHS-root-dir>\MHS\MAIL\PUBLIC
  1220. directory.
  1221.  
  1222. 1) Status Line Events
  1223.  
  1224.   The following is a list of these events and some comments as to
  1225. their meaning:
  1226.  
  1227. Waiting for modem connection ...
  1228.   Appears on the status line while RMHS is waiting for a CONNECT
  1229.   response from the modem.
  1230.  
  1231. Hanging up modem ...
  1232.   Appears on the status line while RMHS is sending HANGUP commands
  1233.   to the modem.
  1234.  
  1235. Dialing ...
  1236.   Appears on the status line while RMHS is sending DIAL commands to
  1237.   the modem.
  1238.  
  1239. Initializing modem ...
  1240.   Appears on the status line while RMHS is sending INIT commands to
  1241.   the modem.
  1242.  
  1243. Resetting modem ...
  1244.   Appears on the status line while RMHS is sending a RESET command to
  1245.   the modem.
  1246.  
  1247.  
  1248. 2) Informational, Warning, and Error Events
  1249.  
  1250.   The following is a list of these events and some comments as to
  1251. their meaning:
  1252.  
  1253. E2550 Error in modem definition file.
  1254.   MDF file contains some syntactic error.
  1255.  
  1256. E2553 Timeout waiting for modem response.
  1257.   Modem failed to respond to a command with the expected OK response
  1258.   within the RESPONSE TIME seconds.
  1259.  
  1260. E2554 Unsupported modem speed (%lu bps).
  1261.   Modem speed set in user interface or modem speed parsed out of
  1262.   CONNECT response from modem does not fall within parameters set in
  1263.   the MDF file.
  1264.  
  1265. E2555 Modem is not responding.
  1266.   Modem repeatedly failed to respond to a command with the expected
  1267.   OK response.
  1268.  
  1269. E2556 Invalid modem response.
  1270.   Modem failed to respond to a command with the expected OK response;
  1271.   instead, modem responded with an unrecognizable string.
  1272.  
  1273. W2557 Modem indicates an error has occurred.
  1274.   Modem has responded to a command with the ERROR response instead of
  1275.   the expected OK response.
  1276.  
  1277. W2558 Adjusting modem speed to %lu bps.
  1278.   ADJUST SPEED is TRUE and the modem CONNECT response indicated a speed
  1279.   change was required.
  1280.  
  1281. W2559 Carrier still active, hangup failed.
  1282.   HANGUP command failed.
  1283.  
  1284. W2560 Speaker command failed.
  1285.   Modem failed to respond to a SPEAKER ON/OFF command with the
  1286.   expected OK response.
  1287.  
  1288. E2561 Protocol command failed.
  1289.   Modem failed to respond to a PROTOCOL ON/OFF command with the
  1290.   expected OK response.
  1291.  
  1292. E2563 Initialization command failed.
  1293.   Modem failed to respond to an INIT command with the expected OK
  1294.   response.
  1295.  
  1296. E2565 One or more modem commands failed.
  1297.   Modem failed to respond to some modem command with the expected OK
  1298.   response.
  1299.  
  1300.  
  1301. E2566 Could not change modem speed to %lu bps.
  1302.   ADJUST SPEED is TRUE and the modem CONNECT response indicated a speed
  1303.   change was required, but the speed change failed.
  1304.  
  1305. E2568 Out of memory in modem layer.
  1306.   When reading a MDF file into memory, RMHS ran out of heap space.
  1307.  
  1308. E2570 Modem dial failed.
  1309.   Modem failed to respond to a DIAL PULSE/TONE command with the
  1310.   expected CONNECT response.
  1311.  
  1312. W2574 Modem could not detect carrier.
  1313.   Modem detected a NO CARRIER response.
  1314.  
  1315. W2575 Modem could not detect dialtone.
  1316.   Modem detected a NO DIALTONE response.
  1317.  
  1318. W2576 Modem detected a busy signal.
  1319.   Modem detected a BUSY response.
  1320.  
  1321. W2577 Called server is not answering.
  1322.   Modem timed out waiting for CONNECT response and last response was
  1323.   RINGING response.
  1324.  
  1325. W2578 Modem detected human voice instead of carrier.
  1326.   Modem detected a VOICE response.
  1327.  
  1328. E2579 The modem attached to COM%d: is bad, does not exist, is
  1329. incorrectly configured, or is incorrectly cabled.
  1330.   Modem is not responding to commands.
  1331.  
  1332. I2581 High-speed connection established.
  1333.   Modem speed parsed out of CONNECT response from modem is above
  1334.   38.4K bps.
  1335.  
  1336. I2582 High-speed connection with protocol established.
  1337.   Modem speed parsed out of CONNECT response from modem is above
  1338.   38.4K bps and PROTOCOL A/B response detected.
  1339.  
  1340. I2583 Established %lu bps connection.
  1341.   CONNECT response detected at indicated speed.
  1342.  
  1343. I2584 Established %lu bps connection with protocol.
  1344.   CONNECT and PROTOCOL A/B responses detected at indicated speed.
  1345.  
  1346. E2585 Could not establish modem connection.
  1347.   Modem timed out waiting for CONNECT response.
  1348.  
  1349.  
  1350. 3) Trace Events
  1351.  
  1352.   Trace events are the actual commands sent to a modem and the actual
  1353. responses received from a modem; these events are NOT placed in the
  1354. RMHS.LOG file. An example of these events are as follows (note that
  1355. trace events are mixed in with other non-trace events):
  1356.  
  1357. ATZ
  1358. OK
  1359. ATEQV1X4S0=0S2=43S3=13S4=10S7=254S12=50
  1360. OK
  1361. AT&C1&D3&L
  1362. OK
  1363. I2569 Dialing OUTBOUND at 2400 bps, tone dial, negotiation off.
  1364. ATDT123-4567
  1365. OK
  1366.