MD-X2000-2500 Series Laser Marker Communication Interface Users Manual

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 180

H98GB

Communication
1 Interface
3-Axis Hybrid Laser Marker
2 EtherNet/IP
MD-X2000/2500 Series
3 PROFINET

Communication Interface 4 OPC UA

User’s Manual
Read this manual before using the product in order to achieve maximum performance.
Keep this manual in a safe place after reading it so that it can be used at any time.
Introduction
Read this manual before using the product in order to achieve maximum performance.
Keep this manual in a safe place after reading it so that it can be used at any time.

Symbols
In this manual, the following symbols alert you to important messages.
Be sure to read the messages.

Indicates a hazardous situation which, if not avoided, will result in death or serious injury.

Indicates a hazardous situation which, if not avoided, could result in death or serious injury.

Indicates a hazardous situation which, if not avoided, could result in minor or moderate injury.

Indicates a situation which, if not avoided, could result in product damage as well as property damage.

Indicates cautions and limitations that must be followed during operation.

Indicates additional information on proper operation.

Indicates tips for better understanding or useful information.

Indicates the reference pages and items in this manual.

Cautions
(1) Unauthorized reproduction of this manual in whole or part is prohibited.
(2) The contents of this manual may be changed for improvements without prior notice.
(3) A
 n utmost effort has been made to ensure the contents of this manual are as complete as possible. If there are any mistakes or questions, please
contact a KEYENCE office listed in the back of the manual.
(4) Regardless of item (3), KEYENCE will not be liable for any effect resulting from the use of this unit.
(5) Any manuals with missing pages or other paging faults will be replaced.
Software License Agreement

Software License Agreement


NOTICE TO USER: PLEASE READ THIS SOFTWARE LICENSE AGREEMENT (THIS “AGREEMENT”) CAREFULLY. BY USING ALL OR ANY
PORTION OF THIS SOFTWARE, YOU ARE AGREEING TO BE BOUND BY ALL THE TERMS AND CONDITONS OF THIS AGREEMENT. IF YOU DO
NOT AGREE TO ANY TERMS OF THIS AGREEMENT, DO NOT USE THIS SOFTWARE.
1. Definition
1.1 “use” or “using” means to access, install, download, copy or otherwise benefit from using the functionality of this Software.
1.2 “This Software” means the software and all associated documentation provided by KEYENCE.
2. Grant of License.
Conditioned upon compliance with all of the terms and conditions of this Agreement, KEYENCE grants you a nonexclusive and nontransferable
license to install this Software on all computers used by your entity in order to use the KEYENCE product. You may make one copy of this Software
for backup or archive purposes only.
3. Restrictions.
3.1 Except for installation of updates or new functions provided by KEYENCE, you may not modify or add any function to this Software.
3.2 You may not reverse engineer, decompile or disassemble this Software.
3.3 You may not create derivative works based on this Software.
3.4 Other than expressly stated by KEYENCE, you may not resell, retransfer, rent or otherwise redistribute this Software to any third parties.
4. Intellectual Property Rights.
Except as expressly stated herein, KEYENCE reserves all right, title and interest in this Software, and all associated copyrights, trademarks, and
other intellectual property rights therein.
5. Disclaimer.
Keyence is licensing this Software to you “AS IS” and without any warranty of any kind. In no event will KEYENCE or its suppliers be liable to you for
any damages, claims, costs or any lost profits caused by using this Software.
6. Termination.
6.1 Your license under this Agreement will terminate automatically if you destroy this Software and the copy of this Software in your possession or
voluntarily return this Software to us.
6.2 Your license under this Agreement will terminate automatically without any notice from KEYENCE if you fail to comply with any of the terms and
conditions of this Agreement. Promptly upon termination, you shall cease all use of this Software and destroy all copies, full or partial, of this
Software in your possession or control.
6.3 You will compensate KEYENCE for costs or any lost profits caused by your violation or breach of any term of this Agreement.
7. Governing Law.
7.1 This Agreement will be governed by and construed in accordance with the substantive laws of Japan without regards to the principles of
conflicts of law.
7.2 If any part of this Agreement is found void and unenforceable, it will not affect the validity of the balance of this Agreement, which shall remain
valid and enforceable according to its terms and conditions.

H98GB 1
Contents

Contents
Introduction Status of device assignment of the MD information area. . . . . . . . . . . 2-10
Symbols Input Assemblies Memory Map. . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
Cautions Output Assemblies Memory Map . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
Software License Agreement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Word area for writing a PLC request. . . . . . . . . . . . . . . . . . . . . . . . 2-19
Command communications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20

Chapter 1 Communication Interface When “Request” bit does NOT work. . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
Ladder Program Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21
Communication command list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 KEYENCE KV Series Program Example. . . . . . . . . . . . . . . . . . . . . . . 2-21
Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 Changing the job No. and starting the marking
RS-232C Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 (An example of bit control) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21
Connection cables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 Changing the string (An example of bit control) . . . . . . . . . . . . . . . 2-22
Communication settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 Sending a command (An example of command communication). . 2-23
Ethernet interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 OMRON PLC CJ2 Series Program Example. . . . . . . . . . . . . . . . . . . . 2-24
Connection cables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 Changing the job No. and starting the marking (An example of bit
Communication settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 control) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24
Communication Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Changing the string (An example of bit control) . . . . . . . . . . . . . . . 2-25
Write/Read command formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Sending a command (An example of command communication). . 2-26
Write command format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Studio 5000 Logix Designer Ladder Program Example. . . . . . . . . . . . 2-27
Read command format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Changing the job No. and starting the marking
Target specifier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 (An example of bit control) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-27
Communication format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9 Changing the string (An example of bit control) . . . . . . . . . . . . . . . 2-27
Header/Delimiter setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9 Sending a command (An example of command communication). . 2-28
Check sum setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Communication priority. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Command Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Chapter 3 PROFINET
How to interpret the command details. . . . . . . . . . . . . . . . . . . . . . . 1-10 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Basic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11 Outline of the control by PROFINET . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Laser marker operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12 Operation Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Current values and statuses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19 Devices compatible with PROFINET communication. . . . . . . . . . . . . . 3-2
Controller setup/management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21 Communication Specification of the Controller. . . . . . . . . . . . . . . . . . . . . . 3-3
Job No.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-25 Basic specification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
String/Logo/Barcode setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-33 Periodic communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Marking parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-46 Status of device assignment of the MD information area. . . . . . . . . . . . 3-4
Code overprinting parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-55 Bit area for writing laser marker state on the PLC. . . . . . . . . . . . . . 3-4
Word area for writing laser marker state on the PLC . . . . . . . . . . . . 3-8
3D shape setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-59
Bit area for writing the request from the PLC
Work flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-63
onto the laser marker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Matrix setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-74
Word area for writing a PLC request. . . . . . . . . . . . . . . . . . . . . . . . 3-11
Group/Counter setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-77
Command communications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
Operation time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-78
Other controller specification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-80
Endian. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
Applied Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-82 GSDML file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
Variable-length support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-82 When “Request” bit does NOT work. . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
Omission of target specifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-82 Setup Procedure of PROFINET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
If the currently running job No. is the target . . . . . . . . . . . . . . . . . . 1-82 Connection Procedure for PROFINET . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
If block No.000 is the target. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-83 Setup of PROFINET Communication. . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Omission of parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-83 Checking the setup of the Laser marker. . . . . . . . . . . . . . . . . . . . . 3-14
Sending of linked commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-84 Modify the settings of the Siemens S7-1200 series.. . . . . . . . . . . . 3-14
For WX command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-84 Controlling the Laser Marker Controller. . . . . . . . . . . . . . . . . . . . . . . . 3-19
For RX command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-85 Switching and Marking the Job No. of the Laser Marker. . . . . . . . 3-19
Linking the communication command (WXC command) . . . . . . . . 1-85 Use the command communication to change
Creating new settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-86 and mark the job No.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20
Communication Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-87 Reading the Marked 2D Code and
Error response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-87 Acquiring the Assessment Result. . . . . . . . . . . . . . . . . . . . . . . . . . 3-21
Error list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-87 Execute Ladder Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22
Appendix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-91 Download the created ladder program on the PLC.. . . . . . . . . . . . . . . 3-22
ASCII code list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-91 Confirm/monitor the state of laser marker . . . . . . . . . . . . . . . . . . . . . . 3-22
Model-Specific Input Value List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-92 Execute ladder program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23

Chapter 2 EtherNet/IP Chapter 4 OPC UA


Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
What is EtherNet/IP?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 What is OPC UA?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
EtherNet/IP communication specifications and functions. . . . . . . . . . . . 2-2 Security precautions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Compatible laser markers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 OPC UA Server Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Compatible PLCs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 OPC UA communication specifications and functions. . . . . . . . . . . . . . 4-3
Cyclic communication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 System configuration example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Cyclic communication with the laser marker . . . . . . . . . . . . . . . . . . . . . 2-3 How to configure the laser marker. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
How to configure the laser marker. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Certificate registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Configuring the PLC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Node structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
PLC settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Node functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
How to configure the KEYENCE KV series. . . . . . . . . . . . . . . . . . . . 2-4 Alarms & conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26
How to configure the OMRON CJ2 series. . . . . . . . . . . . . . . . . . . . 2-6 Control examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
How to configure the Allen-Bradley Control/Compact Logix series. . 2-9 Communication history. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29

2 - MD-X2000/2500 Series Communication Interface User’s Manual -


1
1
Communication Interface

Communication Interface
Communication command list. . . . . . . . . . . . . . . . . 1-2
Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
RS-232C Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Ethernet interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Communication Specifications . . . . . . . . . . . . . . . . 1-8
Write/Read command formats. . . . . . . . . . . . . . . . . . . . . . 1-8
Target specifier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Communication format. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Communication priority. . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Command Details . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Basic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Laser marker operation . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
Current values and statuses . . . . . . . . . . . . . . . . . . . . . . 1-19
Controller setup/management. . . . . . . . . . . . . . . . . . . . . 1-21
Job No.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-25
String/Logo/Barcode setting. . . . . . . . . . . . . . . . . . . . . . 1-33
Marking parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-46
Code overprinting parameters. . . . . . . . . . . . . . . . . . . . . 1-55
3D shape setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-59
Work flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-63
Matrix setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-74
Group/Counter setting. . . . . . . . . . . . . . . . . . . . . . . . . . . 1-77
Operation time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-78
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-80
Applied Functions. . . . . . . . . . . . . . . . . . . . . . . . . . 1-82
Variable-length support . . . . . . . . . . . . . . . . . . . . . . . . . . 1-82
Omission of target specifiers. . . . . . . . . . . . . . . . . . . . . . 1-82
Omission of parameters. . . . . . . . . . . . . . . . . . . . . . . . . . 1-83
Sending of linked commands . . . . . . . . . . . . . . . . . . . . . 1-84
Creating new settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-86
Communication Errors. . . . . . . . . . . . . . . . . . . . . . 1-87
Error response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-87
Error list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-87
Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-91
ASCII code list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-91
Model-Specific Input Value List. . . . . . . . . . . . . . . . . . . . 1-92

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-1


Communication command list

Communication command list


Command function Command Ref.
Delete the job DeleteJob 1-11
Basic Request the READY status Ready 1-11

1
Title (Set/Request) Title 1-11
Start the marking laser StartMarking 1-12
Start the guide laser GuideLaser 1-12
Communication Interface

Stop the guide laser StopMarking 1-12


Enable/disable the acceptance of start marking (Set/Request) TriggerLock 1-12
Enable/disable the distance pointer DistancePointer 1-13
Read a 2D code Check2DCode4 1-13
Check the focus distance FocusCheck 1-14
Laser marker Check the Z coordinate ZTrackingPointCheck 1-15
operation
Set/Request the XY tracking XYTracking 1-15
Set/Request the Z tracking ZTracking 1-16
Z tracking result (matrix) by specifying row and column headers (Set/
ZTrackingMatrixCell 1-16
Request)
Z tracking result (matrix) by specifying a cell number (Set/Request) ZTrackingMartixCellNo 1-17
Start the XY tracking and Z tracking 3AxisTracking 1-17
Start the calibration (high accuracy) of the Z tracking ZTrackingManualCalibration 1-17
Internal lighting status (Set/Request) Lighting 1-18
Running job No. (Set/Request) JobNo 1-19
Current counter value setting (Set/Request) Counter 1-19

Current values and I/O encoded character (Set/Request) IoEncodedCharacter 1-19


statuses Request the final marking string MarkedCharacter 1-19
Request the error status Error 1-20
Clear an error ErrorClear 1-20
Position correction (Set/Request) AllPosition 1-21
Date/time setting (Set/Request) TimeSetting 1-21
Laser power offset (Set/Request) PowerOffset 1-22
Set barcode verification BarcodeVerification 1-22
Set/Request the shutter function as it relates to the laser safety
LaserSafetyModuleShutter 1-22
module operation.
Controller setup/ Timing of the marking complete output ON (Set/Request) PrintCompTimimg 1-22
management
Add a routing table AddRouteTable 1-23
Request the number of routing tables GetRouteTableSettingNum 1-23
Request the routing table information GetRouteTableSetting 1-23
Delete a routing table DeleteRouteTable 1-23
Delete all routing tables DeleteAllRouteTable 1-24
Z timing (Set/Request) ZTiming 1-24

1-2 - MD-X2000/2500 Series Communication Interface User’s Manual -


Communication command list

Command function Command Ref.


Movement/stationary marking setting (Set/Request) OnTheFly 1-25
Head orientation (Set/Request) HeadDirection 1-25
Marking order (Set/Request) MarkingOrder 1-25
Continuous stationary marking (Set/Request) ContinuousStationaryMarking 1-26
Movement parameters (Set/Request) OnTheFlyMarking 1-26

1
Movement marking trigger delay (Set/Request) OnTheFlyTriggerDelay 1-26
Continuous movement marking (Set/Request) ContinuousOnTheFlyMarking 1-27
Marking range setting (Set/Request) OnTheFlyMarkingArea 1-27
Workpiece position adjustment (Plane) (Set/Request) JobPosition 1-28

Communication Interface
Job No.
Height correction (Set/Request) HeightCorrection 1-28
Common block marking parameters (Set/Request) CommonMarkingParameter 1-29
Marking energy check (Set/Request) MarkingEnergy 1-30
Scanner waiting position when ready (Set/Request) ScannerWaiting 1-30
Camera magnification when ready (Set/Request) CameraWaitingScale 1-31
Internal lighting status when ready (Set/Request) CameraWaitingLight 1-31
External lighting status when ready (Set/Request) CameraWaitingExternalLight 1-31
Type of lighting for the running job (Set/Request) LightingType 1-31
Approach scan speed (Set/Request) ApproachScanSpeed 1-32
Block type (Set/Request) BlockType 1-33
Barcode type (Set/Request) CodeType 1-33
String and logo files (Set/Request) CharacterString 1-34
Font setting (Set/Request) CharacterFont 1-37
Character size (Set/Request) CharacterSize 1-38
Logo size (Set/Request) LogoSize 1-38
String proportional setting (Set/Request) CharacterProportional 1-39
String ratio setting (Set/Request) CharacterRatio 1-39
Arc string character layout setting (Set/Request) ArcCharacter 1-40
Barcode/2D code setting (Set/Request) CodeSetting 1-41
String/Logo/Barcode
Barcode size (Set/Request) BarcodeSize 1-41
setting
GS1DataBar size (Set/Request) GS1DataBarSize 1-42
DataMatrix size (Set/Request) DataMatrixSize 1-42
DataMatrix cell size ratio in X direction (Set/Request) DataMatrixCellSizeRatioX 1-43
DataMatrix cell size ratio in Y direction (Set/Request) DataMatrixCellSizeRatioY 1-43
QR Code size (Set/Request) QRCodeSize 1-43
QR code cell size ratio in X direction (Set/Request) QRCodeCellSizeRatioX 1-44
QR code cell size ratio in Y direction (Set/Request) QRCodeCellSizeRatioY 1-44
Block position (Set/Request) BlockPosition 1-44
Block layout (Set/Request) BlockLayout 1-45
Fixed point emission time (Set/Request) FixedPointProcessingTime 1-45
Marking parameters (Set/Request) MarkingParameter 1-46
Barcode/2D code pattern setting (Set/Request) CodePattern 1-47
Hatch logo pattern setting (Set/Request) HatchPattern 1-48
TrueType font pattern setting (Set/Request) TTFPattern 1-49
Barcode/2D code fill marking parameters (Set/Request) CodeFillParameter 1-49
Hatch logo fill marking parameters (Set/Request) HatchParameter 1-50
TrueType font fill marking parameters (Set/Request) TTFParameter 1-51
Marking parameters Photo setting (Set/Request) PhotoSetting 1-51
Marking flag (Set) MarkingEnable 1-52
Individual fill marking parameters (Set/Request) FillMarkingParameter 1-52
Jump Speed (Set/Request) JumpSpeed 1-53
Nudge marking quality setting (Set/Request) MarkingQuality 1-53
Approach (Set/Request) Approach 1-53
Space approach (Set/Request) SpaceApproach 1-54
Curve correction (Set/Request) CurveCorrection 1-54

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-3


Communication command list

Command function Command Ref.


Barcode/2D code overprinting marking parameters (Set/Request) MultiPassMarkingParameter 1-55
Barcode/2D code overprinting pattern setting (Set/Request) MultiPassPattern 1-56
Barcode/2D code overprinting fill parameters (Set/Request) MultiPassFillParameter 1-57
Quality level of barcode/2D code overprinting (Set/Request) MultiPassQualityLevel 1-57
Code overprinting Approach of barcode/2D code overprinting (Set/Request) MultiPassApproach 1-57
parameters

1
Space approach of barcode/2D code overprinting (Set/Request) MultiPassSpaceApproach 1-58
Curve correction of barcode/2D code overprinting (Set/Request) MultiPassCurveCorrection 1-58
Jump speed of barcode/2D code overprinting (Set/Request) MultiPassJumpSpeed 1-58
Communication Interface

Wait time for start marking of barcode/2D code overprinting (Set/


MultiPassBlockMarkingDelayTime 1-58
Request)
3D shape setting (Set/Request) 3DShape 1-59
3D shape type (Set/Request) 3DShapeType 1-59
3D shape position (Set/Request) 3DShapePosition 1-60
Diameter of cylinder shape (Set/Request) CylinderDiameter 1-61
3D shape setting
Cone shape size setting (Set/Request) ConeSize 1-61
Diameter of sphere shape (Set/Request) SphereDiameter 1-61
Position on 3D shape (Set/Request) 3DSurfacePosition 1-62
Cone setting (Set/Request) ConeSetting 1-62
Enable/disable the XY tracking settings (Set/Request) XYTrackingEnable 1-63
Enable/disable the Z tracking settings (Set/Request) ZTrackingEnable 1-63
Set/Request the calibration of the Z tracking ZTrackingCalibration 1-63
Set/Request the warning threshold of the XY tracking XYTrackingCorrectionThreshold 1-64
Set/Request to enable/disable the lens inspection before marking WindowCheckBeforeMarkingEnable 1-64
Set/Request the warning threshold of the lens inspection before WindowCheckBeforeMarkingAlarm
1-64
marking Threshold

WindowCheckBeforeMarking
Set/Request the sensitivity of the lens inspection before marking 1-64
Sensitivity
Set/Request to enable/disable the lens inspection after marking WindowCheckAfterMarkingEnable 1-65
WindowCheckAfterMarkingAlarm
Set/Request the warning threshold of the lens inspection after marking 1-65
Threshold
Set/Request the sensitivity of the lens inspection after marking WindowCheckAfterMarkingSensitivity 1-65
Enable/disable the marking verification function (Set/Request) MarkingConfirmationSetting 1-66
Work flow
2D code quality check and various settings (Set/Request) CodeReaderSetting 1-66
Request internal lighting condition during 2D code reading CodeReaderLightSetting 1-67
Capturing condition of the camera function (Set/Request) CameraImagingSetting 1-67
Capturing position of the camera (Set/Request) CameraTargetSetting 1-68
Request the workflow result WorkflowResultDetail 1-69
Request the marking result MarkingResult 1-70
Request the pre-marking lens inspection result WindowCheckBeforeMarkingResult 1-70
Request the post-marking lens inspection result WindowCheckAfterMarkingResult 1-70
Request the filename of the image captured with the camera CameraImageFilepath 1-71
Request the marking confirmation result MarkingConfirmationResult 1-71
Request the 2D code reader result CodeReadResult 1-72
Request the marking energy result MarkingEnergyResult 1-73
Request the number of marked matrix cells MatrixCellMarkingCount 1-73
Matrix row & column setting (Set/Request) MatrixSetting 1-74
Matrix size setting (Set/Request) MatrixSize 1-74
Matrix cell reference point (Set/Request) CellReferencePoint 1-75
Matrix setting Cell individual setting (Set/Request) MatrixCell 1-75
Cell marking flag (Set) MatrixCellEnable 1-76
Matrix position setting (Set/Request) MatrixPosition 1-76
Count using invalid marking cells (Set/Request) InactiveCellCount 1-76

Group/Counter Group setting (Set/Request) GroupOffset 1-77


setting Counter setting (Set/Request) CounterSetting 1-77

1-4 - MD-X2000/2500 Series Communication Interface User’s Manual -


Communication command list

Command function Command Ref.


Request the controller operating time OperatingTime 1-78
Request the laser excited time LaserOperatingTime 1-78
Request the scanner operating time ScannerOperatingTime 1-78
Request the number of shutter operations ShutterOperatingCount 1-78
Operation time Request the number of laser safety module operations LaserSafetyModuleOperatingCount 1-78

1
Request the head temperature MarkingUnitTemperature 1-79
Request the controller temperature ControllerTemperature 1-79
Request the result of laser power calibration LaserPowerCalibrationResult 1-79
Cumulative marking count 1 and 2 (Set/Request) CumulativeMarkingCount 1-79

Communication Interface
Request the lens inspection result WindowCheckResult 1-80
Set/Request the sensitivity of the lens inspection WindowCheckSensitivity 1-80
Set/Request the lens inspection at startup WindowCheckStartup 1-80
Set/Request the lens inspection alarm threshold. WindowCheckAlarmThreshold 1-81
Maintenance
Start the lens inspection WindowCheck 1-81
Laser power measurement LaserPowerCheck 1-81
Delete all logging data LoggingClearAllData 1-81
Delete logging data with a specified period LoggingClearData 1-81

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-5


Interface

Interface
• Read the “Safety Information” in the user's manual for the applicable model to perform operation in the state that the safety
is secured by using security function even when the network failure occurs.
• Confirm the safe operation by considering the communication delay due to the communication time or network overload
state.

1 RS-232C Interface
Communication Interface

This section explains how to communicate using RS-232C connection.

Connection cables Communication settings


The connector type on the laser marker unit side is D-Sub 9-Pin (Male). The RS-232C communication settings must be configured the same on
When connecting with an external device (PLC, etc.), connect as the laser marker and the external device. Using Marking Builder Plus or
shown below in solid lines using RS-232C straight cable. The following the console, configure the settings such that all of the following items
is an example of connection with an external device with D-Sub 9-Pin are the same.
connector.
Setting item Setting value
Laser Marker side Shield External device side
1 1 • 2400 bps
• 4800 bps
Send 2 2 Receive • 9600 bps
3 3 Baud rate • 19200 bps
Receive Send
• 38400 bps (Default value)
4 4 • 57600 bps
5 5 • 115200 bps
Signal GND Signal GND
6 6 • None (Default value)
Parity check • Odd
7 7
• Even
8 8
• 1 (Default value)
9 9 Stop bit
• 2 bit
Connector hood Connector hood
• None (Default value)
Check sum
• Yes
• The connector will be more susceptible to noise if
the connector hood is not shielded. • The delimiter automatically detects the delimiter setting
• On some external devices, communication cannot of the external device. [EXT] and [CR] are supported.
be established without short-circuiting No. 4/6 pins • The data length is “8 bits fixed”, communication mode
and No. 7/8 pins on the external device side. Refer to is “Full duplex”, synchronization mode is “Start-stop
the manual of the external device. synchronization”, flow control is “None”, and inter-frame
timeout is “3500ms”.
• Only No. 2, 3 and 5 pins are used on the laser marker • It is compliant with the EIA (Electronic Industries
side. Association) RS-232C.
• If the external device also has 9 pins, data is sent from • When sending a non-ASCII string, specify the character
the laser marker to the external device between No.2 code from Unicode (UTF-8), Shift-JIS, or Latin-1. The
pins and data is sent from the external device to the default value is Unicode (UTF-8). If you are using
laser marker between No.3 pins. Marking Builder Plus, you can change the setting from
• Use #4-40 inch screws to fix the connector to the [Communication Settings] under [Controller] in the
controller. [Settings] tab.

When using the RS-232C protocol, data corruption


or failure may occur do to noise or poor connection.
Be sure to use the parity or checksum to increase
the reliability of the communication environment.

1-6 - MD-X2000/2500 Series Communication Interface User’s Manual -


Interface

Ethernet interface
This section explains how to communicate using TCP/IP (Non-
procedure) via Ethernet.

Connection cables
Connect the laser marker with the external device using a LAN (STP or
UTP) cable.
To use TCP/IP (Non-procedure) communication, use the LAN1 [MAIN]
1
port of the laser marker.

Communication Interface
Pin
MDI signal Signal function
number

1 TD+ Sent data (+)

No. 1 to 8 from top 2 TD- Sent data (-)

3 RD+ Received data (+)

4 - -

5 - -
RJ-45
Modular connector 6 RD- Received data (-)

7 - -

• Both straight and cross cables are supported. Category


5 cable or higher is recommended.
• Optional LAN cross cable (OP-66843) is sold separately.

Communication settings
When connecting the laser marker with the external device using TCP/
IP via Ethernet, set the IP addresses and subnet masks such that they
are in the same local area network. The default port number is “50002”.
For the detail, refer to “Communication Setup” in [4 Setting Menu” of
“Marking Builder Plus User's Manual.”

• In the case of Ethernet communication, the delimiter


is fixed to [CR] and the check sum is fixed to [None],
respectively.
• If you are using Marking Builder Plus, you can
change the setting from [Ethernet Settings] under
[Controller] in the [Settings] tab.
To use TCP/IP communication or Industrial Ethernet,
use the LAN1 [MAIN] port of the controller.

For details about communication methods using Profinet


and Ethernet/IP, refer to each manual.

When multiple commands are received from external


equipment via TCP/IP communication, the command
is saved to the buffer (queue) by received order, and
the next command is processed after sending out the
response.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-7


Communication Specifications

Communication Specifications
Write/Read command formats Target specifier
If you wish to send a command from the external device to the laser When sending a command to the laser marker, for most commands,
marker, it should be sent/received in the format described below. you need to determine the change target in advance. A target specifier
is inserted before the command in the form of “Target specifier = Target

1
No.”. If you wish to specify multiple targets, they need to be arranged
side-by-side. The types of target specifiers and target number ranges
Write command format are as described below.

Target Target Range


Communication Interface

If the command is changing the setting value of the laser marker or Description
executing an operation, add “WX” on the beginning of the command. Specifier No.

Command WX,Command [CR] JOB 0000 to 1999 Specifies the job No.

Normal : WX,OK [CR] BLK 000 to 255 Specifies the block No.
Response
Error : WX,NG,S***,ErrCode [CR]
00 : Marking confirmation function
An OK response is returned if the change or instruction specified by FNC 00 to 01
01: 2D code reader
the command is successful and returns an error response if it fails. For
more information on the error, refer to “Communication Errors” (Page TRK 000 to 255 Specifies the tracking No.
1-87).
A response is returned in the timing when the specified change or OLP 0 to 9 Specifies the overprinting No.
instruction has completed.
3DS 000 to 255 Specifies the 3D shape No.
• The spelling of “Command” is not case-sensitive. Both
cases will be accepted. Specifies the number of rows and
• The maximum command byte length is 4096 bytes. You columns of the matrix. The number
need to split the command if you wish to send a longer will be assigned with priority given to
byte length. rows, in reference to the top left of
• The command other than strings is sent in ASCII format. the matrix.

Read command format CEL 00001 to 65025

If the command is requesting the setting value or the status of the laser
marker, add “RX” on the beginning of the command.

Command RX,Command [CR]

Response RX,OK,Response [CR]

The value and status specified by the command are returned in a


response. Since request commands can be sent/received at any time,
no errors will occur as long as the communication format is correct. The GRP 000 to 255 Specifies the group No.
RX command returns a fixed-length response.
CTR 0 to 9/A to J Specifies the counter No.
• The information in brackets [ ] indicates the control code.
[CR] is 0Dh in hexadecimal.
• Use ASCII when sending double-type characters such • A “,” (comma) separator is inserted between the target
as Kanji characters or a Unicode string. specifier and the command.
• Insert a “, “ (comma) separator after a command, • A target specifier may be unnecessary for commands
response or check sum. that directly operate the laser marker.
• The maximum response byte length is 4096 bytes. • You can also specify CEL using row & column headers.
It is specified in the form of “Row number-Column
• A MarkedCharacter command is a request command,
number” in the range between “001-001” and “255-255”.
however, there is a restriction for the timing of sending/
receiving. • The JOB specifier can be substituted by the PRG
specifier used by a Marking Builder 3 supported model.
PRG is accepted as the same as JOB.

For example, to change a string, you need to specify the job No. and
block No. in advance. The command will therefore be as an example
described below.

„ Example of command for changing the string


of job No. 1 and block No.1 to “ABC”
Command WX,JOB=0001,BLK=001,CharacterString=ABC
[CR]

Response WX,OK [CR]

1-8 - MD-X2000/2500 Series Communication Interface User’s Manual -


Communication Specifications

Communication format Communication priority


The laser marker has 6 types of communication paths that generally
support simultaneous connections. However, when the laser marker
Header/Delimiter setting shifts to a specific status via a communication path, priority will be
given to the specific communication path. This means that only request
commands will be accepted for communication paths other than the
RS-232C connection priority communication path. The following table shows the conditions
under which a priority communication path will occur.

1
A response is returned automatically detecting the header/delimiter as [STX]
/ [ETX] or [None] / [CR].
Communication path Priority acquisition period
Ethernet connection • The length of time from when the WX
Only [None]/[CR] are supported. command is sent until a response is

Communication Interface
External communication returned
(RS-232C/Ethernet) • From sending the CreateJob command,
„ [STX]/[ETX] command examples • until a response is returned from the
EndJob command
Command [STX]WX,Command[ETX]
• During acquiring mastership
Response [STX]WX,OK[ETX]
• During I/O terminal monitor mode
Marking Builder Plus
transition
(USB/Ethernet)
„ [None]/[CR] command examples • During transition of settings and backup
data
Command WX,Command[CR]
• During test marking mode transition
Response WX,OK[CR] • During terminal block simulate mode
Console
transition
(Dedicated cable)
• During transition of settings and backup
data

Check sum setting • Blocking communication: The length


of time from when the setting change
You can add a check sum for checking the data integrity for RS-232C command is sent until a response is
communication only. A check sum is added immediately before the MBP ActiveX returned
delimiter as a 2-digit hexadecimal string. The 2-digit string is calculated (USB/Ethernet) • Non-blocking communication: The
based on the horizontal parity (XOR). The following shows an example length of time from when the setting
of the commands and calculating formulas. change command is sent until the next
event is completed

„ A command example with check sum added Profinet, EtherNet/IP


The length of time from the start of a
setting change instruction, etc. until the
(Ethernet)
Command WX,Command,48[CR] operation is completed

Response WX,OK,0B[CR]

Sent code Received code


W 57h 0101 0111b W 57h 0101 0111b
XOR XOR
X 58h 0101 1000b X 58h 0101 1000b
XOR XOR
, 2Ch 0010 1100b , 2Ch 0010 1100b
XOR XOR
C 43h 0100 0011b O 4Fh 0100 1111b
XOR XOR
o 6Fh 0110 1111b K 4Bh 0100 1011b
XOR XOR
m 6Dh 0110 1101b , 2Ch 0010 1100b
XOR
m 6Dh 0110 1101b 0000 1011b
XOR
a 61h 0110 0001b ASCII conversion
XOR 0Bh
n 6Eh 0110 1110b
XOR
d 64h 0110 0100b
XOR
, 2Ch 0010 1100b

0100 1000b
ASCII conversion
48h

The check sum is calculated excluding the header,


delimiter and check sum sections.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-9


Lower limit threshold

Communication Interface
0: Disabled
A:0/1 1 byte
1: Enabled
* Default value “0”
Command Details
Upper limit threshold

Command Details
0: Disabled
Parameter B:0/1 1 byte
1: Enabled
* Default value “0”

Lower limit threshold (J)


C: 00000.01 to 99999.99 8 bytes
* A: Fixed value of “0.01” when 0

How to interpret theD:command details


00000.01 to 99999.99 8 bytes
Upper limit threshold (J)
* B: Fixed value of “0.01” when 0
This section explains how to interpret the command details using the following command as an example.
Marking energy check will be canceled when the next trigger is accepted within 2 seconds of completion of the marking. Therefore, make
sure to allow at least 2 seconds between the marking completion and the next marking start.

1
This shows the target specifier required for This is the default value of the job
thisScanner
(13) command.
waiting position when ready (Set/Request) parameters.

Command ScannerWaiting 14 bytes


Communication Interface

Description Sets/Requests the scanner waiting position when ready.

Target JOB = 0000 to 1999

Command WX,JOB=0000,ScannerWaiting=A,B,C,D[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,ScannerWaiting[CR]
RX
Response RX,OK,A,B,C,D[CR]

Standby coordinate
0: Auto
A:0/1 1 byte
1: Custom coordinate
* Default value “0”

B: Depends on the area size


Normal : -062.500 to 0062.500 Standby X coordinate (mm)
8 bytes
Wide :-165.000 to 0165.000 * A: Fixed value of “0” when 0
Small : -025.000 to 0025.000
Parameter
C: Depends on the area size
Normal : -062.500 to 0062.500 Standby Y coordinate (mm)
8 bytes
Other model : “Y coordinate” of “Model-Specific * A: Fixed value of “0” when 0
Input Value List” (Page 1-80)

D: Depends on the area size


Normal : -021.000 to 0021.000 Standby Z coordinate (mm)
8 bytes
Wide :-021.000 to 0021.000 * A: Fixed value of “0” when 0
Small : -015.000 to 0015.000

When setting the standby coordinate to auto, standby is done on the coordinate where the scanner will be used firstly at work flow.
The input range varies depending on the laser marker area size. Input range is listed in the “Model-Specific Input
The applicable models for each area size are as described below. Value List” (Page 1-92).
• Normal : MD-X2000/2500 Series
• Wide : MD-X2020/2520 Series
Enter a fixed value when the value of the specific parameter is “0”.
• Small : MD-X2050 Series
* Since the fixed values are ignored on the laser marker side, values
other than the fixed values will be accepted as long as they are
within the parameter input range.

„ WX command example
This command changes the scanner waiting position when ready (X: 5mm, Y: 10mm, Z: -5mm) of job No.0005.

Command WX,JOB=0005,ScannerWaiting=1,0005.000,0010.000,-005.000[CR]

Response WX,OK [CR]

„ RX command example
This command requests the scanner waiting position when ready (X: 5 mm, Y: 10 mm, Z: -5 mm) of job No.0005.

Command RX,JOB=0005,ScannerWaiting
- MD-X2000/2500 Series Communication
[CR] Interface User’s Manual - 1-25
Response RX,OK,1,0005.000,0010.000,-005.000[CR]

1-10 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

Basic
(1) Delete the job
Command DeleteJob 13 bytes
Description Deletes the jobs in the laser marker.

Target None

WX
Command

Response
WX,DeleteJob=A,A,A,A...[CR]

WX,OK [CR]
1

Communication Interface
Command
RX None
Response

Deletes all jobs in the case of the job No.


9999 to be deleted
Parameter A:0000 to 1999/9999 4 bytes
You can specify multiple job No. for deletion
by separating them with commas.

• To delete multiple jobs simultaneously, send the command as described below.


WX,DeleteJob=0001,0002,0005,0006[CR]
• When you specify multiple jobs, an error will occur if any one of the specified job No. does not exist.
• If a running job is specified, an error occurs.

(2) Request the READY status


Command Ready 5 bytes
Description Requests whether the laser marker is in the ready status.

Target None

Command
WX None
Response

Command RX,Ready[CR]
RX
Response RX,OK,A[CR]

0 : READY ON
1 : READY OFF (Error occurring)
Parameter A:0/1/2 1 byte
2 : READY OFF (Marking or expansion in
progress)

If the value of parameter A is “1”, you cannot perform any marking until the error is cleared. Clear the error using the ErrorClear command.
However, if the occurring error is a terminal block status error (T***), check the ON/OFF status of the terminal block.

(3) Title (Set/Request)


Command Title 5 bytes
Description Sets/Requests the job title.

Target JOB=0000 to 1999

Command WX,JOB=0000,Title=A[CR]
WX
Response WX,OK[CR]

Command RX,JOB=0000,Title[CR]]
RX
Response RX,OK,A[CR]

• 1 to 100 single-byte or double-byte


characters.
Parameter A:Title -
• An empty string (0 character) will result in
an error.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-11


Command Details

Laser marker operation


(1) Start the marking laser
Command StartMarking 12 bytes
Description Starts the marking laser.

Target None

1 WX
Command

Response
WX, StartMarking=A [CR]

WX,OK [CR]
Communication Interface

Command
RX None
Response

NG response detection range


0: Return an NG response only when the
marking operation is canceled.
Parameter A:0/1 1 byte
1: Return the error details and an NG
response when an error occurs during the
marking operation.

• An error response is returned when marking is canceled from the terminal block, etc.
• The parameter can be omitted. Sending WX,StartMarking[CR] results in the same response as WX,StartMarking=0[CR].

(2) Start the guide laser


Command GuideLaser 10 bytes
Description Starts the guide laser marking using the guide laser type specified by parameter A.

The guide laser is emitted for the same length of time as the marking time when selecting once and emitted
Target
continuously for 30 seconds for all other emission types.

Command WX,GuideLaser=A[CR]
WX
Response WX,OK [CR]

Command
RX None
Response

Guide laser type


1: Once
2: Continuous
Parameter A:1~5 1 byte
3: Area frame
4: Work image
5: Block frame

• This command returns a response as soon as the guide laser emission starts.
• The emission can be canceled using the “StopMarking” command.

(3) Stop the guide laser


Command StopMarking 11 bytes
Description Cancels the guide laser marking.

Target None

Command WX,StopMarking[CR]
WX
Response WX,OK [CR]

Command
RX None
Response

Parameter None

(4) Enable/disable the acceptance of start marking (Set/Request)


Command TriggerLock 11 bytes
Description Enables/disables acceptance of triggers from the terminal block and/or communication path.

Target None

Command WX,TriggerLock=A[CR]
WX
Response WX,OK [CR]

Command RX,TriggerLock[CR]
RX
Response RX,OK,A[CR]

Acceptance of start marking


0: Enabled
Parameter A:0/1 1 bytes
1: Disabled
* Default value “0”

If this command is received during marking, the marking will not stop but the next marking start input will be rejected.

1-12 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(5) Enable/disable the distance pointer


Command DistancePointer 15 bytes
Description Turns on/off the distance pointer.

Target None

Command WX,DistancePointer=A[CR]
WX
Response WX,OK[CR]

RX
Command

Response
RX,DistancePointer[CR]

RX,OK,A[CR] 1
Distance Pointer

Communication Interface
Parameter A:0/1 1 byte 0: Off
1: On

This command returns a response as soon as the distance pointer is turned on/off.

(6) Read a 2D code


Command Check2DCode4 12 bytes
Description Reads the 2D code inside the area using the built-in camera.

Target None

Command WX,Check2DCode4=A,B,C,D,E,F,G,H,I,J,K,L,M,N,O[CR]
WX
Response WX,OK,P,Q,R[CR]

Command
RX None
Response

Capture position
0: Current scanner position
A: 0 to 3 1 byte 1: Custom coordinate
2: Block coordinate
3: Block position (last tracking result applied)

B: Varies depending on the area size


Normal: -062.500 to 0062.500 X coordinate (mm)
8 byte
Wide: -165.000 to 0165.000 * A: Fixed value of “0” when 0/2
Small: -025.000 to 0025.000

C: Varies depending on the area size


Normal: -062.500 to 0062.500 Y coordinate (mm)
8 byte
Wide:- 165.000 to 0165.000 * A: Fixed value of “0” when 0/2
Small: -025.000 to 0025.000

D: Varies depending on the area size


Normal: -21.000~021.000 Z coordinate (mm)
8 byte
Wide: -21.000 to 021.000 * A: Fixed value of “0” when 0/2
Small: -15.000 to 015.000

Reading area (%)


No area specification when “0”
E: 000 to 100 3 byte * A: Same as 100% when 0/1
* A: Auto area specification when 2
* G: Same as 100% when 0/1

Block No.
F: 000 to 255 3 byte
Parameter A: Fixed value of “0” when 0/1

Camera zoom
0: Whole wide
1: Whole standard
G: 0 to 3 1 byte
2: Coax wide
3: Coax standard
* Default value “2”

Brightness
H: -100 to 0100 4 byte
* Default value “0”

Gamma correction value


I: 0.1 to 5.0 3 byte
* Default value “1.0”

Lighting type
0: Internal lighting (normal)
J: 0 to 2 1 byte 1: Internal lighting (halation removal)
2: External lighting
* Default value “2”

Lighting condition for internal lighting 1


0: Off
K: 0/1 1 byte
1: On
* This parameter can be omitted.

Lighting condition for internal lighting 2


0: Off
L: 0/1 1 byte
1: On
* This parameter can be omitted.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-13


Command Details

Lighting condition for internal lighting 3


0: Off
M: 0/1 1 byte
1: On
* This parameter can be omitted.

Lighting condition for internal lighting 4


0: Off
N: 0/1 1 byte
1: On
* This parameter can be omitted.
Parameter

1
Lighting condition for internal lighting 5
0: Off
O: 0/1 1 byte
1: On
* This parameter can be omitted.
Communication Interface

P: A~D/F 1 byte AIM-DPM total grade

Q: 000 to 100 3 byte Matching level

R to Encoded string - Encoded string of 2D code

• When J is 0 and the lighting condition for the internal lighting is specified, all of parameters K, L, M, N, and O must be specified.
• When A is 2 or 3, reading is possible in the period after marking until the next marking.
• When A is 3, the last correction for the XY tracking and Z tracking set for the block will be applied to the capture position.
When no previous tracking result exists because the setting number was switched or for other reasons, the block position will not be corrected.
When the tracking is set to not correct the block position, the capture position will not be corrected.
• The S087 communication error “2D code reading error” is returned if the 2D code cannot be found.
• The fixed camera and internal lighting cannot be selected for the MD-X2050(A). If the command is executed, an S095 Model Limitation Error will occur.
• This command cannot be used for the MD-X400(A)/450(A).
• See the figure below for the relationship between the internal lighting numbers and positions.

5 4 3

1 2
(7) Check the focus distance
Command FocusCheck 10 bytes
Measures the difference between the distance to the workpiece and the reference distance for the number of times
Description
specified in parameter A and returns its average value as the focus deviation amount.

Target None

Command WX,FocusCheck=A[CR]
WX
Response WX,OK,B[CR]

Command
RX None
Response

A: 01~10 2 bytes Measurement count (times)


Parameter
B: -100.0~0100.0 6 bytes Focus deviation amount (mm)

• If the Z coordinate of the position correction has been input, this value will be subtracted from the focus deviation amount.
• It cannot be used on the MD-X400(A)/450(A) series.

1-14 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(8) Check the Z coordinate


Command ZTrackingPointCheck 19 bytes
Measures the specified XYZ coordinates by the number of times specified by a parameter.
Description
Acquires the average and returns a gap amount from a specified Z coordinate.

Target None

Command WX,ZtrackingPointCheck=A,B,C,D,E[CR]
WX

1
Response WX,OK,F,G[CR]

Command
RX None
Response

Communication Interface
A: Depends on the area size
X coordinate (mm)
Normal : -062.500~0062.500 8 bytes
* Default value “0”
Wide : -165.000~0165.000

B: Depends on the area size


Y coordinate (mm)
Normal : -062.500~0062.500 8 bytes
* Default value “0”
Wide :-165.000~0165.000

Z coordinate (mm)
C: -21.000 to 021.000 7 bytes
* Default value “0”
Parameter
Measurement count
D: 1 to 10 2 bytes
* Default value “0”

Sampling cycle
E: 0 to 4 1 byte 0 (short) to 4 (long)
* Default value “0”

Gap amount from a specified Z coordinate


F: -99.00 to 099.00 6 byte
(mm)

G: 000 to 100 3 byte Stability

• It cannot be used on the MD-X2050(A)/400(A)/450(A) series.


• The longer the sampling cycle is, the higher the reliability of the measurement is, even though the measurement time will get longer.

(9) Set/Request the XY tracking


Command XYTracking 10 bytes
Executes a XY tracking by specifying the XY tracking No. of the currently running job to acquire the workpiece gap
Description
amount.

Target None

Command WX,XYTracking=A[CR]
WX
Response WX,OK,B,C,D,E,F,G[CR]

Command RX,XYTracking=A[CR]
RX
Response RX,OK,B,C,D,E,F,G[CR]

A:00~07 2 bytes XY tracking No.

B: Depends on the area size


Normal : -125.000~0125.000 8 bytes X coordinate gap amount (mm)
Wide : -330.000~0330.000

C: Depends on the area size


Normal : -125.000~0125.000 8 bytes Y coordinate gap amount (mm)
Wide : -330.000~0330.000
Parameter
D: -180.000~0180.000 8 bytes θ gap amount (°)

E: 000~100 3 bytes Correlation value

F: 0000 to 9999 4 bytes Execution time (ms)

Result
0: Failure
G:0/1/2 1 byte
1: Success
2: Success (correlation value: low)

• The RX command acquires the result at the previous execution. The previous result will be cleared when changing the job No. of the
current operation.
• When there is no setting of the specified tracking No., S103 tracking No. no registration error will occur.
• When there is no result of the specified tracking No., S104 tracking result request error will occur.
• It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-15


Command Details

(10) Set/Request the Z tracking


Command ZTracking 9 bytes
Description Executes/acquires the result of a Z tracking.

Target None

Command WX,ZTracking=A[CR]
WX
Response WX,OK,B,C,D,E,F,G[CR]

1 RX
Command

Response
RX,ZTracking=A[CR]

RX,OK,B,C,D,E,F,G[CR]

A:0 to 255 3 bytes Z tracking No.


Communication Interface

B:-042.000 to 0042.000 8 bytes Z coordinate gap amount (mm)

X rotation angle gap amount (°)


C: -180.000 to 0180.000 8 bytes * Fixed value of “0” when correcting Z
coordinate

Y rotation angle gap amount (°)


D: -180.000 to 0180.000 8 bytes * Fixed value of “0” when correcting Z
Parameter coordinate

E: 000 to 100 3 bytes Stability

F: 0000 to 9999 4 bytes Execution time (ms)

Result
0: Failure
G: 0/1/2 1 byte 1: Success
2: Success (stability: low)
3: Success (out of tolerance range)

• The RX command acquires the result at the previous execution. The previous result will be cleared when changing the job No. of the
current operation.
• When there is no setting of the specified tracking No., S103 tracking No. no registration error will occur.
• When there is no result of the specified tracking No., S104 tracking result request error will occur.
• It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

(11) Z tracking result (matrix) by specifying a cell number (Set/Request)


Command ZTrackingMatrixCell 19 bytes
Description Sets/requests the Z tracking result for a matrix or a matrix cell specified with row and column headers.

Target None

Command WX,ZTrackingMatrixCell=A,B[CR]
WX
Response WX,OK,C,D,E,F,G,H[CR]

Command RX,ZTrackingMatrixCell=A,B[CR]
RX
Response RX,OK,C,D,E,F,G,H[CR]

A: 000 to 255 3 bytes Row header of the cell

B: 000 to 255 3 bytes Column header of the cell

C: -042.000 to 0042.000 8 bytes Z coordinate deviation (mm)

X angle deviation (°)


D: 0000.000 8 bytes
* Fixed value: 0

Y angle deviation (°)


E: 0000.000 8 bytes
Parameter * Fixed value: 0

F: 000 to 100 3 bytes Stability

G: 000000 to 999999 6 bytes Execution time (ms)

Result
0: Failure
H: 0 to 3 1: Success
2: Success (stability: low)
3: Success (out of tolerance range)

• When 0 is set for the row and column headers, result acquisition is performed for the entire matrix. When Z tracking is set for each cell,
the average of the cells is returned. The result is 1: Success only when the result is a success for all the cells. Otherwise, the result is 0:
Failure.
• During execution, Z tracking is performed for the entire matrix or matrix cells regardless of the specified cell.
The response returns the result of the specified cell.
• More than one cell can be specified for result acquisition. Specify the cells in the format such as “RX,ZTrackingMatrixCell=A,B,A,B,A,B,”
and so on.
The result of this command will be “RX,OK,C,D,E,F,G,H,C,D,E,F,G,H,C,D,E,F,G,H,” and so on.
If any part of the result is failure, an error is returned.
• The RX command acquires the result of the last execution. The result of the last execution will be cleared when the job No. of the
currently operating job is changed.
• When the tracking produces no result, an S104 Tracking Result Request Error will occur.
• This command cannot be used for the MD-X2050(A)/400(A)/450(A).

1-16 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(12) Set/Acquire the result of the Z tracking (matrix) (by specifying a cell number)
Command ZTrackingMatrixCellNo 21 bytes
Description Executes/acquires the result of the Z tracking for a matrix or a matrix cell specified with a cell number.

Target None

Command WX,ZTrackingMatrixCellNo=A[CR]
WX
Response WX,OK,B,C,D,E,F,G[CR]

RX
Command

Response
RX,ZTrackingMatrixCellNo=A[CR]

RX,OK,B,C,D,E,F,G[CR] 1
A: 00000 to 65025 5 bytes Cell number

Communication Interface
B: -042.000~0042.000 8 bytes Z coordinate deviation (mm)

X angle deviation (°)


C: 0000.000 8 bytes
* Fixed value: 0

Y angle deviation (°)


D: 0000.000 8 bytes
* Fixed value: 0
Parameter
E: 000 to 100 3 bytes Stability

F: 000000 to 999999 6 bytes Execution time (ms)

Result
0: Failure
G: 0 to 3 1 bytes 1: Success
2: Success (stability: low)
3: Success (out of tolerance range)

• When 0 is set for the cell number, result acquisition is performed for the entire matrix. The RX command acquires the result of the last
execution. The result of the last execution will be cleared when the job No. of the currently operating job is changed.
• During execution, Z tracking is performed for the entire matrix or matrix cells regardless of the specified cell. The response returns the
result of the specified cell.
• More than one cell can be specified for result acquisition. Specify the cells in the format such as “RX,ZTrackingMatrixCellNo=A,A,A,” and
so on.
The result of this command will be “RX,OK,B,C,D,E,F,G,B,C,D,E,F,G,B,C,D,E,F,G,” and so on.
If any part of the result is failure, an error is returned.
• The RX command acquires the result of the last execution. The result of the last execution will be cleared when the job No. of the
currently operating job is changed.
• When the tracking produces no result, an S104 Tracking Result Request Error will occur.
• This command cannot be used for the MD-X2050(A)/400(A)/450(A).

(13) Start the XY tracking and Z tracking


Command 3AxisTracking 13 bytes
Description Executes a XY tracking and Z tracking of the currently running job.

Target None

Command WX,3AxisTracking
WX
Response WX,OK

Command
RX None
Response

Parameter None

• The results can be acquired by RX, XYTracking = A, and RX, ZTracking = A,RX,ZTrackingMatrixCell=A,B.
• This command cannot be used for the MD-X2050(A)/400(A)/450(A).

(14) Start the calibration (high accuracy) of the Z tracking


Command ZTrackingManualCalibration 26 bytes
Description Executes the calibration of a Z tracking (high accuracy).

Target None

Command WX,ZTrackingManualCalibration[CR]
WX
Response WX,OK [CR]

Command
RX None
Response

It cannot be used on the MD-X400(A)/450(A) series.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-17


Command Details

(15) Internal lighting status (Set/Request)


Command Lighting 8 bytes
Description Set/Request the on/off status of the internal lighting

Target None

Command WX,Lighting=A[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,Lighting[CR]

RX,OK,A[CR]

Status of lighting
Communication Interface

Parameter A:0/1 1 byte 0: Off


1: On

It cannot be used on the MD-X400(A)/450(A) series.

1-18 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

Current values and statuses


(1) Running job No. (Set/Request)
Command JobNo 5 bytes
Description Sets/Requests the running job No.

Target None

WX
Command

Response
WX,JobNo=A[CR]

WX,OK [CR]
1

Communication Interface
Command RX,JobNo[CR]
RX
Response RX,OK,A[CR]

Parameter A:0000~1999 4 bytes Specifies the job No.

• E015 “No Job Error” is returned if you specify a non-registered job No.
• An OK response is returned when a currently running job No. has been specified. At that point in time, the READY output becomes OFF
for an instant due to switching of the job No.

(2) Current counter value setting (Set/Request)


Command Counter 7 bytes
Specifies the counter No. and changes/requests the current counter value as well as the current repetitive marking
Description
count.

Target JOB=0000 to 1999, CTR=0 to 9/A to J,

Command WX,JOB=0000,CTR=0,Counter=A,B[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,CTR=0,Counter[CR]
RX
Response RX,OK,A,B[CR]

A:0000000000 to 4294967295 10 bytes Current counter value


Parameter
B: 0000000000 to 4294967295 10 bytes Repetitive marking count

(3) I/O encoded character (Set/Request)


Command IoEncodedCharacter 18 bytes
Description Sets/Requests the string to use as the I/O encoded character.

Target None

Command WX,IoEncodedCharacter=A[CR]
WX
Response WX,OK [CR]

Command RX,IoEncodedCharacter[CR]
RX
Response RX,OK,A[CR]

Parameter A:00 to 35 2 bytes Specify the I/O encoded character

This command returns a response very quickly as it is processed immediately regardless of the job expansion time.

(4) Request final marking string


Command MarkedCharacter 15 bytes
Description Specify the job No. and block No. to request the string marked by the laser marker.

Target None

Command
WX None
Response

Command RX,MarkedCharacter=A,B[CR]
RX
Response RX,OK,C[CR]

A:0000 to 1999 4 bytes Job No.

Parameter B: 000 to 255 3 bytes Block No.

C: Text - Marking string

• The update characters are returned in the form of an actual marking string.
• Make sure to send this command after the marking. The S029 communication error “Mark data request error” is returned if you send the
command without performing any marking.
• In matrix marking, the response returns the mark data of the last marked cell (block).
• If you requested something in relation to the block other than the character strings, “ “ (blank data) will be returned in the response.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-19


Command Details

(5) Request the error status


Command Error 5 bytes
Description Requests the error occurring in the laser marker.

Target None

Command
WX None
Response

1 RX
Command

Response
RX,Error[CR]

RX,OK,A,B,B,B...[CR]

Displays the status of the errors. If no error is


Communication Interface

A: 0/1 1 byte
occurring, the response returns “0”, if it is, “1”.
Parameter
Displays the currently occurring errors in
B: E003 to E531/W001 to W531/T000 to T017 3 bytes
comma delimited format.

• If multiple errors are occurring in the laser marker, a response is returned in comma delimited format as follows.
RX,OK,1,E001,E002,W100,T000[CR]
• For details of each error, refer to the User's Manual of the laser marker unit.

(6) Clear an error


Command ErrorClear 10 bytes
Description Clears the errors currently occurring in the laser marker.

Target None

Command WX,ErrorClear[CR]
WX
Response WX,OK[CR]

Command
RX None
Response

Parameter None

• An error cannot be cleared unless its cause has been rectified.


• When you send the ErrorClear command with the cause of the laser marker error unresolved, an “OK” response is returned but the error
status will not be cleared.
• Check the ON/OFF state of the terminal block because the error clear cannot be performed for the terminal block error (T*** error except
T000).
• The error clear can be performed for T000 (during remote interlock) if the remote interlock terminal is satisfied.

1-20 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

Controller setup/management
(1) Position correction (Set/Request)
Command AllPosition 11 bytes
Description Sets/Requests the position correction in the Controller Setup.

Target None

WX
Command

Response
WX,AllPosition=A,B,C,D,E,F[CR]

WX,OK [CR]
1

Communication Interface
Command RX,AllPosition[CR]
RX
Response RX,OK,A,B,C,D,E,F[CR]

X rotation angle (°)


A:-090.000 to 0090.000 8 bytes
* Default value “0”

Y rotation angle (°)


B: -090.000 to 0090.000 8 bytes
* Default value “0”

θ angle (°)
C: -180.000 to 0180.000 8 bytes
* Default value “0”

D: Depends on the area size


Normal : -062.500 to 0062.500 X coordinate correction amount (mm)
8 bytes
Parameter Wide :-165.000 to 0165.000 * Default value “0”
Small : -025.000 to 0025.000

E: Depends on the area size


Normal: -062.500 to 0062.500 Y coordinate correction amount (mm)
8 bytes
Other model : “X/Y coordinates position correction” * Default value “0”
in “Model-Specific Input Value List” (Page 1-92)

F: Depends on the area size


Normal : -021.000 to 0021.000 Z correction amount (mm)
8 bytes
Wide :-021.000 to 0021.000 * Default value “0”
Small : -015.000 to 0015.000

• This command is applied to all jobs. If the job pre-expansion function is enabled, it takes time because the response is returned after all
job expansion processings are finished.
• The X/Y rotations angle will be disabled in jobs containing blocks having other than a 3D shape of “XY plane”.
• The following restrictions exist in the case of on-the-fly marking.
• The coordinate correction with the same coordinate on the movement direction (X/Y coordinate) is disabled
• The rotation correction of the coordinate that crosses orthogonally on the movement direction (X/Y rotation angle) is disabled
• θ angle can be corrected up to ±2.000°

(2) Date/time setting (Set/Request)


Command TimeSetting 11 bytes
Description Sets/Requests the date and time of the internal clock.

Target None

Command WX,TimeSetting=A,B,C,D,E,F[CR]
WX
Response WX,OK[CR]

Command RX,TimeSetting[CR]
RX
Response RX,OK,A,B,C,D,E,F[CR]

A:2000 to 2099 4 bytes Year: 4 digits

B: 01 to 12 2 bytes Month

C: 01 to 31 2 bytes Day
Parameter
D: 00 to 23 2 bytes Hour

E: 00 to 59 2 bytes Minute

F: 00 to 59 2 bytes Second

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-21


Command Details

(3) Laser power offset (Set/Request)


Command PowerOffset 11 bytes
Description Sets/Requests the laser power offset in the Unit Setup.

Target None

Command WX,PowerOffset=A[CR]
WX
Response WX,OK[CR]

1 RX
Command

Response
RX,PowerOffset[CR]

RX,OK,A[CR]

Power offset amount (%)


Parameter
Communication Interface

A:-100.0 to 0100.0 6 bytes


* Default value “0”

• If the power offset value set to the block's laser power exceeds 100%, the value will be fixed at 100%.
• This command is applied to all jobs. If the job pre-expansion function is enabled, it takes time because the response is returned after all
job expansion processings are finished.
• This command is not applied to the block whose laser power is 0%.

(4) Set barcode verification


Command BarcodeVerification 19 bytes
This command is used in the barcode verification function. When this command is accepted on the barcode verification
Description screen, the collation string will be associated with the job No. When this command is accepted in Run mode, the
settings will switch to the job No. matching the collation string.

Target None

Command WX,BarcodeVerification=A[CR]
WX
Response WX,OK[CR]

Command
RX None
Response

Barcode verification string (Max. 20


Parameter A: Text -
characters)

You can access Marking Builder Plus barcode verification screen by following the procedure below.
[Settings] tab > [Controller] > [Options] > [Register code] under [Barcode verification]

(5) Set/Request the shutter function as it relates to the laser safety module operation.
Command LaserSafetyModuleShutter 24 bytes
Description Set/Request the shutter to open/close when the laser safety module input is off.

Target None

Command WX,LaserSafetyModuleShutter=A
WX
Response WX,OK

Command RX,LaserSafetyModuleShutter
RX
Response RX,OK,A

Shutter status
0: Do not close the shutter when the safety
Parameter A:0/1 1 byte input is off
1: Close the shutter when the safety input is off
* Default value “0”

When the shutter status turns to “1”, the restoration time from the safety input on will be extended.

(6) Timing of the marking complete output ON (Set/Request)


Command PrintCompTiming 15 bytes
Description Sets/Requests the timing of the marking complete output ON.

Target None

Command WX,PrintCompTiming=A
WX
Response WX,OK

Command RX,PrintCompTiming
RX
Response RX,OK,A

Timing of the marking complete output


0: After completing the marking operation
1: When completing the operation of the
Parameter A:0/1 1 byte
marking verification and 2D code reader
function
* Default value “0”

1-22 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(7) Add a routing table


Command AddRouteTable 13 bytes
Description Adds routing tables used for Ethernet connection.

Target None

Command WX,AddRouteTable=A,B,C[CR]
WX
Response WX,OK[CR]

RX
Command

Response
None
1
A:000.000.000.000 to 255.255.255.254 15 bytes Destination address

Communication Interface
Parameter B:000.000.000.000 to 255.255.255.255 15 bytes Mask setting

C:000.000.000.000 to 255.255.255.255 15 bytes Transfer destination gateway

• Up to four routing tables can be registered. When the registration exceeds the upper limit, an S111 error will be returned.
• The values out of the subnet mask range of the destination address should be set to 0.
• When the same destination address is specified, the table will be overwritten. (This does not apply to the mask setting and transfer
destination gateway.)
• When the destination address is set to 255.255.255.255, an S024 error will occur.
• If the transfer gateway address is not belong to the LAN1 or LAN2 network, an S024 error will occur.

(8) Request the number of routing tables


Command GetRouteTableSettingNum 23 bytes
Description Requests the number of registered routing tables.

Target None

Command
WX None
Response

Command RX,GetRouteTableSettingNum[CR]
RX
Response RX,OK,A[CR]

Parameter A:0 to 4 1 byte No. of registered tables

The number of the registered tables can be acquired.

(9) Request the routing table information


Command GetRouteTableSetting 20 bytes
Description Requests the registered routing table information.

Target None

Command
WX None
Response

Command RX,GetRouteTableSetting=A[CR]
RX
Response RX,OK,B,C,D[CR]

A:0 to 4 1 byte Table index

B:000.000.000.000 to 255.255.255.254 15 bytes Destination address


Parameter
C:000.000.000.000 to 255.255.255.255 15 bytes Mask setting

D:000.000.000.000 to 255.255.255.255 15 bytes Transfer destination gateway

• The information of the registered tables can be acquired. If there are no settings, 0 is returned for all parameters.
• When the value of the table index is out of range, S024 is returned.

(10) Delete a routing table


Command DeleteRouteTable 16 bytes
Description Deletes a routing table.

Target None

Command WX,DeleteRouteTable=A,B[CR]
WX
Response WX,OK[CR]

Command
RX None
Response

A:000.000.000.000 to 255.255.255.254 15 bytes Destination address


Parameter
B:000.000.000.000 to 255.255.255.255 15 bytes Mask setting

• The table that matches the destination address and mask setting will be deleted.
• When 255.255.255.255 is specified for the destination address, an S024 error will occur.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-23


Command Details

(11) Delete all routing tables


Command DeleteAllRouteTable 19 bytes
Description Delete all routing tables.

Target None

Command WX,DeleteAllRouteTable[CR]
WX
Response WX,OK[CR]

1 RX
Command

Response
None

Parameter None None None


Communication Interface

• The information of all registered tables is deleted.

(12) Z timing (Set/Request)


Command ZTiming 7 bytes
Description Sets/Requests the Z timing value.

Target None

Command WX,ZTiming=A,B[CR]
WX
Response WX,OK[CR]

Command RX,ZTiming[CR]
RX
Response RX,OK,A,B[CR]

A:0000 to 4000 4 bytes Z timing value (µs)

Application to matrix setting


Parameter 0: Do not apply the ZTiming setting to the
B:0/1 1 byte matrix setting.
1: Apply the ZTiming setting to the matrix
setting.

For job files that do not include matrix settings, the Z timing value is applied regardless of the parameter B setting.

1-24 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

Job No.
(1) Moving/stationary marking setting (Set/Request)
Command OnTheFly 8 bytes
Description Toggles the stationary/movement marking setting and changes/requests the movement direction.

Target JOB = 0000 to 1999

WX
Command

Response
WX,JOB=0000,OnTheFly=A,B[CR]

WX,OK [CR]
1

Communication Interface
Command RX,JOB=0000,OnTheFly[CR]
RX
Response RX,OK,A,B[CR]

Stationary/Moving marking setting


0: Stationary marking
A:0/1 1 byte
1: Moving marking
* Default value “0”

Moving direction
Parameter Sets the line flow direction.
0: Bottom
B: 0 to 3 1 byte 1: Right
2: Top
3: Left
* A: Fixed value of “0” when 0

The line flow direction will be determined with reference to the direction in which the tip of the laser head is set pointing to the left.

(2) Head orientation (Set/Request)


Command HeadDirection 13 bytes
Description Sets/Requests the head orientation.

Target JOB = 0000 to 1999

Command WX,JOB=0000,HeadDirection=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,HeadDirection[CR]
RX
Response RX,OK,A[CR]

Head orientation
Sets the orientation of the head with reference
to the marking area.
0: left
1: Left (Mirror invert)
2: Right (Mirror invert)
Parameter A:0 to 7 1 bytes
3: Right
4: Bottom (Mirror invert)
5: Top
6: Bottom
7: Top (Mirror invert)
* Default value “0”

(3) Marking order (Set/Request)


Command MarkingOrder 12 bytes
Description Sets/Requests the marking order.

Target JOB = 0000 to 1999

Command WX,JOB=0000,MarkingOrder=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,MarkingOrder[CR]
RX
Response RX,OK,A[CR]

Marking order
0: Group/block no. order
Parameter A:0/1 1 byte
1: Auto
* Default value “0”

This command is only enabled for stationary marking.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-25


Command Details

(4) Continuous stationary marking (Set/Request)


Command ContinuousStationaryMarking 27 bytes
Sets/Requests to enable/disable the function, marking count, and interval of the continuous marking function in
Description
stationary marking.

Target JOB = 0000 to 1999

Command WX,JOB=0000,ContinuousStationaryMarking=A,B,C[CR]
WX

1
Response WX,OK [CR]

Command RX,JOB=0000,ContinuousStationaryMarking[CR]
RX
Response RX,OK,A,B,C[CR]
Communication Interface

Continuous marking setting


1: Disabled
A:1/2 1 byte
2: Enabled
* Default value “1”
Parameter
Continuous marking count (times)
B: 00002 to 65535 5 bytes
* A: Fixed value of “2” when 1

Continuous interval (s)


C: 0000.0 to 0009.9 6 bytes
* A: Fixed value of “0” when 1

This command is only enabled for stationary marking.

(5) Movement parameters (Set/Request)


Command OnTheFlyMarking 15 bytes
Description Sets/Requests the movement parameters of the movement marking function.

Target JOB = 0000 to 1999

Command WX,JOB=0000,OnTheFlyMarking=A,B,C,D[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,OnTheFlyMarking[CR]
RX
Response RX,OK,A,B,C,D[CR]

Moving method
0: Constant
A:0/1 1 byte
1: Encoder
* Default value “0”

B: Depends on the area size Line speed (mm/s)


Normal : 0000.1 to 4000.0 * A: Fixed value of “0.1” when 1
Parameter 6 bytes
Other model : “Line speed” of “Model-Specific * Default value “Normal: 300”/”Wide:
Input Value List” (Page 1-92) 450”/”Small: 150”

C: 0 1 byte Fixed value

Encoder pulse count (Pulse/mm)


D: 001.0 to 200.0 5 bytes * Default value “Normal: 50”/”Wide:
20”/”Small: 100”

This command is only enabled for movement marking.

(6) Movement marking trigger delay (Set/Request)


Command OnTheFlyTriggerDelay 20 bytes
Description Sets/Requests the “distance to the sensor” and “marking position offset” of the movement marking function.

Target JOB = 0000 to 1999

Command WX,JOB=0000,OnTheFlyTriggerDelay=A,B[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,OnTheFlyTriggerDelay[CR]
RX
Response RX,OK,A,B[CR]

Distance to sensor (mm)


A:0000.0 to 1200.0 6 bytes * Default value : “Normal: 62.6”/”Wide:
Parameter 165.1”/”Small: 25.1”

Marking position offset (mm)


B: -1200.0 to 01200.0 7 bytes
* Default value “0”

• This command is only enabled for movement marking.


• Configure the setting such that the sum of “the distance to the sensor” and “marking position offset” is greater than the start position in the
movement range setting. If the movement range setting is disabled, values smaller than the default value will not be accepted.

1-26 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(7) Continuous movement marking (Set/Request)


Command OnTheFlyContinuousMarking 25 bytes
Sets/Requests to enable/disable the function, marking count, and interval of the continuous marking function in
Description
movement marking.

Target JOB = 0000 to 1999

Command WX,JOB=0000,OnTheFlyContinuousMarking=A,B,C[CR]
WX

1
Response WX,OK [CR]

Command RX,JOB=0000,OnTheFlyContinuousMarking[CR]
RX
Response RX,OK,A,B,C[CR]

Communication Interface
Continuous marking setting
0: Mark while trigger ON
A:0/1/2 1 bytes 1: Continuous marking disabled
2: Continuous marking enabled
* Default value “1”
Parameter
Continuous marking count (times)
B: 00002 to 65535 5 bytes
* A: Fixed value of “2” when 0/1

Continuous interval (mm)


C: 0000.1 to 1200.0 6 bytes
* A: Fixed value of “100” when 1

This command is only enabled for movement marking.

(8) Marking range setting (Set/Request)


Command OnTheFlyMarkingArea 19 bytes
Sets/Requests to enable/disable the function, start position, and end position of the marking range setting of the
Description
movement marking function.

Target JOB = 0000 to 1999

Command WX,JOB=0000,OnTheFlyMarkingArea=A,B,C[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,OnTheFlyMarkingArea[CR]
RX
Response RX,OK,A,B,C[CR]

Marking range setting


0: Disabled
A:0/1 1 byte
1: Enabled
* Default value “0”

B: Depends on the area size


Start position (mm)
Normal : -062.500 to 0062.500
Parameter 8 bytes * Default value : “Normal: 31.25”/”Wide:
Other model : “Start position” of “Model-Specific
82.5”/”Small: 12.5”
Input Value List” (Page 1-92)

C: Depends on the area size


End position (mm)
Normal : -062.500 to 0062.500
8 bytes * Default value : “Normal: -31.25”/”Wide:
Other model : “End position” of “Model-Specific
-82.5”/”Small: -12.5”
Input Value List” (Page 1-92)

This command is only enabled for movement marking.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-27


Command Details

(9) Workpiece position adjustment (Plane) (Set/Request)


Command JobPosition 15 bytes
Description Sets/Requests the correction inside the horizontal plane in the workpiece position adjustment.

Target JOB = 0000 to 1999

Command WX,JOB=0000,JobPosition=A,B,C,D,E[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,JOB=0000,JobPosition[CR]

RX,OK,A,B,C,D,E[CR]

A: Depends on the area size


Communication Interface

Normal : -062.500 to 0062.500


Movement reference point X(mm)
Other model : “Movement reference point X/ 8 bytes
* Default value “0”
Y coordinates” of “Model-Specific Input Value List”
(Page 1-92)

B: Depends on the area size


Normal : -062.500 to 0062.500
Movement reference point Y(mm)
Other model : “Movement reference point X/ 8 bytes
* Default value “0”
Y coordinates” of “Model-Specific Input Value List”
(Page 1-92)
Parameter
C: Depends on the area size
Normal : -062.500 to 0062.500 X coordinate correction amount (mm)
8 bytes
Wide : -165.000 to 0165.000 * Default value “0”
Small : -025.000 to 0025.000

D: Depends on the area size


Normal : -125.000 to 0125.000 Y coordinate correction amount (mm)
8 bytes
Other model : “Correction amount X/Y” of “Model- * Default value “0”
Specific Input Value List” (Page 1-92)

θ angle correction amount (°)


E: -180.000 to 0180.000 8 bytes
* Default value “0”

• The θ angle correction is performed, where the origin is the position where the correction amount has been applied to the movement
reference point.
• Workpiece position adjustment is only enabled for stationary marking.

(10) Height correction (Set/Request)


Command HeightCorrection 16 bytes
Description Sets/Requests the correction method and setting values for the workpiece position correction in the height direction.

Target JOB = 0000 to 1999

Command WX,JOB=0000,HeightCorrection=A,B,C,D,E,F[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,HeightCorrection[CR]
RX
Response RX,OK,A,B,C,D,E,F[CR]

Height correction method


0: Fixed
A:0/6 1 byte
6: Auto focus (MD-X2050(A) only)
* Default value “0”

B: Depends on the area size


Correction amount Z coordinate (mm)
Normal : -21.000 to 021.000
7 bytes * A: Fixed value of “0” when 5/6
Wide : -21.000 to 021.000
* Default value “0”
Small : -15.000 to 015.000

Measurement count (times)


C: 1 to 9 1 byte * A: Fixed value of “3” when 0
* Default value “3”

Parameter D: Depends on the area size


Upper tolerance limit (mm)
Normal : -20.999 to 042.000
7 bytes * A: Fixed value of “21” when 0
“Upper tolerance limit” of “Model-Specific Input
* Default value “21”
Value List” (Page 1-92)

E: Depends on the area size


Lower tolerance limit (mm)
Normal : -20.999 to 042.000
7 bytes * A: Fixed value of “-21” when 0
“Lower tolerance limit” of “Model-Specific Input
* Default value “-21”
Value List” (Page 1-92)

If out of range,
1: Mark (warning output)
F: 1/2 1 byte 2: Do not mark (error output)
* A: Fixed value of “1” when 0
* Default value “1”

1-28 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(11) Common block marking parameters (Set/Request)


Command CommonMarkingParameter 22 bytes
Description Sets/Requests the common block marking parameters that can be used commonly in jobs.

Target JOB = 0000 to 1999

Command WX,JOB=0000,CommonMarkingParameter=A,B,C,D,E,F,G,H,I,J,K,L[CR]
WX
Response WX,OK [CR]

RX
Command

Response
RX,JOB=0000,CommonMarkingParameter[CR]

RX,OK,A,B,C,D,E,F,G,H,I,J,K,L[CR] 1
Common laser power (%)

Communication Interface
A:000.0 to 100.0 5 bytes
* Default value “0”

B: Depends on the area size


Normal : 00001 to 12000 Common scan speed (mm/s)
5 bytes
Other model : “Scan speed” of “Model-Specific * Default value “1000”
Input Value List” (Page 1-92)

C: Differs depending on the model


Normal : 000 to 400 Common pulse frequency (kHz)
3 bytes
Other model : “Pulse frequency” of “Model- * Default value “100”
Specific Input Value List” (Page 1-92)

D: Depends on the area size


Normal : 0210 to 0210 Common spot variable
4 bytes
Other model : “Spot variable” of “Model-Specific * Default value “0”
Input Value List” (Page 1-92)

Common marking count (times)


E:001 to 100 3 bytes
* Default value “1”

F: Depends on the area size


Normal : -021.000 to 0021.000 Common Z coordinate (mm)
8 bytes
Wide :-021.000 to 0021.000 * Default value “0”
Parameter Small : -015.000 to 0015.000

Common fill interval (mm)


G: 0.000 to 1.000 5 bytes
* Default value “0.06”

Common quality level


00: Top speed
01: Speed priority
02: Standard
H: 00 to 04/06 2 bytes
03: High quality
04: Top quality
06: Top speed 2
* Default value “2”

Common skip cross (mm)


I: 00.000 to 10.000 6 bytes
* Default value “0”

End Point Control:


J: 0/1 1 byte 0: Optimize
1: Any value

End Point ON Control (%)


K: 000 to 200 3 bytes
* Fixed value “100”

End Point OFF Control (%)


L: 000 to 200 3 bytes
* Fixed value “100”

The fixed value is input for the end point control. It cannot be changed.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-29


Command Details

(12) Marking energy check (Set/Request)


Command MarkingEnergy 13 bytes
Description Sets/Requests the ON/OFF of the marking energy check function and the threshold setting.

Target JOB = 0000 to 1999

Command WX,JOB=0000,MarkingEnergy=A,B,C,D[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,JOB=0000,MarkingEnergy[CR]

RX,OK,A,B,C,D[CR]

Lower limit threshold


Communication Interface

0: Disabled
A:0/1 1 byte
1: Enabled
* Default value “0”

Upper limit threshold


0: Disabled
Parameter B:0/1 1 byte
1: Enabled
* Default value “0”

Lower limit threshold (J)


C: 00000.01 to 99999.99 8 bytes
* A: Fixed value of “0.01” when 0

Upper limit threshold (J)


D: 00000.01 to 99999.99 8 bytes
* B: Fixed value of “0.01” when 0

• Marking energy check will be canceled when the next trigger is accepted within 2 seconds of completion of the marking. Therefore, make
sure to allow at least 2 seconds between the marking completion and the next marking start.
• It cannot be used on the MD-X400(A)/450(A) series.

(13) Scanner waiting position when ready (Set/Request)


Command ScannerWaiting 14 bytes
Description Sets/Requests the scanner waiting position when ready.

Target JOB = 0000 to 1999

Command WX,JOB=0000,ScannerWaiting=A,B,C,D[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,ScannerWaiting[CR]
RX
Response RX,OK,A,B,C,D[CR]

Standby coordinate
0: Auto
A:0/1 1 byte
1: Custom coordinate
* Default value “0”

B: Depends on the area size


Normal : -062.500 to 0062.500 Standby X coordinate (mm)
8 bytes
Wide :-165.000 to 0165.000 * A: Fixed value of “0” when 0
Small : -025.000 to 0025.000
Parameter
C: Depends on the area size
Normal : -062.500 to 0062.500 Standby Y coordinate (mm)
8 bytes
Other model : “Y coordinate” of “Model-Specific * A: Fixed value of “0” when 0
Input Value List” (Page 1-92)

D: Depends on the area size


Normal : -021.000 to 0021.000 Standby Z coordinate (mm)
8 bytes
Wide :-021.000 to 0021.000 * A: Fixed value of “0” when 0
Small : -015.000 to 0015.000

When setting the standby coordinate to auto, standby is done on the coordinate where the scanner will be used firstly at work flow.

1-30 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(14) Camera magnification when ready (Set/Request)


Command CameraWaitingScale 18 bytes
Description Sets/Requests the camera magnification during standby.

Target None

Command WX,JOB=0000,CameraWaitingScale=A[CR]
WX
Response WX,OK[CR]

RX
Command

Response
RX,JOB=1000,CameraWaitingScale[CR]

RX,OK,A 1
Camera magnification

Communication Interface
0: Fixed camera (Wide)
Parameter A:0 to 3 1 byte 1 Fixed camera (Standard)
2: Coaxial Camera (Wide)
3: Coaxial Camera (Standard)

• The fixed camera cannot be selected for the MD-X2050(A). If the command is executed, an S024 Illegal Command Error will occur.
• This command cannot be used for the MD-X400(A)/450(A). If the command is executed, an S095 Model Limitation Error will occur.
• When the camera magnification is set with the CameraWaitingScale command, the lighting conditions specified in the job settings are
applied, so it is recommended to set these conditions with the CameraWaitingLight command.

(15) Internal lighting status when ready (Set/Request)


Command CameraWaitingLight 18 bytes
Description Sets/Requests the status of the internal lighting during standby.

Target JOB=0000 to 1999

Command WX,JOB=0000,CameraWaitingLight=A[CR]
WX
Response WX,OK[CR]

Command RX,JOB=0000,CameraWaitingLight[CR]
RX
Response RX,OK,A[CR]

Lighting status of the internal lighting


Parameter A:0/1 1 byte 0: Off
1: On

This command cannot be used for the MD-X2050(A)/400(A)/450(A). If the command is executed, an S095 Model Limitation Error will occur.

(16) External lighting status when ready (Set/Request)


Command CameraWaitingExternalLight 26 bytes
Description Sets/Requests the status of the internal lighting during standby.

Target JOB=0000 to 1999

Command WX,JOB=0000,CameraWaitingExternalLight=A[CR]
WX
Response WX,OK[CR]

Command RX,JOB=0000,CameraWaitingExternalLight[CR]
RX
Response RX,OK,A[CR]

Lighting status of the external lighting


Parameter A:0/1 1 byte 0: Off
1: On

When the lighting status of the external lighting is set to On, terminal number 40, External Lightning Control Output, turns on during standby.

(17) Type of lighting for the running job (Set/Request)


Command LightingType 12 bytes
Description Sets/Requests the type of lighting set by a job during operation.

Target JOB = 0000 to 1999

Command WX,JOB=0000,LightingType=A
WX
Response WX,OK

Command RX,JOB=0000,LightingType
RX
Response RX,OK,A

* Type of lightings at normal


0: Internal lighting
Parameter A:0/1/2 1 byte
1: Internal lighting (halation removal)
2: External lighting

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-31


Command Details

(18) Approach scan speed (Set/Request)


Command ApproachScanSpeed 17 bytes
Description Sets/Requests the approach scan speed.

Target JOB = 0000 to 1999

Command WX,JOB=0000,ApproachScanSpeed=A[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,JOB=0000,ApproachScanSpeed[CR]

RX,OK,A[CR]

A: Depends on the area size


Communication Interface

Normal : 00000 to 04000 Approach scan speed (mm/s)


Parameter 5 bytes
Other model : “Approach scan speed” of “Model- * Default value “1000”
Specific Input Value List” (Page 1-92)

1-32 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

String/Logo/Barcode setting
(1) Block type (Set/Request)
Command BlockType 9 bytes
Description Sets/Requests the block type.

Target JOB=0000 to 1999,BLK=000 to 255

WX
Command

Response
WX,JOB=0000,BLK=000,BlockType=A[CR]

WX,OK [CR]
1

Communication Interface
Command RX,JOB=0000,BLK=000,BlockType[CR]
RX
Response RX,OK,A[CR]

Block type
-04: Hatch logo
-03: Photo
-02: Workpiece image logo
-01: Logo
Parameter A:-04 to 004/009 3 bytes 000: Horizontal characters
001 :Vertical characters
002: Arc clockwise
003: Arc counterclockwise
004: Fixed Point
009: Barcode, 2D code

• When creating a new block, send this command to a non-registered block No.
• When you change the block type, the association with the 3D shape No. and the X/Y/Z coordinate layout information will be initialized.
• Fixed point is only supported in stationary marking.
• When the changing command is sent, the character string becomes (a) space(s).

(2) Barcode type (Set/Request)


Command CodeType 8 bytes
Description Sets/Requests the barcode type.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,CodeType=A[CR]
WX
Response WX,OK[CR]

Command RX,JOB=0000,BLK=000,CodeType[CR]
RX
Response RX,OK,A[CR]

Barcode type
01: CODE39
02: ITF
03: 2of5
04: NW7
05: JAN
06: CODE128
07: QR Code Model 1
08: QR Code Model 2
09: Micro QR Code
Parameter A:01 to 16 2 bytes
10: DataMatrix ECC200
11: GS1 DataBar(Truncated)
12: GS1 DataBar(Truncated) CC-A
13: GS1 DataBar Stacked
14: GS1 DataBar Stacked CC-A
15: GS1 DataBar Limited
16: GS1 DataBar Limited CC-A
17: GS1 DataMatrix
18: CODE93
* Default value “1”

This command can be sent to a block No. having the block type (BlockType) of “09: Barcode/2D Code”.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-33


Command Details

(3) String and logo files (Set/Request)


Command CharacterString 15 bytes
Description Sets/Requests the string or logo/photo file.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,CharacterString=A[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,JOB=0000,BLK=000,CharacterString[CR]

RX,OK,A[CR]

• If the block type is “-4 to -1”, the parameters


Communication Interface

are sent in the following format:


Logo: %L<File name>
External character %F<File name>
Workpiece image: %K<File name>
Hatch logo: %T<File name>
Photo: %Z<File name>
Parameter A: String/Logo file name - Grayscale photo: %I<File name>
High resolution photo: %X<File name>
• If the block type is “0 to 3”, send the
parameter in string format (in less than 510
single-byte or double-byte characters).
• If the block type is “9”, send a string that
adheres to the barcode/2D code character
input rules.

1-34 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

• This command can be sent to a block No. having the block type (BlockType) of “-4: Hatch logo/-3: Photo/-2: Workpiece image/-1: Logo/00:
Horizontal characters/01: Vertical characters/02: Arc clockwise/03: Arc counterclockwise/09: Barcode/2D Code”.
• To send a “, (comma)” as a string, send it in the form of “%044A” (ASCII).
• To send a “%” as a string, send it in the form of “%%” (ASCII).
• To set update characters, send the following in ASCII format.

Without zero suppression With zero suppression


Type Encoding
Without expiration With expiration Without expiration With expiration

1
Year: 4 digits None %4Y %4T Y - -
None %2Y %2T Y -
Year: 2 digits
yes %2P Y %2P T Y

Communication Interface
None %1Y %1T Y
Year: 1 digits - -
yes %1P Y %1P T Y
Right-aligned Right-aligned
%2M %2T M
None %02M %02T M
Month Left-aligned Left-aligned
%-2M %-2T M
yes %2P M %2P T M - -
Right-aligned Right-aligned
%2D %2T D
None %02D %02T D
Day Left-aligned Left-aligned
%-2D %-2T D
yes %2P D %2P T D - -
Right-aligned Right-aligned
%2h %2T h
None %02h %02T h
Hour Left-aligned Left-aligned
%-2h %-2T h
yes %2P h %2P T h - -
Right-aligned Right-aligned
%2m %2T m
None %02m %02T m
Minute Left-aligned Left-aligned
%-2m %-2T m
yes %2P m %2P T m - -
Right-aligned
%2s
Second None %02s
Left-aligned
%-2s
Right-aligned Right-aligned
%3X %3T X
None %03X %03T X
365 days Left-aligned Left-aligned
%-3X %-3T X
yes %3P X %3P T X - -
None %1B %1T B - -
Day of week
yes %1P B %1P T B -
Week yes %2P W %2P T W - -
Time zone yes %P S - -

I/O encoded None %1R - -


character yes %1P R - - -

is the encoding No. (0 to 9) and is the expiration No. (0 to 9).

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-35


Command Details

• To set a counter, send the following in ASCII format.

Encoding
Type Zero suppression Padding Alignment
yes None

None - - %0 P C C %0 C C
Auto - %P C C %C C
Serial counter
yes Right-aligned % P C C % C C
Specify Digits

1
Left-aligned %- P C C %- C C

● is the encoding No. (0 to 9), ■ is the counter No. (0 to 9, A to J), and ▲ is the No. of digits (1 to 10).

• To set a link, send the following in ASCII format.


Communication Interface

Reference Reference parameters Setting code

GS1 DataBar %H< 1>


GS1 DataBar & CC-A
CC-A %H< 2>
Add check digit %H< C>
Barcode Add start-stop character %H< *>
Add check digit & Add start-stop character %H< C*>
Entire encoded string %H< 00A>
GS1 DataMatrix Specify AI number (AI added) %H< A>
Specify AI number (AI not added) %H< >
Other blocks - %H< >

is the block No. (000 to 255) and is the referenced AI number (Nth AI).
The range specification options add the following before the “>” symbol.
“SxxxLxxx”: S is set with the start position, L is set with the number of reference characters, and XXX is set with the number of characters
(001 to 510).

• Send the following by ASCII when a control code is set to the barcode or 2D code.

Control code Setting code Control code Setting code Control code Setting code

NUL %000A CR %013A SUB %026A


SOH %001A SO %014A ESC %027A
STX %002A SI %015A FS %028A
ETX %003A DLE %016A GS %029A
EOT %004A DC1 %017A RS %030A
ENQ %005A DC2 %018A US %031A
ACK %006A DC3 %019A DEL %127A
BEL %007A DC4 %020A FNC1 %901A
BS %008A NAK %021A FNC2 %902A
HT %009A SYN %022A FNC3 %903A
LF %010A ETB %023A FNC4 %904A
VT %011A CAN %024A
FF %012A EM %025A

1-36 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(4) Font setting (Set/Request)


Command CharacterFont 13 bytes
Description Sets/Requests the font No., line type, line width, line count, and overlap rate used in a string.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,CharacterFont=A,B,C,D,E,F[CR]
WX
Response WX,OK [CR]

RX
Command

Response
RX,JOB=0000,BLK=000,CharacterFont[CR]

RX,OK,A,B,C,D,E,F[CR] 1
Font No.

Communication Interface
-1: Quick
00: Standard
A:00 to 11 2 bytes 01: Small
02 to 11: User font
* Quick: Available on only MD-U1000 series
* Default value “0”

Line type
0: Single
B: 0 to 2 1 byte 1: Multiple
2: Wobble
* Default value “0”

C: Depends on the area size Thickness (mm)


Parameter Normal : 0.010 to 5.000 * B: Fixed value of “0.1” when 0
5 bytes
Other model : “Line width” of “Model-Specific * Default value “Normal: 0.2”/”Wide:
Input Value List” (Page 1-92) 0.3”/”Small: 0.1”

Auto number of lines


0: Any value
D:0/1 1 byte 1: Auto
* B: Fixed value of “0” when 0
* Default value “0”

Number of multiples (lines)


E:002 to 100 3 bytes * D: Fixed value of “2” when 1
* Default value “4”

Overlap rate (%)


F: 75.0 to 98.0 4 bytes * B: Fixed value of “80” when other than 2
* Default value “80”

• This command can be sent to a block No. having the block type (BlockType) of “00: Horizontal characters/01: Vertical characters/02: Arc
clockwise/03: Arc counterclockwise”. Cannot be sent to the block of TrueTypeFont.
• Multiple and Wobble thicknesses can be set to a ratio of up to x0.2 compared to the smaller character height or width.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-37


Command Details

(5) Character size (Set/Request)


Command CharacterSize 13 bytes
Description Sets/Requests the height, width, character layout, space, and full width/full height of a string.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,CharacterSize=A,B,C,D,E,F[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,JOB=0000,BLK=000,CharacterSize[CR]

RX,OK,A,B,C,D,E,F[CR]

A: Depends on the area size


Communication Interface

Normal : 000.100 to 125.000 Height (mm)


7 bytes
Other model : “Height/Width” of “Model-Specific * Default value “3”
Input Value List” (Page 1-92)

B: Depends on the area size


Normal : 000.100 to 125.000 Character width (mm)
7 bytes
Other model : “Height/Width” of “Model-Specific * Default value “2”
Input Value List” (Page 1-92)

Character Layout
0: Character space
C:0/1/3 1 byte
1: Distribute
3: Character pitch
Parameter
D: Depends on the area size
Normal : 000.000 to 180.000 Space (mm)
8 bytes
Other model : “Character space” of “Model- * Default value “0.5”
Specific Input Value List” (Page 1-92)

E: Depends on the area size


Normal : 000.100 to 180.000 Full width/Full height (mm)
7 bytes
Other model : “Character full width/full height” of * Default value “7”
“Model-Specific Input Value List” (Page 1-92)

F: Depends on the area size


Normal : 000.000 to 180.000 Character pitch
7 bytes
Other model : “Character pitch” of “Model-Specific * Default value “0”
Input Value List” (Page 1-92)

• This command can be sent to a block No. having the block type (BlockType) of “00: Horizontal characters/01: Vertical characters/02: Arc
clockwise/03: Arc counterclockwise”.
• You can only set the character height/width ratio between x0.2 and x5.
• The character width and character spacing cannot be set when the ratio specification or proportional is enabled and when the font is a
TrueTypeFont. Also, they cannot be set when the character spacing of C is other than 0.
• C to F: Cannot be set when the character string is circle layout.
• The character pitch can be set for a TrueType font only.

(6) Logo size (Set/Request)


Command LogoSize 8 bytes
Description Sets/Requests the height and width of a logo (including hatch logo and workpiece image logo).

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,LogoSize=A,B[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,LogoSize[CR]
RX
Response RX,OK,A,B[CR]

A: Depends on the area size


Logo height (mm)
Normal : 000.002 to 125.000
7 bytes * Default value depends on the original DXF
Other model : “Logo Height/Width” of “Model-
size
Specific Input Value List” (Page 1-92)
Parameter
B: Depends on the area size
Logo width (mm)
Normal : 000.002 to 125.000
7 bytes * Default value depends on the original DXF
Other model : “Logo Height/Width” of “Model-
size
Specific Input Value List” (Page 1-92)

• This command can be sent to a block No. having the block type (BlockType) of “-4: Hatch logo/-2: Workpiece image/-1: Logo”.
• When the aspect ratio is maintained, the logo height is set automatically based on the value of the logo width.

1-38 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(7) String proportional setting (Set/Request)


Command CharacterProportional 21 bytes
Description Sets/Requests the enable/disable of the proportional function and the minimum character width of a string.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,CharacterProportional=A,B[CR]
WX
Response WX,OK [CR]

RX
Command

Response
RX,JOB=0000,BLK=000,CharacterProportional[CR]

RX,OK,A,B[CR] 1
Proportional setting

Communication Interface
0: Disabled
A:0/1 1 byte
1: Enabled
Parameter * Default value “0”

Minimum character width (%)


B: 000 to 100 3 bytes * A: Fixed value of “20” when 0
* Default value “20”

This command can be sent to a block No. having the block type (BlockType) of “00: Horizontal characters/02: Arc clockwise/03: Arc
counterclockwise”.

(8) String ratio setting (Set/Request)


Command CharacterRatio 14 bytes
Description Sets/Requests the enable/disable of string ratio setting and the width and space ratios of a string.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,CharacterRatio=A,B,C[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,CharacterRatio[CR]
RX
Response RX,OK,A,B,C[CR]

Ratio setting
0: Disabled
A:0/1 1 byte
1: Enabled
* Default value “0”

Character width ratio (%)


* A: Fixed value of “20” when 0
B: 020.00 to 500.00 6 bytes
Parameter * Default value “66.67” if the character type is
system font and “100” if it is a TrueType font

Character space ratio (%)


C: Depends on the block type
* A: Fixed value of “0” when 0
Horizontal characters/Vertical characters: -100.00 to
7 bytes * Default value “25” when the system font,
1000.00
circle layout, and character layout are
Arc (counter) clockwise string: 0000.00 to 1000.00
“character spacing,” and “0” for others.

• This command can be sent to a block No. having the block type (BlockType) of “00: Horizontal characters/01: Vertical characters/02: Arc
clockwise/03: Arc counterclockwise”.
• The ratio specification cannot be set in the case of TrueTypeFont.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-39


Command Details

(9) Arc string character layout setting (Set/Request)


Command ArcCharacter 12 bytes
Description Sets/request the character layout, radius, space, character angle space, and open angle of an arc string.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,ArcCharacter=A,B,C,D,E[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,JOB=0000,BLK=000,ArcCharacter[CR]

RX,OK,A,B,C,D,E[CR]

Arc character layout


Communication Interface

0: Character space
A:0 to 2 1 bytes 1: Angular interval
2: Distribute angle
* Default value “0”

Arc radius (mm)


B: 000.001 to 9999.99 7 bytes
* Default value “20”

C: Depends on the area size


Arc character space (mm)
Parameter Normal : 000.000 to 180.000
7 bytes * A: Fixed value of “0” when other than 0
Other model : “Arc character space” of “Model-
* Default value “0.5”
Specific Input Value List” (Page 1-92)

Arc character angle space (°)


D: 000.000 to 359.999 7 bytes * A: Fixed value of “0” when other than 1
* Default value “10”

Arc open angle (°)


E: 000.000 to 359.999 7 bytes * A: Fixed value of “0” when other than 2
* Default value “120”

This command can be sent to a block No. having the block type (BlockType) of “02: Arc clockwise/03: Arc counterclockwise”.

1-40 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(10) Barcode/2D code setting (Set/Request)


Command CodeSetting 11 bytes
Sets/Requests the format, check digit setting, DataMatrix 06 macro setting, and QR Code error correction rate of a
Description
barcode/2D code.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,CodeSetting=A,B,C,D[CR]
WX

1
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,CodeSetting[CR]
RX
Response RX,OK,A,B,C,D[CR]

Communication Interface
Format
0: Normal
A:0/1/2 1 byte 1: Black/White inversion
2: Overprinting
* Default value “0”

Check Digit
0: None
1: Yes
B:0/1 1 byte
* Fixed value of “0” when the code type is
other than CODE39/ITF/NW7
* Default value “0”

DataMatrix 06 macro
0: None
Parameter 1: Add
C:0/1 1 byte
* Fixed value of “0” when the code type is
other than DataMatrix ECC200
* Default value “0”

QR Code error correction rate


0: L (7%)
1: M(15%)
2: Q(25%)
3: H (30%)
D:0/1/2/3 1 byte
* Fixed value of “0” when the code type is
other than QR Model 1/2 or Micro QR
* Default value “3” when the code type is QR
model 1/2, “2” when micro QR, and “0” for
others.

• This command can be sent to a block No. having the block type (BlockType) of “09: Barcode/2D Code”.
• If “Overprinting” is selected as the format, overprinting No.0 will be assigned to “Base” and overprinting No.1 will be assigned to “Code”,
respectively. Then, set the overprinting marking parameters (MultiPassMarkingParameter), overprinting pattern (MultiPassPattern), and
overprinting fill parameters (MultiPassFillParameters).
• If you set the format to “Normal or Black/White Inversion”, the parameters in all overprinting No. will be initialized.
• The format of “2: Overprinting” cannot be selected in the case of JAN/EAN/UPC/GS1 DataBar.
• The error correction proportion of a QR code cannot be set to H (30%) in the case of the micro QR.

(11) Barcode size (Set/Request)


Command BarcodeSize 11 bytes
Description Sets/Requests the height, narrow bar, bar ratio, and quiet zone width of a barcode.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,BarcodeSize=A,B,C,D[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,BarcodeSize[CR]
RX
Response RX,OK,A,B,C,D[CR]

A: Depends on the area size


Normal : 000.200 to 125.000 Barcode height (mm)
7 bytes
Other model : “Barcode height” of “Model-Specific * Default value “5”
Input Value List” (Page 1-92)

Narrow bar (mm)


Parameter B: 00.010 to 10.000 6 bytes
* Default value “0.2”

Bar ratio (x)


C: 002.0 to 004.0 5 bytes
* Default value “2.5”

Quiet zone (x)


D: 01 to 99 2 bytes
* Default value “10”

• This command can be sent to a block No. having the block type (BlockType) of “09: Barcode/2D Code” AND barcode type (CodeType) of
“01: CODE39/02: ITF/03: 2of5/04: NW7/05: JAN/06: CODE128/18: CODE93”.
• The bar ratio cannot be set in the case of JAN/EAN/UPC/CODE93/CODE128.
• The quiet zone cannot be set when the format is “Normal.”

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-41


Command Details

(12) GS1 DataBar size (Set/Request)


Command GS1DataBarSize 14 bytes
Sets/Requests the module width, linear code height, separator height, 2D module height, guard width, and quiet zone
Description
width of GS1 DataBar.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,GS1DataBarSize=A,B,C,D,E,F[CR]
WX

1
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,GS1DataBarSize[CR]
RX
Response RX,OK,A,B,C,D,E,F[CR]
Communication Interface

Module width (mm)


A:00.010 to 10.000 6 bytes
* Default value 0.25

B: Depends on the area size Linear code height (mm)


Normal : 000.200 to 125.000 * Default value “8.25” for GS1 DataBar
7 bytes
Other model : “Linear code height” of “Model- Truncated, “3” for GS1 DataBar Stacked
Specific Input Value List” (Page 1-92) and “2.5” for GS1 DataBar Limited

Separator height (mm)


* Fixed value of “0.25” when the barcode
C: 0.010 to 5.000 5 bytes type is GS1 DataBar (Truncated) and GS1
Parameter DataBar Limited.
* Default value “0.25”

2D module height (mm)


* Fixed value of “0.5” when the barcode type
D: 0.010 to 5.000 5 bytes
is other than CC-A
* Default value “0.5”

Guard (x)
E:00 to 10 2 bytes
* Default value “0”

Quiet zone (x)


F: 01 to 50 2 bytes
* Default value “1”

• This command can be sent to a block No. having the block type (BlockType) of “09: Barcode/2D Code” AND barcode type (CodeType) of “11
to 16: GS1 DataBar”.
• The guard can be set when the format is “Black/white inversion.”
• The quiet zone can be set when CC-A and the format is “Black/white inversion.”

(13) DataMatrix size (Set/Request)


Command DataMatrixSize 14 bytes
Description Sets/Requests the symbol size, cell size, and quiet zone width of DataMatrix.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,DataMatrixSize=A,B,C[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,DataMatrixSize[CR]
RX
Response RX,OK,A,B,C[CR]

Symbol size
0001:10x10 0020:16x48 0033:8 x 80
0004:16x16 0023:72x72 0034:8 x 96
0007:22x22 0026:96x96 0035:8 x 120
0010:32x32 0029:132x132 0036:8 x 144
0013:44x44 0003:14x14 0037:12 x 64
0016:8x32 0006:20x20 0038:12 x 88
0019:16x36 0009:26x26 0039:16 x 64
A:0001 to 0030 4 bytes 0022:64x64 0012:40x40 0040:20 x 36
0025:88x88 0015:8x18 0041:20 x 44
Parameter 0028:120x120 0018:12x36 0042:20 x 64
0002:12x12 0021:52x52 0043:22 x 48
0005:18x18 0024:80x80 0044:24 x 48
0008:24x24 0027:104x104 0045:24 x 64
0011:36x36 0030:144x144 0046:26 x 40
0014:48x48 0031:8 x 48 0047:26 x 48
0017:12x16 0032:8 x 64 0048:26 x 64
Cell size (mm)
B: 00.010 to 05.000 6 bytes
* Default value “0.2”

Quiet zone (x)


C: 01 to 05 2 bytes
* Default value “1”

• This command can be sent to a block No. having the block type (BlockType) of “09: Barcode/2D Code” AND barcode type (CodeType) of
“10: DataMatrix, 17: GS1 DataMatrix”.
• The quiet zone cannot be set when the format is “Normal.”

1-42 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(14) DataMatrix cell size ratio in X direction (Set/Request)


Command DataMatrixCellSizeRatioX 24 bytes
Description Set or request the DataMatrix cell size ratio in the X direction

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,DataMatrixCellSizeRatioX=A[CR]
WX
Response WX,OK[CR]

RX
Command

Response
RX,JOB=0000,BLK=000,DataMatrixCellSizeRatioX[CR]

RX,OK,A[CR] 1
Parameter A:050.0 to 200.0 5 bytes Ratio (%)

Communication Interface
• This command can be sent to a block No. having the block type (BlockType) of “09: Barcode/2D Code” AND barcode type (CodeType) of
“10: DataMatrix, 17: GS1 DataMatrix”.

(15) DataMatrix cell size ratio in Y direction (Set/Request)


Command DataMatrixCellSizeRatioY 24 bytes
Description Set or request the DataMatrix cell size ratio in the Y direction

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,DataMatrixCellSizeRatioY=A[CR]
WX
Response WX,OK[CR]

Command RX,JOB=0000,BLK=000,DataMatrixCellSizeRatioY[CR]
RX
Response RX,OK,A[CR]

Parameter A:050.0 to 200.0 5 bytes Ratio (%)

• This command can be sent to a block No. having the block type (BlockType) of “09: Barcode/2D Code” AND barcode type (CodeType) of
“10: DataMatrix, 17: GS1 DataMatrix”.

(16) QR Code size (Set/Request)


Command QRCodeSize 10 bytes
Description Sets/Requests the version, cell size, and quiet zone width of QR Code.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,QRCodeSize=A,B,C,D[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,QRCodeSize[CR]
RX
Response RX,OK,A,B,C,D[CR]

Version
1: 1/M1 2: 2/M2 3: 3/M3
4: 4/M4 5: 5/M5 6: -/M6
7: -/M7 8: -/M8 9: -/M9
10: -/M10 11: -/M11 12: -/M12
13: -/M13 14: -/M14 15: -/M15
16: -/M16 17: -/M17 18: -/M18
A:0001 to 0030 4 bytes
19: -/M19 20: -/M20 21: -/M21
22: -/M22 23: -/M32 24: -/M24
25: -/M25 26: -/M26 27: -/M27
28: -/M28 29: -/M29 30: -/M30
Parameter * Default value “0”
* The input range for Model 1 is “0 to 14”
* The input range for Micro QR is “0 to 4”

Cell size (mm)


B: 00.010 to 05.000 6 bytes
* Default value “0.2”

Mode Auto
0: Disabled
C:0/1 1 byte
1: Enabled
* Default value “1”

Quiet zone (x)


D: 01 to 05 2 bytes * Default value “4” for QR Code Model 1/2, “2”
for Micro QR Code

• This command can be sent to a block No. having the block type (BlockType) of “09: Barcode/2D Code” AND barcode type (CodeType) of
“07: QR Model 1/08: QR Model 2/09: Micro QR”.
• The mode AUTO cannot be set in the case of the micro QR.
• The quiet zone can be set when the format is “Black/white inversion.”

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-43


Command Details

(17) QR code cell size ratio in X direction (Set/Request)


Command QRCodeCellSizeRatioX 20 bytes
Description Set or request the QR cell size ratio in the X direction

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,QRCodeCellSizeRatioX=A[CR]
WX
Response WX,OK[CR]

1 RX
Command

Response
RX,JOB=0000,BLK=000,QRCodeCellSizeRatioX[CR]

RX,OK,A[CR]

Parameter A:050.0 to 200.0 5 bytes Ratio (%)


Communication Interface

• This command can be sent to a block No. having the block type (BlockType) of “09: Barcode/2D Code” AND barcode type (CodeType) of
“07: QR Model 1/08: QR Model 2/09: Micro QR”.
• The mode AUTO cannot be set in the case of the micro QR.

(18) QR code cell size ratio in Y direction (Set/Request)


Command QRCodeCellSizeRatioY 20 bytes
Description Set or request the QR cell size ratio in the Y direction

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,QRCodeCellSizeRatioY=A[CR]
WX
Response WX,OK[CR]

Command RX,JOB=0000,BLK=000,QRCodeCellSizeRatioY[CR]
RX
Response RX,OK,A[CR]

Parameter A:050.0 to 200.0 5 bytes Ratio (%)

• This command can be sent to a block No. having the block type (BlockType) of “09: Barcode/2D Code” AND barcode type (CodeType) of
“07: QR Model 1/08: QR Model 2/09: Micro QR”.
• The mode AUTO cannot be set in the case of the micro QR.

(19) Block position (Set/Request)


Command BlockPosition 13 bytes
Description Sets/Requests the X/Y coordinates and Z coordinate reference of the common parameters of a block.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,BlockPosition=A,B,C[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,BlockPosition[CR]
RX
Response RX,OK,A,B,C[CR]

A: Depends on the area size


Normal : -062.500 to 0062.500 X coordinate (mm)
8 bytes
Wide :-165.000 to 0165.000 * Default value “0”
Small : -025.000 to 0025.000

B: Depends on the area size


Normal : -062.500 to 0062.500 Y coordinate (mm)
8 bytes
Other model : “Y coordinate” of “Model-Specific * Default value “0”
Input Value List” (Page 1-92)

C: Depends on the area size and 3D shape type


• The 3D shape is XY plane
Normal/Wide : -021.000 to 0021.000
Parameter Small : -015.000 to 0015.000
• The 3D shape is slope
Normal : -083.500 to 0083.500
Wide : -186.000 to 0186.000 Z coordinate (mm)
Small : -040.000 to 0040.000 * Fixed value of “9999.999” if the common
8 bytes
• The 3D shape is cylinder, cone or sphere block marking parameters are referenced
Normal : -261.000 to 0261.000 * Default value “0”
Wide : -621.000 to 0621.000
Small : -115.000 to 0115.000
• The 3D shape is Z-map
Normal : -125.000 to 0125.000
Wide : -330.000 to 0330.000
Small : -050.000 to 0050.000

1-44 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(20) Block layout (Set/Request)


Command BlockLayout 11 bytes
Description Sets/Requests the reference point, block angle, start angle, and character angle of a block.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,BlockLayout=A,B,C,D,E[CR]
WX
Response WX,OK [CR]

RX
Command

Response
RX,JOB=0000,BLK=000,BlockLayout[CR]

RX,OK,A,B,C,D,E[CR] 1
Block reference point:

Communication Interface
0: Left
1: Right
2: Center
3: Lower left
A:0 to 8 1 bytes 4: Lower right
5: Upper left
6: Upper right
7: Top
8: Bottom
* Default value “3”

Block angle (°)


* Fixed value of “0” when the block type is arc
B: -180.000 to 0180.000 8 bytes
Parameter character
* Default value “0”

Start angle (°)


* Fixed value of “0” when the block type is
C: -180.000 to 0180.000 8 bytes other than arc character
* Default value “90” for clockwise “-90” for
counterclockwise

Set using character angle


0: Disabled
D:0/1 1 bytes
1: Enabled
* Default value “0.”

Character angle (°)


E:-180.000 to 0180.000 8 bytes
* Default value “0”

This command can be sent to a block No. having the block type (BlockType) of other than “04: Fixed point”.

(21) Fixed point emission time (Set/Request)


Command FixedPointProcessingTime 24 bytes
Description Sets/Requests the fixed point emission time.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,FixedPointProcessingTime=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,FixedPointProcessingTime[CR]
RX
Response RX,OK,A[CR]

Emission time (ms)


Parameter A:00000.1 to 65000.0 7 bytes
* Default value “1”

This command can be sent to a block No. having the block type (BlockType) of “04: Fixed point”.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-45


Command Details

Marking parameters
(1) Marking parameters (Set/Request)
Command MarkingParameter 16 bytes
Description Sets/Requests the laser power, scan speed, pulse frequency, spot variable, and marking count of a block.

Target JOB=0000 to 1999,BLK=000 to 255

1 WX
Command

Response
WX,JOB=0000,BLK=000,MarkingParameter=A,B,C,D,E[CR]

WX,OK [CR]
Communication Interface

Command RX,JOB=0000,BLK=000,MarkingParameter[CR]
RX
Response RX,OK,A,B,C,D,E[CR]

Laser power (%)


* Fixed value of “999.9” if the common block
A:000.0 to 100.0/999.9 5 bytes
marking parameters are referenced
* Default value “0”

B: Depends on the area size Scan speed (mm/s)


Normal : 00001 to 12000 * Fixed value of “99999” if the common block
5 bytes
Other model : “Scan speed” of “Model-Specific marking parameters are referenced
Input Value List” (Page 1-92) * Default value “1000”

Pulse frequency (kHz)


* Fixed value of “999” if the common block
Parameter C: 000 to 400 3 bytes
marking parameters are referenced
* Default value “100”

D: Depends on the area size Spot variable


Normal : -210 to 0210 * Fixed value of “9999” if the common block
4 bytes
Other model : “Spot variable” of “Model-Specific marking parameters are referenced
Input Value List” (Page 1-92) * Default value “0”

Marking count (times)


* Fixed value of “999” if the common block
E: 001 to 100/ 999 3 bytes
marking parameters are referenced
* Default value “1”

1-46 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(2) Barcode/2D code pattern setting (Set/Request)


Command CodePattern 11 bytes
Description Sets/Requests the various pattern settings, cell marking order, and cell marking count of a barcode/2D code.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,CodePattern=A,B,C,D,E,F[CR]
WX
Response WX,OK [CR]

RX
Command

Response
RX,JOB=0000,BLK=000,CodePattern[CR]

RX,OK,A,B,C,D,E,F[CR] 1
Pattern

Communication Interface
(QR Code/DataMatrix/Bar Code)
000: -/-/Alternate
001: Pattern 1/A/Unidirectional
002: Pattern 2/B/-
003: Pattern 3/C/-
004: Pattern 4/D/-
005: Pattern 5/E/-
006: Pattern 6/F/-
007: Pattern 7/Entire pattern 1/-
A:000 to 13/254 3 bytes 008: Entire pattern 1/Entire pattern 2/-
009: Entire pattern 2/Entire pattern 3/-
010: Entire pattern 3/Entire pattern 4/-
011: Entire pattern 4/Entire pattern 5/-
012: Entire pattern 5/Entire pattern 6/-
013: Entire pattern 6/-/-
254: Individual/Individual/ -
* Default value “9” for QR, DataMatrix, “0” for
Bar Code
* Entire pattern 5/6: Available on only MD-
U1000 series

Finder
000: None
001: F1
002: F2
B: 000 to 002/255 3 bytes
255: Cell
* QR Code and B: Fixed value of “0” when
other than 0 to 2
* Default value “1”
Parameter Alignment
000: None
001: A1
002: A2
C:000 to 002/255 3 bytes
255: Cell
* DataMatrix and C: Fixed value of “0” when
other than 0 to 2
* Default value “1”

Cell
(QR Code/DataMatrix)
000: None/None
001: M1/C1
002: M2/C2
003: M3/C3
D: 000 to 008 3 bytes
004: M4/C4
005: M5/C5
006: M6/C6
007: M7/C7
008: M8/C8
* Default value “1”

Cell marking order


0: None
1: Continuous
E:000 to 003 3 bytes
2: Skip 1 cell
3: Skip 2 cell
* A: Fixed value of “0” when 8 to 11

Cell marking count (times)


F: 001 to 100 3 bytes * A: Fixed value of “1” when 8 to 11
* Default value “1”

• This command can be sent to a block No. having the block type (BlockType) of “09: Barcode/2D Code”.
• “D: 0” cannot be set when “B: 0/255.”
• “D: 0” cannot be set when “C: 0/255.”

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-47


Command Details

(3) Hatch logo pattern setting (Set/Request)


Command HatchPattern 12 bytes
Description Sets/Requests the fill type, pattern, fill direction, start position, fill angle, and fill cross angle of a hatch logo.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,HatchPattern=A,B,C,D,E,F,G[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,JOB=0000,BLK=000,HatchPattern[CR]

RX,OK,A,B,C,D,E,F,G[CR]

Fill Type
Communication Interface

0: Boundary + Fill
A:0 to 2 1 bytes 1: Fill
2: Boundary
* Default value “0”

Pattern
0: Slant
2: Cross
B: 0 to 3 1 byte
3: Contour
* A: Fixed value of “0” when 2
* Default value “0”

Slant/Cross direction
0: Right to Left
1: Left to Right
2: Left to right, Right to left
3: Right to left, Left to right
C: 0 to 5 1 byte
4: Left to right, Right to left (High Speed)
5: Right to left, Left to right (High Speed)
* Fixed value of “2” when A is 0 or B is 2
* Default value “2”
Parameter * 4/5: Available on only MD-U1000 series

Contour direction
0: Clockwise
1: Counterclockwise
D: 0 to 3 1 byte 2: Clockwise to Counterclockwise
3: Counterclockwise to Clockwise
* Fixed value of “0” when A is 2 or B is 0/1
* Default value “0”

Contour drawing start position


0: Inside
E: 0/1 1 byte 1: Outside
* Fixed value of “1” when A is 2 or B is 0/1
* Default value “0”

Slant/Cross fill angle (°)


F: 000 to 359 3 bytes * Fixed value of “0” when A is 0 or B is 2
* Default value “0”

Cross angle (°)


G: 000 to 359 3 bytes * Fixed value of “0” when A is 2 or B is 0/2
* Default value “0”

This command can be sent to a block No. having the block type (BlockType) of “-4: Hatch logo”.

1-48 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(4) TrueType font pattern setting (Set/Request)


Command TTFPattern 10 bytes
Description Sets/Requests the fill type, pattern, fill direction, fill angle, and fill cross angle of a TrueType font.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,TTFPattern=A,B,C,D,E[CR]
WX
Response WX,OK [CR]

RX
Command

Response
RX,JOB=0000,BLK=000,TTFPattern[CR]

RX,OK,A,B,C,D,E[CR] 1
Fill Type

Communication Interface
0: Boundary + Fill
A:0 to 2 1 byte 1: Fill
2: Boundary
* Default value “0”

Pattern
0: Slant
B:0/2 1 byte 2: Cross
* A: Fixed value of “0” when 2
* Default value “0”

Fill direction
0: Right to Left
1: Left to Right
Parameter
2: Left to right, Right to left
3: Right to left, Left to right
C: 0 to 5 1 byte
4: Left to right, Right to left (High Speed)
5: Right to left, Left to right (High Speed)
* A: Fixed value of “2” when 2/3
* Default value “2”
* 4/5: Available on only MD-U1000 series

Fill angle (°)


D: 000 to 359 3 byte * A: Fixed value of “0” when 2
* Default value “0”

Fill cross angle (°)


E:000 to 359 3 byte * Fixed value of “0” when A is 2 or B is 0
* Default value “90”

This command can be sent to a block No. having the block type (BlockType) of “00: Horizontal characters/01: Vertical characters/02: Arc
clockwise/03: Arc counterclockwise” AND the font type of TrueType font.

(5) Barcode/2D code fill marking parameters (Set/Request)


Command CodeFillParameter 17 bytes
Description Sets/Requests the fill interval and shrink fill of a barcode/2D code.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,CodeFillParameter=A,B[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,CodeFillParameter[CR]
RX
Response RX,OK,A,B[CR]

Fill interval (mm)


* Fixed value of “9.999” if the common block
A:0.000 to 1.000/9.999 5 bytes marking parameters are referenced
Parameter * Default value “Normal: 0.06”/”Wide:
0.08”/”Small: 0.03”

B: Bar Code: -5.000 to 05.000 Shrink fill (mm)


6 bytes
QR Code/DataMatrix: -2.500 to 02.500 * Default value “0”

This command can be sent to a block No. having the block type (BlockType) of “09: Barcode/2D Code”.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-49


Command Details

(6) Hatch logo fill marking parameters (Set/Request)


Command HatchParameter 14 bytes
Sets/Requests the fill interval, common line interval setting reference, shrink fill, no. of skipped fill lines, overprinting
Description enable/disable, overprinting direction, overprinting count, shrink boundary, boundary fill setting, and printing order of a
hatch logo.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,HatchParameter=A,B,C,D,E,F,G,H[CR]

1
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,HatchParameter[CR]
RX
Response RX,OK,A,B,C,D,E,F,G,H[CR]
Communication Interface

Fill interval (mm)


* Fixed value of “9.999” if the common block
A:0.000 to 1.000/9.999 5 bytes marking parameters are referenced
* Default value “Normal: 0.06”/”Wide:
0.08”/”Small: 0.03”

Shrink fill (mm)


B: 00.000 to 10.000 6 bytes
* Default value “0”

Skip line count (lines)


C: 000 to 255 3 bytes
* Default value “0”

Overprinting setting
0: Disabled
D:0/1 1 bytes
1: Enabled
Parameter * Default value “0”

Overprinting direction
0: Alternate
E: 0/1 1 byte
1: Forward
* Default value “0”

Overprinting count
F: 001 to 255 3 bytes
* Default value “1”

Shrink boundary (mm)


G: 00.000 to 10.000 6 bytes
* Default value “0”

Writing Order
0: Boundary -> Fill
H:0/1 1 byte
1: Fill -> Boundary
* Default value “1”

This command can be sent to a block No. having the block type (BlockType) of “-4: Hatch logo” and the fill type in hatch logo pattern setting
(HatchPattern) of 0: Boundary + Fill/1: Fill”.

1-50 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(7) TrueType font fill marking parameters (Set/Request)


Command TTFParameter 12 bytes
Sets/Requests the fill interval, common line interval setting reference, shrink fill, no. of skipped fill lines, overprinting
Description
enable/disable, overprinting direction, overprinting count, shrink boundary, and writing order of a TrueType font.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,TTFParameter=A,B,C,D,E,F,G,H[CR]
WX

1
Response WX,OK[CR]

Command RX,JOB=0000,BLK=000,TTFParameter[CR]
RX
Response RX,OK,A,B,C,D,E,F,G,H[CR]

Communication Interface
Fill interval (mm)
* Fixed value of “9.999” if the common block
A:0.000 to 1.000/9.999 5 bytes marking parameters are referenced
* Default value “Normal: 0.06”/”Wide:
0.08”/”Small: 0.03”

Shrink fill
B: 00.000 to 10.000 6 bytes
* Default value “0”

Skip line count (lines)


C: 000 to 255 3 bytes
* Default value “0.”

Overprinting setting
0: Disabled
D:0/1 1 bytes
1: Enabled
Parameter * Default value “0.”

Overprinting direction
0: Alternate
E: 0/1 1 bytes
1: Forward
* Default value “0.”

Overprinting count
F: 001 to 255 3 bytes
* Default value “1”

Shrink boundary (mm)


G: 00.000 to 10.000 6 bytes
* Default value “0.”

Writing order
0: Boundary -> Fill
H:0/1 1 bytes
1: Fill -> Boundary
* Default value “1”

This command can be sent to a block No. having the block type (BlockType) of “00: Horizontal characters/01: Vertical characters/02: Arc
clockwise/03: Arc counterclockwise” AND the font type of TrueType AND the fill type in the TrueType font pattering setting (TTFPattern) of “0:
Boundary + Fill/1: Fill”.

(8) Photo setting (Set/Request)


Command PhotoSetting 12 byte
Description Sets/Requests the gamma correction, contrast, contrast enhancement, brightness, skip dots, and intensity of a photo.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,PhotoSetting=A,B,C,D,E,F[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,PhotoSetting[CR]
RX
Response RX,OK,A,B,C,D,E,F[CR]

Gamma correction
A: 0.01 to 9.99 (High resolution only) 4 bytes
Default value “0.6”

Contrast
A: -128 to 0127 (High resolution only) 4 bytes
Default value “0”

Contrast enhancement
0: Disabled
C: 0/1 (High resolution only) 1 byte
1: Enabled
Parameter Default value “0”

Brightness
D: -128 to 0127 (High resolution only) 4 byte
Default value “0”

Skip dots
E: 1 to 8 (Grayscale only) 1 byte
Default value “1”

Intensity
F: 1 to 8 (Grayscale only) 1 byte
Default value “3”

• This command can be sent to a block No. having the block type (BlockType) of “-3: Photo”.
• It cannot be used on the MD-F3200/5200 series.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-51


Command Details

(9) Marking flag (Set)


Command MarkingEnable 13 bytes
Description Sets the marking flag of a block.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,MarkingEnable=A,BBB---[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
None

Reset the marking flag


Communication Interface

0: Set the marking flag of all blocks to OFF


A:0/1/2 1 byte 1: Set the marking flag of all blocks to ON
2: Do not change other than the specified
block
Parameter Marking flag
0: Do not Mark
1: Mark
B:0/1 1 byte
* You can change the marking flag of
continuous blocks in a batch by sending this
parameter in multiple digits.

To change the marking flag of multiple blocks in a batch, send parameter B in multiple digits.
To set block No.10 to ON, No.11 to OFF, No.12 to ON and all other blocks to OFF, send the command as described below.
WX,JOB=0000,BLK=010,MarkingEnable=0,101[CR]

(10) Individual fill marking parameters (Set/Request)


Command FillMarkingParameter 20 bytes
Description Sets/Requests to enable/disable the function and the setting values of the individual fill parameters of a hatch logo.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,FillMarkingParameter=A,B,C,D,E,F[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,FillMarkingParameter[CR]
RX
Response RX,OK,A,B,C,D,E,F[CR]

Individual fill parameters


A:0/1 1 byte 0: Enabled
1: Disabled

Fill line laser power (%)


* Fixed value of “999.9” if the common block
B: 000.0 to 100.0/9.999 5 byte marking parameters are referenced
* A: Fixed value of “0” when 1
* Default value “0”

Fill line scan speed (mm/s)


C: Depends on the area size
* Fixed value of “99999” if the common block
Normal : 00001 to 12000
5 bytes marking parameters are referenced
Other model : “Scan speed” of “Model-Specific
* A: Fixed value of “1000” when 1
Input Value List” (Page 1-92)
* Default value “1000”

Parameter Fill line pulse frequency (kHz)


* Fixed value of “999” if the common block
D: 000 to 400 3 bytes marking parameters are referenced
* A: Fixed value of “100” when 1
* Default value “100”

Fill spot variable


E: Depends on the area size
* Fixed value of “9999” if the common block
Normal : -210 to 0210
4 bytes marking parameters are referenced
Other model : “Spot variable” of “Model-Specific
* A: Fixed value of “0” when 1
Input Value List” (Page 1-92)
* Default value “0”

Fill line marking count (times)


* Fixed value of “999” if the common block
F: 001 to 100/999 3 bytes marking parameters are referenced
* A: Fixed value of “1” when 1
* Default value “1”

This command can be sent to a block No. having the block type (BlockType) of “-4: Hatch logo” or TrueTypeFont.

1-52 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(11) Jump Speed (Set/Request)


Command JumpSpeed 9 bytes
Description Sets/Requests the jump speed.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,JumpSpeed=A[CR]
WX
Response WX,OK [CR]

RX
Command

Response
RX,JOB=0000,BLK=000,JumpSpeed[CR]

RX,OK,A[CR] 1
Jump speed

Communication Interface
0: Top Speed
Parameter A:0/1/2 1 byte 1: High Speed
2: Medium Speed
* Default value “0”

This command is enabled when the quality level (MarkingQuality) is not “05: Customize”.

(12) Nudge marking quality setting (Set/Request)


Command MarkingQuality 14 bytes
Sets/Requests the skip cross, common skip cross setting reference, quality level, common quality level setting
Description
reference, and marking start wait time of a block.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,MarkingQuality=A,B,C[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,MarkingQuality[CR]
RX
Response RX,OK,A,B,C[CR]

Skip cross (mm)


* Fixed value of “99.999” if the common block
A:00.000 to 10.000/99.999 6 bytes
marking parameters are referenced
* Default value “0”

Quality Level
00: Top speed
01: Speed priority
02: Standard
Parameter 03: High quality
B: 00 to 06/99 2 bytes 04: Top quality
05: Customize
06: Top speed
* Fixed value of “99” if the common block
marking parameters are referenced
* Default value “02”

Wait time for start marking (ms)


C: 00000.0 to 65000.0 7 bytes
* Default value “0”

The skip cross can be set only for the character strings except TrueTypeFont.

(13) Approach (Set/Request)


Command Approach 8 bytes
Description Sets/Requests the block approach.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,Approach=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,Approach[CR]
RX
Response RX,OK,A[CR]

A: Normal,Wide:0.000 to 5.000、Small:0.000 to Approach (mm)


Parameter 5 bytes
2.500 * Default value “0.500”

This command is enabled when the quality level (MarkingQuality) is “05: Customize”.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-53


Command Details

(14) Space approach (Set/Request)


Command SpaceApproach 13 bytes
Description Sets/Requests the space approach.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,SpaceApproach=A[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,JOB=0000,BLK=000,SpaceApproach[CR]

RX,OK,A[CR]

Space approach (mm)


Parameter
Communication Interface

A:0.000 to 5.000 5 bytes


* Default value “0.250”

This command is enabled when the quality level (MarkingQuality) is “05: Customize”.

(15) Curve correction (Set/Request)


Command CurveCorrection 15 bytes
Description Sets/Requests the curve correction.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,CurveCorrection=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,CurveCorrection[CR]
RX
Response RX,OK,A[CR]

Curve correction
0: Disabled
Parameter A:0/1 1 byte
1: Enabled
* Default value “1”

1-54 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

Code overprinting parameters


(1) Barcode/2D code overprinting marking parameters (Set/Request)
Command MultiPassMarkingParameter 25 bytes
Specifies the overprinting order in the barcode/2D code overprinting setting and changes/requests the marking
Description
parameters.

Target

WX
Command
JOB=0000 to 1999,BLK=000 to 255,OLP=0 to 9

WX,JOB=0000,BLK=000,OLP=0,MultiPassMarkingParameter=A,B,C,D,E,F,G[CR] 1
Response WX,OK [CR]

Communication Interface
Command RX,JOB=0000,BLK=000,OLP=0,MultiPassMarkingParameter[CR]
RX
Response RX,OK,A,B,C,D,E,F,G[CR]

Format
0: Code
A:0 to 2 1 byte 1: Code (Black/white inversion)
2: Base
* Default value “2”

Laser power (%)


* Fixed value of “999.9” if the common block
B: 000.0 to 100.0/999.9 5 bytes
marking parameters are referenced
* Default value “0”

C: Depends on the area size Scan speed (mm/s)


Normal : 00001 to 12000 * Fixed value of “99999” if the common block
5 bytes
Other model : “Scan speed” of “Model-Specific marking parameters are referenced
Input Value List” (Page 1-92) * Default value “1000”

Pulse frequency (kHz)


Parameter * Fixed value of “999” if the common block
D: 000 to 400 3 bytes
marking parameters are referenced
* Default value “100”

E: Depends on the area size Spot variable


Normal : -210 to 0210 * Fixed value of “9999.9” if the common block
4 bytes
Other model : “Spot variable” of “Model-Specific marking parameters are referenced
Input Value List” (Page 1-92) * Default value “0”

Marking count (times)


* Fixed value of “999” if the common block
F: 001 to 100/999 3 bytes
marking parameters are referenced
* Default value “1”

G: Depends on the area size


Normal : 00.000 to 42.000 Deep dig amount (mm)
6 bytes
Other model : “Deep dig amount” of “Model- * Default value “0”
Specific Input Value List” (Page 1-92)

• This command can be sent when the type of block (BlockType) is “09: Barcode/2D code” and the format setting of the barcode or 2D code
related settings (CodeSetting) is the block No. of “2: Overprinting.”
• The overprinting can be added when insetting No. is specified so that it becomes consecutive number at OLP.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-55


Command Details

(2) Barcode/2D code overprinting pattern setting (Set/Request)


Command MultiPassPattern 16 bytes
Specifies the overprinting order in the barcode/2D code overprinting settings and changes/requests the various pattern
Description
settings, cell marking order, and cell marking count.

Target JOB=0000 to 1999,BLK=000 to 255,OLP=0 to 9

Command WX,JOB=0000,BLK=000,OLP=0,MultiPassPattern=A,B,C,D,E,F[CR]
WX

1
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,OLP=0,MultiPassPattern[CR]
RX
Response RX,OK,A,B,C,D,E,F[CR]
Communication Interface

Pattern
(QR Code/DataMatrix/2D Code base/Bar Code/
Bar Code base)
000: -/-/-/Alternate/-
001: Pattern 1/A/B1/Unidirectional/Alternate
002: Pattern 2/B/B2/-/Unidirectional
003: Pattern 3/C/B3/-/Alternate (Horiz.)
004: Pattern 4/D/B4/-/Unidirectional (Horiz.)
005: Pattern 5/E/B5/-/-
006: Pattern 6/F/B6/-/-
007: Pattern 7/Entire pattern 1/B7/-/-
A:000 to 13/254 3 bytes
008: Entire pattern 1/Entire pattern 2/B8/-/-
009: Entire pattern 2/Entire pattern 3/B9/-/-
010: Entire pattern 3/Entire pattern 4/-/-/-
011: Entire pattern 4/Entire pattern 5/-/-/-
012: Entire pattern 5/Entire pattern 6/-/-/-
013: Entire pattern 6/-/-/-/-
254: Individual/Individual/-/-/-
* Default value “0” for Bar Code, “9” for 2D
Code
* B7/8/9, Entire pattern 5/6: Available on only
MD-U1000 series

Finder
000: None
001: F1
002: F2
B: 000 to 002/255 3 bytes
255: =Cell
* QR Code and B: Fixed value of “0” when
other than 0 to 2
Parameter * Default value “0”

Alignment
000: None
001: A1
002: A2
C:000 to 002/255 3 bytes
255: =Cell
* DataMatrix and C: Fixed value of “0” when
other than 0 to 2
* Default value “0”

Cell (QR Code/DataMatrix)


000: None/None
001: M1/C1
002: M2/C2
003: M3/C3
D: 000 to 008 3 bytes 004: M4/C4
005: M5/C5
006: M6/C6
007: M7/C7
008: M8/C8
* Default value “0”

Cell marking order


001: Continuous
E:001 to 003 3 bytes 002: Skip 1 cell
003: Skip 2 cell
* A: Fixed value of “1” when 8 to 11

Cell marking count (times)


F: 001 to 100 3 bytes * A: Fixed value of “1” when 8 to 11
* Default value “1”

• This command can be sent when the type of block (BlockType) is “09: Barcode/2D code” and the format setting of the barcode or 2D code
related settings (CodeSetting) is the block No. of “2: Overprinting.”
• “D: 0” cannot be set when “B: 0/255”.
• “D: 0” cannot be set when “C: 0/255”.

1-56 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(3) Barcode/2D code overprinting fill parameters (Set/Request)


Command MultiPassFillParameters 23 bytes
Specifies the overprinting order in the barcode/2D code overprinting setting and changes/requests the fill interval,
Description
common line interval setting, and shrink fill.

Target JOB=0000 to 1999,BLK=000 to 255,OLP=0 to 9

Command WX,JOB=0000,BLK=000,OLP=0,MultiPassFillParameters=A,B[CR]
WX

1
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,OLP=0,MultiPassFillParameters[CR]
RX
Response RX,OK,A,B[CR]

Communication Interface
Fill interval (mm)
* Fixed value of “9.999” if the common block marking
A:0.000 to 1.000/9.999 5 bytes
parameters are referenced
Parameter * Default value “Normal: 0.06”/”Wide: 0.08”/”Small: 0.03”

B: 2D code: -2.500 to 02.500 Shrink fill (mm)


6 bytes
Barcode: -5.000 to 05.000 * Default value “0”

This command can be sent when the type of block (BlockType) is “09: Barcode/2D code” and the format setting of the barcode or 2D code
related settings (CodeSetting) is the block No. of “2: Overprinting.”

(4) Quality level of barcode/2D code overprinting (Set/Request)


Command MultiPassQualityLevel 21 bytes
Description In barcode/2D code overprinting settings, specify the overprinting order and change/request the quality level.

Target JOB=0000 to 1999,BLK=000 to 255,OLP=0 to 9

Command WX,JOB=0000,BLK=000,OLP=0,MultiPassQualityLevel=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,OLP=0,MultiPassQualityLevel[CR]
RX
Response RX,OK,A[CR]

Quality Level
00: Top speed
01: Speed priority
02: Standard
Parameter A: 00 to 06 2 bytes 03: High quality
04: Top quality
05: Customize
06: Top speed
* Default value “02”

(5) Approach of barcode/2D code overprinting (Set/Request)


Command MultiPassApproach 17 bytes
Description In barcode/2D code overprinting settings, specify the overprinting order and change/request the approach.

Target JOB=0000 to 1999,BLK=000 to 255,OLP=0 to 9

Command WX,JOB=0000,BLK=000,OLP=0,MultiPassApproach=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,OLP=0,MultiPassApproach[CR]
RX
Response RX,OK,A[CR]

A: Normal/Wide: 0.000 to 5.000, Approach (mm)


Parameter 5 bytes
Small: 0.000 to 2.500 * Default value “0.500”

This command is enabled when the quality level of barcode/2D code overprinting (MultiPassQualityLevel) is “05: Customize”.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-57


Command Details

(6) Space approach of barcode/2D code overprinting (Set/Request)


Command MultiPassSpaceApproach 22 bytes
Description In barcode/2D code overprinting settings, specify the overprinting order and change/request the space approach.

Target JOB=0000 to 1999,BLK=000 to 255,OLP=0 to 9

Command WX,JOB=0000,BLK=000,OLP=0,MultiPassSpaceApproach=A[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,JOB=0000,BLK=000,OLP=0,MultiPassSpaceApproach[CR]

RX,OK,A[CR]

Space approach (mm)


Parameter
Communication Interface

A:0.000 to 5.000 5 bytes


* Default value “0.250”

This command is enabled when the quality level of barcode/2D code overprinting (MultiPassQualityLevel) is “05: Customize”.

(7) Curve correction of barcode/2D code overprinting (Set/Request)


Command MultiPassCurveCorrection 24 bytes
Description In barcode/2D code overprinting settings, specify the overprinting order and change/request the curve correction.

Target JOB=0000 to 1999,BLK=000 to 255,OLP=0 to 9

Command WX,JOB=0000,BLK=000,OLP=0 to 9,MultiPassCurveCorrection=A[CR]


WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,OLP=0 to 9,MultiPassCurveCorrection[CR]


RX
Response RX,OK,A[CR]

Curve correction
0: Disabled
Parameter A:0/1 1 byte
1: Enabled
* Default value “0”

(8) Jump speed of barcode/2D code overprinting (Set/Request)


Command MultiPassJumpSpeed 18 bytes
Description In barcode/2D code overprinting settings, specify the overprinting order and change/request the jump speed.

Target JOB=0000 to 1999,BLK=000 to 255,OLP=0 to 9

Command WX,JOB=0000,BLK=000,OLP=0 to 9,MultiPassJumpSpeed=A[CR]


WX
Response WX,OKA[CR]

Command RX,JOB=0000,BLK=000,OLP=0 to 9,MultiPassJumpSpeedA[CR]


RX
Response RX,OK,A[CR]

Jump speed
0: Top Speed
Parameter A:0/1/2 1 byte 1: High Speed
2: Medium Speed
* Default value “0”

This command is enabled when the quality level of barcode/2D code overprinting (MultiPassQualityLevel) is not “05: Customize”.

(9) Wait time for start marking of barcode/2D code overprinting (Set/Request)
Command MultiPassBlockMarkingDelayTime 30 bytes
In barcode/2D code overprinting settings, specify the overprinting order and change/request the wait time for start
Description
marking.

Target JOB=0000 to 1999,BLK=000 to 255,OLP=0 to 9

Command WX,JOB=0000,BLK=000,OLP=0 to 9,MultiPassBlockMarkingDelayTime=A[CR]


WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,OLP=0 to 9,MultiPassBlockMarkingDelayTime[CR]


RX
Response RX,OK,A[CR]

Wait time for start marking (ms)


Parameter A:00000.0 to 65000.0 7 bytes
* Default value “0”

1-58 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

3D shape setting
(1) 3D shape setting (Set/Request)
Command 3DShape 7 bytes
Description Sets/Requests the 3D shape setting enable/disable and the 3D shape No. to be inserted.

Target JOB=0000 to 1999,BLK=000 to 255

WX
Command

Response
WX,JOB=0000,BLK=000,3DShape=A,B[CR]

WX,OK [CR]
1

Communication Interface
Command RX,JOB=0000,BLK=000,3DShape[CR]
RX
Response RX,OK,A,B[CR]

3D shape setting
0: XY Plane
A:0/1 1 byte
1: 3D Shape
Parameter * Default value “0”

3D shape No.
B: 000 to 255 3 bytes * A: Fixed value of “0” when 0
* Default value “0”

• This command can be sent to a block No. having the block type (BlockType) of other than “04: Fixed point”.
• The tilt correction target block of the Z tracking cannot be set for a target. When the block is set to the target, the communication error
S083 “3D information incorrect setting error” will occur.

(2) 3D shape type (Set/Request)


Command 3DShapeType 11 bytes
Description Specifies the 3D shape No. and creates a new or requests a 3D shape type.

Target JOB=0000 to 1999,3DS=000 to 255

Command WX,JOB=0000,3DS=000,3DShapeType=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,3DS=000,3DShapeType[CR]
RX
Response RX,OK,A[CR]

3D Shape
-01: Z map
000: Slope
001: Inside cylinder
002: Outside cylinder
Parameter A: -01/000 to 006/020 3 bytes 003: Inside cone
004: Outside cone
005: Inside hemisphere
006: Outside hemisphere
020: XY Plane
* Default value “20”

• You cannot change a 3D shape No. for which a 3D shape has already been set. The 3D shape setting information is initialized when the
block associated with the 3D shape No. is removed.
• Therefore, associate the block using the 3DShape command following the 3DShapeType.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-59


Command Details

(3) 3D shape position (Set/Request)


Command 3DShapePosition 15 bytes
Description Specifies the 3D shape No. and changes/requests the X/Y/X coordinates and X/Y/Z rotation angles.

Target JOB=0000 to 1999,3DS=000 to 255

Command WX,JOB=0000,3DS=000,3DShapePosition=A,B,C,D,E,F[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,JOB=0000,3DS=000,3DShapePosition[CR]

RX,OK,A,B,C,D,E,F[CR]

A: Depends on the area size and block type


Communication Interface

• The block type is other than arc character


Normal : -062.500 to 0062.500
X coordinate (mm)
Wide :-165.000 to 0165.000 8 bytes
* Default value “0”
Small: -025.000 to 0025.000
• The block type is arc character
-9999.99 to 09999.99

B: Depends on the area size, block type, and 3D shape type


• The block type is other than arc character and 3D shape is
other than cone
Normal : -062.500 to 0062.500
Other model : “Y coordinate” of “Model-Specific Input
Value List” (Page 1-92)
• The block type is other than arc character and 3D shape is
Y coordinate (mm)
cone 8 bytes
* Default value “0”
Normal : 0000.000 to 0062.500
Wide : 0000.000 to 0165.000
Small : 0000.000 to 0025.000
• The block type is arc character
-9999.99 to 09999.99
“Y coordinate” of “Model-Specific Input Value List” (Page
Parameter 1-92)

C: Depends on the area size and 3D shape type


• The 3D shape is cylinder, cone or sphere
Normal : -261.000 to 0261.000
Wide : -621.000 to 0621.000
Small : -115.000 to 0115.000
• The 3D shape is slope
Z coordinate (mm)
Normal : -083.500 to 0083.500 8 bytes
* Default value “0”
Wide : -186.000 to 0186.000
Small : -040.000 to 0040.000
• The 3D shape is Z-map
Normal : -125.000 to 0125.000
Wide : -330.000 to 0330.000
Small : -050.000 to 0050.000

X rotation angle (°)


D: -180.000 to 0180.000 8 bytes
* Default value “0”

Y rotation angle (°)


E:-180.000 to 0180.000 8 bytes
* Default value “0”

Z rotation angle (°)


F: -180.000 to 0180.000 8 bytes
* Default value “0”

• This command can be sent to a block No. having the 3D shape setting (3DShape) of “1: 3D Shapes”.
• Specify the target specifier 3DS based on the 3D shape No. of the 3D shape setting (3DShape).

1-60 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(4) Diameter of cylinder shape (Set/Request)


Command CylinderDiameter 16 bytes
Description Specifies the 3D shape No. and changes/requests the diameter of a cylinder shape.

Target JOB=0000 to 1999,3DS=000 to 255

Command WX,JOB=0000,3DS=000,CylinderDiameter=A[CR]
WX
Response WX,OK [CR]

RX
Command

Response
RX,JOB=0000,3DS=000,CylinderDiameter[CR]

RX,OK,A[CR] 1
A: Depends on the area size

Communication Interface
Normal : 0000.200 to 0480.000 Cylinder diameter (mm)
Parameter 8 bytes
Other model : “Cylinder diameter” of “Model- * Default value “Normal/Wide: 40”/”Small: 20”
Specific Input Value List” (Page 1-92)

• This command can be sent to a block No. having the 3D shape setting (3DShape) of “1: 3D Shapes” AND the 3D shape type
(3DShapeType) of “01/02: Cylinder”.
• Specify the target specifier 3DS based on the 3D shape No. of the 3D shape setting (3DShape).

(5) Cone shape size setting (Set/Request)


Command ConeSize 8 bytes
Description Specifies the 3D shape No. and changes/requests the various sizes of a cone shape.

Target JOB=0000 to 1999,3DS=000 to 255

Command WX,JOB=0000,3DS=000,ConeSize=A,B,C,D,E[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,3DS=000,ConeSize[CR]
RX
Response RX,OK,A,B,C,D,E[CR]

A: Depends on the area size


Normal : 0000.200 to 0480.000 Bottom diameter (mm)
8 bytes
Other model : “Bottom diameter of cone” of * Default value “Normal/Wide: 40”/”Small: 20”
“Model-Specific Input Value List” (Page 1-92)

Set with bus angle


0: Disabled
B:0/1 1 byte
1: Enabled
* Default value “0”

C: Depends on the area size


Parameter
Normal : 0000.200 to 0480.000 Top diameter (mm)
8 bytes
Other model : “Top diameter of cone” of “Model- * Default value “Normal/Wide: 20”/”Small: 10”
Specific Input Value List” (Page 1-92)

D: Depends on the area size


Normal : 000.100 to 125.000 Height (mm)
7 bytes
Other model : “Cone height” of “Model-Specific * Default value “Normal/Wide: 20”/”Small: 10”
Input Value List” (Page 1-92)

Bus angle (°)


E:-85.000 to 085.000 7 bytes
* Default value “0”

• This command can be sent to a block No. having the 3D shape setting (3DShape) of “1: : 3D shape AND the 3D shape type (3DShapeType)
of “3/4: Cone”.
• Specify the target specifier 3DS based on the 3D shape No. of the 3D shape setting (3DShape).
• The bus angle cannot be set when the specification is disabled at the bus angle. The top diameter and height cannot be set when the
specification is enabled at the bus angle.

(6) Diameter of sphere shape (Set/Request)


Command SphereDiameter 14 bytes
Description Specifies the 3D shape No. and changes/requests the diameter of a sphere shape.

Target JOB=0000 to 1999,3DS=000 to 255

Command WX,JOB=0000,3DS=000,SphereDiameter=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,3DS=000,SphereDiameter[CR]
RX
Response RX,OK,A[CR]

A: Depends on the area size


Normal : 0000.200 to 0480.000 Diameter (mm)
Parameter 8 bytes
Other model : “Sphere diameter” of “Model- * Default value “20”
Specific Input Value List” (Page 1-92)

• This command can be sent to a block No. having the 3D shape setting (3DShape) of “1: 3D Shapes” AND the 3D shape type
(3DShapeType) of “05/06: Sphere”.
• Specify the target specifier 3DS based on the 3D shape No. of the 3D shape setting (3DShape).

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-61


Command Details

(7) Position on 3D shape (Set/Request)


Command 3DSurfacePosition 17 bytes
Description Sets/Requests a specified block’sX/Y/θ positions on the 3D shape.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,3DSurfacePosition=A,B,C[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,JOB=0000,BLK=000,3DSurfacePosition[CR]

RX,OK,A,B,C[CR]

A: Depends on the area size and block type


Communication Interface

• The block type is other than arc character


Normal : -062.500 to 0062.500
Wide :-165.000 to 0165.000
X coordinate (mm) on 3D shape
Small : -025.000 to 0025.000 8 bytes
* Default value “0”
• The block type is arc character
-9999.99 to 09999.99
“X coordinate” of “Model-Specific Input Value
List” (Page 1-92)

B: Depends on the area size, block type, and 3D


shape type
• The block type is other than arc character and 3D
Parameter shape is other than cone
Normal : -062.500 to 0062.500
Wide :-165.000 to 0165.000
Small : -025.000 to 0025.000 Y coordinate (mm) on 3D shape
8 bytes
• The block type is other than arc character and 3D * Default value “0”
shape is cone
Normal : 0000.000 to 0062.500
Wide :0000.000 to 0165.000
Small : 0000.000 to 0025.000
• The block type is arc character
-9999.99 to 09999.99

θ angle (°) on 3D shape


C: -90.000 to 090.000 7 bytes
* Default value “0”

• This command can be sent to a block No. having the 3D shape setting (3DShape) of “01: 3D Shapes”.
• When the type of 3D shape (3DShapeType) is a cylinder or cone (001 to 004), the X coordinate on the 3D shape cannot be set.
• When the type of 3D shape (3DShapeType) is other than a cylinder or cone (001 to 004), the θ angle on the 3D shape cannot be set.

(8) Cone setting (Set/Request)


Command ConeSetting 11 bytes
Description Sets/Requests the character frame setting, layout, character angle space, and open angle of a cone.

Target JOB=0000 to 1999,BLK=000 to 255

Command WX,JOB=0000,BLK=000,ConeSetting=A,B,C,D[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,BLK=000,ConeSetting[CR]
RX
Response RX,OK,A,B,C,D[CR]

Char. Frame
0: Use fixed length
A:0/1 1 byte
1: Use fixed angle
* Default value “0”

Layout
1: Angular interval
B:1 to 3 1 byte 2: Distribute angle
Parameter 3: Character pitch
* Default value “1”

Character angle space (°)


C: 000.000 to 180.000 7 bytes * B: Fixed value of “10” when 2/3
* Default value “10”

Open angle (°)


D: 000.000 to 180.000 7 bytes B: Fixed value of “120” when 1/3
* Default value “120”

• This command can be sent to a block No. having the 3D shape setting (3DShape) of “01: 3D Shapes” AND the 3D shape type
(3DShapeType) of “3/4: Cone”.
• B: 3 (Character Pitch) can be set only in the case of TrueTypeFont.

1-62 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

Work flow
(1) Enable/disable the XY tracking settings (Set/Request)
Command XYTrackingEnable 16 bytes
Description Sets/Requests to enable/disable the XY tracking settings.

Target JOB = 0000 to 1999, TRK = 000 to 007

WX
Command

Response
WX,JOB=0000,TRK=000,XYTrackingEnable=A

WX,OK
1

Communication Interface
Command RX,JOB=0000,TRK=000,XYTrackingEnable
RX
Response RX,OK,A

XY tracking
0: Disabled
Parameter A:0/1 1 byte
1: Enabled
* Default value “0”

• When the non-existing XY tracking setting No. in TRK is specified, S103 tracking No. no registration error will occur.
• This command cannot be used for the MD-X2050(A)/400(A)/450(A).

(2) Enable/disable the Z tracking settings (Set/Request)


Command ZTrackingEnable 15 bytes
Description Sets/Requests to enable/disable the Z tracking settings.

Target JOB = 0000 to 1999, TRK = 000 to 255

Command WX,JOB=0000,TRK=000,ZTrackingEnable=A
WX
Response WX,OK

Command RX,JOB=0000,TRK=000,ZTrackingEnable
RX
Response RX,OK,A

Z tracking
0: Disabled
Parameter A:0/1 1 byte
1: Enabled
* Default value “0”

• When the non-existing Z tracking setting No. in TRK is specified, S103 tracking No. no registration error will occur.
• This command cannot be used for the MD-X2050(A)/400(A)/450(A).

(3) Set/Request the calibration of the Z tracking


Command ZTrackingCalibration 20 bytes
Description Sets/Requests the calibration of the Z tracking.

Target JOB = 0 to 1999

Command WX,JOB=0000,ZTrackingCalibration=A,B,C[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,ZTrackingCalibration[CR]
RX
Response RX,OK,A,B,C[CR]

Correction before marking


0: Do not correct
A:0/1/2 1 byte 1: Correct (normal)
2: Correct (high accuracy)
* Default value “0”

Correction after marking


0: Do not correct
Parameter B:0/1/2 1 byte 1: Correct (normal)
2: Correct (high accuracy)
* Default value “1”

Operation at temperature change


0: Do nothing
C:0/1/2 1 byte 1: Calibrate automatically
2: Generate warning
* Default value “0”

It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-63


Command Details

(4) Set/Request the warning threshold of the XY tracking


Command XYTrackingCorrectionThreshold 29 bytes
Description Sets/Requests the warning threshold of the XY tracking.

Target JOB = 0 to 1999, TRK = 000 to 007

Command WX,JOB=0000,TRK=000,XYTracking=A[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
RX,JOB=0000,XYTracking=[CR]

RX,OK,A[CR]

Parameter A:01~99 2 bytes Correlation value


Communication Interface

It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

(5) Set/Request to enable/disable the lens inspection before marking


Command WindowCheckBeforeMarkingEnable 30 bytes
Description Sets/Requests to enable/disable the lens inspection before marking.

Target JOB = 0 to 1999

Command WX,JOB=0000,WindowCheckBeforeMarkingEnable=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,WindowCheckBeforeMarkingEnable[CR]
RX
Response RX,OK,A[CR]

Lens inspection before marking


Parameter A:0/1 1 byte 0: Do not conduct
1: Conduct

It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

(6) Set/Request the warning threshold of the lens inspection before marking
Command WindowCheckBeforeMarkingAlarmThreshold 38 bytes
Description Sets/Requests the warning threshold of the lens inspection before marking.

Target JOB = 0 to 1999

Command WX,JOB=0000,WindowCheckBeforeMarkingAlarmThreshold=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,WindowCheckBeforeMarkingAlarmThreshold[CR]
RX
Response RX,OK,A[CR]

Warning threshold of the lens inspection


Parameter A: 0 to 100 3 bytes before marking
* Warning disabled at “0”

It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

(7) Set/Request the sensitivity of the lens inspection before marking


Command WindowCheckBeforeMarkingSensitivity 35 bytes
Description Sets/Requests the sensitivity of the lens inspection before marking.

Target JOB = 0 to 1999

Command WX,JOB=0000,WindowCheckBeforeMarkingSensitivity=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,WindowCheckBeforeMarkingSensitivity[CR]
RX
Response RX,OK,A[CR]

Lens inspection sensitivity before marking


0: Standard
Parameter A:0/1/2 1 byte 1: High sensitivity 1
2: High sensitivity 2
* Default value “0”

It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

1-64 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(8) Set/Request to enable/disable the lens inspection after marking


Command WindowCheckAfterMarkingEnable 29 bytes
Description Sets/Requests to enable/disable the lens inspection after marking.

Target JOB = 0 to 1999

Command WX,JOB=0000,WindowCheckAfterMarkingEnable=A[CR]
WX
Response WX,OK [CR]

RX
Command

Response
RX,JOB=0000,WindowCheckAfterMarkingEnable[CR]

RX,OK,A[CR] 1
Lens inspection after marking

Communication Interface
Parameter A:0/1 1 byte 0: Do not conduct
1: Conduct

It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

(9) Set/Request the warning threshold of the lens inspection after marking
Command WindowCheckAfterMarkingAlarmThreshold 37 bytes
Description Sets/Requests the warning threshold of the lens inspection after marking.

Target JOB = 0 to 1999

Command WX,JOB=0000,WindowCheckAfterMarkingAlarmThreshold=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,WindowCheckAfterMarkingAlarmThreshold[CR]
RX
Response RX,OK,A[CR]

Warning threshold of the lens inspection after


Parameter A: 0 to 100 3 bytes marking
* Warning disabled at “0”

It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

(10) Set/Request the sensitivity of the lens inspection after marking


Command WindowCheckAfterMarkingSensitivity 34 bytes
Description Sets/Requests the sensitivity of the lens inspection after marking.

Target JOB = 0 to 1999

Command WX,JOB=0000,WindowCheckAfterMarkingSensitivity=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,WindowCheckAfterMarkingSensitivity[CR]
RX
Response RX,OK,A[CR]

Lens inspection sensitivity after marking


0: Standard
Parameter A:0/1/2 1 byte 1: High sensitivity 1
2: High sensitivity 2
* Default value “0”

It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-65


Command Details

(11) Marking confirmation function (Set/Request)


Command MarkingConfirmationSetting 26 bytes
Description Sets/Requests the enable/disable of the marking confirmation function and the various settings.

Target JOB = 0000 to 1999

Command WX,JOB=0000,MarkingConfirmationSetting=A,B,C,D,E
WX
Response WX,OK

1 RX
Command

Response
RX,JOB=0000,MarkingConfirmationSetting

RX,OK,A,B,C,D,E

Marking confirmation
Communication Interface

0: Disabled
A:0/1 1 byte
1: Enabled
* Default value “0”

Sensitivity setting
0: Auto
B:0/1 1 byte
1: Any value
* Default value “0”
Parameter
Sensitivity
C: 000 to 100 3 bytes * G: Fixed value of “50” when 0
* Default value “50”

Error threshold
D: 000 to 100 8 bytes
* Default value “50”

Capture delay
E:0.0 to 9.9 8 bytes
* Default value “0”

• Only enabled for stationary marking.


• It can also be set when the 2D code reader function is enabled.
• Specify the reading coordinate in the “Custom Coordinate Specification” when the matrix function is used or 3D shaped block is read.

(12) 2D code quality check and various settings (Set/Request)


Command CodeReaderSetting 17 bytes
Sets/Requests the enable/disable of the 2D code quality check function when the marking is complete and the various
Description
setting values.

Target JOB = 0000 to 1999

Command WX,JOB=0000,CodeReaderSetting=A,B,C,D
WX
Response WX,OK

Command RX,JOB=0000,CodeReaderSetting
RX
Response RX,OK,A,B,C,D

0: Quality check disabled


A:0/1 1 byte 1: Quality check enabled
* Default value “0”

Capture delay (s)


B: 0.0 to 9.0 1 byte * A: Fixed value of “0” when 0
* Default value “0”

Image hold time (s)


Parameter C: 0.0 to 9.0 3 bytes
* Default value “5”

Error threshold
0: Total grade A or higher is OK.
1: Total grade B or higher is OK.
D: 0 to 4 1 byte 2: Total grade C or higher is OK.
3: Total grade D or higher is OK.
4: Total grade F or higher is OK.
* Default value “4”

• Only enabled for stationary marking.


• It can also be set when the marking verification function is enabled.
• If the 2D code reader function is not activated, an S040 “Operation Limitation Error (2D Code Reader)” will be returned.

1-66 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(13) Request internal lighting condition during 2D code reading


Command CodeReaderLightSetting 22 bytes
Description Requests the internal lighting condition in the 2D code reading setting of the workflow.

Target None

Command None
WX
Response

RX
Command

Response
RX,JOB=0000,CodeReaderLightSetting [CR]

RX,OK,A,B,C,D,E [CR] 1
Lighting condition for internal lighting 1

Communication Interface
A: 0/1 1 byte 0: Off
1: On

Lighting condition for internal lighting 2


B: 0/1 1 byte 0: Off
1: On

Lighting condition for internal lighting 3


Parameter C: 0/1 1 byte 0: Off
1: On

Lighting condition for internal lighting 4


D: 0/1 1 byte 0: Off
1: On

Lighting condition for internal lighting 5


E: 0/1 1 byte 0: Off
1: On

• This command cannot be used for the MD-X2050(A)/400(A)/450(A).


• See the figure below for the relationship between the internal lighting numbers and positions.

5 4 3

1 2
(14) Capturing condition of the camera function (Set/Request)
Command CameraImagingSetting 20 bytes
Description Sets/Requests the capturing condition of the camera function in the work flow.

Target JOB = 0000 to 1999, FNC = 00 to 01

Command WX,JOB=0000,FNC=00,CameraImagingSetting=A,B,C,D
WX
Response WX,OK

Command RX,JOB=0000,FNC=00,CameraImagingSetting
RX
Response RX,OK,A,B,C,D

Camera zoom
0: Whole wide
1: Whole standard
A: 0 to 3 1 byte
2: Coax wide
3: Coax standard
* Default value “2”

Brightness
B: -100 to 0100 4 bytes
Parameter * Default value “0”

Gamma correction value


C: 0.1 to 5.0 3 bytes
* Default value “1.0”

Lighting type
0: Internal lighting (normal)
D:0/1/2 1 byte 1: Internal lighting (halation removal)
2: External lighting
* Default value “2”

• When FNC is out of range, S100 capturing condition invalid error will occur.
• If the marking verification function is not set when FNC=00 is specified, S032 no setting error (marking verification function) will occur.
• If the 2D code reader is not set when FNC=01 is specified, S031 no setting error (2D code reader) will occur. When it is non-activation,
S040 operation limitation error (2D code reader) will occur.
• When the Marking Builder Plus enables the function, the default of the lighting type is not “2”.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-67


Command Details

(15) Capturing position of the camera (Set/Request)


Command CameraTargetSetting 19 bytes
Description Sets/Requests the capturing position of the camera function in the work flow.

Target JOB = 0000 to 1999, FNC = 00 to 01

Command WX,JOB=0000,FNC=00,CameraTargetSetting=A,B,C,D,E,F,G,H,I
WX
Response WX,OK

1 RX
Command

Response
RX,JOB=0000,FNC=00,CameraTargetSetting

RX,OK,A,B,C,D,E,F,G,H,I

0: Block No. specification


Communication Interface

A:0/1 1 byte 1: Custom coordinate specification


* Default value “0”

Block No.
B: 000 to 255 3 bytes * A: Fixed value of “0” when 1
* Default value “0”

Reading X coordinate
C: Depends on the area size 8 bytes * A: Fixed value of “0” when 0
* Default value “0”

Reading Y coordinate
D: Depends on the area size 8 bytes * A: Fixed value of “0” when 0
* Default value “0”

Reading Z coordinate
E: Depends on the area size 8 bytes * A: Fixed value of “0” when 0
* Default value “0”

Whether to reflect the XY tracking result to the


reading coordinate
0: Disabled
1: Enabled
F: 0/1 1 byte * A: Fixed value of “0” when 0
This parameter will be ignored and follow
the XY tracking settings associated to the
block.
Parameter * Default value “0”

The XY tracking No. to be reflected to the


reading coordinate
* A: Fixed value of “0” when 0
This parameter will be ignored and follow
G: 00 to 07 2 bytes
the XY tracking settings associated to the
block.
* F: Fixed value of “0” when 0
* Default value “0”

Whether to reflect the Z tracking result to the


reading coordinate
0: Disabled
1: Enabled
H:0/1 1 byte * A: Fixed value of “0” when 0
This parameter will be ignored and follow
the Z tracking settings associated to the
block.
* Default value “0”

The Z tracking No. to be reflected to the


reading coordinate
* A: Fixed value of “0” when 0
This parameter will be ignored and follow
I: 000 to 255 3 bytes
the Z tracking settings associated to the
block.
* H: Fixed value of “0” when 0
* Default value “0”

• When FNC is out of range, S100 capturing condition invalid error will occur.
• When the marking verification function is not set if FNC=00 is specified, S032 no setting error (marking verification function) will occur.
• When the 2D code reader is not set if FNC=01 is specified, S031 no setting error (2D code reader) will occur. When the 2D code reader
has not been activated the S040 operation limitation error (2D code reader) will occur.
• If the XY tracking No. which is not set to G is specified when F=1, S103 tracking No. no registration error will occur.
• If the Z tracking No. which is not set to I is specified when H=1, S103 tracking No. no registration error will occur.

1-68 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(16) Request the workflow result


Command WorkflowResultDetail 20 bytes
Description Requests the result of the last workflow execution.

Target None

Command
WX
Response

RX
Command

Response
RX,WorkflowResultDetail [CR]

RX,OK,A,B,C,D,E,F,G,H,I,J,K,L,M [CR] 1
Execution

Communication Interface
A: 0/1 1 byte 0: Not executed
1: Executed

Workflow execution result


B: 0/1 1 byte 0: Canceled
1: Complete

C: 000000000000 ~ 999999999999 12 bytes Execution time (ms)

Result of pre-marking capture


0: Not executed
D: 0/1/3 1 byte
1: Success
3: Failure

Result of lens inspection before marking


0: Not executed
E: 0 to 3 1 byte 1: Success
2: Failure (out of judgment threshold)
3: Failure

Result of XY tracking
0: Not executed
F: 0 to 3 1 byte 1: Success
2: Failure (out of judgment threshold)
3: Failure

Result of Z tracking
0: Not executed
G: 0 to 3 1 byte 1: Success
2: Failure (out of judgment threshold)
3: Failure
Parameter
Marking result
0: Not executed
H: 0/1/3 1 byte
1: Success
3: Failure

Result of post-marking capture


0: Not executed
I: 0/1/3 1 byte
1: Success
3: Failure

Marking confirmation result


0: Not executed
J: 0 to 3 1 byte 1: Success
2: Failure (out of judgment threshold)
3: Failure

2D code reading result


0: Not executed
K: 0 to 3 1 byte 1: Success
2: Failure (out of judgment threshold)
3: Failure

Result of lens inspection after marking


0: Not executed
L: 0 to 3 1 byte 1: Success
2: Failure (out of judgment threshold)
3: Failure

Marking Energy result


0: Not executed
M: 0 to 2 1 byte
1: Success
2: Failure (out of judgment threshold)

• The result of the last execution is acquired. The result of the last execution will be cleared when the job No. of the currently operating job
is changed.
• The result of marking energy cannot be acquired unless 2 seconds have passed after marking is complete.
• When there is more than one setting of XY tracking and Z tracking, the worst result will be returned.
The order of judgment results from the worst side is [Failure], [Failure (out of judgment threshold)], and [Success].
• The way that XY tracking and Z tracking results are judged varies between the XYTracking, ZTracking, ZTrackingMatrixCell, and
ZTrackingMatrixCellNo commands. With the WorkflowResultDetail command, even if the detection or distance measurement is
successful, the result will be a failure if the value is outside the judgment threshold.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-69


Command Details

(17) Request the marking result


Command MarkingResult 13 bytes
Description Requests the result of the last marking.

Target None

Command
WX None
Response

1 RX
Command

Response
RX,MarkingResult

RX,OK,A,B

Marking result
Communication Interface

A: 0/1 1 byte 0: Failure


Parameter 1: Success

B: 000000000000 to 999999999999 12 bytes Execution time (ms)

• The result of the last execution is acquired. The result of the last execution will be cleared when the job No. of the currently operating job
is changed.

(18) Request the pre-marking lens inspection result


Command WindowCheckBeforeMarkingResult 30 bytes
Description Requests the last pre-marking lens inspection result

Target None

Command
WX None
Response

Command RX,WindowCheckBeforeMarkingResult [CR]


RX
Response RX,OK,A,B,C,D,E,F,G,H,I,J,K,L,M [CR]

Execution result
A: 0/1 1 byte 0: Not executed
1: Executed

B: 000 to 100 3 bytes Total score


Parameter C: 000 to 100 3 bytes First score

L: 000 to 100 3 bytes Tenth score

M: 0000 to 9999 4 bytes Execution time (ms)

(19) Request the post-marking lens inspection result


Command WindowCheckAfterMarkingResult 29 bytes
Description Requests the last post-marking lens inspection result

Target None

Command
WX None
Response

Command RX,WindowCheckAfterMarkingResult [CR]


RX
Response RX,OK,A,B,C,D,E,F,G,H,I,J,K,L,M [CR]

Execution result
A: 0/1 1 byte 0: Not executed
1: Executed

B: 000 to 100 3 bytes Total score


Parameter C: 000 to 100 3 bytes First score

L: 000 to 100 3 bytes Tenth score

M: 0000 to 9999 4 bytes Execution time (ms)

1-70 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(20) Request the filename of the image captured with the camera
Command CameraImageFilepath 19 bytes
Description Requests the filename of the image captured with the built-in camera during the last marking.

Target None

Command None
WX
Response None

RX
Command

Response
RX,CameraImageFilePath=A,B [CR]

RX,OK,C,D [CR] 1
Target image

Communication Interface
0: Marking confirmation function
1: 2D code reader
A: 0 to 9 1 byte
2: Pre-marking capture
3: Post-marking capture
4: XY tracking

Parameter XY tracking setting No.


B: 000 to 007 3 bytes
* When A is 0 to 3, the value is fixed to 0.

Presence of target image


C: 0/1 1 byte 0: Absent
1: Present

File path
D: Character string
* image/yyyymmddhh/mm/file name

• Acquisition fails when Save is not selected for each image in [Image Save Settings] of the job settings.
• This command cannot be used for the MD-X400(A)/450(A).
• Starting from the image folder, the actual path to the saved file is returned in the file path.

(21) Request the marking confirmation results


Command MarkingConfirmationResult 25 bytes
Description Requests the result of the last marking confirmation function.

Target None

Command
WX None
Response

Command RX,MarkingConfirmationResult [CR]


RX
Response RX,OK,A,B,C,D [CR]

Execution result
A: 0/1 1 byte 0: Not executed
1: Executed

Marking confirmation result


Parameter B: 0/1 1 byte 0: Failure
1: Success

C: 000 to 100 3 bytes Score

D: 0000 to 9999 4 bytes Execution time (ms)

The result of the last execution is acquired. The result of the last execution will be cleared when the job No. of the currently operating job is
changed.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-71


Command Details

(22) Request the 2D code reader result


Command CodeReadResult 14 bytes
Description Requests the result of the last 2D code reading.

Target None

Command
WX None
Response

1 RX
Command

Response
RX,CodeReadResult=A [CR]

RX,OK,B,(C ~ V,)W,X,Y [CR]

Acquire detailed grade


Communication Interface

A: 0/1 1 byte 0: Do not acquire


1: Acquire

B: A to D/F/- 1 byte Total grade

79 bytes
C to V: A to D or 00.000 to 99.999 (including Detailed grade
comma)

W: 000 to 100 3 bytes Matching level

X: 000000 to 999999 6 bytes Reading time

Y: Character string Read data

Detailed grade

C: 1 byte DEC: Decoding success/failure

D: 1 byte CC: Cell contrast

E: 6 bytes CC: Cell contrast

F: 1 byte CM: Cell modulation

G: 1 byte RM: Reflectance margin

H: 1 byte FPD: Fixed pattern damage


Parameter
I: 1 byte AN: Axial non-uniformity

J: 6 bytes AN value: Axial non-uniformity

K: 1 byte GN: Grid non-uniformity

L: 6 bytes GN value: Grid non-uniformity

M: 1 byte UEC: Unused error correction

N: 6 bytes UEC value: Unused error correction

O: 1 byte FID: Format information damage

P: 6 bytes FID value: Format information damage

Q: 1 byte VID: Model information damage

R: 6 bytes VID value: Model information damage

S: 1 byte PGH: Print scaling-horizontal

T: 6 bytes PGH value: Print scaling-horizontal

U: 1 byte PGV: Print scaling-vertical

V: 6 bytes PGV value: Print scaling-vertical

• The last result of the 2D code reading performed by the method other than the workflow will also be acquired.
• The result of the last execution is acquired. The result of the last execution will be cleared when the job No. of the currently operating job
is changed.
• Controllers activated with the MD-AD-2DRA cannot acquire results other than the total grade and read data.
For reading time and matching level, “-” is returned. For detailed grade, “0” or “F” is returned.
• This command cannot be used for the MD-X400(A)/450(A).

1-72 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(23) Request the marking energy result


Command MarkingEnergyResult 19 bytes
Description Requests the last marking energy result.

Target None

Command
WX None
Response

RX
Command

Response
RX,MarkingEnergyResult [CR]

RX,OK,A,B,C [CR] 1
Execution result

Communication Interface
A: 0/1 1 byte 0: Not executed
1: Executed

Parameter Marking Energy result


B: 0/1 1 byte 0: Failure
1: Success

C: 00000.01 to 99999.99 8 bytes Energy (J)

• The result of marking energy cannot be acquired unless 2 seconds have passed after marking is complete.
• When this command is sent within 2 seconds after completion of marking, the Not executed result will be returned.
• This command cannot be used for the MD-X400(A)/450(A). If the command is executed, an S095 Model Limitation Error will occur.

(24) Acquire the number of marked matrix cells


Command MatrixCellMarkingCount 22 bytes
Description Acquires the number of marked matrix cells.

Target None

Command
WX None
Response

Command RX,MatrixCellMarkingCount [CR]


RX
Response RX,OK,A,B,C [CR]

A: 00000 to 65025 3 bytes Number of matrix cells

Number of target cells


Parameter B: 00000 to 65025 3 bytes
(Number of cells with marking flags set to ON)

C: 00000 to 65025 3 bytes Number of marked cells

• For parameter C, the number of cells which have actually been marked is returned, and those with marking flags set to OFF or which
were not marked due to the result of Z tracking are excluded.
• The result of the last marking is acquired. The result of the last execution will be cleared when the job No. of the currently operating job is
changed.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-73


Command Details

Matrix setting
(1) Matrix row & column setting (Set/Request)
Command MatrixSetting 13 bytes
Description Sets/Requests the number of rows/columns and marking direction of a matrix.

Target JOB = 0000 to 1999

1 WX
Command

Response
WX,JOB=0000,MatrixSetting=A,B,C[CR]

WX,OK [CR]
Communication Interface

Command RX,JOB=0000,MatrixSetting[CR]
RX
Response RX,OK,A,B,C[CR]

A:001 to 255 3 bytes Line count

B: 001 to 255 3 bytes Number of columns

Marking direction
Parameter 1: Horizontal
2: Vertical
C:1/2/4/5 1 byte
4: Horizontal (Alternate)
5: Vertical (Alternate)
* Default value “1”

(2) Matrix size setting (Set/Request)


Command MatrixSize 10 bytes
Description Sets/Requests the height, height specification method, width, and width specification method of a matrix.

Target JOB = 0000 to 1999

Command WX,JOB=0000,MatrixSize=A,B,C[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,MatrixSize[CR]
RX
Response RX,OK,A,B,C[CR]

Height specification method


0: Cell height
A:0/2/3 1 byte 2: Maximum distance
3: Matrix height
* Default value “0”

B: Depends on the area size


Height (mm)
Normal : 000.000 to 125.000
7 bytes * Default value “15” for Normal/Wide, and “5”
Other model : “Matrix Height/Width” of “Model-
for Small
Specific Input Value List” (Page 1-92)
Parameter
Width specification method
0: Cell width
C:0/2/3 1 byte 2: Maximum distance
3: Matrix width
* Default value “0”

D: Depends on the area size


Width (mm)
Normal : 000.000 to 125.000
7 bytes * Default value “15” for Normal/Wide, and “5”
Other model : “Matrix Height/Width” of “Model-
for Small
Specific Input Value List” (Page 1-92)

1-74 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(3) Matrix cell reference point (Set/Request)


Command CellReferencePoint 18 bytes
Description Sets/Requests the cell reference point of a matrix.

Target JOB = 0000 to 1999

Command WX,JOB=0000,CellReferencePoint=A[CR]
WX
Response WX,OK [CR]

RX
Command

Response
RX,JOB=0000,CellReferencePoint[CR]

RX,OK,A[CR] 1
Cell base point

Communication Interface
02: Center
03: Lower left
Parameter A:2 to 6 1 bytes 04: Lower right
05: Upper left
06: Upper right
* Default value “2”

If you change the θ angle of the cell coordinates of the matrix (MatrixCell), it will rotate around this reference point.

(4) Cell individual setting (Set/Request)


Command MatrixCell 10 bytes
Specifies the matrix cell and changes/requests the marking enable/disable, X/Y/Z coordinate correction, θ angle
Description
correction and marking start wait time.

Target JOB=0000 to 1999, CEL=00001 to 65025

Command WX,JOB=0000,CEL=00001,MatrixCell=A,B,C,D,E,F[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,CEL=00001,MatrixCell[CR]
RX
Response RX,OK,A,B,C,D,E,F[CR]

Marking flag
0: Do not Mark
A:0/1 1 byte
1: Mark
* Default value “1”

B: Depends on the area size


Normal : -062.500 to 0062.500 X coordinate (mm)
8 bytes
Wide :-165.000 to 0165.000 Default value “0”
Small : -025.000 to 0025.000

C: Depends on the area size


Normal : -062.500 to 0062.500 Y coordinate (mm)
Parameter 8 bytes
Other model : “Y coordinate” of “Model-Specific Default value “0”
Input Value List” (Page 1-92)

D: Depends on the area size


Normal : -021.000 to 0021.000 Z coordinate (mm)
8 bytes
Wide :-021.000 to 0021.000 Default value “0”
Small : -015.000 to 0015.000

θ angle (°)
E:-180.000 to 0180.000 8 bytes
Default value “0”

Wait time for start marking (ms)


F: 00000.0 to 65000.0 7 bytes
* Default value “0”

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-75


Command Details

(5) Cell marking flag (Set)


Command MatrixCellEnable 16 bytes
Description Sets the marking flag of matrix cells in binary.

Target JOB=0000 to 1999, CEL=00001 to 65025

Command WX,JOB=0000,CEL=00001,MatrixCellEnable=A,BBB---[CR]
WX
Response WX,OK [CR]

1 RX
Command

Response
None

Reset the marking flag


Communication Interface

0: Set the marking flag of all cells to OFF


A:0/1/2 1 byte 1: Set the marking flag of all cells to ON
2: Do not change other than the specified
cells
Parameter Marking flag
0: Do not Mark
1: Mark
B:0/1 1 byte
* You can change the marking flag of
continuous cells in a batch by sending this
parameter in multiple digits.

To change the marking flag of multiple cells in a batch, send parameter B in multiple digits.
To set cell No.10 to ON, No.11 to OFF, No.12 to ON and all other cells to OFF, send the command as described below.
WX,JOB=0000,CEL=00010,MatrixCellEnable=0,101[CR]

(6) Matrix position setting (Set/Request)


Command MatrixPosition 14 bytes
Description Sets/Requests the reference point and X/Y coordinates of a matrix.

Target JOB = 0000 to 1999

Command WX,JOB=0000,MatrixPosition=A,B,C[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,MatrixPosition[CR]
RX
Response RX,OK,A,B,C[CR]

Base point
00: Left edge
01: Right edge
02: Center
03: Lower left
A:00 to 08 2 bytes 04: Lower right
05: Upper left
06: Upper right
07: Top
08: Bottom
Parameter * Default value “2”

B: Depends on the area size


Normal : -062.500 to 0062.500 X coordinate (mm)
8 bytes
Wide :-165.000 to 0165.000 * Default value “0”
Small : -025.000 to 0025.000

C: Depends on the area size


Normal : -062.500 to 0062.500 Y coordinate (mm)
7 bytes
Other model : “Y coordinate” of “Model-Specific * Default value “0”
Input Value List” (Page 1-92)

(7) Count using invalid marking cells (Set/Request)


Command InactiveCellCount 17 bytes
Description Sets/Requests the setting of whether or not to count the invalid marking cells when marking a counter in a matrix.

Target JOB = 0000 to 1999

Command WX,JOB=0000,InactiveCellCount=A[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,InactiveCellCount[CR]
RX
Response RX,OK,A[CR]

Count the invalid marking cells


0: Disabled
Parameter A:0/1 1 byte
1: Enabled
* Default value “0”

1-76 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

Group/Counter setting
(1) Group setting (Set/Request)
Command GroupOffset 11 bytes
Specifies the group and changes/requests the X/Y coordinate correction, θ angle correction, and marking enable/
Description
disable setting.

Target

WX
Command
JOB=0000 to 1999,GRP=000 to 255

WX,JOB=0000,GRP=000,GroupOffset=A,B,C,D[CR] 1
Response WX,OK [CR]

Communication Interface
Command RX,JOB=0000,GRP=000,GroupOffset[CR]
RX
Response RX,OK,A,B,C,D[CR]

A: Depends on the area size


Normal : -062.500 to 0062.500 Shift X(mm)
8 bytes
Other model : “X coordinate” of “Model-Specific * Default value “0”
Input Value List” (Page 1-92)

B: Depends on the area size


Normal : -062.500 to 0062.500 Shift Y(mm)
Parameter 8 bytes
Other model : “Y coordinate” of “Model-Specific * Default value “0”
Input Value List” (Page 1-92)

C: -180.000 to 0180.000 8 bytes Shift θ(mm)

Marking flag
D:0/1 1 byte 0: Disabled
1: Enabled

You can only create new groups using Marking Builder Plus. The group number assigned when you created a group in Marking Builder Plus
will be the number of the target specifier GRP.

(2) Counter setting (Set/Request)


Command CounterSetting 14 bytes
Description Specifies the counter No. and changes/requests the various counter settings.

Target JOB=0000 to 1999,CTR=0 to 9/A to J,

Command WX,JOB=0000,CTR=0,CounterSetting=A,B,C,D,E,F,G,H,I[CR]
WX
Response WX,OK [CR]

Command RX,JOB=0000,CTR=0,CounterSetting[CR]
RX
Response RX,OK,A,B,C,D,E,F,G,H,I[CR]

Step
A:00000 to 10000 5 bytes
* Default value “1”

Enabling the default value


0: Disabled
B:0/1 1 byte
1: Enabled
* Default value “0”

Default value
C: 0000000000 to 4294967295 10 bytes * B: Fixed value of “0” when 0
* Default value “0”

Leading value
D: 0000000000 to 4294967295 10 bytes
* Default value “0”

Final value
E:0000000000 to 4294967295 10 bytes
* Default value “4294967295”

Parameter Marking count


F: 0000000000 to 4294967295 10 bytes
* Default value “1”

Reset timing
0: Trigger
1: I/O
2: Power on
G: 0 to 5 1 bytes
3: When switching the job No.
4: When the date changes
5: When the shift code is switched
* Default value “1”

Count timing
0: Trigger
H:0/1 1 byte
1: Each matrix cell/group/marking
* Default value “0”

Base
I: 02 to 36 2 bytes
* Default value “10”

The target specifier JOB can be omitted if you are specifying a common counter.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-77


Command Details

Operation time
(1) Request the controller operating time
Command OperatingTime 13 bytes
Description Requests the operating time of the laser marker.

Target None

1 WX
Command

Response
None
Communication Interface

Command RX,OperatingTime[CR]
RX
Response RX,OK,A[CR]

Parameter A:00000 to 99999 5 bytes Cumulative operation time (h)

(2) Request the laser excited


Command LaserOperatingTime 18 bytes
Description Requests the amount of time the laser has been in the excited state.

Target None

Command
WX None
Response

Command RX, LaserOperatingTime[CR]


RX
Response RX,OK,A[CR]

Parameter A: 00000 to 99999 5 bytes Laser excited time (h)

(3) Request the scanner operating time


Command ScannerOperatingTime 20 bytes
Description Requests the scanner operating time

Target None

Command
WX None
Response

Command RX, ScannerOperatingTime[CR]


RX
Response RX,OK,A[CR]

Parameter A: 00000 to 99999 5 bytes Scanner operating time (h)

(4) Request the number of shutter operations


Command ShutterOperatingCount 21 bytes
Description Requests the number of shutter cycles performed.

Target None

Command
WX None
Response

Command RX,ShutterOperatingCount[CR]
RX
Response RX,OK,A[CR]

Parameter A:0000000000 to 4294967295 10 bytes Number of shutter operations (times)

(5) Request the number of laser safety module operations


Command LaserSafetyModuleOperatingCount 31 bytes
Description Requests the number of times of times the laser safety module has been operated.

Target None

Command
WX None
Response

Command RX, LaserSafetyModuleOperatingCount[CR]


RX
Response RX,OK,A[CR]

Number of laser safety module operations


Parameter A:0000000000 to 4294967295 10 bytes
(times)

1-78 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(6) Request the head temperature


Command MarkingUnitTemperature 22 bytes
Description Requests the head temperature.

Target None

Command
WX None
Response

RX
Command

Response
RX,MarkingUnitTemperature[CR]

RX,OK,A[CR] 1
Parameter A:-999.9 to 0999.9 6 bytes Head temperature (°C)

Communication Interface
(7) Request the controller temperature (°C)
Command ControllerTemperature 21 bytes
Description Requests the controller temperature.

Target None

Command
WX None
Response

Command RX,ControllerTemperature[CR]
RX
Response RX,OK,A[CR]

Parameter A:-999.9 to 0999.9 6 bytes Controller temperature (°C)

(8) Request the result of laser power calibration


Command LaserPowerCalibrationResult 27 bytes
Description Requests the result of laser power calibration.

Target None

Command
WX None
Response

Command RX,LaserPowerCalibrationResult[CR]
RX
Response RX,OK,A,B[CR]

Existence of calibration execution


A: 0/1 1 byte 0: None
Parameter 1: Yes

B: 000.00 to 999.99 6 bytes Calibration result (W)

(9) Cumulative marking count 1 and 2 (Set/Request)


Command CumulativeMarkingCount 22 bytes
Description Sets and request the cumulative marking count 1 and 2 .

Target None

Command WX,CumulativeMarkingCount=A,B[CR]
WX
Response WX,OK [CR]

Command RX,CumulativeMarkingCount[CR]
RX
Response RX,OK,A,B[CR]

A:0000000000 to 4294967295 10 bytes Cumulative marking count 1


Parameter
B: 0000000000 to 4294967295 10 bytes Cumulative marking count 2

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-79


Command Details

Maintenance
(1) Request the lens inspection result
Command WindowCheckResult 17 bytes
Description Requests the result of the lens inspection maintainable as well as the date it was last performed.

Target -

1 WX
Command

Response
-

-
Communication Interface

Command RX,WindowCheckResult[CR]
RX
Response RX,OK,A,B,C,D,E[CR]

Whether the lens inspection has been


conducted
A:0 to 1 1 bytes
When not conducted at all: 0
When it has been conducted: 1

Year conducted
B: 0000 to 2099 4 bytes
(when not conducted at all: 0000)
Parameter
Month conducted
C: 00 to 12 2 bytes
(when not conducted at all: 00)

Day conducted
D: 00 to 31 2 bytes
(when not conducted at all: 00)

Conducted result
E:000 to 100 3 bytes
(when not conducted at all: 000)

It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

(2) Set/Request the sensitivity of the lens inspection


Command WindowCheckSensitivity 22 bytes
Description Sets/Requests the sensitivity of the lens inspection.

Target None

Command WX,WindowCheckSensitivity=A[CR]
WX
Response WX,OK [CR]

Command RX,WindowCheckSensitivity[CR]
RX
Response RX,OK,A[CR]

Lens inspection sensitivity at startup


0: Standard
Parameter A:0/1/2 1 byte 1: High sensitivity 1
2: High sensitivity 2
* Default value “0”

It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

(3) Set/Request the lens inspection at startup


Command WindowCheckStartup 18 bytes
Description Sets/Requests the lens inspection at startup

Target None

Command WX,WindowCheckStartup=A[CR]
WX
Response WX,OK [CR]

Command RX,WindowCheckStartup[CR]
RX
Response RX,OK,A[CR]

Lens inspection at startup


0: Do not conduct
Parameter A:0/1 1 byte
1: At every startup
* Default value “1”

It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

1-80 - MD-X2000/2500 Series Communication Interface User’s Manual -


Command Details

(4) Set/Request the lens inspection alarm threshold.


Command WindowCheckAlarmThreshold 25 bytes
Description Sets/Requests the lens inspection threshold. Inspection results under this threshold will produce a warning.
Target None
Command WX,WindowCheckAlarmThreshold=A[CR]
WX
Response WX,OK [CR]

1
Command RX,WindowCheckAlarmThreshold[CR]
RX
Response RX,OK,A[CR]
Parameter A:0~100 3 bytes Value of the lens inspection result

Communication Interface
It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

(5) Start the lens inspection


Command WindowCheck 11 bytes
Description Executes the lens inspection.

Target None

Command WX,WindowCheck[CR]
WX
Response WX,OK,A[CR]

Command
RX None
Response

Parameter A:0~100 3 bytes Value of the lens inspection result

It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

(6) Laser power measurement


Command LaserPowerCheck 15 bytes
Measures the laser power. It takes about 10 seconds for the measurement. The shutter closes, and the marking point is
Description
not irradiated.

Target None

Command WX,LaserPowerCheck=A,B[CR]
WX
Response WX,OK,C[CR]

Command
RX None
Response

A:000.0~100.0 5 bytes Laser Power (%)

Parameter B:000/040~400 3 bytes Pulse frequency (kHz)

C:000.00~999.99 6 bytes Output power (W)

It cannot be used on the MD-X400(A)/450(A) series.

(7) Delete all logging data


Command LoggingClearAllData 19 bytes
Description Deletes all logging data.

Target None

Command WX,LoggingClearAllData[CR]
WX
Response WX,OK [CR]

Command
RX None
Response

(8) Delete logging data with a specified period


Command LoggingClearData 16 bytes
Description Delete log data in the internal memory by specifying a period.

Target None

Command WX,LoggingClearData=A,B
WX
Response WX,OK

Command
RX None
Response

A:0000000000 to 9999999999 8 bytes Start date: yyyymmddhh


Parameter
B: 0000000000 to 9999999999 8 bytes End date: yyyymmddhh

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-81


Applied Functions

Applied Functions
This chapter provides information on omission of parameters, convenient command usages, and how to create new settings using only commands.

Variable-length support
1 The unwanted “0” can be omitted when sending the setting values to the laser marker using the Write command.

„ Omission of the command for changing the currently running job No. to “1”
Communication Interface

Command WX,JobNo=0001[CR]

Response WX,OK [CR]

Change the job No. to variable-length

Command WX,JobNo=1[CR]

Response WX,OK [CR]

Variable-length support complete

„ Omission of the command for changing the position correction values


Command WX,AllPosition=-90.000,000.000,090.000,-062.500,0000.000,21.000[CR]

Response WX,OK [CR]

Change the correction value to variable-length

Command WX,AllPosition=-90,0,90,-62.5,0,21[CR]

Response WX,OK [CR]

Variable-length support complete

Omission of target specifiers


In the following cases, you can send the command omitting the target specifier.

If the currently running job No. is the target


You can omit the target specifier if you are specifying the currently running job No. using the “JOB” target specifier.

„ Omission of the command for changing the title of the currently running job No.0001 to “ABC”
Command WX,JOB=0001,Title=ABC[CR]

Response WX,OK [CR]

You can omit “JOB” as this is a currently running job No.

Command WX,Title=ABC[CR]

Response WX,OK [CR]

Omission complete

1-82 - MD-X2000/2500 Series Communication Interface User’s Manual -


Applied Functions

If block No.000 is the target


You can omit the target specifier if you are specifying block No. 000 using the “BLK” target specifier.

„ Omission of the command for changing the block No.000 string of the currently running job
No.0001 to “ABC”
Command WX,JOB=0001,BLK=000,CharacterString=ABC[CR]

Response WX,OK [CR]

You can omit “BLK” for block No.000.


1

Communication Interface
Command WX,JOB=0001,CharacterString=ABC[CR]

Response WX,OK [CR]

You can omit “JOB” as this is a currently running job No.

Command WX,CharacterString=ABC[CR]

Response WX,OK [CR]

Omission complete

Omission of parameters
If you only wish to change some parameters using a command that have multiple parameters, you can send the command omitting those parameters
you do not need to change.

„ Omission of the command changing only the C: Day setting value out of the six date/time setting
parameters (A: Year, B: Month, C: Day, D: Hour, E: Minute, F: Second)
To change the current time setting of 2014/12/20/11: 38: 20 to 2014/12/21/11: 38: 20

Command WX,TimeSetting=2014,12,21,11,38,20[CR]

Response WX,OK[CR]

Omit the unwanted parameters

Command WX,TimeSetting=,,21,,,[CR]

Response WX,OK【CR】

Variable-length support complete

• The omitted settings will retain their current status.


• The number of separator commas remain unchanged.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-83


Applied Functions

Sending of linked commands


You can link commands and send them together when sending commands to the same job No. for multiple times. Moreover, you can omit the already-
specified target specifier when linking commands. Enter a target specifier only if you wish to re-specify the target in the middle of a command.

• You cannot link and send a command targeting two or more job No.
• You cannot link and send commands that are related to “Operation/Current Value” or “Status/Controller Setup”.

1 For WX command
Communication Interface

To send the command with a linked WX command, link the command by adding “WX” only to the first command and removing “WX” from the second and
subsequent commands.

„ Omission of the command for changing the block No.1 string of the currently running job No.0001
to “ABC”, and the block No.2 string to “123”
1. Command WX,JOB=0001,BLK=001,CharacterString=ABC[CR]

2. Response WX,OK[CR]

3. Command WX,JOB=0001,BLK=002,CharacterString=123[CR]

4. Response WX,OK[CR]

You can link the commands as they are changing blocks in the same job No.

Command WX,JOB=0001,BLK=001,CharacterString=ABC,JOB=0001,BLK=002,CharacterString=123[CR]

Response WX,OK[CR]

You can omit the “JOB” on the end as the job No. are the same.

Command WX,JOB=0001,BLK=001,CharacterString=ABC,BLK=002,CharacterString=123[CR]

Response WX,OK[CR]

You can omit “JOB” as this is a currently running job No.

Command WX,BLK=001,CharacterString=ABC,BLK=002,CharacterString=123[CR]

Response WX,OK[CR]

You can omit “0s” as they are unnecessary for the parameters.

Command WX,BLK=1,CharacterString=ABC,BLK=2,CharacterString=123[CR]

Response WX,OK[CR]

Omission complete

1-84 - MD-X2000/2500 Series Communication Interface User’s Manual -


Applied Functions

For RX command
To send the command with a linked RX command, link the command by adding “RX” only to the first command and removing “RX” from the second and
subsequent commands. A response is returned in the order of the requesting commands.

„ Omission of the command for requesting the block No.1 (String: ABC) and No.2 (String: 123) string
setting of the currently running job No. 0001
1. Command

2. Response
RX,JOB=0001,BLK=001,CharacterString[CR]

RX,OK,ABC[CR]
1
3. Command RX,JOB=0001,BLK=002,CharacterString[CR]

Communication Interface
4. Response RX,OK,123[CR]

You can link the commands as they are requests in the same job No.

Command RX,JOB=0001,BLK=001,CharacterString,JOB=0001,BLK=002,CharacterString[CR]

Response RX,OK,ABC,123[CR]

You can omit the “JOB” on the end as the job No. are the same.

Command RX,JOB=0001,BLK=001,CharacterString,BLK=002,CharacterString[CR]

Response RX,OK,ABC,123[CR]

You can omit “JOB” as this is a currently running job No.

Command RX,BLK=001,CharacterString,BLK=002,CharacterString[CR]

Response RX,OK,ABC,123[CR]

You can omit “0s” as they are unnecessary for the parameters.

Command RX,BLK=1,CharacterString,BLK=2,CharacterString[CR]

Response RX,OK,ABC,123[CR]

Omission complete

Linking the communication command (WXC command)


You can link and send commands by using WXC command. Commands relating to operation can also be linked. The response will return when all the
command processing has been completed. If an error occurs on a command, commands before the error are executed but commands after the error are
not. In case of linking the commands, put “WXC,” at the beginning and link the commands with “,%,”.

„ In case of changing a character string and then continue the marking.


Command WXC,WX,JOB=000,BLK=000,CharacterString=ABC,%,WX,StartMarking[CR]

Response WXC,OK [CR]

• Up to 128 commands can be linked up.


• The request commands (RX commands) cannot be used. When the request commands are linked, no error will occur as long as
the commands are proccessed correctly, but the results of the requests do not return as a response.

„ When an error occurs in the middle of linking commands.


The following linking command that switches the marking job to No.10 after the recent job's marking is finished. The error response below returns if there
is no marking job in No.10.

Command WXC,WX,StartMarking,%,WX,JobNo=10[CR]

Response WXC,NG,cmd_index=002,E015,No Job Error[CR]

cmd_index = No. of the linking commands on which an error occurs. 000 indicates errors occur on WXC command. 001 or the subsequent number
indicates errors occur on the linking commands.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-85


Applied Functions

Creating new settings


Follow the workflow below if you are creating new settings using only a communication path.

(1) Starting the creation of a new program


Declare a start of job creation on a non-registered job No. using the following command:

Command CreateJob 13 bytes

1 Description
Declare a start of job creation on a non-registered job No. using the following command: The specified job No. will stop
the expansion processing until “EndJob” is input.

Target None
Communication Interface

Command WX,CreateJob=A[CR]
WX
Response WX,OK[CR]

Command
RX None
Response

Parameter A:0000 to 1999 4 bytes Specifies the job No.

• When you declare “CreateJob” on a non-registered job No., a job will be created with all parameters in their default values.
• By declaring “CreateJob” on an existing job No., you can change the desired job parts using this job file as a base.
• If you wish to initialize the job contents every time you create a job, insert “CreateJobWithAllClear” into the command.
• The XY tracking and Z tracking settings cannot be created.
• If you start editing with CreateJob, do not change any setting contents or edit anything other than the job number until ending editing with
EndJob. Doing so will cause an error in EndJob, preventing editing from completing normally.

(2) Setting the required job and block information


The command required to print a single block is described below.

Contents Command Reference


Head orientation HeadDirection 1-25
Block type BlockType 1-33
String settings CharacterString 1-34
Character size CharacterSize 1-38
Block coordinate BlockPosition 1-44
Marking parameters MarkingParameter 1-46

Since all commands other than the string setting command have a default value, you can create new settings even if you omit these values.

(3) Ending the program creation


You can finish editing the job using the command described below.

Command EndJob 10 bytes


Description Declares the end of job editing.

Target None

Command WX,EndJob[CR]
WX
Response WX,OK[CR]

Command
RX None
Response

Parameter None

If the settings are in their default values and the mark data is the “ABC” string, the program can be configured using just three commands as
described below.
• WX,CreateJob=0001[CR]
• WX,JOB=0001,BLK=001,CharacterString=ABC[CR]
• WX,EndJob[CR]

1-86 - MD-X2000/2500 Series Communication Interface User’s Manual -


Communication Errors

Communication Errors
Error response
An error response is returned if there is an error in the command format or data range. All error responses will have the error number “S***” and error
code on the end of the command.

1
Send WX,Command[CR]

Normal response: WX,OK[CR]


Receive
Error response: WX,NG,S***,ErrCode[CR]

Communication Interface
Error list

Error No. Error name Remedy

Check whether the parameter is within the input range.


S000 Job Incorrect Error
Create the job again if no corrupt location can be found.
S001 Job Memory Full Error Remove unwanted jobs from the controller.
Built-in memory card full
S002 Remove unwanted logos, fonts, and Z-MAP data from the controller.
error
S003 USB flash drive full error Remove unwanted data from the USB flash drive.
USB flash drive not
S004 Perform the operation after inserting a USB flash drive.
inserted error
USB flash drive cannot Format the USB flash drive in FAT** format and try again.
S005
be recognized error Try using a different USB flash drive if the error reoccurs.
The console and/or external communication has acquired communication priority.
S006 Priority error Check if the other devices are in test marking or finder mode, check if another device is controlling the
laser marker, and perform the operation after exiting from these modes.
S008 No-File Error Perform the communication again using an existing file as the target.
S009 Busy Error Perform the operation when the laser is in the READY state.
S010 No marking block error Set the marking flag to ON for one or more target blocks (Matrix).
Logos/custom characters
S011 Reduce the number of files.
over error
Scan speed optimization
S012 Reduce the line speed or adjust the character size, etc.
error
Scan Optimize
S013 Set the quality level of all blocks to [Customize].
unexecutable error
Job Operation During
S014 The currently running job cannot be deleted.
Execution Error
Logo/custom character
S015 First remove the job that is using the logo or custom character you wish to delete.
file operation error
Acquiring Mastership
S016 Start marking after the device has gone into READY status or controlling status.
Error
Fixed point marking
S017 Modify the job to make sure that the fixed point and 3D shape blocks are not mixed.
parameter error
Barcode/2D code illegal
S018 Please enter an encoding string.
setting error
S019 All-setup restoration error Make sure to use the backup data from the same model.
S020 Data Length Error Noise may be entering the external communication cable if the error occurs in a sporadic manner.
Job Number Unregistered
S021 Transfer the job to the controller by following the procedure below.
Error
Select [Settings] - [File Operations] in the ribbon menu, and then Transfer the job settings to the
Block No. Not Registered controller.
S022
error
S023 Status error Reset the error and try marking again.
S024 Illegal Command Error Acquire the communication history and check the parameter input range and block type.
Check if the checksum settings for the laser marker and external devices (PLC, etc.) are both ON.
If there is no problem in the above, check if the checksum calculation method of the PLC is set to
S025 Checksum Error
horizontal parity (Exclusive OR).
Noise may be entering the external communication cable if the error occurs in a sporadic manner.
Incorrect format in the communication command. Acquire the communication history and check the
command details.
S026 Format error
If a comma (,) is used in the string, change it to "%044A" (special code representing a comma) before
sending it.
Command
S027 Invalid communication command. Acquire the communication history and check the command details.
Unrecognizable Error
Response data length
S028 Modify the request command to reduce the response data length.
error

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-87


Communication Errors

Error No. Error name Remedy

S029 Mark data request error Send the command after marking has completed.
Group the blocks in the job using Marking Builder Plus.
Group number
S030 You can group blocks by following the procedure below.
unregistered error
Select and right-click on a block to open the context menu, and then select [Grouping].
No Program Error
S031 Activate the 2D code reader function in Marking Builder Plus.
(2D code reader)

1
No Program Error
S032 (Marking confirmation Activate the marking confirmation function in Marking Builder Plus.
function)

No Program Error
S033 Activate the XY tracking or Z tracking function in Marking Builder Plus.
Communication Interface

(3-Axis Tracking)
Operation Limitation Error
S040
(2D Code Reader)
Operation Limitation Error
S041
(3D Marking)
Delete the job that uses the inactivated function or activate the target function..
Operation Limitation Error
S042
(Z Tracking)
Operation Limitation Error
S043
(XY Tracking)
Check the following when using the high speed character edit command.
Quick change of • Check if the block you wish to change is subject to high speed string editing.
S050
character setup error • Check that the string to be sent is registered as the character type that supports high speed string
editing.
Sample Marking
S051 Commence sample marking in READY state.
Unexecutable Error
Laser inspection
S052 Commence inspection laser in READY state.
unexecutable error
Block type incorrect
S060
setting error
Recreate the job.
Block assignment
S061
incorrect setting error
Character size incorrect
S062 Modify the blocks whose character aspect ratio is greater than 1:5 or 5:1.
setting error
Character assignment
S063
incorrect setting error
Character advanced
S064
incorrect setting error
Marking condition
S065
incorrect setting error
Barcode/2D code illegal
S066
setting error
Continuous marking
S067
incorrect setting error
Movement/marking
S068 direction incorrect setting Recreate the job.
error
Job Program Incorrect
S069
Error
Matrix information
S070
incorrect setting error
Matrix cell information
S071
incorrect setting error
Character string incorrect
S072
setting error
Individual counter
S073
incorrect setting error
Reconfigure the common counter settings by following the procedure below.
Common counter
S074 You can configure by selecting [Settings] - [Common Data] in the ribbon menu, followed by [Common
incorrect setting error
Counter].
Encoding information Reconfigure the encoding setting.
S075
incorrect setting error You can configure by selecting [Settings] - [Common Data] in the ribbon menu, followed by [Encoding].
System information
S076
incorrect setting error
Font replacement Recreate the job.
S077 information incorrect
setting error
Reconfigure the character scaling settings.
Font scaling information
S078 You can configure by selecting [Settings] - [Common Data] in the ribbon menu, followed by [Character
incorrect setting error
scaling].

1-88 - MD-X2000/2500 Series Communication Interface User’s Manual -


Communication Errors

Error No. Error name Remedy

Logo/custom character
S080 buffer information
incorrect setting error Recreate the job.
3D information incorrect
S083
setting error
A job loaded on the controller is using a function that has not been activated (e.g. 2D code reader).
S084 Operation limitation error
Delete the job that is using the unactivated function, or activate the necessary function.

S085 Data Version Error

Wobble Incorrect Setting


The loaded job has been created in a higher version than that of the connected Marking Builder Plus.
Upgrade Marking Builder Plus to the latest version, or downgrade the version of the loaded job. 1
S086 Check if the marking line width, overlap rate and scan speed settings are within range.
Error

Communication Interface
S087 2D code reading error Modify the job so that code reading is possible in test marking, then run the job again.
Working distance Height measurement may not be possible in the following cases:
S088
measurement error • Distance measuring light cannot be detected correctly because of the surface condition of the target.
Working distance
S089 measurement limitation Measure the work distance when the laser is in the READY state.
error
S090 Registered barcode error Change the barcode verification string.
Please check the following:
Barcode/2D code link
S091 • Check if the 2D code overprinting setting is enabled for the target block.
setting error
• Check if the target overprinting No. exists.
Barcode illegal
S092 Configure it in either Marking Builder Plus or the console.
registration state error
Marking Confirmation
S093 Check if the marked data exisits within the field of view of the confirmation coordinates.
Function Error
TrueType font file size
S094 Reduce the number of TrueType font types being used.
error
S095 Model limitation error Cannot be used.
S096 Open priority error Restart the device.
File may be read-only.
S097 File Access Error
Check the file attribute and try again.
The FNC specifier of the communication command is specified other than 00 (marking confirmation
Illegal Capturing
S100 function) and 01 (2D code reader).
Condition Error
Send the command using the correct FNC specifier number.

Window maintenance
S101 Window maintenance started by a communication command was cancelled.
cancelled

Z distance measuring
S102 Z coordinate acquisition performed by communication command failed.
failure

Tracking No. Registration


S103 Review the requesting number.
Error

Tracking Result Request


S104
Error

Logging Capture Result


S105 Request the result after marking.
Request Error

Workflow Result Request


S106
Error

Cell number specification


S107 The specified cell number does not exist. Specify one that does.
error

Distance laser unexcited The lens inspection start command was sent while the distance laser was not excited. Send this
S108
error command after exciting the laser.

Capturing Condition Auto If an error occurs in the “Capturing condition auto adjustment” of the 2D code reader, try again.
S109
Adjustment Error If an error occurs in the “Brightness and Magnification Adjustment” of the XY tracking, try again.

S110 No Log Data Execute after saving log data.

The routing table is full. The maximum number of paths that can be registered in this table is four.
S111 Routing Table Full Error
Delete registered paths.

User management
S112 The user management function is disabled.
function disable error

Simultaneous login The number of allowable simultaneous logins (four) was exceeded. Wait for another user to log out
S113
exceeded error before logging in.

User authentication
S114 User authentication failed. Make sure the password is correct.
failure error

S115 No user information error There is no user information. Make sure the user name is correct.

S116 OPC UA parameter error This is the response when an OPC UA method argument is incorrect. Check the arguments.

Check whether the timing of OPC UA processing, the parameters being used, the server certificate, and
S117 OPC UA internal error
the list of expired certificates are correct.

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-89


Communication Errors

Error No. Error name Remedy

Unregistered OPC UA
S118 The OPC UA session has not been registered.
session error

S120 Workflow error A workflow process failed. Check the workflow error details.

1
Communication Interface

1-90 - MD-X2000/2500 Series Communication Interface User’s Manual -


Appendix

Appendix
ASCII code list
Upper 4 bit
0 1 2 3 4 5 6 7 8 9 A B C D E F
0
1
NUL DLE SP
SOH DC1 !
0
1
@
A
P
Q
`
a
p
q
1
2 STX DC2 “ 2 B R b r

Communication Interface
3 ETX DC3 # 3 C S c s
4 EOT DC4 $ 4 D T d t
5 ENQ NAC % 5 E U e u
6 ACK SYN & 6 F V f v
7 BEL ETB ' 7 G W g w
Lower 4 bit
8 BS CAN ( 8 H X h x
9 HT EM ) 9 I Y i y
A LF SUB * : J Z j z
B VT ESC + ; K [ k {
C FF FS , < L \ l ―
D CR GS - = M ] m }
E SO RS . > N ^ n ~
F SI US / ? O _ o DEL

- MD-X2000/2500 Series Communication Interface User’s Manual - 1-91


Appendix

Model-Specific Input Value List


MD-X2000/2500 Series
Parameter Unit Standard area Wide area Small spot
MD-X2000(A)/2500(A) MD-X2020(A)/2520(A) MD-X2050(A)
Line width mm 0.010 to 5.000 0.010 to 7.500 0.010 to 2.500

1 Height/Width

Logo Height/Width
mm

mm
000.100 to 125.000

000.002 to 125.000
000.100 to 330.000

000.005 to 330.000
000.001 to 050.000

000.001 to 50.000
Communication Interface

Arc character space mm 000.000 to 180.000 000.000 to 450.000 000.000 to 075.000

Character space mm 000.000 to 180.000 000.000 to 450.000 000.000 to 075.000

Character full width/full height mm 000.100 to 180.000 000.100 to 450.000 000.100 to 075.000

Character pitch mm 000.000 to 180.000 000.000 to 450.000 000.000 to 075.000

Barcode height mm 000.200 to 125.000 000.300 to 330.000 000.100 to 050.000

Linear code height mm 000.200 to 125.000 000.500 to 330.000 000.100 to 050.000

X coordinate mm -062.500 to 0062.500 -165.000 to 0165.000 -025.000 to 0025.000

Y coordinate mm -062.500 to 0062.500 -165.000 to 0165.000 -025.000 to 0025.000

Z coordinate mm -021.000 to 0021.000 -021.000 to 0021.000 -015.000 to 0015.000

Sphere diameter, Cylinder diameter,


Bottom diameter of cone, Top diameter of mm 0000.200 to 0480.000 0000.200 to 1200.000 0000.200 to 0200.000
cone

Cone height mm 000.100 to 125.000 000.100 to 330.000 000.100 to 050.000

Scan speed mm/s 00001 to 12000 00001 to 08000 00001 to 06000

Approach scan speed mm/s 0 to 04000 0 to 06000 0 to 02000

Pulse frequency kHz 000 to 400

Spot variable - -210 to 0210 -210 to 0210 -150 to 0150

Deep dig amount mm 00.000 to 42.000 00.000 to 42.000 00.000 to 30.000

Matrix Height/Width mm 000.000 to 125.000 000.000 to 330.000 000.000 to 050.000

Line speed mm/s 0000.1 to 4000.0 0000.1 to 2000.0 0000.1 to 2000.0

Start Position mm -062.500 to 0062.500 -165.000 to 0165.000 -025.000 to 0025.000

End Position mm -062.500 to 0062.500 -165.000 to 0165.000 -025.000 to 0025.000

Z coordinate correction amount mm -42.000 to 042.000 -42.000 to 042.000 -30.000 to 030.000

Upper tolerance limit mm -20.999 to 042.000 -20.999 to 042.000 -14.999 to 030.000

Lower tolerance limit mm -42.000 to 20.999 -42.000 to 20.999 -30.000 to 014.999

Movement reference point X/Y


coordinates(Correct inside the horizontal mm -062.500 to 0062.500 -165.000 to 0165.000 -025.000 to 0025.000
plane)

Correction amount X/Y(Correct inside the


mm -125.000 to 0125.000 -330.000 to 0330.000 -050.000 to 0050.00
horizontal plane)

X/Y coordinates position correction in the unit


mm -062.500 to 0062.500 -165.000 to 0165.000 -025.000 to 0025.000
setup

Z coordinate position correction in the unit


mm -21.000 to 021.000 -21.000 to 021.000 -15.000 to 015.000
setup

1-92 - MD-X2000/2500 Series Communication Interface User’s Manual -


2
EtherNet/IP
2

EtherNet/IP
Getting Started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
What is EtherNet/IP?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
EtherNet/IP communication specifications
and functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Compatible laser markers . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Compatible PLCs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Cyclic communication . . . . . . . . . . . . . . . . . . . . . . . 2-3
Cyclic communication with the laser marker. . . . . . . . . . 2-3
How to configure the laser marker . . . . . . . . . . . . . . . . . . 2-3
Configuring the PLC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Status of device assignment of the MD information
area. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
Command communications. . . . . . . . . . . . . . . . . . . . . . . 2-20
When “Request” bit does NOT work. . . . . . . . . . . . . . . . 2-20
Ladder Program Example. . . . . . . . . . . . . . . . . . . . 2-21
KEYENCE KV Series Program Example. . . . . . . . . . . . . 2-21
OMRON PLC CJ2 Series Program Example. . . . . . . . . . 2-24
Studio 5000 Logix Designer Ladder Program
Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-27

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-1


Getting Started

Getting Started
What is EtherNet/IP? EtherNet/IP communication
EtherNet/IP is an industrial communication network proposed by the
specifications and functions
ODVA (Open DeviceNet Vendor Association,Inc.).
EtherNet/IP communications can be shared and used with standard „ EtherNet/IP communication specifications of
Ethernet and network communications. the laser marker
z Scanner and adapters Number of
16
In EtherNet/IP, one of the two devices opens a communication line connections

2
called a “connection” with the other device. The side that opens a
Keyence KV
connection is referred to as a “scanner” (originator); and the side that is 2 to 320 bytes
Series
opened is referred to as an “adapter” (target). Typically, the PLC is used
for the scanner. The laser marker is an adapter device. Cyclic communication OMRON
(Implicit messages) 2 to 320 bytes
Communication CJ/CS series
z Cyclic communication
EtherNet/IP

size
EtherNet/IP offers cyclic communication (Implicit message) for sending Rockwell
and receiving data on a periodic basis. It allows you to set the RPI Automation
2 to 320 bytes
(communication cycle) based on the priority of the sent/received data, ControlLogix
enabling sending and receiving of data with adjustment of the overall CompactLogix
communication load.

Communication cycle „ Overview of the EtherNet/IP functions of the


(RPI) setting laser marker
MD-X2000(A) : 10ms
You can read the laser marker statuses and/or execute various
MD-X2020(A) : 50ms
operations via the EtherNet/IP communication. Refer to the device map
MD-X2500(A) : 100ms
for details.

Compatible laser markers


Laser marker model Software
MD-X2000(A) MD-X2020(A) MD-X2500(A)
10ms 50ms 100ms MD-X2000/2500 Series, MD-X400/450 Series Marking Builder Plus

The MD-X400/450 Series can use an EDS file from the


MD-X2000 Series. EDS file.
In this case, some displays may be the contents of
the MD-X2000 series.

Compatible PLCs
For more details on how to configure each PLC, refer to the instruction manual of the corresponding PLC.

z Keyence
PLC model EtherNet/IP communication unit Firmware version Software

KV-3000/5000 Series KV-EP21V Ver.2 or later KV STUDIO (Ver.6.0 or later)


* The KV-7300/7500 series uses Ver. 8.0 or later,
KV-7000/8000 Series KV-XLE02/EP21V Ver.2 or later
The KV-XLE02 uses Ver. 9.2 or later,
KV-5500/7500/8000 Built-in port/KV-EP21V Ver.2 or later KV-8000 series uses Ver. 10.0 or later

z OMRON
PLC model EtherNet/IP communication unit Firmware version Software

SYSMAC CJ2 Built-in port/CJ1WEIP21 V1.0 or later

SYSMAC CJ1 CJ1WEIP21 V1.0 or later Cx-One (Ver.3.0 or later)

SYSMAC CS1 CS1WEIP21 V1.0 or later

z Rockwell Automation
PLC model EtherNet/IP communication unit Firmware version Software

1756 ControlLogix 1756-ENBT Ver.13 or later

1769 CompactLogix Built-in port Ver.13 or later


RsLogix5000 (Ver.13 or later)
OD firmwarelevel Series C,
1747 SLC5/05 Built-in port
FRN 10 or later

1761/1766 MicroLogix Built-in port/1761-NETENI


Series A, Revision A, FRN1 RsLogix500 (Ver.7.10 or later)
1762/1763/1764 MicroLogix 1761-NETENI

Either a straight or crossover LAN cable can be used.

2-2 - MD-X2000/2500 Series Communication Interface User’s Manual -


Cyclic communication

Cyclic communication
Cyclic communication with the laser marker How to configure the laser marker
Cyclic communication performs periodic communication (several to The laser marker is configured as follows using Marking Builder Plus.
several dozen ms) and is suitable for real-time control.
The communication cycle and communication size settings follow those
on the PLC settings. 1 Select [Controller] from the [Settings] tab, and
then [Ethernet Settings].
It is recommended to set the communication cycle to 10
ms or longer.

2 Set the Ethernet communication settings.


Set these items as appropriate for your network environment.
Setting example
2

EtherNet/IP
IP address 192.168.0.20

Subnet mask 255.255.255.0

Default gateway 0.0.0.0

PLC MD-X2000/2500 series

Laser marker Laser marker


information storage information storage
area area

Controller status Controller status

Error status Error status

Busy status Busy status

Reading result Communication Reading result


cycle
Configured
on the PLC side
Requested Requested
information Storage information Storage
area area

Marking instruction Marking instruction


3 Set Industrial Ethernet to [EtherNet/IP].
Reading instruction Reading instruction The EtherNet/IP setting items will appear.

Command
instruction
Command
instruction 4 Set the Input/Output assembly size.
These items should be set according to the PLC settings.

• Read the “Safety Information” in the user's Setting example


manual for the applicable model to perform
Endian Little-Endian
operation in the state that the safety is secured
by using security function even when the network Input assembly size 320 (bytes)
failure occurs.
• Confirm the safe operation by considering the Output assembly size 288 (bytes)
communication delay due to the communication
time or network overload state.

Even if you specify the update time for cyclic


communication to 10 ms or longer, the processing
may be delayed or the communication may be
disconnected by temporary timeout due to the
excessive temporary or continuous load on the
controller, caused by simultaneous communication
functions being used in the controller such as dialog
operations and commands. In such case, the periodic
communication settings and use condition need to
be reviewed. Be sure to check for these and other
problems in the operating performance before entering
production.

If you modify the EtherNet/IP settings, the unit must


be restarted for the changes to take effect.

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-3


Cyclic communication

Configuring the PLC

PLC settings
Configure the following settings on the PLC when using cyclic communication.
(1) The connection to be used
(2) The device settings to be used for cyclic communication
(For more details on the setting method, refer to the manual of each PLC.)

When using the KV series, (1) and (2) are set automatically when you make a selection in the KV STUDIO.

z Connection to be used
2 In EtherNet/IP, a connection is opened from the scanner during cyclic communication. There are many types of connections, and the connection available
is different for each device. The type of connection available for the laser marker is Exclusive Owner.

Connection type Data type Instance ID Size (bytes) RPI (ms)


EtherNet/IP

Exclusive Owner Result data (Input Assemblies) 0X64 (100) 2 to 320


1 to 10000
(Data transmission + control) Control data (Output Assemblies) 0X65 (101) 2 to 288

z What is Exclusive Owner?


This type of connection allows communication between the PLC and laser marker.
It allows you to send a marking start instruction from the PLC to the laser marker or send a status notification from the laser marker to the PLC.
Only a single [Exclusive Owner] connection can be set for a laser marker.

How to configure the KEYENCE KV series


Connect the KV with the PC using an Ethernet cable and launch KV STUDIO.

1 Create a new project. 3 Transfer the unit configuration to a PLC.


Select [Monitor/Simulator(N)] > [PLC Transfer(W)] to start the

2 In the [Unit Settings (2)] tab of the unit editor,


set the IP address and subnet mask of the
transfer.

unit having the port for EtherNet/IP.

4 Display the EtherNet/IP settings.


Select [Tools(T)] > [Built-in EtherNet Settings(E)] > [EtherNet/
IP(W)] to open the setting screen.

• Set the IP address such that it is different from that


of the laser marker.
• Match the subnet mask value with that of the laser
marker.
• If you are using a unit other than KV-
5500/7500/8000, configure the IP address
and subnet mask after adding the EtherNet/IP
communication unit (KV-EP21V) to the unit.

2-4 - MD-X2000/2500 Series Communication Interface User’s Manual -


Cyclic communication

5 Add the laser marker to a device. 8 Register the device comment.


Add the [MD-X2000/2500 Series] in the [Device List (1)] tab to the Double click the device comment in the project, and open the
device screen by drag and drop. device comment edit window. Switch distinct unit editing to “MD-X2”,
click the [Detail] button, and then click [Register unit Device] and
[Reg].

EtherNet/IP
If you cannot find the target model in the device list,
add MD-X2000/2500 from [EDS File(D)] > [Reg]. The
ez1 file is stored in the location described below.
C:\Program Files (x86)\keyence\Marking Builder
Plus_Ver*\etc\EtherNetIP\[model name]
(Ver* is the version of Marking Builder Plus.)

6 Set the IP address of the laser marker.


Match the IP address with the IP address set on the laser marker
side.

7 Save the settings and close the EtherNet/IP


screen.
Save the settings and close the screen after confirming that the
laser marker has been added under EtherNet/IP as shown below.

The device comment related to EtherNet/IP of the


laser marker will be registered automatically as follow.

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-5


Cyclic communication

How to configure the OMRON CJ2 series 4 Set the IP address of PLC.
After setting the IP address and subnet mask, select [Transfer[PC to
Connect the PLC with the laser marker using an Ethernet cable and launch Unit]], and transfer the parameter to the unit.
CX-Programmer.

1 Create a new project.

2 Connect PLC.
Select [Auto Online] > [Direct Online] from [PLC] menu. Select the
connection type with PLC to connect.

2
EtherNet/IP

• Set the IP address such that it is different from that


of the laser marker.
• Match the subnet mask value with that of the laser
marker.
• To enable the transferred settings, the unit needs to
be restarted.

5 Start up Network Configurator.


Right click [Built In EtherNet/IP Port] of connected PLC, select [Start
Special Application] and then [Start with Settings Inherited].
The [Select Special Application] screen appears, and select
[Network Configurator].

This part describes how to connect via USB.

3 Display the TCP/IP parameter edit screen of PLC.


Double click [I/O Table and Unit Setup] in the project workspace,
then double click [Built In EtherNet/IP Port] of connected PLC.

6 Select interface.
Select [Select Interface] > [CJ2 USB/Serial Port] from [Option] menu.

2-6 - MD-X2000/2500 Series Communication Interface User’s Manual -


Cyclic communication

7 Connect with PLC. 10 Display the device parameter edit window


Select [Connect] from the [Network] menu, set [Setup Interface] > Right click the PLC icon in the network window, and select
[Select Connect Network Port] > [Select Network] according to the [Parameter] > [Edit].
device environment, and then connect it.

8 Upload the network setting.


If [Upload] is selected from the [Network] menu, the IP address

11 Set the In-Consume/Out-Produce area tag.


of the device which has been connected to network is displayed.
Check that the IP address of the connection target device has been
displayed, select [OK], and complete the upload.
Select the [In-Consume] tab, and click [New].
Set the tag name to “E0_00000” (first address of input data
memory), and set the size to “320 Byte”.

EtherNet/IP
9 Install EDS file
Select [Install] from [EDS File] menu.

Next, select the [Out-Produce] tab, and click [New].


Set the tag name to “D00000” (first address of output data memory),
and set the size to “288 Byte”.

The EDS file of the laser marker is located in the


folder below.
C:\Program Files (x86)\keyence\Marking Builder
Plus_Ver*\etc\EtherNetIP\[model name]
(Ver* is the version of Marking Builder Plus.)
The data size of this setting method is the default
setting value.

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-7


Cyclic communication

12 Associate the tags between PLC and MD-X


Select the [Connection] tab.
Select the MD-X in the [Unregister Device List]. Then click [↓] to
register the device in [Register Device List].

2
EtherNet/IP

13 Double click the device to be registered, and


display the [Edit Connection] screen.
Set “Connection I/O Type”, “Originator Device”, and “Target Device”
as follow, and click [Reg].

z Setting example
€Connection I/O Type
Class1
€Originator Device (PLC)

Input Tag Set E0_00000

Connection Type Multi-cast connection

Output Tag Set D00000

Connection Type Point to Point connection

€Target Device (Laser Marker)

Output Tag Set Input_100

Input Tag Set Input_100

14 Return to the [Edit Device Parameters] screen,


and select [OK].
The PLC setting is completed by the above setting method.

For details about how to operate CX-Programmer and


Network Configurator, refer to PLC user's manual.

2-8 - MD-X2000/2500 Series Communication Interface User’s Manual -


Cyclic communication

How to configure the Allen-Bradley 3 Configure the MD-X Ethernet Module


Name the module and enter the Ethernet IP Address of the MD-X
Control/Compact Logix series laser marker.
Then, click [Change] and change the data size from [SINT] to [INT].
Connect the PLC to the laser marker using an Ethernet cable and Click [OK] when finished.
launch RSLogix5000.

1 Install the MD-X EDS File.


In RSLogix5000, click [Tools] then select [EDS Hardware
Installation Tool].
Follow Rockwell Automation EDS wizard for registering an EDS
file.

2
The EDS file of the laser marker is located in the
folder below.
C:\Program Files (x86)\keyence\Marking Builder
Plus_Ver*\etc\EtherNetIP\[model name]
(Ver* is the version of Marking Builder Plus.)

EtherNet/IP
2 Add an MD-X Ethernet Module.
Right click [I/O Configuration] > [Ethernet], and select [New Module].
Select [MD-X2000/2500] and click [Create].

[INT] should be selected since the MD-X2000/2500


series uses 16-bit (2 bytes) addresses. You must
enter the assembly size obtained by dividing the
assembly size of the laser marker by 2.
By default, the laser marker's input assembly size
is 320 and output assembly size is 288. Therefore
the PLC's input assembly size should be 160 and
output assembly size should be 144.

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-9


Cyclic communication

Status of device assignment of the MD information area


In the device, there is an area for writing laser marker state to the PLC and an area for writing instructions from the PLC to the laser marker. It is divided
into bit area and word area.

Input Assemblies Memory Map


Laser marker -> PLC
Address Bit15 Bit14 Bit13 Bit12 Bit11 Bit10 Bit9 Bit8 Bit7 Bit6 Bit5 Bit4 Bit3 Bit2 Bit1 Bit0

External Logging Laser Safety Remote Shutter Laser Distance


Job Change Network Shutter I/O Error Warning Error Ready
0 Lighting Trigger Module Interlock Control Emitted Laser
Ready Status Status Status Status Status Status Status
Control Status Status Status Status Status Status Ready Status

2 1
Window
Monitoring
Busy Status
Mark Check
/2DC Read
Busy Status
Job Edit
Busy
Status
Communication
Priority Error
Status
Job Change
Busy Status
Guide
Laser Busy
Status
Marking
Busy
Status
Busy
Status

Mark Check Mark Check Counter Counter Counter Counter Distance Internal Laser Operation Trigger
Marking Date Attach Date Hold
EtherNet/IP

2 /2DC Read /2DC Read End4 End3 End2 End1 Laser Stop Lighting Control Stop Lock
Complete1 Status Status
NG Status 1 OK Status 1 Status Status Status Status Status Status Status Status Status

3-Axis 3-Axis Mark Check Mark Check


3 Tracking Tracking /2DC Read /2DC Read
NG Status OK Status NG Status 2 OK Status 2

Window Guide
Job Edit 2DC Read Error Clear Laser Stop Marking
4 Monitoring Laser
Complete Complete Complete Complete Complete2
Complete Complete

System Info Counter Counter Counter Rank Job


Counter Up Counter No
5 ID Change Reset Down Value Change Change
Complete Complete
Complete Complete Complete Complete Complete Complete

String Marked Setting


6 Change String Read String Read
Complete Complete Complete

Z Tracking XY Tracking Command


7 Result Read Result Read Send
Complete Complete Complete

Window 2DC Read Error Clear


Job Edit Stop Marking Guide Laser Start Marking
8 Monitoring Request Request
Error Request Error Request Error Request Error
Request Error Error Error

System Info Counter Counter Up Counter Counter


Counter Down Rank Change Job Change
9 ID Change Reset Request Value Change No Change
Request Error Request Error Request Error
Error Request Error Error Request Error Request Error

Marked String Setting String


String Change
10 Read Request Read Request
Request Error
Error Error

Z Tracking XY Tracking Command


11 Result Result Send Request
Request Error Request Error Error

12 Error Code 1

13 Error Code 2

14 Command Send Error Status

15

16 Job No Status

17 Counter No Status

18/19 Counter Value Status

20 Rank Value Status

21 System Info ID

22/23 System Info Value

24 Marking Check Score/2DC Read Grade Status1

25 Marking Check/2DC Read Total Count Status1

26 Marking Check Score/2DC Read Grade Status 2

27 Marking Check/2DC Read Total Count Status 2

28/29 Total Marking Count Status

30 Response Data Size

31 - 155 Response Data

2-10 - MD-X2000/2500 Series Communication Interface User’s Manual -


Cyclic communication

„ Bit area for writing laser marker state on the PLC


In the following areas, information is divided by bit. The bit values are either 0 or 1.
The laser marker information is written in the PLC bit area via cyclic communication. An area without a description is reserved.

Address bit Name Status Information Description


Displays the ready status. When the device status is Ready, operations such
0: Not Ready as start marking, job change, and character string change are accepted
0 Ready Status
1: Ready
Linked I/O Terminal Trigger ready output
Displays the error (E***) status. To recover from an error, eliminate the
0: Not Error causes of the error first, and then turn on Error Clear.
1 Error Status
1: Error
Linked I/O Terminal Error output

0: Not Warning Displays the warning error (W***) status.

2
2 Warning Status
1: Warning Linked I/O Terminal Warning output
0: Not I/O Error
3 I/O Error Status Displays the terminal block error (T***) status.
1: I/O Error

EtherNet/IP
0: Open Shutter Displays whether the internal shutter is opened or closed.
4 Shutter Status
1: Close Shutter Linked I/O Terminal Shutter status output
0: No Connection
5 Network Status Displays the Fieldbus network communication status.
1: Connection

Job Change Ready 0: Not Ready Displays the job switching ready status.
6
0 Status 1: Ready Linked I/O Terminal Job switching ready status

Distance Laser Ready 0: Not Ready Displays the Ready state of the distance laser.
7
Status 1: Ready Linked I/O Terminal Distance laser operation ready output

0: Laser Not Excited Displays the laser excitation status.


8 Laser Emitted Status
1: Laser Excited Linked I/O Terminal Laser excitation status output
0 : OFF (Close)
9 Shutter Control Status Displays whether the shutter control input is on or off.
1 : ON (Open)
0 : OFF (Close)
10 Remote Interlock Status Displays whether the remote interlock input is on or off.
1 : ON (Open)
Displays whether the laser safety module control input is on or off.
Laser Safety Module 0 : OFF (Close)
11 Displays the status where the laser emission stops when it is “1 (ON)”. When
Status 1 : ON (Open)
the laser safety module (MD-C1) is not mounted, it is always “0”.

0: OFF Displays whether the logging trigger input is on or off.


12 Logging Trigger Status
1: ON Linked I/O Terminal Logging trigger input

External Lighting Control 0: OFF Displays whether the external lighting control output is on or off.
13
Status 1: ON Linked I/O Terminal External Lighting Control Output
If one or more of the following busy statuses are on, Busy Status turns on.
Marking Busy, Guide Laser Busy, Job Change Busy, Commmunication
0 Busy Status
Priority, Job Edit Busy, Mark Cheeck/2DC Read Busy Status Window
Monitoring Busy
Turns on during marking (including laser inspection).
1 Marking Busy Status
Linked I/O Terminal Output During Marking
Turns on when guide laser marking is in operation (including the distance
2 Guide Laser Busy Status pointer).
Linked I/O Terminal Guide Laser Output
Turns on when a job is being deployed.
3 Job Change Busy Status 0: Not Busy
1 (Deployment timing: when changing marking jobs, content, and so on)
1: Busy
Communication Priority Displays the communication priority status. Turns on when the laser marker
4
Error Status is connected to an external control device and in the no priority state.
Turns on when the Job Edit Start Request turns on and editing starts.
5 Job Edit Busy Status Returns to “OFF” when the Job Edit Start Request is turned off and editing is
completed.
Mark Check /2DC Read
6 Turns on when the marking verification function or 2DC reading is operating.
Busy Status
Turns on during the lens inspection. Also turns on during maintenance and
Window Monitoring Busy workflow lens inspections.This not only turns on when the operation is started
7
Status by Profinet and Ethernet/IP communications, but also when this operation is
started by another communication before or after marking.

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-11


Cyclic communication

Address bit Name Status Information Description


0 Trigger Lock Status Displays whether the trigger lock input is on or off.
1 Operation Stop Status Displays whether the processing operation stop input is on or off.
2 Laser Control Status Displays whether the laser stop input is on or off.
0: OFF
3 Date Hold Status 1: ON Displays whether the date hold input is on or off.
4 Internal Lighting Status Displays whether the internal lighting control input is on or off.
Distance Laser Stop
5 Displays whether the distance laser enable input is on or off.
Status

0: OFF Displays the status of date attach output.


8 Date Attach Status
1: ON Linked I/O Terminal Date attach output

2
9 Counter End1 Status
Displays the status of counter end output 1 - 4. You can use the Controller
10 Counter End2 Status settings of the Marking Builder Plus to assign the individual and common
0: Not Complete
11 Counter End3 Status 1: Complete counters (0 to 9, A to J).
EtherNet/IP

12 Counter End4 Status Linked I/O Terminal Counter end output 1 - 4


2
Displays whether the marking verification function or 2D code grade
0→1: OK assessment result is OK or not.* 1
1→0 : - Displays the 2D code grade result by default, and the assessment result of
Mark Check/2DC Read [Reset Timing] the marking verification function will be displayed in Mark Check/2DC Read
13
OK Status 1 Reset when 2DC Read Request OK Status 2. Status 1 and 2 can be reversed in the communication setting
or 2DC Read Complete Bit Clear screen.
turns on.
Linked I/O Terminal Marking/2D code check OK output
Displays whether the marking verification function or 2D code grade
0→1: NG
assessment result is OK or not. 1
1→0 : -
Displays the 2D code grade result by default, and the assessment result of
Mark Check/2DC Read [Reset timing] the marking verification function will be displayed in Mark Check/2DC Read
14
NG Status 1 Reset when 2DC Read Request NG Status 2. Status 1 and 2 can be reversed in the communication setting
or 2DC Read Complete Bit Clear screen.
turns on.
Linked I/O Terminal Marking/2D code check OK output

0: Not Complete Displays the status of marking complete output.


15 Marking Complete 1
1: Complete Linked I/O Terminal Marking complete output
0→1: OK Displays whether the marking verification function or 2D code grade
1→0 : - assessment result is OK or not.* 1
Mark Check/2DC Read Displays the marking verification result by default, and the grade assessment
0 [Reset Timing]
OK Status 2 result of the 2D code will be displayed in Mark Check/2DC Read OK Status 1.
Reset when 2DC Read Request
Status 1 and 2 can be reversed in the communication setting screen.
or 2DC Read Complete Bit Clear
turns on. Linked I/O Terminal Marking/2D code check OK output
0→1: OK Displays whether the marking verification function or 2D code grade
1→0 : - assessment result is OK or not.* 1
Mark Check/2DC Read Displays the marking verification result by default, and the grade assessment
1 [Reset Timing]
NG Status 2 result of the 2D code will be displayed in Mark Check/2DC Read NG Status 1.
Reset when 2DC Read Request
3 Status 1 and 2 can be reversed in the communication setting screen.
or 2DC Read Complete Bit Clear
turns on. Linked I/O Terminal Marking/2D code check NG output
Turns on for a fixed time when using the XY tracking/Z tracking function,
3-Axis Tracking OK 0→1: OK or when the tracking has been completed successfully. Turns on by AND
2 condition when using multiple tracking settings.
Status 1→0 : -
Linked I/O Terminal 3-Axis Tracking OK Output
Turns on for a fixed time when using the XY tracking/Z tracking function, or
3-Axis Tracking NG 0→1: NG when the tracking has failed. Turns on by OR condition when using multiple
3 tracking settings.
Status 1→0 : -
Linked I/O Terminal 3-Axis Tracking NG Output
Displays the completion status of marking initiated with Start Marking
0 Marking Complete 2
Request. If marking has been canceled, it does not turn on.* 2
Displays the completion status of guide laser marking started with Guide
1 Guide Laser Complete Laser Request. If completed, regardless of how it was canceled, be it
communications, I/O, or the like, it turns on.* 2
0: Not Complete Displays the completion status of Stop Marking Request. Even if marking is
2 Laser Stop Complete 11: Complete started from other communications or I/O, if cancellation is completed with
[Reset timing] Stop Marking Request, the bit turns on.
4
Reset when the Complete Clear Displays the completion status of Error Clear Request. After completion, it
3 Error Clear Complete Bit statuses turn on or the next turns on, regardless of whether error clearing was successful or not.* 2
Request turns on.
4 2DC Read Complete Displays the completion status of 2DC Read Request.* 2
Window Monitoring
5 Turns on when completing the lens inspection.* 2
Complete
Displays the completion status of editing initiated with Job Edit Start Request.
8 Job Edit Complete
If it completes successfully, the bit turns on.

2-12 - MD-X2000/2500 Series Communication Interface User’s Manual -


Cyclic communication

Address bit Name Status Information Description


0 Job Change Complete Displays the completion status of Job Change Request.* 2
1 Rank Change Complete Displays the completion status of Rank Change Request.* 2
2 Counter No Complete Displays the completion status of Counter No Change Request.* 2
3 Counter Value Complete Displays the completion status of Counter Value Change Request.* 2
Displays the completion status of the value changed with Counter Up
5 4 Counter Up Complete
Request.* 2
Displays the completion status of the value changed with Counter Down
5 Counter Down Complete
Request.* 2
6 Counter Reset Complete 0: Not Complete Displays the completion status of the reset with Counter Reset Request.* 2
11: Complete

2
System Info ID Change Displays the completion status of the operation information ID by System Info
8
Complete [Reset timing] ID Change Request.
Reset when the Complete Clear
Setting String Read
0 Bit statuses turn on or the next Displays the completion status of Setting String Read Request.* 2
Complete
Request turns on.

EtherNet/IP
6 Marked String Read
1 Displays the completion status of Marked String Read Request.* 2
Complete
2 String Change Complete Displays the completion status of String Change Request.* 2
Command Send
8 Displays the completion status of Command Send Request.* 2
Complete
XY Tracking Result Read
7 9 Display the completion status of XY Tracking Result Request.* 2
Complete
Z Tracking Result Read
10 Display the completion status of Z Tracking Result Request.* 2
Complete
If the marking operation started with Start Marking Request fails, the bit turns
Start Marking Request
0 on.
Error
If marking is canceled or marking cannot start without priority, it turns on.* 3
If the guide laser operation started with Guide Laser Request fails, the bit
Guide Laser Request
1 turns on. If Guide Laser Request is turned on when the guide laser cannot be
Error
irradiated or cannot be started without priority, it turns on.* 3
Stop Marking Request If a Stop Marking Request fails to stop marking, the bit turns on.
2
8 Error *3
3 Error Clear Request Error If an Error Clear Request fails to clear the error, it turns on.* 3
4 2DC Read Request Error If a 2DC Read Request fails to read a 2D code, the bit turns on.
Window Monitoring If a Window Monitoring Request fails in the lens inspection operation, it turns
5
Request Error on.* 3
If a Job Edit Start Request fails to edit the job, it turns on.* If edit start is not
8 Job Edit Error 0: Not Error received or if data cannot be deployed when editing finishes, the bit turns on.
1: Error
Job Change Request
0 [Reset timing] If a job change with a Job Change Request fails, it turns on.* 3
Error
Reset when the Complete Bit
Rank Change Request Clear statuses turn on or the next If an I/O specified character change with a Rank Change Request fails, it
1
Error Request turns on. turns on.* 3
Counter No Change If a number change with a Counter No Change Request fails, the bit turns on.
2
Request Error *3
If a value change with a Counter Value Change Request fails, the bit turns
Counter Value Change
3 on.
Request Error
9 *3
Counter Up Request If a value change with a Counter Up Request fails, it turns on.* 3
4
Error Receivable condition: Ready ON
Counter Down Request If a value change with a Counter Down Request fails, it turns on.* 3
5
Error Receivable condition: Ready ON
Counter Reset Request If a reset with a Counter Reset Request fails, it turns on.* 3
6
Error Receivable condition: Ready ON
System Info IDChange If a change of the operation information ID with a System Info ID Change
8
Error Request fails, it turns on.* 3
Setting String Read 0: Not Complete
0 If reading with a Setting String Read Request fails, it turns on.* 3
Request Error 1: Complete
Marked String Read [Reset timing] If reading with a Marked String Read Request fails, the bit turns on.
10 1
Request Error Reset when the Complete Bit *3
String Change Request Clear statuses turn on or the next If a change with a String Change Request fails, the bit turns on.
2 Request turns on.
Error It will also fail if the data length exceeds 250 bytes.* 3
Command Send Request 0: Not Complete If Command Send Request fails, the bit turns on.
8
Error 1: Complete It will also fail if the data length exceeds 250 bytes.* 3
XY Tracking Result [Reset timing]
11 9 When XY Tracking Result Request fails, it turns on.* 2
Request Error Reset when the Complete Bit
Z Tracking Result Clear statuses turn on or the next
10 Request turns on. When Z Tracking Result Request fails, it turns on.* 2
Request Error

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-13


Cyclic communication

* 1 If a code is read with the settable 2D code reading function on Marking Builder Plus, OK/NG is output with the grade that is set as the
threshold as the reference. If code is read with 2DC Read Request, OK/NG is output for whether the code was successfully read or not. (Even
if the code reads with a F Grade, OK is output.)
* 2 The bit turns at completion only if the operation is started by Profinet and Ethernet/IP communications. If you start the operation with other
forms of communication or I/O, the bit will not turn on, even if the operation completes.
* 3 The bit turns on at error only if the operation is started by Profinet and Ethernet/IP communications. If you started the operation with other
forms of communication or I/O, the bit will not turn on, even if an error occurs.

Remote interlock input, shutter interlock input, and laser excitement input cannot be controlled from Ethernet/IP. Control those inputs from I/O.

„ Word area for writing laser marker state on the PLC


In the following areas, the information is divided by word. The information is shown with 2-byte unsigned integer (0 to 65535).
The laser marker information is written in the PLC word area via cyclic communication. An area without a description is reserved.

2 Address
12
Data Type
Word
Name
Error Code 1
Status Information Description
Displays the number for the error currently occurring. The error
number display differs to the normal display.
EtherNet/IP

The error codes are displayed as four digits such as 1*** for an
Error Number error (E***), 2*** for a warning error (W***), and 3*** for an I/O
13 Word Error Code 2 error (T***).
Up to two errors can be displayed. When three or more errors
occur, confirm the errors through Marking Builder Plus.
Error Number
[Reset timing] If Command Send Request fails due to a software error, the
Command Send Error Command Send Request error number is displayed. The error number display differs to
14 Word
Status Reset when Complete Bit Clear the normal display. A software error (S***) is displayed as 4*** in
turns on or the next Command four digits.
Send Request turns on.
16 Word Job No Status Job Number (0 to 1999) Displays the currently selected job number.
• Counter Value Change/Up/Down/Reset Request that is to be
changed
• Counter Value Status that is to be displayed
17 Word Counter No Status Counter Number (0 to 19) Displays the number of the target counter listed above.
Changes with Counter No Change Request.
Individual Counter(0 to 9): 0 to 9
Common Counter(A to J):10 to 19
Counter Value Displays the current counter value set to be displayed for
18/19 DWord Counter Value Status
(0 to 4294967295) Counter No Change Request.
I/O Encoded Character Value
20 Word Rank Value Status Displays the value for I/O specified characters.
(0 to 35)
21 Word System Info ID System Info ID (0 to 301) Displays the currently selected operation information ID.
System Info Value
22/23 DWord System Info Value Displays the operation information specified by System Info ID.
(0 to 4294967295)
Any of the following are displayed:
• 2D code reading (Defaults) : Read fail of AIM DPM
[When acquiring 2DC reading] comprehensive determination
0 to 4 grade or F(0)/D(1)/C(2)/B(3)/A(4)
• Marking verification function : score
[When using the marking
verification function] Displays the 2D code grade result by default, and the
Marking Check Score/ assessment result of the marking verification function will be
24 Word 000 to 100
2DC Read Grade Status 1 displayed in Marking Check Score/2DC Read Grade Status 2.
[Reset timing] Status 1 and 2 can be reversed in the communication setting
Reset when 2DC Read Complete screen of Marking Builder Plus.
Bit Clear turns on or the next 2DC When displaying the result of the 2D code reading grade,
Read Request turns on. even if you started the operation with communications and I/O
other than 2DC Read Request, the result is displayed after the
operation is completed.
Displays the execution count of the 2D code reading or the
0 to 65535 execution count of the marking verification functions. Displays
Marking Check/ the execution count of the 2D code reading by default, and the
25 Word 2DC Read Total Count [Reset timing] execution count of the marking verification functions will be
Status 1 It will be reset to “0” when the displayed in Marking Check/2DC Read Total Count Status 2.
power is turned off. Status 1 and 2 can be reversed in the communication setting
screen of Marking Builder Plus.
Any of the following are displayed:
• Marking verification function (defaults) : score
[When using the marking • 2D code reading : Read fail of AIM DPM comprehensive
verification function] determination grade or
000 to 100 F(0)/D(1)/C(2)/B(3)/A(4)
[When acquiring 2DC reading] Displays the marking verification result by default, and the grade
Marking Check Score/
26 Word 0 to 4 result of the 2D code reading will be displayed in Marking Check
2DC Read Grade Status 2
[Reset timing] Score/2DC Read Grade Status 2. Status 1 and 2 can be reversed
Resets when 2DC Read Complete in the communication setting screen of Marking Builder Plus.
Bit Clear turns on or the next 2DC When displaying the result of the 2D code reading grade,
Read Request turns on. even if you started the operation with communications and I/O
other than 2DC Read Request, the result is displayed after the
operation is completed.

2-14 - MD-X2000/2500 Series Communication Interface User’s Manual -


Cyclic communication

Address Data Type Name Status Information Description


Displays the execution count of the marking verification function
0 to 65535 or the execution count of the 2D code reading. Displays the
Marking Check/ execution count of the marking verification function by default,
27 Word 2DC Read Total Count [Reset timing] and the execution count of the 2D code reading in Marking
Status 2 It will be reset to “0” when the Check/2DC Read Total Count Status 1.
power is turned off. Status 1 and 2 can be reversed in the communication setting
screen of Marking Builder Plus.
Total Marking Count Marking Count
28/29 DWord Displays the marking count.
Status (0 to 4294967295)
30 Word Response Data Size Data size (2 bytes) Stores the data length of “Response Data” in 16-bit binary data.
The following response data are displayed:

2
• Setting/Marked String Request
• 2DC Read Request (read content)
• Command Send Request
Response • XY Tracking Result Request
[Reset timing] • Z Tracking Result Request

EtherNet/IP
31 to 155 Character Response Data Reset when each Complete Bit • Window Monitoring Request
Clear request turns on or the next * Selectable capacities are from 32, 64, 128, and 252 bytes on
Request turns on. the PLC settings. (Default: 128 bytes. Fixed at 250 bytes in the
KEYENCE PLC “KV Series”.) However, if the response data
is greater than the selected byte number, all the data cannot
be received. Additionally, even if 252 bytes is selected, the
maximum amount of data that will be received is 250 bytes.

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-15


Cyclic communication

Output Assemblies Memory Map


PLC -> Laser Marker

Address Bit15 Bit14 Bit13 Bit12 Bit11 Bit10 Bit9 Bit8 Bit7 Bit6 Bit5 Bit4 Bit3 Bit2 Bit1 Bit0

Job Edit Window Error Stop Guide Start


2DC Read
0 Start Monitoring Clear Marking Laser Marking
Request
Request Request Request Request Request Request

System Info Counter Counter Counter Counter Counter Rank Job


1 ID Change Reset Down Up Value Change No Change Change Change
Request Request Request Request Request Request Request Request

String Marked Set String


2 Change String Read Read
Request Request Request

2 3
Z Tracking
Result
Request
XY Tracking Command
Result
Request
Send
Request

Internal Laser Operation Trigger


EtherNet/IP

Distance Laser Date Hold


4 Lighting Stop Stop Lock
Stop Request Request
Request Request Request Request

Window Guide
Job Edit 2DC Read Error Clear Laser Stop Marking
Monitoring Laser
6 Complete Complete Complete Complete Complete
Complete Complete
Bit Clear Bit Clear Bit Clear Bit Clear Bit Clear
Bit Clear Bit Clear

System Info Counter Counter Rank Job


Counter Reset Counter Down Counter Up
ID Change Value Change No Change Change Change
7 Complete Bit Complete Bit Complete
Complete Complete Bit Complete Complete Complete
Clear Clear Bit Clear
Clear Clear Bit Clear Bit Clear Bit Clear

String Marked Set String


Change String Read Read
8
Complete Complete Complete
Bit Clear Bit Clear Bit Clear

3-Axis
Command
Tracking
Send
9 Result Read
Complete
Complete Bit
Bit Clear
Clear

10/11 Request No

12 Request Data Size

13 - 137 Request Data

2-16 - MD-X2000/2500 Series Communication Interface User’s Manual -


Cyclic communication

„ Bit area for writing the request from the PLC onto the laser marker
In the following areas, information is divided by bit. The bit values are either 0 or 1.
The request from the PLC is written onto the laser marker via cyclic communication. An area without a description is reserved.

Address bit Name Status Information Description

0→1: Start
1→0 : - Starts the marking. If marking cannot be performed or is canceled, Start
0 Start Marking Request Marking Request Error turns on. The Marking Busy Status turns on during
[Condition of operation] marking. If marking completes successfully, Marking Complete 1 and 2 turn on.
The Ready Status is turned on.

Starts guide laser marking. Enter the number into Request No. beforehand.
0→1: Start 0: Distance pointer 1: Guide laser once
1→0 : -

2
2: Guide laser continuously 3: Area frame
[Condition of operation]
The Ready Status is turned on. 4: Work image 5: Block frame
1 Guide Laser Request
* During shutter control, laser
If marking completes or is canceled (including canceled due to an error)
safety module control, and safety
after a set amount of time, the Guide Laser Request Complete bit turns on. If

EtherNet/IP
shutter control, it is accepted even
guide laser marking cannot start, Guide Laser Request Error turns on.
if the Ready Status is turned off.
If the move marking setting is selected, guide laser marking cannot be used.
The error bit turns on.

0→1: Stop
1→0 : -
2 Stop Marking Request [Condition of operation] Cancels marking.
The Marking Busy Status is turned
on.

If an error occurs, remove the cause of the error and then turn this bit on to
0 clear the error. An Error Status Bits error cannot be cleared (it is reset when
0→1: Error Clear the Complete Bit Clear statuses turn on or the next Request turns on). After
3 Error Clear Request
1→0 : - the operation has been completed, Error Clear Complete turns on regardless
of whether the error is cleared successfully or not. If the error clearing
operation cannot be accepted, Error Clear Request Error turns ON.

Reads 2D code. The reading position is the current scanner coordinates.


Reading is performed with the coaxial camera in wide mode. The internal
0→1: Start lighting does not turn on automatically during reading. To use this lighting,
1→0 : - turn it on via communication or I/O before executing the 2DC Read Request.
4 2DC Read Request
[Condition of operation] If this request is run when the condition of operation is not satisfied, Mark
The Ready Status is turned on. Check/2DC Read OK Status, Mark Check/2DC Read NG Status, and 2DC
Read Complete are reset, and 2DC Read Request Error turns on.
* It cannot be used on the MD-X400(A)/450(A) series.

0→1: Start Starts the lens inspection. The score is stored in Response Data. If this
1→0 : - request is run when the condition of operation is not satisfied, Window
Window Monitoring
5 Monitoring Complete is reset, and Window Monitoring Request Error is turned
Request [Condition of operation] on.
The Ready Status is turned on. * It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

Starts the job editing. If the start edit request is received successfully, the
job change request after that is retained temporarily in the controller, and the
0→1: Edit Start job is deployed all at once when editing is completed. Use this request if you
8 Job Edit Start Request
1→0: Edit End want to reduce the communication time used by job editing. If edit start is
received successfully, Job Edit Busy Status turns on. Additionally, if edit start
is received successfully, Job Edit Complete turns on. 1

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-17


Cyclic communication

Address bit Name Status Information Description

0 Job Change Request Changes the job number. * 1

1 Rank Change Request Changes the I/O specified characters. * 1

Changes the number of the counter to be changed. * 1


Counter No Change
2 Individual Counter(0 to 9): 0 to 9
Request
Common Counter(A to J):10 to 19

Counter Value Change Changes the value of the counter set to be displayed for Counter No Change
3
Request Request. * 1

Increases the value of the counter set to be displayed for Counter No Change
4 Counter Up Request
Request. * 1

2
Reduces the value of the counter set to be displayed for Counter No Change
5 Counter Down Request
Request. * 1

6 Counter Reset Request Resets the counter set to be displayed for Counter No Change Request. * 1
0→1: Request
1 Changes the operation information ID. The operation information to the ID is
EtherNet/IP

1→0 : -
displayed to System Info Value.* 1
Operation ID Operation information
1 Controller operating time
2 Laser excited time
3 Scanner operating time
System Info ID Change
8 101 Number of shutter operations
Request
Number of times the laser safety module has
102
been operated
201 Head temperature
202 Controller temperature
301 Results of the laser power calibration
302 Final execution result of the lens inspection

Setting String Read


8 Loads the settings.* 2
Request

Marked String Read Loads the marked content.* 2


9 0→1: Request
2 Request Sending the request before marking results in an error.
1→0 : -
Changes the content to be marked in the current job. Store the block no.
10 String Change Request in Request No., the string in Request Data, and the length of the string in
Request Data Size. The maximum data length is 250 bytes.

Sends communication commands. Store the communication command


8 Command Send Request in Request Data and the length of the string in Request Data Size. The
maximum data length is 250 bytes. Store the response in Response Data.

Loads the result of the XY tracking. Enter the XY tracking No. into the
XY Tracking Result 0→1: Request
3 9 Request No. Store the response in Response Data. Sending the request
Request 1→0 : -
before marking results in an error.

Loads the result of the Z tracking. Enter the Z tracking No. into Request No.
Z Tracking Result
10 Store the response in Response Data. Sending the request before marking
Request
results in an error.

Disables the trigger input. If this bit turns on while marking, the trigger lock
0 Trigger Lock Request status is activated after all of the mark data is marked. Test marking and
sample marking is immediately canceled when this bit turns on.

Stops the laser radiation (the internal shutter remains open). Use this bit to
1 Operation Stop Request
stop the laser radiation at the desired position while processing a workpiece.

Stops the marking laser and the guide laser. The internal shutter closes while
2 Laser Stop Request
0: Input Off this bit is turned on.
4
1: Input On If the controller's internal clock passes midnight when this bit is turned on,
3 Date Hold Request the date of updated string is subtracted one day and the subtracted date is
marked.

Turns on an internal lighting.


4 Internal Lighting Request
* It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

Distance Laser Stop Stops the distance laser.


5
Request * It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

2-18 - MD-X2000/2500 Series Communication Interface User’s Manual -


Cyclic communication

Address bit Name Status Information Description

Marking Complete Bit


0 Resets Marking Complete and Start Marking Request Error.
Clear

Guide Laser Complete


1 Resets Guide Laser Complete and Guide Laser Request Error.
Bit Clear

Laser Stop Complete Bit


2 Resets Laser Stop Complete and Stop Marking Request Error.
Clear

Error Clear Complete Bit


3 0→1: Complete Clear Resets Error Clear Complete and Error Clear Request Error.
6 Clear
1→0 : -
Resets 2DC Read Complete and 2DC Read Request Error.
2DC Read Complete Bit
4 Mark Check/2DC Read OK Status and Mark Check/2DC Read NG Status is

2
Clear
also cleared at the same time.

Window Monitoring
5 Resets Window Monitoring Complete.
Complete Bit Clear

EtherNet/IP
Job Edit Complete Bit
8 Resets Job Edit Complete and Job Edit Error.
Clear

Job Change Complete Bit


0 Resets Job Change Complete and Job Change Request Error.
Clear

Rank Change Complete


1 Resets Rank Change Complete and Rank Change Request Error.
Bit Clear

Counter No Change
2 Resets Counter No Complete and Counter No Change Request Error.
Complete Bit Clear

Counter Value Change


3 Resets Counter Value Complete and Counter Value Change Error.
Complete Bit Clear 0→1: Complete Clear
7
Counter Up Complete Bit 1→0 : -
4 Resets Counter Up Complete and Counter Up Request Error.
Clear

Counter Down Complete


5 Resets Counter Down Complete and Counter Down Request Error.
Bit Clear

Counter Reset Complete


6 Resets Counter Reset Complete and Counter Reset Request Error.
Bit Clear

System Info ID Change


8 Resets System Info ID Change Complete and System Info ID Change Error.
Complete Clear

Setting String Read


0 Resets Setting String Read Complete and Setting String Read Request Error.
Complete Bit Clear

Marked String Read 0→1: Complete Clear Resets Marked String Read Complete and Marked String Read Request
8 1
Complete Bit Clear 1→0 : - Error.

String Change Complete


2 Resets String Change Complete and String Change Request Error.
Bit Clear

Command Send
8 Resets Command Send Complete and Command Send Request Error.
Complete Bit Clear
0→1: Complete Clear
9 Resets XY Tracking Result Read Complete, Z Tracking Result Read
3-Axis Tracking Result 1→0 : -
9 Complete, 3-Axis Tracking OK Status, 3-Axis Tracking NG Status, XY
Read Complete Bit Clear
Tracking Result Request Error, and Z Tracking Result Request Error.

* 1 T urns on this bit after storing the job No., I/O specified character No., counter value, counter No., and operation information No. in the
applicable Request No.
* 2 If you turn on this bit after storing the block No. in Request No., the content will be loaded from the specified block in the current job. Store
the load result in Response Data.

Word area for writing a PLC request


In the following areas, the information is divided by word. The information is shown with 2-byte unsigned integer (0 to 65535).
The detailed information of the request from the PLC is written.

Address Data Type Name Status Information Description

Stores the job No., block No., counter value, and counter No. to be
10/11 DWord Request No Numbers (Four bytes)
changed.

12 Word Request Data Size Data size (Two bytes) Stores the data length of “Request Data” in 16-bit binary data.

Use for String Change Request and Command Send Request. Store
the change string and communication command data. Headers and
Command function
delimiters are not required.
(Default: 250 bytes)
13 to 137 Character Request Data * Selectable capacities are from 32, 64, 128, and 252 bytes on the
* Selectable from 32, 64, 128, and
PLC settings. (Default: 250 bytes.)
252 bytes on the PLC.
However, even if 252 bytes is selected, the maximum amount of
data that can be sent is 250 bytes.

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-19


Cyclic communication

Command communications
Control via the command communication can also be made when using EtherNet/IP.
Since the communication mode is “command/response type”, multiple commands cannot be sent simultaneously. Therefore, make sure to send the
command only after a response has been received.

z Communication format
Header and delimiter settings are not required.
Store the send data size in “Request Data Size” and the send data in “Request Data” in the PLC command area. Then set the “Command Send Request”
bit to “1” to enable the stored data to be sent to the controller.
For further details of the communication command, refer to “Chapter 1 Communication Interface” (Page 1-1) .

2 When “Request” bit does NOT work


If a request is turned on but does not work, check the communications history.
You can check the history of commands sent and received between the PLC and laser marker in the Marking Builder Plus communications history.
EtherNet/IP

z Confirmation method
Start Marking Builder Plus, and select the [Maintenance] tab > [Communication] > [Communication History].
The [Communication History] window appears. Click the [Update] button to display the latest history.

If the communication history is empty, the laser marker has not received any communication.
Double check the communication settings between the laser marker and the PLC, and make sure that the HUB and cable are not defective.

z Request format
Each request will be stored in the communication history in the following format:
Command: ***** Request
Response: ***** Request,X (X = 0: Success; X = 1: Fail)
However, the requests below have a different format. (X = 0: Success; X = 1: Fail)
Request History format (“>” = command; “<” = response)

> 2DC_Read_Request,0
2DC Read Request
< 2DC_Read_Request,X,[Grade],[Content]

> Job_Edit_Start_Request,[Job No]


Job Edit Start Request
< Job_Edit_Start_Request,X

> Job_Change_Request,[Job No]


Job Change Request
< Job_Change_Request,X

> Rank_Change_Request,[I/O Character No]


Rank Change Request
< Rank_Change_Request,X

> Counter_No_Change_Request,,[Counter No],1


Counter No Change Request
< Counter_No_Change_Request,X,[Counter Current Value]

> Counter_Value_Change_Request,,[Counter No],[Counter Current Value]


Counter Value Change Request
< Counter_Value_Change_Request,X

> System_Info_ID_Change_Request,[System_Info_ID]
System Info ID Change Request
< System_Info_ID_Change_Request,X

> Setting_String_Read_Request,BLK=[Block No],CharacterString


Setting String Read Request
< Setting_String_Read_Request,[OK/NG],[Character String]

> Marked_String_Read_Request,MarkedCharacter=[Job No],[Block No]


Marked String Read Request
< Marked_String_Read_Request,[OK/NG],[Character String]

> String_Change_Request,,[Block No],[Character String]


String Change Request
< String_Change_Request,X

> Window_Monitoring_Request,WindowCheck
Window Monitoring Request
< Window_Monitoring_Request,[OK/NG], [Score]

> XY_Tracking_Result_Request,0
XY_Tracking_Result_Request < XY_Tracking_Result_Request, [OK/NG], [X Coordinate Gap Amount], [Y Coordinate Gap Amount], [θ Gap Amount], [Correlation
Value], [Execution Time], [Result]

> Z_Tracking_Result_Request
Z_Tracking_Result_Request < Z_Tracking_Result_Request, [OK/NG], [Z Coordinate Gap Amount], [X Rotation Angle], [Y Rotation Angle], [Stability], [Execution
Time], [Result]

> [Stored data for Request Data]


Command Send Request
< [Response]

An error may be the cause of the request not working. You can check up to two error codes simultaneously, Error Code 1 and Error Code 2.
Error details and resolutions are listed in the User's Manual for the applicable model.

2-20 - MD-X2000/2500 Series Communication Interface User’s Manual -


Ladder Program Example

Ladder Program Example


KEYENCE KV Series Program Example
This chapter introduces an example of a ladder program for controlling the laser marker using the KV series. The data memory numbers are described
based on the default values of KV-5500/7500. Modify the numbers as necessary according to your environment.

Changing the job No. and starting the marking (An example of bit control)

z Reference ladder z Timing chart


Ready Status 2

EtherNet/IP
Request No

Job Change Request

Job Change Complete

Start Marking Request

Marking Complete 2

Marking Complete /
Job Change Complete Bit
Clear

• “Ready Status” becomes OFF and the “Busy” bit


becomes ON while the job No. switching is in progress.
• If the job No. switching fails, “Job Change Request
Error” will become ON.
• “Job Change Complete” retains its ON status until “Job
Change Complete Clear” becomes ON or until “Job
z Sequence Change Request” becomes ON again.
• “Marking Complete” retains its ON status until “Marking
(1) If Ready Status is ON at the rising edge of MR000, Complete Bit Clear” becomes ON or until “Marking
transfer job No.”0” to Request No. Request” becomes ON again.
End the sequence if Ready Status is OFF. • The request bit should be ON for longer than the cyclic
(2) Execute Job Change Request after the completion of communication time interval (RPI).
sequence (1).
A switch is made to job No.0.
(3) When Job Change Complete becomes ON, Start
Marking Request is set to ON.
The marking process starts.
(4) When Marking Complete2 becomes ON, Job Change
Complete Bit Clear and Marking Complete Bit Clear are
set to ON.
The completion flag is cleared.

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-21


Ladder Program Example

Changing the string (An example of bit control)

z Reference ladder z Timing chart


Ready Status

Request Data No

Request Data Size

2
Request Data

String Change Request


EtherNet/IP

String Change Complete

String Change Complete Bit


Clear

• “Ready” becomes OFF and “Busy” becomes ON while a


string is being changed.
• If changing the string fails, the [String Change Request
Error] will turn on.
• “String Change Complete” will not become OFF until
“String Change Complete Bit Clear” becomes ON or until
“String Change Request” becomes ON again.
z Sequence • The request bit should be ON for longer than the cyclic
communication time interval (RPI).
(1) Perform the following at the rising edge of MR001:
• Transfer the block No. “0” to Request No.
• Transfer “8” to Request Data size
• Transfer “MD-X2000” to Request Data

The character string data needs to arrange the order


(endian) according to the CIP rules. By the RCPSASC
command of KVSeries convert the character string
stored in “DM100” into the CIP character string type
data, and store the converted data in “W092(Request
Data Size)”*, and store the converted data size in
“DM200”.
* The character string data length is stored in
“W092(Request Data Size)” and “W093(Request
Data (0))”.

If Ready Status is ON, perform String Change Request.


The command for changing the string of block No.0 to “MD-X2000”
will be sent.
(2) When String Change Complete becomes ON, String
Change Complete Bit Clear is set to ON.
The completion flag is cleared.

2-22 - MD-X2000/2500 Series Communication Interface User’s Manual -


Ladder Program Example

Sending a command (An example of command communication)

z Reference ladder z Timing chart


Ready Status

Request Data Size

Request Data

2
Command Send Request

Command Send Complete

EtherNet/IP
Response Data Size

Response Data

• “Ready” becomes OFF and “Busy” becomes ON while


a string is being changed via sending communication
commands.
• “Command Send Request Error” turns ON when the
z Sequence command sending fails.
• “Command Send Complete” will not become OFF until
(1) Perform the following at the rising edge of MR002: “Command Send Complete Bit Clear” becomes ON or
• Transfer the number of sent bytes “30” to Request Data Size until “Command Send Request” becomes ON again.
• Transfer “WX,BLK=000,CharacterString=ABC” to Request Data • The response to “Command Send Request” stores the
data length in “Response Data Size” and data content in
• For further details of the communication command, “Response Data”.
refer to “Chapter 1 Communication Interface” • The request bit should be ON for longer than the cyclic
(Page 1-1). communication time interval (RPI).
• The send data needs to arrange the order (endian)
according to the CIP rules. By the RCPSASC
command of KV Series, convert the character string
(“WX,BLK=000,CharacterString=ABC”) stored in
“DM1000” into the CIP character string type data,
and store the converted data in “W092(Request
Data Size)”*, and store the data size after being
converted into “DM2000”.
* The character string data length is stored in
“W092(Request Data Size)” and “W093(Request
Data (0))”.

If Ready Status is ON at the rising edge of MR002, perform


Command Send Request, and the command to change the
character string of block No. 0 to “ABC” will be sent.
(2) When Command Send Complete becomes ON, store
Response Data in the data memory “DM3000”.
Once the command communication ends, the received
data will be stored in “W012 (Response Data Size)” and
“W013 (Response Data)”.
The received data likewise needs to arrange the order
(endian). By using the CPSASC command of KV Series
convert the “W012 (Response Data Size)” and “W013
(Response Data)” into the converted data in DM3000.

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-23


Ladder Program Example

OMRON PLC CJ2 Series Program Example


This chapter introduces an example of a ladder program for controlling the laser marker using the CJ2 series. The data memory numbers are described
based on the default values of CJ2 series. Modify the numbers as necessary according to your environment.

Changing the job No. and starting the marking (An example of bit control)

z Reference ladder z Timing chart


Ready Status

2 Request No

Job Change Request


EtherNet/IP

Job Change Complete

Start Marking Request

Marking Complete 2

Marking Complete /
z Sequence Job Change Complete Bit
Clear
(1) If Ready Status is ON at the rising edge of 0.01,
transfer job No.”1” to Request No. • “Ready Status” becomes OFF and the “Busy” bit
End the sequence if Ready Status is OFF. becomes ON while the job No. switching is in progress.
• If the job No. switching fails, “Job Change Request
(2) Execute Job Change Request after the completion of
Error” will become ON.
sequence (1). • “Job Change Complete” retains its ON status until “Job
A switch is made to job No.1. Change Complete Clear” becomes ON or until “Job
(3) Set Start Marking Request at the rising edge of 0.02 to Change Request” becomes ON again.
ON . • “Marking Complete” retains its ON status until “Marking
The marking process starts. Complete Bit Clear” becomes ON or until “Marking
Request” becomes ON again.
(4) Set Job Change Complete Bit Clear at the rising edge • The request bit should be ON for longer than the cyclic
of 0.03, and set Marking Complete Bit Clear at the communication time interval (RPI).
rising edge of 0.04 to ON.
The completion flag is cleared.

2-24 - MD-X2000/2500 Series Communication Interface User’s Manual -


Ladder Program Example

Changing the string (An example of bit control)

z Reference ladder z Sequence


(1) Input “KEYENCE” in D2000 at the rising edge of 1.01.
(2) Detect the character string length of D2000 at the
rising edge of 1.02.
(3) Divide the detected character string length by 2 at the
rising edge of 1.03 (2), and detect the memory count
which is going to store the character data.
(4) Perform the following at the rising edge of 1.04:
• Transfer the character data “KEYENCE” to Request Data
• Byte swap the Request Data. 2
The send data needs to arrange the order (endian)

EtherNet/IP
according to the CIP rules. By the SWAP command of
CJ2 Series convert the character string (“KEYENCE”)
stored in “D3000” into the CIP character string type
data, and store the converted data in “D13 (Request
Data Size)”.

(5) Perform the following at the rising edge of 1.05:


• Store the block No. “0” to be changed to Request No.
• Store the character string length “7” to Request Data size
• Set String Change Request to ON.

z Timing chart
Ready Status

Request Data No

Request Data Size

Request Data

String Change Request

String Change Complete

String Change Complete Bit


Clear

• “Ready” becomes OFF and “Busy” becomes ON while a


string is being changed.
• If changing the string fails, the [String Change Request
Error] will turn on.
• “String Change Complete” will not become OFF until
“String Change Complete Bit Clear” becomes ON or until
“String Change Request” becomes ON again.
• The request bit should be ON for longer than the cyclic
communication time interval (RPI).

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-25


Ladder Program Example

Sending a command (An example of command communication)

z Reference ladder z Sequence


(1) Input “WX,BLK=0,CharacterString=MD-X” in D3000 at the
rising edge of 2.01.
* In the reference ladder, part of it is omitted.
(2) Detect the character string length of D3000 at the rising
edge of 2.02.
(3) Divide the detected character string length by 2 at the
rising edge of 2.03 (2), and detect the memory count which

2
is going to store the character data.
(4) Perform the following at the rising edge of 2.04:
• Transfer the character data “WX,BLK=0,CharacterString=MD-X” to
Request Data
EtherNet/IP

• Byte swap the Request Data.

• For details on commands, refer to “Communication


Interface Manual”.
• The send data needs to arrange the order
(endian) according to the CIP rules. By the SWAP
command of CJ2 Series convert the character string
(“WX,BLK=0,CharacterString=MD-X”) stored in “D3000”
into the CIP character string type data, and store the
converted data in “D13 (Request Data Size)”.

(5) Perform the following at the rising edge of 2.05:


• Store the character string length “29” to Request Data size
• Set the Bit of Command Send Request to ON.

z Timing chart
Ready Status

Request Data Size

Request Data

Command Send Request

Command Send Complete

Command Send Complete


Bit Clear

• “Ready” becomes OFF and “Busy” becomes ON while


a string is being changed via sending communication
commands.
• “Command Send Request Error” turns ON when the
command sending fails.
• “Command Send Complete” will not become OFF until
“Command Send Complete Bit Clear” becomes ON or
until “Command Send Request” becomes ON again.
• The response to “Command Send Request” stores the
data length in “Response Data Size” and data content in
“Response Data”.
• The request bit should be ON for longer than the cyclic
communication time interval (RPI).

2-26 - MD-X2000/2500 Series Communication Interface User’s Manual -


Ladder Program Example

Studio 5000 Logix Designer Ladder Program Example


This chapter introduces an example of an RSLogix5000 ladder program for controlling the laser marker using an Allen-Bradley Compact/Control Logix
PLC.

Changing the job No. and starting the Changing the string (An example of bit
marking (An example of bit control) control)

z Reference ladder z Reference ladder

EtherNet/IP
z Sequence
(1) Turn ON ChangeJob.
If Job Change Complete is OFF and Ready Status is ON, “1” is
stored in Request No.
(2) Execute Job Change Request after the completion of
(1).
A switch is made to job No.1.
(3) If Job Change Complete becomes ON, Start Marking z Sequence
Request are set to ON.
The marking process starts. (1) If String Change Complete is OFF and Ready Status
is ON when ChangeString turns ON, the following
(4) When Marking Complete2 turns ON, the Job Change
occurs:
Complete Bit Clear and Marking Complete Bit Clear are
• The length of the new string “5” is moved to Request Data Size
turned ON. • The Block Number “0” is moved to Request No
z Timing chart • The new string “ABCDE” is moved to Request Data (Addresses
13 to 17)
• String Change Request turns ON
Ready Status
(2) When String Change Complete turns ON, the String
Change Complete Bit Clear turns ON.
Request No

z Timing chart
Job Change Request
Ready Status

Job Change Complete


Request No

Start Marking Request


Request Data Size

Marking Complete 2
Request Data

Marking Complete /Job


Change Complete Bit Clear String Change Request

• “Ready Status” becomes OFF and the “Busy” bit String Change Complete
becomes ON while the job No. switching is in progress.
• If the job No. switching fails, “Job Change Request
String Change Complete Bit
Error” will become ON. Clear
• “Job Change Complete” retains its ON status until “Job
Change Complete Clear” becomes ON or until “Job
Change Request” becomes ON again.
Marking Complete2 remains ON until Marking Complete • “Ready” becomes OFF and “Busy” becomes ON while a
Bit Clear turns ON or until Marking Request turns ON string is being changed.
again. • If changing the string fails, the [String Change Request
• The request bit should be ON for longer than the cyclic Error] will turn on.
communication time interval (RPI). • “String Change Complete” will not become OFF until
“String Change Complete Bit Clear” becomes ON or until
“String Change Request” becomes ON again.
• The request bit should be ON for longer than the cyclic
communication time interval (RPI).

- MD-X2000/2500 Series Communication Interface User’s Manual - 2-27


Ladder Program Example

Sending a command (An example of


command communication)

z Reference ladder

2
EtherNet/IP

z Sequence
(1) If Command Send Complete is OFF and Ready Status
is ON when SendCommand turns ON, the following
occurs:
• The length of the command string “29” is moved to Request Data
Size
• The command string “WX,BLK=0,CharacterString=MD-X” is
moved to Request Data (Addresses 13 to 41)
• Command Send Request turns ON
(2) When Command Send Complete turns ON, the
following occurs:
• The Response Data Size “5” is moved to CommandResponse.
LEN
• The Response Data “WX,OK” is moved to CommandResponse.
DATA (Addresses 0 to 4)
• Command Send Complete Bit Clear turns ON.

z Timing chart
Ready Status

Request Data Size

Request Data

Command Send Request

Command Send Request


Complete

Command Send Request


Complete Bit Clear

• “Ready” becomes OFF and “Busy” becomes ON while


a string is being changed via sending communication
commands.
• “Command Send Request Error” turns ON when the
command sending fails.
• “Command Send Complete” will not turn OFF until
“Command Send Complete Bit Clear” turns ON or until
“Command SendRequest” turns ON again.
• The response to “Command Send Request” stores the
data length in “Response Data Size” and data content in
“Response Data”.
• The request bit should be ON for longer than the cyclic
communication time interval (RPI).

2-28 - MD-X2000/2500 Series Communication Interface User’s Manual -


3
PROFINET

PROFINET
Getting Started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Outline of the control by PROFINET. . . . . . . . . . . . . . . . . 3-2
Operation Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Devices compatible with PROFINET communication. . . 3-2
Communication Specification of the Controller. . . 3-3
Basic specification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Status of device assignment of the MD information
area. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Command communications. . . . . . . . . . . . . . . . . . . . . . . 3-11
Other controller specification . . . . . . . . . . . . . . . . . . . . . 3-11
When “Request” bit does NOT work. . . . . . . . . . . . . . . . 3-12
Setup Procedure of PROFINET . . . . . . . . . . . . . . . 3-13
Connection Procedure for PROFINET. . . . . . . . . . 3-14
Setup of PROFINET Communication . . . . . . . . . . . . . . . 3-14
Controlling the Laser Marker Controller. . . . . . . . . . . . . 3-19
Execute Ladder Program . . . . . . . . . . . . . . . . . . . . 3-22
Download the created ladder program on the PLC. . . . 3-22
Confirm/monitor the state of laser marker. . . . . . . . . . . 3-22

- MD-X2000/2500 Series Communication Interface User’s Manual - 3-1


Getting Started

Getting Started
Outline of the control by PROFINET
The MD-X2000/2500 series supports communication with PROFINET. PROFINET is an open communication standard defined by the PROFIBUS
& PROFINET International, which allows any compatible devices to communicate regardless of their manufactures. This system complies with the
Conformance Class A.

Operation Flow
Confirm the Specification
“Communication Specification of the Controller” (Page 3-3)

• Check if PROFINET supports the PLC to be connected.

3
• Check the device map of the input/output data.
PROFINET

Changing the PROFINET Setup Procedure


“Setup Procedure of PROFINET” (Page 3-13)

Set this product for connection with PROFINET.


Major setting items: IP address of this product and PROFINET device name

Establishing PROFINET communication


“Setup of PROFINET Communication” (Page 3-14)

• To register the laser marker information on the PLC, use the GSDML file that the laser marker model uses.
• After the PROFINET connection has been successfully established, the LINK LED (green) of the Ethernet port of the controller starts
blinking.

Performing the necessary processing


“Controlling the Laser Marker Controller” (Page 3-19)

Data I/O
• The laser marker information will be assigned to the PLC device and the status of the laser marker will be written to the MD information
area (Page 3-4) on the PLC.
• The laser marker information will be assigned to the PLC device and the laser marker controller is controlled by writing data to the MD
instruction area (Page 3-9) on the PLC.

Command control (Page 10)


The communication commands can be executed and several settings such as the marking parameter can be edited.
“Command communications” (Page 3-11)

Devices compatible with PROFINET communication


For details of the PLC setup, refer to “Connection Procedure for PROFINET” (Page 3-14) and the instruction manuals provided with the PLC.

z PLCs from Siemens


PLC PROFINET Communication
Firmware versions Software to be used Versions of software to be used
model units

S7-300 Built-in V2.6 of later STEP 7 V5.5.0.0 SP 2 or later

S7-400 Built-in V5.3 of later STEP 7 V5.5.0.0 SP 2 or later

S7-1200 Built-in V2.0 of later STEP 7 Basic Version V13 SP1

S7-1500 Built-in V2.0 of later STEP7 Professional Version V13 or later

3-2 - MD-X2000/2500 Series Communication Interface User’s Manual -


Communication Specification of the Controller

Communication Specification of the Controller


Basic specification
PROFINET communication of this system supports “periodic communication.”
When performing periodic communication using PROFINET, the laser marker functions are assigned to the PLC device. Use the functions assigned to
each device depending on the purpose. Either a straight or crossover LAN cable can be used.

Periodic communication
The periodic communication performs communication periodically (at an interval of few msec. to several dozens of msec.), which is suitable for real-time
control. The update time and communication size depend on the connection settings on the PLC side.
For details, refer to “Connection Procedure for PROFINET” (Page 3-14).

PROFINET
PLC MD-X2000/2500 series

MD information area
MD information area
Controller
Controller status
information
Error status
Error status
Busy status
Busy status
Reading result Communication Reading result
cycle
Configured
on the PLC side
PLC specified area PLC specified area

Marking instruction Marking instruction

Reading instruction Reading instruction

Command Command
instruction instruction

• Read the “Safety Information” in the user's manual for the applicable model to perform operation in the state that the safety
is secured by using security function even when the network failure occurs.
• Confirm the safe operation by considering the communication delay due to the communication time or network overload
state.

• Set the communication interval to 8 msec. or longer.


• The processing may be delayed or the communication may be disconnected by temporary timeout due to the excessive
temporary or continuous load, caused by simultaneous communication functions. In this case, the periodic communication
settings and use condition need to be reviewed. Be sure to check problems in the operating performance before entering
production.
• Networks having many connected devices including a PROFINET device could cause delay and packet loss when the networks
are largely overloaded routinely/temporally. Validate the system thoroughly before operation.

- MD-X2000/2500 Series Communication Interface User’s Manual - 3-3


Communication Specification of the Controller

Status of device assignment of the MD information area


In the device, there is an area for “writing laser marker state to the PLC” and an area for “writing instructions from the PLC to the laser marker”. It is
divided into “bit area” and “word area”.

Bit area for writing laser marker state on the PLC


In the following areas, information is divided by bit. The bit values are either 0 or 1.
The laser marker information is written in the PLC bit area via cyclic communication. An area without a description is reserved.
Slot Size Module Address bit Name Status Information Description

Displays the ready status. When the device status is Ready, operations
0: Not Ready such as start marking, job change, and character string change are
0 Ready Status accepted
1: Ready
Linked I/O Terminal Trigger ready output

Displays the error (E***) status. To recover from an error, eliminate the

3
0: Not Error causes of the error first, and then turn on Error Clear.
1 Error Status
1: Error
Linked I/O Terminal Error output

0: Not Warning Displays the warning error (W***) status.


2 Warning Status
PROFINET

1: Warning Linked I/O Terminal Warning output

0: Not I/O Error


0 3 I/O Error Status Displays the terminal block error (T***) status.
1: I/O Error

0: Open Shutter Displays whether the internal shutter is opened or closed.


4 Shutter Status
1: Close Shutter Linked I/O Terminal Shutter status output

0: No Connection
5 Network Status Displays the Fieldbus network communication status.
1: Connection

0: Not Ready Displays the job switching ready status.


6 Job Change Ready Status
1: Ready Linked I/O Terminal Job switching ready status

Displays the Ready state of the distance laser.


Distance Laser Ready 0: Not Ready
7 Distance laser operation ready
Status 1: Ready Linked I/O Terminal
output

0: Laser Not Excited Displays the laser excitation status.


0 Laser Emitted Status
1: Laser Excited Linked I/O Terminal Laser excitation status output

0: OFF (Close)
1 Shutter Control Status Displays whether the shutter control input is on or off.
1: ON (Open)

0: OFF (Close)
2 Remote Interlock Status Displays whether the remote interlock input is on or off.
1: ON (Open)

Machine 1 Displays whether the laser safety module control input is on or off.
0 4 Laser Safety Module 0: OFF (Close)
Status 3 Displays the status where the laser emission stops when it is “1 (ON)”.
Status 1: ON (Open)
When the laser safety module (MD-C1) is not mounted, it is always “0”.

0: OFF Displays whether the logging trigger input is on or off.


4 Logging Trigger Status
1: ON Linked I/O Terminal Logging trigger input

External Lighting Control 0: OFF Displays whether the external lighting control output is on or off.
5
Status 1: ON Linked I/O Terminal External Lighting Control Output

If one or more of the following busy statuses are on, Busy Status turns
on.
Marking Busy, Guide Laser Busy, Job Change Busy,
0 Busy Status
Commmunication Priority, Job Edit Busy,
Mark Cheeck/2DC Read Busy Status,
Window Monitoring Busy

Turns on during marking (including laser inspection).


1 Marking Busy Status
Linked I/O Terminal Output During Marking

Turns on when guide laser marking is in operation (including the


2 Guide Laser Busy Status distance pointer).

Linked I/O Terminal Guide Laser Output

0: Not Busy Turns on when a job is being deployed.


2 3 Job Change Busy Status
1: Busy (Deployment timing: when changing marking jobs, content, and so on)

Displays the communication priority status. Turns on when the laser


Communication Priority
4 marker is connected to an external control device and in the no priority
Error Status
state.

Turns on when the Job Edit Start Request turns on and editing starts.
5 Job Edit Busy Status Returns to “OFF” when the Job Edit Start Request is turned off and
editing is completed.

Mark Check /2DC Read Turns on when the marking verification function or 2DC reading is
6
Busy Status operating.

Turns on during the lens inspection. This not only turns on when the
Window Monitoring Busy operation is started by Profinet and Ethernet/IP communications, but
7
Status also when this operation is started by another communication and
before or after marking.

3-4 - MD-X2000/2500 Series Communication Interface User’s Manual -


Communication Specification of the Controller

Slot Size Module Address bit Name Status Information Description

0 Trigger Lock Status Displays whether the trigger lock input is on or off.

1 Operation Stop Status Displays whether the processing operation stop input is on or off.

2 Laser Control Status 0: OFF Displays whether the laser stop input is on or off.
0
3 Date Hold Status 1: ON Displays whether the date hold input is on or off.

4 Internal Lighting Status Displays whether the internal lighting control input is on or off.

5 Distance Laser Stop Status Displays whether the distance laser stop input is on or off.

0: OFF Displays the status of date attach output.


0 Date Attach Status
1: ON Linked I/O Terminal Date attach output

1 Counter End1 Status


Displays the status of counter end output 1 - 4. You can use the
2 Counter End2 Status 0: Not Complete Controller settings of the Marking Builder Plus to assign the individual
1: Complete and common counters (0 to 9, A to J).
3 Counter End3 Status

3
4 Counter End4 Status Linked I/O Terminal Counter end output 1 - 4

Displays whether the marking verification function or 2D code grade


0→1: OK
assessment result is OK or not.* 1
1→0: -
Displays the 2D code grade result by default, and the assessment
Mark Check/2DC Read OK result of the marking verification function will be displayed in Mark
5 [Reset timing]

PROFINET
Status1 Check/2DC Read OK Status 2. Status 1 and 2 can be reversed in the
1 Reset when 2DC Read
Request or 2DC Read communication setting screen.
Complete Bit Clear turns on.
Linked I/O Terminal Marking/2D code check OK output

Displays whether the marking verification function or 2D code grade


0→1: NG assessment result is OK or not.* 1
1→0: - Displays the 2D code grade result by default, and the assessment
Mark Check/2DC Read NG result of the marking verification function will be displayed in Mark
6 [Reset timing] Check/2DC Read OK Status 2. Status 1 and 2 can be reversed in the
Status1
Function Reset when 2DC Read communication setting screen.
1 4 Request or 2DC Read
Status
Complete Bit Clear turns on. Marking/2D code check NG
Linked I/O Terminal
output

Displays the status of marking complete output.


0: Not Complete
7 Marking Complete 1
1: Complete Linked I/O Terminal Marking complete output

Displays whether the marking verification function or 2D code grade


0→1: OK
assessment result is OK or not.* 1
1→0: -
Displays the marking verification result by default, and the grade
Mark Check/2DC Read OK [Reset timing] assessment result of the 2D code will be displayed in Mark
0
Status 2 Reset when 2DC Read Check/2DC Read OK Status 1. Status 1 and 2 can be reversed in the
Request or 2DC Read communication setting screen.
Complete Bit Clear turns on.
Linked I/O Terminal Marking/2D code check OK output

Displays whether the marking verification function or 2D code grade


0→1: NG assessment result is OK or not.* 1
1→0: - Displays the marking verification result by default, and the grade
Mark Check/2DC Read NG assessment result of the 2D code will be displayed in Mark
1 [Reset timing] Check/2DC Read NG Status 1. Status 1 and 2 can be reversed in the
Status 2 Reset when 2DC Read communication setting screen.
2 Request or 2DC Read
Complete Bit Clear turns on. Marking/2D code check NG
Linked I/O Terminal
output

Turns on for a fixed time when using the XY tracking/Z tracking


function, or when succeeding the tracking. Turns on by AND condition
0→1: OK
2 3-Axis Tracking OK Status when using multiple tracking settings.
1→0: -
Linked I/O Terminal 3-Axis Tracking OK Output

Turns on for a fixed time when using the XY tracking/Z tracking


function, or when failing the tracking. Turns on by AND condition when
0→1: NG
3 3-Axis Tracking NG Status using multiple tracking settings.
1→0: -
Linked I/O Terminal 3-Axis Tracking NG Output

- MD-X2000/2500 Series Communication Interface User’s Manual - 3-5


Communication Specification of the Controller

Slot Size Module Address bit Name Status Information Description

Displays the completion status of marking started with Start Marking


0 Marking Complete 2 Request.
If marking has been canceled, it does not turn on.* 2

Displays the completion status of guide laser marking started with


1 Guide Laser Complete Guide Laser Request. If completed, regardless of how it was canceled,
0: Not Complete be it communications, I/O, or the like, it turns on.* 2
1: Complete
Displays the completion status of Stop Marking Request. Even if
Completion 2 Laser Stop Complete marking is started from other communications or I/O, if cancellation is
2 8 0 [Reset timing]
Status completed with Stop Marking Request, the bit turns on.
Reset when the Complete
Clear Bit statuses turn on or
Displays the completion status of Error Clear Request. After
the next Request turns on.
3 Error Clear Complete completion, it turns on, regardless of whether error clearing was
successful or not.* 2

4 2DC Read Complete Displays the completion status of 2DC Read Request.* 2

Window Monitoring
5
Complete
* Turns on when completing the lens inspection.* 2

3
Displays the completion status of editing started with Job Edit Start
1 0 Job Edit Complete
Request. If it completes successfully, the bit turns on.

0 Job Change Complete Displays the completion status of Job Change Request.* 2

1 Rank Change Complete Displays the completion status of Rank Change Request.* 2
PROFINET

2 Counter No Complete Displays the completion status of Counter No Change Request.* 2

3 Counter Value Complete Displays the completion status of Counter Value Change Request.* 2

Displays the completion status of the value changed with Counter Up


2 4 Counter Up Complete
Request.* 2

Displays the completion status of the value changed with Counter


5 Counter Down Complete Down Request.
0: Not Complete *2
1: Complete Displays the completion status of the reset with Counter Reset
Completion 6 Counter Reset Complete Request.
2 8 [Reset timing]
Status *2
Reset when the Complete
System Info ID Change Clear Bit statuses turn on or Displays the changing completion of the operation information ID by
3 0 the next Request turns on.
Complete System Info ID Change Request.

Setting String Read Displays the completion status of Setting String Read Request.
0
Complete *2

4 Marked String Read Displays the completion status of Marked String Read Request.
1
Complete *2

2 String Change Complete Displays the completion status of String Change Request.* 2

0 Command Send Complete Displays the completion status of Command Send Request.* 2

XY Tracking Result Read


1 Display the completion status of XY Tracking Result Request.* 2
7 Complete

Z Tracking Result Read


2 Display the completion status of Z Tracking Result Request.* 2
Complete

3-6 - MD-X2000/2500 Series Communication Interface User’s Manual -


Communication Specification of the Controller

Slot Size Module Address bit Name Status Information Description

If the marking operation started with Start Marking Request fails, the bit
Start Marking Request turns on.
0
Error If marking is canceled or marking cannot start without priority, it turns
on.* 3

0: Not Error If the guide laser operation started with Guide Laser Request fails, the
1 Guide Laser Request Error 1: Error bit turns on. If Guide Laser Request is turned on when the guide laser
cannot be irradiated or cannot be started without priority, it turns on.* 3
0 [Reset timing]
Stop Marking Request Reset when the Complete Bit
2 If a Stop Marking Request fails to stop marking, the bit turns on.* 3
Error Clear statuses turn on or the
next Request turns on.
3 Error Clear Request Error If an Error Clear Request fails to clear the error, it turns on.* 3

4 2DC Read Request Error If a 2DC Read Request fails to read a 2D code, the bit turns on.

Window Monitoring If a Window Monitoring Request fails in the lens inspection operation, it
5
Request Error turns on.* 3

0: Not Error
1: Error

3
If a Job Edit Start Request fails to edit the job, it turns on.* If edit start
[Reset timing]
1 0 Job Edit Error is not received or if data cannot be deployed when editing finishes, the
Reset when Job Edit
bit turns on.
Complete Bit Clear turns on
or the next Job Edit Start
Request turns on.

PROFINET
Error Status 0 Job Change Request Error If a job change with a Job Change Request fails, it turns on.* 3
3 8
Bits
Rank Change Request If an I/O specified character change with a Rank Change Request fails,
1
Error it turns on.* 3

Counter No Change If a number change with a Counter No Change Request fails, the bit
2
Request Error turns on.* 3
0: Not Error
Counter Value Change If a value change with a Counter Value Change Request fails, the bit
3 1: Error
Request Error turns on.* 3
2 [Reset timing]
If a value change with a Counter Up Request fails, it turns on.* 3
4 Counter Up Request Error Reset when the Complete Bit
Receivable condition: Ready ON
Clear statuses turn on or the
Counter Down Request next Request turns on. If a value change with a Counter Down Request fails, it turns on.* 3
5
Error Receivable condition: Ready ON

Counter Reset Request If a reset with a Counter Reset Request fails, it turns on.* 3
6
Error Receivable condition: Ready ON

System Info ID Change If a change of the operation information ID with a System Info ID
7
Error Change Request fails, it turns on.* 3

Setting String Read 0: Not Complete


0 If reading with a Setting String Read Request fails, it turns on.* 3
Request Error 1: Complete
Marked String Read
4 1 [Reset timing] If reading with a Marked String Read Request fails, the bit turns on.* 3
Request Error Reset when the Complete Bit
String Change Request Clear statuses turn on or the If a change with a String Change Request fails, the bit turns on.
2 next Request turns on.
Error It will also fail if the data length exceeds 250 bytes.* 3

Command Send Request 0: Not Error If Command Send Request fails, the bit turns on.
0
Error 1: Error It will also fail if the data length exceeds 250 bytes.* 3

Error Status XY Tracking Result


3 8 7 1 [Reset timing] When XY Tracking Result Request fails, it turns on.* 3
Bits Request Error Reset when the Complete Bit
Z Tracking Result Request Clear statuses turn on or the
2 next Request turns on. When Z Tracking Result Request fails, it turns on.* 3
Error

* 1 If a code is read with the settable 2D code reading function on Marking Builder Plus, OK/NG is output with the grade that is set as the
threshold as the reference.
If code is read with 2DC Read Request, OK/NG is output for whether the code was successfully read or not.
(If the code is read even at Grade F, OK is output.)
* 2 The bit turns on at completion only if the operation is started by Profinet and Ethernet/IP communications.
If you start the operation with other forms of communication or I/O, the bit will not turn on, even if the operation completes.
The bit turns on when complete only if the operation is started by Profinet and Ethernet/IP communications.
* 3 If you started the operation with other forms of communication or I/O, the bit will not turn on, even if an error occurs.

Remote interlock input, shutter interlock input, and laser excitement input cannot be controlled from Profinet. Control those inputs from I/O.

- MD-X2000/2500 Series Communication Interface User’s Manual - 3-7


Communication Specification of the Controller

Word area for writing laser marker state on the PLC


In the following areas, the information is divided by word. The information is shown with 2-byte unsigned integer (0 to 65535).
The laser marker information is written in the PLC word area via cyclic communication. An area without a description is reserved.
Slot Size Module Address Data Type Name Status Information Description

Displays the number for the error currently occurring. The error number
Word Error Code 1 display differs to the normal display.
The error codes are displayed as four digits such as 1*** for an error
Error Number
(E***), 2*** for a warning error (W***), and 3*** for an I/O error (T***).
Word Error Code 2 Up to two errors can be displayed. When three or more errors occur,
check them with Marking Builder Plus.

4 8 Error Codes 0 Error Number

[Reset timing]
If Command Send Request fails due to a software error, the error
Command Send Reset when Command
Word number is displayed. The error number display differs to the normal
Error Status Send Request Complete Bit
display. A software error (S***) is displayed as 4*** in four digits.
Clear turns on or the next
Command Send Request

3
turns on.
Job Number
Word Job No Status Displays the currently selected job number.
(0 to 1999)

• Counter Value Change/Up/Down/Reset Request that is to be


changed
PROFINET

Counter Number
• Counter Value Status that is to be displayed
Word Counter No Status Displays the number of the target counter listed above.
(0 to 19)
Changes with Counter No Change Request.
Individual Counter(0 to 9): 0 to 9
Operate Common Counter(A to J):10 to 19
5 16 0
Parameter Counter Value Counter Value Displays the current counter value set to be displayed for Counter No
DWord
Status (0 to 4294967295) Change Request.
I/O Encoded Character Value
Word Rank Value Status Displays the value for I/O specified characters.
(0 to 35)
System Info ID
Word System Info ID Displays the currently selected operation information ID.
(0 to 301)
System Info Value
DWord System Info Value Displays the operation information specified by System Info ID.
(0 to 4294967295)

[When acquiring 2DC reading] Any of the following are displayed:


0 to 4 • 2D code reading (Defaults) : Read fail of AIM DPM comprehensive
determination grade or F(0)/D(1)/C(2)/
[When using the marking B(3)/A(4)
Marking Check
verification function] • Marking verification function : score
000 to 100 Displays the 2D code result by default, and the assessment result of
Word Score/2DC Read
the marking verification function will be displayed in Marking Check
Grade Status 1 [Reset timing] Score/2DC Read Grade Status 2. Status 1 and 2 can be reversed in
Resets when 2DC Read the communication setting screen of Marking Builder Plus.
Complete Bit Clear turns on When displaying the result of the 2D code reading grade, even if you
or the next 2DC Read started the operation with communications and I/O other than 2DC
Request turns on. Read Request, the result is displayed after the operation is completed.
Displays the execution count of the 2D code reading or the execution
0 to 65535 count of the marking verification functions. Displays the execution
Marking Check/2DC
count of the 2D code reading by default, and the execution count of the
Word Read Total Count [Reset timing]
marking verification functions will be displayed in Marking Check/2DC
Status 1 It will be reset to “0” when the
Marking Read Total Count Status 2. Status 1 and 2 can be reversed in the
power is turned off.
Check/2D communication setting screen of Marking Builder Plus.
6 8 0
Code Read
[When using the marking Any of the following are displayed:
Result
verification function] • Marking verification function (defaults) : score
000 to 100
• 2D code reading : Read fail of AIM DPM comprehensive
determination grade or F(0)/D(1)/C(2)/B(3)/A(4)
[When acquiring 2DC reading]
Marking Check Displays the result of the marking verification function by default, and
0 to 4
Word Score/2DC Read the grade result of the 2D code reading will be displayed in Marking
Grade Status 2 [Reset timing] Check Score/2DC Read Grade Status 2. Status 1 and 2 can be
Reset when 2DC Read reversed in the communication setting screen of Marking Builder Plus.
Complete Bit Clear turns When displaying the result of the 2D code reading grade, even if you
on or the next 2DC Read started the operation with communications and I/O other than 2DC
Request turns on. Read Request, the result is displayed after the operation is completed.

Displays the execution count of the marking verification function or the


0 to 65535 execution count of the 2D code reading. Displays the execution count
Marking Check/2DC
of the marking verification function by default, and the execution count
Word Read Total Count [Reset timing]
of the 2D code reading in Marking Check/2DC Read Total Count Status
Status 2 It will be reset to “0” when the
1. Status 1 and 2 can be reversed in the communication setting screen
power is turned off.
of Marking Builder Plus.
Count Result Total Marking Count Marking Count
7 4 0 DWord Displays the marking count.
Data Status (0 to 4294967295)
Response Data Data size
0 Word Stores the data length of “Response Data” in 16-bit binary data.
Size (2 bytes)
Displays the response data for the Setting/Marked String Request, 2DC
Response Read Request (read content), Command Send Request, XY Tracking
2+
Response Result Request, and Z Tracking Result Request.
8 data
Data [Reset timing]
size 2 Character Response Data * Selectable capacities are from 32, 64, 128, and 252 bytes on the
Reset when each Complete PLC settings. (Default: 128 bytes.) However, if the response data
Bit Clear request turns on or is greater than the selected byte number, all the data cannot be
the next Request turns on. received. Additionally, even if 252 bytes is selected, the maximum
amount of data that will be received is 250 bytes.

3-8 - MD-X2000/2500 Series Communication Interface User’s Manual -


Communication Specification of the Controller

Bit area for writing the request from the PLC onto the laser marker
In the following areas, information is divided by bit. The bit values are either 0 or 1.
The request from the PLC is written onto the laser marker via cyclic communication. An area without a description is reserved.
Slot Size Module Address bit Name Status Information Description
0→1: Start
1→0 : - Starts the marking.
If marking cannot be performed or is canceled, Start Marking Request
0 Start Marking Request [Condition of operation] Error turns on. The Marking Busy Status turns on during marking. If
The Ready Status is turned marking completes successfully, Marking Complete 1 and 2 turn on.
on.
Starts guide laser marking.
0→1: Start
Enter the number into Request No. beforehand.
1→0 : -
0: Distance pointer 1: Guide laser once
[Condition of operation]
The Ready Status is turned 2: Guide laser continuously 3: Area frame
on.
1 Guide Laser Request 4: Work image 5: Block frame
* During shutter control,

3
contactor control, and
If marking completes or is canceled (including canceled due to an error)
safety shutter control, the
after a set amount of time, the Guide Laser Request Complete bit turns on.
request is received even if
If guide laser marking cannot start, Guide Laser Request Error turns on.
the Ready Status is turned
If the move marking setting is selected, guide laser marking cannot be
off.
used. The error bit turns on.

PROFINET
0→1: Stop
1→0 : -
2 Stop Marking Request Cancels marking.
[Condition of operation]
The Marking Busy Status is
0
turned on.
If an error occurs, remove the cause of the error and then turn this bit
on to clear the error. An Error Status Bit error cannot be cleared (it is
reset when the Complete Bit Clear statuses turn on or the next Request
0→1: Error Clear
3 Error Clear Request turns on).
1→0 : -
After the operation has been completed, Error Clear Complete turns
on regardless of whether the error is cleared successfully or not. If the
error cannot be cleared, Error Clear Request Error turns on.
Reads 2D code.The reading position is the current scanner coordinates.
Reading is performed with the coaxial camera in wide mode. The
0→1: Start internal lighting does not turn on automatically during reading. To use
1→0 : - this lighting, turn it on via communication or I/O before executing the
4 2DC Read Request 2DC Read Request.
[Condition of operation]
If this request is run when the condition of operation is not satisfied, Mark
The Ready Status is turned
Check/2DC Read OK Status, Mark Check/2DC Read NG Status, and 2DC
on.
Read Complete are reset, and 2DC Read Request Error turns on.
* It cannot be used on the MD-X400(A)/450(A) series.
0→1: Start Starts the lens inspection.
1→0 : - If this request is run when the condition of operation is not satisfied,
Window Monitoring
General 5 Window Monitoring Complete is reset, and Window Monitoring Request
Request [Condition of operation]
0 8 Error is turned on.
Request The Ready Status is turned
* It cannot be used on the MD-X2050(A)/400(A)/450(A) series.
on.
Starts the job editing.
If the start edit request is received successfully, the job change
request after that is retained temporarily in the controller, and the job is
0→1: Edit Start
1 0 Job Edit Start Request deployed all at once when editing is completed. Use this request if you
1→0: Edit End
want to reduce the communication time used by job editing. If edit start
is received successfully, Job Edit Busy Status turns on. Additionally, if
edit start is received successfully, Job Edit Complete turns on. 1
0 Job Change Request Changes the job number. * 1
1 Rank Change Request Changes the I/O specified characters. * 1
Changes the number of the counter to be changed. * 1
Counter No Change
2 Individual Counter(0 to 9): 0 to 9
Request
Common Counter(A to J):10 to 19
Counter Value Change Changes the value of the counter set to be displayed for Counter No
3
2 Request Change Request. * 1
Increases the value of the counter set to be displayed for Counter No
4 Counter Up Request
Change Request. * 1
Reduces the value of the counter set to be displayed for Counter No
5 Counter Down Request
Change Request. * 1
Resets the counter set to be displayed for Counter No Change
6 Counter Reset Request
Request. * 1

0→1: Request Changes the operation information ID. The operation information to the
1→0 : - ID is displayed to System Info Value.* 1

Operation ID Operation information


1 Controller operating time
2 Laser excited time
3 Scanner operating time
System Info IDChange
3 0 101 Number of shutter operations
Request
Number of times the laser safety module has
102
been operated
201 Head temperature
202 Controller temperature
301 Results of the laser power calibration
302 Final execution result of the lens inspection

- MD-X2000/2500 Series Communication Interface User’s Manual - 3-9


Communication Specification of the Controller

Slot Size Module Address bit Name Status Information Description


Setting String Read
0 Loads the settings.* 1
Request
Marked String Read Loads the marked content.* 1
1
Request Sending the request before marking results in an error.
5
Changes the content to be marked in the current job.
Store the block no. in Request No., the string in Request Data, and the
2 String Change Request
length of the string in Request Data Size. The maximum data length is
250 bytes.
General 0→1: Request Sends communication commands.
0 8
Request 1→0 : - Store the communication command in Request Data and the length
0 Command Send Request
of the string in Request Data Size. The maximum data length is 250
bytes. Store the response in Response Data.
Loads the result of the XY tracking.
7 XY Tracking Result
1 Enter the XY tracking No. into the Request No. Store the response in
Request
Response Data. Sending the request before marking results in an error.
Loads the result of the Z tracking.
2 Z Tracking Result Request Enter the Z tracking No. into Request No. Store the response in

3
Response Data. Sending the request before marking results in an error.
Disables the trigger input.
If this bit turns on while marking, the trigger lock status is activated after
0 Trigger Lock Request
all of the mark data is marked. Test marking and sample marking is
immediately canceled when this bit turns on.
PROFINET

Stops the laser radiation (the internal shutter remains open).


1 Operation Stop Request Use this bit to stop the laser radiation at the desired position while
processing a workpiece.

Function 0: Input Off Stops the marking laser and the guide laser.
1 4 0 2 Laser Stop Request
Request 1: Input On The internal shutter closes while this bit is turned on.
If the controller's internal clock passes midnight when this bit is turned
3 Date Hold Request on, the date of updated string is subtracted one day and the subtracted
date is marked.
Turns on an internal lighting.
4 Internal Lighting Request
* It cannot be used on the MD-X2050(A)/400(A)/450(A) series.
Distance Laser Stop Stops the distance laser.
5
Request * It cannot be used on the MD-X2050(A)/400(A)/450(A) series.

0 Marking Complete Bit Clear Resets Marking Complete and Start Marking Request Error.

Guide Laser Complete Bit


1 Resets Guide Laser Complete and Guide Laser Request Error.
Clear

Laser Stop Complete Bit


2 Resets Laser Stop Complete and Stop Marking Request Error.
Clear 0→1: Complete Clear
0
1→0 : -
Error Clear Complete Bit
3 Resets Error Clear Complete and Error Clear Request Error.
Clear
2DC Read Complete Bit Resets 2DC Read Complete, 2DC Read Request Error, Mark
4
Clear Check/2DC Read OK Status, and Mark Check/2DC Read NG Status.
Window Monitoring
5 Resets Window Monitoring Complete.
Complete Bit Clear
0→1: Complete Clear
1 0 Job Edit Complete Bit Clear Resets Job Edit Complete and Job Edit Error.
1→0 : -
Job Change Complete Bit
0 Resets Job Change Complete and Job Change Request Error.
Clear
Rank Change Complete Bit
1 Resets Rank Change Complete and Rank Change Request Error.
Clear
Request
2 8 Completion Counter No Change
2 Resets Counter No Complete and Counter No Change Request Error.
Clear Complete Bit Clear
Counter Value Change 0→1: Complete Clear
2 3 Resets Counter Value Complete and Counter Value Change Error.
Complete Bit Clear 1→0 : -
Counter Up Complete Bit
4 Resets Counter Up Complete and Counter Up Request Error.
Clear
Counter Down Complete
5 Resets Counter Down Complete and Counter Down Request Error.
Bit Clear
Counter Reset Complete
6 Resets Counter Reset Complete and Counter Reset Request Error.
Bit Clear
System Info ID Change Resets System Info ID Change Complete and System Info ID Change
3 0
Complete Clear Error.
Setting String Read Resets Setting String Read Complete and Setting String Read Request
0
Complete Bit Clear 0→1: Complete Clear Error.
Marked String Read 1→0 : - Resets Marked String Read Complete and Marked String Read
4 1
Complete Bit Clear Request Error.
String Change Complete
2 Resets String Change Complete and String Change Request Error.
Bit Clear
Command Send Complete 0→1: Complete Clear
7 0 Resets Command Send Complete and Command Send Request Error.
Bit Clear 1→0 : -

* 1 Turns on this bit after storing the job No., I/O specified character No., counter value, counter No., and operation information No. in the
applicable Request No.
* 2 If you turn on this bit after storing the block No. in Request No., the content will be loaded from the specified block in the current job. Store
the load result in Response Data.

3-10 - MD-X2000/2500 Series Communication Interface User’s Manual -


Communication Specification of the Controller

Word area for writing a PLC request


In the following areas, the information is divided by word. The information is shown with 2-byte unsigned integer (0 to 65535).
The detailed information of the request from the PLC is written.

Slot Size Module Address Data Type Name Status Information Description

Numbers Stores the job No., block No., counter value, and counter No. to be
3 4 Request No 0 DWord Request No
(Four bytes) changed.

Data size
0 Word Request Data Size Stores the data length of “Request Data” in 16-bit binary data.
(Two bytes)

2+ Request Use for String Change Request and Command Send Request. Store
Command function
4 data Parameters the change string and communication command data. Headers and
(Default: 250 bytes)
size for strings delimiters are not required.
2 Character Request Data * Selectable from 32, 64,
128, and 252 bytes on the
* Selectable capacities are from 32, 64, 128, and 252 bytes on the
PLC settings. (Default: 250 bytes.) However, even if 252 bytes is
PLC.
selected, the maximum amount of data that can be sent is 250 bytes.

* 1 If you turn on this bit after storing the block No. in Request No., the content will be loaded from the target block in the current job, and will be

3
stored in Response Data.

PROFINET
Command communications
PROFINET communication can control the laser via command communication.
Since the communication mode is “command/response type”, multiple commands cannot be sent simultaneously. Therefore, make sure to send the
command only after a response has been received.
The command and response data is a combination of comma-delimited parameters.

z Communication format
Header and delimiter settings are not required. Store the send data size in “Request Data Size” and the send data in “Request Data” in the PLC
command area. Then set the “Command Send Request” bit to “1” to enable the stored data to be sent to the controller. For the communication
commands, refer to “Communication Interface Manual”.

Other controller specification

Endian
Endian is a method to place multiple-byte data onto the PLC's data memory. The laser marker uses the big endian method. Data having 2 bytes or more
is recorded/sent in sequence from the upper byte.
Typical endians are below.
• PLCs from Siemens: Big endian
• Omron PLC: Little-Endian

GSDML file
GSDML file includes information on the PROFINET functions of the controller.
GSDML file is in the following folder of the PC which Marking Builder Plus was installed on.
C:\Program Files\keyence\MarkingBuilderPlus_Ver*\etc\ Profinet\[model name]
(Version of Marking Builder Plus is in *.)
Copy this file onto your PLC as required.
File name: GSDML-[Version]-Keyence-[Model name]-yyyymmdd.xml
(yyyymmdd is an update time of the file.)

The MD-X400 Series can use a GSDML file from the MD-X2000 Series.
In this case, some displays may be the contents of the MD-X2000 series.

- MD-X2000/2500 Series Communication Interface User’s Manual - 3-11


Communication Specification of the Controller

When “Request” bit does NOT work


If a request is turned on but does not work, check the communications history.
You can check the history of commands sent and received between the PLC and laser marker in the Marking Builder Plus communications history.

z Confirmation method
Start Marking Builder Plus, and select the [Maintenance] tab > [Communication] > [Communication History].
The [Communication History] window appears. Click the [Update] button to display the latest history.

3
PROFINET

If the Communication history is empty, the laser marker has not received any Communication.
Double check the communication settings between the laser marker and the PLC, and make sure that the HUB and cable are not defective.

z Request format
Each request will be stored in the communication history in the following format:
Command: ***** Request
Response: ***** Request,X (X = 0: Success; X = 1: Fail)
However, the requests below have a different format. (X = 0: Success; X = 1: Fail)
Request History format (“>” = command; “<” = response)

> 2DC_Read_Request,0
2DC Read Request
< 2DC_Read_Request,X,[Grade],[Content]

> Job_Edit_Start_Request,[Job No]


Job Edit Start Request
< Job_Edit_Start_Request,X

> Job_Change_Request,[Job No]


Job Change Request
< Job_Change_Request,X

> Rank_Change_Request,[I/O Character No]


Rank Change Request
< Rank_Change_Request,X

> Counter_No_Change_Request,,[Counter No],1


Counter No Change Request
< Counter_No_Change_Request,X,[Counter Current Value]

> Counter_Value_Change_Request,,[Counter No],[Counter Current Value]


Counter Value Change Request
< Counter_Value_Change_Request,X

> System_Info_ID_Change_Request,[System_Info_ID]
System Info ID Change Request
< System_Info_ID_Change_Request,X

> Setting_String_Read_Request,BLK=[Block No],CharacterString


Setting String Read Request
< Setting_String_Read_Request,[OK/NG],[Character String]

> Marked_String_Read_Request,MarkedCharacter=[Job No],[Block No]


Marked String Read Request
< Marked_String_Read_Request,[OK/NG],[Character String]

> String_Change_Request,,[Block No],[Character String]


String Change Request
< String_Change_Request,X

> Window_Monitoring_Request,WindowCheck
Window Monitoring Request
< Window_Monitoring_Request,[OK/NG], [Score]

> XY_Tracking_Result_Request,0
XY_Tracking_Result_Request < XY_Tracking_Result_Request, [OK/NG], [X Coordinate Gap Amount], [Y Coordinate Gap Amount], [θ Gap Amount], [Correlation
Value], [Execution Time], [Result]

> Z_Tracking_Result_Request
Z_Tracking_Result_Request < Z_Tracking_Result_Request, [OK/NG], [Z Coordinate Gap Amount], [X Rotation Angle], [Y Rotation Angle], [Stability], [Execution
Time], [Result]

> [Stored data for Request Data]


Command Send Request
< [Response]

An error may be the cause of the request not working. You can check up to two error codes simultaneously, Error Code 1 and Error Code 2.
Error details and resolutions are listed in the User's Manual for the applicable model.

3-12 - MD-X2000/2500 Series Communication Interface User’s Manual -


Setup Procedure of PROFINET

Setup Procedure of PROFINET


Perform settings on the [Communication settings] screen of Marking Builder Plus.
Perform the I/O setup with which the PROFINET inputs/outputs data via the Ethernet port of the controller.

• For the Ethernet setup of the controller such as IP address and subnet mask, refer to “Marking Builder Plus User's Manual.”
• This product needs to be restarted when you enable the PROFINET settings and rename any device name.

1 Select [Controller] from the [Settings] tab, and


then [Ethernet Settings].
4 Select the 2D code reader and marking
verification output assignments.

2 Set [Industrial Ethernet] to [PROFINET].

PROFINET
5 Press [OK].

3 Specify [Device Name].


6 Restart the controller.
Specify the name used for identifying this product in the PROFINET
network.

Use the same name to this product as one used


for connection of this product with the PLC. An
improper name will not allow the PLC to detect
this product, resulting in failure in establishing the
PROFINET communication.

- MD-X2000/2500 Series Communication Interface User’s Manual - 3-13


Connection Procedure for PROFINET

Connection Procedure for PROFINET


This section describes the example procedure in which the MD-X2000/2500 series connects to the Siemens S7-1200 series via PROFINET, retrieves the
controller status, and executes commands to control the controller.

Setup of PROFINET Communication

Checking the setup of the Laser marker Modify the settings of the Siemens S7-1200
series.
1 Select [Controller] from the [Settings] tab, and
then [Ethernet Settings].
1 Start up [Totally Integrated Automation Portal]
with the PC and the CPU connected each
3 2 Configure the Ethernet.
Use the settings below here as an example.
other, and select [Create new project] from
the [Start] menu.
(Modify the settings depending on the destination device).
PROFINET

Parameter Contents

Automatically acquire IP address Uncheck

2
IP address 192.168.1.20
Enter a project name in the [Project name]
Subnet mask 255.255.255.0
column, and select [Create].
Default gateway Not used

MAC address Not used

Port No. Not used

3 After the PROFINET setup, press [OK].


This example sets the MD-X2500 series with the following
parameters.
(Modify the settings depending on the destination device).

3 Double click [Add new device] under the


[Device & networks] menu, and select the PLC
to be used.
Select [CPU 1211C DC/DC/DC] as an example.
Parameter Contents

Industrial Ethernet PROFINET

Device name md-x1xxx

2DC reader/marking
confirmation 1: 2DC reader/2: Marking verification
output assignment

4 Restart the controller.

Be sure to restart the controller when you enable


the PROFINET settings or rename any device
name. The PROFINET communication will not
work without a restart.

3-14 - MD-X2000/2500 Series Communication Interface User’s Manual -


Connection Procedure for PROFINET

4 When setting MD-X2000/2500 series for the


first time, install GSDML file.
6 Configure the connection between the MD-
X2000/2500 series and the PLC.
Select [Install general station description file (GSD)] of the [Option] Connect to the Ethernet port on the PLC by dragging and dropping
tab. from the Ethernet port shown in green of the “md-x2xxx.”
Select the file name of “GSDML-V2.32-Keyence-MDX-yyyymmdd.
xml (yyyymmdd is the update date of the file)” and press [Install].

Move the mouse cursor away. If the indication below appeared, the
network has been established.

7 Double click the “MD-X1000/2500 series” icon


on the [Device view] screen.

8 Set the MD-X2000/2500 series and the PLC 3


from the [PROFINET interface] screen of

PROFINET
[Properties].

• GSDML file is in the following folder of the PC which


Marking Builder Plus was installed on.
<C:\Program Files\keyence\MarkingBuilderPlus_
Ver*\etc\ Profinet\[model name]>
(* is the version of Marking Builder Plus.)
• When the GSDML file has been installed, this setup
procedure is not required. Re-installation generates
an error without loading the file.
Set the IP address, subnet mask, and PROFINET device name.

5
Use the settings below here as an example.
Create the connection with the MD-X2000/2500 (Modify the settings depending on the destination device).
series. PLCs from Siemens
Setting items MD-X2000/2500 series
CPU 1211C DC/DC/DC
Through [Device] - the [Device & networks] screen - [Hard ware
Catalog] - [Filter], open “Other field devices” - “PROFINET IO” - IPaddress 192.168.0.20 192.168.0.30
“Sensors” - “KEYENCE CORPORATION.” - “Keyence Laser Marker,”
and drag and drop “ MD-X2XXX Series.” Subnet mask 255.255.255.0 255.255.255.0

PROFINET device
MD-x2xxx plc_1
name

Shortest possible
8 ms -
Update interval

Drag and drop

Make sure that the display screen has turned to


the [Network view] tab while dropping.

- MD-X2000/2500 Series Communication Interface User’s Manual - 3-15


Connection Procedure for PROFINET

9 Double click the “MD-X2000/2500 series” icon


on the [Device & networks] screen.
11 Choose a tag name for each address as
required.
Create a new tag table from [Project tree] - [CPU unit] - [PLC tags] -

10 The Device overview appears. Then assign


the devices for MD-X and PLC.
[Add new tag table].
Here the tag table is being created with the MD information area
named MDX_Monitor, and the MD specified area named MDX_
Control.
Assign the MD information area device to [I address], and assign
the PLC specified area device to [Q address].

3
Here the device is assigned as an example as shown below.
PROFINET

Module Address

Machine Status I address 200 - 203 Double click

Function Status I address 204 - 207

Completion Status I address 208 - 215

Error Status Bits I address 216 - 223 €PLC specified area device tag table
Error Codes I address 224 - 231

Operate Parameter I address 232 - 247

Marking Check/2D Code Read Result I address 248 - 255

Count Result Data I address 256 - 259

Response Data I address 260 - 391

General Request Q address 200 - 207

Function Request Q address 208 - 211

Request Completion Clear Q address 212 - 219

Request No Q address 220 - 223

Request Parameters for strings Q address 224 - 353

€MD information area device tag table

Edit the name of the new tag table and edit the list inside tag table.
Set a function name in [Name], and set the address which has
been assigned in [Device overview] beforehand in relation to that
function in [Address]. Here set the items below based on the device
map.

3-16 - MD-X2000/2500 Series Communication Interface User’s Manual -


Connection Procedure for PROFINET

z MDX_Monitor Name Address Module


Start Marking Request Error %I216.0
Guide Laser Request Error %I216.1
Stop Marking Request Error %I216.2
Error Clear Request Error %I216.3
2DC Read Request Error %I216.4
Job Edit Error %I217.0
Name Address Module Job Change Request Error %I218.0
Ready Status %I200.0 Rank Change Request Error %I218.1
Error Status %I200.1 Counter No Change Request Error %I218.2 Error Status
Warning Status %I200.2 Counter Value Change Request Error %I218.3 Bits

Error Warning Status %I200.3 Counter Up Request Error %I218.4


Shutter Status %I200.4 Counter Down Request Error %I218.5
Network Status
Job Change Ready Status
%I200.5
%I200.6
Counter Reset Request Error
System Info ID Change Error
%I218.6
%I218.7 3
Distance Laser Ready Status %I200.7 Setting String Read Request Error %I220.0

PROFINET
Laser Emitted Status %I201.0 Marked String Read Request Error %I220.1
Machine
Shutter Control Status %I201.1 String Change Request Error %I220.2
Status
Remote Interlock Status %I201.2 Command Send Request Error %I223.0
Safety Shutter Status %I201.3 Error Code 1 %IW224
Busy Status %I202.0 Error Code 2 %IW226 Error Codes
Marking Busy Status %I202.1 Command Send Error Status %IW228
Guide Laser Busy Status %I202.2 Job No Status %IW232
Job Change Busy Status %I202.3 Counter No Status %IW234
Communication Priority Error Status %I202.4 Counter Value Status %ID236 Operate
Job Edit Busy Status %I202.5 Rank Value Status %IW240 Parameter

Mark Check /2DC Read Busy Status %I202.6 System Info ID %IW242
Trigger Lock Status %I204.0 System Info Value %ID244
Operation Stop Status %I204.1 Marking Check Score / 2DC Read Grade
%IW248 Marking
Status Check/2D
Laser Control Status %I204.2
Marking Check/2DC Read Total Count Code Read
Date Hold Status %I204.3 %IW250 Result
Status
Internal Lighting Status %I204.4
Count Result
Total Marking Count Status %ID256
Distance Laser Stop Status %I204.5 Data
Date Attach Status %I205.0 Response Data Size %IW260 Response
Function
Status Response Data %IB262 Data
Counter End1 Status %I205.1
Counter End2 Status %I205.2
Counter End3 Status %I205.3
Counter End4 Status %I205.4
Mark Check/2DC Read OK Status %I205.5
Mark Check/2DC Read NG Status %I205.6
Marking Complete 1 %I205.7
Marking Complete 2 %I208.0
Guide Laser Complete %I208.1
Laser Stop Complete %I208.2
Error Clear Complete %I208.3
2DC Read Complete %I208.4
Job Edit Complete %I209.0
Job Change Complete %I210.0
Rank Change Complete %I210.1
Counter No Complete %I210.2 Completion
Counter Value Complete %I210.3 Status

Counter Up Complete %I210.4


Counter Down Complete %I210.5
Counter Reset Complete %I210.6
System Info ID Change Complete %I211.0
Setting String Read Complete %I212.0
Marked String Read Complete %I212.1
String Change Complete %I212.2
Command Send Complete %I215.0

- MD-X2000/2500 Series Communication Interface User’s Manual - 3-17


Connection Procedure for PROFINET

z MDX_Control 12 Select [Save] from the [Project] tab and store


the settings.

13 Select [Download to device] from the [Online]


tab and send the settings to the PLC.

Name Address Module


14 Turn the CPU mode switch to RUN.
The RUN LED (green) of the CPU turns on after the connection is
Start Marking Request %Q200.0 established.

Guide Laser Request %Q200.1. IF THE RUN LED DOES NOT TURN ON
• The PROFINET settings may be incorrect; the
Stop Marking Request %Q200.2 cables connection may be incorrect; or the laser
Error Clear Request %Q200.3 marker may have not started up.
• Once the communication is disconnected, the RUN
2DC Read Request %Q200.4

3
LED turns off. In this case, use the mode switch of
Job Edit Start Request %Q201.0 the CPU to execute the MRES and switch to the
RUN mode.
Job Change Request %Q202.0
Rank Change Request %Q202.1
PROFINET

Counter No Change Request %Q202.2 General


Counter Value Change Request %Q202.3 Request

Counter Up Request %Q202.4


Counter Down Request %Q202.5
Counter Reset Request %Q202.6
System Info ID Change Request %Q203.0
Setting String Read Request %Q205.0
Marked String Read Request %Q205.1
String Change Request %Q205.2
Command Send Request %Q207.0
Trigger Lock Request %Q208.0
Operation Stop Request %Q208.1
Laser Stop Request %Q208.2 Function
Date Hold Request %Q208.3 Request

Internal Lighting Request %Q208.4


Distance Laser Stop Request %Q208.5
Marking Complete Bit Clear %Q212.0
Guide Laser Complete Bit Clear %Q212.1
Laser Stop Complete Bit Clear %Q212.2
Error Clear Complete Bit Clear %Q212.3
2DC Read Complete Bit Clear %Q212.4
Job Edit Complete Bit Clear %Q213.0
Job Change Complete Bit Clear %Q214.0
Rank Change Complete Bit Clear %Q214.1
Counter No Change Complete Bit Clear %Q214.2 Request
Counter Value Change Complete Bit Completion
%Q214.3 Clear
Clear
Counter Up Complete Bit Clear %Q214.4
Counter Down Complete Bit Clear %Q214.5
Counter Reset Complete Bit Clear %Q214.6
System Info ID Change Complete Clear %Q215.0
Setting String Read Complete Bit Clear %Q216.0
Marked String Read Complete Bit Clear %Q216.1
String Change Complete Bit Clear %Q216.2
Command Send Complete Bit Clear %Q219.0
Request No %QD220 Request No
Request Data Size %QW224 Request
Parameters
Request Data %QB226 for strings

If the name for each device via tag table is determined, the
device names are displayed when creating or executing
the job.

3-18 - MD-X2000/2500 Series Communication Interface User’s Manual -


Connection Procedure for PROFINET

Controlling the Laser Marker Controller

This part describes the procedure to control the laser marker through the PLC by the PROFINET communication.

Switching and Marking the Job No. of the Laser Marker


Ready
z Referential ladder diagram
The following is a referential job for switching and marking the job No.
Programming for practical operations needs to consider additional
Request Parameter functions such as error processing.
PLCs from Siemens
Job Change Request
(1)

Job Change Complete

Start Marking Request


3
(1) (2) (3)

PROFINET
(2)
(1) Require switching of the job.
Store the job No. to be set in [Request No] and turn the [Job
Change Request] bit into “1.”
(2) Check that the job change has been completed.
The “Job Change Request Complete” bit turns to “1.”
(3) Enter a trigger.
• While changing the job No., the “Ready Status” bit is “0”
and the “Busy Status” bit is “0.”
• If the job No. switching fails, the “Job Change Request (3)
Error” bit is “1.”
• The “Job Change Complete” bit is cleared by turning the
“Job Change Complete Bit Clear” bit into “1” or start of
the next operation. Before that, the bit remains “1.”
• Each bit remains “1” until the completion bit or the next
operation starts.

(4)

(1) Turn on “Start1” and store “1” in “ Request Parameter “


(2) Turn “Job Change Request” bit into “1.”
If “Job Change Request Complete” turns on, “Job Change Request”
turns off.
(3) Confirm the job change has been completed and turn
the “Start Marking Request” bit into “1.”
If “Job Change Complete” turns on, “Start Marking Request” turns
on. If “Marking Complete 2” turns on, “Start Marking Request” turns
off.
(4) Turn each “Complete Clear” bit into “1.”

- MD-X2000/2500 Series Communication Interface User’s Manual - 3-19


Connection Procedure for PROFINET

Use the command communication to change and mark the job No.
Ready
z Referential ladder diagram
The following is a referential job for switching and marking the job No.
using the command communication.
Request Data Size Programming for practical operations needs to consider additional
functions such as error processing.
PLCs from Siemens
Request Data

(1)
Command Send Request

Command Send Complete

Start Marking Request (2)

3
(1) (2) (3)

(1) Require sending of commands


Store the data contents to be sent in “Request Data” and the
data size in “Request Data Size,” and turn the “Command Send
PROFINET

Request” bit into “1.”


(2) Check that the command send has been completed. (3)
The “Command Send Complete” bit turns to “1.”
(3) Enter a trigger.
• After the command communication and change of the
job No., the “Ready Status” bit turns to “0” and the “Busy
Status “ bit turns to “1.”
• If sending of the command failed, the “Command Send
Request Error” bit turns to “1.” (4)
• The “Command Send Complete” bit is cleared by turning
the “ Command Send Complete Bit Clear “ bit into “1” or
start of the next operation. Before that, the bit remains (1) Turn on “Start2,” store “4” in “Data Size” and “GA,1”
“1.” in “Data.”
• Each bit remains “1” until the completion bit or the next
operation starts. (2) Turn “Command Send Request” bit into “1.”
• The data length of the response to “ Command Send If “Command Send Complete” turns on, “Command Send Request”
Request” is stored in “Response Data Size” and its turns off.
contents in “Response Data.” (3) Check that the command processing has been
completed and turn the “Start Marking Request” bit
into “1.”
If “Command Send Complete” turns on, “Start Marking Request”
turns on. If “Marking Complete 2” turns on, “Start Marking Request”
turns off.
(4) Turn each “Complete Clear” bit into “1.”

3-20 - MD-X2000/2500 Series Communication Interface User’s Manual -


Connection Procedure for PROFINET

Reading the Marked 2D Code and Acquiring the Assessment Result


Ready
z Referential ladder diagram
The following is a referential program for reading the marked 2D code
and acquiring the assessment result.
Start Marking Request Programming for practical operations needs to consider additional
functions such as error processing.
PLCs from Siemens
Marking Complete 2

2DC Read Request


(1)

2DC Read Complete

2DC Read Grade Status

3
(1) (2) (3) (4) (5)

(1) Mark the 2D code.


(2)
Turn “Start Marking Request” bit into “1.”
(2) Confirm that marking has been completed.

PROFINET
The “Marking Complete 2” bit turns to “1.”
(3) Read the 2D code.
Turn the “2DC Read Request” bit into “1.”
(4) Confirm the 2D code reading has been completed.
The “2DC Read Complete” bit turns to “1.”
(3)
(5) Load the assessment result of the 2D code.
At the same time as loading of the 2D code is completed, the result
is stored in “2DC Read Grade Status.”

• The 2D code can be read not only by directing “2DC


Read Request” through the PROFINET communication,
but also by the Marking Builder Plus after marking.
“Marking Builder Plus User's Manual 2D Code Reader”
• The “Ready Status” bit is “0” while reading the 2D code.
Also, the “Busy Status” bit is “1.” (4)
• If reading of the 2D code failed, the “2DC Read Request
Error” bit turns to “1.”
• The “2DC Read Complete” bit is cleared by turning the (1) Turn on “Start3” and mark the current job.
“2DC Read Complete Bit Clear” bit into “1” or start of the
next operation. Before that, the bit remains “1.” (2) Confirm that the marking has been completed and turn
• Each bit remains “1” until the completion bit or the next the “2DC Read Request” bit into “1.”
operation starts. If “Marking Complete 2” turns on, “2DC Read Request” turns off.
If “2DC Read Complete” turns on, “2DC Read Request” turns off.
(3) Confirm the completion of the 2d code read, and store
the assessment result of the “2DC Read Grade Status”
in arbitrary memory.
If “2DC Read Complete” turns on, the assessment of “2DC Read
Grade Status” is copied to the %MB100.
(4) Turn each “Complete Clear” bit into “1.”

- MD-X2000/2500 Series Communication Interface User’s Manual - 3-21


Execute Ladder Program

Execute Ladder Program


Download the created ladder program Confirm/monitor the state of laser
on the PLC. marker

1 Select “Online” - “Download to device” on the


menu bar.
1 Select “Online” - “Go online” on the menu bar.

2 After it has gone online, select “MDX_Monitor”

3 from “PLC tags”.

Select “PG/PC interface” and “Connection to subnet” based on


PROFINET

the communication environment settings, and press Load to start


download.

2 Turn the CPU mode switch to “RUN.”


3 Press the monitor button
The RUN LED (green) of the CPU turns on after the connection is The bit state of the current address is displayed in “Monitor value”.
established. In the following, the bit of Ready (%I200.0), StartUp (%I200.5) and
Laser Emit (%201.0) is “1”, and is Marking Ready state.
IF THE RUN LED DOES NOT TURN ON
• The PROFINET settings may be incorrect; the
cables connection may be incorrect; or the laser
marker may have not started up.
• Once the communication is disconnected, the RUN
LED turns off. In this case, use the mode switch of
the CPU to execute the MRES and switch to the
RUN mode.

3-22 - MD-X2000/2500 Series Communication Interface User’s Manual -


Execute Ladder Program

Execute ladder program 4 Turn the “Start3” bit into “1.”


The marking and reading are started.
Right click the contact point A of “Start3”, and select

1
“Modify”→”Modify to 1” to change the bit to “1”.
Select “Online” - “Go online” on the menu
Right click
bar.

2 After it has gone online, select the created


ladder program from “Job blocks.”

3
“Main” program is switched to in the following.

PROFINET
5 Confirm the judgement result.
Judgment result is stored to “%MB100”.
“4” is stored in the following, therefore, the grade becomes A.

6 After turning the “Start3” bit into “0,” turn the

3 Press the monitor button


“Clear3” bit into “1.”
The bits of Print Complete and Code Read Complete become “0”.
The ladder display is linked with the bit.
IF THE ERROR LED DOES NOT GO OFF
The PROFINET communication with Laser Marker
may have not been established. Confirm the
communication settings of PLC and laser marker, then
restart the laser marker.

- MD-X2000/2500 Series Communication Interface User’s Manual - 3-23


Execute Ladder Program

MEMO

3
PROFINET

3-24 - MD-X2000/2500 Series Communication Interface User’s Manual -


4
OPC UA

Getting Started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2


4
What is OPC UA? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2

OPC UA
Security precautions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
OPC UA Server Function . . . . . . . . . . . . . . . . . . . . . 4-3
OPC UA communication specifications and functions. . 4-3
System configuration example . . . . . . . . . . . . . . . . . . . . . 4-3
How to configure the laser marker . . . . . . . . . . . . . . . . . . 4-4
Certificate registration. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Node structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Node functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
Alarms & conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26
Control examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
Communication history . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-1


Getting Started

Getting Started
What is OPC UA? Security precautions
The MD-X2000/2500 Series is equipped with an OPC UA server
function. z Do not use OPC UA if security vulnerabilities exist.
OPC UA is an industrial network communication protocol. It is a • To limit access to the OPC UA settings, enable the user management
service-oriented architecture that is not dependent on platform and that function on the laser marker and set an appropriate user level.
integrates into an extensible framework all the functionality of the OPC • Use OPC UA with its security functions, such as encryption and
Classic specifications. signatures, enabled. By default, the security policy [None] is also
It provides excellent inter-device interconnectivity and can connect enabled to allow for an easier initial connection. When operating
various layers from field devices to cloud-based servers. with the security function enabled, disable [None]. Because it has a
Its safety and high reliability have led to it being used in more and more security level lower than SHA2, only use SHA1 when necessary.
industrial devices as time goes on.
• Formulate and make use of a policy for managing user names and
passwords.
• Appropriately perform management such as updating, revoking, and
deleting certificates. When trusting a certificate, thoroughly check
its information to check whether the correct certificate has been
registered.
• Manage private keys so they are not disclosed.

4
• Do not use applications and user certificates for multiple purposes.
• Apply all software updates that patch vulnerabilities.

z Design and maintain a network configuration that


ensures security.
OPC UA

• Manage the network in a way that makes data interception and DoS
attacks difficult.
• If there is the risk of illegal access from external devices over the
network, users must implement countermeasures.

4-2 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function

OPC UA Server Function


OPC UA communication specifications and functions

„ Laser marker OPC UA server function specifications


Item Description

Connection port used Ethernet (MAIN, SUB)

Supported function OPC UA server function

Transport/Data encoding method UA TCP binary

URL (endpoint URL) specification method opc.tcp://[IP address]:[port no.] Example) opc.tcp://192.168.0.10:4840

Max. session (client) count 4

Monitor item count * 1 500

Supported sampling cycle 100 ms min.* 2

OPC UA security modes and policies


• Requires signatures and encryption: SingAndEncrypt
• Requires signatures: Sign
• Requires neither signatures nor encryption: None
4

OPC UA
Basic128Rsa15 / Basic256 / Basic256Sha256 / Aes128Sha256RsaOaep /
Signature and encryption algorithms
Aes256Sha256RsaPss

Certificate authoriza- • Authorization by trusted certificate


Application authorization
tion methods • Authorization by CA-signed certificate

User authorization • User name and password • Authorization by trusted certificate


User authorization
methods • Anonymous • Authorization by CA-signed certificate

Applicable certificate standard Conforms to X.509

*1 The monitor item count is the number of elements to set as the targets to communicate with on the OPC UA client in a cyclic manner.
*2 Set the sampling cycle with the OPC UA client.

„ Laser marker OPC UA server function overview


• Transferring files
Jobs, logos, fonts, and other such files can be transferred.
• Checking the laser marker status and operation status
The status of items such as the terminal block and errors can be acquired.
• Monitoring maintenance information
Information such as the operating time, laser power, lens inspection result, and temperature can be monitored.
• Acquiring the workflow result
Items such as the camera image, 2D code reading result, and correction result from the tracking function can be acquired.
• Laser marker operation according to application
It is possible to control the laser marker in an equivalent manner to control over industrial Ethernet with examples including switching between jobs
and changing character strings or counter values.

System configuration example


Communication with the control system and the PLC or other such control device is carried out over communication route 1. Via the OPC UA protocol,
operation information is acquired from and files are transferred to and received from an MES or similar device over communication route 2.
Control device
(PLC)

OPC UA server
(laser marker) Communication route 1
LAN1 (MAIN)
TCP/IP, EtherNet/IP, Profinet

OPC UA client
(MES, etc.)
Communication route 2
LAN2 (SUB)
OPC UA protocol

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-3


OPC UA Server Function

How to configure the laser marker


„ Procedure example 1 for initial connection to
OPC UA client (when the client certificate is
Use Marking Builder Plus to configure the laser marker. self-signed)
To use the OPC UA server function, you have to fix the IP address. In this procedure example, the client connects to the OPC UA server,
If the IP address has not been set, do so before configuring any other the rejected client certificate is trusted, and then the connection is
OPC UA server settings. established.

„ Enabling the OPC UA server function


1 Generate a server certificate.

1 Select [Controller] from the [Settings] tab, and


then [Communication Settings].
Select [Server Certificate], and then [Generation of Certificate].

2 Set the OPC UA server to [Enable].

4
OPC UA

Enter the certificate information, and then click [OK].

3 Set the port number, time zone, and


communication history operation.
Configure the settings to match the usage environment. The initial
port number is 4840.

If the certificate is successfully generated, the server certificate


information will be displayed.

• Marking Builder Plus Ver. 1 does not support


the OPC UA function, so if this software is used
2 Try connecting from the client.
Before connecting, register the laser marker’s server certificate on
to transfer the controller settings, the OPC UA the client. Click [Export] to acquire this certificate.
settings will be initialized. Certificate files, user After registering this certificate, connect to the laser marker’s OPC
names, and passwords will be saved. UA server from the client.
• With the OPC UA server function enabled and
a client connected, communication will be On the first connection, the client certificate is not trusted by the
periodically performed between the client and laser marker, so this connection to the server fails.
server. Depending on the environment, the job However, if the security policy is [None], the connection can be
file deployment time may be longer than when established at this point.
the OPC UA server function is not in use.

4-4 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function

3 Trust the client on the laser marker. „ Procedure example 2 for initial connection to
Select [Client Certificate]. OPC UA client (when the client certificate is
self-signed)
In this procedure example, the client certificate is registered prior to
establishing the connection.

1 Generate a server certificate.


Do this by following the same procedure as in “Procedure example
1 for initial connection to OPC UA client.”

2 Register the client certificate.


Select [Client Certificate].

From [Rejected Client Certificate List], select the client to connect


to, and then select [Move to Trust List].

OPC UA
Select [+] next to [Trusted Client/CA certificates], and then select
the security certificate (*.der) to register.

Once the selected client certificate moves to the [Trusted Client/CA


certificates] list, close this screen.

The certificate appears.

Clients that could not be connected due to the


differences between SHA1 and SHA2 and server
certificates are not displayed as rejected certificates.

4 Connect to the server from the client.


Connect to the laser marker’s OPC UA server from the client again.
If the settings have been configured correctly, the connection will
be established. If the connection fails, the server certificate may not
have been correctly registered on the client.

3 Connect from the client.


Before connecting, register the laser marker’s server certificate on
the client. Click [Export] to acquire this certificate.
After registering this certificate, connect to the laser marker’s OPC
UA server from the client.

If the same client certificate or user certificate


exists in both the trusted certificates and rejected
certificates, connection will be possible.

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-5


OPC UA Server Function

Certificate registration
„ CA certificate registration procedure (when the
client certificate is CA-signed)
In advance, register the laser marker’s server certificate as a trusted
„ CA certificate and certificate revocation list certificate on the client. Alternatively, register the client certificate CA on
the client as necessary.
• CA
CA (Certificate Authority) issues electronic certificates and revokes CA-signed client certificates can be used according to the following patterns.
electronic certificates for which revocation requests have been made This section will explain how to register certificates in patterns 1 and 2.
and for which there is the possibility that their private keys are no In patterns 3 and 4, where a root CA certificate and intermediate CA
longer safe. certificate exist, all CA certificates and CRLs must be registered in the
• CA certificate same manner.
CA electronic certificates. Required when creating, revoking, and
using a certificate authorized by the CA. • Pattern 1
• Certificate revocation list Register as Trusted
The certificate revocation list is expressed as CRL.
The CRL contains the certificates revoked by the CA. You can check
which certificates have been revoked by checking the CRL. Root CA
certificate
The trusted certificate revocation list is prioritized
over the issuer authentication certificate
revocation list.

„ Specifications of usable certificates


4
Client certificate 1 Client certificate 2 Client certificate 3
• Restrictions on application certificates (client and server certificates)
based on the OPC UA standard Connectable Connectable Connectable
Certificate version X.509.v3
OPC UA

Subject CommonName required


• Pattern 2
IP address or domain name, and URI Register as Issuer
Subject alternative name required (with the same contents as
Application URI)
Five required: digitalSignature, Root CA
nonRepudiation, keyEncipherment, certificate
Key usage method
dataEncipherment and Certificate
Signing Register as
Extended key usage method serverAuth and/or clientAuth required Trusted
Authority key identifier Required
If an application certificate that does not conform to these
specifications is imported, the server may fail to start. Client certificate 1 Client certificate 2 Client certificate 3
• Self-signed certificates
Connectable Not connectable Not connectable
The authority key identifier KeyID is the same as the subject key
identifier.
• CA-signed certificates
The authority key identifier KeyID is the same as the subject key • Pattern 3
identifier of the higher-order certificate. Register as Trusted
The CA certificate and CRL must be registered on the server.
• File name extension
Root CA
Certificate extension der certificate
pem * The key must be a PKCS8
Private key extension
format RSA private key.
CRL extension crl * The format must be DER encoded.
Intermediate CA
• File name certificate
The file to import must have a unique file name. If a file with the
same name exists, it will be overwritten on the controller.
The maximum file name length, including extension, is 100
characters. When the file name is expressed in UTF-16, strings that
use surrogate pairs cannot be used. The following characters also
cannot be used.
#%\/:;,.*?" <>| (half-width space) (full-width space) Client certificate 1 Client certificate 2 Client certificate 3

• Signing hash algorithms and key lengths Connectable Connectable Connectable

Signing hash algorithm SHA1


SHA1 • Pattern 4
certificates Number of public key/ 1024 or 2048 Register as Issuer
private key bits
Signing hash algorithm SHA256,SHA384,SHA512
SHA2
Root CA
certificates Number of public key/ 2048, 3072, or 4096
private key bits certificate
• Security policies and signing hash algorithms (client and user
certificates)
Certificate signing hash Intermediate CA
algorithm certificate
SHA1 SHA2
Register as
Basic128Rsa15  -
Security policy

Trusted
Basic256  -
Basic256Sha256 - 
Client certificate 1 Client certificate 2 Client certificate 3
Aes128-Sha256-RsaOaep - 
Connectable Not connectable Not connectable
Aes256-Sha256-RsaPss - 

*When adding to a certificate trusted with Marking Builder Plus,


* Register as Trusted: The certificate is registered as Trusted.
the number of CommonName characters is not limited, but when
* Register as Issuer: The certificate is registered for use in
changing a rejected certificate to a trusted certificate, CommonName
must be 39 characters or less in length. authenticating the issuer (Issuer).

4-6 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function

• Pattern 1 The CRL appears on the screen.

1 Register the CA certificate in the Trusted


folder.
Select [Client Certificate].

Select [+] next to [Trusted Client/CA certificates], and then select


the CA certificate to add. • Pattern 2

1 Register the CA certificate in the Issuer folder.


Select [Client Certificate].
4

OPC UA
Select [Issuer authentication].

The certificate appears.

Select [+] next to [CA certificate], and then select the CA certificate
to add.

2 Register the CRL of the CA certificate.


Select [+] next to [Client Certificate Revocation List], and then
select the CRL of the CA certificate.

The certificate appears.

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-7


OPC UA Server Function

2 Register the CRL of the CA certificate. „ CA certificate registration procedure (when the
Select [+] next to [Client Certificate Revocation List], and then user certificate is CA-signed)
select the CRL of the CA certificate. The certificate registration screen is accessed from [User Certificate].
The rest of the procedure is the same as when registering client
certificates.
For details on the procedure, refer to “CA certificate registration
procedure (when the client certificate is CA-signed).”

The CRL appears on the screen.

„ CA certificate registration procedure (when the


server certificate is CA-signed)
4 In this procedure, a CA-signed certificate is used as the laser marker’s
server certificate.
If a root CA certificate and intermediate CA certificate exist, all CA
certificates and CRLs must be registered in the same manner.
OPC UA

The procedure is the same for SHA1 or SHA2 server certificates.

3 Register the client certificate in the Trusted


folder.
CA-signed server certificates can only be registered according to the
following pattern.
Register as Issuer

Close the issuer authentication screen to return to the client


certificate screen. Root CA
Select [+] next to [Trusted Client/CA certificates], and then select certificate
the client certificate to add.

Server certificate

Import and use the certificate


as a server certificate.

1 Register the CA certificate.


Select [Server Certificate].

The certificate appears.

Select [Issuer authentication].

4-8 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function
Select [+] next to [CA certificate], and then select the CA certificate Select [Ref.], and then select the certificate file (*.der) and private
to add. key file (*.pem).
Enter the passphrase of the server certificate.

When importing is finished, the server certificate information is


updated.
The certificate appears.

4
2

OPC UA
Register the CRL of the CA certificate.
Select [+] next to [Client Certificate Revocation List], and then Because the certificate is CA-signed, the Issued to
select the CRL. and Issued by fields differ.

The CRL appears on the screen.

3 Import the server certificate.


Close the issuer authentication screen to return to the server
certificate screen.
Select [Import] for the certificate to use: SHA2 or SHA1.

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-9


OPC UA Server Function

Node structure
The MD-X2000 Series node structure is as follows.
Node (Object) structure
Root
└──── Objects
└──── LaserMarker
├──── MachineStatus
│ ├──────── ReadyStatus
│ ├──────── ErrorStatus
│ ├──────── WarningStatus
│ ├──────── IOErrorStatus
│ ├──────── ErrorCode
│ ├──────── ShutterStatus
│ ├──────── NetworkStatus
│ ├──────── JobChangeReadyStatus
│ ├──────── DistanceLaserOperationReadyStatus
│ ├──────── MarkingLaserExcitedStatus
│ ├──────── ShutterControlStatus
│ ├──────── RemoteInterlockStatus
│ ├──────── LaserSafetyModuleStatus
│ ├──────── DataLoggingTriggerStatus
│ ├──────── ExternalLightControlStatus
│ ├──────── BusyStatus
│ ├──────── MarkingBusyStatus
│ ├──────── GuideLaserBusyStatus
│ ├──────── JobChangeBusyStatus
│ ├──────── CommunicationPriorityBusyStatus

4
│ ├──────── JobEditBusyStatus
│ ├──────── MarkingConfirmationBusyStatus
│ ├──────── 2DCodeReadBusyStatus
│ ├──────── WindowCheckBusyStatus
│ ├──────── TriggerLockStatus
│ ├──────── OperationDisableStatus
OPC UA

│ ├──────── LaserControlStatus
│ ├──────── DateHoldInputStatus
│ ├──────── BuiltInLightStatus
│ ├──────── DistanceLaserStopStatus
│ ├──────── DateHoldOutputStatus
│ ├──────── CounterCompletionStatus
│ ├──────── CurrentJobNo
│ └──────── IOEncodedCharacter
├──── OperationResult
│ ├──────── MarkingCompleteStatus
│ ├──────── TotalMarkingCount
│ ├──────── MarkingConfirmationResult
│ ├──────── MarkingConfirmationScore
│ ├──────── MarkingConfirmationTotalOperationCount
│ ├──────── 2DCodeReadResult
│ ├──────── 2DCodeReadGrade
│ ├──────── 2DCodeReadTotalOperationCount
│ └──────── WindowCheckScore
│ ├──────── WorkflowResult
│ ├──────── WorkflowTime
│ ├──────── CameraImageBeforeMarkingResult
│ ├──────── WindowCheckBeforeMarkingResult
│ ├──────── WindowCheckBeforeMarkingScore
│ ├──────── WindowCheckBeforeMarkingScoreDetail
│ ├──────── WindowCheckBeforeMarkingTime
│ ├──────── XYTrackingResult
│ ├──────── ZTrackingResult
│ ├──────── MarkingResult
│ ├──────── MarkingTime
│ ├──────── CameraImageAfterMarkingResult
│ ├──────── MarkingConfirmationTime
│ ├──────── 2DCodeReadString
│ ├──────── WindowCheckAfterMarkingResult
│ ├──────── WindowCheckAfterMarkingScore
│ ├──────── WindowCheckAfterMarkingScoreDetail
│ ├──────── WindowCheckAfterMarkingTime
│ ├──────── MarkingEnergyResult
│ ├──────── MarkingEnergy
│ ───────── MatrixCellInformation
├──── IOFunction
│ ├──────── TriggerLockRequest
│ ├──────── OperationDisableRequest
│ ├──────── LaserStopRequest
│ ├──────── DateHoldRequest
│ ├──────── BuiltInLightRequest
│ └──────── DistanceLaserStopRequest
├──── MachineInformation
│ ├──────── ControllerOperatingTime
│ ├──────── LaserExcitedTime
│ ├──────── ScannerOperatingTime
│ ├──────── ShutterOperationCount
│ ├──────── LaserSafetyModuleOperationCount
│ ├──────── HeadTemperature
│ ├──────── ControllerTemperature
│ ├──────── LaserPowerCalibrationResult
│ ├──────── VersionInformation
│ ├──────── LaserMarkerID
├──────── LaserMarkerModel
│ └──────── SerialNumber
├──── MarkingOperation
│ ├──────── StartMarking
│ ├──────── StartGuideLaser
│ ├──────── StopMarking
│ ├──────── Read2DCodePosition
│ ├──────── Read2DCodeBlock
│ ├──────── GetXYTrackingResult
│ ├──────── GetZTrackingResult
│ └──────── GetMarkedString
│ ├──────── GetZTrackingMatrixCellResult
│ ├──────── GetZTrackingMatrixCellNoResult
│ ├──────── GetCameraImage
│ ├──────── StartMarkingResult
│ ├──────── StartGuideLaserMarkingResult
│ ├──────── StopMarkingResult
│ ───────── Read2DCodeResult
├──── JobOperation
│ ├──────── StartJobEdit
│ ├──────── EndJobEdit

4-10 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function
│ ├──────── SetCurrentJobNo
│ ├──────── SetIOEncodedCharacter
│ ├──────── GetCurrentCounterValue
│ ├──────── SetCurrentCounterValue
│ ├──────── UpCurrentCounterValue
│ ├──────── DownCurrentCounterValue
│ ├──────── ResetCurrentCounterValue
│ ├──────── GetCurrentCounterRepetition
│ ├──────── SetCurrentCounterRepetition
│ ├──────── GetSettingString
│ └──────── SetSettingString
│ ├──────── EndJobEditResult
│ ───────── SetCurrentJobNoResult
├──── GeneralOperation
│ ├──────── ClearError
│ ├──────── StartWindowCheck
│ ├──────── CommandSendRequest
│ ├──────── ClearErrorResult
│ ───────── StartWindowCheckResult
└──── FileOperation
├──────── JobFiles
├──────── LogoFiles
├──────── CustomCharacterFiles
├──────── Z-mapFiles
├──────── FontFiles
├──────── BackupFiles
├──────── MLogFiles
├──────── SaveJobFile
├──────── LoadJobFile
├──────── BackupAllSetting
├──────── RestoreAllSetting

4
└──────── InitializeAllSetting
└──────── SaveMLogFile
├──────── SaveJobFileResult
├──────── LoadJobFileResult
├──────── BackupAllSettingResult
├──────── RestoreAllSettingResult

OPC UA
├──────── InitializeAllSettingResult
───────── SaveMLogFileResult
• Method and FileType nodes are added to [JobFiles], [LogoFiles], [CustomCharacterFiles], [Z-MapFiles], [FontFiles], [BackupFiles], and [MlogFiles]
under [FileOperation]. Size, Writable, UserWritable, and OpenCount nodes are added to each FileType node.
• The number of nodes varies dynamically according to the saved data contents. Files with non-targeted extensions cannot be created (with CreateFile
Method).*4
• NodeID is in String format and is referenced from the LaserMarker node via a slash (“/”). For example, “LaserMarker/FileOperation/JobFiles/AAA.ma2”
references the job file AAA.ma2. Furthermore, “LaserMarker/FileOperation/JobFiles/AAA.ma2/Size” references this file’s Size property.

The [FileOperation] node structure is as follows.


FileOperation[FileOperationType]
└──── JobFiles[FileDirectoryType] *2
│ └──── CreateDirectory[Method]
│ └──── CreateFile[Method]
│ └──── Delete[Method]
│ └──── MoveOrCopy[Method]
│ └──── AAA.ma2[FileType]
│ │ └──── Size[Variable]
│ │ └──── Writable[Variable]
│ │ └──── UserWritable[Variable]
│ │ └──── OpenCount[Variable]
│ │ └──── Open[Method]
│ │ └──── Close[Method]
│ │ └──── Read
│ │ └──── Write
│ │ └──── GetPosition[Method]
│ │ └──── SetPosition[Method]
│ └──── BBB.ma2[FileType]
│ │ └────・・・・
│ └──── ・・・・

└──── LogoFiles[FileDirectoryType]
│ └──── CreateDirectory[Method]
│ └──── CreateFile[Method]
│ └──── Delete[Method]
│ └──── MoveOrCopy[Method]
│ └──── CCC.mlg[FileType]
│ │ └────・・・・
│ └──── DDD.mhl[FileType]
│ │ └────・・・・
│ └──── EEE.mwi[FileType]
│ │ └────・・・・
│ └──── ・・・・

└──── CustomCharacterFiles[FileDirectoryType]
│ └──── CreateFile[Method]
│ └──── Delete[Method]
│ └──── MoveOrCopy[Method] *1
│ └──── FFF.mft[FileType]
│ │ └────・・・・
│ └──── ・・・・

└──── Z-mapFiles[FileDirectoryType]
│ └──── CreateFile[Method]
│ └──── Delete[Method]
│ └──── MoveOrCopy[Method] *1
│ └──── GGG.zmp[FileType]
│ │ └────・・・・
│ └──── ・・・・

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-11


OPC UA Server Function

└──── FontFiles[FileDirectoryType]
│ └──── CreateFile[Method]
│ └──── Delete[Method]
│ └──── MoveOrCopy[Method] *1
│ └──── HHH.fuy[FileType]
│ │ └────・・・・
│ └──── ・・・・

└──── BackupFiles[FileDirectoryType] *2
│ └──── CreateFile[Method]
│ └──── Delete[Method]
│ └──── MoveOrCopy[Method] *1
│ └──── JJJ.mab2[FileType]
│ │ └────・・・・
│ └──── ・・・・

└──── MLogFiles[FileDirectoryType] *2
│ └──── Delete[Method]
│ └──── MoveOrCopy[Method] *1
│ └──── KKK.mlog[FileType] *3
│ │ └────・・・・
│ └──── ・・・・

└──── SaveJobFile[Method]
└──── LoadJobFile[Method]

4 └──── BackupAllSetting[Method]
└──── RestoreAllSetting[Method]
└──── InitializeAllSetting[Method]
└──── SaveMLogFile[Method]
OPC UA

└──── SaveJobFileResult
└──── LoadJobFileResult
└──── BackupAllSettingResult
└──── RestoreAllSettingResult
└──── InitializeAllSettingResult
└──── SaveMLogFileResult

*1 Moving and copying are only possible within the directory.


*2 Marking Builder Plus cannot be used to delete the data of the job, backup, and log files within this directory. This data can only be deleted via OPC
UA communication.
*3 There is a limit on the log file capacity that can be acquired via OPC UA communication, which is not the case when acquiring log files with Marking
Builder Plus. Reduce the log data capacity by adjusting the log data acquisition period.
*4 The extensions of the files that can be created with the CreateFile Method are as follows. CreateFile can create up to 3500 files.
File type Corresponding FileDirectoryType node Extension
Logo LogoFiles *.mlg
*.mhl
*.mwi
Photo LogoFiles *.mzu
*.mzm
*.mzx
Custom
CustomCharacterFiles *.mft
character
Font FontFiles *.fuy
Z-MAP Z-mapFiles *.zmp
Job JobFiles *.ma1
*.ma2
Backup BackupFiles *.mab1
*.mab2
Log MLogFiles *.mlog

4-12 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function

Node functions

„ Objects
Name Node
Affiliated object Item Overview Supplemental explanation
Space ID

2 15001 Root - Object LaserMarker Laser marker object (includes the following objects)

Object for acquiring the device status such as


2 15002 LaserMarker MachineStatus
trigger ready

Object for acquiring the results of processes such


2 15003 LaserMarker OperationResult
as marking or 2D code reading

Object for requesting control or acquiring the status,


2 15004 LaserMarker IOFunction
such as for the trigger lock

Object for acquiring device information such as the


2 15005 LaserMarker MachineInformation
operating time and version information

2 15006 LaserMarker MarkingOperation Object for controlling marking such as by starting it

2 15007 LaserMarker JobOperation


Object for job control such as switching settings and
changing character strings

Object for clearing errors and performing other


4
2 15008 LaserMarker GeneralOperation
control

OPC UA
Object for controlling files such as by transferring
2 15009 LaserMarker FileOperation
them

2 15010 FileOperation JobFiles Directory housing the Job files

2 15011 FileOperation LogoFiles Directory housing the logo files

2 15012 FileOperation CustomCharacterFiles Directory housing the custom character files

2 15013 FileOperation Z-mapFiles Directory housing the Z-map files

2 15014 FileOperation FontFiles Directory housing the font files

2 15015 FileOperation BackupFiles Directory housing the backup files

2 15016 FileOperation MLogFiles Directory housing the MLOG files

This object is added directly under


See the objects of node IDs 15010 to
2 supplemental (File name) File object directly under each FileDirectory object 15016. The node ID is in String
explanation format and is referenced from the
LaserMarker node via a slash (“/”).

„ Variable
Name Node Read/ Supplemental
Affiliated object Item Type Overview
Space ID Write explanation/value range

2 16001 MachineStatus ReadyStatus Boolean(True / False) Read Trigger ready status

2 16002 MachineStatus ErrorStatus Boolean Read Error status

2 16003 MachineStatus WarningStatus Boolean Read Warning status

Terminal block error


2 16004 MachineStatus IOErrorStatus Boolean Read
status

Status of the error/


2 16005 MachineStatus ErrorCode String[10](Array) Read warning occurring or of
the terminal block

Shutter open/closed
2 16006 MachineStatus ShutterStatus Boolean Read
status

Network connection
2 16007 MachineStatus NetworkStatus Boolean Read
status

Setting switch ready


2 16008 MachineStatus JobChangeReadyStatus Boolean Read
status

Distance laser operation


2 16063 MachineStatus DistanceLaserOperationReadyStatus Boolean Read
ready status

2 16009 MachineStatus MarkingLaserExcitedStatus Boolean Read Laser excited status

2 16010 MachineStatus ShutterControlStatus Boolean Read Shutter control status

2 16011 MachineStatus RemoteInterlockStatus Boolean Read Remote interlock status

2 16012 MachineStatus LaserSafetyModuleStatus Boolean Read Laser safety input status

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-13


OPC UA Server Function

Name Node Read/ Supplemental


Affiliated object Item Type Overview
Space ID Write explanation/value range

Logging trigger input


2 16013 MachineStatus DataLoggingTriggerStatus Boolean Read
status

External lighting control


2 16014 MachineStatus ExternalLightControlStatus Boolean Read
output status

2 16015 MachineStatus BusyStatus Boolean Read Busy status

Marking in progress
2 16016 MachineStatus MarkingBusyStatus Boolean Read
status

Guide laser marking in


2 16017 MachineStatus GuideLaserBusyStatus Boolean Read
progress status

Setting switch processing


2 16018 MachineStatus JobChangeBusyStatus Boolean Read
status

2 16019 MachineStatus CommunicationPriorityBusyStatus Boolean Read Priority error status

Job editing in progress


2 16020 MachineStatus JobEditBusyStatus Boolean Read
status

4
Marking confirmation in
2 16021 MachineStatus MarkingConfirmationBusyStatus Boolean Read
progress status

2D code reading in
2 16022 MachineStatus 2DCodeReadBusyStatus Boolean Read
progress status
OPC UA

Lens inspection in
2 16023 MachineStatus WindowCheckBusyStatus Boolean Read
progress status

2 16024 MachineStatus TriggerLockStatus Boolean Read Trigger lock input status

Machinery disable input


2 16025 MachineStatus OperationDisableStatus Boolean Read
status

2 16026 MachineStatus LaserControlStatus Boolean Read Laser stop input status

2 16027 MachineStatus DateHoldInputStatus Boolean Read Date hold input status

Built-in lighting control


2 16028 MachineStatus BuiltInLightStatus Boolean Read
input status

Distance laser stop input


2 16029 MachineStatus DistanceLaserStopStatus Boolean Read
status

Date deviation output


2 16030 MachineStatus DateHoldOutputStatus Boolean Read
status

The number of array


elements is four,
Counter completion
2 16031 MachineStatus CounterCompletionStatus Boolean[4] Read corresponding to counter
output status
termination outputs 1 to
4.*1

UInt32
2 16032 MachineStatus CurrentJobNo Read Current job number Value range: 0 to 1999
(Unsigned Integer)

I/O-specified character
2 16034 MachineStatus IOEncodedCharacter UInt32 Read Value range: 0 to 35
acquisition

Marking complete output


2 16035 OperationResult MarkingCompleteStatus Boolean Read *1
status

Cumulative marking count


2 16036 OperationResult TotalMarkingCount UInt32 Read
1

0: no result, 1: success, 2:
Previous marking
2 16037 OperationResult MarkingConfirmationResult UInt32 Read failure, 3: outside of error
confirmation result
thresholds

Score of previous marking


2 16038 OperationResult MarkingConfirmationScore UInt32 Read Value range: 0 to 100
confirmation

Cumulative marking Value range: 0 to


2 16039 OperationResult MarkingConfirmationTotalOperationCount UInt32 Read
confirmation count 4294967295

0: no result, 1: success, 2:
Previous 2D code reading
2 16040 OperationResult 2DCodeReadResult UInt32 Read failure, 3: outside of error
result
thresholds

Previous 2D code reading "-": no result, “A,” “B,” “C,”


2 16041 OperationResult 2DCodeReadGrade String Read
grade “D,” “F”

Cumulative 2D code Value range: 0 to


2 16042 OperationResult 2DCodeReadTotalOperationCount UInt32 Read
reading count 4294967295

Previous lens inspection


2 16044 OperationResult WindowCheckScore UInt32 Read Value range: 0 to 100
result

4-14 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function

Name Node Read/ Supplemental


Affiliated object Item Type Overview
Space ID Write explanation/value range

Previous workflow 0: no result, 1: success, 2:


2 16078 OperationResult WorkflowResult UInt32 Read
execution result failure/canceled

Previous workflow
2 16079 OperationResult WorkflowTime UInt32 Read
execution time (ms)

Previous pre-marking 0: no result, 1: success, 2:


2 16080 OperationResult CameraImageBeforeMarkingResult UInt32 Read
capture result failure

Result of previous 0: no result, 1: success, 2:


2 16081 OperationResult WindowCheckBeforeMarkingResult UInt32 Read pre‑marking lens failure, 3: below warning
inspection threshold

Score of previous
Value range: 0 to 100 (0
2 16082 OperationResult WindowCheckBeforeMarkingScore UInt32 Read pre‑marking lens
when there is no result)
inspection (all)

Scores from point 1 to


Score of previous
point 10. Value range: 0
2 16083 OperationResult WindowCheckBeforeMarkingScoreDetail UInt32[10] Read pre‑marking lens
to 100 (0 when there is no
inspection (individual)
result)

2 16084 OperationResult WindowCheckBeforeMarkingTime UInt32 Read


Execution time of
previous pre-marking lens
inspection (ms)
4

OPC UA
Previous XY tracking
2 16085 OperationResult XYTrackingResult UInt32 Read
result (all)

0: no result, 1: success, 2:
Previous Z tracking result
2 16086 OperationResult ZTrackingResult UInt32 Read failure, 3: outside of error
(all)
thresholds

0: no result, 1: success, 2:
2 16087 OperationResult MarkingResult UInt32 Read Previous marking result
failure

Previous marking
2 16098 OperationResult MarkingTime UInt32 Read
time (ms)

Previous post-marking 0: no result, 1: success, 2:


2 16088 OperationResult CameraImageAfterMarkingResult UInt32 Read
capture result failure

Previous marking
2 16089 OperationResult MarkingConfirmationTime UInt32 Read confirmation execution
time (ms)

Previous 2D code reading


2 16090 OperationResult 2DCodeReadString String Read
contents

Previous result of 0: no result, 1: success, 2:


2 16091 OperationResult WindowCheckAfterMarkingResult UInt32 Read post‑marking lens failure, 3: below warning
inspection threshold

Score of previous
Value range: 0 to 100 (0
2 16092 OperationResult WindowCheckAfterMarkingScore UInt32 Read pre‑marking lens
when there is no result)
inspection (all)

Scores from point 1 to


Score of previous
point 10. Value range: 0
2 16093 OperationResult WindowCheckAfterMarkingScoreDetail UInt32[10] Read pre‑marking lens
to 100 (0 when there is no
inspection (individual)
result)

Execution time of
2 16094 OperationResult WindowCheckAfterMarkingTime UInt32 Read previous pre-marking lens
inspection (ms)

Previous marking energy 0: no result, 1: success, 3:


2 16095 OperationResult MarkingEnergyResult UInt32 Read
check result outside of thresholds

Previous marking energy Value range: 00000.01 to


2 16096 OperationResult MarkingEnergy Double Read
(J) 99999.99

Returns the total number


of cells, number of
marking target cells, and
number of marked cells.
Previous matrix Values are updated when
2 16097 OperationResult MatrixCellInformation UInt32[3] Read information during settings are switched, jobs
marking are deployed, marking
starts, or marking finishes.
Zeros are returned for all
values in the case of non-
matrix settings.

Read/
2 16045 IOFunction TriggerLockRequest Boolean Trigger lock request
Write

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-15


OPC UA Server Function

Name Node Read/ Supplemental


Affiliated object Item Type Overview
Space ID Write explanation/value range

Read/ Machining operation


2 16046 IOFunction OperationDisableRequest Boolean
Write (laser output) stop request

Read/
2 16047 IOFunction LaserStopRequest Boolean Laser stop request
Write

Read/
2 16048 IOFunction DateHoldRequest Boolean Date hold request
Write

Read/ Built-in lighting control


2 16049 IOFunction BuiltInLightRequest Boolean
Write request

Read/ Distance laser stop


2 16050 IOFunction DistanceLaserStopRequest Boolean
Write request

Value range: 0 to
2 16051 MachineInformation ControllerOperatingTime UInt32 Read Controller operating time
4294967295 (unit: H)

Value range: 0 to
2 16052 MachineInformation LaserExcitedTime UInt32 Read Laser operating time
4294967295 (unit: H)

Value range: 0 to

4
2 16053 MachineInformation ScannerOperatingTime UInt32 Read Scanner operating time
4294967295 (unit: H)

Value range: 0 to
2 16054 MachineInformation ShutterOperationCount UInt32 Read Shutter operating count
4294967295
OPC UA

Laser safety module Value range: 0 to


2 16055 MachineInformation LaserSafetyModuleOperationCount UInt32 Read
operation count 4294967295

Value range: −999.9 to


2 16056 MachineInformation HeadTemperature Float Read Marking unit temperature
999.9 (unit: °C)

Value range: −999.9 to


2 16057 MachineInformation ControllerTemperature Float Read Controller temperature
999.9 (unit: °C)

Previous laser power Value range: 0.0 to


2 16058 MachineInformation LaserPowerCalibrationResult Float Read
calibration result 999.99 (unit: W)

2 16059 MachineInformation VersionInformation String[5] Read Version information

Laser marker ID
2 16060 MachineInformation LaserMarkerID String Read
(nickname)

Laser marker model


2 16061 MachineInformation LaserMarkerModel String Read
information

Returns the controller and


2 16062 MachineInformation SerialNumber String[2] Read Serial numbers
head serial numbers.

Read/ Result of marking via


2 16064 MarkingOperation StartMarkingResult OperationMethodResultType *2
Write OPC UA (StartMarking)

Result of guide laser


Read/
2 16065 MarkingOperation StartGuideLaserResult OperationMethodResultType marking via OPC UA *2
Write
(StartGuideLaser)

Result of stopping
Read/
2 16066 MarkingOperation StopMarkingResult OperationMethodResultType marking via OPC UA *2
Write
(StopMarking)

Result of 2D code
Read/ reading via OPC UA
2 16067 MarkingOperation Read2DCodeResult OperationMethodResultType *2
Write (Read2DCodePosition/
Read2DCodeBlock)

Read/ Result of error clearing


2 16068 GeneralOperation ClearErrorResult OperationMethodResultType *2, *3
Write via OPC UA (ClearError)

Result of lens
Read/
2 16069 GeneralOperation StartWindowCheckResult OperationMethodResultType inspection via OPC UA *2
Write
(StartWindowCheck)

Read/ Result of job editing via


2 16070 JobOperation EndJobEditResult OperationMethodResultType *2, *3
Write OPC UA (EndJobEdit)

Result of setting
Read/ the current job
2 16071 JobOperation SetCurrentJobNoResult OperationMethodResultType *2, *3
Write number via OPC UA
(SetCurrentJobNo)

Result of saving the


Read/
2 16072 FileOperation SaveJobFileResult OperationMethodResultType job file via OPC UA *2
Write
(SaveJobFile)

Result of loading the


Read/
2 16073 FileOperation LoadJobFileResult OperationMethodResultType job file via OPC UA *2, *3
Write
(LoadJobFile)

4-16 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function

Name Node Read/ Supplemental


Affiliated object Item Type Overview
Space ID Write explanation/value range

Result of creating the


Read/
2 16074 FileOperation BackupAllSettingResult OperationMethodResultType backup file via OPC UA *2
Write
(BackupAllSetting)

Result of restoring the


Read/
2 16075 FileOperation RestoreAllSettingResult OperationMethodResultType backup file via OPC UA *2
Write
(RestoreAllSetting)

Result of initializing all


Read/
2 16076 FileOperation InitializeAllSettingResult OperationMethodResultType settings via OPC UA *2, *3
Write
(InitializeAllSetting)

Result of saving the


Read/
2 16077 FileOperation SaveMLogFileResult OperationMethodResultType history file via OPC UA *2
Write
(SaveMLogFile)

- - Each FileType node Size UInt64 Read File size

- - Each FileType node Writable Boolean Read Writable or not

Writable by current user


- - Each FileType node UserWritable Boolean Read
or not

Number of corresponding
files opened via OPC UA
communication. Open
4
- - Each FileType node OpenCount UInt16 Read
Method increases this

OPC UA
value and Close Method
decreases it.

*1  epending on the sampling cycle setting, the length of time that MarkingCompleteStatus and CounterCompletionStatus are monitored as ON may be
D
shorter than the ON time of the terminal block. It may not even be possible to monitor these two values switching to ON at all.
*2 When using it for handshaking with the corresponding Method, write 0: None in advance and then call Method.
*3 Result is saved after expansion process completes.

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-17


OPC UA Server Function

„ Method
Return value
Name Node Argument Supplemental
Affiliated object Item <Value.Name> Overview
Space ID <Value.Name>*1 explanation
*2, *3

Method processing
finishes when the
Marking start request
is output. Processing
completion notification is
1. Success/failure
provided via an event. If
<Succeeded>: Boolean Starts
2 17001 MarkingOperation StartMarking None the block to mark does
2. Error code marking
not exist within the job,
<ErrorCode>: String
the S101 error occurs in
the MarkingEnd event.
Related events:
MarkingStart,
MarkingEnd

Method processing
finishes when the
GuideLaser start request
1. Success/failure
is output. Processing
A. Type <Type>: <Succeeded>: Boolean Starts guide

4
2 17002 MarkingOperation StartGuideLaser completion notification is
GuideLaserType 2. Error code laser marking
provided via an event.
<ErrorCode>: String
Related events:
GuideLaserMarkingStart,
GuideLaserMarkingEnd
OPC UA

1. Success/failure
Related events:
<Succeeded>: Boolean Stops
2 17003 MarkingOperation StopMarking None MarkingEnd,
2. Error code marking
GuideLaserMarkingEnd
<ErrorCode>: String

A. X coordinate A, B, C: The setting


<X_Coordinate>: range varies depending
Double on the model.
B. Y coordinate D: 0 to 100
<Y_Coordinate>: 1. Success/failure 2D code The Method finishes
Double <Succeeded>: Boolean reading when 2D code reading
2 17004 MarkingOperation Read2DCodePosition
C. Z coordinate 2. Error code (coordinate starts. Processing
<Z_Coordinate>: <ErrorCode>: String specification) completion notification is
Double provided via an event.
D. Reading range Related events:
<ReadingArea> 2DCodeReadingStart,
(%): UInt32 2DCodeReadingEnd

A: 0 to 255
B: 0 to 100 The Method
A. Block number finishes when 2D
<BlockNo>: 1. Success/failure 2D code code reading starts.
UInt32 <Succeeded>: Boolean reading Processing completion
2 17005 MarkingOperation Read2DCodeBlock
B. Reading range 2. Error code (block notification is provided
<ReadingArea> <ErrorCode>: String specification) via an event.
(%): UInt32 Related events:
2DCodeReadingStart,
2DCodeReadingEnd

1. Success/failure
<Succeeded>: Boolean
2. Error code
<ErrorCode>: String
3. X deviation [mm] <X_
Deviation>: Double
A: 0 to 7
4. Y deviation [mm] <Y_
A. Tracking 6: 0 to 100
Deviation>: Double Acquires the
number 8: Result (0: Failure, 1:
2 17006 MarkingOperation GetXYTrackingResult 5. Angle [°] <Theta_ XY tracking
<TrackingNo>: Success,
Deviation>: Double result
UInt32 2: Success (low match
6. Match level
level))
<Correlation>: UInt32
7. Tact
[ms] <ExecutionTime>:
UInt32
8. Result <Result>:
UInt32

4-18 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function

Return value
Name Node Argument Supplemental
Affiliated object Item <Value.Name> Overview
Space ID <Value.Name>*1 explanation
*2, *3

1. Success/failure
<Succeeded>: Boolean
2. Error code
<ErrorCode>: String
3. Z deviation [mm] <Z_
Deviation>: Double A: 0 to 255
A. Tracking 4. X tilt [°] <X_ 6: 0 to 100
Acquires the
number AngleDeviation>: Double 8: Result (0: Failure, 1:
2 17007 MarkingOperation GetZTrackingResult Z tracking
<TrackingNo>: 5. Y tilt [°] <Y_ Success, 2: Success (low
result
UInt32 AngleDeviation>: Double stability), 3: Success (out
6. Stability <Stability>: of tolerance range))
UInt32
7. Tact
[ms] <ExecutionTime>:
UInt32 8. Result
<Result>: UInt32

1. Success/failure
A. <JobNo>:
<Succeeded>: Boolean
UInt32
2. Error code Acquires the A: 0 to 1999

4
2 17008 MarkingOperation GetMarkedString B. Block number
<ErrorCode>: String marked string B: 0 to 255
<BlockNo>:
3. Marked string
UInt32
<MarkedString>: String

1. Success/failure

OPC UA
<Succeeded>: Boolean
2. Error code
<ErrorCode>: String
3. Z deviation [mm] <Z_
Deviation>: Double Acquires A: 0 to 255
A: Row number 4. X tilt [°] <X_ the matrix B: 0 to 255
<Row>: UInt32 AngleDeviation>: Double cell height 6: 0 to 100
2 17034 MarkingOperation GetZTrackingMatrixCellResult B. Column 5. Y tilt [°] <Y_ correction 8: Result (0: Failure, 1:
number AngleDeviation>: Double result (row Success, 2: Success (low
<Column>: UInt32 6. Stability <Stability>: and column stability), 3: Success (out
UInt32 specified) of tolerance range))
7. Tact
[ms] <ExecutionTime>:
UInt32
8. Result <Result>:
UInt32

1. Success/failure
<Succeeded>: Boolean
2. Error code
<ErrorCode>: String
3. Z deviation [mm] <Z_
Acquires
Deviation>: Double A: 0 to 65025
the matrix
4. X tilt [°] <X_ 6: 0 to 100
cell height
A. Cell number AngleDeviation>: Double 8: Result (0: Failure, 1:
2 17035 MarkingOperation GetZTrackingMatrixCellNoResult correction
<CellNo>: UInt32 5. Y tilt [°] <Y_ Success, 2: Success (low
result (cell
AngleDeviation>: Double stability), 3: Success (out
number
6. Stability <Stability>: of tolerance range))
specified)
UInt32
7. Tact
[ms] <ExecutionTime>:
UInt32 8. Result
<Result>: UInt32

Acquires
camera
A. Image
1. Success/failure images
type <Type>:
<Succeeded>: Boolean (before/after
CameraImageType
2. Error code marking, 2D
2 17023 MarkingOperation GetCameraImage B. Option (XY
<ErrorCode>: String code reading,
tracking number,
3. Jpeg file data marking
etc.) <Option>:
<JpegData>: ImageJPG confirmation,
UInt32
and XY
tracking)

A: 0 to 1999
• If you start editing
with StartJobEdit,
do not change any
setting contents or edit
1. Success/failure
anything other than
A. <JobNo>: <Succeeded>: Boolean Starts setting
2 17009 JobOperation StartJobEdit the job number until
UInt32 2. Error code change
ending editing with
<ErrorCode>: String
EndJobEdit. Doing so
will cause an error in
EndJobEdit, preventing
editing from completing
normally.

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-19


OPC UA Server Function

Return value
Name Node Argument Supplemental
Affiliated object Item <Value.Name> Overview
Space ID <Value.Name>*1 explanation
*2, *3

1. Success/failure
Related events:
<Succeeded>: Boolean Ends setting
2 17010 JobOperation EndJobEdit None ExpansionStart,
2. Error code change
ExpansionEnd
<ErrorCode>: String

A: 0 to 1999
Depending on the
laser marker status, it
may take some time
1. Success/failure
Changes the from the execution of
A. <Succeeded>: Boolean
2 17011 JobOperation SetCurrentJobNo current job SetCurrentJobNo to the
<JobNo>:UInt32 2. Error code
number changing of ReadyStatus
<ErrorCode>: String
to False.
Related events:
ExpansionStart,
ExpansionEnd

1. Success/failure
Changes the
A. <Succeeded>: Boolean
2 17012 JobOperation SetIOEncodedCharacter I/O-specified A: 0 to 35
<EncodedCharacter>:UInt32 2. Error code
character

4
<ErrorCode>: String

1. Success/failure
A. <JobNo>:
<Succeeded>: Boolean
UInt32 Acquires the A: 0 to 1999
2. Error code
2 17013 JobOperation GetCurrentCounterValue B. Counter type current value B: “0” to “9,” “A” to “J”
OPC UA

<ErrorCode>: String
<CounterNo>: of the counter 3: 0 to 4294967295
3. Counter value
String
<CounterValue>: UInt32

A. <JobNo>:
UInt32
B. Counter type 1. Success/failure
Sets the A: 0 to 1999
<CounterNo>: <Succeeded>: Boolean
2 17014 JobOperation SetCurrentCounterValue current value B: “0” to “9,” “A” to “J”
String 2. Error code
of the counter C: 0 to 4294967295
C. Counter value <ErrorCode>: String
<CounterValue>:
UInt32

A. <JobNo>:
1. Success/failure Increases the
UInt32
<Succeeded>: Boolean current value A: 0 to 1999
2 17015 JobOperation UpCurrentCounterValue B. Counter type
2. Error code of the counter B: “0” to “9,” “A” to “J”
<CounterNo>:
<ErrorCode>: String by 1
String

A. <JobNo>:
1. Success/failure Decreases
UInt32
<Succeeded>: Boolean the current A: 0 to 1999
2 17016 JobOperation DownCurrentCounterValue B. Counter type
2. Error code value of the B: “0” to “9,” “A” to “J”
<CounterNo>:
<ErrorCode>: String counter by 1
String

A. <JobNo>:
1. Success/failure
UInt32 Resets the
<Succeeded>: Boolean A: 0 to 1999
2 17017 JobOperation ResetCurrentCounterValue B. Counter type current value
2. Error code B: “0” to “9,” “A” to “J”
<CounterNo>: of the counter
<ErrorCode>: String
String

1. Success/failure
<Succeeded>: Boolean
A. <JobNo>: Acquires
2. Error code
UInt32 the current A: 0 to 1999
<ErrorCode>: String
2 17036 JobOperation GetCurrentCounterRepetition B. Counter type marking B: “0” to “9,” “A” to “J” 3:
3. Current
<CounterNo>: repetition of 0 to 4294967295
marking repetition
String the counter
<RepetitionValue>:
UInt32

A. <JobNo>:
UInt32
B. Counter type Sets the
1. Success/failure
<CounterNo>: current A: 0 to 1999
<Succeeded>: Boolean
2 17037 JobOperation SetCurrentCounterRepetition String marking B: “0” to “9,” “A” to “J”
2. Error code
C. Current repetition of C: 0 to 4294967295
<ErrorCode>: String
marking repetition the counter
<RepetitionValue>:
UInt32

1. Success/failure
A. <JobNo>:
<Succeeded>: Boolean A: 0 to 1999
UInt32
2. Error code Acquires the B. 0 to 255
2 17018 JobOperation GetSettingString B. Block number
<ErrorCode>: String setting string 3: The character code is
<BlockNo>:
3. Setting string UTF-8.
UInt32
<SettingString>: String

4-20 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function

Return value
Name Node Argument Supplemental
Affiliated object Item <Value.Name> Overview
Space ID <Value.Name>*1 explanation
*2, *3

A. <JobNo>:
UInt32 A: 0 to 1999
B. Block number 1. Success/failure B: 0 255 C: The character
<BlockNo>: <Succeeded>: Boolean Updates the code is UTF-8.
2 17019 JobOperation SetSettingString
UInt32 2. Error code setting string Related events:
C. Setting string <ErrorCode>: String ExpansionStart,
<SettingString>: ExpansionEnd
String

Related events:
Clears the
1. Success/failure ExpansionStart,
currently
<Succeeded>: Boolean ExpansionEnd
2 17020 GeneralOperation ClearError None occurring
2. Error code (Deployment processing
errors/
<ErrorCode>: String may occur when errors
warnings
are reset.)

The Method finishes


when lens inspection
1. Success/failure starts. Processing
Starts the lens
<Succeeded>: Boolean completion notification is
2 17021 GeneralOperation StartWindowCheck None inspection

4
2. Error code provided via an event.
(maintenance)
<ErrorCode>: String Related events:
WindowCheckStart,
WindowCheckEnd

OPC UA
Synchronization
processing will be
A. Command Transmits a performed, so pay
1. Return value
2 17022 GeneralOperation CommandSendRequest <Command>: command attention to the timeout
<Response>: String
String string setting. Command
strings can be up to 4096
characters in length.

FileName: If the
extension is not ma2,
error S024 is returned.
A. Job number Method processing
1. Success/failure
<JobNo>: UInt32 finishes when the file
<Succeeded>: Boolean Saves the job
2 17028 FileOperation SaveJobFile B. File name generation request
2. Error code file
<FileName>: is output. Processing
<ErrorCode>: String
String completion notification is
provided via an event.
Related event:
SaveJobFileEnd

Method processing
finishes when the file
A. Job number
1. Success/failure loading request is output.
<JobNo>: UInt32
<Succeeded>: Boolean Loads a job Processing completion
2 17029 FileOperation LoadJobFile B. File name
2. Error code file notification is provided
<FileName>:
<ErrorCode>: String via an event.
String
Related event:
LoadJobFileEnd

FileName: If the
extension is not mab2,
error S024 is returned.
Method processing
1. Success/failure
A. File name finishes when the backup
<Succeeded>: Boolean Creates a
2 17030 FileOperation BackupAllSetting <FileName>: file generation request
2. Error code backup file
String is output. Processing
<ErrorCode>: String
completion notification is
provided via an event.
Related event:
BackupAllSettingEnd

Method processing
finishes when the request
to restore settings from
the backup file is output.
Processing completion
notification is provided
via an event.
A. File name
1. Success/failure Related event:
<FileName>: Restores
<Succeeded>: Boolean RestoreAllSettingEnd
2 17031 FileOperation RestoreAllSetting String settings from
2. Error code B: Use the bits to specify
B. Option a backup file
<ErrorCode>: String the additional targets to
<Option>: UInt32
restore. (ON bits indicate
targets to restore. Bits
are set to 0 by default.)
Bit 0: Ethernet settings
Bit 1: Nickname
Bit 2: User information
Bit 3: OPC UA settings

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-21


OPC UA Server Function

Return value
Name Node Argument Supplemental
Affiliated object Item <Value.Name> Overview
Space ID <Value.Name>*1 explanation
*2, *3

Method processing
finishes when the
initialization request is
1. Success/failure output. Depending on
A. Initialization
<Succeeded>: Boolean Initializes the initialization contents,
2 17032 FileOperation InitializeAllSetting range <Type>:
2. Error code settings processing completion
InitializeSettingType
<ErrorCode>: String notification is provided
via an event.
Related event:
InitializeAllSettingEnd

B,C: Convert the local


time to UTC and enter
this value.
E. FileName: If the
extension is not mlog,
error S024 is returned.
Method processing
finishes when the
save request is output.

4
A. Acquire all Processing completion
remaining data notification is provided
<Entire Period>: via an event.
Boolean Related event:
B. Start time SaveMLogFileEnd
OPC UA

<From>:
DateTime 1. Success/failure • When the controller
C. End time <Succeeded>: Boolean Saves the logging settings are
2 17033 FileOperation SaveMLogFile
<To>: DateTime 2. Error code history file used to set USB memory
D. Do not <ErrorCode>: String as the destination for
acquire images saving the file, data is
<IgnoreImages>: acquired from the USB
Boolean memory. (Data saved to
E. File name USB memory cannot be
<FileName>: acquired as an MLOG file
String in Marking Builder Plus.)
• Saving may fail if the
amount of data to acquire
is large. In this situation,
reduce the amount of
data by configuring
the settings to prevent
acquisition of images or
by shortening the data
acquisition period.

1. Node ID of
A. Directory name
created directory Creates a
2 18001 JobFiles CreateDirectory <DirectoryName>: Not used.*4
<DirectoryNodeId>: directory
String
NodeId

A. File name
(including extension) If the extension is not
1. Node ID of created file
<FileName>: String supported, an error is
<FileNodeId>: NodeId
2 18002 JobFiles CreateFile B. Whether to Creates a file returned. The file handle
2. File handle
open created file is used when calling
<FileHandle>: UInt32
<RequestFileOpen>: FileType node Methods.
Boolean

A. File name
If the file cannot be
(including
deleted, such as because
2 18003 JobFiles Delete extension) None Deletes a file
it is in use, an error is
<ObjectToDelete>:
returned.
NodeId

A. Node ID to move
<ObjectToMoveOrCopy>: Files can only be moved
NodeId (renamed) or copied in
B. Node ID of the the same directory. When
directory to move to renaming a file, it is not
1. New node ID (after
<TargetDirectory>: Moves or possible to leave the
2 18004 JobFiles MoveOrCopy moving or copying)
NodeId copies a file order of the characters
<NewNodeId>: NodeId
C. Whether to copy the unchanged and
file <CreateCopy>: merely switch between
Boolean uppercase and lowercase
D. New name characters.
<NewName>: String

The same as the The same as the JobFiles Creates a The same as the JobFiles
2 18005 LogoFiles CreateDirectory
JobFiles object object directory object

The same as the The same as the JobFiles The same as the JobFiles
2 18006 LogoFiles CreateFile Creates a file
JobFiles object object object

4-22 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function

Return value
Name Node Argument Supplemental
Affiliated object Item <Value.Name> Overview
Space ID <Value.Name>*1 explanation
*2, *3

The same as the The same as the JobFiles The same as the JobFiles
2 18007 LogoFiles Delete Deletes a file
JobFiles object object object

The same as the The same as the JobFiles Moves or The same as the JobFiles
2 18008 LogoFiles MoveOrCopy
JobFiles object object copies a file object

The same as the The same as the JobFiles Creates a The same as the JobFiles
2 18009 CustomCharacterFiles CreateDirectory
JobFiles object object directory object

The same as the The same as the JobFiles The same as the JobFiles
2 18010 CustomCharacterFiles CreateFile Creates a file
JobFiles object object object

The same as the The same as the JobFiles The same as the JobFiles
2 18011 CustomCharacterFiles Delete Deletes a file
JobFiles object object object

The same as the The same as the JobFiles Moves or The same as the JobFiles
2 18012 CustomCharacterFiles MoveOrCopy
JobFiles object object copies a file object

The same as the The same as the JobFiles Creates a The same as the JobFiles
2 18013 Z-mapFiles CreateDirectory
JobFiles object object directory object

4
The same as the The same as the JobFiles The same as the JobFiles
2 18014 Z-mapFiles CreateFile Creates a file
JobFiles object object object

The same as the The same as the JobFiles The same as the JobFiles
2 18015 Z-mapFiles Delete Deletes a file
JobFiles object object object

OPC UA
The same as the The same as the JobFiles Moves or The same as the JobFiles
2 18016 Z-mapFiles MoveOrCopy
JobFiles object object copies a file object

The same as the The same as the JobFiles Creates a The same as the JobFiles
2 18017 FontFiles CreateDirectory
JobFiles object object directory object

The same as the The same as the JobFiles The same as the JobFiles
2 18018 FontFiles CreateFile Creates a file
JobFiles object object object

The same as the The same as the JobFiles The same as the JobFiles
2 18019 FontFiles Delete Deletes a file
JobFiles object object object

The same as the The same as the JobFiles Moves or The same as the JobFiles
2 18020 FontFiles MoveOrCopy
JobFiles object object copies a file object

The same as the The same as the JobFiles Creates a The same as the JobFiles
2 18021 BackupFiles CreateDirectory
JobFiles object object directory object

The same as the The same as the JobFiles The same as the JobFiles
2 18022 BackupFiles CreateFile Creates a file
JobFiles object object object

The same as the The same as the JobFiles The same as the JobFiles
2 18023 BackupFiles Delete Deletes a file
JobFiles object object object

The same as the The same as the JobFiles Moves or The same as the JobFiles
2 18024 BackupFiles MoveOrCopy
JobFiles object object copies a file object

The same as the The same as the JobFiles Creates a The same as the JobFiles
2 18025 MLogFiles CreateDirectory
JobFiles object object directory object

Not used. (Files can


The same as the The same as the JobFiles
2 18026 MLogFiles CreateFile Creates a file only be created with
JobFiles object object
SaveMLogFile().) *4

The same as the The same as the JobFiles The same as the JobFiles
2 18027 MLogFiles Delete Deletes a file
JobFiles object object object

The same as the The same as the JobFiles Moves or The same as the JobFiles
2 18028 MLogFiles MoveOrCopy
JobFiles object object copies a file object

A. OR calculation of the
bits
Bit 0: Open loadable file
Bit 1: Open writable file
Bit 2: Delete existing data
A. Mode <Mode>: 1. File handle
2 Each FileType node Open Opens a file and open file
Byte <FileHandle>: UInt32
Bit 3: Open file in
appending mode
The file handle is used
when calling other
Methods.

A. File handle
Closes the
2 Each FileType node Close <FileHandle>: None
file
UInt32

A. File handle
<FileHandle>:
1. Loaded data <Data>: Reads file
2 Each FileType node Read UInt32
ByteString data
B. Length to load
<Length>: Int32

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-23


OPC UA Server Function

Return value
Name Node Argument Supplemental
Affiliated object Item <Value.Name> Overview
Space ID <Value.Name>*1 explanation
*2, *3

A. File handle
<FileHandle>:
UInt32 Writes data
2 Each FileType node Write None
B. Data to to the file
write <Data>:
ByteString

Acquires
A. File handle the current
1. Current file position
2 Each FileType node GetPosition <FileHandle>: position for
<Position>: UInt64
UInt32 file reading/
writing

A. File handle
<FileHandle>: Sets the
If a value larger than the
UInt32 current
file size is specified with
2 Each FileType node SetPosition B. Current None position for
B, the position is set to
file position file reading/
the end of the file.
<Position>: writing
UInt64

4 *1 W hen specifying a file name to execute a Method, the Marking Builder Plus or laser marker controller file name restrictions are applied.
File name: Up to 100 characters, including the extension. When the file name is expressed in UTF-16, strings that use surrogate pairs cannot be used.
Prohibited characters: #%\/:;,.*?" <>| (half-width space) (full-width space)
*2 Success: TRUE, failure: FALSE.
OPC UA

*3 Error codes only take on a value when a failure occurs. They are blank when the operation is successful.
*4 In terms of the structure, CreateDirectory under JobFiles, LogoFiles, CustomCharacterFiles, Z-mapFiles, BackupFiles, and MLogFiles and CreateFile
under MLogFiles exist but are not used.
If you call these Methods, a BadNotSupported error will be returned, and the operation will not be recorded in the communication history.

„ Event
Node Notification data
NameSpace Affiliated object Item Overview Supplemental explanation*4
ID <element name in event>

Issued at the start of


marking (marking, test
- - Server MarkingStart None Event type: BaseEventType
marking, and laser
inspection)*1

A. Success/
failure
Issued at the completion
<Succeeded>:
of marking (marking, Event type:
- - Server MarkingEnd Boolean
test marking, and laser OperationResultEventType
B. Error code
inspection)*1
<ErrorCode>:
String

A. Success/
failure Issued at the completion
<Succeeded>: of the marking workflow
Event type:
- - Server MarkingWorkflowEnd Boolean (marking, test marking, and
OperationResultEventType
B. Error code single instance of guide
<ErrorCode>: laser marking)*2
String

Issued at the start of guide


laser marking (guide laser
- - Server GuideLaserMarkingStart None Event type: BaseEventType
marking and distance
pointer)*3

A. Success/
failure
Issued at the completion of
<Succeeded>:
guide laser marking (guide Event type:
- - Server GuideLaserMarkingEnd Boolean
laser marking and distance OperationResultEventType
B. Error code
pointer)*3
<ErrorCode>:
String

Issued at the start of


2D code reading (2D
code reading process
- - Server 2DCodeReadingStart None in the workflow and Event type: BaseEventType
reading operation via
Marking Builder Plus or
communication)

A. Success/ Issued at the completion


failure of 2D code reading (2D
<Succeeded>: code reading process
Event type:
- - Server 2DCodeReadingEnd Boolean in the workflow and
OperationResultEventType
B. Error code reading operation via
<ErrorCode>: Marking Builder Plus or
String communication)

4-24 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function

Node Notification data


NameSpace Affiliated object Item Overview Supplemental explanation*4
ID <element name in event>

Issued at the start of


deployment processing for
marking settings (changing
the job, changing the
- - Server ExpansionStart None Event type: BaseEventType
current setting contents,
advance deployment of
job files, and changing the
controller settings)

Issued at the completion of


deployment processing for
marking settings (changing
the job, changing the
- - Server ExpansionEnd None Event type: BaseEventType
current setting contents,
advance deployment of
job files, and changing the
controller settings)

Issued at the start of lens


inspection (only at startup
- - Server WindowCheckStart None Event type: BaseEventType
and during maintenance,

4
not issued in workflows)

A. Success/
failure Issued at the completion
<Succeeded>: of lens inspection (only
Event type:

OPC UA
- - Server WindowCheckEnd Boolean at startup and during
OperationResultEventType
B. Error code maintenance, not issued in
<ErrorCode>: workflows)
String

A. Success/
failure
<Succeeded>:
Issued at the completion of Event type:
- - Server SaveJobFileEnd Boolean
SaveJobFile processing OperationResultEventType
B. Error code
<ErrorCode>:
String

A. Success/
failure
<Succeeded>:
Issued at the completion of Event type:
- - Server LoadJobFileEnd Boolean
LoadJobFile processing OperationResultEventType
B. Error code
<ErrorCode>:
String

A. Success/
failure
<Succeeded>: Issued at the completion
Event type:
- - Server BackupAllSettingEnd Boolean of BackupAllSettings
OperationResultEventType
B. Error code processing
<ErrorCode>:
String

A. Success/
failure
<Succeeded>: Issued at the completion
Event type:
- - Server RestoreAllSettingEnd Boolean of RestoreAllSettings
OperationResultEventType
B. Error code processing
<ErrorCode>:
String

A. Success/
failure
<Succeeded>: Issued at the completion
Event type:
- - Server InitializeAllSettingEnd Boolean of InitializeAllSettings
OperationResultEventType
B. Error code processing
<ErrorCode>:
String

A. Success/
failure
<Succeeded>:
Issued at the completion of Event type:
- - Server SaveMLogFileEnd Boolean
SaveMLogFile processing OperationResultEventType*5
B. Error code
<ErrorCode>:
String

*1 This event is issued multiple times during continuous marking. It is issued every time for the tracking of moving marking marking.
*2 This event is only issued once during continuous marking. It is not issued during moving marking.
*3 This event is issued each time continuous marking is set or the tracking of moving marking occurs during one instance of guide laser marking.
*4 In addition to the BaseEventType, there is also the OperationResultEventType, which returns the success/failure of the operation and the error code in the
case of failure.
*5 This event is not issued when a request is made from Marking Builder Plus.

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-25


OPC UA Server Function

Depending on the sampling cycle setting and the operation status of the laser marker, the updating of Variables and the issuing of
Events may occur later than the operations of the actual laser marker.

Alarms & conditions


These are issued when an error or warning occurs or an error is reset.

With the MD-X2000 Series, the following Node is provided as the A&C function.
Error Condition (ns=2, i=20001)(DiscreteAlarmType)

The Error Condition node notifies the user of error and warning states with the Severity and Message contents.
To monitor, register a ServerNode to a Subscription.

* Only the T000 terminal block error is targeted by the A&C function.

4
OPC UA

4-26 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function

Control examples

„ Sequence example 1: Transfer the new job file myjob.ma2 and load this file as the laser marker job.
OPC UA client Laser marker
1-1 Call the CreateFile Method of the JobFiles node.
(FileName: myjob.ma2, RequestFileOpen: true)

1-2 Acquire the execution result (FileNodeId, FileHandle).


Job file
Create/open
2-1 Call the Write Method of the FileType node of the acquired FileNodeId.*1 *1 If an error occurs during
(FileHandle: value acquired in step 1-2, Data: job file data array) OPC UA communication
because the file size is
Write too large, separate the
2-2 Acquire the execution result. file into multiple transfer
operations (call Write
myjob.ma2 multiple times).

Close
3-1 Call the Close Method of the FileType node of the acquired FileNodeId.
(FileHandle: value acquired in step 1-2) Load

3-2 Acquire the execution result. 4

OPC UA
4-1 Call the LoadJobFile Method of the FileOperation node. Job data in
(JobNo: job number to read, FileName: myjob.ma2) memory

4-1 Acquire the execution result (loading and deployment processing are performed asynchronously).

5 Use a LoadJobFileEnd Event to provide notification of the result.*2

6 Use an ExpansionEnd Event to provide notification of deployment completion.*3 *2 If the Event cannot be acquired, you can use the
LoadJobFileResult Variable in advance to detect the
completion.
*3 When loaded into the current job number or the advance
deployment target job number, deployment processing
7-1 Call the Delete Method of the JobFiles node.*4 is executed, and an event is issued.
(ObjectToDelete: FileNodeId acquired in step 1-2) (An ExpansionStart Event is also issued at the start.)
The result can also be acquired with the
LoadJobFileResult Variable.
7-2 Acquire the execution result. *4 Because files take up space in the built-in memory, it is
recommended to use the Delete Method to delete files
that are no longer used.

„ Sequence example 2: Read out laser marker job data (No. 0000; the temporary file name is markerjob.ma2).
OPC UA client Laser marker
1-1 Call the SaveJobFile Method of the FileOperation node.
(JobNo: 0, FileName: markerjob.ma2)

1-2 Acquire the execution result (save processing is performed asynchronously).


Job data in
2 Use a SaveJobFileEnd Event to provide notification of the result. memory

The file is created in internal memory.


3 Read the Size Variable (file size) of the markerjob.ma2 node. Also, a markerjob.ma2 node is created
under the BackUpFiles node.
Node ID:
ns=2;s=LaserMarker/FileOperation/
BackupFiles/makerjob.ma2
4-1 Call the Open Method of the markerjob.ma2 node.
(To open in reading mode, specify Mode: 1.)
Open

4-2 Acquire the execution result (FileHandle).


markerjob.ma2

Read
5-1 Call the Read Method of the markerjob.ma2 node.*1
(FileHandle: value acquired in step 4-2, Length: file size acquired in step 3)
*1 If an error occurs during OPC UA
communication because the file size
is too large, separate the file into
5-2 Acquire the execution result (Data). multiple transfer operations (call
Read multiple times).
Close
6-1 Call the Close Method of the markerjob.ma2 node.
(FileHandle: value acquired in step 1-2)

Job file 6-2 Acquire the execution result.

7-1 Call the Delete Method of the JobFiles node.*2


(ObjectToDelete: NodeId of the markerjob.ma2 node) *2  ecause files take up space in the built-in memory, it is
B
recommended to use the Delete Method to delete files
that are no longer used.
7-2 Acquire the execution result.

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-27


OPC UA Server Function

„ Sequence example 3: Change the job number (No. 1000 → No. 1001) and the strings (block
1 = “ABCDE,” block 2 = “12345”).
OPC UA client Laser marker
1-1 Call the SetCurrentJobNo Method of the JobOperation node.
(JobNo: 1001)

1-2 Acquire the execution result.


*1 An ExpansionStart Event is also issued at the start of
2 Use an ExpansionEnd Event to provide notification of deployment completion.*1 deployment processing.
If the Event cannot be acquired, use the status, such as
the ReadyStatus Variable, to detect completion.

3-1 Call the StartJobEdit Method of the JobOperation node.*2 *2 From StartJobEdit to EndJobEdit, deployment processing
(JobNo: 1001) is not carried out even if the string is changed.

3-2 Acquire the execution result.

4-1 Call the SetSettingString Method of the JobOperation node.


(JobNo: 1001, BlockNo: 1, SettingString: ABCDE)

4 4-2 Acquire the execution result.


Setting update

Setting Job data in


update
OPC UA

memory
5-1 Call the SetSettingString Method of the JobOperation node.
(JobNo: 1001, BlockNo: 2, SettingString: 12345)

Load and
5-2 Acquire the execution result. deploy.

Deployment
processing
6-1 Call the EndJobEdit Method of the JobOperation node.

6-2 Acquire the execution result.

7 Use an ExpansionEnd Event to provide notification of deployment completion.*1

„ Sequence example 4: Apply triggers from the PLC to acquire the result after marking completion.
OPC UA client Laser marker PLC

1 Apply trigger from terminal block.

2 Use a MarkingStart Event to provide notification of marking starting.

(Laser marking processing)


3 Use a MarkingEnd Event to provide
notification of the completion of laser marking.

If the 2D code reader function is enabled, 2DCodeReadingStart


and 2DCodeReadingEnd Events are issued.
4 Use a MarkingWorkflowEnd Event to provide
notification of workflow completion.*1 *1 If the Event cannot be acquired, use the
MarkingCompleteStatus, 2DCodeReadBusyStatus,
MarkingConfirmationBusyStatus, and
WindowCheckBusyStatus Variables to detect the workflow
completion.

5 Read the Variable for acquiring the result.*2 *2  he workflow execution result is applied to the Variable
T
under the OperationResult node.
For details, refer to the Variable explanation.

6-1 Call the Method for acquiring the result.*3 *3  ou can use GetXYTrackingResult, GetZTrackingResult,
Y
and GetCameraImage Methods to acquire the tracking
result and image.
6-2 Result acquisition For details, refer to the Method explanation.

1' Apply trigger from terminal block.*4

*4  etermine the timing after marking completion so the


D
next marking trigger is applied after the acquisition of the
required data finishes.
(Because the previous result is cleared when the marking
trigger is applied.)

4-28 - MD-X2000/2500 Series Communication Interface User’s Manual -


OPC UA Server Function

Communication history
The history of OPC UA communication can be recorded in the communication history, which can be checked using Marking Builder Plus.

z Variable, Method, and Event communication history examples


Write for a Variable Command: Write_<Variable name>, <value>
Response: Write_<Variable name>, <result: OK/Failed>

Method (normal) Command: <Method name>, <argument 1>, <argument 2>, ...
Response (success): <Method name>, OK, <return value 1>, <return value 2>, ...
Response (failure): <Method name>, Failed, <error code>

Method (FileType node) Command: <File name>, <Method name>, <argument 1>, <argument 2>, ...
Response (success): <File name>, <Method name>, OK, <return value 1>, <return value 2>, ...
Response (failure): <File name>, <Method name>, Failed, <error code>

Event (notification only) Event: <Event name>

Event (including result data) Event (success): <Event name>, OK


Event (failure): <Event name>, Failed, <error code>

4
If the controller is equipped with two LAN ports, both ports can receive events, so the IP address will be 0.0.0.0 in the event
communication history.

OPC UA

- MD-X2000/2500 Series Communication Interface User’s Manual - 4-29


Revision history

Revision history Edition number Revision details

May 2021 Official release

December 2021 2nd revision


1st edition

April 2022 2nd revision


2nd edition

December 2022 2nd revision


3rd edition

July 2023 3rd revision


1st edition
WARRANTIES AND DISCLAIMERS

(1) KEYENCE warrants the Products to be free of defects in materials and workmanship for a period of one (1) year
from the date of shipment. If any models or samples were shown to Buyer, such models or samples were used
merely to illustrate the general type and quality of the Products and not to represent that the Products would
necessarily conform to said models or samples. Any Products found to be defective must be shipped to KEYENCE
with all shipping costs paid by Buyer or offered to KEYENCE for inspection and examination. Upon examination by
KEYENCE, KEYENCE, at its sole option, will refund the purchase price of, or repair or replace at no charge any
Products found to be defective. This warranty does not apply to any defects resulting from any action of Buyer,
including but not limited to improper installation, improper interfacing, improper repair, unauthorized modification,
misapplication and mishandling, such as exposure to excessive current, heat, coldness, moisture, vibration or
outdoors air. Components which wear are not warranted.
(2) KEYENCE is pleased to offer suggestions on the use of its various Products. They are only suggestions, and it
is Buyer’s responsibility to ascertain the fitness of the Products for Buyer’s intended use. KEYENCE will not be
responsible for any damages that may result from the use of the Products.
(3) The Products and any samples (“Products/Samples”) supplied to Buyer are not to be used internally in humans,
for human transportation, as safety devices or fail-safe systems, unless their written specifications state otherwise.
Should any Products/Samples be used in such a manner or misused in any way, KEYENCE assumes no
responsibility, and additionally Buyer will indemnify KEYENCE and hold KEYENCE harmless from any liability or
damage whatsoever arising out of any misuse of the Products/Samples.
(4) OTHER THAN AS STATED HEREIN, THE PRODUCTS/SAMPLES ARE PROVIDED WITH NO OTHER
WARRANTIES WHATSOEVER. ALL EXPRESS, IMPLIED, AND STATUTORY WARRANTIES, INCLUDING,
WITHOUT LIMITATION, THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, AND NON-INFRINGEMENT OF PROPRIETARY RIGHTS, ARE EXPRESSLY DISCLAIMED. IN NO
EVENT SHALL KEYENCE AND ITS AFFILIATED ENTITIES BE LIABLE TO ANY PERSON OR ENTITY FOR
ANY DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, SPECIAL OR CONSEQUENTIAL DAMAGES (INCLUDING,
WITHOUT LIMITATION, ANY DAMAGES RESULTING FROM LOSS OF USE, BUSINESS INTERRUPTION,
LOSS OF INFORMATION, LOSS OR INACCURACY OF DATA, LOSS OF PROFITS, LOSS OF SAVINGS, THE
COST OF PROCUREMENT OF SUBSTITUTED GOODS, SERVICES OR TECHNOLOGIES, OR FOR ANY
MATTER ARISING OUT OF OR IN CONNECTION WITH THE USE OR INABILITY TO USE THE PRODUCTS,
EVEN IF KEYENCE OR ONE OF ITS AFFILIATED ENTITIES WAS ADVISED OF A POSSIBLE THIRD PARTY’S
CLAIM FOR DAMAGES OR ANY OTHER CLAIM AGAINST BUYER. In some jurisdictions, some of the foregoing
warranty disclaimers or damage limitations may not apply.

BUYER’S TRANSFER OBLIGATIONS:


If the Products/Samples purchased by Buyer are to be resold or delivered to a third party, Buyer must provide
such third party with a copy of this document, all specifications, manuals, catalogs, leaflets and written information
provided to Buyer pertaining to the Products/Samples.

E 1101-3
Specifications are subject to change without notice.

KEYENCE CORPORATION
1-3-14, Higashi-Nakajima, Higashi-Yodogawa-ku, Osaka, 533-8555, Japan PHONE: +81-6-6379-2211 www.keyence.com/glb
AUSTRIA FRANCE ITALY POLAND TAIWAN
Phone: +43 (0)2236 378266 0 Phone: +33 1 56 37 78 00 Phone: +39-02-6688220 Phone: +48 71 368 61 60 Phone: +886-2-2721-1080
BELGIUM GERMANY KOREA ROMANIA THAILAND
Phone: +32 (0)15 281 222 Phone: +49-6102-3656-0 Phone: +82-31-789-4300 Phone: +40 (0)269 232 808 Phone: +66-2-078-1090
BRAZIL HONG KONG MALAYSIA SINGAPORE UK & IRELAND
Phone: +55-11-3045-4011 Phone: +852-3104-1010 Phone: +60-3-7883-2211 Phone: +65-6392-1011 Phone: +44 (0)1908-696-900
CANADA HUNGARY MEXICO SLOVAKIA USA
Phone: +1-905-366-7655 Phone: +36 1 802 7360 Phone: +52-55-8850-0100 Phone: +421 (0)2 5939 6461 Phone: +1-201-930-0100
CHINA INDIA NETHERLANDS SLOVENIA VIETNAM
Phone: +86-21-3357-1001 Phone: +91-44-4963-0900 Phone: +31 (0)40 206 6100 Phone: +386 (0)1 4701 666 Phone: +84-24-3772-5555
CZECH REPUBLIC INDONESIA PHILIPPINES SWITZERLAND
Phone: +420 220 184 700 Phone: +62-21-2966-0120 Phone: +63-(0)2-8981-5000 Phone: +41 (0)43 455 77 30
A4WW1-MAN-2033

Copyright (c) 2023 KEYENCE CORPORATION. All rights reserved. 252166GB 2073-1 H98GB Printed in Japan

You might also like