Metasys and Companion

Transcription

1 Metasys Network Technical Manual 636 App. Notes: Operator Devices Section Technical Bulletin Issue Date 0191 Metasys and Companion Application Page 3 Purpose of Application 3 Setting Up the Windows Terminal for Companion 4 Setting Up the WIN.INI File 9 Using Companion in Windows 10 Setting Up Optional Mouse Functions Johnson Controls, Inc. 1 Order No

2 2 App. Notes: Operator Devices Metasys and Companion

3 Application Purpose of Application Metasys provides a convenient interface for facilities that use both Metasys Network and Metasys Companion components. This interface allows you to access Companion Networks from the Metasys Operator Workstation without exiting Windows, even though Companion is not Windows-based. This functionality is provided by the Windows Terminal program, which allows the workstation running Windows to emulate a VT-100 terminal. N1 METASYS Operator Workstation (or PC with Windows) LCP AHU Companion PC NCU NCU RS-232 RS-232 N2 Companion Panel UNT VAV N2 Figure 1: Metasys Operator Workstation Accessing Companion Networks The Companion Networks can connect to the Operator Workstation directly, or through dial-up using a modem and phone lines. In addition, you can connect as many Companion Networks to the workstation as there are serial ports on the workstation. With Windows multi-tasking capabilities, you can display both Metasys and Companion Networks at the same time. You can also display more than one Companion Network, each in its own Terminal window. You can easily switch back and forth between these windows, monitoring and controlling multiple Companion-operated facilities from one centralized location. If the PC you are using does not have Metasys software, but does have Windows 3.0, you can still access Companion Networks after performing the setup procedures described in this document. App. Notes: Operator Devices Metasys and Companion 3

4 In Companion Networks accessed from Metasys (or Windows), Companion s password protection is in effect: operators will not be allowed to access any Companion Networks unless they have a valid Companion password. Note: Please note that this application does not allow you to run Companion software and Metasys software (or Windows) in the same Operator Workstation. Rather, this application allows the Operator Workstation (or a PC with Windows 3.0) to access the Companion Network by emulating the VT-100 class terminal. In other words, the Companion software always resides in the Companion PC or Panel, not in the workstation. This document assumes you are familiar with Windows. If you need more information, see your Windows manual. Setting Up the Windows Terminal for Companion To access Companion, the workstation running Windows must be configured to emulate a VT-100 Class terminal. You do this with the Windows Terminal program. Using Terminal, you set up one terminal configuration file for each Companion Network connected to the workstation. The procedure for setting up the terminal configuration file for direct-connect or dial-up Companion Networks is basically the same. However, there are a few differences for a dial-up connection. These differences are explained after the following steps. To set up Windows to access a Companion Network: 1. Set up the cable connections between the Companion PC or Panel and the serial port of the workstation with Windows. Use the same cable that connects Companion to a remote terminal. This cable is described in the PC or Panel Version Technical Bulletins in the Metasys Companion Technical Manual. 2. In Windows, display the Program Manager. You can also access the Program Manager from the Network Map. To do so, display the Network Map Exit menu. Then select Program Manager. The Program Manager will appear over the Network Map. 3. Select the Accessories icon. The Accessories window appears. 4. Select the Terminal icon. The Terminal window appears as shown on the following page. After you set up the terminal configuration file, this is the window that will display the Companion screen. 4 App. Notes: Operator Devices Metasys and Companion

5 Figure 2: Terminal Window 5. Select the Settings option in the menu bar. The Settings menu appears. 6. Select the Terminal Emulation option. The Emulation dialog box appears, with the correct terminal emulation selected by default. Figure 3: Emulation Dialog Box 7. Select the default by pressing Enter. Note: Pressing Enter is the same as clicking the OK button. 8. From the settings menu, select the Terminal Preferences option. The Preferences dialog box appears. 9. In the Terminal Preferences dialog box, select the settings shown on the following page. App. Notes: Operator Devices Metasys and Companion 5

