The EAP Object Dictionary (subprofile 1000)

1000:0

Device Type

EAP device type:
The Lo-Word contains the CoE profile used (5002).
The Hi-Word contains the CoE profile used (1000).

UINT32

RO

0x03E8138A (65541002_dec)

1008:0

Device Name

Name of the EAP device

STRING[256]

RO

EtherCAT Automation Protocol

100A:0

Software version

Software version of the EAP device

UINT32

RO

0x00000000 (0_dec)

1018:0

Identity

Information for the identification of the EAP device

UINT8

RO

0x04 (4_dec)

1018:01

Vendor ID

Vendor ID of the EAP device

UINT32

RO

0x00000002 (2_dec)

1018:02

Product Code

Product code of the EAP device

UINT32

RO

0x03E8138A (65541002_dec)

1018:03

Product Revision

Revision number of the EAP device

UINT32

RO

0x00030000 (196608_dec)

1018:04

Serial Number

Serial number of the EAP device.
0 means not used

UINT32

RO

0x0

(0_dec)

1600+n:0

Number of used Elements

Number of entries in the RxPDO mapping object

UINT8

RW

#(Subindices)

1600+n:01-255

RxVariable m

Bit 0-7: bit length of the object entered (in the case of a gap in the PDO, corresponds to the bit length of the gap)
Bit 8-15: subindex of the object entered (0 in case of a gap in the PDO)

Bit 16-31: index of the object entered (0 in case of a gap in the PDO)

UINT32

RW

-

1A00+n:0

Number of used Elements

Number of entries in the TxPDO mapping object

UINT8

RW

#(Subindices)

1A00+n:01-255

TxVariable m

Bit 0-7: bit length of the object entered (in the case of a gap in the PDO, corresponds to the bit length of the gap)
Bit 8-15: subindex of the object entered (0 in case of a gap in the PDO)

Bit 16-31: index of the object entered (0 in case of a gap in the PDO)

UINT32

RW

-

F100:0

EAP Status

Status information for the EAP device

UINT8

RO

0x02 (2_dec)

F100:01

Status word

The low byte codes the current state of the EAP device:
0 = Invalid

1 = Init

2 = PreOperational

4 = SafeOperational

8 = Operational

The high byte codes whether an error has occurred:

0 = no error

1 = error

UINT16

RO

0x0008 (8_dec)

F100:02

Status Error Code

An error number that identifies the error that has occurred. 0 means that no error has been identified.

UINT32

RO

0x03E8138A (65541002_dec)

F200:0

EAP Control

Parameter for checking the state of the EAP device

UINT8

RO

0x01 (2_dec)

F200:01

Control Word

Codes the request to place the EAP device in a desired state:
1 = Init

2 = PreOperational

4 = SafeOperational

8 = Operational

UINT16

RO

0x0008 (8_dec)

F020+n:0

Number of used Elements

Number of configured TxFrames

UINT8

RW

#(Subindices)

F020+n:01-254

Box 1 (Publisher)

Value 0x0000 0000 = first TxFrame object (index 8000) doesn't exist

Value 0x0000 03E8 ( = 1000): first TxFrame object (index 8000) exists

Other values are not permissible.

This object can be used to generate/delete TxFrames

UINT32

RW

0x000003E8 (1000 _dec)

F800:0

Number of used Elements

Number of entries in the EAP Info object

UINT8

RW

0x08 (8_dec)

F800:01

Available Tx Var

Indicates the maximum number of configured TxVariable objects (0x6nnn).

UINT16

RW

-

F800:02

Available Rx Var

Indicates the maximum number of configured RxVariable objects (0x7nnn).

UINT16

RW

-

F800:03

Available Tx Process Data

Indicates the maximum number of configured Transmit ProcessData objects (0xDnnn).

UINT16

RW

-

F800:04

Available Rx Process Data

Indicates the maximum number of configured RxProcessData objects (0xEnnn).

UINT16

RW

-

