Messaging (Explicit Exchanges)

Identity

01 hex

1

Supports the reset service

Message router

02 hex

1

Explicit message connection

Assembly

04 hex

2

Defines I/O data format

Connection manager

06 hex

1

Manages the internal resources associated with both I/O and explicit messaging conditions

TCP/IP interface

F5 hex

1

TCP/IP configuration

Ethernet link

F6 hex

1

Counter and status information

Port object

F4 hex

1

Describes the communication interfaces that are present on the device and visible to CIP

Base energy

4E hex

1

Acts as an energy supervisor for CIP energy implementations

Electrical energy

4F hex

1

Provides unified electrical energy reporting capability for CIP enabled devices and processes

01 hex

1

1

Get

Revision

UINT

Revision of this object

The current value assigned to this attribute is one (01). If updates that require an increase in this value are made, then the value of this attribute increases by 1

2

Get

Max instances

UINT

Maximum instance number of an object currently created in this class level of the device

The largest instance number of a created object at this class hierarchy level

3

Get

Number of instances

UINT

Number of object instances currently created at this class level of the device

The number of object instances at this class hierarchy level

6

Get

Max ID number of class attribute

UINT

The attribute ID number of the last class attribute of the class definition implemented in the device

-

7

Get

Max ID number of instance attribute

UINT

The attribute ID number of the last instance attribute of the class definition implemented in the device

-

1

Get

Vendor ID

UINT

Identification of each vendor by number

-

2

Get

Device type

UINT

Indication of general type of product

-

3

Get

Product code

UINT

Identification of a particular product of an individual vendor

-

4

Get

Revision

STRUCT of:

Revision of the item the identity object represents

Identifies the revision of the item the identity object is representing

Major revision

USINT

Minor revision

USINT

5

Get

Status

WORD

Summary status of device

This attribute represents the current status of the entire device. Its value changes as the state of the device changes

6

Get

Serial number

UDINT

Serial number of device

This attribute is a number used in conjunction with the Vendor ID to form a unique identifier for each device on any CIP network

7

Get

Product name

SHORT_STRING

Human readable identification

This text string shall represent a short description of the product represented by the Product Code in attribute 3.

01 hex

01 hex

Get_Attribute_All

Return all attributes

0E hex

0E hex

Get_Attribute_Single

Return single attribute

–

05 hex

Reset

Reset the communication module of the device

02 hex

2

1

Get

Revision

UINT

Revision of this object

The current value assigned to this attribute is one (01). If updates that require an increase in this value are made, then the value of this attribute increases by 1

2

Get

Max instances

UINT

Maximum instance number of an object currently created in this class level of the device

The largest instance number of a created object at this class hierarchy level

3

Get

Number of instances

UINT

Number of object instances currently created at this class level of the device

The number of object instances at this class hierarchy level

4

Get

Optional attribute list

STRUCT of:

List of optional instance attributes utilized in an object class implementation

A list of attribute numbers specifying the optional attributes implemented in the device for this class

Number of attributes

UINT

Number of attributes in the optional attribute list

The number of attribute numbers in the list

Optional attributes

ARRAY of UINT

List of optional attribute numbers

The optional attribute numbers

6

Get

Max ID number of class attribute

UINT

The attribute ID number of the last class attribute of the class definition implemented in the device

-

7

Get

Max ID number of instance attribute

UINT

The attribute ID number of the last instance attribute of the class definition implemented in the device

-

1

Get

Object_list

STRUCT of:

A list of supported objects

Structure with an array of object class codes supported by the device

Number

UINT

Number of supported classes in the classes array

The number of class codes in the classes array

Classes

ARRAY of UINT

List of supported class codes

The class codes supported by the device

2

Get

Number available

UINT

Maximum number of connections supported

Count of the max number of connections supported

01 hex

Get_Attribute_All

Return all attributes

0E hex

Get_Attribute_Single

Return single attribute

04 hex

4

1

Get

Revision

UINT

Revision of this object

The current value assigned to this attribute is two (02)

3

Set

Data

ARRAY of BYTE

-

-

0E hex

Get_Attribute_Single

Return single attribute

1

