Page History

There are 2 independent ways to use this protocol, using a TagProvider or as a DeviceChannel in the Module Device.

• TagProvider: allows to use the PLC addresses directly without creating any Tags nor mappings in the Project.
• DeviceChannel: create Project Tags and map to the PLC addresses, allowing more control over names and data blocks. Use the Solution Import Tags to setup automatically the mapping.

This document has only the specific information about the device connection settings and its address syntax.

Refer to the User Guide for more information on the Device Module or on External TagProviders UNS TagProvider Connections.

Summary

Channels Configuration

Protocol Options

Model:  Set the PLC model. It can be:

• Others: For all models exception 1756-L8X.
• 1756-L8X: For Allen-Bradley model: 1756-L8X, 5069-L330ERS, CompactLogix 5380 and 5069-L310ERS2 5380 GuardLogix.

    MaxStringItemsPerBlock:  Define the maximum string item count to each block.

Nodes Configuration

Primary Station 

Stations syntax:  <IP > ; <Port > ; <Slot><PLCAddress> ; <PLCPort> ; <ProtocolName>;<MotorolaByteOrder>;<GatewayAddress>;<GatewayPort>;<GatewayPassword>;

<GatewayDeviceProtocol>;<LogonName>;<LogonPassword>

Where :

 <IPPLCAddress> = IP address of the slave device in the network 

< Port > = TCP port where the slave device is listening (default is 44818) 

<Slot> = Slot is the Slot number where the CPU is connected.

Example: 192.168.1.101; 44818; 0

Logical address or node name of the PLC. CODESYS protocol address can be specified. But be careful, as these addresses are automatically generated, they may change if the network configuration of the communication partners changes. Therefore configuring the device name should be preferred.

<PLCPort> = Tcp/Ip port number. If not specified, the default value 11740 is used.

<ProtocolName> = Communication protocol to the PLC; the most important settings are:

• Tcp/Ip (Level 4): TCP/IP Level 4 Protocol
• Tcp/Ip (Level 2): TCP/IP Level 2 Protocol
• Tcp/Ip (Level 2 Route): TCP/IP Level 2 Route
• Serial (RS232): Serial connection

<MotorolaByteOrder> = Byte order of the PLC.

<GatewayAddress> = If 'Tcp/Ip' is used as Gateway protocol: IP-Address or Hostname of the Gateway. If 'NamedSharedMemory' is used as Gateway protocol: Name of the shared memory on which the Gateway listens. If not specified, then the default name for the shared memory is used and it behaves identical to the protocol 'SharedMemory'. 'NamedSharedMemory' is for special use only.

<GatewayPort> = If 'Tcp/Ip' is used as Gateway protocol: Port number of the Gateway. Typical values: 1210 / 1217. All other configurations: Not evaluated

<GatewayPassword> = If the Gateway, which is used for the connection, protected by a Gateway password, than this can be entered here, to allow the PLCHandler to use this Gateway.

<LogonName> = If the user management is activated on the PLC, then the user name for the PLCHandler login can be specified here.

<LogonPassword> = If the user management is activated on the PLC, then the password for the PLCHandler login can be specified here.

Example: MY_PC_Name;11740;;False;localhost;1217;;;;;

Points Configuration

Choose the PLC Item that will communicate with the Project Tag. You can type the PLC Item name into the TextBox, or you can browse the PLC Items in the Cell Editor.

Image Added

Points Configuration

The syntax for the ControlLogix communication points is: <Type> : <DeviceTagName>

• Type: Type is data type of the Tag in the PLC.
• DeviceTagName: name of the Tag in the PLC.

The following Table has possible formats for the DeviceTagName

Format

Syntax

Comments

Standard

<Device Tag Name>

Array Element

<Device Array Tag name>[dim 1, dim2, dim 3]

Dimension Range = 1 to 3

User Defined Type (UDT)

<Decice Main Tag Name>.<Type Member>

User Defined Type (UDT)
Array Element

<Device Main Tag Name>.<Type Member>[dim 1, dim2, dim 3]

Dimension Range = 1 to 3

Accessing Bit from SINT or INT or DINT ControlLogix datatype

Method 1: Using the Modifiers column. 

Use the Modifiers column in Device -> Points to specify the Bit to access.

Example of Device Point Configuration to access Bit 3 from INT

Method 2: Using the Tag property. 

In the Device the whole word into a tag and use the Tag property to access the specify Bit.

Example of Device Point Configuration to access whole word

Syntax to access Tag Bit property in any place of project 

E.g.: Tag.Interger.Bit3

 Examples

Performance Optimization

Overview

When you communicate with a ControlLogix PLC, the protocol is not as efficient as the older PLC 5 style N7:0 addressing. This is the price you pay for the convenience of using tag names in a PLC.

With the ControlLogix PLC, you actually have to give it the complete tag name of each tag that you want. The PLC has to find that tag in its database and return the data to you.

When ControlLogix first came out, you could only get one item in each packet, which meant performance was quite slow. Years later, Rockwell added what they call the CIP (Controller Interface Protocol) Multi-Item Request Packet.

ControlLogix Multi-Item Request Packet sizes are about 500 bytes and can contain the names of multiple PLC tag names that you would like to read. Every character in a tag name takes up about 1 byte.

Some of the 500 bytes are needed for the PLC command and general communication overhead. The point remains the same though: there are less than 500 bytes available to fill tag names into a request packet.

Maximizing System Throughput

As with any programmable controller, there are a variety of ways to enhance the performance and system communications.

In this document, we will discuss the following items:

• Set the PLC CPU time slice to 40%-50%
• Use Array Tags
• Use Global Tags only
• Simultaneous Connections

Set the PLC CPU time slice to 40%-50%

One of the first things you should check in your system is the CPU time slice setting in your ControlLogix PLC. This is set using your RS Logix 5000 programming software. This value represents the percentage of available CPU time that is dedicated to communication activities by the PLC CPU.

It should be noted that the time slice settings for the CPU communications default is 10%. For every 10 ms program scan that occurs, the controller spends 1 ms processing driver requests.

If the communication tasks are high priority, the time slice should be set at or above 30%. Set the slice from 10% to 40% to achieve the best balance of communication, performance, and CPU usage. Values greater than 50% start to reach diminishing returns.

Use Array Tags

The best way to communicate with ControlLogix is through the use of Arrays and short PLC tag addresses. Arrays may have a long tag address name in the PLC. If there are numerous tags in the array, great gains in performance can be achieved due to the ability of a single request for all the tags within the 500-byte packet size.

One hundred tags can be read or written to in a single command. For example: If the Array size is 100 (e.g.: MyTag is an array MyTag[0] to MyTag[99]), under 200ms would be reasonable yet still dependent on the number of other requests required to be met by the system and demands on ControlLogix.

Boolean arrays are treated differently: in protocol, a Boolean array is a 32-bit array. Thus, requesting element 0 is requesting bits 0 through 31.

Use Global Tags Only

In PLCs, the use of short tag names for tags other than arrays is also of great benefit. This is because the TOP Server packs the PLC tag addresses into the Multi-Item Request packet sent to ControlLogix. The 500-byte limit is what makes the shortness of the tag addresses so critical.

Creating all required PC communication tags under the Global file is one way of shortening the names because Global tags require the least amount of space in the Multi-Item Request Packet.

Since we can import L5K file tag descriptions, it is not hard to then change the Server tag names to something more descriptive which would make HMI project creation easier. The key is that the ControlLogix PLC tag name be as short as possible, not the tag name used in the SCADA database.

Simultaneous Connections

In general, the limit on the number of Ethernet connections that can be made to a ControlLogix PLC is high. The default ControlLogix driver opens one TCP socket or connection to the PLC’s Ethernet module for each channel that is defined in the SCADA. However, in the ControlLogix Channel → Settings Column, you can change the number of the NodeConnections and Simultaneous Connections (default 1 and 1 respectively).

For example: If a user created a ControlLogix Channel with 15 node connections and 15 simultaneous connections, 15 TCP socket connections would be made. It means that you have 15 messages going to the PLC at the same time. It is 15 time faster than only one connection. In theory, if the PLC’s Ethernet module had a limit of 64 simultaneous TCP sockets, users could connect 64 simultaneous connection at the same time to the PLC.

As more connections are made to a controller, communication performance will begin to degrade based on the amount of data being acquired and the rate of acquisition. To refine the ratio of CPU time spent on processing and communications, refer to the PLC’s System Overhead Time Slice (SOTS) parameter description.

In summary, this can greatly increase the performance of your communication, but you need to balance it with the PLC’s Time Slice.

Troubleshoot

The status of the driver execution can be observed through the platform built-in diagnostic tools. Refer to the Using Diagnostic Tools topic in Devices Communication page.

Connection Error Codes

Connection errors

Error Code

Description

Possible Solution

0

Success

• None

-100

Error Sending Message

-101

Error Sending and Waiting Message

-102 … -105

Error creating TCP/IP connection

-106

Error Receiving Message 

-112

Timeout Start Message

• Turn PLC on
• Plug the PLC Ethernet cable 
• Ping PLC using prompt command
• Check configured IP Address field in Device → Node 
• Increase the driver timeout field in Device → Channel

-113

Timeout between Treated Chars

-114

Timeout End Message

-115

Timeout Connect

-200

Protocol Error

• Check if the PLC model is compatible with driver documentation
• Check the configured Address field in Device → Points

-201

Invalid Protocol

• Check if the PLC model is compatible with driver documentation
• Contact technical support

-202

Invalid Station

• Check configured IP Address field in Device → Node 
• Restart the driver

-204

Invalid Message Sequence

• Check if the PLC model is compatible with driver documentation
• Check the configured Address field in Device → Points

> 0 

CIP Error

• See CIP error codes table

CIP Error Codes

Troubleshooting tips

In this driver, it is very important to enable the TraceWindow messages, as invalid addresses can cause all the communication block with the PLC to fail, the TraceWindow tool will display the first invalid address found on the block when the Device is enabled on the settings.

In order to have a quick view on the many communication blocks, open the ModuleInformation, navigate on the tree to find ControlLogix and then select Read Groups. Looking at the number and success and fail communication counters, you can easily identify if there is a block with error and then use the TraceWindow to locate the wrong address.

Codesys Simulated PLC - Installation and Getting Started

There is a software that can be used to program real PLCs or simulated ones, called CODESYS Control Win V3.

For more information on how to install and configure it, please refer to the Codesys documentation.

Driver Revision History

In this section...