SI-Ethernet Manual
SI-Ethernet Manual
SI-Ethernet and
Unidrive M -
Onboard Ethernet
www.controltechniques.com
General Information
The manufacturer accepts no liability for any consequences resulting from inappropriate, negligent or
incorrect installation or adjustment of the optional parameters of the equipment or from mismatching the
variable speed drive with the motor.
The contents of this guide are believed to be correct at the time of printing. In the interests of commitment
to a policy of continuous development and improvement, the manufacturer reserves the right to change the
specification of the product or its performance, or the content of the guide without notice.
All rights reserved. No parts of this guide may be reproduced or transmitted in any form or by any means,
electrical or mechanical including, photocopying, recording or by an information storage or retrieval system,
without permission in writing from the publisher.
Environmental Statement
Control Techniques is committed to minimising the environmental impacts of its manufacturing operations
and of its products throughout their life cycle. To this end, we operate an Environmental Management
System (EMS) which is certified to the International Standard ISO 14001. Further information on the EMS,
our Environment Policy and other relevant information is available on request, or can be found at
www.greendrives.com.
The electronic variable speed drives manufactured by Control Techniques have the potential to save
energy and (through increased machine/process efficiency) reduce raw material consumption and scrap
throughout their long working lifetime. In typical applications, these positive environmental effects far
outweigh the negative impacts of product manufacture and end-of-life disposal.
Nevertheless, when the products eventually reach the end of their useful life, they must not be discarded
but should instead be recycled by a specialist recycler of electronic equipment. Recyclers will find the
products easy to dismantle into their major component parts for efficient recycling. Many parts snap
together and can be separated without the use of tools, while other parts are secured with conventional
fasteners. Virtually all parts of the product are suitable for recycling.
Product packaging is of good quality and can be re-used. Large products are packed in wooden crates,
while smaller products come in strong cardboard cartons which themselves have a high-recycled fibre
content. If not re-used, these containers can be recycled. Polythene, used on the protective film and bags
from wrapping product, can be recycled in the same way. Control Techniques' packaging strategy prefers
easily recyclable materials of low environmental impact, and regular reviews identify opportunities for
improvement.
When preparing to recycle or dispose of any product or packaging, please observe local legislation and
best practice.
Firmware Statement
This product is supplied with the latest firmware version. When retro-fitting to an existing system, all
firmware versions should be verified to confirm the same functionality as products of the same type already
present. This also applies to products returned from a Control Techniques Service Centre or Repair Centre.
If there is any doubt please contact the supplier of the product.
The firmware version of the product can be identified by looking at Pr MM.002 where MM is the relevant
menu number for the module slot being used.
REACH legislation
EC Regulation 1907/2006 on the Registration, Evaluation, Authorisation and restriction of Chemicals
(REACH) requires the supplier of an article to inform the recipient if it contains more than a specified
proportion of any substance which is considered by the European Chemicals Agency (ECHA) to be a
Substance of Very High Concern (SVHC) and is therefore listed by them as a candidate for compulsory
authorisation.
For current information on how this requirement applies in relation to specific Control Techniques products,
please approach your usual contact in the first instance. Control Techniques position statement can be
viewed at:
http://www.controltechniques.com/REACH
Firmware: V01.03.00.54
Contents
1 Safety information ..........................................................5
1.1 Warnings, cautions and notes .................................................................5
1.2 Electrical safety - general warning ..........................................................5
1.3 System design and safety of personnel ..................................................5
1.4 Environmental limits ................................................................................5
1.5 Compliance with regulations ...................................................................6
1.6 Motor .......................................................................................................6
1.7 Adjusting parameters ..............................................................................6
1.8 General safety considerations for remote operation ...............................6
2 Introduction ....................................................................7
2.1 Products covered by this User Guide ......................................................7
2.2 Features ..................................................................................................7
2.3 Option module identification ....................................................................8
2.4 Product conformance ..............................................................................8
2.5 Conventions used in this guide ...............................................................9
6 Parameters ....................................................................38
6.1 Menus ....................................................................................................38
9 Security .......................................................................182
9.1 Introduction ..........................................................................................182
9.2 General site security issues ................................................................182
9.3 Default restrictions ...............................................................................182
10 Diagnostics .................................................................183
10.1 LED diagnostics ..................................................................................183
10.2 Drive trip display codes .......................................................................183
10.3 Ethernet sub trip codes .......................................................................184
10.4 Ethernet sub trip codes .......................................................................186
10.5 Ethernet hardware fault trip codes ......................................................186
10.6 Diagnostic flow chart ...........................................................................188
information
Safety
1.1 Warnings, cautions and notes
Introduction
A Warning contains information, which is essential for avoiding a safety hazard.
WARNING
Mechanical
installation
A Caution contains information, which is necessary for avoiding a risk of damage to the
product or other equipment.
CAUTION
installation
Electrical
NOTE A Note contains information, which helps to ensure correct operation of the product.
Getting started
The voltages used in the drive can cause severe electrical shock and/or burns, and
could be lethal. Extreme care is necessary at all times when working with or adjacent to
the drive. Specific warnings are given at the relevant places in this User Guide.
Parameters
The drive is intended as a component for professional incorporation into complete
equipment or a system. If installed incorrectly, the drive may present a safety hazard.
The drive uses high voltages and currents, carries a high level of stored electrical
energy, and is used to control equipment which can cause injury.
Protocols
hazards, either in normal operation or in the event of equipment malfunction. System
design, installation, start up and maintenance must be carried out by personnel who
have the necessary training and experience. They must read this safety information and
this User Guide carefully.
PC Applications
The STOP and SAFE TORQUE OFF functions of the drive do not isolate dangerous
voltages from the output of the drive or from any external option unit. The supply must
be disconnected by an approved electrical isolation device before gaining access to the
electrical connections.
Security
With the sole exception of the SAFE TORQUE OFF function, none of the drive
functions must be used to ensure safety of personnel, i.e. they must not be used
for safety-related functions.
Diagnostics
The SAFE TORQUE OFF function may be used in a safety-related application. The
system designer is responsible for ensuring that the complete system is safe and
designed correctly according to the relevant safety standards.
Glossary of
Instructions regarding transport, storage, installation and use of the drive must be
complied with, including the specified environmental limits. Drives must not be
subjected to excessive physical force.
Index
For more information on these limits see the relevant drive user guide.
1.6 Motor
Ensure the motor is installed in accordance with the manufacturer’s recommendations.
Ensure the motor shaft is not exposed.
Standard squirrel cage induction motors are designed for single speed operation. If it is
intended to use the capability of the drive to run a motor at speeds above its designed
maximum, it is strongly recommended that the manufacturer is consulted first.
Low speeds may cause the motor to overheat because the cooling fan becomes less
effective. The motor should be installed with a protection thermistor. If necessary, an
electric forced vent fan should be used.
The values of the motor parameters set in the drive affect the protection of the motor.
The default values in the drive should not be relied upon.
It is essential that the correct value is entered in the motor rated current parameter
Pr 00.046, as this affects the thermal protection of the motor.
information
Safety
2.1 Products covered by this User Guide
This User Guide covers the SI-Ethernet option module and the onboard factory installed
Introduction
Ethernet interface. Both the SI-Ethernet module and the onboard Ethernet interface
offer the same functionality.
The onboard Ethernet interface provides Ethernet connectivity and is installed during
manufacture to the following drives:
Mechanical
installation
• Unidrive M700
• Unidrive M702
The SI-Ethernet is an option module that provides Ethernet connectivity and can be
installation
installed to the following drives:
Electrical
• Unidrive M200 / M201 (sizes 2 to 6)
• Unidrive M300 (sizes 2 to 6)
• Unidrive M400 (sizes 2 to 8)
Getting started
• Unidrive M600 (sizes 3 to 8)
• Unidrive M700 / M701 / M702 (sizes 3 to 10)
• Unidrive M800 / M810 (sizes 3 to 8)
2.2 Features
Parameters
The following list gives an overview of the functionality available:
• Single RJ45 connectivity with support for shielded twisted pair.
• 100 Mbs Ethernet with auto-negotiation.
• Full and half duplex operation with auto-negotiation.
Protocols
• TCP/IP.
• Modbus TCP/IP.
• EtherNet/IP.
• Switch or Gateway mode.
• VLAN tagging. PC Applications
• SyPTPro over Ethernet.
• Unidrive M Connect over Ethernet.
• Machine Control Studio.
• Static IP configuration or DHCP client.
Security
Link
LEDs
Earth
connection
The SI-Ethernet can be identified by:
1. The label located on the topside of the option module.
2. The color coding across the front of the option module. SI-Ethernet being beige.
information
The configuration of the host drive and option module is done using menus and
Safety
parameters. A menu is a logical collection of parameters that have similar functionality.
In the case of an option module, the option module set-up parameters in menu 0 will
appear in drive menu 15, 16 or 17 depending on which slot the module is installed in. In
Introduction
the case of the onboard Ethernet interface, the set-up parameters in menu 0 will
appear in drive menu 24.
The setting of the Option Slot Identifiers (Pr 11.056) may change the slot numbering
from those described above. The internal menus of the option module or onboard
Mechanical
installation
Ethernet interface will appear before menu 0 and after menu 41.
NOTE For M200, M300 and M400 drives, the option module set-up parameters will appear in
menu 15.
installation
Electrical
The method used to determine the menu or parameter is as follows:
• Pr S.mm.ppp - Where S signifies the option module slot number and mm.ppp
signifies the menu and parameter number respectively.
Getting started
If the option module slot number is not specified then the parameter reference will
be a drive parameter.
• Pr MM.ppp - Where MM signifies the menu allocated to the option module setup
menu and ppp signifies the parameter number within the set-up menu.
• Pr mm.000 - Signifies parameter number 000 in any drive menu.
Parameters
Key features and
Protocols
PC Applications
Security
Diagnostics
Glossary of
terms
Index
CAUTION: power down the drive before installing / removing option modules. Failure to
do so may result in damage to the product. Refer to the relevant Safety Information
CAUTION
section in the appropriate drive manual.
1
• With the option module tilted slightly backwards, align and locate the two holes in the rear of the
option module onto the two tabs (1) on the drive.
• Place the option module onto the drive as shown in (2) until the module clicks into place. The
terminal cover on the drive holds the option module in place, so this must be put back on.
NOTE Option modules can only be installed on drives that have the option module slot
functionality.
NOTE Figure 3-1 above is for illustration only, the actual option module may be different to the
one shown.
information
Safety
Introduction
2
Mechanical
installation
installation
Electrical
1
Getting started
• Place the option module onto the drive as shown in (2) until the module clicks into place. The
terminal cover on the drive holds the option module in place, so this must be put back on.
Parameters
Figure 3-3 Installation of an SI option module on Unidrive M600 to M810
and Protocols
Key features
PC Applications
Security
Diagnostics
Glossary of
• Align and insert the option module tab in to the slot provided, this is highlighted in the detailed
view (A).
• Press down on the option module until it clicks into place.
NOTE Option module slots must be used in the following order: Slot 3 (lower), Slot 2 (middle)
Index
Link
LEDs
Earth
connection
Spade (SI-Ethernet
connector only)
8 7 6 5 4 3 2 1 8 7 6 5 4 3 2 1
information
Standard Ethernet UTP or STP cables do not require supplementary grounding.
Safety
4.5 Cable
It is recommended that a minimum specification of CAT5e is installed on new
Introduction
installations, as this gives a good cost/performance ratio. If you are using existing
cabling, this may limit the maximum data rate depending on the cable ratings. In noisy
environments, the use of STP or fiber optic cable will offer additional noise immunity.
NOTE Cabling issues are the single biggest cause of network down-time. Ensure cabling is
Mechanical
correctly routed, wiring is correct, connectors are correctly installed and any switches or
installation
routers used are rated for industrial use. Office grade Ethernet equipment does not
generally offer the same degree of noise immunity as equipment intended for industrial
use.
installation
Electrical
4.6 Maximum network length
The main restriction imposed on Ethernet cabling is the length of a single segment of
cable as detailed in Table 4.1. If distances greater than this are required it may be
Getting started
possible to extend the network with additional switches or by using a fiber optic
converter.
Table 4.1 Ethernet maximum network lengths
Type Of Cable Data rate (bit/s) Maximum trunk length (m)
Parameters
Copper - UTP/STP CAT 5 100
Fiber Optic - Multi-mode 100 M 3000
Fiber Optic - Single-mode up to 100000
The distances specified are absolute recommended maximums for reliable transmission
and Protocols
NOTE
Key features
of data. The distances for the fiber optic sections will be dependent on the equipment
used on the network. The use of wireless networking products is not recommended for
control systems, as performance may be affected by many external influences.
Star topology:
• Enables individual devices to be swapped out
• Minimise message transmission delays
Diagnostics
information
Safety
5.1 Network design considerations
Ethernet is an open system allowing many different vendors to design and supply
Introduction
equipment. When designing an industrial network you must carefully consider the
topology and data traffic on the network to avoid potential problems.
To avoid bandwidth issues it is recommended that the control network is logically
separate from any other network. Where possible a physically separate network should
Mechanical
installation
be used. If this is not possible, the use of managed network devices should be
considered to prevent unnecessary traffic such as broadcasts reaching the control
network.
installation
Electrical
5.2 Addressing
The addressing system used on Ethernet uses two essential numbers for making
Getting started
connection, these are the IP address and the subnet mask. The address allows a
specific device to be located and the subnet mask defines how many bits represent the
subnet part of the address and how many bits represent the node address (see section
5.6.1 The IP address on page 17). Generally devices on different subnets can only
communicate by using a gateway (typically a router or firewall).
5.3 Where do IP addresses come from?
Parameters
Every address on a network must be unique. If you do not connect your network to any
other networks the assignment of IP addresses is not critical (although using a standard
system is recommended), as you have full control of the addresses used. The issue of
addressing becomes important when connecting multiple networks together or
and Protocols
Key features
connecting to the Internet where there is a strong possibility of duplication of addresses
if a scheme is not followed.
5.4 Addressing etiquette
PC Applications
The following list details some points that should be considered when selecting
addresses:
• Reserve address space: Ensure you have enough reserve address space on your
chosen addressing scheme to allow for future expansion.
• Uniqueness: Ensure your addresses are unique, every device on a subnet must
Security
• Broadcast and system addresses: The highest and lowest host address on a
subnet are reserved addresses.
• Use a system: Have a scheme for assigning your addresses, for example typically
servers may have a low IP address and routers a high IP address. It is not
Glossary of
NOTE Using the subnet mask it is possible to modify the IP addressing such that the ratio of
subnets and host addresses may be changed. This gives you the facility to “adjust”
standard classes to suit your specific requirements.
5.5.1 Class A addresses
A class A address only uses the first octet to represent the subnet, the remaining octets
are used to represent the host id. These addresses are intended for large organisations
such as universities and the military. These addresses must be requested from the
governing body (InterNIC) when using them publicly (on the Internet) to avoid
duplication.
5.5.2 Class B addresses
A class B address uses the first two octets to represent the subnet, the remaining octets
are used to represent the host id. These addresses are intended for medium to large
size networks. These addresses must be requested from the governing body (InterNIC)
when using them publicly (on the Internet) to avoid duplication. Class B addresses are
generally used on public or private networks.
information
A complete IP address consists of an IP address and a subnet mask, these two
Safety
numbers are required to allow communication on Ethernet using TCP/IP.
Introduction
The IP address is made up from four 8 bit decimal numbers (octets) and is written as
follows:
w.x.y.z for example192.168.0.1 (class c)
Mechanical
installation
The subnet mask defines what part of the address constitutes the subnet within the IP
address and what part of the address constitutes the host address. The subnet mask is
bit-wise ANDed with the address to give the subnet to which the host belongs. A typical
class C subnet mask would be 255.255.255.0, this may alternatively be written as ‘/24’
installation
Electrical
as in the example below, showing an IP address of 192.168.0.1 with a subnet mask of
255.255.255.0. This alternative notation indicates the number of bits representing the
subnet part of the address, starting from the most significant bit.
Getting started
Alternative subnet mask notation: 192.168.0.1 /24
Parameters
subnet address and the host address.
Figure 5-1 Completing the address
w x y z
and Protocols
Key features
IP Address 192 168 0 1
bit-wise AND
w x y z
Subnet Mask 255 255 255 0 PC Applications
Security
w x y z
Host
Subnet Address 192 168 0 0
Address
Diagnostics
Glossary of
terms
Index
NOTE If using manual IP address configuration please note that the IP address subnet mask
and the default gateway must also be set manually. For more information on manual
configuration see section 7.2.6 Network on page 22.
NOTE If the SI-Ethernet module is configured to use DHCP and the module requires
exchanging, the new SI-Ethernet module will have a different MAC address and hence
the DHCP server will issue the new module with a different IP address.
information
Safety
Start
Introduction
Connect all drives
PING all drives
together using
from a command
approved cable / See Chapter 4 prompt to test
See Chapter 5
connectors /
connections
switches
Mechanical
installation
Ensure each drive
Save module
Is correctly See Chapter 4 See Chapter 5
settings on drive.
grounded
installation
Electrical
Ensure segment END
Getting started
lengths no longer
than maximum
See Chapter 4
limits.
Parameters
Ensure that there Note: Redundant
are no circular
loops between
systems require
devices/switches specialist hardware.
and Protocols
Key features
Ensure the correct
cable types are See Chapter 4
used
PC Applications
A dedicated
Ethernet cable
Perform cable
tester Is
tests
recommended.
Security
See Chapter 5
Any changes
Configure the IP
Diagnostics
Ensure PC is on
the same subnet
or the default
gateway on the
drive & PC are set
Index
information
1 15
Safety
SI-Ethernet 2 N/A
M200 / M201 / M300 / M400
3 N/A
Onboard Ethernet 4 N/A
Introduction
1 15
SI-Ethernet 2 16
M600
3 17
Onboard Ethernet 4 N/A
Mechanical
1 15
installation
SI-Ethernet 2 16
M700 / M702
3 17
Onboard Ethernet 4 24
1 15
installation
Electrical
SI-Ethernet 2 16
M701
3 17
Onboard Ethernet 4 N/A
1 15
Getting started
SI-Ethernet 2 16
M800 / M810
3 N/A
Onboard Ethernet 4 24
Parameters
and Protocols
Key features
PC Applications
Security
Diagnostics
Glossary of
terms
Index
02.035 Non cyclic enable Off (0) or On (1) Off (0) RW Bit US
Non cyclic base
02.036 0.00.000 to 0.59.999 0.00.000 RW SMP US
parameter
information
Safety
Table 5.7 Menu 9 parameters
Introduction
09.002 Cyclic Rx Links Free 0 to 255 RO Num ND NC
Mechanical
installation
09.008 Background cycles per second 0 to 65535 RO Num ND NC PT
installation
Electrical
09.030 PCB Temperature o RO Num ND NC
-128 to 127 C
Getting started
Table 5.8 Menu 10 parameters
Parameters
10.002 Reset Off (0) or On (1) Off (0) RW Bit NC
10.010 Tx1 Link Profile Std (0), Sync (1) Std (0) RW Txt US
and Protocols
Key features
10.011 Tx1 Link Number 0 to 255 0 RW Num US
Tx1 Source
10.012 0.00.000 to 4.99.999 0.00.000 RW SMP PT US
Parameter
Tx1 Parameter
10.013 0 to 10 0 RW Num US
PC Applications
Count
Unicast (0),
Broadcast (1),
Tx1 Link Multicast1 (2),
10.014 Unicast (0) RW Txt US
Transmission Type Multicast2 (3),
Multicast3 (4),
Multicast4 (5)
Security
Tx1 Destination
10.015 0.0.0.0 to 255.255.255.255 0.0.0.0 RW IP US
Address
10.016 Tx1 Message Rate 0 to 100 ms 0 ms RW Num US
Diagnostics
Glossary of
terms
Index
information
Safety
VLAN disabled (-30),
Reserved 29 (-29),
Reserved 28 (-28),
Reserved 27 (-27),
Reserved 26 (-26),
Introduction
Reserved 25 (-25),
Reserved 24 (-24),
Reserved 23 (-23),
Reserved 22 (-22),
SYNC unsupported (-21),
Mechanical
MEC offset (-20),
installation
Invalid tx rate (-19),
Too many mapping (-18),
Link busy (-17),
Invalid profile (-16),
Invalid mapping (-15),
installation
Electrical
10.029 Tx2 Link Status Read only param (-14), OK (0) RO Txt
Msg mismatch (-13),
Msg too long (-12),
Attrib NA (-11),
Attrib RO (-10),
Getting started
Attrib missing (-9),
Timeout (-8),
In error (-7),
Link num in use (-6),
Not editable (-5),
Invalid link num (-4),
Invalid args (-3),
Parameters
Too many links (-2),
Out of memory (-1),
OK (0),
Not running (1),
OK sync (2)
and Protocols
Key features
10.030 Tx3 Link Profile Std (0), Sync (1) Std (0) RW Txt US
PC Applications
Parameter
Tx3 Parameter
10.033 0 to 10 0 RW Num US
Count
Unicast (0),
Broadcast (1),
Tx3 Link Multicast1 (2),
10.034 Unicast (0) RW Txt US
Security
Address 255.255.255.255
10.036 Tx3 Message Rate 0 to 100 ms 0 ms RW Num US
Glossary of
terms
Index
information
Safety
No Event (0),
Event (1),
Rx1 Timeout Event No Event
10.048 Event1 (2), RW Txt US
Type (0)
Event2 (3),
Event3 (4)
Introduction
VLAN disabled (-30),
Reserved 29 (-29),
Reserved 28 (-28),
Reserved 27 (-27),
Reserved 26 (-26),
Mechanical
installation
Reserved 25 (-25),
Reserved 24 (-24),
Reserved 23 (-23),
Reserved 22 (-22),
SYNC unsupported (-21),
MEC offset (-20),
installation
Electrical
Invalid tx rate (-19),
Too many mapping (-18),
Link busy (-17),
Invalid profile (-16),
Getting started
Invalid mapping (-15),
10.049 Rx1 Link Status Read only param (-14), OK (0) RO Txt
Msg mismatch (-13),
Msg too long (-12),
Attrib NA (-11),
Attrib RO (-10),
Attrib missing (-9),
Parameters
Timeout (-8),
In error (-7),
Link num in use (-6),
Not editable (-5),
Invalid link num (-4),
Invalid args (-3),
and Protocols
Key features
Too many links (-2),
Out of memory (-1),
OK (0),
Not running (1),
OK sync (2)
PC Applications
10.050 Rx2 Link Profile Std (0), Sync (1) Std (0) RW Txt US
Rx2 Parameter
10.053 0 to 10 0 RW Num US
Count
Direct (0),
Multicast1 (1),
Diagnostics
Multicast2 (2),
10.054 Rx2 Source Type Direct (0) RW Txt US
Multicast3 (3),
Multicast4 (4),
Local (5)
Glossary of
Trip (0),
10.056 Rx2 Timeout Action Clear output (1), Trip (0) RW Txt US
Hold last (2)
Index
information
Safety
Trip (0),
10.066 Rx3 Timeout Action Clear output (1), Trip (0) RW Txt US
Hold last (2)
This slot (0),
Slot 1 (1),
Introduction
Rx3 Timeout Event
10.067 Slot 2 (2), This slot (0) RW Txt US
Destination
Slot 3 (3),
Slot 4 (4)
No Event (0),
Event (1),
Mechanical
installation
Rx3 Timeout Event
10.068 Event1 (2), No Event (0) RW Txt US
Type
Event2 (3),
Event3 (4)
VLAN disabled (-30),
Reserved 29 (-29),
installation
Electrical
Reserved 28 (-28),
Reserved 27 (-27),
Reserved 26 (-26),
Reserved 25 (-25),
Reserved 24 (-24),
Getting started
Reserved 23 (-23),
Reserved 22 (-22),
SYNC unsupported (-21),
MEC offset (-20),
Invalid tx rate (-19),
Too many mapping (-18),
Parameters
Link busy (-17),
Invalid profile (-16),
Invalid mapping (-15),
10.069 Rx3 Link Status Read only param (-14), OK (0) RO Txt
Msg mismatch (-13),
Msg too long (-12),
and Protocols
Key features
Attrib NA (-11),
Attrib RO (-10),
Attrib missing (-9),
Timeout (-8),
In error (-7),
PC Applications
Link num in use (-6),
Not editable (-5),
Invalid link num (-4),
Invalid args (-3),
Too many links (-2),
Out of memory (-1),
OK (0),
Security
information
No Event (0),
Safety
Rx2 Late Event (1),
No Event
11.052 Synchronization Event 1 (2), RW Txt US
(0)
Frame Event Event 2 (3),
Event 3 (4)
Introduction
Rx3 Late Trip (1),
11.060 Synchronization Do not use (2), Trip (1) RW Txt US
Frame Action Use (3)
This slot (0),
Rx3 Late Slot 1 (1).
This slot
Mechanical
installation
11.061 Synchronization Slot 2 (2), RW Txt US
(0)
Frame Destination Slot 3 (3),
Slot 4 (4)
No Event (0),
Rx3 Late Event (1),
No Event
installation
11.062 Synchronization Event 1 (2), RW Txt US
Electrical
(0)
Frame Event Event 2 (3),
Event 3 (4)
Getting started
5.10.6 Menu 15 - Modbus
Table 5.10 Menu 15 parameters
Parameters
15.001 Enable Off (0) or On (1) On (1) RW Bit US
and Protocols
Key features
15.003 Default Off (0) or On (1) Off (0) RW Bit NC
No error (0),
Modbus Port in use (1),
PC Applications
15.004 RO Txt ND
Configuration Error Timeout event (2),
Num Connections (3)
Modbus Listening
15.005 0 to 65535 502 RW Num US
Port
Maximum
Security
15.006 0 to 4 2 RW Num US
Connections
Maximum Priority
15.007 0 to 4 0 RW Num US
Connections
Diagnostics
Maximum
15.008 Connections 1 to 4 2 RW Num US
Per Client
Glossary of
terms
0.0.0.0 to
15.020 Priority Connection 1 0.0.0.0 RW IP US
255.255.255.255
0.0.0.0 to
15.021 Priority Connection 2 0.0.0.0 RW IP US
255.255.255.255
0.0.0.0 to
15.022 Priority Connection 3 0.0.0.0 RW IP US
255.255.255.255
0.0.0.0 to
15.023 Priority Connection 4 0.0.0.0 RW IP US
255.255.255.255
information
Safety
No event (0),
Trigger Event (1),
RPI timeout event Trigger Event 1 (2),
20.013 No event (0) RW Txt US
type Trigger Event 2 (3),
Trigger Event 3 (4),
Introduction
Trigger Event 4 (5)
Trip (0),
Send flt values (1),
20.015 PLC idle action Clear output (2), No action (4) RW Txt US
Hold last (3),
Mechanical
installation
No action (4)
This slot (0),
Slot 1 (1),
PLC idle action
20.016 Slot 2 (2), This slot (0) RW Txt US
destination
Slot 3 (3),
installation
Slot 4 (4)
Electrical
No event (0),
Trigger Event (1),
Trigger Event 1 (2),
20.017 PLC idle action type No event (0) RW Txt US
Trigger Event 2 (3),
Getting started
Trigger Event 3 (4),
Trigger Event 4 (5)
100-PrimaryI (0),
70-BscSpdCtrlI (1),
Active input
20.018 71-ExtSpdCtrlI (2), 100-PrimaryI (0) RO Txt NC PT
assembly object
72-SpdTqCtrlI (3),
Parameters
73-ExtSpdTqCtrlI (4)
101-PrimaryO (0),
20-BscSpdCtrlO (1),
Active output
20.019 21-ExtSpdCtrlO (2), 101-PrimaryO (0) RO Txt NC PT
assembly object
22-SpdTqCtrlO (3),
and Protocols
23-ExtSpdTqCtrlO (4)
Key features
Input assembly
20.020 40 to 80 Bytes 8 Bytes RW Num US
object size
Output assembly
20.021 40 to 80 Bytes 8 Bytes RW Num US
object size
PC Applications
Input assembly
20.024 0 to 65535 ms RO Num ND NC PT
object process time
Output assembly
20.025 0 to 65535 ms RO Num ND NC PT
object process time
Input assembly
Security
trigger parameter
Output assembly
20.028 object consistency Off (0) or On (1) Off (0) RW Bit US
enable
Glossary of
Output assembly
terms
information
Safety
Table 5.12 Menu 21 parameters
Introduction
Input mapping
21.002 0.00.000 to 4.99.999 0.02.001 RW SMP DE PT US
parameter 2
Input mapping
21.003 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 3
Input mapping
Mechanical
installation
21.004 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 4
Input mapping
21.005 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 5
Input mapping
21.006 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 6
installation
Electrical
Input mapping
21.007 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 7
Input mapping
21.008 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 8
Getting started
Input mapping
21.009 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 9
Input mapping
21.010 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 10
Input mapping
21.011 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 11
Input mapping
Parameters
21.012 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 12
Input mapping
21.013 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 13
Input mapping
21.014 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 14
and Protocols
Key features
Input mapping
21.015 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 15
Input mapping
21.016 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 16
Input mapping
PC Applications
21.017 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 17
Input mapping
21.018 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 18
Input mapping
21.019 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
parameter 19
Input mapping
21.020 0.00.000 to 4.99.999 0.00.000 RW SMP DE PT US
Security
parameter 20
Diagnostics
Glossary of
terms
Index
information
Table 5.14 Menu 23 parameters
Safety
Parameter Range Default Type
Output fault -2147483648 to
23.001 0 RW Num PT US
value 1 2147483647
Introduction
Output fault -2147483648 to
23.002 0 RW Num PT US
value 2 2147483647
Output fault -2147483648 to
23.003 0 RW Num PT US
value 3 2147483647
Output fault -2147483648 to
23.004 0 RW Num PT US
Mechanical
installation
value 4 2147483647
Output fault -2147483648 to
23.005 0 RW Num PT US
value 5 2147483647
Output fault -2147483648 to
23.006 0 RW Num PT US
value 6 2147483647
installation
Output fault -2147483648 to
Electrical
23.007 0 RW Num PT US
value 7 2147483647
Output fault -2147483648 to
23.008 0 RW Num PT US
value 8 2147483647
Output fault -2147483648 to
Getting started
23.009 0 RW Num PT US
value 9 2147483647
Output fault -2147483648 to
23.010 0 RW Num PT US
value 10 2147483647
Output fault -2147483648 to
23.011 0 RW Num PT US
value 11 2147483647
Output fault -2147483648 to
23.012 0 RW Num PT US
Parameters
value 12 2147483647
Output fault -2147483648 to
23.013 0 RW Num PT US
value 13 2147483647
Output fault -2147483648 to
23.014 0 RW Num PT US
value 14 2147483647
Output fault -2147483648 to
and Protocols
Key features
23.015 0 RW Num PT US
value 15 2147483647
Output fault -2147483648 to
23.016 0 RW Num PT US
value 16 2147483647
Output fault -2147483648 to
23.017 0 RW Num PT US
PC Applications
value 17 2147483647
Output fault -2147483648 to
23.018 0 RW Num PT US
value 18 2147483647
Output fault -2147483648 to
23.019 0 RW Num PT US
value 19 2147483647
Output fault -2147483648 to
23.020 0 RW Num PT US
value 20 2147483647
Security
Diagnostics
Glossary of
terms
Index
6.1 Menus
Table 6.1 Ethernet internal menus
Menu Description
S.9 Resources
S.11 Synchronization
S.15 Modbus
information
Safety
S.00.001 Module ID
Minimum 0 Maximum 65535
Default Units
Introduction
Type 16 Bit Volatile Update Rate Power-up write
Display Format None Decimal Places 0
Coding RO, ND, NC, PT, BU
The Module ID:
Mechanical
installation
• Onboard Ethernet = 430
• SI-Ethernet option module = 433
installation
Electrical
0 99999999
Minimum Maximum
(Display 00.00.00.00) (Display 99.99.99.99)
Default Units
Getting started
Type 32 Bit Volatile Update Rate
Display Format Version Number Decimal Places 0
Coding RO, ND, NC, PT
Module firmware version in ww.xx.yy.zz format.
Parameters
S.00.003 Hardware version
Minimum 00.00 Maximum 99.99
Default Units
Type 16 Bit Volatile Update Rate
and Protocols
Key features
Display Format None Decimal Places 2
Coding RO, ND, NC, PT
The hardware version of the option module is in the format of xx.yy.
PC Applications
S.00.004 Serial Number LS
Minimum 0 Maximum 99999999
Default Units
Security
The module serial number is available as a pair of 32-bit values where Serial Number
LS (S.00.004) provides the least significant 8 decimal digits, and Serial Number MS
(S.00.005) provides the most significant 8 decimal digits. The reconstructed serial
Glossary of
S.00.006 Status
Minimum -2 Maximum 3
Default Units
Type 8 Bit Volatile Update Rate Background
Display Format None Decimal Places 0
Coding RO, TE, ND, NC, PT
This parameter displays the current status of the module. All possible values are shown
in the table below.
Value Text Description
-2 Bootldr-Update The bootloader is performing a flash update.
-1 Bootldr-Idle The bootloader is idle.
0 Initialising Module is currently initializing.
1 OK Module has initialized and has found no errors.
2 Config A configuration error has been detected.
An error has occurred preventing the module from
3 Error
running correctly.
S.00.007 Reset
Minimum 0 Maximum 1
Default 0 Units
Read every 200 ms,
Type 1 Bit Volatile Update Rate Written to 0 on module
initialization.
Display Format None Decimal Places 0
Coding RW, NC
When set, the module performs a warm reset. When the reset has been performed and
the module is performing it’s initialization routines the parameter will be cleared to zero.
NOTE The drive, and any other modules fitted to the drive, will not be affected by the reset.
Safety
Minimum 0 Maximum 1
Default 0 Units
Read every 200 ms,
Introduction
Type 1 Bit Volatile Update Rate Written to 0 on module
initialization.
Display Format None Decimal Places 0
Coding RW, NC
Mechanical
installation
If set to “ON” when the module is reset, this parameter will cause the option module to
return to it’s “Out of box configuration” and any settings stored on the module will be
returned to their default values. This will include any Web page customisations, e-mail
installation
settings, etc. Following the default the module will set the parameter to “OFF” and the
Electrical
module will reset.
Take care using this parameter as any configuration information will be irretrievably lost!
Getting started
S.00.009 Active Alarm Bits
0 65535
Minimum Maximum
(Display:0000000000000000) (Display:1111111111111111)
0
Default Units
(Display:0000000000000000)
Parameters
Update
Type 16 Bit Volatile Background
Rate
Display Decimal
Binary 0
Format Places
and Protocols
Key features
Coding RO, NC, BU
Bit Alarm
PC Applications
0 User Program
1 eCMP
2 Modbus
Security
3 Ethernet/IP
4 Reserved
Diagnostics
5 Filesystem
6 Too Hot
Glossary of
terms
Index
Safety
Minimum 0 Maximum 1
Default 1 Units
Type 1 Bit User Save Update Rate Background read
Introduction
Display Format None Decimal Places 0
Coding RW, BU
Controls whether or not the module will attempt to use a Dynamic Host Configuration
Mechanical
Protocol (DHCP) server to obtain the IP address, subnet mask, default gateway and
installation
DNS servers.
When DHCP is enabled, the following parameters will become read-only immediately
(no reset required):
installation
Electrical
• IP Address (S.02.006)
• Subnet Mask (S.02.007)
• Default Gateway (S.02.008)
• Primary DNS (S.02.009)
Getting started
• Secondary DNS (S.02.010)
S.02.006 IP Address
0 4294967295
Minimum Maximum
(Display: 0.0.0.0) (Display:255.255.255.255)
Parameters
3232235876
Default Units
(Display:192.168.1.100)
DHCP enabled: write on
event;
Type 32 Bit User Save Update Rate
and Protocols
DHCP disabled: read on
Key features
reset
Display Format IP Address Decimal Places 0
Coding RW, BU
Safety
0 4294967295
Minimum Maximum
(Display: 0.0.0.0) (Display:255.255.255.255)
0
Default Units
Introduction
(Display: 0.0.0.0)
DHCP enabled:
write on event;
Type 32 Bit User Save Update Rate
DHCP disabled: read on
Mechanical
installation
reset
Display Format IP Address Decimal Places 0
Coding RW, BU
The module can use this IP address when it wishes to resolve the IP address for a
installation
Electrical
domain name. This parameter performs the same function as Secondary DNS
(S.02.010), however the address specified in this parameter will be tried first. Only when
this address is unsuccessful will the secondary DNS address be tried.
Getting started
If DHCP is enabled this parameter becomes read-only, and until a primary DNS address
is allocated to the module will display 0.0.0.0.
If DHCP is disabled the module will initialize, on reset or power cycle, with the primary
DNS address stored for the parameter.
Parameters
S.02.010 Secondary DNS
0 4294967295
Minimum Maximum
(Display: 0.0.0.0) (Display:255.255.255.255)
0
and Protocols
Key features
Default Units
(Display: 0.0.0.0)
DHCP enabled:
write on event;
Type 32 Bit User Save Update Rate
DHCP disabled: read on
PC Applications
reset
Display Format IP Address Decimal Places 0
Coding RW, BU
The module can use this IP address when it wishes to resolve the IP address for a
Security
domain name. This parameter performs the same function as Primary DNS (S.02.009),
however the address specified in this parameter will be tried only when the primary DNS
address is unsuccessful.
Diagnostics
If DHCP is enabled this parameter becomes read-only, and until a secondary DNS
address is allocated to the module will display 0.0.0.0.
If DHCP is disabled the module will initialize, on reset or power cycle, with the
secondary DNS address stored for the parameter.
Glossary of
terms
Index
information
Safety
Minimum 0 Maximum 65535
Default 80 Units
Read on module reset
Type 1 Bit User Save Update Rate
Introduction
and HTTP_ENABLE
Display Format None Decimal Places 0
Coding RW, BU
The web server port. This may be changed for added security.
Mechanical
installation
NOTE The web server functionality is not currently implemented.
installation
Electrical
Minimum 158 Maximum 1500
Default 1500 Units Bytes
Type 16 Bit User Save Update Rate Read on module reset
Getting started
Display Format None Decimal Places 0
Coding RW, BU
Specifies the MTU (Maximum Transmittable Unit) in bytes allowed by the Ethernet
interface.
Parameters
S.02.025 Gateway Mode
Minimum 0 Maximum 2
Default 0 Units
Type 8 Bit User Save Update Rate Read on module reset
and Protocols
Key features
Display Format None Decimal Places 0
Coding RW, TE, BU
PC Applications
Value Text
0 Switch
1 Gateway
Security
2 Strict Gateway
Specifies the operation mode of the gateway. By default the gateway is disabled and the
Diagnostics
switch operates in normal switch mode. By enabling the gateway mode all packets are
filtered by the module and prioritized before being forwarded on. In strict mode the
gateway will drop packets from unsupported protocols.
Glossary of
terms
Index
information
parameter (MM.PPP) identified as S.MM.PPP.
Safety
Parameter Description
S.MM.PPP Base parameter - status (bits b15 to b8) and command (bits b7 to b0) information
Introduction
S.MM.PPP + 1 2nd parameter in sequence - Destination IP address (wwwxxx)
S.MM.PPP + 2 3rd parameter in sequence - Destination IP address (yyyzzz)
S.MM.PPP + 3 4th parameter in sequence - target I source parameter address (SMM)
Mechanical
installation
S.MM.PPP + 4 5th parameter in sequence - target I source parameter address (PPP)
S.MM.PPP + 5 6th parameter in sequence - target I source parameter value (LSW) or error code
S.MM.PPP + 6 7th parameter in sequence - target I source parameter value (MSW)
installation
Electrical
NOTE Each parameter must be at least 16 bits in size.
Getting started
This parameter contains the command code (bits b7 to b0) and status (bits b15 to b8)
information.
Possible values for Status are:
Parameters
0 IDLE Idle.
and Protocols
Key features
3 OK The command processed successfully.
PC Applications
Possible values for Command (bits b7 to b0) are:
1 Check I Abort Check if the status idle or abort from read or write command.
Security
-3 Access Denied The requesting device does not have sufficient access rights.
-5 Data Type The data could not be converted from the specified type.
-8 Not Readable The data could not be read as the source does not allow read access.
The data could not be written as the destination does not allow write
-9 Not Writeable
access.
-10 Over Range The specified value is outside the suitable range for the item.
-12 Response Too Big The response will not fit in the maximum response size.
The decimal place information is invalid (i.e. out of range of allowed
-13 Decimal Place
values for a write).
-14 Invalid Param Invalid parameter in the parameter channel.
information
This parameter:
Safety
• Stores the most significant word of the value to be written to the destination
parameter if the command is Write (3) or
• Stores the most significant word of the value read from the destination parameter if
the command is Read (2) and the status is OK (3)
Introduction
6.1.3 Menu 9 – Resources
Mechanical
installation
Minimum 0 Maximum 255
Default Units
Type 8 Bit Volatile Update Rate Background write
installation
Display Format None Decimal Places 0
Electrical
Coding RO, ND, NC, BU
The number of available transmit cyclic links.
Getting started
S.09.002 Cyclic Rx Links Free
Minimum 0 Maximum 255
Default Units
Type 8 Bit Volatile Update Rate Background write
Parameters
Display Format None Decimal Places 0
Coding RO, ND, NC, BU
The number of available receive cyclic links.
and Protocols
Key features
S.09.003 Fieldbus Links Free
Minimum 0 Maximum 255
Default Units
PC Applications
Type 8 Bit Volatile Update Rate Background write
Display Format None Decimal Places 0
Coding RO, ND, NC, BU
The number of available transmit / receive process images for fieldbus protocols such
Security
as Ethernet/IP.
The number of available mappings in the system for use in cyclic links.
Index
information
The menus specified here allow up to 3 transmit and 3 receive cyclic links to be
Safety
configured. Each receive link can have its own timeout configured with an additional
custom action.
For greater control advanced cyclic links can be configured using the cyclic link editor
Introduction
within Machine Control Studio.
Base link parameters
Src/Dest
Link Profile Link No. Par Count Type IP Address Rate
Par
Mechanical
installation
Tx1 S.10.010 S.10.011 S.10.012 S.10.013 S.10.14 S.10.015* S.10.016
Tx2 S.10.020 S.10.021 S.10.022 S.10.023 S.10.24 S.10.025* S.10.026
Tx3 S.10.030 S.10.031 S.10.032 S.10.033 S.10.34 S.10.035* S.10.036
installation
Electrical
Rx1 S.10.040 S.10.041 S.10.042 S.10.043 S.10.044 n/a n/a
Rx2 S.10.050 S.10.051 S.10.052 S.10.053 S.10.054 n/a n/a
Getting started
Rx3 S.10.060 S.10.061 S.10.062 S.10.063 S.10.064 n/a n/a
S.10.001 Enable
Parameters
Minimum 0 Maximum 1
Default 1 Units
Type 1 Bit User Save Update Rate Background read
Display Format None Decimal Places 0
and Protocols
Key features
Coding RW, BU
This parameter is used to enable or disable the Easy Mode protocol interface.
PC Applications
S.10.002 Reset
Minimum 0 Maximum 1
Security
Default 0 Units
Type 1 Bit Volatile Update Rate Background read
Display Format None Decimal Places 0
Diagnostics
Coding RW, NC
This parameter is used to perform a warm reset of the protocol interface. When set and
the protocol has reset, the parameter will be reset to zero (Off).
Glossary of
terms
Index
This parameter allows the protocol to be defaulted to factory settings. This includes all
of the protocol features, configuration, mappings and stored objects.
This parameter is used to set the link number (1 to 255) for the Tx1 link.
Introduction
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
Coding RW, BU
This parameter is used to set the number of contiguous parameters for the Tx1 link.
Mechanical
installation
S.10.014 Tx1 Link Transmission Type
Minimum 0 Maximum 5
installation
Electrical
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
Getting started
Coding RW, TE, BU
Parameters
1 Broadcast Link is broadcast (255.255.255.255)
2 Multicast1 Link is multicast to the IP address (239.255.0.1)
3 Multicast2 Link is multicast to the IP address (239.255.0.2)
4 Multicast3 Link is multicast to the IP address (239.255.0.3)
and Protocols
Key features
5 Multicast4 Link is multicast to the IP address (239.255.0.4)
This parameter specifies the type of transmission for the Tx1 link.
PC Applications
S.10.015 Tx1 Destination Address
0 4294967295
Minimum Maximum
(Display:0.0.0.0) (Display: 255.255.255.255)
Security
0
Default Units
(Display:0.0.0.0)
Type 32 Bit User Save Update Rate Read on reset
Diagnostics
This parameter specifies the IP address of the destination device for the Tx1 link. If Tx1
Glossary of
Link Transmission Type (S.10.014) is set to either broadcast or one of the multicast
terms
NOTE This parameter value is not locked and may be changed by the user, if this value is
changed to any of the multicast addresses (Multicast1, Multicast2, Multicast3 or
Index
Multicast4) or the broadcast address then Tx1 Link Transmission Type (S.10.014) will
indicate the appropriate setting.
Defines, in milliseconds, the rate at which Tx1 Link will be transmitted. A value of zero
disables the transmission of data.
information
Safety
-10 Attrib RO Attribute is read only
-9 Attrib missing Attribute is missing
-8 Timeout Timeout
Introduction
-7 In error The specified link is in error state
-6 Link num in use The link number specified is already in use
-5 Not editable The link specified is not editable
Mechanical
installation
-4 Invalid link num An invalid link number was specified
-3 Invalid args Link number / argument zero or invalid
-2 Too many links Maximum number of links has been reached
installation
Electrical
-1 Out of memory Failed to allocate memory
0 OK Configuration of link successful
1 Not running Ok, not running
Getting started
2 OK sync Configuration of synchronous link successful
This reports the links status if it has been loaded. A Reset (S.10.002) is required to load
any changes.
Parameters
S.10.020 Tx2 Link Profile
Minimum 0 Maximum 1
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
and Protocols
Key features
Display Format None Decimal Places 0
Coding RW, TE
PC Applications
Value Text Description
0 Std Standard link
1 Sync Synchronized link
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
Glossary of
Coding RW, BU
terms
This parameter is used to set the link number (1 to 255) for the Tx2 link.
Index
information
Safety
0 4294967295
Minimum Maximum
(Display:0.0.0.0) (Display: 255.255.255.255)
0
Default Units
Introduction
(Display:0.0.0.0)
Type 32 Bit User Save Update Rate Read on reset
Display Format IP Address Decimal Places 0
Coding RW, BU
Mechanical
installation
This parameter specifies the IP address of the destination device for the Tx2 link. If Tx2
Link Transmission Type (S.10.024) is set to either broadcast or one of the multicast
settings this parameter will display the appropriate address.
installation
Electrical
NOTE This parameter value is not locked and may be changed by the user, if this value is
changed to any of the multicast addresses (Multicast1, Multicast2, Multicast3 or
Multicast4) or the broadcast address then Tx2 Link Transmission Type (S.10.024) will
indicate the appropriate setting.
Getting started
S.10.026 Tx2 Message Rate
Minimum 0 Maximum 100
Default 0 Units ms
Parameters
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
Coding RW, BU
Defines, in milliseconds, the rate at which Tx2 Link will be transmitted. A value of zero
and Protocols
Key features
disables the transmission of data.
PC Applications
Minimum -30 Maximum 2
Default 0 Units
Type 8 Bit Volatile Update Rate Write on reset
Display Format None Decimal Places 0
Coding RO, TE
Security
Diagnostics
Glossary of
terms
Index
information
required to load any changes.
Safety
S.10.030 Tx3 Link Profile
Minimum 0 Maximum 1
Introduction
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
Coding RW, TE
Mechanical
installation
Value Text Description
0 Std Standard link
installation
Electrical
1 Sync Synchronized link
Getting started
S.10.031 Tx3 Link Number
Minimum 0 Maximum 255
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Parameters
Display Format None Decimal Places 0
Coding RW, BU
This parameter is used to set the link number (1 to 255) for the Tx3 link.
and Protocols
Key features
S.10.032 Tx3 Source Parameter
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
0
PC Applications
Default Units
(Display: 0.00.000)
Type 32 Bit User Save Update Rate Read on reset
Display Format Slot Menu Param Decimal Places 0
Coding RW, PT, BU
Security
This parameter sets the source parameter for the Tx3 link.
Minimum 0 Maximum 10
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Glossary of
Coding RW, BU
This parameter is used to set the number of contiguous parameters for the Tx3 link.
Index
This parameter specifies the type of transmission for the Tx3 link.
This parameter specifies the IP address of the destination device for the Tx3 link. If Tx3
Link Transmission Type (S.10.034) is set to either broadcast or one of the multicast
settings this parameter will display the appropriate address.
NOTE This parameter value is not locked and may be changed by the user, if this value is
changed to any of the multicast addresses (Multicast1, Multicast2, Multicast3 or
Multicast4) or the broadcast address then Tx3 Link Transmission Type (S.10.034) will
indicate the appropriate setting.
Defines, in milliseconds, the rate at which Tx3 Link will be transmitted. A value of zero
disables the transmission of data.
information
Safety
Minimum -30 Maximum 2
Default 0 Units
Type 8 Bit Volatile Update Rate Write on reset
Introduction
Display Format None Decimal Places 0
Coding RO, TE
Mechanical
installation
Value Text Description
VLAN is required in order to guarantee timing in
-30 VLAN disabled
synchronous mode but it is disabled
-29 Reserved 29 Reserved for future use
installation
Electrical
-28 Reserved 28 Reserved for future use
-27 Reserved 27 Reserved for future use
Getting started
-26 Reserved 26 Reserved for future use
-25 Reserved 25 Reserved for future use
-24 Reserved 24 Reserved for future use
-23 Reserved 23 Reserved for future use
Parameters
-22 Invalid DST IP Destination IP address is invalid
Sync link does not support mappings to other option
-21 SYNC unsupported
parameters
-20 MEC offset Incorrect MEC offset
and Protocols
Key features
-19 Invalid tx rate Tx rate must be a factor of 1 second
The number of mapping items exceeds the range
-18 Too many mapping
supported
PC Applications
-17 Link busy The link specified is busy
-16 Invalid profile The profile is invalid
-15 Invalid mapping The mapped parameter does not exist
-14 Read only param The mapped parameter is read only
Security
-8 Timeout Timeout
terms
This parameter reports the link’s status if it has been loaded. A Reset (S.10.002) is
required to load any changes.
information
Safety
Minimum 0 Maximum 10
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Introduction
Display Format None Decimal Places 0
Coding RW, BU
This parameter is used to set the number of contiguous parameters for the Rx1 link.
Mechanical
installation
S.10.044 Rx1 Source Type
Minimum 0 Maximum 5
Default 0 Units
installation
Type 8 Bit User Save Update Rate Read on reset
Electrical
Display Format None Decimal Places 0
Coding RW, TE, BU
Getting started
Value Text Description
0 Direct Link is unicast or broadcast
1 Multicast1 Link is multicast to the IP address
Parameters
2 Multicast2 Link is multicast to the IP address
3 Multicast3 Link is multicast to the IP address
4 Multicast4 Link is multicast to the IP address
5 Local Link will receive from local transmit link
and Protocols
Key features
This specifies the type of transmission for the Rx1 link.
Coding RW, BU
This parameter specifies the watchdog timer for the Rx1 link. If no cyclic data is received
on the Rx1 link the action taken will be determined by the setting in Rx1 Timeout Action
Diagnostics
(S.10.046).
NOTE It is good system design to allow for some message loss by setting the timeout duration
to be greater than the transmit period by a factor of 2 or more.
Glossary of
terms
Index
This parameter defines the slot in which an event will occur if a cyclic data timeout
occurs on the Rx1 link.
Safety
0 No Event No event
1 Event Trigger module event
Introduction
2 Event 1 Trigger module event 1
3 Event 2 Trigger module event 2
4 Event 3 Trigger module event 3
Mechanical
installation
Defines the event to trigger in the given destination, as specified in Rx1 Timeout Event
Destination (S.10.047), if a cyclic data timeout occurs on the Rx1 link.
installation
Electrical
S.10.049 Rx1 Link Status
Minimum -30 Maximum 2
Default 0 Units
Getting started
Type 8 Bit Volatile Update Rate Write on reset
Display Format None Decimal Places 0
Coding RO, TE
Parameters
Value Text Description
VLAN is required in order to guarantee timing in
-30 VLAN disabled
synchronous mode but it is disabled
and Protocols
Key features
-29 Reserved 29 Reserved for future use
-28 Reserved 28 Reserved for future use
-27 Reserved 27 Reserved for future use
PC Applications
-26 Reserved 26 Reserved for future use
-25 Reserved 25 Reserved for future use
-24 Reserved 24 Reserved for future use
-23 Reserved 23 Reserved for future use
Security
parameters
-20 MEC offset Incorrect MEC offset
-19 Invalid tx rate Tx rate must be a factor of 1 second
Glossary of
supported
-17 Link busy The link specified is busy
-16 Invalid profile The profile is invalid
Index
This parameter reports the link’s status if it has been loaded. A Reset (S.10.002) is
required to load any changes.
information
Safety
Minimum 0 Maximum 255
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Introduction
Display Format None Decimal Places 0
Coding RW, BU
This parameter is used to set the link number (1 to 255) for the Rx2 link.
Mechanical
installation
S.10.052 Rx2 Destination Parameter
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
0
installation
Electrical
Default Units
(Display: 0.00.000)
Type 32 Bit User Save Update Rate Read on reset
Display Format Slot Menu Param Decimal Places 0
Getting started
Coding RW, PT, BU
This parameter sets the destination parameter for the Rx2 link.
Parameters
Minimum 0 Maximum 10
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
and Protocols
Key features
Coding RW, BU
This is used to set the number of contiguous parameters for the Rx2 link.
PC Applications
S.10.054 Rx2 Source Type
Minimum 0 Maximum 5
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
Security
This parameter specifies the type of transmission for the Rx2 link.
This parameter specifies the watchdog timer for the Rx2 link. If no cyclic data is
received on the Rx2 link the action taken will be determined by the setting in Rx2
Timeout Action (S.10.056).
NOTE It is good system design to allow for some message loss by setting the timeout duration
to be greater than the transmit period by a factor of 2 or more.
This parameter defines the slot in which an event will occur if a cyclic data timeout
occurs on the Rx2 link.
information
NOTE
Safety
S.10.058 Rx2 Timeout Event Type
Minimum 0 Maximum 4
Introduction
Default 0 Units
Type 8 Bit User save Update Rate Read on reset
Display Format None Decimal Places 0
Coding RW, TE, BU
Mechanical
installation
Value Text Description
0 No Event No event
installation
Electrical
1 Event Trigger module event
2 Event 1 Trigger module event 1
3 Event 2 Trigger module event 2
Getting started
4 Event 3 Trigger module event 3
Defines the event to trigger in the given destination, as specified in Rx2 Timeout Event
Destination (S.10.057), if a cyclic data timeout occurs on the Rx2 link.
Parameters
NOTE This feature is not yet implemented.
and Protocols
Key features
Default 0 Units
Type 8 Bit Volatile Update Rate Write on reset
Display Format None Decimal Places 0
PC Applications
Coding RO, TE
Security
Diagnostics
Glossary of
terms
Index
information
required to load any changes.
Safety
S.10.060 Rx3 Link Profile
Minimum 0 Maximum 1
Introduction
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
Coding RW, TE
Mechanical
installation
Value Text Description
0 Std Standard link
installation
Electrical
1 Sync Synchronized link
Getting started
S.10.061 Rx3 Link Number
Minimum 0 Maximum 255
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Parameters
Display Format None Decimal Places 0
Coding RW, BU
This parameter is used to set the link number (1 to 255) for the Rx3 link.
and Protocols
Key features
S.10.062 Rx3 Destination Parameter
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
0
PC Applications
Default Units
(Display: 0.00.000)
Type 32 Bit User Save Update Rate Read on reset
Display Format Slot Menu Param Decimal Places 0
Coding RW, PT, BU
Security
This parameter sets the destination parameter for the Rx3 link.
Minimum 0 Maximum 10
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Glossary of
Coding RW, BU
This parameter is used to set the number of contiguous parameters for the Rx3 link.
Index
This parameter specifies the type of transmission for the Rx3 link.
This parameter specifies the watchdog timer for the Rx3 link. If no cyclic data is
received on the Rx3 link the action taken will be determined by the setting in Rx3
Timeout Action (S.10.066).
NOTE It is good system design to allow for some message loss by setting the timeout duration
to be greater than the transmit period by a factor of 2 or more.
information
Safety
Minimum 0 Maximum 4
Default 0 Units
Type 8 Bit User save Update Rate Read on reset
Introduction
Display Format None Decimal Places 0
Coding RW, TE, BU
Mechanical
installation
0 This slot Trigger module event in this slot
1 Slot 1 Trigger module event in slot 1
2 Slot 2 Trigger module event in slot 2
installation
Electrical
3 Slot 3 Trigger module event in slot 3
4 Slot 4 Trigger module event in slot 4
Getting started
This parameter defines the slot in which an event will occur if a cyclic data timeout
occurs on the Rx3 link.
Parameters
S.10.068 Rx3 Timeout Event Type
Minimum 0 Maximum 4
Default 0 Units
Type 8 Bit User save Update Rate Read on reset
and Protocols
Key features
Display Format None Decimal Places 0
Coding RW, TE, BU
PC Applications
Value Text Description
0 No Event No event
1 Event Trigger module event
2 Event 1 Trigger module event 1
Security
Defines the event to trigger in the given destination, as specified in Rx3 Timeout Event
Destination (S.10.067), if a cyclic data timeout occurs on the Rx3 link.
NOTE
terms
Index
information
Safety
-3 Invalid args Link number / argument zero or invalid
-2 Too many links Maximum number of links has been reached
-1 Out of memory Failed to allocate memory
Introduction
0 OK Configuration of link successful
1 Not running Ok, not running
2 OK sync Configuration of synchronous link successful
Mechanical
installation
This parameter reports the link’s status if it has been loaded. A Reset (S.10.002) is
required to load any changes.
6.1.5 Menu 11 – Synchronization
installation
Electrical
S.11.001 Preferred Sync Master
Minimum 0 Maximum 4
Default 1 Units
Getting started
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
Coding RW, BU
This Ethernet interface will be preferred as the grandmaster over others with higher
Parameters
preferred values or none specified. A value of zero will ensure that the Ethernet
interface will not become grandmaster (making the Ethernet interface act as an IEEE
1588 slave device only). If more than one Ethernet interface has the same preferred
value only one will be chosen as the grandmaster using the IEEE 1588 BMC algorithm.
and Protocols
Key features
The parameter does not guarantee that the Ethernet interface will become grandmaster
but a value of zero guarantees that the Ethernet interface will not become a
grandmaster.
Specifies the clock domain for the Ethernet interface to act as a grandmaster clock.
Default Units
Type 64 Bit Volatile Update Rate Background write
Display Format MAC Address Decimal Places 0
Index
This parameter displays the MAC address, as a 64-bit hexadecimal value, of the
This parameter displays the synchronization jitter in nanoseconds. The value is filtered
to be human readable.
information
Safety
0 311299
Minimum Maximum
(Display: 00-00-00) (Display: 31-12-99)
Default Units
Introduction
Type 32 Bit Volatile Update Rate Written every 500 ms
Display Format Date Decimal Places 0
Coding RO, ND, NC, PT, BU
This parameter displays the current date. If the module has no time source it will display
Mechanical
installation
the date based on its power-up date of 1st January 1970.
installation
Minimum Maximum
Electrical
(Display: 00:00:00) (Display: 23:59:59)
Default Units
Type 32 Bit Volatile Update Rate Written every 500 ms
Getting started
Display Format Time Decimal Places 0
Coding RO, ND, NC, PT, BU
This parameter displays the current time. If the module has no time source it will display
the time based on its power-up time.
Parameters
S.11.016 PTP Sync Rate
Minimum -4 Maximum 0
Default -4 Units
Type 8 Bit User Save Update Rate Read on reset
and Protocols
Key features
Display Format None Decimal Places 0
Coding RW
This parameter controls the rate at which PTP Sync frames are sent. The message rate
PC Applications
is determined by raising 2 to the power of this parameter. E.g the default value here of -
4 results in sixteen sync messages per second.
Default 20 Units s
Type 8 Bit User Save Update Rate Read on reset
Diagnostics
(S.11.008)) is set.
For a system the duration depends upon the number of IEEE1588 capable master
devices on the network. To use lower values here the number of devices which are
capable of acting as a synchronization master must be kept as low as possible by
Index
setting Preferred Sync Master (S.11.001) to 0 on all interfaces except those which may
be master.
Safety
1 Trip Trip drive with Slx.Er and sub-trip code
2 Do not use The data is ignored
Introduction
3 Use The data is used immediately
This parameter defines the action to be taken when a late synchronized frame is
received on the Rx1 link.
Mechanical
installation
S.11.041 Rx1 Late Synchronisation Frame Destination
Minimum 0 Maximum 4
Default 0 Units
installation
Electrical
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
Coding RW, TE, BU
Getting started
Value Text Description
0 This slot Trigger module event in this slot
1 Slot 1 Trigger module event in slot 1
Parameters
2 Slot 2 Trigger module event in slot 2
3 Slot 3 Trigger module event in slot 3
4 Slot 4 Trigger module event in slot 4
and Protocols
Key features
Defines the destination (slot) to trigger the event when a late synchronized frame is
received on the Rx1 link.
Default 0 Units
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
Diagnostics
0 No Event No event
terms
This parameter defines the action to be taken when a late synchronized frame is
received on the Rx2 link.
Defines the destination (slot) to trigger the event when a late synchronized frame is
received on the Rx2 link.
Introduction
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
Coding RW, TE, BU
Mechanical
installation
Value Text Description
0 No Event No event
1 Event Trigger module event
installation
Electrical
2 Event 1 Trigger module event 1
3 Event 2 Trigger module event 2
4 Event 3 Trigger module event 3
Getting started
Defines the event number to trigger in the given destination (slot) when a late
synchronized frame is received on the Rx2 link.
Parameters
S.11.060 Rx3 Late Synchronisation Frame Action
Minimum 1 Maximum 3
Default 1 Units
and Protocols
Key features
Type 8 Bit User Save Update Rate Read on reset
Display Format None Decimal Places 0
Coding RW, TE, BU
PC Applications
Value Text Description
1 Trip Trip drive with Slx.Er and sub-trip code
2 Do not use The data is ignored
Security
This parameter defines the action to be taken when a late synchronized frame is
Diagnostics
Defines the destination (slot) to trigger the event when a late synchronized frame is
received on the Rx3 link.
Defines the event number to trigger in the given destination (slot) when a late
synchronized frame is received on the Rx3 link.
information
Safety
S.15.001 Enable
Minimum 0 Maximum 1
Default 1 Units
Introduction
Type 1 Bit User Save Update Rate Background read
Display Format None Decimal Places 0
Coding RW, BU
This parameter is used to enable or disable Modbus master and slave functionality.
Mechanical
installation
S.15.002 Reset
Minimum 0 Maximum 1
installation
Default 0 Units
Electrical
Background read; written to
Type 1 Bit Volatile Update Rate
0 on initialization
Display Format None Decimal Places 0
Getting started
Coding RW, NC
This parameter is used to perform a warm reset of the protocol interface. When set and
the protocol has reset, the parameter will be reset to zero (Off).
Parameters
S.15.003 Default
Minimum 0 Maximum 1
Default 0 Units
On module reset, protocol
and Protocols
Key features
Type 1 Bit Volatile Update Rate interface reset or protocol
enable
Display Format None Decimal Places 0
Coding RW, NC
This parameter allows the protocol to be defaulted to factory settings. This includes all PC Applications
of the protocol features, configuration, mappings and stored objects.
Minimum 0 Maximum 3
Default Units
Module reset, Modbus
Diagnostics
information
request of the client or due to a communications error.
Safety
Any connections not in the priority connections pool are kept in the non-priority
connections pool. If a client attempts to establish a priority connection and all available
non-priority connections are in use, the non-priority connection that has not been used
Introduction
for the longest will be closed to make way for the new priority connection.
Mechanical
installation
Default 2 Units
Module reset, Modbus
Type 8 Bit User Save Update Rate interface reset or Modbus
interface enable
installation
Electrical
Display Format None Decimal Places 0
Coding RW, BU
This parameter defines the maximum number of priority connections that any one client
Getting started
can establish. This check is only performed on the connections in the priority
connections pool.
Parameters
Default 100 Units ms
Module reset, Modbus
Type 16 Bit User Save Update Rate interface reset or Modbus
interface enable
and Protocols
Key features
Display Format None Decimal Places 0
Coding RW, BU
This parameter defines the time period in which the Modbus server must receive a
PC Applications
message before any specified action (as defined in Modbus Timeout Action (S.15.010))
is performed. When the timeout occurs, bit 2 in the module's alarm parameter (Active
Alarm Bits (S.00.009)) will be set and the specified action will be performed.
The timeout is enabled when the server receives its first message.
Security
NOTE It is good system design to allow for some message loss by setting the timeout duration
to be greater than the transmit period by a factor of 2 or more.
Diagnostics
Defines the action when no message is received within the time period specified in
Modbus Timeout (S.15.009).
Defines the destination slot to trigger the event (defined by Modbus Timeout Event Type
(S.15.012)) when a timeout occurs.
Safety
0 No event No event
1 Trigger Event Trigger module Event
Introduction
2 Trigger Event 1 Trigger module Event 1
3 Trigger Event 2 Trigger module Event 2
4 Trigger Event 3 Trigger module Event 3
5 Trigger Event 4 Trigger module Event 4
Mechanical
installation
Defines the event to trigger when a timeout occurs. Modbus Timeout Event Destination
(S.15.011) must specify an appropriate consumer (slot option) of the event.
installation
This feature is not yet implemented.
Electrical
NOTE
Getting started
Minimum 0 Maximum 1
Default 0 Units
Module reset, Modbus
Type 8 Bit User Save Update Rate interface reset or Modbus
interface enable
Parameters
Display Format None Decimal Places 0
Coding RW, TE, BU
and Protocols
Key features
0 Standard (mm x 100) + ppp - mm<=162 and ppp<=99
1 Modified (mm x 256) + ppp - mm<=63 and ppp<=255
PC Applications
Specifies the Modbus register addressing mode.
0
Default Units
(Display: 0.0.0.0)
Module reset, Modbus
Diagnostics
Coding RW, BU
terms
information
to 20 parameters
Safety
• User selectable RPI timeout action
• Identity object (class 0x01)
• Motor data object (class 0x28)
Introduction
• Control supervisor object (class 0x29)
• AC/DC Drive object (class 0x2A)
• Control Techniques objects (classes 0x64 to 0x69)
• Explicit (non-cyclic) access to parameters
Mechanical
installation
EtherNet/IP server port
The Ethernet interface uses the standard server port 44818 (0xAF12) for EtherNet/IP
communications, this is fixed and cannot be changed.
installation
Electrical
Parameter Update Rate
Parameters are exchanged over the network. The value exchanged over the network
must be exchanged with the drive or option parameter. The rate of data exchange differs
Getting started
for drive and option destinations.
The diagram below depicts the update cycles used within the Ethernet interface. CIP
assembly mappings being exchanged with the drive will be updated at the background
task rate. This rate (Background cycles per second (S.09.008)) varies with the load on
the Ethernet interface; Easy Mode non-synchronized data exchange also takes place in
Parameters
the background task.
and Protocols
Key features
>=500 µs Synchronous 500 µs
Cyclic Links
PC Applications
R
I
V
E
Security
Network
Diagnostics
Background
>=1 ms Cyclic Links
Task
O
P
Glossary of
T
terms
I
O
N
S
Index
NOTE If either Input Assembly Object Size (S.20.020) or Output Assembly Object Size
(S.20.021) is a non zero value then the available mappings will still be consumed even
if the Ethernet/IP functionality is disabled.
S.20.002 Reset
Minimum 0 Maximum 1
Default 0 Units
Background read; written to
Type 1 Bit Volatile Update Rate
0 on initialization
Display Format Decimal Places 0
Coding RW, NC
This parameter is used to perform a warm reset of the protocol interface. When set and
the protocol has reset, the parameter will be reset to zero (Off).
S.20.003 Default
Minimum 0 Maximum 1
Default 0 Units
On module reset, protocol
Type 1 Bit Volatile Update Rate interface reset or protocol
enable
Display Format None Decimal Places 0
Coding RW, NC
This parameter allows the protocol to be defaulted to factory settings. This includes all
of the protocol features, configuration, mappings and stored objects.
Safety
0 No error No error
1 RPI event dst RPI timeout event destination not valid
Introduction
2 RPI event type RPI timeout event type not valid
3 IDLE event dst PLC IDLE event destination not valid
4 IDLE event type PLC IDLE event type not valid
5 Input mapping Input mapping parameter not valid
Mechanical
installation
6 Output mapping Output mapping parameter not valid
7 In cons trig pr Input consistency trigger parameter not valid
8 Out cons trig pr Output consistency trigger parameter not valid
installation
Electrical
This parameter is used to display the error code if an EtherNet/IP configuration error
occurs.
Getting started
S.20.007 Cyclic data transfers per second
Minimum 0 Maximum 65535
Default Units Messages/s
Type 16 Bit Volatile Update Rate Background
Parameters
Display Format None Decimal Places 0
Coding RO, ND, NC, PT, BU
This parameter shows the EtherNet/IP cyclic data transfer rate.
and Protocols
Key features
S.20.011 RPI timeout action
Minimum 0 Maximum 4
Default 3 Units
PC Applications
Module reset, EtherNet/IP
Type 8 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format None Decimal Places 0
Coding RW, TE, BU
Security
1 Send flt values Send configured fault values to the output parameters
PLC output parameters will have their values set to
2 Clear output
zero
Glossary of
terms
This timeout is defined by the EtherNet/IP protocol and is configured in the PLC master.
Index
The interface will monitor the data traffic and if data is not received within the specified
time, it will perform the requested action. This indicates that the interface has detected
This parameter defines the destination slot to trigger the event upon an RPI timeout.
Safety
Minimum 0 Maximum 5
Default 0 Units
Module reset, EtherNet/IP
Introduction
Type 8 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format None Decimal Places 0
Coding RW, TE, BU
Mechanical
installation
Value Text Description
0 No event No event
installation
Electrical
1 Trigger Event Trigger module Event
2 Trigger Event 1 Trigger module Event 1
3 Trigger Event 2 Trigger module Event 2
Getting started
4 Trigger Event 3 Trigger module Event 3
5 Trigger Event 4 Trigger module Event 4
Defines the event to trigger in the specified destination (RPI timeout event destination
Parameters
(S.20.012)) upon an RPI timeout.
and Protocols
Key features
Minimum 0 Maximum 4
Default 4 Units
Module reset, EtherNet/IP
PC Applications
Type 8 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format None Decimal Places 0
Coding RW, TE, BU
Security
1 Send flt values Send configured fault values to the output parameters
PLC output parameters will have their values set to
2 Clear output
zero
Glossary of
This parameter defines the action to be taken upon a PLC idle event.
Index
This parameter defines the destination slot to trigger the event upon a PLC idle event.
Defines the event to trigger in the specified destination (PLC idle event destination
(S.20.016)) upon a PLC idle event.
Introduction
Module reset, EtherNet/IP
Type 8 Bit Volatile Update Rate interface reset or EtherNet/
IP interface enable
Display Format None Decimal Places 0
Coding RO, TE, NC, PT, BU
Mechanical
installation
Value Text Description
0 100-PrimaryI Primary input (100)
installation
Electrical
1 70-BscSpdCtrlI Basic speed control input (70)
2 71-ExtSpdCtrlI Extended speed control input (71)
Getting started
3 72-SpdTqCtrlI Speed and torque control input (72)
4 73-ExtSpdTqCtrlI Extended speed and torque control input (73)
This parameter defines and shows the required input assembly object.
Parameters
S.20.019 Active output assembly object
Minimum 0 Maximum 4
Default 0 Units
Module reset, EtherNet/IP
and Protocols
Type 8 Bit Volatile Update Rate interface reset or EtherNet/
Key features
IP interface enable
Display Format None Decimal Places 0
Coding RO, TE, NC, PT, BU
PC Applications
Value Text Description
0 101-PrimaryO Primary output (101)
1 20-BscSpdCtrlO Basic speed control output (20)
Security
This parameter defines and shows the required output assembly object.
Glossary of
terms
Index
Safety
Minimum 0 Maximum 1
Default 0 Units
Module reset, EtherNet/IP
Introduction
Type 1 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format None Decimal Places 0
Coding RW
Mechanical
installation
This parameter allows for enabling and disabling input assembly object consistency.
Under normal conditions, cyclic data is sampled and transmitted at the Requested
Packet Interval (RPI). However, if an option module was in the process of modifying the
installation
Electrical
mapped parameters while these parameters were being sampled, then the data
transmitted across the network may not be consistent across the entire assembly
object. If read consistency is enabled (and a trigger parameter specified in Input
assembly object consistency trigger parameter (S.20.027)) then data will only be
Getting started
sampled and transmitted to the PLC or EtherNet/IP master when the trigger parameter
Input assembly object consistency trigger parameter (S.20.027) contains a non-zero
value. This trigger parameter will then be set to zero after the data has been transmitted.
It is therefore possible, by controlling the trigger parameters, that a user program in the
drive or option module can ensure that the values in the cyclic data parameters are not
Parameters
sampled until all values are updated.
Whether consistency is enabled or not, data will always be consistent for an individual
parameter, i.e. all 4 bytes of a 32 bit value will be consistent.
NOTE If read consistency is enabled, then at reset or at power-up, the value in the trigger
and Protocols
Key features
parameter is set to zero.
PC Applications
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
0
Default Units
(Display: 0.00.000)
Module reset, EtherNet/IP
Security
Coding RW, BU
This parameter specifies the parameter to use for triggering input assembly object
consistency. See Input assembly object consistency enable (S.20.026) for more
information on consistency.
Glossary of
terms
Index
Consistency enabled
When the output consistency is enabled, the value in Output assembly object
consistency trigger parameter (S.20.029) is checked at the beginning of the writing
routine. If it is zero then the PLC or EtherNet/IP master output values are written to the
cyclic data destination parameters and the trigger parameter is set to one. If the output
trigger parameter value is non-zero then the output values are not written to the
destination parameters.
NOTE If write consistency is enabled, then at reset or at power-up, the value in the trigger
parameter is set to one.
Consistency disabled
When the output consistency is disabled, the output values are written to the cyclic data
destination parameters at the background task rate after it has been received.
information
Safety
Minimum 0 Maximum 1
Default 0 Units
Module reset, EtherNet/IP
Introduction
Type 8 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format None Decimal Places 0
Coding RW, TE, BU
Mechanical
installation
Value Text Description
0 257 - CT EtherNet/IP interface
installation
Electrical
1 553 - CT AMERICA EtherNet/IP America interface
Getting started
S.20.031 Custom product code
Minimum 0 Maximum 65535
Default 0 Units
Module reset, EtherNet/IP
Type 16 Bit User Save Update Rate interface reset or EtherNet/
Parameters
IP interface enable
Display Format None Decimal Places 0
Coding RW, BU
This parameter defines a custom product type value which is used to identify the
and Protocols
Key features
product on the network.
PC Applications
Minimum 0 Maximum 65535
Default 0 Units
Module reset, EtherNet/IP
Type 16 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Security
information
Safety
Minimum 0 Maximum 4
Default 2 Units
Type 8 Bit User Save Update Rate Reset
Introduction
Display Format None Decimal Places 0
Coding RO, TE, PT, BU
Mechanical
installation
0 2-FC DC FC DC Motor
1 6-WRI Wound Rotor Induction Motor
2 7-SCI Squirrel Cage Induction Motor
installation
Electrical
3 9-Sin PM BL Sinusoidal PM BL Motor
4 10-Trap PM BL Trapezoidal PM BL Motor
Getting started
This parameter defines the type of motor 2.
Parameters
S.21.001 Input mapping parameter 1
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
and Protocols
Key features
10040
Default Units
(Display: 0.10.040)
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
PC Applications
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
Security
2001
Default Units
(Display: 0.02.001)
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
Glossary of
terms
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
Index
information
0 499999
Safety
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
0
Default Units
(Display: 0.00.000)
Introduction
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Mechanical
installation
Coding RW, DE, PT, BU
installation
Electrical
(Display: 0.00.000) (Display: 4.99.999)
0
Default Units
(Display: 0.00.000)
Getting started
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
Parameters
S.21.009 Input mapping parameter 9
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
and Protocols
0
Key features
Default Units
(Display: 0.00.000)
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
PC Applications
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
0
Diagnostics
Default Units
(Display: 0.00.000)
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Glossary of
terms
Introduction
Default Units
(Display: 0.00.000)
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Mechanical
installation
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
installation
Electrical
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
0
Getting started
Default Units
(Display: 0.00.000)
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Parameters
Coding RW, DE, PT, BU
and Protocols
Minimum Maximum
Key features
(Display: 0.00.000) (Display: 4.99.999)
0
Default Units
(Display: 0.00.000)
PC Applications
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
Security
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
Index
information
Safety
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
1021
Default Units
Introduction
(Display: 0.01.021)
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Mechanical
installation
Coding RW, DE, PT, BU
installation
Electrical
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
0
Default Units
(Display: 0.00.000)
Getting started
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
Parameters
S.22.004 Output mapping parameter 4
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
and Protocols
Key features
0
Default Units
(Display: 0.00.000)
Module reset, EtherNet/IP
PC Applications
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
Security
0
Default Units
(Display: 0.00.000)
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
Glossary of
terms
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
Index
information
Safety
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
0
Default Units
Introduction
(Display: 0.00.000)
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Mechanical
installation
Coding RW, DE, PT, BU
installation
Electrical
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
0
Default Units
Getting started
(Display: 0.00.000)
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Parameters
Coding RW, DE, PT, BU
and Protocols
(Display: 0.00.000) (Display: 4.99.999)
Key features
0
Default Units
(Display: 0.00.000)
Module reset, EtherNet/IP
PC Applications
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
Security
0
Default Units
(Display: 0.00.000)
Module reset, EtherNet/IP
Glossary of
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
Index
information
Safety
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
0
Default Units
Introduction
(Display: 0.00.000)
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Mechanical
installation
Coding RW, DE, PT, BU
installation
Electrical
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
0
Default Units
(Display: 0.00.000)
Getting started
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
Parameters
S.22.020 Output mapping parameter 20
0 499999
Minimum Maximum
(Display: 0.00.000) (Display: 4.99.999)
and Protocols
Key features
0
Default Units
(Display: 0.00.000)
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
PC Applications
IP interface enable
Display Format Slot Menu Param Decimal Places 0
Coding RW, DE, PT, BU
Security
Diagnostics
Glossary of
terms
Index
Safety
Minimum -2147483648 Maximum 2147483647
Default 0 Units
Module reset, EtherNet/IP
Introduction
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format None Decimal Places 0
Coding RW, PT
Mechanical
installation
S.23.006 Output Fault value 6
Minimum -2147483648 Maximum 2147483647
installation
Default 0 Units
Electrical
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Getting started
Display Format None Decimal Places 0
Coding RW, PT
Parameters
Minimum -2147483648 Maximum 2147483647
Default 0 Units
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
and Protocols
IP interface enable
Key features
Display Format None Decimal Places 0
Coding RW, PT
PC Applications
S.23.008 Output Fault value 8
Minimum -2147483648 Maximum 2147483647
Default 0 Units
Module reset, EtherNet/IP
Security
Coding RW, PT
Glossary of
terms
Index
Safety
Minimum -2147483648 Maximum 2147483647
Default 0 Units
Module reset, EtherNet/IP
Introduction
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Display Format None Decimal Places 0
Coding RW, PT
Mechanical
installation
S.23.014 Output Fault value 14
Minimum -2147483648 Maximum 2147483647
installation
Default 0 Units
Electrical
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
Getting started
Display Format None Decimal Places 0
Coding RW, PT
Parameters
Default 0 Units
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
IP interface enable
and Protocols
Key features
Display Format None Decimal Places 0
Coding RW, PT
PC Applications
S.23.016 Output Fault value 16
Minimum -2147483648 Maximum 2147483647
Default 0 Units
Module reset, EtherNet/IP
Type 32 Bit User Save Update Rate interface reset or EtherNet/
Security
IP interface enable
Display Format None Decimal Places 0
Coding RW, PT
Diagnostics
Glossary of
terms
Index
information
Safety
This section details the key features and protocols supported by the onboard Ethernet
interface and the SI-Ethernet option module.
Introduction
If the subnet of the host PC/PLC is different to the subnet of the Ethernet interface, then
both the Ethernet interface and the PC/PLC, must be configured with the address of a
gateway that allows communication between the two devices.
Mechanical
installation
7.2 Modbus TCP/IP
Modbus TCP/IP is one of the most widely supported industrial Ethernet based protocols
offering the functionality and simplicity of the Modbus protocol, with the flexibility of
Ethernet. Table 7.1 shows the supported Modbus function codes.
installation
Electrical
Modbus TCP/IP uses the standard Protocol Data Unit (PDU) but without the CRC bytes
and encapsulates it within a Modbus TCP/IP Application Data Unit (ADU) for
transmission. This means that the Modbus PDU is the same for both standard (RTU)
and Ethernet based transmission.
Getting started
Table 7.1 Supported Modbus function codes
Code Description
3 Read multiple 16 bit registers.
6 Write single 16 bit register.
Parameters
16 Write multiple 16 bit registers.
23 Read and write multiple 16 bit registers.
and Protocols
Key features
7.2.1 Modbus TCP/IP port
The port number used for Modbus TCP/IP may be reconfigured to a different port
number using Pr S.15.005 as detailed below.
PC Applications
S.15.005 Modbus Listening Port
Minimum 0 Maximum 65535
Default 502 Units
MODBUS_THREAD_TICK
Type 16 Bit User Save Update Rate
_TIME
Security
Modbus ADU
Length
Field Description
(Bytes)
Transaction Identifier 2 Uniquely identifies the transaction (0 to 65535)
Protocol Identifier 2 Identifies the protocol (0 = Modbus)
Length 2 Number of following bytes in the message
Unit Identifier 1 Uniquely identifies the destination node (0 to 255)
The unit identifier within the MBAP header is used to identify whether the destination
node is the host drive or an option module (not available on the onboard Ethernet
interface with firmware versions prior to V01.02.01.10).
Table 7.3 MBAP Unit Identifier
information
Data access using Modbus TCP/IP takes the form of a request for data by the master,
Safety
followed by a response from the slave indicating success or failure. If no response is
received this indicates that the message has not been received or the message is
invalid or the node is unable to reply.
Introduction
Each drive or option module parameter is internally mapped to a single 16-bit Modbus
register, all Modbus function codes access 16-bit registers only. To access a 32-bit
parameter, two contiguous Modbus registers must be specified in the request and the
32-bit data access scheme must be used.
Mechanical
installation
7.2.4 32-bit data access
Standard Modbus registers are 16 bits in size and reference a single drive/option
module parameter. To access a 32-bit data value the multiple read/write services must
be used to transfer a contiguous array of 16-bit registers. To instruct the client to select
installation
Electrical
either 16-bit or 32-bit access bit 14 of the register address is used.
NOTE Bit b15 of the register address is reserved for future use.
Getting started
Figure 7-2 Data type selection
Parameters
and Protocols
Key features
PC Applications
If 32-bit data type is selected then this effectively adds 16384 (0x4000) to the start
register address.
e.g. For drive parameter Pr 01.021 in standard addressing mode, the start register
value is 16384 + 120 = 16504 (0x4078)
Security
Function Code
Description
Decimal Hex (0x)
Glossary of
NOTE A reset is not required to activate the change, the addressing mode is effectively made
active immediately on changing.
The Modbus slave device increments the register address by 1 before processing the
command, this effectively prevents access to parameter Pr 00.000 in the drive or option
module.
The table below shows how the start register address is calculated for both addressing
modes.
Table 7.5 Start register addressing
Examples
16-bit 32-bit
Decimal Hex (0x) Decimal Hex (0x)
Standard 120 00 78 16504 40 78
0.01.021
Modified 276 01 14 16660 41 14
Standard 99 00 63 16483 40 63
0.01.000
Modified 255 00 FF 16639 40 FF
information
This function code allows a contiguous array of registers to be read. The maximum
Safety
number of registers that can be read is 120, this allows up to 120 16-bit parameters or
60 32-bit parameters to be read in a single transaction. If this is exceeded the server
will issue an exception response code 2.
Introduction
Master request data Slave response data
Mechanical
installation
Start register address Length of data in read block
8 8
(MSB) (Bytes)
Start register address Register data
9 9
(LSB) (MSB)
installation
Electrical
Number of 16-bit registers Register data
10 10
(MSB) (LSB)
Number of 16-bit registers
Getting started
11
(LSB)
The normal response includes the function code, number of data bytes in the read
block followed by the register data (unless an exception occurs).
If 32-bit parameter addressing is used, then for each parameter read:
Parameters
• Two 16-bit registers must be used in the request
• The register data in the response will contain 4 bytes of data
Example
and Protocols
To read drive parameters 0.20.021 to 0.20.023 (transaction ID = 42) with 32-bit data
Key features
access and standard addressing:
Master request data Slave response data
PC Applications
Hex Hex
Byte Description Byte Description
value value
0-1 00 2A Transaction ID (42) 0-1 00 2A Transaction ID (42)
2-3 00 00 Protocol ID (0=TCP/IP) 2-3 00 00 Protocol ID (0=TCP/IP)
Security
Example
To write the value 12345 to drive parameter 0.20.001 (transaction ID = 42) using
standard addressing:
Master request data Slave response data
information
This function code allows a contiguous series of registers to be written. The maximum
Safety
number of registers that can be written is 120, this allows up to 120 16-bit parameters
or 60 32-bit parameters to be read in a single transaction. If this is exceeded the server
will issue an exception response code 2.
Introduction
The normal response includes the function code, start register address and number of
16-bit registers written (unless an exception occurs), returned after the parameters
have been written.
If 32-bit parameter addressing is used, then for each parameter written:
Mechanical
installation
• Two 16-bit registers must be used in the request
• Four bytes must be specified in the request
• The number of registers written in the response will be twice the number of
parameters written
installation
Electrical
Master request data Slave response data
Getting started
7 Function code 0x10 7 Function code 0x10
Start register address Start register address
8 8
(MSB) (MSB)
Start register address Start register address
9 9
Parameters
(LSB) (LSB)
Number of 16-bit registers Number of 16-bit registers written
10 10
(MSB) (MSB)
Number of 16-bit registers Number of 16-bit registers written
11 11
and Protocols
Key features
(LSB) (LSB)
Length of register data to write
12
(Bytes)
PC Applications
Register data
13
(MSB)
Register data
14
(LSB)
Security
Diagnostics
Glossary of
terms
Index
Hex Hex
Byte Description Byte Description
value value
Transaction ID Transaction ID
0-1 00 2A 0-1 00 2A
(42) (42)
Protocol ID Protocol ID
2-3 00 00 2-3 00 00
(0=TCP/IP) (0=TCP/IP)
Length Length
4-5 00 06 4-5 00 0F
(Bytes=6) (Bytes=15)
Unit identifier Unit identifier
6 FF 6 FF
(FF= Drive) (FF= Drive)
Function code Function code
7 10 7 10
(16) (16)
Start register Start register
8-9 47 E4 8-9 47 E4
(20.020) (20.020)
Number of registers Registers written
10-11 00 06 10-11 00 06
(6) (6)
Register data length
12 0C
(Bytes)
00 00
13-16 Register data 0
30 39
00 00
17-20 Register data 1
30 39
00 00
21-24 Register data 2
30 39
information
This function code allows a contiguous series of registers to be written and another
Safety
contiguous series of registers to be read. The maximum number of registers that can
be read is 120 and similarly the maximum number of registers that can be written is
120, this allows up to 120 16-bit parameters or 60 32-bit parameters to be read and / or
Introduction
written in a single transaction. If this is exceeded the server will issue an exception
response code 2.
Mechanical
Byte Description Byte Description
installation
7 Function code 0x17 7 Function code 0x17
Start read register address Length of data in read block
8 8
(MSB) (Bytes)
installation
Electrical
Start read register address Register data
9 9
(LSB) (MSB)
Number of registers to read Register data
Getting started
10 10
(MSB) (LSB)
Number of registers to read
11
(LSB)
Start write register address
12
(MSB)
Parameters
Start write register address
13
(LSB)
Number of registers to write
14
and Protocols
(MSB)
Key features
Number of registers to write
15
(LSB)
Length of register data to write
PC Applications
16
(Bytes)
Register data 0
17
(MSB)
Register data 0
18
Security
(LSB)
The normal response includes the function code, number of data bytes in the read
block followed by the register data (unless an exception occurs).
Diagnostics
• For each parameter written, four bytes must be specified in the request
• For each parameter read, four bytes of data will be used in the response
Index
Hex Hex
Byte
value
Description Byte Description
value
Transaction ID Transaction ID
0-1 00 2A 0-1 00 2A
(42) (42)
Protocol ID Protocol ID
2-3 00 00 2-3 00 00
(0=TCP/IP) (0=TCP/IP)
Length Length
4-5 00 17 4-5 00 0F
(Bytes=6) (Bytes=15)
Unit identifier Unit identifier
6 FF 6 FF
(FF= Drive) (FF= Drive)
Function code Function code
7 17 7 17
(23) (23)
Start read register Length of data
8-9 47 E7 8 0C
(20.023) (Bytes=12)
Number of read registers ?? ?? Register data 0
10-11 00 06 9-12
(6) ?? ?? (Pr 20.024)
Start write register ?? ?? Register data 1
12-13 47 E4 13-16
(20.020) ?? ?? (Pr 20.025)
Number of write registers ?? ?? Register data 2
14-15 00 06 17-20
(6) ?? ?? (Pr 20.026)
Length of register data to
16 0C write
(Bytes=12)
00 00 Register data 0
17-20
30 39 (12345)
00 00 Register data 1
21-24
30 39 (12345)
00 00 Register data 2
25-28
30 39 (12345)
information
If the master request is rejected then an exception response message will be returned.
Safety
Exception Response Message
Introduction
0-1 ?? ?? Transaction ID (defined by Modbus Master)
2-3 00 00 Protocol ID
4-5 00 03 Number of data bytes to follow
Mechanical
installation
6 ?? Unit identifier
7 ?? Function code (request FC with bit b7 set to 1)
Exception code
8 ?? 01 = Function code not supported
installation
Electrical
02 = Invalid register address
The master request function code will be returned but with bit b7 set (e.g. function code
0x03 will be returned as 0x83)
Getting started
7.3 RTMoE (Real Time Motion over Ethernet)
This is a communication protocol developed to support the functionality previously
offered by CTNet and CTSync.
RTMoE provides:
Parameters
• Drive synchronization using the Precision Time Protocol (PTP) otherwise
known as IEEE1588 V2
Each PTP device has a tuneable clock running. Following an arbitration
process the devices select a master and tune their clocks until they are
and Protocols
Key features
synchronized to that master. This process may take several seconds to
complete.
• Data transfer
PC Applications
• Cyclic data (synchronous and non-synchronous) is sent using the
User Datagram Protocol (UDP)
• Non-cyclic data is sent using the Transmission Control Protocol
(TCP)
• Cycle time down to 500 µs
Security
• Via parameters using the Easy Mode menus (10 and 11)
The full capabilities of RTMoE are available only when using Machine Control Studio.
Table 7.6 shows the comparison between Easy Mode and Machine Control Studio
Glossary of
terms
support levels.
Index
Support Level
Capability Easy Mode Machine Control Studio
M200-M400 M600-M800 M200-M400 M600-M800
Non-cyclic communication Yes Yes Yes Yes
Total number of transmit
3 3 5 5
cyclic links
Total number of receive
3 3 5 5
cyclic links
Max transmit synchronous
N/A 1 N/A 1
links
Max receive synchronous
N/A 1 N/A 1
links
Max length of non-
10 x 32-bit 10 x 32-bit 10 x 32-bit 10 x 32-bit
synchronous link
Max length of synchronous
N/A 2 x 32-bit N/A 2 x 32-bit
link
Minimum transmission
10 ms 1 ms 10 ms 500 µs
period
Yes (when cycle Yes (when cycle
Synchronized with AMC N/A N/A
time >= 1 ms) time >= 500 µs)
Synchronized with onboard Yes (when cycle Yes (when cycle
N/A N/A
program time = 4 ms) time = 4 ms)
Max parameter accesses
200 6000 200 6000
per second
Max messages per second
8000 8000 8000 8000
(S.02.004)
information
When designing a network, the message loading for each device should be checked to
Safety
ensure the number of messages do not exceed the maximum recommended value.
Consider the following example where a Unidrive M700 is communicating with three
other devices over Ethernet using Modbus TCP/IP (10 parameters read every 100ms),
Introduction
EtherNet/IP (5 parameters read every 10ms and 5 parameters written every 10ms) and
RTMoE (2 parameters written every 500µs).
Mechanical
installation
Modbus TCP/IP 10 x read 100ms 100 10
5 x read 10ms 500 100
EtherNet/IP
5 x write 10ms 500 100
installation
Electrical
RTMoE 2 x write 500µs 4000 2000
Total 5100 2210
Maximum supported 6000 8000
Getting started
Within capability? 9 9
7.3.2 RTMoE Message type
From the system design, it should be known how many drives will be used and what
Parameters
data needs to be sent where. There are two fundamental ways of sharing data:
• Cyclic data – use cyclic links for important information relating to the dynamic
behavior of the machine (e.g. control word, speed reference, etc.)
• Non-cyclic data – used for non time-critical information (e.g. drive setup data)
and Protocols
Key features
A user program must be used to control the transfer of non-cyclic messages.
(see Non cyclic enable (S.02.035) and Non cyclic base parameter (S.02.036))
Each cyclic message can be one of three types:
PC Applications
Unicast – used if data needs to go
1
from one device to another
Security
2
from one device to all other devices
Glossary of
terms
NOTE Broadcast messages should be used with care, bottlenecks in the network can be
easily created by using broadcast messages, this will reduce the performance of the
network and, in extreme situations, seriously impair the system operation.
Unicast
A unicast link will only be processed by the specified destination address, the
transmitting device specifies the destination address in S.10.015, S.10.025 or S.10.035
(Tx1, Tx2 or Tx3 respectively) and the receiving link in the relevant device must be set
to “Direct” in S.10.044, S.10.054 or S.10.064 (Rx1, Rx2 or Rx3 respectively).
Multicast
A multicast link can be processed by more than one destination address, the
transmitting device configures the multicast address group (Multicast1, Multicast2,
Multicast3 or Multicast4) in S.10.014, S.10.024 or S.10.034 (Tx1, Tx2 or Tx3
respectively), the appropriate multicast destination address is automatically set in
S.10.015, S.10.025 or S.10.035 (Tx1, Tx2 or Tx3 respectively), a receiving link on the
same network must be configured to use the same multicast address group as specified
in S.10.014, S.10.024 or S.10.034 (Tx1, Tx2 or Tx3 respectively) in S.10.044, S.10.054
or S.10.064 (Rx1, Rx2 or Rx3 respectively).
Any device on the same network as the transmitting device may be configured to
receive a multicast message.
Each cyclic link can be configured for one of four multicast addresses, this means that
on any given network, there may be up to four groups of multicast addresses.
The multicast addresses used are in the local scope addresses ranging from
239.255.0.1 to 239.255.0.4.
Broadcast
A broadcast link can be processed by any device on the network, the transmitting
device sets the message type as “Broadcast” in S.10.014, S.10.024 or S.10.034 (Tx1,
Tx2 or Tx3 respectively), the broadcast IP address (255.255.255.255) will be
automatically set in S.10.015, S.10.025 or S.10.035 (Tx1, Tx2 or Tx3 respectively), a
receiving link on the same network must be configured to “Direct” in S.10.044, S.10.054
or S.10.064 (Rx1, Rx2 or Rx3 respectively).
Any device on the same network as the transmitting device may be configured to
receive a broadcast message.
information
There are three main reasons why a bottleneck occurs:
Safety
1. A drive is receiving more Ethernet messages than it can handle.
(8000 frames per second)
2. A drive is being asked to access more parameters than it can handle.
Introduction
(6000 parameters per second for M600, M700 and M800, 500 parameters per
second for M200, M300 and M400)
3. A segment of the network has reached it’s bandwidth limit.
For a full duplex 100Mbit/sec Ethernet network, assuming all Ethernet messages
Mechanical
installation
are the maximum 1500 bytes in length, the bandwidth is 8000 frames/sec in each
direction.
installation
• In reality the maximum number of frames/sec will be higher
Electrical
• A more detailed frame analysis may be performed if necessary but the values
stated can be used to quickly determine whether bottlenecks could be a problem
Getting started
7.3.4 RTMoE Message synchronization
Cyclic messages can be synchronized or non-synchronized.
Only one synchronized cyclic link in each direction (one transmit and one receive) is
possible so these should only be used for high precision applications where the motion
of multiple drives must be closely coupled (e.g. printing applications). All other
Parameters
messages should be sent using a non-synchronized cyclic link.
By default, all cyclic links are non-synchronous, if a synchronous link is required then
the relevant link number profile for both the transmit link and receive link must be set to
“Sync”.
and Protocols
Key features
Synchronized cyclic data links utilise the IEEE1588 clock time distributed across the
network. The IEEE1588 clock can synchronize the drive's control loops to within a 1µs
accuracy, Pr 0.11.002 Option Synchronisation Active displays the active option slot
providing synchronization. With synchronized control loops the Ethernet interface can
PC Applications
be used to transfer drive parameters containing motion information, including those
from the AMC.
Synchronous links work by including the time of when the data should be used along
with the data values. This time allows enough time for the cyclic link to reach all
destination devices, the time allowed for can be set in Easy Mode Maximum Network
Security
Delay (S.11.030). The receiving interface will wait for its current time to match the
timestamp in the cyclic link before processing the message.
With normal Ethernet there are a number of variables that can impact upon the
Diagnostics
• Message length – the longer a message, the longer it will take to transmit and copy
into a switch before forwarding it on. For a synchronous cyclic link frame this delay
is 12µs, for a full Ethernet frame it is 120 µs.
Message length can be controlled, but to maximise compatibility with other Ethernet
Index
traffic, it is sensible to allow for full frame Ethernet messages where possible.
information
Safety
Introduction
Mechanical
installation
installation
Electrical
Getting started
Parameters
and Protocols
Key features
NOTE Configuring a single drive to act as both gateway and synchronization master will PC Applications
increase the message loading on that drive, in some situations this may result in a
reduction of the network performance. In these situations, separate drives should be
used for the gateway and synchronization master.
Security
Diagnostics
Glossary of
terms
Index
Receive Link
information
To guarantee the timing of synchronous links VLANs must be enabled using VLAN
Safety
Enable (S.02.030). VLANs include a priority field that is applied to all messages. This
field is used to apply a higher priority to synchronous cyclic data than other non-
deterministic traffic.
Introduction
7.3.10 Virtual Master
It is possible to send cyclic data to devices on the network and use the same data on
the transmitting device. The cyclic links must be synchronous to include timing
information. On the transmitting device a receive link must also be configured with a
Mechanical
installation
matching link number to the transmit link. For this link you must set Rx1 Source Type
(S.10.044) to be Local. The Ethernet interface will delay the usage of the data
transmitted until the same point in time that all receiving slaves will use the data.
installation
Electrical
7.3.11 Parameter Update Rate
Parameters are exchanged over the network. The value exchanged over the network
must be exchanged with the drive or option parameter. The rate of data exchange
Getting started
differs for synchronous and non-synchronous cyclic links as well as for drive and option
destinations.
The diagram below depicts the update cycles used within the Ethernet interface. Cyclic
link mappings being exchanged with the drive will be updated at the background task
rate. This rate (Background cycles per second (S.09.008)) varies with the load on the
Parameters
Ethernet interface; EtherNet/IP data exchange also takes place in the background task.
and Protocols
Key features
>=500 µs Synchronous 500 µs
Cyclic Links
PC Applications
R
I
V
E
Security
Network
Diagnostics
Background
>=1 ms Cyclic Links
Task
O
P
T
Glossary of
I
terms
O
N
S
Index
The base address specifies the first parameter in a group of seven consecutive
parameters that will be used to read from or write to a parameter in the drive or option
module at the specified IP address by a user program.
The non-cyclic data access feature operates on a “state machine” principle, this means
that the commands must be sent in the correct sequence otherwise the parameter
access will fail.
The following diagram illustrates the operation of the non-cyclic parameter access state
machine.
139
Figure 7-4 Non-cyclic parameter access state machine
information
The destination slot and menu address is sent in the format SMM, where S is the slot
Safety
number and MM is the two digit menu number.
Examples
• For the drive application menu 3, the value sent would be “20”.
Introduction
• For the SI-Applications Plus register 70 in slot 3, the value sent would be “370”.
Mechanical
installation
7.4.3 Setting the destination parameter address (Base address + 4)
The destination parameter address is sent in the format PPP, where PPP is the three
digit parameter number.
installation
Electrical
Examples
• For parameter “021”, the value sent would be “21”.
• For parameter “104”, the value sent would be “104”.
Getting started
7.4.4 Setting the parameter value to write
The destination parameter value is sent in two signed 16-bit values, therefore it must
be converted into two signed 16-bit words.
Parameters
Base address + 5 (LSW)
The least significant word of the parameter value is converted to a signed 16-bit value
stored in a 32-bit variable by bitwise ANDing it with the hexadecimal value 0x00007FFF
and subtracting the decimal value 32768 if the result was greater than the decimal
value 32767.
and Protocols
Key features
Base address + 6 (MSW)
The most significant word of the parameter value is converted to a signed 16-bit value
stored in a 32-bit variable by bitwise shifting it 16 places right and bitwise ANDing the
PC Applications
result with the hexadecimal value 0x00007FFF, then subtracting the decimal value
32768 if the most significant bit is set to 1.
Examples
Security
MSW LSW
Value to write
Decimal Hex Decimal Hex
3515 0 00000000 3515 00000DBB
Diagnostics
information
Safety
// Read complete
// Get the LSW value
Address% = BaseAddress% + 5
LSW% = #Address%
Introduction
// Get the MSW value
Address% = BaseAddress% + 6
MSW% = #Address%
Mechanical
installation
Value% = (LSW% & 0x0000FFFF) | ((MSW% << 16) & 0xFFFF0000)
installation
Electrical
IF Bit32% = 0 THEN
// 16 bit
IF Value%.15 = 1 THEN
// Correct for negative number
Getting started
Value% = Value% - 65536
ENDIF
ENDIF
Parameters
NOTE BaseAddress% is the parameter specified in S.02.036.
Bit32% specifies the source parameter as 16-bit or 32-bit (0 = 16-bit. 1 = 32-bit).
and Protocols
Key features
PC Applications
Security
Diagnostics
Glossary of
terms
Index
NOTE The RPI timeout action will only occur on a loss of cyclic data message, i.e. after cyclic
data has been established and subsequently lost. No action will be taken if no cyclic data
has been detected.
7.5.2 Read consistency
Under normal conditions, cyclic data is sampled and transmitted at the Requested
Packet Interval (RPI). However, if an option module was in the process of modifying the
mapped parameters while these parameters were being sampled, then the data
transmitted across the network may not be consistent across the entire assembly
object. If read consistency is enabled (S.20.026 Input assembly object consistency
enable) and a trigger parameter specified in Input assembly object consistency trigger
parameter (S.20.027) then data will only be sampled and transmitted when the trigger
parameter Input assembly object consistency trigger parameter (S.20.027) contains a
non-zero value. This trigger parameter will then be set to zero after the data has been
sampled.
It is therefore possible, by controlling the trigger parameters, that a user program in the
drive or option module can ensure that the values in the cyclic data parameters are not
sampled until all values are updated.
Whether consistency is enabled or not, data will always be consistent for an individual
parameter, i.e. all 4 bytes of a 32-bit value will be consistent.
information
Under normal conditions, cyclic data is sampled and written at the Requested Packet
Safety
Interval (RPI). However, if an option module was in the process of reading the mapped
parameters while these parameters were being written, then the data obtained may not
be consistent across the entire assembly object. If write consistency is enabled (Output
Introduction
assembly object consistency enable (S.20.028)) and a trigger parameter specified in
Output assembly object consistency trigger parameter (S.20.029) then new data will
only be written to the drive (or option module) when the trigger parameter Output
assembly object consistency trigger parameter (S.20.029) contains a value of zero. This
trigger parameter will then be set to one after the data has been written.
Mechanical
installation
It is therefore possible, by controlling the trigger parameters, that a user program in the
drive or option module can ensure that the values in the cyclic data parameters are not
sampled until all values are updated.
Whether consistency is enabled or not, data will always be consistent for an individual
installation
Electrical
parameter, i.e. all 4 bytes of a 32-bit value will be consistent.
Example
In this example, Pr 0.18.031 is set as the input trigger and Pr 0.18.032 is set as the
Getting started
output trigger. The EtherNet/IP master is configured to check the values of Pr 0.20.011
and Pr 0.20.012 are equal and write the same value to Pr 0.20.021. The SI-Applications
Plus module is configured to generate a ramp value between -32768 and 32767 to write
to Pr 0.20.011 and Pr 0.20.012 when the value of Pr 0.20.021 is equal to the ramp
value.
Parameters
With the input and output consistency enabled, parameters Pr 0.20.011 and Pr 0.20.012
will be sampled and transmitted to the EtherNet/IP master when the input trigger
parameter Pr 0.18.031 is a non-zero value, Pr 0.20.021 will be written to when the
output trigger parameter Pr 0.18.032 is a value of zero.
and Protocols
Key features
The parameter changes required are:
S.20.020 Input assembly object size = 8 (bytes)
S.20.021 Output assembly object size = 4 (bytes)
PC Applications
S.20.026 In Consistency Enable = On
S.20.027 In Consistency Trigger Param = 0.18.031
S.20.028 Out Consistency Enable = On
S.20.029 Out Consistency Trigger Param = 0.18.032
S.21.001 Input mapping parameter 1 = 0.20.011
Security
} //Initial
Background{
top:
IF #18.32 = 1 THEN
// Output trigger set
// Check first sum value against NewValue
IF #20.021 = NewValue% THEN
// OK increment values by 1
NewValue% = NewValue% + 1
IF NewValue% > 32767 THEN NewValue = -32768
#20.011 = NewValue%
#20.012 = NewValue%
information
// ERROR - set DOP0 ON
Safety
#86.03 = 1
ENDIF
ENDIF
Introduction
goto top: // main background loop
} //Background
Mechanical
installation
7.5.4 Non-cyclic (explicit) data transfer
Non-cyclic or explicit messaging is used to read and write parameters non-cyclically by
means of assembly objects. All of the AC Drives profile attributes can be accessed
using explicit messaging.
installation
Electrical
The Control Techniques objects provide access to all drive and slot parameters using
the following format.
Getting started
Object CT Group CT This Slot CT Slot 1 CT Slot 2 CT Slot 3 CT Slot 4
Class code 100 (0x64) 101 (0x65) 102 (0x66) 103 (0x67) 104 (0x68) 105 (0x69)
Instance Menu
Attribute Parameter
Read code 14 (0x0E) Get_Attribute_Single
Parameters
Write code 16 (0x10) Set_Attribute_Single
NOTE An instance value of 0 is not a valid value in this context, therefore an instance value of
200 (0xC8) should be used to access menu 0 parameters. For more information on the
and Protocols
Key features
Control Techniques object see section 7.5.22 Control Techniques objects on page 178.
7.5.5 Cyclic (implicit or polled) data transfer
Cyclic data is a method of data transfer that must be setup during network configuration,
PC Applications
but is transmitted automatically at the determined rate once configuration is complete.
EtherNet/IP transfers cyclic data using assembly objects, “cyclic data” is sometimes
referred to as “Polled data” or “implicit data”.
The terms “input” and “output” refer to data from the perspective of the PLC, an “output”
assembly object transfers data from the PLC to the drive, an “input” assembly object
Security
NOTE Some PLCs provide the option of transmitting a configuration assembly object. The
Diagnostics
Ethernet interface does not use a configuration object; if one is required by the PLC then
instance 1 should be specified with a length of 0 bytes.
In order to use cyclic data over EtherNet/IP, the EtherNet/IP interface must be
configured to map the required parameter data to the assembly object.
For drive parameter access, object 100 (0x64) is used for reading parameters and
object 101 (0x65) is used for writing parameters. The pre-defined assembly objects as
Index
listed in Table 7.8 Supported drive assembly objects can also be configured as cyclic
data.
NOTE Although the Allen Bradley PLCs are mentioned in this document, this does not repre-
sent an endorsement of any particular PLC type or PLC manufacturer.
When configuring the PLC for cyclic communication with Unidrive M, the length of each
parameter data word and the number of parameters must be specified correctly, Figure
7-5, shows the PLC configuration for 20 input parameters and 20 output parameters, as
each parameter consists of 32 bits (4 bytes), the length of each data word should be set
to 32 bits (DINT - double integer word).
The length of each data word must normally be configured when the Ethernet module is
created within the PLC and can not be changed. If a different length is required then a
new Ethernet module must be created.
In order to communicate with the Unidrive M, the PLC must have the Ethernet IP
address set correctly as illustrated in Figure 7-5.
Figure 7-5 PLC configuration
information
Safety
Assembly Class Length Default Mappings
object name Type
Decimal Hex (0x) (Bytes) Bytes 0 to 3 Bytes 4 to 7
Introduction
PrimaryI 100 64 4 to 80 Input 0.10.040 0.02.001
BscSpdCtrlI 70 46 4 Input
ExtSpdCtrlI 71 47 4 Input
Mechanical
installation
SpdTrqCtrlI 72 48 6 Input
ExtSpdTrqCtrlI 73 49 6 Input
installation
Electrical
PrimaryO 101 65 4 to 80 Output 0.06.042 0.01.021
BscSpdCtrlO 20 14 4 Output
ExtSpdCtrlO 21 15 4 Output
Getting started
SpdTrqCtrlO 22 16 6 Output
ExtSpdTrqCtrlO 23 17 6 Output
Parameters
7.5.9 Basic speed control
Output assembly object 0x14 (2010)
The PLC or scanner must be configured for 4 output bytes (or 2 output words) if this
and Protocols
Key features
assembly object is to be used.
PC Applications
Data word Function
Word 0 Basic control word.
Word 1 Speed reference (SpeedRef).
The basic control word consists of 2 bytes (16 bits), with only 2 bits of the low byte being
used as shown below.
b15 b14 b13 b12 b11 b10 b9 b8
Diagnostics
b7 b6 b5 b4 b3 b2 b1 b0
FaultRst RunFwd
Glossary of
terms
Index
NOTE For the drive to run at the speed specified in Word 1, Pr 0.06.043 must be ON and bit 0,
bit 7 and bit 8 of the drive control word (Pr 0.06.042) must all be set to 1 and the external
hardware enable signal must be present.
The individual bit functions for the drive control word are shown in Table 7.10 below.
Table 7.10 Drive control word bit functions
The speed reference word utilises 2 bytes (16 bits) as shown below.
b7 b6 b5 b4 b3 b2 b1 b0
SpeedRef (low byte)
For more information on the setting of the speed reference see section 7.31 AC/DC
Drive object attributes on page 174.
information
Output assembly object 0x15 (2110)
Safety
The PLC or scanner must be configured for 4 output bytes (or 2 output words) if this
assembly object is to be used.
Table 7.11 Extended speed control
Introduction
Data word Function
Word 0 Extended control word.
Word 1 Speed reference (SpeedRef).
Mechanical
installation
Extended control word
The extended control word consists of 2 bytes (16 bits), with only the low byte used as
shown.
installation
Electrical
b15 b14 b13 b12 b11 b10 b9 b8
Getting started
b7 b6 b5 b4 b3 b2 b1 b0
NetRef NetCtrl FaultRst RunRev RunFwd
Control
Parameters
Name Description
Word
RunFwd b0 Set this bit to command the drive to run in the forward direction.
RunRev b1 Set this bit to command the drive to run in the reverse direction.
and Protocols
Key features
A 0 to 1 transition will reset the drive if the drive was in a trip
FaultRst b2
state.
Used in conjunction with Pr 0.06.043 to enable the drive control
NetCtrl b5
PC Applications
word bits b0-b6 and bit 9 (Pr 0.06.042).
Set this bit to command the drive to use the remote speed
NetRef b6
reference value specified in Word 1.
NOTE For the drive to run at the speed specified in Word 1, Pr 0.06.043 must be ON and bit 0,
bit 7 and bit 8 of the drive control word (Pr 0.06.042) must all be set to 1 and the external
Security
NOTE For information on the drive control word see Table 7.10 Drive control word bit
functions on page 150.
Diagnostics
The speed reference word utilises 2 bytes (16 bits) as shown below.
Glossary of
terms
b7 b6 b5 b4 b3 b2 b1 b0
SpeedRef (low byte)
Index
b7 b6 b5 b4 b3 b2 b1 b0
FaultRst RunFwd
Control
Name Description
Word
RunFwd b0 Set this bit to command the drive to run in the forward direction.
A 0 to 1 transition will reset the drive if the drive was in a trip
FaultRst b2
state.
NOTE For the drive to run at the speed specified in Word 1, Pr 0.06.043 must be ON and bit 0,
bit 7 and bit 8 of the drive control word (Pr0.06.043) must all be set to 1.
NOTE For information on the drive control word see Table 7.10 Drive control word bit
functions on page 150.
The speed reference word utilises 2 bytes (16 bits) as shown below.
b7 b6 b5 b4 b3 b2 b1 b0
SpeedRef (low byte)
For more information on the setting of the speed reference see section 7.31 AC/DC
Drive object attributes on page 174.
information
Safety
The torque reference word utilises 2 bytes (16 bits) as shown below.
Introduction
b7 b6 b5 b4 b3 b2 b1 b0
TorqueRef (low byte)
For more information on the setting of the torque reference see section 7.31 AC/DC
Mechanical
installation
Drive object attributes on page 174.
installation
Electrical
The PLC or scanner must be configured for 6 output bytes (or 3 output words) if this
assembly object is to be used.
Getting started
Data word Function
Word 0 Extended control word.
Word 1 Speed reference (SpeedRef).
Word 2 Torque reference (TorqueRef).
Parameters
Extended control word
The extended control word consists of 2 bytes (16 bits), with only 5 bits of the low byte
used as shown below.
and Protocols
Key features
b15 b14 b13 b12 b11 b10 b9 b8
b7 b6 b5 b4 b3 b2 b1 b0
NetRef NetCtrl FaultRst RunRev RunFwd PC Applications
Name Control
Description
Security
Word
RunFwd b0 Set this bit to command the drive to run in the forward direction.
RunRev b1 Set this bit to command the drive to run in the reverse direction.
Diagnostics
FaultRst b2 A 0 to 1 transition will reset the drive if the drive was in a trip state.
Used in conjunction with Pr 06.043 to enable the drive control word
NetCtrl b5
bits b0-b6 and bit 9 (Pr 06.042).
Glossary of
terms
Set this bit to command the drive to use the remote speed
NetRef b6
reference value specified in Word 1.
NOTE For the drive to run at the speed specified in Word 1, Pr 06.043 must be ON and bit 0,
bit 7 and bit 8 of the drive control word (Pr 06.042) must all be set to 1 and the external
Index
The speed reference word utilises 2 bytes (16 bits) as shown below.
b7 b6 b5 b4 b3 b2 b1 b0
SpeedRef (low byte)
For more information on the setting of the speed reference see section 7.31 AC/DC
Drive object attributes on page 174.
The torque reference word utilises 2 bytes (16 bits) as shown below.
b7 b6 b5 b4 b3 b2 b1 b0
TorqueRef (low byte)
For more information on the setting of the torque reference see section 7.31 AC/DC
Drive object attributes on page 174.
b7 b6 b5 b4 b3 b2 b1 b0
Running1
Faulted
(Fwd)
information
Safety
Bit Name Description
Indicates whether the drive is OK or tripped
b0 Faulted
(0=OK, 1=Tripped).
Introduction
Running1 Indicates if the drive is running in the forward direction
b2
(Fwd) (0=False, 1=True).
Mechanical
installation
The speed feedback word utilises 2 bytes (16 bits) as shown below.
installation
Electrical
b7 b6 b5 b4 b3 b2 b1 b0
SpeedActual (low byte)
Getting started
For more information on the speed feedback see section 7.31 AC/DC Drive object
attributes on page 174.
Parameters
The PLC or scanner must be configured for 4 input bytes (or 2 input words) if this
assembly object is to be used.
and Protocols
Key features
Data word Function
Word 0 Extended status word.
Word 1 Speed feedback (SpeedActual).
PC Applications
Extended status word
The extended status word consists of 2 bytes (16 bits), with the bits having functions as
shown below.
DriveState
b7 b6 b5 b4 b3 b2 b1 b0
Diagnostics
The DriveState byte returns a code to indicate the operating state of the drive as shown
in Table 7.16 following.
Glossary of
terms
Index
information
Safety
The speed feedback word utilises 2 bytes (16 bits) as shown below.
Introduction
b7 b6 b5 b4 b3 b2 b1 b0
SpeedActual (low byte)
For more information on the speed feedback see section 7.31 AC/DC Drive object
Mechanical
installation
attributes on page 174.
installation
Electrical
The PLC or scanner must be configured for 6 input bytes (or 3 input words) if this
assembly object is to be used.
Getting started
Data word Function
Word 0 Basic status word.
Word 1 Speed feedback (SpeedActual).
Word 2 Torque feedback (TorqueActual).
Parameters
Basic status word
The basic status word consists of 2 bytes (16 bits), with only the low byte used as shown
below.
and Protocols
Key features
b15 b14 b13 b12 b11 b10 b9 b8
PC Applications
b7 b6 b5 b4 b3 b2 b1 b0
Running1
Faulted
(Fwd)
(0=OK, 1=Tripped).
Running1 Indicates if the drive is running in the forward direction
b2
(Fwd) (0=False, 1=True).
Glossary of
terms
Index
The speed feedback word utilises 2 bytes (16 bits) as shown below.
b7 b6 b5 b4 b3 b2 b1 b0
SpeedActual (low byte)
For more information on the speed feedback see section 7.31 AC/DC Drive object
attributes on page 174.
The torque feedback word utilises 2 bytes (16 bits) as shown below.
b7 b6 b5 b4 b3 b2 b1 b0
TorqueActual (low byte)
For more information on the torque feedback see section 7.31 AC/DC Drive object
attributes on page 174.
b7 b6 b5 b4 b3 b2 b1 b0
At RefFrom CtrlFrom Running2 Running1
Ready Warning Faulted
Reference Net Net (Rev) (Fwd)
The DriveState byte returns a code to indicate the operating state of the drive as shown
in Table 7.19.
information
Safety
Code b15 - b8 State Description
1 00000001 Startup This state is skipped over on CT drives.
2 00000010 Not_Ready Inhibit.
Introduction
3 00000011 Ready Ready.
4 00000100 Enabled Run or Stop.
5 00000101 Stopping Deceleration or Injection.
AC_UU (this will only occur if Mains Loss is
Mechanical
installation
6 00000110 Fault_Stop
enabled).
7 00000111 Faulted Tripped.
Vendor All other DriveType states, e.g. Scan, Orienting,
0 00000000
Specific Regen Active, etc.
installation
Electrical
The individual bits of the low byte of the extended status word are described in Table
7.20 Extended status word (low byte) on page 159.
Getting started
Table 7.20 Extended status word (low byte)
Parameters
1=Tripped (Pr 0.10.001=0).
Warning b1 Indicates if one of the drive alarms is active.
Running1 Indicates if the drive is running in the forward direction.
b2
(Fwd) 0=False, 1=True.
and Protocols
Key features
Running2 Indicates if the drive is running in the reverse direction.
b3
(Rev) 0=False, 1=True.
The ‘Ready’ bit is set depending on which state the drive is in.
Ready = True.
PC Applications
Ready b4 Enabled = True.
Stopping = True.
All others = False.
Indicates if the drive is being controlled from the ‘Drive Control
CtrlFromNet b5 Word’.
Security
0=False, 1=True.
Indicates if the speed reference is derived from Pr 0.01.021.
RefFromNet b6 0=False (Pr 0.01.050<>1 OR Pr 0.01.049<>3).
Diagnostics
The speed feedback word utilises 2 bytes (16 bits) as shown below.
b7 b6 b5 b4 b3 b2 b1 b0
SpeedActual (low byte)
For more information on the speed feedback see section 7.31 AC/DC Drive object
attributes on page 174.
The torque feedback word utilises 2 bytes (16 bits) as shown below.
b7 b6 b5 b4 b3 b2 b1 b0
TorqueActual (low byte)
For more information on the torque feedback see section 7.31 AC/DC Drive object
attributes on page 174.
information
The Object Model has the following object classes present.
Safety
Table 7.21 Supported Objects
Introduction
Effect
Class Decimal Hex (0x) Instances
Mechanical
installation
mapping).
Motor Data 40 28 2 Defines the motor data.
Control Provides drive control and monitoring
41 29 1
installation
Supervisor information.
Electrical
AC/DC Provides drive configuration and
42 2A 1
Drive running state information.
Getting started
<No. of
CT Group 100 64 Provides access to drive parameters.
menus>
<No. of Provides access to the local option
CT This Slot 101 65
menus> module parameters.
Parameters
<No. of Provides access to the option module
CT Slot 1 102 66
menus> parameters in slot 1.
<No. of Provides access to the option module
CT Slot 2 103 67
menus> parameters in slot 2.
and Protocols
Key features
<No. of Provides access to the option module
CT Slot 3 104 68
menus> parameters in slot 3.
<No. of Provides access to the onboard
CT Slot 4 105 69
PC Applications
menus> Ethernet interface parameters.
The identity object provides identification of and general information about the device.
Returns the device type code. The following codes are used:
Product code
Name: Product Code
Class 0x01 Default See below
Instance 0x01 Data Type UINT
Attribute 0x03 Access Get
Returns a 16 bit value to identify the drive type and drive mode and also links a node to
the installed EDS files. The product code is calculated as shown in Table 7.23 Product
code bit allocation below.
Table 7.23 Product code bit allocation
information
The drive operating mode is defined as follows:
Safety
Value Operating Mode
0 Open-loop
Introduction
1 RFC-A
2 RFC-S
3 Regen
Mechanical
installation
CIP code (b2 to b0)
The CIP (Common Industrial Protocol) interface code is defined as follows:
installation
Electrical
0 430 Unidrive M700/800 onboard Ethernet
1 447 SI-DeviceNet
Getting started
2 310 MCi210
3 433 SI-Ethernet
Revision
Parameters
Name: Revision
Class 0x01 Default N/A
Instance 0x01 Data Type ARRAY of USINT
Attribute 0x04 Access Get
and Protocols
Key features
Returns 2 bytes to indicate the major and minor revision numbers of the Ethernet
interface firmware version.
The Ethernet interface firmware version (MM.002) consists of four 2-digit decimal
PC Applications
numbers with the following significance:
[Major].[Minor].[Bugfix].[Build].
The revision code returns the major and minor revisions of the Ethernet interface
firmware version in two unsigned bytes, the major revision being returned first followed
by the minor revision.
Security
b7 b6 b5 b4 b3 b2 b1 b0
Diagnostics
Where “Mod 100” refers to the fractional value of the result from MM.002/10000, (the
terms
revision value 12 (0x0C) and the second byte will be the minor revision value 34 (0x22).
b7 b6 b5 b4 b3 b2 b1 b0
0 0 0 0 1 1 0 0
Major revision = 12 (0x0C)
Minor revision
b7 b6 b5 b4 b3 b2 b1 b0
R 0 1 0 0 0 1 0
Serial Number
Name: SerialNumber
Class 0x01 Default N/A
Instance 0x01 Data Type UDINT
Attribute 0x06 Access Get
Returns the lower 4 bytes (32 bits) of the Ethernet interface serial number.
The Ethernet interface serial number is contained within two adjacent parameters, Pr
MM.004 Serial Number LS displays the least 8 significant decimal digits and Pr MM.005
Serial Number MS displays the most 8 significant decimal digits.
For example, if the serial number of the onboard Ethernet interface is 123456789 then
Pr MM.005 Serial Number MS will display 1 and Pr MM.004 Serial Number LS will
display 23456789.
The Ethernet interface serial number is set during manufacture and cannot be
changed.
Product Name
Name: ProductName
Onboard Ethernet Factory Fitted Ethernet
Class 0x01 Default
SI-Ethernet SI-Ethernet
Instance 0x01 Data Type SHORT_STRING
Attribute 0x07 Access Get
Returns the product name as a short string of ASCII Bytes. The first byte specifies the
number of following bytes that constitute the product name.
information
Class: 0x28 (4010)
Safety
There are 2 instances of the Motor data object. Instance 1 will represent menu 5 motor
information (motor 1) and instance 2 will represent menu 21 motor information (motor
2). The instance being used by the other dependant objects will be determined by Pr
Introduction
0.11.045, to use the second motor map objects (instance 2), Pr 0.11.045 should be set
to Motor 2. Pr 0.11.045 is polled in the background task, so the user should be aware
that during motor map changeover, the RPM speed reference may not be accurate. The
available attributes and associated functions for the AC motor data object are shown in
Table 7.25 AC Motor data object attributes below.
Mechanical
installation
Table 7.25 AC Motor data object attributes
installation
Electrical
Attribute ID Name Access Instance 1 Instance 2
0x03 (310) MotorType (*) Get/Set None None
Pr 0.05.007 Pr 0.21.007
Getting started
0x06 (610) RatedCurrent Get/Set
(scaled to 100 mA units) (scaled to 100 mA units)
0x07 (710) RatedVoltage Get/Set Pr 0.05.009 Pr 0.21.009
Pr 0.05.006 Pr 0.21.006
0x09 (910) RatedFreq Get/Set
(scaled to Hz) (scaled to Hz)
Parameters
Pr 0.05.008 Pr 0.21.008
0x0F (1510) BaseSpeed Get/Set
(scaled to rpm units) (scaled to rpm units)
Get Pr 0.21.015 Pr 0.21.015
0x64 (10010) Motor2Select
Set Pr 0.11.045 Pr 0.11.045
and Protocols
Key features
(* The MotorType attribute has no effect on drive operation, it is only used to provide
information to the user as shown in Table 7.26 Supported motor types below).
PC Applications
Table 7.26 Supported motor types
Value Motor Type
6 Wound rotor induction motor
7 Squirrel cage induction motor (default)
Security
9 Sinusoidal PM BL motor
10 Trapezoidal PM BL motor
Diagnostics
Name: MotorType2
Class 0x28 Default 7
Instance 0x02 Data Type USINT
Attribute 0x03 Access Get/Set
Returns or sets the motor type to be used by the drive for instance 2.
Rated current
Name: RatedCurrent1
Class 0x28 Default Pr 0.05.007 / 10
Instance 0x01 Data Type USINT
Attribute 0x06 Access Get/Set
Returns or sets the rated motor current in Amps for instance 1. This attribute is linked to
Pr 0.05.007.
Set Pr 0.05.007 = RatedCurrent1 * 10.
Get RatedCurrent1 = Pr 0.05.007 / 10.
Name: RatedCurrent2
Class 0x28 Default Pr 0.21.007 / 10
Instance 0x02 Data Type USINT
Attribute 0x06 Access Get/Set
Returns or sets the rated motor current in Amps for instance 2. This attribute is linked to
Pr 0.21.007.
Set Pr 0.21.007 = RatedCurrent2 * 10.
Get RatedCurrent2 = Pr 0.21.007 / 10.
information
Name: RatedVoltage1
Safety
Class 0x28 Default Pr 0.05.009
Instance 0x01 Data Type USINT
Attribute 0x07 Access Get/Set
Introduction
Returns or sets the rated motor voltage in Volts for instance 1. This attribute is linked to
Pr 0.05.009.
Name: RatedVoltage2
Mechanical
installation
Class 0x28 Default Pr 0.21.009
Instance 0x02 Data Type USINT
Attribute 0x07 Access Get/Set
installation
Electrical
Returns or sets the rated motor voltage in Volts for instance 2. This attribute is linked to
Pr 0.21.009.
Rated frequency
Getting started
Name: RatedFreq1
Class 0x28 Default Pr 0.05.006 / 10
Instance 0x01 Data Type USINT
Attribute 0x09 Access Get/Set
Parameters
Returns or sets the rated motor frequency in Hertz for instance 1. This attribute is linked
to Pr 0.05.006.
Set Pr 0.05.006 = RatedFreq1 * 10.
Get RatedFreq1 = Pr 0.05.006 / 10.
and Protocols
Key features
Name: RatedFreq2
Class 0x28 Default Pr 0.21.006 / 10
PC Applications
Instance 0x02 Data Type USINT
Attribute 0x09 Access Get/Set
Returns or sets the rated motor frequency in Hertz for instance 2. This attribute is linked
to Pr 21.006.
Set Pr 0.21.006 =RatedFreq2 * 10.
Security
Name: BaseSpeed2
Class 0x28 Default Pr 0.21.008
Instance 0x02 Data Type USINT
Attribute 0x0F Access Get/Set
Returns or sets the base speed of the motor in RPM for instance 2. This attribute is
linked to Pr 0.21.008.
Motor2Select
Name: Motor2Select
Class 0x28 Default
Instance 0x01 Data Type USINT
Attribute 0x64 Access Get/Set
Selects between Motor 1 and Motor 2. This attribute is linked to Pr 0.11.045. When this
bit is set to 1, Motor 2 will be active.
NOTE Any change in this attribute will be implemented when the drive is disabled.
information
Class: 0x29 (4110)
Safety
The Control Supervisor object provides access to various attributes which control or
monitor the drive running state. The available attributes and their associated functions
are shown in Table 7.27 following.
Introduction
Table 7.27 Control Supervisor object attribute
Attribute ID
Access Name Parameter dependence
Decimal Hex (0x)
Mechanical
installation
3 03 Get/Set RunFwd 0.06.042 bit1
4 04 Get/Set RunRev 0.06.042 bit3
5 05 Get/Set NetCtrl 0.06.042 bit7
installation
Electrical
See Table 7.28 Control Supervisor
6 06 Get State
state attributes on page 171
Getting started
1 (0.10.040 AND 0x2002) = 0x0002
7 07 Get RunningFwd
0 (0.10.040 AND 0x2002) <> 0x0002
1 (0.10.040 AND 0x2002) = 0x2002
8 08 Get RunningRev
0 (0.10.040 AND 0x2002) <> 0x2002
Parameters
See Table 7.28 Control Supervisor
9 09 Get Ready
state attributes on page 171
10 0A Get Faulted Inverse of 0.10.001
and Protocols
11 0B Get Warning 0.10.019
Key features
Sets 0.10.038 to 100 on a 0 to 1
12 0C Get/Set FaultRst
transition
PC Applications
See Table 7.28 Control Supervisor
13 0D Get FaultCode
state attributes on page 171
15 0F Get CtrlFromNet 0.06.042 bit7 AND 0.06.043
102 66 Get/Set DriveEnable 0.06.042 bit0
Security
Diagnostics
Glossary of
terms
Index
RunRev
Name: RunRev
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x04 Access Get/Set
Set to 1 to run the drive in the reverse direction.
Get/Set Pr 0.06.042 (bit 3).
NetCtrl
Name: NetCtrl
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x05 Access Get/Set
Switches between terminal and fieldbus control.
Get/Set Pr 0.06.042 (bit 7)
0 = Terminal control.
1 = Fieldbus control.
State
Name: State
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x06 Access Get
This returns a code to indicate the current running state of the drive as shown in
Table 7.28 following.
information
Safety
Code State Parameter Dependence Description
Introduction
2 Not_Ready 0.10.101 = 0 Inhibit
3 Ready 0.10.101 = 1 Ready
4 Enabled 0.10.101 = 2 OR 0.10.101 = 4 Stop or Run
Mechanical
installation
5 Stopping 0.10.101 = 6 OR 0.10.101 = 7 Decelerating or DC injection braking
6 Fault_Stop 0.10.101 = 5 AC supply loss
7 Faulted 0.10.101 = 9 Tripped
installation
Electrical
Vendor
0 0.10.101 = All other drive states See parameter reference guide
Specific
Getting started
RunningFwd
Name: RunningFwd
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Parameters
Attribute 0x07 Access Get
Indicates that the drive is running in the forward direction.
This attribute will be set to 1 when Pr 0.10.014 = 0 and Pr 0.10.002 = 1.
and Protocols
Key features
RunningRev
Name: RunningRev
Class 0x29 Default N/A
PC Applications
Instance 0x01 Data Type USINT
Attribute 0x08 Access Get
Indicates that the drive is running in the reverse direction.
This attribute will be set to 1 when Pr 0.10.014 = 0 and Pr 0.10.002 = 1.
Security
Diagnostics
Glossary of
terms
Index
Faulted
Name: Faulted
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x0A Access Get
Indicates that the drive is tripped, i.e. not OK (inverse of Pr 0.10.001).
Get 1 = Pr 0.10.001 = 0.
Get 0 = Pr 0.10.001 = 1.
Warning
Name: Warning
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x0B Access Get
Indicates that one of the drive alarms is active.
Get Pr 0.10.019.
FaultRst
Name: FaultRst
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x0C Access Get/Set
Resets the drive from a tripped condition.
Sets Pr 0.10.038 to 100 on a 0 to 1 transition.
information
Name: FaultCode
Safety
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x0D Access Get
Introduction
The fault code attribute will return the ODVA fault code as follows:
If the drive is not OK, the drive fault code is obtained from Pr 0.10.020, if the drive fault
code is listed in Table 7.30, then the ODVA fault code as shown in Table 7.30 below will
Mechanical
be returned.
installation
If the drive fault code is not listed in Table 7.30 then the Ethernet interface will return the
ODVA code as follows:
ODVA Fault Code = 0x1000 + drive fault code.
installation
Electrical
Table 7.30 Control Supervisor fault code attributes
ODVA Fault ODVA Fault
Drive Fault Code Drive Fault Code
Getting started
Code Code
1 0x3220 20 0x2310
2 0x3210 21 0x4300
3 0x2300 26 0x5112
4 0x7112 32 0x3130
Parameters
6 0x9000
CtrlFromNet
and Protocols
Key features
Name: CtrlFromNet
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
PC Applications
Attribute 0x0F Access Get
Indicates whether the drive is operating under fieldbus or terminal control.
This attribute will be set to 1 if Pr 0.06.042 (bit 7) = 1 and Pr 0.06.043 = 1 (fieldbus).
Security
DriveEnable
Name: DriveEnable
Class 0x29 Default N/A
Diagnostics
RunRev attributes to control the drive. RunFwd and RunRev will have no effect if
terms
NOTE The external hardware enable signal must also be present before the drive will enter the
Index
Ready state.
AtReference
Name: AtReference
Class 0x2A Default N/A
Instance 0x01 Data Type USINT
Attribute 0x03 Access Get
Indicates that the drive is running at the requested speed.
Get Pr 0.10.006
0 = Drive not running at requested speed.
1 = Drive running at requested speed.
information
Name: NetRef
Safety
Class 0x2A Default N/A
Instance 0x01 Data Type USINT
Attribute 0x04 Access Get/Set
Introduction
Selects the source of the speed reference.
Get/SetPr 0.06.042 bit 8
0 = analog speed reference.
Mechanical
installation
1 = digital speed reference.
NOTE The NetRef can only be changed between local and remote when the drive is configured
in speed control mode. If a change is requested when in torque mode then a ‘Device
State Conflict’ error code 0x10 will be returned.
installation
Electrical
DriveMode
Name: DriveMode
Getting started
Class 0x2A Default N/A
Instance 0x01 Data Type USINT
Attribute 0x06 Access Get/Set
DriveMode does not allow the operating mode of the drive to be changed. Pr 0.04.011
Parameters
will be written to as shown in Table 7.32 below, provided that the drive is already in the
correct operating mode.
and Protocols
Key features
DriveMode Actual
Access Drive Torque Mode (0.4.011)
Value Mode Mode
Open Loop
PC Applications
1 Open-loop
Speed
Speed control mode (0)
Closed Loop RFC-A
2
Speed RFC-S
Security
Open-loop
3 Torque Control RFC-A Torque control (3)
Get
RFC-S
Diagnostics
0 User Defined
terms
DriveMode Actual
Access Drive Action
Value Mode Mode
0 User Defined Don’t care Return Invalid Attribute Value’ (0x09)
NOTE Pr 0.11.031 will never be changed by setting the DriveMode attribute. An error (0x10) will
be generated if the requested DriveMode value does not correspond to the current
DriveType operating mode.
SpeedActual
Name: SpeedActual
Class 0x2A Default N/A
Instance 0x01 Data Type USINT
Attribute 0x07 Access Get
Returns the actual speed of the motor in RPM. The source of the motor speed depends
on the operating mode of the drive.
Get Pr 0.05.004 (Open Loop).
Get Pr 0.03.002 (Closed Loop).
information
Name: SpeedRef
Safety
Class 0x2A Default N/A
Instance 0x01 Data Type USINT
Attribute 0x08 Access Get/Set
Introduction
Sets or returns the speed reference in RPM.
Closed loop
Get/Set SpeedRef = Pr 0.01.021 (Scaled to 0 decimal places).
Mechanical
installation
Open loop
Get SpeedRef = (Pr 0.01.021 * 60) / Pole Pairs (Scaled to 0 decimal places).
Set Pr 0.01.021 = (SpeedRef * Pole Pairs) / 60 (Scaled to 0 decimal places).
installation
Electrical
TorqueActual
Name: TorqueActual
Getting started
Class 0x2A Default N/A
Instance 0x01 Data Type USINT
Attribute 0x0B Access Get
Returns the actual load on the motor as a percentage of the rated motor load. This
attribute has 1 decimal place precision, a value of 1000 represents 100.0 % load.
Parameters
Get Pr 0.04.020 (Scaled to 1 decimal place).
TorqueRef
and Protocols
Key features
Name:
Class 0x2A Default N/A
Instance 0x01 Data Type USINT
PC Applications
Attribute 0x0C Access Get/Set
Sets the load (torque) reference as % of rated motor load (torque). This attribute has 1
decimal place precision, so a value of 1000 represents 100.0 % load.
Set Pr 0.04.008 = TorqueRef / 10 (Scaled to 1 decimal place).
Security
RefFromNet
Diagnostics
Name: RefFromNet
Class 0x2A Default
Instance 0x01 Data Type USINT
Glossary of
Class Code
Name Description
Dec Hex (0x)
CT
100 64 Provides access to all drive parameters
Group
CT This Provides access to the connected Ethernet interface
101 65
Slot parameters
102 66 CT Slot 1 Provides access to the option module in slot 1 parameters
103 67 CT Slot 2 Provides access to the option module in slot 2 parameters
104 68 CT Slot 3 Provides access to the option module in slot 3 parameters
105 69 CT Slot 4 Provides access to the onboard Ethernet interface parameters
information
Safety
The Ethernet interface supports the following commissioning and programming
software applications:
Introduction
• Unidrive M Connect
• Machine Control Studio
• CTScope
• SyPTPro
Mechanical
installation
• CT OPC server
Some parameters have a profound effect on the operation of the drive. They must not
be altered without careful consideration of the impact on the controlled system.
Measures must be taken to prevent unwanted changes due to error or tampering
installation
Electrical
CAUTION especially if a remote user can access the drive over Ethernet.
Getting started
and monitoring the drive or system performance.
Features include:
• Fast task based commissioning and easy maintenance of the Unidrive M
family is simplified via familiar Windows interface
Parameters
• Intuitive graphical tools enhance and simplify user experience
• For experienced users, dynamic drive logic diagrams and enhanced
searchable listings are present
• Drive and motor performance can be optimized with minimal specialized drive
and Protocols
Key features
knowledge
• Tool is scalable to match application requirements
• Supports the import of Unidrive SP parameter files and allows full drive
cloning (i.e. parameter sets and application program)
PC Applications
• Multiple simultaneous comms channels for a more complete overview of the
system
• Drive discovery gives the ability to find drives on a network automatically
without the user having to specify their addresses
For more information on using Unidrive M Connect please refer to the online help
Security
supplied.
8.2 Machine Control Studio
Machine Control Studio is a CoDeSys based development environment designed for
Diagnostics
use with the onboard user program of Unidrive M and the MCi200/MCi210 Machine
Controller modules.
Programs can be written in one or more of the supported languages - structured text,
Glossary of
function block, SFC (sequential function chart), ladder or instruction list - and
terms
supplied.
8.4 SyPTPro
SyPTPro is a complete integrated development suite for distributed drive applications.
SyPTPro allows user programs to be developed for multiple nodes in DPL, ladder and
function block programming languages. DPL (Drive Programming Language) is a high
level language as easy to use as BASIC but optimised for drive applications. SyPTPro
also allows user programs to be downloaded to nodes and the runtime operation of the
programs to be monitored.
To use SyPTPro over Ethernet requires a version that provides Ethernet support,
SyPTPro V02.01.00 or later includes support for TCP/IP.
NOTE SyPTPro can only be used to program a SI-Applications Plus option module and not an
onboard drive program or a MCi200/MCi210 Machine Controller module.
For more information on using SyPTPro please refer to the online help supplied.
information
OPC is a set of standards written to facilitate connection of a software application such
Safety
as SCADA and HMI to industrial equipment such as drives and PLCs. Provided such
devices have an associated OPC server (inbuilt or external), the standard removes the
need for such applications to have any knowledge of how to obtain data from the
Introduction
device. If such applications implement an OPC client they can then obtain data from
any devices for which OPC servers exist.
The OPC Data Access specification is based around Microsoft COM & DCOM
technology and so servers and clients will typically be running on a Microsoft Operating
system. The client and server can both run on the same computer or they can be
Mechanical
installation
connected via a standard network such as Ethernet.
The CT OPC server will allow software systems containing an OPC Data Access client
to communicate with Unidrive M over Ethernet or Modbus RTU. It does not support any
other manufacturers product. The server uses proprietary protocols to gather and
installation
Electrical
distribute data to and from Unidrive M and offers a standard OPC DA interface to OPC
Clients.
The CT OPC server supports versions 1, 2 and 3 of the OPC DA server specifications.
Getting started
These specifications are obtainable from the OPC foundation
http:\\www.opcfoundation.org.
For more information on using the CT OPC server please refer to the online help
Parameters
supplied.
The CT OPC server was originally developed for use with Unidrive SP, some limitations
exist when used with Unidrive M, these limitations include:
• Unidrive M parameter database not supported
and Protocols
Key features
• No access to option module parameters (except SI-Applications Plus)
• Only parameters 99 or less can be directly accessed
(Parameters with a number of greater than 99 can be mapped to menu 0 and
PC Applications
the menu 0 parameter then accessed).
Security
Diagnostics
Glossary of
terms
Index
NOTE The use of a quality anti-virus solution on any networked system is recommended. The
overall network security policy resides with the network administrators and any connec-
tions to a network should be approved by the network administrators.
NOTE Some managed switches provide control methods for network traffic, however a firewall
offers significantly more features. Configuration of a switch or firewall is beyond the
scope of this document.
information
Safety
This section of the manual provides basic diagnostic information intended to enable
resolution of the most common problems encountered when setting up the Ethernet
interface on an Ethernet network.
Introduction
A high percentage of problems reported are basic setup problems that can be avoided
by using the following pages. Start by using the Diagnostic flow chart on page 188 to
determine the possible cause of a problem. If after following the flow chart you are still
experiencing problems please contact your supplier or local drive supplier for support.
Mechanical
installation
NOTE Please note that support will be limited to the setting up and networking of the drive and
not network infrastructure design.
installation
Electrical
Each Ethernet connection has an associated LED to aid diagnostics, in the case of the
onboard Ethernet interface, this LED is mounted below the associated RJ45 connector;
the SI-Ethernet option module has two LEDs mounted on the topside of the module
Getting started
(Figure 2-1 SI-Ethernet on page 8).
The connection status for the first port (nearest the grounding tab) is indicated by LED
“A”, and the second port is indicated by LED “B”.
The function of these LEDs are described in table 10.1 LED functionality below.
Parameters
Table 10.1 LED functionality
and Protocols
Key features
Steady green Ethernet connection detected but no data.
Flashing green Ethernet communication detected and data flow.
the slot number will be the slot number the SI-Ethernet option module is fitted to. The
exact reason for the trip will be indicated in the drive trip code parameters (Pr 0.10.020
and Pr 0.10.070).
Diagnostics
Table 10.2 Drive trip indications on page 184 following shows the possible trips that will
be displayed on the drive when a problem is detected or the Ethernet interface initiates
a trip.
Glossary of
terms
Index
Trip Description
The drive has detected that an Ethernet interface is present but is unable to
SlotX HF
communicate with it due to a hardware fault.
SlotX Error User trip generated by the Ethernet interface
This trip will occur if a drive slot was previously configured with an option
SlotX Not Fitted
module but on power up, no option module was detected.
This trip will occur if a drive slot was previously configured with an option
module but on power up, a different option module was detected. Replacing
SlotX Different the option module with another one of the same ID number will not initiate
this trip. The trip will also occur if an option module is installed to a
previously unused slot.
Value
Sub trip string Description
Pr 0.10.070
information
Pr 0.10.070
Safety
118 INIT Param Chann Parameter channel Initialization error
119 Link Overload Too many links to be handled in the same cycle
Introduction
120 Mcast Over Limit Too many multicast addresses being used
200 Software Fault Software Fault
201 BG Overrun Background task overrun
Mechanical
installation
202 Firmware Invalid Invalid firmware for hardware version
203 Drive Unknown Unknown drive type
204 DriveUnsupported Unsupported drive type
installation
Electrical
205 Mode Unknown Unknown drive mode
206 Mode Unsupported Unsupported drive mode
207 FLASH Error Corrupted Non-volatile FLASH
Getting started
208 Database Init Database initialization error
209 File System Init File system initialization error
210 Mem Allocation Memory allocation error
Parameters
211 Filesystem Error File system error
212 Config Save Configuration file save error
213 Over Temperature Overheated
214 Drive Timeout The drive has not responded within watchdog period
and Protocols
Key features
215 eCMP Comms Error eCMP communication failure
216 TO eCMP Slot1 eCMP communication to slot 1 timeout
PC Applications
217 TO eCMP Slot2 eCMP communication to slot 2 timeout
218 TO eCMP Slot3 eCMP communication to slot 3 timeout
219 TO eCMP Slot4 eCMP communication to slot 4 timeout
220 I/O Overload Digital output current demand too high
Security
Bit
Alarm Description
(Pr MM.009)
0 User Program The user program has generated an alarm
1 eCMP An eCMP alarm has been generated
2 Modbus A Modbus alarm has been generated
3 Ethernet/IP An Ethernet/IP alarm has been generated
4 Reserved Reserved
5 File System File system full alarm has been generated
6 Too Hot Temperature too high alarm has been generated
Value
Reason
Pr 0.10.070
1 The module category cannot be identified
All the required customisable menu table information has not been supplied or
2
the tables supplied are corrupt
There is insufficient memory available to allocate the comms buffers for this
3
module
4 The module has not indicated that it is running correctly during drive power-up
The module has been removed after power-up or it has ceased to indicate to the
5
drive processor that it is still active
The module has not indicated that it has stopped accessing drive parameters
6
during a drive mode change
The module has failed to acknowledge that a request has been made to reset the
7
drive processor
The drive failed to read correctly the menu table from the module during drive
8
power-up
9 The drive failed to upload menu tables from the module and timed-out (5s)
10 Menu table CRC invalid
187
Ensure the option module is installed correctly.
Replace the option module.
Replace the drive.
Recommended actions:
Issue: 1
10.6 Diagnostic flow chart
Is PrS.02.004
Ethernet
interface was
is PrS.02.004
Is Pr S.02.004
(S.02.003)
6
Ethernet
interface is
Default Ethernet
interface (MM.008)
and retry
information
Safety
Address: This is the unique network identification given to a networked device to allow
Introduction
communication on a network. When a device sends or receives data the address is
used to determine the source and the destination of the message.
ADU: Application Data Unit. The complete Modbus message frame (ADU) consists of
Mechanical
installation
the Modbus Application Protocol (MBAP) and Protocol Data Unit (PDU).
Assembly object: A software component within the Ethernet interface which allows
access to the parameters within the drive or which allows control and monitoring of the
installation
Electrical
drive by using the EtherNet/IP protocol.
Getting started
e.g. The VendorID is an attribute of the Identity object class.
Used in conjunction with the Class and Instance properties.
Parameters
non-crossover network cable is connected.
and Protocols
Key features
Byte: A collection of 8 binary digits that collectively store a value. This may be signed or
unsigned.
PC Applications
Class: A collection of properties which allow the control or monitoring of a device. Used
in conjunction with the Instance and Attribute properties.
Security
Consistency: A method of ensuring that the data transferred over the network is
transmitted as a single entity, thus preventing data skew when multiple bytes are
transmitted.
Diagnostics
Control word: A collection of binary digits that are used to control the drive. Features
typically include directional controls, run controls and other similar functions.
Glossary of
terms
Crossover lead: A network cable where the terminal connections at one end of the
cable are connected straight through to the other end with the exception of the data pair
which are transposed. Normally used to connect two network devices together as a
separate network.
Index
Data rate: Determines the communication speed of the network, the higher the value
the more data can be sent across the network in the same time period.
DNS: Domain Name Server. This is a server that is used to convert a URL such as
“www.controltechniques.com” to an IP address such as 129.254.254.106.
Grounding: Describes the electrical safety or shielding connections for the module.
EDS File: Electronic Data Sheet file. A file which specifies the EtherNet/IP device
functionality.
information
repeat any data received on one port to all ports.
Safety
HTTP: Hypertext transfer protocol. This is a document specification protocol. Commonly
used in web pages.
Introduction
Implicit data: See Cyclic data.
Mechanical
installation
Instance: A collection of properties (Attributes) that are contained within a Class.
Used in conjunction with the Class and Attribute properties.
installation
Electrical
IP: Internet Protocol, this is the protocol used to transmit bytes across an IP network.
Getting started
IP subnet: A part of an IP network that consists of a range of addresses that may be
accessed by all devices on the same network directly.
Parameters
LED: Light Emmiting Diode.
and Protocols
Key features
LSB: Least Significant Bit/Byte.
PC Applications
MAC address: This is a unique address that is assigned to the Ethernet interface at the
time of manufacture. No other device will have this address. The address is used to
make connections to the interface before the IP address is assigned.
MBAP: Modbus application protocol. This is a 7 byte header added to the main Modbus
Security
Modbus IP: A protocol that allows Modbus to be sent over TCP/IP. The modbus
Diagnostics
protocol allows manipulation of the parameters within the host drive and option
modules.
Glossary of
terms
Node: A device on the network. This may be either a device such as a drive or part of
the network such as a repeater.
Index
Non-cyclic (explicit) data: Data that is requested or sent as required and not on a
regular basis. Sometimes referred to as “Explicit data”.
Patch lead: A network cable where the terminal connections at one end of the cable are
connected straight through to the other end on a pin to pin basis. Normally used to
connect a network device to a network switch.
PDU: Protocol Data Unit. This is the main Modbus message telegram, to which is added
the MBAP header to form the complete Modbus telegram.
Poll rate: The rate at which cyclic data is sent and received on the network.
Router: A device that is used to connect different networks or subnets, in a similar way
to a firewall, however a router generally allows significantly less control of the data.
RPI: Requested Packet Interval. Specifies the expected time for the device to respond
to a request.
SMTP: Simple Mail Transfer Protocol. A protocol used for sending email.
SNTP: Simple Network Time Protocol. A protocol used for synchronising time over a
network.
information
have a specific meaning.
Safety
Subnet: A part of a network that has IP addresses in the same range. Devices on the
same subnet may communicate directly with other devices on the same subnet without
Introduction
the use of a gateway.
Subnet mask: Defines which part of the IP address constitutes the subnet address and
which part constitutes the host device address.
Mechanical
installation
Switch: A device that allows Ethernet devices to be interconnected.
installation
Electrical
TCP: Transmission Control Protocol, this protocol is responsible for ensuring that the
data on the network reaches it’s destination.
Getting started
URL: Uniform Resource Locator. A method used to give a web site a friendly name
such as www.controltechniques.com as an alternative to an IP address.
VPN: Virtual Private Network. A method of using a non-secure or public network that
Parameters
allows devices to be connected together as if they were a part of a private network.
and Protocols
Key features
XML: Extensible Markup Language. A document definition that is intended to transfer
data.
PC Applications
Security
Diagnostics
Glossary of
terms
Index
information
Extended speed control ............................................................................151
Safety
Extended speed feedback ........................................................................155
F
Firewall issues ..........................................................................................182
Introduction
Fixed IP addressing ....................................................................................18
G
General safety considerations for remote operation ....................................6
Getting started ............................................................................................15
Mechanical
installation
Glossary of terms .....................................................................................189
Grounding ...................................................................................................12
H
Hubs ...........................................................................................................13
installation
Electrical
I
Installing SyPTPro ....................................................................................180
Instance ....................................................................................................191
Getting started
Introduction ...................................................................................................7
IP address ..................................................................................................17
L
Layout .........................................................................................................12
Parameters
LED Diagnostics .......................................................................................183
Length of cable ...........................................................................................13
M
Minimum software versions required for Ethernet ..............................15, 179
and Protocols
Key features
Modbus function codes ............................................................................119
Modbus TCP/IP ........................................................................................119
Module identification .................................................................................188
Module information .....................................................................................12
PC Applications
Motor ............................................................................................................6
N
Network design ...........................................................................................15
Network length ...........................................................................................13
Network topology ........................................................................................13
Security
R
Read consistency .....................................................................................144