6 Figure 4: Terminal Preferences Dialog Box 10. To enter the settings, press Enter. 11. From the Settings menu, select the Communications option. The Communications dialog box appears. 12. Select the following settings. Match the baud rate to the baud rate specified in Companion s Communications I/O Setup screen. For the PC Version, this is the remote terminal baud rate setting. For the Panel Version, this can be the local or remote terminal setting, depending on the type of connection. 6 App. Notes: Operator Devices Metasys and Companion

7 If you are connecting more than one Companion Network to different serial ports of the workstation, each terminal configuration file should have a different serial port setting (e.g., COM1, COM2, COM3) in the Connector field of the Communications dialog box. The Connector field has a scroll bar that allows you to select additional serial ports. If you are using the same modem (port) for dial-up connection to different networks, the configuration files may have the same serial port setting (but different phone numbers). Figure 5: Communications Dialog Box 13. To enter the settings, press Enter. 14. From the File menu, select the Save option. The Save dialog box appears. 15. Name the new terminal configuration file. The name can be up to eight characters long and must be followed by a TRM extension. Windows will automatically enter a.trm extension if none is entered. If you are going to connect to only one Companion Network, you can give the file a generic name like COMPANON.TRM. If you intend to connect to more than one Companion Network, give each terminal configuration file a unique name that identifies the network. For example, name the file for the Companion Network connected to COM port 1 COMPAN1.TRM. Name the file for the network connected to COM port 2 COMPAN2.TRM. Remember that each Companion Network must have its own terminal configuration file, and each file must have a unique name. 16. To save the new configuration file, press Enter. After you save the file, edit the WIN.INI file so that the Terminal icon appears at the bottom of the workstation screen. This procedure is described in this document, under Setting Up the WIN.INI File. App. Notes: Operator Devices Metasys and Companion 7

8 Setting Up Terminal for a Dial-Up Companion Network To connect the workstation with Windows to a dial-up Companion Network, follow the same procedure described in the previous section for a direct-connect Companion Network, with the following additions: Make the modem connections. Specify the phone number of the dial-up Companion Network. Add modem commands to the terminal configuration file. Make the Modem Connections Make the modem connections and make sure the appropriate modem commands are downloaded. Use Companion s standard modem cable and modem commands. For more information, see the PC or Panel Technical Bulletins in the Metasys Companion Technical Manual. Specify the Phone Number When you create the terminal configuration file for the dial-up network, use the Phone Number option in the Settings menu to specify the phone number. This is the number the workstation will call to access the dial-up Companion Network. Accept the default timeout value (30 seconds). Enter the Additional Modem Commands When you create the terminal configuration file for the dial-up Companion Network, select the Modem Commands option in the Settings menu to display a dialog box for entering Modem commands. Default values will appear in the fields. Change the defaults to the settings shown in the following figure. Figure 6: Modem Commands Dialog Box 8 App. Notes: Operator Devices Metasys and Companion

9 The phone number and modem commands will be saved when you save the terminal configuration file. After you save the file, edit the WIN.INI file so that the Terminal icon appears at the bottom of the workstation screen. This procedure is described below. Setting Up the WIN.INI File Set up the WIN.INI file so that the Terminal icon automatically appears at the bottom of the workstation screen, enabling access to the Companion Network. Because only certain Metasys passwords allow the operator to exit Metasys and go to the Program Manager, this step is necessary so that all operators with valid Companion passwords can access the Companion Networks, without exiting Metasys. To set up the WIN.INI file: 1. From Windows, display the Program Manager. (You can also display the Program Manager from the Network Map by selecting Program Manager in the Exit menu.) 2. From the Program Manager, select Main. The Main window is displayed, displaying the File Manager, Control Menu, and other icons. 3. Select the File Manager icon. The File Manager is displayed. 4. Find the WIN.INI file for the network. It should be in the Windows directory, or in the directory in which Windows is installed. 5. Double-click the WIN.INI file. This displays Notepad, which is a text editor that allows you to edit the WIN.INI file. If you are using a Metasys workstation, the second line of the WIN.INI file displays the following: load=n1hook If you are not using a Metasys workstation, the second line displays: load= 6. Add the name of the Companion configuration file to this line. Make sure you include the.trm extension. For example, if you were to add a configuration file named COMPAN3, the line would look as follows: load=n1hook compan3.trm If it is not a Metasys workstation, it would look like this: load=compan3.trm 7. Save the changed WIN.INI file. App. Notes: Operator Devices Metasys and Companion 9

