Configuring the Fieldbus Interface

Introduction

This section describes the configuration of the Modicon TM5 EtherNet/IP Fieldbus Interface as an Ethernet/IP target device.

For further information about EtherNet/IP, refer to the www.odva.org website.

EtherNet/IP Target Configuration

To configure your TM5NEIP1 as an EtherNet/IP  target device, add the fieldbus interface to your project. Refer to Adding a Fieldbus Interface.

Industrial Ethernet Port Configuration

The device can be connected via Industrial Ethernet. For information and procedures necessary to configure the device network, refer to the EcoStruxure Machine Expert EtherNet/IP User Guide.

EtherNet/IP Parameter Configuration

To configure the Ethernet/IP parameters, double-click the TM5 EtherNet/IP Fieldbus Interface node in the Devices tree.

Target Settings Tab

G-SE-0076159.1.gif-high.gif

 

 

The configured parameters are explained as below:

Configurable Parameters

Description

IP Address by DHCP

IP address is obtained via DHCP

Fixed IP Address

IP address, subnet mask and gateway address are defined by the user

Electronic Keying

Electronic Keying signatures are used to identify the device. Electronic Keying is information contained in the firmware of the device (Vendor Code, Product Code, …).When the controller scanner starts, it compares each selected electronic keying value with the corresponding information in the device. If the device values are not the same as the application values, the logic controller no longer communicates with the device.

You can configure any of following Electronic Keying attributes:

Attribute

Description

Check Device Type

The general type of the product.

Check Vendor Code

The device manufacture.

Check Product Code

The specific type of the product. The Product Code maps to a catalog number. The Product Code differentiates the product from other products of the same Device Type under the indicated Vendor.

Check Major Revision

A number that represents the functional capabilities of a device. Typically, a Major Revision is backwards compatible with a lower Major Revision.

Check Minor Revision

A number that represents behavior changes in the device, for example, anomaly corrections. This number does not represent the functional capabilities of a device.

Connections on Ethernet/IP

To access a target device, an Originator opens a connection which can include several sessions that send requests.

One explicit connection uses one session (a session is a TCP or UDP connection).

One I/O connection uses two sessions.

The total number of connections is 32.

NOTE: The TM5 EtherNet/IP Fieldbus Interface supports cyclic connections. If an Originator opens a connection using a change of state as a trigger, packets are sent at the RPI rate.

Connections Tab

Each EtherNet/IP device has connections.

In the Devices tree, double-click an EtherNet/IP device and select the Connections tab.

Column

Comment

Connection N°

The connection number is unique. It is automatically assigned by EcoStruxure Machine Expert.

Connection Name

The connection name is generated automatically by EcoStruxure Machine Expert.

RPI O --> T (ms)

Requested Packet Interval: The time period between cyclic data transmissions requested by the scanner.

RPI T --> O (ms)

O->T size (byte)

Number of bytes to exchange between the Originator (O) and the Target (T).

T->O size (byte)

To create a connection, click Add Connection.

To modify a connection, select a connection and click Edit Connection, or double-click it.

To remove a connection, select a connection and click Delete Connection.

EtherNet/IP I/O Mapping Tab

Variables can be defined and named in the EtherNet/IP I/O Mapping tab. Additional information such as topological addressing is also provided in this tab. For information and procedures necessary to configure the EtherNet/IP I/O Mapping, refer to the EcoStruxure Machine Expert Programming Guide.

Status

The description of the TM5 EtherNet/IP Fieldbus Interface status is as follows:

oReads the fieldbus interface status. 32 bits of information are available.

oBits 0 to 10 indicate error-free states; bits 11 to 31 indicate error states.

oIndividual states are also indicated by the LED status indicators on the fieldbus interface.

The following table shows bits, their values and description:

Bit

Value (hex)

Description

0

0x00000001

The adapter was configured using configuration assemblies.

1

0x00000002

System start or I/O module detection is done.

