controller information sheet - maple systems systems inc., 808 134th street sw, suite 120, everett,...

. Maple Systems Inc., 808 134th Street SW, Suite 120, Everett, WA 98204-7333

1036-0179 of 20 Rev. 07, 08/15/2016

CONTROLLER INFORMATION SHEET Maple Model(s) Title

Graphic HMI

Allen-Bradley

Compact/ControlLogix/DriveLogix

Connecting and importing tags created with the

RSLogix5000 software.

P/N: 1036-0179

Rev. 07 Date: 08/15/2016

Summary

Maple Systems Graphic HMIs (HMIs that use the EZware configuration software) communicate

with Allen-Bradley Logix Family of Programmable Controllers via the CIP protocol using the

Ethernet port located on the PLC or communication module. To read/write to tags configured in

the Logix PLC, you must import a CSV tag file into EZware. The CSV tag file is created using

the RSLogix5000 software.

Communications Cable

The Graphic HMI can be connected directly to the Ethernet port located on the controller or

communications module. If connecting to the PLC/module directly from the Graphic HMI, a

crossover cable is required. A list of communications cables offered by Maple Systems as well as

cable assembly instructions to assist you in assembling your own communications cable are

available on our website at www.maplesystems.com.

WARNING If your communications cable is not wired exactly as shown in our cable assembly

instructions, damage to the HMI or loss of communications can result.

Accessible PLC Memory

The driver makes use of the tag list exported from the Rockwell Automation RSLogix5000

software. Please note the following:

1. Aliased Tags are not supported.

2. Tags that use Add-On-Defined data types are not supported.

3. Tags that use the LINT data type are not supported

../../../../../../users/sams/My%20Documents/Tech%20Support%20Projects/Revised%2010360179%20AB%20Tags%20CIS/www.maplesystems.com

Ph: 425/745-3229 • Fax: 425/745-3429 • [email protected] • www.maplesystems.com

1036-0179 of 20 Rev. 07, 08/15/2016

1. EZware Settings

The following table lists the communications settings that must be configured in

EZware. These settings can be found in the Edit-Set System Parameters menu under the

Device tab. Click New to create a new device. Please note:

The Recommended Settings column provides the recommended setting

based upon the default settings most commonly used in the Allen-Bradley

Compact/ControlLogix Controllers.

The Options column lists EZware options; the PLC may not support every

option

Name Recommended

Settings Options Important Notes

Name: Rockwell EtherNet/IP

(ControlLogix) Description label

HMI or PLC PLC

Location Local Local, Remote

Select Local if PLC directly

connected to HMI, Remote

if connected through another

HMI.

PLC type:

Allen-Bradley

Compact/Control

Logix Free Tags

(Ethernet IP-CIP

Preferred)

PLC I/F: Ethernet

RS-232,

RS-485 2W,

RS-485 4W,

Ethernet

This driver supports Ethernet

communications only.

PLC default

station no.: 0 0-255

Set to the slot in the rack

corresponding to the location of

the CPU.

Setting: Use UDP: Unchecked Checked or

Unchecked Must be unchecked.

Settings: IP

Address: xxx.xxx.xxx.xxx

0.0.0.0-

255.255.255.255 Must match the controller port’s

IP Address.

Settings: Port 44818 0-65535 Do not change this setting.

Settings: Timeout

(sec) 1.0 0.1 to 25.5

Adjust if longer timeout is

required.


1036-0179 of 20 Rev. 07, 08/15/2016

Name Recommended

Settings Options Important Notes

Settings: Turn

around delay

(ms):

0 0-1000 Timeout period between HMI

polls.

Settings: Send

ACK

Delay :

0 Not Applicable

Settings:

Parameter 1: 0 Not Applicable

Settings:


Settings:


Interval of Block

Pack (words): 5 1-512

Max. read-

command size

(words):

100 1-512

Max. write-

command size

(words):

100 1-512

2. Importing Tags from RSLogix5000 using CSV file

Background Data Types A data type is simply a definition of the size and layout of a memory area when a tag of the data

