Kunbus PR100023R03 User manual

User Manual
IC Module for EtherNet/IPTM
100061R00_UM_EN • 03/11/2017

Table of Contents KUNBUS GmbH
ii IC-Module for EtherNet/IP
Table of Contents
1 General information ........................................................................................................................4
1.1 Disclaimer..................................................................................................................................4
1.2 Notes regarding this user manual..............................................................................................5
1.3 Validity .......................................................................................................................................5
1.4 Limitation of Liability ..................................................................................................................5
1.5 Customer Service ......................................................................................................................6
2 Safety Guidelines ............................................................................................................................7
2.1 User ...........................................................................................................................................7
2.2 Symbols.....................................................................................................................................7
2.3 General Safety Guidelines.........................................................................................................8
2.4 Environmental Conditions..........................................................................................................8
3 Overview ..........................................................................................................................................9
3.1 Introduction................................................................................................................................9
3.2 Application Interface ................................................................................................................10
3.3 Status LEDs.............................................................................................................................11
4 Components ..................................................................................................................................13
4.1 Module Components ...............................................................................................................13
4.2 Storage Unit.............................................................................................................................13
4.3 Data Broker .............................................................................................................................14
4.4 Fieldbus Interface ....................................................................................................................24
4.5 CDI - Configuration and Debug Interface ................................................................................25
4.6 SDI - Serial Data Interface.......................................................................................................26
4.7 SPI - Synchronous serial interface ..........................................................................................28
4.8 Scripter ....................................................................................................................................42
5 Commissioning .............................................................................................................................43
5.1 Installation ...............................................................................................................................43
5.2 Configuration ...........................................................................................................................49
5.3 Firmware Update .....................................................................................................................50
6 Functions for EtherNet/IP.............................................................................................................51
6.1 Connection Types....................................................................................................................51
6.2 Objects ....................................................................................................................................51
6.3 Functions .................................................................................................................................52
7 Memory Register ...........................................................................................................................53
7.1 Overview of the Memory Register ...........................................................................................53
7.2 General Device Parameters ....................................................................................................57
7.3 Register for the Mapping .........................................................................................................80
7.4 Memory of the Communication Channels ...............................................................................82
7.5 Fieldbus specific Registers......................................................................................................84

KUNBUS GmbH Table of Contents
IC-Module for EtherNet/IP iii
8 CDI .................................................................................................................................................95
8.1 Setting up a Serial Connection ................................................................................................95
8.2 CDI Menus...............................................................................................................................97
9 Integrated Server.........................................................................................................................131
9.1 FTP Server ............................................................................................................................131
9.2 Web Server............................................................................................................................131
10 Disposal .......................................................................................................................................134
10.1Dismantling and Disposal ......................................................................................................134
11 Technical data .............................................................................................................................135
11.1Technical data .......................................................................................................................135
12 Appendix......................................................................................................................................136
12.1Configuration via Modpoll ......................................................................................................136

IC-Module for EtherNet/IP 4 / 137
1 General information
1.1 Disclaimer
© 2016 KUNBUS GmbH, Denkendorf (Deutschland)
The contents of this user manual have been prepared by the
KUNBUS GmbH with the utmost care. Due to the technical
development, the KUNBUS GmbH reserves the right to change or
replace the contents of this user manual without prior notice. You can
always obtain the latest version of the user manual at our homepage:
www.kunbus.de
The KUNBUS GmbH shall be liable exclusively to the extent
specified in General Terms and Conditions (www.kunbus.de/
agb.html).
The contents published in this user manual are protected by
copyright. Any reproduction or use for the in-house requirements of
the user is permitted. Reproduction or use for other purposes are not
permitted without the express, written consent of the KUNBUS
GmbH. Contraventions shall result in compensation for damages.
Trademark protection
– KUNBUS is a registered trademark of the KUNBUS GmbH
– Windows® and Microsoft® are registered trademarks of the Microsoft,
Corp.
– Modbus is a registered trademark of the Modbus-IDA Organization.
KUNBUS GmbH
Heerweg 15 C
73770 Denkendorf
Germany
www.kunbus.de
General information

