CipObject

CIP Objects for the NJ/NX Built-in EtherNet/IP Port

This page gives an overview of the CIP objects
For details such as the meaning of each parameter value, see the manual (NJ/NX-series CPU Unit Built-in EtherNet/IP Port User's Manual)

Object types
Object name	Class ID	Description
Identity	0x01	Reading CPU unit information, etc.
NX Configuration	0x74	Reading/writing NX object information, etc.
TCP/IP Interface	0xF5	Reading/writing TCP/IP information, etc.
Ethernet Link	0xF6	Reading/writing Ethernet information, etc.
PLC	0xC4	Getting the controller status, etc.

Identity Object (ClassID 0x01)

The Identity object (Class ID 0x01) is a standard CIP object that manages the identification information of an EtherNet/IP device.
It provides information such as the vendor ID, device type, product code, firmware version, serial number and product name.
It is used to identify connected devices on an EtherNet/IP network and to confirm that the communication partner is the expected device.
Some devices also provide a reset function.

Service code
Service Code	Name	Description
0x01	Get_Attribute_All	Reads all parameter values by specifying the instance
0x0E	Get_Attribute_Single	Reads parameter values by specifying the instance and attribute
0x05	Reset	Resets

Command list
Service Code	Class ID	Instance ID	Attribute ID	Type		Parameter
0x01	0x01	0x00	-			Class
0x01	0x01	0x01	-			Instance
0x0E	0x01	0x00	0x01	UINT		Revision
		0x00	0x02	UINT		MaxInstance
		0x01	0x01	UINT		VenderID
			0x02	UINT		DeviceType
			0x03	UINT		ProductCode
			0x04	Struct		Revision
					USINT	MejorRevision
					USINT	MinorRevision
			0x05	WORD		Status
			0x06	UDINT		SerialNumber
			0x07	STRING		ProductName
0x05	0x01	0x01	-			Reset

NX Configuration Object (ClassID 0x74)

The NX Configuration object (Class ID 0x74) is an OMRON-specific CIP object that manages the settings of OMRON NX series units.
It can read/write parameters inside NX units, restart units, get error information, and read and clear event logs.
It is used to monitor the status of NX units and perform maintenance remotely via EtherNet/IP communication.

Of the following Format types, "ANSI Extended Symbol Segment" is used

Service code
Service Code	Name	Description
0x33	Read NX object	Read NX object
0x34	Write NX Object	Write NX object
0x35	Restart NX unit	Restart NX unit
0x36	Save parameter	Save parameters
0x37	Switch parameter write mode	Switch write mode
0x38	Read total power on time	Read total power-on time
0x3A	Get current error	Read current errors
0x3B	Get event log	Read event log
0x3C	Clear event log	Clear event log
0x3D	Initialize unit operation parameter	Initialize NX objects
0x3E	Get current user error	Get user-defined errors

Command list
Service Code	Class ID	Instance ID	Attribute ID	RequestData
0x33	0x74	0x01	-	UnitNo, Index, SubIndex, ControlField
0x34	0x74	0x01	-	UnitNo, Index, SubIndex, ControlField, Length, WriteData
0x35	0x74	0x01	-	UnitNo
0x36	0x74	0x01	-	UnitNo
0x37	0x74	0x01	-	UnitNo
0x38	0x74	0x01	-	UnitNo
0x3A	0x74	0x01	-	UnitNo, StartNumberOfReadRecord
0x3B	0x74	0x01	-	UnitNo, EventLogType, StartIndexOfReadRecord, NumberOfReadREcord
0x3C	0x74	0x01	-	UnitNo, EventLogType
0x3D	0x74	0x01	-	UnitNo
0x3E	0x74	0x01	-	UnitNo, StartNumberOFReadRecord

TCP/IP Interface Object (ClassID 0xF5)

The TCP/IP Interface object (Class ID 0xF5) is a standard CIP object that manages the TCP/IP network settings of an EtherNet/IP device. It can get or set network information such as the IP address, subnet mask, default gateway, DNS server and host name. It is used to check the basic network settings for EtherNet/IP communication and to change settings remotely.

Service code
Service Code	Name	Description
0x01	Get_Attribute_All	Reads all parameter values by specifying the instance
0x0E	Get_Attribute_Single	Reads parameter values by specifying the instance and attribute
0x10	Set_Attribute_Single	Writes parameter values by specifying the instance and attribute

Command list
Service Code	Class ID	Instance ID	Attribute ID	Type		Parameter
0x01	0xF5	0x00	-			Class
0x0E	0xF5	0x00	0x01	UINT		Revision
			0x02	UINT		MaxInstance
			0x03	UINT		Number of Instances
		0x01	0x01	DWORD		Interface Configuration Status
			0x02	DWORD		ConfigurationCapability
			0x03	DWORD		ConfigurationControl
			0x04	Struct		PhysicalLinkObject
					UINT	Path Size
					EPATH	Path
			0x05	Struct		Interface Configuration Status
					UDINT	IP Address
					UDINT	Network Mask
					UDINT	Gateway Address
					UDINT	Name Server
					UDINT	Name Server2
					UDINT	Domain Name
			0x06	STRING		Host Name
0x10	0xF5	0x01	0x01-0x06 same as above

Ethernet Link Object (ClassID 0xF6)

The Ethernet Link object (Class ID 0xF6) is a standard CIP object that manages the physical link status and communication statistics of an Ethernet port. It provides information such as the link speed, MAC address, number of packets sent and received, number of errors and number of collisions. It is an important object for investigating network trouble, monitoring communication quality and checking the status of Ethernet interfaces.

Service code
Service Code	Name	Description
0x0E	Get_Attribute_Single	Reads parameter values by specifying the attribute
0x10	Set_Attribute_Single	Writes parameter values by specifying the attribute
0x4C	Get_and_Clear	Clears parameter values to zero by specifying attribute 4 or 5

Command list
Service Code	Class ID	Instance ID	Attribute ID	Type		Parameter
0x0E	0xF6	0x00	0x01	UINT		Revision
			0x02	UINT		MaxInstance
			0x03	UINT		Number of Instances
		0x01	0x01	UDINT		Interface Speed
			0x02	DWORD		Interface Flags
			0x03	USINT[6]		Physical Address
			0x04	Struct		Interface Counters
					UDINT	In Octets
					UDINT	In Unicast Packets
					UDINT	In NonUnicast Packets
					UDINT	In Discards
					UDINT	In Errors
					UDINT	In Unknown Protos
					UDINT	Out Octets
					UDINT	Out Unicast Packetes
					UDINT	Out NonUnicast Packets
					UDINT	Out Discards
					UDINT	Out Errors
			0x05	Struct		Media Counters
					UDINT	Alignment Errors
					UDINT	FCS Errors
					UDINT	Single Colisions
					UDINT	Multiple Colisions
					UDINT	SQE Test Errors
					UDINT	Deferre Trasmissions
					UDINT	Late Collisions
					UDINT	Excessive Collisions
					UDINT	MAC Transmit Errors
					UDINT	Carrier Sense Errors
					UDINT	Frame Too Long
					UDINT	MAC Receive Errors
			0x06	Struct		Interface Control
					WORD	Control Bits
					UINT	Forced interface Speed
			0x0C	Struct		HC Interface Counters
					ULINT	HCInOctets
					ULINT	HCInUnicastPkts
					ULINT	HCInMulticastPkts
					ULINT	HCBroadcastPkts
					ULINT	HCOutOctets
					ULINT	HCOutUnicastPkts
					ULINT	HCOutMulticastPkts
					ULINT	HCOutBroadcastPkt
			0x0D	Struct		HC Media Counters
					ULINT	HCStatysAlignmentErrors
					ULINT	HCStatsFCSErrors
					ULINT	HCStatsInternalMacTransmitErrors
					ULINT	HCStatsFrameTooLongs
					ULINT	HCStatsInternalMacReceiveErrors
					ULINT	HCStatsMaSymbolErrors
0x10	0xF6	0x01	AttributeID 0x01-0x06, 0x0C, 0x0D: same parameters as above
0x4C	0xF6	0x01	AttributeID 0x04, 0x05, 0x0C, 0x0D: same parameters as above

PLC Object (ClassID 0xC4)

The PLC object (Class ID 0xC4) is an object that manages the operating status and operating mode of OMRON controllers. It can get and change the current PLC mode (PROGRAM, RUN, MONITOR, etc.), check error status and clear system alarms. It is an important object for remote monitoring and operation control via EtherNet/IP communication.

Service code
Service Code	Name	Description
0x0E	Get_Attribute_Single	Reads parameter values by specifying the instance and attribute
0x10	Set_Attribute_Single	Writes parameter values by specifying the instance and attribute
0x51	Reset_System_Alarm_All	Clears all errors of the CPU unit

Command list
Service Code	Class ID	Instance ID	Attribute ID	Type	Parameter
0x0E	0xC4	0x00	0x01	UINT	Revision
			0x02	UINT	MaxInstance
			0x64	UINT	PLC Mode
			0x65	UINT	PLC Error Status
			0x66	STRING	PLC Model
0x10	0xC4	0x00	0x64	UINT

PLC

CipMes

An application that sends CIP messages using Ethernet socket communication