Omron WS02-CPLC1, WS02-CPLC2 User manual

V240-E1-01

CX-Compolet

Application Design Guide for CIP Communications

WS02-CPLC1 WS02-CPLC2

Introduction

Thank you for using CX-Compolet. CX-Compolet Application Design Guide for CIP Communications (hereinafter referred to as this guide) uses CX-Compolet to describe the design procedures and troubleshooting of user applications using CIP communication. Read the manual of the device to be connected in conjunction with this guide.

A sample code is provided for the specific implementation of the guide described in the chapters of this guide. Use the sample code which is included with the installation CD of CX-Compolet Ver. 1.75 or higher.

Intended Audience

This guide is intended for the following personnel,

who must also have knowledge of electrical systems (electrical engineers or the equivalent).

• Personnel in charge of introducing FA systems.

• Personnel in charge of designing FA systems.

• Personnel in charge of installing and maintaining FA systems.

• Personnel in charge of managing FA systems and facilities.

Applicable Products

This guide covers the following products.

・ CX-Compolet

・ WS02-CPLC1

・ WS02-CPLC2

Trademarks

Microsoft and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and other countries.

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

Other company names and product names in this document are the trademarks or registered trademarks of their respective companies.

CX-Compolet Application Design Guide for CIP Communications ............................................... 1

Introduction ......................................................................................................................................... 2

Intended Audience ............................................................................................................................ 2

Applicable Products ........................................................................................................................... 2

Trademarks ....................................................................................................................................... 2

Contents ............................................................................................................................................ 3

Terms and Conditions Agreement .................................................................................................... 5

Precautions for Safe Use .................................................................................................................. 7

Revision History ................................................................................................................................ 8

1. Introduction .................................................................................................................................. 9

2. System Design ........................................................................................................................... 10

2.1. Communication Method Selection Flow .............................................................................. 10

2.2. Checking Specifications of Each Communication Method .................................................. 12

2.2.1. Checking TCP/UDP port to use.................................................................................... 12

2.2.2. Checking tag data link specifications ........................................................................... 12

2.2.3. Checking message communication specifications ....................................................... 13

2.3. Checking Compolet Type ..................................................................................................... 14

3. Application Design .................................................................................................................... 15

3.1. Using Tag Data Link ............................................................................................................ 15

3.1.1. Creation of Compolet instance ..................................................................................... 16

3.1.2. Validation of VariableCompolet .................................................................................... 17

3.1.3. Reading and writing variable values registered in SYSMAC Gateway ........................ 17

3.2. Using Message Communications ........................................................................................ 18

3.2.1. Creation of Compolet instance ..................................................................................... 19

3.2.2. Setting timeout monitoring period ................................................................................ 20

3.2.3. Opening connections .................................................................................................... 21

3.2.4. Performing message communications ......................................................................... 23

4. Startup Phase............................................................................................................................. 25

4.1. Using Tag Data Link ............................................................................................................ 25

4.1.1. Checking connection status ......................................................................................... 26

4.2. Using Message Communications ........................................................................................ 28

4.2.1. Checking communication load of Compolet/SYSMAC Gateway ................................. 28

5. Operation Phase ........................................................................................................................ 29

5.1. Investigation Flow ................................................................................................................ 29

5.1.1. Communications which cannot be performed with the target device ........................... 29

5.1.2. Tag data Link which cannot be established properly ................................................... 32

5.1.3. Not applied data regardless of the established tag data link connection ..................... 33

5.1.4. Disconnection of tag data link ...................................................................................... 35

5.1.5. Error message communication..................................................................................... 37

6. Checking for Errors and Troubleshooting .............................................................................. 39

6.1. Checking Methods of Error .................................................................................................. 39

6.1.1. Confirmation by Windows Event Viewer ...................................................................... 39

6.1.2. Confirmation by the monitor device function of the network configurator (only tag data link) 39

6.2. Checking Details of the Windows Event Log and Troubleshooting ..................................... 40

6.2.1. Error caused by message communication ................................................................... 40

6.2.2. Error occurring in tag data link ..................................................................................... 41

6.3. Checking Events Occurring in SYSMAC Gateway .............................................................. 42

Terms and Conditions Agreement

・ We assume no responsibility for the operation of the user application created using this guide.

・ We shall not be held liable for any damages, such as damages due to any direct, indirect or ripple effects of

