CIP Objects. Schneider Electric Premium using EcoStruxure™ Control Expert - TSXETC100 EtherNet/IP Communication Module

PDF

Belge

Reklam

Premium using EcoStruxure™ Control Expert

CIP objects

31008211 09/2020

CIP Objects Chapter 6

CIP Objects

Overview

The EtherNet/IP communication module stores data and offers services in a CIP object hierarchy, consisting of the following nested levels:

When the module’s local slave service is activated, remote devices can send explicit messages to the module’s object hierarchy and perform services that:



 access module data, or execute module commands

The local slave function is activated by selecting Active Configuration in the General Configuration page of the Local Slave window

(

see page 62

)

This chapter describes the CIP objects the EtherNet/IP communication module can expose to remote devices.

What Is in This Chapter?

This chapter contains the following topics:

Topic

Adapter Diagnostic Object

Assembly Object

Connection Manager Object

Ethernet Link Object

Identity Object

Module Diagnostic Object

Scanner Diagnostic Object

TCP/IP Interface Object

Page

31008211 09/2020

169

CIP objects

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

Revision

02 Max Instance

X = supported

— = not supported

GET

2. Instance attributes:

ID (hex) Description

01 Control Bits

Type

WORD

GET SET

X X

SET

—

Value

0: Deactivate checking time for production and consumption (default)

1: Activate

02 ST_DIAG_CNT wErrFrameCnt

STRUCT X

UINT

X wErrTimeOutCnt wErrRefusedCnt dwErrProdCnt dwErrConsCnt dwErrProdByteCnt dwErrConsByteCnt

Input Status

Output Status

X = supported

— = not supported

UINT

UDINT

WORD

—

Incremented each time a frame isn’t sent by missing resources or is impossible to send.

Incremented when a connection is timed out.

Incremented when a connection is refused by the remote station.

Incremented at each production.

Incremented at each consumption.

Total bytes produced.

Total bytes consumed.

See Status descriptions, below.

170

31008211 09/2020

ID (hex) Description

05 ST_LINK

CIP Status

Extended Status

Production

Connection ID

Consumed

Connection ID

OtoT API

TtoO API

OtoT RPI

TtoO RPI

ST_SOCK_PARAM

IpSockId

IpForeign wPortForeign

IpLocal wPortLocal

X = supported

— = not supported

CIP objects

Type

STRUCT X

UINT

GET SET

—

UINT

DWORD

UDINT

STRUCT X

DWORD

UINT

DWORD

UINT

—

Value

See Status descriptions, below.

Connection ID

API of the Connection

RPI of the Connection

Internal identifier

IP of the remote station

Port number of the remote station

IP of the local station

Port number of the local station

31008211 09/2020

171

CIP objects

ID (hex) Description

07 ST_PRODUCTION bValid dwCurrentTime dwProductionTime

SequenceNumber stCheckTime dwLastTime dwMaxTime dwMinTime dwRPI wOverRun wUnderRun dwCurrentTime

X = supported

— = not supported

UDINT

STRUCT

UDINT

UINT

UDINT

Type

STRUCT X

WORD

GET SET

—

Value

0: data of the struct production is not valid

1: data of the struct production is valid

(Internal Use—number of ticks before next production)

(Internal Use—number of ticks between production)

Number of the dwquence in the production

(Internal Use)

Maximum time between 2 productions

Minimum time between 2 productions

API of the connection

Number of times the production was too long

Number of times the production was too short

(Internal Use)

172

31008211 09/2020

CIP objects

ID (hex) Description

ST_CONSUMPTION bValid dwCurrentTime UDINT dwConsumptionTime UDINT

SequenceNumber stCheckTime dwLastTime dwMaxTime dwMinTime dwRPI wOverRun

UDINT

STRUCT

UDINT

UDINT wUnderRun dwCurrentTime

Connection Entry List byGeneralStatus byReserved

Extended Status

X = supported

— = not supported

Type

STRUCT X

WORD

GET SET

—

Value

0: data of the struct consumption is not valid

1: data of the struct consumption is valid

(Internal Use—number of ticks before the timeout)

(Internal Use—number of ticks in the timeout)

Number of the sequence in the consumption

UDINT

UINT

UDINT

STRUCT X

BYTE

WORD

—

(Internal Use)

Maximum time between 2 consumptions

Minimum time between 2 consumptions

API of the connection

Number of times the consumption was too long

Number of times the consumption was too short

(Internal Use)

