TOEPYAIPFB01
TOEPYAIPFB01
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 LIBRARY CONTENTS.............................................................................................5
3 IMPORT THE LIBRARY INTO YOUR PROJECT....................................................7
4 ADD THE DRIVE TO YOUR HARDWARE CONFIGURATION.............................12
5 CONNECT THE DRIVE TO THE PROFINET NETWORK ....................................14
6 ADD THE YASKAWA FUNCTION BLOCK TO THE PROGRAM.........................17
7 LINK THE YASKAWA FUNCTION BLOCK TO THE APPLICABLE DRIVE........18
8 EXAMPLE BLOCK USAGE...................................................................................20
9 GATEWAY PROGRAM EXAMPLE........................................................................21
10 MONITOR DRIVE INFORMATION ........................................................................25
11 DETAILED BLOCK TABLES.................................................................................27
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-1200 and S7-1500 controllers. There are separate libraries for 4 different versions of TIA Portal:
V15_1, V16, V17 & V18.
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 Library Contents
2 Library Contents
This library contains 9 different function blocks. There are blocks for the SI-EP3 PROFINET Option card for and for the
JOHB-SMP3 Multi-Protocol Ethernet Option card. Some function blocks are only available for use on the JOHB-SMP3.
Drive Object Module (Telegram) Availability
Function Block Function Block Name Configured in PLC SI-EP3 JOHB-SMP3
Standard fbVFD_Yaskawa_Standard Std Tgm 1 Yes Yes
Standard + 5 fbVFD_Yaskawa_Standard + 5 PZD Std gm 1 + 5 PZD Yes Yes
Configurable
Standard + 10 fbVFD_Yaskawa_Standard + 10 PZD Std Tgm 1 + 10 PZD – Yes
Configurable
P-Drive fbVFD_Yaskawa_PROFIDrive Std Tgm 1 Yes Yes
P-Drive + 5 fbVFD_Yaskawa_PROFIDrive + 5 PZD Std Tgm 1 + 5 Yes Yes
Configurable
P-Drive + 10 fbVFD_Yaskawa_PROFIDrive + 10 PZD Std Tgm 1 + 10 – Yes
Configurable
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 5
2 Library Contents
• The control word for the master drive uses a simple Boolean Run Forward / Run Reverse interface (For example: Fwd Run,
Rev Run and Fault Reset). The status word (ZSW) is set up for PROFIDrive operation. (For example: Ready To Switch On,
Ready To Operate, and Fault.)
• The status word uses simple Boolean status signals (For example: Running, Ready, and Fault.)
• All slave drives use a simple Boolean Run Forward / Run Reverse interface.
• Includes 10 configurable registers (PZDs) for additional cyclic information exchange with the Master Drive (only).
• Set the Control/Status Configuration in the PLC parameters to 0: Yaskawa Specific
• The control word (STW) is set up for PROFIDrive operation. (For example: Ready To Operate, Emergency Off, and Inhibit
Operation.) The control word for the master drive uses a simple Boolean Run Forward / Run Reverse interface. (For example:
Fwd Run, Rev Run, and Fault Reset.) The status word (ZSW) is set up for PROFIDrive operation (For example: Ready To
Switch On, Ready To Operate, and Fault.)
• The status word (ZSW) is set up for PROFIDrive operation (For example: Ready To Switch On, Ready To Operate, and
Fault.)
• The frequency reference is bi-polar.
• All slave drives use a simple Boolean Run Forward / Run Reverse interface.
• Includes 10 configurable registers (PZDs) for additional cyclic information exchange with the Master Drive (only).
• Set the Control/Status Configuration in the PLC parameters to 1: Yaskawa P-Drive
6 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
3 Import the Library Into Your Project
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 7
3 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.
8 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
3 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 library folder, then expand Types, then S7-1200 / 1500.
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 9
3 Import the Library Into Your Project
8. There are several different function blocks that can be used depending upon the telegram you want to use in your
application:
Below shows how the function blocks are organized within TIA Portal:
10 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
3 Import the Library Into Your Project
9. 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.
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 11
4 Add the Drive to Your Hardware Configuration
5. Drag the existing network onto the green square on the JOHB-SMP3 (DP-NORM) icon 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.
12 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
4 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 tab. In most cases, this should align with
the function block that you added to the project in Step 9 on page 11.
8. Specify whether you are using a Standard Yaskawa telegram or the PROFIDrive 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 Standard” or “Yaskawa P-Drive” (PROFIDrive) in the drop-down list to complete adding the drive to
your hardware configuration.
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 13
5 Connect the Drive to the PROFINET Network
2. After the search is complete, click on the newly found drive and then select Online & diagnostics. If the option card
does not yet have a station name assigned, it will show up as "accessible device" followed by the [MAC address].
Note: Yaskawa PROFINET option cards will start with a MAC address of "00-20-B5"
14 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
5 Connect the Drive to the PROFINET Network
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 15
5 Connect the Drive to the PROFINET Network
4. Modify the hardware configuration to set the assigned IP address of the drive.
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.
16 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
6 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 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
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 17
7 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 JOHB-SMP3~Std_Tgm_1_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.
18 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
7 Link the Yaskawa Function Block to the Applicable Drive
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 19
8 Example Block Usage
20 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
9 Gateway Program Example
Some of the following steps are abbreviated; see the previous example in this document for details about where to find the
various menus and other information.
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 21
9 Gateway Program Example
2. Create logic to handle the Run commands for the master and 4 slave drives. In this example, the master and each of
the slave drives have their own Run and Stop push buttons on an HMI. There is also an interlock for each drive that
will remove the Run command if a particular drive has a fault.
22 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
9 Gateway Program Example
3. Create logic to scale the frequency references for the master and all four slave drives. In this example, the frequency
references come across from the HMI as a “real” values and are converted to the properly scaled “int” values used
by the Yaskawa function blocks.
4. From the Yaskawa Function Block Library, drag the Yaskawa > Types > S7-1200/1500 > JOHB-SMP3(only) >
fbVFD_Yaskawa_Gateway_Master function block into the project. This function block will control only the master
drive.
Set the hwlODriveTelegram to the value copied from the JOHB-SMP3 configuration (Device View > Gateway + 10
PZD_1 > System Constants).
Set the value of wInNumOfSlaves to the number of slave drives in the project. For this example, this is set to the
maximum value of 4.
Connect other signals as needed to the function block.
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 23
9 Gateway Program Example
5. From the Yaskawa library, drag 4 of the Yaskawa > Types > S7-1200/1500 > JOHB-SMP3(only) >
fbVFD_Yaskawa_Gateway_Slave function blocks into the project. These function blocks will control each of the slave
drives.
Set the hwlODriveTelegram to the SAME value as copied from the JOHB-SMP3 configuration (Device View >
Gateway + 10 PZD_1 > System Constants).
Set the value of wInSlaveNumber for each of the 4 slave drives.
Connect other signals as necessary.
24 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
10 Monitor Drive Information
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 25
10 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).
26 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
11 Detailed Block Tables
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
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
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 27
11 Detailed Block Tables
n fbVFD_Yaskawa_Standard + 10PZD
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
28 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
11 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
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 29
11 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
30 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
11 Detailed Block Tables
n fbVFD_Yaskawa_PROFIDrive + 10 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
iInCmdPZD6 Int PLC to Drive Parameter 6 Command Value
iInCmdPZD7 Int PLC to Drive Parameter 7 Command Value
iInCmdPZD8 Int PLC to Drive Parameter 8 Command Value
iInCmdPZD9 Int PLC to Drive Parameter 9 Command Value
iInCmdPZD10 Int PLC to Drive Parameter 10 Command Value
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 31
11 Detailed Block Tables
n fbVFD_Yaskawa_Gateway_Master
Input Variables Type Description
hwIODriveTelegram HW_IO Name of telegram begin used with Yaskawa drive
wInNumOfSlaves Int Number of slave drives connected to the master
wInFrequencyRef Word Setpoint frequency (0-6000)
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
iInCmdPZD1 Int PLC to Drive Parameter 1 Command Value
InCmdPZD2 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
iInCmdPZD6 Int PLC to Drive Parameter 6 Command Value
InCmdPZD7 Int PLC to Drive Parameter 7 Command Value
iInCmdPZD8 Int PLC to Drive Parameter 8 Command Value
iInCmdPZD9 Int PLC to Drive Parameter 9 Command Value
iInCmdPZD10 Int PLC to Drive Parameter 10 Command Value
32 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
11 Detailed Block Tables
n fbVFD_Yaskawa_Gateway_Slave
Input Variables Type Description
hwIODriveTelegram HW_IO Name of telegram begin used with Gateway Master drive
iInSlaveNumber Int Slave number (1 ~ 4)
wInFrequencyRef Int Setpoint frequency (0-6000)
bInForwardRun Bool Slave drive command forward run
bInReverseRun Bool Slave drive command reverse run
bInExternalFault Bool Slave drive command EF0 Drive Fault
bInFaultReset Bool Slave drive command fault reset
bInComRef Bool Force slave drive to use PROFINET frequency reference
bInComCtrl Bool Force slave drive to use PROFINET run/stop commands
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 33
11 Detailed Block Tables
n fbVFD_Yaskawa_Gateway_Master_P-Drive
Input Variables Type Description
iInFrequencySetPoint Int Setpoint frequency (-6000 - 6000)
hwIODriveTelegramHW_IO HW_IO Name of telegram being used with Yaskawa drive
bInOff1Bool Bool Proceed to ready operate
bInOff2 Bool Continue operation (OFF2 inactive)
bInOff3 Bool Continue operation (OFF3 inactive)
bInOperationEnable 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
InCmdPZD2 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
iInCmdPZD6 Int PLC to Drive Parameter 6 Command Value
InCmdPZD7 Int PLC to Drive Parameter 7 Command Value
iInCmdPZD8 Int PLC to Drive Parameter 8 Command Value
iInCmdPZD9 Int PLC to Drive Parameter 9 Command Value
iInCmdPZD10 Int PLC to Drive Parameter 10 Command Value
34 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
11 Detailed Block Tables
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 35
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
February 2023 <2> 2, 4, and 9 Updated to include the Multi-Protocol Ethernet Card (JOHB-SMP3).
September 2018 <1> – Typographical error corrections.
July 2018 – – First Release.
36 YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions
This Page Intentionally Blank
YASKAWA TOEPYAIPFB01 PROFINET Function Block For Use in TIA Portal User Instructions 37
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.