M340 NOC Manual PDF

Modicon M340
S1A34009 07/2012
Modicon M340
BMX NOC 0401
Ethernet Communication Module
User Manual
07/2012
S1A34009.02
www.schneider-electric.com
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.
No part of this document may be reproduced in any form or by any means, electronic
or mechanical, including photocopying, without express written permission of
Schneider Electric.
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.
© 2012 Schneider Electric. All rights reserved.
2 S1A34009 07/2012
Table of Contents
Safety Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Chapter 1 Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Physical Description of the BMX NOC 0401 Module . . . . . . . . . . . . . . . . 14
Module Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Communication Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Mounting the BMX NOC 0401 Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Installing Unity Pro Ethernet Configuration Tool Software . . . . . . . . . . . . 23
UnInstalling the Ethernet Configuration Tool. . . . . . . . . . . . . . . . . . . . . . . 25
Chapter 2 Configuring the Ethernet Communication Module . . . . 27
2.1 Ethernet Network Configuration Example . . . . . . . . . . . . . . . . . . . . . . . . . 28
The Ethernet Network Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.2 Creating a Project in Unity Pro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Creating a Project in Unity Pro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Configuring the Size and Location of Inputs and Outputs . . . . . . . . . . . . . 36
2.3 The Unity Pro FDT/DTM Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
DTM Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
DTM Browser Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Field Bus Discovery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Device Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Configuring Properties in the Device Editor . . . . . . . . . . . . . . . . . . . . . . . 55
Uploading and Downloading DTM-Based Applications. . . . . . . . . . . . . . . 57
2.4 Channel Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Channel Properties Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Channel Properties - Switch Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Channel Properties - QoS Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Channel Properties — TCP/IP Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Channel Properties - EtherNet/IP Page . . . . . . . . . . . . . . . . . . . . . . . . . . 72
2.5 Ethernet Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Enabling Ethernet Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Configuring the DHCP and FDR Servers . . . . . . . . . . . . . . . . . . . . . . . . . 77
Configuring the SNMP Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Configuring Access Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Configuring QoS Ethernet Packet Tagging . . . . . . . . . . . . . . . . . . . . . . . . 89
S1A34009 07/2012 3
Configuring the Rapid Spanning Tree Protocol . . . . . . . . . . . . . . . . . . . . 93
Configuring the Email Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Sending Email via the SEND_EMAIL Block. . . . . . . . . . . . . . . . . . . . . . . 99
Configuring the Network Time Service . . . . . . . . . . . . . . . . . . . . . . . . . . 101
2.6 Configuring the Ethernet Communication Module as an EtherNet/IP
Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Introducing the Local Slave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Configuring a Local Slave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Local Slave Inputs and Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Chapter 3 Adding Devices to an Ethernet Network . . . . . . . . . . . . . 119
3.1 Hardware Catalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Adding a DTM to the Unity Pro Hardware Catalog . . . . . . . . . . . . . . . . . 121
Add an EDS File to the Unity Pro Hardware Catalog. . . . . . . . . . . . . . . . 122
Updating the Unity Pro Hardware Catalog. . . . . . . . . . . . . . . . . . . . . . . . 124
Remove an EDS File from the Unity Pro Hardware Catalog . . . . . . . . . . 126
3.2 Adding an EtherNet/IP Device to the Network . . . . . . . . . . . . . . . . . . . . . 128
Setting Up Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Adding an STB NIC 2212 Remote Device . . . . . . . . . . . . . . . . . . . . . . . . 131
Configuring STB NIC 2212 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Configuring EtherNet/IP Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Connecting to the Advantys STB Island . . . . . . . . . . . . . . . . . . . . . . . . . 145
Configuring I/O Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
3.3 Adding a Modbus TCP Device to the Network. . . . . . . . . . . . . . . . . . . . . 162
Setting Up Your Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Adding an STB NIP 2212 Remote Device . . . . . . . . . . . . . . . . . . . . . . . . 165
Configuring STB NIP 2212 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Connecting to the Advantys STB Island . . . . . . . . . . . . . . . . . . . . . . . . . 174
Configuring I/O Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Chapter 4 Working With Derived Data Types . . . . . . . . . . . . . . . . . . 187
Creating and Updating Derived Data Types . . . . . . . . . . . . . . . . . . . . . . 188
Working with Derived Data Type Variables . . . . . . . . . . . . . . . . . . . . . . . 190
Effect of Activating and De-activating Devices on I/O %MW Memory
Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Chapter 5 Optimizing Performance . . . . . . . . . . . . . . . . . . . . . . . . . . 203
5.1 Selecting a Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Role of a Switch in an Ethernet Network . . . . . . . . . . . . . . . . . . . . . . . . . 205
Transmission Speed, Duplex and Auto-Negotiation . . . . . . . . . . . . . . . . 206
Quality of Service (QoS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
IGMP Snooping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Rapid Spanning Tree Protocol (RSTP) . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Virtual Local Area Network (VLAN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Port Mirroring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Simple Network Management Protocol (SNMP) Agent . . . . . . . . . . . . . . 214
4 S1A34009 07/2012
5.2 Control Application Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Message Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Message Connection Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
TCP and CIP Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Message Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Messaging Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Message Frequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Allocating Network Bandwidth. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Estimating Message Traverse and Response Times . . . . . . . . . . . . . . . . 227
5.3 Projecting Ethernet Network Performance . . . . . . . . . . . . . . . . . . . . . . . . 229
Network Load and Bandwidth Calculation Example . . . . . . . . . . . . . . . . . 229
Chapter 6 CIP Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Identity Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Assembly Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Connection Manager Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Modbus Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Quality Of Service (QoS) Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
TCP/IP Interface Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Ethernet Link Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
EtherNet/IP Interface Diagnostics Object . . . . . . . . . . . . . . . . . . . . . . . . . 252
EtherNet/IP IO Scanner Diagnostics Object . . . . . . . . . . . . . . . . . . . . . . . 255
IO Connection Diagnostics Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
EtherNet/IP Explicit Connection Diagnostics Object . . . . . . . . . . . . . . . . . 261
EtherNet/IP Explicit Connection Diagnostics List Object. . . . . . . . . . . . . . 264
Chapter 7 Online Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Accessing CIP Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Editing Port Configuration Properties for Remote EtherNet/IP Devices . . 270
Pinging a Network Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Viewing and Editing Online Settings for a Remote Device . . . . . . . . . . . . 275
Chapter 8 Explicit Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
8.1 Explicit Messaging Using the DATA_EXCH Block . . . . . . . . . . . . . . . . . . 280
Configuring Explicit Messaging Using DATA_EXCH . . . . . . . . . . . . . . . . 281
Configuring the DATA_EXCH Management Parameter . . . . . . . . . . . . . . 283
8.2 EtherNet/IP Explicit Messaging Using DATA_EXCH . . . . . . . . . . . . . . . . 284
Explicit Messaging Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Configuring EtherNet/IP Explicit Messaging Using DATA_EXCH. . . . . . . 287
EtherNet/IP Explicit Message Example: Get_Attribute_Single . . . . . . . . . 289
EtherNet/IP Explicit Message Example: Read Modbus Object . . . . . . . . . 293
EtherNet/IP Explicit Message Example: Write Modbus Object . . . . . . . . . 297
8.3 Modbus TCP Explicit Messaging Using DATA_EXCH . . . . . . . . . . . . . . . 301
Modbus TCP Explicit Messaging Function Codes . . . . . . . . . . . . . . . . . . 302
Configuring Modbus TCP Explicit Messaging Using DATA_EXCH . . . . . 303
EtherNet/IP Explicit Message Example: Read Register Request . . . . . . . 305
S1A34009 07/2012 5
8.4 Explicit Messaging via the Unity Pro GUI . . . . . . . . . . . . . . . . . . . . . . . . 309
Sending Explicit Messages to EtherNet/IP Devices. . . . . . . . . . . . . . . . . 310
Sending Explicit Messages to Modbus TCP Devices . . . . . . . . . . . . . . . 312
Chapter 9 Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
9.1 Module Hardware Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
LED Indicators for the BMX NOC 0401 . . . . . . . . . . . . . . . . . . . . . . . . . . 316
9.2 Unity Pro Software Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Using the Diagnostic Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Ethernet Port Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Bandwidth Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Email Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Network Time Service Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Communication Module RSTP Diagnostics . . . . . . . . . . . . . . . . . . . . . . . 333
Local Slave / Connection Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Local Slave or Connection I/O Value Diagnostics . . . . . . . . . . . . . . . . . . 340
Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
9.3 CPU I/O Block Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Accessing the Unity Pro Diagnostic Tools . . . . . . . . . . . . . . . . . . . . . . . . 345
Communication Channel Diagnostics in Unity Pro . . . . . . . . . . . . . . . . . 348
Communication Module Diagnostics in Unity Pro . . . . . . . . . . . . . . . . . . 350
Chapter 10 Replacing the Ethernet Communication Module . . . . . . 357
Replacing the Ethernet Communication Module . . . . . . . . . . . . . . . . . . . 357
Chapter 11 Embedded Web Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
11.1 Accessing the Embedded Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Introducing the Embedded Web Pages . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Accessing the Home Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Using and Editing a Username and Passwords. . . . . . . . . . . . . . . . . . . . 363
Configuring Port Mirroring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
11.2 Monitoring the Unity Pro Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Using the Monitoring Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Data Editor (Standard) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Working With Data Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Data Editor (Lite) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
11.3 Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Using the Diagnostics Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Status Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Rack Viewer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Processor Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Scanner Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
QoS Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Port Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
6 S1A34009 07/2012
Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Email Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Network Time Service Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Appendices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Appendix A Detected Error Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
EtherNet/IP Implicit or Explicit Messaging Event Codes . . . . . . . . . . . . . . 408
Explicit Messaging: Communication and Operation Reports . . . . . . . . . . 411
Appendix B CIP General Status Codes . . . . . . . . . . . . . . . . . . . . . . . . 415
CIP General Status Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Appendix C Modbus Exception Response Codes . . . . . . . . . . . . . . . 419
MODBUS Exception Response Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Appendix D Email Event Response Codes . . . . . . . . . . . . . . . . . . . . . 421
Electronic Mail Notification Service Event Response Codes . . . . . . . . . . 421
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
S1A34009 07/2012 7
8 S1A34009 07/2012
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, 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.
S1A34009 07/2012 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.
10 S1A34009 07/2012
About the Book
At a Glance
Document Scope
This manual describes the use of the Modicon M340 BMX NOC 0401 Ethernet
communication module. This manual describes the creation of a complete
configuration. The features and functions of the module are described in the course
of constructing this configuration.
The specific configuration settings contained in this manual are intended to be used
for instructional purposes only. The settings required for your specific configuration
ill differ from the examples presented in this manual.
Validity Note
The module described in this document can requires Unity Pro version 5.0 or later.
Related Documents
For additional information, refer to the online help files for the Unity Pro software,
and to the following technical publications:
Title of Documentation Reference Number

Advantys STB EtherNet/IP Network Interface Applications Guide 31008204 (English),
31008205 (French),
31008206 (German),
31008207 (Spanish),
31008208 (Italian)
You can download these technical publications and other technical information from
our website at www.schneider-electric.com.
User Comments
We welcome your comments about this document. You can reach us by e-mail at
techcomm@schneider-electric.com.
S1A34009 07/2012 11
12 S1A34009 07/2012
Modicon M340
Installation
S1A34009 07/2012
Installation
1
Overview
The Ethernet communication module serves as the interface between a M340 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:
z inserting it into a PLC backplane
z connecting it to an Ethernet network
z installing the Unity Pro Ethernet Configuration Tool software
What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Physical Description of the BMX NOC 0401 Module 14
Module Specifications 17
Communication Specifications 19
Mounting the BMX NOC 0401 Module 21
Installing Unity Pro Ethernet Configuration Tool Software 23
UnInstalling the Ethernet Configuration Tool 25
S1A34009 07/2012 13
Installation
Physical Description of the BMX NOC 0401 Module
Front
The front of the module presents the following features:
14 S1A34009 07/2012
Installation
Rotary Switches
The back of the BMX NOC 0401 presents two rotary switches, which you can use to
specify how the module will obtain its IP address.
The settings of these two rotary switches work together to specify the source of the
module’s IP address, as follows:
Setting Description
Upper switch:
0...9 Tens value (0, 10, 20...90) for the device name setting. It is added to the ones
value on the lower switch to identify the module to a DHCP server.
A...F Tens value (100, 200, 300...150) for the device name setting. It is added to the
ones value on the lower switch to identify the module to a DHCP server.
Lower switch:
0...9 Ones value (0, 1, 2...9) for the device name setting. It is added to the tens
value on the upper switch to identify the module to a DHCP server.
A+B BootP1:The module obtains its IP address from a BootP server.
C+D Stored1: The module uses the IP address configured in the application.
E+F Clear IP1: The module applies its default IP address.
1. The lower switch alone determines module behavior. The upper switch is ignored.
S1A34009 07/2012 15
Installation
Switch Labels
The right side of the module displays two labels explaining the choice of rotary
switch settings, as depicted below.
LEDs
The BMX NOC 0401 communication module presents the following LED indicators:
z RUN (running)
z ERR (detected error)
z MS (module status)
z NS (network status)
z ETH STS (Ethernet status)
In addition, each Ethernet port presents the following two LED indicators:
z LNK (link)
z ACT (activity)
For a description of these LEDs, and how to use them to diagnose the
communication module, refer to the topic LED Indicators for the Ethernet
Communication Module (see page 316).
16 S1A34009 07/2012
Installation
Module Specifications
Specifications
BMX NOC 0401 specifications include:
Ports
Communication Ports Four auto-sensing 10/100Base-T shielded twisted pair (RJ-45
connector) ports.
Electrical
Bus Current Required @3.3V: 550 mA
Power Dissipation 1.9 W
Fuse None
Operating Conditions
Temperature –25...+70° C
Humidity 0...95% Rh non-condensing @ 60° C
Altitude 2000 m (6561.68 ft)
Storage Conditions
Temperature –40...+85° C
Humidity 0...95% Rh non-condensing @ 60° C
Altitude 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:
z UL 508
z CSA 22.2-142
z CSA 22.2-213
z CE
z EMI EN55011
z EN61131-2
z IEC61131-2
z IEEE 802.3 2002
z ODVA
S1A34009 07/2012 17
Installation
Communication Modules per Station

The maximum number of communication modules — including but not limited to
BMX NOC 0401 Ethernet communication modules — you can install in a single
station is determined by the CPU serving that station
CPU Maximum Number of Communication Modules per Station

BMX P34 1000 2
BMX P34 2000 3
BMX P34 2010 3
BMX P34 20102 3
BMX P34 2020 3
BMX P34 2030 3
BMX P34 20302 3
NOTE: If you use the embedded Ethernet port with the BMX P34 2••• copro, the
maximum number of communication modules per station is 2.
18 S1A34009 07/2012
Installation
Communication Specifications
Introduction
The following specifications describe both the I/O communication and the
explicit messaging capacities of the BMX NOC 0401.
I/O Communication Specifications

The Ethernet communication module presents the following I/O communication
features:
Communication type Feature Capacity

EtherNet/IP Scanner
(CIP Implicit Messaging)
Maximum number of devices 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 512 bytes including header
Inputs 507 bytes excluding header
Outputs 509 bytes excluding header
Modbus TCP Maximum number of registers
(Modbus Scanner)
Read 125 registers
Write 120 registers
Maximum number of devices 128 devices shared with EtherNet/IP
Maximum message size
Read 250 bytes (125 words) excluding header
Write 240 bytes (120 words) excluding header
S1A34009 07/2012 19
Installation
Explicit Messaging Specifications

The Ethernet communication module presents the following explicit messaging
features:
Communication type Feature Capacity

EtherNet/IP Client
(CIP Explicit Messaging) Maximum number of simultaneous 16 connections
connections
Maximum number of concurrent 16 requests, shared with Modbus TCP
requests
Server
Maximum number of simultaneous 32 connections
connections
Maximum messaging size 1023 bytes
Modbus TCP Client
(Modbus Scanner) Maximum number of simultaneous 16 connections
connections
Maximum number of concurrent 16 requests, shared with EtherNet/IP
requests
Server
Maximum number of simultaneous 128 requests
requests
Maximum number of simultaneous 32 connections
connections
Maximum message size
Read 250 bytes (125 words) excluding header
Write 240 bytes (120 words) excluding header
20 S1A34009 07/2012
Installation
Mounting the BMX NOC 0401 Module
Tools Required
One medium sized (size 2) Phillips-head screw driver.
Mounting the Module

The module can be mounted in any of the racks of the Modicon M340 system. It can
be installed in any available slot (except in the offset X Bus racks). To mount the
communication module:
Step Action Illustration

1 Position the locating pins (situated at
the bottom part of the rear of the
module) in the corresponding slots.
2 Swivel the module upwards toward
the top of the rack, so that the back of
the module sits flush with the rack.
NOTE: Before positioning the pins,
remove the pins protective cover.
3 Tighten the screw to hold the module

in place on the rack.
NOTE: The tightening torque is
1.5 N.m (13.3 lb-in).
S1A34009 07/2012 21
Installation
Wiring
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. The Ethernet cable shield must be connected 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 industrial Ethernet

network through any one of four RJ45 connectors located on the front of the module.
z Use the top two ports (ports 1 and 2) to connect to end devices.
z Use the bottom two ports (ports 3 and 4)—which support the RSTP redundancy
protocol—to connect to the local area networks, for example, a ring.
22 S1A34009 07/2012
Installation
Installing Unity Pro Ethernet Configuration Tool Software
Overview
Accessing Unity Pro Configuration Tool Software depends on the version of Unity
Pro that you are using:
z Unity Pro version 6.0 and higher: The module configuration software is already
included in the Unity Pro installation.
z Unity Pro version 5.0: You need to install the Unity Pro Ethernet Configuration
Tool software, which you can obtain from the following website:
http://www.global-download.schneider-
electric.com/8525773E00058BDC/all/DA00A87B8BB30386852577940058D66
C
Installing Unity Pro 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:
Step Screen Description

1 Welcome Click Next to continue.
2 ReadMe and Indicate whether to display the ReadMe file.
Release Notes Display Click Next to continue.
3 ReadMe (Optional) Displays the ReadMe file, if selected above.
Click Next to continue.
4 License Agreement Displays the software license.
Select I accept..., then click Next to continue.
5 Customer Information Enter the following data:
z your first and last names
z company name
z identify for whom the software is installed:
z anyone who uses this computer
z only for yourself

6 Destination Folder Identify where the application will be installed. Either:
z Accept the default path
z Click Change... and specify a new path

7 Ready to Install Click Next to continue.
8 Status Progress bar indicates the status of the installation.
When complete, click Next to continue.
9 Install Complete Click Finish.
S1A34009 07/2012 23
Installation
The installation process described above copies the following objects to your PC:
z the Unity Pro Ethernet Configuration Tool
z a Generic EtherNet/IP DTM
z 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 Unity Pro application.
Refer to the topic Updating the Unity Pro Hardware Catalog (see page 124) for step-
by-step instructions.
24 S1A34009 07/2012
Installation
UnInstalling the Ethernet Configuration Tool
Introduction
Use the Add or Remove Programs utility provided by the Windows™ operating
system to uninstall the Unity Pro Ethernet Configuration Tool.
To completely uninstall the Ethernet Configuration Tool, remove each of the
following three DTMs, one at a time:
Un-Installing Ethernet Configuration Tool DTMs

To remove the three Ethernet Configuration Tool DTMs:
Step Action
1 Open the Windows Control Panel: Start →Settings →Control Panel.
2 In the Control Panel, double click on Add or Remove Programs.
3 In the Add or Remove Programs window, select the
Change or Remove Programs page.
4 Select the first of the three DTMs to remove (for example, the
Generic EtherNet/IP DTM), then click Remove.
5 Repeat step 4 for each of the remaining 2 DTMs: Generic Modbus DTM and
Unity Pro Ethernet Configuration Tool.
S1A34009 07/2012 25
Installation
26 S1A34009 07/2012
Modicon M340
Configuring
S1A34009 07/2012
Configuring the Ethernet

Communication Module
2
Overview
This chapter shows you how to use Unity Pro 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 Unity Pro project may include different choices that are
appropriate for your specific configuration.

This chapter contains the following sections:
Section Topic Page
2.1 Ethernet Network Configuration Example 28
2.2 Creating a Project in Unity Pro 30
2.3 The Unity Pro FDT/DTM Interface 39
2.4 Channel Properties 59
2.5 Ethernet Services 74
2.6 Configuring the Ethernet Communication Module as an 104
EtherNet/IP Adapter
S1A34009 07/2012 27
Configuring
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:
1 Primary PLC incorporating the BMX NOC 0401 Ethernet communication module
2 A secondary PLC that “listens” to the scan of the primary PLC local slave by the third-party
scanner
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 (1)
7 PC equipped with both Unity Pro configuration software (upgraded with the Ethernet
Configuration Tool that ships with the BMX NOC 0401 Ethernet communication module)
and Advantys configuration software, used to configure communication settings for
Ethernet communication module in the primary PLC (1) and the remote network interface
modules on the STB I/O islands (4 and 5)
28 S1A34009 07/2012
Configuring
Multiple Roles of the PLC and Ethernet Communication Module

The PLC, and in particular the BMX NOC 0401 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:
z a scanner of devices that use the EtherNet/IP (4) and the Modbus TCP (5)
protocols
z an adapter—also known as a local slave—that produces output data that both the
remote third-party PLC (6) and secondary PLC (2) can read as input data
z a DHCP server that provides IP address settings to other devices on the Ethernet
network
z an FDR server that provides operational settings to devices on the Ethernet
network that also receive their IP address from the DHCP server, above
S1A34009 07/2012 29
Configuring
2.2 Creating a Project in Unity Pro
Overview
This section shows you how to add modules—including the BMX NOC 0401
Ethernet communication module—to your project, using Unity Pro.
NOTE: For detailed information about how to use Unity Pro, refer to the online help
and documentation DVD that come with Unity Pro.
What Is in This Section?

This section contains the following topics:
Topic Page
Creating a Project in Unity Pro 31
Configuring the Size and Location of Inputs and Outputs 36
30 S1A34009 07/2012
Configuring
Creating a Project in Unity Pro
Introduction
This topic shows you how to create a new Unity Pro project, and add to the new
project the following components:
z a CPU
z a power supply
z a BMX NOC 0401 Ethernet communication module
NOTE: The following example uses Unity Pro version 7.0, or higher.
Creating and Saving a New Unity Pro Project

Use Unity Pro to create a new project. The following steps describe the creation of
a project for the sample network:
Step Action
1 Open Unity Pro.
2 In the Unity Pro main menu, select File →New....
The New Project window opens displaying a list of Schneider-Electric controller
types.
3 In the New Project window, expand the Modicon M340 node to select a CPU.
In this example, select the he BMX P34 20302 Ethernet CANopen2 controller.
NOTE: By selecting the BMX P34 20302 Ethernet CANopen2 controller, you can
later select the BMX NOC 0401.2 Ethernet communication module.
S1A34009 07/2012 31
Configuring
Step Action
4 Click OK. Unity Pro displays the Project Browser, below.
5 To save the project, select File →Save. The Save As dialog opens.
6 In the Save As dialog, type in a File name—which will be the name of your Unity
Pro project—then click Save. Unity Pro saves your project to the specified path
location.
NOTE: You can change the default location Unity Pro 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:
z Import/Export file path
z XVM path
z Project settings templates path
4 Click OK close the window and save your path edits.
32 S1A34009 07/2012
Configuring
Adding a Power Supply to the New Unity Pro Project

When you added the CPU to the project, above, Unity Pro may also have added a
power supply to the project. If not, the next step is to manually add a power supply
to your Unity Pro project:
Step Action
7 In the Project Browser, double click 0 : PLC bus. Unity Pro displays both the:
z Local Bus window with the selected CPU in the second position, and
z Hardware catalog displaying the Local Bus tab, below:
8 In the Hardware catalog, under the Supply node, use your mouse to select then
drag a BMX CPS 2000 power supply to the first position in the rack.
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.
S1A34009 07/2012 33
Configuring
Adding an Ethernet Communication Module to the New Unity Pro Project

Next, add an Ethernet communication module to your project:
Step Action
10 Returning to the Hardware catalog, under the Communication node, use your
mouse to select then drag a BMX NOC 0401.2 Ethernet communication module
to an open slot in the rack—in this example, slot 2.
NOTE: You can select the BMX NOC 0401.2 only after:
z selecting the BMX P34 20302 CPU for the project, and
z upgrading the BMX NOC 0401 module firmware to version 2.0 or higher
When you drop the communication module into the rack, Unity Pro opens the
communication module Properties window.
11 In the General page of the module properties window, type in an alias name for
the communication module: NOC01:
When you change the alias name, Unity Pro 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.
12 In the File menu, select Save, to save your edits.
34 S1A34009 07/2012
Configuring
Step Action
13 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 (see page 36).
S1A34009 07/2012 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:
z the size and starting position of inputs
z 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 BMX NOC 0401 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 S1A34009 07/2012
Configuring
To input the above settings, take the following steps:
Step Action
1 In the module’s Properties window, select the Configuration page.
2 Type in the size and starting position of the inputs and outputs, as follows:
In the Inputs area:
z In the %MW index field, type in a starting address for inputs—in this
example: 1.
z 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:
z In the %MW index field, type in a starting address for outputs—in this
example: 101.
z In the Max size field, type in the maximum number of 16-bit words dedicated
to outputs—in this example: 100.
Notes:
z Locate the inputs and outputs at the beginning of a 4-byte (or 2 word) range.
Because address numbering in the M340 platform is zero-based, verify that
%MW index input and output settings are configured to start at an even
number.
z Allocate separate non-overlapping space to inputs and outputs.
z Unity Pro automatically reserves space for two arrays of 32 bytes, as follows:
z for connection health bits (see page 193), located at the beginning of the
space configured for inputs
z for connection control bits (see page 196), located at the beginning of the
space configured for outputs
z Confirm that the %MW space assigned for both inputs and outputs is
available in the CPU. For more information, refer to the Unity Pro help file
topic Processor Configuration Screen.
3 In Unity Pro 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.
S1A34009 07/2012 37
Configuring
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 119).
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 (see page 188) that display the following
information and commands for your Unity Pro project:
z connection health bits, that display the status of each connection
z connection control bits, you can use to toggle each connection on and off
z the value of input and output items
z module and device configuration settings
z free memory space that has been reserved, but not yet allocated
38 S1A34009 07/2012
Configuring
2.3 The Unity Pro FDT/DTM Interface
Overview
Unity Pro incorporates the Field Device Tool (FDT) / Device Type Manager (DTM)
approach to integrating intelligent remote devices into your process control
application. Unity Pro includes an FDT container that interfaces with the DTMs of
EtherNet/IP and Modbus TCP devices.
A DTM is a collection of properties that define an EtherNet/IP or Modbus TCP
device. Adding a device to your configuration means adding the device’s DTM to
Unity Pro’s DTM Browser. From the DTM Browser you can open the
Device Editor, which you can use to configure the parameters presented by the
DTM.
Device manufacturers may provide a DTM for each of its EtherNet/IP or Modbus
TCP devices. However, if you are using an EtherNet/IP or Modbus TCP device for
which no DTM exists, you can configure the device by:
z configuring a generic DTM provided in Unity Pro, or
z importing the device’s EDS file—Unity Pro will populate DTM parameters based
on the contents of the imported EDS file

Topic Page
DTM Browser 40
DTM Browser Menu Commands 43
Field Bus Discovery Service 49
Device Editor 53
Configuring Properties in the Device Editor 55
Uploading and Downloading DTM-Based Applications 57
S1A34009 07/2012 39
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 Unity Pro project. Each DTM node
represents an actual module or device in your Ethernet network.
Node Types
There are 3 types of DTM nodes:
z Communication DTMs:
z Any COM DTM can be plugged directly under the root node (Host PC) at the
1st level
z A COM DTM can support Gateway DTMs or Device DTMs as children if their
protocols are compatible
z Gateway DTMs:
z A Gateway DTM can support other Gateway DTMs or Device DTMs as
children if their protocols are compatible.
z Device DTMs:
z A Device DTM does not support any child DTMs
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 Description
channel 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
40 S1A34009 07/2012
Configuring
Element Description
address The bus address of the device, which can be:
z The connection point on its parent gateway network
z 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 Description
Built / Not-built 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.
Connected / A connected DTM is denoted in bold text. An unconnected DTM appears
Disconnected in plain text.
NOTE:
z Connecting a DTM to its physical device automatically connects
higher level parent nodes up to the root node.
z 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 Unity Pro to or from the PLC. DTMs can be
connected/disconnected while Unity Pro is either offline or online.
Installed / Not-
A red superimposed on a device icon indicates the DTM for that
installed
device is not installed on the PC.
S1A34009 07/2012 41
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 Description
Delete Removes the selected node (and its sub-nodes) from the DTM Browser.
Properties Opens the following dialog, which you can use to identify the name of the
missing DTM:
42 S1A34009 07/2012
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:
z universal commands, as determined by the selected node level:
z host PC node (level 1)
z communication module node (level 2)
z remote device node (level 3)
z device-specific commands, as determined by the device DTM
Host PC Node Commands

The Host PC node contextual menu includes the following commands:
Name Description
Add 1 Opens the Add dialog — containing a subset of the Hardware

Catalog, allowing the selection of a communication module DTM.
Check DTM Checks the current project for invalid DTMs or DTMs that are not
devices1 installed in the PC. If the results of the check include invalid or not-
installed 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.
DTM hardware Displays the DTM catalog tab of the Hardware Catalog dialog.
catalog
Expand all2 Displays every DTM in the project.
Collapse all2 Displays only the communication DTMs in the project.
1. This command also appears in the Unity Pro Edit menu.

2. This command also appears in the Unity Pro View menu.
S1A34009 07/2012 43
Configuring
Communication Module and Remote Device Node Commands

The DTM Browser’s contextual menu has the following items:
Name Description
Open 1 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.
Add 1 This opens the Add dialog, displaying a subset of the Hardware Catalog,
allowing the selection of a DTM.
NOTE: Unity Pro filters the content of the Add dialog, so that it displays only
DTMs that are compatible with the selected DTM selected.
Delete1 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.
Field Bus This scans the connected physical devices to create the corresponding
Discovery field bus topology. Refer to the Field Bus Discovery Service topic.
Connect1 This connects the DTM (see page 47) to its physical device on the network.
This connection does not depend on the PLC online/offline status of the
Unity Pro project application.
NOTE: Connecting a gateway or device DTM implicitly connects its parent
DTM.
Disconnect1 This disconnects the DTM (see page 47) from its physical device. This
disconnection depends on the PLC online/offline status of the Unity Pro
project application.
NOTE: Disconnecting a gateway or device DTM implicitly disconnects its
parent DTM.
Load data from This loads data from the physical device on the network to the DTM.
device1
Store data to This loads data from the DTM to the physical device on the network.
device1
Copy This command is disabled.
Paste This command is disabled.
Device menu 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
(see page 45).
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
(see page 45).
44 S1A34009 07/2012
Configuring
Name Description
Properties1 Opens the Ethernet communication module Properties window.
Print device1 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:
z for only one device DTM at a time, when that DTM is not open for editing
in the Device Editor.
z only when the DTM is disconnected from the physical device.
Zoom out2 This returns to the display of the entire DTM connectivity tree.
Expand all2 This displays DTMs below the selected DTM.
Collapse all2 This displays only the selected DTM.

Communication Module Commands

When you select Device menu in the main contextual menu for the communication
module, a sub-menu with the following commands is displayed:
Name Description
Offline Parameter This command is disabled.
Online Parameter This command is disabled.
Compare This compares 2 devices, either online or offline.
Configuration This opens the Device Editor for the selected
communication module, when the module and its DTM
are disconnected.
Observe This command is disabled.
Diagnosis This opens the Diagnosis Window for the selected
communication module, when the module and its DTM
are connected.
S1A34009 07/2012 45
Configuring
Name Description
Additional Add EDS to library Opens the EDS File Wizard, which you can use to add
functions a device EDS file to the Unity Pro EDS device library.
Unity Pro displays the contents of EDS files as DTMs for
use in the DTM Browser and Device Editor.
Remove EDS from Opens the EDS Deletion from Device Library window,
library which you can use to delete an EDS file from the device
library.
Online Action Opens the Online Action window. Depending upon the
protocol(s) a remote device supports, you can use the
Online Action window to:
z Ping a remote EtherNet/IP or Modbus TCP device
z view and write to EtherNet/IP properties in a remote
EtherNet/IP device
z view and write to port configuration properties in a
remote EtherNet/IP device
EtherNet/IP Opens the EtherNet/IP Explicit Message
Explicit Message (see page 310) window, which you can use to send
explicit messages to EtherNet/IP remote devices.
Modbus TCP Opens the Modbus TCP Explicit Message
Explicit Message (see page 312) 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
Mode topic (see page 48) for instruction on how to use
this feature.
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 Description
Configuration 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 Unity Pro EDS device library. Unity Pro displays the contents
of EDS files as DTMs for use in the DTM Browser and Device Editor.
Remove EDS from Opens the EDS Deletion from Device Library window, which you
library can use to delete an EDS file from the device library.
46 S1A34009 07/2012
Configuring
Name Description
Online Action Opens the Online Action window. Depending upon the protocol(s) a
remote device supports, you can use the Online Action window to:
z Ping a remote EtherNet/IP or Modbus TCP device
z view and write to EtherNet/IP properties in a remote EtherNet/IP
device
z view and write to port configuration properties in a remote
EtherNet/IP device
EtherNet/IP Opens the EtherNet/IP Explicit Message (see page 310) window,
Explicit Message which you can use to send explicit messages to EtherNet/IP remote
devices.
Modbus TCP Opens the Modbus TCP Explicit Message (see page 312) window,
Explicit Message which you can use to send explicit messages to Modbus TCP remote
devices.
Advanced Mode Displays or hides expert-level properties that help define Ethernet
connections. See the Enabling Advanced Mode topic (see page 48)
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... You can use the Ethernet configuration tool to...
Connected Monitor and diagnose the real-time operation of the
device or module
Disconnected Configure a communication module or remote device
by editing its properties
NOTE: Distinguish between:

z connecting and disconnecting a DTM and the associated physical device using
commands in the DTM Browser
— and —
z placing Unity Pro in online or offline operating mode using commands in the Unity
Pro 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.
S1A34009 07/2012 47
Configuring
To connect a DTM to, or disconnect a DTM from its respective module or device,
follow these steps:
Step Action
1 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:
z bold text, it is connected and only the Disconnect command is enabled.
z normal text, it is disconnected and only the Connect command is enabled.
2 Click the right-mouse button.

Result: A pop-up menu opens.
3 Select one of the following commands:
z Connect
z Disconnect
NOTE: The Connect and Disconnect commands are also available in the Unity
Pro Edit menu.
Enabling Advanced Mode

Use the contextual menu in the DTM Browser to toggle Unity Pro 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:
Step Action
1 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.
2 In the DTM Browser, right-click the communication module.
Result: A pop-up menu opens.
3 To toggle ON advanced mode, select Device Menu →Advanced Mode.
4 To toggle OFF advanced mode, repeat steps 1 through 3, above.
48 S1A34009 07/2012
Configuring
Field Bus Discovery Service
Introduction
Use the field bus discovery service to detect, and add to your Unity Pro application,
network devices that are situated on a local channel. 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.
The three available matching types are:
z Exact match:
Every identification attribute matches. The correct device type was found.
z Generic match:
At least the Vendor and device Type ID attributes match. The support level of
DTM is “Generic Support”.
z Uncertain match:
At least the Vendor and device Type ID attributes match. The support level of
DTM is not “Generic Support”.
The following procedure explains how to use the field bus discovery service:
Step Action
1 In the DTM Browser, select an appropriate DTM.
2 Right click, and in the pop-up menu and select Field bus discovery.
The Field bus discovery dialog opens:
S1A34009 07/2012 49
Configuring
Step Action
3 If necessary, select a channel and a protocol:
z if the DTM has more than one channel
z if the channel supports more than one protocol
4 Click on OK. The service starts to detect devices on the selected channel.
NOTE: The field bus discovery service limits its search to only the range of IP addresses that is pre-configured
for the selected channel in the Channel Properties page (see page 60).
5 If at least one matched device has been found, the Field Bus Discovery dialog displays a list of Scanned
Devices.
6 Use the controls of the Field Bus Discovery dialog to select the devices to add to your Unity Pro application.
7 After you have selected the devices you want to add in the Field Bus Discovery dialog, click OK.
8 If the field bus discovery process has found one or more devices with an IP address that is already in use in
the project, you will be asked if you want to continue and replace the existing project deviice(s). Click Yes and
proceed to step 9, below, or No to cancel automatic field bus discovery.
9 The device properties dialog (below) opens, displaying the default name for the first discovered device to be
added:
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.
10 Repeat step 9 for each additional discovered device.
11 After you finish adding devices to the application, configure each device for operation as part of the
application. To do this:
z disconnect the Ethernet communication module from its DTM. In the DTM Browser, select the Ethernet
communication module, then select Edit →Disconnect.
z configure the new device properties in the DTMs for both the Ethernet communication module, and the
newly added remote device.
50 S1A34009 07/2012
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 Unity Pro project (which then shows up in the Selected Devices
list:
This dialog presents three lists:
This list... Displays...

Scanned Devices The devices (matched and unmatched) found during the scan.
Matched Devices The matched DTMs found in the workstation DTM catalogue 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.
Selected Devices This list displays the device DTMs that have been selected in the
Matched Devices list, which will be added to the Unity Pro project.
S1A34009 07/2012 51
Configuring
The lists use the following colored icons:
This color... Indicates...

Green The device has been selected
Yellow The device has been matched
Red The device has not been matched
Black Information about the address of the scanned device:
z In the Scanned Devices list, the device has an address identical to one
of the DTMs in the Unity Pro project
z In the Matched Devices list, the device will be assigned an address
identical to one of the DTMs in the Unity Pro project
NOTE: An icon can consist of two colors. For example, a search can discover a device that:
z has a matching DTM, and
z has an IP address identical to a device already added to the Unity Pro application
In this case, the icon next to the discovered device would be:
z half yellow and half black, before it is selected, and
z half green and half black, after it is selected
This dialog has five buttons:
Button Use this button to...

Add All 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 Insert the device DTMs in the Selected Devices list into the Unity Pro project.
If there are one or more devices in the Selected Devices list that have he
same address in the Unity Pro project, a message box opens asking if you
want to continue.
If you click OK, devices in the Unity Pro project that have identical addresses
as the selected devices are deleted and replaced by the DTMs selected in the
Selected Devices list.
Cancel Cancel the field bus discovery scan and do nothing. Information in the three
lists is discarded.
52 S1A34009 07/2012
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:
z the node type selected in the DTM Browser:
z communication module
z remote device
z whether Unity Pro is operating in Advanced Mode
Displaying Properties of the Ethernet Communication Module

After you open the BMX NOC 0401 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).
S1A34009 07/2012 53
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.
54 S1A34009 07/2012
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 Unity Pro main
menu.
To use the Device Editor:
Step Description
1 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 47).
2 In the DTM Browser, select the Ethernet network node you want to configure, which can be either:
z an Ethernet communication module
— or —
z a remote device
3 With a node selected in the DTM Browser, do one of the following:

