184
User’s Manual EtherNet/IP Interface Module IM 34M06H36-01E 3rd Edition IM 34M06H36-01E Yokogawa Electric Corporation Applicable Module Model Code Model Name F3LN01-0N EtherNet/IP Interface Module SF673-MDW FA-M3 Configuration Tool EtherNet/IP Interface Module

EtherNet/IP Interface Module

  • Upload
    others

  • View
    21

  • Download
    1

Embed Size (px)

Citation preview

Page 1: EtherNet/IP Interface Module

User’s Manual

EtherNet/IP Interface Module

IM 34M06H36-01E 3rd Edition

IM 34M06H36-01E

Yokogawa Electric Corporation

Applicable Module Model Code Model Name

F3LN01-0N EtherNet/IP Interface Module

SF673-MDW FA-M3 Configuration Tool EtherNet/IP Interface Module

Page 2: EtherNet/IP Interface Module

Blank Page Blank Page

Page 3: EtherNet/IP Interface Module

All Rights Reserved Copyright © 2018, Yokogawa Electric Corporation

i

IM 34M06H36-01E

Applicable Product Range-free Controller FA-M3

- Model : F3LN01-0N

- Name : EtherNet/IP Interface Module

The document number for this manual is given below.

Refer to the document number in all communications, including when purchasing additional copies of this manual.

- Document No.: IM 34M06H36-01E

Page 4: EtherNet/IP Interface Module

ii

IM 34M06H36-01E

Precautions

About This Manual - This Manual should be passed on to the end user.

- This manual is an essential part of the product; keep it in a safe place for future reference.

- This product is designed to be used by a person with specialized knowledge.

- Before using the product, read this manual thoroughly to have a clear understanding of the product.

- This manual explains the functions of this product, but there is no guarantee that they will suit the particular purpose of the user.

- Under absolutely no circumstances may the contents of this manual be transcribed or copied, in part or in whole, without permission.

- The contents of this manual are subject to change without prior notice.

- Every effort has been made to ensure accuracy in the preparation of this manual. However, should any errors or omissions come to the attention of the user, please contact the nearest Yokogawa Electric representative or sales office.

Safety Symbols

- ”Handle with care.” This symbol on the product indicates that the operator must

follow the instructions laid out in this user's manual to avoid the risk of personnel injuries, fatalities, or damage to the instrument.

- Protective Conductor Terminal

This terminal is to prevent electric shock. Before using the instrument, connect to the Protective earth (Comply with the regulation of each country.), and route the line through the shortest path possible.

- Functional Earth Terminal

This terminal is for stable operation. Before using the instrument, be sure to ground this terminal.

- Alternating current. Indicates alternating current.

- Direct current. Indicates direct current.

Page 5: EtherNet/IP Interface Module

iii

IM 34M06H36-01E

The following symbols are used only in the user's manual.

WARNING - Draws attention to information essential to prevent electrical shock or other dangers

that may result in injury or the loss of life.

CAUTION - Draws attention to information essential to prevent hardware damage, software

damage or system failure.

NOTE

- Draws attention to information essential to the understanding of operation and functions.

Safety Precautions when Using/Maintaining the Product - For the protection and safe use of the product and the system controlled by it, be

sure to follow the instructions and precautions on safety stated in this manual whenever handling the product. Take special note that if you handle the product in a manner other than prescribed in these instructions, the protection feature of the product may be damaged or impaired. In such cases, Yokogawa cannot guarantee the quality, performance, function and safety of the product.

- When installing protection and/or safety circuits such as lightning protection devices and equipment for the product and control system as well as designing or installing separate protection and/or safety circuits for fool-proof design and fail-safe design of processes and lines using the product and the system controlled by it, the user should implement it using devices and equipment, additional to this product.

- If component parts or consumable are to be replaced, be sure to use parts specified by the company.

- This product is not designed or manufactured to be used in critical applications which directly affect or threaten human lives and safety — such as nuclear power equipment, devices using radioactivity, railway facilities, aviation equipment, shipboard equipment, aviation facilities or medical equipment. If so used, it is the user’s responsibility to include in the system additional equipment and devices that ensure personnel safety.

- Do not attempt to modify the product.

- To avoid electrical shock, turn off the power before wiring.

- This product is classified as Class A for use in industrial environments. If used in a residential environment, it may cause electromagnetic interference (EMI).

In such situations, it is the user's responsibility to adopt the necessary measures against EMI.

Exemption from Responsibility - Yokogawa Electric Corporation (hereinafter simply referred to as Yokogawa Electric)

makes no warranties regarding the product except those stated in the WARRANTY that is provided separately.

- Yokogawa Electric assumes no liability to any party for any loss or damage, direct or indirect, caused by the use or any unpredictable defect of the product.

Page 6: EtherNet/IP Interface Module

iv

IM 34M06H36-01E

Software Supplied by the Company - Yokogawa Electric makes no other warranties expressed or implied except as

provided in its warranty clause for software supplied by the company.

- Use the software with one computer only. You must purchase another copy of the software for use with each additional computer.

- Copying the software for any purposes other than backup is strictly prohibited.

- Store the original media that contain the software in a safe place.

- Reverse engineering, such as decompiling of the software, is strictly prohibited.

- Under absolutely no circumstances may the software supplied by Yokogawa Electric be transferred, exchanged, or sublet or leased, in part or as a whole, for use by any third party without prior permission by Yokogawa Electric.

Page 7: EtherNet/IP Interface Module

v

IM 34M06H36-01E

General Requirements for Using the FA-M3 / e-RT3 Controller

Set the product in a location that fulfills the following requirements:

- INDOOR USE ONLY

- This product is an open equipment. The product must be installed in a metallic panel enclosure with an impact rating IK08 or more.

- Where the product will not be exposed to direct sunlight, and where the operating surrounding air temperature is from 0°C to 55°C (32°F to 131°F).

There are modules that must be used in an environment where the operating surrounding air temperature is in a range smaller than 0°C to 55°C (32°F to 131°F). Refer to “Hardware Manual” (IM 34M06C11-01E) or the applicable user's manual. In case of attaching such a module, the entire system's operating surrounding air temperature is limited to the module's individual operating surrounding air temperature.

- Where the relative humidity is from 10 to 90%.

In places where there is a chance of condensation, use a space heater or the like to constantly keep the product warm and prevent condensation.

- For use in Pollution Degree 2 Environment.

- Where there are no corrosive or flammable gases.

- Where the product will not be exposed to mechanical vibration or shock that exceed specifications.

- Where there is no chance the product may be exposed to radioactivity.

Use the correct types of wire for external wiring:

- USE COPPER CONDUCTORS ONLY.

- Use conductors with temperature rating above 75°C.

Securely tighten screws:

- Securely tighten module mounting screws and terminal screws to avoid problems such as faulty operation.

- Tighten terminal block screws with the correct tightening torque as given in this manual. Refer to the “Hardware Manual” (IM 34M06C11-01E) or the applicable user's manual for the appropriate tightening torque.

Securely lock connecting cables:

- Securely lock the connectors of cables, and check them thoroughly before turning on the power.

Interlock with emergency-stop circuitry using external relays:

- Equipment incorporating the FA-M3 / e-RT3 controller must be furnished with emergency-stop circuitry that uses external relays. This circuitry should be set up to interlock correctly with controller status (stop/run).

Ground for low impedance:

- For safety reasons, connect the [FG] grounding terminal to a protective earth (Comply with the regulation of each country.). For compliance to CE Marking, use braided or other wires that can ensure low impedance even at high frequencies for grounding.

Page 8: EtherNet/IP Interface Module

vi

IM 34M06H36-01E

Configure and route cables with noise control considerations:

- Perform installation and wiring that segregates system parts that may likely become noise sources and system parts that are susceptible to noise. Segregation can be achieved by measures such as segregating by distance, installing a filter or segregating the grounding system.

Configure for CE Marking Conformance:

- For compliance to CE Marking, perform installation and cable routing according to the description on compliance to CE Marking in the “Hardware Manual” (IM 34M06C11-01E).

- The list of CE conforming models is available in Appendix A2. of “Hardware Manual”.

Keep spare parts on hand:

- We recommend that you stock up on maintenance parts, including spare modules, in advance.

- Preventive maintenance (replacement of the module) is required for using the module beyond 10 years.

Discharge static electricity before touching the system:

- Because static charge can accumulate in dry conditions, first touch grounded metal to discharge any static electricity before touching the system.

Wipe off dirt with a soft cloth:

- Gently wipe off dirt on the product's surfaces with a soft cloth.

- If you soak the cloth in water or a neutral detergent, tightly wring it out before wiping the product. Letting water enter the module interior can cause malfunctions.

- Do not use volatile solvents such as benzine or paint thinner or chemicals for cleaning, as they may cause deformity, discoloration, or malfunctioning.

Avoid storing the FA-M3 /e-RT3 controller in places with high temperature or humidity:

- Since the CPU module has a built-in battery, avoid storage in places with high temperature or humidity.

- Since the service life of the battery is drastically reduced by exposure to high temperatures, take special care (storage surrounding air temperature should be from -20°C to 75°C).

- There is a built-in lithium battery in a Sequence CPU module which serves as backup power supply for programs, device information and configuration information.

The service life of this battery is more than 10 years in standby mode at room temperature. Take note that the service life of the battery may be shortened when installed or stored at locations of extreme low or high temperatures. Therefore, we recommend that modules with built-in batteries be stored at room temperature.

Always turn off the power before installing or removing modules:

- Failing to turn off the power supply when installing or removing modules, may result in damage.

Do not touch components in the module:

- In some modules you can remove the right-side cover and install ROM packs or change switch settings. While doing this, do not touch any components on the printed-circuit board, otherwise components may be damaged and modules may fail to work.

Page 9: EtherNet/IP Interface Module

vii

IM 34M06H36-01E

Do not use unused terminals:

- Do not connect wires to unused terminals on a terminal block or in a connector. Doing so may adversely affect the functions of the module.

Use the following power source:

- Use only F3PU- as the power supply module.

- If using this product as a UL-approved product, for the external power supply, use a limited voltage / current circuit power source or a Class 2 power source.

- If using this product as a CE-complied product, for the external power supply, use a SELV and limited-energy circuit separated by reinforced insulation or double insulation from hazardous voltage.

Refer to the user's manual before connecting wires:

- Refer to the “Hardware Manual” (IM 34M06C11-01E) or the applicable user’s manual for the external wiring drawing.

- Refer to “A3.6.5 Connecting Output Devices” in the “Hardware Manual” before connecting the wiring for the output signal.

- Refer to “A3.5.4 Grounding Procedure” in the “Hardware Manual” for attaching the grounding wiring.

Authorized Representative:

- The Authorized Representative for this product in the EEA is:

Yokogawa Europe B. V.

Euroweg 2, 3825 HD Amersfoort, The Netherlands

Page 10: EtherNet/IP Interface Module

viii

IM 34M06H36-01E

General Requirements for Using the FA-M3 Slave Units (TAH Series)

Connect YHLS cable to SHIELD terminal:

- Connect the DRAIN line of the YHLS cable to the SHIELD terminal of the YHLS master module securely. Failing to do so may affect the performance of the YHLS system.

Do not touch components in the unit:

- Do not remove the back cover of the unit. Doing so may cause a failure.

Page 11: EtherNet/IP Interface Module

ix

IM 34M06H36-01E

Waste Electrical and Electronic Equipment Waste Electrical and Electronic Equipment (WEEE), Directive

(This directive is only valid in the EU.)

This product complies with the WEEE Directive marking requirement.

The marking indicates that you must not discard this electrical/electronic

product in domestic household waste.

Product Category

With reference to the equipment types in the WEEE directive, this product is classified as a “Monitoring and Control instruments”.

When disposing of products in the EU, contact your local Yokogawa Europe B. V. office.

Do not dispose of this product in domestic household waste.

How to dispose the batteries This is an explanation about the new EU Battery Directive. This directive is only valid in the EU.

Batteries are included in some modules of this product. The procedure is different when the user can remove or cannot remove.

Batteries the user can remove

The battery of F3RP6 and F3RP7 can be removed by yourself. When you remove the battery from F3RP6 and F3RP7 and dispose it, discard them in accordance with domestic law concerning disposal. See the User's Manual of F3RP6 and F3RP7 for the removal procedure. Take a right action on waste batteries, because the collection system in the EU on waste batteries are regulated. If you don't remove the battery from this product, please see .

Batteries the user cannot remove

Dispose the battery together with this product. When you dispose this product in the EU, contact your local Yokogawa Europe B.V.office. Do not dispose them as domestic household waste.

Battery category: Lithium battery

Note: With reference to Annex II of the new EU Battery Directive, the above symbol indicates obligatory separate collection.

Page 12: EtherNet/IP Interface Module

x

IM 34M06H36-01E

Introduction

Overview of the Manual This is the user's manual of the EtherNet/IP interface module, which is installed in an I/O slot of FA-M3.

Other Manuals Please refer to the latest versions of the following manuals as necessary.

F3SP71 and F3SP76 functions

Sequence CPU Instruction Manual - Functions (for F3SP71-4N/4S, F3SP76-7N/7S)

(IM 34M06P15-01E)

F3SP22 functions

Sequence CPU Instruction Manual - Functions (for F3SP22-0S, F3SP28-3N/3S, F3SP38-6N/6S, F3SP53-4H/4S, F3SP58-6H/6S, F3SP59-7S)

(IM 34M06P13-01E)

Instructions

Sequence CPU Instruction Manual - Instructions (IM 34M06P12-03E)

Developing ladder programs

FA-M3 Programing Tool WideField3 (IM 34M06Q16-01E, -02E, -03E, and -04E)

FA-M3 specifications and configurations that are common to all CPU modules*1, implementation and wiring, test operation, maintenance and inspection, and system limitations on module implementation

*1: For product specifications, excluding the power supply module, base module, I/O module, cable, and terminal block unit, refer to the specific user's manuals for the products.

Hardware Manual (IM 34M06C11-01E)

For e-RT3

Refer to the user's manual available on http://www.e-RT3.com/.

Page 13: EtherNet/IP Interface Module

xi

IM 34M06H36-01E

Copyrights and Trademarks

Copyrights The copyright of the programs and online manuals contained in the software medium of the Software Product shall remain in YOKOGAWA.

You are allowed to print the required pages of the online manuals for the purposes of using or operating the Product; however, reprinting or reproducing the entire document is strictly prohibited by the Copyright Law.

Except as stated above, no part of the online manuals may be reproduced, transferred, sold, or distributed to a third party in any manner (either in electronic or written form including, without limitation, in the forms of paper documents, electronic media, and transmission via the network). Nor it may be registered or recorded in the media such as films without permission.

Trademarks - Ethernet is a registered trademark of XEROX Corporation.

- ODVA, CIP, and EtherNet/IP are trademarks of ODVA.

The trade names and company names referred to in this manual are either trademarks or registered trademarks of their respective companies.

Page 14: EtherNet/IP Interface Module

Blank Page

Page 15: EtherNet/IP Interface Module

TOC-1

IM 34M06H36-01E

CONTENTS

Applicable Product ............................................................................................ i

Precautions ........................................................................................................ ii

Introduction ....................................................................................................... x

Copyrights and Trademarks ............................................................................ xi

Overview ................................................................................................ 1-1

1.1 Overview of the EtherNet/IP Interface Module ................................................. 1-1 1.2 Overview of EtherNet/IP ..................................................................................... 1-2 1.3 Overview of Communication Services Provided

by the EtherNet/IP Interface Module ............................................................... 1-10 EtherNet/IP Communication ..........................................................................................................1-10 Higher-level Link Service ...............................................................................................................1-10 Remote Programming Service ......................................................................................................1-10

1.4 Overview of the Configuration Tool ................................................................ 1-11

1.5 Additional Functions ........................................................................................ 1-12

Supported Functions of REV:01:** or later ....................................................................................1-12 Supported Functions of the Configuration Tool (R2.01 or later) ....................................................1-12

2.1 Specifications ..................................................................................................... 2-1

Model and Suffix Code ....................................................................................................................2-1

Supported CPU Modules .................................................................................................................2-1

Supported Configuration Tools for Communication Settings ...........................................................2-1

General Specifications .....................................................................................................................2-2

Specifications of EtherNet/IP Communication .................................................................................2-3

Limitation on Installation ..................................................................................................................2-3

2.2 Components and Functions .............................................................................. 2-4

External Views and Components ....................................................................................................2-4

Functions of Components................................................................................................................2-5

2.3 External Dimensions .......................................................................................... 2-9

2.4 Input/Output Relays and Registers ................................................................. 2-10

Input/Output Relays .......................................................................................................................2-10

Registers .......................................................................................................................................2-14

Special Relays (for Communication Status) ..................................................................................2-16

2.5 Mounting/Unmounting the Module ................................................................. 2-17

Mounting the Module .....................................................................................................................2-17

Unmounting the Module ................................................................................................................2-17

IM 34M06H36-01E 3rd Edition

FA-M3 EtherNet/IP Interface Module

Page 16: EtherNet/IP Interface Module

TOC-2

IM 34M06H36-01E

Mounting the Module in Intense Vibration Environments ..............................................................2-18

3.1 Procedure to Configure Settings ...................................................................... 3-2

Basic Procedure (REV:00: **) ..........................................................................................................3-3

Basic Procedure (REV:01: ** or later) ............................................................................................3-4

Advanced Procedure .......................................................................................................................3-5

3.2 CPU Settings ....................................................................................................... 3-6

Link Type .........................................................................................................................................3-7

Link System Number .......................................................................................................................3-7

Link Device Assignment ..................................................................................................................3-7

Link Refreshing Mode ......................................................................................................................3-8

Link Refreshing Range ....................................................................................................................3-8

Latch Range Setup at Power Failure...............................................................................................3-9

3.3 Network Settings .............................................................................................. 3-10

Network Settings ........................................................................................................................... 3-11

Setting Procedure ..........................................................................................................................3-13

3.4 Config Area Size Settings ................................................................................ 3-14

3.5 EtherNet/IP Communication Settings ............................................................. 3-17

I/O Mapping ...................................................................................................................................3-17

Connection ....................................................................................................................................3-18

Scanner .........................................................................................................................................3-18

Adapter ..........................................................................................................................................3-22

3.6 Wiring and Connecting .................................................................................... 3-23

Connecting Communication Cable ................................................................................................3-23

Shielding ........................................................................................................................................3-23

CE Marking Conformance .............................................................................................................3-24

4.1 I/O Communication ............................................................................................. 4-2

Relays to Be Used ...........................................................................................................................4-2

Starting I/O Communication ............................................................................................................4-3

Accessing I/O Communication Data ................................................................................................4-4

Sample Program ..............................................................................................................................4-5

4.2 Message Communication Client ....................................................................... 4-6

Request Format and Response Format ..........................................................................................4-6

Procedure to Transmit a Message...................................................................................................4-9

Sample Program ............................................................................................................................4-10

4.3 Message Communication Server .................................................................... 4-17

5.1 Higher-level Link Service ................................................................................... 5-1

Specifications ..................................................................................................................................5-2

5.2 Remote Programming Service .......................................................................... 5-3

Specifications ..................................................................................................................................5-3

5.3 TCP Connection Closing .................................................................................... 5-4

Connection Information ...................................................................................................................5-4

Closing Connections ........................................................................................................................5-5

Page 17: EtherNet/IP Interface Module

TOC-3

IM 34M06H36-01E

6.1 LED Indicators .................................................................................................... 6-2

The “RDY” LED Does Not Light Up .................................................................................................6-2

The “STS” LED Does Not Light Up ..................................................................................................6-3

The Green “EIP” LED Does Not Light Up or Flash ..........................................................................6-4

The Red “EIP” LED Lights Up or Flashes........................................................................................6-5

6.2 Error Codes ......................................................................................................... 6-6

Error-Clearance Function ................................................................................................................6-6

Error Registers ................................................................................................................................6-6

Error Codes .....................................................................................................................................6-7

Warning Codes ................................................................................................................................6-7

CIP Error Codes ..............................................................................................................................6-8

6.3 I/O Communication Cannot Be Enabled ......................................................... 6-11

7.1 Main Screen ......................................................................................................... 7-4

7.2 Loading EDS Files .............................................................................................. 7-7

7.3 Registering Devices in the Scan List ................................................................ 7-7

7.4 Configuring F3LN01 Network Settings ............................................................. 7-8

7.5 Setting the IP Addresses of Adapters .............................................................. 7-9

7.6 Setting F3LN01 Adapter Tags .......................................................................... 7-10

7.7 Configuring Adapter Connection Settings ..................................................... 7-11

Using F3LN01 as an Adapter ........................................................................................................7-13

Disable the Minor Revision Check of the Adapter .........................................................................7-14

7.8 Assigning Tags to Link Registers (W) ............................................................ 7-16

7.9 Checking the Scan List .................................................................................... 7-18

7.10 Downloading Settings ...................................................................................... 7-19

7.11 Scan List Monitor .............................................................................................. 7-21

7.12 Monitor CIP Status ............................................................................................ 7-22

7.13 Checking Adapter Information ........................................................................ 7-23

7.14 Checking the Settings ...................................................................................... 7-24

7.15 Export................................................................................................................. 7-24

7.16 Scanning Adapters ........................................................................................... 7-25

7.17 Main Menu ......................................................................................................... 7-26

Appendix 1. EDS File ................................................................... Appendix 1-1

Appendix 1.1 EDS Files of this Module ................................................... Appendix 1-1

Appendix 1.2 Overview of EDS Files ....................................................... Appendix 1-2 Appendix 1.3 Parameter Settings Procedure .......................................... Appendix 1-6

Parameter Settings Procedure ....................................................................................... Appendix 1-6

Parameter Settings Procedure Example ........................................................................ Appendix 1-7

Appendix 1.4 Procedure to Check the Config Area Size ....................... Appendix 1-8 Checking Procedure ....................................................................................................... Appendix 1-8

Checking Procedure Example ........................................................................................ Appendix 1-8

Appendix 2. Tool Commands ...................................................... Appendix 2-1

Appendix 2.1 Specifications ..................................................................... Appendix 2-1 Registers to Be Used ...................................................................................................... Appendix 2-1

Procedure to Run a Tool Command ............................................................................... Appendix 2-3

Tool Commands .............................................................................................................. Appendix 2-4

Page 18: EtherNet/IP Interface Module

TOC-4

IM 34M06H36-01E

EtherNet/IP Settings Write ($0011)................................................................................. Appendix 2-5

EtherNet/IP Settings Read ($0012) ................................................................................ Appendix 2-6

Network Settings Write ($0031) ...................................................................................... Appendix 2-7

Network Settings Read ($0032) ..................................................................................... Appendix 2-8

Operation Mode Setting Write ($0041) ........................................................................... Appendix 2-9

Operation Mode Setting Read ($0042) ........................................................................ Appendix 2-10

Error Codes .................................................................................................................. Appendix 2-10

Appendix 2.2 Sample Programs ............................................................. Appendix 2-11 Network Settings Write .................................................................................................. Appendix 2-11

EtherNet/IP Settings Read ........................................................................................... Appendix 2-13

EtherNet/IP Settings Write ............................................................................................ Appendix 2-15

Appendix 3. EtherNet/IP Setting Data ......................................... Appendix 3-1

Appendix 3.1 Corresponding to Config Area Size .................................. Appendix 3-1 Appendix 3.2 EtherNet/IP Setting Data .................................................... Appendix 3-2

For 64 bytes .................................................................................................................... Appendix 3-2

For 500 bytes ................................................................................................................. Appendix 3-6

Appendix 4. Tips ........................................................................... Appendix 4-1

Revision Information ................................................................................ Rev-1

Page 19: EtherNet/IP Interface Module

1-1

IM 34M06H36-01E

Overview

1.1 Overview of the EtherNet/IP Interface Module

The EtherNet/IP interface module (“this module”) is an EtherNet/IP scanner-adapter module that is designed to be installed in an I/O slot of the range-free controller FA-M3V.

The EtherNet/IP interface module provides the following functions:

- High-speed, high-volume I/O communication with EtherNet/IP equipment

- Message communication with EtherNet/IP equipment

- Higher-level link service This module supports the higher-level link communication, which is a standard FA-M3 communication service. This enables external equipment to read from and write into devices in CPU modules.

