vacon nx

ac drives

ethernet ip option board

optcq

user manual

2 vacon

Introduction

INDEX

Document code: DPD00893A Last edited: 26.1.2012 Introduction ....................................................................................................................... 3 EtherNet/IP board technical data ...................................................................................... 4

1. 2. 2.1 2.2 2.3 2.4 3. 3.1 3.2 3.3 4. 5. 5.1 5.2 5.3 5.4 6. 6.1 6.2 6.3 7. 7.1 7.2 8. 8.1

Overview ....................................................................................................................................4 LED indications .........................................................................................................................5 EtherNet/IP ...............................................................................................................................5 Connections and Wiring ............................................................................................................7 Installation ......................................................................................................................... 8 Installing the EtherNet/IP Option Board in a Vacon NX Unit .................................................... 8 NCDrive ................................................................................................................................... 10 IP Tool NCIPConfig .................................................................................................................. 10 Commissioning ................................................................................................................ 14 EtherNet/IP ...................................................................................................................... 16 Overview .................................................................................................................................. 16 AC/DC Drive Profile ................................................................................................................. 17 EDS file .................................................................................................................................... 17 Explicit Messaging .................................................................................................................. 17 Common Industrial Objects Implemented by the Option Board ....................................... 20 CIP Common Required Objects............................................................................................... 20 Objects Present in an AC/DC Drive ......................................................................................... 24 Vendor Specific Objects........................................................................................................... 27 Assembly Instances Implemented by the Option Board ................................................... 28 Output Instances ..................................................................................................................... 28 Input Instances ........................................................................................................................ 31 Appendix .......................................................................................................................... 35 Additional Information ............................................................................................................ 37

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

Introduction

vacon 3

1.

INTRODUCTION

Vacon NX frequency converters can be connected to Ethernet using an EtherNet/IP fieldbus board OPT-CQ. The OPT-CQ can be installed in the card slots 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 can be 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 Section 3, Installation.

Internal components and circuit boards are at high potential when the frequency converter is connected to the power source. This voltage is extremely dangerous and may cause death or severe injury if you come into contact with it.
WARNING!

If you need further information related to EtherNet/IP, please contact fieldbus@vacon.com.

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

4 vacon

installation

2. 2.1

ETHERNET/IP BOARD TECHNICAL DATA Overview General Ethernet connections Communications Card Name Interface Transfer cable Speed Duplex Default IP-address EtherNet/IP Ambient operating temperature Storing temperature Humidity Altitude Vibration OPT-CQ RJ-45 connector Shielded Twisted Pair 10 / 100 Mb half / full 192.168.0.10 10C50C 40C70C <95%, no condensation allowed Max. 1000 m 0.5 G at 9200 Hz Fulfils EN50178 standard

Protocols Environment

Safety Table 1. EtherNet/IP board technical data

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

EtherNet/IP board technical data

vacon 5

2.2

LED indications

LED: H4 H1 H2

Meaning: LED is ON when board is powered Blinking 0,25s ON / 0,25s OFF when board firmware is corrupted (chapter 3.2.1 NOTE). 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.

2.3

EtherNet/IP EtherNet/IP was introduced in 2001 and today is the most developed, proven and complete industrial Ethernet network solution available for manufacturing automation. 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 the pictures below.

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

6 vacon

installation

1. Human to machine (Graphical User interface, relatively slow communication)

NCDrive / NCIPConfig interface -Parameter -Slow rate actual Values -Trends -Fault history

Ethernet switch

Note! NCDrive can be used in NXS and NXP drives via Ethernet. In NXL drives this is not possible.

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

EtherNet/IP board technical data

vacon 7

2. Machine to machine (Industrial environment, fast communication)

PLC or Programmable Controller

Master Real -Time Control Direction,... .. -Start/Stop, Direction, -Reference -Feedback Ethernet switch

2.4

Connections and Wiring The EtherNet/IP board supports 10/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 socalled 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. More information on Ethernet can be found at www.odva.org.

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

8 vacon

installation

3. 3.1

INSTALLATION Installing the EtherNet/IP Option Board in a Vacon NX Unit