2

0x00000004

Fieldbus interface is not ready to start I/O module configuration.

3

0x00000008

Fieldbus interface I/O module configuration is in process.

4

0x00000010

All I/O module configuration is complete.

5

0x00000020

Ethernet/IP stack initialization is done.

6

0x00000040

Ethernet/IP stack configuration is done.

7…10

0x00000040...0x00000400

Reserved

11

0x00000800

Memory error

12

0x00001000

Flash data error while reading the primary flash memory page.

13

0x00002000

Firmware update error detected. The fieldbus interface is booting with the default firmware.

14

0x00004000

Missing module detected during boot phase

15

0x00008000

Incorrect module detected during boot phase.

16

0x00010000

The adapter has not yet received an IP address assignment from DHCP.

17

0x00020000

2 or more identical IP addresses exist in the network.

18

0x00040000

General EIP stack error

19

0x00080000

Communication resources: Limit reached

20

0x00100000

Stack socket error occurred

21

0x00200000

Insufficient memory

22

0x00400000

Error detected while reading the primary flash memory page.

23

0x00800000

Faulty configuration assembly data

24

0x01000000

“Scanner auto-connected” error

25

0x02000000

Faulty firmware update detected. The fieldbus interface is booting with the default firmware.

26

0x04000000

Error when generating the configuration

27

0x08000000

Configuration resource is currently locked

28…31

0x01000000…0x80000000

Reserved

Profile

The controller supports the following objects:

Object class

Class ID (hex)

Number of Instances

Effect on Interface Behavior

Identity Object

01

1

Provides general information about the bus coupler.

Message Router Object

02

2

Provides message connection.

Assembly Object

04

2

Defines I/O data format.

Connection Manager Object

06

1

Bus Controller Object

64

2

Connection Object

F4

1

Displays connection properties.

TCP/IP Interface Object

F5

1

Displays TCP/IP configuration.

Ethernet Link Object

F6

1

Displays counter and status information for the IEEE 802.3 interface.

Common Class Attributes

The following table describes the class attributes of all supported object:

Attribute ID (hex)

Access

Data type

Description

0x1

Get

UINT

Object revision

0x2

Get

UINT

Largest instance number of the object generated in this class level

0x3

Get

UINT

Number of generated instances

0x4

Get

STRUCT of UINT

Number of optional attributes

ARRAY of UINT

List of optional attribute numbers

0x5

Get

STRUCT of UINT

Number of optional services

ARRAY of UINT

List of optional service codes

0x6

Get

UDINT

Largest possible ID number of class attributes

0x7

Get

UDINT

Largest possible ID number of instance attributes

Identity Object (Class ID = 01 hex)

The identity object provides identification and status information about the device or object.

The following table provides a general overview of the identity object:

Value

Description

0x1, 0x2, 0x3, 0x6, 0x7

Class attributes

0x1, 0xE

Class services

0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8

Instance attributes

0x1, 0x5, 0xE

Instance services

The following table describes the instance attributes:

Attribute ID (hex)

Access

Data type

Description

Function

0x1

Get

UINT

Vendor ID

0x0377 (887)

0x2

Get

UINT

Device type

Default value: 0xF3 (243) = Adapter device

0x3

Get

UINT

Product code

Hardware ID of the fieldbus interface. This is identical to the first four characters printed on the module's housing.

Fieldbus interface code: 0x100A (4106)

0x4

Get

STRUCT of USINT

Major revision

ZZ = Firmware major revision

STRUCT of USINT

Minor revision

YY = Firmware minor revision

0x5

Get

WORD

Status

Refer to status code table below.

0x6

Get

UDINT

Serial number

Identical to the seven characters on the module's housing after the hardware ID

0x7

Get

STRING

Product name

0x1C (length = 28) and hexadecimal equivalent of TM5 EtherNet/IP Fieldbus Interface TM5NEIP1

0x8

Get

