5.   Configuration

5.1.   Access to the APS Command Mode

When the APS-8M Command Mode is active, commands can be invoked to select parameters, and connect or disconnect ports.

Notes:

• Command Mode cannot be accessed from a Buffer Mode Port, Passive Mode Port, or any port that is currently connected to another APS-8M port.
• Supervisor Level Commands cannot be accessed at any APS-8M port where the Supervisor Level has been disabled.

1. Start your communications program (e.g. HyperTerminal or ProComm®.) Make certain the APS and the communications program are set for the same parameters (e.g. baud rate, parity, etc.)



2. Access the Command Mode.



1. Local Access:  To access the command mode from a local PC that is connected to the APS via cable, press [Enter].



1. There must be no other characters preceding [Enter]. If you have already hit other keys, press [Enter] twice.



2. If the Supervisor Password has been defined, the password prompt will be displayed. Key in your Supervisor or Port password and press [Enter]. The "APS>" prompt will appear.



2. Modem Access:  To access the command mode via modem, proceed as follows:



1. Dial the number for the APS-8M's internal modem, or (if present) for an external modem connected to one of the APS-8M's RS232 ports.



2. If you have defined the Supervisor Password, a prompt will be displayed. Key in your Supervisor or Port password and press [Enter]. If the Supervisor Password has not been defined, just press [Enter]. The "APS>" prompt will appear.

5.2.   System SetUp Ports

Ports 1 and 2 are designated as System SetUp Ports, and will therefore, always permit password protected access to Supervisor Level command functions, even when the unit is reinitialized to default parameters.

In order to ensure that access to command functions is always available, Ports 1 and 2 cannot be configured as Buffer Mode or Passive Mode Ports (Buffer and Passive Mode Ports are not able to access the Command Mode.) In addition, Ports 1 and 2 always permit password protected access to Supervisor Level commands; the Supervisor Mode cannot be disabled at these two ports.

5.3.   Password Functions

The APS features two different types of passwords; the Supervisor Password and the Port (User) Passwords. The Supervisor Password allows system administrators to invoke unit configuration commands, and the Port Passwords allow users to access specific ports in order to create connections between permitted ports or view port configuration parameters.

5.3.1.   The Supervisor Password

The Supervisor Password allows access to higher level APS-8M configuration commands, which administrators can employ to select communication parameters, assign port access rights, and perform other system management tasks.

After the Supervisor Password has been defined (via the System Parameters menu), the APS-8M will display a password prompt whenever you attempt to access the command mode. If the correct Supervisor Password is entered, the APS command mode then starts up in Supervisor Mode. Supervisor Level commands are summarized in Section 11.3 of this User's Guide.

Notes:

• If the Supervisor Password is not defined, then Supervisor Level commands will be available to all ports, and port access and configuration functions will not be password protected.
• If you wish to restrict user ports from changing APS-8M configuration parameters or connecting to restricted ports, the Supervisor Password must be defined.
• When the Supervisor Password is defined, the APS-8M will display a password prompt when you attempt to access the command mode. Any RS232 port that has not been assigned a Port Password, can then only be accessed using the Supervisor Password.
• When defining a Supervisor Password, it is strongly recommended that you record the password for future use. If you forget or lose your Supervisor Password, you will not be able to access Supervisor Level Commands. In this case, the only way to access the Supervisor Mode, is to reinitialize the APS-8M to default values as described in Section 4.2.

Normally, the Supervisor Password can be entered at any port in order to gain access to Supervisor Level commands. Note that if you wish to completely deny a port's access to Supervisor Mode (even with the Supervisor Password), the Port Parameters menus (/P) can be used to disable the Supervisor Mode at ports 3 through 8. The Supervisor Mode cannot be disabled at System SetUp Ports 1 and 2.

Note that if the unit is reset to default parameters, all ports will revert to the default state, where Supervisor Level commands are available to all ports, without password protection.

5.3.2.   The Port Passwords

The Port Passwords (or User Passwords) allow system administrators to restrict access to a specific group of ports. When the APS-8M command mode is accessed with a Port Password, users may only connect to the RS232 Ports to which they have been granted access, and review configuration parameters for those ports. Port Passwords do not grant access to APS-8M configuration commands.

