Digital Device Access Software for Modicon® with DEComni[TM] on_Digital_UNIX[TM]_________________________________ Installation and User's Guide Order Number: AA-Q5FSB-TE April 1996 This manual describes how to install and use the Digital Device Access Software for Modicon programmable controllers with the DEComni for Digital UNIX interface. Revision/Update Information: This is a revised document. Operating System and Version: Digital UNIX Version 3.2 Interface Software and Version:EComni Version 3.0 Software Version: Device Access Software for Modicon, Version 3.0 Digital Equipment Corporation Maynard, Massachusetts ________________________________________________________________ April 1996 Possession, use, or copying of the software described in this publication is authorized only pursuant to a valid written license from Digital or an authorized sublicensor. Digital Equipment Corporation makes no representations that the use of its products in the manner described in this publication will not infringe on existing or future patent rights, nor do the descriptions contained in this publication imply the granting of licenses to make, use, or sell equipment or software in accordance with the description. © Digital Equipment Corporation 1994, 1996. All Rights Reserved. The following are trademarks of Digital Equipment Corporation: Alpha, BASEstar, DEComni, Digital, OpenVMS, TK, VAX, and the Digital logo. UNIX is a registered trademark in the United States and other countries licensed exclusively through X/Open Company Ltd. Modicon and Modbus are registered trademarks of AEG Schneider Automation. All other trademarks and registered trademarks are the property of their respective holders. This document is available on CDROM. This document was prepared using DEC DOCUMENT Version 2.3. _________________________________________________________________ Contents Preface................................................... v 1 Overview 1.1 Description................................... 1-1 1.2 Device Communications......................... 1-1 1.3 Supported Functions and Devices............... 1-2 2 Installing and Configuring the DAS for Modicon Programmable Controllers 2.1 Installation Requirements..................... 2-1 2.1.1 Hardware.................................. 2-1 2.1.2 Software.................................. 2-2 2.1.3 Disk Space................................ 2-3 2.2 Installing the DAS for Modicon Programmable Controllers................................... 2-3 2.2.1 Files Created During Installation......... 2-6 2.3 Postinstallation Tasks........................ 2-6 2.3.1 Editing the Configuration Files........... 2-7 2.3.1.1 Editing ODS Registrations............... 2-7 2.3.1.2 DAS for Modicon Programmable Controllers Configuration Files..................... 2-9 2.3.2 Configuring Ports......................... 2-10 2.3.3 Setting Up Plant-Floor Equipment.......... 2-11 2.3.4 Tracing Device Communications............. 2-11 2.4 Failures During Product Use................... 2-12 iii 3 Using the DAS for Modicon Programmable Controllers 3.1 Accessing Modicon Functions................... 3-1 3.2 Supported Functions........................... 3-1 3.2.1 Connect, Conclude and Abort Functions..... 3-2 3.2.2 Read and Write Variable Functions......... 3-2 3.2.3 Abort Indications........................ 3-4 3.3 Addressing Syntax and Supported Data Types.... 3-4 3.3.1 Modicon Micro 84 Addressing Syntax and Supported Data Types...................... 3-5 3.3.2 Modicon 184 and 384 Addressing Syntax and Supported Data Types...................... 3-5 3.3.3 Modicon 484 Addressing Syntax and Supported Data Types...................... 3-6 3.3.4 Modicon 884 Addressing Syntax and Supported Data Types...................... 3-6 3.3.5 Modicon 584 and 984 Addressing Syntax and Supported Data Types...................... 3-7 A Error Messages Index Examples 2-1 ODS Registration.......................... 2-7 2-2 DAS for Modicon Programmable Controllers ODS Configuration File.................... 2-9 Figures 1-1 DAS Communications........................ 1-2 2-1 Modbus Communications..................... 2-2 2-2 Modbus RS-232 Pinouts..................... 2-2 iv Tables 2-1 Disk Space Requirements................... 2-3 2-2 Files Created for the DAS for Modicon Programmable Controllers.................. 2-6 2-3 REGISTER Attributes....................... 2-8 3-1 Connect, Conclude and Abort Interface Access.................................... 3-2 3-2 Read and Write Variable Types............. 3-3 3-3 Read and Write Variable Interface Access.................................... 3-4 3-4 Indication Interface Access............... 3-4 3-5 Modicon Micro 84 Address Format........... 3-5 3-6 Modicon 184 and 384 Address Format........ 3-5 3-7 Modicon 484 Address Format................ 3-6 3-8 Modicon 884 Address Format................ 3-6 3-9 Modicon 584 and 984 Address Format........ 3-7 v _________________________________________________________________ Preface This document describes how to install and use the Digital Device Access Software for Modicon Programmable Controllers. Intended Audience This document is intended for system managers who must set up and maintain the following: o DEComni software o Digital Device Access Software for Modicon Programmable Controllers This document is also intended for application programmers who develop plant-floor management software layered on DEComni software. Readers of this document should have knowledge of: o Digital UNIX operations and administration o Digital UNIX application software o DEComni software o Site-specific installation requirements In addition, knowledge of the Modicon programmable controllers is required. v Document Structure This document is organized as follows: o Chapter 1 provides an overview of the DAS for Modicon programmable controllers. o Chapter 2 provides the information you need to install and configure the DAS for Modicon programmable controllers. o Chapter 3 provides information about the supported functions for Modicon programmable controllers, and how to access the functions. Associated Documents For information on installing and configuring a DEComni system, refer to the following documents: o DEComni for Digital UNIX Installation Guide o DEComni for Digital UNIX Guide to Using Omni Directory Services o DEComni for Digital UNIX Guide to Using OmniView For more information on developing software to integrate manufacturing applications and equipment, refer to the following documents: o DEComni for Digital UNIX Application Programmer's Interface For information on Modicon programmable controller communications and addressing, refer to the following documents: o Modicon Protocol Reference Guide o Modicon DEC Host Based Devices Users Guide vi 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 . vii 1 _________________________________________________________________ Overview This chapter provides an overview of the Digital Device Access Software for Modicon Programmable Controllers. It also briefly describes Modicon programmable controller communications, and the supported functions for the DAS for Modicon programmable controllers. 1.1 Description The DAS for Modicon programmable controllers allows you to access Modicon programmable controllers using DEComni Services. DEComni Services provides the Applications Programming Interface (API) used to communicate with shop floor devices. DEComni uses the Manufacturing Messaging Specification (MMS) (ISO-9506) model to communicate with shop floor devices. DEComni also has the capability to support non-MMS devices such as Modicon programmable controllers through protocol specific Device Access Software, such as the DAS for Modicon programmable controllers. Using the DAS for Modicon programmable controllers, applications can perform a variety of device access functions for the Modicon programmable controllers. 1.2 Device Communications The DAS for Modicon programmable controllers consists of software that provides device-specific communications for users of the DEComni API. The DAS software communicates the requests and data directly with an Digital UNIX device driver to send data to and receive data from plant-floor devices. Figure 1-1 shows how the DAS for Modicon programmable controllers Overview 1-1 Overview 1.2 Device Communications facilitates communications between DEComni applications 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 Modicon programmable controllers supports the following DEComni Services functions for Modicon programmable controllers: 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 an abort from a device (omni_get_indications) The DAS for Modicon programmable controllers supports the following Modicon programmable controllers: o Modicon Micro 84 controllers o Modicon 184 controllers o Modicon 384 controllers o Modicon 484 controllers o Modicon 584 controllers o Modicon 884 controllers o Modicon 984 controllers 1-2 Overview Overview 1.3 Supported Functions and Devices For more information about the supported functions for these programmable controllers, refer to Chapter 3 of this document. Overview 1-3 2 _________________________________________________________________ Installing and Configuring the DAS for Modicon Programmable Controllers This chapter provides the information you need to install the DAS for Modicon programmable controllers 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 Modicon programmable controllers installation. 2.1.1 Hardware The hardware requirements for the DAS for Modicon programmable controllers are the same as those for the DEComni software. For specific hardware requirements, refer to the DEComni for Digital UNIX Installation Guide. Additional hardware required for configuring the DAS for Modicon programmable controllers using Modbus includes: o Any supported Modicon programmable controller. o J478 Modbus modem to connect to the Digital UNIX system. o J478 Modbus modem to connect to the programmable controller. o A cable from the Digital UNIX system to the Modbus modem. o J374 Modbus communications adapter if using Modicon 184 or 384 programmable controllers. o J474 Modbus communications adapter if using Modicon 484 programmable controllers. and Configuring the DAS for Modicon Programmable Controllers 2-1 Installing and Configuring the DAS for Modicon Programmable Controllers 2.1 Installation Requirements Figure 2-1 shows the required hardware for each model of programmable controller. Figure 2-1 Modbus Communications The cable to the J478 Modbus modem must be terminated with a 25 pin male RS232-C connector with pinouts as shown in Figure 2-2. Figure 2-2 Modbus RS-232 Pinouts 2.1.2 Software The following software must be installed prior to installing DAS for Modicon programmable controllers: o Digital UNIX Version 3.2 o DEComni Version 3.0 For more information on installing DEComni software, refer to the DEComni for Digital UNIX 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 Digital UNIX. ______________________________________________________ 2-2 Installing and Configuring the DAS for Modicon Programmable Controllers Installing and Configuring the DAS for Modicon Programmable Controllers 2.1 Installation Requirements 2.1.3 Disk Space Table 2-1 lists the disk space required to install the DAS for Modicon programmable controllers. 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_____________________(Kilobytes)______________________ Peak (during 900 installation) Net_(after_installation)__500______________________________ 2.2 Installing the DAS for Modicon Programmable Controllers When your system meets all hardware and software requirements, you can install the DAS for Modicon programmable controllers. The installation takes from 1 to 5 minutes, depending on your system load and configuration. Install the DAS for Modicon programmable controllers by using the following steps: ________________________ Note ________________________ The following procedure describes how to install from a TK50 magnetic tape cartridge. ______________________________________________________ 1. Log in as superuser. 2. Set your directory to the root (/) directory by entering the following command: # cd / 3. Use setld to load the DAS subset. # /etc/setld -l /dev/rmt0h and Configuring the DAS for Modicon Programmable Controllers 2-3 Installing and Configuring the DAS for Modicon Programmable Controllers 2.2 Installing the DAS for Modicon Programmable Controllers 4. The installation procedure displays the following information and prompt: Please make sure your installation tape is mounted and on-line. Are you ready (y/n)? After all tape rewind and wind operations are complete and the tape drive indicates online status, enter y. 5. Select the subset(s) to load. The installation procedure displays the name of the DAS for Modicon programmable controllers subset and asks you to specify the subsets that you want to load. Enter the subsets that you want to install separated by spaces, not commas. 6. Verify your selection. The script then prompts you to verify your choice. Enter y to confirm the selection. The following is an example of the output from a typical installation: # cd / # /usr/sbin/setld -l /dev/rmt0h Please make sure your installation tape is mounted and on-line. Are you ready (y/n)? y Copyright (C) Digital Equipment Corporation. 1994, 1996. All Rights Reserved. Restricted Rights: Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c) (1) (ii) of DFARS 252.227-7013, or in FAR 52.227-19, or in FAR 52.227-14 Alt. III, as applicable. This software is proprietary to and embodies the confidential technology of Digital Equipment Corporation. Possession, use, or copying of this software and media is authorized only pursuant to a valid written license from Digital or an authorized sublicensor. The subsets listed below are optional: There may be more optional subsets than can be presented on a single screen. If this is the case, you can choose subsets screen by screen or all at once on the last screen. All of the choices you make will be collected for your confirmation before any subsets are installed. 1) Digital Device Access Software for Modicon 2-4 Installing and Configuring the DAS for Modicon Programmable Controllers Installing and Configuring the DAS for Modicon Programmable Controllers 2.2 Installing the DAS for Modicon Programmable Controllers Or you may choose one of the following options: 2) ALL of the above 3) CANCEL selections and redisplay menus 4) EXIT without installing any subsets Enter your choices or press RETURN to redisplay menus. Choices (for example, 1 2 4-6): 1 You are installing the following optional subsets: Digital Device Access Software for Modicon Is this correct? (y/n): y Checking file system space required to install selected subsets: File system space checked OK. Digital Device Access Software for Modicon Copying from /dev/rmt0h (tape) Verifying Release Notes for DOUMOD300 are located in ./usr/opt/doumod300/doc/ BASEstar Open is installed on this node. The Modicon DAS can optionally provide support for BASEstar Open. If BASEstar Open support is selected, error messages are logged to the BASEstar Open log file rather than syserr and configuration template files for use with BASEstar Open are provided. Do you want BASEstar Open support ? (y/n) n -----------------------------------NOTE-------------------------------------- During installation the file ods_mod_config.template is placed in the /ods/scripts directory. Copy and edit this file to create site specific /PATH and /LINE directory definitions for devices at your installation. Press Return to continue: DOUMOD300 software successfully installed. Configuring "Digital Device Access Software for Modicon" (DOUMOD300) Installation configuration procedure for DOUMOD300. Now modifying the ODS schema to add Modicon specific object classes and attributes... Now registering Digital Device Access Software for Modicon with DEComni... and Configuring the DAS for Modicon Programmable Controllers 2-5 Installing and Configuring the DAS for Modicon Programmable Controllers 2.2 Installing the DAS for Modicon Programmable Controllers It is recommended that you run the IVP to verify the installation: you can run it now by replying 'yes' to the following question, or you can run it later using the following command: setld -v DOUMOD300 Do you want to run the IVP now ? (y/n) y Copyright (C) Digital Equipment Corporation. 1994, 1996. All Rights Reserved. Restricted Rights: Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c) (1) (ii) of DFARS 252.227-7013, or in FAR 52.227-19, or in FAR 52.227-14 Alt. III, as applicable. This software is proprietary to and embodies the confidential technology of Digital Equipment Corporation. Possession, use, or copying of this software and media is authorized only pursuant to a valid written license from Digital or an authorized sublicensor. Installation Verification Procedure Verifying links... Verifying ODS attributes... Verifying ODS classes... Installation verification of DOUMOD300 succeeded. 2.2.1 Files Created During Installation Table 2-2 lists the files created by the DAS for Modicon programmable controllers installation procedure, and the directories in which those files are placed. Table 2-2 Files Created for the DAS for Modicon __________Programmable_Controllers_________________________ Directory_____________Filename_____________________________ /ods/scripts__________ods_mod_config.template______________ 2.3 Postinstallation Tasks Before using the DAS for Modicon programmable controllers you must perform the following postinstallation tasks: o Edit the configuration files o Configure ports 2-6 Installing and Configuring the DAS for Modicon Programmable Controllers Installing and Configuring the DAS for Modicon Programmable Controllers 2.3 Postinstallation Tasks o Set up plant-floor equipment 2.3.1 Editing the Configuration Files The configuration script, /usr/var/opt/doumod300/etc/ods_ mod_config.template/etc is supplied with the DAS for Modicon programmable controllers. The ODS configuration file contains Omni Directory Services (ODS) registration commands for Modicon specific classes and attributes. Copy the template file and edit it to include site-specific directory definitions. When you complete your edits, execute the file to create the ODS definitions. The following section provides examples of ODS definitions from the configuration file, and indicates which attributes can be modified. For more information about registering ODS definitions, refer to the DEComni for Digital UNIX Guide to Using Omni Directory Services. 2.3.1.1 Editing ODS Registrations ODS registrations allow the DAS software to locate a particular device on an Modicon Modbus network. Example 2-1 shows the configuration file commands that create the ODS registrations. Example 2-1 ODS Registration REGISTER DIRECTORY NAME "/LINE=MODBUS" ATTRIBUTES "OC=MODBUS_LINE/PORT=tty06 /RETRIES=3/SPEED=9600/PARITY=none/MODEM=0/TIMEOUT=3/TRACE=0" REGISTER DIRECTORY NAME "/PATH=MOD984_PATH" ATTRIBUTES "OC=MODBUS_PATH /LINE_NAME=(/LINE=MODBUS)/SLAVE_ADDRESS=20/TRACE=0" REGISTER DIRECTORY NAME "/PATH=MOD884_PATH" ATTRIBUTES "OC=MODBUS_PATH /LINE_NAME=(/LINE=MODBUS)/SLAVE_ADDRESS=21/TRACE=0" REGISTER DIRECTORY NAME "/PATH=MOD584_PATH" ATTRIBUTES "OC=MODBUS_PATH /LINE_NAME=(/LINE=MODBUS)/SLAVE_ADDRESS=22/TRACE=0" REGISTER DIRECTORY NAME "/PATH=MOD484_PATH" ATTRIBUTES "OC=MODBUS_PATH /LINE_NAME=(/LINE=MODBUS)/SLAVE_ADDRESS=23/TRACE=0" 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. Table 2-3 lists the classes and attributes that are supported for Modicon devices. and Configuring the DAS for Modicon Programmable Controllers 2-7 Installing and Configuring the DAS for Modicon Programmable Controllers 2.3 Postinstallation Tasks Table_2-3_REGISTER_Attributes______________________________ Class____________Attribute________Value(s)_________________ MODBUS_LINE PORT tty06, tty07, etc.[1] SPEED 110 - 9600 PARITY NONE, EVEN, ODD MODEM TRUE, ON, YES, 1 or FALSE, OFF, NO, 0 TIMEOUT 2-10[2] RETRIES 0-20 TRACE[3] TRUE, ON, YES, 1 or FALSE, OFF, NO, 0 MODBUS_PATH LINE_NAME /LINE=xxx[4] SLAVE_ADDRESS 1-247 TRACE[3] TRUE, ON, YES, 1 or FALSE, OFF, NO, 0 [1]Do_not_use_/dev/tty07._The_DAS_prefixes_the_port_name___ with /dev/ when connecting to the device. [2]Seconds. [3]Trace is used to allow troubleshooting of the device communications. See Section 2.3.4 for details. [4]Specify a name registered earlier with ODS that specifies the line that the programmable controller with this slave address will be using. ___________________________________________________________ 2-8 Installing and Configuring the DAS for Modicon Programmable Controllers Installing and Configuring the DAS for Modicon Programmable Controllers 2.3 Postinstallation Tasks 2.3.1.2 DAS for Modicon Programmable Controllers Configuration Files Example 2-2 is a sample of the ODS configuration file for the DAS for Modicon programmable controllers. Example 2-2 DAS for Modicon Programmable Controllers ODS Configuration File #! /bin/csh #********************************************************************! # ! # This is a template for the Modicon-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. ! # ! #********************************************************************! # setenv ODSCL /usr/bin/odscl # # Register the ODS definitions. # $ODSCL << _register_end_ REGISTER DIRECTORY NAME "/LINE=MODBUS" ATTRIBUTES "OC=MODBUS_LINE/PORT=tty06 /RETRIES=3/SPEED=9600/PARITY=none/MODEM=0/TIMEOUT=3/TRACE=0" REGISTER DIRECTORY NAME "/PATH=MOD984_PATH" ATTRIBUTES "OC=MODBUS_PATH /LINE_NAME=(/LINE=MODBUS)/SLAVE_ADDRESS=20/TRACE=0" REGISTER DIRECTORY NAME "/PATH=MOD884_PATH" ATTRIBUTES "OC=MODBUS_PATH /LINE_NAME=(/LINE=MODBUS)/SLAVE_ADDRESS=21/TRACE=0" REGISTER DIRECTORY NAME "/PATH=MOD584_PATH" ATTRIBUTES "OC=MODBUS_PATH /LINE_NAME=(/LINE=MODBUS)/SLAVE_ADDRESS=22/TRACE=0" REGISTER DIRECTORY NAME "/PATH=MOD484_PATH" ATTRIBUTES "OC=MODBUS_PATH /LINE_NAME=(/LINE=MODBUS)/SLAVE_ADDRESS=23/TRACE=0" EXIT _register_end_ and Configuring the DAS for Modicon Programmable Controllers 2-9 Installing and Configuring the DAS for Modicon Programmable Controllers 2.3 Postinstallation Tasks To execute the ODS command file, enter the following command at the user prompt: /ods/scripts/ods_mod_config.template For more information about maintaining ODS definitions, refer to the DEComni for Digital UNIX Guide to Using Omni Directory Services. 2.3.2 Configuring Ports You can physically connect a device to a Local Area Transport (LAT) port. To use a LAT port with the DAS, you must define the LAT port on the Digital UNIX system using the LAT control program. For example, to define port_2 on the LAT node srvr4 as /dev/tty06, perform the following steps: 1. Log in as superuser. 2. Use latcp to define the port: # /usr/sbin/latcp -A -p tty06 -H SRVR4 -R PORT_2 -Q Use the /usr/sbin/latsetup script to create the desired LAT ports and to create the entries in the /etc/inittab file. Do not create entries in the /etc/inittab for LAT ports that you want to use in communicating with the programmable controllers. Entries in /etc/inittab are only for interactive LAT ports. NOTE: Currently the LAT software on Digital UNIX does not recognize port disconnects properly and will not reconnect if the port is logged off. The LAT software also does not return an error if the LAT port has not been configured properly. For these reasons, care must be exercised when using LAT ports in a production environment. For the DAS for Modicon programmable controllers 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: 2-10 Installing and Configuring the DAS for Modicon Programmable Controllers Installing and Configuring the DAS for Modicon Programmable Controllers 2.3 Postinstallation Tasks 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 Setting Up Plant-Floor Equipment To set up your plant-floor equipment, refer to the Modicon documentation for your specific device. 2.3.4 Tracing Device Communications The DAS for Modicon programmable controllers has built into it the capablity to trace device 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 device communications. Tracing can be enabled for a device and/or a line. If tracing is enabled for a device, then only communications from/to that device are traced. If tracing is enabled for a line, then all communications from/to that line are traced. If both device and line tracing is enabled, then the trace will contain the output for both the device 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. o Set the DAS_TRACE_OUTPUT environment variable to the name of the file that you want to contain the trace output. The environment variable must be defined such that it will be seen by the server the DAS is a part of. setenv DAS_TRACE_OUTPUT trace_output.log o Reinitiate communications to the device/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. and Configuring the DAS for Modicon Programmable Controllers 2-11 Installing and Configuring the DAS for Modicon Programmable Controllers 2.3 Postinstallation Tasks 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 device. To turn tracing off, reverse the steps used to turn tracing on. 2.4 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 DEComni you are using - The hardware system you are using (such as a model number) - The Modicon programmable controllers you are communicating with - 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. 2-12 Installing and Configuring the DAS for Modicon Programmable Controllers Installing and Configuring the DAS for Modicon Programmable Controllers 2.4 Failures During Product Use 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 Digital. and Configuring the DAS for Modicon Programmable Controllers 2-13 3 _________________________________________________________________ Using the DAS for Modicon Programmable Controllers This chapter provides information about the supported functions for Modicon devices, and how to access these functions. 3.1 Accessing Modicon Functions Application Programming Interface (API) For information on accessing DEComni Callable Services, refer to the DEComni for Digital UNIX Application Programmer's Interface. 3.2 Supported Functions A variety of functions are supported by the DAS for Modicon programmable controllers. 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. Using the DAS for Modicon Programmable Controllers 3-1 Using the DAS for Modicon Programmable Controllers 3.2 Supported Functions The Modicon DAS supports the following client functions for all supported devices: o Connect o Read Variable o Write Variable o Abort o Conclude The Modicon DAS supports the following server functions (indications) for all supported devices: o Abort 3.2.1 Connect, Conclude and Abort Functions Table 3-1 lists the connect, conclude and abort functions available through the DEComni (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___________________________________ 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 device memory. 3-2 Using the DAS for Modicon Programmable Controllers Using the DAS for Modicon Programmable Controllers 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 Yes SYMBOLIC No UNCONSTRAINED Yes[1] NAMED_VARIABLE No [1]Unconstrained_addresses_must_be_used_for_Modicon_584_and 984 extended addresses. Unconstrained addresses must also be used for Modicon 984 coil addresses of 010000 or higher to distinguish them from discrete input addresses. ___________________________________________________________ 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 device. Variables of this type are uniquely identified by their name. Table 3-3 lists the read and write variable functions available through the DEComni (API) interfaces. Using the DAS for Modicon Programmable Controllers 3-3 Using the DAS for Modicon Programmable Controllers 3.2 Supported Functions Table_3-3_Read_and_Write_Variable_Interface_Access_________ Interface___Function_Name__________________________________ API omni_get_value omni_get_value_a omni_put_value ____________omni_put_value_a_______________________________ 3.2.3 Abort Indications An indication is data that is sent to the DAS from the device without the DAS specifically requesting the data. The DAS supports abort indications. An abort indication is generated by the DAS when it loses a connection to the device. The DAS detects that a connection is broken When an error is returned from a read/write call. In this case all connections using this port are aborted. Table 3-4 lists the indication functions available through the DEComni (API) interface. Table_3-4_Indication_Interface_Access______________________ Interface___Function_Name__________________________________ API omni_get_indications ____________omni_get_indications_a_________________________ 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 DEComni 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. Structures are not supported for the DAS for Modicon programmable controllers. 3-4 Using the DAS for Modicon Programmable Controllers Using the DAS for Modicon Programmable Controllers 3.3 Addressing Syntax and Supported Data Types The following sections describe the supported data types and addressing syntax for each of the supported device families. 3.3.1 Modicon Micro 84 Addressing Syntax and Supported Data Types Table 3-5 shows the structure of a legal address for the Micro 84 family. Table_3-5_Modicon_Micro_84_Address_Format__________________ Address_Format___MMS_Type[1]______Description______________ 0001 - 0064 BIT Coils 1001 - 1064[2] BIT Discrete inputs 3001 - 3004[2] UNSIGNED_16 Input registers INTEGER_16 4001 - 4032 UNSIGNED_16 Holding registers INTEGER_16 [1]Arrays_are_supported._Variable_size_arrays_are_not______ supported. [2]Writes are not supported. ___________________________________________________________ 3.3.2 Modicon 184 and 384 Addressing Syntax and Supported Data Types Table 3-6 shows the structure of a legal address for the Modicon 184 and 384 families. Table_3-6_Modicon_184_and_384_Address_Format_______________ Address_Format___MMS_Type[1]______Description______________ 0001 - 0992 BIT Coils 1001 - 1992[2] BIT Discrete inputs 3001 - 3999[2] UNSIGNED_16 Input registers INTEGER_16 4001 - 4999 UNSIGNED_16 Holding registers INTEGER_16 [1]Arrays_are_supported._Variable_size_arrays_are_not______ supported. [2]Writes are not supported. ___________________________________________________________ Using the DAS for Modicon Programmable Controllers 3-5 Using the DAS for Modicon Programmable Controllers 3.3 Addressing Syntax and Supported Data Types 3.3.3 Modicon 484 Addressing Syntax and Supported Data Types Table 3-7 shows the structure of a legal address for the Modicon 484 family. Table_3-7_Modicon_484_Address_Format_______________________ Address_Format___MMS_Type[1]______Description______________ 0001 - 0512 BIT Coils 1001 - 1256[2] BIT Discrete inputs 3001 - 3032[2] UNSIGNED_16 Input registers INTEGER_16 4001 - 4254 UNSIGNED_16 Holding registers INTEGER_16 [1]Arrays_are_supported._Variable_size_arrays_are_not______ supported. [2]Writes are not supported. ___________________________________________________________ 3.3.4 Modicon 884 Addressing Syntax and Supported Data Types Table 3-8 shows the structure of a legal address for the Modicon 884 family. Table_3-8_Modicon_884_Address_Format_______________________ Address_Format___MMS_Type[1]______Description[3]___________ 00001 - 00768 BIT Coils 10001 - BIT Discrete inputs 10256[2] 30001 - UNSIGNED_16 Input registers 30256[2] INTEGER_16 40001 - 40864 UNSIGNED_16 Holding registers INTEGER_16 [1]Arrays_are_supported._Variable_size_arrays_are_not______ supported. [2]Writes are not supported. [3]Sequencer registers, double precision registers and latches are not supported. ___________________________________________________________ 3-6 Using the DAS for Modicon Programmable Controllers Using the DAS for Modicon Programmable Controllers 3.3 Addressing Syntax and Supported Data Types 3.3.5 Modicon 584 and 984 Addressing Syntax and Supported Data Types Table 3-9 shows the structure of a legal address for the Modicon 584 and 984 families. Table_3-9_Modicon_584_and_984_Address_Format_______________ Address_Format___MMS_Type[1]______Description______________ 00001 - 08192 BIT Coils 10001 - BIT Discrete inputs 18192[2] 30001 - UNSIGNED_16 Input registers 39999[2] INTEGER_16 40001 - 49999 UNSIGNED_16 Holding registers INTEGER_16 60000:1 - UNSIGNED_16 Extended file 69999:10[3] INTEGER_16 000001 - BIT Coils 065535[4] 100001 - BIT Discrete inputs 116384[2] 300001 - UNSIGNED_16 Input registers 365535[2] INTEGER_16 400001 - 465535 UNSIGNED_16 Holding registers INTEGER_16 FLOAT 600000:1 - UNSIGNED_16 Extended file 665535:10[3] INTEGER_16 [1]Arrays_are_supported._Variable_size_arrays_are_not______ supported. [2]Writes are not supported. [3]If a file number is not specified, then the file number defaults to 1. [4]Six digit addresses are supported for Modicon 984's only. To specify a coil 010000 or above, use an unconstrained address, not a numeric address, in order to distinguish the address from a discrete input. ___________________________________________________________ Using the DAS for Modicon Programmable Controllers 3-7 A _________________________________________________________________ Error Messages This appendix contains returned values and associated error messages specific to the DAS for Modicon programmable controllers. aborting, The connection to the device is being aborted, Explanation: Error. The connection to the device is being aborted by an error or by user request. No more requests will be processed by the DAS until the connection is restored. User Action: If the abort was caused by a device error, take action based on the error that occurred. If the abort was a result of a user request. Reconnect to the device before attempting further operations. addresstoolong, Variable address string too long, Explanation: Error. A variable address that is being defined is too long. An address must be 30 characters of less in length. User Action: Redefine the variable using a shorter address. apptypeunsupp, The given application type is not supported for this DAS, Explanation: Error. The application type that was specified in the variable definition is not supported by this DAS. User Action: Change the application type to a valid type for this DAS. Error Messages A-1 Error Messages devfailed, Failure in associated device, Explanation: Error. The slave's programmable controller has failed to respond to a message or an abortive error occurred. User Action: An irrecoverable error in the programmable controller occurred. Replace or repair the defective programmable controller. devilladdress, Illegal data address, Explanation: Error. The address referenced in the data field is not an allowable address for the addressed slave location. User Action: Check the model of the programmable controller and the documentation to determine a valid address for the programmable controller. Then modify the address to a valid address for this programmable controller. devillegalfnc, Illegal function, Explanation: Error. The message function received is not an allowable action for the addressed slave. This error is most likely caused by setting an incorrect application profile, so a command is being sent to a wrong model programmable controller. User Action: Check that the corrrect application profile is being used for this model of programmable controller. devillvalue, Illegal data value, Explanation: Error. The value referenced in the data field is not an allowable value for this addressed slave location. User Action: Check the model of the programmable controller and the documentation to determine a valid value for the programmable controller. Then modify the value to a valid value for this programmable controller. ebusy, Mount device busy, Explanation: Error. An attempt to connect to a port resulted in a "busy" status being returned. User Action: Make sure that the port is defined in the LAT Control Program and that noone else is using the port. Then attempt to reconnect to the port. A-2 Error Messages Error Messages etimedout, Connection timed out, Explanation: Error. An attempt to connect to a port timed out. User Action: Make sure that the port is defined in the LAT Control Program and that noone else is using the port. Then attempt to reconnect to the port. internalerror, Internal error, Explanation: Error. An internal error occurred in the DAS. User Action: Submit an SPR describing the circumstances that caused the error. invaddresstype, Invalid address type, Explanation: Error. A variable that is being defined is defined as an illegal address type. The unconstrained address type is used for Modicon 584 and 984 extended files. The numeric address type is used for all other registers/coils. User Action: Redefine the variable using the proper unconstrained or numeric address type. invalidaddress, The specified programmable controller address is not supported by this DAS, Explanation: Error. An address was sent by a programmable controller but the address is not supported by this DAS. User Action: Reprogram the programmable controller and specify a valid address for this DAS. Consult the DAS documentation to determine a valid address. invalidmodem, Invalid modem attribute specified in the MODBUS_ LINE ODS entry, Explanation: Error. The modem attribute must be one of TRUE, ON, YES, 1 or FALSE, OFF, NO, 0. User Action: Use ODS to enter a valid modem attribute. invalidparity, Invalid parity specified in the MODBUS_LINE ODS entry, Explanation: Error. The parity defined must be either EVEN, ODD or NONE. User Action: Use ODS to enter a valid parity (EVEN, ODD, NONE). Error Messages A-3 Error Messages invalidport, Invalid port name specified in the ODS entry, Explanation: Error. Port names must be 10 characters or less. User Action: Use ODS to enter a port name that is less than 10 characters. invalidretries, Invalid retries number in the ODS entry, Explanation: Error. The retries attribute must be between 0-20. User Action: Use ODS to enter a retries number between 0-20. invalidslaveaddress, Invalid slave address number in the MODBUS_PATH ODS entry, Explanation: Error. Modbus slave address numbers must be a number between 1-247. User Action: Use ODS to enter a slave address number between 1-247. invalidspeed, Invalid speed (baud rate) specified in the MODBUS_LINE ODS entry, Explanation: Error. Baud rates from 110 to 19200 are supported for the Modicon DAS. User Action: Use ODS to enter a speed from 110 to 19200. invalidtimeout, Invalid timeout value in the ODS entry, Explanation: Error. An invalid timeout value was entered for the timeout value in ODS. Timeouts must be between 2 and 10 seconds. User Action: Use ODS to enter a timeout value between 2-10. invalidtrace, Invalid trace attribute specified in the MODBUS_ LINE or MODBUS_PATH ODS entry, Explanation: Error. The trace attribute must be one of TRUE, ON, YES, 1 or FALSE, OFF, NO, 0. User Action: Use ODS to enter a valid trace attribute. A-4 Error Messages Error Messages mmsaddrtypeunsupp, The given MMS type is unsupported for the given address, Explanation: Error. The MMS type is not supported for the variable address given. User Action: Modify the MMS type to one supported for the given address or modify the address to one supported for the MMS type. mmstypeunsupp, The given MMS type is not supported for this DAS, Explanation: Error. The MMS type that was specified in the variable definition is not supported by by this DAS. User Action: Change the MMS type to a valid type for this DAS. modbuserror, A modbus error occurred, Explanation: Error. A Modbus error occurred when reading or writing to the programmable controller. User Action: Retry issuing the command. neterr, Modbus network error occurred, Explanation: Error. A network error on the Modicon Modbus occurred. User Action: Examine the network status in the returned IOSB to determine the specific network error that occurred and take action based on that error. nolicense, No software license., Explanation: Error. The Modicon DAS requires a software license. User Action: Install the license PAK for the Modicon DAS. noline, No "/LINE=" ODS entry for the given application simple name, Explanation: Error. The Modicon DAS requires a /LINE= attribute defined for the ODS entry corresponding to the application simple name entry for the remote VMD. The /LINE= attribute is defined for MODBUS_PATH and MODPLUS_SLAVE_PATH object classes within ODS. User Action: Use the MODBUS_PATH object class (for Modbus) or MODPLUS_SLAVE_PATH object class (for Modbus Plus) within Error Messages A-5 Error Messages ODS to define the application simple name for this VMD. Use a valid line name when defining the /LINE= attribute. nomodem, No "MODEM" ODS entry for the given line, Explanation: Error. The Modicon DAS requires a MODEM attribute defined in ODS. The MODEM attribute is defined for the MODBUS_LINE object class within ODS. User Action: Use the MODBUS_LINE object class within ODS to define the MODEM attribute for this line. Modem control is either enabled (TRUE, ON, YES, 1) or disabled (FALSE, OFF, NO, 0). noparity, No "PARITY" ODS entry for the given line, Explanation: Error. The Modicon DAS requires a PARITY attribute defined in ODS. The PARITY attribute is defined for the MODBUS_LINE object class within ODS. User Action: Use the MODBUS_LINE object class within ODS to define the PARITY attribute for this line. Use a valid parity (EVEN, NONE) when defining the PARITY attribute. noport, No "PORT" ODS entry for the given line, Explanation: Error. The Modicon DAS requires a PORT attribute defined in ODS. The PORT attribute is defined for the MODBUS_LINE object class within ODS. User Action: Use the MODBUS_LINE object class within ODS to define the PORT attribute for this line. Use a valid port name when defining the PORT attribute. noretries, No "RETRIES" ODS entry for the given line, Explanation: Error. The Modicon DAS requires a RETRIES attribute defined in ODS. The RETRIES attribute is defined for the MODBUS_LINE object class within ODS. User Action: Use the MODBUS_LINE object class within ODS to define the RETRIES attribute for this line. Use a valid number when defining the RETRIES attribute. A-6 Error Messages Error Messages noslaveaddress, No "SLAVE_ADDRESS" ODS entry for the given application simple name, Explanation: Error. The Modicon DAS requires a SLAVE_ADDRESS attribute defined for the ODS entry corresponding to the application simple name entry for the remote VMD. The SLAVE_ ADDRESS attribute is defined for MODBUS_PATH object class within ODS. User Action: Use the MODBUS_PATH object class within ODS to define the application simple name for this VMD. Use a valid Modbus slave address number when defining the SLAVE_ADDRESS attribute. nospeed, No "SPEED" ODS entry for the given line, Explanation: Error. The Modicon DAS requires a SPEED attribute defined in ODS. The SPEED attribute is defined for the MODBUS_LINE object class within ODS. User Action: Use the DH_LINE object class within ODS to define the SPEED attribute for this line. Use a valid baud rate when defining the SPEED attribute. notimeout, No "TIMEOUT" ODS entry for the given line, Explanation: Error. The Modicon DAS requires a TIMEOUT attribute defined in ODS. The TIMEOUT attribute is defined for the MODBUS_LINE object class within ODS. User Action: Use the MODBUS_LINE object class within ODS to define the TIMEOUT attribute for this line. Use a valid number when defining the TIMEOUT attribute. notrace, No "TRACE" ODS entry, Explanation: Error. The Modicon DAS requires a TRACE attribute defined in ODS. The TRACE attribute is defined for the MODBUS_PATH, MODBUS_LINE, MODPLUS_LINE, MODPLUS_ SLAVE_PATH and MODPLUS_NODE_PATH object classes within ODS. User Action: Use the appropriate object class within ODS to define the TRACE attribute for this line. Trace is either enabled (TRUE, ON, YES, 1) or disabled (FALSE, OFF, NO, 0). Error Messages A-7 Error Messages openerrorstatus, Errno for line XX returned from open () = X, Explanation: Error. An error occurred when opening the port. User Action: Look up the error number to determine the cause of the error and take appropriate action based on the error code. parsefailed, The parsing of a variable address failed, Explanation: Error. When defining a variable, the parsing of the address failed. Either the syntax or the value of the address is incorrect. User Action: Consult the user documentation to determine a valid address for the variable being defined and redefine the variable using the correct syntax. portopenerror, Error returned from open, Explanation: Error. An error occurred when opening the port. User Action: Check the log file to determine the error code, look up the error number to determine the cause of the error and take appropriate action based on the error code. readerror, Read error on communications line, Explanation: Error. An error was returned when reading from the port. The error is logged separately. User Action: Look up the error and take action based on the error found. readstatus, Read error on line XX, errno = X, Explanation: Error. An error was found when reading from the port. The error number for the error is given in the message. User Action: Look up the error and take action based on the error found. reqpending, Conclude rejected because of a pending read/write request, Explanation: Error. The conclude request was rejected because either a read or a write request was currently pending. User Action: Either abort the connection or wait for the current request(s) to complete before retrying the conclude. A-8 Error Messages Error Messages retriesexceeded, The retry count was exceeded, Explanation: Error. When trying to communicate to the device, the retry count was exceeded. The retry being exceeded means that the message being sent to the device was garbled during transmission and did not match the checksum. User Action: Check cabling to ensure there are no shorts or breaks and is properly grounded. Make sure the cable is routed such that it does not pass close to electrical interference such as transformers and high power cables. timeout, Modbus timeout when reading from the programmable controller, Explanation: Error. The programmable controller did not respond when attempting to read a response from the programmable controller. The response could be part of a read or a write operation. User Action: Check all cabling to make sure that it is properly shielded, grounded and seated. Verify that the communication parameters are set up properly on both programmable controller and the host. Verify that the correct slave address has been selected on the programmable controller and on the host. tracerddev, XX Trace for device XX - read:, Explanation: Error. Tracing has been enabled for the indicated device. The message is data written to the device. User Action: None. tracerdline, XX Trace for line XX - read:, Explanation: Error. Tracing has been enabled for the indicated line. The message is data read from the line. User Action: None. tracewrdev, XX Trace for device XX - write:, Explanation: Error. Tracing has been enabled for the indicated device. The message is data written to the device. User Action: None. Error Messages A-9 Error Messages tracewrline, XX Trace for line XX - write:, Explanation: Error. Tracing has been enabled for the indicated line. The message is data written to the line. User Action: None. ttcharerror, An error occurred when defining TT characteristics, Explanation: Error. An error occurred when setting up TT characteristics. The TT characteristics are set when a connection is initiated with the VMD. User Action: An error message detailing the error should have been logged. Examine the error to determine the proper corrective action. ttcharstatus, Errno for line XX returned from ioctl () = X, Explanation: Error. An error occurred when defining tty characteristics> User Action: Look up the error number to determine the cause of the error and take appropriate action based on the error code. writenotsupport, Writes are not supported for the specified address, Explanation: Error. An attempt was made to write to an address that the Modbus protocol does not allow write access to. User Action: Consult the documentation to determine addresses that can be written to and change the address of the variable or only perform reads when using this variable. A-10 Error Messages _________________________________________________________________ Index A Device access software _______________________________ (cont'd) Abort function, 3-2 installation of, 2-1 Abort indication, 3-4 installation requirements, Accessing DAS functions, 3-1 2-1 Address syntax, 3-4 overview, 1-1 Modicon 184, 3-5 supported client functions, Modicon 384, 3-5 3-2 Modicon 484, 3-6 supported data types, 3-4 Modicon 584, 3-7 supported devices, 1-2 Modicon 884, 3-6 supported functions, 1-2, Modicon 984, 3-7 3-1 Modicon Micro 84, 3-5 supported server functions, C 3-2 _______________________________ using, 3-1 Conclude function, 3-2 Device communications Configuration cabling, 2-1 editing configuration files, overview, 1-1 2-7 tracing, 2-11 ODS registrations, 2-7 Devices Configuration files, 2-9 Programmable controllers Configuring ports, 2-10 supported, 1-2 Connect function, 3-2 F______________________________ D______________________________ Files, created during DAS installation, 2-6 See Device access software Functions, 3-1 Data types, 3-4 abort, 3-2 Device access software conclude, 3-2 accessing functions, 3-1 connect, 3-2 address syntax, 3-4 read variable, 3-2 description of, 1-1 supported, 3-1 functions, 1-2 write variable, 3-2 Index-1 supported data types, 3-5 I______________________________ Indications O______________________________ abort, 3-4 ODS registrations, 2-7 Installation, 2-1 files created, 2-6 P______________________________ procedure, 2-3 Plant-floor equipment, setting Installation requirements, 2-1 up, 2-11 disk space, 2-3 Postinstallation tasks, 2-6 hardware, 2-1 Problem reporting, 2-12 software, 2-2 Product failure, 2-12 M______________________________ R Messages _______________________________ error and return values, A-1 Read variable function, 3-2 MMS data type, 3-4 S Modicon 184 _______________________________ address syntax, 3-5 Supported data types, 3-4 supported data types, 3-5 Modicon 184, 3-5 Modicon 384 Modicon 384, 3-5 address syntax, 3-5 Modicon 484, 3-6 supported data types, 3-5 Modicon 584, 3-7 Modicon 484 Modicon 884, 3-6 address syntax, 3-6 Modicon 984, 3-7 supported data types, 3-6 Modicon Micro 84, 3-5 Modicon 584 address syntax, 3-7 T______________________________ supported data types, 3-7 Trace Modicon 884 ODS configuration, 2-7 address syntax, 3-6 using, 2-11 supported data types, 3-6 Modicon 984 W address syntax, 3-7 _______________________________ supported data types, 3-7 Write variable function, 3-2 Modicon Micro 84 address syntax, 3-5 Index-2