IC-Module for EtherNet/IP 5 / 137
1.2 Notes regarding this user manual
This user manual provides important, technical information that can
enable you, as a user, efficient, safe and convenient integration of
the KUNBUS-IC into your applications and systems. It is intended for
trained, qualified personnel, whose sound knowledge in the field of
electronic circuits and expertise of EtherNet/IPTM is assumed.
As an integral part of the module, the information provided here
should be kept and made available to the user.
1.3 Validity
This document describes the application of the KUNBUS IC-
Modules with the product number:
–PR100023R03, LP0016R02,
1 port, with transmitter, STM32F207IG, 5V
– PR100086R04, LP0016R03,
1 port, with transmitter, STM32F207VE, 3.3V
same SW as PR100085R00
–PR100085R00, LP0016R03,
1 port, with transmitter, STM32F207VE, 5V
same SW as PR100086R00
–PR100061R00, LP0025R02,
2 ports, with transmitter, STM32F427IG, 3.3V
same SW as PR100081R00
–PR100081R00, LP0105R00, 2 ports,
without transmitter, STM32F427IG, 3.3V
same SW as PR100061R00
1.4 Limitation of Liability
Warranty and liability claims will lapse if:
– the product has been used incorrectly,
– damage is due to non-observance of the operating manual,
– damage is caused by inadequately qualified personnel,
– damage is caused by technical modification to the product (e.g.
soldering).
General information

IC-Module for EtherNet/IP 6 / 137
1.5 Customer Service
If you have any questions or suggestions concerning this product,
please do not hesitate to contact us:
KUNBUS GmbH
Heerweg 15 C
73770 Denkendorf
Germany
[phone]
[email protected]
www.kunbus.com
General information

IC-Module for EtherNet/IP 7 / 137
2 Safety Guidelines
2.1 User
The Module may only be assembled, installed and put into operation
by trained, qualified personnel. Before assembly, it is absolutely
essential that this documentation has been read carefully and
understood. Expertise in the following fields is assumed:
– Electronic circuits,
– Basic knowledge of EtherNet/IP,
– work in electrostatic protected areas,
– Locally applicable rules and regulations for occupational safety.
2.2 Symbols
The symbols used have the following meaning:
DANGER Hazard
Observe this information without fail!
There is a safety hazard that can lead to serious injuries and death.
CAUTION Caution
There is a safety hazard that can result in minor injuries and material
damage.
NOTICE Note
Here you will find important information without a safety hazard.
Safety Guidelines

IC-Module for EtherNet/IP 8 / 137
2.3 General Safety Guidelines
DANGER Danger of electric shock
If unsuitable power supply is used, this can cause an electric shock.
ØThis can cause death, serious injuries and material damage to your
systems and modules.
èOnly use a power supply that complies with the regulations for safety
extra-low voltage (SELV) or protective extra-low voltage (PELV).
CAUTION Fault due to mechanical load
A continuous mechanical load of over 5G or shock loads of over 15G can
cause faults on your modules.
èComply with these load limits and avoid any unnecessary loads.
CAUTION Damage due to subsequent processing
Avoid subsequent processing of the KUNBUS-IC.
ØSoldering can cause components to become detached and thus
damage or destroy the module.
ØPlease note that the warranty shall become invalid if the products are
changed technically.
èSpeak to your contact person at the KUNBUS GmbH about customised
solutions.
2.4 Environmental Conditions
Operate the KUNBUS-IC only in an environment that complies with
the operating conditions in order to prevent any damage.
Suitable Environmental Conditions:
Operating temperature 0 °C to +60 °C
Humidity 0% not 95%, non-condensing
Safety Guidelines

IC-Module for EtherNet/IP 9 / 137
3 Overview
3.1 Introduction
With the KUNBUS-IC you can make a sensor or actuator fieldbus-
capable. To do this, simply insert the module into your application
and connect it to the fieldbus.
Illustration1: Module components
The KUNBUS-IC serves as a bridge between your application and
the fieldbus. On the application side there are 3 possibilities to
transfer the data to the module:
1. SSC - Serial Shift Chain
Very simple shift register modules are connected to the SPI interface of
the module. The KUNBUS-IC is the SPI master and reads or writes up
to 32 bytes of data from the blocks cyclically into its internal memory.
This is realized on our evaluation board with 2 input modules with DIP
switches and 4 output modules with LEDs.
¬
2. SPI - Serial Peripheral Interface
The KUNBUS-IC acts as an SPI slave. The SPI master can write or
read any data into the KUNBUS-IC However, in addition to the standard
SPI, a ready line must also be considered. This makes it somewhat
more difficult to connect the KUNBUS-IC to a master.
The max. Data rate is 20MBit/s.
¬
3. SDI - Serial Data Interface
Modbus RTU commands can be sent to the KUNBUS-IC via a UART
interface. Here, too, the master can read or write any data from the
KUNBUS-IC. Only two Modbus commands have to be implemented in
the master. This is the easiest way to implement the interface.
The maximum data rate is 115kBaud.
¬
Overview