The configuration menus (/P) for each RS232 port allow a Port Password to be assigned to each individual port. In order to allow a Port Password to grant access to a group of APS-8M ports, the same Port Password is assigned to each port in the group.

For example, if the Port Password "test" is assigned to ports 3, 4, and 5, then when "test" is entered at the Password Prompt, the user will only be able to connect to ports 3, 4, and 5, and will only be able to view parameters for ports 3, 4, and 5.

If desired, all APS-8M ports can function as both a Supervisor Port and a User Port, depending on which password is entered at the login prompt. However, if you wish to prevent a port from being able to access the Supervisor Mode at all (even with the Supervisor Password), the Supervisor Mode can be disabled at the RS232 Ports using the Port Configuration menus as described in Section 5.5. Note however, that the Supervisor Mode cannot be disabled at Ports 1 and 2; these ports are designated as SetUp Ports, and are always allowed password protected access to Supervisor Level commands.

Note:  When Port Passwords are defined, the APS-8M will not allow you to select a Port Password that has already been used as the Supervisor Password.

5.4.   Defining the Site ID and Supervisor Password

Before configuring individual ports, the Site ID and Supervisor Password should be defined. The Site ID indicates the location or name of the APS- 8M; the Supervisor Password restricts access to sensitive command functions. The Site ID and Supervisor Password are defined via the System Parameters menu (/F).

Notes:

• The Site ID cannot include double quotes.
• The Supervisor Password cannot include an asterisk, forward slash, spaces, or double quotes.
• Both the Site ID and Supervisor Password will be cleared if the APS is initialized to default settings.
• The APS will not allow you to select a Supervisor Password that is the same as an existing Port Password.
• The System Parameters Menu is only available in Supervisor Mode.

1. Access the Command Mode. Type /F  [Enter] to display the System Parameters Menu.



2. Site ID Message:  (Up to 32 chars.; Default = undefined) Type 1 and press [Enter], a prompt will appear. Key in the desired text and press [Enter]. The Site ID will be listed on the Port Status and Port Diagnostic Screens.



3. Supervisor Password:  (Up to 16 characters; Default = undefined) Type 2 and press [Enter], a prompt will appear. Key in the desired password, then press [Enter]. The APS-8M will prompt you to re-key the password to confirm spelling and capitalization. Key in the password a second time, and then press [Enter].

Notes:

• The Supervisor Password is case sensitive. Make certain to note the exact password entered, including the case of each letter.
• Make certain to write down your Supervisor Password. If the password is lost or forgotten, you will not be able to access Supervisor Level commands unless you initialize the unit and clear all parameters as described in Section 4.3.

5.5.   Port Configuration

5.5.1.   Configuration Conventions

When responding to prompts, invoking commands, and selecting items from the port configuration menus, note the following:

• To select an item from a Port Configuration menu, key in the number for the item and press [Enter].