Get

Revision

UINT

Revision of this object

The current value assigned to this attribute is one (01). If updates that require an increase in this value are made, then the value of this attribute increases by 1

2

Get

Max instances

UINT

Maximum instance number of an object currently created in this class level of the device

The largest instance number of a created object at this class hierarchy level

3

Get

Number of instances

UINT

Number of object instances currently created at this class level of the device

The number of object instances at this class hierarchy level

4

Get

Optional attribute list

STRUCT of:

List of optional instance attributes utilized in an object class implementation

A list of attribute numbers specifying the optional attributes implemented in the device for this class

Number of attributes

UINT

Number of attributes in the optional attribute list

The number of attribute numbers in the list

Optional attributes

ARRAY of UINT

List of optional attribute numbers

The optional attribute numbers

6

Get

Max ID number of class attributes

UINT

The attribute ID number of the last class attribute of the class definition implemented in the device

-

7

Get

Max ID number of instance attributes

UINT

The attribute ID number of the last instance attribute of the class definition implemented in the device

-

1

Set

Open requests

UINT

Number of forward open service requests received

-

2

Set

Open format rejects

UINT

Number of forward open service requests which were rejected due to bad format

-

3

Set

Open resource rejects

UINT

Number of forward open service requests which were rejected due to lack of resources

-

4

Set

Open other rejects

UINT

Number of forward open service requests which were rejected for reasons other than bad format or lack of resources

-

5

Set

Close requests

UINT

Number of forward close service requests received

-

6

Set

Close format rejects

UINT

Number of forward close service requests which were rejected due to bad format

-

7

Set

Close other rejects

UINT

Number of forward close service requests which were rejected for reasons other than bad format

-

8

Set

Connection timeouts

UINT

Total number of connection timeouts that have occurred in connections controlled by this connection manager

-

01 hex

01 hex

Get_Attribute_All

Return all attributes

0E hex

0E hex

Get_Attribute_Single

Return single attribute

–

54 hex

Forward_Open

Opens a connection

–

4E hex

Forward_Close

Closes a connection

1

Get

Revision

UINT

Revision of this object

The current value assigned to this attribute is one (01). If updates that require an increase in this value are made, then the value of this attribute increases by 1

2

Get

Max instances

UINT

Maximum instance number of an object currently created in this class level of the device

The largest instance number of a created object at this class hierarchy level

3

Get

Number of instances

UINT

Number of object instances currently created at this class level of the device

The number of object instances at this class hierarchy level

1

Get

Status

DWORD

Interface status

Bit 0-3: Indicates the status of the interface configuration attribute

• 0 = The interface configuration attribute has not been configured

  1 = The interface configuration attribute contains configuration obtained from BOOTP, DHCP or non-volatile storage

  2 = The IP address member of the interface configuration attribute contains configuration, obtained from hardware settings

  3-15 = Reserved for future use

2

Get

Configuration capability

DWORD

Interface capability flags

Bit 0: 1 (TRUE) shall indicate the device is capable of obtaining its network configuration via BOOTP

Bit 1: 1 (TRUE) shall indicate the device is capable of resolving host names by querying a DNS server

Bit 2: 1 (TRUE) shall indicate the device is capable of obtaining its network configuration via DHCP

Bit 3: Shall be 0, behavior to be defined in a future specification edition

Bit 4: 1 (TRUE) shall indicate the interface configuration attribute is settable

Bit 5: 1 (TRUE) shall indicate the IP address member of the interface configuration attribute can be obtained from hardware settings

Bit 6: 1 (TRUE) shall indicate that the device requires a restart in order for a change to the interface configuration attribute to take effect

Bit 7: 1 (TRUE) shall indicate that the device is ACD capable

Bit 8-31: Reserved for future use and shall be set to zero

3

Get

Configuration control

DWORD

Interface control flags

Bit 0-3: Determines how the device shall obtain its IP-related configuration

• 0 = The device shall use statically-assigned IP configuration values

  1 = The device shall obtain its interface configuration values via BOOTP

  2 = The device shall obtain its interface configuration values via DHCP

  3-15 = Reserved for future use