the Customer, caused by defects in the user application created using this guide.

1.WARRANTY

(1) The warranty period for the Software is one year from the date of purchase, unless otherwise specifically

agreed.

(2) If the User discovers defect of the Software (substantial non-conformity with the manual), and return it to

OMRON within the above warranty period, OMRON will replace the Software without charge by offering media

or download from OMRON's website. And if the User discovers defect of media which is attributable to

OMRON and return it to OMRON within the above warranty period, OMRON will replace defective media

without charge. If OMRON is unable to replace defective media or correct the Software, the liability of OMRON

and the User's remedy shall be limited to the refund of the license fee paid to OMRON for the Software.

2.LIMITATION OF LIABILITY

(1) THE ABOVE WARRANTY SHALL CONSTITUTE THE USER'S SOLE AND EXCLUSIVE REMEDIES

AGAINST OMRON AND THERE ARE NO OTHER WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING

BUT NOT LIMITED TO, WARRANTY OF MERCHANTABILITY OR FITNESS FOR PARTICULAR PURPOSE.

IN NO EVENT, OMRON WILL BE LIABLE FOR ANY LOST PROFITS OR OTHER INDIRECT, INCIDENTAL,

SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF USE OF THE SOFTWARE.

(2) OMRON SHALL HAVE NO LIABILITY FOR DEFECT OF THE SOFTWARE BASED ON MODIFICATION

OR ALTERNATION TO THE SOFTWARE BY THE USER OR ANY THIRD PARTY. OMRON SHALL NOT

BE RESPONSIBLE AND/OR LIABLE FOR ANY LOSS, DAMAGE, OR EXPENSES DIRECTLY OR

INDIRECTLY RESULTING FROM THE INFECTION OF OMRON PRODUCTS, ANY SOFTWARE

INSTALLED THEREON OR ANY COMPUTER EQUIPMENT, COMPUTER PROGRAMS, NETWORKS,

DATABASES OR OTHER PROPRIETARY MATERIAL CONNECTED THERETO BY DISTRIBUTED DENIAL

OF SERVICE ATTACK, COMPUTER VIRUSES, OTHER TECHNOLOGICALLY HARMFUL MATERIAL

AND/OR UNAUTHORIZED ACCESS.

(3) OMRON SHALL HAVE NO LIABILITY FOR SOFTWARE DEVELOPED BY THE USER OR ANY THIRD

PARTY BASED ON THE SOFTWARE OR ANY CONSEQUENCE THEREOF.

3. APPLICABLE CONDITIONS

USER SHALL NOT USE THE SOFTWARE FOR THE PURPOSE THAT IS NOT PROVIDED IN THE

ATTACHED USER MANUAL.

4. CHANGE IN SPECIFICATION

The software specifications and accessories may be changed at any time based on improvements and other

reasons.

5. ERRORS AND OMISSIONS

The information in this manual has been carefully checked and is believed to be accurate; however, no

responsibility is assumed for clerical, typographical, or proofreading errors, or omissions.

Precautions for Safe Use

Refer to the following manuals for precautions for safe use.

・ Conditions of Use in CX-Compolet Installation Guide and CX-Compolet (with SYSMAC Gateway

Runtime) Installation Guide.

Revision History

Revision Code

Cat.No.V240-E1-01

Revision code

Date

Revised content

February 2020

Original production

A manual revision code appears as a suffix to the document number on the front and back covers of the manual.

1. Introduction

System design

Provide a guide to determine the appropriate CX-Compolet communication method for the configuration of the equipment.

Application design

This section presents guidelines for configuring user applications using tag data links or message communication, based on the points to remember.

Startup Phase

Shows how to check the operation when starting up the equipment.

Operation Phase

This section presents a guide to trouble shooting methods when operating the equipment.

This guide provides a guide for facilitating the development of new designs for CX-Compolet devices.

2. System Design

Tag Data Link

Data communications

START

Communication Data Type?

Read/write DATA with events as triggers

- Write/read the setting parameters

- Read/clear error history and status

Does communication target device support tag data link?

YES

END

Tag variable data exchange at regular intervals

- Interlock between processes

- Issue production orders

- Such as Acquire production data.

YES

Data communicati

ons

by Message

Are the number

of connections of tag data

link and communication

bandwidth within

the specification limits?

