SYSMAC
WS02-CXPC1-E-V50
CS1-H, CJ1-H, CJ1M CPU Units
Cat.No. W438-E1-01
CX-Programmer
Ver. 5.0
WS02-CXPC1-E-V50
CS1-H, CJ1-H, CJ1M CPU Units
Operation Manual
Function Blocks
Produced July 2004
iv
Notice:
r
f
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 damage to property.
!DANGERIndicates an imminently hazardous situation which, if not avoided, will result in death or
serious injury.
!WARNINGIndicates a potentially hazardous situation which, if not avoided, could result in death or
serious injury.
!CautionIndicates 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 Programming 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.
OMRON, 2004
All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form, o
by any means, mechanical, electronic, photocopying, recording, or otherwise, without the prior written permission o
OMRON.
No patent liability is assumed with respect to the use of the information contained herein. Moreover, because OMRON is constantly 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.
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.
This manual describes the function blocks and related functionality of the CX-Programmer Ver. 5.0
used together with 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. 5.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. 5.0 function block functions have been enhanced. This manual describes
only CX-Programmer Ver. 5.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, and CJ1M CPU
Units. For other information, refer to the CS/CJ-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. 5.0 or the CS1-H, CJ1-H, or
CJ1M CPU Units. Be sure to read the precautions provided in the following section.
Manuals Related to the CX-Programmer Ver. 5.0
NameCat. No.Contents
SYSMAC WS02-CXPC1-E-V50
CX-Programmer Ver. 5.0 Operation Manual
Function Blocks
W438Describes the functionality unique to the CX-Programmer Ver.
5.0 and CS/CJ-series CPU Units with unit version 3.0 or later
based on function blocks. Functionality that is the same as
that of the CX-Programmer is described in W437 (enclosed).
W437Provides information on how to use the CX-Programmer for
all functionality except for function blocks.
Manuals Related to the CS1-H, CJ1-H, CJ1M CPU Units
NameCat. No.Contents
SYSMAC CS Series
CS1G/H-CPU@@-EV1, CS1G/H-CPU@@H
Programmable Controllers
Operation Manual
SYSMAC CJ Series
CJ1G-CPU@@, CJ1G/H-CPU@@H, CJ1GCPU@@P, C J 1 M - C P U @@
Programmable Controllers
Operation Manual
W339Provides an outline of and describes the design, installation,
maintenance, and other basic operations for the CS-series
PLCs.
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.
W393Provides an outline of and describes the design, installation,
maintenance, and other basic operations for the CJ-series
PLCs.
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
NameCat. No.Contents
SYSMAC CS/CJ Series
CS1G/H-CPU@@-EV1, CS1G/H-CPU@@H,
CJ1G-CPU@@, CJ1G/H-CPU@@H, CJ1GCPU@@P, C J 1 M - C P U @@
Programmable Controllers
Programming Manual
SYSMAC CS/CJ Series
CS1G/H-CPU@@-EV1, CS1G/H-CPU@@H,
CJ1G-CPU@@, CJ1G/H-CPU@@H, CJ1GCPU@@P, C J 1 M - C P U @@
Programmable Controllers
Instructions Reference Manual
SYSMAC CS/CJ Series
CS1G/H-CPU@@-EV1, CS1G/H-CPU@@H,
CS1W-SCB21-V1/41-V1, CS1W-SCU21/41,
CJ1G-CPU@@, CJ1G/H-CPU@@H, CJ1GCPU@@P, C J 1 M - C P U @@, CJ1W-SCU21-V1/
41-V1
Communications Commands
Reference Manual
W394Describes programming and other methods to use the func-
tions of the CS/CJ-series PLCs.
The following information is included:
Programming
Ta sk s
File memory
Other functions
Use this manual together with the W339 or W393.
W340Describes the ladder diagram programming instructions sup-
ported by CS/CJ-series PLCs.
When programming, use this manual together with the Oper-
ation Manual (CS1: W339 or CJ1: W393) and Programming
Manual (W394).
W342Describes the communications commands that can be
addressed to CS/CJ-series CPU Units.
The following information is included:
C-series (Host Link) commands
FINS commands
Note: This manual describes commands that can be sent to
the CPU Unit without regard for the communications path,
which can be through a serial communications port on the
CPU Unit, a communications port on a Serial Communications Unit/Board, or a port on any other Communications
Unit.
Overview of Contents
Precautions provides general precautions for using the CX-Programmer Ver. 5.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.
x
PRECAUTIONS
This section provides general precautions for using the CX-Programmer Ver. 5.0 and the Programmable Logic Controller.
The information contained in this section is important for the safe and reliable application of the CX-Programmer
Ver. 5.0 and Programmable Controller. You must read this section and understand the information contained before
attempting to set up or operate the CX-Programmer Ver. 5.0 and Programmable Controller.
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.
2General Precautions
The user must operate the product according to the performance specifications 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, amusement machines, safety equipment, and other systems, machines, and equipment 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 applications.
3Safety Precautions
!WARNING Confirm safety sufficiently before transferring I/O memory area status from the
CX-Programmer Ver. 5.0 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.
xii
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
Application Precautions4
• 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 elements 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-Programmer Ver. 5.0 will output an error when compiling.
• If the other operand specifying a size is a variable, the CX-Programmer
Ver. 5.0 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
(variable). A warning message, however, will be displayed. In particular, if the number of array elements is less than the size specified by
the other operand (e.g., the size of the instruction operand is 16, and
the number 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 executed for the 6 words following those for the number of elements
registered in the actual variable table. If these words are used for other
instructions (including internal variable allocations), unexpected operation 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 performed by pressing short-cut keys, the devices connected to Output Units
may malfunction, regardless of the operating mode of the CPU Unit.
4Application 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. Particularly exit any software such as screen savers, virus checkers, E-mail
or other communications software, and schedulers or other applications that start up periodically or automatically.
• Disable sharing hard disks, printers, or other devices with other computers on any network.
xiii
Application Precautions4
• With some notebook computers, the RS-232C port is allocated to a
modem or an infrared line by default. Following the instructions in documentation 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 computer utilities and the BIOS. Following the instructions in documentation for your computer, disable all energy saving settings.
• Do not turn OFF the power supply to the PLC or disconnect the connecting 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 operation.
• When online editing is performed, the user program and parameter area
data in CS1-H, CJ1-H, and CJ1M 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-Programmer 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 the address itself cannot
be passed as an input variable. (Even if an address is set as an input
parameter, the value passed to the function block will be that for the size
of data in the input variable.) Therefore, an input variable cannot be used
as the operand of the instruction in the function block when the operand
specifies the first or last of multiple words. Use an internal variable with an
AT setting. Alternatively, specify the first or last element in an internal
array variable.
xiv
Application Precautions4
• Values are passed in a batch from the input parameters to the input 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 when an instruction in the function block
algorithm is executed, use an internal variable or external variable instead
of an input 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 variables 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 preregistered 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 remote 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 specified by an instruction operand and the operand cannot be specified as
an internal array variable (e.g., the number of array elements cannot
be specified).
xv
Application Precautions4
xvi
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.
The CX-Programmer Ver. 5.0 is a Programming Device that can use standard
IEC 61131-3 function blocks. The CX-Programmer Ver. 5.0 function block
function is supported for 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 function blocks.
• Function block algorithms can be written in the ladder programming language or in the structured text (ST) language. (See note.)
• When ladder programming is used, ladder programs created with nonCX-Programmer Ver. 4.0 or earlier can be reused by copying and pasting.
• When ST language is used, it is easy to program mathematical processes 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 conforms 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 easier for many applications.
NoteThe IEC 61131 standard was defined by the International Electrotechnical
Commission (IEC) as an international programmable logic 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).
2
Introducing the Function BlocksSection 1-1
1-1-2Function Block Specifications
For specifications that are not listed in the following table, refer to the CX-Programmer Ver. 5.0 Operation Manual (W437).
ItemSpecifications
Model numberWS02-CXPC1-E-V50
Setup diskCD-ROM
Compatible CPU UnitsCS/CJ-series CS1-H, CJ1-H, and CJ1M CPU Units with unit version 3.0 or
Compatible
computers
ComputerIBM PC/AT or compatible
CPU133 MHz Pentium or faster with Windows 98, SE, or NT 4.0 (with service pack
OSMicrosoft Windows 95, 98, SE, Me, 2000, XP, or NT 4.0 (with service pack 6
Memory64 Mbytes min. with Windows 98, SE, or NT 4.0 (with service pack 6 or
Hard disk space100 Mbytes min. available disk space
Monitor
CD-ROM driveOne CD-ROM drive min.
COM portOne RS-232C port min.
later are compatible.
Device TypeCPU Type
• CS1G-HCS1G-CPU42H/43H/44H/45H
• CS1H-HCS1H-CPU63H/64H/65H/66H/67H
• CJ1G-HCJ1G-CPU42H/43H/44H/45H
• CJ1H-HCJ1H-CPU65H/66H/67H
• CJ1MCJ1M-CPU11/12/13/21/22/23
Note If a user program containing function blocks created on the CX-Pro-
grammer 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.
CS/CJ 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.
6 or higher)
or higher)
higher)
Refer to Computer System Requirements below for details.
SVGA (800
Note Use “small font” for the font size.
× 600 pixels) min.
3
Introducing the Function BlocksSection 1-1
ItemSpecifications
Functions not
supported by
CX-Programmer Ver. 4.0
or earlier.
Defining
and creating function blocks
Creating
instances
Storing
function
blocks as
files
Number of
function block
definitions
Function
block names
VariablesVariable names30,000 characters max.
LanguageFunction blocks can be created in ladder programming language or structured
Number of
instances
Instance
names
Project filesThe project file (.cxp/cxt) Includes function block definitions and instances.
Program files The file memory program file (*.obj) includes function block definitions and
Function
block library
files
CS1-H/CJ1-H CPU Units:
• 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
64 characters max.
Variable typesInputs, Outputs, Internals, and Externals
Number of I/O variables in
function block definitions
Allocation of addresses
• 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
30,000 characters max.
instances.
Each function block definition can be stored as a single file (.cxf) for reuse in
other projects.
64 max. (not including EN and ENO)
Automatic allocation (The allocation range can
be set by the user.)
Supported
NoteThe 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, and comments.
For details, refer to Appendix B Structured Text (ST Language) Specifications.
1-1-3Files Created with CX-Programmer Ver. 5.0
Project Files (*.cxp) and
File Memory Program
Files (*.obj)
Projects created using CX-Programmer that contain function block definitions
and projects with instances are saved in the same standard project files
(*.cxp) and file memory program files (*.obj).
The following diagram shows the contents of a project. The function block definitions are created at the same directory level as the program within the relevant PLC directory.
A function block definition created in a project with CX-Programmer Ver. 5.0
can be saved as a file (1 definition = 1 file), enabling definitions to be loaded
into other programs and reused.
Project Text Files
Containing Function
Data equivalent to that in project files created with CX-Programmer Ver. 5.0
(*.cxp) can be saved as CXT text files (*.cxt).
Blocks (*.cxt)
1-1-4CX-Programmer Ver. 5.0 Function Block Menus
The following tables list CX-Programmer Ver. 5.0 menus related to function
blocks. For details on all menus, refer to the CX-Programmer Ver. 5.0 Opera-tion Manual (W437).
Each function block can be
stored in a separate
definition file (.cxf).
Main Menu
Main menuSubmenuShortcutFunction
FileFunc-
tion
Block
EditUpdate Function Block---When a function block definition’s I/O variables have been changed
InsertFunction Block InvocationFCreates an instance in the program (section) at the present cursor
Function Block Parameter PWhen the cursor is located to the left of an input variable or the right
PLCFunc-
tion
Block
Memory
Load Function
Block from File
Save Function
Block to File
Function Block
Memory Allocation
Function Block
Memory Statistics
Function Block
Instance Address
Optimize Function
Memory
---Reads the saved function block library files (*.cxf).
---Saves the created function block definitions to a file ([function block library file]*.cxf).
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.
location.
of an output variable, sets the variable’s input or output parameter.
---Sets the range of addresses (function block instance areas) internally allocated to the selected instance’s variables.
---Checks the status of the addresses internally allocated to the
selected instance’s variables.
---Checks the addresses internally allocated to each variable in the
selected instance.
---Optimizes the allocation of addresses internally allocated to variables.
5
Introducing the Function BlocksSection 1-1
Main Popup Menus
Popup Menu for Function Block Definitions
Popup menuFunction
Insert Function BlockLadderCreates a function block definition with a ladder programming language algo-
Structured TextCreates a function block definition with an ST language algorithm.
From fileReads a function block definition from a function block library file (*.cxf).
Popup Menu for Inserted Function Blocks
Popup menuFunction
OpenDisplays 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.
CompileCompiles the selected function block definition.
Popup Menu for Function Block Variable Tables
Popup menuFunction
EditEdits the variable.
Insert VariableAdds a variable to the last line.
Insert Variable AboveInserts the variable above the current cursor position.
BelowInserts the variable below the current cursor position.
CutCuts the variable.
CopyCopies the variable.
PastePastes the variable.
FindSearches for the variable. Variable names, variable comments, or all (text strings) can
be searched.
ReplaceReplaces the variable.
DeleteDeletes the variable.
RenameChanges only the name of the variable.
rithm.
Popup Menu for Instances
Popup menuFunction
EditChanges the instance name.
Update InvocationWhen a function block definition’s I/O variables have been changed after the instance
Go To Function Block Definition Displays the selected instance’s function block definition on the right side of the window.
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.
Shortcut Keys
F Key: Pasting Function
Block Definitions in
Program
P Key: Inputting
Parameters
Move the cursor to the position at which to create the copied function block
instance in the Ladder Section Window, and click the F Key. This operation is
the same as selecting Insert - Function Block Invocation.
Position the cursor at the left of the input variable, or at the right of the output
variable and click the P Key. This operation is the same as selecting Insert -Function Block Parameter.
6
Function BlocksSection 1-2
1-2Function Blocks
1-2-1Outline
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 variables. These address or constants are called parameters. The addresses
used by the variables themselves are allocated automatically by the CX-Programmer for each program.
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
Standard
program section
written with
variables
Define in advance.
Insert in
program.
Save function
block as a file.
Convert to
library function.
Function
block A
Reuse.
1-2-2Advantages 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.
Program 1
Copy of function block A
InputOutput
Variable Variable
Set
Copy of function block A
InputOutput
Variable Variable
To another PLC program
Set
Variable
Output
Structured
Programming
Easy-to-read “Black Box”
Design
Use One Function Block
for Multiple Processes
Structured programs created with function blocks have better design quality
and require less development time.
The I/O operands are displayed as variable names in the program, so the program is like a “black box” when entering or reading the program and no extra
time is wasted trying to understand the internal algorithm.
Many different processes can be created easily from a single function block by
using the parameters in the standard process as input variables (such as
timer SVs, control constants, speed settings, and travel distances).
7
Function BlocksSection 1-2
Reduce Coding ErrorsCoding mistakes can be reduced because blocks that have already been
debugged can be reused.
Data ProtectionThe 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
Variable Programming
The function block’s I/O is entered as variables, so it isn’t necessary to change
data addresses in a block when reusing it.
Creating LibrariesProcesses that are independent and reusable (such as processes for individ-
ual steps, machinery, equipment, or control systems) can be saved as function block definitions and converted to library functions.
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 definitions from the file and placing them in a new program.
Compatible with
Mathematical expressions can be entered in structured text (ST) language.
Multiple Languages
1-2-3Function Block Structure
Function Block
Definitions
Function blocks consist of function block definitions that are created in
advance and function block instances that are inserted in the program.
Function block definitions are the programs contained in function blocks. Each
function block definition contains the algorithm and variable definitions, as
shown in the following diagram.
Function Block Definition
Example: CLOCK PULSE
Algorithm
Variable definitions
Example: CLOCK PULSE
1. Algorithm
tim_b
tim_a
2. Variable Definitions
Usage
Internal
Internal
Input
Input
TIMX tim_a OFF_TIME
TIMX tim_b ON_TIME
Name
tim_aTIMER
tim_bTIMER
ON_TIMEINT
OFF_TIMEINT
ENO
Type
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.
8
Function BlocksSection 1-2
2. Variable Definitions
The variable table lists each variable’s usage (input, output, or internal) and
properties (data type, etc.). For details, refer to 1-3 Variables.
Number of Function Block
Definitions
The maximum number of function block definitions that can be created for one
CPU Unit is either 128 or 1,024 depending on the CPU Unit model.
InstancesTo 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 definition 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 process different I/O data with the same function.
Not yet in program
and memory not yet
allocated
(abstract).
Function Block Definition FB1
1. Algorithm
Standard
program unit
with variable
names a, b, c,
etc.
2. Parameters
Table defining usage
and properties of
variables a, b, c, etc.
Insert in
program.
Insert in
program.
Block instance in program with memory
allocated. (object)
Program
Instance FB1_1 of function block definition FB1
Input
data
Instance FB1_2 of function block definition FB1
Input
data
Instance
ab
ab
c
Output data
Output data
c
Output data
Output data
Automatic
allocation
Automatic
allocation
Memory
used
Memory
for FB1_1
Memory
for FB1_2
Different I/O data
can be processed
with the same
function.
NoteInstances 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.
9
Function BlocksSection 1-2
instance_A
Function Block Definition
TIMER_FB
Variable Definitions
Internal variable: WORK_NUM
TIMER_FB
Use same internal variables.
instance_A
TIMER_FB
instance_B
TIMER_FB
Use different internal variables.
Number of InstancesMultiple 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.
ParametersEach time an instance is created, set the real I/O memory addresses or con-
stants for I/O 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
Input 3.00
Set the constants or
input source addresses
from which to pass data.
ab
c
Output 2.00
Set the constant or
output destination
address to which to pass
data.
10
Here, 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.
Function BlocksSection 1-2
Even if an input source address (i.e., an input parameter) or an output destination 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
Input D200
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.
mk
n
Output D300
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
passed from output variables to parameters just after processing the algorithm. If it is necessary to read or write a value within the execution cycle 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 addresses).
!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.
■ 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
11
Function BlocksSection 1-2
Cyclic task 0
Instance
CASCADE_01
Algorithm
Internal and I/O
Function Block Definition
Example: CONTROL
Algorithm
Variables
Example:
There are 3 FB
instances and each
has its own I/O and
internal variables.
variables
Instance
CASCADE_02
Algorithm
Internal and I/O
variables
Instance
CASCADE_03
Algorithm
Internal and I/O
variables
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 task 0
P_On
&100
&130
P_On
&150
Function block definition
Example: CONTROL
Algorithm
Variables
The same instance can be
used at multiple locations.
Instance
CASCADE
Algorithm
Internal and I/O
variables
P_On
&20
&10
P_On
&15
&10
Cyclic task 1
P_On
&7
&8
CASCADE
CONTROL
EN ENO
PARA_1
PARA_2
CASCADE
CONTROL
EN ENO
&50
PARA_1
PARA_2
CASCADE_01
CONTROL
EN ENO
ON_TIME
OFF_TIME
CASCADE_02
CONTROL
EN ENO
ON_TIME
OFF_TIME
CASCADE_03
CONTROL
EN ENO
ON_TIME
OFF_TIME
1.0
1.1
1.2
1.0
1.1
Cyclic task 1
P_On
&100
&200
CASCADE
EN ENO
PARA_1
PARA_2
CONTROL
1.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 executed.
Registration of InstancesEach instance name is registered in the global symbol table as a file name.
Program
Instance (sample) of function block definition A
ab
c
The instance is registered in the
global symbol table with the instance
name as the symbol name.
Name
Data type
sample FB [FunctionBlock1]N/A[Auto]
Instance name
Address/
value
The function block definition
name is registered after FB in
square parentheses [ ].
12
VariablesSection 1-3
1-3Variables
1-3-1Introduction
In a function block, the addresses (see note) are not entered as real I/O memory addresses, they are all entered as variable names. Each time an instance
is created, the actual addresses used by the variable are allocated automatically in the specified I/O memory areas by the CX-Programmer. Consequently, 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 memory 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:
Insert in
program.
Program
Input 0.00
Input 3.00
Instance of function block definition A
ab
c
Output 2.00
Function block definition A
Standard program section with
variable names a, b, c, etc.
a
c
b
MOV
Specify inputs and outputs
at the same time.
Table indicating usage and
prpperties of variables a, b, c, etc.
Usage: Inputs
Prpperties:
Name Type AT Initial Value Retained
a BOOL
c
BOOL
Usage: Outputs
Prpperties:
Name Type AT Initial Value
BOOL
b
Retained
NoteConstants are not registered as variables. Enter constants directly in instruc-
tion operands.
• Ladder programming language: Enter hexadecimal numerical values
after the # and decimal values after the &.
• Structured text (ST language): Enter hexadecimal numerical values after 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-2Variable Usage and Properties
Status of 0.00 (1 or 0) is
passed to a.
0.00a
11
Status of 3.00 (1 or 0) is
passed to c.
3.00
00
c
The system automatically allocates the
addresses used by variables a, b, and c. For
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.
Status of b (1 or 0) is
passed to 2.00.
b
2.00
11
Variable UsageThe 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) variable, which passes input condition data.
13
VariablesSection 1-3
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.
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-3Variable Properties
Variables have the following properties.
Variable NameThe 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.
NoteThe 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 Var i a bl e D e f i-nitions in 2-1-2 Function Block Elements.
Data TypeSelect one of the following data types for the variable:
For details on variable data types, refer to Variable Definitions in 2-1-2 Func-tion Block Elements.
AT Settings (Allocation to
an Actual Addresses)
Array SettingsA variable can be treated as a single array of data with the same properties.
It is possible to set a 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.
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.
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 only. Only one-dimensional
arrays are supported by the CX-Programmer Ver. 5.0.
• 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 variable number.
For details on array settings, refer to Variable Definitions in
Elements
.
2-1-2 Function Block
Initial ValueThis 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.
14
VariablesSection 1-3
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 boolean variable would be 0 (FALSE) and a WORD variable would be 0000 hex.
RetainSelect 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.
1-3-4Variable Properties and Variable Usage
The following table shows which properties must be set, can be set, and cannot be set, based on the variable usage.
PropertyVariable usage
InternalsInputsOutputs
NameMust be set.Must be set.Must be set.
Data TypeMust be set.Must be set.Must be set.
AT (specified address)Can be set.Cannot be set.Cannot be set.
Initial ValueCan be set.Can be set.
(See note.)
RetainedCan be set.Can be set.
(See note.)
Can be set.
Can be set.
NoteInputs can be set as initial values, but the value of the actual input parameter
will be given priority.
1-3-5Internal Allocation of Variable Addresses
When an instance is created from a function block definition, the CX-Programmer internally allocates addresses to the variables. Addresses are allocated
to all of the variables registered in the function block definition except for variables that have been assigned actual addresses with the AT Settings prop-
erty.
Program
Instance of function block definition A
Input 0.00
Note: Variable c is an internal
a
variable, so it is not displayed.
Usage: Inputs
Properties:
Name Type AT Initial Value
a BOOL
Usage: Outputs
Properties:
Name Type AT
b
BOOL
t
TIMER
Usage: Internals
Properties:
Name TypeInitial Value
c
BOOL
AT
2000.00
Initial Value
b
Output 2.00
t
Output 5.00
Retained
Retained
YES
Retained
Non-retained area
Starting address
Retained area
Starting address
Timer area
Starting address
Counter area
Automatic allocation of
addresses by system
Manual allocation of address to
variable in FB by AT Settings option.
FB instance areas
Starting
address
Example
2000.00
150
CIO, H, W,
D, or E Area
150
H, D, or E
Area
T Area
C Area
Size (words)
Size (words)
Size (Completion
Flags)
Size (Completion
Flags)
Setting Internal Allocation
Areas for Variables
The user sets the function block instance areas in which addresses are allocated internally by the system. The variables are allocated automatically by
the system to the appropriate instance area set by the user.
15
Converting Function Block Definitions to Library FilesSection 1-4
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.
Function Block Instance Areas
FB Instance
Area
Start Address End AddressSize
Non RetainH512H1407896CIO, WR, HR, DM, EM
RetainH1408H1535128HR, DM, EM
TimersT3072T40951024TIM
CountersC3072C40951024CNT
Default valueApplicable memory
areas
Function Block Holding
Area Words (H512 to
H1535)
The Function Block Holding Area words are allocated from 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 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 operation.
1-4Converting 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).
ProjectProject
Function block definition
Example: CLOCK_PULSE
1. Algorithm
tim_b
TIMX tim_a OFF_TIME
tim_a
TIMX tim_b ON_TIME
ENO
2. Variable Definitions
Usage
Name
Internal
tim_aTIMER
tim_bTIMER
Internal
ON_TIME INT
Input
OFF_TIME INT
Input
Save
Type
Function block
definition file (.cxf)
Read
Function block definition
Example: CLOCK_PULSE
1. Algorithm
tim_b
TIMX tim_a OFF_TIME
tim_a
TIMX tim_b ON_TIME
ENO
2. Variable Definitions
Usage
Name
Internal
Internal
Input
Input
tim_aTIMER
tim_bTIMER
ON_TIME INT
OFF_TIME INT
Type
16
Usage ProceduresSection 1-5
1-5Usage Procedures
Once a function block definition has been created and an instance of the algorithm 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-1Creating 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 the CX-Programmer Ver. 5.0 and copying and pasting useful parts.
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 - FunctionBlock 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
Function block definition A
1. Algorithm
Standard
program section
with variable
names a, b, c,
etc.
2. Variables
Table defining usage
and properties of
variables a, b, c, etc.
Insert in
program.
Program
Input
condition
executed if the input
condition is established.
Instance of function block definition A
Input 0.00
ab
4. Specify the input source and
output destination addresses.
3. Input instance name
5. The system automatically allocates
the addresses used by these
variables. Set the data area area in
which these addresses are allocated.
Output 2.00
c
Output 3.00
17
Usage ProceduresSection 1-5
1-5-2Reusing 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
Read and
insert.
Program
Input
condition
Input 1.00
Instance of function block definition A
c
Output 5.00
Output 6.00
ab
1. Algorithm
Standard
program section
with variable
names a, b, c,
etc.
2. Variables
Table defining usage
and properties of
variables a, b, c, etc.
Save
Function
block
definition
A
Function block
definition file (*.cxf)
NoteIn 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 program check on each function block definition file before saving or reusing the
file.
18
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-8Number of Function Block Program Steps and Instance Execution Time . . .108
2-8-1Number of Function Block Program Steps
(CPU Units with Unit Version 3.0 or Later) . . . . . . . . . . . . . . . . . . .108
2-8-2Function Block Instance Execution Time
(CPU Units with Unit Version 3.0 or Later) . . . . . . . . . . . . . . . . . . .109
20
Function Block SpecificationsSection 2-1
2-1Function Block Specifications
2-1-1Function Block Specifications
ItemDescription
Number of function block definitions CS1-H/CJ1-H CPU Units:
• 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
Number of instancesCS1-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
Number of instance nesting levelsNesting is not supported.
Number of I/O variables64 variables max. per function block definition
2-1-2Function Block Elements
The following table shows the items that must be entered by the user when
defining function blocks.
ItemDescription
Function block
definition name
LanguageThe programming language used in the function block defini-
Variable definitionsVariable settings, such as operands and return values,
AlgorithmEnter the programming logic in ladder or structured text.
CommentFunction blocks can have comments.
Function Block
Definition Name
Each function block definition has a name. The names can be up to 64 characters long and there are no prohibited characters. The default function block
name is FunctionBlock@, where @ is a serial number.
CLOCK PULSE
EN ENO
(BOOL) (BOOL)
ON_TIME
(INT)
OFF_TIME
(INT)
The name of the function block definition
tion. Select ladder programming or structured text
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
• Enter the programming logic using variables.
• Input constants directly without registering in variables.
Function block definition name
21
Function Block SpecificationsSection 2-1
LanguageSelect either ladder programming language or structured text (ST language).
For details refer to Appendix B Structured Text (ST Language) Specifications.
Variable DefinitionsDefine 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
EN
ENO
(BOOL) (BOOL)
ON_TIME
(INT)
OFF_TIME
(INT)
Input variables
Output variables
Variable table
Usage
Name
tim_aTIMER
Internal
Internal
tim_bTIMER
ON_TIMEINT
Input
OFF_TIMEINT
Input
tim_b
tim_a
Internal
variables
Type
TIMX tim_a OFF_TIME
TIMX tim_b OFF_TIME
ENO
Variable Type (Usage)
ItemVariable type
InputsOutputsInternalsExternals
DefinitionOperands to the
instance
Status of value at next
execution
The value is not
passed on to the next
execution.
DisplayDisplayed on the left
side of the instance.
Number allowed64 max. per function
block (excluding EN)
AT settingNoNoSupportedNo
Array settingNoNoSupportedNo
Return values from the
instance
The value is passed on
to the next execution.
Displayed on the right
side of the instance.
64 max. per function
block (excluding ENO)
Variables used only
within instance
The value is passed on
to the next execution.
Not displayed.Not displayed.
UnlimitedUnlimited
Global symbols registered as variables
beforehand with the
CX-Programmer or
user-defined global
symbols.
The value is not
passed on to the next
execution.
22
Function Block SpecificationsSection 2-1
ItemVariable type
InputsOutputsInternalsExternals
Retain settingNoSupportedSupportedNo
Variables created by
default
EN (Enable):
Receives an input con-
dition.
ENO (Enable Output):
Outputs the function
block’s execution status.
NonePre-defined symbols
registered in advance
as variables in the CXProgrammer, such as
Condition Flags and
some Auxiliary Area
bits.
NoteFor 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.
P_On
D0D100
The value of the parameter specified as the input (value of D0)
is passed to the instance’s input variable (PV).
FB
EN
ENO
PV CV
1.0
Example
ADD_INT_DINT
0.0
EN ENO
D100
IN16 OUT32
D200
IN32
IN16 is an INT variable, so the content of D100 is used.
IN32 is a DINT variable, so the content of D200 and
D201 is used.
10.0
D1000
Algorithm (Body)
P_On
Variable table
Usage
tmpDINT
Internal
ENBOOL
Input
IN16INT
Input
IN32DINT
Input
ENOBOOL
Output
OUT32DINT
Output
SIGN IN16 tmp
+L IN32 tmp OUT32
Name
Type
Note1. The same name cannot be assigned to an input variable and output vari-
able. If it is necessary to have the same variable as an input variable and
output variable, register the variables with different names and transfer the
value of the input variable to the output variable in the function block with
an instruction such as MOV.
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, reference the global symbol as external variables.
23
Function Block SpecificationsSection 2-1
Initial Value
Initial values can be set for input variables, but the value of the input parameter 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.
P_On
D0D100
The value of the output variable (CV) is passed to the parameter
specified as the output destination, which is D100 in this case.
FB
EN ENO
PV CV
1.0
Example
0.0
ADD_INT_DINT
EN ENO
D100
IN16 OUT32
D200
IN32
OUT32 is a DINT variable, so
the variable's value is passed
to D1000 and D1001.
10.0
D1000
Algorithm (Body)
EN
Variable table
Usage
tmpDINT
Internal
ENBOOL
Input
IN16INT
Input
IN32DINT
Input
ENOBOOL
Output
OUT32DINT
Output
SIGN IN16 tmp
+L IN32 tmp OUT32
Name
Data type
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
24
Note1. The same name cannot be assigned to an input variable and output vari-
able. If it is necessary to have the same variable as an input variable and
output variable, register the variables with different names and transfer the
value of the input variable to the output variable in the function block with
an instruction such as MOV.
Function Block SpecificationsSection 2-1
2. When the instance is executed, output variables are passed to the corresponding parameters after the algorithm is processed. Consequently, values 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 internal 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 bitInitial value
IOM Hold Bit (A50012)ONThe 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.
■ Internal Variables
Internal variables are used within an instance. These variables are internal to
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 definition 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 cannot reference and will not affect each other’s tim_a value.
Variable table
Usage
Internal
Internal
Input
Input
Name
tim_aTIMER
tim_bTIMER
ON_TIMEINT
OFF_TIMEINT
Data type
P_On
&20
&10
P_On
&40
&10
Pulse_2sON_1sOFF
CLOCK PULSE
EN ENO
ON_TIME
OFF_TIME
Pulse_4sON_1sOFF
CLOCK PULSE
EN ENO
ON_TIME
OFF_TIME
1.0
1.1
25
Function Block SpecificationsSection 2-1
Algorithm (Body)
0.0
ADD_INT_DINT
EN ENO
D100
IN16 OUT32
D200
IN32
Internal variable tmp
is not displayed.
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 variable 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.
VariablesConditionStatus
Variables set to RetainStart of operationRetained
10.0
D1000
EN
SIGN IN16 tmp
+L IN32 tmp OUT32
Variable table
Internal
Input
Input
Input
Output
Output
Power ONRetained
Name
tmpDINT
ENBOOL
IN16INT
IN32DINT
ENOBOOL
OUT32DINT
Type
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 setting the PLC Setup, as shown in the following table.
VariablesConditionIOM Hold Bit (A50012) setting
OFFON
IOM Hold Bit Status at Startup
IOM Hold Bit Status at Startup
(PLC Setup) selected
Variables not
set to Retain
Start of operation Not retained RetainedRetained
Power ONNot retained RetainedNot retained
NoteThe IOM Hold Bit (A50012) is supported for compatibility with previous mod-
els. To hold the values of variables in function blocks, however, use the RetainOption 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 bitInitial value
IOM Hold Bit (A50012)ONThe initial value will not be set.
.
OFFThe initial value will be set.
(PLC Setup) not selected
26
■ External Variables
External variables are either system-defined variables that have been registered in CX-Programmer before hand, or variables that externally reference
user-defined variables in the global symbol table.
Function Block SpecificationsSection 2-1
• For details on system-defined variables, refer to Appendix C External
Var iable s .
• To reference user-defined variables in the global symbol table, the variables must be registered in the global symbol table using the same variable name and data type as the external variable.
Variable PropertiesVariable 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.
NoteA variable name must be input for variables, even ones with AT settings (spec-
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 instruction 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 Completion Flag (1 bit) or the counter present value (16 bits) is specified (depending on the instruction operand). The COUNTER data type cannot be
used in structured text function blocks.
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 programming even if a particular address is specified.
Note(1) The AT property can be set for internal variables only.
27
Function Block SpecificationsSection 2-1
(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)
(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
• Instruction operands specifying the beginning word (or end word) of
multiple words.
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 setting.
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 function should thus be used only when necessary.
Array Setting
With internal variables, a variable can be defined as an array.
NoteOnly 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 can have from 1 to 32,000 array elements.
• The array setting can be set for internal variables only.
• Any data type 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 variable 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
28
Function Block SpecificationsSection 2-1
SCL
SC
SC
SC
SC
SC
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 (+,
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]
0
WORD variable
1
WORD variable
2
WORD variable
3
WORD variable
4
WORD variable
5
WORD variable
6
WORD variable
7
WORD variable
8
WORD variable
9
WORD variable
Specify SCL[3] to access this data element.
−, *, and /).
Settings for variable SCL as an array
variable with element numbers 0 to 9.
NoteUse an internal 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 cannot be set. Prepare an internal array variable with the number of
elements for the required size, and after setting the data in each array element, specify the first or last element in the array variable for the operand.
Specify the beginning of the
array in the SCL instruction.
SCL
EN ENO
S
D
Specifying this array element
in the SCL instruction is the
same as specifying the first
address.
100
29
Instance SpecificationsSection 2-2
NoteFor 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 InitialVal u e 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.
AlgorithmEnter the logic programming using the registered variables.
Operand Input
Restrictions
NoteException: Input directly or indirectly specified addresses for Index Registers
Addresses cannot be directly input into instruction operands within function
blocks. Addresses that are directly input will be treated as variable names.
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 language: Enter hexadecimal numerical values
after the # and decimal values after the &.
• Structured text (ST language): Enter hexadecimal numerical values after 16# and enter decimal numerical values as is.
CommentA comment of up to 30,000 characters long can be entered.
2-2Instance Specifications
2-2-1Composition of an Instance
The following table lists the items that the user must set when registering an
instance.
ItemDescription
Instance nameName of the instance
Language
Variable definitions
Function block instance areas The ranges of addresses used by the variables
CommentsA comment can be entered for each instance.
The programming and variables are the same as in
the function block definition.
30
Instance SpecificationsSection 2-2
Instance NameThis 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
Instance Areas
Function Block Instance
Area Types
To use a function block, the system requires memory to store the instance’s
internal variables and I/O 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.
FB Instance
Area
Non RetainH512H1407896CIO, WR, HR, DM, EM
RetainH1408H1535128HR, DM, EM
TimersT3072T40951024TIM
CountersC3072C40951024CNT
Start Address End AddressSize
Default valueApplicable memory
areas
The following settings are made in the function block instance area:
Non-retained Areas
ItemContents
Allocated variablesVariables for which the retain property for power OFF and
Applicable areasH (Function block Special Holding Area), I/O (CIO Area), H
Setting unitSet in words
Allocated words
(default)
operation start is set as non-retained (See note 1.)
(Holding Area), W (Internal Relay Area), D (Data Memory
Area) (see note 2), E (Extended Data Memory Area) (See
notes 2 and 3.)
H512 to H140
Note(1) Except when the data type is set to TIMER or COUNTER.
31
Instance SpecificationsSection 2-2
(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 retained area.
Retained Area
ItemContents
Allocated variablesVariables for which the retain property for power OFF and
Applicable areasH (Function block Special Holding Area), H (Holding Area), D
Setting unitSet in words
Allocated words
(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 retained area.
operation start is set as retained (See note 1.)
(Data Memory Area) (see note 1), E (Extended Data Memory
Area) (See notes 2 and 3.)
H1408 to H1535
Function Block Holding
Area (H512 to H1535)
Timer Area
ItemContents
Allocated variablesVariables with TIMER set as the data type.
Applicable areasT (Timer Area) Timer Flag (1 bit) or timer PVs (16 bits)
Allocated words
(default)
T3072 to T4095 Timer Flag (1 bit) or timer PVs (16 bits)
Counter Area
ItemContents
Allocated variablesVariables with COUNTER set as the data type.
Applicable areasC (Counter Area) Counter Flag (1 bit) or counter PVs (16 bits)
Allocated words
(default)
C3072 to C4095 Counter Flag (1 bit) or counter PVs (16 bits)
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.
32
NoteTo prevent overlapping of instance area addresses with addresses used in the
program, set H512 to H1535 (Function Block Holding Area words) for the nonretained area and retained area.
Instance SpecificationsSection 2-2
Accessing Function Block
Instance Area from the
User Program
NoteThe allocations in the function block instance area for variables are automati-
If the user program contains an instruction to access the function block
instance area, an error will be displayed in the Compile Tab of the Output Window 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
FB
EN ENO
1.0P_Off
3.0W0.00
Instance data area
Non Retain
Retain
Timers
Counters
Compile error
Start
address
W0512
Size
cally reallocated when a variable is added or deleted. A single instance
requires addresses in sequence, however, so if addresses in sequence cannot be obtained, all variables will be allocated different addresses. As a result,
unused areas will be created. If this occurs, execute the optimization operation to effectively use the allocated areas and remove the unused areas.
CommentsA comment of up to 30,000 characters long can be entered.
Creating Multiple
Instances
Calling the Same InstanceA single instance can be called from multiple locations. In this case, the inter-
nal variables will be shared.
Making Multiple InstancesMultiple 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.
33
Instance SpecificationsSection 2-2
Program 1 (automatic operation)
Product A counter
CTD
CD Q
LD
PV CV
Product B counter
CTD
CD Q
LD
PV CV
Program 1
Program 2
Instance A
FB
Instance B
FB
Instance A
FB
D100
D200
Program 2 (manual operation)
Product B counter
CTD
CD Q
LD
PV CV
Reading the same product’s counter
value at different locations
Reading different products’ counter values
(Algorithm calculating counter value is the same.)
Instance A
I/O variables,
Internal
variables
Body
Instance B
I/O variables,
Internal
variables
Body
FB definition
Variable
definitions
Body
D150
Use the same internal variables
Use different internal variables
2-2-2Parameter Specifications
The data that can be set by the user in the input parameters and output
parameters is as follows:
ItemApplicable data
Input parametersValues (See note 1.), addresses, and program symbols (glo-
Output parametersAddresses, program symbols (global symbols, local symbols)
Note(1) The following table shows the methods for inputting values in parameters.
Input
variable
data type
BOOLBit data1 bitP_Off, P_On0 (FALSE), 1 (TRUE)
INTInteger16 bitsPositive value: & or + followed
DINTDouble integer32 bits−2,147,483,648 to 2,147,483,647
LINTLong (8-byte) integer64 bits−9,223,372,036,854,775,808 to
ContentsSizeParameter value input
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.
(See note 2.)
Setting range
method
−32,768 to 32,767
by integer
Negative value:
integer
− followed by
9,223,372,036,854,775,807
34
Instance SpecificationsSection 2-2
Input
variable
ContentsSizeParameter value input
method
Setting range
data type
UINTUnsigned integer16 bitsPositive value: & or + followed
UDINTUnsigned double integer 32 bits&0 to 4,294,967,295
ULINTUnsigned long (8-byte)
64 bits&0 to 18,446,744,073,709,551,615
by integer
&0 to 65,535
integer
REALReal number32 bitsPositive value: & or + followed
by real number (with decimal
point)
LREALLong real number64 bits
Negative value:
real number (with decimal
− followed by
point)
−3.402823 × 10
−38
10
, 0, 1.175494 × 10
3.402823 × 10
−1.79769313486232 × 10
−2.22507385850720 × 10
38
to −1.175494 ×
38
2.22507385850720 × 10
1.79769313486232 × 10
WORD16-bit data16 bits# followed by hexadecimal
#0000 to FFFF or &0 to 65,535
number (4 digits max.)
& or + followed by decimal
number
DWORD32-bit data32 bits# followed by hexadecimal
number (8 digits max.)
#00000000 to FFFFFFFF or &0 to
4,294,967,295
& or + followed by decimal
number
LWORD64-bit data64 bits# followed by hexadecimal
number (16 digits max.)
& or + followed by decimal
#0000000000000000 to
FFFFFFFFFFFFFFFF or &0 to
18,446,744,073,709,551,615
number
−38
−308
308
to
308
−308
to
, 0,
,
(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 following table.
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-3Operating Specifications
Calling InstancesThe user can call an instance from any location. The instance will be executed
when the input to EN is ON.
0.0
D0
Instance
EN ENO
A B
1.0
In this case, the input to EN is bit 0.0 at the left of the diagram.
• When the input to EN is ON, the instance is executed and
D10
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.
35
Instance SpecificationsSection 2-2
Operation when the
Instance Is Executed
The system calls a function block when the input to the function block’s EN
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
P_On
Algorithm (Image)
CLOCK PULSE
EN ENO
&20
ON_TIME
&10
OFF_TIME
Usage
Internal
Internal
Input
Input
Pulse_2sON_1sOFF tim_b
Pulse_2sON_1sOFF tim_a
Pulse_2sON_1sOFF tim_a
Pulse_2sON_1sOFF tim_bPulse_2sON_1sOFF ON_TIME
1.0
1. The FB is called.
2. The system generates the instance
variables and copies the algorithm.
3. Write data from output variables to parameters.
Input to EN is ON.
Parameters
1. Read values from parameters
to input variables.
2. Execute the algorithm.
3. Write values from output
variables to parameters.
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 algorithm, the output parameter will retain its previous value.
36
Restrictions on Function BlocksSection 2-3
a
Operation when the
Instance Is Not Executed
!Caution An instance will not be executed while its EN input variable is OFF, so Differ-
When the input to the function block’s EN input variable is OFF, the function
block is not called, so the internal variables of the instance do not change (values are retained). In the same way the output variables do not change when
EN is OFF (values are retained).
Program
FB
EN ENO
Execution results:
Output variable 1.0 is turned OFF, but
internal variable a retains its previous value.
Program
Internal
variable a
1.0P_Off
1.0P_OffP_On
FB definition
Body
P_On
ENO
Internal
variable a
If the programming were entered
directly into the program instead of in
function block definition, both bit 1.0
and variable a would be turned OFF.
entiation and Timer instructions will not be initialized while EN is OFF. If Differentiation 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
A function block cannot be called from another function block, i.e., nesting is
not supported.
Program
Instance A
FB1
2-3Restrictions on Function Blocks
Ladder Programming
Restrictions
Instructions Prohibited in
Function Block Definitions
There are some restrictions on instructions used in ladder programs.
The following instructions cannot be used in function block definitions. A compile error will occur if any of these instructions is used.
• Block Programming Instructions (All instructions, including BPRG and
BEND)
• CV Address Conversion Instructions (FRMCV and TOCV)
Instance A: FB1
FB2
Instance X: FB2
37
Restrictions on Function BlocksSection 2-3
• Instructions manipulating record positions (PUSH, FIFO, LIFO, SETR,
and GETR)
• FAILURE POINT DETECTION Instruction (FPD)
• Move Timer/Counter PV to Register Instruction (MOVRW)
AT Setting Restrictions
(Unsupported Data Areas)
Addresses in the following areas cannot be used for AT settings.
• 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
Memory in Instruction
Operands
• Addresses, not variables, can be directly input in Index Registers (both
indirect and direct addressing) and Data Registers.
The following values can be input in instruction operands:
Direct addressing: IR0 to IR15; Indirect addressing: ,IR0 to ,IR15; Constant 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.
I/O Variable Restrictions
(Unsupported Data Areas)
Addresses in the following data areas cannot be used as parameters for input
and output variables.
• Index Registers (neither indirect nor direct addressing is supported) and
Data Registers
• Indirect addressing of DM or EM Area addresses (Neither binary-mode
nor BCD-mode indirect addressing is supported.)
Interlock RestrictionsWhen a function block is called from an interlocked program section, the con-
tents of the function block definition will not be executed. The interlocked function block will behave just like an interlocked subroutine.
P_Off
IL
FB
FB_BODY
Differentiation
Instructions in Function
Block Definitions
38
ILC
Interlocked
Interlock will not
affect instructions in
the function block
definition.
An instance will not be executed while its EN input variable is OFF, so the following precautions are essential when using a Differentiation Instruction in a
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.)
Restrictions on Function BlocksSection 2-3
Example:
0.0
FB1
EN ENO
IN1 OUT1
SET OUT1
Body
LD EN
OR IN1
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
0.00
FB1
EN ENO
a O UT1
IN 1
LD a
OR IN1
SET OUT1
Body
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.
• 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 number 1) and second operand (timer/counter number 2). Different variables
cannot be specified for the first and second operand.
Timer Instructions in
Function Block Definitions
An instance will not be executed while its EN input variable is OFF, so the following 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 operating.
0.00
FB1
EN ENO
U P
LD EN
TIM t im UP
Body
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.
39
Restrictions on Function BlocksSection 2-3
ST Programming
Restrictions
P_On
0.00
FB1
EN ENO
a U P
LD a
TIM t im UP
Body
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.
• 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
• Arithmetic operators
• Logical operators
• Comparison operators
• Numerical Functions
• Arithmetic Functions
•Comments
• The TIMER and COUNTER data types cannot be used.
For further details, refer to Appendix B Structured Text (ST Language) Specifi-cations.
Program Structure Precautions
No Branches to the Left of
the Instance
Only One Instance per
Rung
Branches are not allowed on the left side of the instance. Branches are
allowed on the right side.
IncorrectCorrect
A program rung cannot have more than one instance.
FBFB
Instruction
IncorrectIncorrect
FB
FB
FB
Instruction
40
Restrictions on Function BlocksSection 2-3
No Function Block
Connections
A function block’s input cannot be connected to another function block’s output. 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
FB1
EN
XOUT
D100
XIN1
XIN2
FB2
0.0
FB1
EN
0.0
EN
D3000
XIN1
D100
XIN2
XOUT
FB2
D3000
Temporary variables
transfer the value from
FB1 to FB2.
Downloading in Task UnitsTasks including function blocks cannot be downloaded in task units, but
uploading is possible.
Programming
Console Displays
When a user program created with the CX-Programmer is downloaded to the
CPU Unit and read by a Programming Console, the instances will all be displayed as question marks. (The instance names will not be displayed.)
Online Editing
Restrictions
The following online editing operations cannot be performed on the user program in the CPU Unit.
• Changing or deleting function block definitions (variable table or algorithm)
• Inserting instances or changing instance names
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
Restrictions
Prohibiting Access to
FB Instance Areas
If a fatal error occurs in the CPU Unit while a function block definition is being
executed, ladder program execution will stop at the point where the error
occurred.
ProgramFB definition
BodyInstance name
0.0
FB
EN ENO
AAA BBB
10.0
D200D100
LD P_On
++ AAA
Fatal error occurs here.
MOV AAA BBB
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.
To use a function block, the system requires memory areas to store the
instance’s internal variables and I/O variables.
Function block instance
area
Non-retainedH512896CIO, WR, HR, DM, EM
RetainedH1408128HR, DM, EM
TimerT30721,024TIM
CounterC30721,024CNT
Initial value of
start address
Initial value
of size
Allowed data areas
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.
41
Function Block Applications GuidelinesSection 2-4
• 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).
2-4Function Block Applications Guidelines
This section provides guidelines for using function blocks with the CX-Programmer.
2-4-1Deciding on Variable Data Types
Integer Data Types
(1, 2, or 4-word Data)
NoteUse signed integers if the numbers being used will fit in the range.
Word Data Types
(1, 2, or 4-word Data)
Use the following data types when handling single numbers in 1, 2, or 4-word
units.
• INT and UINT
• DINT and DINT
• LINT and ULINT
Use the following data types when handling groups of data (non-numeric
data) in 1, 2, or 4-word units.
•WORD
•DWORD
•LWORD
2-4-2Determining Variable Types (Inputs, Outputs, Externals, and
Internals)
Using Input Variable to
Change Passed Values
To paste a function block into the program and then change the value (not the
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
42
&3Unit No.
&50
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 variable cannot be used for the operand. Specify either to use internal variables with AT settings, specify the first or last element in an internal array
variable, or use an external variable (as described in 2-4-4 Array Settingsfor Internal Variables).
PARA
Function Block Applications GuidelinesSection 2-4
An input variable cannot be used to specify
Program
Instance for function block definition A
The actual value is
passed
D00100 DATA_1
W500
DATA_2
The address can be specified, but the address itself is not passed.
If the size of the data type in
DATA_1 is 1 word, the value
for the word D00100 is
passed.
If the size of the data type in
DATA_2 is 2 words, the value
for the 2 words W500 and
W501 is passed.
• Values are passed in a batch from the input parameters to the input variables before algorithm execution (not at the same time as the instruction
in the algorithm is executed). Therefore, to pass the value from a parameter 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.
the address of an operand that specifies
the the first (or last) address of multiple
words.
For example, the XFER (BLOCK
TRANSFER) instruction cannot be used to
transfer 10 words from the address
beginning with DATA_1 to the address
beginning with DATA_2.
XFER
&10
DATA_1
DATA_2
Passing Values from or
Monitoring Output
Variables
External Variables:
Condition Flags, Clock
Pulses, Auxiliary Area
Bits, Global Symbols in
Program
Internal Variables:
Internally Allocated
Variables and Variables
Requiring AT Settings
To paste into the program and then pass values outside (the program) from
the function block for each instance, or monitor values, use output variables.
Program
Instance for function block definition A.
The actual value is
passed.
OK_Flag
NG_Flag
Variable for passing a value outside or monitoring:
Use an output variable.
W0.00
W0.01
The following restrictions apply.
• Values are passed from output variables to output parameters all at once
after algorithm execution.
Condition Flags (e.g., Always ON Flag, Equals Flag), Clock Pulses (e.g., 1.0
second clock pulse bit), pre-registered Auxiliary Area Bits (e.g., First Cycle
Flag), and global symbols used in the program are all external variables
defined by the system.
Variables that are not specified as Inputs, Outputs, or Externals are Internals.
Internal variables include variables with internally allocated addresses, variables requiring addresses with AT settings (e.g., I/O allocation addresses,
addresses specially allocated for Special I/O Units), or variables requiring
array settings. 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 forInternal Variables.
2-4-3AT Settings for Internal Variables
Always specify AT settings for internal variables under the following conditions.
• 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).
43
Function Block Applications GuidelinesSection 2-4
p
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 SpecifyingAddresses 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 internal array variable cannot be specified for the operand (e.g., the
number of array elements cannot be specified).
2-4-4Array Settings for Internal Variables
Using Array Variables
to Specify First or Last
Word in Multiword
Operands
1,2,3...1. Prepare an internal array variable with the required number of elements.
When specifying the first or last of a range of words in an instruction operand
(see note), the instruction operates according to the address after AT specification or internal allocation. (Therefore, the variable data type and number of
elements for the variable are unrelated to the operation of the instruction.) Always 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.
NoteSome 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 Specifyingthe First or Last of Multiple Words. Use the following method to specify an array
variable.
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.
44
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
Internal variable, data type = WORD, array setting with 10 elements, variable names = filename[0] to filename[9]
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
Internal variable, data type = WORD, array setting with 100 elements,
variable names = read_data[0] to read_data[99]
• Ladder programming
FREAD (omitted) (omitted) (omitted) read_data[0]
Set data in each array element.
Specify the first element of the array
in the instruction operand.
Division Using Integer
Array Variables (Ladder
Programming Only)
A two-element array can be used to store the result from a ladder program’s
SIGNED BINARY DIVIDE (/) instruction. The result from the instruction is D
(quotient) and D+1 (remainder). This method can be used to obtain the remainder from a division operation in ladder programming.
NoteWhen 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-5Specifying Addresses Allocated to Special I/O Units
Use Index Registers IR0 to IR15 (indirectly specified constant offset) to specify 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.
NoteFor 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).
45
Function Block Applications GuidelinesSection 2-4
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
Instance for function block definition A.
&3Unit No.
1) Specify the first CIO Area word n (n = CIO 2000 + unit number × 10)
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)
Multiplies unit number by
&10
&10 and stores in offset.
Unit No.
Offset
Stores the real I/O memory
MOVR
address for the relay in IR0.
Relay
IR0
2-4-6Using 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 specification: ,IR0 to ,IR15)
NoteAfter storing the real I/O memory addresses in the Index Registers using the
MOVR(560) instruction, Index Registers can be indirectly specified using general instructions. This enables all I/O memory areas to be specified dynamically.
Adds offset to IR0.
+L
IR0
Offset
IR0
2) Specify the designated bit in the CIO
Area (e.g., CIO word n+1, bit 02)
Turns ON CIO word n+1,
SETB
bit 02.
+1,IR0
&2
46
Function Block Applications GuidelinesSection 2-4
Pointer
All I/O memory
areas
MOVR(560)
IR@
Index Register
Example: Specifying +5,IR0 using
constant offset specification, not
variable name
Function block
Instruction
+5,IR0
a
Indirect
specification
Specify address
in IR0
+5 offset
Specify address at +5
IR0
offset from
I/O memory
IR0.
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 instances 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
Value A
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
IR0
Value A
(2) Always set the value before using Index Registers. Operation will not be
stable if Index Registers are used without the values being set.
47
Function Block Applications GuidelinesSection 2-4
Application ExamplesThe following examples are for using Index Registers IR0 to IR15 within func-
tion blocks.
ExampleDetails
Saving the Index Register Value before Using Index RegisterWhen Index Registers are used within this
Store IR0 temporarily in backup buffer
Using Index Registers
1) Setting the value in the Index Register. (Stores the real I/O memory
address for first CIO Area word n)
Calculate offset address from unit number
function block, processing to save the Index
Register value is performed when the function 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 Register IR0 by storing it in SaveIR[0] (internal
variable, data type DINT, 1 array element).
Example: The real I/O memory address for
the first word of CIO 1500 + unit number
25 allocated in the CPU Bus Unit allocation
area based on the CPU Bus Unit’s unit
number (&0 to &15) passed from the function block is stored in IR0.
Procedure:
Assumes that unit numbers &0 to &15 have
already been input (from outside the function 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
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 to be specified.
×
× &25).
48
Precautions for Instructions with Operands Specifying the First or Last of Multiple Section 2-5
ExampleDetails
2) Specifying constant offset of Index Register (Specifying a bit between
CIO n+0 to n+24)
Check local node data link participation
The real I/O memory address for CIO 1500
+ (UnitNo
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
Note CIO 1500 + (UnitNo × &25) + 2 can
Specify bit addresses using instructions that
can specify bit addresses within words
(e.g., second operand of TST(350/351)/
SETB(532) instructions).
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) is stored in Index Register
× &25) + 2.
also by specified by specifying
SCPU_relay [2] using the array setting with SCPU_relay.
× &25 +6) is ON.
Returning the Index Register to the Prior ValueThe 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 contents from when this function started (or
prior to using the Index Register).
2-5Precautions 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 precautions 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 setting (or external variable setting). Therefore, the variable data type and number 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 andOperand Restrictions.
NoteTo 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 following 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.
49
Precautions for Instructions with Operands Specifying the First or Last of Multiple Section 2-5
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 message 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 executed 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.
Do not use variables with a size that does not match the data size to be processed 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
without Matching Data
Size and without AT
Setting
Example: XFER &10 a b
(variables a and b are WORD data types)
If the operand specifying the first address (or last address) of multiple words
uses a non-array variable data type with a size that does not match the data
size required by the instruction and an AT setting is also not used, the CX-Programmer 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 ab
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-Programmer will output a compile error.
Example: H7@@
10 words are
transferred regardless of the size of
variable a.
Variable b (1 word)Variable a (1 word)
This area will be overwritten,
so the CX-Programmer will
output a compile error.
50
Precautions for Instructions with Operands Specifying the First or Last of Multiple Section 2-5
Array VariablesThe 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 SD N
(S: Bit number, D: First destination word, N: Source word)
E.g., COLMab[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: XFERWS D
(W: Number of words, S: First source word; D: First destination word)
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 &20a[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 specified in W. As a result, the XFER(070) instruction will perform read/write processing 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 elements is specified as 20 elements for both array variable a and b.
51
Instruction Support and Operand RestrictionsSection 2-6
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.
20 words will be
transferred regardless of the size of array variables a and b.
Example: H819
The variables allocated in this area
(H810 to H819 in this example) are
overwritten. The data is variablelength data, so the CX-Programmer
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 CXProgrammer 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 (variable), other variables will be affected and unexpected operation may occur.
2-6Instruction 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 SupportInstructions that are not supported for use in function block definitions by the
CX-Programmer and CS/CJ-series CPU Units with unit version 3.0 are given
as Not supported in function blocks in the Symbol column.
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 number of elements. Otherwise, the CX-Programmer will output an error
when compiling.
52
Instruction Support and Operand RestrictionsSection 2-6
k
k
• If “not fixed” is indicated in parentheses, the size used by the instruction 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-Programmer will not output an error when compiling. The instruction will
operate according to the size specified in the other operand, regardless of the number of array variable elements.
---: Operands that do not require an AT setting or specification of array variables.
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 or an array variable with
the required number of elements must be prepared, 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 memory address on a remote node in the network are indicated as Specifyaddress at remote node with AT setting in the AT setting or array required
column.
2-6-1Sequence Input Instructions
InstructionMnemonicFunction
code
LOADLD
@LD
%LD
!LD
!@LD
!%LD
LOAD NOTLD NOT
!LD NOT
@LD NOT
%LD NOT
!@LD NOT
!%LD NOT
ANDAND
@AND
%AND
!AND
!@AND
!%AND
SymbolOperandsSupported
Bus bar
Starting point of bloc
Bus bar
Starting point of bloc
variable
data types
(Required word
B: BitBOOL---
B: BitBOOL---
B: BitBOOL---
AT setting or
array variable
required
data size
shown in
parentheses.)
53
Instruction Support and Operand RestrictionsSection 2-6
InstructionMnemonicFunction
code
AND NOTAND NOT
!AND NOT
@AND NOT
%AND NOT
!@AND NOT
!%AND NOT
OROR
@OR
%OR
!OR
!@OR
!%OR
OR NOTOR NOT
!OR NOT
@OR NOT
%OR NOT
!@OR NOT
!%OR NOT
SymbolOperandsSupported
variable
data types
---BOOL---
Bus bar
Bus bar
---BOOL---
---BOOL---
AT setting or
array variable
required
(Required word
data size
shown in
parentheses.)
AND LOADAND LD---------
Logic blockLogic block
OR LOADOR LD---------
Logic block
Logic block
NOTNOT520---------
CONDITION ONUP521---------
CONDITION
DOWN522---------
OFF
NOT
UP
DOWN
BIT TESTLD TST350S: Source wordWORD---
TST
S
N
N: Bit numberUINT---
BIT TESTLD TSTN351S: Source wordWORD---
TSTN
S
N
N: Bit numberUINT---
54
Instruction Support and Operand RestrictionsSection 2-6
InstructionMnemonicFunction
code
SymbolOperandsSupported
variable
data types
(Required word
BIT TESTAND TST350S: Source wordWORD---
AND TST
S
N
N: Bit numberUINT---
BIT TESTAND TSTN351S: Source wordWORD---
AND TSTN
S
N
N: Bit numberUINT---
BIT TESTOR TST350S: Source wordWORD---
TST
S
N
N: Bit numberUINT---
BIT TESTOR TSTN351S: Source wordWORD---
TSTN
S
N
N: Bit numberUINT---
AT setting or
array variable
required
data size
shown in
parentheses.)
2-6-2Sequence Output Instructions
InstructionMnemonic Function
code
OUTPUTOUT
!OUT
OUTPUT NOTOUT NOT
!OUT NOT
KEEPKEEP
011---BOOL---
!KEEP
DIFFERENTIATE U P
DIFFERENTIATE D OWN
DIFU
!DIFU
DIFD
!DIFD
013---BOOL---
014---BOOL---
SymbolOperandsSupported
S (Set)
R (Reset)
KEEP
B
DIFU
B
DIFD
B
variable
data types
---BOOL---
---BOOL---
AT setting or
array variable
required
(Required
word data size
shown in
parentheses.)
55
Instruction Support and Operand RestrictionsSection 2-6
InstructionMnemonic Function
code
SETSET
@SET
%SET
!SET
!@SET
!%SET
RESETRSET
@RSET
%RSET
!RSET
!@RSET
!%RSET
MULTIPLE BIT
SET
SETA
@SETA
530D: Beginning wordUINTYes (not fixed)
SymbolOperandsSupported
variable
data types
SET
B
RSET
B
SETA
D
N1
N2
B: BitBOOL---
B: BitBOOL---
N1: Beginning bitUINT--N2: Number of bits UINT---
AT setting or
array variable
required
(Required
word data size
shown in
parentheses.)
MULTIPLE BIT
RESET
SINGLE BIT
SET
SINGLE BIT
RESET
SINGLE BIT
OUTPUT
RSTA
@RSTA
SETB
@SETB
!SETB
RSTB
@RSTB
!RSTB
OUTB
@OUTB
!OUTB
531D: Beginning wordUINTYes (not fixed)
532D: Word addressUINT---
533D: Word addressUINT---
534D: Word addressUINT---
RSTA
D
N1
N2
SETB
D
N
RSTB
D
N
OUTB
D
N
N1: Beginning bitUINT--N2: Number of bits UINT---
N: Bit numberUINT---
N: Bit numberUINT---
N: Bit numberUINT---
56
Instruction Support and Operand RestrictionsSection 2-6
2-6-3Sequence Control Instructions
InstructionMnemonic Function
code
SymbolOperandsSupported
variable
array variable
data types
size shown in
parentheses.)
ENDEND001---------
END
NO OPERATION NOP000-----------INTERLOCKIL002---------
INTERLOCK
ILC003---------
CLEAR
MULTI-INTER-
MILH517N: Interlock number # + decimal
LOCK DIFFERENTIATION
HOLD
MULTI-INTER-
MILR518N: Interlock number # + decimal
LOCK DIFFERENTIATION
RELEASE
MULTI-INTER-
MILC519N: Interlock number # + decimal
LOCK CLEAR
MILC
N
IL
ILC
MILH
N
D
MILR
N
D
D: Interlock Status
Bit
D: Interlock Status
Bit
only
---
BOOL---
---
only
BOOL---
---
only
AT setting or
required
(Required
word data
JUMPJMP004Not supported in function
N: Jump number------
blocks
JUMP ENDJME005Not supported in function
N: Jump number------
blocks
CONDITIONAL
JUMP
CONDITIONAL
JUMP
MULTIPLE
JUMP
MULTIPLE
JUMP END
FOR-NEXT
LOOPS
BREAK LOOPBREAK514---------
FOR-NEXT
LOOPS
CJP510Not supported in function
N: Jump number------
blocks
CJPN511Not supported in function
N: Jump number------
blocks
JMP0515---------
JME0516---------
FOR512N: Number of loops UINT---
NEXT513---------
JMP0
JME0
FOR
N
BREAK
NEXT
57
Instruction Support and Operand RestrictionsSection 2-6
2-6-4Timer and Counter Instructions
InstructionMnemonic Function
code
TIMERTIM
(BCD)
TIMX
550N: Timer numberTIMER---
(BIN)
HIGH-SPEED
TIMER
TIMH
(BCD)
TIMHX
015N: Timer numberTIMER---
551N: Timer numberTIMER---
(BIN)
SymbolOperandsSupported
variable
data types
TIM
N
S
TIMX
N
S
TIMH
N
S
TIMHX
N
S
N: Timer numberTIMER--S: Set valueWORD---
S: Set valueUINT---
S: Set valueWORD---
S: Set valueUINT---
AT setting or
array variable
required
(Required
word data
size shown in
parentheses.)
ONE-MS TIMER TMHH
(BCD)
TMHHX
(BIN)
ACCUMULATIVE TIMER
TTIM
(BCD)
TTIMX
(BIN)
LONG TIMERTIML
(BCD)
TIMLX
(BIN)
540Not supported in function
blocks.
552Not supported in function
blocks.
087N: Timer numberTIMER---
555N: Timer numberTIMER---
Timer input
Reset input
542D1: Completion
553D1: Completion
TTIM
N
S
TTIMX
N
S
TIML
D1
D2
S
TIMLX
D1
D2
S
N: Timer numberTIMER--S: Set valueWORD--N: Timer numberTIMER--S: Set valueUINT---
S: Set valueWORD---
S: Set valueUINT---
WORD---
Flag
D2: PV wordDWORD--S: SV wordDWORD---
UINT---
Flags
D2: PV wordUDINT--S: SV wordUDINT---
58
Instruction Support and Operand RestrictionsSection 2-6
InstructionMnemonic Function
code
MULTI-OUTPUT
TIMER
MTIM
(BCD)
MTIMX
543D1: Completion
554D1: Completion
(BIN)
COUNTERCNT
(BCD)
CNTX
546N: Counter number COUNTER---
(BIN)
Count input
Reset input
Count input
Reset input
SymbolOperandsSupported
variable
data types
MTIM
D1
D2
S
MTIMX
D1
D2
S
CNT
N
S
CNTX
N
S
Flags
D2: PV wordWORD--S: 1st SV wordWORDYes (8)
Flags
D2: PV wordUINT--S: 1st SV wordWORDYes (8)
N: Counter number COUNTER--S: Set valueWORD---
S: Set valueUINT---
UINT---
UINT---
AT setting or
array variable
required
(Required
word data
size shown in
parentheses.)
REVERSIBLE
COUNTER
RESET TIMER/
COUNTER
CNTR
(BCD)
CNTRX
(BIN)
CNR
@CNR
(BCD)
012N: Counter number COUNTER---
548N: Counter number COUNTER---
545N1: 1st number in
Increment input
Decrement input
Reset input
Increment input
Decrement input
Reset input
CNTR
N
S
CNTRX
N
S
CNR
N1
N2
S: Set valueWORD---
S: Set valueUINT---
range
N2: Last number in
range
CNRX
@CNRX
(BIN)
547N1: 1st number in
CNRX
N1
N2
range
N2: Last number in
range
NoteEnabled when the same variable is specified for N1 and N2.
TIMER or
COUNTER
(See note.)
TIMER or
COUNTER
(See note.)
TIMER or
COUNTER
(See note.)
TIMER or
COUNTER
(See note.)
---
---
---
---
59
Instruction Support and Operand RestrictionsSection 2-6