Omron NJ Ethernet Driver Help - kepware-japan.com · OmronNJ EthernetDriverHelp DeviceSetup...

Omron NJ EthernetDriver Help

© 2014 Kepware Technologies

Omron NJ Ethernet Driver Help

Table of ContentsTable of Contents 2Omron NJ Ethernet Driver Help 5Overview 5

Device Setup 6Device ID 6Communications Parameters 6Options 7Communications Routing and Timing 8Connection Path Specification 9Routing Examples 10Optimizing Your Communications 13Optimizing Your Application 14Performance Statistics and Tuning 15

Data Types Description 17Address Descriptions 18Address Formats 19Tag Scope 20Predefined Term Tags 21

Automatic Tag Database Generation 22Tag Hierarchy 22Preparing for Automatic Tag Database Generation 23

Error Descriptions 24Address Validation Error Messages 24Address '<address>' is out of range for the specified device or register 25Array size is out of range for address '<address>' 25Array support is not available for the specified address: '<address>' 25Data Type '<type>' is not valid for device address '<address>' 25Device address '<address>' contains a syntax error 25Device address '<address>' is not supported by model '<model name>' 26Device address '<address>' is Read Only 26Missing address 26Automatic Tag Database Generation Error Messages 26Database Error: Address validation failed for tag '<tag name>' with address '<tag address>'. Tag will notbe added to the database 27Database Error: Data type '<hex value>' for member '<member name>' of complex type '<complex typename>' is not supported. A tag for this member will not be added to the database 27Database Error: Encapsulation error occurred during Fwd. Open request. [Encap. Error=<error>] 27Database Error: Encapsulation error occurred during Register Session request. [Encap. Error=<error>] 27Database Error: Encapsulation error occurred while uploading project information. [Encap.Error=<error>] 28

www. kepware.com

2


Database Error: Error occurred during Fwd. Open request [CIP Error=<code>, Ext. Error=<code>] 28Database Error: Error occurred while uploading project information. [CIP Error=<code>, Ext.Error=<code>] 28Database Error: Framing error occurred during Fwd. Open request 28Database Error: Framing error occurred during Register Session request 29Database Error: Framing error occurred while uploading project information 29Database Error: No more connections available for Fwd. Open request 29Database Error: Unable to resolve CIP data type '<hex value>' for tag '<tag name>'. Tag will not beadded to the database 29Unable to generate a tag database for device <device name>. Reason: Low memory resources 29Communication Error Messages 30Unable to bind to adapter: '<adapter>'. Connect failed 30Winsock initialization failed (OS Error = n) 30Winsock V1.1 or higher must be installed to use the Omron NJ Ethernet device driver 30Device Specific Error Messages 31Device '<device name>' is not responding 31Encapsulation error occurred during a request to device '<device name>'. [Encap. Error=<code>] 31Error occurred during a request to device '<device name>'. [CIP Error=<code>, Ext. Error=<code>] 31Frame received from device '<device name>' contains errors 32Unable to retrieve the Identity for device '<device>'. [CIP Error=<error>, Ext. Error=<error>] 32Unable to retrieve the Identity for device '<device>'. [Encap. Error=<error>] 32Unable to retrieve the Identity for device '<device>'. Frame received contains errors 32Omron NJ Ethernet Specific Error Messages 33Read Errors (Non-Blocking) 33Device '<device name>' returnedmore data than expected while reading tag '<tag address>'. Verify the addressincludesan element offset and all dimensions in that offset 33Read request for tag '<tag address>' on device '<device name>' failed due to a framing error 33Unable to read tag '<tag address>' on device '<device name>'. [CIPError=<code>, Ext. Error=<code>] 34Unable to read tag '<tag address>' on device '<device name>'. Addressexceeds current CIP connection size 34Unable to read tag '<tag address>' on device '<device name>'. Controller Tag data type '<type>' unknown. Tagdeactivated 34Unable to read tag '<tag address>' on device '<device name>'. Data type '<type>' is illegal for this tag 34Unable to read tag '<tag address>' on device '<device name>'. Data type '<type>' not supported. Tag deactivated 35Unable to read tag '<tag address>' on device '<device name>'. Tag doesnot support multi-element arrays. Tagdeactivated 35

Read Errors (Blocking) 35Device '<device name>' returnedmore data than expected while reading '<count>' element(s) starting at '<tagaddress>'. Verify the address includesan element offset and all dimensions in that offset 35Read request for '<count>' element(s) starting at '<tag address>' on device '<device name>' failed due to a framingerror 36Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'. [CIPError=<code>, Ext.Error=<code>] 36Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'. Addressexceeds currentCIP connection size 36

www. kepware.com

3


Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'. Blockdoesnot supportmulti-element arrays. BlockDeactivated 36Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'. Controller Tag data type'<type>' unknown. Blockdeactivated 37Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'. Data type '<type>' is illegalfor this block 37Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'. Data type '<type>' notsupported. Blockdeactivated 37

Write Errors 37Unable to write to '<tag address>' on device '<device name>' 38Unable to write to tag '<tag address>' on device '<device name>'. [CIPError=<code>, Ext. Error=<code>] 38Unable to write to tag '<tag address>' on device '<device name>'. Addressexceeds current CIP connection size 38Unable to write to tag '<tag address>' on device '<device name>'. Controller Tag data type '<type>' unknown 38Unable to write to tag '<tag address>' on device '<device name>'. Data type '<type>' is illegal for this tag 39Unable to write to tag '<tag address>' on device '<device name>'. Data type '<type>' not supported 39Unable to write to tag '<tag address>' on device '<device name>'. Tag doesnot support multi-element arrays 39Write request for tag '<tag address>' on device '<device name>' failed due to a framing error 39

Error Codes 40Encapsulation Error Codes 40CIP Error Codes 400x0001 Extended Error Codes 410x001F Extended Error Codes 410x0020 Extended Error Codes 42

Glossary 43Index 44

www. kepware.com

4


Omron NJ Ethernet Driver HelpHelp version 1.016

CONTENTS

OverviewWhat is the Omron NJ Ethernet Driver?

Device SetupHow do I configure a device for use with this driver?

Optimizing Your CommunicationsHow can I enhance this driver's performance and system communications?

Data Types DescriptionWhat data types does this driver support?

Address DescriptionsHow do I address a data location on an Omron NJ Ethernet device?

Automatic Tag Database GenerationHow can I automatically generate a list of tags within the server that correspond to device-specific data?

Error DescriptionsWhat error messages does the Omron NJ Ethernet Driver produce?

Error CodesWhat are the Omron NJ Ethernet error codes?

GlossaryWhere can I find additional information relating to the Omron NJ Ethernet Driver?

OverviewThe Omron NJ Ethernet Driver provides an easy and reliable way to connect Omron NJ Ethernet controllers toclient applications, including HMI, SCADA, Historian, MES, ERP, and countless custom applications.

www. kepware.com

5


Device SetupSupported ControllersOmron NJ 301Omron NJ 501

Communication ProtocolEtherNet/IP (CIP over Ethernet) using TCP/IP.

Maximum Number of Channels and DevicesThe maximum number of channels supported is 256. The maximum number of devices supported is 1024.

Cable Diagram

Device IDThe Device ID specifies the path to the destination NJ CPU unit.

l The Device ID for a local NJ CPU unit is specified as the IP or hostname of the local CPU unit. It must be avalid dotted-quad IP Address or hostname. For example, "192.168.1.100" or "NJ001".

l The Device ID for a remote NJ CPU unit is specified as the IP or hostname of the local CPU or EtherNet/IPunit plus a CIP Connection Path (also known as Routing Path) to the remote CPU unit. For example,"192.168.1.100\1\#10\2\10.10.110.2".

Note: For information on connection path syntax, refer to Connection Path Specification.

Communications Parameters

www. kepware.com

6


Descriptions of the parameters are as follows:

l TCP/IP Port: This parameter specifies the TCP/IP port number that the device is configured to use. Thedefault setting is 44818.

l Connection Size: This parameter specifies the number of bytes available on the CIP connection for datarequests and responses. The valid range is 500 to 1996 bytes. The default setting is 1996 bytes.

Important: The Connection Size value may also be requested through the System Tag "_CIPConnectionSizeRequested."

l Inactivity Watchdog: This parameter specifies the amount of time a connection can remain idle(without Read/Write transactions) before being closed by the controller. In general, the larger thewatchdog value, the more time it will take for connection resources to be released by the controller andvice versa. The default setting is 32 seconds.

l Array Block Size: This parameter specifies the maximum number of array elements to read in a singletransaction. The value is adjustable and ranges from 30 to 3840 elements. The default setting is 120elements.

Options

www. kepware.com

7


Descriptions of the parameters are as follows:

l Enable Performance Statistics: The Omron NJ Ethernet Driver has the ability to gather communicationstatistics to help determine the driver's performance. When checked, this option will be enabled. Thedriver will then track the number and types of Client/Server Tag updates. On restart of the serverapplication, the results will be displayed in the server's Event Log. The default setting is No.

Note: Once a project configuration is designed for optimal performance, it is recommended that usersdisable Performance Statistics. Furthermore, since the statistics are outputted to the Event Log onshutdown, the server will need to be re-launched to view the results.

l Tag Hierarchy: This parameter specifies the tag hierarchy. Options include Condensed and Expanded.The default setting is Expanded. Descriptions of the options are as follows:

