MNET. ProLinx Gateway Modbus TCP/IP Interface Module DRIVER MANUAL

Transcription

1 MNET ProLinx Gateway DRIVER MANUAL

2 Your Feedback Please We always want you to feel that you made the right decision to use our products. If you have suggestions, comments, compliments or complaints about our products, documentation, or support, please write or call us. ProSoft Technology 5201 Truxtun Ave., 3rd Floor Bakersfield, CA (661) (661) (Fax) Copyright 2010 ProSoft Technology, Inc., all rights reserved. MNET ProSoft Technology, ProLinx, inrax, ProTalk, and RadioLinx are Registered Trademarks of ProSoft Technology, Inc. All other brand or product names are or may be trademarks of, and are used to identify products and services of, their respective owners. ProSoft Technology Product Documentation In an effort to conserve paper, ProSoft Technology no longer includes printed manuals with our product shipments. User Manuals, Datasheets, Sample Ladder Files, and Configuration Files are provided on the enclosed CD-ROM, and are available at no charge from our web site: Printed documentation is available for purchase. Contact ProSoft Technology for pricing and availability. North America: Asia Pacific: Europe, Middle East, Africa: +33 (0) Latin America:

3 Important Installation Instructions Power, Input, and Output (I/O) wiring must be in accordance with Class I, Division 2 wiring methods, Article (b) of the National Electrical Code, NFPA 70 for installation in the U.S., or as specified in Section 18-1J2 of the Canadian Electrical Code for installations in Canada, and in accordance with the authority having jurisdiction. The following warnings must be heeded: A WARNING - EXPLOSION HAZARD - SUBSTITUTION OF COMPONENTS MAY IMPAIR SUITABILITY FOR CLASS I, DIV. 2; B WARNING - EXPLOSION HAZARD - WHEN IN HAZARDOUS LOCATIONS, TURN OFF POWER BEFORE REPLACING OR WIRING MODULES C WARNING - EXPLOSION HAZARD - DO NOT DISCONNECT EQUIPMENT UNLESS POWER HAS BEEN SWITCHED OFF OR THE AREA IS KNOWN TO BE NON-HAZARDOUS. D THIS DEVICE SHALL BE POWERED BY CLASS 2 OUTPUTS ONLY. All ProLinx Products WARNING EXPLOSION HAZARD DO NOT DISCONNECT EQUIPMENT UNLESS POWER HAS BEEN SWITCHED OFF OR THE AREA IS KNOWN TO BE NON-HAZARDOUS. AVERTISSEMENT RISQUE D'EXPLOSION AVANT DE DÉCONNECTER L'EQUIPMENT, COUPER LE COURANT OU S'ASSURER QUE L'EMPLACEMENT EST DÉSIGNÉ NON DANGEREUX. Markings culus ISA Class I, Div 2 Groups A, B, C, D culus C22.2 No. 213-M CL I Div 2 GPs A, B, C, D II 3 G Ex na nl IIC X 0 C <= Ta <= 60 C II Equipment intended for above ground use (not for use in mines). 3 Category 3 equipment, investigated for normal operation only. G Equipment protected against explosive gasses. ProLinx Gateways with Ethernet Ports Series C ProLinx Gateways with Ethernet ports do NOT include the HTML Web Server. The HTML Web Server must be ordered as an option. This option requires a factory-installed hardware addition. The HTML Web Server now supports: 8 MB file storage for HTML files and associated graphics files (previously limited to 384K) 32K maximum HTML page size (previously limited to 16K) To upgrade a previously purchased Series C model: Contact your ProSoft Technology distributor to order the upgrade and obtain a Returned Merchandise Authorization (RMA) to return the unit to ProSoft Technology. To order a ProLinx Plus gateway with the -WEB option Add -WEB to the standard ProLinx part number. For example, 5201-MNET-MCM-WEB.

4

5 MNET ProLinx Gateway Contents Contents Your Feedback Please... 2 ProSoft Technology Product Documentation... 2 Important Installation Instructions... 3 All ProLinx Products... 3 ProLinx Gateways with Ethernet Ports... 3 To upgrade a previously purchased Series C model:... 3 To order a ProLinx Plus gateway with the -WEB option Functional Overview Modbus TCP/IP (MNET) Port General Specifications Modbus TCP/IP Internal Database Modbus TCP/IP Client Access to Database Modbus TCP/IP Server Access to Database Modbus Message Routing: Port Modbus TCP/IP Protocol Configuration Installing ProSoft Configuration Builder Software Using the Online Help Configure the Gateway Configuring Module Parameters Printing a Configuration File [MNET Servers] Float Flag Float Start Float Offset Output Offset Bit Input Offset Holding Register Offset Word Input Offset Connection Timeout [MNET CLIENT 0] Minimum Command Delay Response Timeout Retry Count Float Flag Float Start Float Offset ARP Timeout Command Error Delay [MNET CLIENT 0 COMMANDS] Command List Overview Commands Supported by the Module Command Entry Formats Enable Internal Address ProSoft Technology, Inc. Page 5 of 78