USINT

Status

0 = Does not exist

1 = Device self-test

2 = Standby

3 = Operational

4 = Major recoverable fault

5 = Major unrecoverable fault

6 to 254 = Reserved

The following table describes the status codes of instance attribute 5:

Bit

Definition

Function

0

Owned by master (predefined master/slave connection)

There is an owner for the device or object within the device. In the master/slave paradigm, setting this bit means that a master has been assigned to a predefined master/slave connection set.

1

-

Reserved, set to 0 by default.

2

Configured

The firmware is no longer set to the pre-configured default behavior. This does not include how communication is configured.

3

-

Reserved, set to 0 by default.

4…7

Extended device status (Refer to extended status codes table below)

The extended device status indicates whether the device is following the general definition for using this bit through the use of the DeviceStatusAssembly keyword in the [Device] section of the EDS file.

8

Minor recoverable Fault

The device has self-diagnosed a problem that appears to be recoverable. This problem does not cause the device to enter into an error state.

9

Minor unrecoverable Fault

The device has self-diagnosed a problem that does not appear to be recoverable. This problem does not cause the device to enter into an error state.

10

Major recoverable Fault

The device has self-diagnosed a problem that forces it to enter the "Major recoverable fault" error state.

11

Major unrecoverable Fault

The device has self-diagnosed a problem that forces it to enter the "Major unrecoverable fault" error state.

12-15

-

Reserved, set to 0 by default.

The following table describes the extended status codes of Bits 4-7 of instance attribute 5:

Bits 4…7

Definition

0000

Self-testing or unknown.

0001

Firmware update in progress.

0010

At least on faulted I/O connection.

0011

No I/O connections established.

0100

Non-volatile configuration.

0101

Major fault - either bit 10 or 11 is true.

0110

At least one I/O connection in run mode.

0111

At least one I/O connection established, all in idle mode.

1000…1001

Reserved, set to 0 by default.

1010…1111

Vendor or product specific.

The following table describes the identity services:

Service code (hex)

Supported by

Service name

Description

0x1

Class/Instance

Get_Attribute_All

Read all attributes

0x5

Instance

Reset

Reset factory default

0xE

Class/Instance

Get_Attribute_Single

Read one attribute

Message Router Object (Class ID = 02 hex)

The message router provides a message connection that can be used by a client to execute any class or instance services within a physical device.

The following table provides a general overview of the Message Router Object:

Value

Description

0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7

Class attributes

0x1, 0xE

Class services

0x1, 0x2

Instance attributes

0x1, 0xE

Instance services

The following table describes the instance attributes:

Attribute ID (hex)

Access

Data type

Description

0x1

Get

STRUCT of UINT

List of all supported objects

Number of supported classes in class array

ARRAY of UINT

List of supported class codes

0x2

Get

UINT

Maximum number of supported connections

The following table describes the service objects:

Service code (hex)

Supported by

Service name

Description

0x1

Class/Instance

Get_Attribute_All

Returns a list of object attributes

0xE

Class/Instance

Get_Attribute_Single

Supplies the contents of the corresponding attribute

Assembly Object (Class ID = 04 hex)

The assembly object unifies the attributes of various objects and allows data for each object to be transmitted or received using a single connection. The assembly object can be used for input and output data. The direction is considered from the network's point of view.

The following table provides a general overview of the assembly object:

Value

Description

0x1, 0x2, 0x3, 0x6, 0x7

Class attributes

0x1, 0xE

Class services

0x3

Instance attributes

0xE, 0x10

Instance services

The following table describes the instance attributes:

Attribute ID (hex)

Access

Data type

Description

0x3

Set

ARRAY OF BYTE

Data

The following table describes the service objects:

Service code (hex)

Supported by

Service name

Description

0xE

Class/Instance

Get_Attribute_Single

Supplies the contents of the corresponding attribute

0x10

Instance

Get_Attribute_Single