z In the Unity Pro main menu, select Edit →Open.
— or —
z 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:
S1A34009 07/2012 55
Configuring
Step Description
4 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.
5 While you edit a parameter, Unity Pro displays an icon — next to the field you are editing and in the
navigation tree — indicating the parameter value is being edited. Unity Pro 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.
6 After you finish editing a page, click:

z Apply to save your edits and keep the page open.
— or —
z 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.
56 S1A34009 07/2012
Configuring
Uploading and Downloading DTM-Based Applications
Introduction
You can use Unity Pro 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

Unity Pro applications that include DTM files require more memory than traditional
Unity Pro applications. The following products employ DTMs for network
configuration:
z 140 NOC 771 01 Ethernet Communication Module for Quantum
z TSX ETC 101 Ethernet Communication Module for Premium
z 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, Unity Pro 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 Unity Pro:
Step Action
1 In the main menu, select Tools →Project Settings... The Project Settings window
opens.
2 In the left pane of the Project Settings window, select General →
PLC embedded data.
S1A34009 07/2012 57
Configuring
Step Action
3 In the right pane, de-select Upload information:
4 Click OK to save your changes and close the Project Settings window.
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 Unity Pro—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:
z a version of Unity Pro that is equal to or higher than the version used to create
the application
z 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.
z 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)
z 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 Unity Pro application from a PLC.
NOTE: Confirm that each of the above DTM components is installed on the target
PC before attempting the upload.
58 S1A34009 07/2012
Configuring
2.4 Channel Properties
Overview
This section describes how to configure channel properties for the Ethernet network.

Topic Page
Channel Properties Page 60
Channel Properties - Switch Settings 62
Channel Properties - QoS Queue 64
Channel Properties — TCP/IP Page 67
Channel Properties - EtherNet/IP Page 72
S1A34009 07/2012 59
Configuring
Channel Properties Page
Description
Use the Channel Properties page to:
z select the IP address to use for:
z connecting module or device DTMs to physical devices, and
z sending explicit messages to Modbus TCP and EtherNet/IP devices
z view your PC’s IP address settings

The Channel Properties page looks like this:
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 (see page 55)
for instructions on how to edit properties.
Properties
This page presents the following properties:
Name Description
Source Address area:
Source IP Address: 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.
60 S1A34009 07/2012
Configuring
Name Description
EtherNet/IP Network Detection area:
Begin detection The starting IP address of the address range for automatic field bus
range address discovery of EtherNet/IP devices.
End detection The ending IP address of the address range for automatic field bus
range address discovery of EtherNet/IP devices.
Modbus TCP Network Detection area:
Begin detection The starting IP address of the address range for automatic field bus
range address discovery of Modbus TCP devices.
End detection The ending IP address of the address range for automatic field bus
range address discovery of Modbus TCP devices.
S1A34009 07/2012 61
Configuring
Channel Properties - Switch Settings
Description
Use the Switch tab of the Switch page to:
z enable or disable each of the four Ethernet ports on the BMX NOC 0401
communication module
z view and edit the Baud Rate for each port, which includes both the:
z transmission speed, and
z duplex mode
NOTE: The Ethernet communication module supports only the Ethernet II frame
type.
The Switch page looks like this:
To display this page, select the Channel Properties →Switch node in the
navigation tree located on the left side of the Device Editor, then click on the
Switch tab.
Properties
This page presents the following properties:
Name Description
Port (read-only) The Ethernet port number: 1...4.
Enabled The active status of the port:
z Yes = enabled
z No = disabled
62 S1A34009 07/2012
Configuring
Name Description
Baud Rate The transmission speed and duplex mode for the network. Values
include:
z Auto 10/100 Mb (default)
z 100 Mb Half
z 100 Mb Full
z 10 Mb Half
z 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.
S1A34009 07/2012 63
Configuring
Channel Properties - QoS Queue
Description
The BMX NOC 0401 Ethernet communication module can be configured to sort
packets it receives by placing them into one of 4 separate queues—based upon their
priority (very high, high, low, very low)—and handle each packet in the order of its
priority.
The module also can be configured to add a differentiated service code point
(DSCP) value to each packet it originates, indicating the relative priority of the
packet.
The process of packet queuing and DSCP tagging together enable the module to
perform Ethernet packet traffic management.
Use the QoS Queue tab of the Channel Properties →Switch page to assign
differentiated service code point (DSCP) values and queueing priorities to Ethernet
packets based on their message type.
NOTE:
z The settings input in this page are synchronized with the values input in the
Services →QoS page (see page 89). Edits to a common property in either page
will change that value in the other page.
z The Explicit Message group settings are editable only when Unity Pro is
operating in Advanced Mode.
z Confirm that every switch in your network adopts the same DSCP tagging
scheme, thereby providing consistent packet traffic management throughout your
network.
64 S1A34009 07/2012
Configuring
The QoS Queue page, displaying the default settings, looks like this:
To display this page, select the Channel Properties →Switch node in the
navigation tree located on the left side of the Device Editor, then click on the QoS
Queue tab.
S1A34009 07/2012 65
Configuring
QoS Queue Mapping Settings

DSCP settings have a range of 0...63. The range of Queue Mapping settings are
set forth below:
Group Traffic Type Available Group Queue Settings

Precision Time Control Point-to-point event z Very High
z High
Point-to-point general z High

z Low
z Very Low
IEtherNet IP Control1 Urgent z High

z Low
Scheduled
z Very Low
High
Low
Explicit2
Modbus TCP Control1 Modbus I/O z High

z Low
Modbus Explicit
z Very Low
Network Time Protocol NTP Control z Very High

z High
z Low
z Very Low
1. Edits to these properties are synchronized with the Services →QoS page (see page 89).
2. Editable only in Advanced Mode.
66 S1A34009 07/2012
Configuring
Channel Properties — TCP/IP Page
Description
Use the TCP/IP page to:
z select a Configuration mode, which specifies how the communication module
obtains its IP addressing settings, and
z edit the IP addressing settings that will be used if the Configuration mode is set
to Static
NOTE: The settings made in this page can either match or conflict with the manual
settings made using the 2 rotary switches on the back of the module. See the
Resolving Conflicting Hardware and Software IP Address Settings topic for an
explanation of when IP addressing conflicts exist and how the module resolves
them.
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.
S1A34009 07/2012 67
Configuring
Properties
The IP addressing properties you can configure in this page depends upon the
selected configuration mode:
Property Description Configuration Mode Options

Scanner IP The 32-bit identifier — consisting of both a network address and a z Static
Address host address — assigned to a device connected to a TCP/IP Internet z Flash memory
network using the Internet Protocol (IP). z BOOTP
z DHCP
Sub-Network The 32-bit value used to hide (or mask) the network portion of the IP z Static
Mask address and thereby reveal the host address of a device on a network
using the IP protocol.
Gateway The address of a device, if any, that serves as a gateway to the z Static
Address communication module.
Name The device name. z DHCP
NOTE: The default device name, based on the rotary switch settings
is BMX_0401_xxy. where:
z xx is the value of the upper switch setting (tens)
z y is the value of the lower switch setting (ones)
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 Description

Static The module uses the scanner IP address, gateway IP address, and sub-network mask
configured in this page.
Flash Memory 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.
BOOTP The module uses an IP address assigned by a BOOTP server.
DHCP1 The module uses an IP address assigned by a DHCP server.
68 S1A34009 07/2012
Configuring
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:
z 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).
z Default Sub-Network Mask
The default address is 255.0.0.0 (a class A mask).
z 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 4 ARP (address resolution
protocol) messages with a proposed IP address:
z if an answer is returned:
z another network device is already using the proposed IP address
z the module will not use the proposed IP address, but will instead use the
default IP address
z if an answer is not returned:
z 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 can cause some ARP messages to be
dropped. To help avoid this situation, Schneider Electric recommends that, when
powering up an entire network, confirm that every network switch completes its
power up cycle before powering up the PLCs.
S1A34009 07/2012 69
Configuring
Resolving Conflicting Hardware and Software IP Address Settings

The following table summarizes the status of the Ethernet channel depending on the
Configuration Mode set in the application, and the positions of the 2 rotary
switches on the back of the module:
Application: Rotary Switch Position

Configuration BOOTP STORED CLEAR IP
DHCP1
Mode
<no configuration> No Conflict: Get IP address No Conflict: Get No Conflict: Get No Conflict:
from DHCP server using IP address from IP address from: Use default
device name from rotary BOOTP server. z flash memory IP address.
switches. Start basic services — or — Start basic
Start basic services only. only. z BOOTP server services only.
— or —
z use default
IP address
Start basic services
only.
Static or Conflict: Get IP address from Conflict: Get No Conflict: Get
Flash memory DHCP server using device IP address from IP address from the
name from rotary switches. BOOTP server. application.
Start basic services only. Start basic services Start services
only. configured in the
application.
DHCP or BOOTP No Conflict: Get IP address No Conflict: Get No Conflict: Get
with no configured from DHCP server using IP address from IP address from
device name device name from rotary BOOTP server. BOOTP server.
switches. Start services Start services
Start services configured in configured in the configured in the
the application. application. application.
DHCP with a Conflict (if device name on Conflict: Get No Conflict: Get
configured switches differs from name in IP address from IP address from
device name application) or No Conflict: if BOOTP server. DHCP server using
names are equal. Start basic services device name from
Get IP address from DHCP only. application.
server using device name from Start services
rotary switches. configured in the
If conflict, start basic services application.
only; If no conflict, start
services configured in the
application.
1. Based on device name BMX_0401_xxy, where x = the top rotary switch, and y represents the bottom rotary switch.
70 S1A34009 07/2012
Configuring
Basic Services
The following services are provided by the module when it is using its default IP
address:
z FTP server (used for firmware download)
z HTTP/Web server
z Modbus/TCP server
z EtherNet/IP explicit message server
z SNMP agent
z RSTP
NOTE: Using the module as a messaging server, when the module is using its
default IP address, is not recommended. The module will replace the default IP
address with a served or user-configured IP address as soon as one is received.
S1A34009 07/2012 71
Configuring
Channel Properties - EtherNet/IP Page
Description
The EtherNet/IP page is displayed only when Unity Pro is operating in Advanced
Mode (see page 48). Advanced mode properties are identified by the icon.
Use the EtherNet/IP page to configure the following communication module

properties:
z properties that determine how the communication module, as a scanner, opens
connections for both implicit and explicit messages
z the frequency for transmitting produced data over implicit messaging connections
z the timeout period for explicit messaging connections
z the behavior of the communication module—as a scanner—when:
z the application is stopped, or
z the communication module receives a reset service request
The EtherNet/IP page looks like this:
To display this page, select the Channel Properties →EtherNet/IP node in the
navigation tree located on the left side of the Device Editor.
72 S1A34009 07/2012
Configuring
Properties
Note: Users experienced in the configuration of EtherNet/IP networks can edit the
following read-write properties.
Name Description
Timeout
FW_Open IO Connection Timing 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 The amount of time the communication module waits
for the Forward_Open IO messaging transaction to
open an explicit messaging connection.
Default = 3000 ms
EM Connected RPI 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.
EM Request Timeout 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:
z TRUE indicates the module will accept the request
and reset itself.
z 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:
z TRUE indicates that the module enters STOP state
(implicit connections are closed).
z FALSE indicates that the module enters IDLE state
(implicit connections are not closed).
Default = FALSE
S1A34009 07/2012 73
Configuring
2.5 Ethernet Services
Overview
This section describes how to enable and configure Ethernet services provided by
the BMX NOC 0401 communication module.

Topic Page
Enabling Ethernet Services 75
Configuring the DHCP and FDR Servers 77
Configuring the SNMP Agent 83
Configuring Access Control 86
Configuring QoS Ethernet Packet Tagging 89
Configuring the Rapid Spanning Tree Protocol 93
Configuring the Email Service 96
Sending Email via the SEND_EMAIL Block 99
Configuring the Network Time Service 101
74 S1A34009 07/2012
Configuring
Enabling Ethernet Services
Service List
Use the Services page to enable and disable Ethernet services provided by the
communications module.
NOTE: After you enable any service, you can configure its settings. Unity Pro
applies default settings to services 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.
After you Enable a service in this page, the next step is to configure that service.
Depending upon the specific service, it can be configured in either the Unity Pro
Device Editor (by selecting a node beneath the Services parent node) or in the
module’s web pages.
for instructions on how to edit properties in Unity Pro.
S1A34009 07/2012 75
Configuring
Service Descriptions
The Ethernet communication module can be configured to provide the following
services:
This service... Enables the module to... Configurable in...

SNMP z serve as an SNMP v1 agent (not editable)
z provide trap information to up to two devices configured as SNMP
managers.
NOTE: The SNMP service is enabled by default and cannot be
disabled.
Access Control deny access to the Ethernet communication module from unauthorized Device Editor
devices.
Address Server provide both IP addressing parameters and operating parameters to Device Editor
other Ethernet devices.
QoS Tagging add Differentiated Services Code Point (DSCP) tags to Ethernet Device Editor
packets so that network switches can prioritize the transmission and
forwarding of Ethernet packets.
NOTE: Before enabling QoS tagging, confirm that devices connected
to the Ethernet communication module support QoS tagging.
I/O Communication allow the Unity Pro application to control the enabling and disabling of Device Editor
Control individual connections between the communication module and remote
I/O devices.
NOTE:
z The application can open and close individual connections using the
control bits located at the beginning of the output area.
z If this service is disabled the user—via the application program—
cannot toggle on and off connection control bits
RSTP employ the rapid spanning tree protocol (RSTP)—in combination with Device Editor
other similarly-configured network devices—to manage redundant
physical connections and create a loop-free logical path connecting the
network devices.
Port Mirroring duplicate the traffic entering and exiting any one of the four Ethernet Web pages
ports onto another non-RSTP destination port, for the purpose of
diagnosing the source port.
IGMP Snooping restrict outbound multicast transmissions to only those ports with <no configuration
downstream consumers. required>
Network Time provide the source time synchronization signal for the PLC controller, Device Editor
Service which manages an internal clock to maintain this time.
Email enable the sending—but not receiving—of email messages from the Device Editor
PLC application to a standard SMTP server.
76 S1A34009 07/2012
Configuring
Configuring the DHCP and FDR Servers
Description
The Ethernet communication module includes both a DHCP and a Faulty 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:
z enable and disable the communication module’s FDR service
z view an automatically generated list of devices included in the communication
module’s Ethernet configuration, displaying for each device:
z IP addressing parameters, and
z whether the device’s IP addressing parameters are provided by the
communication module’s embedded DHCP server
z 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:
S1A34009 07/2012 77
Configuring
To display this page:
Step Description
1 Select the Services node in the navigation tree located on the left side
of the Device Editor. The Services page opens.
2 In the Services page, set the Address Server field to Enabled. The
Address Server node appears in the navigation tree.
3 Select the Address Server node in the navigation tree.
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.
for instructions on how to apply edited properties to networked devices.
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 can not 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.
78 S1A34009 07/2012
Configuring
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 Description
1 In the Address Server page, click the Add Device Manually button. Unity Pro adds
an empty row to the list of Manually Added Devices.
2 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:
z MAC address
z Device Name
Identifier Depending upon the identifier type, type in the client device
setting for the MAC address or Name.
Mask 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.
3 Refer to the topic Configuring Properties in the Device Editor (see page 55) for
instructions on how to apply edited properties to networked devices.
Viewing the Auto-Generated DHCP Client List

The list of Automatically Added Devices includes a row for each remote device
that is:
z part of the communication module’s Ethernet configuration, and
z 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 Unity Pro configuration.
IP Address The client device IP address.
Enable DHCP TRUE indicates that the device subscribes to the DHCP service.
Identifier Type Indicates the mechanism used by the server to recognize the client
(MAC address or DHCP device name).
S1A34009 07/2012 79
Configuring
Identifier The actual MAC address or DHCP device name.
Mask The client device subnet mask.
Gateway 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:
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.
80 S1A34009 07/2012
Configuring
Step Action
2 With NOC01 selected in the DTM Browser, click the right mouse button, and select Open in the pop-up
menu.:
The Device Editor opens.

3 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:
Unity Pro displays the properties for the selected remote device in the right pane of the window.
S1A34009 07/2012 81
Configuring
Step Action
4 In the right pane of the window, select the Address Setting tab to display the following page:
5 In the Address Server area of this page, configure the following properties:
DHCP for this device Select Enabled
Identified by The choices are:
z MAC Address, or
z Device Name
Select Device Name.

Identifier Unity Pro has automatically added the device name NIC2212_01. For the
purpose of this example, accept this default value.
Subnet Mask Unity Pro 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.
Gateway For the purpose of this example, accept the default value of 0.0.0.0.
6 Click OK to save your edits.
NOTE: Refer to the topic Configuring Properties in the Device Editor (see page 55) for more information on
editing and saving property settings in this window.
82 S1A34009 07/2012
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 authenti-
cation 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:
z authentication checking, by the Ethernet communication module, of any SNMP
manager that sends SNMP requests
z management of event, or trap, reporting by the module
The SNMP page looks like this:
S1A34009 07/2012 83
Configuring
Step Description
1 Select the Services node in the navigation tree located on the left side of the
Device Editor. The Services page opens.
2 In the Services page, set the SNMP field to Enabled, then click OK or Apply.
The SNMP node appears in the navigation tree.
3 Select the SNMP node in the navigation tree.
Viewing and Configuring SNMP Properties

NOTE: The sysName SNMP parameter is neither editable nor visible in the Unity
Pro Ethernet Configuration Tool software. By default, the sysName is set to the
Ethernet communication module part number.
When DHCP is enabled and Device Name is selected as the DHCP identifier for the
module, the SNMP sysName parameter is not set to the module part number, but is
instead the device name.
The following properties can be viewed and edited in the SNMP page:
IP Address Managers:
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 The device location (32 characters maximum)
Contact Information describing the person to contact for device
maintenance (32 characters maximum)
SNMP Manager Select either:
z TRUE: the Location and Contact information are
editable in this page
z FALSE: Location and Contact settings are not editable
in this page
Community Names:
Get Password required by the SNMP agent before executing
read commands from an SNMP manager.
Default = public.
84 S1A34009 07/2012
Configuring
Set Password required by the SNMP agent before executing
write commands from an SNMP manager.
Default = public
Trap 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 TRUE causes the SNMP agent to send a trap notification
Trap message to the SNMP manager if an unauthorized
manager sends a Get or Set command to the agent.
Default = FALSE.
S1A34009 07/2012 85
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:
z the Ethernet communication module itself, so that the module can use
EtherNet/IP explicit messaging for any of the following purposes:
z obtaining diagnostic data
z resetting the module
z changing the IP address
z any client device that may send a request to the Ethernet communication module,
in its role as either Modbus TCP or EtherNet/IP server
z your own maintenance PC, so that you can communicate with the PLC via Unity
Pro to configure and diagnose your application, and to view the module’s web
pages
z 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.
86 S1A34009 07/2012
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:
Step Description
2 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.
3 Select the Access Control node in the navigation tree.
S1A34009 07/2012 87
Configuring
Adding and Removing Devices in the Authorized Address List

To add a device to the Authorized Addresses list:
Step Description
1 In the Access Control page, click Add.
A new row appears in the Authorized Addresses list, displaying:
z a red exclamation point, indicating editing has begun, and
z a placeholder IP address of 0.0.0.0
2 Double-click the left mouse button on the placeholder IP address.

The IP address field expands and becomes editable.
3 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.
4 Repeat steps 1 through 3, above, for each additional device to which you want
to grant access to the communication module.
instructions on how to save your configuration edits.
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.
88 S1A34009 07/2012
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 (DSCP) tag to each Ethernet packet it transmits, thereby
indicating the priority of that packet.
Use the QoS page to:
z specify the source of QoS packet priority settings, and
z view or edit QoS DSCP prioritization values
The contents of the QoS page depends on the Ethernet communication module you
selected for your project: BMX NOC 0401 or BMX NOC 0401.2.
NOTE: The DSCP Value settings input in the QoS page are synchronized with the
same settings in the QoS Queue tab of the Channel Properties →Switch page.
Edits to a common property in either page will change that value in the other page.
The QoS page displays five EtherNet/IP traffic types when you are operating in
Advanced Mode (see page 48), or two EtherNet/IP traffic types when Advanced
Mode is de-selected.
To display the QoS page:
Step Description
2 In the Services page, set the QoS Tagging field to Enabled, then click OK or
Apply. The QoS node appears in the navigation tree.
3 Select the QoS node in the navigation tree.
S1A34009 07/2012 89
Configuring
The QoS Page for the BMX NOC 0401.2 Ethernet Communication Module
The following QoS page displays the default values for the BMX NOC 0401.2
module displays when operating in Advanced Mode:
90 S1A34009 07/2012
Configuring
The QoS Page for the BMX NOC 0401 Ethernet Communication Module
The following QoS page displays the default values for the BMX NOC 0401 module
displays when operating in Advanced Mode:
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 Description
Configuration 1 The communication module uses the settings input in the Type of Traffic
section of this page.
Flash1 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 244).
S1A34009 07/2012 91
Configuring
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 Default

DSCP Value for IO Data Scheduled Priority Messages (EtherNet/IP) 47
DSCP Value for Explicit Message (Modbus TCP & EtherNet/IP) 27
DSCP Value for IO Data Urgent Priority Messages (EtherNet/IP)1 55
DSCP Value for IO Data High Priority Messages (Modbus TCP & EtherNet/IP)1 43
DSCP Value for IO Data Low Priority Messages (EtherNet/IP)1 31
DSCP Value for Network Time Protocol Messages 59

1. Visible only when Advanced Mode (see page 48) is enabled.
To effectively implement QoS settings in your Ethernet network:

z use network switches that support QoS
z consistently apply DSCP values to network devices and switches that support
DSCP
z verify 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 in the Device Editor by selecting a device connection
node, then opening the connection’s General page.
92 S1A34009 07/2012
Configuring
Configuring the Rapid Spanning Tree Protocol
Description
Ethernet ports 3 and 4, located on the front of the BMX NOC 0401 communication
module, support the Rapid Spanning Tree Protocol (RSTP). RSTP is an OSI layer
2 protocol defined by IEEE 802.1D 2004. RSTP performs two necessary services:
z it creates a loop-free logical network path for Ethernet devices that are part of a
topology that includes redundant physical paths
z it automatically restores network communication—by activating redundant
links—in the event the network experiences a loss of service
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.
Use the RSTP →General and the RSTP →Advanced pages to configure RSTP
for the embedded Ethernet switch in the communication module.
NOTE: RSTP can be implemented only when every network switch is configured to
support RSTP.
The RSTP →General page looks like this:
S1A34009 07/2012 93
Configuring
The RSTP →Advanced page looks like this:
To display these pages:
Step Description
1 Select the Services node in the navigation tree located on the left side of the Device Editor. The
Services page opens.
2 In the Services page, set the RSTP field to Enabled, then click OK or Apply. The RSTP node appears
in the navigation tree.
3 Select the RSTP node in the navigation tree, then click on either the General or Advanced tab to display
that page.
94 S1A34009 07/2012
Configuring
Configuring RSTP Properties

The following properties can be viewed and edited in the RSTP →General page:
RSTP Operation State: A 2-byte value for the switch, from 0 to 65535, with a
Bridge Priority default of 32768 (the midpoint).
NOTE: Network switches running RSTP software
periodically exchange information about themselves using
special packets called Bridge Protocol Data Units
(BPDUs), which act as a heartbeat. The Bridge Priority
value is contained in the BPDU and establishes the
relative position of the switch in the RSTP hierarchy.
The following properties can be viewed and edited in the RSTP →Advanced page:
Bridge Parameters:
Maximum Age Time This value is set to The length of time, from 6 to 40 seconds, that the switch waits
for receipt of the next hello message, before initiating a change to the RSTP
topology. Default = 40 s.
Transmit Hold Count The maximum number of BPDUs, from 1 to 40, that the switch can transmit per
second. Default = 40.
Hello Time (read-only) The frequency—set at 2 seconds—that the embedded switch sends
heartbeat BPDUs.
Port Parameters (These properties can be separately configured for ports 3 and 4):
RSTP (read-only) This property is set to Enabled in the Services page.
Priority The priority assigned to the switch port, an integer from 0 to 240 in increments of
16. Default = 0. This value is used by the RSTP process if it needs to break a tie
between two ports on the same switch when identifying a:
z root port: the port on a non-root switch that is closest to the root bridge in terms
of path cost, or
z designated port: the port at one end of a network segment through which traffic
passes on its way to the root bridge
RSTP Cost The method used to determine the RSTP cost of the path through the embedded
switch. Values include:
z Auto—the RSTP protocol will automatically assign a value to the switch by
operation of the RSTP algorithm
z Manual—you input the RSTP cost—an integer from 1 to 200000000—in the
Value field.
Edge Port (read-only) Set to a fixed value of Auto. The RSTP process automatically
determines if the port is an RSTP edge port.
Point to Point (read-only) Set to a fixed value of Auto. The RSTP process automatically
determines if the port is an RSTP point-to-point port.
S1A34009 07/2012 95
Configuring
Configuring the Email Service
Using the Email Service

Use the Simple Mail Transfer Protocol (SMTP) service to configure up to three (3)
Email messages. The PLC uses the Email messages you configure to notify
specified Email recipients about meaningful run-time events—for example, a
change in the value of a variable, or a threshold overrun.
NOTE: The Email service is available only when you first perform the following
tasks:
z upgrade the firmware in the BMX NOC 0401 Ethernet communication module to
version 2.01 or higher
z select the BMX NOC 0401.2 Ethernet communication module for your project
using Unity Pro version 7.0 or higher
Email messages are transmitted by the execution of a SEND_EMAIL
(see page 99) function block included in your application logic.
NOTE: To successfully send an Email message using the SEND_EMAIL block, the
Email service and PLC application must be synchronized—i.e., the Email service
must be activated whenever the PLC is in RUN mode.
You can configure the Email service only in the Email Configuration page of Unity
Pro. You can diagnose the operation of the Email service in the diagnostic pages of
both the Unity Pro software (see page 318) and the communication module web
pages (see page 381).
96 S1A34009 07/2012
Configuring
Configuring Email Service Parameters