F800:05

Available Tx PDOs

Indicates the maximum number of configured TxPDO objects (0x1Ann).

UINT16

RW

-

F800:06

Available Rx PDOs

Indicates the maximum number of configured RxPDO objects (0x16nn).

UINT16

RW

-

F800:07

Available Tx Frames

Indicates the maximum number of configured TxFrame objects (0x8nnn).

UINT16

RO

-

F800:08

Device Cycle Time

Indicates the cycle time with which the EAP device is operated.

ProcessData Cycle times (e.g. 0xDnnn:07) can only assume whole-number multiples of this value.

UINT32

RO

-

F801:0

Number of used Elements

Number of entries in the Bitmap object

UINT8

RW

0x06 (6_dec)

F801:01

Index-Bitmap Tx Var

Bit-coded mapping of existing TxVariable objects.

If bit n is set, then index 0x 6000 + n exists.

OCTETE-STRING

[512]

RW

-

F801:02

Index-Bitmap Rx Var

Bit-coded mapping of existing RxVariable objects.

If bit n is set, then index 0x 7000 + n exists.

OCTETE-STRING

[512]

RW

-

F801:03

Index-Bitmap Tx Process Data

Bit-coded mapping of existing TxProcessData objects.

If bit n is set, then index 0x D000 + 4*n exists.

OCTETE-STRING

[128]

RW

-

F801:04

Index-Bitmap RxProcess Data

Bit-coded mapping of existing RxProcessData objects.

If bit n is set, then index 0x E000 + 4*n exists.

OCTETE-STRING

[128]

RW

-

F801:05

Index-Bitmap Tx PDOs

Bit-coded mapping of existing TxPDO objects.

If bit n is set, then index 0x1A00 + n exists.

OCTETE-STRING

[64]

RW

-

F801:06

Index-Bitmap Rx PDOs

Bit-coded mapping of existing RxPDO objects.

If bit n is set, then index 0x1600 + n exists.

OCTETE-STRING

[64]

RW

-

F920:0

Number of used Elements

Number of entries in the AoE Settings object

UINT8

RW

0x05 (5_dec)

F920:01

Local AoE NetID

Local AoE NetID of the EAP device

OCTET-STRING

[6]

RW

-

F920:02

Router NetID

AoE NetID of the associated AoE router

OCTET-STRING

[6]

RO

-

F920:03

Local MAC Address

Local MAC address of the network card used by this EAP device.

OCTET-STRING

[6]

RO

-

F920:04

Local IP Address

Local IP address of the corresponding network card used by this EAP device.

UINT32

RW

-

F920:05

Local Port Name

Name under which the EAP device together with its AoE port is registered with the TwinCAT ADS router.

STRING

[31]

RW

EtherCAT Automation Protocol

6000+n:0

Number of used Elements

Number of entries in the TxVariable object

UINT8

RW

0x22 (34_dec)

6000+n:01

Size

Length of data (subindex 2) in bits

UINT16

RW

-

6000+n:02

Data

The current data of the variable

OCTET-STRING
[Size/8]

RO

-

6000+n:03

Name

Name of the variable

STRING
[256]

RW

VarData

6000+n:04

Type

Data type of the object as a GUID

GUID

RW

-

6000+n:05

Reserved

-

UINT32

RW

-

6000+n:29

Symbol Name

Symbol name of the linked variable from the application (e.g. PLC-Task - PLC-Projectname.MAIN.iCounter)

STRING
[256]

RW

-

6000+n:30

AoE Address

Octet 7..2: AoE NetID
Octet 1..0: AoE Port

Of the object dictionary that contains the current process variable

OCTET-STRING
[8]

RW

-

6000+n:32

Image Config

Coding indicating which input/output variables of the process image belong to this object

UINT32

RO

-

6000+n:33

Data Offset

Byte offset within the output process image

UINT32

RO

-

6000+n:34

Reserved

-

UINT32

RO

-

7000+n:0