- Remote programming service This service enables communication with FA-M3 Programming Tool WideField3. With this service, you can use FA-M3 Programming Tool WideField3 running on a networked personal computer to download or upload data, monitor programs, monitor devices, and edit online.

- Various methods to configure communication settings EtherNet/IP communication settings can be configured by using the configuration tool “FA-M3 Configuration Tool EtherNet/IP Interface Module”(hereinafter “configuration tool”) or user programs. You can select a method suited to you, for example, using a graphical tool to configure specific settings or developing an application to automate the configuration. The configuration tool can be used for configuration through the EtherNet/IP interface module or a CPU module.

Note For REV:01:** or later of this module, refer to "1.5 Additional functions".

Page 20: EtherNet/IP Interface Module

1-2

IM 34M06H36-01E

1.2 Overview of EtherNet/IP EtherNet/IP (Ethernet Industrial Protocol) is an open, global industrial Ethernet protocol that adapts CIP (Common Industrial Protocol), which is a protocol for industrial automation applications managed by ODVA (ODVA, Inc.).

EtherNet/IP enables I/O communication and message communication according to CIP specifications.

In EtherNet/IP terminology, I/O communication is called implicit connection and message communication is called explicit messaging connection.

This section provides basic information about EtherNet/IP to help users of this module.

Page 21: EtherNet/IP Interface Module

1-3

IM 34M06H36-01E

Configurations of I/O communication

I/O communication is enabled between a scanner that is a device to transmit connection requests and adapters that are devices to receive the connection requests.

The scanner configures and maintains the communication settings according to the specifications of the adapter.

For this module, the communication settings constitute a Scan List. The settings for each adapter device are managed by a Scan No.

Scan List

Scanner device Adapter deviceScan No.0

Adapter deviceScan No.1

Adapter deviceScan No.2

.

.

.

Communication settings for Scan No.0

Communication settings forScan No.1

Communication settings for Scan No.2

.

.

.

Figure 1.1 Configuration of I/O Communication (1)

Some devices are able to be a scanner and an adapter at the same time.

Such a device can work as a scanner to communicate with adapters while it also works as an adapter to communicate with another scanner.

Scanner S1/Adapter deviceScan No.0 of S0

Adapter device Scan No.0 of S1

Adapter device Scan No.1 of S1

Adapter device Scan No.2 of S1

.

.

.

Scanner S0

Adapter deviceScan No.1 of S0

Adapter deviceScan No.2 of S0

.

.

.

Figure 1.2 Configuration of I/O Communication (2)

Page 22: EtherNet/IP Interface Module

1-4

IM 34M06H36-01E

I/O communication

I/O communication is enabled by specifying a logical path or tag that is defined on an adapter. Communication with an adapter device can be output or input. The output and input are configurable independently with a specific communication interval. In EtherNet/IP terminology the communication interval is called RPI (Requested Packet Interval). In EtherNet /IP communication, you can set RPI for each tag according to its priority to ensure efficient communication.

Example: RPI 5ms for high priority, RPI 50ms for low priority

Figure 1.3 Scanner-Adapter Communication (1)

Figure 1.4 Scanner-Adapter Communication (2)

Page 23: EtherNet/IP Interface Module

1-5

IM 34M06H36-01E

Establishing a connection from a scanner to an adapter

A scanner device inquires of an adapter in a way appropriate to the communication type (logical segment communication or symbolic segment communication) defined on the adapter. An instance ID is used for logical segment communication and a tag name is used for symbolic segment communication.

In a case where a connection is established by a scanner, a device that requests a connection is called an originator (O) and a device that receives the request is called a target (T). “O T” and “O to T” mean that data is transferred from the originator to the target. Conversely, “T O” and “T to O” mean that data is transferred from the target to the originator.

Scanner device

Tag O => T(Scanner Output)

Tag name / Instance IDSize: 100 bytes

Adapter device

Tag O => T(Tag for Adapter(Input))Tag name / Instance ID

Size: 100 bytes

Tag T => O(Tag for Adapter(Output))Tag name / Instance ID

Size: 10 bytes

Tag T => O(Scanner Input)

Tag name / Instance IDSize: 10 bytes

Adapter information

Vendor codeProduct typeProduct codeMajor revisionMinor revision

Originator (O)

Target (T)

Originator (O)

Target (T)

(O => T)

(T => O)

IP address

Figure 1.5 Establishing a Connection from a Scanner to an Adapter

To ensure that a connection is established by an originator, the adapter information (refer to Table 1.1) on the target must match that maintained in the scan list.

Additionally, the data sizes must also match each other.

Note that adapter information maintained in the scan list comes from the EDS (Electronic Data Sheets) file provided by the adapter device.

Table 1.1 Adapter Information

Item Description

Vendor id (VendCode) A code registered with ODVA to identify the vendor Product type (VendName) A code defined by ODVA to identify the product type Product code (ProdCode) A code set by the vendor to identify the product Major revision (MajRev) A major revision of the product Minor revision (MinRev) A minor revision of the product

Page 24: EtherNet/IP Interface Module

1-6

IM 34M06H36-01E

Parameter settings for adapter devices in IO communication

If a configuration instance is defined in the EDS file, the adapter equipment parameters are set at the start of IO communication. Note that there is no configuration instance defined in the EDS file of this module.

EDS file Scanner

Tag(O => T)Instance ID100Size:100 bytes

Adapter

Tag(O => T)Instance ID100Size:100 bytes

Tag(T => O)Instance ID101Size:100 bytes

Tag(T => O)Instance ID101Size:100 bytes

Instance ID 199Config Area Size

98 bytes

Parameter settings(example)

Instance ID 199Config Area Size

500 bytes

Parameter settings(example)

ConfigurationConfiguration

Tag(O => T)Instance ID100Size:100 bytes

Tag(T => O)Instance ID101Size:100 bytes

Configuration

Instance ID 199Config Area Size

98 bytes

Parameter settings(example)

Port1 modePort2 mode・

・Port8 mode

Configuration of each Port mode

Port1 modePort2 mode・

・Port8 mode

Port1 modePort2 mode・

・Port8 mode

Setting at the start of IO communication

cyclic communication

cyclic communication

- What you can do with parameter settings

When IO communication is started, the set values of the parameters of the configuration instance of the EDS file can be set to an adapter device. The parameter setting values can be changed by changing the parameter setting values (Default Data Values) in the EDS file in advance.

The minimum and maximum values of the parameters are defined in the EDS file, and can be changed within this range. For the specifications of the parameters, contact the adapter equipment manufacturer.

Note The parameter setting is often used for port settings of adapter devices.

・About config area size

In this document, the configuration instance size is called the Config Area Size.

Note If the Config Area Size of one of the connected adapter devices is 65 bytes or more, the Config Area Size of this module must be set to 500 bytes.

For details, refer to "3.4 Config Area Size Setting".

Page 25: EtherNet/IP Interface Module

1-7

IM 34M06H36-01E

Allowable communication bandwidth

The allowable communication bandwidth of an EtherNet/IP scanner device is expressed in pps (packets per second), which represents the number of transmitted/received packets that the scanner can process per second. EtherNet/IP requires that the system be built with the allowable communication bandwidth in mind.

The system must be constructed so that the following is true.

communication bandwidth of a system(pps) <= communication bandwidth of this module(pps)

pps: packet per second: the number of transmitted/received packets that the scanner can process per second.

When this module is used as a scanner, the communication bandwidth of a system is automatically calculated and displayed in the lower toolbar of the configuration tool.

Note For details, refer to "■Scanner" in "3.5 EtherNet/IP Communication Settings”

Page 26: EtherNet/IP Interface Module

1-8

IM 34M06H36-01E

Message communication

In addition to I/O communication, the EtherNet/IP specifications define message communication.

For message communication, a device that issues a request is called a client and a device that receives the request is called a server.

Servers can provide services for each device such as reading or writing information from or to the device.

Clients can access services provided by servers.

Message communication is also used for I/O communication to establish the initial connection.

The message communication client of this module can implement message communication according to the EtherNet/IP specification. The message communication server of this module provides only functions that are required for EtherNet/IP.

Others

- Transmission triggers

The following types of trigger are available to make a transmission:

Cyclic: Makes transmissions periodically. The interval is specified in RPI.

Change of State: Makes a transmission when data changes. PIT (Production Inhibit Timer) can be specified to prevent transmissions from being made at very short intervals even when data changes frequently.

Application: Allows an application on the device to make transmissions anytime.

This module supports the Cyclic and Change of State triggers.

- Communication priorities

The following types of priority are available:

Low

High

Scheduled: The data transmission speed is limited by the specified RPI. Real transmissions can be slower than the specified RPI.

Urgent

This module supports only the Scheduled priority.

Page 27: EtherNet/IP Interface Module

1-9

IM 34M06H36-01E

- Connection types

The following connection types are available:

Point-to-Point: A connection that enables unicast communication between a scanner and an adapter. This can be used for O T and T O communications.

Multicast: A connection that enables multicast communication for data transmitted from an adapter. The transmitted data can be received by multiple scanners. This can be used only for T O communication. To establish a multicast connection, all scanners must be the same in the following settings: - RPI (Requested packet interval) - Communication type (instance ID or tag name) - Data size - Transmission trigger

This module supports both connection types.

- Real time formats

The following formats are available depending on the data to be transmitted:

Modeless: Data in this format includes 0 or more bytes of application data but does not include a Run/Idle notification. This format is used for normal data transmissions.

Zero Length:

Heartbeat: This format is used when the length of application data is zero bytes. When an “Input only” connection is selected, this format is used for output communication.

32-bit Header: Data in this format includes 0 or more bytes of application data and also includes a Run/Idle notification.

This module supports the Modeless, Heartbeat, and 32-bit Header formats depending on adapters.

Page 28: EtherNet/IP Interface Module

1-10

IM 34M06H36-01E

1.3 Overview of Communication Services Provided by the EtherNet/IP Interface Module

This section describes communication services provided by the EtherNet/IP interface module.

EtherNet/IP Communication

I/O communication

You can implement cyclic data exchange between devices on an EtherNet/IP network without a need to write programs.

For I/O communication, the EtherNet/IP interface module uses tags to transfer data. Tags can be defined with the configuration tool “FA-M3 Configuration Tool EtherNet/IP Interface Module”. A connection to a target device is established for each tag. That is, one tag uses one connection. Up to 256 tags can be registered.

The following table describes the specifications of tags.

Table 1.4 Specifications of Tags

Item Specification Note

Maximum size of a tag 722 words (1444 bytes) If the Scan No are separated, IO communication over 1444 bytes can be performed for the same adapter (refer to “Appendix4.2”).

Maximum number of tags per Scan No

2 (1 for input , 1 for output )

Maximum total size of all tags 8192 words (16384 bytes) -

Maximum number of registered tags

256 (128 for input, 128 for output) This module can connect with up to 128 adapters. Total number of tags for scanner/adapter

Communication interval(RPI) 1 to 10000 ms -

Message communication

You can send any commands to devices on an EtherNet/IP network.

You can develop an application that issues read, write, or other commands without establishing connections and receives responses.

Higher-level Link Service

The higher-level link service enables higher-level computers to issue personal computer link commands over UDP/IP or TCP/IP. With this service, higher-level computers can control CPU modules on an Ethernet network, for example, by reading from or writing into sequence devices or changing the mode.

Remote Programming Service

The remote programming service enables FA-M3 Programming Tool WideField3 to connect to perform various operations.

Page 29: EtherNet/IP Interface Module

1-11

IM 34M06H36-01E

1.4 Overview of the Configuration Tool The configuration tool for EtherNet/IP communication settings is available for this module. The specifications of the configuration tool are as follows.

Note For details on installing the configuration tool (R2.01 or later), refer to "Appendix 4.8 Installation of the configuration tool".

Table 1.5 Specifications of the Configuration Tool

Item Specification

System requirements

PC PC/AT compatible computer

OS Microsoft Windows 10 (32-bit/64-bit) Microsoft Windows 7 (32-bit/64-bit)

CPU 1 GHz or more Memory 1 GB or more HDD capacity 20 MB or more available space Display 1024 x 768 dots or more

Connection media

USB F3SP7x USB port

Ethernet F3SP7x Ethernet port F3LExx Ethernet port F3LN01 Ethernet port

Function Writes communication settings into this module. Supports the EtherNet/IP connection of this module. Reads settings from this module.

Note EtherNet/IP Configurator supports only F3LN01 as an EtherNet/IP scanner device for which you can configure connection settings. The Configurator cannot configure connection settings of scanner devices provided from other manufacturers.

Page 30: EtherNet/IP Interface Module

1-12

IM 34M06H36-01E

1.5 Additional Functions This section describes the additional functions of this module.

Supported Functions of REV:01:** or later

Additional functions Reference

Support for Config Area Size (500 bytes) (previously 64 bytes) Section 3.4 Addition of tool commands - Operation mode setting write - Operation mode setting read

Appendix2.

Supported Functions of the Configuration Tool (R2.01 or later)

Additional functions Reference

Support for Config Area Size (500 bytes) (previously 64 bytes) Section 3.4

Support for Disable the minor revision check of the adapter Appendix4.7 Appendix4.8

Page 31: EtherNet/IP Interface Module

2-1

IM 34M06H36-01E

2. Specifications of the EtherNet/IP Interface Module

2.1 Specifications

Model and Suffix Code Table 2.1 General Specifications

Model Suffix Code

Style Code

Option Code

Description

F3LN01 -0N ... ... EtherNet/IP Interface Module (“this module”)

SF673 -MDW ... ... FA-M3 Configuration Tool EtherNet/IP Interface Module

Supported CPU Modules Table 2.2 Supported CPU Modules

Model Specification

F3SP22-0S 10K ladder steps, basic instruction 0.045 μs minimum, with memory F3SP71-4S 60K ladder steps, basic instruction 0.00375 μs minimum, with network functions F3SP76-7S 260K ladder steps, basic instruction 0.00375 μs minimum, with network functions F3RP71-1R CPU module for Linux, ROM: 128 MB, RAM: 256 MB F3RP71-2L CPU module for Linux, ROM: 256 MB, RAM: 1 GB, SRAM: 4 MB

Supported Configuration Tools for Communication Settings Table 2.3 Supported Configuration Tools for Communication Settings

Model Product Name

SF630-MCW FA-M3 Programing Tool WideField3 SF673-MDW FA-M3 Configuration Tool EtherNet/IP Interface Module

This Module REV Config Area Size*1 Configuration Tool (SF673-MDW) REV

00:** 64 bytes R1.01

01:** or later 64 bytes 500 bytes R2.01 or later

*1: The config area size of the adapter device that can be connected when the scanner is operating.

Page 32: EtherNet/IP Interface Module

2-2

IM 34M06H36-01E

General Specifications Table 2.4 General Specifications

Item Specification

Operation surrounding air temperature range

0 to 55°C

Operation surrounding humidity range

10 to 90% RH (non-condensing)

Storage surrounding air temperature range

-20 to 75°C

Storage surrounding humidity range 10 to 90% RH (non-condensing) Operation surrounding atmosphere No corrosive gas or heavy dust Power consumption 330 mA or less (5 V DC) External dimensions 28.9 (W) x 100 (H) x 83.2 (D) mm (excluding protrusions) Weight 100 g

Page 33: EtherNet/IP Interface Module

2-3

IM 34M06H36-01E

Specifications of EtherNet/IP Communication Table 2.5 Specifications of EtherNet/IP Communication

Item Specification

Physical layer 10BASE-T / 100BASE-TX Data speed 10 / 100 Mbps Maximum segment length*1 100 m

I/O communication

Maximum number of connections

256

Communication interval (RPI*2)

1 to 10,000 ms (specific to each connection, incremented by 1 ms)

Transmission trigger Cyclic or COS (Change of State) Communication priority Scheduled

Connection type OT: Point-to-Point TO: Point-to-Point or Multicast

Maximum data size of refreshing

16384 bytes

Maximum data size per connection

1444 bytes

Allowable communication bandwidth*3

6000 pps (for 504-byte communication) 3000 pps (for 1444-byte communication)

Config area size*4 64 bytes (factory default) 500 bytes (supported for REV:01:** or later)

Message communication

Message type Client: Class3 (Connected Message Manager)

UCMM (Unconnected Message Manager) Server: Class3, UCMM

Maximum data size 504 bytes *1: This is a distance from the HUB to a node. *2: Stands for Request Packet Interval. *3: “pps” stands for packets per second. This represents the number of transmitted/received packets that can be processed per

second. *4: The config area size of the adapter device that can be connected when the scanner is operating.

Limitation on Installation Table 2.6 Limitation on a Multi-module Installation

Installation Module Maximum Number of

Installed Modules

F3LN01-0N only - Up to 6 (Modules cannot be installed in a sub-unit.)

Coexisting with FA link modules

FA Link Module F3LP01 FA Link H Module F3LP02 FA Link H2 Module F3LP32 Fiber-optic FA Link H Module F3LP02

Up to 8 modules can be mixed.

Coexisting with other modules

Personal Computer Link Module F3LC Ethernet Interface Module F3LE FL-net Interface Module F3LX02

Up to 6 modules can be mixed.

Table 2.7 Limitation on Each CPU Module

CPU Module Limitation

F3SP22-0S F3SP71-4S

Up to 1 for each CPU module*1

F3SP76-7S F3RP71-1R F3RP71-2L

Up to 2 for each CPU module*2

*1: The total number including FL-net Interface Module F3LX02 is limited to 1. *2: The total number including FL-net Interface Module F3LX02 is limited to 2.

Page 34: EtherNet/IP Interface Module

2-4

IM 34M06H36-01E

2.2 Components and Functions

External Views and Components

Indicators

10BASE-T/100BASE-TX connector

Front view Right side view

IP address setup switches

RDYSTSEIPEIP

10BASE-T/100BASE-TX

Note: The right side view shows the module with its cover removed.

LN01-0N EIP

Operating condition setup switches

Figure 2.1 External Views and Components

Page 35: EtherNet/IP Interface Module

2-5

IM 34M06H36-01E

Functions of Components

Indicators

The behavior (on, off, or flashing) of LEDs indicates various statuses of the module.

Table 2.8 Indicators

Name Status Color Behavior State Notes

RDY Internal circuit status

Green On Normal

Off Hardware failure

STS Module status Green

On Normal EtherNet/IP can be executed.

Flashing Writing to flash memory

Off Error Refer to the error codes in Table 6.2.

EIP (Green) EIP (Red)

Network status

Green On

Online*1, EtherNet/IP is enabled.

Flashing Online*1, EtherNet/IP is not enabled.

Red On

Module error Initialization mode

Flashing Communication error Scanning can continue.

- Off Offline*1 *1: “Online” means a state where the IP address is valid and the link is up and running. “Offline” means any states other than

“Online”.

CAUTION

- This module cannot start successfully when operating condition setup switch 8 is off and the IP address setup switches are set to 0.0.0.0. The red EIP LED lights up.

- By factory default, the IP address is set to 0.0.0.0 and all operating condition setup switches are set to off. When you start this module with the default settings, the red EIP LED lights up. Before you install this module, ensure that a valid IP address is set.

- When you set the IP address setup switches to 255.255.255.255 and then start this module, the settings stored in the flash memory are reset to the factory default state. In this case, the red EIP LED lights up.

10BASE-T/100BASE-TX connector

This connector is used for connecting a 10BASE-T/100BASE-TX (UTP/STP) cable. The LINK and COM LEDs on the connector are not used. For a 10BASE-T/100BASE-TX cable, use a twisted-pair (UTP/STP) straight cable of Category 5 or more.

Page 36: EtherNet/IP Interface Module

2-6

IM 34M06H36-01E

IP address setup switches

This is a set of 16-position rotary switches for setting an IP address. Example) To set an IP address of 192.168.250.210:

Figure 2.2 IP Address Setup Switches

CAUTION

- This module cannot start successfully when operating condition setup switch 8 is off and the IP address setup switches are set to 0.0.0.0. The red EIP LED lights up.

- By factory default, the IP address is set to 0.0.0.0 and all operating condition setup switches are set to off. When you start this module with the default settings, the red EIP LED lights up. Before you install this module, ensure that a valid IP address is set.

- When you set the IP address setup switches to 255.255.255.255 and then start this module, the settings stored in the flash memory are reset to the factory default state. In this case, the red EIP LED lights up.

- Do not touch the components inside this module when you work with the operating condition setup switches. Doing so may damage the components and lead to module failure.

C

0

8

A

A

2

DF

Hexadecimal

Decimal

C0 A8 FA D2

192 168 250 210. . .

Page 37: EtherNet/IP Interface Module

2-7

IM 34M06H36-01E

Operating condition setup switches

Table 2.9 Operating Condition Setup Switches

No. Function OFF ON

1 Data format setting ASCII (Port number: 12289/$3001)

Binary (Port number: 12289/$3001)

2 Write protection Disabled (Not protected) Enabled (Protected) 3

Reserved Always set to off Not configurable 4 5 6 7

8 IP address selection Switch Setting (IP address setup switches setting)

Software Setting (flash memory settings)

Data format setting

The switch sets the data format to be used when the higher-level link service (port number: 12289/$3001) is used from other nodes.

OFF: ASCII format ON: Binary format

The meaning of the switch is reversed when the port number 12291/$3003 is used for the higher-level link service. For details, refer to “5.1 Higher-level Link Service”.

Write protection

The switch allows or blocks other nodes that attempt to write into sequence devices or download programs with the higher-level link service.

OFF: Disabled (Not protected) ON: Enabled (Protected)

This setting is not applicable when the higher-level link service is not used.

CAUTION

- By factory default, the IP address is set to 0.0.0.0 and all operating condition setup switches are set to off. When you start this module with the default settings, the red EIP LED lights up. Before you install this module, ensure that a valid IP address is set.

- Do not touch the components inside this module when you work with the operating condition setup switches. Doing so may damage the components and lead to module failure.

Page 38: EtherNet/IP Interface Module

2-8

IM 34M06H36-01E

REV, MAC address

The REV and MAC address can be found on the left side or top of the module.

EtherNet/IP

MODEL :F3LN01SUFFIX :-0N

REV :01:00SUPPLY :5VDC 330mASUPPLY2 :INPUT :-

OUTPUT :-MAC ID :000064_ _ _DATE :2018/05/01NO. :

REV:FF:HH FF is firmware revision number. HH is hardware revision number.

(left side of this module)

xxxxxxxx xx

2018/05/01 01:00

(top side of this module)

MAC addressEvery module is assigned with a unique address expressed in a 12-digit hexadecimal number.

REV:FF:HH FF is firmware revision number. HH is hardware revision number.

Figure 2.3 REV, MAC Address

Page 39: EtherNet/IP Interface Module

2-9

IM 34M06H36-01E

2.3 External Dimensions

LN01-0N EIP

10BASE-T/100BASE-TX

RDYSTSEIPEIP

28.983.2

210

0

Units: mm

Figure 2.4 External Dimensions

Page 40: EtherNet/IP Interface Module

2-10

IM 34M06H36-01E

2.4 Input/Output Relays and Registers

Input/Output Relays

Table 2.10 Input/Output Relays

Input Relay Description Output Relay Description

X001 EtherNet/IP Availability Y033 EtherNet/IP Start Request

X002 EtherNet/IP Communication Error

Y034 Reserved

X003 Module Status Y035 Reserved X004 Reserved Y036 Reserved

X005 Message Transmission Completion

Y037 Message Transmission Request

X006 Message Transmission In-progress

Y038 Reserved

X007 Reserved Y039 Reserved X008 Reserved Y040 Reserved X009 Error-Clearance Completion Y041 Error-Clearance Request X010 Module Error Y042 Reserved X011 Reserved Y043 Reserved X012 Module Start-up Y044 Reserved X013 Reserved Y045 Reserved X014 Reserved Y046 Reserved X015 Reserved Y047 Reserved X016 Reserved Y048 Reserved X017 Reserved Y049 Reserved X018 Reserved Y050 Reserved X019 Reserved Y051 Reserved X020 Reserved Y052 Reserved X021 Reserved Y053 Reserved X022 Reserved Y054 Reserved X023 Reserved Y055 Reserved X024 Reserved Y056 Reserved X025 Reserved Y057 Reserved X026 Reserved Y058 Reserved X027 Reserved Y059 Reserved X028 Reserved Y060 Reserved X029 Reserved Y061 Reserved

