[Top] [Prev] [Next] [Bottom]

Modem Definition Commands

This document describes the Modem Definition configuration commands. The modem definition supplies commands to configure the modem to dial, accept connections, and disconnect. It also tells the DIAL device how the modem is configured and what result codes to expect from the modem. For instructions on setting up a modem definition, see Adding a Modem Definition.

Table 1 summarizes the Modem Definition configuration commands. Enter these commands at the Modem Config> prompt. There are no monitoring commands for modem definitions

Press Space twice after you type a command to display the available parameters for each command. Enter help for information about using the command line interface.

Modem Definition Commands

Command Function

Disable Disables options that you configured using the set command, as well as the carrier-wait and ready-wait options.

Enable Enables options that you configured using the set command, as well as the carrier-wait and ready-wait options.

Exit Returns to the DIAL Config <WAN> prompt.

List Displays a modem definition's command strings, result codes, and options.

Set Defines optional commands for configurable modems.

Modem Definition Commands
Command	Function
Disable	Disables options that you configured using the set command, as well as the carrier-wait and ready-wait options.
Enable	Enables options that you configured using the set command, as well as the carrier-wait and ready-wait options.
Exit	Returns to the `DIAL Config <WAN>` prompt.
List	Displays a modem definition's command strings, result codes, and options.
Set	Defines optional commands for configurable modems.

Disable

Disables options for configurable and nonconfigurable modems that you configured using the set command, as well as the carrier-wait or ready-wait options. For nonconfigurable modems, the only options you can change are carrier-wait and ready-wait.

Syntax: disable

answer
carrier-wait
dial
disconnect
initialization
ready-wait

answer

Disables the use of the manual answer command configured using the set answer command. This option is disabled by default. If you disable this option, you should include the initialization command string S0=1, which enables auto-answering by the modem.

Example: disable answer

carrier-wait

Disables the option that allows the DIAL device to assert DTR immediately after self-test in order to accept incoming calls immediately. This option is disabled by default. If you configure your modem to dial when DTR is raised, disabling carrier-wait prevents the DIAL device from dialing out immediately after self-test.

Example: disable carrier-wait

dial

Disables the use of the dial prefix and suffix command strings configured using the set dial prefix and set dial suffix commands. This option is enabled by default.

Example: disable dial

disconnect

Disables the use of the disconnect command configured using the set disconnect command. This option is disabled by default.

Example: disable disconnect

initialization

Disables the use of the initialization command string configured using the set initialization command. This option is enabled by default.

Example: disable initialization

ready-wait

When this option is disabled, after the DIAL device turns on DTR, the device does not wait for the modem to turn on DSR. This option is disabled by default.

Example: disable ready-wait

Enable

Enables optional capabilities that you configured using the set command, as well as the carrier-wait or ready-wait options. For nonconfigurable modems, the only options you can change are carrier-wait and ready-wait.

Syntax: enable

answer
carrier-wait
dial
disconnect
initialization
ready-wait

answer

Enables the use of the manual answer command configured with the set answer command. This option is disabled by default. If you enable this option, you should include S0=0 in the initialization command string to disable auto-answering by the modem. Manual answering may be necessary if the modem both makes and accepts calls because race conditions can make it impossible to determine whether the modem answered an incoming call or connected an outgoing call if they occur at the same time.

Example: enable answer

carrier-wait

Causes the DIAL device to assert DTR immediately after self-test in order to accept incoming calls immediately. This option is disabled by default.

Example: enable carrier-wait

dial

Enables the use of the dial prefix and suffix command strings configured with the set dial prefix and set dial suffix commands. This option is enabled by default.

Example: enable dial prefix

disconnect

Enables the use of the disconnect command string configured with the set disconnect command. This option is disabled by default.

Example: enable disconnect

initialization

Enables the use of the initialization command string configured with the set initialization command. This option is enabled by default.

Example: enable initialization

ready-wait

If you enable this option, after the DIAL device turns on DTR, the DIAL device waits for the modem to turn on DSR. Use this option to ensure that a modem is connected to the DIAL device. This option is disabled by default.

Notes:

If you enable ready-wait, you must initialize Hayes-compatible asynchronous modems with the &S0 command to make sure that DSR is always on. If you do not initialize the modem with &S0, self-test fails on the DIAL device.
If your modem is currently initialized with &S1, do the following before you enter enable ready-wait.

a. Initialize the modem with the &S0 command.
b. Restart the router.

Example: enable ready-wait

Exit

Returns to the DIAL Config <WAN> prompt.

Syntax: exit

Example: exit

DIAL Config <WAN>

List

Displays a modem definition's command strings, result codes, and options.

Syntax: list

Example: list

Configuration of Modem: usr288

Options
-------
Initialization:  Enabled
Answer:          Disabled
Dial:            Enabled
Disconnect:      Disabled
Carrier Wait:    Disabled
Ready Wait:      Disabled 

Commands
--------
Initialization:  ATE0M0S0=1\r
Answer:          ATA\r
Dial Prefix:     ATDT
Dial Suffix:     \r
Disconnect:      ATH\r
Escape Sequence: +++

Guard Time:      50

Result Codes
------------
BUSY:            BUSY
CONNECT:	         CONNECT
ERROR:           ERROR
NO ANSWER:       NO ANSWER
NO CARRIER:      NO CARRIER
NO DIALTONE:     NO DIALTONE
OK:              OK
RING:            RING