10 8. Exit Windows and start Windows again. The Terminal icon appears at the bottom of the screen. To access the Companion Network, click the icon. The initial Companion screen is displayed inside the Terminal window, prompting you to enter your password. Once you re logged on, you can perform all the functions allowed by your password. For special information on using Companion with Windows, see the Using Companion in Windows section of this document. For general information on using Companion, see the Metasys Companion User s Manual. If necessary, set up additional direct-connect or dial-up Companion Networks using the same procedure described above. Using Companion in Windows Accessing a Direct- Connect Companion Network Accessing a Dial-Up Companion Network When the physical connections between Companion and the workstation are established, and the terminal configuration file that allows VT-100 emulation is set up, you are ready to access the Companion Network from Windows. Once you ve accessed Companion and logged on, you can use all the functions allowed by your password. Note: For Companion s four function keys to be available, you must press the Scroll Lock key after you access the Companion Network. To access a direct-connect Companion Network: 1. Double-click the Terminal icon. The Terminal window appears, displaying the initial Companion screen. 2. Press the Scroll Lock key. To use Companion s four function keys, the Scroll Lock must be on. 3. Log on Companion. You may now use all the functions allowed by your password. To access a dial-up Companion Network: 1. Double-click the Terminal icon. The Terminal window appears. 2. Select the Phone option in the menu bar. The Phone menu appears. 3. Select the Dial option. If the connection is successful, the Companion screen appears. 4. Press the Scroll lock key. For Companion s four function keys to be available, the Scroll Lock must be on. 5. Log on Companion. You may now use all the functions allowed by your password. 10 App. Notes: Operator Devices Metasys and Companion

11 Switching to a Different Companion Network Minimizing the Terminal Window You can switch between Companion Networks using the Terminal window File menu. Because each Companion Network has its own configuration file, by loading a new configuration file into the Terminal, you access a different Companion Network. For each Companion Network you log on to, you must have a valid password. To switch to another Companion Network: 1. Quit out of the Companion Network you are currently using with the Quit option in Companion s Main menu. Do not close the Terminal window. 2. Select the File option in the Terminal menu bar. The File menu is displayed. 3. Select the Open option in the File menu. The Open File dialog box is displayed, listing the existing terminal configuration files. 4. Select the file for the Companion Network you want to access. If it is a dial-up connection, select the Dial option in the Phone menu to call the new Companion Network. The Terminal window displays the new Companion screen, prompting you to enter your password. 5. Log on Companion. You may use all functions allowed by your password. If you want to keep Companion active but need more room on the workstation screen for other applications, minimize the Terminal window that displays Companion. The minimized window becomes a Terminal icon in the lower portion of the screen and Companion remains active. When you double-click the icon to restore the window, the Companion screen will again be displayed in the Terminal window. We advise that you use this method rather than closing and opening the Terminal window that displays Companion. If you minimize Companion s Terminal window, Companion will inform you of alarm reports with a tone (if the alarm tone is enabled). You can then maximize the icon, view the alarm report on the Companion screen, and respond to the alarm as necessary. Quitting Companion IMPORTANT: Do not close Companion s Terminal window without first quitting Companion. Press Q in the Main menu to quit Companion. Then close Companion s Terminal window. App. Notes: Operator Devices Metasys and Companion 11