6 Contents MNET ProLinx Gateway Reg Count Swap Code Node IP Address Service Port Slave Address Modbus Function MB Address in Device Using the CommonNet Data Map From Address To Address Register Count Swap Code Delay Preset Ethernet Configuration Downloading a File from PC to the Module Diagnostics and Troubleshooting Debug Port Requirements Using ProSoft Configuration Builder (PCB) for Diagnostics Main Menu Database View Menu Master Command Error List Menu Master Command List Menu Network Menu LED Indicators Base Module LEDs Ethernet LED Indicators MNET Error and Status Data MNET Client Error/Status Data MNET Server Port 2000 Status Error Locations MNET Server Port 502 Status Error Locations MNET Server Port 2001 Error Locations MNET Client Command List Error Data Modbus Protocol Specification Read Coil Status (Function Code 01) Read Input Status (Function Code 02) Read Holding Registers (Function Code 03) Read Input Registers (Function Code 04) Force Single Coil (Function Code 05) Preset Single Register (Function Code 06) Diagnostics (Function Code 08) Sub-function codes supported Modbus Exception Responses Force Multiple Coils (Function Code 15) Preset Multiple Registers (Function Code 16) Support, Service & Warranty 69 How to Contact Us: Technical Support Return Material Authorization (RMA) Policies and Conditions Page 6 of 78 ProSoft Technology, Inc.

7 MNET ProLinx Gateway Contents All Product Returns: Procedures for Return of Units Under Warranty: Procedures for Return of Units Out of Warranty: LIMITED WARRANTY What Is Covered By This Warranty What Is Not Covered By This Warranty Disclaimer Regarding High Risk Activities Intellectual Property Indemnity Disclaimer of all Other Warranties Limitation of Remedies ** Time Limit for Bringing Suit No Other Warranties Allocation of Risks Controlling Law and Severability Index 77 ProSoft Technology, Inc. Page 7 of 78

8 Contents MNET ProLinx Gateway Page 8 of 78 ProSoft Technology, Inc.

9 MNET ProLinx Gateway Functional Overview 1 Functional Overview In This Chapter Modbus TCP/IP (MNET) Port General Specifications Modbus TCP/IP Internal Database The ProLinx Modbus TCP/IP (MNET) driver can be used to interface many different protocols into the Schneider Electric Quantum family of processors as well other devices supporting the protocol. The MNET driver supports Client connections as well as Server connections, and, with the addition of the WEB hardware option, the gateway also provides HTTP, FTP and capability. The Ethernet driver interfaces with a common internal database in the gateway. This permits the sharing of data across many different protocols and networks. The following illustration shows the functionality of the MNET driver. ProSoft Technology, Inc. Page 9 of 78

10 Functional Overview MNET ProLinx Gateway 1.1 Modbus TCP/IP (MNET) Port The gateway supports a client connection on the TCP/IP network to interface with processors (and other server based devices) using a user constructed command list of up to 100 entries. The gateway s internal database is used as the source for write commands to the remote processors. Data collected from the processors using read commands is placed in the gateway s database. Data in the gateway s internal database is accessible for read and write operations by any node on the network supporting the MBAP (Service Port 502) or MNET (Service Ports 2000/2001) TCP/IP protocols. The MBAP protocol (Port 502) is a standard implementation defined by Schneider Automation and used on their Quantum Processor. This open protocol is a modified version of the serial Modbus protocol. The MNET protocol is an embedded Modbus protocol message in a TCP/IP packet. The gateway supports up to five active server connections on Service Ports 502, five additional active server connections on Service Port 2000, and one active client connection. LINK DATA Page 10 of 78 ProSoft Technology, Inc.

11 MNET ProLinx Gateway Functional Overview 1.2 General Specifications 10 MB Ethernet Application port Supports Enron version of Modbus protocol for floating-point data transactions Configurable parameters for the client including a minimum response delay of 0 to ms and floating-point support Supports five independent server connections for Service Port 502 Supports five independent server connections for Service Port 2000 All data mapping begins at Modbus register , protocol base 0. Error codes, network error counters, and port status data available in user data memory ProSoft Technology, Inc. Page 11 of 78

12 Functional Overview MNET ProLinx Gateway 1.3 Modbus TCP/IP ProSoft s Modbus TCP/IP implementation uses the module s shared internal memory for data transfer. Sharing the memory with another protocol driver allows the module to transfer data between Modbus TCP/IP devices and other devices on other networks. Configurable floating-point data movement is supported, including support for Enron or Daniel floating-point applications. Modbus TCP/IP Server (Slave) The server driver accepts incoming connections on Service Port 502 for clients using Modbus TCP/IP MBAP messages and from clients on Service Port 2000 (or other Service Ports) for clients using Encapsulated Modbus messages.. Supports five independent server connections for Service Port 502 (MBAP) Supports five independent server connections for Service Port 2000 (Encapsulated) Supports a total Modbus TCP/IP data transfer capacity of up to 4000 registers or up to 64,000 bits in any combination of data types throughout the memory database Modbus data types overlap in the gateway s memory database, so the same data can be conveniently read or written as bit-level or register-level data. Modbus TCP/IP Client (Master) Actively reads data from and writes data to Modbus TCP/IP devices, using MBAP or Encapsulated Modbus message formats Offers one client connection with up to 100 commands to talk to multiple severs Status Data Error codes, counters, and port status available Page 12 of 78 ProSoft Technology, Inc.

