BASEstar[TM] Open DAS for Allen-Bradley Data Highway[TM] on_OpenVMS[TM]______________________________________ Installation and User's Guide Order Number: AA-Q5G1D-TE April 2000 This manual describes how to install and use the BASEstar Open Device Access Software for Allen- Bradley Data Highway. Revision/Update Information: This is a revised document. Operating System and Version: OpenVMS/Alpha Version 6.1 Operating System and Version: OpenVMS/VAX Version 6.1 Interface Software and Version:ASEstar Open Version 3.1 Software Version: Device Access Software for Allen-Bradley Data Highway, Version 3.1A Compaq Computer Corporation Houston, Texas ________________________________________________________________ April 2000 © 1994 Compaq Computer Corporation. COMPAQ, VAX and VMS Registered in U.S. Patent and Trademark Office. BASEstar and OpenVMS are trademarks of Compaq Information Technologies Group, L.P. in the United States and/or other countries. PLC, PLC-2, PLC-3 and PLC-5 are registered trademarks of Allen-Bradley Company Inc. PLC-5/250, SLC, SLC 500, SLC 5/01, SLC 5/02, SLC 5/03, SLC 5/04, SLC 5/05, Data Highway, DH+ and Data Highway Plus are trademarks of Allen-Bradley Company, Inc. All other products mentioned herein may be trademarks or registered trademarks of their respective companies. Confidential computer software. Valid license from Compaq or authorized sublicensor required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentaion, and Technical data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. Compaq shall not be liable for technical or editorial errors or omissions contained herein. The information in this document is subject to change without notice. This document is available on CD-ROM. This document was prepared using DECdocument, Version 3.3. _________________________________________________________________ Contents Preface................................................... vii 1 Overview 1.1 Description................................... 1-1 1.2 Device Communications......................... 1-2 1.3 Supported Functions and Devices............... 1-2 2 Installing and Configuring the DAS 2.1 Installation Requirements..................... 2-1 2.1.1 Hardware.................................. 2-1 2.1.2 Software.................................. 2-3 2.1.3 Disk Space................................ 2-4 2.2 Installing the DAS............................ 2-4 2.2.1 Files Created During Installation......... 2-7 2.2.2 Installation Messages..................... 2-7 2.3 Postinstallation Tasks........................ 2-10 2.3.1 Editing the Configuration Files........... 2-10 2.3.1.1 Editing ODS Registrations............... 2-11 2.3.1.2 Editing BASEstar Open Protocol Profile Definitions............................. 2-14 2.3.1.3 Editing VMD Definitions................. 2-15 2.3.1.4 Configuration Files..................... 2-18 2.3.2 Configuring Ports......................... 2-23 2.3.3 Configuring TELNET Access................. 2-24 2.3.4 Setting Up Plant-Floor Equipment.......... 2-25 2.4 Tracing device communications................. 2-26 2.5 Failures During Product Use................... 2-27 iii 3 Using the DAS 3.1 Accessing Allen-Bradley Functions............. 3-1 3.2 Supported Functions........................... 3-2 3.2.1 Connect, Conclude and Abort Functions..... 3-3 3.2.2 Read and Write Variable Functions......... 3-4 3.2.3 Read and Write Data Point Functions....... 3-9 3.2.4 Receiving Indications..................... 3-14 3.2.4.1 Write Indications....................... 3-14 3.2.4.2 Abort Indications....................... 3-19 3.3 Addressing Syntax and Supported Data Types.... 3-20 3.3.1 PLC-2 Addressing Syntax and Supported Data Types..................................... 3-20 3.3.2 PLC-3 Addressing Syntax and Supported Data Types..................................... 3-21 3.3.2.1 PLC-3 Data Table Addressing............. 3-21 3.3.2.2 PLC-3 Extended Addressing............... 3-27 3.3.3 PLC-5 Addressing Syntax and Supported Data Types..................................... 3-28 3.3.4 PLC-5/250 Addressing Syntax and Supported Data Types................................ 3-40 3.3.5 SLC Addressing Syntax and Supported Data Types..................................... 3-56 A I/O Error Messages B DAS Error Messages Index Examples 2-1 ODS Registration.......................... 2-11 2-2 BASEstar Open Protocol Profile Configuration............................. 2-14 2-3 VMD Configuration......................... 2-15 2-4 ODS Configuration File.................... 2-18 2-5 BSTR Configuration File................... 2-19 3-1 UNNAMED_VARIABLE CREATE Command........... 3-7 3-2 UNNAMED_VARIABLE GET VALUE Output......... 3-7 3-3 UNNAMED_VARIABLE PUT VALUE Output......... 3-8 iv 3-4 DEVICE_DATA_POINT CREATE Command.......... 3-10 3-5 DATA_POINT GET VALUE Output............... 3-12 3-6 DATA_POINT PUT VALUE Output............... 3-12 3-7 Write Indication Configuration............ 3-15 3-8 AB.PAR Contents........................... 3-16 3-9 Write Indication Example.................. 3-17 Figures 1-1 DAS Communications........................ 1-2 2-1 Allen-Bradley 15 Pin Device Connector Layout.................................... 2-2 2-2 Allen-Bradley 25 Pin Device Connector Layout.................................... 2-2 2-3 Allen-Bradley 9 Pin Device Connector Layout.................................... 2-2 3-1 General PLC-2 Address Format.............. 3-20 3-2 PLC-3 I/O Data Table Address Format....... 3-22 3-3 PLC-3 Timer and Counter Data Table Address Format.................................... 3-23 3-4 PLC-3 Timer Structure..................... 3-23 3-5 PLC-3 Counter Structure................... 3-23 3-6 PLC-3 ASCII, Binary, Decimal, Floating-Point, High-Order Integer, Integer and Status Data Table Address Format.................................... 3-25 3-7 PLC-3 Pointer Data Table Address Format... 3-26 3-8 PLC-3 Pointer Structure................... 3-26 3-9 PLC-3 Extended Address Format............. 3-27 3-10 PLC-5 I/O Data Table Address Format....... 3-28 3-11 PLC-5 Status Data Table Address Format.... 3-29 3-12 PLC-5 ASCII, Binary, Decimal, Floating-Point and Integer Data Table Address Format............................ 3-30 3-13 PLC-5 Timer, Counter, Control, SFC Status, Block-Transfer Control, Token Data, ASCII String, PID Control and Message Control Data Table Address Format................. 3-32 3-14 PLC-5 Timer Structure..................... 3-32 v 3-15 PLC-5 Counter Structure................... 3-32 3-16 PLC-5 Control Structure................... 3-33 3-17 PLC-5 SFC Status Structure................ 3-33 3-18 PLC-5 Block-Transfer Control Structure.... 3-33 3-19 PLC-5 Token Data Structure................ 3-33 3-20 PLC-5 ASCII String Structure.............. 3-34 3-21 PLC-5 PID Control Structure............... 3-34 3-22 PLC-5 Message Control Structure........... 3-34 3-23 PLC-5/250 Binary, Floating-Point, Long Integer and Integer Address Format........ 3-41 3-24 PLC-5/250 Timer, Counter, Control, ASCII String, PID Control and Message Control Address Format............................ 3-43 3-25 PLC-5/250 Timer Structure................. 3-43 3-26 PLC-5/250 Counter Structure............... 3-43 3-27 PLC-5/250 Control Structure............... 3-43 3-28 PLC-5/250 ASCII String Structure.......... 3-44 3-29 PLC-5/250 PID Control Structure........... 3-44 3-30 PLC-5/250 Message Control Structure....... 3-44 3-31 PLC-5/250 Status Address Format........... 3-48 3-32 PLC-5/250 I/O Address Format.............. 3-49 3-33 PLC-5/250 Block-Transfer Data Address Format.................................... 3-50 3-34 PLC-5/250 Block-Transfer Read/Write Control Address Format.................... 3-51 3-35 PLC-5/250 Block-Transfer Read/Write Control Structure......................... 3-52 3-36 PLC-5/250 Adapter Status Address Format... 3-53 3-37 PLC-5/250 Adapter Status Structure........ 3-53 3-38 PLC-5/250 Internal Storage Address Format.................................... 3-54 3-39 PLC-5/250 Shared Data Address Format...... 3-55 3-40 SLC I/O Data Table Address Format......... 3-56 3-41 SLC Status Data Table Address Format...... 3-57 3-42 SLC ASCII, Binary, Floating-Point and Integer Data Table Address Format......... 3-58 3-43 SLC Timer, Counter, Control and ASCII String Data Table Address Format.......... 3-60 vi 3-44 SLC Timer Structure....................... 3-60 3-45 SLC Counter Structure..................... 3-60 3-46 SLC Control Structure..................... 3-61 3-47 SLC ASCII String Structure................ 3-61 Tables 2-1 Disk Space Requirements................... 2-4 2-2 Files Created During Installation......... 2-7 2-3 REGISTER Attributes....................... 2-12 2-4 VMD CREATE................................ 2-16 2-5 KE/KF/KF-2/KF-3 Switch Settings........... 2-26 3-1 Connect, Conclude and Abort Interface Access.................................... 3-3 3-2 Read and Write Variable Types............. 3-5 3-3 Read and Write Variable Interface Access.................................... 3-6 3-4 Read and Write Data Point Interface Access.................................... 3-9 3-5 Indication Interface Access............... 3-14 3-6 Supported PLC Write Functions............. 3-19 3-7 Example PLC-2 Data Types.................. 3-21 3-8 Example PLC-3 I/O Data Table Addresses.... 3-22 3-9 Example PLC-3 Timer and Counter Data Table Addresses................................. 3-24 3-10 Example PLC-3 ASCII, Binary, Decimal, Floating-Point, High-Order Integer, Integer and Status Data Table Address Format.................................... 3-25 3-11 Example PLC-3 Pointer Data Table Addresses................................. 3-26 3-12 Example PLC-3 Extended Addresses.......... 3-27 3-13 Example PLC-5 I/O Data Table Addresses.... 3-29 3-14 Example PLC-5 Status Data Table Addresses................................. 3-30 3-15 Example PLC-5 ASCII, Binary, Decimal, Floating-Point and Integer Data Table Address Format............................ 3-31 vii 3-16 Example PLC-5 Timer, Counter, Control, SFC Status, Block-Transfer Control, Token Data, ASCII String, PID Control and Message Control Data Table Address Formats................................... 3-34 3-17 Example PLC-5/250 Binary, Floating-Point, Long Integer and Integer Address Format... 3-42 3-18 Example PLC-5/250 Timer, Counter, Control, ASCII String, PID Control and Message Control Address Formats................... 3-44 3-19 Example PLC-5/250 Status Addresses........ 3-49 3-20 Example PLC-5/250 I/O Addresses........... 3-50 3-21 Example PLC-5/250 Block-Transfer Data Addresses................................. 3-51 3-22 Example PLC-5/250 Block-Transfer Read/Write Control Addresses.............. 3-52 3-23 Example PLC-5/250 Adapter Status Addresses................................. 3-54 3-24 Example PLC-5/250 Internal Storage Addresses................................. 3-55 3-25 Example PLC-5/250 Shared Data Addresses... 3-55 3-26 Example SLC I/O Data Table Addresses...... 3-57 3-27 Example SLC Status Data Table Addresses... 3-58 3-28 Example SLC ASCII, Binary, Floating-Point and Integer Data Table Address Format..... 3-59 3-29 Example SLC Timer, Counter, Control and ASCII String Data Table Address Formats... 3-61 viii _________________________________________________________________ Preface This document describes how to install and use the BASEstar Open DAS for Allen-Bradley Data Highway. Intended Audience This document is intended for system managers who must set up and maintain the following: o BASEstar Open software o BASEstar Open DAS for Allen-Bradley Data Highway This document is also intended for application programmers who develop plant-floor management software layered on BASEstar Open software. Readers of this document should have knowledge of: o OpenVMS operations and administration o OpenVMS application software o BASEstar Open software o Site-specific installation requirements In addition, knowledge of the Allen-Bradley PLCs is required. Document Structure This document is organized as follows: o Chapter 1 provides an overview of the DAS for Allen- Bradley Data Highway. o Chapter 2 provides the information you need to install and configure the DAS for Allen-Bradley Data Highway. vii o Chapter 3 provides information about the supported functions for Allen-Bradley PLCs, and how to access the functions. Associated Documents For information on installing and configuring a BASEstar Open system, refer to the following documents: o BASEstar Open for OpenVMS Release Notes o BASEstar Open for OpenVMS Installation Guide o BASEstar Open for OpenVMS Management Guide For information on installing and configuring a BASEstar Open system, refer to the following documents: o BASEstar Open for OpenVMS Release Notes o BASEstar Open for OpenVMS Installation Guide o BASEstar Open for OpenVMS Management Guide For information on using BASEstar Open software functions, refer to the following documents: o BASEstar Open for OpenVMS Introduction o BASEstar Open for OpenVMS Reference Guide (Model) o BASEstar Open for OpenVMS Command Language Interface o BASEstar Open for OpenVMS Error Messages Guide For more information on developing software to integrate manufacturing applications and equipment, refer to the following documents: o BASEstar Open for OpenVMS Application Programming Interface For information on installing and using OMNI functions, refer to the following documents: o Compaq OMNI for OpenVMS Installation Guide o Compaq OMNI for OpenVMS Application Programmer's Interface o Compaq OMNI for OpenVMS Guide to Using Omni Directory Services viii o Compaq OMNI for OpenVMS Guide to Using OmniView For information on Allen-Bradley PLC communications and addressing, refer to the following documents: o Allen-Bradley Data Highway/Data Highway Plus/DH-485 Communication Protocol and Command Set o Allen-Bradley PLC-2 Family of Programmable Controllers Addressing Reference o Allen-Bradley PLC-3 Family of Programmable Controllers Addressing Reference o SLC 500 Family of Programmable Controllers Addressing Reference o Allen-Bradley 1785 PLC-5 Programmable Controllers Addressing Reference o Allen-Bradley Pyramid Integrator System Addressing Reference Conventions This document uses the following conventions: Boldface Highlights user input within textual descriptions. Press the key labeled Return. Unless otherwise specified, press after entering a command or responding to a prompt. Enter Type the words or symbols described and press . ix 1 _________________________________________________________________ Overview This chapter provides an overview of the BASEstar Open DAS for Allen-Bradley Data Highway. It also briefly describes Allen-Bradley PLC communications, and the supported functions for the DAS for Allen-Bradley Data Highway. 1.1 Description The DAS for Allen-Bradley Data Highway allows you to access Allen-Bradley PLCs using BASEstar Open Device Services, BASEstar Open Data Services or OMNI Services. Device Services is the device configuration and data collection component of BASEstar Open for OpenVMS, allowing the user to: o Configure device and variable definitions o Read and write variable values o Configure polled data collection Data Services is the data management component of BASEstar Open for OpenVMS that provides device independent access to shop floor data allowing the user to: o Configure data points o Read and write data point values o Generate events based on data changes OMNI Services provides the Applications Programming Interface (API) used by the BASEstar Open Device/Data Services to communicate with shop floor devices. OMNI uses the Manufacturing Messaging Specification (MMS) (ISO- 9506) model to communicate with shop floor devices. OMNI also has the capability to support non-MMS devices such as Allen-Bradley PLCs through protocol specific Device Access Software, such as the DAS for Allen-Bradley Data Highway. Overview 1-1 Overview 1.1 Description Using the DAS for Allen-Bradley Data Highway, applications can perform a variety of device access functions for the Allen-Bradley PLCs. 1.2 Device Communications The DAS for Allen-Bradley Data Highway consists of software that provides device-specific communications for users of the OMNI API. BASEstar Open Device/Data Services use the OMNI API to provide device communications to BASEstar Open users. The DAS software communicates the requests and data directly with an OpenVMS device driver to send data to and receive data from plant-floor devices. Figure 1-1 shows how the DAS for Allen-Bradley Data Highway facilitates communications between BASEstar Open Device/Data Services and the device. Figure 1-1 DAS Communications 1.3 Supported Functions and Devices You can perform only device access funtions that are supported by the DAS. The DAS for Allen-Bradley Data Highway supports the following OMNI Services functions for Allen-Bradley PLCs: o Initiate a connection to a device (omni_connect) o Conclude a connection with a device (omni_conclude) o Abort a connection with a device (omni_abort) o Get a value from a device's memory (omni_get_value) o Put a value to a device's memory (omni_put_value) o Receive a write indication from a device (omni_get_ indications) 1-2 Overview Overview 1.3 Supported Functions and Devices o Receive an abort from a device (omni_get_indications) The DAS for Allen-Bradley Data Highway supports the following Allen-Bradley PLCs: o Allen-Bradley PLC-2, PLC-2/5, PLC-2/15, PLC-2/16, PLC-2 /17, PLC-2/20, PLC-2/30 o Allen-Bradley PLC-3 Family o Allen-Bradley PLC-5/10, PLC-5/11, PLC-5/12, PLC-5/15, PLC-5/20, PLC-5/25, PLC-5/30, PLC-5/40, PLC-5/40L, PLC-5 /60, PLC-5/60L, PLC-5/80, PLC-5/250 o Allen-Bradley SLC 500, SLC 5/01, SLC 5/02, SLC 5/03, SLC 5/04 For more information about the supported functions for these PLCs, refer to Chapter 3 of this document. Overview 1-3 2 _________________________________________________________________ Installing and Configuring the DAS This chapter provides the information you need to install the DAS for Allen-Bradley Data Highway and to configure your system. 2.1 Installation Requirements Review the following hardware and software requirements to ensure that your system is prepared for the DAS for Allen-Bradley Data Highway installation. ________________________ Note ________________________ Back up the disks on your system before installing this software. This will provide a method to restore your system in the event of an installation problem. The procedure for backing up disks is described in the OpenVMS System Management Utilities Reference Manual. ______________________________________________________ 2.1.1 Hardware The hardware requirements for the DAS for Allen-Bradley Data Highway are the same as those for the BASEstar Open software. For specific hardware requirements, refer to the BASEstar Open for OpenVMS Installation Guide . Additional hardware required for configuring the DAS for Allen-Bradley Data Highway includes: o Any supported Allen-Bradley PLC o Allen-Bradley KE, KF, KF2 or KF3 communications card o A cable from the OpenVMS system to the communications card Installing and Configuring the DAS 2-1 Installing and Configuring the DAS 2.1 Installation Requirements The cable used to connect to the communications card depends on the communication option being used. The following figures describe the pinouts for 15 pin (KE card), 25 pin (KF communications) and 9 pin (SLC DF1 communications) connectors. The cable to the KE communications card must be terminated with a 15 pin male connector as shown in Figure 2-1. Figure 2-1 Allen-Bradley 15 Pin Device Connector Layout The cable to the KF communications card must be terminated with a 25 pin male RS232-C connector as shown in Figure 2-2. Figure 2-2 Allen-Bradley 25 Pin Device Connector Layout The cable to the SLC 5/03 or SLC 5/04 DF1 port must be terminated with a 9 pin male RS232 connector as shown in Figure 2-3. Figure 2-3 Allen-Bradley 9 Pin Device Connector Layout 2-2 Installing and Configuring the DAS Installing and Configuring the DAS 2.1 Installation Requirements 2.1.2 Software The following software must be installed prior to installing DAS for Allen-Bradley Data Highway: o OpenVMS/Alpha Version 6.1 o OpenVMS/VAX Version 6.1 o BASEstar Open for OpenVMS Version 3.1 For more information on installing BASEstar Open software, refer to the BASEstar Open for OpenVMS Installation Guide. ________________________ Note ________________________ Before using this product on a system, you must first register a License Product Authorization Key (License PAK) using the License Management Facility (LMF). For more information about the License Management Utility, refer to the License Management Utility Manual for OpenVMS. ______________________________________________________ Installing and Configuring the DAS 2-3 Installing and Configuring the DAS 2.1 Installation Requirements 2.1.3 Disk Space Table 2-1 lists the disk space required to install the DAS for Allen-Bradley Data Highway. The space requirements are approximations; actual sizes may vary depending on your system environment and configuration. Table_2-1_Disk_Space_Requirements__________________________ Approximate Space Requirements Usage_____________________(Blocks)_________________________ Peak (during 1250 (Alpha) installation) 3000 (VAX) Net (after installation) 600 (Alpha) __________________________1500_(VAX)_______________________ 2.2 Installing the DAS When your system meets all hardware and software requirements, you can install the DAS for Allen-Bradley Data Highway. The installation takes from 1 to 5 minutes, depending on your system load and configuration. Install the DAS for Allen-Bradley Data Highway by using the following steps: 1. Log in to a privileged system manager's account. 2. Set the default directory to SYS$UPDATE: $ SET DEFAULT SYS$UPDATE 3. Invoke VMSINSTAL: $ @SYS$UPDATE:VMSINSTAL ABDVAA031 ddcu: where: o ABDVAA argument is the kit name o VV in the name means this is an OpenVMS/VAX kit o VA in the name means this is an OpenVMS/Alpha kit o 031 portion of the name is the version number 2-4 Installing and Configuring the DAS Installing and Configuring the DAS 2.2 Installing the DAS o ddcu argument represents the name of the device on which the installation media is mounted, where: - dd is the device code - c is the controller designation - u is the unit number VMSINSTAL prompts you for information during the installation. Note that DECnet software does not need to be running to perform the installation procedure. The following is an example of the output from the installation on OpenVMS/Alpha: Beginning installation of ABDVAA V3.1 at 12:36 %VMSINSTAL-I-RESTORE, Restoring product save set A ... %VMSINSTAL-I-RELMOVED, Product's release notes have been moved to SYS$HELP. Copyright 1994 Compaq Computer Corportation Confidential computer software. Valid license from Compaq or authorized sublicensor required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. BASEstar Open DAS for Allen-Bradley Data Highway installation procedure. Checking for a valid license... Product: ABDAS-V Producer: DEC Version: 1.0 Release Date: 01-JUN-1994 * Does this product have an authorization key registered and loaded? y Now checking OpenVMS version... Now checking that OMNI is installed... Now checking OMNI version... Now checking OMNI logicals... Now checking the OMNI integrator registration utility... Installing and Configuring the DAS 2-5 Installing and Configuring the DAS 2.2 Installing the DAS * Do you want BASEstar Open support [YES]? Now checking disk space... * Do you want to purge files replaced by this installation [YES]? * Do you want to run the IVP after the installation [YES]? ---------------------------------NOTE------------------------------------ During installation the file ODS_AB_CONFIG.TEMPLATE is copied to the ODS:[SCRIPTS] directory. Copy and edit this file to create site specific /PATH and /LINE directory definitions for devices at your installation. ---------------------------------NOTE------------------------------------ During installation the file BSTR_AB_CONFIG.TEMPLATE is copied to the BSTR$KIT:[ETC] directory. Copy and edit this file to create site specific VMD definitions. Now modifying the ODS schema to add Allen-Bradley specific object classes and attributes... Checking ODS Attribute Type Schema definitions ... Checking ODS Object Class Schema definitions ... Querying ODS Schema definitions ... Valid Schema definitions found in the attribute schema database as: OC ALIASED_NAME CN C L S O OU P_ADDR APC OWNER APT AEQ MAPV SY OBJ_ID BER PSAP S SAP TSAP N_ADDR AS_LIST DESCR VMD DOM DEL VN APPSN APROF VERSION NLEVEL MAX_CALL ED MAX_CALLING MAX_SEG CBB_LIST SS_LIST VENDOR MODEL REV INUM DN SHARE CONT_FILE CAP_FILE PN REUSE ARG MON DOM_LIST VAR ATYPE ADDR_T ADDR_V PATH LINE STATION LI NE_NAME PORT ENQ_RETRIES NAK_RETRIES TIMEOUT SPEED PARITY MODEM TRACE KE_STATION KE_TIMEOUT Valid Schema definitions found in the object class schema database as: TOP ALIAS C L O OU AP AE DSA DEVICE TAE OAE AS VMD DOMAIN PI NVAR UNVAR DH_LINE DH_PATH Normal Completion. %VMSINSTAL-I-MOVEFILES, Files will now be moved to their target directories... Now registering BASEstar Open DAS for Allen-Bradley Data Highway with OMNI... Copyright 1994 Compaq Computer Corportation Executing the Installation Verification Procedure. 2-6 Installing and Configuring the DAS Installing and Configuring the DAS 2.2 Installing the DAS BASEstar Open DAS for Allen-Bradley Data Highway installation procedure has succeeded. Installation of ABDVAA V3.1 completed at 14:33 Adding history entry in VMI$ROOT:[SYSUPD]VMSINSTAL.HISTORY Creating installation data file: VMI$ROOT:[SYSUPD]ABDVAA031.VMI_DATA VMSINSTAL procedure done at 14:34 2.2.1 Files Created During Installation Table 2-2 lists the files created by the DAS for Allen- Bradley Data Highway installation procedure, and the directories in which those files are placed. Table_2-2_Files_Created_During_Installation________________ Directory________Filename__________________________________ ODS:[SCRIPTS] ODS_AB_CONFIG.TEMPLATE BSTR$KIT:[ETC]___BSTR_AB_CONFIG.TEMPLATE___________________ 2.2.2 Installation Messages You may see VMSINSTAL messages during the installation procedure. The following messages are specific to the DAS for Allen-Bradley Data Highway installation: BADOMNI, The version of OMNI required is V3.1 or later., Explanation: Error. This version of the DAS is designed to work with OMNI V3.1 or later. User Action: Install OMNI V3.1 or later and then reinstall the DAS. BADVMS (Alpha), BASEstar Open DAS for Allen-Bradley Data Highway must be installed under OpenVMS V6.1., Explanation: Error. The DAS is being installed on a version of OpenVMS that is less than OpenVMS V6.1. User Action: Upgrade OpenVMS to the required minimum version and then install the DAS. Installing and Configuring the DAS 2-7 Installing and Configuring the DAS 2.2 Installing the DAS BADVMS (VAX), BASEstar Open DAS for Allen-Bradley Data Highway must be installed under OpenVMS V6.1., Explanation: Error. The DAS is being installed on a version of OpenVMS that is less than OpenVMS V6.1. User Action: Upgrade OpenVMS to the required minimum version and then install the DAS. NETBLOCKS (VAX), BASEstar Open DAS for Allen-Bradley Data Highway requires 1500 blocks after installation., Explanation: Error. There isn't enough space on the system disk to install the DAS. User Action: Delete unneeded files and reattempt the installation. NETBLOCKS (ALPHA), BASEstar Open DAS for Allen-Bradley Data Highway requires 600 blocks after installation., Explanation: Error. There isn't enough space on the system disk to install the DAS. User Action: Delete unneeded files and reattempt the installation. NOETC, Unable to find BSTR$KIT:[ETC] directory., Explanation: Error. The directory to place the BASEstar Open configuration template for Allen-Bradley devices was not found. User Action: Reinstall BASEstar Open to set up the BSTR$KIT:[ETC] directory. NOLICENSE, No license found for this product - IVP will not be run., Explanation: Informational. A valid license was not found. The installation will continue, but the IVP will not be run. User Action: Register and load a valid license for this product before attempting to use the DAS. 2-8 Installing and Configuring the DAS Installing and Configuring the DAS 2.2 Installing the DAS NOLOAD, License for this product not loaded - IVP will not be run., Explanation: Informational. The license for this product has not been loaded by the License Management Utility. The installation willl proceed, but the IVP will not be run. User Action: Load the license using the License Management Utility before attempting to use the DAS. NOOMNI, OMNI must be installed before BASEstar Open DAS for Allen-Bradley Data Highway., Explanation: Error. The installation procedure could not verify that OMNI was installed on the system. OMNI installation is a prerequisite to the installation of this DAS. User Action: Install OMNI V3.1 and then reinstall the DAS. NOINTREG, Unable to find the integrator registration utility., Explanation: Error. OMNI provides a registration utility for DASes to use to register their presence with OMNI. This registration utility could not be found. User Action: Reinstall OMNI to provide the required registration utility. NOODS, Unable to find the directory for OMNI Directory Services., Explanation: Error. The installation procedure creates classes and attributes in the OMNI Directory Services database and this database could not be found. User Action: Reinstall OMNI to set up the OMNI Directory Services directory. NOSCRIPT, Unable to find ODS:[SCRIPTS] directory., Explanation: Error. The directory to place the ODS configuration template for Allen-Bradley devices was not found. User Action: Reinstall OMNI to set up the OMNI Directory Services directory. Installing and Configuring the DAS 2-9 Installing and Configuring the DAS 2.2 Installing the DAS ODSINI, OMNI logicals have not been defined, attempting to define logicals., Explanation: Information. The DAS installation requires that certain OMNI logicals be defined and these logical names were not found. The installation procedure attempts to define the logical names by executing SYS$STARTUP:OMNI_ LOGICALS.COM. User Action: None. 2.3 Postinstallation Tasks Before using the DAS for Allen-Bradley Data Highway you must perform the following postinstallation tasks: o Edit the configuration files o Configure ports o Set up plant-floor equipment 2.3.1 Editing the Configuration Files Configuration files, ODS_AB_CONFIG.TEMPLATE and BSTR_ AB_CONFIG.TEMPLATE, are supplied with the DAS for Allen- Bradley Data Highway. The ODS configuration file contains OMNI Directory Services (ODS) registration commands for Allen-Bradley specific classes and attributes. The BASEstar Open configuration file contains definitions for sample Allen-Bradley VMDs and protocol profile(s). Copy the template files and edit them to include site- specific directory, VMD and protocol profile definitions. When you complete your edits, execute the files to create the ODS and BASEstar Open Device Services definitions. The following sections provide examples of ODS and BASEstar Open definitions from the configuration files, and indicate which attributes can be modified. For more information about creating VMD and protocol profile definitions, refer to the BASEstar Open for OpenVMS Command Language Interface. For more information about registering ODS definitions, refer to the Compaq OMNI for OpenVMS Guide to Using Omni Directory Services. 2-10 Installing and Configuring the DAS Installing and Configuring the DAS 2.3 Postinstallation Tasks 2.3.1.1 Editing ODS Registrations ODS registrations allow the DAS software to locate a particular PLC on an Allen-Bradley data highway network. Example 2-1 shows the configuration file commands that create the ODS registrations. Example 2-1 ODS Registration REGISTER DIRECTORY NAME "/LINE=DATA_HIGHWAY" ATTRIBUTES "OC=DH_LINE /PORT=LTA201:/ENQ_RETRIES=10/NAK_RETRIES=3/KE_TIMEOUT=128/SPEED=9600 /PARITY=none/MODEM=0/TRACE=0/KE_STATION=12/TIMEOUT=3" REGISTER DIRECTORY NAME "/LINE=DATA_HIGHWAY_PLUS" ATTRIBUTES "OC=DH_LINE /PORT=LTA202:/ENQ_RETRIES=10/NAK_RETRIES=3/KE_TIMEOUT=128/SPEED=9600 /PARITY=none/MODEM=0/TRACE=0/KE_STATION=13/TIMEOUT=3" REGISTER DIRECTORY NAME "/LINE=DH485" ATTRIBUTES "OC=DH_LINE /PORT=LTA203:/ENQ_RETRIES=10/NAK_RETRIES=3/SPEED=9600 /PARITY=none/MODEM=0/TIMEOUT=3" REGISTER DIRECTORY NAME "/PATH=PLC_2_15_PATH" ATTRIBUTES "OC=DH_PATH /LINE_NAME=(/LINE=DATA_HIGHWAY)/STATION=20/TRACE=0" REGISTER DIRECTORY NAME "/PATH=PLC_2_30_PATH" ATTRIBUTES "OC=DH_PATH /LINE_NAME=(/LINE=DATA_HIGHWAY)/STATION=21/TRACE=0" REGISTER DIRECTORY NAME "/PATH=PLC_3_PATH" ATTRIBUTES "OC=DH_PATH /LINE_NAME=(/LINE=DATA_HIGHWAY)/STATION=22/TRACE=0" REGISTER DIRECTORY NAME "/PATH=PLC_5_40_PATH" ATTRIBUTES "OC=DH_PATH /LINE_NAME=(/LINE=DATA_HIGHWAY_PLUS)/STATION=20/TRACE=0" REGISTER DIRECTORY NAME "/PATH=PLC_5_250_PATH" ATTRIBUTES "OC=DH_PATH /LINE_NAME=(/LINE=DATA_HIGHWAY_PLUS)/STATION=21/TRACE=0" REGISTER DIRECTORY NAME "/PATH=SLC_5_04" ATTRIBUTES "OC=DH_PATH /LINE_NAME=(/LINE=DH485)/STATION=1" You can modify the command for your site configuration. Table 2-3 lists ODS attributes, the class they belong to and valid values for the attributes. Attribute values are not checked until a connection is initiated with the VMD. Installing and Configuring the DAS 2-11 Installing and Configuring the DAS 2.3 Postinstallation Tasks Table_2-3_REGISTER_Attributes____________________________________ Class_______Attribute________Default_____Value(s)________________ DH_LINE PORT TT01:, LTA201:, etc.[1] SPEED 110 - 19200 PARITY NONE, EVEN MODEM NO TRUE, ON, YES, 1 or FALSE, OFF, NO, 0 TIMEOUT 3 2-6[2] KE_STATION[3] 0 0-377[4] KE_TIMEOUT 128 0-255[6] ENQ_RETRIES[7] 10 0-20 NAK_RETRIES[8] 3 0-20 TRACE[9] NO TRUE, ON, YES, 1 or FALSE, OFF, NO, 0 DH_TELNET IP_ADDRESS xx.xx.xx.xx[11] PORT_NUMBER[12] [1]LTAXXX:_is_used_for_LAT_connections._TTXX:_is_used_for_direct_ connection. [2]Seconds. [3]If a KE Station address is specified, then the DAS will configure the KE/KF/KF-2 for the ENQ retries, NAK retries and KE timeout values specified. If a KE Station Address of 0 is specified, then the DAS does not configure the KE/KF/KF-2 and the KE timeout value is ignored. Do NOT configure the KE station address if connecting to a DH-485 network. [4]Octal for PLC-2, PLC-3 or PLC-5 controllers. [6]The KE timeout value is specified in cycles. Consult the KE/KF /KF-2 documentation to determine how long the time is in seconds. [7]The ENQ retries is the number of times a request for a response is sent to the PLC before an error is returned to the user. [8]The NAK retries is the number of times a retransmission is attempted when a recoverable error is detected in the message received by the PLC. [9]Trace is used to allow troubleshooting of the PLC communications. See Section 2.4 for details. [11]The TCP/IP address must be in xx.xx.xx.xx notation where xx is a number from 0-255. [12]Put a valid port number for a socket connection to the TELNET server. (continued on next page) 2-12 Installing and Configuring the DAS Installing and Configuring the DAS 2.3 Postinstallation Tasks Table_2-3_(Cont.)_REGISTER_Attributes____________________________ Class_______Attribute________Default_____Value(s)________________ TIMEOUT 3 2-6[2] KE_STATION[3] 0 0-377[4] KE_TIMEOUT 128 0-255[6] ENQ_RETRIES[7] 10 0-20 NAK_RETRIES[8] 3 0-20 TRACE[9] NO TRUE, ON, YES, 1 or FALSE, OFF, NO, 0 DH_PATH LINE_NAME /LINE=xxx[10] STATION 0-377[4], 1-31[5] TRACE[9] NO TRUE, ON, YES, 1 or FALSE, OFF, NO, 0 [2]Seconds.______________________________________________________ [3]If a KE Station address is specified, then the DAS will configure the KE/KF/KF-2 for the ENQ retries, NAK retries and KE timeout values specified. If a KE Station Address of 0 is specified, then the DAS does not configure the KE/KF/KF-2 and the KE timeout value is ignored. Do NOT configure the KE station address if connecting to a DH-485 network. [4]Octal for PLC-2, PLC-3 or PLC-5 controllers. [5]Decimal for SLC controllers. If a SLC controller is connected directly to a data highway plus network, the station is still specified in decimal, not octal. [6]The KE timeout value is specified in cycles. Consult the KE/KF /KF-2 documentation to determine how long the time is in seconds. [7]The ENQ retries is the number of times a request for a response is sent to the PLC before an error is returned to the user. [8]The NAK retries is the number of times a retransmission is attempted when a recoverable error is detected in the message received by the PLC. [9]Trace is used to allow troubleshooting of the PLC communications. See Section 2.4 for details. [10]Specify a name registered earlier with ODS that specifies the line that the PLC with this station address will be using. _________________________________________________________________ Installing and Configuring the DAS 2-13 Installing and Configuring the DAS 2.3 Postinstallation Tasks 2.3.1.2 Editing BASEstar Open Protocol Profile Definitions The BASEstar Open protocol profile is used to associate a device with the correct DAS. Example 2-2 shows the configuration file commands that create protocol profile definitions. Example 2-2 BASEstar Open Protocol Profile Configuration CREATE PROTOCOL_PROFILE ab_plc2 \ -APPLPROFID 51 \ -MAXPDUSIZE 1024 \ -SMA_MODE ENABLED \ -LOG CREATE PROTOCOL_PROFILE ab_plc3 \ -APPLPROFID 52 \ -MAXPDUSIZE 1024 \ -SMA_MODE ENABLED \ -LOG CREATE PROTOCOL_PROFILE ab_plc5 \ -APPLPROFID 53 \ -MAXPDUSIZE 1024 \ -SMA_MODE ENABLED \ -LOG CREATE PROTOCOL_PROFILE ab_slc \ -APPLPROFID 54 \ -MAXPDUSIZE 1024 \ -SMA_MODE ENABLED \ -LOG The DAS for Allen-Bradley Data Highway uses a different Application Profile ID for each PLC family that it supports. When defining a VMD, be sure to specify the proper protocol profile for the family of PLC being defined. The MAXPDUSIZE should be greater than or equal to the largest total packet sent by the PLC. If a packet is segmented into several smaller packets use the total packet size for this number. 2-14 Installing and Configuring the DAS Installing and Configuring the DAS 2.3 Postinstallation Tasks SMA_MODE indicates that the DAS supports reading multiple variables with one read command. The DAS does not support writing multiple variables. Variables in a polling set are grouped and read in one function call by BASEstar Open if the SMA_MODE ENABLED flag is set. 2.3.1.3 Editing VMD Definitions The VMD definition represents an Allen-Bradley PLC and references previously defined ODS and protocol profile definitions. Example 2-3 shows the configuration file commands that create VMD definitions. Example 2-3 VMD Configuration CREATE VMD plc_2_15 -MODEL "PLC_2_15" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=PLC_2_15_PATH":ab_plc2 \ -DESCRIPTION "PLC 2/15" \ -LOG CREATE VMD plc_2_30 -MODEL "PLC_2_30" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=PLC_2_30_PATH":ab_plc2 \ -DESCRIPTION "PLC 2/30" \ -LOG CREATE VMD plc_3 -MODEL "PLC_3" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=PLC_3_PATH":ab_plc3 \ -DESCRIPTION "PLC 3" \ -LOG CREATE VMD plc_5_40 -MODEL "PLC_5_40" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=PLC_5_40_PATH":ab_plc5 \ -DESCRIPTION "PLC 5/40" \ -LOG CREATE VMD plc_5_250 -MODEL "PLC_5_250" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=PLC_5_250_PATH":ab_plc5 \ -DESCRIPTION "PLC 5/250" \ -LOG (continued on next page) Installing and Configuring the DAS 2-15 Installing and Configuring the DAS 2.3 Postinstallation Tasks Example 2-3 (Cont.) VMD Configuration CREATE VMD slc_5_04 -MODEL "SLC_5_04" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=SLC_5_04_PATH":ab_slc \ -DESCRIPTION "SLC 5/04" \ -LOG An access point is created using the following syntax: APPLICATION_SIMPLE_NAME:PROTOCOL_PROFILE_NAME. The APPLICATION_SIMPLE_NAME is the definition registered in ODS. The PROTOCOL_PROFILE_NAME is defined using the BASEstar Open CLI as described in Section 2.3.1.2. An access point tells the BASEstar Open software how to access the VMD. For more information on specifying client and DVM access points, refer to BASEstar Open for OpenVMS Command Language Interface. Modify the command for your site configuration. Table 2-4 lists the modifiable device attributes. Table_2-4_VMD_CREATE_____________________________________________ VMD_______Parameter_____________Value(s)_________________________ PLC 2 MODEL PLC_2, PLC_2_5, PLC_2_05, PLC_2_ 15, PLC_2_16, PLC_2_17, PLC_2_20, PLC_2_30 VENDOR[1] Allen-Bradley REVISION[1] CLIENT_ACCESS_ POINT[2] DVM_ACCESS_POINT[2] DESCRIPTION[1] PLC 3 MODEL PLC_3 [1]The_value_of_this_field_is_informational_only_and_is_not______ checked by the DAS. [2]See the BASEstar Open for OpenVMS Command Language Interface for information on specifying client and DVM access points. (continued on next page) 2-16 Installing and Configuring the DAS Installing and Configuring the DAS 2.3 Postinstallation Tasks Table_2-4_(Cont.)_VMD_CREATE_____________________________________ VMD_______Parameter_____________Value(s)_________________________ VENDOR[1] Allen-Bradley REVISION[1] CLIENT_ACCESS_ POINT[2] DVM_ACCESS_POINT[2] DESCRIPTION[1] PLC-3 PLC 5 MODEL PLC_5_10, PLC_5_11, PLC_5_12, PLC_5_15, PLC_5_16, PLC_5_20, PLC_5_25, PLC_5_26, PLC_5_30, PLC_5_36, PLC_5_40, PLC_5_40L, PLC_5_46, PLC_5_60, PLC_5_60L, PLC_5_66, PLC_5_80, PLC_5_86, PLC_5_250 VENDOR[1] Allen-Bradley REVISION[1] CLIENT_ACCESS_ POINT[2] DVM_ACCESS_POINT[2] DESCRIPTION[1] SLC MODEL SLC_500, SLC_5_01, SLC_5_02, SLC_ 5_03, SLC_5_04, SLC_5_05 VENDOR[1] Allen-Bradley REVISION[1] CLIENT_ACCESS_ POINT[2] DVM_ACCESS_POINT[2] DESCRIPTION[1] [1]The_value_of_this_field_is_informational_only_and_is_not______ checked by the DAS. [2]See the BASEstar Open for OpenVMS Command Language Interface for information on specifying client and DVM access points. _________________________________________________________________ Installing and Configuring the DAS 2-17 Installing and Configuring the DAS 2.3 Postinstallation Tasks 2.3.1.4 Configuration Files Example 2-4 and Example 2-5 are samples of the ODS and BSTR configuration files for the DAS for Allen-Bradley Data Highway. Example 2-4 ODS Configuration File $! $! $! Copyright 1994 Compaq Computer Corporation. $! $! COMPAQ Registered in U.S. Patent and Trademark Office. $! $! Confidential computer software. Valid license from Compaq or authorized $! sulicensor required for possession, use or copying. Consistent with $! FAR 12.211 and 12.212, Commercial Computer Software, Computer Software $! Documentation, and Technical Data for Commercial Items are licensed to $! the U.S. Government under vendor's standard commercial license. $! $!********************************************************************! $! ! $! This is a template for the Allen-Bradley-specific ! $! ODS configuration command file. Rename and edit this command ! $! procedure template to reflect your site-specific ! $! configuration. You must manually execute this command ! $! procedure to configure ODS to provide line configuration ! $! information for your devices. ! $! ! $! Add comments to the site-specific changes here. ! $! ! $!********************************************************************! $! $ODSCL := $ODS:[EXEC]ODSCL $! $! Register the ODS definitions. $! $ODSCL REGISTER DIRECTORY NAME "/LINE=DATA_HIGHWAY" ATTRIBUTES "OC=DH_LINE /PORT=LTA201:/ENQ_RETRIES=10/NAK_RETRIES=3/KE_TIMEOUT=128/SPEED=9600 /PARITY=none/MODEM=0/KE_STATION=12/TIMEOUT=3" (continued on next page) 2-18 Installing and Configuring the DAS Installing and Configuring the DAS 2.3 Postinstallation Tasks Example 2-4 (Cont.) ODS Configuration File REGISTER DIRECTORY NAME "/LINE=DATA_HIGHWAY_PLUS" ATTRIBUTES "OC=DH_LINE /PORT=LTA202:/ENQ_RETRIES=3/NAK_RETRIES=3/KE_TIMEOUT=128/SPEED=9600 /PARITY=none/MODEM=0/KE_STATION=10/TIMEOUT=3" REGISTER DIRECTORY NAME "/LINE=DH485" ATTRIBUTES "OC=DH_LINE /PORT=LTA203:/ENQ_RETRIES=10/NAK_RETRIES=3/SPEED=9600 /PARITY=none/MODEM=0/TIMEOUT=3" REGISTER DIRECTORY NAME "/PATH=PLC_2_15" ATTRIBUTES "OC=DH_PATH /LINE_NAME=(/LINE=DATA_HIGHWAY)/STATION=20" REGISTER DIRECTORY NAME "/PATH=PLC_2_30" ATTRIBUTES "OC=DH_PATH /LINE_NAME=(/LINE=DATA_HIGHWAY)/STATION=21" REGISTER DIRECTORY NAME "/PATH=PLC_3" ATTRIBUTES "OC=DH_PATH /LINE_NAME=(/LINE=DATA_HIGHWAY)/STATION=22" REGISTER DIRECTORY NAME "/PATH=PLC_5_40" ATTRIBUTES "OC=DH_PATH /LINE_NAME=(/LINE=DATA_HIGHWAY_PLUS)/STATION=20" REGISTER DIRECTORY NAME "/PATH=PLC_5_250" ATTRIBUTES "OC=DH_PATH /LINE_NAME=(/LINE=DATA_HIGHWAY_PLUS)/STATION=21" REGISTER DIRECTORY NAME "/PATH=SLC_5_04" ATTRIBUTES "OC=DH_PATH /LINE_NAME=(/LINE=DH485)/STATION=1" EXIT To execute the ODS command file, enter the following command at the user prompt: @ODS:[SCRIPTS]ODS_AB_CONFIG.TEMPLATE Example 2-5 BSTR Configuration File (continued on next page) Installing and Configuring the DAS 2-19 Installing and Configuring the DAS 2.3 Postinstallation Tasks Example 2-5 (Cont.) BSTR Configuration File ! ! Copyright 1994 Compaq Computer Corporation ! ! COMPAQ Registered in U.S. Patent and Trademark Office. ! ! Confidential computer software. Valid license from Compaq or authorized ! sulicensor required for possession, use or copying. Consistent with ! FAR 12.211 and 12.212, Commercial Computer Software, Computer Software ! Documentation, and Technical Data for Commercial Items are licensed to ! the U.S. Government under vendor's standard commercial license. ! ! Create the protocol profile definitions for the PLC-2, ! PLC-3, PLC-5 and SLC family of PLCs. ! Protocol profile IDs uniquely identify protocol support to OMNI. ! CREATE PROTOCOL_PROFILE ab_plc2 \ -APPLPROFID 51 \ -MAXPDUSIZE 1024 \ -SMA_MODE ENABLED \ -LOG CREATE PROTOCOL_PROFILE ab_plc3 \ -APPLPROFID 52 \ -MAXPDUSIZE 1024 \ -SMA_MODE ENABLED \ -LOG CREATE PROTOCOL_PROFILE ab_plc5 \ -APPLPROFID 53 \ -MAXPDUSIZE 1024 \ -SMA_MODE ENABLED \ -LOG CREATE PROTOCOL_PROFILE ab_slc \ -APPLPROFID 54 \ -MAXPDUSIZE 1024 \ -SMA_MODE ENABLED \ -LOG (continued on next page) 2-20 Installing and Configuring the DAS Installing and Configuring the DAS 2.3 Postinstallation Tasks Example 2-5 (Cont.) BSTR Configuration File ! ! Create VMD definitions. ! Use the ODS entries and protocol profile names created earlier. ! CREATE VMD plc_2_15 -MODEL "PLC_2_15" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=PLC_2_15_PATH":ab_plc2 \ -DESCRIPTION "PLC 2/15" \ -LOG CREATE VMD plc_2_30 -MODEL "PLC_2_30" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=PLC_2_30_PATH":ab_plc2 \ -DESCRIPTION "PLC 2/30" \ -LOG CREATE VMD plc_3 -MODEL "PLC_3" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=PLC_3_PATH":ab_plc3 \ -DESCRIPTION "PLC 3" \ -LOG CREATE VMD plc_5_40 -MODEL "PLC_5_40" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=PLC_5_40_PATH":ab_plc5 \ -DESCRIPTION "PLC 5/40" \ -LOG CREATE VMD plc_5_250 -MODEL "PLC_5_250" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=PLC_5_250_PATH":ab_plc5 \ -DESCRIPTION "PLC 5/250" \ -LOG CREATE VMD slc_5_04 -MODEL "SLC_5_04" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=SLC_5_04_PATH":ab_slc \ -DESCRIPTION "SLC 5/04" \ -LOG (continued on next page) Installing and Configuring the DAS 2-21 Installing and Configuring the DAS 2.3 Postinstallation Tasks Example 2-5 (Cont.) BSTR Configuration File ! ! Create actors/activities for the VMDs ! CREATE NODE ab_node -PHYSICAL "your_node" -LOG CREATE DOMAIN /plc_2_15 CREATE DOMAIN /plc_2_30 CREATE DOMAIN /plc_3 CREATE DOMAIN /plc_5_40 CREATE DOMAIN /plc_5_250 CREATE DOMAIN /slc_5_04 CREATE ACTOR /AB -LOG SET CONTEXT /AB CREATE PROGRAM ab_server -PROGRAM_KIND DATADEV -LOG CREATE ACTIVITY plc_2_15 -PROGRAM ab_server \ -NODES (ab_node) \ -DOMAINS (/plc_2_15) \ -VMDS (plc_2_15) \ -LOG CREATE ACTIVITY plc_2_30 -PROGRAM ab_server \ -NODES (ab_node) \ -DOMAINS (/plc_2_30) \ -VMDS (plc_2_30) \ -LOG CREATE ACTIVITY plc_3 -PROGRAM ab_server \ -NODES (ab_node) \ -DOMAINS (/plc_3) \ -VMDS (plc_3) \ -LOG CREATE ACTIVITY plc_5_40 -PROGRAM ab_server \ -NODES (ab_node) \ -DOMAINS (/plc_5_40) \ -VMDS (plc_5_40) \ -LOG CREATE ACTIVITY plc_5_250 -PROGRAM ab_server \ -NODES (ab_node) \ -DOMAINS (/plc_5_250) \ -VMDS (plc_5_250) \ -LOG (continued on next page) 2-22 Installing and Configuring the DAS Installing and Configuring the DAS 2.3 Postinstallation Tasks Example 2-5 (Cont.) BSTR Configuration File CREATE ACTIVITY slc_5_04 -PROGRAM ab_server \ -NODES (ab_node) \ -DOMAINS (/slc_5_04) \ -VMDS (slc_5_04) \ -LOG To execute the BASEstar Open command file, enter the following command at the user prompt: $CLI_BSTR -F BSTR_AB_CONFIG.TEMPLATE For more information about maintaining protocol profile and device definitions, refer to the BASEstar Open for OpenVMS Command Language Interface. For more information about maintaining ODS definitions, refer to the Compaq OMNI for OpenVMS Guide to Using Omni Directory Services. 2.3.2 Configuring Ports You can connect a PLC to a Local Area Transport (LAT) port. To use a LAT port with the DAS, you must define the LAT port on the OpenVMS system using the LAT control program. For example, to define port_2 on the LAT node srvr4 as LTA992, enter the following: $ MCR LATCP LCP> CREATE PORT LTA992 LCP> SET PORT LTA992 /NODE=srvr4/PORT=port_2/NOQUEUE Use the LAT port name defined above when defining the port to ODS. You must also set the following SYSGEN parameters to access Allen-Bradley PLCs to reduce the potential for data overruns. Use the SYSGEN utility to display the current values and AUTOGEN to reset the values accordingly. For information on using SYSGEN and AUTOGEN, refer to the OpenVMS System Management Utilities Reference Manual for details. Installing and Configuring the DAS 2-23 Installing and Configuring the DAS 2.3 Postinstallation Tasks ___________________________________________________________ Parameter________Value_____________________________________ TTY_ALTALARM 0 TTY_ALTYPAHD_____1024______________________________________ To enable use of the alternate typeahead buffer, type the following command from DCL: $ SET TERM LTA992:/ALTYPEAHD/PERMANENT For the DAS for Allen-Bradley Data Highway to send and receive data correctly, you must set and define LAT port characteristics to match the line parameters defined in ODS for the corresponding port. The following example shows the characteristics set at the LAT prompt: Local> DEF PORT n SPEED 9600 Local> DEF PORT n AUTOBAUD DISABLED Local> DEF PORT n AUTOCONNECT DISABLED Local> DEF PORT n FLOW DISABLED Local> DEF PORT n PREFERRED NONE Local> DEF PORT n ACCESS REMOTE Local> DEF PORT n CHAR 8 Local> DEF PORT n PARITY EVEN 2.3.3 Configuring TELNET Access You can connect a PLC to a terminal server using the TELNET protocol. Using the TELNET protocol allows the use of non- proprietary protocols to access terminal servers to perform device communications. The terminal server being used must support the BINARY transfer option (RFC 856). The DAS negotiates binary transfer as part of establishing a connection with the port. If the terminal server will not allow binary transfer, the negotiation fails and a connection is not established. NOTE: Using TELNET communications is slower than either LAT or a directly connected device. Ensure that your throughput requirements will be satisfied before deciding to implement TELNET communications. 2-24 Installing and Configuring the DAS Installing and Configuring the DAS 2.3 Postinstallation Tasks For the DAS for Allen-Bradley Data Highway to send and receive data correctly using TELNET, you must set up a port on the terminal server to receive a connect from the DAS. The following example shows setting up a port using a DECserver 700. Local> DEF TELNET LISTENER y PORT n Local> DEF TELNET LISTENER y CONNECTIONS ENABLED The following example shows setting up the server for TELNET access. A gateway needs to be configured only if the terminal server is on a different subnet than the host. In general, the terminal server should be on the same subnet as the host in order to reduce communications delays. Local> DEF INTERNET ADDRESS xx.xx.xx.xx Local> DEF INTERNET MASK xx.xx.xx.xx Local> DEF INTERNET GATEWAY xx.xx.xx.xx 2.3.4 Setting Up Plant-Floor Equipment To set up your plant-floor equipment, refer to the Allen- Bradley documentation for your specific PLC. Table 2-5 provides switch settings to use in setting up your KE/KF/KF-2/KF-3 communications card. Installing and Configuring the DAS 2-25 Installing and Configuring the DAS 2.3 Postinstallation Tasks Table_2-5_KE/KF/KF-2/KF-3_Switch_Settings__________________ Parameter_____________Supported___Values___________________ Half Duplex No Full Duplex Yes Embedded Response No BCC Error Check Yes CRC Error Check No RS-232C Handshaking Yes[1] Station Number Yes 1-377 (octal)[2], 1-31 (decimal)[3] Computer Comm Rate Yes 110 - 19200[4] [1]If_using_the_handshaking_signals_(RTS,_CTS,_DSR,_DTR,___ DCD) be sure that the computer is also using those signals and that the cable has been wired properly. [2]PLC-2, PLC-3, & PLC-5 controllers [3]SLC controllers [4]The 1771-KE,KF Series A Revision A-G support a maximum of 9600 baud. The 1771-KE,KF Series A Revision H and later, the 1770-KF2 Series B Revision F and later and the 1785-KE support a maximum of 19200 baud. ___________________________________________________________ 2.4 Tracing device communications The DAS for Allen-Bradley Data Highway has built into it the capability to trace PLC communications and to send this output to either a file or to a user terminal. The purpose of this tracing is to allow the troubleshooting of PLC communications. Tracing can be enabled for a device and/or a line. If tracing is enabled for a PLC, then only communications from/to that PLC are traced. If tracing is enabled for a line, then all communications from/to that line are traced. If both PLC and line tracing is enabled, then the trace will contain the output for both the PLC and the line, so the trace output will be duplicated. To enable tracing do the following: o Set the TRACE attribute in the ODS definition for the path or line being traced. 2-26 Installing and Configuring the DAS Installing and Configuring the DAS 2.4 Tracing device communications o Set the DAS_TRACE_OUTPUT logical name to the name of the file that you want to contain the trace output. The logical name must be defined in a scope that will be seen by the server the DAS is a part of. DEFINE DAS_TRACE_OUTPUT MY_DISK:[MY_DIRECTORY]TRACE_OUTPUT.LOG o Reinitiate communications to the PLC/line. The ODS definition is read when a connection to the device is initiated (device tracing) or when a connection to the line is initiated (line tracing), so communications must be reinitiated in order for tracing to occur. The trace output is flushed to the file after every 10 lines that are traced, so trace output may lag actual device I/O. All trace output is in hexadecimal and shows both input to and output from the PLC. To turn tracing off, reverse the steps used to turn tracing on. 2.5 Failures During Product Use If an error occurs while this product is in use and you believe the error is caused by a problem with the product, take one of the following actions: o If you have a Software Product Services Support Agreement, contact your Customer Support Center (CSC) by telephone or by using the electronic means provided with your support agreement (such as DSNlink). The CSC provides telephone support for high-level advisory and remedial assistance. When you initially contact the CSC, indicate the following: - The name and version number of the operating system you are using - The version number of the product you are using - The version number of BASEstar Open you are using - The hardware system you are using (such as a model number) - The Allen-Bradley PLCs you are communicating with Installing and Configuring the DAS 2-27 Installing and Configuring the DAS 2.5 Failures During Product Use - A brief description of the problem (one sentence if possible) - How critical the problem is o If you have a Self-Maintenance Software Agreement, you can submit a Software Performance Report (SPR). o If you do not have any type of software services support agreement and you purchased this product within the past year, you can submit an SPR if you think the problem is caused by a software error. When you submit an SPR, take the following steps: 1. Describe as accurately as possible the circumstances and state of the system when the problem occurred. Include the description and version number of the product being used. Demonstrate the problem with specific examples. 2. Reduce the problem to as small a size as possible. 3. Remember to include listings of any command files, INCLUDE files, or relevant data files, and so forth. 4. Report only one problem per SPR. This will facilitate a faster response. 5. Mail the SPR package to Compaq. 2-28 Installing and Configuring the DAS 3 _________________________________________________________________ Using the DAS This chapter provides information about the supported functions for Allen-Bradley PLCs, and how to access these functions. 3.1 Accessing Allen-Bradley Functions DAS for Allen-Bradley Data Highway functions are accessed through the following interfaces: o BASEstar Open Command Language Interface (CLI) o BASEstar Open Application Programming Interface (API) o OMNI Application Programming Interface (API) Command Language Interface (CLI) To access the BASEstar Open CLI, enter the following command at the DCL prompt ($): $ CLI_BSTR For information about BASEstar Open commands, refer to the BASEstar Open for OpenVMS Command Language Interface. Application Programming Interface (API) For information on accessing BASEstar Open Callable Services, refer to the BASEstar Open for OpenVMS Application Programming Interface. For information on accessing OMNI Callable Services, refer to the Compaq OMNI for OpenVMS Application Programmer's Interface. Using the DAS 3-1 Using the DAS 3.2 Supported Functions 3.2 Supported Functions A variety of functions are supported by the DAS for Allen- Bradley Data Highway. These functions may be supported as either client or server or both. If a function is supported as a server, then the application will receive an indication when the VMD is requesting the service. 3-2 Using the DAS Using the DAS 3.2 Supported Functions The DAS for Allen-Bradley Data Highway supports the following client functions for all supported devices: o Connect o Read Variable o Write Variable o Abort o Conclude The DAS for Allen-Bradley Data Highway supports the following server functions (indications) for all supported devices: o Write indication o Abort ________________________ Note ________________________ Information Report is still supported for backward compatability but support will be dropped in a future release of the DAS. Support for SLC controllers does not include information report as an option. Configurations should be modified to use write indication support as soon as possible. ______________________________________________________ 3.2.1 Connect, Conclude and Abort Functions Table 3-1 lists the connect, conclude and abort functions available through the OMNI (API) interface. Table_3-1_Connect,_Conclude_and_Abort_Interface_Access_____ Interface___Function_Name__________________________________ API omni_connect omni_connect_a omni_conclude omni_conclude_a omni_abort ____________omni_abort_a___________________________________ Using the DAS 3-3 Using the DAS 3.2 Supported Functions 3.2.2 Read and Write Variable Functions Use the read variable and write variable functions to read data from and write data to a specific address in PLC memory. 3-4 Using the DAS Using the DAS 3.2 Supported Functions Table 3-2 lists the variable types supported by this DAS. Table_3-2_Read_and_Write_Variable_Types____________________ Variable_Type_________Address_Type__________Supported______ UNNAMED_VARIABLE NUMERIC No SYMBOLIC No UNCONSTRAINED Yes NAMED_VARIABLE Yes[1] [1]Named_variables_are_not_supported_by_the_DAS,_but_they__ are used by BASEstar Open when accessing variables using the Device Manager Server. The BASEstar Open Device Manager Server converts named variables with an address type of UNCONSTRAINED to unnamed variables. ___________________________________________________________ An UNNAMED_VARIABLE type describes a specific physical address on a VMD. This address has a predefined type based on the address. Variables of this type are an inherent part of the VMD architecture and are uniquely identified by their physical address. An unnamed variable can be one of the following types: o NUMERIC A numeric address must be an MMS unsigned integer. o SYMBOLIC A symbolic address must be an MMS visible string. o UNCONSTRAINED An unconstrained address can be any MMS octet (byte) string. A NAMED_VARIABLE type describes a variable on a PLC. Variables of this type are uniquely identified by their name. Table 3-3 lists the read and write variable functions available through the BASEstar Open (CLI) and OMNI (API) interfaces. Using the DAS 3-5 Using the DAS 3.2 Supported Functions Table_3-3_Read_and_Write_Variable_Interface_Access_________ Interface___Function_Name__________________________________ CLI GET VALUE UNNAMED_VARIABLE PUT VALUE UNNAMED_VARIABLE API omni_get_value omni_get_value_a omni_put_value ____________omni_put_value_a_______________________________ 3-6 Using the DAS Using the DAS 3.2 Supported Functions Example 3-1 shows examples of creating unnamed variables using the CREATE UNNAMED_VARIABLE command. Example 3-1 UNNAMED_VARIABLE CREATE Command BSTR> CREATE UNNAMED_VARIABLE plc_2_15.p1 \ -DATATYPE INTEGER_16 \ -ADDRESS "200" \ -ADDRTYPE UNCONSTRAINED BSTR> CREATE UNNAMED_VARIABLE plc_3.p1 \ -DATATYPE INTEGER_16 \ -ADDRESS "$N5:20" \ -ADDRTYPE UNCONSTRAINED BSTR> CREATE UNNAMED_VARIABLE plc_5_40.p1 \ -DATATYPE BIT \ -ADDRESS "$N7:30/1" \ -ADDRTYPE UNCONSTRAINED BSTR> CREATE ARRAY_DATATYPE WORD_ARRAY_10 \ -DATATYPE INTEGER_16 \ -SIZE 10 BSTR> CREATE UNNAMED_VARIABLE plc_5_40.p2 \ -DATATYPE WORD_ARRAY_10 \ -ADDRESS "$N7:30" \ -ADDRTYPE UNCONSTRAINED BSTR> CREATE STRUCTURE_DATATYPE PLC_5_COUNTER \ -MEMBERS (CONTROL:INTEGER_16 PRE:INTEGER_16 ACC:INTEGER_16) BSTR> CREATE UNNAMED_VARIABLE plc_5_40.p3 \ -DATATYPE PLC_5_COUNTER \ -ADDRESS "$C5:4" \ -ADDRTYPE UNCONSTRAINED BSTR> CREATE UNNAMED_VARIABLE slc_5_04.p1 \ -DATATYPE INTEGER_16 \ -ADDRESS "$N7:0" \ -ADDRTYPE UNCONSTRAINED Example 3-2 shows the information displayed when you enter the GET VALUE UNNAMED_VARIABLE command. Example 3-2 UNNAMED_VARIABLE GET VALUE Output (continued on next page) Using the DAS 3-7 Using the DAS 3.2 Supported Functions Example 3-2 (Cont.) UNNAMED_VARIABLE GET VALUE Output BSTR> GET VALUE UNNAMED_VARIABLE plc_5_40.p1 20 BSTR> GET VALUE UNNAMED_VARIABLE plc_5_40.p2 array[10] of INTEGER_16 [ 0]: 0 [ 1]: 0 [ 2]: 0 [ 3]: 0 [ 4]: 0 [ 5]: 0 [ 6]: 0 [ 7]: 0 [ 8]: 0 [ 9]: 0 BSTR> GET VALUE UNNAMED_VARIABLE plc_5_40.p3 structure PLC_5_COUNTER { CONTROL: 0 PRE: 0 ACC: 0 } Example 3-3 shows the information displayed when you enter the PUT VALUE UNNAMED_VARIABLE command. Example 3-3 UNNAMED_VARIABLE PUT VALUE Output BSTR> PUT VALUE UNNAMED_VARIABLE plc_5_40.p1 (Bit) : 1 BSTR> PUT VALUE UNNAMED_VARIABLE plc_5_40.p2 (continued on next page) 3-8 Using the DAS Using the DAS 3.2 Supported Functions Example 3-3 (Cont.) UNNAMED_VARIABLE PUT VALUE Output array[10] of INTEGER_16 [ 0]: (Integer 16) : 1 [ 1]: (Integer 16) : 2 [ 2]: (Integer 16) : 3 [ 3]: (Integer 16) : 4 [ 4]: (Integer 16) : 5 [ 5]: (Integer 16) : 6 [ 6]: (Integer 16) : 7 [ 7]: (Integer 16) : 8 [ 8]: (Integer 16) : 9 [ 9]: (Integer 16) : 10 3.2.3 Read and Write Data Point Functions Use the read data point and write data point functions to read data from and write data to a device in a device independent way. Table 3-4 lists the read and write data point functions available through the BASEstar Open (CLI) interface and BASEstar Open (API) interface. Table_3-4_Read_and_Write_Data_Point_Interface_Access_______ Interface___Function_Name__________________________________ CLI GET VALUE DATA_POINT PUT VALUE DATA_POINT API bstr_data_point_get_value ____________bstr_data_point_put_value______________________ Using the DAS 3-9 Using the DAS 3.2 Supported Functions Example 3-4 shows examples of creating a device data point using the CREATE DEVICE_DATA_POINT command. Example 3-4 DEVICE_DATA_POINT CREATE Command BSTR> CREATE DEVICE_DATA_POINT /plc_2_15/p1 \ -DATATYPE UNSIGNED_16 \ -UPDATE_POLICY SOLICITED \ -ACCESS_POLICY ALWAYS \ -DEVICE_ACCESS RDWR \ -VMD_NAME plc_2_15 \ -VAR_NAME p1 \ -VAR_CLASS UNNAMED BSTR> CREATE DEVICE_DATA_POINT /plc_3/p1 \ -DATATYPE INTEGER_16 \ -UPDATE_POLICY SOLICITED \ -ACCESS_POLICY ALWAYS \ -DEVICE_ACCESS RDWR \ -VMD_NAME plc_3 \ -VAR_NAME p1 \ -VAR_CLASS UNNAMED BSTR> CREATE DEVICE_DATA_POINT /plc_5_40/p1 \ -DATATYPE BIT \ -UPDATE_POLICY SOLICITED \ -ACCESS_POLICY ALWAYS \ -DEVICE_ACCESS RDWR \ -VMD_NAME plc_5_40 \ -VAR_NAME p1 \ -VAR_CLASS UNNAMED BSTR> CREATE DEVICE_DATA_POINT /plc_5_40/p2 \ -DATATYPE WORD_ARRAY_10 \ -UPDATE_POLICY SOLICITED \ -ACCESS_POLICY ALWAYS \ -DEVICE_ACCESS RDWR \ -VMD_NAME plc_5_40 \ -VAR_NAME p2 \ -VAR_CLASS UNNAMED (continued on next page) 3-10 Using the DAS Using the DAS 3.2 Supported Functions Example 3-4 (Cont.) DEVICE_DATA_POINT CREATE Command BSTR> CREATE DEVICE_DATA_POINT /plc_5_40/p3 \ -DATATYPE PLC_5_COUNTER \ -UPDATE_POLICY SOLICITED \ -ACCESS_POLICY ALWAYS \ -DEVICE_ACCESS RDWR \ -VMD_NAME plc_5_40 \ -VAR_NAME p3 \ -VAR_CLASS UNNAMED BSTR> CREATE DEVICE_DATA_POINT /slc_5_04/p1 \ -DATATYPE INTEGER_16 \ -UPDATE_POLICY SOLICITED \ -ACCESS_POLICY ALWAYS \ -DEVICE_ACCESS RDWR \ -VMD_NAME slc_5_04 \ -VAR_NAME p1 \ -VAR_CLASS UNNAMED Using the DAS 3-11 Using the DAS 3.2 Supported Functions Example 3-5 shows the information displayed when you enter the GET VALUE DATA_POINT command. Example 3-5 DATA_POINT GET VALUE Output BSTR> GET VALUE DATA_POINT /plc_5_40/p1 20 BSTR> GET VALUE DATA_POINT /plc_5_40/p2 array[10] of INTEGER_16 [ 0]: 0 [ 1]: 0 [ 2]: 0 [ 3]: 0 [ 4]: 0 [ 5]: 0 [ 6]: 0 [ 7]: 0 [ 8]: 0 [ 9]: 0 BSTR> GET VALUE DATA_POINT /plc_5_40/p3 structure PLC_5_COUNTER { CONTROL: 0 PRE: 0 ACC: 0 } Example 3-6 shows the information displayed when you enter the PUT VALUE DATA_POINT command. Example 3-6 DATA_POINT PUT VALUE Output BSTR> PUT VALUE DATA_POINT /plc_5_40/p1 (Bit) : 1 BSTR> PUT VALUE DATA_POINT /plc_5_40/p2 (continued on next page) 3-12 Using the DAS Using the DAS 3.2 Supported Functions Example 3-6 (Cont.) DATA_POINT PUT VALUE Output array[10] of INTEGER_16 [ 0]: (Integer 16) : 1 [ 1]: (Integer 16) : 2 [ 2]: (Integer 16) : 3 [ 3]: (Integer 16) : 4 [ 4]: (Integer 16) : 5 [ 5]: (Integer 16) : 6 [ 6]: (Integer 16) : 7 [ 7]: (Integer 16) : 8 [ 8]: (Integer 16) : 9 [ 9]: (Integer 16) : 10 Using the DAS 3-13 Using the DAS 3.2 Supported Functions 3.2.4 Receiving Indications An indication is data that is sent to the DAS from the PLC without the DAS specifically requesting the data. The DAS supports write and abort indications. ________________________ Note ________________________ Information reports are also supported for PLC-2, PLC- 3, and PLC-5 for backward compatability purposes only. Configurations should be migrated to use the write indication support as soon as possible. ______________________________________________________ Table 3-5 lists the indication functions available through the OMNI (API) interface. Table_3-5_Indication_Interface_Access______________________ Interface___Function_Name__________________________________ API omni_get_indications ____________omni_get_indications_a_________________________ 3.2.4.1 Write Indications The write indication is used when the PLC is sending data to the host. In order to use the write indication function, a variable must be created on the host's local VMD that matches the address and size of the data being sent by the PLC. Example 3-7 shows an example of how to configure VMDs, actors and activities to receive write indications from a PLC-5 that has been configured to send PLC-2 type messages to the host. A PLC-2 VMD is configured in BASEstar Open to receive the write indications. Note that the PLC-2 has been configured using the PLC-5 protocol profile since it will be receiving write indications from a PLC-5. ________________________ Note ________________________ The path on the PLC-2 is not used since the VMD is only used to receive the write indications and is not used in establishing communications to the PLC. ______________________________________________________ 3-14 Using the DAS Using the DAS 3.2 Supported Functions Example 3-7 Write Indication Configuration CREATE PROTOCOL_PROFILE ab_plc5 \ -APPLPROFID 53 \ -MAXPDUSIZE 1024 \ -SMA_MODE ENABLED \ -LOG CREATE VMD plc_2_30 -MODEL "PLC_2_30" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=PLC_2_30_PATH":ab_plc5 \ -DESCRIPTION "PLC 2/30" \ -LOG CREATE VMD plc_5_40 -MODEL "PLC_5_40" \ -VENDOR "AB" \ -DVM_ACCESS_POINT "/PATH=PLC_5_40_PATH":ab_plc5 \ -DESCRIPTION "PLC 5/40" \ -LOG ! ! Create actors/activities for the VMDs ! CREATE NODE ab_node -PHYSICAL "your_node" -LOG CREATE DOMAIN /ab_data CREATE ACTOR /AB_IND -LOG SET CONTEXT /AB_IND CREATE PROGRAM ab_data_srv -PROGRAM_KIND DATADEV \ -PARAM AB_PARAM:AB.PAR \ -LOG CREATE_PROGRAM ab_event_srv -PROGRAM_KIND EVENT \ -LOG CREATE ACTIVITY ab_data_act -PROGRAM ab_data_srv \ -NODES (ab_node) \ -DOMAINS (/ab_data) \ -VMDS (plc_5_40) \ -LOG Using the DAS 3-15 Using the DAS 3.2 Supported Functions CREATE ACTIVITY ab_event_act -PROGRAM ab_event_srv \ -NODES (ab_node) \ -DOMAINS (/ab_data) \ -LOG The CREATE PROGRAM command shown in Example 3-7 has an additional attribute, the -PARAM attribute, that specifies a parameter file to be read by the ab_data_srv program. The parameter file contains the name of the local VMD to receive the write indications as shown in Example 3-8. See BASEstar Open for OpenVMS Management Guide for more information on possible contents of the parameter file. Example 3-8 AB.PAR Contents /AB_IND/ab_data_srv.env: BSTR_LOCAL_VMD_NAME=plc_2_30 Only one parameter file can be specified per program so BASEstar Open limits the number of local VMDs that can be specified to one per program. This limitation means that all write indications for a particular program must be directed to one local VMD, so all PLCs connected to that line must use unique addresses to ensure that the data from the PLC is uniquely identified. Also, mixing of types writes (i.e. PLC-2 and PLC-5) is not supported. 3-16 Using the DAS Using the DAS 3.2 Supported Functions Example 3-9 shows an example that creates variables, device data points, events, triggers and enboxes to receive write indications from the PLC-5 configured in Example 3-7. Example 3-9 Write Indication Example BSTR> EXECUTE ACTOR /AB_IND -WAIT BSTR> CREATE UNNAMED_VARIABLE plc_2_30.p1 \ -DATATYPE UNSIGNED_16 \ -ADDRESS "200" \ -ADDRTYPE UNCONSTRAINED BSTR> CREATE DEVICE_DATA_POINT /ab_data/p1 \ -DATATYPE UNSIGNED_16 \ -UPDATE_POLICY UNSOLICITED \ -ACCESS_POLICY ON_REQUEST \ -DEVICE_ACCESS READ \ -VMD_NAME plc_2_30 \ -VAR_NAME p1 \ -VAR_CLASS UNNAMED BSTR> CREATE ENBOX /ab_data/enbox1 \ -QUEUE_KIND SEQUENTIAL \ -ENBOX_KIND SYSTEM_BUFFERING \ -MAX_NOTIFICATIONS 10 BSTR> CREATE EVENT /ab_data/e1 \ -PARAMETER_TYPES (INTEGER_16) BSTR> CREATE TRIGGER /ab_data/t1 \ -STATE ENABLED \ -TRIGGER_EVALUATION ON_WRITE \ -DATA_POINT /ab_data/p1 \ -EVENT /ab_data/e1 \ -EVE_PARAMETERS (/ab_data/p1:VALUE) BSTR> ADD SUBSCRIPTION EVENT /ab_data/e1 /ab_data/enbox1 \ -NOTIFICATION PARAMETERS_LIST \ -STATE ENABLED BSTR> CONNECT ENBOX /ab_data/enbox1 (continued on next page) Using the DAS 3-17 Using the DAS 3.2 Supported Functions Example 3-9 (Cont.) Write Indication Example BSTR> RECEIVE NOTIFICATION ENBOX /ab_data/enbox1 Event : /ab_data/e1 Origin : /ab_data/t1 Priority : 0 Confirmation : NOT_CONFIRMED Notification_id : 1 User_parameter : 0 Notification_format: PARAMETERS_LIST Time : Fri Mar 17 08:26:50 2000 Parameter 1 value: 1 BSTR> DISCONNECT ENBOX /ab_data/enbox1 BSTR> REMOVE SUBSCRIPTION EVENT /ab_data/e1 /ab_data/enbox1 The use of the value INIT_UNSOLICITED for the -UPDATE_ POLICY qualifier is not supported for write indications since the address of the variable in the remote VMD is not available. If an application requires the value of an unsolicited variable when starting, before the value has been updated by the device, create a device data point and unnamed variable on the remote VMD and use that to read the initial value. If a PLC has been programmed to send data to the host and a variable is found that matches the address of the data being sent, a write indication is generated specifying the variable that was found. If more than one variable is configured that matches the address of the data being sent, then an indication is generated for only the first variable found. Table 3-6 lists the functions to use when programming the PLC to send data to the host for each PLC family. Sending PLC-2 protected or unprotected writes is supported for all PLC families. For SLC controllers use the 485CIF target device to send PLC-2 messages. Also for SLC controllers the destination address is specified as a decimal byte offset. This value must be converted to a word octal address to obtain the unnamed variable address to use for the message coming from the device. 3-18 Using the DAS Using the DAS 3.2 Supported Functions Table_3-6_Supported_PLC_Write_Functions____________________ _PLC_Family_ Remote Local VMD____VMD____Function_Name____Address_Type________________ PLC 2 PLC 2 Protected or PLC-2 address Unprotected Write PLC 3 PLC 2 Protected or PLC-2 address Unprotected Write PLC 3 PLC 3 Word Range PLC-3 Logical binary address Write PLC 5 PLC 2 Protected or PLC-2 address Unprotected Write PLC 5 PLC-5 Typed Write PLC-5 Logical binary or ASCII address SLC PLC 2 Protected or PLC-2 address Unprotected Write SLC SLC Protected Typed SLC address ______________Logical_Write________________________________ 3.2.4.2 Abort Indications An abort indication is generated by the DAS when it loses a connection to the PLC. The DAS detects that a connection is broken under the following conditions: o When a request to the KE/KF card times out. In this case all connections using this communication card are aborted. o When an error is returned from a QIO call. In this case all connections using this port are aborted. o When a LOCAL status code of X'02' is returned from the KE/KF card. In this case the KE/KF cards is unable to communicate to the remote PLC. In this case only the connection to the PLC for which the X'02' status code is returned is aborted. Using the DAS 3-19 Using the DAS 3.3 Addressing Syntax and Supported Data Types 3.3 Addressing Syntax and Supported Data Types Data types are defined at the device and application levels. The device data type is referred to as the MMS data type. The MMS data type is mapped to an application data type. Data types can be either simple or complex. Simple data types are native to the OMNI environment. Complex data types are divided into either arrays or structures. Complex data types must be created by a user before they can be used in defining data points or variables. The following sections describe the supported data types and addressing syntax for each of the supported PLC families. 3.3.1 PLC-2 Addressing Syntax and Supported Data Types Figure 3-1 shows the structure of a legal address for the PLC-2 family. Figure 3-1 General PLC-2 Address Format 3-20 Using the DAS Using the DAS 3.3 Addressing Syntax and Supported Data Types Table 3-7 shows examples of valid addresses for the PLC-2 family. Table_3-7_Example_PLC-2_Data_Types_________________________ Example Address_____MMS_Type[1]______Description___________________ 377 UNSIGNED_16 Word 377 octal including status bits[2] 20 BCD3[3] Word 20 octal[2] 1777/17 BIT_STRING Bit 17 octal of word 1777 octal[2] 33 Array of 10 Ten words beginning at word 33 BCD3 octal [1]Arrays_are_supported._Structures_are_not_supported._____ Variable size arrays are not supported. [2]Control bits should be treated as read only and modified only under PLC program control. Modifying these bits from a computer can give unpredictable results. [3]The number must be a valid BCD number from 0-999. Status bits are cleared. ___________________________________________________________ 3.3.2 PLC-3 Addressing Syntax and Supported Data Types The PLC-3 family supports the following addressing syntaxes: o Data table addressing o Extended addressing Section 3.3.2.1 and Section 3.3.2.2 describe these addressing syntaxes. 3.3.2.1 PLC-3 Data Table Addressing The structure of a legal data table address for the PLC-3 differs depending on the table that is being addressed. The PLC-3 supports the following data table sections: I - Input O - Output C - Counter T - Timer A - ASCII Using the DAS 3-21 Using the DAS 3.3 Addressing Syntax and Supported Data Types B - Binary D - Decimal F - Floating-Point H - High-Order Integer N - Integer S - Status P - Pointer Figure 3-2 shows the structure of a legal I/O data table address for the PLC-3. Table 3-8 shows examples of legal I/O data table addresses for the PLC-3. Figure 3-2 PLC-3 I/O Data Table Address Format Table_3-8_Example_PLC-3_I/O_Data_Table_Addresses___________ Example Address_____MMS_Type[1]______Description___________________ I20 UNSIGNED_16 Input image rack 2 group 0 octal I377 INTEGER_16 Input image rack 37 group 7 octal I1:1777/17 BIT_STRING Bit 17 of word 1777 octal in file 1 decimal $O33:77/1 BIT_STRING Bit 1 of word 77 octal in file 33 decimal O99:167 INTEGER_16 Word 167 octal in file 99 decimal I0 Array of 10 Ten words beginning at rack 0 UNSIGNED_16 group 0 [1]Arrays_are_supported._Structures_are_not_supported._____ Variable size arrays are not supported. ___________________________________________________________ 3-22 Using the DAS Using the DAS 3.3 Addressing Syntax and Supported Data Types Figure 3-3 shows the structure of a legal Timer or Counter data table address for the PLC-3. Figure 3-4 shows a PLC-3 Timer structure. Figure 3-5 shows a PLC-3 Counter structure. Table 3-9 shows examples of legal Timer or Counter data table addresses for the PLC-3. Figure 3-3 PLC-3 Timer and Counter Data Table Address Format Figure 3-4 PLC-3 Timer Structure Figure 3-5 PLC-3 Counter Structure Using the DAS 3-23 Using the DAS 3.3 Addressing Syntax and Supported Data Types Table 3-9 Example PLC-3 Timer and Counter Data Table __________Addresses________________________________________ Example_Address__MMS_Type[1]______Description______________ $TACC20 UNSIGNED_16 Timer 20 accumulated value CPRE:91 INTEGER_16 Counter 91 preset value TCTL:20/17 BIT_STRING Timer 20 Timer Enable bit[2] T20.TD BIT_STRING Timer 20 Timer Done bit[2] C5 Structure[3] All of counter 5. UNSIGNED_16 Control UNSIGNED_16 Preset value UNSIGNED_16 Accumulated value [1]Arrays_are_not_supported._______________________________ [2]Control bits should be treated as read only and modified only under PLC program control. Modifying these bits from a computer can give unpredictable results. [3]Write operations are not allowed to structures. Fields in the structure can be any combination of three INTEGER_16 or UNSIGNED_16. The control, preset and accumulated values are read in that order. ___________________________________________________________ Figure 3-6 shows the structure of a legal ASCII, Binary, Decimal, Floating-Point, High-Order Integer or Status data table address for the PLC-3. Table 3-10 shows examples of legal ASCII, Binary, Decimal, Floating-Point, High-Order Integer or Status data table addresses for the PLC-3. 3-24 Using the DAS Using the DAS 3.3 Addressing Syntax and Supported Data Types Figure 3-6 PLC-3 ASCII, Binary, Decimal, Floating-Point, High-Order Integer, Integer and Status Data Table Address Format Table 3-10 Example PLC-3 ASCII, Binary, Decimal, Floating- Point, High-Order Integer, Integer and Status ___________Data_Table_Address_Format_______________________ Example Address_____MMS_Type[1]______Description___________________ $S0:0 UNSIGNED_16 Word 0 of status file 0 N20:0 INTEGER_16 Word 0 of integer file 20 D20:780 BCD4[2] Word 780 of decimal (BCD) file 20 F39:19 FLOAT[3] Word 19 of floating-point file 39 H8:20 UNSIGNED_32[4] Word 20 of high-order integer file 8 H99:0 INTEGER_32[4] Word 0 of high-order integer file 99 A10:20 VISIBLE_ Word 20 of ASCII file 10 STRING[5] A7:0 OCTET_STRING[5] Word 0 of ASCII file 7 B5:20/10 BIT_STRING[6] Bit 10 octal of word 20 of binary file 5 [1]Arrays_are_supported._Structures_are_not_supported._____ Variable size arrays are not supported. [2]Decimal (BCD) section only. The data must be a valid BCD number from 0-9999. [3]Floating-point section only. [4]High-order integer section only. [5]ASCII section only. [6]Bit writes that span more than one word are not supported. ___________________________________________________________ Using the DAS 3-25 Using the DAS 3.3 Addressing Syntax and Supported Data Types Figure 3-7 shows the structure of a legal Pointer data table address for the PLC-3. Figure 3-8 shows a PLC-3 Pointer structure. Table 3-11 shows examples of legal Pointer data table addresses for the PLC-3. Figure 3-7 PLC-3 Pointer Data Table Address Format Figure 3-8 PLC-3 Pointer Structure Table_3-11_Example_PLC-3_Pointer_Data_Table_Addresses______ Example_Address__MMS_Type[1]______Description______________ $PFIL:91 INTEGER_16T Pointer 91 file number PSEC:20 UNSIGNED_16 Pointer 20 section number P4 Structure[2] All of pointer 4 UNSIGNED_16 Section UNSIGNED_16 File UNSIGNED_16 Word [1]Writes_are_not_allowed_to_the_pointer_file._Arrays_are__ not supported. [2]Fields in the structure can be any combination of three INTEGER_16 or UNSIGNED_16. The section, file and word values are read in that order. ___________________________________________________________ 3-26 Using the DAS Using the DAS 3.3 Addressing Syntax and Supported Data Types 3.3.2.2 PLC-3 Extended Addressing Extended addressing is an alternative form of addressing memory in the PLC-3. Only data table area addresses are supported (area 3). Figure 3-9 shows the structure of legal extended addresses. Table 3-12 shows example addresses and supported data types for the PLC-3. Figure 3-9 PLC-3 Extended Address Format Table_3-12_Example_PLC-3_Extended_Addresses________________ Example_Address__MMS_Type[1]______Description______________ E3.1.1.0.0.77 INTEGER_16 Word 77 octal of the output image (1) file E3.1.9.0.0.30 VISIBLE_STRING Word 30 of ASCII (9) file 0 E3.1.10.8.99.0 INTEGER_32 Longword 99 of high-order integer (10) file 8 E3.1.4.0.99.2 UNSIGNED_16 Accumulated value of counter (4) 99 E3.1.8.8.0.183 BIT_STRING Bit 16 octal of word 183 /16 of binary (8) file 8 [1]Support_for_data_types_and_arrays_follow_the_same_rules_ as when using data table addressing. Structures are not supported. ___________________________________________________________ Using the DAS 3-27 Using the DAS 3.3 Addressing Syntax and Supported Data Types 3.3.3 PLC-5 Addressing Syntax and Supported Data Types This section describes legal data table addresses and data types for the 1785 PLC-5 family. For information on addresses and supported data types for the PLC-5/250 PLC, refer to Section 3.3.4. The structure of a legal data table address for the PLC-5 differs depending on the table that is being addressed. The PLC-5 supports the following data table sections: I - Input O - Output S - Status B - Binary T - Timer C - Counter R - Control N - Integer F - Floating-Point A - ASCII D - Decimal ST - String SC - SFC Status BT - Block-Transfer Control TD - Token Data PD - PID Control MG - Message Control Figure 3-10 shows the structure of a legal I/O data table address for the PLC-5. Table 3-13 shows examples of legal I/O data table addresses for the PLC-5. Figure 3-10 PLC-5 I/O Data Table Address Format 3-28 Using the DAS Using the DAS 3.3 Addressing Syntax and Supported Data Types Table_3-13_Example_PLC-5_I/O_Data_Table_Addresses__________ Example Address_____MMS_Type[1]______Description___________________ I:20 UNSIGNED_16 Input image rack 2 group 0 octal I:277 INTEGER_16 Input image rack 27 group 7 octal I:177/17 BIT_STRING Bit 17 of rack 17 group 7 octal $O:77/1 BIT_STRING Bit 1 of rack 7 group 7 octal I:0 Array of 10 Ten words beginning at rack 0 UNSIGNED_16 group 0 [1]Arrays_are_supported._Structures_are_not_supported._____ Variable size arrays are not supported. ___________________________________________________________ Figure 3-11 shows the structure of a legal Status data table address for the PLC-5. Table 3-14 shows examples of legal Status data table addresses for the PLC-5. Figure 3-11 PLC-5 Status Data Table Address Format Using the DAS 3-29 Using the DAS 3.3 Addressing Syntax and Supported Data Types Table_3-14_Example_PLC-5_Status_Data_Table_Addresses_______ Example Address_____MMS_Type[1]______Description___________________ S:20 UNSIGNED_16 Word 20 of the status file S:12 INTEGER_16 Word 12 of the status file $S:125/1 BIT_STRING Bit 1 of word 125 of the status file S:0 Array of 10 Ten words beginning at word 0 UNSIGNED_16 [1]Arrays_are_supported._Structures_are_not_supported._____ Variable size arrays are not supported. ___________________________________________________________ Figure 3-12 shows the structure of a legal ASCII, Binary, Decimal, Floating-Point or Integer data table address for the PLC-5. Table 3-15 shows examples of legal ASCII, Binary, Decimal, Floating-Point and Integer data table addresses for the PLC-5. Figure 3-12 PLC-5 ASCII, Binary, Decimal, Floating-Point and Integer Data Table Address Format 3-30 Using the DAS Using the DAS 3.3 Addressing Syntax and Supported Data Types Table 3-15 Example PLC-5 ASCII, Binary, Decimal, Floating- ___________Point_and_Integer_Data_Table_Address_Format_____ Example Address_____MMS_Type[1]______Description___________________ $N20:0 INTEGER_16 Word 0 of integer file 20 D20:780 BCD4[2] Word 780 of decimal (BCD) file 20 F39:19 FLOAT[3] Word 19 of floating-point file 39 A10:20 VISIBLE_ Word 20 of ASCII file 10 STRING[5] A11:0 OCTET_STRING[4] Word 0 of ASCII file 11 B91:20/10 BIT_STRING[5] Bit 10 of word 20 of binary file 91 B:33 UNSIGNED_16 Word 33 of the default binary file (3) N:91 UNSIGNED_16 Word 91 of the default integer file (7) F:3 FLOAT Word 3 of the default floating-point file (8) B/155 BIT_STRING Bit 11 of word 9 in the default binary file (3) [1]Arrays_are_supported._Structures_are_not_supported._____ Variable size arrays are not supported. [2]Decimal (BCD) section only. The data must be a valid BCD number from 0-9999. [3]Floating-point section only. [4]ASCII section only. [5]Bit writes that span more than one element are not supported. ___________________________________________________________ Figure 3-13 shows the structure of a legal Timer, Counter, Control, SFC Status, Block-Transfer Control, Token Data, ASCII String, PID Control or Message Control data table address for the PLC-5. Figure 3-14 shows a PLC-5 Timer structure. Figure 3-15 shows a PLC-5 Counter structure. Figure 3-16 shows a PLC-5 Control structure. Figure 3-17 shows a PLC-5 SFC Status structure. Using the DAS 3-31 Using the DAS 3.3 Addressing Syntax and Supported Data Types Figure 3-18 shows a PLC-5 Block-Transfer Control structure. Figure 3-19 shows a PLC-5 Token Data structure. Figure 3-20 shows a PLC-5 ASCII String structure. Figure 3-21 shows a PLC-5 PID Control structure. Figure 3-22 shows a PLC-5 Message Control structure. Table 3-16 shows examples of legal Timer, Counter, Control, SFC Status, Block-Transfer Control, Token Data, ASCII String, PID Control and Message Control data table addresses for the PLC-5. Figure 3-13 PLC-5 Timer, Counter, Control, SFC Status, Block-Transfer Control, Token Data, ASCII String, PID Control and Message Control Data Table Address Format Figure 3-14 PLC-5 Timer Structure Figure 3-15 PLC-5 Counter Structure 3-32 Using the DAS Using the DAS 3.3 Addressing Syntax and Supported Data Ty