Overview

The Port object describes the communication interfaces that exist on the device and that are visible to CIP.

Class ID

F4 (hex), 244 (decimal)

Instance IDs

The Port object presents two instances:

  • 0: class

  • 1: instance

Attributes

Port object attributes are associated with each instance, as follows:

Instance ID = 0 (class attributes):

Attribute ID (hex and dec)

Description

GET

SET

01

Revision

X

—

02

Maximum Instance

X

—

03

Number of Instances

X

—

04

Optional Attribute List

X

—

05

Optional Service List

X

—

06

Optional Maximum Number of Class Attributes

X

—

07

Optional Maximum Number of Instance Attributes

X

—

08

Entry Port

Returns the instance of the Port object that describes the port through which this request entered the device

X

—

09

Port Instance Information

Array of structures containing instance attributes 1 and 2 (see below) from each port instance

X

—

Port Type (see Instance attribute 01)

X

—

Port Number (see Instance attribute 02)

X

—

X = supported

— = not supported

Instance ID = 1 (instance attributes):

Attribute ID

Description

Type

GET

SET

Value

hex

dec

01

01

Port Type.

UINT

X

—

  • 0: Routing not supported

  • 1: Vendor specific

  • 2: ControlNet

  • 3: ControlNet Redundant

  • 4: EtherNet/IP (formerly TCP/IP)

  • 5: DeviceNet

  • 6-199: Vendor specific

  • 200: CompoNet

  • 201: Modbus/TCP

  • 202: Modbus/SL

  • 203: SERCOS III

  • 204: HART

  • 205: IO-Link

  • 206-65535: Reserved

02

02

Port Number

X

—

The CIP number

03

03

Logical Link Object

STRUCT of

X

—

A list of supported objects (i.e. a structure with an array of object class codes supported by the device)

Path Length

UINT

X

—

The number of 16-bit words in the following path.

Link Path

Padded EPATH

X

—

Logical path segments that identify the object for this port.

04

04

Port Name

SHORT_STRING

X

—

String name of port interface name, up to 64 characters

05

05

Port Type Name

SHORT_STRING

X

—

String name of port interface type, up to 64 characters

06

06

Port Description

SHORT_STRING

X

—

String that describes the port

07

07

Port Number and Node Address

Padded EPATH

X

—

A single port segment containing the Port Number of this port and the Link Address of this device on this port.

08

08

Port Node Range

STRUCT of

X

—

Minimum Node Number

UINT

X

—

For example, on port.

Maximum Node Number

UINT

X

—

For example, on port.

09

09

Chassis Identity

Packed EPATH

X

—

Electronic key of the chassis to which this port is attached. This attribute is a single Logical Electronic Key Segment with Format 4 of the Logical Electronic Key segment.

A

10

Port Routing Capabilities

DWORD

X

—

Bit string defining the routing capabilities of this port, where 0=not-supported, 1=supported:

  • bit 0: Incoming unconnected messages

  • bit 1: Outgoing unconnected messages

  • bit 2: Incoming transport class 0/1 connections

  • bit 3: Outgoing transport class 0/1 connections

  • bit 4: Incoming transport class 2/3 connections

  • bit 5: Outgoing transport class 2/3 connections

  • bit 6: Outgoing DeviceNet CIP Safety connections (only for DeviceNet ports)

  • bits 7-31: Reserved

B

11

Associated Communication Objects

STRUCT of

X

—

List of communication object instances associated with this instantiated Port Object (see list, below)

Number of entries in following Array:

USINT

X

—

Array of STRUCT of

X

—

Number of 16 bit words in the following path

USINT

X

—

Logical path segments that identify an associated communication object instance

Padded EPATH

X

—

X = supported

— = not supported

The list of Associated Communication Objects in Attribute 11 (dec) / B (hex) includes:

DeviceNet Object – 0x03

RSTP Port Object – 0x55

TCP/IP Interface Object – 0xF5

Modbus Object – 0x44

Parallel Redundancy Protocol Object – 0x56

Ethernet Link Object – 0xF6

Modbus Serial Link Object – 0x46

PRP Nodes Table Object – 0x57

0xF6 • CompoNet Link Object – 0xF7

Device Level Ring Object – 0x47

EtherNet/IP Security Object – 0x5E

CompoNet Repeater Object – 0xF8

QoS Object – 0x48

ControlNet Object – 0xF0

CompoNet Repeater Object – 0xF8

SERCOS III Link Object – 0x4C

ControlNet Keeper Object – 0xF1

IO-Link Master PHY Object – 0x10C

RSTP Bridge Object – 0x54

ControlNet Scheduling Object – 0xF2

—

Services

The port object performs the following services upon the listed object types:

Service ID

Description

Class

Instance

Notes

hex

dec

01

01

Get_Attributes_All

X

X

Returns:

  • all class attributes (instance = 0)

  • instance attributes 1 to 7 (instance = 1)

10

10

Set_Attribute_Single

—

X

Modifies an attribute..

0E

14

Get_Attribute_Single

X

X

Returns the value of the specified attribute.

X = supported

— = not supported