type is created. The data type itself is not allocated any memory by the PLC- it is just a template

that the PLC uses when allocating memory in the PLC for a tag. The basic or ‘atomic’ data types

supported by RSLogix5000 v16 as defined by IEC 61131-3 are BOOL, SINT, INT, DINT,

REAL and LINT.

Atomic Data Type Definition Range

BOOL 1 bit (Boolean) 0 (False), 1 (True)

SINT 8 bits (short integer) -128 to 127

INT 16 bits (signed integer) -32768 to 32767

DINT 32 bits (signed double integer) -2,147,483,648 to 2,147,483,647

LINT* 64 bits (signed long integer) -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807

REAL 32 bits (IEEE 754 single precision float) -3.40282346E+38 to 3.40282346E+38

* not supported in EZware


1036-0179 of 20 Rev. 07, 08/15/2016

All other data types are data structures that are created from these basic types.

There are five folders listed in the RSLogix5000 software for data types:

User-Defined- these are new data types defined by the PLC programmer. They can be a

combination of other data types (atomic, string, predefined, module or other user-defined)

that already exist.

Strings- these define a data array that can be used to store ASCII character strings.

Predefined- these are predefined data types used by the instruction set. An instruction

(ex. XIC, ADD, PID) is an operation that is performed by the PLC.

Add-On-Defined†- these are data types that are created to support Add-On Instructions.

Module-Defined- data types to define memory that is used by a physical module (ex.

analog, digital) attached to the PLC.

†not supported in EZware

Tags Tags are a particular instance or assigned area of memory in the PLC where data is stored. Tags

have unique names that are created by the PLC programmer for the purpose of storing data and

controlling the program. Each tag is assigned a data type to determine the type of memory and

how much memory must be allocated for the tag. The tags that you create in RSLogix5000 can

be easily imported into the EZware software so that you do not have to recreate them in the HMI

project.

There are two types of tags in RSLogix5000: Controller tags and Program tags. The Controller

tags are global in scope. Therefore, they can be referenced by any of the tasks, programs, or

routines that run.

Program tags are local in scope to the particular program they were created in. EZware supports

reading/writing to both Controller tags and Program tags. Note: if you are unable to import

Program tags, go to Maple Systems website to upgrade your software.

EZware supports all tags listed above except for:

Tags that use Add-On-Defined data types

Tags that use the LINT data type

Alias tags (tags assigned to other tags)


1036-0179 of 20 Rev. 07, 08/15/2016

Importing RSLogix5000 tags into EZware To read/write to tags in your PLC, EZware must know what tags were created. Therefore, you

must import the tags into EZware so that you can reference them in your HMI project. This is

done following these five steps:

Step 1: Create tags in the RSLogix5000 project.

Example of RSLogix 5000 project (Controller Tags)

Go into the Controller Organizer window for your PLC. Click on the System Protocol tab.

Verify settings are:

Protocol: DF1 Point to Point

Station Address: Default is 0

Error Detection: BCC

RSLogix5000- Communication Settings

Double-click on the Ethernet module folder and note the IP address that is assigned to the

module.


1036-0179 of 20 Rev. 07, 08/15/2016

RSLogix5000- IP Address Settings

Step 2: Export the tags to a CSV file. Take note where on your computer you are saving the file.

RSLogix5000- Creating a CSV project file

Step 3: Start EZwarePlus, add the Allen-Bradley Compact/Control Logix Free Tags (EthernetIP-

CIP Preferred) driver.

First time users:

Start EZwarePlus or EZware5000

Select your HMI model

In the System Parameter Settings window, click New

In Device Properties window, click the right-arrow button on PLC type

On the PLC selection menu, select Allen-Bradley (Rockwell Automation) folder

Select Compact/Control Logix Free Tags (EthernetIP-CIP Preferred)


1036-0179 of 20 Rev. 07, 08/15/2016

EZwarePlus- Add Allen Bradley Compact/ControlLogix Free Tags Preferred driver

Configure for Ethernet with correct IP address of target PLC.