12 If you close Companion s Terminal window without first quitting Companion, there will be degraded system performance the next time you access the Companion Network. Specifically, portions of the screen will not be visible. Remember, you always have the option of simply minimizing Companion s Terminal window, which keeps Companion active but out of the way. To quit Companion: 1. Display Companion s Main menu. 2. Press Q to select the Quit option. The Terminal window appears empty. 3. Close the Terminal window (by double-clicking the Control-menu box). Disconnecting a Dial-Up Connection Setting Up Optional Mouse Functions Use the same Quit procedure to hang up from a dial-up connection: press Q from the Main menu to quit Companion. Then close the Terminal window. This will disconnect the workstation from the dial-up Companion Network. The following information on setting up and using the mouse to select functions in the Terminal window is optional. Regardless of whether you set up the mouse, you can always use the function keys on the keyboard to select the Cancel, Save, More, or Acknow functions (as long as Scroll Lock is on). Normally, the mouse will not work in the Companion section of the Terminal window (the mouse will work as usual with the Terminal window itself). However, when you set up the Terminal configuration file, you can set up limited mouse capabilities with the Function Keys option. This allows you to select function key options (e.g., Cancel, Save, More) by mouse-clicking a section on the screen, rather than by pressing the function key on the keyboard. If you set up the mouse to select functions, the function keys will be displayed as boxes at the bottom of the Terminal window. You use the mouse to click one of these boxes to select the function. For example, click the box marked Save to perform the (F2) Save function. Click the box marked Cancel to perform the (F1) Cancel function. To set up the mouse to select functions: 1. In the Terminal window, select Settings in the Terminal menu bar. The Settings menu is displayed. 2. Select the Function Keys option. The Function Keys dialog box appears. 12 App. Notes: Operator Devices Metasys and Companion

13 3. Enter the following Key Names and Commands. The name will appear in the box representing the function key at the bottom of the Terminal window. The command tells Terminal what Companion keystrokes to simulate when you click the box. Figure 7: Function Keys Dialog Box 4. To enter the settings, click the OK button. 5. Save the file with the Save option in the File menu. The function key settings will be saved with the terminal configuration file. Using the Mouse If you set up function keys as described above, the Terminal window displaying Companion will look like this. App. Notes: Operator Devices Metasys and Companion 13

14 Figure 8: Terminal Window with Function Keys To access a Companion function like Cancel or Save, use the mouse to click the function you want to perform. When you move the pointer to the section of the window displaying the function boxes, the mouse pointer becomes a pointing hand. Setting Up Additional Mouse- Selectable Functions You can also use the Function Keys dialog box to set up additional mouseselectable functions. For example, you can name one of the function boxes Net Sum, and enter a command that tells Terminal to display a Network Summary when you click the Net Sum function box. The command is a string of characters that tells Terminal what keystrokes to simulate when you click the function box. For example, the command string for displaying a Network Summary is: ^[OP^[OPNS^M Terminal executes this command by simulating the keystrokes as follows. ^[OP Equals a Cancel, which backs up one screen. By repeating Cancel, you tell Terminal to return to the Main menu from wherever you are in Companion. ^[OP N S Repeats the Cancel. Displays the Main menu. Selects the Network option in the Main menu, which displays the Network menu. Selects the Summary option in the Network menu, which displays the field for selecting a starting network address. 14 App. Notes: Operator Devices Metasys and Companion

15 ^M Equals pressing the Enter (or Return) key, which accepts the default starting network address number and displays the Network Summary. Here s another example that tells Companion to quit from any screen. (Otherwise, you would have to return to the Main menu to quit.) You could name the key Quit, and enter the following command: ^[OP^[OPQ Terminal simulates the keystrokes for this command as follows. ^[OP Cancel. ^[OP Cancel. Returns to the Main menu from any screen in Companion. Q Selects the Quit option from the Main menu, which logs you off and exits Companion. As you can see from these examples, Windows gives you flexibility in assigning mouse-selectable functions. You ll find more information in the Windows User s Guide, in the Terminal chapter, under Assigning Function Keys. App. Notes: Operator Devices Metasys and Companion 15

16 Notes Controls Group FAN E. Michigan Street Metasys Network Technical Manual P.O. Box 423 Revision Date 0191 Milwaukee, WI Printed in U.S.A. 16 App. Notes: Operator Devices Metasys and Companion