Use the following page to configure up to three Email messages:
Step Description
2 In the Services page, set the Email field to Enabled. The Email node appears
in the navigation tree.
3 Select the Email node in the navigation tree.
S1A34009 07/2012 97
Configuring
Viewing and Configuring Email Settings

The configurable Email service parameters include the following:
Parameter Description
SMTP Server Configuration:
SMTP Server IP Address: The IP address of the Email server that will relay Email
messages.
SMTP Server Port: TCP port used by the Email server. Default = 25.
Password Authentication:
Authentication: Is client authentication by the Email server:
z Disabled (default)
z Enabled
Login: If the Email server is configured for client authentication, the user
name, up to 64 characters.
Password: If the Email server is configured for client authentication, the
client password string, up to 64 characters.
Email Header 1...3:
From: The Email address of the sender, up to 64 characters.
To: The Email addresses of the recipients, up to 128 characters.
Subject: The static part of the Email message, up to 32 characters.
98 S1A34009 07/2012
Configuring
Sending Email via the SEND_EMAIL Block
Using SEND_EMAIL to Send Pre-configured Email Messages

Use the SEND_EMAIL block in your application to programmatically send any of
three email messages you previously configured in Unity Pro (see page 96).
NOTE: To successfully send an Email message using the SEND_EMAIL block,
synchronize the Email client service and PLC application—i.e., activate the Email
client service whenever the PLC is in RUN mode.
FBD Representation
Input Parameters
The following table describes the input parameters:
Parameters Data Type Description

ADR ARRAY [0...7] OF INT The path to the destination device, in the format of
rack.slot.channel.
Use the EFB ADDR to convert from the string format
to the array of INT. For example, if the module is
configured at rack 0, slot 4, channel 0, use:
ADDR(‘0.4.0’).
HEAD_KEY INT The email header number previously configured in
Unity Pro (see page 96). Only values of 1, 2, and 3
are valid).
SUBJ_STR STRING The dynamic part of the email subject that is
appended to the static subject string.
BODY_STR STRING The body of the email.
NOTE: Use the $N (or $n) two-character tag to
insert a line break in the email text.
S1A34009 07/2012 99
Configuring
Input / Output Parameters

The following table describes the GEST management parameter, which is the only
input/output parameter:
Parameters Data Type Description

GEST ARRAY [0...3] OF INT The management parameter, consisting of 4 words.
The GEST management parameter presents the following structure:
Description Word Order MSB LSB

System-managed 1 Exchange number Activity bit—the first bit of the first
data word. It indicates the execution
status of the communication:
z 1 = Email is being sent
z 0 = Email complete
2 Operation report Communication report

(see page 412) (see page 411)
User-managed 3 Timeout
data
4 Length: the size of the data buffer.
NOTE: The length parameter is an output parameter.
This word is written by the system and equals the total
length of the email (header + body). The maximum size
of header + body is 1024 characters.
100 S1A34009 07/2012

Configuring
Configuring the Network Time Service
The Network Time Protocol Client

The Ethernet communication module includes a network time protocol (NTP) client.
After you enable the network time service (see page 75), you can configure it by:
z identifying two external NTP servers—a primary server, and a secondary
server—the Ethernet communication module uses to synchronize its internal time
setting
z specifying the time zone location of the module
z enabling the automatic adjustment of the module internal time setting for daylight
saving time changes
The Ethernet communication module sends its internal time setting to the PLC
controller over the shared backplane. The PLC manages an internal clock to
maintain this time, and uses the time setting to time-stamp system events and I/O
data.
NOTE: The network time service is available only when you first perform the
following tasks:
z upgrade the firmware in the BMX NOC 0401 Ethernet communication module to
version 2.01 or higher
z select the BMX NOC 0401.2 Ethernet communication module for your project
using Unity Pro version 7.0 or higher
Operation of the network time service can be monitored and diagnosed in:
z the Network Time Service Diagnostics page of the Unity Pro software
(see page 330), and
z the Network Time Service web page (see page 402)
S1A34009 07/2012 101

Configuring
You can configure the network time only in the following page:
Step Description
2 In the Services page, set the Network Time Service field to Enabled. The
Network Time Service node appears in the navigation tree.
3 Select the Network Time Service node in the navigation tree.
Viewing and Configuring Network Time Service Settings

The following settings can be viewed and edited in this page:
NTP Server Configuration:
Primary NTP Server The IP address of the NTP server, from which the Ethernet
IP Address communication module first requests a time setting.
Secondary NTP Server The IP address of the back-up NTP server, from which the
IP Address Ethernet communication module requests a time setting, after
not receiving a response from the primary NTP server.
Polling Period The frequency (1...120 seconds) the Ethernet communication
module uses for requesting a time setting from the NTP server.
Default = 18 seconds.
102 S1A34009 07/2012

Configuring
Time Zone:
Time Zone Setting The time zone associated with the Ethernet communication
module, selected from a list that includes time zones around the
globe. Default = Greenwich Mean Time (GMT) + 0 minutes.
Timezone Offset The number of minutes (–1439...+1439) used to adjust the Time
Zone Setting. Default = 0 minutes.
Daylight Saving:
Automatically adjust z Enabled: turns ON the automatic clock adjustment for daylight
clock for daylight saving savings.
z Disabled: turns OFF the automatic clock adjustment for
daylight savings.
Default = Disabled.
If automatic adjustment of the clock for daylight savings is
enabled, use the next two fields to configure daylight saving
adjustments.
Start Daylight Saving Month Select the month daylight savings begins.
Default = March.
Day of Week Select the day of the week daylight savings
begins. Default = Sunday.
Week# Select the week of the month daylight
savings begins. Default = 1 (fist week of the
month).
End Daylight Saving Month Select the month daylight savings ends.
Default = November.
Day of Week Select the day of the week daylight savings
ends. Default = Sunday.
Week# Select the week of the month daylight
savings ends. Default = 1 (fist week of the
month).
S1A34009 07/2012 103

Configuring
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:
z implicit messaging requests from a scanner device in the network, and
z explicit messaging requests—directed to the communication module’s assembly
object (see page 237)—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 233) other than
the assembly object.

Topic Page
Introducing the Local Slave 105
Configuring a Local Slave 107
Local Slave Inputs and Outputs 112
104 S1A34009 07/2012

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 237). The
local slave function is especially beneficial for peer to peer data exchanges at a
repetitive rate.
NOTE:
z The Ethernet communication module can provide three local slave adapter
instances, while simultaneously performing as a scanner. These roles are not
mutually exclusive.
z The local slave is exclusively an EtherNet/IP functionality
In this example, the local slave instance is part of the following topology:
S1A34009 07/2012 105

Configuring
The sample configuration, above, includes the following devices:

z A primary PLC (1) incorporating the BMX NOC 0401 Ethernet communication
module with one local slave instance enabled. The PLC scans I/O data from
remote devices (4 and 5)
z A secondary PLC (2) that “listens” to the scan of the primary PLC’s local slave by
the third-party PLC (6)
z A managed Ethernet switch (3)
z An Advantys STB island (4), with an STB NIC 2212 EtherNet/IP network interface
module plus 8 I/O modules
z An Advantys STB island (5), with an STB NIP 2212 Modbus TCP network
interface module plus 8 I/O modules
z A third party scanner (6)—which lacks adapter capability, and therefore cannot
itself be scanned by the primary PLC (1)—that:
z collects data from other sources (not part of this network)
z writes data to inputs of the primary PLC’s local slave
z scans the primary PLC’s local slave’s output data via an exclusive owner
connection
z A PC running the following software:
z Unity Pro
z the Unity Pro Configuration Tool
z Advantys Configuration Software
NOTE:
z Because the third party scanner (6) and the secondary scanner (2) are both
receiving the same data produced by the local slave, configure the requested
packet interval (RPI) setting of the third party scanner’s exclusive owner
connection and the secondary scanner’s listen only connection to the same
setting.
z By enabling a local slave on the primary PLC (1):
z 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.
z the secondary PLC (2) 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 Unity Pro software installed in the PC
(7, above) to configure a local slave, and to create input and output items in support
of the peer-to-peer data transfers between and among scanners.
106 S1A34009 07/2012

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:
z enabling and naming the local slave
z specifying the size of local slave input and output assemblies
z 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.
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, the application in the third-party PLC produces
data, which is available in the PLC’s Ethernet communication module as inputs. In
this example, the third-party device produces the following information:
z production totals for manufacturing line A
z production totals for manufacturing line B
z the number of production interruption events for line A
z 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: With these third-party PLC items:
Outputs (T to O)—assembly instance 101 Inputs—assembly instance 101
Inputs (O to T)—assembly instance 102 Outputs—assembly instance 102
S1A34009 07/2012 107

Configuring
The configured Local Slave page looks like this:
108 S1A34009 07/2012

Configuring
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 Description
Number The unique number—or identifier—assigned to the
device. By default, Unity Pro assigns:
z 000 = local slave 1
In this example, accept the default 000.

Active Configuration z Enabled activates the local slave.
z Disabled de-activates the local slave, but retains the
current local slave settings.
In this example, select Enabled.
Comment An optional free text comment field up to 80 characters
maximum.
In this example, leave blank.
Connection bit Auto-generated integer (0...127) indicating the offset of
the connection’s:
z health bit, located in the module’s input area
z 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 Unity Pro as follows:
Assembly number Local slave number Used for connection

101 1 T->O 1
102 1 O->T Exclusive Owner
103 1 Configuration
199 1 O->T Listen Only
111 2 T->O
113 2 Configuration
1. In this table:
z O indicates the originator—or scanner—device
z T indicates the target—or adapter—device
S1A34009 07/2012 109

Configuring
Assembly number Local slave number Used for connection

121 3 T->O
123 3 Configuration
1. In this table:
z O indicates the originator—or scanner—device
z T indicates the target—or adapter—device
The Local Slave assembly settings include:.
Setting Description
Outputs (T->O) A read-only value (see table, above).
In this example, 101.
Outputs (T->O) Size 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.
Inputs (O->T) A read-only value (see table, above).
Inputs (O->T) Size 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.
Configuration A read-only value (see table, above).
Configuration Size 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 Unity Pro creates for your application has both a non-
editable structure name (used by Unity Pro 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:
z view and edit local slave input and output variable names
z view non-editable local slave structure names
110 S1A34009 07/2012

Configuring
The following property settings have been made in this example:
Setting Description
Input:
Structure Name The read-only name for input structures. By default, it is the
concatenation of:
z the prefix T_
z the alias device name—in this case NOC01
z the device number—in this case 01
z the suffix _IN
In this case, the default would be T_NOC01_01_IN.

Variable Name The editable base name for input variables. By default, it is the
concatenation of:
z the suffix _IN
In this case, the default would be NOC01_01_IN.

For this example, accept the default variable name.
Output:
Structure Name The read-only name for output structures. By default, it is the
concatenation of:
z the prefix T_
z the suffix _OUT
In this case, the default would be T_NOC01_01_OUT.

Variable Name The editable base name for output variables. By default, it is the
concatenation of:
z 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.
S1A34009 07/2012 111

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:
z 4 input word items
z 1 output word item
NOTE: The items created, below, are designed to hold data received from, or sent
to, the third-party 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.
112 S1A34009 07/2012

Configuring
Creating Input Word Items

To create input items for local slave 01:
Step Action
1 Select the Input tab to open that page:
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.
2 In the Default Item Name Root input box type: ProductionTotal_LineA.
3 Starting at the beginning of the table, select the first two rows: 0 and 1:
S1A34009 07/2012 113

Configuring
Step Action
4 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:
6 Click Apply to save the new items, and leave the page open.
7 Repeat steps 2 - 6 for each new word item you need to create. In this example,
that includes the following items:
z Rows 2-3, Default Items Name Root: ProductionTotal_LineB
z Rows 4-5: Default Items Name Root: Events_LineA
z Rows 6-7: Default Items Name Root: Events_LineB
8 Create output words.
114 S1A34009 07/2012

Configuring
Creating Output Word Items

To create output items for local slave 01:
Step Action
1 Click the Output tab to open the following page:
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.
2 In the Default Item Name Root input box type: DataReceived.
3 Starting at the beginning of the table, select the first 2 rows, 0 and 1:
S1A34009 07/2012 115

Configuring
Step Action
4 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:
6 Click OK to close the Items window.

7 Select File →Save to save your edits.
116 S1A34009 07/2012

Configuring
Using Local Slave Inputs and Outputs

The inputs and outputs created, above, are used as follows:
z The third-party device updates values of the following variables:
z ProductionTotal_LineA
z ProductionTotal_LineB
z Events_LineA
z Events_LineB
z The Ethernet communication module updates value of the DataReceived

variable in the third-party device at the configured RPI.
S1A34009 07/2012 117

Configuring
118 S1A34009 07/2012

Modicon M340
Adding Devices to an Ethernet Network
S1A34009 07/2012
Adding Devices to an Ethernet

Network
3
Overview
This chapter presents examples of how to add devices to, and how to configure
these device for operations on, your Ethernet network.

Section Topic Page
3.1 Hardware Catalog 120
3.2 Adding an EtherNet/IP Device to the Network 128
3.3 Adding a Modbus TCP Device to the Network 162
S1A34009 07/2012 119

3.1 Hardware Catalog
Overview
Unity Pro includes a collection of modules and devices—called the
Hardware Catalog—that you can add to a Unity Pro 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. Unity Pro displays each EDS file in the
form of a DTM. In this way, you can use Unity Pro 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:
z how to add a DTM to the catalog
z how to add an EDS file to the catalog
z how to update the catalog
z how to remove an EDS file from the catalog

Topic Page
Adding a DTM to the Unity Pro Hardware Catalog 121
Add an EDS File to the Unity Pro Hardware Catalog 122
Updating the Unity Pro Hardware Catalog 124
Remove an EDS File from the Unity Pro Hardware Catalog 126
120 S1A34009 07/2012

Adding a DTM to the Unity Pro Hardware Catalog
A Manufacturer Defined Process

Before a you can add a DTM to the Unity Pro Hardware Catalog, install it on the
host PC—the same PC that is running Unity Pro—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 BMX NOC 0401 Ethernet communication
module, refer to the topic Installing Unity Pro Ethernet Configuration Tool Software
(see page 23).
NOTE: After you successfully install a device DTM on your PC, update the Unity Pro
Hardware Catalog (see page 124) so the new DTM is visible in the catalog and
available to be added to a Unity Pro project.
S1A34009 07/2012 121

Add an EDS File to the Unity Pro Hardware Catalog
Overview
Unity Pro includes a wizard you can use to add one or more EDS files to the Unity
Pro Hardware Catalog. The wizard presents a series of instruction screens that:
z simplify the process of adding EDS files to the catalog, and
z provide a redundancy check in case you attempt to add duplicate EDS files to the
catalog
NOTE: The Unity Pro 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 Unity Pro 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.
4 Click Next.
Page 2 of the wizard opens:
122 S1A34009 07/2012

Step Action
5 In the Select the Location of the EDS File(s) section, select either:
z Add File(s), to add one or more EDS files you will individually select, or
z Add all the EDS from the Directory, to add all files from a folder you will select.
z 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:
z one or more EDS files, or
z 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.
9 Click Next.
The wizard compares the selected EDS files against existing files in the library.
10 (Conditional) If one or more selected EDS files is a duplicate, a File Already Exists message opens.
Close the message.
11 Page 3 of the wizard opens indicating the Status of each device you attempted to add:
z a green check mark indicates the EDS file can be added
z a blue informational icon indicates a redundant file
z a red exclamation point indicates an invalid EDS file

(Optional) Select a file in the list, then click View Selected File to open it.
12 Click Next to add the non-duplicate files.
Page 4 of the wizard opens, indicating the action is complete.
13 Click Finish to close the wizard.
14 The next step is to update the Unity Pro Hardware Catalog (see page 124), so that the newly added device
is available for inclusion in a Unity Pro project.
S1A34009 07/2012 123

Updating the Unity Pro 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 Unity Pro Hardware Catalog.
Updating the Hardware Catalog makes the new Ethernet module or device
available for addition to your Unity Pro application.
To update the Hardware Catalog:
Step Action
1 In the Unity Pro 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 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.
124 S1A34009 07/2012

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.
S1A34009 07/2012 125

Remove an EDS File from the Unity Pro Hardware Catalog
Overview
You can remove a module or device from the list of available devices in the Unity
Pro 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 Unity Pro 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
(see page 122) at a future time.
Removing an EDS File from the Catalog

To remove an EDS file from the catalog:
Step Action
1 If the DTM Browser is not already open, in the Unity Pro 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 →Remove EDS from library.
The following window opens:
126 S1A34009 07/2012

Step Action
4 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:
z All EDS (no filtering)
z Only Devices
z Only Chassis
z Only Modules
Sort by Sorts the list of displayed EDS files; select:

z File Name
z Manufacturer
z Category
z Device Name
Displayed Name The description displayed for each device; select:
z Catalog Name
z Product Name
5 In the Device Library tree control, navigate to and select the EDS file you want to
remove.
6 (Optional) Click the View Selected File button to display the read-only contents of
the selected EDS file.
7 Click the Delete Selected File button. A message box opens.
8 Click Yes to remove the selected EDS file from the list.
9 When you have finished removing EDS files, click Close.
10 The next step is to update the Hardware Catalog (see page 124).
S1A34009 07/2012 127

3.2 Adding an EtherNet/IP Device to the Network
Overview
This section extends the sample Unity Pro application, by describing how to:
z add an STB NIC 2212 EtherNet/IP network interface module to your Unity Pro
application
z configure the STB NIC 2212 module
z configure EtherNet/IP connections linking the BMX NOC 0401 communication
module and the STB NIC 2212 network interface module
z configure I/O items for the Advantys Island
NOTE: The instructions in this chapter describe a single, specific device

configuration example. Refer to the Unity Pro help files for additional information
about alternative configuration choices.

Topic Page
Setting Up Your Network 129
Adding an STB NIC 2212 Remote Device 131
Configuring STB NIC 2212 Properties 133
Configuring EtherNet/IP Connections 139
Connecting to the Advantys STB Island 145
Configuring I/O Items 149
128 S1A34009 07/2012

Setting Up Your Network
Overview
This sample network includes the following hardware and software:
z a controller rack with:
z BMX CPS 2000, 100/240 VAC power supply
z BMX P34 20302 controller
z BMX NOC 0401.2 Ethernet communication module
z a remote STB Advantys island with:

z STB NIC 2212 EtherNet/IP network interface module
z STB PDT 3100 power distribution module
z STB DDI 3230 2 pt digital input module
z STB DDO 3200 2 pt digital output module
z STB AVI 1270 2 pt analog input module
z STB AVO 1250 2 pt analog output module
z a PC running both Unity Pro (version 5.0 or higher) and Advantys configuration
software (version 5.0 or higher)
z an Ethernet managed switch that is connected to the both the controller and
island by means of twisted pair Ethernet cable and RJ45 connectors.
S1A34009 07/2012 129

Network Topology
The Ethernet network devices used in this configuration include the following:
To re-create this example:

z use the IP addresses for your own configuration’s:
z PC
z STB NIC 2212 network interface module
z check wiring
NOTE: Unity Pro software running in the PC is used to configure the
BMX P34 20302 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.
130 S1A34009 07/2012

Adding an STB NIC 2212 Remote Device
Overview
You can use the Unity Pro 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
Unity Pro device library can be added to your project. Refer to the topic describing
the Add EDS File Wizard (see page 122) 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 Action
1 In the Unity Pro main menu, select Tools →Hardware Catalog to display that
window.
2 In the Hardware Catalog window, click on the DTM Catalog tab to open that
page.
2 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 Action
1 In the DTM Browser, select the Ethernet communication module node, and then click the right mouse
button. A pop-up menu opens.
S1A34009 07/2012 131

Step Action
2 In the pop-up menu, select Add... The following dialog opens:
3 In the Add dialog, select the STBNIC2212, then click Add DTM. The Properties window for the
STB NIC 2212 network interface module opens.
4 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:
When you edit the Alias name, Unity Pro 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.
5 Click OK. Unity Pro adds the new STB NIC 2212 network interface module to the DTM Browser, beneath
the communication module.
6 Refer to the topic Configuring Properties in the Device Editor (see page 55) for instructions on how to save
your configuration edits.
The next step is to configure the device you have just added to the project.
132 S1A34009 07/2012

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 47).
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:
z Properties
z Address Setting
S1A34009 07/2012 133

Configuring the Properties Page

The Properties page for an STB NIC 2212 network interface module looks like this:
The following settings are used in this sample configuration. Use settings that are
appropriate for your actual application:
Step Action
1 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 z Enabled: adds this device to the Unity Pro project
configuration
z Disabled: removes this device from the Unity Pro
project configuration
Accept the default setting of Enabled.
134 S1A34009 07/2012

Step Action
2 In the IO Structure Name section of the page, edit the following:
Input area:
Structure Name (Read-only) Unity Pro 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 131)): NIC2212_01_IN.
Output area:
Structure Name (Read-only) Unity Pro automatically assigns a structure
name based on the variable name, in this case
T_NIC2212_01_OUT.
Variable Name 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.
S1A34009 07/2012 135

Step Action
3 In the Items Management section of the page, edit the following:
Import mode z 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 auto-
created items cannot be edited in the Device Editor.
z 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:
z Because the STB NIC 2212 DTM does not contain pre-
configured input and output items, select Manual.
z To view I/O items, navigate to and select the Items
node in the left pane of the Device Editor, as follows:
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.
4 Click Apply to save your edits, and leave the window open for further edits.
136 S1A34009 07/2012

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:
S1A34009 07/2012 137

Step Action
1 In the Address Settings page, edit the following:
IP Address By default:
z the first three octet values equal the first three octet
values of the Ethernet communication module, and
z 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 z 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
(see page 79).
z Disabled (the default) de-activates the DHCP client in
this device.
Select Enabled.
Identified by If DHCP for this Device is Enabled, this indicates the
device identifier type:
z MAC Address, or
z Device Name
Select Device Name.

Identifier 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).
Mask 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.
2 Click OK to save your edits.
The next step is to configure the connection between the communication module
and the remote device.
138 S1A34009 07/2012

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 BMX NOC 0401 communication
module and a remote STB NIC 2212 network interface module. Configuration edits
are made to the DTMs for each device.
When making DTM edits, disconnect the selected DTM from the actual module or
device (see page 47).
Configuring Connection Settings in the Communication Module DTM

Unity Pro automatically creates a connection between a communication module and
remote device, when the remote device is added to the Unity Pro 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 Action
1 Open the DTM for the communications module—in this example NOC01—by
selecting it in the Device Editor, then do one of the following:
z in the main menu, select Edit →Open, or
z click the right mouse button, and select Open in the pop-up menu
The communication module DTM opens in the Device Editor.

2 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
S1A34009 07/2012 139

Step Action
3 Click on the Connection Settings tab to open the following page:
NOTE: To view the Time-out Multiplier parameter, confirm that Unity Pro is
operating in Advanced Mode.
4 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
Unity Pro 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 The refresh period for this connection, from 2 to 65535 ms.
Interval (RPI) 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.
5 Click OK to save your settings.
140 S1A34009 07/2012

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
Unity Pro automatically created, when the remote device was added to the project.
Use settings that are appropriate for your actual application:
Step Action
1 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:
z click the right mouse button, and select Open in the pop-up menu
The remote device DTM opens in the Device Editor.

2 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.
b Click the Add Connection button. The Select the connection to add dialog opens.
c Use the scroll buttons on the drop down list to display and select the Read Input / Write
Output Data connection type.
d 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.
S1A34009 07/2012 141

Step Action
3 With the Read Input / Write Output Data node selected, click on the General tab:
142 S1A34009 07/2012

Step Action
4 In the General page, edit the following settings:
RPI 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.)
Input size The number of bytes reserved for input data, from 0 to 505. Type in 19.
NOTE: Unity Pro reserves input data in increments of 4 bytes (2 words). In this example,
typing in the value of 19 bytes reserve 20 bytes of input memory.
Input mode The transmission type:
z Multicast
z Point to Point
Accept the default selection of Multicast.

Input type 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:
z Low
z High
z 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.
For the purpose of this example, accept the default selection of Scheduled.
Input trigger The transmission trigger. Values can include:
z Cyclic
z 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: Unity Pro reserves output data in increments of 4 bytes (2 words). In this example,
typing in the value of 6 bytes reserves 8 bytes of output memory.
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.
S1A34009 07/2012 143

Step Action
5 Click on the Identity Check tab to open the following page:
6 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 Unity Pro will use in comparing the configured versus the actual remote
device. Settings include:
z Must match exactly—the DTM or EDS file exactly matches the remote device
z Disable—no checking occurs; the identity portion of the connection is filled with zero
values (the default setting)
z Must be compatible—if the remote device is not the same as defined by the DTM/EDS,
it emulates the DTM/EDS definitions
z None—no checking occurs; the identity portion of the connection is omitted
z 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 z True—for each of the following selected tests, the DTM/EDS and remote device need
Mode only be compatible
z False—for each of the following selected tests, the DTM/EDS and remote device need
to match exactly
Minor Version For each of the parameters to the left, select one of the following settings:
z Compatible—include the parameter in the test
Major Version
z Not checked—the parameter is not included in the test
Product Code
Product Type
Product
Vendor
7 Click OK to save your settings.
The next step is to configure I/O settings.
144 S1A34009 07/2012

Connecting to the Advantys STB Island
Overview
In this example, you will use the Advantys configuration software running on your
PC to:
z connect the Advantys configuration software to the STB NIC 2212 and the 8 I/O
modules that comprise the Advantys STB island
z upload Advantys STB island configuration to the Advantys configuration software
in your PC
z display a fieldbus image for the Advantys STB island showing the relative location
of:
z status information
z input data
z output data
Using the data presented in the fieldbus image, you can use Unity Pro 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).
S1A34009 07/2012 145

Step Action
4 For this example, type in the following field values:
z for the field Workspace File type in Advantys
z for the field Island File type in Advantys_01
5 Click OK. The Advantys configuration software displays an empty DIN rail in the
center of the screen.
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.
146 S1A34009 07/2012

Step Action
10 Select Online →Connect. The Data Transfer dialog opens (below):
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):
Note: A box appears beneath each module containing one or two integers—for
example . These integers serve the following purpose:
z The left-side integer (3 in this example) identifies the module’s physical position—
left to right—among the modules in the rack.
z 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.
S1A34009 07/2012 147

Step Action
12 Select Island →I/O Image Overview. The I/O Image window opens to the Fieldbus
Image page:
Each table cell contains one of the following alpha-numeric indicators:

z S indicates a status bit for the STB NIC 2212 network interface module
z 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:
z 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
z 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.
148 S1A34009 07/2012

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:
z use the Advantys configuration software to identify the relative position of each
I/O module’s inputs and outputs
z use the Unity Pro Device Editor to create input and output items, defining each
item’s:
z name
z 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. In this example, items need to
be created for:
z 19 bytes of inputs
z 6 bytes of outputs
The Unity Pro 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, 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.
In the sample project, the following items were created:
z discrete bits for digital inputs and outputs
z 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:
Step Action
1 In the Advantys configuration software, select Island →I/O Image Overview. The
I/O Image window opens to the Fieldbus Image page.
2 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.
3 Make a note of the word, bit(s), module and item information for that cell.
4 Repeat steps 2 and 3 for each cell containing either an S or an integer.
S1A34009 07/2012 149

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 Unity Pro
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, as
follows:
z WORD items: align these items on a 16-bit boundary
z DWORD items: align these items on a 32-bit boundary.
This process yields the following tables of input and output data:
Input Data:
Advantys Fieldbus Image Unity Pro EIP Items STB Module Description
Word Bit(s) Byte Bit(s)
1 0-15 0 0-7 NIC 2212 low byte status
1 0-7 high byte status
2 0-1 2 0-1 DDI 3230 input data
2-3 2-3 DDI 3230 input status
4-5 4-5 DDO 3200 output data echo
6-7 6-7 DDO 3200 output status
8-11 3 0-3 DDI 3420 input data
12-15 4-7 DDI 3420 input status
3 0-3 4 0-3 DDO 3410 output data echo
4-7 4-7 DDO 3410 output status
8-13 5 0-5 DDI 3610 input data
14-15 6-7 NA not used
4 0-5 6 0-5 DDI 3610 input status
6-7 6-7 NA not used
8-13 7 0-5 DDO 3600 output data echo
5 0-5 8 0-5 DDO 3600 output status
6-15 8 6-7 NA not used
9 0-7
6 0-15 10 0-7 AVI 1270 input data ch 1
11 0-7
7 0-7 12 0-7 AVI 1270 input status ch 1
8-15 13 0-7 NA not used
150 S1A34009 07/2012

Advantys Fieldbus Image Unity Pro EIP Items STB Module Description
8 0-15 14 0-7 AVI 1270 input data ch 2
15 0-7
8-15 17 0-7 AVO 1250 output status ch 1
10 0-7 18 0-7 AVO 1250 output status ch 2
8-15 NA NA NA not used
Output Data:
Advantys Fieldbus Image Unity Pro EIP Items Module Description

1 0-1 0 0-1 DDO 3200 output data
2-5 2-5 DDO 3410 output data
6-7 6-7 NA not used
8-13 1 0-5 DDO 3600 output data
2 0-15 2 0-7 AVO 1250 output data ch 1
3 0-7
5 0-7
This example shows you how to create 19 bytes of inputs and 6 bytes of outputs. To
more efficiently use space, this example creates items in the following sequence:
z input bit items
z input byte and word items
z output bit items
z output byte and word items
S1A34009 07/2012 151

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 Action
1 In the DTM Browser, select the communication module:
2 Do one of the following:

z click the right mouse button, then select Open in the pop-up menu.
The Device Editor opens, displaying the DTM for the communication module.
3 In the left pane of the Device Editor, navigate to and select the Items node for the
STB NIC 2212 network interface module:
152 S1A34009 07/2012

Step Action
4 The Items window opens:
5 Select the Input (bit) tab to display that page.

6 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.
7 In the Items List, select the first 2 rows in the table. (These rows represent bits 0-1
in byte.)
S1A34009 07/2012 153

Step Action
8 Click the Define Item(s) button.The Item Name Definition dialog opens:
Note: The asterisk (*) indicates a series of discrete items with the same root name
will be created.
9 Accept the default Item Name and click OK. 2 discrete input items are created:
10 Click Apply to save the items, and leave the page open.
154 S1A34009 07/2012

Step Action
11 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:
z Byte: 0, Bits: 2-3, Default Items Name Root: DDI3230_in_st
z Byte: 0, Bits: 4-5, Default Items Name Root: DDO3200_out_echo
z Byte: 0, Bits: 6-7, Default Items Name Root: DDO3200_out_st
z Byte: 1, Bits: 0-3, Default Items Name Root: DDI3420_in_data
z Byte: 3, Bits: 0-5, Default Items Name Root: DDI3610_in_data
12 The next task is to create input bytes and words.
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 Action
1 Select the Input tab to return to that page:
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
2 In the Default Item Name Root input box type: NIC22212_01_LO_st.
S1A34009 07/2012 155

Step Action
3 Starting at the first available whole input word, select the single row at byte 8:
156 S1A34009 07/2012

Step Action
5 Select Byte as the New Item(s) Data Type, then click OK. A new byte item is
created:
7 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:
z byte: select a single row
z word: select two rows, beginning at the next available whole word
In this example, you will create items for each of the following:
z Byte: 9, Default Items Name Root: NIC2212_01_HI_st
z Word: 10, Default Items Name Root: AVI1270_CH1_in_data
z Byte: 12, Default Items Name Root: AVI1270_CH1_in_st
z Word: 14-15, Default Items Name Root: AVI1270_CH2_in_data
z Byte: 16, Default Items Name Root: AVI1270_CH2_in_st
z Byte: 17, Default Items Name Root: AVO1250_CH1_out_st
z Byte: 18, Default Items Name Root: AVO1250_CH2_out_st
8 The next task is to create output bits.
S1A34009 07/2012 157

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 Action
1 Select the Output (bit) tab to open the following page:
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.
2 In the Default Items Name Root input box type: DDO3200_out_data.
3 In the Items List, select the rows that correspond to bits 0-1 in byte 0—i.e., the first
2 rows:
158 S1A34009 07/2012

Step Action
NOTE: The asterisk (*) indicates a series of discrete items with the same root name
will be created.
5 Accept the default output name and click OK. 2 discrete output items are created:
7 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:
z Byte: 0, Bits: 2-5, Default Items Name Root: DDO3410_out_data
z Byte: 1, Bits: 0-5, Default Items Name Root: DDO3600_out_data
8 The next task is to create output bytes and words.
S1A34009 07/2012 159

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 Action
1 Click on the Output tab to open the following page:
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.
2 In the Default Item Name Root input box type: AVO1250_CH1_out_data.
3 Starting at the next available whole word, select 2 rows: 2 and 3:
160 S1A34009 07/2012