!
NOTE

MAKE SURE THAT THE FREQUENCY CONVERTER IS SWITCHED OFF BEFORE AN OPTION OR FIELDBUS BOARD IS CHANGED OR ADDED! Vacon NX frequency converter.

Remove the cable cover.

Open the cover of the control unit.

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

Installation

vacon 9

Install EtherNet/IP option board in slot D or E on the control board of the frequency converter. Make sure that the grounding plate (see below) fits tightly in the clamp.

Make a sufficiently wide opening for your cable by cutting the grid as wide as necessary.

Close the cover of the control unit and the cable cover.

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

10 vacon

installation

3.2

NCDrive

NCDrive software can be used with the Ethernet board in NXS and NXP drives. NOTE! Does not work with NXL NCDrive software is recommended to be used in LAN (Local Area Network) only. NOTE! If OPT-CI Ethernet Option board is used for NC Tools connection, like NCDrive, the OPT-D3 board can not be used. NOTE! NCLoad does not work via Ethernet. See NCDrive help for further information. 3.3 IP Tool NCIPConfig

To begin using the Vacon EtherNet board, you need to set an IP address. The factory default IP address is 192.168.0.10. Before connecting the board to the network, its IP addresses must be set according to the network. For more information about IP addresses, contact your network administrator. 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 www.vacon.com website. After starting the installation program, follow the onscreen instructions. Once the program is installed successfully, you can 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. Step 1. Connect your PC to the Ethernet network with an Ethernet cable. You can also connect the PC directly to the device using a crossover cable. This option may be needed if your PC does not support Automatic crossover function. Step 2. Scan 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. NOTE! Some switches block broadcast messages. In this case, each network node must be scanned separately. Read the manual under Help menu!

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

Installation

vacon 11

Step 3. Set IP adresses. Change the nodes IP settings according to the network IP settings. The program will report conflicts with a red color in a table cell. Read the manual under Help menu!

Step 4. Send configuration to boards. In the table view, check the boxes for boards whose configuration you want to send and select Configuration, then Configure. Your changes are sent to the network and will be valid immediately. NOTE! Only A-Z, a-z and 0 -9 symbols can be used in the drive name, no special characters, or Scandinavian letters (, , etc.)! The drive name can be freely formed using the allowed characters.

3.3.1

Update OPT-CQ 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. NOTE! 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 section 7. Once you can see all nodes in the view, you can update the new firmware by clicking the VCN packet field in NCIPCONFIG 's table view on the right.

Click

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

12 vacon

installation

After clicking the VCN packet field, a file open window where you can choose a new firmware packet is displayed.

Send the new firmware packet to the option board by checking its box in the 'VCN Packet' field at the right corner of the table view. After selecting all nodes to be updated by checking the boxes, send the new firmware to the board by selecting 'Software' then 'Download'.

NOTE! Do not do a power up cycle within 1 minute after downloading the option board software. This may 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 may also appear due to a faulty board, a temporary malfunction of the board or disturbance in the environment.

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

vacon 13

3.4

Configure Option board parameters

These features are available from NCIPConfig tool version 1.6. In the tree-view, expand the folders until you reach the board parameters. Slowly double-click the parameter (Comm. Time-out in figure below) and enter new value. New parameter values are automatically sent to the option board after the modification is complete.

NOTE! If the fieldbus cable is broken at the Ethernet board end or removed, a fieldbus error is immediately generated.

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

14 vacon

4.

