Cat. No.

W447-E1-03

SYSMAC
CX-Programmer
Ver. 7.0
WS02-CXPC1-E-V7
CS1-H, CJ1-H, CJ1M, CP1H CPU Units
NSJ, FQM1

OPERATION MANUAL
Function Blocks
CX-Programmer
Ver. 7.0
WS02-CXPC1-E-V7
CS1-H, CJ1-H, CJ1M, CP1H CPU Units
NSJ, FQM1
Operation Manual
Function Blocks
Revised July 2006
iv
Notice:
OMRON products are manufactured for use according to proper procedures by a qualified operator
and only for the purposes described in this manual.
The following conventions are used to indicate and classify precautions in this manual. Always heed
the information provided with them. Failure to heed precautions can result in injury to people or dam-
age to property.

!DANGER Indicates an imminently hazardous situation which, if not avoided, will result in death or
serious injury. Additionally, there may be severe property damage.

!WARNING Indicates a potentially hazardous situation which, if not avoided, could result in death or
serious injury. Additionally, there may be severe property damage.

!Caution Indicates a potentially hazardous situation which, if not avoided, may result in minor or
moderate injury, or property damage.

OMRON Product References

All OMRON products are capitalized in this manual. The word “Unit” is also capitalized when it refers to
an OMRON product, regardless of whether or not it appears in the proper name of the product.
The abbreviation “Ch,” which appears in some displays and on some OMRON products, often means
“word” and is abbreviated “Wd” in documentation in this sense.
The abbreviation “PLC” means Programmable Controller. “PC” is used, however, in some Program-
ming Device displays to mean Programmable Controller.

Visual Aids
The following headings appear in the left column of the manual to help you locate different types of
information.
Note Indicates information of particular interest for efficient and convenient opera-
tion of the product.

1,2,3... 1. Indicates lists of one sort or another, such as procedures, checklists, etc.

 OMRON, 2005
All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form, or
by any means, mechanical, electronic, photocopying, recording, or otherwise, without the prior written permission of
OMRON.
No patent liability is assumed with respect to the use of the information contained herein. Moreover, because OMRON is con-
stantly striving to improve its high-quality products, the information contained in this manual is subject to change without
notice. Every precaution has been taken in the preparation of this manual. Nevertheless, OMRON assumes no responsibility
for errors or omissions. Neither is any liability assumed for damages resulting from the use of the information contained in
this publication.

v
vi
 TABLE OF CONTENTS
PRECAUTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
1 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
2 General Precautions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
3 Safety Precautions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
4 Application Precautions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix

SECTION 1
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1-1 Introducing the Function Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1-2 Function Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1-3 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1-4 Converting Function Block Definitions to Library Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1-5 Usage Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1-6 Version Upgrade Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

SECTION 2
Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2-1 Function Block Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2-2 Instance Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
2-3 Restrictions on Function Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
2-4 Function Block Applications Guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
2-5 Precautions for Instructions with Operands Specifying the First or Last of Multiple Words 60
2-6 Instruction Support and Operand Restrictions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
2-7 CPU Unit Function Block Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
2-8 Number of Function Block Program Steps and Instance Execution Time . . . . . . . . . . . . . . 122

SECTION 3
Creating Function Blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
3-1 Procedural Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
3-2 Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Appendices
A Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
B Structured Text Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
C External Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
D Function Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

vii
 TABLE OF CONTENTS

viii
About this Manual:
This manual describes the function blocks and related functionality of the CX-Programmer Ver. 7.0
used together with CP1H CPU Units and CS1-H, CJ1-H, and CJ1M CPU Units with unit version 3.0 or
later, and includes the sections described on the next page. The CX-Programmer Ver. 7.0 is software
that enables the personal computer to be used as a function block programming device, and can be
used only for SYSMAC CS-series and CJ-series CPU Units that support function blocks.
The CX-Programmer Ver. 7.0 function block functions have been enhanced. This manual describes
only CX-Programmer Ver. 7.0 operations that are related to functions blocks. For operations not related
to function blocks, refer to the CX-Programmer Operation Manual (enclosed, Cat. No. W437). This
manual also provides only information related to function blocks for the CS1-H, CJ1-H, CJ1M, and
CP1H CPU Units. For other information, refer to the CS/CJ/CP-series manuals.
Please read this manual and related manuals carefully and be sure you understand the information
provided before attempting to install or operate the CX-Programmer Ver. 7.0 or the CS1-H, CJ1-H,
CJ1M, or CP1H CPU Units. Be sure to read the precautions provided in the following section.

CX-Programmer Ver. 7.0 Manuals

Name Cat. No. Contents
SYSMAC WS02-CXPC1-E-V7 W447 Describes the functionality unique to the CX-Programmer Ver.
CX-Programmer Ver. 7.0 Operation Manual (this 7.0 and CP-series CPU Units or CS/CJ-series CPU Units with
Function Blocks manual) unit version 3.0 or later based on function blocks. Functional-
(CS1G-CPU@@H, CS1H-CPU@@H, ity that is the same as that of the CX-Programmer is
CJ1G-CPU@@H, CJ1H-CPU@@H, described in W446 (enclosed).
CJ1M-CPU@@, CP1H-X@@@@-@,
CP1H-XA@@@@-@, CP1H-Y@@@@-@
CPU Units)
SYSMAC WS02-CXPC1-E-V7 W446 Provides information on how to use the CX-Programmer for
CX-Programmer Operation Manual all functionality except for function blocks.
CX-Net Operation Manual W362 Information on setting up networks, such as setting data links,
routing tables, and unit settings.
SYSMAC CXONE-AL@@C-E W445 Describes the operating procedures for the CX-Integrator.
CX-Integrator Operation Manual

CS1-H, CJ1-H, and CJ1M CPU Unit Manuals

Name Cat. No. Contents
SYSMAC CS Series W339 Provides an outline of and describes the design, installation,
CS1G/H-CPU@@-EV1, CS1G/H-CPU@@H maintenance, and other basic operations for the CS-series
Programmable Controllers PLCs.
Operation Manual The following information is included:
An overview and features
The system configuration
Installation and wiring
I/O memory allocation
Troubleshooting
Use this manual together with the W394.

ix
 Name Cat. No. Contents
SYSMAC CJ Series W393 Provides an outline of and describes the design, installation,
CJ1G-CPU@@, CJ1G/H-CPU@@H, maintenance, and other basic operations for the CJ-series
CJ1G-CPU@@P, CJ1M-CPU@@ PLCs.
Programmable Controllers The following information is included:
Operation Manual An overview and features
The system configuration
Installation and wiring
I/O memory allocation
Troubleshooting
Use this manual together with the W394.
SYSMAC CS/CJ Series W394 Describes programming and other methods to use the func-
CS1G/H-CPU@@-EV1, CS1G/H-CPU@@H, tions of the CS/CJ-series PLCs.
CJ1G-CPU@@, CJ1G/H-CPU@@H, The following information is included:
CJ1G-CPU@@P, CJ1M-CPU@@ Programming
Programmable Controllers Tasks
Programming Manual File memory
Other functions
Use this manual together with the W339 or W393.
SYSMAC CS/CJ Series W340 Describes the ladder diagram programming instructions sup-
CS1G/H-CPU@@-EV1, CS1G/H-CPU@@H, ported by CS/CJ-series PLCs.
CJ1G-CPU@@, CJ1G/H-CPU@@H, When programming, use this manual together with the Oper-
CJ1G-CPU@@P, CJ1M-CPU@@ ation Manual (CS1: W339 or CJ1: W393) and Programming
Programmable Controllers Manual (W394).
Instructions Reference Manual
SYSMAC CS/CJ Series W342 Describes the communications commands that can be
CS1G/H-CPU@@-EV1, CS1G/H-CPU@@H, addressed to CS/CJ-series CPU Units.
CS1W-SCB21-V1/41-V1, CS1W-SCU21/41, The following information is included:
CJ1G-CPU@@, CJ1G/H-CPU@@H, C-series (Host Link) commands
CJ1G-CPU@@P, CJ1M-CPU@@, FINS commands
CJ1W-SCU21-V1/41-V1 Note: This manual describes commands that can be sent to
Communications Commands the CPU Unit without regard for the communications path,
Reference Manual which can be through a serial communications port on the
CPU Unit, a communications port on a Serial Communica-
tions Unit/Board, or a port on any other Communications
Unit.

NSJ-series NSJ Controller Manual

Refer to the following manual for NSJ-series NSJ Controller specifications and handling methods not
given in this manual.
Cat. No. Models Name Description
W452 NSJ5-TQ@@(B)-G5D NSJ Series Provides the following information about the NSJ-series NSJ Control-
NSJ5-SQ@@(B)-G5D Operation lers:
NSJ8-TV@@(B)-G5D Manual Overview and features
NSJ10-TV@@(B)-G5D
NSJ12-TS@@(B)-G5D Designing the system configuration
Installation and wiring
I/O memory allocations
Troubleshooting and maintenance
Use this manual in combination with the following manuals: SYSMAC
CS Series Operation Manual (W339), SYSMAC CJ Series Operation
Manual (W393), SYSMAC CS/CJ Series Programming Manual
(W394), and NS-V1/-V2 Series Setup Manual (V083)

x
FQM1 Series Manuals (Unit Version 3.0 or Later)
Refer to the following manuals for specifications and handling methods not given in this manual for
FQM1 Series unit version 3.0 (FQM1-CM002/MMP22/MMA22).
Cat. No. Models Name Description
O012 FQM1-CM002 FQM1 Series Provides the following information about the FQM1-series Modules
FQM1-MMP22 Operation Manual (unit version 3.0):
FQM1-MMA22 Overview and features
Designing the system configuration
Installation and wiring
I/O memory allocations
Troubleshooting and maintenance
O013 FQM1-CM002 FQM1 Series Individually describes the instructions used to program the FQM1.
FQM1-MMP22 Instructions Use this manual in combination with the FQM1 Series
FQM1-MMA22 Reference Manual Operation Manual (O012) when programming.

CP-series PLC Unit Manuals

Refer to the following manuals for specifications and handling methods not given in this manual for CP-
series CPU Units.
Cat. No. Models Name Description
W450 CP1H-X@@@@-@ SYSMAC CP Series Provides the following information on the CP Series:
CP1H-XA@@@@-@ CP1H CPU Unit • Overview/Features
CP1H-Y@@@@-@ Operation Manual
• System configuration
• Mounting and wiring
• I/O memory allocation
• Troubleshooting
Use this manual together with the CP1H Programmable Control-
lers Programming Manual (W451).
W451 CP1H-X@@@@-@ SYSMAC CP Series Provides the following information on the CP Series:
CP1H-XA@@@@-@ CP1H CPU Unit Pro- • Programming instructions
CP1H-Y@@@@-@ gramming Manual
• Programming methods
• Tasks
Use this manual together with the CP1H Programmable Control-
lers Operation Manual (W450).

Installation from CX-One

For details on procedures for installing the CX-Programmer from CX-One FA Integrated Tool Package,
refer to the CX-One Ver. 2.0 Setup Manual provided with CX-One.
Cat. No. Model Manual name Contents
W463 CXONE-AL@@C-EV2/ CX-One Ver. 2.0 Setup Manual Installation and overview of CX-One FA
AL@@D-EV2 Integrated Tool Package.

xi
Overview of Contents
Precautions provides general precautions for using the CX-Programmer Ver. 7.0.
Section 1 introduces the function block functionality of the CX-Programmer and explains the features
that are not contained in the non-function block version of CX-Programmer.
Section 2 provides specifications for reference when using function blocks, including specifications on
function blocks, instances, and compatible PLCs, as well as usage precautions and guidelines.
Section 3 describes the procedures for creating function blocks on the CX-Programmer.
The Appendices provide information on data types, structure text specifications, and external vari-
ables.

!WARNING Failure to read and understand the information provided in this manual may result in per-
sonal injury or death, damage to the product, or product failure. Please read each section
in its entirety and be sure you understand the information provided in the section and
related sections before attempting any of the procedures or operations given.

xii
Read and Understand this Manual
Please read and understand this manual before using the product. Please consult your OMRON
representative if you have any questions or comments.

Warranty and Limitations of Liability

WARRANTY
OMRON's exclusive warranty is that the products are free from defects in materials and workmanship for a
period of one year (or other period if specified) from date of sale by OMRON.

OMRON MAKES NO WARRANTY OR REPRESENTATION, EXPRESS OR IMPLIED, REGARDING NON-

INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR PARTICULAR PURPOSE OF THE
PRODUCTS. ANY BUYER OR USER ACKNOWLEDGES THAT THE BUYER OR USER ALONE HAS
DETERMINED THAT THE PRODUCTS WILL SUITABLY MEET THE REQUIREMENTS OF THEIR
INTENDED USE. OMRON DISCLAIMS ALL OTHER WARRANTIES, EXPRESS OR IMPLIED.

LIMITATIONS OF LIABILITY
OMRON SHALL NOT BE RESPONSIBLE FOR SPECIAL, INDIRECT, OR CONSEQUENTIAL DAMAGES,
LOSS OF PROFITS OR COMMERCIAL LOSS IN ANY WAY CONNECTED WITH THE PRODUCTS,
WHETHER SUCH CLAIM IS BASED ON CONTRACT, WARRANTY, NEGLIGENCE, OR STRICT
LIABILITY.

In no event shall the responsibility of OMRON for any act exceed the individual price of the product on which
liability is asserted.

IN NO EVENT SHALL OMRON BE RESPONSIBLE FOR WARRANTY, REPAIR, OR OTHER CLAIMS

REGARDING THE PRODUCTS UNLESS OMRON'S ANALYSIS CONFIRMS THAT THE PRODUCTS
WERE PROPERLY HANDLED, STORED, INSTALLED, AND MAINTAINED AND NOT SUBJECT TO
CONTAMINATION, ABUSE, MISUSE, OR INAPPROPRIATE MODIFICATION OR REPAIR.

xiii
Application Considerations
SUITABILITY FOR USE
OMRON shall not be responsible for conformity with any standards, codes, or regulations that apply to the
combination of products in the customer's application or use of the products.

At the customer's request, OMRON will provide applicable third party certification documents identifying
ratings and limitations of use that apply to the products. This information by itself is not sufficient for a
complete determination of the suitability of the products in combination with the end product, machine,
system, or other application or use.

The following are some examples of applications for which particular attention must be given. This is not
intended to be an exhaustive list of all possible uses of the products, nor is it intended to imply that the uses
listed may be suitable for the products:

• Outdoor use, uses involving potential chemical contamination or electrical interference, or conditions or
uses not described in this manual.
• Nuclear energy control systems, combustion systems, railroad systems, aviation systems, medical
equipment, amusement machines, vehicles, safety equipment, and installations subject to separate
industry or government regulations.
• Systems, machines, and equipment that could present a risk to life or property.

Please know and observe all prohibitions of use applicable to the products.

NEVER USE THE PRODUCTS FOR AN APPLICATION INVOLVING SERIOUS RISK TO LIFE OR
PROPERTY WITHOUT ENSURING THAT THE SYSTEM AS A WHOLE HAS BEEN DESIGNED TO
ADDRESS THE RISKS, AND THAT THE OMRON PRODUCTS ARE PROPERLY RATED AND INSTALLED
FOR THE INTENDED USE WITHIN THE OVERALL EQUIPMENT OR SYSTEM.

PROGRAMMABLE PRODUCTS
OMRON shall not be responsible for the user's programming of a programmable product, or any
consequence thereof.

xiv
Disclaimers
CHANGE IN SPECIFICATIONS
Product specifications and accessories may be changed at any time based on improvements and other
reasons.

It is our practice to change model numbers when published ratings or features are changed, or when
significant construction changes are made. However, some specifications of the products may be changed
without any notice. When in doubt, special model numbers may be assigned to fix or establish key
specifications for your application on your request. Please consult with your OMRON representative at any
time to confirm actual specifications of purchased products.

DIMENSIONS AND WEIGHTS

Dimensions and weights are nominal and are not to be used for manufacturing purposes, even when
tolerances are shown.

PERFORMANCE DATA
Performance data given in this manual is provided as a guide for the user in determining suitability and does
not constitute a warranty. It may represent the result of OMRON's test conditions, and the users must
correlate it to actual application requirements. Actual performance is subject to the OMRON Warranty and
Limitations of Liability.

ERRORS AND OMISSIONS

The information in this manual has been carefully checked and is believed to be accurate; however, no
responsibility is assumed for clerical, typographical, or proofreading errors, or omissions.

xv
xvi
 PRECAUTIONS
This section provides general precautions for using the CX-Programmer and the Programmable Logic Controller.
The information contained in this section is important for the safe and reliable application of the CX-Programmer
and Programmable Controller. You must read this section and understand the information contained before
attempting to set up or operate the CX-Programmer and Programmable Controller.

1 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii

2 General Precautions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
3 Safety Precautions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
4 Application Precautions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix

xvii
Intended Audience 1

1 Intended Audience
This manual is intended for the following personnel, who must also have
knowledge of electrical systems (an electrical engineer or the equivalent).
• Personnel in charge of installing FA systems.
• Personnel in charge of designing FA systems.
• Personnel in charge of managing FA systems and facilities.

2 General Precautions
The user must operate the product according to the performance specifica-
tions described in the operation manuals.
Before using the product under conditions which are not described in the
manual or applying the product to nuclear control systems, railroad systems,
aviation systems, vehicles, combustion systems, medical equipment, amuse-
ment machines, safety equipment, and other systems, machines, and equip-
ment that may have a serious influence on lives and property if used
improperly, consult your OMRON representative.
Make sure that the ratings and performance characteristics of the product are
sufficient for the systems, machines, and equipment, and be sure to provide
the systems, machines, and equipment with double safety mechanisms.
This manual provides information for programming and operating the product.
Be sure to read this manual before attempting to use the product and keep
this manual close at hand for reference during operation.

!WARNING It is extremely important that a PLC and all PLC Units be used for the speci-
fied purpose and under the specified conditions, especially in applications that
can directly or indirectly affect human life. You must consult with your OMRON
representative before applying a PLC System to the above-mentioned appli-
cations.

3 Safety Precautions
!WARNING Confirm safety sufficiently before transferring I/O memory area status from the
CX-Programmer to the actual CPU Unit. The devices connected to Output
Units may malfunction, regardless of the operating mode of the CPU Unit.
Caution is required in respect to the following functions.

• Transferring from the CX-Programmer to real I/O (CIO Area) in the CPU
Unit using the PLC Memory Window.
• Transferring from file memory to real I/O (CIO Area) in the CPU Unit using
the Memory Card Window.

!Caution Variables must be specified either with AT settings (or external variables), or
the variables must be the same size as the data size to be processed by the
instruction when specifying the first or last address of multiple words in the
instruction operand.

1. If a non-array variable with a different data size and without an AT setting

is specified, the CX-Programmer will output an error when compiling.
2. Array Variable Specifications

xviii
Application Precautions 4

• When the size to be processed by the instruction operand is fixed:

The number of array elements must be the same as the number of ele-
ments to be processed by the instruction. Otherwise, the CX-Programmer
will output an error when compiling.
• When the size to be processed by the instruction operand is not fixed:
The number of array elements must be greater than or the same as the
size specified in the other operands.
• If the other operand specifying a size is a constant, the CX-Program-
mer will output an error when compiling.
• If the other operand specifying a size is a variable, the CX-Programmer
will not output an error when compiling, even if the size of the array
variable is not the same as that specified by the other operand (vari-
able). A warning message, however, will be displayed. In particular, if
the number of array elements is less than the size specified by the oth-
er operand (e.g., the size of the instruction operand is 16, and the num-
ber of elements registered in the actual variable table is 10), the
instruction will execute read/write processing for the area that exceeds
the number of elements. For example, read/write processing will be ex-
ecuted for the 6 words following those for the number of elements reg-
istered in the actual variable table. If these words are used for other
instructions (including internal variable allocations), unexpected oper-
ation will occur, which may result in serious accidents.
Check that the system will not be adversely affected if the size of the
variable specified in the operand is less than the size in the operand
definition before starting PLC operations.

!Caution Confirm safety at the destination node before transferring a program to

another node or changing contents of the I/O memory area. Doing either of
these without confirming safety may result in injury.

!Caution Execute online editing only after confirming that no adverse effects will be
caused by extending the cycle time. Otherwise, the input signals may not be
readable.

!Caution Confirm safety sufficiently before monitoring power flow and present value
status in the Ladder Section Window or when monitoring present values in the
Watch Window. If force-set/reset or set/reset operations are inadvertently per-
formed by pressing short-cut keys, the devices connected to Output Units
may malfunction, regardless of the operating mode of the CPU Unit.

4 Application Precautions
Observe the following precautions when using the CX-Programmer.
• User programs cannot be uploaded to the CX-Programmer.
• Observe the following precautions before starting the CX-Programmer.
• Exit all applications not directly related to the CX-Programmer. Partic-
ularly exit any software such as screen savers, virus checkers, E-mail
or other communications software, and schedulers or other applica-
tions that start up periodically or automatically.
• Disable sharing hard disks, printers, or other devices with other com-
puters on any network.

xix
Application Precautions 4

• With some notebook computers, the RS-232C port is allocated to a

modem or an infrared line by default. Following the instructions in doc-
umentation for your computer and enable using the RS-232C port as
a normal serial port.
• With some notebook computers, the default settings for saving energy
do not supply the rated power to the RS-232C port. There may be both
Windows settings for saving energy, as well as setting for specific com-
puter utilities and the BIOS. Following the instructions in documenta-
tion for your computer, disable all energy saving settings.
• Do not turn OFF the power supply to the PLC or disconnect the connect-
ing cable while the CX-Programmer is online with the PLC. The computer
may malfunction.
• Confirm that no adverse effects will occur in the system before attempting
any of the following. Not doing so may result in an unexpected operation.
• Changing the operating mode of the PLC.
• Force-setting/force-resetting any bit in memory.
• Changing the present value of any word or any set value in memory.
• Check the user program for proper execution before actually running it on
the Unit. Not checking the program may result in an unexpected opera-
tion.
• When online editing is performed, the user program and parameter area
data in CS1-H, CJ1-H, CJ1M, and CP1H CPU Units is backed up in the
built-in flash memory. The BKUP indicator will light on the front of the CPU
Unit when the backup operation is in progress. Do not turn OFF the power
supply to the CPU Unit when the BKUP indicator is lit. The data will not be
backed up if power is turned OFF. To display the status of writing to flash
memory on the CX-Programmer, select Display dialog to show PLC Mem-
ory Backup Status in the PLC properties and then select Windows - PLC
Memory Backup Status from the View Menu.
• Programs including function blocks (ladder programming language or
structured text (ST) language) can be downloaded or uploaded in the
same way as standard programs that do not contain function blocks.
Tasks including function blocks, however, cannot be downloaded in task
units (uploading is possible).
• If a user program containing function blocks created on the CX-Program-
mer Ver. 5.0 or later is downloaded to a CPU Unit that does not support
function blocks (CS/CJ-series CPU Units with unit version 2.0 or earlier),
all instances will be treated as illegal commands and it will not be possible
to edit or execute the user program.
• If the input variable data is not in boolean format, and numerical values
only (e.g., 20) are input in the parameters, the actual value in the CIO
Area address (e.g., 0020) will be passed. Therefore, be sure to include an
&, #, or +, - prefix before inputting the numerical value.
• Addresses can be set in input parameters, but an address itself cannot be
passed as an input variable. (Even if an address is set as an input param-
eter, the value passed to the function block will be that for the size of data
of the input variable.) Therefore, an input variable cannot be used as the
operand of an instruction in the function block when the operand specifies
the first or last of multiple words. With CX-Programmer version 7.0, use

xx
Application Precautions 4

an input-output variable specified as an array variable (with the first

address set for the input parameter) and specify the first or last element of
the array variable, or, with any version of CX-Programmer, use an internal
variable with an AT setting. Alternatively, specify the first or last element in
an internal variable specified as an array variable.
• Values are passed in a batch from the input parameters to the input vari-
ables or input-output variables before algorithm execution (not at the
same time as the instructions in the algorithm are executed). Therefore, to
pass the value from a parameter to an input variable or input-output vari-
able when an instruction in the function block algorithm is executed, use
an internal variable or external variable instead of an input variable or
input-output variable. The same applies to the timing for writing values to
the parameters from output variables.
• Always use internal variables with AT settings in the following cases.
• The addresses allocated to Basic I/O Units, Special I/O Units, and
CPU Bus Units cannot be registered to global symbols, and these vari-
ables cannot be specified as external variables (e.g., the data set for
global variables may not be stable).
• Use internal variables when Auxiliary Area bits other than those pre-
registered to external variables are registered to global symbols and
these variables are not specified as external variables.
• Use internal variables when specifying PLC addresses for another
node on the network: For example, the first destination word at the re-
mote node for SEND(090) and the first source word at the remote node
for RECV(098).
• Use internal variables when the first or last of multiple words is speci-
fied by an instruction operand and the operand cannot be specified as
an array variable (e.g., the number of array elements cannot be spec-
ified).

xxi
Application Precautions 4

xxii
 SECTION 1
Introduction

This section introduces the function block functionality of the CX-Programmer and explains the features that are not
contained in the non-function block version of CX-Programmer.

1-1 Introducing the Function Blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1-1-1 Overview and Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1-1-2 Function Block Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1-1-3 Files Created with CX-Programmer Ver. 6.0 or Later . . . . . . . . . . . 5
1-1-4 Function Block Menus in CX-Programmer Ver. 5.0 (and later Versions) 5
1-2 Function Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1-2-1 Outline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1-2-2 Advantages of Function Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1-2-3 Function Block Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1-3 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1-3-1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1-3-2 Variable Usage and Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1-3-3 Variable Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1-3-4 Variable Properties and Variable Usage . . . . . . . . . . . . . . . . . . . . . . 17
1-3-5 Internal Allocation of Variable Addresses . . . . . . . . . . . . . . . . . . . . 18
1-4 Converting Function Block Definitions to Library Files . . . . . . . . . . . . . . . . 19
1-5 Usage Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1-5-1 Creating Function Blocks and Executing Instances . . . . . . . . . . . . . 20
1-5-2 Reusing Function Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1-6 Version Upgrade Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

1
Introducing the Function Blocks Section 1-1

1-1 Introducing the Function Blocks

1-1-1 Overview and Features
The CX-Programmer Ver. 5.0 (and later versions) is a Programming Device
that can use standard IEC 61131-3 function blocks. The CX-Programmer
function block function is supported for CP1H CPU Units, NSJ-series NSJ
Controllers, and FQM1 Flexible Motion Controllers as well as CS/CJ-series
CPU Units with unit version 3.0 or later and has the following features.
• User-defined processes can be converted to block format by using func-
tion blocks.
• Function block algorithms can be written in the ladder programming lan-
guage or in the structured text (ST) language. (See note.)
• When ladder programming is used, ladder programs created with non-
CX-Programmer Ver. 4.0 or earlier can be reused by copying and past-
ing.
• When ST language is used, it is easy to program mathematical pro-
cesses that would be difficult to enter with ladder programming.
Note The ST language is an advanced language for industrial control
(primarily Programmable Logic Controllers) that is described in IEC
61131-3. The ST language supported by CX-Programmer con-
forms to the IEC 61131-3 standard.
• Function blocks can be created easily because variables do not have to
be declared in text. They are registered in variable tables.
A variable can be registered automatically when it is entered in a ladder or
ST program. Registered variables can also be entered in ladder programs
after they have been registered in the variable table.
• A single function block can be converted to a library function as a single
file, making it easy to reuse function blocks for standard processing.
• A program check can be performed on a single function block to easily
confirm the function block’s reliability as a library function.
• Programs containing function blocks (ladder programming language or
structured text (ST) language) can be downloaded or uploaded in the
same way as standard programs that do not contain function blocks.
Tasks containing function blocks, however, cannot be downloaded in task
units (uploading is possible).
• One-dimensional array variables are supported, so data handling is eas-
ier for many applications.
Note The IEC 61131 standard was defined by the International Electro-
technical Commission (IEC) as an international programmable log-
ic controller (PLC) standard. The standard is divided into 7 parts.
Specifications related to PLC programming are defined in Part 3
Textual Languages (IEC 61131-3).
• A function block (ladder programming language or structured text (ST)
language) can be called from another function block (ladder programming
language or structured text (ST) language). Function blocks can be
nested up to 8 levels and ladder/ST language function blocks can be com-
bined freely.

2
Introducing the Function Blocks Section 1-1

1-1-2 Function Block Specifications

For specifications that are not listed in the following table, refer to the CX-Pro-
grammer Ver. 7.0 Operation Manual (W437).
Item Specifications
Model number WS02-CXPC1-E-V7
Setup disk CD-ROM
Compatible CPU Units CS/CJ-series CS1-H, CJ1-H, and CJ1M CPU Units with unit version 3.0 or later
are compatible.
Device Type CPU Type
• CS1G-H CS1G-CPU42H/43H/44H/45H
• CS1H-H CS1H-CPU63H/64H/65H/66H/67H
• CJ1G-H CJ1G-CPU42H/43H/44H/45H
• CJ1H-H CJ1H-CPU65H/66H/67H
• CJ1M CJ1M-CPU11/12/13/21/22/23
The following CP-series CPU Units are compatible.
• CP1H CP1H-X/XA/Y
Note If a user program containing function blocks created on the CX-Program-
mer Ver. 5.0 or later is downloaded to a CPU Unit that does not support
function blocks (CS/CJ-series CPU Units with unit version 2.0 or earlier),
all instances will be treated as illegal commands and it will not be possi-
ble to edit or execute the user program.
• NSJ G5D (Used for the NSJ5-TQ0@-G5D, NSJ5-SQ0@-G5D, NSJ8
-TV0@-G5D, NSJ10-TV0@-G5D, and NSJ12-TS0@-G5D)
M3D (Used for the NSJ5-TQ0@-M3D, NSJ5-SQ0@-M3D, and
NSJ8-TV0@-M3D)
• FQM1-CM FQM1-CM002
• FQM1-MMA FQM1-MMA22
• FQM1-MMP FQM1-MMP22
CS/CJ/CP Series Function Restrictions
• Instructions Not Supported in Function Block Definitions
Block Program Instructions (BPRG and BEND), Subroutine Instructions (SBS,
GSBS, RET, MCRO, and SBN), Jump Instructions (JMP, CJP, and CJPN),
Step Ladder Instructions (STEP and SNXT), Immediate Refresh Instructions
(!), I/O REFRESH (IORF), ONE-MS TIMER (TMHH)
For details, refer to 2-3 Restrictions on Function Blocks.
Compatible Computer IBM PC/AT or compatible
computers CPU 133 MHz Pentium or faster with Windows 98, 98SE, or NT 4.0 (with service
pack 6 or higher)
OS Microsoft Windows 95, 98, 98SE, Me, 2000, XP, or NT 4.0 (with service pack 6
or higher)
Memory 64 Mbytes min. with Windows 98, 98SE, or NT 4.0 (with service pack 6 or
higher)
Refer to the CX-Programmer Ver. 5.0 Operation Manual (W437) for details.
Hard disk space 100 Mbytes min. available disk space
Monitor SVGA (800 × 600 pixels) min.
Note Use “small font” or “normal size (96 dpi)” for the font size.
CD-ROM drive One CD-ROM drive min.
COM port One RS-232C port min.

3
Introducing the Function Blocks Section 1-1

Item Specifications
Functions not Defining Number of CS1-H/CJ1-H CPU Units:
supported by and creat- function • Suffix -CPU44H/45H/64H/65H/66H/67H: 1,024 max. per CPU Unit
CX-Program- ing func- block defini-
• Suffix -CPU42H/43H/63H: 128 max. per CPU Unit
mer Ver. 4.0 tion blocks tions
or earlier. CJ1M CPU Units:
• CJ1M-CPU11/12/13/21/22/23: 128 max. per CPU Unit
CP1H CPU Units:
• All models: 128 max. per CPU Unit
NSJ Controllers:
• NSJ@-@@@@-G5D: 1,024 max. per Controller;
NSJ@-@@@@-M3D: 128 max. per Controller
FQM1 Flexible Motion Controllers:
• FQM1-CM002/MMA22/MMP22: 128 max. per Controller
Function 64 characters max.
block
names
Variables Variable names 30,000 characters max.
Variable types Input variables (Inputs), output variables (Out-
puts), input-output variables (In Out), internal
variables (Internals), and external variables
(Externals)
Number of variables used in Maximum number of variables per function block
a function block definition
(not including internal vari- • Input-output variables: 16 max.
ables, external variables, • Input variables + input-output variables: 64 max.
EN, and EN0) • Output variables + input-output variables: 64
max.
Allocation of addresses Automatic allocation (The allocation range can be
used by variables set by the user.)
Actual address specification Supported
Array specifications Supported (one-dimensional arrays only and only
for internal variables and input-output variables)
Language Function blocks can be created in ladder programming language or structured
text (ST, see note).
Creating Number of CS1-H/CJ1-H CPU Units:
instances instances • Suffix -CPU44H/45H/64H/65H/66H/67H: 2,048 max. per CPU Unit
• Suffix -CPU42H/43H/63H: 256 max. per CPU Unit
CJ1M CPU Units:
• CJ1M-CPU11/12/13/21/22/23: 256 max. per CPU Unit
CP1H CPU Units:
• All models: 256 max. per CPU Unit
NSJ Controllers:
• SJ@-@@@@-G5D: 2,048 max. per Controller;
NSJ@-@@@@-M3D: 256 max. per Controller
FQM1 Flexible Motion Controllers:
• FQM1-CM002/MMA22/MMP22: 256 max. per Controller
Instance 30,000 characters max.
names
Storing Project files The project file (.cxp/cxt) Includes function block definitions and instances.
function Program The file memory program file (*.obj) includes function block definitions and
blocks as files instances.
files
Function Each function block definition can be stored as a single file (.cxf) for reuse in
block library other projects.
files

4
Introducing the Function Blocks Section 1-1

Note The structured text (ST language) conforms to the IEC 61131-3 standard, but
CX-Programmer Ver. 5.0 supports only assignment statements, selection
statements (CASE and IF statements), iteration statements (FOR, WHILE,
REPEAT, and EXIT statements), RETURN statements, arithmetic operators,
logical operators, comparison functions, numeric functions, standard string
functions, numeric string functions, OMRON expansion functions, and com-
ments. For details, refer to Appendix B Structured Text Specifications.

1-1-3 Files Created with CX-Programmer Ver. 6.0 or Later

Project Files (*.cxp) and Projects created using CX-Programmer that contain function block definitions
File Memory Program and projects with instances are saved in the same standard project files
Files (*.obj) (*.cxp) and file memory program files (*.obj).
The following diagram shows the contents of a project. The function block def-
initions are created at the same directory level as the program within the rele-
vant PLC directory.
Project file (.cxp)

PLC1 Global symbol table

I/O table
PLC Setup
PLC memory table
Program (with rung comments)
Local symbol table
Section 1 (with instances)
Section 2 (with instances)

END section (with instances)

Function block definitions

FunctionBlock1 Each function block can be

stored in a separate
FunctionBlock2 definition file (.cxf).
Instances created
in program
PLC2 sections.

Function Block Library A function block definition created in a project with CX-Programmer Ver. 6.0
Files (*.cxf) can be saved as a file (1 definition = 1 file), enabling definitions to be loaded
into other programs and reused.
Note When function blocks are nested, all of the nested (destination) function block
definitions are included in this function block library file (.cxf).
Project Text Files Data equivalent to that in project files created with CX-Programmer Ver. 6.0
Containing Function (*.cxp) can be saved as CXT text files (*.cxt).
Blocks (*.cxt)

1-1-4 Function Block Menus in CX-Programmer Ver. 5.0 (and later

Versions)
The following tables list menus related to function blocks in CX-Programmer
Ver. 5.0 and later versions. For details on all menus, refer to the CX-Program-
mer Ver. 5.0 Operation Manual (W437).

Main Menu
Main menu Submenu Shortcut Function
File Function Load Function --- Reads the saved function block library files (*.cxf).
Block Block from File
Save Function --- Saves the created function block definitions to a file ([function block
Block to File library file]*.cxf).

5
Introducing the Function Blocks Section 1-1

Main menu Submenu Shortcut Function

Edit Update Function Block --- When a function block definition’s input variables, output variables,
or input-output variables have been changed after the instance was
created, an error will be indicated by displaying the instance’s left
bus bar in red. This command updates the instance with the new
information and clears the error.
To Lower Layer --- Jumps to the function block definition for the selected instance.
Function Block (ladder) --- Generates a ladder-programmed function block for the selected pro-
generation gram section while automatically determining address application
conditions.
View Monitor FB Ladder --- When monitoring the program online, monitors I/O bit and word sta-
Instance tus (I/O bit monitor) of the ladder diagram in the instance.
(Supported by CX-Programmer Ver. 6.0 and later only).
Monitor FB Instance --- When monitoring the program online, monitors ST variable status
as well as I/O bit and word status (I/O bit monitor) of the ladder dia-
gram in the instance.
(Supported by CX-Programmer Ver. 6.1 and later only).
To Lower Layer --- Displays on the right side the contents of the function block defini-
tion of the selected instance. (Supported by CX-Programmer Ver.
6.0 and later only.)
To Upper Layer --- Returns to the calling instance (ladder diagram or ST). (Supported
by CX-Programmer Ver. 6.0 and later only.)
Window FB Instance --- Displays the FB Instance Viewer. (When nesting, the display shows
Viewer details such as the relationship between instance nesting levels and
allocated variable addresses in the instances.)
Insert Function Block Invocation F Creates an instance in the program (section) at the present cursor
location.
Function Block Parameter P When the cursor is located to the left of an input variable or the right
of an output variable, sets the variable’s input or output parameter.
PLC Function Function Block --- Sets the range of addresses (function block instance areas) inter-
Block Memory Allo- nally allocated to the selected instance’s variables.
Memory cation
Function Block --- Checks the status of the addresses internally allocated to the
Memory Statis- selected instance’s variables.
tics
Function Block --- Checks the addresses internally allocated to each variable in the
Instance selected instance.
Address
Optimize Func- --- Optimizes the allocation of addresses internally allocated to vari-
tion Memory ables.
Program FB online Begin --- Starts online editing of a function block.
Edit Send Change --- Transfers changes made during online editing of a function block.
Cancel --- Cancels changes made to a function block being edited online.
Transfer FB --- Transfers only the function block source.
Source
Release FB --- Forcefully releases the access rights for function block online edit-
Online Edit ing held by another user.
Access Rights

6
Introducing the Function Blocks Section 1-1

Main menu Submenu Shortcut Function

Tools Simula- Break Point | --- Sets or clears a break point.
tion Set/Clear
Break Point
Break Point | --- Clears all break points.
Clear All Break
Point
Mode | Run --- Executes continuous scanning. (Sets the ladder execution engine’s
(Monitor Mode) run mode to MONITOR mode.)
Mode | Stop --- Sets the simulator’s operation mode to PROGRAM mode.
(Program
Mode)
Mode | Pause --- Pauses simulator operation.
Step Run --- Executes just one step of the simulator’s program.
Step Run | --- When there is a function block call instruction, this command moves
Step In to execution of the internal program step.
Step Run | --- When a function block’s internal program step is being executed,
Step Out this command returns to the next higher level (call source) and
pauses execution.
Step Run | --- Executes steps continuously for a fixed length of time.
Continuous
Step Run
Step Run | --- Executes for one cycle and pauses execution.
Scan Run
Always Display --- Used with the Step Run or Continuous Step Run commands to
Current Execu- automatically scroll the display and always show the pause point.
tion Point
Break Point List --- Displays a list of the break points that have been set. (Operation
can be jumped to a specified point.)

Main Pop-up Menus

Pop-up Menu for Function Block Definitions
Pop-up menu Function
Insert Function Block Ladder Creates a function block definition with a ladder programming language algo-
rithm.
Structured Text Creates a function block definition with an ST language algorithm.
From file Reads a function block definition from a function block library file (*.cxf).

Pop-up Menu for Inserted Function Blocks

Pop-up menu Function
Open Displays the contents of the selected function block definition on the right side
of the window.
Save Function Block File Saves the selected function block definition in a file.
Compile Compiles the selected function block definition.
FB online Edit Begin Starts online editing of a function block.
Send Change Transfers changes made during online editing of a function block.
Cancel Cancels changes made to a function block being edited online.
Transfer FB Source Transfers only the function block source.
Release FB Online Forcefully releases the access rights for function block online editing held by
Edit Access Rights another user.

7
Function Blocks Section 1-2

Pop-up Menu for Function Block Variable Tables

Pop-up menu Function
Edit Edits the variable.
Insert Variable Adds a variable to the last line.
Insert Variable Above Inserts the variable above the current cursor position.
Below Inserts the variable below the current cursor position.
Cut Cuts the variable.
Copy Copies the variable.
Paste Pastes the variable.
Find Searches for the variable. Variable names, variable comments, or all (text strings) can
be searched.
Replace Replaces the variable.
Delete Deletes the variable.
Rename Changes only the name of the variable.

Pop-up Menu for Instances

Pop-up menu Function
Edit Changes the instance name.
Update Invocation When a function block definition’s input variables, output variables, or input-output vari-
ables have been changed after the instance was created, an error will be indicated by
displaying the instance’s left bus bar in red. This command updates the instance with
the new information and clears the error.
Monitor FB Ladder Instance When monitoring the program online, monitors I/O bit and word status (I/O bit monitor)
of the ladder diagram in the instance.
(Supported by CX-Programmer Ver. 6.0 and later only).
Monitor FB Instance When monitoring the program online, monitors ST variable status as well as I/O bit and
word status (I/O bit monitor) of the ladder diagram in the instance.
(Supported by CX-Programmer Ver. 6.1 and later only).
Register in Watch Window Displays the FB variables registration Dialog Box in order to register a variable from the
selected instance to the Watch Window.
Function Block Definition Displays the selected instance’s function block definition on the right side of the window.

Shortcut Keys
F Key: Pasting Function Move the cursor to the position at which to create the copied function block
Block Definitions in instance in the Ladder Section Window, and press the F Key. This operation is
Program the same as selecting Insert - Function Block Invocation.
Enter Key: Inputting Position the cursor at the left of the input variable or input-output variable, or
Parameters at the right of the output variable and press the Enter Key. This operation is
the same as selecting Insert - Function Block Parameter.

1-2 Function Blocks

1-2-1 Outline
A function block is a basic program element containing a standard processing
function that has been defined in advance. Once the function block has been
defined, the user just has to insert the function block in the program and set
the I/O in order to use the function.
As a standard processing function, a function block does not contain actual
addresses, but variables. The user sets addresses or constants in those vari-
ables. These address or constants are called parameters. The addresses
used by the variables themselves are allocated automatically by the CX-Pro-
grammer for each program.

8
Function Blocks Section 1-2

With the CX-Programmer, a single function block can be saved as a single file
and reused in other PLC programs, so standard processing functions can be
made into libraries.
Program 2
Copy of function block A

Function block A Program 1

Copy of function block A Variable Output
Standard
program section
written with
variables
Input Variable Variable Output

Define in advance.
Insert in
program. Set Set

Copy of function block A

Save function
block as a file.

Convert to Input Output

library function. Variable Variable

Function
block A To another PLC program
Reuse.

1-2-2 Advantages of Function Blocks

Function blocks allow complex programming units to be reused easily. Once
standard programming is created in a function block and saved in a file, it can
be reused just by placing the function block in a program and setting the
parameters for the function block’s I/O. The ability to reuse existing function
blocks will save significant time when creating/debugging programs, reduce
coding errors, and make the program easier to understand.

Structured Structured programs created with function blocks have better design quality
Programming and require less development time.

Easy-to-read “Black Box” The I/O operands are displayed as variable names in the program, so the pro-
Design gram is like a “black box” when entering or reading the program and no extra
time is wasted trying to understand the internal algorithm.
Use One Function Block Many different processes can be created easily from a single function block by
for Multiple Processes using the parameters in the standard process as input variables (such as
timer SVs, control constants, speed settings, and travel distances).
Reduce Coding Errors Coding mistakes can be reduced because blocks that have already been
debugged can be reused.
Black-boxing Know-how Read-protection can be set for function blocks to prevent programming know-
how from being disclosed.
Data Protection The variables in the function block cannot be accessed directly from the out-
side, so the data can be protected. (Data cannot be changed unintentionally.)
Improved Reusability with The function block’s I/O is entered as variables, so it isn’t necessary to change
Variable Programming data addresses in a block when reusing it.

Creating Libraries Processes that are independent and reusable (such as processes for individ-
ual steps, machinery, equipment, or control systems) can be saved as func-
tion block definitions and converted to library functions.

9
Function Blocks Section 1-2

The function blocks are created with variable names that are not tied to actual
addresses, so new programs can be developed easily just by reading the def-
initions from the file and placing them in a new program.

Supports Nesting and Mathematical expressions can be entered in structured text (ST) language.
Multiple Languages With CX-Programmer Ver. 6.0 and later versions, function blocks can be
nested. The function block nesting function allows just special processing to
be performed in a ST-language function block nested within a ladder-lan-
guage function block.
Function block (ladder language)

Call (Nesting)
Function block (ST language)

1-2-3 Function Block Structure

Function blocks consist of function block definitions that are created in
advance and function block instances that are inserted in the program.

Function Block Function block definitions are the programs contained in function blocks. Each
Definitions function block definition contains the algorithm and variable definitions, as
shown in the following diagram.
Example: CLOCK PULSE
Function Block Definition
Example: CLOCK PULSE 1. Algorithm
tim_b
TIMX tim_a OFF_TIME
Algorithm
tim_a
Variable definitions TIMX tim_b ON_TIME

ENO

2. Variable Definitions
Usage Name Type
Internal tim_a TIMER
Internal tim_b TIMER
Input ON_TIME INT
Input OFF_TIME INT

1. Algorithm
Standardized programming is written with variable names rather than real I/O
memory addresses. In the CX-Programmer, algorithms can be written in
either ladder programming or structured text.
2. Variable Definitions
The variable table lists each variable’s usage (input, output, input-output, or
internal) and properties (data type, etc.). For details, refer to 1-3 Variables.
Number of Function Block The maximum number of function block definitions that can be created for one
Definitions CPU Unit is either 128 or 1,024 depending on the CPU Unit model.

10
Function Blocks Section 1-2

Instances To use an actual function block definition in a program, create a copy of the
function block diagram and insert it in the program. Each function block defini-
tion that is inserted in the program is called an “instance” or “function block
instance.” Each instance is assigned an identifier called an “instance name.”
By generating instances, a single function block definition can be used to pro-
cess different I/O data with the same function.
Not yet in program
and memory not yet Block instance in program with memory
allocated allocated. (object)
(abstract).

Function Block Definition FB1 Program Instance

Memory
1. Algorithm Instance FB1_1 of function block definition FB1 used
Insert in
program. Automatic
Standard allocation
program unit Memory
with variable Input a b for FB1_1
names a, b, c, data Output data
etc.
c
Output data Memory
Automatic
2. Parameters allocation for FB1_2
Table defining usage Insert in
and properties of program.
variables a, b, c, etc.

Instance FB1_2 of function block definition FB1 Different I/O data

can be processed
with the same
function.
Input a b
data Output data
c
Output data

Note Instances are managed by names. More than one instance with the same
name can also be inserted in the program. If two or more instances have the
same name, they will use the same internal variables. Instances with different
names will have different internal variables.
For example, consider multiple function blocks that use a timer as an internal
variable. In this case all instances will have to be given different names. If
more than one instance uses the same name, the same timer would be used
in multiple locations, resulting in duplicated use of the timer.
If, however, internal variables are not used or they are used only temporarily
and initialized the next time an instance is executed, the same instance name
can be used to save memory.

instance_A
TIMER_FB
Function Block Definition
TIMER_FB

Variable Definitions
Internal variable: WORK_NUM Use same internal variables.

instance_A
TIMER_FB

Use different internal variables.

instance_B
TIMER_FB

Number of Instances Multiple instances can be created from a single function block definition. Up to
either 256 or 2,048 instances can be created for a single CPU Unit depending
on the CPU Unit model. The allowed number of instances is not related to the
number of function block definitions and the number of tasks in which the
instances are inserted.

11
Function Blocks Section 1-2

Parameters Each time an instance is created, set the real I/O memory addresses or con-
stants for input variables, output variables, and input-output variables used to
pass input data values to instances and obtain output data values from
instances. These addresses and constants are called parameters.
Instance of Function Block Definition A

Input 0.00 a b Output 2.00

Input 3.00 c

Set the constant or

Set the constants or output destination
input source addresses address to which to pass
from which to pass data. data.

Using Input Variables and Output Variables

With input variables and output variables, it is not the input source address
itself, but the contents at the input address in the form and size specified by
the variable data type that is passed to the function block. In a similar fashion,
it is not the output destination address itself, but the contents for the output
address in the form and size specified by the variable data type that is passed
from the function block.
Even if an input source address (i.e., an input parameter) or an output desti-
nation address (i.e., an output parameter) is a word address, the data that is
passed will be the data in the form and size specified by the variable data type
starting from the specified word address.
Program

Instance of Function Block Definition A

Input D100 m k Output D300

Input D200 n

Examples:
If m is type WORD, one word of data from D100 will be passed to the
variable.
If n is type DWORD, two words of data from D200 and D201 will be
passed to the variable.
If k is type LWORD, four words of data from the variable will be passed
to the D300 to D303.

Note (1) Only addresses in the following areas can be used as parameters: CIO
Area, Auxiliary Area, DM Area, EM Area (banks 0 to C), Holding Area,
and Work Area.
The following cannot be used: Index and Data Registers (both direct and
indirect specifications) and indirect addresses to the DM Area and EM
Area (both in binary and BCD mode).
(2) Local and global symbols in the user program can also be specified as
parameters. To do so, however, the data size of the local or global symbol
must be the same as the data size of the function block variable.
(3) When an instance is executed, input values are passed from parameters
to input variables before the algorithm is processed. Output values are

12
Function Blocks Section 1-2

passed from output variables to parameters just after processing the al-
gorithm. If it is necessary to read or write a value within the execution cy-
cle of the algorithm, do not pass the value to or from a parameter. Assign
the value to an internal variable and use an AT setting (specified address-
es).

!Caution If an address is specified in an input parameter, the values in the address are
passed to the input variable. The actual address data itself cannot be passed.

!Caution Parameters cannot be used to read or write values within the execution cycle
of the algorithm. Use an internal variable with an AT setting (specified
addresses). Alternatively, reference a global symbol as an external variable.

Using Input-Output Variables (In Out)

When using an input-output variable, set the address for the input parameter.
A constant cannot be set. The address set for the input parameter will be
passed to the function block. If processing is performed inside the function
block using the input-output variable, the results will be written to I/O starting
at the address set for the size of the variable.
Program

Instance of function block definition A

Automatically set.

Input D200 a a Output D200

Address passed. Address passed.

“a” changed by function

block processing.
D200
D201
Variable “a”

Processing is performed inside the function block using variable

“a.” The resulting value is written to I/O memory for the size of
variable “a” starting at address D200.

Note Input-output variables are specified in a CX-Programmer variable table by

selecting “In Out” for the variable usage.

13
Function Blocks Section 1-2

■ Reference Information
A variety of processes can be created easily from a single function block by
using parameter-like elements (such as fixed values) as input variables and
changing the values passed to the input variables for each instance.
Example: Creating 3 Instances from 1 Function Block Definition
Cyclic task 0
Instance CASCADE_01
CASCADE_01 P_On 1.0
CONTROL
Algorithm EN ENO
&20
ON_TIME
Internal and I/O
variables &10 OFF_TIME

Function Block Definition

Example: CONTROL Instance CASCADE_02
CASCADE_02 P_On 1.1
CONTROL
Algorithm Algorithm EN ENO
&15
ON_TIME
Variables Internal and I/O
variables &10 OFF_TIME

Example:
There are 3 FB
instances and each Cyclic task 1
has its own I/O and Instance CASCADE_03
internal variables. CASCADE_03 P_On 1.2
CONTROL
Algorithm EN ENO
&7
ON_TIME
Internal and I/O
variables &8 OFF_TIME

If internal variables are not used, if processing will not be affected, or if the
internal variables are used in other locations, the same instance name can be
used at multiple locations in the program.
Cyclic taskCASCADE
0
P_On CONTROL 1.0
EN ENO
&100
The same instance can be PARA_1
used at multiple locations. &130 PARA_2
Function block definition
Example: CONTROL
Instance CASCADE
CASCADE P_On CONTROL 1.1
Algorithm Algorithm EN ENO
&50
Internal and I/O PARA_1
Variables variables &150 PARA_2

Cyclic taskCASCADE
1
P_On CONTROL 1.2
EN ENO
&100
PARA_1
&200 PARA_2

Some precautions are required when using the same memory area. For
example, if the same instance containing a timer instruction is used in more
than one program location, the same timer number will be used causing coil
duplication, and the timer will not function properly if both instructions are exe-
cuted.

14
Variables Section 1-3

Registration of Instances Each instance name is registered in the global symbol table as a file name.
Program
Instance (sample) of function block definition A

a b

The instance is registered in the

global symbol table with the instance
name as the symbol name.

Name Data type Address/

value
sample FB [FunctionBlock1] N/A[Auto]
The function block definition
name is registered after FB in
Instance name square parentheses [ ].

1-3 Variables
1-3-1 Introduction
In a function block, the addresses (see note) are not entered as real I/O mem-
ory addresses, they are all entered as variable names. Each time an instance
is created, the actual addresses used by the variable are allocated automati-
cally in the specified I/O memory areas by the CX-Programmer. Conse-
quently, it isn’t necessary for the user to know the real I/O memory addresses
used in the function block, just as it isn’t necessary to know the actual mem-
ory allocations in a computer. A function block differs from a subroutine in this
respect, i.e., the function block uses variables and the addresses are like
“black boxes.”
Example:
Program
Function block definition A
Instance of function block definition A
Standard program section with
variable names a, b, c, etc.
Insert in
a b program. Input 0.00 a b Output 2.00

Input 3.00 c

c Specify inputs and outputs

MOV at the same time.

Status of 0.00 (1 or 0) is Status of b (1 or 0) is

Table indicating usage and passed to a. passed to 2.00.
properties of variables a, b, c, etc.
0.00 1 a 1 b 1 2.00 1
Usage: Inputs
Status of 3.00 (1 or 0) is
Properties: passed to c.
Name Type AT Initial Value Retained
3.00 0 c 0
a BOOL
c BOOL
Usage: Outputs The system automatically allocates the
Properties: addresses used by variables a, b, and c. For
Name Type AT Initial Value Retained
b BOOL
example, when W100 to W120 is set as the
system’s non-retained memory area, bit
addresses such as a = W10000, b = W10001,
and c = W10002 will be allocated.

Note Constants are not registered as variables. Enter constants directly in instruc-
tion operands.

15
Variables Section 1-3

• Ladder programming language: Enter hexadecimal numerical values

after the # and decimal values after the &.
• Structured text (ST language): Enter hexadecimal numerical values af-
ter 16# and enter decimal numerical values as is.
Exception: Enter directly or indirectly specified addresses for Index Registers
IR0 to IR15 and Data Registers DR0 to DR15 directly into the instruction
operand.

1-3-2 Variable Usage and Properties

Variable Usage The following variable types (usages) are supported.
Internals: Internal variables are used only within an instance. They cannot
be used pass data directly to or from I/O parameters.
Inputs: Input variables can input data from input parameters outside of
the instance. The default input variable is an EN (Enable) vari-
able, which passes input condition data.
Outputs: Output variables can output data to output parameters outside of
the instance. The default output variable is an ENO (Enable Out)
variable, which passes the instance’s execution status.
In Out: Input-output variables can input data from input parameters out-
side of the instance and can return the results of processing in a
function block instance to external parameters.
Externals: External variables are either system-defined variables registered
in advance with the CX-Programmer, such as the Condition Flags
and some Auxiliary Area bits, or user-defined global symbols for
use within instances.
For details on variable usage, refer to the section on Variable Type (Usage)
under Variable Definitions in 2-1-2 Function Block Elements.
The following table shows the number of variables that can be used and the
kind of variable that is created by default for each of the variable usages.

1-3-3 Variable Properties

Variables have the following properties.
Variable Name The variable name is used to identify the variable in the function block. It
doesn’t matter if the same name is used in other function blocks.
Note The variable name can be up to 30,000 characters long, but must not begin
with a number. Also, the name cannot contain two underscore characters in a
row. The character string cannot be the same as that of a an index register
such as in IR0 to IR15. For details on other restrictions, refer to Variable Defi-
nitions in 2-1-2 Function Block Elements.
Data Type Select one of the following data types for the variable:
BOOL, INT, UINT, DINT, UDINT, LINT, ULINT, WORD, DWORD, LWORD,
REAL, LREAL, TIMER, COUNTER, and STRING (See note.)
For details on variable data types, refer to Variable Definitions in 2-1-2 Func-
tion Block Elements.
Note STRING data can be used only when the function block is programmed in the
ST language.

16
Variables Section 1-3

AT Settings (Allocation to It is possible to set a variable to a particular I/O memory address rather than
an Actual Addresses) having it allocated automatically by the system. To specify a particular
address, the user can input the desired I/O memory address in this property.
This property can be set for internal variables only. Even if a specific address
is set, the variable name must still be used in the algorithm.
Refer to Variable Definitions in 2-1-2 Function Block Elements for details on
AT settings and 2-4-3 AT Settings for Internal Variables for details on using AT
settings.
Array Settings A variable can be treated as a single array of data with the same properties.
To convert a variable to an array, specify that it is an array and specify the
maximum number of elements.
This property can be set for internal variables and input-output variables only.
Only one-dimensional arrays are supported by the CX-Programmer Ver. 5.0
and later versions.
• Setting Procedure
Click the Advanced Button, select the Array Variable option, and input the
maximum number of elements.
• When entering an array variable name in the algorithm in a function block
definition, enter the array index number in square brackets after the vari-
able number.
For details on array settings, refer to Variable Definitions in 2-1-2 Function Block
Elements.

Initial Value This is the initial value set in a variable before the instance is executed for the
first time. Afterwards, the value may be changed as the instance is executed.
For example, set a boolean (BOOL) variable (bit) to either 1 (TRUE) or 0
(FALSE). Set a WORD variable to a value between 0 and 65,535 (between
0000 and FFFF hex).
If an initial value is not set, the variable will be set to 0. For example, a bool-
ean variable would be 0 (FALSE) and a WORD variable would be 0000 hex.
Retain Select the Retain Option if you want a variable’s data to be retained when the
PLC is turned ON again and when the PLC starts operating.
• Setting Procedure
Select the Retain Option.
Size When a STRING variable is used, the size required to store the text string can
be set to between 1 and 255 characters.

1-3-4 Variable Properties and Variable Usage

The following table shows which properties must be set, can be set, and can-
not be set, based on the variable usage.
Property Variable usage
Internals Inputs Outputs In Out
Name Must be set. Must be set. Must be set. Must be set.
Data Type Must be set. Must be set. Must be set. Must be set.
AT (specified Can be set. Cannot be set. Cannot be set. Cannot be set.
address)
Array specification Must be set. Cannot be set. Cannot be set. Must be set.
Initial Value Can be set. Can be set. Can be set. Cannot be set.
(See note 1.)

17
Variables Section 1-3

Property Variable usage

Internals Inputs Outputs In Out
Retained Can be set. Can be set. Can be set. Cannot be set.
(See note 1.)
Size Can be set. Cannot be set. Cannot be set. Cannot be set.
(See note 2.)

(1) Inputs can be set as initial values, but the value of the actual input param-
eter will be given priority.
(2) Valid only for STRING variables.

1-3-5 Internal Allocation of Variable Addresses

When an instance is created from a function block definition, the CX-Program-
mer internally allocates addresses to the variables. Addresses are allocated
to all of the variables registered in the function block definition except for vari-
ables that have been assigned actual addresses with the AT Settings prop-
erty.
Program FB instance areas
Non-retained area
Instance of function block definition A
Starting address 15 0

CIO, H, W, Size (words)

Input 0.00 a b Output 2.00 D, or E Area
t Output 5.00 Retained area

Note: Variable c is an internal Starting address 15 0

variable, so it is not displayed.
H, D, or E Size (words)
Usage: Inputs Area
Properties:
Name Type AT Initial Value Retained Timer area
a BOOL
Starting address Size (Completion
Usage: Outputs T Area Flags)
Properties:
Name Type AT Initial Value Retained
Counter area
b BOOL YES
Starting Size (Completion
t TIMER Automatic allocation of address C Area Flags)
addresses by system
Usage: Internals Example
Properties:
2000.00
Name Type AT InitialValue Retained
c BOOL 2000.00
Manual allocation of address to
variable in FB by AT Settings option.

Setting Internal Allocation The user sets the function block instance areas in which addresses are allo-
Areas for Variables cated internally by the system. The variables are allocated automatically by
the system to the appropriate instance area set by the user.
Setting Procedure
Select Function Block Memory - Function Block Memory Allocation from
the PLC Menu. Set the areas in the Function Block Memory Allocation Dialog
Box.

18
Converting Function Block Definitions to Library Files Section 1-4

Function Block Instance Areas

CS/CJ-series CPU Units Ver. 3.0 or Later, CP-series CPU Units, and NSJ
Controllers
FB Instance Default value Applicable memory
Area Start address End address Size areas
Non Retain H512 H1407 896 CIO, WR, HR, DM, EM
Retain H1408 H1535 128 HR, DM, EM
Timers T3072 T4095 1024 TIM
Counters C3072 C4095 1024 CNT

FQM1 Flexible Motion Controllers

FB Instance Default value Applicable memory
Area Start address End address Size areas
Non Retain 5000 5999 1000 CIO, WR, DM
Retain None
Timers T206 T255 50 TIM
Counters C206 C255 50 CNT

Function Block Holding The Function Block Holding Area words are allocated from H512 to H1535.
Area Words (H512 to These words are different to the standard Holding Area used for programs
H1535) (H000 to H511) and are used only for the function block instance area (inter-
nally allocated variable area). These words cannot be specified as instruction
operands. They are displayed in red if input when a function block is not being
created. Although the words can be input when creating a function block, an
error will occur when the program is checked. If this area is specified not to be
retained in the Function Block Memory Allocation Dialog Box, turn the power
ON/OFF or clear the area without retaining the values when starting opera-
tion.

1-4 Converting Function Block Definitions to Library Files

A function block definition created using the CX-Programmer can be stored as
a single file known as a function block definition file with filename extension
*.cxf. These files can be reused in other projects (PLCs).
Project Project

Function block definition Function block definition

Example: CLOCK_PULSE Example: CLOCK_PULSE

1. Algorithm
1. Algorithm tim_b
tim_b Save Read TIMX tim_a OFF_TIME
TIMX tim_a OFF_TIME
tim_a
tim_a TIMX tim_b ON_TIME
TIMX tim_b ON_TIME

ENO
ENO

2. Variable Definitions
2. Variable Definitions
Usage Name Type
Usage Name Type Internal tim_a TIMER
Internal tim_a TIMER tim_b TIMER
Internal
Internal tim_b TIMER Input ON_TIME INT
Input ON_TIME INT OFF_TIME INT
Input
Input OFF_TIME INT
Function block
definition file (.cxf)

19
Usage Procedures Section 1-5

1-5 Usage Procedures

Once a function block definition has been created and an instance of the algo-
rithm has been created, the instance is used by calling it when it is time to
execute it. Also, the function block definition that was created can be saved in
a file so that it can be reused in other projects (PLCs).

1-5-1 Creating Function Blocks and Executing Instances

The following procedure outlines the steps required to create and execute a
function block.

1,2,3... 1. First, create the function block definition including the algorithm and vari-
able definitions in ladder program or ST language. Alternatively, insert a
function block library file that has been prepared in advance.

Note (a) Create the algorithm entirely with variable names.

(b) When entering the algorithm in ladder programming language,
project files created with versions of CX-Programmer earlier than
Ver. 5.0 can be reused by reading the project file into CX-Pro-
grammer Ver. 5.0 or higher and copying and pasting useful parts.
(c) Existing ladder programming can be automatically turned into a
function block using Edit - Function Block (ladder) generation.
2. When creating the program, insert copies of the completed function block
definition. This step creates instances of the function block.
3. Enter an instance name for each instance.
4. Set the variables’ input source addresses and/or constants and output
destination addresses and/or constants as the parameters to pass data for
each instance.
5. Select the created instance, select Function Block Memory - Function
Block Memory Allocation from the PLC Menu, and set the internal data
area for each type of variable.
6. Transfer the program to the CPU Unit.
7. Start program execution in the CPU Unit and the instance will be called and
executed if their input conditions are ON.
The instance is
executed if the input
condition is established. 3. Input instance name
Function block definition A Program
Instance of function block definition A
1. Algorithm Input
condition 5. The system automatically allocates
the addresses used by these
Standard variables. Set the data area area in
program section which these addresses are allocated.
with variable Insert in Input 0.00 a b Output 2.00
names a, b, c, program.
etc.
c Output 3.00

2. Variables

Table defining usage

and properties of 4. Specify the input source and
variables a, b, c, etc. output destination addresses.

20
Usage Procedures Section 1-5

1-5-2 Reusing Function Blocks

Use the following procedure to save a function block definition as a file and
use it in a program for another PLCs.

1,2,3... 1. Select the function block that you want to save and save it as a function
block definition file (*.cxf).
2. Open the other PLC’s project and open/read the function block definition
file (*.cxf) that was saved.
3. Insert the function block definition in the program when creating the new
program.
Function block definition A

1. Algorithm Program

Input Instance of function block definition A

Standard condition
program section
with variable
names a, b, c,
etc. Input 1.00 a b Output 5.00

c Output 6.00
2. Variables
Table defining usage
and properties of Read and
variables a, b, c, etc. insert.
Save

Function
block
definition
A

Function block
definition file (*.cxf)

Note In the CX-Programmer Ver. 5.0, each function block definition can be com-
piled and checked as a program. We recommend compiling to perform a pro-
gram check on each function block definition file before saving or reusing the
file.

21
Version Upgrade Information Section 1-6

1-6 Version Upgrade Information

This section outlines the improvements made to the CX-Programmer func-
tions as part of the upgrades from version 5.0 to version 6.0, from version 6.0
to version 6.1, and from version 6.1 to version 7.0.

Version 6.1 to 7.0 Upgrade Information

Applicable PLC Models The version 6.1 to version 7.0 upgrades apply to the following PLC models.
• CS/CJ-series CPU Units with unit version 4.0 or later
• CP-series CP1H (CP1H-XA, CP1H-X, and CP1H-Y) CPU Units
• NSJ-M3D-series Controllers (NSJ@-@@@@(B)-M3D)
Convenient Functions to Convert Ladder Diagrams to Function Blocks
Version 6.1 Version 7.0
Ladder programming can be copied into a func- One or more program sections can be selected from the program and
tion block definition to create a function block. then Function Block (ladder) generation selected from the menu to
The symbols and addresses in the ladder pro- automatically create a function block definition and automatically allo-
gramming, however, have to be checked and cate variables according to symbols and addresses in the program sec-
input variables, internal variables, and output tions. (Allocations can later be changed as required.) This enables
variables have to be identified and manually reg- legacy programming to be easily converted to function blocks.
istered.

Online Function Block Editing

Version 6.1 Version 7.0
Function block definitions (i.e., the algorithms The algorithms and variables tables for function blocks can be changed
and variable tables) cannot be changed online while the PLC is operation. (See note.) This enables debugging and
when the PLC is running. (Only I/O parameters changing function block definitions in systems that cannot be stopped,
for function block instances can be changed.) such as systems that operate 24 hours a day.
Operation: Right-click the function block definition in the Work Space
and select FB Online Edit - Begin from the pop-up menu.
Note Function block instances cannot be added.
Note This function cannot be used for simulations on CX-Simulator.

Support for STRING Data Type and Processing Functions in Standard Text Programs
Version 6.1 Version 7.0
• The STRING data type (text) cannot be used in • The STRING data type (text) can be used in ST programming.This
ST programming. (See note.) enables, for example, substituting a text string for a variable (e.g., a :=
• There are no text processing functions sup- '@READ';) to easily set a variable containing text (i.e., ASCII charac-
ported for ST programming. ters). In doing this, the user does not have to be concerned with the
• Even in a ladder program, the user has to con- ASCII code or code size.
sider the ASCII code and code size of text for • Text processing functions are supported for ST programming, includ-
display messages and no-protocol communica- ing text extraction, concatenation, and searching. This enables easily
tions (see note) when executing string process- processing text strings and display messages in ST programming
ing instructions, data conversion instructions, inside function blocks.
and serial communications instructions. • Functions are also supported for sending and receiving text strings.
Note The user can use the PLC memory func- This enables easily processing no-protocol communications using ST
tion of the CX-Programmer to input text programming in functions blocks without being concerned with ASCII
strings in I/O memory. The data size in I/O codes.
memory, however, must be considered.

Support for Input-Output Variables

Version 6.1 Version 7.0
• Input-output variables cannot be used in func- • Input-output variables can be used in function blocks.
tion blocks. (Only input variables, internal vari- • Input-output variables can be specified as arrays.
ables, and output variables can be used.) • Addresses are passed from input parameters to input variables
• Arrays cannot be specified for input variables. instead of values. This enables using input-output variable arrays
• Values are passed from input parameters to inside function blocks to enable easily passing large amounts of data
input variables. to function blocks using the input parameters.

22
Version Upgrade Information Section 1-6

Version 6.0 to 6.1 Upgrade Information

Support for NSJ-series The PLC model (“device type”) can be set to “NSJ” and the CPU type can be
NSJ Controllers set to the G5D.
Support for FQM1 Unit The new models of the FQM1 Flexible Motion Controller are now supported
Version 3.0 (i.e., the FQM1-CM002 Coordinator Module and the FQM1-MMA22/MMP22
Motion Control Modules).
Instance ST/Ladder Program Simulation Function
Previous version (Ver. 6.0) New version (Ver. 6.1)
The CX-Simulator could be used to execute a The Step Run, Continuous Step Run, Scan Run, and Set/Clear Break
ladder program step (Step Run), execute steps Point functions can be executed as CX-Programmer functions.
continuously (Continuous Step Run), execute a All of these functions can be used with ladder programs and ladder/ST
single cycle (Scan Run), and set I/O break point programs in function blocks.
conditions.
Note The CX-Simulator Ver. 1.6 (sold separately) must be installed in
order to use these functions.
Note I/O break conditions cannot be set.

Improved Function Block Functions

Monitoring ST Programs in Function Blocks
Previous version (Ver. 6.0) New version (Ver. 6.1)
The operation of ST programs within function The status of a function block instance’s ST program can be monitored
block instances could not be monitored while while monitoring the program.
monitoring the program online. To monitor the ST program’s status, either double-click the function
(It was possible to check the contents of a func- block instance or right-click the instance and select Monitor FB
tion block definition’s program and monitor the I/ Instance from the pop-up menu. At this point, it will be possible to
O status of a function block instance’s ladder change PVs and force-set/reset bits.
diagram.) Note Online editing is not supported.

Password Protection of Function Blocks

Previous version (Ver. 6.0) New version (Ver. 6.1)
The function block properties could be set to The following two kinds of password protection can be set.
prevent the display of a function block defini- • Password protection restricting both reading and writing.
tion’s program.
• Password protection restricting writing only.

23
Version Upgrade Information Section 1-6

Version 5.0 to 6.0 Upgrade Information

Nesting Function Blocks
Previous version (Ver. 5.0) New version (Ver. 6.0)
A function block could not be called from another A function block can be called from another function block (nested). Up
function block. (Nesting not supported.) to 8 nesting levels are supported.
The languages of the calling function block and called function block
can be either ladder language or ST language.
The nesting level relationship between function blocks can be displayed
in a directory tree format. When function blocks are nested, just one
Function Block Library file (.cxf extension) is stored for the calling func-
tion block and its called (nested) function block definitions.

I/O Bit Monitor Support for Ladder Programs in Function Blocks

Previous version (Ver. 5.0) New version (Ver. 6.0)
The I/O status of a function block instance’s lad- The I/O status of a function block instance’s ladder diagram can be
der diagram could not be monitored while moni- monitored while monitoring the program online.
toring the program online. To monitor the I/O status, either double-click the function block instance
(It was only possible to check the program in the or right-click the instance and select Monitor FB Ladder Instance
function block definition.) from the pop-up menu. At this point, it will be possible to monitor the
status of I/O bits and the content of words, change PVs, force-set/reset
bits, and monitor differentiation (ON/OFF transitions) of bits.
Note Online editing is not supported and timer/counter SVs cannot be
changed.

Registering and Monitoring Function Block Instance Variables in a Watch Window

Previous version (Ver. 5.0) New version (Ver. 6.0)
To register a function block instance’s variable in Multiple variables in a function block instance can be easily registered
a Watch Window, it was necessary to display the together in the Watch Window. The FB variables registration Dialog Box
Watch Window, double-click the window, and can be displayed with any of the following methods and the variables
select the desired variable from a pull-down list. can be registered together in that Dialog Box.
• Right-click the function block instance and select Register in Watch
Window from the pop-up menu.
• Select the desired function block instance in the program or variable
table and either copy/paste or drag/drop the instance into the Watch
Window.
• Move the cursor to an empty line in the Watch Window and select
Register in Watch Window from the pop-up menu.

Other Function Block Improvements

• The cross-reference pop-up function is supported in ladder programs
within function blocks.
• The ST language help program can be started from the pop-up menu in
ST Editor.
• A function block’s definitions can be opened just by double-clicking the
function block instance.
• The cursor automatically moves down after a function block instance’s
parameter input is confirmed.

24
 SECTION 2
Specifications

This section provides specifications for reference when using function blocks, including specifications on function blocks,
instances, and compatible PLCs, as well as usage precautions and guidelines.

2-1 Function Block Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

2-1-1 Function Block Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2-1-2 Function Block Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2-2 Instance Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
2-2-1 Composition of an Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
2-2-2 Parameter Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
2-2-3 Operating Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
2-3 Restrictions on Function Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
2-4 Function Block Applications Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
2-4-1 Deciding on Variable Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
2-4-2 Determining Variable Types
(Inputs, Outputs, In Out, Externals, and Internals). . . . . . . . . . . . . . 51
2-4-3 AT Settings for Internal Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . 53
2-4-4 Array Settings for Input-Output Variables and Internal Variables . . 54
2-4-5 Specifying Addresses Allocated to Special I/O Units . . . . . . . . . . . 55
2-4-6 Using Index Registers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
2-5 Precautions for Instructions with Operands Specifying the First or
Last of Multiple Words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
2-6 Instruction Support and Operand Restrictions . . . . . . . . . . . . . . . . . . . . . . . . 62
2-6-1 Sequence Input Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
2-6-2 Sequence Output Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
2-6-3 Sequence Control Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
2-6-4 Timer and Counter Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
2-6-5 Comparison Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
2-6-6 Data Movement Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
2-6-7 Data Shift Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
2-6-8 Increment/Decrement Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . 78
2-6-9 Symbol Math Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
2-6-10 Conversion Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
2-6-11 Logic Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
2-6-12 Special Math Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
2-6-13 Floating-point Math Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
2-6-14 Double-precision Floating-point Instructions. . . . . . . . . . . . . . . . . . 92
2-6-15 Table Data Processing Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . 95
2-6-16 Data Control Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
2-6-17 Subroutine Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
2-6-18 Interrupt Control Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
2-6-19 High-speed Counter and Pulse Output Instructions
(CJ1M-CPU21/22/23 Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

25
 2-6-20 Step Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
2-6-21 Basic I/O Unit Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
2-6-22 Serial Communications Instructions . . . . . . . . . . . . . . . . . . . . . . . . . 104
2-6-23 Network Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
2-6-24 File Memory Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
2-6-25 Display Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
2-6-26 Clock Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
2-6-27 Debugging Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
2-6-28 Failure Diagnosis Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
2-6-29 Other Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
2-6-30 Block Programming Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
2-6-31 Text String Processing Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . 113
2-6-32 Task Control Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
2-6-33 Model Conversion Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
2-6-34 Special Instructions for Function Blocks . . . . . . . . . . . . . . . . . . . . . 117
2-7 CPU Unit Function Block Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
2-7-1 Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
2-7-2 Operation of Timer Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
2-8 Number of Function Block Program Steps and Instance Execution Time . . . 122
2-8-1 Number of Function Block Program Steps . . . . . . . . . . . . . . . . . . . . 122
2-8-2 Function Block Instance Execution Time . . . . . . . . . . . . . . . . . . . . . 123

26
Function Block Specifications Section 2-1

2-1 Function Block Specifications

2-1-1 Function Block Specifications
Item Description
Number of function CS1-H/CJ1-H CPU Units:
block definitions • Suffix -CPU44H/45H/64H/65H/66H/67H: 1,024 max. per
CPU Unit
• Suffix -CPU42H/43H/63H: 128 max. per CPU Unit
CJ1M CPU Units:
• CJ1M-CPU11/12/13/21/22/23: 128 max. per CPU Unit
CP1H CPU Units:
• CP1H-XA/X/Y: 128 max. per CPU Unit
NSJ Controllers:
• All models: 1,024 max. per Controller
FQM1 Flexible Motion Controllers:
• FQM1-CM002/MMA22/MMP22: 128 max. per Controller
Number of instances CS1-H/CJ1-H CPU Units:
• Suffix -CPU44H/45H/64H/65H/66H/67H: 2,048 max. per
CPU Unit
• Suffix -CPU42H/43H/63H: 256 max. per CPU Unit
CJ1M CPU Units:
• CJ1M-CPU11/12/13/21/22/23: 256 max. per CPU Unit
CP1H CPU Units:
• CP1H-XA/X/Y: 256 max. per CPU Unit
NSJ Controllers:
• All models: 2,048 max. per Controller
FQM1 Flexible Motion Controllers:
• FQM1-CM002/MMA22/MMP22: 256 max. per Controller
Number of instance • CX-Programmer Ver. 5.0:
nesting levels Nesting is not supported.
• CX-Programmer Ver. 6.0 and later versions:
Supports nesting up to 8 levels. (The instance called from
the program is counted as one nesting level.)
Number of variables Maximum number of variables per function block definition
used in a function block • Input-output variables: 16 max.
(not including internal
• Input variables + input-output variables: 64 max.
variables, external vari-
ables, EN, and EN0) • Output variables + input-output variables: 64 max.

2-1-2 Function Block Elements

The following table shows the items that must be entered by the user when
defining function blocks.
Item Description
Function block The name of the function block definition
definition name
Language The programming language used in the function block defini-
tion. Select ladder programming or structured text
Variable definitions Variable settings, such as operands and return values,
required when the function block is executed
• Type (usage) of the variable
• Name of the variable
• Data type of the variable
• Initial value of the variable

27
Function Block Specifications Section 2-1

Item Description
Algorithm Enter the programming logic in ladder or structured text.
• Enter the programming logic using variables.
• Input constants directly without registering in variables.
Comment Function blocks can have comments.

Function Block Each function block definition has a name. The names can be up to 64 char-
Definition Name acters long and there are no prohibited characters. The default function block
name is FunctionBlock@, where @ is a number (assigned in order).
Function block definition name

CLOCK PULSE
EN ENO
(BOOL) (BOOL)
ON_TIME
(INT)

OFF_TIME
(INT)

Language Select either ladder programming language or structured text (ST language).

Note (1) For details on ST language, refer to Appendix B Structured Text Specifi-
cations.
(2) When nesting, function blocks using ST language and ladder language
can be combined freely (version 6.0 and higher only).

Variable Definitions Define the operands and variables used in the function block definition.
Variable Names • Variable names can be up to 30,000 characters long.
• Variables name cannot contain spaces or any of the following characters:
! “ # $ % & ‘ ( ) = - ~ ^ \ | ‘ @ { [ + ; * : } ] < , > . ? /
• Variable names cannot start with a number (0 to 9).
• Variable names cannot contain two underscore characters in a row.
• The following characters cannot be used to indicate addresses in I/O
memory.
A, W, H (or HR), D (or DM), E (or EM), T (or TIM), C (or CNT) followed
by the numeric value (word address)
Variable Notation
CLOCK PULSE
Variable table
EN
ENO Usage Name Type
(BOOL) (BOOL) Internal tim_a TIMER
ON_TIME Internal tim_b TIMER
(INT) Input ON_TIME INT
OFF_TIME Input OFF_TIME INT
(INT)

Output variables
Input variables

tim_b
TIMX tim_a OFF_TIME

tim_a
TIMX tim_b OFF_TIME

ENO

Internal
variables

28
Function Block Specifications Section 2-1

Variable Type (Usage)

Item Variable type
Inputs Outputs In Out Internals Externals
(See note.)
Definition Operands to the Return values from Variables used to Variables used Global symbols
instance the instance pass data to and only within registered as vari-
from instances instance ables beforehand
using addresses with the CX-Pro-
grammer or user-
defined global
symbols.
Status of value The value is not The value is The value of the The value is The value of the
at next execu- passed on to the passed on to the external parameter passed on to the variable registered
tion next execution. next execution. next execution. externally
Display Displayed on the Displayed on the Displayed on the Not displayed. Not displayed.
left side of the right side of the left and right sides
instance. instance. of the instance.
Number allowed 64 max. per func- 64 max. per func- 16 max. per func- Unlimited Unlimited
tion block (exclud- tion block (exclud- tion block
ing EN) ing ENO)
AT setting No No No Supported No
Array setting No No Supported Supported No
Retain setting No Supported No Supported No
Variables cre- EN (Enable): ENO (Enable Out- None None Pre-defined sym-
ated by default Receives an input put): bols registered in
condition. Outputs the func- advance as vari-
tion block’s execu- ables in the CX-
tion status. Programmer, such
as Condition Flags
and some Auxil-
iary Area bits.

Note For details on Externals, refer to Appendix C External Variables.

■ Input Variables
Input variables pass external operands to the instance. The input variables
are displayed on the left side of the instance.
The value of the input source (data contained in the specified parameter just
before the instance was called) will be passed to the input variable.

1.0
P_On FB
EN
ENO
D0 D100
PV CV

The value of the parameter specified as the input (value of D0)

is passed to the instance’s input variable (PV).

Example
10.0
Algorithm (Body)
0.0 ADD_INT_DINT
P_On
EN ENO SIGN IN16 tmp
D100 D1000
IN16 OUT32
+L IN32 tmp OUT32
D200 IN32

Variable table
IN16 is an INT variable, so the content of D100 is used.
Usage Name Type
IN32 is a DINT variable, so the content of D200 and
D201 is used.
Internal tmp DINT
Input EN BOOL
Input IN16 INT
Input IN32 DINT
Output ENO BOOL
Output OUT32 DINT

29
Function Block Specifications Section 2-1

Note 1. The same name cannot be assigned to an input variable and output vari-
able. If it is necessary to receive a value from an external variable, change
the variable inside the function block, and then return the result to the ex-
ternal variable, use an input-output variable.
2. When the instance is executed, input values are passed from parameters
to input variables before the algorithm is processed. Consequently, values
cannot be read from parameters to input variables within the algorithm. If
it is necessary to read a value within the execution cycle of the algorithm,
do not pass the value from a parameter. Assign the value to an internal
variable and use an AT setting (specified addresses). Alternatively, refer-
ence the global symbol as external variables.
Initial Value
Initial values can be set for input variables, but the value of the input parame-
ter will be enabled (the input parameter value will be set when the parameter
for input variable EN goes ON and the instance is executed).
Note The input parameter setting cannot be omitted when using the CX-
Programmer.
EN (Enable) Variable
When an input variable is created, the default input variable is the EN variable.
The instance will be executed when the parameter for input variable EN is ON.

■ Output Variables
Output variables pass return values from the instance to external applications.
The output variables are displayed on the right side of the instance.
After the instance is executed, the value of the output variable is passed to the
specified parameter.
1.0
P_On FB
EN ENO

D0 PV CV D100

The value of the output variable (CV) is passed to the parameter

specified as the output destination, which is D100 in this case.

Example

0.0 10.0 Algorithm (Body)

ADD_INT_DINT
EN ENO EN
SIGN IN16 tmp
D100 D1000
IN16 OUT32
+L IN32 tmp OUT32
D200 IN32

Variable table
Usage Name Data type
OUT32 is a DINT variable, so Internal tmp DINT
the variable's value is passed Input EN BOOL
to D1000 and D1001. Input IN16 INT
Input IN32 DINT
Output ENO BOOL
Output OUT32 DINT

30
Function Block Specifications Section 2-1

Like internal variables, the values of output variables are retained until the
next time the instance is executed (i.e., when EN turns OFF, the value of the
output variable is retained).
Example:
In the following example, the value of output variable CV will be retained until
the next time the instance is executed.
Product A counter
CTD
CD Q

LD

PV CV D150

Note 1. The same name cannot be assigned to an input variable and output vari-
able. If it is necessary to receive a value from an external variable, change
the variable inside the function block, and then return the result to the ex-
ternal variable, use an input-output variable.
2. When the instance is executed, output variables are passed to the corre-
sponding parameters after the algorithm is processed. Consequently, val-
ues cannot be written from output variables to parameters within the
algorithm. If it is necessary to write a value within the execution cycle of the
algorithm, do not write the value to a parameter. Assign the value to an in-
ternal variable and use an AT setting (specified addresses).
Initial Value
An initial value can be set for an output variable that is not being retained, i.e.,
when the Retain Option is not selected. An initial value cannot be set for an
output variable if the Retain Option is selected.
The initial value will not be written to the output variable if the IOM Hold Bit
(A50012) is ON.
Auxiliary Area control bit Initial value
IOM Hold Bit (A50012) ON The initial value will not be set.

ENO (Enable Output) Variable

The ENO variable is created as the default output variable. The ENO output
variable will be turned ON when the instance is called. The user can change
this value. The ENO output variable can be used as a flag to check whether or
not instance execution has been completed normally.

31
Function Block Specifications Section 2-1

Input-Output Variables
Input-output variables use addresses to pass data to and from a function
block instance. An input-output variable is displayed on both the left and right
side of the instance. The value of the input-output variable immediately after
the instance is executed is not stored in the addresses internally allocated to
the input-output variable by the system, but rather the value is stored in the
address (and following addresses depending on the data size) of the parame-
ter used to pass data to and from the input-output variable.

P_ON 1.0
FB
EN ENO
D200 D200
CAL CAL

Address D200 is passed to the input-output variable CAL.

Inside the function block, the specified data size of I/O
memory starting from D200 is processed, and changes are
thus passed outside the function block instance.

Note Input-output variables are specified a CX-Programmer variable table by

selecting “In Out” for the variable usage.

■ Internal Variables
Internal variables are used within an instance. These variables are hidden
within each instance. They cannot be referenced from outside of the instance
and are not displayed in the instance.
The values of internal variables are retained until the next time the instance is
executed (i.e., when EN turns OFF, the value of the internal variable is
retained). Consequently, even if instances of the same function block defini-
tion are executed with the same I/O parameters, the result will not necessarily
be the same.
Example:
The internal variable tim_a in instance Pulse_2sON_1sOFF is different from
internal variable tim_a in instance Pulse_4sON_1sOFF, so the instances can-
not reference and will not affect each other’s tim_a value.
Variable table
Pulse_2sON_1sOFF
Usage Name Data type
1.0 Internal tim_a TIMER
P_On CLOCK PULSE
EN ENO Internal tim_b TIMER
&20 Input ON_TIME INT
ON_TIME Input OFF_TIME INT

&10 OFF_TIME

Pulse_4sON_1sOFF
1.1
P_On CLOCK PULSE
EN ENO
&40
ON_TIME

&10 OFF_TIME

32
Function Block Specifications Section 2-1

0.0 10.0 Algorithm (Body)

ADD_INT_DINT
EN ENO EN
SIGN IN16 tmp
D100 D1000
IN16 OUT32
+L IN32 tmp OUT32
D200 IN32

Variable table
Internal variable tmp Name Type
is not displayed. Internal tmp DINT
Input EN BOOL
Input IN16 INT
Input IN32 DINT
Output ENO BOOL
Output OUT32 DINT

Retain Data through Power Interruptions and Start of Operation

Internal variables retain the value from the last time that the instance was
called. In addition, the Retain Option can be selected so that an internal vari-
able will also retains its value when the power is interrupted or operation
starts (the mode is switched from PROGRAM to RUN or MONITOR mode).
When the Retain Option is selected, the value of the variable is retained when
the power is interrupted or operation starts unless the CPU Unit does not
have a backup battery. If the CPU Unit does not have a good battery, the value
will be unstable.
Variables Condition Status
Variables set to Retain Start of operation Retained
Power ON Retained

When the Retain Option is not selected, the value of the variable will not be
held when the power is interrupted or operation starts. Even variables not set
to be retained, however, can be held at the start of operation by turning ON
the IOM Hold Bit (A50012) and can be held during power interruptions by set-
ting the PLC Setup, as shown in the following table.
Variables Condition IOM Hold Bit (A50012) setting
OFF ON
IOM Hold Bit Status at Startup IOM Hold Bit Status at Startup
(PLC Setup) selected (PLC Setup) not selected
Variables not Start of operation Not retained Retained Retained
set to Retain Power ON Not retained Retained Not retained

Note The IOM Hold Bit (A50012) is supported for compatibility with previous mod-
els. To hold the values of variables in function blocks, however, use the Retain
Option and not the IOM Hold Bit.
Initial Value
An initial value can be set for an internal variable that is not being retained
(i.e., when the Retain Option not selected). An initial value cannot be set for
an internal variable if the Retain Option is selected.
Internal variables that are not being retained will be initialized to 0.
The initial value will not be written to the internal variable if the IOM Hold Bit
(A50012) is ON.
Auxiliary Area control bit Initial value
IOM Hold Bit (A50012) ON The initial value will not be set.
OFF The initial value will be set.

■ External Variables
External variables are either system-defined variables that have been regis-
tered in CX-Programmer before hand, or variables that externally reference
user-defined variables in the global symbol table.

33
Function Block Specifications Section 2-1

• For details on system-defined variables, refer to Appendix C External

Variables.
• To reference user-defined variables in the global symbol table, the vari-
ables must be registered in the global symbol table using the same vari-
able name and data type as the external variable.
Variable Properties Variable Name
The variable name is used to identify the variable in the function block. The
name can be up to 30,000 characters long. The same name can be used in
other function blocks.
Note A variable name must be input for variables, even ones with AT settings (spec-
ified address).
Data Type
Any of the following types may be used.
Data type Content Size Inputs Outputs In Out Internals
BOOL Bit data 1 bit OK OK OK OK
INT Integer 16 bits OK OK OK OK
UNIT Unsigned integer 16 bits OK OK OK OK
DINT Double integer 32 bits OK OK OK OK
UDINT Unsigned double integer 32 bits OK OK OK OK
LINT Long (4-word) integer 64 bits OK OK OK OK
ULINT Unsigned long (4-word) integer 64 bits OK OK OK OK
WORD 16-bit data 16 bits OK OK OK OK
DWORD 32-bit data 32 bits OK OK OK OK
LWORD 64-bit data 64 bits OK OK OK OK
REAL Real number 32 bits OK OK OK OK
LREAL Long real number 64 bits OK OK OK OK
TIMER Timer (See note 1.) Flag: 1 bit Not sup- Not sup- Not sup- OK
PV: 16 bits ported ported ported
COUNTER Counter (See note 2.) Flag: 1 bit Not sup- Not sup- Not sup- OK
PV: 16 bits ported ported ported
STRING Text string data (See note 3.) Variable Not sup- Not sup- Not sup- OK
ported ported ported

Note (1) The TIMER data type is used to enter variables for timer numbers (0 to
4095) in the operands for TIMER instructions (TIM, TIMH, etc.). When
this variable is used in another instruction, the Timer Completion Flag (1
bit) or the timer present value (16 bits) is specified (depending on the in-
struction operand). The TIMER data type cannot be used in structured
text function blocks.
(2) The COUNTER data type is used to enter variables for counter numbers
(0 to 4095) in the operands for COUNTER instructions (CNT, CNTR,
etc.). When this variable is used in another instruction, the Counter Com-
pletion Flag (1 bit) or the counter present value (16 bits) is specified (de-
pending on the instruction operand). The COUNTER data type cannot be
used in structured text function blocks.
(3) The STRING data type can be used only within ST programming.

34
Function Block Specifications Section 2-1

AT Settings (Allocation to Actual Addresses)

With internal variables, it is possible to set the variable to a particular I/O
memory address rather than having it allocated automatically by the system.
To specify a particular address, the user can input the desired I/O memory
address in this property. It is still necessary to use variable name in program-
ming even if a particular address is specified.

Note (1) The AT property can be set for internal variables only.
(2) AT settings can be used only with the CIO (Core I/O Area), A (Auxiliary
Area), D (Data Memory Area), E (Extended Memory Area, H (Holding
Relay Area), W (Internal Relay Area).
The AT property cannot be set in the following memory areas:
• Index Register and Data Register Areas (directly/indirectly specified)
• Indirectly specified DM/EM (: binary mode, *:BCD mode)
(3) AT settings can be used for the following allocations.
• Addresses for Basic I/O Units, CPU Bus Units, or Special I/O Units
• Auxiliary Area bits not registered as external variables in advance
• PLC addresses for other nodes in the network
Example:
If the READ DATA FILE instruction (FREAD) is being used in the function
block definition and it is necessary to check the File Memory Operation Flag
(A34313), use an internal variable and specify the flag’s address in the AT set-
ting.
Register an internal variable, select the AT setting option, and specify A34313
as the address. The status of the File Memory Operation Flag can be checked
through this internal variable.

Address A34313 is allocated to a

boolean internal variable named
NOW_CARD_ACCESS.

When the AT setting is used, the function block loses its flexibility. This func-
tion should thus be used only when necessary.
Array Setting
With internal variables and input-output variables, a variable can be defined
as an array.
Note Only one-dimensional arrays are supported by the CX-Programmer.
With the array setting, a large number of variables with the same properties
can be used by registering just one variable.
• An array set for an internal variable can have from 1 to 32,000 array ele-
ments. An array set for an input-output variable can have the number of
elements given in the following table.
Data type Number of elements
BOOL 2,048
INT/UINT/WORD 2,048

35
Function Block Specifications Section 2-1

Data type Number of elements

DINT/UDINT/DWORD 1,024
LINT/ULINT/LWORD 512

• An array can be set only for internal variables or input-output variables.

• Any data type except for STRING can be specified for an array variable,
as long as it is an internal variable.
• When entering an array variable name in the algorithm of a function block
definition, enter the array index number in square brackets after the vari-
able name. The following three methods can be used to specify the index.
(In this case the array variable is a[].)
• Directly with numbers (for ladder or ST language programming)
Example: a[2]
• With a variable (for ladder or ST language programming)
Example: a[n], where n is a variable
Note INT, DINT, LINT, UINT, UDINT, or ULINT can be used as the vari-
able data type.
• With an equation (for ST language programming only)
Example: a[b+c], where b and c are variables
Note Equations can contain only arithmetic operators (+, −, *, and /).
An array is a collection of data elements that are the same type of data. Each
array element is specified with the same variable name and a unique index.
(The index indicates the location of the element in the array.)
A one-dimensional array is an array with just one index number.
Example: When an internal variable named SCL is set as an array variable
with 10 elements, the following 10 variables can be used:
SCL[0], SCL[1], SCL[2], SCL[3], SCL[4], SCL[5], SCL[6], SCL[7], SCL[8], and
SCL[9]
SCL
0 WORD variable
1 WORD variable
2 WORD variable
3 WORD variable Specify SCL[3] to access this data element.
4 WORD variable
5 WORD variable
6 WORD variable
7 WORD variable
8 WORD variable
9 WORD variable

Settings for variable SCL as an array

variable with element numbers 0 to 9.

Note Use an array variable when specifying the first or last of multiple words in an
instruction operand to enable reusing the function block if an internal variable
with a AT property cannot be set for the operand and an external variable can-
not be set. When using an array setting for an input-output variable, specify
the address of the first word for the input parameter (CX-Programmer version
7.0 or higher). When using an array setting for an internal variable, prepare an
array variable with the number of elements for the required size, and after set-

36
Function Block Specifications Section 2-1

ting the data in each array element, specify the first or last element in the
array variable for the operand.
Example:
Function block definition Instance

Variable SCL
EN ENO
SCL WORD[10]
100
S D

Algorithm

SCL- BODY
SCL
LD P_On 0 #0000 Specifying this array element
in the SCL instruction is the
MOV #0000 SC
SCL[0] 1 &0 same as specifying the first
MOV &0SCL[1]
SC 2 #0300 address.
SCL[2]
MOV #0300 SC 3 &4000
MOV &4000 SCL[3]
SC
SCL S SCL[0]
SC D
Write the operand data to
the array variables.

Specify the beginning of the

array in the SCL instruction.

Note For details, refer to 2-5 Precautions for Instructions with Operands Specifying
the First or Last of Multiple Words.
Initial Values
When an instance is executed the first time, initial values can be set for input
variables, internal variables, and output variables. For details, refer to Initial
Value under the preceding descriptions of input variables, internal variables,
and output variables.

Retaining Data through Power Interruptions and Start of Operation

The values of internal variables can be retained through power interruptions
and the start of operation. When the Retain Option is selected, the variable
will be allocated to a region of memory that is retained when the power is
interrupted and PLC operation starts.

Algorithm Enter the logic programming using the registered variables.

Operand Input Addresses cannot be directly input into instruction operands within function
Restrictions blocks. Addresses that are directly input will be treated as variable names.
Note Exception: Input directly or indirectly specified addresses for Index Registers
IR0 to IR15 and Data Registers DR0 to DR15 directly into the instruction
operand. Do not input variables.
Input constants directly into instruction operands.
• Ladder programming: Enter decimal values after the &, and enter
hexadecimal numerical values after the #.

37
Instance Specifications Section 2-2

• Structured text (ST language): Enter decimal numerical values as is

and enter hexadecimal numerical values after 16#.

Comment A comment of up to 30,000 characters long can be entered.

2-2 Instance Specifications

2-2-1 Composition of an Instance
The following table lists the items that the user must set when registering an
instance.
Item Description
Instance name Name of the instance
Language The programming and variables are the same as in
Variable definitions the function block definition.
Function block instance areas The ranges of addresses used by the variables
Comments A comment can be entered for each instance.

Instance Name This is the name of the instance.

• Instance names can be up to 30,000 characters long.
• Instance names cannot contain spaces or any of the following characters:
! “ # $ % & ‘ ( ) = - ~ ^ \ | ‘ @ { [ + ; * : } ] < , > . ? /
• Instance names cannot start with a number (0 to 9).
There are no other restrictions.
The instance name is displayed above the instance in the diagram.
Instance name

Pulse_2sON_2sOFF

CLOCK PULSE
EN
ENO
&20
ON_TIME
&10
OFF_TIME

Function Block To use a function block, the system requires memory to store the instance’s
Instance Areas internal variables, input variables, output variables, and input-output variables.
These areas are known as the function block instance areas and the user
must specify the first addresses and sizes of these areas. The first addresses
and area sizes can be specified in 1-word units.
When the CX-Programmer compiles the function, it will output an error if there
are any instructions in the user program that access words in these areas.

38
Instance Specifications Section 2-2

CS/CJ-series CPU Units Ver. 3.0 or Later, CP-series PLCs, and NSJ
Controllers
FB Instance Default value Applicable memory
Area Start address End address Size areas
Non Retain H512 H1407 896 CIO, WR, HR, DM, EM
Retain H1408 H1535 128 HR, DM, EM
Timers T3072 T4095 1024 TIM
Counters C3072 C4095 1024 CNT

FQM1 Flexible Motion Controllers

FB Instance Default value Applicable memory
Area Start address End address Size areas
Non Retain 5000 5999 1000 CIO, WR, DM
Retain None
Timers T206 T255 50 TIM
Counters C206 C255 50 CNT

Function Block Instance The following settings are made in the function block instance area:
Area Types
CS/CJ-series CPU Units Ver. 3.0 or Later, CP-series PLCs, and NSJ
Controllers
Non-retained Areas
Item Contents
Allocated variables Variables for which the retain property for power OFF and
operation start is set as non-retained (See note 1.)
Applicable areas H (Function block Special Holding Area), I/O (CIO Area), H
(Holding Area), W (Internal Relay Area), D (Data Memory
Area) (see note 2), E (Extended Data Memory Area) (See
notes 2 and 3.)
Setting unit Set in words
Allocated words H512 to H1407
(default)

Note (1) Except when the data type is set to TIMER or COUNTER.
(2) Bit data can be accessed even if the DM or EM Area is specified for the
non-retained area or retained area.
(3) The same bank number cannot be specified as the current bank in the
user program if the EM Area is specified for the non-retained area or re-
tained area.
Retained Area
Item Contents
Allocated variables Variables for which the retain property for power OFF and
operation start is set as retained (See note 1.)
Applicable areas H (Function block Special Holding Area), H (Holding Area), D
(Data Memory Area) (see note 1), E (Extended Data Memory
Area) (See notes 2 and 3.)
Setting unit Set in words
Allocated words H1408 to H1535
(default)

Note (1) Except when the data type is set to TIMER or COUNTER.
(2) Bit data can be accessed even if the DM or EM Area is specified for the
non-retained area or retained area.

39
Instance Specifications Section 2-2

(3) The same bank number cannot be specified as the current bank in the
user program if the EM Area is specified for the non-retained area or re-
tained area.
Timer Area
Item Contents
Allocated variables Variables with TIMER set as the data type.
Applicable areas T (Timer Area) Timer Flag (1 bit) or timer PVs (16 bits)
Allocated words T3072 to T4095 Timer Flag (1 bit) or timer PVs (16 bits)
(default)

Counter Area
Item Contents
Allocated variables Variables with COUNTER set as the data type.
Applicable areas C (Counter Area) Counter Flag (1 bit) or counter PVs (16 bits)
Allocated words C3072 to C4095 Counter Flag (1 bit) or counter PVs (16 bits)
(default)

Function Block Holding Area (H512 to H1535)

The default allocation of Function Block Holding Area words set as retained
and non-retained words is H512 to H1535. These words are different to the
standard Holding Area used for programs (H000 to H511), and are used only
for the function block instance area (internally allocated variable area).
• These words cannot be specified in AT settings for internal variables.
• These words cannot be specified as instruction operands.
• These words are displayed in red if they are input when a function
block is not being created.
• Although the words can be input when creating a function block, an
error will occur when the program is checked.
• If this area is specified as non-retained, turn the power ON/OFF or clear
the area without retaining the values when starting operation.
Note To prevent overlapping of instance area addresses with addresses used in the
program, set H512 to H1535 (Function Block Holding Area words) for the non-
retained area and retained area. If there are not sufficient words, use words in
areas not used by the user program.
FQM1 Flexible Motion controller
FB Instance Default value Applicable memory
Area Start address End address Size areas
Non Retain 5000 5999 1000 CIO, WR, DM
Retain None
Timers T206 T255 50 TIM
Counters C206 C255 50 CNT

Non-retained Areas
Item Contents
Allocated variables Variables for which the retain property for power OFF and
operation start is set as retained. (See note 1.)
Applicable areas I/O (CIO), W (Work Area), and D (DM Area) (See note 2.)
Setting unit Set in words
Allocated words CIO 5000 to CIO 5999
(default)

40
Instance Specifications Section 2-2

Note (1) Except when the data type is set to TIMER or COUNTER.
(2) Bit data can be accessed even if the DM Area is specified for the non-re-
tained area.
Retained Area
None
Timer Area
Item Contents
Allocated variables Variables with TIMER set as the data type.
Applicable areas T (Timer Area) Timer Flag (1 bit) or timer PVs (16 bits)
Allocated words T206 to T255 Timer Flag (1 bit) or timer PVs (16 bits)
(default)

Counter Area
Item Contents
Allocated variables Variables with COUNTER set as the data type.
Applicable areas C (Counter Area) Counter Flag (1 bit) or counter PVs (16 bits)
Allocated words C206 to C255 Counter Flag (1 bit) or counter PVs (16 bits)
(default)

Accessing Function Block If the user program contains an instruction to access the function block
Instance Area from the instance area, an error will be displayed in the Compile Tab of the Output Win-
User Program dow of CX-Programmer if the following operations are attempted.
• Attempting to write during online editing (writing not possible)
• Executing program check (Selecting Compile from the Program Menu or
Compile All PLC Programs from the PLC Menu)
Example: If W0 to W511 is specified as the non-retained area of the function
block instance area and W0.00 is used in the ladder program, an error will
occur when compiling and be displayed as “ERROR: [omitted]...- Address -
W0.00 is reserved for Function Block use].

Program
P_Off FB 1.0
EN ENO Instance data area Start Size
address
Non Retain W0 512
Retain
W0.00 3.0 Timers
Counters

Compile error

Note The allocations in the function block instance area for variables are automati-
cally reallocated when a variable is added or deleted. A single instance
requires addresses in sequence, however, so if addresses in sequence can-
not be obtained, all variables will be allocated different addresses. As a result,
unused areas will be created. If this occurs, execute the optimization opera-
tion to effectively use the allocated areas and remove the unused areas.

Comments A comment of up to 30,000 characters long can be entered.

41
Instance Specifications Section 2-2

Creating Multiple
Instances
Calling the Same Instance A single instance can be called from multiple locations. In this case, the inter-
nal variables will be shared.
Making Multiple Instances Multiple instances can be created from a single function block definition. In
this case, the values of internal variables will be different in each instance.
Example: Counting Product A and Product B
Prepare a function block definition called Down Counter (CTD) and set up
counters for product A and product B. There are two types of programs, one
for automatic operation and another for manual operation. The user can
switch to the appropriate mode of operation.
In this case, multiple instances will be created from a single function block.
The same instance must be called from multiple locations.
Program 1 (automatic operation) Program 2 (manual operation)

Product A counter Product B counter

CTD CTD
CD Q CD Q

LD LD

PV CV D100 PV CV D150

Product B counter Reading the same product’s counter

value at different locations
CTD
CD Q
Reading different products’ counter values
LD (Algorithm calculating counter value is the same.)

PV CV D200

Program 1 Instance A
Instance A
I/O variables,
FB Internal
variables
FB definition
Body Variable
Instance B definitions
FB
Body
Instance B

I/O variables,
Internal
variables
Program 2
Instance A
Body
FB

Use the same internal variables

Use different internal variables

42
Instance Specifications Section 2-2

2-2-2 Parameter Specifications

The data that can be set by the user in the input parameters and output
parameters is as follows:
Item Applicable data
Input parameters Values (See note 1.), addresses, and program symbols (glo-
bal symbols and local symbols) (See note 2.)
Note The data that is passed to the input variable from the
parameter is the actual value of the size of the input
variable data. (An address itself will not be passed even
if an address is set in the parameter.)
Note Input parameters must be set. If even one input param-
eter has not been set, a fatal error will occur and the
input parameters will not be transferred to the actual
PLC.
Output parameters Addresses, program symbols (global symbols, local symbols)
(See note 2.)
Input-output parame- Addresses, program symbols (global symbols, local symbols)
ters

Note (1) The following table shows the methods for inputting values in parameters.
Input Contents Size Parameter value input Setting range
variable method
data type
BOOL Bit data 1 bit P_Off, P_On 0 (FALSE), 1 (TRUE)
INT Integer 16 bits Positive value: & or + followed −32,768 to 32,767
DINT Double integer 32 bits by integer −2,147,483,648 to 2,147,483,647
LINT Long (8-byte) integer 64 bits Negative value: − followed by −9,223,372,036,854,775,808 to
integer 9,223,372,036,854,775,807
UINT Unsigned integer 16 bits Positive value: & or + followed &0 to 65,535
UDINT Unsigned double integer 32 bits by integer &0 to 4,294,967,295
ULINT Unsigned long (8-byte) 64 bits &0 to 18,446,744,073,709,551,615
integer
REAL Real number 32 bits Positive value: & or + followed −3.402823 × 1038 to −1.175494 ×
by real number (with decimal
10−38, 0, 1.175494 × 10−38 to
point)
3.402823 × 1038
Negative value: − followed by
LREAL Long real number 64 bits −1.79769313486232 × 10308 to
real number (with decimal
point) −2.22507385850720 × 10−308, 0,
2.22507385850720 × 10−308,
1.79769313486232 × 10308
WORD 16-bit data 16 bits # followed by hexadecimal #0000 to FFFF or &0 to 65,535
number (4 digits max.)
& or + followed by decimal
number
DWORD 32-bit data 32 bits # followed by hexadecimal #00000000 to FFFFFFFF or &0 to
number (8 digits max.) 4,294,967,295
& or + followed by decimal
number
LWORD 64-bit data 64 bits # followed by hexadecimal #0000000000000000 to
number (16 digits max.) FFFFFFFFFFFFFFFF or &0 to
& or + followed by decimal 18,446,744,073,709,551,615
number

43
Instance Specifications Section 2-2

(2) The size of function block input variables and output variables must
match the size of program symbols (global and local), as shown in the fol-
lowing table.
Size Function block variable data Program symbol (global, local)
type data type
1 bit BOOL BOOL
16 bits INT, UINT, WORD INT, UINT, UINT BCD, WORD
32 bits DINT, UDINT, REAL, DWORD DINT, UDINT, UDINT BCD, REAL,
DWORD
64 bits LINT, ULINT, LREAL, LWORD LINT, ULINT, ULINT BCD, LREAL,
LWORD
More than 1 Non-boolean CHANNEL, NUMBER (see note)
bit

Note The program symbol NUMBER can be set only in the input param-
eters. The value that is input must be within the size range for the
function block variable data type.

2-2-3 Operating Specifications

Calling Instances The user can call an instance from any location. The instance will be executed
when the input to EN is ON.
Instance
1.0
0.0
EN ENO
In this case, the input to EN is bit 0.0 at the left of the diagram.
D0 D10 • When the input to EN is ON, the instance is executed and
A B the execution results are reflected in bit 1.0 and word D10.
• When the input to EN is OFF, the instance is not executed,
bit 1.0 is turned OFF, and the content of D10 is not changed.

Operation when the The system calls a function block when the input to the function block’s EN
Instance Is Executed input variable is ON. When the function block is called, the system generates
the instance’s variables and copies the algorithm registered in the function
block. The instance is then executed.
Pulse_2sON_1sOFF
Algorithm (Body)
1.0
P_On CLOCK PULSE tim_b
EN ENO TIMX tim_a OFF_TIME
&20
ON_TIME
1. The FB is called.
tim_a
TIMX tim_b ON_TIME
&10 OFF_TIME
ENO
2. The system generates the instance
variables and copies the algorithm.

FB instance (Pulse_2sON_1sOFF)
Usage Name Value
Internal 200-100ms_PULSE_tim_a ---
Internal 200-100ms_PULSE_tim_b ---
Input 200-100ms_PULSE_ON_TIME &20
Input 200-100ms_PULSE_OFF_TIME &10

3. The contents of the

Algorithm (Image) instance are executed.
Pulse_2sON_1sOFF tim_b
Pulse_2sON_1sOFF tim_a Pulse_2sON_1sOFF OFF_TIME

Pulse_2sON_1sOFF tim_a
Pulse_2sON_1sOFF tim_b Pulse_2sON_1sOFF ON_TIME

Pulse_2sON_1sOFF ENO

The order of execution is as follows:

1. Read data from parameters to input variables.
2. Execute the algorithm.
3. Write data from output variables to parameters.

44
Instance Specifications Section 2-2

Input to EN is ON.

Parameters 1. Read values from parameters

to input variables.

2. Execute the algorithm.

3. Write values from output Parameters

variables to parameters.

Data cannot be exchanged with parameters in the algorithm itself.

In addition, if an output variable is not changed by the execution of the algo-
rithm, the output parameter will retain its previous value.
Operation when the When the input to the function block’s EN input variable is OFF, the function
Instance Is Not Executed block is not called, so the internal variables of the instance do not change (val-
ues are retained). In the same way the output variables do not change when
EN is OFF (values are retained).
Program FB definition
Body
P_Off FB 1.0
P_On
EN ENO
ENO

Internal
variable a

Execution results:
Output variable 1.0 is turned OFF, but
internal variable a retains its previous value.

Program
If the programming were entered
directly into the program instead of in a
P_Off P_On 1.0 function block definition, both bit 1.0
and variable a would be turned OFF.
Internal
variable a

!Caution An instance will not be executed while its EN input variable is OFF, so Differ-
entiation and Timer instructions will not be initialized while EN is OFF. If Differ-
entiation or Timer instructions are being used, use the Always ON Flag
(P_On) for the EN input condition and include the instruction’s input condition
within the function block definition.

Nesting With CX-Programmer Ver. 6.0 and later versions, a function block can be
called from another function block, i.e., nesting is supported. Function blocks
can be nested up to 8 levels (including the function block called from the pro-
gram).
The calling function block and called function block can be either ST lan-
guage, ladder language, or either combination of the two.
Program FB0: Ladder diagram FB1: Ladder diagram FB7: Ladder diagram FB8: Ladder diagram
INSTANCE_FB0
INSTANCE_FB1 INSTANCE_FB2 INSTANCE_FB8
FB0
FB1 2nd FB2 FB8 8th
1st 7th

FB0 (ST) FB1 (ST) FB7 (ST) FB8 (ST)

Example: ; Example: Example: Example:

INSTANCE_FB1 (A:=FB1__OUT1,B=:>FB1_IN1) INSTANCE_FB2 (...,..) INSTANCE_FB8 (...,..)

"INSTANCE_FB1," "INSTANCE_FB2," etc., are the FUNCTION BLOCK data type instance names.
Note: Any combination of ladder diagrams and structured text programming can be used between the called and the calling function block.

45
Restrictions on Function Blocks Section 2-3

The function block nesting levels can also be displayed in a directory tree for-
mat with the FB Instance Viewer function.

The nested function blocks’ function block definitions are included in the func-
tion block library file (.cxf) containing the calling function block’s definitions.

2-3 Restrictions on Function Blocks

2-3-1 Ladder Programming Restrictions
There are some restrictions on instructions used in ladder programs.
Instructions Prohibited in The following instructions cannot be used in function block definitions. A com-
Function Block Definitions pile error will occur if any of these instructions is used.
• Block Programming Instructions (All instructions, including BPRG and
BEND)
• Subroutine Instructions (SBS, GSBS, RET, MCRO, SBN, GSBN, and
GRET)
• Jump Instructions (JMP, CJP, CJPN, and JME)
• Step Instructions (STEP and SNXT)
• Immediate Refresh Instructions (!)
• I/O REFRESH Instruction (IORF)
• TMHH and TMHHX Instructions
• FAILURE POINT DETECTION Instruction (FPD)
• Move Timer/Counter PV to Register Instruction (MOVRW)
AT Setting Restrictions Addresses in the following areas cannot be used for AT settings.
(Unsupported Data Areas)
• Index Registers (neither indirect nor direct addressing is supported) and
Data Registers
Note Input the address directly, not the AT setting.
• Indirect addressing of DM or EM Area addresses (Neither binary-mode
nor BCD-mode indirect addressing is supported.)
Direct Addressing of I/O • Addresses, not variables, can be directly input in Index Registers (both
Memory in Instruction indirect and direct addressing) and Data Registers.
Operands The following values can be input in instruction operands:
Direct addressing: IR0 to IR15; Indirect addressing: ,IR0 to ,IR15; Con-
stant offset (example): +5,IR0; DR offset: DR0,IR0; Auto-increment:
,IR0++; Auto-decrement: --,IR0
• Direct addressing in instruction operands is not supported for any other
areas in I/O memory.
Restrictions for Input Addresses in the following data areas cannot be used as parameters for input
Variables, Output variables, output variables, and input-output variables.
Variables, and Input-
Output Variables • Index Registers (neither indirect nor direct addressing is supported) and
(Unsupported Data Areas) Data Registers
• Indirect addressing of DM or EM Area addresses (Neither binary-mode
nor BCD-mode indirect addressing is supported.)

46
Restrictions on Function Blocks Section 2-3

Interlock Restrictions When a function block is called from an interlocked program section, the con-
tents of the function block definition will not be executed. The interlocked func-
tion block will behave just like an interlocked subroutine.
P_Off

IL
FB_BODY

FB

ILC

Interlocked Interlock will not

affect instructions in
the function block
definition.

Differentiation An instance will not be executed while its EN input variable is OFF, so the fol-
Instructions in Function lowing precautions are essential when using a Differentiation Instruction in a
Block Definitions function block definition. (Differentiation Instructions include DIFU, DIFD, and
any instruction with an @ or % prefix.)
• As long as the instance’s EN input variable is OFF, the execution condition
will retain its previous status (the last status when the EN input variable
was ON) and the Differentiation Instruction will not operate.
• When the instance’s EN input variable goes ON, the present execution
condition status will not be compared to the last cycle’s status. The
present execution condition will be compared to the last condition when
the EN input variable was ON, so the Differentiation Instruction will not
operate properly. (If the EN input variable remains ON, the Differentiation
Instruction will operate properly when the next rising edge or falling edge
occurs.)
Example:

0.0 Body
FB1
EN ENO LD EN
OR IN1
IN1 OUT1 SET OUT1

These Differentiation Instructions do not

operate when input condition 0.00 goes
from OFF to ON the first time.
The instructions do not operate while
input condition 0.00 is OFF.

If Differentiation Instructions are being used, always use the Always ON Flag
(P_On) for the EN input condition and include the instruction’s input condition
within the function block definition.

P _On Body
FB1
EN ENO LD a
OR I N1
0.00 a O UT1 SET OUT1

IN 1
The EN input condition is always ON, so
these Differentiation Instructions operate
normally.

• Input a decimal numerical value after “#” when specifying the first operand
of the following instructions.
MILH(517), MILR(518), MILC(519), DIM(631), MSKS(690), MSKR(692),
CLI(691), FAL(006), FALS(007), TKON(820), TKOF(821)
Note “&” is not supported.

47
Restrictions on Function Blocks Section 2-3

• CNR(545), CNRX(547) (RESET TIMER/COUNTER) instructions cannot

be used to reset multiple timers and counters within a function block at the
same time.
Always specify the same variable for the first operand (timer/counter num-
ber 1) and second operand (timer/counter number 2). Different variables
cannot be specified for the first and second operand.
Timer Instructions in An instance will not be executed while its EN input variable is OFF, so the fol-
Function Block Definitions lowing precautions are essential when using a Timer Instruction in a function
block definition.
The Timer Instruction will not be initialized even though the instance’s EN
input variable goes OFF. Consequently, the timer’s Completion Flag will not be
turned OFF if the EN input variable goes OFF after the timer started operat-
ing.

Body
0.00 FB1
EN ENO LD EN
TI M t i m U P
UP

The timer’s Completion Flag (UP)

will not be turned OFF even though
input condition 0.00 goes OFF.

If Timer Instructions are being used, always use the Always ON Flag (P_On)
for the EN input condition and include the instruction’s input condition within
the function block definition.

P _On Body
FB1
EN ENO LD a
TI M t i m U P
0.00 a UP

The timer’s completion flag (UP) is turned

OFF when input condition a (0.00) goes OFF.

• If the same instance containing a timer is used in multiple locations at the

same time, the timer will be duplicated.

2-3-2 ST Programming Restrictions

• Only the following statements and operators are supported.
• Assignment statements
• Selection statements (CASE and IF statements)
• Iteration statements (FOR, WHILE, REPEAT, and EXIT statements)
• RETURN statements
• Function block calling statements
• Arithmetic operators
• Logical operators
• Comparison operators
• Numerical functions
• Arithmetic functions
• Standard text string functions
• Numeric text string functions
• OMRON expansion functions

48
Restrictions on Function Blocks Section 2-3

• Comments
• The TIMER and COUNTER data types cannot be used.
For further details, refer to Appendix B Structured Text Specifications.

2-3-3 Programming Restrictions

Restrictions in Locating Function Block Instances
No Branches to the Left of Branches are not allowed on the left side of the instance. Branches are
the Instance allowed on the right side.
Incorrect Correct
FB FB

Instruction

Instruction

Only One Instance per A program rung cannot have more than one instance.
Rung
Incorrect Correct
FB

FB FB

No Function Block A function block’s input cannot be connected to another function block’s out-
Connections put. In this case, a variable must be registered to transfer the execution status
from the first function block’s output to the second function blocks input.
0.0
0.0
FB1 FB1
EN FB2 EN
XIN1 D3000
XOUT XOUT

0.0
D100 XIN2
FB2 Temporary variables
EN transfer the value from
FB1 to FB2.
D3000
XIN1

D100
XIN2

Downloading in Task Tasks including function blocks cannot be downloaded in task units, but
Units uploading is possible.

Programming When a user program created with the CX-Programmer is downloaded to the
Console Displays CPU Unit and read by a Programming Console, the instances will all be dis-
played as question marks. (The instance names will not be displayed.)

Online Editing The following online editing operations cannot be performed on the user pro-
Restrictions gram in the CPU Unit.
• Changing or deleting function block definitions (variable table or algo-
rithm)
• Inserting instances or changing instance names

49
Restrictions on Function Blocks Section 2-3

Note The instance’s I/O parameters can be changed, instances can be

deleted, and instructions outside of an instance can be changed.

Error-related If a fatal error occurs in the CPU Unit while a function block definition is being
Restrictions executed, ladder program execution will stop at the point where the error
occurred.
Program FB definition
Instance name Body
LD P_On
0.0 FB 10.0
++ AAA
EN ENO
Fatal error occurs here.
MOV AAA BBB
D100 AAA BBB D200

In this case, the MOV AAA BBB instruction will not be executed and output
variable D200 will retain the same value that it had before the function block
was executed.

Prohibiting Access to To use a function block, the system requires memory areas to store the
FB Instance Areas instance’s internal variables, input variables, output variables, and input-out-
put variables.
CS/CJ-series CPU Units Ver. 3.0 or Later, CP-series PLCs, and NSJ
Controllers
Function block instance Initial value of Initial value Allowed data areas
area start address of size
Non-retained H512 896 CIO, WR, HR, DM, EM
Retained H1408 128 HR, DM, EM
Timer T3072 1,024 TIM
Counter C3072 1,024 CNT

FQM1 Flexible Motion Controllers

FB Instance Default value Applicable memory
Area Start address End address Size areas
Non Retain 5000 5999 1000 CIO, WR, DM
Retain None
Timers T206 T255 50 TIM
Counters C206 C255 50 CNT

If there is an instruction in the user program that accesses an address in an

FB instance area, the CX-Programmer will output an error in the following
cases.
• When a program check is performed by the user by selecting Program -
Compile from the Program Menu or Compile All Programs from the
PLC Menu.
• When attempting to write the program through online editing (writing is
not possible).

50
Function Block Applications Guidelines Section 2-4

2-4 Function Block Applications Guidelines

This section provides guidelines for using function blocks with the CX-Pro-
grammer.

2-4-1 Deciding on Variable Data Types

Integer Data Types Use the following data types when handling single numbers in 1, 2, or 4-word
(1, 2, or 4-word Data) units.
• INT and UINT
• DINT and DINT
• LINT and ULINT
Note Use signed integers if the numbers being used will fit in the range.
Word Data Types Use the following data types when handling groups of data (non-numeric
(1, 2, or 4-word Data) data) in 1, 2, or 4-word units.
• WORD
• DWORD
• LWORD
Text String Data Use the following data type for text string data.
• STRING

2-4-2 Determining Variable Types (Inputs, Outputs, In Out, Externals,

and Internals)
Using Input Variable to To paste a function block into the program and then change the value (not the
Change Passed Values address itself) to be passed to the function block for each instance, use an
input variable.
Program
Instance for function block definition A
The value itself is
passed

&3 Unit No.

&50 PARA

Changing the pass value to an input variable.

The following two restrictions apply.

• An address can be set in an input parameter, but an address itself cannot
be passed to an input variable (even if an address is set in the input
parameter, the value for the size of the input variable data type is passed
to the function block). Therefore, when the first or last of multiple words is
specified in the instruction operand within the function block, an input vari-
able cannot be used for the operand. Specify either to use internal vari-
ables with AT settings, specify the first or last element in an input-output
array variable (set the input parameter to the first address) (CX-Program-
mer version 7.0 or higher), specify the first or last element in an internal
array variable, or use an external variable (as described in 2-4-4 Array
Settings for Input-Output Variables and Internal Variables).

51
Function Block Applications Guidelines Section 2-4

Program An input variable cannot be used to specify

the address of an operand that specifies
Instance for function block definition A the first (or last) address of multiple words.
The actual value is For example, the XFER (BLOCK
passed TRANSFER) instruction cannot be used to
If the size of the data type in transfer 10 words from the address
DATA_1 is 1 word, the value beginning with DATA_1 to the address
D00100 DATA_1 for the word D00100 is beginning with DATA_2.
passed.
W500 DATA_2
XFER
If the size of the data type in
&10
DATA_2 is 2 words, the value
for the 2 words W500 and DATA_1
W501 is passed. DATA_2

The address can be specified, but the address itself is not passed.

• Values are passed in a batch from the input parameters to the input vari-
ables before algorithm execution (not at the same time as the instruction
in the algorithm is executed). Therefore, to pass the value from a parame-
ter to an input variable when the instruction in the function block algorithm
is executed, use an internal variable or external variable instead of an
input variable.
Passing Values from or To paste into the program and then pass values outside (the program) from
Monitoring Output the function block for each instance, or monitor values, use output variables.
Variables
Program
Instance for function block definition A.
The actual value is
passed.
OK_Flag W0.00

NG_ Flag W0.01

Variable for passing a value outside or monitoring:

Use an output variable.

The following restrictions apply.

• Values are passed from output variables to output parameters all at once
after algorithm execution.
Input-Output Variables to An input-output variable can be used to implement the functionality of both
Return FB Processing input and output parameters. Internal operation involves passing the address
Results from Values set for the parameter to the input-output variable, but the use of the input-out-
Passed from Input
Parameters to Output put variable inside the function block is the same as that of other variables.
Parameters
Program Section
Instance of FB definition A
Specify an address for the input parameter;
the address will be passed to the FB.

D100 a a D100
D100 can be used
in the rest of the
program after being
changed in the FB.
Use an input-output variable to implement Contents can be changed in the FB.
both input and output variable functions
while changing the value in the FB.
This address D100 a "a" indicates D100.
is passed. (Example: WORD data type)

52
Function Block Applications Guidelines Section 2-4

Input-Output Array Input-output variables can be set as arrays (which is not possible for input
Variables to Pass Large variables and output variables). If an input-output array variable is used, a
Amounts of Data range of addresses of the specified size starting from the address set for the
input parameter can be used inside the FB. Input-output variables should thus
be used when it’s necessary to pass large quantities of data to a function
block.
Program Section
Instance of FB definition A
Specify an address for the input parameter;
the address will be passed to the FB.

D200 Data Data D200

D200 to D2009 can

be used in the rest
of the program after
being changed in
the FB.
Use an input-output variable to pass large
quantities of data to the FB (only the first Contents can be changed in the FB.
address is actually passed).
This address D200 Data "Data[0]" indicates D200.
is passed. D201 WORD data "Data [1]" indicates D201
Array setting Etc.
10 elements
D209

External Variables: Condition Flags (e.g., Always ON Flag, Equals Flag), Clock Pulses (e.g., 1.0
Condition Flags, Clock second clock pulse bit), pre-registered Auxiliary Area Bits (e.g., First Cycle
Pulses, Auxiliary Area Flag), and global symbols used in the program are all external variables
Bits, Global Symbols in
Program defined by the system.

Internal Variables: Variables that are not specified as Inputs, Outputs, In Out, or Externals are
Internally Allocated Internals. Internal variables include variables with internally allocated
Variables and Variables addresses and variables requiring addresses with AT settings (e.g., I/O alloca-
Requiring AT Settings
tion addresses, addresses specially allocated for Special I/O Units). Variables
requiring array settings include input-output variables and internal variables.
For details on conditions requiring AT settings or array settings, refer to 2-4-3
AT Settings for Internal Variables, and 2-4-4 Array Settings for Input-Output
Variables and Internal Variables.

2-4-3 AT Settings for Internal Variables

Always specify AT settings for internal variables under the following condi-
tions.
• When addresses allocated to Basic I/O Units, Special I/O Units, or CPU
Bus Units are used and these addresses are registered to global symbols
that cannot be specified as external variables (e.g., data set for global
symbols is unstable).
Note The method for specifying Index Registers for Special I/O Unit allo-
cation addresses requires AT settings to be specified for the first
address of the allocation area. (For details, refer to 2-4-5 Specifying
Addresses Allocated to Special I/O Units.)
• When Auxiliary Area bits that are not pre-registered to external variables
are used, and these bits are registered to global symbols that are not
specified as external variables.
• When setting the first destination word at the remote node for SEND(090)
and the first source word at the local node for RECV(098).
• When the instruction operand specifies the first or last of multiple words,
and an array variable cannot be specified for the operand (e.g., the num-
ber of array elements cannot be specified).

53
Function Block Applications Guidelines Section 2-4

2-4-4 Array Settings for Input-Output Variables and Internal Variables

Using Array Variables When specifying the first or last of a range of words in an instruction operand
to Specify First or Last (see note), the instruction operates according to the address after AT specifi-
Word in Multiword cation or internal allocation. (Therefore, the variable data type and number of
Operands
elements for the variable are unrelated to the operation of the instruction.) Al-
ways specify a variable with an AT setting or an array variable with a number
of elements that matches the data size to be processed by the instruction.
Note Some examples are the first source word or first destination word of the
XFER(070) (BLOCK TRANSFER) instruction, the first source word for
SEND(090), or control data for applicable instructions.
For details, refer to 2-5 Precautions for Instructions with Operands Specifying
the First or Last of Multiple Words. Use the following method to specify an array
variable.
When using input-output variables, set the input parameter to the first address
of multiple words.
Use the following procedure for internal variables.

1,2,3... 1. Prepare an internal array variable with the required number of elements.
Note Make sure that the data size to be processed by the instruction is
the same as the number of elements. For details on the data sizes
processed by each instruction, refer to 2-6 Instruction Support and
Operand Restrictions.
2. Set the data in each of the array elements using the MOV instruction in the
function block definition.
3. Specify the first (or last) element of the array variable for the operand. This
enables specification of the first (or last) address in a range of words.
Examples are provided below.
Handling a Single String of Data in Multiple Words
In this example, an array contains the directory and filename (operand S2) for
an FREAD instruction.
• Variable Table
Input-output variable or internal variable, data type = WORD, array setting
with 10 elements, variable names = filename[0] to filename[9]
• Data Settings and Internal Function Block Processing
• Input-output variables:
Set the input parameter to the address of the first word in the data (ex-
ample: D100). The data (#5C31, #3233, #0000, etc.) is set in D100 to
D109 in advance from the main user program.
FREAD (omitted) (omitted) read_num[0] (omitted) Specify the first element of the array
in the instruction operand.

• Internal variables:
Use ladder programming within the function block to set data into the
array.
MOV #5C31 file_name[0]
MOV #3233 file_name[1] Set data in each array element.
MOV #0000 file_name[2])
FREAD (omitted) (omitted) file_name[0] (omitted) Specify the first element
of the array in the instruction
operand.

54
Function Block Applications Guidelines Section 2-4

Handling Control Data in Multiple Words

In this example, an array contains the number of words and first source word
(operand S1) for an FREAD instruction.
• Variable table
Input-output variable or internal variable, data type = DINT, array setting
with 3 elements, variable names = read_num[0] to read_num[9]
• Data Settings and Internal Function Block Processing
• Input-output variables:
Set the input parameter to the address of the first word in the data (ex-
ample: D200). The data is set in D200 to D205 in advance from the
main user program.
FREAD (omitted) read_num[0] (omitted) (omitted) Specify the first element of the array
in the instruction operand.

• Internal variables:
Use ladder programming within the function block to set data into the
array.
• Ladder Programming
MOVL &100 read_num[0] (No._of_words)
Set data in each array element.
MOVL &0 read_num[1] (1st_source_word)

FREAD (omitted) read_num[0] (omitted) (omitted) Specify the first element of the array
in the instruction operand.

Handling a Block of Read Data in Multiple Words

The allowed amount of read data must be determined in advance and an
array must be prepared that can handle the maximum amount of data. In this
example, an array receives the FREAD instruction’s read data (operand D).
• Variable table
Input-output variable or internal variable, data type = WORD, array setting
with 100 elements, variable names = read_data[0] to read_data[99]
• Data Settings and Internal Function Block Processing
• Input-output variables:
Set the input parameter to the address of the first word in the read data
(example: D200).
FREAD (omitted) (omitted) (omitted) read_data[0]

• Internal variables:
FREAD (omitted) (omitted) (omitted) read_data[0]

Division Using Integer A two-element array can be used to store the result from a ladder program’s
Array Variables (Ladder SIGNED BINARY DIVIDE (/) instruction. The result from the instruction is D
Programming Only) (quotient) and D+1 (remainder). This method can be used to obtain the remain-
der from a division operation in ladder programming.
Note When ST language is used, it isn’t necessary to use an array to receive the
result of a division operation. Also, the remainder can’t be calculated directly
in ST language. The remainder must be calculated as follows:
Remainder = Dividend − (Divisor × Quotient)

2-4-5 Specifying Addresses Allocated to Special I/O Units

Use Index Registers IR0 to IR15 (indirectly specified constant offset) to spec-
ify addresses allocated to Special I/O Units based on the value passed for the
unit number as an input parameter within the function block definition as
shown in the following examples.

55
Function Block Applications Guidelines Section 2-4

Note For details on using Index Registers in function blocks, refer to 2-4-6 Using
Index Registers.
Examples
Example 1: Specifying the CIO Area within a Function Block (Same for DM
Area)
Special I/O Units
Variables: Use the unit number as an input variable, and specifying the first
allocation address as an internal variable with the AT set to CIO 2000.
Programs: Use the following procedure.

1,2,3... 1. Multiply the unit number (input variable) by &10, and create the unit num-
ber offset (internal variable, DINT data type).
2. Use the MOVR(560) (MOVE TO REGISTER) instruction to store the real I/
O memory address for the first allocation address (internal variable, AT =
CIO 2000) in the Index Register (e.g., IR0).
3. Add the unit number offset to the real I/O memory address within the Index
Register (e.g., IR0).
Example 2: Specifying the Designated Bit in the CIO Area (e.g., CIO Word
n+a, Bit b)
Programs: Use either of the following methods.
• Word addresses: Specify the constant offset of the Index Register using
an indirect specification (e.g., +a,IR0).
• Bit addresses: Specify an instruction that can specify a bit address within
a word (e.g., &b in second operand of SETB instruction when writing and
TST instruction when reading).
Example: Special I/O Units
1) Specify the first CIO Area word n (n = CIO 2000 + unit number × 10)
Instance for function block definition A. Used constants:
Unit number (input variable, INT data type)
Offset (internal variable, DINT data type)
Relay (internal variable, WORD data type, 400 array elements, AT
setting = 2000)
&3 Unit No.

Multiplies unit number by

&10 &10 and stores in offset.
Unit No.
Offset

MOVR Stores the real I/O memory

Relay address for the relay in IR0.
IR0

+L Adds offset to IR0.

IR0
Offset
IR0

2) Specify the designated bit in the CIO

Area (e.g., CIO word n+1, bit 02)

SETB Turns ON CIO word n+1,

+1,IR0 bit 02.
&2

56
Function Block Applications Guidelines Section 2-4

2-4-6 Using Index Registers

Index Registers IR0 to IR15 function as pointers for specifying I/O memory
addresses. These Index Registers can be used within function blocks to
directly specify addresses using IR0 to IR15 and not the variable names
(Index Register direct specification: IR0 to IR15; Index Register indirect speci-
fication: ,IR0 to ,IR15)
Note After storing the real I/O memory addresses in the Index Registers using the
MOVR(560) instruction, Index Registers can be indirectly specified using gen-
eral instructions. This enables all I/O memory areas to be specified dynami-
cally.

Pointer All I/O memory

areas

MOVR(560)

IR@

Index Register
Example: Specifying +5,IR0 using
constant offset specification, not Specify address
variable name in IR0 I/O memory
Function block
Indirect +5 offset
specifi-
Instruction
cation Specify ad-
+5,IR0
a
dress at +5
IR0 offset from
IR0.

57
Function Block Applications Guidelines Section 2-4

Note (1) When Index Registers IR0 to IR15 are used within function blocks, using
the same Index Register within other function blocks or in the program
outside of function blocks will create competition between the two in-
stances and the program will not execute properly. Therefore, when using
Index Registers (IR0 to IR15), always save the value of the Index Register
at the point when the function block starts (or before the Index Register
is used), and when the function block is completed (or after the Index
Register has been used), incorporate processing in the program to return
the Index Register to the saved value.
Example: Starting function block (or before using Index Register):
1. Save the value of IR (e.g., A).
Value A
Value A
IR0

Within function block:

2.Use IR.
Value B

IR0

At start of function block (or before Index Register is used):

3. Return IR to saved valuev(e.g., A)
Value A
Value A
IR0

(2) Always set the value before using Index Registers. Operation will not be
stable if Index Registers are used without the values being set.

Application Examples The following examples are for using Index Registers IR0 to IR15 within func-
tion blocks.
Example Details
Saving the Index Register Value before Using Index Register When Index Registers are used within this
Store IR0 temporarily in backup buffer function block, processing to save the Index
Register value is performed when the func-
tion starts (or before the Index Register is
used) to enable the value to be returned to
the original Index Register value after the
function block is completed (or after the
Index Register is used).
Example: Save the contents of Index Regis-
ter IR0 by storing it in SaveIR[0] (internal
variable, data type DINT, 1 array element).

58
Function Block Applications Guidelines Section 2-4

Example Details
Using Index Registers Example: The real I/O memory address for
1) Setting the value in the Index Register. (Stores the real I/O memory the first word of CIO 1500 + unit number ×
address for first CIO Area word n.) 25 allocated in the CPU Bus Unit allocation
area based on the CPU Bus Unit’s unit
number (&0 to &15) passed from the func-
tion block is stored in IR0.
Calculate offset address from unit number Procedure:
Assumes that unit numbers &0 to &15 have
already been input (from outside the func-
tion block) in UnitNo (input variables, INT
data type).
1. Multiple UnitNo by &25, and store in Off-
set (internal variable, DINT data type)
2. Store the real I/O memory address for
SCPU_Relay (internal variable, WORD
data type, (if required, specify the array as
400 elements (see note), AT setting =
1500)) in Index Register IR0.
Note Specifying an array for SCPU_relay,
such as SCPU_relay [2], for example,
enables the address CIO 1500 +
(UnitNo × &25) + 2 to be specified.
This also applies in example 2 below.
3. Increment the real I/O memory address
in Index Register IR0 by the value for the
variable Offset (variable UnitNo × &25).
2) Specifying constant offset of Index Register (Specifying a bit between The real I/O memory address for CIO 1500
CIO n+0 to n+24) + (UnitNo × &25) is stored in Index Register
IR0 by the processing in step 1 above.
Therefore the word address is specified
using the constant offset from IR0.
For example, specifying +2,IR0 will specify
CIO 1500 + (UnitNo × &25) + 2.
Note CIO 1500 + (UnitNo × &25) + 2 can
also by specified by specifying
SCPU_relay [2] using the array set-
ting with SCPU_relay.
Specify bit addresses using instructions that
can specify bit addresses within words
(e.g., second operand of TST(350/351)/
SETB(532) instructions).
Check local node data link participation Example: Variable NodeSelf_OK turns ON
when NetCheck_OK (internal variable,
BOOL data type) is ON and bit 15 of the
word at the +6 offset from IR0 (CIO 1500 +
UnitNo × &25 +6) is ON.

Returning the Index Register to the Prior Value The Index Register returns to the original
Restore data to IR0 from temporary backup buffer value after this function block is completed
(or after the Index Register has been used).
Example: The value for variable SaveIR[0]
that was saved is stored in Index Register
IR0, and the value is returned to the con-
tents from when this function started (or
prior to using the Index Register).

59
Precautions for Instructions with Operands Specifying the First or Last of Multi- Section 2-5

2-5 Precautions for Instructions with Operands Specifying the

First or Last of Multiple Words
When using ladder programming to create function blocks with instruction
operands specifying the first or last of a range of words, the following precau-
tions apply when specifying variables for the operand.
When the operand specifies the first or last word of multiple words, the
instruction operates according to the internally allocated address for AT set-
ting (or external variable setting). Therefore, the variable data type and num-
ber of array elements are unrelated to the operation of the instruction. Either
specify a variable with an AT setting, or an array variable with a size that
matches the data size to be processed by the instruction.
For details on whether an AT setting (or external variable setting) or an array
setting for a number of elements is required to specify the first address of a
range of words in the instruction operand, refer to 2-6 Instruction Support and
Operand Restrictions.
Note To specify the first or last of multiple words in an instruction operand, always
specify a variable with AT setting (or an external variable), or a variable with
the same size as the data size to be processed in the instruction. The follow-
ing precautions apply.

1,2,3... 1. If a non-array variable is specified without AT setting and without a match-

ing data size, the CX-Programmer will output an error when compiling.
2. The following precautions apply to when an array variable is specified.
Size to Be Processed in the Instruction Operand Is Fixed
Make sure that the number of elements in the array is the same as size to be
processed by the instruction. Otherwise, the CX-Programmer will output an
error when compiling.
Size to Be Processed in the Instruction Operand Is Not Fixed
Make sure that the number of elements in the array is the same or greater
than the size specified by another operand.
Other Operand Specifying Size: Constant
The CX-Programmer outputs an error when compiling.
Other Operand Specifying Size: Variable
The CX-Programmer will not output an error when compiling (a warning mes-
sage will be displayed) even if the number of elements in the array does not
match the size specified in another operand (variable).
In particular, when the number of elements in the array is less than the size
specified by another operand, (for example, when instruction processing size
is 16 and the number of elements actually registered in the variable table is
10), the instruction will execute read/write processing in the areas exceeding
the number of elements. (In this example, read/write processing will be exe-
cuted for the next 6 words after the number of elements registered in the
actual variable table.) If the same area is being used by another instruction
(including internal variable allocations), unexpected operation may occur,
which may result in a serious accident.

60
Precautions for Instructions with Operands Specifying the First or Last of Multi- Section 2-5

Do not use variables with a size that does not match the data size to be pro-
cessed by the instruction in the operand specifying the first address (or last
address) for a range of words. Always use either non-array variables data type
with a size that is the same as the data size required by the instruction or
array variable with the number of elements that is the same as the data size
required by the instruction. Otherwise, the following errors will occur.
Non-array Variables If the operand specifying the first address (or last address) of multiple words
without Matching Data uses a non-array variable data type with a size that does not match the data
Size and without AT size required by the instruction and an AT setting is also not used, the CX-Pro-
Setting
grammer will output a compile error.
Example: BLOCK TRANSFER(070) instruction: XFER W S D
(W: Number of words, S: First source word; D: First destination word)
When &10 is specified in W, variable a with data type WORD is specified in S,
and variable b with data type WORD is specified in D: XFER &10 a b
The XFER(070) instruction will transfer the data in the 10 words beginning from
the automatically allocated address in variable a to the 10 words beginning
with the automatically allocated address in variable b. Therefore, the CX-Pro-
grammer will output a compile error.
Example: XFER &10 a b
(variables a and b are WORD data types)

Internally allocated address Internally allocated address

Example: H700 Variable a (1 word) Example: H7@@ Variable b (1 word)
10 words are
transferred regard-
less of the size of
variable a.
This area will be overwritten,
so the CX-Programmer will
output a compile error.

Array Variables The result depends on the following conditions.

Size to Be Processed by Instruction Is Fixed
If the size to be processed by the instruction is a fixed operand, and this size
does not match the number of array elements, the CX-Programmer will output
a compile error.
Example: LINE TO COLUMN(064) instruction; COLM S D N
(S: Bit number, D: First destination word, N: Source word)
E.g., COLM a b[0] c
If an array for a WORD data type with 10 array elements is specified in D
when it should be for 16 array elements, the CX-Programmer will output an
error when compiling.
Size to Be Processed by Instruction Is Not Fixed
When the operand size to be processed by the instruction is not fixed (when
the size is specified by another operand in the instruction), make sure that the
number of array elements is the same or greater than the size specified in the
other operand (i.e., size to be processed by the instruction).
Other Operand Specifying Size: Constant
The CX-Programmer will output an error when compiling.
Example: BLOCK TRANSFER: XFER W S D
(W: Number of words, S: First source word; D: First destination word)

61
Instruction Support and Operand Restrictions Section 2-6

When &20 is specified in W, array variable a with data type WORD and 10
elements is specified in S, and array variable b with data type WORD and 10
elements is specified in D:
XFER &20 a[0] b[0]
Even though the array variables a[0] and b[0] are both 10 words, the
XFER(070) instruction will execute transfer processing for the 20 words spec-
ified in W. As a result, the XFER(070) instruction will perform read/write pro-
cessing for the I/O memory area following the number of array elements that
was allocated, as shown in the following diagram.
Therefore, if a[10 elements] is internally allocated words (e.g., H700 to H709),
and b[10 elements] is internally allocated words (e.g., H800 to H809),
XFER(070) will transfer data in words H700 to H719 to words H800 to H819.
In this operation, if another internally allocated variable (e.g., c), is allocated
words in H810 to H819, the words will be overwritten, causing unexpected
operation to occur. To transfer 20 words, make sure that the number of ele-
ments is specified as 20 elements for both array variable a and b.
XFER &20 a[0] b[0]
Using a WORD data type with 10 elements for both variables a and b:
To transfer 20 words, be sure to specify 20 elements for both array variables a and b.

Internally allocated address Internally allocated address

Example: H700
Array variable Array variable
10 words a (10 words) a (10 words) 10 words
20 words

Example: H710
Example: H810
20 words will be
transferred regard- The variables allocated in this area
less of the size of ar- (H810 to H819 in this example) are
Example: H719 ray variables a and b. overwritten. The data is variable-
length data, so the CX-Programmer
Example: H819 will not output a compile error.

Other Operand Specifying Size: Variable

Even if the number of array elements does not match the size (i.e., size to be
processed by the instruction) specified in another operand (variable), the CX-
Programmer will not output an error when compiling. The instruction will be
executed according to the size specified by the operand, regardless of the
number of elements in the array variable.
Particularly if the number of elements in the array is less than the size (i.e.,
size to be processed by the instruction) specified by another operand (vari-
able), other variables will be affected and unexpected operation may occur.

2-6 Instruction Support and Operand Restrictions

The tables in this appendix indicate which instructions can be used in function
blocks created with ladder programming language, the restrictions that apply
to them and to the operands, including the variables (whether array variables
and AT settings or external variable specifications are required, and which
data types can be used).
Instruction Support Instructions that are not supported for use in function block definitions by the
CX-Programmer, CP-series CPU Units, and CS/CJ-series CPU Units with unit
version 3.0 are given as Not supported in function blocks in the Symbol col-
umn.

62
Instruction Support and Operand Restrictions Section 2-6

Restrictions on Operands • Operands that specify the first or last of multiple words, thereby requiring
AT setting or specification of array variables, are indicated as follows in
the AT setting or array required column.
Yes: An AT setting (or external specification) or array variable must be
specified for the operand to specify the first or last of multiple words.
• The value within parentheses is the fixed size used by the instruction
for reading, writing, or other processing. This size indicates either the
data type size or the size required for the array variable specified in
word units. For array variables, this size must be the same as the num-
ber of elements. Otherwise, the CX-Programmer will output an error
when compiling.
• If “not fixed” is indicated in parentheses, the size used by the instruc-
tion for reading, writing, or other processing can be changed. Make
sure that the maximum size required for the number of array elements
is provided.
Even if the number of array elements in an operand with unfixed size
does not match the size specified in another operand, the CX-Pro-
grammer will not output an error when compiling. The instruction will
operate according to the size specified in the other operand, regard-
less of the number of array variable elements.
---: Operands that do not require an AT setting or specification of array vari-
ables.
Note When specifying the first or last word of multiple words in an in-
struction operand, input parameters cannot be used to pass data
to or from variables. Either an AT setting must be used or one of the
following must be used: 1) An input-output variable set to an array
must be used and the address of the first word must be set for the
input parameter (CX-Programmer version 7.0 or higher) or 2) An
array variable with the required number of elements must be pre-
pared, and after the array data is set in the function block definition,
the first or last element in the array variable must be specified for
the operand.
• Any operands for which an AT setting must be specified for an I/O mem-
ory address on a remote node in the network are indicated as Specify
address at remote node with AT setting in the AT setting or array required
column.
The following table lists all of the instructions supported by the CS/CJ-series
CPU Units, CP-series CPU Units, NSJ-series NSJ Controllers, and FQM1
Flexible Motion Controllers (unit version 3.0 or later).
• Some instructions are supported only by FQM1 Flexible Motion Control-
lers (unit version 3.0 or later). These are indicated by “FQM1 only” under
the mnemonic.
• There are also instructions that are supported only by the CS/CJ-series
CPU Units, CP-series CPU Units, and NSJ-series NSJ Controllers, i.e.,
that cannot be used by the FQM1 Flexible Motion Controllers (unit version
3.0 or later). Refer to the FQM1 Instructions Reference Manual (Cat. No.
O013) to confirm the instructions that are supported.

63
Instruction Support and Operand Restrictions Section 2-6

2-6-1 Sequence Input Instructions

Instruction Mnemonic Function Symbol Operands Supported AT setting or
code variable array variable
data types required
(Required word
data size
shown in
parentheses.)
LOAD LD Bus bar B: Bit BOOL ---
@LD
%LD
!LD
Starting point of block
!@LD
!%LD

LOAD NOT LD NOT Bus bar B: Bit BOOL ---

!LD NOT
@LD NOT
%LD NOT
Starting point of block
!@LD NOT
!%LD NOT

AND AND B: Bit BOOL ---

@AND
%AND
!AND
!@AND
!%AND
AND NOT AND NOT --- BOOL ---
!AND NOT
@AND NOT
%AND NOT
!@AND NOT
!%AND NOT
OR OR Bus bar --- BOOL ---
@OR
%OR
!OR
!@OR
!%OR

OR NOT OR NOT Bus bar --- BOOL ---

!OR NOT
@OR NOT
%OR NOT
!@OR NOT
!%OR NOT

AND LOAD AND LD Logic block Logic block

--- --- ---

64
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT setting or

code variable array variable
data types required
(Required word
data size
shown in
parentheses.)
OR LOAD OR LD --- --- ---
Logic block

Logic block

NOT NOT 520 --- --- ---

NOT

CONDITION UP 521 --- --- ---

ON UP

CONDITION DOWN 522 --- --- ---

OFF DOWN

BIT TEST LD TST 350 S: Source word WORD ---

TST
N: Bit number UINT ---
S
N

BIT TEST LD TSTN 351 S: Source word WORD ---

TSTN
N: Bit number UINT ---
S
N

BIT TEST AND TST 350 S: Source word WORD ---

AND TST
N: Bit number UINT ---
S
N

BIT TEST AND TSTN 351 S: Source word WORD ---

AND TSTN
N: Bit number UINT ---
S
N

BIT TEST OR TST 350 S: Source word WORD ---

TST N: Bit number UINT ---

S
N

BIT TEST OR TSTN 351 S: Source word WORD ---

TSTN N: Bit number UINT ---

S
N

65
Instruction Support and Operand Restrictions Section 2-6

2-6-2 Sequence Output Instructions

Instruction Mnemonic Function Symbol Operands Supported AT setting or
code variable array variable
data types required
(Required
word data size
shown in
parentheses.)
OUTPUT OUT --- BOOL ---
!OUT

OUTPUT NOT OUT NOT --- BOOL ---

!OUT NOT

KEEP KEEP 011 S (Set) --- BOOL ---

KEEP
!KEEP
R (Reset)
B

DIFFERENTI- DIFU 013 --- BOOL ---

ATE UP DIFU
!DIFU
B

DIFFERENTI- DIFD 014 --- BOOL ---

ATE DOWN DIFD
!DIFD
B

SET SET B: Bit BOOL ---

SET
@SET
B
%SET
!SET
!@SET
!%SET
RESET RSET B: Bit BOOL ---
RSET
@RSET
B
%RSET
!RSET
!@RSET
!%RSET
MULTIPLE BIT SETA 530 D: Beginning word UINT Yes (not fixed)
SET SETA
@SETA N1: Beginning bit UINT ---
D
N2: Number of bits UINT ---
N1
N2

MULTIPLE BIT RSTA 531 D: Beginning word UINT Yes (not fixed)
RESET RSTA
@RSTA N1: Beginning bit UINT ---
D
N2: Number of bits UINT ---
N1
N2

66
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT setting or

code variable array variable
data types required
(Required
word data size
shown in
parentheses.)
SINGLE BIT SETB 532 D: Word address UINT ---
SETB
SET @SETB N: Bit number UINT ---
D
!SETB
N

SINGLE BIT RSTB 533 D: Word address UINT ---

RESET RSTB
@RSTB N: Bit number UINT ---
D
!RSTB
N

SINGLE BIT OUTB 534 D: Word address UINT ---

OUTPUT OUTB
@OUTB N: Bit number UINT ---
D
!OUTB
N

2-6-3 Sequence Control Instructions

Instruction Mnemonic Function Symbol Operands Supported AT setting or
code variable array variable
data types required
(Required
word data
size shown in
parentheses.)
END END 001 --- --- ---
END

NO OPERATION NOP 000 --- --- --- ---

INTERLOCK IL 002 --- --- ---
IL

INTERLOCK ILC 003 --- --- ---

CLEAR ILC

MULTI-INTER- MILH 517 N: Interlock number # + decimal ---

LOCK DIFFER- MILH only
ENTIATION N D: Interlock Status BOOL ---
HOLD D Bit

MULTI-INTER- MILR 518 N: Interlock number # + decimal ---

LOCK DIFFER- MILR only
ENTIATION N D: Interlock Status BOOL ---
RELEASE D Bit

MULTI-INTER- MILC 519 N: Interlock number # + decimal ---

LOCK CLEAR MILC only
N

JUMP JMP 004 Not supported in function N: Jump number --- ---
blocks
JUMP END JME 005 Not supported in function N: Jump number --- ---
blocks
CONDITIONAL CJP 510 Not supported in function N: Jump number --- ---
JUMP blocks
CONDITIONAL CJPN 511 Not supported in function N: Jump number --- ---
JUMP blocks

67
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT setting or

code variable array variable
data types required
(Required
word data
size shown in
parentheses.)
MULTIPLE JMP0 515 --- --- ---
JUMP JMP0

MULTIPLE JME0 516 --- --- ---

JUMP END JME0

FOR-NEXT FOR 512 N: Number of loops UINT ---

LOOPS FOR
N

BREAK LOOP BREAK 514 --- --- ---

BREAK

FOR-NEXT NEXT 513 --- --- ---

LOOPS NEXT

2-6-4 Timer and Counter Instructions

Instruction Mnemonic Function Symbol Operands Supported AT setting or
code variable array variable
data types required
(Required
word data
size shown in
parentheses.)
TIMER TIM N: Timer number TIMER ---
TIM
(BCD) S: Set value WORD ---
N
S

TIMX 550 N: Timer number TIMER ---

TIMX
(BIN) S: Set value UINT ---
N
S

HIGH-SPEED TIMH 015 N: Timer number TIMER ---

TIMH
TIMER (BCD) S: Set value WORD ---
N
S

TIMHX 551 N: Timer number TIMER ---

TIMHX
(BIN) S: Set value UINT ---
N
S

ONE-MS TIMER TMHH 540 Not supported in function N: Timer number TIMER ---
(BCD) blocks. S: Set value WORD ---
TMHHX 552 Not supported in function N: Timer number TIMER ---
(BIN) blocks. S: Set value UINT ---

68
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT setting or

code variable array variable
data types required
(Required
word data
size shown in
parentheses.)
ACCUMULA- TTIM 087 N: Timer number TIMER ---
TTIM
TIVE TIMER (BCD) S: Set value WORD ---
N
S

TTIMX 555 Timer input N: Timer number TIMER ---

TTIMX
(BIN) S: Set value UINT ---
N
Reset input
S

LONG TIMER TIML 542 D1: Completion WORD ---

TIML Flag
(BCD)
D1 D2: PV word DWORD ---
D2 S: SV word DWORD ---
S

TIMLX 553 D1: Completion UINT ---

TIMLX Flags
(BIN)
D1 D2: PV word UDINT ---
D2 S: SV word UDINT ---
S

MULTI-OUTPUT MTIM 543 D1: Completion UINT ---

TIMER MTIM Flags
(BCD)
D1 D2: PV word WORD ---
D2 S: 1st SV word WORD Yes (8)
S

MTIMX 554 D1: Completion UINT ---

MTIMX Flags
(BIN)
D1 D2: PV word UINT ---
D2 S: 1st SV word WORD Yes (8)
S

COUNTER CNT Count input N: Counter number COUNTER ---

CNT
(BCD) S: Set value WORD ---
N
Reset input
S

CNTX 546 Count input N: Counter number COUNTER ---

CNTX
(BIN) S: Set value UINT ---
N
Reset input
S

69
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT setting or

code variable array variable
data types required
(Required
word data
size shown in
parentheses.)
REVERSIBLE CNTR 012 Increment input N: Counter number COUNTER ---
COUNTER CNTR
(BCD) Decrement input S: Set value WORD ---
N
Reset input
S

CNTRX 548 Increment input N: Counter number COUNTER ---

CNTRX
(BIN) Decrement input S: Set value UINT ---
N
Reset input
S

RESET TIMER/ CNR 545 N1: 1st number in TIMER or ---

CNR
COUNTER @CNR range COUNTER
N1 (See note.)
(BCD)
N2 N2: Last number in TIMER or ---
range COUNTER
(See note.)
CNRX 547 N1: 1st number in TIMER or ---
CNRX
@CNRX range COUNTER
N1 (See note.)
(BIN)
N2 N2: Last number in TIMER or ---
range COUNTER
(See note.)

Note Enabled when the same variable is specified for N1 and N2.

70
Instruction Support and Operand Restrictions Section 2-6

2-6-5 Comparison Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
Symbol Compari- LD,AND, OR 300 (=) Using LD: S1: Comparison UINT ---
son (Unsigned) + 305 (<>) data 1
=, <>, <, <=, 310 (<) Symbol, option S2: Comparison UINT ---
>, >= data 2
315 (<=) S1
320 (>) S2
325 (>=)
Using AND:

Symbol, option

S1
S2

Using OR:

Symbol, option

S1
S2

Symbol Compari- LD,AND, OR 301 (=) --- S1: Comparison UDINT ---
son (Double-word, + 306 (<>) data 1
unsigned) =, <>, <, <=, S2: Comparison UDINT ---
>, >= 311 (<)
data 2
+ 316 (<=)
L 321 (>)
326 (>=)
Symbol Compari- LD,AND, OR 302 (=) --- S1: Comparison INT ---
son (Signed) + 307 (<>) data 1
=, <>, <, <=, S2: Comparison INT ---
>, >= 312 (<)
data 2
+ 317 (<=)
S 322 (>)
327 (>=)
Symbol Compari- LD,AND, OR 303 (=) --- S1: Comparison DINT ---
son (Double-word, + 308 (<>) data 1
signed) =, <>, <, <=, S2: Comparison DINT ---
>, >= 313 (<)
data 2
+ 318 (<=)
SL 323 (>)
328 (>=)
UNSIGNED COM- CMP 020 S1: Comparison UINT ---
CMP
PARE !CMP data 1
S1 S2: Comparison UINT ---
S2 data 2

71
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
DOUBLE CMPL 060 S1: Comparison UDINT ---
CMPL
UNSIGNED COM- data 1
PARE S1 S2: Comparison UDINT ---
S2 data 2

SIGNED BINARY CPS 114 S1: Comparison INT ---

CPS
COMPARE !CPS data 1
S1 S2: Comparison INT ---
S2 data 2

DOUBLE SIGNED CPSL 115 S1: Comparison DINT ---

CPSL
BINARY COMPARE data 1
S1 S2: Comparison DINT ---
S2 data 2

TABLE TCMP 085 S: Source data WORD ---

TCMP
COMPARE @TCMP T: 1st word of table WORD Yes (16)
S
R: Result word UINT ---
T
R

MULTIPLE MCMP 019 S1: 1st word of set WORD Yes (16)
MCMP 1
COMPARE @MCMP
S1 S2: 1st word of set WORD Yes (16)
S2 2
R R: Result word UINT

UNSIGNED BCMP 068 S: Source data WORD ---

BLOCK BCMP
@BCMP T: 1st word of table WORD Yes (32)
COMPARE S
R: Result word UINT ---
T
R

EXPANDED BCMP2 502 S: Source data WORD ---

BLOCK COMPARE @BCMP2 BCMP2
T: 1st word of block WORD Yes (not
S fixed)
T R: Result word WORD ---
R

AREA RANGE ZCP 088 CD: Compare data UINT ---

COMPARE ZCP (1 word)
CD LL: Lower limit of UINT ---
LL range
UL UL: Upper limit of UINT ---
range

72
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
DOUBLE AREA ZCPL 116 CD: Compare data UDINT ---
RANGE COMPARE ZCPL (2 words)
CD LL: Lower limit of UDINT ---
LL range
UL UL: Upper limit of UDINT ---
range
Time Comparison LD, AND, OR 341 (=DT) LD (LOAD): C: Control word WORD ---
+ 342 S1: 1st word of WORD Yes (3)
=DT, <> (<>DT) Symbol
present time
DT, <DT, 343 (<DT) C S2: 1st word of WORD Yes (3)
<=DT, >DT, 344 S1 comparison time
>=DT (<=DT) S2
345 (>DT)
346 AND:
(>=DT)
Symbol
C
S1
S2

OR:

Symbol
C
S1
S2

2-6-6 Data Movement Instructions

Instruction Mnemonic Function Symbol Operands Supported AT setting or
code variable array variable
data types required
(Required
word data size
shown in
parentheses.)
MOVE MOV 021 S: Source WORD ---
MOV
@MOV D: Destination WORD ---
S
!MOV
!@MOV D

DOUBLE MOVE MOVL 498 S: 1st source DWORD ---

MOVL
@MOVL word
S D: 1st destina- DWORD ---
D tion word

73
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT setting or

code variable array variable
data types required
(Required
word data size
shown in
parentheses.)
MOVE NOT MVN 022 S: Source WORD ---
MVN
@MVN D: Destination WORD ---
S
D

DOUBLE MOVE MVNL 499 S: 1st source DWORD ---

MVNL
NOT @MVNL word
S D: 1st destina- DWORD ---
D tion word

MOVE BIT MOVB 082 S: Source word WORD ---

MOVB or data
@MOVB
S C: Control word UINT ---
C D: Destination WORD ---
D word

MOVE DIGIT MOVD 083 S: Source word WORD ---

MOVD or data
@MOVD
S C: Control word UINT ---
C D: Destination UINT ---
D word

MULTIPLE BIT XFRB 062 C: Control word UINT ---

TRANSFERÅ@ XFRB
@XFRB S: 1st source WORD Yes
C word (not fixed)
S D: 1st destina- WORD Yes
D tion word (not fixed)

BLOCK XFER 070 N: Number of UINT ---

XFER words
TRANSFER @XFER
N S: 1st source WORD Yes
S word (not fixed)
D D: 1st destina- WORD Yes
tion word (not fixed)
BLOCK SET BSET 071 S: Source word WORD ---
BSET
@BSET St: Starting word WORD Yes
S (not fixed)
St E: End word WORD Yes
E (not fixed)

DATA EXCHANGE XCHG 073 E1: 1st WORD ---

XCHG
@XCHG exchange word
E1 E2: Second WORD ---
E2 exchange word

DOUBLE DATA XCGL 562 E1: 1st DWORD ---

XCGL
EXCHANGE @XCGL exchange word
E1 E2: Second DWORD ---
E2 exchange word

74
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT setting or

code variable array variable
data types required
(Required
word data size
shown in
parentheses.)
SINGLE WORD DIST 080 S: Source word WORD ---
DISTRIBUTE DIST
@DIST Bs: Destination WORD Yes
S base address (not fixed)
Bs Of: Offset UINT ---
Of

DATA COLLECT COLL 081 Bs: Source base WORD Yes

COLL address (not fixed)
@COLL
Bs Of: Offset WORD ---
Of D: Destination WORD ---
D word

MOVE TO MOVR 560 S: Source BOOL ---

MOVR
REGISTER @MOVR (desired word
S orbit)
D D: Destination WORD ---
(Index Register)
MOVE TIMER/ MOVRW 561 Not supported in func- S: Source --- ---
COUNTER PV TO @MOVRW tion blocks (desired TC
REGISTER number)
D: Destination --- ---
(Index Register)

2-6-7 Data Shift Instructions

Instruction Mnemonic Function Symbol Operands Supported AT setting or
code variable array variable
data types required
(Required
word data size
shown in
parentheses.)
SHIFT REGIS- SFT 010 Data input St: Starting word UINT Yes (not fixed)
SFT
TER Shift input E: End word UINT Yes (not fixed)
St
Reset input D1 and D2
E
must be the
same array vari-
able when array
variables are
required.
REVERSIBLE SFTR 084 C: Control word UINT ---
SHIFT REGIS- SFTR
@SFTR St: Starting word UINT Yes (not fixed)
TER C
E: End word UINT Yes (not fixed)
St
D1 and D2
E must be the
same array vari-
able when array
variables are
required.

75
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT setting or

code variable array variable
data types required
(Required
word data size
shown in
parentheses.)
ASYNCHRO- ASFT 017 C: Control word UINT ---
NOUS SHIFT ASFT
@ASFT St: Starting word UINT Yes (not fixed)
REGISTER C
E: End word UINT Yes (not fixed)
St
D1 and D2
E must be the
same array vari-
able when array
variables are
required.
WORD SHIFT WSFT 016 S: Source word WORD ---
WSFT
@WSFT St: Starting word UINT Yes (not fixed)
S
E: End word UINT Yes (not fixed)
St
D1 and D2
E must be the
same array vari-
able when array
variables are
required.
ARITHMETIC ASL 025 Wd: Word UINT ---
SHIFT LEFT ASL
@ASL
Wd

DOUBLE SHIFT ASLL 570 Wd: Word UDINT ---

LEFT ASLL
@ASLL
Wd

ARITHMETIC ASR 026 Wd: Word UINT ---

SHIFT RIGHT ASR
@ASR
Wd

DOUBLE SHIFT ASRL 571 Wd: Word UDINT ---

RIGHT ASRL
@ASRL
Wd

ROTATE LEFT ROL 027 Wd: Word UINT ---

ROL
@ROL
Wd

DOUBLE ROLL 572 Wd: Word UDINT ---

ROTATE LEFT ROLL
@ROLL
Wd

ROTATE LEFT RLNC 574 Wd: Word UINT ---

WITHOUT RLNC
@RLNC
CARRY Wd

DOUBLE RLNL 576 Wd: Word UDINT ---

ROTATE LEFT RLNL
@RLNL
WITHOUT Wd
CARRY
ROTATE RIGHT ROR 028 Wd: Word UINT ---
ROR
@ROR
Wd

76
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT setting or

code variable array variable
data types required
(Required
word data size
shown in
parentheses.)
DOUBLE RORL 573 Wd: Word UDINT ---
ROTATE RIGHT RORL
@RORL
Wd

ROTATE RIGHT RRNC 575 Wd: Word UINT ---

WITHOUT RRNC
@RRNC
CARRY Wd

DOUBLE RRNL 577 Wd: Word UDINT ---

ROTATE RIGHT RRNL
@RRNL
WITHOUT Wd
CARRY
ONE DIGIT SLD 074 St: Starting word UINT Yes (not fixed)
SLD
SHIFT LEFT @SLD E: End word UINT Yes (not fixed)
St
E

ONE DIGIT SRD 075 St: Starting word UINT Yes (not fixed)
SRD
SHIFT RIGHT @SRD E: End word UINT Yes (not fixed)
St
E

SHIFT N-BIT NSFL 578 D: Beginning UINT Yes (not fixed)

DATA LEFT NSFL word for shift
@NSFL
D C: Beginning bit UINT ---
C N: Shift data UINT ---
N length

SHIFT N-BIT NSFR 579 D: Beginning UINT Yes (not fixed)

DATA RIGHT NSFR word for shift
@NSFR
D C: Beginning bit UINT ---
C N: Shift data UINT ---
N length

SHIFT N-BITS NASL 580 D: Shift word UINT ---

NASL
LEFT @NASL C: Control word UINT ---
D
C

DOUBLE SHIFT NSLL 582 D: Shift word UDINT ---

NSLL
N-BITS LEFT @NSLL C: Control word UINT ---
D
C

SHIFT N-BITS NASR 581 D: Shift word UINT ---

NASR
RIGHT @NASR C: Control word UINT ---
D
C

DOUBLE SHIFT NSRL 583 D: Shift word UDINT ---

NSRL
N-BITS RIGHT @NSRL C: Control word UINT ---
D
C

77
Instruction Support and Operand Restrictions Section 2-6

2-6-8 Increment/Decrement Instructions

Instruction Mnemonic Function Symbol Operands Supported AT setting
code variable or array
data types variable
required
(Required
word data
size
shown in
parenthe-
ses.)
INCREMENT ++ 590 Wd: Word UINT ---
BINARY ++
@++
Wd

DOUBLE INCRE- ++L 591 Wd: Word UDINT ---

MENT BINARY ++L
@++L
Wd

DECREMENT -- 592 Wd: Word UINT ---

BINARY --
@--
Wd

DOUBLE DECRE- --L 593 Wd: 1st word UDINT ---

MENT BINARY --L
@--L
Wd

INCREMENT BCD ++B 594 Wd: Word WORD ---

++B
@++B
Wd

DOUBLE INCRE- ++BL 595 Wd: 1st word DWORD ---

MENT BCD ++BL
@++BL
Wd

DECREMENT BCD --B 596 Wd: Word DWORD ---

--B
@--B
Wd

DOUBLE DECRE- --BL 597 Wd: 1st word WORD ---

MENT BCD --BL
@--BL
Wd

78
Instruction Support and Operand Restrictions Section 2-6

2-6-9 Symbol Math Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
SIGNED BINARY + 400 Au: Augend word INT ---
ADD WITHOUT +
@+ Ad: Addend word INT ---
CARRY Au
R: Result word INT ---
Ad
R

DOUBLE SIGNED +L 401 Au: 1st augend DINT ---

BINARY ADD +L word
@+L
WITHOUT CARRY Au Ad: 1st addend DINT ---
Ad word
R R: 1st result word DINT ---

SIGNED BINARY +C 402 Au: Augend word INT ---

ADD WITH CARRY +C
@+C Ad: Addend word INT ---
Au
R: Result word INT ---
Ad
R

DOUBLE SIGNED +CL 403 Au: 1st augend DINT ---

BINARY ADD WITH @+CL +CL word
CARRY Au Ad: 1st addend DINT ---
Ad word
R R: 1st result word DINT ---

BCD ADD +B 404 Au: Augend word WORD ---

+B
WITHOUT CARRY @+B Ad: Addend word WORD ---
Au
R: Result word WORD ---
Ad
R

DOUBLE BCD ADD +BL 405 Au: 1st augend DWORD ---
WITHOUT CARRY @+BL +BL word
Au Ad: 1st addend DWORD ---
Ad word
R R: 1st result word DWORD ---

BCD ADD WITH +BC 406 Au: Augend word WORD ---
CARRY +BC
@+BC Ad: Addend word WORD ---
Au
R: Result word WORD ---
Ad
R

79
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
DOUBLE BCD ADD +BCL 407 Au: 1st augend DWORD ---
WITH CARRY +BCL word
@+BCL
Au Ad: 1st addend DWORD ---
Ad word
R R: 1st result word DWORD ---

SIGNED BINARY - 410 Mi: Minuend word INT ---

SUBTRACT WITH- -
@- Su: Subtrahend INT ---
OUT CARRY Mi word
Su R: Result word INT ---
R

DOUBLE SIGNED -L 411 Mi: Minuend word DINT ---

BINARY SUB- -L
@-L Su: Subtrahend DINT ---
TRACT WITHOUT Mi word
CARRY
Su R: Result word DINT ---
R

SIGNED BINARY -C 412 Mi: Minuend word INT ---

SUBTRACT WITH -C
@-C Su: Subtrahend INT ---
CARRY Mi word
Su R: Result word INT ---
R

DOUBLE SIGNED -CL 413 Mi: Minuend word DINT ---

BINARY WITH -CL
@-CL Su: Subtrahend DINT ---
CARRY Mi word
Su R: Result word DINT ---
R

BCD SUBTRACT -B 414 Mi: Minuend word WORD ---

WITHOUT CARRY -B
@-B Su: Subtrahend WORD ---
Mi word
Su R: Result word WORD ---
R

DOUBLE BCD -BL 415 Mi: 1st minuend DWORD ---

SUBTRACT WITH- -BL word
@-BL
OUT CARRY Mi Su: 1st subtrahend DWORD ---
Su word
R R: 1st result word DWORD ---

BCD SUBTRACT -BC 416 Mi: Minuend word WORD ---

WITH CARRY -BC
@-BC Su: Subtrahend WORD ---
Mi word
Su R: Result word WORD ---
R

80
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
DOUBLE BCD -BCL 417 Mi: 1st minuend DWORD ---
SUBTRACT WITH -BCL word
@-BCL
CARRY Mi Su: 1st subtrahend DWORD ---
Su word
R R: 1st result word DWORD ---

SIGNED BINARY * 420 Md: Multiplicand INT ---

MULTIPLY * word
@*
Md Mr: Multiplier word INT ---
Mr R: Result word DINT ---
R

DOUBLE SIGNED *L 421 Md: 1st multiplicand DINT ---

BINARY MULTIPLY *L word
@*L
Md Mr: 1st multiplier DINT ---
Mr word
R R: 1st result word LINT ---

UNSIGNED *U 422 Md: Multiplicand UINT ---

BINARY MULTIPLY *U word
@*U
Md Mr: Multiplier word UINT ---
Mr R: Result word UINT ---
R

DOUBLE *UL 423 Md: 1st multiplicand UDINT ---

UNSIGNED *UL word
@*UL
BINARY Md Mr: 1st multiplier UDINT ---
MULTIPLY Mr word
R R: 1st result word ULINT ---

BCD MULTIPLY *B 424 Md: Multiplicand WORD ---

*B word
@*B
Md Mr: Multiplier word WORD ---
Mr R: Result word DWORD ---
R

DOUBLE BCD *BL 425 Md: 1st multiplicand DWORD ---

MULTIPLY *BL word
@*BL
Md Mr: 1st multiplier DWORD ---
Mr word
R R: 1st result word LWORD ---

81
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
SIGNED BINARY / 430 Dd: Dividend word INT ---
DIVIDE /
@/ Dr: Divisor word INT ---
Dd
R: Result word DWORD Yes (2)
Dr
INT must
R be used
when
array vari-
ables are
required.
DOUBLE SIGNED /L 431 Dd: 1st dividend DINT ---
BINARY DIVIDE /L word
@/L
Dd Dr: 1st divisor word DINT ---
Dr R: 1st result word LWORD Yes (2)
R DINT must
be used
when
array vari-
ables are
required.
UNSIGNED /U 432 Dd: Dividend word UINT ---
BINARY DIVIDE /U
@/U Dr: Divisor word UINT ---
Dd
R: Result word DWORD Yes (2)
Dr
UINT must
R be used
when
array vari-
ables are
required.
DOUBLE /UL 433 Dd: 1st dividend UDINT ---
UNSIGNED /UL word
@/UL
BINARY DIVIDE Dd Dr: 1st divisor word UDINT ---
Dr R: 1st result word LWORD Yes (2)
R UDINT
must be
used
when
array vari-
ables are
required.
BCD DIVIDE /B 434 Dd: Dividend word WORD ---
/B
@/B Dr: Divisor word WORD ---
Dd
R: Result word DWORD Yes (2)
Dr
WORD
R must be
used
when
array vari-
ables are
required.

82
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
DOUBLE BCD /BL 435 Dd: 1st dividend DWORD ---
DIVIDE /BL word
@/BL
Dd Dr: 1st divisor word DWORD ---
Dr R: 1st result word LWORD Yes (2)
R DWORD
must be
used
when
array vari-
ables are
required.

2-6-10 Conversion Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
BCD-TO-BINARY BIN 023 S: Source word WORD ---
BIN
@BIN R: Result word UINT ---
S
R

DOUBLE BCD-TO- BINL 058 S: 1st source word DWORD ---

BINL
DOUBLE BINARY @BINL R: 1st result word UDINT ---
S
R

BINARY-TO-BCD BCD 024 S: Source word UINT ---

BCD
@BCD R: Result word WORD ---
S
R

DOUBLE BINARY- BCDL 059 S: 1st source word UDINT ---

BCDL
TO-DOUBLE BCD @BCDL R: 1st result word DWORD ---
S
R

2’S COMPLEMENT NEG 160 S: Source word WORD ---

NEG
@NEG R: Result word UINT ---
S
R

83
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
DOUBLE 2’S COM- NEGL 161 S: 1st source word DWORD ---
NEGL
PLEMENT @NEGL R: 1st result word UDINT ---
S
R

16-BIT TO 32-BIT SIGN 600 S: Source word WORD ---

SIGN
SIGNED BINARY @SIGN R: 1st result word DINT ---
S
R

DATA DECODER MLPX 076 S: Source word UINT ---

MLPX
@MLPX C: Control word UINT ---
S
R: 1st result word UINT Yes (not
C fixed)
R

DATA ENCODER DMPX 077 S: 1st source word UINT Yes (not
DMPX fixed)
@DMPX
S R: Result word UINT ---
R C: Control word UINT ---
C

ASCII CONVERT ASC 086 S: Source word UINT ---

ASC
@ASC Di: Digit designator UINT ---
S
D: 1st destination UINT Yes (3)
Di word
D

ASCII TO HEX HEX 162 S: 1st source word UINT Yes (2)
HEX
@HEX Di: Digit designator UINT ---
S
D: Destination word UINT Yes (not
Di fixed)
D

COLUMN TO LINE LINE 063 S: 1st source word WORD Yes (16)
LINE
@LINE N: Bit number UINT ---
S
D: Destination word UINT ---
N
D

LINE TO COLUMN COLM 064 S: Source word WORD ---

COLM
@COLM D: 1st destination WORD Yes (16)
S word
D N: Bit number UINT ---
N

84
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
SIGNED BCD-TO- BINS 470 C: Control word UINT ---
BINARY BINS
@BINS S: Source word WORD ---
C
D: Destination word INT ---
S
D

DOUBLE SIGNED BISL 472 C: Control word UINT ---

BCD-TO-BINARY BISL
@BISL S: 1st source word DWORD ---
C
D: 1st destination DINT ---
S word
D

SIGNED BINARY- BCDS 471 C: Control word UINT ---

TO-BCD BCDS
@BCDS S: Source word INT ---
C
D: Destination word WORD ---
S
D

DOUBLE SIGNED BDSL 473 C: Control word UINT ---

BINARY-TO-BCD BDSL
@BDSL S: 1st source word DINT ---
C
D: 1st destination DWORD ---
S word
D

FOUR-DIGIT NUM- STR4 601 S: Numeric UINT ---

STR4
BER-TO-ASCII @STR4 D: ASCII text WORD Yes (2)
S
D

EIGHT-DIGIT NUM- STR8 602 S: Numeric UDINT ---

STR8
BER-TO-ASCII @STR8 D: ASCII text WORD Yes (4)
S
D

SIXTEEN-DIGIT STR16 603 S: Numeric ULINT ---

STR16
NUMBER-TO-ASCII @STR16 D: ASCII text WORD Yes (8)
S
D

FOUR-DIGIT ASCII- NUM4 604 S: ASCII text WORD Yes (2)

NUM4
TO-NUMBER @NUM4 D: Numeric UINT ---
S
D

EIGHT-DIGIT ASCII- NUM8 605 S: ASCII text WORD Yes (4)

NUM8
TO-NUMBER @NUM8 D: Numeric UDINT ---
S
D

85
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
SIXTEEN-DIGIT NUM16 606 S: ASCII text WORD Yes (8)
NUM16
ASCII-TO-NUMBER @NUM16 D: Numeric ULINT ---
S
D

2-6-11 Logic Instructions

Instruction Mnemonic Function Symbol Operand Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
LOGICAL AND ANDW 034 I1: Input 1 WORD ---
ANDW
@ANDW I2: Input 2 WORD ---
l1
R: Result word WORD ---
l2
R

DOUBLE LOGICAL ANDL 610 I1: Input 1 DWORD ---

AND ANDL
@ANDL I2: Input 2 DWORD ---
l1
R: Result word DWORD ---
l2
R

LOGICAL OR ORW 035 I1: Input 1 WORD ---

ORW
@ORW I2: Input 2 WORD ---
l1
R: Result word WORD ---
l2
R

DOUBLE LOGICAL ORWL 611 I1: Input 1 DWORD ---

OR ORWL
@ORWL I2: Input 2 DWORD ---
l1
R: Result word DWORD ---
l2
R

EXCLUSIVE OR XORW 036 I1: Input 1 WORD ---

XORW
@XORW I2: Input 2 WORD ---
l1
R: Result word WORD ---
l2
R

86
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operand Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
DOUBLE EXCLU- XORL 612 I1: Input 1 DWORD ---
SIVE OR XORL
@XORL I2: Input 2 DWORD ---
l1
R: Result word DWORD ---
l2
R

EXCLUSIVE NOR XNRW 037 I1: Input 1 WORD ---

XNRW
@XNRW I2: Input 2 WORD ---
l1
R: Result word WORD ---
l2
R

DOUBLE EXCLU- XNRL 613 I1: Input 1 DWORD ---

SIVE NOR XNRL
@XNRL I2: Input 2 DWORD ---
l1
R: Result word DWORD ---
l2
R

COMPLEMENT COM 029 Wd: Word WORD ---

COM
@COM
Wd

DOUBLE COMPLE- COML 614 Wd: Word DWORD ---

MENT COML
@COML
Wd

2-6-12 Special Math Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
BINARY ROOT ROTB 620 S: 1st source word UDINT ---
ROTB
@ROTB R: Result word UINT ---
S
R

BCD SQUARE ROOT 072 S: 1st source word DWORD ---

ROOT
ROOT @ROOT R: Result word WORD ---
S
R

87
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
ARITHMETIC PRO- APR 069 C: Control word UINT Yes (not
CESS APR fixed)
@APR
C S: Source data WORD ---
S R: Result word WORD ---
R

FLOATING POINT FDIV 079 Dd: 1st dividend UDINT ---

DIVIDE FDIV word
@FDIV
Dd Dr: 1st divisor word UDINT ---
Dr R: 1st result word UDINT ---
R

BIT COUNTER BCNT 067 N: Number of UINT ---

BCNT words
@BCNT
N S: 1st source word UINT Yes (not
S fixed)
R R: Result word UINT ---

VIRTUAL AXIS AXIS 981 M: Mode designa- WORD ---

AXIS tion
(FQM1 only)
M C: Processing cycle WORD ---
C T: 1st settings table WORD Yes (27)
T word

88
Instruction Support and Operand Restrictions Section 2-6

2-6-13 Floating-point Math Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
FLOATING TO 16- FIX 450 S: 1st source word REAL ---
FIX
BIT @FIX R: Result word INT ---
S
R

FLOATING TO 32- FIXL 451 S: 1st source word REAL ---

FIXL
BIT @FIXL R: Result word DINT ---
S
R

16-BIT TO FLOAT- FLT 452 S: Source word INT ---

FLT
ING @FLT R: 1st result word REAL ---
S
R

32-BIT TO FLOAT- FLTL 453 S: 1st source word DINT ---

FLTL
ING @FLTL R: Result word REAL ---
S
R

FLOATING-POINT +F 454 Au: 1st augend REAL ---

ADD +F word
@+F
Au Ad: 1st addend REAL ---
Ad word
R R: 1st result word REAL ---

FLOATING-POINT -F 455 Mi: 1st Minuend REAL ---

SUBTRACT -F word
@-F
Mi Su: 1st Subtrahend REAL ---
Su word
R R: 1st result word REAL ---

FLOATING- POINT *F 456 Md: 1st Multiplicand REAL ---

MULTIPLY *F word
@*F
Md Mr: 1st Multiplier REAL ---
Mr word
R R: 1st result word REAL ---

FLOATING- POINT /F 457 Dd: 1st Dividend REAL ---

DIVIDE /F word
@/F
Dd Dr: 1st Divisor word REAL ---
Dr R: 1st result word REAL ---
R

89
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
DEGREES TO RADI- RAD 458 S: 1st source word REAL ---
RAD
ANS @RAD R: 1st result word REAL ---
S
R

RADIANS TO DEG 459 S: 1st source word REAL ---

DEG
DEGREES @DEG R: 1st result word REAL ---
S
R

SINE SIN 460 S: 1st source word REAL ---

SIN
@SIN R: 1st result word REAL ---
S
R

COSINE COS 461 S: 1st source word REAL ---

COS
@COS R: 1st result word REAL ---
S
R

TANGENT TAN 462 S: 1st source word REAL ---

TAN
@TAN R: 1st result word REAL ---
S
R

ARC SINE ASIN 463 S: 1st source word REAL ---

ASIN
@ASIN R: 1st result word REAL ---
S
R

ARC COSINE ACOS 464 S: 1st source word REAL ---

ACOS
@ACOS R: 1st result word REAL ---
S
R

ARC TANGENT ATAN 465 S: 1st source word REAL ---

ATAN
@ATAN R: 1st result word REAL ---
S
R

SQUARE ROOT SQRT 466 S: 1st source word REAL ---

SQRT
@SQRT R: 1st result word REAL ---
S
R

EXPONENT EXP 467 S: 1st source word REAL ---

EXP
@EXP R: 1st result word REAL ---
S
R

90
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
LOGARITHM LOG 468 S: 1st source word REAL ---
LOG
@LOG R: 1st result word REAL ---
S
R

EXPONENTIAL PWR 840 B: 1st base word REAL ---

POWER PWR
@PWR E: 1st exponent REAL ---
B word
E R: 1st result word REAL ---
R

Floating Symbol LD, AND, 329 (=F) Using LD: S1:Comparoson REAL ---
Comparison OR 330 (<>F) data 1
+ 331 (<F) Symbol, option S2:Comparison REAL ---
=F, <>F, <F, data 2
332 (<=F) S1
<=F, >F, >=F
333 (>F) S2
334 (>=F)
Using AND:

Symbol, option

S1
S2

Using OR:

Symbol, option

S1
S2

FLOATING- POINT FSTR 448 S: 1st source word REAL ---

TO ASCII FSTR
@FSTR C: Control word UINT Yes (3)
S
D: Destination word UINT Yes (not
C fixed)
D

ASCII TO FLOATING- FVAL 449 S: Source word UINT Yes (not

FVAL
POINT @FVAL fixed)
S D: 1st destination REAL ---
D word

91
Instruction Support and Operand Restrictions Section 2-6

2-6-14 Double-precision Floating-point Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
DOUBLE FLOATING FIXD 841 S: 1st source word LREAL ---
FIXD
TO 16-BIT BINARY @FIXD D: Destination INT ---
S word
D

DOUBLE FLOATING FIXLD 842 S: 1st source word LREAL ---

FIXLD
TO 32-BIT BINARY @FIXLD D: 1st destination DINT ---
S word
D

16-BIT BINARY TO DBL 843 S: Source word INT ---

DBL
DOUBLE FLOATING @DBL D: 1st destination LREAL ---
S word
D

32-BIT BINARY TO DBLL 844 S: 1st source word DINT ---

DBLL
DOUBLE FLOATING @DBLL D: 1st destination DINT ---
S word
D

DOUBLE FLOATING- +D 845 Au: 1st augend LREAL ---

POINT ADD +D word
@+D
Au Ad: 1st addend LREAL ---
Ad word
R R: 1st result word LREAL ---

DOUBLE FLOATING- -D 846 Mi: 1st minuend LREAL ---

POINT SUBTRACT -D word
@-D
Mi Su: 1st subtra- LREAL ---
Su hend word
R R: 1st result word LREAL ---

DOUBLE FLOATING- *D 847 Md: 1st multipli- LREAL ---

POINT MULTIPLY *D cand word
@*D
Md Mr: 1st multiplier LREAL ---
Mr word
R R: 1st result word LREAL ---

DOUBLE FLOATING- /D 848 Dd: 1st Dividend LREAL ---

POINT DIVIDE /D word
@/D
Dd Dr: 1st divisor word LREAL ---
Dr R: 1st result word LREAL ---
R

92
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
DOUBLE DEGREES RADD 849 S: 1st source word LREAL ---
RADD
TO RADIANS @RADD R: 1st result word LREAL ---
S
R

DOUBLE RADIANS DEGD 850 S: 1st source word LREAL ---

DEGD
TO DEGREES @DEGD R: 1st result word LREAL ---
S
R

DOUBLE SINE SIND 851 S: 1st source word LREAL ---

SIND
@SIND R: 1st result word LREAL ---
S
R

DOUBLE COSINE COSD 852 S: 1st source word LREAL ---

COSD
@COSD R: 1st result word LREAL ---
S
R

DOUBLE TANGENT TAND 853 S: 1st source word LREAL ---

TAND
@TAND R: 1st result word LREAL ---
S
R

DOUBLE ARC SINE ASIND 854 S: 1st source word LREAL ---
ASIND
@ASIND R: 1st result word LREAL ---
S
R

DOUBLE ARC ACOSD 855 S: 1st source word LREAL ---

ACOSD
COSINE @ACOSD R: 1st result word LREAL ---
S
R

DOUBLE ARC TAN- ATAND 856 S: 1st source word LREAL ---
ATAND
GENT @ATAND R: 1st result word LREAL ---
S
R

DOUBLE SQUARE SQRTD 857 S: 1st source word LREAL ---

SQRTD
ROOT @SQRTD R: 1st result word LREAL ---
S
R

DOUBLE EXPO- EXPD 858 S: 1st source word LREAL ---

EXPD
NENT @EXPD R: 1st result word LREAL ---
S
R

93
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
DOUBLE LOGA- LOGD 859 S: 1st source word LREAL ---
LOGD
RITHM @LOGD R: 1st result word LREAL ---
S
R

DOUBLE EXPONEN- PWRD 860 B: 1st base word LREAL ---

TIAL POWER PWRD
@PWRD E: 1st exponent LREAL ---
B word
E R: 1st result word LREAL ---
R

DOUBLE SYMBOL LD, AND, 335 (=D) Using LD: S1:Comparoson LREAL ---
COMPARISON OR 336 (<>D) data 1
+ 337 (<D) Symbol, option S2:Comparison LREAL ---
=D, <>D, <D, data 2
338 (<=D) S1
<=D, >D,
>=D 339 (>D) S2
340 (>=D)
Using AND:

Symbol, option

S1
S2

Using OR:

Symbol, option

S1
S2

94
Instruction Support and Operand Restrictions Section 2-6

2-6-15 Table Data Processing Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
SET STACK SSET 630 TB: 1st stack UINT Yes (not
SSET
@SSET address fixed)
TB N: Number of UINT ---
N words

PUSH ONTO PUSH 632 TB: 1st stack --- ---

PUSH
STACK @PUSH address
D S: Source word --- ---
S

FIRST IN FIRST FIFO 633 TB: 1st stack --- ---

LIFO
OUT @FIFO address
S D: Destination word --- ---
D

LAST IN FIRST LIFO 634 TB: 1st stack --- ---

FIFO
OUT @LIFO address
S D: Destination word --- ---
D

DIMENSION DIM 631 N: Table number # + decimal ---

RECORD TABLE DIM
@DIM only
N
LR: Length of each UINT ---
LR record
NR NR: Number of UINT ---
records
TB
TB: 1st table word UINT Yes (not
fixed)
SET RECORD SETR 635 N: Table number --- ---
LOCATION SETR
@SETR R: Record number --- ---
N
D: Destination --- ---
S1 Index Register
D

GET RECORD GETR 636 N: Table number --- ---

NUMBER GETR
@GETR IR: Index Register --- ---
N
D: Destination word --- ---
S1
D

DATA SEARCH SRCH 181 C: 1st control word UDINT ---

SRCH
@SRCH R1: 1st word in UINT Yes (not
C range fixed)
R1 Cd: Comparison WORD ---
Cd data

95
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
SWAP BYTES SWAP 637 N: Number of UINT ---
SWAP
@SWAP words
N R1: 1st word in UINT Yes (not
R1 range fixed)

FIND MAXIMUM MAX 182 C: 1st control word UDINT ---

MAX
@MAX R1: 1st word in UINT Yes (not
C range fixed)
R1 D: Destination word UINT ---
D

FIND MINIMUM MIN 183 C: 1st control word UDINT ---

MIN
@MIN R1: 1st word in UINT Yes (not
C range fixed)
R1 D: Destination word UINT ---
D

SUM SUM 184 C: 1st control word UDINT ---

SUM
@SUM R1: 1st word in UINT Yes (not
C range fixed)
R1 D: 1st destination UDINT ---
D word

FRAME CHECK FCS 180 C: 1st control word UDINT ---

SUM FCS
@FCS R1: 1st word in UINT Yes (not
C range fixed)
R1 D: 1st destination UINT ---
D word

STACK SIZE READ SNUM 638 TB: First stack UINT Yes (not
SNUM
@SNUM address fixed)
TB D: Destination word UINT ---
D

STACK DATA READ SREAD 639 TB: First stack UINT Yes (not
SREAD address fixed)
@SREAD
TB C: Offset value UINT ---
C D: Destination word UINT ---
D

STACK DATA SWRIT 640 TB: First stack UINT Yes (not
OVERWRITE SWRIT address fixed)
@SWRIT
TB C: Offset value UINT ---
C S: Source data UINT ---
S

96
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
STACK DATA SINS 641 TB: First stack UINT Yes (not
INSERT SINS address fixed)
@SINS
TB C: Offset value UINT ---
C S: Source data UINT ---
S

STACK DATA SDEL 642 TB: First stack UINT Yes (not
DELETE SDEL address fixed)
@SDEL
TB C: Offset value UINT ---
C D: Destination word UINT ---
D

2-6-16 Data Control Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
PID CONTROL PID 190 S: Input word UINT ---
PID
C: 1st parameter WORD Yes (39)
S word
C D: Output word UINT ---
D

PID CONTROL PIDAT 191 S: Input word UINT ---

WITH AUTO TUN- PIDAT
C: 1st parameter WORD Yes (41)
ING S word
C D: Output word UINT ---
D

LIMIT CONTROL LMT 680 S: Input word INT ---

LMT
@LMT C: 1st limit word DINT Yes (2)
S
D: Output word INT ---
C
D

DEAD BAND CON- BAND 681 S: Input word INT ---

TROL BAND
@BAND C: 1st limit word UINT Yes (2)
S
D: Output word UINT ---
C
D

97
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
DEAD ZONE CON- ZONE 682 S: Input word INT ---
TROL ZONE
@ZONE C: 1st limit word UDINT Yes (2)
S
D: Output word UINT ---
C
D

TIME-PROPOR- TPO 685 S: Input word UINT ---

TIONAL OUTPUT TPO
C: 1st parameter WORD Yes (7)
S word
C R: Pulse Output Bit BOOL ---
R

SCALING SCL 194 S: Input word UINT ---

SCL
@SCL P1: 1st parameter LWORD Yes (4)
S word
P1 R: Result word WORD ---
R

SCALING 2 SCL2 486 S: Source word INT ---

SCL2
@SCL2 P1: 1st parameter WORD Yes (3)
S word
P1 R: Result word WORD ---
R

SCALING 3 SCL3 487 S: Source word WORD ---

SCL3
@SCL3 P1: 1st parameter WORD Yes (5)
S word
P1 R: Result word INT ---
R

AVERAGE AVG 195 S: Source word UINT ---

AVG
N: Number of UINT ---
S cycles
N R: Result word UINT Yes (not
R fixed)

98
Instruction Support and Operand Restrictions Section 2-6

2-6-17 Subroutine Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
SUBROUTINE CALL SBS 091 Not supported in func- N: Subroutine num- --- ---
@SBS tion blocks ber
SUBROUTINE SBN 092 Not supported in func- N: Subroutine num- --- ---
ENTRY tion blocks ber
SUBROUTINE RET 093 Not supported in func- --- ---
RETURN tion blocks
MACRO MCRO 099 Not supported in func- N: Subroutine num- --- ---
@MCRO tion blocks ber
S: 1st input param- --- ---
eter word
D: 1st output --- ---
parameter word
GLOBAL SUBROU- GSBS 750 Not supported in func- N: Subroutine num- --- ---
TINE CALL @GSBS tion blocks ber
GLOBAL SUBROU- GSBN 751 Not supported in func- N: Subroutine num- --- ---
TINE ENTRY tion blocks ber
GLOBAL SUBROU- GRET 752 Not supported in func- --- ---
TINE RETURN tion blocks
JUMP TO SUBROU- JSB 982 Not supported in func- --- --- ---
TINE (FQM1 only) tion blocks

2-6-18 Interrupt Control Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
SET INTERRUPT MSKS 690 N: Interrupt identi- # + decimal ---
MSKS
MASK @MSKS fier only
N S: Interrupt data UINT ---
S

READ INTERRUPT MSKR 692 N: Interrupt identi- # + decimal ---

MSKR
MASK @MSKR fier only
N D: Destination word UINT ---
D

99
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
CLEAR INTER- CLI 691 N: Interrupt identi- # + decimal ---
CLI
RUPT @CLI fier only
N S: Interrupt data UINT ---
S

DISABLE INTER- DI 693 --- --- ---

RUPTS DI
@DI
ENABLE INTER- EI 694 --- --- ---
RUPTS EI

INTERVAL TIMER STIM 980 C1: Control data #1 WORD ---

STIM
@STIM C2: Control data #2 INT ---
C1
(FQM1 only) C3: Control data #3 INT ---
C2
C3

2-6-19 High-speed Counter and Pulse Output Instructions (CJ1M-CPU21/

22/23 Only)
Instruction Mnemonic Function Symbol/Operands Function Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
MODE CONTROL INI 880 P: Port specifier WORD ---
INI
@INI C: Control data UINT ---
P
NV: 1st word with DWORD ---
C new PCV
NV

HIGH-SPEED PRV 881 P: Port specifier # + decimal ---

COUNTER PV PRV only
@PRV
READ P C: Control data # + decimal ---
C only
D D: 1st destination WORD Yes (1 or
word 2)
COUNTER FRE- PRV2 883 C1: Control data WORD ---
QUENCY CON- PRV2
C2: Pulses/revolu- UINT ---
VERT C1 tion
(CJ1M CPU Unit C2 D: 1st destination UDINT ---
Ver. 2.0 or later only) word
D

100
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol/Operands Function Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
COMPARISON CTBL 882 P: Port specifier # + decimal ---
TABLE LOAD CTBL only
@CTBL
P C: Control data # + decimal ---
C only
TB TB: 1st compari- LWORD Yes (not
son table word fixed)
SPEED OUTPUT SPED 885 P: Port specifier UINT ---
SPED
@SPED M: Output mode WORD ---
P
F: 1st pulse fre- UDINT ---
M quency word
F

SET PULSES PULS 886 P: Port specifier UINT ---

PULS
@PULS T: Pulse type UINT ---
P
N: Number of DINT ---
T pulses
N

PULSE OUTPUT PLS2 887 P: Port specifier # + decimal ---

PLS2 only
@PLS2
P M: Output mode # + decimal ---
M only
S S: 1st word of set- WORD Yes (6)
tings table
F
F: 1st word of start- UDINT ---
ing frequency
ACCELERATION ACC 888 P: Port specifier # + decimal ---
CONTROL ACC only
@ACC
P M: Output mode # + decimal ---
M only
S S: 1st word of set- WORD Yes (3)
tings table
ORIGIN SEARCH ORG 889 P: Port specifier # + decimal ---
ORG only
@ORG
P C: Control data # + decimal ---
C only

PULSE WITH VARI- PWM 891 P: Port specifier # + decimal ---

ABLE DUTY FAC- PWM only
@PWM
TOR P F: Frequency # + decimal ---
F only
D D: Duty factor # + decimal ---
only

101
Instruction Support and Operand Restrictions Section 2-6

2-6-20 Step Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
STEP DEFINE STEP 008 Not supported in func- B: Bit --- ---
tion blocks
STEP START SNXT 009 Not supported in func- B: Bit --- ---
tion blocks

2-6-21 Basic I/O Unit Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
I/O REFRESH IORF 097 Not supported in func- St: Starting word --- ---
@IORF tion blocks E: End word --- ---
7-SEGMENT SDEC 078 S: Source word UINT ---
DECODER SDEC
@SDEC Di: Digit designator UINT ---
S
D: 1st destination UINT Yes (not
Di word fixed)
D

DIGITAL SWITCH DSW 210 I: Data input word UINT ---

DSW
INPUT (D0 to D3)
I O: Output word UINT ---
O D: 1st result word WORD ---
D C1: Number of dig- UINT ---
C1 its
C2: System word WORD ---
C2

TEN KEY INPUT TKY 211 I: Data input word UINT ---
TKY
D1: 1st register UDINT ---
I word
D1 D2: Key input word UINT ---
D2

HEXADECIMAL HKY 212 I: Data input word UINT ---

KEY INPUT HKY
O: Output word UINT ---
I
D: 1st register word WORD Yes (3)
O
C: System word WORD ---
D
C

102
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
MATRIX INPUT MTR 213 I: Data input word UINT ---
MTR
O: Output word UINT ---
I
D: 1st destination ULINT Yes (4)
O word
D C: System word WORD ---
C

7-SEGMENT DIS- 7SEG 214 S: 1st source word WORD Yes (2)
PLAY OUTPUT 7SEG
O: Output word UINT ---
S
C: Control data # + decimal ---
O only
C D: System word WORD ---
D

INTELLIGENT I/O IORD 222 C: Control data UINT ---

READ IORD
@IORD S: Transfer source UDINT Yes (2)
C and number of UINT must
S words be used
D when
array vari-
ables are
required.
D: Transfer destina- UINT Yes (not
tion and number of fixed)
words
INTELLIGENT I/O IOWR 223 C: Control data UINT ---
WRITE IOWR
@IOWR S: Transfer source WORD Yes (not
C and number of fixed)
S words
D D: Transfer destina- UINT Yes (2)
tion and number of UINT must
words be used
when
array vari-
ables are
required.
CPU BUS UNIT I/O DLNK 226 DLNK N: Unit number UINT ---
REFRESH @DLNK N

103
Instruction Support and Operand Restrictions Section 2-6

2-6-22 Serial Communications Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
PROTOCOL MACRO PMCR 260 C1:Control word 1 UINT ---
PMCR
@PMCR C2: Control word 2 UINT ---
C1
S: 1st send word UINT Yes (not
C2 fixed)
S R: 1st receive word UINT Yes (not
fixed)
R

TRANSMIT TXD 236 S: 1st source word UINT Yes (not

TXD fixed)
@TXD
S C: Control word UINT ---
C N: Number of bytes UINT ---
N 0000 to 0100 hex(0
to 256 decimal)
RECEIVE RXD 235 D: 1st destination UINT Yes (not
RXD word fixed)
@RXD
D C: Control word UINT ---
C N: Number of bytes UINT ---
N to store 0000 to
0100 hex(0 to 256
decimal)
TRANSMIT VIA TXDU 256 S: 1st source word UINT Yes (not
SERIAL COMMUNI- TXDU fixed)
@TXDU
CATIONS UNIT S C: 1st control word UDINT ---
C N: Number of send UINT ---
N bytes (4 digits
BCD)
RECEIVE VIA RXDU 255 D: 1st destination UINT Yes (not
SERIAL COMMUNI- RXDU word fixed)
@RXDU
CATIONS UNIT D C: 1st control word UDINT ---
C N: Number of stor- UINT ---
N age bytes

CHANGE SERIAL STUP 237 C: Control word UINT ---

STUP
PORT SETUP @STUP (port)
C S: 1st source word UINT Yes (not
S fixed)

104
Instruction Support and Operand Restrictions Section 2-6

2-6-23 Network Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
NETWORK SEND SEND 090 S: 1st source word UINT Yes (not
SEND fixed)
@SEND
S D: 1st destination UINT Specify
D word address at
remote
C node with
AT setting.
C: 1st control word WORD Yes (5)
NETWORK RECEIVE RECV 098 S: 1st source word UINT Specify
RECV address at
@RECV
S remote
node with
D
AT setting.
C D: 1st destination UINT Yes (not
word fixed)
C: 1st control word WORD Yes (5)
DELIVER COMMAND CMND 490 S: 1st command UINT Yes (not
CMND word fixed)
@CMND
S D: 1st response UINT Yes (not
D word fixed)
C C: 1st control word WORD Yes (6)

EXPLICIT MESSAGE EXPLT 720 S: 1st word of send WORD Yes (not
SEND EXPLT message fixed)
S D: 1st word of WORD Yes (not
D received message fixed)
C C: 1st control word LWORD Yes (4)
WORD
must be
used
when
array vari-
ables are
required.
EXPLICIT GET EGATR 721 S: 1st word of send ULINT Yes (4)
ATTRIBUTE EGATR message WORD
S must be
D used
when
C array vari-
ables are
required.
D: 1st word of WORD Yes (not
received message fixed)
C: 1st control word LWORD Yes (4)
message

105
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
EXPLICIT SET ESATR 722 S: 1st word of send WORD Yes (not
ATTRIBUTE ESATR message fixed)
S C: 1st control word WORD Yes (3)
C

EXPLICIT WORD ECHRD 723 S: 1st source word UINT Specify

READ ECHRD in remote CPU Unit the desti-
S nation
address
D
when
C using AT
settings.
D: 1st destination UINT Yes (2)
word in local CPU
Unit
C: 1st control word WORD Yes (5)
EXPLICIT WORD ECHWR 724 S: 1st source word UINT Yes (not
WRITE ECHWR in local CPU Unit fixed)
S D: 1st destination UINT Specify
D word in remote the desti-
CPU Unit nation
C address
when
using AT
settings.
C: 1st control word WORD Yes (5)

106
Instruction Support and Operand Restrictions Section 2-6

2-6-24 File Memory Instructions

Instruction Mnemonic Function Symbol Operand Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
READ DATA FILE FREAD 700 C: Control word UINT ---
FREAD
@FREAD S1: 1st source word LWORD Yes (2)
C
DWORD
S1 must be
S2 used
when
D array vari-
ables are
required.
S2: Filename UINT Yes (39)
D: 1st destination UINT Yes (not
word fixed)
WRITE DATA FILE FWRIT 701 C: Control word UINT ---
FWRIT
@FWRIT D1: 1st destination LWORD Yes (2)
C word DWORD
D1 must be
D2 used
when
S array vari-
ables are
required.
D2: Filename UINT Yes (39)
S: 1st source word UINT Yes (not
fixed)
WRITE TEXT FILE TWRIT 704 C: Control word UINT ---
TWRIT
@TWRIT S1: Number of UINT Yes (2)
C bytes to write
S1 S2: Directory and WORD Yes (39)
S2 file name
S3 S3: Write data WORD Yes (not
fixed)
S4
S4: Delimiter WORD Yes (2)

107
Instruction Support and Operand Restrictions Section 2-6

2-6-25 Display Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe
ses.)
DISPLAY MESSAGE MSG 046 N: Message num- UINT ---
MSG
@MSG ber
N M: 1st message UINT Yes (16)
M word

SEVEN-SEGMENT SCH 047 S: Message data WORD ---

LED WORD DATA SCH
@SCH C: Leftmost/right- UINT ---
DISPLAY S most 2 digits speci-
C fier

SEVEN-SEGMENT SCTRL 048 S: Control data UINT ---

SCTRL
LED CONTROL @SCTRL
S

2-6-26 Clock Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
CALENDAR ADD CADD 730 C: 1st calendar WORD Yes (3)
CADD word
@CADD
C T: 1st time word DWORD Yes (2)
T WORD
R must be
used
when
array vari-
ables are
required.
R: 1st result word WORD Yes (3)
CALENDAR SUB- CSUB 731 C: 1st calendar WORD Yes (3)
TRACT CSUB word
@CSUB
C T: 1st time word DWORD Yes (2)
T WORD
R must be
used
when
array vari-
ables are
required.
R: 1st result word WORD Yes (3)

108
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
HOURS TO SEC- SEC 065 S: 1st source word DWORD Yes (2)
SEC
ONDS @SEC WORD
S must be
D used
when
array vari-
ables are
required.
D: 1st destination DWORD Yes (2)
word WORD
must be
used
when
array vari-
ables are
required.
SECONDS TO HMS 066 S: 1st source word DWORD Yes (2)
HMS
HOURS @HMS WORD
S must be
D used
when
array vari-
ables are
required.
D: 1st destination DWORD Yes (2)
word WORD
must be
used
when
array vari-
ables are
required.
CLOCK ADJUST- DATE 735 S: 1st source word LWORD Yes (4)
MENT DATE
@DATE WORD
S must be
used
when
array vari-
ables are
required.

109
Instruction Support and Operand Restrictions Section 2-6

2-6-27 Debugging Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
TRACE MEMORY TRSM 045 --- --- ---
SAMPLING TRSM

2-6-28 Failure Diagnosis Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
FAILURE ALARM FAL 006 N: FAL number # + decimal ---
FAL
@FAL only
N M: 1st message WORD ---
M word or error code
to generate(#0000
to #FFFF)
SEVERE FAILURE FALS 007 N: FALS number # + decimal ---
FALS
ALARM only
N M: 1st message WORD ---
M word or error code
to generate(#0000
to #FFFF)
FAILURE POINT FPD 269 Not supported in func- C: Control word --- ---
DETECTION tion blocks T: Monitoring time --- ---
R: 1st register word --- ---

110
Instruction Support and Operand Restrictions Section 2-6

2-6-29 Other Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
SET CARRY STC 040 --- --- ---
STC
@STC
CLEAR CARRY CLC 041 --- --- ---
CLC
@CLC
SELECT EM BANK EMBC 281 N: EM bank num- UINT ---
EMBC ber.
@EMBC
N

EXTEND MAXI- WDT 094 T: Timer setting Constants ---

MUM CYCLE TIME @WDT WDT only
T

SAVE Condition CCS 282 --- --- ---

CCS
FlagS @CCS
LOAD Condition CCL 283 --- --- ---
CCL
FlagS @CCL
CONVERT FRMCV 284 S: Word containing --- ---
FRMCV
ADDRESS FROM @FRMCV CV-series memory
CV S address
D D: Destination --- ---
Index Register
CONVERT TOCV 285 S: Index Register --- ---
TOCV
ADDRESS TO CV @TOCV containing CS
S Series memory
address
D
D: Destination word --- ---
DISABLE PERIPH- IOSP 287 --- --- ---
ERAL SERVICING @IOSP IOSP

ENABLE PERIPH- IORS 288 --- --- ---

ERAL SERVICING IORS

111
Instruction Support and Operand Restrictions Section 2-6

2-6-30 Block Programming Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
BLOCK PROGRAM BPRG 096 Not supported in func- N: Block program --- ---
BEGIN tion blocks number
BLOCK PROGRAM BEND 801 Not supported in func- --- --- ---
END tion blocks
BLOCK PROGRAM BPPS 811 Not supported in func- N: Block program --- ---
PAUSE tion blocks number
BLOCK PROGRAM BPRS 812 Not supported in func- N: Block program --- ---
RESTART tion blocks number
CONDITIONAL CONDI- 806 Not supported in func- --- --- ---
BLOCK EXIT TION EXIT tion blocks
CONDITIONAL EXIT Bit 806 Not supported in func- B: Bit operand --- ---
BLOCK EXIT operand tion blocks
CONDITIONAL EXIT NOT 806 Not supported in func- B: Bit operand --- ---
BLOCK EXIT (NOT) Bit operand tion blocks
CONDITIONAL CONDI- 802 Not supported in func- --- --- ---
BLOCK BRANCHING TION IF tion blocks
CONDITIONAL IF Bit oper- 802 Not supported in func- B: Bit operand --- ---
BLOCK BRANCHING and tion blocks
CONDITIONAL IF NOT Bit 802 Not supported in func- B: Bit operand --- ---
BLOCK BRANCH- operand tion blocks
ING (NOT)
CONDITIONAL ELSE 803 Not supported in func- --- --- ---
BLOCK BRANCH- tion blocks
ING (ELSE)
CONDITIONAL IEND 804 Not supported in func- --- --- ---
BLOCK BRANCH- tion blocks
ING END
ONE CYCLE AND CONDI- 805 Not supported in func- --- --- ---
WAIT TION WAIT tion blocks
ONE CYCLE AND WAIT Bit 805 Not supported in func- B: Bit operand --- ---
WAIT operand tion blocks
ONE CYCLE AND WAIT NOT 805 Not supported in func- B: Bit operand --- ---
WAIT (NOT) Bit operand tion blocks
TIMER WAIT TIMW 813 Not supported in func- N: Timer number --- ---
(BCD) tion blocks SV: Set value --- ---
TIMWX 816 Not supported in func- N: Timer number --- ---
(BIN) tion blocks SV: Set value --- ---
COUNTER WAIT CNTW 814 Not supported in func- N: Counter number --- ---
(BCD) tion blocks SV: Set value --- ---
I: Count input --- ---
CNTWX 817 Not supported in func- N: Counter number --- ---
(BIN) tion blocks SV: Set value --- ---
I: Count input --- ---

112
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
HIGH-SPEED TIMER TMHW 815 Not supported in func- N: Timer number --- ---
WAIT (BCD) tion blocks SV: Set value --- ---
TMHWX 818 Not supported in func- N: Timer number --- ---
(BIN) tion blocks SV: Set value --- ---
LOOP LOOP 809 Not supported in func- --- --- ---
tion blocks
LEND LEND 810 Not supported in func- --- --- ---
tion blocks
LEND LEND Bit 810 Not supported in func- B: Bit operand --- ---
operand tion blocks
LEND NOT LEND NOT 810 Not supported in func- B: Bit operand --- ---
Bit operand tion blocks

2-6-31 Text String Processing Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
MOV STRING MOV$ 664 S: 1st source word UINT Yes (not
MOV$
@MOV$ fixed)
S D: 1st destination UINT Yes (not
D word fixed)

CONCATENATE +$ 656 S1: Text string 1 INT Yes (not

STRING +$ fixed)
@+$
S1 S2: Text string 2 INT Yes (not
S2 fixed)
D D: First destination INT Yes (not
word fixed)
GET STRING LEFT LEFT$ 652 S1: Text string first UINT Yes (not
LEFT$ word fixed)
@LEFT$
S1 S2: Number of UINT ---
S2 characters
D D: First destination UINT Yes (not
word fixed)
GET STRING RGHT$ 653 S1: Text string first UINT Yes (not
RIGHT RGHT$ word fixed)
@RGHT$
S1 S2: Number of UINT ---
S2 characters
D D: First destination UINT Yes (not
word fixed)

113
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
GET STRING MID- MID$ 654 S1: Text string first UINT Yes (not
DLE MID$ word fixed)
@MID$
S1 S2: Number of UINT ---
S2 characters
S3 S3: Beginning posi- UINT ---
tion
D
D: First destination UINT Yes (not
word fixed)
FIND IN STRING FIND$ 660 S1: Source text UINT Yes (not
FIND$ string first word fixed)
@FIND$
S1 S2: Found text UINT Yes (not
S2 string first word fixed)
D D: First destination UINT ---
word
STRING LENGTH LEN$ 650 S: Text string first UINT Yes (not
LEN$
@LEN$ word fixed)
S D: 1st destination UINT ---
D word

REPLACE IN RPLC$ 661 S1: Text string first UINT Yes (not
RPLC$
STRING @RPLC$ word fixed)
S1 S2: Replacement UINT Yes (not
S2 text string first word fixed)
S3 S3: Number of UINT ---
characters
S4
S4: Beginning posi- UINT ---
D tion
D: First destination UINT Yes (not
word fixed)
DELETE STRING DEL$ 658 S1: Text string first UINT Yes (not
DEL$ word fixed)
@DEL$
S1 S2: Number of UINT ---
S2 characters
S3 S3: Beginning posi- UINT ---
tion
D
D: First destination UINT Yes (not
word fixed)
EXCHANGE XCHG$ 665 Ex1: 1st exchange UINT Yes (not
XCHG$
STRING @XCHG$ word 1 fixed)
Ex1 Ex2: 1st exchange UINT Yes (not
Ex2 word 2 fixed)

CLEAR STRING CLR$ 666 S: Text string first UINT Yes (not
CLR$ word fixed)
@CLR$
S

114
Instruction Support and Operand Restrictions Section 2-6

Instruction Mnemonic Function Symbol Operands Supported AT

code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
INSERT INTO INS$ 657 S1: Base text string UINT Yes (not
STRING INS$ first word fixed)
@INS$
S1 S2: Inserted text UINT Yes (not
S2 string first word fixed)
S3 S3: Beginning posi- UINT ---
tion
D
D: First destination UINT Yes (not
word fixed)
String Comparison LD,AND, OR 670 (=$) S1: Text string 1 UINT Yes (not
Symbol
+ 671 (<>$) fixed)
=$,<>$,<$,< 672 (<$) S1 S2: Text string 2 UINT Yes (not
=$,>$,>=$ S2 fixed)
673 (<=$)
674 (>$)
675 (>=$)

2-6-32 Task Control Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
TASK ON TKON 820 N: Task number # + decimal ---
TKON only
@TKON
N

TASK OFF TKOF 821 N: Task number # + decimal ---

TKOF only
@TKOF
N

115
Instruction Support and Operand Restrictions Section 2-6

2-6-33 Model Conversion Instructions

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
BLOCK TRANSFER XFERC 565 W: Number of WORD ---
XFERC words (in BCD)
@XFERC
W S: 1st source word WORD Yes (not
S fixed)
D D: 1st destination WORD Yes (not
word fixed)
SINGLE WORD DIS- DISTC 566 S1: Source word WORD ---
TRIBUTE DISTC
@DISTC D: Destination base WORD Yes (not
S1 address fixed)
D S2: Offset (in BCD) WORD ---
S2

DATA COLLECT COLLC 567 S1: Source base WORD Yes (not
COLLC address fixed)
@COLLC
S1 S2: Offset (in BCD) WORD ---
S2 D: Destination word WORD ---
D

MOVE BIT MOVBC 568 S: Source word or WORD ---

MOVBC data
@MOVBC
S C: Control word (in WORD ---
C BCD)
D D: Destination word WORD ---

BIT COUNTER BCNTC 621 W: Number of WORD ---

BCNTC words (in BCD)
@BCNTC
W S: 1st source word UINT Yes (not
S fixed)
D D: Result word WORD ---

116
CPU Unit Function Block Specifications Section 2-7

2-6-34 Special Instructions for Function Blocks

Instruction Mnemonic Function Symbol Operands Supported AT
code variable setting or
data types array
variable
required
(Required
word data
size
shown in
parenthe-
ses.)
GET VARIABLE ID GETID 286 S: Source variable WORD ---
GETID or address
@GETIC
S D1: Variable type WORD ---
D1 (I/O memory area)
code
D2
D2: Word address WORD ---

2-7 CPU Unit Function Block Specifications

The specifications of the functions blocks used in CS/CJ-series and CP-series
CPU Units are given in the following tables. Refer to the other operation man-
uals for the CS/CJ Series and CP Series for other specifications.

2-7-1 Specifications
CS1-H CPU Units
Item Specification
Model CS1H- CS1H- CS1H- CS1H- CS1H- CS1G- CS1G- CS1G- CS1G-
CPU67H CPU66H CPU65H CPU64H CPU63H CPU45H CPU44H CPU43H CPU42H
I/O points 5,120 1,280 960
Program capacity 250K 120K 60K 30K 20K 60K 30K 20K 10K
(steps)
Data memory 32K words
Extended Data 32K 32K 32K 32K words × 1 bank 32K 32K words × 1 bank
Memory words × words × words × E0_00000 to words × E0_00000 to E0_32767
13 banks 7 banks 3 banks E0_32767 3 banks
E0_00000 E0_00000 E0_00000 E0_00000
to to to to
EC_32767 E6_32767 E2_32767 E2_32767
Function Maxi- 1,024 1,024 1,024 1,024 128 1,024 1,024 128 128
blocks mum
number of
definitions
Maxi- 2,048 2,048 2,048 2,048 256 2,048 2,048 256 256
mum
number of
instances
Com- Total for 2,048 2,048 1,280 1,280 1,280 1,280 704 704 704
ment all files
Memory (Kbytes)
Unit (ver.
4.0 or
later)

117
CPU Unit Function Block Specifications Section 2-7

Item Specification
Inside Function 1,664 1,664 1,024 512 512 1,024 512 512 512
com- block pro-
ment gram
memory memory
(ver. 3.0 (Kbytes)
or later) Com- 128 128 64 64 64 64 64 64 64
ment files
(Kbytes)
Program 128 128 64 64 64 64 64 64 64
index files
(Kbytes)
Variable 128 128 128 64 64 128 64 64 64
tables
(Kbytes)

CJ1-H CPU Units

Item Specification
Model CJ1H- CJ1H- CJ1H- CJ1G- CJ1G- CJ1G- CJ1G-
CPU67H CPU66H CPU65H CPU45H CPU44H CPU43H CPU42H
I/O points 2,560 1,280 960
Program capacity 250K 120K 60K 60K 30K 20K 10K
(steps)
Data memory 32K words
Extended Data 32K words 32K words 32K words 32K words 32K words × 1 bank
Memory × 13 banks × 7 banks × 3 banks × 3 banks E0_00000 to E0_32767
E0_00000 E0_00000 E0_00000 E0_00000
to to to to
EC_32767 E6_32767 E2_32767 E2_32767
Function Maxi- 1,024 1,024 1,024 1,024 1,024 128 128
blocks mum
number of
definitions
Maxi- 2,048 2,048 2,048 2,048 2,048 256 256
mum
number of
instances
Com- Total for 2,048 2,048 1,280 1,280 1,280 1,280 704
ment all files
Memory (Kbytes)
Unit (ver.
4.0 or
later)
Inside Function 1,664 1,664 1,024 1,024 512 512 512
com- block pro-
ment gram
memory memory
(ver. 3.0 (Kbytes)
or later) Com- 128 128 64 64 64 64 64
ment files
(Kbytes)
Program 128 128 64 64 64 64 64
index files
(Kbytes)
Variable 128 128 128 128 64 64 64
tables
(Kbytes)

118
CPU Unit Function Block Specifications Section 2-7

CJ1M CPU Units

Item Specification
Units with internal I/O functions Units without internal I/O functions
Model CJ1M-CPU23 CJ1M-CPU22 CJ1M-CPU21 CJ1M-CPU13 CJ1M-CPU12 CJ1M-CPU11
I/O points 640 320 160 640 320 160
Program capacity 20K 10K 5K 20K 10K 5K
(steps)
Number of Expan- 1 max. Expansion not supported 1 max. Expansion not supported
sion Racks
Data memory 32K words
Extended Data None
Memory
Pulse start times 46 µs (without acceleration/ 63 µs (without ---
deceleration) acceleration/
70 µs (with acceleration/decel- deceleration)
eration) 100 µs (with
acceleration/
deceleration)
Number of sched- 2 1 2 1
uled interrupts
PWM outputs 2 1 None
Maximum value of 1,024 256 1,024 256
subroutine number
Maximum value of 1,024 256 1,024 256
jump number in JMP
instruction
Internal inputs 10 points ---
• 4 interrupt inputs (pulse catch)
• 2 high-speed counter inputs (50-kHz phase dif-
ference or 100-kHz single-phase)
Internal outputs 6 points 6 points ---
• 2 pulse outputs (100 kHz) • 2 pulse out-
• 2 PWM outputs puts
(100 kHz)
• 1 PWM out-
put
Function Maxi- 128
blocks mum
number of
definitions
Maxi- 256
mum
number of
instances
Com- Total for 704
ment all files
Memory (Kbytes)
Unit (ver.
4.0 or
later)

119
CPU Unit Function Block Specifications Section 2-7

Item Specification
Units with internal I/O functions Units without internal I/O functions
Inside Function 256
com- block pro-
ment gram
memory memory
(ver. 3.0 (Kbytes)
or later) Com- 64
ment files
(Kbytes)
Program 64
index files
(Kbytes)
Variable 64
tables
(Kbytes)

CP1H CPU Units

Item X models XA models Y models
Model CP1H-X40DR-A CP1H-XA40DR-A CP1H-Y20DT-D
CP1H-X40DT-D CP1H-XA40DT-D
CP1H-X40DT1-D CP1H-XA40DT1-D
Max. number of I/O points 320 points (40 built-in points + 40 points/Expansion 300 points (20 built-in
Rack x 7 Racks) points + 40 points/Expan-
sion Rack x 7 Racks)
Program capacity (steps) 20K
Data memory 32K words
Number of connectable Expan- 7 Units (CPM1A-series Expansion Units and Expansion I/O Units)
sion Units and Expansion I/O Units
Function blocks Maximum num- 128
ber of definitions
Maximum num- 256
ber of instances
Flash memory Function block 256
program mem-
ory (Kbytes)
Comment files 64
(Kbytes)
Program index 64
files (Kbytes)
Variable tables 64
(Kbytes)

120
CPU Unit Function Block Specifications Section 2-7

NSJ-series NSJ Controllers

Model NSJ5-TQ0@-G5D, NSJ5-SQ0@-G5D, NSJ5-TQ0@-M3D, NSJ5-SQ0@-M3D,
NSJ8-TV0@-G5D, NSJ10-TV0@-G5D, NSJ8-TV0@-M3D
NSJ12-TS0@-G5D,
Max. number of I/O points 1,280 640
Program capacity (steps) 60K 20K
Data memory 32K words
Extended data memory 32K words × 3 banks None
E0_00000 to E2_32767
Function blocks Maximum num- 1,024 128
ber of definitions
Maximum num- 2,048 256
ber of instances
Comment mem- Function block 1,024 256
ory program mem-
ory (Kbytes)
Comment files 64 64
(Kbytes)
Program index 64 64
files (Kbytes)
Variable tables 128 64
(Kbytes)

FQM1 Flexible Motion Controllers

Item Coordinator Module Motion Control Modules
Model FQM1-CM002 FQM1-MMA22 FQM1-MMP22
Max. number of I/O points 344 points (24 built-in 20 built-in points
points + 320 points on
Basic I/O Units)
Program capacity (steps) 10K
Data memory 32K words
Function blocks Maximum num- 128
ber of definitions
Maximum num- 256
ber of instances
Flash memory Function block 256
program mem-
ory (Kbytes)
Comment files 64
(Kbytes)
Program index 64
files (Kbytes)
Variable tables 64
(Kbytes)

121
Number of Function Block Program Steps and Instance Execution Time Section 2-8

2-7-2 Operation of Timer Instructions

There is an option called Apply the same spec as T0-2047 to T2048-4095 in
the PLC properties. This setting affects the operation of timers as described in
this section.

Selecting the Option If this option is selected, all timers will operate the same regardless of timer
(Default) number, as shown in the following table.
Timer Operation for Timer Numbers T0000 to T4095
Refresh Description
When instruction is The PV is refreshed each time the instruction is executed.
executed If the PV is 0, the Completion Flag is turned ON. If it is not 0,
the Completion Flag is turned OFF.
When execution of all All PV are refreshed once each cycle.
tasks is completed
Every 80 ms If the cycle time exceeds 80 ms, all PV are refreshed once
every 80 ms.

Not Selecting the If this option is not selected, the refreshing of timer instructions with timer
Option numbers T0000 to T2047 will be different from those with timer numbers
T2048 to T4095, as given below. This behavior is the same for CPU Units that
do not support function blocks. (Refer to the descriptions of individual instruc-
tion in the CS/CJ Series Instruction Reference for details.)
Timer Operation for Timer Numbers T0000 to T2047
Refresh Description
When instruction is The PV is refreshed each time the instruction is executed.
executed If the PV is 0, the Completion Flag is turned ON. If it is not 0,
the Completion Flag is turned OFF.
When execution of all All PV are refreshed once each cycle.
tasks is completed
Every 80 ms If the cycle time exceeds 80 ms, all PV are refreshed once
every 80 ms.

Timer Operation for Timer Numbers T2048 to T4095

Refresh Description
When instruction is The PV is refreshed each time the instruction is executed.
executed If the PV is 0, the Completion Flag is turned ON. If it is not 0,
the Completion Flag is turned OFF
When execution of all PV are not updated.
tasks is completed
Every 80 ms PV are not updated even if the cycle time exceeds 80 ms.

Select the Apply the same spec as TO-2047 to T2048-4095 Option to ensure
consistent operation when using the timer numbers allocated by default to
function block variables (T3072 to T4095).

2-8 Number of Function Block Program Steps and Instance

Execution Time
2-8-1 Number of Function Block Program Steps
This section applies only to CP-series CPU Units with unit version Ver. 1.0 or
later and CS/CJ-series CPU Units with unit version Ver. 3.0 or later, NSJ Con-
trollers, and FQM1 Flexible Motion Controllers.

122
Number of Function Block Program Steps and Instance Execution Time Section 2-8

Use the following equation to calculate the number of program steps when
function block definitions have been created and the instances copied into the
user program of the CPU Unit.
Number of steps
= Number of instances × (Call part size m + I/O parameter transfer part size n × Num-
ber of parameters) + Number of instruction steps in the function block definition p
(See note.)

Note The number of instruction steps in the function block definition (p) will not be
diminished in subsequence instances when the same function block definition
is copied to multiple locations (i.e., for multiple instances). Therefore, in the
above equation, the number of instances is not multiplied by the number of
instruction steps in the function block definition (p).
The following table applies only to CP-series CPU Units with unit version Ver.
1.0 or later and CS/CJ-series CPU Units with unit version Ver. 3.0 or later,
NSJ Controllers, and FQM1 Flexible Motion Controllers.

Contents Number of steps

m Call part 57 steps
n I/O parameter 1-bit input variable, output 6 steps
transfer part variable, or input-output
The data type is variable (BOOL)
shown in parenthe- 1-word input variable, out- 6 steps
ses. put variable, or input-out-
put variable (INT, UINT,
WORD)
2-word input variable, out- 6 steps
put variable, or input-out-
put variable (DINT, UDINT,
DWORD, REAL)
4-word input variable, out- 12 steps
put variable, or input-out-
put variable (LINT, ULINT,
LWORD, LREAL)
p Number of instruc- The total number of instruction steps (same as standard
tion steps in func- user program) + 27 steps.
tion block definition

Example:
Input variables with a 1-word data type (INT): 5
Output variables with a 1-word data type (INT): 5
Function block definition section: 100 steps
Number of steps for 1 instance = 57 + (5 + 5) × 6 steps + 100 steps + 27 steps
= 244 steps

2-8-2 Function Block Instance Execution Time

This section applies only to CP-series CPU Units with unit version Ver. 1.0 or
later and CS/CJ-series CPU Units with unit version Ver. 3.0 or later, NSJ Con-
trollers, and FQM1 Flexible Motion Controllers.
Use the following equation to calculate the effect of instance execution on the
cycle time when function block definitions have been created and the
instances copied into the CPU Unit’s user program.
Effect of Instance Execution on Cycle Time
= Startup time (A)
+ I/O parameter transfer processing time (B)
+ Execution time of instructions in function block definition (C)

123
Number of Function Block Program Steps and Instance Execution Time Section 2-8

The following table shows the length of time for A, B, and C.

Operation CPU Unit model
CS1H-CPU6@H CS1G-CPU4@H CJ1M-CPU@@
CJ1H-CPU6@H CJ1G-CPU4@H CP1H-X@@@-@
NSJ CP1H-XA@@@-@
CP1H-Y@@@-@
A Startup time Startup time not including 6.8 µs 8.8 µs 15.0 µs
I/O parameter transfer
B I/O parameter trans- 1-bit input variable, out- 0.4 µs 0.7 µs 1.0 µs
fer processing time put variable, or input-out-
The data type is put variable (BOOL)
indicated in paren- 1-word input variable, 0.3 µs 0.6 µs 0.8 µs
theses. output variable, or input-
output variable (INT,
UINT, WORD)
2-word input variable, 0.5 µs 0.8 µs 1.1 µs
output variable, or input-
output variable (DINT,
UDINT, DWORD, REAL)
4-word input variable, 1.0 µs 1.6 µs 2.2 µs
output variable, or input-
output variable (LINT,
ULINT, LWORD, LREAL)
C Function block defi- Total instruction processing time (same as standard user program)
nition instruction
execution time

Example: CS1H-CPU63H
Input variables with a 1-word data type (INT): 3
Output variables with a 1-word data type (INT): 2
Total instruction processing time in function block definition section: 10 µs
Execution time for 1 instance = 6.8 µs + (3 + 2) × 0.3 µs + 10 µs = 18.3 µs
Note The execution time is increased according to the number of multiple instances
when the same function block definition has been copied to multiple locations.

124
 SECTION 3
Creating Function Blocks

This section describes the procedures for creating function blocks on the CX-Programmer.

3-1 Procedural Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

3-2 Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
3-2-1 Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
3-2-2 Creating a New Function Block Definition . . . . . . . . . . . . . . . . . . . 128
3-2-3 Defining Function Blocks Created by User . . . . . . . . . . . . . . . . . . . 131
3-2-4 Creating Instances from Function Block Definitions . . . . . . . . . . . . 143
3-2-5 Setting Function Block Parameters Using the Enter Key. . . . . . . . . 145
3-2-6 Setting the FB Instance Areas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
3-2-7 Checking Internal Address Allocations for Variables . . . . . . . . . . . 149
3-2-8 Copying and Editing Function Block Definitions . . . . . . . . . . . . . . 151
3-2-9 Checking the Source Function Block Definition from an Instance . 151
3-2-10 Checking Instance Information such as Nesting Levels . . . . . . . . . . 151
3-2-11 Checking the Size of the Function Block Definition . . . . . . . . . . . . 152
3-2-12 Compiling Function Block Definitions (Checking Program). . . . . . 152
3-2-13 Printing Function Block Definition . . . . . . . . . . . . . . . . . . . . . . . . . 153
3-2-14 Password Protection of Function Block Definitions. . . . . . . . . . . . . 154
3-2-15 Saving and Reusing Function Block Definition Files . . . . . . . . . . . 157
3-2-16 Downloading/Uploading Programs to the Actual CPU Unit . . . . . . 158
3-2-17 Monitoring and Debugging Function Blocks . . . . . . . . . . . . . . . . . . 158

125
Procedural Flow Section 3-1

3-1 Procedural Flow

The following procedures are used to create function blocks, save them in
files, transfer them to the CPU Unit, monitor them, and debug them.

Creating Function Blocks

Create a Project Refer to 3-2-1 Creating a Project for details.
■ Creating a New Project

1,2,3... 1. Start the CX-Programmer and select New from the File Menu.
2. Select a Device type: CS1G-H, CS1H-H, CJ1G-H, CJ1H-H, CJ1M, or
CP1H, NSJ, or FQM1-CM (MMA/MMP).
■ Reusing an Existing CX-Programmer Project

1,2,3... 1. Start the CX-Programmer, and read the existing project file (.cxp) created
using CX-Programmer Ver. 4.0 or earlier by selecting the file from the File
Menu.
2. Select a Device type: CS1H-H, CS1G-H, CJ1G-H, CJ1H-H, CJ1M, or
CP1H, NSJ, or FQM1-CM (MMA/MMP).
Create a Function Block Refer to 3-2-2 Creating a New Function Block Definition for details.
Definition

1,2,3... 1. Select Function Blocks in the project workspace and right-click.

2. Select Insert Function Block - Ladder or Insert Function Blocks -
Structured Text from the pop-up menu.
Define the Function Block Refer to 3-2-3 Defining Function Blocks Created by User for details.
■ Registering Variables before Inputting the Ladder Program or ST Program

1,2,3... 1. Register variables in the variable table.

2. Create the ladder program or ST program.
■ Registering Variables as Necessary while Inputting the Ladder Program
or ST Program

1,2,3... 1. Create the ladder program or ST program.

2. Register a variable in the variable table whenever required.
Create an Instance from Refer to 3-2-4 Creating Instances from Function Block Definitions for details.
the Function Block
Definition
■ Inserting Instances in the Ladder Section Window and then Inputting the
Instance Name

1,2,3... 1. Place the cursor at the location at which to create an instance (i.e., a copy)
of the function block and press the F Key.
2. Input the name of the instance.
3. Select the function block definition to be copied.
■ Registering Instance Names in the Global Symbol Table and then
Selecting the Instance Name when Inserting

1,2,3... 1. Select Function Block as the data type for the variable in the global symbol
table.
2. Press the F Key in the Ladder Section Window.

126
Procedural Flow Section 3-1

3. Select the name of the instance that was registered from the pull-down
menu on the FB Instance Field.

Allocate External I/O to Refer to 3-2-5 Setting Function Block Parameters Using the Enter Key for
the Function Block details.

1,2,3... 1. Place the cursor at the position of the input variable or output variable and
press the P Key.
2. Input the source address for the input variable or the destination address
for the output variable.
Set the Function Block Refer to 3-2-6 Setting the FB Instance Areas for details.
Memory Allocations
(Instance Areas)

1,2,3... 1. Select the instance and select Function Block Memory - Function Block
Memory Allocation from the PLC Menu.
2. Set the function block memory allocations.

Printing, Saving, and Reusing Function Block Files

Compile the Function Refer to 3-2-12 Compiling Function Block Definitions (Checking Program) and
Block Definition and Save 3-2-15 Saving and Reusing Function Block Definition Files for details.
It as a Library File

1,2,3... 1. Compile the function block that has been saved.

2. Print the function block.
3. Save the function block as a function block definition file (.cxf).
4. Read the file into another PLC project.

Transferring the Program to the PLC

Refer to 3-2-16 Downloading/Uploading Programs to the Actual CPU Unit.

Monitoring and Debugging the Function Block

Refer to 3-2-17 Monitoring and Debugging Function Blocks.

127
Procedures Section 3-2

3-2 Procedures
3-2-1 Creating a Project
Creating New Projects
with CX-Programmer
1,2,3... 1. Start the CX-Programmer and select New from the File Menu.
2. In the Change PLC Window, select a Device Type that supports function
blocks. These are listed in the following table.
Device CPU
CS1G-H CPU42H/43H/44H/45H
CS1H-H CPU63H/64H/65H/66H/67H
CJ1G-H CPU42H/43H/44H/45H
CJ1H-H CPU65H/66H/67H
CJ1M CPU11/12/13/21/22/23
CP1H CP1H-XA/X/Y
NSJ G5D (Used for the NSJ5-TQ0@-G5D, NSJ5-SQ0@-G5D, NSJ8-
TV0@-G5D, NSJ10-TV0@-G5D, and NSJ12-TS0@-G5D)
M3D (Used for the NSJ5-TQ0@-M3D, NSJ5-SQ0@-M3D, and
NSJ8-TV0@-M3D)
FQM1-CM FQM1-CM002
FQM1-MMA FQM1-MMA22
FQM1-MMP FQM1-MMP22

3. Press the Settings Button and select the CPU Type. For details on other
settings, refer to the CX-Programmer Ver. 5.0 Operation Manual (W414).

3-2-2 Creating a New Function Block Definition

1,2,3... 1. When a project is created, a Function Blocks icon will appear in the project
workspace as shown below.

Function Blocks will appear under the PLC.

2. Function block definitions are created by inserting function block defini-

tions after the Function Blocks icon.
Creating Function Block Function blocks can be defined by the user using either ladder programming
Definitions or structured text.
Creating (Inserting) Function Block Definitions with Ladders
1. Select Function Blocks in the project workspace, right-click, and select
Insert Function Blocks - Ladder from the pop-up menu. (Or select Func-
tion Block - Ladder from the Insert Menu.)

128
Procedures Section 3-2

Creating (Inserting) Function Block Definitions with Structured Text

1. Select Function Blocks in the project workspace, right-click, and select
Insert Function Blocks - Structured Text from the pop-up menu. (Or se-
lect Function Block - Structured Text from the Insert Menu.)

FunctionBlock1 is displayed as the Icon

under the Function Blocks Icon ( ).

2. A function block called FunctionBlock1 will be automatically inserted either

after the for ladder programming language (default) or the for ST
language. This icon contains the definitions for the newly created (insert-
ed) function block.
3. Whenever a function block definition is created, the name FunctionBlock@
will be assigned automatically, where @ is a serial number. These names
can be changed. All names must contain no more than 64 characters.

Using OMRON FB Library Files

Use the following procedure to insert OMRON FB Library files (.cxf).
1. Select Function Blocks in the project workspace, right-click, and select
Insert Function Blocks - Library File from the pop-up menu. (Or select
Function Block - Library File from the Insert Menu.)
2. The following Select Function Block Library File Dialog Box will be dis-
played.

Note To specify the default folder (file location) in the Function Block Li-
brary File Dialog Box, select Tools - Options, click the General
Tab and the select the default file in the OMRON FB library storage
location field.
3. Specify the folder in which the OMRON FB Library file is located, select the
library file, and click the Open Button. The library file will be inserted as a
function block definition after the .

129
Procedures Section 3-2

Function Block Definitions

Creating Function Block One of the following windows will be displayed when the newly created Func-
Definitions tion Block 1 icon is double-clicked (or if it is right-clicked and Open is selected
from the pop-up menu). A variable table for the variables used in the function
block is displayed on top and an input area for the ladder program or struc-
tured text is displayed on the bottom.
Ladder Program

Variable table

Ladder input area

Structured Text

Variable table

ST input area

As shown, a function block definition consists of a variable table that serves

as an interface and a ladder program or structured text that serves as an algo-
rithm.
Variable Table as an Interface
At this point, the variable table is empty because there are no variables allo-
cated for I/O memory addresses in the PLC.
Ladder Program or Structure Text as an Algorithm
• With some exceptions, the ladder program for the function block can con-
tain any of the instructions used in the normal program. Refer to 2-3
Restrictions on Function Blocks for restrictions on the instructions that
can be used.
• Structured text can be input according to the ST language defined in
IEC61131-3.
Using OMRON FB Library Double-click the inserted function block library (or right-click and select Open
Files from the pop-up menu) to display the variable table that has finished being
created at the top right window, and the ladder program that has finished
being created in the bottom right window. Both windows are displayed in gray
and cannot be edited.

130
Procedures Section 3-2

Variable table

Ladder program

Note Function block definitions are not displayed in the default settings for OMRON
FB Library files (.cxf). To display definitions, select the Display the inside of
FB option in the function block properties. (Select the OMRON FB Library file
in the project workspace, right-click, select Properties, and select the Dis-
play the inside of FB option in the General Tab.)

3-2-3 Defining Function Blocks Created by User

A function block is defined by registering variables and creating an algorithm.
There are two ways to do this.
• Register the variables first and then input the ladder program or structure
text.
• Register variables as they are required while inputting input the ladder
program or structure text.

Registering Variables First

Registering Variables in The variables are divided by type into five sheets in the variable table: Inter-
the Variable Table nals, Inputs, Outputs, Input-Output, and Externals.
These sheets must be switched while registering or displaying the variables.

1,2,3... 1. Make the sheet for the type of variable to be registered active in the vari-
able table. (See note.) Place the cursor in the sheet, right-click, and per-
form either of the following operations:
• To add a variable to the last line, select Insert Variable from the pop-
up menu.
• To add the variable to the line above or below a line within the list, se-
lect Insert Variable - Above or Below from the pop-up menu.
Note The sheet where a variable is registered can also be switched
when inserting a variable by setting the usage (N: Internals, I: In-
puts, O: Outputs, E: Externals, P: In Out).
The New Variable Dialog Box shown below will be displayed.
• Name: Input the name of the variable.
• Data Type: Select the data type.
• Usage: Select the variable type.
• Initial Value: Select the initial value of the variable at the start of oper-
ation.
• Retain: Select if the value of the variable is to be maintained when the
power is turned ON or when the operating mode is changed from
PROGRAM or MONITOR mode to RUN mode. The value will be
cleared at these times if Retain is not selected.

131
Procedures Section 3-2

Input the name of the

function block variable
The default data type is BOOL.
Change as required.

Type of variable to register

(i.e., the sheet)
Initial value

Select to maintain value for

power interruptions.

Note (a) For user-defined external variables, the global symbol table can
be browsed by registering the same variable name in the global
symbol table.
(b) External variables defined by the system are registered in the ex-
ternal variable table in advance.
2. For example, input “aaa” as the variable name and click the OK Button.
As shown below, a BOOL variable called aaa will be created on the Inputs
Sheet of the Variable Table.

BOOL variable called aaa

created on Inputs Sheet.

Note (1) After a variable is added, it can be selected to display in reverse video,
then moved to another line by dragging and dropping. To select a variable
for dragging and dropping, select the variable in any of the columns ex-
cept the Name field.
(2) After inputting a variable, the sheet where the variable is registered can
be changed by double-clicking and changing the setting in the Usage field
(N: Internals, I: Inputs, O: Outputs, E: Externals, P: In Out). The variable
can also be copied or moved between the sheets for internal, external, in-
put, output, and input-output variables. Select the variable, right-click,
and select Copy or Cut from the pop-up menu, and then select Paste.
(3) Variable names must also be input for variables specified with AT (allocat-
ing actual address) settings.
(4) The following text is used to indicate I/O memory addresses in the PLC
and thus cannot be input as variable names in the function block variable
table.
• A, W, H, HR, D, DM, E, EM, T, TIM, C, or CNT followed by a numeric
value

132
Procedures Section 3-2

Creating the Algorithm Using a Ladder Program

1,2,3... 1. Press the C Key and select aaa registered earlier from the pull-down menu
in the New Contact Dialog Box.

Press the C Key and select aaa registered earlier

from the pull-down menu in the New Contact Dialog Box.

2. Click the OK Button. A contact will be entered with the function block inter-
nal variable aaa as the operand (variable type: internal).

Contact entered with function block

internal variable aaa as operand.

The rest of the ladder program is input in exactly the same way as for stan-
dard programs with CX-Programmer.
Note Addresses cannot be directly input for instruction operands within function
blocks. Only Index Registers (IR) and Data Registers (DR) can be input
directly as follows (not as variables): Addresses DR0 to DR5, direct specifica-
tions IR0 to IR15, and indirect specifications ,IR0 to ,IR15.
Using Structured Text
An ST language program (see note) can either be input directly into the ST
input area or a program input into a general-purpose text editor can be copied
and then pasted into the ST input area using the Paste Command on the Edit
Menu.
Note The ST language conforms to IEC61131-3. Refer to Appendix B Structured
Text Specifications for details.

133
Procedures Section 3-2

ST program input directly or pasted from one

created in a text editor.

Note (1) Tabs or spaces can be input to create indents. They will not affect the al-
gorithm.
(2) The display size can be changed by holding down the Ctrl Key and turn-
ing the scrolling wheel on a wheel mouse.
(3) When an ST language program is input or pasted into the ST input area,
syntax keywords reserved words will be automatically displayed in blue,
comments in green, errors in red, and everything else in black.
(4) To change the font size or colors, select Options from the Tools Menu
and then click the ST Font Button on the Appearance Tab Page. The font
names, font size (default is 8 point) and color can be changed.
(5) For details on structured text specifications, refer to Appendix B Struc-
tured Text Specifications.

Registering Variables as Required

The ladder program or structured text program can be input first and variable
registered as they are required.
Using a Ladder Program When using a ladder diagram, a dialog box will be displayed to register the
variable whenever a variable name that has not been registered is input. The
variable is registered at that time.
Use the following procedure.

1,2,3... 1. Press the C Key and input a variable name that has not been registered,
such as aaa, in the New Contact Dialog Box.
Note Addresses cannot be directly input for instruction operands within
function blocks. Only Index Registers (IR) and Data Registers (DR)
can be input directly as follows (not as variables): Addresses DR0
to DR5, direct specifications IR0 to IR15, and indirect specifications
,IR0 to ,IR15.
2. Click the OK Button. The New Variable Dialog Box will be displayed. With
special instructions, a New Variable Dialog Box will be display for each op-
erand in the instruction.

Set the data type and other

properties other than the name.

134
Procedures Section 3-2

The properties for all input variables will initially be displayed as follows:
• Usage: Internal
• Data Type: BOOL for contacts and WORD for channel (word)
• Initial Value: The default for the data type.
• Retain: Not selected.
3. Make any required changes and click the OK Button.
4. As shown below, the variable that was registered will be displayed in the
variable table above the program.

Instruction input. Function block internal variable registered.

5. If the type or properties of a variable that was input are not correct, double-
click the variable in the variable table and make the required corrections.

■ Reference Information
AT Settings (Specified Address)
AT settings can be made in the variable properties to specify allocation
addresses for Basic I/O Units, Special I/O Units, or CPU Bus Units, or Auxil-
iary Area addresses not registered using the CX-Programmer. A variable
name is required to achieve this. Use the following procedure to specify an
address.

1,2,3... 1. After inputting the variable name in the New Variable Dialog Box, click the
Advanced Button. The Advanced Settings Dialog Box will be displayed.
2. Select AT (Specified Address) under AT Settings and input the desired ad-
dress.

Select AT. Input address.

The variable name is used to enter variables into the algorithm in the func-
tion block definition even when they have an address specified for the AT
settings (the same as for variables without a specified address).
For example, if a variable named Restart has an address of A50100 spec-
ified for the AT settings, Restart is specified for the instruction operand.
Array Settings
An array can be specified to use the same data properties for more than one
variable and manage the variables as a group.
Use the following procedure to set an array.

135
Procedures Section 3-2

1,2,3... 1. After inputting the variable name in the New Variable Dialog Box, click the
Advanced Button. The Advanced Settings Dialog Box will be displayed.
2. Select Array Variable in the Array Settings and input the maximum number
of elements in the array.

Select Array Variable. Input the number of elements.

When the name of an array variable is entered in the algorithm in the func-
tion block definition, square brackets surrounding the index will appear af-
ter the array name.
For example, if you create a variable named PV with a maximum of 3 ele-
ments, PV[0], PV[1], and PV[2] could be specified as instruction operands.
There are three ways to specify indices.
• Directly with numbers, e.g., PV[1] in the above example (for ladder pro-
gramming or ST language programming)
• With a variable, e.g., PV[a] in the above example, where “a” is the
name of a variable with a data type of INT (for ladder programming or
ST language programming)
• With an equation, e.g., PV[a+b] or PV[a+1} in the above example,
where “a” and “b” are the names of variables with a data type of INT
(for ST language programming only)
Using Structured Text When using structured text, a dialog box will not be displayed to register the
variable whenever a variable name that has not been registered is input. Be
sure to always register variables used in standard text programming in the
variable table, either as you need them or after completing the program.
(Place the cursor in the tab page on which to register the variable, right-click,
and select Insert Variable from the pop-up menu.
Note For details on structured text specifications, refer to Appendix B Structured
Text Specifications.

Copying User Program Circuits and Pasting in Ladder Programming of Function

Block Definitions
A single circuit or multiple circuits in the user program can be copied and
pasted in the ladder programming of function block definitions. This operation,
however, is subject to the following restrictions.
Source Instruction Addresses are not registered in the function block definition variable tables.
Operand: Address Only After pasting, the addresses will be displayed in the operand in red. Double-
click on the instruction and input the variable name into the operand.
Note Index Registers (IR) and Data Registers (DR), however, do not require modifi-
cation after pasting and function in the operand as is.

136
Procedures Section 3-2

Source Instruction Automatically generate symbol name Option Selected in Symbols Tab
Operand: Address and I/O under Options in Tools Menu
Comment
The user program symbol names (in the global symbol table only) will be gen-
erated automatically as AutoGen_ + Address (if the option is deselected, the
symbol names will be removed).
Example 1: For address 100.01, the symbol name will be displayed as
AutoGen_100_01.
Example 2: For address D0, the symbol name will be displayed as
AutoGen_D0.
If circuits in the user program are copied and pasted into the function block
definition program as is, the symbols will be registered automatically in the
function block definition symbol table (at the same time as copying the cir-
cuits) as the symbol name AutoGen_Address and I/O comments as Com-
ment. This function enables programmed circuits to be easily reused in
function blocks as addresses and I/O comments.
Note The prefix AutoGen_ is not added to Index Registers (IR) and Global Data
Registers (DR), and they cannot be registered in the original global symbol
table.
Automatically generate symbol name Option Not Selected in Symbols
Tab under Options in Tools Menu
Addresses and I/O comments are not registered in the function block defini-
tion variable tables. Addresses are displayed in the operand in red. I/O com-
ments will be lost. Double-click on the instruction and input the symbol name
into the operand.
Index Registers (IR) and Data Registers (DR), however, do not require modifi-
cation after pasting and function in the operand as is.
Source Instruction The user program symbol is automatically registered in the internal variables
Operand: Symbol of the function block definition variable table. This operation, however, is sub-
ject to the following restrictions.
Addresses
Symbol addresses are not registered. Use AT settings to specify the same
address.
Symbol Data Types
The symbol data types are converted when pasted from the user program into
the function block definition, as shown in the following table.
Symbol data type in user program → Variable data type after pasting in
function block program
CHANNEL → WORD
NUMBER → The variable will not be registered,
and the value (number) will be pasted
directly into the operand as a con-
stant.
UINT BCD → WORD
UDINT BCD → DWORD
ULINT BCD → LWORD

Symbol data types CHANNEL, NUMBER, UINT BCD, UDINT BCD, or ULINT
BCD, however, cannot be copied from the symbol table (not the program) and
then pasted into the variable table in the function block definition.

137
Procedures Section 3-2

Note Symbols with automatically generated symbol names (AutoGen_ + Address)

cannot be copied from a global symbol table and pasted into the function
block definition symbol table.

Generating Function Block Definitions from Existing Ladder Programming

One or more program circuits in a user program can be converted to the lad-
der programming in a function block definition.
Note This function is designed to help you create function block definitions based
on existing ladder programming. It does not automatically generate finish def-
initions. After generating a function block definition with this function, always
check the warning messages in the FB Variable Allocation Dialog Box and
Output Window and check the program that was generated, and be sure to
make any required changes.

1,2,3... 1. Right-click one or more program circuits in the user program and select
Function Block (ladder) generation from the pop-up menu.

2. The following FB Variable Allocation Dialog Box will be displayed.

138
Procedures Section 3-2

The addresses of the operands used in the instructions in the selected pro-
gram circuits will be automatically allocated as listed below depending on
application conditions.
Application Application inside selected program circuits
outside selected Not used Used in Used in Used in input
program circuits input output and output
section section sections
Not used --- Internal vari- Internal vari- Internal variable
(See note.) able able
Used --- Input variable Output vari- Input-output vari-
able able

Note Even if an address is allocated to I/O, it will be considered to be "not

used" and converted to an internal variable if it is not used outside
the selected circuits (no matter where it is used inside the selected
circuits).
Note Names will be automatically set for addresses without symbol names as fol-
lows: AutoGen_address. AT specifications will be automatically removed.
3. Change the allocations to internal, input, output, or input-output variables
as required. Right-click the variable and select the desired variable type
from the Change usage Menu.

If necessary, double-click any variable in the variable list and change the
name or comment. The array and AT settings can also be changed.
4. Click the OK Button. The following Function Block (Ladder) Generation Di-
alog Box will be displayed.

Input the FB definition name and comment, and then click the OK Button.
5. The function block definition will be generated based on the settings and
will appear under the function blocks in the Workspace.
Function Blocks
FunctionBlock1

6. The following dialog box will be displayed asking if you want to insert an
instance of the function block definition below the original program circuits.

139
Procedures Section 3-2

7. Click the Yes Button to insert an instance and click the No Button to not
insert an instance.
8. The following New Function Block Invocation Dialog Box will appear if the
Yes Button was clicked.

Enter the function block instance name and click the OK Button. An in-
stance of the function block definition will be inserted below the original
program circuits as shown below.

9. Enter the input conditions and parameters for the instance that was insert-
ed.
Note The function block definition generation function is convenient for converting
existing ladder programming that has been proven in actual operation into
function blocks. The application of addresses within the selected program cir-
cuits is analyzed both inside and outside the selection to allocate internal,
input, output, and input-output variables as accurately as possible. Program
circuits that contain operands that are only symbols (i.e., that are not
addresses) cannot be converted. To create function blocks from program cir-
cuits that contain operands that are only symbols, copy and past the program
circuits into a function block definition. Refer to Copying User Program Cir-
cuits and Pasting in Ladder Programming of Function Block Definitions on
page 136 for details.

140
Procedures Section 3-2

Program Circuits That In the following case, the program circuits must be altered before a function
Must Be Altered before block definition can be automatically generated.
Generating a Function
Block Definition Addresses Used Both as Bits and Words
The bit and word addresses will be registered as different variables. The pro-
gram can be altered in advance to avoid this.
Example: MOV(021) for W0 and SET for W0.02

↓
Here, the instruction can be changed to specify a word instead of a bit. As
shown below, W0 is used both for MOV(021) and SETB(532), and the bit
number for SETB(532) is specified using &2.

Program Circuits That In the following cases, operand specifications must be changed using array
Must Be Altered after settings after generating the function block definition.
Generating a Function
Block Definition Instructions with Multiword Operands, Some of Which Are Changed by
Another Instruction in the Program Circuits
Example: D0 Specified as the First Word for MOVL(498) and D1 Specified for
MOV(021)

141
Procedures Section 3-2

↓
As shown below, the variables must be changed to specify the first word in an
array and a specific word in the same array after the function block definition
has been generated.
Example: DT_WORD is set as a WORD array variable with 2 elements.
DT_WORD[0] is specified for MOVL(498) and DT_WORD[1] is specified for
MOV(021).

Instructions with Two Operands Specifying Starting and Ending Words

Example: D0 to D9 Specified for BSET(071)

↓
As shown below, the variables must be changed to specify the first word in an
array and a specific word in the same array after the function block definition
has been generated.
Example: DT_WORD is set as a WORD array variable with 10 elements.
DT_WORD[0] is specified for the first operand and DT_WORD[9] is specified
for the second operand of BSET(071).

142
Procedures Section 3-2

Operands with Sizes Affected by Other Operands

Example: Five Transfer Words, D0 Specified for the First Source Word, and
D100 Specified for the First Destination Word for XFER(070)

↓
As shown below, the variables must be changed to set the first elements in
two different arrays after the function block definition has been generated.
Example: DT_WORD1 and DT_WORD2 are set as WORD array variables
with 5 elements each. DT_WORD1[0] is specified for the first word for the first
operand and DT_WORD2[0] is specified for first word for the second operand
of XFER(070).

3-2-4 Creating Instances from Function Block Definitions

If a function block definition is registered in the global symbol table, either of
the following methods can be used to create instances.
Method 1:Select the function block definition, insert it into the program, and
input a new instance name. The instance will automatically be registered in
the global symbol table.
Method 2: Set the data type in the global symbol table to “FUNCTION
BLOCK,” specify the function block definition to use, and input the instance
name to register it.
Note When using ST language, a function block can be called by select-
ing “FUNCTION BLOCK” as the variable’s data type, using the de-
sired instance name, and entering a function block call statement.

143
Procedures Section 3-2

■ Method 1: Using the F Key in the Ladder Section Window and Inputting
the Instance Name

1,2,3... 1. In the Ladder Section Window, place the cursor in the program where the
instance is to be inserted and press the F Key. (Alternately, select Func-
tion Block Invocation from the Insert Menu.) The New Function Block In-
vocation Dialog Box will be displayed.
When using ST language, a function block can be called by selecting
“FUNCTION BLOCK” as the variable’s data type, using the desired in-
stance name, and entering the following function block call statement.
Specify arguments in parentheses after the instance name (to pass input
variable values from the calling function block to input variables in the
called function block) and also specify return values (to receive output vari-
able values from the called function block to output variables in the calling
function block). The instance name can be set to any internal variable with
the “FUNCTION BLOCK” data type.
2. Input the instance name, select the function block from which to create an
instance, and click the OK Button.

Press F Key with cursor here.

Following dialog Input the instance name.

box is displayed.

Select the function block from

which to create an instance.

3. As an example, set the instance name in the FB Instance Field to sample,

set the function block in the FB Definition Field to FunctionBlock1, and
click the OK Button. As shown below, a copy of the function block definition
called FunctionBlock1 will be created with an instance name of sample.

Instance name
Function block definition
An instance called sample
is created from the function
block definition called
FunctionBlock1.

The instance will be automatically registered in the global symbol table

with an instance name of sample and a data type of FUNCTION BLOCK.

■ Method 2: Registering the Instance Name in the Global Symbol Table in

Advance and Then Selecting the Instance Name
If the instance name is registered in the global symbol table in advance, the
instance name can be selected from the global symbol table to create other
instances.

144
Procedures Section 3-2

1,2,3... 1. For a ladder diagram, select a data type of Function block in the global
symbol table, input the instance name, and registered the instance.
For ST, select a data type of Function block, use the instance name, and
use a call statement for the function block as follows to call the function
block:
Input the instance name (any internal variable name with a function block
data type) followed by the arguments in parentheses (i.e., specify the input
variable values of the calling function block to pass to the input variables of
the called function block). Also include the return values (i.e., specify the
output variable values of the called function block to pass back to the out-
put variables of the calling function block).
2. Press the F Key in the Ladder Section Window. The Function Block Invo-
cation Dialog Box will be displayed.
3. Select the instance name that was previously registered from the pulldown
menu on the FB Instance Field. The instance will be created.

Restrictions
Observe the following restrictions when creating instances. Refer to 2-3
Restrictions on Function Blocks for details.
• No more than one function block can be created in each program circuit.
• The rung cannot be branched to the left of an instance.
• Instances cannot be connected directly to the left bus bar, i.e., an EN
must always be inserted.
Note If changes are made in the I/O variables in a variable table for a function block
definition, the bus bar to the left of all instances that have been created from
that function block definition will be displayed in red to indicate an error. When
this happens, select the function block, right-click, and select Update Invoca-
tion. The instance will be updated for any changes that have been made in
the function block definition and the red bus bar display indicating an error will
be cleared.

3-2-5 Setting Function Block Parameters Using the Enter Key

After an instance of a function block has been created, input parameters must
be set for input variables and output parameters must be set for output vari-
ables to enable external I/O.
• Values, addresses, and program symbols (global symbols and local sym-
bols) can be set in input parameters. (See note a.)
• Addresses and program symbols (global symbols and local symbols) can
be set in output parameters. (See note b.)

Note (a) The function block’s input variable data size and the program’s
symbol data size must match.
(b) The function block’s output variable data size and the program’s
symbol data size must match.

1,2,3... 1. Inputs are located on the left of the instance and outputs on the right. Place
the cursor where the parameter is to be set and press the Enter Key. (Al-
ternately, select Function Block Parameter from the Insert Menu.) The
New Parameter Dialog Box will be displayed as shown below.

145
Procedures Section 3-2

Instance name
Function block definition

Press the P Key with the cursor on the left

of the instance. The New Parameter
Dialog Box will be displayed.

Input the address from which to pass data

to the input variable.

2. Set the source address from which to pass the address data to the input
variable. Also set the destination address to which the address data will be
passed from the output variable.

The value of 001 is passed to input

variable aaa.

Note Set the data in all the input parameters. If even a single input parameter
remains blank, the left bus bar for the instance will be displayed in red to indi-
cate an error. If this happens, the program cannot be transferred to the CPU
Unit.

Inputting Values in Parameters

The following table lists the methods for inputting values in parameters.
Input variable data Content Size Input method Setting range
type
BOOL Bit data 1 bit P_Off, P_On 0 (FALSE), 1 (TRUE)
INT Integer 16 bits Positive value: & or + followed −32768 to +32767
by integer
DINT Double integer 32 bits −2147483648 to +2147483647
Negative value: − followed by
LINT Long (4-word) inte- 64 bits integer −9223372036854775808 to
ger +9223372036854775807
UINT Unsigned integer 16 bits Positive value: & or + followed &0 to 65535
UDINT Unsigned double 32 bits by integer &0 to 4294967295
integer
ULINT Unsigned long (4- 64 bits &0 to 18446744073709551615
word) integer

146
Procedures Section 3-2

Input variable data Content Size Input method Setting range

type
REAL Real number 32 bits Positive value: & or + followed −3.402823 × 1038 to −1.175494
by real number (with decimal
point) × 10−38, 0, +1.175494 × 10−38
Negative value: − followed by to +3.402823 × 1038
LREAL Long real number 64 bits real number (with decimal −1.79769313486232 × 10308 to
point)
−2.22507385850720 × 10−308,
−
0, +2.22507385850720 × 10 308
to +1.79769313486232 × 10308
WORD 16-bit data 16 bits # followed by hexadecimal #0000 to FFFF or &0 to 65535
number (4 digits max.)
& or + followed by decimal
number
DWORD 32-bit data 32 bits # followed by hexadecimal #00000000 to FFFFFFFF or &0
number (8 digits max.) to 4294967295
& or + followed by decimal
number
LWORD 64-bit data 64 bits # followed by hexadecimal #0000000000000000 to
number (16 digits max.) FFFFFFFFFFFFFFFF or &0 to
& or + followed by decimal 18446744073709551615
number

Note If a non-boolean data type is used for the input variable and only a numerical
value (e.g., 20) is input, the value for the CIO Area address (e.g, CIO 0020)
will be passed, and not the numerical value. To set a numerical value, always
insert an &, #, + or − prefix before inputting the numerical value.
Example Programs:
Instance for function block definition A

( INT )
10 DATA_1

If the data format for DATA_1 is INT, and "10" is input,

the value for CIO 0010 will be passed.

Instance for function block definition A

( INT )
&10 DATA_1

If the data format for DATA_1 is INT, and the prefix &
is added so that "&10" is input, the numerical value
will be passed.

If the input variable data type is boolean and a numerical value only (e.g.,
0 or 1) is input in the parameter, the value for CIO 000000 (0.00) or
CIO 000001 (0.01) will be passed. Always input P_Off for 0 (OFF) and
P_On for 1 (ON).

147
Procedures Section 3-2

3-2-6 Setting the FB Instance Areas

The areas where addresses for variables used in function blocks are allocated
can be set. These areas are called the function block instance areas.

1,2,3... 1. Select the instance in the Ladder Section Window or in the global symbol
table, and then select Function Block Memory - Function Block Memo-
ry Allocation from the PLC Menu.
The Function Block Memory Allocation Dialog shown below will appear.
2. Set the FB instance areas.

Non-retained area

Retained area
Timer area
Counter area

First Last Size

address address

The non-retained and retained areas are set in words. The timer and
counter areas are set by time and counter numbers.
The default values are as follows:
CS/CJ-series CPU Units Ver. 3.0 or Later, CP1H CPU Units, and NSJ
Controllers
FB Instance Default value Applicable memory
Area Start address End address Size areas
Non Retain H512 (See H1407 (See 896 CIO, WR, HR, DM, EM
(See notes 1 note 2.) note 2.)
and 3.)
Retain (See H1408 (See H1535 (See 128 HR, DM, EM
note 1.) note 2.) note 2.)
Timers T3072 T4095 1024 TIM
Counters C3072 C4095 1024 CNT

Note (1) Bit data can be accessed even if the DM or EM Area is specified for the
non-retained area or retained area.
(2) The Function Block Holding Area words are allocated in H512 to H1535.
These words cannot be specified in instruction operands in the user pro-
gram. These words can also not be specified in the internal variable’s AT
settings.
(3) Words H512 to H1535 are contained in the Holding Area, but the ad-
dresses set as non-retained will be cleared when the power is turned
OFF and ON again or when operation is started.
(4) To prevent overlapping of instance area addresses and addresses used
in the program, set H512 to H1535 (Function Block Holding Area words)
for the non-retained area and retained area. If there are not sufficient
words, use words in areas not used by the user program. If another area
is set, the addresses may overlap with addresses that are used in the
user program.
If the addresses in the function block instance areas overlap with any of
the addresses used in the user program, an error will occur when compil-
ing. This error will also occur when a program is downloaded, edited on-
line, or checked by the user.

148
Procedures Section 3-2

Work Area Addresses

used in the user
program overlap with
the instance areas.

If addresses are duplicated and an error occurs, either change the function
block instance areas or the addresses used in the user program.
FQM1 Flexible Motion Controllers
FB Instance Default value Applicable memory
Area Start address End address Size areas
Non Retain 5000 5999 1000 CIO, WR, DM
Retain None
Timers T206 T255 50 TIM
Counters C206 C255 50 CNT

Note Bit data can be accessed even if the DM Area is specified for the non-retained
area.

3-2-7 Checking Internal Address Allocations for Variables

The following procedure can be used to check the I/O memory addresses
internally allocated to variables.

1,2,3... 1. Select View - Symbols - Global.

2. Select the instance in the global symbol table, right-click, and select Func-
tion Block Memory Address from the pop-up menu. (Alternately, select
Function Block Memory - Function Block Memory Address from the
PLC Menu.)
Example: Instance name displayed in global variable table (automatically registered)

Right-click on the instance name and select Function Block Instance Address.

3. The FB Interface Memory Dialog Box will be displayed. Check the I/O
memory addresses internally allocated to variables here.

149
Procedures Section 3-2

Example: Addresses used internally

for the input variables.

Method Used for Checking Addresses Internally Allocated to Variables

Program

Instance of function block definition A,

instance name: sample
a b

Right-click and select Function

Instance registered in global Block Memory Address.
symbol table under instance name. FM Instance Memory Dialog Box
Inputs
Name Type Address/ Name Type Address
Value
a BOOL W400.00
sample FB [FunctionBlock1] N/A [Auto]
Outputs
Name Type Address
b BOOL W401.00
Instance name c BOOL W401.02

Addresses used for function

block internal variables

Checking the Status of The following procedure can be used to check the number of addresses allo-
Addresses Internally cated to variables and the number still available for allocation in the function
Allocated to Variables block instance areas.

1,2,3... 1. Select the instance in the Ladder Section Window, right-click, and select
Function Block Memory - Function Block Memory Statistics from the
PLC Menu.
2. The Function Block Memory Statistics Dialog Box will be displayed as
shown below. Check address usage here.

The total number The number of

of words in each The number words still available.
interface area. of words
already used.

150
Procedures Section 3-2

Optimizing Function When a variable is added or deleted, addresses are automatically re-allocated
Memory in the variables’ instance area. Consecutive addresses are required for each
instance, so all of the variables will be allocated to a different block of
addresses if the original block of addresses cannot accommodate the change
in variables. This will result in an unused block of addresses. The following
procedure can be used to eliminate the unused areas in memory so that
memory is used more efficiently.

1,2,3... 1. Select the instance in the Ladder Section Window, right-click, and select
Function Block Memory - Optimize Function Memory from the PLC
Menu.
The following dialog box will be displayed.

2. Click the OK Button. Allocations to the function block instance areas will
be optimized.

3-2-8 Copying and Editing Function Block Definitions

Use the following operation to copy and edit the function block definition that
has been created.
1. Select the function block to copy, right-click, and select Copy from the pop-
up menu.
2. Position the cursor over the function block item under the PLC in the
project directory, right-click and select Paste from the pop-up menu.
3. The function block definition will be copied (“copy” is indicated before the
name of the function block definition at the copy source).
4. To change the function block name, left-click or right-click and select Re-
name from the pop-up menu.
5. Double-click the function block definition to edit it.

3-2-9 Checking the Source Function Block Definition from an Instance

Use the following procedure to check the function block definition from which
an instance was created.
Either double-click the instance or right-click the instance and select Go To -
Function Block Definition from the pop-up menu. The function block defini-
tion will be displayed.

3-2-10 Checking Instance Information such as Nesting Levels

When function blocks are nested in the created program, the structure of the
nesting levels can be checked by selecting Windows - FB Instance Viewer
from the View Menu. The function block relationships will be shown in a direc-
tory tree format, with the calling function blocks at the higher level and the
called function blocks at the lower level.
The FB Instance Viewer Window will provide other information, such as the
array variables being used and internal addresses allocated to the variables,
as shown in the following diagram. Variables can be registered in the Watch
Window just by dragging the variable from the list of variables used in the
instance and dropping the variable in the Watch Window.

151
Procedures Section 3-2

FB Instance Viewer

Note: Variables can be

registered by dragging and
dropping them in the Watch
Window.

When nesting, this area shows The variable names, data types,
the nesting level relationship addresses (allocated internal
between instances (function block addresses), and comments are
definition names in parentheses). displayed for variables used in
The higher-level is the calling the active instance selected in
block and the lower-level is the the directory tree in the area on
called block. the left.
Also, if there are array variables
or timer/counter variables, they
are displayed just below the
instance.

3-2-11 Checking the Size of the Function Block Definition

CX-Programmer can be used to check the size of the function block definition
being created using a similar method to checking the program capacity. The
procedure is as follows:
1. Select Memory View from the View Menu.
2. The function block definition size and number of function block definitions
will be displayed in the Memory View Dialog Box as shown below.

• The Used #, Free #, and Max # fields under Function Block refer to the
number of function block definitions.

3-2-12 Compiling Function Block Definitions (Checking Program)

A function block definition can be compiled to perform a program check on it.
Use the following procedure.

152
Procedures Section 3-2

1,2,3... Select the function block definition, right-click, and select Compile from the
pop-up menu. (Alternately, press the Ctrl + F7 Keys.)
The function block will be compiled and the results of the program check will
be automatically displayed on the Compile Table Page of the Output Window.

Results of program check displayed.

3-2-13 Printing Function Block Definition

Use the following procedure to print function block definitions.

1,2,3... 1. Double-click the function block definition to be printed, and with the vari-
able table and algorithm displayed, select Print from the File Menu. The
following Target Print Rung Dialog Box will be displayed.

2. Select the All Rung or Select Rung option. When the Select Rung option
is selected, specify the start rung and end rung numbers. When a page
number has been specified in the header and footer fields in File - Page
Setup, the first page number can be specified.
3. Select either of the following options for the function block printing range.
• Symbol table and program (default)
• Symbol table
• Program
4. Click the OK Button, and display the Print Dialog Box. After setting the
printer, number of items to print and the paper setting, click the OK button.

153
Procedures Section 3-2

5. The following variable table followed by the algorithm (e.g, ladder program-
ming language) will be printed.

Note For details on print settings, refer to the section on printing in the CX-Pro-
grammer Ver. 5.0 Operation Manual (W437).

3-2-14 Password Protection of Function Block Definitions

Overview
Function block definitions in a project can be protected by setting a password
to restrict access. The following two levels of password protection that can be
set, depending on the application.
Password Protection on This password protection level restricts both writing (changing) and displaying
both Writing and Reading the contents of the function block definition.
To set read/write protection, select Prohibit writing and display as the Protec-
tion type in the function block’s properties. This level of protection prevents
unintended program changes/modifications and also protects against misap-
propriation of program materials.
Password Protection on This password protection level restricts writing (changing) the contents of the
Writing Only function block definition.
To set write protection, select Prohibit writing as the Protection type in the
function block’s properties. This level of protection prevents unintentional pro-
gram changes/modifications.

Setting Password Protection

This operation can be performed offline only.
Password protection can be applied to individual function block definitions or
multiple function block definitions together.
Protecting an Individual Use the following procedure to set the password protection for an individual
Function Block Definition function block definition.

1,2,3... 1. In the project workspace, select the function block definition, right-click,
and select Properties from the pop-up menu. (Alternately, select Proper-
ties from the View Menu.)

154
Procedures Section 3-2

2. The Function Block Properties Dialog Box will be displayed. Click the Pro-
tection Tab and click the Set Button.

3. The Function Block Protect Setting Dialog Box will be displayed. Select the
protection level in the Protection Type Field.

The following table shows the functions restricted in each protection level.
Function Protect Type
Prohibit writing and Prohibit writing
display
Displaying function block contents Prohibited Allowed
Printing function block contents
Editing function block contents Prohibited
Saving/loading to function block Allowed Allowed
library files

4. Input the password in the Password Field of the Function Block Protect
Setting Dialog Box. Input the same password again in the confirmation
field to verify the password and click the Set Button.
The password can be up to 8 characters long and only alphanumeric char-
acters can be used.
5. When a function block definition has been password protected, the func-
tion block definition’s icon will change to indicate that it is protected. The
icon also indicates the protection level, as shown below.
: Prohibit writing and display (same for ladder and ST)
: Prohibit writing (ladder)
: Prohibit writing (ST)
Protecting Multiple Use the following procedure to set the password protection for two or more
Function Block Definitions function block definitions at the same time.

1,2,3... 1. Select Function Blocks in the project workspace, right-click, and select
Function Block Protection - Set from the pop-up menu.

155
Procedures Section 3-2

2. The Function Block Protection Collective Setting Dialog Box will be dis-
played. Select the names of the function blocks that you want to protect,
select the Protection Type (protection level), input the password, and click
the Set Button.

3. The selected function block definitions will be password protected.

Clearing Password Protection

This operation can be performed offline only.
Password protection can be cleared from an individual function block defini-
tion or multiple function block definitions together.
Clearing Password Use the following procedure to clear the password protection on an individual
Protection on an function block definition.
Individual Function Block

1,2,3... 1. In the project workspace, select the function block definition, right-click,
and select Properties from the pop-up menu. (Alternately, select Proper-
ties from the View Menu.)
2. The Function Block Properties Dialog Box will be displayed. Click the Pro-
tection Tab and click the Release Button.
3. The Function Block Protection Release Dialog Box will be displayed. Input
the password in the Password Field and click the Release Button.
4. If the password was correct, the protection will be cleared and the function
block definition’s icon will change to a normal icon in the project work-
space.
Clearing Password Use the following procedure to clear the password protection on two or more
Protection on Multiple function block definitions at the same time.
Function Blocks

1,2,3... 1. Select Function Blocks in the project workspace, right-click, and select
Function Block Protection - Release from the pop-up menu.

156
Procedures Section 3-2

2. The Function Block Protection Collective Release Dialog Box will be dis-
played. Select the names of the function blocks that you want to be unpro-
tected, input the password, and click the Release Button.
3. If the password input matches the selected function blocks’ passwords, the
protection will be cleared for all of the function block definitions at once.

3-2-15 Saving and Reusing Function Block Definition Files

The function block definition that has been created can be saved indepen-
dently as a function block library file (*.cxf) to enable reusing it in other
projects.

Note (1) Before saving to file, or reusing in another project, compile the function
block definition and perform a program check.
(2) When function blocks are being nested, the function block definition of the
called (nested) function blocks are included and saved in the function
block library file.
Saving a Function Block Use the following procedure to save a function block definition to a function
Library File block library file.

1,2,3... 1. Select the function block definition, right-click, and select Save Function
Block to File from the pop-up menu. (Alternately, select Function Block
- Save Function Block to File from the File Menu.)
2. The following dialog box will be displayed. Input the file name. Function
Block Library Files (*.cxf) should be selected as the file type.

Reading Function Block Use the following procedure to read a function block library file (*.cxf) into a
Library Files into Other project.
Projects

1,2,3... 1. Select the function block definition item under the PLC directory in the
Project Workspace, right-click, and select Insert Function Block - From
File from the pop-up menu (or select File - Function Block - Load Func-
tion Block from File).
2. The following dialog box will be displayed. Select a function block library
file (*.cxf) and click the Open Button.

157
Procedures Section 3-2

3. A function block called FunctionBlock1 will be automatically inserted after

the Function Blocks icon. This icon contains the definition of the function
block.
4. Double-click the FunctionBlock1 Icon. The variable table and algorithm
will be display.

3-2-16 Downloading/Uploading Programs to the Actual CPU Unit

After a program containing function blocks has been created, it can be down-
loaded from the CX-Programmer to an actual CPU Unit that it is connected to
online. Programs can also be uploaded from the actual CPU Unit. It is also
possible to check if the programs on the CX-Programmer (personal computer)
and in the actual CPU Unit are the same. When the program contains function
blocks, however, downloading in task units is not possible (uploading is possi-
ble).

3-2-17 Monitoring and Debugging Function Blocks

The following procedures can be used to monitor programs containing func-
tion blocks.
Monitoring I/O in Ladder With the CX-Programmer Ver. 6.0 and later versions, it is possible to monitor
Programs within the status of bits and content of words in a ladder program within an instance
Instances when monitoring the program. To monitor I/O bits and words (I/O Bit Monitor),
either double-click the instance or right-click the instance and select Monitor
FB Ladder Instance from the pop-up menu. At this point, it is possible to
monitor bits and words, change PVs, force-set/reset bits, and perform differ-
entiation monitoring.
Note It is not possible to perform online editing or change timer/counter SVs. Also,
although monitoring the status of bits and words is possible for input-output
variables, changing PVs and force-setting/resetting bits is not possible.

Double-click I/O values can be

monitored in the
algorithm within the
function block.

158
Procedures Section 3-2

Monitoring Variables of ST With the CX-Programmer Ver. 6.1 and later versions, it is possible to monitor
Programs within the ST programs within an instance when monitoring the program. To monitor
Instances I/O bits and words (I/O Bit Monitor), either double-click the instance or right-
click the instance and select Monitor FB Instance from the pop-up menu.
To return to the original instance, right-click in the ST program monitor window
and select To Upper Layer from the pop-up menu.

Right-click and select Double-click

To Upper Layer. the instance.

The ST program and variable

monitoring areas are displayed.

Left side: Right side:

ST program monitor window ST variable monitor window

The variable’s PV is displayed

in blue characters.

The ST program is displayed in the left side of the window (called the ST pro-
gram monitor window).
The values of variables used in the ST program are displayed in the right side
of the window (called the ST variable monitor window).
At this point, it is possible to monitor variable values, change PVs, force-set or
force-reset bits, and copy/paste variables in the Watch Window. (These oper-
ations are described below.)
Monitoring Variables
Variable values are displayed in blue in the ST variable monitor window.

159
Procedures Section 3-2

Changing PVs
To change a PV, select the desired variable in the ST variable monitor window
(displayed in reverse video when selected), right-click, and select Set - Value
from the pop-up menu.
Select the variable.

The Set New Value Dialog Box will be displayed. Input the new value in the
Value field.
Force-setting and Force-resetting Bits
To force-set, force-reset, or clear the forced status, select the desired variable
in the ST variable monitor window (displayed in reverse video when selected),
right-click, and select Force - On, Force - Off, Force - Cancel, or Force -
Cancel All Forces from the pop-up menu.
Copying and Pasting in the Watch Window

1,2,3... 1. To copy a variable to the Watch Window, select the desired variable in the
ST variable monitor window (displayed in reverse video when selected),
right-click, and select Copy from the pop-up menu.
2. Right-click in the Watch Window and select Paste from the pop-up menu.

Select the variable in the ST

variable monitor window,
right-click, and select Copy.

Right-click in the Watch

Window and select Paste.

160
Procedures Section 3-2

Checking Programs within Use the following procedure to check the program in the function block defini-
Function Block Definitions tion for an instance during monitoring.

1,2,3... Right-click the instance and select To Lower Layer from the pop-up menu.
The function block definition will be displayed.
Monitoring Instance Use the following procedure to monitor instance variables.
Variables in the Watch
Window

1,2,3... 1. Select View - Window - Watch.

A Watch Window will be displayed.
2. Use any one of the three following methods to display the FB variables reg-
istration Dialog Box.
a. Right-click the instance and select Register in Watch Windows from
the pop-up menu.
b. Copy the instance and paste it in the Watch Window.
c. Right-click an empty row in the Watch Window and select Register in
Watch Windows from the pop-up menu.

3. Select Usage - Data Type. The FB Instance setting can also be selected.
The default Usage is N: Internal and the other available selections are I:
Input, O: Output, and E: External.
The default Data Type is A: All. Special data types BOOL and INT can also
be selected.
4. Click the OK Button. The selected variable will be registered in the Watch
Window and the value will be displayed as shown below.

161
Procedures Section 3-2

Select Register in Watch

Windows.
or
Copy the instance and
paste it in the Watch
Window.
or
Right-click an empty row in
the Watch Window and
select Register in Watch
Windows.

Click the OK Button

to register.

Monitoring Input Variables The present values of input variables and output variables (parameters) are
and Output Variables in displayed below the parameters.
Instances

PV of parameter for I/O variable.

Simulation of Ladder/ST The CX-One Ver 1.1 (CX-Programmer Ver. 6.1) and later versions have a sim-
Programs in Instances ulation function that can simulate the operation of a ladder program or ST pro-
gram within a function block instance. Both step execution and break point
operation are supported.
To return to the original instance, right-click in the ST program monitor window
and select To Upper Layer from the pop-up menu.
■ Enabling the Simulation Function
Use the following procedure to enable the simulation function.

1,2,3... 1. Open the program containing the instance to be debugged.

2. Select View - Toolbars and select the Simulator Debug Option in the Tool-
bars Tab.
3. Select Work Online Simulator from the CX-Programmer’s PLC Menu and
transfer the program to the CX-Simulator in the computer.
Note Steps 2 and 3 can be done in the opposite order.
■ Step Execution (Step Run)
Executes the program in step (instruction) increments. When the instance is
stopped, this function can move to the first step (instruction) of the ladder or
ST program in that instance.
The program in the instance can be executed with the Step Run or Continu-
ous Step Run method (see note).

162
Procedures Section 3-2

Note Set the duration of the step execution for Continuous Step Run operation by
selecting the CX-Programmer’s Tools - Options command and setting the
Continuous Step Interval on the PLCs Tab Page.
Step In
Use the following procedure to begin step execution of a ladder/ST program
within an instance (called Step Run operation).

1,2,3... 1. Pause execution of the instance. (See note.)

2. Click the Step In Icon or select Tools - Simulation - Mode - Step In.
Example: Step In from Instance to Internal Ladder Program

Stopped here. Click the Step In Icon to

start Step In execution.

Moves to here.

Example: Step In from ST Program to Internal Ladder Program

With an ST program, an
arrow is displayed to the left Click the Step In Icon to Moves to here.
Stopped here. of the stopped position. start Step In execution.

Note When the program is being executed at a point outside of the function block
instance, the processing is the same as normal Step Run operation.
Step Out
Use the following procedure to pause step execution of a ladder/ST program
within an instance (Step Run operation) and return to one level higher in the
program (the program or instance that was the source of the call).

1,2,3... 1. During Step Run operation, move the cursor to any stopping point in the
instance.
2. Click the Step Out Icon or select Tools - Simulation - Mode - Step Out.

163
Procedures Section 3-2

Example:
Returning from an ST Program to the Calling Program or Instance
Moves to here.
Stopped here.

Click the Step Out Icon to

return to the calling program.

Note The Step Out command can be executed only in a ladder/ST program within
an instance.
■ Display when Operation is Paused by the Simulation Function
The color of the cursor (or arrow in an ST program) indicates whether an
operation has been paused in the Simulation Function Window, as well as
which operation has been paused.
Debug Color (default) Program execution Details
operation status
Step Run or Pink Simulator paused Paused by Step Run
Continuous status operation or the Pause
Step Run Button
Regular color Not executed due to Step is not being exe-
interlock or other cuted because of an
function. instruction such as IL,
MILR/MILH, JMP0, or
FOR/BREAK.
Break point Blue Simulator instruction Paused (break status) by
break a break point.

Note (1) When Tools - Simulation - Always Display Current Execution Point
has been selected, the Simulator automatically scrolls the display to show
the paused point in the instance when performing Step Run or Continu-
ous Step Run operation.
(2) The color of the cursor (or arrow in an ST program), which indicates when
an operation has been paused in the Simulation Function Window, can
be changed from its default color.
To change the color, select Tools - Options and click the Appearance
Tab. Select Pause Simulator, Simulator Instruction Break, or Simulator IO
Break, and change the color for that condition.
■ Break Point Operation in an Instance
Execution can be paused automatically at the preset break point in the
instance. (In this case, the Step In operation cannot be used.)
Note When a break point is set for an instance, the break point is valid for that
instance only. (The break point is not valid for other instances created from
the same function block definition.)

164
Procedures Section 3-2

3-2-18 Online Editing Function Block Definitions

Ladder diagrams for ST programs in function block definitions can be edited
even when the CPU Unit is operating in MONITOR mode. This enables
debugging or changing function block definitions even in systems that cannot
be shut down, such as systems that operate 24 hours a day.
To edit function block definitions online, you must use CX-Programmer version
7.0 or higher (i.e., CX-One version 2.0 or higher) and a CS/CJ-series CPU
Unit with unit version 4.0 or later. (See note.)
This function cannot be used for simulations on CX-Simulator.
Note With CS/CJ-series CPU Units with unit version 3.0, online editing
can be used to change peripheral aspects of function block instanc-
es.
• Parameters passing data to/from instances can be changed, in-
structions not in instances can be changed, and instances can be
deleted.
• Instances cannot be added, instance names cannot be changed,
and changes cannot be made to variable tables or algorithms in
function block definitions.

Editing Reserved Memory to Add an Internal Variable with Online Editing

To add an internal variable to the variable table in a function block definition,
the memory required for the size of the variable being added must be
reserved in advance. This memory is separate from the internally allocated
range for the variable in the function block instance area. Use the following
procedure to reserve memory before starting online editing of the function
block.

1,2,3... 1. In the Workspace, right-click the function block definition to be edited and
select Properties from the pop-up menu.
2. Click the Memory Tab, right-click the area for which to reserve memory,
and select Online edit reserved memory from the pop-up menu.

3. Enter the size of memory to reserve in each field in the Memory Size Edit
for FB Online Edit Dialog Box.

165
Procedures Section 3-2

Editing and Transferring a Function Block Definition

1,2,3... 1. While online with the PLC, right-click a function block definition in the
Workspace (see note) and select FB online Edit - Begin from the pop-up
menu.
Note Online editing can also be started from the Function Block Defini-
tion Window, the Instance Ladder/ST Monitor Window, or a function
block call instruction (from the normal ladder program or from a lad-
der program in a function block).
The following dialog box will be displayed before the FB Online Editor is
started.

At the same time, a list of instances that will be affected is displayed in the
Output Window.

Note Affect of Function Block Definition Changes on Instances

When a function block definition is changed, the contents of all in-
stances that call that function block definition will also be changed.
This is illustrated below.
Example

Function Block Definition FB1 User Program

Instance calling FB1

Affected

Programming
changed.

A list of instances that will

be affected is displayed in
Affected the Output Window.

Instance calling FB1

Change function block definitions only after considering the affect

of the change on overall program operation.
2. Click the Yes Button. The contents of the function block definition will be
displayed and can be edited.

166
Procedures Section 3-2

3. After editing the contents of the function block definition, select FB online
Edit - Send Changes. The following FB Online Edit - Transfer Dialog Box
will be displayed.

4. Select one of the following transfer modes and click the Yes Button.
• Normal Mode
• Quick Mode
Refer to Transfer Modes on page 168 and Selecting a Transfer Mode on
page 169 for details on the transfer modes.

167
Procedures Section 3-2

The new function block definition will be transferred to the buffer memory
in the CPU Unit and the progress of the transfer will be displayed in a dialog
box.

(At this point, the CPU Unit will still be operating with the previous function
block definition.)
The following dialog box will appear when the transfer has been complet-
ed.

(At this point, the CPU Unit will still be operating with the previous function
block definition.)
5. Click the Yes Button. The user program in the CPU Unit will be updated
with the new function block definition from the buffer memory of the CPU
Unit. (If the No Button is click, the new function block definition in the buffer
memory will be discarded and the program will not be changed.)
In either case, the program will return to the status in which function block
definitions cannot be edited. To edit another function block definition, se-
lect FB online Edit - Begin and begin the online editing procedure from
the beginning.
Transfer Modes Normal Mode
In Normal Mode, both the source code and object code are transferred to the
CPU Unit. Some time may be required for Normal Mode transfers because of
the quantity of data that must be sent. Other editing or transfer operations
cannot be performed until the transfer has been completed.
Note The Display confirmation of FB online edit changes Option can be
selected to display a confirmation dialog box after the source code
has been transferred but just before updating the user memory in
the CPU Unit.
Quick Mode
In Normal Mode, only the object code is transferred to the CPU Unit. The
source code is not transferred, making Quick Mode faster than Normal Mode.
After transferring the object code either 1) select Program - Transfer FB
Source to transfer the source code or 2) transfer the source code according
to instructions displayed in a dialog box when you go offline.
After transferring the object code, “FB Source” will be displayed in yellow at
the bottom of the window to indicate that the source code has not yet been
transferred. This message will disappear when the source code is transferred.

168
Procedures Section 3-2

Selecting a Transfer Mode As a rule, use Normal Mode to transfer function block definition changes. If
too much time is required, increase the baud rate as much as possible before
the transfer. If too much time is still required and debugging efficiency is hin-
dered by continuous online editing, use Quick Mode as an exception, but be
sure you understand the restrictions given in the following note (Mode Restric-
tions in Quick Mode).
Guidelines for transfer times are given below for eight function block defini-
tions with a source code totaling 8 Kbytes for all 8 definitions and all
instances.
Normal Mode Quick Mode
At 115.2 kbps: 5s 1s
At 19.2 kbps: 10 s 2s

Note Restrictions in Quick Mode

A program containing function blocks cannot be uploaded correctly to the CX-
Programmer unless the source code for all function block definitions has been
transferred to the CPU Unit. Whenever using Quick Mode to transfer changes
to function block definitions, always select Program - Transfer FB Source
later to transfer the source code as well. Even if the source code is not trans-
ferred, it will be automatically transferred when you go offline unless the com-
puter or CX-Programmer crashes before the source code can be transferred.
In that happens, it may be impossible to upload the program. (See note.)
Note It may be still be possible to transfer the source code even if the
above problem occurs.
a. The following dialog box will be displayed the next time the CX-Pro-
grammer is started.

b. Click the OK Button.

c. Go online with the CPU Unit to which a transfer was made using Quick
Mode.
d. When you go online, the CXP project automatically backed up in the
computer will be started and the following dialog box will be displayed.

e. Click the Yes Button and then following the instructions provided in the
dialog boxes. The source code automatically backed up in the comput-
er can be compared to the object code in the CPU Unit and if they
match, the source code can be transferred.

169
Procedures Section 3-2

Note Source Code and Object Code

Before transferring a program, the CX-Programmer normally compiles the
source code into object code so that the CPU Unit can execute it and then
transfers both the source code and object code to the CPU Unit. The CPU
Unit stores the source code and object code in user memory and built-in flash
memory. Only when both the source code and object code exist in the CPU
Unit can the CX-Programmer transfer and restore the program for the upload
operation.

Canceling Changes to Function Block Definitions

Select FB online Edit - Cancel to discard any changes made to a function
block definition. The function block definition will not be transferred to the CPU
Unit and the original definition will be restored.

Effects on CPU Unit Operation

The following will occur if online editing is performed with the CPU Unit oper-
ating in MONITOR mode: 1) The cycle time of the CPU Unit will be extended
by several cycle times when the program in the CPU Unit is rewritten and 2)
The cycle time will again be extended when the results of online editing are
backed up to built-in flash memory. (At this time, the BKUP indicator on the
front of the CPU Unit will flash and the progress will be displayed on the CX-
Programmer.)
Maximum Cycle Time The maximum extensions to the cycle time are given in the following table.
Extensions for Online
Editing During online editing During backup
12 ms max. 4% of cycle time

Note Cycle Time Monitor Time

Be sure that the cycle time monitor time set in the PLC Setup is not exceeded
when the program is rewritten as a result of online editing in MONITOR mode.
If the monitor time is exceeded, a cycle time exceeded error will occur and
CPU Unit operation will stop. If this occurs, switch to PROGRAM mode and
then to MONITOR or RUN mode to restart operation.

Restrictions in Online Editing of Function Block Definitions

The following restrictions apply to online editing of function block definitions.
• Online editing is not possible for function block definitions that exceed
4 Ksteps.
• A maximum of 0.5 Ksteps can be added to or deleted from a function
block definition during one online editing operation.
• Input variables, output variables, and input-output variables cannot be
added or deleted.
• New function block instances cannot be added.
• Instance names cannot be changed.
• Internal variables can be added, internal variable comments can be
changed, and internal variables can be deleted from the variable table in
the function block definition. To add an internal variable, however, memory
must be reserved in advance. Refer to Editing Reserved Memory to Add
an Internal Variable with Online Editing on page 165 for details.
• The previous status flags for all differentiated instructions (DIFU(013), @
instructions, DIFD(014), and % instructions) will be initialized (i.e., turned
OFF) when online editing is finished.

170
Procedures Section 3-2

• After performing online editing, do not turn OFF the power supply to the
PLC until the CPU Unit has finished backing up data to the built-in flash
memory (i.e., until the BKUP indicator stops flashing). If the power supply
is turned OFF before the data is backed up, the data will not be backed up
and the program will return to the status it had before online editing was
performed.

171
Procedures Section 3-2

172
 Appendix A
Data Types

Basic Data Types

Data type Content Size Range of values
BOOL Bit data 1 0 (FALSE), 1 (TRUE)
INT Integer 16 −32,768 to +32,767
DINT Double integer 32 −2,147,483,648 to +2,147,483,647
LINT Long (8-byte) integer 64 −9,223,372,036,854,775,808 to +9,223,372,036,854,775,807
UINT Unsigned integer 16 &0 to 65,535
UDINT Unsigned double integer 32 &0 to 4,294,967,295
ULINT Unsigned long (8-byte) 64 &0 to 18,446,744,073,709,551,615
integer
REAL Real number 32 −3.402823 × 1038 to −1.175494 × 10−38, 0,
+1.175494 × 10−38 to +3.402823 × 1038
LREAL Long real number 64 −1.79769313486232 × 10308 to −2.22507385850720 × 10−308, 0,
2.22507385850720 × 10−308 to 1.79769313486232 × 10308
WORD 16-bit data 16 #0000 to FFFF or &0 to 65,535
DWORD 32-bit data 32 #00000000 to FFFFFFFF or &0 to 4,294,967,295
LWORD 64-bit data 64 #0000000000000000 to FFFFFFFFFFFFFFFF or
&0 to 18,446,744,073,709,551,615
STRING Text string (See note 1.) Variable ---
(See note 1.)
TIMER Timer (See note 2.) Flag: 1 bit Timer number: 0 to 4095
(See note 2.) PV: 16 bits Completion Flag: 0 or 1
Timer PV: 0 to 9999 (BCD), 0 to 65535 (binary)
COUNTER Counter (See note 2.) Flag: 1 bit Counter number: 0 to 4095
(See note 2.) PV: 16 bits Completion Flag: 0 or 1
Counter PV: 0 to 9999 (BCD), 0 to 65535 (binary)
FUNCTION Function block instance --- ---
BLOCK

Note (1) The STRING data type can be used only in ST programming. It cannot be used in ladder diagrams.
(2) The TIMER and COUNTER data types cannot be used in structured text function blocks.

Derivative Data Types

Array 1-dimensional array; 32,000 elements max.

173
Data Types Appendix A

174
 Appendix B
Structured Text Specifications

Structured Text
Structured text (also referred to as ST language) is a high-level programming language similar to PASCAL that
uses language structures such as selection and iteration statements. Programs written using structured text
are configured using statements. Statements are configured from variables and equations.
• Equations are sequences containing operators and operands (variables or constants). Operators include
arithmetic operators, comparison operators, and logical operators.
• Statements are either assignment or control statements. Assignment statements store calculation results
from the equation in the variable. Control statements include selection statements and iteration state-
ments.

Example of Structured Text

Statement (e.g., CASE): Equation: Configured using
Configured using variables, operators and operands.
equations, etc.

CASE COLOR OF (*Variable COLOR value is...*)

(*1: Increment variable NofRed by 1*)
1: NofRed := NofRed +1;
(*2: Increment variable NofBlue by 1*)
2: NofBlue := NofBlue+1; (*Neither 1 or 2: Increment variable NofOther by 1*)
ELSE NofOther := NofOther+1;
END CASE;
IF NofRed > 100 OR NofBlue >100 THEN (* When NofRed or NofBlue exceeds 100*)
STOP:=TRUE (*Assign TRUE for variable STOP*)
END IF;

Comment: Configured using (* before the

comment and *) after the comment.
Statement (e.g., IF):
Configured using variables,
equations, etc.

Restrictions
Statement Delimiters
• Statements (assignment and control statements) must always end in a semicolon (;). The statement can-
not be completed by simply using a carriage return.
• Do not use a semicolon (;) as a delimiter within a statement such as following reserved words, values, or
equations. Inserting a semicolon within a statement, except at the end of a statement, will result in a syntax
error.

Comments
• Comments are enclosed in parentheses and asterisks, i.e., (*comment*). Any characters except parenthe-
ses and asterisks can be used within a comment. Nesting within comments is not supported.
Notation Example
(*comment*) (*this is the comment*)
Note: Nesting in comments is not possible, i.e., (*(*this type of nesting is not supported*)*)

175
Structured Text Specifications Appendix B

Spaces, Carriage Returns, Tabs

• Any number of spaces, carriage returns, and tabs, or combinations of these can be used anywhere within
statements. Therefore, use spaces, carriage returns, and tabs between reserved words and equations to
make them easier to read.
• Spaces, carriage returns, and tabs cannot be used between the following tokens (the smallest meaningful
unit for compiling), in which case they are referred to as token separators.
Tokens: Reserved words, variable names, special characters, constants (numerical values)
Reserved words (upper or lower case):AND, CASE, DO, ELSE, FOR, IT, NOT, OF, OR, REPEAT,
THEN, TO, UNTIL, WHILE, XOR, TRUE, FALSE, ELSIF, BY,
EXIT, RETURN
Variable names: Any text that is not a reserved word will be recognized as a variable
name.
Special characters: <=, >=, <>, :=, .., &, (*, *)
Constants (numerical values): Numerical value only for decimal numbers
16# followed by numerical value for hexadecimal numbers
2# followed by numerical value for binary numbers
8# followed by numerical value for octal numbers
If a space, carriage return, or tab is used between any of the above tokens, the parts of the token on either
side will be treated as separate tokens. Therefore, make sure that spaces, carriage returns, or tabs are not
used within a single token.
• Always use a space, carriage return, tab, or other token separator between reserved words and variable
names. Using token separators between other token combinations is optional.
In the following example, the box (@) indicates where a space, carriage return, tab, or other token separa-
tor is required.
IF@A>0THEN@X=10;
ELSE@
X:=0;
END_IF;

Upper and Lower Case

• Reserved words and variable names do not distinguish between upper and lower case (either can be
used).

Prohibited Characters for Variable Names

• The following characters enclosed in square brackets cannot be used in variable names.
[!], [“], [#], [$], [%], [&], [‘], [(],, [)], [-], [=], [^], [~], [\], [|], [@], [‘], [[], [{], [;], [+], [:], [*], []], [}], [,], [<], [.], [>], [/], [?]
• The numbers 0 to 9 cannot be used as the first character of variable names.
• An underscore cannot be followed immediately by another underscore in variable names.
• Spaces cannot be used in variable names.
An error message will occur if any of these characters are used in this way.

Inputting Constants
• Numerical values can be expressed in decimal, hexadecimal, octal, or binary, as shown in the following
examples.
Notation Method Example (for the decimal value 12)
Decimal: Numerical value only 12
Hexadecimal: 16# followed by numerical value 16#C
Octal: 8# followed by numerical value 8#14
Binary: 2# followed by numerical value 2#1100
Text string: Place in single quotation marks ‘Hello world’

176
Structured Text Specifications Appendix B

Operator Priority
• Consider the operator priority in the structured text syntax, or enclose operations requiring priority in
parentheses.
Example: AND takes priority over OR. Therefore, in the example X OR Y AND Z, priority will be given to Y
AND Z.

STRING Data Type

• The following text strings are supported: Strings with up to 255 alphanumeric characters
The text strings are not case sensitive.
• Text strings are stored in PLC memory as follows:
Data for the Text String "123456"

n 31 32
n+1 33 34
n+2 35 36 The null code (00) is stored
at the end of the text string.
n+3 00 00
• Place text strings inside signal quotation marks.
Notation Description
‘A’ Indicates the text string “A” (ASCII 41).
‘’ Indicates a text string containing a single space (ASCII 20).
‘’ Indicates an empty text string.

• Two hexadecimal digits following a dollar sign ($) are interpreted as hexadecimal values.
Notation Description
$02 The hexadecimal number 02 (start code)
$03 The hexadecimal number 03 (end code)

• Certain alphabet characters following a dollar sign ($) are interpreted as listed in the following table.
Notation Description
$$ The dollar sign (ASCII 24)
$’ A single quotation mark (ASCII 27)
$L or $l Line feed (ASCII 0A)
$N or $n Carriage return + line feed (ASCII 0D 0A)
$P or $p New page (ASCII 0C)
$R or $r Carriage return (ASCII 0D)
$T or $t Tab (ASCII 09)

CX-Programmer’s ST Input Screen Display

Text Display Color
The CX-Programmer automatically displays text in the following colors when it is input or pasted in the ST Input
Screen.
• Text keywords (reserved words): Blue
• Comments: Green
• Errors: Red
• Other: Black

Changing Fonts
To change font sizes or display colors, select Tools - Options, click the Appearance Tab, and then click the ST
Font Button. The font name, font size (default is 8 point), and color can be changed.

177
Structured Text Specifications Appendix B

Statements
Statement Function Example
End of statement Ends the statement ;
Comment All text between (* and *) is treated as a (*comment*)
comment.
Assignment Substitutes the results of the expres- A:=B;
sion, variable, or value on the right for
the variable on the left.
IF, THEN, ELSIF, ELSE, END_IF Evaluates an expression when the con- IF (condition_1) THEN
dition for it is true. (expression 1);
ELSIF (condition_2) THEN
(expression 2);
ELSE
(expression 3);
END_IF;
CASE, ELSE, END_CASE Evaluates an express based on the CASE (variable) OF
value of a variable. 1: (expression 1);
2: (expression 2);
3: (expression 3);
ELSE
(expression 4);
END_CASE;
FOR, TO, BY, DO, END_FOR Repeatedly evaluates an expression FOR (identifier) := (initial_value) TO
according to the initial value, final (final_value) BY (increment) DO
value, and increment. (expression);
END_FOR;
WHILE, DO, END_WHILE Repeatedly evaluates an expression as WHILE (condition) DO
long as a condition is true. (expression);
END_WHILE;
REPEAT, UNTIL, END_REPEAT Repeatedly evaluates an expression REPEAT
until a condition is true. (expression);
UNTIL (condition)
END_REPEAT;
EXIT Stops repeated processing. EXIT;
RETURN Returns to the point in the program RETURN;
from which a function block was called.
Function block instance call Calls another function block definition. Variable name with FUNCTION
BLOCK data type (called function block
definition’s input variable name := call-
ing function block definition’s variable
name or constant, ..., called function
block definition’s output variable name
or constant => calling function block
definition’s output variable name, ...);

Operators
Operation Symbol Data types supported by operator Priority
1: Lowest
11: Highest
Parentheses and (expression), 1
brackets array[index]
Function evaluation identifier Depends on the function (refer to 2-6 Instruction 2
Support and Operand Restrictions)
Exponential ** REAL, LREAL 3
Complement NOT BOOL, WORD, DWORD, LWORD 4
Multiplication * INT, DINT, UINT, UDINT, ULINT, REAL, LREAL 5
Division / INT, DINT, LINT, UINT, UDINT, ULINT, REAL, LREAL 5

178
Structured Text Specifications Appendix B

Operation Symbol Data types supported by operator Priority

1: Lowest
11: Highest
Addition + INT, DINT, LINT, UINT, UDINT, ULINT, REAL, LREAL 6
Subtraction − INT, DINT, LINT, UINT, UDINT, ULINT, REAL, LREAL 6
Comparisons <, >, <=, >= BOOL, INT, DINT, LINT, UINT, UDINT, ULINT, 7
WORD, DWORD, LWORD, REAL, LREAL
Equality = BOOL, INT, DINT, LINT, UINT, UDINT, ULINT, 8
WORD, DWORD, LWORD, REAL, LREAL
Non-equality <> BOOL, INT, DINT, LINT, UINT, UDINT, ULINT, 8
WORD, DWORD, LWORD, REAL, LREAL
Boolean AND & BOOL, WORD, DWORD, LWORD 9
Boolean AND AND BOOL, WORD, DWORD, LWORD 9
Boolean exclusive XOR BOOL, WORD, DWORD, LWORD 10
OR
Boolean OR OR BOOL, WORD, DWORD, LWORD 11

Note Operations are performed according to the data type.

Therefore, the addition result for INT data, for example, must be a variable using the INT data type. Par-
ticularly care is required when a carry or borrow occurs in an operation for integer type variables. For
example, using integer type variables A=3 and B= 2, if the operation (A/B)*2 is performed, the result of
A/B is 1 (1.5 with the value below the decimal discarded), so (A/B)*2 = 2.

Standard Functions
Function type Syntax
Numerical Functions Absolute values, trigonometric functions, etc.
Arithmetic Functions Exponential (EXPT)
Data Type Conversion Functions Source_data_type_TO_New_data_type (Variable_name)
Number-String Conversion Functions Source_data_type_TO_STRING (Variable_name)
STRING_TO_New_data_type (Variable_name)

Numerical Functions
The following numerical functions can be used in structured text.
Function Argument data type Return value Description Example
data type
ABS (argument) INT, DINT, LINT, INT, DINT, LINT, Absolute value [argu- a: = ABS (b)
UINT, UDINT, ULINT, UINT, UDINT, ment] (*absolute value of variable
REAL, LREAL ULINT, REAL, b stored in variable a*)
LREAL
SQRT (argument) REAL, LREAL REAL, LREAL Square root: a: = SQRT (b)
√ argument (*square root of variable b
stored in variable a*)
LN (argument) REAL, LREAL REAL, LREAL Natural logarithm: LOGe a: = LN (b)
argument (*natural logarithm of vari-
able b stored in variable a*)
LOG (argument) REAL, LREAL REAL, LREAL Common logarithm: a: = LOG (b)
LOG10 argument (*common logarithm of vari-
able b stored in variable a*)
EXP (argument) REAL, LREAL REAL, LREAL Natural exponential: ear- a: = EXP (b)
gument (*natural exponential of vari-
able b stored in variable a*)
SIN (argument) REAL, LREAL REAL, LREAL Sine: SIN argument a: = SIN (b)
(*sine of variable b stored in
variable a*)

179
Structured Text Specifications Appendix B

Function Argument data type Return value Description Example

data type
COS (argument) REAL, LREAL REAL, LREAL Cosine: COS argument a: = COS (b)
(*cosine of variable b stored
in variable a*)
TAN (argument) REAL, LREAL REAL, LREAL Tangent: TAN argument a: = TAN (b)
(*tangent of variable b stored
in variable a*)
ASIN (argument) REAL, LREAL REAL, LREAL −1 a: = ASIN (b)
Arc sine: SIN argument
(*arc sine of variable b
stored in variable a*)
ACOS (argument) REAL, LREAL REAL, LREAL −1 a: = ACOS (b)
Arc cosine: COS argu-
ment (*arc cosine of variable b
stored in variable a*)
ATAN (argument) REAL, LREAL REAL, LREAL −
Arc tangent: TAN 1 argu-
a: = ATAN (b)
ment (*arc tangent of variable b
stored in variable a*)
EXPT (base, expo- Base REAL, REAL, LREAL Exponential: Base exponent a: = EXPT (b, c)
nent) LREAL (*Exponential with variable b
Exponent INT, as the base and variable c
DINT, as the exponent is stored in
LINT, variable a*)
UINT,
UDINT,
ULINT

Note The data type returned for numerical functions is the same as that used in the argument. Therefore, vari-
ables substituted for function return values must be the same data type as the argument.

Text String Functions

The following functions can be used with CPU Units with unit version 4.0 or later.
Function Argument data type Return Description Example
value
data type
LEN(String) String STRING INT Detects the length a: = LEN (b)
of a text string. (*number of characters in string
b stored in variable a*)
LEFT(<Source_string>, Source_ STRING STRING Extracts charac- a: = LEFT (b,c)
<Number_of_characters>) string ters from a text (*number of characters specified
Number_of_ INT, string starting from by variable c extracted from the
characters UINT the left. left of text string b and stored in
variable a*)
RIGHT(<Source_string>, Source_ STRING STRING Extracts charac- a: = RIGHT (b,c)
<Number_of_characters>) string ters from a text (*number of characters specified
Number_of_ INT, string starting from by variable c extracted from the
characters UINT the right. eight of text string b and stored
in variable a*)
MID(<Source_string>, Source_ STRING STRING Extracts charac- a: = MID (b,c,d)
<Number_of_characters>, string ters from a text (*number of characters specified
<Position>) Number_of_ INT, string. by variable c extracted from text
characters UINT string b starting at position spec-
Position INT, ified by variable d and stored in
UINT variable a*)
CONCAT(<Source_string_ Source_ STRING STRING Concatenates text a: = CONCAT (b,c...)
1>,<Source_string_2>,...) string strings. (*text strings b, c... are joined
*Up to 32 source strings.* and stored in variable a*)

180
Structured Text Specifications Appendix B

Function Argument data type Return Description Example

value
data type
INSERT(<Source_string>, Source_ STRING STRING Insert one text a: = INSERT (b,c,d)
<Insert_string>,<Position>) string string into another. (*text string c inserted into text
Insert_ STRING string b at position specified by
string variable d and resulting string
Position INT, stored in variable a*)
UINT
DELETE(<Source_string>, Source_ STRING STRING Deletes characters a: = DELETE (b,c,d)
<Number_of_characters>, string from a text string. (*number of characters specified
<Position>) Number_of_ INT, by variable c deleted from text
characters UINT string b starting from position
Position INT, specified by variable d and
UINT resulting string stored in variable
a*)
REPLACE(<Source_string Source_ STRING STRING Replaces charac- a: = REPLACE (b,c,d,e)
>,<Replace_string>, string ters in a text string. (*number of characters specified
<Number_of_characters>, Replace_ STRING by variable d in source string b
<Position>) string replaced with text string c start-
Number_of_ INT, ing from position specified by
characters UINT variable e and resulting string
stored in variable a*)
Position INT,
UINT
FIND(<Source_string>, Source_ STRING INT Finds characters a: = FIND (b,c)
<Find_string>) string within a text string. (*first occurrence of text string c
Find_string STRING found in text string b and posi-
tion stored in variable a; 0 stored
if text string c is not found.*)

Data Type Conversion Functions

The following data type conversion functions can be used in structured text.
Syntax
Source_data_type_TO_New_data_type (Variable_name)
Example: REAL_TO_INT (C)
In this example, the data type for variable C will be changed from REAL to INT.
Data Type Combinations
The combinations of data types that can be converted are given in the following table.
(YES = Conversion possible, No = Conversion not possible)
FROM TO
BOOL INT DINT LINT UINT UDINT ULINT WORD DWORD LWORD REAL LREAL BCD_ BCD_
WORD DWORD
BOOL No No No No No No No No No No No No No No
INT No No YES YES YES YES YES YES YES YES YES YES YES YES
DINT No YES No YES YES YES YES YES YES YES YES YES YES YES
LINT No YES YES No YES YES YES YES YES YES YES YES No No
UINT No YES YES YES No YES YES YES YES YES YES YES YES YES
UDINT No YES YES YES YES No YES YES YES YES YES YES YES YES
ULINT No YES YES YES YES YES No YES YES YES YES YES No No
WORD No YES YES YES YES YES YES No YES YES No No No No
DWORD No YES YES YES YES YES YES YES No YES No No No No
LWORD No YES YES YES YES YES YES YES YES No No No No No
REAL No YES YES YES YES YES YES No No No No YES No No
LREAL No YES YES YES YES YES YES No No No YES No No No

181
Structured Text Specifications Appendix B

FROM TO
BOOL INT DINT LINT UINT UDINT ULINT WORD DWORD LWORD REAL LREAL BCD_ BCD_
WORD DWORD
WORD_ No YES YES No YES YES No No No No No No No No
BCD
DWORD_ No YES YES No YES YES No No No No No No No No
BCD

Number-String Conversion Functions

The following number-string conversion functions can be used in structured text.
Syntax
Source_data_type_TO_STRING (Variable_name)
Example: INT_TO_STRING (C)
In this example, the integer variable C will be changed to a STRING variable.
STRING_TO_New_data_type (Variable_name)
Example: STRING_TO_INT (C)
In this example, the STRING variable C will be changed to an integer.
Data Type Combinations
The combinations of data types that can be converted are given in the following table.
(YES = Conversion possible, No = Conversion not possible)
FROM TO
BOOL INT DINT LINT UINT UDINT ULINT WORD DWORD LWORD REAL LREAL STRING
BOOL No No No No No No No No No No No No No
INT No No YES YES YES YES YES YES YES YES YES YES YES
DINT No YES No YES YES YES YES YES YES YES YES YES YES
LINT No YES YES No YES YES YES YES YES YES YES YES No
UINT No YES YES YES No YES YES YES YES YES YES YES YES
UDINT No YES YES YES YES No YES YES YES YES YES YES YES
ULINT No YES YES YES YES YES No YES YES YES YES YES No
WORD No YES YES YES YES YES YES No YES YES No No YES
DWORD No YES YES YES YES YES YES YES No YES No No YES
LWORD No YES YES YES YES YES YES YES YES No No No No
REAL No YES YES YES YES YES YES YES YES YES No No No
LREAL No YES YES YES YES YES YES YES YES YES No No No
STRING No YES YES No YES YES No YES YES No No No No

182
Structured Text Specifications Appendix B

OMRON Expansion Functions

Function type Description
Memory Card Functions Functions that write data to Memory Cards
Communications Functions Functions that send and received text strings
Angle Conversion Functions Functions that convert between degrees and radians.

Memory Card Functions

The following functions can be used with CPU Units with unit version 4.0 or later.
Function Argument data type Return Description Example
value
data type
WRITE_TEXT(<Write_string>, Write_string STRING --- Writes a text WRITE_TEXT(a,b,c,d)
<Directory_name_and_file_ Directory_ STRING string to a (*text string a is written to a file
name>,<Delimiter>,<Parame- name_and_ Memory with the file name and directory
ter>) file_name Card. specified by variable b; if variable
Delimiter STRING d is 0, the text string is added to
the file along with delimiter speci-
Parameter INT, fied by variable c; if variable d is 1,
UINT, a new file is created*)
WORD

Communications Functions
The following functions can be used with CPU Units with unit version 4.0 or later.
Function Argument data type Return Description Example
value
data type
TXD_CPU(<Send_string>) Send_string STRING --- Sends a text string to TXD_CPU(a)
the RS-232C port on (*text string a is sent from
the CPU Unit. the RS-232C port on the
CPU Unit*)
TXD_SCB(<Send_string>, Send_string STRING --- Sends a text string to TXD_SCB(a,b)
<Serial_port>) Serial_port INT, the serial port on a (*text string a is sent from
UINT, Serial Communica- the serial port specified by
WORD tions Board. variable b on the Serial
Communications Board*)
TXD_SCU(<Send_string>, Send_string STRING --- Sends a text string to a TXD_SCU(a,b,c,d)
<SCU_unit_number>, SCU_unit_ INT, serial port on a Serial (*text string a is sent from
<Serial_port>,<Internal_ number UINT, Communications Unit. the serial port specified by
logic_port>) WORD variable c on the Serial
Serial_port INT, --- Communications Unit speci-
UINT, fied by variable b using the
WORD internal logic port specified
by variable d*)
Internal_logic INT, ---
_port UINT,
WORD
RXD_CPU(<Storage_ Storage_ STRING --- Receives a text string RXD_CPU(a,b)
location>,<Number_of_ location from the RS-232C port (*number of characters
characters>) Number_of_ INT, on the CPU Unit. specified by variable b are
characters UINT, received from the RS-232C
WORD port on the CPU Unit and
stored in variable a*)

183
Structured Text Specifications Appendix B

Function Argument data type Return Description Example

value
data type
RXD_SCB(<Storage_ Storage_ STRING --- Receives a text string RXD_SCB(a,b,c)
location>,<Number_of_ location from the serial port on (*number of characters
characters>,<Serial_port>) Number_of_ INT, a Serial Communica- specified by variable b are
characters UINT, tions Board. received from the serial port
WORD specified by variable c on
Serial_port INT, the Serial Communications
UINT, Board and stored in variable
WORD a*)
RXD_SCU(<Storage_ Storage_ STRING --- Receives a text string RXD_SCU(a,b,c,d,e)
location>,<Number_of_ location from a serial port on a (*number of characters
characters>,<SCU_unit_ Number_of_ INT, Serial Communica- specified by variable b are
number>,<Serial_port>, characters UINT, tions Unit. received from the serial port
<Internal_logic_port>) WORD specified by variable d on
SCU_unit_ INT, the Serial Communications
number UINT, Unit specified by variable c
WORD using the internal logic port
specified by variable e and
Serial_port INT, stored in variable a*)
UINT,
WORD
Internal_logic INT,
_port UINT,
WORD

Angle Conversion Instructions

The following functions can be used with CPU Units with unit version 4.0 or later.
Function Argument Return value Description Example
data type data type
DEG_TO_RAD(argument) REAL, LREAL REAL, LREAL Converts an angle from a:=DEG_TO_RAD(b)
degrees to radians. (*an angle in degrees in variable
b is converted to radians and
stored in variable a*)
RAD_TO_DEG (argu- REAL, LREAL REAL, LREAL Converts an angle from a:=RAD_TO_DEG(b)
ment) radians to degrees. (*an angle in radians in variable
b is converted to degrees and
stored in variable a*)

Statement Descriptions
Assignment
Summary
The left side of the statement (variable) is substituted with the right side of the statement (equation, variable, or
constant).
Reserved Words
:=
Combination of colon (:) and equals sign (=).
Statement Syntax
Variable: = Equation, variable, or constant;
Usage
Use assignment statements for inputting values in variables. This is a basic statement for use before or within
control statements. This statement can be used for setting initial values, storing calculation results, and incre-
menting or decrementing variables.

184
Structured Text Specifications Appendix B

Description
Substitutes (stores) an equation, variable, or constant for the variable.
Examples
Example 1: Substitute variable A with the result of the equation X+1.
A:=X+1;
Example 2: Substitute variable A with the value of variable B.
A:=B;
Example 3: Substitute variable A with the constant 10.
A:=10;
Precautions
The data type of the equation, variable, or constant to be assigned must be the same as the data type of the
variable to be substituted. Otherwise, a syntax error will occur.

Control Statements
IF Statement (Single Condition)
Summary
This statement is used to execute an expression when a specified condition is met. If the condition is not met,
a different expression is executed.
Reserved Words
IF, THEN, (ELSE), END_IF
Note ELSE can be omitted.
Statement Syntax
IF <condition> THEN
<expression_1>;
ELSE
<expression_2>;
END_IF;
Process Flow Diagram

False
Condition

True

Expression 1 Expression 2

Usage
Use the IF statement to perform a different operation depending on whether a single condition (condition equa-
tion) is met.
Description
Condition = If true, execute expression_1
Condition = If false, execute expression_2
Precautions
• IF must be used together with END_IF.

185
Structured Text Specifications Appendix B

• The condition must include a true or false equation for the evaluation result.
Example: IF(A>10)
The condition can also be specified as a boolean variable only rather than an equation. As a result, the
variable value is 1 (ON) = True result, 0 (OFF) = False result.
• Statements that can be used in expression_1 and expression_2 are assignment statements, IF, CASE,
FOR, WHILE, or REPEAT.
Example:
IF <condition_1> THEN
IF <condition_2> THEN
<expression_1>;
ELSE
<expression_2>:
END_IF;
END_IF;
The processing flow diagram is as follows:

Condition 1 False

True

False
Condition 2

True

Expression 1 Expression 1

ELSE corresponds to THEN immediately before it, as shown in the above diagram.
• Multiple statements can be executed within expression_1 and expression_2. Be sure to use a semicolon (;)
delimiter between multiple statements in an expression.
• The ELSE statement can be omitted. When ELSE is omitted, no operation is executed if the result of the
condition equation is false.
Processing Flow Diagram

False
Condition

True

Expression

Examples
Example 1: If variable A>0 is true, variable X will be substituted with numerical value 10. If A>0 is false, variable
X will be substituted with numerical value 0.

186
Structured Text Specifications Appendix B

IF A>0 THEN
X:=10;
ELSE
X:=0;
END_IF;
Example 2: If variable A>0 and variable B>1 are both true, variable X will be substituted with numerical value
10, and variable Y will be substituted with numerical value 20. If variable A>0 and variable B>1 are both false,
variable X and variable Y will both be substituted with numerical value 0.
IF A>0 AND B>1 THEN
X:=10; Y:=20;
ELSE
X:=0; Y:=0;
END_IF;
Example 3: If the boolean (BOOL data type) variable A=1(ON), variable X will be substituted with numerical
value 10. If variable A=0(OFF), variable X will be substituted with numerical value 0.
IF A THEN X:=10;
ELSE X:=0;
END_IF;

IF Statement (Multiple Conditions)

Summary
This statement is used to execute an expression when a specified condition is met. If the first condition is not
met, but another condition is met, a corresponding expression is executed. If none of the conditions is met, a
different expression is executed.
Reserved Words
IF, THEN, ELSIF, (ELSE)
Note ELSE can be omitted.
Statement Syntax
IF <condition_1> THEN <expression_1>;
ELSIF <condition_2> THEN <expression_2>;
ELSIF <condition_3> THEN <expression_3>;

...
ELSIF <condition_n> THEN <expression_n>;
ELSE <expression_m>;
END_IF;

187
Structured Text Specifications Appendix B

Processing Flow Chart

False
Condition 1

True False
Condition 2

Expression 1 True False

Condition 3

Expression 2
True

Expression 3

Expression m

Usage
Use the IF statement to perform different operations depending which of multiple conditions (condition equa-
tion) is met.
Description
Condition 1 = If true, execute expression 1
Condition 1 = If false,
Condition 2 = If true, execute expression 2
Condition 2 = If false,
Condition 3 = If true, execute expression 3
etc.
Condition n = If true, execute expression n
If none of these conditions are met, condition m is executed.
Precautions
• IF must be used together with END_IF.
• Condition_@ contains the true or false result of the equation (e.g., IF(A>10)).
A boolean (BOOL data type) variable only can also be specified as the condition rather than an equation.
For boolean conditions, the result is true when the variable value is 1 (ON) and false when it is 0 (OFF).
• Statements that can be used in expression_@ are assignment statements, IF, CASE, FOR, WHILE, or
REPEAT.
• Multiple statements can be executed in expression_@. Be sure to use a semicolon (;) delimiter between
multiple statements in an expression.
• The ELSE statement can be omitted. When ELSE is omitted, no operation is executed if the result of any
condition equation is false.
Examples
Example 1: If variable A>0 is true, variable X will be substituted with numerical value 10.
If A>0 is false, but variable B=1, variable X will be substituted with numerical value 1.
If A>0 is false, but variable B=2, variable X will be substituted with numerical value 2.
If either of these conditions is met, variable X will be substituted with numerical value 0.

188
Structured Text Specifications Appendix B

IF A>0 THEN X:=10;

ELSIF B=1 THEN X:=1;
ELSIF B=2 THEN X:=2;
ELSE X:=0;
END_IF;

CASE Statement
Summary
This statement executes an expression containing a selected integer that matches the value from an integer
equation. If the selected integer value is not the same, either no expression or a specified expression is exe-
cuted.
Reserved Word
CASE
Statement Syntax
CASE <integer_equation> OF
<integer_equation_value_1 >:<expression_1>;
<integer_equation_value_2>:<expression_2>;
...
<integer_equation_value_n>:<expression_n>;
ELSE <expression_m>;
END_CASE;
Processing Flow Chart

Same as Yes
selected
value 1?

No

Same as Yes
selected
value 2?

No

Same as Yes
selected
value n?

No

Expression m Expression n Expression 2 Expression 1

Usage
Use the CASE statement to execute different operations depending on specified integer values.
Description
If the integer_equation matches integer_equation_value_n, expression_n is executed.
if the integer_equation does not match any of integer_equation_value_n, expression_m is executed.
Precautions
• CASE must be used together with END_CASE.
• The result of the integer_equation must be in integer format (INT, DINT, LINT, UINT, UDINT, or ULINT).

189
Structured Text Specifications Appendix B

• Statements that can be used in expression_@ are assignment statements, IF, CASE, FOR, WHILE, or
REPEAT.
• Multiple statements can be executed in expression_@. Be sure to use a semicolon (;) delimiter between
multiple statements in an expression.
• Variables in integer format (INT, DINT, LINT, UINT, UDINT, or ULINT), or equations that return integer val-
ues can be specified in the integer_equation.
• When OR logic is used for multiple integers in the integer_equation_value_n, separate the numerical value
using a comma delimiter. To specify a sequence of integers, use two periods (..) as delimiters between the
first and last integers.
Examples
Example 1: If variable A is 1, variable X is substituted with numerical value 1. If variable A is 2, variable X is
substituted with numerical value 2. If variable A is 3, variable X is substituted with numerical value 3. If neither
of these cases matches, variable Y will be substituted with 0.
CASE A OF
1:X:=1;
2:X:=2;
3:X:=3;
ELSE Y:=0;
END_CASE;
Example 2: If variable A is 1, variable X is substituted with numerical value 1. If variable A is 2 or 5, variable X
is substituted with numerical value 2. If variable A is a value between 6 and 10, variable X is substituted with
numerical value 3. If variable A is 11, 12, or a value between 15 and 20, variable X is substituted with numerical
value 4. If neither of these cases matches, variable Y will be substituted with 0.
CASE A OF
1:X:=1;
2,5:X:=2;
6..10:X:=3;
11,12,15..20:X:=4;
ELSE Y:=0;
END_CASE;

FOR Statement
Summary
This statement is used to execute a specified expression repeatedly until a variable (referred to here as an iter-
ation variable) reaches a specified value.
Reserved Words
FOR, TO, (BY), DO, END_FOR
Note BY can be omitted.
Statement Syntax
FOR <iteration_variable>:= <initial_value> TO <final_value_equation> BY
<increment_value_equation>
DO
<expression>;
END_FOR;

190
Structured Text Specifications Appendix B

Processing Flow Chart

Iteration variable = Initial

Iteration
Iteration
True
variable ≥
Final value?

False

Expression

Iteration variable + Increment value

End

Usage
Use the FOR statement when the number of iterations has been determined beforehand. FOR is particularly
useful when switching the number of elements in an array variable according to the value of a specified itera-
tion variable.
Description
When the iteration_variable is the initial_value, the expression is executed. After execution, the value obtained
from the increment_equation is added to the iteration_variable, and if the iteration_variable <
final_value_equation (see note 1), the expression is executed. After execution, the value obtained from the
increment_equation is added to the iteration_variable, and if the iteration_variable < final_value_equation value
(see note 1), the expression is executed. This process is repeated. If the iteration_variable ≥
final_value_equation (see note 2), the processing ends.
Note (1) If the value from the increment_equation is negative, the condition is iteration_variable >
final_value_equation value.
(2) If the value from the increment_equation is negative, the condition is iteration_variable ≤
final_value_equation.
Precautions
• A negative value can be specified in the increment_equation
• FOR must be used in combination with END_FOR.
• The initial_value, final_value_equation, and final_value_equation must be an integer data type (INT, DINT,
LINT, UINT, UDINT, or ULINT).
• After processing is executed with the final value, the iteration value is incremented to the final value + 1 and
iteration processing ends.
Example: In the following structured text, the value of “a” becomes TRUE.
FOR i:=0 TO 100 DO
array[i]:=0;
END_FOR;

IF i=101 THEN
a:=TRUE;
ELSE
a:=FALSE;
END_IF;

191
Structured Text Specifications Appendix B

• Do not use a FOR statement in which an iteration variable is changed directly. Doing so may result in unex-
pected operations.
Example:
FOR i:=0 TO 100 BY 1 DO
array[i]:=0;
i:=i+5;
END_FOR;
• Statements that can be used in the expression are assignment statements, IF, CASE, FOR, WHILE, or
REPEAT.
• Multiple statements can be executed in the expression. Be sure to use a semicolon (;) delimiter between
multiple statements in an expression.
• BY increment_equation can be omitted. When omitted, BY is taken as 1.
• Variables with integer data types (INT, DINT, LINT, UINT, UDINT, or ULINT), or equations that return inte-
ger values can be specified in the initial_value, final_value_equation, and increment_equation.
Example 1: The iteration is performed when the iteration variable n = 0 to 50 in increments of 5, and the
array variable SP[n] is substituted with 100.
FOR n:=0 TO 50 BY 5 DO
SP[n]:=100;
END_FOR;
Example 2: The total value of elements DATA[1] to DATA[50] of array variable DATA[n] is calculated, and
substituted for the variable SUM.
FOR n:=0 TO 50 BY 1 DO
SUM:=SUM+DATA[n];
END_FOR;
Example 3: The maximum and minimum values from elements DATA[1] to DATA[50] of array variable
DATA[n] are detected. The maximum value is substituted for variable MAX and the minimum value is sub-
stituted for variable MIN. The value for DATA[n] is between 0 and 1000.
MAX:=0;
MIN:=1000;
FOR n:=1 TO 50 BY 1 DO
IF DATA[n]>MAX THEN
MAX:=DATA[n];
END IF;
IF DATA[n]<MIN THEN
MIN:=DATA[n];
END IF;
END_FOR;

WHILE Statement
Summary
This statement is used to execute a specified expression repeatedly for as long as a specified condition is true.
Reserved Words
WHILE, DO, END_WHILE
Statement Syntax
WHILE <condition> DO
<expression>;
END_WHILE;

192
Structured Text Specifications Appendix B

Processing Flow Chart

Iteration

False
Condition

True

Expression

End

Usage
Use the WHILE statement when the number of iterations has not been determined beforehand (depends on
the condition being met) to repeat specified processing for the duration that the condition is met. This state-
ment can be used to execute processing while the condition equation is true only (pretest loop).
Description
Before the expression is executed, the condition is evaluated.
If the condition is true, the expression is executed. Afterwards, the condition is evaluated again. This process is
repeated. If the condition is false, the expression is not executed and the condition evaluation ends.
Precautions
• WHILE must be used in combination with END_WHILE.
• Before executing the expression, if the condition equation is false, the process will end without executing
the expression.
• Statements that can be used in the expression are assignment statements, IF, CASE, FOR, WHILE, or
REPEAT.
• Multiple statements can be executed in the expression. Be sure to use a semicolon (;) delimiter between
multiple statements in an expression.
• The condition can also be specified as a boolean variable (BOOL data type) only rather than an equation.
Examples
Example 1: The value exceeding 1000 in increments of 7 is calculated and substituted for variable A.
A:=0;
WHILE A>=1000 DO
A:=A+7;
END_WHILE;
Example 2: While X<3000, the value of X is doubled, and the value is substituted for the array variable DATA[1].
The value of X is then multiplied by 2 again, and the value is substituted for the array variable DATA[2]. This
process is repeated.
n:=1’
WHILE X<3000 DO
X:=X*2;
DATA[n]:=X;
n:=n+1;
END_WHIE;

REPEAT Statement
Summary
This statement is used to repeatedly execute an expression until a specified condition is true.

193
Structured Text Specifications Appendix B

Reserved Words
REPEAT, UNTIL, END_REPEAT
Statement Syntax
REPEAT
<expression>;
UNTIL <condition>
END_REPEAT
Processing Flow Chart

Expression
Iteration

False
Condition

True

End

Usage
Use the REPEAT statement to repeat processing for as long as a condition is met after specified processing,
when the number of iterations is undetermined beforehand (depends on whether the condition is met). This
statement can be used to determine whether to repeat processing according to the results of specified pro-
cessing execution (post-test loop).
Description
The expression will execute the first time without a condition. Thereafter, the condition equation will be evalu-
ated. If the condition is false, the expression will be executed again. If the condition is true, processing will end
without executing the expression.
Precautions
• REPEAT must be used together with END_REPEAT.
• Even if the condition equation is true before the expression has been executed, the expression will be exe-
cuted.
• Statements that can be used in the expression are assignment statements, IF, CASE, FOR, WHILE, or
REPEAT.
• Multiple statements can be executed in the expression. Be sure to use a semicolon (;) delimiter between
multiple statements in an expression.
• The condition can also be specified as a boolean variable (BOOL data type) only rather than an equation.
Examples
Example 1: Numeric values from 1 through 10 are incremented and the total is substituted for the variable
TOTAL.
A:=1;
TOTAL:=0;
REPEAT
TOTAL:=TOTAL+A;
A:=A+1;
UNTIL A>10
END_REPEAT;

194
Structured Text Specifications Appendix B

EXIT Statement
Summary
This statement is used within iteration statements (FOR, WHILE, REPEAT) only to force an iteration statement
to end. This statement can also be used within an IF statement to force an iteration statement to end when a
specified condition is met.
Reserved Words
EXIT
Statement Syntax (Example: Using within IF Statement)
FOR (WHILE, REPEAT) expression
...
IF <condition> THEN EXIT;
END_IF;

...
END_FOR (WHILE, REPEAT);
Usage
Use the EXIT statement to force iteration processing to end before the end condition is met.
Description (Example: Using within IF Statement)
When the condition equation is true, the iteration statement (FOR, WHILE, REPEAT) is forced to end, and any
statements after EXIT will not be executed.
Note (1) The condition can also be specified as a boolean variable (BOOL data type) only rather than an
equation.
(2) Even if the condition equation is true before the expression has been executed, the expression will
be executed.
Example
Processing is repeated from when variable n = 1 until 50 in increments of 1 and n is added to array variable
DATA[n]. If DATA[n] exceeds 100, however, processing will end.
FOR n:=1; TO 50 BY 1 DO
DATA[n]:=DATA[n]+n;
IF DATA[n]>100 THEN EXIT;
END_IF;
END_FOR;

RETURN Statement
Summary
This statement is used to execute the next instruction following the location that called the function block in the
program when the function block in the structured text must be forced to end before it has been completed.
Reserved Words
RETURN
Statement Syntax
RETURN;
Usage
Use the RETURN statement when a function block has been forced to end.

Function Block Call Statement

Summary
This statement is used to call another function block definition.

195
Structured Text Specifications Appendix B

Reserved Words
None
Statement Syntax
After specifying the instance name (see note), specify the arguments (the calling function block’s input vari-
ables to pass to the called function block’s input variables) and return values (the called function block’s output
variables to be received by the calling function block’s output variables) in parentheses.
Note The instance name can be any internal variable name that has the Function Block data type.
Either of the following two methods can be used to enter the function call statement.
1. Specification Method A: Specify both the Called and Calling Function Blocks’ Variable Names
Instance name (called function block definition’s input variable name := calling function block definition’s
variable name or constant, ..., called function block definition’s output variable name or constant => call-
ing function block definition’s output variable name, ...);
Note All of the input variable specifications (called function block definition’s input variable name :=
calling function block definition’s variable name or constant) must be separated by commas.
Only the required number of output variable specifications (called function block definition’s
output variable name or constant => calling function block definition’s output variable name)
must be separated by commas.
2. Specification Method B: Specify only the Calling Function Block’s Variable Names (or Constants) and Omit
the Called Function Block’s Variable Names
Instance name (calling function block definition’s variable name or constant, ..., calling function block
definition’s output variable name, ...);
Note When the called function block definition’s input and output variable names are omitted as
shown above, the values of the calling function block’s input variables (or constants) are au-
tomatically passed to the called function block’s input variables in the order that the variables
are registered in the variable table. In the same way, the called function block’s output vari-
ables are automatically returned to the calling function block’s output variables in the order
that they are registered in the variable table.
Usage
Use the function block call statement to call a function block definition (ST or ladder language) from an ST-lan-
guage program.
Description
1. The following instance is registered in the internal variables in the variable table.
Internal variable element Content Example
Name Any instance name Calcu_execute
Data type FUNCTION BLOCK FUNCTION BLOCK
FB definition Selects the called function block defini- Calculation
tion.

2. The values that will be passed between variables are specified within parentheses after the registered in-
stance name (Calcu_execute in this example) and a semi-colon marks the end of the statement, as shown
in the following example.
Calcu_execute (A:=B,C=>D) ;
The value of input variable B (in the calling function block) is passed to input variable A (in the called func-
tion block). Likewise the value of output variable C (in the called function block) is returned to output vari-
able D (in the calling function block).
Examples
In the following examples, a function block is called from function block 1 (FB1).
• Function block 1 is written in ST language.

196
Structured Text Specifications Appendix B

• Function block 2 can be written in either ladder or ST language.

Program FB1 (ST) FB2 (ladder)

Instance_FB1
Example:
FB1 Instance_FB2 (..., ...);

FB2 (ST)
Example:

INSTANCE _FB1 is an instance name with data type FUNCTION BLOCK.

• The following table shows the variables in function block 1 and the corresponding variables in function
block 2 that receive/pass data.
Variable type Variable name Passage to/from FB2
Input variables FB1_IN1 Passed to FB2_IN1
FB1_IN2 Passed to FB2_IN2
FB1_IN3 Passed to FB2_IN3
Output variables FB1_OUT1 Received from FB2_OUT1
FB1_OUT2 Received from FB2_OUT2
FB1_OUT3 Received from FB2_OUT3
Internal variables A Passed to EN
Note: Data Type = Bool
B Received from ENO
Note: Data Type = Bool
Internal variables (instance) Instance_FB2 Called function block definition:
Note: Data Type = FUNCTION BLOCK Function block 2

• The following table shows the variables in function block 2 and the corresponding variables in function
block 1 that receive/pass data.
Variable type Variable name Passage to/from FB2
Input variables FB2_IN1 Received from FB1_IN1
FB2_IN2 Received from FB1_IN2
FB2_IN3 Received from FB1_IN3
Output variables FB2_OUT1 Passed to FB1_OUT1
FB2_OUT2 Passed to FB1_OUT2
FB2_OUT3 Passed to FB1_OUT3

Example 1: Specification Method A (Specifying both the FB1 and FB2 Variables)
Instance_FB2(EN:=A,FB2_IN1:=FB1_IN1,FB2_IN2:=FB1_IN2,FB2_IN3:=FB1_IN3,FB2_OUT1=>FB1_
OUT1,FB2_OUT2=>FB1_OUT2,FB2_OUT3=>FB1_OUT3,ENO=>B)
• It is all right for the arguments and return values to be listed in irregular order.
• The input variables’ arguments must be at the beginning of the list, or just after the EN variable if the EN
variable is listed.
• Specification method B cannot be used together with specification method A in the same function block call
statement.
Other Statement Variations:
• Statement without EN

197
Structured Text Specifications Appendix B

Instance_FB2(FB2_IN1:=FB1_IN1,FB2_IN2:=FB1_IN2,FB2_IN3:=FB1_IN3,FB2_OUT1=>FB1_OUT1,
FB2_OUT2=>FB1_OUT2,FB2_OUT3=>FB1_OUT3,ENO=>B)
• Statement without EN and ENO
Instance_FB2(FB2_IN1:=FB1_IN1,FB2_IN2:=FB1_IN2,FB2_IN3:=FB1_IN3,FB2_OUT1=>FB1_OUT1,
FB2_OUT2=>FB1_OUT2,FB2_OUT3=>FB1_OUT3)
• Statement without ENO
Instance_FB2(EN:=A,FB2_IN1:=FB1_IN1,FB2_IN2:=FB1_IN2,FB2_IN3:=FB1_IN3,FB2_OUT1=>FB1_
OUT1,FB2_OUT2=>FB1_OUT2,FB2_OUT3=>FB1_OUT3)
• Statement without FB2_OUT2 (FB2_OUT2 data not required.)
Instance_FB2(EN:=A,FB2_IN1:=FB1_IN1,FB2_IN2:=FB1_IN2,FB2_IN3:=FB1_IN3,FB2_OUT1=>FB1_
OUT1,FB2_OUT3=>FB1_OUT3,ENO=>B)
• Statement without FB2_OUT2 (FB2_OUT2 data not required.)
Instance_FB2(EN:=A,FB2_IN1:=FB1_IN1,FB2_IN2:=FB1_IN2,FB2_IN3:=FB1_IN3,FB2_OUT1=>FB1_
OUT1,FB2_OUT3=>FB1_OUT3,ENO=>B)
• Statement with Irregular Order
Instance_FB2(EN:=A,FB2_IN1:=FB1_IN1,FB2_OUT1=>FB1_OUT1,FB2_IN2:=FB1_IN2,FB2_OUT2=>
FB1_OUT2,FB2_IN3:=FB1_IN3,FB2_OUT3=>FB1_OUT3,ENO=>B)
Example 2: Specification Method B (Specifying only the FB1 Variables)
Instance_FB2(FB1_IN1,FB1_IN2,FB1_IN3,FB1_OUT1,FB1_OUT2,FB1_OUT3)
Instance_FB2(FB1_IN1,FB1_IN2,FB1_IN3,FB1_OUT1)
• The arguments and return values must be listed in a fixed order.
Input variable 1, Input variable 2, ..., Output variable 1, Output variable 2, ...
• The input variables’ arguments must be at the beginning of the list, or just after the EN variable if the EN
variable is listed.
• An output variable can be omitted if the data is not actually being used and the output variable is not in the
middle of the list of output variables.
Example: Instance_FB2(FB1_IN1,FB1_IN2,FB1_IN3,FB1_OUT1,B1_OUT3)
In this case, the FB1_OUT3 at the end of the list would return the value from FB2_OUT2.
• The EN and ENO data cannot be entered as an argument or return value.
• Specification method A cannot be used together with specification method B in the same function block call
statement.
Example 3: Averaging Function Block
In the following example, function block 1 calls function block 2, which calculates the average value.

Program FB1 (ST) The data1, data2, and data3 values are
Instance_FB1 passed to input1, input2, and input3.

FB1 Average_FB( input1 := data1, input2 := data2,

input3 := data3, average => AVG ); FB2 (ST)
average := ( input1 + input2 + input3 ) / 3 ;
The average value is
returned in AVG.
Average_FB is an instance name with data type FUNCTION BLOCK.

Function Block 1
• Variable Table
Variable type Variable name Data type Passage to/from FB2
Input variable EN BOOL ---
Input variable data1 INT Passed to input1
Input variable data2 INT Passed to input2
Input variable data3 INT Passed to input3
Input variable bCheck BOOL ---

198
Structured Text Specifications Appendix B

Variable type Variable name Data type Passage to/from FB2

Output variable ENO BOOL ---
Output variable AVG INT Received from average
Internal variable Average_FB FUNCTION BLOCK ---
Called function block definition:
Function block 2

• ST-language Algorithm
If bCheck is true, function block 2 is called to calculate the average value. The 3 values data1, data2,
and data3 are passed to function block 2 input variables input1, input2, and input3 respectively. The
result of the calculation (average) is returned to AVG.
Note The following diagram shows the Average_FB function block called with specification method
A (both function block’s variables listed).
IF bCheck = TRUE THEN
Average(input1:=data1,input2:=data2,input3:=data3,average=>AVG);
ELSE
RETURN;
END_IF;

199
Structured Text Specifications Appendix B

Function Block 2
• Variable Table
Variable type Variable name Data type Passage to/from FB1
Input variable EN BOOL ---
Input variable input1 INT Received from data1
Input variable input2 INT Received from data2
Input variable input3 INT Received from data3
Output variable ENO BOOL ---
Output variable average INT Passed to AVG

• ST-language Algorithm
Calculates the average value of input1, input2, and input3 and stores the result in average.
average:=(input1+input2+input3)/3;

Example of Structured Text Programming

Converting an Integer to BCD and Outputting It as a Text String
FB
(BOOL) (BOOL)
EN ENO
(INT)
Input_Num
(STRING) (STRING)
Output_String−Output_String

Input Variable
INT Input_Num;
Input-Output Variable
STRING Output_String;
Internal Variable
WORD Num_BCD;

(*Check Input_BCD input parameter (BCD data)*)

IF(Input_BCDNum>=0 & Input_BCD<=16#Num<=9999) THEN
ENO:=true;
ELSE
ENO:=false;
RETURN;
END_IF;

Num_BCD:=INT_TO_BCD_WORD(Input_Num);
(*For example, if Num is 100 (16#0064), it is converted to BCD 0100*)
Output_String:=WORD_TO_STRING(Num_BCD);
(*Convert BCD 0100 to text string*)

Restrictions
Nesting
There is no restriction on the number of nests that can be used in IF, CASE, FOR, WHILE, or REPEAT state-
ments.

200
Structured Text Specifications Appendix B

Data Type Restrictions

• Integers can only be allocated to variables with data types WORD, DWORD, INT, DINT, UINT, UDINT, or
ULINT. For example, if A is an INT data type, A:=1; it possible. If the value is not an integer data type, a
syntax error will occur. For example, if A is an INT data type, a syntax error will occur for A:=2.5;.
• If a real number (floating point decimal data) can only be allocated to variables with data types REAL and
UREAL. For example, if A is a REAL data type, A:=1.5; is possible. If the value is not an real data type, a
syntax error will occur. For example, if A is a REAL data type, a syntax error will occur for A:=2;. Use
A:=2.0;.
• Bits (TRUE, FALSE) can only be allocated to variables with the BOOL data type. For example, if A is a
BOOL data type, A:=FALSE; is possible. If a BOOL data type is not used, a syntax error will occur. For
example, if A is an INT data type, a syntax error will occur for A:=FALSE;.
• Data types must all be consistent within the structured text. For example, if A, B, and C are INT data types,
A:=B+C; is possible. If, however, A and B are INT data types, but C is a REAL data type or LINT data type,
a syntax error will occur for A:=B+C;.

Structured Text Errors

Error Messages
Error Message Cause of error Example
%s' Input variables cannot be A value was substituted for an
assigned a value input variable.
%s' operator not supported by A numerical value or variable A:=B+1; (*A and B are WORD type variables*))
%s data type for a data type that is not sup-
ported by the operator was
used.
%s' variable had a read only A value was substituted for a
memory AT Address and can- variable allocated to a read-
not be assigned a value only memory address (read-
only Auxiliary Area address or
Condition Flag).
Array index out of range An array index larger than the Array[100]:=10; (*Array is an array variable with an array
array size was specified. size of 100*)
Conversion cannot convert A numeric equation in which Y:=ABS(X); (*X is an INT type variable, Y is a UINT type
from %s to %s the data type of the operation variable*)
result does not match the vari-
able at the substitution desti-
nation and a variable that is
different from the data type
was substituted.
Division by Zero The numeric expression con-
tains division by 0.
End of comment not found The comment does not have a (*comment
closing parenthesis and aster-
isk “*)” corresponding to the
opening parenthesis and
asterisk “(*” of the comment.
Invalid Literal Format '%s' The numeric format is illegal. X:=123_; (*There is no numeral after underscore*)
X:=1__23; (*The underscore is followed immediately by
another underscore*)
X:=2#301; Y:=8#90; (*A numeral that cannot be used with
binary or octal values has been used*)
Note The underscore can be inserted between numerals
to make them easier to read. Placing 2#, 8#, and
16# at the beginning of the numeral expresses the
numerals as binary, octal, and hexadecimal values,
respectively.

201
Structured Text Specifications Appendix B

Error Message Cause of error Example

Invalid Literal Value The numeric value is illegal. X:=1e2; (*an index was used for a numeric value that was
not a REAL data type*)
Note “e” indicates an exponent of 10.
Invalid array index A numeric equation with a Array[Index]:=10; (*Index is a WORD type variable*)
non-integer type operation
result or a non-integer vari-
able has been specified in the
array index.
Invalid constant A numeric equation with a CASE A OF (*A is a REAL type variable*)
non-integer type operation 1: X:=1;
result, or a non-integer vari-
able or numeric value has 2: X:=2;
been specified in the integer END_CASE;
equation of a CASE state-
ment.
Invalid expression The numeric equation is ille- WHILE DO (*The WHILE statement does not contain a
gal. For example, the integer condition equation*)
equation or condition equation X:=X+1;
is illegal or has not been spec-
ified in the syntax (IF, WHILE, END_WHILE;
REPEAT, FOR, CASE).
Invalid parameter in FOR loop A variable with data type other FOR I:=1 TO 100 DO (*I is a WORD type variable*)
declaration than INT, DINT, LINT, UINT, X:=X+1;
UDINT, or ULINT has been
used for variables in a FOR END_FOR;
statement.
Invalid statement The statement is illegal. E.g., X:=X+1; (*There is no REPEAT in the syntax*)
The statement (IF, WHILE, UNTIL X>10
REPEAT, FOR, CASE,
REPEAT) does not contain an END_REPEAT;
IF, WHILE, REPEAT, FOR,
CASE, or REPEAT in the syn-
tax, respectively.
Invalid variable for Function The specified variable for the Y:=SIN(X1, ENO=>1);
output function output is illegal (A
non-boolean (BOOL) variable
or numeral has been specified
as the ENO transfer destina-
tion.)
Missing ( The call for a data format con- Y:=INT_TO_DINT X);
version instruction or function
does not contain a “(“ (open-
ing parenthesis).
Missing ) The operator parentheses or Y:=(X1+X2/2
the call for a data format con-
version instruction or function
does not contain a “)“ (closing
parenthesis) corresponding to
“(“ (opening parenthesis).
Missing : The integer equation in the CASE A OF
CASE statement is not fol- 1 X:=1;
lowed by a “:” (colon).
END_CASE;
Missing := “:=” is not included in the
assignment equation.
Missing ; The statement is not con-
cluded by a “;” (semicolon).
Missing DO “DO” is not provided in the
FOR or WHILE statement.

202
Structured Text Specifications Appendix B

Error Message Cause of error Example

Missing END_CASE “END_CASE” is not provided
at the end of the CASE state-
ment.
Missing END_FOR “END_FOR” is not provided at
the end of the FOR statement.
Missing END_IF “END_IF” is not provided at
the end of the IF statement.
Missing END_REPEAT “END_REPEAT” is not pro-
vided at the end of the
REPEAT statement.
Missing END_WHILE “END_WHILE” is not pro-
vided at the end of the WHILE
statement.
Missing Input Parameter. All The function argument is not Y:=EXPT(X);
input variables must be set. specified or is insufficient.
Missing OF “OF” is not included in CASE
statement.
Missing THEN “THEN” is not included in IF
statement.
Missing TO “TO” is not included in FOR
statement.
Missing UNTIL “UNTIL” is not included in
REPEAT statement.
Missing [ The array index for the array X:=Array; (*Array is an array variable*)
variable has not been speci-
fied.
Missing ] The array index for the array X:=Array[2; (*Array is an array variable*)
variable has not been speci-
fied.
Missing constant A constant is not provided in CASE A OF
the integer equation of the 2..: X:=1;
CASE statement.
2,: X:=2;
END_CASE;
NOT operation not supported The NOT operator was used Result:=NOT 1;
on a literal number for a numeric value.
Negation not supported by %s A minus symbol was used Y:=-X; (*X is an UINT type variable, Y is an INT type vari-
data type before a variable with a data able*)
type that does not support
negative values (UINT,
UDINT, ULINT).
There must be one line of There is no line of valid code
valid code (excluding com- (excluding comments).
ments)
Too many variables specified Too many parameter settings Y:=SIN(X1,X2);
for Function are specified for the function.
Undefined identifier '%s' A variable that is not defined
in the variable table has been
used.
Unexpected syntax '%s' A keyword (reserved word) or FOR I:=1 TO 100 DO BY -1 (*The DO position is illegal*)
variable has been used ille- X:=X+1;
gally.
END_FOR;
Usage mismatch in Function The function parameter has Y:=SIN(X1,EN=>BOOL1); (*The input parameter EN has
variable been used illegally. been used as an output parameter*)

203
Structured Text Specifications Appendix B

Error Message Cause of error Example

Value out of range A value outside the range for X:=32768; (*X is an INT type variable*)
the variable data type has
been substituted in the vari-
able.
Variable '%s' is not a Function A variable that cannot be Y:=SIN(Z:=X); (*X and Y are REAL type variables, and Z
parameter specified in the function is not a SIN function parameter *)
parameter has been specified
in the parameter.

Warning Messages
Warning message Cause of warning Example
Keyword '%s' is redundant The keyword has been used
in an invalid location. For
example, use of the EXIT
statement outside a loop syn-
tax.
Conversion from '%s' to '%s', Data may be lost due to con- Y:=DINT_TO_INT(X); (*X is a DINT type variable, Y is an
possible loss of data version of a data type with a INT type variable*)
large data size to a data type
with a small data size.

Commonly Asked Questions

Q: How is a hexadecimal value expressed?
A: Add “16#” before the value, e.g., 16#123F.
The prefixes 8# and 2# can also be added to express octal numbers and binary numbers, respectively. Num-
bers without these prefixes will be interpreted as decimal numbers.
Q: How many times can FOR be used?
A: In the following example, the contents of the FOR statement is executed 101 times. The loop processing
ends when the value of “i” is equal to 101.
FOR i:=0 TO 100 BY 1 DO
a:=a+1;
END_FOR;
Q: What occurs when the array subscript is exceeded?
A: For the array variable INT[10] with 10 elements, an error will not be detected for the following type of state-
ment. Operation will be unstable when this statement is executed.
i:=15;
INT[i]:=10;
Q: Are the variables in the structured text editor automatically registered in the variable tables?
A: No. Register the variables in the variable table before using them.
Q: Can ladder programming instructions be called directly?
A: No.

204
 Appendix C
External Variables

Classification Name External variable in Data type Address

CX-Programmer
Conditions Flags Greater Than or Equals (GE) Flag P_GE BOOL CF00
Not Equals (NE) Flag P_NE BOOL CF001
Less Than or Equals (LE) Flag P_LE BOOL CF002
Instruction Execution Error (ER) Flag P_ER BOOL CF003
Carry (CY) Flag P_CY BOOL CF004
Greater Than (GT) Flag P_GT BOOL CF005
Equals (EQ) Flag P_EQ BOOL CF006
Less Than (LT) Flag P_LT BOOL CF007
Negative (N) Flag P_N BOOL CF008
Overflow (OF) Flag P_OF BOOL CF009
Underflow (UF) Flag P_UF BOOL CF010
Access Error Flag P_AER BOOL CF011
Always OFF Flag P_Off BOOL CF114
Always ON Flag P_On BOOL CF113
Clock Pulses 0.02 second clock pulse bit P_0_02s BOOL CF103
0.1 second clock pulse bit P_0_1s BOOL CF100
0.2 second clock pulse bit P_0_2s BOOL CF101
1 minute clock pulse bit P_1mim BOOL CF104
1.0 second clock pulse bit P_1s BOOL CF102
Auxiliary Area Flags/ First Cycle Flag P_First_Cycle BOOL A200.11
Bits Step Flag P_Step BOOL A200.12
First Task Execution Flag P_First_Cycle_Task BOOL A200.15
Maximum Cycle Time P_Max_Cycle_Time UDINT A262
Present Scan Time P_Cycle_Time_Value UDINT A264
Cycle Time Error Flag P_Cycle_Time_Error BOOL A401.08
Low Battery Flag P_Low_Battery BOOL A402.04
I/O VerIFication Error Flag P_IO_Verify_Error BOOL A402.09
Output OFF Bit P_Output_Off_Bit BOOL A500.15
OMRON FB Library CIO Area specification P_CIO WORD A450
words (see note) HR Area specification P_HR WORD A452
WR Area specification P_WR WORD A451
DM Area specification P_DM WORD A460
EM0 to C Area specification P_EM0 to P_EMC WORD A461 to
A473

Note These words are external variables for the OMRON FB Library. Do not use these words for creating
function blocks.

205
External Variables Appendix C

206
 Appendix D
Function Descriptions

Standard Functions
Text String Functions
LEN: Detect String Length
• Function
Finds the length of a specified text string.
• Application
Return_value := LEN(string);
• Arguments and Return Values
Variable name Data type Description
String STRING Specifies the text string for
which to find the length.
Return_value INT Returns the size of the speci-
fied text string.

• Example
Variables
STRING Message Message A B C D E F G H
INT Result

Result:=LEN(Message);
→ "8" is stored in Result variable.

LEFT: Extract Characters from Left

• Function
Extracts the specified number of characters from the left of the specified text string.
• Application
Return_value := LEFT(Source_string, Number_of_characters);
• Arguments and Return Values
Variable name Data type Description
Source_string STRING Specifies the text string from which to
extract characters.
Number_of_characters INT, UINT Specifies the number of characters to
extract.
Return_value STRING Returns the extracted characters.

• Example
Variables
Message A B C D E F G H
STRING Message
STRING Result
Result:=LEFT(Message,3);
→ "ABC" is stored in the Result variable.

RIGHT: Extract Characters from Right

• Function
Extracts the specified number of characters from the right of the specified text string.
• Application
Return_value := RIGHT(Source_string, Number_of_characters);

207
Function Descriptions Appendix D

• Arguments and Return Values

Variable name Data type Description
Source_string STRING Specifies the text string from
which to extract characters.
Number_of_characters INT, UINT Specifies the number of char-
acters to extract.
Return_value STRING Returns the extracted charac-
ters.

• Example
Variables
STRING Message Message A B C D E F G H
STRING Result
Result:=RIGHT(Message,3);
→ "FGH" is stored in the Result variable.

MID: Extract Characters from Middle

• Function
Extracts the specified number of characters starting from the specified position of the specified text
string.
• Application
Return_value := MID (Source_string, Number_of_characters, Position);
• Arguments and Return Values
Variable name Data type Description
Source_string STRING Specifies the text string from which to
extract characters.
Number_of_characters INT, UINT Specifies the number of characters to
extract.
Position INT, UINT Specifies the position from which to start
extracting characters. The first character is
position “1” (e.g., position 1 is “A” in mes-
sage 1 in the following illustration).
Return_value STRING Returns the extracted characters.

• Example
Variables Message A B C D E F G H
STRING Message
STRING Result
Result:=MID(Message,3,2);
→ "BCD" is stored in the Result variable.

CONCAT: Concatenate Strings

• Function
Joins the specified text strings.
Up to 31 text strings can be specified.
• Application
Return_value := CONCAT(Source_string_1, Source_string_2, …);
• Arguments and Return Values
Variable name Data type Description
Source_string_1 STRING Specifies a text string to be joined.
Source_string_2 STRING Specifies a text string to be joined.
:
Return_value STRING Returns the joined text strings.

208
Function Descriptions Appendix D

• Example

Variables
Message 1 A B C Message 2 D E Message 3 F G H
STRING Message1
STRING Message2
Result:=CONCAT(Message1,Message2,Message3);
STRING Message3
→ "ABCDEFGH" is stored in the Result variable.
STRING Result
Result A B C D E F G H

INSERT: Insert Characters

• Function
Inserts the specified characters into a text string.
• Application
Return_value := INSERT(Source_string, Insert_string, Position);
• Arguments and Return Values
Variable name Data type Description
Source_string STRING Specifies the text string into which to insert char-
acters.
Insert_string STRING Specifies the text string to be inserted.
Position INT, UINT Specifies the position at which to insert charac-
ters. The first character is position “1” (e.g., posi-
tion 1 is “A” in message 1 in the following
illustration).
Return_value STRING Returns the text string with the characters
inserted.

• Example
Variables Message 1 A B C D Message 2 E F G H
STRING Message1
STRING Message2
STRING Result Result := INSERT(Message1, Message2, 2);
→ "ABEFGHC" is stored in the Result variable.
Result A B E F G H C D

DELETE: Delete Characters

• Function
Deletes the specified number of characters starting from the specified position of the specified text
string.
• Application
Return_value := DEL (Source_string, Number_of_characters, Position);
• Arguments and Return Values
Variable name Data type Description
Source_string STRING Specifies the text string from which to delete
characters.
Number_of_characters INT, UINT Specifies the number of characters to delete.
Position INT, UINT Specifies the position from which to delete
characters. The first character is position “1”
(e.g., position 1 is “A” in message 1 in the fol-
lowing illustration).
Return_value STRING Returns the text string with the specified
number of characters deleted.

209
Function Descriptions Appendix D

• Example
Variables Message
A B C D E F G H
STRING Message1
STRING Result
Result:=DEL(Message1,4,2);
→ "AFGH" is stored in the Result variable.
Result
A F G H

REPLACE: Replace Characters

• Function
Replaces the specified number of characters starting from the specified position of the specified text
string.
• Application
Return_value := REPLACE(Source_string, Replace_string, Number_of_characters, Position);
• Arguments and Return Values
Variable name Data type Description
Source_string STRING Specifies the text string in which to replace
characters.
Replace_string STRING Specifies the replace text string.
Number_of_characters INT, UINT Specifies the number of characters to be
replaced.
Position INT, UINT Specifies the position from which to
replace characters. The first character is
position “1” (e.g., position 1 is “A” in mes-
sage 1 in the following illustration).
Return_value STRING Returns the text string with the characters
replaced.

• Example
Message 1 Message 2
Variables A B C D E F G H X Y Z
STRING Message1
STRING Message2 Result:=REPLACE(Message1,Message2,2,3);
STRING Result → "ABXYEFGH" is stored in the Result variable.

Result A B E F G H
X Y

FIND: Find Characters

• Function
Finds the first occurrence of the specified text string in another text string and returns the position.
If the text string is not found, 0 is returned.
• Application
Return_value := FIND(Source_string, Find_string);
• Arguments and Return Values
Variable name Data type Description
Source_string STRING Specifies the text string to search.
Find_string STRING Specifies the text string to find.
Return_value INT Returns the position of the first occurrence of
the find text string. The first character is position
“1” (e.g., position 1 is “A” in message 1 in the fol-
lowing illustration).

210
Function Descriptions Appendix D

• Example
Message 1 Message 2
Variables A B C D E C D E C D E
STRING Message1
STRING Message2
INT Result Result:=FIND(Message1,Message3);
→ "2" is stored in the Result variable.

Memory Card Functions

WRITE_TEXT: Create Text File
• Function
Writes the specified text sting into the specified file in the Memory Card.
• Application
Write_Text (Write_string, Directory_name_and_file_name, Delimiter, Parameter);
• Arguments and Return Values
Variable name Data type Description
Write_string STRING Specifies the text string to write to a file.
Directory_name_and STRING Specifies the directory and file name, including the root direc-
_file_name tory(\). The file name must be 8 characters or less. The file
name extension is always TXT. For example, the following file
name creates a file named LINE_A.TXT in the root directory:
\LINE_A.
Delimiter STRING '': Empty character
',': Comma
“$L” or “$l”: Line feed (ASCII 0A)
“$N” or “$n”: Carriage return + line feed (ASCII 0D 0A)
“$P” or “$p”: New page (ASCII 0C)
“$R” or “$r”: Carriage return (ASCII 0D)
“$T” or “$t”: Tab (ASCII 09)
Parameter INT, UINT, WORD 0: Append
1: Create new file

211
Function Descriptions Appendix D

• Example
Variables
BOOL P_MemCardBusyFlag (* File Memory Operation Flag *) AT A343.13
BOOL P_MemCardAskFlag (* Memory Card Detected Flag *) AT A343.15
STRING FileName (* File name *)
INT LogData1 2 3 (* Log number *)
STRING FiledStrl1 2 3 (* Log number text string *)
STRING CsvLineStr (* CSV-format log, 1-line text string *)

FileName := '\LOGFILE';
LogData1 := 12;
LogData2 := 345;
LogData3 := 6789;
Contents of output file
(* Output data to text file if Memory Card write conditions are met. *)
IF ( P_MemCardAckFlag AND (NOT P_MemCardBusyFlag) ) THEN
LOGFILE.TXT
(* Convert from number to text string *)
FieldStr1 := INT_TO_STRING( LogData1 ); 12,345,6789
FieldStr2 := INT_TO_STRING( LogData2 );
FieldStr3 := INT_TO_STRING( LogData3 );
(* Create 1-row CSV-format numeric value text string *)
CsvLineStr := FieldStr1 + ',' + FieldStr2 + ',' + FieldStr3;
(* Output one line of numeric data to file *)
WRITE_TEXT( CsvLineStr, FileName, '$n', 0 );
END_IF;

Related Auxiliary Address Description

Area Flag
File Memory Opera- A343.13 ON when any of the following conditions exists:
tion Flag • CMND instruction sending a FINS command to the local
CPU Unit.
• File Memory Instruction being executed.
• Program replacement using the control bit in the Auxiliary
Area.
• Easy backup operation.
Memory Card A343.15 ON when a Memory Card has been detected.
Detected Flag

For further information and precautions on related Auxiliary Area flags, refer to the section on the FWRIT File
Memory Instruction in the CS/CJ-series Instruction Reference Manual.

Communications Functions
TXD_CPU: Send String via CPU Unit RS-232C Port
• Function
Sends a text string from the RS-232C port on the CPU Unit.
• Application
TXD_CPU (Send_string);
• Conditions
The serial communications mode of the RS-232C port must be set to no-protocol communications.
• Arguments and Return Values
Variable name Data type Description
Send_string STRING Specifies the text string to send.

212
Function Descriptions Appendix D

• Example
(SCB) CPU Unit

Get Scene Number

command: @READ

Barcode Reader

Variables
BOOL DoSendData (* Variable to control send function *)
INT iProcess (* Process number *)
STRING Message (* Send message *)
BOOL EnableCPUPort (* Send Ready Flag *) AT A392.05

(* Send data when DoSendData is ON and iProcess is 0 *)

IF (DoSendData = TRUE) AND (iProcess = 0) THEN
iProcess := 1;
DoSendData := FALSE;
END_IF;
(* Execute send processing according to process number *)
CASE iProcess OF
1: (* Create send text data *)
Message := '@READ';
iProcess := 2;
2: (* Execute send function if sending is enabled *)
IF SendEnableCPUPort = TRUE THEN
TXD_CPU(Message);
iProcess := 3;
END_IF;
3: (* Sending is finished if Send Ready Flag is ON *)
IF SendEnableCPUPort = TRUE THEN
iProcess := 0;
END_IF;
END_CASE;

Related Auxiliary Address Description

Area Flag
RS-232C Port Send A392.05 ON when sending is enabled in no-protocol mode.
Ready Flag

For further information and precautions on related Auxiliary Area flags, refer to the section on TXD Serial Com-
munications Instruction in the CS/CJ-series Instruction Reference Manual.
TXD_SCB: Send String via Serial Port on Serial Communications Board
• Function
Sends a text string from a serial port on a Serial Communications Board (SCB).
• Application
TXD_SCB (Send_string, Serial_port);
• Conditions
The serial communications mode of the serial port must be set to no-protocol communications.

213
Function Descriptions Appendix D

• Arguments and Return Values

Variable name Data type Description
Send_string STRING Specifies the text string to send.
Serial_port INT, UINT, WORD Specifies the number of the serial port.
1: Serial port 1
2: Serial port 2

• Example
Serial
Communi-
cations
Board
(SCB) CPU Unit

Get Scene Number

command: @READ

Barcode Reader

Variables
BOOL DoSendData (* Variable to control send function *)
INT iProcess (* Process number *)
STRING Message (* Send message *)
BOOL EnableSCBPort (* Send Ready Flag *) AT A365.05

(* Use serial port number 1 *)

(*Send data when DoSendData is ON and iProcess is 0 *)

IF (DoSendData = TRUE) AND (iProcess = 0) THEN
iProcess := 1;
DoSendData := FALSE;
END_IF;

(* Execute send processing according to process number *)

CASE iProcess OF
1: (* Create send text data *)
Message := '@READ';
iProcess := 2;
2: (* Execute send function if sending is enabled *)
IF EnableSCBPort = TRUE THEN
TXD_SCB(Message, 1);
iProcess := 3;
END_IF;
3: (* Sending is finished if Send Ready Flag is ON *)
IF EnableSCBPort = TRUE THEN
iProcess := 0;
END_IF;
END_CASE;

Related Auxiliary Address Description

Area Flag
Port 1 Send Ready A356.05 ON when sending is enabled in no-protocol mode.
Flag
Port 2 Send Ready A356.13 ON when sending is enabled in no-protocol mode.
Flag

For further information and precautions on related Auxiliary Area flags, refer to the section on TXD Serial Com-
munications Instruction in the CS/CJ-series Instruction Reference Manual.

214
Function Descriptions Appendix D

TXD_SCU: Send String via Serial Port on Serial Communications Unit

• Function
Sends a text string from a serial port on a Serial Communications Unit (SCU).
• Application
TXD_SCU (Send_string, SCU_unit_number, Serial_port, Internal_logic_port);
• Conditions
The serial communications mode of the serial port must be set to no-protocol communications.
• Arguments and Return Values
Variable name Data type Description
Send_string STRING Specifies the text string to send.
SCU_unit_number INT, UINT, WORD Specifies the number of the Serial Communi-
cations Unit.
Serial_port INT, UINT, WORD 1: Serial port 1
2: Serial port 2
Internal_logic_port INT, UINT, WORD 0 to 7: Internal logic port number
16#F: Automatic logic port allocation

215
Function Descriptions Appendix D

• Example
Serial
Communications
CPU Unit Unit (SCU)

Get Scene Number

Command: @READ

Barcode reader

Variables
BOOL DoSendData (* Variable to control send function *)
INT iProcess (* Process number *)
STRING Message (* Send message *)
WORD SCU_Status[ ] (* Serial Communications Unit's TXDU Execution Flag *) AT 1544.05
BOOL EnableCommunication[ ] (* Communications Port Enable Flag*) AT A202.07 Use port 7

(* Use the following: Unit number: 0, Serial port number: 2, Logical port number: 7 *)

(* Send data when DoSendData is ON and iProcess is 0 *)

IF (DoSendData = TRUE) AND (iProcess = 0) THEN
iProcess := 1;
DoSendData := FALSE;
END_IF;

(* Execute send processing according to process number *)

CASE iProcess OF
1: (* Create send text data *)
Message := '@READ';
iProcess := 2;
2: (* Execute send function if Communications Port Enable Flag and TXDU Execution Flag are ON *)
IF (P_ComEnable = TRUE) AND (P_SCU_Exe = FALSE) THEN
TXD_SCU(Message, 1, 2, 7);
iProcess := 3;
END_IF;
3: (* Sending has been completed if Communications Port Enable Flag is ON *)
IF P_ComEnable = TRUE THEN
iProcess := 0;
END_IF;
END_CASE;

Related Auxiliary Address

Area Flag
Communications A202.00 to A202.07 ON when network communications can be executed. The bit
Instruction Enable numbers correspond directly to the internal logic port numbers
Flags Bits 00 to 07: Internal logic ports 0 to 7

Related CPU Bus Bit

Unit Area bits
n = CIO 150 + 25 x 05 ON when TXDU is being executed.
unit number
Port 1: n+9
Port 2: n+19

For further information and precautions on related Auxiliary Area flags, refer to the section on TXDU Serial
Communications Instruction in the CS/CJ-series Instruction Reference Manual.

216
Function Descriptions Appendix D

RXD_CPU: Receive String via CPU Unit RS-232C Port

• Function
Receives a text string from the RS-232C port on the CPU Unit.
• Application
RXD_CPU (Storage_location, Number_of_characters)
• Conditions
The serial communications mode of the RS-232C port must be set to no-protocol communications.
• Arguments and Return Values
Variable name Data type Description
Storage_location STRING Specifies the storage location for the received
text string.
Number_of_characters INT, UINT, WORD Specifies the number of characters to receive.
0 to 255

• Example
CPU Unit

Message → Value to read

Barcode reader

Variables
BOOL DoRecvData (* Variable to control receive function *)
STRING Message (* Variable to store received message *)
BOOL EndRecvCPUPort (* Reception Completed Flag *) AT A392.06

IF DoRecvData = TRUE THEN (* Receive data when DoRecvData is ON *)

(* Execute receive function if reception has been completed *)
IF EndRecvCPUPort = TRUE THEN
RXD_CPU(Message, 16); (* Get 16 characters *)
DoRecvData = FALSE;
END_IF;
END_IF;

Related Auxiliary Address Description

Area Flag
RS-232C Port A392.06 ON when reception has been completed in no-protocol mode.
Reception Com-
pleted Flag
RS-232C Port A392.07 ON when a data overflow occurred during reception in no-pro-
Reception Overflow tocol mode.
Flag
RS-232C Port A393 Contains the number of characters received in no-protocol
Reception Counter mode.

For further information and precautions on related Auxiliary Area flags, refer to the section on RXD Serial Com-
munications Instruction in the CS/CJ-series Instruction Reference Manual.
RXD_SCB: Receive String via Serial Port on Serial Communications Board
• Function

217
Function Descriptions Appendix D

Receives a text string from a serial port on a Serial Communications Board (SCB).
• Application
RXD_SCB (Storage_location, Number_of_characters, Serial_port)
• Conditions
The serial communications mode of the serial port must be set to no-protocol communications.
• Arguments and Return Values
Variable name Data type Description
Storage_location STRING Specifies the storage location for the received
text string.
Number_of_characters INT, UINT, WORD Specifies the number of characters to receive.
0 to 255
Serial_port INT, UINT, WORD Specifies the number of the serial port.
1: Serial port 1
2: Serial port 2

• Example
Commu-
nications
Board
(SCB) CPU Unit

Message → Value to read

Barcode reader

Variables
BOOL DoRecvData (* Variable to control receive function *)
STRING Message (* Variable to store received message *)
BOOL EndRecvSCBPort (* Reception Completed Flag *) AT A356.06

(* Use serial port number 1 *)

IF DoRecvData = TRUE THEN (* Receive data when DoRecvData is ON *)
(* Execute receive function if reception has been completed *)
IF EndRecvSCBPort = TRUE THEN
RXD_SCB(Message, 16, 1); (* Get 16 characters *)
DoRecvData := FALSE;
END_IF;
END_IF;

Related Auxiliary Address Description

Area Flag
Port 1 Reception A356.06 ON when reception has been completed in no-protocol mode.
Completed Flag
Port 1 Reception A356.07 ON when a data overflow occurred during reception in no-pro-
Overflow Flag tocol mode.
Port 1 Reception A357 Contains the number of characters received in no-protocol
Counter mode.
Port 2 Reception A356.14 ON when reception has been completed in no-protocol mode.
Completed Flag

218
Function Descriptions Appendix D

Related Auxiliary Address Description

Area Flag
Port 2 Reception A356.15 ON when a data overflow occurred during reception in no-pro-
Overflow Flag tocol mode.
Port 2 Reception A358 Contains the number of characters received in no-protocol
Counter mode.

For further information and precautions on related Auxiliary Area flags, refer to the section on RXD Serial Com-
munications Instruction in the CS/CJ-series Instruction Reference Manual.
RXD_SCU: Receive String via Serial Port on Serial Communications Unit
• Function
Receives a text string from a serial port on a Serial Communications Unit (SCU).
• Application
RXD_SCU (Storage_location, Number_of_characters, SCU_unit_number, Serial_port,
Internal_logic_port);
• Conditions
The serial communications mode of the serial port must be set to no-protocol communications.
• Arguments and Return Values
Variable name Data type Description
Storage_location STRING Specifies the storage location for the received text
string.
Number_of_characters INT, UINT, WORD Specifies the number of characters to receive.
0 to 255
SCU_unit_number INT, UINT, WORD Specifies the number of the Serial Communica-
tions Unit.
Serial_port INT, UINT, WORD 1: Serial port 1
2: Serial port 2
Internal_logic_port INT, UINT, WORD 0 to 7: Internal logic port number
16#F: Automatic logic port allocation

219
Function Descriptions Appendix D

• Example
Serial
Communi-
cations
CPU Unit Unit (SCU)

Message → Value to read

Barcode reader

Variables
BOOL DoRecvData (* Variable to control receive function *)
INT iProcess (* Process number *)
STRING Message (* Variable to store received message *)
WORD SCU_Status[ ] (* Status of Serial Communications Unit *) AT 1544.06
BOOL EnableCommunication[ ] (* Communications Port Enable Flag *)*) AT A202.07 Use port 7

(* Use the following: Unit number: 0, Serial port number: 2, Logical port number: 7 *)

(* Send data when DoRecvData is ON and iProcess is 0 *)

IF (DoRecvData = TRUE) AND (iProcess = 0) THEN
iProcess := 1;
DoRecvData := FALSE;
END_IF;

(* Execute receive processing according to process number *)

CASE iProcess OF
1: (* Serial Communications Unit Reception Completed Flag: CIO 1500+ 25 x unit No. + 9 *);
IF (P_ComEnable = TRUE) AND (SCU_Recv = TRUE) THEN
RXD_SCU(Message, 16, 1, 2, 7);
iProcess := 2;
END_IF;
2: (* Reception has been completed if Communications Port Enable Flag is ON *)
IF P_ComEnable = TRUE THEN
iProcess := 0;
END_IF;
END_CASE;

Related Auxiliary Area Flag Address

Communications Instruction A202.00 to ON when network communications can be executed. The bit
Enable Flag A202.07 numbers correspond directly to the internal logic port numbers
Bits 00 to 07: Internal logic ports 0 to 7

Related CPU Bus Unit Area bits Bit

n = CIO 150 + 25 x unit number 06 ON when reception has been completed in no-protocol mode.
Port 1: n+9
Port 2: n+19
n = CIO 150 + 25 x unit number 07 ON when a data overflow occurred during reception in no-pro-
Port 1: n+9 tocol mode.
Port 2: n+19
n = CIO 150 + 25 x unit number --- Contains the number of characters received in no-protocol
Port 1: n+10 mode.
Port 2: n+20

For further information and precautions on related Auxiliary Area flags, refer to the section on RXDU Serial
Communications Instruction in the CS/CJ-series Instruction Reference Manual.

220
Function Descriptions Appendix D

Angle Conversion Functions

DEG_TO_RAD: Convert Degrees to Radians
• Function
Converts an angle in degrees to radians.
• Application
Return_value := DEG_TO_RAD (argument)
• Arguments and Return Values
Variable name Data type Description
Argument REAL, LREAL Specifies an angle in degrees.
Return_value REAL, LREAL Returns an angle in radians.

RAD_TO_DEG: Convert Radians to Degrees

• Function
Converts an angle in radians to degrees.
• Application
Return_value := RAD_TO_DEG (argument)
• Arguments and Return Values
Variable name Data type Description
Argument REAL, LREAL Specifies an angle in radians.
Return_value REAL, LREAL Returns an angle in degrees.

221
Function Descriptions Appendix D

222
 Index

saving to files, 157

A function blocks
addresses advantages, 9
allocation areas, 38 application guidelines, 51
checking internal allocations, 149 creating, 20, 125
setting allocation areas, 148 debugging, 158
algorithm defining, 131
creating, 133 elements, 27
applications errors, 50
precautions, xix monitoring, 158
array settings, 17, 35, 54, 135 operating specifications, 44
outline, 8
AT settings, 17, 35, 135
restrictions, 46
restrictions, 46
reusing, 21
automatically generating function block definitions, 138
setting parameters, 145
specifications, 4, 27
structure, 10
C functions, 2
compiling, 152 function blocks, 4
computer system requirements, 3 restrictions, 3

D G
data types, 16, 34, 173 global symbol table, 15
determining, 51
debugging function blocks, 158
differentiation
I
restrictions, 47 IEC 61131-3, 2, 5
input variables, 29
input-output variables, 32
E inputs, 16
errors instance areas, 18, 38
function blocks, 50 setting, 18, 148
external variables, 33 instances
list, 205, 207 creating, 20, 143
externals, 16 multiple, 42
number of, 11
outline, 11
F registering in global symbol table, 15
specifications, 38
features, 2
internal variables, 32
files
function block definitions, 157 internals, 16
library, 5
project text files, 5
function block definitions, 10
L
checking for an instance, 151 ladder programming
compiling, 152 function block definition, 130
creating, 128 restrictions in function blocks, 46

223
 Index

M V
menus, 5 variable names, 16
main, 5 variables
popup, 7 address allocations, 18
monitoring function blocks, 158 checking address allocations, 149
creating as needed, 134
definitions, 28
O introduction, 15
properties, 16, 34
online editing
registering in advance, 131
function block definitions, 165
restrictions, 46
restrictions, 49
setting allocation areas, 18
output variables, 30 usage, 16, 29
outputs, 16

P
parameters
outline, 12
precautions, xvii
applications, xix
general, xviii
safety, xviii
Programming Consoles, 49
projects
creating, 128

S
safety precautions, xviii
specifications, 25
CX-Programmer Ver. 5.0, 3
function block operation, 44
instances, 38
structured text
function block definition, 130
restrictions, 48
symbol name
automatically generating, 137

T
timer instructions
operation, 122
restrictions, 48

224
 Revision History

A manual revision code appears as a suffix to the catalog number on the front cover of the manual.

Cat. No. W447-E1-03

Revision code

The following table outlines the changes made to the manual during each revision. Page numbers refer to the
previous version.
Revision code Date Revised content
01 February 2005 Original production
02 November 2005 Added Ver. 6.1 upgrade information, such as information on the Simulation functions
and ST program variable monitoring.
03 July 2006 Added Ver. 7.0 upgrade information.

225
 Revision History

226
OMRON Corporation
Control Devices Division H.Q.
Shiokoji Horikawa, Shimogyo-ku,
Kyoto, 600-8530 Japan
Tel: (81)75-344-7109/Fax: (81)75-344-7149
Regional Headquarters
OMRON EUROPE B.V.
Wegalaan 67-69, NL-2132 JD Hoofddorp
The Netherlands
Tel: (31)2356-81-300/Fax: (31)2356-81-388
OMRON ELECTRONICS LLC
1 East Commerce Drive, Schaumburg, IL 60173
U.S.A.
Tel: (1)847-843-7900/Fax: (1)847-843-8568
OMRON ASIA PACIFIC PTE. LTD.
83 Clemenceau Avenue,
#11-01, UE Square,
Singapore 239920
Tel: (65)6835-3011/Fax: (65)6835-2711
OMRON (CHINA) CO., LTD.
Room 2211, Bank of China Tower,
200 Yin Cheng Zhong Road,
PuDong New Area, Shanghai, 200120 China
Tel: (86)21-5037-2222/Fax: (86)21-5037-2200