Altivar Machine ATV340 - Variable Speed Drives for Asynchronous

Altivar Machine ATV340 - Variable Speed Drives for Asynchronous
Altivar Machine ATV340
NVE61653 09/2016
Altivar Machine ATV340
Variable Speed Drives
for Asynchronous and Synchronous Motors
Ethernet Embedded Manual
NVE61653.01
09/2016
www.schneider-electric.com
The information provided in this documentation contains general descriptions and/or technical characteristics of the performance of the products contained herein. This documentation is not intended as a
substitute for and is not to be used for determining suitability or reliability of these products for specific user
applications. It is the duty of any such user or integrator to perform the appropriate and complete risk
analysis, evaluation and testing of the products with respect to the relevant specific application or use
thereof. Neither Schneider Electric nor any of its affiliates or subsidiaries shall be responsible or liable for
misuse of the information contained herein. If you have any suggestions for improvements or amendments
or have found errors in this publication, please notify us.
No part of this document may be reproduced in any form or by any means, electronic or mechanical,
including photocopying, without express written permission of Schneider Electric.
All pertinent state, regional, and local safety regulations must be observed when installing and using this
product. For reasons of safety and to help ensure compliance with documented system data, only the
manufacturer should perform repairs to components.
When devices are used for applications with technical safety requirements, the relevant instructions must
be followed.
Failure to use Schneider Electric software or approved software with our hardware products may result in
injury, harm, or improper operating results.
Failure to observe this information can result in injury or equipment damage.
© 2016 Schneider Electric. All Rights Reserved.
2
NVE61653 09/2016
Table of Contents
Safety Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1 Presentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Hardware Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Software Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 2 Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network Layer Supported Functions/Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TCP and UDP Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.2 Modbus TCP Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modbus TCP Frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modbus TCP Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Supported Modbus TCP Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Application Profile with Modbus TCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.3 Ethernet IP Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EtherNet/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cyclical Exchanges (Implicit Exchanges) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Messaging (Explicit Exchanges) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Timeout Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.4 CIP Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Supported Object Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Identity Object (01 hex) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Message Router Object (02 hex). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TCP/IP Interface Object (F5 hex) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet Link Object (F6 hex) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Assembly Object (04 hex) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connection Manager Object (06 hex) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Motor Data Object (28 hex) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Control Supervisor Object (29 hex) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AC/DC Drive Object (2A hex) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Application Object (70 hex to C7 hex) / Explicit Messaging . . . . . . . . . . . . . . . . . . . . . . . . .
Base Energy Object (4E hex) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Electrical Energy Object (4F hex) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 3 Hardware Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Hardware Presentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Firmware Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Electrical Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cable Routing Practice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 4 Software Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.1 Basic Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IP Parameter Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Device Name] PAn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[IP mode Ether. Embd ]IM00 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[IP address]IC01IC02IC03IC04 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Mask] IM01IM02IM03IM04 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Gateway] IG01IG02IG03IG04 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Enable FDR] FdV0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[FDR Action] FdA0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[FDR Operating State] FdS0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[FDR Error Status] Fdr0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NVE61653 09/2016
7
11
13
14
15
17
18
19
20
21
23
24
25
26
27
28
29
30
33
33
34
35
36
38
39
42
44
46
48
49
51
54
55
57
59
60
60
61
62
65
66
67
68
68
69
69
70
70
71
71
72
3
4.2
4.3
4.4
4.5
4.6
[MAC @] MACO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[ETH emb Rx frames] ErXE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[ETH emb Tx frames] ETXE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[ETH emb error frames] EErE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Ethernet Rate Data] ArdE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Enable Webserver]EWEE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Reset EmbWeb] rWPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Ethernet Embd cmd.] CMd5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Ethernet Embd Ref Freq] LFr5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Ethernet Timeout] ttOb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Additional Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FDR Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RSTP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring I/O Scanning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DNS Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SNTP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SNMP Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fast Device Replacement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Presentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Startup Detailed Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FDR Operation Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Local Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Downloaded Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Communication Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Definition of a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Functional Profiles Supported by the Drive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CIA402 Operating State Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Description of Operating States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cmd Register CMd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Stop Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Assigning Control Word Bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[CIA402 State Reg] EtA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Starting Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sequence for a Drive Powered by the Power Stage Supply . . . . . . . . . . . . . . . . . . . . . . . . .
Sequence for a Drive with Separate Control Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sequence for a Drive with Mains Contactor Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Embedded Webserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connection to the Webserver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
My Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Display - Drive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setup - My Preference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Software Setup with SoMachine (M251) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Drive Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet Master Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 5 Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5.1 Operating States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring Communication Error Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4
72
73
73
73
73
74
74
74
75
75
76
77
78
79
80
81
82
84
85
86
87
88
89
91
92
93
94
95
96
98
99
100
100
101
102
103
104
107
109
110
111
112
113
114
115
116
117
118
123
124
124
NVE61653 09/2016
5.2 Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the Control Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration of the Drive for Operation in I/O Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration of the Drive for Operation with CiA 402 Profile in Combined Mode . . . . . . . .
Configuration of the Drive for Operation with CiA 402 Profile in Separate Mode . . . . . . . . .
Chapter 6 Diagnostic and Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fieldbus Status LEDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connection for Fieldbus Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fieldbus Functions Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Control-Signal Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Glossary
NVE61653 09/2016
.....................................................
126
127
127
128
129
131
132
133
134
136
137
5
6
NVE61653 09/2016
Safety Information
Important Information
NOTICE
Read these instructions carefully, and look at the equipment to become familiar with the device before
trying to install, operate, service, or maintain it. The following special messages may appear throughout
this documentation or on the equipment to warn of potential hazards or to call attention to information that
clarifies or simplifies a procedure.
PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by qualified personnel.
No responsibility is assumed by Schneider Electric for any consequences arising out of the use of this
material.
A qualified person is one who has skills and knowledge related to the construction and operation of
electrical equipment and its installation, and has received safety training to recognize and avoid the
hazards involved.
Qualification Of Personnel
Only appropriately trained persons who are familiar with and understand the contents of this manual and
all other pertinent product documentation are authorized to work on and with this product. In addition, these
persons must have received safety training to recognize and avoid hazards involved. These persons must
have sufficient technical training, knowledge and experience and be able to foresee and detect potential
hazards that may be caused by using the product, by changing the settings and by the mechanical,
electrical and electronic equipment of the entire system in which the product is used. All persons working
on and with the product must be fully familiar with all applicable standards, directives, and accident
prevention regulations when performing such work.
NVE61653 09/2016
7
Intended Use
This product is a drive for three-phase asynchronous motors and intended for industrial use according to
this manual.The product may only be used in compliance with all applicable safety standard and local
regulations and directives, the specified requirements and the technical data. The product must be
installed outside the hazardous ATEX zone. Prior to using the product, you must perform a risk assessment
in view of the planned application. Based on the results, the appropriate safety measures must be
implemented.Since the product is used as a component in an entire system, you must ensure the safety
of persons by means of the design of this entire system (for example, machine design). Any use other than
the use explicitly permitted is prohibited and can result in hazards. Electrical equipment should be installed,
operated, serviced, and maintained only by qualified personnel.
Product Related Information
Read and understand these instructions before performing any procedure with this drive.
DANGER
HAZARD OF ELECTRIC SHOCK, EXPLOSION OR ARC FLASH









Only appropriately trained persons who are familiar with and understand the contents of this manual
and all other pertinent product documentation and who have received safety training to recognize and
avoid hazards involved are authorized to work on and with this drive system. Installation, adjustment,
repair and maintenance must be performed by qualified personnel.
The system integrator is responsible for compliance with all local and national electrical code
requirements as well as all other applicable regulations with respect to grounding of all equipment.
Many components of the product, including the printed circuit boards, operate with mains voltage. Do
not touch. Use only electrically insulated tools.
Do not touch unshielded components or terminals with voltage present.
Motors can generate voltage when the shaft is rotated. Prior to performing any type of work on the
drive system, block the motor shaft to prevent rotation.
AC voltage can couple voltage to unused conductors in the motor cable. Insulate both ends of unused
conductors of the motor cable.
Do not short across the DC bus terminals or the DC bus capacitors or the braking resistor terminals.
Before performing work on the drive system:
 Disconnect all power, including external control power that may be present.
 Place a Do Not Turn On label on all power switches.
 Lock all power switches in the open position.
 Wait 15 minutes to allow the DC bus capacitors to discharge. The DC bus LED is not an indicator
of the absence of DC bus voltage that can exceed 800 Vdc.
 Measure the voltage on the DC bus between the DC bus terminals (PA/+, PC/-) using a properly
rated voltmeter to verify that the voltage is < 42 Vdc.
 If the DC bus capacitors do not discharge properly, contact your local Schneider Electric representative. Do not repair or operate the product.
Install and close all covers before applying voltage.
Failure to follow these instructions will result in death or serious injury.
Drive systems may perform unexpected movements because of incorrect wiring, incorrect settings,
incorrect data or other errors.
WARNING
UNANTICIPATED EQUIPMENT OPERATION



Carefully install the wiring in accordance with the EMC requirements.
Do not operate the product with unknown or unsuitable settings or data.
Perform a comprehensive commissioning test.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
Damaged products or accessories may cause electric shock or unanticipated equipment operation.
8
NVE61653 09/2016
DANGER
ELECTRIC SHOCK OR UNANTICIPATED EQUIPMENT OPERATION
Do not use damaged products or accessories.
Failure to follow these instructions will result in death or serious injury.
Contact your local Schneider Electric sales office if you detect any damage whatsoever.
WARNING
LOSS OF CONTROL





The designer of any control scheme must consider the potential failure modes of control paths and,
for critical control functions, provide a means to achieve a safe state during and after a path failure.
Examples of critical control functions are emergency stop, overtravel stop, power outage and restart.
Separate or redundant control paths must be provided for critical control functions.
System control paths may include communication links. Consideration must be given to the
implications of unanticipated transmission delays or failures of the link.
Observe all accident prevention regulations and local safety guidelines (1).
Each implementation of the product must be individually and thoroughly tested for proper operation
before being placed into service.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
(1) For USA: Additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest edition),
Safety Standards for Construction and Guide for Selection, Installation and Operation of Adjustable-Speed
Drive Systems.
NOTICE
DESTRUCTION DUE TO INCORRECT MAINS VOLTAGE
Before switching on and configuring the product, verify that it is approved for the mains voltage
Failure to follow these instructions can result in equipment damage.
The temperature of the products described in this manual may exceed 80 °C (176 °F) during operation.
WARNING
HOT SURFACES




Ensure that any contact with hot surfaces is avoided.
Do not allow flammable or heat-sensitive parts in the immediate vicinity of hot surfaces.
Verify that the product has sufficiently cooled down before handling it.
Verify that the heat dissipation is sufficient by performing a test run under maximum load conditions.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
This equipment has been designed to operate outside of any hazardous location. Only install this
equipment in zones known to be free of a hazardous atmosphere.
DANGER
POTENTIAL FOR EXPLOSION
Install and use this equipment in non-hazardous locations only.
Failure to follow these instructions will result in death or serious injury.
Machines, controllers, and related equipment are usually integrated into networks. Unauthorized persons
and malware may gain access to the machine as well as to other devices on the network/fieldbus of the
machine and connected networks via insufficiently secure access to software and networks.
NVE61653 09/2016
9
WARNING
UNAUTHORIZED ACCESS TO THE MACHINE VIA SOFTWARE AND NETWORKS



In your hazard and risk analysis, consider all hazards that result from access to and operation on the
network/fieldbus and develop an appropriate cyber security concept.
Verify that the hardware infrastructure and the software infrastructure into which the machine is
integrated as well as all organizational measures and rules covering access to this infrastructure
consider the results of the hazard and risk analysis and are implemented according to best practices
and standards covering IT security and cyber security (such as: ISO/IEC 27000 series, Common
Criteria for Information Technology Security Evaluation, ISO/ IEC 15408, IEC 62351, ISA/IEC 62443,
NIST Cybersecurity Framework, Information Security Forum - Standard of Good Practice for
Information Security).
Verify the effectiveness of your IT security and cyber security systems using appropriate, proven
methods.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
10
NVE61653 09/2016
About the Book
At a Glance
Document Scope
The purpose of this document is to:
 Show you how to install the Ethernet fieldbus on your drive.
 Show you how to configure drive to use Ethernet for display, monitoring, and control.
 Provide examples of setup using SoMachine
NOTE: Read and understand this document and all related documents (see below) before installing,
operating, or maintaining your drive.
Validity Note
This documentation is valid for the Altivar Machine 340 drives.
The technical characteristics of the devices described in this document also appear online. To access this
information online:
Step
Action
1
Go to the Schneider Electric home page www.schneider-electric.com.
2
In the Search box type the reference of a product or the name of a product range.
 Do not include blank spaces in the reference or product range.
 To get information on grouping similar modules, use asterisks (*).
3
If you entered a reference, go to the Product Datasheets search results and click on the reference that
interests you.
If you entered the name of a product range, go to the Product Ranges search results and click on the
product range that interests you.
4
If more than one reference appears in the Products search results, click on the reference that interests
you.
5
Depending on the size of your screen, you may need to scroll down to see the data sheet.
6
To save or print a data sheet as a .pdf file, click Download XXX product datasheet.
The characteristics that are presented in this manual should be the same as those characteristics that
appear online. In line with our policy of constant improvement, we may revise content over time to improve
clarity and accuracy. If you see a difference between the manual and online information, use the online
information as your reference.
NVE61653 09/2016
11
Related Documents
Use your tablet or your PC to quickly access detailed and comprehensive information on all our products
on www.schneider-electric.com
The internet site provides the information you need for products and solutions
The whole catalog for detailed characteristics and selection guides
 The CAD files to help design your installation, available in over 20 different file formats
 All software and firmware to maintain your installation up to date
 A large quantity of White Papers, Environment documents, Application solutions, Specifications... to
gain a better understanding of our electrical systems and equipment or automation
 And finally all the User Guides related to your drive, listed below:

Title of Documentation
Reference Number
ATV340 Getting Started
NVE37643 (English), NVE37642 (French),
NVE37644 (German), NVE37646 (Spanish),
NVE37647 (Italian), NVE37648 (Chinese)
ATV340 Getting Started Annex (SCCR)
NVE37641 (English)
ATV340 Installation Manual
NVE61069 (English), NVE61071 (French),
NVE61074 (German), NVE61075 (Spanish),
NVE61078 (Italian), NVE61079 (Chinese)
ATV340 Programming Manual
NVE61643 (English), NVE61644 (French),
NVE61645 (German), NVE61647 (Spanish),
NVE61648 (Italian), NVE61649 (Chinese)
ATV340 Modbus manual (Embedded)
NVE61654 (English)
ATV340 Ethernet manual (Embedded)
NVE61653 (English)
ATV340 PROFIBUS DP manual (VW3A3607)
NVE61656 (English)
ATV340 DeviceNet manual (VW3A3609)
NVE61683 (English)
ATV340 PROFINET manual (VW3A3627)
NVE61678 (English)
ATV340 CANopen manual (VW3A3608, 618, 628)
NVE61655 (English)
ATV340 EtherCAT manual - (VW3A3601)
NVE61686 (English)
ATV340 Communication Parameters
NVE61728 (English)
ATV340 ATEX manual
NVE61651 (English)
ATV340 Embedded Safety Function Manual
NVE64143 (English)
ATV340 Safety Functions manual
NVE61741 (English), NVE61742 (French),
NVE61745 (German), NVE61747 (Spanish),
NVE61749 (Italian), NVE61752 (Chinese)
You can download these technical publications and other technical information from our website at
http://download.schneider-electric.com
Terminology
The technical terms, terminology, and the corresponding descriptions in this manual normally use the
terms or definitions in the relevant standards.
The technical terms, terminology, and the corresponding descriptions in this manual normally use the
terms or definitions in the relevant standards.
Among others, these standards include:
IEC 61800 series: Adjustable speed electrical power drive systems
 IEC 61508 Ed.2 series: Functional safety of electrical/electronic/programmable electronic safety-related
 EN 954-1 Safety of machinery - Safety related parts of control systems
 EN ISO 13849-1 & 2 Safety of machinery - Safety related parts of control systems.
 IEC 61158 series: Industrial communication networks - Fieldbus specifications
 IEC 61784 series: Industrial communication networks - Profiles
 IEC 60204-1: Safety of machinery - Electrical equipment of machines – Part 1: General requirements

In addition, the term zone of operation is used in conjunction with the description of specific hazards, and
is defined as it is for a hazard zone or danger zone in the EC Machinery Directive (2006/42/EC) and in ISO
12100-1.
Also see the glossary at the end of this manual.
12
NVE61653 09/2016
Altivar Machine ATV340
Presentation
NVE61653 09/2016
Chapter 1
Presentation
Presentation
What Is in This Chapter?
This chapter contains the following topics:
Topic
NVE61653 09/2016
Page
Hardware Overview
14
Software Overview
15
13
Presentation
Hardware Overview
General
The drive embeds an Ethernet dual port adapter that can be used in the following two industrial
communication protocols:
 Modbus TCP
 EtherNet/IP
In addition of the communication services provided by each protocol, the adapter provides a set of services
at the Ethernet and TCP/IP level. The embedded adapter offers an embedded Web server (in 6 langages)
which offers comfortable displaying and commissioning functions directly from a standard web browser.
The figure shows the location of the Ethernet dual port adapter.
ATV340U07N4E to ATV340D22N4E
ATV340D30N4E to ATV340D75N4E
1: Ethernet adapter
14
NVE61653 09/2016
Presentation
Software Overview
Simplified TCP/IP Model
The table provides the basic overview to the simplified TCP/IP model
Application
Modbus TCP-EtherNet/IP
Transport
TCP / UDP
Network
IP
Link
Ethernet
Modbus TCP-EtherNet/IP Features Overview
NVE61653 09/2016
15
Presentation
16
NVE61653 09/2016
Altivar Machine ATV340
Basics
NVE61653 09/2016
Chapter 2
Basics
Basics
What Is in This Chapter?
This chapter contains the following sections:
Section
2.1
NVE61653 09/2016
Topic
Page
Introduction
18
2.2
Modbus TCP Features
23
2.3
Ethernet IP Features
28
2.4
CIP Object
34
17
Basics
Section 2.1
Introduction
Introduction
What Is in This Section?
This section contains the following topics:
Topic
18
Page
Introduction
19
Network Layer Supported Functions/Protocols
20
TCP and UDP Protocol
21
NVE61653 09/2016
Basics
Introduction
Modbus TCP
The Modbus application layer is standard. Many of the manufacturers are already implementing this
protocol. Many have already developed a Modbus TCP/IP connection and numerous products are
currently available. With the simplicity of its protocol and the fast Ethernet throughput data rate of
100 Mbit/s, Modbus TCP/IP achieves excellent performance.
EtherNet/IP
EtherNet/IP is a fieldbus based on TCP and UDP. EtherNet/IP extends Ethernet by an advanced industrial
protocol (CIP, Common Industrial Protocol) as an application layer for automation applications in this way,
Ethernet suites for industrial control. Products from different manufacturers can be networked without the
need for special interface adaptation.
TCP/IP and Ethernet Features
The product supports the following functions via:
 Manual IP address assignment
 Automatic IP address assignment via BOOTP or DHCP
 Automatic configuration data via FDR
 Commissioning via DTM-based commissioning software
 Diagnostics and configuration via integrated Web server
 Support of LLDP (Link Layer Discovery Protocol)
 Support of RSTP (Rapid Spanning Tree Protocol)
 Support of SNTP (Simple Network Time Protocol)
 Support of DNS (Domain Name System)
 Support of IPV6 for DPWS (Devices Profile for Web Services)
 Handling of QoS (Quality of Service)