l Condensed Mode: In this mode, the server tags created by automatic tag generation follow agroup/tag hierarchy consistent with the tag's address. Groups are created for every segmentpreceding the period.

l Expanded Mode: In Expanded Mode, tag groups are created for every segment preceding theperiod (as in Condensed Mode), but groups are also created for array tags. This is the defaultsetting.

Note: For more information on the groups that are created, refer to Tag Hierarchy.

Note: To enable this functionality, check Allow Automatically Generated Subgroups in Device Properties.

Communications Routing and TimingRouting provides a way to communicate with a remote NJ CPU via a local NJ EtherNet/IP unit. For more informationon routing, refer to Chapter 8 of Omron's NJ-series CPU Unit Built-in EtherNet/IP Port User's Manual W506.Although the material focuses on NJ to NJ communications, the same concepts apply when the driver iscommunicating with a remote NJ CPU.

Routing TimingWhen communications with a remote CPU are lost, the driver will utilize different request timeout parametersthan configured in the device's timing settings when performing the following:

l Identity requests: Unconnected messages used to determine the remote CPU's model and Firmwareversion.

www. kepware.com

8


l Forward Open requests: Unconnected messages used to establish a high-level CIP connection with theremote CPU.

In these situations, the local device will return CIP Error 0x01 Ext. Err 0x204, which is defined as an"unconnected request timeout" and indicates that the remote CPU could not be reached. These requests willusually occur after a connection has been closed following a read or write request timeout. In this scenario, thedevice may enter an error state quickly following a read or write request timeout but fail tags slowly thereafter asit waits for the unconnected request timeout to occur. Although the driver will wait the entire "unconnectedrequest timeout," it is possible for the local device to respond sooner with this error.

This custom timeout is based on the number of segments in the routing path. Only one attempt is made perrequest. For more information, refer to the table below.

Number ofSegments

Request Timesout(sec) Example

1 15 10.10.110.2\1\02 20 10.10.110.2\1\#10\2\172.16.1.33 25 10.10.110.2\1\#10\2\172.16.1.3\1\04 30 10.10.110.2\1\#10\2\192.168.1.3\1\0\2\172.16.1.45 35 10.10.110.2\1\#10\2\192.168.1.3\1\0\2\172.16.1.4\1\0

Note: The driver will always utilize the device's timing settings when performing reads, writes, and AutomaticTag Generation operations regardless of whether routing to a remote CPU or directly to a local CPU. For moreinformation, refer to "Device Properties - Timing" in the server help documentation.

Connection Path SpecificationThe CIP connection path (more commonly known as the routing path) is specified in the Device ID.Communication originates from the Omron NJ Ethernet Driver on the PC and is directed at the local NJ CPU orEtherNet/IP unit. Once at this local unit, the Device ID specifies a way out of the unit and onto the backplane. Therouting path then directs the message to the desired remote NJ CPU unit.

The routing path itself is a series of Port/Link Address pairs, which are identical to the routing paths described inChapter 8 of Omron's NJ-series CPU Unit Built-in EtherNet/IP Port User's Manual W506. In that document,"Network type number" is synonymous with Port and "Remote address" is synonymous with Link Address. Withinthe routing path, both Ports and Link Addresses are delimited by a backslash (no spaces necessary).

Note: A routing path is not necessary when the destination is the local NJ CPU unit. The Device ID only needs tocontain the IP address of the local CPU unit.

Designator Type Description Formats RangePort (Network typenumber)

Specifies a way out of the interface unit in question.

Backplane (BP) Port: 1EtherNet/IP (EIP) Port: 2

DecimalHex

0-65535#0000-#FFFF

Link Address(Remote address)

Specifies a destination from the Port.

Backplane (BP) Port: Unit Address of the destination unitEtherNet/IP (EIP) Port: IP Address of the remote CPU orEtherNet/IP (EIP) unit

Decimal

Hex

Unit: 0-255IP: Validdotted-quadIP*#00-#FF

*Hostnames are not allowed.

Device ID Syntax containing Routing PathLocal CPU (0 Hops)Local EIP IP \ BP Port \ CPU Unit Address

Remote CPU (1 Hop)Local CPU IP \ BP Port \ EIP Unit Address \ EIP Port \ Remote CPU IP Address or Local CPU IP\ BP Port \ EIP UnitAddress \ EIP Port \ Remote EIP IP Address\ BP Port\ Remote CPU Unit Address

Multi-Hop (N Hops)

www. kepware.com

9


Local CPU IP \ BP Port \ EIP Unit Address \ EIP Port \ Remote CPU IP Address \ BP Port… \ EIP Unit Address \ EIPPort \ Remote CPU IP Address or Local CPU IP \ BP Port \ EIP Unit Address \ EIP Port \ Remote CPU IP Address \ BPPort… \ EIP Unit Address \ EIP Port \ Remote EIP IP Address \ BP Port \ Remote CPU Unit Address

Routing ExamplesThe routing examples below include the entire Device ID.

Local Omron NJ (A): 10.10.110.2\1\0

The breakdown of the 10.10.110.2\1\0 path is as follows:

l 10.10.110.2: IP Address of Device A's EIP unitl \1: Port # of Device A's EIP unit to access Backplanel \0: Unit Address of Device A's CPU unit

Remote Omron NJ (B) via Omron NJ (A): 10.10.110.2\1\#10\2\172.16.1.3

www. kepware.com

10


The breakdown of the 10.10.110.2\1\#10\2\172.16.1.3 path is as follows:

l 10.10.110.2: IP Address of Device A's CPU unitl \1: Port # of Device A's CPU unit to access Backplanel \#10: Unit Address of Device A's EIP unit (10 hex, 16 dec)l \2: Port # of Device A's EIP unit to access EtherNet/IPl \172.16.1.3: IP Address of Device B's CPU unit

Remote Omron NJ (B) via Omron NJ (A): 10.10.110.2\1\#10\2\192.168.1.3\1\0

www. kepware.com

11


The breakdown of the 10.10.110.2\1\#10\2\192.168.1.3\1\0 path is as follows:

l 10.10.110.2: IP Address of Device A's CPU unitl \1: Port # of Device A's CPU unit to access Backplanel \#10: Unit Address of Device A's EIP unit (10 hex, 16 dec)l \2: Port # of Device A C1J-EIP21 unit to access EtherNet/IPl 192.168.1.3: IP Address of Device B's EIP unitl \1: Port # of Device B's EIP unit to access Backplanel \0: Unit Address of Device B's CPU unit

Remote Omron NJ (C) via Omron NJ (A):10.10.110.2\1\#10\2\192.168.1.3\1\0\2\172.16.1.4\1\0

www. kepware.com

12


The breakdown of the 10.10.110.2\1\#10\2\192.168.1.3\1\0\2\172.16.1.4\1\0 path is as follows:

l 10.10.110.2: IP Address of Device A's CPU unitl \1: Port # of Device A's CPU unit to access Backplanel \#10: Unit Address of Device A's EIP unit (10 hex, 16 dec)l \2: Port # of Device A's EIP unit to access EtherNet/IPl \192.168.1.3: IP Address of Device B's EIP unitl \1: Port # of Device B's EIP unit to access Backplanel \0: Unit Address of Device B's CPU unitl \2: Port # of Device B's CPU unit to access EtherNet/IPl \172.16.1.4: IP Address of Device C's EIP unitl \1: Port # of Device C's EIP unit to access Backplanel \0: Unit Address of Device C's CPU unit

Note: For more information, refer to Connection Path Specification. For more information on building aconnection/routing path, refer to Chapter 8 of Omron's NJ-series CPU Unit Built-in EtherNet/IP Port User's ManualW506.

Optimizing Your CommunicationsAs with any programmable controller, there are a variety of ways to enhance the performance and systemcommunications.

Connection SizeIncreasing the Connection Size allows more Read/Write requests per data packet, which provides greaterthroughput. Although it also increases the CPU load and response turnaround time, it significantly improvesperformance. For more information, refer to Communications Parameters.

Multi-Request Packets

www. kepware.com

13


The Omron NJ Ethernet Driver has been designed to optimize reads and writes by including multiple requests ina single transaction. This provides drastic improvement in performance over single tag transactions. The onlylimitation is the number of data bytes that can fit in a single transaction.

Important: Because read and write requests specify variables' addresses in ASCII format, users should keepthe size of the variables' names to a minimum. The smaller the variable name, the more tags that will fit in asingle transaction, and the fewer transactions needed to process all tags.

Blocking Array ElementsTo optimize the reading of basic array elements, read a block of the array in a single request instead ofindividually. The more elements read in a block, the greater the performance. Since transaction overhead andprocessing consumes the most time, do as few transactions as possible while scanning as many desired tags aspossible. This is the essence of array element blocking.

Block sizes are specified as an element count. A block size of 120 elements means that a maximum of 120 arrayelements will be read in one request. The maximum block size of 3840 elements means a maximum of 3840 arrayelements will be read in one request.

As discussed in Communication Parameters, the block size is adjustable and should be chosen based on theproject at hand. For example, if array elements 0 to 26 and element 3839 are tags to be read, then using a blocksize of 3840 is not only overkill, but detrimental to the driver's performance. This is because all elementsbetween 0 and 3839 will be read on each request, even though only 28 of those elements are of importance. Inthis case, a block size of 30 is more appropriate. Elements 0 to 26 would be serviced in one request and element3839 would be serviced on the next.