X030 Disconnection Request Received

Y062 Disconnection Request

X031 Parameter Area Error Y063 Reserved X032 Online Y064 Reserved

: Slot number

Note

The Reserved output relays should always be used in the OFF position.

Page 41: EtherNet/IP Interface Module

2-11

IM 34M06H36-01E

The following is an overview of input/output relays and their references. For the following relays, please refer to the next page. - Module Start-up (X0 12) - Module Status (X0 03) - Module Error (X0 10) - Parameter Area Error (X0 31) - Online (X0 32)

Relay Description Description Reference

X012 Module Start-up Module Start-up Status Section 6.1

X003 Module Status Status of the EtherNet/IP communication can be executed.

Section 4.1

X010 Module Error

Module Error/Setting Error - Boot error - Incorrect switch setting - Incorrect configuration - Internal error

Section 6.2 Table 6.2

X031 Parameter Area Error

Flash memory Area Error - Power off while writing to

flash memory - Flash memory write error

Appendix 2 No.7 of Appendix 4.1

Y041 Error-Clearance Request Error-Clearance Function for error codes

Section 6.2 Section 7.11 X009 Error-Clearance Completion

Y033 EtherNet/IP Start Request EtherNet/IP Communication Function - IO communication - Message Transmission

Section 4.1 X001 EtherNet/IP Availability

X002 EtherNet/IP Communication Error

Y037 Message Transmission Request

Message Communication Client

Section 4.2 X005 Message Transmission Completion

X006 Message Transmission In-progress

X030 Disconnection Request Received

TCP Connection Closing Section 5.3 Y062

Disconnection Request Received

X032 Online Linkup status - : Slot number

Page 42: EtherNet/IP Interface Module

2-12

IM 34M06H36-01E

Module Start-up (X012)

Indicates that the module is started. Check that it is turned on before accessing this module. This relay is turned off when the module is started in initialization mode. If this relay is not turned on except in initialization mode, this module is not Start-up. Please take the following measures. measures - Check the LED status and take the measures described in "6.1 LED Indicators".

CAUTION

For initialization mode, refer to Table 3.1. If the problem persists, replace the module as it may be a hardware failure.

Module Status (X003)

Indicates whether the EtherNet/IP start request can be performed. ON: Normal. In this state, you can make an EtherNet/IP start request. OFF: Error or writing into the flash memory.

In this state, you cannot make an EtherNet/IP start request.

This relay's state becomes the STS LED state (refer to Table 2.8).

Module Error (X010)

When one of the following module errors is detected, this relay turns on (refer to section 6.2). - boot error - Incorrect switch - Incorrect configuration - Internal error When this relay turns on, the STS LED turns off. measures - refer to section “6.2 Error codes”.

Page 43: EtherNet/IP Interface Module

2-13

IM 34M06H36-01E

Parameter Area Error (X031)

If the Parameter (Flash memory) Area Error relay turns on, download parameters again. If this relay is still on, you need to replace the module because there might be a hardware failure. If the problem re-occurs, take the following measures. measures - when the power is turned off, check that you have not done any settings from the

configuration tool or tool commands. - Reconsider the installation environment for noise and other factors.

CAUTION

If the problem persists, replace the module as it may be a hardware failure.

Online (X032)

Turns on to indicate an online state where the IP address is valid and the link is up and running. In this state, the network communication can be enabled. This relay's state becomes the EIP(Green) LED state (refer to Table 2.8).

Page 44: EtherNet/IP Interface Module

2-14

IM 34M06H36-01E

Registers Table 2.11 Registers (1/2)

Data Position

Item Description R/W

1

MAC address*1

The MAC address of the module

Data Position

R 2

3

4

IP address*1

The IP address of the module

Data Position

R 5

6

Subnet mask*1

The subnet mask of the module

Data Position

R 7

8 Default gateway*1

The default gateway of the module

Data Position R

9

10 IP TTL IP Time to Live R 11 to 15 Reserved Reserved -

16 Config Area Size 0: 64 bytes (REV:00:**) 64: 64 bytes (REV:01:** or later) 500: 500 bytes (REV:01:** or later)

R

17 Operating condition setup switch 1

0 indicates OFF. 1 indicates ON.

R

18 Operating condition setup switch 2

R

19 Operating condition setup switch 3

R

20 Operating condition setup switch 4

R

21 Operating condition setup switch 5

R

22 Operating condition setup switch 6

R

23 Operating condition setup switch 7

R

24 Operating condition setup switch 8

R

25 to 33 Reserved Reserved - 34 Error code 1*2 Error summary R 35 Error code 2*2 Error details R 36 Warning code 1*3 Warning summary R 37 Warning code 2*3 Warning details R

38 CIP error 1*4 General status code returned from the EtherNet/IP function

R

39 CIP error 2*4 Additional code returned from the EtherNet/IP function

R

40 to 64 Reserved Reserved - 65

EtherNet/IP settings

Command number R/W 66 to 250 Parameters (185 words) R/W 251 to 254 Reserved - 255 Command Run Request flag R/W 256 Command Run Completion flag R

*1: The stored value is applied if it is valid. *2: This stores the information of the first error. You need to request an error-clearance to store a new error. *3: This stores the information of the first warning. You need to request an error-clearance to store a new warning. *4: This stores the information of the first CIP error. You need to request an error-clearance to store a new CIP error.

Page 45: EtherNet/IP Interface Module

2-15

IM 34M06H36-01E

Table 2.12 Registers (2/2)

Data Position

Item Description R/W

257

Remote programming service

Disconnection flag R/W 258 to 260 Reserved - 261 to 262

Connection information 1

Destination IP address R 263 Destination port number R 264 Source port number R 265 to 266

Connection information 2

Destination IP address R 267 Destination port number R 268 Source port number R 269 to 384 Reserved - 385

Higher-level link service

Disconnection flag R/W 386 to 388 Reserved - 389 to 390

Connection information 1

Destination IP address R 391 Destination port number R 392 Source port number R 393 to 394

Connection information 2

Destination IP address R 395 Destination port number R 396 Source port number R 397 to 398

Connection information 3

Destination IP address R 399 Destination port number R 400 Source port number R 401 to 402

Connection information 4

Destination IP address R 403 Destination port number R 404 Source port number R 405 to 406

Connection information 5

Destination IP address R 407 Destination port number R 408 Source port number R 409 to 410

Connection information 6

Destination IP address R 411 Destination port number R 412 Source port number R 413 to 414

Connection information 7

Destination IP address R 415 Destination port number R 416 Source port number R 417 to 418

Connection information 8

Destination IP address R 419 Destination port number R 420 Source port number R 421 to 512 Reserved - 513

EtherNet/IP message client

Received service data size R 514 to 519 Reserved - 520 Completion code R 521 Error code R 522 to 576 Reserved - 577 Transmitted service data size R/W 578 to 579 Destination IP address R/W 580 Service R/W 581 Class R/W 582 Instance R/W 583 Attribute R/W 584 Timeout R/W 585 to 768 Reserved - 769 to 1020 Received message buffer R 1025 to 1276 Transmitted message buffer R/W

Page 46: EtherNet/IP Interface Module

2-16

IM 34M06H36-01E

Special Relays (for Communication Status)

Communications can be monitored for the registration status and connection status by using the scan numbers in the scan list. A bit corresponding to the scan number indicates the status of the communication.

Scan Number

For sequence CPU modules

You can use the special relays to monitor the status.

Table 2.13 Communication Status

Special Relay Number Name Description

System 1 System 2

M3521 to M3648 M4561 to M4688 Registration for scanner communication

0: Not registered 1: Registered

M3649 M4689 Registration for adapter communication

0: No adapter is registered. 1: One or more adapters are registered.

M3777 to M3904 M4817 to M4944 Connection status of scanner communication

0: Not available / Disconnected 1: Connected

M3905 M4945 Connection status of adapter communication

0: All adapters are not available or are disconnected 1: One or more adapters are connected.

For e-RT3 CPU modules

You can use functions for the FL-net interface module to get the network participation status and to get higher-level operation signal errors. Function: Gets the network participation status.

Syntax: int getM3FlnNt ( unsigned short sysNo, unsigned short network[16] ); Reads the registration status for communication.

Function: Gets higher-level operation signal errors.

Syntax: int getM3FlnEr ( unsigned short sysNo, unsigned short err[16] ); Reads the connection status for communication.

Note

To use the e-RT3 CPU module, refer to “e-RT3 Linux BSP (SFRD12) Programming Manual” (IM 34M06M52-22E).

Page 47: EtherNet/IP Interface Module

2-17

IM 34M06H36-01E

2.5 Mounting/Unmounting the Module

Mounting the Module

To mount the EtherNet/IP interface module (“this module”) on the base module, as described in Figure 2.5, engage the bottom side of this module in the base module, and then press this module against the base module so that the yellow button is latched.

CAUTION

You must turn off the power of the system before mounting the module.

Figure 2.5 Mounting This Module

CAUTION

Do not bend the connector pins on the rear of this module while you are mounting it. If this module is pushed with excessive force, the connector pins may bend, causing a failure.

Unmounting the Module

To unmount this module from the base module, reverse the above operation. Press the yellow button on the top of this module to release the lock and then pull this module toward you.

CAUTION

You must turn off the power of the system before unmounting the module.

Page 48: EtherNet/IP Interface Module

2-18

IM 34M06H36-01E

Mounting the Module in Intense Vibration Environments

This module is designed to be fastened with a screw so that it can be used in intense vibration environments. Use a screw described in the table below. Insert the screw into the screw hole on the top of this module and tighten the screw with a Phillips screwdriver.

Table 2.14 Screw

Required Screw

Binding head machine screw M4 that is 12 to 15 mm long (or 14 to 15 mm long with a washer)

Figure 2.6 Securing the Module with a Screw

F02R1.VSD

Page 49: EtherNet/IP Interface Module

3-1

IM 34M06H36-01E

3. Communication Settings To enable EtherNet/IP I/O communication on the EtherNet/IP interface module (“this module”), you need to complete the following settings:

Settings on sequence CPU modules

- Link register settings

Settings on this module

- Network settings

- EtherNet/IP communication settings

The settings you configured on this module are stored in the flash memory of this module. The information is retained when the power is turned off.

The settings can be configured by using the switches, the configuration tool, or user programs.

Note For details on the tool commands, refer to “Appendix 2. Tool Commands”.

Page 50: EtherNet/IP Interface Module

3-2

IM 34M06H36-01E

3.1 Procedure to Configure Settings This section describes an example of the procedure to procedure to configure settings.

Note For details on installing the configuration tool, refer to "Appendix 4.8 Installation of the Configuration Tool".

Overview of Basic Procedure

This procedure is the basic procedure to download the Ethernet/IP setting data created by the configuration tool to this module.

DownloadAdapter

Adapter

EDS Files

Registration

configuration tool

Ethernet/IP Setting Data

This module

Overview of Advanced Procedure

This procedure is to download the Ethernet/IP settings data to this module by the user program using the tool command. The Ethernet/IP setting data is created by the configuration tool and exported to the SD card of the CPU module.

Normally, you do not need to use this procedure.

Adapter

Adapter

Export

1.Reading files by program2.Download by program Tool Command : EtherNet/IP Setting write

EtherNet/IPSettting (bin) File

SD CardConfiguraiton Tool

EtherNet/IPSettting Data

EDS Files

Registration

This Module

Mount

Note For details on the EtherNet/IP setting data, refer to “Appendix 3. EtherNet/IP Setting Data”.

Page 51: EtherNet/IP Interface Module

3-3

IM 34M06H36-01E

Basic Procedure ( REV:00:** )

The basic procedure flow is shown below.

Start

Set the operating condition setup switches and the IP address setup switches

Create setting datain the configuration tool

Download setting datain the configuration tool

Communicationstart

Install this module and turn on the power.

Download a project that includes link register settingsto a CPU module.

Use Configuration tool (R1.01)

Register the EDS file of the adapter to the Configuration tool

Refer to Section 3.3

Refer to Section 3.5, Chapter 7

Refer to Section 3.6

Refer to Section 3.2

Frist time only

Refer to Section 3.5, Chapter 7

Refer to Chapter 4

Page 52: EtherNet/IP Interface Module

3-4

IM 34M06H36-01E

Basic Procedure ( REV:01:** or later )

Following is a flowchart of the basic procedure ( REV:01:** or later ).

The configuration tool revision used differs depending on the operation mode.

Start

Set the operating condition setup switches and the IP address setup switches

Create setting datain the configuration tool

Download setting datain the configuration tool

Communicationstart

Install this module and turn on the power.

Download a project that includes link register settingsto a CPU module.

Use Configuration tool (R2.01 or later)Set Config Area Size 500 bytes

Register the EDS file of the adapter to the Configuration tool

Focus on connectivity

Use Configuration tool (R1.01)(Set Config Area Size 64 bytes)

Refer to Section 3.3

Refer to Section 3.5, Chapter 7

Refer to Section 3.6

Refer to Section 3.2

First time onlyRefer to Section 7.2

Refer to Section 3.5, Chapter 7

Refer to Chapter 4

YES(Recommended)

NO

Refer to Section 3.4

Page 53: EtherNet/IP Interface Module

3-5

IM 34M06H36-01E

Advanced Procedure

Replace the "Download configuration information with the configuration tool" part of the basic procedure with the following.

Download setting datain the user programs

Use the configuration tool to export the setting data (EtherNet/IP Data (binary))

END

Read the setting data on the SD card to the CPU module by the user program

Download the setting Data to the CPU module by using the tool command (EtherNet/IP setting

registration) in the user program

Refer to Section 7.15

Refer to Section 2

Note For details on the EtherNet/IP setting data, refer to “Appendix 3. EtherNet/IP Setting Data”.

Page 54: EtherNet/IP Interface Module

3-6

IM 34M06H36-01E

3.2 CPU Settings For I/O communication, link registers (W registers) are used to exchange data between this module and a CPU module.

To use a sequence CPU module, the following ladder program configurations must be completed:

- Link type

- Link system number

- Link device assignment

- Link refreshing mode

- Link refreshing range

- Latch range setup at power failure

Note For details on how to configure the settings,

refer to “FA-M3 Programming Tool WideField3 Offline” (IM 34M06Q16-02E).

Note To use e-RT3 CPU modules, refer to “e-RT3 CPU Module (SFRD2) BSP Common Function Manual” (IM 34M06M52-02E).

Page 55: EtherNet/IP Interface Module

3-7

IM 34M06H36-01E

Link Type

For this module, set [Link Type] to “FL-net”.

Refer to Figure 3.2.

Figure 3.2 FA Link Setup

Link System Number

When more than one FA Link Module, FL-net Interface Module, or this module is installed, each of them is automatically assigned with a link system number in ascending order of the slot number.

To assign link system numbers regardless of where the modules are installed, in [FA Link Setup], set [FA Link/FL-net System Setup] to [Manual setup], and then set a slot number for each link system. For multi-CPU configurations, [Manual setup] must be selected.

Refer to Figure 3.2.

Link Device Assignment

For this module, set the link register to “8192” and the link relay to “0” for the link system of FA link.

Refer to Figure 3.2.

Page 56: EtherNet/IP Interface Module

3-8

IM 34M06H36-01E

Link Refreshing Mode

You can select peripheral process refreshing or control process refreshing.

Select peripheral process refreshing if the scan time of the ladder program is important, or select control process refreshing if the transfer rate of common area data is important.

Peripheral process refreshing reduces influence on the scan time.

Control process refreshing may prolong the scan time but the link refreshing process is not affected by the command processing time.

For this module, you are recommended to select [Control Process].

Refer to Figure 3.3.

Figure 3.3 FL-net Refresh

Link Refreshing Range

For this module, you are recommended to select [All Nodes]. The option allows this module to optimize link refreshing automatically.

In the terminology of this setting, a “node” represents a unit of FA-M3 link refreshing. This is different from a “node” in the EtherNet/IP terminology.

Refer to Figure 3.3.

Page 57: EtherNet/IP Interface Module

3-9

IM 34M06H36-01E

Latch Range Setup at Power Failure

To retain link device data in the event of a power failure, configure the following settings.

Figure 3.4 Latch Range Setup at Power Failure

Note For details on data retention in the event of a power failure,

refer to “Sequence CPU Instruction Manual - Functions (for F3SP22-0S, F3SP28-3N/3S, F3SP38-6N/6S, F3SP53-4H/4S, F3SP58-6H/6S, F3SP59-7S)” (IM 34M06P13-01E) or “Sequence CPU Instruction Manual - Functions (for F3SP71-4N/4S, F3SP76-7N/7S)” (IM 34M06P15-01E).

Page 58: EtherNet/IP Interface Module

3-10

IM 34M06H36-01E

3.3 Network Settings To use network functions on this module, you can configure the following network settings:

- IP address

- Subnet mask

- Default gateway

- IP Time to Live

Depending on the setting of the operating condition setup switch 8, Switch settings or Software settings can be performed.

The switch setting can be configured with the IP address setting switch. The software setting can be configured from the configuration tool or user program. The software settings you configured are stored in the flash memory, and they take effect when this module starts or the EtherNet/IP Start Request relay is turned from off to on.

Software Setting(configuration tool)

Software Setting(user program)

Toolcommand

SelectConnection

Download by configuration tool

Set by user program (tool command)

Valid network settings

Take valid when this module start-up or the EtherNet/IP Start Request relay is turned from off to on.

IP address setup switches

operating condition setup switch 8OFF:hardware Setting ON:software Setting

Hardware Setting

operating condition setup

Valid according to Table 3.1

Set at power off

Set at power off

This moduleLAN port

CPU moduleUSB/LAN port

FlashMemory

Set in the network parameter setting screen

Note The configuration tool can be connected via the CPU module, so software settings can also be performed via the CPU module. For details on the select connection of the configuration tool, refer to "7.10 Downloading Settings".

Page 59: EtherNet/IP Interface Module

3-11

IM 34M06H36-01E

Network Settings

The factory default settings for network settings are shown in the table below.

Item Description Factory Default Value

Operating Condition Setup Switch 8

Select valid network settings OFF: Switch ON: Software (Flash Memory)

OFF

IP address setup switches IP address 0.0.0.0 Subnet mask Subnet mask 0.0.0.0 Default gateway IP address The IP address of a gateway 0.0.0.0 IP Time to Live IP TTL value 0 (64)

*1: Normally, the IP address should not be set to “0.0.0.0”, “255.255.255.255”, nor “127.0.0.1”. *2: For switch settings, the subnet mask is set according to the IP address class (see the next page).

Note Valid network settings can be checked in the registers of this module. For details, refer to " Input/Output Relays and Registers (data position numbers 4 to 10)”.

IP address

For the relationship between “Operating Condition Setup Switch 8” and valid IP address value, refer to Table 3.1.

The settings you configured are stored in the flash memory, and they take valid when this module start-up or the EtherNet/IP Start Request relay is turned from off to on.

Table 3.1 IP Address and Behavior of This Module

Operating Condition

Setup Switch 8

IP Address Value Stored in

the Flash Memory*3

IP Address Value Set by the IP Address Setup Switches

0.0.0.0 Neither 0.0.0.0 nor

255.255.255.255 255.255.255.255

OFF - Error*5 IP address value set by the IP address setup switches

Initialization mode*1

ON

0.0.0.0

Incorrect configuration error or Incorrect switch error*2 *4

IP address value set by the IP address setup switches*2

Neither 0.0.0.0 nor

255.255.255.255

IP address value stored in the flash memory*2

255.255.255.255 Setting error*2 *1: Starting this module in initialization mode clears the setting values stored in the flash memory and resets this module to the

factory default state. *2: You can change the current IP address by software setting. Store a new IP address value in the flash memory and then turn on

the EtherNet/IP Start Request relay, which enables the new IP address value to take effect. *3: By factory default, the flash memory stores an IP address value of “0.0.0.0”. *4: To enable EtherNet/IP communication successfully, you must turn off and on the power after you configure the settings. *5: The red EIP LED lights up or an incorrect switch error occurs.

Page 60: EtherNet/IP Interface Module

3-12

IM 34M06H36-01E

Subnet mask

This is a mask value used to identify the subnet address of an IP address.

Set an appropriate value for your system or network to which this module belongs. This setting is sometimes not required.

Specifying the subnet mask value of “0.0.0.0” causes the subnet mask to vary depending on the valid IP address as follows: “255.0.0.0” for Class A, “255.255.0.0” for Class B, or “255.255.255.0” for Class C.

Default gateway IP address

This is set to the IP address of a gateway (or a router) that is used to communicate with other networks.

Set an appropriate value for your system or network to which this module belongs. This setting is sometimes not required.

IP time to Live

This is a value indicating when a packet expires. This value decrements by one whenever the packet passes through a router or something like that. When this value eventually reaches zero, the packet is discarded. That is, this value limits the area that packets can reach. Increase the value if packets transmitted farther away fail to be received. Specifying the TTL value of “0” causes the TTL to be set to “64”.

Note Valid network settings can be checked in the registers of this module. For details, refer to " Input/Output Relays and Registers (data position numbers 4 to 10)”.

Page 61: EtherNet/IP Interface Module

3-13

IM 34M06H36-01E

Setting Procedure

This section describes the setting procedure for network configuration.

When the flash memory setting is "0.0.0.0", which is the factory default setting, "Software setting 2" can be performed.

Item Connection Path for Configuration Tool

Flash Memory Settings IP Address Setup Switch

Switch Settings - - - Software Settings 1 CPU module - - Software Settings 2 This module “0.0.0.0”(factory default) “0.0.0.0”(factory default)

Software Settings 3 This module Any value other than “0.0.0.0”*1

Any value other than “0.0.0.0”

*1: For details on how to restore the settings stored in the flash memory to the factory defaults, see "Appendix 4.5 Resetting the

Settings Stored in the Flash Memory to the Factory Default State".

Switch Settings

The desired IPaddress source will be

used when the power isturned on next time.

Turn off operating condition setting switch 8

Set the IP addresssetup switches to adesired IP address.

Mount this module.

Software Settings 2

Turn on operating condition setting switch 8

Set the IP addresssetup switches to a

tentative IP address.

The desired IPaddress source will be

used when the power isturned on next time.

Connect the configuration tool to the LAN port of

this module, and set the desired IP address by

the flash setting.

Turn on the power.

Mount this module.

Turn off the power.

Download the settings.

Software Settings 1

Turn on operating condition setting switch 8

The desired IPaddress source will be

used when the power isturned on next time.

Connect the configuration tool to the LAN/USB port of the CPU module, and

set the desired IP address by flash settings.

Turn on the power.

Mount this module.

Turn off the power.

Download the settings.

Software Settings 3

Turn off operating condition setting switch 8

Set the IP addresssetup switches to a

tentative IP address.

The desired IPaddress source will be

used when the power isturned on next time.

Connect the configuration tool to the LAN port of

this module, and set the desired IP address by

the flash setting.

Turn on the power.

Mount this module.

Turn off the power.

Download the settings.

Unmount this module.

Turn on operating condition setting switch 8

Turn on the power.

Mount this module.

Note For the relationship between “Operating Condition Setup Switch 8” and valid IP address value, refer to Table 3.1. For details on network settings in the configuration tool, refer to "7.4 Configuring F3LN01 Network Settings ".

Page 62: EtherNet/IP Interface Module

3-14

IM 34M06H36-01E

3.4 Config Area Size Settings This section describes the config area size settings.

This function is supported by REV:01:** or later of this module. Please note the compatibility with the configuration tool.

Support for configuration tools

This Module REVConfig Area

Size*1 Configuration Tool

REVCombination Availability

Measures

00:** 64 bytes (factory default)

R1.01 R2.01 or later - Use R1.01

01:** or later

64 bytes (factory default)

R1.01 R2.01 or later - *1 Use R1.01

500 bytes R1.01 - Use R2.01 R2.01 or later

: Available -: Do not use. Cannot connect, or does not operate normally even if it can be connected. *1: When connecting to R2.01 or later, it is possible to change the configuration area size to 500 bytes.

What you can do by changing settings

- 64 bytes

IO communication can be used to communicate with adapter devices with a config area size of 0 to 64 bytes.

- 500 byte (REV:01:** or later)

IO communication can be used to communicate with adapter devices with a config area size of 0 to 500 bytes. REV:01:** or later, it is recommended to use the 500 bytes setting for better connectivity.

