N-Tron CIP User Manual
CIP
User Manual &
Installation
Guide
CIP Manual N-TRON Corp.
N-TRON CIP Manual
1 Introduction ................................................................................................................................... 3
2 CIP Components .......................................................................................................................... 3
2.1 Electronic Data Sheet (EDS) ................................................................................................. 3
2.2 CIP Objects ........................................................................................................................... 3
2.2.1 TCP/IP Interface Object ................................................................................................. 6
2.2.2 Ethernet Link Object ...................................................................................................... 7
2.2.3 N-TRON Object .............................................................................................................. 9
2.3 CIP Services ........................................................................................................................ 11
2.4 Accessing Data ................................................................................................................... 11
2.4.1 Explicit Messaging ....................................................................................................... 11
2.4.2 I/O Connections ........................................................................................................... 11
3 Rockwell RSLogix 5000 – Add-On Instruction Installation ......................................................... 12
3.1 Configuration of RSLogix project ........................................................................................ 12
3.2 Input_Assembly Parameter ................................................................................................. 21
3.3 Switch_Parameters Parameter ........................................................................................... 22
3.4 Explicit Messaging Options ................................................................................................. 22
3.5 Troubleshooting................................................................................................................... 22
3.6 Sample Project .................................................................................................................... 23
4 Rockwell RSLogix 5000 – Tag reference ................................................................................... 24
4.1 Generic assembly tags ........................................................................................................ 24
4.2 7506GX2 assembly tags .................................................................................................... 33
4.3 System fault tags ................................................................................................................. 35
4.4 CIP Tags ............................................................................................................................. 36
4.5 Identity object ...................................................................................................................... 36
4.6 TCPIP object ....................................................................................................................... 36
4.7 Ethernet Link object ............................................................................................................ 37
4.8 N-TRON Switch object ........................................................................................................ 39
5 Rockwell FactoryTalk - Faceplate Installation Instructions ........................................................ 42
5.1 Configuration of FactoryTalk View Faceplate Displays....................................................... 42
5.2 Sample Project .................................................................................................................... 53
6 Rockwell FactoryTalk - Faceplate quick reference guide ........................................................... 54
6.1 Introduction .......................................................................................................................... 54
6.2 Home display ....................................................................................................................... 55
6.3 Diagnostics display.............................................................................................................. 57
6.4 Settings display ................................................................................................................... 59
6.5 Alarm display ....................................................................................................................... 60
7 Support ....................................................................................................................................... 61
8 References ................................................................................................................................. 61
9 Revisions .................................................................................................................................... 61
Revision February 18, 2011 Page 2 of 61
CIP Manual N-TRON Corp.
1 Introduction
EtherNet/IP™, better known as the Common Industrial Protocol (CIP™), was designed
for use in process control and industrial automation applications. CIP was designed to
provide consistent device access to eliminate the need for vendor specific software for
configuration and monitoring of individual devices.
N-TRON switches with CIP support can be used to communicate with other industrial
devices, such as Rockwell controllers.
2 CIP Components
The following CIP components are available with N-TRON CIP enabled switches.
2.1 Electronic Data Sheet (EDS)
An electronic datasheet for each N-TRON switch is provided.
In a Rockwell environment EDS files are installed using the “EDS Hardware Installation
Tool”. This allows N-TRON switches to be recognized in an RSLinx environment.
2.2 CIP Objects
“Objects” are used to organize various information about the switch. There are four types
of objects provided. Three are specified by the ODVA, and one is N-TRON specific:
Identity object
TCP/IP Interface object
Ethernet Link object
N-TRON switch object
Standard “services” are associated with objects. Services exist for reading an attribute,
setting an attribute, resetting a device, etc. See references [1] and [2] for specific details.
The following sections describe the attributes associated with each object type, such as
attribute Id number and data format. All attributes can be read, but only some can be set,
as shown by the “Set” column.
Revision February 18, 2011 Page 3 of 61
CIP Manual N-TRON Corp.
Id
Name
Set
Format
Description
1
Vendor ID
UINT (16)
1006. This is N-TRON’s ODVA EtherNet/IP
Vendor ID.
2
Device Type
UINT (16)
0x0C. Communications Adapter
3
Product Code
UINT (16)
Switch product code:
708TX = 701
708FX2 = 703
716TX = 705
716FX2 = 706
7018TX = 708
7018FX2 = 709
708M12 = 710
711FX3 = 711
7010TX = 713
709FX = 714
710FX2 = 715
714FX6 = 717
712FX4 = 718
7012FX2 = 719
7026TX = 720
7506GX2 = 7506
4
Major Revision
USINT (8)
Major version of CIP implementation.
Minor Revision
USINT (8)
Minor version of CIP implementation.
5
Status
WORD (16)
Summary status of device. Bits:
Bit 0 If set, device has an owner
Bit 1 reserved
Bit 2 If set, device has non-default
configuration
Bit 3 reserved
Bits 4-7 Extended device status – not used
Bit 8 Minor recoverable fault
Bit 9 Minor unrecoverable fault
Bit 10 Major recoverable fault
Bit 11 Major unrecoverable fault
Bits 12-15 reserved
(see fault table below)
6
Serial Number
UDINT (32)
Serial number of the device. This is the last 4
octets of the base switch MAC.
7
Product Name
SHORT_STRI
NG
Switch Model Number.
EX: N-TRON 7018FX2
15
Assigned_Name
Set
STRINGI
This is the user assigned switch name.
Identity Object
The identity object class (Class code = 0x01) and instance attributes are implemented as
defined by CIP Vol 1, 5-2 [1]. There is one instance (1) of this object. Service code
(0x32) will get all attributes, including optional attributes. The following table
summarizes the attributes in the Identity object.
Revision February 18, 2011 Page 4 of 61
CIP Manual N-TRON Corp.
17
Geographic_Location
Set
STRINGI
This is the user assigned switch location.
Bit
Called
Definition
8
Minor Recoverable Fault
Power supply 1, Power supply 2, N-Ring Full, System, Port
utilization, Temperature, N-Link partner is down, N-Link
integrity fault
9
Minor Unrecoverable Fault
Configuration device error
10
Major Recoverable Fault
N-Ring partial low, N-Ring partial high, N-Ring multiple
managers, Boot loader version, N-Link partner port unknown,
N-Link multiple masters, N-Link control fault, N-Link
configuration fault
11
Major Unrecoverable Fault
none
The table below defines fault bits within the Status attribute of the Identity object.
Revision February 18, 2011 Page 5 of 61
CIP Manual N-TRON Corp.
Id
Name
Set
Format
Description
1
Status
DWORD
(32)
Interface status
0 interface configuration attrib
not configured
1 interface configuration attrib
is valid
2
Configuration
Capability
DWORD
(32)
Interface capability flags. Bits:
0 BOOTP client capable
1 DNS client capable
2 DHCP client capable
3 DHCP-DNS update capable
4 Configuration is settable
5 Through bit 31 reserved
3
Configuration
Control
Set
DWORD
(32)
Interface control flags.
Bits 0-3:
0 use interface configuration
previously stored
1 get interface configuration
via BOOTP
2 get interface configuration
via DHCP
3 through 15 reserved
Bit 4=1 device shall resolve host names
by querying a DNS server
4
Physical Link
Object
STRUCT
of: Path Size
UINT (16)
Size of Path
Path
Padded
EPATH
Logical segments identifying the
physical link object
5
Interface
Configuration
STRUCT
of: IP Address
Set
UDINT (32)
The device’s IP address.
Network Mask
Set
UDINT (32)
The device’s network mask
Gateway
Address
Set
UDINT (32)
Default gateway address
Name Server
Set
UDINT (32)
Primary name server
Name Server 2
Set
UDINT (32)
Secondary name server
Domain Name
Set
STRING
Default domain name
6
Host Name
STRING
Host name
2.2.1 TCP/IP Interface Object
The TCP/IP Interface object class (Class code = 0xF5) and instance attributes are
implemented as defined by CIP Vol 2, 5-3 [2]. There is only one instance (1) of this
object. The following table summarizes the attributes in the TCP/IP Interface object.
Revision February 18, 2011 Page 6 of 61
CIP Manual N-TRON Corp.
Id
Name
Set
Format
Description
1
Interface Speed
UDINT (32)
Interface speed currently in use. Speed
in Mbps (e.g., 0, 10, 100, 1000, etc.)
2
Interface Flags
DWORD (32)
Interface status flags Bit map of
interface flags. See section 5-4.3.2.1.
Includes Link status, duplex mode,
auto-negotiation status, etc.
3
Physical Address
ARRAY of 6
USINTs (8)
MAC address of switch port. Base
MAC plus port number.
4
Interface Counters
STRUCT of:
In Octets
UDINT (32)
Octets received on the interface.
In Ucast Packets
UDINT (32)
Unicast packets received on the interface.
In Nucast Packets
UDINT (32)
Non-unicast packets received on the
interface.
In Discards
UDINT (32)
Inbound packets received on the interface
but discarded
In Errors
UDINT (32)
= 0. Not available.
Inbound packets that contain errors (does
not include In Discards).
In Unknown Protos
UDINT (32)
= 0. Not available.
Inbound packets with unknown protocol
Out Octets
UDINT (32)
Octets sent on the interface
Out Ucast Packets
UDINT (32)
Unicast packets sent on the interface
Out Nucast Packets
UDINT (32)
Non-unicast packets sent on the interface
Out Discards
UDINT (32)
Outbound packets discarded
Out Errors
UDINT (32)
= 0. Not available.
Outbound packets that contain errors
5
Media Counters
STRUCT of:
Alignment Errors
UDINT (32)
Frames received that are not an integral
number of octets in length
FCS Errors
UDINT (32)
Frames received that do not pass the FCS
check
Single Collisions
UDINT (32)
Successfully transmitted frames which
experienced exactly one collision
Multiple Collisions
UDINT (32)
Successfully transmitted frames which
experienced more than one collision
SQE Test Errors
UDINT (32)
= 0. Not available.
Number of times SQE test error message
is generated
Deferred Transmissions
UDINT (32)
Frames for which first transmission attempt
is delayed because the medium is busy
Late Collisions
UDINT (32)
Number of times a collision is detected
later than 512 bit times into the
transmission of a packet
Excessive Collisions
UDINT (32)
Frames for which transmission fails due to
excessive collisions
2.2.2 Ethernet Link Object
The Ethernet Link object class (Class code = 0xF6) and instance attributes are
implemented as defined by CIP Vol 2, 5-4 [2]. There is one instance of this object per
switch port where instance 1 = port 1, instance 2 = port 2, etc. As per the CIP
specification, the get all service code (0x01) will get all attributes, excluding vendor
extensions. Service code (0x32) will get all attributes, including the N-TRON vendor
extensions. The following table summarizes the attributes in the Ethernet Link object.
Revision February 18, 2011 Page 7 of 61
CIP Manual N-TRON Corp.
MAC Transmit Errors
UDINT (32)
= 0. Not available.
Frames for which transmission fails due to
an internal MAC sub layer transmit error
Carrier Sense Errors
UDINT (32)
= 0. Not available.
Times that the carrier sense condition was
lost or never asserted when attempting to
transmit a frame
Frame Too Long
UDINT (32)
Frames received that exceed the
maximum permitted frame size
MAC Receive Errors
UDINT (32)
= 0. Not available.
Frames for which reception on an interface
fails due to an internal MAC sub layer
receive error
6
Interface Control
STRUCT of:
Control Bits
Set
WORD (16)
Interface Control Bits. Includes autonegotiation and duplex settings.
Forced Interface Speed
Set
UINT (16)
Speed at which the interface shall be
forced to operate. Speed in Mbps (10,
100, 1000, etc.)
7
Interface Type
USINT (8)
Type of interface: twisted pair, fiber,
internal, etc
8
Interface State
USINT (8)
Current state of the interface: operational,
disabled, etc
9
Admin State
Set
USINT (8)
Administrative state: enable, disable
10
Interface Label
SHORT_STR
ING
Human readable identification: TX1, FX1,
GB1, etc.
100
Interface Description
SHORT_STR
ING
Human readable description. For example:
Port 1 - 10/100 Mbit TX
Port 15 - 100 MBit FX
101
Interface Utilization
USINT (8)
Percentage of entire interface bandwidth
being used (0-100).
102
Utilization Alarm Upper Threshold
Set
USINT (8)
Upper percentage at which to declare a
utilization alarm (0-100).
103
Utilization Alarm Lower Threshold
Set
USINT (8)
Lower percentage at which to declare a
utilization alarm (0-100).
104
Broadcast Limit
Set
USINT (8)
Broadcast limiting percentage (0-100).
(BPCL)
105
TX Unicast Packet Rate
UDINT32
Number of TX unicast packets per second.
106
RX Unicast Packet Rate
UDINT32
Number of RX unicast packets per second.
107
TX Multicast Packet Rate
UDINT32
Number of TX multicast packets per
second
108
RX Multicast Packet Rate
UDINT32
Number of RX multicast packets per
second
109
TX Broadcast Packet Rate
UDINT32
Number of TX broadcast packets per
second.
110
RX Broadcast Packet Rate
UDINT32
Number of RX broadcast packets per
second.
111
TX Multicast Packets
UDINT32
Total number of TX multicast packets.
112
RX Multicast Packets
UDINT32
Total number of RX multicast packets.
113
TX Broadcast Packets
UDINT32
Total number of TX broadcast packets.
114
RX Broadcast Packets
UDINT32
Total number of RX broadcast packets.
115
Port Role
UDINT32
Bit mask of port roles. Bits=
0 = RSTP
1 = N-Ring
2 = N-Link Control
3 = N-Link Partner
4 = N-Link Coupler
Revision February 18, 2011 Page 8 of 61
CIP Manual N-TRON Corp.
Id
Name
Set
Format
Description
1
Device Up
Time
UDINT (32)
Number of seconds since device was powered up.
2
Port Count
UDINT (32)
Total port count
3
Valid Ports
LWORD (64)
AB: DINT[2]
0 = Invalid Port, 1 = Port Exists on device
Bit 0: Port 1
Bit 1: Port 2
etc.
4
Global Admin
Status
LWORD (64)
AB: DINT[2]
0 = Port Disabled, 1 = Port Enabled
Bit 0: Port 1
Bit 1: Port 2
etc.
5
Global Link
Status
LWORD (64)
AB: DINT[2]
0 = Link Down, 1 = Link Up
Bit 0: Port 1
Bit 1: Port 2
etc.
6
System Faults
DWORD (32)
Bit 00: Power Supply 1
Bit 01: Power Supply 2
Bit 02: N-Ring Fault (complete)
Bit 03: N-Ring Partial Fault (low port)
Bit 04: N-Ring Partial Fault (high port)
Bit 05: N-Ring Multiple Managers
Bit 06: System error
Bit 07: Dongle Configuration Invalid
Bit 08: N-Link Fault
Bit 09: Boot loader version mismatch
Bit 10: Port Utilization Alarm
Bit 11: Temperature Alarm
7
IGMP Querier
Status
USINT (8)
Query Status:
0 = Disabled, 1 = Active (manual), 2 = Active
(Auto), 3 = Backup (Auto) [enabled but not active].
8
IGMP Version
USINT (8)
IGMP Version (V1, V2, V3, etc).
9
IGMP
Resource
Usage
USINT (8)
Percent of maximum capacity. Takes into account
the number of groups used per max groups and any
other possible resource limitations (0-100).
10
IGMP Active
Querier
UDINT (32)
IP of the active IGMP querier.
11
CPU Usage
USINT (8)
Percent of usage (0-100).
12
Class 1
Connections
UINT (16)
Number of CIP Ethernet/IP class 1 (multicast)
connections.
13
Class 3
Connections
UINT (16)
Number of CIP Ethernet/IP class 3 (unicast)
connections.
2.2.3 N-TRON Object
The N-TRON object (Class code = 0xC0) is a vendor specific object and is implemented
as defined by CIP Vol 1, 4 [1]. There is only one instance (1) of this object. The
following table summarizes the attributes of the N-TRON object.
Revision February 18, 2011 Page 9 of 61
CIP Manual N-TRON Corp.
14
Temperature
Alarm Upper
Threshold
Set
INT (16)
Upper temperature (C) at which to declare an alarm
15
Temperature
Alarm Lower
Threshold
Set
INT (16)
Lower temperature (C) at which to declare an alarm
16
Contact Status
BYTE (8)
2 Bits per contact. 00=Not Present, 01=Open,
10=Closed.
17
Temperature_C
INT (16)
Temperature in degrees C. 0x7FFF = Not Supported
on device.
18
Temperature_F
INT (16)
Temperature in degrees F. 0x7FFF = Not Supported on
device.
19
Reset MIB
Counts
Set
LWORD (64)
Reset port MIB counters. (1 bit per port to reset).
20
Device MAC
Address
ARRAY of 6
USINTs (8)
MAC address of device
21
Device Role
UDINT (32)
Bit mask of device roles. Bits=
0 = N-Ring Manager
1 = N-Ring Member
2 = N-Ring AutoDetect
3 = N-Link Master
4 = N-Link Slave
5 = N-Link Coupler
22
Config Device
Status
BYTE (8)
0 = Not Supported, 1 = Not Present, 2 = Present
23
System
Configuration
Set
UDINT32
Bit mask of system config. Bits=
Bit 0: GET: Changes have been made that have not
been saved.
SET: Save system configuration to flash.
Bit 1: GET: Changes have been made that require a
reboot to take affect.
SET: Shutdown and reboot device
24
System
Firmware
Version String
SHORT_STR
ING
Human readable representation of firmware version
string.
25
System Boot
Loader
Version String
SHORT_STR
ING
Human readable representation of boot loader
version string.
26
System Fault
String
STRINGI
Human readable representation of error status.
May contain multiple errors. Length is contained
as part of the STRINGI data type.
Revision February 18, 2011 Page 10 of 61
CIP Manual N-TRON Corp.
Service
Code
Service Description
Identity
TCP/IP
Ethernet
Link
N-TRON
1
Get_Attributes_All
yes
yes
yes
yes
5
Reset
Yes – reset
switch or
restore factory
configuration
14
Get_Attribute_Single
yes
yes
yes
yes
16
Set_Attribute_Single
Attributes
15,17
Attributes
3,5
Attributes
6,9, 102104
Attributes
14,15,19,23
Vendor
Specific
50
Get_All_Attributes –
including vendor
defined attributes
yes yes
Object
Specific
76
Get_And_Clear
Attributes
4,5
N-TRON switch
Assembly Number
Size (bytes)
Input (to switch)*
101
4
Output (from switch)
102
104
Configuration*
103
0
2.3 CIP Services
The table following is a summary of the supported services as defined by CIP Vol 1,
Appendix A: Explicit Messaging Services [1].
2.4 Accessing Data
2.4.1 Explicit Messaging
Explicit messaging refers to a request/response form of communications over a CIP
(TCP/IP) connection. Applications can use explicit messaging, for example, to invoke the
“Get All Attributes” service and read all attributes of the Identity object.
2.4.2 I/O Connections
I/O connections are used to send data (grouped in assemblies) between devices
periodically. The interval between sends is the “Requested Packet Interval”, or
RPI.
The N-TRON switch assemblies (Input, Output, and Configuration) are defined in
the following table.
Revision February 18, 2011 Page 11 of 61
* - not currently used
CIP Manual N-TRON Corp.
In an RSLogix 5000 environment, these assemblies are configured in the
“Connection Parameters” panel of the Generic Ethernet Module. (Note that input
and output assemblies are reversed.) More information is contained in the
section for Add-On Instruction installation.
3 Rockwell RSLogix 5000 – Add-On Instruction Installation
N-TRON 700-Series Switch
RSLogix Add-On Instructions (AOI)
Installation Instructions
Software installation prerequisites
1. RSLogix 5000 version 17 or later
2. N-TRON switch with firmware version 3 or later
Summary of steps
1. Import the Add-On Instruction (AOI)
2. Add your N-TRON switch to the I/O Configuration tree
3. Add an instance of the AOI in your application
4. Create and configure tags for the AOI
3.1 Configuration of RSLogix project
Extract all files from the zip file to your desktop or destination folder.
Open an RSLogix project.
Import the N-TRON Add-On Instruction (AOI). In the controller organizer window, right
click “Add-On Instructions” folder, select “Import Add-On Instruction” and browse to
the folder containing AOI_NTRON_*.L5X files. Import an AOI for each switch type
installed.
Revision February 18, 2011 Page 12 of 61
CIP Manual N-TRON Corp.
.
The Add-On Instruction tree showing AOIs for 708FX2, 708TX, and several auxiliary
AOIs.
Add a Generic Ethernet Module to the I/O Configuration.
Revision February 18, 2011 Page 13 of 61
CIP Manual N-TRON Corp.
The Generic Ethernet Module is located under the “Communications” group:
Configure the module as shown. Use the proper IP address and connection parameters for
your installation.
Revision February 18, 2011 Page 14 of 61
CIP Manual N-TRON Corp.
Click the Connection tab and set the desired RPI. The input assembly will be received
from the switch at the selected RPI.
Click OK The new module will appear in the I/O Configuration tree:
Revision February 18, 2011 Page 15 of 61
CIP Manual N-TRON Corp.
Create a new rung in the MainRoutine and add the AOI for your specific switch to the
rung.
The following will appear:
Revision February 18, 2011 Page 16 of 61
CIP Manual N-TRON Corp.
Add tag names for the various fields. For example:
Right click on each new tag name and create each tag. (Note that the tags for
Switch_Inputs and Switch_Outputs, shown in the rectangle above, were created when the
Generic Ethernet Module was added.)
For example:
Click the button to the right of the “Get_Message” tag and configure as shown:
Revision February 18, 2011 Page 17 of 61
CIP Manual N-TRON Corp.
Revision February 18, 2011 Page 18 of 61
CIP Manual N-TRON Corp.
Click the button to the right of the “Get_Message_Extended” tag and configure as shown:
Revision February 18, 2011 Page 19 of 61
Loading...