PLC I/F: Ethernet

IP: Click the Settings button. Enter IP address of PLC.

PLC default station: Default is 0 but this must match the Station Address setting you

assigned to the PLC.

EZwarePlus- Configure Allen Bradley Free Tags Preferred driver


1036-0179 of 20 Rev. 07, 08/15/2016

Step 4: Click Import Tag button and select the CSV file that you created in Step 2.

EZware- Importing an Allen-Bradley CSV Tag file

Step 5: If EZware recognizes all of the tags in the CSV file, you will get a successful download

message and you are done. If some of the tags were not recognized, a Warning box is displayed.

EZware- Import Tag Warning message


1036-0179 of 20 Rev. 07, 08/15/2016

If you want to access any of the tags that were not successfully imported, it may be possible by

using the Structure Editor in EZware to define the data types used for the tags, then importing the

tags again. Note the Tag Name and unknown data type for each tag listed in the Error Status

table. Note: you can create a CSV file by clicking on the Export button. Click OK. Proceed to

the next section.

Creating new data types in the Structure Editor To be able to read/write to any of the tags that were not imported, you must create the data type

before the tag can be imported. This is done using the Structure Editor.

The Structure Editor is used to create data types that are not recognized when you import your

tags. Click the Data Type… button to display the Structure Editor:

EZware- Accessing the Structure Editor

As with the RSLogix5000 software, the Structure Editor arranges the Data Types into four

folders (note: the Add-On-Defined folder is not supported in EZware):

User-Defined folder- this folder contains any custom data types you created. Note: the 27

data types already in this folder are actually used for BACnet applications.

Strings folder- contains the STRING data type

Predefined folder- contains over 120 predefined data types that match the data types in

the Predefined folder in RSLogix5000.

Module-Defined folder- contains 10 common modules that can be added to the base unit

of a PLC. Not all modules are listed so if you have a physical analog/digital module that


1036-0179 of 20 Rev. 07, 08/15/2016

is not shown, you will have to create a new data type before you can import the tags used

for that module.

Please note that every tag that you wish to import into EZware from your PLC project must have

a data type assigned to it that is listed in one of these folders. If EZware does not recognize the

data type associated with the tag, then an error message is displayed and the tag is not imported.

In most instances, tags that were not imported may be due to missing data types either in the

module-defined folder or the user-defined folder. If the data type is listed (and in the correct

folder), then the tag may still not be imported if the data type is not recognized by EZware (ex.

LINT data type).

To create a new data type in the module-defined folder EZware does allow access to tags used for physical modules (ex. digital or analog) of the PLC.

These data types are located in the module-defined folder of the Structure Editor. By default,

there are ten predefined data types in this folder. However, there are many more physical

modules available so you may have to create additional data types before you can import the

tags.

In our example above, six of the ten error messages were generated because EZware did not

recognize the data types that were created in RSLogix5000 for two physical modules:

1769-IQ6XOW4/B- this is a 6 point 24VDC Sink/Source Input, 4 point AC/DC Relay

Output digital module for the 1769 CompactLogix Series PLC.

1769-IF4XOF2/A- this is a 4 channel input/2 channel output analog module for the 1769

CompactLogix Series PLC.

In the RSLogix5000 software, the following data types were automatically added to the Module-

Defined folder when the two modules were added:

control relay data type-analog module

input data type-analog module

output data type-analog module

control data type-digital module

input data type-digital module

output data type-digital module

Before the HMI project can access any of the tags that were created in the PLC program for

the modules, you must copy the data type listed using the Structure Editor. In this example,

we will show how to do this for the first data type that was listed in the Error List-

AB: 1769_IQ6XOW4:C:0.


1036-0179 of 20 Rev. 07, 08/15/2016

EZware- Import Tag Warning message

Step 1: Open your PLC project in RSLogix5000. In the Project Editor Window, locate the

sub-folder Module-Defined that is a subset of the folder Data Types. Expand the folder to

show the six data types that support the two modules.

Double-click on the data type: AB:1769_IQ6XOW4:C:0 to display its properties:

