Allen-Bradley ControlLogix Ethernet Driver Help - Kepware

133 Pages·2016·1.12 MB·English

by  Kepware Technologies

Allen-Bradley ControlLogix Ethernet Driver
© 2022PTCInc.AllRightsReserved.
Allen-BradleyControlLogixEthernetDriver
2
Table of Contents
Allen-BradleyControlLogixEthernet Driver 1
Table of Contents 2
Allen-BradleyControlLogixEthernet Driver 11
Overview 12
Setup 14
ChannelProperties—General 16
TagCounts 17
ChannelProperties—EthernetCommunications 17
ChannelProperties—WriteOptimizations 17
ChannelProperties—Advanced 18
DeviceProperties—General 19
OperatingMode 20
DeviceProperties—ScanMode 20
TagCounts 21
DeviceProperties—Timing 21
DeviceProperties—Auto-Demotion 22
DeviceProperties—TagGeneration 23
DeviceProperties—LogixCommunicationsParameters 25
DeviceProperties—LogixOptions 26
DeviceProperties—LogixDatabaseSettings 27
DeviceProperties—ENIDF1/DH+/CNGatewayCommunicationsParameters 29
BlockWrites 30
DeviceProperties—SLC500SlotConfiguration 30
DeviceProperties—Redundancy 32
SLC500Modular I/OSelectionGuide 33
ConfigurationAPI—Allen-BradleyControlLogixEthernet Example 36
Enumerations 37
DeviceModelEnumerations 38
ConfigurationAPI—SlotConfiguration 39
AutomaticTagDatabase Generation 42
TagHierarchy 42
Controller-to-ServerNameConversions 45
PreparingforAutomaticTagDatabaseGeneration 45
Performance Optimizations 47
OptimizingCommunications 47
OptimizingtheApplication 49
www.ptc.com
3 Allen-BradleyControlLogixEthernet Driver
PerformanceStatisticsandTuning 50
PerformanceTuningExample 51
Data TypesDescription 63
DefaultDataTypeConditions 63
AddressDescriptions 65
LogixAddressing 66
MicroLogixAddressing 67
SLC500FixedI/OAddressing 69
SLC500ModularI/OAddressing 70
PLC-5SeriesAddressing 71
LogixTag-BasedAddressing 73
AddressFormats 74
TagScope 75
InternalTags 76
PredefinedTerm Tags 77
AddressingAtomicDataTypes 77
AddressingStructureDataTypes 79
AddressingSTRINGDataType 79
OrderingofLogixArrayData 80
LogixAdvancedAddressing 82
AdvancedAddressing:BOOL 82
AdvancedAddressing:SINT 84
AdvancedAddressing:INT 86
AdvancedAddressing:DINT 89
AdvancedAddressing:LINT 91
AdvancedAddressing:REAL 93
AdvancedAddressing:USINT 96
AdvancedAddressing:UINT 98
AdvancedAddressing:UDINT 100
AdvancedAddressing:ULINT 102
AdvancedAddressing:LREAL 103
FileListing 105
OutputFiles 105
InputFiles 109
StatusFiles 113
BinaryFiles 113
Timer Files 114
Counter Files 115
www.ptc.com
Allen-BradleyControlLogixEthernetDriver
4
ControlFiles 116
Integer Files 117
FloatFiles 117
ASCIIFiles 118
StringFiles 119
BCDFiles 119
LongFiles 120
MicroLogixPIDFiles 121
PIDFiles 122
MicroLogixMessageFiles 124
MessageFiles 125
BlockTransfer Files 126
FunctionFiles 127
High-SpeedCounter File(HSC) 127
Real-TimeClockFile(RTC) 128
Channel0CommunicationStatusFile(CS0) 129
Channel1CommunicationStatusFile(CS1) 130
I/OModuleStatusFile(IOS) 130
Error Codes 132
EncapsulationErrorCodes 132
CIPErrorCodes 132
0x0001ExtendedError Codes 133
0x001FExtendedError Codes 134
0x00FFExtendedError Codes 134
Event LogMessages 135
Thefollowingerrorsoccurreduploadingcontroller projectfrom device.ResortingtoSymbolic
Protocol. 135
Invalidor corruptcontroller projectdetectedwhilesynchronizing.Synchronizationwillberetried
shortly. 135
Projectdownloaddetectedwhilesynchronizing.Synchronizationwillberetriedshortly. 135
Databaseerror.Datatypefor referencetagunknown.Settingaliastagdatatypetodefault.|
Referencetag='<tag>',Aliastag='<tag>',Defaultdatatype='<type>'. 135
Databaseerror.Member datatypenotfoundintagimportfile.Settingdatatypetodefault.|
Member datatype='<type>',UDT='<type>',Defaultdatatype'<type>'. 136
Databaseerror.Datatypenotfoundintagimportfile.Tagnotadded.| Datatype='<type>',Tag
name='<tag>'. 136
Databaseerror.Error occurredprocessingaliastag.Tagnotadded.| Aliastag='<tag>'. 136
Databaseerror.Encapsulationerror occurredduringregister sessionrequest.| Encapsulation
error =<code>. 137
Databaseerror.Framingerror occurredduringregister sessionrequest. 137
www.ptc.com
5 Allen-BradleyControlLogixEthernet Driver
Databaseerror.Encapsulationerror occurredduringfwd.openrequest.| Encapsulationerror =
<code>. 137
Databaseerror.Framingerror occurredduringforwardopenrequest. 137
Databaseerror.Error occurredduringforwardopenrequest.| CIPerror =<code>,Extended
error =<code>. 137
Databaseerror.Encapsulationerror occurredwhileuploadingprojectinformation.| Encap-
sulationerror =<code>. 137
Databaseerror.Error occurredwhileuploadingprojectinformation.| CIPerror =<code>,Exten-
dederror =<code>. 138
Databaseerror.Framingerror occurredwhileuploadingprojectinformation. 138
Databaseerror.Internalerror occurred. 139
Databaseerror.Encapsulationerror occurredwhileuploadingprogram information.| Program
name='<name>',Encapsulationerror =<code>. 139
Databaseerror.Error occurredwhileuploadingprogram information.| Program name=
'<name>',CIPerror =<code>,Extendederror =<code>. 139
Databaseerror.Framingerror occurredwhileuploadingprogram information.| Program name
='<name>'. 140
Databaseerror.UnabletoresolveCIPdatatypefor tag.Settingtodefaulttype.| CIPdatatype=
<type>,Tagname='<tag>',Defaultdatatype='<type>'. 140
Encapsulationerror occurredwhileuploadingprojectinformation.| Encapsulationerror =
<code>. 140
Error occurredwhileuploadingprojectinformation.| CIPerror =<code>,Extendederror =
<code>. 141
Framingerror occurredwhileuploadingprojectinformation. 141
Encapsulationerror occurredwhileuploadingprogram information.| Program name=
'<name>',Encapsulationerror =<code>. 142
Error occurredwhileuploadingprogram information.| Program name='<name>',CIPerror =
<code>,Extendederror =<code>. 142
Framingerror occurredwhileuploadingprogram information.| Program name='<name>'. 142
Encapsulationerror occurredwhileuploadingcontroller program information.Encapsulation
error =<code>. 142
Error occurredwhileuploadingcontroller program information.CIPerror =<code>,Extended
error =<code>. 142
Framingerror occurredwhileuploadingcontroller program information. 142
CIPconnectiontimedoutwhileuploadingprojectinformation. 142
Databaseerror.CIPconnectiontimedoutwhileuploadingprojectinformation. 142
Databaseerror.Nomoreconnectionsavailablefor fwd.openrequest. 143
Error openingfilefor tagdatabaseimport.| OSerror ='<code>'. 143
Controller notsupported.| Vendor ID=<ID>,Producttype=<type>,Productcode=<code>,
Productname='<name>'. 143
Framereceivedfrom devicecontainserrors. 143
Writerequestfailedduetoaframingerror.| Tagaddress='<address>'. 143
www.ptc.com
Allen-BradleyControlLogixEthernetDriver
6
Readrequestfor tagfailedduetoaframingerror.| Tagaddress='<address>'. 144
Blockreadrequestfailedduetoaframingerror.| Blocksize=<number>(elements),Blockstart
address='<address>'. 144
Blockreadrequestfailedduetoaframingerror.| Blocksize=<number>(bytes),Blockname=
'<name>'. 144
Unabletowritetotag.| Tagaddress='<address>',CIPerror =<code>,Extendederror =
<code>. 145
Unabletoreadtag.| Tagaddress='<address>',CIPerror =<code>,Extendederror =<code>. 145
Unabletoreadblock.| Blocksize=<number>(elements),Blockstartaddress='<address>',CIP
error =<code>,Extendederror =<code>. 145
Unabletoreadblock.| Blocksize=<number>(bytes),Tagname='<tag>',CIPerror =<code>,
Extendederror =<code>. 146
Unabletowritetotag.Controller tagdatatypeunknown.| Tagaddress='<address>',Datatype
=<type>. 146
Unabletoreadtag.Controller tagdatatypeunknown.Tagdeactivated.| Tagaddress=
'<address>',Datatype=<type>. 146
Unabletoreadblock.Controller tagdatatypeunknown.Blockdeactivated.| Blocksize=<num-
ber>(elements),Blockstartaddress='<address>',Datatype=<type>. 146
Unabletowritetotag.Datatypenotsupported.| Tagaddress='<address>',Datatype=
'<type>'. 147
Unabletoreadtag.Datatypenotsupported.Tagdeactivated.| Tagaddress='<address>',Data
type='<type>'. 147
Unabletoreadblock.Datatypenotsupported.Blockdeactivated.| Blocksize=<number>(ele-
ments),Blockstartaddress='<address>',Datatype='<type>'. 147
Unabletowritetotag.Datatypeisillegalfor thistag.| Tagaddress='<address>',Datatype=
'<type>'. 148
Unabletoreadtag.Datatypeisillegalfor thistag.Tagdeactivated| Tagaddress='<address>',
Datatype='<type>'. 148
Unabletoreadblock.Datatypeisillegalfor thisblock.Blockdeactivated.| Blocksize=<num-
ber>(elements),Blockstartaddress='<address>',Datatype='<type>'. 148
Unabletowritetotag.Tagdoesnotsupportmulti-elementarrays.| Tagaddress='<address>'. 149
Unabletoreadtag.Tagdoesnotsupportmulti-elementarrays.Tagdeactivated.| Tagaddress
='<address>'. 149
Unabletoreadblock.Blockdoesnotsupportmulti-elementarrays.Blockdeactivated.| Block
size=<number>(elements),Blockstartaddress='<address>'. 149
Unabletowritetotag.Nativetagsizemismatch.| Tagaddress='<address>'. 150
Unabletoreadtag.Nativetagsizemismatch.| Tagaddress='<address>'. 150
Unabletoreadblock.Nativetagsizemismatch.| Blocksize=<number>(elements),Blockstart
address='<address>'. 150
Unabletoreadblock.Nativetagsizemismatch.| Blocksize=<number>(bytes),Blockname=
'<name>'. 151
Unabletowritetotag.| Tagaddress='<address>'. 151
Unabletoreadtag.Tagdeactivated.| Tagaddress='<address>'. 151
www.ptc.com
7 Allen-BradleyControlLogixEthernet Driver
Unabletoreadblock.Blockdeactivated.| Blocksize=<number>(elements),Blockstart
address='<address>'. 152
Unabletoreadblock.Blockdeactivated.| Blocksize=<number>(bytes),Tagname='<tag>'. 152
Error occurredduringarequesttodevice.| CIPerror =<code>,Extendederror =<code>. 153
Encapsulationerror occurredduringarequesttodevice.| Encapsulationerror =<code>. 153
Memorycouldnotbeallocatedfor tag.| Tagaddress='<address>'. 153
Unabletoreadblock.Framereceivedcontainserrors.| Blocksize=<number>(elements),Start-
ingaddress='<address>'. 154
Unabletoreadfunctionfilefrom device.Framereceivedcontainserrors.| Functionfile=
'<name>'. 154
Unabletoreadblock.Tagsdeactivated.| Blocksize=<number>(elements),Startingaddress=
'<address>',DF1status=<code>,Extendedstatus=<code>. 154
Unabletoreadfunctionfilefrom device.Tagsdeactivated.| Functionfile='<name>',DF1status
=<code>,Extendedstatus=<code>. 155
Unabletowritetoaddress.Framereceivedcontainserrors.| Address='<address>'. 155
Unabletowritetofunctionfile.Framereceivedcontainserrors.| Functionfile='<name>'. 155
Unabletoreadblock.| Blocksize=<number>(elements),Startingaddress='<address>',DF1
status=<code>,Extendedstatus=<code>. 155
Unabletoreadfunctionfile.| Functionfile='<name>',DF1status=<code>,Extendedstatus=
<code>. 156
Unabletoreadblock.Tagsdeactivated.| Blocksize=<number>(elements),Startingaddress=
'<address>',DF1status=<code>,Extendedstatus=<code>. 156
Unabletoreadfunctionfile.Tagsdeactivated.| Functionfile='<name>',DF1status=<code>. 157
Unabletowritetoaddress.| Address='<address>',DF1status=<code>,Extendedstatus=
<code>. 157
Unabletowritetofunctionfile.| Functionfile='<name>',DF1status=<code>,Extendedstatus
=<code>. 158
Unabletoreadblock.| Blocksize=<number>(elements),Startingaddress='<address>',DF1
status=<code>. 158
Unabletoreadfunctionfile.| Functionfile='<name>',DF1status=<code>. 159
Unabletowritetoaddress.| Address='<address>',DF1status=<code>. 159
Unabletowritetofunctionfile.| Functionfile='<name>',DF1status=<code>. 159
Unabletoreadtag.Internalmemoryisinvalid.| Tagaddress='<address>'. 160
Unabletoreadtag.Datatypeisillegalfor thistag.| Tagaddress='<address>',Datatype=
'<type>'. 160
Unabletoreadblock.Internalmemoryisinvalid.Tagdeactivated.| Tagaddress='<address>'. 160
Unabletoreadblock.Internalmemoryisinvalid.Blockdeactivated.| Blocksize=<number>(ele-
ments),Blockstartaddress='<address>'. 161
Unabletowritetoaddress.Internalmemoryisinvalid.| Tagaddress='<address>'. 161
Unabletoreadblock.Blockdeactivated.| Blocksize=<number>(elements),Blockstart
address='<address>',CIPerror =<code>,Extendederror =<code>. 161
Devicenotresponding.Localnoderespondedwitherror.| DF1status=<code>. 161
www.ptc.com
Allen-BradleyControlLogixEthernetDriver
8
Unabletowritetofunctionfile.Localnoderespondedwitherror.| Functionfile='<name>',DF1
status=<code>. 161
Unabletowritetoaddress.Localnoderespondedwitherror.| Functionfile='<name>',DF1
status=<code>. 162
Unexpectedoffsetencounteredfor tag.TagwilluseSymbolicprotocol.| Tagaddress=
'<address>'. 162
Unexpectedoffsetencounteredfor tag.| Tagaddress='<address>'. 162
Unexpectedoffset/spanencounteredfor tag.| Tagaddress='<address>'. 162
Projectdownloadinprogressor noprojectexists. 162
Projectdownloadcomplete. 163
Projectonlineeditdetected.CurrentlyusingSymbolicaddressing. 163
Projectofflineeditdetected.CurrentlyusingSymbolicaddressing. 163
Thefollowingerrorsoccurreduploadingcontroller projectfrom device.Resortingtosymbolic
protocol. 163
Unabletoretrievetheidentityfor device.AlltagswilluseSymbolicProtocol.| Encapsulation
error =<code>. 163
Unabletoretrievetheidentityfor device.AlltagswilluseSymbolicProtocol.| CIPerror =
<code>,Extendederror =<code>. 163
Unabletoretrievetheidentityfor device.Framereceivedcontainserrors.AlltagswilluseSym-
bolicProtocol. 164
RequestedCIPconnectionsizeisnotsupportedbythisdevice.Automaticallyfallingbacktomax.
size.| Requestedsize=<number>(bytes),Max.size=<number>(bytes). 164
Thetagimportfilenameisinvalid,filepathsarenotallowed. 164
Read/Writerequeststodevicestopped.UpdatingLogicalAddressesfrom deviceproject. 165
Read/Writerequeststodeviceresumed.UpdatingLogicalAddressesfrom devicecomplete.Cur-
rentlyusingLogicaladdressing. 165
Databasestatus.Importingnon-aliastags. 165
Databasestatus.Importingaliastags. 165
Databasestatus.Buildingtagprojects,pleasewait.| Tagprojectcount=<number>. 165
Databaseerror.Tagrenamedbecauseitexceedsmax.character length.| Tagname='<tag>',
Max.length=<number>,Newtagname='<tag>'. 165
Databaseerror.Arraytagsrenamedbecausetheyexceedmax.character length.| Arraytags=
'<tags>',Max.length=<number>,Newarraytags='<tags>'. 165
Databaseerror.Program groupnameexceedsmax.character length.Program grouprenamed.
| Groupname='<name>',Max.length=<number>,Newgroupname='<name>'. 165
Databasestatus.Retrievingcontroller project. 166
Databasestatus.| Program count=<number>,Datatypecount=<number>,Importedtag
count=<number>. 166
Databasestatus.GeneratingOPCtags. 166
Lowmemoryresources. 166
Unknownerror occurred. 166
Databasestatus.Importingtagsfrom .L5Xfile.| Schemarevision='<value>',Softwarerevision 166
www.ptc.com
9 Allen-BradleyControlLogixEthernet Driver
='<value>'.
Details.| IP='<address>',Vendor ID=<vendor>,Producttype=<type>,Productcode=<code>,
Revision=<value>,Productname='<name>',ProductS/N=<number>. 166
Elapsedtime=<number>(seconds). 166
Symbolicdevicereads=<number>. 166
Symbolic,arrayblockdevicereads=<number>. 167
Symbolic,arrayblockcachereads=<number>. 167
Symbolinstancenon-blockdevicereads=<number>. 167
Symbolinstancenon-block,arrayblockdevicereads=<number>. 167
Symbolinstancenon-block,arrayblockcachereads=<number>. 167
Symbolinstanceblockdevicereads=<number>. 167
Symbolinstanceblockcachereads=<number>. 167
Physicalnon-blockdevicereads=<number>. 167
Physicalnon-block,arrayblockdevicereads=<number>. 167
Physicalnon-block,arrayblockcachereads=<number>. 167
Physicalblockdevicereads=<number>. 167
Physicalblockcachereads=<number>. 168
Tagsread=<number>. 168
Packetssent=<number>. 168
Packetsreceived=<number>. 168
Initializationtransactions=<number>. 168
Read/Writetransactions=<number>. 168
Avg.packetssent/sec=<number>. 168
Avg.packetsreceived/sec=<number>. 168
Avg.tagreads/sec=<number>. 168
Avg.tags/transaction=<number>. 168
----------------------------------------------------------------------------------------------------- 169
%s| DEVICESTATISTICS 169
Avg.deviceturn-aroundtime=<number>(milliseconds) 169
%s| CHANNELSTATISTICS 169
DRIVERSTATISTICS 169
Devicetagimportaborted. 169
Importfile'%s'notfoundatpath'%s'. 169
Errorsoccurredretrievingcontroller project. 169
Internaldriver error occurred. 169
Invalidor corruptcontroller projectdetectedwhilesynchronizing.Tryagainlater. 169
Projectdownloaddetectedwhilesynchronizing.Tryagainlater. 170
Lowmemoryresources. 170
L5Kfileisinvalidor corrupt. 170
www.ptc.com
Allen-BradleyControlLogixEthernetDriver
10
Unknownerror occurred. 170
Databaseerror.PLC5/SLC/MicroLogixdevicesdonotsupportthisfunction. 170
L5Xfileisinvalidor corrupt. 170
Importfile'<empty>'notfoundatpath'<empty>'. 170
Importfile'%s'notfoundatpath'<empty>'. 170
Importfile'<empty>'notfoundatpath'%s'. 170
XMLelementfailedpost-schemavalidation.Importingtagsfrom deviceisnotsupportedfor
model.Usealternativeelement.| XMLelement='{<namespace>}<element>',Unsupported
model='<model>',AlternativeXMLelement='{<namespace>}<element>'. 170
Valuenotsupportedfor anXMLelementonthismodel.Automaticallysettingtonewvalue.|
Value='<value>',XMLelement='{<namespace>}<element>',Model='<model>',Newvalue=
'<value>'. 171
Appendices 172
Allen-BradleyControlLogixEthernet ChannelProperties 172
Allen-BradleyControlLogixEthernet DeviceProperties 172
Allen-BradleyControlLogixEthernet TagProperties 175
LogixDeviceIDs 176
CompactLogix5300Ethernet DeviceID 176
1761-NET-ENISetup 178
DataHighwayPlusGatewaySetup 178
ControlNet™GatewaySetup 179
EtherNet/IPGatewaySetup 181
SerialGatewaySetup 182
MicroLogix1100Setup 183
CommunicationsRouting 183
ConnectionPathSpecification 183
RoutingExamples 185
ChoosingaProtocolMode 188
DetectingaChangeintheControllerProject 190
SoftLogix5800ConnectionNotes 191
Index 193
www.ptc.com