Adapter Diagnostic Object

Overview

The Adapter Diagnostic CIP object consists of the attributes and services described below.

Attributes

The Adapter Diagnostic CIP object consists of the following attributes:

1. Class attributes:

ID (hex)	Description	GET	SET
01	Revision	X	—
02	Max Instance	X	—
X = supported — = not supported

2. Instance attributes:

ID (hex)	Description	Type	GET	SET	Value
01	Control Bits	WORD	X	X	0: Deactivate checking time for production and consumption (default) 1: Activate
02	ST_DIAG_CNT	STRUCT	X	X
	wErrFrameCnt	UINT			Incremented each time a frame isn’t sent by missing resources or is impossible to send.
	wErrTimeOutCnt	UINT			Incremented when a connection is timed out.
	wErrRefusedCnt	UINT			Incremented when a connection is refused by the remote station.
	dwErrProdCnt	UDINT			Incremented at each production.
	dwErrConsCnt	UDINT			Incremented at each consumption.
	dwErrProdByteCnt	UDINT			Total bytes produced.
	dwErrConsByteCnt	UDINT			Total bytes consumed.
03	Input Status	WORD	X	—	See Status descriptions, below.
04	Output Status	WORD	X	—	See Status descriptions, below.
05	ST_LINK	STRUCT	X	—
	CIP Status	UINT			See Status descriptions, below.
	Extended Status	UINT			See Status descriptions, below.
	Production Connection ID	DWORD			Connection ID
	Consumed Connection ID	DWORD			Connection ID
	OtoT API	UDINT			API of the Connection
	TtoO API	UDINT			API of the Connection
	OtoT RPI	UDINT			RPI of the Connection
	TtoO RPI	UDINT			RPI of the Connection
06	ST_SOCK_PARAM	STRUCT	X	—
	IpSockId	DWORD			Internal identifier
	IpForeign	DWORD			IP of the remote station
	wPortForeign	UINT			Port number of the remote station
	IpLocal	DWORD			IP of the local station
	wPortLocal	UINT			Port number of the local station
07	ST_PRODUCTION	STRUCT	X	—
	bValid	WORD			0: data of the struct production is not valid 1: data of the struct production is valid
	dwCurrentTime	UDINT			(Internal Use—number of ticks before next production)
	dwProductionTime	UDINT			(Internal Use—number of ticks between production)
	SequenceNumber	UDINT			Number of the dwquence in the production
	stCheckTime	STRUCT
	dwLastTime	UDINT			(Internal Use)
	dwMaxTime	UDINT			Maximum time between 2 productions
	dwMinTime	UDINT			Minimum time between 2 productions
	dwRPI	UDINT			API of the connection
	wOverRun	UINT			Number of times the production was too long
	wUnderRun	UINT			Number of times the production was too short
	dwCurrentTime	UDINT			(Internal Use)
08	ST_CONSUMPTION	STRUCT	X	—
	bValid	WORD			0: data of the struct consumption is not valid 1: data of the struct consumption is valid
	dwCurrentTime	UDINT			(Internal Use—number of ticks before the timeout)
	dwConsumptionTime	UDINT			(Internal Use—number of ticks in the timeout)
	SequenceNumber	UDINT			Number of the sequence in the consumption
	stCheckTime	STRUCT
	dwLastTime	UDINT			(Internal Use)
	dwMaxTime	UDINT			Maximum time between 2 consumptions
	dwMinTime	UDINT			Minimum time between 2 consumptions
	dwRPI	UDINT			API of the connection
	wOverRun	UINT			Number of times the consumption was too long
	wUnderRun	UINT			Number of times the consumption was too short
	dwCurrentTime	UDINT			(Internal Use)
09	Connection Entry List	STRUCT	X	—	Status of the CCO object. See Status descriptions, below.
	byGeneralStatus	BYTE
	byReserved	BYTE
	Extended Status	WORD
X = supported — = not supported

Adapter Status

Adapter status values include the followng:

Status	Description	CIP Status	Extended	Explanation
0	OK	0	0	The I/O data are correctly exchanged.
33	No connection	0	0	No connection.
		0xFB	0xFB01	Connection in timeout.
		0xFB	0xFB07	Optimization error / unknown MAC Address.
		0xFB	0xFB0B	Timeout on consumption.
		0xFB	0xFB0C	Connection closed by a Fw_Close.
		0xFB	0xFB0E	Module in STOP.
		0xFD		Error from encapsulation layer.
		0xFE		Error on TCP connection.
		0x02	0	No more resources to handle the connection.
		0x20	0	Connections refused by bad format or parameters.
53	IDLE	0	0	An IDLE notification is received.
54	Connection in progress	0	0	The connection is established, but I/O data is not yet consumed.

Services

The CIP Adapter Diagnostic object performs the following services upon the listed object types:

ID (hex)	Description	Class	Instance	Notes
01	Get_Attributes_All	X	X
61	Get_Output	—	X	Returns the status and values of the output:
				Offset	Type	Description
				0	UINT	Status
				2	USINT[0...409]	Output Data
62	Get_Intput	—	X	Returns the status and values of the input:
				Offset	Type	Description
				0	UINT	Status
				2	USINT[0...409]	Input Data
63	Set_DiagCounters	—	X	Sets the values of the structure: ST_DIAG_CNT to 0, and ST_CHECK_TIME (production and consumption) to 0 (but not fields dwLastTime and dwCurrentTime) the structure ST_DIAG_CNT to 0.
X = supported — = not supported