Web Server
The standard webserver (in six languages) provides access to pages such as:
 My dashboard
 Display
 Diagnostics
 Drive
 Setup
VW3A3721 MultiDrive Link Feature
The VW3A3721 embeds, in addition of the features described above, the MultiDrive Link feature.
This allow to use and give access to Multiple Pumps functions of Altivar 600 range.
For more informations about commissioning of MultiDrive Link feature and Multiple Pumps functions, refer
to ATV600 Programming Manual.
NVE61653 09/2016
19
Basics
Network Layer Supported Functions/Protocols
ARP Protocol
The ARP (Address resolution protocol) is a protocol used to map network addresses (IP) to hardware
addresses (MAC).
The protocol operates below the network layer as a part of the OSI link layer, and is used when IP is used
over Ethernet. A host, wishing to obtain a physical address, broadcasts an ARP request onto the TCP/IP
network. A unique IP address is assigned to the host, and is sent to its hardware address.
ICPM Protocol
The embedded manages the ICMP protocol.
 ICMP client: not supported
 ICMP server: the managed requests are the following:
Type
Description
0
Echo reply (ping)
3
Destination unreachable
4
Sources quench
5
Redirect
6
Alternate host address
8
Echo request (ping)
9
Router advertisement
10
Router solicitation
11
Time exceeded
12
Parameter problem
13
Time stamp request
14
Time stamp reply
15
Information request
16
Information reply
17
Address mask request
18
Address mask reply
IP Protocol
The Ethernet adapter implements the IPV4 and IPV6 (for DPWS) protocols.
SNMP Services
The Ethernet adapter accepts the community name “private” for writing and the community name “public”
for Reading.
MIB
20
Objects
Description
Access
Default Value
SysDescr
Text description of the product
Read only
Schneider Electric Altivar Ethernet
TCP/IP
SysObjectID
Points in the private MIB on the product
part number
Read only
1.3.6.1.4.1.3833.1.100.4.1
SysUpTime
Time elapsed since the last power-up
Read only
Managed by the option
SysContact
Information allowing to contact the node Read/write
manager
'' ''
SysName
Node administrative name
Read/write
“” or FDR device name if configured
SysLocation
Physical location of the product
Read/write
'' ''
SysService
Indicates the service type offered by the Read only
product.
72
NVE61653 09/2016
Basics
TCP and UDP Protocol
Connections
The Ethernet adapter supports up to 32 concurrent TCP/IP and/or TCP/UDP connection.
BOOTP and DHCP Protocol
The Ethernet adapter can use BOOTP and DHCP protocols.
The BOOTP frame is the same: only the OP field is different.
The following table describes the DHCP frame format:
OP (1 byte)
HTYPE (1 byte)
HLEN (1 byte)
HOPS (1 byte)
XID (4 bytes)
SECS (2 bytes)
FLAGS (2 bytes)
CIADDR (4 bytes)
YIADDR (4 bytes)
SIADDR (4 bytes)
GIADDR (4 bytes)
CHADDR (16 bytes)
SNAME (64 bytes)
FILE (128 bytes)
OPTIONS (312 bytes)
DHCP frame fields are described as follows:
NVE61653 09/2016
Field
Description
op
Message type DHCP request / DHCP reply
htype
Address hardware type
hlen
Hardware address length
hops
Used by relay agent
xid
Transaction identifier, random number chosen by the client allowing to associate the request and the
response
secs
Time in seconds since the beginning of the transaction
flags
First bit used for the broadcast reply flag
ciaddr
Client IP address, only used if the client can respond to ARP request
yiaddr
Client IP address, “your” IP address proposed by the server
siaddr
IP address of the server
giaddr
Gateway IP address, used when a relay agent needs to be crossed
sname
Server name
file
Location of boot file
options
Optional parameters with DHCP extensions
21
Basics
DHCP Message
The DHCP protocol uses 8 different types of message during the IP assigning process.
The following table describes the 8 messages:
Message
Description
DISCOVER
The client tries to discover the DHCP server using a broadcast
OFFER
The server proposes a configuration
REQUEST
The client chooses a DHCP server and declines other offers
ACK
The chosen server assigns the IP configuration
NAK
The server rejects the client request
DECLINE
The client declines the assigned IP configuration
RELEASE
The client releases Its IP address before the end of the lease
INFORM
The client asks for network information (it already has an IP address)
Operating Modes
The choice between DHCP, BOOTP, and fixed configuration is made through one parameter:
 Fixed: the Ethernet adapter uses the address stored in parameter.
 BOOTP: the Ethernet adapter receives the addresses from BOOTP server.
 DHCP: if the device name [XXX] is valid, the Ethernet adapter receives the addresses from the DHCP
server.
22
NVE61653 09/2016
Basics
Section 2.2
Modbus TCP Features
Modbus TCP Features
What Is in This Section?
This section contains the following topics:
Topic
NVE61653 09/2016
Page
Modbus TCP Frames
24
Modbus TCP Servers
25
Supported Modbus TCP Functions
26
Application Profile with Modbus TCP
27
23
Basics
Modbus TCP Frames
TCP Telegrams
Modbus TCP telegrams are not only Modbus standard requests and responses encapsulated in TCP
frames.
1
2
3
4
TCP header
MBPA: Modbus application protocol header
ADU: Application data unit
PDU: Protocol data unit (The Modbus message itself)
MBAP Header Structure
24
Fields
Length
Description
Transaction
identifier
2 bytes
Identification of a Modbus
Initialized by the
request / response transaction client
Client
Server
Recopied by the server
from the received
request
Protocol
identifier
2 bytes
0= Modbus protocol
Initialized by the
client
Recopied by the server
from the received
request
Length
2 bytes
Number of following bytes
Initialized by the
client (request)
Initialized by the server
(response)
Unit identifier
1 byte
Identification of a remote slave Initialized by the
connected on a serial line or on client
other buses
Recopied by the server
from the received
request
NVE61653 09/2016
Basics
Modbus TCP Servers
Overview
NVE61653 09/2016
Unit ID
Modbus TCP server
Accessible parameters
0/248
Variable speed drive
See the file related to drive communication parameters.
255
Drive I/O scanner
See I/O scanner setting (see page 26)
25
Basics
Supported Modbus TCP Functions
Modbus TCP Services
The Modbus TCP option supports the following services:
Function Name
Code
Read holding registers
Dec
Hex
Description
Remarks
Max PDU length: 63 words
03
03 hex
Read N output words
Write 1 output word (Unit ID 0-248 06
only)
06 hex
Write 1 output word
Write multiple registers
16
10 hex
Write N output word
Max PDU length: 63 words
Read/write multiple registers (Uint
ID 0-248 and 255)
23
17 hex
Read/write multiple
registers
Max PDU length: 32 words
(W), 32 words (R)
(Subfunction)
Read device identification
43/14
2B hex
0E hex
Encapsulated interface
transport / read device
identification
See the table below
Identification
Id
Value
Comment
00 hex
Schneider Electric
Device manufacturer
01 hex
ATVXXX
Drive commercial part number
02 hex
0101
Drive version
04 hex
−
−
05 hex
−
−
06 hex
Customized Name
Device name
I/O Scanning Service
The I/O scanning service is used to exchange periodic I/O data between:
 A controller or PLC (I/O scanner).
 Devices (I/O scanning servers).
This exchange is performed by implicit requests, thus avoiding the need to program the controller (PLC).
The I/O scanner periodically generates the read/write multiple registers (23 = 17 hex) request. The I/O
scanning service operates if it has been enabled in the PLC and in the drive. The drive parameters
assigned to I/O scanning have been selected by default. This assignment can be modified by configuration.
When the I/O scanning service has been enabled in the drive:
A TCP connection is assigned to it.
 The parameters assigned in the periodic variables are exchanged cyclically between the Ethernet
adapter and the drive.
 The parameters assigned to the periodic output variables are reserved for I/O scanning. They cannot
be written by other Modbus services, even if the I/O scanner is not sending its periodic output variables.

I/O Scanner Setting
The communication scanner is managed through the DTM-based PC software.
26
Channel
Factory Setting
Output 1
CMd
Output 2
LFrd
Output 3
0
Up to output 32
0
Input 1
EtA
Input 2
rFrd
Input 3
0
Up to Input 32
0
NVE61653 09/2016
Basics
Application Profile with Modbus TCP
Description
The profiles managed with the drive when it is controlled through Modbus TCP are:
 Native profile (CiA402 - IEC 61800-7),
 I/O profile.
For details, refer to CiA®402 - IEC61800-7 functional profile
NVE61653 09/2016
27
Basics
Section 2.3
Ethernet IP Features
Ethernet IP Features
What Is in This Section?
This section contains the following topics:
Topic
28
Page
EtherNet/IP
29
Cyclical Exchanges (Implicit Exchanges)
30
Messaging (Explicit Exchanges)
33
Timeout Monitoring
33
NVE61653 09/2016
Basics
EtherNet/IP
EtherNet/IP Fieldbus Adapter Features Overview
The Ethernet adapter, is compliant with the ODVA drive profile. It supports the following profiles:
 CIP basic speed control
 CIP extended speed control
 Drive native profile (IEC 61800-7 CiA402) and I/O profile only for assembly 100 and 101. In addition to
these cyclic exchanges, the adapter also supports explicit messaging.
 CIP energy objects
NVE61653 09/2016
29
Basics
Cyclical Exchanges (Implicit Exchanges)
Overview
This part gives a description of the assembly sets and how to configure them.
Principle of Control Configuration
By the configuration of the control, it is possible to decide from which channel the drive receives its
commands and reference frequency, either permanently or depending on a switching command.
Numerous configurations are possible. For more information, refer to the programming manual and
communication parameters manual.The following configurations are some of the available possibilities.
The selection of the assembly set is made with the Ethernet adapter.
Control with Communication Scanner
If the default assemblies selected are 100 and 101, the drive is controlled according to its native profile
CiA402.-IEC-61800-7.
By configuring the communication scanner, it is possible to assign any relevant parameter of the drive to
the 32 input and 32 output variables of the assemblies. This is available through the DTM interface.
Control According to ODVA AC Drive Profile
The ODVA AC drive profile is activated when one of the following assemblies is selected:
20: Basic speed control output, size 2 words / 4 bytes
 21: Extended speed control output, size 2 words / 4 bytes
 70: Basic speed control input, size 2 words / 4 bytes
 71: Extended speed control input, size 2 words / 4 bytes

The Ethernet adapter translates the commands, behavior, and display information from of ODVA profile
(on the network) to the CiA402 profile (in the drive).
CIP Basic Speed Control (Assemblies 20 and 70)

Assembly 20: CIP basic speed control output
The following table describes the assembly mapping:
Word Number
Definition
0
CIP basic command word
1
Speed reference (rpm)
The following table describes the CIP basic command word:
Bit 7
Bit 6
Bit 5
Bit 4
Bit 3
Not used
Not used
Not used
Not used
Not used
(1)
(2)
30
Bit 2
(1)
Fault reset
0: No command
1: Fault reset
Bit 1
Bit 0
Not used
Run forward (2)
0: Stop
1: Run
Active on rising edge
Active on level
Bit 15
Bit 14
Bit 13
Bit 12
Bit 11
Bit 10
Bit 9
Bit 8
Not used
Not used
Not used
Not used
Not used
Not used
Not used
Not used
NVE61653 09/2016
Basics

Assembly 70: CIP basic speed control input
The following table describes the assembly mapping:
Word Number
Definition
0
CIP basic status word
1
Actual speed (rpm)
The following table describes the CIP basic command word:
Bit 7
Bit 6
Bit 5
Bit 4
Bit 3
Bit 2
Bit 1
Bit 0
Not used
Not used
Not used
Not used
Not used
Running
0: Stopped
1: Running
Not used
Operating state
fault
0: Inactive
1: Active
Bit 15
Bit 14
Bit 13
Bit 12
Bit 11
Bit 10
Bit 9
Bit 8
Not used
Not used
Not used
Not used
Not used
Not used
Not used
Not used
CIP Extended Speed Control (Assemblies 21 and 71)
NOTE: NetRef and NetCtrl objects must be set by explicit messaging to control the drive by network.

Assembly 21: CIP extended speed control output
The following table describes the assembly mapping:
Word Number
Definition
0
CIP extended command word
1
Speed reference (rpm)
The following table describes the CIP extended command word:
Bit 7
Bit 6
Bit 5
Not used
Network
setpoint
0: Setpoint
by terminal
1: Setpoint
by network
Not used
Network
command
0: Setpoint
by terminal
1: Setpoint
by network
(1)
NVE61653 09/2016
Bit 4
Bit 3
Bit 2
Not used
Bit 1
(1)
Fault reset
0: No command
1: Fault reset
Bit 0
Run forward / reverse
00: Quick stop
01: Run forward
10: Run reverse
11: No action
Active on rising edge
Bit 15
Bit 14
Bit 13
Bit 12
Bit 11
Bit 10
Bit 9
Bit 8
Not used
Not used
Not used
Not used
Not used
Not used
Not used
Not used
31
Basics
Network Setpoint and Network Address Management
The assembly 21 uses the command and reference frequency switching functions of the drive. The
Ethernet adapter, when configured with the assembly 21, links the bit 5 and the bit 6 to C512 and C513
respectively.
To operate correctly, command settings of the drive must be as follows or an [External Error] EPF1 is
triggered.
Menu
Parameter
Settings
[Complete settings] CSt-/[Command and
Reference] CrP-
[Control Mode] CHCF
[Ref Freq 1 Config] Fr1
[Ref Freq 2 Config] Fr2
[Cmd Channel 1] Cd1
[Cmd Channel 2] Cd2
[Command Switching] CCS
[Ref Freq 2 switching] rFC
[Separate] SEP
[Embedded Ethernet] EtH
[Al1] AI1 or [Al2] AI2
[Ethernet] EtH
[Terminals] tEr
[C512] C512
[C513] C513

Assembly 71: CIP extended speed control input
The following table describes the assembly mapping:
Word Number
Definition
0
CIP extended status word
1
Actual speed (rpm)
The following table describes the CIP extended status word:
32
Bit 7
Bit 6
Bit 5
Bit 4
Bit 3
At
reference
0:
Reference
not
reached
1:
Reference
reached
Setpoint
from
network
0: Setpoint
from
terminal
1: Setpoint
from
network
Command
from
network
0: Setpoint
from
terminal
1: Setpoint
from
network
Ready
0: Not
ready
1: Ready
Run forward / reverse
00: Stopped
01: Running forward
10: Running reverse
11: Not used
Bit 2
Bit 1
Bit 0
Operating state
Warning
0: No Warning fault
0: Inactive
1: Warning
1: Active
Bit 15
Bit 14
Bit 13
Bit 12
Bit 11
Bit 10
Not used
Not used
Not used
Not used
Not used
Bit 8 to 10 are used for the drive state
000: Not used
001: Startup
010: Not ready
011: Ready
100: Enabled
101: Stopping
110: Fault stop
111: Operating state fault
Bit 9
Bit 8
NVE61653 09/2016
Basics
Messaging (Explicit Exchanges)
Introduction
Parameters of the drive can be accessed by R/W as CIP objects.
Altivar Parameters Path
The drive parameters are grouped in classes:
 Each application class has only one instance.
 Each instance groups 200 parameter.
 Each attribute in an instance relates to a parameter.
The first parameter registered in the first application class (class code: 70 hex = 112) has the logical
address 3000.
Example
The following table describes the examples of logical addresses:
Logical Address
Hexadecimal
Decimal
3000
70 hex / 01 hex / 01 hex
112/1/1
3100
70 hex / 01 hex / 65 hex
112/1/101
3200
71 hex / 01 hex / 01 hex
113/1/1
64318
A2 hex / 01 hex / 77 hex
418/1/119
For details, refer to the communication parameters manual.
Timeout Monitoring
Description
An EtherNet/IP time-out is triggered if the adapter does not receive any cyclic messages within a
predefined time period. This period is managed by the EtherNet/IP controller (not by the drive) and is
configured in its module properties box. The duration of the time-out is defined by the RPI (Request packet
intervals) and a multiplier.
NVE61653 09/2016
33
Basics
Section 2.4
CIP Object
CIP Object
What Is in This Section?
This section contains the following topics:
Topic
34
Page
Supported Object Classes
35
Identity Object (01 hex)
36
Message Router Object (02 hex)
38
TCP/IP Interface Object (F5 hex)
39
Ethernet Link Object (F6 hex)
42
Assembly Object (04 hex)
44
Connection Manager Object (06 hex)
46
Motor Data Object (28 hex)
48
Control Supervisor Object (29 hex)
49
AC/DC Drive Object (2A hex)
51
Application Object (70 hex to C7 hex) / Explicit Messaging
54
Base Energy Object (4E hex)
55
Electrical Energy Object (4F hex)
57
NVE61653 09/2016
Basics
Supported Object Classes
Introduction
Three categories of object classes can be defined:
 CIP device on EtherNet/IP
 AC/DC drive
 VSD specific