Bit 4: 1 (TRUE) shall resolve host names by querying a DNS server

Bit 5-31: Reserved for future use and shall be set to zero

4

Get

Physical link object

STRUCT of:

Path to physical link object

This attribute identifies the object associated with the underlying physical communications interface

Path size

UINT

Size of path

Number of 16 bit words in path

Path

Padded EPATH

Logical segments identifying the physical link object

The path is restricted to one logical class segment and one logical instance segment. The maximum size is 12 bytes

5

Get

Interface configuration

STRUCT of:

TCP/IP network interface configuration

The interface configuration attribute contains the configuration parameters required for a device to operate as a TCP/IP node. The contents of the interface configuration attribute shall depend upon how the device has been configured to obtain its IP parameters

IP address

UDINT

The device’s IP address

Value of 0 indicates no IP address has been configured. Otherwise, the IP address shall be set to a valid class A, B, or C address and shall not be set to the loopback address (127.0.0.1)

Network mask

UDINT

The device’s network mask

Value of 0 indicates no network mask address has been configured

Gateway address

UDINT

Default gateway address

Value of 0 indicates no IP address has been configured. Otherwise, the IP address shall be set to a valid class A, B, or C address and shall not be set to the loopback address (127.0.0.1)

Name server

UDINT

Primary name server

Value of 0 indicates no name server address has been configured. Otherwise, the name server address shall be set to a valid class A, B, or C address

Name server 2

UDINT

Secondary name server

Value of 0 indicates no secondary name server address has been configured. Otherwise, the name server address shall be set to a valid class A, B, or C address

Domain name

STRING

Default domain name

ASCII characters. Maximum length is 48 characters. Shall be padded to an even number of characters (pad not included in length). A length of 0 shall indicate no domain name is configured

6

Get

Host name

STRING

Host name

ASCII characters. Maximum length is 64 characters. Shall be padded to an even number of characters (pad not included in length). A length of 0 shall indicate no host name is configured

13

Set

Encapsulation inactivity timeout

UINT

Number of seconds of inactivity before TCP connection or DTLS session is closed

0 = Disable

1-3600 = timeout in seconds

Default = 120

–

01 hex

Get_Attribute_All

Return all attributes

0E hex

0E hex

Get_Attribute_Single

Return single attribute

–

10 hex

Set_Attribute_Single

Write one attribute

1

Get

Revision

UINT

Revision of this object

The current value assigned to this attribute is one (01). If updates that require an increase in this value are made, then the value of this attribute increases by 1

2

Get

Max instances

UINT

Maximum instance number of an object currently created in this class level of the device

The largest instance number of a created object at this class hierarchy level

3

Get

Number of instances

UINT

Number of object instances currently created at this class level of the device

The number of object instances at this class hierarchy level

4

Get

Optional attribute list

STRUCT of:

List of optional instance attributes utilized in an object class implementation

A list of attribute numbers specifying the optional attributes implemented in the device for this class

Number of attributes

UINT

Number of attributes in the optional attribute list

The number of attribute numbers in the list

Optional attributes

ARRAY of UINT

List of optional attribute numbers

The optional attribute numbers

6

Get

Max ID number of class attribute

UINT

The attribute ID number of the last class attribute of the class definition implemented in the device

-

7

Get

Max ID number of instance attribute

UINT

The attribute ID number of the last instance attribute of the class definition implemented in the device

-

1

Get

Interface speed

UDINT

Interface speed currently in use

Speed in Mbps

2

Get

Interface flags

DWORD

Interface status flags

Bit 0: Link status indicates whether the IEEE 802.3 communications interface is connected to an active network. 0 indicates an inactive link; 1 indicates an active link

Bit 1: Half/Full duplex indicates the duplex mode currently in use. 0 indicates that the interface is running half duplex; 1 indicates full duplex

Bit 2-4: Negotiation status

• 0 = Auto-negotiation in progress

• 1 = Auto-negotiation and speed detection failed

• 2 = Auto negotiation failed but speed detected

• 3 = Successfully negotiated speed and duplex

• 4 = Auto-negotiation not attempted

Bit 5: Manual setting requires reset

