N-Tron CIP NT24k User Manual

CIP

User Manual &

Installation

Guide

NT24k Switch Family

CIP – Common Industrial Protocol

CIP Manual – NT24k N-Tron Corporation

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 Identity Object ............................................................................................................ 4

2.2.2 TCP/IP Interface Object .............................................................................................. 6

2.2.3 Ethernet Link Object ................................................................................................... 7

2.2.4 N-TRON Object .......................................................................................................... 8

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 ....................................................... 13

3.1 Configuration of RSLogix project ..................................................................................... 13

3.2 Input_Assembly Parameter ............................................................................................. 22

3.3 Switch_Parameters Parameter ........................................................................................ 23

3.4 Explicit Messaging Options .............................................................................................. 23

3.5 Troubleshooting .............................................................................................................. 23

3.6 Sample Project ................................................................................................................ 24

4 Rockwell RSLogix 5000 – Tag reference ................................................................................ 25

4.1 Generic assembly tags .................................................................................................... 25

4.2 NT24k assembly tags ..................................................................................................... 27

4.3 System fault tags ............................................................................................................. 29

4.4 CIP Tags ......................................................................................................................... 31

4.5 Identity object .................................................................................................................. 31

4.6 TCPIP object ................................................................................................................... 31

4.7 Ethernet Link object ......................................................................................................... 32

4.8 N-TRON Switch object .................................................................................................... 34

5 Support .................................................................................................................................. 37

6 References ............................................................................................................................. 37

7 Revisions ............................................................................................................................... 37

Revision August 23, 2013, 2013 Page 2 of 37

CIP Manual – NT24k N-Tron Corporation

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 August 23, 2013, 2013 Page 3 of 37

CIP Manual – NT24k N-Tron Corporation

2.2.1

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.

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:

NT24k = 24001

NT24k-DR16 = 24002

NT24k-DR24 = 24003

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

15 Assigned_Name Set STRINGI

Switch Model Number.

EX: N-Tron NT24k

This is the user assigned switch name.

17 Geographic_Location Set STRINGI

This is the user assigned switch location.

The table below defines fault bits within the Status attribute of the Identity object.

Revision August 23, 2013, 2013 Page 4 of 37

CIP Manual – NT24k N-Tron Corporation

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

Revision August 23, 2013, 2013 Page 5 of 37

CIP Manual – NT24k N-Tron Corporation

2.2.2

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.

Id Name

1 Status DWORD

Set Format

(32)

Description

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

5 Interface

STRUCT

Configuration

EPATH

of:

Logical segments identifying the physical link object

IP Address Set UDINT (32) The device’s IP address. Network Mask Set UDINT (32) The device’s network mask Gateway

Set UDINT (32) Default gateway address 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

Revision August 23, 2013, 2013 Page 6 of 37

CIP Manual – NT24k N-Tron Corporation

2.2.3

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.

Name

1 Interface Speed

2 Interface Flags

3 Physical Address

Interface Counters In Octets In Ucast Packets In Nucast Packets In Discards

In Errors

In Unknown Protos

Out Octets Out Ucast Packets Out Nucast Packets Out Discards Out Errors

Media Counters Alignment Errors

FCS Errors Single Collisions

Multiple Collisions

SQE Test Errors

Deferred Transmissions

Late Collisions

Excessive Collisions

MAC Transmit Errors

Set

Format

UDINT (32)

DWORD (32)

ARRAY of 6 USINTs (8)

STRUCT of: UDINT (32) UDINT (32) UDINT (32) UDINT (32)

UDINT (32)

UDINT (32) UDINT (32) UDINT (32) UDINT (32) UDINT (32)

STRUCT of: UDINT (32)

UDINT (32) UDINT (32)

UDINT (32)

Description

Interface speed currently in use. Speed in Mbps (e.g., 0, 10, 100, 1000, etc.) Interface status flags Bit map of interface flags. See section 5-4.3.2.1. Includes Link status, duplex mode, auto-negotiation status, etc. MAC address of switch port. Base MAC plus port number.