These objects are detailed in the following table:
NVE61653 09/2016
Object class
Class ID
Cat.
No. of
instances
Effect on behavior interface
Identity
01 hex
1
1
Supports the reset service.
Message router
02 hex
1
1
Explicit message connection.
Ethernet link
F6 hex
1
1
Counter and status information.
TCP/IP interface
F5 hex
1
1
TCP/IP configuration.
Connection manager
05 hex
1
1
–
Motor data
28 hex
2
1
Defines data for the motor connected to the
device.
Control supervisor
29 hex
2
1
Manages drive functions, operational states, and
control.
AC/DC drive
2A hex
2
1
Provides drive configuration.
Assembly
04 hex
2
12
Defines I/O data format.
Application
–
3
1
Vendor-specific object - drive parameters.
35
Basics
Identity Object (01 hex)
Overview
The identity object provides identification and status information about the drive.
Class Code
Hexadecimal
Decimal
01 hex
1
Class Attributes
Attribute ID
Access
Name
Data type
1
Get
Revision
Value
Details
UNIT
X
Revision index of the class
2
Get
Max instances
UNIT
1
1 defined instance
3
Get
Number of instances
UNIT
1
–
4
Get
Optional attribute
list
UNIT
1
–
6
Get
Max ID of
class attributes
UNIT
7
–
7
Get
Max ID of
instance attribute
UNIT
7
–
Attribute ID
Access
Name
Data type
Value
Details
1
Get
Vendor ID
UNIT
243
–
2
Get
Device type
UNIT
00 h
02 h
AC/DC drive profile (02h)
3
Get
Product code
UNIT
6152
1830 hex
4
Get
Revision
Struct of:
USINT
USINT
x
Major = high byte of (C1SU)
Minor = low byte of (C1SU)
5
Get
Status
WORD
–
See definition in the following
table
6
Get
Serial number
UDINT
–
First byte: 18 hex
Second…Fourth byte: last
3 bytes of MAC-ID
7
Get
Product name
Struct of:
USINT
STRING
–
ATVxxx
Instance Attributes
Attribute 5–Status
36
Bit
Definition
How
0
Owned by master (predefined
master/slave connection)
No interface
2
Configured
If any of the product (option + drive) NVS attributes has changed
from their default (out of box values).
4-7
Extended device status: See below –
8
Minor recoverable Fault
No minor recoverable fault.
9
Minor unrecoverable Fault
No minor unrecoverable fault.
10
Major recoverable Fault
[Embd Eth Com Interrupt] EtHF detected error or CIP
connection timeout or Ethernet network overload.
11
Major unrecoverable Fault
ILF detected error, EEPROM failed, OB hardware detected
error.
Others
Reserved 0
–
NVE61653 09/2016
Basics
Bit 4-7 Definition
Bit 4-7
Definition
How
0000
Self-testing or unknown
Not used
0001
Firmware update in progress
Not used
0010
At least on faulted I/O connection
–
00 11
No I/O connections established
–
0100
Non-volatile configuration bad
Non-volatile memory detected error in OB
0101
Major fault - either bit 10 or 11 is
true
Bit 10 or 11 is true
0110
At least one I/O connection in run
mode
–
0111
At least one I/O connection
established, all in idle mode
–
1000
1001
Reserved, shall be 0
–
1 0 1 0 to
1111
Vendor specific
–
Supported Class Services
Service code
Service name
01 hex
Get_Attribute_All
Description
Read all attributes
0E hex
Get_Attribute_Single
Read one attribute
Supported Instance Services
NVE61653 09/2016
Service code
Service name
Description
01 hex
Get_Attribute_All
Read all attributes
0E hex
Get_Attribute_Single
Read one attribute
10 hex
Set_Attribute_Single
Write one attribute
05 hex
Reset
Perform the reset of the drive
37
Basics
State Diagram for the Identity Object
Message Router Object (02 hex)
Overview
The message router object is the element through which all the Explicit messages objects pass in
order to be directed towards the truly destined objects.
Class Code
Hexadecimal
Decimal
02 hex
2
Class Attributes
38
Attribute ID
Access
Name
1
Get
Revision
Need
Data type
Value
Details
Opt.
UINT
X
Revision index of the class
2
Get
Max instances
Opt.
UINT
1
1 defined instance
NVE61653 09/2016
Basics
TCP/IP Interface Object (F5 hex)
Supported Class Attributes
Attribute ID
Access
Name
Data type
Value
Detail
1
Get
Revision
UINT
X
Revision index of the class
2
Get
Max instances
UINT
1
1 defined instance
3
Get
Number of instances
UINT
1
–
4
Get
Optional attribute list UINT
1
–
5
Get
Optional service list
UINT
1
–
6
Get
Max ID of class
attributes
UINT
7
–
7
Get
Max ID of
instance attribute
UINT
6
–
Supported Instance Attributes
Attribute ID
Access
Name
Data type
Detail
1
Get
Status
DWORD
0 = The interface configuration attribute
has not been configured
1 = The interface configuration attribute
contains valid configuration
2
Get
Configuration capab
ility
DWORD
Bit 0 = 1 (TRUE) shall indicate that the
device is capable of obtaining its network
configuration via BOOTP
Bit 1 = 1 (TRUE) shall indicate that the
device is capable of resolving host names
by querying a DNS server
Bit 2 = 1 (TRUE) shall indicate that the
device is capable of obtaining its network
configuration via DHCP
Bit 3 = 1 (TRUE) shall indicate that the
device is capable of sending its host
name in the DHCP request
Bit 4 = 1 (TRUE) shall indicate that the
Interface Configuration attribute is
settable.
Bit 5-31: reserved
3
Get/Set
Configuration contr
ol
DWORD
Bits 0-3 start-up configuration
0 = The device shall use the interface
configuration values previously stored
1 = The device shall obtain its interface
configuration values via BOOTP
2 = The device shall obtain its interface
configuration values via DHCP upon
start-up (1)
3-15 = Reserved for future use
Bit 4 = 1 (TRUE), the device shall resolve
host names by querying a DNS server
Bit 5-31: reserved
4
Get
Physical link
object
STRUCT of
UINT
EPATH
Path size
Path: Logical segments identifying the
physical link object
Example [20][F6][24][01]: [20] = 8-bit
class segment type;
[F6] = Ethernet link object class; [24] = 8bit instance segment type; [01] = instance
1
(1) If set option board parameter OBP:FDRU=0 is also set to implicitly disable the FDR mechanism on the DHCP
protocol. This to be compatible with CIP tools that has configured the device to operate in a non-FDR specific
environment. You have to manually enable the feature if you wish to use it.
NVE61653 09/2016
39
Basics
Attribute ID
Access
Name
Data type
5
Get/Set
Interface configura
tion
STRUCT of
UDINT
UDINT
UDINT
UDINT
UDINT
String
Detail
6
Get/Set
Host name
String
Read/write name of the drive
8
Get/Set
TTL value
USINT
TTL value for EtherNet/IP multicast
packets
9
Get/Set
Mcast config
Struct Of.
IP multicast address configuration
Alloc control
USINT
0 - Use default allocation algorithm to
generate multicast addresses
1 - Multicast addresses shall be allocated
according to the values in Num Mcast and
Mcast Start Addr
Reserved
USINT
Shall be 0
Num Mcast
UINT
Number of multicast addresses to
allocate for EtherNet/IP
Mcast Start Addr
UDINT
Starting multicast address from which to
begin allocation
IP address (0: no address configured)
Network mask (0: no network mask
configured)
Gateway address (0: no address
configured)
Name server address (0: no address
configured)
Name server address 2 (0: no address
configured)
Domain name
(1)
If set option board parameter OBP:FDRU=0 is also set to implicitly disable the FDR mechanism on the DHCP
protocol. This to be compatible with CIP tools that has configured the device to operate in a non-FDR specific
environment. You have to manually enable the feature if you wish to use it.
Supported Class Services
Service code
Service name
Description
01 hex
Get_Attribute_All
Read all attributes
0E hex
Get_Attribute_Single
Read one attribute
10 hex
Set_Attribute_Single
Write one attribute
Service name
Description
Supported Instance Services
Service code
40
0E hex
Get_Attribute_Single
Read one attribute
10 hex
Set_Attribute_Single
Write one attribute
01 hex
Get_Attribute_All
–
NVE61653 09/2016
Basics
TCP/IP Interface Behavior
NVE61653 09/2016
41
Basics
Ethernet Link Object (F6 hex)
Class Attributes
Attribute ID
Access
Name
Data type
Value
Details
1
Get
Revision
UINT
X
Revision index of the class
2
Get
Max instances
UINT
1
One defined instance
3
Get
Number of instances
UINT
1
–
6
Get
Max ID of
class attributes
UINT
7
–
7
Get
Max ID of instance
attribute
UINT
6
–
Supported Instance Attributes
Attribute ID
Access
Name
1
Get
Interface speed
Data type
Detail
UDINT
Interface speed currently in use
2
Get
Interface flags
DWORD
Bit 0: Link status indicates whether the
Ethernet 802.3 communications interface
is connected to an active network. 0
indicates an inactive link; 1 indicates an
active link
Bit 1: Half/Full duplex indicates the duplex
mode currently in use. 0 indicates that the
interface is running half duplex; 1
indicates full duplex
Bit 2-4: Negotiation status
 0: Auto-negotiation in progress
 1: Auto-negotiation and speed
detection not successful
 2: Auto negotiation not successful but
detected speedduplex was defaulted
 3: Successfully negotiated speed and
duplex
 4: Auto-negotiation not attempted.
Forced speedand duplex
Bit 5: Manual setting require reset
 0: Indicates that the interface can
activate changes to link parameters
(autonegotiate, duplex mode,
interface speed) automatically
 1: Indicates that the device requires a
reset service be issued to its identity
object in order for the changes to take
effect.
Bit 6: Local hardware error
 0: Indicates that the interface detects
no local hardware error
 1: Indicates that a local hardware error