This Module REV Config Area Size*1

00:** 64 bytes (factory default)

01:** or later 64 bytes (factory default) 500 bytes

Compatibility of user programs

User programs are compatible except for programs that use the following tool commands.

Tool Command Config Area Size EtherNet/IP Setting Data

Operation mode setting write*1 Operation mode setting read*1

64 bytes (factory default) For 64 bytes 500 bytes For 500 bytes

*1: These are the commands used to download/upload the EtherNet/IP setting data by the user program.

Note For details on how to check configuration area size of the adapter, refer to "Appendix 1 EDS File. For details on the EtherNet/IP configuration data, refer to “Appendix 3 EtherNet/IP Configuration Data”.

Page 63: EtherNet/IP Interface Module

3-15

IM 34M06H36-01E

Settings method

This setting can be made using the configuration tool (R2.01 or later) or tool commands.

- Configuration Tool (R2.01 or later)

This setting can be changed when this module is connected to the configuration tool.

- Tool command (REV:01:** or later)

This setting can be changed when this module is connected to the configuration tool.

Settings procedure by using the configuration tool (R2.01 or later)

Explain the procedure to set the config area size to 500 bytes.

- On the menu bar, select [Online], and then [Connect].

Checking of change

when the config area size of this module is 64 bytes, this screen is displayed. Click the "Yes" button. Final checking of change settings screen is show up. *Clicking the "No" button closes the pop-up window and aborts the connection and setting changes.

Final checking of change

Click the "Yes" button. The config area size changes from 64 bytes to 500 bytes, and the connection is established. *Clicking the "No" button closes the pop-up window and aborts the connection and setting changes.

Note In the configuration tool (R2.01 or later), you can reset the config area size to 64 bytes from the menu [Online] - [Connection] - [Mode change].

Page 64: EtherNet/IP Interface Module

3-16

IM 34M06H36-01E

Checking method

This can be checked from the registers of this module or from the tool commands.

- Register

Data Position

Item Description R/W

16 config area size 0:64 bytes(REV:00:**) 64:64 bytes(REV:01:** or later) 500:500 bytes(REV:01:** or later)

R

- Tool command

This can be checked by using the operation mode setting read command (refer to Appendix 2).

Page 65: EtherNet/IP Interface Module

3-17

IM 34M06H36-01E

3.5 EtherNet/IP Communication Settings EtherNet/IP communication settings are required to enable I/O communication with EtherNet/IP.

Note - The setting can be configured using the configuration tool or tool command.

- The settings you configured are stored in the flash memory, and they take valid when this module starts or the EtherNet/IP Start Request relay is turned from off to on.

I/O Mapping

The following figure illustrates how I/O communication data flows between this module and other devices.

Figure 3.5 I/O Communication Data Flow

To exchange I/O communication data between this module and a CPU module, link registers (W registers) are used. You can group the link registers into an input data area and an output data area with any sizes. The input data area stores data to be read from devices on the network and the output data area stores data to be written into devices on the network.

To exchange data between this module and other EtherNet/IP devices, a tag is used for each unit of data. You can assign tags to the registers in the input/output data areas to map the registers to target devices.

CPU module

W registers

Output dataarea

This moduleAdapter

Adapter

Scanner

Input data area

Scanner

Tag 1

Output

Tag 2

Tag 3

Tag a

Tag b

Tag c

Input

Input

Output

Output

Input area

Output area

Input

Tag 4

Output

Page 66: EtherNet/IP Interface Module

3-18

IM 34M06H36-01E

Connection

For I/O communication, a “connection” represents a logical line to exchange data with a tag. To exchange data between two nodes, a node requests of the other node to establish a connection. A node that requests a connection is called an “originator (O)” and a node that receives the requests is called a “target (T)”.

Scanner

An EtherNet/IP device that works as an originator is called a scanner device.

To enable this module to work as a scanner, you need to configure the following settings for each adapter:

- Connection settings (scan list)

- Assignment of tags to link registers

After setting, the system must be confirmed to satisfy the following specifications.

- Allowable communication bandwidth / link register capacity

The following sections provide a general explanation on the settings to be configured.

For details, refer to “Appendix 3. EtherNet/IP Setting Data”.

Page 67: EtherNet/IP Interface Module

3-19

IM 34M06H36-01E

Connection settings

Complete a scan list that includes connection settings for each adapter.

The scan list includes up to 128 adapters.

An adapter can have a connection for an input tag (TO) and another connection for an output tag (OT). When an adapter needs to have two or more input tags or output tags, you can create multiple instances of the same adapter in the scan list.

For the communication type, you can select the logical segment type or symbolic segment type for each adapter. Table 3.3 describes the connection settings.

Table 3.3 Connection Settings

Item Description Notes

Scan number The ID number in the scan list Assign a number starting from zero without skipping any numbers.

IP address The IP address of the destination adapter

Adapter information

Vendor identifier Device type Product identifier Major revision Minor revision

These are used to establish a connection.

Communication type Logical segment type or Symbolic segment type

Trigger Cyclic or Change of State

Timeout Set to a multiple of RPI. RPI*1 Packet interval Connection type*1 Point-to-Point or Multicast

Real time format*1 Select one from Modeless, Zero Length, Heartbeat, and 32-bit.

Zero Length is not supported.

Priority*1 Select one from Low, High, Scheduled, and Urgent.

Only Scheduled is supported.

Instance for logical segment communication*1*2

The instance number to be used for the logical segment type

Tag name*1*3 The tag name to be used for the symbolic segment type

Tag size*1 The size of the tag Up to 1444 bytes *1: Specify a specific value for each of the input tag (OT) and output tag (TO). *2: This is required only for logical segment communication. *3: This is required only for symbolic segment communication.

Note - The number of connections represents the total number of input tags to receive data and

output tags to transmit data. That is, two connections are required to exchange data with one device when both the input tag and output tag are used.

- When the connection type is set to Multicast, a packet can be transmitted to multiple nodes by using an output tag. All nodes to receive multicast packets must have the same settings for the connection type (set to Multicast), RPI, and timeout.

Assignment of tags to link registers

Assign tags to be used for communication to link registers (W registers).

For each module, you can assign up to 256 tags including ones that are used when the module works as an adapter.

Page 68: EtherNet/IP Interface Module

3-20

IM 34M06H36-01E

Allowable communication bandwidth / link register capacity

The link register capacity and the system communication bandwidth usage are determined by the following parameters in the connection settings.

- Total Size of All Tags / Average tag size / RPI of each tag

The system should be built to meet the following

- Total Size of All Tags (word) <= Link register capacity (8192 word)

- system communication bandwidth (pps) <= allowable communication bandwidth (pps)

The system communication bandwidth is the sum of the communication bandwidth of each tag.

- system communication bandwidth (pps) = sum of the communication bandwidth of each tag (pps)

The communication bandwidth of each tag is inversely proportional to the RPI.

- Communication bandwidth of each tag (pps): 1000 / RPI of each tag (ms)

The allowable communication bandwidth is determined by the average tag sizes.

Average tag size Allowable

Communication BandwidthNotes

0 to 504 bytes 6000 pps 505 to 1444 bytes 3000 pps Maximum tag size: 1444 bytes

System Communication

Bandwidth

Average Tag Size(byte)

Total Size of All Tags(word)

Note Settings that are higher than the allowable communication bandwidth cannot be downloaded. We recommend that you obtain the EDS file of the adapter device before purchasing the adapter device, and create a scan list with the configuration tool to check the system communication bandwidth and the total tag size.

Page 69: EtherNet/IP Interface Module

3-21

IM 34M06H36-01E

Describe some examples of limitations in system construction.

- Example of limitation due to link register capacity

In the following example, the limit is caused by the link register capacity (8192 words). It is necessary to adjust the size of a tag by reducing the number of tags or the size of a tag.

Connected Device

Input/ Output

size of tag RPI Communication

BandwidthNotes

Adapter 1 T ⇒ O 1444 bytes 50 ms 20 pps Adapter 2 O ⇒ T 1444 bytes 50 ms 20 pps Adapter 3 T ⇒ O 1444 bytes 50 ms 20 pps Adapter 4 O ⇒ T 1444 bytes 50 ms 20 pps … … … … Adapter 12 O ⇒ T 1444 bytes 50 ms 20 pps

Total Size of All Tags 8664 words 17328 bytes = 8664 words

Average tag size 1444 bytes System communication bandwidth

240 pps

allowable communication bandwidth

3000 pps

- Example of limitation due to allowable communication bandwidth

In the following example, the system communication bandwidth is limited by the allowable communication bandwidth. It is necessary to adjust the systems communication bandwidth to 6000pps or less by setting RPI to a larger value.

Connected Device Input/ Output

Size of Tag RPI Communication

BandwidthNotes

Adapter 1 T ⇒ O 100 bytes 1 ms 1000 pps O ⇒ T 100 bytes 1 ms 1000 pps

Adapter 2 O ⇒ T 100 bytes 1 ms 1000 pps

Adapter 3 T ⇒ O 100 bytes 1 ms 1000 pps O ⇒ T 100 bytes 1 ms 1000 pps

Adapter 4 T ⇒ O 100 bytes 1 ms 1000 pps Adapter 5 T ⇒ O 100 bytes 1 ms 1000 pps Total Size of All Tags 700 bytes 700 bytes = 350 words Average tag size 100 bytes System communication bandwidth

7000 pps

allowable communication bandwidth

6000 pps

Page 70: EtherNet/IP Interface Module

3-22

IM 34M06H36-01E

Adapter

An EtherNet/IP device that works as a target is called an adapter device. On an adapter device, you need to configure the following settings:

- Tag settings

- Assignment of tags to link registers

You can use the same link register area that is for scanner communication.

The following sections provide a general explanation on the settings to be configured.

For details, refer to “Appendix 3. EtherNet/IP Setting Data”.

Tag settings

Create tags to be used for communication.

Table 3.4 describes the details of a tag.

Table 3.4 Details of an Adapter Tag

Item Description Notes

Tag name The name of the tag used for I/O communication

Up to 32 half-width alphanumeric characters are acceptable. You cannot use the same name for multiple adapter tags. The tag name is used for symbolic segment communication.

Size Data size (in bytes) Acceptable range: 0 to 1444

Logical instance number

The logical instance number of the adapter tag

Acceptable range: 100 to 199 0: The tag name is used for establishing a connection. Non-0: The logical instance number is used for establishing a connection. You cannot use the same number for multiple adapter tags.

Assignment of tags to link registers

Assign tags to be used for communication to link registers (W registers).

For each module, you can assign up to 256 tags including ones that are used when the module works as a scanner.

Page 71: EtherNet/IP Interface Module

3-23

IM 34M06H36-01E

3.6 Wiring and Connecting

Connecting Communication Cable

Connecting 10BASE-T/100BASE-TX cable

For 10BASE-T/100BASE-TX cable, use a twisted-pair cable (UTP or STP). The twisted-pair cable (UTP or STP) must be a straight cable of Category 5 or more.

Shielding

When using a shielded twisted-pair cable (STP), ground the shield of the cable as required. The shield of the cable is connected to the shell of the 10BASE-T/100BASE-TX connector, and the shell is connected to the FG of the module when the connector is inserted.

LAN controller Transformer

Receive signal

Transmit signal

RJ45

1MΩ 1MΩ

Figure 3.7 Shielding

Page 72: EtherNet/IP Interface Module

3-24

IM 34M06H36-01E

Peel off insulation and apply an FG clamp to the exposed shield.Shielded

cable

Screw the FG clamp to the metal plate of the panel enclosure for grounding.

CE Marking Conformance

To ensure compliance to CE Marking for a system incorporating this module, use a shielded cable for connecting to this module. Peel off part of the insulation of a shielded cable to expose the shield, and apply an FG clamp to the shield to secure and ground it.

Figure 3.8 Shielding (for CE Marking Conformance)

Page 73: EtherNet/IP Interface Module

4-1

IM 34M06H36-01E

4. EtherNet/IP Communication With EtherNet/IP, you can implement the following types of communication:

- I/O communication

- Message communication

Client

Server

This chapter describes the usage for each type.

Page 74: EtherNet/IP Interface Module

4-2

IM 34M06H36-01E

4.1 I/O Communication This section describes EtherNet/IP I/O communication using the EtherNet/IP interface module (“this module”). Before you can enable I/O communication, the communication settings must be completed. For details on communication settings, refer to “3. Communication Settings”.

Relays to Be Used

Relay Number

Name Description

Y0□□33 EtherNet/IP Start Request

Before you turn on this relay, ensure that the Module Status relay (X0 03) is on. When you turn ON from OFF, the registered network settings and EtherNet/IP setting data become valid, and the EtherNet/IP execution request is executed. Turn OFF when setting network settings or EtherNet/IP settings.

X0□□01 EtherNet/IP Availability

Turns ON when the EtherNet/IP execution request operates normally. ON: The EtherNet/IP communication function is being executed. IO communication and message communication can be used. OFF:The EtherNet/IP communication function is stopped.

X0□□02 EtherNet/IP Communication Error

Turns ON when an error occurs in the EtherNet/IP Start Request. ON: EtherNet/IP communication error.

In this state, the EIP LED blinks in red. Check the error code (refer to chapter 6.2).

OFF: EtherNet/IP communication is normal, or the EtherNet/IP

communication function is stopped.

X0□□03 Module Status

Indicates whether the EtherNet/IP execution request can be performed. ON: Normal. At this time, EtherNet/IP Start Request can be made. OFF: Error. Or, the flash memory is being written.

At this time, the EtherNet/IP Start Request cannot be executed.

: Slot number

Page 75: EtherNet/IP Interface Module

4-3

IM 34M06H36-01E

Starting I/O Communication

To enable I/O communication, turn on the EtherNet/IP Start Request relay (Y033).

Before you turn on the EtherNet/IP Start Request relay, ensure that the Module Status relay is on, indicating that this module is in a normal state.

After EtherNet/IP communication is enabled, check whether all adapters on the scan list are connected. To check this, use the special relays (starting from M3521) for their communication status. Figure 4.1 illustrates an example procedure to start I/O communication.

Example procedure to start I/O

communication

Turn on EIP Start Request (Y033).

Read the registration status of the communication (starting

from M3521).

Go to a user-developed application.

Module Status (X003)

OFF

ON

Read the connection status of the communication (starting

from M3777).

The registration status and the connection status

are consistent.

YES

NO

Timeout?NO

YES

Error processing

Set the timer.

Set the timer.

Timeout?NO

YES

Error processing

Figure 4.1 Example Procedure to Start I/O Communication

Page 76: EtherNet/IP Interface Module

4-4

IM 34M06H36-01E

Accessing I/O Communication Data

I/O communication data can be accessed through link registers (W registers) in the CPU module.

While EtherNet/IP communication transfers data in units of bytes, link registers store data in units of words with little-endian format.

Figure 4.2 illustrates an example of using link registers and how the registers store transferred data.

Figure 4.2 Example of Using Link Registers and How the Registers Store Transferred Data

CPU module

Link registers

Output data area(W4097 to W8192)

Input data area(W0001 to W4096)

Output

Input

Input

Output

Input

Output

W0001 to W0010 Tag 1

Tag 2

Tag 3

W0011 toW0110

W0111 toW0130

Tag A

Tag B

Tag B

W5001 to W5010

W5011 toW5110

W5111 toW5130

$2301W5111

W5112 $6745

W5113 $AB89

$01+00

$23+01

$45+02

$67+03

$89+04

$AB+05

Tag B data

Transferred data

Tags on scanners and adapters

Input

Page 77: EtherNet/IP Interface Module

4-5

IM 34M06H36-01E

Sample Program

Figure 4.3 shows a sample ladder program.

This program implements the example procedure to start I/O communication described in Figure 4.1.

Figure 4.3 Sample Program to Start I/O Communication

Page 78: EtherNet/IP Interface Module

4-6

IM 34M06H36-01E

4.2 Message Communication Client An EtherNet/IP message client can start command-response interactions between the client and a server over CIP. The message communication client of this module supports CIP explicit messaging with UCMM (unconnected message manager).

You can use the message communication client to retrieve the status of an EtherNet/IP device or execute services on the device.

Request Format and Response Format

The following sections describe registers and relays used for message communication.

Communication parameters

The following registers store message communication parameters.

Table 4.1 Message Communication Parameters

Data Position

Item Description

577 Transmitted message data size

Specify the size (in bytes) of service data to be included.Set “0” when you do not transmit service data.

578 to 579 Destination IP address Destination IP address Data Position

580 Service code 581 Class ID 582 Instance ID 583 Attribute ID*1

584 Timeout value Specify a value in milliseconds. Setting “0” causes this parameter to be set to 10 seconds.

*1: Specify “-1” when no attribute ID is required. For example, when you set the service code to “1” (Get Attribute All), no attribute

ID is required. Thus, you set data position 583 to “-1”. Configure parameters according to the functionality (specifications) of the message server on the destination device.

Service data to be transmitted

To transmit service data, set data position 577 to the size of the message data to be transmitted, and store service data to be transmitted in the registers described in the following table.

Table 4.2 Service Data to Be Transmitted

Data Position

Item Description

1025 to 1276 Service data to be transmitted

Store service data to be transmitted. The maximum data size is 504 bytes. *1 The data is stored in little-endian format. Note this when you want to store multi-byte data.

*1 The maximum stored data size varies depending on the service or other factors. For example, Set Attribute Single reserves

eight bytes for the service and request path and thus the maximum stored data size is 496 bytes. Get Attribute Single reserves four bytes for the service and request path and thus the maximum stored data size is 500 bytes.

Page 79: EtherNet/IP Interface Module

4-7

IM 34M06H36-01E

Relays to Be Used

To request a message transmission, turn on the Message Transmission Request relay (Y037). When the message is transmitted and the response is received, the Message Transmission Completion relay (X005) turns on.

Check the reception status, retrieve the returned service data, and then turn off the Message Transmission Request relay. When you turn off the Message Transmission Request relay, the Message Transmission Completion relay turns off.

Table 4.3 Relays for Message Transmission Request and Completion

Relay Number

Name Description

Y0□□33 EtherNet/IP Start Request

Before you turn on this relay, ensure that the Module Status relay (X0 03) is on. When you turn ON from OFF, the registered network settings and EtherNet/IP setting data become valid, and the EtherNet/IP execution request is executed. Turn OFF when setting network settings or EtherNet/IP settings.

X0□□01 EtherNet/IP Availability

Turns ON when the EtherNet/IP execution request operates normally. ON: The EtherNet/IP communication function is being executed. IO communication and message communication can be used. OFF:The EtherNet/IP communication function is stopped.

Y037 Message Transmission Request relay

When this relay is turned from off to on, an explicit message is transmitted over EtherNet/IP. When the transmission is completed, the Message Transmission Completion relay (X005) turns on. Before you turn off this relay, ensure that the Message Transmission Completion relay (X005) is on.

X005 Message Transmission Completion relay

When an explicit message transmission over EtherNet/IP is completed, this relay turns on. When you turn off the Message Transmission Request relay (Y037), this relay turns off. Then, you can request the next message.

X006 Message Transmission In-progress relay

When this relay is on, it indicates that an explicit message is being transmitted over EtherNet/IP.

: Slot number

Note - The Message Transmission Request relay (Y037) is ignored while the Message

Transmission In-progress relay (X006) is on.

- A message transmission request fails with an error while the EtherNet/IP Availability relay (X001) or the Module Status relay (X003) is off.

Response

After the message transmission is completed, you can retrieve the response message.

Table 4.4 Response Message

Data Position

Item Description

513 Received service data size This is set to the size (in bytes) of received and stored service data. Zero indicates that there is no service data.

520 Completion code 0: Succeeded Non-0: Failed

521 Error code

Page 80: EtherNet/IP Interface Module

4-8

IM 34M06H36-01E

You can determine the result of the message transmission by referencing the completion code and error code.

Table 4.5 Completion Codes and Error Codes

Completion Code

Error Code Description

$0000 $0000 Succeeded

$EC00 $0000 to $FFFF A CIP error was detected. The error code is set to a CIP error code.

$F000

$0001 Timeout, or EtherNet/IP is disabled. $0003

$0004 The data size is not valid. (The message transmission was not executed.)

Received service data

Table 4.6 Received Service Data

Data Position

Item Description

769 to 1020 Received service data

Stores received service data. The maximum data size is 504 bytes. The data is read in little-endian format. Note this when you want to read multi-byte data.

Page 81: EtherNet/IP Interface Module

4-9

IM 34M06H36-01E

Procedure to Transmit a Message

Figure 4.4 illustrates how to transmit a message.

CPU module(Steps performed by a user-

developed program)

F3LN01-0N(Steps performed by

this module)

Check the following conditions:EIP Availability (X001): ON

Message Transmission Completion (X005): OFF

Message Transmission In-progress (X006): OFF

Turn on Message Transmission Request (Y0□□37).

Turn on Message Transmission In-progress (X006).

Message server device(Steps performed by the

server device)

Transmit the message.

Process the message.

Transmit the response message.

Receive the response message.

Turn off Message Transmission In-progress (X006).

Turn on Message Transmission Completion (X005).

Turn off Message Transmission Request (Y037).

Turn off Message Transmission Completion (X005).

Set message parameters and data in the registers.

Read the response message from the registers.

Figure 4.4 Procedure to Transmit a Message

Page 82: EtherNet/IP Interface Module

4-10

IM 34M06H36-01E

Sample Program

This section describes a sample program to transmit messages.

The sample program transmits two messages. The first message is to retrieve the Identity information of the destination device.

The second message is to write data into the destination device.

To try the sample program, you need to change parameters according to the specifications of your destination device.

System configuration

Figure 4.5 System Configuration

Flow

Message transmission

sample

Configure initial settings.

Enable EIP.

Message transmission 1(to retrieve Identity)

Message transmission 2(to set parameters on

the device)

End

Figure 4.6 Flowchart

LN01

EtherNet/IP device

SP71

192.168.250.2

192.168.250.9

PU10

1 2

Page 83: EtherNet/IP Interface Module

4-11

IM 34M06H36-01E

Message transmission 1 (to retrieve Identity)

The following table describes how registers on this module are set to retrieve the Identity information.

Table 4.7 Registers to Be Set

Data Position

Item Value Notes

577 Transmitted service data size 0 No service data is transmitted.

578, 579 Destination IP address $C0A8FA09 192.168.250.9

580 Service code $0E Get Attribute Single

581 Class ID $01 Identity object

582 Instance ID $01 The ID of the instance to be retrieved

583 Attribute ID 7 Product Name

584 Timeout value 1000 1000 milliseconds

Message transmission 2 (to set parameters on the device)

Table 4.8 Registers to Be Set

Data Position

Item Value Notes

577 Transmitted service data size 12 The size of service data to be transmitted is 12 bytes.

578, 579 Destination IP address $C0A8FA09 192.168.250.9

580 Service code $32 Depends on the specifications of the device.

581 Class ID $64 Depends on the specifications of the device.

582 Instance ID $01 The ID of the instance into which data is written

583 Attribute ID $64 Depends on the specifications of the device.

584 Timeout value 1000 1000 milliseconds

Page 84: EtherNet/IP Interface Module

4-12

IM 34M06H36-01E

Table 4.9 Service Data

Data Position

Item Value Notes

1025 Transmitted service data 0, 1 $1100 Write service data as follows: 00: $00 01: $11 02: $22 03: $33 04: $44 05: $55 06: $66 07: $77 08: $88 09: $99 10: $AA 11: $BB

1026 Transmitted service data 2, 3 $3322

1027 Transmitted service data 4, 5 $5544

1028 Transmitted service data 6, 7 $7766

1029 Transmitted service data 8, 9 $9988

1030 Transmitted service data 10, 11 $BBAA

Page 85: EtherNet/IP Interface Module

4-13

IM 34M06H36-01E

Sample ladder program

Page 86: EtherNet/IP Interface Module

4-14

IM 34M06H36-01E

Page 87: EtherNet/IP Interface Module

4-15

IM 34M06H36-01E

Page 88: EtherNet/IP Interface Module

4-16

IM 34M06H36-01E

Figure 4.7 Sample Program

Page 89: EtherNet/IP Interface Module

4-17

IM 34M06H36-01E

4.3 Message Communication Server The message communication server enables other EtherNet/IP devices to start message communication to this module and access CIP objects on this module.