IC-Module for EtherNet/IP 10 / 137
Connection via SSC can be implemented with minimal effort, but this
variant is also the least powerful.
The variants SPI and SDI are very flexible, as the KUNBUS-IC can
also be configured by the application processor. SDI is easier to
implement but also slower than SPI.
3.2 Application Interface
The main board is connected to the device controller via a 32-pin
connector strip. Thus, you have the option to plug the module directly
into your DIL socket.
NOTICE If the module is plugged in and unplugged frequently, mechanical
stresses may damage the module.
Use a zero insertion force socket to prevent damage.
You can find detailed information on this topic in section"Installation
[}43]".
Overview

IC-Module for EtherNet/IP 11 / 137
3.3 Status LEDs
You have the option to integrate additional LEDs into your
application. These LEDs can be activated using the shift register.
üTo do this, configure the first output shift register
◦ In register 0x0025 or
◦ in CDI menu "2.3 SSC Communication"
The signals have the following meaning:
LED Assignment Signal Meaning
0
green
EtherNet/IP
module
status
off Module is not connected to the power
supply.
on Operating Mode.
flashes Standby Mode.
flashes to-
gether with
LED 1
Self-test.
1
red
EtherNet/IP
module
status
on A serious error has occurred.
flashes to-
gether with
LED 0
Self-test.
2
green
EtherNet/IP
network
status
off Module is not connected to the power
supply or has no IP address.
flashes No connection established.
on Connection established.
flashes to-
gether with
LED 1
Self-test.
3
red
EtherNet/IP
network
status
on The IP address is already occupied.
flashes Timeout (connection).
flashes to-
gether with
LED 0
Self-test.
4
green
Operating
Mode
off Module is not in operation.
flashes At least one part of the system has not
yet finished the initialisation.
on All system components function
faultlessly.
Overview

IC-Module for EtherNet/IP 12 / 137
LED Assignment Signal Meaning
5
red
Module error off No Error.
flashes At least one system component does not
function due to a configuration error.
on A fatal error has occurred. Please contact
our support.
6
green
Script pro-
gress
flashes Script deactivated or not loaded.
on Script is running.
7
red
Script error off No Error.
on Error in Script.
Connect the associated LED outputs with a 2-colour LED
respectively.
Overview

IC-Module for EtherNet_IP 13 / 137
4 Components
4.1 Module Components
The module is divided into independent components to ensure a high
level of flexibility in the application.
The following pages describe the individual components:
4.2 Storage Unit
The storage unit is the central component for all functions of the IC-
Module. It is subdivided into individual Memory registers with a width
of 16 bits each. In these Memory registers the following information is
stored:
– Input and output data
– Configuration settings
– Module Status
– Error states
The functionality of the addressing was adopted from Modbus. The
register assignment depends on the application and is not specified
by the Modbus specification. A Memory Register according to this
specification has a register number between 1 (0x0001) and a
maximum of 65536 (0x10000), of which the module only uses a small
part, however.
With 8-bit values, 1 byte remains unused. 32-bit values are stored in
2 registers.
The 16-bit values are stored internally in the memory in Little Endian
order. This must be taken into account when you access data in
bytes via the fieldbus interface, SDI or SSC.
NOTICE!In the description of the individual memory registers
and CDI, the memory registers are also referred to as Modbus
registers. However, this does not mean that they can only be
addressed via the Modbus protocol.
In section "Overview of the Memory Register [}53]" we have
compiled a detailed overview of registers for you.
Components

IC-Module for EtherNet/IP 14 / 137
4.3 Data Broker
The Data Broker decouples individual components from each other
and distributes the data streams between the interfaces. You can
configure any number of data that the Data Broker copies from the
data sources to the data sinks. This gives you great flexibility, e. g.
you can change the order of the data or merge data from different
sources.
Illustration2: Internal mapping by the Data Broker
Components