is detected. The meaning of this is
product-specific
Bit 7-31: Reserved shall be set to zero
3
42
Get
Physical address
USINT [6]
MAC layer address
4
Get
Interface counters
–
–
5
Get
Media counters
–
–
6
Get/Set
Interface control
–
Force auto negotiate, half full and speed
7
Get
Interface type
USINT
2
10
Get
Interface label
SHORT_STRIN Instance 1: “Top”
G
Instance 2: “Bottom”
Service code
NVE61653 09/2016
Basics
Supported Class Services
Service code
Service name
Description
0E hex
Get_Attribute_Single
Read one attribute
01 hex
Get_Attribute_All
–
Supported Instance Services
NVE61653 09/2016
Service code
Service name
Description
0E hex
Get_Attribute_Single
Read one attribute
10 hex
Set_Attribute_Single
Write one attribute
01 hex
Get_Attribute_All
–
4C hex
Get_And_Clear
Same than Get_Attribute_Single
43
Basics
Assembly Object (04 hex)
Supported Class Attributes
Attribute ID
Access
Name
Data type
Value
Detail
1
Get
Revision
UINT
X
Revision index of the class
2
Get
Max instances
UINT
1
One defined instance
3
Get
Number of instances
UINT
1
–
6
Get
Max ID of
class attributes
UINT
7
–
7
Get
Max ID of
instance attribute
UINT
3
–
Supported Instances
Attribute ID
Access
Name
Data type
3
Get/Set
Data
ARRAY OF BYTE
4
Get
Size
UINT
Value
Details
Supported Instances for Altivar Process
Instance
Type
Name
20
AC drive output
CIP Basic Speed Control Output
21
AC drive output
CIP Extended Speed Control Output
70
AC drive input
CIP Basic Speed Control Input
71
AC drive input
CIP Extended Speed Control Input
100
AC drive output
Native Drive Output
101
AC drive input
Native Drive Input
Supported Class Services
Service code
Service Name
Description
0E hex
Get_Attribute_Single
Read one attribute
Supported Instance Services
44
Service Code
Service Name
Description
0E hex
Get_Attribute_Single
Read one attribute
10 hex
Set_Attribute_Single
Write one attribute
NVE61653 09/2016
Basics
Output Instance Data Description
Instance
Byte
Bit 7
Bit 6
Bit 5
Bit 4
Bit 3
Bit 2
Bit 1
Bit 0
20
0
X
X
X
X
X
Fault Reset
0 = No
command
1= Fault Reset
X
Run Forward
0 = Stop
1 = Run
1
X
X
X
X
X
X
X
X
21
100
70
71
101
2-3
Speed Actual (rpm)
0
X
Net
Reference
0 = Local, by
terminal
1= Network
NetComman X
d
0 = Local
1 = Network
X
Fault Reset
0 = No
command
1= Fault Reset
Run Fwd / Reverse:
00: Quick stop
01: Run forward
10: Run reverse
11: No action
1
X
X
X
X
X
X
X
X
2-3
Speed Actual (rpm)
0-1
I/O Scanning word 1
2-3
I/O Scanning word 2
4-5
I/O Scanning word 3
6-7
I/O Scanning word 4
8-9
I/O Scanning word 5
10-11
I/O Scanning word 6
0
X
X
X
X
X
0 = Stopped
1 = Running
X
0 = No error
1 = Error
1
X
X
X
X
X
X
X
X
2-3
Speed Actual (rpm)
0
At reference
0 = Not
reached
1 = Reached
Ref From Net
0 = From
terminal
1 = From
network
Cmd From
Net
0 = From
terminal
1 = From
network
Ready
0 = Not
ready
1 =Ready
Running Fwd / reverse
00: Stopped
01: Running Forward
10: Running reverse
11: Not used
Warning
0 = No
warning
1=
Warning
Not used
1
X
X
X
X
X
2-3
Speed Actual (rpm)
0-1
Scanner Read word 1
2-3
Scanner Read word 2
4-5
Scanner Read word 3
6-7
Scanner Read word 4
8-9
Scanner Read word 5
10-11
Scanner Read word 6
NVE61653 09/2016
000: Not used
001: Startup
010: Not ready
011: Ready
100: Enabled
101: Stopping
110: Fault stop
111: Operating state fault
45
Basics
Connection Manager Object (06 hex)
Class Code
Hexadecimal
Decimal
06 hex
6
Class Attributes
Attribute ID
Access
Name
Need
Data type
Value
Details
1
Get
Revision
Opt.
UINT
X
Revision index of the class
2
Get
Max instances
Opt.
UINT
4
3 defined instance
Attributes of Instance 1 - Explicit Message Instance
Attribute
Access
Name
Need
Data type
Value
Details
1
Get
State
Req.
USINT
–
0: Non-existent
3: Established
5: Deferred
Delete
2
Get
Instance_type
Req.
USINT
0
Explicit Message
3
Get
TransportClass_trigger
Req.
BYTE
83 hex
Class 3 server
4
Get
Produced_connection_id
Req.
UINT
10xxxxxx01
1
xxxxxx = Node
address
5
Get
Consumed_connection_id
Req.
UINT
10xxxxxx10
0
xxxxxx = Node
address
6
Get
Initial_comm_characteri Req.
stics
BYTE
21 hex
Explicit
messaging via
Group 2
7
Get
Produced_connection_siz Req.
e
UINT
36
Produced data
maximum size
(in bytes)
8
Get
Consumed_connection_siz Req.
e
UINT
36
Consumed data
maximum size
(in bytes)
9
Get/Set
Expected_packet_rate
Req.
UINT
2500
2.5 sec.
(TimeOut)
12
Get/Set
Watchdog_timeout_action Req.
USINT
1 or 3
1: Auto-Delete
3: Deferred
Delete (Default)
13
Get
Produced connection
path length
Req.
UINT
0
Length of
attribute 14 data
14
Get
Produced connection
path
Req.
Array of
UINT
Null
Not used
15
Get
Consumed connection
path length
Req.
UINT
0
Length of
attribute 16 data
16
Get
Consumed connection
path
Req.
Array of
UINT
Null
Not used
For details, refer to Ethernet/ specification for more information.
46
NVE61653 09/2016
Basics
Supported Class Attributes
Attribute ID
Access
Name
Data type
Value
Details
1
Get
Revision
UINT
X
Revision index of the class
2
Get
Max Instances
UINT
1
1 defined instance
3
Get
Number of Instances
UINT
1
–
4
Get
Optional attribute
list
STRUCT of
–
List of optional attribute
numbers
6
Get
Max ID of class
attributes
UINT
7
–
7
Get
Max ID of
instance attributes
UINT
–
Attribute ID number of last
class attribute
Supported Instance1 (Explicit) Attributes
Attribute ID
Access
Name
Data type
Details
1
Get
Open Requests
UINT
Number of forward open service requests
received.
2
Get
Open Format Rejects
UINT
Number of forward open service requests
which were rejected due to bad format.
3
Get
Open Resources Reje
cts
UINT
Number of forward open service requests
which were rejected due to lack of
resources.
4
Get
Open Other Rejects
UINT
Number of forward open service requests
which were rejected for reasons other than
bad format or lack of resources.
5
Get
Close Requests
UINT
Number of forward close service requests
received.
6
Get
Close Format Reques
ts
UINT
Number of forward close service requests
which were rejected due to bad format.
7
Get
Close Other Request
s
UINT
Number of forward close service requests
which were rejected for reasons other than
bad format.
8
Get
Connection Timeouts
UINT
Total number of connection timeouts that
have occurred in connections controlled by
this connection manager.
Supported Class Services
Service code
Service name
Description
01 hex
Get_Attribute_All
Read all attributes
0E hex
Get_Attribute_Single
Read one attribute
Supported Instance Services
NVE61653 09/2016
Service code
Service name
Description
0E hex
Get_Attribute_Single
Read one attribute
10 hex
Set_Attribute_Single
Write one attribute
4E hex
Forward_Close
Closes a connection
54 hex
Forward_Open
Opens a connection, maximum data
size is 511 bytes
47
Basics
Motor Data Object (28 hex)
Supported Class Attributes
Attribute ID
Access
Name
Data type
Value
Details
1
Get
Revision
UINT
X
Revision index of the class
2
Get
Max Instances
UINT
1
One defined instance
3
Get
Number of Instances
UINT
1
–
6
Get
Max ID of class attribu UINT
tes
7
–
7
Get
Max ID of
instance attribute
UINT
15
–
Data type
ATV
Supported Instance Attributes
Attribute ID
Access
Name
Need
1
Get
NumAttr
Details
Opt.
USINT
No
–
2
Get
Attributes List
Opt.
USINT
(ARRAY)
No
–
3
Get
MotorType
Req.
USINT
Yes
7
6
Get/Set
RatedCurrent
Req.
UINT
Yes
Motor nominal current
Linked to NCR drive
parameter.
NCR unit is 0,1 A as
attribute 6
7
Get/Set
RatedVoltage
Req.
UINT
Yes
Motor nominal voltage
Linked to UNS drive
parameter
UNS unit is 1 V as attribute
7
8
Get/Set
RatedPower
Opt.
UINT
No
–
9
Get/Set
RatedFreq
Opt.
UINT
Yes
Motor nominal frequency
linked to FRS drive
parameter FRS unit is
0,1 Hz.
The parameter value has to
be divided by 10 to be in the
unit of attribute 9
12
Get/Set
PoleCount
Opt.
UINT
No
–
15
Get/Set
BaseSpeed
Opt.
UINT
Yes
Motor nominal speed
Linked to NSP drive
parameter
NSP unit is 1 rpm as
attribute 15
Supported Class Services
Service code
Service name
Description
0E hex
Get_Attribute_Single
Read one attribute
Service code
Service name
Description
0E hex
Get_Attribute_Single
Read one attribute
10 hex
Set_Attribute_Single
Write one attribute
Supported Instance Services
48
NVE61653 09/2016
Basics
Control Supervisor Object (29 hex)
Supported Class Attributes
Attribute ID
Access
Name
Data type
Value
Details
1
Get
Revision
UINT
X
Revision index of the class
2
Get
Max Instances
UINT
1
One defined instance
3
Get
Number of Instances
UINT
1
–
6
Get
Max ID of class attrib UINT
utes
7
–
7
Get
Max ID of
instance attribute
17
–
UINT
Supported Instance Attributes for Schneider Electric
Attribute ID
Access
Name
Data type
Details
3
Get/Set
Run Fwd
BOOL
On edge (0 --> 1)
4
Get/Set
Run Rev
BOOL
On edge (0 --> 1)
5
Get/Set
Net Ctrl
BOOL
0: Local control
1: Network control (default)
6
Get
State
USINT
See machine status:
0:
1: Startup
2: Not_Ready
3: Ready
4: Enabled
5: Stopping
6: Fault_stop
7: Operating state fault
7
Get
Running Fwd
BOOL
ETA.15 = 0
8
Get
Running Rev
BOOL
ETA.15 = 1
9
Get
Ready
BOOL
ETA.1 = 1
10
Get
Error detected
BOOL
ETA.3 = 1
12
Get/Set
Fault Reset
BOOL
CMD.7 = 1.
13
Get
Error Code
USINT
Parameter Errd
15
Get
Ctrl From Net
BOOL
0: Local Control
1: Network Control
16
Get/Set
DN Error Mode
USINT
Action on loss of CIP network.
0: Stop + [Embd Eth Com Interrupt] EtHF
detected error
1: Ignored
17
Get/Set
Force error
BOOL
Force [Embd Eth Com Interrupt] EtHF
detected error (On edge)
Supported Class Services
Service code
Service name
Description
0E hex
Get_Attribute_Single
Read one attribute
Supported Instance Services
NVE61653 09/2016
Service code
Service name
Description
0E hex
Get_Attribute_Single
Read one attribute
10 hex
Set_Attribute_Single
Write one attribute
05 hex
Reset
Reset drive
49
Basics
Control Supervisor States
50
NVE61653 09/2016
Basics
AC/DC Drive Object (2A hex)
Supported Class Attributes
Attribute ID
Access
Name
Data type
Value
Details
1
Get
Revision
UINT
X
Revision index of the class
2
Get
Max Instances
UINT
1
1 defined instance
3
Get
Number of Instances
UINT
1
–
6
Get
Max ID of
class attributes
UINT
7
–
7
Get
Max ID of
instance attribute
UINT
21
–
Supported Instance
Attribute ID
Access
Name
Need
1
Get
NumAttr
Data type
ATV
Comments
Opt.
USINT
No
–
2
Get
Attributes List
Opt.
USINT
(ARRAY)
No
–
3
Get
At Reference
Opt.
BOOL
Yes
Use the result of the “reference
reached” function of the device.
No more, no less specific adjustment
than what is in the drive function.
4
Get/Set
NetRef
Req.
BOOL
Yes
Image of the NetRef signal received
from the network.
'Get' order returns the value written by
'Set' order.
Used to manage the reference
channel.
6
Get
Drive mode
Req.
USINT
Yes
Used to get the drive mode.
In the standard, the attribute can also
be used to set the drive mode, but it is
not possible on our products.
Value is fixed at 1.
NOTE: On other drives this value
main depends on the Motor control
law set in the device.
7
Get
Speed Actual
Req.
INT
Yes
Used to get the value of the motor
Speed.
Unit: rpm
8
Get/Set
SpeedRef
Req.
INT
Yes
Image of the speed reference signal
received from the network.
Unit: rpm
'Get' order returns the value written by
'Set' order Used to set the speed
reference in the drive.
9
Get
Current Actual
Opt.
INT
Yes
Used to get the value of the current in
the motor.
Unit: 0.1 Amps
10
Get/Set
Current Limit
Opt.
INT
Yes
Used to set or get the current value
used for the motor thermal protection.
Unit: 0,1 Amps.
11
Get
Torque Actual
Opt.
INT
Yes
Used to get the value of the motor
torque.
Unit: 1 N.m
(1)
For the standard, the acceleration, and deceleration time are given to go from 0 to [HighSpdLimit] (attribute 21 of
AC/DC drive object). For the drive, the acceleration and deceleration time are given to go from 0 to the motor nominal
frequency (FrS parameter).
(2)
In the drive, the unit of acceleration and deceleration time depends on INR parameter.
Inr = 0: acceleration and deceleration time are in 0,01 s
Inr = 1 (factory setting): acceleration and deceleration time are in 0,1 s
Inr = 2: acceleration and deceleration time are in 1 s
NVE61653 09/2016
51
Basics
Attribute ID
Access
Name
Need
Data type
ATV
Comments
15
Get
Power Actual
Opt.
INT
No
Used to get the value of the output
power.
Unit 1 <--> 1/2PowerScale.
18
Get/Set
AccelTime
Opt.
UINT
Yes
Used to get and set the acceleration
time(1)(2)
19
Get/Set
DecelTime
Opt.
UINT
Yes
Used to get and set the deceleration
time(1)(2)
20
Get/Set
LowSpdLimit
Opt.
UINT
Yes
Used to get and set the low speed
limit.
Units: rpm
21
Get/Set
HighSpdLimit
Opt.
UINT
Yes
Used to get and set the high speed
limit.
Units: rpm
26
Get/Set
PowerScale
Opt.
SINT
No
–
28
Get/Set
TimeScale
Opt.
SINT
No
Default value = 0
29
Get
RefFromNet
Opt.
BOOL
No
Used to know if the drive is processing
the reference sent by the network that
asks the attribute 29 value
46
Get
Cumulative Run
Time
Brand UINT
No
Cumulative run time
(1)
For the standard, the acceleration, and deceleration time are given to go from 0 to [HighSpdLimit] (attribute 21 of
AC/DC drive object). For the drive, the acceleration and deceleration time are given to go from 0 to the motor nominal
frequency (FrS parameter).
(2)
In the drive, the unit of acceleration and deceleration time depends on INR parameter.
Inr = 0: acceleration and deceleration time are in 0,01 s
Inr = 1 (factory setting): acceleration and deceleration time are in 0,1 s
Inr = 2: acceleration and deceleration time are in 1 s
52
Attribute ID
Details
3
Attribute value = value of bit 10 of ETA drive parameter
7
Motor speed.
Linked to rFrd drive parameter.
(rFrd is in 1 rpm as attribute 7
8
Speed reference.
Linked to LFrd drive parameter.
LFrd is in 1 rpm as attribute 8
9
Actual current in the motor.
Linked to LCr drive parameter.LCr is in 0,1 A as attribute 9
10
Current value used for the motor thermal protection.
Linked to ItH drive parameter.
ItH is in 0,1 A as attribute 10
11
Actual torque in the motor.
Linked to Otrn drive parameter.
Otrn is in 0,1 N.m.
The value has to be multiplied by 10 to be in the unit of attribute 11
18
Acceleration time.
Linked to ACC drive parameter.
See note (2) of the specification above
19
Deceleration time.
Linked to DEC drive parameter.
See note (2) of the specification above
20
Low speed.
Linked to SMIL drive parameter.
SMIL is in 1 rpm as attribute 20
21
High speed.
Linked to SMAL drive parameter.
SMAL is in 1 rpm as attribute 21
NVE61653 09/2016
Basics
Supported Class Services
Service code
Service name
Description
0E hex
Get_Attribute_Single
Read one attribute
Service code
Service name
Description
0E hex
Get_Attribute_Single
Read one attribute
10 hex
Set_Attribute_Single
Write one attribute
Supported Instance Services
NVE61653 09/2016
53
Basics
Application Object (70 hex to C7 hex) / Explicit Messaging
Application Object Behavior
Class = ((AdL - 3000) / 200) + 70 hex
Instance = 1
Attribute = (AdL % 200) + 1
AdL = (class - 70 h) * 200 + attribute - 1 + 3000
This rule allows the access to address under 20599. The other addresses are not accessible.
The drive parameters are grouped into classes.
 Each application class has only one instance.
 Each instance groups 200 parameters.
 Each attribute in an instance relates to a parameter.
Supported Class Attributes
Attribute ID
Access
Name
Data type
Value
Details
1
Get
Revision
UINT
X
Revision index of the class
2
Get
Max Instances
UINT
1
One defined instance
3
Get
Number of Instances
UINT
1
–
6
Get
Max ID of class attrib
utes
UINT
7
–
7
Get
Max ID of instance att
ribute
UINT
X
–
Attribute ID
Access
Name
Data type
Details
1
Get/Set
1st parameter of
the block
UINT
Value returned by the drive at address xx
–
–
–
–
Value returned by the drive at address xx
X
Get/Set
Last parameter of the
block
UINT
Value returned by the drive at address xx
Supported Instance Attributes
Supported Class Services
Service code
Service name
Description
0E hex
Get_Attribute_Single
Read one attribute
Service code
Service name
Description
0E hex
Get_Attribute_Single
Read one attribute
10 hex
Set_Attribute_Single
Write one attribute
Supported Instance Services
54
NVE61653 09/2016
Basics
Base Energy Object (4E hex)
Overview
The base energy object acts as an Energy Supervisor for CIP Energy implementations. It is responsible
for providing a time base for energy values, provides energy mode services, and can provide aggregation
services for aggregating energy values up through the various levels of an industrial facility. It also provides
a standard format for reporting energy metering results.
Class Code
Hexadecimal
Decimal
4E hex
78
Class Attributes
Attribute ID
Access
Name
Data type
Value
Details
1
Get
Revision
UINT
X
Revision index of the class
2
Get
Max instances
UINT
1
1 defined instance
3
Get
Number of instances UINT
1
–
Instance Attributes
Attribute ID
Access
Name
Data type
Value
Details
1
Get
Energy/Resource Type
UINT
1
1 = Electrical
2
Get
Base Energy
Object Capabilities
UINT
–
See definition in the following table
3
Get
Energy Accuracy
UINT
–
See definition in the following table
4
Get
Energy Accuracy Basis
UINT
–
See definition in the following table
7
Get
Consumed Energy
Odometer
ODOMETE –
R
The consumed energy value in kWh
8
Get
Generated Energy
Odometer
ODOMETE –
R
The generated energy value in kWh
9
Get
Net Energy Odometer
–
SIGNED_
ODOMETE
R
The generated energy value in kWh
The following table provides the Odometer and Signed_Odometer structure principle:
Data Type Structure
Description of Data Type Semantics of Value
Element
ODOMETER STRUCT of:
SIGNED_ODOMETER
STRUCT of:
–
–
UINT
INT
x10n
±Unit1 x 10n
UINT
INT
x10n+3
±Unit1 x 10n+3
UINT
INT
x10n+6
±Unit1 x 10n+6
UINT
INT
x10n+9
±Unit1 x 10n+9
UINT
INT
x10n+12
±Unit1 x 10n+12
The valid range of n shall be a SINT between 0 and -15.
The following table provides the Odometer type in Kilowatt-hours units and n = -3:
x10n+12
x10n+9
Terawatt-hours (kWh Gigawatt-hours (kWh x
x 109)
106)
NVE61653 09/2016
x10n+6
x10n+3
Megawatt-hours (kWh x Kilowatt-hours (kWh)
103)
x10n
Watt-hours (kWh x
10-3)
55
Basics
Attribute 1-Energy/Resource Type
This attribute specifies the type of energy managed by this Base Energy Object instance. If this attribute
value = 1 Electrical, then this instance of the Base Energy Object is associated with a corresponding
instance of the Electrical Energy Object pointed to by attribute 12.
Attribute 2-Base Energy Object Capabilities
The value indicates how Energy Odometer values are generated and/or how Energy Transfer Rates are
generated or specified.
Value
Name
Definition
0
Energy Measured
Indicates that the instance reports energy values that are directly measured by
the device
Attribute 3-Energy Accuracy
This attribute specifies the accuracy of metering energy results. By default, it specifies the accuracy of
energy metering results as 100 times the percentage of reading. A value of 500 indicates a device accuracy
of 5% of reading.
Attribute 4-Energy Accuracy Basis
This optional attribute defines the basis of the Energy Accuracy attribute.
Value
Name
Definition
0
Per cent of
reading
Error = (Energy Accuracy value / 100) * Delta Energy
Attribute 7-Consumed Energy Odometer
The Consumed Energy Odometer represents a range of 0 kWh to 999,999,999,999.999 kWh.
Section
Description
Consumed energy value in kWh
Odometer structure: 5x16 bits parameters give a value of consumed energy
value in kWh.
Attribute 8-Generated Energy Odometer
The generated energy odometer represents a range of 0 kWh to 999,999,999,999.999 kWh.
Section
Description
Generated energy value in kWh
Odometer structure: 5x16 bits parameters give a value of generated energy
value in kWh.
Attribute 9-Net Energy Odometer
The net energy odometer represents a range of -999,999,999,999.999 kWh to 999,999,999,999.999 kWh.
56
Section
Description
Total energy value in kWh
Signed odometer structure: 5x16 bits parameters give a value of total energy
value in kWh.
NVE61653 09/2016
Basics
Electrical Energy Object (4F hex)
Overview
This object is used to provide unified electrical energy reporting capability for CIP enabled devices and
processes. Energy reporting is typically related to the measurement of various metering results. This object
provides for the consistent reporting of electrical energy data. Electrical energy is assigned a separate
object to accommodate its alternating and polyphase characteristics, which result in a collection of
attributes that are unique among energy sources.
Each instance of the Electrical Energy Object shall be associated with an instance of the Base Energy
Object (class code 0x4E). Instance attribute 41, Associated Base Energy Object Path is used to define this
association.
Class Code
Hexadecimal
Decimal
4F hex
79
Class Attributes
Attribute ID
Access
Name
Data type
Value
Details
1
Get
Revision
UINT
X
Revision index of the class
2
Get
Max instances
UINT
1
1 defined instance
3
Get
Number of instance
s
UINT
1
–
Attribute ID
Access
Name
Data type
Value
Details
1
Get
Real Energy
Consumed Odometer
ODOMETE
R
–
The total real energy consumed in
kWh
2
Get
Real Energy
Generated Odometer
ODOMETE
R
–
The total real energy generated in
kWh
3
Get
Real Energy
Net Odometer
SIGNED_
ODOMETE
R
–
The running total of Real Energy
Consumed minus Real Energy
Generated in kWh
9
Get
Line Frequency
REAL
–
Line Frequency (0.1 Hertz)
Available on Low harmonic drives
13
Get
Average Current
REAL
–
RMS line current of three-phase
average (0.1 Amps)
Available on Low harmonic drives
19
Get
L1-L2 Voltage
REAL
–
RMS L1 to L2 voltage (0.1 Volts)
20
Get
L2-L3 Voltage
REAL
–
RMS L2 to L3 voltage (0.1 Volts)
21
Get
L3-L1 Voltage
REAL
–
RMS L3 to L1 voltage (0.1 Volts)
22
Get
Average L-L Voltage
REAL
–
RMS line to line voltage threephase average (0.1 Volts)
27
Get
Total Real Power
REAL
–
Total real power, signed to show
direction (Watts)
41
Get
Associated Base
Energy Object Path
SRUCT of:
–
Path to associated Base Energy
Object instance
Path Size
UNIT
–
Size of path (in words)
Path
Padded
EPATH
–
This is an array of bytes whose
contents convey the application
path and other information of the
request for this transaction
Instance Attributes
NVE61653 09/2016
57
Basics
Attribute 1-Real Energy Consumed Odometer
The Real Energy Consumed Odometer represents a range of 0 kWh to 999,999,999,999.999 kWh.
Section
Description
Total real energy consumed value in
kWh
Odometer structure: 5x16 bits parameters give a value of consumed energy
value in kWh.
Attribute 2-Real Energy Generated Odometer
The Real Energy Generated Odometer represents a range of 0 kWh to 999,999,999,999.999 kWh.
Section
Description
Total real energy generated value in
kWh
Odometer structure: parameters give a value of generated energy value in
kWh.
Attribute 3-Real Energy Net Odometer
The Real Energy Net Odometer represents a range of -999,999,999,999.999 kWh to
999,999,999,999.999 kWh.
Section
Description
Total real energy net value in kWh
Signed odometer structure: 5x16 bits parameters give a value of total real
energy net value in kWh.
Attribute 27- Total Real Power
This attribute expresses the time rate of energy transfer as a REAL value, expressed in engineering units
of kilowatts (kW). A positive value indicates consumption of energy, while a negative value indicates
generation of energy.
Attribute 41- Associated Base Energy Object Path
The Base Energy Object (class code 0x4E) acts as an energy supervisor for CIP Energy implementations.
58
NVE61653 09/2016
Altivar Machine ATV340
Hardware Setup
NVE61653 09/2016
Chapter 3
Hardware Setup
Hardware Setup
What Is in This Chapter?
This chapter contains the following topics:
Topic
NVE61653 09/2016
Page
Hardware Presentation
60
Firmware Version
60
Electrical Installation
61
Cable Routing Practice
62
59
Hardware Setup
Hardware Presentation
Ethernet Dual Port
The figure shows Ethernet adapter equipped with 2 RJ45 connectors
ATV340U07N4E to ATV340D22N4E
ATV340D30N4E to ATV340D75N4E
1: Ethernet dual port adapter
Firmware Version
Compatibility
There is no specific firmware for the Ethernet adapter. The drive firmware embeds the Ethernet adapter
firmware.
60
NVE61653 09/2016
Hardware Setup
Electrical Installation
Pin Layout
The drive is equipped with 2 RJ45 female sockets for the Ethernet connection.
The table provides the pin out details of each RJ45 connector:
Pin
Signal
Meaning
1
Tx+
Ethernet transmit line +
2
Tx-
Ethernet transmit line –
3
Rx+
Ethernet receive line +
4
−
−
5
−
−
6
Rx-
Ethernet receive line –
7
−
−
8
−
−
Cable Specification
Cable specifications are as follows:
 Minimum Cat 5e,
 Use equipotential bonding conductors (100 BASE-TX, category 5e or industrial Ethernet fast connect)
 Connector RJ45, no crossover cable
 Shield: both ends grounded
 Twisted-pair cable
 Verify that wiring, cables, and connected interfaces meet the PELV requirements.
 Maximum cable length per segment = 100 m (328 ft) / 6 plugs
NOTE: RSTP function is not compatible with half duplex configuration. All devices involved in the RSTP
topology shall be RSTP capable and configured.
NVE61653 09/2016
61
Hardware Setup
Cable Routing Practice
Installation Topology
The Ethernet adapter enables several wiring solutions:
 Daisy chain and/or Star topology
NOTE: In daisy chain topology, if one drive is turned off, an [Embd Eth Com Interrupt] EtHF error is
trigged in the other drives connected to the same topology. To keep the integrity of Ethernet daisy chain
network when one or more drives are powered off, add an external permanent 24VDc supply to the
control block of the drive.

62
Redundant ring topology with RSTP (with an RSTP switch)
NVE61653 09/2016
Hardware Setup
NVE61653 09/2016

Redundant ring topology with RSTP (with a RSTP PLC)

Redundant star topology with RSTP
63
Hardware Setup
The following figure shows the direct connection between the drive and PC.
64
NVE61653 09/2016
Altivar Machine ATV340
Software Setup
NVE61653 09/2016
Chapter 4
Software Setup
Software Setup
What Is in This Chapter?
This chapter contains the following sections:
Section
NVE61653 09/2016
Topic
Page
4.1
Basic Settings
66
4.2
Additional Settings
76
4.3
Fast Device Replacement
84
4.4
Communication Profile
91
4.5
Embedded Webserver
109
4.6
Software Setup with SoMachine (M251)
115
65
Software Setup
Section 4.1
Basic Settings
Basic Settings
What Is in This Section?
This section contains the following topics:
Topic
66
Page
IP Parameter Settings
67
[Device Name] PAn
68
[IP mode Ether. Embd ]IM00
68
[IP address]IC01IC02IC03IC04
69
[Mask] IM01IM02IM03IM04
69
[Gateway] IG01IG02IG03IG04
70
[Enable FDR] FdV0
70
[FDR Action] FdA0
71
[FDR Operating State] FdS0
71
[FDR Error Status] Fdr0
72
[MAC @] MACO
72
[ETH emb Rx frames] ErXE
73
[ETH emb Tx frames] ETXE
73
[ETH emb error frames] EErE
73
[Ethernet Rate Data] ArdE
73
[Enable Webserver]EWEE
74
[Reset EmbWeb] rWPE
74
[Ethernet Embd cmd.] CMd5
74
[Ethernet Embd Ref Freq] LFr5
75
[Ethernet Timeout] ttOb
75
NVE61653 09/2016
Software Setup
IP Parameter Settings
Assigning IP Parameters
If not using IPV6 functionalities for DWPS, following parameters shall be configured:
 The drive IP address.
 The subnet mask.
 The gateway IP address.
These IP addresses can be entered using the display terminal, the embedded webserver, or the DTMbased PC software.
They can be also provided by:
A BOOTP server (correspondence between the MAC address and the IP addresses).
 Or a DHCP server (correspondence between device name [DEVICE NAME] PAn and the IP
addresses).

If an IP address other than 0.0.0.0 has been entered manually, assignment using a server is disabled.
Regardless of the type of IP address assignment, if the address is modified, then the IP address is effective
the next time the drive is turned on (control voltage if a separate power supply is being used).
Entering IP Parameters in the Display Terminal
In the [Communication] COM- , [Comm parameters] CMP- menu and [Embd Eth Config] EtEsubmenu, enter the following IP addresses:
 [IP address] IC01 IC02 IC03 IC04
 [Mask] IM01 IM02 IM03 IM04,
 [Gateway] IG01 IG02 IG03 IG04.
If this address is modified, the new IP address entered is displayed.
Configuring BOOTP
The BOOTP service is used to assign IP addresses based on the MAC address. The MAC address
consisting of 6 hexadecimal digits (MM-MM-MM-XX-XX-XX) must be entered in the BOOTP server. The
MAC address appears on the fieldbus adapter dedicated menu on the display terminal.
In the [Communication] COM- , [Comm parameters] CMP- menu and [Embd Eth Config] EtEsubmenu:
 Leave the IP address [IP address] IC01IC02IC03IC04 at the value [0.0.0.0] 0000.
 Do not enable the FDR service.
Configuring DHCP
The DHCP service is used to assign IP addresses and FDR configuration file path based on the device
name [DEVICE NAME] PAn.
The device name consisting of an alphanumeric string must be entered in both the DHCP server and the
drive.
In the [Communication] COM- , [Comm parameters] CMP- menu and [Embd Eth Config] EtEsubmenu, enter the [DEVICE NAME] PAn
NVE61653 09/2016
67
Software Setup
[Device Name] PAn
About This Parameter
This parameter is used set the device name.
Access
This parameter is accessible via [Communication] COM- , [Comm parameters] CMP- menu and
submenu.
This is a read/write parameter
Possible Settings
The FDR (Fast Device Replacement) service is based on identification of the device by a Device Name. In
the case of the Altivar drive, this is represented by the [Device Name] PAn parameter. Verify that all the
network devices have different Device Name.
NOTE: The [Device Name] PAN is common for both Ethernet interfaces.
[IP mode Ether. Embd ]IM00
About This Parameter
This parameter is used to select the IP address assignment method.
Access
This parameter is accessible via [Communication] COM- , [Comm parameters] CMP- menu and [Embd
Eth Config] EtE- submenu.
This is a read/write parameter
The parameter number is 64400.
Possible Settings
The table presents the parameter settings:
68
Settings
Code
Value
Description
[Fixed]
[BOOTP]
MAnU
bOOt
0
1
[DHCP]
dHCP
2
Manually set the IP address.
Automatically gets the IP address from the Bootp or DHCP server using the
MAC address.
Automatically gets the IP address from the DHCP server using the device
name.
Factory setting: DHCP
NVE61653 09/2016
Software Setup
[IP address]IC01IC02IC03IC04
About This Parameter
This parameter is used to set the IP address and can be edited only when the IP mode is set to fixed
address.
Access
This parameter is accessible via [Communication] COM- , [Comm parameters] CMP- menu and [Embd
Eth Config] EtE- submenu.
This is a read/write parameter
The parameter number for IC01 is 64401
The parameter number for IC02 is 64402
The parameter number for IC03 is 64403
The parameter number for IC04 is 64404
Possible Settings
The table presents the parameter settings:
Settings
Code
Value
Description
[139.160.069.241]
139
160
069
241
0...255
0...255
0...255
0...255
First byte of IP address.
Second byte of IP address.
Third byte of IP address.
Fourth byte of IP address.
[Mask] IM01IM02IM03IM04
About This Parameter
This parameter is used to set the IP subnet mask and can be edited only when IP mode is set to fixed
address.
Access
This parameter is accessible via [Communication] COM- , [Comm parameters] CMP- menu and [Embd
Eth Config] EtE- submenu.
This is a read/write parameter
The parameter number for IM01 is 64405
The parameter number for IM02 is 64406
The parameter number for IM03 is 64407
The parameter number for IM04 is 64408
Possible Settings
The table presents the parameter settings:
NVE61653 09/2016
Settings
Code
Value
Description
[255.255.254.0]
255
255
254
0
0...255
0...255
0...255
0...255
First byte of IP Mask .
Second byte of IP Mask .
Third byte of IP Mask .
Fourth byte of IP Mask
69
Software Setup
[Gateway] IG01IG02IG03IG04
About This Parameter
This parameter is used to set the default gateway address and can be edited only IP mode is set to fixed
address.
Access
This parameter is accessible via [Communication] COM- , [Comm parameters] CMP- menu and [Embd
Eth Config] EtE- submenu.
This is a read/write parameter
The parameter number for is 64409
The parameter number for is 64410
The parameter number for is 64411
The parameter number for is 64412
Possible Settings
The table presents the parameter settings:
Settings
Code
Value
Description
[0.0.0.0]
0
0
0
0
0...255
0...255
0...255
0...255
First byte of IP gateway.
Second byte of IP gateway
Third byte of IP gateway
Fourth byte of IP gateway
[Enable FDR] FdV0
About This Parameter
This parameter is used to enable or disable the FDR service.
Access
This parameter is accessible via [Communication] CoM-, [Comm parameters] CMP- menu, [Embd Eth
Config] EtE- submenu and [Fast Device Replacement] Fdr- submenu.
This is a read/write parameter.
The parameter number is 64435
This parameter can be accessed if [IP mode Ether. Embd] iM00 is set to [DHCP] dHCP
Possible Settings
The table presents the parameter settings:
70
Settings
Code
Value
Description
[No]
[Yes]
nO
YES
0
1
No: FDR service disabled
Yes: FDR service enabled
Factory setting: No
NVE61653 09/2016
Software Setup
[FDR Action] FdA0
About This Parameter
This parameter is used to select the FDR action that needs to be performed.
Access
This parameter is accessible via [Communication] CoM-, [Comm parameters] CMP- menu, [Embd Eth
Config] EtE- submenu and [Fast Device Replacement] Fdr- submenu.
This is a read/write parameter.
The parameter number is 64434
This parameter can be accessed if [IP mode Ether. Embd] iM00 is set to [DHCP] dHCP
Possible Settings
The table presents the parameter settings:
Settings
Code
Value
Description
[NOT ACTIVE]
[SAVE]
[REST]
IdLE
SAVE
rESt
0
1
2
Not active: No FDR action
Save: FDR save command
Restore: FDR restore command
[FDR Operating State] FdS0
About This Parameter
This parameter is used to display the FDR operating state.
Access
This parameter is accessible via [Communication] CoM-, [Comm parameters] CMP- menu, [Embd Eth
Config] EtE- submenu and [Fast Device Replacement] Fdr- submenu.
This is a read-only parameter.
The parameter number is 64433
This parameter can be accessed if [IP mode Ether. Embd] iM00 is set to [DHCP] dHCP
Possible Settings
The table presents the parameter settings:
NVE61653 09/2016
Settings
Code
Value
Description
[Initialization]
[Not Active]
[Operational]
[Ready]
[IP Configuration]
[Not Configured]
[Reading Configuration]
[Writing Configuration]
[Applying Configuration]
InIt
IdLE
OPE
rdY
IPC
UnCF
GEt
SEt
APP
0
1
2
4
5
7
8
9
10
INIT: Initialization
IDLE: Function not active
OPE: Operational
RDY: Ready
IPC: IP configuration
UNCF: Function not configured
GET: Download the current configuration
SET: Save the current configuration
APP: Applying the configuration to the drive
71
Software Setup
[FDR Error Status] Fdr0
About This Parameter
This parameter is used to display the FDR error status.
Access
This parameter is accessible via [Communication] CoM-, [Comm parameters] CMP- menu, [Embd Eth
Config] EtE- submenu and [Fast Device Replacement] Fdr- submenu.
This is a read-only parameter.
The parameter number is 64432
This parameter can be accessed if [IP mode Ether. Embd] iM00 is set to [DHCP] dHCP
Possible Settings
The table presents the parameter settings:
Settings
Code
Value
Description
[No Error]
[Service Timeout]
[Server No File]
[Server Corrupt File]
[Server Empty File]
[Drive Invalid File]
[CRC Error]
[Version Incompatibility]
[Drive No File]
[Server Reading Size]
[Drive Opening File]
[Drive Reading File]
[Incompatibility]
[Drive Invalid Name]
[Server Incorrect File Size]
[Drive Writing File]
[Server Writing File]
nO
tOUt
SnF
CrPt
EPtY
HInV
CrC
VrM
HnF
SIZE
OPEn
rEAD
SCnt
nInV
FSIZ
HWF
SWF
0
1
2
3
4
5
6
7
9
10
11
12
13
14
15
16
17
NO: No error
TOUT: Server timeout
SNF: No file on server
CRPT: Corrupted file on server
EPTY: Empty file on server
HINV: Invalid file on drive
CRC: CRC error
VRM: Version incompatibility between drive and file
HNF: No file on drive
SIZE: File size reading error on server
OPEN: Drive cannot open the file
READ: Drive cannot read the file
SCNT: File incompatibility
NINV: Drive name is invalid
FSIZ: Incorrect file size on server
HWF: Drive cannot write the file
SWF: Server cannot write the file
[MAC @] MACO
About This Parameter
This parameter displays the MAC address of the device.
Access
This parameter is accessible via [Display] MON- , [Communication map] CMM- menu and
submenu.[Ethernet Emb Diag] MPEThis is a read-only parameter
Possible Settings
The table presents the parameter settings:
72
Settings
Code
Value
Description
[MM-MM-MM-XX-XX-XX]
MM-MM-MM-XX-XX-XX
MM-MM-MM-XX-XX-XX
MAC address
NVE61653 09/2016
Software Setup
[ETH emb Rx frames] ErXE
About This Parameter
This parameter displays the Ethernet adapter received frames counter
Access
This parameter is accessible via [Display] MON- , [Communication map] CMM- menu and [Ethernet
Emb Diag] MPE- submenu.
This is a read-only parameter
The parameter numbers is 64416
[ETH emb Tx frames] ETXE
About This Parameter
This parameter displays the Ethernet adapter transmitted frames counter
Access
This parameter is accessible via [Display] MON- , [Communication map] CMM- menu and [Ethernet
Emb Diag] MPE- submenu.
This is a read-only parameter
The parameter numbers is 64418
[ETH emb error frames] EErE
About This Parameter
This parameter displays the Ethernet adapter error frames counter
Access
This parameter is accessible via [Display] MON-, [Communication map] CMM- menu and [Ethernet
Emb Diag] MPE- submenu.
This is a read-only parameter
The parameter numbers is 64420
[Ethernet Rate Data] ArdE
About This Parameter
This parameter displays the Ethernet adapter actual rate.
Access
This parameter is accessible via [Display] MON- , [Communication map] CMM- menu and [Ethernet
Emb Diag] MPE- submenu.
This is a read-only parameter
The parameter numbers is 64413
Possible Settings
The table presents the parameter settings:
NVE61653 09/2016
Settings
Code
Value
Description
[Auto]
[10M. full]
[10M. half]
[100M. full]
[100M. half]
AUtO
10F
10H
100F
100H
Auto
10 F
10 H
100 F
100 H
Data rate is auto detected depending on the first data packet received.
Data rate is set to10 Mbit/s full
Data rate is set to10 Mbit/s half
Data rate is set to100 Mbit/s full
Data rate is set to100 Mbit/s half
Factory setting: Auto
73
Software Setup
[Enable Webserver]EWEE
About This Parameter
This parameter is used to manage the fieldbus adapter Web services.
Access
This parameter is accessible via [My preferences] MYP- menu and [Webserver] WbS- submenu.
This is a read/write parameter
The parameter numbers is 64264
Possible Settings
The table presents the parameter settings:
Settings
Code
Value
Description
[No]
[Yes]
no
yes
0
1
Web services disabled
Web services enabled
Factory setting: Yes
[Reset EmbWeb] rWPE
About This Parameter
This parameter is used to manage the set to factory value the Ethernet webserver settings, including the
password.
Access
This parameter is accessible via [My preferences] MYP- menu and [Webserver] WbS- submenu.
This is a read/write parameter
Possible Settings
The table presents the parameter settings:
Settings
Code
Value
Description
[No]
[Yes]
no
yes
0
1
Reset of the adapter webserver password not requested
Reset of the adapter webserver password requested
NOTE: The parameter is set to [No] when the operation is done
[Ethernet Embd cmd.] CMd5
About This Parameter
This parameter displays the command word built with Ethernet embedded source (same as CMD).
Access
This parameter is accessible via [Display] MON- , [Communication map] CMM- menu and [Command
word image] CWI- submenu.
This is a read-only parameter
The parameter numbers is 8515
74
NVE61653 09/2016
Software Setup
[Ethernet Embd Ref Freq] LFr5
About This Parameter
This parameter displays the reference frequency built with Ethernet embedded source (same as LFr).
Access
This parameter is accessible via [Display] MON- , [Communication map] CMM- menu and [Command
word image] CWI- submenu.
This is a read-only parameter
The parameter numbers is 8525
[Ethernet Timeout] ttOb
About This Parameter
This parameter is used to set the Ethernet timeout.
Access
This parameter is accessible via fieldbus using the Modbus address.
This is a read/write parameter
The parameter number is 64415.
Possible Settings
The table presents the parameter settings:
NVE61653 09/2016
Settings
Description
0.1...30 sec
Factory setting: 10 sec
75
Software Setup
Section 4.2
Additional Settings
Additional Settings
What Is in This Section?
This section contains the following topics:
Topic
76
Page
FDR Settings
77
RSTP Settings
78
Configuring I/O Scanning
79
DNS Settings
80
SNTP Settings
81
SNMP Settings
82
NVE61653 09/2016
Software Setup
FDR Settings
Access
The parameters are accessible via the webserver or the DTM-based PC software
FDR Configuration
The following figure shows FDR settings via webserver:
The table presents the FDR Configuration settings:
Parameter
Description
Settings
FDR Activation
This parameter is used to enable or
disable the FDR service
Enabled: FDR service enabled
Disabled: FDR service disabled.
Factory setting: Enabled
NOTE: You can enable FDR only if
the IP assignment mode selected is
DHCP.
Control Configuration
This parameter is used to select the
server or local configuration.
Served: Transfers the configuration file
from server to drive at power-up.
Stored: uses the configuration stored in
the drive at power-up.
Factory setting: served
Automatic Syncho Cycle (x
10 Sec)
Allows you to select the interval for
periodic synchronization of the drive
with the FDR server.
10...655350 sec
Factory setting: 2560 sec
NOTE: You can configure automatic
Synchro cycle only if Synchronization
mode check box is selected.
NVE61653 09/2016
77
Software Setup
RSTP Settings
Access
The parameters are accessible via the DTM-based PC software.
Bridge Settings
The following figure shows the bridge settings using the DTM:
The table presents the Bridge configuration
78
Parameters
Description
Settings
Enable RSTP
Allows you to enable or disable the RSTP
To enable RSTP, select the
Enable RSTP check box.
Status
Allows you to enable or disable the RSTP bridge.
Enabled: Enables the use of
Rapid Spanning-Tree Protocol
(RSTP).
Disabled:Disables the use of
Rapid Spanning-Tree Protocol
(RSTP)
Bridge Priority
The bridge priority is used to control which bridge is
elected as the root bridge.
Bridge with the smallest (lowest) bridge ID is
elected as the root bridge. Bridge ID consists of the
configurable priority and the MAC address of the
bridge.
To compare 2 bridge ids, bridge priorities are
compared first. If the bridge priorities are equal,
then the MAC addresses are compared.
The bridge priority can be set only in increments of
4096
0
4096
8192
12288
16384
20480
24576
28672
32768
36864
40960
45056
49152
53248
57344
61440
Hello Time(S)
The hello time parameter corresponds to the time 1...10 sec
interval at which the root bridge transmits
configuration Bridge Protocol Data Units (BPDU)s.
Max age time (6-40 s)
The maximum age time correspond to the
maximum expected arrival time of hello BPDUs. If
the timer expires, the bridge detects
acommunication interruption to the root bridge and
initiates a topology convergence.The maximum
age timer should be longer than the configured
hello time.
0 hex
1000 hex
2000 hex
3000 hex
4000 hex
5000 hex
6000 hex
7000 hex
8000 hex
9000 hex
A000 hex
B000 hex
C000 hex
D000 hex
E000 hex
F000 hex
6...40 sec
NVE61653 09/2016
Software Setup
Ports Configuration
The following figure shows the port settings:
The table provides the Ports settings
Parameters
Description
Port Priority
Allows you to define the priority of the interface to 0...240
the other going to same subnet.
Settings
NOTE:
 The port priority can be set only in
increments of 16
 Drive takes the value in account after a
product restart.
Port Path Cost
Port Select
Allows you to define the cost of sending
spanning tree traffic through the interface.
RSTP uses path cost to determine the topology
with the smallest total path cost between each
point of the tree and the root bridge.
0...1,569,325,055
NOTE: If the port path cost is set to 0
(auto), the path cost is based on the port link
speed maximum, for details see the
following table.
RSTP Port
Allows you to select the type of ports. With the
port types defined, RSTP can quickly reconfigure Edge Port
a network when a change in network topology is
detected.
Table provides the value of the path cost based on the port link maximum speed
Port Link Maximum Speed
Automatic Path Cost
10 Gb/s (Not supported by the adapter)
2000
1 Gb/S (Not supported by the adapter)
20000
100 Mb/s
200000
10 Mb/s
2000000
Configuring I/O Scanning
Description
The drive I/O scanning service can be enabled or disabled with the DTM-based PC software.
It is not possible to modify the assignment of the I/O scanning periodic variables using the display terminal.
To configure I/O scanning, use the DTM-based PC software.
NVE61653 09/2016
79
Software Setup
DNS Settings
Description
The Domain Name System (DNS) is a distributed naming system for devices connected to the network.
It translates domain names to IP addresses for locating the devices easily on the network.
DNS Configuration
The DNS configuration can be done using the DTM-based PC software.
The following figure shows the DNS configuration window:
The table presents the DNS Configuration settings:
Item
Description
1
Obtain DNS Server address automatically: When checked, the function is enabled and allows getting
automatically the IP address from the DNS server.
2
Preferred DNS server: Enter the IP address of the preferred DNS server.
3
Alternate DNS server: Enter the IP address of the alternate DNS server.
NOTE: The alternate IP address is used only if the first server is unavailable.
NOTE: The changes must be applied to the module configuration by clicking the
80
button.
NVE61653 09/2016
Software Setup
SNTP Settings
Description
The Simple Network Time Protocol (SNTP) is networking protocol for clock synchronization of devices
connected to the network.
SNTP Configuration
The SNTP configuration can be done using the DTM-based PC software.
The following figure shows the SNTP Configuration window:
The SNTP Configuration window is divided in 2 zones:
 SNTP Settings
 Local Time
The table presents the SNTP settings:
Item
Description
1
Enabled: Enables SNTP service.
Disabled: Disables SNTP service.
2
Server 1 IP Address: Enter the IP address of the first preferred SNTP server.
3
Server 2 IP Address: Enter the IP address of the second preferred SNTP server.
4
Polling Interval: Allows you to select the scanning interval for checking the time change.
NOTE: This IP address is used for SNTP only if the first server is unavailable.
The table presents the Local Time settings:
Item
Description
a
Current Date: Allows you to enter the current date
b
Current Time:Allows you to select the current time
NOTE: The changes must be applied to the module configuration by clicking the
NVE61653 09/2016
button.
81
Software Setup
SNMP Settings
Description
Simple Network Management Protocol (SNMP) is an internet-standard protocol used to manage devices
on IP networks.
It is used for collecting and organizing information about the devices on the network.
SNMP Configuration
The SNMP configuration can be done using the DTM-based PC software.
The following figure shows the SNTP Configuration window:
The SNMP Configuration window is divided in 4 zones:
 Manager’s IP Address
 Agent
 Community Names
 Enabled Traps
Manager's IP Address
SNMP manager is a central system used for monitoring and controlling the SNMP agents.
The table presents Manager’s IP Address settings:
Item
Description
1a
Manager 1: SNMP manager is a central system, which is used for monitoring and controlling the
SNMP agents.
2a
Manager 2: Enter the IP address of SNMP manager 2.
Agents
Agents are the devices which are connected to the network. The SNMP manager monitors these devices.
The table presents the Agents settings:
82
Item
Description
1b
System Name: Enter the system name used by the drive.
2b
System Location: Enter the system location of the drive.
3b
System Contact:Contact point to get the information about the system.
Enter the system contact of the drive.
NVE61653 09/2016
Software Setup
Community Names
Community names are used to identify the commands that can be performed by an SNMP manager on a
device.
The table presents the Community Names settings:
Item
Description
1c
Get: Requests send from manager to agent to retrieve data.
2c
Set: Requests send from manager to agent to change data.
3c
Trap: Requests send from manager to agent to find the available data.
Enabled Traps
Traps are used to inform the SNMP manager of specific events occurring on device.
The table presents the Enabled Traps settings:
NVE61653 09/2016
Item
Description
1d
Cold Start: The agent reinitialized its configuration tables.
2d
Link Down Trap: A network interface card (NIC) on agent reinitializes.
3d
Link Up Trap: A network interface card (NIC) on agent stops responding.
4d
Authentication Failure Trap: SNMP agent gets a request from an unrecognized community name.
83
Software Setup
Section 4.3
Fast Device Replacement
Fast Device Replacement
What Is in This Section?
This section contains the following topics:
Topic
84
Page
Presentation
85
Startup Detailed Behavior
86
FDR Operation Behavior
87
Local Configuration
88
Downloaded Configuration
89
NVE61653 09/2016
Software Setup
Presentation
FDR Service
The FDR (Fast Device Replacement) service is used to simplify the maintenance of drives connected to
an Ethernet network. In the event of a drive not working correctly, this service automatically reconfigures
its replacement.
The new drive (FDR client) retrieves:
 Its IP addresses and the FDR file path from a DHCP server
 The FDR file from an FTP server if the drive is not configured in local configuration
In practice, the DHCP server and the FTP server are the same device (PAC M580, M340 PLC, M251MESE
or dedicated PCs).
The FDR file contains:
 The Ethernet parameters (configuration of I/O scanning, FDR, and so on)
 The drive parameters (drive, functions, application, and so on)
The FDR service is based on identification of the device by a Device Name. In the case of the drive, this
is represented by the [DEVICE NAME] PAn parameter.
The configuration of the FDR service is accessible via embedded webserver or DTM-based software or
Graphic Display Terminal.
NOTE: Check that all the network devices have different Device Name.
The FDR server controls duplication of Device Name (it does not assign an IP address that has already
been assigned and is active).
If the same IP address is supplied on 2 devices, the second should trigger an IP address duplication
(network management detected error which triggers an [External Error] EPF1 by default).
If the FDR service has been enabled, the Ethernet adapter attempts to restore its IP addresses on each
power-up. Each time the procedure has detected error, the Ethernet adapter reiterates its FDR requests
(DHCP).
After assigning the Ethernet adapter IP addresses, if the configuration is not downloaded successfully, the
Ethernet adapter triggers a [FDR1 Error] FDR1.
NVE61653 09/2016
85
Software Setup
Startup Detailed Behavior
Presentation
86
NVE61653 09/2016
Software Setup
FDR Operation Behavior
NVE61653 09/2016
87
Software Setup
Local Configuration
Presentation
IP Assignment Save
If the drive parameter configuration is local, the FDR server only assigns the following IP addresses:
 IP address,
 Subnet mask,
 Gateway IP address.
On connection to the network, the drive automatically saves its parameters in the FDR server.
Drive Connection Procedure
Step
88
Action
Description
1
Configure the FDR server
See the PLC manual or the section on software setup using Unity
2
Configure the drive
In the [Communication] COM-, [Comm parameters] CMP- menu,
[Embd Eth Config] EtEConfigure = [DHCP] dHCP
Enable the FDR service via webserver or DTM-based software or
Graphic Display Terminal.
Select local drive configuration with webserver or DTM-based
software.
Enter the device name, DEVICE NAME, in the [Communication]
COM-, [Comm parameters] CMP- menu, [Embd Eth Config]
EtE- submenu.
3
Turn off the drive
Turn off the drive and then back on again (control voltage supply if a
separate power supply is being used), otherwise the device name is
not taken into account
4
Connect the drive to the network
Connect the drive and the FDR server (PLC) to the Ethernet network
NVE61653 09/2016
Software Setup
Downloaded Configuration
Presentation
IP Assignment Save
If the drive parameter configuration has been downloaded, the FDR server assigns the following
addresses:
 IP address,
 Subnet mask,
 Gateway IP address,
 FDR server IP address.
Periodic Saving
Periodic saving of the drive configuration can be configured on the FDR server in either local configuration
or downloaded configuration mode
Using the embedded webserver or the DTM-based software:
 Set FDR synchronization to automatic mode
 Set the synchronization cycle time
NOTE: Saving too often overburden the fieldbus and adversely affects its performance (factory setting:
2.560 s.).
Limitations
The FDR service is able to store the current configuration of the drive, but does not provide the possibility
to store multi-parameters configurations.
NVE61653 09/2016
89
Software Setup
Drive Parameters (Configuration)
In the procedure described below, the configuration file is transferred to the FDR server, via the Ethernet
network, using a manual save command.
Step
1
Action
Description
Configure the drive
In the [Communication] COM-, [Comm parameters] CMPmenu, [Embd Eth Config] EtE- submenu:
 Leave the IP address [IP address]
IC01IC02IC03IC04 at the value [0.0.0.0] 0000
Using the embedded webserver or the DTM-based software:
 Set FDR synchronization to manual mode.
 Before the first connection, select local drive configuration. The
drive needs first to push the configuration to the server.
Enter the device name, DEVICE NAME, in the [Communication]
COM-, [Comm parameters] CMP- menu, [Ethernet Eth Config]
EtE- submenu.
2
Turn off the drive
Turn off the drive and then back on again (control voltage if a
separate power supply is being used), otherwise the device name is
not taken into account
3
Connect the drive to the fieldbus
Connect the drive and the FDR server (PLC) to the Ethernet
fieldbus.
4
Configure the FDR server (see the
PLC manual)
The server downloads the IP addresses to the Ethernet adapter .
Check that the operation has proceeded correctly: you can also
check, in the [Communication] COM-, [Comm parameters]
CMP- menu, [Embd Eth Config] EtE- submenu. Whether the
[IP address] IC01IC02IC03IC04 , [Mask]
IM01IM02IM03IM04 and [Gateway]
IG01IG02IG03IG04 parameters have values other than
[0.0.0.0] 0000
5
Supply the FDR server with the
configuration file
Using the embedded webserver or the DTM-based software
 Specify that the drive configuration is downloaded from the FDR
server on each power-up
 Send a save command to the FDR server.
6
Check that the system is operational If the save operation has not been successful, the adapter detects
a communication error which, in factory settings mode, triggers a
[FDR1 Error]Fdr1
Replacing a Drive
For replacing a drive, it is necessary to follow the procedure below:
Step
1
Action
Action
Configure the drive
In the [Communication] COM-, [Comm parameters] CMPmenu, [Embd Eth Config] EtE- submenu:
 Leave the IP address [IP address]
IC01IC02IC03IC04 at the value [0.0.0.0] 0000
Using the embedded webserver or the DTM-based software:
 Set FDR synchronization to manual mode.
 Before the first connection, select served drive configuration. The
drive needs first to transfer the configuration from the server.
Enter the device name, DEVICE NAME, in the [Communication]
COM-, [Comm parameters] CMP- menu, [Embd Eth Config]
EtE- submenu.
90
2
Turn off the drive
Turn off the drive and then back on again (control voltage if a
separate power supply is being used), otherwise the device name is
not taken into account
3
Connect the drive to the fieldbus
Connect the drive and the FDR server (PLC) to the Ethernet fieldbus
4
Check that the drive is operational
Check that the operation has proceeded correctly.
If downloading has not been possible after a period of 2 min
following assignment of the IP addresses, the adapter detects a
communication error which, in factory settings mode, triggers an
[FDR1 Error] Fdr1
NVE61653 09/2016
Software Setup
Section 4.4
Communication Profile
Communication Profile
What Is in This Section?
This section contains the following topics:
Topic
NVE61653 09/2016
Page
Definition of a Profile
92
Functional Profiles Supported by the Drive
93
Functional Description
94
CIA402 Operating State Diagram
95
Description of Operating States
96
Summary
98
Cmd Register CMd
99
Stop Commands
100
Assigning Control Word Bits
100
[CIA402 State Reg] EtA
101
Starting Sequence
102
Sequence for a Drive Powered by the Power Stage Supply
103
Sequence for a Drive with Separate Control Stage
104
Sequence for a Drive with Mains Contactor Control
107
91
Software Setup
Definition of a Profile
Types of Profiles
There are 3 types of profile:
 Communication profiles
 Functional profiles
 Application profiles
Communication Profile
A communication profile describes the characteristics of a bus or network:
Cables
 Connectors
 Electrical characteristics
 Access protocol
 Addressing system
 Periodic exchange service
 Messaging service
 ...

A communication profile is unique to a type of fieldbus (such as Modbus, PROFIBUS DP, and so on) and
is used by different types of devices.
Functional Profile
A functional profile describes the behavior of a type of device:
Functions
 Parameters (such as name, format, unit, type, and so on.)
 Periodic I/O variables
 State chart
 ...

A functional profile is common to all members of a device family (such as variable speed drives, encoders,
I/O modules, displays, and so on).
They can feature common or similar parts. The standardized (IEC 61800-7) functional profiles of variable
speed drives are:
 CiA402
 PROFIDRIVE
 CIP AC Drive
CiA402 device profile for drives and motion control represents the next stage of this standard development
and is now part of the IEC 61800-7 standard.
Application Profile
Application profile defines the services to be provided by the devices on a machine. For example, CiA DSP
417-2 V 1.01 part 2: CANopen application profile for lift control systems - virtual device definitions.
Interchangeability
The aim of communication and functional profiles is to achieve interchangeability of the devices connected
via the fieldbus.
92
NVE61653 09/2016
Software Setup
Functional Profiles Supported by the Drive
I/O Profile
Using the I/O profile simplifies PLC programming.
The I/O profile mirrors the use of the terminal strip for control by utilizing 1 bit to control a function.
The I/O profile for the drive can also be used when controlling via a fieldbus.The drive starts up as soon as
the run command is sent.15 bits of the control word (bits 1...15) can be assigned to a specific function.
This profile can be developed for simultaneous control of the drive via:
 The terminals
 The Modbus control word
 The CANopen control word
 Ethernet Modbus TCP embedded control word (for ATV340•••N4E drives)
 The fieldbus module control word
The I/O profile is supported by the drive itself and therefore in turn by all the communication ports.
CiA402 Profile
The drive only starts up following a command sequence.
The control word is standardized.
5 bits of the control word (bits 11...15) can be assigned to a function.
The CiA402 profile is supported by the drive itself and therefore by all the communication ports.
The drive supports the velocity mode of CiA402 profile.
In the CiA402 profile, there are two modes that are specific to the drive and characterize commands and
references value management:
 Separate [Separate] SEP
 Not separate [Not separ.] SIm,
NVE61653 09/2016
93
Software Setup
Functional Description
Introduction
Drive operation involves two main functions, which are illustrated in the diagrams below.
CiA402
The main parameters are shown with their CiA402 name and their CiA402/Drivecom index (the values in
brackets are the CANopen addresses of the parameter).
The following figure shows the control diagram for drive operation:
Simplified diagram for speed control in Velocity mode:
Altivar Drive
These diagrams translate as follows for the Altivar drive.
The following figure shows the control diagram for drive operation:
Simplified diagram for speed control in Velocity mode:
94
NVE61653 09/2016
Software Setup
CIA402 Operating State Diagram
State Diagram
After switching on and when an operating mode is started, the product goes through a number of operating
states.
The state diagram (state machine) shows the relationships between the operating states and the state
transitions. The operating states are internally monitored and influenced by monitoring functions.
The following figure shows the CIA402 state diagram:
NVE61653 09/2016
95
Software Setup
Description of Operating States
Drive Operating State
The operating state of the drive changes depending on whether the control word [Cmd Register] CMd, is
sent or an event occurs (an error detection, for example).
The drive operating state can be identified by the value of the status word [CIA402 State Reg] EtA.
Operating State
Description
1 - Not ready to switch
on
Initialization starts. This is a transient state invisible to the communication network.
2 - Switch on disabled
The power stage is not ready to switch on.
The drive is locked, no power is supplied to the motor.
For a separate control stage, it is not necessary to supply the power.
For a separate control stage with mains contactor, the contactor is not closed.
The configuration and adjustment parameters can be modified.
3 - Ready to switch on
The power stage is ready to switch on and awaiting power stage supply mains.
For a separate control stage, it is not necessary to supply the power stage, but the
system expects it in order to change to state 4 - Switched on.
For a separate control stage with mains contactor, the contactor is not closed.
The drive is locked, no power is supplied to the motor.
The configuration and adjustment parameters can be modified.
4 - Switched on
Power stage is switched on.
For a separate control stage, the power stage must be supplied.
For a separate control stage with mains contactor, the contactor is closed.
The drive is locked, no power is supplied to the motor.
The power stage of the drive is ready to operate, but voltage has not yet been
applied to the output.
The adjustment parameters can be modified.
If a configuration parameter is modified, the drive returns to the state 2 - Switch
on disable .
5 - Operation enabled
Power stage is enabled. The drive is in running state
For a separate control stage, the power stage must be supplied.
For a separate control stage with mains contactor, the contactor is closed.
The drive is unlocked, power is supplied to the motor.
The drive functions are activated and voltage is applied to the motor terminals.
If the reference value is zero or the Halt command is applied, no power is supplied
to the motor and no torque is applied. To perform [Auto tuning] tUn, the drive must
be in state 5 - Operation enabled.
The adjustment parameters can be modified.
The configuration parameters cannot be modified.
NOTE: The command 4 - Enable operation must be taken into consideration
only if the channel is valid. In particular, if the channel is involved in the command
and the reference value, transition 4 is possible only after the reference value has
been received once.
The reaction of the drive to a Disable operation command depends on the
value of the [SwitchOnDisable Stp] dOtd parameter:
 If the [SwitchOnDisable Stp] dOtd parameter is set to 0, the drive changes to
operating state 4 - Switched on and stops in freewheel stop.
 If the [SwitchOnDisable Stp] dOtd parameter is set to 1, the drive stops on
ramp and then changes to operating state 4 - Switched on.
96
NVE61653 09/2016
Software Setup
NVE61653 09/2016
Operating State
Description
6 - Quick stop active
The drive performs a fast stop and remains locked in the operating state 6-Quick
stop active. Before restarting the motor, it is required to go to the operating state
2-switch on disabled.
During fast stop, the drive is unlocked and power is supplied to the motor.
The configuration parameters cannot be modified.
The condition for transition 12 to state 2 - Switch on disabled depends on the
value of the parameter
Quick stop mode (QStd):
If the Quick stop mode parameter has the value FST2, the drive stops according
to the fast stop ramp and then changes to state 2 - Switch on disabled .
If the Quick stop mode parameter has the value FST6, the drive stops according
to the fast stop ramp and then remains in state 6 - Quick stop active until:
 A Disable voltage command is received or
 The STOP key is pressed or
 A freewheel stop command via the digital input of the terminal.
7 - Fault reaction
active
Transient state during which the drive performs an action corresponding to the
selected error response.
8 - Fault
Error response terminated. Power stage is disabled.
The drive is locked, no power is supplied to the motor.
97
Software Setup
Summary
Device Status Summary
Operating State
Power Stage Supply for
Separate Control Stage
Power Supplied to Motor
Modification of Configuration
Parameters
1 - Not ready to
switch on
Not required
No
Yes
2 - Switch on
disabled
Not required
No
Yes
3 - Ready to
switch on
Not required
No
Yes
4 - Switched on
Required
No
Yes, return to 2 - Switch on
disabled operating state
5 - Operation
enabled
Required
Yes
No
6 - Quick stop
active
Required
Yes, during fast stop
No
7 - Fault reaction
active
Depends on error response
configuration
Depends on error
response configuration
−
8 - Fault
Not required
No
Yes
NOTE:
 Configuration parameters are described in communication parameter file as R/WS access type
parameters. Other parameters can be accessed whatever the operating state.
 A Setting parameter can be accessed in all operating state of the drive.
98
NVE61653 09/2016
Software Setup
Cmd Register CMd
Bit Mapping of the Control Word
Bit 7
Bit 6
Bit 5
Bit 4
Bit 3
Bit 2
Bit 1
Bit 0
Fault reset
Reserved
(=0)
Reserved
(=0)
Reserved
(=0)
Enable
operation
Quick stop
Enable
voltage
Switch on
1 = Run
command
0 = Quick
stop active
Authorization
to supply AC
power
Mains
contactor
control
0 to 1
transition =
Error is
reset (after
cause of
error is no
longer
active)
Bit 15
Bit 14
Bit 13
Bit 12
Bit 11
Bit 10
Bit 9
Bit 8
Manufacturer
specific
assignable
Manufacturer
specific
assignable
Manufacturer
specific
assignable
Manufacturer
specific
assignable
Manufacturer
specific
Reserved
(=0)
Reserved
(=0)
Halt
Command
State
Transition
Final
Operating
State
Bit 7
Bit 3
Bit 2
Bit 1
Bit 0
Fault
Reset
Enable
Operation
Quick
Stop
Enable
Voltage
Switch
On
Shutdown
2, 6, 8
3 - Ready
to switch
on
X
X
1
1
0
0006 hex
Switch on
3
4 Switched
on
X
X
1
1
1
0007 hex
Enable
operation
4
5 Operation
enabled
X
1
1
1
1
000F hex
Disable
operation
5
4 Switched
on
X
0
1
1
1
0007 hex
Disable
voltage
7, 9, 10, 12
2 - Switch
on
disabled
X
X
X
0
X
0000 hex
6 - Quick
stop
active
X
X
0
1
X
0002 hex
0→1
X
X
X
X
0080 hex
Quick stop 11
Fault
reset
7, 10
2 - Switch
on
disabled
15
2 - Switch
on
disabled
Halt
0 = Forward
direction
asked
1= Reverse
direction
asked
Example
Value
X: Value is of no significance for this command.
0→1: Command on rising edge.
NVE61653 09/2016
99
Software Setup
Stop Commands
Halt Command
The Halt command enables movement to be interrupted without having to leave the 5 - Operation
enabled state. The stop is performed in accordance with the [Type of stop] Stt parameter.
If the Halt command is active, no power is supplied to the motor and no torque is applied.
Regardless of the assignment of the [Type of stop] Stt parameter [Fast stop Assign] FSt, [Ramp stop]
rMP, [Freewheel Stop] nSt, or [DC Injection Assign] dCI, the drive remains in the 5 - Operation
enabled state.
Fast Stop Command
A Fast Stop command at the terminals or using a bit of the control word assigned to Fast Stop causes
a change to the 4 - Switched on
Freewheel Command
A Freewheel Stop command using a digital input of the terminal or a bit of the control word assigned
to Freewheel Stop causes a change to operating state 2 - Switch on disabled.
Assigning Control Word Bits
Function Codes
In the CiA402 profile, fixed assignment of a function input is possible using the following codes:
Bit
Ethernet Embedded
Bit 11
C511
Bit 12
C512
Bit 13
C513
Bit 14
C514
Bit 15
C515
For example, to assign the DC injection braking to bit13 of the fieldbus adapter, simply configure the [DC
Injection Assign] dCI parameter with the [C513] C513 value.
Bit 11 is assigned by default to the operating direction command [Reverse Assign] rrS.
100
NVE61653 09/2016
Software Setup
[CIA402 State Reg] EtA
Bit Mapping of the Status Word
Bit 7
Bit 6
Bit 5
Bit 4
Bit 3
Bit 2
Bit 1
Bit 0
Warning
Switch on
disabled
Quick stop
Voltage
enabled
Fault
Operation
enabled
Switched on
Ready to
switch on
Error
detected
Running
Ready
1 = Awaiting
power
Stage
supply
A warning is Power stage
active
supply
disabled
0 = Quick
Power stage
stop is active supply
present
Bit 15
Bit 14
Bit 13
Bit 12
Bit 11
Bit 10
Bit 9
Bit 8
Manufacturer
-specific
Direction of
rotation
Manufacturerspecific Stop
via STOP key
Reserved
(=0)
Reserved
(=0)
Internal limit
active
Target
reached
Remote
Reserved (=0)
Reference
value outside
limits
Reference
value
reached
Command
or reference
value via
fieldbus
Operating
State
Bit 6
Bit 5
Bit 4
Bit 3
Bit 2
Bit 1
Bit 0
ETA Masked
Switch On
Disabled
Quick
Stop
Voltage
Enabled
Fault
Operation
Enabled
Switched
On
Ready to
Switch On
by 006F H (1)
1 -Not
ready to
switch on
0
X
X
0
0
0
0
−
2 -Switch
on
disabled
1
X
X
0
0
0
0
0040 hex
3 -Ready
to switch
on
0
1
X
0
0
0
1
0021 hex
4 Switched
on
0
1
1
0
0
1
1
0023 hex
5 Operation
enabled
0
1
1
0
1
1
1
0027 hex
6 -Quick
stop
active
0
0
1
0
1
1
1
0007 hex
7 -Fault
reaction
active
0
X
X
1
1
1
1
002F
8 -Fault
0
X
X
1
0
0
0
0008 hex(2)..
.0028 hex
(1)
This mask can be used by the PLC program to test the diagram state.
detected error following operating state 6 - Quick stop active.
X: In this state, the value of the bit can be 0 or 1.
(2)
NVE61653 09/2016
101
Software Setup
Starting Sequence
Description
The command sequence in the state diagram depends on how power is being supplied to the drive.
There are 3 possible scenarios:
Power stage
supply
Direct
Direct
Mains contactor controlled by the
drive
Control stage
supply
Not separate (1)
Separate
Separate
(1)
102
The power stage supplies the control stage.
NVE61653 09/2016
Software Setup
Sequence for a Drive Powered by the Power Stage Supply
Description
Both the power and control stages are powered by the power stage supply.
If power is supplied to the control stage, it has to be supplied to the power stage as well.
The following sequence must be applied:
Step 1
Apply the 2 - Shut down command
Step 2



Check that the drive is in the operating state 3 - Ready to switch on.
Then apply the 4 - Enable operation command.
The motor can be controlled (send a reference value not equal to zero).
NOTE: It is possible, but not necessary to apply the 3 - Switch on command followed by the 4 Enable Operation command to switch successively into the operating states 3 - Ready to Switch
on, 4 - Switched on and then 5 - Operation Enabled. The 4 - Enable operation command
is sufficient.
NVE61653 09/2016
103
Software Setup
Sequence for a Drive with Separate Control Stage
Description
Power is supplied separately to the power and control stages.
If power is supplied to the control stage, it does not have to be supplied to the power stage as well.
The following sequence must be applied:
Step 1


104
The power stage supply is not necessarily present.
Apply the 2 - Shut down command
NVE61653 09/2016
Software Setup
Step 2


Power Stage Supply
Terminal Display
Absent
nLP
21 hex
Present
rdY
31 hex

NVE61653 09/2016
Check that the drive is in the operating state 3 - Ready to switch on.
Check that the power stage supply is present (Voltage enabled of the status word).
Status Word
Apply the 3 - Switch on command
105
Software Setup
Step 3




106
Check that the drive is in the operating state 4 - Switched on.
Then apply the 4 - Enable operation command.
The motor can be controlled (send a reference value not equal to zero).
If the power stage supply is still not present in the operating state 4 - Switched on after a time delay
[Mains V. time out] LCt, the drive triggers an error [Input Contactor] LCF.
NVE61653 09/2016
Software Setup
Sequence for a Drive with Mains Contactor Control
Description
Power is supplied separately to the power and control stages.
If power is supplied to the control stage, it does not have to be supplied to the power stage as well. The
drive controls the mains contactor.
The following sequence must be applied:
Step 1


NVE61653 09/2016
The power stage supply is not present as the mains contactor is not being controlled.
Apply the 2 - Shutdown command.
107
Software Setup
Step 2


108
Check that the drive is in the operating state 3 - Ready to switch on.
Apply the 3 - Switch on command, which closes the mains contactor and switch on the power stage
supply.
NVE61653 09/2016
Software Setup
Section 4.5
Embedded Webserver
Embedded Webserver
What Is in This Section?
This section contains the following topics:
Topic
NVE61653 09/2016
Page
Overview
110
Connection to the Webserver
111
My Dashboard
112
Display - Drive
113
Setup - My Preference
114
109
Software Setup
Overview
Webserver
The Ethernet adapter provides an integrated Web server (in six languages) which allows several functions
like: display, parameter settings, and diagnostics. This chapter describes the services provided by this
webserver.
The webserver can be accessed from standard browsers like Internet Explorer, Chrome, Safari, or Firefox.
110
NVE61653 09/2016
Software Setup
Connection to the Webserver
Access
The webserver can be accessed from standard browsers.
In the following example, the drive has received the IP address 10.0.0.5:
First connect the computer to the drive by typing http:// followed by the drive IP address.
You are asked to first enter a User Name and a Password.
By default the user name is ADMIN. If you are connecting to the webserver for the first time, the password
is available from the Graphic Display Terminal of the drive in the [Main Menu] / [My preference]
MYP/[Webserver] WbS-/[Webserver default password] WDP menu. Once logged in you are asked to
change the default connection ID (User Name and Password), according to the default security access
rule. Access rules can be modified in the Setup/Access Management web page.
Once connected, the webserver home page is displayed.
Using IPV6 network discovery service, there is no need to set IP parameters. The drive appears
automatically in the network explorer of the PC while physically connected.
The drive is identified as ATV340•••••-MMMM where MMMM is the two last bytes of the MAC address.
Right-click and select Display device web page to open the webserver.
Web Server Site Map
The descriptions of the Web server pages are shown in the following table
Page
Menu
My Dashboard
Display
Diagnostics
Drive
Setup
NVE61653 09/2016
Description
This page can be customized, adding or removing Widgets
that are designed for a quick overview of the drive data.
Drive
Drive parameters are displayed in data tables. Customized
tables can be created.
Energy Dashboard
Trends show information about the energy consumption of
the drive.
Chart Viewer
Drive parameters are displayed in charts. Customized charts
can be created.
Drive
Drive diagnostics are displayed.
Fieldbus
Communication diagnostics are displayed.
Drive Parameter
Drives settings can be modified.
Drive Communication
Communication settings can be modified.
Fieldbus
Drive Ethernet settings can be modified.
File Transfer
Drive configuration and reports can be downloaded or loaded
between a computer and the drive.
My Preferences
Webserver access and appearance can be handled.
111
Software Setup
My Dashboard
Overview
The following table provides the procedure to add the widget to this page:
Step
Action
1
Click the add a widget button.
2
Drag a widget to the desired location.
The following figure shows the widgets that can be added. Various widgets of a same category are
available.
112
NVE61653 09/2016
Software Setup
Display - Drive
Data Table
The following table provides the procedure to create data tables of drive parameters.
Step
Action
1
Type the name of the table. Spaces are not allowed in this field.
2
3
Select a parameter by clicking the top of the parameter or typing the code and clicking the
button. To delete a parameter while creating the table click the parameter.
Click the Add Table button.To remove a table click the
selected.
button, only visible when the table is
Chart Viewer
The following table provides the procedure to create a chart viewer.
Step
Action
1
Type the name of the chart. Spaces are not allowed in this field.
2
Select the plot frequency.
3
Select the plot frequency unit.
4
Select the number of plot points.
5
6
NVE61653 09/2016
Select a parameter by clicking the top of the parameter or typing the code and clicking the
button. To delete a parameter while creating the chart click the parameter. Maximum of five
parameters can be selected.
Click the Create Chart button, To remove a chart click the
selected.
button, only visible when chart is
113
Software Setup
Setup - My Preference
User Access
In this menu, the access to the Web server can be managed by users with administrator rights. These
users can add, remove, block, unblock, and modify the access rights of other users.
The following table shows the description of the buttons located in this menu:
Button
Description
Add a new user, typing the name of the user; the password and the access rights.
Block and unblock the access of a user to the webserver
Change the password. The administrator can change the password of other users.
Themes
In this menu, the aspect of the Web server can be changed. Predefined themes are available, which can
be customized.
The following table provides the procedure for creating new themes
Step
Action
1
Click the
button.
2
Type the name of the theme. Spaces are not allowed in this field.
3
Type the description of the theme.
4
Upload a logo by clicking the
5
Type name of the website.
6
Click the Save button.
button.
Access Management
Select if login credentials are required or not to access to the web server. The password policy can be
changed.
The following table describes the different actions that can be set to enforce the password policy.
114
Action
Description
Enforce Password Policy
Enable or disable the password enforcement
Password History
Limits the number of failed attempts to access before locking the user account,
it can be set to disable or three and even five attempts.
Special Character Required
If enabled, a special character is mandatory when creating a password for a user
account.
Numeric Character
If enabled, a numeric character is mandatory when creating a password for a
user account.
Alphabetic Character
If enabled, an alphabetical character is mandatory when creating a password for
a user account.
Minimum Password Length
If enabled, a preset number of characters is mandatory when creating a
password for a user account.
NVE61653 09/2016
Software Setup
Section 4.6
Software Setup with SoMachine (M251)
Software Setup with SoMachine (M251)
What Is in This Section?
This section contains the following topics:
Topic
NVE61653 09/2016
Page
Introduction
116
Drive Configuration
117
Ethernet Master Configuration
118
115
Software Setup
Introduction
Overview
In the following example
 Drive is connected to the M251MESE
 Communication protocol used is EtherNet/IP
 You can control the drive directly via SoMachine
NOTE: The version of SoMachine used is V 4.2
116
NVE61653 09/2016
Software Setup
Drive Configuration
Overview
In the following example, the drive configuration must be done as follows in-order to establish
communication between the drive and the PLC.
You can configure the drive using the
 Graphical Display Terminal
 DTM via the SoMachine container
Factory Settings
Before configuring the drive, make sure that you reset the drive to factory setting
Go to
 [File Management] FMT- menu
 [Factory settings] FCS- submenu
Then configure the following parameters
 [Parameters group list] FrY- to [All] All
 [Go to Factory Settings] GFS to OK
Command Configuration
To control the drive with an Ethernet master, select Ethernet as active command channel
Go to
[Complete Settings] CSt- menu
 [Command and Reference] CrP- menu

Then configure
 [Ref Freq 1 Config] Fr1 parameter to [Embedded Ethernet] EtH value
Communication Configuration
To set the Ethernet address of the drive, go to:
 [Communication] COM- menu
 [Comm parameters] CMP- submenu
 [Embd Eth Config] EtE- submenu
Then configure
 [IP Mode Ether. Embd] IM00 to value [Fixed] MAnu
 [IP address] IC0 to value 192.168.0.2
 [Mask] IM0 to value 255.255.255.0
You must restart the device to take into account the modified Ethernet related parameters.
NVE61653 09/2016
117
Software Setup
Ethernet Master Configuration
Overview
In the following example, Ethernet master is configured via SoMachine.
Master Configuration
To access the master configuration window, double click Ethernet_2 (Device Network)
In the Configuration window, do the following to configure the master:
 Select Fixed IP Address
 In the IP Address box, enter 192.168.0.1 as the IP address of the master
 In the Subnet Mask box, enter 255.255.255.0 as the subnet mask of the master
NOTE: Other parameters are linked to Cyber Security parameters. For more information, refer to the
M251MESE documentation.
118
NVE61653 09/2016
Software Setup
NVE61653 09/2016
119
Software Setup
Add ATV340 Device
Right-click Industrial_Ethernet_Manager and then click Add Device
120
NVE61653 09/2016
Software Setup
In the Add Device dialog box, under Name, select Altivar 340, and then click the Add Device button.
ATV340 Configuration
Double-click ATV340
In the Target settings tab, configure the IP address of the device as shown in the figure.
In the Ethernet/IP I/O Mapping Tab, inputs/output are automatically created depending on the selected
assemblies (for example: assemblies 100/101)
You can give variable names and descriptions to these variables to use them in your PLC program.
NVE61653 09/2016
121
Software Setup
The figure shows the input mapping for the selected assemblies
The figure shows the output mapping for the selected assemblies
122
NVE61653 09/2016
Altivar Machine ATV340
Operations
NVE61653 09/2016
Chapter 5
Operations
Operations
What Is in This Chapter?
This chapter contains the following sections:
Section
NVE61653 09/2016
Topic
Page
5.1
Operating States
124
5.2
Operating Modes
126
123
Operations
Section 5.1
Operating States
Operating States
Configuring Communication Error Response
Description
The response of the drive in the event of an Ethernet communication interruption can be configured.
Configuration can be performed using the display terminal from the [Complete settings] CSt-,
[Error/Warning handling] CSWM- menu, [Embedded modbus TCP] EMtC- via the [Eth Error
Response] EtHL parameter.
The values of the [Eth Error Response] EtHL parameter, which triggers a transition to the operating
state fault are:
Value
Meaning
[Freewheel Stop] YES
Freewheel stop (factory setting)
[Ramp stop] rMP
Stop on ramp
[Fast stop] FSt
Fast stop
[DC injection] dCI
DC injection stop
The values of the [Eth Error Response] EtHL parameter, which does not trigger a transition to the
operating state fault are:
Value
Meaning
[Ignore] nO
Detected error ignored
[Per STT] Stt
Stop according to configuration of [Type of stop] Stt
[Fallback Speed] LFF
Change to fallback speed, maintained as long as the detected error persists
and the run command has not been removed
[Speed maintained] rLS
The drive maintains the speed at the time the detected error occurred, as long
as the detected error persists, and the run command has not been removed
The fallback speed can be configured in the [Complete settings] CSt-, [Error/Warning handling]
CSWM- menu, [Fallback speed] LFF- submenu, using the [FallbackSpeed] LFF parameter.
WARNING
LOSS OF CONTROL
If this parameter is set to nO, Ethernet communication monitoring is disabled.
 Only use this setting after a thorough risk assessment in compliance with all regulations and standards
that apply to the device and to the application.
 Only use this setting for tests during commissioning.
 Verify that communication monitoring has been re-enabled before completing the commissioning
procedure and performing the final commissioning test.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
124
NVE61653 09/2016
Operations
Detected Errors
Parameter
Written to the
device
[FDR 1 Error]
FDR1
NVE61653 09/2016
Description
Possible Values
Terminal Display
This parameter is used 1: Modbus TCP timeout
to indicate that fieldbus
error has been
detected.
When the detected
error is active, the value
corresponds to the
cause of the error.
When the cause of the
error is no longer active,
the value is reset to 0.
[1] 1
−
1: Invalid IP address
2: Duplicate IP address
[1] 1
[2] 2
This parameter is used
to indicate that an error
has been detected
during FDR procedure.
Details about this error
are provided using
FDR0 parameter.
0: No error
1: Server timeout
2: No file on server
3: Corrupted file on server
4: Empty file on server
5: Invalid file on drive
6: CRC error
7: Version incompatibility between drive
and file.
9: No file on drive
10: File size reading error on server
11: Drive cannot open the file
12: Drive cannot read the file
13: File incompatibility
14: Drive name is invalid
15: Incorrect file size on server
16: Drive cannot write the file
17: Server cannot write the file
[No error]
[Server Timeout]
[Server No File]
[Server Corrupt File]
[Server Empty File]
[Drive Invalid File]
[CRC Error]
[Version Incompatibility]
[Drive No File]
[Server Reading Size]
[Drive Opening File]
[Drive Reading File]
[Incompatibility]
[Drive Invalid Name]
[Server Incorrect File Size]
[Drive Writing File]
[Server Writing File]
125
Operations
Section 5.2
Operating Modes
Operating Modes
What Is in This Section?
This section contains the following topics:
Topic
126
Page
Configuring the Control Channel
127
Configuration of the Drive for Operation in I/O Profile
127
Configuration of the Drive for Operation with CiA 402 Profile in Combined Mode
128
Configuration of the Drive for Operation with CiA 402 Profile in Separate Mode
129
NVE61653 09/2016
Operations
Configuring the Control Channel
Overview
This chapter explains how to configure the drive for operation from the communication network through
three following examples.
 I/O mode - a simple command word (based on forward, reverse, and reset binary commands).
 Combined mode (with native profile CiA 402) - Both reference value and command word come from the
communication network.
 Separate (with native profile CiA 402) - reference value and command word come from separate
sources: for example, the command word (in CiA 402) comes from the communication network and the
reference value from the HMI.
Configuration of the Drive for Operation in I/O Profile
Description
For the I/O profile, here is a simple example, which can be extended with additional features. The
command word is made of run forward (bit 0 of CMd), run reverse (bit 1 of CMd), and the function fault
reset (bit 7 of CMd). Reference frequency is given by analog input 1.
The settings are the following:
[Ref Freq 1 Config] Fr1
[AI1] AI1
[Control Mode] CHCF
[I/O profile] IO
[Command switching] CCS
[Cmd Channel 1] CD1
[Cmd channel 1] Cd1
[Ethernet] EtH
The bits of the command word can now be configured.
In the [Command and Reference]CrP- menu configure:
[Reverse Assign] rrS
[CD01] Cd01
In the [Error/Warning handling]CSWM- menu, [Fault Reset] rSt-submenu, configure:
[Fault Reset] rSF
NVE61653 09/2016
[CD07] Cd07
127
Operations
Configuration of the Drive for Operation with CiA 402 Profile in Combined Mode
Description
This section describes how to configure the settings of the drive if it is controlled in CiA 402 mode. The
example focuses on the not separate mode. Additional modes are detailed in the drive programming
manual.
In the [Complete settings] CSt- menu, [Command and reference] CrP [Ref Freq Channel 1] Fr1: is set on according to the communication source you can choose in the
following table:
Origin of the Control
Ref1 Channel Setting
Ethernet embedded
[Embedded Ethernet] EtH


[Freq Switch Assign] rFC is set to default value ([Ref Freq 1 Config] Fr1).
[Control Mode] CHCF: defines if the drive operates in combined mode (reference and command from
the same channel).
For the current example, [Control Mode] CHCF is adjusted to [Not separ.] SIM as reference and control
are originated from the communication network.
128
Profile
Ref1 Channel setting
CiA 402 combined mode
[Not separ.] SIM
CiA 402 separate mode
[Separate] SEp
I/O profile
[I/O profile] IO
NVE61653 09/2016
Operations
Configuration of the Drive for Operation with CiA 402 Profile in Separate Mode
Description
Alternate combinations are possible, see the drive programming manual for the list of possible settings.
For example:
The drive is controlled from the communication but the reference value is adjusted with analog input 1. The
control word comes from the controller and is written according to CiA 402 profile.
The settings are as shown in the table:
NVE61653 09/2016
[Ref Freq 1 Config] Fr1
[AI1] AI1
[Control Mode] CHCF
[Separate] SEp
[Cmd channel 1] Cd1
[Ethernet] EtH
[Freq Switch Assign] rFC
[Ref Freq Channel] FR1
129
Operations
130
NVE61653 09/2016
Altivar Machine ATV340
Diagnostic and Troubleshooting
NVE61653 09/2016
Chapter 6
Diagnostic and Troubleshooting
Diagnostic and Troubleshooting
What Is in This Chapter?
This chapter contains the following topics:
Topic
NVE61653 09/2016
Page
Fieldbus Status LEDs
132
Connection for Fieldbus Mode
133
Fieldbus Functions Test
134
Control-Signal Diagnostics
136
131
Diagnostic and Troubleshooting
Fieldbus Status LEDs
LED Indicators
The following figure describes the LEDs status for fieldbus monitoring:
ATV340U07N4E to ATV340D22N4E
ATV340D30N4E to ATV340D75N4E
LED Description
Item
LED
Description
1
LNK1
Indicates port A activity.
2
MS
Indicates status.
3
NS
Indicates network status.
4
LNK2
Indicates port B activity.
LNK1 and LNK2
These LEDs indicate the status of the Ethernet adapter ports:
Color & status
Description
OFF
No link
Blinking Green/Yellow
Power on testing
Green ON
Link established at 100 Mbit/s
Yellow ON
Link established at 10 Mbit/s
Blinking Green
Fieldbus activity at 100 Mbit/s
Blinking Yellow
Fieldbus activity at 10 Mbit/s
NS: Network Status
This LED indicates the status of the fieldbus
132
Color & status
Description
OFF
The device does not have an IP address or powered off
Blinking Green/Red
Power on testing
Green ON
A connection is established to control the command word.
Blinking Green
Device has a valid IP, but no command word connection.
Red ON
Duplicated IP
Blinking Red
An established connection to control the command word is closed or timed out
NVE61653 09/2016
Diagnostic and Troubleshooting
MS: Module Status
This LED indicates the status of the adapter
Color & status
Description
OFF
No power is supplied to the device
Blinking Green/Red
Power on testing
Green ON
The device is operating correctly.
Blinking Green
Device has not been configured.
Blinking red
The device has detected a recoverable minor detected error.
Red ON
The device has detected a non-recoverable major detected error.
Connection for Fieldbus Mode
Description
If the product cannot be addressed via the fieldbus, first check the connections. The product manuals
contains the technical data of the device and information on fieldbus and device installation.
Verify the following:
 Power connections to the device
 Fieldbus cable and fieldbus wiring
 Fieldbus connection to the device
NVE61653 09/2016
133
Diagnostic and Troubleshooting
Fieldbus Functions Test
Channels for Commands and Reference Values
All the drive commands and reference value parameters are managed on a channel-by-channel basis.
Parameter Name
Parameter Code
Taken Into
Account by the
Drive
Modbus
Serial
CANopen
Fieldbus Module
Ethernet
Embedded
Control word
CMd
CMd1
CMd2
CMd3
CMd5
Extended control
word
CMI
CMI1
CMI2
CMI3
CMI5
Reference speed
(rpm)
LFrd
LFd1
LFd2
LFd3
LFd5
Reference frequency
(0.1 Hz)
LFr
LFr1
LFr2
LFr3
LFr5
Reference value for
torque control mode
(0.1% of the nominal
LTR
LTR1
LTR2
LTR3
LTR5
Reference value
supplied by PI
controller
PISP
PIr1
PIr2
PIr3
PIr5
Reference value
supplied by analog
multiplier function
MFr
MFr1
MFr2
MFr3
MFr5
torque)(1)
(1):
If available
Fieldbus Monitoring Criteria
The fieldbus is monitored according to the protocol-specific criteria.
Protocol
Criteria
Related Detected Error
Embedded Ethernet
FDR detected error
IP address duplication detected error
Adjustable time-out for received control
word (I/O scanning or messaging)
Fieldbus overload
[External Error] EPF1
[FDR 1 Error] FDR1
[Embd Eth Com Interrupt] EtHF
Monitoring of Communication Channels
Communication channels are monitored if they are involved in one of the following parameters:
 The control word ([Cmd Register] CMd) from the active command channel
 The control word containing the command switch (bit configured on [Cmd switching] CCS)
 The control word containing the switch for reference value 1'1B (bit configured on [Ref 1B switching]
rCb)
 The control word containing the switch for reference value 1'2 (bit configured on [Freq Switch Assign]