Bit 6: 0 indicates the interface detects no local hardware fault; 1 indicates a local hardware fault is detected

Bit 7-31: Reserved shall be set to zero

3

Get

Physical address

Array of 6 USINTs

MAC layer address

The recommended display format is "XX-XX-XX-XX-XX-XX", starting with the first octet

7

Get

Interface type

USINT

Type of interface: twisted pair, fiber, internal

Value 0: Unknown interface type

Value 1: The interface is internal to the device

Value 2: Twisted-pair

Value 3: Optical fiber

Value 4-255: Reserved

8

Get

Interface state

USINT

Current state of the interface: operational, disabled

Value 0: Unknown interface state

Value 1: The interface is enabled and is ready to send and receive data

Value 2: The interface is disabled

Value 3: The interface is testing

Value 4-255: Reserved

10

Get

Interface label

SHORT_STRING

Human readable identification

The interface label attribute shall be a text string that describes the interface. The content of the string is vendor specific.

11

Get

Interface capability

STRUCT of:

Indication of capabilities of the interface

Bit 0: Manual setting requires reset

• 0 = Indicates that the device automatically applies changes made to the interface control attribute and, therefore, does not require a reset in order for changes to take effect.

• 1 = Indicates that the device does not automatically apply changes made to the interface control attribute and, therefore, will require a reset in order for changes to take effect.

Bit 1: Auto-negotiate

• 0 = Indicates that the interface does not support link auto-negotiation

• 1 = Indicates that the interface supports link auto-negotiation

Bit 2: Auto-MDIX

• 0 = Indicates that the interface does not support auto MDIX operation

• 1 = Indicates that the interface supports auto MDIX operation

Bit 2: Manual speed/duplex

• 0 = Indicates that the interface does not support manual setting of speed/duplex. The interface control attribute shall not be supported

• 1 = Indicates that the interface supports manual setting of speed/duplex via the interface control attribute

Bit 4-31: Reserved. Shall be set to 0

Capability bits

DWORD

Interface capabilities, other than speed/duplex

Bitmap

Speed/Duplex options

STRUCT of:

Indicates speed/duplex pairs supported in the interface control attribute

-

USINT

Speed/Duplex array count

Number of elements

ARRAY of

STRUCT of:

Speed/Duplex array

-

UINT

Interface speed

Speed in Mbps

USINT

Interface duplex mode

0 = Half duplex

1 = Full duplex

2-255 = Reserved

01 hex

Get_Attribute_All

Return all attributes

0E hex

Get_Attribute_Single

Return single attribute

F4 hex

299

1

Get

Revision

UINT

Revision of this object

The current value assigned to this attribute is one (01). If updates that require an increase in this value are made, then the value of this attribute increases by 1

2

Get

Max instance

UINT

Maximum instance number of an object currently created in this class level of the device

The largest instance number of a created object at this class hierarchy level

3

Get

Number of instances

UINT

Number of object instances currently created at this class level of the device

The number of object instances at this class hierarchy level

8

Get

Entry port

UINT

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

1

9

Get

Port instance info

ARRAY of

STRUCT of

Array of structures containing instance attributes 1 and 2 from each instance

The array is indexed by instance number starting with zero, up to the maximum instance number. The values for instance zero and any non-instantiated instances shall be zero

Port type

UINT

Enumerates the type of port

The vendor assigns values to these three attributes to indicate the type of the port, whether or not it supports routing, and whether it provides a link specific object to make link specific functionality visible to CIP

Port number

UINT

CIP port number associated with this port

Manufacturer assigns a unique value to identify each communication port. Value 0 is reserved and cannot be used

1

Get

Port type

UINT

Enumerates the type of port

The vendor assigns value to this attribute to indicate the type of port

2

Get

Port number

UINT

CIP port number associated with this port

Manufacturer assigns a unique value to identify each communication port. Value 0 is reserved and cannot be used

3

Get

Link object

STRUCT of:

The vendor assigns value to this attribute to indicate whether it supports routing, and whether it provides link specific object to make link specific functionality visible to CIP

Path length

UINT

Number of 16 bit words in the path

Link path