The following sections describe EtherNet/IP message CIP objects that users can access.

Identity object ($01)

Table 4.10 Class Attributes

ID Access Name Data

Type*1Description

Attribute Value

1 Get Revision UINT The revision of the object 1

2 Get Max Instance UINT The maximum instance number 1

*1: For details on data types, refer to Table 4.13.

Table 4.11 Instance Attributes

ID Access Name Data

Type*1Description Attribute Value

1 Get Vendor ID UINT Identifies the vendor. 250 (Yokogawa)

2 Get Device Type UINT Identifies the device type.12 (Communications Adapter)

3 Get Product Code UINT Identifies the product. 6 (F3LN01)

4 Get

Revision The revision of the item represented by the Identity object

Major Revision USINT Major revision 1

Minor Revision USINT Minor revision 1

5 Get Status WORD The status of the device -

6 Get Serial Number UDINT The serial number of the device

Starting from 1

7 Get Product Name SHORT_STRING

The user-readable identification name

“F3LN01”

*1: For details on data types, refer to Table 4.13.

Table 4.12 Service Codes

Code Service Class Instance Notes

$01 Get_Attribute_All Available Available

$05 Reset Not Available

Available

$0E Get_Attribute_Single Available Available

Page 90: EtherNet/IP Interface Module

4-18

IM 34M06H36-01E

Table 4.13 Data Types

Data Type Description Range

Minimum Maximum

WORD Bit string: 16 bits -

UINT 16-bit unsigned integer 0 65535

INT 16-bit signed integer -32768 32767

USINT Unsigned short integer 0 255

UDINT Unsigned double-precision integer

0 232-1

SHORT_STRING

Character string (A character occupies 1 byte.) First byte: The length of the character string

-

Other supported objects

The following table lists other objects supported by this module.

Table 4.14 Supported Objects

Class ID Object Notes

$F5 TCP/IP Interface

$F6 Ethernet Link

Page 91: EtherNet/IP Interface Module

5-1

IM 34M06H36-01E

5. Other Communication Functions In addition to EtherNet/IP communication, the EtherNet/IP interface module (“this module”) supports communication functions described in this chapter.

5.1 Higher-level Link Service This service enables other nodes to issue commands to monitor and configure FA-M3 sequence devices, start and stop programs, and load and save programs. You do not need to develop or run additional programs on FA-M3 modules to enable the higher-level link.

This service enables command-response interactions over TCP/IP and UDP/IP through a socket interface.

This module cannot send commands to other nodes.

The first sender is always a node other than this module. First, a node sends this module a command. Then, this module can be a sender to send a response.

A command is an instruction that is sent from a node to this module.

A response is a reply that is sent from this node to a node.

Ethernet

Response

Command

FA5101.VSD

Figure 5.1 Higher-level Link Service

For details on commands and responses used in the higher-level link service, refer to “Personal Computer Link Commands” (IM 34M06P41-01E).

Page 92: EtherNet/IP Interface Module

5-2

IM 34M06H36-01E

Specifications Table 5.1 Specifications of the Higher-level Link Service

Item Specification

Communication method

TCP/IP UDP/IP

Data format ASCII or binary Maximum number of connections

8

Port number Higher-level link service: 12289 ($3001) or 12291 ($3003) Write protection Configurable

Data formats and port numbers

For the data format, you can select one from ASCII and binary.

Use the operating condition setup switch to select ASCII or binary. The meaning of the switch depends on the port number. The following table describes the dependency.

Table 5.2 Data Formats and Port Numbers

Operating Condition Setup

Switch 1

Port Number

12289 ($3001)

12291 ($3003)

OFF ASCII Binary ON Binary ASCII

Write protection

You can configure this module to block certain commands from running.

To do so, use the operating condition setup switch on the side of this module.

The following table lists commands that can be blocked with this protection.

Table 5.3 Commands Blocked by the Write Protection

- Device accessing commands to write bits, words, or long words. - Device accessing commands to write bits, words, or long words of the same data. - Device accessing commands to write bits, words, or long words randomly. - Special module accessing commands to write words or long words. - Commands to load a program - Commands to write a date and time

Page 93: EtherNet/IP Interface Module

5-3

IM 34M06H36-01E

5.2 Remote Programming Service This service enables you to use FA-M3 Programming Tool WideField3 on a remote networked node (personal computer) to develop programs for sequence CPU modules.

Figure 5.2 Remote Programming Service

Specifications

Table 5.4 Specifications of the Remote Programming Service

Item Specification

Communication method TCP/IP, UDP/IP Maximum number of connections 2 Port number 12290 ($3002)

Note Up to two connections can be made. However, the node connected later will be prioritized. Be aware of this when performing online edit and other edits or downloads.

Note For details on connecting with WideField3, refer to “FA-M3 Programming Tool WideField3 Online” (IM 34M06Q16-03E).

Page 94: EtherNet/IP Interface Module

5-4

IM 34M06H36-01E

5.3 TCP Connection Closing This function enables a CPU module to forcibly close TCP connections established on this module. This is useful, for example, when you want to close TCP connections and disconnect nodes for restarting.

Connection Information

When a TCP connection is established, the information of the destination node is stored in an area described below.

When a connection is not established, the values in the area are set to $0000.

Table 5.5 Registers Used for TCP Connection Closing

Data Position

Service Description R/W

257

Remote programming service

Disconnection flag R/W 258 to 260 Reserved - 261 to 262

Connection information 1

Destination IP address R 263 Destination port number R 264 Source port number R 265 to 266

Connection information 2

Destination IP address R 267 Destination port number R 268 Source port number R 269 to 384 Reserved 385

Higher-level link service

Disconnection flag R/W 386 to 388 Reserved - 389 to 390

Connection information 1

Destination IP address R 391 Destination port number R 392 Source port number R 393 to 394

Connection information 2

Destination IP address R 395 Destination port number R 396 Source port number R 397 to 398

Connection information 3

Destination IP address R 399 Destination port number R 400 Source port number R 401 to 402

Connection information 4

Destination IP address R 403 Destination port number R 404 Source port number R 405 to 406

Connection information 5

Destination IP address R 407 Destination port number R 408 Source port number R 409 to 410

Connection information 6

Destination IP address R 411 Destination port number R 412 Source port number R 413 to 414

Connection information 7

Destination IP address R 415 Destination port number R 416 Source port number R 417 to 418

Connection information 8

Destination IP address R 419 Destination port number R 420 Source port number R 421 to 512 Reserved -

Page 95: EtherNet/IP Interface Module

5-5

IM 34M06H36-01E

Closing Connections

Use a CPU module to close established TCP connections forcibly.

Procedure to close connections

Figure 5.3 Procedure to Close Connections

Specifying connections to be closed

Write a non-zero bit into data positions that represent connections you want to close. You can specify multiple connections.

Table 5.6 Setting Area

Data Position Specification

257 Disconnection flag for the remote programming service 385 Disconnection flag for the higher-level link service

Connection represented by data positions 261 to 264 Connection represented by data positions 265 to 268

Figure 5.4 Bit Positions for Remote Programming Service Connections to Be Closed

15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

Page 96: EtherNet/IP Interface Module

5-6

IM 34M06H36-01E

Connection represented by data positions 389 to 392 Connection represented by data positions 393 to 396 Connection represented by data positions 397 to 400 Connection represented by data positions 401 to 404 Connection represented by data positions 405 to 408 Connection represented by data positions 409 to 412 Connection represented by data positions 413 to 416 Connection represented by data positions 417 to 420

Figure 5.5 Bit Positions for Higher-level Link Service Connections to Be Closed

Making a disconnection request

Turn on an output relay to make a disconnection request.

The reception of the request is notified with an input relay.

Table 5.7 Relays Used to Make a Disconnection Request and Check the Reception

Relay Number

Name Description

Y062 Disconnection Request

When turned ON from OFF, requests the disconnection of the remote programming service and the higher-level link service. Before you turn off this relay, ensure that the Disconnection Request Received relay (X0 30) is on.

X030 Disconnection Request Received

After you turn on the Disconnection Request relay (Y0 62), this relay turns on when the disconnection request is received. Due to the nature of the system, specified connections might not always close immediately after the request is received. When you specify a connection that is not yet established, the request is ignored. When you turn off the Disconnection Request relay (Y0 62), this relay turns off.

: Slot number

15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

Page 97: EtherNet/IP Interface Module

6-1

IM 34M06H36-01E

6. Errors and Troubleshooting This chapter provides flowcharts illustrating how to troubleshoot the EtherNet/IP interface module.

Firstly, check the following points:

- Is this module installed correctly?

- Are the operating condition setup switches set correctly?

- Is the IP address of this module set correctly?

- Are connectors or other parts on this module tightened securely?

- Is the communication cable connected correctly?

- Is the network configured correctly?

- Is the network equipment configured correctly?

- Does the network equipment work properly?

- Is the power to the network equipment turned on?

- Are you using the tool command and the configuration tool at the same time?

- Is the correspondence with the configuration tool correctly? (refer to section 3.4)

The configuration tool (R1.01) cannot be used for modules with a config area size of 500 bytes. Please use the configuration tool (R2.01 or later).

Note If you cannot register the EDS file in the configuration tool, please contact us.

Page 98: EtherNet/IP Interface Module

6-2

IM 34M06H36-01E

6.1 LED Indicators

The “RDY” LED Does Not Light Up

The “RDY” LED does not light up.

Is a specified voltage applied to the power

supply module?

Does the “RDY” LED on the power supply

module light up?

Do the “RDY” LEDson other modules light up?

Is this module installedin the slot correctly?

Install this moduleinanother slot. Does the“RDY” LED light up?

Replace this module.

Replace the base module.

Properly press down on this module until it clicks.

Check the limitation (current consumption). Replace the power supply module or the

base module.

Replace the power supply module.

Apply the specified voltage.

YES

NO

NO

YES

NO

YES

NO

YES

NO

YES

Figure 6.1 The “RDY” LED Does Not Light Up

Page 99: EtherNet/IP Interface Module

6-3

IM 34M06H36-01E

The “STS” LED Does Not Light Up

The “STS” LED does not light up.

Does the “RDY” LED light up?

Does the red “EIP” LED light up?

The error codes(register data positions

34 and 35) are 0.

Replace this module.

Investigate the error codes and perform appropriate actions.

Go to the flow “The Red ‘EIP’ LED Lights Up or

Flashes”.

Go to the flow “The 'RDY' LED Does Not Light Up”.

NO

YES

YES

NO

Yes

NO

Initialize and restartthis module. The “STS”

LED is still off.

NO

YES

Use this module with correct settings.

Initialize this module.*1

*1: To reset this module to the factory default state, set all IP address setup switches to “F” and then turn on the power (which

enables this module to start in initialization mode). Figure 6.2 The “STS” LED Does Not Light Up

Page 100: EtherNet/IP Interface Module

6-4

IM 34M06H36-01E

The Green “EIP” LED Does Not Light Up or Flash

The green “EIP” LED does not light up or

flash.

Does the “RDY” LED light up?

Is the red “EIP” LED off?

The error codes(register data positions

34 and 35) are 0.

Investigate the error codes and perform appropriate actions.

Go to the flow “The Red 'EIP' LED Lights Up or

Flashes”.

Go to the flow “The 'RDY' LED Does Not Light Up”.

NO

YES

YES

NO

YES

NO

Initialize this module.*1

Check the points described above and

contact us.

Initialize andreconfigure this module.

The same symptomstill persists.

NO

YES

Use this module with correct settings.

*1: To reset this module to the factory default state, set all IP address setup switches to “F” and then turn on the power (which

enables this module to start in initialization mode). Figure 6.3 The Green “EIP” LED Does Not Light Up or Flash

Page 101: EtherNet/IP Interface Module

6-5

IM 34M06H36-01E

The Red “EIP” LED Lights Up or Flashes

The red “EIP” LED lights up or flashes.

Does the “RDY” LED light up?

The error codes(register data positions

34 and 35) are 0.

Investigate the error codes and perform appropriate actions.

Set the IP address setup switches correctly.

Go to the flow “The 'RDY' LED Does Not Light Up”.

NO

YES

YES

NO

Yes

NO

The red “EIP” flashes.Yes Go to the flow “I/O

Communication Cannot Be Enabled”.

NO(It lights up.)

The IP addressSetup switches are set to

“0.0.0.0” or “255.255.255.255”.

Initialize this module.*1

Check the points described above and

contact us.

Initialize andreconfigure this module.

The same symptomstill persists.*1

NO

YES

Use this module with correct settings.

*1: To reset this module to the factory default state, set all IP address setup switches to “F” and then turn on the power (which

enables this module to start in initialization mode). Figure 6.4 The Red “EIP” LED Lights Up or Flashes

Page 102: EtherNet/IP Interface Module

6-6

IM 34M06H36-01E

6.2 Error Codes When this module detects an error, registers described in Table 6.1 are set to appropriate codes.

Error-Clearance Function

Stored error codes remain until the error is cleared.

To clear an error, turn on the Error-Clearance Request relay (Y0 41).

Relay Number

Name Description

Y041 Error-Clearance Request

When turned from OFF to ON, the error register is cleared. Before you turn off this relay, ensure that the Error-Clearance Completion relay (X0 09) is on.

X009 Error-Clearance Completion

After you turn on the Error-Clearance Request relay (Y0 41), this relay turns on when the error-clearance is completed. When you turn off the Error-Clearance Request relay (Y0 41), this relay turns off.

: Slot number

Error Registers

Table 6.1 Error Registers

Data Position

Item Description R/W

34 Error code 1 Error summary R 35 Error code 2 Error details R 36 Warning code 1 Warning summary R 37 Warning code 2 Warning details R 38 CIP error code 1 General status code returned from the EtherNet/IP function R 39 CIP error code 2 Additional code returned from the EtherNet/IP function R

Page 103: EtherNet/IP Interface Module

6-7

IM 34M06H36-01E

Error Codes

When an error occurs and EtherNet/IP communication fails, register data positions 34 and 35 are set to appropriate error codes.

Table 6.2 Error Codes

Error Code 1

Error Code 2

Name Description

$A001 - Boot error A hardware failure is detected during startup. Check the status and contact us.

$A011 - Incorrect switch setting

Switch setting error is detected. Check IP address setup switches or the operating condition setup switches setting (refer to table 3.1).

$A030 - Incorrect configuration

Network Settings error is detected. Check Network Settings (refer to table 3.1).

$A091 - Internal error Check the status and contact us.

Warning Codes

When an error occurs with EtherNet/IP communication, register data positions 36 and 37 are set to appropriate warning codes. In this case, communication might continue.

Table 6.3 Warning Codes

Warning Code 1

Warning Code 2

Name Description

$9012 The scan number of the node

Node not found There is no response from the node that is included in the scan list. Check for a CIP error.

$0913 The scan number of the node

Node information mismatch

The device information stored in the scan list differs from one that is retrieved from the actual device. Check for a CIP error.

Page 104: EtherNet/IP Interface Module

6-8

IM 34M06H36-01E

CIP Error Codes

When a CIP error is detected, register data positions 38 and 39 are set to the CIP status codes.

Table 6.4 CIP Error Codes

CIP Error Code 1

CIP Error Code 2

Name Description

$C0xx $yyyy CIP error “xx” represents the CIP general status code and “yyyy” represents the CIP extended status code.

Table 6.5 CIP Status Codes List (1/3)

xx (General)

yyyy (Extended)

Description

$01 $0100 CONNECTION IN USE OR DUPLICATE FORWARD OPEN

$01 $0103 TRANSPORT CLASS AND TRIGGER COMBINATION NOT SUPPORTED

$01 $0106 OWNERSHIP CONFLICT $01 $0107 TARGET CONNECTION NOT FOUND $01 $0108 INVALID NETWORK CONNECTION PARAMETER $01 $0109 INVALID CONNECTION SIZE $01 $0110 TARGET FOR CONNECTION NOT CONFIGURED $01 $0111 RPI NOT SUPPORTED. $01 $0112 RPI VALUE(S) NOT ACCEPTABLE $01 $0113 OUT OF CONNECTIONS $01 $0114 VENDOR ID OR PRODUCT CODE MISMATCH $01 $0115 DEVICE TYPE MISMATCH $01 $0116 REVISION MISMATCH $01 $0117 INVALID PRODUCED OR CONSUMED APPLICATION PATH $01 $0118 INVALID OR INCONSISTENT CONFIGURATION APPLICATION PATH $01 $0119 NON-LISTEN ONLY CONNECTION NOT OPENED $01 $011A TARGET OBJECT OUT OF CONNECTIONS $01 $011B THE PRODUCTION INHIBIT TIME IS GREATER THAN THE RPI $01 $011C TRANSPORT CLASS NOT SUPPORTED $01 $011D TO PRODUCTION TRIGGER NOT SUPPORTED $01 $011E DIRECTION NOT SUPPORTED $01 $011F INVALID ORIGINATOR TO TARGET NETWORK CONNECTION FIXVAR$01 $0120 INVALID TARGET TO ORIGINATOR NETWORK CONNECTION FIXVAR

$01 $0121 INVALID ORIGINATOR TO TARGET NETWORK CONNECTION PRIORITY

$01 $0122 INVALID TARGET TO ORIGINATOR NETWORK CONNECTION PRIORITY

$01 $0123 INVALID ORIGINATOR TO TARGET NETWORK CONNECTION TYPE $01 $0124 INVALID TARGET TO ORIGINATOR NETWORK CONNECTION TYPE

$01 $0125 INVALID ORIGINATOR TO TARGET NETWORK CONNECTION REDUNDANT_OWNER

$01 $0126 INVALID CONFIGURATION SIZE $01 $0127 INVALID ORIGINATOR TO TARGET NETWORK CONNECTION SIZE $01 $0128 INVALID TARGET TO ORIGINATOR NETWORK CONNECTION SIZE $01 $0129 INVALID CONFIGURATION APPLICATION PATH $01 $012A INVALID CONSUMING APPLICATION PATH $01 $012B INVALID PRODUCING APPLICATION PATH $01 $012C CONFIGURATION SYMBOL DOES NOT EXIST $01 $012D CONSUMING SYMBOL DOES NOT EXIST $01 $012E PRODUCING SYMBOL DOES NOT EXIST $01 $012F INCONSISTENT APPLICATION PATH COMBINATION

Page 105: EtherNet/IP Interface Module

6-9

IM 34M06H36-01E

Table 6.6 CIP Status Codes List (2/3)

xx (General)

yyyy (Extended)

Description

$01 $0130 INCONSISTENT CONSUME DATA FORMAT $01 $0131 INCONSISTENT PRODUCE DATA FORMAT $01 $0132 NULL FORWARD OPEN FUNCTION NOT SUPPORTED $01 $0133 CONNECTION TIMEOUT MULTIPLIER NOT ACCEPTABLE $01 $0134 MISMATCHED TO NETWORK CONNECTION SIZE $01 $0135 MISMATCHED TO NETWORK CONNECTION FIXVAR $01 $0136 MISMATCHED TO NETWORK CONNECTION PRIORITY $01 $0137 MISMATCHED TRANSPORT CLASS $01 $0138 MISMATCHED TO PRODUCTION TRIGGER $01 $0139 MISMATCHED TO PRODUCTION INHIBIT TIME SEGMENT $01 $0203 CONNECTION TIMED OUT $01 $0204 UNCONNECTED REQUEST TIMED OUT $01 $0205 PARAMETER ERROR IN UNCONNECTED REQUEST SERVICE $01 $0206 MESSAGE TOO LARGE FOR UNCONNECTED_SEND SERVICE $01 $0207 UNCONNECTED ACKNOWLEDGE WITHOUT REPLY $01 $0301 NO BUFFER MEMORY AVAILABLE $01 $0302 NETWORK BANDWIDTH NOT AVAILABLE FOR DATA $01 $0303 NO CONSUMED CONNECTION ID FILTER AVAILABLE $01 $0304 NOT CONFIGURED TO SEND SCHEDULED PRIORITY DATA $01 $0305 SCHEDULE SIGNATURE MISMATCH $01 $0306 SCHEDULE SIGNATURE VALIDATION NOT POSSIBLE $01 $0311 PORT NOT AVAILABLE $01 $0312 LINK ADDRESS NOT VALID $01 $0315 INVALID SEGMENT IN CONNECTION PATH $01 $0316 FORWARD CLOSE SERVICE CONNECTION PATH MISMATCH $01 $0317 SCHEDULING NOT SPECIFIED $01 $0318 LINK ADDRESS TO SELF INVALID $01 $0319 SECONDARY RESOURCES UNAVAILABLE $01 $031A RACK CONNECTION ALREADY ESTABLISHED $01 $031B MODULE CONNECTION ALREADY ESTABLISHED $01 $031C MISCELLANEOUS $01 $031D REDUNDANT CONNECTION MISMATCH

$01 $031E NO MORE USER CONFIGURABLE LINK CONSUMER RESOURCES AVAILABLE IN THE PRODUCING MODULE

$01 $031F NO USER CONFIGURABLE LINK CONSUMER RESOURCES CONFIGURED IN THE PRODUCING MODULE

$01 $0800 NETWORK LINK OFFLINE $01 $0810 NO TARGET APPLICATION DATA AVAILABLE $01 $0811 NO ORIGINATOR APPLICATION DATA AVAILABLE

$01 $0812 NODE ADDRESS HAS CHANGED SINCE THE NETWORK WAS SCHEDULED

$01 $0813 NOT CONFIGURED FOR OFF-SUBNET MULTICAST $01 $0814 INVALID PRODUCE/CONSUME DATA FORMAT

Page 106: EtherNet/IP Interface Module

6-10

IM 34M06H36-01E

Table 6.7 CIP Status Codes List (3/3)

xx (General)

yyyy (Extended)

Description

$02 $01 One or both of the connection instances is non-existent.

$02 $02 The connection class and/or instance is out of resources to bind instances.

$03 - Invalid parameter value $04 - Path segment error $05 - Path destination unknown $06 - Partial transfer $07 - Connection lost $08 - Service not supported $09 - Invalid attribute value $0A - Attribute list error $0B - Already in requested mode/state $0C - Object state conflict $0D - Object already exists $0E - Attribute not settable $0F - Privilege violation $10 - Device state conflict $11 - Reply data too large $12 - Fragmentation of a primitive value $13 - Not enough data $14 - Attribute not supported $15 - Too much data $16 - Object does not exist $17 - Service fragmentation sequence not in progress $18 - No stored attribute data $19 - Store operation failure $1A - Routing failure, request packet too large $1B - Routing failure, response packet too large $1C - Missing attribute list entry data $1D - Invalid attribute value list $1E - Embedded service error $1F - Vendor specific error $20 $01 Both connection instances are the same value. $21 - Write-once value or medium already written $22 - Invalid Reply Received $23 - Buffer Overflow $24 - Message Format Error $25 - Key Failure in path $26 - Path Size Invalid $27 - Unexpected attribute in list $28 - Invalid Member ID $29 - Member not settable

Page 107: EtherNet/IP Interface Module

6-11

IM 34M06H36-01E

6.3 I/O Communication Cannot Be Enabled

I/O communication cannot be enabled.

Check the LED indicators.

Check the status of communication (including a ping test).

Check the points described above and contact us.

Check the registers for a CIP error.

Check whether the information (such as the revision) in the EDS file

matches the target device.

Check whether the data size matches that specified on the target device.

Check whether the tag name or instance ID, which is used to establish a connection, matches that specified

on the target device.

Perform the following actions depending on the error

Use the configuration tool “FA-M3 Configuration Tool EtherNet/IP Interface Module” to check for

errors.

Use Wireshark or other network analyzers to check the communication.

Use WideField to check the link settings.

Check the following.・Operating condition setup switches・IP address setup switches・Table 3.1

Check the network configuration and the following network settings

( If the config area size is set to 500 bytes)Check the correspondence of the configuration

tool.Refer to Section 3.4

Check configuration tool correspondence, and Redownload the Setting.

Make the same settings in the coinfiguration tool.If communication is possible, check the user program.

Refer to Section 3.4

(When configuring with the user program (tool command))

Check whether the EtherNet/IP configuration data is the one exported by the configuration tool or the one read out by the EtherNet/IP Setting data read.

Figure 6.5 I/O Communication Cannot Be Enabled

Page 108: EtherNet/IP Interface Module