Number of used Elements

Number of entries in the RxVariable object

UINT8

RW

0x22 (34_dec)

7000+n:01

Size

Length of data (subindex 2) in bits

UINT16

RW

-

7000+n:02

Data

The current data of the variable

OCTET-STRING
[Size/8]

RW

-

7000+n:03

Name

Name of the variable

STRING
[256]

RW

VarData

7000+n:04

Type

Data type of the object as a GUID

GUID

RW

-

7000+n:05

Reserved

UINT32

RW

-

7000+n:29

Symbol Name

Symbol name of the linked variable from the application (e.g. PLC-Task - PLC-Projectname.MAIN.iCounter)

STRING
[256]

RW

-

7000+n:30

AoE Address

Octet 7..2: AoE NetID
Octet 1..0: AoE Port

Of the object dictionary that contains the current process variable

OCTET-STRING
[8]

RW

-

7000+n:32

Image Config

Coding indicating which input/output variables of the process image belong to this object

UINT32

RO

-

7000+n:33

Reserved

-

UINT32

RO

-

7000+n:34

Data Offset

Byte offset within the output process image

UINT32

RO

-

8000+n*8:0

Number of used Elements

Number of entries in the TxFrame object

UINT8

RW

0x32 (50_dec)

8000+n*8:03

Name

Name of the frame

STRING
[256]

RW

-

8000+n*8:04

Device type

Subprofile type (identical to the corresponding entry in the object 0xF020-0xF022)

UINT32

RO

0x03E8 (1000_dec)

8000+n*8:05

Destination Vendor ID

For peer-to-peer communication;

0 = not used

Polled Connection:
Vendor ID of the communication partner

Pushed Connection:
not used

UINT32

RW

-

8000+n*8:06

Destination Product Code

For peer-to-peer communication;

0 = not used

UINT32

RW

-

8000+n*8:07

Destination Revision Number

For peer-to-peer communication;

0 = not used

UINT32

RW

-

8000+n*8:08

Destination Serial Number

For peer-to-peer communication;

0 = not used

UINT32

RW

-

8000+n*8:30

Target AMS NetID

AoE NetID (Subscriber Net ID)

If the value is not 0, the destination addresses SI 32 and SI 33 must have the value 0.

OCTET-STRING
[6]

RW

-

8000+n*8:31

Gateway IP Address

The standard gateway IP address must then be set if SI 33 does not have the value 0.

UINT32

RW

-

8000+n*8:32

Target MAC Address

MAC address

If the value is not 0, the destination addresses SI 30 and SI 33 must have the value 0.

The MAC address can be a Unicast, Multicast or Broadcast address.

OCTET-STRING
[6]

RW

01 01 05 04 00 00

8000+n*8:33

Target IP Address

IP Address

If the value is not 0, the destination addresses SI 30 and SI 32 must have the value 0.

The IP address can be a Unicast, Multicast or Broadcast address.

UINT32

RW

-

8000+n*8:34

VLAN Info

The VLAN Info is made up of the following fields:

Bit 0-15: VLan Type (81 00)
Bit 16-18: Priority
Bit 19: Reserved
Bit 20-31: VLan ID

No VLAN header is used if the value is 0

UINT32

RW

0x00000000 (0_dec)

8000+n*8:35

Subscriber Monitoring

If the value is 1, an ARP request is sent regularly to the configured destination address in order to ensure that the addressee is still replying. Sending of the TxFrame is ceased if this is not the case.

The Subscriber Monitoring can only be used with a Unicast communication.

UINT8

RW

0x00 (0_dec)

8000+n*8:36

Target Changeable

If Target Changeable has the value 0, no variable is shown for the destination address in the process image. Otherwise the following mapping applies when showing the destination address:

1 : Target MAC address
2 : Target AMS NetID
3 : Target IP address

UINT8

RO

0x00 (0_dec)

8000+n*8:37

Monitoring Retry Cycles

obsolete

UINT32

RO

-