Modifies the value of an attribute

Connection Manager Object (Class ID = 06 hex)

The connection manager object is used for connected and connectionless communication using various subnetworks.

The following table provides a general overview of the connection manager object:

Value

Description

0x1, 0x2, 0x3, 0x4, 0x6, 0x7

Class attributes

0x1, 0xE

Class services

0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8

Instance attributes

0x1, 0xE, 0x4E, 0x52, 0x54

Instance services

The following table describes the instance attributes:

Attribute ID (hex)

Access

Data type

Description

0x1

Set (1)

UINT

Number of forward open service requests received.

0x2

Set (1)

UINT

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

0x3

Set (1)

UINT

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

0x4

Set (1)

UINT

Number of forward open service requests that were not rejected due to an invalid format or insufficient resources.

0x5

Set (1)

UINT

Number of received forward close service requests.

0x6

Set (1)

UINT

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

0x7

Set (1)

UINT

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

0x8

Set

UINT

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

(1) A device can refuse the Set request to this attribute if the transmitted attribute value is not zero. In this case, it transmits the general status code 0x09 (invalid attribute value).

The following table describes the service objects:

Service code (hex)

Supported by

Service name

Description

0x1

Class/Instance

Get_Attribute_All

Returns a predefined list of object attributes

0xE

Class/Instance

Get_Attribute_Single

Returns the contents of the corresponding attributes

0x4E

Instance

Forward_Close

Closes a connection

0x52

Instance

Unconnected_Send

Unconnected transmit service

0x54

Instance

Forward_Open

Opens a connection, maximum data size is 511 bytes

Bus Controller Object (Class ID = 64 hex)

The bus controller object is used to configure all global bus controller parameters. All I/O module parameters are managed individually using the I/O module object.

The following table provides a general overview of the bus controller object:

Value

Description

0x1, 0x2

Class attributes

0xE

Class services

0x1, 0x2, 0x3, 0x5, 0x6, 0x7, 0x8, 0x9, 0xA, 0xB, 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x80, 0x81, 0xE0, 0xE1, 0xE2, 0xE3, 0xE4, 0xE5, 0xE6

Instance attributes

0x10, 0x32, 0x33, 0x34, 0x34, 0x35, 0x36, 0x37, 0x38, 0x40, 0x41, 0x42, 0xE

Instance services

The following table describes the instance attributes:

Attribute ID (hex)

Access

Data type

Description

0x1

Get

UDINT

Adapter status

0x2

Get

UINT

Hardware major revision

0x3

Get

UINT

Hardware minor revision

0x4

Get

UINT

FPGA hardware revision

0x5

Get

UINT

Active boot block

0x6

Get

UINT

Default firmware major revision

0x7

Get

UINT

Default firmware minor revision

0x8

Get

UINT

Update firmware major revision

0x9

Get

UINT

Update firmware minor revision

0xA

Get

UINT

Default FPGA software revision

0xB

Get

UINT

Update FPGA software revision

0x20

Get

UINT

Number of modules

0x21

Get

UINT

Length of the analog input data in bytes

0x22

Get

UINT

Length of the analog output data in bytes

0x23

Get

UINT

Length of the digital input data in bytes

0x24

Get

UINT

Length of the digital output data in bytes

0x25

Get

UINT

Length of the X2X network status information in bytes

0x26

Get

UINT

Length of the output status information in bytes

0x27

Get

UINT

Highest X2X station number currently in use

0x40

Set/Get

UINT

Size of the analog input assembly in bytes (AI)

0x41

Set/Get

UINT

Size of the analog output assembly in bytes (AO)

0x42

Set/Get

UINT

Size of the digital input assembly in bytes (DI)

0x43

Set/Get

UINT

Size of the digital output assembly in bytes (DO)

0x44

Set/Get

UINT

Size of the X2X network status assembly in bytes (NS)

0x45

Set/Get

UINT

