EtherNet/IP - Getting Started Version: 1.00 (October 2008) Model No.: MAEPGETST-ENG All information contained in this manual is current as of its creation/publication. We reserve the right to change the contents of this manual without warning. The information contained herein is believed to be accurate as of the date of publication; however, Bernecker + Rainer Industrie-Elektronik Ges.m.b.H. makes no warranty, expressed or implied, with regards to the products or the documentation contained within this book. In addition, Bernecker + Rainer Industrie-Elektronik Ges.m.b.H. shall not be liable in the event of incidental or consequential damages in connection with or resulting from the furnishing, performance, or use of these products. The software names, hardware names, and trademarks used in this document are registered by the respective companies. Copyright B&R Subject to change without notice 1
I Table of Contents 1 X20BC0088 Overview... 3 1.1 System Overview...4 1.1.1 LED Status Indicators...5 1.1.2 Node Switches...6 1.2 Supported 3 rd Party Hardware and Software...7 1.2.1 Supported Allen-Bradley CPUs...7 1.2.2 Supported Allen-Bradley Software...7 1.3 Overview of Programming Options...7 2 Default Setup... 8 2.1.1 Step-by-Step Guide to Setting up Bus Controller...9 2.1.2 Configuration and I/O Assembly Explanation...11 2.1.3 Online with RSLogix TM 5000...12 3 FieldbusDESIGNER Setup... 14 3.1.1 Step-by-Step Guide to Setting up Bus Controller...14 3.1.1.1 Overview...14 3.1.1.2 Inserting Allen-Bradley Hardware and Bus Controller...14 3.1.1.3 Configuration of Bus Controller...18 3.1.1.4 Inserting Modules into FieldbusDESIGNER...19 3.1.1.5 Configuration of Modules...22 3.1.1.6 Building a Project...24 3.1.2 Going Online with RSLogix TM 5000...25 3.1.3 Transferring IO into Existing Projects...26 4 Bus Controller Capabilities... 29 4.1.1 Speed and Performance...29 4.1.2 System Size Limits...29 4.1.3 Guidelines for Proper Operation...30 4.2 Optimized Performance...30 4.2.1 Setting Proper RPI and X2X Time...30 5 Module Configuration / Writing to Registers... 33 APPENDIX: Additional Documentation... 35 2 Copyright B&R - Subject to change without notice
1 X20BC0088 Overview The EtherNet/IP TM bus controller (X20BC0088) allow connecting X20-, X67-, and XV-I/O modules to an Allen- Bradley Master (Scanner) with the EtherNet/IP TM protocol. B&R IO can be configured with default module functionality directly with RSLogix TM 5000, or configured using FieldbusDESIGNER. This tool features a comprehensive help system for first time users, and offers a very familiar interface for experienced B&R users. With FieldbusDESIGNER, users can configure modules, get details on I/O mapping, and even create complete project files giving easy access to user defined I/O data points instead of byte arrays. Fieldbus- DESIGNER can be downloaded for free (www.br-automation.com). The EtherNet/IP TM bus controller was created in compliance with the EtherNet/IP TM specification governed by ODVA (Open DeviceNet Vendor Association). When using FieldbusDESIGNER, the default CPU for the generated project is the 1769-L35E CompactLogix Controller. However, the generated project can be used for any Logix platform. This document will provide the programmer with a detailed description of the bus controller including how to setup, configure and diagnose the module. Further information about this module can be obtained from the document list in Section 8: Appendix. Copyright B&R - Subject to change without notice 3
1.1 System Overview FieldbusDESIGNER Allen-Bradley I/O configuration Allen-Bradley CPU I/O device 4 Copyright B&R - Subject to change without notice
1.1.1 LED Status Indicators Figure LED Color Status Description On At least one client is connected Green Blinking Bus controller not yet configured Mod Status 1) On Major unrecoverable fault Red Blinking Major recoverable fault Blinking green/red Initialization / Self test 2) Net Status 1) L / A IF1 L / A IF2 Green Red On Blinking On Blinking green/red Green Blinking Blinking On Off At least one active master (scanner) connection is established No active master (scanner) connection established IP address is not unique Timeout on at least one connection Initialization / Self test The LED blinks when Ethernet activity is present on the bus Connection (link) established, no activity on the bus No physical Ethernet connection exists 1) Mod Status and Net Status LEDs are green/red dual LEDs 2) If this will not stop blinking, there is a configuration issue with your system Copyright B&R - Subject to change without notice 5
1.1.2 Node Switches Station Number 0x00 Function Use the IP address and connection parameters saved into flash memory. 0x01-0x7F The last position of the IP address saved in flash memory is temporarily replaced with the station number. The IP address stored in the flash memory is not changed. 0x80-0xEF IP is temporarily set by DHCP server. DHCP host name is: br + MAC address Example of a default host name: MAC address: 00-60-65-00-49-02 Resulting host name: br006065004902 The IP address stored in the flash memory is not changed. 0xF0-0xFE Reserved. Currently same as 0xFF. 0xFF Boots with default values: IP address: 192.168.100.1 Network mask: 255.255.255.0 Gateway: 192.169.100.254 The IP address stored in the flash memory is not changed. The bus controller can be addressed via Windows NetBIOS service (only if no other routers or gateways are in the way): Primary NetBIOS name is identical to DHCP host name ( br + MAC address) Secondary NetBIOS name is: br + eip + station number (three decimal places) This means that the following secondary NetBIOS name is generated for a station number: e. g. 0xD7 (dec. 215): "breip215" For station number 0x00 the secondary NetBIOS name is identical to DHCP host name. 6 Copyright B&R - Subject to change without notice
1.2 Supported 3 rd Party Hardware and Software The X20BC0088 module adheres to the EtherNet/IP TM specification, so it can operate with any EtherNet/IP TM scanner. All documentation, examples, and FieldbusDESIGNER support is for the RSLogix TM 5000 software using a CompactLogix CPU. 1.2.1 Supported Allen-Bradley CPUs Allen-Bradley CPUs from the Logix family including CompactLogix and ControlLogix, FlexLogix, and DriveLogix. The default processor for FieldbusDESIGNER is the CompactLogix 1769-L35E. 1.2.2 Supported Allen-Bradley Software All functional testing was performed using RSLogix TM 5000 versions 15.01 and 16.03 1.3 Overview of Programming Options There are two options for programming the X20BC0088: Default Setup and FieldbusDESIGNER setup. Default setup allows the programmer to stay within the RSLogix TM 5000 programming environment, and does not require additional software (refer to Section 2: Default Setup). Each module connected behind the bus controller is used in its default configuration and I/O points are manipulated through their respective byte offsets. If configuration of modules beyond their default configuration is needed, it must be done with explicit messages in RSLogix TM 5000, or by directly connecting to the module (e.g. Telnet). FieldbusDESIGNER setup allows the programmer more configuration options. Modules can be configured beyond their default setups and I/O points can be assigned a descriptive name. FieldbusDESIGNER generates an *.L5K file which can be directly imported with RSLogix 5000. Copyright B&R - Subject to change without notice 7
2 Default Setup Default setup is done completely within RSLogix TM 5000 using each X20 and X67 module s internally stored default setup. If necessary, this default setup can be altered later using explicit messages or by directly connecting to the bus controller. This setup mode is recommended for systems which have a limited number of Digital and Analog I/O points, or systems that allow for modules to operate in their default configuration. Additional modules can be added to a system at any time, with no (or very limited) changes to the system required. The following programs are required: RSLogix TM 5000 V15 or V16 (programming) RSLinx TM (online communication) 8 Copyright B&R - Subject to change without notice
2.1.1 Step-by-Step Guide to Setting up Bus Controller Create a new project in RSLogix TM 5000 and insert your Allen-Bradley processor On the Ethernet Port, under Communications, insert a generic Ethernet Module ETHERNET-MODULE Copyright B&R - Subject to change without notice 9
Configure new generic Ethernet module 1) Insert a name 2) Comm Format should be Data SINT (differing settings require adoption of assembly sizes) 3) IP address setup according to Section 1.1.2 Node Switches. 4) Setup Assembly Instance and Size according to Section 2.1.2: Configuration and I/O Assembly Explanation. 10 Copyright B&R - Subject to change without notice
2.1.2 Configuration and I/O Assembly Explanation Configuration Assembly Instance ID Type Description Size in Bytes 100, 0x64 Basis Configuration for the I/O modules 400* * 400 Bytes is the maximum configuration size. When using default setup, the size for the configuration assembly must be set to 0, since no configuration data is sent to the modules. Output Assembly Instance ID Type Description Default Size in Bytes 110, 0x6E Single Analog Output 120 111, 0x6F Single Digital Output 120 112, 0x70 Combination Analog + Digital Output 240 Input Assembly Instance ID Type Description Default Size in Bytes 120, 0x78 Single Analog Input 120 121, 0x79 Single Digital Input 120 122, 0x7A Single Network Status 120 123, 0x7B Single Output Status 120 124, 0x7C Combination Analog Input + Digital Input + Network Status + Output Status 480 Copyright B&R - Subject to change without notice 11
2.1.3 Online with RSLogix TM 5000 When online with the CPU in RSLogix TM 5000, the input and output channels can be accessed through the I/O assembly tags. Digital Outputs: BC0088:O.Data[120] is the offset for digital outputs. The first digital output in the system is addressed to BC0088:O.Data[120].0, the second to BC0088:O.Data[120].1 and so on. Digital Inputs: BC0088:I.Data[120] is the offset for digital inputs. The first digital input in the system is addressed to BC0088:I.Data[120].0, the second to BC0088:I.Data[120].1 and so on. 12 Copyright B&R - Subject to change without notice
Analog Outputs: BC0088:O.Data[0] is the offset for analog outputs. Each analog output is represented by an Integer value, or two SINT values. The first analog output in the system is addressed to SINTs BC0088:O.Data[0] and BC0088:O.Data[1], the second to BC0088:O.Data[2] and BC0088:O.Data[3], and so on. Analog Inputs: BC0088:I.Data[0] is the offset for analog inputs. Each analog input is represented by an Integer value, or two SINT values. The first analog input in the system is addressed to SINTs BC0088:I.Data[0] and BC0088:I.Data[1], the second to BC0088:I.Data[2] and BC0088:I.Data[3], and so on. Copyright B&R - Subject to change without notice 13
3 FieldbusDESIGNER Setup FieldbusDESIGNER is used to configure B&R fieldbus components and provides a programming environment very similar to B&R Automation Studio. Modules can be setup beyond their default configuration, and unique names can be assigned to each module s I/O points. When configuration is complete, a build is performed which generates an *.L5K file. This file can be imported into RSLogix TM 5000. FieldbusDESIGNER is available on the B&R website under section Service Material Related Downloads Automation Software Automation Studio FieldbusDESIGNER : http://www.br-automation.com/cps/rde/xchg/br-productcatalogue/hs.xsl/services_120347_eng_html.htm 3.1.1 Step-by-Step Guide to Setting up Bus Controller 3.1.1.1 Overview The following sections will describe in detail, how to make a project, insert and configure modules, build an *.L5K file, and go online with an Allen-Bradley CPU. The last section will cover how to transfer the setup from one project to another. Transferring between projects will allow the programmer to insert the bus controller into an already existing project, or to transfer the files to a different CPU type. For further information please reference FieldbusDESIGNER help. 3.1.1.2 Inserting Allen-Bradley Hardware and Bus Controller Instructions for inserting Allen-Bradley Hardware are also inside the FieldbusDESIGNER help: 1) Create a new Project 2) Select a Name and Path for the project, and then press next. 14 Copyright B&R - Subject to change without notice
3) Select a Name for the configuration and CPU. Copyright B&R - Subject to change without notice 15
4) Select a CPU module for the new project. The CPU defaults to a CompactLogix. If the CPU needs to be changed, this should be done in RSLogix TM 5000. 5) Open the EtherNet/IP Hardware Tree. Right click on the CPU and select Open EtherNet/IP. 16 Copyright B&R - Subject to change without notice
6) Insert a BC0088 Module. Right click in the EtherNet/IP network and select Insert. 7) Select the BC0088 Module, and enter the station number. Copyright B&R - Subject to change without notice 17
3.1.1.3 Configuration of Bus Controller Instructions for configuring the bus controller are also available inside the FieldbusDESIGNER help: 8) The X20BC0088 module can be configured by right clicking on it in the hardware tree and selecting Open Adapter Configuration. 9) The IP address, X2X Cycle time, IO settings and other options can be set through the adapter configuration. 18 Copyright B&R - Subject to change without notice
3.1.1.4 Inserting Modules into FieldbusDESIGNER More information about Inserting Modules is inside the FieldbusDESIGNER help: More information about the X2X bus is inside the FieldbusDESIGNER help: Copyright B&R - Subject to change without notice 19
10) Open the X2X link to add X20 and X67 modules. Right click on the X20BC0088 module inside the hardware tree and select Open X2X Link. 11) The X2X Link is open and modules can be inserted. 20 Copyright B&R - Subject to change without notice
12) Right click on the X2X link and insert the modules. Copyright B&R - Subject to change without notice 21
3.1.1.5 Configuration of Modules 13) One X20DI8371 Digital Input card and one X20DO8322 Digital Output card have been inserted for this example. 14) IO variable names can be inserted in the PV or Channel Name for each data point. 22 Copyright B&R - Subject to change without notice
15) Each channel has a default name. For instance, the first input channel has the name DigitalInput01 as its default name. If no value is inserted in the PV or Channel Name column, then DigitalInput01 is the name associated with this channel. For this example the variable name Input has been added. Modules can be configured by right clicking on the module within the hardware tree and selecting Open IO Configuration Copyright B&R - Subject to change without notice 23
3.1.1.6 Building a Project 16) Once all modules have been inserted, the project can be built. Press F7 or select the build Icon from the icon menu. 17) Additional information will be provided in the output window following the build. The 4 th line of text for the build, shows the path of the generated *.L5K file. Created RSLogix 5000 project file: C:\projects\TEMP\FBD\MyFirstProject\Output\EthernetIP_CPU1.L5K The IP address, number of modules, Requested packet interval (RPI) time, Assembly sizes, and ZIP compression rate are all shown. If any assembly size exceeds the maximum, a build error will be displayed. ZIP compression rate refers to the compression rate of the configuration assembly. Compressed configuration data allows for more modules per bus controller. This option can be disabled from the Controller Configuration menu shown in Section 3.1.1.3: Configuration of Bus Controller. 24 Copyright B&R - Subject to change without notice
3.1.2 Going Online with RSLogix TM 5000 Locate and Import the *.L5K file into RSLogix TM 5000. Under Data Types User-Defined the Input and Output data types can be found. The variables names provided in the FieldbusDESIGNER project are found here. The Configuration, Input, and Output assemblies can all be found in the Controller Tags section. The following picture shows the controller tags section: copyinpcounter, copyoutcounter, and maincounter are lifecycle counters ST1:C is the configuration assembly ST1:I is the input assembly ST1:O is the output assembly ST1_inp is the input data type tag ST1_out is the output data type tag The ST1_inp is copied to the ST1:I input assembly each cycle in the CopyInputData program of the Main- Task. The ST1:O output assembly is copied to the ST1_out tag in the CopyOutputData program of the MainTask. Copyright B&R - Subject to change without notice 25
3.1.3 Transferring IO into Existing Projects The following steps describe how to transfer the bus controller information between RSLogix TM 5000 projects. This is useful for integrating the bus controller into existing projects, or for switching the CPU. 1) Open a second instance of RSLogix TM 5000. One instance will have the project generated by FieldbusDESIGNER, and the other instance will have a new or existing project. 2) Click the ETHERNET-MODULE ST1 from FieldbusDESIGNER project, drag and drop it into the new project This will copy the BC0088 module and its assemblies into the new project. 26 Copyright B&R - Subject to change without notice
3) If the IO channel names want to be preserved, the User-defined data types must be transferred next. The data types can be transferred the same as the module: by drag and drop between open instances. If access directly to the IO assembly please reference Section 2.1.3 Online with RSLogix TM 5000. 4) Within the Controller tags, define tags for the Input and Output Assemblies. Controller tags, can be defined, or they can be dragged and dropped between instances. Also, transfer the lifecycle counters (copy- InpCounter, copyoutcounter, and maincounter). 5) Transfer the programs between the projects. Programs can be dragged and dropped like the bus controller and data types. Copyright B&R - Subject to change without notice 27
6) Ensure the order stays the same: Copy Inputs, Execute main program, and Copy Outputs. 7) Ensure the IO structures are tied correctly to the copy function blocks. The project is now transferred. 28 Copyright B&R - Subject to change without notice
4 Bus Controller Capabilities 4.1.1 Speed and Performance X2X cycle times as low as 0.5ms can be achieved, as well as RPI as low as 1.0ms. The number of modules behind a bus controller is limited by the X2X cycle time and the size of the configuration assembly. The configuration size can be minimized by grouping similar modules under one bus controller. 4.1.2 System Size Limits The total number of modules behind a bus controller is dependent on the configuration buffer limit of the master and the X2X cycle time. The master is allowed 400 Bytes of configuration data in the configuration buffer. The amount of configuration data required for a module is dependent on the number of configuration registers used per module. If a wide variety of modules are used, the number of modules will be severely limited. If many of the same module type are used, compression of the configuration data allows for more modules. If FieldbusDESIGNER is used to build a system, the size of the configuration, Output, and Input assemblies is given upon successful project build. If more modules are required, they can be split between multiple bus controllers. The bus controller network can have up to a few hundred analog and a few hundred digital I/O modules (253 modules in total). Limits (Set by Allen-Bradley ): Configuration data: 400 Bytes Output Assembly: 496 Bytes Input Assembly: 500 Bytes Each Byte represents 8 digital I/O on a X20DI9371 or an X20DO9322 module. Copyright B&R - Subject to change without notice 29
4.1.3 Guidelines for Proper Operation The following items work without limitations: Standard I/O Modules (X20, X67, XV) All standard DC modules (X20) Node number modules (X20/X67) Switching function models The following items work with limitations: Serial interfaces (X20CS10x0) can only be used behind a bus controller when operated in default bus controller function model called flat stream mode Stepper modules (X20SMxxxx) have to be operated in ramp function model Not supported at this time: B&R NetTime and module functions that use it Special module functions requiring data exchange between module and application w/o handshaking (stream X2X communication) like transmitting scope data with an X20AIx632 see module documenation for more details 4.2 Optimized Performance 4.2.1 Setting Proper RPI and X2X Time The RPI (Request Packet Interval) controls the update rate for the BC0088 module s connection. This value can be changed within RSLogix TM 5000 by right clicking on the Generic Ethernet Module and selecting Properties. The minimum value for RPI is 1 ms, and the default is 10 ms. 30 Copyright B&R - Subject to change without notice
The X2X cycle time can be adjusted in FieldbusDESIGNER under Adapter Configuration or through accessing attribute ID 0x80 of the bus controller object (class 0x64, instance 0x1). The default value is 1ms. After making changes, the bus controller must be restarted for the changes to take effect. X2X Bus Configuration Attribute ID [hex] 0x80 Datatype UINT Access Set Default Value 6 Description The X2X bus cycle time and the data capacity are directly related. The following chart should help the programmer optimize the X2X cycle time. If more modules are required than allowed, either increase the cycle time, or increase the number of bus controllers on the bus. The cycle time can be adjusted in FieldbusDESIGNER, or written to the bus controller directly with the attribute ID and value. Value Cycle Time Description 0 4ms Max 253 IO modules, max. 1400 Byte sync data 1 3.5 ms Max 253 IO modules, max. 1150 Byte sync data 2 3 ms Max 253 IO modules, max. 900 Byte sync data 3 2.5 ms Max 200 IO modules, max. 800 Byte sync data 4 2 ms Max 200 IO modules, max. 500 Byte sync data 5 1.5 ms Max 100 IO modules, max. 450 Byte sync data 6 1 ms Max 80 IO modules, max. 300 Byte sync data 7 0.5 ms Max 40 IO modules, max. 120 Byte sync data Copyright B&R - Subject to change without notice 31
To change the X2X cycle time within FieldbusDESIGNER, right click the X20BC0088 bus controller and select Open Adapter Configuration 32 Copyright B&R - Subject to change without notice
5 Module Configuration / Writing to Registers Modules can be configured by writing to their registers. This allows for dynamic configuration of modules within RSLogix TM 5000 by using explicit messages. Service Code = 0x33 for write command Class = 0x65 for I/O modules Instance = 2 = Module location on rack (See figure below) Attribute = 0 = can be left to 0 for this type of service Source Length = 6 = length of address and data in bytes: address is 2 bytes, data is always 4 bytes Source Element = array of 6 SINT: address is write_data[0 1], data is write_data[2..5] Register addresses and configuration data can be taken from the MAX20REGISTER-ENG and MAX67ENG document. Copyright B&R - Subject to change without notice 33
The MSG function block s configuration is shown below. Configuration registers can be read by calling service 0x32 of the same object: Source Length = 2 = length of register address in bytes Source Element = array of 2 SINT: address is write_data[0 1] The service will return a 4 byte value (the register s data). 34 Copyright B&R - Subject to change without notice
APPENDIX: Additional Documentation MAX20REGISTER-ENG: X20 Module Register Information Document. B&R Website Link: http://www.br-automation.com/cps/rde/xchg/br-productcatalogue/hs.xsl/services_113749_eng_html.htm MAX67-ENG: X67 Module Register Information Document. B&R Website Link: http://www.br-automation.com/cps/rde/xchg/brproductcatalogue/hs.xsl/cookies_allowed.htm?caller=services_87388_eng_html.htm Copyright B&R - Subject to change without notice 35