8000+n*8:38

Monitoring Retry Cycle Time

Waiting time in µs after which a new ARP request is sent if SI 35 = 0x01.

UINT32

RW

0xF4240 (1000000_dec)

8000+n*8:39

Frame Control

Bit 0 = 1: the sending of the TxFrame is ceased

Bit 1 = 1: destination MAC address is deleted from the ARP cache

UINT16

RW

0x0000 (0_dec)

8000+n*8:40

Frame State

Bit 0 = 1: the TxFrame wasn't sent

Bit 1 = 1: error (the frame is too large)

Bit 2 = 1: the subscriber is no longer answering (only if SI 35 = 0x01)

UINT16

RO

0x0000 (0_dec)

8000+n*8:48

Control Symbol Name

Symbol name of the linked variable from the application (e.g. PLC-Task)

STRING
[256]

RW

-

8000+n*8:49

State Symbol Name

Symbol name of the linked variable from the application (e.g. PLC-Task)

STRING
[256]

RW

-

8000+n*8:50

Target Address Symbol Name

Symbol name of the linked variable from the application (e.g. PLC-Task)

If a symbol name is set, the configured destination address is shown in the process image and SI 36 is set accordingly.

STRING
[256]

RW

-

8001+n*8:0

Number of used Elements

Number of entries in the TxPD assignment object

UINT8

RW

#(Subindices)

8001+n*8
:01-255

Entry n

1. -255. TxProcessData of the TxFrame

UINT16

RW

-

8002+n*8:0

Number of used Elements

Number of entries in the TxFrameInfo object

UINT8

RW

0x21 (33_dec)

8002+n*8:01

Image Config

Coding indicating which input/output variables of the process image belong to this object

Lo-Word = Input process image

Bit 0 = 1: State

Hi-Word = output Process image

Bit 0 = 1: Control

Bit 1 = 1: Target MAC Address

Bit 2 = 1: Target AMS NetID

Bit 3 = 1: Target IP Address

UINT32

RO

0x00010001 (65537_dec)

8002+n*8:02

Control Offset

Byte offset within the output process image

UINT32

RO

-

8002+n*8:03

State Offset

Byte offset within the input process image

UINT32

RO

-

8002+n*8:04

NetID Offset

Byte offset within the output process image

UINT32

RO

-

8002+n*8:32

IoDivMod

The divider/modulo value defines the waiting time in cycles until the next TxFrame is sent.

Bit 0-7 (Divider): number of cycles to be waited

Bit 8-15 (Modulo): specifies the start cycle from which counting starts

UINT16

RW

0x0000 (0_dec)

8002+n*8:33

CoE Index

For future purposes

UINT16

RW

-

D000+n*4:0

Number of used Elements

Number of entries in the TxPD object

UINT8

RW

0x22 (34_dec)

D000+n*4:01

Name

Name of the frame

STRING
[256]

RW

-

D000+n*4:02

PDO Number

The PDO number defines the object index of the assigned TxPDO

UINT16

RW

-

D000+n*4:03

Process Data ID

The PD ID defines a value in the range 0…65535 that must clearly be within the communication network.

The ID is part of the Process Data Frame header.

UINT16

RW

-

D000+n*4:04

Version

The version is a value in the range 0…65535 and should be consistently incremented as soon as changes are made to this TxPD (e.g. the reference to another TxPDO).

The version is part of the Process Data Frame header.

UINT 16

RW

-

D000+n*4:05

CoS On Change Cycles

Obsolete, see subindex 8.

UINT16

RO

-

D000+n*4:06

CoS Inhibit Time

The Inhibit Time specifies the time span in µs during which the TxPD is not sent again, not even if the value of a process variable of the assigned PDO has changed.

The transmission of the TxPD is not suppressed if the value is 0.

If the value is > 0, then the value of subindex 8 (CoS On Change Timeout) must also be > 0; however, the values of the subindices 7 and 10 must be 0.

UINT32

RW