Size of the output status assembly in bytes (OS)

0x46

Set/Get

UINT

Composition of the combination input assembly

0x60

Set/Get

UINT

Global action delay time (ms)

0x61

Set/Get

UINT

Communication loss (timeout) action

0x62

Set/Get

UINT

Communication loss (timeout) scope

0x63

Set/Get

UINT

Communication loss (timeout) reset mode

0x64

Set/Get

UINT

Program mode (idle) action

0x65

Set/Get

UINT

Program mode (idle) scope

0x66

Set/Get

UINT

Action for faulty or missing module in state “Operational”

0x67

Set/Get

UINT

Action for missing module(s) during the boot phase

0x68

Set/Get

UINT

Action for incorrect module type(s) during the boot phase

0x80

Set/Get

UINT

X2X Link configuration

0x81

Set/Get

UINT

X2X cable length (m)

0xE0

Get

UINT

Reading network address switches

0xE1

Set/Get

UINT

Module initialization delay (ms)

0xE2

Set/Get

UINT

Enable/disable the Telnet password

0xE3

Set/Get

UINT

IP maximum transmission unit (bytes)

0xE4

Get

UINT

Current boot configuration assembly ID

0xE5

Get

UINT

Read the number of configured I/O modules

The following table describes the service objects:

Service code (hex)

Supported by

Service name

Description

0xE

Class/Instance

Get_Attribute_Single

Supplies the contents of the corresponding attribute.

0x10

Instance

Get_Attribute_Single

Modifies the value of an attribute.

0x32

Class/Instance

Resets all pending timeout.

0x33

Instance

Saves all system data to flash memory. This permanently stores all changes to volatile flash memory that have not been stored there automatically by other services.

0x34

Instance

Reads all system data from flash memory. This overwrites all changes in RAM with the permanently saved settings.

0x35

Instance

Deletes this entire flash memory. This restores the default settings.

0x36

Instance

Reinitializes all assemblies.

0x37

Instance

Enables one or more extended configuration assemblies. The specified parameter makes it possible to generate several independent figurations in the 10 assemblies. This can be used to enable the desired configuration with the corresponding start assembly ID. All 10 assemblies for a single configuration can also be used.

0x38

Instance

Clears all I/O modules configuration data from RAM. Flash memory is not cleared.

0x40

Instance

Generates a new configuration based on an existing configuration or the non-connected I/O modules. This includes both configured and non configured I/O modules.

oBit 0: the configuration is compressed in ZIP format

oBit 1: The EtherNet/IP stack configuration assemblies are written

oBit 2: All data generated is stored in flash memory

oBit 3: The RAW I/O module register configuration is written

0x41

Instance

Clears the parameter list for all I/O modules.

0x42

Instance

Applies the parameter list to existing RAW configurations. This changes all existing configurations. The result is stored in the RAW configuration (Flash Shadow RAM).

Connection Object (Class ID = F4 hex)

The connection object describes the CIP connections present on the device.

The following table provides a general overview of the connection object:

Value

Description

0x1, 0x2, 0x3, 0x6, 0x7

Class attributes

0x8, 0x9

Extended class attributes

0x1, 0xE

Class services

0x1, 0x2, 0x3, 0x4, 0x7

Instance attributes

0x1, 0xE

Instance services

The following table describes the extended class attributes:

Attribute ID (hex)

Access

Data type

Description

Default Value

0x8

Get

UINT

Instance of the connection object that describes the connection object and was used to send this request to the device.

0x9

Get

ARRAY OF STRUCT

Array of structures that contain the instances attributes 1 and 2 for each instance.

(1)

UINT

Enumerates the connection types.

Refer to instance attributes below.

UINT

CIP connection number that is linked to this connection.

Refer to instance attributes below.

(1) The index of the array is determined by the instance number, i.e. from 1 to the maximum number of instances. The value at index 1 (offset 0) and non-instanced instances set to 0.