Octets received on the interface. Unicast packets received on the interface. Non-unicast packets received on the interface. Inbound packets received on the interface but discarded = 0. Not available. Inbound packets that contain errors (does not include In Discards). = 0. Not available. Inbound packets with unknown protocol Octets sent on the interface Unicast packets sent on the interface Non-unicast packets sent on the interface Outbound packets discarded = 0. Not available. Outbound packets that contain errors

Frames received that are not an integral number of octets in length Frames received that do not pass the FCS check Successfully transmitted frames which experienced exactly one collision Successfully transmitted frames which experienced more than one collision = 0. Not available. Number of times SQE test error message is generated Frames for which first transmission attempt is delayed because the medium is busy Number of times a collision is detected later than 512 bit times into the transmission of a packet Frames for which transmission fails due to excessive collisions = 0. Not available. Frames for which transmission fails due to an

Revision August 23, 2013, 2013 Page 7 of 37

CIP Manual – NT24k N-Tron Corporation

Carrier Sense Errors

Frame Too Long

MAC Receive Errors

9 10

100

101

102

103

104 105 106 107 108 109 110 111 112 113 114 115

Interface Control Control Bits

Forced Interface Speed

Interface Type

Interface State

Admin State Interface Label

Interface Description

Interface Utilization

Utilization Alarm Upper Threshold

Utilization Alarm Lower Threshold

Broadcast Limit TX Unicast Packet Rate RX Unicast Packet Rate TX Multicast Packet Rate RX Multicast Packet Rate TX Broadcast Packet Rate RX Broadcast Packet Rate TX Multicast Packets RX Multicast Packets TX Broadcast Packets RX Broadcast Packets Port Role

Set

UDINT (32)

STRUCT of: WORD (16)

UINT (16)

USINT (8)

USINT (8) SHORT_STRI NG

SHORT_STRI NG

USINT (8)

USINT (8) UDINT32 UDINT32 UDINT32 UDINT32 UDINT32 UDINT32 UDINT32 UDINT32 UDINT32 UDINT32 UDINT32

2.2.4

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.

internal MAC sub layer transmit error = 0. Not available. Times that the carrier sense condition was lost or never asserted when attempting to transmit a frame Frames received that exceed the maximum permitted frame size = 0. Not available. Frames for which reception on an interface fails due to an internal MAC sub layer receive error

Interface Control Bits. Includes autonegotiation and duplex settings. Speed at which the interface shall be forced to operate. Speed in Mbps (10, 100, 1000, etc.)

Type of interface: twisted pair, fiber, internal, etc. Current state of the interface: operational, disabled, etc. Administrative state: enable, disable Human readable identification: TX1, FX1, GB1, etc.

Human readable description. For example: Port 1 - 10/100 Mbit TX Port 15 - 100 MBit FX Percentage of entire interface bandwidth being used (0-100). Upper percentage at which to declare utilization alarm (0-100). Lower percentage at which to declare a utilization alarm (0-100). Broadcast limiting percentage (0-100). (BPCL) Number of TX unicast packets per second. Number of RX unicast packets per second. Number of TX multicast packets per second Number of RX multicast packets per second Number of TX broadcast packets per second. Number of RX broadcast packets per second. Total number of TX multicast packets. Total number of RX multicast packets. Total number of TX broadcast packets. Total number of RX broadcast packets. Bit mask of port roles. Bits= 0 = RSTP 1 = N-Ring 2 = N-Link Control 3 = N-Link Partner 4 = N-Link Coupler

Revision August 23, 2013, 2013 Page 8 of 37

CIP Manual – NT24k N-Tron Corporation

Name

Device Up

Set

Format

UDINT (32)

Description

Number of seconds since device was powered up.

Time

2 3

Port Count Valid Ports

UDINT (32) LWORD (64)

AB: DINT[2]

Total port count 0 = Invalid Port, 1 = Port Exists on device Bit 0: Port 1 Bit 1: Port 2 etc.

Global Admin Status

LWORD (64) AB: DINT[2]