-

D000+n*4:07

Cycle Time

The Cycle Time defines the time interval in µs at which the TxPD is cyclically transmitted. If the value of Cycle Time is larger than 0, the subindices 6, 8 and 10 must be 0.

The TxPD is not transmitted at all if the value is 0.

UINT 32

RW

-

D000+n*4:08

CoS On Change Timeout

On Change Timeout specifies the maximum duration of the time interval in µs during which no TxPD is transmitted, unless the value of a process variable of the assigned PDO changes during that time.

If the value is 0, the process variables are not sent in the case of a change of state.

If the value is > 0, the values of subindices 7 and 10 must be 0.

UINT32

RW

-

D000+n*4:10

Poll Request Rx PD

Poll Request RxPD defines the object index of an RxProcessData, which triggers the transmission of this TxPD as soon as the defined RxPD has received a new value. The TxPD then functions as a server in Polled Data Exchange mode.

The Polled Data Exchange mode is inactive if the value is 0.

If the value is > 0, the values of subindices 6, 7 and 8 must be 0.

UINT16

RW

-

D000+n*4:11

Process Data Control

Bit 0 = 1: deactivate the transmission of the TxPD

UINT16

RW

0x0000 (0_dec)

D000+n*4:12

Process Data State

Bit 0 = 1: the TxPD was not transmitted

UINT16

RO

-

D000+n*4:32

Control Symbol Name

Symbol name of the linked variable from the application (e.g. PLC-Task)

STRING

[256]

RW

-

D000+n*4:33

State Symbol Name

Symbol name of the linked variable from the application (e.g. PLC-Task)

STRING

[256]

RW

-

D000+n*4:34

ID Symbol Name

Symbol name of the linked variable from the application (e.g. PLC-Task)

STRING

[256]

RW

-

D002+n*4:0

Number of used Elements

Number of entries in the TxPDInfo object

UINT8

RW

0x20 (32_dec)

D002+n*4:01

Image Config

Coding indicating which input/output variables of the process image belong to this object

Lo-Word = Input process image

Bit 0 = 1: State

Hi-Word = output Process image

Bit 0 = 1: Control

Bit 1 = 1: ProcessData ID

UINT32

RO

0x00010001 (65537_dec)

D002+n*4:02

Control Offset

Byte offset within the output process image

UINT32

RO

-

D002+n*4:03

State Offset

Byte offset within the input process image

UINT32

RO

-

D002+n*4:04

ID Offset

Byte offset within the output process image

UINT32

RO

-

D002+n*4:32

IoDivMod

The divider/modulo value defines the waiting time in cycles until the TxPD is sent again.

Bit 0-7 (Divider): number of cycles to be waited

Bit 8-15 (Modulo): specifies the start cycle from which counting starts

UINT16

RW

0x0000 (0_dec)

E000+n*4:0

Number of used Elements

Number of entries in the RxPD object

UINT8

RW

0x25 (37_dec)

E000+n*4:01

Name

Name of the frame

STRING
[256]

RW

-

E000+n*4:02

PDO Number

The PDO number defines the object index of the assigned RxPDO

UINT16

RW

-

E000+n*4:03

Process Data ID

The PD ID defines a value in the range 0…65535 that matches the ID of the Process Data received.

UINT16

RW

-

E000+n*4:04

Version

The version is a value in the range 0…65535 and should be consistently incremented as soon as changes are made to this RxPD (e.g. the reference to another RxPDO).

UINT 16

RW

-

E000+n*4:05

Ignore Version

If this is 0, then the version (hash value) of the Process Data received is checked on the basis of the version from subindex 4.

If it is 1, then the version check is deactivated.

UINT8

RW

0x00 (0_dec)

E000+n*4:06

Publisher NetID

Definition of a Publisher NetID. An EAP telegram is only processed if it was sent from a sender with this NetID.

This filter is deactivated if the Publisher NetID has the value 0.

OCTET-STRING

[6]