StringsIt is recommended that string variables be defined with the smallest string length necessary to serve theirpurpose. In Sysmac Studio, string variables are defined with a length of 256 by default. Reading these stringvariables with large string lengths will incur extra device communications and may affect performance.

Optimizing Your ApplicationThe Omron NJ Ethernet Driver has been designed to provide the best performance with the least amount ofimpact on the system's overall performance. While the Omron NJ Ethernet Driver is fast, there are a couple ofguidelines that can be used in order to optimize the application and gain maximum performance.

The server refers to communications protocols like Omron NJ Ethernet as a channel. Each channel defined in theapplication represents a separate path of execution in the server. Once a channel has been defined, a series ofdevices must then be defined under that channel. Each of these devices represents a single Omron NJ CPU fromwhich data will be collected. While this approach to defining the application will provide a high level ofperformance, it won't take full advantage of the Omron NJ Ethernet Driver or the network. An example of how theapplication may appear when configured using a single channel is shown below.

Each device appears under a singlechannel, called "Channel1". In thisconfiguration, the driver must movefrom one device to the next as quicklyas possible in order to gatherinformation at an effective rate. As moredevices are added or more informationis requested from a single device, theoverall update rate begins to suffer.

www. kepware.com

14


If the Omron NJ Ethernet Driver could only define one channel, then all devices needed for the project would haveto be created beneath it; however, the Omron NJ Ethernet Driver can define up to 256 channels. Using multiplechannels distributes the data collection workload by simultaneously issuing multiple requests to the network. Anexample of how the same application may appear when configured using multiple channels to improveperformance is shown below.

Each device has now been definedunder its own channel. In this newconfiguration, a single path ofexecution is dedicated to the task ofgathering data from each device. Ifthe application has 256 or fewerdevices, it can be optimized exactlyhow it is shown here.

The performance will improve even ifthe application has more than 256devices. While 256 or fewer devicesmay be ideal, the application will stillbenefit from additional channels.Although by spreading the deviceload across all channels will cause theserver to move from device to deviceagain, it can now do so with far lessdevices to process on a singlechannel.

Performance Statistics and TuningThe Performance Statistics feature provides benchmarks and statistics about the Omron NJ Ethernet application'sperformance. It can affect the server's performance because it is an additional layer of processing. As such, it isdisabled by default. To enable the Performance Statistics feature, open Device Properties and select theOptions tab. In Enable Performance Statistics, select Yes.

Types of Performance StatisticsPerformance Statistics provide meaningful numerical results across three scopes: device, channel, and driver.Descriptions of the types are as follows:

l Device: These statistics provide the data access performance on a particular device.l Channel: These statistics provide the average data access performance for all the devices under a givenchannel with Performance Statistics enabled.

l Driver: These statistics provide the average data access performance for all devices using the Omron NJEthernet Driver with Performance Statistics enabled.

Choosing a Statistic TypeThe type of statistics needed depends on the application. In general, driver statistics provide a true measure ofthe application's performance, whereas channel and device statistics are most relevant while tuning theapplication. For example, will moving 10 certain tags from Device A to Device B increase the performance ofDevice A? Will moving Device A from Channel 1 to Channel 2 increase the performance of Channel 1? Thesequestions are good examples of situations when device and channel statistics should be used.

Locating StatisticsServer statistics are outputted to the server's Event Log upon shutdown. To view the results, shut down theserver and then restart it.

Differences between Server Statistics and Performance StatisticsPerformance Statistics provide the makeup of the types of reads performed (such as device reads vs. cachereads) whereas server statistics provide a general read count value.

Tuning the Application for Increased PerformanceTo increase device and channel statistic results, keep variable names to a minimum length and use VariableArrays as often as possible. For more information, refer toOptimizing Your Communications.

www. kepware.com

15


For information on increasing driver statistic results, refer to the instructions below. For more information, refertoOptimizing Your Application.

1. Devices should be spread across channels. More than one device should not be put on a channel unlessnecessary.

2. Load should be spread evenly across devices. A single device should not be overloaded unless necessary.

3. The same Variable Tag should not be referenced across different devices.

www. kepware.com

16


Data Types Description

Data Type DescriptionBoolean Single bitByte Unsigned 8 bit valueChar Signed 8 bit valueWord Unsigned 16 bit value

bit 0 is the low bitbit 15 is the high bit

Short Signed 16 bit value

bit 0 is the low bitbit 14 is the high bitbit 15 is the sign bit

Long Signed 32 bit valueDWord Unsigned 32 bit valueFloat 32 bit IEEE floating pointDouble 64 bit IEEE floating pointString Null terminated ASCII stringDefault *

*If the data type is specified as "Default" when creating a Static Tag, the driver will query the controller for thetag's data type and then set the canonical data type for items referencing that Static Tag to the query result. If adata type is not specified when creating a Dynamic Tag, the driver will query the controller for the tag's data typeand then set the canonical data type for that Dynamic Tag to the query result.

www. kepware.com

17


Address DescriptionsThe Omron NJ Ethernet Driver uses a tag or symbol-based addressing structure referred to as variables. Thesetags differ from conventional PLC data items in that the tag name itself is the address, not a file or registernumber. Users can access the controller's basic data types. Although some of the system-defined types arestructures, they are ultimately based on these basic data types. Thus, all basic members of a structure areaccessible.

Omron Data Type Description Data Type RangeBOOL Single bit value Boolean 0, 1SINT Signed 8 bit value Char -128 to 127USINT Unsigned 8 bit value Byte 0 to 255BYTE Bit string (8 bits) Byte 0 to 255INT Signed 16 bit value Short -32768 to 32767UINT Unsigned 16 bit value Word 0 to 65535WORD Bit string (16 bits) Word 0 to 65535DINT Signed 32 bit value Long -2147483648 to 2147483647UDINT Unsigned 32 bit value DWord 0 to 4294967295DWORD Bit string (32 bits) DWord 0 to 4294967295LINT Signed 64 bit value Double -9223372036854775808 to

9223372036854775807ULINT Unsigned 64 bit value Double 0 to 18446744073709551615REAL 32 bit IEEE floating

pointFloat -3.402823e+38 to -1.175495e-38

01.175495e-38 to 3.402823e+38

LREAL 64 bit IEEE floatingpoint

Double -1.79769313486231e+308 to -2.22507385850721e-30802.22507385850721e-308 to1.79769313486231e+308

STRING Character string String String lengths range from 1 to 1985characters. This equates to variables defined inSysmac Studio as STRING[2] and STRING[1986] respectively. The extra characteraccounts for the null terminator.

Enumeration Signed 32 bit value Long -2147483648 to 2147483647*

*The valid values for an enumeration are actually a subset of the values in the specified range. The subset ofvalues is determined by the configuration of the enumeration in the Omron NJ device.

Client/Server Tag Address RulesVariable names correspond to Client/Server Tag addresses. Both variable names and Client/Server Tagaddresses follow the IEC 61131-3 identifier rules. Descriptions of the rules are as follows:

l Can only contain alphanumeric characters and underscoresl Can have as many as 127 characters per segmentl Characters are not case sensitivel White spaces are ignored

Client/Server Tag Name RulesTag name assignment in the server differs from address assignment in that names cannot begin with anunderscore. For syntax and examples, refer to Address Formats.

Important: If a tag address is large enough that it exceeds the protocol limit of 511 bytes, it will fail validationwith an "Address out of range" error. If this occurs, reduce the number of characters in the tag address until itpasses validation.

Data Type CoercionThe Omron NJ Ethernet Driver can coerce some Omron data types in the controller to more than one server datatype. For example, the tag for a SINT variable in the controller can be created with a Byte server data type. For alist of the supported data type coercions for all Omron data types that are supported by the driver, refer to thetable below.

www. kepware.com

18


Omron Data Type Data TypeBOOL BooleanSINT, USINT, OR BYTE Char or ByteINT, UINT, ORWORD Short or WordDINT, UDINT, DWORD, OR ENUM Long or DWordLINT OR ULINT DoubleREAL FloatLREAL DoubleSTRING String

Address FormatsA Variable Tag may be addressed statically in the server or dynamically from a client in several ways. The tag'sformat will depend on its type and intended usage. Descriptions of the variable types are as follows:

l Array Element: A variable may be defined in the controller using the following syntax: ARRAY [x1..x2,y1..y2, z1..z2] OF TYPE, where TYPE is one of the Omron data types listed in Address Descriptions. Toaccess individual elements, specify the x, y, and z offsets. The driver blocks read requests on the lastdimension. For example, with a variable like "MyArray[1,0]" and "MyArray[1,4]," the driver will perform asingle request for five elements starting at "MyArray[1,0]." For more information, refer toCommunication Parameters and Optimizing Your Communications.

l Array: A variable may be defined in the controller using the following syntax: ARRAY [x1..x2, y1..y2,z1..z2] OF TYPE, where TYPE is one of the Omron data types listed in Address Descriptions. To accessmultiple elements in a single client item, use the array type syntax. Like Array Elements, the driver willperform a single request to read and write multiple array elements. The difference with arrays is that allitems in the array will be provided to the client in an atomic operation. String Arrays are not supported.