Blank Page

Page 109: EtherNet/IP Interface Module

7-1

IM 34M06H36-01E

7. Configuration Tool To use the EtherNet/IP interface module (“this module”), you need to first write settings into it.

For details on the system requirements for this configuration tool, refer to “1.4 Overview of the Configuration Tool”.

This configuration tool offers the following main functions:

- Settings write: Writes communications settings into this module.

(Network parameters, EtherNet/IP data)

- Connection support: Supports I/O communication with EtherNet/IP.

- Settings check: Checks the settings configured on this module.

This configuration tool and the EDS file of this module can be downloaded from Yokogawa's membership site "Partner Portal".

URL: https://partner.yokogawa.com/global/itc/index.htm

Note For EDS files from other manufacturers, please contact them.

Page 110: EtherNet/IP Interface Module

7-2

IM 34M06H36-01E

Settings write

You have to configure the following settings on this module:

- EtherNet/IP setting data: If you are using this module as a scanner, you have to configure adapter connection settings

and assign tags to link registers to enable the exchange of data with FA-M3.

If you are using this module as an adapter, you have to set tags to enable connection from another scanner and assign those tags to link registers.

- Network settings: You have to set up the LAN port on this module. The available settings include the IP address,

subnet mask, default gateway, and IP-TTL.

By using this configuration tool, you can configure these settings, manage them in a project file, and write them into the flash memory of this module.

The following figure shows the general setup procedures to be followed when this module is to be used as either a scanner or an adapter.

To use F3LN01 as a scanner:

Load an EDS file.

Register devices in the scan list.

Set the IP addresses of

adapters.

Configure adapter connection settings.

Assign tags to link registers.

Download settings.

Configuration complete

To use F3LN01 as an adapter:

Configure the network settings

for F3LN01.

Set adapter tags.

Assign tags to link registers.

Download settings.

Configuration complete

Configure the network settings

for F3LN01.

Figure 7.1 General Setup Procedures

Page 111: EtherNet/IP Interface Module

7-3

IM 34M06H36-01E

Connection support

A connection check is done after you configure and download settings. If a connection cannot be established during a connection check, this configuration tool provides the following support functions:

- Checking the scan list for disconnected adapters The execution of Scan List Monitor provided with this configuration tool displays

disconnected adapters in a different color for easy identification.

- Identifying the connection error that has occurred with the disconnected adapters The execution of Scan List Monitor provided with this configuration tool loads the CIP

status code that was output upon the occurrence of the connection error. Checking this status code gives you an idea of what caused the connection failure.

- Loading device information from disconnected adapters A connection failure can occur due to inconsistent device information. This configuration

tool can load device information (device properties) from disconnected adapters.

Settings check

If you configure this module by using a program you have developed specifically for this purpose, you can verify the configured data with this configuration tool.

Page 112: EtherNet/IP Interface Module

7-4

IM 34M06H36-01E

7.1 Main Screen If you start this configuration tool, the screen shown in Figure 7.2 appears.

Figure 7.2 Main Screen

Title bar

The title bar shows the name and version of the configuration tool, and the name of the open project file. If you edit the project, an asterisk (*) appears after the project file name until you save the settings.

Device list

[Device List] is displayed in the left area of the screen. If you load an EDS file of a device into this configuration tool, the device shows up in this area.

Any devices to be used as adapters must first be registered here.

Scan list

[Scan List] is displayed in the center area of the screen.

When this module is used as a scanner, a scan list displayed in this area describes the network configuration for connection with adapters. “F3LN01” displayed at the top of the list is the module that serves as a scanner, and you will be writing settings into this module.

If you are using only the adapter function with this module, you will be configuring adapter settings for only the “F3LN01” displayed at the top of the list.

Page 113: EtherNet/IP Interface Module

7-5

IM 34M06H36-01E

IP address

The [IP Address] area is located on the top right of the screen. If you click one of the devices displayed in the scan list, the IP address of that device shows up in this area. You can also change IP addresses from this area.

Device property

The [Device Property] area is displayed on the right of the screen. If you click one of the devices displayed in the device list or scan list, the properties of that device show up.

Explanation

The [Explanation] area is located on the bottom right of the screen. You can use this area to review the details of the error/warning codes and CIP statuses stored in the register of this module. If you enter one of these codes and click the [Explanation] button, the details of that code show up in the [Information] area located below.

Information

The [Information] area is located on the bottom right of the screen. This area displays the following information.

Table 7.1 Information displayed under [Information]

Connection Status*1 Trigger Displayed Information

Off On Monitor

Applicable Applicable Applicable The [Explanation] button in the [Explanation] area is clicked.

Details of the error/warning and the CIP status

Applicable Applicable A device is clicked in the [Scan List] area.

Details of a connection settings error or warning output for a specific device

Applicable A device is clicked in the [Scan List] area.

Details of the CIP status output upon connection

Applicable Information displayed in the [Monitor CIP Status] area is clicked.

Details of the CIP status corresponding to the clicked line

Applicable Applicable Information displayed in the [Relay] area is clicked.

Details of X relay and Y relay status

Applicable Applicable Information displayed in the [Register] area is clicked.

Details of the error/warning and the CIP status

*1: Connection status: On = online, Off = offline, Monitor = Scan List Monitor is running

Monitor CIP Status

When this module goes online, the indication [Monitor CIP Status] shows up at the bottom of the screen.

If you start Scan List Monitor, this area displays the CIP status output when a connection with the adapters failed. The CIP status does not show up when a connection with the adapters is successful. Similarly, the CIP status does not show up when the connection destination is not found and a communication is therefore not established.

CPU LED status

When this module goes online, the LED status of the connected CPU module shows up. This is applicable to sequence CPUs only.

Page 114: EtherNet/IP Interface Module

7-6

IM 34M06H36-01E

Module status

When this module goes online, the relay and register status (error/warning and CIP status) of this module shows up.

Page 115: EtherNet/IP Interface Module

7-7

IM 34M06H36-01E

7.2 Loading EDS Files If you are using this module as a scanner, you have to load the EDS files prepared for the devices to be used as adapters into this configuration tool.

You can load EDS files in one of the following ways:

- On the menu bar, select [Edit], and then [Read EDS File].

- Click the icon.

When the EDS files are successfully loaded, the loaded devices show up on the device list.

Afterwards, the registered devices show up on the device list each time you start this configuration tool. The devices registered in the scan list must also be registered in the device list.

You can delete devices that are no longer necessary from these lists.

You cannot register the same device twice on these lists. However, devices with the same model name but different revisions can be registered in these lists as different devices.

7.3 Registering Devices in the Scan List

If you are using this module as a scanner, you have to register the devices to be used as adapters in the scan list.

You can register devices in one of the following ways:

- On the device list, select devices, and then drag and drop them onto the scan list.

- On the device list, select devices, and then click the icon.

- On the device list, right-click a device, and then select [Add Scanlist].

The registered devices show up on the scan list.

To use F3LN01 as a scanner:

Load an EDS file.

Register devices in the scan list.

Set the IP addresses of

adapters.

Configure the network settings

for F3LN01.

To use F3LN01 as a scanner:

Load an EDS file.

Register devices in the scan list.

Set the IP addresses of

adapters.

Configure the network settings

for F3LN01.

Page 116: EtherNet/IP Interface Module

7-8

IM 34M06H36-01E

7.4 Configuring F3LN01 Network Settings Set network parameters for this module.

You have to configure the following settings:

- IP address

- Subnet mask

- Default gateway

- IP TTL

You can set network parameters on the [Network Parameter Setting] screen. You can open the setting screen in one of the following ways:

- On the menu bar, select [Edit], and then [Network

Parameter Setting].

- Right-click [F3LN01[Target Module]], and then select [Network Parameter Setting].

- Click the icon.

- Select [F3LN01[Target Module]], and then in the [IP Address] area, click the [IP Setting] button.

Figure 7.3 [Network Parameter Setting] Screen

Configure adapter connection settings.

To use F3LN01 as an adapter:

Configure the network settings

for F3LN01.

Set adapter tags.

To use F3LN01 as a scanner:

Load an EDS file.

Register devices in the scan list.

Set the IP addresses of

adapters.

Configure the network settings

for F3LN01.

Page 117: EtherNet/IP Interface Module

7-9

IM 34M06H36-01E

An IP address is determined by a combination of the hardware setting that is configured by means of the switches and the software setting stored in the flash memory.

For details, refer to “3.3 Network Settings”.

On the [Network Parameter Setting] screen, you can identify the IP address that is going to be valid by entering the switch settings.

7.5 Setting the IP Addresses of Adapters When you are using this module as a scanner, you have to set an IP address for each one of the adapters you have registered in the scan list.

If you click one of the adapters in the scan list, the IP address of the adapter shows up in the [IP Address] area.

In this area, you can change the displayed IP address.

You have to observe the following conditions when setting or editing an IP address:

- An IP address set for the adapter must be different from the one set for

the scanner.

- If there are multiple adapters with the same IP address set for them, these adapters must be identical to one another. In other words, these adapters will be used as a single adapter.

- If there are multiple adapters with the same IP address set for them, different connection settings must be configured for each one of them.

If any of the above conditions are not met, the corresponding device is highlighted in pink. When you click it, the device settings show up in the [Information] area.

To use F3LN01 as a scanner:

Load an EDS file.

Register devices in the scan list.

Set the IP addresses of

adapters.

Configure the network settings

for F3LN01.

Page 118: EtherNet/IP Interface Module

7-10

IM 34M06H36-01E

7.6 Setting F3LN01 Adapter Tags If you are using this module as an adapter, you need to set tags to enable connection from another scanner. You can set adapter tags by opening the [F3LN01 Tag Setting for Adapter] screen.

You can open the setting screen in one of the following ways:

- Double-click [F3LN01[Target Module]].

- Click the icon.

- Right-click [F3LN01[Target Module]] and then select [F3LN01 Tag Setting for Adapter].

Figure 7.4 shows the [F3LN01 Tag Setting for Adapter] screen.

You can set the necessary tags on this screen.

[Add] button: This button adds a tag to the table.

[Size when added]: This is the size applied to the added tag.

[Initial ID]: This is the ID applied to the added tag. When the set ID is already in use, this configuration tool searches for and displays an available ID.

[Initial Tag]: This is the name applied to the added tag. This tag name is saved with a numerical value attached to it.

[Delete]: This button deletes the selected tag from the table.

Figure 7.4 [F3LN01 Tag Setting for Adapter] Screen

To use F3LN01 as an adapter:

Configure the network settings

for F3LN01.

Set adapter tags.

Assign tags to link registers.

Download settings.

Configuration complete

Page 119: EtherNet/IP Interface Module

7-11

IM 34M06H36-01E

7.7 Configuring Adapter Connection Settings

Open the [Adapter connection setting] screen to configure connection settings for the adapter devices in the scan list.

You can open the setting screen in one of the following ways:

- Double-click one of the adapters in the scan list.

- Select one of the adapters in the scan list, and then click the icon.

- Right-click one of the devices in the scan list, and then select [Adapter Connection Setting].

Figure 7.5 shows the [Adapter connection setting] screen.

For a single scan list, you can configure a set of connection settings for input (T O) and another set of connection settings for output (O T).

Table 7.2 describes the available settings.

However, the configurable range of each setting and selectable options vary depending on the device specifications defined in the EDS file.

Table 7.2 Adapter Connection Settings

Item Displayed Information

[Connection selection] You can select a connection name specified in the EDS file.

[Communication type] Either [Logical Segment] or [Symbolic Segment] is displayed as the connection type. This item is automatically input when you select a connection name.

[Timeout multiplier] You can select a timeout period that determines the timing of disconnection. Set a multiple of RPI.

[Trigger] You can select either [Cyclic] or [Change Of State].

[PIT] You can configure this setting when you have selected [Change Of State] as a trigger. Set a value in the range from 0 to 255 (milliseconds) as the time period following the change of state during which you can inhibit data transmission.

[Configuration Instance] The instance number of the configuration is displayed.

[RPI] Set a value in the range from 1 to 10,000 (milliseconds) as a communication interval.

[Connection type] Select either [PointToPoint] or [Multicast]. [Realtime format] Select from options such as [Heartbeat], [Modeless], etc. [Priority] This item is fixed to [Schedule].

[Logical segment instance] If you have selected [Logical Segment] as a communication type, specify an instance for communication.

[Tag name] for symbolic segment

If you have selected [Symbolic Segment] as a communication type, specify a tag name for communication.

[Data size] Specify the size of incoming and outgoing data.

Note All of the above settings must be in agreement with the adapter settings. In particular, if the instance for logical segment communication, the tag name for symbolic segment, and the data size set here are inconsistent with the adapter settings, a connection cannot be established.

To use F3LN01 as a scanner:

Load an EDS file.

Register devices in the scan list.

Set the IP addresses of

adapters.

Configure adapter connection settings.

Assign tags to link registers.

Download settings.

Configuration complete

Configure the network settings

for F3LN01.

Page 120: EtherNet/IP Interface Module

7-12

IM 34M06H36-01E

Figure 7.5 Adapter Connection Settings

Page 121: EtherNet/IP Interface Module

7-13

IM 34M06H36-01E

Using F3LN01 as an Adapter

Provided that you are using F3LN01 as an adapter, proper connection information is automatically selected from the project file in which the adapter settings are saved, which you can use to set connection settings for F3LN01.

(This project file contains the project settings that you have configured on the [F3LN01 Tag Setting for Adapter] screen.)

When F3LN01 is the adapter, the [Select Tag of F3LN01] buttons show up at the bottom of the screen, as shown in Figure 7.5. These buttons do not show up when another company's device is used as an adapter.

If you click one of the [Select Tag of F3LN01] buttons, the screen shown in Figure 7.6 appears.

Figure 7.6 [SelectTag] Screen

Of the project files saved in the folder specified in the [Select Folder] area, only the one having the matching IP address is displayed in the [Select Project] area.

Of the adapter tags saved in the project displayed in the [Select Project] area, only the ones having the matching communication type (logical segment or symbolic segment) and communication direction (T O or O T) are displayed in the [Select Tag] area.

If you select one of the tags displayed in the table under [Select Tag] and then click the [OK] button, an instance for logical segment communication or a tag name for symbolic segment and data size are automatically set on the [Adapter connection setting] screen.

Page 122: EtherNet/IP Interface Module

7-14

IM 34M06H36-01E

Disable the Minor Revision Check of the Adapter

Normally, when connecting to an adapter, if the major revision and minor revision defined in the EDS file do not match both the major revision and minor revision registered inside the adapter device to be connected, a revision mismatch error occurs. However, depending on the adapter device manufacturer, the major revision and minor revision may not match in the adapter device and EDS file.

As a workaround when connection is not possible due to the combination of adapter devices in this way, it is possible to make settings that allow minor revision mismatches. Click the adapter displayed in the [Scan List] and the [Device Properties] will be displayed as shown in Figure 7.7.

Figure 7.7 Device Property

To disable the minor revision check, click the checkbox displayed next to [Minor Revision]. If checked, it will be displayed as shown in Figure 7.8.

Figure 7.8 Device Property (Disable minor revision check)

Page 123: EtherNet/IP Interface Module

7-15

IM 34M06H36-01E

Note - Major revision mismatch cannot be disabled.

- If the revisions do not match between the EDS file and the adapter, first contact the manufacturer to see if there is a correct matching combination. If there is no matching combination, also inquire whether it is okay to connect with minor revisions that do not match. Please note that we are not responsible for any damage caused by connecting with invalid minor revision check without checking the above.

Page 124: EtherNet/IP Interface Module

7-16

IM 34M06H36-01E

7.8 Assigning Tags to Link Registers (W) You have to assign tags with connection settings configured for them to link registers of this module. You can assign tags to link registers by using the [Tag, Link Register(W) Allocation] screen.

You can open the setting screen in one of the following ways:

- On the menu bar, select [Edit], and then [Tag, Link Register(W) Allocation].

- Click the icon.

- Right-click one of the devices in the scan list, and then select [Tag, Link Register(W) Allocation].

Figure 7.7 shows the [Tag, Link Register(W) Allocation] screen.

On the [Tag, Link Register(W) Allocation] screen, you only have to set [W Start] of the link register to which to assign each tag.

If you click the [Auto Set] button, tags that are not yet set are automatically set, saving you the trouble of setting each tag. In this case, tags are assigned to available registers (those to which no tag has been assigned yet).

The tags assigned to link registers show up in the lists displayed on the right of the screen. If there are any problems with the assignment of tags to link registers, the corresponding tags are displayed in red.

These problems include the following:

- The same link register number is used with two or more tags.

- The output tag area contains a tag used for input.

Output tags are integrated into [Link Register Output Area] for processing. For this reason, remember that you cannot place an input register in this area. You can check the output tag area by viewing [Link Register Output Area] located on the top right of the screen.

Note The assignment of tags to link registers is the setting to be configured on the F3LN01 module alone, which is done by setting a value in the range from W0001 to W8192. The link system of link registers is not taken into account. Any necessary adjustments with regard to the link system of link registers must be done on the WideField side. Refer to “3.2 CPU Settings”.

For details on output tags, refer to “Assignment of Output Tags to Link Registers” of “Appendix 4. Tips”.

To use F3LN01 as a scanner:

Load an EDS file.

Register devices in the scan list.

Set the IP addresses of

adapters.

Configure adapter connection settings.

Assign tags to link registers.

Download settings.

Configuration complete

To use F3LN01 as an adapter:

Configure the network settings

for F3LN01.

Set adapter tags.

Assign tags to link registers.

Download settings.

Configuration complete

Configure the network settings

for F3LN01.

Page 125: EtherNet/IP Interface Module

7-17

IM 34M06H36-01E

Figure 7.9 [Tag, Link Register(W) Allocation] Screen

Page 126: EtherNet/IP Interface Module

7-18

IM 34M06H36-01E

7.9 Checking the Scan List You can check whether the settings described in the previous sections are properly configured for each one of the devices in the scan list.

If there is an error in the settings, the corresponding device is highlighted in pink.

When you click the highlighted device, the device settings show up in the [Information] area.

If the settings can cause unstable communication in some environments, the corresponding device is highlighted in yellow as a warning.

If there is an error or warning in the settings, the following message shows up on the status bar: “There are errors or warnings in the configuration.”

When all the settings are correctly specified, the message “The setting is normal. You can download it.” shows up on the status bar and you can download the settings.

An error is output when the following conditions are not satisfied:

- When [Logical Segment] is selected as a communication type, the set ID must be in the range from 0 to 65535.

- There must be no more than 256 tags.

- The IP address of each device must be in a.b.c.d format.

- The IP addresses of the adapters must be different from the IP address of the scanner.

- Different IP addresses must be specified for different devices.

- Different connection schemes must be set for all devices having the same IP address.

- If [Symbolic Segment] is selected as a communication type, the [Tag name] field must not be left blank.

- Tags have been assigned.

Page 127: EtherNet/IP Interface Module

7-19

IM 34M06H36-01E

7.10 Downloading Settings After checking the status bar and confirming that the settings are free of errors, you can download the settings to this module. When the settings contain any errors, you cannot download them.

On the menu bar, select [Online], and then [Connect].

On the displayed screen, you can select a connection scheme.

Figure 7.10 Selecting a Connection Scheme

If you select [FA-M3 Connection], a connection is established by using a normal connection scheme provided by FA-M3. The connection can be established even when the actual IP address of F3LN01 is different from the set IP address.

On the other hand, with F3LN01 connection, a connection is made to the IP address that has been set as the target module on this configuration tool. In this case, one of the ports set on FA-M3 is automatically reconfigured to establish a connection.

Under [Link System Setup], select a link system of the F3LN01 to connect to. For details on a link system, refer to “3.2 CPU Settings”.

Select a connection destination, and then click the [Connect] button.

After the connection is successfully established, the indication [Online] shows up on the status bar and information regarding the connected CPU and F3LN01 as well as the monitor display show up on the screen. (Figure 7.9)

The LED status of the CPU (F3SP only) and the relays and registers of F3LN01 are monitored at regular intervals.

Next, on the menu bar, select [Online], and then [Download].

To use F3LN01 as a scanner:

Load an EDS file.

Register devices in the scan list.

Set the IP addresses of

adapters.

Configure adapter connection settings.

Assign tags to link registers.

Download settings.

Configuration complete

To use F3LN01 as an adapter:

Configure the network settings

for F3LN01.

Set adapter tags.

Assign tags to link registers.

Download settings.

Configuration complete

Configure the network settings

for F3LN01.

Page 128: EtherNet/IP Interface Module

7-20

IM 34M06H36-01E

If a ladder program is running, a message appears, asking you whether it is OK to stop the ladder program. Download begins when the ladder program stops.

After you finish your online tasks, terminate the connection by selecting [Online] on the menu bar, and then [Disconnect].

Figure 7.11 Main Screen - Online Mode

Page 129: EtherNet/IP Interface Module

7-21

IM 34M06H36-01E

7.11 Scan List Monitor During online mode, you can use Scan List Monitor.

On the menu bar, select [Online], and then [Monitor]. Alternatively, click the [Monitor ON] button under [Monitor CIP Status].

When information in the displayed scan list could be different from the settings configured on the connected module, the settings are automatically uploaded.

The monitor regularly loads the communication status of special relays and highlights the adapters in the scan list with different colors to indicate their connection status.

Green indicates connected devices, pink indicates disconnected devices, and gray indicates disabled devices.

When a connection is successful:

When a connection is unsuccessful:

If you click a device highlighted in pink, the details of the corresponding CIP status show up in the [Information] area.

Page 130: EtherNet/IP Interface Module

7-22

IM 34M06H36-01E

7.12 Monitor CIP Status When Scan List Monitor starts, CIP status is regularly acquired and displayed.

The following information is displayed:

- Display number: 001 or greater number

- Time: The time elapsed since the start of Monitor CIP Status or since the clicking of the [Clear] button

- Scan number

- CIP status code

If you click a CIP status information line displayed under [Monitor CIP Status], the corresponding CIP status information shows up in the [Information] area.

Page 131: EtherNet/IP Interface Module

7-23

IM 34M06H36-01E

7.13 Checking Adapter Information If you click the [Read] button under [Device Property] while online, a ladder program is stopped if it is running (a confirmation message is displayed), and device information is acquired and displayed by means of an Identity message.

This operation is not available while Scan List Monitor is running.

Select one of the devices in the scan list. You can use the IP address of the selected device to check adapter information.

When the information is loadable, the [Read] button under [Device Property] becomes enabled.

If you click the [Read] button, the [DeviceProperty] dialog box appears.

Figure 7.12 [DeviceProperty] Dialog Box

If you load an undefined device in the scan list and the EDS file of the loaded device is registered in the device list, the undefined device in the scan list is replaced with the device corresponding to the EDS file.

Page 132: EtherNet/IP Interface Module

7-24

IM 34M06H36-01E

7.14 Checking the Settings You can review the EtherNet/IP data set in this module to confirm whether it is free of mistakes.

On the menu bar, select [Online], and then [Upload Data Check].

The data is automatically uploaded and then checked.

The check results are displayed in a dialog box.

This operation causes the data to be uploaded but does not update the scan list.

Figure 7.13 Checking the Data Set in the Module

The EtherNet/IP data saved in binary format can also be checked in the same manner.

On the menu bar, select [Tools], [Check], and then [EtherNet/IP Data (bin)].

7.15 Export This configuration tool can output the following files that describe project details:

- EtherNet/IP data

Of the configuration data written into this module, this configuration tool can output EtherNet/IP data to a file. By using the CPU module program, you can load data from this file, and then by using a user-developed program, you can write the settings into this module. You can select either binary format or text format as the output file format.

- Scan list

You can output the registered scan list in CSV format. You can use this file to check the connection settings configured for adapters.

- Tag list

You can output data regarding the relationship between tags and link registers in CSV format. You can use this file, for example, to check whether tags are correctly assigned to link registers.

Page 133: EtherNet/IP Interface Module

7-25

IM 34M06H36-01E

7.16 Scanning Adapters By using the ping command, this configuration tool can search for connected adapters and register them in the scan list.

On the menu bar, select [Online], and then [Scanning Adapters].

A screen appears, on which you can set the scanning of adapters.

Figure 7.14 [Scanning Adapters] Screen

