E6581741

4.10. Port Object (0xF4)

Class code 0xF4.

The Port Object enumerates the CIP ports present on the device.

One instance exists for each CIP port.

Class Attributes

Instance

Attribute ID

Access

Name

Data type

Details

Value

 

1

Get

Revision

UINT

Revision of this object

1

 

2

Get

Max Instances

UINT

Maximum instance number of an

1

 

 

 

 

 

object currently created in this class

 

 

 

 

 

 

level of the device.

 

 

3

Get

Number of Instances

UINT

Number of object instances currently

1

 

 

 

 

 

created at this class level of the

 

 

 

 

 

 

device.

 

 

6

Get

Max ID of class

UINT

The attribute ID number of the last

9

 

 

 

attributes

 

class attribute of the class definition

 

 

 

 

 

 

implemented in the device.

 

0

7

Get

Max ID of instance

UINT

The attribute ID number of the last

7

 

 

 

attribute

 

instance attribute of the class

 

 

 

 

 

 

definition implemented in the device.

 

 

8

Get

Entry Port

UINT

Returns the instance of the Port

1

 

 

 

 

 

Object that describes the port

 

 

 

 

 

 

through which this request entered

 

 

 

 

 

 

the device.

 

 

9

Get

All Ports

STRUCT

Array of structures containing

0000

 

 

 

 

of

instance attributes 1 and 2 from

0000

 

 

 

 

Port Type

each instance.

0000

 

 

 

 

Port

 

0200

 

 

 

 

Number

 

 

Note: Attribute 9

 

 

 

 

 

00 00 00 00 -> port type = 0 (Connection terminated)

/ instance number = 0 (class)

 

00 00 02 00 -> port type = 2 (TCP/IP Port)

/ port number = 2

 

Class Services

Service Code

Service Name

0x01

Get_Attribute_All

0x0E

Get_Attribute_Single

Description of Service

Read all attributes

Read one attribute

Instance 1 Attribute

Instance

Attribute ID

Access

Name

Data type

Details

Value

 

1

Get

Port Type

UINT

Enumerate the type of port.

0

 

 

 

 

 

(0 = TCP/IP)

 

 

2

Get

Port Number

UINT

CIP port associated with this port

2

 

 

 

 

 

(identify each communication port).

 

 

 

 

 

 

Value ‘1’ is reserved.

 

 

3

Get

Link Object

STRUCT

Identify Object attached to this port.

02 00

 

 

 

 

of

For EtherNet/IP, this path

20 F5

 

 

 

 

UINT

corresponds to TCP/IP Interface

24 01

1

 

 

 

Padded

object.

 

 

 

 

EPATH

 

 

 

4

Get

Port Name

SHORT_

String which names the port.

0B 45

 

 

 

 

STRING

11, EtherNet/IP

74 68

 

 

 

 

 

 

65 72

 

 

 

 

 

 

4E 65

 

 

 

 

 

 

74 2F

 

 

 

 

 

 

49 50

 

7

Get

Node address

Padded

Node number of this device on port.

-

 

 

 

 

EPATH

The range within this data type is

 

 

 

 

 

 

restricted to a Port Segment.

 

Instance Services

Service Code

Service Name

0x01

Get_Attribute_All

0x0E

Get_Attribute_Single

Description of Service

Read all attributes

Read one attribute

- 36 -

Page 37
Image 37
Toshiba IPE002Z Port Object 0xF4, 0x01 GetAttributeAll 0x0E GetAttributeSingle, Read all attributes Read one attribute