Home WTI User's Guides
cover
Warnings and Cautions
1. Introduction
2. Unit Description
2.2. Back Panel
3. Getting Started
3.1. Communication Parameters
3.2. Apply Power to the APS-16
3.3. Connecting your PC to the APS-16
3.4. Communicating with the APS-16 Unit
4. Hardware Installation
4.1. Configure Setup Switches
4.1.1. Default Baud Rate
4.2. Initialize Unit to Default Settings
4.3. Connecting Devices to the APS-16
5. Configuration
5.1. Access to the APS-16 Command Mode
5.2. Defining and Reading the Site I.D.
5.3. Port Configuration
5.3.1. Configuration Conventions
5.3.2. Port Modes
5.3.3. Command Availability
5.3.4. Port Configuration Menu
6. Operation
6.1. Any-to-Any Mode
6.1.1. Port Connection and Disconnection
6.1.1.1. Using ASCII Commands to Connect Ports
6.1.1.2. Disconnecting Ports
6.1.2. Defining Hunt Groups
6.2. Passive Mode
6.3. Buffer Mode
6.3.1. Reading Data from Buffer Mode Ports
6.3.2. Port Buffers
6.4. Modem Mode
7. Saving Configuration Parameters
7.1. Sending Parameters to a File
7.2. Restoring Saved Parameters
8. Command Reference Guide
8.1. Command Conventions
8.2. Command Response
8.3. Command Summary
8.4. Command Set
A. RS-232 Port Interface
B. Specifications
C. Customer Service
Index
APS-16

8.4. Command Set

 

Wake Up (Access Command Mode) (/^E)

Waking an Any-to-Any Mode or Modem Mode Port will provide access to the Command Mode, allowing the user to enter commands to connect ports, display status and etc.. When the Command Mode is inactive (Port Asleep), the port will only respond to the /^E command. Note that when the password feature has been defined and enabled, the unit will prompt the user to enter a password before allowing access to the Command Mode.

Availability: All (Administrator) / Basic (User) Format: /^E [Enter] Response: The "APS>" prompt will appear.

Sleep (Exit Command Mode) (/X)

Puts the port to sleep and exits the Command Mode. While sleeping, the port will only recognize the /^E (Wake) command. Note that exiting from the Command Mode will not terminate port connections. The /X Command functions as follows:

•                      Any-to-Any Mode: Exits Command Mode.

•                      Modem Mode: Disconnects and resets modem, hang-up message is sent, hardware line to modem drops for 500 ms, and reset message is sent.

 

Availability: All (Administrator) / Basic (User) Format: /X [Enter] Response: (Terse and Verbose) Asleep

Help (/H)

Displays a Help Screen, which lists all APS-16 commands along with a brief description of each command.

Availability: All (Administrator) / Basic (User) Format: /H [Enter] Response: Displays Help Screen

_______ _�f�_�_� ___

Status (/S)

Displays the Status Screen (Figure 3.2), which lists current conditions and parameters for all ports.

Availability: All (Administrator) / Basic (User) Format: /S [Enter] Response: Displays Status Screen

The Status Screen lists the following parameters: Port: Port Number. When the Port Number is followed by a plus sign (+), this indicates port has been granted access to

"All" (Administrator) commands. Name: User-defined Port Name. Status: Indicates current status of each port as follows:

*: Indicates port has accessed Command Mode. Free: Indicates port is not in use. C-nn: Indicates port is connected to Port "nn".

Baud: Lists the Port's baud rate. Com: Lists the port's data bits and parity settings. HS: Handshaking setting: XON/XOFF, RTS/CTS, BOTH, or

NONE. Mode: Any-to-Any, Passive, Buffer, or Modem Mode. Timeout: Indicates status of Timeout Feature. When disabled,

column will read "OFF". When enabled, Timeout Period will be listed. Buf: Lists amount of data stored in port’s buffer. CTS: Lists status of port's input hardware signal. H (high) = active, L (low) = inactive.

Who (View Port Parameters) (/W)

Displays configuration of an individual port, but does not allow the user to change parameters. Ports with Basic (user) command capability cannot display parameters for other ports.

