ProSoft Technology 5201-MNET-ASCII Owner's manual

MNET

ProLinx Gateway

Modbus TCP/IP Interface Module

September 1, 2010

DRIVER MANUAL

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 93309

+1 (661) 716-5100

+1 (661) 716-5101 (Fax)

www.prosoft-technology.com

support@prosoft-technology.com

MNET Driver Manual

September 1, 2010

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: www.prosoft-technology.com

Printed documentation is available for purchase. Contact ProSoft Technology for pricing and availability.

North America: +1.661.716.5100

Asia Pacific: +603.7724.2080

Europe, Middle East, Africa: +33 (0) 5.3436.87.20

Latin America: +1.281.298.9109

Important Installation Instructions

Power, Input, and Output (I/O) wiring must be in accordance with Class I, Division 2 wiring methods, Article 501-4 (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 12.12.01 Class I, Div 2 Groups A, B, C, D

cULus C22.2 No. 213-M1987

183151

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.

MNET ♦ ProLinx Gateway Contents

Modbus TCP/IP Interface Module Driver Manual

ProSoft Technology, Inc. Page 5 of 78

September 1, 2010

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 ................................................................ 3

1 Functional Overview 9

1.1 Modbus TCP/IP (MNET) Port .................................................................................. 10

1.2 General Specifications ............................................................................................ 11

1.3 Modbus TCP/IP ....................................................................................................... 12

1.4 Internal Database .................................................................................................... 13

1.4.1 Modbus TCP/IP Client Access to Database............................................................ 13

1.4.2 Modbus TCP/IP Server Access to Database .......................................................... 13

1.4.3 Modbus Message Routing: Port 2001 ..................................................................... 15

2 Modbus TCP/IP Protocol Configuration 17

2.1 Installing ProSoft Configuration Builder Software ................................................... 18

2.1.1 Using the Online Help ............................................................................................. 18

2.2 Configure the Gateway ............................................................................................ 19

2.2.1 Configuring Module Parameters ............................................................................. 19

2.2.2 Printing a Configuration File .................................................................................... 19

2.3 [MNET Servers] ....................................................................................................... 20

2.3.1 Float Flag ................................................................................................................ 20

2.3.2 Float Start ................................................................................................................ 20

2.3.3 Float Offset .............................................................................................................. 20

2.3.4 Output Offset ........................................................................................................... 21

2.3.5 Bit Input Offset ......................................................................................................... 21

2.3.6 Holding Register Offset ........................................................................................... 21

2.3.7 Word Input Offset .................................................................................................... 21

2.3.8 Connection Timeout ................................................................................................ 21

2.4 [MNET CLIENT 0] ................................................................................................... 22

2.4.1 Minimum Command Delay ...................................................................................... 22

2.4.2 Response Timeout .................................................................................................. 22

2.4.3 Retry Count ............................................................................................................. 22

2.4.4 Float Flag ................................................................................................................ 23

2.4.5 Float Start ................................................................................................................ 23

2.4.6 Float Offset .............................................................................................................. 23

2.4.7 ARP Timeout ........................................................................................................... 23

2.4.8 Command Error Delay ............................................................................................. 23

2.5 [MNET CLIENT 0 COMMANDS] ............................................................................. 24

2.5.1 Command List Overview ......................................................................................... 24

2.5.2 Commands Supported by the Module ..................................................................... 25

2.5.3 Command Entry Formats ........................................................................................ 25

2.5.4 Enable ..................................................................................................................... 26

2.5.5 Internal Address ...................................................................................................... 27

Contents MNET ♦ ProLinx Gateway

Driver Manual Modbus TCP/IP Interface Module

Page 6 of 78 ProSoft Technology, Inc.

September 1, 2010

2.5.6 Reg Count ............................................................................................................... 27

2.5.7 Swap Code ............................................................................................................. 28

2.5.8 Node IP Address ..................................................................................................... 28

2.5.9 Service Port ............................................................................................................ 28

2.5.10 Slave Address ......................................................................................................... 29

2.5.11 Modbus Function .................................................................................................... 29

2.5.12 MB Address in Device ............................................................................................ 30

2.6 Using the CommonNet Data Map ........................................................................... 31

2.6.1 From Address ......................................................................................................... 32

2.6.2 To Address .............................................................................................................. 32

2.6.3 Register Count ........................................................................................................ 32

2.6.4 Swap Code ............................................................................................................. 32

2.6.5 Delay Preset ........................................................................................................... 33

2.7 Ethernet Configuration ............................................................................................ 34

2.8 Downloading a File from PC to the Module ............................................................ 35

3 Diagnostics and Troubleshooting 37

3.1 Debug Port Requirements ...................................................................................... 38

3.1.1 Using ProSoft Configuration Builder (PCB) for Diagnostics ................................... 38

3.1.2 Main Menu .............................................................................................................. 41

3.1.3 Database View Menu .............................................................................................. 43

3.1.4 Master Command Error List Menu.......................................................................... 45

3.1.5 Master Command List Menu ................................................................................... 46

3.1.6 Network Menu ......................................................................................................... 47

3.2 LED Indicators ........................................................................................................ 49

3.2.1 Base Module LEDs ................................................................................................. 49

3.2.2 Ethernet LED Indicators .......................................................................................... 49

3.3 MNET Error and Status Data .................................................................................. 50

3.3.1 MNET Client Error/Status Data ............................................................................... 50

3.3.2 MNET Server Port 2000 Status Error Locations ..................................................... 51

3.3.3 MNET Server Port 502 Status Error Locations ....................................................... 52

3.3.4 MNET Server Port 2001 Error Locations ................................................................ 52

3.3.5 MNET Client Command List Error Data ................................................................. 53

4 Modbus Protocol Specification 55

4.1 Read Coil Status (Function Code 01) ..................................................................... 56

4.2 Read Input Status (Function Code 02) ................................................................... 57

4.3 Read Holding Registers (Function Code 03) .......................................................... 58

4.4 Read Input Registers (Function Code 04) .............................................................. 59

4.5 Force Single Coil (Function Code 05) .................................................................... 60

4.6 Preset Single Register (Function Code 06) ............................................................ 61

4.7 Diagnostics (Function Code 08) ............................................................................. 62

4.7.1 Sub-function codes supported ................................................................................ 63

4.7.2 Modbus Exception Responses ............................................................................... 64

4.8 Force Multiple Coils (Function Code 15) ................................................................ 66

4.9 Preset Multiple Registers (Function Code 16) ........................................................ 67

5 Support, Service & Warranty 69

How to Contact Us: Technical Support ............................................................................................ 69

5.1 Return Material Authorization (RMA) Policies and Conditions ............................... 71

MNET ♦ ProLinx Gateway Contents

Modbus TCP/IP Interface Module Driver Manual

ProSoft Technology, Inc. Page 7 of 78

September 1, 2010

5.1.1 All Product Returns: ................................................................................................ 71

5.1.2 Procedures for Return of Units Under Warranty: .................................................... 72

5.1.3 Procedures for Return of Units Out of Warranty: .................................................... 72

5.2 LIMITED WARRANTY ............................................................................................. 73

5.2.1 What Is Covered By This Warranty ......................................................................... 73

5.2.2 What Is Not Covered By This Warranty .................................................................. 74

5.2.3 Disclaimer Regarding High Risk Activities .............................................................. 74

5.2.4 Intellectual Property Indemnity ................................................................................ 75

5.2.5 Disclaimer of all Other Warranties .......................................................................... 75

5.2.6 Limitation of Remedies ** ........................................................................................ 76

5.2.7 Time Limit for Bringing Suit ..................................................................................... 76

5.2.8 No Other Warranties ............................................................................................... 76

5.2.9 Allocation of Risks ................................................................................................... 76

5.2.10 Controlling Law and Severability ............................................................................. 76

Index 77

Contents MNET ♦ ProLinx Gateway

Driver Manual Modbus TCP/IP Interface Module

Page 8 of 78 ProSoft Technology, Inc.

September 1, 2010

MNET ♦ ProLinx Gateway Functional Overview

Modbus TCP/IP Interface Module Driver Manual

ProSoft Technology, Inc. Page 9 of 78

September 1, 2010

1 Functional Overview

 Modbus TCP/IP (MNET) Port

In This Chapter

................................................................ 10

 General Specifications........................................................................... 11

 Modbus TCP/IP ..................................................................................... 12

 Internal Database .................................................................................. 13

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 Email 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.

Functional Overview MNET ♦ ProLinx Gateway

Driver Manual Modbus TCP/IP Interface Module

Page 10 of 78 ProSoft Technology, Inc.

September 1, 2010

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.

DATA

LINK

DATA

LINK

MNET ♦ ProLinx Gateway Functional Overview

Modbus TCP/IP Interface Module Driver Manual

ProSoft Technology, Inc. Page 11 of 78

September 1, 2010

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 65535 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 400001, protocol base 0.

 Error codes, network error counters, and port status data available in user

data memory

Functional Overview MNET ♦ ProLinx Gateway

Driver Manual Modbus TCP/IP Interface Module

Page 12 of 78 ProSoft Technology, Inc.

September 1, 2010

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

MNET ♦ ProLinx Gateway Functional Overview

Modbus TCP/IP Interface Module Driver Manual

ProSoft Technology, Inc. Page 13 of 78

September 1, 2010

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.

1.4.1 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.

1.4.2 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.

Functional Overview MNET ♦ ProLinx Gateway

Driver Manual Modbus TCP/IP Interface Module

Page 14 of 78 ProSoft Technology, Inc.

September 1, 2010

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 2000. 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

0 40001

1000 41001

2000 42001

3000 43001

3999 44000

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 floating-

point data.

Database Address Modbus Address

4000 44001

5000 45001

6000 46001

7000 47001

8000 48001

9000 49001

9999 50000

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.

MNET ♦ ProLinx Gateway Functional Overview

Modbus TCP/IP Interface Module Driver Manual

ProSoft Technology, Inc. Page 15 of 78

September 1, 2010

1.4.3 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.

Functional Overview MNET ♦ ProLinx Gateway

Driver Manual Modbus TCP/IP Interface Module

Page 16 of 78 ProSoft Technology, Inc.

September 1, 2010

MNET ♦ ProLinx Gateway Modbus TCP/IP Protocol Configuration

Modbus TCP/IP Interface Module Driver Manual

ProSoft Technology, Inc. Page 17 of 78

September 1, 2010

2 Modbus TCP/IP Protocol Configuration

 Installing ProSoft Configuration Builder Software

In This Chapter

.................................. 18

 Configure the Gateway .......................................................................... 19

 [MNET Servers] ..................................................................................... 20

 [MNET CLIENT 0] ................................................................................. 22

 [MNET CLIENT 0 COMMANDS] ........................................................... 24

 Using the CommonNet Data Map .......................................................... 31

 Ethernet Configuration .......................................................................... 34

 Downloading a File from PC to the Module ........................................... 35

Modbus TCP/IP Protocol Configuration MNET ♦ ProLinx Gateway

Driver Manual Modbus TCP/IP Interface Module

Page 18 of 78 ProSoft Technology, Inc.

September 1, 2010

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.

1 Open your web browser and navigate to http://www.prosoft-

technology.com/pcb

Installing ProSoft Configuration Builder from the ProSoft website

2 Click the DOWNLOAD HERE link to download the latest version of ProSoft

Configuration Builder.

3 Choose S

AVE 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.

1 Insert the ProSoft Solutions Product CD-ROM into the CD-ROM drive of your

PC. Wait for the startup screen to appear.

Installing ProSoft Configuration Builder from the Product CD-ROM

2 On the startup screen, click PRODUCT DOCUMENTATION. This action opens a

Windows Explorer file tree window.

3 Click to open the U

TILITIES folder. This folder contains all of the applications

and files you will need to set up and configure your gateway.

4 Double-click the S

ETUP 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.

2.1.1 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 H

ELP

menu, and then choose CONTENTS.

MNET ♦ ProLinx Gateway Modbus TCP/IP Protocol Configuration

Modbus TCP/IP Interface Module Driver Manual

ProSoft Technology, Inc. Page 19 of 78

September 1, 2010

2.2 Configure the Gateway

2.2.1 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.

2.2.2 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 F

ILE 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.

Modbus TCP/IP Protocol Configuration MNET ♦ ProLinx Gateway

Driver Manual Modbus TCP/IP Interface Module

Page 20 of 78 ProSoft Technology, Inc.

September 1, 2010

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.

2.3.1 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.

2.3.2 Float Start

0 to 32767

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.

2.3.3 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 3000.

Page is loading ...

ProSoft Technology 5201-MNET-ASCII Owner's manual

ProSoft Technology 5201-MNET-ASCII Owner's manual

Related papers

Other documents