Status of the CCO object. See Status descriptions, below.

31008211 09/2020

173

CIP objects

Adapter Status

Adapter status values include the followng:

Status Description Extended Explanation

No connection

IDLE

Connection in progress

0xFB

0xFD

0xFE

0x02

0x20

CIP

Status

0xFB

0xFB01

0xFB07

0xFB0B

0xFB0C

0xFB0E

The I/O data are correctly exchanged.

No connection.

Connection in timeout.

Optimization error / unknown MAC Address.

Timeout on consumption.

Connection closed by a Fw_Close.

Module in STOP.

Error from encapsulation layer.

Error on TCP connection.

No more resources to handle the connection.

Connections refused by bad format or parameters.

An IDLE notification is received.

The connection is established, but I/O data is not yet consumed.

174

31008211 09/2020

CIP objects

Services

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

ID (hex)

Description Class Instance Notes

Get_Attributes_All X X

Get_Output — X Returns the status and values of the output:

Offset Type Description

Get_Intput — X

UINT Status

USINT[0...409] Output Data

Returns the status and values of the input:

Offset Type Description

Set_DiagCounters — X

UINT Status

USINT[0...409] Input Data

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

31008211 09/2020

175

CIP objects

Assembly Object

Overview

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

Attributes

The Assembly CIP object consists of the following attributes:

1. Class attributes:

ID (hex)

Description

Revision

02 Max Instance

X = supported

— = not supported

2. Instance attributes:

ID (hex)

Description

Data

X = supported

— = not supported

Type

Array of

BYTE

GET

SET

—

GET

SET

Services

The CIP Assembly object performs the following services upon the listed object types:

ID (hex)

Description

Get_Attributes_All

Get_Attributes_Single

Set_Attributes_Single

Class Instance

X X

—

Notes

—

Returns these values:

0E=attribute not settable: assembly is not o->T type

0F=permission denied: assembly is being used by an active connection

13=config too small: the

Set_Attributes_Single command contains partial data

15=too big data: the Set_Attributes_Single command contains too much data

X = supported

— = not supported

176

31008211 09/2020

CIP objects

Connection Manager Object

Overview

The Connection Manager CIP object consists of the attributes and services described below.

Attributes

The Connection Manager CIP object consists of the following attributes:

1. Class attributes:

ID (hex)

Description

Revision

02 Max Instance

X = supported

— = not supported

GET

2. Instance attributes:

ID (hex) Description

01 Open Requests

02 Open Format Rejects

Open Other Rejects

Close Requests UINT

Close Format Requests UINT

Close Other Requests

Type

UINT

Open Resource Rejects UINT

UINT

SET

—

GET SET Value

X X Number of Forward Open service requests received

X X

Number of Forward Open service requests that were rejected due to bad format

Number of Forward Open service requests that were rejected due to lack of resources

Number of Forward Open service requests that were rejected for reasons other than bad format or lack of resources

X X

Number of Forward Close service requests received

Number of Forward Close service requests that were rejected due to bad format

Number of Forward Close service requests that were rejected for reasons other than bad format

X = supported

— = not supported

31008211 09/2020

177

CIP objects

ID (hex) Description

08 Connection Timeouts

Connection Entry List

CPU_Utilization

MaxBuffSize

BufSize Remaining

X = supported

— = not supported

Type

UINT

STRUCT X

UINT X

GET SET Value

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

—

List of connections—always 0

CPU Utilization in tenths of a percent— always 0

UDINT

—

Amount of buffer space originally available—always 0

Amount of buffer space now available— always 0

Services

The CIP Connection Manager object performs the following services upon the listed object types:

ID (hex)

Description

Get_Attributes_All

Get_Attributes_Single

Forward Close

Unconnected Send

Forward Open

X = supported

— = not supported

Class Instance

X X

—

Notes

—

Managed internally by the

EtherNet/IP stack—no link to

CPU exists

178

31008211 09/2020

CIP objects

Ethernet Link Object

Overview

The Ethernet Link CIP object consists of the attributes and services described below.

Attributes

The Ethernet Link CIP object consists of the following attributes:

1. Class attributes:

ID (hex)

Description

Revision

02 Max Instance

X = supported

— = not supported

2. Instance attributes:

ID (hex) Description

01 Interface Speed

02 Interface Flags

Type

UDINT

DWORD

—

GET

SET

—

Value

Valid values include:

0, 10000000, 100000000

Bit 0: Link Status

0 = Inactive

1 = Active

Bit 1: Duplex Mode