Note: Not all clients support array types. For support information, refer to the client application.l Basic: A variable defined with a basic type and no array syntax.l String: A variable defined with the string basic type.

Note: All Symbolic Variable Tag names in Sysmac Studio can be copied and pasted into the server's tag addressfield and be valid.

Array ElementAt least one dimension (but no more than three) must be specified.

Syntax Example<Variable Tag name> [dim1] tag_1 [5]<Variable Tag name> [dim 1, dim2] tag_1 [2, 3]<Variable Tag name> [dim 1, dim2, dim 3] tag_1 [2, 58, 547]

ExamplesMyBooleanArray[31]MyBooleanArray3D[2,2,7]MySintArray[1]MyLrealArray[65535]MySintArray2D[1,2]MyLrealArray2D[2,500]MySintArray3D[2,3,9]MyLrealArray3D[2,10,10]

ArrayWith this format, multiple elements of a Variable Array are read and written in a single transaction. The clientmust support array types (such as "VT_ARRAY"). Client data is organized in a row by column format to facilitateone dimension (1 row, y columns) or two dimensions (x rows, y columns). This format is supported for one-dimensional, two-dimensional, and three-dimensional Variable Arrays only. Like Array Elements, at least onedimension (but no more than three) must be specified.

Note: All Omron data types that are supported by this driver support the array format except string.

Important: Spanning an array across multiple Variable Array dimensions is not supported. If an array is createdon a two-dimensional or three-dimensional Variable Array, the size of that array (which is rows by columns) must

www. kepware.com

19


not exceed the bounds of the last dimension. For example, given a Variable Array "MySintArray3D" defined asARRAY[0..2,0..3,0..9] OF SINT, the Array Tag MySintArray3D[0,0,0]{10} is valid because it references elements[0,0,0..9] that all lie within the last dimension. MySintArray3D[0,0,0]{11} is invalid, however, because it isattempting to reference elements [0,0,0..9] and [0,1,0] that exceed the bounds of the last dimension by oneelement.