rFC)
 The reference frequency or reference speed ([Ref Frequency] LFr or LFRD: Nominal speed value)
from the active channel for reference value
 Summing reference frequency or reference speed ([Ref Frequency] LFr or LFRD: Nominal speed
value) 2 (assigned to [Summing Input 2] SA2)
 Summing reference frequency or reference speed ([Ref Frequency] LFr or LFRD: Nominal speed
value) 3 (assigned to [Summing Input 3] SA3)
 Subtracting reference frequency or reference speed ([Ref Frequency] LFr or LFRD: Nominal speed
value) 2 (assigned to [Subtract Ref Freq 2] dA2)
 Subtracting reference frequency or reference speed ([Ref Frequency] LFr or LFRD: Nominal speed
value) 3 (assigned to [Subtract Ref Freq 3] dA3)
 The reference value given by the PID controller (PISP)
 The PID controller feedback ([AI Virtual 1] AIU1)
134
NVE61653 09/2016
Diagnostic and Troubleshooting


The multiplication coefficient of the reference values ([Multiplying coeff.] MFr) 2 (assigned to [Ref Freq
2 Multiply] MA2)
The multiplication coefficient of the reference values ([Multiplying coeff.] MFr) 3 (assigned to [Ref Freq
3 Multiply] MA3)
As soon as one of these parameters has been written once to a communication channel, it activates
monitoring for that channel.
If a communication warning is sent (in accordance with the protocol criteria) by a monitored port or fieldbus
module, the drive triggers a communication interruption.
The drive reacts according to the communication interruption configuration (operating state Fault,
maintenance, fallback, and so on)
If a communication warning occurs on a channel that is not being monitored, the drive does not trigger a
communication interruption.
Enabling of Communication Channels
A communication channel is enabled once all the parameters involved have been written at least one
time.The drive is only able to start if all channels involved in command and reference value are enabled.
For example:
A drive in DSP402 profile is connected to an active communication channel.
It is mandatory to write at least 1 time the reference value and the command in order to switch from 4Switched on to 5-Operation enabled state.
A communication channel is disabled:
In the event of a communication warning.
 In forced local mode.