The system design describes the selection of the optimum communication method (tag data link or message

communication) for the target device and the limitations of each communication method.

2.1. Communication Method Selection Flow

Select the communication method (tag data link, message communication). Determine the communication method according to the flow chart below.

・ The use of a tag data link is recommended if communication response performance or periodicity is

emphasized, when developing an application to monitor the equipment (line) or to give instructions to the equipment. The tag data link must keep the used communication bandwidth (PPS) within the

specified range. Refer to the user’s manual of the unit and set the settings properly. NJ/NX-series CPU Unit Built-in EtherNet/IP™ Port (Cat. No. W506)

Point

 When constructing the instruction system with the tag data link, design with consideration of the

handshake(5.1.3.3 Application handshakes in user applications

 Even if the system is mainly data reading/writing triggered by an event, when the data capacity

is large or the event occurs frequently, the communication load and the load on the SYSMAC Gateway may increase. In addition, the expected response speed may not be satisfied. Therefore, we recommend designing for the restriction on the use of message communication, using the tag data link function as the basis.

) in the application.

2.2. Checking Specifications of Each Communication Method

Function

Protocol

Port number

Remarks

Tag data link

UDP

2222

Fixed value and

communication

Item

Specifications

Number of connections

Up to 384 (same when multiple ports are used)

Number of registrable tag sets

Number of registrable tags

384

Number of tags per

(7 tags when the tag set includes the Controller status)

Item

Specifications

node

Maximum data size per connection

In this chapter, the requirements for applications should be designed to be implemented within the specifications of each communication method described below.

2.2.1. Checking TCP/UDP port to use

SYSMAC Gateway uses the TCP/UDP port numbers shown in the following table. Do not set the same port number for other applications.

Message

TCP 44818

2.2.2. Checking tag data link specifications

2.2.2.1. Checking number of connections

Check that the maximum value of the following items of the tag data link is not exceeded.

384 (1 connection = 1 tag set)

Up to 8

connection (= 1 tag set)

2.2.2.2. Checking the data size of the connection

unchangeable

Make sure that the data size does not exceed the maximum values of the following items.

Maximum link data size per

Maximum size of 1 tag set 722 words (The Controller status uses 1 word when the tag

*1: To use a data size of 505 bytes or larger, the system must support a large forward open (an optional CIP specification).

The CS, CJ, NJ, NX, and NY-series Units support a large forward open, but before connecting to nodes of other companies, confirm that the devices also support it.

369664 bytes

1444 bytes*1

set includes the Controller status.)

2.2.2.3. Checking the data exchange interval

Item

Specifications

separately for each connection in 1-ms increments)

Allowed communications bandwidth

Item

Specifications

Server: No restriction (depends on the computer memory)

Item

Specifications

Item

Specifications

Number of Open Connection Tasks

Up to 32

Number of Close Connection Tasks

Up to 64

Number of Send Message Tasks

Up to 64

Check the data exchange interval and the communication bandwidth.

Packet interval 1 to 10,000 ms*1 (The packet interval can be set

5000 pps*2 (The heartbeat is included.)

*1: It can be set from 1ms at the shortest, but if the packet interval is short, the timeout is likely to occur depending on the OS state. Normally, use it at least 50 ms.

*2: The pps means “packets per second”, and indicates the number of packets that can be processed per second.

Point

Communication time variations increase as the data length increases or the number of connections increases according to the setting of tag data link. Also, communication time variations occur depending on the type of network card, CPU load, and network load. The extent to which communication performance is achieved is depending on the usage environment. Be sure to measure the performance in the actual environment. Set such as the packet interval, time-out monitoring time to an appropriate value afterward.

2.2.3. Checking message communication specifications

2.2.3.1. Checking number of connections

Ensure that the total number of connections does not exceed the maximum.

Number of connections Client: Maximum connections in total of UCMM and Class

3 = 128

2.2.3.2. Checking data size of connection

Ensure that the data size of the connection does not exceed the maximum.

Data sizes Up to 1988 bytes*1 (Class 3)/496 bytes*1 (UCMM)

*1 These values are the maximum values. The values depend on the data type, variable name, path information, and other factors according to whether connections are used, R/W direction and the like.

2.2.3.3. Checking number of transactions that SYSMAC Gateway can accept simultaneously

Ensure that the number of processes in the user application does not exceed the maximum value.

+ 30 hidden pages