Step Action
5 Accept the default output name and click OK. the following output word item is
created:
6 Click Apply to save the new item and leave the page open.
7 Repeat steps 2 - 6 for the AVO 1250 channel 2 output data at bytes 4 and 5.
S1A34009 07/2012 161

3.3 Adding a Modbus TCP Device to the Network
Overview
This section extends the sample Unity Pro application, by describing how to:
z add an STB NIP 2212 Modbus TCP network interface module to your Unity Pro
application
z configure the STB NIP 2212 module
z configure a Modbus TCP connection linking the BMX NOC 0401 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 Unity Pro help files for additional information
about alternative configuration choices.

Topic Page
Setting Up Your Network 163
Adding an STB NIP 2212 Remote Device 165
Configuring STB NIP 2212 Properties 167
Connecting to the Advantys STB Island 174
Configuring I/O Items 178
162 S1A34009 07/2012

Setting Up Your Network
Overview
This sample network includes the following hardware and software:
z a controller rack with:
z BMX CPS 2000, 100/240 VAC power supply
z BMX P34 20302 controller
z a remote STB Advantys island with:

z STB NIP 2212 Modbus TCP network interface module
z STB PDT 3100 power distribution module
z STB AVI 1270 2 pt analog input module
z STB AVO 1250 2 pt analog output module
z a PC running both Unity Pro (version 5.0 or higher) and Advantys configuration
software (version 5.0 or higher)
z an Ethernet managed switch that is connected to the both the controller and
island by means of twisted pair Ethernet cable and RJ45 connectors.
S1A34009 07/2012 163

Network Topology
The Ethernet network devices used in this configuration include the following:
To re-create this example:

z use the IP addresses for your own configuration’s:
z PC
z STB NIP 2212 network interface module
z check wiring
NOTE: Unity Pro software running in the PC is used to configure the
BMX P34 20302 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.
164 S1A34009 07/2012

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 Action
1 In the DTM Browser, select the Ethernet communication module node, and then
click the right mouse button. A pop-up menu opens.
2 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.
S1A34009 07/2012 165

Step Action
4 In the General page of the Properties window, edit the default Alias name to read
NIP2212_01:
When you edit the Alias name, Unity Pro 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.
5 Click OK. Unity Pro adds the new STB NIP 2212 network interface module to the
DTM Browser, beneath the communication module.
instructions on how to save your configuration edits.
The next step is to configure the device you have just added to the project.
166 S1A34009 07/2012

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 47).
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:
z Properties
z Address Setting
z Request Setting
Configuring the Properties Page

Use the Properties page to:
z add the remote device to, or remove it from, the configuration
z edit the base name for variables and data structures used by the remote device
z indicate how input and output items will be created and edited
S1A34009 07/2012 167

The Properties page for an STB NIP 2212 network interface module looks like this:
Step Action
1 In the Properties section of the page, edit the following:
Number The relative position of the device in the list, from
0...127.
For this example, accept the default of 004.
Active Configuration z Enabled: adds this device to the Unity Pro project
configuration
z Disabled: removes this device from the Unity Pro
project configuration
Accept he default setting of Enabled.
168 S1A34009 07/2012

Step Action
2 In the IO Structure Name section of the page, edit the following:
Input area:
Structure Name (Read-only) Unity Pro automatically assigns a
structure name based on the variable name, in this
case T_NIP2212_01_IN.
Variable Name Accept the auto-generated variable name (based on
the alias name (see page 165)): NIP2212_01_IN.
Output area:
Structure Name (Read-only) Unity Pro automatically assigns a
structure name based on the variable name, in this
case T_NIP2212_01_OUT.
Variable Name 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.
3 In the Items Management section of the page, edit the following:
Import mode z 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.
z 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.
In this example, select Manual.
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.
S1A34009 07/2012 169

Configuring the Address Setting Page

Use the Address Setting page to:
z configure the IP address for the remote device
z 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:
170 S1A34009 07/2012

Step Action
1 In the Address Settings page, edit the following:
IP Address By default:
z the first three octet values equal the first three
octet values of the Ethernet communication
module, and
z 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 z 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 (see page 79).
z Disabled (the default) de-activates the DHCP
client in this device.
Select Enabled.
Identified by If DHCP for this Device is Enabled, this indicates
the device identifier type:
z MAC Address, or
z Device Name
Select Device Name.

Identifier If DHCP for this Device is Enabled, the specific
device MAC Address or Name value.
Type in NIP2212_01.
Mask The device subnet mask. The default =
255.255.255.0.
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.
The next step is to configure the connection between the communication module
and the remote device.
S1A34009 07/2012 171

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.
172 S1A34009 07/2012

Step Action
1 In the Request Settings page, edit the following:
Connec- (Read-only) The offset for both the health bit and the control bit for this connection. Offset values
tion Bit are auto-generated by the Unity Pro 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
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.
Unit ID The number of the device, or module, that is the target of the connection. A value of:
z 255 (the default) used to access the Ethernet communication module itself
z 254 causes no Modbus message to be sent; the module reports an event
z 0...253 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).
Because the remote device itself is the request target, accept the default value of 255.
Health The maximum allowed period, in milliseconds, between device responses, from 0...120000 ms in
Timeout 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.
Repeti- The data scan rate, from 0...60000 ms, in intervals of 5 ms. The default = 60 ms. Accept the default
tive Rate value of 60.
RD Address in the remote device of the input data image. The input data image begins at word 45391.
Address Because there is an offset of 40000 in the M340 platform, type in a value of 5391.
RD The number of words in the remote device, from 0...125, that the communication module will read.
Length Because the Modbus device will be configured for 18 words of input items, type in a value of 18.
Last The behavior of inputs in the application in the event communication is lost:
Value z Hold Value (the default)
z Set To Zero
Accept the default.

WR Address in the remote device of the output data image. The output data image begins at word
Address 40000. Because there is an offset of 40000 in the M340 platform, type in a value of 0.
WR The number of words in the remote device, from 0 to 120, to which the communication module will
Length write. Because the Modbus device will be configured for 5 words of output items, type in a value
of 5.
2 Click OK to save your edits, and close the window.
The next step is to connect the Unity Pro project to the Advantys Island.
S1A34009 07/2012 173

Connecting to the Advantys STB Island
Overview
In this example, you will use the Advantys configuration software running on your
PC to:
z connect the Advantys configuration software to the STB NIP 2212 and the 8 I/O
modules that comprise the Advantys STB island
z upload Advantys STB island configuration to the Advantys configuration software
in your PC
z display a fieldbus image for the Advantys STB island showing the relative location
of:
z input data
z output data
Using the data presented in the fieldbus image, you can use Unity Pro 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:
z for the field Workspace File type in Advantys
z for the field Island File type in Advantys_02
174 S1A34009 07/2012

Step Action
5 Click OK. The Advantys configuration software displays an empty DIN rail in the
center of the screen.
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.
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):
S1A34009 07/2012 175

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):
Note: A box appears beneath each module containing one or two integers—for
example . These integers serve the following purpose:
z The left-side integer (3 in this example) identifies the module’s physical position—
left to right—among the modules in the rack.
z 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.
176 S1A34009 07/2012

Step Action
12 Select Island →I/O Image Overview. The I/O Image window opens to the Fieldbus
Image page:
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:
z 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
z 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:
z 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.
z 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.
S1A34009 07/2012 177

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:
z use the Modbus Image page of the Advantys configuration software to identify
the relative position of each I/O module’s inputs and outputs
z use the Unity Pro Device Editor to create input and output items, defining each
item’s:
z name
z 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 Unity Pro
project (see page 36).
In this example, the following number and type of items need to be created:
z 18 input words
z 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:
Step Action
1 In the Advantys configuration software, select Island →I/O Image Overview. The
I/O Image window opens to the Modbus Image page.
2 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.
178 S1A34009 07/2012

Step Action
3 Make a note of the register number and item information for that word.
4 Repeat steps 2 and 3 for each word.
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 Unity Pro.
NOTE: When you create items, align items of data type WORD and DWORD, as
follows:
z WORD items: align these items on a 16-bit boundary
z DWORD items: align these items on a 32-bit boundary
This process yields the following tables of input and output data:
Input Data (Read):
Advantys Modbus Image Unity Pro Items STB Module Description

Register Bit(s) Bytes Bit(s)
45392 0-1 0 0-1 DDI 3230 input data
1 not used
45393 0-1 2 0-1 DDI 3230 input status
3 not used
5 not used
7 not used
45396 0-3 8 0-3 DDI 3420 input data
9 not used
45397 0-3 10 0-3 DDI 3420 input status
11 not used
13 not used
15 not used
45400 0-5 16 0-5 DDI 3610 input data
17 not used
45401 0-5 18 0-5 DDI 3610 input status
19 not used
S1A34009 07/2012 179


Register Bit(s) Bytes Bit(s)
21 not used
23 not used
45404 0-15 24 0-7 AVI 1270 input data ch 1
25 0-7
27 not used
45406 0-15 28 0-7 AVI 1270 input data ch 2
29 0-7
31 not used
45408 0-7 32 0-7 AVI 1270 output status ch 1
33 not used
45409 0-7 34 0-7 AVI 1270 output status ch 2
35 not used
Output Data (Write):

Register Bit(s) Byte Bit(s)
40001 0-1 0 0-1 DDO 3200 output data
1 not used
40002 0-3 2 0-3 DDO 3410 output data
3 not used
40003 0-5 4 0-5 DDO 3600 output data
5 not used
7 0-7
9 0-7
This example shows you how to create 18 words of inputs and 5 words of outputs.
This example creates items in the following sequence:
z input word items
z output word items
180 S1A34009 07/2012

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 Action
1 In the DTM Browser, select the communication module:

z click the right mouse button, then select Open in the pop-up menu.
The Device Editor opens, displaying the DTM for the communication module.
3 In the left pane of the Device Editor, navigate to and select the Items node for the
STB NIP 2212 network interface module:
S1A34009 07/2012 181

Step Action
4 Select the Input tab to open that page:
5 In the Default Item Name Root input box type: DDI3230_in_data.
6 Starting at the beginning of the table, select the first two rows: 0 and 1:
182 S1A34009 07/2012

Step Action
NOTE: The Define Item(s) button is enabled only when Input Mode is set to
Manual.
8 Select WORD as the New Item(s) Data Type, then click OK. A new item is created:
S1A34009 07/2012 183

Step Action
10 Repeat steps 2 - 6 for each new word item you need to create. In this example, that
includes the following items:
z Rows 2-3, Default Items Name Root: DDI3230_in_st
z Rows 4-5: Default Items Name Root: DDO3200_out_echo
z Rows 6-7: Default Items Name Root: DDO3200_out_st
z Rows 8-9: Default Items Name Root: DDI3420_in_data
z Rows 10-11: Default Items Name Root: DDI3420_in_st
z Rows 16-17: Default Items Name Root: DDI3610_in_data
z Rows 18-19: Default Items Name Root: DDI3610_in_st
z Rows 24-25: Default Items Name Root: AVI1270_CH1_in_data
z Rows 26-27: Default Items Name Root: AVI1270_CH1_in_st
z Rows 28-29: Default Items Name Root: AVI1270_CH2_in_data
z Rows 30-31: Default Items Name Root: AVI1270_CH2_in_st
z Rows 32-33: Default Items Name Root: AVO1250_CH1_out_st
z Rows 34-35: Default Items Name Root: AVO1250_CH2_out_st
11 The next task is to create output words.
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 Action
1 Click on the Output tab to open the following page:
184 S1A34009 07/2012

Step Action
2 In the Default Item Name Root input box type: DDO3200_out_data.
3 Starting at the beginning of the table, select the first 2 rows, 0 and 1:
NOTE: The Define Item(s) button is enabled only when Input Mode is set to
Manual.
S1A34009 07/2012 185

Step Action
5 Select WORD as the New Item(s) Data Type, then click OK. A new item is
created:
6 Click Apply to save the new item and leave the page open.
7 Repeat steps 2 - 6 for each new word item you need to create. In this example, that
includes the following items:
z Rows 2-3, Default Items Name Root: DDO3410_out_data
z Rows 4-5: Default Items Name Root: DDO3600_out_data
z Rows 6-7: Default Items Name Root: AVO1250_CH1_out_data
z Rows 8-9: Default Items Name Root: AVO1250_CH2_out_data

The next task is to update the Unity Pro application.
186 S1A34009 07/2012

Modicon M340
Working With Derived Data Types
S1A34009 07/2012
4
Overview
This chapter describes how to complete your project by creating, updating, and
viewing derived data type (DDT) variables in Unity Pro.

Topic Page
Creating and Updating Derived Data Types 188
Working with Derived Data Type Variables 190
Effect of Activating and De-activating Devices on I/O %MW Memory Addresses 199
S1A34009 07/2012 187

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
Unity Pro 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 Action
1 In the Project Browser, navigate to and select the communication module.
z click the right mouse button, and select Open in the pop-up menu, or
z in the Edit menu, select Open.
The Configuration page of the Ethernet communication module opens, below:
3 Click the Update application button.

NOTE:
z Every time you use the Device Editor to make changes to your Unity Pro
project, return to this screen and click the Update application button to save
your edits.
z Unity Pro refreshes the collection of DDTs and variables—by adding, editing, or
deleting previously generated DDTs and variables—each time you:
z click on the Update application button, above, or
z select either Build →Build Changes or Build →Rebuild All Project
188 S1A34009 07/2012

Step Action
4 Click OK. The Project Browser displays the new or edited derived data types,
below:
S1A34009 07/2012 189

Working with Derived Data Type Variables
Derived Data Type Variables

When you click on the Update application button, Unity Pro creates a collection of
derived data types and variables. These are used by Unity Pro 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 Unity Pro 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:
z view the status of connections from the communication module to remote
EtherNet/IP and Modbus TCP devices, where:
z the status of connections is displayed in the form of a HEALTH_BITS array
consisting of 32 bytes
z each connection is represented by a single bit in the array
z a bit value of 1 indicates the connection is healthy
z a bit value of 0 indicates the connection is lost, or the communication module
can no longer communicate with the remote device
z 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.
z monitor the value of local slave and remote device input and output items you
created in the Unity Pro Device Editor
190 S1A34009 07/2012

Identifying Derived Variables in the Data Editor

To view your Unity Pro application’s derived data type variables:
Step Description
1 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:
NOTE:
z A check mark appears in the DDT checkbox. (If not, select the DDT checkbox to
display these variables.)
z The red arrow and lock icons indicate the variable name was auto-generated by
Unity Pro based on the configuration of the local slave or remote device and
cannot be edited.
S1A34009 07/2012 191

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:
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 page 36). However, within
the reserved area for both inputs and outputs, Unity Pro assigns addresses to
variables in the following order:
Inputs Order Outputs
Health bits 1 1 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.
192 S1A34009 07/2012

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:
z 1 indicates the connection is active
z 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:
S1A34009 07/2012 193

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:
z for Modbus TCP devices: the main device node
z 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:
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.
3 For an EtherNet/IP device, open the Connection Settings page and look for the
Connection Bit number:
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.
4 For a local slave, open the local slave configuration page (see page 107) and look
for the Connection Bit number:
194 S1A34009 07/2012

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 Action
1 In the Project Browser, select the Animation Tables node and click the right
mouse button. A pop-up menu opens.
2 Select New Animation Table.
3 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 Accept the default value of 100.
animated characters
The completed dialog looks like this:
4 Click OK. The dialog closes and the new Connection_Health_Bits animation
table opens.
5 Double-click on the first empty row in the Name column, then click the ellipsis
button . The Instance Selection dialog opens.
S1A34009 07/2012 195

Step Action
6 In the Instance Selection dialog, navigate to and select the entire
HEALTH_BITS_IN array:
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.
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.
196 S1A34009 07/2012

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 Action
1 With the Connection_Health_Bits animation table open, double-click on the next
empty row in the Name column, then click the ellipsis button . The
Instance Selection dialog opens.
2 In the Instance Selection dialog, navigate to and select the entire
CONTROL_BITS_OUT array:
S1A34009 07/2012 197

Step Action
3 Click OK to add the control bit array to the Connection_Health_Bits animation
table:
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.
4 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.
5 Type in 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 displays an initial value of 7. This
indicates that the first three connections (0, 1, and 2) are active. If you want to
toggle off the third connection (i.e. connection number 2), type in a value of 3.
6 On your keyboard, press Enter. The control bit for the third connection (i.e.
connection number 2) is toggled off.
198 S1A34009 07/2012

Effect of Activating and De-activating Devices on I/O %MW Memory Addresses
Introduction
Unity Pro 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, Unity Pro 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
(see page 192), the activation and de-activation of a single device causes a rippling
effect on the address locations of other I/O variables throughout the application.
Because activating and de-activating devices can cause substantial changes to
located variable addresses, Schneider Electric recommends the following practices:
z Activate every device and local slave your application is likely to use, and allow
these devices to remain activated.
z 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 device (see page 196).
z When configuring function blocks in Unity Pro, 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 Unity Pro.
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:
z the Ethernet communication module, named NOC01
z an STB NIC 2212 EtherNet/IP network interface module with I/O modules,
named NIC2212_01
Note that, when a new network is created, Unity Pro 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:
z Total network inputs and outputs are set in the Configuration page of the
Ethernet communication module in Unity Pro:
z 100 input words are reserved, beginning at %MW01
z 100 output words are reserved, beginning at %MW101
S1A34009 07/2012 199

z Connection bits for the project include:

z 32 input bytes (16 words) for health bits with an instance name of NOC01_IN
z 32 output bytes (16 words) for control bits with an instance name of
NOC01_OUT
z Local slave inputs and outputs include:
z 8 input bytes (4 words) are reserved with an instance name of NOC01_LS1_IN
z 4 output bytes (2 words) are reserved with an instance name of
NOC01_LS1_OUT
z Remote EtherNet/IP device inputs and outputs include:
z 19 input bytes (10 words) are reserved with an instance name of
NIC2212_01_IN
z 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, Unity Pro 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.
200 S1A34009 07/2012

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 slave configuration page (see page 109), 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:
Notice how the address locations for the remote EtherNet/IP device have shifted:
z inputs (NIC2212_01_IN) have shifted from %MW17 to %MW21
z 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.
S1A34009 07/2012 201

202 S1A34009 07/2012

Modicon M340
Optimizing Performance
S1A34009 07/2012
5
Overview
This chapter describes how to optimize the performance of your Ethernet network.

Section Topic Page
5.1 Selecting a Switch 204
5.2 Control Application Design 215
5.3 Projecting Ethernet Network Performance 229
S1A34009 07/2012 203

5.1 Selecting a Switch
Overview
This section describes how to select an Ethernet switch for your network.

Topic Page
Role of a Switch in an Ethernet Network 205
Transmission Speed, Duplex and Auto-Negotiation 206
Quality of Service (QoS) 207
IGMP Snooping 208
Rapid Spanning Tree Protocol (RSTP) 209
Virtual Local Area Network (VLAN) 210
Port Mirroring 212
Simple Network Management Protocol (SNMP) Agent 214
204 S1A34009 07/2012

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:
z turn switch ports on or off
z configure port speed and duplex settings
z control and monitor message traffic within segments
z prioritize message traffic
Recommended Switch Features

When acquiring an Ethernet switch for your process control network, confirm that the
switch includes the following features:
z Multiple speed (10/100/1000 Mbps)
z Full duplex
z QoS
z IGMP snooping
z RSTP
z VLAN support
z Port mirroring
z SNMP agent
S1A34009 07/2012 205

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 auto-negotiation—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:
z both auto-negotiation and manual configuration of speed and duplex settings
z multiple speeds: 10/100/1000 Mbps
z both full duplex and half duplex
206 S1A34009 07/2012

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 first-out 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 Priority mapping rule Description

Explicit (QoS tag in DSCP or TOS field in Each IP based Ethernet packet contains a
Ethernet packet) IP header 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 Each Ethernet packet contains a value in the
header priority field in the VLAN tag in its Ethernet
header, indicating the QoS priority. The
switch forwards packets based on this priority.
Implicit Port based 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.
S1A34009 07/2012 207

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 IGMP Multicast Group Join message. The group message is received by
all network switches, which update their multicast addressing information databases
in response.
Similarly, when an Ethernet device transmits an IGMP Multicast Group Leave
message, all network switches update their multicast addressing information
databases by removing the device from their databases.
Multicast messaging reduces network traffic by:
z requiring that a message be sent only once
z sending the message only to devices for which the message is intended
Recommendation
Schneider Electric recommend the following:
z employ switches that support IGMP V2 or higher
z because IGMP snooping may be disabled by default, enable IGMP snooping for
each network switch
z confirm that one switch is configured as the IGMP querier
208 S1A34009 07/2012

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:
z it creates a loop-free logical network path for Ethernet devices that are part of a
topology that includes redundant physical paths
z 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:
z 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:
z the number of switches in the topology: the more switches, the longer the
recovery time
z the processing speed of the switches in the topology: the slower the speed, the
longer the recovery time
z the bandwidth, traffic load, and topology pattern
z If the switch is part of a topology with redundant physical paths: enable RSTP.
z 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.
S1A34009 07/2012 209

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 Mapping rule Description

Explicit (VLAN tag in Tag based Each VLAN group is assigned a unique VLAN ID, which is included in
Ethernet packet) each Ethernet packet. The switch forwards packets based on VLAN ID.
Implicit (no VLAN tag Port based Switch ports are assigned to different VLANs, when the switch is
in Ethernet packet) configured (see example, below.)
MAC based 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.
210 S1A34009 07/2012

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.
S1A34009 07/2012 211

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:
z only the incoming packets of a single mirrored port
z only the outgoing packets of a single mirrored port
z both the incoming and outgoing packets of a single mirrored port
z the packets of several mirrored ports—or the whole switch
A packet sniffer’s troubleshooting features should include:

z analyzing network performance
z monitoring network activity
212 S1A34009 07/2012

Recommendation
Schneider Electric recommends implementing port mirroring as follows:
z 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.
z When configuring the switch, confirm that port mirroring is designed to forward
packets—e.g., incoming, outgoing, or both—to meet your requirements.
z A packet sniffer’s troubleshooting features should include the capabilities of
analyzing network performance and monitoring network activity.
S1A34009 07/2012 213

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:
z operational state information (interface status, mode of operation, etc.)
z configuration parameters (IP address, features enabled / disabled, timer values,
etc.)
z performance statistics (frame counters, event logs, etc.)
If a switch is equipped with SNMP agent software, a designated SNMP manager

can:
z retrieve management data about the switch
z control the switch by editing its configuration settings
z receive traps—or notices of events—affecting the state of the switch
214 S1A34009 07/2012

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.

Topic Page
Message Types 216
Message Connection Types 218
TCP and CIP Connections 220
Message Priority 221
Messaging Performance 222
Message Frequency 223
Allocating Network Bandwidth 225
Estimating Message Traverse and Response Times 227
S1A34009 07/2012 215

Message Types
Overview
Two types of industrial Ethernet message types are supported by the Ethernet
Message Type Includes...

Explicit z Non-time critical management data
z Read/write application data
Implicit z Real-time I/O data

z Real-time control data
z 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:
z point-to-point client-server mode
z variable size
z variable frequency
z long response time
z long connection timeout
216 S1A34009 07/2012

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 Characteristics

Connected z Begins when an originating device initiates a connection by sending
a request to a target device.
z The connection is established when the originator receives a
successful response from the target.
z 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.
z Used for recurring requests, and for high priority parameter
monitoring.
z Typically use short response timeout settings.
Unconnected z Less resource intensive.

z Used for less frequent requests, and for lower priority parameter
monitoring.
z 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:
z producer/consumer mode (EtherNet/IP) or client/server mode (Modbus TCP)
z small, fixed data size
z fixed frequency
z short response time
z short connection timeout
S1A34009 07/2012 217

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 Unity Pro Ethernet
Configuration Tool. Open the DTM Editor for the Ethernet communication module,
then edit the following settings:
z the network multiple is the Time-out Multiplier parameter found in the
Device List →<device> →<connection> →Connection Settings page, and
z 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.
218 S1A34009 07/2012

Connection Types and Protocols

The connection type and transport protocol employed depends upon the message
type and message protocol, as follows:
Message Type Message Protocol Connection Type Connection Protocol

Explicit EtherNet/IP CIP, TCP TCP/IP
Modbus TCP TCP TCP/IP
FTP TCP TCP/IP
HTML (web) TCP TCP/IP
SMTP TCP TCP/IP
SNMP N/A UDP/IP
SNTP N/A UDP/IP
DHCP N/A UDP/IP
BOOTP N/A UDP/IP
Implicit EtherNet/IP CIP, TCP UDP/IP
Modbus TCP TCP TCP/IP
IGMP N/A IP
RSTP N/A 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, saves network resources, and improves performance.
S1A34009 07/2012 219

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 Maximum Number of Connections per Module

CIP 256
TCP 128
NOTE:
z A single TCP connection can support multiple CIP connections.
z The maximum number of TCP connections does not include connections
dedicated to other services, for example, FTP and Web connections.
220 S1A34009 07/2012

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.
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.
S1A34009 07/2012 221

Messaging Performance
Maximum Messaging Load

The Ethernet communication module supports a the following maximum messaging
loads:
Message Type Maximum Messaging Load

Implicit (EtherNet/IP plus Modbus TCP) 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
222 S1A34009 07/2012

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:
z on a cyclic basis, at the request packet interval (RPI) rate, or
z upon the occurrence of a change of state event
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:
z 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.
z 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.
S1A34009 07/2012 223

Change of State I/O Messaging

For change of state triggered real-time I/O data messages:
z output transmissions occur at the rate of the PLC controller application cycle time
z 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.
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.
224 S1A34009 07/2012

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:
z 10% of network bandwidth
z 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. Message Load
can be estimated as follows:
Message Load =
(number of packets per connection) x (number of connections) / RPI
The number of packets per connection value depends on the capacity of the device,
and can be either:
z 1: for connections that support uni-directional communication
z 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 and Message Bandwidth formulae to
calculate the fastest RPI for the message.
S1A34009 07/2012 225

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. Device Load is the sum
of the Message Load values for every message handled by the device.
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 Device Load not exceed 90% of CPU
processing capacity of each device.
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:
z 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.
z Increase the RPI setting for a device where possible.
z 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 Network Load not exceed 90% of
maximum network bandwidth.
If necessary, you may need to optimize your control application design by:
z adjusting device RPI settings
z changing connection types (e.g., from direct to rack optimized)
z modify the configuration
z change the network topology
226 S1A34009 07/2012

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:
z the number of forwarding network devices
z the transmission delay of each forwarding device
z network load
z 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 Message Traverse
Time, as follows:
Step Description
1 Determine the worst case network load.
2 Obtain switch performance information, under varying network loads, and use
the worst case—i.e., the largest—transmission delay value.
3 Determine the logical network topology that yields the longest path—i.e. the
greatest number of switches—through which a message passes.
4 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.
S1A34009 07/2012 227

Message Response Time

After calculating Message Traverse Time (above), you can next measure Message
Response Time, which measures the total time required for:
z a message to travel from a client device over the network to a server
z the message to be processed by the server
z 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 Unity Pro Ethernet Configuration Tool:
z EM Request Timeout value, and
z EM Connection RPI
228 S1A34009 07/2012

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:
z a PLC that controls 3 remote I/O stations (A, B, and C)
z BMX NOC 0401 Ethernet communication module, acting as the local I/O
scanner, installed in the PLC rack
z an 8-port Ethernet managed switch
z a PC running used to obtain diagnostic data via explicit messages running the
following software:
z Unity Pro
z the Unity Pro Ethernet Configuration Tool
z 4 remote devices, acting as:

z an I/O adapter (A) for a rack of I/O modules
z a second I/O adapter (B) for a rack of I/O modules
z a remote I/O drive (C)
z a remote I/O scanner (D)
Unity Pro 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.
S1A34009 07/2012 229

Network Diagram
The proposed network diagram looks like this:
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 Load Limits Bandwidth Limits

Ethernet Communication Module 12000 pps 80 Mbps
I/O Adapter (A) 8000 pps 70 Mbps
I/O Adapter (B) 8000 pps 70 Mbps
I/O Drive (C) 8000 pps 70 Mbps
I/O Scanner (D) 12000 pps 80 Mbps
Switch 16000 pps 90 Mbps
230 S1A34009 07/2012

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 CIP I/O Connections RPI Setting I/O Packet Size

I/O Adapter (A) 5 20 ms 8000 bits
I/O Adapter (B) 2 30 ms 4096 bits
I/O Drive (C) 2 30 ms 8000 bits
I/O Scanner (D) 2 50 ms 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 Number of X Number of ÷ RPI = Load

packets per connections
connection
I/O Adapter (A) 2 X 5 ÷ 20 ms = 500 pps
I/O Adapter (B) 2 X 2 ÷ 30 ms = 134 pps
I/O Drive (C) 2 X 2 ÷ 30 ms = 134 pps
I/O Scanner (D) 2 X 2 ÷ 50 ms = 80 pps
Total = 848 pps
Switch = 848 pps
S1A34009 07/2012 231

Bandwidth:
Device Packet size X Load = Bandwidth

I/O Adapter (A) 8000 bits X 500 pps = 4 Mbps
I/O Adapter (B) 4096 bits X 134 pps = 0.554 Mbps
I/O Drive (C) 8000 bits X 134 pps = 1.07 Mbps
I/O Scanner (D) 8000 bits X 80 pps = 0.64 Mbps
Total = 6.26 Mbps
Switch = 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 90% of Load Limit 90% of Bandwidth Limit

Ethernet Communication Module 10800 pps 72 Mbps
I/O Adapter (A) 7200 pps 63 Mbps
I/O Adapter (B) 7200 pps 63 Mbps
I/O Drive (C) 7200 pps 63 Mbps
I/O Scanner (D) 10800 pps 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.
232 S1A34009 07/2012

Modicon M340
CIP objects
S1A34009 07/2012
CIP Objects
6
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:

z a collection of instance attributes, by including in the explicit message address
only the object’s class and instance values, or
z 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:
z access module data, or
z execute module commands
This chapter describes the CIP objects the Ethernet communication module
exposes to remote devices.
S1A34009 07/2012 233

CIP objects

Topic Page
Identity Object 235
Assembly Object 237
Connection Manager Object 239
Modbus Object 242
Quality Of Service (QoS) Object 244
TCP/IP Interface Object 246
Ethernet Link Object 248
EtherNet/IP Interface Diagnostics Object 252
EtherNet/IP IO Scanner Diagnostics Object 255
IO Connection Diagnostics Object 257
EtherNet/IP Explicit Connection Diagnostics Object 261
EtherNet/IP Explicit Connection Diagnostics List Object 264
234 S1A34009 07/2012

CIP objects
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:
z 0: class
z 1: instance
Attributes
Identity object attributes are associated with each instance, as follows:
Instance ID = 0 (class attributes):
Attribute ID Description GET SET

01 Revision X —
02 Max Instance X —
X = supported
— = not supported
Instance ID = 1 (instance attributes):
Attribute ID Description Type GET SET

hex dec
01 01 Vendor ID UINT X —
02 02 Device Type UINT X —
03 03 Product Code UINT X —
04 04 Revision STRUCT X —
Major USINT
Minor USINT
X = supported
— = not supported
S1A34009 07/2012 235

CIP objects

hex dec
05 05 Status Word X —
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
06 06 Serial Number UDINT X —
07 07 Product Name STRING X —
18 24 Modbus Identity STRUCT X —
X = supported
— = not supported
Services
The Identity object performs the following services upon the listed object types:
Service ID Description Class Instance Notes

hex dec
01 01 Get_Attributes_All X X Returns:
z all class attributes (instance = 0)
z instance attributes 1 to 7 (instance = 1)
0E 14 Get_Attribute_Single X X Returns the value of the specified attribute.

X = supported
— = not supported
236 S1A34009 07/2012

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:
z 0: class
z 101, 102, 111, 112, 121, 122: instance
Attributes
The Assembly object consists of the following attributes:

01 Revision X —
03 Number of Instances X —
X = supported
— = not supported
Instance attributes:
Instance ID Attribute ID Description Type GET SET

101 03 Local slave 1: T->O input data Array of BYTE X —
102 Local slave 1: O>T Array of BYTE X X
111 Local slave 2: T->O input data Array of BYTE X —
121 Local slave 3: T->O input data Array of BYTE X —
X = supported
— = not supported
S1A34009 07/2012 237

CIP objects
Services
The CIP Assembly object performs these services upon the listed object types:

