Modbus Integration Guide
Modbus Integration Guide
Rev. 6/28/2012
Verify that you have the most current version of this document. Go to [Link] then select Support >
Download > Third-party Interfaces > Third-party Integration Guides.
Contents
Overview .................................................................................................................................. 1
Controller as a master device on EIA-232/485 ............................................................................ 2
Before-you-begin checklist ........................................................................................... 2
The integration process ................................................................................................ 3
1 Create a control program in EIKON® LogicBuilder ..................................................... 3
Formatting a Modbus address ....................................................................... 3
Editing a microblock address ......................................................................... 5
2 Download the Modbus driver and control programs ................................................... 6
3 Connect the Automated Logic® controller to the third-party device ............................ 6
Wiring specifications ..................................................................................... 6
To wire a third-party device ............................................................................ 6
4 Set up the Modbus Combo driver properties .............................................................. 8
5 Verify the controller is set up correctly ....................................................................... 8
To capture communication using PuTTY ........................................................ 10
Controller as a slave device on EIA-232/485............................................................................. 12
Before-you-begin checklist ......................................................................................... 12
The integration process .............................................................................................. 13
1 Create a control program in EIKON® LogicBuilder ................................................... 13
Formatting a Modbus address ..................................................................... 13
Editing a microblock address ....................................................................... 15
2 Download the Modbus driver and control programs ................................................. 15
3 Connect the Automated Logic® controller to the third-party device .......................... 15
Wiring specifications ................................................................................... 15
To wire a third-party device .......................................................................... 16
4 Set up the Modbus Combo driver properties ............................................................ 17
5 Verify the controller is set up correctly ..................................................................... 17
To capture communication using PuTTY ........................................................ 19
Controller as a client device on Ethernet.................................................................................... 21
Before-you-begin checklist ......................................................................................... 21
The integration process .............................................................................................. 22
1 Create a control program in EIKON® LogicBuilder ................................................... 22
Formatting a Modbus address ..................................................................... 22
Editing a microblock address ....................................................................... 24
2 Download the Modbus driver and control programs ................................................. 25
3 Connect the Automated Logic® controller to the third-party device .......................... 25
4 Set up the Modbus Combo driver properties ............................................................ 25
5 Verify the controller is set up correctly ..................................................................... 26
To capture communication using Wireshark ................................................. 27
To capture communication using PuTTY ........................................................ 28
Controller as a server device on Ethernet ................................................................................... 30
Before-you-begin checklist ......................................................................................... 30
The integration process .............................................................................................. 30
1 Create a control program in EIKON® LogicBuilder ................................................... 31
Formatting a Modbus address ..................................................................... 31
Editing a microblock address ....................................................................... 32
2 Download the Modbus driver and control programs ................................................. 33
3 Connect the Automated Logic® controller to the third-party device .......................... 33
4 Set up the Modbus Combo driver properties ............................................................ 33
5 Verify the controller is set up correctly ..................................................................... 34
To capture communication using Wireshark ................................................. 35
To capture communication using PuTTY ........................................................ 36
© 2012 Automated Logic Corporation. All rights reserved throughout the world. Automated Logic, WebCTRL, EIKON, and BACview are
registered trademarks, and EnergyReports, Environmental Index, and Eco-Screen are trademarks of Automated Logic Corporation. BACnet
is a registered trademark of ASHRAE. All other brand and product names are trademarked by their respective companies.
Modbus Troubleshooting ......................................................................................................... 38
If the Automated Logic® controller is a Serial Master or Ethernet Client ....................... 38
Register addresses ...................................................................................... 38
Errors .......................................................................................................... 39
If the Automated Logic® controller is a Serial Slave or Ethernet Server ........................ 43
Register addresses ...................................................................................... 43
Errors .......................................................................................................... 43
Appendix A - Upgrading an existing Modbus driver ..................................................................... 44
Appendix B - Modbus Protocol Conformance Statement ............................................................. 46
Overview
You can use an Automated Logic® controller to integrate Modbus device(s) with a
WebCTRL® system. The controller can serve as a master or slave on a serial network, or a
client or server on a TCP/IP network.
This document is divided into 4 sections that provide integration instructions for the 4
scenarios listed in the first two columns below. Determine how your Automated Logic®
controller will be used, then go to the appropriate page for the instructions.
NOTES
• The Modbus Combo driver supports Modbus devices connected to ports S1, S2, and
E1 simultaneously on the Automated Logic® controller. The third-party point count for
the controller is the total of the 3 ports.
• The 3 ports can simultaneously have different functionality. For example, Port S1
could be a serial master, Port S2 could be a serial slave, and Port E1 an ethernet
client.
CAUTION If you want to upgrade a system to the Modbus Combo driver, carefully
review Appendix A - Upgrading an existing Modbus driver (page 44) to determine if you
should upgrade the driver.
Automated Logic®
Controllers LGR25 ME-LGR25
LGR250 ME-LGR200
LGR1000 ME812u-LGR
Driver Modbus Combo:
drv_melgr_mb_combo_<latest version>.driver
Read/write capability Can read from and write to the third-party equipment
Third party
Supported equipment Any device that supports the Modbus (Modicon)
protocol
Network media type EIA-232, EIA-485
Quantity of Modbus slave For EIA-232: 1 Modbus slave
devices you can physically
connect to Port S1 or Port S2 on For EIA-485: Up to 254 Modbus slaves
the Automated Logic® master NOTE You may reach the point
controller limitation of the Automated
Logic® controller before
connecting 254 Modbus slaves.
Before-you-begin You need the following items, information, and skills for the integration process:
checklist
A points list for each Modbus device that includes register addresses and read/write
capabilities. Points lists are usually available from the third-party manufacturer’s
representative or website.
The addresses of the Modbus devices
The network media type required by the Modbus device: EIA-232 or EIA-485
A port pinout/configuration of the Modbus device. Pinouts are usually available from
the third-party manufacturer’s representative or website.
The Modbus network’s baud rate, data bits, parity, and stop bits
Verification that all communication properties have been set on the Modbus devices
Verification of communications through the port that the Automated Logic®
controller will connect to
Experience creating control programs in the EIKON® LogicBuilder application
Experience installing, wiring, setting up, and downloading to the Automated Logic®
controller
1 Create a When you create your control program, use a Network I/O microblock for each third-party
control program point.
in EIKON® TIP Verify the third-party manufacturer’s register addressing pattern by establishing
LogicBuilder communication with a few points whose values you can physically manipulate before you
spend time addressing the remaining integration points.
CAUTION!
When integrating third-party devices into a WebCTRL® system, most communication
problems are caused by incorrect data or typing errors in the microblock's Address field.
Example: modbus2://UINT/40128/26
NOTE To send a broadcast to all Modbus devices on the port specified by the protocol
signature, use 0 for the device address in a network output microblock.
Protocol
S2 modbus2://
* You can also use modbus:// for points on one of the ports, but not both ports.
1 The Modbus register address (sometimes called register, address, code, or parameter) must be a decimal value. If the
register addresses in the points list include the letters A-F, use a scientific calculator to convert these hexadecimal
values to decimal values.
If the register addresses in the points list are 5-digit numbers in the range #0001-#9999 (where # = the prefix 1, 3, or
4), you may use the addresses as they are, or change them to fit the formats in the table above by shifting the prefix
one digit to the left. For example, if you see the address 38129, you can also use 308129.
2 Each Float uses 2 consecutive Modbus register addresses. Use the lower number in the microblock address.
See Modbus Troubleshooting (page 38) for more information on register addresses.
8 Click .
9 In WebCTRL®, download the driver and control programs to the Automated Logic®
controller.
NOTES
• If you cannot determine the media type or connections of the third-party device,
contact your third-party representative.
• Use the same polarity throughout the network segment.
• Repeaters are required for more than 32 devices on an EAI-485 network. See your
third-party device manufacturer's recommendations.
• Configure an EIA-485, 4-wire (EIA-422) network as a linear bus with daisy-chained
connections. Star topologies are not recommended.
• To reduce communication and data errors, terminate each end of an EIA-485 network
with a resistor whose value equals the network's characteristic impedance. Some
third-party manufacturers provide a built-in resistor that you enable or disable with a
jumper. Make sure that only devices at the end of a network have termination
enabled.
EXAMPLE If an EIA-485 4-wire network's characteristic impedance is 120 Ohms,
terminate both pairs of wires at each end of the network with a 120 Ohm resistor (4
resistors total). Each end of the network will then have one resistor across the Rx+
and Rx- and one across the Tx+ and Tx-.
• A solid receive light on the Automated Logic® controller indicates a wiring or polarity
problem.
5 Set the remaining fields under Port Configuration to match the third-party device.
6 Under Protocol Configuration, verify that Is this device a Master is set to Yes.
7 Set the remaining fields using information from the third-party manufacturer's
representative. Select the Details checkbox for help.
8 On the NET tree, select Protocols.
9 In the Protocol Status table, verify the following for the port you enabled:
○ Modbus 1 shows Running on Port S1
○ Modbus 2 shows Running on Port S2
If the status shows Not Running or the wrong port, verify that:
○ You selected the correct port in step 3 above.
○ You set the controller's DIP switches correctly.
○ The control program has at least one valid Modbus address. The driver must
detect at least one valid address to initiate Modbus communications.
5 Verify the 1 On the WebCTRL® GEO tree, select the control program for the Automated Logic®
controller is set controller.
up correctly 2 Select the Properties page > Network Points tab.
If... Then...
You see the point value you You have successfully established communication with
expect with no errors in the the third-party device.
Error column
All points show question The WebCTRL® application is not communicating with
marks instead of values the Automated Logic® controller or the control program.
Troubleshoot the controller's communications. See the
controller's Technical Instructions.
If the above solutions do not resolve the problem, gather the following information for
technical support:
• A diagnostic capture. See next topic.
• A screenshot of the Driver > Protocols > Properties page and the Driver > Protocols >
Modbus > Properties page
• A screenshot of the Properties page > Network Points tab showing addresses and
errors
• Technical instructions for the third-party device, if available
PREREQUISITES
• Download and install PuTTY from the PuTTY website
([Link]
• Get the Automated Logic® controller's IP address.
• Get the longest microblock refresh time in the control program that has the error you
are troubleshooting. In WebCTRL®, view the control program's Properties page >
Network Points tab to see all the refresh times.
1 Connect your computer's Ethernet port to the controller's Ethernet port using one of
the following:
○ A CAT5 or higher Ethernet crossover cable
○ A hub and a CAT5 or higher Ethernet straight-through cable
2 Ping the Automated Logic® controller to verify communications between the
controller and the computer you are using to get this capture.
3 On the WebCTRL® NET tree, expand the Automated Logic® controller's driver, then
select Protocols.
4 Click Properties, select Enable Telnet diagnostics, then click OK.
5 Start PuTTY.
6 Enter the controller's IP address.
7 Select Telnet as the Connection Type.
8 Click the Logging option in the upper left corner of the left pane.
9 Select Printable output.
10 Select a location for the capture text file.
11 Click Open to start the session.
12 After Login:>, type: diagport
Press Enter.
13 To capture data receipts, after diagport>, do one of the following:
○ For Modbus on Port S1, type: modbus1 rx
○ For Modbus on Port S2, type: modbus2 rx
Press Enter.
14 To capture data transmissions, after diagport>, do one of the following:
○ For Modbus on Port S1, type: modbus1 tx
○ For Modbus on Port S2, type: modbus2 tx
Press Enter.
15 To capture more detailed diagnostic messages, after diagport>, do one of the
following:
○ For Modbus on Port S1, type: modbus1 vmsg
○ For Modbus on Port S2, type: modbus2 vmsg
Press Enter.
Automated Logic®
Controllers LGR25 ME-LGR25
LGR250 ME-LGR200
LGR1000 ME812u-LGR
Driver Modbus Combo:
drv_melgr_mb_combo_<latest version>.driver
Capability Can be read from and written to
Third party
Supported equipment A master device that supports the Modbus (Modicon)
protocol
Network media type EIA-232, EIA-485
Quantity of devices you can 1 Modbus master
physically connect to Port S1 or
Port S2 on the Automated
Logic® controller
Before-you-begin You need the following items, information, and skills for the integration process:
checklist
A list of the points in the Automated Logic controller that the Modbus device will
read or write to.
The Automated Logic® controller's address on the Modbus network.
The network media type required by the Modbus device: EIA-232 or EIA-485
A port pinout/configuration of the Modbus device. Pinouts are usually available from
the third-party manufacturer’s representative or website.
The Modbus network’s baud rate, data bits, parity, and stop bits
Verification that all communication properties have been set on the Modbus devices
Verification of communications through the port that the Automated Logic®
controller will connect to
Experience creating control programs in the EIKON® LogicBuilder application
Experience installing, wiring, setting up, and downloading to the Automated Logic®
controller
1 Create a When you create your control program, use a Network I/O microblock for each value that
control program you want to expose to the Modbus master.
in EIKON®
LogicBuilder
Formatting a Modbus address
Use the information below to format a valid address in each microblock that you want to
expose to the Modbus master.
CAUTION!
When integrating third-party devices into a WebCTRL® system, most communication
problems are caused by incorrect data or typing errors in the microblock's Address field.
Example: modbus2://UINT/40128
Protocol
NOTE You can also use the modbus:// signature for points on one of the ports, but not
both ports.
1 If the register addresses in the points list are 5-digit numbers in the range #0001-#9999 (where # = the prefix 1, 3,
or 4), you may use the addresses as they are, or change them to fit the formats in the table above by shifting the
prefix one digit to the left. For example, if you see the address 38129, you can also use 308129.
2 Each Float uses 2 consecutive Modbus register addresses. Use the lower number in the microblock address.
See Modbus Troubleshooting (page 38) for more information on register addresses.
8 Click .
9 In WebCTRL®, download the driver and control programs to the Automated Logic®
controller.
For... Use Wire ...to Set the port's Set DIP switches
Automated Automated third-party jumper(s) on on Automated
Logic® Logic® device Automated Logic®
controller terminal... terminal Logic® controller
port... controller
EIA-232 S1 or S2* TX Rx EIA-232 Turn off or
Rx Tx disable PTP,
MSTP, or
Signal Ground Gnd
Enhanced
EIA-485, S1 or S2* Net+ + EIA-485 Access if it
2-wire Net- - 485-2w (Port applies to the
S1 only) port you are
This is called using.
Half on some
controllers.
EIA-485, S1 Tx+ Rx+ EIA-485
4-wire Tx- Rx- 485-4w
(EIA-422) This is called
Rx+ Tx+
Full on some
Rx- Tx-
controllers.
* The ME812u-LGR does not have Port S2.
NOTES
• If you cannot determine the media type or connections of the third-party device,
contact your third-party representative.
• Use the same polarity throughout the network segment.
• Repeaters are required for more than 32 devices on an EAI-485 network. See your
third-party device manufacturer's recommendations.
• Configure an EIA-485, 4-wire (EIA-422) network as a linear bus with daisy-chained
connections. Star topologies are not recommended.
• To reduce communication and data errors, terminate each end of an EIA-485 network
with a resistor whose value equals the network's characteristic impedance. Some
third-party manufacturers provide a built-in resistor that you enable or disable with a
jumper. Make sure that only devices at the end of a network have termination
enabled.
EXAMPLE If an EIA-485 4-wire network's characteristic impedance is 120 Ohms,
terminate both pairs of wires at each end of the network with a 120 Ohm resistor (4
resistors total). Each end of the network will then have one resistor across the Rx+
and Rx- and one across the Tx+ and Tx-.
• A solid receive light on the Automated Logic® controller indicates a wiring or polarity
problem.
5 Under Port Configuration, select the controller port that connects the third-party
network.
6 Under Protocol Configuration, set Is this device a Master to No for the port you are
using.
7 In the Modbus Slave Address for this port is field, type the address of the Automated
Logic® controller on the third-party network.
8 On the NET tree, select Protocols.
9 In the Protocol Status table, verify the following for the port you enabled:
○ Modbus 1 shows Running on Port S1
○ Modbus 2 shows Running on Port S2
If the status shows Not Running or the wrong port, verify that:
○ You selected the correct port in step 3 above.
○ You set the controller's DIP switches correctly.
○ The control program has at least one valid Modbus address. The driver must
detect at least one valid address to initiate Modbus communications.
5 Verify the 1 On the WebCTRL® GEO tree, select the control program for the Automated Logic®
controller is set controller.
up correctly 2 Select the Properties page > Network Points tab.
If... Then...
You see the point value you You have successfully exposed the Automated Logic®
expect and the Error column controller's value to the third-party device.
shows Initializing
All points show question The WebCTRL® application is not communicating with
marks instead of values the Automated Logic® controller or the control program.
Troubleshoot the controller's communications. See the
controller's Technical Instructions.
If the above solutions do not resolve the problem, gather the following information for
technical support:
• A diagnostic capture. See next topic.
• A screenshot of the Driver > Protocols > Properties page and the Driver > Protocols >
Modbus > Properties page
• A screenshot of the Properties page > Network Points tab showing addresses and
errors
• Technical instructions for the third-party device, if available
PREREQUISITES
• Download and install PuTTY from the PuTTY website
([Link]
• Get the Automated Logic® controller's IP address.
• Get the longest microblock refresh time in the control program that has the error you
are troubleshooting. In WebCTRL®, view the control program's Properties page >
Network Points tab to see all the refresh times.
1 Connect your computer's Ethernet port to the controller's Ethernet port using one of
the following:
○ A CAT5 or higher Ethernet crossover cable
○ A hub and a CAT5 or higher Ethernet straight-through cable
2 Ping the Automated Logic® controller to verify communications between the
controller and the computer you are using to get this capture.
3 On the WebCTRL® NET tree, expand the Automated Logic® controller's driver, then
select Protocols.
4 Click Properties, select Enable Telnet diagnostics, then click OK.
5 Start PuTTY.
6 Enter the controller's IP address.
7 Select Telnet as the Connection Type.
8 Click the Logging option in the upper left corner of the left pane.
9 Select Printable output.
10 Select a location for the capture text file.
11 Click Open to start the session.
12 After Login:>, type: diagport
Press Enter.
13 To capture data receipts, after diagport>, do one of the following:
○ For Modbus on Port S1, type: modbus1 rx
○ For Modbus on Port S2, type: modbus2 rx
Press Enter.
14 To capture data transmissions, after diagport>, do one of the following:
○ For Modbus on Port S1, type: modbus1 tx
○ For Modbus on Port S2, type: modbus2 tx
Press Enter.
15 To capture more detailed diagnostic messages, after diagport>, do one of the
following:
○ For Modbus on Port S1, type: modbus1 vmsg
○ For Modbus on Port S2, type: modbus2 vmsg
Press Enter.
Automated Logic®
Controllers LGR25 ME-LGR25
LGR250 ME-LGR200
LGR1000 ME812u-LGR
Driver Modbus Combo:
drv_melgr_mb_combo_<latest version>.driver
Read/write capability Can read from and write to the third-party equipment
Third party
Supported equipment Any device that supports the Modbus (Modicon)
protocol
Network media type Ethernet
Quantity of devices you can Up to 30 Modbus TCP/IP connections.*
connect to the Automated
Logic® client controller
* You may be able to connect more devices (256 maximum) if you consider the
following:
• The lower the point count per device, the more devices you can connect.
• The more devices, the slower the communication between the
Automated Logic® controller and the Modbus devices.
A practical limit in most systems is approximately 100 devices. To connect more
than 30 devices, change the Close socket after each completed transaction setting
in the driver.
Before-you-begin You need the following items, information, and skills for the integration process:
checklist
The IP addresses of the Modbus server
The Unit ID of each Modbus device that contains points that the Automated Logic®
controller will read and write to, and a points list for each device that includes point
register addresses and read/write capabilities. Points lists are usually available from
the third-party manufacturer’s representative or website.
Verification that all communication properties have been set on the Modbus devices
Verification of Ethernet communication with each server that the Automated Logic®
controller will connect to
Experience creating control programs in the EIKON® LogicBuilder application
Experience installing, wiring, setting up, and downloading to the Automated Logic®
controller
1 Create a When you create your control program, use a Network I/O microblock for each third-party
control program point.
in EIKON® TIP Verify the third-party manufacturer’s register addressing pattern by establishing
LogicBuilder communication with a few points whose values you can physically manipulate before you
spend time addressing the remaining integration points.
CAUTION!
When integrating third-party devices into a WebCTRL® system, most communication
problems are caused by incorrect data or typing errors in the microblock's Address field.
Address format:
Example: mtcpip://UINT/40128/3/[Link]
Unit ID
1 The Modbus register address (sometimes called register, address, code, or parameter) must be a decimal value. If
the register addresses in the points list include the letters A-F, use a scientific calculator to convert these
hexadecimal values to decimal values.
If the register addresses in the points list are 5-digit numbers in the range #0001-#9999 (where # = the prefix 1, 3,
or 4), you may use the addresses as they are, or change them to fit the formats in the table above by shifting the
prefix one digit to the left. For example, if you see the address 38129, you can also use 308129.
2 Each Float uses 2 consecutive Modbus register addresses. Use the lower number in the microblock address.
See Modbus Troubleshooting (page 38) for more information on register addresses.
8 Click .
9 In WebCTRL®, download the driver and control programs to the Automated Logic®
controller.
3 Connect the Use one of the following CAT5 or higher Ethernet cables:
Automated • A cross-over cable to connect the Automated Logic® controller directly to the
Logic® controller third-party Modbus device
to the third-party • A straight-through cable to connect the controller to a hub or switch, and a second
device straight-through cable to connect the hub or switch to the third-party Modbus device
Maximum cable length: 328 feet (100 meters)
4 Set up the 1 On the WebCTRL® NET tree, expand the Automated Logic® controller's driver.
Modbus Combo 2 Expand Protocols, then select Modbus TCP/IP.
driver properties 3 Under Port Configuration, select TCP/IP as the Communication Type.
4 The standard Modbus TCP Port is 502. If a different port is to be used, type the port
number. Select the Details checkbox for help.
5 Under Modbus Protocol Configuration, set This device is a Client to Yes.
6 Set the remaining fields under Modbus Protocol Configuration using information from
the third-party manufacturer's representative. Select the Details checkbox for help.
7 If the Automated Logic® controller has more than 30 TCP/IP connections, under
TCP/IP Protocol Configuration, change Close socket after each completed
transaction to Yes.
NOTE If you connect more than 30 devices (256 maximum), consider the following:
• The lower the point count per device, the more devices you can connect.
• The more devices, the slower the communication between the Automated Logic®
controller and the Modbus devices.
A practical limit in most systems is approximately 100 devices.
5 Verify the 1 On the WebCTRL® GEO tree, select the control program for the Automated Logic®
controller is set controller.
up correctly 2 Select the Properties page > Network Points tab.
If... Then...
You see the point value You have successfully established communication with the
you expect with no errors third-party device.
in the Error column
All points show question The WebCTRL® application is not communicating with the
marks instead of values Automated Logic® controller or the control program.
Troubleshoot the controller's communications. See the
controller's Technical Instructions.
Some points show You may have exceeded the third-party points available in
question marks instead of the controller. If so, do one of the following:
values • Use a controller that provides more third-party points.
• Split the points between two control programs used in
separate controllers.
To determine the number of third-party points used in a
controller: On the WebCTRL® NET tree, click on the
controller's Driver, then scroll to the bottom of the page.
Number of integration points requested and Number of
integration points active show how many third-party
Network I/O microblocks the controller is using. These
counts will differ if you exceed the controller's integration
point limit. For example, if your LGR25's control program
includes 27 third-party points, your Integration points
requested will be 27 and your Integration points active will
be 25.
The point name is red Look in the Error column for one of the following error
codes and descriptions.
• 1 - Communications Disabled for this Microblock
Enable the microblock's Communications Enabled field
on the Network Points tab, on the microblock's
Properties page > Details tab, or in EIKON®
LogicBuilder.
• 3 - Address Error - Unknown Protocol Specified
Select the correct port on the Modbus driver page in
WebCTRL®, verify that Address in the microblock is
correct, or set the DIP switches correctly on the
controller.
• All other errors
On the WebCTRL® NET tree, expand the Automated
Logic® controller's driver, then select Protocols >
Modbus > Modbus Error Definitions. Find the error and
its possible solution.
If the above solutions do not resolve the problem, gather the following information for
technical support:
• A diagnostic capture using Wireshark. See the following section for Wireshark
instructions.
NOTE If directed by Tech Support, you can use PuTTY to get a diagnostic capture.
PuTTY instructions are after the Wireshark instructions.
• A screenshot of the driver's Protocols and Modbus TCP/IP pages.
• A screenshot of the Properties page > Network Points tab showing addresses and
errors
• All information from a Modstat copied into a text file.
Right-click the Modstat, then select Select All. Press Ctrl+C to copy the information,
then open Notepad and paste the information into a text file.
• Technical instructions for the third-party device, if available
PREREQUISITE Provide an Ethernet hub (not a switch) so that Wireshark can capture all
Ethernet communication, not just broadcasts.
9 Click the Start button next to the adapter that is connected to the network. This starts
the IP capture.
TIP Choose the adapter that shows the Packets value changing.
10 Allow the capture to run long enough to ensure that there is sufficient data to allow a
technician to review the problem.
11 On the menu bar, select Capture > Stop to stop the data capture.
12 Select File > Save and save the capture to a convenient location. Leave the Save as
type default set to Wireshark/tcpdump/… - libpcap (*.pcap, *.cap).
13 Send the file to Automated Logic® Technical Support for analysis.
TIP You can color code the information in the Wireshark capture file based on
user-defined criteria. See Wireshark's Help for instructions on setting up Coloring Rules.
PREREQUISITES
• Download and install PuTTY from the PuTTY website
([Link]
• Get the Automated Logic® controller's IP address.
• Get the longest microblock refresh time in the control program that has the error you
are troubleshooting. In WebCTRL®, view the control program's Properties page >
Network Points tab to see all the refresh times.
1 Connect your computer's Ethernet port to the controller's Ethernet port using one of
the following:
○ A CAT5 or higher Ethernet crossover cable
○ A hub and a CAT5 or higher Ethernet straight-through cable
2 Ping the Automated Logic® controller to verify communications between the
controller and the computer you are using to get this capture.
3 On the WebCTRL® NET tree, expand the Automated Logic® controller's driver, then
select Protocols.
4 Click Properties, select Enable Telnet diagnostics, then click OK.
Automated Logic®
Controllers LGR25 ME-LGR25
LGR250 ME-LGR200
LGR1000 ME812u-LGR
Driver Modbus Combo:
drv_melgr_mb_combo_<latest version>.driver
Read/write capability Can be read from and written to
Third party
Supported equipment Any device that supports the Modbus (Modicon)
protocol
Network media type Ethernet
Quantity of devices you can • Up to 3 Modbus client devices
connect to the Automated Logic® • One Modbus slave on EIA-232
controller • Up to 254 Modbus slaves on EIA-485
Before-you-begin You need the following items, information, and skills for the integration process:
checklist
A list of the points in the Automated Logic® controller that the Modbus client will
read or write to.
Verification that all communication properties have been set on the Modbus devices
Verification of Ethernet communication with each Modbus client that the Automated
Logic® controller will connect to
Experience creating control programs in the EIKON® LogicBuilder application
Experience installing, wiring, setting up, and downloading to the Automated Logic®
controller
The integration Follow the steps in this section to integrate an Automated Logic® controller into a
process Modbus system. To install and network the Automated Logic® controller, see the
controller's Technical Instructions.
CAUTION!
When integrating third-party devices into a WebCTRL® system, most communication
problems are caused by incorrect data or typing errors in the microblock's Address field.
Address format:
mtcpip://register type/modbus register address
Example: mtcpip://UINT/40128
For a this kind of exposed value in use this with this and a Modbus
third-party the Automated Logic® microblock... register type... register address in
device to... controller... this range...
Write 0 to 65,535 ANI Uint (not Unit) 400001–465535
Unsigned 16-bit integer
Holding register (4XXXXX)
–32,768 to +32,767 ANI Sint 400001–465535
Signed 16-bit integer
Holding register (4XXXXX)
Value with decimal point ANI Float 400001–465535
Holding register (4XXXXX)
0 or 1 BNI Do 1–65535
Coil
Discrete (binary) output
1 If the register addresses in the points list are 5-digit numbers in the range #0001-#9999 (where # = the prefix 1, 3,
or 4), you may use the addresses as they are, or change them to fit the formats in the table above by shifting the
prefix one digit to the left. For example, if you see the address 38129, you can also use 308129.
2 Each Float uses 2 consecutive Modbus register addresses. Use the lower number in the microblock address.
See Modbus Troubleshooting (page 38) for more information on register addresses.
8 Click .
9 In WebCTRL®, download the driver and control programs to the Automated Logic®
controller.
3 Connect the Use one of the following CAT5 or higher Ethernet cables:
Automated • A cross-over cable to connect the Automated Logic® controller directly to the
Logic® controller third-party Modbus device
to the third-party • A straight-through cable to connect the controller to a hub or switch, and a second
device straight-through cable to connect the hub or switch to the third-party Modbus device
Maximum cable length: 328 feet (100 meters)
4 Set up the 1 On the WebCTRL® NET tree, expand the Automated Logic® controller's driver.
Modbus Combo 2 Expand Protocols, then select Modbus TCP/IP.
driver properties 3 Under Port Configuration, select TCP/IP as the Communication Type.
4 The standard Modbus TCP Port is 502. If a different port is to be used, type the port
number. Select the Details checkbox for help.
5 Under Modbus Protocol Configuration, set This device is a Client to No.
6 On the NET tree, select Protocols.
7 In the Protocol Status table, verify that the mtcpip protocol shows Running on Port
E1.
If... Then...
You see the point value You have successfully exposed the Automated Logic®
you expect and the Error controller's value to the third-party device.
column shows Initializing
All points show question The WebCTRL® application is not communicating with the
marks instead of values Automated Logic® controller or the control program.
Troubleshoot the controller's communications. See the
controller's Technical Instructions.
Some points show You may have exceeded the third-party points available in
question marks instead of the controller. If so, do one of the following:
values • Use a controller that provides more third-party points.
• Split the points between two control programs used in
separate controllers.
To determine the number of third-party points used in a
controller: On the WebCTRL® NET tree, click on the
controller's Driver, then scroll to the bottom of the page.
Number of integration points requested and Number of
integration points active show how many third-party
Network I/O microblocks the controller is using. These
counts will differ if you exceed the controller's integration
point limit. For example, if your LGR25's control program
includes 27 third-party points, your Integration points
requested will be 27 and your Integration points active will
be 25.
The point name is red Look in the Error column for one of the following error
codes and descriptions.
• 1 - Communications Disabled for this Microblock
Enable the microblock's Communications Enabled field
on the Network Points tab, on the microblock's
Properties page > Details tab, or in EIKON®
LogicBuilder.
• 3 - Address Error - Unknown Protocol Specified
Select the correct port on the Modbus driver page in
WebCTRL®, verify that Address in the microblock is
correct, or set the DIP switches correctly on the
controller.
• All other errors
On the WebCTRL® NET tree, expand the Automated
Logic® controller's driver, then select Protocols >
Modbus > Modbus Error Definitions. Find the error and
its possible solution.
A value is incorrect Verify that the Address in the microblock is correct.
PREREQUISITE Provide an Ethernet hub (not a switch) so that Wireshark can capture all
Ethernet communication, not just broadcasts.
9 Click the Start button next to the adapter that is connected to the network. This starts
the IP capture.
TIP Choose the adapter that shows the Packets value changing.
10 Allow the capture to run long enough to ensure that there is sufficient data to allow a
technician to review the problem.
TIP You can color code the information in the Wireshark capture file based on
user-defined criteria. See Wireshark's Help for instructions on setting up Coloring Rules.
PREREQUISITES
• Download and install PuTTY from the PuTTY website
([Link]
• Get the Automated Logic® controller's IP address.
• Get the longest microblock refresh time in the control program that has the error you
are troubleshooting. In WebCTRL®, view the control program's Properties page >
Network Points tab to see all the refresh times.
1 Connect your computer's Ethernet port to the controller's Ethernet port using one of
the following:
○ A CAT5 or higher Ethernet crossover cable
○ A hub and a CAT5 or higher Ethernet straight-through cable
2 Ping the Automated Logic® controller to verify communications between the
controller and the computer you are using to get this capture.
3 On the WebCTRL® NET tree, expand the Automated Logic® controller's driver, then
select Protocols.
4 Click Properties, select Enable Telnet diagnostics, then click OK.
5 Start PuTTY.
6 Enter the controller's IP address.
7 Select Telnet as the Connection Type.
8 Click the Logging option in the upper left corner of the left pane.
9 Select Printable output.
10 Select a location for the capture text file.
11 Click Open to start the session.
12 After Login:>, type: diagport
Press Enter.
13 To capture data receipts, after diagport>, type: mtcpip rx
Press Enter.
14 To capture data transmissions, after diagport>, type: mtcpip tx
Press Enter.
Base address
Most manufacturers begin counting register addresses at 1; some begin at 0. Other than
contacting the manufacturer to get clarification, you can look at the register address list to
see if the addressing in any table starts at 0. If any table's addressing begins at 0, you
need to add 1 to each register address in order to read the right register. For example, if
you are given a register address of 40100, you must enter the address as 40101 to read
the correct register.
Prefix
Some manufacturers include the prefix in their register address. If you add another prefix,
you will have an invalid register address. For example, if the third-party manufacturer
shows a holding register address is 40123 and you add the prefix 4, your register address
will be 440123, which is an invalid address.
or
Prefix
Some manufacturers include the prefix in their register address. If you add another prefix,
you will have an invalid register address. For example, if the third-party manufacturer
shows a holding register address is 40123 and you add the prefix 4, your register address
will be 440123, which is an invalid address.
Errors
If the Properties page > Network Points tab shows errors, look for the error in the table
below. To see a more extensive list, go to the NET tree > the controller > Driver >
Protocols > Modbus Error Definitions.
or
CAUTION If you want to upgrade a system to the Modbus Combo driver, carefully
read the section below to determine if you should upgrade the driver.
b) Go back to the WebCTRL NET tree > Properties page and check for other errors.
Again, see "Troubleshooting" in the Modbus Integration Guide to resolve errors.
Serial connection:
Modes RTU1
ASCII
Media type EIA-232
EIA-485, 2-wire1
EIA-485, 4-wire
Baud rate 1200 96001
2400 192001
4800 384001
Data bits 7
81
Parity None1
Odd
Even
Stop bits 11
2
1 Most commonly used value(s)
Ethernet connection: