Ethernet/IP integration

Integration in RSLogix EIP development tool

Example of how the module can be integrated into the RSLogix EIP development tool:

  1. Go offline.

    ../../_images/Offline_gehen.png

    Go offline

  2. Right click on Ethernet (the correct scanner card) and select New Module….

    ../../_images/New_Module_waehlen.png

    Select New Module

  3. Select the Generic Ethernet Module as Ethernet module in the communication path.

    ../../_images/Generic_Ethernet_Module_waehlen.png

    Select Generic Ethernet Module

  4. Enter tag name (user-defined), select the general format Data SINT, enter the IP address of the module and the correct connection parameters and confirm with OK.

    ../../_images/New-Module-Dialog.png

    New Module dialog

    ⇒ The new module and the corresponding controller tags are automatically generated.

    ../../_images/Controller-Tags.png

    Controller tags

  5. Download the configuration with Download.

    ../../_images/Konfiguration_herunterladen.png

    Download configuration

After the download is completed the tags can be monitored and activated using the Controller tags option.

Note

Make sure to select the previously configured correct tag name.

The entry, output and configuration data are described on the following pages.

Note

These tags can also be used for programming.

../../_images/Tag-Erstellung_beendet.png

Tag creation completed

Integration

Data configuration

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

Enter the values from Data configuration in the control system. They describe the data sizes of the entry, output and configuration data.

Data configuration

Data size

Instance ID

Length of data

Input with 32 bytes of IO-Link process data

100

392

Output with 32 bytes of IO-Link process data

101

262

Configuration

102

58/0

Automatic IO-Link

103

0 (adjustable, see Automatic IO-Link – Adjustable IO-Link process data length)

Input with 24 bytes of IO-Link process data

110

328

Output with 24 bytes of IO-Link process data

111

198

Input with 16 bytes of IO-Link process data

112

264

Output with 16 bytes of IO-Link process data

113

134

Input with 10 bytes of IO-Link process data

114

216

Output with 10 bytes of IO-Link process data

115

86

Input with 8 bytes of IO-Link process data

116

200

Output with 8 bytes of IO-Link process data

117

70

Input with 6 bytes of IO-Link process data

118

184

Output with 6 bytes of IO-Link process data

119

54

Input with 4 bytes of IO-Link process data

120

168

Output with 4 bytes of IO-Link process data

121

38

Input with 2 bytes of IO-Link process data

122

152

Output with 2 bytes of IO-Link process data

123

22

Input with 1 byte of IO-Link process data

124

144

Output with 1 byte of IO-Link process data

125

14

Input with 0 bytes of IO-Link process data

126

8

Output with 0 bytes of IO-Link process data

127

6

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

The Ethernet/IP master offers a variety of configurations for IO-Link process data lengths, ranging from 0 to 32 bytes. The EDS file (Electronic Data Sheet) contains several predefined connections under the Connection Manager section. One of these connections is, for example, Connection2 with the name Exclusive Owner Connections – 32 IOL Data. A connection is a compilation of a configuration. Part of this is the definition of the data from the control unit to the device (O->T), the data from the device to the control unit (T->O) and the device configuration. These definitions can be found in the EDS file under the Assembly section. Assem101 (a consuming module with 32 bytes of IO-Link output process data) is used for Connection2 and the direction O->T. _Assem100 (a producing module with 32 bytes of IO-Link input process data) is used for the direction T->O and Assem102 is used for the configuration.

For example, if 10 bytes of IO-Link input and output data are required, the path 20 04 2C 73 2C 72 (hex)_can be used, where the assembly sizes are _T->O 216, O->T 86 and the configuration assembly is 0 or 58 bytes.

Configuration modules

The Ethernet/IP master contains two configuration assemblies for managing the IO-Link settings. These are Assem102 and Assem103, which each serve different purposes:

  • Assem102: The assignment of this module is described in detail in the EDS file and can be configured to a size of either 58 bytes or 0 bytes. If it is set to 0 bytes, the existing configuration is retained and is not overwritten.

  • Assem103: This module is set to a length of 0 bytes and was specially developed to automatically set all ports to IO-Link mode.

If the configuration module is not included in the connection path, the device operates as if module 103 is being used. This means that all ports are automatically set to IO-Link mode.

Configuration data

Assignment of configuration data sequence shows an assignment of the configuration data sequence. The stated standard values describe a configuration with the IO-Link function on Pin 4 and standard I/O functions on Pin 2 and 4 of every port. The input and output functions of the configured standard I/O ports are set using the process data.

Assignment of configuration data sequence

Byte

Module part

Description

0…1

Module

Configuration of the pin functions for ports X01 to X08 (pin 4 and pin 2 functions for each port)

2…8

IO-Link Port X01

Configuration of the IO-Link Port X01

9…15

IO-Link Port X02

Configuration of the IO-Link Port X02

16…22

IO-Link Port X03

Configuration of the IO-Link Port X03

23…29

IO-Link Port X04

Configuration of the IO-Link Port X04

30…36

IO-Link Port X05

Configuration of the IO-Link Port X05

37…43

IO-Link Port X06

Configuration of the IO-Link Port X06

44…50

IO-Link Port X07

Configuration of the IO-Link Port X07

51…57

IO-Link Port X08

Configuration of the IO-Link Port X08

Module configuration

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

Module configuration

Bit

Description

0

Port X01 Pin 4 function (0x00: Standard-I/O, 0x01: IO-Link)

1

Port X01 Pin 2 function (0x00: Standard-I/O, 0x01: IO-Link)

2

Port X02 Pin 4 function (0x00: Standard-I/O, 0x01: IO-Link)

3

Port X02 Pin 2 function (0x00: Standard-I/O, 0x01: IO-Link)

4

Port X03 Pin 4 function (0x00: Standard-I/O, 0x01: IO-Link)

5

Port X03 Pin 2 function (0x00: Standard-I/O, 0x01: IO-Link)

6

Port X04 Pin 4 function (0x00: Standard-I/O, 0x01: IO-Link)

7

Port X04 Pin 2 function (0x00: Standard-I/O, 0x01: IO-Link)

8

Port X05 Pin 4 function (0x00: Standard-I/O, 0x01: IO-Link)

9

Port X05 Pin 2 function (0x00: Standard-I/O, 0x01: IO-Link)

10

Port X06 Pin 4 function (0x00: Standard-I/O, 0x01: IO-Link)

11

Port X06 Pin 2 function (0x00: Standard-I/O, 0x01: IO-Link)

12

Port X07 Pin 4 function (0x00: Standard-I/O, 0x01: IO-Link)

13

Port X07 Pin 2 function (0x00: Standard-I/O, 0x01: IO-Link)

14

Port X08 Pin 4 function (0x00: Standard-I/O, 0x01: IO-Link)

15

Port X08 Pin 2 function (0x00: Standard-I/O, 0x01: IO-Link)

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

IO-Link Port configuration

Byte

Description

2

Port X01 Cycle time

3

Port X01 Validation type and parameter server

4, 5

Port X01 Vendor ID

6…8

Port X01 Device ID

Cycle settings

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

With this parameter, the IO-Link communication speed can be set. The IO-Link cycle time can be increased calculated by the multiplier and the time base.

The time base is described in time base table, the multiplier is entered as a decimal number from 0…63.

IO-Link Port configuration
Bit Description
7 6 5 4 3 2 1 0
Time base Multiplier Bit 0…5: Multiplier These bits contain a 6-bit multiplier for calculating the _MasterCycleTime_ or _MinCycle_ Time. Value range: 0…63.
Bit 6…7: Time Base These bits specify the time base for calculating the _MasterCycleTime_ or _MinCycleTime_.

Possible values for MasterCycleTime and MinCycleTime:

Possible values for MasterCycleTime and MinCycleTime

Time base coding

Time base value

Calculation

Cycle Time

00

0.1 ms

Multiplier x time base

0.41[1] …6.3 ms

01

0.4 ms [1]

6.4 ms + multiplier x time base

6.4…31.6 ms

10

1.6 ms

32 ms + multiplier x time base

32…132.8 ms

11

reserved

reserved

reserved

Validation settings

No validation : Validation deactivated, every device is accepted.

Compatibility : Manufacturer ID and Device ID are compared with the data of the IO-Link device.

Parameter server

Switched on : Data retention functions active, parameter data and identification data of the IO-Link device are saved in a remanent memory.

Switched off : Data retention functions deactivated, saved parameter data and identification data of the IO-Link devices remain in the memory.

Enable download : If only the download is enabled, in each case the master starts a download of the parameter data. In this case the download is also performed irrespective of the upload flag of the IO-Link device. If there are no data in the master port, an upload takes place first (e.g. after deletion of the data or before the first data upload). Upload and download enabled: If the upload and download are enabled, a distinction is made for different parameter records depending on the upload flag of the IO-Link device. If there are no data in the IO-Link master port, an initial upload takes place (e.g. after deletion of the data or before the first data upload). If the upload flag is set at the IO-Link device, the parameter data are uploaded in each case. If no upload flag is set and parameter data have already been stored, a download of the parameter data takes place in each case.

Note