0 = half duplex

1 = full duplex

Bits 2-4: Negotiation Status

3 = successfully negotiated speed and duplex

4 = forced speed and link

Bit 5: Manual Setting Requires Reset

0 = automatic

1 = device need reset

Bit 6: Local Hardware Fault

0 = no fault

1 = fault detected

Module MAC Address 03 Physical Address ARRAY of

6 USINT

X = supported

— = not supported

GET SET

X —

31008211 09/2020

179

CIP objects

ID (hex) Description

04 Interface Counters STRUCT

In octets

Type

UDINT

GET

SET

—

UDINT In Ucast

Packets

In NUcast

Packets

In Discards

UDINT

In Errors UDINT

UDINT In Unknown

Protos

Out Octets

Out Ucast

Packets

Out NUcast

Packets

Out Discards

Out Errors

X = supported

— = not supported

UDINT

Value

Octets received on the interface

Unicast packets received on the interface

Non-unicast packets received on the interface

Inbound packets received on the interface, but discarded

Inbound packets that contain errors

(does not include In Discards)

Inbound packets with unknown protocol

Octets sent on the interface

Unicast packets sent on the interface

Non-unicast packets sent on the interface

Outbound packets discarded

Outbound packets that contain errors

180

31008211 09/2020

CIP objects

ID (hex) Description

05 Media Counters

Alignment

Errors

FCS Errors

Single

Collisions

Multiple

Collisions

SQE Test

Errors

Deferred

Transmissions

Type

STRUCT X

UDINT

Late Collisions UDINT

GET SET

—

Excessive

Collisions

MAC Transmit

Errors

Carrier Sense

Errors

Frame Too

Long

MAC Receive

Errors

X = supported

— = not supported

UDINT

Value

Frames that are not an integral number of octets in length

Frames received that do not pass the

FCS check

Successfully transmitted frames that experienced exactly one collision

Successfully transmitted frames that experienced more than one collision

Number of times the SQE test error is generated

Frames for which first transmission attempt is delayed because the medium is busy

Number of times a collision is detected later than 512 bittimes into the transmission of a packet

Frames for which transmission fails due to excessive collisions

Frames for which transmission fails due to internal MAC sublayer transmit error

Times that the carrier sense condition was lost or never asserted when attempting to transmit a frame

Frames received that exceed the maximum permitted frame size

Frames for which reception on an interface fails due to an internal MAC sublayer receive error

31008211 09/2020

181

CIP objects

ID (hex) Description

06 Interface Control

Control Bits

Type

STRUCT

WORD

GET

SET

Forced

Interface Speed

UINT

Value

API of the connection

Bit 0: Auto-negotiation

0 = Disabled

1 = Enabled

Note: When auto-negotiation is enabled, the error 0x0C (Object State

Conflict) is returned when attempting to set either:



Forced Interface Speed, or



Forced Duplex Mode

Bit 1: Forced Duplex Mode (if autonegotiation bit = 0)

0 = half duplex

1 = full duplex

Valid values include:

10000000, 100000000

Note: Attempting to set any other value returns the error 0x09

(Invalid Attribute Value)

X = supported

— = not supported

Services

The CIP Ethernet Link object performs the following services upon the listed object types:

ID (hex)

X = supported

— = not supported

Description

Get_Attributes_All

Set_Attribute_Single

Get_Attribute_Single

Class

—

Instance

182

31008211 09/2020

Identity Object

Overview

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

Attributes

The Identity CIP object consists of the following attributes:

1. Class attributes:

ID (hex)

Description

Revision

02 Max Instance

X = supported

— = not supported

GET

2. Instance attributes:

ID (hex)

Description

Vendor ID

Device Type

Product Code

Revision

Major

Minor

05 Status bit 2:

0x01=the module is configured bits 4-7:

0x03=no I/O connections established

0x06=at least 1 I/O connection in run mode

0x07=at least 1 I/O connection established, all in IDLE mode

Serial Number

Product Name

X = supported

— = not supported

Type

UINT

UINT X

STRUCT X

USINT

Word

GET

UDINT

STRING

SET

—

SET

—

CIP objects

31008211 09/2020

183

CIP objects

Services

The CIP Identity object performs the following services upon the listed object types:

ID (hex)

Description

Get_Attributes_All

Get_Attributes_Single

Reset

Class Instance

X X

—

Notes

Applies to all class and all instance attributes

Two types:

00=power cycle

01=return to factory defaults and power cycle