Specify the range of IP addresses to define the adapters to be scanned and specify the timeout period for the ping command.

To start a scan, click the [Start] button.

The scan results show up on the right pane.

If you click the [OK] button, the found devices are added to the scan list.

If an existing device in the scan list has the same IP address as that of a found device, the existing device remains unchanged. Devices with no IP address assigned to them are displayed as “Undefined”.

When you click an “Undefined” device and then click the [Read] button, if that device is already registered in the device list, the [Undefined] marking in question is replaced with the name of that device.

Taking the above steps saves you the trouble of registering devices in the scan list and setting the IP address of each adapter.

Page 134: EtherNet/IP Interface Module

7-26

IM 34M06H36-01E

7.17 Main Menu [File] - [New Project]

This menu command initializes all the settings inside this configuration tool. [File] - [Open Project]

This menu command loads a previously saved project file and applies the settings to it. (If no project has been saved, a confirmation message appears.)

[File] - [Save Project]

This menu command overwrites the loaded project file with the settings. If you select this menu command when this configuration tool is in its initial state, you will be prompted to enter the name of the file to which to save the settings.

[File] - [Save Project As]

This menu command saves the settings to a project file. You will be prompted to enter the name of the file to which to save the settings.

[File] - [Exit]

This menu command shuts down this configuration tool. If you have not saved the edited settings to a project file, you will be asked whether you want to save your settings. If this module is online, the connection is terminated before the tool is shut down.

[Edit] - [Read EDS File]

This menu command loads EDS files and registers them in the device list. When the same devices already exist in the device list, those devices will not be added to the device list. The same devices are those that have the same vendor code, device code, product code, major revision, and minor revision as the loaded devices.

[Edit] - [Tag, Link Register(W) Allocation]

A screen appears, on which you can assign tags to link registers. [Edit] - [Network Parameter Setting]

A screen appears, on which you can set network parameters. [Online] - [Connect]

This menu command is selectable when this module is offline.

A screen appears, on which you can select a connection scheme and establish a connection. [Online] - [Disconnect]

This menu command is selectable when this module is online. This menu command disconnects this module from FA-M3.

[Online] - [Download]

This menu command is selectable when this module is online. This menu command downloads EtherNet/IP data and network parameters. However, if the same network parameters have already been set, the network parameters will not be downloaded. If a connection is made to the target module to download network parameters, this configuration tool disconnects from the target module before the EtherNet/IP Start Request relay turns on. This precaution is necessary to prevent disconnection due to the change of network settings. If you want to connect this configuration tool to the same target module again, you have to first turn the module off and on again or turn on the EtherNet/IP Start Request relay and enable the IP address.

Page 135: EtherNet/IP Interface Module

7-27

IM 34M06H36-01E

[Online] - [Upload]

This menu command is selectable when this module is online. This menu command uploads EtherNet/IP data and network parameters and applies them to the scan list. When there is edited data that has not been saved yet, a confirmation message appears, asking you if you want to save the project.

[Online] - [Upload Data Check]

This menu command is selectable when this module is online. This menu command uploads and checks the EtherNet/IP data set in the module. Note that the uploaded data will not be applied to the scan list.

[Online] - [Monitor]

This menu command is selectable when this module is online. This menu command starts Scan List Monitor.

[Online] - [Scanning Adapters]

This menu command is selectable when this module is online. A dialog box appears, from which you can scan adapters connected to the network by using the ping command.

[Online] – [Mode Change]

This menu command is selectable when this module is online. Change the module operation mode (config area size) from 500byte to 64byte.

[Tools] - [Export] - [EtherNet/IP Data (bin)]

This menu command saves the EtherNet/IP data to be downloaded in a binary file. [Tools] - [Export] - [EtherNet/IP Data (text)]

This menu command saves the EtherNet/IP data to be downloaded in a text file. [Tools] - [Export] - [Tag List (csv)]

This menu command saves the tag list to a file in CSV format. [Tools] - [Export] - [Scan List (csv)]

This menu command saves the scan list, including the connection settings, to a file in CSV format.

[Tools] - [Import] - [EtherNet/IP Data (bin)]

This menu command loads the exported and saved binary file containing EtherNet/IP data and applies it to the scan list.

[Tools] - [Import] - [EtherNet/IP Data (text)]

This menu command loads the exported and saved text file containing EtherNet/IP data and applies it to the scan list.

Page 136: EtherNet/IP Interface Module

7-28

IM 34M06H36-01E

[Tools] - [Check] - [EtherNet/IP Data (bin)]

This menu command loads and checks the exported and saved binary file containing EtherNet/IP data. Note that the loaded data will not be applied to the scan list.

[Tools] - [Language Change]

A screen appears, on which you can change the language. [Help] - [FA-M3 Configuration Tool EtherNet/IP Interface Module Help]

This menu command opens the manual of the module. [Help] - [About FA-M3 Configuration Tool EtherNet/IP Interface Module]

This menu command displays version information for this configuration tool.

Page 137: EtherNet/IP Interface Module

Appx.1-1

IM 34M06H36-01E

Appendix 1. EDS File

Appendix 1.1 EDS File of this Module This section describes how to obtain the EDS file for this module.

This configuration tool and the EDS file of this module can be downloaded from Yokogawa's membership site "Partner Portal".

URL: https://partner.yokogawa.com/global/itc/index.htm

The following files can be downloaded.

If you use another manufacturer's scanner for IO communication, please register the EDS file of this module to the configuration tool of the other manufacturer's scanner.

File name Note

Yokogawa_F3LN01.eds In most cases, this file will be used. Yokogawa_Chassis.eds Please use this file if you are asked for an EDS file in Chassis format.

Example: OMRON's Network Configurator, etc. F3LN01.ico When you register the EDS file, please put it in the same folder as the above file.

Note For EDS files from other manufacturers, please contact them.

Page 138: EtherNet/IP Interface Module

Appx.1-2

IM 34M06H36-01E

Appendix 1.2 Overview of EDS Files This section provides an overview of the EDS file.

In the EDS file, specifications are defined for each section separated by [].

For more details, please refer to the CIP specifications published by ODVA. In this document, only the Overview is explained.

What you can do with EDS files

The EDS file defines the connection settings for the adapter devices.

By reading the EDS file into the configuration tools of each company, you can reduce the man-hours required for configuration.

The parameters of the EDS file are subject to the adapter equipment specifications, so please contact the adapter equipment manufacturer.

Note If the EDS file cannot be registered in the configuration tool, please contact us.

Basic Section

File name Note

[File] EDS file information [Device] Device information [Device Classfication] Category Information. example: EtherNet/IP, DeviceNet [Param] Variable definitions for parameters.

It is used to define parameters for connection settings and configuration settings.The range and default values of the parameters are defined.

[Assembly] This is the structure definition of the parameter ([Pram]). It is used to define parameters for connection settings and configuration settings.The range and default values of the parameters are defined.

[Connection Manager] Connection setting information. For each connection name, information on multiple connection settings is defined.The configuration tool reads the adapter connection settings from the specified connection name. The connection settings consist of constants, [Param], and [Assembly].

Others

- “$ ~” is comment.

Page 139: EtherNet/IP Interface Module

Appx.1-3

IM 34M06H36-01E

EDS File Example

Note This is different from the actual EDS file of this module.

[File] DescText = "F3LN01"; CreateDate = 11-30-2017; CreateTime = 09:00:00; ModDate = 04-17-2018; ModTime = 17:00:00; Revision = 1.0; HomeURL = "http://www.fa-m3.com/";

[Device] VendCode = 250; VendName = "Yokogawa Electric Corporation"; ProdType = 12; ProdTypeStr = "Communications Adapter"; ProdCode = 6; MajRev = 1; MinRev = 1; ProdName = "F3LN01"; Catalog = "F3LN01"; Icon = "F3LN01.ico";

[Device Classification] Class1 = EtherNetIP;

Marjor Revision

Minor Revision

Page 140: EtherNet/IP Interface Module

Appx.1-4

IM 34M06H36-01E

[Params] Param30 = 0, $ reserved, shall equal 0 ,, $ Link Path Size, Link Path 0x0000, $ Descriptor 0xC2, $ Data Type 1, $ Data Size in bytes "Port Mode (Port 1)", $ name "", $ units "", $ help string 0,3,1, $ min, max, default data values ,,,, $ mult, div, base, offset scaling ,,,, $ mult, div, base, offset links ; $ decimal places Enum30 = 0,"Disabled", 1,"Digital Input (Pin 4)", 2,"Digital Output (Pin 4)", 3,"IO-Link (Pin 4)";

[Assembly] Object_Name = "Assembly Object"; Object_Class_Code = 0x04;

Assem199 = "Config Assembly", "20 04 24 C7 30 03", , 0x0001, ,, 8,Param28, 8,Param29, 8,Param30, 8,Param31, 8,Param32,     … 

8,Param736, 8,Param737;

Parameter Value

Parameter instance name

Parameter Min (0)、Max(3)、default data values(1)

Parameter instance number

Assembly Instance Number

Assembly Instance Name

Page 141: EtherNet/IP Interface Module

Appx.1-5

IM 34M06H36-01E

[Connection Manager] Object_Name = "Connection Manager Object"; Object_Class_Code = 0x06; Connection1 = 0x04010002, $ Trigger and Transport 0x44640405, $ Connnection Parameters Param19,Param2,Assem150, $ O->T RPI, size, format Param19,Param1,Assem100, $ T->O RPI, size, format ,, $ proxy config size, format 98,Assem199, $ target config size, format "Exclusive Owner IO-Acyc-Diag", $ Connection Name " In/Out Data", $ help string "20 04 24 C7 2C 96 2C 64"; $ Path

Set Default Values And Ranges For Other Parameters

ConnectionName

Config. InstanceNumber

Page 142: EtherNet/IP Interface Module

Appx.1-6

IM 34M06H36-01E

Appendix 1.3 Parameter Settings Procedure This section describes the parameter setting procedure for the adapter device.

Parameter Settings Procedure

Explains the parameter settings procedure for the adapter device.

Use a text editor to modify the EDS file.

Start

Is there an config. Instance definition?

Check the definition of the config. instance in the connection settings of the EDS file.

Refer to the specifications of the adapter equipment to check the specifications of the parameters (Params) of

the config. Instance.

Set the value of the parameter (Params) for the config. instance (change the default data value).

Re-register the modified EDS file in the configuration tool.

See next page for details.

If it is defined as Assem199, please search for it below. (The name may vary from company to company.)

Number:Instance Assembly 199 、Instance ID 199Name:Config Assembly 、Configuraiton Assembly

See next page for examples of changes.

END

YES

NO

Note In some cases, the parameter names in the EDS file do not match the parameter names in the manual of the adapter device. In such a case, contact the manufacturer of the adapter device and also contact us.

Page 143: EtherNet/IP Interface Module

Appx.1-7

IM 34M06H36-01E

Parameter Settings Procedure Example

An example of the parameter settings procedure for the adapter device is described below.

Setting content

Set the parameter "Port Mode" of the config instance (Assem199) of the connection "Exclusive Owner IO" to "1 : Input".

Procedure example

(1) Search the EDS file for Port Mode and check the definition of the Port Mode parameter

(Param30).

(2) Change the default data values of Port Mode (Param30) to 1.

[Params]

[Connection Manager]

[Assembly]

Assem100 = …

Assem200 = …

Param29 = … Param30 = 0, $ reserved, shall equal 0 ,, $ Link Path Size, Link Path 0x0000, $ Descriptor 0xC2, $ Data Type 1, $ Data Size in bytes "Port Mode (Port 1)", $ name "", $ units "", $ help string 0,3,2, $ min, max, default data values ,,,, $ mult, div, base, offset scaling ,,,, $ mult, div, base, offset links ; $ decimal placesEnum30 = 0,"Disabled", 1,"Digital Input", 2,"Digital Output", 3,"IO-Link";

(2) change the default data values to 1. 0,3,2, $ min, max, default data values ⇒ 0,3,1, $ min, max, default data values

* The setting can be changed between min-max.

Param30 = …

Connection2 = …

Depending on the EDS file, the comment may look like this$ config #2 or $ config part 2

・・・

Overview of EDS files

Connection3 =‥‥,, $ proxy config size, format98,Assem199, $ target config size, format"Exclusive Owner IO", $ Connection Name‥‥

Assem199 = "Config Assembly",・・・8,Param29, 8,Param30, ・・・

Connection1 = …

(1)

Connection selection of Configuration tool

(2)

Page 144: EtherNet/IP Interface Module

Appx.1-8

IM 34M06H36-01E

Appendix 1.4 Procedure to Check the Config Area Size

Checking Procedure

(1) Check the config area (proxy config size / target config size) size for all connections in the EDS file.

(2) The maximum of the checked sizes shall be used as the config size for the adapter equipment.

Note If the config area size of even one of the adapter devices to be connected is 65 bytes or more, the config area size of this module must be set to 500 bytes.

Checking Procedure Example

In the following example, the configuration area size is 98 bytes.

[Connection Manager]

Connection1 =

Param19,Param2,Assem150, $ O->T RPI, size, format

Param19,Param1,Assem100, $ T->O RPI, size, format

,, $ proxy config size, format

,, $ target config size, format

"Exclusive Owner IO-Acyc-Diag", $ Connection Name

Connection2 =

Param19,Param2,Assem150, $ O->T RPI, size, format

Param19,Param1,Assem100, $ T->O RPI, size, format

,, $ proxy config size, format

98,Assem199, $ target config size, format

"Exclusive Owner IO-Acyc-Diag", $ Connection Name

proxy config size is unused (0 bytes).

target config size is unused (0 bytes).

proxy config size is unused (0 bytes).

target config size is 98 bytes.

Note A proxy config is usually unused.

Page 145: EtherNet/IP Interface Module

Appx.1-9

IM 34M06H36-01E

● If target config area size is not defined

If there is no definition of target config size, please check it with ODVA's EDS editing tool "EZ-EDS" or contact us.

[Connection Manager]

Connection1 =

Param19,Param2,Assem150, $ O->T RPI, size, format

Param19,Param1,Assem100, $ T->O RPI, size, format

,, $ proxy config size, format

,Assem199, $ target config size, format

"Exclusive Owner IO-Acyc-Diag", $ Connection Name

proxy config size is unused (0 bytes).

target config size is used.

The actual size of the data block (in bytes) in

Assem199 is the config size.

Actual Size of the Data Block Bytes↑

Note ODVA's EDS editing tool "EZ-EDS" can be downloaded free of charge from the ODVA website.

Page 146: EtherNet/IP Interface Module

Blank Page

Page 147: EtherNet/IP Interface Module

Appx. 2-1

IM 34M06H36-01E

Appendix 2. Tool Commands To configure the EtherNet/IP interface module (“this module”), not only can you use configuration tool, but you can also develop applications that execute provided tool commands.

Note Configuration tool also uses the tool commands. When you develop applications to execute tool commands, ensure that your applications do not conflict with Configuration tool. Such a conflict can cause tool commands to fail and you may not be able to achieve desired effects.

Page 148: EtherNet/IP Interface Module

Appx. 2-2

IM 34M06H36-01E

Appendix 2.1 Specifications

Registers to Be Used

Table Appendix 2.1 Registers for Tool Commands

Data Position

Item Description R/W

65

EtherNet/IP settings

Command number R/W 66 to 250 Parameters (185 words) R/W 251 to 254 Reserved - 255 Command Run Request flag R/W 256 Command Run Completion flag R

Command number

Specify a command you want to run.

When the command is completed, this area stores the exit code.

Parameters

Specify parameters required for the command to be run.

When the command is completed, this area stores response data, if any.

Command Run Request flag

When both the Command Run Request flag and the Command Run Completion flag are “0”, you can run a command by setting the Command Run Request flag to “1”.

Command Run Completion flag

After you set the Command Run Request flag to “1” to run a command, the Command Run Completion flag changes to “1” when the command is completed.

Once you finish working with the command and set the Command Run Request flag to “0”, the Command Run Completion flag changes to “0”.

Page 149: EtherNet/IP Interface Module

Appx. 2-3

IM 34M06H36-01E

Procedure to Run a Tool Command

Tool command

Set the Command Run Request flag to

“0”.

Specify the command number and command

parameters.

Set the Command Run Request flag to

“1”.

Read the command number area and the

parameter area.

Normal end

Is the Command Run Completion flag “0”?

NO

YES

Is the Command Run Completion flag “1”?

NO

YES

Does the value read from the command number area indicate a

normal end?

Abnormal end

YES

NO

Figure Appendix 2.1 Procedure to Run a Tool Command

Note Do not turn off power while the command to write to the flash memory is being executed.

Page 150: EtherNet/IP Interface Module

Appx. 2-4

IM 34M06H36-01E

Tool Commands Table Appendix 2.2 Tool Commands

Command Number

Command Name This module's

Supported REVWrite to

Flash Memory$0011 EtherNet/IP Settings Write -

$0012 EtherNet/IP Settings Read - - $0031 Network Settings Write -

$0032 Network Settings Read - - $0041 Operation mode setting Write 01:** or later

$0042 Operation mode setting Read 01:** or later -

Note Do not turn off the power while data is being written.

The number of times of writing into the flash memory of this module is limited to 100,000.

Page 151: EtherNet/IP Interface Module

Appx. 2-5

IM 34M06H36-01E

EtherNet/IP Settings Write ($0011)

Write the EtherNet/IP settings data to the flash memory of this module.

Use the EtherNet/IP setting data that was exported by the configuration tool or read by the EtherNet/IP setting read (refer to Section 3.1).

Because of the large data size, the EtherNet/IP setting data is divided into pages (128 words) and registered. On the last page, register the end flag with 1. After the page is added, the entire data is written into the flash memory automatically.

The written EtherNet/IP setting data will take effect when this module starts or the EtherNet/IP Start Request relay is turned from off to on. If the EtherNet/IP setting data is incorrect, an error will occur at the time it is enabled.

Request

Table Appendix 2.3 Requesting the EtherNet/IP Settings Write Command

Data Position Description

65 Command number: $0011 66 Page number: Starting from 0

67

End flag 0: A subsequent page exists. 1: No subsequent page exists. After the page is added, the entire data is written into the

flash memory automatically. 68 to 195 EtherNet/IP setting data line (The length is constant at 128 words.)

Note For details on the EtherNet/IP setting data, refer to “Appendix 3. EtherNet/IP Setting Data”. Note that the EtherNet/IP setting data differs depending on the operation mode of this module (REV:01:** or later).

Response

Succeeded:

Table Appendix 2.4 Success Response of the EtherNet/IP Settings Write Command

Data Position Description

65 Exit code: $0011

Failed:

Table Appendix 2.5 Error Response of the EtherNet/IP Settings Write Command

Data Position Description

65 Exit code: $8011

66

Error code $F011: The request was made while EtherNet/IP communication was enabled. $F012: Flash memory writing error. $F1xx: A parameter was not correct (where xx represents the failed data position).

Note Do not turn off the power while the program is running because it writes to the flash memory.

Page 152: EtherNet/IP Interface Module

Appx. 2-6

IM 34M06H36-01E

EtherNet/IP Settings Read ($0012)

Reads EtherNet/IP settings from this module.

Request

Table Appendix 2.6 Requesting the EtherNet/IP Settings Read Command

Data Position Description

65 Command number: $0012 66 Page number: Starting from 0 *1

*1: Set a sequential number starting from 0.

Note For details on the EtherNet/IP setting data, refer to “Appendix 3. EtherNet/IP Setting Data”. Note that the EtherNet/IP setting data differs depending on the operation mode of this module (REV:01:** or later).

Response

Succeeded:

Table Appendix 2.7 Success Response of the EtherNet/IP Settings Read Command

Data Position Description

65 Exit code: $0012 66 Page number: Starting from 0

67 End flag

0: A subsequent page exists. 1: No subsequent page exists.

68 to 195 EtherNet/IP setting data line (The length is constant at 128 words.)

Failed:

Table Appendix 2.8 Error Response of the EtherNet/IP Settings Read Command

Data Position Description

65 Exit code: $8012

66 Error code

$F1xx: A parameter was not correct (where xx represents the failed data position).

Page 153: EtherNet/IP Interface Module

Appx. 2-7

IM 34M06H36-01E

Network Settings Write ($0031)

Writes the network settings into this module.

The written network setting data will take effect when the power is turned on or an EtherNet/IP Start Request is made.

Request

Table Appendix 2.9 Requesting the Network Settings Write Command

Data Position Description Default Value

65 Command number: $0031

66 to 67 IP address*1

Data Position 0.0.0.0

68 to 69 Subnet mask

Data Position 0.0.0.0

70 to 71 Default gateway

Data Position 0.0.0.0

72 IP Time to Live (0 to 255) 64 *1: An IP address value specified with this command is stored in the flash memory. The stored value takes effect when operating

condition setup switch 8 is on. When “0.0.0.0” is stored in the flash memory, an IP address value set by the IP address setup switches takes effect regardless of whether operating condition setup switch 8 is on or off.

Response

Succeeded:

Table Appendix 2.10 Success Response of the Network Settings Write Command

Data Position Description

65 Exit code: $0031

Failed:

Table Appendix 2.11 Error Response of the Network Settings Write Command

Data Position Description

65 Exit code: $8031

66

Error code $F011: The request was made while EtherNet/IP communication was enabled. $F012: Flash memory writing error. $F1xx: A parameter was not correct (where xx represents the failed data position).

Note Do not turn off the power while the program is running because it writes to the flash memory.

Page 154: EtherNet/IP Interface Module

Appx. 2-8

IM 34M06H36-01E

Network Settings Read ($0032)

Reads the network settings from this module.

Request

Table Appendix 2.12 Requesting the Network Settings Read Command

Data Position Description

65 Command number: $0032

Response

Succeeded:

Table Appendix 2.13 Success Response of the Network Settings Read Command

Data Position Description

65 Command number: $0032

66 to 67 IP address

Data Position

68 to 69 Subnet mask

Data Position

70 to 71 Default gateway

Data Position 72 IP Time to Live (0 to 255)

Failed:

Table Appendix 2.14 Error Response of the Network Settings Read Command

Data Position Description

65 $8032: Error 66 Error code

Page 155: EtherNet/IP Interface Module

Appx. 2-9

IM 34M06H36-01E

Operation Mode Setting Write ($0041)

Writes the operation mode setting to the flash memory of this module.

The written operation mode setting data will take effect when the power is turned on or an EtherNet/IP Start Request is made.

Request

Table Appendix 2.16 Requesting the Operation Mode Setting Write Command

Data Position Description

65 Command number : $0041

66 Config area sizes

64 bytes: $0000 500 bytes: $0001

67 to 69 Reserved

Response

Succeeded:

Table Appendix 2.17 Success Requesting the Operation Mode Setting Write Command

Data Position Description

65 Exit code: $0041

Failed:

Table Appendix 2.18 Error Response of the Operation Mode Setting Write Command

Data Position Description

65 Exit code: $8041

66

Error code $F001: The command is not supported(This occurs when running at REV:00:**). $F012: Flash memory writing error. $F1xx: A parameter was not correct (where xx represents the failed data position).

Note Do not turn off the power while the program is running because it writes to the flash memory.

Page 156: EtherNet/IP Interface Module

Appx. 2-10

IM 34M06H36-01E

Operation Mode Setting Read ($0042)

Reads the Operation mode setting from this module.

Request

Table Appendix 2.19 Requesting the Operation Mode Setting Read Command

Data Position Description

65 Command number: $0042 66 to 69

Response

Succeeded:

Table Appendix 2.20 Success Response of the Operation Mode Setting Read Command

Data Position Description

65 Exit code: $0042

66 to 69 Config area sizes

$0000: 64 bytes $0001: 500 bytes

Failed:

Table Appendix 2.21 Error Response of the Operation Mode Setting Read Command

Data Position Description

65 Exit code : $8042

66 Error code

$F001 : The command is not supported(This occurs when running at REV:00:**).

Error Codes Table Appendix 2.15 Error Codes

Error Code Description Measures

$F001 The command is not supported. Specify the correct command number.

$F011 The request was made while EtherNet/IP communication was enabled.

Do not execute commands while EtherNet/IP communication is executing.

$F012 Flash memory writing error Retry. If the error occurs again, the module may have failed and should be replaced.

$F1xx A parameter is not correct. xx represents the register data position (66 to 250) that stores an incorrect parameter.