13 MNET ProLinx Gateway Functional Overview 1.4 Internal Database Central to the functionality of the gateway is the internal database. This database is shared between all the ports on the gateway and is used as a conduit to pass information from one device on one network to one or more devices on another network. This permits data from devices on one communication port to be viewed and controlled by devices on another port. In addition to data from the Server and Client ports, status and error information generated by the gateway can also be mapped into the internal database Modbus TCP/IP Client Access to Database The client functionality exchanges data between MNET module's internal database and data tables established in one or more Quantum processors or other server based devices. The command list, defined in the user configuration, defines what data is to be transferred between the module and each of the servers on the network. No ladder logic is required in the processor (server) for client functionality, except to assure that sufficient data memory exists. The following illustration describes the flow of data between the Ethernet clients and the internal database Modbus TCP/IP Server Access to Database The MNET gateway provides server functionality using reserved Service Port 502 for Modbus TCP/IP MBAP messages, as well as Service Ports 2000 and 2001 to support the TCP/IP Encapsulated Modbus version of the protocol used by several HMI manufacturers. Server support in the gateway permits client applications (that is, HMI software, Quantum processors, and so on) to read from and write to the gateway s database. This document discusses the requirements for attaching to the gateway using client applications. ProSoft Technology, Inc. Page 13 of 78

14 Functional Overview MNET ProLinx Gateway The Server driver is able to support multiple concurrent connections from several Clients. Up to five (5) Clients can simultaneously connect on Service Port 502 and five (5) more can also simultaneously connect on Service Port Service Port 2001 is used by the MNET driver to pass Encapsulated Modbus commands through from the Ethernet port to the gateway s serial port (Modbus pass-through support is available on 5201-MNET-MCM and 5202-MNET-MCM4 models only). When configured as a Server, the internal database of the MNET gateway is used as the source for read requests and the destination for write requests from remote clients. Access to the database is controlled by the command type received in the incoming message from the Client. The following table defines the relationship of the gateway s internal database to the addresses required in the incoming Modbus TCP/IP requests: Database Address Modbus Address The following virtual addresses are not part of the normal gateway user database and are not valid addresses for standard data. However, these addresses may be used for incoming commands that are requesting floating-point data. To use addresses in this upper range requires you to set the Float Flag to Yes, the Float Start to a database address in the range below, and the Float Offset to a database address in the gateway user memory area shown above. Remember that, once you do this, all data above the Float Start address must be floatingpoint data. Database Address Modbus Address The MNET gateway must be correctly configured and connected to the network before you attempt to use it. Use a network verification program, such as the command prompt PING instruction, to verify that the gateway can be seen on the network. Use ProSoft Configuration Builder to confirm proper configuration of the gateway and to transfer the configuration files to and from the gateway. Page 14 of 78 ProSoft Technology, Inc.

