Yaskawa MP Ethernet Manual
Yaskawa MP Ethernet Manual
Table of Contents
Table of Contents 2
Yaskawa MP Series Ethernet Driver Help 4
Overview 4
Device Setup 5
Memory Mapping for MPxxxxiec Devices 6
Communications Parameters 7
Block Sizes 8
Hardware Configuration for MPxxxx (218IF Module) 9
Hardware Configuration for MPxxxxiec 15
Hardware Configuration for MPxxxx (218IF Module) - Ladders 20
Optimizing Yaskawa MP Series Ethernet Communications 29
Data Types Description 30
Address Descriptions for MPxxxx (218IF Module) Devices 31
Address Descriptions for MPxxxxiec Devices 32
Error Descriptions 34
Address Validation 34
Address '<address>' is out of range for the specified device or register 34
Array size is out of range for address '<address>' 35
Array support is not available for the specified address: '<address>' 35
Data Type '<type>' is not valid for device address '<address>' 35
Device address '<address>' contains a syntax error 35
Device address '<address>' is not supported by model '<model name>' 35
Device address '<address>' is Read Only 36
Missing address 36
Device Status Messages 36
Device '<device name>' is not responding 36
Unable to write to '<address>' on device '<device name>' 36
Device Specific Messages 36
Device '<device name>' block request [<start address> to <end address>] responded with exception
'<exception response>' 37
Failure to start Winsock communications 37
Illegal data address for tag '<tag address>' on device '<device name>' 37
Illegal data address in block [<start address> to <end address>] on device '<device name>' 38
Illegal data value for tag '<tag address>' on device '<device name>' 38
Illegal data value in block [<start address> to <end address>] on device '<device name>' 38
Illegal function code '<function code (hex)>' in block [<start address> to <end address>] on device
'<device name>' 38
Illegal function code '<hex function code>' for tag '<tag address>' on device '<device name>' 39
Slave device '<device name>' detected a memory parity error 39
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 3
www. kepware.com
4 Yaskawa MP Series Ethernet Driver Help
CONTENTS
Overview
What is the Yaskawa MP Series Ethernet Driver?
Device Setup
How do I configure a device for use with this driver?
Address Descriptions
How do I reference a data location in a Yaskawa MP Series Ethernet device?
Error Descriptions
What error messages does the Yaskawa MP Series Ethernet Driver produce?
Overview
The Yaskawa MP Series Ethernet Driver provides an easy and reliable way to connect Yaskawa MP Series Ethernet
devices to OPC Client applications, including HMI, SCADA, Historian, MES, ERP and countless custom appli-
cations. It is intended for any MPxxxx Series controller that uses the 218IF module or any MPxxxxiec Series con-
troller that communicates via Modbus TCP.
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 5
Device Setup
Supported Devices
MPxxxx (218IF Module). This includes any controller that uses the 218IF module.
MPxxxxiec. This includes all devices from the MP2000iec Series.
Communication Protocol
MPxxxx (218IF Module) Protocol: Memobus over TCP.
MPxxxxiec Protocol: Modbus TCP.
Device ID
Yaskawa MP Series Ethernet devices are networked using standard IP addressing. The Device ID has the fol-
lowing format: YYY.YYY.YYY.YYY, where YYY designates the device IP address. Each YYY byte should be in the
range of 0 to 255.
Connection Timeout
This parameter specifies the time that the driver will wait for a connection to be made with a device. Depending
on network load, the connect time may vary with each connection attempt. The default setting is 3 seconds. The
valid range is 1 to 60 seconds.
Request Timeout
This parameter specifies the time that the driver will wait on a response from the device before giving up and
going on to the next request. Longer timeouts only affect performance if a device is not responding. The default
setting is 1000 milliseconds. The valid range is 100 to 9999 milliseconds.
Retry Attempts
This parameter specifies the number of times that the driver will retry a message before giving up and going on
to the next message. The default setting is 3 retries. The valid range is 1 to 10.
Cable Diagrams
Both the MPxxxx 218IF Ethernet communications module and the MPxxxxiec are connected to the network via an
Ethernet twisted pair transceiver. The pinout of the 218IF Ethernet connector is displayed in the table below.
www. kepware.com
6 Yaskawa MP Series Ethernet Driver Help
Note: The Yaskawa MP Series Ethernet Driver supports MPxxxxiec series devices, which includes the Yaskawa
MP2000iec Series. For more information, refer to the MP2000iec Series at the manufacturer's website.
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 7
Communications Parameters
www. kepware.com
8 Yaskawa MP Series Ethernet Driver Help
l Port Number: This parameter specifies the TCP/IP port number that the remote device is configured to
use. The default port number is 502.
Note: There should only be one device defined in the PLC per connection.
Block Sizes
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 9
Register Addresses
Input registers (IW, IL, IF) and output registers (MW, ML, MF) can be read from 1 to 120 locations (words) at a
time. The default value is 32.
Register Addresses
Input registers (IW, ID, IL) and output registers (QW, QD, QL) can be read from 1 to 120 locations (words) at a
time. The default value is 32.
l The Yaskawa MP Series Ethernet Driver will support any controller that uses the 218IF module.
l Each connection point must be configured individually.
l Up to 20 connections may be configured, though only 10 may be used at a time.
l In the OPC server project, each device requires a corresponding connection configuration in a 218IF mod-
ule. Connections for remote stations and other software applications must be configured in addition to
those required by the OPC server.
www. kepware.com
10 Yaskawa MP Series Ethernet Driver Help
4. In Scan Time, note the High Speed Scan Setting and Low Speed Scan Setting fields. Yaskawa rec-
ommends 1ms for the High Scan setting and 20ms for the Low Scan setting.
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 11
5. When the scan time settings are set, close the Scan Time dialog.
www. kepware.com
12 Yaskawa MP Series Ethernet Driver Help
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 13
l By default, the IP address will be set to 192.168.1.200; Response Time and Count of Retry will be
0. Set the IP address to one that is supported by the network.
l No connections will have been created in a new project. Select Connection 1 and enter a port
number in the Local Port field. The OPC server defaults to Port 502. If a different port number has
been set, make sure the device in the OPC server project also has the same port number.
l Since this is a slave connection port, the Node IP Address and Node Port should both be set to 0.
www. kepware.com
14 Yaskawa MP Series Ethernet Driver Help
10. If there is the possibility of a device connection from another LAN, set the Network Subnet Mask and
Gateway IOP Address. To do so, select Edit | Local Port: TCP/IP Setting from the File Manager
main menu. In the Station Setting dialog, set the Subnet Mask and Gateway IP values. Then, click OK to
set and close.
11. Load the new configuration into the controller's Flash Memory.
12. Next, create the ladder programs as described in Hardware Configuration - Ladders.
Important: The ladders are absolutely necessary; otherwise, the driver will not be able to connect to the 218IF
module or exchange data with it.
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 15
1. To start, install the programming software. In the following examples, MotionWorks IEC Pro 1.2.3.12 is
used.
3. Launch the Hardware Configuration by clicking the Hardware Configuration icon . The Hardware Con-
figuration window should appear as shown below.
www. kepware.com
16 Yaskawa MP Series Ethernet Driver Help
4. In the upper-right corner, enter the device's IP Address. Then, click Connect.
5. In the Project Window Tree, beneath the name of the device, double-click on Modbus/TCP. In this
example, the device name is "MyMachine".
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 17
8. Next, return to the MotionWorks IEC Pro 1.2.3.12 main project window. Locate the Project Tree Win-
dow and then browse to Physical Hardware.
www. kepware.com
18 Yaskawa MP Series Ethernet Driver Help
11. To create a new variable, right-click on the desired group and then select Insert Variable.
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 19
12. In the Address column, specify the MotionWorks IEC Pro 1.2.3.12 address.
13. Once all changes are complete, build the project by clicking Build | Make.
14. Next, launch the Project Control dialog by clicking the Project Control icon . To download the
project, click Download | Download. The following dialog will be invoked:
Note: The Error button will be enabled if the project contains any errors. When clicked, it will display a
description of the error.
15. Next, locate State and verify that it is set to Run. Then, select Cold, Warm, or Hot. Descriptions of the
starts are as follows:
Viewing Data
Users must be in debug mode in order to view data. For more information, refer to the instructions below.
1. First, right-click on the variable that will be edited. Then, select Debug Dialog.
www. kepware.com
20 Yaskawa MP Series Ethernet Driver Help
Important: The ladders are absolutely necessary: otherwise, the driver will not be able to connect to the 218IF
module or exchange data.
Adding Ladders
To add a new ladder drawing, select Low Scan Programs in the Controller project. Then, select File|New
Drawing from the main menu.
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 21
Note: The image below shows how the Input DWG Name dialog is displayed.
www. kepware.com
22 Yaskawa MP Series Ethernet Driver Help
Ladder L01
The next ladder program is Ladder L01, which initializes the Message Receive parameters and manages the proc-
ess.
Note: The ladder program image has been separated in order to simplify viewing and printing.
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 23
www. kepware.com
24 Yaskawa MP Series Ethernet Driver Help
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 25
www. kepware.com
26 Yaskawa MP Series Ethernet Driver Help
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 27
www. kepware.com
28 Yaskawa MP Series Ethernet Driver Help
Note: The Yaskawa MP Series Ethernet device may release the communications socket connection by default after
a 2 minute interval from when the last communications occurred between the device and the server.
In order to maintain a responsive connection to the Yaskawa MP Series Ethernet module, it is recommended that
the Set point value of the On Delay Timer at rung 12 of ladder L01 should be set greater than the slowest
group update rate occurring in the client application by ten or more seconds.
For example, if the client has a group update rate of 120 seconds (120000ms), the On Delay Timer set point
should be changed to at least 130 seconds (130000ms).
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 29
Our server refers to communications protocols like Yaskawa MP Series Ethernet as a channel. Each channel
defined in the application represents a separate path of execution in the server. Once a channel has been
defined, a series of devices must then be defined under that channel. Each of these devices represents a single
Yaskawa Memobus Plus controller from which data will be collected. While this approach to defining the appli-
cation will provide a high level of performance, it won't take full advantage of the Yaskawa MP Series Ethernet
Driver or the network. An example of how the application may appear when configured using a single channel is
shown below.
If the Yaskawa MP Series Ethernet Driver could only define one single channel, then the example shown above
would be the only option available; however, the Yaskawa MP Series Ethernet Driver can define up to 16 chan-
nels. Using multiple channels distributes the data collection workload by simultaneously issuing multiple
requests to the network. An example of how the same application may appear when configured using multiple
channels to improve performance is shown below.
Block Size, which is available on each defined device, can also affect the Aromat Matsushita/NAIS Ethernet driv-
er's performance. Block Size refers to the number of bytes that may be requested from a device at one time. To
refine the performance of this driver, configure Block Size to 1 to 120 registers and 8 to 800 bits.
www. kepware.com
30 Yaskawa MP Series Ethernet Driver Help
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 31
IL0000-ILFFFD
IF0000-IFFFFD Long, DWord, LBCD
Float
Output Registers MW00000-MW65534 Short, Word, BCD Read/Write
MW00000-MW65533 Long, DWord, LBCD,
MW00000.b-MW65534.b Float
Boolean
(b is bit number 0x0-0xF)
ML00000-ML65533
MF00000-MF65533 Long, DWord, LBCD
Float
Output Registers as strings with HiLo byte MSH00000.bbb-MSH65534.ddd String Read/Write
order
(ddd is string length 2-240, even dec-
imal)
Output Registers as strings with LoHi byte MSL00000.bbb-MSL65534.bbb String Read/Write
order
(ddd is string length 2-240, even dec-
imal)
Arrays
Arrays are supported for register addresses (IW, IL, IF, MW, ML, and MF). The syntax for declaring an array is
MMxxxxx[cols] and MMxxxxx[rows][cols], where "MM" is the memory type mnemonic and "xxxxx" is the base
address of the array data.
The last register of the array cannot exceed the end of the address range. The formula for the final address in an
array is base address + (rows * columns * x) - x.
Note 1: "x" is the total number of bytes in the data type. Word equals 2, DWord equals 4, and Double equals 8.
Users should note the following:
l The last register of a Word, Short, and BCD array cannot exceed 65534.
l Float, DWord, Long, and Long BCD arrays cannot exceed 65533.
l Arrays do not allow the total number of registers being requested to exceed the register block size that
was specified for the device.
Note 2: Arrays are not supported for Boolean types (Ibxxxx.b, MBxxxxx.b, IWxxxx.b, and MWxxxxx.b).
String Support
This driver supports reading and writing output register memory as an ASCII string. When using output reg-
isters for string data, each register will contain two bytes of ASCII data. The order of the ASCII data within a given
register can be selected when the string is defined. The length of the string can be from 2 to 240 bytes and is
entered in place of a bit number. The length must be entered as an even decimal number.
Examples
1. To address a string starting at MW40200 with a length of 100 bytes and Hi-Lo byte order, enter:
MSH40200.100
www. kepware.com
32 Yaskawa MP Series Ethernet Driver Help
2.To address a string starting at MW40500 with a length of 78 bytes and Lo-Hi byte order, enter:
MSL40500.78
Note 1: Input addresses (IB, IW, IL, IF) are in hex, while output addresses (MB, MW, ML, MF) are in decimal. Bit
numbers, "b" are always in hex. Array "rows" and "cols" are always in decimal.
Note 2: All output addresses map to the same memory area. For example, MB00001.F is the same as
MW00001.F. ML00001 and MF00001 both map to the same memory as MW00001 and MW00002. The same is
true for input addresses.
Note 3: Writes to MB00000-MB04095 are faster than writes to MB04096-MB65534 because they can take advan-
tage of direct bit access Memobus commands. Writes to the higher bits requires the driver to perform a read mod-
ify write operation, taking approximately twice as long.
Important: The actual range of valid addresses is hardware specific and may be smaller than the range allowed
by this driver.
%IW28672.b-%IW30718.b Boolean
(b is bit number 0-15)
%IL28672-%IL30712 Double
Output Registers %QW24576-%QW26622 Short, Word, BCD Read Only
%QW28672-%QW30718
%QW24576.b-%QW26622.b Boolean
%QW28672.b-%QW30718.b
(b is bit number 0-15)
%QL24576-%QL26616 Double
%QL28672-%QL30712
Arrays
Arrays are supported for register addresses IW, IL, ID, QW, QL, QD. The syntax for declaring an array is
%MMxxxxx[cols] and %MMxxxxx[rows][cols], where "MM" is the memory type mnemonic and "xxxxx" is the base
address of the array data. When creating an array, the total number of registers requested by an array cannot
exceed the register block size that was specified for this device.
The last register of the array cannot exceed the end of the address range. The final address in an array may be
calculated through the following: base address + (rows * columns * x) - x.
Note: "x" is the total number of bytes in the data type. Word equals 2, DWord equals 4, and Double equals 8.
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 33
Note: Arrays are not supported for Boolean types (%IXxxxx.b, %QXxxxxx.b, %IWxxxx.b, %QWxxxxx.b).
l X: Single bit.
l W: Word (16 bits).
l D: Double Word (32 bits).
l L: Long Word (64 bits).
www. kepware.com
34 Yaskawa MP Series Ethernet Driver Help
Error Descriptions
The following error/warning messages may be generated. Click on the link for a description of the message.
Address Validation
Address '<address>' is out of range for the specified device or register
Array size is out of range for address '<address>'
Array support is not available for the specified address: '<address>'
Data Type '<type>' is not valid for device address '<address>'
Device address '<address>' contains a syntax error
Device address '<address>' is not supported by model '<model name>'
Device address '<address>' is Read Only
Missing address
Address Validation
The following error/warning messages may be generated. Click on the link for a description of the message.
Address Validation
Address '<address>' is out of range for the specified device or register
Array size is out of range for address '<address>'
Array support is not available for the specified address: '<address>'
Data Type '<type>' is not valid for device address '<address>'
Device address '<address>' contains a syntax error
Device address '<address>' is not supported by model '<model name>'
Device address '<address>' is Read Only
Missing address
Possible Cause:
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 35
A tag address that has been specified statically references a location that is beyond the range of supported loca-
tions for the device.
Solution:
Verify that the address is correct; if it is not, re-enter it in the client application.
Possible Cause:
A tag address that has been specified statically is requesting an array size that is too large for the address type or
block size of the driver.
Solution:
Re-enter the address in the client application to specify a smaller value for the array or a different starting point.
Possible Cause:
A tag address that has been specified statically contains an array reference for an address type that doesn't sup-
port arrays.
Solution:
Re-enter the address in the client application to remove the array reference or correct the address type.
Possible Cause:
A tag address that has been specified statically has been assigned an invalid data type.
Solution:
Modify the requested data type in the client application.
Possible Cause:
An invalid tag address has been specified in a dynamic request.
Solution:
Re-enter the address in the client application.
Possible Cause:
A tag address that has been specified statically references a location that is valid for the communications protocol
but not supported by the target device.
Solution:
Verify that the address is correct and if not re-enter it in the client application. Also verify that the selected model
name for the device is correct.
www. kepware.com
36 Yaskawa MP Series Ethernet Driver Help
Possible Cause:
A tag address that has been specified statically has a requested access mode that is not compatible with what the
device supports for that address.
Solution:
Change the access mode in the client application.
Missing address
Error Type:
Warning
Possible Cause:
A tag address that has been specified statically has no length.
Solution:
Re-enter the address in the client application.
Possible Cause:
1. The connection between the device and the host PC is broken.
2. The communication parameters for the connection are incorrect.
3. The named device may have been assigned an incorrect Network ID.
4. The response from the device took longer to receive than the amount of time specified in the "Request Timeout"
device setting.
Solution:
1. Verify the cabling between the PC and the device.
2. Verify that the specified communication parameters match those of the device.
3. Verify that the Network ID given to the named device matches that of the actual device.
4. Increase the Request Timeout setting so that the entire response can be handled.
Possible Cause:
1. The named device may not be connected to the network.
2. The named device may have been assigned an incorrect Network ID.
3. The named device is not responding to write requests.
4. The address does not exist in the PLC.
Solution:
1. Check the PLC network connections.
2. Verify that the Network ID given to the named device matches that of the actual device.
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 37
Possible Cause:
The device returned a Modbus exception code.
Solution:
Determine the meaning of the exception code, and then fix accordingly.
Possible Cause:
Could not negotiate with the operating systems Winsock 1.1 functionality.
Solution:
Verify that the winsock.dll is properly installed on the system.
Illegal data address for tag '<tag address>' on device '<device name>'
Error Type:
Warning
Possible Cause:
The data address received in this query is not allowed for the server or slave because the reference number and
transfer length combination is invalid.
Solution:
Ensure that the range of memory exists in the PLC.
Note:
For a controller with 100 registers, a request with offset 96 and length 4 would succeed. A request with an offset
96 and length 5, however, will generate exception 02.
www. kepware.com
38 Yaskawa MP Series Ethernet Driver Help
Possible Cause:
The data address received in this query is not allowed for the server or slave because the reference number and
transfer length combination is invalid.
Solution:
Ensure that the range of memory exists in the PLC.
Note:
For a controller with 100 registers, a request with offset 96 and length 4 would succeed. A request with an offset
96 and length 5, however, will generate exception 02.
Illegal data value for tag '<tag address>' on device '<device name>'
Error Type:
Warning
Possible Cause:
A value contained in the query data field is not an allowed value for server or slave. This indicates an error in the
structure of the remainder of a complex request, such as that the implied length is incorrect.
Solution:
Correct the error in the structure , and then retry the complex request.
Note:
This error message does not mean that a data item submitted for storage in a register has a value outside the
expectation of the application program. The Modbus TCP Protocol is not aware of the significance of any particular
value of any particular register.
Possible Cause:
A value contained in the query data field is not an allowed value for server or slave. This indicates an error in the
structure of the remainder of a complex request, such as that the implied length is incorrect.
Solution:
Correct the error in the structure , and then retry the complex request.
Note:
This error message does not mean that a data item submitted for storage in a register has a value outside the
expectation of the application program. The Modbus TCP Protocol is not aware of the significance of any particular
value of any particular register.
Possible Cause:
The function code received in the query is not allowed for the server or slave. This may be because the function
code is only applicable to newer devices, and was not implemented in the unit selected. It may also indicate that
the server or slave is in the wrong state to process this type of request (such as if it is not configured but is being
asked to return register values).
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 39
Solution:
Correct the function code, and then retry the query.
Illegal function code '<hex function code>' for tag '<tag address>' on device
'<device name>'
Error Type:
Fatal
Possible Cause:
The function code received in the query is not allowed for the server or slave. This may be because the function
code is only applicable to newer devices, and was not implemented in the unit selected. It may also indicate that
the server or slave is in the wrong state to process this type of request (such as if it is not configured but is being
asked to return register values).
Solution:
Correct the function code, and then retry the query.
Possible Cause:
The slave attempted to read extended memory, and detected a parity error.
Solution:
The master can retry the request, but service may be required on the slave device.
Possible Cause:
An unrecoverable error occurred while the server or slave was attempting to perform the requested action.
Solution:
Locate the cause of the error, and then re-attempt the action.
Possible Cause:
The slave is processing a long duration program command.
Solution:
The master should retransmit the message later when the slave is free.
Possible Cause:
The device returned a Modbus exception code.
Solution:
Determine the meaning of the exception code, and then fix accordingly.
www. kepware.com
40 Yaskawa MP Series Ethernet Driver Help
Possible Cause:
The device could not bind local IP address of specified adapter.
Solution:
1. Verify that the winsock.dll is properly installed on the system.
2. Verify that TCP/IP and Ethernet adapter is properly configured on the system.
Possible Cause:
The device could not create a socket for TCP/IP Ethernet communication.
Solution:
Verify that the winsock.dll is properly installed on the system.
Possible Cause:
1. The data is corrupted.
2. An unexpected frame was received.
Solution:
Re-attempt the query.
Possible Cause:
1. The data is corrupted.
2. An unexpected frame was received.
Solution:
Re-attempt the query.
Possible Cause:
Could not negotiate with the operating systems winsock 1.1 functionality.
Solution:
Verify that the winsock.dll is properly installed on the system.
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 41
Possible Cause:
The device could not negotiate with the operating systems winsock 1.1 functionality.
Solution:
Verify that the winsock.dll is properly installed on the system.
Winsock V1.1 or higher must be installed to use the Yaskawa MP Series Eth-
ernet device driver
Error Type:
Fatal
Possible Cause:
The device could not negotiate with the operating systems winsock 1.1 functionality.
Solution:
Verify that the winsock.dll is properly installed on the system.
www. kepware.com
42 Yaskawa MP Series Ethernet Driver Help
Index
BCD 30
Block Sizes 8
Boolean 30
Communications Parameters 7
www. kepware.com
Yaskawa MP Series Ethernet Driver Help 43
Error Descriptions 34
Illegal data address for tag '<tag address>' on device '<device name>' 37
Illegal data address in block [<start address> to <end address>] on device '<device name>' 38
Illegal data value for tag '<tag address>' on device '<device name>' 38
Illegal data value in block [<start address> to <end address>] on device '<device name>' 38
Illegal function code '<function code (hex)>' in block [<start address> to <end address>] on 38
device '<device name>'
Illegal function code '<hex function code>' for tag '<tag address>' on device '<device 39
name>'
LBCD 30
Long 30
www. kepware.com
44 Yaskawa MP Series Ethernet Driver Help
Missing address 36
Short 30
Slave device '<device name>' has failed 39
String 30
Tag '<tag address>' on device '<device name>' responded with exception '<exception 39
code>'
www. kepware.com