After uploading the parameter data, the Vendor ID and Device ID of the connected IO-Link device remain stored until the data records are deleted.

When the connected IO-Link device is started a validation takes place and then only an IO-Link device of the same type can be used for the data retention.

If a different type of IO-Link device should be used, the content of the parameter server must be deleted.

The data storage is only supported by IO-Link devices with IO-Link Revision 1.1.

Values for validation type and parameter server

IO-Link Port configuration

Value

Description

0

No device check

1

Type-compatible device V1.0

2

Type-compatible device V1.1

3

Type-compatible device V1.1+ Backup + Restore

4

Type-compatible device V1.1, Restore

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

The upload flag is required in order to overwrite data already saved in the parameter server with new parameter data of the same IO-Link device.

In order to activate the upload flag of an IO-Link device, the data value 0x05 must be entered in the index 0x02, subindex 0.

(For information on setting parameters via IO-Link, see I/O ports or IO-Link device parameterization.

Configuration via Explicit Messages

PLC program

Note

Information about the PLC program and Add Application Logic , see Allen Bradley Ethernet/IP QuickConnect Application Technique.

Fault State

For each output at the port pins, a safe state can be predefined, which should be adopted in the case of a loss of bus communication.

The Fault State settings can be implemented via the following Class Instance Attribute of the Explicit Messages.

Activate / deactivate Fault State

Class

Instance

Attribute

Value

9 (0x09)

1 – m [2]

6

"0": Fault State disabled
"1": Fault State enabled

Fault State Action

Class

Instance

Attribute

Value

9 (0x09)

1 – m [2]

5

"0": Output on
"1": Hold last state

Note

The Fault State settings are only stored temporarily in the module. They are deleted again after a power reset.

In order to ensure a permanent Fault State configuration, the configuration must be programmed via the PLC so that it can be transferred to the module again when the system is restarted.

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

There are two ways to parameterize an IO-Link device connected to the IO-Link Port.

  • Parameterization via the web server (see I/O ports)

  • Parameterization via Explicit Messages

The following section describes, for example, how via Rockwell RSLogix 5000 an IO-Link device can be parameterized via Explicit Messages.

The MSG modules are used in the PLC program (see MSG modules).

../../_images/image32.png

MSG modules

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

Source Length must at least correspond to the read parameters, but can also be bigger (in this example 100 bytes).

  1. As a Source Element (Write) and as a Destination Element (Read), create a SINT[100] Array and select the first row [0].

    ../../_images/image33.png

    Create SINT[100] Arrays

  2. In the Source Element Array (Write) enter which index should be read (in this example Index 0x4E).

    ../../_images/image34.png

    Enter Source Element Array

    ⇒ The read value is displayed in the Destination Element Array (Read).
    ⇒ The error code is also displayed there in the event of a parameterization error.

  3. In the Communication window select the Ethernet module for which parameters should be set.

    ../../_images/image35.png

    Select Ethernet module

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

Values for write IO-Link parameters

Service code

Class

Instance

Attribute

0x32

0x96

1 - n [3]

0x02 (Write parameters)

  1. Select Source Element and Destination Element as described in the example Values for read IO-Link parameters.

    The Source Length must be the same length as the parameter data to be written. In this example the index 0x4E, subindex 0, value 0x02 are written in the _Source Element Array (Write).

    In the event of a parameterization error an error code is displayed in the Destination Element Array (Read).

    ../../_images/image36.png

    Configuration

  2. In the Communication tab select the Ethernet module for which parameters should be set.

    ../../_images/image351.png

    Select Ethernet module

Note

The Explicit Messages functions are implemented according to Volume 1: Common Industrial Protocol Specification and Volume 2: Ethernet/IP Adaption of CIP.

Process data

Process data inputs

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

The input data have a size of 392 bytes. The table below shows the assignment of the process data inputs.

Process data inputs

Byte

Module part

Description

0…7

Standard I/O ports

Process data inputs for the standard inputs

8…55

IO-Link Port 0

Process data inputs for the IO-Link Port 0

56…103

IO-Link Port 1

Process data inputs for the IO-Link Port 1

104…151

IO-Link Port 2

Process data inputs for the IO-Link Port 2

152…199

IO-Link Port 3

Process data inputs for the IO-Link Port 3

200…247

IO-Link Port 4

Process data inputs for the IO-Link Port 4

248…295

IO-Link Port 5

Process data inputs for the IO-Link Port 5

296…343

IO-Link Port 6

Process data inputs for the IO-Link Port 6

344…391

IO-Link Port 7

Process data inputs for the IO-Link Port 7

Standard input data

Byte Bit Description
7 6 5 4 3 2 1 0
0 I32 I34 I22 I24 I12 I14 I02 I04

Input data I04: Input for Port 0, Pin 4 The result is only 0 when the port is configured as an IO-Link Port.

1 I72 I74 I62 I64 I52 I54 I42 I44
2 S3 S2 S1 S0

Short circuit status Short circuit between Pin 1 and 3 at reported port

3 S7 S6 S5 S4
4 O32 O34 O22 O24 O12 O14 O02 O04

Overload status O04: Overload at Port 0, Pin 4 Only if the port is configured as an output. [4]

5 O72 O74 O62 O64 O52 O54 O42 O44
6 0 0 0 0 0 NA PS

PA [4]

Status of power supply NA: No actuator supply PS: Power supply of sensor PA: Power supply of actuator

7 0 0 0 0 0 0 0 0 reserved

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

Byte Bit Description
7 6 5 4 3 2 1 0
8…39 IO-Link Port 0 input data
40 0 0 0 0 0 0 DC IOL

IO-Link status IOL: Port in IO-Link mode DC: Device connected 0: reserved

41 SC 0 0 0 0 PDI DF VF

IO-Link error VF: Validation failed SC: IO-Link short-circuit DF: Data storage validation failed PDI: Process data invalid

42 Manufacturer code 1 Manufacturer code
43 Manufacturer code 2
44 Device code 1 Device code
45 Device code 2
46 Device code 3
47 Mode Type 0 Event 1 Mode: 0: reserved 1: Single event 2: Event outgoing 3: Event incoming Type: 0: reserved 1: Message 2: Warning 3: Error
48 Event code high
49 Event code low
50 Mode Type 0 Event 2
51 Event code high
52 Event code low
53 Mode Type 0 Event 3
54 Event code high
55 Event code low
The data of the other IO-Link Ports are structured identically and described below.

Process data outputs

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

The output data have a size of 262 bytes. The table below shows the assignment of the process data outputs.

Byte

Module part

Description

0…5

Standard I/O ports

Process data outputs for the standard inputs

6…37

IO-Link Port 0

Process data output for the IO-Link Port 0

38…69

IO-Link Port 1

Process data output for the IO-Link Port 1

70…101

IO-Link Port 2

Process data output for the IO-Link Port 2

102…133

IO-Link Port 3

Process data output for the IO-Link Port 3

134…165

IO-Link Port 4

Process data output for the IO-Link Port 4

166…197

IO-Link Port 5

Process data output for the IO-Link Port 5

198…229

IO-Link Port 6

Process data output for the IO-Link Port 6

230…261

IO-Link Port 7

Process data output for the IO-Link Port 7

Standard output data

Byte Bit Description
7 6 5 4 3 2 1 0
0 O32 O34 O22 O24 O12 O14 O02 O04 Output data O04: Output at Port 0, Pin 4 The port must be configured as an output in order to use this function at an IO-Link Port.1)
1 O72 O74 O62 O64 O52 O54 O42 O44
2 R32 R34 R22 R24 R12 R14 R02 R04 Restart Restart of output after identified short-circuit
3 R72 R74 R62 R64 R52 R54 R42 R44
4 0 0 0 0 0 0 0 0 reserved
5 0 0 0 0 0 DL GO RO Display control2) DL: Display locked / PLC lock GO: Green display LED lights up RO: Red display LED lights up
1) not available for BNI XG1-… 2) only valid for devices with display

Note

Please check whether IO-Link is supported by your module before using this function. For more information on product variants that support IO-Link, see Supported product variants

Byte Bit Description
7 6 5 4 3 2 1 0
6…37 IO-Link Port 0 output data
The data of the other IO-Link Ports are structured identically and described below.

Quick Connect mode

The following points must be observed in Quick Connect operating mode:

  • Ethernet port settings

    • Ethernet port 1: The connection must be set to a fixed speed of 100 Mbit/s in full duplex mode.

    • Ethernet port 2: The connection must be set to a fixed speed of 100 Mbit/s in full duplex mode.

  • Device configuration: Quick Connect mode must be activated.

Auto-MDIX is not available in Quick Connect mode. Therefore, the automatic configuration of the ports at fixed speed and activated Quick Connect is as follows:

  • Port 1: MDI

  • Port 2: MDIX

This configuration is crucial, as port 2 can be connected to port 1 of another device with a non-crossover cable, but not to port 2. If the connection is incorrect, no Ethernet connection (link) can be established.

For more information, see Ethernet/IP Specification Volume 2: EtherNet/IP Adaption of CIP, Appendix E: EtherNet/IP Quick Connect™.