ProSoft Technology 5301-MBP-ASCII User Manual
MBP
ProLinx Gateway
Modbus Plus
May 12, 2011
PROTOCOL 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.
How to Contact 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
Copyright © 2011 ProSoft Technology, Inc., all rights reserved.
MBP Protocol Manual
May 12, 2011
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 in
Adobe® Acrobat Reader file format (.PDFs). These product documentation files may also be freely downloaded from
our web site: www.prosoft-technology.com
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:
WARNING - EXPLOSION HAZARD - SUBSTITUTION OF COMPONENTS MAY IMPAIR SUITABILITY FOR CLASS
I, DIV. 2;
WARNING - EXPLOSION HAZARD - WHEN IN HAZARDOUS LOCATIONS, TURN OFF POWER BEFORE
REPLACING OR WIRING MODULES
WARNING - EXPLOSION HAZARD - DO NOT DISCONNECT EQUIPMENT UNLESS POWER HAS BEEN
SWITCHED OFF OR THE AREA IS KNOWN TO BE NON-HAZARDOUS.
THIS DEVICE SHALL BE POWERED BY CLASS 2 OUTPUTS ONLY.
ProLinx® Products Warnings
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.
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.
MBP ♦ ProLinx Gateway Contents
Modbus Plus Protocol Manual
Contents
Your Feedback Please ........................................................................................................................ 2
How to Contact Us .............................................................................................................................. 2
ProSoft Technology® Product Documentation .................................................................................... 2
Important Installation Instructions ....................................................................................................... 3
ProLinx® Products Warnings ............................................................................................................... 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 7
1.1
1.2
1.3
1.4
1.2.1
1.2.2
1.2.3
1.2.4
1.2.5
Modbus Plus Port ...................................................................................................... 8
Module Internal Database ......................................................................................... 9
Modbus Plus Port Access to Database ..................................................................... 9
Modbus Plus Master Access to Database .............................................................. 10
Modbus Plus Slave Access to Database ................................................................ 11
Modbus Plus Global In Access to Database ........................................................... 12
Modbus Plus Global Out Access to Database ........................................................ 13
Single Port With Dual Media-Redundant Connector Operation .............................. 14
Command Routing .................................................................................................. 15
2 Port Physical and Protocol Specifications 17
2.1
2.2
2.3
Functional Specifications - Modbus Plus ................................................................ 18
General Specifications - ProLinx ............................................................................. 19
Hardware Specifications.......................................................................................... 20
3 MBP Protocol Configuration 21
3.1
3.1.1
3.1.2
3.1.3
3.1.4
3.2
3.2.1
3.2.2
3.2.3
3.3
3.3.1
3.3.2
3.3.3
3.3.4
3.3.5
3.3.6
3.3.7
3.3.8
[Modbus Plus Configuration] ................................................................................... 22
Local Node Address ................................................................................................ 22
Global Output File Length ....................................................................................... 22
Global Input Update Timeout .................................................................................. 23
Master Command Timeout Preset .......................................................................... 23
[Modbus Plus Device Definition] ............................................................................. 24
Route Values ........................................................................................................... 25
Global In Length ...................................................................................................... 25
Global In Address .................................................................................................... 25
[Modbus Plus Commands] ...................................................................................... 26
Enable ..................................................................................................................... 26
Internal Address ...................................................................................................... 26
Poll Interval .............................................................................................................. 27
Count ....................................................................................................................... 27
Swap Code .............................................................................................................. 27
Device Index ............................................................................................................ 28
Function Code ......................................................................................................... 28
Device Address ....................................................................................................... 28
ProSoft Technology, Inc. Page 5 of 52
May 12, 2011
Contents MBP ♦ ProLinx Gateway
Protocol Manual Modbus Plus
4 Communication Port Cables 29
4.1
4.1.1
Modbus Plus Connections ...................................................................................... 30
Port 0: RS-232 - Null Modem (without Hardware Handshaking) ............................ 31
5 LED Indicators 33
5.1
LEDs for the Modbus Plus Port .............................................................................. 34
6 Serial Port Modbus Error and Status Data 35
6.1
6.2
6.3
6.4
6.2.1
6.3.1
6.4.1
6.4.2
6.4.3
Viewing Error and Status Data ............................................................................... 36
Global Input Update Status ..................................................................................... 37
Global In Status Code Definitions ........................................................................... 37
Master Command Status ........................................................................................ 38
Master Command Status Error Code Definitions ................................................... 38
Miscellaneous Module Status ................................................................................. 39
Module Status Values ............................................................................................. 40
Peer Status Codes .................................................................................................. 41
Global Out Update Status ....................................................................................... 41
7 Support, Service & Warranty 43
Contacting Technical Support .......................................................................................................... 43
7.1
7.2
7.1.1
7.1.2
7.1.3
7.2.1
7.2.2
7.2.3
7.2.4
7.2.5
7.2.6
7.2.7
7.2.8
7.2.9
7.2.10
Return Material Authorization (RMA) Policies and Conditions ............................... 45
Returning Any Product ............................................................................................ 45
Returning Units Under Warranty ............................................................................. 46
Returning Units Out of Warranty ............................................................................. 46
LIMITED WARRANTY ............................................................................................ 47
What Is Covered By This Warranty ........................................................................ 47
What Is Not Covered By This Warranty .................................................................. 48
Disclaimer Regarding High Risk Activities .............................................................. 48
Intellectual Property Indemnity ............................................................................... 49
Disclaimer of all Other Warranties .......................................................................... 49
Limitation of Remedies ** ....................................................................................... 50
Time Limit for Bringing Suit ..................................................................................... 50
No Other Warranties ............................................................................................... 50
Allocation of Risks .................................................................................................. 50
Controlling Law and Severability ............................................................................ 50
Index 51
Page 6 of 52 ProSoft Technology, Inc.
May 12, 2011
MBP ♦ ProLinx Gateway Functional Overview
Modbus Plus Protocol Manual
1 Functional Overview
In This Chapter
Modbus Plus Port .................................................................................... 8
Module Internal Database ....................................................................... 9
Single Port With Dual Media-Redundant Connector Operation ............. 14
Command Routing ................................................................................ 15
ProSoft Technology, Inc. Page 7 of 52
May 12, 2011
Functional Overview MBP ♦ ProLinx Gateway
Protocol Manual Modbus Plus
1.1 Modbus Plus Port
The ProLinx module supports the Modbus Plus protocol on the DB-9 Male
Modbus Plus port. The Modbus port is configurable.
The Modbus Plus port can be used to continuously interface with Modbus Plus
devices over a network. The port supports 200 user-defined commands that
determine the Modbus Plus messages issued to each individual unit attached to
the network.
Page 8 of 52 ProSoft Technology, Inc.
May 12, 2011
MBP ♦ ProLinx Gateway Functional Overview
Modbus Plus Protocol Manual
1.2 Module Internal Database
The internal database is central to the functionality of the module. This database
is shared between all the ports on the module 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 Modbus Plus port, status and error information
generated by the module can also be mapped into the internal database.
1.2.1 Modbus Plus Port Access to Database
The Modbus Plus driver uses the database in two ways:
1 A read command issued to a Modbus Plus device by the driver will return the
foreign device data into the internal database.
2 A write command issued to a Modbus Plus device by the driver will use the
data in the internal database to write to the foreign device.
External Modbus Plus devices can monitor and control data in this database
through the Modbus Plus Port. Setup of the port only requires appropriate values
in the CFG file.
ProSoft Technology, Inc. Page 9 of 52
May 12, 2011
Functional Overview MBP ♦ ProLinx Gateway
Protocol Manual Modbus Plus
1.2.2 Modbus Plus Master Access to Database
The Master functionality exchanges data between MBP module's internal
database and data tables established in one or more Modicon processors or
other Modbus Plus slave devices. The command list, defined in the user
configuration, defines what data to transfer between the module and each of the
slaves on the network. No ladder logic is required in the processor for master
functionality, except to assure that sufficient data memory exists.
The following illustration describes the flow of data between the Modbus Plus
devices and the internal database.
Page 10 of 52 ProSoft Technology, Inc.
May 12, 2011
MBP ♦ ProLinx Gateway Functional Overview
Modbus Plus Protocol Manual
1.2.3 Modbus Plus Slave Access to Database
The MBP module supports slave functionality using the Modbus Plus protocol.
Services supported in the module permit Modbus Plus master applications (that
is, HMI software applications, Modicon processors, and so on) to read from and
write to the module's database. This section discusses the requirements for
attaching to the module using several Modbus Plus master applications.
There is no configuration of the MBP module required to implement Slave
functionality other than setting up the network and database parameters in the
user configuration file.
The internal database of the MBP module is used as the source (read requests)
and destination (write requests) for requests from remote masters. Access to the
database depends on the command type executed to interface with the
database. The following table defines the relationship of the module's internal
database to the addresses required in the instructions:
Database Address Modbus Address
0 40001
1000 41001
2000 42001
3000 43001
4000 44001
5000 45001
6000 46001
7000 47001
8000 48001
9000 49001
9999 50000
Before attempting to use the module on a network, verify that the MBP module is
correctly configured and connected to the network. Use ProSoft Configuration
Builder to confirm proper configuration of the module, and to transfer the
configuration files to and from the module.
ProSoft Technology, Inc. Page 11 of 52
May 12, 2011
Functional Overview MBP ♦ ProLinx Gateway
Protocol Manual Modbus Plus
1.2.4 Modbus Plus Global In Access to Database
The MBP module actively exchanges global in (32 words max. per node) and
global out (32 words max.) data on the Modbus Plus network. Priority is given to
these data types to provide a high speed mechanism for the transfer of control
data.
1 The Global In driver reads configuration data from the configuration file. This
data includes the Device Definition File that includes the node address data,
the number of Global In words and where to put this data in the module's
internal database.
2 During the configuration process, the Input File Map is updated out of the
configuration file. The Input File Map informs the module which data registers
in the internal database to feed into the module's input image. This
operational mode is independent of the Global In mode but is commonly used
to transfer global input data from other nodes directly to the processor.
3 The Global In Driver monitors Global In data from other nodes on the
network. If the data matches one of the node addresses in the Device
Definition File and is qualified in terms of length, and so on. the data is
accepted.
4 After the data is accepted, the data is transferred into the module's internal
database. The user via configuration in the Device Definition File determines
the location of the data.
5 As data is read from the other nodes on the network into the module, an
asynchronous process moves the data from the database into the module's
input image. The values to be moved are user determined via configuration of
the Input File Map. Up to 32 words of data can be transferred in this fashion.
6 Status is monitored for each device in the Device Definition File that is
expected to return Global In data to the module. This status is updated on an
on-going basis and is transferred to the Modbus Plus network for processing.
This data includes the node status value and a counter incremented each
time global input data is received.
Page 12 of 52 ProSoft Technology, Inc.
May 12, 2011
MBP ♦ ProLinx Gateway Functional Overview
Modbus Plus Protocol Manual
1.2.5 Modbus Plus Global Out Access to Database
When the MBP module's Global Output capability is enabled, up to 32 words of
data can be transferred onto the Modbus Plus network by the module. This data,
typically reserved for high-speed data such as for application control data, is
transmitted each time the module receives the network token.
The number of words transferred to the Modbus Plus network is user determined
through the Module Configuration Block. The following flow chart and associated
table describe the flow of data into and out of the module.
1 The Global Output driver reads configuration data from the configuration file.
This data consists of the number of words to be transmitted by the module
each time the module has the token. In addition, timing data on the update
rate for the Global Out transmission is also obtained from the configuration
data.
2 The Global Out data image is updated through the module's output image.
Based on the update rate configured by the user, the Global Out image in the
Modbus Plus chipset will also be updated.
3 The Global Output driver in the Modbus Plus chipset will transmit the Global
Out data each time the token is received by the module.
4 The Global Output driver status is updated in the module's database.
To enable the Global Output Mode, set the Global Output Length parameter to a
value between 1 and 32. To disable this feature, set the parameter to a value of
zero.
ProSoft Technology, Inc. Page 13 of 52
May 12, 2011
Functional Overview MBP ♦ ProLinx Gateway
Protocol Manual Modbus Plus
1.3 Single Port With Dual Media-Redundant Connector Operation
Some Modbus Plus modules are equipped with a second, redundant Modbus
Plus Connector. A Dual Connector Modbus Plus network is implemented in the
following way:
The primary network connects to Connector 1 on all modules.
The secondary (backup) network connects to Connector 2 on all modules.
If the primary network connected through Connector 1 fails (for example, if a
cable is cut or disconnected), the network connected through Connector 2 will
become active, maintaining the connection between devices.
Important: All Modbus Plus nodes on a network must be equipped with dual connectors in order to
implement redundant connector operation.
Refer to the following illustration for an example of redundant connector
operation on a Modbus Plus network.
Page 14 of 52 ProSoft Technology, Inc.
May 12, 2011
MBP ♦ ProLinx Gateway Functional Overview
Modbus Plus Protocol Manual
1.4 Command Routing
ProSoft Technology, Inc. Page 15 of 52
May 12, 2011
Functional Overview MBP ♦ ProLinx Gateway
Protocol Manual Modbus Plus
Page 16 of 52 ProSoft Technology, Inc.
May 12, 2011
Loading...