hex dec
0E 14 Get_Attribute_Single X X Returns the value oft he specified attribute
02 02 Set_Attribute_Single 1 — X 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.
238 S1A34009 07/2012

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:
z 0: class
z 1: instance
Attributes
Connection Manager object attributes are associated with each instance, as follows:

01 Revision X —
X = supported
— = not supported
Attribute ID Description Type GET SET Value

hex dec
01 01 Open Requests UINT X X Number of Forward
Open service requests
received
02 02 Open Format UINT X X Number of Forward
Rejects Open service requests
that were rejected due
to bad format
03 03 Open Resource UINT X X Number of Forward
to lack of resources
X = supported
— = not supported
S1A34009 07/2012 239

CIP objects

hex dec
04 04 Open Other UINT X X Number of Forward
that were rejected for
reasons other than bad
format or lack of
resources
05 05 Close Requests UINT X X Number of Forward
Close service requests
received
06 06 Close Format UINT X X Number of Forward
Requests Close service requests
to bad format
07 07 Close Other UINT X X Number of Forward
Requests Close service requests
that were rejected for
reasons other than bad
format
08 08 Connection UINT X X Total number of
Timeouts connection timeouts
that occurred in
connections controlled
by this connections
manager
09 09 Connection Entry STRUCT X — 0 (Unsupported optional
List item
0B 11 CPU_Utilization UINT X — 0 (Unsupported optional
item
0C 12 MaxBuffSize UDINT X — 0 (Unsupported optional
item
0D 13 BufSize Remaining UDINT X — 0 (Unsupported optional
item
X = supported
— = not supported
240 S1A34009 07/2012

CIP objects
Services
The Connection Manager object performs the following services on the listed object
types:

hex dec
01 01 Get_Attributes_All X X Returns the value of all attributes.
X = supported
— = not supported
S1A34009 07/2012 241

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:
z 0: class
z 1: instance
Attributes
The Modbus object consists of the following attributes:

01 Revision X —
X = supported
— = not supported

— No instance attributes are supported — — —
Services
The Modbus object performs the following services upon the listed object types:
Service ID Description Class Instance

hex dec
0E 14 Get_Attribute_Single X X
4B 75 Read_Discrete_Inputs — X
X = supported
— = not supported
242 S1A34009 07/2012

CIP objects

hex dec
4C 76 Read_Coils — X
4D 77 Read_Input_Registers — X
4E 78 Read_Holding_Registers — X
4F 79 Write_Coils — X
50 80 Write_Holding_Registers — X
51 81 Modbus_Passthrough — X
X = supported
— = not supported
S1A34009 07/2012 243

CIP objects
Quality Of Service (QoS) Object
Overview
The QoS object implements Differentiated Services Code Point (DSCP or DiffServe)
values for the purpose of providing a method of prioritizing Ethernet messages. The
QoS object presents the instances, attributes and services described below.
Class ID
Instance IDs
The QoS object presents two instance values:
z 0: class
z 1: instance
Attributes
The QoS object consists of the following attributes:

01 Revision X —
X = supported
— = not supported

04 DSCP Urgent USINT X X For CIP transport class
0/1 Urgent priority
messages, default
value = 55.
05 DSCP Scheduled USINT X X For CIP transport class
0/1 Urgent priority
messages, default
value = 47.
X = supported
— = not supported
244 S1A34009 07/2012

CIP objects

06 DSCP High USINT X X For CIP transport class
0/1 Urgent priority
messages, default
value = 43.
07 DSCP Low USINT X X For CIP transport class
0/1 Urgent priority
messages, default
value = 31.
08 DSCP Explicit USINT X X 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:

hex dec
10 16 Set_Attribute_Single — X
X = supported
— = not supported
S1A34009 07/2012 245

CIP objects
TCP/IP Interface Object
Overview
The TCP/IP interface object presents the instances, attributes and services
described below.
Class ID
F5 (hex), 245 (decimal)
Instance IDs
The TCP/IP interface object presents 2 instance values:
z 0: class
z 1: instance
Attributes
TCP/IP interface object attributes are associated with each instance, as follows:

01 Revision X —
X = supported
— = not supported

01 Status DWORD X — 0x01
02 Configuration DWORD X — 0x01 = from BootP
Capability 0x11 = from flash
0x00 = other
03 Configuration Control DWORD X X 0x01 = out-of-box
default
04 Physical Link Object STRUCT X —
Path Size UINT
Path Padded
EPATH
X = supported
— = not supported
246 S1A34009 07/2012

CIP objects

05 Interface STRUCT X X 0x00 = out-of-box
Configuration default
IP Address UDINT
Network Mask UDINT
Gateway Address UDINT
Name Server UDINT
Name Server 2 UDINT
Domain Name STRING
06 Host Name STRING X —
X = supported
— = not supported
Services
The TCP/IP interface object performs the following services upon the listed object
types:

hex dec
01 01 Get_Attributes_All X X Returns the value of all
attributes.
0E 14 Get_Attribute_Single X X Returns the value of the
specified attribute.
10 16 Set_Attribute_Single1 — X 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:
z Configure the Ethernet communication module to obtain its IP address from flash memory.
z Confirm that the PLC is in stop mode.
S1A34009 07/2012 247

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 the following instance values:
z 0: class
z 1: port 1
z 2: port 2
z 3: port 3
z 4: port 4
z 5: internal port
Attributes
The Ethernet Link object presents the following attributes:

01 Revision X —
03 Number of Instances X —
X = supported
— = not supported
Instance ID = 1...5 (instance attributes):

hex dec
01 01 Interface Speed UDINT X — Valid values include:
0, 10000000, 100000000
X = supported
— = not supported
248 S1A34009 07/2012

CIP objects

hex dec
02 02 Interface Flags DWORD X — 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 Fault detected
0 = no event
1 = event detected
03 03 Physical Address ARRAY of X — Module MAC Address
6 USINT
04 04 Interface Counters STRUCT X —
In octets UDINT Octets received on the interface
In Ucast Packets UDINT Unicast packets received on the
interface
In NUcast Packets UDINT Non-unicast packets received on the
interface
In Discards UDINT Inbound packets received on the
interface, but discarded
In Errors UDINT Inbound packets that contain detected
errors (does not include In Discards)
In Unknown Protos UDINT Inbound packets with unknown protocol
Out Octets UDINT Octets sent on the interface
Out Ucast Packets UDINT Unicast packets sent on the interface
Out NUcast Packets UDINT Non-unicast packets sent on the
interface
Out Discards UDINT Outbound packets discarded
Out Errors UDINT Outbound packets that contain
detected errors
X = supported
— = not supported
S1A34009 07/2012 249

CIP objects

hex dec
05 05 Media Counters STRUCT X —
Alignment Errors UDINT Frames that are not an integral number
of octets in length
FCS Errors UDINT CRC error detected—Frames received
with a dtected FCS checksum error
Single Collisions UDINT Successfully transmitted frames that
experienced exactly one collision
Multiple Collisions UDINT Successfully transmitted frames that
experienced more than one collision
SQE Test Errors UDINT Number of times the SQE test error is
detected
Deferred Transmissions UDINT Frames for which first transmission
attempt is delayed because the
medium is busy
Late Collisions UDINT Number of times a collision is detected
later than 512 bittimes into the
transmission of a packet
Excessive Collisions UDINT Frames for which transmission is not
successful due to excessive collisions
MAC Transmit Errors UDINT Frames for which transmission is not
successful due to internal MAC
sublayer transmit detected error
Carrier Sense Errors UDINT Times that the carrier sense condition
was lost or not asserted when
attempting to transmit a frame
Frame Too Long UDINT Frames received that exceed the
maximum permitted frame size
MAC Receive Errors UDINT Frames for which reception on an
interface is not successful due to an
internal MAC sublayer receive detected
error
X = supported
— = not supported
250 S1A34009 07/2012

CIP objects

hex dec
06 06 Interface Control STRUCT X X API of the connection
Control Bits WORD Bit 0: Auto-negotiation
0 = Disabled
1 = Enabled
Note: When auto-negotiation is
enabled, the detected error 0x0C
(Object State Conflict) is returned when
attempting to set either:
z Forced Interface Speed, or
z Forced Duplex Mode
Bit 1: Forced Duplex Mode (if auto-

negotiation bit = 0)
0 = half duplex
1 = full duplex
Forced Interface Speed UINT Valid values include:
10000000, 100000000
Note: Attempting to set any other value
returns the detected error 0x09
(Invalid Attribute Value)
10 16 Interface Label SHORT_ X — A fixed textual string identifying the
STRING 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:

hex dec
01 01 Get_Attributes_All X X
10 16 Set_Attribute_Single — X
4C 76 Get_and_Clear — X
X = supported
— = not supported
S1A34009 07/2012 251

CIP objects
EtherNet/IP Interface Diagnostics Object
Overview
The EtherNet/IP Interface Diagnostics object presents the instances, attributes and
services described below.
Class ID
Instance IDs
The EtherNetP/IP Interface object presents two instance values:
z 0: class
z 1: instance
Attributes
EtherNet/IP Interface Diagnostics object attributes are associated with each
instance, as follows:

01 Revision X —
X = supported
— = not supported

01 Protocols Supported UINT X —
X = supported
— = not supported
252 S1A34009 07/2012

CIP objects

02 Connection Diagnostics STRUCT X —
Max CIP IO Connections UINT Number of Class 1 connections opened
opened since the last reset
Current CIP IO UINT Number of Class 1 connections currently
Connections opened
Max CIP Explicit UINT Number of Class 3 connections opened
Connections opened since the last reset
Current CIP Explicit UINT Number of Class 3 connections currently
Connections opened
CIP Connections UINT Increments each time a Forward Open is not
Opening Errors successful (Originator and Target)
CIP Connections UINT Increments when a connection times out
Timeout Errors (Originator and Target)
Max EIP TCP UINT Number of TCP connections (used for EIP,
Connections opened as client or server) opened since the last
reset
Current EIP TCP UINT Number of TCP connections (used for EIP,
Connections as client or server) currently open
03 IO Messaging STRUCT X X
Diagnostics
IO Production Counter UDINT Increments each time a Class 0/1 message
is sent
IO Consumption UDINT Increments each time a Class 0/1 message
Counter is received
IO Production Send UINT Increments each time a Class 0/1 message
Errors Counter is not sent
IO Consumption UINT Increments each time a consumption is
Receive Errors Counter received with a detected error
04 Explicit Messaging STRUCT X X
Diagnostics
Class 3 Msg Send UDINT Increments each time a Class 3 message is
Counter sent (client and server)
Class 3 Msg Receive UDINT Increments each time a Class 3 message is
Counter received (client and server)
UCMM Msg Receive UDINT Increments each time a UCMM message is
Counter sent (client and server)
UCMM Msg Receive UDINT Increments each time a UCMM message is
Counter received (client and server)
X = supported
— = not supported
S1A34009 07/2012 253

CIP objects
Services
The EtherNet/IP Interface Diagnostics object performs the following services upon
the listed object types:

hex dec
0E 14 Get_Attribute_Single — X Returns the value of the specified attribute.
4C 76 Get_and_Clear — X Returns and clears the values of all instance
attributes.
X = supported
— = not supported
254 S1A34009 07/2012

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
Instance IDs
The EtherNet/IP IO Scanner Diagnostics object presents two instances:
z 0: class
z 1: instance
S1A34009 07/2012 255

CIP objects
Attributes
EtherNet/IP IO Scanner Diagnostics object attributes are associated with each
instance, as follows:

01 Revision X —
X = supported
— = not supported

01 IO Status Table STRUCT X —
Size UINT
Status ARRAY of
UNINT
X = supported
— = not supported
Services
The EtherNet/IP IO Scanner Diagnostics object performs the following services
upon the listed object types:

hex dec
X = supported
— = not supported
256 S1A34009 07/2012

CIP objects
IO Connection Diagnostics Object
Overview
The IO Connection Diagnostics object presents the instances, attributes and
services described below.
Class ID
Instance IDs
The IO Connection Diagnostics object presents two instance values:
z 0: class
z 1...256: instance
S1A34009 07/2012 257

CIP objects
Attributes
IO Connection Diagnostics object attributes are associated with each instance, as
follows:

01 Revision X —
X = supported
— = not supported
Instance ID = 1 to 256 (instance attributes):

01 IO Communication STRUCT X X
Diagnostics
IO Production Counter UDINT Increments at each production
IO Consumption Counter UDINT Increments at each consumption
IO Production Send Errors UINT Increments each time a production is
Counter not sent
IO Consumption Receive UINT Increments each time a consumption
Errors Counter is received with a detected error
CIP Connection Timeout UINT Increments when a connection times
Errors out
CIP Connection Opening UINT Increments each time a connection is
Errors unable to open
CIP Connection State UINT State of the Connection Bit
CIP Last Error General Status UINT General status of the last error
detected on the connection
CIP Last Error Extended UINT Extended status of the last error
Status detected on the connection
Input Communication Status UINT Communication status of the inputs
(see table, below)
Output Communication Status UINT Communication status of the outputs
(see table, below)
X = supported
— = not supported
258 S1A34009 07/2012

CIP objects

02 Connection Diagnostics STRUCT X X
Production Connection ID UDINT Connection ID for production
Consumption Connection ID UDINT Connection ID for consumption
Production RPI UDINT RPI for production
Production API UDINT API for production
Consumption RPI UDINT RPI for consumption
Consumption API UDINT API for consumption
Production Connection UDINT Connection parameters for production
Parameters
Consumption Connection UDINT Connection parameters for
Parameters consumption
Local IP UDINT —
Local UDP Port UINT —
Remote IP UDINT —
Remote UDP Port UINT —
Production Multicast IP UDINT Multicast IP used for production (or 0)
Consumption Multicast IP UDINT Multicast IP used for consumption (or
0)
Protocols Supported UDINT 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 Description Values

15...3 Reserved 0
2 Idle 0 = no idle notification
1 = idle notification
1 Consumption inhibited 0 = consumption started
1 = no consumption
0 Production inhibited 0 = production started
1 = no production
S1A34009 07/2012 259

CIP objects
Services
The EtherNet/IP Interface Diagnostics object performs the following services upon
the listed object types:

hex dec
0E 14 Get_Attribute_Single — X Returns the value of the specified attribute.
4C 76 Get_and_Clear — X Returns and clears the values of all instance
attributes.
X = supported
— = not supported
260 S1A34009 07/2012

CIP objects
EtherNet/IP Explicit Connection Diagnostics Object
Overview
The EtherNet/IP Explicit Connection Diagnostics object presents the instances,
Class ID
Instance IDs
The EtherNet/IP Explicit Connection Diagnostics object presents two instance
values:
z 0: class
z 1...64: instance
S1A34009 07/2012 261

CIP objects
Attributes
EtherNet/IP Explicit Connection Diagnostics object attributes are associated with
each instance, as follows:

01 Revision X —
X = supported
— = not supported
Instance ID = 1 to 64 (instance attributes):

01 Number of connections UINT X — Total number of opened explicit connections
02 Explicit Messaging STRUCT X —
Connections Diagnostic
List
Originator connection UDINT O->T connection ID
ID
Originator IP UDINT —
Originator TCP port UINT —
Target connection ID UDINT T->O connection ID
Target IP UDINT —
Target TCP port UINT —
Msg Send counter UDINT Increments each time a Class 3 CIP
message is sent on the connection
Msg Receive counter UDINT Increments each time a Class 3 CIP
message is received on the connection
X = supported
— = not supported
262 S1A34009 07/2012

CIP objects
Services
The EtherNet/IP Explicit Connection Diagnostics object performs the following
services upon the listed object types:

hex dec
01 01 Get_Attributes_All X — Returns the value of all attributes.
08 08 Create X — —
09 09 Delete — X —
4B 75 Explicit_Connections_Diagnostic_ — X —
Read
X = supported
— = not supported
S1A34009 07/2012 263

CIP objects
EtherNet/IP Explicit Connection Diagnostics List Object
Overview
The EtherNet/IP Explicit Connection Diagnostics List object presents the instances,
Class ID
Instance IDs
The EtherNet/IP Explicit Connection Diagnostics List object presents two instance
values:
z 0: class
z 1...N: instance
264 S1A34009 07/2012

CIP objects
Attributes
EtherNet/IP Explicit Connection Diagnostics List object attributes are associated
with each instance, as follows:

01 Revision X —
X = supported
— = not supported
Instance ID = 1 to N (instance attributes):

01 Number of connections UINT X — Total number of opened explicit connections
02 Explicit Messaging ARRAY of X —
Connections Diagnostic STRUCT
List
Originator connection UDINT O->T connection ID
ID
Originator IP UDINT —
Originator TCP port UINT —
Target connection ID UDINT T->O connection ID
Target IP UDINT —
Target TCP port UINT —
Msg Send counter UDINT Increments each time a Class 3 CIP
message is sent on the connection
Msg Receive counter UDINT Increments each time a Class 3 CIP
message is received on the connection
X = supported
— = not supported
S1A34009 07/2012 265

CIP objects
Services
The EtherNet/IP Explicit Connection Diagnostics object performs the following
services upon the listed object types:

hex dec
01 01 Get_Attributes_All X — Returns the value of all attributes.
08 08 Create X — —
09 09 Delete — X —
4B 75 Explicit_Connections_Diagnostic_ — X —
Read
X = supported
— = not supported
266 S1A34009 07/2012

Modicon M340
Online Action
S1A34009 07/2012
Online Action
7
Overview
The Ethernet communication module supports online actions that let you:
z display CIP objects for the communication module or a remote EtherNet/IP
device
z view and edit port configuration parameters for the communication module or a
remote EtherNet/IP device
z ping the communication module or a remote EtherNet/IP or Modbus TCP device
to confirm it is active on the Ethernet network
z connect to a remote device and then:
z view the remote device’s default parameter settings
z view the remote device’s current parameter settings
z edit and download to the remote device its editable parameter settings

Topic Page
Accessing CIP Objects 268
Editing Port Configuration Properties for Remote EtherNet/IP Devices 270
Pinging a Network Device 273
Viewing and Editing Online Settings for a Remote Device 275
S1A34009 07/2012 267

Online Action
Accessing CIP Objects
Overview
Use the Module Information page of the Online Action window to:
z retrieve and display current data describing the state of CIP objects for the
selected communication module or remote EtherNet/IP device, and
z 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 Unity Pro software:
In this mode... You can display data for these CIP objects...
Standard mode Identity object (see page 235)
Advanced mode z Identity object
(see page 48) z Connection Manager object (see page 239)
z TCP/IP Interface object (see page 246)
z Ethernet Link object
z QoS object (see page 244)
The Module Information page looks like this:
268 S1A34009 07/2012

Online Action
Retrieve and Display CIP Object Data

To display CIP object data for an EtherNet/IP communication module or remote
device:
Step Action
1 In the DTM Browser, select a communication module.
2 Click the right mouse button, and in the pop-up menu select Device menu →
Online Action. The Online Action window opens.
3 In the left pane of the Online Action window, select a communication module
or EtherNet/IP device.
4 In the right pane, click on the Module Information tab to open that page.
5 If Unity Pro is operating in Advanced Mode
z Select one of the following CIP objects:
z Identity
z Connection Manager
z TCP/IP
z Ethernet Link
z QoS
z If you selected a multi-port module or device in step 3, above, select an

Interface, or port, number
NOTE: If Unity Pro is operating in Standard Mode, it will display data only for the
CIP Identity object.
6 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 Action
1 In the DTM Browser, select a communication module.
3 In the left pane of the Online Action window, select a communication module
or EtherNet/IP device.
4 In the right pane, click on the Module Information tab to open that page.
5 Click the Reset Device button.
S1A34009 07/2012 269

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:
z Get command to retrieve port configuration settings from a remote EtherNet/IP
device
z 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:
270 S1A34009 07/2012

Online Action
Get Port Configuration Settings

To get settings from a remote EtherNet/IP device on the network:
Step Action
1 In the DTM Browser, select the communication module upstream of the remote
EtherNet/IP device.
EtherNet/IP Explicit Message. The EtherNet/IP Explicit Message window
opens.
3 In the EtherNet/IP Explicit Messaging page, complete the Address section.
Note: Port configuration explicit messages are sent as unconnected messages.
4 Return to the DTM Browser and again select the communication module
upstream of the remote EtherNet/IP device.
6 In the left pane of the Online Action window, select a remote EtherNet/IP
device.
7 In the right pane, click on the Port Configuration tab to open that page.
8 If the remote device consists of more than one port, select the port number in
the Physical Interface Instance list.
9 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 Action
1 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.
2 Type in, or select, the new value.
3 Repeat steps 1 - 2 for each parameter you want to edit.
S1A34009 07/2012 271

Online Action
Step Action
z Click the Set All Values to Device to write every value to the remote device
- or -
z if you edited parameters for only one part, or group, of the collection of
remote device values, then:
z in the Set Part of Values area, select one property group, then
z click the Set Values to Device button
Unity Pro sends the property value edits to the remote device via an EtherNet/IP
explicit message, and displays the results in the Description area.
272 S1A34009 07/2012

Online Action
Pinging a Network Device
Overview
Use the Unity Pro ping function to send an ICMP echo request to a target Ethernet
device to determine:
z if the target device is present, and if so
z the elapsed time to receive an echo response from the target device
The target device is identified by its IP address setting. Unity Pro will verify that the
target address is not a:
z loopback address (127.000.000.000 to 127.255.255.255)
z multicast address (224.000.000.000 to 239.255.255.255)
z reserved address (240.000.000.000 to 255.255.255.255)
z broadcast address
The ping function can be performed in the Ping page of the Online Action window:
Pinging a Network Device

To ping a network device:
Step Action
1 In the DTM Browser, select the communication module upstream of the remote
EtherNet/IP device you want to ping.
2 Click the right mouse button and select Device Menu > →Online Action in the
pop-up menu. The Online Action window opens.
S1A34009 07/2012 273

Online Action
Step Action
3 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:
z the communication module
z a remote EtherNet/IP device
z a remote Modbus TCP device
4 Select the Ping page. To send...

z a single ping, de-select the Repeat checkbox
z a series of pings—1 every 100 ms—select Repeat checkbox
5 (Optional) Select Stop on Error to stop pinging an unsuccessful

communication.
6 Click Ping once to begin pinging.
7 Click Ping a second time to stop repeated pinging, where no error has been
detected.
8 The Ping Result box displays the ping outcome. Click Clear to empty the
Ping Result box.
274 S1A34009 07/2012

Online Action
Viewing and Editing Online Settings for a Remote Device
Introduction
Use the Online Parameters window to:
z view the remote device’s default parameter settings
z view the remote device’s current parameter settings
z 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 Action
1 In the DTM Browser, select the node for a remote device.
Online Parameters. The Online Parameters window opens for the selected
remote device.
3 In the left pane of the Online Parameters window, select a connection node.
Unity Pro 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:
z the device selected in the DTM Browser, and
z the connection selected in the left pane of the Online Parameters window
S1A34009 07/2012 275

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. Unity Pro reads the default device values from its
EDS file and displays them on-screen.
Displaying Online Parameter Settings

To view the current parameter settings for the remote device, follow these steps:
Step Action
1 With a connection selected in the left pane, click the Synchronize button. The
Synchronize Action message box opens.
2 In the message box, select Read values from the device, then click OK.
The message box closes. In the Online Parameters window:
z the Status field displays the results of the read transaction
z the parameter list displays current values
276 S1A34009 07/2012

Online Action
Editing Online Parameter Settings

To edit parameter settings for the remote device, follow these steps:
Step Action
1 With a connection selected in the left pane, display either:
z default device settings, or
z current device settings
2 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.
3 Click the Synchronize button. The Synchronize Action message box opens.
4 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.
S1A34009 07/2012 277

Online Action
278 S1A34009 07/2012

Modicon M340
Explicit Messaging
S1A34009 07/2012
Explicit Messaging
8
Overview
The BMX NOC 0401 Ethernet communication module supports explicit messaging
by means of both the EtherNet/IP and Modbus TCP protocols.
To create an explicit message for the EtherNet/IP protocol, use the DATA_EXCH
function block in application logic.
To create an explicit message for the Modbus TCP protocol, use any one of the
following function blocks in application logic: DATA_EXCH, READ_VAR, or
WRITE_VAR.
NOTE: A single Unity Pro 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 configure both EtherNet/IP and Modbus TCP explicit
messages by using:
z the DATA_EXCH function block in application logic
z the Unity Pro graphical user interface

Section Topic Page
8.1 Explicit Messaging Using the DATA_EXCH Block 280
8.2 EtherNet/IP Explicit Messaging Using DATA_EXCH 284
8.3 Modbus TCP Explicit Messaging Using DATA_EXCH 301
8.4 Explicit Messaging via the Unity Pro GUI 309
S1A34009 07/2012 279

Explicit Messaging
8.1 Explicit Messaging Using the DATA_EXCH Block
Overview
This section introduces you to the DATA_EXCH function block, which you can use to
configure both EtherNet/IP and Modbus TCP explicit messages.
This section describes how to configure the DATA_EXCH function block’s
Management parameter, which is common to both Modbus TCP and EtherNet/IP
explicit messaging.

Topic Page
Configuring Explicit Messaging Using DATA_EXCH 281
Configuring the DATA_EXCH Management Parameter 283
280 S1A34009 07/2012

Explicit Messaging
Configuring Explicit Messaging Using DATA_EXCH
Overview
Use the DATA_EXCH function block to configure both Modbus TCP and EtherNet/IP
connected and unconnected explicit messages.
The Management_Param, the Data_to_Send, and the Received_Data
parameters define the operation.
EN and ENO can be configured as additional parameters.
FBD Representation
Input Parameters
Parameter Data type Description

Address Array [0...7] of INT The path to the destination device, the content of
which can vary depending on the message
protocol. Use the ADDM function. Refer to a
description of the Address parameter for:
z EtherNet/IP messages (see page 287)
z Modbus TCP messages (see page 303)
ActionType INT The type of action to perform. For both the

EtherNet/IP and Modbus TCP protocols, this
setting = 1 (transmission followed by await
reception).
Data_to_Send Array [n...m] of INT The content of this parameter is specific to the
protocol, either EtherNet/IP or Modbus TCP.
For EtherNet/IP explicit messaging, refer to the to
the topic Configuring the Data_To_Send
Parameter (see page 287).
For Modbus TCP explicit messaging, refer to Unity
Pro online help.
S1A34009 07/2012 281

Explicit Messaging
Input/Output Parameters

Management_Param Array [0...3] of INT The management parameter
(see page 283), consisting of 4 words.
Output Parameters

Received_Data Array [n...m] of INT The EtherNet/IP (CIP) response
(see page 288) or the Modbus TCP
response (see page 304).
The structure and content depends
upon the specific protocol.
282 S1A34009 07/2012

Explicit Messaging
Configuring the DATA_EXCH Management Parameter
Introduction
The structure and content of the Management parameter of the DATA_EXCH block
is common to both EtherNet/IP and Modbus TCP explicit messaging.
Configuring the Management Parameter

The Management parameter consists of 4 contiguous words, described below:
Data source Register Description

High Byte (MSB) Low Byte (LSB)
Data managed by Management_Param[0] Exchange number Two read-only bits:
the system z Bit 0 = Activity bit (see below)
z Bit 1 = Cancel bit
Management_Param[1] Operation report Communication report (see page 411)

(see page 412)
Data managed by Management_Param[2] Block timeout. Values include:
the user z 0 = infinite wait
z other values = timeout x 100 ms, for example:
z 1 = 100 ms
z 2 = 200 ms
Management_Param[3] Length of data sent or received:

z Input (before sending the request): length of data in the
Data_to_Send parameter, in bytes
z Output (after response): length of data in the Received_Data
parameter, in bytes
Activity Bit:
This bit indicates the execution status of the communication function.
It is set to 1 when launched, and returns to 0 when its execution is complete.
It is the first bit of the first element of the table.
Example: if the management table has been declared as follows:
Management_Param[0] ARRAY [0..3] OF INT,
the activity bit is the bit with the notation Management_Param[0].0.
NOTE: The notation previously used requires configuration of the project properties
in such a way as to authorize the extraction of bits on integer types. If this is not the
case, Management_Param[0].0 cannot be accessed in this manner.
S1A34009 07/2012 283

Explicit Messaging
8.2 EtherNet/IP Explicit Messaging Using

DATA_EXCH
Overview
This section shows you how to configure the DATA_EXCH function block for
EtherNet/IP explicit messages.

Topic Page
Explicit Messaging Services 285
Configuring EtherNet/IP Explicit Messaging Using DATA_EXCH 287
EtherNet/IP Explicit Message Example: Get_Attribute_Single 289
EtherNet/IP Explicit Message Example: Read Modbus Object 293
EtherNet/IP Explicit Message Example: Write Modbus Object 297
284 S1A34009 07/2012

Explicit Messaging
Explicit Messaging Services
Overview
Every 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 explicit messages using either the DATA_EXCH function block in
Unity Pro, or the Unity Pro Ethernet Configuration Tool.
Services
The services available in Unity Pro include, but are not limited to, the services listed
below:
Service Code Description Available in...

Hex Dec DATA_EXCH Unity Pro GUI
block
0 0 (Reserved) — —
1 1 Get_Attributes_All X X
2 2 Set_Attributes_All X X
3 3 Get_Attribute_List X —
4 4 Set_Attribute_List X —
5 5 Reset X X
6 6 Start X X
7 7 Stop X X
8 8 Create X X
9 9 Delete X X
A 10 Multiple_Service_Packet X —
B-C 11-12 (Reserved) — —
D 13 Apply_Attributes X X
E 14 Get_Attribute_Single X X
F 15 (Reserved) — —
10 16 Set_Attribute_Single X X
11 17 Find_Next_Object_Instance X X
12-13 18-19 (Reserved) — —
14 20 Error Response (DeviceNet only) — —
15 21 Restore X X
"X" indicates the service is available. "—" indicates the service is not available.
S1A34009 07/2012 285

Explicit Messaging
Service Code Description Available in...

Hex Dec DATA_EXCH Unity Pro GUI
block
16 22 Save X X
17 23 No Operation (NOP) X X
18 24 Get_Member X X
19 25 Set_Member X X
1A 26 Insert_Member X X
1B 27 Remove_Member X X
1C 28 GroupSync X —
1D-31 29-49 (Reserved) — —
"X" indicates the service is available. "—" indicates the service is not available.
286 S1A34009 07/2012

Explicit Messaging
Configuring EtherNet/IP Explicit Messaging Using DATA_EXCH
Configuring the Address Parameter

To configure the Address parameter, use the ADDM function to convert the character
string, described below, to an address:
ADDM(‘rack.slot.channel{ip_address}message_type.protocol’), where:
This field... Represents...

rack the number assigned to the rack containing the communication
module
slot the position of the communication module in the rack
channel the communication channel—set to a value of 0
ip_address the IP address of the remote device, for example 193.168.1.6
message_type the type of message, presented as a three character string—either:
z UNC (indicating an unconnected message), or
z CON (indicating a connected message)
protocol the protocol type—the three character string CIP
Configuring the Data_to_Send Parameter

The Data_to_Send parameter varies in size. It consists of contiguous registers
that include—in sequence—both the message type and the CIP request:
Offset (words) Length (bytes) Data Type Description

0 2 bytes Bytes Message type:
z High byte = size of the request in words
z Low byte = EtherNet/IP service code
1 Management_Param[3] Bytes The CIP request1.

(size of Data_to_Send) NOTE: The structure and size of the CIP request
minus 2 depends on the EtherNet/IP service.
1 Structure the CIP request in little endian order.
S1A34009 07/2012 287

Explicit Messaging
Contents of the Received_Data Parameter

The Received_Data parameter contains only the CIP response. The length of the
CIP response varies, and is reported by Management_Param[3] after the
response is received. The format of the CIP response is described, below:
Offset Length (bytes) Data Type Description

(words)
0 2 Byte z High byte (MSB) = reserved
z Low byte (LSB): reply service
1 2 Byte z High byte (MSB): length of additional status

z Low byte (LSB): EtherNet/IP general status
(see page 415)
2 length of additional status Byte array Additional Status1
... Management_Param[3] Byte array Response data
(size of Received_Data)
minus 4, and minus the
additional status length
1. Refer to The CIP Networks Library, Volume 1, Common Industrial Protocol at section 3-5.6 Connection Manager
Object Instance Error Codes.
NOTE: The response is structured in little endian order.
Checking the Received_Data Response for System and CIP Status

Use the contents of the Received_Data parameter to check both the system status
and the CIP status of the Ethernet communication module when handling the explicit
message.
First: Check the value of the high byte (MSB) of the first response word, positioned
at offset 0. If the value of this byte is:
z equal to 0: the system properly handled the explicit message
z not equal to 0: a system-based event occurred
Refer to the list of EtherNet/IP Explicit Messaging Event Codes
(see page 408) for an explanation of the system-based event code contained
in the second response word, positioned at offset 1.
Next: If the system properly handled the explicit message, and the high byte of the
first response word equals 0, check the value of the second response word,
positioned at offset 1. If the value of this word is:
z equal to 0: the explicit message was properly handled by the CIP protocol
z not equal to 0: a CIP protocol-based event occurred
Refer to your CIP documentation for an explanation of the CIP status
displayed in this word.
288 S1A34009 07/2012

Explicit Messaging
EtherNet/IP Explicit Message Example: Get_Attribute_Single
Overview
The following unconnected explicit messaging example shows you how to use the
DATA_EXCH function block to retrieve diagnostic data from a remote device—in this
case an STB NIC 2212 network interface module at IP address 192.168.1.6—using
the Get_Attribute_Single service.
You can perform the same explicit messaging service using the EtherNet/IP
Explicit Message window of the Unity Pro Ethernet Configuration Tool
(see page 310).
Implementing the DATA_EXCH Function Block

To implement the DATA_EXCH function block, you need to create and assign
variables for the following blocks:
S1A34009 07/2012 289

Explicit Messaging
Declaring Variables
In this example, the following variables were defined. You can, of course, use
different variable names in your explicit messaging configurations.
Configuring the Address Variable

The Address variable identifies the explicit message originating device—in this
example, the BMX NOC 0401 communication module—and the target device. Note
that the Address variable does not include the Xway address elements
{Network.Station} because we are not bridging through another PLC station. Use
the ADDM function to convert the following character string to an address:
ADDM(‘0.1.0{192.168.1.6}UNC.CIP’), where:
z rack = 0
z module (slot number) = 1
z channel = 0
z remote device IP address = 192.168.1.6
z message type = unconnected
z protocol = CIP
Configuring the ActionType Variable

The ActionType variable identifies the function type for the DATA_EXCH function
block:
Variable Description Value (hex)

ActionType Transmission followed by wait for response 16#01
290 S1A34009 07/2012

Explicit Messaging
Configuring the DataToSend Variable

The DataToSend variable identifies the type of explicit message and the CIP
request:
Variable Description Value

(hex)
DataToSend[0] CIP request service information: 16#030E
z High byte = request size in words: 16#03 (3 decimal)
z Low byte = service code: 16#0E (14 decimal)
DataToSend[1] CIP request class information: 16#0420

z High byte = class: 16#04 (4 decimal)
z Low byte = class segment: 16#20 (32 decimal)
DataToSend[2] CIP request instance information: 16#6424

z High byte = instance: 16#64 (100 decimal)
z Low byte = instance segment: 16#24 (36 decimal)
DataToSend[3] CIP request attribute information: 16#0330

z High byte = attribute: 16#03 (3 decimal)
z Low byte = attribute segment: 16#30 (48 decimal)
Viewing the Response

Use a Unity Pro Animation table to display the ReceivedData variable array. Note
that the ReceivedData variable array consists of the entire data buffer.
To display the CIP response, follow these steps:
Step Action
1 In Unity Pro, select Tools →Project Browser to open the Project Browser.
2 In the Project Browser, select the Animation Tables folder, then click the right
mouse button. A pop-up menu appears.
3 Select New Animation Table in the pop-up menu. A new animation table and its
properties dialog both open.
4 In the Properties dialog, edit the following values:
Name Type in a table name. For this example: ReceivedData.
Functional module Accept the default <None>.
Comment (Optional) Type your comment here.
Number of animated Type in 100, representing the size of the data buffer in
characters words.
S1A34009 07/2012 291

Explicit Messaging
Step Action
5 The completed Properties dialog looks like this:
Click OK to close the dialog.

6 In the animation table’s Name column, type in the name of the variable assigned to
the RECP pin: ReceivedData and hit Enter. The animation table displays the
ReceivedData variable.
7 Expand the ReceivedData variable to display its word array, where you can view the
CIP response contained in the ReceivedData variable:
Note: Each array entry presents 2 bytes of data in little endian format, where the
least significant byte is stored in the smallest memory address. For example, ‘8E’ in
word[0] is the lower byte, and ‘00’ is the upper byte.
292 S1A34009 07/2012

Explicit Messaging
EtherNet/IP Explicit Message Example: Read Modbus Object
Overview
DATA_EXCH function block to read data from a remote device—in this case an
STB NIC 2212 network interface module at IP address 192.168.1.6—using the
Read_Holding_Registers service of the Modbus Object.
(see page 310).

S1A34009 07/2012 293

Explicit Messaging
Declaring Variables

z rack = 0
z channel = 0
z protocol = CIP

block:

294 S1A34009 07/2012

Explicit Messaging

request:

(hex)
DataToSend[0] CIP request service information: 16#024E
z Low byte = service code: 16#4E (78 decimal)


DataToSend[3] Location of first word to be read): 16#0031

z High byte = 16#00 (0 decimal)
z Low byte = 16#31 (49 decimal)
DataToSend[4] Number of words to read: 16#0001


Step Action
characters words.
S1A34009 07/2012 295

Explicit Messaging
Step Action

7 Expand the ReceivedData variable to display its word array, where you can view
the CIP response contained in the ReceivedData variable:
least significant byte is stored in the smallest memory address. For example, ‘CE’
in word[0] is the lower byte, and ‘00’ is the upper byte.
296 S1A34009 07/2012

Explicit Messaging
EtherNet/IP Explicit Message Example: Write Modbus Object
Overview
DATA_EXCH function block to write data to a remote device—in this case an
STB NIC 2212 network interface module at IP address 192.168.1.6—using the
Write_Holding_Registers service of the Modbus Object.
(see page 310).

S1A34009 07/2012 297

Explicit Messaging
Declaring Variables

z rack = 0
z channel = 0
z protocol = CIP

block:

298 S1A34009 07/2012

Explicit Messaging

request:

(hex)
DataToSend[0] CIP request service information: 16#0250
z Low byte = service code: 16#50 (80 decimal)


DataToSend[3] Location of first word to write (+ %MW1): 16#0000

z High byte = 16#00 (0 decimal)
z Low byte = 16#00 (0 decimal)
DataToSend[4] Number of words to write: 16#0001

DataToSend[5] Data to write: 16#006F

z Low byte = attribute segment: 16#6F (111 decimal)

Step Action
Number of animated Type in 49, representing the size of the data buffer in words.
characters
S1A34009 07/2012 299

Explicit Messaging
Step Action

least significant byte is stored in the smallest memory address. For example, ‘D0’ in
word[0] is the lower byte, and ‘00’ is the upper byte.
300 S1A34009 07/2012

Explicit Messaging
8.3 Modbus TCP Explicit Messaging Using

DATA_EXCH
Overview
This section shows you how to configure DATA_EXCH function block parameters for
Modbus TCP explicit messages.

Topic Page
Modbus TCP Explicit Messaging Function Codes 302
Configuring Modbus TCP Explicit Messaging Using DATA_EXCH 303
EtherNet/IP Explicit Message Example: Read Register Request 305
S1A34009 07/2012 301

Explicit Messaging
Modbus TCP Explicit Messaging Function Codes
Overview
You can execute Modbus TCP explicit messages using either a Unity Pro
DATA_EXCH function block or the Unity Pro Ethernet Configuration Tool’s Modbus
Explicit Message Window.
NOTE: Configuration edits made to an Ethernet communication module from the
Unity Pro 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.
Function Codes
The function codes supported by the Unity Pro graphical user interface include the
following standard explicit messaging functions:
Function Code (dec) Description

1 Read bits (%M)
2 Read input bits (%I)
3 Read words (%MW)
4 Read input words (%IW)
15 Write bits (%M)
16 Write words (%MW)
NOTE: You can use the DATA_EXCH function block to execute any Modbus function,
via program logic. Because the available function codes are too numerous to list
here, refer instead to the Modbus IDA website for more information about these
Modbus functions, at:
http://www.Modbus.org.
302 S1A34009 07/2012

Explicit Messaging
Configuring Modbus TCP Explicit Messaging Using DATA_EXCH
Introduction
When you use the DATA_EXCH block to create an explicit message for a Modbus
TCP device, configure this block the same way you would configure it for any other
Modbus communication. Refer to the Unity Pro online help for instructions on how
to configure the DATA_EXCH block.
Configuring ADDM Block Unit ID Settings

When you configure the DATA_EXCH block, use the ADDM block to set the
DATA_EXCH block’s Address parameter. The ADDM block presents the configuration
format ADDM(‘rack.slot.channel[ip_address}UnitID.message_type.protocol’)
where:
The parameter... Represents...

rack the number assigned to the rack containing the BMX NOC 0401
slot the position of the BMX NOC 0401 communication module in the
rack
channel the communication channel—set to a value of 0
ip_address the IP address of the remote device, for example, 192.168.1.7
Unit ID the destination node address, also known as the Modbus Plus on
Ethernet Transporter (MET) mapping index value
message_type the three character string TCP
protocol the three character string MBS
The Unit ID value in a Modbus message indicates the destination of the message.
The manner in which the BMX NOC 0401 communication module handles the Unit
ID value depends upon its role as either a server or a client. When the
communication module acts as a:
z server: a message with Unit ID value of 255 is directed to and processed by the
communication module itself. Other messages are passed to the CPU.
z client: a message with Unit ID value of 255 is directed to and handled by the
communication module itself. Other values are passed to the CPU.
S1A34009 07/2012 303

Explicit Messaging
Contents of the Received_Data Parameter

The Received_Data parameter contains the Modbus response. The length of the
response varies, and is reported by Management_Param[3] after the response is
received. The format of the Modbus response is described, below:
Offset (words) Length (bytes) Description

0 2 First word of the Modbus response:
z High byte (MSB):
z if successful: Modbus Function Code
z if not: Modbus function code + 16#80
z Low byte (LSB):

z if successful: depends on the request
z if not: Modbus exception code
(see page 419)
1 Length of the Remainder of the Modbus response: depends on
Received_Data the specific Modbus request)
parameter – 2
NOTE: Structure the response in little endian order.
304 S1A34009 07/2012

Explicit Messaging
EtherNet/IP Explicit Message Example: Read Register Request
Overview
The following example shows you how to use the DATA_EXCH function block to send
an explicit messaging Modbus TCP request to a remote device—in this case an
STB NIP 2212 network interface module at IP address 192.168.1.7—to read a
single word located in the remote device at register 5391.

S1A34009 07/2012 305

Explicit Messaging
Declaring Variables

ADDM(‘0.1.0{192.168.1.7}TCP.MBS’), where:
z rack = 0
z channel = 0
z message type = TCP
z protocol = Modbus

block:

306 S1A34009 07/2012

Explicit Messaging

The DataToSend variable contains the target register address and the number of
registers to read:

(hex)
DataToSend[0] z High byte = Most significant byte (MSB) of register 16#1503
address 16#15 (21 decimal)
z Low byte = function code: 16#03 (03 decimal)
DataToSend[1] z High byte = Most significant byte (MSB) of the number of 16#000F
registers to read: 16#00 (0 decimal)
z Low byte = Least significant byte (LSB) of register
address: 16#0F (15 decimal)
z High byte = not used: 16#00 (0 decimal)
z Low byte = Least significant byte (LSB) of the number of
registers to read: 16#01 (1 decimal)

To display the Modbus TCP response, follow these steps:
Step Action
characters words.
S1A34009 07/2012 307

Explicit Messaging
Step Action

the databuffer: ReceivedData and hit Enter. The animation table displays the
Note: Each array entry presents 2 bytes of data in little endian format. For example,
‘03’ in word[0] is the low byte, and ‘02’ is the high byte.
308 S1A34009 07/2012

Explicit Messaging
8.4 Explicit Messaging via the Unity Pro GUI

Topic Page
Sending Explicit Messages to EtherNet/IP Devices 310
Sending Explicit Messages to Modbus TCP Devices 312
S1A34009 07/2012 309

Explicit Messaging
Sending Explicit Messages to EtherNet/IP Devices
Overview
Use the EtherNet/IP Explicit Message window to send an explicit message from
Unity Pro to an EtherNet/IP module or device on the network.
An explicit message can be sent as either a connected, or an unconnected
message:
z an unconnected message requires path — or addressing — information
identifying the destination device and, optionally, device attributes
z 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.
310 S1A34009 07/2012

Explicit Messaging
Sending Explicit Messages

The following steps explain how to execute the EtherNet/IP explicit message,
depicted above:
Step Action
1 In the DTM Browser, select the communication module that is upstream of the target device.
2 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.
3 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 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.
Instance 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 Select the service the explicit message is intended to perform. In this example:
Get_Attribute_Single.
Enter Path (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.
Data The data to be sent to the target device, for services that send data. In this example, leave
blank.
Messaging Select the type of explicit message to send:
z Connected
z Unconnected
In this example, select Unconnected.

Repeat 500 ms Select this check box to re-send the explicit message every 500 ms. In this example, leave
this blank.
4 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.
5 Click Close to close the window.
S1A34009 07/2012 311

Explicit Messaging
Sending Explicit Messages to Modbus TCP Devices
Overview
Use the Modbus Explicit Message window to send an explicit message from Unity
Pro 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
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.
312 S1A34009 07/2012

Explicit Messaging
Sending Explicit Messages

To send an explicit message to a target Modbus TCP device:
Step Action
1 In the DTM Browser, select the communication module that is upstream of the
target device.
Modbus Explicit Message.
Result: The Modbus Explicit Message window opens.
3 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 A component of the addressing path. In this example
5391.
Quantity A component of the addressing path. In this example 2.
Read Device (read-only) The service the explicit message is intended to
Id Code perform. In this example Basic Device Identity. Not used
in this example.
Object Id (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:
z 255 (the default) used to access the Ethernet
communication module itself
z 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 Select the service the explicit message is intended to
perform. In this example ReadHoldingRegisters
Repeat 500ms Select this check box to re-send the explicit message
every 500 ms. Leave this check box de-selected.
4 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.
5 Click Close to close the window.
S1A34009 07/2012 313

Explicit Messaging
314 S1A34009 07/2012

Modicon M340
Diagnostics
S1A34009 07/2012
Diagnostics
9
Overview
This chapter describes methods of diagnosing the condition of the Ethernet
communication module provided by the:
z Ethernet communication module hardware, and
z Unity Pro configuration software

Section Topic Page
9.1 Module Hardware Diagnostics 316
9.2 Unity Pro Software Diagnostics 318
9.3 CPU I/O Block Diagnostics 344
S1A34009 07/2012 315

Diagnostics
9.1 Module Hardware Diagnostics
LED Indicators for the BMX NOC 0401
LED Indicators
The BMX NOC 0401 module displays the following indicators in the LED display
area:
The module also displays the following LED indicators next to each Ethernet port
connector:
LED Descriptions
Use the LED display to diagnose the state of the module, as follows:
LED Color Description

RUN Green z Off: Indicates that the module is not communicating with the CPU over the
backplane.
z Steady Green: Indicates that the module:
z has just been turned on and has not yet started the LED power-up test, or
z is communicating with the CPU over the backplane
ERR Red z Off: The module is operating normally.

z Blinking Red: The module is not configured (or the configuration is in progress),
or backplane communication has stopped.
z Steady Red: The module has detected an event.
316 S1A34009 07/2012

Diagnostics
LED Color Description

MS Green/ z Off: Power is not being supplied to the module.
(Module Status) Red z Steady Green: The module is operating normally.
z Blinking Green: The module has not been configured.
z Steady Red: The module has detected a major event.
z Blinking Red: The module has detected a recoverable event.
NS Green/ z Off: Power is not being supplied to the module, or the module has not been
(Network Status) Red assigned an IP address.
z Steady Green: The module has established at least one CIP connection.
z Blinking Green: The module has obtained an IP address but has not established
any CIP connections.
z Steady Red: The module has detected that its IP address is a duplicate IP
address.
z Blinking Red: One or more CIP connection (with the module as target) have
timed out.
ETH STS Amber z Off: No power is supplied to the module.
(Ethernet Status) z Steady Amber: Indicates that the module is operating normally.
z Four flashes: The module has detected a duplicate IP address.
z Five flashes: The module is waiting for a served IP address.
z Six flashes: The module is using its default IP address.
z 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.
LNK (Link) Yellow/ z Off: An Ethernet link has not been established.
Green z Yellow: A 10 Mbit Ethernet link has been established
z Green: A 100 Mbit Ethernet link has been established
ACT (Activity) Green z Off: There is no receive or transmit activity.

z Flashes Green: Indicates activity.
S1A34009 07/2012 317

Diagnostics
9.2 Unity Pro Software Diagnostics
Overview
This section describes the diagnostic tools, provided by the Unity Pro configuration
software, that you can use to monitor the condition of the Ethernet communication
module.

Topic Page
Using the Diagnostic Window 319
Ethernet Port Diagnostics 321
Bandwidth Diagnostics 325
Email Diagnostics 328
Network Time Service Diagnostics 330
Communication Module RSTP Diagnostics 333
Local Slave / Connection Diagnostics 336
Local Slave or Connection I/O Value Diagnostics 340
Logging 342
318 S1A34009 07/2012

Diagnostics
Using the Diagnostic Window
Introduction
Use the Diagnostic window to display:
z LED icons (in the left pane of the window) that indicate the operating status of
modules, devices and connections
z pages (in the right pane of the window) that present diagnostic data for the
following:
z the communication module
z local slave nodes activated for the communication module
z 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
The Diagnostic window looks like this:
S1A34009 07/2012 319

Diagnostics
To open the Diagnostic window:
Step Action
1 In the DTM Browser, select the communication module and click the right
2 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, Unity Pro 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.
Unity Pro 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 Indicates the following state for a...

icon... Communication module Connection to a remote device
Run state 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).
One of the following: The health bit for at least one EtherNet/IP
z unknown connection or Modbus TCP request, to a remote
z started device or to a sub-device or module, is set to
z stopped inactive (0).
z not connected
320 S1A34009 07/2012

Diagnostics
Ethernet Port Diagnostics
Introduction
Use the Ethernet Diagnostic page to display either dynamically generated or static
data for the communication module’s Ethernet port(s). The page displays five
columns of data, as follows:
z one column for an module’s Internal Port, and
z up to four columns for the enabled external Ethernet ports (ports 1, 2, 3 and 4
Use the Refresh Every 500ms checkbox to display static or dynamic data, as
follows:
When the checkbox is... This page...

Selected z Displays data that is dynamically updated every 500 ms,
and
z Increments the number at the top of the table each time
data is refreshed
De-selected z Displays static data, and
z Does not Increment the number at the top of the table,
which instead displays a constant value
S1A34009 07/2012 321

Diagnostics
The Ethernet Diagnostic page looks like this:
To open this page:
Step Action
3 In the left pane of the Diagnostic window, select the communication module
node.
4 Click on the Ethernet Diagnostic tab to open that page.
322 S1A34009 07/2012

Diagnostics
Ethernet Diagnostic Parameters

The Ethernet Diagnostic page displays the following parameters for each
communication module port:
General parameters:
Interface Speed Valid values include: 0, 10, 100 Mbits/second
Interface Flags 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 detected (see below)
Duplex Mode 0 = half duplex; 1 = full duplex
Negotiation Status 3 = successfully negotiated speed and duplex
4 = forced speed and link
Manual Setting Requires 0 = automatic; 1 = device requires reset
Reset
Local Hardware Fault 0 = no event; 1 = event detected
Physical Address Module MAC Address
Input parameters:
Octets Octets received on the interface
Unicast Packets Unicast packets received on the interface
Non-Unicast Packets Non-unicast packets received on the interface
Discards Inbound packets received on the interface, but discarded
Errors Inbound packets that contain detected errors (does not include In Discards)
Unknown Protocols Inbound packets with unknown protocol
Output parameters:
Octets Octets received on the interface
Unicast Packets Unicast packets received on the interface
Non-Unicast Packets Non-unicast packets received on the interface
Discards Inbound packets received on the interface, but discarded
Errors Outbound packets that contain detected errors (does not include In Discards)
Unknown Protocols Outbound packets with unknown protocol
S1A34009 07/2012 323

Diagnostics
Error counter parameters:
Alignment Errors Frames that are not an integral number of octets in length
FCS Errors Frames received with a detected FCS checksum error
Single Collisions Successfully transmitted frames that experienced exactly one collision
Multiple Collisions Successfully transmitted frames that experienced more than one collision
SQE Test Errors Number of times the SQE test error is detected
Deferred Transmissions Frames for which first transmission attempt is delayed because the medium is busy
Late Collisions Number of times a collision is detected later than 512 bittimes into the transmission of
a packet
Excessive Collisions Frames for which transmission is not successful due to excessive collisions
MAC Transmit Errors Frames for which transmission is not successful due to 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 is not successful due to an internal MAC
sublayer receive detected error
324 S1A34009 07/2012

Diagnostics
Bandwidth Diagnostics
Introduction
Use the Bandwidth Diagnostic page to display either dynamically generated or
static data for the communication module’s bandwidth usage.
follows:

and
data is refreshed
S1A34009 07/2012 325

Diagnostics
The Bandwidth Diagnostic page looks like this:
To open this page:
Step Action
2 In the menu, select Device menu →Diagnostic. The Diagnostic window
opens.
node.
4 Click on the Bandwidth Diagnostic tab to open that page.
326 S1A34009 07/2012

Diagnostics
Bandwidth Diagnostic Parameters

The Bandwidth Diagnostic page displays the following parameters for the
I/O - Scanner:
EtherNet/IP Sent The number of EtherNet/IP packets the module has sent, since the last reset, in
packets/second.
EtherNet/IP Received 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 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 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 The maximum number of packets that the module can process, in packets per second.
Module Utilization The percentage of communication module capacity being used by the application.
Messaging - Client:
EtherNet/IP Activity The number of I/O messages sent by the module—using the EtherNet/IP protocol—
since last reset, in packets per second.
Modbus TCP Activity 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 The number of I/O messages received by the module—using the EtherNet/IP
protocol—since last reset, in packets per second.
Modbus TCP Activity 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.
S1A34009 07/2012 327

Diagnostics
Email Diagnostics
Diagnosing SMTP Transmissions

Use the Email Diagnostic page to display dynamically generated data describing
the communication module’s Email message transmissions.
The Email Diagnostic page looks like this:
Click the Reset Counter button to reset the counting statistics on this page to 0.
To open this page:
Step Action
1 In the DTM Browser, select the communication module and click the right mouse button. A pop-up menu
opens.
2 In the menu, select Device menu →Diagnostic. The Diagnostic window opens.
3 In the left pane of the Diagnostic window, select the communication module node.
4 Click on the Email Diagnostic tab to open that page.
328 S1A34009 07/2012

Diagnostics
Email diagnostic Parameters

Email service parameters include the following:
Refresh Every 500ms Select this to dynamically update this page every 500ms.
The number of times this page has been refreshed appears
immediately to the right (in this example, 192.
Email Service The status of this service in the Ethernet communication
module:
z green = operational (OK)
z orange = not operational (NOK)
Remote Email Server Status The connection status between Ethernet communication
module and the SMTP server:
z green = operational (OK)
z red = not operational (NOK)
NOTE: Status is checked at start-up and at least every 30

minutes after start-up.
SMTP Server IP Address IP address of the SMTP server
Sender The three header fields of the last Email message sent.
Receivers
Subject
Number of Emails Sent Total number of emails sent and successfully acknowledged
by the SMTP server.
Time Since Last Email Counts the number of seconds since the last email was
successfully sent.
Last Error Hexadecimal code describing the reason for the last
unsuccessful Email transmission (see page 421). The value
“0” indicates no unsuccessful transmissions.
Time Since Last Email Counts the number of seconds since the last email was
successfully sent.
Number of Errors Total number of emails that either:
z could not be sent
z were sent but were not successfully acknowledged by the
SMTP server
Email Service Not Reachable Number of times the SMTP server could not be reached.
(Link checked every 30 minutes.)
S1A34009 07/2012 329

Diagnostics
Network Time Service Diagnostics
Diagnosing the Network Time Service

Use the Network Time Service Diagnostic page to display dynamically generated
data describing the operation of the network time protocol (NTP) service that you
configured in the Network Time Service page (see page 101) in Unity Pro.
The Network Time Service Diagnostic page looks like this:
Click the Reset Counter button to reset the counting statistics on this page to 0.
To open this page:
Step Action
1 In the DTM Browser, select the communication module and click the right mouse button. A pop-up
menu opens.
2 In the menu, select Device menu →Diagnostic. The Diagnostic window opens.
3 In the left pane of the Diagnostic window, select the communication module node.
4 Click on the NTP Diagnostic tab to open that page.
330 S1A34009 07/2012

Diagnostics
Network Time Service Diagnostic Parameters

Time synchronization service parameters are in the table:
Refresh Every 500ms Select this to dynamically update this page every 500ms. The number of times this page has
been refreshed appears immediately to the right (in this example, 785).
Network Time Service Operational status of the service in the module:
z green = operational
z orange = not operational
Network Time Server Communication status of the NTP server:

Status z green = the NTP server is reachable
z red = the NTP server is not reachable
Last Update Elapsed time, in seconds, since the most recent NTP server update.
Current Date System date
Current Time System time in hh:mm:ss format
DST Status The actual working status of the automatic daylight savings service:
z ON = automatic adjustment of daylight savings is enabled and the current date and time
reflect the daylight savings time adjustment
z OFF = automatic adjustment of daylight savings is disabled; or automatic adjustment of
daylight savings is enabled, but the current date and time may not reflect the daylight
savings time adjustment
Quality The correction, in seconds, applied to the local counter at every NTP server update.Numbers
greater than 0 indicate increasingly excessive traffic condition or NTP server overload.
Requests Total number of client requests sent to the NTP server
Responses Total number of server responses sent from the NTP server
Errors Total number of unanswered NTP requests
Last Error Last detected error code received from the NTP client:
z 0: good NTP configuration
z 1: late NTP server response (can be caused by excessive network traffic or server
overload)
z 2: NTP not configured
z 3: invalid NTP parameter setting
z 4: NTP component disabled
z 7: unrecoverable NTP transmission
z 9: invalid NTP server IP address
z 15: invalid syntax in the custom time zone rules file
Primary / Secondary The IP address of the primary and the secondary NTP server
NTP Server IP NOTE: A green LED to the right of the primary or secondary NTP server IP address identifies
the currently active server.
Auto Adjust Clock for The configuration setting of the daylight savings adjustment service:
Daylight Savings z enabled
z disabled
S1A34009 07/2012 331

Diagnostics
DST Start / DST End Specifies the day that daylight savings time begins and ends:
Month The month daylight savings time starts or ends
Day of Week The day of the week daylight savings time starts or ends
Week# The occurrence of the specified day within the specified month.
Time Zone Time zone plus or minus Universal Time, Coordinated (UTC)
Offset The time, in minutes, to be combined with the selected Time Zone selection to produce the
system time.
Polling Period The frequency the NTP client requests time updates from the NTP server
332 S1A34009 07/2012

Diagnostics
Communication Module RSTP Diagnostics
Introduction
Use the RSTP Diagnostic page to display either dynamically generated or static
data for a BMX NOC 0401 (M340) communication module’s RSTP service.
follows:

and
data is refreshed
communication module to the physical module. To do this, select the module node
in the DTM Browser, then select Edit →Connect.
S1A34009 07/2012 333

Diagnostics
The RSTP Diagnostic page looks like this:
To open this page:
Step Action
node.
4 Click on the RSTP Diagnostic tab to open that page.
334 S1A34009 07/2012

Diagnostics
RSTP Diagnostic Parameters

The RSTP Diagnostic page displays the following parameters for each
communication module port:
Bridge RSTP Diagnostic:
Bridge ID An 8-byte bridge identification field is comprised of a 2 sub-fields:
z Bridge Priority: a 2-byte value from 0 to 65535—with a default of
32768—assigned to the module’s embedded Ethernet switch
z MAC Address (see below)
MAC Address The Media Access Control address of a device, found on the front of
the module.
Designated Root ID The Bridge ID of the root switch.
Root Path Cost The aggregate cost of port costs from this switch back to the root
switch.
Default Hello Time The interval at which Configuration BPDU messages will be
transmitted during a network convergence. For RSTP this is a fixed
value of 2 seconds.
Learned Hello Time The current Hello Time value learned from the root switch.
Configured Max Age The value that other switches use for MaxAge when this switch is
acting as the root. Valid range: 6 to 40
Learned Max Age The maximum age learned from the root switch. This is the actual
value currently used by this switch.
Total Topology The total number of topology changes detected by this switch since
Changes the management entity was last reset or initialized.
Ports 3 and 4 RSTP Statistics:
Status The port’s current state as defined by RSTP Protocol. This state
controls the action the port takes when it receives a frame. Possible
values are: disabled, discarding, learning, forwarding.
Role: The port’s current role per RSTP protocol. Possible values are: root
port, designated port, alternate port, backup port, disabled port.
Cost The logical cost of this port as a path to the root switch. If this port is
configured for AUTO then the cost is determined based on the
connection speed of the port.
STP Packets A value in this field indicates that a device on the network has the
STP protocol enabled.
NOTE:
z Other devices, with STP enabled, can severely affect the network
convergence times. Schneider Electric recommends the STP
protocol (but not the RSTP protocol) be disabled on every
network device capable of supporting it.
z The communication module does not support the STP protocol.
The module’s embedded switch ignores ignore STP packets.
S1A34009 07/2012 335

Diagnostics
Local Slave / Connection Diagnostics
Introduction
The Local Slave Diagnostic page and the EIP Connection Diagnostic page
present common information. Use the:
z Local Slave Diagnostic page to display I/O status and production/consumption
information for a selected local slave
z EIP Connection Diagnostic page to display I/O status and
production/consumption information for a connection of a remote EtherNet/IP
device
follows:

and
data is refreshed
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.
336 S1A34009 07/2012

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.)
To open this page:
Step Action
1 In the DTM Browser, select the communication module and click the right mouse
button. A pop-up menu opens.
3 In the left pane of the Diagnostic window, click on one of the following:
z for local slave diagnostics, select the communication module node
z for remote device connection diagnostics, select a remote device connection
4 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.
S1A34009 07/2012 337

Diagnostics
Diagnostic Parameters
This page displays the following diagnostic parameters for the selected local slave
or connection:
Status (see page 339):
Input An integer representing input status.
Output An integer representing output status.
General An integer representing basic connection status.
Extended An integer representing extended connection status.
Counter:
Frame Error Increments each time a frame is not sent by missing resources or is impossible to send.
Time-Out Increments each time a connection times out.
Refused Increments when connection is refused by the remote station.
Production Increments each time a message is produced.
Consumption Increments each time a message is consumed.
Production Byte Total of produced messages, in bytes, since the communication module was last reset.
Consumption Byte Total of consumed messages, in bytes, since the communication module wa last reset.
Theoretical Packets per Packets per second calculated sing current configuration value.
second
Real Packets per Actual number of packets per second generated by this connection.
second
Diagnostic:
Production Connection The connection ID.
ID
Consumption The connection ID.
Connection ID
O -> T API Accepted packet interval (API) of the output connection.
T -> O API Accepted packet interval (API) of the input connection.
O -> T RPI Requested packet interval (RPI) of the output connection.
T -> O RPI Requested packet interval (RPI) of the input connection.
Socket Diagnostics:
Socket ID Internal Identification of the socket.
Remote IP Address IP address of the remote station, for this connection.
Remote Port Port number of the remote station, for this connection.
Local IP Address IP address of the communication module, for this connection.
Local Port Port number of the communication module, for this connection.
338 S1A34009 07/2012

Diagnostics
Connection Status Codes

The Input and Output Status diagnostic parameters (see page 338), in the
preceding table, can present the following values:
Input/Output Status (dec) Description

0 OK
33 Time-out
53 IDLE
54 Connection established
58 Not connected (TCP)
65 Not connected (CIP)
68 Connection establishing
70 Not connected (EPIC)
77 Scanner stopped
S1A34009 07/2012 339

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.
follows:

and
data is refreshed
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 Action
3 In the left pane of the Diagnostic window, click on one of the following:
z the communication module node, or
z a connection node
4 Click on the I/O Values tab to open that page.
340 S1A34009 07/2012

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:
Input/Output A display of the local slave or remote device input or output data
data display image.
Length The number of bytes in the input or output data image.
Status The Scanner Diagnostic object’s scanner status (see page 255),
with respect to the read of the input or output data image.
S1A34009 07/2012 341

Diagnostics
Logging
Description
Unity Pro maintains a log of events for:
z the Unity Pro embedded FDT container
z each Ethernet communication module DTM, and
z each EtherNet/IP remote device DTM
Events relating to the Unity Pro 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:
z in configuration mode: in the Device Editor, by selecting the Logging node in
the left pane
z 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:
342 S1A34009 07/2012

Diagnostics
Logging Attributes
The Logging window displays the result of an operation or function performed by
Unity Pro. Each log entry includes the following attributes:
Attribute Description
Date/Time The time the event occurred, displayed in the format: yyyy-mm--dd
hh:mm:ss
Log Level The level of event importance. Values include:
Information A successfully completed operation.
Warning An operation that Unity Pro completed, but which may
lead to a subsequent detected error.
Error An operation that Unity Pro was unable to complete.
Message A brief description of the core meaning of the event.
Detail Message A more detailed description of the event, which may include parameter
names, location paths, etc.
S1A34009 07/2012 343

Diagnostics
9.3 CPU I/O Block Diagnostics
Overview
The CPU’s I/O Block contains diagnostic information relating to the operation of the
BMX NOC 0401 Ethernet communication module. This information can be
accessed in Unity Pro at runtime. This section describes the available I/O Block
data, and how to access it.

Topic Page
Accessing the Unity Pro Diagnostic Tools 345
Communication Channel Diagnostics in Unity Pro 348
Communication Module Diagnostics in Unity Pro 350
344 S1A34009 07/2012

Diagnostics
Accessing the Unity Pro Diagnostic Tools
Overview
The Unity Pro software provides diagnostic tools that let you view the:
z communication module status
z communication module’s:
z detected faults
z I/O objects
z communication channel’s:
z MAC Address
z IP Address settings
z detected faults
These Unity Pro diagnostic tools are available in the BMX NOC 0401 Module
Properties window, only when Unity Pro is operating online.
NOTE: If the module and software are disconnected, use the Master DTM
diagnostic screen in Unity Pro to check the I/O status.
Accessing Unity Pro Diagnostic Tools

To access diagnostic tools for the Ethernet communication module:
Step Action
1 Open the Unity Pro project backplane diagram, below:
S1A34009 07/2012 345

Diagnostics
Step Action
z double click the left mouse button on the communication module in the
window above, or
z click the right mouse button on the communication module, then select
Open Module... in the popup menu
The Ethernet Module window opens:
346 S1A34009 07/2012

Diagnostics
Step Action
3 Navigate the Ethernet Module window using the following features:
1 Module status icons These three indicators display the module’s status in
online mode.
2 Channel area Select a node to display parameters for either:
z the communication module, or
z a communication channel
3 Page tabs Select a page to display module or channel

properties:
z for the communication module:
z Overview
z Fault
z I/O Objects
z for a communication channel:

z Configuration
z Debug
z Fault
4 General parameters View communication channel parameters:

z Function displays the configured communication
function and is read-only.
z Task displays the task (configured MAST) and is
read-only.
5 Mode parameters Displays parameters for the mode you select by
opening a page.
S1A34009 07/2012 347

Diagnostics
Communication Channel Diagnostics in Unity Pro
Overview
Select a communication channel in the Channel area to access the:
z Configuration page, where you can:
z edit the EtherNet/IP Module name
z edit input and output data size and location settings
z launch the Unity Pro EtherNet/IP configuration tool
Refer to the description of the Configuration page (see page 36) for more
information.
z Debug page, which displays the communication module’s:
z MAC Address
z IP Address settings
z Fault page, which displays active detected faults for the communication channel
MAC Address
To display the MAC Address of the communication module:
Step Action
1 In the Channel area, select the communication channel. The following pages
are displayed:
z Configuration
z Debug
z Default
2 To display the communication module’s MAC Address and IP Address settings,

click on the Debug page:
348 S1A34009 07/2012

Diagnostics
Channel Detected Faults

To display the active faults detected on the communication channel:
Step Action
1 In the Channel area, select the communication channel.
2 To display the communication module’s detected active faults, click on the Fault
page:
NOTE: You can also access the channel detected error bit (CH_ERROR) by using
the Unity Pro Animation Table to display the %Ir.m.ch.ERR object.
S1A34009 07/2012 349

Diagnostics
Communication Module Diagnostics in Unity Pro
Overview
Use the Ethernet Module window in Unity Pro to diagnose the BMX NOC 0401
Ethernet communication module. In this window, you can access:
z three icons that reflect the current status of selected LEDs
z the Overview page, where you can view a description of the module
z Fault page, which displays detected active faults for the communication module
z I/O Objects page, where you can view and manage I/O objects for the module
Module Status Icons

The Ethernet Module window displays three icons that reflect the current status of
the following LEDs:
z Run
z ERR
z STS
Refer to the description of LED indicators (see page 316) for information on how to
use these icons.
350 S1A34009 07/2012

Diagnostics
Accessing Module Detected Faults

To display the detected active faults on the communication module:
Step Action
1 In the Channel area, select the communication module. The following pages
are displayed:
z Overview
z Fault
z I/O Objects
2 To display the communication module’s active detected faults, click on the Fault
page:
NOTE: You can also access the module detected error bit by using the Unity Pro
Animation Table to display the %Ir.m.MOD.ERR object.
S1A34009 07/2012 351

Diagnostics
Managing I/O Objects

Use the I/O Objects page to view module I/O objects, and to manage the association
of these objects with variables.
Open the I/O Objects page by selecting the I/O Objects tab, after the
communication module has been selected in the Channel area:
NOTE:
z The BMX NOC 0401 communication module supports only Channel, System,
and Status I/O Objects. Not every bit is used.
z Refer to the Unity Pro help for instructions on how to use the I/O Objects page.
352 S1A34009 07/2012

Diagnostics
Reading I/O Objects

Use a READ_STS function block in Unity Pro to update each of the following types
of data:
z module data
z channel data
Updating module data:
To display module information, follow these steps:
Step Action
1 Configure the READ_STS function block, as follows:
Where:
r = rack or station number
m = module or slot number
MOD = a constant indicating module data
2 To view the data updated by the READ_STS function block, enter the corresponding
direct addresses in the Unity Pro Animation table, or use them in your program logic:
Object Description
%Ir.m.MOD.ERR Module detected error bit
%Ir.m.MOD.ERR is implicitly updated based on %Ir.m.0.ERR
%MWr.m.MOD.0 Exchange Status:
Bit 0: reading of module status in progress
%MWr.m.MOD.1 Exchange Report:
Bit 0: detected error while reading module status
%MWr.m.MOD.2 Bit 0: internal fault detected
Bit 1: operational fault detected
Bit 2: not used
Bit 3: self test
Bit 4: not used
Bit 5: configuration fault detected
Bit 6: missing module or off
Bit 7: not used
S1A34009 07/2012 353

Diagnostics
Updating channel data:

To display channel information, follow these steps:
Step Action
1 Configure the READ_STS function block, as follows:
Where:
r = rack, or station, number
m = module, or slot, number
ch = channel number—set to 0 for ETC transactions
2 To view the data updated by the READ_STS function block, enter the corresponding
direct addresses in the Unity Pro Animation table, or use them in your program logic:
Object Description Standard Symbol
%Ir.m.ch.ERR Channel detected error bit CH_ERROR
%Ir.m.ch.0 Status of Ethernet services: —
Bit 0: EIP Scanner (0 = OK, 1 = NOK) —
Bit 1: EIP Adapter (0 = OK, 1 = NOK) —
Bit 2: EIP Client (0 = OK, 1 = NOK) —
Bit 3: EIP Server (0 = OK, 1 = NOK) —
Bit 4: Modbus scanner (0 = OK, 1 = NOK) —
Bit 5: Modbus TCP Client (0 = OK, —
1 = NOK)
Bit 6: Modbus TCP Server (0 = OK, —
1 = NOK)
Bit 7: FDR Server (0 = OK, 1 = NOK) —
Bit 8: RSTP (0 = OK, 1 = NOK) —
Bit 9–Bit 15: reserved —
%MWr.m.ch.0 Exchange Status: EXCH_STS
Bit 0: reading of status words of the channel STS_IN_PROG
in progress
Bit 1: command write in progress CMD_IN_PROG
%MWr.m.ch.1 Exchange Report: EXCH_RPT
Bit 0: detected error while reading channel STS_ERR
status
Bit 1: detected error while writing a CMD_ERR
command to the channel
354 S1A34009 07/2012

Diagnostics
Step Action
2 %MWr.m.ch.2 Standard channel status (low byte): —
cont’d Bits 0...3: reserved (0) —
Bit 4: internal fault detected —
Bit 5: not used (0) —
Bit 6: X-Bus communication fault detected —
Bit 7: application fault detected —
(conf fault detected)
High byte: —
Bits 0...7: reserved (0) —
%MWr.m.ch.3 Ethernet Port Global Status: ETH_PORT_STATUS
Bit 0: detected configuration error —
Bit 1: the Ethernet interface is disabled —
Bit 2: duplicate IP address detected —
Bit 3: configuration mismatch —
Bit 4: reserved —
Bit 5: the module is in the process of —
obtaining an IP address
Bits 6...15: reserved —
%MWr.m.ch.4 IP address (IP_ADDR): IP_ADDR
z During normal operation, the double —
word %MDr.m.c.4 contains the IP
address configured or served to the
module.
z In No Configuration state, the double —
word %MDr.m.c.4 contains the default
IP address of the module.
z In Configuration Error detected state, —
the double word %MDr.m.c.4 contains
the default IP address of the module.
z When a duplicate IP address is —
detected, the double word %MDr.m.c.4
contains the served or configured
duplicate IP address.
z When the module is waiting for a —
BOOTP response, the double word
%MDr.m.c.4 contains the IP address
0.0.0.0.
S1A34009 07/2012 355

Diagnostics
356 S1A34009 07/2012

Modicon M340
Replacing the Communication Module
S1A34009 07/2012
Replacing the Ethernet

Communication Module
10
Replacing the Ethernet Communication Module
Overview
Replacing The module involves removing the old module and mounting a new one
in its place
When to Replace
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:
z off (cold swap), or
z 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: Operating parameters, that were added to the configuration using explicit
messaging “SET” commands, are not included in the parameters that the CPU
sends to a replacement module.
To install the replacement module, follow the instructions in the module mounting
procedure (see page 21).
S1A34009 07/2012 357

Replacing the Communication Module
358 S1A34009 07/2012

Modicon M340
Embedded Web Pages
S1A34009 07/2012
Embedded Web Pages
11
Overview
This chapter describes the embedded web pages for the BMX NOC 0401 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.

Section Topic Page
11.1 Accessing the Embedded Web Server 360
11.2 Monitoring the Unity Pro Application 368
11.3 Diagnostics 381
S1A34009 07/2012 359

Embedded Web Pages
11.1 Accessing the Embedded Web Server
Introduction
This section introduces the BMX NOC 0401 communication module’s embedded
web server, and describes how to access—and to control access to—the web
pages.

Topic Page
Introducing the Embedded Web Pages 361
Accessing the Home Page 362
Using and Editing a Username and Passwords 363
Configuring Port Mirroring 366
360 S1A34009 07/2012

Embedded Web Pages
Introducing the Embedded Web Pages
Introduction
Use the BMX NOC 0401 Ethernet communication module’s embedded web server
pages to:
z display real-time diagnostic data for both the module and other networked
devices
z read the values of—and write values to—Unity Pro application variables
z manage and control access to the embedded web pages by assigning separate
passwords for:
z viewing the diagnostic web pages, and
z using the Data Editor to write values to Unity Pro 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.
S1A34009 07/2012 361

Embedded Web Pages
Accessing the Home Page
On First Use
Before you begin to use the BMX NOC 0401 communication module’s embedded
web pages, you need to:
z navigate to the web server (see page 362)
z access web page content by inputting the default username and password
(see page 363) combination
z change passwords (see page 364) that are required for:
z accessing web pages, and
z writing data values using the Data Editor
Navigating to the Web Server

To access the embedded web server, open an Internet browser, then enter the
IP address (see page 67) 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:
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.
362 S1A34009 07/2012

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:
z an HTTP access password, which grants read-only access to web page content
z 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 Description
1 After navigating to the embedded web server (see page 362), select one of the main menu selections
(for example, Setup).
2 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.
S1A34009 07/2012 363

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, (see page 362) using the IP address of the
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 (see page 363).
The Setup page opens:
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:
364 S1A34009 07/2012

Embedded Web Pages
Step Description
4 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: z To change the username: type in a new username
z To retain the current username (for example, if you are
changing only the password): type in the current username
New password: z To change the password: type in a new password
z To keep the current password (for example, if you are
changing only the username): type in the current password
Confirm Type in the same password entered in the New password field,
password: above.
5 Click the Save User button.
6 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 Type in the current password that is required to write data using
password: the Data Editor.
New write Type in the new Data Editor password.
password:
Confirm write Type in the same password entered in the New write password
password: field, above.
7 Click the Change Write Password button.
S1A34009 07/2012 365

Embedded Web Pages
Configuring Port Mirroring
Enabling Port Mirroring in Unity Pro

You can use the port mirroring service to duplicate the traffic entering and exiting
any one of the four Ethernet ports (the source port) onto another one of the ports
(the destination port), for the purpose of diagnosing the source port.
NOTE:
z Verify that the port mirroring service is enabled in Unity Pro (see page 75) before
configuring it in the web pages.
z You can designate only non-RSTP enabled ports as the destination port.
z The port mirroring configuration settings are transient, and are cleared when you
reboot the Ethernet communication module.
Configuring Port Mirroring in the Web Pages

To configure port mirroring, follow these steps:
Step Description
1 In Unity Pro, enable the port mirroring service (see page 75) to globally enable port
mirroring.
2 Navigate to and open the web server, (see page 362) using the IP address of the
communication module. The Home page opens.
3 From the Home page, click on the Setup main menu item. If required, input the
username and web page password (see page 363). The Setup page opens:
366 S1A34009 07/2012

Embedded Web Pages
Step Description
4 On the left side of the page, click on the Port Mirroring node. The Port Mirroring
page opens:
5 Configure the following fields:

Enable: Place a check mark in this field to enable port mirroring.
(Default = de-selected.)
Source: Select a port (1...4). The traffic from this port will be duplicated and
sent to the destination port for diagnosis.
Destination: Select a port—other than the source port—to receive the
duplicated traffic of the source port. Only ports with RSTP
disabled can be selected.
6 Click the Save button.
S1A34009 07/2012 367

Embedded Web Pages
11.2 Monitoring the Unity Pro Application
Overview
This section describes how to use the BMX NOC 0401 Ethernet communication
module’s embedded web pages to monitor the Unity Pro application.

Topic Page
Using the Monitoring Page 369
Data Editor (Standard) 370
Working With Data Templates 375
Data Editor (Lite) 379
368 S1A34009 07/2012

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:

z Data Editor Lite
z Data Editor Standard
S1A34009 07/2012 369

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.
z Use passwords to strictly limit access to write data functionality.
z Do not use weak passwords, including the default password and other obvious
passwords.
z 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.
370 S1A34009 07/2012

Embedded Web Pages
Data Editor
The Data Editor presents the following controls:
1 Toolbar
2 Data template list
3 Data template
4 Configuration Area
Toolbar
The Data Editor toolbar presents the following features:
Command or Field Icon Description

New z 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.
z If a row in the currently open data template is selected,
this command inserts a new row below the selected row.
Save Saves changes made to both the data template list and
each data template.
Copy z If a node in the data template list is selected, this
command copies the selected data template.
z If an item (or row) in the currently open data template is
selected, this command to copies the selected item.
S1A34009 07/2012 371

Embedded Web Pages
Command or Field Icon Description

Paste z If the root, or Empty, node is selected in the data
template list, this command pastes a previously copied
data template into the list.
z 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.
Delete Deletes the selected data template from the list, or the
selected item from the data template.
Change password Opens the Change password dialog, where you can
change the Data Editor Write (see page 364) password.
NOTE: The Data Editor Write password can also be
changed in the Setup →Security web page.
Read PLC symbols Loads the existing Unity Pro 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.
Start animation 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.
Stop animation 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.
Rate — The refresh rate of the dynamic display of data template
items, in milliseconds.
IP address — 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:
z previously saved, or
z 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.
372 S1A34009 07/2012

Embedded Web Pages
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 Description
Symbol Contains the names of Unity Pro symbols (variables).
Address Contains direct addresses and the addresses of Unity Pro symbols (variables).
Any direct address can be viewed by entering its reference in this field. Valid
direct addresses include:
%Mi same as for 0X coils
%Ii same as 1x for discreet inputs
%IWi same as 3x for input registers
%MWi, %MDi, %MFi same as 4x for holding registers
NOTE:
z 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.
z 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].
Data type 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 16-bit signed integer
UINT 16-bit unsigned integer
DINT 32-bit signed integer
UDINT 32-bit unsigned integer
REAL 32-bit IEEE floating point
TIME 32-bit unsigned integer (in ms)
DATE Date (32-bit BCD)
TOD Time of day (32-bit BCD)
BOOL 1 bit discrete (Boolean)
Value When animation has started, this field displays the value of the symbol
(variable) or direct address. This field is updated continuously.
S1A34009 07/2012 373

Embedded Web Pages
Field Description
Format Contains the format type for displaying the value of the symbol (variable) or
direct address. The following formats are available:
bool Boolean
dec Decimal
hex Hexadecimal
binary Binary
ASCII bytes displayed as ASCII characters
time day_hr_min_sec_ms
date YYYY-MM-DD or HH:MM:SS
Status Contains messages describing the status of communication with the symbol
(variable) or direct address:
if communication is The status message reads OK
normal
if communication is The status field displays a system message
interrupted describing the interruption
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:
z create a new data template (see page 375)
z display the items contained in an existing data template (see page 376)
z add items to a data template, including:
z inserting a symbol (see page 377) (or variable) to a data template
z inserting a direct address (see page 377) to a data template
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.
374 S1A34009 07/2012

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 Description
1 Confirm that Data Editor animation is OFF. If necessary, click the Stop animation
toolbar button.
2
Click the New table toolbar button.
The New table dialog opens:
3 In the Table name field, type in the name of the new data template.
4 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.
Saving a Data Template

After you save a new data template, you can re-use it to view or modify its contents.
NOTE:
z 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.
z 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.
S1A34009 07/2012 375

Embedded Web Pages
To save a new data template, follow these steps:
Step Description
1 Click the Save toolbar button.
The Save application dialog opens:
2 In the Password field, type in the Web Page (HTTP) Access password.
NOTE: The default password is USER.
3 Click Ok.
The new data template is saved.
Displaying an Existing Data Template

When you open a saved data template, you can use it to:
z edit its contents by inserting either a variable or a direct address
z monitor the value and status of data items
z 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:
376 S1A34009 07/2012

Embedded Web Pages
Inserting a Symbol (Variable) Into a Data Template

You can add Unity Pro variables—also called symbols—into a data template. After
a variable is added, you can view or modify its value.
To add a symbol to a data template, follow these steps:
Step Description
1 In the data template spreadsheet, double-click on an empty row.
The Data Editor configuration area opens.
2 In the configuration area, click on the ellipsis button (...).
The Lookup Variable dialog opens:
3 Select the variable (symbol) you want to add to your data template.
4 Click OK.
The variable name is displayed in the Symbol field of the row selected in the
data template.
5 In the configuration area, click Apply. The selected row is updated.
6 Save your edits.
Inserting a Direct Address Into a Data Template

You can add Unity Pro 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:
Step Description
1 In the data template spreadsheet, double-click on an empty row.
The Data Editor configuration area opens.
2 In the Address field of the configuration area, type in the item’s direct address.
3 In the configuration area, click Apply. The selected row is updated.
4 Save your edits.
S1A34009 07/2012 377

Embedded Web Pages
Modifying Data Values Using a Data Template

You can use the Data Editor to write data values to a variable (symbol) or 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 Unity Pro application.
To use the Data Editor to edit data, follow these steps:
Step Description
1 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.
2 In the Value field, type in the desired data value.
3 Click Apply.
The Enter password dialog opens:
4 In the Password field, type in the Write Data password.

5 Click OK. The new value is sent to the controller.
378 S1A34009 07/2012

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 Type Display

%MW IEC internal word INT DECIMAL
%MD IEC double word DINT DECIMAL
%M IEC internal bits BOOL 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.
S1A34009 07/2012 379

Embedded Web Pages
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.
380 S1A34009 07/2012

Embedded Web Pages
11.3 Diagnostics
Overview
This section describes the diagnostic services provided by the BMX NOC 0401
Ethernet communication module.

Topic Page
Using the Diagnostics Page 382
Status Summary 383
Rack Viewer 386
Processor Load 388
Scanner Status 391
Messaging 393
QoS Configuration 395
Port Statistics 396
Redundancy 398
Email Diagnostics 399
Network Time Service Diagnostics 402
Properties 404
S1A34009 07/2012 381

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:

z Status Summary (see page 383)
z Rack Viewer (see page 386)
z Ethernet:
z Processor Load (see page 388)
z Scanner Status (see page 391)
z Messaging (see page 393)
z QoS Configuration (see page 395)
z Switch
z Port Statistics (see page 396)
z Redundancy (see page 398)
z Network Time Service (see page 402)

z Email (see page 399)
z Properties (see page 404)
382 S1A34009 07/2012

Embedded Web Pages
Status Summary
Introduction
Use the Status Summary page to view the status of:
z the LEDs (see page 316) located on the front of the BMX NOC 0401 Ethernet
z the Ethernet services (see page 75) supported by the communication module
z the communication module in its role as:
z scanner
z Modbus TCP server
z EtherNet/IP messaging server
Status Summary Display

The Status Summary page looks like this:
S1A34009 07/2012 383

Embedded Web Pages
To open this page:
Step Action
1 Starting at the Home page, click the Diagnostics main menu item. The
Diagnostics page opens.
2 On the left side of the Diagnostics page, select Ethernet →Status Summary.
3 If necessary, type in the HTTP web access password.
Status Summary Data

The LEDs section of the page can present the following operational states:
LED Color Text Descriptions

RUN Green Ready for operation
Gray Not ready for operation
ERR Red Fault detected
Gray No fault detected
ETH STS Green In operation
Red Duplicate IP
Waiting for BootP server response
Default IP Address in use
IP Address Configuration conflict detected
MS (module status) Green In operation
Red Not configured
Fault detected
Recoverable fault detected
NS (network status) Green Connections established
Red No EtherNet/IP connections
Connection error detected
Duplicate IP address
384 S1A34009 07/2012

Embedded Web Pages
The Services section of the page can present the following functional conditions:
Function Color Text Descriptions

DHCP Server — Enabled
FDR Server Disabled
QoS Tagging
IGMP Snooping
Access Control
Port Mirroring
RSTP
Network Time Service — Enabled
Email Service Disabled
Scanner Status Green Working properly
Red At least one connection is bad
Gray Not configured
S1A34009 07/2012 385

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 M340 rack.
To view information describing a specific module—including the BMX NOC 0401
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:
To open this page:
Step Action
2 On the left side of the Diagnostics page, select Rack Viewer.
386 S1A34009 07/2012

Embedded Web Pages
Rack Viewer Displaying the BMX NOC 0401

When you click on the BMX NOC 0401 in the rack display, the following web page
opens:
Click on the blue Back arrow to return to the rack display.
S1A34009 07/2012 387

Embedded Web Pages
Processor Load
Introduction
Use the Processor Load web page to display dynamically generated data for the
BMX NOC 0401 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:
z 90% to 100%—background color is RED
z 80% to 89.99%—background color is YELLOW
z 0% to 79.99%—background color is GRAY
388 S1A34009 07/2012

Embedded Web Pages
To open this page:
Step Action
2 On the left side of the Diagnostics page, select Ethernet →Processor Load.
Processor Load Parameters

The Processor Load page displays the following parameters for the communication
module:
Module Load:
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,
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,
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 The maximum number of packets that the module can
process, in packets per second.
Module Utilization The percentage of communication module capacity being
used by the application. The background color of the value
changes, depending on the percentage utilization.
S1A34009 07/2012 389

Embedded Web Pages
Messaging - Client:
EtherNet/IP activity The number of I/O messages sent by the module—using
the EtherNet/IP protocol—since last reset, in packets per
second.
Modbus TCP activity 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 The number of I/O messages received by the module—
using the EtherNet/IP protocol—since last reset, in packets
per second.
Modbus TCP activity The number of I/O messages received by the module—
using the Modbus TCP protocol—since last reset, in
packets per second.
390 S1A34009 07/2012

Embedded Web Pages
Scanner Status
Introduction
The Scanner Status web page displays read-only data describing the current state
of the BMX NOC 0401 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:
z I/O scanning status
z A value of Operational indicates that the values in the Scanner Status grid
are reporting the state of scanned devices.
z 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.
z Number of transactions per second
z Number of connections
The Scanner Status web page looks like this:
S1A34009 07/2012 391

Embedded Web Pages
In the Scanner Status grid, the colors that appear in each block indicate the
following states for specific remote devices:
z GREEN indicates that a device is being scanned
z BLACK indicates that I/O scanning of the specific device has been intentionally
disabled
z GRAY indicates an device that is not configured
z RED indicates a suspect device
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:
z MB: indicates a Modbus TCP connection
z EIP: indicates an EtherNet/IP connection
To open this page:
Step Action
2 On the left side of the Diagnostics page, select Ethernet →Scanner Status.
392 S1A34009 07/2012

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:
S1A34009 07/2012 393

Embedded Web Pages
The display grid provides the following information about each active connection:
z Conn.: the connection number—1 to 64
z 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.
z Remote port: the TCP port for the connection on the remote device
z Local port: the TCP port for the connection on the Ethernet communication
module
z Type: the connection type—EtherNet/IP or Modbus TCP
z Mess. Sent: the number of messages transmitted over this connection
z Mess. Received: the number of messages received by this connection
z Error Sent: the number of events detected on this connection
NOTE:
z 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.
z 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
To open this page:
Step Action
2 On the left side of the Diagnostics page, select Ethernet →Messaging.
394 S1A34009 07/2012

Embedded Web Pages
QoS Configuration
Introduction
The BMX NOC 0401 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 differentiated services code point (DSCP) tag to each Ethernet
packet it transmits, thereby indicating the priority of that packet.
The QoS Configuration page displays both the:
z status of the QoS Ethernet packet tagging service—enabled or disabled, and
z the QoS service configuration settings
NOTE: The QoS service is enabled in the Services page, and the configuration
settings are input in the QoS page, of the Unity Pro Ethernet Configuration Tool.
QoS Configuration Display

The QoS Configuration page looks like this:
This page is read-only.

To open this page:
Step Action
1 Starting at the Home page, click the Diagnostics main menu item. The Diagnostics page opens.
2 On the left side of the Diagnostics page, select Ethernet →QoS Configuration.
S1A34009 07/2012 395

Embedded Web Pages
Port Statistics
Introduction
Use the Port Statistics page to display the following data for the BMX NOC 0401
Ethernet communication module:
z static IP addressing configuration data for the module, and
z dynamically generated data describing operations of the module’s internal port,
and each of the module’s external Ethernet ports (ports 1, 2, 3 and 4)
Port Statistics Display

The Port Statistics page looks like this:
Click on the Reset counters button to reset the counting statistics to zero.
To open this page:
Step Action
1 Starting at the Home page, click the Diagnostics main menu item. The Diagnostics page opens.
2 On the left side of the Diagnostics page, select Ethernet →Switch →Port Statistics.
396 S1A34009 07/2012

Embedded Web Pages
Port Statistics Descriptions

The Port Statistics page displays the following parameters for each communication
module port:
Ethernet Configuration data:
Hostname The name assigned to the communication module
MAC Address The factory assigned Media Access Control (MAC) address, consisting
of 6 hexidecimal octet values
IP Address The Internet Protocol (IP) address (see page 67) that has been
assigned to the communication module
Subnet Mask The subnet mask (see page 67) that has been assigned to the
Gateway The IP address of the remote device (see page 67), if any, that serves
as a gateway to the communication module
Port Statistics:
Interface Label Un-Initialized or Initialized
Speed (Operational) Baud rate: 0, 10, 100 Mbps
Duplex (Operational) Twisted Pair— Full Link, 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 been successful after 16
attempts to transmit a frame, due to repeated collisions
CRC errors: The number of times a CRC (FCS) error was detected on an incoming
frame
Number Bytes Received: Number of inbound bytes received on the interface
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: The number of outbound packets that contain detected errors (not
included in discards)
Number Outbound Packets Discard: The number of outbound packets discarded while attempting to send
them
S1A34009 07/2012 397

Embedded Web Pages
Redundancy
Introduction
Use the Redundancy page to enable and disable the Rapid Spanning Tree Protocol
(RSTP) for switch ports 3 and 4.
NOTE: Because only switch ports 3 and 4 support RSTP redundancy, use ports 3
and 4 to connect the BMX NOC 0401 Ethernet communication module to the wider
network, and ports 1 and 2 for connections to local devices.
The RSTP service creates a loop-free logical network path for Ethernet devices that
are part of a topology that includes redundant physical paths, and automatically
restores network communication—by activating redundant links—in the event the
network experiences a service interruption.
Redundancy Display
The Redundancy page looks like this:
To open this page:
Step Action
2 On the left side of the Diagnostics page, select Ethernet →Switch →
Redundancy.
398 S1A34009 07/2012

Embedded Web Pages
Email Diagnostics
Diagnosing SMTP Transmissions

Use the SMTP Diagnostics web page to display dynamically generated data
describing the BMX NOC 0401 Ethernet communication module Email
transmissions.
NOTE: The Email service is enabled in the Services page, and the configuration
settings are input in the SMTP Configuration page of the module DTM.
The SMTP Diagnostics web page looks like this:
Click the Reset Counter button to reset to 0 the Email Service Statistics.
S1A34009 07/2012 399

Embedded Web Pages
To open this page:
Step Action
2 On the left side of the Diagnostics page, select Ethernet →SMTP
Diagnostics.
Email diagnostic Parameters

Electronic mail notification service parameters include the following:
Email Service:
Status The status of this service in the Ethernet communication module:
z Operational
z Service Disabled
Email Server:
Status The connection status between Ethernet communication module
and the SMTP server:
z check mark = connected
z no check mark = not connected
NOTE: Status is checked at start-up and at least every 30 minutes

after start-up.
IP Address IP address of the SMTP server
Information of Last Email Header Used:
Sender Address: Content of the From field in the last used Email header
Recipient Address: Content of the To field in the last used Email header
Subject: Content of the Subject field in the last used Email header
Email Service Statistics:
Number of Emails Sent Total number of Emails sent and successfully acknowledged by
the SMTP server.
Number of Responses Total number of responses received from the SMTP server
from Email Server
Number of Errors Total number of Emails that either:
z could not be sent
z were sent but were not successfully acknowledged by the
SMTP server
400 S1A34009 07/2012

Embedded Web Pages
Last Error Hexadecimal code describing the reason for the last unsuccessful
Email transmission (see page 421). The value “0” indicates no
unsuccessful transmissions.
Time elapses since last Counts the number of seconds since the last Email was
Email successfully sent successfully sent.
(sec)
Number of times link to Number of times the SMTP server could not be reached. (Link
the server down checked every 30 minutes.)
S1A34009 07/2012 401

Embedded Web Pages
Network Time Service Diagnostics
Diagnosing the Network Time Service

Use the Network Time Service Diagnostic web page to display dynamically
generated data describing the operation of the network time protocol (NTP) service
that you configured in the Network Time Service page (see page 101) in Unity Pro.
NOTE: The Email service is enabled in the Services page, and the configuration
settings are input in the Network Time Service Configuration page of the module
DTM.
The NTP Diagnostics web page looks like t his:
Click the Reset Counter button to reset to 0 the Network Time Service Statistics.
To open this page:
Step Action
2 On the left side of the Diagnostics page, select Ethernet →NTP Diagnostics.
402 S1A34009 07/2012

Embedded Web Pages
Network Time Service Diagnostic Parameters

Time synchronization service parameters are in the table:
Network Time Service:
Status Operational status of the service in the module:
z Operational
z Service Disabled
Date and Time Status:

Date: System date
Time: System time
NOTE: Red text indicates the network time server is not available.
DST Status The actual working status of the automatic daylight savings service:
z ON = automatic adjustment of daylight savings is enabled and the current date and
time reflect the daylight savings time adjustment
z OFF = automatic adjustment of daylight savings is disabled; or automatic adjustment
of daylight savings is enabled, but the current date and time may not reflect the daylight
savings time adjustment
Time Zone Time zone plus or minus Universal Time, Coordinated (UTC)
NTP Server:
Status Connection status of the NTP server:
z check mark = the NTP server is reachable
z no check mark = the NTP server is not reachable
IP Address The IP address of the NTP server

Type The NTP server currently active:
z Primary
z Secondary
Network Time Service Statistics:

Number of Requests: Total number of client requests sent to the NTP server
Number of Responses: Total number of server responses sent from the NTP server
Number of Errors: Total number of unanswered NTP requests
Last Error Last detected error code received from the NTP client:
z 0: good NTP configuration
z 1: late NTP server response (can be caused by excessive network traffic or server
overload)
z 2: NTP not configured
z 3: invalid NTP parameter setting
z 4: NTP component disabled
z 7: unrecoverable NTP transmission
z 9: invalid NTP server IP address
z 15: invalid syntax in the custom time zone rules file
S1A34009 07/2012 403

Embedded Web Pages
Properties
Introduction
The Properties web page displays read-only data describing the particular
BMX NOC 0401 Ethernet communication module installed in your system.
Properties Display
The Properties page looks like this:
To open this page:
Step Action
2 On the left side of the Diagnostics page, select Properties.
404 S1A34009 07/2012

Modicon M340
S1A34009 07/2012
Appendices
What Is in This Appendix?

The appendix contains the following chapters:
Chapter Chapter Name Page
A Detected Error Codes 407
B CIP General Status Codes 415
C Modbus Exception Response Codes 419
D Email Event Response Codes 421
S1A34009 07/2012 405

406 S1A34009 07/2012
Modicon M340
Detected Error Codes
S1A34009 07/2012
A
Overview
This chapter contains a list of codes that describe the status of Ethernet
communication module messages.

Topic Page
EtherNet/IP Implicit or Explicit Messaging Event Codes 408
Explicit Messaging: Communication and Operation Reports 411
S1A34009 07/2012 407

EtherNet/IP Implicit or Explicit Messaging Event Codes
If a DATA_EXCH function block does not execute an EtherNet/IP explicit message,

Unity Pro returns a hexidecimal event code. The event code can describe an
EtherNet/IP event.
EtherNet/IP Event Codes

EtherNet/IP hexadecimal event codes include:
Event Code Description

16#800D Timeout on the explicit message request
16#8015 Either:
z Nor resources to handle the message, or
z Internal event: no buffer available, no link available, impossible to send to
the TCP task
16#8018 Either:
z Another explicit message for this device is in progress, or
z 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 events that originate at the
remote target and are received via the CIP connection.
16#8100 Connection in use or duplicate Forward_Open
16#8103 Transport class and trigger combination not supported
16#8106 Ownership conflict
16#8107 Target connection not found
16#8108 Invalid network connection parameter
16#8109 Invalid connection size
16#8110 Target for connection not configured
16#8111 RPI not supported
16#8113 Out of connections
16#8114 Vendor ID or product code mismatch
16#8115 Product type mismatch
16#8116 Revision mismatch
16#8117 Invalid produced or consumed application path
16#8118 Invalid or inconsistent configuration application path
16#8119 Non-Listen Only connection not opened
16#811A Target object out of connections
408 S1A34009 07/2012


16#811B RPI is smaller than the production inhibit time
16#8123 Connection timed out
16#8124 Unconnected request timed out
16#8125 Parameter event in unconnected request and service
16#8126 Message too large for unconnected_send service
16#8127 Unconnected acknowledge without reply
16#8131 No buffer memory available
16#8132 Network bandwidth not available for data
16#8133 No consumed connection ID filter available
16#8134 Not configured to send scheduled priority data
16#8135 Schedule signature mismatch
16#8136 Schedule signature validation not possible
16#8141 Port not available
16#8142 Link address not valid
16#8145 Invalid segment in connection path
16#8146 Event in Forward_Close service connection path
16#8147 Scheduling not specified
16#8148 Link address to self invalid
16#8149 Secondary resources unavailable
16#814A Rack connection already established
16#814B Module connection already established
16#814C Miscellaneous
16#814D Redundant connection mismatch
16#814E No more user-configurable link consumer resources: the configured number of
resources for a producing application has reached the limit
16#814F No more user-configurable link consumer resources: there are no consumers
configured for a producing application to use
16#8160 Vendor specific
16#8170 No target application data available
16#8171 No originator application data available
16#8173 Not configured for off-subnet multicast
16#81A0 Event in data assignment
16#81B0 Optional object state event
16#81C0 Optional device state event
Note: All 16#82xx events are register session response events.
S1A34009 07/2012 409


16#8200 Target device does not have sufficient resources
16#8208 Target device does not recognize message encapsulation header
16#820F Reserved or unknown event from target
410 S1A34009 07/2012

Explicit Messaging: Communication and Operation Reports
Overview
Communication and operation reports are part of the management parameters.
NOTE: It is recommended that communication function reports be tested at the end
of their execution and before the next activation. On cold start-up, confirm that all
communication function management parameters are checked and reset to 0.
It may be helpful to use the %S21 to examine the first cycle after a cold or warm
start. For more information, refer to Unity Pro online help for %S21.
Communication Report
This report is common to every explicit messaging function. It is significant when the
value of the activity bit switches from 1 to 0. The reports with a value between 16#01
and 16#FE concern events detected by the processor that executed the function.
The different values of this report are indicated in the following table:
Value Communication report (least significant byte)

16#00 Correct exchange
16#01 Exchange stop on timeout
16#02 Exchange stop on user request (CANCEL)
16#03 Incorrect address format
16#04 Incorrect destination address
16#05 Incorrect management parameter format
16#06 Incorrect specific parameters
16#07 Error detected in sending to the destination
16#08 Reserved
16#09 Insufficient receive buffer size
16#0A Insufficient send buffer size
16#0B No processor system resources
16#0C Incorrect exchange number
16#0D No telegram received
16#0E Incorrect length
16#0F Telegram service not configured
16#10 Network module missing
16#11 Request missing
16#12 Application server already active
16#13 UNI-TE V2 transaction number incorrect
S1A34009 07/2012 411

Value Communication report (least significant byte)

16#FF Message refused
NOTE: The function can detect a parameter event before activating the exchange.
In this case the activity bit remains at 0, and the report is initialized with values
corresponding to the event.
Operation Report
This report byte is specific to each function, and specifies the result of the operation
on the remote application:
Value Operation report (most significant byte)

16#05 Length mismatch (CIP)
16#07 Bad IP address
16#09 Network is down
16#0A Connection reset by peer
16#0C Communication function not active
16#0D z Modbus TCP: transaction timed out
z EtherNet/IP: request timeout
16#0F No route to remote host

16#13 Connection refused
16#15 z Modbus TCP: no resources
z EtherNet/IP: no resources to handle the message; or an internal event; or
no buffer available; or no link available; or cannot send message
16#16 Remote address not allowed
16#18 z Modbus TCP: concurrent connections or transactions limit reached
z EtherNet/IP: TCP connection or encapsulation session in progress
16#19 Connection timed out

16#30 z Modbus TCP: remote host is down
z EtherNet/IP: connection open timed out
16#80...16#87: Forward_Open response events:

16#80 Internal event
16#81 Configuration event: the length of the explicit message, or the RPI rate, needs
to be adjusted
16#82 Device event: target device does not support this service
16#83 Device resource event: no resource is available to open the connection
16#84 System resource evebt: unable to reach the device
16#85 Data sheet event: incorrect EDS file
16#86 Invalid connection size
412 S1A34009 07/2012

Value Operation report (most significant byte)

16#90...16#9F: Register session response events:
16#90 Target device does not have sufficient resources
16#98 Target device does not recognize message encapsulation header
16#9F Unknown event from target
S1A34009 07/2012 413

414 S1A34009 07/2012

Modicon M340
CIP General Status Codes
S1A34009 07/2012
B
NOTE: Taken by permission from The CIP Networks Library, Volume 1, Common
Industrial Protocol (CIP™), Edition 3.6, April 2009.
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.
General Status Name Description of Status

Status Code
(in hex)
00 Success Service was successfully performed by the object specified.
01 Connection A connection related service was unsuccessful along the connection path.
unsuccessful
02 Resource Resources needed for the object to perform the requested service were
unavailable unavailable.
03 Invalid parameter See status code 0x20, which is the preferred value to use for this condition.
value
04 Path segment error 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.
05 Path destination The path is referencing an object class, instance, or structure element that is not
unknown known or is not contained in the processing node. Path processing stops when
a path destination unknown error is detected.
06 Partial transfer Only part of the expected data was transferred.
07 Connection lost The messaging connection was lost.
S1A34009 07/2012 415


Status Code
(in hex)
08 Service not The requested service was not implemented or was not defined for this object
supported class/instance.
09 Invalid attribute Invalid attribute data detected.
value
0A Attribute list error An attribute in the Get_Attribute_List or Set_Attribute_List response has a non-
zero status.
0B Already in The object is already in the mode/state being requested by the service.
requested
mode/state
0C Object state The object cannot perform the requested service in its current mode/state.
conflict
0D Object already The requested instance of object to be created already exists.
exists
0E Attribute not A request to modify a non-modifiable attribute was received.
settable
0F Privilege violation A permission/privilege check was unsuccessful.
10 Device state The device’s current mode/state prohibits the execution of the requested service.
conflict
11 Reply data too The data to be transmitted in the response buffer is larger than the allocated
large response buffer.
12 Fragmentation of a The service specified an operation that is going to fragment a primitive data
primitive value value, i.e., half a REAL data type.
13 Not enough data The service did not supply enough data to perform the specified operation.
14 Attribute not The attribute specified in the request is not supported.
supported
15 Too much data The service supplied more data than was expected.
16 Object does not The object specified does not exist in the device.
exist
17 Service The fragmentation sequence for this service is not currently active for this data.
fragmentation
sequence not in
progress
18 No stored attribute The attribute data of this object was not saved prior to the requested service.
data
19 Store operation The attribute data of this object was not saved due to an unsuccessful attempt.
unsuccessful
416 S1A34009 07/2012


Status Code
(in hex)
1A Routing The service request package was too large for transmission on a network in the
unsuccessful, path to the destination. The routing device was forced to abort the service.
request packet too
large
1B Routing The service response packet was too large for transmission on a network in the
unsuccessful, path from the destination. The routing device was forced to abort the service.
response packet
too large
1C Missing attribute The service did not supply an attribute in a list of attributes that was needed by
list entry data the service to perform the requested behavior.
1D Invalid attribute The service is returning the list of attributes supplied with status information for
value list those attributes that were invalid.
1E Embedded service An embedded service resulted in a detected error.
error
1F Vendor specific A vendor specific error has been detected. The additional code field of the error
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.
20 Invalid parameter 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.
21 Write-once value An attempt was made to write to a write-once medium (e.g., WORM drive,
or medium already PROM) that has already been written, or to modify a value that cannot be
written changed once established.
22 Invalid reply An invalid reply is received (e.g., reply service code does not match the request
received service code, or reply message is shorter than the minimum expected reply size).
This status code an serve for other causes of invalid replies.
23 Buffer overflow The message received is larger than the receiving buffer can handle. The entire
message was discarded.
24 Message format The format of the received message is not supported by the server.
error
25 Key failure in path 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.
26 Path size invalid 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.
27 Unexpected An attempt was made to set an attribute that is not able to be set at this time.
attribute in list
S1A34009 07/2012 417


Status Code
(in hex)
28 Invalid member ID The member ID specified in the request does not exist in the specified
class/instance/attribute.
29 Member not A request to modify a non-modifiable member was received.
settable
2A Group 2 only This detected error code may only be reported by DeviceNet group 2 only
server — general servers with 4 Kb or less code space and only in place of service not supported,
error attribute not support, or attribute not settable.
2B Unknown Modbus A CIP to Modbus translator received an unknown Modbus exception code.
error
2C Attribute not A request to read a non-readable attribute was received.
gettable
2D - CF – Reserved by CIP for future extensions.
D0 - FF Reserved for This range of detected error codes is used to indicate object class specific
object class and detected errors. Use this range only when none of the codes presented in this
service errors table accurately reflect the error that is detected.
418 S1A34009 07/2012

Modicon M340
Modbus Exception Response Codes
S1A34009 07/2012
Modbus Exception Response

Codes
C
MODBUS Exception Response Codes
The MODBUS exception response codes include the following:
Status Response Description

Hex) (Dec)
0x8101 33025 Illegal Function The function code received in the query is not an
allowable action for the server (or slave). This
may be because the function code is only
applicable to newer devices, and was not
implemented in the unit selected. It could also
indicate that the server (or slave) is in the wrong
state to process a request of this type. This code
is also returned when attempting to write to a
read-only attribute.
0x8102 33026 Illegal Data The data address received in the query is not an
Address allowable address for the server (or slave). More
specifically, the combination of reference number
and transfer length is invalid.
0x8103 33027 Illegal Data A value contained in the query data field is not an
Value allowable value for server (or slave). This
indicates an invalid request structure. It
specifically does NOT mean that a data item
submitted for storage in a register has a value
outside the expectation of the application
program, because the MODBUS protocol does
not test the significance of any particular register
value.
0x8104 33028 Slave Device An unrecoverable event occurred while the
Failure server (or slave) was attempting to perform the
requested action.
S1A34009 07/2012 419

Modbus Exception Response Codes
Status Response Description

Hex) (Dec)
0x8105 33029 Acknowledge Specialized use in conjunction with programming
commands: The server (or slave) has accepted
the request and is processing it, but a long
duration of time will be required to do so. This
response is returned so that a timeout in the client
(or master) will not occur. The client (or master)
can next send a Poll Program Complete message
to determine if processing is completed.
0x8106 33030 Slave Device Specialized use in conjunction with programming
Busy commands: The server (or slave) is engaged in
processing a long–duration program command.
The client (or master) should retransmit the
message later when the server (or slave) is free.
0x8107 33031 Negative Specialized use in conjunction with programming
Acknowledge commands: The request attempts to initiate a
program function that is not supported by the
server (slave).
0x8108 33032 Memory Parity Specialized use in conjunction with function
Error codes 20 and 21 and reference type 6, indicating
that the extended file area did not pass a
consistency check.
0x810A 33034 Gateway Path Specialized use in conjunction with gateways,
Unavailable indicates that the gateway was unable to allocate
an internal communication path from the input
port to the output port for processing the request.
Usually means that the gateway is misconfigured
or overloaded.
0x810B 33035 Gateway Target Specialized use in conjunction with gateways,
Device Failed to indicates that no response was obtained from the
Respond target device. Usually means that the device is
not present on the network.
The preceding MODBUS exception response codes are derived from the
MODBUS Application Protocol Specification V1.1b as distributed by the Modbus
Organization, Inc. at http://www.Modbus-IDA.com.
420 S1A34009 07/2012

Modicon M340
Email Event Response Codes
S1A34009 07/2012
D
Electronic Mail Notification Service Event Response Codes
SMTP Codes
The following codes are available only on the Unity Pro DTM and web page
diagnostic screens for the electronic mail notification service:
Code (hex) Description

5100 Internal error detected
5101 SMTP component not operational
5102 Mail header not configured
5103 Invalid mail header value detected (1, 2, or 3)
5104 Cannot connect to SMTP server
5105 Error detected during transmitting content of email body to SMTP server
5106 Closing SMTP connection with the server returned a detected error
message
5107 SMTP HELO request unsuccessful
5108 SMTP MAIL request unsuccessful — SMTP server may require
authentication
5109 SMTP RCPT request unsuccessful
510A No recipient accepted by the SMTP server
510B SMTP DATA request unsuccessful
510C Send email request contains an invalid length
510D Authentication unsuccessful
510E A reset component request was received while the connection was open
S1A34009 07/2012 421

422 S1A34009 07/2012

Modicon M340
Glossary
S1A34009 07/2012
Glossary
Adapter
An adapter is the target of real-time I/O data connection requests from scanners. It
cannot send or receive real-time I/O data unless it is configured to do so by a
scanner, and it does not store or originate the data communications parameters
necessary to establish the connection. An adapter accepts explicit message
requests (connected and unconnected) from other devices.
Advanced mode
In Unity Pro, Advanced mode is a selection that displays expert-level configuration
properties that help define Ethernet connections. Because these properties are
designed to be edited only by persons with a solid understanding of communication
protocols, they can be hidden or displayed, depending upon the qualifications of the
specific user.
BOOTP
(bootstrap protocol) A UDP network protocol that can be used by a network client to
automatically obtain an IP address from a server. The client identifies itself to the
server using its MAC address. The server—which maintains a pre-configured table
of client device MAC addresses and associated IP addresses—sends the client its
defined IP address. The BOOTP service utilizes UDP ports 67 and 68.
Broadcast
A message sent to all devices in the subnet.
S1A34009 07/2012 423

Glossary
CIP™
(Common Industrial Protocol) A comprehensive suite of messages and services for
the collection of manufacturing automation applications—control, safety, synchroni-
zation, motion, configuration and information. CIP allows users to integrate these
manufacturing applications with enterprise-level Ethernet networks and the Internet.
CIP is the core protocol of EtherNet/IP.
Class 1 connection
A CIP transport class 1 connection used for I/O data transmission via Implicit
Messaging between EtherNet/IP devices.
Class 3 connection
A CIP transport class 3 connection used for Explicit Messaging between EtherNet/IP
devices.
connected messaging
In EtherNet/IP, connected messaging uses a CIP connection for communication. A
connected message is a relationship between two or more application objects on
different nodes. The connection establishes a virtual circuit in advance for a
particular purpose, such as frequent explicit messages or real-time I/O data
transfers.
connection
A virtual circuit between two or more network devices, created prior to the
transmission of data. After a connection is established, a series of data is
transmitted over the same communication path, without the need to include routing
information—including source and destination address—with each piece of data.
connection originator
The EtherNet/IP network node that initiates a connection request for I/O data
transfer or explicit messaging.
connectionless
Describes communication between two network devices, whereby data is sent
without prior arrangement between the two devices. Each piece of transmitted data
also includes routing information—including source and destination address.
424 S1A34009 07/2012

Glossary
consumer
See producer/consumer, below.
CSMA/CD
(carrier sense multiple access with collision detection) An Ethernet and IEEE 802.3
media access method, operating at the physical layer and handled fully by hardware
at the communication media signal level. All network devices contend equally for
access to transmit. When a device (device ‘A’) detects a signal sent by another
device (device ‘B’) while A is transmitting, A aborts its transmission and retries after
a random period of time.
DHCP
(dynamic host configuration protocol) An extension of the BOOTP communications
protocol that provides for the automatic assignment of IP addressing settings—
including IP address, subnet mask, gateway IP address, and DNS server names.
DHCP does not require the maintenance of a table identifying each network device.
The client identifies itself to the DHCP server using either its MAC address, or a
uniquely assigned device identifier. The DHCP service utilizes UDP ports 67 and 68.
DNS
(domain name server/service) A service that translates an alpha-numeric domain
name into an IP address, the unique identifier of a device on the network.
domain name
An alpha-numeric string that identifies a device on the internet, and which appears
as the primary component of a web site’s Uniform Resource Locator (URL). For
example, the domain name "schneider-electric.com" is the primary component of
the URL "www.schneider-electric.com".
Each domain name is assigned as part of the Domain Name System, and is
associated with an IP address.
Also called a host name.
S1A34009 07/2012 425

Glossary
DTM
(device type manager) A DTM is a device driver running on the host PC. It provides
a unified structure for accessing device parameters, configuring and operating the
devices, and diagnosing events. DTMs can range from a simple Graphical User
Interface for setting device parameters to a highly sophisticated application capable
of performing complex real-time calculations for diagnosis and maintenance
purposes. In the context of a DTM, a device can be a communications module or a
remote device on the network.
EDS
(electronic data sheet) EDS are simple text files that describe the configuration
capabilities of a device. EDS files are generated and maintained by the
manufacturer of the device.
Ethernet
A 10 or 100 Mb/s, CSMA/CD, frame-based LAN that can run over twisted pair or
fiber optic cable, or wireless. The IEEE standard 802.3 defines the rules for
configuring a wired Ethernet network; the IEEE standard 802.11 defines the rules for
configuring a wireless Ethernet network.
EtherNet/IP™
A network communication protocol for industrial automation applications that
combines the standard internet transmission protocols of TCP/IP and UDP with the
application layer Common Industrial Protocol (CIP) to support both high speed data
exchange and industrial control. EtherNet/IP employs electronic data sheets (EDS)
to classify each network device and its functionality. Because EtherNet/IP is based
on standard Ethernet protocols, it can be implemented using commercially available
Ethernet components and cabling.
Explicit Messaging
TCP/IP-based messaging for Modbus TCP and EtherNet/IP. It is used for point-to-
point, client/server messages that include both data—typically unscheduled
information between a client and a server—and routing information. In EtherNet/IP,
Explicit Messaging is considered Class 3 type messaging, and can be connection-
based or connectionless.
426 S1A34009 07/2012

Glossary
Explicit Messaging client

Explicit Messaging client class) Device class defined by the ODVA for EtherNet/IP
nodes that only support Explicit Messaging as a client. HMI and SCADA systems are
the most common examples of this device class.
full duplex
The ability of a two networked devices to independently and simultaneously
communicate with each other in both directions.
gateway
A device that interconnects two different networks—sometimes with different
network protocols. When used to connect networks based on different protocols, a
gateway converts a datagram from one protocol stack into the other. When used to
connect two IP-based networks, a gateway (also called a router) has two separate
IP addresses - one on each network.
hub
A multiport device used to span longer network distances by connecting several
Ethernet devices with shielded/unshielded twisted pair or fiber optic cables.
Messages received by a hub are repeated on all ports. All connected devices are
part of the same segment, share bandwidth and operate via half-duplex
communication. A hub lacks the ability to filter network messages based on their
source and destination address. Because communication is half-duplex, the
likelihood of collisions is increased. Collisions are handled by each connected
device using CSMA/CD. Hubs are OSI Layer 1 (physical layer) devices.
S1A34009 07/2012 427