Padded EPATH

Logical path segments that identify the object for this port

4

Get

Port name

SHORT_STRING

String which names the communications interface. The maximum number of characters in the string is 64

This attribute is the vendor assigned name of the communications interface associated with this instance

7

Get

Port number and node address

Padded EPATH

Port segment containing the port number and the link address of the device on this port

The port number and node address value shall be a port segment containing the port number of this port and the link address of this device on the port

10

Get

Port routing capabilities

DWORD

Bit string that defines the routing capabilities of this port

Bit 0: Routing of incoming unconnected messaging supported

Bit 1: Routing of outgoing unconnected messaging supported

Bit 2: Routing of incoming transport class 0/1 connections supported

Bit 3: Routing of outgoing transport class 0/1 connections supported

Bit 4: Routing of incoming transport class 2/3 connections supported

Bit 5: Routing of outgoing transport class 2/3 connections supported

Bit 6: Routing of outgoing DeviceNet CIP safety connections supported

Bit 7-31: Reserved

0x0E

Get_Attribute_Single

Used to read a port class attribute value. This service is required if any of the port class attributes are supported

4E hex

78

1

Get

Revision

UINT

Revision of this object

The current value assigned to this attribute is two (2)

1

Get

Energy/resource type

UINT

Specifies the type of energy managed by this energy instance

0: Generic

1: Electrical

2: Non-electrical

3-99: Reserved

100-199: Vendor specific

200-65535: Reserved

2

Get

Base energy object capabilities

UINT

The energy capabilities of the instance

0: Energy measured

1: Energy derived

2: Energy proxy

3: Energy aggregated

4: Energy rate fixed

5: Non-electrical aggregated

6-65535: Reserved

3

Get

Energy accuracy

UINT

Specifies the accuracy of power and energy metering results

Typical accuracy in 0.01 percent of reading (default) or 0.01 of other units as specified in the energy accuracy basis attribute

0: Unknown

7

Get

Consumed energy odometer

ODOMETER

The consumed energy value

Energy in kWh

8

Get

Generated energy odometer

ODOMETER

The generated energy value

Energy in kWh

9

Get

Net energy odometer

SIGNED_ODOMETER

The total net energy value

Energy in kWh

10

Get

Energy transfer rate

REAL

The time rate of energy consumption or production

Power in kW

12

Get

Energy type specific object path

STRUCT of:

Path to energy type specific object instance

This attribute may contain a path to an electrical energy object instance (class code 0x4F), a path to a non-electrical energy object instance (class code 0x50) or a null path (a path size value of zero (0))

Path size

UINT

Size of Path (in words)

-

Path

Padded EPATH

-

-

0E hex

Get_Attribute_Single

Used to read a base energy class attribute value

ODOMETER STRUCT of:

SIGNED_ODOMETER STRUCT of:

–

–

UINT

INT

x10ⁿ

±Unit x 10ⁿ

UINT

INT

x10ⁿ⁺³

±Unit x 10ⁿ⁺³

UINT

INT

x10ⁿ⁺⁶

±Unit x 10ⁿ⁺⁶

UINT

INT

x10ⁿ⁺⁹

±Unit x 10ⁿ⁺⁹

UINT

INT

x10ⁿ⁺¹²

±Unit x 10ⁿ⁺¹²

The valid range of n shall be a SINT between 0 and -15.

x10ⁿ⁺¹²

x10ⁿ⁺⁹

x10ⁿ⁺⁶

x10ⁿ⁺³

x10ⁿ

Terawatt-hours
(kWh x 10⁹)

Gigawatt-hours
(kWh x 10⁶)

Megawatt-hours
(kWh x 10³)

Kilowatt-hours (kWh)

Watt-hours
(kWh x 10^-3)

4F hex

79

1

Get

Revision

UINT

Revision of this object

The current value assigned to this attribute is two (2)

1

Get

Real energy consumed odometer

ODOMETER

The total real energy consumed

0 kWh to 999,999,999,999.999 kWh

2

Get

Real energy generated odometer

ODOMETER

The total real energy generated

0 kWh to 999,999,999,999.999 kWh

3

Get

