EtherNet/IP Communications Module M/N RECOMM-ENET Firmware Version 2.xxx Firmware Version 3.
The information in this manual is subject to change without notice. Throughout this manual, the following notes are used to alert you to safety considerations: ! ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic loss. Important: Identifies information that is critical for successful application and understanding of the product. ! ATTENTION: The drive may contain high voltages that can cause injury or death.
CONTENTS Chapter 1 Introduction 1.1 Module Features............................................................ 1-1 1.2 Compatible Products ..................................................... 1-2 1.3 Related Documentation ................................................. 1-2 1.4 Getting Assistance from Reliance Electric..................... 1-3 Chapter 2 Getting Started 2.1 Required Equipment ...................................................... 2-2 2.2 Installation Checklist .........................
.10 Setting Web Access Control ........................................ 4-19 4.11 Resetting the Module ................................................... 4-21 4.12 Viewing the Module Configuration ............................... 4-22 Chapter 5 Configuring the Scanner or Bridge 5.1 Configuring a Simple Network: An Example .................. 5-1 5.2 Adding a Bridge or Scanner to the I/O Configuration..... 5-2 5.3 Adding the Module and Drive to the I/O Configuration5-4 5.4 Saving the Configuration..........
9.1.1 Information on Module Home Page..................... 9-4 9.2 Process Display Pop-Up Windows ................................ 9-5 9.3 TCP/IP Configuration Web Page ................................... 9-6 9.4 Configure E-mail Notification Web Page ....................... 9-7 9.4.1 To configure e-mail notification............................ 9-8 9.5 DPI Device Information Pages.....................................
IV EtherNet/IP Communications Module
List of Figures Figure 2.1 – Components of the EtherNet/IP Module ................................. 2-1 Figure 3.1 – Setting Web Pages Switch ..................................................... 3-2 Figure 3.2 – DPI Ports and Internal Interface Cables ................................. 3-3 Figure 3.3 – Mounting the Module .............................................................. 3-4 Figure 3.4 – Connecting the Ethernet Cable to the Network ...................... 3-5 Figure 4.
Figure 5.6 – Right Clicking the Scanner...................................................... 5-5 Figure 5.7 – Select Module Type Dialog Box.............................................. 5-5 Figure 5.8 – Module Properties Dialog Box - Page 1.................................. 5-6 Figure 5.9 – Module Properties Dialog Box - Page 2.................................. 5-7 Figure 5.10 – RSLogix 5000 - Data Types and I/O Configuration Folders.. 5-8 Figure 5.11 – Download Dialog Box..................................
Figure 9.1 – Main Web Page for the Module .............................................. 9-2 Figure 9.2 – Process Display Pop-up Window............................................ 9-5 Figure 9.3 – TCP/IP Configuration Web Page ............................................ 9-6 Figure 9.4 – Configuration of E-mail Notification Web Page....................... 9-8 Figure 9.5 – Selected Fault Configuration Page ......................................... 9-9 Figure 9.6 – Example of E-mail Message Ssent by Module ..
VIII EtherNet/IP Communications Module
List of Tables Table 2.1 – Equipment Shipped with the EtherNet/IP Module.................... 2-2 Table 2.2 – User-Supplied Items Required for Installation ......................... 2-2 Table 4.1 – Configuration Tools.................................................................. 4-1 Table 4.2 – Editing the New Entry Dialog Box ............................................ 4-5 Table 4.3 – Selections for Drive Response to Communication Fault........ 4-18 Table 4.4 – Fault Configuration Parameters ..........
X EtherNet/IP Communications Module
CHAPTER 1 Introduction This manual provides information about the EtherNet/IP Communications module (RECOMM-ENET) and using it with DPI AC drives, such as SP600 and GV6000 drives. It is intended for qualified electrical personnel familiar with installing, programming, and maintaining AC drives and networks. The module is mounted in the drive and receives its required power from the drive. It can be used with other products that implement DPI, which is a peripheral communication interface.
1.2 Compatible Products DPI (Drive Peripheral Interface) is a second generation peripheral communication interface. The EtherNet/IP module is compatible with Reliance Electric drive products that support DPI. AT the time of publication, compatible products include: • • • • 1.3 SP600 6SP Series AC Drives SP600 6SB Series AC Drives GV6000 AC Drives LiquiFlo 2.0 AC Drives Related Documentation Refer to the following related publications as necessary for more information.
1.4 Getting Assistance from Reliance Electric If you have any questions or problems with the products described in this instruction manual, contact your local Reliance Electric sales office. For technical assistance, call 1-864-284-5444. Before calling, please review the troubleshooting section of this manual and check the Reliance drives website for additional information. When you call this number, you will be asked for the drive model number and this instruction manual number.
1-4 EtherNet/IP Communications Module
CHAPTER 2 Getting Started This chapter provides: • • • • A description of the EtherNet/IP module’s components A list of parts shipped with the module A list of user-supplied parts required for installing the module An installation checklist Not provided on firmware version 2.xxx or earlier ➀ Status Indicators Four LEDs to indicate the status of the connected drive, module, and network. Refer to chapter 6 for more information about the LEDs.
2.1 Required Equipment Table 2.1 lists the equipment shipped with the EtherNet/IP module. When you unpack the module, verify that the package includes all of these items. Table 2.1 – Equipment Shipped with the EtherNet/IP Module Item Description One EtherNet/IP Communications module One 2.54 cm (1 in) and one 15.
2.2 Installation Checklist This section is designed to help experienced users start using the EtherNet/IP module. If you are unsure how to complete a step, refer to the referenced chapter. ✔ Step ❒ 1 Review the safety precautions for the module. ❒ 2 Verify that the drive is properly installed. Drive User Manual ❒ 3 Action Install the module. Verify that the drive and the network are not powered.
✔ Step Action ❒ 7 Create a ladder logic program. Use a programming tool to create a ladder logic program that enables you to do the following: 2-4 Refer to: • Control the module and connected drive using I/O • Monitor or configure the drive using Explicit messages.
CHAPTER 3 Installing the EtherNet/IP Module Chapter 3 provides instructions for installing the module on Reliance Electric drives. 3.1 Preparing for an Installation Before installing the module: • Read the EtherNet/IP Performance and Application Guide, publication ENET-AP001..., and EtherNet/IP Media Planning and Installation Manual, publication ENET-IN001... • Verify that you have all required equipment. Refer to chapter 2, Getting Started, for a list of equipment. ! Important: 3.
! ATTENTION: The EtherNet/IP module contains ESD- (Electrostatic Discharge) sensitive parts that can be damaged if you do not follow ESD control procedures. Static control precautions are required when handling the module. Failure to observe these precautions could result in damage to equipment. Set the Web Pages Switch (SW2) to enable or disable the module web pages (see figure 3.1 and setting descriptions below). By default, the module web pages are disabled.
Step 3. Connect the Internal Interface cable to the DPI port on the drive and then to the DPI connector on the module. See figure 3.2. ➀ ➁ ➂ SP600 Drive (6SP Series) EtherNet/IP module ➃ GV6000 or SP600 6SB Series Drive ➀ ➁ ➂ ➃ 15.24 cm (6 in) Internal Interface cable DPI Connector EtherNet Cable 2.54 cm (1 in) Internal Interface cable Figure 3.2 – DPI Ports and Internal Interface Cables Step 4.
For GV6000 and SP600 6SB series drives, mount the module on the drive using the four captive screws to secure and ground it to the drive. Important: All screws must be tightened since the module is grounded through a screw. The recommended tightening torque is 0.9 N-m (8 in-lb). Module Internal Interface cable folded behind the module and in front of the drive. SP600 6SP Series Drive GV6000 or SP600 6SB Series Drive Figure 3.
3.4 Connecting the Module to the Network ! Step 1. ATTENTION: The Reliance Electric drive may contain high voltages that can cause injury or death. Remove power from the drive, and then verify power has been discharged before installing or removing a module. Failure to observe this precaution could result in severe bodily injury or loss of life. Remove power from the drive. Step 2. Use static control precautions. Step 3. Connect an Ethernet cable to the EtherNet/IP network. Refer to figure 3.4.
3.5 Applying Power ATTENTION: Unpredictable operation may occur if parameter settings are not compatible with your application. Verify that settings are compatible with your application before applying power to the drive. Failure to observe these precautions could result in severe bodily injury of loss of life. ! 3.6 Step 1. Close the door or reinstall the cover on the drive. The status indicators can be viewed on the front of the drive after power has been applied. Step 2. Apply power to the drive.
CHAPTER 4 Configuring the EtherNet/IP Module Chapter 4 provides instructions and information for setting the parameters in the module. For a complete list of parameters, refer to Appendix B, EtherNet/IP Module Parameters. For definitions of terms in this chapter, refer to the Glossary. 4.1 Configuration Tools The module stores parameters and other information in its own nonvolatile memory. Therefore, you must access the module to view and edit its parameters. Table 4.
4.2 Using the LCD OIM to Configure the Module 4.2.1 SP600 and LiquiFlo 2.0 Use the procedure in figure 4.1 to access the parameters on the EtherNet/IP module using the LCD OIM. If you are unfamiliar with the operation of the LCD OIM, refer to the Reliance Electric Drive User Manual for more information.
4.2.2 GV6000 Use the procedure in figure 4.2 to access the parameters on the EtherNet/IP module using the LCD OIM. If you are unfamiliar with the operation of the LCD OIM, refer to the Reliance Electric Drive User Manual for more information. Figure 4.2 – Acessing the Module Parameters using the LCD OIM (GV6000) 4.
Step 2. On a computer connected to the EtherNet/IP network, start the BOOTP software. The BOOTP Server window appears as shown in figure 4.3. Devices on the network issuing BOOTP requests appear in the BOOTP Request History list. Figure 4.3 – BOOTP Server Window Step 3. In the BOOTP Request History list, double-click the hardware address (Ethernet MAC address) of the module. The New Entry dialog box is displayed as shown in figure 4.4. Figure 4.4 – New Entry Dialog Box Step 4.
Table 4.2 – Editing the New Entry Dialog Box In this field: Enter this information: IP Address A unique IP address for the module. Subnet Mask1 A subnet mask for the module’s network. Gateway1 The IP address of the gateway device on the module’s network. 1 1 For definitions, refer to the Glossary. Step 5. Click OK to apply the settings. The module appears in the Relation List with the new settings as shown in figure 4.5. Figure 4.
4.4 Using Parameters to Set the IP Address, Subnet Mask, and Gateway Address By default, the module is configured so that you set its IP address, subnet mask, and gateway address using a BOOTP server. If you want to set these features using the module’s parameters instead, you must disable BOOTP and then set the appropriate parameters in the module. To disable the BOOTP feature: Step 1. Set the value of module parameter 3 (BOOTP) to Disabled as shown in figure 4.6.
Step 3. Reset the module. Refer to Resetting the Module in section 4.11. The Net A status indicator will be solid green or flashing green if the IP address is correctly configured. To set a subnet mask using parameters: Step 1. Verify that module parameter 3 (BOOTP) is set to Disabled. This parameter must be set to Disabled to configure the subnet mask using parameters. Step 2.
4.5 Setting the Data Rate By default, the module is set to autodetect, so it automatically detects the data rate and duplex setting used on the network. If you need to set a specific data rate and duplex setting, the value of module parameter 16 (EN Rate Cfg) determines the Ethernet data rate and duplex setting that the module will use to communicate. For definitions of data rate and duplex, refer to the Glossary. Step 1.
Port 5 Device RECOMM-ENET Parameter #: 23 DPI I/O Config xxxxxxxxxxx0000 1 Cmd/Ref b00 Bit 0 1 2 3 4 5 - 15 Description Logic Command/Reference (Default) Datalink A Datalink B Datalink C Datalink D Not Used Figure 4.11 – I/O Configuration Screen on an LCD OIM Step 2. If Logic Command/Reference is enabled, configure the parameters in the drive to accept the Logic Command and Reference from the module.
4.7 Setting the Reference Adjustment A reference adjustment is a percent scaling factor for the reference from the network and can be set from 0 to 200%. This allows the drive’s reference to either match the network reference (=100%), scale below the network reference (<100%), or scale above the network reference (>100%). ! ATTENTION: Changes to module parameter 37 (Ref Adjust) take effect immediately.
4.8.1 Configuring the Module for a Master-Slave Hierarchy To select a Master-Slave hierarchy: Step 1. Enable the desired I/O in module parameter 23 (DPI I/O Cfg). Refer to figure 4.11. Step 2. Set the bits in module parameter 35 (M-S Input). This parameter determines the data received from the master by the drive. A “1” enables the I/O. A “0” disables the I/O. Bit 0 is the right-most bit. In 4.13, it is highlighted and equals “1.
4.8.2 Configuring the Module to Transmit Peer-toPeer Data To configure an module to transmit Peer-to-Peer data: Step 1. Verify that module parameter 51 (Peer Out Enable) is set to Off (see figure 4.15). This parameter must be Off while you configure peer output parameters. Value Setting 0 Off (Default) 1 On Port 5 Device RECOMM-ENET Parameter #: 51 Peer Out Enable 0 Off Figure 4.15 – Peer Out Enable Screen on an LCD OIM Step 2.
transmits Peer messages when a change-of-state condition occurs, minimum and maximum intervals are required. • The minimum interval ensures that the module does not transmit messages on the network too often, thus minimizing network traffic. It is set in module parameter 52 (Peer Out Time).
Port 5 Device RECOMM-ENET Parameter #: 47 Peer Inp Enable 0 Off Value Setting 0 Off (Default) 1 On Figure 4.19 – Peer Input Enable Screen on an LCD OIM Step 2. In module parameters 42 through 45 (Peer Inp Addr 1 through Peer Inp Addr 4), set the IP address of the node from which you want to receive data. See figure 4.20. Valid nodes must have EtherNet/IP modules connected to drives with compatible logic command/status words. IP Address of Node Transmitting 255 . 255 . 255 . 255 Peer I/O Default = 0.0.0.
• Step 4. If a drive that uses a 16-bit Reference and 16-bit Datalinks receives a 32-bit Reference or Datalink, it uses the data in the most significant word of the 32-bit Reference or Datalink and ignores the data in the least significant word. If desired, select the destination of the data to input to the drive as Peer B in module parameter 39 (Peer B Input). See figure 4.22.
For example, if the value of Peer Out Time (52) is 2.00 and the value of Peer Out Skip (53) is 2 (see figure 4.18), then parameter 46 (Peer Inp Timeout) needs to have a value greater than 4.00, such as 5.00 (see figure 4.24). Port 5 Device Default = 10.00 Secs RECOMM-ENET Parameter #: 46 Peer Inp Timeout 5.00 Secs. 0.01 <> 10.00 Figure 4.24 – Peer Input Timeout Screen on an LCD OIM Step 7. ! Set the action in parameter 41 (Peer Flt Action) that the module will take if it times out. Figure 4.
4.9 Setting a Fault Action There are three user-configurable fault action parameters: Comm Flt Action (21) and Idle Flt Action (22) determine the action of the module and the connected drive if communications are disrupted. By default, these parameters fault the drive if it is using I/ O from the network and communications are disrupted (for example, a cable is disconnected) or the master is idle. Peer Flt Action (41) determines the action of the module and the connected drive if the module times out.
! ATTENTION: Parameter 41 (Peer Flt Action) lets you determine the action of the module and connected drive if the module times out. By default, this parameter faults the drive if you have configured the module for peer-to-peer communication. You can set this parameter so that the drive continues to run. Precautions should be taken to ensure that the setting of this parameter does not create a hazard of injury or equipment damage.
4.9.1 Setting the Fault Configuration Parameters If you set parameter 21 (Comm Flt Action), 22 (Idle Flt Action), or 14 (Peer Flt Action) to “Send Flt Cfg,” the values in the parameters shown in table 4.4 are sent to the drive after a communications fault occurs. You must set these parameters to values required by your application. Table 4.4 – Fault Configuration Parameters Parameter Number Name Description 25 Flt Cfg Logic A 16-bit value sent to the drive for Logic Command.
Firmware 2.xxx (and earlier) By default, the firmware 2.xxx (and earlier) module web pages are enabled. To disable the module web pages, use Access Control (54) to set the Web Enable Bit 0 value to “0” (Disabled). You can also protect the configured settings for e-mail messaging using Access Control (54). To do this, the value of E-mail Config Bit 1 must be“0” (Disabled default).
Port 5 Device RECOMM-ENET Parameter #: 56 Web Features xxxxxxxxxxxxxxx 1 E-mail Cfg b00 Bit 0 1-7 Description E-mail Cfg (Default = 1 = enabled) Not Used Figure 4.28 – Example Web Access Control Screen on an LCD OIM Changes to this parameter take effect immediately. A reset is not required. 4.11 Resetting the Module Changes to some module parameters require that you reset the module before the new settings take effect.
4.12 Viewing the Module Configuration The parameters in table 4.5 provide information about how the module is configured. You can view these parameters at any time. Table 4.5 – Module Configuration Parameters No Name and Description 17 EN Rate Act The actual network data rate. Details Values Type: 18 Ref / Fdbk Size Size of the Reference/Feedback. The drive determines the size of the Reference/Feedback. Values: 19 Datalink Size Size of each Datalink word. The drive determines the size of Datalinks.
CHAPTER 5 Configuring the Scanner or Bridge Chapter 5 provides instructions on how to configure a ControlLogix bridge to communicate with the module and connected drive. 5.1 Configuring a Simple Network: An Example After the module is configured, the connected drive and module will be a single node on the network. This chapter provides the steps that are needed to configure a simple network like the network in figure 5.1.
5.2 Adding a Bridge or Scanner to the I/O Configuration To establish communications over an EtherNet/IP network, you must first add the controller and its scanner or bridge to the I/O configuration. This example uses RSLogix software to do this. Step 1. Start RSLogix 5000. The RSLogix 5000 window appears as shown in figure 5.2. Example_RECOMM_ENET Controller Example_RECOMM_ENET Figure 5.2 – RSLogix 5000 Window Step 2.
Figure 5.3 – Select Module Type Dialog Box Step 3. In the list, select the EtherNet/IP scanner or bridge used by your controller and then select the major revision of its firmware in the Major Revision box. In this example (figure 5.3), we use a 1756-ENBT EtherNet/IP Bridge (Series A), so the 1756-ENBT/A option is selected. Step 4. Click OK. The Module Properties dialog box (figure 5.4) appears. Figure 5.4 – Module Properties Dialog Box - Page 1 Step 5. Edit the fields listed in table 5.
Table 5.1 – Module Properties Fields Field Name Slot Revision IP Address Electronic Keying Step 6. Enter This Information A name to identify the scanner or bridge. The slot of the EtherNet/IP scanner or bridge in the rack. The minor revision of the firmware in the scanner. (You already set the major revision in the Select Module Type dialog box (figure 5.3). The IP address of the EtherNet/IP scanner or bridge. Compatible Module.
Figure 5.6 – Right Clicking the Scanner The Select Module Type dialog box (figure 5.7) appears. Figure 5.7 – Select Module Type Dialog Box Step 2. Select module type ETHERNET-MODULE (Generic Ethernet Module) to configure a RECOMM-ENET module (figure 5.7), and then click OK. The Module Properties dialog box (figure 5.8) appears.
SP600 Figure 5.8 – Module Properties Dialog Box - Page 1 Step 3. Edit the fields listed in table 5.2. Table 5.2 – Edit Module Properties Field Enter This Information Name A name to identify the module and drive. Comm. Format Data - INT. This setting formats the data in 16-bit words. IP Address The IP address of the module. Step 4. Under Connection Parameters, edit the fields listed in table 5.3. Table 5.
Tables 5.4 and 5.5 define the number of 16-bit words that you need for input and output depending on your configuration. Table 5.4 – SP600 and LiquiFlo 2.0 (16-Bit Reference/Feedback and Datalinks) Input Size 4 6 8 10 12 Output Size 2 4 6 8 10 Logic Command/ Status 4 4 4 4 4 Reference/ Feedback (16-bit) 4 4 4 4 4 Datalinks (16-bit) A B C D 4 4 4 4 4 4 4 4 4 4 Table 5.
Step 6. In the Requested Packet Interval (RPI) field, set the value to 5.0 milliseconds or greater. This value determines the maximum interval that a controller should use to move data to or from the module. To conserve bandwidth, use higher values for communicating with low priority devices. Step 7. Click Finish>>. The new node (“SP600” in this example) now appears under the scanner or bridge (“1756-ENBT” in this example) in the I/O Configuration folder.
5.4 Saving the Configuration After adding the scanner or bridge and the module to the I/O configuration, you must download the configuration to the controller. You should also save the configuration to a file on your computer. Step 1. Select Communications > Download. The Download dialog box (figure 5.11) appears. Example_RECOMM_ENET Figure 5.
5-10 EtherNet/IP Communications Module
CHAPTER 6 Using I/O Messaging Chapter 6 provides information and examples that explain how to use a ControlLogix controller to send I/O Messaging to control, configure, and monitor an SP600, GV6000 or LiquiFlo 2.0 drive. ATTENTION: Risk of injury or equipment damage exists. The examples in this publication are intended solely for purposes of example. There are many variables and requirements with any application.
Chapter 4, Configuring the Module, and chapter 5, Configuring the Scanner or Bridge, discuss how to configure the module and scanner or bridge on the network for these options. The Glossary defines the different options. This chapter discusses how to use I/O after you have configured the module and scanner or bridge. 6.2 Understanding the I/O Image The terms input and output are defined from the scanner’s point of view.
Figure 6.1 illustrates an example of an I/O image with 16-bit words.
For example, an image that uses 32-bit words for Reference and four Datalinks would change the I/O image in figure 6.
EtherNet/IP Controller Scanner 2 Module Word and I/O Output Image (Write) 0 1 2 3 4 5 Logic Command Pad Word Reference (LSW) (2) Reference (MSW) (2) Datalink In B1 Datalink In B2 Input Image (Read) 0 1 2 3 4 5 6 7 Pad Word Pad Word (1) Logic Status Pad Word Feedback (LSW) Feedback (MSW) Datalink Out B1 Datalink Out B2 Message Handler 1 DPI Reliance Electric Drive Logic Command Reference Data In A1 Data In A2 Data In B1 Data In B2 Data In C1 Data In C2 Data In D1 Data In D2 (1) Message Buffer L
6.4 Using Reference/Feedback When enabled, Reference/Feedback begins at word 1 (16-bit) or word 2 (32-bit) in the I/O image. The reference (16 bits or 32 bits) is produced by the controller and consumed by the adapter. The feedback (16 bits or 32 bits) is produced by the adapter and consumed by the controller. The size of the Reference/Feedback is determined by the drive and displayed in Ref/Fdbk Size (18) in the adapter.
6.5 Using Datalinks A Datalink is a mechanism used by Reliance Electric drives to transfer data to and from the controller. Datalinks allow a parameter value to be changed without using an Explicit Message. When enabled, each Datalink consumes either two 16-bit or 32-bit words in both the input and output image depending on its size. The size of Datalinks (16-bit words or 32-bit words) is determined by the drive and displayed in Datalink Size (19) in the module.
6.5.1 32-Bit Parameters using 16-Bit Datalinks To read (and/or write) a 32-bit parameter using 16-bit Datalinks, typically both Datalinks of a pair (x1 and x2) are set to the same 32bit parameter. For example, to read Elapsed MWh (9) in an SP600 drive, both Datalink A1 and A2 are set to “9.” Datalink A1 will contain the least significant word (LSW) and Datalink A2 the most significant word (MSW). In this example, the parameter 9 value of 5.8 MWh is read as a “58” in Datalink A1.
6.6 Sample Ladder Logic Program The sample ladder logic program works with a ControlLogix controller and an SP600 drive. 6.6.1 Function of the Sample Program With this program, you can perform the following actions: • • • Obtain Logic Status information from the drive. • Transmit Datalink data to and from the drive. Use the Logic Command to control the drive (for example, start). Send a Reference to the drive and receive Feedback from the drive. Table 6.
6.7 RSLogix 5000 Configuration Controller Tags When you add the module and drive to the I/O configuration (refer to chapter 5), RSLogix 5000 software automatically creates controller tags for them. In this example program, the following controller tags are used. SP600:C SP600:I SP600:O Figure 6.3 – Controller Tags for the Sample ControlLogix Ladder Logic Program You can expand the Output and Input tags to reveal the output and input configuration.
SP600:C SP600:I SP600:I.Data SP600:I.Data[0] SP600:I.Data[1] SP600:I.Data[2] SP600:I.Data[3] SP600:I.Data[4] SP600:I.Data[5] SP600:I.Data[6] SP600:I.Data[7] SP600:I.Data[8] SP600:I.Data[9] SP600:I.Data[10] SP600:I.Data[11] SP600 Input Image Table System Overhead System Overhead SP600 Logic Status SP600 Feedback SP600 Datalink A1 Out SP600 Datalink A2 Out SP600 Datalink B1 Out SP600 Datalink B2 Out SP600 Datalink C1 Out SP600 Datalink C2 Out SP600 Datalink D1 Out SP600 Datalink D2 Out Figure 6.
6.9 Sample ControlLogix Ladder Logic Program S600 Logic Status Word bit 01 (ACTIVE) SP600:I.Data[2].1 DriveStatusRunning SP600 Logic Status Word bit 07 (FAULT) SP600:I.Data[2].7 DriveStatusFaulted 0 1 2 3 4 5 6 Copy File Source Dest Length SP600 Speed Feedback COP SP600:I.Data[3] DriveFeedback 1 DriveCommandStop SP600 Logic Command bit 00 (STOP) SP600:O.Data[0].0 DriveCommandStart SP600 Logic Command bit 01 (START) SP600:O.Data[0].
Write Datalink A-D data to the SP600 drive (Data In A1 - Data In D2). SP600 Datalink A1 In COP Copy File Source DatalinkDataToDrive[0] Dest SP600:O.Data[2] Length 8 9 (End) Figure 6.8 – Sample ControlLogix Ladder Logic Program for I/O Messaging (Continued) 6.10 Sample Datalink Data The following figure shows the Datalink data used in the sample program.
6-14 EtherNet/IP Communications Module
CHAPTER 7 Using Explicit Messaging Chapter 7 provides information and examples that explain how to use Explicit Messaging to configure and monitor a Reliance Electric drive and an EtherNet/IP module. ! ATTENTION: The examples in this publication are intended solely for purposes of example. There are many variables and requirements with any application.
7.2 Formatting Explicit Messages Explicit Messages for the ControlLogix Controller ControlLogix scanners and bridges accommodate both downloading Explicit Message Requests and uploading Explicit Message Responses. The scanner or bridge module can accommodate one request or response for each transaction block. Each transaction block must be formatted as shown in figure 7.1 . ➓ ➊ ➋ ➌ ➎ Box ➊ ➋ ➌ ➍ ➏ ➐ ➑ ➒ Description Message Type The message type is usually CIP Generic.
Box ➍ ➎ ➏ ➐ ➑ ➒ ➓ Description Class The class is an EtherNet/IP class. Refer to Appendix C, EtherNet/IP Objects, for available classes. Instance The instance is an instance (or object) of an EtherNet/IP class. Refer to Appendix C, EtherNet/IP Objects, for available instances for each class. Attribute The attribute is a class or instance attribute. Refer to Appendix C, Ethernet/IP Objects, for available attributes for each class or instance.
➊ Set up and send Explicit Message ➎ Complete Explicit Message ➍ Retrieve Explicit Message Response ➋ ➌ ➊ Format the required data and set up the ladder logic program to send an Explicit Message request to the scanner or bridge module (download). ➋ The scanner or bridge module transmits the Explicit Message Request to the slave device over the EtherNet/IP network. ➌ The slave device transmits the Explicit Message Response back to the master.
7.4 About the Explicit Message Examples These examples show how to format and execute the following types of Explicit Messages using a ControlLogix controller: • • Get Attribute Single Set Attribute Single • • Get Attributes Scattered Set Attributes Scattered Message Formats When formatting a message example, refer to Formatting Explicit Messages in this chapter for an explanation of the content of each box.
7.4.1 Get Attribute Single Message Example A Get Attribute Single message reads a single attribute value. In this example, we read the value of a parameter in an SP600 drive. Message Format Example SP600 Figure 7.4 – Message Format for a Get Attribute Single Message Table 7.1 identifies key settings for the message format: Table 7.1 – Settings for Message Format Configuration Service Type1 Service Code1 Class Instance Attribute Destination Value Description Get Attribute Single e (Hex.) 93 (Hex.
Ladder Logic Rung Example Get Attribute Single Message Example 10 PerformGetAttributeSingle Get Attribute Single Service MSG Type - CIP Generic GetAttributeSingle ... Message Control EN DN ER Figure 7.5 – Get Attribute Single Message Example Destination Data Example In this example, the Get Attribute Single message reads Output Freq (1) in the drive and returns its value to the destination tag named GetAttributeSingleData. Figure 7.
7.4.2 Set Attribute Single Message Example A Set Attribute Single message writes a value for a single attribute. In this example, we write the value of a parameter in an SP600 drive. Message Format Example SP600 Figure 7.7 – Message Format for a Set Attribute Single Message Table 7.2 identifies key settings for the data format: Table 7.2 – Key Settings for Data Format Configuration Service Type1 Service Code1 Class Instance Attribute Source Element Source Length Value Set Attribute Single 10 (Hex.
Ladder Logic Rung Example 11 PerformSetAttributeSingle Set Attribute Single Service MSG Type - CIP Generic Message Control SetAttributeSingle ... EN DN ER Figure 7.8 – Set Attribute Single Message Example Example Source Data In this example, the Set Attribute Single message writes 599, the value in the source tag named SetAttributeSingleData, to Preset Speed 7 (107) in the drive. Figure 7.9 – Example of Source Data from Set Attribute Single Message 59.9 Hz is written to the parameter.
7.4.3 Get Attributes Scattered Message Example A Get Attributes Scattered message reads the values of multiple attributes. In this example, we read the values of various parameters in an SP600 drive. Message Format Example SP600 Figure 7.10 – Message Format for a Get Attributes Scattered Message The following table identifies key settings for the message format: Table 7.
Ladder Logic Rung Example PerformGetAttributesScattered 12 Get Attributes Scattered Service MSG Type - CIP Generic Message Control GetAttributesScattered ... EN DN ER Figure 7.11 – Example of Get Attributes Scattered Message Explanation of Source and Destination Data The data structures in figure 7.13 uses 16-bit words and can get up to twenty-two parameters in a single message.
Source Data Example In this example, we use the data structure in figure 7.13 in the source tag named GetScatteredRequestData to read the following five parameters: • • • • • Output Freq (1) Output Current (3) Output Voltage (6) DC Bus Voltage (12) Analog In1 Value (17) Figure 7.
Destination Data Example The Get Attributes Scattered message reads the multiple parameters and returns their values to the destination tag (GetScatteredResponseData). Figure 7.14 – Destination Data Example In this example, the parameters have the following values: Drive Parameter Output Freq (1) Output Current (3) Output Voltage (6) DC Bus Voltage (12) Analog In2 Value (17) Using Explicit Messaging Value 32.5 Hz 0.1 Amp 118.7 VAC 329.2 VDC 8.
7.4.4 Set Attributes Scattered Message Example A Set Attributes Scattered message writes values to multiple attributes. In this example, we write the values of various parameters in an SP600 drive. Example Message Format SP600 Figure 7.15 – Message Format for a Set Attributes Scattered Message The following table identifies key settings for the message format: Table 7.
Ladder Logic Rung Example PerformSetAttributesScattered 13 Set Attributes Scattered Service MSG Type - CIP Generic Message Control SetAttributesScattered ... EN DN ER Figure 7.16 – Set Attributes Scattered Message Example Explanation of Source and Destination Data The data structures in figure 7.17 use 16-bit words and can set up to twenty-two parameters in a single message.
Source Data Example In this example, we use the data structure in figure 7.18 in the source tag (SetScatteredRequestData) to write new values for these parameters: Drive Parameter Accel Time 2 (141) Decel Time 2 (143) Preset Speed 5 (105) Preset Speed 6 (106) Preset Speed 7 (107) Value 11.1 sec 22.2 sec 33.3 Hz 44.4 Hz 55.5 Hz Figure 7.
Example Destination Data The results of the message appear in the destination tag named SetScatteredResponseData. Values of “0” indicate no errors occurred. Figure 7.
7-18 EtherNet/IP Communications Module
CHAPTER 8 Troubleshooting the Module and Network Chapter 8 contains information for troubleshooting the EtherNet/IP module and the network. 8.1 Understanding the Status Indicators The module has four status indicators. They can be viewed on the module or through the drive cover. ➊ ➊ ➋ ➌ ➋ ➌ ➍ ➍ Number Status Indicator Description Refer to... ➊ DRIVE DPI Connection Status Section 8.1.1 ➋ MS Module Status Section 8.1.2 ➌ NET A EtherNet/IP Connection Status Section 8.1.
8.1.1 DRIVE Status Indicator Table 8.2 – DRIVE Status Indicator: State Definitions Status Off Cause The module is not powered or is not connected properly to the drive. Flashing The module is not Red receiving a ping message from the drive. Solid Red Securely connect the module to the drive using the ribbon cable. • • Apply power to the drive. • Cycle power to the drive. Verify that cables are securely connected.
8.1.2 MS Status Indicator Table 8.3 – MS Status Indicator: State Definitions Status Off Cause The module is not powered. Flashing The module has Red failed the firmware test. Corrective Action • Securely connect the module to the drive using the Internal Interface cable. • Apply power to the drive and network. • • • Clear faults in the module. • If resetting defaults does not correct the problem, flash the module with the latest firmware release. • • Cycle power to the drive.
8.1.3 NET A Status Indicator Table 8.4 – NET A Status Indicator: State Definitions Status Off Corrective Action • Securely connect the module to the drive using the Internal Interface cable and to the network using an Ethernet cable. • Correctly connect the Ethernet cable to the Ethernet connector. • Set a unique IP address using a BOOTP server or disabling BOOTP and using parameters. • Apply power to the drive and network. Solid Red The module failed duplicated IP address detection test.
8.1.4 NET B Status Indicator Table 8.5 – NET B Status Indicator: State Definitions Status Off Cause Corrective Action The module is not If Net A is off: powered or is not • Securely connect the module to transmitting on the the drive using the Internal EtherNet/IP Interface cable and to the network. network using an Ethernet cable. • Correctly connect the Ethernet cable to the Ethernet connector. • Set a unique IP address using a BOOTP server or by disabling BOOTP and using parameters.
8.2 Module Diagnostic Items Table 8.6 lists diagnostic items that can be accessed using VS Utilities software or the LCD OIM. Diagnostic items can help you or Rockwell Automation personnel troubleshoot communication problems. Table 8.6 – Module Diagnostic Items No. Event Description 1 Common Logic Cmd The current value of the Common Logic Command being transmitted to the host. 2 Prod Logic Cmd The current value of the Product-Specific Logic Command being transmitted to the host.
Table 8.6 – Module Diagnostic Items (Continued) No. Event Description 27 Boot Flash Count The number of times the Boot flash segment has been updated. 28 App Flash Count The number of times the Application flash segment has been updated in the field. 29 M-S Input Size The size of data transferred from the network to the drive. 30 M-S Output Size The size of data transferred from the drive to the network. 31 32 33 34 35 36 The decimal value of each byte in the module’s Ethernet hardware address.
Table 8.6 – Module Diagnostic Items (Continued) No. 45 46 47 48 Event Gateway Act 1 Gateway Act 2 Gateway Act 3 Gateway Act 4 Description The value of each byte in the module’s current gateway address. A value of “0” appears if the module does not currently have a gateway address. 255 . 255 . 255 . 255 [Gateway Act 1] [Gateway Act 2] [Gateway Act 3] [Gateway Act 4] 49 EN Rx Overruns The number of receive buffer overruns reported by the Ethernet hardware.
8.3 Viewing and Clearing Events The module maintains an event queue that reports the history of its actions. You can view the event queue using an LCD OIM or VS Utilities software. To View and Clear Events Using an LCD OIM Use the procedure shown in figures 8.2 and 8.3 to access the event queue using the LCD OIM. Note that you must have the RECOMMENET module as the selected device to access the event queue.
Events Many events in the event queue occur under normal operation. However, if you encounter communication problems, the events can help you or Rockwell Automation personnel troubleshoot the problem. Table 8.7 lists events that may appear in the event queue. Table 8.7 – Event Codes and Descriptions Code Event 1 No Event 2 DPI Bus Off Flt 3 Ping Time Flt 4 Port ID Flt 5 6 Port Change Flt Host Sent Reset 7 8 EEPROM Sum Flt Online @ 125kbps 9 Online @ 500kbps 10 Bad Host Flt 11 Dup.
Table 8.
Table 8.7 – Event Codes and Descriptions Code Event 43 Msg Ctrl Open 44 Msg Ctrl Close 45 Msg Ctrl Timeout 46 OPT Open 47 OPT Close 48 OPT Timeout 8-12 Description The timeout attribute in either the CIP Register or Assembly object was written with a nonzero value, allowing control messages to be sent to the module. The timeout attribute in either the CIP Register or Assembly object was written with a zero value, disallowing control messages to be sent to the module.
CHAPTER 9 Viewing the Module’s Web Pages Chapter 9 provides instructions on how to monitor the module and connected drive using the web interface. Future enhancements may result in web pages that look different than the examples shown in this chapter. 9.1 Accessing the Module’s Main Web Pages After configuring the module, you can view its web pages.
To view the module’s web pages: Step 1. On a computer with access to the EtherNet/IP network on which the module is installed, start a web browser (for example, Microsoft™ Internet Explorer (version 5.0 or greater) or Netscape™ Navigator™ (version 4.6 or greater) software. The computer can access the web pages if it is connected to the same network as the module or if it is connected to a network with access to the module’s network via a gateway device (for example, a router). Step 2.
Title Bar on Adapter Web Pages The title bar appears on all module web pages, including its Home Page. It consists of three elements: Item Reliance Electric logo (at far left) Module Title (middle) Rockwell Automation logo (at far right) Description This logo is also a link. Click it to view the reliance.com web Home Page. Shows the module type or user-configurable title. This logo is also a link. Click it to view the Rockwell Automation web Home Page.
Link/Folder Description Software tools Web Click this link to view Reliance Electric’s web page site link with information about software tools such as V*S Utilities. Launch my V*S Click this link to launch the V*S Utilities software Utilities software already installed on your PC. link E-mail technical Click this link to view a new e-mail message window support link to send a message to Reliance Electric’s Technical Support Team. 9.1.
9.2 Process Display Pop-Up Windows The Process Display pop-up window dynamically shows a host’s information. To view this window, click the “Process Display” link in the navigation window. Figure 9.
9.3 TCP/IP Configuration Web Page The TCP/IP Configuration web page provides details about the module’s Ethernet settings and network activities. Figure 9.3 – TCP/IP Configuration Web Page Information 9-6 Description IP Address IP address of module Subnet Mask Subnet mask for the module’s network Gateway Address Address for the gateway device on the module’s network BOOTP Whether BOOTP is being used to configure the module’s network information.
Information Description Ethernet Transmitted Number of packets tha the module has sent Packets Ethernet Transmit Errors Number of transmit errors reported by the hardware EtherNet/IP Missed I/ Number of I/O connection packets that the O Packets module did not receive 9.
For more information, see section 4.10, Setting Web Access Control. Figure 9.4 – Configuration of E-mail Notification Web Page 9.4.1 To configure e-mail notification Step 1. Click the desired “Send an e-mail message when ...” check boxes you want to occur that will send e-mail notification. If you only want e-mail notification when selected faults/alarms occur: • Click the respective fault and/or alarm radio buttons. • Click the “selected faults” link and/or “selected alarms” link.
Figure 9.5 – Selected Fault Configuration Page • Click the desired fault/alarm check boxes, and click Save Changes. • Click the “Back to E-mail Configuration Page” link. Step 2. Type the following information in their respective boxes: Information “IP address of . . . ” Description Type in the address of the mail server that will be used to deliver the e-mail messages. “E-mail addresses to notify . . Type in addresses to where you want e-mail .” messages to be sent.
Important:For firmware 2.xxx (and earlier) modules, it is recommended that Access Control (54) E-mail Config Bit 1 value be set to “0” (Disabled) after E-mail Notification has been configured. Otherwise the configuration can be changed anytime the web page is accessed with a browser.Forfirmware 3.xxx (and later) modules, it is recommended that Web Features (56) Email Cfg Bit 0 value be set to “0” (Disabled) after E-mail Notification has been configured.
9.5 DPI Device Information Pages DPI device information pages show a device’s module information, diagnostic information, and fault queue. Figure 9.
Figure 9.8 – Example of Port 0 (SP600 Drive) Diagnostic Information Page Figure 9.
Figure 9.
Viewing the Module’s Web Pages 9-14
APPENDIX A Technical Specifications Communications Network Protocol Data Rates EtherNet/IP 10/100 Mbps Half/Full Duplex Drive Protocol Data Rates DPI 125 kbps or 500 kbps Electrical Consumption Drive Network 350 mA at 5 VDC supplied by the host (for example, the drive) None Mechanical Dimensions Height Length Width 19 mm (0.75 in) 86 mm (3.39 in) 78.5 mm (3.
Regulatory Compliance UL UL508C cUL CAN / CSA C22.2 No. 14-M91 CTick EN61800-3 CE EN50178 and EN61800-3 Note: This is a product of category C2 according to IEC 61800-3. In a domestic environment this product may cause radio interference in which case supplementary mitigation measures may be required.
APPENDIX B Module Parameters The following information is provided for each EtherNet/IP module parameter along with its description: Parameter Number: Unique number assigned to each parameter. Parameter Name: Unique name assigned to each parameter. Range: Predefined parameter limits or selections. Default: Factory default setting. Type: Read Only or Read/Write Reset Required: Module must be reset before parameter value is recognized.
1 DPI Port Range: 0 to 7 Default: 5 Type: Read Only Reset Required: N/A Display the port number to which the module is connected. This will usually be port 5. 2 DPI Data Rate Range: 0 = 125 Kbps 1 = 500 Kbps Default: 0 = 125 Kbps Type: Read Only Reset Required: N/A Displays the data rate used by the drive. This data rate is set in the drive and the module detects it.
4 5 6 7 IP Addr Cfg 1 IP Addr Cfg 2 IP Addr Cfg 3 IP Addr Cfg 4 Range: 0 to 255 Default: 0 Type: Read/Write Reset Required: Yes Sets the bytes in the IP address. 255 . 255 . 255 . 255 IP Addr Cfg 1 IP Addr Cfg 2 IP Addr Cfg 3 IP Addr Cfg 4 Important: To set the IP address using these parameters, parameter 3 (BOOTP) must be set to Disabled.
12 13 14 15 Gateway Cfg 1 Gateway Cfg 2 Gateway Cfg 3 Gateway Cfg 4 Range: 0 to 255 Default: 0 Type: Read/Write Reset Required: Yes Sets the bytes of the gateway address. 255 . 255 . 255 . 255 Gateway Cfg 1 Gateway Cfg 2 Gateway Cfg 3 Gateway Cfg 4 Important: To set the gateway address using these parameters, parameter 3 (BOOTP) must be set to Disabled.
17 EN Rate Act Range: 0 = No Link 1 = 10 Mbps Full 2 = 10 Mbps Half 3 = 100 Mbps Full 4 = 100 Mbps Half Default: 0 = No Link Type: Read Only Reset Required: N/A Displays the actual network data rate and duplex mode used by the module. 18 Ref/Fdbk Size Range: 0 = 16-bit 1 = 32-bit Default: 0 = 16-bit Type: Read Only Reset Required: N/A Displays the size of the Reference/Feedback. The drive determines the size of the Reference/Feedback.
20 Reset Module Range: 0 = Ready (No action) 1 = Reset Module 2 = Set Defaults (Restores module to factory-default settings) Default: 0 = Ready Type: Read/Write Reset Required: No This parameter is a command. No action is taken if it is set to “Ready.” Resets the module if it is set to “Reset Module.” Restores the module to factory default settings if it is set to “Set Defaults.” It will be reset to “0 = Ready” after the command has been performed.
22 Idle Flt Action Range: 0 = Fault 1 = Stop 2 = Zero Data 3 = Hold Last 4 = Send Flt Cfg Default: 0 = Fault Type: Read/Write Reset Required: No Sets the action that the module takes if the module detects that the PLC is set to program mode. This setting is effective only if the I/O that controls the drive is transmitted through the module. ! 23 ATTENTION: Idle Flt Action (22) lets you determine the action of the module and connected drive if the controller is idle.
24 DPI I/O Active Range: See figure B.2. Default: xxx0 0001 Type: Read Only Reset Required: N/A No t No Used t No Used tU Da sed ta Da link D t Da alink ta C Da link B ta Cm link A d/R ef Displays the I/O that the module is actively transmitting. The value of this parameter will usually be equal to the value of DPI I/O Cfg (23). x x x 0 0 0 0 1 7 6 5 4 3 2 1 0 1 = I/O Enabled 0 = I/O Disabled x =Not Used Figure B.
26 Flt Cfg Ref Range: 0 to 4294967295 Default: 0 Type: Read/Write Reset Required: No Sets the Reference data that is sent to the drive if any of the following is true: • Comm Flt Action (21) is set to Send Flt Cfg and communications are disrupted. • Idle Flt Action (22) is set to Send Flt Cfg and the scanner is put into Program mode. • Peer Flt Action (41) is set to Send Flt Cfg and communications are disrupted.
35 M-S Input Range: See figure B.3. Default: xxx0 0001 Type: Read/Write Reset Required: Yes No t No Used t No Used tU Da sed ta Da link D t Da alink tali C Da nk B ta Cm link A d/R ef Configures the Master-Slave input data. This data is produced by the Master device (for example, scanner or bridge) and consumed by the module. x x x 0 0 0 0 1 7 6 5 4 3 2 1 0 1 = I/O Enabled 0 = I/O Disabled x =Not Used Figure B.3 – M-S Input (35) 36 M-S Output Range: See figure B.4.
37 Ref Adjust Range: 0.00 to 200.00 % Default: 100.00 % Type: Read/Write Reset Required: No Sets the percent scale factor for the Reference from the network. ! 38 39 ATTENTION: Changes to module parameter 37 (Ref Adjust) take effective immediately. A drive receiving its Reference from the module will receive the newly scaled Reference, resulting in change of speed. Failure to observe this precaution could result in bodily injury and/or damage to equipment.
40 Peer Cmd Mask Range: Minimum: 0000 0000 0000 0000 Maximum: 1111 1111 1111 1111 0 = Ignore bit 1 = Use bit Default: 0000 0000 0000 0000 Type: Read/Write Reset Required: Yes Configures the mask for the Logic Command word when it is received through peer input. If the mask bit is 0 (Off), the command bit is ignored and not used. If the mask bit is 1 (On), the command bit is checked and used.
42 43 44 45 Peer Inp Addr 1 Peer Inp Addr 2 Peer Inp Addr 3 Peer Inp Addr 4 Range: 0 to 255 Default: 0 Type: Read/Write Reset Required: No Sets the bytes in the IP address that specifies the device from which the module receives (consumes) Peer I/O data. 255 . 255 . 255 . 255 Peer Inp Addr 1 Peer Inp Addr 2 Peer Inp Addr 3 Peer Inp Addr 4 Important: Changes to these parameters are ignored when parameter 47 (Peer Inp Enable) is On. 46 Peer Inp Timeout Range: 0.01 to 10.00 sec Default: 10.
47 Peer Input Enable Range: 0 = Off 1 = On Default: 0 = Off Type: Read/Write Reset Required: No Enables or disables the Peer I/O input. 48 Peer Inp Status Range: 0 = Off 1 = Waiting 2 = Running 3 = Faulted Default: 0 = Off Type: Read Only Reset Required: N/A Displays the status of the consumed peer input connection.
51 Peer Out Enable Range: 0 = Off 1 = On Default: 0 = Off Type: Read/Write Reset Required: No Enables or disables the Peer I/O output. 52 Peer Out Time Range: 0.01 to 10.00 sec Default: 10.00 sec Type: Read/Write Reset Required: No Sets the minimum time that a module will wait when transmitting data to a peer. Important: Changes to these parameters are ignored when parameter 51 (Peer Out Enable) is On.
54 Access Control Range: 0 = Disabled 1 = Enabled Default: xxxx xx01 Type: Read/Write Reset Required: No This parameter is only available for firmware version 2.xxx (and earlier) modules. Sets the access to the Web interface and Web-configurable features such as e-mail notification. 7 6 5 4 3 2 1 0 Bit 31 Default x x x x x x x 1 1 0 = Web Enable 1 = E-mail Config 2 -31 = Not Used Figure 2.
This parameter is only available for firmware version 3.xxx (and later) modules. Sets the access to the Web interface and Web-configurable features. Bit Default 7 6 5 4 3 2 1 0 x x x x x x 1 1 Bit Definitions 0 = E-mail Cfg 1 - 7 = Not Used Figure 2.
Module Parameters B-18
APPENDIX C EtherNet I/P Objects Appendix C presents information about the EtherNet/IP objects that can be accessed using Explicit Messages. For information on the format of Explicit Messages and sample ladder logic programs, refer to Chapter 8, Using Explicit Messaging. Class Code Object Hex. Dec.
Table 3.
Instance Attributes Attribute Access ID Rule Name Data Type Description 1 Get Vendor ID UINT 5 = Reliance Electric 2 Get Device Type UINT 123 3 Get Product Code UINT 4 Get Revision: Major Minor STRUCT of USINT USINT WORD Number identifying product name and rating Value varies Value varies 5 Get Status Bit 0 = Owned Bit 2 = Configured Bit 10 = Recoverable fault Bit 11 = Unrecoverable fault 6 Get Serial Number UDINT Unique 32-bit number 7 Get Product Name SHORT_ STRING Product
C.
C.
Instance Attributes Attribute ID Access Rule Name 1 Get Bad Flag BOOL If set to 1, then attribute 4 may contain invalid, bad or otherwise corrupt data.
C.4 Parameter Object Class Code Hexadecimal Decimal 0x0F 15 Instances The number of instances depends on the number of parameters in the DPI drive. The module parameters are appended to the list of drive parameters. The total number of parameters can be read in Instance 0, Attribute 2.
Attribute Access ID Rule 10 Set Data Type Name Native Language USINT Description 0 = English 1 = French 2 = Spanish 3 = Italian 4 = German 5 = Japanese 6 = Portuguese 7 = Mandarin Chinese 8 = Russian 9= Instance Attributes Attribute Access ID Rule Name Parameter Value Data Type Description 1 1 2 Get Link Path Size USINT 0 = No link specified n = The size of Attribute in 3 bytes 3 Get Link Path 4 4 Get Descriptor WORD 0 = False, 1 = True Bit 1 = Supports ENUMs Bit 2 = Supports scaling
Attribute Access ID Rule Name Data Type Description 11 Get Maximum Value 1 3 12 Get Default Value 1 3 13 Get Scaling Multiplier UINT 3 14 Get Scaling Divisor UINT 3 15 Get Scaling Base UINT 3 16 Get Scaling Offset UINT 3 17 Get Multiplier Link UINT 3 18 Get Divisor Link UINT 3 19 Get Base Link UINT 3 20 Get Offset Link UINT 3 21 Get Decimal Precision USINT 3 1 Access rule is defined in bit 4 of instance attribute 4. 0 = Get/Set, 1 = Get.
C.5 Parameter Group Object Class Code Hexadecimal Decimal 0x10 16 Instances The number of instances depends on the number of groups in the device. A group of module parameters is appended to the list of groups in the device. The total number of groups can be read in Instance 0, Attribute 2.
Instance Attributes 1 Attribute ID Access Rule 1 Get Group Name String SHORT_ STRING Group name 2 Get Number of Members in Group UINT Number of parameters in group. 3 Get 1st Parameter UINT Number in Group 1 4 Get 2nd Parameter UINT Number in Group 1 n Get UINT 1 Data Type … Name Description Value varies based on group instance.
C.6 PCCC Object Class Code Hexadecimal Decimal 0x67 103 Instances Supports Instance 1. Class Attributes Not supported. Instance Attributes Not supported.
Message Structure for Execute_PCCC Request Response Name Data Type Length USINT Length of requestor ID Length USINT Length of requestor ID Vendor UINT Vendor number of requestor Vendor UINT Vendor number of requestor Serial Number UDINT ASA serial number of Serial requestor Number UDINT ASA serial number of requestor Other Product Specific Identifier of user, task, etc., on the requestor Product Specific Identifier of user, task, etc.
N-Files N-File N40 … Bits N40:0 N40:1 N40:2 N40:3 N40:4 N40:5 N40:6 N40:63 N41 Description This N-file lets you use Emulated Block Transfer messages to read and write many types of DPI messages. To use Emulated Block Transfer messages, you send a Write message to N40:0 – N40:63, wait until the module responds with a reply message, and then read the response data in N40:0 – N40:63 with a Read message. Bits 15 to 8 are the Most Significant Byte. Bits 7 to 0 are the Least Significant Byte.
N41:0 N41:1 N41:2 N41:3 N41:4 N41:5 N41:6 N41:7 N41:8 N41:9 N41:10 N41:11 N41:12 N41:13 N41:14 N41:15 N41:16 N41:17 N41:18 N42 N42:3 N42:7 N42:8 Logic Command Word Logic Status Word Reference (least significant word) Feedback (least significant word) Reference (most significant word) Feedback (most significant word) Datalink A1 (least significant word) Datalink A1 (least significant word) Datalink A1 (most significant word) Datalink A1 (most significant word) Datalink A2 (least significant word) Datalink
N-File Description N201 – N212 These N-files let you read and write parameter values in DPI Peripherals (for example, an OIM or module) as 32-bit double words. You can interpret the data in various ways (for example, 32-bit real, 32-bit integer) To read a parameter, you need to send a message with two elements. For example, to read parameter 1 in the peripheral connected to DPI port 1, read two elements beginning at N201:2.
C.7 DPI Device Object Class Code Hexadecimal Decimal 0x92 146 Instances The number of instances depends on the number of components in the device. The total number of components can be read in Instance 0, Attribute 4.
Attribute ID Access Rule 4 Get Number of Components BYTE Number of components (e.g., main control board, I/O boards) in the device. 5 Set User Definable Text STRING[16] Text identifying the device with a user-supplied name. 6 Get Status Text STRING[12] Text describing the status of the device. 7 Get Configuration Code BYTE Identification of variations. 8 Get Configuration Text STRING[16] Text identifying a variation of a family device.
Attribute ID Access Rule Data Type Description 20 Set CustomerGenerated Firmware STRING[36] GUID (Globally Unique Identifier) identifying customer firmware flashed into the device. 128 Get Customization Code WORD Code identifying the customized device. 129 Get Customization WORD Revision Number Revision of the customized device. 130 Get Customization Device Text Text identifying the customized device.
C.8 DPI Parameter Object Class Code Hexadecimal Decimal 0x93 147 Instances The number of instances depends on the number of parameters in the device. The total number of parameters can be read in Instance 0, Attribute 0.
Attribute Access ID Rule Name Data Type Description 4 Get NVS Link Value Checksum WORD Checksum of parameter links in a user set in NVS 5 Get First Accessible Parameter WORD First parameter available if parameters are protected by passwords. A “0” indicates all parameters are protected. 7 Get Class Revision WORD 2 = DPI 8 Get First Parameter Processing Error WORD The first parameter that has been written with a value outside of its range. A “0” indicates no errors.
Attribute Access ID Rule 11 Name Get/Set DPI Link Data Type Description BYTE[3] Link (parameter or function block that is the source of the value) (0 = no link) ID for help text for this parameter 12 Get Help Object Instance WORD 13 Get DPI Read Basic STRUCT of BOOL[32] CONTAINER CONTAINER CONTAINER CONTAINER STRING[16] STRING[4] Descriptor (Refer to pages C-24 to C-25) Parameter value Minimum value Maximum value Default value Parameter name Units (e.g.
Descriptor Attributes Bit Name Description 0 Data Type (Bit 1) Right bit is least significant bit (0).
Bit Name Description 21 Formula Links Reserved 22 Access Level (Bit 1) Reserved 23 Access Level (BIt 2) Reserved 24 Access Level (Bit 3) Reserved 25 Writable ENUM Reserved 26 Not a Link Source 0 = Parameter can be a source for a link 1 = Parameter cannot be a source for a link 27 Enhanced Bit ENUM Reserved 28 Enhanced ENUM Reserved 29 Not Used Reserved 30 Not Used Reserved 31 Not Used Reserved Formulas for Converting Display Value = ((Internal Value + Offset) x Multiplier x Base) /
C.9 DPI Fault Object Class Code Hexadecimal Decimal 0x97 151 Products such as SP600, GV6000 and LiquiFlo 2.0 drives use this object for faults. Modules use this object for events. Instances The number of instances depends on the maximum number of faults or events supported in the queue. The maximum number of faults/events can be read in Instance 0, Attribute 2.
Attribute Access ID Rule Name Data Type Description 5 Get Fault Data List STRUCT of BYTE BYTE WORD[n] Reserved 6 Get Number of Recorded Faults WORD Number of faults/events in the queue. A “0” indicates the fault queue is empty.
Services Implemented for: Service Code Class Instance 0x0E Yes Yes Get_Attribute_Single Service Name 0x10 Yes Yes Set_Attribute_Single C.10 DPI Alarm Object Class Code Hexadecimal Decimal 0x98 152 Products such as SP600, GV6000 and LiquiFlo 2.0 drives use this object for alarms or warnings. Modules do not support this object. Instances The number of instances depends on the maximum number of alarms supported by the queue. The maximum number of alarms can be read in Instance 0, Attribute 2.
Instance Attributes Attribute ID Access Rule 0 Get Name Full/All Information Data Type Description STRUCT of WORD STRUCT of BYTE BYTE STRING[16] STRUCT of LWORD BOOL[16] WORD CONTAINER[n] 1 Get Basic Information STRUCT of WORD STRUCT of BYTE BYTE STRUCT of LWORD Alarm code Alarm source DPI port DPI Device Object Alarm text Alarm time stamp Timer value (0 = Timer not supported) BOOL[0]: (0 = invalid data, 1 = valid data) BOOL[1]: (0 = elapsed time, 1 = real time) BOOL[2 - 15] Reserved Reserved Re
C.11 DPI Diagnostic Object Class Code Hexadecimal 0x99 Decimal 153 Instances The number of instances depends on the maximum number of diagnostic items in the device. The total number of diagnostic items can be read in Instance 0, Attribute 2. … Example Description 0 Class Attributes (Drive) 1 Drive Diagnostic Item 1 2 Drive Diagnostic Item 2 16384 16385 Class Attributes (Module) Module Diagnostic Item1 … Device Host Module DPI Port 1 DPI Port 2 DPI Port 3 DPI Port 4 DPI Port 5 DPI Port 6 … (Dec.
Instance Attributes Attribute Access ID Rule Name 0 Get Full/All Info 1 Get/Set Value Data Type STRUCT of BOOL[32] CONTAINER1 CONTAINER CONTAINER CONTAINER WORD WORD STRING[4] UINT UINT UINT INT DWORD STRING[16] Various Description Descriptor (Refer to pages C-24 to C-25) Value Minimum value Maximum value Default value Pad Word Pad Word Units (e.g.
C.12 DPI Time Object Class Code Hexadecimal Decimal 0x9B 155 Instances The number of instances depends on the number of timers in the device. Instance 1 is always reserved for a real time clock although a device may not support it. The total number of timers can be read in Instance 0, Attribute 2.
Instance Attributes Attribute ID Access Rule 0 Get Name Data Type Read Full STRUCT of STRING[16] LWORD or STRUCT Description Name of the timer Elapsed time in milliseconds unless timer is a real time clock (See attribute 2) See Attribute 3 BOOL[16] 1 Get 2 Get/Set 3 Get Timer Text STRING[16] Name of the timer Timer Value LWORD -ORSTRUCT of WORD BYTE BYTE BYTE BYTE BYTE BYTE Elapsed time in milliseconds unless the timer is a real time clock.
C.13 TCP/IP Interface Object Class Code Hexadecimal 0xF5 Decimal 245 Instances The module supports one instance of the TCP/IP Interface object.
Attribute Access ID Rule Name Data Type 4 Get Physical Link STRUCT of Object UINT Padded EPATH 5 Get Interface STRUCT of Configuration UDINT UDINT UDINT UDINT UDINT STRING 6 Get Host Name STRING Description Path size Path Module’s IP address Module’s subnet mask Module’s gateway address Primary name server Secondary name server Default domain name Host name when using DHCP Services Service Code 0x0E 0x10 C-34 Implemented for: Class Instance Yes Yes No Yes Service Name Get_Attribute_Single Set_Attribut
C.14 Ethernet Link Object Class Code Hexadecimal 0xF6 Decimal 246 Instances The module supports one instance of the TCP/IP Interface object.
Attribute Access ID Rule Name 5 Get Media Counters Data Type Description STRUCT RX = Received, TX = Transmitted of UDINT RX frames not having integral number of octets long UDINT RX frames not passing FCS check UDINT TX frames having one collision UDINT TX frames having multiple collisions UDINT Number of times of SQE test error message UDINT TX Frames delayed first attempt by busy medium UDINT Collisions detected later than 512 bit-times in trans.
EtherNet I/P Objects C-37
C-38 EtherNet/IP Communications Module
APPENDIX D Logic Command/ Status Words Appendix D provides the definitions of the Logic Command/Logic Status words that are used for some products that can be connected to the EtherNet/IP module. If you do not see the Logic Command/Logic Status for the product that you are using, refer to your product’s documentation. D.1 SP600, GV600 and LiquiFlo 2.
Logic Bits 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 Command x x x x Description Reference Select 000 = No Command 001 = Ref. 1 (Ref A Select) 010 = Reserved 011 = Ref. 3 (Preset 3) 100 = Ref. 4 (Preset 4) 101 = Ref. 5 (Preset 5) 110 = Ref. 6 (Preset 6) 111 = Ref. 7 (Preset 7) MOP Decrement 0 = Not Decrement 1 = Decrement 1 A 0 = Not Stop condition (logic 0) must first be present before a 1 = Start condition will start the drive. 2 To perform this command, the value must switch from “0” to “1.
Logic Bits 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 x x x x Logic Command/Status Words Status Reference Description 0000 = Ref A Auto 0001 = Reserved 0010 = Preset 2 Auto 0011 = Preset 3 Auto 0100 = Preset 4 Auto 0101 = Preset 5 Auto 0110 = Preset 6 Auto 0111 = Preset 7 Auto 1000 = Term Blk Manual 1001 = DPI 1 Manual 1010 = DPI 2 Manual 1011 = DPI 3 Manual 1100 = DPI 4 Manual 1101 = DPI 5 Manual 1110 = DPI 6 Manual 1111 = Jog Ref D-3
D-4 EtherNet/IP Communications Module
GLOSSARY BOOTP (Bootstrap Protocol) - Enables the module to configure itself dynamically at boot time if the network has a BOOTP server. The BOOTP server assigns the module a preconfigured IP address, a subnet mask, and a gateway address; therefore, you do not have to configure these using the parameters in the module. BOOTP can make it easier to administer an Ethernet network. A free version of Rockwell Software’s BOOTP Server can be accessed at: http://www.reliance.com/prodserv/standriv/stdhome.htm.
DPI (Drive Peripheral Interface) - A peripheral communication interface used by various Reliance Electric drives and power products. DPI peripheral - A device that provides an interface between DPI and a network or user. Peripheral devices are also referred to as “modules” and “adapters.” The EtherNet/IP module and SP600 OIM are examples of DPI peripherals. DPI product - A device that uses the DPI communications interface to communicate with one or more peripheral devices.
fault configuration - When communications are disrupted (for example, a cable is disconnected), the module and SP600 drive can respond with a user-defined fault configuration. The user sets the data that is sent to the drive in the fault configuration parameters (parameters 25 (Flt Cfg Logic) through 34 (Flt Cfg D2 In). When a fault action parameter is set to use the fault configuration and a fault occurs, the data from these parameters is sent as the Command Logic, Reference, and/or Datalink(s).
0 1 7 Class A 0 Network ID 15 0 1 Class B 1 0 15 0 1 2 Class C 1 1 0 7 Network ID 7 23 31 23 Host ID 31 Host ID 15 Network ID 23 31 Host ID The number of devices on your EtherNet/IP network will vary depending on the number of bytes that are used for the network address. In many cases you are given a network with a Class C address, in which the first three bytes contain the network address (subnet mask = 255.255.255.0). This leaves 8 bits or 256 addresses on your network.
module - Devices such as drives, controllers, and computers usually require an module to provide a communication interface between them and a network such as EtherNet/IP. An module reads data on the network and transmits it to the connected device. It also reads data in the device and transmits it to the network. The RECOMM-ENET EtherNet/IP module is a module that connects SP600, GV6000 and LiquiFlo 2.0 drives to a Ethernet network.
RSNetWorx for EtherNet/IP - RSNetWorx for EtherNet/IP software is a tool for configuring and monitoring EtherNet/IP networks and connected devices. It is a 32-bit Windows application that runs on Windows 95, Windows 98, and Windows NT. Information about RSNetWorx for EtherNet/IP software can be found at http:// www.software.rockwell.com/rsnetworx.
zero data - When communications are disrupted (for example, a cable is disconnected), the module and drive can respond with zero data. Zero data results in the drive receiving zero as values for command data. If the drive was running and using the reference from the module, it will stay running but at zero reference.
Glossary Glossary-8
INDEX A Access Control (54), B-16 assembly object, C-4 assistance, technical, 1-3 B BOOTP (3), B-2 BOOTP (Bootstrap Protocol) configuring the module using, 4-3 disabling, 4-6 bridge, configuring, 5-1 to 5-9 C checklist, installation, 2-3 Comm Flt Action (21), 4-17, B-6 commissioning the module, 3-6 communications specifications, A-1 configuration tools, 4-1 configuring the module, 4-1 to 4-22 configuring the scanner or bridge, 5-1 to 5-9 connecting the module to the drive, 3-2 connecting the module to the
Flt Cfg Ref (26), B-9 G gateway address setting using BOOTP, 4-3 setting using parameters, 4-7 Gateway Cfg 1 (12), B-4 Gateway Cfg 2 (13), B-4 Gateway Cfg 3 (14), B-4 Gateway Cfg 4 (15), B-4 Get Attribute Single message example, 7-6 Get Attributes Scattered message example, 7-10 I I/O configuration adding a bridge or scanner, 5-2 adding the module and drive, 5-4 saving, 5-4, 5-9 I/O configuration, setting, 4-8 I/O messaging, 6-1 to 6-13 identity object, C-2 Idle Flt Action (22), 4-17, B-7 installation che
P parameter descriptions, B-1 to B-11 parameter group object, C-10 parameter object, C-7 PCCC object, C-12 P-DP Addr Cfg (3), B-2 Peer A Input (38), B-11 Peer A Output (49), B-14 Peer B Input (39), B-11 Peer B Output (50), B-14 Peer Cmd Mask (40), B-12 Peer Flt Action (41), 4-16, B-12 Peer Inp Addr 1 (42), B-13 Peer Inp Addr 2 (43), B-13 Peer Inp Addr 3 (44), B-13 Peer Inp Addr 4 (45), B-13 Peer Inp Status (48), B-14 Peer Inp Timeout (46), B-13 Peer Input Enable (47), B-14 Peer Out Enable (51), B-15 Peer Ou
Index-4 EtherNet/IP Communications Module
DIF Documentation Improvement Form Use this form to give us your comments concerning this publication or to report an error that you have found. For convenience, you may attach copies of the pages with your comments. After you have completed this form, please return it to: Reliance Electric Technical Documentation 6040 Ponders Court Greenville, SC 29615 Fax: 864.284.
U.S. Drives Technical Support Tel: (1) 262.512.8176, Fax: (1) 262.512.2222, Email: support@drives.ra.rockwell.com, Online: www.ab.com/support/abdrives www.rockwellautomation.com Power, Control and Information Solutions Headquarters Americas: Rockwell Automation, 1201 South Second Street, Milwaukee,WI 53204-2496 USA,Tel: (1) 414.382.2000, Fax: (1) 414.382.