Glossary
Implicit Messaging
UDP/IP-based class 1 connected messaging for EtherNet/IP. Implicit messaging
maintains an open connection for the scheduled transfer of control data between a
producer and consumer. Because an open connection is maintained, each message
contains primarily data—without the overhead of object information—plus a
connection identifier.
IP address
The 32-bit identifier—consisting of both a network address and a host address—
assigned to a device connected to a TCP/IP network.
local slave
Functionality offered by Schneider Electric EtherNet/IP communication modules that
allows a Scanner to take the role of an Adapter. The local slave enables the module
to publish data via Implicit Messaging connections. Local slave is typically used in
peer-to-peer exchanges between PLCs.
multicast
A special form of broadcast where copies of the packet are delivered to only a
subset of all possible destinations. Implicit Messaging typically uses multicast format
for communications in an EtherNet/IP network.
O->T
Originator to target.
originator
In EtherNet/IP a device is considered the originator when it initiates a CIP
connection for Implicit or Explicit Messaging communications; or when it initiates a
message request for un-connected Explicit Messaging.
428 S1A34009 07/2012

Glossary
producer/consumer
CIP, the core protocol for EtherNet/IP, uses the producer/consumer model, as
opposed to the client/server message addressing scheme employed by Modbus
TCP. The producer/consumer model is inherently multicast. Nodes on the network
determine if they should consume the data in a message based on the connection
ID in the packet.
QoS
Quality of Service The practice of assigning different priorities to traffic types for the
purpose of regulating data flow on the network. In an Industrial network, QoS can
help provide a predictable level of network performance.
rack optimized connection