Availability: All (Administrator) / Basic (User) Format: /W [n] [Enter]

Where "n" is the number or name of the desired port.

Response: Displays port parameters.

Example:

To display parameters for a port named "SALES", access the Command Mode from a port with All command capability, and type /W SALES [Enter].

Connect (/C)

Establishes a bi-directional connection between two ports. There are two different types of port connections:

•                      Resident Connect: If the /C command specifies one port name or number, your resident port will be connected to the specified port.

•                      Third Party Connect: If the /C command specifies two port names or numbers, the unit will connect the two ports indicated. A Third Party Connect command must be issued from a third port with "All" command capability. "Basic" ports cannot perform a Third Party Connect.

 

Availability: All (Administrator) / Basic (User) Format: /C <n> [n] [Enter] Where n is the number or name of the port(s) to be connected.

Response: Verbose: Connected nn Terse: 1

Examples: Resident Connect: To connect your resident port to Port 16, access the Command Mode and type /C 16 [Enter].

Third Party Connect: To connect Port 12 to Port 14, access the command Mode from a third port with "All" command capability and type the following /C 12 14 [Enter].

_______ _�f�_�_� ___

Third Party Disconnect (/D)

Invoke the /D command at your resident port to disconnect two other ports. The /D command cannot be used to disconnect your resident port. To disconnect your resident port, issue the Resident Disconnect Sequence (Default = [Enter]+++[Enter])or wait for the Timeout Period to elapse (if enabled).

Availability: All (Administrator) Format: /D[/Y] <n> [n] [n] [Enter]

Where:

 

Response: Verbose: "Are you Sure (y/n)?", if Y, unit will respond with "Disconnected". Terse: 5, if Y, unit will respond with 3.

Example:

To disconnect Port 2 from Port 3 without the "Sure?" prompt, access the Command Mode from a third port with "All" command capability and type one of the following commands:

/D/Y 2 [Enter] or /D/Y 3 [Enter]

Erase Buffer (/E)

Erases data from the buffer for a specified port or several ports. Note that buffered data which has been cleared by the /E command cannot be recovered.

Availability: All (Administrator) Format: /E[/Y] <n> [n] [n] [Enter]

Where:

 

Response: Verbose: "Are You Sure (y/n)?", if Y, the unit will respond with "OK". Terse: 5, if Y, the unit will respond with 0.

Example:

To clear the buffer for Port 3, access the Command Mode from a port with "All" command capability, and type /E 3 [Enter].

Initialize (/I)

Tests internal memory and initializes the unit with the default parameters specified by the Setup Switches. While the memory test is in progress, the Activity LEDs will flash in sequence.

Caution: When the /I command is invoked, the APS-16 will revert to the parameters specified by the SetUp Switches. Any command selected parameters will be lost.

Availability: All (Administrator)

Format: /I[/Y] [Enter] Where /Y is a command option used to suppress the "Sure?" prompt.

Response: Verbose: "Are You Sure (y/n)?", if Y, memory test and initialization begins. Terse: 5, if Y, memory test and initialization begins.

Enter Site ID (/F)

Defines a text string which is used to indicate the location and/or name or each APS-16 unit. The Site I.D. message can be up to 32 characters long, and cannot include non-printable ASCII codes such as nulls and Line Feeds.

Availability: All (Administrator) Format: /F [Enter] Response: (Verbose and Terse) Enter Site ID:

_______ _�f�_�_� ___

Read Site ID (/J)

Displays the user-defined Site I.D. message.

Availability: All (Administrator) / Basic (User) Format: /J [Enter] Response: Displays Site I.D. Message

Set Port Parameters (/P)

Displays a menu which allows the user to select options and parameters for the selected port. Section 5.3 describes the procedure for defining port parameters.

Availability: All (Administrator)

Format: /P [n] [Enter] Where n is the number or name of the port to be configured. If the port number or name is not specified, the Port Configuration menu for your resident port will be displayed.

Response: The Port Parameters Menu is displayed.

Read Port Parameters (/U)

Sends configuration parameters to an ASCII text file as described in Section 7.

Availability: All (Administrator) Format: /U [Enter] Response: The APS-16 will send a series of command lines.