RW

00 00 00 00 00 00

E000+n*4:07

MAC Address

A Multicast MAC address can be defined that uses the NIC (Network Interface Card) as a filter for the reception of Multicast packets.

The filter function is deactivated if the value is 0.

OCTET-STRING

[6]

RW

01 01 05 04 00 00

E000+n*4:08

IP Address

A Multicast IP address can be defined that uses the NIC (Network Interface Card) as a filter for the reception of Multicast packets.

The filter function is deactivated if the value is 0.

UINT32

RW

0x00000000

(0_dec)

E000+n*4:09

Update Time

The Update Time is used to specify the time interval in µs within which a new ProcessData must be received.

This mechanism is deactivated if the value is 0.

UINT32

RW

0x00000000

(0_dec)

E000+n*4:10

Poll Request TxPD

Poll Request TxPD defines the object index of a TxProcessData, which is sent as a request in order to receive an EAP telegram with the suitable ProcessData.

The TxPD then functions as a server in Polled Data Exchange mode.

The Polled Data Exchange mode is inactive if the value is 0.

UINT16

RW

0x0000

(0_dec)

E000+n*4:11

Process Data Control

Bit 0 = 1: The checking of the version number or the hash value is deactivated.

UINT16

RW

0x0000 (0_dec)

E000+n*4:12

Process Data State

Bit 0 = 1: A ProcessData with an invalid version number (hash value) was received

Bit 1 = 1: A ProcessData with an invalid length was received

Bit 2 = 1: The Timeout Poll Response was exceeded

UINT16

RO

-

E000+n*4:13

Process Data Quality

The quality indicates the time in 100 µs since this RxProcessData was last updated (i.e. since data was last received)

UINT16

RO

-

E000+n*4:14

Process Data Cycle Index

On receiving a valid ProcessData, the Cycle Index is assigned the transmitted Cycle Index from the EAP telegram (see Process Data Frame Header)

UINT16

RO

-

E000+n*4:32

Control Symbol Name

Symbol name of the linked variable from an application (e.g. PLC Task)

STRING

[256]

RW

-

E000+n*4:33

State Symbol Name

Symbol name of the linked variable from an application (e.g. PLC Task)

STRING

[256]

RW

-

E000+n*4:34

ID Symbol Name

Symbol name of the linked variable from an application (e.g. PLC Task)

STRING

[256]

RW

-

E000+n*4:35

Quality Symbol Name

Symbol name of the linked variable from the application (e.g. PLC-Task)

STRING

[256]

RW

-

E000+n*4:36

Cycle Index Symbol Name

Symbol name of the linked variable from the application (e.g. PLC-Task)

STRING

[256]

RW

-

E000+n*4:37

Timeout Poll Response

Specifies the maximum time span in µs within which the response to the Polled Request must be received.

If the Value > 0 and the timeout has expired following the sending of the Polled Request, then bit 2 is set in PD State (subindex 12).

If the value is 0, then this monitoring is deactivated.

UINT32

RW

0x00000000

(0_dec)

E002+n*4:0

Number of used Elements

Number of entries in the RxPD Info object

UINT8

RW

0x06 (6_dec)

E002+n*4:01

Image Config

Coding indicating which input/output variables of the process image belong to this object

Lo-Word = Input process image

Bit 0 = 1: State

Hi-Word = output Process image

Bit 0 = 1: Control / Cycle Index

Bit 1 = 1: ProcessData ID

UINT32

RO

0x00010001 (65537_dec)

E000+n*4:02

Control Offset

Byte offset within the output process image

UINT32

RO

-

E002+n*4:03

State Offset

Byte offset within the input process image

UINT32

RO

-

E002+n*4:04

ID Offset

Byte offset within the output process image

UINT32

RO

-

E002+n*4:05

Quality Offset

Byte offset within the input process image

UINT32

RO

-

E002+n*4:06

Cycle Index Offset

Byte offset within the input process image

UINT32

RO

-