Data from multiple I/O modules are consolidated in a single data packet to be
presented to the Scanner in an Implicit Message in an EtherNet/IP network.
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.
scanner
A Scanner acts as the originator of I/O connection requests for Implicit Messaging
in EtherNet/IP, and message requests for Modbus TCP.
Scanner Class device

A Scanner Class device is defined by the ODVA as an EtherNet/IP node capable of
originating exchanges of I/O with other nodes in the network.
S1A34009 07/2012 429

Glossary
subnet mask
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.
switch
A multiport device used to segment the network and limit the likelihood of collisions.
Packets are filtered or forwarded based upon their source and destination
addresses. Switches are capable of full-duplex operation and provide full network
bandwidth to each port. A switch can have different input/output speeds (for
example, 10, 100 or 1000Mbps). Switches are considered OSI layer 2 (data link
layer) devices.
T->O
Target to originator.
target
In EtherNet/IP a device is considered the target when it is the recipient of a
connection request for Implicit or Explicit Messaging communications; or when it is
the recipient of a message request for un-connected Explicit Messaging.
TCP
(transmission control protocol) TCP is the OSI transport layer protocol that supports
connection-oriented communications, by establishing the connection necessary to
transmit an ordered sequence of data over the same communication path.
TCP/IP
Also known as "Internet protocol suite", TCP/IP is a collection of protocols used to
conduct transactions on a network. The suite takes its name from the two most
broadly used protocols: transmission control protocol and internet protocol. TCP/IP
is a connection-oriented protocol that is used by Modbus TCP and EtherNet/IP for
Explicit Messaging.
trap
A trap is an event directed by an SNMP agent that indicates either:
z a change has occurred in the status of an agent, or
z an unauthorized SNMP manager device has attempted to get data from, or
change data on, an SNMP agent
430 S1A34009 07/2012

