Allen-Bradley ControlLogix Ethernet Driver Help

133 Pages·2016·1.12 MB·English

by  Kepware Technologies

Allen-Bradley ControlLogix
Ethernet Driver
©2016 Kepware, Inc.
Allen-Bradley ControlLogix Ethernet Driver
2
Table of Contents
Table of Contents 2
Allen-BradleyControlLogixEthernetDriver 7
Overview 8
Device Setup 9
CommunicationsRouting 10
ConnectionPathSpecification 11
RoutingExamples 12
LogixDeviceIDs 14
CompactLogix5300EthernetDeviceID 15
LogixCommunicationsParameters 17
LogixOptions 18
LogixDatabaseSettings 20
LogixDatabaseOptions 21
LogixDatabaseFiltering 22
1761-NET-ENISetup 22
DataHighwayPlusGatewaySetup 23
ControlNetGatewaySetup 24
EtherNet/IPGatewaySetup 25
SerialGatewaySetup 25
MicroLogix1100Setup 26
ENIDF1/DH+/ControlNetGatewayCommunicationsParameters 27
SLC500SlotConfiguration 28
SLC500ModularI/OSelectionGuide 29
Performance Optimizations 31
OptimizingCommunications 31
OptimizingtheApplication 33
PerformanceStatisticsandTuning 34
PerformanceTuningExample 35
Data Types Description 48
Address Descriptions 49
LogixAddressing 49
MicroLogixAddressing 50
SLC500FixedI/OAddressing 52
SLC500ModularI/OAddressing 52
PLC-5SeriesAddressing 53
LogixTag-BasedAddressing 54
AddressFormats 55
TagScope 56
InternalTags 57
PredefinedTermTags 57
AddressingAtomicDataTypes 57
AddressingStructureDataTypes 58
AddressingSTRINGDataType 58
OrderingofLogixArrayData 59
LogixAdvancedAddressing 60
AdvancedAddressing:BOOL 60
AdvancedAddressing:SINT 62
www.kepware.com
Allen-Bradley ControlLogix Ethernet Driver
3
AdvancedAddressing:INT 63
AdvancedAddressing:DINT 65
AdvancedAddressing:LINT 67
AdvancedAddressing:REAL 68
FileListing 70
OutputFiles 71
InputFiles 73
StatusFiles 76
BinaryFiles 77
TimerFiles 77
CounterFiles 78
ControlFiles 78
IntegerFiles 79
FloatFiles 79
ASCIIFiles 80
StringFiles 81
BCDFiles 81
LongFiles 81
MicroLogixPIDFiles 82
PIDFiles 83
MicroLogixMessageFiles 84
MessageFiles 85
BlockTransferFiles 85
FunctionFileListing 86
High-SpeedCounterFile(HSC) 86
Real-TimeClockFile(RTC) 87
Channel0CommunicationStatusFile(CS0) 88
Channel1CommunicationStatusFile(CS1) 88
I/OModuleStatusFile(IOS) 89
Automatic Tag Database Generation 90
TagHierarchy 90
Controller-to-ServerNameConversions 92
PreparingforAutomaticTagDatabaseGeneration 92
Error Codes 94
EncapsulationErrorCodes 94
CIPErrorCodes 94
0x0001ExtendedErrorCodes 95
0x001FExtendedErrorCodes 95
0x00FFExtendedErrorCodes 95
Error Descriptions 97
AddressValidationErrors 97
Address<address>isoutofrangeforthespecifieddeviceorregister. 97
Arraysizeisoutofrangeforaddress<address>. 97
Arraysupportisnotavailableforthespecifiedaddress:<address>. 97
Datatype<type>isnotvalidfordeviceaddress<address>. 98
Deviceaddress<address>containsasyntaxerror. 98
Deviceaddress<address>isnotsupportedbymodel<modelname>. 98
Deviceaddress<address>isreadonly. 98
Memorycouldnotbeallocatedfortagwithaddress<address>ondevice<devicename>. 99
Missingaddress 99
CommunicationErrors 99
www.kepware.com
Allen-Bradley ControlLogix Ethernet Driver
4
Socketerror<code>occurredon<devicename>.Operation<operationname>failedbecause
<reason>. 99
Unabletobindtoadapter:<adapter>.Connectfailed. 100
Winsockinitializationfailed(OSerror=n). 100
WinsockV1.1orhighermustbeinstalledtousetheAllen-BradleyControlLogixEthernetDriver. 100
Device-SpecificErrorMessages 100
Allen-BradleyControlLogixEthernet<Device>:CIPconnectionsize<requested>isnotsupportedby
thisdevice.Automaticallyfallingbackto500bytes. 101
Device<devicename>isnotresponding. 101
Encapsulationerroroccurredduringarequesttodevice<devicename>.[Encap.error=<code>]. 101
erroroccurredduringarequesttodevice<devicename>.[CIPerror=<code>,Ext.
error=<code>]. 102
Framereceivedfromdevice<devicename>containserrors. 102
Unabletoretrievetheidentityfordevice<device>.[CIPerror=<error>,Ext.error=<error>].All
tagswilluseSymbolicProtocolMode. 102
Unabletoretrievetheidentityfordevice<device>.[Encap.error=<error>].Alltagswilluse
SymbolicProtocolMode. 102
Unabletoretrievetheidentityfordevice<device>.Framereceivedcontainserrors.Alltagswilluse
SymbolicProtocolMode. 103
ControlLogix-SpecificErrorMessages 103
ReadErrors(Non-Blocking) 103
Readrequestfortag<tagaddress>ondevice<devicename>failedduetoaframingerror.Tag
deactivated. 104
Unabletoread<tagaddress>ondevice<devicename>.Tagdeactivated. 104
Unabletoreadtag<tagaddress>ondevice<devicename>.[CIPerror=<code>,Ext.
error=<code>]. 104
Unabletoreadtag<tagaddress>ondevice<devicename>.Controllertagdatatype<type>
unknown.Tagdeactivated. 104
Unabletoreadtag<tagaddress>ondevice<devicename>.Datatype<type>isillegalforthis
tag.Tagdeactivated. 105
Unabletoreadtag<tagaddress>ondevice<devicename>.Datatype<type>notsupported.Tag
deactivated. 105
Unabletoreadtag<tagaddress>ondevice<devicename>.Tagdoesnotsupportmulti-element
arrays.Tagdeactivated. 105
ReadErrors(Blocking) 105
Readrequestfor<count>element(s)startingat<tagaddress>ondevice<devicename>failed
duetoaframingerror.Blockdeactivated. 106
Unabletoread<count>element(s)startingat<tagaddress>ondevice<devicename>.Block
deactivated. 106
Unabletoread<count>element(s)startingat<tagaddress>ondevice<devicename>.[CIP
error=<code>,Ext.error=<code>]. 106
Unabletoread<count>element(s)startingat<address>ondevice<device>.Controllertagdata
type<type>unknown.Blockdeactivated. 107
Unabletoread<count>element(s)startingat<address>ondevice<device>.Datatype<type>
isillegalforthisblock. 107
Unabletoread<count>element(s)startingat<address>ondevice<device>.Datatype<type>
notsupported. 107
Unabletoread<count>element(s)startingat<tagaddress>ondevice<devicename>.Block
doesnotsupportmulti-elementarrays.Blockdeactivated. 107
WriteErrors 108
Unabletowriteto<tagaddress>ondevice<devicename>. 108
Unabletowritetotag<tagaddress>ondevice<devicename>.[CIPerror=<code>,Ext.
Status=<code>]. 108
Unabletowritetotag<tagaddress>ondevice<devicename>.Controllertagdatatype<type>
unknown. 109
Unabletowritetotag<tagaddress>ondevice<devicename>.Datatype<type>isillegalforthis 109
www.kepware.com
Allen-Bradley ControlLogix Ethernet Driver
5
tag.
Unabletowritetotag<tagaddress>ondevice<devicename>.Datatype<type>notsupported. 109
Unabletowritetotag<tagaddress>ondevice<devicename>.Tagdoesnotsupportmulti-
elementarrays. 109
Writerequestfortag<tagaddress>ondevice<devicename>failedduetoaframingerror. 110
ProjectSynchronizationErrors 110
Encapsulationerroroccurredwhileuploadingprojectinformation.[Encap.error=<code>]. 110
Erroroccurredwhileuploadingprojectinformation.[CIPerror=<code>,Ext.error=<code>]. 110
Framingerroroccurredwhileuploadingprojectinformation. 111
Invalidorcorruptcontrollerprojectdetectedwhilesynchronizing.Synchronizationwillberetried
shortly. 111
Lowmemoryresources. 111
Projectdownloaddetectedwhilesynchronizing.Synchronizationwillberetriedshortly. 112
Unabletoread<element>element(s)startingat<address>ondevice<devicename>.Nativetag
sizemismatch. 112
Unabletoreadtag<tagname>ondevice<devicename>.Nativetagsizemismatch. 112
Unabletowritetotag<tagname>ondevice<devicename>.Nativetagsizemismatch. 112
ENI/DH+/ControlNetGatewaySpecificErrorMessages 112
Device<devicename>isnotresponding.Localnoderespondedwitherror[DF1STS=<value>]. 113
Unabletoread<blocksize>element(s)startingat<address>ondevice<devicename>.[DF1
STS=<value>,EXTSTS=<value>].Tag(s)deactivated. 113
Unabletoread<blocksize>element(s)startingat<address>ondevice<devicename>.Frame
receivedcontainserrors. 113
Unabletowritetoaddress<address>ondevice<devicename>.[DF1STS=<value>,EXT
STS=<value>]. 114
Unabletowritetoaddress<address>ondevice<devicename>.Framereceivedcontainserrors. 114
Unabletowritetoaddress<address>ondevice<devicename>.Localnoderespondedwitherror
[DF1STS=<value>]. 114
Unabletowritetofunctionfile<address>ondevice<devicename>.Localnoderespondedwith
error[DF1STS=<value>]. 115
AutomaticTagDatabaseGenerationErrors 115
Databaseerror:Arraytags<orig.tagname><dimensions>exceed31characters.Tagsrenamedto
<newtagname><dimensions>. 115
Databaseerror:Datatype<type>fortag<tagname>notfoundintagimportfile.Tagnotadded. 116
Databaseerror:DatatypeforRef.Tag<tagname>unknown.SettingAliastag<tagname>data
typetoDefault(<type>). 116
Databaseerror:ErroroccurredprocessingAliastag<tagname>.Tagnotadded. 116
Databaseerror:Memberdatatype<type>forUDT<UDTname>notfoundintagimportfile.Setting
toDefaulttype<type>. 116
Databaseerror:Programgroup<orig.programname>exceeds31characters.Programgroup
renamedto<newprogramname>. 117
Databaseerror:Tag<orig.tagname>exceeds31characters.Tagrenamedto<newtagname>. 117
Databaseerror:UnabletoresolveCIPdatatype<hexvalue>fortag<tagname>.Settingtodefault
type<logixdatatype>. 117
Invalidorcorruptcontrollerprojectdetectedwhilesynchronizing.Tryagainlater. 117
Projectdownloaddetectedwhilesynchronizing.Tryagainlater. 118
Unabletogenerateatagdatabasefordevice<devicename>.Reason:Importfilenotfound. 118
Unabletogenerateatagdatabasefordevice<devicename>.Reason:L5Kfileisinvalidorcorrupt. 118
Unabletogenerateatagdatabasefordevice<devicename>.Reason:Lowmemoryresources. 118
Reference Material 119
Choosing a Protocol Mode 120
DetectingaChangeintheControllerProject 121
SoftLogix5800ConnectionNotes 123
Glossary 124
www.kepware.com
Allen-Bradley ControlLogix Ethernet Driver
6
Index 126
www.kepware.com
Allen-Bradley ControlLogix Ethernet Driver
7
Allen-Bradley ControlLogix Ethernet Driver
Helpversion1.117
CONTENTS
Overview
WhatistheAllen-BradleyControlLogixEthernetDriver?
DeviceSetup
HowdoIconfigureadeviceforusewiththisdriver?
CommunicationsRouting
HowdoIcommunicatewitharemoteControlLogix5000processoror1756-DHRIO/1756-CNBInterfaceModule?
PerformanceOptimizations
HowdoIgetthebestperformancefromtheAllen-BradleyControlLogixEthernetDriver?
DataTypesDescription
Whatdatatypesdoesthisdriversupport?
AddressDescriptions
HowdoIaddressatagonaAllen-BradleyControlLogixEthernetdevice?
AutomaticTagDatabaseGeneration
HowcanIeasilyconfiguretagsfortheAllen-BradleyControlLogixEthernetDriver?
ErrorDescriptions
Whaterrormessagesdoesthedriverproduce?
ErrorCodes
WhataretheAllen-BradleyControlLogixEtherneterrorcodes?
ReferenceMaterial
WherecanIfindadditionalinformationrelatingtotheAllen-BradleyControlLogixEthernetDriver?
www.kepware.com
Allen-Bradley ControlLogix Ethernet Driver
8
Overview
TheAllen-BradleyControlLogixEthernetDriverprovidesaneasyandreliablewaytoconnectAllen-Bradley
ControlLogixEthernetcontrollerstoOPCclientapplications,includingHMI,SCADA,Historian,MES,ERP,and
countlesscustomapplications.
SupportedAllen-Bradley Controllers
ControlLogix® 5500 Series
CommunicationswithControlLogixcanbeaccomplishedthroughanEtherNet/IPcommunicationmodulefor
Ethernetcommunicationsorthrougha1761-NET-ENImoduleforEthernet-to-serialcommunicationsusingthe
controller'sserialport.
CompactLogix™ 5300 Series
EthernetcommunicationswithCompactLogixrequiresaprocessorwithabuilt-inEtherNet/IPportsuchasthe
1769-L35E.CommunicationswithCompactLogixotherwiserequiresa1761-NET-ENImoduleforEthernet-to-
serialcommunicationsusingthecontroller'sserialport.
FlexLogix5400 Series
CommunicationswithFlexLogixcanbeaccomplishedthrougha1788-ENBTdaughtercardforEthernet
communicationsorthrougha1761-NET-ENImoduleforEthernet-to-serialcommunicationsusingthecontroller's
serialport.
SoftLogix5800
ThedriversupportstheAllen-BradleySoftLogix5800SeriesControllerandrequiresanEthernetcardinthe
SoftLogixPC.
DataHighway PlusGateway
ThedriversupportsthePLC-5SeriesandSLC500SerieswithaDataHighwayPlusinterface.Thisis
accomplishedthroughaDH+gatewayandrequiresoneoftheaforementionedPLCs,anEtherNet/IP
communicationmodule,anda1756-DHRIO-interfacemodule(bothresidingintheControlLogixrack).
ControlNetGateway
ThedriversupportsthePLC-5CSeries.ThisisaccomplishedthroughaControlNetgatewayandrequiresthe
aforementionedPLC,anEtherNet/IPcommunicationmodule,anda1756-CNB/CNBRinterfacemodule(both
residingintheControlLogixrack).
1761-NET-ENI
Thedriversupportscommunicationswiththe1761-NET-ENIdevice.TheENIdeviceaddsextraflexibilityin
devicenetworkingandcommunicationsbyprovidinganEthernet-to-serialinterfaceforbothFullDuplexDF1
controllersandLogixcontrollers.InconjunctionwiththeENIdevice,thisdriversupportsthefollowing:
ControlLogix5500Series*
l
CompactLogix5300Series*
l
FlexLogix5400Series*
l
MicroLogixSeries
l
SLC500FixedI/OProcessor
l
SLC500ModularI/OSeries
l
PLC-5Series
l
*Thesemodelsrequire1761-NET-ENISeriesBorhigher.
MicroLogix1100
ThedriversupportscommunicationswiththeMicroLogix1100(CH1Ethernet)usingEtherNet/IP.
ControlLogixisaregisteredtrademarksofAllen-BradleyCompany,LLC.
CompactLogixisatrademarksofRockwellAutomation,Inc.
Alltrademarksarethepropertyoftheirrespectiveowners.
www.kepware.com
Allen-Bradley ControlLogix Ethernet Driver
9
Device Setup
SupportedDevices
Device Communications
ControlLogix5550/5553/5555/5561/5562/ Via1756-ENBT/ENET/EN2F/EN2T/EN2TR/
5563/5564/5565/5571/5572/5573/5574/ EN3TR/EWEB/EN2TXTEthernetmodule
5575/5585processors
ViaSerialGateway
Via1761-NET-ENISeriesBorhigherusingChannel
0(serial)
CompactLogix5320/5323/5330/5331/5332/ Built-inEthernet/IPportonprocessorswithEsuffix*
5335/5343/5345/5370
ViaSerialGateway
Via1761-NET-ENISeriesBorhigherusingChannel
0(serial)
FlexLogix5433/5434processors Via1788-ENBTEthernetdaughtercard
ViaSerialGateway
Via1761-NET-ENISeriesBorhigherusingChannel
0(serial)
SoftLogix5810/5830/5860processors ViaSoftLogixEthernet/IPMessagingmodule
ViaSerialGateway
MicroLogix1000/1200/1500 Via1761-NET-ENI
ViaEtherNet/IPGateway
MicroLogix1100/1400 ViaMicroLogix1100/1400Channel1(Ethernet)
Via1761-NET-ENI
ViaEtherNet/IPGateway
SLC500FixedI/OProcessor Via1761-NET-ENI
ViaEtherNet/IPGateway
SLC500ModularI/OProcessors(SLC5/01,SLC5/02, ViaDH+Gateway**
SLC5/03,SLC5/04,SLC5/05)
Via1761-NET-ENI
ViaEtherNet/IPGateway
PLC-5series(excludingthePLC5/250series) ViaDH+Gateway
Via1761-NET-ENI
ViaEtherNet/IPGateway
PLC-5/20C,PLC-5/40C,PLC-5/80C ViaControlNetGateway
Via1761-NET-ENI
ViaEtherNet/IPGateway
*Forexample,1769-L35E.
**ThisdriversupportsanySLC500seriesPLCthatsupportsDH+orthatcanbeinterfacedtoaDH+network
(suchastheKF2interfacemodule).
Firmware Versions
Device Version
ControlLogix5550(1756-L1) 11.35-13.34
ControlLogix5553(1756-L53) 11.28
ControlLogix5555(1756-L55) 11.32-16.04
www.kepware.com
Allen-Bradley ControlLogix Ethernet Driver
10
Device Version
ControlLogix5561(1756-L61) 12.31-20.11
ControlLogix5562(1756-L62) 12.31-20.11
ControlLogix5563(1756-L63) 11.26-20.11
ControlLogix5564(1756-L64) 16.03-20.11
ControlLogix5565(1756-L65) 16.03-20.11
ControlLogix5571(1756-L71) 20.11-28.011
ControlLogix5572(1756-L72) 19.11-28.011
ControlLogix5573(1756-L73) 18.12-28.011
ControlLogix5574(1756-L74) 19.11-28.011
ControlLogix5575(1756-L75) 18.12-28.011
ControlLogix5583(1756-L83) 28.011
ControlLogix5585(1756-L85) 28.011
CompactLogix5370(1769-L1) 20.11-28.011
CompactLogix5370(1769-L2) 20.11-28.011
CompactLogix5370(1769-L3) 20.11-28.011
CompactLogix5320(1769-L20) 11.27-13.18
CompactLogix5323(1769-L23) 17.05-20.11
CompactLogix5330(1769-L30) 11.27-13.18
CompactLogix5331(1769-L31) 16.22-20.11
CompactLogix5332(1769-L32) 16.22-20.11
CompactLogix5335(1769-L35) 16.22-20.11
CompactLogix5343(1768-L43) 15.07-20.11
CompactLogix5345(1768-L45) 16.24-20.11
ControlLogix5380(5069-L3) 28.011
FlexLogix5433(1794-L33) 11.25-13.33
FlexLogix5434(1794-L34) 11.25-16.02
SoftLogix5800(1789-L60) 16.00-20.01
ControlLogix,CompactLogix,andFlexLogixSerial 1761-NET-ENISeriesBorhigherorSerial
Communications Gateway
MicroLogix1100(1763-L16AWA/BWA/BBB) 1.1
Communication Protocol
TheCommunicationsProtocolisEtherNet/IP(CIPoverEthernet)usingTCP/IP.
LogixandGateway Models
LogixandGatewaymodelssupportthefollowing:
ConnectedMessaging
l
SymbolicReads
l
SymbolicWrites
l
SymbolInstanceReads(V21orhigher)
l
Physical(DMA)Reads(V20orlower)
l
SymbolInstanceWrites
l
ENI Models
ENI modelssupportunconnectedmessaging.
Communications Routing
Routingprovidesawaytocommunicatewitharemotedeviceovervariousnetworks.Itcanbethoughtofasa
bridgebetweenthelocaldeviceandaremotedeviceeveniftheyareontwodifferentfieldbusnetworks.Access
toaremote(destination)backplaneallowsfordirectcommunicationwiththesupportedmoduleslocatedonthis
backplane.Supportedmodulesincludethefollowing:
ControlLogix5500processorforControlLogixapplications.
l
SoftLogix5800processorforSoftLogixapplications.
l
1756-DHRIOinterfacemoduleforDH+Gatewayapplications.
l
1756-CNBor1756-CNBRinterfacemoduleforControlNetGatewayapplications.
l
www.kepware.com