Set

Defines optional commands for configurable modems.

Keep the following in mind when you enter these command strings:

The strings are case sensitive. If the modem requires upper-case commands, enter the strings in upper case.
You can include nonprintable characters in the set answer, set dial prefix, set dial suffix, set disconnect, set escape-sequence, and set initialization strings.
For most intelligent modems (Hayes-compatible), you must terminate the set answer, set dial suffix, set disconnect, and set initialization strings with a \r (carriage-return character).
You can use the following C language-style escape characters in modem command strings:


\n	Linefeed
\r	Carriage return
\\	Backslash
\xhh	Hexadecimal two-digit number

Syntax: set

answer
dial prefix
dial suffix
disconnect
escape-sequence
guard-time
initialization
result-code busy
result-code connect
result-code error
result-code no-answer
result-code no-carrier
result-code no-dialtone
result-code ok
result-code ring

answer

The modem command that causes the modem to answer incoming calls manually. The default is ATA\r. You must end this string with a carriage-return character (\r). After you set this string, enable its use by entering enable answer.

Example: set answer

Answer command (1-10 characters) [ATA\r]?

dial prefix

The modem commands that cause the modem to prepare to dial the remote modem. The DIAL device sends these commands to the modem before sending the dial address to the modem. Enter the modem's dial command as the last command in this string. Do not include the dial address in this string; the DIAL device uses the destination address you set at the Circuit Config <NET-#> using the set destination command. The default is ATDT.

Example: set dial prefix

Dial prefix (1-20 characters) [ATDT]?

dial suffix

The modem dialing commands that the DIAL device sends to the modem following the dial address. You must end this string with a carriage-return character (\r). Do not include the dial address in this string; the DIAL device uses the destination address you set at the Circuit Config <NET-#> using the set destination command. The default is \r.

Example: set dial suffix

Dial suffix (1-20 characters) [\r]? $ (508) 555-2323 9999\r

In this example, the $ instructs the modem to wait for the calling-card prompt tone and then transmit the calling-card identification sequence that follows the $ symbol.

disconnect

The modem command that causes the modem to hang up the connection (go on-hook). You must end this string with a carriage-return character (\r). The default is ATH\r. After you set this string, enable its use by entering enable disconnect.

Example: set disconnect

Disconnect command (1-10 characters) [ATH\r]?

escape-sequence

The modem command that causes the modem to return to command mode from online mode without closing the connection. If you entered enable disconnect, DIAL devices use this sequence to cause asynchronous modems to return to command mode when the DIAL device must send the disconnect command to the modem. The default is +++. Do not end this sequence with \r.

Example: set escape-sequence

Escape sequence (1-3 characters) [+++]?

guard-time

Sets a period of inactivity to precede and follow the escape sequence you configured using the set escape-sequence command. This period minimizes the possibility that the DIAL device misinterprets data as an escape sequence. The range is 0 to 255, and each unit is equal to 20 milliseconds. The default is 50 (one second).

Example: set guard-time

Guard time (0-255) [50]?

initialization

The modem commands that initialize the modem. You must end this string with a carriage-return character (\r). The software accepts up to 40 characters, however, the maximum length acceptable to modems depends on the brand and model of modem.

Example: set initialization

Initialization commands (1-40 characters) [ATE0M0S0=1\r]?

result-code busy

The code that the modem sends to indicate that the modem detected a busy signal.

Example: set result-code busy

BUSY result code (1-10 characters) [BUSY]?

result-code connect

The code that the modem sends to indicate that the modem established a connection with another modem. Intelligent modems can typically return a number of result codes that begin with the characters CONNECT, with each alternative indicating a different connection speed and other information. The string entered here matches any result code that begins with the same characters.

Example: set result-code connect

CONNECT result code (1-10 characters) [CONNECT]?

result-code error

The code that the modem sends to indicate that the modem received an invalid command. Typically, this means that an initialization command string included an invalid command.

Example: set result-code error

ERROR result code (1-10 characters) [ERROR]?

result-code no-answer

The code that the modem sends to indicate that the modem waited five seconds for a dial tone and then hung up. The modem returns this code instead of NO CARRIER if the @ character is in the dial prefix or dial suffix string.

Example: set result-code no-answer

NO ANSWER result code (1-16 characters) [NO ANSWER]?

result-code no-carrier

The code that the modem sends to indicate that the modem dropped the carrier because of one of the following conditions:

The line is disconnected.
The modem failed to detect carrier after waiting a period that is commonly configurable, depending on the modem, in modem register S7.

Example: set result-code no-carrier

NO CARRIER result code (1-16 characters) [NO CARRIER]?

result-code no-dialtone

The code that the modem sends to indicate that the modem failed to detect a dial tone after waiting a period of seconds that is usually configurable, depending on the modem, in modem register S6. If your modem returns the result code NO DIAL TONE, the DIAL device recognizes it, and you do not need to change this setting.

Example: set result-code no-dialtone

NO DIALTONE result code (1-16 characters) [NO DIALTONE]?

result-code ok

The code that the modem sends to indicate that the modem successfully executed a command or string of commands.

Example: set result-code ok

OK result code (1-10 characters) [OK]?

result-code ring

The code that the modem sends to indicate that the modem detected a ringing signal, indicating an incoming call.

Example: set result-code ring

RING result code (1-10 characters) [RING]?

[Top] [Prev] [Next] [Bottom]