X = supported

— = not supported

184

31008211 09/2020

CIP objects

Module Diagnostic Object

Overview

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

Attributes

The Module Diagnostic CIP object consists of the following attributes:

1. Class attributes:

ID (hex)

Description

Revision

02 Max Instance

X = supported

— = not supported

GET

2. Instance attributes:

ID (hex) Description

01 Module Status

CNF Version

CRC

I/O Connection Status

Size Table

Table

Cco Mode

SET

—

Type

WORD

UDINT X

STRUCT X

WORD

WORD[]

WORD

GET SET Value

X — 01=started

02=stopped

03=running

X — 0x0100

—

— size (16 bytes) table of I/O status (8 WORDS)

1=INPUT and OUTPUT status of I/O connection are OK

0=at least 1 INPUT or OUTPUT status of I/O connection is not OK

01=activate status to CCO in the module

02=block access to CCO

X = supported

— = not supported

31008211 09/2020

185

CIP objects

Services

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

ID (hex)

Description

Get_Attributes_All

0E Set_Attributes_Single

X = supported

— = not supported

Class Instance

X X

— X

Notes

—

186

31008211 09/2020

CIP objects

Scanner Diagnostic Object

Overview

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

Attributes

The Scanner Diagnostic CIP object consists of the following attributes:

1. Class attributes:

ID (hex)

Description

Revision

02 Max Instance

X = supported

— = not supported

GET

2. Instance attributes:

ID (hex) Description

01 Control Bits

Type

WORD

GET SET

X X

SET

—

Value

0: Deactivate checking time for production and consumption (default)

1: Activate

02 ST_DIAG_CNT wErrFrameCnt

STRUCT X

UINT

X wErrTimeOutCnt wErrRefusedCnt dwErrProdCnt dwErrConsCnt dwErrProdByteCnt dwErrConsByteCnt

Input Status

Output Status

X = supported

— = not supported

UINT

UDINT

WORD

—

Incremented each time a frame isn’t sent by missing resources or is impossible to send.

Incremented when a connection is timed out.

Incremented when a connection is refused by the remote station.

Incremented at each production.

Incremented at each consumption.

Total bytes produced.

Total bytes consumed.

See Status descriptions, below.

31008211 09/2020

187

CIP objects

ID (hex) Description

05 ST_LINK

CIP Status

Extended Status

Production

Connection ID

Consumed

Connection ID

OtoT API

TtoO API

OtoT RPI

TtoO RPI

ST_SOCK_PARAM

IpSockId

IpForeign wPortForeign

IpLocal wPortLocal

X = supported

— = not supported

Type

STRUCT X

UINT

GET SET

—

UINT

DWORD

UDINT

STRUCT X

DWORD

UINT

DWORD

UINT

—

Value

See Status descriptions, below.

Connection ID

API of the Connection

RPI of the Connection

Internal identifier

IP of the remote station

Port number of the remote station

IP of the local station

Port number of the local station

188

31008211 09/2020

CIP objects

ID (hex)

Description

ST_PRODUCTION bValid dwCurrentTime dwProductionTime

SequenceNumber stCheckTime dwLastTime dwMaxTime dwMinTime dwRPI wOverRun wUnderRun dwCurrentTime

X = supported

— = not supported

UDINT

STRUCT

UDINT

UINT

UDINT

Type

STRUCT X

WORD

GET SET

—

Value

0: data of the struct production is not valid

1: data of the struct production is valid

(Internal Use—number of ticks before next production)

(Internal Use—number of ticks between production)

Number of the dwquence in the production

(Internal Use)

Maximum time between 2 productions

Minimum time between 2 productions

API of the connection

Number of times the production was too long

Number of times the production was too short

(Internal Use)

31008211 09/2020

189

CIP objects

ID (hex)

Description

ST_CONSUMPTION bValid dwCurrentTime UDINT dwConsumptionTime UDINT

SequenceNumber stCheckTime dwLastTime dwMaxTime dwMinTime dwRPI wOverRun

UDINT

STRUCT

UDINT

UDINT wUnderRun dwCurrentTime

Connection Entry List byGeneralStatus byReserved

Extended Status

X = supported

— = not supported

Type

STRUCT X

WORD

GET SET

—

Value

0: data of the struct consumption is not valid

1: data of the struct consumption is valid

(Internal Use—number of ticks before timeout)

(Internal Use—number of ticks of the timeout)

Number of the sequence in the consumption

UDINT

UINT

UDINT