Specify the correct parameters.

$F2xx Internal error EtherNet/IP setting data is not correct.

Write the EtherNet/IP setting data exported by the configuration tool. Check that the page number and end flag are correct.

Page 157: EtherNet/IP Interface Module

Appx. 2-11

IM 34M06H36-01E

Appendix 2.2 Sample Programs

Network Settings Write

Page 158: EtherNet/IP Interface Module

Appx. 2-12

IM 34M06H36-01E

Figure Appendix 2.2 Network Settings Write

Page 159: EtherNet/IP Interface Module

Appx. 2-13

IM 34M06H36-01E

EtherNet/IP Settings Read

This sample program reads EtherNet/IP settings and stores them in the cache registers.

Page 160: EtherNet/IP Interface Module

Appx. 2-14

IM 34M06H36-01E

Figure Appendix 2.3 EtherNet/IP Settings Read

Page 161: EtherNet/IP Interface Module

Appx. 2-15

IM 34M06H36-01E

EtherNet/IP Settings Write

This sample program writes EtherNet/IP settings from the cache registers into this module.

Page 162: EtherNet/IP Interface Module

Appx. 2-16

IM 34M06H36-01E

Figure Appendix 2.4 EtherNet/IP Settings Write

Page 163: EtherNet/IP Interface Module

Appx. 3-1

IM 34M06H36-01E

Appendix 3. EtherNet/IP Setting Data This section describes the EtherNet/IP Setting data used by the configuration tools and tool commands.

Note The EtherNet/IP setting data used in the tool commands must be the EtherNet/IP data (bin) exported by the configuration tool. The parameter range specification in this chapter is an example. Please note that the reserved area is not always "0".

Appendix 3.1 Corresponding to Config Area Size The configuration data must be used in accordance with the following table.

This module REV config area size EtherNet/IP Setting Data

00:** 64 bytes For 64 bytes 01:** or later 64 bytes For 64 bytes 01:** or later 500 bytes For 500 bytes

Note The config area size of this module must be set according to the config area size of the adapter devices. For details, refer to "3.4 Config Area Size Setting".

For details on how to check the config area size, refer to "Appendix1. EDS File”.

The EtherNet/IP setting data differs in the following areas. For details, see the next page.

Category Item EtherNet/IP Setting Data

For 64 bytes For 500 bytes

Overall Structure Scan data 312 1184 Details of a Scan Record

Configuration Path Information

288 1160

Configuration Path Information for the Class1 Logical Segment Type

config. info, etc. 252 1124

Configuration Path Information for the Class1 Symbolic Segment Type

config. info, etc. 132 1004

Page 164: EtherNet/IP Interface Module

Appx. 3-2

IM 34M06H36-01E

Appendix 3.2 EtherNet/IP Setting Data The EtherNet/IP configuration data structure is shown below.

Note The EtherNet/IP setting data used in the tool commands must be the EtherNet/IP data (bin) exported by the configuration tool. The parameter range specification in this chapter is an example. Please note that the reserved area is not always "0".

For 64 bytes Table Appendix 3.1 Overall Structure

Category Item Offset Size Notes

Reserved Reserved 0 24 0 (not configurable)*1

Tag list

Number of registered tags

24

2 0 to 256

Reserved 2 Tag 1

28 44 A record represents a tag.

(From 0 up to 256 records) For details of a tag record, refer to Table Appendix 3.2.

Tag 2 44

... ...

Scan list

Number of scan records

28 + 44 x The number of registered tags

2 0 to 128

Reserved 2

Scan data 0 32 + 44 x The number of registered tags

312 A record represents a scan data set. (From 0 up to 128 records)

Scan data 1 312

... ...

*1: This module might return any value other than 0 when you read this area, but it is not failure.

Table Appendix 3.2 Details of a Tag Record (44 Bytes)

Offset Size Item Acceptable

ValueNotes

0 1 Type 1: Scanner 2: Adapter

1 1 Input/Output 0: Output 1: Input

2 2 Tag number 1 to 254 A sequential number is assigned in ascending order for input and output tags, respectively.

4 32 Tag name Half-width alphanumeric characters

Multiple tags cannot have the same name. The maximum length is 32 characters.

36 4 Data offset 0 to 16382

This must be an even number. [Half of this value + 1] indicates the register number of the first link register.

40 2 Data size 0 to 1444 [Half of this value] indicates the number of link registers.

42 2 Instance ID 0: Not specified.1 to 65535

254 and 255 are not acceptable. Multiple tags cannot have the same ID.

Page 165: EtherNet/IP Interface Module

Appx. 3-3

IM 34M06H36-01E

Table Appendix 3.3 Details of a Scan Record (312 Bytes)

Offset Size Item Acceptable Value Notes

0 1 Enabled/Disabled flag0: Disabled 1: Enabled

1 1 Reserved 2 2 Scan number 0 to 127 4 4 IP address 8 2 Reserved 10 2 Vendor identifier 0 to 65535 12 2 Device type 0 to 65535 14 2 Product identifier 0 to 65535 16 1 Major revision 0 to 255 17 1 Minor revision 0 to 255

18 1 Class 1: Class1/3 3: Class3

19 1 Trigger 0: Cyclic 1: Change of State 2: Application

20 2 PIT (in milliseconds) for Change of State

0 to 255

22 1 Time Out Multiplier

0: x 4 (2^2) 1: x 8 (2^3) 2: x 16 (2^4) 3: x 32 (2^5) 4: x 64 (2^6) 5: x 128 (2^7) 6: x 256 (2^8) 7: x 512 (2^9)

23 1 Communication type0: Logical segment 1: Symbolic segment (tag)

24 288 Configuration Path information

When the communication type is 0: The Configuration Path information for the Class1 logical segment type Refer to Table Appendix 3.4. When the communication type is 1: The Configuration Path information for the Class1 symbolic segment type Refer to Table Appendix 3.5.

Page 166: EtherNet/IP Interface Module

Appx. 3-4

IM 34M06H36-01E

Table Appendix 3.4 Configuration Path Information for the Class1 Logical Segment Type (288 Bytes)

Offset Size Item Acceptable Value Notes

0 2 Configuration Instance

0 to 65535

A value of 65535 indicates that Configuration Path is omitted.

2 2 Reserved O=>T information 4 4 RPI 1,000 to 10,000,000 In microseconds 8 1 Connection type 2: Point-to-Point 9 1 Real time format 2: 32-bit Header 10 1 Priority 2: Scheduled 11 1 Reserved

12 2 Instance for logical segment communication

0 to 65535 A value of 65535 indicates that Consuming I/O Path is omitted.

14 2 Data size*1 0 to 1444

This must be an even number. [Half of this value + 1] indicates the register number of the first link register.

16 4 Data offset*1 0 to 16382 [Half of this value] indicates the number of link registers.

T=>O information 20 4 RPI 1,000 to 10,000,000 In microseconds

24 1 Connection type 1: Multicast 2: Point-to-Point

25 1 Real time format 2: 32-bit Header 26 1 Priority 2: Scheduled 27 1 Reserved

28 2 Instance for logical segment communication

0 to 65535 A value of 65535 indicates that Consuming I/O Path is omitted.

30 2 Data size*1 0 to 1444 [Half of this value] indicates the number of link registers.

32 4 Data offset*1 0 to 16382

This must be an even number. [Half of this value + 1] indicates the register number of the first link register.

36 252 Reserved config info, etc. *1: The data size and the data offset in a scan record must match the ones in an appropriate tag record.

Page 167: EtherNet/IP Interface Module

Appx. 3-5

IM 34M06H36-01E

Table Appendix 3.5 Configuration Path Information for the Class1 Symbolic Segment Type (288 Bytes)

Offset Size Item Acceptable Value Notes 0 4 RPI (O=>T) 1,000 to 10,000,000 In microseconds 4 4 RPI (T=>O) 1,000 to 10,000,000 In microseconds

8 1 Connection type 1: Multicast 2: Point-to-Point

9 1 Real time format (O=>T)

2: 32-bit Header

10 1 Real time format (T=>O)

0: Modeless

11 1 Priority 2: Scheduled O=>T information 12 1 Tag name size 0 to 64

13 64 Tag name Half-width alphanumeric characters

77 1 Reserved

78 2 Data size*1 0 to 1444 [Half of this value] indicates the number of link registers.

80 4 Data offset*1 0 to 16382

This must be an even number. [Half of this value + 1] indicates the register number of the first link register.

T=>O information 84 1 Tag name size 0 to 64

85 64 Tag name Half-width alphanumeric characters

149 1 Reserved

150 2 Data size*1 0 to 1444 [Half of this value] indicates the number of link registers.

152 4 Data offset*1 0 to 16382

This must be an even number. [Half of this value + 1] indicates the register number of the first link register.

156 132 Reserved config info, etc. *1: The data size and the data offset in a scan record must match the ones in an appropriate tag record.

Page 168: EtherNet/IP Interface Module

Appx. 3-6

IM 34M06H36-01E

For 500 bytes Table Appendix 3.6 Overall Structure (For 500 bytes)

Category Item Offset Size Notes

Reserved Reserved 0 24 0 (not configurable) *1

Tag list

Number of registered tags

24

2 0 to 256

Reserved 2 Tag 1

28 44 A record represents a tag.

(From 0 up to 256 records) For details of a tag record, refer to Table Appendix 3.7.

Tag 2 44

... ...

Scan list

Number of scan records

28 + 44 x The number of registered tags

2 0 to 128

Reserved 2

Scan data 0 32 + 44 x The number of registered tags

1184 A record represents a scan data set. (From 0 up to 128 records)

Scan data 1 1184

... ...

*1: This module might return any value other than 0 when you read this area, but it is not failure.

Table Appendix 3.7 Details of a Tag Record (44 Bytes) (For 500 bytes)

Offset Size Item Acceptable

ValueNotes

0 1 Type 1: Scanner 2: Adapter

1 1 Input/Output 0: Output 1: Input

2 2 Tag number 1 to 254 A sequential number is assigned in ascending order for input and output tags, respectively.

4 32 Tag name Half-width alphanumeric characters

Multiple tags cannot have the same name. The maximum length is 32 characters.

36 4 Data offset 0 to 16382

This must be an even number. [Half of this value + 1] indicates the register number of the first link register.

40 2 Data size 0 to 1444 [Half of this value] indicates the number of link registers.

42 2 Instance ID 0: Not specified.1 to 65535

254 and 255 are not acceptable. Multiple tags cannot have the same ID.

Page 169: EtherNet/IP Interface Module

Appx. 3-7

IM 34M06H36-01E

Table Appendix 3.8 Details of a Scan Record (312 Bytes) (For 500 bytes)

Offset Size Item Acceptable Value Notes

0 1 Enabled/Disabled flag0: Disabled 1: Enabled

1 1 Reserved 0 (not configurable) 2 2 Scan number 0 to 127 4 4 IP address 8 2 Reserved 0 (not configurable) 10 2 Vendor identifier 0 to 65535 12 2 Device type 0 to 65535 14 2 Product identifier 0 to 65535 16 1 Major revision 0 to 255 17 1 Minor revision 0 to 255

18 1 Class 1: Class1/3 3: Class3

19 1 Trigger 0: Cyclic 1: Change of State 2: Application

20 2 PIT (in milliseconds) for Change of State

0 to 255

22 1 Time Out Multiplier

0: x 4 (2^2) 1: x 8 (2^3) 2: x 16 (2^4) 3: x 32 (2^5) 4: x 64 (2^6) 5: x 128 (2^7) 6: x 256 (2^8) 7: x 512 (2^9)

23 1 Communication type0: Logical segment 1: Symbolic segment (tag)

24 288 Configuration Path information

When the communication type is 0: The Configuration Path information for the Class1 logical segment type Refer to Table Appendix 3.9. When the communication type is 1: The Configuration Path information for the Class1 symbolic segment type Refer to Table Appendix 3.10.

Page 170: EtherNet/IP Interface Module

Appx. 3-8

IM 34M06H36-01E

Table Appendix 3.9 Configuration Path Information for the Class1 Logical Segment Type (1160 Bytes) (For 500 bytes)

Offset Size Item Acceptable Value Notes

0 2 Configuration Instance

0 to 65535

A value of 65535 indicates that Configuration Path is omitted.

2 2 Reserved O=>T information 4 4 RPI 1,000 to 10,000,000 In microseconds 8 1 Connection type 2: Point-to-Point 9 1 Real time format 2: 32-bit Header 10 1 Priority 2: Scheduled 11 1 Reserved

12 2 Instance for logical segment communication

0 to 65535 A value of 65535 indicates that Consuming I/O Path is omitted.

14 2 Data size*1 0 to 1444

This must be an even number. [Half of this value + 1] indicates the register number of the first link register.

16 4 Data offset*1 0 to 16382 [Half of this value] indicates the number of link registers.

T=>O information 20 4 RPI 1,000 to 10,000,000 In microseconds

24 1 Connection type 1: Multicast 2: Point-to-Point

25 1 Real time format 2: 32-bit Header 26 1 Priority 2: Scheduled 27 1 Reserved

28 2 Instance for logical segment communication

0 to 65535 A value of 65535 indicates that Consuming I/O Path is omitted.

30 2 Data size*1 0 to 1444 [Half of this value] indicates the number of link registers.

32 4 Data offset*1 0 to 16382

This must be an even number. [Half of this value + 1] indicates the register number of the first link register.

36 1124 Reserved config info, etc. *1: The data size and the data offset in a scan record must match the ones in an appropriate tag record.

Page 171: EtherNet/IP Interface Module

Appx. 3-9

IM 34M06H36-01E

Table Appendix 3.10 Configuration Path Information for the Class1 Symbolic Segment Type (1160 Bytes) (For 500 bytes)

Offset Size Item Acceptable Value Notes 0 4 RPI (O=>T) 1,000 to 10,000,000 In microseconds 4 4 RPI (T=>O) 1,000 to 10,000,000 In microseconds

8 1 Connection type 1: Multicast 2: Point-to-Point

9 1 Real time format (O=>T)

2: 32-bit Header

10 1 Real time format (T=>O)

0: Modeless

11 1 Priority 2: Scheduled O=>T information 12 1 Tag name size 0 to 64

13 64 Tag name Half-width alphanumeric characters

77 1 Reserved

78 2 Data size*1 0 to 1444 [Half of this value] indicates the number of link registers.

80 4 Data offset*1 0 to 16382

This must be an even number. [Half of this value + 1] indicates the register number of the first link register.

T=>O information 84 1 Tag name size 0 to 64

85 64 Tag name Half-width alphanumeric characters

149 1 Reserved

150 2 Data size*1 0 to 1444 [Half of this value] indicates the number of link registers.

152 4 Data offset*1 0 to 16382

This must be an even number. [Half of this value + 1] indicates the register number of the first link register.

156 1004 Reserved config info, etc. *1: The data size and the data offset in a scan record must match the ones in an appropriate tag record.

Page 172: EtherNet/IP Interface Module

Blank Page

Page 173: EtherNet/IP Interface Module

Appx. 4-1

IM 34M06H36-01E

Appendix 4. Tips

Appendix 4.1. Frequently Asked Questions

No. Question Answer Reference

1 How to get EDS files from other manufacturer?

Please contact the adapter device manufacturer. -

2 EDS files cannot be registered in the configuration tool.

Please contact us. Note that the configuration tool (R1.01) cannot register an EDS file with a config area size of 65 bytes or more. The configuration tool (R2.01 or later) can register EDS files.

Section 1.5 Section 3.4 Appx.4.8

3 What is the meaning of MajRev and MinRev in EDS file?

They mean revisions of adapter device. - MajRev (Major Revision) Usually increased when incompatible changes are made. - MinRev (Minor Revision) Usually increased when making compatible changes.

-

4 Connection Error. [General:$01, Extended:$0116] A REVISION MISMATCH has occurred.

Normally, the EDS of the adapter device and the MinRev of the actual device do not match.

Appx.4.7

5 How can I change the parameter settings in the config area of the EDS file?

Edit the EDS file directly or use an EDS editing tool such as “EZ-EDS”, a free software provided by ODVA. After editing, re-register the EDS file to the configuration tool.

Appx.1

6 When the configuration tool is connected via the LAN port of this module (scanner), the message displayed. "Connection open failed" or "There was a possibility that a connection error occurred last time. Please wait one minute and connect.” Unable to connect even after retrying.

This may also occur in the following situations where communication retries occur frequently. "Ethernet/IP start request relay is ON" and "The number of unconnected adapters with different IP addresses is 20 or more. Please connect the configuration tool via the LAN/USB port of the CPU module. Alternatively, to reduce the number of unconnected adapters, download the setting that removes or disables unconnected adapters from the scan list.

-

7 When the power is turned off and then on during IO communication, the parameter area error rarely turns on, and the settings need to be re-downloaded. When the power is turned off and on without IO communication, the above problem is not reproduced.

During setting with the tool command (flash memory write), power off may have occurred. Check if the STS LED is blinking (mean flash memory writing) when the power is turned off. If it is blinking, check the user program.

Table2.8 Appx.2

Page 174: EtherNet/IP Interface Module

Appx. 4-2

IM 34M06H36-01E

Appendix 4.2. Assignment of Output Tags to Link Registers

For I/O communication, assigning output tags to a smaller link register area can achieve a faster internal processing. The assignment of input tags does not affect the processing speed.

Example 1

Tag 1: 10 words, W4097 to W4106

Tag 2: 20 words, W4201 to W4221

Example 2

Tag 1: 10 words, W4097 to W4106

Tag 2: 20 words, W4107 to W4126

Example 2 assigns output tags more densely, resulting in a faster processing.

Appendix 4.3. Communication Status Each communication can be monitored for the registration status and connection status by accessing special relays with its scan number. (Refer to section 2.4.)

However, in some error cases, the special relays cannot be updated correctly. For example, when you use tool commands to configure EtherNet/IP settings and eventually an adapter fails to be registered, the failed scan number might not be reflected on the registration status.

To ensure that all desired adapters are connected, in addition to comparing the registration status and connection status of the special relay, also compare the following

- The actual registration status and the registration status of the special relay.

- The actual connection state and the connection state of the special relay.

To ensure that all desired adapters are connected, you should check the connection status against not only the registration status from the special relay but also the registration status that you wanted originally.

If you cannot communicate correctly by using the tool commands, we recommend that you download the settings from the configuration tool and check the reproducibility.

- In case it works correctly when downloaded from the configuration tool.

Check if the EtherNet/IP configuration data exported by the configuration tool is used. Review the user program that uses the tool commands.

- In case it does not work correctly after downloading from the configuration tool.

Check whether the network settings and EtherNet/IP settings are the same as the other device.

Page 175: EtherNet/IP Interface Module

Appx. 4-3

IM 34M06H36-01E

Appendix 4.4. I/O Communication for More Than 1444 Bytes of Data

On this module, a tag cannot transfer more than 1444 bytes of data. To transmit/receive more than 1444 bytes of data to/from a device, you can include two instances of the device in the scan list. By doing so, more than 1444 bytes of data can be transferred in two separate connections.

Note that the simultaneity of two separate data sets is not assured when they are transmitted on separate connections.

Same Addapters(IP address)

Different Tags(Instance ID)

Page 176: EtherNet/IP Interface Module

Appx. 4-4

IM 34M06H36-01E

Appendix 4.5. Resetting the Settings Stored in the Flash Memory to the Factory Default State

You can use the following procedure to reset the settings stored in the flash memory to the factory default state.

Set the IP address setup switches to

“255.255.255.255”.

Turn on the power.

Mount this module.

Procedure to initialize the settings in the

flash memory

Start this module and check that the RDY LED and the red EIP

LED light up.

Turn off the power.

Initialization is completed

Unmount this module.

Set the IP address setup switches to a

value other than “255.255.255.255”.

Page 177: EtherNet/IP Interface Module

Appx. 4-5

IM 34M06H36-01E

Appendix 4.6. Detecting a Failed CPU Module from EtherNet/IP Equipment

When a CPU module fails, the failure sometimes cannot be notified to this module. To enable EtherNet/IP equipment to detect a failed CPU module, periodic handshaking with CPU modules or other mechanisms must be implemented.

Page 178: EtherNet/IP Interface Module

Appx. 4-6

IM 34M06H36-01E

Appendix 4.7. REVISION MISMATCH

If you see a [$C001-$0116 (revision mismatch)] error in the CIP status when connecting to the adapter, you may be able to connect by disabling the minor revision check.

Note For the setting to disable the minor revision check, refer to the column [7.7 ■Disable the Minor Revision Check of the Adapter].

Appendix 4.8. Installing the Configuration Tool

Describes the installation of the Configuration Tool.

The Configuration Tool installer program supports the following setup operations.

Configuration Tool Installer Program

ExistingConfiguration Tool

Installed

New installation of Configuration Tool

Uninstalling Configuration Tool

Installation

Yes

No

Uninstallation

Note The Configuration Tool installer automatically detects whether Configuration Tool is already installed on a PC, and then runs in new installation / uninstallation. To upgrade the Configuration Tool, uninstall the Configuration Tool and then install a new setting tool.

Page 179: EtherNet/IP Interface Module

Appx. 4-7

IM 34M06H36-01E

installation

This section describes how to install Configuration Tool.

Note Exit all other applications before installing the software.

To install Configuration Tool, follow the steps below.

Procedure ◆

① Using Explorer or some other means,

move to the folder where the Setup

program is located, and browse the files

in the folder.

② Select and run [SETUP.EXE]

⇒ The Configuration Tool InstallShield

Wizard runs and displays the Choose

Setup Language dialog box.

③ Select a language and click [Next].

⇒ The Welcome to the InstallShield Wizard

for Configuration Tool dialog box is

displayed.

④ Click [Next].

⇒ The Choose Destination Location dialog

box is displayed.

Page 180: EtherNet/IP Interface Module

Appx. 4-8

IM 34M06H36-01E

⑤ Select the installation destination and

click [Next].

⇒ The Ready to Install the Program dialog

box is displayed.

⑥ Click [Install].

⇒ Installation beings.

⑦ Click [Finish].

Page 181: EtherNet/IP Interface Module

Appx. 4-9

IM 34M06H36-01E

Uninstallation

This section describes how to remove an existing Configuration Tool from a PC.

Note Removing the Configuration Tool does not delete EDS files previously created by a user.

To uninstall Configuration Tool, follow the steps below.

Procedure ◆

① Using Explorer or some other means,

move to the folder where the Setup

program is located, and browse the files

in the folder.

② Select and run [SETUP.EXE]

⇒ The InstallShield Wizard runs and

displays the Confirm Uninstall dialog box

is displayed.

③ Click [OK].

⇒ File deletion beings. The Uninstall

Complete dialog box is displayed when

the program has been removed.

④ Click [Finish].

Note It is also possible to uninstall from the system function on Windows.

For Windows 10, select [FAM3ConfigurationToolEtherNetIP] from the [Apps & features] list in [Windows Settings] and click the [Uninstall] button.

If you are using another OS, check the uninstallation method according to your environment.

Page 182: EtherNet/IP Interface Module

Appx. 4-10

IM 34M06H36-01E

Use an older version of the Configuration Tool

When you install the Configuration Tool (R2.01 or later), the Configuration Tool of the previous version (R1.01) is also installed in the installation folder.

Note The Configuration Tool of the old version (R1.01) is installed in the following folder by default.

[C:\Program Files(x86)\EtherNetIPM3\_R1.01\FAM3ConfigurationToolEtherNetIP.exe]

Check the installation folder according to the environment in which the Configuration Tool is installed.

To start the old version of the Configuration Tool, start the above EXE file directly.

Page 183: EtherNet/IP Interface Module

Rev-1

IM 34M06H36-01E

Revision Information Title : EtherNet/IP Interface Module

Document No. : IM 34M06H36-01E

Aug. 2021 / 3rd Edition

Support for additional functions of REV:01:** or later. Correction of errors.

Aug. 2019 / 2nd Edition

Addition of modules

May. 2018 / 1st Edition

New publication

For Questions and More Information If you have any questions, you can send an E-mail to the following address.

E-mail: [email protected] Written by

Yokogawa Electric Corporation

Published by Yokogawa Electric Corporation

2-9-32 Nakacho, Musashino-shi, Tokyo, 180-8750, JAPAN

Page 184: EtherNet/IP Interface Module

Blank Page