0 = Port Disabled, 1 = Port Enabled Bit 0: Port 1 Bit 1: Port 2 etc.

Global Link Status

LWORD (64) AB: DINT[2]

0 = Link Down, 1 = Link Up Bit 0: Port 1 Bit 1: Port 2 etc.

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: the configuration on an installed configuration device is invalid Bit 08: N-Link Fault Bit 09: Boot loader version mismatch Bit 10: Port Utilization Alarm Bit 11: Temperature Alarm

IGMP Querier Status

USINT (8)

Query Status: 0 = Disabled, 1 = Active (manual), 2 = Active (Auto), 3 = Backup (Auto) [enabled but not active].

IGMP Version

IGMP Resource Usage IGMP Active

USINT (8) USINT (8)

UDINT (32)

IGMP Version (V1, V2, V3, etc.). Percent of maximum capacity. Takes into account the number of groups used per max groups and any other possible resource limitations (0-100). IP of the active IGMP querier.

Querier

11 12

CPU Usage Class 1 Connections Class 3 Connections

Temperature Alarm Upper Threshold

USINT (8) UINT (16)

UINT (16)

Set INT (16)

Percent of usage (0-100). Number of CIP EtherNet/IP class 1 (multicast) connections. Number of CIP EtherNet/IP class 3 (unicast) connections.

Upper temperature (C) at which to declare an alarm

Revision August 23, 2013, 2013 Page 9 of 37

CIP Manual – NT24k N-Tron Corporation

Temperature Alarm Lower Threshold

Contact Status

Temperature_C

Temperature_F

Reset MIB Counts Device MAC Address

Device Role

Config Device Status

Set INT (16)

BYTE (8)

Lower temperature (C) at which to declare an alarm

2 Bits per contact. 00=Not Present, 01=Open, 10=Closed.

INT (16)

Set LWORD (64)

ARRAY of 6 USINTs (8)

UDINT (32) Bit mask of device roles. Bits=

BYTE (8)

Temperature in degrees C. 0x7FFF = Not Supported on device. Temperature in degrees F. 0x7FFF = Not Supported on device.

Reset port MIB counters. (1 bit per port to reset).

MAC address of device

0 = N-Ring Manager 1 = N-Ring Member 2 = N-Ring AutoDetect 3 = N-Link Master 4 = N-Link Slave 5 = N-Link Coupler

0 = Not Supported, 1 = Not Present, 2 = Present

System Configuration

System Firmware Version String

System Boot Loader Version String

System Fault String

Power Configuration

Set UDINT (32) 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 effect. SET: Shutdown and reboot device

SHORT_STRI NG

STRINGI

Human readable representation of firmware version string.

Human readable representation of boot loader version string.

Human readable representation of error status. May contain multiple errors. Length is contained as part of the STRINGI data type.

UDINT (32)

4 Bits per power supply. 0000 = DC Power, 0001 = AC Power, 1111 = Unknown. Power supply 1 configuration is in bits 0-3 and Power supply 2 configuration is in bits 4-7.

Revision August 23, 2013, 2013 Page 10 of 37

CIP Manual – NT24k N-Tron Corporation

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].

Service Code 1 Get_Attributes_All yes yes yes yes 5 Reset Yes – reset

14 Get_Attribute_Single yes yes yes yes 16 Set_Attribute_Single Attributes

Vendor Specific 50 Get_All_Attributes –

Object Specific 76 Get_And_Clear Attributes

Service Description Identity TCP/IP Ethernet

Link

switch or restore factory configuration

Attributes

15,17

yes yes including vendor defined attributes

3,5

Attributes 6,9, 102104

4,5

N-TRON

Attributes 14,15,19,23

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.

N-TRON switch Assembly Number Input (to switch)* 101 4 Output (from switch) Configuration* 103 0

* - not currently used

102 104

Size (bytes)

Revision August 23, 2013, 2013 Page 11 of 37

CIP Manual – NT24k N-Tron Corporation

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.

Revision August 23, 2013, 2013 Page 12 of 37

+ 25 hidden pages