Real energy net odometer

SIGNED_ODOMETER

The running total of real energy consumed minus real energy generated

-999,999,999,999.999 kWh to 999,999,999,999.999 kWh

4

Get

Reactive energy consumed odometer

ODOMETER

The total reactive power consumed

0 kVARh to 999,999,999,999.999 kVARh

5

Get

Reactive energy generated odometer

ODOMETER

The total reactive power generated

0 kVARh to 999,999,999,999.999 kVARh

6

Get

Reactive energy net odometer

SIGNED_ODOMETER

The running total of reactive energy consumed minus reactive energy generated

-999,999,999,999.999 kVARh to 999,999,999,999.999 kVARh

7

Get

Apparent energy odometer

ODOMETER

The total apparent energy consumed

Range from 0 kVAh to 999,999,999,999.999 kVAh

9

Get

Line frequency

REAL

Line Frequency in Hertz

Hz

10

Get

L1 current

REAL

RMS line current in L1

Amps (A)

11

Get

L2 current

REAL

RMS line current in L2

Amps (A)

12

Get

L3 current

REAL

RMS line current in L3

Amps (A)

13

Get

Average current

REAL

RMS line current of three-phase average

Amps (A)

14

Get

Percent current unbalance

REAL

Percentage current deviation between phases

Percent

15

Get

L1-N voltage

REAL

RMS line to neutral voltage of L1

Volts (V)

16

Get

L2-N voltage

REAL

RMS line to neutral voltage of L2

Volts (V)

17

Get

L3-N voltage

REAL

RMS line to neutral voltage of L3

Volts (V)

18

Get

Average L-N voltage

REAL

RMS line to neutral voltage of three-phase average

Volts (V)

19

Get

L1-L2 voltage

REAL

RMS L1 to L2 voltage

Volts (V)

20

Get

L2-L3 voltage

REAL

RMS L2 to L3 voltage

Volts (V)

21

Get

L3-L1 voltage

REAL

RMS L3 to L1 voltage

Volts (V)

22

Get

Average L-L voltage

REAL

RMS line to line voltage three-phase average

Volts (V)

23

Get

Percent voltage unbalance

REAL

Percentage voltage deviation between phases

Percent

24

Get

L1 real power

REAL

L1 real power, signed to show direction

Watts (W)

25

Get

L2 real power

REAL

L2 real power, signed to show direction

Watts (W)

26

Get

L3 real power

REAL

L3 real power, signed to show direction

Watts (W)

27

Get

Total real power

REAL

Total real power, signed to show direction

Watts (W)

28

Get

L1 reactive power

REAL

L1 reactive power, signed to show direction

Volt-amps reactive (VAR)

29

Get

L2 reactive power

REAL

L2 reactive power, signed to show direction

Volt-amps reactive (VAR)

30

Get

L3 reactive power

REAL

L3 reactive power, signed to show direction

Volt-amps reactive (VAR)

31

Get

Total reactive power

REAL

Total reactive power, signed to show direction

Volt-amps reactive (VAR)

32

Get

L1 apparent power

REAL

L1 apparent power

Volt-amps (VA)

33

Get

L2 apparent power

REAL

L2 apparent power

Volt-amps (VA)

34

Get

L3 apparent power

REAL

L3 apparent power

Volt-amps (VA)

35

Get

Total apparent power

REAL

Total apparent power

Volt-amps (VA)

36

Get

L1 true power factor

REAL

L1 ratio between power and apparent power

Percent

37

Get

L2 true power factor

REAL

L2 ratio between power and apparent power

Percent

38

Get

L3 true power factor

REAL

L3 ratio between power and apparent power

Percent

39

Get

Three phase true power factor

REAL

Ratio between power and apparent power

Percent

40

Get

Phase rotation

UINT

The phase rotation of a three-phase system

0 = None

1 = ABC

2 = ACB

41

Get

Associated base energy object path

STRUCT of:

Path to associated base energy object instance

03 00 21 00 4E 00 24 01

Path size

UINT

Size of path (in words)

Path

Padded EPATH

-

0E hex

Get_Attribute_Single

Used to read a electrical energy class attribute value