COMMISSIONING The Vacon EtherNet/IP board is commissioned with the control keypad by giving values to appropriate parameters in menu M7 (or with NCIPConfig tool, read chapter IP Tool NCIPConfig). Keypad commissioning is only possible with NXP- and NXS-type frequency converters, NXL frequency converters require NCIPConfig tool. Expander board menu (M7) The Expander board menu makes it possible for the user to see what expander boards are connected to the control board and to reach and edit the parameters associated with the expander board. Enter the following menu level (G#) with the Menu button right. At this level, you can browse trough slots A to E with the Browser buttons to see what expander boards are connected. On the lowermost line of the display you see the number of parameter groups associated with the board. If you still press the Menu button right once you will reach the parameter group level where there are one group in the EtherNet/IP board case: Parameters. A further press on the Menu button right takes you to Parameter group.

EtherNet/IP parameters
# 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 Name Default Range Comm. Timeout 10 s 0255 s IP Part 1 192 1223 IP Part 2 168 0255 IP Part 3 0 0255 IP Part 4 10 0255 SubNet Part 1 255 0255 SubNet Part 2 255 0255 SubNet Part 3 0 0255 SubNet Part 4 0 0255 DefGW Part 1 192 0255 DefGW Part 2 168 0255 DefGW Part 3 0 0255 DefGW Part 4 1 0255 InputAssembly 71 0255 OutputAssembly 21 0255 Table 2. EtherNet/IP parameters Description 0 = Not used 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 Ch. 7 See Ch. 7

IP Address IP is divided to 4 parts. (Part = Octet) Default IP Address is 192.168.0.10. Defines how much time can pass from the last received message from the Client Device before fieldbus fault is generated. Communication time out is disabled when given the value 0. Communication timeout value can be changed from the keypad or with NCIPConfig tool (read chapter IP Tool NCIPConfig).

Communication timeout

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

appendix

vacon 15

NOTE! If fieldbus cable is broken from EtherNet/IP board end, fieldbus error is generated immediately. All EtherNet/IP parameters are saved to the EtherNet/IP board (not to the control board). If new EtherNet/IP board is changed to control board you must configure the new EtherNet/IP board. Option board parameters are possible to save to the keypad, with NCIPConfig tool or with NCDrive.

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

16 vacon

Commissioning

5. 5.1

ETHERNET/IP Overview EtherNet/IP (Ethernet/Industrial Protocol) is a communication system suitable for use in industrial environments. EtherNet/IP allows industrial devices to exchange time-critical application information. These devices include simple I/O devices such as sensors/actuators, as well as complex control devices such as robots, programmable logic controllers, welders, and process controllers. EtherNet/IP uses CIP (Control and Information Protocol), the common network, transport and application layers also shared by ControlNet and EtherNet/IP. EtherNet/IP then makes use of standard Ethernet and TCP/IP technology to transport CIP communications packets. The result is a common, open application layer on top of open and highly popular Ethernet and TCP/IP protocols. EtherNet/IP Messaging Forms: Unconnected Messaging is used for connection establishment and for unfrequent, low-priority messages. Connected Messaging utilizes resources which are dedicated in advance to a particular purpose such as real-time I/O data transfer. EtherNet/IP Messaging Connections: Explicit Messaging Connections are general purpose point-to-point connections. Messages are send through TCP protocol. Implicit (I/O Data) Connections are established to move application specific I/O Data at regular intervals. They are often setup as one-to-many relationships in order to take full advantage of the producer-consumer multicast model. Implicit messages are send through UDP protocol.

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

appendix

vacon 17

5.2

AC/DC Drive Profile In order to provide interoperability between devices from different manufacturers, there must be defined standard in which those devices: exhibit the same behavior produce and/or consume the same basic set of I/O data contain the same basic set of configurable attributes The formal definition of this information is known as a device profile.

5.3

EDS file EDS - The abbreviation for Electronic Data Sheet, a file on disk that contains configuration data for specific device types. You can provide configuration support for your device by using a specially formatted ASCII file, referred to as the Electronic Data Sheet (EDS). An EDS provides information about the device configuration datas: context content format The information in an EDS allows configuration tools to provide informative screens that guide a user through the steps necessary to configure a device. An 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.

5.4

Explicit Messaging Explicit Messaging is used in commissioning and parametrizing 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 then Explicit Messages cannot be used to control Output Data. However this restriction doesnt apply for IO Data reading.

5.4.1
Class 0x01 0x04 0x06 0x28 0x29 0x2A 0xA0 0xBE 0xF5 0xF6

List of Object Classes

The Communication Interface supports the following object classes:
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

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

18 vacon

Commissioning

5.4.2

List of services
Service Code (in hex) Service Name Connection manager Control Supervisor Vendor parameter Class Inst Inst Y Y Assemly instance selector Class Inst Y Y TCP/IP interface Identity object Ethernet link AC/DC Drive Y Y Y Class Inst Y Y

The Services supported by these object classes are shown below

Class

Class

Class

Class

Class

Class

Motor Data Inst Y Y Inst Y Y

Assembly

01 05 0E 10 4E 52 54

Get_Attributes_All Reset (Type 0) Get_Attribute_Single Set_Attribute_Single Forward Close Unconnected_Send Forward_Open

Y Y Y

Y Y

Y Y Y Y Y

Y Y

Y Y Y

Y Y Y

See Ch. 6 for the Interface Object profiles.

5.4.3

List of data types

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.

Elementary Data Types

Data Type Name BOOL SINT INT USINT UINT UDINT BYTE WORD SHORT_STRING Data Type Code (in hex) C1 C2 C3 C6 C7 C8 D1 D2 DA Data Type Description Logical Boolean with values TRUE and FALSE Signed 8bit integer value Signed 16bit integer value Unsigned 8bit integer value Unsigned 16bit integer value Unsigned 32bit integer value bit string 8bits bit string 16bits character sting (1 byte per character, 1 byte length indicator)

Constructed Data Types

Type Code A1 A2 Description Abbreviated array type encoding Formal structure type encoding

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

Class

Inst

Inst

Inst

Inst

appendix

vacon 19

5.4.4

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 will set ALL attributes to their default values and change the response of the drive to a loss of communications with the OPTCQ. The device will have to be re-configured for your application before resuming normal operation.
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.

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

20 vacon

Common Industrial Objects Implemented by the Option Board

6. 6.1

COMMON INDUSTRIAL OBJECTS IMPLEMENTED BY THE OPTION BOARD CIP Common Required Objects

6.1.1

Identity Object, Class 0x01

Access Rule Get Get

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 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

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

appendix

vacon 21

6.1.2

Connection Manager Object, Class 0x06

Data Type Access Rule Get Get

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 Open Requests 02h Open Format Rejects 03h 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 UINT UINT UINT UINT UINT UINT UINT UINT

Access Rule Get Get Get Get Get Get Get Get

RPI = Requested Packet Intervall, minimum time is 16ms

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

22 vacon

Common Industrial Objects Implemented by the Option Board

6.1.3

TCP/IP Interface Object, Class 0xF5

Data Type UINT Access Rule Get Get

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 DWORD DWORD DWORD STRUCT of: UINT Padded EPATH STRUCT of: UDINT UDINT UDINT UDINT UDINT STRING STRING

Access Rule Get Get Get / Set Get

Get / Set

Get / Set

Attribute Configuration Control supports only value 0 (device is using configuration values which are stored in non-volatile memory). Attribute Host Name is used just for information purpose.

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

appendix

vacon 23

6.1.4

Ethernet Link Object, Class 0xF6

Access Rule Get Get Get

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

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

24 vacon

Common Industrial Objects Implemented by the Option Board

6.2

Objects Present in an AC/DC Drive

6.2.1

Assembly Object, Class 0x04

Access Rule NOT SUPPORTED

Class Attributes Id Description 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

Motor Data Object, Class 0x28

Access Rule NOT SUPPORTED Requirements NOT SUPPORTED Data Type USINT UINT UINT UINT Access Rule Get Get / Set Get / Set Get / Set Get Get / Set

Class Attributes Id Description Class Services Id Service Instance Attributes Id Description 03h 06h 07h 09h

Motor Type Rated Current Rated Voltage Rated Frequency 0Ch Pole Count UINT 0Fh Base Speed UINT Instance Services Id Service 0Eh Get_Attribute_Single 10h Set_Attribute_Single

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

appendix

vacon 25

6.2.3

Control Supervisor Object, Class 0x29

Access Rule NOT SUPPORTED Requirements NOT SUPPORTED Access Rule Get / Set Get / Set Get / Set Get Get Get Get Get Get Get / Set Get

Class Attributes Id Description Class Services Id Service

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

* NetCtrl -> Network Control (When Bit is set to 1 and control place is fieldbus then Drive gets control from network) NOTE! Does not force the drive to fieldbus control. ** Indicates the status of NetCtrl

When both Run (Run1 & Run2) attributes set than no action.

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

26 vacon

Common Industrial Objects Implemented by the Option Board

6.2.4

AC/DC Drive Object, Class 0x2A

Access Rule NOT SUPPORTED

Class Attributes Id Description 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

* NetRef -> Network Reference (When Bit is 1 and control place is fieldbus then Drive gets reference from network). ** NetProc -> Network Process (is used to write process reference) When Netproc = 1 & Drive mode = 0 (Vendor Specific) Process Reference is send to the Drive as Process Data 1 When Netproc = 1 & Drive mode = 4 (Process Control) Process Reference is send to the Drive as Process Data 2 When NetProc = 0, then Process Reference must fail. *** Indicates the status of NetRef.

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

appendix

vacon 27

6.3

Vendor Specific Objects

6.3.1

Vendor Parameters Object, Class 0xA0

Vendor Parameter Object is used in order to get access to Drive Parameters. Because Drive Parameters are identified by the 16bit length ID number, therefore it is impossible to use only Attribute IDwhich is 8bit in length. To overcome this issue we are using the following method to calculate requested Drive Parameter ID:

Drive Parameter ID = Instance ID (Higher Byte) + Attribute ID (Lower Byte)

Class Attributes Id Description 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

Access Rule NOT SUPPORTED

6.3.2

Assembly Instance Selector Object, Class 0xBE

Access Rule NOT SUPPORTED

Class Attributes Id Description Class Services Id Service

NOT SUPPORTED Instance Attributes Id Description Data Type Access Rule 03h OutputInstanc USINT Get / Set e 04h InputInstance USINT Get / Set Instance Services Id Service 0Eh Get_Attribute_Single 10h Set_Attribute_Single

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

28 vacon

Assembly Instances Implemented by the Option Board

7. 7.1

ASSEMBLY INSTANCES IMPLEMENTED BY THE OPTION BOARD Output Instances

Assemblys 20-25 ODVA AC/DC Profile Assemblys 71-75 ODVA AC/DC Profile Assemblys 100-> Vacon Profile

7.1.1

Assembly Instance 20
Bit 6 Bit .5 Bit 4 Bit 3 Bit 2 FaultReset Speed Reference (Low Byte), rpm Speed Reference (High Byte), rpm Bit 1 Bit 0 RunFwd

Instance 20 (Output) Length = 4 Bytes Byte Bit 7 0 1 2 3

7.1.2

Assembly Instance 21 (default)

Bit 6 NetRef Bit .5 NetCtrl Bit 4 Bit 3 Bit 2 FaultReset Bit 1 RunRev Bit 0 RunFwd

Instance 21 (Output) Length = 4 Bytes Byte Bit 7 0 1 2 3

Speed Reference (Low Byte), rpm Speed Reference (High Byte), rpm

7.1.3

Assembly Instance 23
Bit 6 NetRef Bit .5 NetCtrl Bit 4 Bit 3 Bit 2 FaultReset Bit 1 RunRev Bit 0 RunFwd

Instance 23 (Output) Length = 6 Bytes Byte Bit 7 0 1 2 3 4 5

Speed Reference (Low Byte), rpm Speed Reference (High Byte), rpm Torque Reference (Low Byte), Nm Torque Reference (High Byte), Nm

Torque Reference is not send to the Drive if Motor Control Mode (Parameter ID 600) is set to values others than: 2 Torque Control 4 Closed Loop Torque Control

Torque Reference is send to the Drive as a Process Data 1. Note! Torque reference is not functional in NXL.

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

appendix

vacon 29

7.1.4

Assembly Instance 25
Bit 6 NetRef Bit .5 NetCtrl Drive Mode Speed Reference (Low Byte), rpm Speed Reference (High Byte, rpm Process Reference (Low Byte) Process Reference (High Byte) Bit 4 Bit 3 Bit 2 FaultReset Bit 1 RunRev Bit 0 RunFwd

Instance 25 (Output) Length = 6 Bytes Byte Bit 7 0 1 2 3 4 5 NetProc

We are supporting following Drive Modes: 0 (Vendor Specific) Process Reference is send to the Drive as Process Data 1 4 (Process Control) Process Reference is send to the Drive as Process Data 2 (see ch. 8.1.3)

Others Drive Modes are not supported and in case if used then Process Reference is not handled.

7.1.5

Assembly Instance 101

Instance 101 (Output) Length = 8 Bytes Byte Bit 7 0 1 2 3 4 5 6 7

Bit 6 NetRef

Bit .5 NetCtrl

Bit 4

Bit 3

Bit 2 FaultReset

Bit 1 RunRev

Bit 0 RunFwd

FBSpeed Reference (Low Byte), % FBSpeed Reference (High Byte), % FBProcessDataIn1(Low Byte) FBProcessDataIn1(High Byte) FBProcessDataIn2(Low Byte) FBProcessDataIn2(High Byte)

Process Data is send to the Drive independently from the NetRef and NetCtrl bits settings.

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

30 vacon

Assembly Instances Implemented by the Option Board

7.1.6

Assembly Instance 111

Instance 111 (Output) 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

Bit 1

Bit 0

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)

* This is the reference 1 to the frequency converter. 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 %
Control word

Bit 0 1 2 3 - 15

Description Value = 0 Value = 1 STOP RUN Clockwise Counter-clockwise Rising edge of this bit will reset active fault Not in use

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

appendix

vacon 31

7.2

Input Instances

7.2.1

Assembly Instance 70
Bit 7 Bit 6 Bit .5 Bit 4 Bit 3 Bit 2 Running1 Speed Actual (Low Byte), rpm Speed Actual (High Byte), rpm Bit 1 Bit 0 Faulted

Instance 70 (Input) Length = 4 Bytes Byte 0 1 2 3

7.2.2

Assembly Instance 71 (default)

Instance 71 (Input) Length = 4 Bytes Byte Bit 7 0 1 2 3

Bit 6

Bit .5

Bit 4 Ready

Bit 3 Running2

Bit 2 Running1

Bit 1 Warning

Bit 0 Faulted

AtReference RefFromNet CtrlFromNet

Drive State, see ch. 7.2.6 Speed Actual (Low Byte), rpm Speed Actual (High Byte), rpm

7.2.3

Assembly Instance 73

Instance 73 (Input) Length = 6 Bytes Byte Bit 7 0 1 2 3 4 5

Bit 6

Bit .5

Bit 4 Ready

Bit 3 Running2

Bit 2 Running1

Bit 1 Warning

Bit 0 Faulted

AtReference RefFromNet CtrlFromNet

Drive State, see ch. 7.2.6 Speed Actual (Low Byte), rpm Speed Actual (High Byte), rpm Torque Actual (Low Byte), Nm Torque Actual (High Byte), Nm

Note! Torque reference is not functional in NXL.

7.2.4

Assembly Instance 75

Instance 75 (Input) Length = 6 Bytes Byte Bit 7 0 1 2 3 4 5

Bit 6

Bit .5

Bit 4 Ready

Bit 3 Running2

Bit 2 Running1

Bit 1 Warning

Bit 0 Faulted

AtReference RefFromNet CtrlFromNet

Drive State, see ch. 7.2.6 Speed Actual (Low Byte), rpm Speed Actual (High Byte), rpm Process Actual (Low Byte) Process Actual (High Byte)

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

32 vacon

Assembly Instances Implemented by the Option Board

7.2.5

Assembly Instance 107

Instance 107 (Input) Length = 8 Bytes Byte Bit 7 0 1 2 3 4 5 6 7

Bit 6

Bit .5

Bit 4 Ready

Bit 3 Running2

Bit 2 Running1

Bit 1 Warning

Bit 0 Faulted

AtReference RefFromNet CtrlFromNet

Drive State, see ch. 7.2.6 % Speed Actual (Low Byte) * % Speed Actual (High Byte) * Process DataOut1 (Low Byte) Process DataOut1 (High Byte) Process DataOut2 (Low Byte) Process DataOut2 (High Byte)

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

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

appendix

vacon 33

7.2.7

Assembly Instance 117

Instance 117 (Input): EIP Drive Status Length = 34 bytes Byte Bit 7 Bit 6 0 1 2 3 4 5 6 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 .5

Bit 4

Bit 3

Bit 2

Bit 1

Bit 0

FBStatusWord (Low Byte) FBStatusWord (High Byte) % Speed Actual (Low Byte) * % Speed Actual (High Byte) * RPM Speed Actual (Low Byte) ** RPM Speed Actual (High Byte) ** RPM with Slip Speed Actual (Low Byte)***. RPM with Slip Speed Actual (High Byte) *** Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved ProcessDataOut1 (LowByte) ProcessDataOut1 (HighByte) ProcessDataOut2 (LowByte) ProcessDataOut2 (HighByte) ProcessDataOut3 (LowByte) ProcessDataOut3 (HighByte) ProcessDataOut4 (LowByte) ProcessDataOut4 (HighByte) ProcessDataOut5 (LowByte) ProcessDataOut5 (HighByte) ProcessDataOut6 (LowByte) ProcessDataOut6 (HighByte) ProcessDataOut7 (LowByte) ProcessDataOut7 (HighByte) ProcessDataOut8 (LowByte) ProcessDataOut8 (HighByte)

* This is the actual value from the frequency converter. 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 RPM Speed Actual is the actual speed of the motor. The unit is RPM *** The RPM with Slip Speed Actual is the actual speed of the motor with slip speed. The unit is RPM

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

34 vacon

Assembly Instances Implemented by the Option Board

Status word

Bit 0 1 2 3 4 5 6 7 8-15

Description Value = 0 Not ready Stop Clockwise No fault No alarm Ref. Freq. not reached Motor not running at zero speed Flux ready Not in use

Value = 1 Ready Run Counter-clockwise Faulted Alarm Ref. Freq. reached Motor running at zero speed Flux not ready

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

appendix

vacon 35

8.

APPENDIX

Process Data OUT (Slave Master)

The fieldbus master can read the frequency converters actual values using process data variables. Basic, Standard, Local/Remote, Multi-Step, PID control and Pump and fan control applications use process data as follows:

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 can be 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. Process Data IN (Master - > Slave) ControlWord, Reference and Process Data are used with All-in One applications as follows:

Basic, Standard, Local/Remote, Multi-Step applications

Data Reference ControlWord Value Speed Reference Start/Stop Command Fault reset Command Not used Unit % Scale 0.01% -

PD1 PD8

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

36 vacon

Appendix

Multipurpose control application

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% -

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% -

Tel. +358 (0)201 2121 Fax +358 (0)201 212 205

appendix

vacon 37

8.1

Additional Information

8.1.1

Handling of the NetCtrl bit (Network Control)

If NetCtrl bit is set then Output Instances Control Word is send to the Drive. Additionally BusCtrl bit of the FBFixedControlWord is set.

8.1.2

Handling of the NetRef bit (Network Reference)

If NetRef bit is set then Torque Reference and Speed Reference are send to the Drive. Additionally BusRef bit of the FBFixedControlWord is set.

8.1.3 8.1.4

Handling of the NetProc bit in Assembly Instance 25 (Net Process) Handling of RefFromNet and CtrlFromNet bits

If NetProc bit is set then Process Reference is send to the Drive.

RefFromNet and CtrlFromNet bits are set if value of REMOTEIndication is more than 0. See further information in 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 fieldbus@vacon.com.

24-hour support +358 (0)40 837 1150 Email: vacon@vacon.com

License for LWIP Copyright (c) 2001, 2002 Swedish Institute of Computer Science. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Find your nearest Vacon office on the Internet at: www.vacon.com

Manual authoring: documentation@vacon.com Vacon Plc. Runsorintie 7 65380 Vaasa Finland Subject to change without prior notice 2012 Vacon Plc. Document ID:

Rev. A