Schneider Electric Quantum using EcoStruxure™ Control Expert - 140NOC77101 Ethernet Communication Module User Manual
விளம்பரம்
விளம்பரம்
Quantum using EcoStruxure™ Control Expert
S1A33985 12/2018
Quantum using
EcoStruxure™
Control Expert
140 NOC 771 01
Ethernet Communication Module
User Manual
(Original Document)
12/2018 www.schneider-electric.com
2
The information provided in this documentation contains general descriptions and/or technical characteristics of the performance of the products contained herein. This documentation is not intended as a substitute for and is not to be used for determining suitability or reliability of these products for specific user applications. It is the duty of any such user or integrator to perform the appropriate and complete risk analysis, evaluation and testing of the products with respect to the relevant specific application or use thereof. Neither Schneider Electric nor any of its affiliates or subsidiaries shall be responsible or liable for misuse of the information contained herein. If you have any suggestions for improvements or amendments or have found errors in this publication, please notify us.
You agree not to reproduce, other than for your own personal, noncommercial use, all or part of this document on any medium whatsoever without permission of Schneider Electric, given in writing. You also agree not to establish any hypertext links to this document or its content.
Schneider Electric does not grant any right or license for the personal and noncommercial use of the document or its content, except for a non-exclusive license to consult it on an "as is" basis, at your own risk. All other rights are reserved.
All pertinent state, regional, and local safety regulations must be observed when installing and using this product. For reasons of safety and to help ensure compliance with documented system data, only the manufacturer should perform repairs to components.
When devices are used for applications with technical safety requirements, the relevant instructions must be followed.
Failure to use Schneider Electric software or approved software with our hardware products may result in injury, harm, or improper operating results.
Failure to observe this information can result in injury or equipment damage.
© 2018 Schneider Electric. All rights reserved.
S1A33985 12/2018
Table of Contents
Safety Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1 Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Hardware Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Module Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Communication Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing Control Expert Ethernet Configuration Tool Software . . . . .
Uninstalling the Ethernet Configuration Tool . . . . . . . . . . . . . . . . . . . .
Chapter 2 Configuring the Ethernet Communication Module . . . . .
2.1 Ethernet Network Configuration Example . . . . . . . . . . . . . . . . . . . . . .
The Ethernet Network Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.2 Creating a Project in Control Expert . . . . . . . . . . . . . . . . . . . . . . . . . .
Creating a Project in Control Expert . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the Size and Location of Inputs and Outputs . . . . . . . . . .
2.3 The Control Expert FDT/DTM Interface. . . . . . . . . . . . . . . . . . . . . . . .
DTM Browser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTM Browser Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field Bus Discovery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Device Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring Properties in the Device Editor. . . . . . . . . . . . . . . . . . . . .
Uploading and Downloading DTM-Based Applications . . . . . . . . . . . .
2.4 Channel Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Channel Properties Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Channel Properties - Ethernet Page . . . . . . . . . . . . . . . . . . . . . . . . . .
Channel Properties - TCP/IP Page . . . . . . . . . . . . . . . . . . . . . . . . . . .
Channel Properties - EtherNet/IP Page. . . . . . . . . . . . . . . . . . . . . . . .
2.5 Ethernet Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enabling Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the DHCP and FDR Servers . . . . . . . . . . . . . . . . . . . . . .
Configuring the SNMP Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring QoS Ethernet Packet Tagging . . . . . . . . . . . . . . . . . . . . .
69
74
77
80
62
64
66
67
56
58
59
61
42
48
52
54
31
36
38
39
27
28
28
30
19
21
23
25
9
13
15
16
S1A33985 12/2018
3
4
2.6 Configuring the Ethernet Communication Module as an EtherNet/IP
Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introducing the Local Slave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring a Local Slave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Local Slave Inputs and Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 3 Adding Devices to an Ethernet Network. . . . . . . . . . . . . .
3.1 Hardware Catalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adding a DTM to the Control Expert Hardware Catalog . . . . . . . . . . .
Add an EDS File to the Control Expert Hardware Catalog. . . . . . . . . .
Updating the Control Expert Hardware Catalog. . . . . . . . . . . . . . . . . .
Remove an EDS File from the Control Expert Hardware Catalog . . . .
3.2 Adding an EtherNet/IP Device to the Network . . . . . . . . . . . . . . . . . . .
Setting Up Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adding an STB NIC 2212 Remote Device . . . . . . . . . . . . . . . . . . . . . .
Configuring STB NIC 2212 Properties . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring EtherNet/IP Connections . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting to the Advantys STB Island. . . . . . . . . . . . . . . . . . . . . . . .
Configuring I/O Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.3 Adding a Modbus TCP Device to the Network. . . . . . . . . . . . . . . . . . .
Setting Up Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adding an STB NIP 2212 Remote Device . . . . . . . . . . . . . . . . . . . . . .
Configuring STB NIP 2212 Properties . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting to the Advantys STB Island. . . . . . . . . . . . . . . . . . . . . . . .
103
105
107
108
110
112
117
123
97
98
99
100
82
83
85
90
127
140
141
143
145
152
Configuring I/O Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
156
Chapter 4 Working With Derived Data Types . . . . . . . . . . . . . . . . . .
165
Creating and Updating Derived Data Types . . . . . . . . . . . . . . . . . . . .
Working with Derived Data Type Variables . . . . . . . . . . . . . . . . . . . . .
166
168
Effect of Activating and De-activating Devices on I/O %MW Memory
Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5.1 Selecting a Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
177
Chapter 5 Optimizing Performance. . . . . . . . . . . . . . . . . . . . . . . . . .
181
Role of a Switch in an Ethernet Network . . . . . . . . . . . . . . . . . . . . . . .
Transmission Speed, Duplex and Auto-Negotiation . . . . . . . . . . . . . .
Quality of Service (QoS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
182
183
184
185
IGMP Snooping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rapid Spanning Tree Protocol (RSTP) . . . . . . . . . . . . . . . . . . . . . . . .
Virtual Local Area Network (VLAN) . . . . . . . . . . . . . . . . . . . . . . . . . . .
Port Mirroring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Simple Network Management Protocol (SNMP) Agent . . . . . . . . . . . .
186
187
188
190
191
S1A33985 12/2018
5.2 Control Application Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Message Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Message Connection Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TCP and CIP Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Message Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Messaging Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Message Frequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Allocating Network Bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Estimating Message Traverse and Response Times . . . . . . . . . . . . .
5.3 Projecting Ethernet Network Performance . . . . . . . . . . . . . . . . . . . . .
Network Load and Bandwidth Calculation Example . . . . . . . . . . . . . .
Chapter 6 CIP Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Identity Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Assembly Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connection Manager Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modbus Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Quality Of Service (QoS) Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TCP/IP Interface Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet Link Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EtherNet/IP Interface Diagnostics Object . . . . . . . . . . . . . . . . . . . . . .
EtherNet/IP IO Scanner Diagnostics Object . . . . . . . . . . . . . . . . . . . .
IO Connection Diagnostics Object. . . . . . . . . . . . . . . . . . . . . . . . . . . .
EtherNet/IP Explicit Connection Diagnostics Object . . . . . . . . . . . . . .
EtherNet/IP Explicit Connection Diagnostics List Object. . . . . . . . . . .
Chapter 7 Online Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Accessing CIP Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing Port Configuration Properties for Remote EtherNet/IP Devices
Pinging a Network Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Viewing and Editing Online Settings for a Remote Device . . . . . . . . .
Chapter 8 Explicit Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8.1 Explicit Messaging Using the MBP_MSTR Block . . . . . . . . . . . . . . . .
Configuring Explicit Messaging Using MBP_MSTR . . . . . . . . . . . . . .
8.2 EtherNet/IP Explicit Messaging Using MBP_MSTR . . . . . . . . . . . . . .
EtherNet/IP Explicit Messaging Services . . . . . . . . . . . . . . . . . . . . . .
Configuring the CONTROL and DATABUF Parameters . . . . . . . . . . .
MBP_MSTR Example: Get_Attributes_Single . . . . . . . . . . . . . . . . . . .
MBP_MSTR Example – Read Modbus Object . . . . . . . . . . . . . . . . . .
MBP_MSTR Example – Write Modbus Object . . . . . . . . . . . . . . . . . .
S1A33985 12/2018
245
246
248
250
252
255
256
256
222
224
226
231
234
236
240
242
258
259
261
264
269
274
204
206
206
211
213
215
217
220
192
193
195
197
198
199
200
202
5
6
8.3 Modbus TCP Explicit Messaging Using MBP_MSTR . . . . . . . . . . . . .
Modbus TCP Explicit Messaging Function Codes . . . . . . . . . . . . . . . .
Configuring the Control Parameter for Modbus TCP Explicit Messaging
280
281
282
289
8.4 Explicit Messaging via the Control Expert GUI . . . . . . . . . . . . . . . . . .
Sending Explicit Messages to EtherNet/IP Devices. . . . . . . . . . . . . . .
Sending Explicit Messages to Modbus TCP Devices . . . . . . . . . . . . .
Chapter 9 Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
295
9.1 Module Hardware Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
290
293
LED Indicators for the Ethernet Communication Module . . . . . . . . . . .
9.2 Control Expert Software Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the Diagnostic Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet Port Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Bandwidth Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Local Slave / Connection Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . .
Local Slave or Connection I/O Value Diagnostics . . . . . . . . . . . . . . . .
Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
313
Chapter 10 Replacing the Ethernet Communication Module . . . . . . .
315
Replacing the Ethernet Communication Module . . . . . . . . . . . . . . . . .
315
Chapter 11 Embedded Web Pages . . . . . . . . . . . . . . . . . . . . . . . . . .
317
11.1 Accessing the Embedded Web Server . . . . . . . . . . . . . . . . . . . . . . . .
Introducing the Embedded Web Pages . . . . . . . . . . . . . . . . . . . . . . . .
Accessing the Home Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using and Editing a Username and Passwords. . . . . . . . . . . . . . . . . .
318
319
320
321
11.2 Monitoring the Control Expert Application . . . . . . . . . . . . . . . . . . . . . .
Using the Monitoring Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data Editor (Standard) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working With Data Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data Editor (Lite) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11.3 Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the Diagnostics Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Status Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rack Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Processor Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Scanner Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QoS Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
296
296
298
299
301
304
307
311
340
341
344
346
348
350
351
324
325
326
331
335
336
337
338
S1A33985 12/2018
Appendices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
353
Appendix A Detected Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .
TCP/IP Ethernet Detected Error Codes. . . . . . . . . . . . . . . . . . . . . . . .
Modbus TCP Explicit Messaging Detected Error Codes . . . . . . . . . . .
EtherNet/IP Implicit or Explicit Messaging Detected Error Codes . . . .
Appendix B CIP General Status Codes . . . . . . . . . . . . . . . . . . . . . . .
CIP General Status Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
355
356
357
358
361
361
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
365
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
367
S1A33985 12/2018
7
8
S1A33985 12/2018
Safety Information
Important Information
NOTICE
Read these instructions carefully, and look at the equipment to become familiar with the device before trying to install, operate, service, or maintain it. The following special messages may appear throughout this documentation or on the equipment to warn of potential hazards or to call attention to information that clarifies or simplifies a procedure.
S1A33985 12/2018
9
PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by qualified personnel. No responsibility is assumed by Schneider Electric for any consequences arising out of the use of this material.
A qualified person is one who has skills and knowledge related to the construction and operation of electrical equipment and its installation, and has received safety training to recognize and avoid the hazards involved.
BEFORE YOU BEGIN
Do not use this product on machinery lacking effective point-of-operation guarding. Lack of effective point-of-operation guarding on a machine can result in serious injury to the operator of that machine.
WARNING
UNGUARDED EQUIPMENT
Do not use this software and related automation equipment on equipment which does not have point-of-operation protection.
Do not reach into machinery during operation.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
10
This automation equipment and related software is used to control a variety of industrial processes.
The type or model of automation equipment suitable for each application will vary depending on factors such as the control function required, degree of protection required, production methods, unusual conditions, government regulations, etc. In some applications, more than one processor may be required, as when backup redundancy is needed.
Only you, the user, machine builder or system integrator can be aware of all the conditions and factors present during setup, operation, and maintenance of the machine and, therefore, can determine the automation equipment and the related safeties and interlocks which can be properly used. When selecting automation and control equipment and related software for a particular application, you should refer to the applicable local and national standards and regulations. The
National Safety Council's Accident Prevention Manual (nationally recognized in the United States of America) also provides much useful information.
In some applications, such as packaging machinery, additional operator protection such as pointof-operation guarding must be provided. This is necessary if the operator's hands and other parts of the body are free to enter the pinch points or other hazardous areas and serious injury can occur.
Software products alone cannot protect an operator from injury. For this reason the software cannot be substituted for or take the place of point-of-operation protection.
Ensure that appropriate safeties and mechanical/electrical interlocks related to point-of-operation protection have been installed and are operational before placing the equipment into service. All interlocks and safeties related to point-of-operation protection must be coordinated with the related automation equipment and software programming.
S1A33985 12/2018
NOTE: Coordination of safeties and mechanical/electrical interlocks for point-of-operation protection is outside the scope of the Function Block Library, System User Guide, or other implementation referenced in this documentation.
START-UP AND TEST
Before using electrical control and automation equipment for regular operation after installation, the system should be given a start-up test by qualified personnel to verify correct operation of the equipment. It is important that arrangements for such a check be made and that enough time is allowed to perform complete and satisfactory testing.
WARNING
EQUIPMENT OPERATION HAZARD
Verify that all installation and set up procedures have been completed.
Before operational tests are performed, remove all blocks or other temporary holding means used for shipment from all component devices.
Remove tools, meters, and debris from equipment.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
Follow all start-up tests recommended in the equipment documentation. Store all equipment documentation for future references.
Software testing must be done in both simulated and real environments.
Verify that the completed system is free from all short circuits and temporary grounds that are not installed according to local regulations (according to the National Electrical Code in the U.S.A, for instance). If high-potential voltage testing is necessary, follow recommendations in equipment documentation to prevent accidental equipment damage.
Before energizing equipment:
Remove tools, meters, and debris from equipment.
Close the equipment enclosure door.
Remove all temporary grounds from incoming power lines.
Perform all start-up tests recommended by the manufacturer.
S1A33985 12/2018
11
OPERATION AND ADJUSTMENTS
The following precautions are from the NEMA Standards Publication ICS 7.1-1995 (English version prevails):
Regardless of the care exercised in the design and manufacture of equipment or in the selection and ratings of components, there are hazards that can be encountered if such equipment is
improperly operated.
It is sometimes possible to misadjust the equipment and thus produce unsatisfactory or unsafe operation. Always use the manufacturer’s instructions as a guide for functional adjustments.
Personnel who have access to these adjustments should be familiar with the equipment manufacturer’s instructions and the machinery used with the electrical equipment.
Only those operational adjustments actually required by the operator should be accessible to the operator. Access to other controls should be restricted to prevent unauthorized changes in operating characteristics.
12
S1A33985 12/2018
About the Book
At a Glance
Document Scope
This manual describes the use of the Quantum 140 NOC 771 01 Ethernet communication module.
This manual describes the creation of a complete configuration. The features and functions of the module are explained in the course of constructing this configuration.
Use the specific configuration settings contained in this manual for instructional purposes only. The settings required for your specific configuration differ from the example presented in this manual.
Validity Note
This documentation is valid for EcoStruxure™ Control Expert 14.0 or later.
Related Documents
For additional information, refer to the online help files for the EcoStruxure™ Control Expert software, and to the following technical publications:
Title of Documentation
Advantys STB EtherNet/IP Network Interface Applications Guide
Reference Number
31008204
You can download these technical publications and other technical information from our website at https://www.schneider-electric.com/en/download
S1A33985 12/2018
13
14
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Installation
S1A33985 12/2018
Installation Chapter 1
Installation
Overview
The Ethernet communication module serves as the interface between a Quantum PLC and other
Ethernet network devices by means of either the EtherNet/IP or the Modbus TCP communication protocol. This chapter shows you how to install the module by:
inserting it into a PLC backplane connecting it to an Ethernet network installing the Control Expert Ethernet Configuration Tool software
What Is in This Chapter?
This chapter contains the following topics:
Topic
Hardware Installation
Module Specifications
Communication Specifications
Installing Control Expert Ethernet Configuration Tool Software
Uninstalling the Ethernet Configuration Tool
Page
S1A33985 12/2018
15
Installation
Hardware Installation
Overview
The following information describes how to install the 140 NOC 771 01 Ethernet communication module.
External Features
16
S1A33985 12/2018
Installation
LEDs
The Ethernet communication module presents the following LED indicators:
Active
Module Status
Network Status
Ready
Link
Activity
100 Mb link
Full Duplex
For a description of these LEDs, and how to use them to diagnose the module, refer to the topic
LED Indicators for the Ethernet Communication Module
see page 296
Locating a Backplane Slot
The Ethernet communication module operates on a Quantum PLC station. It can be installed in any available position in the PLC backplane.
Selecting a Power Supply
When configuring the PLC station, add a power supply module that is capable of supplying power to modules on the rack.
Tools Required
One medium-sized (size 2) Phillips-head screw driver.
S1A33985 12/2018
17
Installation
Mounting the Module in the Backplane
Step
1
Action
Holding the module at an angle, mount it on the two hooks located near the top of the backplane.
The following figure shows the correct way to hold the module.
2
3
Swing the module down so the connector engages the backplane connector.
Use a Phillips-head screw driver to tighten the screw at the bottom of the module from 2 through 4 in-lbs or from .22 through .45 Newton meters of torque.
Wiring the Ethernet Connector
WARNING
HAZARD OF ELECTRICAL SHOCK OR BURN
Connect the ground wire to the protective ground (PE) terminal before you establish any further connections. When you remove connections, disconnect the ground wire last. Connect the
Ethernet cable shield to PE ground at the Ethernet switch.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
The Ethernet communication module communicates over an Ethernet network through a single
RJ45 connector located at the bottom of the module.
18
S1A33985 12/2018
Installation
Module Specifications
Specifications
140 NOC 771 01 specifications include:
Ports
Communication Ports One auto-sensing 10/100Base-T shielded twisted pair (RJ-45 connector) port.
Electrical
Bus Current Required @5V: 400 mA
Power Dissipation
Fuse
Operating Conditions
Temperature
2 W
None
Humidity
Altitude
Storage Conditions
Temperature
0...+60° C
0...95% Rh non-condensing @ 60°C
2000 m (6561.68 ft)
Humidity
Altitude
–40...+85°C
0...95% Rh non-condensing @ 60°C
3000 m (9842.52 ft) transport
Software Compatibility
The Ethernet communication module is compatible with Unity Pro programming software version
5.0 and later.
Standards
The Ethernet communication module complies with the following standards:
UL 508
CSA 22.2-142
CE
EMI EN55011
EN61131-2
FM 3611 Class 1 Div2 Groups ABCD
IEC61131-2
IEEE 802.3 2002
ODVA
S1A33985 12/2018
19
Installation
Communication Modules per Rack
The maximum number of communication modules—including but not limited to 140 NOC 771 01
Ethernet communication modules—you can install in a single rack is determined by the CPU serving that rack:
CPU
140 CPU 311 10
140 CPU 434 12A
140 CPU 534 14A
140 CPU 651 50
140 CPU 651 60
140 CPU 652 60
6
6
6
6
6
Maximum Number of Communication Modules per Rack
2
NOTE: The 140 NOC 771 01 cannot be placed in a Hot Standby rack.
20
S1A33985 12/2018
Installation
Communication Specifications
Introduction
The following specifications describe both the I/O communication and the explicit messaging capacities of the 140 NOC 771 01.
I/O Communication Specifications
The Ethernet communication module presents the following I/O communication features:
Communication type
EtherNet/IP
(CIP Implicit Messaging)
Modbus TCP
(Modbus Scanner)
Feature
Scanner
Maximum number of devices
Capacity
128 devices (125 devices as scanner + 3 devices as adapter) shared with Modbus TCP
Maximum message size 512 bytes
Adapter
Maximum number of instances 3 adapter instances
Maximum number of connections 2 connections per instance
Maximum message size
Inputs
Outputs
511 bytes including header
505 bytes excluding header
509 bytes excluding header
Maximum number of registers
Read
Write
Maximum number of devices
Maximum message size
Read
Write
125 registers
120 registers
128 devices shared with EtherNet/IP
250 bytes (125 words) excluding header
240 bytes (120 words) excluding header
S1A33985 12/2018
21
Installation
Explicit Messaging Specifications
The Ethernet communication module presents the following explicit messaging features:
Communication type
EtherNet/IP
(CIP Explicit Messaging)
Modbus TCP
(Modbus Scanner)
Feature
Client
Maximum number of simultaneous connections
Maximum number of concurrent requests
Server
Maximum number of simultaneous connections
Maximum messaging size
Client
Maximum number of simultaneous connections
Maximum number of concurrent requests
Server
Maximum number of simultaneous requests
Maximum number of simultaneous connections
Maximum message size
Read
Write
Capacity
16 connections
16 requests, shared with Modbus TCP
32 connections
1023 bytes
16 connections
16 requests, shared with EtherNet/IP
128 requests
32 connections
250 bytes (125 words) excluding header
240 bytes (120 words) excluding header
22
S1A33985 12/2018
Installation
Installing Control Expert Ethernet Configuration Tool Software
Overview
Accessing Control Expert Configuration Tool Software depends on the software version you are using:
Unity Pro version 6.0 and higher: The module configuration software is already included in the software installation.
Unity Pro version 5.0: You need to install the Ethernet Configuration Tool software, which you can obtain from the following website: http://www.global-download.schneiderelectric.com/8525773E00058BDC/all/DA00A87B8BB30386852577940058D66C
NOTE:
Installing Ethernet Configuration Tool Software for Unity Pro Version 5.0
To install this software, navigate to navigate to the root of the installation files and run the file
Setup.exe.
The setup process displays the following setup screens:
3
4
5
6
7
8
Step
1
2
9
Screen
Welcome
ReadMe and
Release Notes Display
ReadMe
License Agreement
Customer Information
Destination Folder
Ready to Install
Status
Install Complete
Description
Click Next to continue.
Indicate whether to display the ReadMe file.
Click Next to continue.
(Optional) Displays the ReadMe file, if selected above.
Click Next to continue.
Displays the software license.
Select I accept..., then click Next to continue.
Enter the following data:
your first and last names
company name identify for whom the software is installed:
anyone who uses this computer only for yourself
Click Next to continue.
Identify where the application will be installed. Either:
Accept the default path
Click Change... and specify a new path
Click Next to continue.
Click Next to continue.
Progress bar indicates the status of the installation.
When complete, click Next to continue.
Click Finish.
S1A33985 12/2018
23
Installation
The installation process described above copies the following objects to your PC:
the Ethernet Configuration Tool
a Generic EtherNet/IP DTM a Generic Modbus TCP DTM
NOTE: A DTM is a small software driver that defines and enables a device.
Updating Hardware Catalog
For installations of Unity Pro version 5.0 and higher, the next step is to update the
Hardware Catalog. Updating the Hardware Catalog adds your new Ethernet communication module to the list of available modules and devices that you can add to your application.
Refer to the topic Updating the Control Expert Hardware Catalog instructions.
see page 103
24
S1A33985 12/2018
Installation
Uninstalling the Ethernet Configuration Tool
Introduction
Use the Add or Remove Programs utility provided by the Windows™ operating system to uninstall the Ethernet Configuration Tool.
To completely uninstall the Ethernet Configuration Tool, remove each of the following three DTMs, one at a time:
Uninstalling the Ethernet Configuration Tool DTMs
To remove the three Ethernet Configuration Tool DTMs:
Step
1
2
3
4
5
Action
Open the Windows Control Panel: Start → Settings → Control Panel.
In the Control Panel, double click on Add or Remove Programs.
In the Add or Remove Programs window, select the Change or Remove Programs page.
Select the first of the three DTMs to remove (for example, the Generic EtherNet/IP DTM), then click
Remove.
Repeat step 4 for each of the remaining 2 DTMs: Generic Modbus DTM and
Control Expert Ethernet Configuration Tool.
S1A33985 12/2018
25
Installation
26
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Configuring
S1A33985 12/2018
Configuring the Ethernet Communication Module Chapter 2
Configuring the Ethernet Communication Module
Overview
This chapter shows you how to use Control Expert programming software to select and configure the Ethernet communication module.
NOTE: The instructions presented in this chapter include specific choices made for a sample project. Your project may include different choices that are appropriate for your specific configuration.
What Is in This Chapter?
This chapter contains the following sections:
2.4
2.5
2.6
Section
2.1
2.2
2.3
Topic
Ethernet Network Configuration Example
Creating a Project in Control Expert
The Control Expert FDT/DTM Interface
Channel Properties
Ethernet Services
Configuring the Ethernet Communication Module as an EtherNet/IP Adapter
Page
S1A33985 12/2018
27
Configuring
Ethernet Network Configuration Example Section 2.1
Ethernet Network Configuration Example
The Ethernet Network Example
The Ethernet Network
This manual describes the creation of a complete Ethernet network configuration for the following topology:
28
1 Primary PLC incorporating the 140 NOC 771 01 Ethernet communication module
2 PC equipped with both Control Expert configuration software (upgraded with the Ethernet Configuration
Tool that ships with the 140 NOC 771 01 Ethernet communication module), and Advantys configuration software, used to configure communication settings for Ethernet communication module in the PLC (1) and the remote network interface modules on the STB I/O islands (4 and 5, below)
3 Ethernet managed switch
4 Advantys STB island, with an STB NIC 2212 EtherNet/IP network interface module plus 8 I/O modules
5 Advantys STB island, with an STB NIP 2212 Modbus TCP network interface module plus 8 I/O modules
6 Third-party PLC that scans a local slave in the primary PLC
7 A secondary PLC that “listens” to the scan of the primary PLC local slave by the third-party scanner
S1A33985 12/2018
Configuring
Multiple Roles of the PLC and Ethernet Communication Module
The PLC, and in particular the 140 NOC 771 01 Ethernet communication module, can be configured to simultaneously perform multiple roles with respect to other network devices. In this sample network, you will learn how to configure the communication module to operate as:
a scanner of devices that use the EtherNet/IP (4) and the Modbus TCP (5) protocols
an adapter—also known as a local slave—that produces output data that both the remote thirdparty PLC (6) and secondary PLC (7) can read as input data a DHCP server that provides IP address settings to other devices on the Ethernet network an FDR server that provides operational settings to the devices on the Ethernet network that also receive their IP addresses from the DHCP server, above
S1A33985 12/2018
29
Configuring
Creating a Project in Control Expert Section 2.2
Creating a Project in Control Expert
Overview
This section shows you how to add modules—including the 140 NOC 771 01 Ethernet communication module—to your project, using Control Expert.
What Is in This Section?
This section contains the following topics:
Topic
Creating a Project in Control Expert
Configuring the Size and Location of Inputs and Outputs
Page
30
S1A33985 12/2018
Configuring
Creating a Project in Control Expert
Introduction
This topic shows you how to create a new Control Expert project, and add to the new project the following components:
a CPU a power supply a 140 NOC 771 01 Ethernet communication module
Creating and Saving a New Expert Project
The following steps describe the creation of a project for the sample network:
Step
1
2
3
Action
Open Control Expert.
In the Control Expert main menu, select File → New....
The New Project window opens displaying a list of Schneider-Electric controller types.
In the New Project window, expand the Quantum node and select a CPU. In this example, select the 140 CPU 651 60 controller:
4 Click OK. Control Expert displays the Project Browser, below.
5 To save the project, select File → Save. The Save As dialog opens.
S1A33985 12/2018
31
Configuring
Step
6
Action
In the Save As dialog, type in a File name—which will be the name of your Control Expert project—then click Save. Control Expert saves your project to the specified path location.
NOTE: You can change the default location Control Expert uses to store project files. Before saving your project:
1 Select Tools → Options. The Options Management window opens.
2 In the left pane, navigate to Options → General → Paths.
3 In the right pane, type in a new path location for the Project path. You can also edit the:
Import/Export file path
XVM path
Project settings templates path
4 Click OK close the window and save your path edits.
Adding a Power Supply to the New Control Expert Project
The next step is to add a power supply to your Control Expert project:
Step
7
Action
In the Project Browser, double click Local Bus. Control Expert displays both the:
Local Bus window with the selected CPU in the second position, and
Hardware catalog displaying the Local Bus tab, below:
32
S1A33985 12/2018
Step
8
Configuring
Action
In the Hardware catalog, under the Supply node, use your mouse to select then drag a
140 CPS 114 X0 115/230 VAC power supply to a position in the rack—in this example, slot 1.
9 In the File menu, select Save, to save your edits.
NOTE: Schneider-Electric recommends that you periodically save your changes as you make edits.
S1A33985 12/2018
33
Configuring
Adding an Ethernet Communication Module to the New Control Expert Project
Next, add an Ethernet communication module to your project:
Step
10
11
Action
Returning to the Hardware catalog, under the Communication node, use your mouse to select then drag a 140 NOC 771 01 communication module to an open slot in the rack—in this example, slot 4.
When you drop the communication module into the rack, Control Expert opens the communication module Properties window.
In the General page of the module properties window, type in an alias name for the communication module: NOC01:
34
12
When you change the alias name, Control Expert changes the base input and output type and variable names to match the edited alias name.
NOTE: Schneider Electric recommends that you assign a unique alias name to each communication module. This practice helps you distinguish between modules of the same type.
In the File menu, select Save, to save your edits.
S1A33985 12/2018
Step
13
Configuring
Action
Click OK to close the Properties window. The Local Bus now displays the three modules you have added:
14 The next step is to configure the located memory space in the CPU for the communication module’s inputs and outputs
.
S1A33985 12/2018
35
Configuring
Configuring the Size and Location of Inputs and Outputs
Overview
Use the Configuration page of the Ethernet communication module’s Properties window to configure:
the size and starting position of inputs the size and starting position of outputs
The following steps present one example of how to configure the size and location of inputs and outputs. Your own project configuration may differ.
Setting Input and Output Memory Addresses and Naming the Module
The Properties window opens when you double-click the left mouse button on the image of the
140 NOC 771 01 communication module in either the Local Bus window, or the Project Browser.
When you select the Configuration page, it displays the network—or Alias—name. This is the name assigned to the network channel when the communication module was added to the project.
Use the Configuration page to edit the communication module inputs and outputs, as follows:
36
S1A33985 12/2018
Configuring
To input the above settings, take the following steps:
Step
1
2
3
Action
In the module’s Properties window, select the Configuration page.
Type in the size and starting position of the inputs and outputs, as follows:
In the Inputs area:
In the %MW index field, type in a starting address for inputs—in this example: 1.
In the Max size field, type in the maximum number of 16-bit words dedicated to inputs—in this example:100.
In the Outputs area:
In the %MW index field, type in a starting address for outputs—in this example: 101.
In the Max size field, type in the maximum number of 16-bit words dedicated to outputs—in this example: 100.
Notes:
The inputs and outputs can be located at any available address. Allocate separate, non-
overlapping space to inputs and outputs.
Control Expert automatically reserves space for two arrays of 32 bytes, as follows:
for inputs
configured for outputs
, located at the beginning of the space configured
, located at the beginning of the space
Confirm that the %MW range you assign to both inputs and outputs is available in the CPU.
For more information, refer to the Control Expert help file topic Processor Configuration
Screen.
In Control Expert select Edit → Validate (or click the Validate button) to save the address and size settings for inputs and outputs.
NOTE: After you validate module settings for the first time, the module name cannot be edited.
If you subsequently decide to change the module name, delete the existing module from the configuration, then add and rename a replacement module.
Completing the Ethernet Network Configuration
After configuring settings for inputs and outputs, the next step is to configure the communication module settings—beginning with its Channel Properties—and then configure remote Ethernet network devices
see page 97
NOTE: After you input configuration settings for the communication module and remote devices, return to the Configuration page of the Ethernet communication module’s Properties window and click the Update application button. This creates derived data type (DDT) variables that display the following information and commands for your Control Expert project:
connection health bits, that display the status of each connection connection control bits, you can use to toggle each connection on and off the value of input and output items module and device configuration settings free memory space that has been reserved, but not yet allocated
see page 166
S1A33985 12/2018
37
Configuring
The Control Expert FDT/DTM Interface Section 2.3
The Control Expert FDT/DTM Interface
Overview
The section describes the use of DTMs within Control Expert.
What Is in This Section?
This section contains the following topics:
Topic
DTM Browser
DTM Browser Menu Commands
Field Bus Discovery Service
Device Editor
Configuring Properties in the Device Editor
Uploading and Downloading DTM-Based Applications
Page
38
S1A33985 12/2018
Configuring
DTM Browser
Overview
The DTM Browser displays a hierarchical list of DTMs—in the form of nodes on a connectivity tree—that have been added to your Control Expert project. Each DTM node represents an actual module or device in your Ethernet network.
Node Types
There are 3 types of DTM nodes:
Communication DTMs:
Any COM DTM can be plugged directly under the root node (Host PC) at the 1st level
A COM DTM can support Gateway DTMs or Device DTMs as children if their protocols are compatible
Gateway DTMs:
A Gateway DTM can support other Gateway DTMs or Device DTMs as children if their protocols are compatible.
Device DTMs:
A Device DTM does not support any child DTMs
S1A33985 12/2018
39
Configuring
Node Names
Each DTM has a default name when inserted into the browser. The default name consists of the following elements:
<Channel: Address> Device Name
Where:
Element channel address
Description
This is the name of the channel communication media, to which the device is plugged in. This name is read from the DTM and is set by the device vendor.
Example: EtherNet/IP, Modbus
The bus address of the device, which can be:
The connection point on its parent gateway network
The slot number in the modular device parent internal bus
Example: the device IP address device name The default name is determined by the vendor in the device DTM, but can be edited by the user.
Node Status
The DTM Browser displays the status of each DTM node in the connectivity tree, as follows:.
Status
Built / Not-built
Connected /
Disconnected
Installed / Notinstalled
Description
A blue check mark superimposed on a device icon indicates that node, or one of its sub-nodes, is not built. This means that some property of the node has changed, and the information stored in the physical device is no longer consistent with the local project.
A connected DTM is denoted in bold text. An unconnected DTM appears in plain text.
NOTE:
Connecting a DTM to its physical device automatically connects higher level parent nodes up to the root node.
Disconnecting a DTM from its physical device automatically disconnects its lower level child nodes.
NOTE: Connecting or disconnecting a DTM to or from its device does not also connect or disconnect Control Expert to or from the PLC. DTMs can be connected/disconnected while Control Expert is either offline or online.
A red superimposed on a device icon indicates the DTM for that device is not installed on the PC.
40
S1A33985 12/2018
Configuring
Handling Invalid Nodes
As indicated above, a red superimposed on a node indicates the DTM for that node is not installed on the PC. To resolve this situation, click the right mouse button on the node to open a pop-up menu with the following two commands:
Command
Delete
Properties
Description
Removes the selected node (and its sub-nodes) from the DTM Browser.
Opens the following dialog, which you can use to identify the name of the missing DTM:
S1A33985 12/2018
41
Configuring
DTM Browser Menu Commands
Overview
The DTM Browser includes a pop-up, contextual (right-click) menu that displays commands for the currently selected DTM. The list of available commands consists of:
universal commands, as determined by the selected node level:
host PC node (level 1)
communication module node (level 2) remote device node (level 3)
device-specific commands, as determined by the device DTM
Host PC Node Commands
The Host PC node contextual menu includes the following commands:
Name
Add 1
Check DTM devices 1
Description
Opens the Add dialog — containing a subset of the Hardware Catalog, allowing the selection of a communication module DTM.
Checks the current project for invalid DTMs or DTMs that are not installed in the PC. If the results of the check include invalid or notinstalled DTMs, they are displayed in the User errors tab in the information window and a red is superimposed over their icons in the DTM Browser.
DTM services Displays the communication DTMs selection, as well as the device topology, their respective IP addresses, and connection state. In this dialog, for each device you can connect, disconnect, load from devices, or store to devices. You can also choose to stop communication or continue activity when detected errors occur.
Displays the DTM catalog tab of the Hardware Catalog dialog.
DTM hardware catalog
Expand all 2 Displays every DTM in the project.
Collapse all 2 Displays only the communication DTMs in the project.
1. This command also appears in the Control Expert Edit menu.
2. This command also appears in the Control Expert View menu.
42
S1A33985 12/2018
Communication Module and Remote Device Node Commands
The DTM Browser’s contextual menu has the following items:
Name
Open 1
Add 1
Description
This opens the Device Editor for the selected communication module.
NOTE: Double-clicking the left mouse button on the DTM in the
DTM Browser also opens this window.
This opens the Add dialog, displaying a subset of the Hardware Catalog, allowing the selection of a DTM.
NOTE: Control Expert filters the content of the Add dialog, so that it displays only DTMs that are compatible with the selected DTM selected.
Delete 1
Field Bus
Discovery
Connect 1
Disconnect 1
If the selected DTM allows this function, this deletes the selected DTM and its sub-node DTMs from the DTM connectivity tree.
Deletion from the DTM connectivity tree does not affect the DTM’s link to the I/O scanning table.
This scans the connected physical devices to create the corresponding field bus topology. Refer to the Field Bus Discovery Service topic.
This connects the DTM ( see page 46
Control Expert project application.
) to its physical device on the network.
This connection does not depend on the PLC online/offline status of the
NOTE: Connecting a gateway or device DTM implicitly connects its parent
DTM.
Expert project application.
from its physical device. This disconnection depends on the PLC online/offline status of the Control
NOTE: Disconnecting a gateway or device DTM implicitly disconnects its parent DTM.
Load data from device 1
Store data to device
1
Copy
Paste
Device menu
This loads data from the physical device on the network to the DTM.
This loads data from the DTM to the physical device on the network.
This command is disabled.
This command is disabled.
This command opens a sub-menu that contains device-specific commands, as determined by the device vendor.
For details, refer to the Communication Module Commands topic
1. This command also appears in the Control Expert Edit menu.
2. This command also appears in the Control Expert View menu.
Configuring
S1A33985 12/2018
43
Configuring
Name
Properties 1
Description
Device menu 2 This command opens a sub-menu that contains device-specific commands, as determined by the device vendor.
For details, refer to the Communication Module Commands topic
Opens the Ethernet communication module Properties window.
Print device 1 If this optional function is supported by a DTM, this function displays the device documentation — including configuration settings — in the PC’s default Internet browser, which can then be printed.
NOTE: Device information can be printed:
for only one device DTM at a time, when that DTM is not open for editing in the Device Editor.
only when the DTM is disconnected from the physical device.
Zoom out 2 This returns to the display of the entire DTM connectivity tree.
Expand all 2
Collapse all
2
This displays DTMs below the selected DTM.
This displays only the selected DTM.
1. This command also appears in the Control Expert Edit menu.
2. This command also appears in the Control Expert View menu.
Communication Module Commands
When you select Device menu in the main contextual menu for the communication module, a submenu with the following commands is displayed:
Name
Offline Parameter
Online Parameter
Compare
Configuration
Observe
Diagnosis
Description
This command is disabled.
This command is disabled.
This compares 2 devices, either online or offline.
This opens the Device Editor for the selected communication module, when the module and its DTM are disconnected.
This command is disabled.
This opens the Diagnosis Window for the selected communication module, when the module and its DTM are connected.
44
S1A33985 12/2018
Configuring
Name
Additional functions
Remove EDS from library
Description
Add EDS to library Opens the EDS File Wizard, which you can use to add a device EDS file to the Control Expert EDS device library. Control Expert displays the contents of EDS files as DTMs for use in the DTM Browser and Device Editor.
Opens the EDS Deletion from Device Library window, which you can use to delete an EDS file from the device library.
Online Action
EtherNet/IP
Explicit Message
Modbus TCP
Explicit Message
Opens the Online Action window. Depending upon the protocol(s) a remote device supports, you can use the
Online Action window to:
Ping a remote EtherNet/IP or Modbus TCP device
view and write to EtherNet/IP properties in a remote
EtherNet/IP device view and write to port configuration properties in a remote EtherNet/IP device
Opens the EtherNet/IP Explicit Message
window, which you can use to send explicit messages to EtherNet/IP remote devices.
Opens the Modbus TCP Explicit Message
window, which you can use to send explicit messages to Modbus TCP remote devices.
About
Advanced Mode Displays or hides expert-level properties that help define
Ethernet connections. See the Enabling Advanced
this feature.
for instruction on how to use
When you select Device menu 2 in the main contextual menu for the communication module, a sub-menu with the following commands is displayed:
Name
Configuration
Description
This opens the Device Editor for the selected communication module, when the module and its DTM are disconnected.
Diagnosis This opens the Diagnosis Window for the selected communication module, when the module and its DTM are connected.
Add EDS to library Opens the EDS File Wizard, which you can use to add a device EDS file to the Control Expert EDS device library. Control Expert displays the contents of EDS files as DTMs for use in the DTM Browser and
Device Editor.
Remove EDS from library
Opens the EDS Deletion from Device Library window, which you can use to delete an EDS file from the device library.
S1A33985 12/2018
45
Configuring
Name
Online Action
EtherNet/IP
Explicit Message
Modbus TCP
Explicit Message
Advanced Mode
Description
Opens the Online Action window. Depending upon the protocol(s) a remote device supports, you can use the Online Action window to:
Ping a remote EtherNet/IP or Modbus TCP device view and write to EtherNet/IP properties in a remote EtherNet/IP
device view and write to port configuration properties in a remote
EtherNet/IP device
Opens the EtherNet/IP Explicit Message
devices.
window, which you can use to send explicit messages to EtherNet/IP remote
Opens the Modbus TCP Explicit Message
devices.
window, which you can use to send explicit messages to Modbus TCP remote
Displays or hides expert-level properties that help define Ethernet connections. See the Enabling Advanced Mode topic for instruction on how to use this feature.
Connecting and Disconnecting a Device or Module DTM
A device or module DTM can be either connected to, or disconnected from, the physical device or module.
When a device and its DTM are...
Connected
Disconnected
You can use the Ethernet configuration tool to...
Monitor and diagnose the real-time operation of the device or module
Configure a communication module or remote device by editing its properties
NOTE: Distinguish between:
connecting and disconnecting a DTM and the associated physical device using commands in
the DTM Browser
— and — placing Control Expert in online or offline operating mode using commands in the Control Expert
PLC menu
You can connect a DTM to, or disconnect a DTM from a device or module using the contextual pop-up menu in the DTM Browser. The DTM Browser indicates the relationship between the DTM and the remote module or device: a connected DTM is displayed in bold text; a disconnected DTM is displayed in normal text.
46
S1A33985 12/2018
Configuring
To connect a DTM to, or disconnect a DTM from its respective module or device, follow these steps:
Step
1
2
3
Action
In the DTM Browser select the DTM that you want to connect to, or disconnect from, the physical communication module or remote device.
NOTE: If the module or device name appears in:
bold text, it is connected and only the Disconnect command is enabled.
normal text, it is disconnected and only the Connect command is enabled.
Click the right-mouse button.
Result: A pop-up menu opens.
Select one of the following commands:
Connect
Disconnect
NOTE: The Connect and Disconnect commands are also available in the Control
Expert Edit menu.
Enabling Advanced Mode
Use the contextual menu in the DTM Browser to toggle Control Expert in or out of Advanced Mode, thereby displaying or hiding expert-level properties that help define Ethernet connections. These properties are identified by the icon.
NOTE: To maintain system performance, confirm that Advanced Mode properties are configured only by persons with a solid understanding of communication protocols.
To toggle Advanced Mode on and off:
3
4
Step
1
2
Action
Close both the Diagnosis Window and every instance of the Device Editor before attempting to toggle Advanced Mode on or off.
NOTE: If the Device Editor or the Diagnosis Window is open, the Advanced Mode status — on or off — cannot be changed.
In the DTM Browser, right-click the communication module.
Result: A pop-up menu opens.
To toggle ON advanced mode, select Device Menu → Advanced Mode.
To toggle OFF advanced mode, repeat steps 1 through 3, above.
S1A33985 12/2018
47
Configuring
Field Bus Discovery Service
Introduction
Use the field bus discovery service to detect and add to your Control Expert application, network devices that are situated on a local network. The field bus discovery service is available only when the Ethernet communication module DTM is connected to its physical device.
Only the first level devices below the communication DTM are detected.
Performing Field Bus Discovery
The results of the scanning process is compared to the registered DTMs in the DTM catalog of the computer. If a match is found in the DTM catalog for a scanned device, the results are accompanied with a matching type that gives the accuracy of the match.
These are the available matching types:
Exact match : Every identification attribute matches. The correct device type was found.
Generic match : At least the Vendor and device Type ID attributes match. The support level of the DTM is “Generic Support.”
Uncertain match : At least the Vendor and device Type ID attributes match. The support level of the DTM is not “Generic Support.”
Use the field bus discovery service:
Step
1
2
Action
In the DTM Browser, select an appropriate DTM.
NOTE: The field bus discovery service limits its search to the range of IP addresses that is pre-
configured for the selected channel in the Channel Properties page ( see page 59 ) .
Right-click the DTM and scroll to Field bus discovery to open the dialog box:
48
3
4
Under these conditions, select a channel and a protocol:
The DTM has more than one channel.
The channel supports more than one protocol.
Click on OK. The service starts to detect devices on the selected channel.
S1A33985 12/2018
Configuring
6
7
8
Step
5
9
Action
If at least one matched device has been found, the Field Bus Discovery dialog displays a list of
Scanned Devices.
Use the controls of the Field Bus Discovery dialog to select the devices to add to your Control Expert application.
After you have selected the devices you want to add in the Field Bus Discovery dialog, click OK.
If the field bus discovery process finds at least one device with an IP address that is already used in the project, you are asked if you want to continue and replace the existing project device(s):
Yes: Proceed to the next step.
No: Cancel automatic field bus discovery.
The device properties dialog (below) opens, displaying the default name for the first discovered device to be added:
10
11
In the General page of the device properties dialog, type in the Alias name for the device to be added, then click OK. The dialog closes, then re-opens if there is another device to be added to the application.
Repeat the above step for each additional discovered device.
After you finish adding devices to the application, configure each device for operation as part of the application:
Disconnect the Ethernet communication module from its DTM. In the DTM Browser, select the
Ethernet communication module, then select Edit → Disconnect.
Configure the new device properties in the DTMs for both the Ethernet communication module, and the newly added remote device.
S1A33985 12/2018
49
Configuring
Field Bus Discovery Dialog
If at least one matched device has been found, the Field Bus Discovery dialog box is displayed listing the scanned and matched devices. Select the matched devices to be created in the Control
Expert project (which then shows up in the Selected Devices list:
50
This dialog presents these lists:
List
Scanned Devices
Matched Devices
Selected Devices
Description
The devices (matched and unmatched) found during the scan.
The matched DTMs found in the workstation DTM catalog for the device that you selected in the Scanned Devices list.
Each time a scanned device is selected in the Scanned Devices list, the contents of the
Matched Devices list is updated to display the matched device DTMs found for the selected scanned device.
The matching process can yield one or more matched devices for a given scanned device. In this case, only one DTM was discovered for the selected scanned device.
This list displays the device DTMs that have been selected in the Matched Devices list, which will be added to the Control Expert project.
S1A33985 12/2018
Configuring
The lists use the following colored icons:
Color
Green
Yellow
Red
Black
Meaning
The device has been selected.
The device has been matched.
The device has not been matched.
Information about the address of the scanned device:
In the Scanned Devices list, the device has an address identical to one of the DTMs in
the Control Expert project
In the Matched Devices list, the device will be assigned an address identical to one of the
DTMs in the Control Expert project
NOTE: An icon can consist of two colors. For example, a search can discover a device that:
has a matching DTM, and has an IP address identical to a device already added to the Control Expert application
In this case, the icon next to the discovered device would be:
half yellow and half black before it is selected, and
half green and half black after it is selected
This dialog has five buttons:
Button
Add All
Use this button to...
Automatically add the most closely matched (according to the matching types listed above) device DTM for each found device in the Matched Devices list to the Selected Devices list.
Add One Add the matched device DTM selected in the Matched Devices list.
Remove Remove one or more devices from the Selected Devices list.
OK
Cancel
Insert the device DTMs in the Selected Devices list into the Control Expert project.
If there are one or more devices in the Selected Devices list that have the same address in the
Control Expert project, a message box opens asking if you want to continue.
If you click OK, devices in the Control Expert project that have identical addresses as the selected devices are deleted and replaced by the DTMs selected in the Selected Devices list.
Cancel the field bus discovery scan and do nothing. Information in the three lists is discarded.
S1A33985 12/2018
51
Configuring
Device Editor
Description
Use the Device Editor to view and configure Ethernet communication modules and remote devices. The collection of properties you can view or configure depends on:
the node type selected in the DTM Browser:
communication module
remote device
whether Control Expert is operating in Advanced Mode
Displaying Properties of the Ethernet Communication Module
After you open the Ethernet communication module in the DTM Browser, the left pane (1, below) of the Device Editor displays a tree control containing configurable property groups for the communication module. Click on a node in the tree control to display one or more pages of module properties for the selected group in the right pane (2, below).
52
S1A33985 12/2018
Configuring
Property Types
The Device Editor displays an icon next to many device properties. The following three icons are displayed:
This icon...
Indicates the property is...
Read-only. The property value cannot be edited in this page.
Read-write. The property value can be edited in this page.
An expert-level communication protocol property that is displayed only when Advanced
Mode is enabled.
Displaying Property Definitions
Many property configuration pages provide an on-screen definition of the property you are editing.
To display a property definition in the Description section of the page, select that property in the property list. The following screen displays a description of the Gateway IP Address property.
NOTE: The page displayed above can be accessed by opening an Ethernet communication module in the Device Editor, and then selecting Channel Properties → TCP/IP in the navigation tree.
S1A33985 12/2018
53
Configuring
Configuring Properties in the Device Editor
Configuring Properties
The Device Editor can be opened from the DTM Browser.
To open the DTM Browser select Tools → DTM Browser in the Control Expert main menu.
To use the Device Editor:
Step
1
2
3
Description
Confirm that the DTM you want to use is not connected to the actual communication module or device. If
necessary, disconnect the DTM from the module or device ( see page 46 ) .
In the DTM Browser, select the Ethernet network node you want to configure, which can be either:
an Ethernet communication module
— or — a remote device
With a node selected in the DTM Browser, do one of the following:
In the Control Expert main menu, select Edit → Open.
— or —
In the DTM Browser click the right mouse button and, in the pop-up menu, select Open.
The Device Editor appears. It displays the configurable properties for the selected module or device:
54
S1A33985 12/2018
Configuring
Step
4
5
6
Description
Expand the navigation tree and select a node in the left window pane to display its properties in the right pane. The list of configurable properties varies, depending on the node type — communication module or remote device — selected in the DTM Browser.
While you edit a parameter, Control Expert displays an icon — next to the field you are editing and in the navigation tree — indicating the parameter value is being edited. Control Expert displays one of the following icons:
This icon...
Indicates the importance of the parameter being edited is...
High: Editing this parameter may limit or deny access to the module or device.
Low: Editing this parameter will not limit or deny access to the module or device.
After you finish editing a page, click:
Apply to save your edits and keep the page open.
— or —
OK to save your edits and close the page.
NOTE: Your edits will not take effect until they are successfully downloaded from your PC to the CPU and from the CPU to the communication modules and network devices.
S1A33985 12/2018
55
Configuring
Uploading and Downloading DTM-Based Applications
Introduction
You can use Control Expert to download an application file from your PC to the PLC, and to upload an application file from the PLC to your PC.
To perform a successful upload, confirm that the application file includes specific upload-related information as part of the application.
Downloading DTM-Based Applications
Control Expert applications that include DTM files require more memory than traditional Control
Expert applications. The following products employ DTMs for network configuration:
140 NOC 771 01 Ethernet Communication Module for Quantum
TSX ETC 101 Ethernet Communication Module for Premium
BMX NOC 0401 Ethernet Communication Module for M340
In some cases, the configurations created for these modules—and the data associated with them—will require more memory than is available in the CPU.
If the amount of memory required by an application exceeds the amount of memory that is available in the CPU, Control Expert displays a message during the build process, before the application is downloaded to the PLC.
When this situation occurs, exclude the additional upload-related information from the application to complete the build and enable the application download. To do this, make the following configuration change in Control Expert:
Step
1
2
3
Action
In the main menu, select Tools → Project Settings... The Project Settings window opens.
In the left pane of the Project Settings window, select General →
PLC embedded data.
In the right pane, de-select Upload information:
56
4 Click OK to save your changes and close the Project Settings window.
S1A33985 12/2018
Configuring
After the Upload information setting is disabled, you can build the application and download it to the PLC.
NOTE: An application in which the Upload information setting has been disabled cannot later be uploaded from the PLC to the PC.
Uploading DTM-Based Applications
DTM-based applications that were successfully downloaded to Control Expert—with the project’s
Upload information setting enabled—can later be uploaded from the PLC to the PC if the target PC has the following files installed on it:
a version of Control Expert that is equal to or higher than the version used to create the
application the master DTMs for the modules included in the configuration
NOTE: The Ethernet Configuration Tool installation CD contains the Master DTMs for the
Ethernet communication modules, referenced above.
the device DTMs for the DTM-based devices attached to the network (confirm that the DTMs are of the same or higher revision as each device DTM used in the configuration) the device EDS files for any EtherNet/IP device used in the configuration (confirm that the EDS files are of the same or higher revision as each device EDS file used in the configuration)
After the above components have been installed on the target PC, you can upload a DTM-based
Control Expert application from a PLC.
NOTE: Confirm that each of the above DTM components is installed on the target PC attempting the upload.
before
S1A33985 12/2018
57
Configuring
Channel Properties Section 2.4
Channel Properties
Overview
This section describes how to configure channel properties for the Ethernet network.
What Is in This Section?
This section contains the following topics:
Topic
Channel Properties Page
Channel Properties - Ethernet Page
Channel Properties - TCP/IP Page
Channel Properties - EtherNet/IP Page
Page
58
S1A33985 12/2018
Channel Properties Page
Description
Use the Channel Properties page to:
select the IP address to use for:
connecting module or device DTMs to physical devices sending explicit messages to Modbus TCP and EtherNet/IP devices
view your PC’s IP address settings
The Channel Properties page looks like this:
Configuring
To display this page, select the Channel Properties node in the navigation tree located on the left side of the Device Editor.
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to edit properties.
see page 54
for instructions
S1A33985 12/2018
59
Configuring
Properties
This page presents the following properties:
Name
Source Address area:
Source IP
Address (PC):
Description
A list of IP addresses assigned to network interface cards installed on your PC.
Sub-Network Mask: The subnet mask associated with the selected Source IP Address.
EtherNet/IP Network Detection area:
Begin detection range address
End detection range address
The starting IP address of the address range for automatic field bus discovery of
EtherNet/IP devices.
The ending IP address of the address range for automatic field bus discovery of
EtherNet/IP devices.
Modbus TCP Network Detection area:
Begin detection range address
End detection range address
The starting IP address of the address range for automatic field bus discovery of
Modbus TCP devices.
The ending IP address of the address range for automatic field bus discovery of
Modbus TCP devices.
Managing Source IP Address for Multiple PCs
When you connect a PC to a DTM-based Control Expert application, Control Expert requires that you define the IP address of the PC connected to the PLC, which is referred to as the source IP address (PC) . Rather than having to perform a Build in Control Expert each time you connect a PC to the PLC, the source IP address (PC) is selected automatically when you import the Control
Expert application. During application import, the DTM retrieves all available configured NIC addresses of a connected PC and matches the subnet mask of the master with the available NIC list.
If a match between the subnet mask of the master and the NIC list exists, Control Expert automatically selects the matched IP address as the source IP address (PC) in the Channel
Properties page.
If multiple matches exist, Control Expert automatically selects the IP address nearest to the subnet mask.
If no match exists, Control Expert automatically selects the IP address to the nearest available subnet mask.
60
S1A33985 12/2018
Configuring
Channel Properties - Ethernet Page
Description
Use the Ethernet page to:
view and edit the Connection Speed, which includes both the:
transmission speed, and duplex mode
view the Frame Format
The Ethernet page looks like this:
To display this page, select the Channel Properties → Ethernet node in the navigation tree located on the left side of the Device Editor.
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to edit properties.
see page 54
for instructions
Properties
This page presents the following properties:
Name
Connection Speed
Frame Format
Description
The transmission speed and duplex mode for the network. Values include:
Auto 10/100 Mb (default)
100 Mb Half
100 Mb Full
10 Mb Half
10 Mb Full
NOTE: Schneider Electric recommends the default setting—Auto
10/100 Mb. This setting causes the connected devices to perform auto-negotiation and thereby determine the fastest common transmission rate and duplex mode.
Ethernet II is the only available value (read-only).
S1A33985 12/2018
61
Configuring
Channel Properties - TCP/IP Page
Description
Use the TCP/IP page to:
select a Configuration mode, which specifies how the communication module obtains its IP
addressing settings, and edit the IP addressing settings that will be used if the Configuration mode is set to Static
The TCP/IP page looks like this:
To display this page, select the Channel Properties → TCP/IP node in the navigation tree located on the left side of the Device Editor.
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to edit properties.
see page 54
for instructions
Selecting a Configuration Mode
Use the Configuration list to specify a configuration mode. The configuration mode setting determines how the communication module obtains its IP address at startup. Choices are:
Configuration Mode
Static
Flash Memory
BOOTP
Description
The module uses the scanner IP address, gateway IP address, and sub-network mask configured in this page.
The module uses the IP address configured via the TCP/IP object and stored flash memory. An IP address configured by this process survives both a warm and a cold re-start.
The module uses an IP address assigned by a BOOTP server.
62
S1A33985 12/2018
Configuring
Setting the Module Addresses in Static Mode
Three IP address properties need to be configured for the Ethernet communication module in
Static configuration mode:
Property
Scanner IP Address
Sub-Network Mask
Gateway Address
Description
The 32-bit identifier—consisting of both a network address and a host address—assigned to a device connected to a TCP/IP
Internet network using the Internet Protocol (IP).
The 32-bit value used to hide (or mask) the network portion of the
IP address and thereby reveal the host address of a device on a network using the IP protocol.
The address of a device, if any, that serves as a gateway to the communication module.
Default Address Configurations
The communication module uses a default address configuration when it is not configured or when a duplicate IP address is detected. The default address is based on the MAC address of the module and makes it possible for several Schneider Electric devices to use their default network configuration on the same network.
The module uses the following default address configurations:
Default IP Address
This default address starts with 10.10 and uses the last two bytes of the MAC address. As an example, a device with the MAC address of 00:00:54:10:8A:05 has a default IP address of
10.10.138.5 (0x8A=138, 0x05=5).
Default Sub-Network Mask
The default address is 255.0.0.0 (a class A mask).
Default Gateway Address
The default gateway address is identical to the default IP address.
Duplicate Address Checking
Before going online, the module sends out at least four ARP (Address Resolution Protocol) messages with a proposed IP address:
if an answer is returned:
another network device is already using the proposed IP address
the module will not use the proposed IP address, but will instead use the default IP address
if an answer is not returned:
the module is assigned the proposed IP address (along with the associated network parameters.)
NOTE: When powering up an entire network, some switches may be slow to complete the power up process. THis slow switch responce can cause some ARP messages to be dropped. To help improve performance when powering up an entire network, confirm that the network switches complete their power up cycle before powering up the PLCs.
S1A33985 12/2018
63
Configuring
Channel Properties - EtherNet/IP Page
Description
The EtherNet/IP page is displayed only when Control Expert is operating in Advanced Mode
see page 47
. Advanced mode properties are identified by the icon.
Use the EtherNet/IP page to configure the following communication module properties:
properties that determine how the communication module, as a scanner, opens connections for
both implicit and explicit messages the frequency for transmitting produced data over implicit messaging connections the timeout period for explicit messaging connections the behavior of the communication module—as a scanner—when:
the application is stopped, or the communication module receives a reset service request
The EtherNet/IP page looks like this:
64
To display this page, select the Channel Properties → EtherNet/IP node in the navigation tree located on the left side of the Device Editor.
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to edit properties.
see page 54
for instructions
S1A33985 12/2018
Configuring
Properties
Note: Users experienced in the configuration of EtherNet/IP networks can edit the following readwrite properties.
Name
Timeout
FW_Open IO Connection Timing
Description
The amount of time the communication module waits for the Forward_Open IO messaging transaction to open an implicit messaging connection.
Default = 5000 ms
FW_Open EM Connection Timing
EM Connected RPI
EM Request Timeout
The amount of time the communication module waits for the Forward_Open IO messaging transaction to open an explicit messaging connection.
Default = 3000 ms
The value used to set the T->O (target to originator) and O->T (originator to target) requested packet interval (RPI) for explicit message connections. This value is used to calculate the lifetime of a connection.
Default = 10000 ms.
The amount of time the communication module waits between a request and reply of an explicit message.
Default =10 s.
Output
Allow reset explicit message The behavior of the communication module—as scanner—when it receives a reset service request:
TRUE indicates the module will accept the request
and reset itself.
FALSE indicates the module ignores the reset service request and continues uninterrupted operations.
Default = FALSE
Behavior when CPU state is STOP The state of the communication module when the CPU application goes into a STOP state:
TRUE indicates that the module enters STOP state
(implicit connections are closed).
FALSE indicates that the module enters IDLE state
(implicit connections are not closed).
Default = FALSE
S1A33985 12/2018
65
Configuring
Ethernet Services Section 2.5
Ethernet Services
Overview
This section describes how to enable and configure Ethernet services provided by the
140 NOC 771 01 communication module.
What Is in This Section?
This section contains the following topics:
Topic
Enabling Services
Configuring the DHCP and FDR Servers
Configuring the SNMP Agent
Configuring Access Control
Configuring QoS Ethernet Packet Tagging
Page
66
S1A33985 12/2018
Configuring
Enabling Services
Description
Use the Services page to enable and disable Ethernet services provided by the communications module.
NOTE: After you enable a service, you can configure its settings. Control Expert applies default settings to each service you enable, but elect not to configure.
The Services page looks like this:
To display this page, select the Services node in the navigation tree located on the left side of the
Device Editor.
When you Enable a service, Control Expert displays a node for that service in the navigation tree on the left side of the Device Editor, beneath the Services parent node. Click on a service node to access its settings.
When you Disable a service, Control Expert hides the node for that service.
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to edit properties.
see page 54
for instructions
S1A33985 12/2018
67
Configuring
Properties
The Ethernet communication module can be configured to provide the following services:
If this service is enabled...
SNMP
Access Control
Address Server
QoS Tagging
I/O Communication Control
The module can...
serve as an SNMP v1 agent provide trap information to up to two devices configured as SNMP managers.
NOTE: The SNMP service is enabled by default, and cannot be disabled.
deny access to the Ethernet communication module by unauthorized network devices.
provide both IP addressing parameters and operating parameters to other
Ethernet devices.
add Differentiated Services Code Point
Ethernet packets.
(DSCP) tags to Ethernet packets so that network switches can prioritize the transmission and forwarding of
NOTE: Before enabling QoS tagging, confirm that devices connected to the
Ethernet communication module support QoS tagging.
allow the Control Expert application to control the enabling and disabling of individual connections between the communication module and remote I/O devices.
NOTE:
The application can open and close individual connections using the control bits located at the beginning of the output area.
If this service is disabled, the user, via the application program, cannot toggle on and off connection control bits
68
S1A33985 12/2018
Configuring
Configuring the DHCP and FDR Servers
Description
The Ethernet communication module includes both a DHCP and a Fast Device Replacement
(FDR) server. The DHCP server provides IP address settings to networked Ethernet devices. The
FDR server provides operating parameter settings to replacement Ethernet devices that are equipped with FDR client functionality.
Use the Address Server page to:
enable and disable the communication module’s FDR service
view an automatically generated list of devices included in the communication module’s
Ethernet configuration, displaying for each device:
IP addressing parameters, and whether the device’s IP addressing parameters are provided by the communication module’s embedded DHCP server
manually add remote devices—that are not part of the communication module’s Ethernet configuration—to the communication module’s DHCP client list
NOTE: Confirm that each device you manually add is equipped with DHCP client software, and is configured to subscribe to the communication module’s IP addressing service.
The Address Server page looks like this:
To display this page:
Step
1
2
3
Description
Select the Services node in the navigation tree located on the left side of the
Device Editor. The Services page opens.
In the Services page, set the Address Server field to Enabled. The Address
Server node appears in the navigation tree.
Select the Address Server node in the navigation tree.
S1A33985 12/2018
69
Configuring
Enabling the FDR Service
To enable the communication module’s FDR service, set the FDR Server field to Enabled. To disable the service, toggle the same field to Disabled.
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to apply edited properties to networked devices.
see page 54
for instructions
Any networked Ethernet device equipped with FDR client functionality can subscribe to the communication module’s FDR service. The communication module can store up to 1 MB of FDR client operating parameter files. When this file storage capacity is reached, the module cannot store any additional client FDR files.
The communication module can store FDR client files for up to 128 devices, depending on the size of each stored file. For example, if the size of each FDR client file is small–not more than 8 Kb–the module could store up to the maximum of 128 parameter files.
Manually Adding Remote Devices to the DHCP Service
Remote devices that are part of the communication module’s Ethernet configuration–and which have subscribed to the communication module’s IP addressing service–automatically appear in the
Automatically Added Devices list.
Other remote devices–that are not part of the communication module’s configuration–can be manually added to the communication module’s DHCP IP addressing service.
To manually add networked Ethernet devices, which are not part of the communication module’s
Ethernet configuration, to the communication module’s IP addressing service:
Step
1
2
3
Description
In the Address Server page, click the Add Device Manually button. Control Expert adds an empty row to the list of Manually Added Devices.
In the new row, configure the following parameters for the client device:
IP Address Type in the IP address of the client device.
Identifier Type Select the type of value the client device will use to identify itself to the FDR server:
MAC address
Device Name
Identifier
Mask
Depending upon the identifier type, type in the client device setting for the MAC address or Name.
Type in the client device subnet mask.
Gateway Type in the gateway address that remote devices can use to communicate with devices located on other networks. Use
0.0.0.0 if remote devices will not communicate with devices located on other networks.
Refer to the topic Configuring Properties in the Device Editor
instructions on how to apply edited properties to networked devices.
70
S1A33985 12/2018
Configuring
Viewing the Auto-Generated DHCP Client List
The list of Automatically Added Devices includes a row for each remote device that is:
part of the communication module’s Ethernet configuration, and
configured to subscribe to the communication module’s DHCP addressing service
NOTE: You cannot add devices to this list in this page. Instead, use the configuration pages for the remote device to subscribe to this service.
The list of Automatically Added Devices contains the following information for each networked device:
Property Description
Device Number The number assigned to the device in the Control Expert configuration.
IP Address
Enable DHCP
Identifier Type
The client device IP address.
TRUE indicates that the device subscribes to the DHCP service.
Indicates the mechanism used by the server to recognize the client (MAC address or DHCP device name).
Identifier
Mask
Gateway
The actual MAC address or DHCP device name.
The client device subnet mask.
The IP address a DHCP client device will use to access other devices that are not located on the local subnet. A value of 0.0.0.0 constrains the
DHCP client device by allowing it to communicate only with devices on the local subnet.
Subscribing to the DHCP Service for a Device that is Part of the Configuration
An Ethernet device–that is part of the communication module Ethernet configuration–can subscribe to the communication module’s IP addressing service. To subscribe to this service, follow these steps:
Step Action
1 In the DTM Browser, select the Ethernet communication module that is connected to the remote device that you want to add to the DHCP service. In the following example, the communication module with the alias name of NOC01 is selected:
S1A33985 12/2018
NOTE: The selected module is connected to the STB NIC 2212 network interface device bearing the alias name NIC2212_01, which is the module you want to add to the DHCP service.
71
Configuring
Step Action
2 With NOC01 selected in the DTM Browser, click the right mouse button, and select
Open in the pop-up menu.:
3
The Device Editor opens.
In the navigation tree on the left side of the Device Editor, expand the Device List node and select the device for which you want to enable the DHCP service. In this example, select NIC2212_01:
72
Control Expert displays the properties for the selected remote device in the right pane of the window.
S1A33985 12/2018
Step Action
4 In the right pane of the window, select the Address Setting tab to display the following page:
Configuring
5
6
In the Address Server area of this page, configure the following properties:
DHCP for this device Select Enabled
Identified by The choices are:
MAC Address, or
Device Name
Identifier
Subnet Mask
Gateway
Select Device Name.
Control Expert has automatically added the device name NIC2212_01. For the purpose of this example, accept this default value.
Control Expert has automatically applied the same subnet mask used for the Ethernet communication module. For the purpose of this example, accept the default value of 255.255.255.0.
For the purpose of this example, accept the default value of 0.0.0.0.
Click OK to save your edits.
NOTE:
Refer to the topic Configuring Properties in the Device Editor ( see page 54 )
for more information on editing and saving property settings in this window.
S1A33985 12/2018
73
Configuring
Configuring the SNMP Agent
Description
The Ethernet communication module includes an SNMP v1 agent. An SNMP agent is a software component running on the communication module that allows access to the module's diagnostic and management information via the SNMP service.
SNMP browsers, network management software, and other tools typically use SNMP to access this data. In addition, the SNMP agent can be configured with the IP address of up to two devices— typically PC's running network management software—to be the target of event driven trap messages. These trap messages inform the management device of events such as cold start, and detected authentication failures.
Use the SNMP page to configure the SNMP agent in the communication module. The SNMP agent can connect to and communicate with up to 2 SNMP managers as part of an SNMP service. The
SNMP service includes:
authentication checking, by the Ethernet communication module, of any SNMP manager that
sends SNMP requests management of event, or trap, reporting by the module
The SNMP page looks like this:
74
S1A33985 12/2018
Configuring
To display this page:
Step
1
2
3
Description
Select the Services node in the navigation tree located on the left side of the Device Editor. The
Services page opens.
In the Services page, set the SNMP field to Enabled, then click either OK or Apply. The SNMP node appears in the navigation tree.
Select the SNMP node in the navigation tree.
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to edit properties.
see page 54
for instructions
S1A33985 12/2018
75
Configuring
Viewing and Configuring SNMP Properties
NOTE: The sysName SNMP parameter is neither editable nor visible in the Control Expert Ethernet
Configuration Tool software. By default, the sysName is set to the Ethernet communication module part number.
The following properties can be viewed and edited in the SNMP page:
Property
IP Address Managers:
Description
IP Address Manager 1 The IP address of the first SNMP manager to which the SNMP agent sends notices of traps.
IP Address Manager 2 The IP address of the second SNMP manager to which the SNMP agent sends notices of traps.
Agent:
Location
Contact
SNMP Manager
The device location (32 characters maximum)
Information describing the person to contact for device maintenance (32 characters maximum)
Select either:
TRUE: the Location and Contact information are editable in this page
FALSE: Location and Contact settings are not editable in this page
Community Names:
Get
Set
Trap
Password required by the SNMP agent before executing read commands from an
SNMP manager. Default = public.
Password required by the SNMP agent before executing write commands from an
SNMP manager. Default = public
Password an SNMP manager requires from the SNMP agent before the manager will accept trap notices from the agent. Default = public
Security:
Enable Authentication
Failure Trap
TRUE causes the SNMP agent to send a trap notification message to the SNMP manager if an unauthorized manager sends a Get or Set command to the agent.
Default = FALSE.
76
S1A33985 12/2018
Configuring
Configuring Access Control
Description
Use the Access Control page to restrict access to the Ethernet communication module in its role as either a Modbus TCP or EtherNet/IP server. When access control is enabled in the Services page, add the IP addresses of the following devices to the list of Authorized Addresses to permit communication with that device:
the Ethernet communication module itself, so that the module can use EtherNet/IP explicit messaging for any of the following purposes:
obtaining diagnostic data resetting the module changing the IP address
any client device that may send a request to the Ethernet communication module, in its role as either Modbus TCP or EtherNet/IP server your own maintenance PC, so that you can communicate with the PLC via Control Expert to configure and diagnose your application, and to view the module’s web pages any target device to which the Ethernet communication module may send a Modbus TCP explicit message
NOTE: You need not add to list the IP address of devices that will be the target of EtherNet/IP explicit messages.
When access control is disabled in the Services page, the Ethernet communication module will accept Modbus TCP and EtherNet/IP requests from any device.
S1A33985 12/2018
77
Configuring
The following graphic depicts the Access Control page immediately after a new row has been added to the list of Authorized Addresses, but before the new item has been configured:
78
To display this page:
Step
1
2
3
Description
Select the Services node in the navigation tree located on the left side of the
Device Editor. The Services page opens.
In the Services page, set the Access Control field to Enabled and click either OK or Apply. The Access Control node appears in the navigation tree.
Select the Access Control node in the navigation tree.
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to edit properties.
see page 54
for instructions
S1A33985 12/2018
Configuring
Adding and Removing Devices in the Authorized Address List
To add a device to the Authorized Addresses list:
Step
1
2
3
4
5
Description
In the Access Control page, click Add.
A new row appears in the Authorized Addresses list, displaying:
a red exclamation point, indicating editing has begun, and a placeholder IP address of 0.0.0.0
Double-click the left mouse button on the placeholder IP address.
The IP address field expands and becomes editable.
In the new IP address field, type in the IP address of the device which will be able to access the communication module, then press Enter.
Repeat steps 1 through 3, above, for each additional device to which you want to grant access to the communication module.
Refer to the topic Configuring Properties in the Device Editor instructions on how to save your configuration edits.
for
To remove a device from the Authorized Addresses list, select its IP address in the list, then click
Remove. The selected IP address is removed.
S1A33985 12/2018
79
Configuring
Configuring QoS Ethernet Packet Tagging
Description
The Ethernet communication module can be configured to perform Ethernet packet tagging. The module supports the OSI layer 3 Quality of Service (QoS) standard defined in RFC-2475. When you enable QoS, the module adds a differentiated services code point packet it transmits, thereby indicating the priority of that packet.
(DSCP) tag to each Ethernet
Use the QoS page to:
specify the source of QoS packet priority settings, and
view or edit the five QoS DSCP prioritization values
The QoS page looks like this:
80
To display this page:
Step
1
2
3
Description
Select the Services node in the navigation tree located on the left side of the
Device Editor. The Services page opens.
In the Services page, set the QoS Tagging field to Enabled, then click OK or
Apply. The QoS node appears in the navigation tree.
Select the QoS node in the navigation tree.
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to edit properties.
see page 54
for instructions
S1A33985 12/2018
Configuring
Specifying the Source of QoS Settings
The five QoS prioritization values can be set either from the communication module’s flash memory, or in this page. To specify the QoS configuration source, set the Use value from field to either:
Setting
Configuration 1
Description
The communication module uses the settings input in the Type of Traffic section of this page.
Flash 1 The communication module uses the settings saved in the module’s flash memory. The fields in the Type of Traffic section are read-only.
1. Schneider Electric recommends that QoS values be set in the configuration, and not by saving settings to flash memory. Settings saved to flash memory will be lost if the module is replaced.
NOTE: You can also edit QoS configuration settings by using explicit messages to set the attributes of the QoS CIP object
see page 222
.
Type of Traffic Settings
QoS tagging lets you prioritize Ethernet packet streams based on the type of traffic in that stream.
The communication module recognizes the traffic types described below. When the Use value from field is set to Configuration, you can edit the prioritization values in this page. Each traffic type can have a prioritization value from 0... 63.
Traffic Type
DSCP Value for IO Data Urgent Priority Messages (EtherNet/IP)
Default
55
DSCP Value for IO Data Scheduled Priority Messages (EtherNet/IP) 47
DSCP Value for IO Data High Priority Messages (Modbus TCP & EtherNet/IP) 43
DSCP Value for IO Data Low Priority Messages (EtherNet/IP)
DSCP Value for Explicit Message (Modbus TCP & EtherNet/IP)
31
27
To effectively implement QoS settings in your Ethernet network:
Use network switches that support QoS.
Consistently apply DSCP values to network devices and switches that support DSCP.
Confirm that switches apply a consistent set of rules for sorting DSCP tags, when transmitting and receiving Ethernet packets.
NOTE: The QoS settings for Scheduled, High, and Low priority messages also apply to input and output priority messages for a remote device. You can configure these settings for a remote device
see page 119
) in the Device Editor by selecting a device connection node, then opening the
connection’s General page.
S1A33985 12/2018
81
Configuring
Configuring the Ethernet Communication Module as an EtherNet/IP Adapter Section 2.6
Configuring the Ethernet Communication Module as an
EtherNet/IP Adapter
Overview
This section describes how to configure the Ethernet communication module to act as an
EtherNet/IP adapter, using a functionality called Local Slave. The communication module supports up to three instances of local slaves.
In its role as a EtherNet/IP adapter, the module initiates no messages. Instead, it responds to:
implicit messaging requests from a scanner device in the network, and
explicit messaging requests—directed to the communication module’s assembly object
see page 215
) —from other devices on the network
NOTE: If no local slave instance is enabled, the communication module can respond to explicit messaging requests directed at its CIP objects
see page 211
) other than the assembly object.
What Is in This Section?
This section contains the following topics:
Topic
Introducing the Local Slave
Configuring a Local Slave
Local Slave Inputs and Outputs
Page
82
S1A33985 12/2018
Configuring
Introducing the Local Slave
Local Slave Networking Example
The Ethernet communication module supports up to three instances of the local slave functionality.
The local slave functionality allows other scanners on the network to read from, and write to, the
Ethernet communication module using implicit messaging. Each local slave instance can accept one exclusive owner connection and one listen only connection. Through a local slave, a remote
scanner can access the communication module’s CIP Assembly object (
see page 215
. The local slave function is especially beneficial for peer to peer data exchanges at a repetitive rate.
NOTE:
The Ethernet communication module can provide three local slave adapter instances, while
simultaneously performing as a scanner. These roles are not mutually exclusive.
The local slave is exclusively an EtherNet/IP functionality.
S1A33985 12/2018
83
Configuring
The sample configuration, above, includes the following scanners and adapters:
A primary PLC (1) with one local slave instance enabled. The PLC performs the following functions:
scans I/O data from remote devices (4 and 5)
scans input data from its own local slave instance
A third party scanner (6)—which lacks adapter capability, and therefore cannot itself be scanned by the primary PLC (1)—performs the following functions:
collects data from other sources (not part of this network) writes data to inputs of the primary PLC’s local slave scans the primary PLC’s local slave’s output data via an exclusive owner connection
A secondary scanner (7), which also scans the primary PLC’s local slave, for the very same output data scanned by the third party scanner, via a listen only connection
NOTE:
Because the third party scanner (6) and the secondary scanner (8) both receive the same data
produced by the local slave, the requested packet interval (RPI) settings of the third party scanner’s exclusive owner connection are the same as those of the secondary scanner’s listen only connection.
By enabling a local slave on the primary PLC (1):
PLC (1) allows the third party PLC (6) to write to it at a repetitive rate, even if PLC (6) is not capable of acting as an adapter.
the secondary PLC (7) is able to scan the primary PLC (1) at a repetitive rate, rather than through application intensive explicit messaging.
The topics in this section show you how to use Control Expert software installed in the PC (2, above) to configure a local slave, and to create input and output items in support of the peer-topeer data transfers between and among scanners.
84
S1A33985 12/2018
Configuring
Configuring a Local Slave
Description
The Ethernet communication module presents three identical Local Slave configuration pages.
Use each page to configure a separate local slave instance. Create a local slave instance by:
enabling and naming the local slave specifying the size of local slave input and output assemblies configuring local slave variable names
To display this page, select one of the three Local Slave nodes in the navigation tree located on the left side of the Device Editor.
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to edit properties.
see page 54
for instructions
The following steps describe a sample configuration for Local Slave 1. Your configuration may be different.
Configuration Example: Local Slave 1
In the sample network configuration data, which is available in the PLC Ethernet communication module as inputs. In this example, the third-party device produces the following information:
production totals for manufacturing line A
see page 83
, the application in the third-party PLC produces production totals for manufacturing line B the number of production interruption events for line A the number of production interruption events for line B
Any information that needs to be passed to the third-party device—for example, confirmation that data from the third-party device has been received by the PLC—is accessible in the third-party device as input data. In this example, the third-party device is programmed to scan Local Slave 1 for this confirmation.
When configuring inputs and outputs in both the local slave and the third-party PLC, associate inputs and outputs as follows:
Associate these local slave items:
Outputs (T to O)—assembly instance 101
Inputs (O to T)—assembly instance 102
With these third-party PLC items:
Inputs—assembly instance 101
Outputs—assembly instance 102
S1A33985 12/2018
85
Configuring
The configured Local Slave page looks like this:
Enabling and Naming the Local Slave
Use the Properties section of the Local Slave page to enable (or disable) and identify the local slave.
Setting
Number
Active Configuration
Description
The unique number—or identifier—assigned to the device. By default, Control Expert assigns:
000 = local slave 1
001 = local slave 2
002 = local slave 3
In this example, accept the default 000.
Enabled activates the local slave.
Disabled de-activates the local slave, but retains the current local slave settings.
In this example, select Enabled.
86
S1A33985 12/2018
Configuring
Setting
Comment
Connection bit
Description
An optional free text comment field up to 80 characters maximum.
In this example, leave blank.
Auto-generated integer (0...127) indicating the offset of the connection’s:
health bit, located in the module’s input area control bit, located in the module’s output area
Note: This setting is auto-generated after the local slave settings are input and the network configuration is saved.
Configuring the Size of Local Slave Input and Output Assemblies
Use the Assemblies section of the Local Slave page to configure the size of the local slave inputs and outputs. The assembly numbers are non-editable, and are assigned by Control Expert as follows:
Assembly number
101
112
113
200
121
102
103
199
111
Local slave number
1
1
1
1
2
2
2
2
3
Used for connection
T->O
1
O->T Exclusive Owner
Configuration
O->T Listen Only
T->O
O->T Exclusive Owner
Configuration
O->T Listen Only
T->O
122
123
201
3
3
3
O->T Exclusive Owner
Configuration
O->T Listen Only
1. In this table:
O indicates the originator—or scanner—device
T indicates the target—or adapter—device
S1A33985 12/2018
87
Configuring
The Local Slave assembly settings include:.
Setting
Outputs (T->O)
Outputs (T->O) Size
Inputs (O->T)
Inputs (O->T) Size
Configuration
Configuration Size
Description
A read-only value (see table, above).
In this example, 101.
The maximum size—in bytes—reserved for local slave outputs. An integer from 1 to 509.
In this example, only two output bytes are used: type in 2.
A read-only value (see table, above).
In this example, 102.
The maximum size—in bytes—reserved for local slave inputs. An integer from 0 to 505.
In this example, only eight input bytes are used: type in 8.
A read-only value (see table, above).
In this example, 103.
A read-only value set to 0.
NOTE: When using explicit messaging to read the Ethernet communication module’s assembly object, you need to allocate sufficient room for the response, because the size of the response will equal the sum of: the assembly size + Reply service (1 byte) + General Status (1 byte)
Configuring Local Slave I/O Variable Names
Each input and output that Control Expert creates for your application has both a non-editable structure name (used by Control Expert to internally identify input and output items) and an editable variable name.
Use the I/O Structure Name section of the Local Slave page to:
view and edit local slave input and output variable names
view non-editable local slave structure names
The following property settings have been made in this example:
Setting
Input:
Structure Name
Description
The read-only name for input structures. By default, it is the concatenation of:
the prefix T_
the alias device name—in this case NOC01 the device number—in this case 01 the suffix _IN
In this case, the default would be T_NOC01_01_IN.
88
S1A33985 12/2018
Configuring
Setting
Variable Name
Description
The editable base name for input variables. By default, it is the concatenation of:
the alias device name—in this case NOC01 the device number—in this case 01 the suffix _IN
In this case, the default would be NOC01_01_IN.
For this example, accept the default variable name.
Output:
Structure Name
Variable Name
The read-only name for output structures. By default, it is the concatenation of:
the prefix T_ the alias device name—in this case NOC01
the device number—in this case 01 the suffix _OUT
In this case, the default would be T_NOC01_01_OUT.
The editable base name for output variables. By default, it is the concatenation of:
the alias device name—in this case NOC01 the device number—in this case 01 the suffix _OUT
In this case, the default would be NOC01_01_OUT.
For this example, accept the default variable name.
If you have edited one or more variable names, you can restore the default variable names by clicking on the Default Name button.
S1A33985 12/2018
89
Configuring
Local Slave Inputs and Outputs
Introduction
The Ethernet communication module serves as an adapter when the Active Configuration field is set to Enabled in the configuration window for one (or more) of the module’s local slave nodes.
When a local slave instance of an Ethernet communication module is enabled, the designated memory location allocated to that instance is exposed to, and can be accessed by, other devices.
The I/O data exchange, between the remote device and the local slave, is configured as part of the remote device’s configuration settings.
Configuring the I/O Items
You can configure input and output items in groups of 1 or more single bits, 8-bit bytes, 16-bit words, 32-bit dwords, or 32-bit IEEE floating values. The number of items you create depends upon the data type and size of each item.
The process for creating and defining I/O items for the local slave is the same as for any adapter class device, and depends upon the type of items you wish to create.
In support of the ongoing configuration example, the following items are required:
4 input word items
1 output word item
NOTE: The items created, below, are designed to hold data received from, or sent to, the thirdparty scanner. In addition to these items, it is necessary to include logic in the application programs in which the Ethernet communication module and the third-party scanner, respectively, are included. Writing this code is beyond the scope of this example.
90
S1A33985 12/2018
Creating Input Word Items
To create input items for local slave 01:
Step
1
Action
Select the Input tab to open that page:
Configuring
2
3
NOTE: In this example, each row represents a byte. Because the items you create will be a 16-bit words, each item consists of 2 rows.
In the Default Item Name Root input box type: ProductionTotal_LineA.
Starting at the beginning of the table, select the first two rows: 0 and 1:
S1A33985 12/2018
91
Configuring
Step
4
Action
Click the Define Item(s) button.
Result: The Item Name Definition dialog opens:
5 Select WORD as the New Item(s) Data Type, then click OK.
Result: A new item is created:
92
6
7
8
Click Apply to save the new items, and leave the page open.
Repeat steps 2 - 6 for each new word item you need to create. In this example, that includes the following items:
Rows 2-3, Default Items Name Root: ProductionTotal_LineB
Rows 4-5: Default Items Name Root: Events_LineA
Rows 6-7: Default Items Name Root: Events_LineB
Create output words.
S1A33985 12/2018
Creating Output Word Items
To create output items for local slave 01:
Step
1
Action
Click the Output tab to open the following page:
Configuring
2
3
NOTE: In this example, each row represents a byte. Because the only item you will create is a 16-bit word, you will select 2 rows.
In the Default Item Name Root input box type: DataReceived.
Starting at the beginning of the table, select the first 2 rows, 0 and 1:
S1A33985 12/2018
93
Configuring
Step
4
Action
Click the Define Item(s) button.
Result: The Item Name Definition dialog opens:
5 Select WORD as the New Item(s) Data Type, then click OK.
Result: A new item is created:
94
6
7
Click OK to close the Items window.
Select File → Save to save your edits.
S1A33985 12/2018
Configuring
Using Local Slave Inputs and Outputs
The inputs and outputs created, above, are used as follows:
The third-party device updates values of the following variables:
ProductionTotal_LineA
ProductionTotal_LineB
Events_LineA
Events_LineB
The Ethernet communication module updates value of the DataReceived variable in the thirdparty device at the configured RPI.
S1A33985 12/2018
95
Configuring
96
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Adding Devices to an Ethernet Network
S1A33985 12/2018
Adding Devices to an Ethernet Network Chapter 3
Adding Devices to an Ethernet Network
Overview
This chapter presents examples of how to add devices to, and how to configure these device for operations on, your Ethernet network.
What Is in This Chapter?
This chapter contains the following sections:
Section
3.1
3.2
3.3
Topic
Hardware Catalog
Adding an EtherNet/IP Device to the Network
Adding a Modbus TCP Device to the Network
Page
S1A33985 12/2018
97
Adding Devices to an Ethernet Network
Hardware Catalog Section 3.1
Hardware Catalog
Overview
Control Expert includes a collection of modules and devices—called the Hardware Catalog—that you can add to a Control Expert project. EtherNet/IP and Modbus TCP devices are located in the hardware catalog’s DTM Catalog page. Each device in the catalog is represented by a DTM that defines the parameters of the module or device.
Not every device on the market today offer device-specific DTMs. Some devices are instead defined by a device-specific EDS file. Control Expert displays each EDS file in the form of a DTM.
In this way, you can use Control Expert to configure these Ethernet/IP devices—defined by an EDS file—in the same way you would configure a DTM-defined device.
Other devices lack both a DTM and an EDS file. You can configure these devices by using a
Generic DTM that is included in the DTM Catalog page.
This section address the topics:
how to add a DTM to the catalog
how to add an EDS file to the catalog how to update the catalog how to remove an EDS file from the catalog
What Is in This Section?
This section contains the following topics:
Topic
Adding a DTM to the Control Expert Hardware Catalog
Add an EDS File to the Control Expert Hardware Catalog
Updating the Control Expert Hardware Catalog
Remove an EDS File from the Control Expert Hardware Catalog
Page
98
S1A33985 12/2018
Adding Devices to an Ethernet Network
Adding a DTM to the Control Expert Hardware Catalog
A Manufacturer Defined Process
Before a you can add a DTM to the Control Expert Hardware Catalog, install it on the host PC— the same PC that is running Control Expert—by means of an installation process defined by the device manufacturer.
Consult your device documentation, provided by the device manufacturer, for information describing how to install a device DTM on your PC.
For instructions on how to install the 140 NOC 771 01 Ethernet communication module, refer to the topic Installing Control Expert Ethernet Configuration Tool Software
see page 23
.
NOTE: After you successfully install a device DTM on your PC, update the Control Expert
Hardware Catalog
see page 103
added to a Control Expert project.
so the new DTM is visible in the catalog and available to be
S1A33985 12/2018
99
Adding Devices to an Ethernet Network
Add an EDS File to the Control Expert Hardware Catalog
Overview
Control Expert includes a wizard you can use to add one or more EDS files to the Control Expert
Hardware Catalog. The wizard presents a series of instruction screens that:
simplify the process of adding EDS files to the catalog, and provide a redundancy check in case you attempt to add duplicate EDS files to the catalog
NOTE: The Control Expert Hardware Catalog displays a partial collection of DTMs and EDS files registered with the ODVA. This library includes DTMs and EDS files for products not manufactured or sold by Schneider Electric. The non-Schneider Electric EDS files are identified by vendor in the catalog. Please contact the identified device’s manufacturer for inquiries regarding the corresponding non-Schneider Electric EDS files.
Adding EDS Files
To add one or more EDS files to the library:
Step Action
1 If the DTM Browser is not already open, in the Control Expert main menu select Tools →
DTM Browser.
2 In the DTM Browser, select a communication module, then click the right mouse button.
A pop-up menu opens.
3 In the pop-up menu, select Device menu → Add EDS to library.
The introductory page of the wizard opens.
100
S1A33985 12/2018
Step Action
4 Click Next.
Page 2 of the wizard opens:
Adding Devices to an Ethernet Network
S1A33985 12/2018
5 In the Select the Location of the EDS File(s) section, select either:
Add File(s), to add one or more EDS files you will individually select, or
Add all the EDS from the Directory, to add all files from a folder you will select.
Select Look in Subfolders to also add EDS files in subfolders beneath the folder you selected.
6 Click the Browse button.
The Open dialog opens.
7 Use the Open dialog to navigate to and select:
one or more EDS files, or
a folder containing EDS files
8 After you have made your selections, click Open.
The dialog closes and your selection appears in the Directory or File Name field.
101
Adding Devices to an Ethernet Network
Step Action
9 Choose the naming convention rule for the EDS DTM name creation.
The new naming convention is based on Model Name / Product Name and Revision. A random character is automatically suffixed when Model Name / Product Name and Revision of an EDS file of the library are identical. The new naming convention is irrespective of the order in which EDS files are added to device library.
By default, the New Naming Convention check box is selected and the new naming rule applies.
NOTE: To keep backward compatibility with Control Expert versions, unchecked the New Naming
Convention check box and the naming rule is based on Model Name / Product Name.
10 Click Next.
The wizard compares the selected EDS files against existing files in the library.
11 (Conditional) If one or more selected EDS files is a duplicate, a File Already Exists message opens.
Close the message.
12 Page 3 of the wizard opens indicating the Status of each device you attempted to add:
a green check mark indicates the EDS file can be added
a blue informational icon indicates a redundant file
a red exclamation point indicates an invalid EDS file
(Optional) Select a file in the list, then click View Selected File to open it.
13 Click Next to add the non-duplicate files.
Page 4 of the wizard opens, indicating the action is complete.
14 Click Finish to close the wizard.
15
The next step is to update the Control Expert Hardware Catalog (
added device is available for inclusion in a Control Expert project.
, so that the newly
102
S1A33985 12/2018
Adding Devices to an Ethernet Network
Updating the Control Expert Hardware Catalog
Updating Hardware Catalog
After you have followed the manufacturer’s instructions and installed a module or device DTM on your PC, the next step is to update the Control Expert Hardware Catalog. Updating the
Hardware Catalog makes the new Ethernet module or device available for addition to your Control
Expert application.
To update the Hardware Catalog:
Step Action
1 In the Control Expert main menu, select Tools → Hardware Catalog. The
Hardware Catalog window opens.
2 In the Hardware Catalog window, select the DTM Catalog tab to display a module and device DTM list. At the time of initial software installation, the catalog displays no devices:
3 Click the External Update Tool button. The FDT/DTM Catalog window opens:
4
S1A33985 12/2018
In the FDT/DTM Catalog window, click Update. The window refreshes itself, as indicated by the progress bar in the lower right corner of the window.
103
Adding Devices to an Ethernet Network
Step Action
5 After the update has finished, click Close. The FDT/DTM Catalog window closes and the Hardware Catalog displays.
6 In the Hardware Catalog window, click Reload catalog to refresh the DTM list.
104
S1A33985 12/2018
Adding Devices to an Ethernet Network
Remove an EDS File from the Control Expert Hardware Catalog
Overview
You can remove a module or device from the list of available devices in the Control Expert
Hardware Catalog by removing its EDS file. When you remove an EDS file from the library, the device or module is no longer displayed by Control Expert in the DTM Catalog page of the
Hardware Catalog window.
However, removing an EDS file from the library does not delete the file. Instead, the EDS file
remains in its stored location and can again be added to the catalog
time.
see page 100
Removing an EDS File from the Catalog
To remove an EDS file from the catalog:
Step
1
2
3
Action
If the DTM Browser is not already open, in the Control Expert main menu select
Tools → DTM Browser.
In the DTM Browser, select a communication module, then click the right mouse button.
A pop-up menu opens.
In the pop-up menu, select Device menu → Remove EDS from library.
The following window opens:
S1A33985 12/2018
105
Adding Devices to an Ethernet Network
5
6
7
8
9
10
Step
4
Action
Use the selection lists in the heading of this window to specify how EDS files will be displayed:
Display Filters the list of displayed EDS files; select:
All EDS (no filtering)
Only Devices
Only Chassis
Only Modules
Sort by
Displayed Name
Sorts the list of displayed EDS files; select:
File Name
Manufacturer
Category
Device Name
The description displayed for each device; select:
Catalog Name
Product Name
In the Device Library tree control, navigate to and select the EDS file you want to remove.
(Optional) Click the View Selected File button to display the read-only contents of the selected EDS file.
Click the Delete Selected File button. A message box opens.
Click Yes to remove the selected EDS file from the list.
When you have finished removing EDS files, click Close.
The next step is to update the Hardware Catalog
106
S1A33985 12/2018
Adding Devices to an Ethernet Network
Adding an EtherNet/IP Device to the Network Section 3.2
Adding an EtherNet/IP Device to the Network
Overview
This section extends the sample Control Expert application, by describing how to:
add an STB NIC 2212 EtherNet/IP network interface module to your Control Expert application
configure the STB NIC 2212 module configure EtherNet/IP connections linking the 140 NOC 771 01 communication module and the
STB NIC 2212 network interface module configure I/O items for the Advantys Island
NOTE: The instructions in this chapter describe a single, specific device configuration example.
Refer to the Control Expert help files for additional information about alternative configuration choices.
What Is in This Section?
This section contains the following topics:
Topic
Setting Up Your Network
Adding an STB NIC 2212 Remote Device
Configuring STB NIC 2212 Properties
Configuring EtherNet/IP Connections
Connecting to the Advantys STB Island
Configuring I/O Items
Page
S1A33985 12/2018
107
Adding Devices to an Ethernet Network
Setting Up Your Network
Overview
This sample network includes the following hardware and software:
a controller rack with:
140 CPS 114 X0, 115/230 VAC power supply
140 CPU 651 50 controller
140 NOC 771 01, Ethernet communication module
a remote STB Advantys island with:
STB NIC 2212 EtherNet/IP network interface module
STB PDT 3100 power distribution module
STB DDI 3230 2 pt digital input module
STB DDO 3200 2 pt digital output module
STB DDI 3420 4 pt digital input module
STB DDO 3410 4 pt digital output module
STB DDI 3610 6 pt digital input module
STB DDO 3600 6 pt digital output module
STB AVI 1270 2 pt analog input module
STB AVO 1250 2 pt analog output module a PC running both Unity Pro (version 5.0 or later) and Advantys configuration software (version
5.0 or later) an Ethernet managed switch that is connected to the both the controller and island by means of twisted pair Ethernet cable and RJ45 connectors.
108
S1A33985 12/2018
Adding Devices to an Ethernet Network
Network Topology
The Ethernet network devices used in this configuration include the following:
To re-create this example:
use the IP addresses for your own configuration’s:
PC
140 NOC 771 01 Ethernet communication module
STB NIC 2212 network interface module
check wiring
NOTE: Control Expert software running in the PC is used to configure the CPU 651 50 controller.
In this example, the PC is indirectly wired to the CPU’s Ethernet port via the Ethernet switch.
Alternatively, you could bypass the switch and directly wire the PC to either the CPU’s Modbus or
USB ports.
S1A33985 12/2018
109
Adding Devices to an Ethernet Network
Adding an STB NIC 2212 Remote Device
Overview
You can use the Control Expert device library to add a remote device—in this example the
STB NIC 2212 module—to your project. Only a remote device that is part of your Control Expert
device library can be added to your project. Refer to the topic describing the Add EDS File Wizard
see page 100
) for instructions on how to add a device EDS file to the device library.
Alternatively, with a remote device already added to your device library, you can use automatic device discovery to populate your project. Perform automatic device discovery by using the Field bus discovery command with a communication module selected in the DTM Browser.
In either case, you need to update the list of available modules and devices, as follows:
Step
1
2
2
Action
In the Control Expert main menu, select Tools → Hardware Catalog to display that window.
In the Hardware Catalog window, click on the DTM Catalog tab to open that page.
In the DTM Catalog page, click Reload catalog. The list of available devices, as displayed both in the DTM Catalog page and the Add dialog, is updated and reflects any device additions or deletions.
Adding an STB NIC 2212 Remote Device
To add the STB NIC 2212 to your project, follow these steps:
Step
1
2
Action
In the DTM Browser, select the Ethernet communication module node, and then click the right mouse button. A pop-up menu opens.
In the pop-up menu, select Add... The following dialog opens:
110
S1A33985 12/2018
Adding Devices to an Ethernet Network
Step
3
4
Action
In the Add dialog, select the STBNIC2212, then click Add DTM. The Properties window for the STB NIC 2212 network interface module opens.
In the General page of the Properties window, edit the default Alias name, because retaining the original default name can result in duplicate module names. In this example, type in the name NIC2212_01:
5
6
When you edit the Alias name, Control Expert applies it as the base for both structure and variable names.
NOTE: No additional editing needs to be performed in the pages of this window.
Except for the Alias name field, parameters are read-only.
Click OK. Control Expert adds the new STB NIC 2212 network interface module to the DTM Browser, beneath the communication module.
Refer to the topic Configuring Properties in the Device Editor
instructions on how to save your configuration edits.
The next step is to configure the device you have just added to the project.
S1A33985 12/2018
111
Adding Devices to an Ethernet Network
Configuring STB NIC 2212 Properties
Overview
Use the pages of the Device Editor to view and edit settings for a remote device. Before you can
edit the device settings, disconnect the DTM from the remote device (
see page 46
.
To display the DTM settings for a remote device, select the device name, which is found under the
Device List node in the left pane of the Device Editor.
For the purposes of this example, which configures an STB NIC 2212 network interface module, select the node named NIC2212 01. The Device Editor displays the following pages:
Properties
Address Setting
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to edit properties.
see page 54
for instructions
Configuring the Properties Page
The Properties page for an STB NIC 2212 network interface module looks like this:
112
S1A33985 12/2018
Adding Devices to an Ethernet Network
The following settings are used in this sample configuration. Use settings that are appropriate for your actual application:
Step
1
2
Action
In the Properties section of the page, edit the following:
Number The relative position of the device in the list, from 0 to 127.
For this example, accept the default of 003.
Active Configuration
Enabled: adds this device to the Control Expert project configuration
Disabled: removes this device from the Control Expert project configuration
Accept the default setting of Enabled.
In the IO Structure Name section of the page, edit the following:
Input area:
Structure Name (Read-only) Control Expert automatically assigns a structure name based on the variable name, in this case
T_NIC2212_01_IN.
Variable Name Accept the auto-generated input variable name (based on the alias name
( see page 110 ) ): NIC2212_01_IN.
Output area:
Structure Name
Variable Name
(Read-only) Control Expert automatically assigns a structure name based on the variable name, in this case
T_NIC2212_01_OUT.
Accept the auto-generated output variable name (based on the alias name): NIC2212_01_OUT.
Default Name button Restores the default variable and structure names. For this example, custom names are used instead of the default names.
S1A33985 12/2018
113
Adding Devices to an Ethernet Network
Step
3
Action
In the Items Management section of the page, edit the following:
Import mode
Automatic: Select this if I/O items are pre-defined for the device in its DTM, and will not subsequently be edited. These items are automatically created and added to the configuration, and later updated if the items list if the device DTM changes. These autocreated items cannot be edited in the Device Editor.
Manual: Select this if I/O items will be manually created or edited. If the device DTM pre-defines I/O items, those pre-defined I/O items are automatically created and added to the configuration, and can later be manually edited in the Device Editor. The I/O items list is not affected by changes to the device DTM.
NOTE:
Because the STB NIC 2212 DTM does not contain preconfigured input and output items, select Manual.
To view I/O items, navigate to and select the Items node in the left pane of the Device Editor, as follows:
4
Reimport Items Imports the I/O items list from the device DTM, overwriting any manual I/O item edits. Enabled only when Import mode is set to Manual.
Click Apply to save your edits, and leave the window open for further edits.
114
S1A33985 12/2018
Adding Devices to an Ethernet Network
Configuring the Address Setting Page
Use the Address Setting page to enable the DHCP client in the STB NIC 2212 network interface module. When the DHCP client is enabled in the remote device, it will obtain its IP address from the DHCP server in the Ethernet communication module. The Address Setting page looks like this:
S1A33985 12/2018
115
Adding Devices to an Ethernet Network
The following settings are used in this sample configuration. Use settings that are appropriate for your actual application:
Step
1
2
Action
In the Address Settings page, edit the following:
IP Address By default:
the first three octet values equal the first three octet
values of the Ethernet communication module, and the fourth octet value equals this device Number setting—in this case, the default value would be 004.
In our continuing example, type in the address
192.168.1.6.
DHCP for this Device
Enabled activates the DHCP client in this device. The device obtains its IP address from the DHCP service provided by the Ethernet communication module and
appears on the auto-generated DHCP client list
Disabled (the default) de-activates the DHCP client in this device.
Identified by
Select Enabled.
If DHCP for this Device is Enabled, this indicates the device identifier type:
MAC Address, or
Device Name
Identifier
Mask
Select Device Name.
If DHCP for this Device is Enabled, the specific device
MAC Address or Name value.
Accept the default setting of NIC2212_01 (based on the
Alias name).
The device subnet mask. The default = 255.255.255.0.
Accept the default value.
Gateway The gateway address used to reach this device. The default of 0.0.0.0 indicates this device is located on the same subnet as the Ethernet communication module.
Accept the default value.
Click OK to save your edits.
The next step is to configure the connection between the communication module and the remote device.
116
S1A33985 12/2018
Adding Devices to an Ethernet Network
Configuring EtherNet/IP Connections
Overview
An EtherNet/IP connection provides a communication link between two or more devices.
Properties for a single connection can be configured in the DTMs for the connected devices.
Use the Device Editor to view and edit connection settings. The following example presents settings for a connection between the 140 NOC 771 01 communication module and a remote
STB NIC 2212 network interface module. Configuration edits are made to the DTMs for each device.
For DTM edits, disconnect the selected DTM from the actual module or device (
see page 46
.
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to edit properties.
see page 54
for instructions
Configuring Connection Settings in the Communication Module DTM
Control Expert automatically creates a connection between a communication module and remote device, when the remote device is added to the Control Expert project. Thereafter, many edits to the connection can be made in the DTM for the remote device. However, some of the connection parameters can also be configured in the DTM for the communication module, as demonstrated below.
The following connection settings for this sample configuration can be set in the DTM for the communication module. Use settings that are appropriate for your actual application:
Step
1
2
Action
Open the DTM for the communications module—in this example NOC01—by selecting it in the
Device Editor, then do one of the following:
in the main menu, select Edit → Open, or click the right mouse button, and select Open in the pop-up menu
The communication module DTM opens in the Device Editor.
In the navigation pane (on the left side of the Device Editor) select the node representing the connection from the communication module to the remote device, in this case:
Device List → NIC2212_01 → Read Input / Write Output Data
S1A33985 12/2018
117
Adding Devices to an Ethernet Network
Step
3
Action
Click on the Connection Settings tab to open the following page:
118
4
5
NOTE: You can view the Time-out Multiplier parameter, when Control Expert is operating in
Advanced Mode.
In the Connection Settings page, edit the following settings:
Connection Bit (Read-only) The offset for both the health bit and the control bit for this connection. Offset values are auto-generated by the Control Expert
Ethernet Configuration Tool, beginning at 0, and are prioritized according to the connection type, as follows:
1 Modbus TCP connections
2 local slave connections
3 EtherNet/IP connections
NOTE: The initial value of this EtherNet/IP connection is 1, because only a single local slave has previously been enabled. When a single
Modbus TCP connection is created, the value of this connection bit offset changes to 2.
Request Packet
Interval (RPI)
The refresh period for this connection, from 2 to 65535 ms. Default =
12 ms. Type in 30 ms.
NOTE: This parameter can be set in the DTM for the communication module or the remote device.
Time-out Multiplier This setting, multiplied against the RPI, produces a value that triggers an inactivity timeout. Setting selections include: x4, x8, x16, x32, x64, x128, x256 and x512.
Accept the default of x4.
NOTE: The Connection Information page is read-only when the communication module is selected. This information needs to be set in the DTM for the remote device.
Click OK to save your settings.
S1A33985 12/2018
Adding Devices to an Ethernet Network
Configuring Connection Settings in the Remote Device DTM
Connections between a communication module and remote device can be created and edited in the DTM for the remote device.
In this example, the following configuration edits are made to the connection that Control Expert automatically created, when the remote device was added to the project. Use settings that are appropriate for your actual application:
Step
1
2
3
Action
Open the DTM for the remote device—in this example NIC2212_01—by selecting it in the
Device Editor, then do one of the following:
in the main menu, select Edit → Open, or click the right mouse button, and select Open in the pop-up menu b c
The remote device DTM opens in the Device Editor.
In the navigation pane (on the left side of the Device Editor), confirm that the remote device connection is of the type Read Input / Write Output Data. To view the connection type, select
NIC2212_01 in the left pane of the Device Editor. If the connection type is not of the type Read
Input / Write Output Data, delete the existing connection and add a new one, as follows: a With the connection selected in the left pane, click the Remove Connection button.
The existing connection is removed.
Click the Add Connection button. The Select the connection to add dialog opens.
d
Use the scroll buttons on the drop down list to display and select the Read Input /
Write Output Data connection type.
Click OK to close the Select the connection to add dialog. The new connection node appears. e Click Apply to save the new connection, leaving the Device Editor open for additional edits.
With the Read Input / Write Output Data node selected, click on the General tab:
S1A33985 12/2018
119
Adding Devices to an Ethernet Network
Step
4
Action
In the General page, edit the following settings:
RPI
Input size
The refresh period for this connection. Accept the value of 30 ms. (This parameter can be set in the DTM for the communication module or the remote device.)
The number of bytes reserved for input data, from 0 to 505. Type in 19.
NOTE: Control Expert reserves input data in increments of 2 bytes (1 word). In this example, typing in the value of 19 bytes reserves 20 bytes of input memory.
Input mode The transmission type:
Multicast
Point to Point
Input type
Accept the default selection of Multicast.
Ethernet packet type—fixed or variable length—to be transmitted. Only Fixed length packets are supported.
Input priority The transmission priority. The value depends upon the device DTM. Values can include:
Low
High
Scheduled
NOTE: For remote modules that support more than one priority value, you can use this setting to specify the order in which the Ethernet communication module will handle packets. For more information, refer to the topic describing QoS Packet
Prioritization (see Premium using EcoStruxure™ Control Expert, TSX ETC 101
Ethernet Communication Module, User Manual) .
For the purpose of this example, accept the default selection of Scheduled.
Input trigger The transmission trigger. Values can include:
Cyclic
Change of state or application
For input I/O data, select Cyclic.
Output size The number of bytes reserved for output data, from to 509. Type in 6.
NOTE: Control Expert reserves output data in increments of 2 bytes (1 word).
Output mode Accept the default selection of Point to Point.
Output type (Read-only). Only Fixed length packets are supported.
Output priority
Accept the default selection of Scheduled.
120
S1A33985 12/2018
Step
5
Adding Devices to an Ethernet Network
Action
Click on the Identity Check tab to open the following page:
S1A33985 12/2018
121
Adding Devices to an Ethernet Network
Step
6
7
Action
In the Identity Check page, set rules for comparing the identity of the remote device, as defined by its DTM or EDS file, against the identity of the actual remote device located on the network.
Complete the following settings:
Check
Identity
Define the rule Control Expert will use in comparing the configured versus the actual remote device. Settings include:
Must match exactly—the DTM or EDS file exactly matches the remote device
Disable—no checking occurs; the identity portion of the connection is filled with zero values (the default setting)
Must be compatible—if the remote device is not the same as defined by the
DTM/EDS, it emulates the DTM/EDS definitions
None—no checking occurs; the identity portion of the connection is omitted
Custom—enables the following 6 parameter settings, to be set individually.
For this example, select Disable.
If Check identity is set to Custom, complete the following 6 fields:
Compatibility
Mode
Minor
Version
Major
Version
True—for each of the following selected tests, the DTM/EDS and remote device need only be compatible
False—for each of the following selected tests, the DTM/EDS and the remote device need to match exactly
For each of the parameters to the left, select one of the following settings:
Compatible—include the parameter in the test
Not checked—do not include the parameter in the test
Product
Code
Product
Type
Product
Vendor
Click OK to save your settings.
The next step is to configure I/O settings.
122
S1A33985 12/2018
Adding Devices to an Ethernet Network
Connecting to the Advantys STB Island
Overview
In this example, you will use the Advantys configuration software running on your PC to:
connect the Advantys configuration software to the STB NIC 2212 and the 8 I/O modules that comprise the Advantys STB island upload Advantys STB island configuration to the Advantys configuration software in your PC display a fieldbus image for the Advantys STB island showing the relative location of:
status information input data output data
Using the data presented in the fieldbus image, you can use Control Expert to create input and output items that map to specific status, input, output, and output echo data.
NOTE: Before proceeding with the following instructions, confirm that you have auto-configured the Advantys STB island by pressing the RST button on the front of the STB NIC 2212 module.
Making the Connection
To connect to the STB NIC 2212 and I/O modules using the Advantys configuration software:
Step Action
1 Startup the Advantys configuration software on your PC. A dialog opens displaying available project types.
2 Select STB.
3 Select File → New Workspace. The New Workspace window opens (below).
4 For this example, type in the following field values:
for the field Workspace File type in Advantys
for the field Island File type in Advantys_01
S1A33985 12/2018
5 Click OK. The Advantys configuration software displays an empty DIN rail in the center of the screen.
123
Adding Devices to an Ethernet Network
Step Action
6 Select Online → Connection Settings. The Connection Settings window opens
(below).
7 In the Connection Settings window, accept the Modbus Node ID default setting of 1, select TCP/IP, and click the Settings... button:
The TCP/IP Parameters dialog opens (below).
8 In the Remote IP Address field, type in the IP address for the STB NIC 2212, in this example: 192.168.1.6.
9 Click OK to close the TCP/IP Parameters dialog, and click OK again to close the
Connection Settings dialog.
10 Select Online → Connect. The Data Transfer dialog opens (below):
124
S1A33985 12/2018
Adding Devices to an Ethernet Network
Step Action
11 Select Upload in the Data Transfer dialog. The island workspace is populated with island data and shows the STB NIC 2212 and the island modules (below):
S1A33985 12/2018
Note: A box appears beneath each module containing one or two integers—for example . These integers serve the following purpose:
The left-side integer (3 in this example) identifies the module’s physical position— left to right—among the modules in the rack.
The right-side integer (1 in this example) identifies the module’s relative position—left to right—among only data producing/receiving modules. If the module is not a data producing/receiving module (e.g. a power supply, or end of segment module) no right-side integer appears.
125
Adding Devices to an Ethernet Network
Step Action
12 Select Island → I/O Image Overview. The I/O Image window opens to the Fieldbus
Image page:
126
Each table cell contains one of the following alpha-numeric indicators:
S indicates a status bit for the STB NIC 2212 network interface module
an integer identifies the relative position—from left to right—of a data producing/receiving module with input or output data in that cell. For example:
the STB DDI 3230 input module is the first data producing or receiving module
in the rack; its data is designated by the integer 1 in bits 0 - 3 of word 2 in the
Input Data table the STB DDO 3600 output module is the sixth data producing module in the rack; its status and output echo data is designated by the integer 6 in bits 8 -
13 of word 4 and in bits 0 - 5 of word 5 in the Input Data table; its output data is designated by the integer 6 in bits 8 - 13 of word 1 in the Output Data table
Notes:
Select a cell in either the Input Data or Output Data tables to display—in the middle of the page—a description of the cell data and its source module.
Convert the size of the Input Data table and the Output Data table from words to bytes (i.e. divide by 2), then use that data as the values for the Input Size (19) and
Output Size (6) parameters when configuring the remote device’s connection properties.
S1A33985 12/2018
Adding Devices to an Ethernet Network
Configuring I/O Items
Overview
The final task in this example is to add I/O items to the configuration of the STB NIC 2212 and its
8 I/O modules. To accomplish this:
use the Advantys configuration software to identify the relative position of each I/O module’s inputs and outputs use the Control Expert Device Editor to create input and output items, defining each item’s:
name
data type
I/O Item Types and Sizes
The goal is to create a collection of input items and output items that equal the input size and output size specified for the STB NIC 2212
see page 119
) . In this example, items need to be created for:
19 bytes of inputs
6 bytes of outputs
The Control Expert Device Editor provides great flexibility in creating input and output items. You can create input and output items in groups of 1 or more single bits, 8-bit bytes, 16-bit words, 32bit dwords, or 32-bit IEEE floating values. The number of items you create depends upon the data type and size of each item.
In the sample project, the following items were created:
discrete bits for digital inputs and outputs
8-bit bytes or 16-bit words for analog inputs and outputs
Mapping Input and Output Items
Use the Fieldbus Image page of the I/O Image Overview window in the Advantys configuration software to identify the number and type of I/O items you need to create, as follows:
3
4
Step
1
2
Action
In the Advantys configuration software, select Island → I/O Image Overview. The I/O Image window opens to the Fieldbus Image page.
Select the first cell (word 1, cell 0) in the Input Data table to display, in the middle of the page, a description of the cell data and its source module.
Make a note of the word, bit(s), module and item information for that cell.
Repeat steps 2 and 3 for each cell containing either an S or an integer.
NOTE: The Fieldbus Image presents input and output data in the form of 16-bit words (starting with word 1). You need to rearrange this data for the Control Expert Ethernet Configuration Tool, which presents the same data in the form of 8-bit bytes (starting with byte 0).
NOTE: When you create items, align items of data type WORD and DWORD on a 16-bit boundary.
S1A33985 12/2018
127
Adding Devices to an Ethernet Network
This process yields the following tables of input and output data:
Input Data:
Advantys Fieldbus Image
Word Bit(s)
1 0-15
2
3
4
5
6
7
8
9
10
0-1
2-3
4-5
6-7
8-11
12-15
0-3
4-7
8-13
14-15
0-5
6-7
8-13
14-15
0-5
6-15
0-15
0-7
8-15
0-15
0-7
8-15
0-7
8-15
11
12
13
14
8
8
9
10
15
16
17
18
NA
0
1
Control Expert EIP Items
Byte Bit(s)
2
0-7
0-7
0-1
2-3
4-5
6-7
3
4
5
6
4-7
0-5
6-7
0-5
0-3
4-7
0-3
7
0-7
0-7
0-7
NA
0-7
0-7
0-7
0-7
6-7
0-7
0-7
0-7
6-7
0-5
6-7
0-5
STB Module
NIC 2212
AVI 1270
AVI 1270
NA
AVI 1270
AVI 1270
AVO 1250
AVO 1250
NA
DDI 3230
DDI 3230
DDO 3200
DDO 3200
DDI 3420
DDI 3420
DDO 3410
DDO 3410
DDI 3610
NA
DDI 3610
NA
DDO 3600
NA
DDO 3600
NA
Description low byte status high byte status input data input status output data echo output status input data input status output data echo output status input data not used input status not used output data echo not used output status not used input data ch 1 input status ch 1 not used input data ch 2 input status ch 2 output status ch 1 output status ch 2 not used
128
S1A33985 12/2018
Adding Devices to an Ethernet Network
Output Data:
Advantys Fieldbus Image
Word Bit(s)
1 0-1
2-5
2
6-7
8-13
14-15
0-15
3 0-15 4
5
2
3
Control Expert EIP Items
Byte Bit(s)
0 0-1
2-5
1
6-7
0-5
6-7
0-7
0-7
0-7
0-7
Module
DDO 3200
DDO 3410
NA
DDO 3600
NA
AVO 1250
AVO 1250
Description output data output data not used output data not used output data ch 1 output data ch 2
This example shows you how to create 19 bytes of inputs and 6 bytes of outputs. To achieve a more efficient usage of space, this example creates items in the following sequence:
input bit items input byte and word items
output bit items output byte and word items
Creating Input Bit Items
To create input bit items for the STB NIC 2212 example, beginning with 16 discrete inputs for
NIC 2212 status:
Step
1
Action
In the DTM Browser, select the communication module:
S1A33985 12/2018
2 Do one of the following:
in the main menu, select Edit → Open, or
click the right mouse button, then select Open in the pop-up menu.
The Device Editor opens, displaying the DTM for the communication module.
129
Adding Devices to an Ethernet Network
Step
3
Action
In the left pane of the Device Editor, navigate to and select the Items node for the STB NIC 2212 network interface module:
4 The Items window opens:
130
5
6
Select the Input (bit) tab to display that page.
In the Input (bit) page, type the following default root name—representing device status—into the
Default Items Name Root input box type: DDI3232_in_data.
S1A33985 12/2018
Step
7
Adding Devices to an Ethernet Network
Action
In the Items List, select the first 2 rows in the table. (These rows represent bits 0-1 in byte.)
8 Click the Define Item(s) button.The Item Name Definition dialog opens:
S1A33985 12/2018
Note: The asterisk (*) indicates a series of discrete items with the same root name will be created.
131
Adding Devices to an Ethernet Network
Step
9
Action
Accept the default Item Name and click OK. 2 discrete input items are created:
132
10
11
12
Click Apply to save the items, and leave the page open.
Repeat steps 6 - 10 for each group of discrete input items you need to create. In this example, that includes items for each of the following groups:
Byte: 0, Bits: 2-3, Default Items Name Root: DDI3230_in_st
Byte: 0, Bits: 4-5, Default Items Name Root: DDO3200_out_echo
Byte: 0, Bits: 6-7, Default Items Name Root: DDO3200_out_st
Byte: 1, Bits: 0-3, Default Items Name Root: DDI3420_in_data
Byte: 1, Bits: 4-7, Default Items Name Root: DDI3420_in_st
Byte: 2, Bits: 0-3, Default Items Name Root: DDO3410_out_echo
Byte: 2, Bits: 4-7, Default Items Name Root: DDO3410_out_st
Byte: 3, Bits: 0-5, Default Items Name Root: DDI3610_in_data
Byte: 4, Bits: 0-5, Default Items Name Root: DDI3610_in_st
Byte: 5, Bits: 0-5, Default Items Name Root: DDO3600_out_echo
Byte: 6, Bits: 0-5, Default Items Name Root: DDO3600_out_st
The next task is to create input bytes and words.
S1A33985 12/2018
Adding Devices to an Ethernet Network
Creating Input Items
To create input items for the STB NIC 2212 example, begin with an input data byte containing low byte status for the STB NIC 2212 module:
Step
1
Action
Select the Input tab to return to that page:
2
NOTE: In this example, both the Offset/Device and Offset/Connection columns represent the byte address. The items you create will be either an 8-bit byte or a 16-bit word
In the Default Item Name Root input box type: NIC22212_01_LO_st.
S1A33985 12/2018
133
Adding Devices to an Ethernet Network
Step
3
Action
Starting at the first available whole input word, select the single row at byte 8:
4 Click the Define Item(s) button.The Item Name Definition dialog opens:
134
S1A33985 12/2018
Adding Devices to an Ethernet Network
Step
5
Action
Select Byte as the New Item(s) Data Type, then click OK. A new byte item is created:
S1A33985 12/2018
6
7
8
Click Apply to save the new items, and leave the page open.
Repeat steps 2 - 6 for each byte or word input item you need to create.
NOTE: The number of rows you select for a new item depends upon the item type. If the item is a:
byte: select a single row word: select two rows, beginning at the next available whole word
In this example, you will create items for each of the following:
Byte: 9, Default Items Name Root: NIC2212_01_HI_st
Word: 10, Default Items Name Root: AVI1270_CH1_in_data
Byte: 12, Default Items Name Root: AVI1270_CH1_in_st
Word: 14-15, Default Items Name Root: AVI1270_CH2_in_data
Byte: 16, Default Items Name Root: AVI1270_CH2_in_st
Byte: 17, Default Items Name Root: AVO1250_CH1_out_st
Byte: 18, Default Items Name Root: AVO1250_CH2_out_st
The next task is to create output bits.
135
Adding Devices to an Ethernet Network
Creating Output Bit Items
To create output bit items for the STB NIC 2212 example, beginning with 2 output bits for the
STB DDO3200 module:
Step
1
Action
Select the Output (bit) tab to open the following page:
2
3
NOTE: Both the Offset/Device and Offset/Connection columns represent the byte address of an output, while the Position in Byte column indicates the bit position—within the byte—of each discrete output item.
In the Default Items Name Root input box type: DDO3200_out_data.
In the Items List, select the rows that correspond to bits 0-1 in byte 0—i.e., the first 2 rows:
136
S1A33985 12/2018
Adding Devices to an Ethernet Network
Step
4
Action
Click the Define Item(s) button.The Item Name Definition dialog opens:
5
NOTE: The asterisk (*) indicates a series of discrete items with the same root name will be created.
Accept the default output name and click OK. 2 discrete output items are created:
S1A33985 12/2018
6
7
8
Click Apply to save the new items, and leave the page open.
Repeat steps 2 - 6 for each group of discrete output items you need to create. In this example, that includes items for each of the following groups:
Byte: 0, Bits: 2-5, Default Items Name Root: DDO3410_out_data
Byte: 1, Bits: 0-5, Default Items Name Root: DDO3600_out_data
The next task is to create output bytes and words.
137
Adding Devices to an Ethernet Network
Creating Numeric Output Items
To create output items for the STB NIC 2212, example, beginning with a output data word for the
STB AVO 1250 module:
Step
1
Action
Click on the Output tab to open the following page:
2
3
NOTE: In this example, both the Offset/Device and Offset/Connection columns represent the byte address. The items you create will be 16-bit words comprising 2 bytes.
In the Default Item Name Root input box type: AVO1250_CH1_out_data.
Starting at the next available whole word, select 2 rows: 2 and 3:
138
S1A33985 12/2018
Step
4
Adding Devices to an Ethernet Network
Action
Click the Define Item(s) button.The Item Name Definition dialog opens:
5 Accept the default output name and click OK. the following output word item is created:
S1A33985 12/2018
8
9
6
7
Click Apply to save the new item and leave the page open.
Repeat steps 2 - 6 for the AVO 1250 channel 2 output data at bytes 4 and 5.
Click OK to close the Items window.
Select File → Save to save your edits.
139
Adding Devices to an Ethernet Network
Adding a Modbus TCP Device to the Network Section 3.3
Adding a Modbus TCP Device to the Network
Overview
This section extends the sample Control Expert application, by describing how to:
add an STB NIP 2212 Modbus TCP network interface module to your Control Expert application
configure the STB NIP 2212 module configure a Modbus TCP connection linking the 140 NOC 771 01 communication module and the STB NIP 2212 network interface module
NOTE: The instructions in this chapter describe a single, specific device configuration example.
Refer to the Control Expert help files for additional information about alternative configuration choices.
What Is in This Section?
This section contains the following topics:
Topic
Setting Up Your Network
Adding an STB NIP 2212 Remote Device
Configuring STB NIP 2212 Properties
Connecting to the Advantys STB Island
Configuring I/O Items
Page
140
S1A33985 12/2018
Adding Devices to an Ethernet Network
Setting Up Your Network
Overview
This sample network includes the following hardware and software:
a controller rack with:
140 CPS 114 X0, 115/230 VAC power supply
140 CPU 651 50 controller
140 NOC 771 01, Ethernet communication module
a remote STB Advantys island with:
STB NIP 2212 Modbus TCP network interface module
STB PDT 3100 power distribution module
STB DDI 3230 2 pt digital input module
STB DDO 3200 2 pt digital output module
STB DDI 3420 4 pt digital input module
STB DDO 3410 4 pt digital output module
STB DDI 3610 6 pt digital input module
STB DDO 3600 6 pt digital output module
STB AVI 1270 2 pt analog input module
STB AVO 1250 2 pt analog output module a PC running both Unity Pro (version 5.0 or later) and Advantys configuration software (version
5.0 or later) an Ethernet managed switch that is connected to the both the controller and island by means of twisted pair Ethernet cable and RJ45 connectors.
S1A33985 12/2018
141
Adding Devices to an Ethernet Network
Network Topology
The Ethernet network devices used in this configuration include the following:
142
To re-create this example:
use the IP addresses for your own configuration’s:
PC
140 NOC 771 01 Ethernet communication module
STB NIP 2212 network interface module
check wiring
NOTE: Control Expert software running in the PC is used to configure the CPU 651 50 controller.
In this example, the PC is indirectly wired to the CPU’s Ethernet port via the Ethernet switch.
Alternatively, you could bypass the switch and directly wire the PC to either the CPU’s Modbus or
USB ports.
S1A33985 12/2018
Adding Devices to an Ethernet Network
Adding an STB NIP 2212 Remote Device
Overview
Use the generic Modbus DTM selection, in the Add dialog, to select and insert an STB NIP 2212 module to your project.
Adding an STB NIP 2212 Remote Device
To add the STB NIP 2212 to your project, follow these steps:
Step
1
2
Action
In the DTM Browser, select the Ethernet communication module node, and then click the right mouse button. A pop-up menu opens.
In the menu, select Add... The following dialog opens:
3 In the Add dialog, select the STBNIP2212, then click Add DTM. The Properties window for the STB NIP 2212 network interface module opens.
S1A33985 12/2018
143
Adding Devices to an Ethernet Network
Step
4
Action
In the General page of the Properties window, edit the default Alias name to read
NIP2212_01:
144
5
6
When you edit the Alias name, Control Expert applies it as the base name for both structure and variable names.
NOTE: No additional editing needs to be performed in the pages of this window.
Except for the Alias name field, parameters are read-only.
Click OK. Control Expert adds the new STB NIP 2212 network interface module to the DTM Browser, beneath the communication module.
Refer to the topic Configuring Properties in the Device Editor
instructions on how to save your configuration edits.
The next step is to configure the device you have just added to the project.
S1A33985 12/2018
Adding Devices to an Ethernet Network
Configuring STB NIP 2212 Properties
Overview
Use the pages of the Device Editor to view and edit settings for a remote device. To edit the device settings, disconnect the DTM from the remote device
see page 46
.
To display the DTM settings for a remote device, select the device name, which is found under the
Device List node in the left pane of the Device Editor.
For the purposes of this example, which configures an STB NIP 2212 network interface module, select the node named NIP2212 01. The Device Editor displays the following pages:
Properties
Address Setting
Request Setting
NOTE: Refer to the topic Configuring Properties in the Device Editor
on how to edit properties.
see page 54
for instructions
S1A33985 12/2018
145
Adding Devices to an Ethernet Network
Configuring the Properties Page
Use the Properties page to:
add the remote device to, or remove it from, the configuration
edit the base name for variables and data structures used by the remote device indicate how input and output items will be created and edited
The Properties page for an STB NIP 2212 network interface module looks like this:
146
S1A33985 12/2018
Adding Devices to an Ethernet Network
The following settings are used in this sample configuration. Use settings that are appropriate for your actual application:
Step
1
2
3
4
Action
In the Properties section of the page, edit the following:
Number
Active Configuration
The relative position of the device in the list, from 0...127.
For this example, accept the default of 004.
Enabled: adds this device to the Control Expert project configuration
Disabled: removes this device from the Control Expert project configuration
Accept he default setting of Enabled.
In the IO Structure Name section of the page, edit the following:
Input area:
Structure Name
Variable Name
(Read-only) Control Expert automatically assigns a structure name based on the variable name, in this case T_NIP2212_01_IN.
Accept the auto-generated variable name (based on the alias name
( see page 143 ) ): NIP2212_01_IN.
Output area:
Structure Name
Variable Name
(Read-only) Control Expert automatically assigns a structure name based on the variable name, in this case T_NIP2212_01_OUT.
Accept the auto-generated variable name (based on the alias name):
NIP2212_01_OUT.
Default Name button Restores the default variable and structure names. For this example, custom names are used instead of default names.
In the Items Management section of the page, edit the following:
Import mode
Automatic: I/O items are taken from the device DTM and updated if the items list in the device DTM changes. Items cannot be edited in the Device Editor.
Manual: I/O items are manually added in the Device Editor. The
I/O items list is not affected by changes to the device DTM.
Reimport Items
In this example, select Manual.
Imports the I/O items list from the device DTM, overwriting any manual I/O item edits. Enabled only when Import mode is set to
Manual.
Click Apply to save your edits, and leave the window open for further edits.
S1A33985 12/2018
147
Adding Devices to an Ethernet Network
Configuring the Address Setting Page
Use the Address Setting page to:
configure the IP address for the remote device
enable, or disable, DHCP client software for the remote device
When the DHCP client software is enabled in the remote device, it will obtain its IP address from the DHCP server in the Ethernet communication module. The Address Setting page looks like this:
148
S1A33985 12/2018
Adding Devices to an Ethernet Network
The following settings are used in this sample configuration. Use settings that are appropriate for your actual application:
Step
1
2
Action
In the Address Settings page, edit the following:
IP Address By default:
the first three octet values equal the first three octet values of the
Ethernet communication module, and the fourth octet value equals this device Number setting—in this case, 004.
In this example, the IP address is 192.169.1.7.
DHCP for this Device
Enabled activates the DHCP client in this device. The device obtains its IP address from the DHCP service provided by the
Ethernet communication module and appears on the autogenerated DHCP client list
Disabled (the default) de-activates the DHCP client in this device.
Identified by
Select Enabled.
If DHCP for this Device is Enabled, this indicates the device identifier type:
MAC Address, or
Device Name
Identifier
Mask
Select Device Name.
If DHCP for this Device is Enabled, the specific device MAC Address or Name value.
Accept the default setting of NIP2212_01 (based on the Alias name).
The device subnet mask. The default = 255.255.255.0.
Accept the default value.
Gateway The gateway address used to reach this device. The default of 0.0.0.0 indicates this device is located on the same subnet as the Ethernet communication module.
Accept the default value.
Click Apply to save your edits, and leave the window open for further edits.
The next step is to configure the connection between the communication module and the remote device.
S1A33985 12/2018
149
Adding Devices to an Ethernet Network
Configuring the Request Setting Page
Use the Request Setting page to add, configure, and remove Modbus requests for the remote device. Each request represents a separate link between the communication module and the remote device.
The Request Setting page for an STB NIP 2212 network interface module looks like this:
The Add Request function is enabled only when Import Mode is set to Manual.
150
S1A33985 12/2018
Adding Devices to an Ethernet Network
The following settings are used in this sample configuration. Use settings that are appropriate for your actual application:
Step Action
1 In the Request Settings page, edit the following:
Connection
Bit
(Read-only) The offset for both the health bit and the control bit for this connection. Offset values are auto-generated by the Control Expert Ethernet Configuration Tool—starting at
0—based on the connection type, in the following order:
1. Modbus TCP connections
2. Local Slave connections
3. EtherNet/IP connections
Unit ID
NOTE: When this Modbus TCP connection is created, the offset values for the previously created local slave and EtherNet/IP connections are incremented by 1: the local slave connection bit is set to 1, and the EtherNet/IP connection bit value is set to 2.
The number of the device, or module, that is the target of the connection. A value of:
255 (the default) used to access the Ethernet communication module itself
0...254 identifies the device number of the target device, behind a Modbus TCP to
Modbus gateway
NOTE: When accessing data in the Ethernet communication module itself, use 255.
When accessing data in the application running in the PLC, use a value from 0 to 254 (a value of 1 is recommended).
Health
Timeout
Repetitive
Rate
RD
Address
Because the remote device itself is the request target, accept the default value of 255.
The maximum allowed period, in milliseconds, between device responses, from
0...120000 ms in increments of 5 ms. When this setting is exceeded, the health timeout bit is set to 1. The default = 1500 ms. Accept the default value of 1500.
The data scan rate, from 0...60000 ms, in intervals of 5 ms. The default = 60 ms. Accept the default value of 60.
Address in the remote device of the input data image. The input data image begins at word 45392. Because there is an offset of 40000 in the Quantum platform, type in a value of 5392.
RD Length The number of words in the remote device, from 0...125, that the communication module will read. Because the Modbus device will be configured for 18 words of input items, type in a value of 18.
Last Value The behavior of inputs in the application in the event communication is lost:
Hold Value (the default)
Set To Zero
2
Accept the default.
WR
Address
Address in the remote device of the output data image. The output data image begins at word 40001. Because there is an offset of 40000 in the Quantum platform, type in a value of 1.
WR Length The number of words in the remote device, from 0...120, to which the communication module will write. Because the Modbus device will be configured for 5 words of output items, type in a value of 5.
Click OK to save your edits, and close the window.
The next step is to connect the Control Expert project to the Advantys Island.
S1A33985 12/2018
151
Adding Devices to an Ethernet Network
Connecting to the Advantys STB Island
Overview
In this example, you will use the Advantys configuration software running on your PC to:
connect the Advantys configuration software to the STB NIP 2212 and the 8 I/O modules that comprise the Advantys STB island upload Advantys STB island configuration to the Advantys configuration software in your PC display a fieldbus image for the Advantys STB island showing the relative location of:
input data output data
Using the data presented in the fieldbus image, you can use Control Expert to create input and output items that map to specific input, output, and output echo data.
NOTE: Before proceeding with the following instructions, confirm that you have auto-configured the Advantys STB island by pressing the RST button on the front of the STB NIP 2212 module.
Making the Connection
To connect to the STB NIP 2212 and I/O modules using the Advantys configuration software:
Step Action
1 Startup the Advantys configuration software on your PC. A dialog opens displaying available project types.
2 Select STB.
3 Select File → New Workspace. The New Workspace window opens (below).
4 For this example, type in the following field values:
for the field Workspace File type in Advantys
for the field Island File type in Advantys_02
152
5 Click OK. The Advantys configuration software displays an empty DIN rail in the center of the screen.
S1A33985 12/2018
Adding Devices to an Ethernet Network
Step Action
6 Select Online → Connection Settings. The Connection Settings window opens
(below).
7 In the Connection Settings window, accept the Modbus Node ID default setting of 1, select TCP/IP, and click the Settings... button:
The TCP/IP Parameters dialog opens (below).
8 In the Remote IP Address field, type in the IP address for the STB NIP 2212, in this example: 192.168.1.7.
p
9 Click OK to close the TCP/IP Parameters dialog, and click OK again to close the
Connection Settings dialog.
10 Select Online → Connect. The Data Transfer dialog opens (below):
S1A33985 12/2018
153
Adding Devices to an Ethernet Network
Step Action
11 Select Upload in the Data Transfer dialog. The island workspace is populated with island data and shows the STB NIP 2212 and the island modules (below):
154
Note: A box appears beneath each module containing one or two integers—for example . These integers serve the following purpose:
The left-side integer (3 in this example) identifies the module’s physical position— left to right—among the modules in the rack.
The right-side integer (1 in this example) identifies the module’s relative position—left to right—among only data producing/receiving modules. If the module is not a data producing/receiving module (e.g. a power supply, or end of segment module) no right-side integer appears.
S1A33985 12/2018
Adding Devices to an Ethernet Network
Step Action
12 Select Island → I/O Image Overview. The I/O Image window opens to the Fieldbus
Image page:
S1A33985 12/2018
Each table cell contains an integer that identifies the relative rack position of a data producing/receiving module with input or output data in that cell. For example:
the STB DDI 3230 input module is the first data producing or receiving module in the rack; its data and status information is indicated by the integer 1 in bits 0...1
of registers 45392 and 45393 in the Input Data table the STB DDO 3600 output module is the sixth data producing module in the rack; its output echo and status data is designated by the integer 6 in bits 0 - 5 of register 45402 and in bits 0 - 5 of register 45403 in the Input Data table; its output data is designated by the integer 6 in bits 0 - 5 of register 40003 in the Output
Data table
NOTE:
Select a cell in either the Input Data or Output Data tables to display—in the middle of the page—a description of the cell data and its source module.
Convert the size of the Input Data table and the Output Data table from words to bytes (i.e. divide by 2), then use that information when setting the RD Length
(inputs) and WR Length (outputs) parameters in the Request Setting page for the remote Modbus TCP device.
155
Adding Devices to an Ethernet Network
Configuring I/O Items
Overview
The next task in this example is to add I/O items to the configuration of the STB NIP 2212 and its
8 I/O modules. To accomplish this:
Use the Modbus Image page of the Advantys configuration software to identify the relative position of each I/O module’s inputs and outputs.
Use the Control Expert Device Editor to create input and output items, defining each item’s:
name
data type
NOTE: You can manually configure I/O items only when Input Mode is set to Manual.
I/O Item Types and Sizes
Because the Modbus TCP network interface module transmits data in the form of 16-bit words, in this example you will create every input and output item using the WORD data type. This remains true even if the item contains only a few bits of data. Bit-packing is not permitted when, as in this example, the remote device is a Modbus TCP network interface module.
NOTE: When you add more devices to your network, it may be necessary to increase the size and
index location of both inputs and outputs for your Control Expert project (
see page 36
.
In this example, the following number and type of items need to be created:
18 input words
5 output words
Mapping Input and Output Items
Use the Fieldbus Image page of the I/O Image Overview window in the Advantys configuration software to identify the number and type of I/O items you need to create, as follows:
3
4
Step
1
2
Action
In the Advantys configuration software, select Island → I/O Image Overview. The I/O Image window opens to the Modbus Image page.
Select the cell 0 of the first word (45392) in the Input Data table to display—in the middle of the page—a description of the cell data and its source module.
Make a note of the register number and item information for that word.
Repeat steps 2 and 3 for each word.
156
NOTE: The Modbus Image presents input and output data in the form of 16-bit words (starting with word 1). You need to maintain this data format as you create input and output items in Control
Expert.
NOTE: When you create items, align items of data type WORD and DWORD on a 16-bit boundary.
This process yields the following tables of input and output data:
S1A33985 12/2018
Adding Devices to an Ethernet Network
Input Data (Read):
Advantys Modbus Image
Register Bit(s)
45392 0-1
45401
45402
45403
45404
45405
45406
45407
45397
45398
45399
45400
45393
45394
45395
45396
0-7
0-15
0-7
0-5
0-5
0-5
0-15
0-3
0-5
0-3
0-3
0-1
0-3
0-1
0-1
26
27
28
29
22
23
24
25
30
31
18
19
20
21
14
15
16
17
10
11
12
13
8
9
6
7
4
5
2
3
0
1
Control Expert Items
Bytes Bit(s)
0-1 not used
0-1 not used
0-1 not used
0-1 not used
0-3 not used
0-3 not used
0-3 not used
0-5 not used
0-7
0-7
0-7 not used
0-7
0-7
0-7 not used
0-3 not used
0-5 not used
0-5 not used
0-5 not used
STB Module Description
DDI 3230
DDI 3230
DDO 3200
DDO 3200
DDI 3420
DDI 3420
DDO 3410
DDO 3410
DDI 3610
DDI 3610
DDO 3600
DDO 3600
AVI 1270
AVI 1270
AVI 1270
AVI 1270 input data input status output data echo output status input data input status output data echo output status input data input status output data echo output status input data ch 1 input status ch 1 input data ch 2 input status ch 2
S1A33985 12/2018
157
Adding Devices to an Ethernet Network
Advantys Modbus Image
Register
45408
Bit(s)
0-7
45409 0-7
Control Expert Items
Bytes Bit(s)
32
33
34
35
0-7 not used
0-7 not used
STB Module
AVI 1270
AVI 1270
Description output status ch 1 output status ch 2
Output Data (Write):
Advantys Modbus Image
Register Bit(s)
40001 0-1
40002
40003
40004
40005
0-3
0-5
0-15
0-15 8
9
6
7
4
5
2
3
0
1
Control Expert Items
Byte Bit(s)
0-1 not used
0-3 not used
0-5 not used
0-7
0-7
0-7
0-7
STB Module
DDO 3200
DDO 3410
DDO 3600
AVO 1250
AVO 1250
Description output data output data output data output data ch 1 output data ch 2
This example shows you how to create 18 words of inputs and 5 words of outputs. This example creates items in the following sequence:
input word items output word items
158
S1A33985 12/2018
Adding Devices to an Ethernet Network
Creating Input Word Items
To create input items for the STB NIP 2212 example, beginning with an input word for the
DDI 3230 input module:
Step
1
Action
In the DTM Browser, select the communication module:
2
3
Do one of the following:
in the main menu, select Edit → Open, or
click the right mouse button, then select Open in the pop-up menu.
The Device Editor opens, displaying the DTM for the communication module.
In the left pane of the Device Editor, navigate to and select the Items node for the STB NIP 2212 network interface module:
S1A33985 12/2018
159
Adding Devices to an Ethernet Network
Step
4
Action
Select the Input tab to open that page:
5
6
NOTE: In this example, each row represents a byte. Because the items you create will be a 16bit words, each item consists of 2 rows.
In the Default Item Name Root input box type: DDI3230_in_data.
Starting at the beginning of the table, select the first two rows: 0 and 1:
160
S1A33985 12/2018
Step
7
Adding Devices to an Ethernet Network
Action
Click the Define Item(s) button.The Item Name Definition dialog opens:
8
NOTE: The Define Item(s) button is enabled only when Input Mode is set to Manual.
Select WORD as the New Item(s) Data Type, then click OK. A new item is created:
S1A33985 12/2018
9 Click Apply to save the new items, and leave the page open.
161
Adding Devices to an Ethernet Network
Step
10
11
Action
Repeat steps 2 - 6 for each new word item you need to create. In this example, that includes the following items:
Rows 2-3, Default Items Name Root: DDI3230_in_st
Rows 4-5: Default Items Name Root: DDO3200_out_echo
Rows 6-7: Default Items Name Root: DDO3200_out_st
Rows 8-9: Default Items Name Root: DDI3420_in_data
Rows 10-11: Default Items Name Root: DDI3420_in_st
Rows 12-13: Default Items Name Root: DDO3410_out_echo
Rows 14-15: Default Items Name Root: DDO3410_out_st
Rows 16-17: Default Items Name Root: DDI3610_in_data
Rows 18-19: Default Items Name Root: DDI3610_in_st
Rows 20-21: Default Items Name Root: DDO3600_out_echo
Rows 22-23: Default Items Name Root: DDO3600_out_st
Rows 24-25: Default Items Name Root: AVI1270_CH1_in_data
Rows 26-27: Default Items Name Root: AVI1270_CH1_in_st
Rows 28-29: Default Items Name Root: AVI1270_CH2_in_data
Rows 30-31: Default Items Name Root: AVI1270_CH2_in_st
Rows 32-33: Default Items Name Root: AVO1250_CH1_out_st
Rows 34-35: Default Items Name Root: AVO1250_CH2_out_st
The next task is to create output words.
162
S1A33985 12/2018
Adding Devices to an Ethernet Network
Creating Output Word Items
To create output items for the STB NIP 2212, example, beginning with an output data word for the
DDO 3200 output module:
Step
1
Action
Click the Output tab to open the following page:
2
3
NOTE: In this example, each row represents a byte. Because he items you create will be a 16bit words, each item consists of 2 rows.
In the Default Item Name Root input box type: DDO3200_out_data.
Starting at the beginning of the table, select the first 2 rows, 0 and 1:
S1A33985 12/2018
163
Adding Devices to an Ethernet Network
Step
4
Action
Click the Define Item(s) button.The Item Name Definition dialog opens:
5
NOTE: The Define Item(s) button is enabled only when Input Mode is set to Manual.
Select WORD as the New Item(s) Data Type, then click OK. A new item is created:
164
6
7
8
9
Click Apply to save the new item and leave the page open.
Repeat steps 2 - 6 for each new word item you need to create. In this example, that includes the following items:
Rows 2-3, Default Items Name Root: DDO3410_out_data
Rows 4-5: Default Items Name Root: DDO3600_out_data
Rows 6-7: Default Items Name Root: AVO1250_CH1_out_data
Rows 8-9: Default Items Name Root: AVO1250_CH2_out_data
Click OK to close the Items window.
Select File → Save to save your edits.
The next task is to update the Control Expert application (
see page 166
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Working With Derived Data Types
S1A33985 12/2018
Working With Derived Data Types Chapter 4
Working With Derived Data Types
Overview
This chapter describes how to complete your project by creating, updating, and viewing derived data type (DDT) variables in Control Expert.
What Is in This Chapter?
This chapter contains the following topics:
Topic
Creating and Updating Derived Data Types
Working with Derived Data Type Variables
Effect of Activating and De-activating Devices on I/O %MW Memory Addresses
Page
S1A33985 12/2018
165
Working With Derived Data Types
Creating and Updating Derived Data Types
Creating or Updating Derived Data Types
After you have completed your edits in the Device Editor, the next step is to let Control Expert create the necessary program objects in the form of derived data types (DDTs) and variables that will support your network design. To do this, follow these steps:
Step
1
2
Action
In the Project Browser, navigate to and select the communication module.
Do one of the following:
click the right mouse button, and select Open in the pop-up menu, or
in the Edit menu, select Open.
The Configuration page of the Ethernet communication module opens, below:
166
3 Click the Update application button.
NOTE:
Every time you use the Device Editor to make changes to your Control Expert project, return to this screen and click the Update application button to save your edits.
Control Expert refreshes the collection of DDTs and variables by adding, editing, or deleting previously generated DDTs and variables each time you do one of the following:
click on the Update application button, above
select either Build → Build Changes or Build → Rebuild All Project
S1A33985 12/2018
Step
4
Working With Derived Data Types
Action
Click OK. The Project Browser displays the new or edited derived data types, below:
S1A33985 12/2018
167
Working With Derived Data Types
Working with Derived Data Type Variables
Derived Data Type Variables
When you click on the Update application button, Control Expert creates a collection of derived data types and variables. These are used by Control Expert to support communication and data transfer between the PLC and the various local slaves, remote devices, and their I/O items. You can access these derived data types and variables in the Control Expert Data Editor and add them to a user-defined Animation Table, where you can monitor read-only variables and edit read-write variables.
Use these data types and variables to:
view the status of connections from the communication module to remote EtherNet/IP and
Modbus TCP devices, where:
the status of connections is displayed in the form of a HEALTH_BITS array consisting of 32 bytes
each connection is represented by a single bit in the array a bit value of 1 indicates the connection is healthy a bit value of 0 indicates the connection is lost, or the communication module can no longer communicate with the remote device toggle a connection ON (1) or OFF (0) by writing to a selected bit in a 32 byte CONTROL_BITS array
NOTE: Distinguish between toggling a bit in the CONTROL_BITS array on or off, and enabling or disabling a remote device.
monitor the value of local slave and remote device input and output items you created in the
Control Expert Device Editor
168
S1A33985 12/2018
Working With Derived Data Types
Identifying Derived Variables in the Data Editor
To view your Control Expert application’s derived data type variables:
Step
1
Description
In the Project Browser, navigate to and double-click the left mouse button on
Variables & FB instances → Derived Variables:
2 The Data Editor opens, displaying the Variables page:
S1A33985 12/2018
NOTE:
A check mark appears in the DDT checkbox. (If not, select the DDT checkbox to display these variables.)
The red arrow and lock icons indicate the variable name was auto-generated by
Control Expert based on the configuration of the local slave or remote device and cannot be edited.
169
Working With Derived Data Types
Displaying the Order of Input and Output Items in PLC Memory
The Data Editor displays the address of each input and output variable. Click once on the Address column header to sort input and output addresses in ascending order. When you open the first input and output variables, you can see both the connection health bits and the connection control bits:
170
Note the order of inputs and outputs in the above example. Recall that the user defines the size and location of inputs and outputs (see Modicon M340, BMX NOC 0401
Ethernet Communication Module, User Manual) . However, within the reserved area for both inputs and outputs, Control Expert assigns addresses to variables in the following order:
Inputs
Health bits 1
Order
1
Outputs
Control bits 1
Modbus TCP input variables 2 2 Modbus TCP output variables 2
Local Slave input variables 3 3 Local Slave output variables 3
EtherNet/IP input variables 2 4 EtherNet/IP output variables 2
1. Health and control bits are sub-ordered as follows: i. by device type: a. Modbus TCP; b. local slave; c. EtherNet/IP ii. within each device type: a. by device or local slave number b. within a device: by connection number
2. Device variables are sub-ordered as follows: i. by device number ii. within a device: by connection number iii. within a connection: by item offset
3. Local slave variables are sub-ordered as follows: i. by local slave number ii. within each local slave: by item offset
NOTE: When a device is added to or removed from the project, or when the active status of an existing device or a local slave changes, the specific location of inputs and outputs in PLC memory also changes.
S1A33985 12/2018
Working With Derived Data Types
Identifying the Connection Health Bits
The Ethernet communication module can support up to 128 connections to remote devices. The health of each connection is represented in a single bit value. A health bit value of:
1 indicates the connection is active
0 indicates the connection is inactive
The health bits are contained in a 32-byte array in the Variables page of the Data Editor. To display offline this byte array, first sort the variables in ascending order of address, then open the first input variable as shown below:
To determine which health bit is mapped to a specific remote device connection, in the
Device Editor for the Ethernet communications
Step Action
1 In the Device Editor for the Ethernet communication module, under the Device List node, navigate to and select:
for Modbus TCP devices: the main device node for EtherNet/IP devices: a connection node
2 For a Modbus TCP device, open the Request Setting page and look for the
Connection Bit number:
S1A33985 12/2018
In the above example (which displays the left portion of a truncated Request Setting page), the Connection Bit value of 0 maps to the first bit in the first byte of the
HEALTH_BITS_IN array, which can be represented as HEALTH_BITS_IN[0].0
.
171
Working With Derived Data Types
Step Action
3 For an EtherNet/IP device, open the Connection Settings page and look for the
Connection Bit number:
4
In the above example, the Connection Bit value of 2 maps to the third bit in the first byte of the HEALTH_BITS_IN array, which can be represented as
HEALTH_BITS_IN[0].2
.
For a local slave, open the local slave configuration page
the Connection Bit number:
Monitoring Connection Health Bits in an Animation Table
Use an animation table to monitor the status of connection health bits and other variables. To add health bits to an animation table, follow these steps:
Step
1
2
Action
In the Project Browser, select the Animation Tables node and click the right mouse button. A pop-up menu opens.
Select New Animation Table.
172
S1A33985 12/2018
Working With Derived Data Types
Step
3
Action
In the New Animation Table dialog, type in values for the following fields:
Name Type in a name for the new animation table. In this example, type in Connection_Health_Bits.
Number of animated characters
Accept the default value of 100.
The completed dialog looks like this:
4
5
Click OK. The dialog closes and the new Connection_Health_Bits animation table opens.
Double-click on the first empty row in the Name column, then click the ellipsis button . The Instance Selection dialog opens.
S1A33985 12/2018
173
Working With Derived Data Types
Step
6
Action
In the Instance Selection dialog, navigate to and select the entire
HEALTH_BITS_IN array:
174
7 Click OK to add the array to the Connection_Health_Bits animation table:
Keep in mind that each row represents a byte, which contains eight individual connection health bits. When the DTM for the Ethernet communication module is connected to the physical module, the Value field displays a value for the entire byte.
S1A33985 12/2018
Working With Derived Data Types
Modifying Connection Control Bits in an Animation Table
You can also use an animation table to modify the value of a control bit, toggling it on or off.
NOTE: Using control bits to toggle a connection on or off (as described below) is the preferred way of regulating communication with a remote device. Toggling a connection control bit on and off does not affect the address location of I/O items. In either case—on or off—the I/O items remain a part of the configuration at the same address locations.
By contrast, enabling and disabling the Active Configuration property for a device or local slave either adds I/O items to, or removes I/O items from, the application. This has the rippling effect of changing the addresses not only for the items of the enabled/disabled device, but also for I/O items relating to other devices in the configuration.
The following example shows you how to add connection control bits to the
Connection_Health_Bits animation table that you created, above, and use the animation table’s
Modification function to toggle control bits on or off:
Step
1
2
Action
With the Connection_Health_Bits animation table open, double-click on the next empty row in the Name column, then click the ellipsis button
Instance Selection dialog opens.
In the Instance Selection dialog, navigate to and select the entire
CONTROL_BITS_OUT array:
. The
S1A33985 12/2018
175
Working With Derived Data Types
Step
3
Action
Click OK to add the control bit array to the Connection_Health_Bits animation table:
4
5
6
Keep in mind that each row represents a byte, which contains eight individual connection control bits. When the DTM for the Ethernet communication module is connected to the physical module, the Value field displays a value for the entire byte.
With the DTM for the Ethernet communication module connected to the physical module, double click in the Value column for the row (byte) that contains the control bit you want to toggle.
Type a value that toggles the bit (or bits) in the byte you want to change to on or off. For example, suppose the Value field of the control bit displays an initial value of 7. This indicates that the first three (0, 1, and 2) are not established. If you intend to establish the third connection (connection 2), modify the corresponding bit to 0
(type a value of 3).
NOTE: When the control bit is 0, the connection is established. When the control bit is 1, the connection is closed.
On your keyboard, press Enter. The control bit for the third connection (i.e. connection number 2) is toggled off.
176
S1A33985 12/2018
Working With Derived Data Types
Effect of Activating and De-activating Devices on I/O %MW Memory Addresses
Introduction
Control Expert assigns a located address in %MW memory to each input and output variable for a remote device and local slave, when that device or slave is activated.
In addition, Control Expert removes from %MW memory each located variable address whenever the related device or slave is de-activated.
In each case, because of the ordered structure of I/O items in PLC memory
other I/O variables throughout the application.
see page 170
activation and de-activation of a single device causes a rippling effect on the address locations of
Because activating and de-activating devices can cause substantial changes to located variable addresses, Schneider Electric recommends the following practices:
Activate every device and local slave your application is likely to use, and allow these devices to remain activated.
If it subsequently becomes necessary to disable communications to a device or slave, instead of de-activating it, use the appropriate control bits to toggle off all connections to that slave or
see page 175
When configuring function blocks in Control Expert, instead of directly reassigning input and output pins to a specific %MW address, do the following: assign specific input and output pins only to the derived data types and variables automatically created by Control Expert.
The Sample Network
The sample network is a part of the same physical network that has been the subject of our continuing configuration example, and includes:
the Ethernet communication module, named NOC01 an STB NIC 2212 EtherNet/IP network interface module with I/O modules, named NIC2212_01
Note that, when a new network is created, Control Expert presents three local slave nodes that can be activated and pre-assigns them device numbers 000, 001, and 002. By default, each local slave is not activated. Therefore, each local slave’s inputs and outputs are not initially assigned a %MW memory address.
The following example describes the effect of activating a local slave function after another remote device has already been configured and added to the network. In this ca
The sample Ethernet network has been configured as follows:
Total network inputs and outputs are set in the Configuration page of the Ethernet communication module in Control Expert:
100 input words are reserved, beginning at %MW01
100 output words are reserved, beginning at %MW101
Connection bits for the project include:
32 input bytes (16 words) for health bits with an instance name of NOC01_IN
32 output bytes (16 words) for control bits with an instance name of NOC01_OUT
S1A33985 12/2018
177
Working With Derived Data Types
Local slave inputs and outputs include:
8 input bytes (4 words) are reserved with an instance name of NOC01_LS1_IN
4 output bytes (2 words) are reserved with an instance name of NOC01_LS1_OUT
Remote EtherNet/IP device inputs and outputs include:
19 input bytes (10 words) are reserved with an instance name of NIC2212_01_IN
8 output bytes (4 words) are reserved with an instance name of NIC2212_01_OUT
I/O Assignment Without an Activated Local Slave
When you click the Update application button in the Ethernet communication module Configuration page, with the local slave de-activated, Control Expert auto-generates a collection of variables in support of the application’s I/O items at the following instance locations:
Note the address locations of the remote EtherNet/IP device’s inputs (%MW17) and outputs
(%MW117). As you will see, below, when the local slave is activated, these address locations will change.
I/O Assignment With an Activated Local Slave
The following example displays input and output variables for the same project. However, in this example the Active Configuration setting for the first local slave was set to Enabled in the local
see page 86
, before the input and output variables were created. As a result clicking the Update application button in the Ethernet communication module Configuration page generated the following collection of variables:
178
S1A33985 12/2018
Working With Derived Data Types
Notice how the address locations for the remote EtherNet/IP device have shifted:
inputs (NIC2212_01_IN) have shifted from %MW17 to %MW21
outputs (NIC2212_01_OUT) have shifted from %MW117 to %MW118
This shift of %MW input and output memory address assignments occurs because the local slave was activated, and local slave I/O variables are placed in a located memory address position ahead of remote EtherNet/IP device I/O variables.
A similar shift of addresses would occur—with respect to both local slave and EtherNet/IP device
I/O variable addresses—if a Modbus TCP remote device is activated. This is because Modbus
TCP device I/O variables are places in a located memory address position ahead of both local slave and EtherNet/IP I/O variables.
As stated above, a way to avoid this shift of I/O memory addresses is to activate every local slave and remote device that your project may require, and then allow them to remain active. To later disable a device, use the appropriate control bits to toggle off every connection to that device.
S1A33985 12/2018
179
Working With Derived Data Types
180
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Optimizing Performance
S1A33985 12/2018
Optimizing Performance Chapter 5
Optimizing Performance
Overview
This chapter describes how to optimize the performance of your Ethernet network.
What Is in This Chapter?
This chapter contains the following sections:
Section
5.1
5.2
5.3
Topic
Selecting a Switch
Control Application Design
Projecting Ethernet Network Performance
Page
S1A33985 12/2018
181
Optimizing Performance
Selecting a Switch Section 5.1
Selecting a Switch
Overview
This section describes how to select an Ethernet switch for your network.
What Is in This Section?
This section contains the following topics:
Topic
Role of a Switch in an Ethernet Network
Transmission Speed, Duplex and Auto-Negotiation
Quality of Service (QoS)
IGMP Snooping
Rapid Spanning Tree Protocol (RSTP)
Virtual Local Area Network (VLAN)
Port Mirroring
Simple Network Management Protocol (SNMP) Agent
Page
182
S1A33985 12/2018
Optimizing Performance
Role of a Switch in an Ethernet Network
Overview
Schneider Electric recommends the use of managed switches—not unmanaged switches or hubs—in process control networks. A managed switch provides more functionality than an unmanaged switch, including the ability to:
turn switch ports on or off configure port speed and duplex settings control and monitor message traffic within segments prioritize message traffic
Recommended Switch Features
When acquiring an Ethernet switch for your process control network, confirm that the switch includes the following features:
Multiple speed (10/100/1000 Mbps)
Full duplex
QoS
IGMP snooping
RSTP
VLAN support
Port mirroring
SNMP agent
S1A33985 12/2018
183
Optimizing Performance
Transmission Speed, Duplex and Auto-Negotiation
Introduction
Most Ethernet switches support multiple transmission speeds, full- and half-duplex communication, and offer auto-negotiation capability. Hubs, by contrast, are not designed to support full duplex transmissions.
Duplex
Full duplex enables a switch port to both transmit and receive messages simultaneously, over two dedicated communication channels. Half duplex, by contrast, permits a port to transmit or receive messages in only one direction at a time. Signal collisions are possible in half duplex communications—because messages are transmitted and received over a single channel. Half duplex communications can cause poor performance and message loss.
Auto-Negotiation
Auto-negotiation permits a switch port—connected to a remote device that also supports autonegotiation—to automatically configure itself for the maximum speed and duplex configuration supported by both devices. However, it may be necessary to manually configure the speed and duplex settings of the switch port, if its peer device does not possess auto-negotiation capability.
Recommendation
Schneider Electric recommends that you employ only switches that support:
both auto-negotiation and manual configuration of speed and duplex settings
multiple speeds: 10/100/1000 Mbps both full duplex and half duplex
184
S1A33985 12/2018
Optimizing Performance
Quality of Service (QoS)
Introduction
A switch that supports QoS packet tagging can be configured to deliver higher priority messages before messages with a lower (or no) priority. This enhances system determinism and increases the timely delivery of prioritized messages.
In the absence of QoS tagging, the switch delivers various application messages on a first-in firstout basis. This can result in poor system performance caused by the long forwarding delay—and late delivery—of high priority application messages, which may be handled after lower priority messages.
Types of QoS
The tagging types are based on the switch configuration:
Tagging type
Explicit (QoS tag in
Ethernet packet)
Implicit
Priority mapping rule Description
DSCP or TOS field in
IP header
Each IP based Ethernet packet contains a value in the DSCP or TOS field in its IP header, indicating the QoS priority. The switch forwards packets based on this priority.
VLAN tag in Ethernet header
Port based
Each Ethernet packet contains a value in the priority field in the VLAN tag in its Ethernet header, indicating the QoS priority. The switch forwards packets based on this priority.
Switch ports are mapped to different QoS priorities. For example, switch port 1 is mapped to QoS priority 1, switch port 2 is mapped to QoS priority 2, etc.
Recommendation
Schneider Electric recommends the use of devices—including switches—that support explicit QoS tagging.
NOTE: Some switches that support QoS tagging have this feature disabled by default. Confirm that
QoS is enabled when deploying each switch.
S1A33985 12/2018
185
Optimizing Performance
IGMP Snooping
Multicast Messaging
Internet Group Management Protocol (IGMP) is an essential feature of multicast messaging. IGMP instructs routers and switches to forward Ethernet multicast packets to only those device ports that have requested these packets.
In the absence of IGMP snooping, a switch forwards multicast packets out of all its ports, resulting in greater network traffic, wasted network bandwidth, and degraded network performance.
Configure one Ethernet network switch as the IGMP querier. This switch periodically polls the field devices connected to the network, which causes all connected devices to issue an multicast addressing information databases in response.
IGMP Multicast
Group Join message. The group message is received by all network switches, which update their
Similarly, when an Ethernet device transmits an from their databases.
IGMP Multicast Group Leave message, all network switches update their multicast addressing information databases by removing the device
Multicast messaging reduces network traffic by:
requiring that a message be sent only once sending the message only to devices for which the message is intended
Recommendation
Schneider Electric recommend the following:
employ switches that support IGMP V2 or higher
because IGMP snooping may be disabled by default, enable IGMP snooping for each network switch confirm that one switch is configured as the IGMP querier
186
S1A33985 12/2018
Optimizing Performance
Rapid Spanning Tree Protocol (RSTP)
RSTP
Rapid Spanning Tree Protocol (RSTP) is an OSI layer 2 protocol defined by IEEE 802.1D 2004 that performs the following functions:
it creates a loop-free logical network path for Ethernet devices that are part of a topology that includes redundant physical paths
it automatically restores network communication—by activating redundant links—in the event the network experiences a broken link
RSTP software, operating simultaneously in every network switch, obtains information from each switch which enables the software to create a hierarchical logical network topology. RSTP is a flexible protocol that can be implemented on many physical topologies, including ring, mesh, or a combination of ring and mesh.
Recommendation
Schneider Electric recommends the following practices:
Use RSTP instead of STP: RSTP provides a faster recovery time than STP
NOTE: Recovery time is the time that elapses between the moment a broken link is detected to the moment network service is restored. Recovery time depends on:
the number of switches in the topology: the more switches, the longer the recovery time the processing speed of the switches in the topology: the slower the speed, the longer the recovery time the bandwidth, traffic load, and topology pattern
If the switch is part of a topology with redundant physical paths: enable RSTP.
If the switch is part of a topology that does not include redundant physical paths: disable
RSTP—in this case, disabling RSTP improves network performance.
S1A33985 12/2018
187
Optimizing Performance
Virtual Local Area Network (VLAN)
Introduction
Use VLANs to divide a larger network into smaller virtual groups of devices, and to split a switch into many virtual network switches. VLANs permit the creation of logically separate groups of network devices, without having to physically re-wire those devices.
When a switch receives a message directed to a specific VLAN, it forwards that message only to the switch ports connected to devices that are members of that VLAN. The switch does not send the message to other ports.
A VLAN reduces network traffic, blocks multicast and broadcast traffic from other VLANs, provides separation between VLANs, and improves system performance.
VLAN Types
Depending upon the switch features, there many different ways to define and implement VLANs:
Tagging type
Explicit (VLAN tag in
Ethernet packet)
Implicit (no VLAN tag in Ethernet packet)
Mapping rule
Tag based
Port based
MAC based
Description
Each VLAN group is assigned a unique VLAN ID, which is included in each Ethernet packet. The switch forwards packets based on VLAN ID.
Switch ports are assigned to different VLANs, when the switch is configured (see example, below.)
A switch maps VLAN group membership—and forwards Ethernet frames—based on device MAC address.
Protocol based A switch maps VLAN group membership—and forwards Ethernet frames—based on message protocol.
IP-subnet based A switch maps VLAN group membership—and forwards Ethernet frames—based on IP subnet portion of the target address.
188
S1A33985 12/2018
Optimizing Performance
Example
In the port-based VLAN example, below, switch ports 1, 2, and 3 are assigned to VLAN A, while switch ports 4, 5, and 6 are assigned to VLAN B:
NOTE: A single port can be a member of multiple VLANs.
S1A33985 12/2018
189
Optimizing Performance
Port Mirroring
Introduction
Port mirroring lets you troubleshoot switch port transmissions by copying the traffic that passes through one port (the source or mirrored port) and sending the copied transmission to a second port (the destination or mirror) port, where the packets can be examined.
In the following example, the data packets transmitted over port 1 are copied and sent to port 6.
To troubleshoot port 1, a PC with packet sniffing software is used to analyze the traffic on port 6 and thereby troubleshoot port 1.
A target device of port 1 transmissions
B PC with packet sniffing software connected to port 6, which mirrors port 1 transmissions
Port mirroring does not affect the normal forwarding behavior of the mirrored port. In many switches, you can configure port mirroring so that you can forward and examine:
only the incoming packets of a single mirrored port only the outgoing packets of a single mirrored port
both the incoming and outgoing packets of a single mirrored port the packets of several mirrored ports—or the whole switch
A packet sniffer’s troubleshooting features should include:
analyzing network performance monitoring network activity
Recommendation
Schneider Electric recommends implementing port mirroring as follows:
Use a destination or mirror port only for port mirroring and not for any other purpose. Connect
only the PC with packet sniffer to the mirroring port.
When configuring the switch, confirm that port mirroring is designed to forward packets—e.g., incoming, outgoing, or both—to meet your requirements.
A packet sniffer’s troubleshooting features should include the capabilities of analyzing network performance and monitoring network activity.
190
S1A33985 12/2018
Optimizing Performance
Simple Network Management Protocol (SNMP) Agent
An SNMP agent is a software component that responds to queries about the management data of the switch, and reports events to another device acting as an SNMP manager.
The management data for a switch can include:
operational state information (interface status, mode of operation, etc.)
configuration parameters (IP address, features enabled / disabled, timer values, etc.) performance statistics (frame counters, event logs, etc.)
If a switch is equipped with SNMP agent software, a designated SNMP manager can:
retrieve management data about the switch
control the switch by editing its configuration settings receive traps—or notices of events—affecting the state of the switch
S1A33985 12/2018
191
Optimizing Performance
Control Application Design Section 5.2
Control Application Design
Overview
In a control system, control and automation are achieved by processing and delivering various application service messages.
Understanding messages, allocating network bandwidth among messages, and determining the time required for a message to traverse the network are all major performance considerations of your control application design.
What Is in This Section?
This section contains the following topics:
Topic
Message Types
Message Connection Types
TCP and CIP Connections
Message Priority
Messaging Performance
Message Frequency
Allocating Network Bandwidth
Estimating Message Traverse and Response Times
Page
192
S1A33985 12/2018
Optimizing Performance
Message Types
Overview
Two types of industrial Ethernet message types are supported by the Ethernet communication module:
Message Type
Explicit
Implicit
Includes...
Non-time critical management data
Read/write application data
Real-time I/O data
Real-time control data
Real-time synchronization data
Explicit Messages
Explicit messages transmit information used for device configuration and diagnostics, and for data collection. In explicit messaging, the client issues a request; the server receives, processes, and sends a response back to the client.
You can specify a response timeout value, indicating how long the client waits for a response from the server. If the client does not receive a response from the server within the response timeout period, the client reissues its request. The length of the response timeout will vary depending on the requirements of your application.
Examples of explicit messages include: SNMP messages, FTP messages, CIP establish connection messages, EtherNet/IP query and response messages, and DHCP messages.
The characteristics of explicit messaging are:
point-to-point client-server mode
variable size variable frequency long response time long connection timeout
Explicit messages can be sent as either connected or unconnected, depending on the frequency of your need for data, and on the level of service required:
Message type
Connected
Characteristics
Begins when an originating device initiates a connection by sending a request to a target device.
The connection is established when the originator receives a successful response from the target.
A CIP connected message has a higher priority and provides better service, but requires a greater amount of resources from both the target and originator devices.
Used for recurring requests, and for high priority parameter monitoring.
Typically use short response timeout settings.
S1A33985 12/2018
193
Optimizing Performance
Message type
Unconnected
Characteristics
Less resource intensive.
Used for less frequent requests, and for lower priority parameter monitoring.
Typically use very long response timeout settings.
NOTE: The response timeout can be configured using the EM Request Timeout parameter
(located in the Channel Properties → EtherNet/IP page).
Implicit Messages
Implicit messages consist of packets of data that are time critical. Implicit messages are used for real-time control and synchronization. Examples of implicit messages include: real-time I/O data, motion control data, functional diagnostic data, real-time synchronization data, and network topology management data.
Implicit messages require determinism and high performance in message processing and delivery.
The characteristics of implicit messaging are:
producer/consumer mode (EtherNet/IP) or client/server mode (Modbus TCP)
small, fixed data size fixed frequency short response time short connection timeout
194
S1A33985 12/2018
Optimizing Performance
Message Connection Types
Introduction
The transmission of most messages require a point-to-point connection between a transmitter and receiver.
For all types of explicit messages, the connection automatically closes when the communication ends, or is timed-out.
For implicit messages, keep the connection open. If the I/O connection—CIP for EtherNet/IP, TCP for Modbus TCP—the transmission stops. In this case, the scanner employs the TCP implicit messaging connection to dynamically re-establish the CIP connection.
Calculating the Connection Timeout
For CIP connections, you can control the connection timeout setting by specifying both the network multiplier and the requested packet interval (RPI in ms):
Timeout = Network Multiplier x RPI
NOTE: You can locate and configure these values in the Control Expert Ethernet Configuration
Tool. Open the DTM Editor for the Ethernet communication module, then edit the following settings:
the network multiple is the Time-out Multiplier parameter found in the Device List → <device>
→ <connection> → Connection Settings page, and the RPI is the EM Connection RPI parameter found in the Channel Properties → EtherNet/IP page
A large timeout value may affect the ability of the network to optimize the availability of connection resources, re-establish connections, and update I/O data when the connection is lost.
A small timeout value may unnecessarily cause the frequent closing and re-establishing of connections.
It is preferable to use a larger timeout value for explicit messaging connections, and a smaller timeout value for implicit messaging connections. The specific value you employ depends on your application requirements.
S1A33985 12/2018
195
Optimizing Performance
Connection Types and Protocols
The connection type and transport protocol employed depends upon the message type and message protocol, as follows:
Message Type
Explicit
Implicit
Message Protocol
EtherNet/IP
Modbus TCP
FTP
HTML (web)
SMTP
SNMP
SNTP
DHCP
BOOTP
EtherNet/IP
Modbus TCP
IGMP
RSTP
Connection Type
CIP, TCP
TCP
TCP
TCP
TCP
N/A
N/A
N/A
N/A
CIP, TCP
TCP
N/A
N/A
Connection Protocol
TCP/IP
TCP/IP
TCP/IP
TCP/IP
TCP/IP
UDP/IP
UDP/IP
UDP/IP
UDP/IP
UDP/IP
TCP/IP
IP
Ethernet
Connection- Overhead
Any message transmission includes overhead, which consumes network bandwidth and processing time. The smaller the size of the data transmitted, the relatively greater the portion of the message allocated to overhead.
Consequently, it makes sense to design your I/O messaging by consolidating data from multiple
I/O devices—with similar processing capabilities and performance needs—and transmitting it through a single adapter. This design conserves bandwidth, stores network resources, and improves performance.
196
S1A33985 12/2018
Optimizing Performance
TCP and CIP Connections
Number of Connections Supported
The Ethernet communication module employs both TCP and CIP connections to support both implicit and explicit messages, as follows:
Connection Type
CIP
TCP
Maximum Number of Connections per Module
256
128
NOTE:
A single TCP connection can support multiple CIP connections.
The maximum number of TCP connections does not include connections dedicated to other services, for example, FTP and Web connections.
S1A33985 12/2018
197
Optimizing Performance
Message Priority
QoS
The routers and switches that comprise your network infrastructure cannot distinguish between explicit message and implicit messages. However, these devices—including the Ethernet communication module—can support QoS Ethernet packet tagging
see page 80
.
Using Qos tagging, these devices can handle messages they send and receive according to each message’s tagged priority, forwarding higher priority messages before lower priority messages.
198
S1A33985 12/2018
Optimizing Performance
Messaging Performance
Maximum Messaging Load
The Ethernet communication module supports a the following maximum messaging loads:
Message Type
Implicit (EtherNet/IP plus Modbus TCP)
Maximum Messaging Load
12000 packets per second, with no simultaneous explicit messages
Explicit (EtherNet/IP plus Modbus TCP) 120 packets per second, with a maximum of
6000 simultaneous implicit messages
S1A33985 12/2018
199
Optimizing Performance
Message Frequency
Introduction
The term message frequency refers to how often a device transmits a particular type of message.
Message frequency directly affects control network load and performance, as well as the CPU capacity of every network device that processes these messages.
Depending on your application requirements, real-time I/O data can be transmitted using implicit messaging as follows:
on a cyclic basis, at the request packet interval upon the occurrence of a change of state event
(RPI) rate, or
Cyclic Real-Time I/O Messaging
Much of the load on an Ethernet control network consists of cyclic real-time I/O data.
Consequently, carefully consider how to set the RPI value for transmitting these messages:
A small RPI value results in more frequent, and more numerous, message transmissions. This increases network load, and may waste network resources and degrade system performance.
Conversely, a larger RPI value—for example, one that is equal (or nearly equal) to the frequency of your application’s need for new data—can result in your application not receiving the most current data. Also, if a connection is lost, the time to re-establish the connection will be relatively long, because the connection timeout is proportional to the RPI.
Schneider Electric recommends setting RPI to 50% of the actual frequency by which your application requires data for cyclic real-time I/O messaging.
NOTE: The I/O scanner can simultaneously communicate with different I/O adapters at different
RPI rates. This enhances the ability of the PLC to control and monitor different devices with varying processing capacities.
Change of State I/O Messaging
For change of state triggered real-time I/O data messages:
output transmissions occur at the rate of the PLC controller application cycle time
input transmissions occur whenever an input event is detected by an input device
Consequently, for an I/O device with a rapid response and transmission time, using a direct connection to the I/O device may be more efficient than using a rack optimized connection. In this design, because only the single device input data is sent, the size of the frequently transmitted message is potentially much smaller than would be the case if the message contained data from every I/O device on the remote island.
NOTE: A change of state (versus cyclic) triggered real-time I/O message usually reduces network load. Configure the change of state message with a longer connection timeout value.
200
S1A33985 12/2018
Optimizing Performance
RSTP and IGMP Messaging
RSTP and IGMP messages usually consume a very small amount of network bandwidth. Set up the IGMP query period based on your application requirements.
Scheduling Certain Explicit Messages
Depending on your application requirements, you can also configure certain explicit messages to be transmitted either cyclically or upon the occurrence of a change of state event. For example, you can periodically monitor a device using SNMP query, Web pages, EtherNet/IP, and Modbus
TCP. The cyclic period should be configured so that the total load consumed by explicit messaging does not exceed 10% of network capacity.
S1A33985 12/2018
201
Optimizing Performance
Allocating Network Bandwidth
Introduction
Maximum network bandwidth equals your network speed, for example 100 Mbps. When designing your control network, allocate network bandwidth among the control application messages required by your application.
NOTE: Schneider Electric recommends you reserve at least the following amounts for processing explicit messaging:
10% of network bandwidth
10% of CPU processing capacity for each network device
Message Load and Message Bandwidth
Message Load —in packets per second (PPS)—represents the number of packets in a single message that are received and sent within one second. follows:
Message Load can be estimated as
Message Load =
(number of packets per connection) x (number of connections) / RPI
The either:
number of packets per connection value depends on the capacity of the device, and can be
1: for connections that support uni-directional communication
2: for connections that support input and output (for producer/consumer mode) or request and response (for client/server mode) per one time bi-directional exchange, or
The connection can be used for either explicit or implicit messaging. For UDP-based explicit messaging, assume that each client represents one connection, and that messages are transmitted cyclically.
Message Bandwidth (in bits) can be calculated as follows:
Message Bandwidth = message packet size (bits) x Message Load
Based on the portion of network bandwidth you want to allocate to a particular message, you can use the Message Load message.
and Message Bandwidth formulae to calculate the fastest RPI for the
202
S1A33985 12/2018
Optimizing Performance
Device Load and Device Bandwidth
Device Load —measured in number of packets—represents the load contributed by messages received and sent by a device within one second. values for every message handled by the device.
Device Load is the sum of the Message Load
If the Device Load exceeds the device’s processing capability, performance of both the device and the network is degraded.
NOTE: Schneider Electric recommends that capacity of each device.
Device Load not exceed 90% of CPU processing
Device Bandwidth —measured in bits—is the sum of the Message Bandwidth values for messages handled by the device
In your control application design, determine whether the I/O scanner device can handle the load contributed by every I/O adapter device. To do this, perform the following steps:
1 Calculate the implicit messaging load and bandwidth for each remote device.
2 Sum the load and bandwidth estimates for every remote device.
3 Compare the total implicit messaging load and bandwidth against the maximum implicit messaging capacity of the device acting as I/O scanner.
If the projected total load or bandwidth for a communication module acting as an I/O scanner exceeds its implicit messaging load or bandwidth limits, consider one or more of the following corrective actions:
If the I/O adapter supports rack optimized connections, and if a single rack of digital I/O uses multiple direct connections, replace the direct connections with a single rack optimized connection, if possible.
Increase the RPI setting for a device where possible.
Add another communication module to act as an I/O scanner, and re-design the network in order to share the load.
Network Load and Network Bandwidth
Network Load —measured in number of packets—can be estimated as the sum of the Device Load of the adapter devices, or of the scanner devices.
Network Bandwidth —measured in bits—can be estimated as the sum of the Device Bandwidth of the adapter devices, or of the scanner devices.
NOTE: Schneider Electric recommends that bandwidth.
Network Load not exceed 90% of maximum network
If necessary, you may need to optimize your control application design by:
adjusting device RPI settings
changing connection types (e.g., from direct to rack optimized) modify the configuration change the network topology
S1A33985 12/2018
203
Optimizing Performance
Estimating Message Traverse and Response Times
Message Traverse Time
Message Traverse Time is defined as the time required for a message to travel from its point of origin to its targeted destination over a network path. As the messages travels over the network path, it may pass through—and be forwarded by—a number of intermediate network devices, including switches and routers.
Message Traverse Time is impacted by several factors, including, for example, the following:
the number of forwarding network devices the transmission delay of each forwarding device network load message priority
Message Traverse Time can be estimated by determining the transmission delay (the store and forward delay) of intermediate network devices and counting the number of such devices.
Assuming each forwarding device is a switch, and each switch presents the same transmission delay, the following formula can be used:
Message Traverse Time =
(Switch Transmission Delay) x (Number of Switches)
Schneider Electric recommends that you estimate a worst-case follows:
Message Traverse Time , as
Step
1
2
3
4
Description
Determine the worst case network load.
Obtain switch performance information, under varying network loads, and use the worst case—i.e., the largest—transmission delay value.
Determine the logical network topology that yields the longest path—i.e. the greatest number of switches—through which a message passes.
Using the largest transmission delay value and the largest number of forwarding switches, use the formula (above) to calculate a worst-cast
Message Traverse Time .
204
S1A33985 12/2018
Optimizing Performance
Message Response Time
After calculating Message Traverse Time (above), you can next measure Message Response
Time , which measures the total time required for:
a message to travel from a client device over the network to a server the message to be processed by the server the server response to travel back to the client over the network
Message Response Time can be calculated as follows:
Message Response Time =
(2 x (Message Traverse Time)) + (Server Processing Time)
In the above formula, ‘2’ indicates a round trip required for client/server communication.
After Message Response Time is calculated, you can determine and configure the following parameters, both of which are found in the Channel Properties → EtherNet/IP page of the Control
Expert Ethernet Configuration Tool:
EM Request Timeout value, and
EM Connection RPI
S1A33985 12/2018
205
Optimizing Performance
Projecting Ethernet Network Performance Section 5.3
Projecting Ethernet Network Performance
Network Load and Bandwidth Calculation Example
Network Devices
This example estimates the performance for an Ethernet network composed of the following devices:
a PLC that controls 3 remote I/O stations (A, B, and C)
140 NOC 771 01 Ethernet communication module, acting as the local I/O scanner, installed in
the PLC rack an 8-port Ethernet managed switch a PC running used to obtain diagnostic data via explicit messages running the following software:
Control Expert the Control Expert Ethernet Configuration Tool
4 remote devices, acting as:
an I/O adapter (A) for a rack of I/O modules
a second I/O adapter (B) for a rack of I/O modules a remote I/O drive (C) a remote I/O scanner (D)
Control Expert software running in the PC is used to configure the CPU controller.
For programming purposes you need a connection to the PLC either through the CPU's Ethernet port or other supported programming paths.
206
S1A33985 12/2018
Network Diagram
The proposed network diagram looks like this:
Optimizing Performance
Network Load and Bandwidth Limits
When performing calculations, keep in mind that the Ethernet module and remote devices cannot exceed their implicit messaging and bandwidth limits:
Device
Ethernet Communication Module
I/O Adapter (A)
I/O Adapter (B)
I/O Drive (C)
I/O Scanner (D)
Switch
Load Limits
12000 pps
8000 pps
8000 pps
8000 pps
12000 pps
16000 pps
Bandwidth Limits
80 Mbps
70 Mbps
70 Mbps
70 Mbps
80 Mbps
90 Mbps
S1A33985 12/2018
207
Optimizing Performance
Remote Device Connections and RPI
For the purpose of this example, it is assumed that the remote devices require the following numbers of CIP connections, and are configured for the stated requested packet interval (RPI) settings:
Device
I/O Adapter (A)
I/O Adapter (B)
I/O Drive (C)
I/O Scanner (D)
2
2
CIP I/O Connections
5
2
RPI Setting
20 ms
30 ms
30 ms
50 ms
I/O Packet Size
8000 bits
4096 bits
8000 bits
8000 bits
For the purposes of this example, it is also assumed that every connection is bi-directional.
I/O Scanner Calculations
The Ethernet communication module, acting as local I/O scanner, has to handle the implicit messaging load contributed by the remote devices. Your task is to:
1 estimate the implicit messaging load and bandwidth contributed by each remote device
2 sum the load and bandwidth values for each remote device
3 compare the total load and bandwidth against the maximum implicit messaging capacity of the local I/O scanner
Recall that the implicit messaging load calculation formula for a single remote device is:
Load = (number of packets per connection) x (number of connections) / RPI
Because every connection is assumed to be bi-directional, the number of packets per connection value is 2. Consequently, the estimated implicit messaging load contributed by each device, and the total implicit messaging load the local I/O scanner has to handle can be estimated as follows:
Load:
Device
I/O Adapter (A)
I/O Adapter (B)
I/O Drive (C) 2
I/O Scanner (D) 2
2
2
Number of packets per connection
X
X
X
X
X
2
2
5
2
Number of connections
÷ RPI
÷ 20 ms
÷ 30 ms
÷ 30 ms
÷ 50 ms
Total
Switch
= Load
= 500 pps
= 134 pps
= 134 pps
= 80 pps
= 848 pps
= 848 pps
208
S1A33985 12/2018
Optimizing Performance
Bandwidth:
Device
I/O Adapter (A)
I/O Adapter (B)
I/O Drive (C)
I/O Scanner (D)
Packet size
8000 bits
4096 bits
8000 bits
8000 bits
X
X
X
X
X
Total
Load
500 pps
134 pps
134 pps
80 pps
Switch
=
=
=
=
=
=
=
Bandwidth
4 Mbps
0.554 Mbps
1.07 Mbps
0.64 Mbps
6.26 Mbps
6.26 Mbps
Conclusion
The projected total load for the module—848 pps—is within the device implicit messaging limit of
12000 data packets per second. The projected total bandwidth for the communication module—
6.26 Mbps—is also within the device implicit messaging bandwidth limit of 80 Mbps. The projected total load and bandwidth for the remote devices (including the switch) are also within their 90% load and bandwidth limits:
Device
Ethernet Communication Module
I/O Adapter (A)
I/O Adapter (B)
I/O Drive (C)
I/O Scanner (D)
90% of Load Limit
10800 pps
7200 pps
7200 pps
7200 pps
10800 pps
90% of Bandwidth Limit
72 Mbps
63 Mbps
63 Mbps
63 Mbps
72 Mbps
NOTE: Although message load contributed by explicit messaging are not included in the above calculations, such load contributions are presumed to be less than 10% of the device load and bandwidth.
S1A33985 12/2018
209
Optimizing Performance
210
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
CIP objects
S1A33985 12/2018
CIP Objects Chapter 6
CIP Objects
Overview
The Ethernet communication module can access CIP data and services located in connected devices. The CIP objects and their content depends on the design of each device.
CIP object data and content are exposed—and accessed—hierarchically in the following nested levels:
NOTE: You can use explicit messaging to access either:
a collection of instance attributes, by including in the explicit message address only the object’s
class and instance values, or a single attribute, by extending the explicit message address to include not only the object’s class and instance values but also a specific attribute value
When the Ethernet communication module’s local slave service is activated, remote devices can send explicit messages to the module’s CIP object structure and:
access module data, or execute module commands
This chapter describes the CIP objects the Ethernet communication module exposes to remote devices.
S1A33985 12/2018
211
CIP objects
What Is in This Chapter?
This chapter contains the following topics:
Topic
Identity Object
Assembly Object
Connection Manager Object
Modbus Object
Quality Of Service (QoS) Object
TCP/IP Interface Object
Ethernet Link Object
EtherNet/IP Interface Diagnostics Object
EtherNet/IP IO Scanner Diagnostics Object
IO Connection Diagnostics Object
EtherNet/IP Explicit Connection Diagnostics Object
EtherNet/IP Explicit Connection Diagnostics List Object
Page
212
S1A33985 12/2018
Identity Object
Overview
The Identity object presents the instances, attributes and services described below.
Class ID
01
Instance IDs
The Identity object presents two instances:
0: class
1: instance
Attributes
Identity object attributes are associated with each instance, as follows:
Instance ID = 0 (class attributes):
Attribute ID
01
Description
Revision
02
X = supported
— = not supported
Max Instance
GET
X
X
Instance ID = 1 (instance attributes):
Attribute ID hex dec
01
02
01
02
03
04
03
04
Description
Vendor ID
Device Type
Product Code
Revision
Major
Minor
X = supported
— = not supported
Type GET
UINT
UINT
UINT X
STRUCT X
USINT
USINT
X
X
SET
—
—
SET
—
—
—
—
CIP objects
S1A33985 12/2018
213
CIP objects
Attribute ID hex
05 dec
05
Description Type GET SET
Status bit 2:
0x01=the module is configured bits 4-7:
0x03=no I/O connections established
0x06=at least 1 I/O connection in run mode
0x07=at least 1 I/O connection established, all in IDLE mode
Serial Number
Product Name
Modbus Identity
Word X
UDINT X
STRING X
STRUCT X
—
06
07
18
06
07
24
X = supported
— = not supported
—
—
—
Services
The Identity object performs the following services upon the listed object types:
Description Class Instance Notes Service ID hex dec
01 01 Get_Attributes_All X X
0E 14 Get_Attribute_Single
X = supported
— = not supported
X X
Returns:
all class attributes (instance = 0)
instance attributes 1 to 7 (instance = 1)
Returns the value of the specified attribute.
214
S1A33985 12/2018
CIP objects
Assembly Object
Overview
The Assembly object consists of the attributes and services described below.
NOTE: You can send an explicit message to the Assembly object only when no other connections have been established that read from or write to this object. For example, you can send an explicit message to the Assembly object if a local slave instance is enabled, but no other module is scanning that local slave.
Class ID
04
Instance IDs
The Assembly object presents the following instance identifiers:
0: class
101, 102, 111, 112, 121, 122: instance
Attributes
The Assembly object consists of the following attributes:
Instance ID = 0 (class attributes):
Attribute ID
01
02
03
X = supported
— = not supported
Description
Revision
Max Instance
Number of Instances
Instance attributes:
Instance ID
101
102
111
112
121
122
X = supported
— = not supported
Attribute ID
03
Description
Local slave 1: T->O input data
Local slave 1: O>T
Local slave 2: T->O input data
Local slave 2: O>T
Local slave 3: T->O input data
Local slave 3: O>T
S1A33985 12/2018
X
X
GET
X
SET
—
—
—
Type
Array of BYTE
Array of BYTE
Array of BYTE
Array of BYTE
Array of BYTE
Array of BYTE
X
X
X
X
X
GET
X
X
—
X
SET
—
X
—
215
CIP objects
Services
The CIP Assembly object performs these services upon the listed object types:
Service ID hex dec
0E
10
14
16
Description
Get_Attribute_Single
Set_Attribute_Single 1
Class
X
—
Instance
X
X
Notes
Returns the value of the specified attribute
Returns these values:
0E=attribute not settable: assembly is not o->T type
0F=permission denied: assembly is being used by an active connection
13=config too small: the Set_Attribute_Single command contains partial data
15=data too big: the Set_Attribute_Single command contains too much data
X = supported
— = not supported
1. When valid, the size of the data written to the Assembly object using the Set_Attribute_Single service equals the size of the Assembly object as configured in the target module.
216
S1A33985 12/2018
CIP objects
Connection Manager Object
Overview
The Connection Manager object presents the instances, attributes and services described below.
Class ID
06
Instance IDs
The Connection Manager object presents two instance values:
0: class
1: instance
Attributes
Connection Manager object attributes are associated with each instance, as follows:
Instance ID = 0 (class attributes):
Attribute ID
01
Description
Revision
02 Max Instance
X = supported
— = not supported
GET
X
X
SET
—
—
Instance ID = 1 (instance attributes):
Attribute ID hex dec
01 01
Description
Open Requests
Type
UINT
GET SET
X X
Value
02
03
02
03
Open Format
Rejects
Open Resource
Rejects
UINT
UINT
X
X
X
X
Number of Forward
Open service requests received
Number of Forward
Open service requests that were rejected due to bad format
Number of Forward
Open service requests that were rejected due to lack of resources
X = supported
— = not supported
S1A33985 12/2018
217
CIP objects
Attribute ID hex
04
05
06
07
08 dec
04
05
06
07
08
Description
Open Other
Rejects
Close Requests
Close Format
Requests
Close Other
Requests
Connection
Timeouts
Type
UINT
UINT
UINT
UINT
UINT
GET SET Value
X
X
X
X
X
0C
0D
09
0B
09
11
12
13
MaxBuffSize UDINT
BufSize Remaining UDINT
X = supported
— = not supported
Connection Entry
List
CPU_Utilization
STRUCT
UINT
X
X
X
X
X
X
X
X
X
—
—
—
—
Number of Forward
Open service requests that were rejected for reasons other than bad format or lack of resources
Number of Forward
Close service requests received
Number of Forward
Close service requests that were rejected due to bad format
Number of Forward
Close service requests that were rejected for reasons other than bad format
Total number of connection timeouts that occurred in connections controlled by this connections manager
0 (Unsupported optional item
0 (Unsupported optional item
0 (Unsupported optional item
0 (Unsupported optional item
218
S1A33985 12/2018
CIP objects
Services
The Connection Manager object performs the following services on the listed object types:
Class Instance Notes Service ID hex dec
01
0E
01
14
X = supported
— = not supported
Description
Get_Attributes_All
Get_Attribute_Single
X
X
X
X
Returns the value of all attributes.
Returns the value of the specified attribute.
S1A33985 12/2018
219
CIP objects
Modbus Object
Overview
The Modbus object converts EtherNet/IP service requests to Modbus functions, and Modbus exception codes to CIP General Status codes. It presents the instances, attributes and services described below.
Class ID
44 (hex), 68 (decimal)
Instance IDs
The Modbus object presents two instance values:
0: class
1: instance
Attributes
The Modbus object consists of the following attributes:
Instance ID = 0 (class attributes):
Attribute ID
01
Description
Revision
02 Max Instance
X = supported
— = not supported
Instance ID = 1 (instance attributes):
Attribute ID
—
Description
No instance attributes are supported
Type
—
GET
X
X
SET
—
—
GET
—
SET
—
220
S1A33985 12/2018
Services
The Modbus object performs the following services upon the listed object types:
Class Instance Service ID hex dec
0E
4B
4C
4D
4E
4F
14
75
76
77
78
79
Description
Get_Attribute_Single
Read_Discrete_Inputs
Read_Coils
Read_Input_Registers
Read_Holding_Registers
Write_Coils
50
51
80
81
X = supported
— = not supported
Write_Holding_Registers
Modbus_Passthrough
—
—
—
—
X
—
—
—
X
X
X
X
X
X
X
X
CIP objects
S1A33985 12/2018
221
CIP objects
Quality Of Service (QoS) Object
Overview
The QoS object implements Differentiated Services Code Point (DSCP or instances, attributes and services described below.
DiffServe ) values for the purpose of providing a method of prioritizing Ethernet messages. The QoS object presents the
Class ID
48 (hex), 72 (decimal)
Instance IDs
The QoS object presents two instance values:
0: class
1: instance
Attributes
The QoS object consists of the following attributes:
Instance ID = 0 (class attributes):
Attribute ID
01
Description
Revision
02 Max Instance
X = supported
— = not supported
Instance ID = 1 (instance attributes):
Attribute ID
04
Description
DSCP Urgent
Type
USINT
GET
X
SET
X
05 DSCP Scheduled USINT X X
GET
X
X
SET
—
—
Value
For CIP transport class
0/1 Urgent priority messages, default value = 55.
For CIP transport class
0/1 Urgent priority messages, default value = 47.
X = supported
— = not supported
222
S1A33985 12/2018
CIP objects
Attribute ID
06
07
08
Description
DSCP High
DSCP Low
DSCP Explicit
Type
USINT
USINT
USINT
GET
X
X
X
SET
X
X
X
Value
For CIP transport class
0/1 Urgent priority messages, default value = 43.
For CIP transport class
0/1 Urgent priority messages, default value = 31.
For CIP explicit messages (transport class 2/3 and UCMM), default value = 27.
X = supported
— = not supported
NOTE: A change in the instance attribute value takes effect on device re-start, for configurations made from flash memory.
Services
The QoS object performs the following services upon the listed object types:
Description Class Instance Service ID hex dec
0E
10
14
16
X = supported
— = not supported
Get_Attribute_Single
Set_Attribute_Single
X
—
X
X
S1A33985 12/2018
223
CIP objects
TCP/IP Interface Object
Overview
The TCP/IP interface object presents the instances (per network), attributes and services described below.
Class ID
F5 (hex), 245 (decimal)
Instance IDs
The TCP/IP interface object presents 2 instance values:
0: class
1: instance
Attributes
TCP/IP interface object attributes are associated with each instance, as follows:
Instance ID = 0 (class attributes):
Attribute ID
01
Description
Revision
02 Max Instance
X = supported
— = not supported
GET
X
X
SET
—
—
Instance ID = 1 (instance attributes):
Attribute ID
01
02
03
04
Description
Status
Configuration
Capability
Configuration Control
Physical Link Object
Path Size
Path
Type
DWORD
DWORD
DWORD
STRUCT X
UINT
Padded
EPATH
GET SET Value
X — 0x01
X —
X X
0x01 = from BootP
0x11 = from flash
0x00 = other
0x01 = out-of-box default
—
X = supported
— = not supported
224
S1A33985 12/2018
CIP objects
Attribute ID
05
Description
Interface
Configuration
IP Address
Network Mask
Gateway Address
Name Server
Name Server 2
Domain Name
06 Host Name
X = supported
— = not supported
Type GET
STRUCT X
SET
X
Value
0x00 = out-of-box default
UDINT
UDINT
UDINT
UDINT
UDINT
STRING
STRING X —
Services
The TCP/IP interface object performs the following services upon the listed object types:
Service ID hex dec
01 01
Description Class Instance Notes
Get_Attributes_All X X Returns the value of all attributes.
0E
10
14
16
Get_Attribute_Single
Set_Attribute_Single 1
X
—
X
X
Returns the value of the specified attribute.
Sets the value of the specified attribute.
X = supported
— = not supported
1. The Set_Attribute_Single service can execute only when these preconditions are satisfied:
Configure the Ethernet communication module to obtain its IP address from flash memory.
Confirm that the PLC is in stop mode.
S1A33985 12/2018
225
CIP objects
Ethernet Link Object
Overview
The Ethernet Link object consists of the instances, attributes and services described below.
Class ID
F6 (hex), 246 (decimal)
Instance IDs
The Ethernet Link object presents two instance values:
0: class
1: instance
Attributes
The Ethernet Link object presents the following attributes:
Instance ID = 0 (class attributes):
Attribute ID
01
02
03
X = supported
— = not supported
Description
Revision
Max Instance
Number of Instances
X
X
GET SET
X —
—
—
226
S1A33985 12/2018
CIP objects
Instance ID = 1 (instance attributes):
Attribute ID hex dec
01 01
02 02
Description
Interface Speed
Interface Flags
03 03 Physical Address
X = supported
— = not supported
Type
UDINT
DWORD
ARRAY of 6
USINT
GET SET Value
X
X
X
—
—
—
Valid values include:
0, 10000000, 100000000
Bit 0: link status
0 = Inactive
1 = Active
Bit 1: duplex mode
0 = half duplex
1 = full duplex
Bits 2—4: negotiation status
3 = successfully negotiated speed and duplex
4 = forced speed and link
Bit 5: manual setting requires reset
0 = automatic
1 = device need reset
Bit 6: local hardware detected error
0 = no event
1 = event detected module MAC address
S1A33985 12/2018
227
CIP objects
Attribute ID hex
04 dec
04
Description
Interface Counters
In octets
In Ucast Packets
In NUcast Packets
In Discards
In Errors
In Unknown Protos
Out Octets
Out Ucast Packets
X = supported
— = not supported
Out NUcast Packets
Out Discards
Out Errors
Type
STRUCT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
GET SET Value
X — octets received on the interface unicast packets received on the interface non-unicast packets received on the interface inbound packets received on the interface, but discarded inbound packets with detected errors (does not include in discards) inbound packets with unknown protocol octets sent on the interface unicast packets sent on the interface non-unicast packets sent on the interface outbound packets discarded outbound packets with detected errors
228
S1A33985 12/2018
Attribute ID hex
05 dec
05
Description
Media Counters
Alignment Errors
FCS Errors
Single Collisions
Multiple Collisions
SQE Test Errors
Deferred Transmissions
UDINT
UDINT
Late Collisions UDINT
Excessive Collisions
MAC Transmit Errors
Carrier Sense Errors
UDINT
UDINT
UDINT
Type
STRUCT
UDINT
UDINT
UDINT
UDINT
X = supported
— = not supported
Frame Too Long
MAC Receive Errors
UDINT
UDINT
CIP objects
GET SET Value
X — frames that are not an integral number of octets in length bad CRC — frames received do not pass the FCS check successfully transmitted frames that experienced exactly 1 collision successfully transmitted frames that experienced more than 1 collision number of times the detected
SQE test error is generated frames for which first transmission attempt is delayed because the medium is busy number of times a collision is detected later than 512 bit times into the transmission of a packet frames that do not transmit due to excessive collisions frames that do not transmit due to a detected internal MAC sublayer transmit error times that the carrier sense condition was lost or not asserted when attempting to transmit a frame frames received that exceed the maximum permitted frame size frames not received on an interface due to a detected internal MAC sublayer receive error
S1A33985 12/2018
229
CIP objects
Attribute ID hex
06 dec
06
Description Type GET SET Value
10 16
Interface Control
Control Bits
Forced Interface Speed
Interface Label
STRUCT
WORD
UINT
X
SHORT_STRING X
X
—
API of the connection
Bit 0: Auto-negotiation
0 = disabled
1 = enabled
Note: When auto-negotiation is enabled, 0x0C (object state conflict) is returned when attempting to set either:
forced interface speed
or forced duplex mode
Bit 1: forced duplex mode (if auto-negotiation bit = 0)
0 = half duplex
1 = full duplex
Valid values include:
10000000, 100000000
Note: Attempting to set any other value returns the detected error 0x09
(invalid attribute value)
A fixed textual string identifying the interface, that should include
‘internal’ for internal interfaces.
Maximum number of characters is 64.
X = supported
— = not supported
Services
The Ethernet Link object performs the following services upon the listed object types:
Description Class Instance Service ID hex
01
10
0E
4C dec
01
16
14
76
X = supported
— = not supported
Get_Attributes_All
Set_Attribute_Single
Get_Attribute_Single
Get_and_Clear
X
—
X
—
X
X
X
X
230
S1A33985 12/2018
CIP objects
EtherNet/IP Interface Diagnostics Object
Overview
The EtherNet/IP Interface Diagnostics object presents the instances, attributes and services described below.
Class ID
350 (hex), 848 (decimal)
Instance IDs
The EtherNet/IP Interface object presents two instance values:
0: class
1: instance
Attributes
EtherNet/IP Interface Diagnostics object attributes are associated with each instance, as follows:
Instance ID = 0 (class attributes):
Attribute ID
01
Description
Revision
02 Max Instance
X = supported
— = not supported
GET
X
X
SET
—
—
S1A33985 12/2018
231
CIP objects
Instance ID = 1 (instance attributes):
Attribute ID
01
02
03
Description
Protocols Supported
Current CIP IO
Connections
Max CIP Explicit
Connections opened
Current CIP Explicit
Connections
CIP Connections
Opening Errors
CIP Connections
Timeout Errors
Max EIP TCP
Connections opened
Current EIP TCP
Connections
IO Messaging
Diagnostics
IO Production Counter
Type
UINT
Connection Diagnostics STRUCT X
Max CIP IO Connections opened
UINT
UINT
UINT
UINT
UINT
UINT
UINT
UINT
STRUCT
UDINT
GET SET Value
X —
—
X X
Number of Class 1 connections opened since the last reset
Number of Class 1 connections currently opened
Number of Class 3 connections opened since the last reset
Number of Class 3 connections currently opened
Increments each time a Forward Open is not successful (Originator and Target)
Increments when a connection times out
(Originator and Target)
Number of TCP connections (used for EIP, as client or server) opened since the last reset
Number of TCP connections (used for EIP, as client or server) currently open
IO Consumption
Counter
IO Production Send
Errors Counter
IO Consumption
Receive Errors Counter
X = supported
— = not supported
UDINT
UINT
UINT
Increments each time a Class 0/1 message is sent
Increments each time a Class 0/1 message is received
Increments each time a Class 0/1 message is not sent
Increments each time a consumption is received with a detected error
232
S1A33985 12/2018
CIP objects
Attribute ID
04
Description
Explicit Messaging
Diagnostics
Class 3 Msg Send
Counter
Class 3 Msg Receive
Counter
UCMM Msg Receive
Counter
UCMM Msg Receive
Counter
X = supported
— = not supported
Type GET
STRUCT X
SET
X
Value
UDINT
UDINT
UDINT
UDINT
Increments each time a Class 3 message is sent (client and server)
Increments each time a Class 3 message is received (client and server)
Increments each time a UCMM message is sent (client and server)
Increments each time a UCMM message is received (client and server)
Services
The EtherNet/IP Interface Diagnostics object performs the following services upon the listed object types:
Description Class Instance Notes Service ID hex dec
01
0E
4C
01
14
76
Get_Attributes_All
Get_Attribute_Single
Get_and_Clear
X
—
—
X
X
X
Returns the value of all attributes.
Returns the value of the specified attribute.
Returns and clears the values of all instance attributes.
X = supported
— = not supported
S1A33985 12/2018
233
CIP objects
EtherNet/IP IO Scanner Diagnostics Object
Overview
The EtherNet/IP IO Scanner Diagnostics object presents the instances, attributes and services described below.
Class ID
351 (hex), 849 (decimal)
Instance IDs
The EtherNet/IP IO Scanner Diagnostics object presents two instances:
0: class
1: instance
Attributes
EtherNet/IP IO Scanner Diagnostics object attributes are associated with each instance, as follows:
Instance ID = 0 (class attributes):
Attribute ID
01
Description
Revision
02
X = supported
— = not supported
Max Instance
GET
X
X
SET
—
—
Instance ID = 1 (instance attributes):
Attribute ID
01
Description
IO Status Table
Size
Status
X = supported
— = not supported
Type
STRUCT
UINT
ARRAY of
UNINT
GET
X
SET
—
234
S1A33985 12/2018
CIP objects
Services
The EtherNet/IP IO Scanner Diagnostics object performs the following services upon the listed object types:
Class Instance Notes Service ID hex dec
01
0E
01
14
Description
Get_Attributes_All
Get_Attribute_Single
X = supported
— = not supported
X
X
X
X
Returns the value of all attributes.
Returns the value of the specified attribute.
S1A33985 12/2018
235
CIP objects
IO Connection Diagnostics Object
Overview
The IO Connection Diagnostics object presents the instances, attributes and services described below.
Class ID
352 (hex), 850 (decimal)
Instance IDs
The IO Connection Diagnostics object presents two instance values:
0: class
1...256: instance (The instance number is the connection number in the configuration.)
Attributes
IO Connection Diagnostics object attributes are associated with each instance, as follows:
Instance ID = 0 (class attributes):
Attribute ID
01
Description
Revision
02 Max Instance
X = supported
— = not supported
GET
X
X
SET
—
—
236
S1A33985 12/2018
CIP objects
Instance ID = 1 to 256 (instance attributes):
Attribute ID
01
Description
IO Communication
Diagnostics
IO Production Counter
IO Consumption Counter
Type
STRUCT
UDINT
UDINT
UINT IO Production Send Errors
Counter
IO Consumption Receive
Errors Counter
CIP Connection Timeout
Errors
CIP Connection Opening
Errors
UINT
UINT
UINT
CIP Connection State UINT
CIP Last Error General Status UINT
CIP Last Error Extended
Status
UINT
Input Communication Status UINT
Output Communication Status UINT
X = supported
— = not supported
GET SET Value
X X
Increments at each production
Increments at each consumption
Increments each time a production is not sent
Increments each time a consumption is received with a detected error
Increments when a connection times out
Increments each time a connection is unable to open
State of the Connection Bit
General status of the last error detected on the connection
Extended status of the last error detected on the connection
Communication status of the inputs
(see table, below)
Communication status of the outputs
(see table, below)
S1A33985 12/2018
237
CIP objects
Attribute ID
02
Description
Connection Diagnostics
Production Connection ID
Consumption Connection ID
Production RPI
Production API
Consumption RPI
Consumption API
Production Connection
Parameters
Consumption Connection
Parameters
Local IP
Local UDP Port
Remote IP
Remote UDP Port
Production Multicast IP
Consumption Multicast IP
Protocols Supported
Type
STRUCT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UINT
UDINT
UINT
UDINT
UDINT
UDINT
GET SET Value
X X
Connection ID for production
Connection ID for consumption
RPI for production
API for production
RPI for consumption
API for consumption
Connection parameters for production
Connection parameters for consumption
—
—
—
—
Multicast IP used for production (or 0)
Multicast IP used for consumption (or
0)
Protocol supported on the connection:
1 = EtherNet/IP
X = supported
— = not supported
The following values describe the structure of the instance attributes: CIP Connection State ,
Input Communication Status , and Output Communication Status :
Bit Number
15...3
2
1
0
Description
Reserved
Idle
Consumption inhibited
Production inhibited
Values
0
0 = no idle notification
1 = idle notification
0 = consumption started
1 = no consumption
0 = production started
1 = no production
238
S1A33985 12/2018
CIP objects
Services
The EtherNet/IP Interface Diagnostics object performs the following services upon the listed object types:
Description Class Instance Notes Service ID hex dec
01
0E
4C
01
14
76
Get_Attributes_All
Get_Attribute_Single
Get_and_Clear
X
—
—
X
X
X
Returns the value of all attributes.
Returns the value of the specified attribute.
Returns and clears the values of all instance attributes.
X = supported
— = not supported
S1A33985 12/2018
239
CIP objects
EtherNet/IP Explicit Connection Diagnostics Object
Overview
The EtherNet/IP Explicit Connection Diagnostics object presents the instances, attributes and services described below.
Class ID
353 (hex), 851 (decimal)
Instance IDs
The EtherNet/IP Explicit Connection Diagnostics object presents two instance values:
0: class
1...
N : instance ( N = maximum concurrent number of explicit connections)
Attributes
EtherNet/IP Explicit Connection Diagnostics object attributes are associated with each instance, as follows:
Instance ID = 0 (class attributes):
Attribute ID hex
01
02
X = supported
— = not supported
Description
Revision
Max Instance
Value
1
0...N
GET
X
X
SET
—
—
Instance ID = 1 to N (instance attributes):
Attribute ID hex
01
02
03
04
05
06
Description
Originator connection ID
Originator IP
Originator TCP Port
Target connection ID
Target IP
Target TCP Port
X = supported
— = not supported
Type GET SET Value
UDINT X
UINT X
UDINT X
UDINT X
UDINT X
UDINT X
—
—
—
—
—
—
Originator to target connection ID
Target to originator connection ID
240
S1A33985 12/2018
CIP objects
Attribute ID hex
07
Description
Msg Send Counter
08 Msg Receive counter
Type GET
UDINT X
UDINT X
SET
—
—
Value
Incremented each time a Class 3
CIP message is sent on the connection
Increments each time a Class 3 CIP message is received on the connection
X = supported
— = not supported
Services
The EtherNet/IP Explicit Connection Diagnostics object performs the following services upon the listed object type:
Class Instance Notes Service ID hex dec
01 01
Description
Get_Attributes_All
X = supported
— = not supported
X X Returns the value of all attributes.
S1A33985 12/2018
241
CIP objects
EtherNet/IP Explicit Connection Diagnostics List Object
Overview
The EtherNet/IP Explicit Connection Diagnostics List object presents the instances, attributes and services described below.
Class ID
354 (hex), 852 (decimal)
Instance IDs
The EtherNet/IP Explicit Connection Diagnostics List object presents two instance values:
0: class
1...
N : instance
Attributes
EtherNet/IP Explicit Connection Diagnostics List object attributes are associated with each instance, as follows:
Instance ID = 0 (class attributes):
Attribute ID
01
Description
Revision
02 Max Instance
X = supported
— = not supported
GET
X
X
SET
—
—
242
S1A33985 12/2018
CIP objects
Instance ID = 1 to N (instance attributes):
Attribute ID
01
02
Description Type
Number of connections UINT
Explicit Messaging
Connections Diagnostic
List
ID
Originator connection
ARRAY of
STRUCT
UDINT
Originator IP
Originator TCP port
UINT
UDINT
Target connection ID UDINT
Target IP UDINT
Target TCP port
Msg Send counter
UDINT
UDINT
Msg Receive counter UDINT
GET SET Value
X — Total number of opened explicit connections
X —
O->T connection ID
—
—
T->O connection ID
—
—
Increments each time a Class 3 CIP message is sent on the connection
Increments each time a Class 3 CIP message is received on the connection
X = supported
— = not supported
Services
The EtherNet/IP Explicit Connection Diagnostics object performs the following services upon the listed object types:
Service ID hex dec
01
08
01
08
09
4B
09
75
X = supported
— = not supported
Description Class Instance Notes
Get_Attributes_All
Create
X
X
Delete —
Explicit_Connections_Diagnostic_Read —
—
—
X
X
Returns the value of all attributes.
—
—
—
S1A33985 12/2018
243
CIP objects
244
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Online Action
S1A33985 12/2018
Online Action Chapter 7
Online Action
Overview
The Ethernet communication module supports online actions that let you:
display CIP objects for the communication module or a remote EtherNet/IP device
view and edit port configuration parameters for the communication module or a remote
EtherNet/IP device ping the communication module or a remote EtherNet/IP or Modbus TCP device to confirm it is active on the Ethernet network
connect to a remote device and then:
view the remote device’s default parameter settings
view the remote device’s current parameter settings edit and download to the remote device its editable parameter settings
What Is in This Chapter?
This chapter contains the following topics:
Topic
Accessing CIP Objects
Editing Port Configuration Properties for Remote EtherNet/IP Devices
Pinging a Network Device
Viewing and Editing Online Settings for a Remote Device
Page
S1A33985 12/2018
245
Online Action
Accessing CIP Objects
Overview
Use the Module Information page of the Online Action window to:
retrieve and display current data describing the state of CIP objects for the selected
communication module or remote EtherNet/IP device, and reset the selected communication module or remote EtherNet/IP device
NOTE: Before you can perform online actions for a communication module or remote device, connect its DTM to the physical module or device. To do this, select the module or device node in the DTM Browser, then select Edit → Connect.
The appearance of this page, and the CIP object information you can retrieve, depend upon the operating mode of the Control Expert software:
In this mode...
Standard mode
You can display data for these CIP objects...
Identity object
Identity object
TCP/IP Interface object
Ethernet Link object
The Module Information page looks like this:
246
S1A33985 12/2018
Online Action
Retrieve and Display CIP Object Data
To display CIP object data for an EtherNet/IP communication module or remote device:
Step
1
2
3
4
5
6
Action
In the DTM Browser, select a communication module.
Click the right mouse button, and in the pop-up menu select Device menu →
Online Action. The Online Action window opens.
In the left pane of the Online Action window, select a communication module or
EtherNet/IP device.
In the right pane, click on the Module Information tab to open that page.
If Control Expert is operating in Advanced Mode
Select one of the following CIP objects:
Identity
Connection Manager
TCP/IP
Ethernet Link
QoS
If you selected a multi-port module or device in step 3, above, select an
Interface, or port, number
NOTE: If Control Expert is operating in Standard Mode, it will display data only for the CIP Identity object.
Click the Refresh button to update the data displayed.
Reset a Communication Module or Remote EtherNet/IP Device
To reset a communication module or remote EtherNet/IP device:
Step
1
2
3
4
5
Action
In the DTM Browser, select a communication module.
Click the right mouse button, and in the pop-up menu select Device menu →
Online Action. The Online Action window opens.
In the left pane of the Online Action window, select a communication module or
EtherNet/IP device.
In the right pane, click on the Module Information tab to open that page.
Click the Reset Device button.
S1A33985 12/2018
247
Online Action
Editing Port Configuration Properties for Remote EtherNet/IP Devices
Overview
Use the Port Configuration page of the Online Action window to view and edit communication port properties for a remote EtherNet/IP device. Specifically, you can use this page to execute a:
Get command to retrieve port configuration settings from a remote EtherNet/IP device
Set command that writes all or selected edited values to the same remote EtherNet/IP device
Configuration edits transmitted from this page are sent as EtherNet/IP explicit messages and employ the Address and Messaging settings configured in the EtherNet/IP Explicit Messaging window.
NOTE: Before you can perform online actions for a remote device, connect its DTM to the physical device. To do this, select the device node in the DTM Browser, then select Edit → Connect.
The Port Configuration page looks like this:
248
S1A33985 12/2018
Online Action
Get Port Configuration Settings
To get settings from a remote EtherNet/IP device on the network:
Step
1
2
3
4
5
6
7
8
9
Action
In the DTM Browser, select the communication module upstream of the remote
EtherNet/IP device.
Click the right mouse button, and in the pop-up menu select Device menu →
EtherNet/IP Explicit Message. The EtherNet/IP Explicit Message window opens.
In the EtherNet/IP Explicit Messaging page, complete the Address section.
Note: Port configuration explicit messages are sent as unconnected messages.
Return to the DTM Browser and again select the communication module upstream of the remote EtherNet/IP device.
Click the right mouse button, and in the pop-up menu select Device menu →
Online Action. The Online Action window opens.
In the left pane of the Online Action window, select a remote EtherNet/IP device.
In the right pane, click on the Port Configuration tab to open that page.
If the remote device consists of more than one port, select the port number in the Physical Interface Instance list.
In the Port Configuration page, click the Get Values from Device button.
The table displays the returned values of the communication properties for the selected remote device and port.
Edit and Set Port Configuration Settings
To edit and set port configuration settings that were retrieved using the above-described Get Port
Configuration Settings process:
Step
1
2
3
4
Action
Double-click the left mouse button in the Value cell for the parameter you want to edit. The cell becomes editable.
Note: The page also displays a Description of the selected parameter.
Type in, or select, the new value.
Repeat steps 1 - 2 for each parameter you want to edit.
Do one of the following:
Click the Set All Values to Device to write every value to the remote device
- or if you edited parameters for only one part, or group, of the collection of remote device values, then:
in the Set Part of Values area, select one property group, then
click the Set Values to Device button
Control Expert sends the property value edits to the remote device via an
EtherNet/IP explicit message, and displays the results in the Description area.
S1A33985 12/2018
249
Online Action
Pinging a Network Device
Overview
Use the Control Expert ping function to send an ICMP echo request to a target Ethernet device to determine:
if the target device is present, and if so the elapsed time to receive an echo response from the target device
The target device is identified by its IP address setting. Control Expert will verify that the target address is not a:
loopback address (127.000.000.000 to 127.255.255.255) multicast address (224.000.000.000 to 239.255.255.255) reserved address (240.000.000.000 to 255.255.255.255) broadcast address
The ping function can be performed in the Ping page of the Online Action window:
250
S1A33985 12/2018
Pinging a Network Device
To ping a network device:
Step
1
2
3
4
5
6
7
8
Action
In the DTM Browser, select the communication module upstream of the remote
EtherNet/IP device you want to ping.
Click the right mouse button and select Device Menu > → Online Action in the pop-up menu. The Online Action window opens.
In the Online Action window, select the device you want to ping. The window displays pages containing online information for the selected device.
NOTE: The specific collection of displayed pages depends on the type of device selected:
the communication module
a remote EtherNet/IP device a remote Modbus TCP device
Select the Ping page. To send...
a single ping, de-select the Repeat checkbox
a series of pings—1 every 100 ms—select Repeat checkbox
(Optional) Select Stop on Error to stop pinging an unsuccessful communication.
Click Ping once to begin pinging.
Click Ping a second time to stop repeated pinging, where no error has been detected.
The Ping Result box displays the ping outcome. Click Clear to empty the
Ping Result box.
Online Action
S1A33985 12/2018
251
Online Action
Viewing and Editing Online Settings for a Remote Device
Introduction
Use the Online Parameters window to:
view the remote device’s default parameter settings
view the remote device’s current parameter settings edit and download to the remote device its editable parameter settings
Parameter setting edits transmitted from this page are sent as EtherNet/IP explicit messages and employ the Address and Messaging settings configured in the EtherNet/IP Explicit Messaging window.
NOTE: Before you can view and edit online settings for a remote device, connect its DTM file to the physical device. To do this, select the device node in the DTM Browser, then select Edit →
Connect.
To open the Online Parameters window, follow these steps:
Step
1
2
3
Action
In the DTM Browser, select the node for a remote device.
Click the right mouse button, and in the pop-up menu select Device menu →
Online Parameters. The Online Parameters window opens for the selected remote device.
In the left pane of the Online Parameters window, select a connection node.
Control Expert displays the parameters relating to the selected connection in the right pane.
NOTE: The list of parameters displayed in the Online Parameters window depends upon:
the device selected in the DTM Browser, and
the connection selected in the left pane of the Online Parameters window
252
S1A33985 12/2018
Online Action
An example of the Online Parameters window—in this case for the STB NIC 2212 remote network interface device—looks like this:
Read-only parameters are identified by a locked icon .
Editable parameters are identified by a blue arrowhead .
Displaying Default Parameter Settings
To view the default parameter settings for the remote device, click the Get Values from EDS button. Control Expert reads the default device values from its EDS file and displays them onscreen.
Displaying Online Parameter Settings
To view the current parameter settings for the remote device, follow these steps:
Step
1
2
Action
With a connection selected in the left pane, click the Synchronize button. The
Synchronize Action message box opens.
In the message box, select Read values from the device, then click OK.
The message box closes. In the Online Parameters window:
the Status field displays the results of the read transaction the parameter list displays current values
S1A33985 12/2018
253
Online Action
Editing Online Parameter Settings
To edit parameter settings for the remote device, follow these steps:
3
4
Step
1
2
Action
With a connection selected in the left pane, display either:
default device settings, or
current device settings
In the Value column, type in or select a new value for each setting you want to edit.
NOTE: When you select a parameter, the Description area displays an explanation of the parameter and its available settings.
Click the Synchronize button. The Synchronize Action message box opens.
In the message box, select Write data to the device, then click OK.
The message box closes. In the Online Parameters window, the Status field displays the results of the write transaction.
254
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Explicit Messaging
S1A33985 12/2018
Explicit Messaging Chapter 8
Explicit Messaging
Overview
The Ethernet communication module supports explicit messaging via the EtherNet/IP and Modbus
TCP protocols.
NOTE: A single Control Expert application can contain more than 16 explicit messaging blocks, but only 16 explicit messaging blocks can be active at the same time.
This chapter describes how to use both Control Expert function block logic and the Control Expert interface to send explicit messages.
What Is in This Chapter?
This chapter contains the following sections:
Section
8.1
8.2
8.3
8.4
Topic
Explicit Messaging Using the MBP_MSTR Block
EtherNet/IP Explicit Messaging Using MBP_MSTR
Modbus TCP Explicit Messaging Using MBP_MSTR
Explicit Messaging via the Control Expert GUI
Page
S1A33985 12/2018
255
Explicit Messaging
Explicit Messaging Using the MBP_MSTR Block Section 8.1
Explicit Messaging Using the MBP_MSTR Block
Configuring Explicit Messaging Using MBP_MSTR
Overview
You can use the MBP_MSTR function block to configure both Modbus TCP and EtherNet/IP connected and unconnected explicit messages.
The operation begins when the input to the EN pin is turned ON. The operation ends if the ABORT pin is turned ON, or if the EN pin is turned OFF.
The CONTROL and DATABUF output parameters define the operation.
NOTE: The structure and content of the CONTROL and DATABUF output parameters differ for explicit messages configured using the EtherNet/IP and Modbus TCP protocols. Refer to the topics
Configuring the Control Parameter for EtherNet/IP and Configuring the Control Parameter for
Modbus TCP for instructions on how to configure these parameters for each protocol.
The ACTIVE output turns ON during operation; the ERROR output turns ON if the operation aborts without success; the SUCCESS output turns ON at the successful completion of the operation.
EN and ENO can be configured as additional parameters.
Representation in FBD
Input Parameters
Parameter
ENABLE
ABORT
256
Data type
BOOL
BOOL
Description
When ON, the explicit message operation (specified in the first element of the CONTROL pin) is executing.
When ON, the operation is aborted.
S1A33985 12/2018
Explicit Messaging
Output Parameters
Parameter
ACTIVE
ERROR
SUCCESS
Data type
BOOL
BOOL
BOOL
Description
ON when the operation is active.
OFF at all other times.
ON when the operation is aborted without success.
OFF before operation, during operation, and if operation succeeds.
ON when the operation concludes successfully.
OFF before operation, during operation, and if operation does not conclude successfully.
CONTROL
DATABUF
1
1
WORD
WORD
This parameter contains the control block. The first element contains a code describing the operation to be performed. The content of the control block depends on the operation. The structure of the control block depends on the protocol (EtherNet/IP or Modbus TCP).
Note: Assign this parameter to a located variable.
This parameter contains the data buffer. For operations that:
provide data — e.g., a write operation — this
parameter is the data source receive data — e.g., a read operation — this parameter is the data destination
Note: Assign this parameter to a located variable.
1. Refer to the topics Configuring the Control Block for EtherNet/IP and Configuring the
Control Block for Modbus TCP for instructions on how to configure these parameters for the
EtherNet/IP and Modbus TCP communication protocols.
S1A33985 12/2018
257
Explicit Messaging
EtherNet/IP Explicit Messaging Using MBP_MSTR Section 8.2
EtherNet/IP Explicit Messaging Using MBP_MSTR
Overview
This section shows you how to configure the MBP_MSTR function block for EtherNet/IP explicit messages.
What Is in This Section?
This section contains the following topics:
Topic
EtherNet/IP Explicit Messaging Services
Configuring the CONTROL and DATABUF Parameters
MBP_MSTR Example: Get_Attributes_Single
MBP_MSTR Example – Read Modbus Object
MBP_MSTR Example – Write Modbus Object
Page
258
S1A33985 12/2018
Explicit Messaging
EtherNet/IP Explicit Messaging Services
Overview
Every EtherNet/IP explicit message performs a service. Each service is associated with a service code (or number). You will need to identify the explicit messaging service by its name, decimal number, or hexadecimal number.
You can execute EtherNet/IP explicit messages using either a Control Expert MBP_MSTR function block or the Control Expert Ethernet Configuration Tool’s EtherNet/IP Explicit Message Window.
NOTE: Configuration edits made to an Ethernet communication module from the Control Expert
Ethernet Configuration Tool’s EtherNet/IP Explicit Message Window are not saved to the operating parameters stored in the CPU and, therefore, are not sent by the CPU to the module on startup.
You can use Control Expert to construct a request that executes any service supported by the target device that is compliant with the EtherNet/IP protocol.
Services
The services supported by Control Expert include the following standard explicit messaging services:
1
2
5
6
3
4
9
A
7
8
Service Code
Hex Dec
D
E
10
11
1
2
3
4
5
6
7
8
9
10
13
14
16
17
Description
Get_Attributes_All
Set_Attributes_All
Get_Attribute_List
Set_Attribute_List
Reset
Start
Stop
Create
Delete
Multiple_Service_Packet
Apply_Attributes
Get_Attribute_Single
Set_Attribute_Single
Find_Next_Object_Instance
14 20 Detected Error Response
(DeviceNet only)
"X" = the service is available.
"—" = the service is not available.
X
X
X
X
—
X
X
X
X
X
X
X
X
X
X
Available in...
MBP_MSTR block Control Expert GUI
X
X
—
—
X
X
X
X
X
—
X
X
X
X
—
S1A33985 12/2018
259
Explicit Messaging
Service Code
Hex Dec
15
16
17
18
21
22
23
24
Description
Restore
Save
No Operation (NOP)
Get_Member
19
1A
1B
1C
25
26
27
28
Set_Member
Insert_Member
Remove_Member
GroupSync
"X" = the service is available.
"—" = the service is not available.
X
X
X
X
X
X
X
X
Available in...
MBP_MSTR block Control Expert GUI
X
X
X
X
X
X
X
—
260
S1A33985 12/2018
Explicit Messaging
Configuring the CONTROL and DATABUF Parameters
Overview
The CONTROL and DATABUF output parameters define the operation performed by the MBP_MSTR function block. For the EtherNet/IP protocol, the structure of the CONTROL and DATABUF output parameters remains the same for every explicit messaging service
see page 259
.
Configuring the Control Parameter
The Control parameter consists of 9 contiguous words, as described below:
Register
CONTROL[0]
CONTROL[1]
CONTROL[2]
CONTROL[3]
Function
Operation
Detected error status
Data buffer length
Response offset
Description
14 = unconnected
270 = connected
Holds the event code only).
Data buffer length, in words
Offset for the beginning of the response in the data buffer, in 16-bit words
Note: To avoid overwriting the request, confirm that the response offset value is greater than the request length CONTROL[7] .
CONTROL[4]
CONTROL[5]
CONTROL[6]
1
1
Slot
IP address
High byte = slot location on backplane
Low byte = 0 (not used)
High byte = byte 4 of the IP address (MSB)
Low byte = byte 3 of the IP address
High byte = byte 2 of the IP address
Low byte = byte 1 of the IP address (LSB)
Length of the CIP request, in bytes CONTROL[7] Request length
CONTROL[8] Response length Length of the response received, in bytes
Read only—set after completion
1. For example, the Control parameter handles the IP address 192.168.1.6 in the following order: Byte 4 = 192, Byte 3 = 168, Byte 2 = 1, Byte 1 = 6.
S1A33985 12/2018
261
Explicit Messaging
Configuring the Data Buffer
The data buffer varies in size. It consists of contiguous registers that include—in sequence—both the CIP request and the CIP response. To avoid overwriting the request, confirm that the data buffer is large enough to simultaneously contain both the request and response data.
Data Buffer:
Variable size: set in CONTROL[2]
CIP Request:
Request size: set in CONTROL[7]
CIP Response:
Starting position: set in CONTROL[3]
Response size: reported in CONTROL[8]
NOTE: If the response offset is smaller than the request size, the response data overwrites part of the request.
The format of the data buffer’s CIP request and CIP response is described, below.
NOTE: Structure both the request and response in little endian order.
Request:
Byte offset Field
0 Service
1 Request_Path_Size
2
...
Request_Path
Request_Data
Data type
Byte
Byte
Padded
EPATH
Byte array
Description
Service of the explicit message
The number of words in the
Request_Path field
This byte array describes the path of the request—including class ID, instance ID, etc.—for this transaction
Service specific data to be delivered in the explicit message request—if none, this field is empty
262
S1A33985 12/2018
Explicit Messaging
Response:
Byte offset Field
0 Reply Service
Data type
Byte
Description
Service of the explicit message +
16#80
1
2
Reserved
General Status
Byte
Byte
0
EtherNet/IP General Status
Additional Status array size—in words 3
4
Size of Additional
Status
Additional Status
Byte
Word array Additional status 1
...
Response Data Byte array Response data from request, or additional detected error data if
General Status indicates a detected error
1. Refer to The CIP Networks Library, Volume 1, Common Industrial Protocol at section 3-5.6
Connection Manager Object Instance Detected Error Codes ;
S1A33985 12/2018
263
Explicit Messaging
MBP_MSTR Example: Get_Attributes_Single
Overview
The following unconnected explicit messaging example shows you how to use the MBP_MSTR function block to retrieve diagnostic information for an STB island from an STB NIC 2212 network interface module, by using the Get_Attributes_Single service.
You can perform the same explicit messaging service using the EtherNet/IP Explicit Message
Window of the Control Expert Ethernet Configuration Tool (
see page 290
Implementing the MBP_MSTR Function Block
To implement the MBP_MSTR function block, you need to create and assign variables, then connect it to an AND block. In the following example, the logic will continuously send an explicit message upon receiving notice of success:
Input Variables
Variables need to be created and assigned to input pins. For the purpose of this example, variables have been created — and named — as described below. (You can use different variable names in your explicit messaging configurations.)
Input Pin
ENABLE
ABORT
Variable
Enable
StopEM
Data Type
BOOL
BOOL
264
S1A33985 12/2018
Explicit Messaging
Output Variables
Variables also need to be created and assigned to output pins. (The names assigned to output variables apply only to this example, and can be changed in your explicit messaging configurations.)
Output Pin
ACTIVE
ERROR
SUCCESS
CONTROL
DATABUF
Variable
EMActive
EMError
EMSuccess
EIP_ControlBuf
EIP_DataBuf
Data Type
BOOL
BOOL
BOOL
Array of 10 WORD s
Array of 100 WORD s
NOTE: To simplify configuration, you can assign the CONTROL and DATABUF output pins to a byte array consisting of located variables. When configured in this manner, you will not need to be aware of the location of data within a word (for example, high versus low byte, and big or little endian format).
Control Array
The control array parameter ( EIP_ControlBuf ) consists of 9 contiguous words. You need to configure only some control words; other control words are read-only and are written to by the operation. In this example, the control array defines the operation as an unconnected explicit message, and identifies the target device:
Register
CONTROL[0]
CONTROL[1]
CONTROL[2]
CONTROL[3]
CONTROL[4]
Description
Operation:
High byte =
00 (unconnected), or
01 (connected)
Low byte = 0E (CIP explicit message)
Detected error status: read-only (written by operation)
Data buffer length = 100 words
Response offset: offset — in words — for the beginning of the explicit message response in the databuffer
High byte = slot location of the communication module in the backplane
Low byte = 0 (not used)
Configure
Yes
No
Yes
Yes
Yes
Setting (hex)
16#000E
(unconnected)
16#0000
16#0064
16#0004
16#0400
S1A33985 12/2018
265
Explicit Messaging
Register
CONTROL[5]
1
CONTROL[6]
1
Description
IP address of the Ethernet communication module:
High byte = byte 4 of the IP address
Low byte = byte 3 of the IP address
IP address of the Ethernet communication module:
High byte = byte 2 of the IP address
Low byte = byte 1 of the IP address
CIP request length (in bytes)
Configure
Yes
Yes
Setting (hex)
16#C0A8
16#0106
CONTROL[7] Yes 16#0008
CONTROL[8] Length of received response (written by operation)
No 16#0000
1. In this example, the control parameter handles the IP address 192.168.1.6 in the following order: Byte 4 = 192, Byte 3 = 168, Byte 2 = 1, Byte 1 - 6.
CIP Request
The CIP request is located at the beginning of the databuffer and is followed by the CIP response.
In this example, the CIP request calls for the return of a single attribute value (diagnostic data), and describes the request path through the target device’s object structure leading to the target attribute:
Request word
High byte
Description
1
2
3
4
Request path size (in words)
Request path: class assembly object
Request path: instance
Request path: attribute
Value
(hex)
16#03
16#04
16#64
16#03
Low byte
Description
EM Service:
Get_Attributes_Single
Request path: logical class segment
Request path: logical instance segment
Request path: logical attribute segment
Value
(hex)
16#0E
16#20
16#24
16#30
Combining the high and low bytes, above, the CIP request would look like this:
2
3
4
Request word
1
Value
16#030E
16#0420
16#6424
16#0330
266
S1A33985 12/2018
Explicit Messaging
Viewing the Response
Use a Control Expert Animation table to display the EIP_DataBuf variable array. Note that the
EIP_DataBuf variable array consists of the entire data buffer, which includes the:
CIP request (4 words) located in EIP_DataBuf(1-4)
CIP service type (1 word) located in EIP_DataBuf(5)
CIP request status (1 word) located in EIP_DataBuf(6)
CIP response (in this case, 10 words) located in EIP_DataBuf(7-16)
To display the CIP response, follow these steps:
Step
1
2
3
4
Action
In Control Expert, select Tools → Project Browser to open the Project Browser.
In the Project Browser, right-click Animation Tables → New Animation Table.
Result: A new animation table opens.
In the New Animation Table dialog, edit the following values:
Name Type in a table name. For this example: EIP_DataBuf.
Functional Mode
Comment
Accept the default <None>.
Leave blank.
Number of animated characters
Type 100, representing the size of the data buffer in words.
The completed dialog looks like this:
S1A33985 12/2018
Click OK to close the dialog.
267
Explicit Messaging
Step
5
6
Action
In the animation table’s Name column, type in the name of the variable assigned to the databuffer: EIP_DataBuf and press Enter. The animation table displays the
EIP_DataBuf variable.
Expand the EIP_DataBuf variable to display its word array, where you can view the
CIP response at words EIP_DataBuf(7-16):
Note: Each word presents 2 bytes of data in little endian format, where the least significant byte is stored in the smallest memory address. For example, ‘0E’ in
EIP_DataBuf[0] is the low byte, and ‘03’ is the high byte.
268
S1A33985 12/2018
Explicit Messaging
MBP_MSTR Example – Read Modbus Object
Overview
The following unconnected explicit messaging example shows you how to use the MBP_MSTR function block to retrieve data from a remote device—for example a 140 NOC 771 01, a
TSX ETC 101, or a BMX NOC 0401 Ethernet communication module at IP address 192.168.1.12
using the Read_Holding_Registers service of the Modbus object (
see page 220
You can perform the same explicit messaging service using the EtherNet/IP Explicit Message
Window of the Control Expert Ethernet Configuration Tool (
see page 290
Implementing the MBP_MSTR Function Block
To implement the MBP_MSTR function block, you need to create and assign variables, and connect it to an OR block. In the following example, the logic will continuously send an explicit message upon receiving notice of success or detected error.
Input Variables
Variables need to be created and assigned to input pins. For the purpose of this example, variables have been created and named as described below. (You can use different variable names in your explicit messaging configurations.)
Input Pin
ENABLE
ABORT
Variable
Enable
StopEM
Data Type
BOOL
BOOL
S1A33985 12/2018
269
Explicit Messaging
Output Variables
Variables also need to be created and assigned to output pins. (The names assigned to output variables apply only to this example, and can be changed in your explicit messaging configurations.)
Output Pin
ACTIVE
ERROR
SUCCESS
CONTROL
DATABUF
Variable
EMActive
EMError
EMSuccess
EIP_ControlBuf
EIP_DataBuf
Data Type
BOOL
BOOL
BOOL
Array of 10 INT
Array of 100 INT
NOTE: To simplify configuration, you can assign the CONTROL and DATABUF output pins to a byte array consisting of located variables. When configured in this manner, you will not need to be aware of the location of data within a word (for example, high versus low byte, and big or little endian format).
Control Array
The control array parameter (EIP_ControlBuf) consists of 9 contiguous words. You need to configure only some control words; other control words are read-only and are written to by the operation. In this example, the control array defines the operation as an unconnected explicit message, and identifies the target device:
Register
CONTROL[0]
CONTROL[1]
CONTROL[2]
CONTROL[3]
CONTROL[4]
CONTROL[5]
1
CONTROL[6]
1
Description
Operation:
High byte = 00 (unconnected)
Low byte = 0E (CIP explicit message)
Error status: read-only (written by operation)
Data buffer length = 100 INT
Response offset: offset — in words — for the beginning of the explicit message response in the databuffer
High byte = slot location of the communication module in the backplane
Low byte = 00 (not used)
IP address of the Ethernet communication module:
High byte = IP address byte 4 (192)
Low byte = IP address byte 3 (168)
IP address of the Ethernet communication module:
High byte = IP address byte 2 (001)
Low byte = IP address byte 1 (012)
Configure Setting (hex)
Yes 16#000E
No
Yes
Yes
Yes
Yes
Yes
16#0000
16#0064
16#0005
16#0400
16#C0A8
16#010C
270
S1A33985 12/2018
Explicit Messaging
Register
CONTROL[7]
Description
CIP request length (in bytes)
Configure Setting (hex)
Yes 16#000A
CONTROL[8] Length of received response (written by operation) No 16#0000
1. In this example, the control parameter handles the IP address 192.168.1.12 in the following order: Byte 4
= 192, Byte 3 = 168, Byte 2 = 1, Byte 1 - 12.
CIP Request
The CIP request is located at the beginning of the databuffer and is followed by the CIP response.
In this example, the CIP request calls for the return of a 5 contiguous word values, and describes the request path through the target device’s object structure leading to the target attribute. The values (decimal) to be returned are 11, 22, 33, 44 and 55:
1
2
Request word
High byte
Description
3
4
5
6
7
8...12
Request path size (in words)
Request path: class assembly object (Modbus Object)
Request path: instance
First word to read (not used)
Number of Words to Read (not used)
Service Code + response bit
(read-only)
Service response (not used)
Value
(hex)
16#02
16#44
16#01
16#00
16#00
16#00
16#00
Response words 1...5 (read only) 16#00
Low byte
Description
EM Service: Read_Holding_Register
Request path: logical class segment
(indicates an 8-bit object)
Request path: logical instance segment
(indicates an 8-bit instance)
First word to read: value + %MW1 (i.e. start at zero based second word)
Number of Words to Read: 5
Value
(hex)
16#4E
16#20
16#24
16#02
16#05
Response = CE (read-only) 16#00
Service response: 0=request did not succeed, 1=success (read only))
Response words 1...5 (read only)
16#00
16#00
Combining the high and low bytes, above, the CIP request would look like this:
2
3
Request word
1
4
5
6...12
Value
16#024E
16#4420
16#0124
16#0002
16#0005
16#0000
S1A33985 12/2018
271
Explicit Messaging
Viewing the Response
Use a Control Expert Animation table to display the EIP_DataBuf variable array. Note that the
EIP_DataBuf variable array consists of the entire data buffer, which includes the:
CIP request (5 words) located in EIP_DataBuf(0-4)
CIP service type (1 word) located in EIP_DataBuf(5)
CIP request status (1 word) located in EIP_DataBuf(6)
CIP response (in this case, 10 words) located in EIP_DataBuf(7-11)
To display the CIP response, follow these steps:
Step
1
2
3
4
Action
In Control Expert, select Tools → Project Browser to open the Project Browser.
In the Project Browser, right-click Animation Tables → New Animation Table.
Result: A new animation table opens.
In the New Animation Table dialog, edit the following values:
Name Type in a table name. For this example: EIP_DataBuf.
Functional Mode
Comment
Accept the default <None>.
Leave blank.
Number of animated characters
Type 100, representing the size of the data buffer in words.
The completed dialog looks like this:
272
Click OK to close the dialog.
S1A33985 12/2018
Step
5
6
Explicit Messaging
Action
In the animation table’s Name column, type in the name of the variable assigned to the databuffer: EIP_DataBuf and press Enter. The animation table displays the EIP_DataBuf variable.
Expand the EIP_DataBuf variable to display its word array, where you can view the CIP response at words EIP_DataBuf(7-16):
S1A33985 12/2018
Note: Each word presents 2 bytes of data in little endian format, where the least significant byte is stored in the smallest memory address. For example, ‘4E’ in EIP_DataBuf[0] is the low byte, and ‘02’ is the high byte.
273
Explicit Messaging
MBP_MSTR Example – Write Modbus Object
Overview
The following unconnected explicit messaging example shows you how to use the MBP_MSTR function block to write data to a remote device, for example a 140 NOC 771 01, a TSX ETC 101, or a BMX NOC 0401 Ethernet communication module at IP address 192.168.1.12 using the
Write_Holding_Registers service of the Modbus object (
see page 220
You can perform the same explicit messaging service using the EtherNet/IP Explicit Message
Window of the Control Expert Ethernet Configuration Tool (
see page 290
Implementing the MBP_MSTR Function Block
To implement the MBP_MSTR function block, you need to create and assign variables, and connect it to an OR block. In the following example, the logic will continuously send an explicit message upon receiving notice of success or detected error.
Input Variables
Variables need to be created and assigned to input pins. For the purpose of this example, variables have been created — and named — as described below. (You can use different variable names in your explicit messaging configurations.)
Input Pin
ENABLE
ABORT
Variable
Enable
StopEM
Data Type
BOOL
BOOL
274
S1A33985 12/2018
Explicit Messaging
Output Variables
Variables also need to be created and assigned to output pins. (The names assigned to output variables apply only to this example, and can be changed in your explicit messaging configurations.)
Output Pin
ACTIVE
ERROR
SUCCESS
CONTROL
DATABUF
Variable
EMActive
EMError
EMSuccess
EIP_ControlBuf
EIP_DataBuf
Data Type
BOOL
BOOL
BOOL
Array of 10 INT
Array of 100 INT
NOTE: To simplify configuration, you can assign the CONTROL and DATABUF output pins to a byte array consisting of located variables. When configured in this manner, you will not need to be aware of the location of data within a word (for example, high versus low byte, and big or little endian format).
Control Array
The control array parameter (EIP_ControlBuf) consists of 9 contiguous words. You need to configure only some control words; other control words are read-only and are written to by the operation. In this example, the control array defines the operation as an unconnected explicit message, and identifies the target device:
Register
CONTROL[0]
Setting (hex)
16#000E
CONTROL[1]
CONTROL[2]
CONTROL[3]
CONTROL[4]
CONTROL[5]
1
CONTROL[6]
1
Description
Operation:
High byte = 00 (unconnected)
Low byte = 0E (CIP explicit message)
Error status: read-only (written by operation)
Data buffer length = 20 (words)
Response offset: offset—in words (10)—for the beginning of the explicit message response in the databuffer
High byte = slot location (4) of the communication module in the backplane
Low byte = 00 (not used)
IP address of the Ethernet communication module:
High byte = IP address byte 4 (192)
Low byte = IP address byte 3 (168)
IP address of the Ethernet communication module:
High byte = IP address byte 2 (001)
Low byte = IP address byte 1 (012)
Configure
Yes
No
Yes
Yes
Yes
Yes
Yes
16#0000
16#0014
16#000A
16#0400
16#C0A8
16#010C
S1A33985 12/2018
275
Explicit Messaging
Register
CONTROL[7]
Description
CIP request length (20) in bytes
Configure
Yes
Setting (hex)
16#0014
CONTROL[8] Length of received response (written by operation) No 16#0000
1. In this example, the control parameter handles the IP address 192.168.1.12 in the following order: Byte 4
= 192, Byte 3 = 168, Byte 2 = 1, Byte 1 - 12.
CIP Request
The CIP request is located at the beginning of the databuffer and is followed by the CIP response.
In this example, the CIP request calls for the writing of 5 contiguous words beginning at position 2, and describes the request path through the target device’s object structure leading to the target attribute The values to be written in sequence are 111, 222, 333, 444, and 555:
1
2
Request word
3
High byte
Description
Request path size (in words)
Request path: class assembly object (Modbus Object)
Request path: instance
Value
(hex)
16#02
16#44
16#01
4
9
10
11
7
8
5
6
12
13
14
First word to write (not used)
Number of words to write
Data words 1
Data words 2
Data words 3
Data words 4
Data words 5
Service Code + response bit
(read-only)
Service response (read only)
Location of first word to write response (read only)
Number of words to write response (read only)
16#00
16#00
16#00
16#00
16#01
16#01
16#02
16#00
16#00
16#00
16#00
Low byte
Description
EM Service: Write_Holding_Register
Request path: logical class segment
(indicates an 8-bit object)
Request path: logical instance segment
(indicates an 8-bit instance)
First word to write: value + %MW1 (i.e. start at zero based second word)
Number of words to write: 5
Data words 1
Data words 2
Data words 3
Data words 4
Data words 5
Service Code + response bit (read-only) response = D0
Value
(hex)
16#50
16#20
16#24
16#02
Service response (read only) success = 0 16#00
Location of first word to write response
(read only)
16#00
Number of words to write response (read only)
16#00
16#05
16#6F
16#DE
16#4D
16#BC
16#2B
16#000
276
S1A33985 12/2018
Explicit Messaging
Combining the high and low bytes, above, the CIP request would look like this:
12
13
14
8
9
10
11
6
7
4
5
2
3
Request word
1
Value
16#0250
16#4420
16#0124
16#0002
16#0005
16#006F
16#00DE
16#014D
16#01BC
16#022B
16#0000
16#0000
16#0000
16#0000
Viewing the Response
Use a Control Expert Animation table to display the EIP_DataBuf variable array. Note that the
EIP_DataBuf variable array consists of the entire data buffer, which includes the:
CIP request (5 words) located in EIP_DataBuf(0-4)
CIP response (in this case, 5 words) located in EIP_DataBuf(5-9)
CIP service type (1 word) located in EIP_DataBuf(10)
CIP request status (1 word) located in EIP_DataBuf(11)
Echo of location of first word to write in EIP_DataBuf(12)
Echo of number of words to write in EIP_DataBuf(12)
S1A33985 12/2018
277
Explicit Messaging
To display the CIP response, follow these steps:
Step
1
2
3
4
Action
In Control Expert, select Tools → Project Browser to open the Project Browser.
In the Project Browser, right-click Animation Tables → New Animation Table.
Result: A new animation table opens.
In the New Animation Table dialog, edit the following values:
Name Type in a table name. For this example: EIP_DataBuf.
Functional Mode
Comment
Accept the default <None>.
Leave blank.
Number of animated characters
Type 100, representing the size of the data buffer in words.
The completed dialog looks like this:
278
5
Click OK to close the dialog.
In the animation table’s Name column, type in the name of the variable assigned to the databuffer: EIP_DataBuf and press Enter. The animation table displays the EIP_DataBuf variable.
S1A33985 12/2018
Step
6
Explicit Messaging
Action
Expand the EIP_DataBuf variable to display its word array, where you can view the CIP response at words EIP_DataBuf(7-16):
Note: Each word presents 2 bytes of data in little endian format, where the least significant byte is stored in the smallest memory address. For example, ‘50’ in EIP_DataBuf[0] is the low byte, and ‘02’ is the high byte.
S1A33985 12/2018
279
Explicit Messaging
Modbus TCP Explicit Messaging Using MBP_MSTR Section 8.3
Modbus TCP Explicit Messaging Using MBP_MSTR
Overview
This section shows you how to configure the MBP_MSTR function block to send explicit messages using the Modbus TCP protocol.
What Is in This Section?
This section contains the following topics:
Topic
Modbus TCP Explicit Messaging Function Codes
Configuring the Control Parameter for Modbus TCP Explicit Messaging
Page
280
S1A33985 12/2018
Explicit Messaging
Modbus TCP Explicit Messaging Function Codes
Overview
Every Modbus TCP explicit message performs a function. Each function is associated with a code
(or number). You will need to identify the explicit messaging function by its name, decimal number, or hexadecimal number.
You can execute Modbus TCP explicit messages using either a Control Expert MBP_MSTR function block or the Control Expert Ethernet Configuration Tool’s Modbus Explicit Message Window.
NOTE: Configuration edits made to an Ethernet communication module from the Control Expert
Ethernet Configuration Tool are not saved to the operating parameters stored in the CPU and, therefore, are not sent by the CPU to the module on startup.
Services
The function codes supported by Control Expert include the following standard explicit messaging functions:
1
2
7
8
3
4
Function Code
Hex Dec
A
17
1
2
3
4
7
8
10
23
Description
Write data
Read data
Get local statistics
Clear local statistics
Get remote statistics
Clear remote statistics
Reset module
Read / write data
FFF0 65520 Enable / disable HTTP and
FTP/TFTP services
"X" = the service is available.
"—" = the service is not available.
X
X
X
X
X
X
X
X
X
Available in...
MBP_MSTR block Control Expert GUI
X
X
X
X
X
X
-
X
X
S1A33985 12/2018
281
Explicit Messaging
Configuring the Control Parameter for Modbus TCP Explicit Messaging
Overview
The CONTROL and DATABUF output parameters define the operation performed by the
see page 256
) function block. For the Modbus TCP protocol, both the structure and the content of
the CONTROL output parameter vary, depending upon the function code
see page 281
The structure of the CONTROL parameter is described, below, for each supported function code.
Control Parameter Routing Register
The CONTROL[5] routing register specifies the source and destination node addresses for network data transfer, and consists of the following 2 bytes:
Most Significant Byte (MSB): contains the source node address, for example, the slot number of the 140 NOC 771 01
Least Significant Byte (LSB): contains the destination node address—a value representing either a direct or a bridge address. The LSB is required for devices reached through a bridge, for example, an Ethernet to Modbus bridge or an Ethernet to Modbus Plus bridge. The values of the LSB are as follows:
If no bridge is used: LSB is set to zero(0).
If a bridge is used: LSB contains the Modbus Plus on Ethernet Transporter (MET) mapping index value. This value, also known as the Unit ID, indicates the device to which the message is directed.
The CONTROL[5] routing register:
When the Ethernet communication module acts as a server, the LSB indicates the destination of a message received by the communication module:
messages with an LSB value from 0 to 254 are forwarded to and processed by the CPU messages with an LSB value of 255 are retained and processed by the Ethernet communication module
NOTE: Use unit ID 255 when requesting diagnostic data from the Ethernet communication module.
282
S1A33985 12/2018
Explicit Messaging
Write Data
The Control parameter consists of 9 contiguous words, as described below:
Register
CONTROL[1]
CONTROL[2]
Function
Operation
Description
1 = write data
CONTROL[3]
CONTROL[4]
CONTROL[5]
Error status
Data buffer length
Starting register
Routing register
only)
(read-
Number of addresses sent to the slave
Start address of the slave to which the data is written, in 16-bit words
High byte = Ethernet communication module slot
Low byte = MBP on Ethernet transporter (MET) mapping index
Byte 4 of the IP address (MSB)
CONTROL[6]
1
CONTROL[7]
1
IP address
Byte 3 of the IP address
CONTROL[8]
1
CONTROL[9]
1
Byte 2 of the IP address
Byte 1 of the IP address (LSB)
1. For example, the Control parameter handles the IP address 192.168.1.7 in the following order: Byte 4 = 192, Byte 3 = 168, Byte 2 = 1, Byte 1 = 7.
Read Data
The Control parameter consists of 9 contiguous words, as described below:
Register
CONTROL[1]
CONTROL[2]
CONTROL[3]
CONTROL[4]
CONTROL[5]
Function
Operation
Error status
Data buffer length
Starting register
Routing register
Description
2 = read data
only)
(read-
Number of addresses to be read from the slave
Determines the %MW starting register in the slave from which the data is read. For example:
1 = %MW1, 49 = %MW49)
High byte = Ethernet communication module slot
Low byte = MBP on Ethernet transporter (MET) mapping index
S1A33985 12/2018
283
Explicit Messaging
Register
CONTROL[6]
1
Function
IP address
Description
Byte 4 of the IP address (MSB)
CONTROL[7]
1
CONTROL[8]
1
Byte 3 of the IP address
Byte 2 of the IP address
CONTROL[9]
1 Byte 1 of the IP address (LSB)
1. For example, the Control parameter handles the IP address 192.168.1.7 in the following order: Byte 4 = 192, Byte 3 = 168, Byte 2 = 1, Byte 1 = 7.
Get Local Statistics
The Control parameter consists of 9 contiguous words, as described below:
Register
CONTROL[1]
CONTROL[2]
CONTROL[3]
CONTROL[4]
CONTROL[5]
Data buffer length
Starting register
Routing register
(not used)
Description
3 = read local statistics
only)
(read-
Number of addresses to be read from local statistics (0...37)
First address from which the statistics table is read (Reg1=0)
High byte = Ethernet communication module slot
Low byte = MBP on Ethernet transporter (MET) mapping index
— CONTROL[6]
CONTROL[7]
CONTROL[8]
CONTROL[9]
Function
Operation
Error status
Module Response: A TCP/IP Ethernet module responds to the Get Local Statistics command with the following information:
284
S1A33985 12/2018
Explicit Messaging
Word
00...02
03
04 and 05
06 and 07
08 and 09
10 and 11
12 and 13
14 and 15
16 and 17
18 and 19
20 and 21
22 and 23
24 and 25
26 and 27
28 and 29
30 and 31
32 and 33
34 and 35
36 and 37
Description
MAC Address
Board Status—this word contains the following bits:
Bit 15 0 = Link LED off;
1 = Link LED ON
Bit 3 Reserved
Bits 14...13
Bit 12
Bits 11...9
Bits 8...4
Reserved
0 = 10 Mbit;
1 = 100 Mbit
Reserved
Bit 2
Bit 1
0 = half duplex; 1 = full duplex
0 = not configured;
1 = configured
Bit 0 0 = PLC not running;
1 = PLC or NOC running
Module Type—this bit presents the following values:
0 = NOE 2x1
1 = ENT
2 = M1E
3 = NOE 771 00
4 = ETY
5 = CIP
6 = (reserved)
7 = 140 CPU 651 x0
8...9 = (reserved)
10 = 140 NOE 771 10
11 = 140 NOE 771 01
12 = 140 NOE 771 11
13...16 = (reserved)
17 = M340 CPU
18 = M340 NOE
19 = BMX NOC 0401
20 = TSX ETC 101
21 = 140 NOC 771 01
Number of receiver interrupts
Number of transmitter interrupts
Transmit_timeout error count
Collision_detect error count
Missed packets
(reserved)
Number of times driver has restarted
Receive framing error detected
Receiver overflow error detected
Receive CRC error detected
Receive buffer error detected
Transmit buffer error detected
Transmit silo underflow
Late collision
Lost carrier
Number of retries
IP address
S1A33985 12/2018
285
Explicit Messaging
Clear Local Statistics
The Control parameter consists of 9 contiguous words, as described below:
Register
CONTROL[1]
CONTROL[2]
CONTROL[3]
CONTROL[4]
CONTROL[5]
Function
Operation
Error status
(not used)
Description
4 = clear local statistics
only)
(read-
—
—
High byte = Ethernet communication module slot
Low byte = MBP on Ethernet transporter (MET) mapping index
— CONTROL[6]
CONTROL[7]
CONTROL[8]
CONTROL[9]
(not used)
(not used)
Routing register
Get Remote Statistics
The Control parameter consists of 9 contiguous words, as described below:
Register
CONTROL[1]
CONTROL[2]
CONTROL[3]
CONTROL[4]
CONTROL[5]
Function
Operation
Error status
Data buffer length
Starting register
Routing register
Description
7 = get remote statistics
Holds the event code ( see page 355 )
(read-only)
Number of addresses to be read from the statistics data field
(0...37)
First address from which the node statistics table is read
High byte = Ethernet communication module slot
Low byte = MBP on Ethernet transporter (MET) mapping
Byte 4 of the IP address (MSB)
CONTROL[6]
1 IP address
CONTROL[7]
1
CONTROL[8]
1
Byte 3 of the IP address
Byte 2 of the IP address
CONTROL[9]
1 Byte 1 of the IP address (LSB)
1. For example, the Control parameter handles the IP address 192.168.1.7 in the following order: Byte 4 =
192, Byte 3 = 168, Byte 2 = 1, Byte 1 = 7.
286
S1A33985 12/2018
Explicit Messaging
Clear Remote Statistics
The Control parameter consists of 9 contiguous words, as described below:
Register
CONTROL[1]
CONTROL[2]
Function
Operation
Description
8 = clear remote statistics
CONTROL[3]
CONTROL[4]
CONTROL[5]
Error status
(not used)
(not used)
only)
(read-
—
—
Routing register High byte = Ethernet communication module slot
Low byte = MBP on Ethernet transporter (MET) mapping index
Byte 4 of the IP address (MSB)
CONTROL[6]
1 IP address
CONTROL[7]
1
CONTROL[8]
1
Byte 3 of the IP address
Byte 2 of the IP address
CONTROL[9]
1 Byte 1 of the IP address (LSB)
1. For example, the Control parameter handles the IP address 192.168.1.7 in the following order: Byte 4 = 192, Byte 3 = 168, Byte 2 = 1, Byte 1 = 7.
Reset Module
The Control parameter consists of 9 contiguous words, as described below:
Register
CONTROL[1]
CONTROL[2]
CONTROL[3]
CONTROL[4]
CONTROL[5]
Function
Operation
Error status
(not used)
Description
10 = reset module
only)
(read-
—
—
High byte = Ethernet communication module slot
Low byte = MBP on Ethernet transporter (MET) mapping index
— CONTROL[6]
CONTROL[7]
CONTROL[8]
CONTROL[9]
(not used)
(not used)
Routing register
S1A33985 12/2018
287
Explicit Messaging
Read/Write Data
The Control parameter consists of 11 contiguous words, as described below:
Register
CONTROL[1]
CONTROL[2]
Function
Operation
Description
23 = read / write data
CONTROL[3]
CONTROL[4]
CONTROL[5]
Error status
Data buffer length
Starting register
Routing register
only)
(read-
Number of addresses sent to the slave
Determines the %MW starting register in the slave to which the data will be written.
For example: 1 = %MW1, 49 = %MW49)
High byte = Ethernet communication module slot
Low byte = MBP on Ethernet transporter (MET) mapping index
Byte 4 of the IP address (MSB)
CONTROL[6]
1
CONTROL[7]
1
IP address
Byte 3 of the IP address
CONTROL[8]
1
CONTROL[9]
1
CONTROL[10] Data buffer length
Byte 2 of the IP address
Byte 1 of the IP address (LSB)
Number of addresses to be read from the slave
CONTROL[11] Starting register Determines the %MW starting register in the slave from which the data is read. For example:
1 = %MW1, 49 = %MW49)
1. For example, the Control parameter handles the IP address 192.168.1.7 in the following order: Byte 4 = 192, Byte 3 = 168, Byte 2 = 1, Byte 1 = 7.
288
S1A33985 12/2018
Explicit Messaging via the Control Expert GUI Section 8.4
Explicit Messaging via the Control Expert GUI
What Is in This Section?
This section contains the following topics:
Topic
Sending Explicit Messages to EtherNet/IP Devices
Sending Explicit Messages to Modbus TCP Devices
Explicit Messaging
Page
S1A33985 12/2018
289
Explicit Messaging
Sending Explicit Messages to EtherNet/IP Devices
Overview
Use the EtherNet/IP Explicit Message window to send an explicit message from Control Expert to an EtherNet/IP module or device on the network.
An explicit message can be sent as either a connected, or an unconnected message:
an unconnected message requires path — or addressing — information identifying the
destination device and, optionally, device attributes a connected explicit message contains both path information and a connection identifier to the target device
You can use explicit messaging to perform many different services. Not every EtherNet/IP device supports every service.
NOTE: Before you can perform explicit messaging, connect the DTM for the upstream communication module to the module itself. To do this, select the module node in the
DTM Browser, then select Edit → Connect.
The EtherNet/IP Explicit Message window, below, presents an example of both the configuration of an EtherNet/IP explicit message and the response. The explicit message is addressed to a remote STB NIC 2212 network interface module to obtain diagnostic information.
290
S1A33985 12/2018
Explicit Messaging
Sending Explicit Messages
The following steps explain how to execute the EtherNet/IP explicit message, depicted above:
Step
1
2
3
Action
In the DTM Browser, select the communication module that is upstream of the target device.
Click the right mouse button, and in the pop-up menu select Device menu → EtherNet/IP
Explicit Message.
Result: The EtherNet/IP Explicit Message window opens.
Configure the explicit message using the following fields:
IP Address The IP address of the target device, used to identify the target of the explicit message. In the above example: 192.168.1.6.
Class
Instance
The class identifier of the target device, used in the construction of the message path. An integer from 1 to 65535. In this example: 4.
The class instance of the target device, used in the construction of the message path. An integer from 0 to 65535. In this example: 100.
Attribute (Optional) The specific device attribute — or property — that is the target of the explicit message, used in the construction of the message path. An integer from 0 to 65535. In this example: 3
NOTE: Select the check box to enable this field.
NOTE: Refer to your EtherNet/IP device user manual for class, instance and attribute values.
Number The integer associated with the service to be performed by the explicit message. An integer from 1 to 127.
NOTE: If you select Custom Service as the named service, type in a service number. This field is read-only for all other services.
Name
Enter Path
Data
Messaging
Repeat 500 ms
Select the service the explicit message is intended to perform. In this example: Get_Attribute_Single.
(Optional) Select this check box to enable the message path field, where you can manually enter the entire path to the target device. In this example, the path is not manually entered.
NOTE: Displayed only when Advanced Mode is enabled.
The data to be sent to the target device, for services that send data. In this example, leave blank.
Select the type of explicit message to send:
Connected
Unconnected
In this example, select Unconnected.
Select this check box to re-send the explicit message every 500 ms. In this example, leave this blank.
S1A33985 12/2018
291
Explicit Messaging
Step
4
5
Action
After your explicit message is configured, click Send to Device.
The Response area displays the data sent to the configuration tool by the target device in hexadecimal format.
The Status area displays messages indicating whether or not the explicit message has succeeded.
Click Close to close the window.
292
S1A33985 12/2018
Explicit Messaging
Sending Explicit Messages to Modbus TCP Devices
Overview
Use the Modbus Explicit Message window to send an explicit message from Control Expert to a
Modbus TCP module or device on the network.
You can use explicit messaging to perform many different services. Not all Modbus TCP devices support all services.
NOTE: Before you can perform explicit messaging, connect the DTM for the upstream communication module to the module itself. To do this, select the module node in the
DTM Browser, then select Edit → Connect.
The Modbus TCP Explicit Message window, below, presents an example of both the configuration of a Modbus TCP explicit message, and the response. In this example, the explicit message is used to read 2 registers in the remote STB NIP 2212 network interface module, starting at offset
5391.
S1A33985 12/2018
293
Explicit Messaging
Sending Explicit Messages
To send an explicit message to a target Modbus TCP device:
Step
1
2
3
4
5
Action
In the DTM Browser, select the communication module that is upstream of the target device.
Click the right mouse button, and in the pop-up menu select Device menu →
Modbus Explicit Message.
Result: The Modbus Explicit Message window opens.
Configure the explicit message using the following fields:
IP Address The IP address of the target device, used to identify the target of the explicit message. In this example:
192.168.1.7.
Start Address
Quantity
Read Device
Id Code
Object Id
A component of the addressing path. In this example
5391.
A component of the addressing path. In this example 2.
(read-only) The service the explicit message is intended to perform. In this example Basic Device Identity. Not used in this example.
(read-only) Specify the object the explicit message is intended to access. In this example 0. Not used in this example.
Refer to your Modbus TCP device user manual for Start Address, Quantity,
Read Device Id Code, and Object Id values.
Unit Id The number of the device, or module, that is the target of the connection. A value of:
255 (the default) used to access the Ethernet communication module itself
0...254 identifies the device number of the target device, behind a Modbus TCP to Modbus gateway
Number (read-only) The integer associated with the service to be performed by the explicit message. An integer from
0...255.
Name
Repeat 500ms
Select the service the explicit message is intended to perform. In this example ReadHoldingRegisters
Select this check box to re-send the explicit message every 500 ms. Leave this check box de-selected.
After your explicit message is configured, click Send to Device.
The Response area displays any data sent to the configuration tool by the target device in hexadecimal format.
The Status area displays messages indicating whether or not the explicit message has succeeded.
Click Close to close the window.
294
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Diagnostics
S1A33985 12/2018
Diagnostics Chapter 9
Diagnostics
Overview
This chapter describes methods of diagnosing the condition of the Ethernet communication module provided by the:
Ethernet communication module hardware, and
Control Expert configuration software
What Is in This Chapter?
This chapter contains the following sections:
Section
9.1
9.2
Module Hardware Diagnostics
Control Expert Software Diagnostics
Topic Page
S1A33985 12/2018
295
Diagnostics
Module Hardware Diagnostics Section 9.1
Module Hardware Diagnostics
LED Indicators for the Ethernet Communication Module
LED Indicators
The 140 NOC 771 01 Ethernet communication module displays the following LED indicators:
LED Descriptions
Use the LED display to diagnose the state of the module, as follows:
LED
Active
Mod Status
(Module
Status)
Color
Green
Green/
Red
Description
Off: Indicates that the module is not communicating with the CPU over the backplane.
Steady Green: Indicates that the module:
has just been turned on and has not yet started the LED power-up test, or is communicating with the CPU over the backplane
Off: Power is not being supplied to the module.
Steady Green: The module is operating normally.
Blinking Green: The module has not been configured.
Steady Red: The module has detected a major event.
Blinking Red: The module is not properly configured.
296
S1A33985 12/2018
Diagnostics
LED
Net Status
(Network
Status)
Ready
Link
Activity
100Mb
Color
Green/
Red
Green
Green
Green
Green
Fduplex
(Full Duplex)
Green
Description
Off: Power is not being supplied to the module or the module does not have an IP address assigned.
Steady Green: The module has established at least one CIP connection.
Blinking Green: The module has obtained an IP address but has not established any
CIP connections.
Steady Red: The module has detected that its IP address is a duplicate IP address.
Blinking Red: One or more exclusive owner CIP connection (with the module as target) have timed out. All the timed-out exclusive owner CIP connections have not yet been re-established.
Off: No power is supplied to the module.
Steady Green: Indicates that the module is operating normally.
Two flashes: The MAC address is missing.
Three flashes: The Ethernet link is not connected.
Four flashes: The module has detected a duplicate IP address.
Five flashes: The module is waiting for a served IP address.
Six flashes: The module is using its default IP address.
Seven flashes: The module has detected a configuration error.
NOTE: If more than one diagnostic condition exists simultaneously, the Ready LED displays the shortest flash sequence.
Off: An Ethernet link has not been established.
Steady Green: An Ethernet link has been established
Off: There is no receive or transmit activity.
Flashes Green: Indicates activity.
Off: No 100Mb Ethernet link is detected.
Steady Green: The module connected with a 100Mb Ethernet link.
Off: The module is not connected to a full duplex Ethernet link.
Steady Green: Indicates that the module is connected with a full duplex link.
S1A33985 12/2018
297
Diagnostics
Control Expert Software Diagnostics Section 9.2
Control Expert Software Diagnostics
Overview
This section describes the diagnostic tools, provided by the Control Expert configuration software, that you can use to monitor the condition of the Ethernet communication module.
What Is in This Section?
This section contains the following topics:
Topic
Using the Diagnostic Window
Ethernet Port Diagnostics
Bandwidth Diagnostics
Local Slave / Connection Diagnostics
Local Slave or Connection I/O Value Diagnostics
Logging
Page
298
S1A33985 12/2018
Diagnostics
Using the Diagnostic Window
Introduction
Use the Diagnostic window to display:
LED icons (in the left pane of the window) that indicate the operating status of modules, devices
and connections pages (in the right pane of the window) that present diagnostic data for the following:
the communication module local slave nodes activated for the communication module
EtherNet/IP connections between the communication module and a remote EtherNet/IP device
NOTE: Before you can open the Diagnostic window, connect the DTM for the target communication module to the physical module itself. To do this, select the module node in the
DTM Browser, then select Edit → Connect.
The Diagnostic window looks like this:
S1A33985 12/2018
299
Diagnostics
To open the Diagnostic window:
Step
1
2
Action
In the DTM Browser, select the communication module and click the right mouse button. A popup menu opens.
In the menu, select Device menu → Diagnostic.
Diagnostic LED Icons
During the time that a communication module DTM is connected to the physical communication module, Control Expert sends an explicit message request once per second to detect the state of the communication module, and the states of the remote devices and EtherNet/IP connections linked to that module.
Control Expert places one of the following status icons over the module, device or connection nodes in the left pane of the Diagnostic window to indicate its current status:
This icon...
Indicates the following state for a...
Communication module Connection to a remote device
Run state
One of the following:
unknown started stopped not connected
The health bit for every EtherNet/IP connection and Modbus TCP request, to a remote device or to a sub-device or module, is set to active (1).
The health bit for at least one EtherNet/IP connection or Modbus
TCP request, to a remote device or to a sub-device or module, is set to inactive (0).
300
S1A33985 12/2018
Diagnostics
Ethernet Port Diagnostics
Introduction
Use the Ethernet Diagnostic page to display data for the communication module’s Ethernet port that is either:
dynamically refreshed every 500 ms, or a static snapshot of Ethernet port data
Use the Refresh Every 500ms checkbox to display static or dynamic data, as follows:
When the checkbox is...
Selected
De-selected
This page...
Displays data that is dynamically updated every 500 ms, and
Increments the number at the top of the table each time data is refreshed
Displays static data, and
Does not Increment the number at the top of the table, which instead displays a constant value
NOTE: Before you can open the Diagnostic window, connect the DTM for the target communication module to the physical module itself. To do this, select the module node in the
DTM Browser, then select Edit → Connect.
The Ethernet Diagnostic page looks like this:
S1A33985 12/2018
301
Diagnostics
To open this page:
2
3
Step
1
4
Action
In the DTM Browser, select the communication module and click the right mouse button. A pop-up menu opens.
In the menu, select Device menu → Diagnostic.
In the left pane of the Diagnostic window, select the communication module node.
Click on the Ethernet Diagnostic tab to open that page.
Ethernet Diagnostic Parameters
The Ethernet Diagnostic page displays the following parameters for the communication module’s single Ethernet port:
Parameter
General parameters:
Interface Speed
Interface Flags
Description
Valid values include: 0, 10, 100 Mbits/second
Bit 0—Link Status: 0 = Inactive; 1 = Active
Bit 1—Duplex Mode (see below)
Bits 2...4—Negotiation Status (see below)
Bit 5—Manual Setting Requires Reset (see below)
Bit 6—Local Hardware Fault (see below)
0 = half duplex; 1 = full duplex Duplex Mode
Negotiation Status
Manual Setting
Requires Reset
3 = successfully negotiated speed and duplex
4 = forced speed and link
0 = automatic; 1 = device requires reset
Local Hardware Fault 0 = no event; 1 = event detected
Physical Address Module MAC Address
Input parameters:
Octets
Unicast Packets
Octets received on the interface
Unicast packets received on the interface
Non-Unicast Packets Non-unicast packets received on the interface
Discards
Errors
Unknown Protocols
Inbound packets received on the interface, but discarded
Inbound packets that contain detected errors (excludes In Discards)
Inbound packets with unknown protocol
302
S1A33985 12/2018
Parameter Description
Output parameters:
Octets
Unicast Packets
Octets received on the interface
Unicast packets received on the interface
Non-Unicast Packets Non-unicast packets received on the interface
Discards
Errors
Inbound packets received on the interface, but discarded
Outbound packets that contain detected errors (excludes
In Discards)
Outbound packets with unknown protocol Unknown Protocols
Error counter parameters:
Alignment Errors Frames that are not an integral number of octets in length
FCS Errors
Single Collisions
Multiple Collisions
Frames received that do not pass the FCS check
Successfully transmitted frames that experienced exactly one collision
Successfully transmitted frames that experienced more than one collision
SQE Test Errors
Deferred
Transmissions
Late Collisions
Number of times the SQE test error is detected
Frames for which first transmission attempt is delayed because the medium is busy
Number of times a collision is detected later than 512 bittimes into the transmission of a packet
Excessive Collisions Frames for which transmission does not succeed due to excessive collisions
MAC Transmit Errors Frames for which transmission fails due to a detected internal MAC sublayer transmit error
Carrier Sense Errors Times that the carrier sense condition was lost or not asserted when attempting to transmit a frame
Frame Too Long Frames received that exceed the maximum permitted frame size
MAC Receive Errors Frames for which reception on an interface does not succeed due to a detected internal MAC sublayer receive error
Diagnostics
S1A33985 12/2018
303
Diagnostics
Bandwidth Diagnostics
Introduction
Use the Bandwidth Diagnostic page to display either dynamically generated or static data for the communication module’s bandwidth usage.
Use the Refresh Every 500ms checkbox to display static or dynamic data, as follows:
When the checkbox is...
Selected
De-selected
This page...
Displays data that is dynamically updated every 500 ms, and
Increments the number at the top of the table each time data is refreshed
Displays static data, and
Does not Increment the number at the top of the table, which instead displays a constant value
NOTE: Before you can open the Diagnostic window, connect the DTM for the target communication module to the physical module itself. To do this, select the module node in the
DTM Browser, then select Edit → Connect.
304
S1A33985 12/2018
The Bandwidth Diagnostic page looks like this:
Diagnostics
To open this page:
2
3
Step
1
4
Action
In the DTM Browser, select the communication module and click the right mouse button. A pop-up menu opens.
In the menu, select Device menu → Diagnostic. The Diagnostic window opens.
In the left pane of the Diagnostic window, select the communication module node.
Click on the Bandwidth Diagnostic tab to open that page.
S1A33985 12/2018
305
Diagnostics
Bandwidth Diagnostic Parameters
The Bandwidth Diagnostic page displays the following parameters for the communication module:
Description Parameter
I/O - Scanner:
EtherNet/IP Sent
EtherNet/IP Received
Modbus TCP Requests
Modbus TCP Responses
The number of EtherNet/IP packets the module has sent, since the last reset, in packets/second.
The number of EtherNet/IP packets the module has received, since the last reset, in packets/second.
The number of Modbus TCP requests the module has sent, since the last reset, in packets/second.
The number of Modbus TCP responses the module has received, since the last reset, in packets/second.
I/O - Adapter:
EtherNet/IP Sent
EtherNet/IP Received
The number of EtherNet/IP packets the module has sent—in the role of a local slave—since the last reset, in packets/second.
The number of EtherNet/IP packets the module has received—in the role of a local slave—since the last reset, in packets/second.
I/O - Module
Module Capacity
Module Utilization
The maximum number of packets that the module can process, in packets per second.
The percentage of communication module capacity being used by the application.
Messaging - Client:
EtherNet/IP Activity
Modbus TCP Activity
The number of I/O messages sent by the module—using the
EtherNet/IP protocol—since last reset, in packets per second.
The number of I/O messages sent by the module—using the
Modbus TCP protocol—since last reset, in packets per second.
Messaging - Server:
EtherNet/IP Activity
Modbus TCP Activity
The number of I/O messages received by the module—using the EtherNet/IP protocol—since last reset, in packets per second.
The number of I/O messages received by the module—using the Modbus TCP protocol—since last reset, in packets per second.
Module:
Processor Utilization The percent of Ethernet communication module processor capacity used by the present level of communication activity.
306
S1A33985 12/2018
Diagnostics
Local Slave / Connection Diagnostics
Introduction
The Local Slave Diagnostic page and the EIP Connection Diagnostic page present common information. Use the:
Local Slave Diagnostic page to display I/O status and production/consumption information for a selected local slave
EIP Connection Diagnostic page to display I/O status and production/consumption information for a connection of a remote EtherNet/IP device
Use the Refresh Every 500ms checkbox to display static or dynamic data, as follows:
When the checkbox is...
Selected
De-selected
This page...
Displays data that is dynamically updated every 500 ms, and
Increments the number at the top of the table each time data is refreshed
Displays static data, and
Does not Increment the number at the top of the table, which instead displays a constant value
NOTE: Before you can open the Diagnostic window, connect the communication module or remote device DTM to the physical module or device. To do this, select the appropriate node in the
DTM Browser, then select Edit → Connect.
S1A33985 12/2018
307
Diagnostics
The following figure presents an example of the EIP Connection Diagnostic page. (Except for the title, the Local Slave Diagnostic page is the same.)
308
To open this page:
2
3
Step
1
4
Action
In the DTM Browser, select the communication module and click the right mouse button. A pop-up menu opens.
In the menu, select Device menu → Diagnostic.
In the left pane of the Diagnostic window, click on one of the following:
for local slave diagnostics, select the communication module node
for remote device connection diagnostics, select a remote device connection
Depending upon you selection in step 3, above, click on either the
Local Slave Diagnostic tab or the EIP Connection Diagnostic tab to open that page.
S1A33985 12/2018
Diagnostics
Diagnostic Parameters
This page displays the following diagnostic parameters for the selected local slave or connection:
Parameter
Status
Description
Input
Output
General
Extended
Counter:
Frame Error
An integer representing input status.
An integer representing output status.
An integer representing basic connection status.
An integer representing extended connection status.
Time-Out
Refused
Production
Consumption
Production Byte
Consumption Byte
Increments each time a frame is not sent by missing resources or is impossible to send.
Increments each time a connection times out.
Increments when connection is refused by the remote station.
Increments each time a message is produced.
Increments each time a message is consumed.
Total of produced messages, in bytes, since the communication module was last reset.
Total of consumed messages, in bytes, since the communication module wa last reset.
Theoretical Packets per second Packets per second calculated sing current configuration value.
Real Packets per second Actual number of packets per second generated by this connection.
Diagnostic:
Production Connection ID
Consumption Connection ID
O -> T API
T -> O API
O -> T RPI
T -> O RPI
Socket Diagnostics:
The connection ID.
The connection ID.
Accepted packet interval (API) of the output connection.
Accepted packet interval (API) of the input connection.
Requested packet interval (RPI) of the output connection.
Requested packet interval (RPI) of the input connection.
Socket ID
Remote IP Address
Remote Port
Local IP Address
Local Port
Internal Identification of the socket.
IP address of the remote station, for this connection.
Port number of the remote station, for this connection.
IP address of the communication module, for this connection.
Port number of the communication module, for this connection.
S1A33985 12/2018
309
Diagnostics
Connection Status Codes
The Input and Output Status diagnostic parameters present the following values:
see page 309
, in the preceding table, can
65
68
70
77
Input/Output Status (dec)
0
33
53
54
58
Description
OK
Time-out
IDLE
Connection established
Not connected (TCP)
Not connected (CIP)
Connection establishing
Not connected (EPIC)
Scanner stopped
310
S1A33985 12/2018
Diagnostics
Local Slave or Connection I/O Value Diagnostics
Introduction
Use the I/O Values page to display both the input data image and output data image for the selected local slave or connection.
Use the Refresh Every 500ms checkbox to display static or dynamic data, as follows:
When the checkbox is...
Selected
De-selected
This page...
Displays data that is dynamically updated every 500 ms, and
Increments the number at the top of the table each time data is refreshed
Displays static data, and
Does not Increment the number at the top of the table, which instead displays a constant value
NOTE: Before you can open the Diagnostic window, connect the communication module or remote device DTM to the physical module or device. To do this, select the appropriate node in the
DTM Browser, then select Edit → Connect.
To open this page:
Step
1
2
3
4
Action
In the DTM Browser, select the communication module and click the right mouse button. A pop-up menu opens.
In the menu, select Device menu → Diagnostic.
In the left pane of the Diagnostic window, click on one of the following:
the communication module node, or
a connection node
Click on the I/O Values tab to open that page.
S1A33985 12/2018
311
Diagnostics
The following example depicts the I/O Values page for a remote device connection:
Local Slave / Connection I/O Values
This page displays the following parameters for either a local slave or a remote device connection input and output values:
Parameter
Input/Output data display
Length
Status
Description
A display of the local slave or remote device input or output data image.
The number of bytes in the input or output data image.
The Scanner Diagnostic object’s scanner status ( see page 234
with respect to the read of the input or output data image.
,
312
S1A33985 12/2018
Diagnostics
Logging
Description
Control Expert maintains a log of events for:
the Control Expert embedded FDT container
each Ethernet communication module DTM, and each EtherNet/IP remote device DTM
Events relating to the Control Expert FDT container are displayed in the FDT log event page of the
Output Window.
Events relating to a communication module or remote EtherNet/IP device are displayed:
in configuration mode: in the Device Editor, by selecting the Logging node in the left pane
in diagnostic mode: in the Diagnostics window, by selecting the Logging node in the left pane
The following is a sample of the events log displayed in the Diagnostics window:
S1A33985 12/2018
313
Diagnostics
Logging Attributes
The Logging window displays the result of an operation or function performed by Control Expert.
Each log entry includes the following attributes:
Attribute
Date/Time
Log Level
Message
Detail Message
Description
The time the event occurred, displayed in the format: yyyy-mm--dd hh:mm:ss
The level of event importance. Values include:
Information A successfully completed operation.
Warning An operation that Control Expert completed, but which may lead to a subsequent detected error.
Error An operation that Control Expert was unable to complete.
A brief description of the core meaning of the event.
A more detailed description of the event, which may include parameter names, location paths, etc.
314
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Replacing the Communication Module
S1A33985 12/2018
Replacing the Ethernet Communication Module Chapter 10
Replacing the Ethernet Communication Module
Replacing the Ethernet Communication Module
Overview
You can replace the communication module at any time using another module with compatible firmware. A module can be replaced when power to the module is either:
off (cold swap), or on (hot swap)
The replacement module obtains its operating parameters over the backplane connection from the
CPU. The transfer occurs either immediately (hot swap) or when power is next cycled to the device
(cold swap).
NOTE: The operating parameters that the CPU sends to a replacement module do not include any parameter values that were edited in the original module using explicit messaging "SET" commands.
S1A33985 12/2018
315
Replacing the Communication Module
Replacing the Communication Module
Replacing the module involves removing the old module and mounting a new one in its place.
To remove a module:
Step
1
2
Action
Use a Phillips-head screw driver to detach the screw, located at the lower front side of the module, from the backplane.
Swing the bottom of the module away and up from the backplane, pivoting it on the hooks holding the module at the top of the backplane, until the module detaches from backplane connector:
316
3 Lift the module up and off of the hooks located at the top of the backplane.
To install the replacement module, follow the instructions in the module mounting procedure
see page 18
.
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Embedded Web Pages
S1A33985 12/2018
Embedded Web Pages Chapter 11
Embedded Web Pages
Overview
This chapter describes the embedded web pages for the 140 NOC 771 01 Ethernet communication module.
The communication module includes a Hypertext Transfer Protocol (HTTP) server. The server transmits web pages for the purpose of monitoring, diagnosing, and controlling remote access to the communication module. The server provides easy access to the communication module from standard internet browsers, including—but not limited to—Internet Explorer.
What Is in This Chapter?
This chapter contains the following sections:
Section
11.1
11.2
11.3
Topic
Accessing the Embedded Web Server
Monitoring the Control Expert Application
Diagnostics
Page
S1A33985 12/2018
317
Embedded Web Pages
Accessing the Embedded Web Server Section 11.1
Accessing the Embedded Web Server
Introduction
This section introduces the 140 NOC 771 01 communication module’s embedded web server, and describes how to access—and to control access to—the web pages.
What Is in This Section?
This section contains the following topics:
Topic
Introducing the Embedded Web Pages
Accessing the Home Page
Using and Editing a Username and Passwords
Page
318
S1A33985 12/2018
Embedded Web Pages
Introducing the Embedded Web Pages
Introduction
Use the 140 NOC 771 01 Ethernet communication module’s embedded web server pages to:
display real-time diagnostic data for both the module and other networked devices
read the values of—and write values to—Control Expert application variables manage and control access to the embedded web pages by assigning separate passwords for:
viewing the diagnostic web pages, and using the Data Editor to write values to Control Expert application variables
Requirements
The embedded web server presents module data in the form or standard HTML web pages.
Access the embedded web pages using Internet Explorer version 4.0 or higher, running the Java
Runtime Environment (JRE) version 1.6 or higher.
S1A33985 12/2018
319
Embedded Web Pages
Accessing the Home Page
On First Use
Before you begin to use the 140 NOC 771 01 communication module’s embedded web pages, you need to:
access web page content by inputting the default username and password
combination change passwords
see page 320
see page 322
that are required for: accessing web pages, and writing data values using the Data Editor
see page 321
Navigating to the Web Server
To access the embedded web server, open an Internet browser, then enter the IP address
see page 62
of the Ethernet communication module in the format: http://IP address , then click
Enter.
NOTE: If a DNS name has been assigned to the module, the DNS name can be used instead of the IP address.
The web server opens, displaying the Home page:
320
Use the Home page as the point of entry to the communication module’s embedded web server.
From here, you can navigate to every other web page.
S1A33985 12/2018
Embedded Web Pages
Using and Editing a Username and Passwords
Inputting the Username and Web Page Access Password
A username and password are required to access web page content and edit application data. All username and password settings are case sensitive.
The embedded web pages support the use of a single, editable username for both web page access and data editing. The factory-default username setting is USER.
The embedded web pages require two different passwords, as follows:
an HTTP access password, which grants read-only access to web page content
a data editor write password, which permits the editing of data values using the Data Editor
Each password can be edited. The factory default setting for each password is USER.
To input a username and password combination
Step
1
2
Description
After navigating to the embedded web server
main menu selections (for example, Setup).
, select one of the
Select a page name from the list of pages on the left side of the page (for example, Security). The following dialog opens:
3 Type in the required Username and Password combination, then click OK.
NOTE: In the above example, the settings for both the Username and
Password remain set to the default setting of USER.
S1A33985 12/2018
321
Embedded Web Pages
Editing the Username and Passwords
The single username and both passwords can be edited in the Security web page. To edit username and passwords, follow these steps:
Step Description
1 Navigate to and open the web server,
communication module. The Home page opens.
2 From the Home page, click on the Setup main menu item. If required, input the username and web page password
The Setup page opens:
322
S1A33985 12/2018
Embedded Web Pages
Step Description
3 On the left side of the page, click on the Security node. (If required, input the
Username and web page access Password.)
The Security page opens:
4
5
6
7
S1A33985 12/2018
To change the username and password combination used for web page access, in the HTTP access rights section of the page, enter values for the following fields:
Username:
To change the username: type in a new username
To retain the current username (for example, if you are changing only the password): type in the current username
New password:
To change the password: type in a new password
To keep the current password (for example, if you are changing only the username): type in the current password
Confirm password:
Type in the same password entered in the New password field, above.
Click the Save User button.
To change the password used for writing data values in the Data Editor, in the
Data Editor Write Password section of the page, enter values for the following fields:
Data Editor write password:
Type in the current password that is required to write data using the Data Editor.
New write password:
Confirm write password:
Type in the new Data Editor password.
Type in the same password entered in the New write password field, above.
Click the Change Write Password button.
323
Embedded Web Pages
Monitoring the Control Expert Application Section 11.2
Monitoring the Control Expert Application
Overview
This section describes how to use the 140 NOC 771 01 Ethernet communication module’s embedded web pages to monitor the Control Expert application.
What Is in This Section?
This section contains the following topics:
Topic
Using the Monitoring Page
Data Editor (Standard)
Working With Data Templates
Data Editor (Lite)
Page
324
S1A33985 12/2018
Embedded Web Pages
Using the Monitoring Page
Monitoring Page
Click on the main menu Monitoring command to display the Monitoring page:
To access a monitoring service, click on either of the following links:
Data Editor Lite
Data Editor Standard
S1A33985 12/2018
325
Embedded Web Pages
Data Editor (Standard)
Overview
The Data Editor is a Java applet that dynamically displays run-time application data. Use the
Data Editor to create and edit data monitoring tables that provide read/write access to application data and device registers.
NOTE: Write access is password protected.
WARNING
Unintended Equipment Operation
The data editor makes it possible to write to application variables and change application data values.
Use passwords to strictly limit access to write data functionality.
Do not use weak passwords, including the default password and other obvious passwords.
Limit access to trained personnel.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
This topic describes the Data Editor user interface.
Data Editor
The Data Editor presents the following controls:
326
1 Toolbar
2 Data template list
3 Data template
4 Configuration Area
S1A33985 12/2018
Embedded Web Pages
Toolbar
The Data Editor toolbar presents the following features:
Command or Field
New
Save
Copy
Paste
Delete
Change password
Read PLC symbols
Start animation
Stop animation
Icon Description
If a node in the data template list is selected, this command opens the
New table dialog for the creation of a new data template. The new data template is inserted below the selected node.
If a row in the currently open data template is selected, this command inserts a new row below the selected row.
Saves changes made to both the data template list and each data template.
If a node in the data template list is selected, this command copies the selected data template.
If an item (or row) in the currently open data template is selected, this command to copies the selected item.
If the root, or Empty, node is selected in the data template list, this command pastes a previously copied data template into the list.
If an empty item (or row) in the currently open data template is selected, this command pastes a previously copied item into the data template item at the selected row.
NOTE: When adding a copied item, or row, to a data template, the paste command will overwrite item data in the selected row. To insert a copied row between existing rows, first use the New command to create an empty row, then paste the copied data into the new row.
Deletes the selected data template from the list, or the selected item from the data template.
Opens the Change password dialog, where you can change the Data
Editor Write
NOTE: The Data Editor Write password can also be changed in the Setup
→ Security web page.
Loads the existing Contrrol Expert symbol, or variable, names into the
Lookup Variable dialog. Variables that have been loaded into this dialog can be added to the currently open data template.
Starts the dynamic display of value and status for the items contained in the selected data template.
NOTE: The Start animation icon is visible only when animation is turned
OFF.
Stops the dynamic display of value and status for the items contained in the selected data template.
NOTE: The Stop animation icon is visible only when animation is turned
ON.
S1A33985 12/2018
327
Embedded Web Pages
Command or Field
Rate
IP address
Icon
—
—
Description
The refresh rate of the dynamic display of data template items, in milliseconds.
The IP address of the Ethernet communication module and its embedded web server.
Data Template List
The data template list displays a node for each data template that was either:
previously saved, or
created after the Data Editor was opened, but not yet saved
Select a data template in this list to view or edit its contents.
NOTE: If you create a new data template, then navigate away from the Data Editor before clicking the Save button, the new data template will be lost.
Data Template
Use the data template—when animation is turned ON—to monitor the status and values of items for the template that is currently selected in the data template list.
Each data template item (or row) is defined in the configuration area. A data template item can contain the following fields:
Field
Symbol
Address
Description
Contains the names of Control Expert symbols (variables).
Contains direct addresses and the addresses of Control Expert symbols (variables). Any direct address can be viewed by entering its reference in this field. Valid direct addresses include:
%Mi
%Ii
%IWi
%MWi, %MDi, %MFi same as for 0X coils same as 1x for discreet inputs same as 3x for input registers same as 4x for holding registers
NOTE:
A single bit of any word address (for example, %MWi, %IWi) can be specified by appending
".j" to the address, where "j" is a bit index in the range of 0 (LSB) to 15 (MSB). For example, bit 4 of the value at %MW101 would be specified as %MW101.4.
A direct address can include an index specification that allows it to be treated as an array variable. Indexed addressing can be used with a %Mi, %MWi, %MDi, or %MFi address by appending "[j]" to the address of the beginning of the array, where "j" is an unsigned integer value. For example, the third value of an array of float values starting at %MF201 would be specified as %MF201[2].
328
S1A33985 12/2018
Embedded Web Pages
Field
Data type
Value
Format
Status
Description
Contains the data type of the symbol (variable) or direct address. Symbol (variable) data types appear automatically when the symbol (variable) is located. Select direct address data types from a drop-down list. The following data types are valid:
INT
UINT
DINT
UDINT
REAL
TIME
16-bit signed integer
16-bit unsigned integer
32-bit signed integer
32-bit unsigned integer
32-bit IEEE floating point
32-bit unsigned integer (in ms)
DATE
TOD
BOOL
Date (32-bit BCD)
Time of day (32-bit BCD)
1 bit discrete (Boolean)
When animation has started, this field displays the value of the symbol (variable) or direct address. This field is updated continuously.
Contains the format type for displaying the value of the symbol (variable) or direct address. The following formats are available: bool Boolean dec hex binary
ASCII
Decimal
Hexadecimal
Binary bytes displayed as ASCII characters time date day_hr_min_sec_ms
YYYY-MM-DD or HH:MM:SS
Contains messages describing the status of communication with the direct address: if communication is normal The status message reads OK if communication is interrupted
The status field displays a system message describing the interruption
S1A33985 12/2018
329
Embedded Web Pages
Configuration Area
Open and close the configuration area by double-clicking on a row in the data template. The configuration area will display the configuration settings for the selected row. Use the up and down arrows on your keyboard to move between rows in the data template and display their settings in the configuration area.
Use the configuration area—when data template animation is turned OFF—to:
create a new data template display the items contained in an existing data template
see page 331
see page 333
see page 333
Use the configuration area—when data template animation is turned ON—to write data to read/write application variables.
Refer to the topic Working With Data Templates for more information on how to use the controls in the configuration area.
330
S1A33985 12/2018
Embedded Web Pages
Working With Data Templates
Creating a Data Template
To display and access application data, first create a data template.
To create a new data template, follow these steps:
Step
1
2
Description
Confirm that Data Editor animation is OFF. If necessary, click the Stop animation toolbar button.
Click the New table toolbar button.
The New table dialog opens:
3
4
In the Table name field, type in the name of the new data template.
Click Ok.
The new data template appears as a node in the data template list.
NOTE: Save the new data template before performing any other task in the Data Editor. Moving to another page—or creating a new data template in the current page—before saving your work deletes the new data template.
S1A33985 12/2018
331
Embedded Web Pages
Saving a Data Template
After you save a new data template, you can re-use it to view or modify its contents.
NOTE:
Be careful when you modify and save a data template. The last saved modification overwrites
the pre-existing data template, even if the data template was originally created by someone other than yourself.
If a data template is open for viewing by someone else, your edits to that data template will be seen only when that person next accesses the Data Editor.
To save a new data template, follow these steps:
Step
1
Description
Click the Save toolbar button.
The Save application dialog opens:
2
3
In the Password field, type in the Web Page (HTTP) Access password.
NOTE: The default password is USER.
Click Ok.
The new data template is saved.
332
S1A33985 12/2018
Embedded Web Pages
Displaying an Existing Data Template
When you open a saved data template, you can use it to:
edit its contents by inserting a direct address
monitor the value and status of data items write data values to a read/write variables
The data template list, located on the left side of the Data Editor, displays the saved data templates. Select a data template node from the list to display that template’s data items in the spreadsheet on the right:
Inserting a Direct Address Into a Data Template
You can add Control Expert direct address items—also called located registers—into a data template. After a direct address item is added, you can view or modify its value.
To add a direct address item to a data template, follow these steps:
2
3
4
Step
1
Description
In the data template spreadsheet, double-click on an empty row.
The Data Editor configuration area opens.
In the Address field of the configuration area, type in the item’s direct address.
In the configuration area, click Apply. The selected row is updated.
Save your edits.
S1A33985 12/2018
333
Embedded Web Pages
Modifying Data Values Using a Data Template
You can use the Data Editor to write data values to a direct address item, and send the new value to the controller.
For example, suppose that you have programmed a pushbutton object to jog a motor when the button is depressed and to stop jogging when the button is released. If communications are lost while the button is depressed, the motor will continue to jog even when the button is released.
Graphic objects are not designed to be used to control situations like this, unless other interlock methods are installed in the system.
NOTE: You can only modify the value of data items that are defined as read/write in the Control
Expert application.
To use the Data Editor to edit data, follow these steps:
2
3
Step
1
Description
In the data template spreadsheet, double-click on the item you want to write data to.
The Data Editor configuration area opens, displaying the fields for the selected item.
In the Value field, type in the desired data value.
Click Apply.
The Enter password dialog opens:
4
5
In the Password field, type in the Write Data password.
NOTE: The default password is USER.
Click OK. The new value is sent to the controller.
334
S1A33985 12/2018
Embedded Web Pages
Data Editor (Lite)
Overview
Data Editor Lite is a version of the Data Editor that is smaller in size and therefore faster to download, especially for use via a dial-up connection.
Data Editor Lite presents the same interface as the Data Editor, with the exception that its toolbar does not include the Read PLC Symbols function:
Variables
Data Editor Lite accepts the following IEC variables:
Address
%MW IEC internal word
%MD IEC double word
%M IEC internal bits
Type
INT
DINT
BOOL
Display
DECIMAL
DECIMAL
BOOLEAN
NOTE: You cannot access the Lookup Variable dialog and insert symbols into a data template using Data Editor Lite. You can insert only direct addresses.
Re-Using Data Editor Templates
Data Editor Lite can reuse the same templates created with the Data Editor. However, Data Editor templates can use a wider range of variable types than Data Editor Lite. When Data Editor Lite encounters a variable it cannot manage, it displays Not Supported as the data type. In this case, the variable cannot be edited using Data Editor Lite.
S1A33985 12/2018
335
Embedded Web Pages
Diagnostics Section 11.3
Diagnostics
Overview
This section describes the diagnostic services provided by the 140 NOC 771 01 Ethernet communication module.
What Is in This Section?
This section contains the following topics:
Topic
Using the Diagnostics Page
Status Summary
Rack Viewer
Processor Load
Scanner Status
Messaging
Ethernet Statistics
QoS Configuration
Properties
Page
336
S1A33985 12/2018
Embedded Web Pages
Using the Diagnostics Page
Diagnostics Page
Click on the main menu Diagnostics command to display the Diagnostics page:
To access a monitoring service, click on either of the following links:
Status Summary
Rack Viewer
Ethernet:
see page 340
Processor Load
see page 338
see page 341
see page 344
see page 346
Ethernet Statistics
see page 350
Properties
see page 351
S1A33985 12/2018
337
Embedded Web Pages
Status Summary
Introduction
Use the Status Summary page to view the status of:
see page 296
module the Ethernet services
located on the front of the 140 NOC 771 01 Ethernet communication
see page 67
) supported by the communication module
the communication module in its role as:
scanner
Modbus TCP server
EtherNet/IP messaging server
Status Summary Display
The Status Summary page looks like this:
338
To open this page:
2
3
Step
1
Action
Starting at the Home page, click the Diagnostics main menu item. The Diagnostics page opens.
On the left side of the Diagnostics page, select Ethernet → Status Summary.
If necessary, type in the HTTP web access password.
NOTE: The default password is USER.
S1A33985 12/2018
Embedded Web Pages
Status Summary Data
The LEDs section of the page can present the following operational states:
LED
Active
Module Status)
Network Status)
Ready
Link
100MB
Fduplex
Color
Green
Red
Green
Red
Green
Red
Green
Red
Green
Red
Green
Gray
Green
Gray
Text Descriptions
Running
Error present
In operation
Not configured
Fault detected
Recoverable fault detected
Connections established
Connection error
Duplicate IP address
In operation
Duplicate IP address
Waiting for Served IP Configuration
Default IP in use
Configuration error
Ethernet link established
No Ethernet link established
Connected to 100MB network
Not connected to 100MB network
Connected to Full duplex network
Not connected to Full duplex network
The Services section of the page can present the following functional conditions:
Function
DHCP Server
FDR Server
QoS Tagging
Access Control
Scanner Status
Color
—
Text Descriptions
Enabled
Disabled
Green
Red
Gray
Working properly
At least one connection is bad
Not configured
S1A33985 12/2018
339
Embedded Web Pages
Rack Viewer
Introduction
Use the Rack Viewer to access web pages that describe the identity, placement, configuration and operation of modules in the Quantum rack.
To view information describing a specific module—including the 140 NOC 771 01 Ethernet communication module—click on the image of that module in the Rack Viewer.
Rack Display
The Rack Viewer looks like this, when it is first opened:
340
To open this page:
2
3
Step
1
4
5
Action
Starting at the Home page, click the Diagnostics main menu item. The Diagnostics page opens.
On the left side of the Diagnostics page, select Rack Viewer.
If necessary, type in the HTTP web access password.
NOTE: The default password is USER.
To open a page displaying configuration and operating data for the
140 NOC 771 01, click on the module image in the rack.
The Rack Viewer parameter page opens.
To return to the main Rack Viewer page, click the Back arrow.
S1A33985 12/2018
Embedded Web Pages
Processor Load
Introduction
Use the Processor Load web page to display dynamically generated data for the 140 NOC 771 01 communication module’s bandwidth usage.
Processor Load Display
The Processor Load page looks like this:
NOTE: The background color for the Processor Utilization and Module Utilization values varies, depending upon the percentage of utilization. If utilization is:
90% to 100%—background color is RED
80% to 89.99%—background color is YELLOW
0% to 79.99%—background color is GRAY
S1A33985 12/2018
341
Embedded Web Pages
To open this page:
2
3
Step
1
Action
Starting at the Home page, click the Diagnostics main menu item. The
Diagnostics page opens.
On the left side of the Diagnostics page, select Ethernet → Processor Load.
If necessary, type in the HTTP web access password.
NOTE: The default password is USER.
Processor Load Parameters
The Processor Load page displays the following parameters for the communication module:
Parameter
Module Load:
Description
Processor Utilization The percent of Ethernet communication module processor capacity used by the present level of communication activity. The background color of the value changes, depending on the percentage utilization.
I/O Scanner:
EtherNet/IP Sent (writes) The number of EtherNet/IP packets the module has sent, since the last reset, in packets/second.
EtherNet/IP Received (read) The number of EtherNet/IP packets the module has received, since the last reset, in packets/second.
Modbus TCP Requests The number of Modbus TCP requests the module has sent, since the last reset, in packets/second.
Modbus TCP Responses The number of Modbus TCP responses the module has received, since the last reset, in packets/second.
I/O Adapter:
EtherNet/IP Sent (writes) The number of EtherNet/IP packets the module has sent—in the role of a local slave—since the last reset, in packets/second.
EtherNet/IP Received (read) The number of EtherNet/IP packets the module has received—in the role of a local slave—since the last reset, in packets/second.
I/O - Module
Module Capacity
Module Utilization
The maximum number of packets that the module can process, in packets per second.
The percentage of communication module capacity being used by the application.
The background color of the value changes, depending on the percentage utilization.
342
S1A33985 12/2018
Parameter
Messaging - Client:
EtherNet/IP activity
Modbus TCP activity
Messaging - Server:
EtherNet/IP activity
Modbus TCP activity
Embedded Web Pages
Description
The number of I/O messages sent by the module—using the EtherNet/IP protocol— since last reset, in packets per second.
The number of I/O messages sent by the module—using the Modbus TCP protocol— since last reset, in packets per second.
The number of I/O messages received by the module—using the EtherNet/IP protocol—since last reset, in packets per second.
The number of I/O messages received by the module—using the Modbus TCP protocol—since last reset, in packets per second.
S1A33985 12/2018
343
Embedded Web Pages
Scanner Status
Introduction
The Scanner Status web page displays read-only data describing the current state of the
140 NOC 771 01 Ethernet communication module in its role as I/O scanner.
Scanner Status Display
The top of the page displays the following general diagnostic information about the scanner:
I/O scanning status
A value of Operational indicates that the values in the Scanner Status grid are reporting the state of scanned devices.
A value of Stopped indicates the local system is not scanning. In this case, any data that appears in the Scanner Status grid is meaningless.
Number of transactions per second
Number of connections
The Scanner Status web page looks like this:
344
In the Scanner Status grid, the colors that appear in each block indicate the following states for specific remote devices:
GREEN indicates that a device is being scanned
BLACK indicates that I/O scanning of the specific device has been intentionally disabled
GRAY indicates an device that is not configured
RED indicates a suspect device
S1A33985 12/2018
Embedded Web Pages
NOTE: A green Scanner Status indicator in the grid can remain green for a remote scanned device after the Ethernet cable is detached from that device. This situation can occur if the health timeout value for that device is set to 0.
To avoid this result—and to help promote the accurate reporting of I/O scanning health—configure an operational health timeout value in the range 1...65535 (in 1 ms increments).
The grid also indicates the protocol used to communicate with the remote device:
MB: indicates a Modbus TCP connection
EIP: indicates an EtherNet/IP connection
To open this page:
2
3
Step
1
Action
Starting at the Home page, click the Diagnostics main menu item. The
Diagnostics page opens.
On the left side of the Diagnostics page, select Ethernet → Scanner Status.
If necessary, type in the HTTP web access password.
NOTE: The default password is USER.
S1A33985 12/2018
345
Embedded Web Pages
Messaging
Introduction
The Messaging page provides current information on the open TCP connections on port 502.
Messaging Display
The top of the page displays the number of messages sent and received by local port 502.
The Messaging page looks like this:
346
The display grid provides the following information about each active connection:
Conn.: the connection number—1 to 64
Remote address: the IP address of the remote device
NOTE: If the remote device includes an embedded web server, click on the Remote address to open that server and view the remote device’s web pages.
Remote port: the TCP port for the connection on the remote device
Local port: the TCP port for the connection on the Ethernet communication module
Type: the connection type—EtherNet/IP or Modbus TCP
Mess. Sent: the number of messages transmitted over this connection
Mess. Received: the number of messages received by this connection
Error Sent: the number of events detected on this connection
NOTE:
Following a request to close a connection, the PLC may hold the connection open in its memory
for a few minutes, during which the display will reflect the open connection.
The Number of Messages received is not reset after a port 502 connection is closed. Therefore, the count indicates the total number of messages that have been received since the module was started
S1A33985 12/2018
To open this page:
2
3
Step
1
Action
Starting at the Home page, click the Diagnostics main menu item. The
Diagnostics page opens.
On the left side of the Diagnostics page, select Ethernet → Messaging.
If necessary, type in the HTTP web access password.
NOTE: The default password is USER.
Embedded Web Pages
S1A33985 12/2018
347
Embedded Web Pages
Ethernet Statistics
Introduction
The Ethernet Statistics page provides information about the status, transmit and receive statistics, and detected errors for the web server embedded in the 140 NOC 771 01 communication module.
Ethernet Statistics Display
The Ethernet Statistics page looks like this:
348
Click the Reset counters button to reset the counting statistics to zero.
To open this page:
2
3
Step
1
Action
Starting at the Home page, click the Diagnostics main menu item. The
Diagnostics page opens.
On the left side of the Diagnostics page, select Ethernet → Ethernet Statistics.
If necessary, type in the HTTP web access password.
NOTE: The default password is USER.
S1A33985 12/2018
Embedded Web Pages
Ethernet Statistics
The Ethernet Statistics page displays the following data for the Ethernet communication module.
Ethernet configuration data:
Hostname
MAC Address
IP Address
Subnet Mask
Gateway Address
The name assigned to the communication module
The factory assigned Media Access Control (MAC) address, consisting of 6 hexidecimal octet values
The Internet Protocol (IP) address ( see page 62
assigned to the communication module
The subnet mask
communication module
that has been assigned to the
The IP address of the remote device ( see page 62
serves as a gateway to the communication module
, if any, that
Port Statistics:
Speed (Operational) Baud rate: 0, 10 or 100 Mbits/second
Duplex (Operational) Twisted Pair—Full Link, or Twisted Pair—Half Link
Frames transmit OK The number of frames that have been successfully transmitted
Frames received OK The number of frames that have been successfully received
Collisions The number of times a collision between two successfully transmitted packets was detected on the link
Excessive collisions The number of times the transmitter has not succeeded after 16 attempts to transmit a frame, due to repeated collisions
Late collisions The number of times a collision was detected after the slot time of the channel had elapsed
CRC errors The number of times a CRC (FCS) error was detected on an incoming frame
The number of inbound bytes received on the interface Number Bytes
Received
Number Inbound
Packets Error
The number of inbound packets that contain detected errors (not included in discards)
Number Inbound
Packets Discard
The number of inbound packets received on the interface, but discarded
Number Bytes Sent The number of outbound bytes transmitted on the interface
Number Outbound
Packets Error
Number Outbound
Packets Discard
The number of outbound packets that contain detected errors (not included in discards)
The number of outbound packets discarded while attempting to send them
S1A33985 12/2018
349
Embedded Web Pages
QoS Configuration
Introduction
The 140 NOC 771 01 Ethernet communication module supports the OSI layer 3 Quality of Service
(QoS) standard defined in RFC-2475. When the QoS is enabled, the module adds a of that packet.
differentiated services code point (DSCP) tag to each Ethernet packet it transmits, thereby indicating the priority
The QoS Configuration page displays both the:
status of the QoS Ethernet packet tagging service—enabled or disabled, and
the QoS service configuration settings
NOTE: The QoS service is enabled in the Services page
settings are input in the QoS page
Tool.
see page 67
see page 80
) , of the Control Expert Ethernet Configuration
QoS Configuration Display
The QoS Configuration page looks like this:
350
This page is read-only.
To open this page:
2
3
Step
1
Action
Starting at the Home page, click the Diagnostics main menu item. The Diagnostics page opens.
On the left side of the Diagnostics page, select Ethernet → QoS Configuration.
If necessary, type in the HTTP web access password.
NOTE: The default password is USER.
S1A33985 12/2018
Embedded Web Pages
Properties
Introduction
The Properties web page displays read-only data describing the particular 140 NOC 771 01
Ethernet communication module installed in your system.
Properties Display
The Properties page looks like this:
To open this page:
2
3
Step
1
Action
Starting at the Home page, click the Diagnostics main menu item. The
Diagnostics page opens.
On the left side of the Diagnostics page, select Properties.
If necessary, type in the HTTP web access password.
NOTE: The default password is USER.
S1A33985 12/2018
351
Embedded Web Pages
352
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
S1A33985 12/2018
Appendices
What Is in This Appendix?
The appendix contains the following chapters:
Chapter Name Chapter
A
B
Detected Error Codes
CIP General Status Codes
Page
S1A33985 12/2018
353
354
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Detected Error Codes
S1A33985 12/2018
Detected Error Codes Appendix A
Detected Error Codes
Overview
This chapter contains a list of codes that describe the status of Ethernet communication module messages.
What Is in This Chapter?
This chapter contains the following topics:
Topic
TCP/IP Ethernet Detected Error Codes
Modbus TCP Explicit Messaging Detected Error Codes
EtherNet/IP Implicit or Explicit Messaging Detected Error Codes
Page
S1A33985 12/2018
355
Detected Error Codes
TCP/IP Ethernet Detected Error Codes
TCP/IP Ethernet Detected Error Codes
An event in an MBP_MSTR routine via TCP/IP Ethernet may produce one of the following codes in the MBP_MSTR control block.
TCP/IP Ethernet Hexadecimal Detected Error Codes
TCP/IP Ethernet hexadecimal detected error codes include:
Code (hexadecimal)
16#1001
16#2001
16#2002
16#2003
16#2004
16#2005
16#2006
16#2007
16#2008
16#200E
16#200F
16#3000
16#3001
16#3002
16#3003
16#3005
16#3006
16#3007
16#4001
16#F001
16#F002
Meaning
Abort by user
An operation type that is not supported has been specified in the control block
One or more control block parameters were modified while the MSTR element was active (this only applies to operations which require several cycles for completion).
Control block parameters my only be modified in inactive MSTR components.
Invalid value in the length field of the control block
Invalid value in the offset field of the control block
Invalid value in the length and offset fields of the control block
Unauthorized data field on slave
Invalid slot number in the configuration routing register
Example: 253 for 140 CRP 312 00 slot number
Unauthorized network routing path on slave
The control block is not assigned, or parts of the control block are located outside of the %MW (4x) range.
The space allocated for the CIP response is too small.
Generic Modbus exception response
Slave does not support requested operation
Non-existing slave registers were requested
An unauthorized data value was requested
Slave has accepted a lengthy program command
Function cannot currently be carried out: lengthy command running
Slave has rejected lengthy program command
Inconsistent response by Modbus slave
Module is resetting
Component not fully initialized
356
S1A33985 12/2018
Detected Error Codes
Modbus TCP Explicit Messaging Detected Error Codes
Modbus TCP Detected Error Codes
An event in an MBP_MSTR routine via Modbus TCP may produce one of the following detected error codes in the MBP_MSTR control block.
Modbus TCP Hexadecimal Detected Error Codes
Modbus TCP hexadecimal detected error codes include:
Code (hexadecimal)
16#5101
16#5102
16#5103
16#5104
16#5105
16#5106
16#5107
16#5108
16#5109
16#5301
16#510A
16#510B
Meaning
No resources
Bad IP address
Transaction timed out
Concurrent connections or transactions limit reached
Remote address not allowed
No route to host
Remote host is down
Connection reset by peer
Network is down
No resources available
— or —
Module not ready or initializing
Connection refused
Connection timed out
S1A33985 12/2018
357
Detected Error Codes
EtherNet/IP Implicit or Explicit Messaging Detected Error Codes
Introduction
If an MBP_MSTR function block does not execute an EtherNet/IP explicit message, Control Expert displays a hexadecimal detected error code. This code can describe:
an EtherNet/IP event a TCP/IP Ethernet event
Refer to the topic TCP/IP Ethernet detected error codes
codes.
see page 356
EtherNet/IP Detected Error Codes
EtherNet/IP hexadecimal detected error codes include:
Code
16#800D
16#8015
16#8018
Description
Timeout on the explicit message request
Either:
Nor resources to handle the message, or
Internal event: no buffer available, no link available, impossible to send to the TCP task
Either:
Another explicit message for this device is in progress, or
TCP connection or encapsulation session in progress
16#8030 Timeout on the Forward_Open request
Note: The following 16#81xx events are Forward_Open response detected error codes that originate at the remote target and are received via the CIP connection.
16#8100
16#8103
16#8106
16#8107
Connection in use or duplicate Forward_Open
Transport class and trigger combination not supported
Ownership conflict
Target connection not found
16#8108
16#8109
16#8110
16#8111
16#8113
16#8114
16#8115
16#8116
16#8117
Invalid network connection parameter
Invalid connection size
Target for connection not configured
RPI not supported
Out of connections
Vendor ID or product code mismatch
Product type mismatch
Revision mismatch
Invalid produced or consumed application path
358
S1A33985 12/2018
Detected Error Codes
16#8133
16#8134
16#8135
16#8136
16#8141
16#8142
16#8145
16#8146
16#8147
16#8148
16#8149
16#814A
16#814B
16#814C
16#814D
16#814E
Code
16#8118
16#8119
16#811A
16#811B
16#8123
16#8124
16#8125
16#8126
16#8127
16#8131
16#8132
16#814F
16#8160
16#8170
16#8171
16#8173
16#81A0
S1A33985 12/2018
Description
Invalid or inconsistent configuration application path
Non-Listen Only connection not opened
Target object out of connections
RPI is smaller than the production inhibit time
Connection timed out
Unconnected request timed out
Parameter event in unconnected request and service
Message too large for unconnected_send service
Unconnected acknowledge without reply
No buffer memory available
Network bandwidth not available for data
No consumed connection ID filter available
Not configured to send scheduled priority data
Schedule signature mismatch
Schedule signature validation not possible
Port not available
Link address not valid
Invalid segment in connection path
Event in Forward_Close service connection path
Scheduling not specified
Link address to self invalid
Secondary resources unavailable
Rack connection already established
Module connection already established
Miscellaneous
Redundant connection mismatch
No more user-configurable link consumer resources: the configured number of resources for a producing application has reached the limit
No more user-configurable link consumer resources: there are no consumers configured for a producing application to use
Vendor specific
No target application data available
No originator application data available
Not configured for off-subnet multicast
Event in data assignment
359
Detected Error Codes
Code
16#81B0
16#81C0
Description
Optional object state event
Optional device state event
Note: All 16#82xx events are register session response detected error codes.
16#8200 Target device does not have sufficient resources
16#8208
16#820F
Target device does not recognize message encapsulation header
Reserved or unknown event from target
360
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
CIP General Status Codes
S1A33985 12/2018
CIP General Status Codes Appendix B
CIP General Status Codes
CIP General Status Codes
02
03
04
05
06
07
08
General
Status Code
(in hex)
00
01
NOTE: Taken by permission from The CIP Networks Library, Volume 1
Protocol (CIP™), Edition 3.6, April 2009.
, Common Industrial
The following table lists the status codes that may be present in the general status code field of a detected error response message. Note that the extended code field is available for use in further describing any general status code. Extended status codes are unique to each general status code within each object. Each object manages the extended status values and value ranges (including vendor specific). All extended status values are reserved unless otherwise indicated within the object definition.
Status Name
Success
Connection unsuccessful
Description of Status
09
0A
Resource unavailable
Invalid parameter value
Path segment error
Path destination unknown
Partial transfer
Connection lost
Service not supported
Invalid attribute value
Attribute list error
Service was successfully performed by the object specified.
A connection related service was unsuccessful along the connection path.
Resources needed for the object to perform the requested service were unavailable.
See status code 0x20, which is the preferred value to use for this condition.
The path segment identifier or the segment syntax was not understood by the processing node. Path processing stops when a path segment error is detected.
The path is referencing an object class, instance, or structure element that is not known or is not contained in the processing node. Path processing stops when a path destination unknown error is detected.
Only part of the expected data was transferred.
The messaging connection was lost.
The requested service was not implemented or was not defined for this object class/instance.
Invalid attribute data detected.
An attribute in the Get_Attribute_List or Set_Attribute_List response has a non-zero status.
S1A33985 12/2018
361
CIP General Status Codes
14
15
16
17
0D
0E
0F
10
General
Status Code
(in hex)
0B
Status Name
0C
11
12
13
18
19
1A
1B
1C
1D
1E
Description of Status
Already in requested mode/state The object is already in the mode/state being requested by the service.
Object state conflict The object cannot perform the requested service in its current mode/state.
Object already exists
Attribute not settable
Privilege violation
The requested instance of object to be created already exists.
A request to modify a non-modifiable attribute was received.
A permission/privilege check was unsuccessful.
Device state conflict The device’s current mode/state prohibits the execution of the requested service.
Reply data too large
Fragmentation of a primitive value
Not enough data
Attribute not supported
Too much data
Object does not exist
Service fragmentation sequence not in progress
No stored attribute data
Store operation unsuccessful
Routing unsuccessful, request packet too large
Routing unsuccessful, response packet too large
The data to be transmitted in the response buffer is larger than the allocated response buffer.
The service specified an operation that is going to fragment a primitive data value, i.e., half a REAL data type.
The service did not supply enough data to perform the specified operation.
The attribute specified in the request is not supported.
The service supplied more data than was expected.
The object specified does not exist in the device.
The fragmentation sequence for this service is not currently active for this data.
The attribute data of this object was not saved prior to the requested service.
The attribute data of this object was not saved due to an unsuccessful attempt.
The service request package was too large for transmission on a network in the path to the destination. The routing device was forced to abort the service.
The service response packet was too large for transmission on a network in the path from the destination. The routing device was forced to abort the service.
Missing attribute list entry data The service did not supply an attribute in a list of attributes that was needed by the service to perform the requested behavior.
Invalid attribute value list The service is returning the list of attributes supplied with status information for those attributes that were invalid.
Embedded service error An embedded service resulted in a detected error.
362
S1A33985 12/2018
CIP General Status Codes
General
Status Code
(in hex)
1F
Status Name
20
21
22
23
24
25
26
27
28
29
2A
2B
2C
Description of Status
Vendor specific error
Invalid parameter
Write-once value or medium already written
Invalid reply received
Buffer overflow
Message format error
Key failure in path
Path size invalid
Unexpected attribute in list
Invalid member ID
Member not settable
Group 2 only server — general error
Unknown Modbus error
Attribute not gettable
A vendor specific error has been detected. The additional code field of the error response defines the particular error encountered. Use this general code only when none of the codes presented in this table or within an object class definition accurately reflect the detected error.
A parameter associated with the request was invalid. This code is used when a parameter does not meet the requirements of this specification and/or the requirements defined in an application object specification.
An attempt was made to write to a write-once medium (e.g., WORM drive, PROM) that has already been written, or to modify a value that cannot be changed once established.
An invalid reply is received (e.g., reply service code does not match the request service code, or reply message is shorter than the minimum expected reply size). This status code an serve for other causes of invalid replies.
The message received is larger than the receiving buffer can handle. The entire message was discarded.
The format of the received message is not supported by the server.
The key segment that was included as the first segment in the path does not match the destination module. The object specific status indicates which part of the key check was unsuccessful.
The size of the path that was sent with the service request is either not large enough to allow the request to be routed to an object or too much routing data was included.
An attempt was made to set an attribute that is not able to be set at this time.
The member ID specified in the request does not exist in the specified class/instance/attribute.
A request to modify a non-modifiable member was received.
This detected error code may only be reported by DeviceNet group
2 only servers with 4 Kb or less code space and only in place of service not supported, attribute not support, or attribute not settable.
A CIP to Modbus translator received an unknown Modbus exception code.
A request to read a non-readable attribute was received.
S1A33985 12/2018
363
CIP General Status Codes
General
Status Code
(in hex)
2D - CF
D0 - FF
Status Name
–
Reserved for object class and service errors
Description of Status
Reserved by CIP for future extensions.
This range of detected error codes is used to indicate object class specific detected errors. Use this range only when none of the codes presented in this table accurately reflect the error that is detected.
364
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Glossary
S1A33985 12/2018
Glossary
R
RPI
(requested packet interval) The time period between cyclic data transmissions requested by the
Scanner. EtherNet/IP devices will publish data at the rate specified by the RPI assigned to them by the Scanner. Modbus TCP devices will receive message requests from the Scanner at each
RPI.
S1A33985 12/2018
365
Glossary
366
S1A33985 12/2018
Quantum using EcoStruxure™ Control Expert
Index
S1A33985 12/2018
Index
0-9
140 NOC 780 00 device editor,
DTM browser,
A
add remote device, address
advanced mode
DTM browser,
Advantys STB island
assembly object, auto-negotiation,
,
B
C
channel properties,
CIP objects,
configuration inputs, outputs,
configuring
connection diagnostics,
type, connection manager object,
S1A33985 12/2018 connection timeout calculating, control bits,
Control Expert
download application, upload application,
D
data editor creating a data template, direct address,
modify data,
saving a data template, data editor (standard), data template displaying a data template, derived data types, derived variables, detected error codes
EtherNet/IP,
Modbus TCP,
TCP/IP, device bandwidth,
DTM browser, device load,
DHCP,
,
367
Index
scanner status,
diagnostics web page, download,
DTM
bandwidth,
properties,
add,
Ethernet port,
processor load,
,
Ethernet statistics,
DTM browser advanced mode,
configuring properties in device editor,
DTM browser menu commands,
E
EDS file add,
Ethernet
connection speed,
Ethernet diagnostics,
Ethernet link object,
EtherNet/IP detected error codes,
EtherNet/IP explicit connection diagnostics object,
,
EtherNet/IP interface diagnostics object,
EtherNet/IP IO Scanner Diagnostics object,
EtherNet/IP settings,
EtherNet/IP,
Modbus TCP,
368 explicit messaging
EtherNet/IP,
Read Modbus Object,
Modbus TCP function codes,
explicit messaging detected error codes,
F
FDR,
G
get local statistics,
get remote statistics,
H
hardware catalog
health bits,
home web page,
I
I/O connection,
IGMP snooping,
implicit message, inputs
IO connection diagnostics object,
S1A33985 12/2018
L
LED indicators, load example, limits, local slave, diagnostics,
,
M
,
MBP_MSTR detected error codes,
menu commands
DTM browser, message priority, message load,
message bandwidth,
monitoring web page,
messages
,
,
Modbus TCP detected error codes,
N
network example,
network example,
,
S1A33985 12/2018
O
online action
display CIP object data, get port configuration, ping,
online parameters, outputs
P
password data editor write,
port mirroring,
Q
QoS,
QoS object,
R
rack viewer, read data,
RSTP,
read/write data, remote device configuring, replacement, reset module,
,
S
Index
369
Index services
specifications,
status summary,
,
communication,
STB NIC 2212 configuring I/O items,
STB NIP 2212 configuring I/O items, switch
recommended features,
T
TCP/IP detected error codes,
timeout
U
username,
V
variables
W
web pages
diagnostics,
Ethernet statistics,
scanner status,
processor load,
370
S1A33985 12/2018
பதிவிறக்கு
பொது இணைப்பு புதுப்பிக்கப்பட்டது
உங்கள் அரட்டைக்கான பொது இணைப்பு புதுப்பிக்கப்பட்டுள்ளது. You may view and manage your chat links after registration here.
ஆவண பொது இணைப்பு
விளம்பரம்