IC-Module for EtherNet/IP 15 / 137
Mapping
You have the option to define the allocation (mapping) yourself. This
allows you to define which input register the Data Broker should
accept data from and which output register it should transfer data to.
You can define up to 4 register areas with freely definable lengths in
the respective output register area for each of the interfaces. Any
register area of the same length is assigned to the output register
areas from one of the input register areas of all interfaces. Here, the
4 target areas are always on consecutive output register positions,
starting with the lowest register address for the respective interface.
Illustration3: Mapping
NOTICE Viewpoint
Please note that the description of the input and output values is written
from the perspective of the module and not from the perspective of the
overall system or master.
èOutput: Values that the module sends to the fieldbus or application.
èInput: Values that the module receives from the fieldbus or application.
Components

IC-Module for EtherNet/IP 16 / 137
You can configure standard values that the Data Broker writes in the
relevant output register instead of an input register in the event of a
failure of a data provider. That has the advantage that the data
processing cannot abort unnoticed.
The module uses the Little Endian byte order for the internal
processing. You can also configure the Data Broker so that it
exchanges the high and low byte when copying if necessary. To do
this, add the value 0x8000 or 32768 to the length of the affected
mapping area (see details below).
Components

IC-Module for EtherNet_IP 17 / 137
Extended Mapping
Some applications work with data that is viewed bitwise. To make the
mapping for such applications even more flexible, an "Extended
Mapping" is provided. This mapping basically works in the same way
as the mapping described above:
Individual areas of the output Memory Register are assigned from
areas of the input Memory registers. In Extended Mapping you define
such assignments for up to 16 areas. When doing so, enter a number
of consecutive bits for each of these areas.
The limit of a register must be exceeded: The area may be up to
1024 bits long. Unlike the simple mapping described above,
however, the 16 target areas do not necessarily have to be at
consecutive addresses. You are totally free to define the position of
the first bit of the target area by entering an output register address
and the corresponding bit position (0 bis 15). The source area is also
defined by entering the input register and a start bit position.
Illustration4: Extended Mapping
Components

IC-Module for EtherNet/IP 18 / 137
All mapping areas are processed sequentially. The Data Broker first
copies all simple mapping areas cyclically. After that, it executes the
Extended Mapping. In the course of this, it is quite possible to
intentionally overwrite a target area by several sources of data.
All copy operations of the Data Broker are carried out one after the
other without interruption. It is therefore not possible, for example, to
change fieldbus input data between the copy actions, or to read the
output data between the copy actions.
NOTICE It is possible that bits are overwritten unintentionally by various input
sources.
Make sure that the target areas do not overlap unintentionally.
Components

IC-Module for EtherNet/IP 19 / 137
Validity period of the process data
Data sources that write data to the input area of the central memory
are called producers because they produce process data. The Data
Broker collects this data and copies it into the output area of the
central memory. From there, the data is sent to its target, the so-
called consumer, via the corresponding interfaces.
Illustration5: Distribution to producers/consumers
Process data is normally exchanged cyclically between producers
and consumers. If a producer fails (e.g. a connector is removed or a
cable is broken), the consumer must be able to deal with this
situation appropriately. For this reason, you can define in advance
which values the producer will receive in exchange for the failed
process data.
Components

IC-Module for EtherNet/IP 20 / 137
The IC-Module allow a separate validity period to be defined for each
producer (SDI, SSC, EtherNet/IP ). When a producer supplies new
process data, a stopwatch is started. If the producer does not supply
any new process data before the predefined validity period expires,
then the old data is invalid after this time.
Each consumer predefines which data he is to receive from the Data
Broker in such a case:
– All bytes at 0
– All bytes at 1
– retain the last valid data
The set validity periods from KUNBUS-IC are saved permanently in
the Memory registers. They are also available after a restart.
Likewise, the rule defined for a consumer, as to how to proceed if the
validity period is exceeded. The respective time values of the validity
period must be adapted, of course, to the cycle time of the interface
concerned.
– For EtherNet/IP this cycle time is determined by parameters of the
master.
– For SSC interface the time is determined from the shift register chain
length, the cycle frequency, and for short or fast register chains, it is
determined by the cycle time of the KUNBUS-IC.
– During SPI slave mode and SDI transfer, the master determines the
cycle time of the respective interface.
Components