Glossary
UDP
(user datagram protocol) UDP is a transport layer protocol that supports
connectionless communications. Applications running on networked nodes can use
UDP to send datagrams to one another. Unlike TCP, UDP does not attempt to
provide deterministic delivery or ordering of datagrams. However, by avoiding the
overhead required by deterministic delivery and checking of datagrams, UDP is
faster than TCP. UDP may be the preferred protocol for time-sensitive applications,
where dropped datagrams are preferable to delayed datagrams. UDP is the primary
transport for Implicit Messaging in EtherNet/IP.
unconnected messaging
In EtherNet/IP, unconnected messaging uses TCP (without a CIP connection) to
send explicit messages. More overhead is contained within each unconnected
message than for a connected message. The unconnected message is not
necessarily provided destination node resources. Unconnected Messaging is used
for non-periodic requests.
S1A34009 07/2012 431

Glossary
432 S1A34009 07/2012

Modicon M340
Index
S1A34009 07/2012
Index
B
AC
0-9 connection
diagnostics, 336
140 NOC 780 00
I/O, 340
device editor, 55
overhead, 219
DTM browser, 43
protocol, 219
type, 219
A connection manager object, 239
connection timeout
access control, 86 calculating, 218
add remote device, 131, 165 control bits, 195
address
I/O, 192
advanced mode D
DTM browser, 48
data editor
Advantys STB island
creating a data template, 375
connecting to, 145, 174
direct address, 377
assembly object, 237, 242
lite, 379
auto-negotiation, 206
modify data, 378
saving a data template, 375
B variables, 377
data editor (standard), 370
Bandwidth Diagnostics, 325 data template
displaying a data template, 376
DATA_EXCH, 289, 293, 297, 305
C event codes, 408
channel properties, 60 explicit messaging, 281
CIP objects, 233 derived data types, 188, 190
configuring derived variables, 191
properties in device editor, 55 device bandwidth, 226
device discovery, 49
device editor, 53
DTM browser, 55
S1A34009 07/2012 433

Index
device load, 226 EtherNet/IP interface diagnostics object, 252

DHCP, 77 EtherNet/IP IO Scanner Diagnostics object,
DHCP client, 80 255
diagnostics, 319 EtherNet/IP settings, 72
bandwidth, 325, 388 explicit message, 216
connection, 336 EtherNet/IP, 310
Email, 328, 399 Get_Attribute_Single, 289
Ethernet port, 321 Modbus TCP, 312
local slave, 336 Read Modbus Object, 293
messaging, 393 read register, 305
NTP, 330, 402 Write Modbus Object, 297
port statistics, 396 explicit messaging, 281
processor load, 388 communication report, 411
properties, 404 event codes, 408
QoS, 395 Modbus TCP function codes, 302
rack viewer, 386 operation report, 411
redundancy, 398
RSTP, 333
scanner status, 391 F
status summary, 383 FDR, 77
diagnostics web page, 382 field bus discovery, 49
download, 57 full-duplex, 206
DSCP, 64
DTM
add, 121 H
DTM Browser, 40 hardware catalog
DTM browser updating, 124
advanced mode, 48 health bits, 193
configuring properties in device editor, 55 home web page, 362
DTM browser menu commands, 43
I
E I/O
EDS file connection, 340
add, 122 local slave, 340
remove, 126 identity object, 235
Email IGMP snooping, 208
configuring, 96 implicit message, 217
diagnostics, 328, 399 inputs
Ethernet address, 192
connection speed, 62 IO connection diagnostics object, 257
Ethernet diagnostics, 321 IP address, 67
ethernet link object, 248
EtherNet/IP explicit connection diagnostics
object, 261, 264
434 S1A34009 07/2012

Index
L O
LEDs, 316 online action
load CIP object, 268
example, 229 display CIP object data, 269
limits, 222 get port configuration, 271
local slave, 105 ping, 273
configuring, 107 port configuration, 270
diagnostics, 336 reset, 269
I/O, 112, 340 set port configuration, 271
logging, 342 online parameters, 275
outputs
address, 192
M
menu commands
DTM browser, 43 P
message password
priority, 221 data editor write, 364
message bandwidth, 225 web page access, 364
message frequency, 223 web pages, 363
message load, 225 physical description, 14
message response time, 228 ping, 273
message traverse time, 227 port diagnostics, 321
messages port mirroring, 212
types, 216 web pages, 366
messaging, 393 port statistics, 396
monitoring web page, 369 processor load, 388
mounting, 21
Q
N QoS, 64, 89, 207, 221, 395
network QoS object, 244
example, 28
network bandwidth, 226
network example, 129, 163 R
network load, 226 rack viewer, 386
network time service, 101 redundancy, 398
NTP remote device
diagnostics, 330, 402 configuring, 133, 167
replacement, 357
RSTP, 93, 209
RSTP Diagnostics, 333
S1A34009 07/2012 435

Index
S W
scanner status, 391 web pages
SEND_EMAIL, 99 data editor (standard), 370
services diagnostics, 382
enabling, 75 home, 362
SMTP codes, 421 messaging, 393
SNMP agent, 83, 214 monitoring, 369
specifications, 17 password, 363
communication, 19 port mirroring, 366
status summary, 383 port statistics, 396
STB NIC 2212 processor load, 388
configuring I/O items, 149 properties, 404
STB NIP 2212 QoS, 395
configuring I/O items, 178 rack viewer, 386
switch redundancy, 398
managed, 205 scanner status, 391
recommended features, 205 status summary, 383
wiring, 22
T
TCP/IP interface object, 246
timeout
connection, 218
U
uninstall, 25
Unity Pro
create project, 31
download application, 57
upload application, 58
upload, 58
username, 364
V
variables
derived, 191
VLAN, 210
436 S1A34009 07/2012

M340 NOC Manual PDF

Uploaded by

Copyright:

Available Formats

M340 NOC Manual PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

M340 NOC Manual PDF

Uploaded by

Copyright:

Available Formats

Modicon M340

Title of Documentation Reference Number

What Is in This Chapter?

Physical Description of the BMX NOC 0401 Module

Communication Modules per Station

CPU Maximum Number of Communication Modules per Station

I/O Communication Specifications

Communication type Feature Capacity

Explicit Messaging Specifications

Communication type Feature Capacity

Mounting the BMX NOC 0401 Module

Mounting the Module

Step Action Illustration

3 Tighten the screw to hold the module

The Ethernet communication module communicates over an industrial Ethernet

Installing Unity Pro Ethernet Configuration Tool Software

Step Screen Description

Click Next to continue.

Click Next to continue.

Updating Hardware Catalog

UnInstalling the Ethernet Configuration Tool

Un-Installing Ethernet Configuration Tool DTMs

Configuring the Ethernet

What Is in This Chapter?

2.1 Ethernet Network Configuration Example

The Ethernet Network Example

The Ethernet Network

Multiple Roles of the PLC and Ethernet Communication Module

2.2 Creating a Project in Unity Pro

What Is in This Section?

Creating a Project in Unity Pro

Creating and Saving a New Unity Pro Project

4 Click OK close the window and save your path edits.

Adding a Power Supply to the New Unity Pro Project

9 In the File menu, select Save, to save your edits.

Adding an Ethernet Communication Module to the New Unity Pro Project

Configuring the Size and Location of Inputs and Outputs

To input the above settings, take the following steps:

Completing the Ethernet Network Configuration

2.3 The Unity Pro FDT/DTM Interface

What Is in This Section?

Example: the device IP address

Handling Invalid Nodes

DTM Browser Menu Commands

z device-specific commands, as determined by the device DTM

Host PC Node Commands

Add 1 Opens the Add dialog — containing a subset of the Hardware

Expand all2 Displays every DTM in the project.

Collapse all2 Displays only the communication DTMs in the project.

1. This command also appears in the Unity Pro Edit menu.

Communication Module and Remote Device Node Commands

Properties1 Opens the Ethernet communication module Properties window.

Expand all2 This displays DTMs below the selected DTM.

Collapse all2 This displays only the selected DTM.

1. This command also appears in the Unity Pro Edit menu.

Communication Module Commands

Connecting and Disconnecting a Device or Module DTM

NOTE: Distinguish between:

2 Click the right-mouse button.