• To clear an item in a Port Configuration menu, enter the number for the desired item and press [Enter]. When the prompt appears, press [Space] and then press [Enter].
• When defining the Port Name, do not use the forward slash character (/), double quotes ("), the asterisk character (*), or blank spaces.
• Port Names cannot begin with a number.
• Refer to the instructions in each screen for additional functions available under that screen.
• To exit a menu or prompt without changing its current value, press [Esc].
• Passwords and port names are case sensitive. When defining passwords and port names, note the exact text, including the case of each character.
• If you are configuring the APS-8M unit via modem, communication parameters will not be changed until after you exit from command mode and disconnect from the APS-8M unit.

5.5.2.   Port Modes

The APS offers four different port operation modes; Any-to-Any Mode, Passive Mode, Buffer Mode, and Modem Mode.  The Port Modes function as follows:

• Any-to-Any Mode:  Allows communication between connected ports.  Any-to-Any Mode Ports can be connected to other Any-to-Any Mode, Passive Mode, Buffer Mode, or Modem Mode Ports by accessing Command Mode and invoking the /C command (see Section 8.1.1). The Any-to-Any Mode is available to all APS ports, except Port 8 (the External Modem Port).



• Passive Mode:  Allows communication between connected ports, but does not allow access to Command Mode. Passive Mode Ports can be connected by accessing Command Mode from a free Any-to-Any or Modem Mode port and invoking the /C command (see Section 8.1.1). The Passive Mode is not available to Ports 1, 2, or 8.



• Buffer Mode:  Allows collection and storage of data received from connected devices.  Collected data can be retrieved by accessing Command Mode from a free Any-to-Any or Modem Mode Port, and issuing the Connect (/C) Command.  Note that the Buffer Mode also allows pass- through communication with the connected device. The Buffer Mode is not available to Ports 1, 2, or 8.



• Modem Mode:  A port configured for the Modem Mode can perform all functions normally available in Any-to-Any Mode, but the Modem Mode also allows definition of a Hang-Up String, Reset String, and Initialization String. Any APS RS232 port can be configured for the Modem Mode, and Port 8 (the External Modem port) is always configured for Modem Mode.

For more information on Port Modes, please refer to Section 8.

5.5.3.   RS232 Port Configuration Menus

The Port Configuration Menus are used to select options for each of the APS RS232 ports. Parameters selected via these menus will stay in effect until the unit is initialized or the /P command is used to reconfigure the port. After initialization, parameters will revert to the defaults specified by the SetUp Switches.

 PORT PARAMETERS #02

  1.  Port Name:             (undefined)
  2.  Password:              (undefined)
  3.  Baud Rate:             9600
  4.  Bits/Parity:           8-None
  5.  Stop Bits:             1
  6.  Handshake Mode:        RTS/CTS
  7.  Port Mode:             Any-to-Any
      74.  DTR Output:       Pulse
  8.  Supervisor Mode:       Permit
  9.  Logoff Character:      ^X
 10.  Sequence Disconnect:   One Character
 11.  Timeout Disconnect:    Off
 12.  Response Type:         Verbose
 13.  Command Echo:          On
 14.  Accept Break:          Yes

 Enter:  "<" Previous Port,
         ">" Next Port,
         <ESC> Exit ... 

Figure 5.1:   Port Configuration Menu (Port 2 Shown)

To select port parameters, proceed as follows:

1. Access the Command Mode. If the password prompt is displayed, key in your Supervisor Level Password.



2. Type /P, followed by the number of the port to be configured, and press [Enter].  For example, to configure Port 2, type /P 2  [Enter].  The Port Configuration menu will appear (Figure 5.1).



1. If the /P Command is entered without the port number (e.g. /P [Enter]), the configuration menu for your resident port will be displayed.



2. The /P command is only available in the Supervisor Mode.

The Port Configuration menu offers the following options:

1. Port Name:  (Up to 16 characters) Assigns a name to the port. (Defaults: Ports 1 through 7 = undefined; Port 8 = "Internal_Modem").



2. Password:  (Up to 16 chars.) Defines the Port Password for this port. Note that identical Port Passwords are generally assigned to several ports. When this password is entered at the login prompt, the user will then have access to all ports that share this password. (Default = undefined).

Notes:

• The Port Password is not displayed by the Port Parameters menu. When the Port Password has been defined, the field for this item will read "defined". To display Port Passwords, invoke the /SP or /WP commands as described in Section 7.
• The APS will not allow you to define a Port Password which is the same as the existing Supervisor Password.

3. Baud Rate:  Selects the baud rate for the port.  Can be set to any standard rate from 300 bps to 115.2K bps. (Default = Selected By SetUp Switches 1, 2, and 3.)



4. Bits/Parity:  (Default = 8-None.)



5. Stop Bits:  (Default = 1.)



6. Handshake Mode:  Selects the handshake format for this port; XON/XOFF, RTS/CTS (hardware), Both, or None. (Default = RTS/CTS.)



7. Port Mode:  Defines the operation mode for this port. (Default: Ports 1 through 7 = Any-to-Any Mode; Port 8 = Modem Mode.)
   
   

   Notes:

   • Ports 1 and 2 cannot be configured for Passive Mode or Buffer Mode.
   • Port 8 is always configured for Modem Mode. Port 8 cannot be set to Any-to-Any Mode, Buffer Mode, or Passive Mode.
   
   
   When Any-to-Any, Passive, or Buffer Mode is selected, the unit will display the DTR Output prompt as shown in Figure 5.1. The DTR Output prompt is not displayed when Modem Mode is selected.
   
   
   74. DTR Output:  Determines how DTR will react when this port disconnects. DTR can be held low, held high, or pulsed for 0.5 seconds and then held high. In the default state, DTR will pulse for 0.5 seconds and then remain high. For more information on hardware lines, please refer to Appendix A. (Default = Pulse).
   
   
   
   When Port Mode (menu Item 7) is set to Modem Mode, the menu will include additional prompts (see Figure 5.2), which are used to define the following:

 PORT PARAMETERS #08

  1.  Port Name:             (undefined)
  2.  Password:              (undefined)
  3.  Baud Rate:             9600
  4.  Bits/Parity:           8-None
  5.  Stop Bits:             1
  6.  Handshake Mode:        RTS/CTS
  7.  Port Mode:             Modem
      71.  Reset String:     ATZ
      72.  Init String:      ATM0&C1&D2S0=1
      73.  Hang-Up String:   (undefined)
  8.  Supervisor Mode:       Permit
  9.  Logoff Character:      ^X
 10.  Sequence Disconnect:   One Character
 11.  Timeout Disconnect:    Off
 12.  Response Type:         Verbose
 13.  Command Echo:          On
 14.  Accept Break:          Yes

 Enter:  "<" Previous Port,
         ">" Next Port,
         <ESC> Exit ... 

Figure 5.2:   Port Parameters Menu; Modem Mode (Port 8 Shown)

71. Reset String:  If necessary, this prompt can re-define the modem reset string, which is sent prior to the Initialization string. (Up to 48 Characters, Default = ATZ).



72. Initialization String:  Defines a command string that is sent to initialize a modem to settings required by your application. (Up to 48 Characters, Defaults: Port 1 through 7 = AT&C1$D2S0=1; Port 8 = ATM0&C1$D2S0=1).



73. Hang-Up String:  Although the APS will pulse the DTR line to hang-up an attached modem, the Hang-Up string is often useful for controlling modems that do not use the DTR line. (Up to 48 Characters, Default = undefined).

Notes:

• When communicating with the APS via modem, communication parameters will not be changed until you exit from command mode and discontinue the modem connection to the unit.
• For a list of basic AT commands for the APS-8M's Internal Modem, please refer to Section 6. For a complete listing of all available AT commands and S-Registers, please visit the User's Guide Archive at the WTI web site: http://www.wti.com/guides/guidarch.htm

8. Supervisor Mode:  Permits or denies access to Supervisor Mode. When enabled (Permit), and the valid Supervisor Password is entered, the port will allow access to Supervisor Level commands. When disabled (Deny), the port may not enter Supervisor Mode, even when the Supervisor Password is entered. (Default = Permit).

Note:  The Supervisor Mode cannot be disabled at Ports 1 or 2.

9. Logoff Character:  Defines the Logoff Character for this port.  The Logoff Character determines the command(s) or character(s) that must be issued at this port in order to disconnect from a second port (Resident Disconnect).  (Default = ^X ([Ctrl] plus [X])).

Note:  When redefining the Logoff Character, make certain to select a character that does not normally occur in your data. This will prevent the unit from accidentally disconnecting ports in the middle of a data transfer. For example, if the Logoff Character is defined as "s", then the ports will disconnect whenever the letter "s" is detected.

10. Sequence Disconnect:  Enables/Disables and configures the Resident Disconnect command. This prompt offers the option to either disable the Sequence Disconnect, or select a one character format or a three character format. (Default = One Characters). Note the following:



• When a Resident Connection is initiated, the APS will send a message which lists the connected ports, and displays the one character or three character command that will be required in order to disconnect.



• The One Character Disconnect sequence is intended for situations where the destination port will not receive the disconnect command. When the Three Character format is selected, the disconnect sequence will pass through to the destination port prior to breaking the connection.



• When the One Character format is selected, resident connections are terminated by entering the selected Logoff Character only. There is no need to press [Enter] before and after the Logoff Character when the One Character format is selected.



• When the Three Character format is selected, the Resident Disconnect Sequence will use the format "[Enter]LLL[Enter]", where L is the selected Logoff Character.



11. Timeout Disconnect:  Enables and selects the Timeout Period for this port. If enabled, and the port does not receive or transmit data for the specified Timeout Period, the port will disconnect. In Any-to-Any Mode, Passive Mode, or Buffer Mode, the default setting for this item is "OFF". When the port is set for Modem Mode, the default setting for this item is 15 minutes.

Notes:

• The Timeout Disconnect is also applied to non-connected ports that are left in Command Mode. If no additional data activity is detected, an unconnected port will exit from command mode when the Timeout Disconnect value expires.
• When connected ports time out and are disconnected, both ports will also exit from Command Mode.

12. Response Type:  Selects the type of messages that this port will send in response to commands.  The user can select Verbose (English Text), Terse (Numeric / Abbreviation), or Quiet Mode (No Response). (Default = Verbose.)



13. Command Echo:  Enables or Disables the command echo for this port. (Default = On.)



14. Accept Break:  Determines whether the port will accept breaks received from the attached device, and pass them along to a connected port. When enabled, breaks received at this port will be passed to any port that this port is connected to, and sent along to the device connected to the other port. When disabled, breaks will be refused at this port, and hence, not sent to the other port. (Default = Yes.)

5.6.   Copying Parameters to All Ports

The /CP command (Copy Port Parameters) provides a convenient means for selecting similar parameters for all APS RS-232 ports.

When the /CP command is invoked, the unit will display a menu which allows you to select port communication parameters, then copy them to all APS RS-232 ports. The Copy Port Parameters menu can be used to set all parameters for all RS-232 Ports, or define only a select group of parameters and then copy them to all ports.

Notes:

• The /CP command is only available in Supervisor Mode.
• The Copy Port Parameters Menu will not display the Port Password. This field will read either "undefined" or "defined", depending upon whether or not the Port Password has been specified.
• The /CP command cannot be used to set Ports 1 and 2 to Passive Mode or Buffer Mode (Port Mode, Item 7.)
• The /CP command cannot be used to disable the Supervisor Mode at Ports 1 and 2 (Supervisor Mode, Item 8.)
• The /CP command cannot be used to change the Port Mode at Port 8 (Internal Modem Port.)

COPY PORT PARAMETERS:

 1. Port Name:
 2. Password:               (undefined)
 3. Baud Rate:
 4. Bits/Parity:
 5. Stop Bits:
 6. Handshake Mode:
 7. Port Mode:
    74. DTR Output:
 8. Supervisor Mode:
 9. Logoff Character:
10. Sequence Disconnect:
11. Timeout Disconnect:
12. Response Type:
13. Command Echo:
14. Accept Break:

(Note: Ports 1 & 2 will NOT have restricted values changed.)
Enter: Parameter # <CR> to define parameter value to copy to all ports,
       -<CR> to remove all values set,
       X<CR> to exit WITHOUT copy,
       <ESC> to copy to all ports and exit ... 

Figure 5.3:   The Copy Port Parameters Menu

To select common parameters for all APS RS-232 ports, proceed as follows:

1. Access the APS command mode. If the password prompt is displayed, key in your Supervisor Level Password.



2. At the command prompt, type /CP and press [Enter], the menu shown in Figure 5.3 will be displayed.



3. Selecting Parameters:  To select parameters to be copied, key in the number for the desired parameter, press [Enter], and then follow the instructions in the submenu. Note that it is not necessary to define all port parameters, for example, the /CP command could be used to select only the Baud Rate for all ports.

Note:  The /CP command will only copy the parameters that are currently displayed by the Copy Port Parameters menu. Note that although the Port Password is not displayed, the selected password will be copied if the field for this item reads "defined".

4. Clear Menu:  After defining several parameters, if you wish to clear the /CP menu and start again, type - (dash) and press [Enter], the menu will be reset.



5. Exit Without Copy: To exit from the Copy Parameters menu without copying selected parameters to all RS232 ports, type X and then press [Enter]. The APS will exit from the Copy Parameters menu and return to the command prompt.



6. Copy Parameters:  When you have finished selecting parameters, press [Esc] to copy the selected parameters to all APS RS-232 Ports and exit from the Copy Port Parameters menu. Note that the APS will display a "Sure" prompt before copying parameters to other ports.

5.7.   Save User Selected Parameters

Although this step is optional, it is strongly recommended to save all user-defined parameters to an ASCII file. This will allow quick recovery in the event of accidental deletion or reconfiguration of port parameters. Section 9 describes the procedure for saving configuration parameters to an ASCII file.