NOTE: On exiting forced local mode:




NVE61653 09/2016
The drive copies the run commands, the direction, and the forced local reference value to the active
channel (maintained).
Monitoring of the active channels for the command and reference value resumes following a time delay
[Time-out forc. local] FLOt.
Drive control only takes effect once the d rive has received the reference and the command from the
active channels.
135
Diagnostic and Troubleshooting
Control-Signal Diagnostics
Introduction
On the display terminal, the [Display] MON-, [Communication map] CMM- submenu can be used to
display control-signal diagnostic information between the drive and the controller:
 Active command channel [Command Channel] CMdC
 Value of the control word [Cmd Register] CMd from the active command channel [Command Channel]
CMdC
 Active reference frequency channel [Ref Freq Channel] rFCC
 Value of the reference frequency [Pre-Ramp Ref Freq] FrH from the active target channel [Ref Freq
Channel] rFCC
 Value of the operating state word [CIA402 State Reg] EtA
 Specific data for all available fieldbusses are in dedicated submenus.
 In the [Command word image] CWI- submenu: control words from all channels
 In the [Freq. ref. word map] rWI- submenu: reference frequency values produced by all channels
Control Word Display
The [Command Channel] CMdC parameter indicates the active command channel.
The [Cmd Register] CMd parameter indicates the hexadecimal value of the control word (CMD) used to
control the drive.
The [Command word image] CWI- submenu ([Ethernet Embd cmd.] CMd5) parameter is used to
display the hexadecimal value of the control word from the fieldbus .
Reference Frequency Display
The [Ref Freq Channel] rFCC parameter indicates the active channel for reference frequency.
The [Ref Frequency] LFr parameter indicates the value (in 0.1 Hz units) of the reference frequency used
to control the drive.
The [Freq. ref. word map] rWI- submenu ([Ethernet Embd Ref Freq] LFr5) parameter is used to
display the value (in 0.1 Hz units) of the reference frequency from the fieldbus.
Operating State Word Display
The [CIA402 State Reg] EtA parameter gives the value of the operating state word (ETA).
The table provides the bit details of ETA parameter:
136
Bit
Description
DRIVECOM
Status word
Bit0 = 1
Ready to switch on
Bit1 = 1
Switched on
Bit2 = 1
Operation enabled
Bit3 = 1
Operating state fault
Bit4 = 1
Power stage is switched on
Bit5 = 0
Quick stop
Bit6 = 1
Switch on disabled
Bit7 = 1
Warning
Bit8 = 1
Drivecom reserved
Bit9 = 0
Forced local mode in progress
Bit10 = 1
Reference value reached (steady state)
Bit11 = 1
Reference value exceeded (< LSP or > HSP)
Bit12
Reserved
Bit13
Reserved
Bit14 = 1
Stop imposed via STOP key
Bit15 = 0
Motor rotation in forward direction (or stopped)
NVE61653 09/2016
Altivar Machine ATV340
Glossary
NVE61653 09/2016
Glossary
A
Abbreviations
Req. = Required
Opt. = Optional
C
CAN
COB
COB ID
Controller Area Network is an internally standardized serial bus system
Communication Object. A unit of transportation in a CAN network. Data must be sent across a CAN
Network inside a COB. There are 2048 different COB's in a CAN network. A COB can contain at most
8 bytes of data.
Each COB is uniquely identified in a CAN network by a number called the COB Identifier (COB-ID).
D
Display terminal
The display terminal menus are shown in square brackets.
For example: [Communication]
The codes are shown in round brackets.
For example: COMParameter names are displayed on the display terminal in square brackets.
For example: [Fallback Speed]
Parameter codes are displayed in round brackets.
For example: LFF
DP
DPWS
Decentralized Periphery
Device Profile for Web Service
E
Error
Discrepancy between a detected (computed, measured, or signaled) value or condition and the specified
or theoretically correct value or condition.
F
Factory setting
Fault
Fault Reset
NVE61653 09/2016
Default configuration of the product.
Fault is an operating state. If the monitoring functions detect an error, a transition to this operating state is
triggered, depending on the error class. A "Fault reset" is required to exit this operating state after the
cause of the detected error has been removed. Further information can be found in the pertinent standards
such as IEC 61800-7, ODVA Common Industrial Protocol (CIP).
A function used to restore the drive to an operational state after a detected error is cleared by removing
the cause of the error so that the error is no longer active.
137
Glossary
L
LSB
Least Significant Byte
M
MEI
Monitoring function
MS0, MS1
MSB
Modbus Encapsulated Interface
Monitoring functions acquire a value continuously or cyclically (for example, by measuring) in order to
check whether it is within permissible limits. Monitoring functions are used for error detection.
Number of a master in the network.
Most Significant Byte
N
NMT
Network Management. One of the service elements of the application layer in the CAN Reference Model.
The NMT serves to configure, initialize, and handle detected errors in a CAN network.
P
Parameter
PDO
PELV
PLC
PNO
Power stage
Device data and values that can be read and set (to a certain extent) by the user.
Process Data Object
Protective Extra Low Voltage, low voltage with isolation. For more information: IEC 60364-4-41
Programmable logic controller
PROFIBUS Nutzerorganisation e.V. (PROFIBUS User organization).
The power stage controls the motor. The power stage generates current for controlling the motor.
Q
QoS
Quick Stop
Quality of Service
The quick Stop function can be used for fast deceleration of a movement as a response to a detected error
or via a command.
R
RPDO
Receive PDO
S
SNMP
138
Simple Network Management Protocol
NVE61653 09/2016
Glossary
SNTP
SYNC
Simple Network Time Protocol
Synchronization Object
T
TPDO
Transmit PDO
V
VSD
Variable Speed Drive
W
Warning
If the term is used outside the context of safety instructions, a warning alerts to a potential problem that
was detected by a monitoring function. A warning does not cause a transition of the operating state.
Z
Zone of operation
NVE61653 09/2016
This term is used in conjunction with the description of specific hazards, and is defined as it is for a hazard
zone or danger zone in the EC Machinery Directive (2006/42/EC) and in ISO 12100-1.
139
Glossary
140
NVE61653 09/2016
ATV340_Ethernet_Embedded_Manual_EN_NVE61653_01
09/2016
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement