KUKA Ethernet/IP 2.0: Controller Option
KUKA Ethernet/IP 2.0: Controller Option
KUKA Ethernet/IP 2.0: Controller Option
For KR C2 edition2005
Issued: 03.04.2009
© Copyright 2009
KUKA Roboter GmbH
Zugspitzstraße 140
D-86165 Augsburg
Germany
This documentation or excerpts therefrom may not be reproduced or disclosed to third parties without
the express permission of the KUKA Roboter GmbH.
Other functions not described in this documentation may be operable in the controller. The user has
no claims to these functions, however, in the case of a replacement or service work.
We have checked the content of this documentation for conformity with the hardware and software
described. Nevertheless, discrepancies cannot be precluded, for which reason we are not able to
guarantee total conformity. The information in this documentation is checked on a regular basis, how-
ever, and necessary corrections will be incorporated in the subsequent edition.
Subject to technical alterations without an effect on the function.
Translation of the original operating instructions
KIM-PS5-DOC
Contents
1 Introduction .................................................................................................. 5
1.1 Target group .............................................................................................................. 5
1.2 Robot system documentation .................................................................................... 5
1.3 Trademarks ................................................................................................................ 5
1.4 Terms used ................................................................................................................ 5
3 Safety ............................................................................................................ 9
3.1 Representation of warnings and notes ...................................................................... 9
4 Installation ................................................................................................... 11
4.1 System requirements ................................................................................................. 11
4.2 Installing the KUKA Ethernet/IP drivers ..................................................................... 11
4.3 Uninstalling the KUKA Ethernet/IP drivers ................................................................. 11
4.4 Installing the KUKA Ethernet/IP configuration software ............................................. 12
4.5 Uninstalling the KUKA Ethernet/IP configuration program ......................................... 12
5 Configuration ............................................................................................... 13
5.1 Ethernet/IP network configuration .............................................................................. 13
5.2 Notes on use of the Ethernet/IP configuration software ............................................. 13
5.3 Starting the configuration software ............................................................................ 14
5.3.1 Adapting the configuration settings ....................................................................... 16
5.4 Assigning devices ...................................................................................................... 19
5.4.1 General tab ........................................................................................................... 20
5.4.2 General tab – Network Properties ........................................................................ 21
5.4.3 Chassis tab ........................................................................................................... 22
5.4.4 Connections tab .................................................................................................... 23
5.4.5 Changing the connection type .............................................................................. 24
5.4.6 Changing the connection properties ..................................................................... 25
5.4.7 Checking the device identity ................................................................................. 26
5.4.8 Online Parameters tab .......................................................................................... 26
5.4.9 Module Informations tab ....................................................................................... 27
5.4.10 Port Configuration tab ........................................................................................... 28
5.4.11 EDS File tab .......................................................................................................... 29
5.4.12 Defining the input/output assignment ................................................................... 30
5.5 Transferring the configuration to the robot controller ................................................. 31
5.6 Configuring the robot controller .................................................................................. 32
5.6.1 IOSYS.INI configuration ........................................................................................ 32
5.6.2 IOCTL commands ................................................................................................. 35
5.6.3 Configuring the file ENIP.INI ................................................................................. 36
6 Troubleshooting .......................................................................................... 39
6.1 ApplicomIO status ...................................................................................................... 39
7 Repair ........................................................................................................... 41
7.1 Installing the KUKA Ethernet/IP board ....................................................................... 41
Index ............................................................................................................. 49
1 Introduction
This documentation is aimed at users with the following knowledge and skills:
Expert system knowledge of the robot controller system
Expert knowledge of the Windows operating system
Advanced knowledge of network technology
Für den optimalen Einsatz unserer Produkte empfehlen wir unseren Kunden
eine Schulung im KUKA College. Informationen zum Schulungsprogramm
sind unter www.kuka.com oder direkt bei den Niederlassungen zu finden.
1.3 Trademarks
Term Description
KUKA.HMI The Human-Machine Interface (HMI) is an interface which
allows a human to communicate with a machine.
TCP/IP The Transmission Control Protocol (TCP) is a protocol for
data exchange between the devices in a network.
TCP constitutes a virtual channel between 2 sockets in a
network connection. Data can be transmitted along this
channel in both directions.
The Internet Protocol (IP) has the task of transporting data
packets via a number of networks from a transmitter to a
receiver.
RPI The Requested Package Interval (RPI) is the time interval
between 2 telegrams.
Subnet Exact specification of part of the IP address space.
2 Product description
Description
Item Description
1 Jumper for setting the board number:
Value: 1 ... 8
Default setting: 1
2 Jumper for the PCI bus identifier:
Default setting: 1
3,4 LEDs for visualizing the data transfer
5 RJ45 port
3 Safety
Safety Warnings marked with this pictogram are relevant to safety and must be ob-
served.
Danger!
This warning means that death, severe physical injury or substantial material
damage will occur, if no precautions are taken.
Warning!
This warning means that death, severe physical injury or substantial material
damage may occur, if no precautions are taken.
Caution!
This warning means that minor physical injuries or minor material damage
may occur, if no precautions are taken.
Notes Notes marked with this pictogram contain tips to make your work easier or ref-
erences to further information.
4 Installation
Laptop/PC Hardware
CD-ROM drive
Software
Windows XP with SP1
Procedure 1. Select the menu sequence Setup > Install Additional Software.
2. Press the New SW softkey. If Ethernet/IP is not yet displayed, press the
Refresh softkey.
3. Select Ethernet/IP and press the Install softkey. Answer the request for
confirmation with Yes. The files are copied onto the hard drive.
4. Reboot the robot controller. The installation is resumed and completed.
Ethernet/IP update:
In the case of an Ethernet/IP update, the configuration settings may be de-
leted. A new configuration must be created.
(>>> 5.3 "Starting the configuration software" page 14)
Procedure 1. Select the menu sequence Setup > Install Additional Software. All in-
stalled additional programs are displayed.
2. Select Ethernet/IP and press the De-install softkey. Answer the request
for confirmation with Yes.
“De-installation prepared” is displayed in the State column.
3. If required, repeat step 2 to uninstall further software.
4. Reboot the robot controller. Uninstallation is resumed and completed.
If the Ethernet/IP configuration program has already been used on the same
computer and if malfunctions occur after reinstallation, then it must be
checked that only one Ethernet/IP driver is activated.
5 Configuration
Item Description
1 Configuration link
2 Diagnostic link
For technical reasons, do not use a hub for the network connection.
The robot controller and the configuration PC must be located in the
same subnet.
The Ethernet/IP board and the bus devices must be located in the same
subnet.
On activating Expert mode via the menu sequence File > Preferences >
Expert Mode, additional configuration options are shown. These options
are indicated with an icon.
In the configuration windows, the button opens a selection box with the
options Properties and Edit. Both options allow changes to be made in
the configuration.
The Properties option is described in this documentation (>>> Fig. 5-2).
Additional information about the configuration parameters that are not de-
scribed in this documentation is given in the Description info boxes of the
individual configuration windows. (>>> Fig. 5-2).
The configuration data created for Ethernet/IP are not saved on the card after
the robot controller is switched off. When the robot controller is rebooted,
these configuration data are reloaded onto the Ethernet/IP card.
Procedure 1. Start the Console icon on the desktop. Alternatively, select the menu se-
quence Programs > KUKA > Ethernet_IP > 2.3 >Console.
The program applicomIO console opens. If configurations have already
been created using this program, the last used configuration is loaded.
If the program is started for the first time, the following window is displayed:
Item Description
1 Configuration list box:
Static: Manual setting
Default setting for the IP address: 192.168.0.1
DHCP
Settings are automatically obtained from the memory of the
DHCP server.
BOOTP
Settings are automatically obtained from the memory of the
BOOTP server.
2 Properties button
3 Work area
4 Description info box
3. Click on the button and assign an IP address for the Ethernet/IP board.
The Ethernet/IP board must be located in the same subnet as the bus devic-
es which are to be added later.
Parameter Description
Number of Number of times that the ApplicomIO® board
retries attempts to send an unacknowledged data packet.
1 ... 12
Default setting: 2
Interval Time interval between attempts at transmitting a
between retries data packet. The time interval is increased after
every attempt by the factor “Number of retries”.
1 ... 5 s
Default setting: 1
Connection Activates the TCP/IP function Keep Alive in order to
servicing perform a cyclical check of the TCP connection to
the device.
DHCP, DNS Time interval between DHCP polls.
Time-Out (>>> 5.6.3 "Configuring the file ENIP.INI" page 36)
Maximum number of polls: 5
Value: 1 ... 30 s
Default setting: 3
Item Description
1 Name of the configuration.
2 Description of the configuration.
3 Checkbox activated:
The configuration can be downloaded to the robot controller.
4 IP address of the robot controller.
5 FTP user name of the robot controller.
Default setting: target
6 Password for the robot controller.
Default setting: vxworks
Item Description
7 Checkbox activated:
Direct access to the Ethernet/IP board in the robot controller is
possible, including the following functions:
Diagnostics
Online access to Ethernet/IP devices, e.g. for configuration
Network detection
8 Select EtherNet/IP Board button for direct access.
The connection to Ethernet/IP can be updated in the status
box of the Configured boards state.
(>>> 5.4 "Assigning devices" page 19)
Item Description
1 Local Network Adapters group: Selection of a local network
adapter which can be used to establish a connection to the
Ethernet/IP board.
Board Name: Name of the network adapter
2 Automatic/Manual tabs:
Automatic: Automatic detection of the available network
adapter(s) by clicking on the Detect button
Manual: Manual selection an available network adapter
3 Configured Board group:
Serial Number: Input box for the serial number of the net-
work adapter
Connection Test button: Start the connection test
Procedure 1. Drag the relevant devices from the Equipment Library into the work area
using Drag&Drop.
Item Description
1 Equipment Library
2 Configuration work area
3 Configured boards state:
The connection to the Ethernet/IP card can be updated by
right-clicking on the state of the board.
Item Description
1 Tabs
Item Description
1 Name of the device
2 Number of the device
Value: 0 to 127
3 Link Parameters checkbox
Checkbox activated:
The device number is linked to the device IP address.
The device name is linked to the host name.
Check box not activated:
The device number is separated from the device IP address.
The device name is separated from the host name.
4 Set the network properties (>>> 5.4.2 "General tab – Network
Properties" page 21)
5 Blank text box for additional description
Max. 80 characters
6 Active Configuration checkbox
Checkbox activated:
Configuration of the device is activated.
Check box not activated:
Configuration of the device is not activated, but remains saved
in the applicomIO® console.
Procedure 1. In the Network Properties selection box, select the line Address Type.
The IP address and host name can only be changed if the Link Parameters
checkbox is deactivated. (>>> 5.4.1 "General tab" page 20)
Item Description
1 Address Type
2 Address Type:
IP (default)
Host name
3 Properties
Item Description
1 Chassis selection in the Equipment Library
2 Available Modules work area
3 Configured Modules work area
2. Click on the button to check the settings and modify them if necessary.
3. Confirm with OK.
Item Description
1 Name of device or module
2 Connection type
3 Connection properties
4 Device identity check
5 Configuration settings
6 Add button (disabled)
Is enabled when a setting is removed
7 Remove button (disabled)
Is enabled when a setting is selected
Procedure 1. Select the connection type element in the Configured Connection box.
(>>> Fig. 5-12)
2. Remove the connection type using the Remove button.
3. Add a connection type using the Add button.
4. Select the connection type from the list box. (>>> Fig. 5-13)
5. Confirm with OK.
The connection type Rack Optimization can only be used with digital devic-
es.
All offset values of the modules are listed in the 1st module. Errors in subor-
dinate modules cannot be detected by the firmware.
Procedure 1. Select the element General in the Configured Connection box and dis-
play the assigned values.
2. Select the required assignment.
Parameter Description
Request Packet Default setting for the refresh rate: 10 ms
Interval (RPI)
Input Size EDS standard setting
Input Mode Input Mode defines the type of data transmission:
Point to Point: Transmission from adapter to scan-
ner
Multicast: Transmission from adapter to a multicast
IP address
Null: No transmission
Input Type The setting Fixed is predefined and cannot be
changed.
Priority Connection priority
Trigger Type In connection with the RPI, the following trigger types
can be set for data transmission:
Cyclic: Cyclic data transmission depending on the
RPI
Change of State: Data transmission on status
change
Application: Data polling by adapter
Output Size EDS standard setting
Output Mode Output Mode defines the type of data transmission:
Point to Point: Transmission from scanner to
adapter
Multicast: Transmission from scanner to a multi-
cast IP address
Null: No transmission
Parameter Description
Output Type The setting Fixed is predefined and cannot be
changed.
Priority Connection priority
Procedure 1. Select the Check Module Identity element in the Configured Connec-
tion box.
2. The assigned value is displayed in the Connections Parameters box.
Default setting: Disable
3. Mark the element.
4. Click on the Properties button to check the settings and modify them if
necessary.
5. Confirm with OK.
Parameter Description
Must Match Exactly Exact identity check
Disable No identity check (default setting)
Must Be Compatible The device adapts its identity parameters to the
EDS.
Custom User-defined identity
None No identity check
Item Description
1 Work area
2 Synchronize button
3 Get Values from EDS button
4. Click on the button to check the settings and modify them if necessary.
5. Confirm with OK.
Item Description
1 Work area
2 Get Informations button
3 Object group
4 Reset Equipment button
Item Description
1 Work area
2 Get Values from Equipment button
3 Set Part of Values group
4 Set Values to Equipment button
5 Set All Values to Equipment button
Description With the View or Print EDS File button, information about the EDS file and
the bus devices can be displayed in an editor.
Item Description
1 View or Print EDS File button
Description The offset values in the input/output display are required for the configuration
of IOSYS.INI.
Procedure 1. In the Configuration work area (>>> Fig. 5-7), select the device and open
the tree structure.
3. In the input/output display, read the offset values from the “Offset/equip.”
column and transfer them manually to IOSYS.INI on the robot controller.
(>>> 5.6.1 "IOSYS.INI configuration" page 32)
The function of the input/output display depends on the module type. If there
is no entry, read the offset values from the Online Parameters tab, or con-
tact the manufacturer.
With the setting Rack Optimization, all offset values are listed in the 1st
module.
Take care not to mix up the offset values in the input/output display, and en-
sure that the values are correctly transferred.
Procedure 1. Select the menu sequence Configure > I/O Driver > Edit I/O Config..
The file IOSYS.INI is opened.
2. Check or modify the settings.
3. Save changes.
4. Select the menu sequence Configure > I/O Driver > Reconfigure I/O
Driver to apply the changes.
Example of 1 [CONFIG]
IOSYS.INI 2 VERSION=2.00
3 [DRIVERS]
4 EthernetIP=23,eipInit,eipdrv.0
5 [EthernetIP]
6 INB0=3,4,x8
7 OUTB0=3,10,x8
8 ANIN1=6,24,14,1,CAL16384
9 ANOUT1=6,17,14,1
Line Description
1 [CONFIG] section
2 Indication of the version number
3 [DRIVERS] section
4 Activation of the Ethernet/IP bus driver
5 [EthernetIP] section
6 Configuration of a digital input:
Input 0 is assigned to device 3 with offset 4.
Multiplier 8.
7 Configuration of a digital output:
Output 0 is assigned to device 3 with offset 10.
Multiplier 8.
Line Description
8 Configuration of an analog input:
Input 1 is assigned to device 6 with offset 24.
Data width 14 bits; type 1; calibration value 16384.
9 Configuration of an analog output:
Output 1 is assigned to device 6 with offset 17.
Data width 14 bits; type 1.
The name of the section EthernetIP must be identical to the name of the bus
driver.
IN INGranularityNumber=Device ,Offset,Multiplier
Element Description
Granularity Data type: CHAR
Byte, word, double word
B, W, DW
Number Data type: INT
Number of the digital input
0 ... 1023
Device Data type: INT
Address of the device
0 ... 127
Offset Data type: INT
Offset on the device address
(>>> 5.4.12 "Defining the input/output assignment"
page 30)
Multiplier x: Multiplier for byte length of the data object
(x4 = 1 data object with byte length 4)
xx: multiplier for data object with byte length 1
(xx4 = 4 data objects with byte length 1)
Element Description
Granularity Data type: CHAR
Byte, word, double word
B, W, DW
Number Data type: INT
Number of the digital output
0 ... 1023
Device Data type: INT
Address of the device
0 ... 127
Element Description
Offset Data type: INT
Offset on the device address
(>>> 5.4.12 "Defining the input/output assignment"
page 30)
Multiplier x: Multiplier for byte length of the data object
(x4 = 1 data object with byte length 4)
xx: multiplier for data object with byte length 1
(xx4 = 4 data objects with byte length 1)
Element Description
Number Data type: INT
Number of the analog input
0 ... 1023
Device Data type: INT
Address of the device
0 ... 127
Offset Data type: INT
Offset on the device address
(>>> 5.4.12 "Defining the input/output assignment"
page 30)
Data width Data type: INT
1 ... 32 bits
Type Data type: INT
0...3
Specifies the alignment and sign of the data set
0: Right-justified without sign
1: Right-justified with sign
2: Left-justified without sign
3: Left-justified with sign
Calibration value Data type: INT
0 ... 65536
With analog inputs/outputs, the value is specified as a
decimal number without prefix.
0 or no specified value sets the calibration to the maxi-
mum value
Element Description
Number Data type: INT
Analog output number
0 ... 1023
Device Data type: INT
Address of the device
0 ... 127
Offset Data type: INT
Offset on the device address
(>>> 5.4.12 "Defining the input/output assignment"
page 30)
Data width Data type: INT
1 ... 32 bits
Type Data type: INT
0...3
Specifies the alignment and sign of the data set
0: Right-justified without sign
1: Right-justified with sign
2: Left-justified without sign
3: Left-justified with sign
Calibration value Data type: INT
0 ... 65536
With analog inputs/outputs, the value is specified as a
decimal number without prefix.
0 or no specified value sets the calibration to the maxi-
mum value
Parameter Description
Return value Depends on the function (REQUEST number) called.
Driver ID Can be found in the [DRIVERS] section of the IOSYS.INI
file.
IOCTL
Function Description
code
CP_EIP_UPDATE_CONFIG 1030 Loads the configuration from the current
directory of the file system into the mem-
ory of the Ethernet/IP board. The scanner
is rebooted. Any configuration already
loaded before the download is stopped.
CP_EIP_UPDATE_FIRMWARE 1031 Loads the firmware and configuration
from the current directory of the file sys-
tem into the memory of the Ethernet/IP
board. The scanner is rebooted. Any con-
figuration already loaded before the
download is stopped.
CP_EIP_RESET 1032 Resets the memory. The firmware and
configuration files are deleted from the
memory.
CP_EIP_DUMP 1033 The file name and version are read from
the memory of the Ethernet/IP board and
output to the Telnet shell.
Precondition: The TELNETOUTPUT
value in the INI file must be set to 1.
CP_EIP_DUMP_FILE 1034 The file name and version are read from
the memory of the Ethernet/IP board and
output to the file WSE_DumpFlashfile.txt.
CP_EIP_REBOOT_SLOW 1035 Reboots the firmware and configuration
from the flash memory. The scanner is
rebooted.
CP_EIP_REBOOT_QUICK 1036 Resets the firmware without rebooting.
This function is intended for servicing pur-
poses only.
CP_EIP_CHECK_CONFIGURATION 1037 Comparison of the configuration version
in the flash memory and the configuration
in the current directory of the file system.
Return value 0: Versions are identical.
Return value 1: Versions are not iden-
tical.
Return value < 0: Error when reading
the versions.
CP_EIP_DUMP_DPM_FILE 1038 Output the DPM in the file
WSE_DumpDpmFile.txt.
Description The file ENIP.INI is the configuration file of the CALL-P driver enip.o.
The menu item Reset restarts the bus. Changes are not applied.
Example of 1 [General]
ENIP.INI 2 DEBUG=0x0001
3 TELNETOUTPUT=0
4 LOGFILESIZE=500000
5 DHCPTIMEOUT=15
6 DEVICEWAITTIME=0
Line Description
1 Default setting
2 DEBUG option (bit-coded) for the log file
0x0001 = Standard logging
0x0002 = Debug outputs
0x0004 = Logging of device errors by status poll
0x0008 = Logging of errors on read/write functions
3 TELNETOUTPUT
0 = no Telnet output
1 = Telnet output
4 LOGFILESIZE
Definition of the log file size
500 KB ... 10 MB
5 DHCPTIMEOUT
Time waited by the driver until the Ethernet/IP board is
assigned an IP address by the DHCP server.
3 ... 180 s
(>>> Fig. 5-3)Parameters: DHCP, DNS Time-Out
6 DEVICEWAITTIME
Time waited by the driver until all devices are active. This
avoids unnecessary error messages during booting.
0 ... 30 s
6 Troubleshooting
Description The status values are displayed via driver messages on the user interface.
7 Repair
Procedure 1. Select the menu sequence Configure > On/Off Options > Start Types.
The option window Start Types is opened.
2. In the group Start Types in the option window, activate the checkbox Cold
Boot.
3. Press the OK softkey.
4. Switch the robot controller off.
5. Open the control PC.
6. Remove the cover from PCI slot 1.
7. Plug the KUKA Ethernet/IP board into PCI slot 1.
Caution!
Substantial damage to property may occur:
The Ethernet/IP board must only be plugged into PCI slot 1.
The Ethernet/IP board must be firmly and uniformly engaged with the
socket of the slot.
Precondition The robot controller is switched off and secured to prevent unauthorized
persons from switching it on again.
Observe the ESD guidelines.
8 KUKA Service
Introduction The KUKA Roboter GmbH documentation offers information on operation and
provides assistance with troubleshooting. For further assistance, please con-
tact your local KUKA subsidiary.
Availability KUKA Customer Support is available in many countries. Please do not hesi-
tate to contact us if you have any questions.
Argentina Ruben Costantini S.A. (Agency)
Luis Angel Huergo 13 20
Parque Industrial
2400 San Francisco (CBA)
Argentina
Tel. +54 3564 421033
Fax +54 3564 428877
[email protected]
Index
A Module Informations tab 27
ANIN 34
ANOUT 34 N
ApplicomIO status 39 Network configuration 13
Notes 13
C
Chassis tab 22 O
Configuration 13 Online Parameters 27
Configuration settings, adaptation 16 Online Parameters tab 26, 27
Configuration software, starting 14 OUT 33
Configuration work area 31
Configuration, IOSYS.INI 32 P
Configuration, robot controller 32 Port Configuration tab 28
Configuration, transferring to robot controller 31 Product description 7
Connection properties, changing 25 Properties, network adapters 18
Connection type, changing 24
Connections tab 23 S
Safety 9
D Safety instructions 9
Device identity, checking 26 Schulungen 5
Devices, assigning 19 Service, KUKA Roboter 43
Documentation, robot system 5 Support request 43
System requirements 11
E
EDS File tab 29 T
ENIP.INI, configuration 36 Target group 5
Ethernet/IP board, installation 41 Terms used 5
Ethernet/IP board, removal 41 Trademarks 5
Ethernet/IP configuration program, uninstallation Troubleshooting 39
12
Ethernet/IP configuration software, installation U
12 Uninstallation, Ethernet/IP configuration pro-
Ethernet/IP drivers, installation 11 gram 12
Ethernet/IP drivers, uninstallation 11 Uninstallation, Ethernet/IP drivers 11
Ethernet/IP network configuration 13
W
G Warnings 9
General tab 20
General tab – Network Properties 21
I
IN 33
Input/output assignment 30
Input/output display 31
Installation 11
Installation, Ethernet/IP configuration software
12
Installation, Ethernet/IP drivers 11
Introduction 5
IOCTL commands 35
K
KUKA Customer Support 43
KUKA EtherNet/IP 2.0 7
KUKA Ethernet/IP board (PCU-ETHIO) 7
M
Module Informations 27