Vacon NX OPTCQ Ethernet IP Board User Manual DPD00
Vacon NX OPTCQ Ethernet IP Board User Manual DPD00
Vacon NX OPTCQ Ethernet IP Board User Manual DPD00
ac drives
optcq
user manual
vacon 1
Table of contents
Document: DPD00893B
Version release date: 18.2.2013
1.
2.
Introduction ...................................................................................................................... 3
EtherNet/IP board technical data ..................................................................................... 4
3.
Installation ....................................................................................................................... 8
2.1
2.2
2.3
2.4
3.1
3.2
3.3
3.3.1
3.4
Overview ..........................................................................................................................................................4
LED indications................................................................................................................................................5
EtherNet/IP......................................................................................................................................................5
Connections and wiring ..................................................................................................................................7
Installing the EtherNet/IP option board in a Vacon NX unit........................................................................8
NCDrive ..........................................................................................................................................................10
IP tool NCIPConfig.........................................................................................................................................10
Updating the OPTCQ option board program with the NCIPConfig tool ......................................................12
Configuring the option board parameters ...................................................................................................13
4.
Commissioning ............................................................................................................... 14
5.
EtherNet/IP .................................................................................................................... 17
6.
7.
4.1
4.2
4.3
5.1
5.2
5.3
5.4
5.4.1
5.4.2
5.4.3
5.4.4
6.1
6.1.1
6.1.2
6.1.3
6.1.4
6.2
6.2.1
6.2.2
6.2.3
6.2.4
6.3
6.3.1
6.3.2
7.1
7.1.1
7.1.2
7.1.3
7.1.4
7.1.5
7.1.6
7.1.7
7.2
7.2.1
7.2.2
7.2.3
IP address ......................................................................................................................................................15
Communication timeout ...............................................................................................................................15
Input/Output assemblies ..............................................................................................................................15
Overview ........................................................................................................................................................17
AC/DC drive profile .......................................................................................................................................17
EDS file ..........................................................................................................................................................17
Explicit messaging ........................................................................................................................................18
List of object classes.....................................................................................................................................18
List of services ..............................................................................................................................................18
List of data types ...........................................................................................................................................19
Reset service .................................................................................................................................................19
Common required objects of the CIP ...........................................................................................................20
Identity object, class 0x01 .............................................................................................................................20
Connection manager object, class 0x06 ......................................................................................................21
TCP/IP interface object, class 0xF5 .............................................................................................................22
Ethernet link object, class 0xF6 ...................................................................................................................23
Objects present in an AC/DC drive ...............................................................................................................24
Assembly object, class 0x04 .........................................................................................................................24
Motor data object, class 0x28 .......................................................................................................................24
Control supervisor object, class 0x29 ..........................................................................................................25
AC/DC drive object, class 0x2A.....................................................................................................................26
Vendor-specific objects ................................................................................................................................27
Vendor parameter object, class 0xA0 ..........................................................................................................27
Assembly instance selector object, class 0xBE ..........................................................................................27
Output instances ...........................................................................................................................................28
Assembly instance 20 ...................................................................................................................................28
Assembly instance 21 (default) ....................................................................................................................28
Assembly instance 23 ...................................................................................................................................28
Assembly instance 25 ...................................................................................................................................29
Assembly instance 101 .................................................................................................................................29
Assembly instance 111 .................................................................................................................................30
Assembly instance 128 .................................................................................................................................30
Input instances ..............................................................................................................................................32
Assembly instance 70 ...................................................................................................................................32
Assembly instance 71 (default) ....................................................................................................................32
Assembly instance 73 ...................................................................................................................................32
2 vacon
7.2.4
7.2.5
7.2.6
7.2.7
7.2.8
8.
8.1
8.2
8.3
8.4
8.5
8.5.1
8.5.2
8.5.3
8.5.4
Introduction
1.
vacon 3
INTRODUCTION
The Vacon NX AC drive can be connected to Ethernet by using an EtherNet/IP fieldbus board
OPTCQ. The OPTCQ is installed in the card slot D or E.
Every appliance connected to an Ethernet network has two identifiers; a MAC address and an IP
address. The MAC address (Address format: 00:21:99:xx:yy:zz) is unique to the appliance and cannot
be changed. The EtherNet/IP board's MAC address is found on the sticker attached to the board or
by using the Vacon IP tool software NCIPConfig. Please find the software installation at
www.vacon.com.
In a local network, IP addresses can be defined by the user as long as all units connected to the
network are given the same network portion of the address. For more information about IP
addresses, contact your Network Administrator. Overlapping IP addresses cause conflicts between
appliances. For more information about setting IP addresses, see Chapter 3.
DANGER! When the AC drive is connected to the power source, the internal
components and circuit boards are at high potential. Coming into contact with
this voltage can cause death or severe injury.
9000.emf
NOTE! You can download the English and French product manuals with applicable safety,
warning and caution information from www.vacon.com/downloads.
REMARQUE Vous pouvez tlcharger les versions anglaise et franaise des manuels produit
contenant lensemble des informations de scurit, avertissements et mises en garde
applicables sur le site www.vacon.com/downloads.
4 vacon
2.
2.1
Overview
Table 1.
General
Ethernet connections
Communications
Card Name
Interface
Transfer cable
Speed
Duplex
IP address
Protocols
Environment
EtherNet/IP
Ambient operating
temperature
Storing
temperature
Humidity
Altitude
Vibration
Safety
OPTCQ
RJ-45 connector
Shielded Twisted Pair
10 / 100 Mb
half / full
Static IP or DHCP (firmware version
dependent)
V004 and newer: Default is DHCP
V003 and older: Default is static IP
192.168.0.10
10C50C
40C70C
<95%, no condensation allowed
Max. 1000 m
0.5 G at 9200 Hz
Fulfils EN50178 standard
2.2
vacon 5
LED indications
Figure 1.
Table 2.
LED
H4
H1
H2
2.3
Meaning
LED is ON when board is powered.
Blinking 0,25s ON / 0,25s OFF when board firmware is
corrupted (see Chapter 3.2).
OFF when board is operational.
Blinking 2,5s ON / 2,5s OFF when board is ready for
external communication.
OFF when board is not operational.
EtherNet/IP
EtherNet/IP is a member of a family of networks that implements the Common Industrial Protocol
(CIP) at its upper layers. CIP encompasses a comprehensive suite of messages and services for a
variety of manufacturing automation applications, including control, safety, synchronization, motion,
configuration and information. As a truly media-independent protocol that is supported by hundreds
of vendors around the world, CIP provides users with a unified communication architecture
throughout the manufacturing enterprise.
Common use-cases of Ethernet devices are human to machine and machine to machine. Basic
features of these two use-cases are presented in Figures 2 and 3 below.
More information on EtherNet/IP can be found at www.odva.org.
6 vacon
Ethernet switch
NOTE! The NCDrive can be used in NXS and NXP drives via Ethernet. In NXL drives this is not
possible.
vacon 7
Master
Real-Time Control
Start/Stop, Direction, etc.
Reference
Feedback
Ethernet switch
2.4
The EtherNet/IP board supports 10 and 100Mb speeds in both Full and Half-duplex modes. The
boards must be connected to the Ethernet network with a shielded CAT-5e cable. Use a so-called
crossover cable (at least CAT-5e cable with STP, Shielded Twisted Pair) if you want to connect the
EtherNet/IP option board directly to the master appliance. Use only industrial standard components
in the network and avoid complex structures to minimize the length of response time and the
amount of incorrect dispatches.
8 vacon
3.
3.1
Installation
INSTALLATION
Installing the EtherNet/IP option board in a Vacon NX unit
CAUTION! Before an option or fieldbus board is changed or added, make sure
that the AC drive is switched off.
13006.emf
Installation
vacon 9
10 vacon
3.2
Installation
NCDrive
The NCDrive software can be used with the EtherNet/IP board in NXS and NXP drives. However, it
does not work with with NXL drives.
It is recommended that you use the NCDrive software only in LAN (Local Area Network).
NOTE! If an OPTCQ Ethernet option board is used for an NC Tools connection, like NCDrive, the OPTD3 board cannot be used.
NCLoad does not work via Ethernet. See NCDrive Help for further information.
3.3
IP tool NCIPConfig
To start using the Vacon EtherNet/IP board, the IP address must be correctly configured. The OPTCQ
board has static IP as default (firmware V003 and older) or DHCP as default (firmware V004 or
newer).
If static IP is used, the correct IP address must be set before connecting the board to the network. If
DHCP is used, the board can be connected to the network, and when there is a DHCP server in the
network, the OPTCQ board will obtain its IP address from the DHCP server.
You need a PC with an Ethernet connection and the NCIPConfig tool installed to set the EtherNet/IP
board's IP addresses. To install the NCIPConfig tool, start the installation program from CD or
download it from the www.vacon.com website. After starting the installation program, follow the onscreen instructions.
When the program is installed successfully, launch it by selecting it in the Windows Start menu.
Follow these instructions to set the IP addresses. Select Help --> Manual if you want more
information about the software features.
Scan the network nodes. Select Configuration --> Scan and wait until the devices
connected to the bus in the tree structure are displayed to the left of the screen.
Installation
vacon 11
NOTE! Some switches block broadcast messages. In this case, each network node must be scanned
separately. Read the manual under Help menu.
Set the IP addresses. Change the nodes IP settings according to the network IP settings.
The program reports conflicts with a red colour in a table cell. Read the manual under
Help menu.
Send configuration to boards. In the table view, tick the boxes for boards whose
configuration you want to send. Select Configuration, then Configure. Your changes are
sent to the network and will be valid immediately.
NOTE! Only the symbols A-Z, a-z and 0-9 can be used in the drive name. Do not use special
characters or Scandinavian letters (, , etc.). The drive name can be freely formed using the
allowed characters.
12 vacon
3.3.1
Installation
Updating the OPTCQ option board program with the NCIPConfig tool
In some cases it may be necessary to update the option board's firmware. Differing from other Vacon
option boards, the EtherNet/IP option board's firmware is updated with the NCIPConfig tool. The IP
addresses of the PC and the option board must be in the same area when the software is loaded.
To start the firmware update, scan the nodes in the network according to the instructions
in Chapter 7. When you can see all nodes in the view, update the new firmware by clicking
the VCN packet field on the right in the table view of NCIPConfig.
Tick the new firmware packets box in the VCN Packet field at the right corner of the
table view. Select all nodes to be updated by ticking the boxes. Send the new firmware to
the board by selecting Software --> Download.
2.
1.
Installation
vacon 13
NOTE! Do not do a power up cycle within 1 minute after downloading the option board software. This
can cause the option board to go to Safe Mode. This situation can only be solved by re-downloading
the software. The Safe Mode triggers a fault code (F54). The Board slot error F54 can also appear
due to a faulty board, a temporary malfunction of the board or a disturbance in the environment.
NOTE! If the OPTCQ board firmware is updated from V003 (or older) to V004 (or newer), the static IP
address assigned to the board will remain after the update. To activate the DHCP mode manually,
see Chapter 4.
3.4
In the tree-view, expand the folders until you reach the board parameters.
Slowly double-click the parameter (Comm. Time-out in the figure below) and enter a new
value. When the modification is complete, the new parameter values are automatically
sent to the option board.
NOTE! If the fieldbus cable is broken or removed, a fieldbus error is generated. Reset the fault by
checking the installation. If the installation is correct, contact your nearest Vacon distributor. See NX
All in One Application Manual for resetting faults.
14 vacon
4.
Commissioning
COMMISSIONING
The Vacon EtherNet/IP board is commissioned with the control keypad by giving values to
appropriate parameters in menu M7 (or with the NCIPConfig tool, see Chapter 3.3). Keypad
commissioning is only possible with the NXP and NXS type AC drives. The NXL AC drives require the
NCIPConfig tool.
In the Expander board menu (M7) you can see which expander boards are connected to the control
board. You can also edit the parameters associated with the expander board.
1
2
3
Enter the following menu level (G#) with the arrow button right. Browse through slots A
to E with the arrow buttons up/down to see which expander boards are connected.
On the last line of the display, you see the number of parameter groups associated with
the board. Press the arrow button right once more to reach the parameter group level
where there is only one group in the EtherNet/IP board case: Parameters.
To go to Parameter group, press the arrow button right again.
Table 3.
EtherNet/IP parameters
No
1
Name
Comm. Timeout
Default
0
Range
0255 s
2
3
4
5
6
7
8
9
10
11
12
13
14
15
IP Part 1
IP Part 2
IP Part 3
IP Part 4
SubNet Part 1
SubNet Part 2
SubNet Part 3
SubNet Part 4
DefGW Part 1
DefGW Part 2
DefGW Part 3
DefGW Part 4
InputAssembly
OutputAssembly
192
168
0
10
255
255
0
0
192
168
0
1
71
21
1223
0255
0255
0255
0255
0255
0255
0255
0255
0255
0255
0255
0255
0255
Description
0 = RPI (Requested Packet
Interval) x CTM (Connection
Timeout Multiplier)
IP Address Part 1
IP Address Part 2
IP Address Part 3
IP Address Part 4
Subnet Mask Part 1
Subnet Mask Part 2
Subnet Mask Part 3
Subnet Mask Part 4
Default Gateway Part 1
Default Gateway Part 2
Default Gateway Part 3
Default Gateway Part 4
See Chapter 7
See Chapter 7
NOTE! The default value of parameter 1 is 0 in firmware versions V004 and newer. In earlier
versions the default value is 10 seconds.
NOTE! The default value of parameters 2-13 is 0 in firmware versions V004 and newer, because
DHCP is enabled by default.
Commissioning
vacon 15
4.1 IP address
The IP address is divided into four octets. The value is 0.0.0.0 when DHCP is used until the board has
been assigned an IP address. A static IP address is entered by editing the parameters from the
keypad or using NCIPConfig. This disables DHCP mode.
When the board has static IP, and the IP address is changed to *.0.0.0 through NCIPConfig or the
keypad, then DHCP mode will be re-enabled after the next power-up.
Changing the IP address to *.255.255.255 causes the board to change to static IP address
192.168.0.10 after the next power-up.
4.2 Communication timeout
With firmware version V004 or newer, when this parameter is assigned the value 0, the
communication timeout is the value of the Requested Packet Interval (RPI) multiplied with the
Connection Timeout Multiplier (CTM) as defined in the EtherNet/IP master. RPI for the OPTCQ board
is at minimum 16 milliseconds. If a value other than 0 is used as the communication timeout, this
means the total time (in seconds) including the RPI x CTM timeout. If communication with the
EtherNet/IP master device is inactive for a period longer than the defined communication timeout,
the drive generates a fieldbus fault.
With firmware version V003 or older, when this parameter is assigned the value 0, the
communication timeout is disabled. In this case a fieldbus fault is generated only if the Ethernet link
is lost (for example, if the cable is disconnected). You can change the Communication timeout value
from the keypad or with the NCIPConfig tool. See Chapter 3.3.
NOTE! If the fieldbus cable is broken or removed, a fieldbus error is generated. Reset the fault by
checking the installation. If the installation is correct, contact your nearest Vacon distributor. See NX
All in One Application Manual for resetting faults.
4.3 Input/Output assemblies
The I/O assemblies are changed in the keypad, through NCIPConfig, or in the EtherNet/IP master.
The same assembly must be selected in both the drive and the EtherNet/IP master. The
configuration assembly for the OPTCQ board must be set to 1 in the EtherNet/IP master.
All EtherNet/IP parameters are saved to the EtherNet/IP board (not to the control board). If the new
EtherNet/IP board is changed into the control board, you must configure the new EtherNet/IP board.
The option board parameters can be saved to the keypad, with the NCIPConfig tool or with NCDrive.
16 vacon
Commissioning
EtherNet/IP
vacon 17
5. ETHERNET/IP
5.1
Overview
EDS file
The Electronic Data Sheet (EDS) is a specially formatted ASCII text file that contains configuration
data for specific device types. The EDS provides information about the context, content and format of
the device configuration data.
The information in the EDS allows configuration tools to provide informative screens that guide you
through the steps that are needed to configure a device.
The EDS provides all of the information necessary to access and alter the configurable parameters
of a device. This information matches the information provided by instances of the Parameter Object
Class. The CIP Object Library describes the Parameter Object Class in detail.
18 vacon
EtherNet/IP
Explicit messaging
5.4
Explicit Messaging is used in commissioning and parametrising of the EtherNet/IP board. Explicit
messages provide multipurpose, point-to-point communication paths between two devices. They
provide the typical request/response-oriented network communication used to perform node
configuration and problem diagnosis. Explicit messages typically use low priority identifiers and
contain the specific meaning of the message right in the data field. This includes the service to be
performed and the specific object attribute address.
NOTE! If Class 1 connection (cyclic data) has been established, Explicit Messages cannot be used to
control Output Data. However, this restriction does not apply for I/O Data reading.
5.4.1
5.4.2
Object
Identity Objects
Assembly Object
Connection Manager Object
Motor Data Object
Control Supervisor Object
AC/DC Drive Object
Vendor Parameters Object
Assembly Instance Selector Object
TCP/IP Interface Object
Ethernet Link Object
List of services
The services supported by the object classes in Table 4 are shown below.
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Inst
Class
Assemly instance
selector
Vendor parameter
AC/DC Drive
Motor Data
Assembly
Y
Inst
Class
Y
Y
Inst
Class
Inst
Class
Inst
Class
Inst
Class
Class
Inst
Inst
Class
Ethernet link
TCP/IP interface
Connection manager
Inst
Y
Y
Y
Class
Identity object
Inst
Get_Attributes_All
Reset (Type 0)
Get_Attribute_Single
Set_Attribute_Single
Forward Close
Unconnected_Send
Forward_Open
Class
01
05
0E
10
4E
52
54
Service Name
Control Supervisor
Table 5.
Service
Code
(in hex)
Y
Y
Y
Y
Y
EtherNet/IP
5.4.3
vacon 19
The attribute list that follows includes information on the Data Type of each attribute. The following
tables explain the Data, Structure, and Array Type codes used in the Data Type column.
Table 6.
Data Type
Code (in hex)
C1
SINT
INT
USINT
UINT
UDINT
BYTE
WORD
SHORT_STRING
C2
C3
C6
C7
C8
D1
D2
DA
Table 7.
Type Code
A1
A2
5.4.4
Description
Abbreviated array type encoding
Formal structure type encoding
Reset service
The following table lists the different types of resets supported by the Identity Object. Resetting the
OPTCQ interface to its out-of-box configuration sets all the attributes to their default values. It also
changes the response of the drive to a loss of communications with the OPTCQ. The device has to be
re-configured for your application before resuming normal operation.
Table 8.
Value
0
Type of Reset
Emulate as closely as possible the cycling of power to
the OPTCQ EtherNet/IP Interface. This value is the
default if this parameter is omitted. The Vacon drive
shall be stopped if it is running.
20 vacon
6.
6.1
6.1.1
Class Attributes
Id
Description
Data Type
01h
Revision
02h
Max Instances
UINT
Class Services
Id
Service
0Eh
Get_Attribute_Single
Instance Attributes
Id
Description
Data Type
01h
Vendor ID
UINT
02h
Device Type
UINT
03h
Product Code
UINT
04h
Revision
STRUCT
of:
Major Revision
USINT
Minor Revision
USINT
05h
Status
WORD
Access Rule
Get
Get
Access Rule
Get
Get
Get
Get
Get
Byte struct:
(Bits meaning when True)
Bit0 = Owned
Bit2 = Configured
Bit8 = Minor Revocerable fault
Bit9 = Minor Unrecovable fault
Bit10 = Major Recoverable fault
Bit11 = Major Unrecoverable fault
Bit4 7:
0011 = No I/O connection
established
0110 = At least one I/O
connection in run mode
06h
07h
Serial Number
Product Name
UDINT
SHORT_
STRING
Get
Get
Instance Services
Id
Service
01h
Get_Attributes_All
05h
Reset*
0Eh
Get_Attribute_Single
*Only reset type 0 reset of the Option Board
6.1.2
vacon 21
Class Attributes
Id
Description
01h Revision
02h Max Instance
Class Services
Id
Service
01h Get_Attributes_All
0Eh Get_Attribute_Single
Instance Attributes
Id
Description
01h
02h
03h
Open Requests
Open Format Rejects
Open Resource
Rejects
04h Open Other Rejects
05h Close Requests
06h Close Format
Requests
07h Close Other Requests
08h Connection Timeouts
Instance Services
Id
Service
01h Get_Attributes_All
0Eh Get_Attribute_Single
4Eh Forward Close
52h Unconnected_Send
54h Forward_Open
Data
Type
Access Rule
Get
Get
Data
Type
UINT
UINT
UINT
Access Rule
Get
Get
Get
UINT
UINT
UINT
Get
Get
Get
UINT
UINT
Get
Get
22 vacon
6.1.3
Class Attributes
Id
Description
01h Revision
02h Max Instance
Class Services
Id
Service
01h Get_Attributes_All
0Eh Get_Attribute_Single
Instance Attributes
Id
Description
01h
02h
03h
04h
Status
Configuration
Capability
Configuration Control
Physical Link
Path Size
Path
05h
Interface
Configuration
IP Address
Network Mask
Gateway Address
Name Server
Name Server 2
Domain Name
06h Host Name
Instance Services
Id
Service
01h Get_Attributes_All
0Eh Get_Attribute_Single
10h Set_Attribute_Single
Data
Type
UINT
Data
Type
DWORD
DWORD
DWORD
STRUCT
of:
UINT
Padded
EPATH
STRUCT
of:
UDINT
UDINT
UDINT
UDINT
UDINT
STRING
STRING
Access Rule
Get
Get
Access Rule
Get
Get
Get / Set
Get
Get / Set
Get / Set
Attribute Configuration Control supports only the value 0 (device is using configuration values that
are stored in non-volatile memory).
Attribute Host Name is used only for information purposes.
6.1.4
vacon 23
Class Attributes
Id
Description
Data Type
01h
Revision
UINT
02h
Max Instance
UINT
03h
Number of
UINT
Instances
Class Services
Id
Service
01h
Get_Attributes_All
0Eh
Get_Attribute_Single
Instance Attributes
Id
Description
Data Type
01h
Interface Speed UDINT
02h
Interface Flags
DWORD
03h
Physical
ARRAY of
Address
6 USINTs
Instance Services
Id
Service
0Eh
Get_Attribute_Single
Access Rule
Get
Get
Get
Access Rule
Get
Get
Get
24 vacon
6.2
6.2.1
Class Attributes
Id
Description
Access Rule
NOT SUPPORTED
Class Services
Id
Service
NOT SUPPORTED
Instance Attributes
Id
Description
03h
Data
Data Type
ARRAY of
BYTE
Access Rule
Get / Set
Instance Services
Id
Service
0Eh
Get_Attribute_Single
10h
Set_Attribute_Single
6.2.2
Class Attributes
Id
Description
Class Services
Id
Access Rule
NOT SUPPORTED
Service
Requirements
NOT SUPPORTED
Instance Attributes
Id
Description
03h
06h
07h
09h
Motor Type
Rated Current
Rated Voltage
Rated
Frequency
Pole Count
Base Speed
Data
Type
USINT
UINT
UINT
UINT
0Ch
UINT
0Fh
UINT
Instance Services
Id
Service
0Eh
Get_Attribute_Single
10h
Set_Attribute_Single
Access
Rule
Get
Get / Set
Get / Set
Get / Set
Get
Get / Set
6.2.3
vacon 25
Class Attributes
Id
Description
Class Services
Id
Service
Access Rule
NOT SUPPORTED
Requirements
NOT SUPPORTED
Instance Attributes
Id
Description
Data Type
03h
Run1
BOOL
04h
Run2
BOOL
05h
NetCtrl *
BOOL
06h
State
USINT
07h
Running1
BOOL
08h
Running2
BOOL
09h
Ready
BOOL
0Ah
Faulted
BOOL
0Bh
Warning
BOOL
0Ch
FaultRst
BOOL
0Fh
CtrlFromNet** BOOL
Instance Services
Id
Service
0Eh
Get_Attribute_Single
10h
Set_Attribute_Single
05h
Reset
Access Rule
Get / Set
Get / Set
Get / Set
Get
Get
Get
Get
Get
Get
Get / Set
Get
* Network Control (When Bit is set to 1 and control place is fieldbus, the drive gets control from the network).
NOTE! Does not force the drive to fieldbus control.
** Indicates the status of NetCtrl.
Figure 6.
When both Run attributes (Run1 & Run2) are set, no action is taken.
26 vacon
6.2.4
Class Attributes
Id
Description
Access Rule
NOT SUPPORTED
Class Services
Id
Service
NOT SUPPORTED
Instance Attributes
Id
Description
03h
AtReference
04h
NetRef*
05h
NetProc**
06h
DriveMode
07h
SpeedActual
08h
SpeedRef
0Bh
TorqueActual
0Ch
TorqueRef
0Dh
ProcessActual
0Eh
ProcessRef
1Dh
RefFromNet***
Instance Services
Id
Service
0Eh
Get_Attribute_Single
10h
Set_Attribute_Single
Data Type
BOOL
BOOL
BOOL
USINT
INT
INT
INT
INT
INT
INT
BOOL
Access Rule
Get
Get / Set
Get / Set
Get / Set
Get
Get / Set
Get
Get / Set
Get
Get / Set
Get
* Network Reference (When Bit is 1 and control place is fieldbus, the drive gets reference from the network).
** Network Process (used to write process reference)
When Netproc = 1 & Drive mode = 0 (Vendor-specific), Process Reference is sent to the Drive
as Process Data 1
When Netproc = 1 & Drive mode = 4 (Process Control), Process Reference is sent to the Drive
as Process Data 2
When NetProc = 0, Process Reference must fail.
*** Indicates the status of NetRef.
6.3
Vendor-specific objects
6.3.1
vacon 27
Vendor Parameter Object is used to get access to the drive parameters. Because drive parameters
are identified by a 16-bit ID number, it is impossible to use only an Attribute ID, which is 8 bits in
length. To overcome this issue the following method is used to calculate the requested Drive
Parameter ID:
Class Attributes
Id
Description
Access Rule
NOT SUPPORTED
Class Services
Id
Service
NOT SUPPORTED
Instance Attributes
Id
Description
Access Rule
LOWER BYTE OF THE PARAMETER ID
Instance Services
Id
Service
0Eh
Get_Attribute_Single
10h
Set_Attribute_Single
6.3.2
Class Attributes
Id
Description
Access Rule
NOT SUPPORTED
Class Services
Id
Service
NOT SUPPORTED
Instance Attributes
Id
Description
Data Type
03h
InputInstance
USINT
04h
OutputInstance
USINT
Instance Services
Id
Service
0Eh
Get_Attribute_Single
10h
Set_Attribute_Single
Access Rule
Get / Set
Get / Set
28 vacon
7.
7.1
Output instances
Assembly instance 20
Table 19.
Instance 20 (Output)
Length = 4 Bytes
Byte
Bit 7
0
1
2
3
7.1.2
Bit 6
Bit 5
Bit 4
Bit 3
Bit 2
FaultReset
Bit 1
Bit 0
RunFwd
Bit 1
RunRev
Bit 0
RunFwd
Bit 1
RunRev
Bit 0
RunFwd
Instance 21 (Output)
Length = 4 Bytes
Byte
Bit 7
0
1
2
3
7.1.3
Bit 6
NetRef
Bit .5
NetCtrl
Bit 4
Bit 3
Bit 2
FaultReset
Assembly instance 23
Table 21.
Instance 23 (Output)
Length = 6 Bytes
Byte
Bit 7
0
1
2
3
4
5
Bit 6
NetRef
Bit .5
NetCtrl
Bit 4
Bit 3
Bit 2
FaultReset
vacon 29
Torque Reference is not sent to the drive if Motor Control Mode (Parameter ID 600) is set to values
other than:
2 Torque Control
Assembly instance 25
Table 22.
Instance 25 (Output)
Length = 6 Bytes
Byte
Bit 7
0
NetProc
1
2
3
4
5
Bit 6
NetRef
Bit .5
NetCtrl
Bit 4
Bit 3
Bit 2
FaultReset
Bit 1
RunRev
Bit 0
RunFwd
Drive Mode
Speed Reference (Low Byte), rpm
Speed Reference (High Byte, rpm
Process Reference (Low Byte)
Process Reference (High Byte)
4 (Process Control) Process Reference is sent to the drive as Process Data 2 (see Chapter
8.5.3).
Other drive modes are not supported. If they are used, the Process Reference is not handled.
7.1.5
Bit 6
NetRef
Bit .5
NetCtrl
Bit 4
Bit 3
Bit 2
FaultReset
Bit 1
RunRev
Bit 0
RunFwd
Process Data is sent to the drive independently of the NetRef bit and the NetCtrl bit settings.
30 vacon
7.1.6
Bit 6
Bit .5
Bit 4
Bit 3
Bit 2
FBFixedControlWord (Low Byte)
FBFixedControlWord (High Byte)
FBSpeedReference (Low Byte) *
FBSpeedReference (High Byte) *
ProcessDataIn1 (LowByte)
ProcessDataIn1 (HighByte)
ProcessDataIn2 (LowByte)
ProcessDataIn2 (HighByte)
ProcessDataIn3 (LowByte)
ProcessDataIn3 (HighByte)
ProcessDataIn4 (LowByte)
ProcessDataIn4 (HighByte)
ProcessDataIn5 (LowByte)
ProcessDataIn5 (HighByte)
ProcessDataIn6 (LowByte)
ProcessDataIn6 (HighByte)
ProcessDataIn7 (LowByte)
ProcessDataIn7 (HighByte)
ProcessDataIn8 (LowByte)
ProcessDataIn8 (HighByte)
Bit 1
Bit 0
* Reference 1 to the AC drive. Used normally as Speed reference. The allowed scaling is 0...10000. In the
application, the value is scaled in percentage of the frequency area between set minimum and maximum
frequency.
0 = 0.00 %, 10000 = 100.00 %
7.1.7
Instance 128
Length = 20 Bytes
Byte
Bit 7
0
1
2
3
4
5
6
7
8
9
10
Bit 6
Bit 5
Bit 4
Bit 3
Bit 2
FBFixedControlWord (Low Octet)
FBGeneralControlWord (High Octet)
FBSpeedReference (Low Octet) in %
FBSpeedReference (High Octet) in %
FBProcessDataIn1 (Low Octet)
FBProcessDataIn1 (High Octet)
FBProcessDataIn2 (Low Octet)
FBProcessDataIn2 (High Octet)
FBProcessDataIn3 (Low Octet)
FBProcessDataIn3 (High Octet)
FBProcessDataIn4 (Low Octet)
Bit 1
Bit 0
11
12
13
14
15
16
17
18
19
7.1.7.1
vacon 31
Control word
Table 26.
Bit
0
1
Start/Stop
Direction
Fault Reset
3
4
5
6
7
8
10
11
12
13
14
15
Request Fieldbus
Reference
Description
0
Stop request from fieldbus
Requested direction is
"FORWARD"
No action
Not in use
Not in use
Not in use
Not in use
Not in use
Control Place is as
parameterised in the drive
(unchanged)
Source of setpoint value shall be
as parameterised in the drive
(unchanged)
Not in use
Not in use
Not in use
Not in use
Not in use
Offline
1
Run request from fieldbus
Requested direction is
"REVERSE"
No action. Rising edge (0->1) =
Active faults, alarms and infos
are reset
Active
32 vacon
7.2
Input instances
7.2.1
Assembly instance 70
Table 27.
Instance 70 (Input)
Length = 4 Bytes
Byte
Bit 7
0
1
2
3
7.2.2
Bit 6
Bit .5
Bit 4
Bit 3
Bit 2
Running1
Bit 1
Bit 0
Faulted
Instance 71 (Input)
Length = 4 Bytes
Byte
Bit 7
Bit 6
Bit .5
Bit 4
Bit 3
0
AtReference RefFromNet CtrlFromNet
Ready
Running2
1
Drive State, see Chapter 7.2.6
2
Speed Actual (Low Byte), rpm
3
Speed Actual (High Byte), rpm
7.2.3
Bit 2
Running1
Bit 1
Warning
Bit 0
Faulted
Bit 1
Warning
Bit 0
Faulted
Assembly instance 73
Table 29.
Instance 73 (Input)
Length = 6 Bytes
Byte
Bit 7
Bit 6
Bit .5
Bit 4
Bit 3
Bit 2
0
AtReference RefFromNet CtrlFromNet
Ready
Running2 Running1
1
Drive State, see Chapter 7.2.6
2
Speed Actual (Low Byte), rpm
3
Speed Actual (High Byte), rpm
4
Torque Actual (Low Byte), Nm
5
Torque Actual (High Byte), Nm
7.2.4
vacon 33
Assembly instance 75
Table 30.
Instance 75 (Input)
Length = 6 Bytes
Byte
Bit 7
Bit 6
Bit .5
Bit 4
Bit 3
Bit 2
0
AtReference RefFromNet CtrlFromNet
Ready
Running2 Running1
1
Drive State, see Chapter 7.2.6
2
Speed Actual (Low Byte), rpm
3
Speed Actual (High Byte), rpm
4
Process Actual (Low Byte)
5
Process Actual (High Byte)
7.2.5
Bit 1
Warning
Bit 0
Faulted
Bit 1
Warning
Bit 0
Faulted
7.2.6
Drive state
0x00 DN_NON_EXISTANT
0x01 DN_STARTUP
0x02 DN_NOT_READY
0x03 DN_READY
0x04 DN_ENABLED
0x05 DN_STOPPING
0x06 DN_FAULT_STOP
0x07 DN_FAULTED
34 vacon
7.2.7
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
Bit 1
Bit 0
* The actual value from the AC drive. The value is between 0...10000. In the application, the value is scaled in
percentage of frequency area between set minimum and maximum frequency.
0 = 0.00 %, 10000 = 100.00 %
** The actual speed of the motor. The unit is RPM.
*** The actual speed of the motor with slip speed. The unit is RPM.
7.2.8
vacon 35
Instance 127
Length = 20 Bytes
Byte
Bit 7
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Bit 6
Bit 5
Bit 4
Bit 3
Bit 2
FBFixedStatusWord (Low Octet)
FBGeneralStatusWord (High Octet)
FBSpeedActual (Low Octet) in %
FBSpeedActual (High Octet) in %
FBProcessDataOut1 (Low Octet)
FBProcessDataOut1 (High Octet)
FBProcessDataOut2 (Low Octet)
FBProcessDataOut2 (High Octet)
FBProcessDataOut3 (Low Octet)
FBProcessDataOut3 (High Octet)
FBProcessDataOut4 (Low Octet)
FBProcessDataOut4 (High Octet)
FBProcessDataOut5 (Low Octet)
FBProcessDataOut5 (High Octet)
FBProcessDataOut6 (Low Octet)
FBProcessDataOut6 (High Octet)
FBProcessDataOut7 (Low Octet)
FBProcessDataOut7 (High Octet)
FBProcessDataOut8 (Low Octet)
FBProcessDataOut8 (High Octet)
Bit 1
Bit 0
36 vacon
Data mapping
8.
DATA MAPPING
8.1
Control word
Table 34.
Bit
0
1
2
3-15
8.2
STOP
RUN
Clockwise
Counterclockwise
Rising edge of this bit will reset active fault
Not in use
Status word
Table 35.
Bit
0
Ready status
1
2
Run/Stop status
Direction status
3
4
5
6
Fault status
Alarm status
Reference reached
Zero speed
7
8-15
8.3
Motor magnetisation
Not in use
0
Drive is not ready for
operation
Drive is stopped
Drive is running clockwise
No fault is active
No alarm is active
Reference is not reached
Motor is not running at zero
speed
Motor is not magnetised
1
Drive is ready for operation
Drive is running
Drive is running
counterclockwise
Drive is in fault state
An alarm is active
Reference is reached
Motor is running at zero speed
Motor is magnetised
The fieldbus master can read the actual values of the AC drive by using process data variables. The
applications Basic, Standard, Local/Remote, Multi-Step, PID control and Pump and fan control use
process data as follows:
Table 36.
Data
Process data OUT 1
Process data OUT 2
Process data OUT 3
Process data OUT 4
Process data OUT 5
Process data OUT 6
Process data OUT 7
Process data OUT 8
Value
Output Frequency
Motor Speed
Motor Current
Motor Torque
Motor Power
Motor Voltage
DC link voltage
Active Fault Code
Unit
Hz
rpm
A
%
%
V
V
-
Scale
0,01 Hz
1 rpm
0,1 A
0,1%
0,1%
0,1 V
1V
-
The Multipurpose application has a selector parameter for every Process Data. The monitoring
values and drive parameters are selected using the ID number (see NX All in One Application
Manual, Tables for monitoring values and parameters). Default selections are as in the table above.
Data mapping
8.4
vacon 37
ControlWord, Reference and Process Data are used with All-in One applications as explained in the
three following tables.
Table 37. Basic, Standard, Local/Remote, Multi-Step applications
Data
Reference
ControlWord
Value
Speed Reference
Start/Stop
Command
Fault reset
Command
Not used
PD1 PD8
Unit
%
-
Scale
0.01%
-
Data
Reference
ControlWord
Process Data IN1
Process Data IN2
Process Data IN3
PD3 PD8
Value
Speed Reference
Start/Stop Command
Fault reset Command
Torque Reference
Free Analogue INPUT
Adjust Input
Not Used
Unit
%
-
Scale
0.01%
-
%
%
%
-
0.1%
0.01%
0.01%
-
Table 39. PID control and Pump and fan control applications
Data
Reference
ControlWord
Value
Speed Reference
Start/Stop Command
Fault reset Command
Process Data IN1 Reference for PID
controller
Process Data IN2 Actual Value 1 to PID
controller
Process Data IN3 Actual Value 2 to PID
controller
PD4PD8
Not Used
Unit
%
-
Scale
0.01%
-
0.01%
0.01%
0.01%
38 vacon
Data mapping
8.5
Additional information
8.5.1
If NetCtrl bit is set, Output Instances Control Word is sent to the drive. Additionally, BusCtrl bit of
the FBFixedControlWord is set.
8.5.2
If NetRef bit is set, Torque Reference and Speed Reference are sent to the drive. Additionally,
BusRef bit of the FBFixedControlWord is set.
8.5.3
RefFromNet and CtrlFromNet bits are set if value of REMOTEIndication is more than 0, and NetRef
and NetCtrl bits are set. See Chapters 6.2.3 and 6.2.4.
If you need to contact Vacon service in problems related to EtherNet/IP, please send a description
of the problem together with the Drive Info File to tech.supportVDF@vacon.com.
Data mapping
vacon 39
Manual authoring:
documentation@vacon.com
Vacon Plc.
Runsorintie 7
65380 Vaasa
Finland
Subject to change without prior notice
2013 Vacon Plc.
Document ID:
Rev. B