RSLogix5000- Data type in Module-Defined folder

Step 2: In the EZware software, open the project that has the AB driver and tags which you

have already imported. Start the Structure Editor.

Any new data type created must go into the same folder that it is listed in the RSLogix5000

folder. For the AB:1769_IQ6XOW4:C:0 data type, we must create it in the Module-Defined

folder. In the Structure Editor, right-click on the Module-Defined folder, then click New data

type.

Ph:425/745-3229• Fax:425/745-3429• [email protected] •www.maplesystems.com

1036-0179 of 20 Rev. 07, 08/15/2016

EZware- Structure Editor, adding new Module-Defined data type

Name: this must be identical to the name given to the data type in RSLogix5000.

Description: this field is optional but you can enter the same description that is listed

for the data type in RSLogix5000.

Member table: the table must match the Name and Data Type of each member listed in

the RSLogix5000 table. Note: It is only necessary to capture the member data types

that are used by the tags that you want to import into EZware. You can manually add

each member one-by-one by using the Add button but the Paste button provides a

faster way. In the RSLogix5000 software, left-click on the left-most column on the

row of the first data member (ex. Config). Then, while holding down the left button of

the mouse, drag to the lowest row so that all of the data members are highlighted.

RSLogix5000- Copying members of data type

Use CTRL-C to copy.

Go back to the Structure Editor and click on the Paste button. Click anywhere inside

the blank area, then use CTRL-V to paste.


1036-0179 of 20 Rev. 07, 08/15/2016

EZware- Paste function in Structure Editor

Click OK.

You should see all of the members now listed in the Structure Editor.

EZware- new data type in Module-Defined folder

Click OK. A popup button “Tags verify succeeded.” should display. Click OK.

You should also notice that there is now a new data type AB:1769_IQ6XOW4:C:0 listed

under the Module-Defined folder.

To create another data type for a module, simply right-click on the Module-Define folder as

before, then New Data Type.

When you are done, before you leave the Structure Editor, you must click the Save to default

button. This will save the new data types that you just created to a file (ModuleDefined.dat)

that is located in a folder called Data Type in the C:\MapleSystems\EZPlus directory. This file

and three other files (Predefined.dat, Strings.dat, and UserDefined.dat) are used to define all of


1036-0179 of 20 Rev. 07, 08/15/2016

the data types that are interpreted by EZware when importing tags.

EZware- Structure Editor, six new data types for physical modules

Click Exit to leave the Structure Editor.

To create a new data type in the user-defined folder In our example above, you may have noticed four other errors:

myLINT_Tag Unknown data type: LINT

Solar_Cell_1 Unknown data type: PV_CELL

threeD_array Binary access error

Program:MainProgram.Solar_Cell_2 Unknown data type: PV_CELL

We can’t import the myLINT_Tag because the LINT data type is not supported in EZware.

The other two tags (one a Controller scope tag and the other a Program scope tag) were not

imported because EZware did not recognize the data type: PV_CELL. To rectify this problem,

we must use the Structure Editor to create a new data type: PV_CELL. The data type

PV_CELL was created in RSLogix5000 under the User-Defined folder:

RSLogix5000- user-defined data type example


1036-0179 of 20 Rev. 07, 08/15/2016

So let’s create a new data type in the Structure Editor using the User-Defined folder:

Copy the Name (PV_CELL) into the Name: field of the Structure Editor.

Copy the Description as well.

Copy the Data members using the Paste function (see ‘To create a new data type in the

module-defined folder’ section above if you do not remember how to do this).

EZware- creating a new data type in the user-defined folder

Click the Save to Default button to save the new data type to the User-Defined.dat file, then

Exit.

When you import the RSLogix tags again, the Solar_Cell tags are imported without error.

To read/write to multi-dimensional arrays An array is a numerically indexed sequence of elements. In RSLogix5000, you can create a

data array with a specified range for the index. The array can be multi-dimensional meaning

that you can define each member with more than one index. RSLogix5000 supports up to

three-dimensional arrays.


1036-0179 of 20 Rev. 07, 08/15/2016

RSLogix5000- creating a multi-dimensional tag

The last error is for a tag called threeD_array. The Binary access error would seem to indicate

that EZware does not recognize the format of the tag. However, if you were to create a

Numeric object in EZware, you will notice that you have access to this array:

EZware Numeric Object- listing of a three dimensional array tag

So although an error is generated when you try to import multi-dimensional arrays, you can

still read/write to each element of the array using EZware. EZware supports multi-

dimensional arrays that use SINT, INT, DINT, or FLOAT data types.


1036-0179 of 20 Rev. 07, 08/15/2016

Additional Notes Tags that use the STRING data type EZware can read/write to tags that use the STRING data type. The default STRING data type

in RSLogix5000 has two elements: a DINT that is used to record the length of the character

string and a SINT data array that stores the characters (maximum length is 82 bytes).

Although you can configure your HMI to write to a STRING tag, EZware does not

automatically update the length of the characters. When configuring an ASCII object in

EZware to read/write to a STRING tag, select the Use Unicode option and click the Setting

button to configure the character length of the string. A maximum of 32 characters is

allowed.

Editing the STRING.LEN using EZware If you want EZware to change the STRING.LEN variable when writing to a STRING tag,

perform the following steps:

1. Create the ASCII object. On the Data Entry tab, select Use a popup keypad and select

one of the ASCII keypads listed in the drop down box for Window no. Use the

Notification feature to set an internal HMI memory bit (ex. LB100)

EZware- Create ASCII object with Notification option


1036-0179 of 20 Rev. 07, 08/15/2016

2. Create a PLC Control Object that will execute a macro when the Notification bit above

is set.

EZware- PLC Control object to execute macro

3. Create a macro that calculates the number of characters that were entered by the HMI

operator when using the ASCII keypad.

EZware- Macro that determines length of characters entered with ASCII object


1036-0179 of 20 Rev. 07, 08/15/2016

Accessing SINT, INT, or DINT as binary There may be an instance in which you configure a tag using the INT data type but you wish to

access each individual bit of the tag separately in EZware. This is done by configuring the

Style setting in RSLogix5000 to Binary for that tag:

RSLogix5000- Setting the Style to Binary for tags

When the tag is imported into EZware, you can now access the tag using either a Word object

or a Bit object.


1036-0179 of 20 Rev. 07, 08/15/2016

EZware- Accessing Binary Style tags with Bit objects or Word objects

Load from default button in the Structure Editor When clicked, this button will load all of the default data types stored in the four *.dat folders

located in the C:\MapleSystems\Data Type directory. Note: this will erase all new data types

that you have created since pressing the Save to default button.

EZware Address Tag Manager does not show imported AB tags EZware has a feature called Address Tag Manager Library which normally lists all of the tags

that you created in a project. When using the Import Tags feature with an Allen Bradley

driver, none of the tags imported are shown in the Address Tag Library. To see a listing of the

tags, you must open a Bit object (ex. Bit Lamp) or Word object (ex. Numeric object). In the

Read Address field, select the Allen-Bradley driver, then click on the Settings button.

Important Memory Considerations

If your PLC’s memory range is smaller than the range supported by the Maple HMIs, it is

possible to configure the HMI to monitor a PLC memory address which does not exist.

Since this can cause unpredictable results, when you configure the HMI please ensure that

all selected PLC memory addresses are valid for your PLC model.

Do not configure the HMI to write to any PLC memory address which should only be

written to by the PLC.

Troubleshooting Notes:

If the HMI attempts to address an invalid register reference, the HMI may display “PLC No

Response”. Also, the Allen-Bradley PLC itself will set a “MINOR FAULT” error in its

processor status.

If communications are erratic the Logix PLC may not be devoting enough time to the

communication task.

On the Advanced tab of the Controller Properties dialog box, increase the System

Overhead Time Slice percentage.

For Periodic tasks, increase the Period setting and/or lower the Priority.

For more information, refer to the RSLogix5000 documentation.