Yaskawa Drive: User Instructions
Yaskawa Drive: User Instructions
To properly use the product, read this manual thoroughly and retain
for easy reference, inspection, and maintenance. Ensure the end user
receives this manual.
2 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
PROFINET Function Block For Use in TIA
Portal
1 DOCUMENT OVERVIEW.........................................................................................4
2 IMPORT THE LIBRARY INTO YOUR PROJECT....................................................5
3 ADD THE DRIVE TO YOUR HARDWARE CONFIGURATION...............................9
4 CONNECT THE DRIVE TO THE PROFINET NETWORK ....................................11
5 ADD THE YASKAWA FUNCTION BLOCK TO THE PROGRAM.........................14
6 LINK THE YASKAWA FUNCTION BLOCK TO THE APPLICABLE DRIVE........15
7 EXAMPLE BLOCK USAGE...................................................................................18
8 MONITOR DRIVE INFORMATION ........................................................................19
9 DETAILED BLOCK TABLES.................................................................................21
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 3
1 Document Overview
1 Document Overview
This document shows the steps to successfully integrate Yaskawa drives into TIA Portal. Additionally, it shows the steps
required to quickly and easily integrate it into the PLC logic.
u Library Overview
The Yaskawa VFD PROFINET Library allows you to integrate Yaskawa drives controlled over PROFINET into TIA Portal
projects quickly and easily.
The library has function blocks that are designed to let you easily interface with the drive to decrease development time.
The library supports S7-300, S7-1200 and S7-1500 controllers. There are separate libraries for 5 different versions of TIA
Portal: V13 SP1, V14, V14 SP1 and V15.
Note: These instructions assume that you have already created a TIA Portal project and you have already added a PLC controller to the project.
4 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
2 Import the Library Into Your Project
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 5
2 Import the Library Into Your Project
4. After the file explorer opens, navigate to the location where you saved the downloaded library in Step 1.
Note: If you cannot find your library in this file explorer, make sure that library version you downloaded matches the version of TIA
Portal you are using.
5. After you select the archived library, the software will ask you where you want to save the uncompressed version of
the library. Select a destination and click OK.
6 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
2 Import the Library Into Your Project
6. Make sure that the library is shown in the Global libraries tab to confirm that you have successfully added the
library.
7. Expand the Yaskawa VFD PROFINet library folder, then expand Types, then Yaskawa VFD Library.
8. Depending on the PLC that your system is using, expand either the S7-300 or S7-1200/1500 folder.
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 7
2 Import the Library Into Your Project
9. There are four different block options depending on the telegram you want to use in your application. The four
supported telegrams are:
. Standard PROFIDrive telegram
. Standard PROFIDrive telegram + 5 PZD
. Standard Yaskawa telegram
. Standard Yaskawa telegram + 5 PZD
10.Depending on the telegram you want to use in your application, drag the appropriate block from your global libraries
to Program blocks in the left-hand side of Portal to import the library into your project.
8 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
3 Add the Drive to Your Hardware Configuration
5. Drag the existing network onto the green square in the lop-left corner of the drive to add the drive to the appropriate
PROFINET network.
Note: Make sure to assign your drive to the correct PLC as its IO controller. In the figure below, the drive is assigned to PLC_1, as
indicated by the blue text.
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 9
3 Add the Drive to Your Hardware Configuration
7. Navigate to your hardware catalog and expand Module > Drive Object. Select the telegram that you want to use for
your application, then drag it into the first blank row on the Device overview . In most cases, this should align with
the function block that you added to the project in Step 10 on page 8.
8. Specify whether you are using the Standard PROFIDrive telegram or the Standard Yaskawa telegram.
Click on the telegram that was just added in the Device overview window, then go to Properties > General > Module
Parameters and select either Yaskawa or Formerly PROFIDrive in the drop-down list to complete adding the drive
to your hardware configuration.
10 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
4 Connect the Drive to the PROFINET Network
2. After the search is complete, right-click on the newly found drive and select Online & diagnostics.
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 11
4 Connect the Drive to the PROFINET Network
. Expand Functions, then click on Assign name. In the box labeled PROFINET device name, set /
change the station name for the drive. Then click Assign name.
12 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
4 Connect the Drive to the PROFINET Network
4. Modify the hardware configuration to align the assigned IP address of the drive and PROFINET device name.
. In the Devices & networks window, click on the Network view tab [1], then click on the drive [2].
. Select the Properties tab [3], then select the General tab [4], then expand PROFINET interface
[X1], and select Ethernet addresses [5]. Make sure that the Set IP address in the project radio button
[6] is selected, and enter the IP address you assigned to the drive in Step 3.
. In the PROFINET area underneath the IP address, uncheck Generate PROFINET device name
automatically [7] and enter the PROFINET device name [8] you set in Step 3.
5. Recompile and download the updated hardware configuration to verify a successful connection. If successful, both
“NS” and “MS” LEDs on the drive will be lit.
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 13
5 Add the Yaskawa Function Block to the Program
2. After you drag the block into a rung, you will be prompted to declare the block as either single or multi-instance.
Consider your the existing architecture of your code before you make your selection.
When you declare the function block as single instance, it will create a global data block that will allow you to access
the inputs and outputs of the function block anywhere in the program.
When you declare the function block as multi-instance, it can improve the organization of your code when you use
many drives throughout the project.
3. Choose a name for the instance memory, considering existing naming conventions. If no naming conventions already
exist, consider the following:
. Example Single Instance Name: dbIns_Drive1
. Example Multi-Instance Name: #VFD_Drive1
14 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
6 Link the Yaskawa Function Block to the Applicable Drive
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 15
6 Link the Yaskawa Function Block to the Applicable Drive
2. After you add the Yaskawa function block into the project, there are two inputs that must align with the hardware
configuration to correctly communicate with the drive:
. iInInputIAddress
. iInOutputQAddress
These values must align with what is configured in Step 1.
16 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
6 Link the Yaskawa Function Block to the Applicable Drive
2. The TIA Portal automatically creates tags for all hardware identifier numbers. To locate the hardware identifier number
for a drive, navigate to Default Tag Table > System Constants. Here, there will be a tag of datatype Hw_SubModule
that will have the “Drive name” + “~” + “Telegram name”.
In our example it has the name is Drive1~Stnd_Telgram_1. Use CTRL + C to copy this entire tag name onto the
clipboard for use later. Make sure that this number matches the number in Step 1.
3. After you add the Yaskawa function block into your project, you must link the input hwIODriveTelgram to the tag located
in the previous step.
Use CTRL + V to paste the tag name from the clipboard and press ENTER. To confirm the tag is correct, ensure that
the green number above the tag matches the value in Step 1.
Note: The tag name needs to be in quotations to register as a tag and show the green number.
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 17
7 Example Block Usage
18 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
8 Monitor Drive Information
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 19
8 Monitor Drive Information
4. Click the monitor all icon (shown in the figure below with the glasses) to view the live values in the “Monitor value”
column.
5. To easily add all the instance data to the watch table, click the bottom-right corner of a single item and drag it toward
the bottom of the screen.
6. To modify the values (for example, wInFrequencyRef or bInForwardRun), enter the desired value in the Modify
value column. Click the Modify all selected values once and now button (the button with a lightning bolt with an “!”
next to it).
20 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
9 Detailed Block Tables
n fbVFD_Yaskawa_Standard + 5 PZD
Input Variables Type Description
iInFrequencySetPoint Int Setpoint frequency (0-6000)
iInInputIAddress Int Beginning of drive input I address space
iInOutputQAddress Int Beginning of drive output Q address space
bInForwardRun Bool Command forward run
bInReverseRun Bool Command reverse run
bInFaultReset Bool Command fault reset
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 21
9 Detailed Block Tables
n fbVFD_Yaskawa_PROFIDrive
Input Variables Type Description
iInFrequencySetPoint Int Setpoint frequency (-6000-6000)
iInInputIAddress Int Beginning of drive input I address space
iInOutputQAddress Int Beginning of drive output Q address space
bInOnOff1 Bool STW, Bit 0: Proceed to ready operate
bInOff2 Bool STW, Bit 1: Continue operation (OFF2 inactive)
bInOff3 Bool STW, Bit 2: Continue operation (OFF3 inactive)
bInRampOutZero Bool STW, Bit 3: Proceed to ENABLE OPERATION
bInRampOutZero Bool STW, Bit 4: Normal operation (Stop inactive)
22 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
9 Detailed Block Tables
n fbVFD_Yaskawa_PROFIDrive + 5 PZD
Input Variables Type Description
iInFrequencySetPoint Int Setpoint frequency (-6000-6000)
iInInputIAddress Int Beginning of drive input I address space
iInOutputQAddress Int Beginning of drive output Q address space
bInOnOff1 Bool Proceed to ready operate
bInOff2 Bool Continue operation (OFF2 inactive)
bInOff3 Bool Continue operation (OFF3 inactive)
bInRampOutZero Bool Proceed to ENABLE OPERATION
bInRampOutZero Bool Normal operation (Stop inactive)
bInRampHold Bool Normal operation (Force ramp function generator inactive)
bInRampInZero Bool Normal operation (Force ramp function generator inactive)
bInReset Bool Reset signal enable
bInRemoteCMD Bool Network control enabled
iInCmdPZD1 Int PLC to Drive Parameter 1 Command Value
iInCmdPZD2 i Int PLC to Drive Parameter 2 Command Value
InCmdPZD3 Int PLC to Drive Parameter 3 Command Value
iInCmdPZD4 Int PLC to Drive Parameter 4 Command Value
iInCmdPZD5 Int PLC to Drive Parameter 5 Command Value
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 23
9 Detailed Block Tables
u S7-1200/1500 Blocks
n fbVFD_Yaskawa_Standard
Input Variables Type Description
wInFrequencyRef Word Setpoint frequency (0-6000)
hwIODriveTelegram HW_IO Name of telegram begin used with Yaskawa drive
bInForwardRun Bool Command forward run
bInReverseRun Bool Command reverse run
bInFaultReset Bool Command fault reset
bInFaultEF0 Bool Command EF0 Drive Fault
bInDI1 Bool Command DI1
bInDI2 Bool Command DI2
bInDI3 Bool Command DI3
bInDI4 Bool Command DI4
bInDI5 Bool Command DI5
bInDI6 Bool Command DI6
bInDI7 Bool Command DI7
bInDI8 Bool Command DI8
bInDI9 Bool Command DI9
bInDI10 Bool Command DI10
bInDI11 Bool Command DI11
bInDI12 Bool Command DI12
n fbVFD_Yaskawa_Standard + 5 PZD
Input Variables Type Description
wInFrequencyRef Word Setpoint frequency (0-6000)
hwIODriveTelegram HW_IO Name of telegram begin used with Yaskawa drive
24 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
9 Detailed Block Tables
n fbVFD_Yaskawa_PROFIDrive
Input Variables Type Description
iInFrequencySetPoint Int Setpoint frequency (-6000-6000)
hwIODriveTelegram HW_IO Name of telegram begin used with Yaskawa drive
bInOnOff1 Bool Proceed to ready operate
bInOff2 Bool Continue operation (OFF2 inactive)
bInOff3 Bool Continue operation (OFF3 inactive)
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 25
9 Detailed Block Tables
n fbVFD_Yaskawa_PROFIDrive + 5 PZD
Input Variables Type Description
iInFrequencySetPoint Int Setpoint frequency (-6000-6000)
hwIODriveTelegram HW_IO Name of telegram begin used with Yaskawa drive
bInOnOff1 Bool STW, Bit 0: Proceed to ready operate
bInOff2 Bool STW, Bit 1: Continue operation (OFF2 inactive)
bInOff3 Bool STW, Bit 2: Continue operation (OFF3 inactive)
bInOperationEnable Bool STW, Bit 3: Proceed to ENABLE OPERATION
bInRampOutZero Bool STW, Bit 4: Normal operation (Stop inactive)
bInRampHold Bool STW, Bit 5: Normal operation (Force ramp function generator inactive)
bInRampInZero Bool STW, Bit 6: Normal operation (Force ramp function generator inactive)
bInReset Bool STW, Bit 7: Reset signal enable
bInRemoteCMD Bool STW, Bit 10: Network control enabled
iInCmdPZD1 Int PLC to Drive Parameter 1 Command Value
iInCmdPZD2 Int PLC to Drive Parameter 2 Command Value
iInCmdPZD3 Int PLC to Drive Parameter 3 Command Value
iInCmdPZD4 Int PLC to Drive Parameter 4 Command Value
iInCmdPZD5 Int PLC to Drive Parameter 5 Command Value
26 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
9 Detailed Block Tables
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 27
Revision History
The revision dates and the numbers of the revised manuals appear on the bottom of the back cover.
Revision
Date of Publication Section Revised Content
Number
September 2018 <1> – Typographical error corrections.
July 2018 – – First Release.
28 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
YASKAWA Drive
PROFINET Function Block for Use in TIA Portal
User Instructions
In the event that the end user of this product is to be the military and said product is to be
employed in any weapons systems or the manufacture thereof, the export will fall under the
relevant regulations as stipulated in the Foreign Exchange and Foreign Trade Regulations.
Therefore, be sure to follow all procedures and submit all relevant documentation according
YASKAWA AMERICA, INC. to any and all rules, regulations and laws that may apply.
Specifications are subject to change without notice for ongoing product modifications and
improvements.
© 2018 YASKAWA AMERICA, INC.