The following table describes the instance attributes:

Attribute ID (hex)

Access

Data type

Description

Function

0x1

Get

UINT

Enumerates the possible connection types. All connection types with the exception of 0 indicate routing-capable connections of the corresponding type.

o0: Connection does not support CIP routing. Attribute 2 is ignored

o1 Reserved to preserve compatibility with existing protocols

o2: ControlNet

o3: ControlNet redundant

o4: EtherNet/IP

o5: DeviceNet

o6 - 99: Reserved

o100 - 199: Manufacturer-specific

o200: CompoNet

o201: Modbus TCP

o202: Modbus SL

o203: SERCOS III

o204: -

o65534: Reserved

o65535: Not configured

0x2

Get

UINT

CIP connection number that is linked to this connection. This attribute is ignored if the connection type = 0.

Manufacturer assigns a unique value to identify each communication port. Value 1 is defined for internal product use (i.e. backplane).

Value 0 is reserved and cannot be used.

0x3

Get

STRUCT

 

 

UINT

Number of 16-bit words in the following path.

Range = 2 to 6

Padded EPATH

Logical path segment that identifies the object for this port.

The path consists of one logical class segment and one logical instance segment. The maximum size is 12 bytes.

0x4

Get

SHORT_STRING

Name of the physical network port.

"Port A", for example. The maximum number of characters is 64. This name must be different for each physical port. If several CIP ports use the same physical port, the same physical name must be used.

0x7

Get

Padded EPATH

Rotary switch value

The switch value identical to attribute  2.

The following table describes the service objects:

Service code (hex)

Supported by

Service name

Description

0x1

Class/Instance

Get_Attributes_All

Returns a predefined list of object attributes.

0xE

Class/Instance

Get_Attribute_Single

Returns the contents of the corresponding attributes.

TCP/IP Interface Object (Class Code = F5 hex)

The TCP/IP interface object provides a mechanism for configuring the TCP/IP network of the fieldbus interface.

The following table provides a general description of the TCP/IP interface object:

Value

Description

0x1, 0x2, 0x3, 0x6, 0x7

Class attributes

0x1, 0xE

Class services

0x1, 0x2, 0x3, 0x4, 0x5, 0x6

Instance attributes

0x1, 0x2, 0xE, 0x10

Instance services

The following table describes the instance attributes:

Attribute ID (hex)

Access

Data type

Description

Function

0x1

Get

DWORD

Interface status

Refer to interface status table below

0x2

Get

DWORD

Interface configuration properties

o0: BOOTP Client

o1: DNS Client

o2: DHCP Client

o3: DHCP DNS update

o4: Configured in EcoStruxure Machine Expert

o5-31: Reserved

0x3

Set

DWORD

Interface control flags

o0: The software configuration is obtained by reading the internal flash memory

o1: The software configuration is obtained with BOOTP

o2: The software configuration is obtained with DHCP

o3-15: reserved

0x4

Get

STRUCT

Path to the physically linked object

The path identifies the object that is connected to the underlying physical communication object.

UINT

Length of the path

Number of 16 bits word in the element Path.

EPATH

Logical segments that identify the physical link

The path addresses to the internal port of the built-in 3-port switch.

0x5

Get

STRUCT

TCP/IP network interface configuration

Contains TCP/IP configuration parameters.

In order to avoid incomplete or incompatible configurations, parameters cannot be set individually.

UDINT

IP address

This value is 0 if an IP address has not been configured. Otherwise, a valid class A, B or C address should be written.

Example: 0x0164A8C0 (corresponds to 192.168.100.1)

UDINT

Network mask

This value is 0 if a network mask has not been configured.

Example: 0x00FFFFFF (corresponds to 255.255.255.0)

UDINT

Gateway address

This value is 0 if a gateway address has not been configured. Otherwise, a valid class A, B or C address should be written.

Example: 0xFE64A8C0 (corresponds to 192.168.100.254)

UDINT

Primary name server

The value 0 indicates that a primary name server has not been configured. Otherwise, a valid class A, B or C address should be written.

UDINT

Secondary server

The value 0 indicates that a secondary name server has not been configured. Otherwise, a valid class A, B or C address should be written.

STRING

Domain name

ASCII characters.

The maximum length is 48 characters. They should be filled to an even number (filler byte not included in the length).

The length is 0 if a domain name has not been configured.

0x6

Get

STRING

Hostname

ASCII characters.

The maximum length is 64 characters. They should be filled to an even number (filler byte not included in the length).

The length is 0 if a domain name has not been configured.

The following table provides the interface status of attribute 1:

Bit

Name

Description

0…3

Interface configuration status

o0: The software configuration attribute has not been configured.

o1: The software configuration contains a valid configuration for BOOTP, DHCP or non volatile memory.

o2: The software configuration contains a valid configuration for hardware settings such as a thumbwheel switch, handwheel, etc.

o3-15: Reserved

4

Mcast pending

Indicates a pending configuration change in the TTL value and/or Mcast configuration attribute. This bit is set if either the TTL value or Mcast configuration attribute is set and deleted the next time the device is started.

5…31

Reserved

Reserved

The following table describes the service objects:

Service code (hex)

Supported by

Service name

Description

0x1

Class/Instance

Get_Attribute_All

Returns a predefined list of object attributes.

0x2

Instance

Set_Attribute_All

Modifies all modifiable attributes.

0xE

Class/Instance

Get_Attribute_Single

Returns the content of the corresponding attributes.

0x10

Instance

Set_Attribute_Single

Modifies an individual attribute value.

Ethernet Link Object (Class ID = F6 hex)

The Ethernet link object manages connection-specific counters and status information.

The following table provides a general overview of the Ethernet link object:

Value

Description

0x1, 0x2, 0x3, 0x6, 0x7

Class attributes

0x1, 0xE

Class services

0x1, 0x2, 0x3

Instance attributes

0x1, 0xE

Instance services

The following table describes the instance attributes:

Attribute ID (hex)

Access

Data type

Description

Function

0x1

Get

UDINT

Transfer rate currently in use

Speed in Mbps (e.g. 0, 10, 100, 1000, etc.)

0x2

Get

DWORD

Interface status flag

Refer to interface status table below

0x3

Get

ARRAY [0...5] of USINT

Physical address

Device-specific MAC address

The following table describes the status codes of the interface status flag:

Bit

Name

Description

0

Connection status

Indicates whether the communication interface is connected to an active network.

o0: Indicates an inactive link.

o1: Indicates an active link.

1

Full-/Half-duplex

Indicates the duplex mode currently in use.

o0: Indicates that the interface is running half duplex.

o1: Indicates full duplex.

This flag is undefined if the connection status flag is 0.

2…4

Auto-negotiation Status

Indicates the current status of auto-negotiation.

o0: Auto-negotiation in progress

o1-2: Auto-negotiation and speed detection not successful.

o3: Successfully negotiated speed and duplex.

o4: Auto-negotiation not attempted. Forced speed and duplex.

5

Manual Setting Require Reset

Indicates the change mode required.

o0: The interface can activate changes to link parameters (auto-negotiate, duplex mode, interface speed) automatically.

o1: The device requires a reset service be issued to its identity object in order for the changes to take effect.

6

Local Hardware Error

Indicates whether a local error is detected.

o0: Indicates that the interface detects no local hardware error

o1: Indicates that a local hardware error is detected. The meaning of this is product-specific.

7…31

Reserved

Reserved. Set to 0 by default.

The following table describes the instance service objects:

Service code (hex)

Supported by

Service name

Description

0x1

Class/Instance

Get_Attribute_All

Returns a predefined list of object attributes.

0xE

Class/Instance

Get_Attribute_Single

Provides the contents of the corresponding attribute.