Syntax Example<Variable Tag name> [dim 1 offset] {# of columns} tag_1 [5]{8}<Variable Tag name> [dim 1 offset, dim 2 offset] {# of columns} tag_2 [0, 5]{8}<Variable Tag name> [dim 1 offset, dim 2 offset, dim 3 offset] {# of columns} tag_3 [1,0, 5]{8}<Variable Tag name> [dim 1 offset] {# of rows}{# of columns} tag_4 [5]{2}{4}<Variable Tag name> [dim 1 offset, dim 2 offset] {# of rows}{# of columns} tag_1 [0,5]{2}{4}<Variable Tag name> [dim 1 offset, dim 2 offset, dim 3 offset] {# of rows}{# ofcolumns}

tag_1 [1,0,5]{2}{4}

Note: The number of elements to read and/or write equals the number of rows multiplied by the number ofcolumns. If no rows are specified, the number of rows will default to 1. At least one element of the array must beaddressed. Rows x Columns must be between 1 and 65535.

ExamplesMyBooleanArray[0]{32}MyBooleanArray3D[2,2,7]{1}MySintArray[1]{5}MyLrealArray[65535]{1}MySintArray2D[1,2]{10}MyLrealArray2D[2,500]{14}{20}MySintArray3D[2,3,9]{10}MyLrealArray3D[2,10,10]{14}{20}

BasicSyntax Example<Variable Tag name> tag_1

ExamplesMyBoolMyByteMyIntMyWordMyReal

StringThe number of characters to read and/or write equals the string length, which must be at least 2. AlthoughSysmac Studio allows a variable to be defined as STRING [1], reads and writes will not be possible because onecharacter is reserved for a null terminator. As such, it is recommended that string variables be defined with alength of 2 to 1986. To account for this null terminator, the valid range for string lengths in the driver is 1 to1985.

Syntax Example<Variable Tag name> / <string length> tag_1 / 255

ExamplesMyString256/255MyString986/1985MyString1986/100MyStruct[23].Banners[4].Output/10MyStringArray3D[2,10,10]/255

Tag ScopeNote: Local variables can only be read and written in a POU (program, function, or function block) in which it isdefined.

Global Tags

www. kepware.com

20


Global Tags are Variable Tags that have global scope in the controller. Any program or task can access GlobalTags; however, the number of ways a Global Tag can be referenced depends on both its Variable Data Type andthe address format being used.

Structure Tag AddressingStructure Tags are tags with one or more member tags, which can be basic or structured in nature.

<structure name> . <basic-type tag>

This implies that a substructure would be addressed as:

<structure name> . <substructure name> .<basic-type tag>

Arrays of structures would be addressed as follows:

<structure array name> [dim1, dim2, dim3] . <basic-type tag>

Again, this implies that an array of substructures would be addressed as:

<structure name> . <substructure array name> [dim1, dim2, dim3] . <basic-type tag>

Note: The examples given above are only a few of the many addressing possibilities involving structures. Theyare displayed in order to provide an introduction to structure addressing. For more information, refer to OmronNJ documentation.

Predefined Term TagsThe tags displayed in the table below can be used to obtain general processor information from a PLC.

Tag Name Data Type Description#DEVICETYPE Word An integer value that corresponds to the "ProdType" attribute specified in

the PLC's EDS file.#REVISION String Firmware revision displayed as <major>.<minor>.#PRODUCTNAME String The processor name that corresponds to the "ProdName" attribute

specified in the PLC's EDS file.#PRODUCTCODE Word An integer value that corresponds to the "ProdCode" attribute specified in

the PLC's EDS file.#VENDORID Word An integer value that corresponds to the "VendCode" attribute specified in

the PLC's EDS file.

www. kepware.com

21


Automatic Tag Database GenerationThe Omron NJ Ethernet Driver can be configured to automatically generate a list of tags within the server thatcorrespond to the Global Variables used in the Omron SYSMAC NJ Series controller program and that arepublished to the network as inputs, outputs, or publish-only variables.

Note: Variable Tags generated for enumerations will have a data type of Long.

See Also: Address Formats and Address Descriptions.

Tag HierarchyThe server tags created by automatic tag generation can follow one of two hierarchies: Expanded or Condensed.To enable this functionality, ensure that "Allow Automatically Generated Subgroups" is enabled in DeviceProperties. The default setting is Expanded Mode.

Expanded ModeIn Expanded Mode, tag groups are created for every segment preceding the period (as in Condensed Mode), butare also created in logical groupings. Groups created include the following:

l Structures and substructuresl Unionsl Arrays

Basic Global tags (or non-structure, non-union, and non-array tags) are placed at the device level. Eachstructure, union, and array tag is provided in its own subgroup of the parent group.

The name of the structure, union, or array subgroup also provides a description of the structure, union, or array.For example, an array tag1[1,6] defined in the controller would have a subgroup name of "tag1[x,y]" where xsignifies dimension 1 exists and y signifies dimension 2 exists. The tags within an array subgroup are all theelements of that array. The tags within a structure subgroup are the structure members themselves. If astructure contains an array, then an array subgroup of the structure group will be created as well. The tagswithin a union subgroup are the union members themselves. If a union contains an array, then an arraysubgroup of the union group will be created as well.

Array Tag GroupsA group is created for each array that contains array elements. Group names will have the notation: <arrayname>[x,y,z] where:

l [x,y,z] is a 3 dimensional arrayl [x,y] is a 2 dimensional arrayl [x] is a 1 dimensional array

Array Tags will have the notation: <tag element>[XXXXX,YYYYY,ZZZZZ]. For example, element tag1[12,2,987]would have the tag name "tag1[12,2,987]".

Condensed ModeIn Condensed Mode, the server tags created by automatic tag generation follow a group/tag hierarchy consistentwith the tag's address. Groups are created for every segment preceding the period. Groups created include thefollowing:

l Structures and substructuresl Unions

Note: Groups are not created for arrays.

www. kepware.com

22


Preparing for Automatic Tag Database GenerationFor information on using automatic tag database generation, follow the instructions below.

Note: It is recommended that all communications to the Omron NJ CPU of interest cease during the databasecreation process.

1. In the server, open theDevice Properties of the device for which tags will be generated.

2. Select the Database Creation tab and utilize as instructed in the server help file.

www. kepware.com

23


Error DescriptionsThe following error/warning messages may be generated. Click on the link for a description of the message.

Address Validation Error MessagesAddress '<address>' is out of range for the specified device or registerArray size is out of range for address '<address>'Array support is not available for the specified address: '<address>'Data Type '<type>' is not valid for device address '<address>'Device address '<address>' contains a syntax errorDevice address '<address>' is not supported by model '<model name>'Device address '<address>' is Read OnlyMissing address

Automatic Tag Database Generation Error MessagesDatabase Error: Address validation failed for tag '<tag name>' with address '<tag address>'. Tagwill not be added to the databaseDatabase Error: Data type '<hex value>' for member '<member name>' of complex type '<complextype name>' is not supported. A tag for this member will not be added to the databaseDatabase Error: Encapsulation error occurred during Fwd. Open request. [Encap. Error=<error>]Database Error: Encapsulation error occurred during Register Session request. [Encap.Error=<error>]Database Error: Encapsulation error occurred while uploading project information. [Encap.Error=<error>]Database Error: Error occurred during Fwd. Open request [CIP Error=<code>, Ext. Error=<code>]Database Error: Error occurred while uploading project information. [CIP Error=<code>, Ext.Error=<code>]Database Error: Framing error occurred during Fwd. Open requestDatabase Error: Framing error occurred during Register Session requestDatabase Error: Framing error occurred while uploading project informationDatabase Error: No more connections available for Fwd. Open requestDatabase Error: Unable to resolve CIP data type '<hex value>' for tag '<tag name>'. Tag will notbe added to the databaseUnable to generate a tag database for device <device name>. Reason: Low memory resources

Communication ErrorsUnable to bind to adapter: '<adapter>'. Connect failedWinsock initialization failed (OS Error = n)Winsock V1.1 or higher must be installed to use the Omron NJ Ethernet device driver

Device Specific Error MessagesDevice '<device name>' is not respondingEncapsulation error occurred during a request to device '<device name>'. [Encap. Error=<code>]Error occurred during a request to device '<device name>'. [CIP Error=<code>, Ext. Error=<code>]Frame received from device '<device name>' contains errorsUnable to retrieve the Identity for device '<device>'. [CIP Error=<error>, Ext. Error=<error>]Unable to retrieve the Identity for device '<device>'. [Encap. Error=<error>]Unable to retrieve the Identity for device '<device>'. Frame received contains errors

Omron NJ Ethernet Specific Error MessagesRead Errors (Non-Blocking)Read Errors (Blocking)Write Errors

Address Validation Error MessagesThe following error/warning messages may be generated. Click on the link for a description of the message.

Address ValidationAddress '<address>' is out of range for the specified device or registerArray size is out of range for address '<address>'Array support is not available for the specified address: '<address>'Data Type '<type>' is not valid for device address '<address>'

www. kepware.com

24


Device address '<address>' contains a syntax errorDevice address '<address>' is not supported by model '<model name>'Device address '<address>' is Read OnlyMissing address

Address '<address>' is out of range for the specified device or registerError Type:Warning

Possible Cause:1. A tag address that has been specified statically references a location that is beyond the range of supportedlocations for the device.2. The tag address size exceeds the protocol limits.

Solution:1. Verify the address is correct; if it is not, re-enter it in the client application.2. Reduce the number of characters in the tag name. If the error persists, reduce the number of characters in thestructure or union (including any nested structures or unions) under which the tag is located.

Array size is out of range for address '<address>'Error Type:Warning

Possible Cause:A tag address that has been specified statically is requesting an array size that is too large for the address type orblock size of the driver.

Solution:Re-enter the address in the client application to specify a smaller value for the array or a different starting point.

Array support is not available for the specified address: '<address>'Error Type:Warning

Possible Cause:A tag address that has been specified statically contains an array reference for an address type that doesn'tsupport arrays.

Solution:Re-enter the address in the client application to remove the array reference or correct the address type.

Data Type '<type>' is not valid for device address '<address>'Error Type:Warning

Possible Cause:A tag address that has been specified statically has been assigned an invalid data type.

Solution:Modify the requested data type in the client application.

Device address '<address>' contains a syntax errorError Type:Warning

Possible Cause:A tag address that has been specified statically contains one or more invalid characters.

Solution:Re-enter the address in the client application.

www. kepware.com

25


Device address '<address>' is not supported by model '<model name>'Error Type:Warning

Possible Cause:A tag address that has been specified statically references a location that is valid for the communications protocolbut not supported by the target device.

Solution:Verify the address is correct; if it is not, re-enter it in the client application. Also verify that the selected modelname for the device is correct.

Device address '<address>' is Read OnlyError Type:Warning

Possible Cause:A tag address that has been specified statically has a requested access mode that is not compatible with what thedevice supports for that address.

Solution:Change the access mode in the client application.

Missing addressError Type:Warning

Possible Cause:A tag address that has been specified statically has no length.

Solution:Re-enter the address in the client application.

Automatic Tag Database Generation Error MessagesThe following is a list of sub type error topics. Click on a link for more information about that specific errormessage.

Automatic Tag Database Generation Error MessagesDatabase Error: Address validation failed for tag '<tag name>' with address '<tag address>'. Tagwill not be added to the databaseDatabase Error: Data type '<hex value>' for member '<member name>' of complex type '<complextype name>' is not supported. A tag for this member will not be added to the databaseDatabase Error: Encapsulation error occurred during Fwd. Open request. [Encap. Error=<error>]Database Error: Encapsulation error occurred during Register Session request. [Encap.Error=<error>]Database Error: Encapsulation error occurred while uploading project information. [Encap.Error=<error>]Database Error: Error occurred during Fwd. Open request [CIP Error=<code>, Ext. Error=<code>]Database Error: Error occurred while uploading project information. [CIP Error=<code>, Ext.Error=<code>]Database Error: Framing error occurred during Fwd. Open requestDatabase Error: Framing error occurred during Register Session requestDatabase Error: Framing error occurred while uploading project informationDatabase Error: No more connections available for Fwd. Open requestDatabase Error: Unable to resolve CIP data type '<hex value>' for tag '<tag name>'. Tag will notbe added to the databaseUnable to generate a tag database for device <device name>. Reason: Low memory resources

www. kepware.com

26


Database Error: Address validation failed for tag '<tag name>' with address'<tag address>'. Tag will not be added to the databaseError Type:Warning

Possible Cause:The tag address size exceeds the protocol limits.

Solution:Reduce the number of characters in the tag name. If the error persists, reduce the number of characters in thestructure or union (including any nested structures or unions) under which the tag is located.

Database Error: Data type '<hex value>' for member '<member name>' ofcomplex type '<complex type name>' is not supported. A tag for this memberwill not be added to the databaseError Type:Warning

Possible Cause:The device's configuration of the complex type's member uses an unsupported data type.

Solution:Modify the device's configuration of the complex type's member to use a supported data type.

See Also:Address Descriptions

Database Error: Encapsulation error occurred during Fwd. Open request.[Encap. Error=<error>]Error Type:Error

Possible Cause:The device returned an error within the encapsulation portion of the EtherNet/IP packet during an automatic taggeneration request.

Solution:The driver will attempt to recover from this error. If the problem persists, contact Technical Support.

Note:This excludes error 0x02, which is device-related and not driver-related.

See Also:Encapsulation Error Codes

Database Error: Encapsulation error occurred during Register Session request.[Encap. Error=<error>]Error Type:Error




www. kepware.com

27



Database Error: Encapsulation error occurred while uploading projectinformation. [Encap. Error=<error>]Error Type:Error





Database Error: Error occurred during Fwd. Open request [CIP Error=<code>,Ext. Error=<code>]Error Type:Error

Possible Cause:The device returned an error within the CIP portion of the EtherNet/IP packet during an automatic tag generationrequest.

Solution:The solution depends on the error code(s) returned.

See Also:CIP Error Codes

Database Error: Error occurred while uploading project information. [CIPError=<code>, Ext. Error=<code>]Error Type:Error

Possible Cause:The device returned an error within the CIP portion of the EtherNet/IP packet during an automatic tag generationrequest.



Database Error: Framing error occurred during Fwd. Open requestError Type:Error

Possible Cause:1. The packets are misaligned due to the connection and/or disconnection between the PC and device.2. There is bad cabling connecting the device that is causing noise.

www. kepware.com

28


Solution:1. Place the device on less noisy network.2. Increase the Request Timeout and/or Request Attempts.

Database Error: Framing error occurred during Register Session requestError Type:Error



Database Error: Framing error occurred while uploading project informationError Type:Error



Database Error: No more connections available for Fwd. Open requestError Type:Error

Possible Cause:Omron devices support a finite number of connections. The connection limit has been exceeded.

Solution:Reduce the number of connections from the server(s) to the device and try again.

Database Error: Unable to resolve CIP data type '<hex value>' for tag '<tagname>'. Tag will not be added to the databaseError Type:Warning

Possible Cause:1. A communications error occurred during automatic tag database generation that was caused by EthernetEncapsulation, the device, or framing.2. The CIP data type is not supported by the driver.

Solution:1. Correct the communications error and then retry automatic tag database generation.2. Change the Variable Data Type to one that is supported.

See Also:Preparing for Automatic Tag Database Generation

Unable to generate a tag database for device <device name>. Reason: Lowmemory resourcesError Type:Warning

www. kepware.com

29


Possible Cause:Memory required for database generation could not be allocated. The process is aborted.

Solution:Close any unused applications and/or increase the amount of virtual memory. Then, try again.

Communication Error MessagesThe following is a list of sub type error topics. Click on a link for more information about that specific errormessage.

Communication Error MessagesUnable to bind to adapter: '<adapter>'. Connect failedWinsock initialization failed (OS Error = n)Winsock V1.1 or higher must be installed to use the Omron NJ Ethernet device driver

Unable to bind to adapter: '<adapter>'. Connect failedError Type:Error

Possible Cause:The driver was unable to bind to the specified network adapter, which is necessary for communications with thedevice.

Reasons:1. The adapter is disabled or no longer exists.2. A network system failure occurred (such as Winsock or network adapter failure).3. There are no more available ports.

Solution:1. For network adapters available on the system, check the Network Adapter list in the communications serverapplication (located in Channel Properties). If the specified adapter is not in this list, steps should be taken tomake it available to the system. This includes verifying that the network connection is enabled and connected inthe PC's Network Connections.2. Determine how many channels are using the same adapter in the communications server application. Then,reduce this number so that only one channel is referencing the adapter. If the error still occurs, check to see ifother applications are using that adapter and then shut down those applications.

Winsock initialization failed (OS Error = n)Error Type:Error

OS Error: Indication Possible Solution10091 The underlying network subsystem is not

ready for network communication.Wait a few seconds and restartthe driver.

10067 The limit on the number of taskssupported by the Windows Socketsimplementation has been reached.

Close one or more applicationsthat may be using Winsock andrestart the driver.

Winsock V1.1 or higher must be installed to use the Omron NJ Ethernet devicedriverError Type:Error

Possible Cause:The version number of the Winsock DLL found on the system is less than 1.1.

Solution:Upgrade Winsock to version 1.1 or higher.

www. kepware.com

30


Device Specific Error MessagesThe following is a list of device specific error topics. Click on a link for more information about that specific errormessage.

Device Specific Error MessagesDevice '<device name>' is not respondingEncapsulation error occurred during a request to device '<device name>'. [Encap. Error=<code>]Error occurred during a request to device '<device name>'. [CIP Error=<code>, Ext. Error=<code>]Frame received from device '<device name>' contains errorsUnable to retrieve the Identity for device '<device>'. [CIP Error=<error>, Ext. Error=<error>]Unable to retrieve the Identity for device '<device>'. [Encap. Error=<error>]Unable to retrieve the Identity for device '<device>'. Frame received contains errors

Device '<device name>' is not respondingError Type:Warning

Possible Cause:1. The Ethernet connection between the device and the Host PC is broken.2. The communications parameters for the Ethernet connection are incorrect.3. The named device may have been assigned an incorrect IP address.4. The response from the device took longer to receive than the amount of time specified in the "Request Timeout"device setting.

Solution:1. Verify the cabling between the PC and the device.2. Verify that the correct port is specified for the named device.3. Verify that the IP address given to the named device matches that of the actual device.4. Increase the Request Timeout setting so that the entire response can be handled.

Encapsulation error occurred during a request to device '<device name>'.[Encap. Error=<code>]Error Type:Warning

Possible Cause:The device returned an error within the encapsulation portion of the EtherNet/IP packet during a request. Allreads and writes within the request failed.

Solution:The driver will attempt to recover from such an error. If the problem persists, contact Technical Support. Thisexcludes error 0x02, which is device-related, not driver-related.


Error occurred during a request to device '<device name>'. [CIPError=<code>, Ext. Error=<code>]Error Type:Warning

Possible Cause:The device returned an error within the CIP portion of the EtherNet/IP packet during a request. All reads andwrites within the request failed.



www. kepware.com

31


Frame received from device '<device name>' contains errorsError Type:Warning

Possible Cause:1. The packets are misaligned due to connection and/or disconnection between the PC and device.2. There is bad cabling connecting the device that is causing noise.

Solution:1. Place the device on less noisy network.2. Increase the Request Timeout and/or Attempts.

Unable to retrieve the Identity for device '<device>'. [CIP Error=<error>, Ext.Error=<error>]Error Type:Warning

Possible Cause:The Identity was unable to be retrieved because the device returned an error within the CIP portion of theEtherNet/IP packet during a request.

Solution:The solution depends on the error code that is returned. If the problem persists, contact Technical Support.


Unable to retrieve the Identity for device '<device>'. [Encap. Error=<error>]Error Type:Warning

Possible Cause:The Identity was unable to be retrieved because the device returned an error within the encapsulation portion ofthe EtherNet/IP packet during a request.

Solution:The driver will attempt to recover from such an error. If the problem persists, contact Technical Support. Thisexcludes error 0x02, which is device-related, not driver-related.


Unable to retrieve the Identity for device '<device>'. Frame received containserrorsError Type:Warning

Possible Cause:1. The packets are misaligned due to connection and/or disconnection between the PC and device.2. There is bad cabling connecting the devices that is causing noise.3. The wrong frame size was received.4. There is a TNS mismatch.5. An invalid response command was returned from the device.6. The device is not EtherNet/IP enabled.

Solution:1. The driver will recover from this error without intervention. If this error occurs frequently, there may be anissue with the cabling, the network, or the device itself.

www. kepware.com

32


2. Verify that the device being communicated with is a Omron EtherNet/IP-enabled device.

Omron NJ Ethernet Specific Error MessagesThe following sections pertain to messaging from the Omron NJ Ethernet driver-level source.

Omron NJ Ethernet Specific Error MessagesRead Errors (Non-Blocking)Read Errors (Blocking)Write Errors

Read Errors (Non-Blocking)The following error/warning messages may be generated. Click on the link for a description of the message.

Read Errors (Non-Blocking)Device '<device name>' returned more data than expected while reading tag '<tag address>'.Verify the address includes an element offset and all dimensions in that offsetRead request for tag '<tag address>' on device '<device name>' failed due to a framing errorUnable to read tag '<tag address>' on device '<device name>'. [CIP Error=<code>, Ext.Error=<code>]Unable to read tag '<tag address>' on device '<device name>'. Address exceeds current CIPconnection sizeUnable to read tag '<tag address>' on device '<device name>'. Controller Tag data type '<type>'unknown. Tag deactivatedUnable to read tag '<tag address>' on device '<device name>'. Data type '<type>' is illegal for thistagUnable to read tag '<tag address>' on device '<device name>'. Data type '<type>' not supported.Tag deactivatedUnable to read tag '<tag address>' on device '<device name>'. Tag does not support multi-elementarrays. Tag deactivated

Device '<device name>' returned more data than expected while reading tag'<tag address>'. Verify the address includes an element offset and alldimensions in that offsetError Type:Warning

Possible Cause:The tag address references an Array Variable, but either not all dimensions were specified in the element offsetor no element offset was specified at all. For example, the Array Variable "MyArray" is defined as ARRAY[0..2,0..9] OF INT. Creating a tag address like MyArray[0]{2}@Word Array may cause this error to occurbecause the second dimension is not specified. In this example, a read of the tag would result in 10 INTsreturned versus the 2 INTs that are expected. Likewise, creating a tag address like MyArray@Word may causethis error to occur because neither the first nor second dimension was specified. In this example, a read of thetag would result in 30 INTs returned versus the 1 INT that is expected.

Solution:Add the fully-qualified element offset to the tag address. In the examples above, the correct tag address could beMyArray[0,0]{2} and MyArray[0,0] respectively.

Note:This message is only a warning. Reads will succeed, but will be less efficient because of the extra overhead in theread response. As such, it is recommended that users fix the tag addresses that exhibit this behavior.

Read request for tag '<tag address>' on device '<device name>' failed due toa framing errorError Type:Warning

Possible Cause:A read request for the specified tag failed due to one of the following reasons:

www. kepware.com

33


1. Incorrect request service code.2. Received more or less bytes than expected.

Solution:If this error occurs frequently, there may be an issue with the cabling or the device itself. If the error occursfrequently for a specific tag, contact Technical Support. Increasing the request attempts will also give the drivermore opportunities to recover from this error.

Unable to read tag '<tag address>' on device '<device name>'. [CIPError=<code>, Ext. Error=<code>]Error Type:Warning

Possible Cause:The device returned an error within the CIP portion of the EtherNet/IP packet during a read request for thespecified tag.



Unable to read tag '<tag address>' on device '<device name>'. Addressexceeds current CIP connection sizeError Type:Warning

Possible Cause:The tag address size resulted in a request frame that exceeds the protocol limits.

Solution:Increase the CIP Connection Size to a value that will accommodate the tag's request frame.

Unable to read tag '<tag address>' on device '<device name>'. Controller Tagdata type '<type>' unknown. Tag deactivatedError Type:Warning

Possible Cause:A read request for the specified tag failed because the Variable's data type is not currently supported.

Solution:Remove references to this Variable. In response to this error, the tag will be deactivated; thus, it will not beprocessed again.

Unable to read tag '<tag address>' on device '<device name>'. Data type'<type>' is illegal for this tagError Type:Warning

Possible Cause:A read request for the specified tag failed because the client's tag data type is illegal for the given Variable.

Solution:Change the tag's data type to one that is supported.

See Also:Data Type Coercion

www. kepware.com

34


Unable to read tag '<tag address>' on device '<device name>'. Data type'<type>' not supported. Tag deactivatedError Type:Warning

Possible Cause:A read request for the specified tag failed because the client's tag data type is not supported.

Solution:Change the tag's data type to one that is supported. In response to this error, the tag will be deactivated; thus, itwill not be processed again.

Unable to read tag '<tag address>' on device '<device name>'. Tag does notsupport multi-element arrays. Tag deactivatedError Type:Warning

Possible Cause:A read request for the specified tag failed because the driver does not support multi-element array access to thegiven Variable.

Solution:Change the tag's data type or address to one that is supported. In response to this error, the tag will bedeactivated; thus, it will not be processed again.

Read Errors (Blocking)The following error/warning messages may be generated. Click on the link for a description of the message.

Read Errors (Blocking)Device '<device name>' returned more data than expected while reading '<count>' element(s)starting at '<tag address>'. Verify the address includes an element offset and all dimensions inthat offsetRead request for '<count>' element(s) starting at '<tag address>' on device '<device name>'failed due to a framing errorUnable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'. [CIPError=<code>, Ext. Error=<code>]Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'.Address exceeds current CIP connection sizeUnable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'. Blockdoes not support multi-element arrays. Block DeactivatedUnable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'.Controller Tag data type '<type>' unknown. Block deactivatedUnable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'. Datatype '<type>' is illegal for this blockUnable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'. Datatype '<type>' not supported. Block deactivated

Device '<device name>' returned more data than expected while reading'<count>' element(s) starting at '<tag address>'. Verify the address includesan element offset and all dimensions in that offsetError Type:Warning

Possible Cause:The tag address references an Array Element Variable, but either not all dimensions were specified in the elementoffset or no element offset was specified at all. For example, the Array Element Variable "MyArray" is defined asARRAY[0..9] OF INT. Creating a tag address like MyArray@Int may cause this error to occur because the firstdimension is not specified. In this example, a read of the tag would result in 10 INTs returned versus the 1 INTthat is expected.

www. kepware.com

35


Solution:Add the fully-qualified element offset to the tag address. In the example above, the correct tag address could beMyArray[4].

Note:This error message is only a warning. Reads will succeed, but will be less efficient because of the extra overheadin the read response. As such, it is recommended that users fix the tag addresses that exhibit this behavior.

Read request for '<count>' element(s) starting at '<tag address>' on device'<device name>' failed due to a framing errorError Type:Warning

Possible Cause:A read request for the specified tag to the specified tag address and count failed due to one of the followingreasons:


Solution:If this error occurs frequently, there may be an issue with the cabling or the device itself. If the error occursfrequently for a specific tag, contact Technical Support. Increasing the request attempts will also give the drivermore opportunities to recover from this error. In response to this error, <count> elements of the block will bedeactivated; thus, it will not be processed again.

Unable to read '<count>' element(s) starting at '<tag address>' on device'<device name>'. [CIP Error=<code>, Ext. Error=<code>]Error Type:Warning

Possible Cause:The device returned an error within the CIP portion of the EtherNet/IP packet during a read request for thespecified tag.



Unable to read '<count>' element(s) starting at '<tag address>' on device'<device name>'. Address exceeds current CIP connection sizeError Type:Warning



Unable to read '<count>' element(s) starting at '<tag address>' on device'<device name>'. Block does not support multi-element arrays. BlockDeactivatedError Type:Warning

Possible Cause:

www. kepware.com

36


A read request for the specified tags to the specified tag address and count failed because the driver does notsupport multi-element array access to the given Variable.

Solution:Change the data type or address for tags within this block to one that is supported. In response to this error,<count> elements of the block will be deactivated; thus, it will not be processed again.

Unable to read '<count>' element(s) starting at '<tag address>' on device'<device name>'. Controller Tag data type '<type>' unknown. BlockdeactivatedError Type:Warning

Possible Cause:A read request for the specified tags to the specified tag address and count failed because the Variable's datatype is not currently supported.

Solution:Remove references to this Variable. In response to this error, <count> elements of the block will be deactivated;thus, it will not be processed again.

Unable to read '<count>' element(s) starting at '<tag address>' on device'<device name>'. Data type '<type>' is illegal for this blockError Type:Warning

Possible Cause:A read request for the specified tags to the specified tag address and count failed because the client's tag datatype is illegal for the given Variable.

Solution:Change the data type for tags within this block to one that is supported.

See Also: Data Type Coercion

Unable to read '<count>' element(s) starting at '<tag address>' on device'<device name>'. Data type '<type>' not supported. Block deactivatedError Type:Warning

Possible Cause:A read request for the specified tags to the specified tag address and count failed because the client's tag datatype is not supported.

Solution:Change the data type for tags within this block to one that is supported. In response to this error, <count>elements of the block will be deactivated; thus, it will not be processed again.

Write ErrorsThe following error/warning messages may be generated. Click on the link for a description of the message.

Write ErrorsUnable to write to '<tag address>' on device '<device name>'Unable to write to tag '<tag address>' on device '<device name>'. [CIP Error=<code>, Ext.Error=<code>]Unable to write to tag '<tag address>' on device '<device name>'. Address exceeds current CIPconnection sizeUnable to write to tag '<tag address>' on device '<device name>'. Controller Tag data type'<type>' unknown

www. kepware.com

37


Unable to write to tag '<tag address>' on device '<device name>'. Data type '<type>' is illegal forthis tagUnable to write to tag '<tag address>' on device '<device name>'. Data type '<type>' notsupportedUnable to write to tag '<tag address>' on device '<device name>'. Tag does not support multi-element arraysWrite request for tag '<tag address>' on device '<device name>' failed due to a framing error

Unable to write to '<tag address>' on device '<device name>'Error Type:Warning

Possible Cause:1. The Ethernet connection between the device and the Host PC is broken.2. The communication parameters for the Ethernet connection are incorrect.3. The named device may have been assigned an incorrect IP address.

Solution:1. Verify the cabling between the PC and the device.2. Verify that the correct port has been specified for the named device.3. Verify that the IP address given to the named device matches that of the actual device.

Unable to write to tag '<tag address>' on device '<device name>'. [CIPError=<code>, Ext. Error=<code>]Error Type:Warning

Possible Cause:The device returned an error within the CIP portion of the EtherNet/IP packet during a write request for thespecified tag.



Unable to write to tag '<tag address>' on device '<device name>'. Addressexceeds current CIP connection sizeError Type:Warning



Unable to write to tag '<tag address>' on device '<device name>'. ControllerTag data type '<type>' unknownError Type:Warning

Possible Cause:A write request for the specified tag failed because the Variable's data type is not currently supported.

Solution:Remove references to this Variable.

www. kepware.com

38


Unable to write to tag '<tag address>' on device '<device name>'. Data type'<type>' is illegal for this tagError Type:Warning

Possible Cause:A write request for the specified tag failed because the client's tag data type is illegal for the given Variable.


See Also:Data Type Coercion

Unable to write to tag '<tag address>' on device '<device name>'. Data type'<type>' not supportedError Type:Warning

Possible Cause:A write request for the specified tag failed because the client's tag data type is not supported.


Unable to write to tag '<tag address>' on device '<device name>'. Tag doesnot support multi-element arraysError Type:Warning

Possible Cause:A write request for the specified tag failed because the driver does not support multi-element array access to thegiven Variable.

Solution:Change the tag's data type or address to one that is supported.

Write request for tag '<tag address>' on device '<device name>' failed due toa framing errorError Type:Warning

Possible Cause:A write request for the specified tag failed after so many retries due to one of the following reasons:


Solution:If this error occurs frequently, there may be an issue with the cabling or device. Increasing the Retry Attemptswill also give the driver more opportunities to recover from this error.

www. kepware.com

39


Error CodesThe following sections define error codes that may be encountered in the server's Event Log. For moreinformation on a specific error code type, select a link from the list below.

Encapsulation Error CodesCIP Error Codes

Encapsulation Error CodesThe following error codes are in hexadecimal.

Error Code Description0001 Command not handled.0002 Memory not available for command.0003 Poorly formed or incomplete data.0064 Invalid Session ID.0065 Invalid length in header.0069 Requested protocol version not supported.0070 Invalid Target ID.

CIP Error CodesThe following error codes are in hexadecimal.

Error Code Description0001 Connection Failure.*0002 Insufficient resources.0003 Value invalid.0004 IOI could not be deciphered or tag does not exist.0005 Unknown destination.0006 Data requested would not fit in response packet.0007 Loss of connection.0008 Unsupported service.0009 Error in data segment or invalid attribute value.000A Attribute list error.000B State already exists.000C Object model conflict.000D Object already exists.000E Attribute not settable.000F Permission denied.0010 Device state conflict.0011 Reply will not fit.0012 Fragment primitive.0013 Insufficient command data / parameters specified to

execute service.0014 Attribute not supported.0015 Toomuch data specified.001A Bridge request too large.001B Bridge response too large.001C Attribute list shortage.001D Invalid attribute list.001E Embedded service error.001F Failure during connection.**0020 Invalid parameter.***0022 Invalid reply received.0025 Key segment error.0026 Number of IOI words specified does not match IOI word count.0027 Unexpected attribute in list.

www. kepware.com

40


*See Also: 0x0001 Extended Error Codes**See Also: 0x001F Extended Error Codes***See Also: 0x0020 Extended Error Codes

0x0001 Extended Error CodesThe following error codes are in hexadecimal.

Error Code Description0100 Connection in use.0103 Transport not supported.0106 Ownership conflict.0107 Connection not found.0108 Invalid connection type.0109 Invalid connection size.0110 Module not configured.0111 EPR not supported.0114 Wrong module.0115 Wrong device type.0116 Wrong revision.0118 Invalid configuration format.011A Application out of connections.0203 Connection timeout.0204 Unconnected message timeout.0205 Unconnected send parameter error.0206 Message too large.0301 No buffer memory.0302 Bandwidth not available.0303 No screeners available.0305 Signature match.0311 Port not available.0312 Link address not available.0315 Invalid segment type.0317 Connection not scheduled.0318 Link address to self is invalid.

Note: For unlisted error codes, refer to the Omron documentation.

0x001F Extended Error CodesThe following error codes are in hexadecimal.

Error Code Description0101 Could be one of the following errors:

1. The combined size of the variable type and readaddress is incorrect.2. The variable type specification is incorrect.3. The read start address exceeds the range of thevariable area.4. The read end address exceeds the range of thevariable area.5. There are too many elements.

0102 Could be one of the following errors:

1. The number of elements does not match the size of thewrite data.2. The variable type specification is not correct.3. A Read Only area is included in the write area.

www. kepware.com

41


0104 A variable type is out of range.8001 An internal error occurred.800D There is an error in the registered tag information.8014 An internal error occurred.8016 A variable is not correctly registered.


0x0020 Extended Error CodesThe following error code is in hexadecimal.

Error Code Description8017 More than one element was specified for a variable that

does not have elements.8018 Zero elements or data that exceeded the range of the

array was specified for an array.8022 The data type specified in the request service data does

not agree with the tag information. The AddInfor Lengthin the request service data is not 0.

8028 Value is out of range.


www. kepware.com

42


Glossary

Term DefinitionLink Address Unique identifier for an Omron unit (such as Unit Address, IP address, and so

forth).Packet Stream of data bytes on the wire representing the request(s) being made. Packets

are limited in size.Port Number Specifies a way out of the Omron unit in question (such as a channel).Routing Utilizing one or more Omron NJ racks to hop to another Omron NJ rack.

*For more information on tag division, refer to Performance Statistics and Tuning and Optimizing YourCommunications.

Variable Tag-Based AddressingTerm DefinitionArray Client/Server Array Tag whose address has an Array Element specified. For

example, ARRAYTAG [0] {5}.Array Element Element within a Variable Array. For client/server access, the element must be a

basic. For example, ARRAYTAG [0].Array Variable Multi-dimensional array (1, 2 or 3 dimensions possible) support within Sysmac

Studio for Omron NJ-platform controllers. All basic data types support VariableArrays. Not all basic structure data types support Variable Arrays.

Basic Data Type A pre-defined, non-structured data type. Example: SINT and DINT.Basic Tag A Variable Tag defined with a basic data type.Client An HMI/SCADA or data bridging software package utilizing OPC,DDE, or proprietary

client/server protocol to interface with the server.Client/Server DataType

Data type for tags defined statically in the server or dynamically in a client.Supported data types in the server are listed in Data Type Descriptions. Supporteddata types in the client depends on the client in use.

Client/Server Tag Tag defined statically in the server or dynamically in a client. These tags aredifferent entities than Variable Tags. A Variable Tag's tag name becomes aClient/Server Tag's tag address when referencing a Variable Tag.

Client/Server Array Row x column data presentation format supported by the server and by someclients. Not all clients support arrays.

Variable Data Type A data type defined in Sysmac Studio for Omron NJ-platform controllers.Variable Tag Tag defined in Sysmac Studio for Omron NJ-platform controllers.Server The OPC/DDE/proprietary server utilizing this Omron NJ Ethernet Driver.Structure Data Type A complex data type (pre-defined or user-defined) that consists of members whose

data types are basic or structured in nature.Structure Tag A Variable Tag defined with a Structure Data Type.

www. kepware.com

43


Index

0

0x0001 Extended Error Codes 410x001F Extended Error Codes 410x0020 Extended Error Codes 42

A

Address '<address>' is out of range for the specified device or register 25Address Descriptions 18Address Formats 19Address Validation Error Messages 24Array Block Size 7Array size is out of range for address '<address>' 25Array support is not available for the specified address: '<address>' 25Automatic Tag Database Generation 22Automatic Tag Database Generation Error Messages 26

B

Boolean 17Byte 17

C

Cable Diagram 6Char 17CIP Error Codes 40Communication Error Messages 30Communication Protocol 6Communications Parameters 6Communications Routing and Timing 8Connection Path Specification 9Connection Size 7

www. kepware.com

44


D

Data Type '<type>' is not valid for device address '<address>' 25Data Types Description 17Database Error: Address validation failed for tag '<tag name>' with address '<tag address>'.

Tag will not be added to the database 27Database Error: Data type '<hex value>' for member '<member name>' of complex type

'<complex type name>' is not supported. A tag for this member will not be added to thedatabase 27

Database Error: Encapsulation error occurred during Fwd. Open request. [Encap.Error=<error>] 27

Database Error: Encapsulation error occurred during Register Session request. [Encap.Error=<error>] 27

Database Error: Encapsulation error occurred while uploading project information. [Encap.Error=<error>] 28

Database Error: Error occurred during Fwd. Open request [CIP Error=<code>, Ext.Error=<code>] 28

Database Error: Error occurred while uploading project information. [CIP Error=<code>, Ext.Error=<code>] 28

Database Error: Framing error occurred during Fwd. Open request 28Database Error: Framing error occurred during Register Session request 29Database Error: Framing error occurred while uploading project information 29Database Error: No more connections available for Fwd. Open request 29Database Error: Unable to resolve CIP data type '<hex value>' for tag '<tag name>'. Tag will

not be added to the database 29Device '<device name>' is not responding 31Device '<device name>' returned more data than expected while reading '<count>' element(s)

starting at '<tag address>'. Verify the address includes an element offset and alldimensions in that offset 35

Device '<device name>' returned more data than expected while reading tag '<tag address>'.Verify the address includes an element offset and all dimensions in that offset 33

Device address '<address>' contains a syntax error 25Device address '<address>' is not supported by model '<model name>' 26Device address '<address>' is Read Only 26Device ID 6Device Setup 6Device Specific Error Messages 31Double 17DWord 17

www. kepware.com

45


E

Encapsulation Error Codes 40Encapsulation error occurred during a request to device '<device name>'. [Encap.

Error=<code>] 31Error Codes 40Error occurred during a request to device '<device name>'. [CIP Error=<code>, Ext.

Error=<code>] 31

F

Float 17Frame received from device '<device name>' contains errors 32

G

Global Tags 20Glossary 43

I

Inactivity Watchdog 7

L

Long 17Long Controller Program & Tag Names 22

M

Missing address 26

www. kepware.com

46


N

Non-Blocking 33

O

Omron NJ Ethernet Specific Error Messages 33Optimizing Your Application 14Optimizing Your Communications 13Options 7Overview 5

P

Performance Statistics and Tuning 15Port ID 9Predefined Term Tags 21Preparing for Automatic Tag Database Generation 23

R

Read Errors 33, 35Read request for '<count>' element(s) starting at '<address>' on device '<device>' failed due to

a framing error 36Read request for tag '<tag address>' on device '<device name>' failed due to a framing

error 33Routing Examples 10

S

Short 17String 17Structure Tag Addressing 20-21

www. kepware.com

47


T

Tag Hierarchy 22Tag Scope 20TCP/IP Port 7

U

Unable to bind to adapter: '<adapter>'. Connect failed 30Unable to generate a tag database for device <device name>. Reason: Low memory

resources 29Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'.

Controller Tag data type '<type>' unknown. Block deactivated 37Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'.

[CIP Error=<code>, Ext. Error=<code>] 36Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'.

Address exceeds current CIP connection size 36Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'.

Block does not support multi-element arrays. Block Deactivated 36Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'.

Data type '<type>' is illegal for this block 37Unable to read '<count>' element(s) starting at '<tag address>' on device '<device name>'.

Data type '<type>' not supported. Block deactivated 37Unable to read tag '<tag address>' on device '<device name>'. [CIP Error=<code>, Ext.

Error=<code>] 34Unable to read tag '<tag address>' on device '<device name>'. Address exceeds current CIP

connection size 34Unable to read tag '<tag address>' on device '<device name>'. Controller Tag data type

'<type>' unknown. Tag deactivated 34Unable to read tag '<tag address>' on device '<device name>'. Data type '<type>' is illegal for

this tag 34Unable to read tag '<tag address>' on device '<device name>'. Data type '<type>' not

supported. Tag deactivated 35Unable to read tag '<tag address>' on device '<device name>'. Tag does not support multi-

element arrays. Tag deactivated 35Unable to retrieve the Identity for device '<device>'. [CIP Error=<error>, Ext. Error=<error>]

32Unable to retrieve the Identity for device '<device>'. [Encap. Error=<error>] 32Unable to retrieve the Identity for device '<device>'. Frame received contains errors 32Unable to write to '<tag address>' on device '<device name>' 38Unable to write to tag '<tag address>' on device '<device name>'. [CIP Error=<code>, Ext.

www. kepware.com

48


Error=<code>] 38Unable to write to tag '<tag address>' on device '<device name>'. Address exceeds current

CIP connection size 38Unable to write to tag '<tag address>' on device '<device name>'. Controller Tag data type

'<type>' unknown 38Unable to write to tag '<tag address>' on device '<device name>'. Data type '<type>' is illegal

for this tag 39Unable to write to tag '<tag address>' on device '<device name>'. Tag does not support multi-

element arrays 39Unable to write to tag <tag address> on device <device name> . Data type <type> not

supported 39

W

Winsock initialization failed (OS Error = n) 30Winsock V1.1 or higher must be installed to use the Omron NJ Ethernet device driver 30Word 17Write Errors 37Write request for tag '<tag address>' on device '<device name>' failed due to a framing

error 39

www. kepware.com

49

Omron NJ Ethernet Driver Help - kepware-japan.com · OmronNJ EthernetDriverHelp DeviceSetup...

Documents

Transcript of Omron NJ Ethernet Driver Help - kepware-japan.com · OmronNJ EthernetDriverHelp DeviceSetup...