15 MNET ProLinx Gateway Functional Overview Modbus Message Routing: Port 2001 When Modbus messages are sent to the module over the TCP/IP connection to port 2001, the messages are sent (routed in the module) directly out the serial communication port (Port 0, if it is configured as a Modbus Master. The commands (whether a read or a write command) are immediately routed to the slave devices on the serial port. Response messages from the slave devices are routed to the TCP/IP network to be received by the originating host. ProSoft Technology, Inc. Page 15 of 78

16 Functional Overview MNET ProLinx Gateway Page 16 of 78 ProSoft Technology, Inc.

17 MNET ProLinx Gateway Modbus TCP/IP Protocol Configuration 2 Modbus TCP/IP Protocol Configuration In This Chapter Installing ProSoft Configuration Builder Software Configure the Gateway [MNET Servers] [MNET CLIENT 0] [MNET CLIENT 0 COMMANDS] Using the CommonNet Data Map Ethernet Configuration Downloading a File from PC to the Module ProSoft Technology, Inc. Page 17 of 78

18 Modbus TCP/IP Protocol Configuration MNET ProLinx Gateway 2.1 Installing ProSoft Configuration Builder Software You must install the ProSoft Configuration Builder (PCB) software to configure the gateway. You can always get the newest version of ProSoft Configuration Builder from the ProSoft Technology website. Installing ProSoft Configuration Builder from the ProSoft website 1 Open your web browser and navigate to 2 Click the DOWNLOAD HERE link to download the latest version of ProSoft Configuration Builder. 3 Choose SAVE or SAVE FILE when prompted. 4 Save the file to your Windows Desktop, so that you can find it easily when you have finished downloading. 5 When the download is complete, locate and open the file, and then follow the instructions on your screen to install the program. If you do not have access to the Internet, you can install ProSoft Configuration Builder from the ProSoft Solutions Product CD-ROM, included in the package with your gateway. Installing ProSoft Configuration Builder from the Product CD-ROM 1 Insert the ProSoft Solutions Product CD-ROM into the CD-ROM drive of your PC. Wait for the startup screen to appear. 2 On the startup screen, click PRODUCT DOCUMENTATION. This action opens a Windows Explorer file tree window. 3 Click to open the UTILITIES folder. This folder contains all of the applications and files you will need to set up and configure your gateway. 4 Double-click the SETUP CONFIGURATION TOOL folder, double-click the PCB_*.EXE file and follow the instructions on your screen to install the software on your PC. The information represented by the "*" character in the file name is the PCB version number and, therefore, subject to change as new versions of PCB are released. Note: Many of the configuration and maintenance procedures use files and other utilities on the CD-ROM. You may wish to copy the files from the Utilities folder on the CD-ROM to a convenient location on your hard drive Using the Online Help Most of the information needed to help you use ProSoft Configuration Builder is provided in a Help System that is always available whenever you are running ProSoft Configuration Builder. The Help System does not require an Internet connection. To view the help pages, start ProSoft Configuration Builder, open the HELP menu, and then choose CONTENTS. Page 18 of 78 ProSoft Technology, Inc.

19 MNET ProLinx Gateway Modbus TCP/IP Protocol Configuration 2.2 Configure the Gateway Configuring Module Parameters 1 Click on the [+] sign next to the gateway icon to expand gateway information. 2 Click on the [+] sign next to any icon to view gateway information and configuration options. 3 Double-click any icon to open an Edit dialog box. 4 To edit a parameter, select the parameter in the left pane and make your changes in the right pane. 5 Click OK to save your changes Printing a Configuration File 1 Select the gateway icon, and then click the right mouse button to open a shortcut menu. 2 On the shortcut menu, choose VIEW CONFIGURATION. This action opens the View Configuration window. 3 On the View Configuration window, open the FILE menu, and choose PRINT. This action opens the Print dialog box. 4 On the Print dialog box, choose the printer to use from the drop-down list, select printing options, and then click OK. ProSoft Technology, Inc. Page 19 of 78

20 Modbus TCP/IP Protocol Configuration MNET ProLinx Gateway 2.3 [MNET Servers] This section contains database offset information used by the servers when accessed by external clients. These offsets can be utilized to segment the database by data type Float Flag Yes or No This flag specifies if the floating-point data access functionality is to be implemented. If the float flag is set to Yes, Modbus functions 3, 6, and 16 will interpret floating-point values for registers as specified by the two following parameters Float Start 0 to This parameter defines the first register of floating-point data. All requests with register values greater-than or equal to this value will be considered floating-point data requests. This parameter is only used if the Float Flag is enabled. For example, if a value of 7000 is entered, all requests for registers 7000 and above will be considered as floating-point data Float Offset 0 to 4999 This parameter defines the start register for floating-point data in the internal database. This parameter is used only if the Float Flag is enabled. For example, if the Float Offset value is set to 3000 and the float start parameter is set to 7000, data requests for register 7000 will use the internal Modbus register Page 20 of 78 ProSoft Technology, Inc.

21 MNET ProLinx Gateway Modbus TCP/IP Protocol Configuration Output Offset 0 TO 3999 When the port is configured as a slave, this parameter specifies the internal database address to use as the zero address or starting point for binary output Coil data. Coil data is read by Modbus Function Code 1 commands (Read Coils) and written by Function Codes 5 (Force Single Coil) or Function Code 15 (Force Multiple Coils). For example, if this parameter is set to 50 and a Function Code 1 command is received requesting Coil address 0 (virtual Modbus Coil address or ), the data returned in the response will be the value at register 50, bit 0 in the gateway's database Bit Input Offset 0 to 3999 This parameter specifies the offset address in the internal Modbus database for network requests for Modbus function 2 commands. For example, if the value is set to 150, an address request of 0 will return the value at register 150 in the database Holding Register Offset 0 to 4999 This parameter specifies the offset address in the internal Modbus database to with network requests for Modbus functions 3, 6, or 16 commands. For example, if the value is set to 50, an address request of 0 will return the value at register 50 in the database Word Input Offset 0 to 3999 This parameter specifies the offset address in the internal Modbus database for network requests for Modbus function 4 commands. For example, if the value is set to 150, an address request of 0 will return the value at register 150 in the database Connection Timeout 0 to 1200 seconds. This is the number of seconds the Server will wait to receive new data. If the Server does not receive any new data during this time, it will close the connection. ProSoft Technology, Inc. Page 21 of 78

22 Modbus TCP/IP Protocol Configuration MNET ProLinx Gateway 2.4 [MNET CLIENT 0] The [MNET CLIENT 0] section of the CFG file specifies the parameters for the client to be emulated on the gateway. The command list for the client is entered in a separate section Minimum Command Delay 0 to This parameter specifies the number of milliseconds to wait between the initial issuance of a command. This parameter can be used to delay all commands sent to slaves to avoid "flooding" commands on the network. This parameter does not affect retries of a command as they will be issued when failure is recognized Response Timeout 0 to milliseconds This is the time in milliseconds that a Client will wait before re-transmitting a command if no response is received from the addressed server. The value to use depends upon the type of communication network used, and the expected response time of the slowest device on the network Retry Count 0 to 10 This parameter specifies the number of times a command will be retried if it fails. Page 22 of 78 ProSoft Technology, Inc.

23 MNET ProLinx Gateway Modbus TCP/IP Protocol Configuration Float Flag Yes or No This flag specifies if the floating-point data access functionality is to be implemented. If the float flag is set to Yes, Modbus functions 3, 6, and 16 will interpret floating-point values for registers as specified by the two following parameters Float Start 0 to This parameter defines the first register of floating-point data. All requests with register values greater-than or equal to this value will be considered floating-point data requests. This parameter is only used if the Float Flag is enabled. For example, if a value of 7000 is entered, all requests for registers 7000 and above will be considered as floating-point data Float Offset 0 TO 3998 This parameter defines the starting register for floating-point data in the internal gateway database. This parameter is used only if the Float Flag is set to YES. For example, if the Float Offset value is set to 3000 and the Float Start parameter is set to 7000, the data returned as floating-point data for register (or ) will actually come from internal gateway registers 3000 and If the requested address was (407002), the data will be returned from internal registers 3002 and If the requested address was (407101), the data will be returned from internal registers 3200 and 3201; and so on ARP Timeout 1 to 60 This parameter specifies the number of seconds to wait for an ARP reply after a request is issued Command Error Delay 0 to 300 This parameter specifies the number of 100 millisecond intervals to turn off a command in the error list after an error is recognized for the command. If this parameter is set to 0, there will be no delay. ProSoft Technology, Inc. Page 23 of 78

24 Modbus TCP/IP Protocol Configuration MNET ProLinx Gateway 2.5 [MNET CLIENT 0 COMMANDS] The [MNET CLIENT 0 COMMANDS] section defines the Modbus TCP/IP commands to be issued from the gateway to server devices on the network. These commands can be used for data collection and/or control of devices on the TCP/IP network. The command list is formatted differently than the other sections of the configuration file. Commands are present in a block between the labels START and END. These labels inform the program where the list resides. The gateway's program will parse all commands after the START label until it reaches the END label or until the command count entered for the port is reached Command List Overview In order to interface the ProLinx module with Modbus TCP/IP Server devices, you must construct a command list. The commands in the list specify the Server device to be addressed, the function to be performed (read or write), the data area in the device to interface with and the registers in the internal database to be associated with the device data. The Client command list supports up to 16 commands. The command list is processed from top (command #0) to bottom. A poll interval parameter is associated with each command to specify a minimum delay time in tenths of a second between the issuance of a command. If the user specifies a value of 10 for the parameter, the command will be executed no more frequently than every 1 second. Write commands have a special feature, as they can be set to execute only if the data in the write command changes. If the register data values in the command have not changed since the command was last issued, the command will not be executed. If the data in the command has changed since the command was last issued, the command will be executed. Use of this feature can lighten the load on the network. In order to implement this feature, set the enable code for the command to a value of 2. Page 24 of 78 ProSoft Technology, Inc.

25 MNET ProLinx Gateway Modbus TCP/IP Protocol Configuration Commands Supported by the Module The format of each command in the list depends on the Modbus Function Code being executed. The following table lists the functions supported by the module. Function Code Definition Supported in Client Supported in Server 1 Read Coil Status X X 2 Read Input Status X X 3 Read Holding Registers X X 4 Read Input Registers X X 5 Set Single Coil X X 6 Single Register Write X X 7 Read Exception Status X 8 Diagnostics X 15 Multiple Coil Write X X 16 Multiple Register Write X X 22 Mask Write 4X X 23 Read/Write X Each command list record has the same general format. The first part of the record contains the information relating to the communication module and the second part contains information required to interface to the Modbus TCP/IP Server device Command Entry Formats The following table shows the structure of the configuration data necessary for each of the supported commands Enable Internal Poll Interval Count Swap IP Address Serv Slave Function Code Device Modbus Code Address Time Code Port Node Address Code Code Register (bit) Register (bit) 1/10th Seconds Bit Count 1/10th Seconds Bit Count Code Register 1/10th Seconds Word Count Code Register 1/10th Seconds Word Count Code 1 bit 1/10th Seconds Bit Count Code 1 bit 1/10th Seconds Word Count Code Register (bit) 1/10th Seconds Bit Count Code Register 1/10th Seconds Word Count 0 IP Address Port # Address Read Coil (0x) Register 0 IP Address Port # Address Read Input (1x) Register Code IP Address Port # Address Read Holding Registers (4x) 0 IP Address Port # Address Read Input Registers (3x) 0 IP Address Port # Address Force (Write) Single Coil (0x) 0 IP Address Port # Address Preset (Write) Single Register (4x) 0 IP Address Port # Address Force (Write) Multiple Coil (0x) 0 IP Address Port # Address Preset (Write) Multiple Register (4x) Register Register Register Register Register Register ProSoft Technology, Inc. Page 25 of 78

26 Modbus TCP/IP Protocol Configuration MNET ProLinx Gateway The first part of the record is the gateway Information, which relates to the ProLinx gateway and the second part contains information required to interface to the Server device. Command list example: Enable YES, NO, or CONDITIONAL This field defines whether the command is to be executed and under what conditions. Value Description 0 The command is disabled and will not be executed in the normal polling sequence. 1 The command is executed each scan of the command list if the Poll Interval Time is set to zero. If the Poll Interval time is set, the command will be executed, when the interval timer expires. 2 The command will execute only if the internal data associated with the command changes. This value is valid only for write commands. Page 26 of 78 ProSoft Technology, Inc.

27 MNET ProLinx Gateway Modbus TCP/IP Protocol Configuration Internal Address 0 to 4999 (for word-level addressing) or 0 to (for bit-level addressing) This field specifies the database address in the gateway's internal database to use as the destination for data brought in by a read command or as the source for data to be sent out by a write command. The database address is interpreted as a bit address or a 16-bit word (register) address, depending on the Modbus Function Code used in the command. For Modbus functions 1, 2, 5, and 15, this parameter is interpreted as a bitlevel address. For Modbus functions 3, 4, 6, and 16, this parameter is interpreted as a wordor register-level address Reg Count Regs: 1 to 125 Coils: 1 to 800 This parameter specifies the number of 16-bit registers or binary bits to be transferred by the command. Functions 5 and 6 ignore this field as they apply only to a single data point. For functions 1, 2, and 15, this parameter sets the number of bits (inputs or coils) to be transferred by the command. For functions 3, 4, and 16, this parameter sets the number of registers to be transferred by the command. ProSoft Technology, Inc. Page 27 of 78

28 Modbus TCP/IP Protocol Configuration MNET ProLinx Gateway Swap Code NONE SWAP WORDS SWAP WORDS & BYTES SWAP BYTES This parameter defines if and how the order of bytes in data received or sent is to be rearranged. This option exists to allow for the fact that different manufacturers store and transmit multi-byte data in different combinations that do other manufacturers. This parameter is helpful when dealing with floating-point or other multi-byte values, as there is no one standard method of storing these data types. This parameter can be set to rearrange the byte order of data received or sent into order more useful or convenient for other applications. The following table defines the valid Swap Code values and the effect they have on the byteorder of the data. Swap Code Description None No Change is made in the byte ordering (1234 = 1234) Swap Words The words are swapped (1234=3412) Swap Words & Bytes The words are swapped then the bytes in each word are swapped (1234=4321) Swap Bytes The bytes in each word are swapped (1234=2143) These swap operations affect 4-byte (or 2-word) groups of data. Therefore, data swapping using these Swap Codes should be done only when using an even number of words, such as when 32-bit integer or floating-point data is involved Node IP Address xxx.xxx.xxx.xxx The IP address of the device being addressed by the command Service Port 502 or other supported ports on server Use a value of 502 when addressing Modbus TCP/IP servers that are compatible with the Schneider Electric MBAP specifications (this will be most devices). If a server implementation supports another service port, enter the value here. Page 28 of 78 ProSoft Technology, Inc.

29 MNET ProLinx Gateway Modbus TCP/IP Protocol Configuration Slave Address 0 - Broadcast to all nodes 1 to 255 Use this parameter to specify the slave address of a remote Modbus Serial device through a Modbus Ethernet to Serial converter. Note: Use the Node IP Address parameter (page 28) to address commands to a remote Modbus TCP/IP device. Note: Most Modbus devices accept an address in the range of only 1 to 247, so check with slave device manufacturer to see if a particular slave can use addresses 248 to 255. If the value is set to zero, the command will be a broadcast message on the network. The Modbus protocol permits broadcast commands for write operations. Do not use node address 0 for read operations Modbus Function 1, 2, 3, 4, 5, 6, 15, or 16 This parameter specifies the Modbus Function Code to be executed by the command. These function codes are defined in the Modbus protocol. The following table lists the purpose of each function supported by the module. More information on the protocol is available from Modbus Function Code Description 1 Read Coil Status 2 Read Input Status 3 Read Holding Registers 4 Read Input Registers 5 Force (Write) Single Coil 6 Preset (Write) Single Register 15 Force Multiple Coils 16 Preset Multiple Registers ProSoft Technology, Inc. Page 29 of 78

30 Modbus TCP/IP Protocol Configuration MNET ProLinx Gateway MB Address in Device This parameter specifies the starting Modbus register or bit address in the slave to be used by the command. Refer to the documentation of each Modbus slave device for the register and bit address assignments valid for that device. The Modbus Function Code determines whether the address will be a register- or bit- level OFFSET address into a given data type range. The offset will be the target data address in the slave minus the base address for that data type. Base addresses for the different data types are: or (0x0001) for bit-level Coil data (Function Codes 1, 5, and 15) or (1x0001) for bit-level Input Status data (Function Code 2) or (3x0001) for Input Register data (Function Code 4) or (4x0001) for Holding Register data (Function Codes 3, 6, and 16). Address calculation examples: For bit-level Coil commands (FC 1, 5, or 15) to read or write a Coil 0X address 00001, specify a value of 0 ( = 0). For Coil address 00115, specify 114 ( = 114) For register read or write commands (FC 3, 6, or 16) 4X range, for 40001, specify a value of 0 ( = 0). For 01101, 11101, or 41101, specify a value of ( = 1100) ( = 1100) ( = 1100) ( = 1100) Note: If the documentation for a particular Modbus slave device lists data addresses in hexadecimal (base16) notation, you will need to convert the hexadecimal value to a decimal value to enter in this parameter. In such cases, it is not usually necessary to subtract 1 from the converted decimal number, as this addressing scheme typically uses the exact offset address expressed as a hexadecimal number. Page 30 of 78 ProSoft Technology, Inc.

31 MNET ProLinx Gateway Modbus TCP/IP Protocol Configuration 2.6 Using the CommonNet Data Map The Data Map section allows you to copy data between areas in the gateway's internal database. You can copy a maximum of 100 registers per Data Map command, and you can configure a maximum of 200 separate copy commands. You can copy data from the error or status tables in upper memory to internal database registers in the User Data memory area. You can rearrange the byte and/or word order during the copy process. For example, by rearranging byte or word order, you can convert floating-point values to the correct format for a different protocol. You can also use the Data Map to condense widely dispersed data into one contiguous data block, making it easier to access. ProSoft Technology, Inc. Page 31 of 78

32 Modbus TCP/IP Protocol Configuration MNET ProLinx Gateway From Address 0 to highest Status Data address This field specifies the beginning internal database register address for the copy operation. This address can be any valid address in the User Data Area or the Status Data Area of the gateway To Address 0 to 3999 This parameter specifies the beginning destination register address for the copy operation. This address must always be within the User Data registers area. Take care to specify a destination address that will not overwrite data that has been stored in memory by one of the communication protocols running on the gateway Register Count 1 to 100 This parameter specifies the number of registers to copy Swap Code NO CHANGE, WORD SWAP, WORD AND BYTE SWAP, BYTE SWAP You may need to swap the order of the bytes in the registers during the copy process in order to change the alignment of bytes between dissimilar protocols. This parameter is helpful when dealing with floating-point or other multi-register values, as there is no standard method of storage of these data types in slave devices. The following table defines the values and their associated operations: Swap Code Description No Swap No change is made in the byte ordering (1234 = 1234) Word Swap The words are swapped (1234=3412) Word and The words are swapped, then the bytes in each word are swapped (1234=4321) Byte Swap Bytes The bytes in each word are swapped (1234=2143) Page 32 of 78 ProSoft Technology, Inc.

33 MNET ProLinx Gateway Modbus TCP/IP Protocol Configuration Delay Preset This parameter sets an interval for each Data Map copy operation. The value you put for the Delay Preset is not a fixed amount of time. It is the number of firmware scans that must transpire between copy operations. The firmware scan cycle can take a variable amount of time, depending on the level of activity of the protocol drivers running on the ProLinx gateway and the level of activity on the gateway's communication ports. Each firmware scan can take from 1 to several milliseconds to complete. Therefore, Data Map copy operations cannot be expected to happen at regular intervals. If multiple copy operations (several rows in the Data map section) happen too frequently or all happen in the same update interval, they could delay the process scan of the gateway protocols, which could result in slow data updates or missed data on communication ports. To avoid these potential problems, you should set the Delay Preset to different values for each row in the Data Map section and set them to higher, rather than lower, numbers. For example, Delay Preset values below 1000 could begin to cause a noticeable delay in data updates through the communication ports. And you should not set all Delay Presets to the same value. Instead, use different values for each row in the Data Map such as 1000, 1001, and 1002 or any other different Delay Preset values you like. This will prevent the copies from happening concurrently and prevent possible process scan delays. ProSoft Technology, Inc. Page 33 of 78

34 Modbus TCP/IP Protocol Configuration MNET ProLinx Gateway 2.7 Ethernet Configuration Use this procedure to configure the Ethernet settings for your module. You must assign an IP address, subnet mask and gateway address. After you complete this step, you can connect to the module with an Ethernet cable. 1 Determine the network settings for your module, with the help of your network administrator if necessary. You will need the following information: o IP address (fixed IP required)... o Subnet mask... o Gateway address... Note: The gateway address is optional, and is not required for networks that do not use a default gateway. 2 Double-click the ETHERNET CONFIGURATION icon. This action opens the Edit dialog box. 3 Edit the values for my_ip, netmask (subnet mask) and gateway (default gateway). 4 When you are finished editing, click OK to save your changes and return to the ProSoft Configuration Builder window. Page 34 of 78 ProSoft Technology, Inc.

35 MNET ProLinx Gateway Modbus TCP/IP Protocol Configuration 2.8 Downloading a File from PC to the Module 1 Verify that your PC is connected to the gateway with a null-modem serial cable connected to the serial port on your PC and the serial port on the gateway 2 Open the PROJECT menu, and then choose MODULE. 3 On the MODULE menu, choose DOWNLOAD. Wait while ProSoft Configuration scans for communication ports on your PC. When the scan is complete, the Download dialog box opens. 4 Select the PORT to use for the download. 5 Click the DOWNLOAD button. Note: If you change the IP Address, you must cycle power to the gateway for the change to take effect. ProSoft Technology, Inc. Page 35 of 78

36 Modbus TCP/IP Protocol Configuration MNET ProLinx Gateway Page 36 of 78 ProSoft Technology, Inc.

37 MNET ProLinx Gateway Diagnostics and Troubleshooting 3 Diagnostics and Troubleshooting In This Chapter Debug Port Requirements LED Indicators MNET Error and Status Data There are two ways to troubleshoot ProLinx Gateways: Using the LEDs located on the front of the gateway Using the Debug port that provides a view into the gateway's internal database. ProSoft Technology, Inc. Page 37 of 78

38 Diagnostics and Troubleshooting MNET ProLinx Gateway 3.1 Debug Port Requirements In order to use the Debug capabilities of any ProLinx Module you will need the following: A PC running ProSoft Configuration Builder or HyperTerminal software A Null Modem cable A Mini-DIN to DB-9M connector Configuration and executable files described earlier Using ProSoft Configuration Builder (PCB) for Diagnostics The Configuration and Debug menu for this gateway is arranged as a tree structure, with the Main menu at the top of the tree, and one or more submenus for each menu command. The first menu you see when you connect to the gateway is the Main menu. Because this is a text-based menu system, you enter commands by typing the [command letter] from your computer keyboard in the Diagnostic window in ProSoft Configuration Builder (PCB). The gateway does not respond to mouse movements or clicks. The command executes as soon as you press the [COMMAND LETTER] you do not need to press [ENTER]. When you type a [COMMAND LETTER], a new screen will be displayed in your terminal application. Required Hardware You can connect directly from your computer s serial port to the serial port on the gateway to view configuration information, perform maintenance, and send or receive configuration files. ProSoft Technology recommends the following minimum hardware to connect your computer to the gateway: based processor (Pentium preferred) 1 megabyte of memory At least one UART hardware-based serial communications port available. USB-based virtual UART systems (USB to serial port adapters) often do not function reliably, especially during binary file transfers, such as when uploading/downloading configuration files or gateway firmware upgrades. To connect to the gateway s Configuration/Debug serial port Using the Diagnostic Window in ProSoft Configuration Builder 1 Start PCB, and then select the gateway to test. Click the right mouse button to open a shortcut menu. Page 38 of 78 ProSoft Technology, Inc.

39 MNET ProLinx Gateway Diagnostics and Troubleshooting 2 On the shortcut menu, choose DIAGNOSTICS. This action opens the Diagnostics dialog box. 3 Press [?] to open the Main menu. If there is no response from the gateway, follow these steps: ProSoft Technology, Inc. Page 39 of 78

40 Diagnostics and Troubleshooting MNET ProLinx Gateway 1 Click to configure the connection. On the Connection Setup dialog box, select a valid com port or other connection type supported by the gateway. 2 Verify that the null modem cable is connected properly between your computer s serial port and the gateway. A regular serial cable will not work. 3 On computers with more than one serial port, verify that your communication program is connected to the same port that is connected to the gateway. If you are still not able to establish a connection, contact ProSoft Technology for assistance. Page 40 of 78 ProSoft Technology, Inc.

41 MNET ProLinx Gateway Diagnostics and Troubleshooting Navigation All of the submenus for this gateway contain commands to redisplay the menu or return to the previous menu. You can always return from a submenu to the next higher menu by pressing [M] on your keyboard. The organization of the menu structure is represented in simplified form in the following illustration: The remainder of this section shows the menus available for this gateway, and briefly discusses the commands available to you. Keystrokes The keyboard commands on these menus are usually not case sensitive. You can enter most commands in lowercase or uppercase letters. The menus use a few special characters (?, -, that must be entered exactly as shown. Some of these characters will require you to use the SHIFT, CTRL, or ALT keys to enter them correctly. For example, on US English keyboards, enter the? command as SHIFT and /. Also, take care to distinguish the different uses for uppercase letter "eye" (I), lowercase letter "el" (L), and the number one (1). Likewise, uppercase letter "oh" (O) and the number zero (0) are not interchangeable. Although these characters look alike on the screen, they perform different actions on the gateway and may not be used interchangeably Main Menu When you first connect to the module from your computer, your terminal screen will be blank. To activate the main menu, press the [?] key on your computer s keyboard. If the module is connected properly, the main menu will appear on your terminal screen. Caution: Some of the commands available to you from this menu are designed for advanced debugging and system testing only, and can cause the gateway to stop communicating with the processor or with other devices, resulting in potential data loss or other failures. Only use these commands if you are specifically directed to do so by ProSoft Technology Technical Support staff. Some of these command keys are not listed on the menu, but are active nevertheless. Please be careful when pressing keys so that you do not accidentally execute an unwanted command. ProSoft Technology, Inc. Page 41 of 78

42 Diagnostics and Troubleshooting MNET ProLinx Gateway Opening the Database View Menu Press [D] to open the Database View menu. Use this menu command to view the current contents of the gateway s database. For more information about this submenu, see Database View Menu (page 43). Viewing Module Configuration Press [C] to view the Module Configuration screen. Use this command to display the current configuration and statistics for the gateway. Viewing Version Information Press [V] to view version information for the gateway. Use this command to view the current version of the software for the gateway, as well as other important values. You may be asked to provide this information when calling for technical support on the product. Values at the bottom of the display are important in determining gateway operation. The Program Scan Counter value is incremented each time a gateway s program cycle is complete. Tip: Repeat this command at one-second intervals to determine the frequency of program execution. Viewing Client Configuration Press [B] to view configuration information for the client. Opening the Network Menu Press [@] to open the Network menu. The Network menu allows you to send, receive and view the WATTCP.CFG file that contains the IP, gateway and other network specification information. For more information about this submenu, see Network Menu (page 47). Warm Booting the Module Press [W] from the Main menu to warm boot (restart) the gateway. This command will cause the program to exit and reload, refreshing configuration parameters that must be set on program initialization. Only use this command if you must force the gateway to reboot. Exiting the Program Press [ESC] to restart the gateway and force all drivers to be loaded. The gateway will use the configuration stored in the gateway's Flash memory to configure the gateway. Page 42 of 78 ProSoft Technology, Inc.