STRUCT X

BYTE

WORD

—

(Internal Use)

Maximum time between 2 consumptions

Minimum time between 2 consumptions

API of the connection

Number of times the consumption was too long

Number of times the consumption was too short

(Internal Use)

Status of the CCO object. See Status descriptions, below.

190

31008211 09/2020

CIP objects

Scanner Status

Scanner status values include the followng:

Extended Explanation

Status

Description

Timeout

IDLE

Connection established

0xFB

Not connected (TCP) 0xFE

Not connected (CIP) 0xFB

0xFB

CIP

Status

0xFB

0xFB0B

0xFB08

0xFB09

0xFB0A

0xFB01

0xFB02

0xFB03

0xFB

Connection establishing

0xFB

0xD0

Not connected (EPIC) 0xFD

0xFD

Scanner stopped

0xFD

0xFB04

0xFB05

0xFB06

0xFB07

0x0001

0x0002

The I/O data are correctly exchanged.

Timeout detected on consumption.

An IDLE notification is received.

The connection is established, but I/O is not yet consumed.

Impossible to start the production.

Impossible to start the consumption.

Not enough resources to manage the connection.

Error on TCP connection.

Timeout for Fw_Open response.

Bad format of the Fw_Open response (so addr).

Bad parameters in the Fw_Open response (OT

Net Par).

Bad parameters in the Fw_Open response (TO

Net Par).

Fw_Open respons asks for port number other than

2222.

Error joining the UDP multicast group.

Optimization error / unknown MAC Address.

Connection is closed.

Connection is pending.

Error code in register session response.

Error code in the frame.

Encapsulation session un-registered.

Connection is stopped.

31008211 09/2020

191

CIP objects

Services

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

Notes ID (hex) Description

01 Get_Attributes_All

Class

Instance

61 Get_Output — X

62 Get_Input —

63 Set_DiagCounters —

X = supported

— = not supported

Returns the status and values of the output:

Offset Type Description

UINT

USINT[0...409]

Status

Output Data

Returns the status and values of the input:

Offset Type Description

UINT

USINT[0...409]

Status

Input Data

Sets the value of the structure ST_DIAG_CNT to 0.

192

31008211 09/2020

TCP/IP Interface Object

Overview

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

Attributes

The TCP/IP Interface CIP object consists of the following attributes:

1. Class attributes:

ID (hex)

Description

Revision

02 Max Instance

X = supported

— = not supported

GET

2. Instance attributes:

ID (hex) Description

Status

Configuration Capability

Configuration Control

Physical Link Object

Path Size

Path

Interface Configuration 05

IP Address

Network Mask

Gateway Address

Name Server

Name Server 2

Domain Name

06 Host Name

X = supported

— = not supported

Type GET SET Value

DWORD X

—

— always = 0x01

0x01 = from BootP

0x11 = from flash

0x00 = other

DWORD X X 0x01 = out-of-box default

STRUCT X

UINT

Padded

EPATH

STRUCT X

—

X 0x00 = out-of-box default

UDINT

STRING

STRING X —

SET

—

31008211 09/2020

CIP objects

193

CIP objects

Services

The CIP TCP/IP Interface object performs the following services upon the listed object types:

ID (hex)

Description

Get_Attributes_All

Get_Attributes_Single

X = supported

— = not supported

Class Instance

X X

—

Notes

—

194

31008211 09/2020

Reklam

CIP Objects

see page 62

Adapter Diagnostic Object

Assembly Object

Connection Manager Object

Ethernet Link Object

Identity Object

Module Diagnostic Object

Scanner Diagnostic Object

TCP/IP Interface Object

İlgili

TSX ETC 101 Ethernet Module User Manual | AI Chat

TSX ETC 100 EtherNet/IP Communication Module User Manual

Premium TSX ETC 101以太网模块手册：AI助手及PDF下载

Schneider Ethernet Module User Manual + AI Chat

Schneider Electric Communication Services and Architectures Reference manual

TSX ESY 007 Installation Manual | AI Chat & PDF

Modicon controllers Reference Manual

EcoStruxure Control Expert OS Loader User Manual | AI Chat & PDF Download

Schneider Premium Hot Standby User Manual: AI Chat & PDF

Schneider Electric Premium and Atrium Using EcoStruxure™ Control Expert - Fipio Bus User Guide

Schneider Electric Ethernet Network Modules User Manual

Schneider Electric Premium and Atrium using EcoStruxure™ Control Expert - Fipway Network User Manual