2080 rm001 - en e

Reference Manual
Micro800 Programmable Controllers General Instructions

Catalog Numbers 2080-LC10, 2080-LC20, 2080-LC30, 2080-LC50
Important user information
Read this document and the documents listed in the additional resources section about installation, configuration, and operation of this equipment
before you install, configure, operate, or maintain this product. Users are required to familiarize themselves with installation and wiring instructions
in addition to requirements of all applicable codes, laws, and standards.
Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required to be carried out by
suitably trained personnel in accordance with applicable code of practice. If this equipment is used in a manner not specified by the manufacturer,
the protection provided by the equipment may be impaired.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or application of this
equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated
with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and
diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in this
manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment, which may lead to
personal injury or death, property damage, or economic loss.
ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic
loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence
Important: Identifies information that is critical for successful application and understanding of the product.
Labels may also be on or inside the equipment to provide specific precautions.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may be
present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous
temperatures.
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc
Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work
practices and for Personal Protective Equipment (PPE).
Allen-Bradley, Rockwell Software, Rockwell Automation, and TechConnect are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Table of contents
Preface In This Manual ................................................................................................................... 13

Supported Controllers ...................................................................................................... 13
Additional Resources......................................................................................................... 13
Legal Notices ....................................................................................................................... 14
Chapter 1
Find information about Instruction blocks .............................................................................................................. 17

Operators ..................................................................................................................... 17
instructions and ladder
Functions ..................................................................................................................... 18
elements Function blocks .......................................................................................................... 19
Instruction set in alphabetical order............................................................................... 21
Chapter 2
Ladder Diagram (LD) Ladder Diagram (LD) program ....................................................................................... 29

LD program development environment ....................................................................... 30
language
Chapter 3
Ladder Diagram (LD) Rung .............................................................................................................................. 33

Add a rung to a LD program ............................................................................ 33
elements
Rung labels ........................................................................................................... 35
Rung comments .................................................................................................. 36
Branch........................................................................................................................... 38
Add a branch to a LD program ........................................................................ 38
Instruction Block (LD) ............................................................................................. 41
Coil ................................................................................................................................ 41
Add coil elements ............................................................................................... 42
Direct Coil ........................................................................................................... 45
Reverse Coil ......................................................................................................... 45
Pulse Falling Edge Coil ...................................................................................... 46
Pulse Rising Edge Coil....................................................................................... 47
Set Coil ................................................................................................................. 48
Reset Coil ............................................................................................................. 49
Contact......................................................................................................................... 50
Add a contact to a LD program ....................................................................... 51
Direct Contact .................................................................................................... 54
Reverse Contact .................................................................................................. 54
Pulse Rising Edge Contact................................................................................ 55
Pulse Falling Edge Contact............................................................................... 56
Return ........................................................................................................................... 57
Jump .............................................................................................................................. 58
Rockwell Automation Publication 2080-RM001F-EN-E - November 2016 3

Table of contents
Instruction blocks in LD programs ................................................................................ 59

Work in the LD language editor ..................................................................................... 59
Ladder Diagram (LD) program examples ..................................................................... 61
LD Keyboard shortcuts ..................................................................................................... 62
Chapter 4
Alarm instruction LIM_ALRM (limit alarm) ............................................................................................... 67
Chapter 5
Arithmetic instructions ABS (absolute value).......................................................................................................... 72

ACOS (arccosine of source)............................................................................................. 73
ACOS_LREAL (arccosine Long Real).......................................................................... 75
Addition ............................................................................................................................... 77
ASIN (arcsine) .................................................................................................................... 78
ASIN_LREAL (arcsine Long Real)................................................................................ 80
ATAN (arctangent)........................................................................................................... 82
ATAN_LREAL (arctangent Long Real) ...................................................................... 83
COS (cosine)....................................................................................................................... 85
COS_LREAL (cosine Long Real) .................................................................................. 87
Division ................................................................................................................................ 88
EXPT (exponent) .............................................................................................................. 90
LOG (log base 10).............................................................................................................. 92
MOD (modulo).................................................................................................................. 94
MOV (move) ...................................................................................................................... 96
Multiplication ..................................................................................................................... 97
Neg (negation) .................................................................................................................... 99
POW (raise power) .......................................................................................................... 100
RAND (random value) ................................................................................................... 102
SIN (sine)........................................................................................................................... 104
SIN_LREAL (sine Long Real) ...................................................................................... 106
SQRT (square root)......................................................................................................... 107
Subtraction ........................................................................................................................ 109
TAN (tangent) ................................................................................................................. 111
TAN_LREAL (tangent Long Real) ............................................................................. 112
TRUNC (truncate) ......................................................................................................... 114
Chapter 6
ASCII serial port instructions ABL (ASCII test for buffer line) ................................................................................... 117
ACB (ASCII characters in buffer)................................................................................ 119
ACL (ASCII clear buffer) .............................................................................................. 122
AHL (ASCII handshake lines)...................................................................................... 124
ARD (ASCII read)........................................................................................................... 127
ARL (ASCII read line).................................................................................................... 130
4 Rockwell Automation Publication 2080-RM001F-EN-E - November 2016
Table of contents
AWA (ASCII write append) ......................................................................................... 133

AWT (ASCII write)........................................................................................................ 135
ASCII parameter details ................................................................................................. 138
ABLACB data type .................................................................................................. 138
ACL data type ........................................................................................................... 139
AHL ChannelSts data type .................................................................................... 139
AHLI data type ......................................................................................................... 140
ARDARL data type ................................................................................................. 140
AWAAWT data type .............................................................................................. 141
Chapter 7
Binary instructions AND_MASK (AND mask) .......................................................................................... 143

BSL (bit shift left) ............................................................................................................ 145
BSR (bit shift right) ......................................................................................................... 149
NOT_MASK (bit to bit NOT mask) ......................................................................... 152
OR_MASK (bit to bit OR mask) ................................................................................. 154
ROL (rotate left) .............................................................................................................. 156
ROR (rotate right) ........................................................................................................... 158
SHL (shift left) ................................................................................................................. 160
SHR (shift right) .............................................................................................................. 162
XOR_MASK (exclusive OR mask).............................................................................. 164
Chapter 8
Boolean instructions F_TRIG (falling edge detection) .................................................................................. 167

R_TRIG (rising edge detector) ..................................................................................... 169
RS (reset/set)..................................................................................................................... 171
OR ....................................................................................................................................... 172
AND ................................................................................................................................... 173
XOR (exclusive OR) ....................................................................................................... 174
NOT ................................................................................................................................... 175
SR (set/reset)..................................................................................................................... 175
TTABLE (truth table) .................................................................................................... 177
MUX8B (multiplexer of 8 BOOL inputs) ................................................................. 180
MUX4B (multiplexer of 4 BOOL inputs) ................................................................. 184
Chapter 9
Communication instructions MSG_CIPGENERIC (common industrial protocol generic message)................ 189

CIPAPPCFG data type........................................................................................... 192
CIPCONTROLCFG data type ........................................................................... 192
CIPSTATUS data type........................................................................................... 193
CIPSTATUS status bits ................................................................................. 194
CIPSTATUS error codes ............................................................................... 195
CIPTARGETCFG data type ................................................................................ 196
Table of contents
Target path for CIP messaging ...................................................................... 197

CIP/EIP message connections ....................................................................... 198
CIP message timeout timers ........................................................................... 199
MSG_CIPSYMBOLIC (common industrial protocol symbolic message) ......... 200
CIPSYMBOLICCFG data type ........................................................................... 202
Symbolic Read/Write syntax ......................................................................... 203
Supported Data Packet Size for CIP Serial Function ....................................... 204
MSG_MODBUS (modbus message) .......................................................................... 204
MODBUSLOCPARA data type.......................................................................... 207
Message execution process (Rung = TRUE) ...................................................... 209
MODBUSTARPARA data type .......................................................................... 211
MSG_MODBUS2 (MODBUS/TCP message) ....................................................... 211
MODBUS2LOCPARA data type ....................................................................... 215
MODBUS2TARPARA data type ........................................................................ 216
Message execution processes and timing diagrams .................................................... 218
Message execution process (general)..................................................................... 218
Message execution process (Rung = TRUE) ...................................................... 219
Message execution timing diagram (Rung = TRUE) ....................................... 221
Message execution process (Rung = FALSE) ..................................................... 221
Message execution timing diagram (Rung = FALSE)....................................... 222
Message execution process (Error) ........................................................................ 223
Message execution timing diagram (Error) ......................................................... 224
Use the communication (message) function blocks.................................................. 224
Configure object data values for explicit messaging (MSG_CIPGENERIC)
...................................................................................................................................... 225
Example: How to create a MSG_CIPGENERIC messaging program to read
data from a controller .............................................................................................. 227
Identify initial values for the input variables, MSG_CIPGENERIC .... 228
Add a MSG_CIPGENERIC function block and variables ..................... 229
Configure initial values for variables ............................................................ 231
Add a contact and a coil .................................................................................. 234
Add a COP function block, variables and contact
(MSG_CIPGENERIC).................................................................................. 235
Verify correct IP configuration on Controller B ....................................... 237
Example: How to create a MSG_CIPSYMBOLIC messaging program to
write a value to a variable ........................................................................................ 238
Add a COP function block, variables and a contact
(MSG_CIPSYMBOLIC)............................................................................... 239
Add an Equal operator and a coil .................................................................. 241
Add a MSG_CIPSYMBOLIC function block, variables and a contact243
Verify correct IP configuration on Controller B ....................................... 245
Create global variable for Controller B ........................................................ 247
Review the complete program results ........................................................... 247
Example: How to configure Modbus communication to read from and write
to a drive ..................................................................................................................... 249
Communication protocol support ............................................................................... 253
Embedded communication channels ................................................................... 255

Table of contents
Chapter 10
Compare instructions Equal ................................................................................................................................... 257

Greater than ...................................................................................................................... 260
Greater than or equal....................................................................................................... 262
Less than............................................................................................................................. 264
Less than or equal ............................................................................................................. 266
Not equal ........................................................................................................................... 268
Chapter 11
Counter instructions CTD (count down) ......................................................................................................... 271

CTU (count up)............................................................................................................... 273
CTUD (count up down)................................................................................................ 275
Chapter 12
Data conversion instructions ANY_TO_BOOL ........................................................................................................... 279

ANY_TO_BYTE ............................................................................................................ 280
ANY_TO_DATE ........................................................................................................... 282
ANY_TO_DINT ............................................................................................................ 283
ANY_TO_DWORD ..................................................................................................... 284
ANY_TO_INT ............................................................................................................... 286
ANY_TO_LINT ............................................................................................................. 287
ANY_TO_LREAL.......................................................................................................... 288
ANY_TO_LWORD ...................................................................................................... 289
ANY_TO_REAL ............................................................................................................ 290
ANY_TO_SINT ............................................................................................................. 291
ANY_TO_STRING....................................................................................................... 292
ANY_TO_TIME ............................................................................................................ 294
ANY_TO_UDINT ........................................................................................................ 295
ANY_TO_UINT ............................................................................................................ 296
ANY_TO_ULINT ......................................................................................................... 298
ANY_TO_USINT.......................................................................................................... 299
ANY_TO_WORD ......................................................................................................... 300
Chapter 13
Data manipulation AVERAGE ........................................................................................................................ 303

COP .................................................................................................................................... 305
instructions
Copy to a different data type.................................................................................. 308
COP string array example....................................................................................... 309
MIN (minimum).............................................................................................................. 311
MAX (maximum) ............................................................................................................ 313

Table of contents
Chapter 14
High-Speed Counter (HSC) What is a High-Speed Counter? ................................................................................... 317

HSC (high-speed counter) ............................................................................................. 318
instructions
HSCCmd values ....................................................................................................... 320
HSCAPP data type .................................................................................................. 321
HSCSTS data type ................................................................................................... 325
PLS data type ............................................................................................................. 333
HSC_SET_STS (high-speed counter set status) ....................................................... 335
Use the High-Speed Counter instructions ................................................................. 337
Update HSC application data ............................................................................... 338
High-Speed Counter (HSC) User Interrupt dialog box .................................. 339
Configure a High-Speed Counter (HSC) User Interrupt............................... 340
Add and configure a High-Speed Counter (HSC) User Interrupt ............... 340
HSC Interrupt properties............................................................................... 341
HSC Interrupt parameters ............................................................................. 342
Configure a Programmable Limit Switch (PLS)................................................ 344
Example: How to create a High-Speed Counter (HSC) program ................. 345
Create a ladder diagram and add variables................................................... 346
Assign values to the HSC variables ............................................................... 350
Assign variables and build the program ....................................................... 351
Test the program and run the High-Speed Counter................................. 352
Add a Programmable Limit Switch (PLS) function.......................................... 355
Example: Programmable Limit Switch (PLS) enabled ..................................... 356
Chapter 15
Input/Output instructions LCD .................................................................................................................................... 360

LCD_BKLT_REM (remote LCD backlight) ........................................................... 362
LCD_REM (remote LCD)............................................................................................ 364
RHC (read high speed clock) ........................................................................................ 368
RPC (read program checksum) ..................................................................................... 370
DLG (data log) ................................................................................................................. 371
IIM (immediate input) ................................................................................................... 373
IOM (immediate output) ............................................................................................... 375
KEY_READ (read keys on LCD) ................................................................................ 378
KEY_READ_REM (read keys for remote LCD) ..................................................... 381
MM_INFO (memory module information).............................................................. 383
MMINFO data type ................................................................................................ 386
MODULE_INFO ........................................................................................................... 387
MODULE_INFO - plug-in and expansion module information ................. 392
MODULE_INFO instruction timing diagrams ............................................... 394
PLUGIN_INFO (plug-in information) ..................................................................... 400
PLUGIN_READ (read plugin) .................................................................................... 403
PLUGIN_RESET (reset plugin) .................................................................................. 405
PLUGIN_WRITE ( write plugin) ............................................................................... 407

Table of contents
RCP (recipe) ..................................................................................................................... 409

RTC_READ ( read real-time clock) ............................................................................ 412
RTC_SET (set real-time clock) .................................................................................... 414
SYS_INFO ........................................................................................................................ 417
SYS_INFO data type ............................................................................................... 418
TRIMPOT_READ (read trimpot).............................................................................. 419
Trimpot ID definition ............................................................................................ 421
Chapter 16
Interrupt instructions STIS (select timed start) ................................................................................................. 423

UIC (clear interrupt lost bit) ......................................................................................... 425
UID (disable interrupt) .................................................................................................. 427
UIE (enable interrupt) .................................................................................................... 429
UIF (flush pending interrupt) ....................................................................................... 430
Chapter 17
Motion control instructions General rules for motion control function blocks ..................................................... 434
Motion control function block parameter details ..................................................... 436
Motion control axis states....................................................................................... 437
Motion control function block parameter numbers ......................................... 439
Motion control function block error IDs............................................................ 441
Axis error scenarios .................................................................................................. 442
AXIS_REF data type ............................................................................................... 443
FB_AXIS_REF data type ....................................................................................... 444
Axis variables ............................................................................................................. 445
MC_AbortTrigger (motion control abort trigger) ................................................... 445
MC_Halt (motion control halt)................................................................................... 448
MC_Home (motion control home) ............................................................................ 452
MC_MoveAbsolute (motion control move absolute) ............................................. 456
MC_MoveRelative (motion control move relative) ................................................. 461
MC_MoveVelocity (motion control move velocity)................................................ 466
MC_Power (motion control power) ........................................................................... 470
MC_ReadActualPosition (motion control read actual position) .......................... 474
MC_ReadActualVelocity (motion control read actual velocity) ........................... 479
MC_ReadAxisError (motion control read axis error) ............................................. 484
AxisErrorID error codes ......................................................................................... 487
MC_ReadBoolParameter (motion control read BOOL parameter) .................... 489
MC_ReadParameter (motion control read parameter) ........................................... 493
MC_ReadStatus (motion control read status)........................................................... 495
MC_Reset (motion control reset) ................................................................................ 501
MC_SetPosition (motion control set position) ........................................................ 503
MC_Stop (motion control stop) .................................................................................. 507
MC_TouchProbe (motion control touch probe) ..................................................... 510
MC_WriteBoolParameter (motion control write BOOL parameter) ................. 514

Table of contents
MC_WriteParameter (motion control write parameter)........................................ 518
Chapter 18
Process control instructions DERIVATE ...................................................................................................................... 523

FFL (FIFO load) .............................................................................................................. 525
FFL and FFU instruction timing diagrams ......................................................... 530
FFU (FIFO unload)......................................................................................................... 535
HYSTER (hysteresis) ...................................................................................................... 541
INTEGRAL ...................................................................................................................... 543
PWM (Pulse Width Modulation) ................................................................................ 549
SCALER (scale)................................................................................................................ 552
STACKINT (stack integers) ......................................................................................... 555
TND (abort current program) ...................................................................................... 558
LIMIT (limit test)............................................................................................................ 560
Chapter 19
Program control instruction SUS (suspend)................................................................................................................... 563
Chapter 20
Proportional Integral What is Proportional Integral Derivative (PID) control? ....................................... 565
IPIDCONTROLLER (proportionalintegralderivative controller) ................ 565
Derivative (PID) instruction
GAIN_PID data type .............................................................................................. 569
AT_Param data type................................................................................................ 570
How the IPIDController function block implements PID control .............. 571
IPIDController function block operation .......................................................... 572
Use the Proportional Integral Derivative instruction....................................... 574
Use auto-tune with the IPIDController function block .......................... 577
Auto-tune in first and second order systems ............................................... 577
Configure auto-tuning .................................................................................... 578
Use a Structured Timing Interrupt (STI) with auto-tuning ................... 583
Example: IPIDController with auto-tune .................................................. 583
Example: How to create a feedback loop for the manipulated value ..... 585
Example: How to add a UDFB to a PID program .................................... 586
Example: How to create an IPIDController program to control
temperature........................................................................................................ 587
Example: How to create an IPIDController program to control water
supply level ......................................................................................................... 589
PID (proportional-integral-derivative)........................................................................ 592
PID instruction state machine ............................................................................... 597
PID instruction timing diagrams .......................................................................... 598

Table of contents
Chapter 21
Real Time Clock (RTC) RTC_READ ( read real-time clock) ............................................................................ 605
RTC_SET (set real-time clock) .................................................................................... 607
instructions
Chapter 22
Socket instructions SOCKET_ACCEPT ...................................................................................................... 613

SOCKET_CREATE ...................................................................................................... 616
SOCKET_DELETE ....................................................................................................... 621
SOCKET_DELETEALL .............................................................................................. 624
SOCKET_INFO ............................................................................................................. 626
SOCKET_OPEN ............................................................................................................ 633
SOCKET_READ ............................................................................................................ 637
SOCKET_WRITE ......................................................................................................... 642
SOCKADDR_CFG data type ...................................................................................... 646
SOCK_STATUS data type ........................................................................................... 647
Socket error codes ............................................................................................................ 647
Socket instruction status bits ......................................................................................... 652
Socket instruction timing diagrams .............................................................................. 653
Socket instruction transaction diagrams ..................................................................... 660
Transactions for TCP Client......................................................................................... 660
Transactions for TCP Server ......................................................................................... 661
Transactions for UDP with Open Connection......................................................... 661
Transactions for UDP without Open Connections ................................................. 662
State machine diagrams for TCP .................................................................................. 663
State machine diagrams for UDP.................................................................................. 666
Chapter 23
String manipulation ASCII.................................................................................................................................. 669

CHAR (ASCII code to string character) .................................................................... 671
instructions
DELETE (delete sub-string) .......................................................................................... 673
FIND (find sub-string) ................................................................................................... 675
INSERT (insert string) ................................................................................................... 677
LEFT (extract left of a sting) ......................................................................................... 679
MID (extract middle of a string) ................................................................................... 681
MLEN (string length) ..................................................................................................... 683
RIGHT (extract right of a string) ................................................................................. 685
REPLACE (replace sub-string) ..................................................................................... 687
Chapter 24
Timer instructions Timer instruction configuration ................................................................................... 691

TOF (timer, off-delay) .................................................................................................... 692

Table of contents
TON (timer, on-delay) ................................................................................................... 694

TONOFF (time-delay, on, off) ..................................................................................... 696
TP (pulse timing) ............................................................................................................. 699
RTO (retentive timer, on-delay) ................................................................................... 701
DOY (check year for real-time clock) .......................................................................... 703
TDF (time difference) ..................................................................................................... 706
TOW (check week for real-time clock) ....................................................................... 708
Index

Preface
In This Manual This guide provides reference information about the instruction set available for
developing programs for use in Micro800 control systems. The instruction set
includes Structured Text (ST), Ladder Diagram (LD) Function Block Diagram
(FBD) programming language support. Additionally, the ladder elements
supported in Connected Components Workbench development environment are
defined.
Supported Controllers Connected Components Workbench includes configuration support for the
following Micro800 controllers.
2080-LC10-12AWA 2080-LC30-24QBB
2080-LC10-12DWD 2080-LC30-24QVB
2080-LC10-12QBB 2080-LC30-24QWB
2080-LC10-12QWB 2080-LC30-48AWB
2080-LC20-20AWB 2080-LC30-48QBB
2080-LC20-20QBB 2080-LC30-48QVB
2080-LC20-20QWB 2080-LC30-48QWB
2080-LC30-10QVB 2080-LC50-24AWB
2080-LC30-10QWB 2080-LC50-24QBB
2080-LC30-16AWB 2080-LC50-24QVB
2080-LC30-16QVB 2080-LC50-24QWB
2080-LC30-16QWB 2080-LC50-48AWB
2080-LC50-48QBB
2080-LC50-48QVB
2080-LC50-48QWB
Additional Resources These documents contain additional information concerning related Rockwell
Automation products.
Resource Description
Industrial Automation Wiring and Grounding Guidelines, Provides general guidelines for installing a Rockwell
publication 1770-4.1 available at Automation industrial system.
http://literature.rockwellautomation.com/idc/groups/lite
rature/documents/in/1770-in041_-en-p.pdf .

Preface
Resource Description
Product Certifications website, http://www.ab.com Provides declarations of conformity, certificates, and other
certification details.
You can view or download publications at

http://www.rockwellautomation.com/literature . To order paper copies of
technical documentation, contact your local Rockwell Automation distributor or
sales representative.
Legal Notices Copyright notice
2016 Rockwell Automation, Inc. All rights reserved. Printed in USA.
This document and any accompanying Rockwell Software products are

copyrighted by Rockwell Automation, Inc. Any reproduction and/or distribution
without prior written consent from Rockwell Automation, Inc. is strictly
prohibited. Please refer to the license agreement for details.
End User License Agreement (EULA)
You can view the Rockwell Automation End-User License Agreement ("EULA")
by opening the License.rtf file located in your product's install folder on your hard
drive.
Trademark Notices
Allen-Bradley, ControlLogix, CompactLogix, Connected Components

Workbench, FactoryTalk, Guardmaster, GuardShield 450L, Kinetix, Micro800,
MicroLogix, MicroLogix to Micro800 Conversion Tool, PowerFlex, PanelView,
PanelView Plus, PLC-2, PLC-3, PLC-5, Rockwell Automation, and Rockwell
Software are trademarks of Rockwell Automation, Inc.
Any Rockwell Automation software or hardware not mentioned here is also a

trademark, registered or otherwise, of Rockwell Automation, Inc.
Other Trademarks
Microsoft, Excel, Visual C++, SQL Server and Visual Studio are either registered
trademarks or trademarks of Microsoft Corporation in the United States and/or
other countries. Adobe, Reader, and Acrobat are either registered trademarks or
trademarks of Adobe Systems Incorporated in the United States and/or other
countries. OPC is either a registered trademark or trademark of OPC Foundation
in the United States and/or other countries. Kepware is either a registered
trademark or trademark of Kepware Technologies Corporation in the United
States and/or other countries. All other trademarks are the property of their
respective holders and are hereby acknowledged.
Preface
Warranty
This product is warranted in accordance with the product license. The products
performance may be affected by system configuration, the application being
performed, operator control, maintenance, and other related factors. Rockwell
Automation is not responsible for these intervening factors. The instructions in
this document do not cover all the details or variations in the equipment,
procedure, or process described, nor do they provide directions for meeting every
possible contingency during installation, operation, or maintenance. This
products implementation may vary among users.
This document is current as of the time of release of the product; however, the
accompanying software may have changed since the release. Rockwell Automation,
Inc. reserves the right to change any information contained in this document or
the software at any time without prior notice. It is your responsibility to obtain the
most current information available from Rockwell when installing or using this
product.
Environmental compliance
Rockwell Automation maintains current product environmental information on

its website at
http://www.rockwellautomation.com/rockwellautomation/about-us/sustainabili
ty-ethics/product-environmental-compliance.page
Contact Rockwell Automation
Customer Support Telephone 1.440.646.3434
Online Support http://www.rockwellautomation.com/support/

Chapter 1
Find information about instructions and ladder

elements
Connected Components Workbench includes a comprehensive instruction set

with structures and arrays, development environments for ladder logic, structured
text, function block diagram, and user-defined function block programs.
Additionally, Connected Components Workbench includes user-interface

configuration tools for Micro800 controllers, PowerFlex drives, a Safety Relay
device, PanelView Component graphic terminals, and serial and network
connectivity options.
For information about a specific instruction, including a description, parameter

details, and language examples, locate the instruction from the table of contents, or
from the following reference topics.
Instruction reference in alphabetical order on page 21
For a description of the ladder elements used in Connected Components

Workbench, see the following section:
Ladder Diagram (LD) language reference on page 29
Instruction blocks The Connected Components Workbench instruction set includes IEC 61131-3
compliant instruction blocks for Micro800 controllers. Instruction blocks
collectively include operators, functions and function blocks.
See also
Operators on page 17
Functions on page 18
Function blocks on page 19
Operators The Connected Components Workbench instruction set includes IEC 61131-3
compliant instruction blocks for Micro800 controllers; operators are included in
the Connected Components Workbench instruction set.

Chapter 1 Find information about instructions and ladder elements
An operator is a basic logical operation such as arithmetic, boolean, comparator, or

data conversion.
See also
Functions Functions have one or more input parameters and one output parameter.
Instruction block format
An instruction block is represented by a single rectangle, and has a fixed number of

input connection points and output connection points. An elementary instruction
block performs a single function.
Item Item Description

No.
Block name The name of the function to be performed by the instruction block is written inside its
rectangle shape (at the top).
Input Each input of an instruction block is labeled and has a defined type.
Input connection Inputs are connected on the left border.
Output Each output of an instruction block is labeled and has a defined type.
Output Outputs are connected on the right border.

connection
Calling a function
Connected Components WorkbenchTM does not support recursive function calls.

When a function of the Functions section is called by itself or one of its called
functions, a run-time error occurs. Furthermore, functions do not store the local
values of their local variables. Since functions are not instantiated, they cannot call
function blocks.
A function can be called by a program, by a function, or by a function block.

Find information about instructions and ladder elements Chapter 1
Any program of any section can call one or more functions. A function can
have local variables.
A function has no instance meaning local data is not stored and so is usually
lost from one call to the other.
Because the execution of a function is driven by its parent program, the
execution of the parent program is suspended until the function ends.
Main program Function Function
Defining function and parameter names
The interface of a function must be explicitly defined with a type and a unique
name for each of its calling (input) parameters or return (output) parameters. A
function has one return parameter. The value of a return parameter for a function
block is different for each programming language (FBD, LD, ST).
Function names and function parameter names can use up to 128 characters.
Function parameter names can begin with a letter or an underscore followed by
letters, numbers, and single underscores.
See also
Function blocks A function block is an instruction block that has input and output parameters and
works on internal data (parameters). It can be written in Structured Text, Ladder
Diagram, or Function Block Diagram languages.

Instruction block format
An instruction block is represented by a single rectangle, and has a fixed number of

input connection points and output connection points. An elementary instruction
block performs a single function.
Item Item Description

No.
Block name The name of the function to be performed by the instruction block is written inside its
rectangle shape (at the top).
Input Each input of an instruction block is labeled and has a defined type.
Input connection Inputs are connected on the left border.
Output Each output of an instruction block is labeled and has a defined type.
Output Outputs are connected on the right border.

connection
Calling a function block
When a function block is called in a program, an instance of the block is actually

called. The instance uses the same code, but the input and output parameters are
instantiated, which means local variables are copied for each instance of the
function block. The values of the variables of a function block instance are stored
from one cycle to the other.
A function block can be called by a program, or by another function block. They

cannot be called by functions because functions are not instantiated.
Defining function block and parameter names
The interface of a function block must be explicitly defined with a type and a
unique name for each of its calling (input) parameters or return (output)
parameters. Function blocks can have more than one output parameter. The value
of a return parameter for a function block is different for each programming
language (FBD, LD, ST).

Function block names and function block parameter names can use up to 128
characters. Function block parameter names can begin with a letter or an
underscore followed by letters, numbers, and single underscores.
See also
Instruction set in The following table lists the Micro800 controller instructions available in
Connected Components Workbench in alphabetical order.
alphabetical order
Instruction Category Type Description
ABL on page 117 Communications Function block Counts the number of characters in the buffer up to
and including end of line character.
ABS on page 72 Arithmetic Function Returns the absolute value of a Real value.
ACB on page 119 Communications Function block Counts the total number of characters in the buffer.
ACL on page 122 Communications Function block Clears the receive and transmit buffers.
ACOS on page 73 Arithmetic Function Calculates the arc-cosine of a Real value.
ACOS_LREAL on page 75 Arithmetic Function Calculates the arc-cosine of a Long Real value.
Addition on page 77 Arithmetic Operator Adds two or more Integer, Real, Time, or String
values.
AHL on page 124 Communications Function block Sets or resets modem handshake lines.
AND on page 173 Boolean operations Operator Performs a boolean AND operation between two or
more values.
AND_MASK on page 143 Binary operations Function Performs a bit to bit AND between two Integer
values.
ANY_TO_BOOL on page 279 Data conversion Function Converts a non-Boolean value to a Boolean.
ANY_TO_BYTE on page 280 Data conversion Function Converts a value to a Byte.
ANY_TO_DATE on page 282 Data conversion Function Converts a String, Integer, Real, or Time data type to
Date data type.
ANY_TO_DINT on page 283 Data conversion Function Converts a value to a Double Integer.
ANY_TO_DWORD on page Data conversion Function Converts a value to a Double Word value.
284
ANY_TO_INT on page 286 Data conversion Function Converts a value to an Integer.
ANY_TO_LINT on page 287 Data conversion Function Converts a value to a Long Integer.
ANY_TO_LREAL on page 288 Data conversion Function Converts a value to a Long Real.
ANY_TO_LWORD on page Data conversion Function Converts a value to a Long Word.
289
ANY_TO_REAL on page 290 Data conversion Function Converts a value to a Real.
ANY_TO_SINT on page 291 Data conversion Function Converts a value to a Short Integer.
ANY_TO_STRING on page Data conversion Function Converts a value to a String.
292
ANY_TO_TIME on page 294 Data conversion Function Converts a value to the Time data type.


ANY_TO_UDINT on page Data conversion Function Converts a value to an Unsigned Double Integer.
295
ANY_TO_UINT on page 296 Data conversion Function Converts a value to an Unsigned Integer.
ANY_TO_ULINT on page 298 Data conversion Function Converts a value to an Unsigned Long Integer.
ANY_TO_USINT on page 299 Data conversion Function Converts a value to an Unsigned Short Integer.
ANY_TO_WORD on page Data conversion Function Converts a value to a Word.
300
ARD on page 127 Communications Function block Reads characters from the input buffer and places
them into a string.
ARL on page 130 Communications Function block Reads one line of characters from the input buffer and
places them into a string.
ASCII on page 669 String manipulation Function Returns the ASCII code for characters in a string.
Character -> ASCII code.
ASIN on page 78 Arithmetic Function Calculates the arcsine of a Real value.
ASIN_LREAL on page 80 Arithmetic Function Calculates the arcsine of a Long Real value.
ATAN on page 82 Arithmetic Function Calculates the arctangent of a Real value.
ATAN_LREAL on page 83 Arithmetic Function Calculates the arctangent of a Long Real value.
AVERAGE on page 303 Data Manipulation Function block Calculates a running average over a number of a
defined samples.
AWA on page 133 Communications Function Writes a string with two appended (user-configured)
characters to an external device.
AWT on page 135 Communications Function Writes characters from a source string to an external
device.
BSL on page 145 Binary operations Function block Shifts a bit in an array element to the left.
BSR on page 149 Binary operations Function block Shifts a bit in an array element to the right.
CHAR on page 671 String manipulation Function Returns a one character string for an ASCII code. ASCII
code -> character.
COP on page 305 Data conversion Function block Copies the binary data in the source element to the
destination element.
COS on page 85 Arithmetic Function Calculates the cosine of a Real value.
COS_LREAL on page 87 Function Calculates the cosine of a Long Real value.
CTD on page 271 Counter Function Counts integers from a given value down to 0, 1 by 1.
CTU on page 273 Counter Function Counts integers from 0 up to a given value, 1 by 1.
CTUD on page 275 Counter Function Counts integers from 0 up to a given value, 1 by 1, or
from a given value down to 0, 1 by 1.
DELETE on page 673 String manipulation Function Deletes characters from a string.
DERIVATE on page 523 Process Control Function block Differentiation of a real value over a defined cycle
time.
Division on page 88 Arithmetic Operator Division of two Integer or Real values.
DLG on page 371 Input/Output Function Block Writes variable values from the run-time engine into
a Data Logging File on an SD Card.
DOY on page 703 Time Function Turn on an output if the value of the real-time clock is
in the range of the Year Time setting.
Equal on page 257 Compare Operator Tests whether one value is equal to another.


EXPT on page 90 Arithmetic Function Calculates the Real value of a base number raised to
the power of the Integer exponent.
FFL on page 535 Process Control Function Block Loads 8 bit, 16 bit, 32 bit, or 64 bit data into a
user-created array called a FIFO stack.
FFU on page 535 Process Control Function Block Unloads 8 bit, 16 bit, 32 bit, or 64 bit data from a
user-created array called a FIFO (first in first out) stack
in the same order data was loaded using the FFL
instruction.
FIND on page 675 String manipulation Function Locates and provides the position of sub-strings
within strings.
F_TRIG on page 167 Boolean operations Function block Detects a falling edge of a Boolean variable.
Greater Than on page 260 Compare Operator Compares Integer, Real, Time, Date, and String input
values to determine whether the first is greater than
the second.
Greater Than or Equal Compare Operator Compares Integer, Real, Time, Date, and String input
on page 262 values to determine whether the first is greater than
or equal to the second.
HSC on page 318 Input/Output Function block HSC applies high presets, low presets and output
source values to the high-speed counter.
HSC_SET_STS on page 335 Input/Output Function block HSC_SET_STS manually sets or resets the HSC
counting status.
HYSTER on page 541 Process Control Function block Boolean hysteresis on difference of reals.
IIM on page 373 Input/Output Function block Updates inputs prior to normal output scan.
INSERT on page 677 String manipulation Function Inserts sub-strings at user-defined positions within
strings.
INTEGRAL on page 543 Process Control Function block Integrates a real value during the defined cycle time.
IOM on page 375 Input/Output Function block Updates outputs prior to normal output scan.
IPIDCONTROLLER on page Process Control Function block Configure and control the inputs and outputs used for
565 the Proportional Integral Derivative (PID) logic.
KEY_READ on page 378 Input/Output Function block Micro810 only.
Reads the Key status on the optional LCD module
when the user display is active.
KEY_READ_REM on page Input/Output Function block Micro820 only.
381 Reads the Key status on the optional Remote LCD
module when the user display is active.
LCD on page 360 Input/Output Function Micro810 only.
Displays a string or number on an LCD screen.
LCD_BKLT_REM on page Input/Output Function Sets the Remote LCD backlight parameters in a user
362 program.
LCD_REM on page 364 Input/Output Function Displays user defined messages for the Remote LCD.
LEFT on page 679 String manipulation Function Extracts characters from the left side of a string.
Less Than on page 264 Compare Operator Compares Integer, Real, Time, Date, and String input
values to determine whether the first is less than the
second.
Less Than or Equal on page Compare Operator Compares Integer, Real, Time, Date, and String input
266 values to determine whether the first is less than or
equal to the second.


LIM_ALRM on page 67 Alarm Function block An alarm with hysteresis on a Real value for high and
low limits.
LIMIT on page 560 Process Control Function Restricts integer values to a given interval.
LOG on page 92 Arithmetic Function Calculates the logarithm (base 10) of a Real value.
MAX on page 313 Function Calculates the maximum of two integer values.
MC_AbortTrigger on page Motion Function block Aborts Motion function blocks that are connected to
445 trigger events.
MC_Halt on page 448 Motion Function block Commands a controlled motion stop under normal
operating conditions.
MC_Home on page 452 Motion Function block Commands the axis to perform the <search home>
sequence.
MC_MoveAbsolute on page Motion Function block Commands a controlled motion to a specified
456 absolute position.
MC_MoveRelative on page Motion Function block Commands a controlled motion of a specified
461 distance relative to the actual position at the time of
the execution.
MC_MoveVelocity on page Motion Function block Commands a never ending controlled motion at a
466 specified velocity.
MC_Power on page 470 Motion Function block Control the power stage, ON or OFF.
MC_ReadActualPosition Motion Function block Returns the actual position of the feedback axis.
on page 479
MC_ReadActualVelocity Motion Function block Returns the actual velocity of the feedback axis.
on page 479
MC_ReadAxisError on page Motion Function block Reads the axis errors not related to the Motion
484 control instruction blocks.
MC_ReadBoolParameter Motion Function block Returns the value of a vendor specific parameter of
on page 489 type BOOL.
MC_ReadParameter on page Motion Function block Returns the value of a vendor specific parameter of
493 type Real.
MC_ReadStatus on page 495 Motion Function block Returns the status of the axis with respect to the
motion currently in progress.
MC_Reset on page 501 Motion Function block Transitions the axis state from ErrorStop to StandStill
by resetting all internal axis-related errors.
MC_SetPosition on page 503 Motion Function block Shifts the coordinate system of an axis by
manipulating the actual position.
MC_Stop on page 507 Motion Function block Commands a controlled motion stop and transfers the
axis state to Stopping.
MC_TouchProbe on page Motion Function block Records an axis position at a trigger event.
510
MC_WriteBoolParameter Motion Function block Modifies the value of a vendor specific parameter of
on page 514 type Bool.
MC_WriteParameter Motion Function block Modifies the value of a vendor specific parameter of
on page 518 type Real.
MID on page 681 String manipulation Function Extracts characters from the middle of a string.
MIN on page 311 Function Calculates the minimum of two integer values.
MLEN on page 683 String manipulation Function Calculates the length of a string.
MM_INFO on page 383 Input/Output Function block Reads memory module header information.


MODULE_INFO on page 387 Input/Output Function block Reads module information from a plug-in module or
an expansion module.
MOD on page 94 Arithmetic Function Performs a Modulo calculation on Integer values.
MOV on page 96 Arithmetic Operator Assigns the input value to the output.
MSG_CIPGENERIC on page Communications Function Sends a CIP generic explicit message.
189
MSG_CIPSYMBOLIC on page Communications Function Sends a CIP symbolic explicit message.
200
MSG_MODBUS on page 204 Communications Function Sends a Modbus message.
MSG_MODBUS2 on page Communications Function Sends a MODBUS/TCP message over an Ethernet
211 Channel.
Multiplication on page 97 Arithmetic Operator Multiplies two or more Integer or Real values.
MUX4B on page 184 Boolean Function Multiplexer between four BOOL inputs, outputs a
BOOL value.
MUX8B on page 180 Boolean Function Multiplexer between eight BOOL inputs, outputs a
BOOL value.
NOT on page 175 Boolean operations Operator Converts Boolean values to negated values.
Not Equal on page 268 Compare Operator Compares Integer, Real, Time, Date, and String input
values to determine whether the first is not equal to
the second.
Neg on page 99 Arithmetic Operator Converts a value to a negative.
NOT_MASK on page 152 Binary operations Function Integer bit-to-bit negation mask, inverts a parameter
value.
OR_MASK on page 154 Binary operations Function Integer OR bit-to-bit mask, turns bits on.
OR on page 172 Boolean operations Operator Boolean OR of two or more values.
PID on page 592 Process Control Function block An output instruction that controls physical
properties such as temperature, pressure, liquid level,
or flow rate using process loops.
PLUGIN_INFO on page 400 Input/Output Function block Gets module information from a generic plug-in
module (excluding Memory Module).
PLUGIN_READ on page 403 Input/Output Function block Reads data from a generic plug-in module (excluding
Memory Module).
PLUGIN_RESET on page 405 Input/Output Function block Resets a generic plug-in module, hardware reset
(excluding Memory Module).
PLUGIN_WRITE on page 407 Input/Output Function block Writes data to a generic plug-in module (excluding
Memory Module).
POW on page 100 Arithmetic Function Calculates the value of a Real number raised to a
power of the Real exponent.
PWM on page 549 Process Control Function block Turns the PWM (Pulse Width Modulation) output for
a configured PWM channel ON or OFF.
R_TRIG on page 169 Boolean operations Function block Detects a rising edge of a Boolean variable.
RAND on page 102 Arithmetic Function Calculates random integer values from a defined
range.
REPLACE on page 687 String manipulation Function Replaces parts of a string with new sets of characters.


RCP on page 409 Input/Output Function block Reads and writes recipe data to and from an SD
memory card.
RHC on page 368 Input/Output Function Reads high-speed clock.
RIGHT on page 685 String manipulation Function Extracts characters from the right side of a string.
ROL on page 156 Binary operations Function For 32-bit integers, rotates integer bits to the left.
ROR on page 158 Binary operations Function For 32-bit integers, rotates integer bits to the right.
RPC on page 370 Input/Output Function Reads user program checksum.
RS on page 171 Boolean operations Function block Reset dominant bistable.
RTC_READ on page 412 Input/Output Function block Reads the real-time clock (RTC) module information.
RTC_SET on page 414 Input/Output Function block Sets RTC (real-time clock) data to the RTC module
information.
RTO on page 701 Time Function block Retentive timing. Increases an internal timer when
input is active, but does not reset the internal timer
when input changes to inactive.
SCALER on page 552 Process Control Function block Scales the input value according to output range.
SHL on page 160 Binary operations Function For 32-bit integers, moves integers to the left and
places 0 in the least significant bit.
SHR on page 162 Binary operations Function For 32-bit integers, moves integers to the right and
places 0 in the most significant bit.
SIN on page 104 Arithmetic Function Calculates the sine of a Real value.
SIN_LREAL on page 106 Arithmetic Function Calculates the sine of a Long Real value.
SOCKET_ACCEPT on page Communications Function block Accepts a TCP connection request from a remote
613 destination and returns a socket instance used to
send and receive data on the newly created
connection.
SOCKET_CREATE on page Communications Function block Creates an instance of the socket and returns an
616 instance number that is used as an input in any
follow-on socket operations.
SOCKET_DELETE on page Communications Function block Deletes a created socket instance.
621
SOCKET_DELETEALL on page Communications Function block Deletes all created socket instances.
624
SOCKET_INFO on page 626 Communications Function block Returns information for the socket such as error codes
and execution status.
SOCKET_OPEN on page 633 Communications Function block Opens the connection for the specified destination
address for Transmission Control Protocol (TCP)
connections. For User Datagram Protocol (UDP)
connections, associates a destination IP address and
port number with the specified socket.
SOCKET_READ on page 637 Communications Function block Reads data on a socket.
SOCKET_WRITE on page 642 Communications Function block Sends data on a socket.
SQRT on page 107 Arithmetic Function Calculates the square root of a Real value.
SR on page 175 Boolean operations Function block Set dominant bistable.
STACKINT on page 555 Process Control Function block Manages stack of integers.
STIS on page 423 Interrupt Function Starts the selected timed user interrupt (STI ) timer
from the control program rather than starting
automatically.


Subtraction on page 109 Arithmetic Operator Subtracts one Integer, Real or Time value from
another Integer, Real or Time value.
SUS on page 563 Program Control Function block Suspends the execution of the <M800 controller>.
SYS_INFO on page 417 Input/Output Function block Reads the status data block for the Micro800
controller.
TAN on page 111 Arithmetic Function Calculates the tangent of a Real value.
TAN_LREAL on page 112 Arithmetic Function Calculates the tangent of a Long Real value.
TDF on page 706 Time Function Computes the time difference between TimeA and
TimeB.
TND on page 558 Process Control Function Stops the current cycle of the user program scan.
TOF on page 692 Time Function block Off-delay timing. Increases an internal timer up to a
given value.
TON on page 694 Time Function block On-delay timing. Increases an internal timer up to a
given value.
TONOFF on page 696 Time Function block Delay turning on an output on a true rung, and then
delay turning off the output on the false rung.
TOW on page 708 Time Function Turns on an output if the value of the real-time clock
is in the range of the Time of Week setting.
TP on page 699 Time Function block Pulse timing. On a rising edge, increases an internal
timer up to a given value.
TRIMPOT_READ on page 419 Input/Output Function block Reads the trimpot value from a specific trimpot.
TRUNC on page 114 Arithmetic Function Truncates Real values, leaving just the Integer.
TTABLE on page 177 Boolean Function Provides the value of the output based on the
combination of inputs.
UIC on page 425 Interrupt Function Clears the lost bit for the selected user interrupt.
UID on page 427 Interrupt Function Disables a specific user interrupt.
UIE on page 429 Interrupt Function Enables a specific user input.
UIF on page 430 Interrupt Function Flushes or removes a pending user input.
XOR_MASK on page 164 Binary operations Function Integer exclusive OR bit-to-bit mask, returns inverted
bit values.
XOR on page 174 Boolean operations Operator Boolean exclusive OR of two values.
See also
Finding information about instructions and ladder elements on page 17

Chapter 2
Ladder Diagram (LD) language
A Ladder Diagram (LD) is a graphical representation of Boolean equations that

combines contacts (input arguments) with coils (output results). Using graphic
symbols in a program chart (organized like a relay ladder wiring diagram), the LD
language describes the tests and modifications of Boolean data.
LD graphic symbols are organized within the chart as an electrical contact

diagram. The term "ladder" comes from the concept of rungs connected to vertical
power rails at both ends where each rung represents an individual circuit.
Connected Components Workbench provides an LD language editor and

supports the elements and instructions that are supplied with the Connected
Components Workbench software only.
See also
Ladder Diagram (LD) elements on page 33
LD program development environment on page 30
Work with elements in the LD language editor on page 59
A Ladder Diagram (LD) is a graphical representation of Boolean equations that

Ladder Diagram (LD)
combines contacts (input arguments) with coils (output results). Using graphic
program symbols in a program chart (organized like a relay ladder wiring diagram), the LD
language describes the tests and modifications of Boolean data.
The LD language uses graphic symbols in a program chart, organized like a relay
ladder wiring diagram, to describe the tests and modifications of Boolean data.
Connected Components Workbench provides a Ladder Diagram language editor

that supports the elements and instructions that are supplied with the Connected
Components Workbench software only.
See also

Chapter 2 Ladder Diagram (LD) language
Ladder Diagram (LD) program examples on page 61
LD program development The following illustration shows the language editor for a Ladder Diagram (LD)
program where you develop an LD Program Organizational Unit (POU). Use the
environment LD language editor menu, LD Toolbox, LD keyboard shortcuts, or
the Multi-language Editor located on the Tools menu to add elements to your
LD POU.
Example: LD language editor menu

Ladder Diagram (LD) language Chapter 2
Example: LD Toolbox
See also
LD Keyboard shortcuts on page 62

Chapter 3
Ladder Diagram (LD) elements
Ladder Diagram (LD) elements are the components used to build a ladder
diagram program. All the elements listed in the following table can be added to a
ladder diagram program within Connected Components Workbench.
Element Description
Rung on page 33 Represents a group of circuit elements that lead to the activation of a coil.
Instruction Block (LD) Instructions include operators, functions, and function blocks including user-defined function
on page 41 blocks.
Branch on page 38 Two or more instructions in parallel.
Coil on page 41 Represents the assignment of outputs or internal variables. In an LD program, a coil represents
an action.
Contact on page 50 Represents the value or function of an input or internal variable.
Return on page 57 Represents the conditional end of a diagram output.
Jump on page 58 Represents the conditional and unconditional logic in the LD program that control the control the
execution of diagrams.
See also
Ladder Diagram (LD) language on page 29
Rung Rungs are graphic components of Ladder Diagram (LD) programs that represent
a group of circuit elements that lead to the activation of a coil. Use labels to
identify rungs within the diagram. Labels, along with jumps, control the execution
of a diagram. Comments are free-format text you can add above the rung for
documentation purposes.
See also
Add a rung to an LD program on page 33
Add a label to a rung on page 35
LD program on page 29
Add a rung to a LD program Rungs are graphic components of a Ladder Diagram (LD) program that represent
a group of circuit elements that lead to the activation of a coil.

Chapter 3 Ladder Diagram (LD) elements
In Connected Components Workbench you can add a rung to a Ladder Diagram

(LD) program from the:
Language Diagram (LD) language editor

Multi-language Editor located on the Tools menu
LD Toolbox
To add a rung element to a Ladder Diagram program:
1. In the LD language editor, right-click an existing rung and then either:
Click Copy, and then click Paste to insert a copy of the rung into the
language editor.
Click Insert Rung, and then either:
Click Above to add the rung above the selected rung.
Click Below to add the rung below the selected rung.
Select a rung or an element in the LD language editor, and then press either:

Ladder Diagram (LD) elements Chapter 3
CTRL+ALT+0 - to add the rung above the selected rung.

CTRL+0 - to add the rung below the selected rung.
Click Tools > Multi-language Editor > Insert Rung Below to add
the rung below the selected rung.
Click Tools > Multi-language Editor > Insert Rung Above to add
the rung above the selected rung.
2. (optional) Open the LD Toolbox to show the rung element,
To insert a rung below an existing rung, select the rung in the LD

language editor and then double-click Rung in the LD Toolbox.
If an element is not selected prior to double-clicking Rung in the
LD Toolbox, the rung is inserted below the last rung in the LD
language editor.
Select Rung and then drag the element into the LD language editor.
A plus sign (+) appears in the LD language editor to show a valid
target. Release the mouse button to add the element.
Tip: If the ladder diagram contains more than 355 rungs, use the down triangle rather than the scroll bar to view
additional rungs.
See also
Rungs on page 33
Rung labels Labels are optional additions for every rung in the Ladder Diagram (LD) language
editor.
Labels can be an unlimited number of characters, beginning with a letter or

underscore character followed by letters, numbers, and underscore characters.
Labels cannot have spaces or special characters (for example, +, -, or \).

To add a label for a rung in the LD language editor:
1. To add a label to a rung, right-click the rung to open the LD language editor
menu, and then select Display Label.
The rung updates to include the label and the LD language editor menu
shows a checkmark next to Display Label.
2. Select the Label, and type a description.
3. (optional) To remove the label, click Display Label from the LD language
editor menu.
See also
Rungs on page 33
Rung comments Comments are optional for every rung in the Ladder Diagram (LD) language
editor. By default, a comment is included when you add a rung element in the LD
language editor.

Comments are:
Entered in the space above the rung.

Saved in rich text format.
Stored in the controller.
To add or remove a comment for a rung in the LD language editor:
1. To remove a comment, right-click the rung to open the LD language editor

menu.
2. From the LD language editor menu, click Display Comment. The

comment is removed from the rung and the check mark next to Display
Comment on the LD language editor menu is removed.
3. (optional) To add a comment to a rung, click Display Comment from the

LD language editor menu.
See also
Add a rung to an LD program on page 33

Rungs on page 33
Branch Branches create alternative routing for connections. You can add parallel branches
to elements on a rung using the Ladder Diagram (LD) language editor.
Branch example
See also
Add a branch to a LD program on page 38
Add a branch to a LD program Branches are graphic components of Ladder Diagram (LD) programs that create
alternative routing for connections and may include parallel branches.
In Connected Components Workbench you can add a branch to a Ladder

Diagram (LD) program from the:
Ladder Diagram (LD) language editor

LD Toolbox
To add a branch to a Ladder Diagram program:
1. In the LD language editor, verify the LD program has a defined rung for the
branch. Then do one of the following:

Right-click a rung or an element in the LD language editor,

select Insert Ladder Elements and then click Branch.
If the Variable Selector opens, select a variable or click OK without
selecting a variable to add the Branch element.
Select a rung or element in the LD language editor and then press either:
CTRL+ALT+1 to add the branch to the left of the selected element
or rung.
CTRL+1 to add the branch to the right of the selected element.
Select a rung or an element in the LD language editor and then either:
Click Tools > Multi-language Editor > Insert Branch Before to
add the branch to the left of the selected element.
Click Tools > Multi-language Editor > Insert Branch After to
add the branch to the right of the selected element.
Open the LD Toolbox to show the branch element and then either:
Double-click the branch element to add it to the LD language editor.
Drag the branch element into the LD language editor and position it
on the rung.


2. (optional) To insert a parallel branch:
a. In the LD language editor, right-click the branch to open the LD

language editor menu.
b. From the LD language editor menu, select Insert Branch and then
click either:
Above to add a branch above the selected branch.
Below to add the branch below the selected branch.
3. (optional) To move a branch element to another location in a LD program,

select the element and drag the element to new a location in the LD
program.

A plus sign (+) appears in the LD language editor to show a valid target.
Release the mouse button to insert the element in the target location.
See also
Branch on page 38
Instruction Block (LD) A Ladder Diagram (LD) Instruction Block element is a IEC 61131-3 compliant
functional element in a LD program that can be a function block, a function, a
user-defined function block, a user-defined function, or an operator.
See also
Add an instruction block to a LD program on page 33
Ladder Diagram (LD) program on page 29
Coils are graphic components of Ladder Diagram (LD) programs that represent
Coil
the assignment of an output or of an internal variable. In LD programs, a coil
represents an action. A coil must be connected on the left to a Boolean symbol,
such as a contact, or to a Boolean output of an instruction block. Coils can only be
added to a defined rung in the LD language editor. The coil definition can be
modified after the coil is added to the rung.
The following example shows the coil element types available for Ladder Diagram
programs.

Example: Coils
See also
Add coil elements on page 42
Direct coil on page 45
Reverse coil on page 45
Pulse rising edge coil on page 47
Pulse falling edge coil on page 46
Set coil on page 48
Reset coil on page 49
Add coil elements Coils are graphic components of Ladder Diagram (LD) programs that represent
an action taken an output or of an internal variable.
In Connected Components Workbench you can add a coil to a Ladder Diagram

(LD) program from the:

LD Toolbox

To add a coil element to a Ladder Diagram program:
coil. Then do one of the following:

select Insert Ladder Elements and then click Direct Coil.
If the Variable Selector opens, select a variable or click OK without
selecting a variable to add the Direct Coil element.
Select a rung or an element in the LD language editor, and then

press CTRL+4 to add the Direct Coil to the right side of the rung.
Select a rung or an element in the LD language editor, and then click Tools
> Multi-language Editor > Insert Coil to add the coil to the right side of
the rung.
Open the LD Toolbox to show the coil elements (Direct Coil, Reverse
Coil, Set Coil, Reset Coil, Pulse Rising Edge Coil, Pulse Falling Edge
Coil) and then either:
Double-click the coil element to add it to the LD language editor.
Drag the coil element into the LD language editor and position it on
the rung.


2. (optional) To insert a parallel coil,
a. In the LD language editor, verify the LD program has a defined

branch and then right-click the top level of the branch to open
the LD language editor menu.
b. From the LD language editor menu, select Insert Ladder

Elements and then click Direct Coil. The element is inserted on
the top level of the branch.
c. Right-click the bottom level of the branch to open the LD

d. From the LD language editor menu, select Insert Ladder
Elements and then click Direct Coil. The element is inserted on
the bottom level of the branch.
3. (optional) To change the type of coil, in the LD language editor select the
coil, and then press the space bar until the coil type displays in the language
editor.
Every time the space bar is pressed the coil type changes from direct, to
reverse, to set, to reset, to pulse rising edge, to pulse falling edge.

See also
Branch on page 38
Coils on page 41
LD Keyoard shortcuts on page 62
Direct Coil Coils are graphic components of Ladder Diagram (LD) programs that represent
the assignment of an output or of an internal variable.
A direct coil supports a Boolean output of a connection line Boolean state.
The associated variable is assigned with the Boolean state of the left connection.
The state of the left connection is propagated into the right connection. The right
connection must be connected to the right vertical power rail (unless you have
parallel coils, where only the upper coil must be connected to the right vertical
power rail).
The associated Boolean variable must be an output or it must be user-defined.
Direct coil example
See also
Coils on page 41
Reverse Coil on page 45
Reverse Coil Coils are graphic components of Ladder Diagram (LD) programs that represent

A reverse coil element supports a Boolean output according to the Boolean

negation of a connection line state.
The associated variable is assigned with the Boolean negation of the state of the
left connection. The state of the left connection is propagated into the right
connection. The right connection must be connected to the right vertical power
rail (unless you have parallel coils, where only the upper coil must be connected to
the right vertical power rail).
The associated Boolean variable must be output or it must be user-defined.
Reverse Coil example
See also
Coils on page 41
Direct Coil on page 45
Pulse Falling Edge Coil Coils are graphic components of Ladder Diagram (LD) programs that represent
Pulse falling edge (or negative) coils support a Boolean output of a connection line
Boolean state.

The associated variable is set to TRUE when the Boolean state of the left
connection falls from TRUE to FALSE. The output variable resets to FALSE in
all other cases. The state of the left connection is propagated into the right
Pulse Falling Edge Coil example
See also
Coils on page 41
Pulse rising edge coil on page 47
Pulse Rising Edge Coil Coils are graphic components of Ladder Diagram (LD) programs that represent
Pulse rising edge (or positive) coils support a Boolean output of a connection line
Boolean state.
connection rises from FALSE to TRUE. The output variable resets to FALSE in
all other cases. The state of the left connection is propagated into the right
The associated Boolean variable must be output or user-defined.

Pulse Rising Edge Coil example
See also
Coils on page 41
Pulse Falling Edge Coil on page 46
Set Coil Coils are graphic components of Ladder Diagram (LD) programs that represent
the assignment of an output or of an internal variable. In LD programs, a coil
represents an action.
Set coils support a Boolean output of a connection line Boolean state.
connection becomes TRUE. The output variable keeps this value until an inverse
order is made by a Reset coil. The state of the left connection is propagated into
the right connection. The right connection must be connected to the right vertical
power rail (unless you have parallel coils, where only the upper coil must be
connected to the right vertical power rail).

Set Coil example
See also
Coils on page 41
Reset Coil on page 49
Reset Coil Coils are graphic components of Ladder Diagram (LD) programs that represent
Reset coils support a Boolean output of a connection line Boolean state.
The associated variable is reset to FALSE when the Boolean state of the left
connection becomes TRUE. The output variable keeps this value until an inverse
order is made by a Set coil. The state of the left connection is propagated into the
right connection. The right connection must be connected to the right vertical
power rail (unless you have parallel coils, where only the upper coil must be
connected to the right vertical power rail).
The associated Boolean variable must be output or user-defined.

Reset Coil example
See also
Coils on page 41
Set Coil on page 48
Contact Contacts are graphic components of Ladder Diagram (LD) programs. Depending
on the type, a contact represents the value or function of an input or of an internal
variable. Contacts can only be added to a defined rung in the LD language editor.
After a contact is added, its definition can be modified.
The following example shows the contact element types available for Ladder
Diagram programs.
Example: Contacts
See also
Add contact elements on page 51
Direct contact on page 54
Reverse contact on page 54

Pulse rising edge contact on page 55
Pulse falling edge contact on page 56
Add a contact to a LD program Contacts are graphic components of a Ladder Diagram (LD) program. Depending
on the type, a contact represents the value or function of an input or of an internal
variable. Contacts can only be added to a defined rung in the LD language editor.
In Connected Components Workbench you can add a contact to a Ladder

Diagram (LD) program from the:

LD Toolbox
To add a contact element to a Ladder Diagram program:
contact. Then do one of the following:


select Insert Ladder Elements and then click Direct Contact.
If the Variable Selector opens, select a variable or click OK
without selecting a variable to add the Direct Contact element.
CTRL+ALT+3 to add the Direct Contact element to the left side of
the selected element or the rung.
CTRL+3 to add the Direct Contact element to the right side of the
selected element or the rung.
Select a rung or an element in the LD language editor and then either:
Click Tools > Multi-language Editor > Insert Contact Before to
add the contact to the left side of the selected element or rung.
Click Tools > Multi-language Editor >Insert Contact After to
add the contact to the right side of the selected element or rung.
Open the LD Toolbox to show the contact elements (Direct
Contact, Reverse Contact, Pulse Rising Edge Contact, Pulse Falling
Edge Contact) and then either:
Double-click the contact element to add it to the LD language editor.
Drag the contact element into the LD language editor and position it
on the rung.

2. (optional) To insert a parallel contact:
a. In the LD language editor, verify the LD program has a defined

branch and then right-click the top level of the branch to open
the LD language editor menu.
b. From the LD language editor menu, select Insert Ladder

Elements and then click Direct Contact. The element is
inserted on the top level of the branch.
c. Right-click the bottom level of the branch to open the LD

d. From the LD language editor menu, select Insert Ladder
Elements and then click Direct Contact. The element is
inserted on the bottom level of the branch.
3. (optional) To change the type of contact, in the language editor select the
contact, and then press the space bar until the the contact type displays in
the language editor.
Every time the space bar is pressed the contact type changes from direct,
to reverse, to pulse rising edge, to pulse falling edge.

See also
Branch on page 38
Contacts on page 50
Direct Contact Contacts are graphic components of Ladder Diagram (LD) programs.
Direct contacts support a Boolean operation between a connection line state and a
Boolean variable.
The state of the connection line on the right of the contact is the logical AND
between the state of the left connection line and the value of the variable
associated with the contact.
Direct Contact example
See also
Add a contact element on page 51
Contacts on page 50
Reverse Contact on page 54
Reverse Contact Contacts are graphic components of Ladder Diagram (LD) programs.
Reverse contacts support a Boolean operation between a connection line state and
the Boolean negation of a Boolean variable.

The state of the connection line on the right of the contact is the logical AND
between the state of the left connection line and the Boolean negation of the value
of the variable associated with the contact.
Reverse Contact example
See also
Contacts on page 50
Direct Contact on page 54
Pulse Rising Edge Contact Contacts are graphic components of Ladder Diagram (LD) programs.
Pulse rising edge (or positive) contacts support a Boolean operation between a
connection line state and the rising edge of a Boolean variable.
The state of the connection line on the right of the contact is set to TRUE when
the state of the connection line on the left is TRUE, and the state of the associated
variable rises from FALSE to TRUE. The state is reset to FALSE in all other cases.
Pulse Rising Edge Contact example
Recommendation: Restrict the use of output variables with edge contacts
We recommend not using outputs or variables with a Pulse rising edge contact
(positive) or a Pulse falling edge contact (negative). These contacts are for physical

inputs in a ladder diagram. To detect the edge of a variable or an output, we

recommend using the R_TRIG/F_TRIG function block, which is supported and
works in any language at any location in your program.
See also
Contacts on page 50
Pulse Falling Edge Contact on page 56
Pulse Falling Edge Contact Contacts are graphic components of Ladder Diagram (LD) programs.
Pulse falling edge (or negative) contacts support a Boolean operation between a
connection line state and the falling edge of a Boolean variable.
The state of the connection line on the right of the contact is set to TRUE when
the state of the connection line on the left is TRUE, and the state of the associated
variable falls from TRUE to FALSE. The state is reset to FALSE in all other cases.
Pulse Falling Edge Contact example
Recommendation: Restrict the use of output variables with edge contacts
We recommend not using outputs or variables with a Pulse rising edge contact
(positive) or a Pulse falling edge contact (negative). These contacts are for physical
inputs in a ladder diagram. To detect the edge of a variable or an output, we
recommend using the R_TRIG/F_TRIG function block, which is supported and
works in any language at any location in your program.
See also
Contact on page 50

Pulse Rising Edge Contact on page 55
Return Returns are outputs that represent a conditional end of a Ladder Diagram (LD)
program.
You cannot place connections to the right of a return element.
When the left connection line has the TRUE Boolean state, the diagram ends
without executing the instructions located on the next lines of the diagram.
When the LD diagram is a function, its name is associated with an output coil to
set the return value (returned to the calling diagram).
Return example
To insert a return in a Ladder Diagram program:
Do one of the following:
Right-click a rung or an element in the LD language editor, select Insert

Ladder Elements and then click Return.
Select a rung or element in the LD language editor and then
press CTRL+6.
Select a rung or an element in the LD language editor and then click Tools
> Multi-language Editor > Insert Return.
Open the LD Toolbox to show the return element and then either:
Double-click the return element to add it to the LD language editor.
Drag the return element into the LD language editor and position it
on the rung.

See also
Jumps are conditional or unconditional elements that control the execution of

Jump
Ladder Diagram (LD) programs.
Jump notation
The following notation indicates a jump to a label:
>>LABEL - Jump to a label where the label name is "LABEL"
Jump example
To insert a jump:
Do one of the following:
Right-click a rung or an element in the LD language editor, select Insert

Ladder Elements and then click Jump.
Select a rung or element in the LD language editor and then
press CTRL+5.
Select a rung or an element in the LD language editor and then click Tools
> Multi-language Editor > Insert Jump.
Open the LD Toolbox to show the jump element and then either:
Double-click the jump element to add it to the LD language editor.
Drag the jump element into the LD language editor and position it
on the rung.

See also
Returns on page 57
Instruction blocks in LD The Connected Components Workbench instruction set includes IEC 61131-3
compliant instruction blocks. Instruction blocks collectively include function
programs blocks, functions and operators. You can connect instruction block inputs and
outputs to variables, contacts, coils, or other instruction block inputs and outputs.
Instruction block conventions
The IEC61131-3 programming language specification addresses numerous aspects

of programmable controllers including the operating system execution, data
definitions, programming languages, and instruction sets. The IEC61131-3
specification provides a minimum set of functionality that can be extended to
meet end user applications.
Instruction block names
Functions and function blocks are represented by a box that displays the name of
the instruction, and the short version of the parameter names. For function blocks,
the instance name is displayed above the function block name.
Instruction block return parameters
The return parameter of a function has the same name as the function. The
return parameter is the only output.
The return parameters of a function block can have any name. Multiple
return parameters can provide multiple outputs.
You can define the parameters of programs for multiple devices by
navigating the tabs for individual devices displayed in the Parameter view.
See also
Work in the LD language When you add items to a rung in the Ladder Diagram (LD) program, they are
added according to the following criteria.
editor
The first element on a rung is inserted at the position you select in the
ladder diagram.

Subsequent elements are inserted to the right of the selected item on the
rung.
You cannot insert an element to the right of a coil return or jump.
Different methods to add an element to Ladder Diagram program:
LD language editor
Add elements, delete elements, and copy and paste elements.
Use LD keyboard shortcuts to add elements.
Add elements.
Export an image of the LD program.
Enable or disable the automatic opening of the Variable Selector
and Instruction Block Selector.
LD Toolbox
Add elements.
You can replace an assigned variable directly from the language editor, or from the
Variable Selector.
To modify a variable from the language editor:
1. In the language editor, click the variable name to display a drop-down list of
global and local variables.
2. Do one of the following:
Type a new variable name in the text box.

Select a different variable name from the drop-down list.
To modify a variable from the Variable Selector:
1. In the language editor, double-click the variable to open the Variable

Selector.
2. Click the variable name, then select a different variable from the drop-down
list of global and local variables.
3. Click an existing variable, then type constant values in the text box
provided.

See also
Ladder Diagram (LD) The following examples are Ladder Diagram (LD) programs.
program examples Example: R_TRIG function block
The following example program shows the recommended usage of an R_TRIG

function block used to detect an edge while connected to the controller.
Example: Comparing Real Values using Subtraction (-) ABS, and Less than
(<)
The Real data type is not recommended when comparing values for equality
because of differences in the way numbers are rounded. Two output values may
appear equal in a Connected Components Workbench display, but will evaluate as
false.
For example, 23.500001 compared to 23.499999 will both display as 23.5 in the
variable input display, but will not be equal in the controller.

To test whether two Real data type values are equal, you can use a Subtraction
instruction to get the difference between the values and then determine if the
difference is Less Than an established precision value. See the following LD
program example for comparing two Real data type values.
See also
LD Keyboard shortcuts The following keyboard shortcuts are available for use with the Ladder Diagram
language.
Shortcut Description
Ctrl+0 Inserts a rung after a selected rung.1
Ctrl+Alt+0 Inserts a rung before a selected rung.1

Ctrl+ 1 Inserts a branch after a selected element.

Ctrl+Alt+ 1 Inserts a branch before a selected element.
Ctrl+2 Inserts an instruction block after a selected element.2
Ctrl+Alt+2 Inserts an instruction block before a selected element.2

Ctrl+3 Inserts a contact after a selected element.2
Ctrl+Alt+3 Inserts a contact before a selected element.2
Ctrl+4 Inserts a coil after a selected element.
Ctrl+5 Inserts a jump after a selected element.
Ctrl+Alt+5 Inserts a jump after a selected element.

Ctrl+6 Inserts a return after a selected element.
Ctrl+8 Inserts a branch above the selected branch.

Ctrl+Alt+8 Inserts a branch below the selected branch.
Delete Removes a selected rung or element.
Enter When a rung is selected, pressing the Enter key selects the first element of the
rung. If there is no rung element, nothing happens.
Spacebar When a coil or contact is selected, pressing the Spacebar changes the contact or
coil type.
Shift+Enter Inserts a line break.
Ctrl+Enter Opens a line above the current line.
Ctrl+Shift+Enter Opens a line below the current line.
Ctrl+Shift+L Removes the current line.
Ctrl+Delete Removes the next word in the current line.
Backspace Removes the character on the left.
Ctrl+Backspace Removes the previous word in the current line.
Ctrl+C Copies the selected text to the clipboard.
Ctrl+Insert Copies the selected text to the clipboard.
Ctrl+V Pastes text saved on the clipboard to the insertion point.
Shift+Insert Pastes text saved on the clipboard to the insertion point.
Ctrl+Z Undoes the previous command.
Ctrl+Y Redoes the previous command.
Ctrl+Shift+Z Redoes the previous command.
Ctrl+Left Moves to the previous statement or word.
Ctrl+Right Moves to the next statement or word.
Home Moves to the first element of the selected rung, if there is no rung element nothing
happens.
End Moves to the last element of the selected rung, if there is no rung element nothing
happens.
Ctrl+Home Moves to the first element of the first rung, if there is no rung element, the first
rung is selected.

Ctrl+End Moves to the last element of the last rung, if there is no rung element, the last
rung is selected.
Page Up Moves to the top of the visible code.
Page Down Moves to the bottom of the visible code.
Ctrl+J Moves to the matching bracket.
Ctrl+Down Scrolls down.
Ctrl+Up Scrolls up.
Shift+Down Selects down.
Shift+Left Mouse Click Selects multiple rungs. Click each rung individually.
Shift+Up Selects up.
Shift+Left Selects left.
Shift+Right Selects right.
Ctrl+Shift+Left Selects to the previous statement or word.
Ctrl+Shift+Right Selects to the next statement or word.
Shift+Home Selects from the insertion point until the start of the line.
Shift+End Selects from the insertion point until the end of the line.
Ctrl+Shift+Home Selects from the insertion point until the start of the document.
Ctrl+Shift+End Selects from the insertion point until the end of the document.
Shift+Page Up Selects from the insertion point until the top of the visible code.
Shift+Page Down Selects from the insertion point until the end of the visible code.
Ctrl+Shift+Page Up Selects from the insertion point until the top of the visible code.
Ctrl+Shift+Page Down Selects from the insertion point until the end of the visible code.
Ctrl+A Selects the entire document.
Ctrl+D When a rung or one element of the rung is selected, after pressing CTRL+D user
can edit rung comment.
Ctrl+R Enable or disable the Automatic Selector Invocation.
By default, either the Instruction Block Selector or Variable Selector dialog opens
when an element is added to a Ladder Diagram program.
Ctrl+Shift+W Selects the next word.
Ctrl+Shift+J Selects to the matching bracket.
Shift+Alt+Down Selects the current and next lines.
Shift+Alt+Up Selects the current and previous lines.
Shift+Alt+Left Selects left on the current line.
Shift+Alt+Right Selects right on the current line.
Ctrl+Shift+Alt+ Left Selects available columns in lines of code from the left to right.
Ctrl+Shift+Alt+Right Selects available columns in lines of code from the right to left.
Esc Deselects the selected text.
Insert Toggles between the overwrite/insert typing mode.

1
When no rung is selected, a rung is added at the end of the rung list.
2
When a branch is selected, an element is inserted at the end of the branch.
See also

Chapter 4
Alarm instruction
Use the alarm instruction to provide alerts when a configured high or low limit is
reached.
Function block Description

LIM_ALRM on page 67 Hysteresis on a real value for high and low limits.
See also
Instruction set in alphabetical order on page 21
LIM_ALRM is an alarm with hysteresis on a Real value for high and low limits.
LIM_ALRM (limit alarm)
A hysteresis is applied on high and low limits. The hysteresis delta used for either
high or low limit is one half of the EPS parameter.
A Process alarm is an alarm that occurs when a fault is received and processed by
the controller. Process level alarms provide an alert when the module has exceeded
the configured high or configured low limits for each channel.
Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.
This instruction applies to the Micro810, Micro820, Micro830, and Micro850

controllers.
Use this table to help determine the parameter values for this instruction.

Chapter 4 Alarm instruction
Parameter Parameter Data type Description

type
EN Input BOOL When TRUE, enables the instruction block.
TRUE - execute current LIM_ALRM computation.
FALSE - there is no computation.
Applies only to Ladder Diagram programs.
H Input REAL High limit value.
X Input REAL Input is any real value.
L Input REAL Low limit value.
EPS Input REAL Hysteresis value (must be greater than zero).
QH Output BOOL High alarm: TRUE if X above high limit H.
Q Output BOOL Alarm output: TRUE if X out of limits.
QL Output BOOL Low alarm: TRUE if X below low limit L.
ENO Output BOOL Enables outputs.
LIM_ALRM timing diagram example
LIM_ALRM Function Block Diagram example

Alarm instruction Chapter 4
LIM_ALRM Ladder Diagram example
LIM_ALRM Structured Text example

Chapter 4 Alarm instruction
Results
See also
Alarm instructions on page 67

Chapter 5
Arithmetic instructions
Use the arithmetic instructions to perform mathematical calculations.
Function Description
ABS on page 72 Returns the absolute value of a Real value.

ACOS on page 73 Calculates the arc-cosine of a Real value.
ACOS_LREAL on page 75 Calculates the arc-cosine of a Long Real value.
Addition on page 77 Adds two or more Integer, Real, Time, or String values.
ASIN on page 78 Calculates the arcsine of a Real value.
ASIN_LREAL on page 80 Calculates the arcsine of a Long Real value.
ATAN on page 82 Calculates the arctangent of a Real value.
ATAN_LREAL on page 83 Calculates the arctangent of a Long Real value.
COS on page 85 Calculates the cosine of a Real value.
COS_LREAL on page 87 Calculates the cosine of a Long Real value.
Division on page 88 Division of two Integer or Real values.
EXPT on page 90 Calculates the Real value of a base number raised to the power of the Integer
exponent.
LOG on page 92 Calculates the logarithm (base 10) of a Real value.
MOD on page 94 Performs a Modulo calculation on Integer values.
MOV on page 96 Copies an input value to an output.
Multiplication on page 97 Multiplies two or more Integer or Real values.
Neg on page 99 Converts a value to a negative.
POW on page 100 Calculates the value of a Real number raised to a power of the Real exponent.
RAND on page 102 Calculates random integer values from a defined range.
SIN on page 104 Calculates the sine of a Real value.
SIN_LREAL on page 106 Calculates the sine of a Long Real value.
SQRT on page 107 Calculates the square root of a Real value.
Subtraction on page 109 Subtracts one Integer, Real or Time value from another Integer, Real or Time
value.
TAN on page 111 Calculates the tangent of a Real value.
TAN_LREAL on page 112 Calculates the tangent of a Long Real value.
TRUNC on page 114 Truncates Real values, leaving just the Integer.
See also

Chapter 5 Arithmetic instructions
ABS (absolute value) Returns the absolute (positive) value of a Real value.

Text.

controllers.
Parameter Parameter Data Type Description

Type
EN Input BOOL Instruction enable.
TRUE - execute current absolute computation.
Applies to Ladder Diagram programs.
IN Input REAL Any signed Real value.
ENO Output BOOL Enable output.
ABS Output REAL Absolute value (always positive).
ABS Function Block Diagram example
ABS Ladder Diagram example

Arithmetic instructions Chapter 5
ABS Structured Text diagram example
(* ST Equivalence: *)
over := (ABS (delta) > range);
Results
See also
Arithmetic instructions on page 71
ACOS (arccosine of source) Calculates the arc-cosine of a Real value. Input and output values are in radians.

Text.

controllers.


Type
TRUE - execute current arc-cosine computation.
IN Input REAL Must be in set [-1.0 .. +1.0].
ACOS Output REAL Arc-cosine of the input value (in set [-p1/2..+p1/2])=0 for invalid input.
ACOS Function Block Diagram example
ACOS Ladder Diagram example
ACOS Structured Text example
cosine := COS (angle);
result := ACOS (cosine); (* result is equal to angle *)

Results
See also
ACOS_LREAL (arccosine Calculates the arc-cosine of a Long Real value.
Long Real) Languages supported: Function Block Diagram, Ladder Diagram, Structured
Text.

controllers.

Type
TRUE - execute current computation.
IN Input LREAL Must be in set [-1.0 .. +1.0].
ACOS_LREAL Output LREAL Arc-cosine of the input value (in set [0.0 .. PI]) = 0.0 for invalid input.

ACOS_LREAL Function Block Diagram example
ACOS_LREAL Ladder Diagram examples
ACOS_LREAL Structured Text examples
cosine := COS_LREAL (angle);
result := ACOS_LREAL (cosine); (* result is equal to angle *)
Results

See also
Adds two or more Integer, Real, Time, or String values.

Addition
Text.

controllers.

Type
TRUE - execute current addition computation.
i1 Input SINT Addend in Real, Time, or String data type.
USINT All inputs must be the same data type.
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
STRING

i2 Input SINT Addend in Real, Time, or String data type.

BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
STRING
o1 Output SINT Sum of the input values in Real, Time, or String format.
USINT Input and output must use the same data type.
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
STRING
Addition Structured Text example
(* ST equivalence: *)
ao10 := ai101 + ai102;

ao5 := (ai51 + ai52) + ai53;
See also
Calculates the arcsine of a Real value. Input and output values are in radians.
ASIN (arcsine)
Text.


controllers.

Type
TRUE - execute current arcsine computation.
IN Input REAL Must be in set [-1.0 .. +1.0].
ASIN Output REAL Arcsine of the input value(in set [-p1/2..+p1/2])=0 for invalid input.
ASIN Function Block Diagram example
ASIN Ladder Diagram example
ASIN Structured Text example
sine := SIN (angle);

result := ASIN (sine); (* result is equal to angle *)
Results
See also
Calculates the arcsine of a Long Real value.

ASIN_LREAL (arcsine Long
Real) Languages supported: Function Block Diagram, Ladder Diagram, Structured
Text.

controllers.

Type
IN Input LREAL Must be in set [-1.0 .. +1.0].
ASIN_LREAL Output LREAL Arcsine of the input value (in set [-PI/2 .. +PI/2]) = 0.0 for invalid input.

ASIN_LREAL Function Block Diagram example
ASIN_LREAL Ladder Diagram example
ASIN_LREAL Structured Text example
sine := SIN_LREAL (angle);
result := ASIN_LREAL (sine); (* result is equal to angle *)
Results

See also
Calculates the arctangent of a Real value.

ATAN (arctangent)
Text.

controllers.

Type
TRUE - execute current arctangent computation.
IN Input REAL Any Real value.
ATAN Output REAL Arctangent of the input value (in set [-PI/2 .. +PI/2]) = 0.0 for invalid
input.
ATAN Function Block Diagram example
ATAN Ladder Diagram example

ATAN Structured Text example
tangent := TAN (angle);
result := ATAN (tangent); (* result is equal to angle*)
Results
See also
ATAN_LREAL (arctangent Calculates the arctangent of a Long Real value.
Long Real) Languages supported: Function Block Diagram, Ladder Diagram, Structured
Text.

controllers.


Type
IN Input LREAL Any Long Real value.
ATAN_LREAL Output LREAL Arctangent of the input value (in set [-PI/2 .. +PI/2]) = 0.0 for invalid
input.
ATAN_LREAL Function Bock Diagram example
ATAN_LREAL Ladder Diagram example
ATAN_LREAL Structured Text example
tangent := TAN_LREAL (angle);
result := ATAN_LREAL (tangent); (* result is equal to angle*)

Results
See also
Calculates the cosine of a Real value.

COS (cosine)
Text.

controllers.

Type
TRUE - execute current cosine computation.
COS Output REAL Cosine of the input value (in set [-1.0 .. +1.0]).

COS Function Block Diagram example
COS Ladder Diagram example
COS Structured Text example
cosine := COS (angle);
result := ACOS (cosine); (* result is equal to angle *)
Results

See also
Calculates the cosine of a Long Real value.

COS_LREAL (cosine Long
Text.

controllers.

Type
TRUE - execute current cosine computation.
COS_LREAL Output LREAL Cosine of the input value (in set [-1.0 .. +1.0]).
COS_LREAL Function Block Diagram example
COS_LREAL Ladder Diagram example

COS_LREAL Structured Text example
cosine := COS_LREAL (angle);
result := ACOS_LREAL (cosine); (* result is equal to angle *)
Results
See also
Division Divides the first Integer or Real input value by the second Integer or Real input
value.

Text.


controllers.

Type
TRUE - execute current division computation.
i1 Input SINT Dividend in non-zero Integer or Real data type.
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
i2 Input SINT Divisor in non-zero Integer or Real data type.
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL

o1 Output SINT Quotient of the inputs in non-zero Integer or Real data type.
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
ENO Output BOOL Enable out.
Division Structured Text example
ao10 := ai101 / ai102;

ao5 := (ai5 / 2) / ai53;
See also
EXPT (exponent) Raises the value of IN (base) to the power of EXP (exponent) and outputs the
Real result of the operation.

Text.

controllers.


Type
TRUE - execute current exponent computation.
IN Input REAL Any signed Real value.
EXP Input DINT Integer exponent.
EXPT Output REAL The Real value of IN to the power of EXP.
EXPT Function Block Diagram example
EXPT Ladder Diagram example
EXPT Structured Text example
tb_size := ANY_TO_DINT (EXPT (2.0, range) );

Results
See also
LOG (log base 10) Calculates the logarithm (base 10) of a Real value.

Text.

controllers.

Type
TRUE - execute current logarithm computation.
IN Input REAL Must be greater than zero.
LOG Output REAL Logarithm (base 10) of the input value. The returned result is -3.4E+38
for a zero IN value and negative IN value.

LOG Function Block Diagram example
LOG Ladder Diagram example
LOG Structured Text example
xpos := ABS (xval);
xlog := LOG (xpos);
Results

See also
Divide the IN input by the Base input and place the remainder in the MOD
MOD (modulo)
output.

Text.

controllers.

Type
TRUE - execute the module computation.
IN Input DINT Any signed integer value.
Base Input DINT Must be greater than zero.
MOD Output DINT Modulo calculation (input MOD base) / returns -1 if Base <= 0.
MOD Function Block Diagram example

MOD Ladder Diagram example
MOD Structured Text example
division_result := (value / divider); (* integer division *)
rest_of_division := MOD (value, divider); (* rest of the division *)
Results
See also

MOV (move) Assigns the input (i1) value to the output (o1).
Languages supported: Function Block Diagram, Ladder Diagram.
For Structured Text programs, use the Equal (=) operator instead of MOV.

controllers.

Type
TRUE - execute the direct link to an output computation.
i1 Input BOOL Input and output must use the same data type.
DINT
REAL
TIME
STRING
SINT
USINT
INT
UINT
UDINT
LINT
ULINT
DATE
LREAL
BYTE
WORD
DWORD
LWORD

o1 Output BOOL Input and output must use the same data type.
DINT
REAL
TIME
STRING
SINT
USINT
INT
UINT
UDINT
LINT
ULINT
DATE
LREAL
BYTE
WORD
DWORD
LWORD
Structured Text example
ao23 := ai10;
See also
Multiplication Multiplies two or more Integer or Real values.

Text.

controllers.


Type
TRUE - execute current multiplication computation.
i1 Input SINT Factor in Integer or Real data type.
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
i2 Input SINT Factor in Integer or Real data type.
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
LINT
LWORD
REAL
LREAL
o1 Output SINT Product of the inputs in Integer or Real data type.
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL

Multiplication Structured Text example
(* ST equivalence *)
ao10 := ai101 * ai102;

ao5 := (ai51 * ai52) * ai53;
See also
Neg (negation) Converts a value to a negated value.

Text.

controllers.

Type
TRUE - execute current convert to negative computation.
i1 Input SINT Input and output must be the same data type.
INT
DINT
LINT
REAL
LREAL
o1 Output SINT Input and output must be the same data type.
INT
DINT
LINT
REAL
LREAL


Neg Structured Text example
ao23 := - (ai10);
ro100 := - (ri1 + ri2);
See also
When the first argument is 'base' and the second argument is 'exponent', calculate
POW (raise power)
the Real result of (base exponent).

Text.

controllers.
Parameter Parameter Type Data Type Description

TRUE - execute current exponent computation.
IN Input REAL Real number to be raised.
EXP Input REAL Power (exponent).
POW Output REAL (IN EXP)
1.0 if IN is not 0.0 and EXP is 0.0
0.0 if IN is 0.0 and EXP is negative
0.0 if both IN and EXP are 0.0
0.0 if IN is negative and EXP does not correspond to an
integer.

POW Function Block Diagram example
POW Ladder Diagram example
POW Structured Text example
result := POW (xval, power);

Results
See also
RAND (random value) Calculates random integer values from a defined range.

Text.

controllers.

Type
TRUE - execute the random integer value computation.
base Input DINT Defines the supported set of numbers.
RAND Output DINT Random value in set [0..base-1].

RAND Function Block Diagram example
RAND Ladder Diagram example
RAND Structured Text example
selected := MUX4 ( RAND (4), 1, 4, 8, 16 );
(*
random selection of 1 of 4 pre-defined values
the value issued of RAND call is in set [0..3],
so 'selected' issued from MUX4, will get 'randomly' the value
1 if 0 is issued from RAND,
or 4 if 1 is issued from RAND,
*)

Results
See also
SIN (sine) Calculates the sine of a Real value.

Text.

controllers.

Type
TRUE - execute current sine computation.
SIN Output REAL Sine of the input value (in set [-1.0 .. +1.0]).

SIN Function Block Diagram example
SIN Ladder Diagram example
SIN Structured Text example
sine := SIN (angle);
result := ASIN (sine); (* result is equal to angle *)
Results

See also
Calculates the sine of a Long Real value.

SIN_LREAL (sine Long Real)
Text.

controllers.

Type
SIN_LREAL Output LREAL Sine of the input value (in set [-1.0 .. +1.0]).
SIN_LREAL Function Block Diagram example
SIN_LREAL Ladder Diagram example

SIN_LREAL Structured Text example
TESTOUTPUT1 := SIN_LREAL(TESTINPUT1) ;
Results
See also
SQRT (square root) Calculates the square root of a Real value.

Text.

controllers.


Type
TRUE - execute current square root computation.
IN Input REAL Must be greater than or equal to zero.
SQRT Output REAL Square root of the input value. The returned result is 0 for a negative
IN value.
SQRT Function Block Diagram example
SQRT Ladder diagram example
SQRT Structured Text example
xpos := ABS (xval);
xroot := SQRT (xpos);

Results
See also
Subtraction Subtracts one Integer, Real, or Time value from another Integer, Real or Time
value.

Text.

controllers.


Type
TRUE - execute current addition computation.
i1 Input SINT Minuend in any Integer, Real or Time data type.

BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
i2 Input SINT Subtrahend in any Integer, Real or Time data type.
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
o1 Output SINT Difference of the minuend and the subtrahend in any Integer,
USINT Real or Time data type.
BYTE Output must be the same data type as inputs.
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME

Subtraction Structured Text example
ao10 := ai101 - ai102;

ao5 := (ai51 - 1) - ai53;
See also
TAN (tangent) Calculates the tangent of a Real value.

Text.

controllers.

Type
TRUE - perform current tangent computation.
IN Input REAL Cannot be equal to PI/2 modulo PI.
TAN Output REAL Tangent of the input value = 1E+38 for invalid input.
TAN Function Block Diagram example

TAN Ladder Diagram example
TAN Structured Text example
tangent := TAN (angle);
result := ATAN (tangent); (* result is equal to angle*)
Results
See also
TAN_LREAL (tangent Long Calculates the tangent of a Long Real value.

Text.


controllers.

Type
TRUE - perform current computation.
IN Input LREAL Cannot be equal to PI/2 modulo PI.
TAN_LREAL Output LREAL Tangent of the input value = 1E+38 for invalid input.
TAN_LREAL Function Block Diagram example
TAN_LREAL Ladder Diagram example
TAN_LREAL Structured Text example
tangent := TAN_LREAL (angle);

result := ATAN_LREAL (tangent); (* result is equal to angle*)
Results
See also
TRUNC (truncate) Truncates Real values, leaving just the Integer.

Text.

controllers.

Type
TRUE - perform the truncation of Real value computation.
TRUNC Output REAL If IN>0, biggest integer less or equal to the input.
If IN<0, least integer greater or equal to the input.

TRUNC Function Block Diagram example
TRUNC Ladder Diagram example
TRUNC Structured Text example
result := TRUNC (+2.67) + TRUNC (-2.0891);
(* means: result := 2.0 + (-2.0) := 0.0; *)
Results

See also

Chapter 6
ASCII serial port instructions
Use the ASCII serial port instructions to use or alter the communication channel
for receiving or transmitting data.
ABL on page 117 Counts the number of characters in the buffer up to and including end of line character.
ACB on page 119 Counts the total number of characters in the buffer.
ACL on page 122 Clears the receive and transmit buffers.
AHL on page 124 Sets or resets modem handshake lines.
ARD on page 127 Reads characters from the input buffer and places them into a string.
ARL on page 130 Reads one line of characters from the input buffer and places them into a string.
AWA on page 133 Writes a string with two appended (user-configured) characters to an external device.
AWT on page 135 Writes characters from a source string to an external device.
See also
ABL (ASCII test for buffer Counts the number of ASCII characters in the input buffer up to and including
the end-of-line termination character.
line)
Text.

controllers.

Chapter 6 ASCII serial port instructions

Type
IN Input BOOL Rung input state.
TRUE - When Rising Edge is detected, start the function block with
the precondition that the last operation is complete.
FALSE - The instruction block is idle.
ABLInput Input ABLACB The channel to be operated.
Use the ABLACB data type to define the Channel, TriggerType, and
Cancel parameters for ABLInput.
Q Output BOOL Indicates when the character count is ongoing or complete.
The outputs update asynchronously from the program scan. Output Q
cannot be used to re-trigger the instruction since IN is edge triggered.
TRUE - The function block is complete.
FALSE - The function block is not complete.
Characters Output UINT The number of characters in the buffer. The buffer limit is 82
characters.
Error Output BOOL Indicates the existence of an error condition.
TRUE - An error is detected.
FALSE - No error.
ErrorID Output UINT A unique numeric that identifies the error. The errors for this
instruction are defined in ABL error codes.
ABL error codes
Use this table to determine the ABL error codes and descriptions.
Error code Error description
03 Transmission cannot be completed because the Clear-to-Send signal was lost.

06 Illegal parameter was detected.
07 Cannot complete ASCII send or receive because channel configuration has been shut down using the
channel configuration dialog box.
08 Cannot complete ASCII Write due to an ASCII transmission already in progress.
09 ASCII communication requested is not supported by current channel configuration.
10 The Cancel was set, stopping instruction execution. No action required.
11 The requested length for the string is either invalid, a negative number, greater than 82, or 0. Applies to
ARD and ARL function blocks.
13 The requested (.LEN) in the control block is a negative number or a value greater than the string size
stored with the source string. Applies to AWA and AWT function blocks.
14 The ACL function block was aborted.
16 Serial port is not supporting RTS or CTS control lines.

ASCII serial port instructions Chapter 6
ABL Function Block Diagram example
ABL Ladder Diagram example
ABL Structured Text example
See also
ABLACB data type on page 138
ASCII serial port instructions on page 117
ACB (ASCII characters in Counts the total number of ASCII characters in the buffer including end of line.
buffer) Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.

controllers.

Type
TRUE - When Rising Edge is detected, start the instruction block with
ACBInput Input ABLACB The channel to be operated.
Use the ABLACB data type to define the Channel, TriggerType, and
Cancel parameters for ACBInput.
Q Output BOOL Indicates whether the character count is ongoing or complete.
Outputs of this function block are updated asynchronously from the
program scan. Output Q cannot be used to re-trigger the instruction
since IN is edge triggered.
TRUE - The counting is complete.
FALSE - The counting is ongoing.
Characters Output UINT The number of characters in the buffer.
FALSE - No error.
ACB error codes



ACB Function Block Diagram example
ACB Ladder Diagram example

ACB Structured Text example
See also
ACL (ASCII clear buffer) Clears the receive and transmit buffers, and removes instructions from the ASCII
queue.

Text.

controllers.

Type
TRUE - When Rising Edge is detected, start the function block with

ACLInput Input ACLI The channel to be operated, and the state of the transmit and receive
buffers.
For RXBuffer, clears the receive buffer and removes the receive ASCII
function blocks (ARL and ARD) from the ASCII queue.
For TXBuffer, clears the transmit buffer and removes the transmit
ASCII function blocks (AWA and AWT) from the ASCII queue.
Use the ACLI data type to define the Channel, RXBuffer, and TXBuffer
parameters for ACLInput.
Q Output BOOL Indicates when the ASCII queue clearing process is ongoing or
complete.
FALSE - No error.
ABL error codes


ACL Function Block Diagram example
ACL Ladder Diagram example
ACL Structured Text example
See also
ACL data type on page 139
AHL (ASCII handshake lines) Sets or resets the RS-232 Request to Send (RTS) handshake control lines for a
modem.

Text.


controllers.

Type
TRUE - When Rising Edge is detected, start the instruction block with
AHLInput Input AHLI The channel to be operated, and the set or reset of the RTS control
line for the modem.
Use the AHLI data type to define the Channel, SetRts, ClrRts, and
Cancel parameters for AHLInput.
Q Output BOOL Indicates when the set or reset is complete.
Outputs of this instruction are updated asynchronously from the
ChannelSts Output WORD Displays the current status (0000 to 001F) of the handshake lines for
the specified channel.
FALSE - No error.
ABL error codes



AHL Function Block Diagram example
AHL Ladder Diagram example

AHL Structured Text example
See also
AHLI data type on page 140
AHL ChannelSts data type on page 139
ARD (ASCII read) Reads ASCII characters from the input buffer and stores them into a string.
Operation details:
The ARD instruction runs until all of the characters in the ASCII buffer are
received. If another ASCII instruction is executed, it is queued until ARD is
finished.
To abort the ARD instruction, execute an ACL instruction.
To prevent the ARD instruction delaying the ASCII queue while it waits
for the required number of characters, use the results of an ACB instruction
to trigger the ARD instruction.
Status of the instruction can be extracted from the control bit of the
instruction instance (for example, ARD_1.controlbit). This shows if the
instruction is blocking the ASCII instruction queue waiting for more
characters:
7th bit = Instruction is enabled.
6th bit = Instruction is in the queue.
5th bit = Instruction is done.
3rd bit = Instruction has an error.

Text.


controllers.

Type
TRUE - When Rising Edge is detected, start the instruction block
with the precondition that the last operation is complete.
ARDInput Input ARDARL Read characters from the buffer. The maximum is 82.
Use the ARDARL data type to define the Channel, Length, and
Cancel parameters for the ARDInput.
Q Output BOOL Indicates when the buffer read is ongoing or complete.
Destination Output ASCIILOCADDR The string element where the characters are stored.
NumChar Output UINT The number of characters.
FALSE - No error.
ABL error codes


ARD Function Block Diagram example
ARD Ladder Diagram example

ARD Structured Text example
See also
ARDARL data type on page 140
ARL (ASCII read line) Reads a line of ASCII characters from the buffer, up to and including the
termination characters, and stores them in a string.

Text.

controllers.

Type

ARLInput Input ARDARL Read a line of ASCII characters from the buffer. The maximum is 82.
Use the ARDARL data type to define the Channel, Length, and
Cancel parameters for the ARDLInput.
Q Output BOOL Indicates when the read line from the input buffer is ongoing or
complete.
Destination Output ASCIILOCADDR The string element where the characters are stored.
NumChar Output UINT The number of characters in the line, including the termination
character.
FALSE - No error.
ABL error codes


ARL Function Block Diagram example
ARL Ladder Diagram example
ARL Structured Text example
See also

AWA (ASCII write append) Writes a string with two appended (user-configured) characters to an external
device.

Text.

controllers.

Type
TRUE - Rising Edge is detected, start the instruction block with the
precondition that the last operation is complete.
AWAInput Input AWAAWT The channel and number (Length) of the characters to write to the
buffer. Maximum is 82.
Use the AWAAWT data type to define Channel, Length, and Cancel
parameters for AWAInput.
Source Input ASCIILOCADDR The source string that was output as a character array by either the
ARD or ARL instruction.
Q Output BOOL Indicates when the write is ongoing or complete.
NumChar Output UINT The number of characters. NumChar may be less than the Length
requested to be transmitted if the length of the Source String is
shorter than the requested Length.
Updates when the transmission is complete and Q is TRUE.
FALSE - No error.

ABL error codes

AWA Function Block Diagram example

AWA Ladder Diagram example
AWA Structured Text example
See also
AWAAWT data type on page 141
AWT (ASCII write) Writes ASCII characters from a source string to an external device.

Text.


controllers.

Type
AWTInput Input AWAAWT The channel and number (Length) of the characters to write to the
buffer. Maximum is 82.
Use the AWAAWT data type to define Channel, Length, and Cancel
parameters for AWTInput.
Source Input ASCIILOCADDR The source string that was output as a character array by either the
ARD or ARL instruction.
Q Output BOOL Indicates when the write is ongoing or complete.
NumChar Output UINT The number of characters. NumChar may be less than the Length
requested to be transmitted if the length of the Source String is
shorter than the requested Length.
Updates when the transmission is complete and Q is TRUE.
FALSE - No error.
ABL error codes


AWT Function Block Diagram example
AWT Ladder Diagram example

AWT Structured Text example
See also
ASCII parameter details The following topics provide additional details for ASCII parameters and
structured data types.
ACL data type on page 139
See also
ABLACB data type Use this table to help determine the parameter values for the ABLACB data type.

Parameter Data type Description
Channel UINT Serial port number:

2 for the embedded serial port, or
5-9 for serial port plug-ins installed in slots 1 through 5:
5 for slot 1
6 for slot 2
7 for slot 3
8 for slot 4
9 for slot 5
TriggerType USINT Represents one of the following:
0: Msg Triggered Once (when IN goes from False to True)
1: Msg triggered continuously when IN is True
Other value: Reserved
Cancel BOOL When this input is set to TRUE, this function block does not execute.
See also
ASCII parameter details on page 138
ACL data type Use this table to help determine the parameter values for the ABL data type.

5 for slot 1
6 for slot 2
7 for slot 3
8 for slot 4
9 for slot 5
RXBuffer BOOL When TRUE, clears the receive buffer and removes the receive ASCII function blocks (ARL
and ARD) from the ASCII queue.
TXBuffer BOOL When TRUE, clears the transmit buffer and removes the transmit ASCII function blocks
(AWA and AWT) from the ASCII queue.
See also
AHL ChannelSts data type Use this table to help determine the parameter values for the AHL ChannelSts
data type.
DTRstatus UINT Used for the DTR signal (reserved)

DCDstatus UINT Used for the DCD signal (bit 3 of word)

1 indicates active
DSRstatus UINT Used for the DSR signal (reserved)
RTSstatus UINT Used for the RTS signal (bit 1 of word)
1 indicates active
CTSstatus UINT Used for the CTS signal (bit 0 of word)
1 indicates active
See also
AHLI data type Use this table to help determine the parameter values for the AHL data type.

5 for slot 1
6 for slot 2
7 for slot 3
8 for slot 4
9 for slot 5
ClrRts BOOL Used to reset the RTS control line.
SetRts BOOL Used to set the RTS control line.
Cancel BOOL When this input is set to TRUE, this function block does not execute.
See also
ARDARL data type Use this table to help determine the parameter values for the ARDARL data type.


5 for slot 1
6 for slot 2
7 for slot 3
8 for slot 4
9 for slot 5
Length UINT The number of characters that you want to read from the buffer (maximum is 82).
Cancel BOOL When this input is set to TRUE, this function block does not execute. If already executing,
operation ceases.
See also
AWAAWT data type Use this table to help determine the parameter values for the AWAAWT data
type.

5 for slot 1
6 for slot 2
7 for slot 3
8 for slot 4
9 for slot 5
Length UINT Defines the number of characters to write to the buffer (maximum is 82).
When Length is set to 0, AWA sends 0 bytes of user data and 2 bytes of appended
characters to the buffer.
Cancel BOOL When TRUE, this function block does not execute. If already executing, operation
ceases.
See also

Chapter 7
Binary instructions
Use Binary instructions to perform mathematical operations.
Operator Description
AND_MASK on page 143 Performs a bit-to-bit AND between two Integer values.
NOT_MASK on page 152 Integer bit-to-bit negation mask, inverts a parameter value.
BSL on page 145 Shifts a bit in an array element to the left.

BSR on page 149 Shifts a bit in an array element to the right.
OR_MASK on page 154 Integer OR bit-to-bit mask, turns bits on.
ROL on page 156 For 32-bit integers, rotates integer bits to the left.
ROR on page 158 For 32-bit integers, rotates integer bits to the left.
SHL on page 160 For 32-bit integers, moves integers to the left and places 0 in the least
significant bit.
SHR on page 162 For 32-bit integers, moves integers to the right and places 0 in the most
significant bit.
XOR_MASK on page 164 Integer exclusive OR bit-to-bit mask, returns inverted bit values.
See also
AND_MASK (AND mask) Performs a bit to bit AND between two integer values.

Text.

controllers.

Chapter 7 Binary instructions

Type
TRUE - execute the Integer AND bit-to-bit mask computation.
IN Input DINT Must have integer format.
MSK Input DINT Must have integer format.
AND_MASK Output DINT Bit-to-bit logical AND between IN and MSK.
AND_MASK Function Block Diagram example
AND_MASK Ladder Diagram example
AND_MASK Structured Text example
parity := AND_MASK (xvalue, 1); (* 1 if xvalue is odd *)
result := AND_MASK (16#abc, 16#f0f); (* equals 16#a0c *)

Binary instructions Chapter 7
Results
See also
Binary instructions on page 143
BSL (bit shift left) Shifts a bit in an array element to the left.

Text.
This instruction applies to the Micro820, Micro830, and Micro850 controllers.
Operation details:
The BSL instruction is an immediate process on false-to-true rung transition and

updates output synchronously. When Execute is TRUE, the leftmost bit (Src +
SrcOffset and Length) is copied into the Unload bit and all bits in the array or
non-array are shifted left by one bit. Length and 16 bit boundary are considered
except for BOOL data types. The external bit is then moved to bit 0 (Src +
SrcOffset) of the first element.

For wraparound operations, set the position of the BitAddr to the last bit position
or to the Unload bit. Possible usage of the BSL instruction, track bottles through a
bottling line where each bit represents a bottle.
Paramete Parameter Data Type Description

r Type
Execute Input BOOL Instruction enable.
TRUE - Rising Edge detected, shifts bit to the left one position.
Verify fault conditions first.
If Length = 0, the external bit is moved into the Unload bit. No
bit shift is done on Scr. Error and ErrorID bits are reset. Done bit
is set.
If Length > 0 and Length 2048, the Error and ErrorID bits are
reset. After the bit shift completes, the Done bit is set.
If Length > 0 and Length 2048, the leftmost bit (addressed
by Src + SrcOffset and Length) is copied into the Unload bit
and all bits that are part of the array or non-array are shifted
left by one bit (up to the bit Length and 16 bit boundary except
for BOOL). External bit is moved to bit 0 (Src + SrcOffset) of the
first element.
FALSE - Rising Edge not detected, do not enable BSL operation.
Scr Input ANY_ELEMENTARY The address of the Src (bit) to be shifted. Supported data types:
BOOL, DWORD, INT, UINT, WORD, DINT and UDINT.
Arrays: Set Scr to a variable based address such as: Source1,
Source1[0], or Source1[1] .
Non-arrays: Set Scr to a variable address such as Source1.
SrcOffset Input UINT If SrcOffset is 0, start from the first element.
Arrays: Set SrcOffset to 0. If set to Source1[0] or Source1[1]
an error occurs: 'Source offset exceeds the size of the array.'
Non-arrays: Set SrcOffset to 0 or an error occurs: 'Source offset
exceeds the size of the array.'
BitAddr Input BOOL Location of the bit shifted into Src.

Length Input UINT Length contains the number of bits in the Src to be shifted.
Supports shifting across array elements.
For BOOL data type, number of Booleans in the array to be
shifted.
For 16 and 32 bit data types, bits are shifted in multiples of 16
(such as 16, 32, and 64). If Length is not an even multiple of
16, the number of shifted bits are sent to the next 16-bit
boundary.
Length is based on the size of the data type. If Length exceeds
the range, an error occurs, 'Source offset exceeds the size of the
array.' Length values:
BOOL: 1
16 bit word: 1-16
32 bit word: 1-32
64 bit word: 1-64
Done Output BOOL When TRUE, operation completed successfully.
When FALSE, operation encountered an error condition.
Unload Output BOOL Bit shifted out from Src address.
Error Output BOOL When a fault occurs, Error is set to true.
ErrorID Output USINT When a fault occurs, ErrorID contains the error code.
BSL error codes
01 Not supported dimension.

02 Data type not supported.
03 Length of bits exceeds 2048.
04 Source offset exceeds the size of the array.
05 Length of bits exceeds the size of the array.
07 Invalid parameters.
BSL Function Block Diagram example

BSL Ladder Diagram example
BSL Structured Text example
Results

See also
Shifts a bit in an array element to the right.

BSR (bit shift right)
Text.
Operation details:
The BSR instruction is an immediate process on false-to-true rung transition and

updates output synchronously. When Execute is TRUE, the right most bit (bit 0
of the element addressed by Src + SrcOffset) is copied into the Unload bit and all
bits in the array or non-array are shifted right by one bit. Length and 16 bit
boundary are considered except for BOOL data types. The external bit is then
moved to bit 0 (Src + SrcOffset) of the first element.
For wraparound operations, set the position of the BitAddr to the last bit position
or to the Unload bit. Possible usage of the BSL instruction, track bottles through a
bottling line where each bit represents a bottle.

r Type
TRUE - Rising Edge detected, shifts bit to the right one position.
FALSE - Rising Edge not detected, do not enable BSR operation.
Scr Input ANY_ELEMENTAR The address of the Src (bit) to be shifted. Supported data types:
Y BOOL, DWORD, INT, UINT, WORD, DINT and UDINT.
Arrays: Set Scr to a variable based address such as: Source1,
Source1[0], or Source1[1] .
Non-arrays: Set Scr to a variable address such as Source1.

SrcOffset Input UINT If SrcOffset is 0, start from the first element.

Arrays: Set SrcOffset to 0. If set to Source1[0] or Source1[1] an
error occurs: 'Source offset exceeds the size of the array.'
Non-arrays: Set SrcOffset to 0 or an error occurs: 'Source offset
exceeds the size of the array.'
BitAddr Input BOOL Location of the bit shifted into Src.
Length Input UINT Length contains the number of bits in the Src to be shifted.
Supports shifting across array elements.
For BOOL data type, number of Booleans in the array to be
shifted.
For 16 and 32 bit data types, bits are shifted in multiples of 16
(such as 16, 32, and 64). If Length is not an even multiple of 16,
the number of shifted bits are to the next 16-bit boundary.
Length is based on the size of the data type. If Length exceeds
the range, an error occurs, 'Source offset exceeds the size of the
array.' Length values:
BOOL: 1
16 bit word: 1-16
32 bit word: 1-32
64 bit word: 1-64
Done Output BOOL When TRUE, operation completed successfully.
When FALSE, operation encountered an error condition.
Unload Output BOOL Bit shifted out from Src address.
Error Output BOOL When a fault occurs, Error is set to true.
ErrorID Output USINT When a fault occurs, ErrorID contains error code.
BSR error codes
01 Not supported dimension.

02 Data type not supported.
03 Length of bits exceeds 2048.
04 Source offset exceeds the size of the array.
05 Length of bits exceeds the size of the array.
07 Invalid parameters.

BSR Function Block Diagram example
BSR Ladder Diagram example
BSR Structured Text example

Results
See also
NOT_MASK (bit to bit NOT Integer bit-to-bit negation mask, inverts a parameter value.
mask) Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.

controllers.

Type
TRUE - execute the bit-to-bit negation mask computation.
NOT_MASK Output DINT Bit-to-bit negation on 32 bits of IN.

NOT_MASK Function Block Diagram example
NOT_MASK Ladder Diagram example
NOT_MASK Structured Text example
(*ST equivalence: *)
result := NOT_MASK (16#1234);
(* result is 16#FFFF_EDCB *)
Results

See also
Integer OR bit-to-bit mask, turns bits on.

OR_MASK (bit to bit OR
Text.

controllers.

Type
TRUE - execute the Integer OR bit-to-bit mask computation.
OR_MASK Output DINT Bit-to-bit logical OR between IN and MSK.
OR_MASK Function Block Diagram example

OR_MASK Ladder Diagram example
OR_MASK Structured Text examples
parity := OR_MASK (xvalue, 1); (* makes value always odd *)
result := OR_MASK (16#abc, 16#f0f); (* equals 16#fbf *)
Results
See also

ROL (rotate left) For 32-bit integers, rotates integer bits to the left.

Text.

controllers.

Type
TRUE - execute the rotate bits left integer value computation.
IN Input DINT Integer value.
NbR Input DINT Number of 1-bit rotations (in set [1..31]).
ROL Output DINT Left rotated value. When NbR <= 0, no change occurs.
ROL Function Block Diagram example

ROL Ladder Diagram example
ROL Structured Text example
result := ROL (register, 1);
(* register = 2#0100_1101_0011_0101*)
(* result = 2#1001_1010_0110_1010*)
Results
See also

ROR (rotate right) For 32-bit integers, rotates integer bits to the right.

Text.

controllers.

Type
TRUE - execute the rotate bits right integer value computation.
IN Input DINT Any integer value.
NbR Input DINT Number of 1-bit rotations (in set [1..31]).
ROR Output DINT Right rotated value. There is no effect if NbR <= 0.
ROR Function Block Diagram example

ROR Ladder Diagram example
ROR Structured Text example
result := ROR (register, 1);
(* register = 2#0100_1101_0011_0101 *)
(* result = 2#1010_0110_1001_1010 *)
Results
See also

SHL (shift left) For 32-bit integers, moves integers to the left and places 0 in the least significant
bit.

Text.

controllers.

Type
TRUE - move integers to the left.
FALSE - there is no integer movement.
NbS Input DINT Number of 1 bit shifts (in set [1..31]).
SHL Output DINT Left shifted value. There is no effect if NbS <= 0. If a value of 0,
replaces the least significant bit.
SHL Function Block Diagram example

SHL Ladder Diagram example
SHL Structured Text example
result := SHL (register,1);
(* register = 2#0100_1101_0011_0101 *)
(* result = 2#1001_1010_0110_1010 *)
Results
See also

SHR (shift right) For 32-bit integers, moves integers to the right and places 0 in the most significant
bit.

Text.

controllers.

Type
TRUE - move integers to the right.
FALSE - there is no integer movement.
NbS Input DINT Number of 1 bit shifts (in set [1..31]).
SHR Output DINT Right shifted value. There is no effect if NbS <= 0. If a value of 0,
replaces the most significant bit.
SHR Function Block Diagram example

SHR Ladder Diagram example
SHR Structured Text example
result := SHR (register,1);
(* register = 2#1100_1101_0011_0101 *)
(* result = 2#0110_0110_1001_1010 *)
Results
See also

XOR_MASK (exclusive OR Integer exclusive OR bit-to-bit mask, returns inverted bit values.

Text.

controllers.

Type
TRUE - perform the exclusive OR bit-to-bit mask computation.

XOR_MASK Output DINT Bit-to-bit logical Exclusive OR between IN and MSK.
XOR_MASK Function Block Diagram example
XOR_MASK Ladder Diagram example

XOR_MASK Structured Text example
crc32 := XOR_MASK (prevcrc, nextc);
result := XOR_MASK (16#012, 16#011); (* equals 16#003 *)
Results
See also

Chapter 8
Boolean instructions
Use Boolean instructions to determine an output value based on a logical

calculation from inputs. The module outputs can be directly controlled from the
program or independently controlled by the module using the Boolean
instructions.
MUX4B on page 184 Multiplexer between four BOOL inputs, outputs a BOOL value.
MUX8B on page 180 Multiplexer between eight BOOL inputs, outputs a BOOL value.
TTABLE on page 177 Provides the value of the output based on the combination of inputs.
F_TRIG on page 167 Detects a falling edge of a Boolean variable.

RS on page 171 Reset dominant bistable.
R_TRIG on page 169 Detects a rising edge of a Boolean variable.

SR on page 175 Set dominant bistable.
Operator Description
AND on page 173 Performs a boolean AND operation between two or more values.
NOT on page 175 Converts Boolean values to negated values.
XOR on page 174 Boolean exclusive OR of two values.
OR on page 172 Boolean OR of two or more values.
See also
F_TRIG (falling edge Detects a falling edge of a Boolean variable. Each time a falling edge is detected,
sets output for one more cycle.
detection)
Text.

Chapter 8 Boolean instructions

controllers.

Type
CLK Input BOOL Checks the input for a falling edge. Any Boolean variable.
TRUE = No falling edge detected.
FALSE = Falling edge detected on input CLK, set output Q to TRUE.
Q Output BOOL Indicates status for Q output.

TRUE = Falling edge detected, sets output Q for one more cycle.
FALSE = No change to output Q.
F_TRIG Function Block Diagram example
F_TRIG Ladder Diagram example
F_TRIG Structured Text example
(* ST Equivalence: F_TRIG1 is an instance of a F_TRIG block *)
F_TRIG1(cmd);
nb_edge := ANY_TO_DINT(F_TRIG1.Q) + nb_edge;

Boolean instructions Chapter 8
Results
See also
Boolean instructions on page 167
R_TRIG (rising edge Detects a rising edge of a Boolean variable.
detector) Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.

controllers.

Type
CLK Input BOOL Any Boolean variable.
TRUE - Rising Edge detected, set Q to TRUE.
FALSE - no Rising Edge detected, set Q to FALSE.
Q Output BOOL TRUE - when CLK is TRUE.
FALSE - in all other cases.

R_TRIG Function Block Diagram example
R_TRIG Ladder Diagram example
R_TRIG Structured Text example
(* ST Equivalence: R_TRIG1 is an instance of a R_TRIG block *)
R_TRIG1(cmd);
nb_edge := ANY_TO_DINT(R_TRIG1.Q) + nb_edge;
Results
See also

RS (reset/set) Resets or sets the dominant bistable.

Text.

controllers.

Type
SET Input BOOL TRUE - sets Q1 to TRUE.
RESET1 Input BOOL TRUE - resets Q1 to FALSE (dominant).
Q1 Output BOOL Boolean memory state.
RS Function Block Diagram example
RS Ladder Diagram example

RS Structured Text example
(* ST Equivalence: RS1 is an instance of a RS block *)
RS1(start_cmd, (stop_cmd OR alarm));

command := RS1.Q1;
Results
See also
OR Performs a logical OR operation of two or more Boolean values and returns the
Boolean value true if either input is true, otherwise returns false.

Text.


controllers.

Type
i1 Input BOOL
i2 Input BOOL
o1 Output BOOL Boolean OR of the input terms.
TRUE - When one or more of the inputs are TRUE.
FALSE - When inputs are FALSE.
OR Structured Text example
bo10 := bi101 OR NOT (bi102);

bo5 := (bi51 OR bi52) OR bi53;
See also
AND Performs a boolean AND operation between two or more values.

Text.

controllers.


Type
i1 Input BOOL Value in Boolean data type.
i2 Input BOOL Value in Boolean data type.
o1 Output BOOL Result of the Boolean AND operation of the input values.
AND Structured Text example
bo10 := bi101 AND NOT (bi102);

bo5 := (bi51 AND bi52) AND bi53;
See also
XOR (exclusive OR) Performs an exclusive OR operation of two Boolean values.

Text.

controllers.

Type
i1 Input BOOL
i2 Input BOOL
o1 Output BOOL Boolean exclusive OR of the two input terms.
TRUE - When one or both of the inputs are TRUE.
FALSE - When both inputs are FALSE.
XOR Structured Text example
bo10 := bi101 XOR NOT (bi102);

bo5 := (bi51 XOR bi52) XOR bi53;

See also
Converts Boolean values to negated values.

NOT
Text.

controllers.

Type
i1 Input BOOL Any Boolean value or complex expression.
o1 Output BOOL TRUE when IN is FALSE.
FALSE when IN is TRUE.
NOT Structured Text example
bo10 := NOT (bi101);
See also
SR (set/reset) Set a dominant bistable.

Text.


controllers.

Type
SET1 Input BOOL TRUE - sets Q1 to TRUE (dominant).
RESET Input BOOL TRUE - resets Q1 to FALSE.
Q1 Output BOOL Boolean memory state.
TRUE - when SET1 is TRUE.
FALSE - when RESET is TRUE.
Dominant bistable example
Set1 Reset Q1 Result Q1

0 0 0 0
0 0 1 1
0 1 0 0
0 1 1 0
1 0 0 1
1 0 1 1
1 1 0 1
1 1 1 1
SR Function Block Diagram example

SR Ladder Diagram example
SR Structured Text example
(* ST Equivalence: SR1 is an instance of a SR block *)
SR1((auto_mode & start_cmd), stop_cmd);

command := SR1.Q1;
Results
See also
TTABLE (truth table) Provides the value of the output based on the combination of inputs.

If the value is 0xABCD and In3 through In0 corresponds to the number 7, then
TTABLE is the value of bit 7 in the table (which is 1). The least significant bit in
the table is bit 0.

Text.

controllers.

Type
Table Input UINT Truth table of BOOLEAN function.
IN0 Input BOOL Any BOOL input value.
TTABLE Output BOOL The value of the output according to the combination of inputs.
TTABLE input combinations
The TTABLE instruction has four inputs, and therefore 16 combinations. These
combinations are found in a truth table; for each combination, the output value
can be adjusted. The number of configurable combinations depends on the
number of inputs connected to the function.
Truth Table combination example.
Number In3 In2 In1 In0

1 0 0 0 0
2 0 0 0 1
3 0 0 1 0
4 0 1 1 1

5 0 1 0 1
6 0 1 1 0
7 0 1 1 1
8 1 0 0 0
9 1 0 0 1
10 1 0 1 0
11 1 0 1 1
12 1 1 0 0
13 1 1 0 1
14 1 1 1 0
15 1 1 1 1
TTABLE Function Block Diagram diagram
TTABLE Ladder Diagram example

TTABLE Structured Text example
Results
See also
MUX8B (multiplexer of 8 Multiplexer between eight BOOL inputs, outputs a BOOL value.
BOOL inputs) Languages supported: Function Block Diagram, Ladder Diagram, Structured
Text.


controllers.

Type
Selector Input USINT Selector integer value, must be in set [0...7].
TRUE - when Selector is 0.
FALSE - when Selector is not 0.


Type
MUX8B Output BOOL TRUE - when:
In0 if Selector = 0
In1 if Selector = 1
In2 if Selector = 2
In3 if Selector = 3
In4 if Selector = 4
In5 if Selector = 5
In6 if Selector = 6
In7 if Selector = 7
FALSE - for all other values of the Selector.
MUX8B Function Block Diagram example

MUX8B Ladder Diagram example
MUX8B Structured Text example
range := MUX8 (choice, 1, 5, 10, 50, 100, 500, 1000, 5000);

(* select from 8 predefined ranges, for example, if choice is 3, range will be 50 *)
Results
See also
MUX4B (multiplexer of 4 Multiplexer between four BOOL inputs, outputs a BOOL value.
BOOL inputs) Languages supported: Function Block Diagram, Ladder Diagram, Structured
Text.

controllers.


Type
Selector Input USINT Selector integer value, must be in set [0...3].
MUX4B Output BOOL TRUE - when:
In0 if Selector = 0
In1 if Selector = 1
In2 if Selector = 2
In3 if Selector = 3
FALSE - for all other values of the Selector.
MUX4B Function Block Diagram example

MUX4B Ladder Diagram example
MUX4B Structured Text example
range := MUX4 (choice, 1, 10, 100, 1000);
(* select from 4 predefined ranges, for example, if choice is 1, range will be 10 *)

Results
See also

Chapter 9
Communication instructions
Use Communication instructions to read, write, compare, and convert

communication strings.
MSG_CIPGENERIC on page 189 Sends a CIP generic explicit message.

MSG_CIPSYMBOLIC on page 200 Sends a CIP symbolic explicit message.
MSG_MODBUS on page 204 Sends a Modbus message.
MSG_MODBUS2 on page 211 Sends a MODBUS/TCP message over an Ethernet Channel.
See also
Communication protocol support on page 253
Configure object data values for explicit messaging on page 225
Message execution processes and timing diagrams on page 218
Use the communication (messaging) function blocks on page 224
MSG_CIPGENERIC (common Sends a common industrial protocol (CIP) explicit message over an Ethernet
channel or a serial port.
industrial protocol generic
message) A maximum of four message requests per channel can be processed in one scan.
For Ladder Diagram programs, message requests are executed at the end of a
ladder scan.

Text.

Chapter 9 Communication instructions

Type
TRUE - Rising Edge detected, start the instruction block with the
precondition that the last operation has been completed.
FALSE - Rising Edge not detected, idle.
CtrlCfg Input CIPCONTROLCFG The instruction block execution control configuration. Use the
CIPCONTROLCFG data type parameters to define CtrlCfg.
AppCfg Input CIPAPPCFG CIP service and application path (EPATH) configuration.
Use the CIPAPPCFG data type parameters to define AppCfg.
TargetCfg Input CIPTARGETCFG Target device configuration.
Use the CIPTARGETCFG data type parameters to define TargetCfg.
ReqData Input USINT[1..1] CIP message request data. The array size should be greater than
the ReqLength size.
ReqLength Input UINT CIP message request data length:
0 - 490
ResData Input USINT[1..1] CIP message response data. The array size should be greater than
the ReqLength size.
When a MSG is triggered or re-triggered, data in the ResData array
is cleared.
Q Output BOOL Outputs of this instruction are updated asynchronously from the
program scan. Output Q cannot be used to re-trigger the
instruction since IN is edge triggered.
TRUE - MSG instruction finished successfully.
FALSE - MSG instruction is not finished.
Status Output CIPSTATUS The instruction block status.
When a MSG is triggered, or re-triggered, all elements inside
Status are reset.
The Status output is defined in CIPSTATUS data type.

Communication instructions Chapter 9

Type
ResLength Output UINT CIP message response data length:
0 - 490
When a MSG is triggered, or re-triggered, ResLength is reset to 0.
MSG_CIPGENERIC Function Block Diagram example
MSG_CIPGENERIC Ladder Diagram example

MSG_CIPGENERIC Structured Text example
See also
CIPCONTROLCFG data type on page 192
CIPAPPCFG data type on page 192
CIPTARGETCFG data type on page 196
CIPSTATUS data type on page 193
Communication instructions on page 189

data from a controller on page 227
CIPAPPCFG data type Use this table to help define the parameters for the CIPAPPCFG data type.
Service USINT Service code:

1 127
Class UINT Logical segments Class ID value:
1 65535
Instance UDINT Logical segments Instance ID value:
0 4294967295
Attribute UINT Logical segments Attribute ID value:
1 - 65535, 0 - No Attribute ID used
MemberCnt USINT Members ID count. Maximum Member ID values used:
1 - 3, 0 - No Member ID used
MemberId UINT[3] Member ID values:
0 - 65535
See also
MSG_CIPSYMBOLIC on page 200
MSG_CIPGENERIC on page 189
CIPCONTROLCFG data type Use this table to help determine the parameter values for the
CIPCONTROLCFG data type.

Parameter Data Type Description

Cancel BOOL TRUE - Cancel the execution of the function block.
Bit is cleared when the message is enabled.
If the Cancel parameter is set, and the message is enabled (EN bit is set) and not done
(DN bit is not set), then the message execution is aborted and the ER bit is set.
1 to 65535: Cyclic trigger value in milliseconds. Msg is triggered periodically when IN
is True. Set the value to 1 to trigger the MSG as quickly as possible.
StrMode USINT Reserved for future use.
CIP message triggering
A CIP message can be triggered periodically by setting a non-zero value to the

TriggerType parameter.
Use this table to help define the actions for the TriggerType parameter.
Action Results
Message is enabled Trigger timer starts
Trigger timer expires before the message Message is immediately triggered in the next ladder scan cycle.
completes
Message completes before the trigger time expires Message is triggered when the trigger time expires.
Example: message triggering
In the following example, the TriggerType value is set to 100.
See also
CIPSTATUS data type Use this table to help determine the parameter values for the CIPSTATUS data
type.

Error BOOL This bit is set to TRUE when the function block execution encounters an error
condition.
ErrorID UINT Error code value.
ErrorIDs are defined in CIPSTATUS error codes.
SubErrorID UINT Sub Error code value.
SubErrorIDs defined in CIPSTATUS error codes.
ExtErrorID UINT CIP extended status error code value.
StatusBits UINT This parameter can be used to verify control bits:
Bit 0: EN Enable
Bit 1: EW Enable Wait
Bit 2: ST Start
Bit 3: ER Error
Bit 4: DN Done
Bit 5: CIPCONN - CIP Connection Closure
Bit 6: EIPSESS - EIP Session Closure
Other bits are reserved
StatusBits are defined for CIPSTATUS status bits.
See also
CIPSTATUS error codes on page 195
CIPSTATUS status bits on page 194
CIPSTATUS status bits The CIPSTATUS status bits are set based on the status of the message execution,
the communication buffers, and the rung conditions.
- - - - - - - - - - 4 3 2 1 0
-
Bit Name Description Behavior

0 EN Enable Set when the rung goes true and remains set until either the DN bit or the ER bit is
set and the rung goes false.
1 EW Enable Set when the communication buffer is allocated for the message request. Cleared
Waiting when the ST bit is set.
2 ST Start Set when the message has been transmitted and is waiting for a reply. Cleared
when the DN bit is set.
3 ER Error Set when message transmission fails. An error code is written to ErrorID. The ER bit
and error code values are cleared the next time the rung goes from false to true.

Bit Name Description Behavior

4 DN Done Set when the message is transmitted successfully. The DN bit is cleared the next
time the rung goes from false to true.
When the Done bit is set, all other bits are cleared to indicate the MSG completed
successfully. When an error is detected and the Error bit is set, the other status bits
(EN/EW/ST) are not cleared.
5 CIPCONN Done Set when the CIP Connection for the Communication is closed. The CIPCONN bit is
applicable when ConnClose is True, for other cases the CIPCONN bit is False. The
CIPCONN bit is also used for Serial, Ethernet and USB.
6 EIPSESS Done Set when the Encapsulation CIP Session for the Communication is closed. The
EIPSESS bit is applicable when ConnClose is True, for other cases the EIPSESS bit is
False. This bit is used for Ethernet only.
See also
CIPSTATUS error codes Use this table to help determine the parameter values for the ErrorID and
SubErrorID fields of the CIPSTATUS parameter when the ER bit is set.
ErrorID SubErrorID Error code description

code
33 Parameter configuration related errors

32 Bad Channel number.
36 Unsupported CIP connection type.

40 Unsupported CIP symbolic data type.
41 Invalid CIP symbol name.
43 Unsupported CIP Class value or MemberID count.
48 The instruction blocks input data array size is not sufficient.
49 Invalid target path.
50 Bad service code.
51 The instruction blocks transmit data array size is too big for CIP communication.
The maximum length for the user data to be transmitted varies for different message
configurations. If the total CIP message payload (including user data and CIP message overload)
is beyond 504 bytes, an error 0x21 (subError 0x33) is reported.
52 Bad Segment type value.

53 Bad UCCM timeout value.
If the encapsulation timeout value is less than the UCCM timeout or the difference between
encapsulation timeout and UCCM time out is less than or equal to one second, an error 0x21
(subError 0x35) is reported.
54 Bad connected timeout value.
If the encapsulation timeout value is less than the CONNECTED message timeout or the
difference between the encapsulation timeout and the CONNECTED message time out is less
than or equal to one second, an error 0x21 (subError 0x36) is reported.
55 Timeout related errors
112 Message timed out while waiting in the message wait queue.

ErrorID SubErrorID Error code description

code
113 Message timed out while waiting for the connection to the link layer to be established.
114 Message timed out while waiting to transmit to the link layer.
115 Message timed out while waiting for a response from the link layer.
69 Server response format related error codes
65 Message reply does not match request.
68 Message reply data type not valid/supported. (MSG_CIPSYMBOLIC).
208 No IP address configured for the network.
209 Maximum number of connections used no connections available.
210 Invalid internet address or node address.
217 Message execution was canceled by user. (Cancel parameter was set to TRUE).
218 No network buffer space available.
222 Reserved.
223 The Link address is not available. A TCP/IP or Ethernet configuration change is in progress.
224 CIP response error code. SubErrorID specifies the CIP status and ExtErrorID specifies the CIP extended status
value. Refer to the CIP specification for possible error code values.
255 Channel is shutdown or reconfiguration is in progress. Error code occurs immediately after power on until a
connection is established, and is normal behavior.
It may also occur in one of the following situations:
An Ethernet cable is disconnected
An IP address cannot be detected
A serial port plug-in is present but not configured
See also
CIPTARGETCFG data type Use this table to help determine the parameter values for the CIPTARGETCFG
data type.

Path STRING[80] Path for the target. A maximum of two hops can be specified. The path syntax
is:
{"<port>,<node/slot address>"}2
CipConnMode USINT CIP Connection type.
0 - Unconnected (default)
1 - Class3 connection


UcmmTimeout UDINT Unconnected message timeout (in milliseconds). The amount of time to wait
for a reply for unconnected messages, including connection establishment for
connected message.
Valid values: 250-10,000 ms.
Set to 0 to use the default value of 3000 ms (3 seconds).
A value set to less than 250 ms will be set to 250 ms (minimum).
A value set to greater than 10,000 ms will be set to 10,000 ms
(maximum).
ConnMsgTimeout UDINT Class3 Connection timeout (in milliseconds). The amount of time to wait for a
reply for connected messages. The connection closes when the timeout
expires.
Valid values: 800-10,000 ms.
Set to 0 to use the default value of 10,000 ms (10 seconds).
A value set to less than 800 will be set to 800 ms (minimum).
A value set to greater than 10,000 ms will be set to 10,000 ms
(maximum).
ConnClose BOOL Connection closing behavior:
TRUE - Close the connection when the message completes.
FALSE - Do not close the connection when the message completed
(default).
See also
CIP/EIP message connections on page 198
CIP message timeout timers on page 199
Target path for CIP messaging on page 197
Target path for CIP messaging The target path for CIP messaging contains parameters which determine the path
and destination of the of the CIP message.
The target path string parameter uses the following syntax:
"<local port>, <1st targets address>, [<1st targets local port>, <2nd
targets address>]"
The 1st hop must be present; the 2nd hop is optional.
String element Description

Local port Local port used to send out the message. The port should be an active EtherNet/IP
or CIP Serial port - USB ports are not supported.


1st Target address Target address of the 1st hop.
For EIP, specify the targets IP address. The IP address should be a unicast
address and should not be 0, multicast, broadcast, local address or a loop back
(127.x.x.x) address.
For CIP Serial, specify the targets node address. The supported value is 1.
Local port of the 1st Target Local port used to send out the message.
2nd Target address Target address of the 2nd hop.
Target path example
The following table lists example values used in a target path string and describes
the results for each string.

"0,0" The target device is the local device.
"6,1" Through Port 6 (Micro830 UPM Serial port) reach the Node at 1.
"4,192.168.1.100" Through Port 4 (Micro850 embedded Ethernet port) reach the Node at
192.168.1.100.
"4,192.168.1.100,1,0" Through Port 4 (Micro850 embedded Ethernet port) reach the Node at
192.168.0.100 (Logix ENET module).
From ENET module, through the Backplane port (Port 1) reach the Logix controller
at Slot 0.
See also
CIP/EIP message connections A maximum of 16 CIP (class 3) and 16 EIP connections are supported for client
message execution. The following table describes the CIP/EIP connection
behavior.
Scenario Results
Message request is enabled and CipConnMode=1. If a connection to the target does not exist, a CIP connection is
established.
If a connection to the target already exists, the existing CIP
connection is used.
Message request is enabled, CipConnMode=1, and the If an EIP connection to the target does not exist, an EIP
message's local port is Ethernet. connection is established prior to establishing a CIP connection.
Message request is enabled, CipConnMode=0, and the If an EIP connection to the target does not exist, an EIP
message's local port is Ethernet. connection is established.

Scenario Results
Message execution is completed, and ConnClose is set If there is only one connection to the target, the connection is
to True. closed.
If there is more than one connection to the target, the
connection is closed when the last message execution is
completed.
When a CIP connection is closed, any associated EIP connection
is also closed.
If more than one CIP connection uses the same EIP connection,
the EIP connection will be closed after all associated CIP
connections are closed.
When ConnClose is true, the message connection and If more than one message shares the same connection then the
EIP Session are closed upon completion of the message connection is closed upon completion of the last message.
execution.
A CIP or EIP connection that is not associated with any See CIP Specification Volume II TCP/IP objects for details
active message is closed if it is idle for x seconds. regarding the CIP Set Service.
Where x is a configurable Encapsulation Inactivity
Timeout value that can be set using the CIP Set Service.
Message execution is completed, and ConnClose is set The connection is not closed.
to False.
Connection is not associated with an active message, The connection is closed.
and remains idle for the amount of time specified in
ConnTimeOut parameter.
Controller transitions from an executing mode (Run, All active connections are forcibly closed.
Remote Run, Remote Test Single Scan and Remote
Single Rung) to a non-executing mode.
See also
CIP message timeout timers The following table describes how timers for CIPTARGETCFG timeout
parameters (UcmmTimeout and ConnMsgTimeout) behave based on message
requests and status.
Action Results
Message is enabled UcmmTimeout timer is activated
Connection is requested ConnMsgTimeout timer is activated
ConnMsgTimeout timer is active UcmmTimeout timer is disabled

Connection request is completed UcmmTimeout timer is reactivated
See also

MSG_CIPSYMBOLIC Sends a common industrial protocol (CIP) symbolic message over an Ethernet
channel or a serial port.
(common industrial
protocol symbolic message) Languages supported: Function Block Diagram, Ladder Diagram, Structured
Text.
MSG_CIPSYMBOLIC operation
When the function block is enabled, the receive buffers for the Read operations
are cleared on the rising edge of Enable.
Arguments

Type
CtrlCfg Input CIPCONTROLCFG The instruction block execution control configuration. Use the
CIPCONTROLCFG data type parameters to define CtrlCfg.
SymbolicCfg Input CIPSYMBOLICCFG Information for the symbol for Read and Write.
TargetCfg Input CIPTARGETCFG Target device configuration.
Use the CIPTARGETCFG data type parameters to define
TargetCfg.
Data Input USINT[490] Read command stores the data returned from the server.
Write command buffers the data to be sent to the server.
When a MSG is triggered or re-triggered, Data is cleared for the
MSG Read command.


Type
Status Output CIPSTATUS Function block execution status
When a MSG is triggered, or re-triggered, all elements inside
Status are reset.
The Status output is defined in CIPSTATUS data type.
DataLength Output UDINT Number of data bytes Read/Written.
When a MSG is triggered or re-triggered, DataLength is reset to
0 for MSG Read command.
MSG_CIPSYMBOLIC Function Block Diagram example
MSG_CIPSYMBOLIC Ladder Diagram example

MSG_CIPSYMBOLIC Structured Text example
See also
CIPCONTROLCFG data type on page 192
CIPSYMBOLICCFG data type on page 202

write a value to a variable on page 238
CIPSYMBOLICCFG data type Use this table to help determine the parameter values for the
CIPSYMBOLICCFG data type.

Service USINT Service code:
0 - Read (default)
1 - Write
Symbol STRING Name of the variable to Read/Write.
Maximum of 80 characters.
Field cannot be empty.
Symbol syntax defined in Symbolic Read/Write syntax.
Count UINT Number of variable elements to Read/Write:
Valid values: 1 - 490
1 is used if the value is set to 0.
Type User-defined User-defined data type for the target variable.
Type defined in Symbolic data type support.
Offset USINT Reserved for future use.
A byte offset of Read/Write variable used to Read/Write a large size variable that
cannot be processed in one message.
0 0xFF
Reserved for future use.
Symbolic data type support
Use this table to help determine the data types MSG_CIPSYMBOLIC supports.

Data type Data type value Description

(hexadecimal)
BOOL 193 (0xC1) Logical Boolean with values TRUE (1) and FALSE (0)
SINT 194 (0xC2) Signed 8bit integer value
INT 195 (0xC3) Signed 16bit integer value
DINT 196 (0xC4) Signed 32bit integer value
LINT 197 (0xC5) Signed 64bit integer value
USINT 198 (0xC6) Unsigned 8bit integer value
UINT 199 (0xC7) Unsigned 16bit integer value
UDINT 200 (0xC8) Unsigned 32bit integer value
ULINT 201 (0xC9) Unsigned 64bit integer value
REAL 202 (0xCA) 32bit floating point value
LREAL 203 (0xCB) 64bit floating point value
STRING 218 (0xDA) Character string
See also
Symbolic Read/Write syntax on page 203
Symbolic Read/Write syntax Syntax defines the combinations of symbols of a valid read/write instruction
block.
Valid symbol names
To be valid, each symbol name must meet the following requirements.
Begin with a letter or underscore character followed by a letter, digit, or

single underscore character.
Be 40 characters or less.
Not contain two consecutive underscore characters.
Use special characters [ ] . , as separators.
Symbol syntax
Use this table to help define the valid syntax for symbols. Only global variables are
supported.
Symbol Syntax Example

Variable PROGRAM:<program name>,<symbol name> PROGRAM:POU1.MyTag
Array <symbol name>[dim3, dim2, dim1] MyTag1[0]
(Maximum supported dimension is 3. MyTag2[3,6]
MyTag3[1,0,4]

Structure <symbol name>.<symbol name of struct field> MyTag4.time.year

MyTag5.local.time[1].year
See also
CIPSYMBOLICCFG data type on page 202
Supported Data Packet Size for For Micro830 and Micro850 controllers, both embedded serial port and plug-in
serial ports can support CIP serial communication. CIP serial communication
CIP Serial Function
data packet includes user data and CIP packet header.
When working as a CIP serial client, Micro830/Micro850 serial ports can support
a maximum of 490 bytes of read/write user data. This maximum specification
applies to CIP serial data packets with a minimum packet header size. When the
size of a packet header is bigger than the minimum packet header size, the
maximum size of user data that the CIP client can support is less than 490 bytes. If
data packet size is greater than the maximum data size supported by the CIP
client, the function block reports an error (0x21) and a sub-error (0x33).
When working as a CIP serial server, Micro830 and Micro850 serial ports can
support a minimum of 255 bytes of read/write user data. This minimum user data
size specification applies to CIP serial data packets with maximum packet header
size. When the size of CIP packet header is less than the maximum packet header
size, the CIP client can support data packet size that is greater than the minimum
specification (that is, greater than 255 bytes). However, if user data size is greater
than the maximum data size supported by the CIP server function, the CIP data
packet could be dropped, and the client will time out.
Important: For CIP serial server function, it is recommended not to read/write more than 255 bytes of user data in a
single CIP message.
See also
MSG_MODBUS (modbus Sends a Modbus message over a serial port.
message) Operation details:
A maximum of four message requests per channel can be processed in one

scan. For Ladder Diagram programs, message requests are executed at the
end of a ladder scan.
If a trigger is set to continuous, error codes are also continuously cleared. To
view error codes, add a rung before the MSG_MODBUS instruction.


Text.

Type
FALSE - Rising Edge not detected, not started.
Cancel Input BOOL TRUE - Cancel the execution of the instruction block.
FALSE - when IN is TRUE.
LocalCfg Input MODBUSLOCPARA Define structure input (local device).
Define the input structure for the local device using the
MODBUSLOCPARA data type.
TargetCfg Input MODBUSTARPARA Define structure input (target device).
Define the input structure for the target device using the
MODBUSTARPARA data type.
LocalAddr Input MODBUSLOCADDR MODBUSLOCADDR is a 125 Word array that is used by Read
commands to store the data (1-125 words) returned by the Modbus
slave and by Write commands to buffer the data (1-125 words) to be
sent to the Modbus slave.
Error Output BOOL Indicates an error occurred.

FALSE - No error.
instruction are defined in MSG_MODBUS error codes.

MSG_MODBUS error codes
This table describes error codes for MSG_MODBUS.
3 The value of the TriggerType has been changed from 2 - 255.

20 The local communication driver is incompatible with the MSG instruction.
21 A local channel configuration parameter error exists.
22 The Target or Local Bridge address is higher than the maximum node address.
33 A bad MSG file parameter exists.

54 A lost modem.
55 The message timed out in the local processor. A link layer timeout.
217 The user cancelled the message.
129 An illegal function.
130 An illegal data address.
131 An illegal data value.
132 A slave device failure.
133 Acknowledge.
134 The slave device is busy.
135 Negative acknowledge.
136 A memory parity error.
137 A non-standard reply.
255 The channel has been shut down.
MSG_MODBUS Function Block Diagram example

MSG_MODBUS Ladder Diagram example
MSG_MODBUS Structured Text example
See also
Example: How to configure Modbus communication to read from and

write to a drive on page 249
MODBUSTARPARA data type on page 211
MODBUSLOCPARA data type on page 207
MODBUSLOCPARA data type Use this table to help determine the parameter values for the
MODBUSLOCPARA data type.

Channel UINT Micro800 PLC serial port number:

5-9 for serial port plug-ins installed in slots 1 through
5 for slot 1
6 for slot 2
7 for slot 3
8 for slot 4
9 for slot 5
1: Msg triggered continuously when IN is True
Other value: Reserved
Cmd USINT Represents one of the following:
01: Read Coil Status (0xxxx)
02: Read Input Status (1xxxx)
03: Read Holding Registers (4xxxx)
04: Read Input Registers (3xxxx)
05: Write Single Coil (0xxxx)
06: Write Single Register (4xxxx)
15: Write Multiple Coils (0xxxx)
16: Write Multiple Registers (4xxxx)
Others: Custom command support.
MODBUSLOCPARA custom command support:

Custom Commands in the range of 0-255 that are not already assigned to a Modbus
command are also supported. If a custom command is used then the
LocalCfg:ElementCnt contains the number of bytes received.
The response is received into the Local Address Data and overwrites the request data.
Example for CMD=0x2B
Local Address Data 1:0x0E, READ_DEVICE_ID_MEI
Local Address Data 2:0x01, READ_DEV_ID_BASIC
Local Address Data 3:0x00, Read Vendor Object
ElementCnt UINT Limits
For Read Coil/Discrete inputs: 2000 bits
For Read Register: 125 words
For Write Coil: 1968 bits
For Write Register: 123 words
MSG_MODBUS message triggering
A Modbus message can be triggered periodically by setting a non-zero value to the

This table describes the TriggerType parameter behavior when used with the
MSG_MODBUS function block.
Action Results
Message is enabled Trigger timer starts
Trigger timer expires before the message completes Message is immediately triggered in the next ladder scan cycle.
Message completes before the trigger time expires Message is triggered when the trigger time expires.
Example: message triggering
In the following example, the TriggerType value is set to 100.
See also
MSG_MODBUS on page 204
Message execution process The following process diagram describes the message instruction events that occur
when the Rung condition is True.
(Rung = TRUE)

Com queue: Message requests added to the Com queue have a buffer allocated
and processed by the communication task. The maximum queue size limit is 4.
Wait queue: Messages that cannot be added to the Com queue are added to the
Wait queue to be processed at a later time. The Wait queue does not have a
maximum size limit.
See also

MODBUSTARPARA data type The following table describes the MODBUSTARPARA data type.

Addr UDINT Target data address (1 - 65536). Decreases by one when sending.
Node USINT The default slave node address is 1. The range is 1- 247. Zero is the Modbus
broadcast address and is only valid for Modbus write commands (for example, 5, 6,
15 and 16).
See also
MSG_MODBUS2 Sends a MODBUS/TCP message over an Ethernet Channel.
(MODBUS/TCP message) Operation details:
A maximum of four message requests per channel can be processed in one

scan. For Ladder Diagram programs, message requests are executed at the
end of a ladder scan.
When MSG_MODBUS2 is enabled, the receive buffers for Read
operations are cleared on the rising edge of Enable.
Canceling the execution of the MSG_MODBUS2 instruction does not
guarantee the message request going out is Cancelled, but does guarantee
the response is not processed.

Text.
This instruction applies to the Micro820 and Micro850 controllers.


r Type
Cancel Input BOOL TRUE - Cancel the execution of the instruction block. Canceling
the execution of the MSG_MODBUS2 instruction does not
guarantee the message request going out is Cancelled, but does
guarantee the response is not processed.
FALSE - when IN is TRUE.
LocalCfg Input MODBUS2LOCPARA Defines structure input (local device).
Define the input structure for the local device using the
MODBUS2LOCPARA data type.
TargetCfg Input MODBUS2TARPARA Defines structure input (target device).
Define the input structure for the target device using the
MODBUS2TARPARA data type.
LocalAddr Input MODBUSLOCADDR MODBUSLOCADDR data type is a 125 Word array.
LocalAddr usage:
For Read commands, store the data (1-125 words) returned
by the Modbus slave.
For Write commands, buffer the data (1-125 words) to be
sent to the Modbus slave.
Error Output BOOL Indicates an error detected.
TRUE - An error occurred.
FALSE - No error.
instruction are defined in Modbus2 error codes.
SuberrorID Output UINT Used to verify status bits:
Bit 0: EN Enable
Bit 1: EW Enable Wait
Bit 2: ST Start
Bit 3: ER Error
Bit 4: DN Done
Other bits are reserved.
StatusBits Output UINT SubError code value when Error is TRUE.
When a MSG is triggered, or re-triggered, a previously set
SubErrorID is cleared.
MSG_MODBUS2 error and sub-error codes
When the ER bit is set, the ErrorID and SubErrorID fields display the following
error codes.

Error ID SubErrorID Description
33 Parameter configuration related errors

32 Bad Channel number.
37 Bad Element count.
38 Bad Data Address.
55 Timeout related errors
112 Message timed out while waiting in the message wait queue.
113 Message timed out while waiting for the a connection to the link layer to be established.
114 Message timed out while waiting to transmit to the link layer.
115 Message timed out while waiting for a response from the link layer.
69 Message response format related error codes
208 No IP address configured for the network.
209 Maximum number of connections used no connections available.
210 Invalid internet address or node address.
217 Message execution was canceled by user. (Cancel parameter was set to TRUE).
222 TCP/IP socket or communication failure.
255 Channel is shutdown or reconfiguration is in progress. Error code occurs immediately after power on until a
connection is established, and is normal behavior. It may also occur if an Ethernet cable is disconnected or an
IP address cannot be detected.
Slave response error codes
129 Illegal Function Code
130 Illegal Data Address
131 Illegal Data Value

132 Server Failure
133 Acknowledge
134 Negative Acknowledge
136 Memory parity Error
137 Non-standard reply error code. Actual error code can be found in the SubErrorID.

MSG_MODBUS2 Function Block Diagram example
MS_MODBUS2 Ladder Diagram example
MSG_MODBUS2 Structured Text example
See also

MODBUS2LOCPARA data type on page 215
MODBUS2TARPARA data type on page 216
MODBUS2LOCPARA data type Use this table to help determine the parameter values for the
MODBUS2LOCPARA data type.

Channel UINT Local Ethernet port number:
4 for Micro850 & Micro820 embedded Ethernet port.
TriggerType UDINT Message trigger type:
1 to 65535 - Cyclic trigger value in milliseconds. Message triggered periodically
when IN is true and the previous message execution completes.
Set the value to 1 to trigger messages as quickly as possible.
See MSG_MODBUS2 message triggering.
Cmd USINT Modbus command:
01: Read Coil Status (0xxxx)
02: Read Input Status (1xxxx)
03: Read Holding Registers (4xxxx)
04: Read Input Registers (3xxxx)
05: Write Single Coil (0xxxx)
06: Write Single Register (4xxxx)
15: Write Multiple Coils (0xxxx)
16: Write Multiple Registers (4xxxx)
Others: Custom command support
MODBUS2LOCPARA custom command support:

Custom Commands in the range of 0-255 not already assigned to a Modbus
command are also supported. If a custom command is used then
LocalCfg:ElementCnt contains the number of bytes received.
The response is received in Local Address Data and overwrites the request data.
Example for CMD=0x2B:
Local Address Data 1:0x0E, READ_DEVICE_ID_MEI
Local Address Data 2:0x01, READ_DEV_ID_BASIC
Local Address Data 3:0x00, Read Vendor Object
ElementCnt UINT Limits
For Read Coil/Discrete inputs: 2000 bits
For Read Register: 125 words
For Write Coil: 1968 bits
For Write Register: 123 words
MSG_MODBUS2 message triggering
A Modbus message can be triggered periodically by setting a non-zero value to the


This table describes what happens when the TriggerType parameter is used with
the MSG_MODBUS2 function block.
Action Results
Message is enabled. Trigger timer starts.
Trigger timer expires before the message completes. Message is immediately triggered in the next ladder scan
cycle.
Message completes before the trigger time expires. Message is triggered when the trigger time expires.
See also
MSG_MODBUS2 on page 211
MODBUS2TARPARA data type Use this table to help determine the parameter values for the
MODBUS2TARPARA data type.
Addr UDINT Target devices Modbus data address:

1 - 65536.
Decreases by one when sending.
Firmware uses low-word of address if the address value is greater than 65536.
NodeAddress[4] USINT Target devices IP address. The IP address should be a valid unicast address and
cannot be 0, multicast, broadcast, local address or loop back address (127.x.x.x).
For example, to specify 192.168.2.100:
NodeAddress[0]=192
NodeAddress[1]=168
NodeAddress[2]=2
NodeAddress[3]=100
Port UINT Target TCP port number. Standard Modbus/TCP port is 502.
1 - 65535
Set to 0 to use the default value 502
UnitId USINT Unit Identifier. Used to communicate with slave devices through a Modbus bridge.
Refer Modbus specification for more details. Note that Micro800 shall not attempt to
validate this value.
0 - 255
Set to 255 if Target device is not a bridge.
MsgTimeOut UDINT Message timeout (in milliseconds). Amount of time to wait for a reply for an
initiated command.
250-10,000
Set to 0 to use the default value 3,000.
A value less than 250 (minimum) is set to 250.
A value greater than 10,000 (maximum) is set to 10,000.
See Modbus/TCP message timeout timers.

ConnTimeOut UDINT TCP Connection establishment timeout (in milliseconds). Amount of time to wait for
establishing successful TCP connection to the Target device.
250-10,000
Set to 0 to use the default value 5,000.
A value less than 250 (minimum) is set to 250.
A value greater than 10,000 (maximum) is set to 10,000.
See Modbus/TCP message timeout timers.
ConnClose BOOL TCP connection closing behavior.
True - Close the TCP connection upon message completion.
False - Do not close the TCP connection upon message completion [Default].
See Modbus/TCP message connections.
Modbus/TCP message timeout timers
This table describes the behavior for MsgTimeOut and ConnTimeOut based on
message requests and status.
Action Results
Message is enabled. Activates the MsgTimeOut timer.
TCP connection is requested. Activates the ConnTimeOut timer.
ConnTimeOut timer is active. Disables the MsgTimeOut timer.
Connection request is complete. Reactivates the MsgTimeOut timer.
Modbus/TCP message connections
Modbus/TCP client supports a maximum of 16 connections. This table describes

Modbus/TCP connection behavior.
Scenario Results
Message request is enabled, and a connection If a connection to the target does not exist, a new connection is
to the target does not exist. established.
If a connection to the target already exists, the existing connection is
used.
Message execution is completed, and If there is only one connection to the target, the connection is closed.
ConnClose is set to True. If there is more than one connection to the target, the connection is
closed when the last message execution is completed.
Message execution is completed, and The connection is not closed.
ConnClose is set to False.
Connection is not associated with an active The connection is closed.
message, and remains idle for the amount of
time specified in ConnTimeOut parameter.
Controller transitions from an executing mode All active connections are forcibly closed.
(Run, Remote Run, Remote Test Single Scan
and Remote Single Rung) to a non-executing
mode.

See also
The following topics describe how and when MSG_CIPGENERIC,

Message execution
MSG_CIPSYMBOLIC and MSG_MODBUS2 message instructions execute
processes and timing based on their bit and rung conditions.
diagrams
Message execution process (general) on page 218
Message execution process (Rung = TRUE) on page 209
Message execution timing diagram (Rung = True) on page 221
Message execution process (Rung = FALSE) on page 221
Message execution timing diagram (Rung = FALSE) on page 222
Message execution process (Error) on page 223
Message execution timing diagram (Error) on page 224
See also
Message execution process The following diagram shows how and when messages execute based on the status
of the Com queue.
(general)

The following table describes the sequence of events identified in the preceding
diagram.
No. Description of events
1 The message is enabled.

If the Com queue is empty, the buffer is allocated for the message and the message is added to the Com queue
for transmission.
The Com queue size is 4 and each channel has a separate queue.
2 If the Com queue is full, the message is added to the Wait Queue.
When the Com queue is empty, the message in the Wait queue is added to the Com queue.
There is no size limit for the Wait Queue and each channel has a separate queue.
3 The communication task executes the messages in the Com queue on every End-of-Scan for transmission.
Each channel's queue is processed one by one in a round robin fashion.
One message from each channel is executed, and the process continues until all messages are executed or the
communication schedule (10ms) expires.
The channel next to the last processed channel is scheduled to appear first in the next End-of-Scan.
See also
when the Rung condition is True.
(Rung = TRUE)

Com queue: Message requests added to the Com queue have a buffer allocated
and processed by the communication task. The maximum queue size limit is 4.
Wait queue: Messages that cannot be added to the Com queue are added to the
Wait queue to be processed at a later time. The Wait queue does not have a
maximum size limit.
See also

Message execution timing The following table describes the message conditions and bit status for each
execution step identified in the timing diagram while the rung condition remains
diagram (Rung = TRUE)
true.
Step Message description Bit status

1 Rung condition goes TRUE. EN bit is set.
Message execution is enabled. All other bits are cleared.
2 Message control buffer is acquired. At this time, input data (that is, the EW bit is set.
"data" parameter for write messages) is copied for transmission.
Subsequent changes to the input data will not be reflected in the
transmitted message.
3 Message transmission starts. EW bit is cleared.
ST bit is set.
4 Message response is received. ST bit is cleared.
DN bit is set.
5 Rung condition goes FALSE. EN bit is cleared.
Timing diagram for (Rung = TRUE)
See also
when the Rung condition is False.
(Rung = FALSE)

See also
Message execution timing The following table describes the message conditions and bit status for each
execution step identified in the timing diagram when the rung goes to FALSE
diagram (Rung = FALSE)
during execution.



2 Rung condition goes FALSE.
Message execution continues.
3 Message buffer is acquired.At this time, input data (that is, the EW bit is set.
"data" parameter for write messages) is copied for transmission.
Subsequent changes to the input data will not be reflected in the
transmitted message.
ST bit is set.
5 Message response is received. ST bit is cleared.
DN bit is set.
6 Message is scanned again after step 5. EN bit is cleared.
Timing diagram for (Rung = FALSE)
See also
Message execution process The following table describes the message conditions and bit status for each
execution step identified in the timing diagram when an error occurs during
(Error)
execution.



2 Message buffer is acquired. EW bit is set.
ST bit is set.
4 Message transmission times out. EW and ST bits do not change.
4-6 As rung condition goes FALSE. EN bit is cleared.
ER bit is set.
See also
Message execution timing The following timing diagram shows a typical pattern when an error occurs during
execution.
diagram (Error)
See also
Use the communication This section provides specific details and examples for using communication
instructions in logic programs. See the following topics for details of and examples
(message) function blocks for using the MSG_CIPGENERIC and MSG_CIPSYMBOLIC function blocks
to create programs.

See also

data from a controller on page 227

Example: How to configure Modbus communication to read from and

write to a drive on page 249
Configure object data values for To use the MSG_CIPGENERIC function block for explicit messaging, configure
the AppCfg parameter with the correct values.
explicit messaging
(MSG_CIPGENERIC) For additional information about message communication
There are several sources of information covering the implementation and use of
message communication, including Connected Components Workbench Help,
user manuals and the Rockwell Automation Literature Library.
The following table lists additional sources of information relevant to message

communication.
Information source Description How to find the information

User manual for your Contains important information about Connected Components Workbench Help
specific communication messaging and specific information for menu
device configuring message function blocks.
EtherNet/IP Adapter Provides information about the EtherNet/IP Connected Components Workbench Help
22-COMM-E FRN 1.xxx, objects that can be accessed using Explicit menu
Appendix C Messages.
EtherNet/IP specification Defines the objects to be included in every CIP ODVA web site (http://www.odva.org)
device: Identity object, Message Router object
and the Network object.
Micro800 Programmable Provides quickstart instructions for using CIP Rockwell Automation Literature Library
Controllers: Getting Started GENERIC and CIP Symbolic Messaging in
with CIP Client Messaging Micro830 and Micro850 programmable logic
controllers (PLC).
To access user manuals and quickstart guides:
1. To access quickstart guides, on the Help menu, click View Help.
2. Double-click on Connected Components Workbench.

3. Double-click on Getting Started with Connected Components

Workbench.
4. To access drive manuals, on the Help menu, click User Manuals to display
the Manuals dialog box.
5. Click the plus (+) sign next to Drives to expand the category, and then
expand the class until the manual is located.
6. Double-click the manual name to open the .pdf file.
7. To access the EtherNet/IP manual, on the Help menu, click User Manuals
to display the Manuals dialog box.
8. Click the plus (+) sign next to Drives to expand the category, and then
expand the PowerFlex 4-class Peripherals class.
9. Double-click the 22-COMM-E EtherNet/IP Adapter User Manual to open

the .pdf file.
To access manuals from the Rockwell Automation Literature Library:
1. Go to http://literature.rockwellautomation.com .
2. Click Advanced Search.
3. Enter the product information and other search criteria.
4. Click Search.
This example shows search criteria for Kinetix manuals:
5. To access non-English language versions of user manuals, select the language

from the Publication Language drop-down box (right corner).
6. Enter the full or partial device catalog number in the Search box. For
example, enter 2080-LC30 to view Micro830 user manuals.
7. From the Publication Language drop-down box (right corner), select a

language.

8. In the Search box, type the full or partial device catalog number. For
example, enter 2080-LC30 to view Micro830 user manuals.
CIP Register object data
MSG_CIPGENERIC function blocks use the CIP Register object data in the
AppCfg parameter. The object data includes the following:
Class Code
Instance
Instance Attribute
Service
Values for the MSG_CIPGENERIC AppCfg parameter
Use the values from the CIP register object in your input variables to configure the
MSG_CIPGENERIC function block parameters. The following image shows the
CIP register object data values used in the MSG_CIPGENERIC function block
parameters.
See also
Using the communication (messaging) function blocks on page 224
Example: How to create a This example shows how to create a message program that retrieves Controller B
catalog information from Controller A using a MSG_CIPGENERIC function
MSG_CIPGENERIC messaging
block and a COP function block.
program to read data from a
controller

Perform the following tasks to create a MSG_CIPGENERIC messaging program

that reads information from a different controller.
No Task
1 Identify initial values for the input variables (MSG_CIPGENERIC) on page 228
2 Add a MSG_CIPGENERIC function block and variables on page 229
3 Configure initial values for variables on page 231
4 Add a contact and a coil on page 234
5 Add a COP function block, variables and contact (MSG_CIPGENERIC) on page 235
6 Verify correct IP configuration on Controller B on page 237
See also
Identify initial values for the input Follow these general steps to add input variables and initial values, and obtain the
variables, MSG_CIPGENERIC Identity Object values to configure the AppCfg parameter initial values.
To add input variables and initial values:
1. From the Help menu, click User Manuals.
2. Expand the Drives selection and locate the user manual for the type of
communication adapter you are using (EtherNet/IP Adapter User
Manual).
3. Double-click the manual to open it.

4. Review the Appendix headings to locate the section that provides

information about the EtherNet/IP objects that can be accessed using
Explicit Messages (Appendix C).
5. Go to the Appendix section and identify the object type related to your
explicit message (Identity object).
6. Identify the initial values for the AppCfg parameters based on the type
information being retrieved.
Ethernet/IP object data and AppCfg parameters example
The following table identifies the specific Ethernet/IP object data used to read
catalog information from a controller.
Input variable AppCfg Ethernet/IP Description Initial value

example parameter object data
option
MyAppCfg.Service Service Service code Implement for class = Yes 14
Implement for Instance = Yes (0x0E in
Get attribute single hexadecimal)
MyAppCfg.Class Class Class code EtherNet/IP object class = Identity object 01

MyAppCfg.Instanc Instance Instances 22-COMM-E 01
e
MyAppCfg.Attribu Attribute Instance attribute Get product name and rating as SHORT 07
te STRING
See also
Add a generic message function block and variables on page 229
Example: How to configure explicit messaging (MSG_CIPGENERIC)

on page 227
Add a MSG_CIPGENERIC function To add a MSG_CIPGENERIC function block to a ladder diagram program and
block and variables then add input variables to the function block, perform the following steps.
To add a MSG_CIPGENERIC function block:
1. Add a controller:
Expand the Controllers folder and the Micro850 folder to view all
Micro850 controllers.
Double-click a controller (2080-LC50-48QVB) to add it to Project
Organizer.
2. Add a ladder diagram program:

In Project Organizer, right-click Programs, click Add, and then

click New LD: Ladder Diagram.
Right-click the ladder diagram icon in Project Organizer,
click Rename and type CIPExplicitMessage.
Double-click the ladder diagram program in Project Organizer to
display the LD POU in the language editor.
3. Add the MSG_CIPGENERIC function block:
In the Toolbox, select Instruction Block and drag and drop it onto
the ladder rung to display the Instruction Block Selector.
In Search, type MSG to display the message function blocks.
Type MSG_ReadDrive in the Instance field.
Double-click MSG_CIPGENERIC to add an instance of the function
block to the ladder diagram.
4. Add MSG_CIPGENERIC local input variables:
In Project Organizer, double-click Local Variables to display

the Local Variables page.
In the Variables page, add the variables and data types listed in the
table.
Parameter Variable Name Data Type
CtrlCfg MyCtrlCfg CIPCONTROLCFG
AppCfg MyAppCfg CIPAPPCFG
TargetCfg MyTargetCfg CIPTARGETCFG
ReqData MyReqData USINT
ReqLength MyReqLength UINT
ResData MyResData USINT (array)
5. For the MyResData variable, double click Dimension and change the array
size to [1..81].

The Variables page should look similar to the following image.
See also
Configure initial values (MSG_CIPGENERIC) on page 231

on page 227
Identify initial values for the input variables (MSG_CIPGENERIC)

on page 228
Configure initial values for variables Follow these steps to add initial values to the input variables you previously
created and then assign the variables to the correct MSG_CIPGENERIC
function block input parameter.
To assign variables to MSG_CIPGENERIC:
1. To configure initial values for the MyCtrlCfg input variable:
From the Local Variables page, expand MyCtrlCfg to view its

parameters.
Enter the following values in the Initial Value column for each
parameter.
Parameter Initial value Comments
MyCtrlCfg.Cancel Leave blank Not needed.
MyCtrlCfg.TriggerType 0 We only need to retrieve the catalog number
once.
MyCtrlcfg.StrMode Leave blank Not needed.
2. To configure initial values for the MyAppCfg input variable

From the Local Variables page, expand MyAppCfg to view its

parameters.
parameter.
Parameter Initial value
MyAppCfg.Service 14
MyAppCfg.Class 01
MyAppCfg.Instance 01
MyAppCfg.Attribute 07
3. To configure initial values for the MyTargetCfg input variable
From the Local Variables page, expand MyTargetCfg to view its

parameters.
parameter.
Parameter Initial Value Comments
MyTargetCfg.Path 4,192.168.100. The first 4 indicates the message is being sent out of the
4 embedded Ethernet port.
192.168.100.4 is the IP address of the drive Ethernet
interface.
MyTargetCfg.CipConnMode 0 Unconnected is preferred for CIP messages.
MyTargetCfg.UcmmTimeout blank Unconnected messages have a timeout default of 3000
milliseconds if their Initial Values are blank.
MyTargetCfg.ConnMsgTime blank Connected messages have a timeout default of 3000
out milliseconds if their Initial Values are blank.
MyTargetCfg.ConnClose FALSE For Connected messaging, the CIP connection could be
closed immediately after completion of the message
instruction by setting the Initial Value to TRUE.

The parameters in the Variables page should look similar to the

following image.
4. To assign the variables to the parameters
In the ladder diagram POU, click the top portion of the variable input
block to display the variable drop-down list.
From the list, assign each input parameter to its correct input variable as
identified in the following table.
Parameter Input variable Comments
CtrlCfg MyCtrlCfg The catalog number must only be retrieved one time so the
MyCtrlCfg.TriggerType initial value is set to 0.
AppCfg MyAppCfg The initial values were determined by looking up the object
data values for Service, Class, Instance and Attribute.
Target MyTargetCfg The initial values are for target device configuration.
ReqData MyReqData Because this is a Read message, there is no request data so the
ReqData parameters is not used.
ReqLength MyReqLength Because this is a Read message, there is no request data so the
ReqLength parameters is not used.
ResData MyResData The catalog number string is stored in the array in the ODVA
short string format.
The first array element defines the strength length and the rest
store the string character's hexadecimal value.
The maximum number of characters is 80, plus the length
element so MyResData is defined as a 1 dimension array with
81 elements.

The instance of the MSG_CIPGENERIC function block should look

similar to the following image.
See also
Add a generic message function block and variables on page 229
Add a contact and a coil on page 234

on page 227
Add a contact and a coil Use the following steps to add a coil and a contact to the MSG_CIPGENERIC
instruction that converts the catalog information to a human readable string.
To add a coil to MSG_CIPGENERIC:
1. In the Toolbox, select Direct Contact and drag and drop it to the left of
the MSG_CIPGENERIC function block input on the first ladder rung.
2. In the Variable Selector, type Get_Catalog in the Name field for the
contact.
3. In the Toolbox, select Direct Coil and drag and drop it to the right of the
MSG_CIPGENERIC function block output on the first ladder rung.
4. In the Variable Selector, type Convert_String in the Name field for the
coil.

The first rung of your ladder diagram program for MSG_CIPGENERIC

messaging should look similar to the following image.
See also
Add a COP function block, variables and contact on page 235

on page 227
Add a COP function block, variables Use the following steps to add a COP function block, variables and a contact. The
and contact (MSG_CIPGENERIC) COP instruction is used to convert data from the source data type (for example,
DINT or REAL) to the destination data type. In this example, the catalog
information is converted to a human readable string.
To add a COP function block:
1. In the Toolbox, select Rung and drag and drop it directly under the first
ladder rung to add a second rung.
2. Add the COP function block:
In the Toolbox, select Block and drag and drop it onto the second
ladder rung to open the Instruction Block Selector.
Double-click COP to add an instance of the function block to the
ladder diagram.
3. Add local input variables for COP:

In Project Organizer, double-click Local Variables to display

In the Local Variables page, add the variables and data types listed in
the following table.
Parameter Variable name Data type
Src MyResData Array USINT
SrcOffset 0 UINT
Dest CatalogID Array STRING
DestOffset 0 UINT
Length 1 UINT
Swap FALSE BOOLEAN
4. For the CatalogID variable, double click Dimension and change the array
size to [1..1]
5. Add a contact:
In the Toolbox, select Direct Contact and drag and drop it to the left
of the COP function block input on the second ladder rung.
In the Variable Selector, select the Convert_String variable for the
contact.
Result
The second rung of your ladder diagram program for MSG_CIPGENERIC


See also
Add a contact and a coil on page 234
Verify correct IP configuration on Controller B on page 237
Verify correct IP configuration on Follow these steps to verify the IP address settings are correct on Controller B.
Controller B
To verify the IP address:
1. Open the application workspace for the controller:
2. In Project Organizer, double-click the controller to open the controller

workspace.
3. In the controller workspace, expand Ethernet in the Controller tree and

then click Internet Protocol to display the controller configuration page.
4. Verify the IP address settings are correct as identified in the following table.
IP configuration option Value

IP address 192.168.1.19
Subnet Mask 255.255.255.0
Gateway address 192.168.1.1
Results

The Internet Protocol options in your controller configuration page should look
See also
Add a MSG_CIPSYMBOLIC function block, variables and a contact

on page 243
Create global variable for Controller B on page 247

Example: How to create a This example shows how to create a message program to write a value to a
Controller B global variable from Controller A.
MSG_CIPSYMBOLIC messaging
program to write a value to a
variable

To create a MSG_CIPSYMBOLIC messaging program used to write a value to a

global variable on another controller, perform the following tasks.
No Task
1 Add a COP function block, variables and a contact (MSG_CIPSYMBOLIC) on page 239
2 Add an Equal operator and a coil on page 241
3 Add a MSG_CIPSYMBOLIC function block, variables and a contact on page 243
4 Verify correct IP configuration on Controller B on page 237
5 Create global variable for Controller B on page 247
6 Review the complete program results on page 247
See also
Add a COP function block, variables The COP instruction is used to convert the data you enter to the destination data
and a contact (MSG_CIPSYMBOLIC) type so the data is compatible with the controller variable.
To add a COP function block:
1. Add a controller:
Expand the Controllers folder and the Micro850 folder to view all
Micro850 controllers.
Double-click a controller (2080-LC50-48QVB) to add it to Project
Organizer.
2. Add a ladder diagram program:

In Project Organizer, right-click Programs, click Add, and then

click New LD: Ladder Diagram.
Right-click the ladder diagram icon in Project Organizer,
click Rename and type CIPSymbolicMessage.
Double-click the ladder diagram program in Project Organizer to
display the LD POU in the language editor.
3. Add a COP function block:
the first ladder rung to open the Instruction Block Selector.
In Search, type COP, and double-click COP to add an instance of the
function block to the ladder diagram.
4. Add COP variables and initial values:
In the ladder diagram POU, double-click Local Variables to open

In the Variables page, add the variables and data types listed in the
table below.
5. Create Arrays:
For ValueToWrite, double-click Dimension and change the array size

to [1..1].
For A_Data, double-click Dimension and change the array size to
[1..4].
6. Enter the data from the Value column of the table below into the Initial
Value field for each variable.
7. Add a contact:
of the COP function block input on the first ladder rung.
In the Variable Selector, assign a variable named Convert_Data to
contact.
Use the variables defined in the table for the COP function block.

Src ValueToWrite Array UDINT
Initial value:
987654321


SrcOffset 0 UINT
Dest A_Data Array USINT
DestOffset 0 UINT
Length 4 UINT
Swap TRUE BOOLEAN
STS COPsts Array UINT
The first rung of your ladder diagram program for MSG_CIPSYMBOLIC

See also
Add an Equal operator and a coil on page 241

Add an Equal operator and a coil The Equal instruction is used to trigger writing a value if the data type conversion
was successful. To add an Equal (=) operator, variables and a coil, perform the
following steps.
To add an Equal operator:
1. In the Toolbox, select Rung and drag and drop it directly under the first
ladder rung to add a second rung.
2. Add an Equal operator:

the second ladder rung to open the Instruction Block Selector.
In Search, type the '=' sign and double-click '=' to add an instance of
the operator to the ladder diagram.
3. To add Equal variables:
In the ladder diagram POU, double-click a variable to display

the Variable Selector.
In the Variable Selector, assign variable names as listed in the
following table.
Parameter Variable name
i1 COPsts
i2 1
4. To add a coil to the Equal operator:
In the Toolbox, select Direct Coil and drag and drop it to the right
of the Equal operator output on the second ladder rung.
In the Variable Selector, type WriteValue in the Name field for
the coil.
The second rung of your ladder diagram program for
MSG_CIPGENERIC messaging should look similar to the following
image.
See also
Add a COP function block, variables and a contact on page 239

on page 243


Add a MSG_CIPSYMBOLIC function To add a MSG_CIPSYMBOLIC function block, input variables and a contact to
block, variables and a contact a ladder diagram, perform the following steps.
To add function block and variables:
1. In the Toolbox, select Rung and drag and drop it directly under the second
ladder rung to add a third rung.
2. Add the MSG_CIPSYMBOLIC function block:
the ladder rung to display the Instruction Block Selector.
In Search, type MSG to display the message function blocks.
Type MSG_WriteVariable in the Instance field.
Double-click MSG_CIPSYMBOLIC to add an instance of the
function block called MSG_WriteVariable to the ladder diagram.
3. Assign variable names:
In the ladder diagram POU, double-click a variable to display

the Variable Selector.
In the Variable Selector, assign variable names as listed in the
following table.
4. For the Data variable, double click Dimension and change the array size to
[1...4].
5. Configure initial values for the local variables, add CtrlCfg initial values:
From the Local Variables page, expand the CtrlCfg parameter to view
additional parameters.
parameter.
A_CtrlCfg.Cancel Leave blank
A_CtrlCfg.TriggerType 300
A_Ctrlcfg.StrMode Leave blank
6. Add SymCfg initial values:

From the Local Variables page, expand the SymCfg parameter to view
additional parameters.
parameter.
A_SymCfg.Service 1
A_SymCfg.Symbol 'UDINT_FromA'
A_SymCfg.Count Leave blank
A_SymCfg.DataType 200
A_SymCfg.Offset Leave blank
The Local Variables selector should look similar to the following

image.
7. Configure initial values for TargetCfg
From the ladder diagram POU, double-click the A_TarCfg variable to

open the global variables selector.
Expand the TargetCfg parameter to view additional parameters.
parameter.
A_TarCfg.Path '4,192.168.1.19'
A_TarCfg.CipConnMode 1
A_TarCfg.UcmmTimeout 0
A_TarCfg.ConnMsgTimeout 0
A_TarCfg.ConnClose Leave blank

The User Global Variables selector should similar to the following

image.
8. Add a contact:
of the MSG_CIPSYMBOLIC function block input on the third ladder
rung.
In the Variable Selector, assign the WriteValue variable to the
contact.
The third rung of your ladder diagram program for MSG_CIPSYMBOLIC
See also
Add an Equal operator and a coil on page 241

Verify correct IP configuration on Follow these steps to verify the IP address settings are correct on Controller B.
Controller B

To verify the IP address:
1. Open the application workspace for the controller:

workspace.
3. In the controller workspace, expand Ethernet in the Controller tree and

then click Internet Protocol to display the controller configuration page.
4. Verify the IP address settings are correct as identified in the following table.
IP configuration option Value

IP address 192.168.1.19
Subnet Mask 255.255.255.0
Gateway address 192.168.1.1
Results
The Internet Protocol options in your controller configuration page should look
See also

on page 243


Create global variable for Controller Follow these steps to create a Global variable for controller B.
B
To create a Global variable:
1. In Project Organizer, double-click Global Variables to display the Global

Variables selector.
2. Type UDINT_FromA in the Name column.
3. Configure the remaining parameters:
Verify the data type is UDINT.

Verify the Read/Write attribute is selected.
The Global Variables selector should look similar to the following image.
See also
Review the complete program results on page 247
Review the complete program results The following example shows the complete MSG_CIPSYMBOLIC messaging
program after it has executed.

Controller B results
The following two images show the values for Controller B before and after the
messaging program is executed.
Before the program executes

After the program executes
See also
Example: How to configure These examples describe how to configure Modbus communication to read status
data from and write control data to a PowerFlex 4 drive using the
Modbus communication to read
MSG_MODBUS instruction.
from and write to a drive
Micro830 wiring
This example uses a Micro830 controller with a SERIALISOL module plugged

into the first slot (Channel 5). A single PowerFlex 40 is connected, but the
diagram below shows how to wire for multi-drop. Refer to the user manual for
additional wiring information.

Modbus Read example
The following MSG_MODBUS instruction can be used to read status data from
the PowerFlex 40 drive.
Drive status
An "1807" indicates the drive is
Ready (bit 0 ON),

Active (bit 1 ON)
Commanded Forward (bit 2 ON)
Rotating Forward (bit 3 ON)
Status of some digital inputs on the drive
A "278" indicates 27.8Hz.
Refer to the PowerFlex user manual for additional information about Logic Status
word bits, error code descriptions, commanded and actual speeds, and other status
codes.

MSG_MODBUS Read configuration
The following image shows the variable options for the MSG_MODBUS
instruction block used to read status data from a PowerFlex 40 drive.
MSG_MODBUS Read variables
The following table identifies the variables and the values used to configure the
MSG_MODBUS instruction to read status data from a PowerFlex 4 drive.
Variable Value Description

*.Channel 5 Channel 5 - location of SERIALISOL module
*.TriggerType 0 Trigger on False-to-True transition
*.Cmd 3 Modbus Function Code "03" - Read Holding Registers
*.ElementCnt 4 Length
*.Addr 8449 PowerFlex Logic Status word address + 1
*.Node 2 PowerFlex Node address
*_laddr[1] {data} PowerFlex Logic Status word
*_laddr[2] {data} PowerFlex Error Code
*_laddr[3] {data} PowerFlex Commanded Speed (Speed Reference)
*_laddr[4] {data} PowerFlex Speed Feedback (Actual Speed)

MOV instruction example
The following images shows an example of using the MOV instruction to move
the *_l[1] array value to a Word, which allows you to directly access the individual
bits.
Modbus Write example
The following MSG_MODBUS instruction is used to write control data to a

PowerFlex 40 drive.

MSG_MODBUS Write configuration
The following image shows the variables and the values used to configure the
MSG_MODBUS instruction to write control data to a PowerFlex 4 drive.
MSG_MODBUS Write variables
The following table lists the variables, values and describes the purpose of each
variable.
Variable Value Description

*.Channel 5 Channel 5 - location of SERIALISOL module
*.TriggerType 0 Trigger on False-to-True transition
*.Cmd 16 Modbus Function Code "16" - Write Holding Registers
*.ElementCnt 2 Length
*.Addr 8193 PowerFlex Logic Status word address + 1
*.Node 2 PowerFlex Node address
*_laddr[1] {data} PowerFlex Logic Command word
*_laddr[2] {data} owerFlex Speed Reference word
See also
Communication protocol The MSG_CIP function blocks support different communication protocols as
described in this section.
support
Function block support for message communication protocols.

Messaging Protocol Communication media Use this function block

Modbus/RTU client and server Through a Serial port configured MSG_MODBUS on page 204
as Modbus RTU.
Modbus/TCP client and server Over the Ethernet instead of MSG_MODBUS2 on page 211
through a serial port.
Ethernet IP client and server Through an embedded Ethernet MSG_CIPSYMBOLIC on page 200
channel. MSG_CIPGENERIC on page 189
CIP Serial client and server Ethernet cable or Serial cable. MSG_CIPSYMBOLIC on page 200
ASCII Through an RS-232 port ASCII serial port instructions on page 117
configured with an ASCII driver.
Modbus RTU
Modbus is a half-duplex, master-slave communications protocol that allows a

single master to communicate with a maximum of 247 slave devices. The Modbus
network master reads and writes bits and registers. Modbus RTU is supported by
configuring the Serial port as Modbus RTU.
For more information about the Modbus protocol, refer to the Modbus Protocol
Specifications (available from http://www.modbus.org).
Modbus/TCP
The Modbus/TCP Server communication protocol uses the same Modbus

mapping features as Modbus RTU, but it is supported over the Ethernet instead of
through a Serial port.
The Micro850 controller supports up to 16 simultaneous Modbus TCP Server

connections. No protocol configuration is required other than configuring the
Modbus mapping table.
EtherNet/IP
Micro820 and Micro850 controllers support up to 16 simultaneous EtherNet/IP

server connections through an embedded Ethernet communication channel. The
channel can be used to connect a Micro850 controller to various devices through a
local area network using a 10 Mbps/100 Mbps transfer rate.
Common Industrial Protocol (CIP)
The CIP protocol is a transport and application layer protocol used for messaging
over EtherNet/IP, ControlNet, and DeviceNet networks that allows HMIs to
easily connect to a Micro830 or a Micro850 controller.

CIP explicit messaging
The CIP protocol is used for explicit messaging. Explicit Messaging

(configuration, data collection, and diagnostics) is used to transfer data that does
not require continuous updates. Explicit messaging is supported using CIP
Generic client messaging through the MSG_CIPGENERIC function block and
using CIP Symbolic client messaging through the MSG_CIPSYMBOLIC
function block.
CIP Serial
CIP serial uses DF1 Full Duplex protocol, and provides point-to-point connection
between two devices. It combines data transparency (American National
Standards Institute ANSI - X3.28-1976 specification subcategory D1) and 2-way
simultaneous transmission with embedded responses (subcategory F1)
Micro830 and Micro850 controllers support CIP Serial through an RS-232

connection to external devices, such as computers running RSLinx Classic
software, PanelView Component terminals (firmware revisions 1.70 and above),
or other controllers that support CIP Serial over DF1 Full-Duplex, such as
ControlLogix and CompactLogix controllers that have embedded serial ports.
The Serial Port driver can be configured as CIP Serial, Modbus RTU, ASCII or
Shutdown through the device configuration tree.
See also
Embedded communication channels on page 255
Embedded communication The Micro820, Micro830, and Micro850 controllers have the following
additional embedded communication channels:
channels
A non-isolated RS-232/485 combo port
A non-isolated USB programming port (Micro830 and Micro850 only)
An RJ-45 Ethernet port (Micro820, and Micro850 only)
See also
Communication protocol support on page 253

Chapter 10
Compare instructions
Use Compare instructions to compare Integer, Real, Time, Date, and String values
using an expression or a specific compare instruction.
Instruction Description
(=) Equal on page 257 Compares the first input to the second input to determine equality. For
Integer, Real, Time, Date, and String data types.
(>) Greater Than on page 260 Compares input values to determine whether the first is greater than the
second.
(>=) Greater Than or Equal on page 262 Compares input values to determine whether the first is greater than or
(<) Less Than on page 264 Compares input values to determine whether the first is less than the
second.
(<=) Less Than or Equal on page 266 Compare input values to determine whether the first is less than or
(<>) Not Equal on page 268 Compares input values to determine whether the first is not equal to the
second.
See also
Equal Performs an operation that compares the first input to the second input to
determine equality for Integer, Real, Time, Date, and String data types.
Operation details:
Equality testing of Time values is not recommended for TON, TP, and
TOF instruction blocks.
because numbers in the math operation are rounded differently than those
that appear in the variable output display. Consequently, two output values
may appear equal in the display, though evaluate as false. For example,
23.500001 compared to 23.499999, both display as 23.5 in the variable
input display, but are not equal in the controller.

Text.

Chapter 10 Compare instructions

controllers.

Type
EN Input BOOL Function enable.
TRUE - execute the equality comparison.
FALSE - there is no comparison.
i1 Input BOOL All inputs must be the same data type.
SINT The Time input applies to the Structured Text, Ladder
USINT Diagram and Function Block Diagram languages.
BYTE The Real data type is not recommended.
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING

Compare instructions Chapter 10

Type
i2 Input BOOL
SINT
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output BOOL TRUE if i1 = i2.
Compare Real Values using Subtraction (-) ABS, and Less than (<) example
because of differences in the way numbers are rounded. Two output values may
appear equal in a Connected Components Workbench display, but will evaluate as
false.
For example, 23.500001 compared to 23.499999 will both display as 23.5 in the
variable input display, but will not be equal in the controller.

To test whether two Real data type values are equal, you can use a Subtraction
instruction to get the difference between the values and then determine if the
difference is Less Than an established precision value. See the following LD
program example for comparing two Real data type values.
Equal (=) Structured Text example
aresult := (10 = 25); (* aresult is FALSE *)

mresult := ('ab' = 'ab'); (* mresult is TRUE *)
See also
Compare instructions on page 257
Greater than Compares Integer, Real, Time, Date, and String input values to determine
whether the first is greater than the second.

Text.

controllers.

Type
TRUE - execute the input comparison.
FALSE -there is no comparison.
i1 Input SINT All inputs must be the same data type.
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING

i2 Input SINT
USINT
- BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output BOOL TRUE if i1 > i2.
Greater than (>) Structured Text example
aresult := (10 > 25); (* aresult is FALSE *)

mresult := ('ab' > 'a'); (* mresult is TRUE *)
See also
Greater than or equal Compares Integer, Real, Time, Date, and String input values to determine
whether the first is greater than or equal to the second.
For TON, TP, and TOF, equality testing of Time values is not recommended.

Text.


controllers.

Type
i1 Input SINT All inputs must be the same data type. The Time input applies
USINT to the Structured Text, Ladder Diagram and Function Block
BYTE Diagram languages.
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING


Type
i2 Input SINT
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output BOOL TRUE if i1 >= i2.
Greater than or equal (>=) Structured Text example
aresult := (10 >= 25); (* aresult is FALSE *)

mresult := ('ab' >= 'ab'); (* mresult is TRUE *)
See also
Less than Compares Integer, Real, Time, Date, and String input values to determine
whether the first is less than the second.

Text.


controllers.

Type
i1 Input SINT All inputs must be the same data type.
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING


Type
i2 Input SINT
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output BOOL TRUE if i1 < i2.
Less than (<) Structured Text example
aresult := (10 < 25); (* aresult is TRUE *)

mresult := ('z' < 'B'); (* mresult is FALSE *)
(* IL equivalence: *)
LD 10
LT 25
ST aresult
LD 'z'
LT 'B'
ST mresult
See also
Less than or equal Compares Integer, Real, Time, Date, and String input values to determine
whether the first is less than or equal to the second.
For TON, TP, and TOF, equality testing of Time values is not recommended.

Text.


controllers.

Type
i1 Input SINT - USINT - BYTE - All inputs must be the same data type. The Time input applies
INT - UINT - WORD - to the Structured Text, Ladder Diagram and Function Block
DINT - UDINT - Diagram languages.
DWORD - LINT -
ULINT - LWORD -
REAL - LREAL - TIME -
DATE - STRING
i2 Input SINT - USINT - BYTE -
INT - UINT - WORD -
DINT - UDINT -
DWORD - LINT -
ULINT - LWORD -
REAL - LREAL - TIME -
DATE - STRING
o1 Output BOOL TRUE if i1 <= i2.
Less than or equal (<=) Structured Text example
aresult := (10 <= 25); (* aresult is TRUE *)

mresult := ('ab' <= 'ab'); (* mresult is TRUE *)
See also

Not equal Compares Integer, Real, Time, Date, and String input values to determine
whether the first is not equal to the second.

Text.

controllers.

Type
TRUE - execute current compare computation.
i1 Input BOOL All inputs must be the same data type.
SINT
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING


Type
i2 Input BOOL
SINT
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output BOOL TRUE - if first <> second.
Not equal (<>) Structured Text example
aresult := (10 <> 25); (* aresult is TRUE *)

mresult := ('ab' <> 'ab'); (* mresult is FALSE *)
See also

Chapter 11
Counter instructions
Use Counter instructions to control operations based on the number of events.
CTD on page 271 Counts integers from a given value down to 0, 1 by 1.

CTU on page 273 Counts integers from 0 up to a given value, 1 by 1.
CTUD on page 275 Counts integers from 0 up to a given value, 1 by 1, or from a given value down to
0, 1 by 1.
See also
CTD (count down) Counts integers from a given value down to 0, 1 by 1.

Text.

controllers.

Type
CD Input BOOL Counts down.
TRUE - Rising edge detected, count down in increments of
one.
FALSE - Falling edge detected, hold the counter value at the
same value.

Chapter 11 Counter instructions

Type
LOAD Input BOOL Load verifies the PV value against the count down value.
TRUE - When the count down value equals the PV value, set
the CV value equal to the PV value.
FALSE - Continue incrementing count down by one.
PV Input DINT Programmed maximum value of the counter.

Q Output BOOL Indicates whether the count down instruction has resulted in
a number less than or equal to the maximum value of the
counter.
TRUE - CV is less than or equal to zero (Underflow condition).
FALSE = Count down value is greater that zero.
CV Output DINT Current counter value.
CTD Function Block Diagram example
CTD Ladder Diagram example
CTD Structured Text example
(*ST Equivalence: CTD1 is an instance of block *)

Counter instructions Chapter 11
CTD1(trigger,load_cmd,100);
underflow := CTD1.Q;
result := CTD1.CV;
Results
See also
Counter instructions on page 271
CTU (count up) CTU counts (integers) from 0 up to a given value, 1 by 1.

Text.

controllers.


Type
CU Input BOOL Counts upward.
TRUE - Rising edge detected, count upward in increments of
one.
FALSE - Falling edge detected, hold the counter value at the
same value.
RESET Input BOOL Reset verifies the PV value against the count upward value.
TRUE - When the count upward value equals the PV value,
set the CV value to zero.
FALSE - Continue incrementing count upward by one.
PV Input DINT Programmed maximum value of the counter.
Q Output BOOL Indicates whether the count up instruction has resulted in a
number greater than or equal to the maximum value of the
counter.
TRUE - Counter result <= PV (Overflow condition).
FALSE - Counter result > PV
CV Output DINT Current counter result.
CTU Function Block Diagram example
CTU Ladder Diagram example

CTU Structured Text example
(* ST Equivalence: CTU1 is an instance of CTU block*)
CTU1(trigger,NOT(auto_mode),100);
overflow := CTU1.Q;
result := CTU1.CV;
Results
See also
CTUD (count up down) Counts integers from 0 up to a given value, 1 by 1, or from a given value down to
0, 1 by 1.

Text.


controllers.

Type
CU Input BOOL TRUE - Rising Edge detected, count up.
CD Input BOOL TRUE - Rising Edge detected, count down.
RESET Input BOOL Reset dominant command.
(CV = 0 when RESET is TRUE).
LOAD Input BOOL Load command.
TRUE - when CV = PV.
PV Input DINT Programmed maximum value.
QU Output BOOL Overflow.
TRUE - when CV >= PV.
QD Output BOOL Underflow.
TRUE - when CV <= 0.
CV Output DINT Counter result.
CTUD Function Block Diagram example

CTUD Ladder Diagram example
CTUD Structured Text example
(* ST Equivalence: We suppose CTUD1 is an instance of block*)
CTUD1(trigger1, trigger2, reset_cmd, load_cmd,100);

full := CTUD1.QU;
empty := CTUD1.QD;
nb_elt := CTUD1.CV;
See also

Chapter 12
Data conversion instructions
Use Data conversion instructions to convert the data type of a variable to a

different data type.
ANY_TO_BOOL on page 279 Converts a non-Boolean value to a Boolean.
ANY_TO_BYTE on page 280 Converts a value to a Byte.
ANY_TO_DATE on page 282 Converts a String, Integer, Real, or Time data type to Date data type.
ANY_TO_DINT on page 283 Converts a value to a Double Integer.
ANY_TO_DWORD on page 284 Converts a value to a Double Word value.
ANY_TO_INT on page 286 Converts a value to an Integer.
ANY_TO_LINT on page 287 Converts a value to a Long Integer.
ANY_TO_LREAL on page 288 Converts a value to a Long Real.
ANY_TO_LWORD on page 289 Converts a value to a Long Word.
ANY_TO_REAL on page 290 Converts a value to a Real.
ANY_TO_SINT on page 291 Converts a value to a Short Integer.
ANY_TO_STRING on page 292 Converts a value to a String.
ANY_TO_TIME on page 294 Converts a value to the Time data type.
ANY_TO_UDINT on page 295 Converts a value to an Unsigned Double Integer.
ANY_TO_UINT on page 296 Converts a value to an Unsigned Integer.
ANY_TO_ULINT on page 298 Converts a value to an Unsigned Long Integer.
ANY_TO_USINT on page 299 Converts a value to an Unsigned Short Integer.
ANY_TO_WORD on page 300 Converts a value to a Word.
See also
ANY_TO_BOOL Converts a non-Boolean value to a Boolean value.

Text.

Chapter 12 Data conversion instructions

controllers.

Type
TRUE - execute the conversion to Boolean computation.
i1 Input SINT Any non-Boolean value.
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output BOOL Boolean value.
ANY_TO_BOOL Structured Text example
ares := ANY_TO_BOOL (10); (* ares is TRUE *)

tres := ANY_TO_BOOL (t#0s); (* tres is FALSE *)
mres := ANY_TO_BOOL ('FALSE'); (* mres is FALSE *)
See also
Data conversion instructions on page 279
ANY_TO_BYTE Converts a value to an 8-bit Byte value.

Data conversion instructions Chapter 12

Text.

controllers.

Type
TRUE - execute the conversion to Byte computation.
i1 Input BOOL Any non-Byte value.
SINT
USINT
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output BYTE An 8-bit Byte value.
ANY_TO_BYTE Structured Text example
bres := ANY_TO_BYTE (true); (* bres is 1 *)

tres := ANY_TO_BYTE (t#0s46ms); (* tres is 46 *)
mres := ANY_TO_BYTE ('0198'); (* mres is 198 *)

See also
Converts a String, Integer, Real, or Time data type to Date data type.
ANY_TO_DATE
Boolean, Byte, and Word date types are supported but are not recommended.

Text.

controllers.

Type
TRUE - execute the conversion to the Date computation.
i1 Input BOOL Strings are directly converted to DATE data type and must be in
SINT the format of YYYY-MM-DD, DATE#YYYY-MM-DD, or
D#YYYY-MM-DD.
USINT
BYTE Integers and Real, which must be positive, are in units of seconds
and added to the date 1970-01-01.
INT
UINT Time is added to the date 1970-01-01.
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
STRING
o1 Output DATE Converted date value. Errors during conversion (such as a negative
date) results in an INVALID result.

ANY_TO_DATE Function Block Diagram example
ANY_TO_DATE
ANY_TO_DATE Ladder Diagram example
ANY_TO_DATE Structured Text example
See also
ANY_TO_DINT Converts a value to 32-bit Double Integer value.

Text.

controllers.


Type
TRUE - execute the conversion to the 32-bit Double Integer
computation.
i1 Input BOOL Any value other than a Double Integer.
SINT
USINT
BYTE
INT
UINT
WORD
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output DINT A 32-bit Double Integer value.
ANY_TO_DINT Structured Text example
bres := ANY_TO_DINT (true); (* bres is 1 *)

tres := ANY_TO_DINT (t#1s46ms); (* tres is 1046 *)
mres := ANY_TO_DINT ('0198'); (* mres is 198 *)
See also
Converts a value to a 32-bit double Word value.

ANY_TO_DWORD
Text.


controllers.

Type
TRUE - execute the conversion to the 32-bit double Word
computation.
i1 Input BOOL Any value other than a double word.

SINT
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output DWORD A 32-bit double Word value.
ANY_TO_DWORD Structured Text example
bres := ANY_TO_DWORD (true); (* bres is 1 *)

tres := ANY_TO_DWORD (t#1s46ms); (* tres is 1046 *)
mres := ANY_TO_DWORD ('0198'); (* mres is 198 *)
See also

ANY_TO_INT Converts a value to a 16-bit Integer value.

Text.

controllers.

Type
TRUE - execute the conversion to the 16-bit Integer
computation.
i1 Input BOOL Any non-16-bit Integer value.
SINT
USINT
BYTE
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output INT A 16-bit Integer value.
ANY_TO_INT Structured Text example
bres := ANY_TO_INT (true); (* bres is 1 *)

tres := ANY_TO_INT (t#0s46ms); (* tres is 46 *)

mres := ANY_TO_INT ('0198'); (* mres is 198 *)
See also
ANY_TO_LINT Converts a value to a 64-bit Long Integer value.

Text.

controllers.

Type
TRUE - execute the conversion to the 64-bit Long Integer
computation.
i1 Input BOOL Any value other than a Long Integer.
SINT
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output LINT A 64-bit Long Integer value.

ANY_TO_LINT Structured Text example
bres := ANY_TO_LINT (true); (* bres is 1 *)

tres := ANY_TO_LINT (t#0s46ms); (* tres is 46 *)
mres := ANY_TO_LINT ('0198'); (* mres is 198 *)
See also
ANY_TO_LREAL Converts any value to a Long Real value.

Text.

controllers.

Type
TRUE - execute the conversion to the long Real
computation.
i1 Input BOOL Any value other than a long Real.
SINT
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
TIME
DATE
STRING


Type
o1 Output LREAL A long real value.
ANY_TO_LREAL Structured Text example
bres := ANY_TO_LREAL (true); (* bres is 1.0 *)

tres := ANY_TO_LREAL (t#1s46ms); (* tres is 1046.0 *)
ares := ANY_TO_LREAL (198); (* ares is 198.0 *)
See also
ANY_TO_LWORD Converts a value to a 64-bit Long Word value.

Text.

controllers.

Type
TRUE - execute the conversion to the 64-bit Long Word
computation.


Type
i1 Input BOOL Any value other than a Long Word.
SINT
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
REAL
LREAL
IME
DATE
STRING
o1 Output LWORD A 64-bit Long Word value.
ANY_TO_LWORD Structured Text example
bres := ANY_TO_LWORD (true); (* bres is 1 *)

tres := ANY_TO_LWORD (t#0s46ms); (* tres is 46 *)
mres := ANY_TO_LWORD ('0198'); (* mres is 198 *)
See also
ANY_TO_REAL Converts a value to a Real value.

Text.

controllers.

Type
TRUE - execute the conversion to the Real computation.
i1 Input BOOL Any value other than Real.
SINT
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
LREAL
TIME
DATE
STRING
o1 Output REAL A real value.
ANY_TO_REAL Structured Text example
bres := ANY_TO_REAL (true); (* bres is 1.0 *)

tres := ANY_TO_REAL (t#1s46ms); (* tres is 1046.0 *)
ares := ANY_TO_REAL (198); (* ares is 198.0 *)
See also
ANY_TO_SINT Converts a value to a Short Integer value.

Text.

controllers.


Type
TRUE - execute the conversion to the 8-bit Short Integer
computation.
i1 Input BOOL Any non-Short Integer value.
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output SINT A Short Integer value.
ANY_TO_SINT Structured Text example
bres := ANY_TO_SINT (true); (* bres is 1 *)

tres := ANY_TO_SINT (t#0s46ms); (* tres is 46 *)
mres := ANY_TO_SINT ('0198'); (* mres is 198 *)
See also
ANY_TO_STRING Converts a value to a String value.
Operation details:
When converting a REAL data type to a String the ANY_TO_STRING

instruction uses the IEEE 754 format.

ANY_TO_STRING converts 125.0 to 1.25000E+02

When the target string length is 5 chars:
ANY_TO_STRING converts 125.0 to 1.25000E+02 and outputs
1.250 to the target string.
Consider creating a user-defined function block to convert from
Exponential notation to number.

Text.

controllers.

Type
TRUE - execute the conversion to String computation.
i1 Input BOOL Any value other than String.
SINT
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE


Type
o1 Output STRING If IN is a Boolean, 'FALSE' or 'TRUE'.
If IN is an Integer or a real, a decimal representation.
If IN is a TIME, can be:
TIME time1
STRING s1
time1 :=13 ms;
s1:=ANY_TO_STRING(time1);
(* s1 = '0s13' *).
ANY_TO_STRING Structured Text example
bres := ANY_TO_STRING (TRUE); (* bres is 'TRUE' *)

ares := ANY_TO_STRING (125); (* ares is '125' *)
See also
ANY_TO_TIME Converts a non-Time or non-Date value to a Time value.

Text.

controllers.

Type
TRUE - execute the conversion to the Time computation.


Type
i1 Input BOOL Any positive value other than a Time or Date data type.
SINT IN (or integer part of IN if it is real) is the number of
USINT milliseconds.
STRING (number of milliseconds, for example, a value of
BYTE
300032 represents 5 minutes and 32 milliseconds).
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
STRING
o1 Output TIME Time value represented by IN. A value of 1193h2m47s295ms
indicates an invalid time.
ANY_TO_TIME Structured Text example
ares := ANY_TO_TIME (1256); (* ares := t#1s256ms *)

rres := ANY_TO_TIME (1256.3); (* rres := t#1s256ms *)
See also
ANY_TO_UDINT Converts a value to a 32-bit Unsigned Double Integer value.

Text.

controllers.


Type
TRUE - execute the conversion to the 32-bit Double Integer
computation.
i1 Input BOOL Any value other than an Unsigned Double Integer.
SINT
USINT
BYTE
INT
UINT
WORD
DINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output UDINT A 32-bit Unsigned Double Integer value.
ANY_TO_UDINT Structured Text example
bres := ANY_TO_UDINT (true); (* bres is 1 *)

tres := ANY_TO_UDINT (t#1s46ms); (* tres is 1046 *)
mres := ANY_TO_UDINT ('0198'); (* mres is 198 *)
See also
ANY_TO_UINT Converts a value to an Unsigned Integer value.

Text.


controllers.

Type
TRUE - execute the conversion to the 16-bit Unsigned Integer
computation.
i1 Input BOOL Any non-Unsigned Integer value.
SINT
USINT
BYTE
INT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output UINT An Unsigned Integer value.
ANY_TO_UINT Structured Text example
bres := ANY_TO_UINT (true); (* bres is 1 *)

tres := ANY_TO_UINT (t#0s46ms); (* tres is 46 *)
mres := ANY_TO_UINT ('0198'); (* mres is 198 *)
See also

ANY_TO_ULINT Converts a value to a 64-bit Unsigned Long Integer value.

Text.

controllers.

Type
TRUE - execute the conversion to the 64-bit Unsigned Long
Integer computation.
i1 Input BOOL Any value other than an Unsigned Long Integer.
SINT
USINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output ULINT A 64-bit Unsigned Long Integer value.
ANY_TO_ULINT Structured Text example
bres := ANY_TO_ULINT (true); (* bres is 1 *)

tres := ANY_TO_ULINT (t#0s46ms); (* tres is 46 *)

mres := ANY_TO_ULINT ('0198'); (* mres is 198 *)
See also
ANY_TO_USINT Converts a value to an Unsigned Short Integer value.

Text.

controllers.

Type
TRUE - execute the conversion to the 8-bit Unsigned Short
Integer computation.
i1 Input BOOL Any non-Short Integer value.
SINT
BYTE
INT
UINT
WORD
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output USINT An Unsigned Short Integer value.

ANY_TO_USINT Structured Text example
bres := ANY_TO_USINT (true); (* bres is 1 *)

tres := ANY_TO_USINT (t#0s46ms); (* tres is 46 *)
mres := ANY_TO_USINT ('0198'); (* mres is 198 *)
See also
ANY_TO_WORD Converts a value to a 16-bit Word value.

Text.

controllers.

Type
TRUE - execute the conversion to the 16-bit Word
computation.

i1 Input BOOL Any value other than a WORD value.

SINT
USINT
BYTE
INT
DINT
UDINT
DWORD
LINT
ULINT
LWORD
REAL
LREAL
TIME
DATE
STRING
o1 Output WORD A Word value.
ANY_TO_WORD Structured Text example
bres := ANY_TO_WORD (true); (* bres is 1 *)

tres := ANY_TO_WORD (t#0s46ms); (* tres is 46 *)
mres := ANY_TO_WORD ('0198'); (* mres is 198 *)
See also

Chapter 13
Data manipulation instructions
Use Data manipulation instructions to alter the output data to change the status
without altering the program.
AVERAGE on page 303 Calculates a running average over a number of a defined samples.
COP on page 305 Copies the binary data in the source element to the destination element.
MAX on page 313 Calculates the maximum of two integer values.
MIN on page 311 Calculates the minimum of two integer values.
See also
AVERAGE Calculates a running average over a number of a defined samples and stores the
value at each cycle.
Operation details:
The defined number of samples (N) cannot exceed 128.

When setting or changing the value for N, set RUN to FALSE, then set it
back to TRUE.
If the RUN command is FALSE (reset mode), the output value is equal to
the input value.
When the maximum number of stored values is reached, the first stored
value is erased by the last one.
Using floating-point data types could result in inaccurate calculations due
to the rounding limitations inherent in floating-point mathematics.

Text.

Chapter 13 Data manipulation instructions

controllers.

Type
RUN Input BOOL TRUE = run
FALSE = reset
XIN Input REAL Any real variable.
N Input DINT Application defined number of samples.
XOUT Output REAL Running average of XIN value.
AVERAGE Function Block Diagram example
AVERAGE Ladder Diagram example

Data manipulation instructions Chapter 13
AVERAGE Structured Text example
(* ST Equivalence: AVERAGE1 an instance of an AVERAGE block *)
AVERAGE1((auto_mode & store_cmd), sensor_value, 100);

ave_value := AVERAGE1.XOUT;
See also
Data manipulation instructions on page 303
Copies the binary data in the source element to the destination element. The
COP
source element remains unchanged.

Text.

controllers.


Type
Enable Input BOOL Instruction block enable. COP iis level triggered.
TRUE - perform copy.
FALSE - the function block is idle.
Src Input BOOL DWORD Initial element to copy.
SINT REAL If the source is a STRING data type the destination must be a
USINT TIME either a STRING data type or a USINT (UCHAR and BYTE)
BYTE DATE data type. If it is not, a data type mismatch is reported.
INT STRING
UINT LWORD
WORD ULINT
DINT LINT
UDINT LREAL
SrcOffset Input UINT The source element offset is used with array data types to
identify the position in the source array to copy the data
from.
Set the offset to 0 if:
If it is not an array data type, or
To copy from the first element for an array data type.
Dest Input BOOL DWORD Initial element to be overwritten by the source.
SINT REAL If the destination is a STRING data type the source must be
USINT TIME either a STRING data type or a USINT (UCHAR and BYTE)
BYTE DATE data type. If it is not, a data type mismatch is reported.
INT STRING
UINT LWORD
WORD ULINT
DINT LINT
UDINT
DestOffset Input UINT The destination element offset is used with array data types
to identify the position in the destination array to copy the
data to.
Set the offset to 0 if:
If it is not an array data type, or
To copy from the first element for an array data type.
Length Input UINT Number of destination elements to copy.
When the destination is a STRING data type, it indicates the
number of strings to be copied.
Swap Input BOOL Used to exchange the data from the source and destination
elements, so that the destination data replaces the source
data and the source data replaces the destination data.
TRUE - Swap bytes according to the data type. A swap
operation does not occur if:
The source data type or the destination data type is a
STRING, or
If both the source and the destination are 1-byte length
data.
Sts Output UINT Status of the copy operation. The definitions for the Sts
parameter are defined in COP status codes.


Type
ENO Output BOOL Enables output.

COP status codes (Sts)
The following table describes the COP status codes.
COP Status code Status description
0x00 No action taken (not enabled).

0x01 COP function block success.
0x02 Destination has spare bytes when copying from String.
0x03 Source data are truncated.
0x04 Copy length is invalid.
0x05 Data type mismatch when there is String Data type as either source or destination.
0x06 Source data size is too small for copy.
0x07 Destination data size is too small for copy.
0x08 Source Data offset is invalid.
0x09 Destination Data offset is invalid.
0x0A Data is invalid in either source or destination.
COP Function Block Diagram example

COP Ladder Diagram example
COP Structured Text example
See also
COP string array example on page 309
Copy to a different data type on page 308
Copy to a different data type When a copy to or from a String data type is performed, the ODVA short String
format is used for data in the USINT array.
When COP is used between any other pair of data types, the copy operation is
valid, even if the data type in the source is not the same as the data type in the
destination, and even when they are not in a valid format. The logic must be
validated at the application level.

From a USINT array to a String array
To copy a USINT array to a String array, the data in the USINT array must be in
this format:
Byte1: Length of first String

Byte2: First Byte Character
Byte3: Second Byte Character
Byte n: Last Byte Character
Byte (n+1): Length of second String
Byte (n+2): First Byte Character for second String
See also
COP on page 305
COP string array example The following example shows a COP instruction copying a string array into Usint
array. The COP instruction skips all the elements in the source array with Zero
length.
For this example:
Length is specified as 4 bytes.

Number of Destination Elements to copy is 4 bytes.
All the array elements with Zero length (blanks) are skipped.
The COP instruction finds a non-zero length element in the string array[1],
which is copied into the designation Usint array[1] with 1. One is the
length of the string in String array[1]) and Usint array[2] is 65, which is the
ASCII code of "A".
The COP instruction finds a non-zero length element in String array[10]
which is "a", which is copied into destination Usint array[3] with 1. One is
the length of string in String array[10]) and Usint array[4] is 97 which is
ASCII code of "a".

Ladder Diagram

Array elements with Logical Values
See also
COP on page 305
MIN (minimum) Calculates the minimum of two integer values.

Text.


controllers.

Type
TRUE - execute the minimum integer value computation
IN1 Input DINT Any signed integer value.
IN2 Input DINT Cannot be Real.
MIN Output DINT Minimum of both input values.
MIN Function Block Diagram example
MIN Ladder Diagram example

MIN Structured Text example
new_value := MAX (MIN (max_value, value), min_value);
(* bounds the value to the [min_value..max_value] set *)
Results
See also
MAX (maximum) Calculates the maximum of two integer values.

Text.


controllers.

Type
TRUE - execute maximum integer value computation.
IN1 Input DINT Any signed integer value.
IN2 Input DINT Cannot be Real.
MAX Output DINT Maximum of both input values.
MAX Function Block Diagram example
MAX Ladder Diagram example

MAX Structured Text example
new_value := MAX (MIN (max_value, value), min_value);
Results
See also

Chapter 14
High-Speed Counter (HSC) instructions
Use High-speed counter instructions to monitor and control the high-speed

counter.
HSC on page 318 HSC applies high presets, low presets and output source values to the high-speed counter.
HSC_SET_STS HSC_SET_STS manually sets or resets the HSC counting status.

on page 335
See also
What is a High-Speed A high-speed counter detects and counts narrow (fast) pulses and then issues
specialized instructions to initiate control operations when the detected counts
Counter? reach their preset values. Control operations include the automatic and
immediate execution of the high-speed counter interrupt routine and the
immediate update of outputs based on the configured source and mask pattern.
High-speed counter capabilities
Because HSC instructions have high-performance requirements, their operation is

performed by custom circuitry that runs in parallel with the main system
processor. Enhanced capabilities of High-Speed Counters (HSC) include:
100 kHz operation high-speed direct control of outputs

32-bit signed integer data (count range of 2,147,483,647)
Programmable high and low presets
Overflow and underflow setpoint
Automatic interrupt processing based on accumulated count
Run-time editable parameters (from the user control program) HSC
instruction operation

Chapter 14 High-Speed Counter (HSC) instructions
Micro800 controller support for HSC
All Micro830 and Micro850 controllers, except for 2080-LCxx-AWB, support up

to six HSC inputs. HSC functionality is implemented in Micro800 controllers
using high-speed counter hardware (embedded inputs in the controller), and the
HSC instruction in the application. The HSC instruction configures the
high-speed counter hardware and updates the image accumulator.
Important: The HSC function can only be used with the controller's embedded I/O. It cannot be used with
expansion I/O modules.
See also
High-Speed Counter (HSC) instructions on page 317
Use the High-Speed Counter instructions on page 337
HSC (high-speed counter) HSC applies high presets, low presets and output source values to the high-speed
counter.
Operation details:
Programmable Limit Switch (PLS) is enabled by setting the

HSCAppData.PLSEnable parameter to True.
The PLSPosition parameter is reset after a full cycle completes and the
HSCSTS.HP value is reached.
This instruction is available for controllers with embedded high speed counters
such as Micro830 and Micro850.

Text.

High-Speed Counter (HSC) instructions Chapter 14

Type
EN Input BOOL Instruction block rung state.
TRUE - the timer starts incrementing.
The recommendation is not to use the EN parameter with the HSC
function block because when EN is set to FALSE the timer continues to
increment.
Enable Input BOOL Enable instruction block.
TRUE - execute the HSC operation specified in the HSC command
parameter.
FALSE - no HSC commands are issued.
HscCmd Input USINT Issues commands to the HSC.
HSCAppData Input HSCAPP HSC application configuration, which is usually only needed once.
HSCStsInfo Input HSCSTS HSC dynamic status, which is continuously updated during HSC counting.
PlsData Input DINT Programmable Limit Switch (PLS) data structure.
UDINT
Sts Output UINT HSC execution status.
HSC status codes:
0x00 - No action taken (not enabled).
0x01 - HSC execution successful.
0x02 - HSC command invalid.
0x03 - HSC ID out of range.
0x04 - HSC configure error.
HSC Function Block Diagram example

HSC Ladder Diagram example
HSC Structured Text example
See also
HSCCmd values on page 320
HSCAPP data type on page 321
HSCSTS data type on page 325
PLS data type on page 333
HSCCmd values The following table describes the HSC commands for each HSC command value.
HSC command Command description
0x01 HSC RUN

Start HSC (if HSC is in Idle mode and the rung is enabled).
Update HSC Status Information only (if HSC in Run mode and the rung is enabled).
0x02 HSC Stop: Stop a HSC counting (if HSC is in Run mode and the rung is enabled).

0x03 HSC Load/Set: reload the HSC Application Data (if rung is enabled) for 6 input elements: HPSetting,
LPSetting, HPOutput, LPOutput, OFSetting, and UFSetting.
Note: This command does not re-load the following input element: HSC accumulator.
0x04 HSC Accumulator Reset (if rung is enabled).
HSC command results
Command Result Conditions

value
HscCmd =1 Starts the HSC Setting the Enable input parameter to False does not stop counting while in
mechanism, and the HSC running mode.
transitions to running HscCmd =2 must be issued to stop counting.
mode.
The HSC mechanism HSC AppData.Accumalator is updated with HSC Sts.Accumulator
automatically updates
values.
HscCmd =4 Sets the HSC Acc value to HscCmd =4 does not stop HSC counting.
(reset) the HSC If HSC is counting when HscCmd =4 is issued, some counting may be lost
AppData.Accumalator
value.
To set a specific value to HSC Acc while counting, write the value to HSC
AppData.Accumalator immediately before HscCmd =4 is issued.
See also
HSC on page 318
HSCAPP data type Use the HSCAPP data type to define the HSCAppData parameter in HSC
instruction. The HSCApp data type parameters are used to define HSC
configuration data.
Use this table to help determine the parameter values for the HSCAPP data type.
Parameter Data Type Data User program Description

format access
PLSEnable BOOL bit read/write Enable or disable the High-Speed Counter
Programmable Limit Switch (PLS).
HSCID UINT word read/write Defines the HSC.
HSCMode UINT word read/write Defines the HSC mode.
Accumulator DINT long word read/write Initial accumulator value.
HSCApp.Accumulator sets the initial accumulator value
when the High-Speed Counter starts. When the HSC is
in Counting mode, the Accumulator is automatically
updated by the HSC sub-system to reflect the actual
HSC accumulator value.

HPSetting DINT long word read/write High preset setting.

The HSCApp.HPSetting parameter sets the upper
setpoint (in counts) that defines when the HSC
sub-system generates an interrupt.
The data loaded into the high preset must be less than
or equal to the data resident in the overflow
(HSCAPP.OFSetting) parameter or an HSC error is
generated.
LPSetting DINT long word read/write Low preset setting.
HSCApp.LPSetting sets the lower setpoint (in counts)
that defines when the HSC sub-system generates an
interrupt.
The data loaded into the low preset must be greater
than or equal to the data resident in the underflow
(HSCAPP.UFSetting) parameter or an HSC error is
generated.
If the underflow and low preset values are negative
numbers, the low preset must be a number with an
absolute value smaller than the underflow.
OFSetting DINT long word read/write Overflow setting.
The HSCApp.OFSetting overflow setting defines the
upper count limit for the counter.
If the counter's accumulated value increments above
the value specified in OFSetting, an overflow interrupt
is generated.
When the overflow interrupt is generated, the HSC
sub-system resets the accumulator value to the
underflow value and the counter continues counting
from the underflow value (counts are not lost in this
transition).
OFSetting values must be:
Between -2,147,483,648 and 2,147,483,647.
Greater than the underflow value.
Greater than or equal to the data resident in the
high preset (HSCAPP.HPSetting) or an HSC error is
generated.
UFSetting DINT long word read/write Underflow setting.
The HSCApp.UFSetting underflow setting that defines
the lower count limit for the counter.
If the counter's accumulated value decrements below
the value specified in UFSetting, an underflow interrupt
is generated.
When the underflow interrupt is generated, the HSC
sub-system resets the accumulated value to the
overflow value and the counter starts counting from
the overflow value (counts are not lost in the
transition).
UFSetting values must be:
Between -2,147,483,648 and 2,147,483,647.
Less than the overflow value.
Less than or equal to the data resident in the low
preset (HSCAPP.LPSetting) or an HSC error is
generated.

OutputMask UDINT word read/write Out mask for output.

The HSCApp.OutputMask defines the embedded
outputs on the controller that the High-Speed Counter
can directly control. The HSC sub-system can, without
control program interaction, turn outputs ON or OFF
based on the High or Low presets of the HSC
accumulator.
The bit pattern stored in HSCApp.OutputMask defines
which outputs are controlled by the HSC and which
outputs are not controlled by the HSC.
The HSCAPP.OutputMask bit pattern corresponds to the
output bits on the controller, and can only be
configured during initial setup.
Bits that are set (1) are enabled and can be turned on or
off by the HSC sub-system.
Bits that are set (0) cannot be turned on or off by the
HSC sub-system.
For example, to use the HSC to control outputs 0, 1, 3,
assign:
HscAppData.OutputMask = 2#1011, or
HscAppData.OutputMask = 11
HPOutput UDINT long word read/write 32-bit output setting for High preset reaching.
HSCApp.HPOutput defines the state (1 = ON or 0 =
OFF) of the outputs on the controller when the high
preset is reached. For more information on how to
directly turn outputs on or off based on the high preset.
Configure the high output bit pattern during initial
setup, or you can use the HSC function block to load the
new parameters while the controller is operating.
LPOutput UDINT long word read/write 32-bit output setting for Low preset reaching.
HSCApp.LPOutput defines the state (1 = "on", 0 = "off
") of the outputs on the controller when the low preset
is reached. For more information on how to directly
turn outputs on or off based on the low preset.
Configure the low output bit pattern during initial
setup, or you can use the HSC function block to load the
new parameters while the controller is operating.
HSCApp settings versus PLSData settings
When the PLS function is enabled, relevant HSCApp settings are superseded by
the corresponding PLSData settings as shown in the following table.
HSCApp setting PLSData setting

HSCAPP.HpSetting HSCHP
HSCAPP.LpSetting HSCLP
HSCAPP.HPOutput HSCHPOutput
HSCAPP.LPOutput HSCLPOutput
HSCApp.HSCID
The HSCApp.HSCID parameter identifies the High-Speed Counter.

The following table lists the values for the HSCID:
Output Selection Bit Description

First word of HSC Function Data 15-13 Module type of HSC:
0x00 - Embedded.
0x01 - Expansion.
0x02 - Plug-in Port.
12-8 Slot ID of the module:
0x00 - Embedded.
0x01-0x1F - ID of Expansion Module.
0x01-0x05 - ID of Plug-in Port.
7-0 HSC ID inside the module:
0x00-0x0F - Embedded.
0x00-0x07 - ID of HSC for Expansion.
0x00-0x07 - ID of HSC for Plug-in Port.
For the initial version of Connected Components Workbench,
only IDs 0x00-0x05 are supported.
HSCApp.HSCMode
The HSCApp.HSCMode parameter sets the High-Speed Counter to one of 10

types of counting modes. The mode value is configured through the programming
device and is accessible in the control program.
For additional information on HSC operating modes and input assignments, see
HSC Inputs and Wiring Mapping in the Micro830 and Micro850 Programmable
Controllers User Manual.
HSC operating modes, the main HSC and sub HSC support different modes.
The main high-speed counters support 10 types of operation modes.

Sub high-speed counters support 5 types of operation modes (mode 0, 2, 4,
6, 8).
If the main high-speed counter is set to mode 1, 3, 5, 7 or 9, then the sub
high-speed counter is disabled.
HSCMode Counting mode
0 Up counter. The accumulator is immediately cleared (0) when it reaches the high preset. A low preset
cannot be defined in this mode.
1 Up counter with external reset and hold. The accumulator is immediately cleared (0) when it reaches the
high preset. A low preset cannot be defined in this mode.
2 Counter with external direction.
3 Counter with external direction, reset and hold.

4 Two input counter (up and down).
5 Two input counter (up and down) with external reset and hold.
6 Quadrature counter (phased inputs A and B).
7 Quadrature counter (phased inputs A and B) with external reset and hold.
8 Quadrature X4 counter (phased inputs A and B).
9 Quadrature X4 counter (phased inputs A and B) with external reset and hold.
HSCAppData parameters example
The following image shows the HSCAppData parameters in the Variable

Selector.
See also
HSC on page 318
HSCSTS data type HSCSTSInfo (data type HSCSTS) displays the status of the High-Speed
Counter.
HSCSTSInfo status actions
During HSC counting, the following HSC status actions occur.
If the HSC function block is counting with command 0x01, the HSC status
is continuously updated.
If an error occurs, the Error_Detected flag is turned on and an error code is
set.

HSCSTSInfo parameters
Parameter Data HSC mode User Description

type program
access
CountEnable BOOL 0...9 read only Counting enabled.
ErrorDetected BOOL 0...9 read/write Non-zero means error detected.
CountUpFlag BOOL 0...9 read only Count up flag.
CountDwnFla BOOL 2...9 read only Count down flag.
g
Mode1Done BOOL 0 or 1 read/write HSC is Mode 1A or Mode 1B; accumulator counts up to the HP
value.
OVF BOOL 0...9 read/write Overflow is detected.
UNF BOOL 0...9 read/write Underflow is detected.
CountDir BOOL 0...9 read only 1: count up; 0: count down.
HPReached BOOL 2...9 read/write High preset reached.
LPReached BOOL 2...9 read/write Low preset reached.
OFCauseInter BOOL 0...9 read/write Overflow caused a HSC interrupt.
UFCauseInter BOOL 2...9 read/write Underflow caused a HSC. interrupt.
HPCauseInter BOOL 0...9 read/write High preset reached, causing a HSC interrupt.
LPCauseInter BOOL 2...9 read/write Low Preset reached, causing a HSC interrupt.
PlsPosition UINT 0...9 read only Position of the Programmable Limit Switch (PLS). The
PLSPosition parameter is reset after completing a full cycle and
reaching the HP value.
ErrorCode UINT 0...9 read/write Displays the error codes detected by the HSC sub-system.
Accumulator DINT read/write Actual accumulator reading.
HP DINT read only Last high preset setting.
LP DINT read only Last low preset setting.
HPOutput UDINT read/write Last high preset output setting.
LPOutput UDINT read/write Last low preset output setting.
HSCSTSInfo parameter details
HSCSTSInfo (data type HSCSTS) parameters are used to determine the status of
the High-Speed Counter.
CountEnable
Parameter Data HSC mode User program access

type
HSCSTS.CountEnable BOOL 0...9 read only
Indicates the status of the High-Speed Counter, whether counting is enabled (1)
or disabled (0, default).
ErrorDetected


type
HSCSTS.ErrorDetected BOOL 0...9 read/write
Detects if an error is present in the HSC sub-system. Configuration errors are the
most common types of error represented by the ErrorDetectedr. When the bit is
set (1), look at the specific error code in parameter HSCSTS.ErrorCode, which is
maintained by the controller. You can clear the ErrorDetected bit when necessary.
CountUpFlag

type
HSCSTS.CountUpFlag BOOL 0...9 read only
Used with all of the HSCs (modes 0...9). If the HSCSTS.CountEnable bit is set,
the Count Up bit is set (1). If the HSCSTS.CountEnable is cleared, the Count
Up bit is cleared (0).
CountDownFlag

type
HSCSTS.CountDownFl BOOL 2...9 read only
ag
Used with the bidirectional counters (modes 2...9). If the HSCSTS.CountEnable

bit is set, the Count Down bit is set (1). If the HSCSTS.CountEnable bit is clear,
the Count Down bit is cleared (0).
Mode1Done

type
HSCSTS.Mode1Don BOOL 0 or 1 read/write
e
The HSC sub-system sets the HSCSTS.Mode1Done status flag to (1) when the
HSC is configured for Mode 0 or Mode 1 behavior, and the accumulator counts
up to the High Preset value.
OVF

type
HSCSTS.OVF BOOL 0...9 read/write

The HSC sub-system sets the HSCSTS.OVF status flag to (1) whenever the
accumulated value (HSCSTS.Accumulator) has counted through the overflow
variable (HSCAPP.OFSetting). This bit is transitional and is set by the HSC
sub-system. It is up to the control program to use, track, and clear (0) the overflow
condition.
Overflow conditions do not generate a controller fault.
UNF

type
HSCSTS.UNF BOOL 0...9 read/write
The HSC sub-system sets the HSCSTS.UNF status flag to (1) whenever the
accumulated value (HSCSTS.Accumulator) has counted through the underflow
variable (HSCAPP.UFSetting). This bit is transitional and is set by the HSC
sub-system. It is up to the control program to use, track, and clear (0) the
underflow condition.
Underflow conditions do not generate a controller fault.
CountDir

type
HSCSTS.CountDir BOOL 0...9 read only
The HSC sub-system controls the HSCSTS.CountDir status flag. When the
HSC accumulator counts up, the direction flag is set to (1). Whenever the HSC
accumulator counts down, the direction flag is cleared (0).
If the accumulated value stops, the direction bit retains its value. The only time the
direction flag changes is when the accumulated count reverses.
This bit is updated continuously by the HSC sub-system whenever the controller
is in a run mode.
HPReached

type
HSCSTS.HPReached BOOL 2...9 read/write
The HSC sub-system sets the HSCSTS.HPReached status flag to (1) whenever
the accumulated value (HSCSTS.Accumulator) is greater than or equal to the
high preset variable (HSCAPP.HPSetting).

is in an executing mode. Writing to this element is not recommended.
LPReached

type
HSCSTS.LPReached BOOL 2...9 read only
The HSC sub-system sets the HSCSTS.LPReached status flag to (1) whenever the
accumulated value (HSCSTS.Accumulator) is less than or equal to the low preset
variable (HSCAPP.LPSetting).
is in an executing mode. Writing to this element is not recommended.
OFCauseInter
Parameter Data HSC User program access

type mode
HSCSTS.OFCauseInter BOOL 0...9 read/write
The Overflow Interrupt status bit sets (1) when the HSC accumulator counts
through the overflow value and the HSC interrupt is triggered. This bit can be
used in the control program to identify that the overflow variable caused the HSC
interrupt. If the control program needs to perform any specific control action
based on the overflow, this bit is used as conditional logic.
This bit can be cleared (0) by the control program and is also cleared by the HSC
sub-system whenever these conditions are detected:
Low Preset Interrupt executes

High Preset Interrupt executes
Underflow Interrupt executes
UFCauseInter

type mode
HSCSTS.UFCauseInt BOOL 2...9 read/write
er
The Underflow Interrupt status bit sets (1) when the HSC accumulator counts
through the underflow value and the HSC interrupt is triggered. This bit can be
used in the control program to identify that the underflow condition caused the
HSC interrupt. If the control program needs to perform any specific control
action based on the underflow, this bit is used as conditional logic.

Low Preset Interrupt occurs

High Preset Interrupt occurs
Overflow Interrupt occurs
HPCauseInter

type mode
HSCSTS.HPCauseInt BOOL 0...9 read/write
er
The High Preset Interrupt status bit sets (1) when the HSC accumulator reaches
the high preset value and the HSC interrupt is triggered. This bit can be used in
the control program to identify that the high preset condition caused the HSC
based on the high preset, this bit is used as conditional logic.
Low Preset Interrupt occurs

Underflow Interrupt occurs
LPCauseInter

type mode
HSCSTS.LPCauseInte BOOL 2...9 read/write
r
The Low Preset Interrupt status bit sets (1) when the HSC accumulator reaches
the low preset value and the HSC interrupt is triggered. This bit can be used in the
control program to identify that the low preset condition caused the HSC
based on the low preset, this bit is used as conditional logic.
High Preset Interrupt occurs

Underflow Interrupt occurs

PlsPosition

type
HSCSTS.PLSPosition UINT 0...9 read only
When the HSC is in Counting mode, and PLS is enabled, this parameter indicates
which PLS element is used for the current HSC configuration.
ErrorCode

type
HSCSTS.ErrorCode BOOL 0...9 read only
Displays the error codes detected by the HSC sub-system.
Error code HSC counting User program access

sub-element error code
Bit 15-8 (high byte) 0-255 The non-zero value for the high byte indicates that the HSC error is due to the
PLS data setting. The value of the high byte indicates which element of the PLS
data triggers the error.
Bit 7-0 (low byte) 0x00 No error occurring.
0x01 Invalid HSC counting mode.
0x02 Invalid high preset.
0x03 Invalid overflow.
0x04 Invalid underflow.
0x05 No PLS data.
Accumulator
Parameter Data User program access

type
HSCApp.Accumulat DINT read/write
or
Sets the initial accumulator value when the High-Speed Counter starts. When the
HSC is in Counting mode, the Accumulator is automatically updated by the HSC
sub-system to reflect the actual HSC accumulator value.
HP

type
HSCSTS.HP DINT read only

The HSCSTS.HP is the upper setpoint (in counts) that defines when the HSC
The data loaded into the high preset must be less than or equal to the data resident
in the overflow (HSCAPP.OFSetting) parameter or an HSC error is generated.
This is the latest high preset setting, which may be updated by PLS function from
the PLS data block.
LP

type
HSCSTS.LP DINT read only
The HSCSTS.LP is the lower setpoint (in counts) that defines when the HSC
The data loaded into the low preset must be greater than or equal to the data
resident in the underflow (HSCAPP.UFSetting) parameter or an HSC error is
generated. If the underflow and low preset values are negative numbers, the low
preset must be a number with a smaller absolute value.
This is the latest low preset setting, which may be updated by PLS function from
the PLS data block.
HPOutput

type
HSCApp.HPOutput UDINT read/write
Defines the state (1 = ON or 0 = OFF) of the outputs on the controller when the
high preset is reached. For more information on how to directly turn outputs on
or off based on the high preset.
You can configure the high output bit pattern during initial setup, or you can use
the HSC function block to load the new parameters while the controller is
operating.
LPOutput

type
HSCApp.LPOutput UDINT read/write

LPOutput (HSCApp.LPOutput) defines the state (1 = "on", 0 = "off ") of the

outputs on the controller when the low preset is reached. For more information
on how to directly turn outputs on or off based on the low preset.
You can configure the low output bit pattern during initial setup, or you can use
the HSC function block to load the new parameters while the controller is
operating.
HSCSTSInfo parameters example
The following image shows the HSCStsInfo parameters in the Variable Selector.
See also
HSC on page 318
PLS data type PLSData (data type PLS) is used to configure the programmable limit switch.
PLSData structure elements
The PLS data structure is a flexible array with the following elements.
Element Element Data Type Element description

order
HSCHP Word 0...1 DINT High preset
HSCLP Word 2...3 DINT Low preset
HSCHPOutput Word 4...5 UDINT Output high data

HSCLPOutput Word 6...7 UDINT Output low data
The total number of elements for one PLS data structure should not exceed 255.
PLSData parameters
The following table lists the PLSData parameter details.
Element Data Type Data Format HSC mode User program Description
access
HSCHP DINT 32-bit signed 0 read/writer High preset
integer
HSCLP DINT 32-bit signed 0 read/writer Low preset
integer
HSCHPOutput UDINT 32-bit binary 0 read/writer Output high data
HSCLPOutput UDINT 32-bit binary 0 read/writer Output low data
HSCApp settings versus PLSData settings
When the PLS function is enabled, relevant HSCApp settings are superseded by
the corresponding PLSData settings as shown in the following table.
HSCApp setting PLSData setting

HSCAPP.HpSetting HSCHP
HSCAPP.LpSetting HSCLP
HSCAPP.HPOutput HSCHPOutput
HSCAPP.LPOutput HSCLPOutput
PLSData parameters example
The following figure shows the PLSData parameters in the Variable Selector.
See also
Configure a Programmable Limit Switch (PLS) on page 344

HSC_SET_STS (high-speed HSC_SET_STS manually sets or resets the HSC counting status.
counter set status) Operation details:
The HSC function block must be stopped (not counting) for the
HSC_SET_STC function block to set or reset the HTS status. If HSC
function is not stopped, the input parameters continue to update and
changes made using HSC_SET_STS are ignored.

Text.

Type
Enable Input BOOL Instruction block enable.
TRUE - set/reset the HSC status.
FALSE - there is no HSC status change.
HscID Input UINT Manually sets ore resets the HSC status.
Mode1Done Input BOOL Mode 1A or 1B counting is done.
HPReached Input BOOL High preset reached.
This bit can be reset to FALSE when HSC is not counting.
LPReached Input BOOL Low preset reached.
This bit can be reset to FALSE when HSC is not counting.
OFOccurred Input BOOL Overflow occurred.
This bit can be reset to FALSE when necessary.
UFOccurred Input BOOL Underflow occurred.
This bit can be reset to FALSE when necessary.
Sts Output UINT Status codes are defined in HSC status codes (Sts).


HSC status codes (Sts)
The following table describes the status codes for the HSC function block.
Status code Status description
0x00 No action taken (not enabled).

0x01 HSC execution successful.
0x02 HSC command invalid.
0x03 HSC ID out of range.
0x04 HSC configure error.
HSC_SET_STS Function Block Diagram example

HSC_SET_STS Ladder Diagram example
HSC_SET_STS Structured Text example
See also
Use the High-Speed Counter This section provides specific details and examples for using high-speed counter
instructions in logic programs, including the following:
instructions
Update HSC application data on page 338
Configure a High-Speed Counter (HSC) user interrupt on page 340
Example: How to create a High-Speed Counter(HSC) on page 345

Example: How to add a Programmable Limit Switch (PLS) function on page 355
Example: Programmable Limit Switch (PLS) enabled on page 356
Update HSC application data HSC configuration is defined in the HSC application data, and is usually only
configured once before programming the HSC instruction. Changes made to the
HSC application data (HSCAppData parameter) are ignored while the HSC is
counting.
To update the HSC configuration
1. Update HSCAppData.
2. Call the HSC instruction with command 0x03 (set/reload).
See also
Example: How to create a High-Speed Counter (HSC) program on page

345
HSC (high-speed counter) on page 318

High-Speed Counter (HSC) User In Interrupt Type, select High-Speed Counter (HSC) User Interrupt.
Interrupt dialog box Use the HSC interrupt dialog box to:
Configure the interrupt properties, such as ID and the program to use it in.
Configure the interrupt parameters.
See also
High-Speed Counter instructions on page 317

Configure a High-Speed Counter A user interrupt causes the controller to suspend the task it is currently
performing, perform a different task, and then return to the suspended task at the
(HSC) User Interrupt
point where the task was suspended.
<Mi830> and Micro850 controllers support up to six HSC User Interrupts that
can be used to execute selected user logic at a pre-configured event.
See also

345
Add and configure a High-Speed To add and configure a HSC interrupt from the controller's configuration
workspace, perform the following steps.
Counter (HSC) User Interrupt
To add an HSC interrupt:

workspace.
2. In the Controller tree, click Interrupts to display the Interrupt

configuration page.
3. Right-click an empty row, and click Add to open the Interrupt properties
dialog box.

4. To configure an HSC interrupt:
In Interrupt Type, select High-Speed Counter (HSC) User

Interrupt.
Select the HSC Interrupt properties.
Select the HSC Interrupt parameters.
5. Close the Interrupt properties dialog box.
See also
High-Speed Counter instructions on page 317
HSC Interrupt properties on page 341
HSC Interrupt parameters on page 342
HSC Interrupt properties The HSC Interrupt properties status bits indicate the enabled/disabled status, the
execution status, and whether or not the interrupt condition is lost.
User Interrupt Enable (HSC0.Enabled)
Parameter Data HSC modes User program access

format
HSCO.Enabled bit 0...9 read only
Enabled bit is used to indicate HSC interrupt enable or disable status.
User Interrupt Executing (HSC0.EX)

format
HSCO.Ex bit 0...9 read only
The EX (User Interrupt Executing) bit is set (1) whenever the HSC sub-system
begins processing the HSC subroutine due to any of the following conditions:
Low preset reached

High preset reached
Overflow condition - count up through the overflow value
Underflow condition - count down through the underflow value
The HSC EX bit can be used in the control program as conditional logic to detect
if an HSC interrupt is executing.

The HSC sub-system will clear (0) the EX bit when the controller completes its
processing of the HSC subroutine.
User Interrupt Pending (HSC0.PE)

format
HSCO.PE bit 0...9 read only
The PE (User Interrupt Pending) status flag indicates an interrupt is pending. The
PE status bit can be monitored or used for logic purposes in the control program if
you need to determine when a subroutine cannot be immediately executed. The
PE bit is maintained by the controller and is set and cleared automatically.
User Interrupt Lost (HSC0.LS)

format
HSCO.LS bit 0...9 read only
The LS (User Interrupt Lost) is a status flag that indicates an interrupt has been
lost. The controller can process 1 active user interrupt condition and maintain 1
pending user interrupt condition before it sets the lost bit.
The LS bit is set by the controller. It is up to the control program to use and
monitor a lost condition.
See also
HSC Interrupt parameters The HSC interrupt parameters are used to configure the start and mask options.
Auto Start (HSC0.AS)
Parameter Data format HSC modes User program access

HSCO.AS bit 0...9 read only
Auto Start is configured with the programming device and stored as part of the
user program. The auto start bit defines if the HSC interrupt function
automatically starts whenever the controller enters any run or test mode.
Overflow Mask (HSC0.MV)
The MV (Overflow Mask) control bit is used to enable (allow) or disable (not
allow) an overflow interrupt from occurring. If the bit is clear (0), and
an Overflow Reached condition is detected by the HSC, the HSC user interrupt
is not executed.
The MV bit is controlled by the user program and retains its value through a
power cycle. The user program must set and clear the MV bit.
HSCO.MV bit 0...9 read only
Underflow Mask (HSC0.MN)

HSCO.MN bit 2...9 read only
The MN (Underflow Mask) control bit is used to enable (allow) or disable (not
allow) an underflow interrupt from occurring. If the bit is clear (0), and an
Underflow Reached condition is detected by the HSC, the HSC user interrupt is
not executed.
The MN bit is controlled by the user program and retains its value through a
power cycle. The user program must set and clear the MN bit.
High Preset Mask (HSC0.MH)

HSCO.MH bit 0...9 read only
The MH (High Preset Mask) control bit is used to enable (allow) or disable (not
allow) a high preset interrupt from occurring. If this bit is clear (0), and a High
Preset Reached condition is detected by the HSC, the HSC user interrupt is not
executed.
The MH bit is controlled by the user program and retains its value through a
power cycle. The user program must set and clear the MH bit.
Low Preset Mask (HSC0.ML)

HSCO.ML bit 2...9 read only
The ML (Low Preset Mask) control bit is used to enable (allow) or disable (not
allow) a low preset interrupt from occurring. If this bit is clear (0), and a Low
Preset Reached condition is detected by the HSC, the HSC user interrupt is not
executed.

The ML bit is controlled by the user program and retains its value through a
power cycle. The user program must set and clear the ML bit.
See also
Configure a Programmable The high-speed counter has additional operating modes for implementing a
Programmable Limit Switch (PLS). The PLS function is used to configure the
Limit Switch (PLS)
High-Speed Counter to operate as a PLS or as a rotary cam switch. The PLS
function supports up to 255 pairs of high and low presets, and can be used when
you need more than one pair of high and low presets.
Enabling PLS in the HSC
The PLS mode only operates in tandem with the HSC of the Micro800
controller, and must be enabled in the HSC instruction by setting the
HSCAppData.PLSEnable parameter to True.
The PLSPosition parameter is reset after completing a full cycle and reaching the
HSCSTS.HP value. Resetting the HSC instruction or moving 0 to the
PLSPositon parameter does not reset the PLSPosition.
HSC operation when PLS is enabled
The PLS function can operate with all other HSC capabilities, including the
ability to select which HSC events generate a user interrupt.
When the PLS function is enabled, and the controller is in run mode, the HSC
counts incoming pulses, and the following events occur.
When the count reaches the first preset (HSCHP or HSCLP) defined in
the PLS data, the output source data (HSCHPOutput or HSCLPOutput)
is written through the HSC mask (HSCAPP.OutputMask).
At that point, the next presets (HSCHP and HSCLP) defined in the PLS
data become active.
When the HSC counts to the new preset, the new output data is written
through the HSC mask.
This process continues until the last element within the PLS data block is
loaded.
At that point the active element within the PLS data block is reset to zero.

This behavior is referred to as circular operation.
See also
Configure High-Speed Counter (HSC) user interrupts on page 340

345
Example: How to create a This example shows how to create a High-Speed Counter (HSC) program that
uses a quadrature encoder and includes a Programmable Limit Switch (PLS)
High-Speed Counter (HSC)
function.
program
Quadrature encoder used in the example
The High Speed Counter program example uses an HSC function block and a
quadrature counter with phased inputs A and B. The quadrature encoder
determines the direction of rotation and the position for rotating equipment, such
as a lathe. The Bidirectional Counter counts the rotation of the quadrature
encoder.
The following quadrature encoder is connected to inputs 0 and 1. The count

direction is determined by the phase angle between A and B:
If A leads B, the counter increments.

If B leads A, the counter decrements.

Create a High-Speed Counter (HSC) program
Perform the following tasks for to create, build, and test the HSC program, and
then add a PLS function.
Table Table Heading

Heading
1 Create a ladder diagram and add variables on page 346
2 Assign values to the HSC variables on page 350
3 Assign variables and build the program on page 351
4 Test the program and run the High-Speed Counter on page 352
5 Add a Programmable Limit Switch (PLS) function on page 355
See also
Configure High-Speed Counter (HSC) user interrupts on page 340
Create a ladder diagram and add Create a ladder diagram and then add local variables to the rung. This sample
variables program uses a 2080-LC50-24QVB controller. The HSC is supported on all
Micro830 and Micro850 controllers except 2080-LCxx-xxAWB controller types.
To create a ladder diagram and add variables:
1. In the Device Toolbox, expand the Catalog tab to view the device folders.

2. Expand the Controllers folder and the Micro830 folder to view all
Micro830 controllers. Double-click a controller (2080-LC50-24QVB) to
add it to the Project Organizer.
3. In the Project Organizer, right-click Programs, click Add, and then

click New LD: Ladder Diagram to add a new ladder logic program.
4. Right-click UntitledLD and select Open.
5. In the Toolbox:
Double-click Direct Contact to add it to the rung, or

Drag and drop a Direct Contact onto the rung.
6. Assign a variable to the direct contact:

Double-click on the direct contact to display the Variable Selector,

and then click the I/O - Micro830 tab.
Click _IO_EM_DI_05, and then click OK to assign the direct contact
to input 5.
7. In the Toolbox, select a function block and drag it to the right of the direct
contact as shown in the following image.
8. Double-click the function block to open the Instruction Block Selector.
9. In the Instruction Block Selector, select HSC and click OK.

10. Verify the ladder rung looks similar to the following figure.
11. In the Project Organizer, double-click Local Variables to display

the Variables page.
12. In the Variables page, add the following variables and data types.
Variable Name Data Type

MyCommand USINT
MyAppData HSCAPP
MyInfo HSCSTS
MyPLS PLS
MyStatus UINT
Result
The Variables page should look like the image below:
See also
Add a Programmable Limit Switch (PLS) function on page 355


345
Assign values to the HSC variables After you add variables, follow these steps to add values to the variables using the
Initial Value column in the Variable Selector. A standard program usually uses a
routine to assign values to the variables.
To assign values to the HSC variables:
1. Expand MyAppData to view all variables.
2. Assign the HSC mode value:
In the Initial Value field for the MyAppData.HSCMode variable, type

6.
3. Assign the rest of the values to the MyAppData variables as shown in the
following figure.
In the Initial Value field, enter the value.
4. Assign the HSC command value:
In the Initial Value field for the MyCommand variable, type 1.
See also
Assign variables and build the program on page 351


345
HSCCmd values on page 320
HSCAPP data type on page 321
Assign variables and build the After you enter values in the HSC variables, follow these steps to assign the
program variables to the function block, and build the program.
To assign variables and build the program:
1. From the Ladder Diagram editor, assign each variable to the HSC function
block element as shown.
2. From Project Organizer, click the controller to display the Controller

tree.

3. From the Controller tree, click Embedded I/O, and select input filters for
the encoder.
4. Verify the encoder is connected to the Micro830 controller.
5. Start the Micro830 controller and connect the controller to your computer.
6. Build the program and then download the program to the controller.
See also

345
Create a ladder diagram and add variables on page 346
Assign values to the HSC variables on page 350
Test the program and run the After you download the HSC program to the controller, you can test it and then
High-Speed Counter run the High-Speed Counter.
To test the program:
1. Connect to the Controller.
2. From the Project Organizer, double-click the HSC program, then

double-click Local Variables.
You can see the values of the two HSC outputs: STS (MyStatus) and
HSCSTS (MyInfo).

3. Double-click the _IO_EM_DI_05 direct contact to display the Variable

Selector window.
4. Click the I/O Micro830 tab, and then click the _IO_EM_DI_05 row.
5. Select Lock and Logical Value to force the input to the ON position.
6. To view results, click the Local Variables tab to view variable changes.
7. Expand MyAppData and MyInfo variable list.
8. Turn on the encoder to see the counter count up/down. For example, if the
encoder is attached to a motor shaft, then turn on the motor to trigger the
HSC count.
9. Verify the Logical Value of in the MyStatus variable is 1, which indicates the
HSC is running.
10. View the counter value in MyInfo.Accumulator.

Results
In this example, once MyInfo.Accumulator reaches a High Preset value of 40,

output 0 turns on and the HPReached flag turns on. If MyInfo.Accumulator
reaches a Low Preset value of -40, output 1 turns on and the LPReached flag turns
on.
See also

345

Add a Programmable Limit This example explains how to add a Programmable Limit Switch (PLS) function
to the HSC program.
Switch (PLS) function
Variable values for the counter settings:
MyAppData.PlsEnable is used to enable or disable the PLS settings. It

should be set to FALSE (disabled) if the MyAppData variable is used.
MyAppData.HscID is used to specify which embedded inputs will be used
based on the mode and application type. See HSC Inputs and Wiring
Mapping to know the different IDs that can be used as well as the
embedded inputs and its characteristics.
If ID 0 is used, ID 1 cannot be used on the same controller because the
inputs are used by Reset and Hold.
MyAppData.HscMode is used to specify the type of operation the HSC
uses to count. See HSC Mode (HSCAPP.HSCMode).
To enable PLS:
1. In Project Organizer, double-click Local Variables to display

the Variables page.
2. Enable the PLS function:
In the Initial Value field for the MyAppData.PlsEnable variable, select

TRUE.
3. Configure the underflow and overflow settings:
In the Initial Value field for MyAppData.OFSetting, type 50.

In the Initial Value field for MyAppData.UFSetting, type -50.
4. (optional) Configure the output mask if an output.

Results for this example:
The PLS variable has a dimension of [1..4]. This means that HSC can
have four pairs of High and Low Presets.
High Preset values should be lower than the OFSetting and the Low
Preset should be greater than the UFSetting.
The HscHPOutPut and HscLPOutPut values determine which
outputs are turned on when a High Preset or Low Preset is reached.
See also

345
Example: Programmable Limit This example describes the results when PLS is enabled using specific HSC and
PLSData parameter values.
Switch (PLS) enabled
HSC parameter values
This example assumes the HSC parameters are set to the following values:
HSCApp.OutputMask = 31
HSCApp.HSCMode = 0
HSC controls Embedded Output 0...4 only

PLSData parameter values
This example assumes the PLSData parameters for the variable (HSC_PLS) are
configured as follows.
PLS enabled results
For this example, the following events occur.
When the ladder logic first runs: HSCSTS.Accumulator = 1, which means

all outputs are turned off.
When HSCSTS.Accumulator = 250, HSC_PLS[1].HSCHPOutput is sent
through the HSCAPP.OutputMask, and energizes outputs 0 and 1.
Sending the high preset output through the output mask repeats as the
HSCSTS.Accumulator reaches 500, 750, and 1000, and the controller
energizes outputs 0...2, 0...3, and 0...4 respectively.
After the operation completes, the cycle resets and repeats from
HSCSTS.HP = 250.
When the full cycle completes and the HSCSTS.HP value is reached the
PLSPositon parameter is reset.
See also
Updating HSC application data on page 338
Configuring High-Speed Counter (HSC) user interrupts on page 340

Configuring a Programmable Limit Switch (PLS) on page 344

345

Chapter 15
Input/Output instructions
Use Input/Output instructions to read or write data to or from a controller or

module using signals sent to a device that is physically connected to a
programmable logic controller. Input relays transfer signals to the internal relays,
and output relays transfer signals to external output devices.
LCD on page 360 Micro810 only.

Displays a string or number on an LCD screen.
LCD_BKLT_REM on page 362 Sets the remote LCD backlight parameters in a user program.
LCD_REM on page 364 Displays user defined messages for the remote LCD.
RHC on page 368 Reads the high speed clock value in the Micro800 controller.
RPC on page 370 Reads the user program checksum, either from the controller or memory module.
DLG on page 371 Writes variable values from the run-time engine into a Data Logging File on an SD
Card.
IIM on page 373 Updates inputs prior to normal output scan.
IOM on page 375 Updates outputs prior to normal output scan.
KEY_READ on page 378 Micro810 only.
Reads the Key status on the optional LCD module when the user display is active.
KEY_READ_REM on page 381 Micro820 only.
Reads the Key status on the optional remote LCD module when the user display is
active.
MM_INFO on page 383 Reads memory module header information.
MODULE_INFO on page 387 Reads module information from a plug-in or expansion module excluding the
2080-MEMBAK-RTC memory module.
PLUGIN_INFO on page 400 Reads module information from a generic plug-in or expansion module excluding
the 2080-MEMBAK-RTC memory module.
PLUGIN_READ on page 403 Reads data from a generic plug-in module excluding the 2080-MEMBAK-RTC
memory module.
PLUGIN_RESET on page 405 Resets the hardware for a generic plug-in module excluding the
2080-MEMBAK-RTC memory module.
PLUGIN_WRITE on page 407 Writes data to a generic plug-in module excluding the 2080-MEMBAK-RTC
memory module.
RCP on page 409 Reads and writes recipe data to and from an SD memory card.
RTC_READ on page 412 Reads the real-time clock (RTC) module information.
RTC_SET on page 414 Sets RTC data to the RTC module information.
SYS_INFO on page 417 Reads the status data block for the Micro800 controller.

Chapter 15 Input/Output instructions
TRIMPOT_READ on page 419 Reads the trimpot value from a specific trimpot.
See also
LCD Displays a string or a number on the optional LCD screen.

Text.
This instruction applies to the Micro810 controllers.

Type
Enable Input BOOL Instruction enable.
TRUE - the LCD switches to the user-defined screen (strings display on
the LCD screen) instead of the I/O status screen.
FALSE - the LCD displays the contents of the I/O status screen.
Line1 Input STRING String displayed on line 1 of the LCD.
LCD Output BOOL TRUE - function is enabled.

Input/Output instructions Chapter 15
LCD Function Block Diagram example
LCD Ladder Diagram example
LCD Structured Text example
TESTOUTPUT := LCD(LCDENABLE, LINE1, LINE2, LINE3, LINE4) ;

Results
See also
Input/Output instructions on page 359
KEY_READ on page 378
LCD_BKLT_REM (remote Sets the Remote LCD backlight parameters in a user program.
LCD backlight) Operation details:
The backlight settings defined in LCD_BKLT_REM are used when the Remote
LCD display is:
a user defined screen defined using LCD_REM.

the default IO Status screen.
For all other screens, the backlight settings used are those defined using the
menu on the Remote LCD.

Text.


Type
TRUE - execute REM_LCD_BKLT, overwrite any current backlight
settings.
FALSE - REM_LCD_BKLT is disabled and the Remote LCD menu
settings take effect.
Color Input UINT Backlight Color Code
0: White
1: Blue
2: Red
3: Green
4-65535: Reserved
Mode Input UINT 0 : Permanently OFF
1: Permanently ON
2: Flash (1 sec interval)
3-65535: Reserved
LCD_BKLT_RE Output BOOL TRUE - Instruction executed successfully.
M FALSE - Error occurred during instruction execution.
Sts Output UINT Status of the remote LCD operation.
LCD_BKLT_REM status codes:
0 - Enable input is false.
1 - Success.
2 - Remote LCD not detected.
May occur when:
Remote LCD is not physically connected to the controller
or the wiring is incorrect.
Serial port settings are other than what is required for
the Remote LCD.
3 - Connection error.
May occur when there is an internal state machine error such as
an incompatibility between Controller FW version and RLCD FW
version.
4 - Invalid color code.
5 - Invalid mode.
6-65535 - Reserved.

LCD_BKLT_REM Function Block Diagram examples
LCD_BKLT_REM Ladder Diagram example
LCD_BKLT_REM Structured Text example
See also
LCD_REM (remote LCD) Displays user defined messages for the Remote LCD.
Operation details:
For Line1 through Line8 the maximum string length is 24 characters.

Text.


Type
Enable Input BOOL Enable the instruction block.
TRUE - remote LCD switches to user-defined screen from I/O
status screen.
FALSE - remote LCD switches back to I/O status screen.
Font Input UDINT Font size for startup message:
0: Default (Large 8x16)
1: Small (8x8)
2: Large (8x16)
3: Extra Large (16x16)
4 onward: Reserved
The Remote LCD size is 192x64 pixels.

When the font size for the start up message is small font, the
Remote LCD displays:
strings in Line1 to Line8.
a maximum of 24 characters per line.
When the font size for the start up message is large or extra
large, the Remote LCD displays:
strings in Line1 to Line4.
ignores strings in Line5 to Line8.
a maximum of 12 characters per line.


Type
Line1 Input String String to be displayed on line 1 of the LCD.
For Line1 through Line8 the maximum string length is 24
characters.
Line2 Input String String displayed on line 2 of the LCD.
LCD_REM Output BOOL Function block enable.
When Enable = TRUE, user display is active.
When Enable = FALSE, IO Status/Menu display is active.
Sts Output UINT Status of the remote LCD operation.
LCD_REM status codes:
0 - Enable input is false.
1 - User message displayed successfully.
3 - Connection error.
May occur when:
Remote LCD is not physically connected to the
controller (or the wiring is incorrect).
Serial port settings are other than what is
required for the Remote LCD.
4 - Invalid font code.
5 - 5-65535 - Reserved.

LCD_REM Function Block Diagram example

LCD_REM Ladder Diagram example
LCD_REM Structured Text example
See also
RHC (read high speed clock) Reads the high speed clock value in the Micro800 controller.


Text.

controllers.

Type
TRUE - read high speed clock.
FALSE - no operation.
RHC Output UDINT The value of the high speed clock.
High-speed clock resolution
Controller Type Increments Timebase Resolution

Micro810 4 every 40 s 10 s 40 s
Micro820 1 every 10 s 10 s 10 s
Micro830
Micro850
RHS Function Block Diagram example
RHS Ladder Diagram example

RHS Structured Text example
TESTOUTPUT2 := RHC() ;
See also
RPC (read program Reads the user program checksum, either from the controller or memory module.
checksum) Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.

controllers.

Type
MemMod Input BOOL TRUE - the value is taken from the memory module.
FALSE - the value is taken from the Micro800 controller.
RPC Output UDINT The checksum value of the specified user program.
RPC Function Block Diagram example

RPC Ladder Diagram example
RPC Structured Text example
TESTOUTPUT2 := RPC(TESTINPUT) ;
See also
DLG (data log) Writes variable values from the run-time engine into a Data Logging File on an
SD Card.
When writing to a data log a maximum of 50 group folders are allowed per day.
Each group folder has a maximum of 50 files with a file size of 4k-8k.

Text.


Type
Enable Input BOOL Data logging write enable.
TRUE - Rising Edge Enable detected, start data logging
operation when previous instruction operations are
complete.
FALSE - Rising Edge not detected.
TSEn Input BOOL TRUE - Date and time stamp logging enable flag.
CfgID Input USINT Data logging configuration VA ID number from 1-10.
Status Output USINT Current status of the instruction.
Data logging Status codes:
0 - Idle
1 - Doing
2 - Succeed, indicates data logging is complete.
3 - Error, indicates data logging completed with error.
ErrorID Output UDINT A unique numeric error code for DLG.
DLG error codes
Error code Error Name Comments

0 DLG_ERR_NONE No error.
1 DLG_ERR_NO_SDCARD SD card is absent.
2 DLG_ERR_RESERVED Reserved.
3 DLG_ERR_DATAFILE_ACCESS Access Data logging file error.
4 DLG_ERR_CFG_ABSENT Data logging configuration file is absent.
5 DLG_ERR_CFG_ID Configure ID is absent in data logging configuration file
6 DLG_ERR_RESOURCE_BUSY The Data logging operation linked to this Data logging ID is
used by another FB operation.
7 DLG_ERR_CFG_FORMAT Data logging configuration file format is invalid.
8 DLG_ERR_RTC Real time clock is invalid.
9 DLG_ERR_UNKNOWN Unspecified error has occurred.
DLG Function Block Diagram example

DLG Ladder Diagram example
DLG Structured Text example
See also
IIM (immediate input) Update inputs prior to normal output scan.
Operation details:
Typically used at the beginning of an interrupt program to select or mask

inputs that are immediately scanned to get the current inputs.

Text.

controllers.


Type
TRUE - execute instruction block.
FALSE - do not execute.
InputType Input USINT Identifies the type of input:
0 - Embedded input.
1 - Plug-in input.
InputSlot Input USINT Identifies the input slot.
0 - Embedded input
1,2,3,4,5 - Plug-in slot number. (Slots are numbered from
left to right, starting with number 1.)
For embedded input, always 0.
For Plug-in input, input slot is 1,2,3,4,5 (Plug-in slot number,
starting with left-most slot = 1).
Sts Output USINT Immediate input scan status.
IIM status (Sts) codes:
0x00 - Not enabled (no action taken).
0x01 - Input/output scan success.
0x02 - Input/output type invalid.
0x03 - Input/output slot invalid.
TRUE - Input updated.
FALSE - Input not updated.
IIM Function Block Diagram example

IIM Ladder Diagram example
IIM Structured Text example
Results
See also
IOM (immediate output) Update outputs prior to normal output scan.
Operation details:

Typically used at the end of an interrupt program to select or mask which

outputs are immediately scanned and updated.

Text.

controllers.

Type
TRUE - execute instruction.
FALSE - do not execute.
OutputType Input USINT Identifies the type of output:
0 - Embedded output.
1 - Plug-in output.
OutputSlot Input USINT Identifies the output slot:
0 - Embedded output
1,2,3,4,5 - Plug-in slot number. (Slots are numbered from
left to right, starting with number 1.)
For embedded output, always 0.
For Plug-in output, output slot is 1,2,3,4,5 (Plug-in slot
number, starting with left-most slot = 1).
Sts Output USINT Immediate output scan status.
IOM (Sts) status codes:
0x00 - Not enabled (no action taken).
0x01 - Input/output scan success.
0x02 - Input/output type invalid.
0x03 - Input/output slot invalid.
TRUE - Output updated.
FALSE - Output not updated.

IOM Function Block Diagram example
IOM Ladder Diagram example
IOM Structured Text example

Results
See also
KEY_READ (read keys on Reads the Key status on the optional LCD module when the user display is active.
LCD) Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.
This instruction applies to the Micro810 controller.


Type
Enable Input BOOL Enables the instruction block.
TRUE - enable Read Keys on the Remote LCD keypad.
FALSE - disable Read Keys on the Remote LCD keypad.
CKYL Output BOOL TRUE: ESC key pressed for more than 2 seconds.
EKYL Output BOOL TRUE: OK key pressed for more than 2 seconds.
CKY Output BOOL TRUE: ESC key pressed.
EKY Output BOOL TRUE: OK key pressed.
UKY Output BOOL TRUE: Up key pressed.
DKY Output BOOL TRUE: Down key pressed.
LKY Output BOOL TRUE: Left key pressed.
RKY Output BOOL TRUE: Right key pressed.
KEY_READ Function Block Diagram example

KEY_READ Ladder Diagram example
KEY_READ Structured Text example
KEY_READ_1(KEYENABLE) ;
KEY_EKYL := KEY_READ_1.EKYL ;
KEY_CKY := KEY_READ_1.CKY ;

KEY_EKY := KEY_READ_1.EKY ;
KEY_UKY := KEY_READ_1.UKY ;
KEY_DKY := KEY_READ_1.DKY ;
KEY_RKY := KEY_READ_1.RKY ;
KEY_LKY := KEY_READ_1.LKY ;
See also
LCD on page 360
KEY_READ_REM (read keys Reads the Key status on the optional Remote LCD module when the user display
is active.
for remote LCD)
Operation details:
Use the LCD_REM instruction to activate the user display on the Remote
LCD module. If the user display is not active, an error occurs during
KEY_READ_REM execution.
P-BUTTON property in LCD Function File activates; otherwise all key
status is FALSE.
Only single key presses are supported for the KEY_READ_REM
instruction; two-key press combinations are not supported.

Text.

Type
TRUE - Enable
FALSE - Disable


Type
KEY_READ_REM Output BOOL TRUE - Remote LCD Key data is read successfully.
FALSE - Enable is false, there is an error reading. Remote LCD
Key Data or User Display is not active.
Sts Output UINT Status of the KEY_READ_REM operation.
KEY_READ_REM status codes:
0 - Enable Input is False.
1 - Key data read successfully.
May occur when:
Remote LCD is not physically connected to the
controller (or the wiring is incorrect).
Serial port settings are other than what is
required for the Remote LCD.
3 - Connection Error.
May occur when there is an internal state machine error.
Possible cause, an incompatibility between Controller FW
version and RLCD FW version.
4 - User Display is not active.
5-65535 - Reserved.
KeyData Output UDINT Remote LCD KeyPad Data.
KeyData definitions are defined in KeyData bitfields table.
KeyData bitfields table
Use this table to help determine the KeyData bitfields for KEY_READ_REM.
Bit No. in KeyData Name Parameter Description
0 UKY TRUE = Up key pressed.

1 DKY TRUE = Down key pressed.
2 LKY TRUE = Left key pressed.
3 RKY TRUE = Right key pressed.
4 F1KY TRUE = F1 key pressed.
10 EKY TRUE = Enter key pressed.
11 CKY TRUE = Cancel key pressed.
12 EKYL TRUE = Enter key pressed for more than 2 seconds.
13 CKYL TRUE = Cancel key pressed for more than 2 seconds.
14-31 -- Reserved.

KEY_READ_REM Function Block Diagram example
KEY_READ_REM Ladder Diagram example
KEY_READ_REM Structured Text example
See also
MM_INFO (memory module Reads Memory Module header information. When a Memory Module is not
present, all values return zero (0).
information)
Text.


controllers.

Type
TRUE - read Memory Module header information.
FALSE - there is no read operation, and the output Memory
Module information is invalid.
MMInfo Output MMINFO Memory Module Information is defined in the MMINFO data
type.
MM_INFO Function Block Diagram example
MM_INFO Ladder Diagram example
MM_INFO Structured Text example

Results
For controllers using 2080-MEMBAK-RTC:

For controllers using an SD card:
See also
MMINFO data type on page 386
MMINFO data type The following table describes the MMINFO data type parameters.
MMCatalog MMCATNUM The catalog number of the Memory Module.

When using the MM_INFO instruction on controllers with an SD card, the
MMCatalog is "SD CARD".
Series UINT The series of the Memory Module.
When using the MM_INFO instruction on controllers with an SD card, the
series is 0.
Revision UINT The revision of the Memory Module.
When using the MM_INFO on controllers with an SD card, the revision is 0.
UPValid BOOL User program valid (TRUE: Valid).
ModeBehavior BOOL Mode behavior (TRUE: Go to RUN on power up).
LoadAlways BOOL Memory Module restore to controller always on power up.
LoadOnError BOOL Memory Module restore to controller if power up with error.
FaultOverride BOOL Override fault on power up.
MMPresent BOOL Memory Module is present.
See also
MM_INFO on page 383

MODULE_INFO Reads module information from a plug-in module or an expansion module.
Operation details:
Plug-in module information is read during RUN time.

The 2080-MEMBAK-RTC memory plug-in module is not supported.
Expansion module information is read when the module is powered on.
When a plug-in or expansion module is not defined with a ModuleID,
ProductType, or ProductCode, the MODULE_INFO operation returns 0
for the respective output parameter.
The plug-in and expansion module identification information is defined by
Allen-Bradley and is provided below as part of the MODULE_INFO
description.

Text.

Expansion modules are only supported on the Micro850 controller.


Type
TRUE - executes MODULE_INFO read operation.
FALSE - does not execute the read operation. All output data values are
reset to 0.
ModuleType Input USINT Identifies the module type:
1 - 2085 Expansion Module.
2 - 2080 Plug-in Module.
SlotID Input USINT The slot number where the plug-in or expansion module is located.
Slot IDs are: 1, 2, 3, 4, 5
Slot 1 is on the far left.
Done Output BOOL TRUE - Operation completed successfully.
FALSE - Operation is not executing or an error condition occurred.
Present Output BOOL Detects the plug-in or expansion module in the controller slot.
TRUE - Module is physically present.
FALSE - Module is not physically present.
ModID Output UINT The identification for the module in the controller slot.
Plug-in modules are defined with a unique module identifier.
Expansion modules are not defined with a unique module
identifier, ModID returns 0.
VendorID Output UINT The plug-in or expansion module vendor ID.
For Allen-Bradley products, the vendor ID is 1.
ProductType Output UINT The plug-in or expansion module product type.
ProductCode Output UINT The plug-in or expansion module product code.
ModRevision Output UINT The plug-in or expansion module revision information.
FALSE - No error.
ErrorID Output USINT A unique numeric that identifies the error. The errors are defined in the
MODULE_INFO error codes.
MODULE_INFO error codes
Use this table to determine the MODULE_INFO error codes and descriptions.
1 Invalid module type.

Change to a valid module type.
Valid module types are:
1 - 2085 Expansion Module. Only supported on Micro850 controllers.
2 - 2080 Plug-in Module. Supported on Micro820, Micro830, and Micro850 controllers.
2 Invalid slot number.
Change to a valid slot number.
3 Invalid expansion module type.

4 Expansion module fatal error.
5 Plug-in module Read Info is not supported.
6 Plug-in module read error occurred while reading the Module ID.
7 Plug-in module read error occurred while reading the Vendor ID.
8 Plug-in module read error while reading the Product Type.
9 Plug-in module read error occurred while reading the Product Code.
10 Plug-in module read error occurred while reading the Module Revision.
MODULE_INFO Function Block Diagram example

MODULE_INFO Ladder Diagram example

MODULE_INFO Structured Text example
Results
See also
MODULE_INFO instruction timing diagrams on page 394

MODULE_INFO - Plug-in and Expansion module information on page

392
MODULE_INFO - plug-in and The following information provides the plug-in and expansion module Type,
Module ID, Vendor ID, Product Codes and the Revision Word descriptions for
expansion module information
expansion modules as defined by Allen-Bradley.
Plug-in module information
Use this table to determine the plug-in module information defined by

Allen-Bradley.
Plug-in Module Plug-in Type Module ID Vendor ID Product Type Product Code
2080-IF2 Analog 96 1 10 32
2080-IF4 Analog 98 1 10 33
2080-OF2 Analog 100 1 10 34
2080-TC2 Analog 102 1 10 35
2080-RTD2 Analog 104 1 10 36
2080-DNET20 Communication 34 1 12 249
2080-SERIALISOL Communication 32 1 - -
2080-IQ4 Digital 192 1 7 192
2080-OB4 Digital 193 1 7 193
2080-OV4 Digital 194 1 7 194
2080-IQ4OB4 Digital 195 1 7 195
2080-IQ4OV4 Digital 196 1 7 196
2080-OW4I Digital 197 1 7 197
2080-MOT-HSC Specialty 48 1 43 48
2080-TRIMPOT6 Specialty 72 1 - -
Expansion module information
Use this table to determine the expansion module information defined by

Allen-Bradley.

Model number Expansion Type Module ID Vendor ID Product Type Product Code
2085-IF4 Analog - 1 10 208
2085-IF8 Analog - 1 10 206
2085-IRT4 Analog - 1 10 213
2085-OF4 Analog - 1 10 214
2085-IA8 Digital - 1 7 1148
2085-IM8 Digital - 1 7 1152
2085-IQ16 Digital - 1 7 1144
2085-IQ32T Digital - 1 7 1145
2085-OA8 Digital - 1 7 1149
2085-OB16 Digital - 1 7 1146
2085-OV16 Digital - 1 7 1147
2085-OW16 Digital - 1 7 1151
2085-OW8 Digital - 1 7 1150
Expansion module Revision Word descriptions
Use this table to determine the Revision Word information for Allen-Bradley
expansion modules.
Bit Name Description
15 Max Baud Rate (1:0) These bits identify the maximum frequency for Max Baud Rate (1:0).
00 (bin) is 2 Mbps
14
01 (bin) is 4 Mbps
10 (bin) is 8 Mbps
11 (bin) is 16 Mbps
13 Minor Revision (3:0) Minor Revision (3:0) is the product minor revision designation. This field indicates the
minor revision of the Catalog number designated by the Vendor ID, Product Type,
12 Product Code, Series and Major Revision.
The Minor Revision ranges from 0 to 15.
11
10

9 Major Revision (4:0) Major Revision (4:0) is the product major revision designation. This field indicates the
major revision of the Catalog number designated by the Vendor ID, Product Type,
8 Product Code, and Series.
The Major ranges from 0 to 31.
7
4 Series (4:0) SERIES (4:0) is the product Series designation. This field indicates the Series letter of the
Catalog number designated by the Vendor ID, Product Type, and Product Code.
Series Series Series Series Series Series Series Series
(4:0) (4:0) (4:0) (4:0)
0 A 8 I 16 Q 24 Y
1 B 9 J 17 R 25 Z
2 C 10 K 18 S 26 AA
3 D 11 L 19 T 27 AB
4 E 12 M 20 U 28 AC
5 F 13 N 21 V 29 AD
6 G 14 O 22 W 30 AE
7 H 15 P 23 X 31 >AE
See also
MODULE_INFO on page 387
MODULE_INFO instruction The following timing diagram examples describe execution scenarios for the
MODULE_INFO instruction.
timing diagrams

Successful execution when a module is physically present
Use this table to help determine the MODULE_INFO parameter values for each
scan cycle.
Scan Cycle Description
1, 8 Rung condition becomes TRUE when:

Enable input bit is TRUE.
ModuleType and SlotID are valid. A physical module is present.
Done and Present output bits are TRUE.
Error output bit is FALSE.
Update module related information for Module ID, Vendor ID, Product Type, Product Code, and
Module Revision accordingly.
2,3,4 No change in rung condition.
5. 9 Rung condition becomes FALSE when Enable bit is FALSE. All output parameters are cleared.
6, 7, 10, 11 No change in rung condition. Enable bit is FALSE. All output parameters are cleared.

Successful execution when Module is not physically present
scan cycle.

ModuleType and SlotID are valid. A physical module is not present.
Done output bit is TRUE.
Error and Present output bits are FALSE.
Input parameters are valid and a physical module is not present.
Update output parameters accordingly.
5. 9 Rung condition becomes FALSE when:
Enable bit is FALSE.
All output parameters are cleared.

MODULE_INFO execution with Error
scan cycle.

ModuleType and SlotID are valid. A physical module is not present.
Error output bit is TRUE.
Module related information for Module ID, Vendor ID, Product Type, Product Code, and Module
Revision is cleared.
ModuleType, SlotID, or both are invalid.

MODULE_INFO successful execution with error - no physical module
scan cycle.

ModuleType or SlotID or both are invalid. A physical Module is not present.
Done and Present output bits are FALSE.
Error output bit is TRUE.
Module related information for Module ID, Vendor ID, Product Type, Product Code, and Module
Revision is cleared.
2 No change in rung condition.
ModuleType or SlotID or both are invalid.
3, 4 No change in rung condition.
ModuleType and SlotID are both are valid. Module is physically present.
Error output bit is FALSE.
Update module information for Module ID, Vendor ID, Product Type, Product Code, and Module
Revision accordingly.


MODULE_INFO successful execution with error when physical module is

present
scan cycle.

ModuleType or SlotID or both are valid. Module is physically present.
Error output bit is FALSE
Module input parameters are valid and module is physically present.


ModuleType and SlotID are both are invalid. Module is physically present.
Done and Present output bits are FALSE.
Error output bit is TRUE and cleared.
Update module information for Module ID, Vendor ID, Product Type, Product Code, and Module
Revision accordingly.
See also
MODULE_INFO on page 387
Read module information from a generic Plug-in or Expansion module.

PLUGIN_INFO (plug-in
information) Operation details:
In Connected Components Workbench 10 or higher, the PLUGIN_INFO

instruction can read any generic Plug-in or Expansion Module information,
except the 2080-MEMBAK-RTC module.
When a generic Plug-in or Expansion Module is not present, all values
return to zero (0).

Text.


Type
TRUE - execute Plug-in or Expansion module information read.
FALSE - the instruction block is not executed. All output data values
are reset to 0.
SlotID Input UINT Plug-in Slot number:
Slot ID = 1,2,3,4,5
(Starting with the first Slot from left = 1).
Expansion Slot number:

Slot ID = 101, 102, 103, 104
(Starting with the first Slot from left = 101).
ModID Output UINT Plug-in Generic Module physical ID.
If the Expansion Module is not supported ModID = 0xFFF
If a Plug-in or Expansion Module is not present ModID = 0x0000
VendorID Output UINT The Plug-in or Expansion Generic Module vendor ID.
For Allen Bradley products, the vendor ID = 1.
If a Plug-in or Expansion Module is not present VendorID = 0x0000
ProductType Output UINT Plug-in or Expansion Generic Module product type.
If a Plug-in or Expansion Module is not present ProductType =
0x0000
ProductCode Output UINT Plug-in or Expansion Generic Module product code.
If a Plug-in or Expansion Module is not present ProductCode =
0x0000
ModRevision Output UINT Plug-in or Expansion Generic Module revision information.
If a Plug-in or Expansion Module is not present ModRevision =
0x0000
Applies only to Ladder Diagram programs. Ladder Diagram adds the
ENO output automatically.
PLUGIN_INFO Function Block Diagram example

PLUGIN_INFO Ladder Diagram example
PLUGIN_INFO Structured Text

example

Results
See also
PLUGIN_READ (read plugin) Reads data from a generic plug-in module.
Operation details:
Any plug-in module except for 2080-MEMBAK-RTC modules.

When a Plug-in Generic Module is not present, all values return to zero (0).

Text.


Type
TRUE - execute UPM read.
FALSE - there is no read operation and the data inside the data array
is invalid.
SlotID Input UINT Plug-in slot number.
Slot ID = 1,2,3,4,5 (starting with the far left slot = 1).
Offset Input UINT Address offset of the first data to be read, calculating from the first
byte of the Plug-in Generic Module.
DataLength Input UINT The number of bytes to be read.
DataArray Input USINT An array used to store the data read from the Plug-in Generic
Module.
Sts Output UINT Status codes for PLUGIN_READ.
Status (Sts) codes:
0x00 - Function block not enabled (no operation).
0x01 - Plug-in operation success.
0x02 - Plug-in operation fails due to an invalid Slot ID.
0x03 - Plug-in operation fails since it is not a valid Plug-in
Generic module.
0x04 - Plug-in operation fails due to data operated out of
range.
0x05 - Plug-in operation fails due to a data access parity
error.
PLUGIN_READ Function Block Diagram example

PLUGIN_READ Ladder Diagram example
PLUGIN_READ Structured Text example
See also
Resets any Plug-in Generic Module hardware except 2080-MEMBAK-RTC

PLUGIN_RESET (reset
modules. After the hardware reset, the Plug-in Generic Module is ready for
plugin) configuration and operation.

Text.


TRUE - execute Plug-in reset.
FALSE - there is no reset operation.
Sts Output UINT PLUGIN_RESET status codes.
Status (Sts) codes:
0x02 - Plug-in operation fails due to an invalid
Slot ID.
0x03 - Plug-in operation fails since it is not a valid
Plug-in Generic module.
0x04 - Plug-in operation fails due to data
operated out of range.
0x05 - Plug-in operation fails due to a data access
parity error.
PLUGIN_RESET Function Block Diagram example
PLUGIN_RESET Ladder Diagram example
PLUGIN_RESET Structured Text example

Results
See also
PLUGIN_WRITE (write Writes a block of data to any Plug-in Generic Module hardware except
2080-MEMBAK-RTC modules.
plugin)
Text.

Type
TRUE - execute Plug-in write.
FALSE - there is no data write operation.


AddrOffset Input UINT Address offset of the first data to be written, calculating from
the first byte of the Plug-in Generic Module.
DataLength Input UINT The number of bytes to be written.
DataArray Input USINT Data to be written to the Plug-in Generic Module.
Sts Output UINT PLUGIN_WRITE status codes.
Status (Sts) codes:
0x02 - Plug-in operation fails due to an invalid Slot ID.
0x03 - Plug-in operation fails since it is not a valid
Plug-in Generic module.
0x04 - Plug-in operation fails due to data operated out of
range.
0x05 - Plug-in operation fails due to a data access parity
error.
PLUGIN_WRITE Function Block Diagram example

PLUGIN_WRITE Ladder Diagram example
PLUGIN_WRITE Structured Text example
See also
RCP (recipe) Reads the data value of a variable from the recipe data file that resides in the recipe
data file folder in the SD card and updates the value to the run-time engine.
Writes the variable value with the run-time engine to the recipe data file in the SD
card.

Text.


Type
Enable Input BOOL Enable recipe read/write instruction block.
TRUE - Rising Edge detected, execute recipe instruction if the
previous operation is completed.
FALSE - Rising Edge not detected, do not execute recipe
instruction.
RWFlag Input BOOL TRUE - RWFlag (Write operation). Recipe writes the the
variable's values with the run-time engine into a recipe data
file on the SD card.
FALSE - RWFlag (Read operation). The recipe reads the
variable's values from the SD card and updates the
corresponding variable's value to the runtime engine.
CfgID Input USINT Recipe configuration VA ID number 1-10.
FileName Input STRING Recipe data file name (maximum 30 characters length).
Status Output USINT Recipe instruction block current status.
RCP status codes:
0 Idle
1 Doing
2 Succeed, complete without error.
3 Error, complete with error.
ErrorID Output UDINT The numeric RCP error code.
The definitions are defined in RCP error codes.
RCP error codes
Error code Error Name

0 RCP_ERR_NONE
1 RCP_ERR_NO_SDCARD
2 RCP_ERR_DATAFILE_FULL

Error code Error Name

3 RCP_ERR_DATAFILE_ACCESS
SD card are identified as:
broken.
full.
read only.
4 RCP_ERR_CFG_ABSENT
5 RCP_ERR_CFG_ID
6 RCP_ERR_RESOURCE_BUSY
7 RCP_ERR_CFG_FORMAT
8 RCP_ERR_RESERVED
Reserved for future possible expansion.
9 RCP_ERR_UNKNOWN
10 RCP_ERR_DATAFILE_NAME
11 RCP_ERR_DATAFOLDER_INVALID
12 RCP_ERR_DATAFILE_ABSENT
13 RCP_ERR_DATAFILE_FORMAT
14 RCP_ERR_DATAFILE_SIZE
Recipe data file size is too large (>4kb).
RCP Function Block Diagram example

RCP Ladder Diagram example
RCP Structured Text example
See also
RTC_READ ( read real-time Reads the real-time clock (RTC) module information.
clock) Operation details:
Micro810 or Micro820 controller with embedded RTC:

RTCBatLow is always set to zero (0).
RTCEnabled is always set to one (1).
When the embedded RTC has lost its charge/memory due to loss of power:
RTCData is set to 2000/1/1/0/0/0.
RTCEnabled is set to one (1).

Text.


controllers.

Type
TRUE - execute RTC information read.
FALSE - there is no read operation and output RTC data is invalid.
RTCData Output RTC RTC data information: yy/mm/dd, hh/mm/ss, week.
RTCData output is defined using the RTC data type.
RTCPresent Output BOOL TRUE - RTC hardware is plugged in.
FALSE - RTC hardware is not plugged in.
RTCEnabled Output BOOL TRUE - RTC hardware is enabled (timing).
FALSE - RTC hardware is disabled (not timing).
RTCBatLow Output BOOL TRUE - RTC battery is low.
FALSE - RTC battery is not low.
RTC data type
Use this table to help determine the parameter values for the RTC data type.
Parameter Data Description

type
Year UINT The year setting for the RTC. 16-bit value, and the valid range is from
2000 (Jan 01, 00:00:00) to
2098 (Dec. 31, 23:59:59)
Month UINT The month setting for the RTC.
Day UINT The day setting for the RTC.
Hour UINT The hour setting for the RTC.
Minute UINT The minute setting for the RTC.
Second UINT The second setting for the RTC.
DayOfWeek UINT The day of the week setting for the RTC. This parameter is ignored for RTC_SET.

RTC_READ Function Block Diagram example
RTC_READ Ladder Diagram example
RTC_READ Structured Text example
See also
RTC_SET (set real-time Set RTC (real-time clock) data to the RTC module information.
clock) Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.

controllers.

Type
TRUE - execute RTC_SET with the RTC information from
input.
FALSE - there is no read operation and output RTC data is
invalid.
RTCEnable Input BOOL TRUE - To enable RTC with the RTC data specified.
FALSE - To disable RTC.
This input is ignored by Micro810 and Micro820 controllers.
RTCData Input RTC RTC data information: yy/mm/dd, hh/mm/ss, week as
defined in the RTC data type.
RTCData is ignored when RTCEnable = 0.
Sts Output USINT The read operation status.
RTC_Set status (Sts) values:
0x01 - RTC set operation success.
0x02 - RTC set operation fails.
RTC data type


type
2000 (Jan 01, 00:00:00) to
2098 (Dec. 31, 23:59:59)
RTC_SET Function Block Diagram example
RTC_SET Ladder Diagram example
RTC_SET Structured Text example

See also
Reads the status data block for the Micro800 controller.

SYS_INFO
Text.

controllers.

Type
TRUE - execute read operation.
FALSE - do not execute function.
Sts Output SYSINFO System status data block.
The Sts output is defined in the SYS_INFO data type.
SYS_INFO Function Block Diagram example
SYS_INFO Ladder Diagram example

SYS_INFO Structured Text example
Results
See also
SYS_INFO data type on page 418
SYS_INFO data type The following table describes the SYSINFO data type.

BootMajRev UINT Boot Major Revision.

BootMinRev UINT Boot Minor Revision.
Operating System Series UINT Operating System Series:
0 indicates a series A device
1 indicates a series B device
OSMajRev UINT OS Major Revision.

OSMinRev UINT OS Minor Revision.
ModeBehaviour BOOL Mode Behavior (TRUE: Go to RUN on power up).
FaultOverride BOOL Fault Override (TRUE: Override error on power up).

StrtUpProtect BOOL Startup Protection (TRUE: Run startup protection program on power up).
For future release.
MajErrHalted BOOL Major error halted (TRUE: Major error halted).
MajErrCode UINT Major error code.

MajErrUFR BOOL Major error during user fault routine.
For future release.
UFRPouNum UINT User fault routine program number.
MMLoadAlways BOOL Memory Module restore to controller always on power up (TRUE: Restore).
MMLoadOnError BOOL Memory Module restore to controller if power up with error (TRUE: Restore).
MMPwdMismatch BOOL Memory Module password mismatch (TRUE: Controller and Memory Module
password mismatch).
FreeRunClock UINT Free running clock that increments every 100 microseconds from 0 to 65535 and
then returns to 0. You can use the Clock, which is globally accessible, if you need
more resolution than the standard 1 millisecond timer.
Only supported for Micro830 and Micro850 controllers. Value for Micro810
controllers remains 0.
ForcesInstall BOOL Forces enabled (TRUE: Enabled).

EMINFilterMod BOOL Embedded filter modified (TRUE: Modified).
See also
SYS_INFO on page 417
TRIMPOT_READ (read Reads the trimpot value from a specific trimpot.
trimpot) Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.


controllers.

Type
TRUE - execute Trimpot read.
FALSE - there is no read operation and output Trimpot value is
invalid.
TrimPotID Input UINT The ID of the Trimpot to be read. TrimPotID is defined in Trimpot
ID definitions.
TrimPotValue Output UINT Current trimpot value.

Sts Output UINT The Trimpot read operation status.
TRIMPOT status (Sts) codes:
0x00 - Function block not enabled (no read/write
operation).
0x01 - Read/write operation success.
0x02 - Read/write operation fails due to an invalid Trimpot
ID.
0x03 - Write operation fails due to an out of range value.
TRIMPOT Function Block Diagram example

TRIMPOT Ladder Diagram example
TRIMPOT Structured Text example
See also
Trimpot ID definitions on page 421
Trimpot ID definition The following table describes the Trimpot ID definition used in the
TRIMPOT_read instruction.
Output selection Bit Description
Trimpot ID definition 15 - 13 Module type of trimpot:

0x00 - Embedded.
0x01 - Expansion.
0x02 - Plug-in Port.

Output selection Bit Description
12 - 8 Slot ID of the module:

0x00 - Embedded.
0x01-0x1F - ID of Expansion Module.
0x01-0x05 - ID of Plug-in Port.
7-4 Trimpot type:

0x00 - Reserved.
0x01 - Digital Trimpot Type 1 (LCD Module 1).
0x02 - Mechanical Trimpot Module 1.
3-0 Trimpot ID inside the module:
0x00-0x0F - Embedded.
0x00-0x07 - ID of Trimpot for Expansion.
0x00-0x07 - ID of Trimpot for Plug-in Port.
The trimpot ID starts from 0.
See also
TRIMPOT_READ on page 419

Chapter 16
Interrupt instructions
Use Interrupt instructions to signal the processor that an event needs attention.
Usually the interrupt signal is used for high-priority conditions that require
interruption of the current code the processor is executing.
STIS on page 423 Starts the selected timed user interrupt (STI ) timer from the control program rather than
starting automatically.
UIC on page 425 Clears the lost bit for the selected user interrupt.
UID on page 427 Disables a specific user interrupt.
UIE on page 429 Enables a specific user input.

UIF on page 430 Flushes or removes a pending user input.
See also
STIS (select timed start) Starts the selectable timed user interrupt (STI ) timer from the control program
rather than starting automatically.

Text.

controllers.

Chapter 16 Interrupt instructions

Type
TRUE - start the STI timer from the control program.
FALSE - do not perform function.
IRQType Input UDINT Use the STI defined words.
- IRQ_STI0
- IRQ_STI1
- IRQ_STI2
- IRQ_STI3
SetPoint Input UINT The amount of time (in ms) which must expire prior to
executing the selectable timed interrupt.
A value of 0 disables the STIS function.
A value between 1 and 65535 enables the STIS function.
STIS Output BOOL Rung status (same as Enable).
STIS Function Block Diagram example
STIS Ladder Diagram example

Interrupt instructions Chapter 16
STIS Structured Text example
TESTOUTPUT := STIS(TESTENABLE, 2, 1000) ;
Results
See also
Interrupt instructions on page 423
UIC (clear interrupt lost bit) Clears the lost bit for the selected user interrupt(s).

Text.

controllers.


TRUE - start clear bit operation.
IRQType Input UDINT Use the STI - IRQ_HSC3
defined words. - IRQ_HSC4
- IRQ_EII0 - IRQ_HSC5
- IRQ_EII1 - IRQ_STI0
- IRQ_EII5 - IRQ_UFR
- IRQ_EII6 - IRQ_UPM0
- IRQ_HSC0 - IRQ_UPM2
UIC Output BOOL Rung status (same as Enable).
UIC Function Block Diagram example
UIC Ladder Diagram example
UIC Structure Text example

Results
See also
UID (disable interrupt) Disables a specific user interrupt(s).

Text.

controllers.

TRUE - start the disable operation.
IRQType Input UDINT Use the STI defined words. - IRQ_HSC3
- IRQ_UPM4
UID Output BOOL Rung status (same as Enable).

UID Function Block Diagram example
UID Ladder Diagram example
UID Structured Text example
TESTOUTPUT := UID(TESTENABLE, 2) ;
Results

See also
Enables a specific user interrupt.

UIE (enable interrupt)
Text.

controllers.

TRUE - start enable operation.
- IRQ_UPM4
UIE Output BOOL Rung status (same as Enable).
UIE Function Block Diagram example

UIE Ladder Diagram example
UIE Structured Text example
TESTOUTPUT := UIE(TESTENABLE, 2) ;
Results
See also
UIF (flush pending Flushes or removes a pending user interrupt.
interrupt) Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.


controllers.

TRUE - start UIF operation.
- IRQ_UPM4
UIF Output BOOL Rung status (same as Enable).
UIF Function Block Diagram example
UIF Ladder Diagram example

UIF Structured Text example
TESTOUTPUT := UIF(TESTENABLE, 2) ;
Results
See also

Chapter 17
Motion control instructions
Use the motion control instructions to program and design the motion of a
particular axis. Motion control requires Connected Components Workbench 2.0
or higher.
Tips: Administrative instructions support both PTO motion and Feedback motion.
The motion control instructions that support an FBAxis are: MC_ReadActualPosition and
MC_ReadActualVelocity.
Administrative
MC_AbortTrigger on page 445 Aborts Motion function blocks that are connected to trigger events.
MC_Power on page 470 Control the power stage, ON or OFF.
MC_ReadAxisError on page 484 Reads the axis errors not related to the Motion control instruction blocks.
MC_ReadBoolParameter on page 489 Returns the value of a vendor specific parameter of type BOOL.
MC_ReadParameter on page 493 Returns the value of a vendor specific parameter of type Real.
MC_ReadStatus on page 495 Returns the status of the axis with respect to the motion currently in
progress.
MC_Reset on page 501 Transitions the axis state from ErrorStop to StandStill by resetting all
internal axis-related errors.
MC_SetPosition on page 503 Shifts the coordinate system of an axis by manipulating the actual position.
MC_TouchProbe on page 510 Records an axis position at a trigger event.

MC_WriteBoolParameter on page 514 Modifies the value of a vendor specific parameter of type BOOL.
MC_WriteParameter on page 518 Modifies the value of a vendor specific parameter of type REAL.
Motion
MC_Halt on page 448 Commands a controlled motion stop under normal operating conditions.
MC_Home on page 452 Commands the axis to perform the <search home> sequence.
MC_MoveAbsolute on page 456 Commands a controlled motion to a specified absolute position.
MC_MoveRelative on page 461 Commands a controlled motion of a specified distance relative to the actual
position at the time of the execution.
MC_MoveVelocity on page 466 Commands a never ending controlled motion at a specified velocity.
MC_ReadActualPosition on page 474 Returns the actual position of the feedback axis.
Requires Connected Components Workbench 8 or higher.
MC_ReadActualVelocity on page 479 Returns the actual velocity of the feedback axis.
Requires Connected Components Workbench 8 or higher.

Chapter 17 Motion control instructions
MC_Stop on page 507 Commands a controlled motion stop and transfers the axis state to
Stopping.
See also
General rules for motion The general rules for the Micro800 motion control function blocks follow the
PLC open Motion control specifications. The following table provides general
control function blocks rules about the interface of motion control function blocks.
Rule applies to Rule
Input parameters With Execute: The parameters are used with the rising edge of the execute input. To
modify any parameter, change the input parameter(s) and trigger the motion again.
If an instance of a function block receives a new Execute before it finishes (as a series
of commands on the same instance), the new Execute is ignored, and the previously
issued instruction continues with its execution.
With Enable: The parameters are used with the rising edge of the enable input and
can be modified continuously.
Missing input parameters Missing input is captured during User Application compilation. There is no missing
input error handling at the controller level.
Inputs exceeding application If a function block is commanded with parameters that result in a violation of
limits application limits, the instance of the function block generates an error. In this case,
the Error output is flagged On, and error information is indicated by the output
ErrorID. The controller, in most cases, remains in Run mode, and there is no Motion
Error reported as a major controller fault.
Sign rules for inputs The Acceleration, Deceleration, and Jerk inputs are always positive values. Velocity,
Position and Distance inputs can have positive and negative values.
Position versus Distance Position is a value defined within a coordinate system. Distance is a relative measure
related to technical units. Distance is the difference between two positions.
Position/Distance input Only linear motion is supported on Micro800 controllers. For MC_MoveAbsolute
function block, the position input is the absolute location to be commanded to the
axis. For MC_MoveRelative, the distance input is the relative location (considering
current axis position is 0) from current position.
Velocity input Velocity can be a signed value, but it can also use Direction input to define the sign of
the velocity (negative velocity x negative direction = positive velocity). The E
parameter "Direction" refers to the velocity input and output for compatibility
reasons.
Direction input For distance (position) motion, with the target position (either absolute, or relative)
defined, the motion direction is unique. The direction input for distance move is
ignored.
For velocity motion, direction input value can be 1 (positive direction), 0 (current
direction) or -1 (negative direction). For any other value, only the sign is considered.
For example, -3 denotes negative direction, +2 denotes positive direction, and so on.
For velocity move (MC_MoveVelocity), the sign (velocity x direction) determines the
actual motion direction if the value is not 0. For example, if velocity x direction =
+300, then direction is positive.

Motion control instructions Chapter 17
Acceleration, Deceleration Deceleration or Acceleration inputs should have a positive value. If Deceleration or
and Jerk inputs Acceleration is set to a non-positive value, the function block reports an error
(Error ID: MC_FB_ERR_RANGE).
Jerk input should have a non-negative value. If Jerk is set to a negative value, the
function block reports an error (Error ID: MC_FB_ERR_RANGE).
If Maximum Jerk is set to zero, all jerk parameters for the motion control function
block, including jerk setting for MC_Stop have to be set to zero. If they are not, the
function block reports an error (Error ID: MC_FB_ERR_RANGE).
If Jerk is set to a non-zero value, S-Curve profile is generated; if Jerk is set to 0,
trapezoidal profile is generated.
Home Jerk configuration is not limited to Max Jerk configuration.
If the motion engine fails to generate the motion profile prescribed by the
dynamic input parameters, the function block reports an error (Error ID:
MC_FB_ERR_PROFILE).
Output exclusivity With Execute: When Execute is TRUE, one of the Busy, Done, Error, or
CommandAborted outputs must also be TRUE. The outputs are mutually exclusive:
only one output on one function block can be TRUE.
Only one of the outputs Active, Error, Done and CommandAborted is set at one time.
With Enable: The Valid and Error outputs are mutually exclusive: only one output on
one function block can be TRUE.
Output status With Execute: The Done, Error, ErrorID and CommandAborted outputs are reset with
the falling edge of Execute instruction. However, the falling edge of Execute does not
stop or influence the execution of the actual function block. Even if Execute is reset
before the function block completes, the corresponding outputs are set for at least
one cycle.
If an instance of a function block receives a new Execute command before it completes
(as a series of commands on the same instance), the new Execute command is
ignored, and the previously issued instruction continues with execution.
With Enable: Valid, Enabled, Busy, Error, and ErrorID outputs are reset with the
falling edge of Enable as soon as possible.
Behavior of Done output The Done output is set when the commanded action has successfully completed.
When multiple function blocks are working on the same axis in a sequence, the
following applies:
When one movement on an axis is interrupted with another movement on the
same axis without having reached the final goal, Done on the first function block
will not be set.
Behavior of Busy output Every function block can have a Busy output, indicating the function block is not
finished (for function blocks with an Execute input) or is not working and new output
values can be expected (in case of Enable input).
Busy is set at the rising edge of Execute and reset when one of the outputs Done,
Aborted, or Error is set. The function block should be kept in the active loop of the
application program for at least as long as Busy is TRUE because the outputs may
change.
Function blocks with the same instance that are busy cannot execute until it is no
longer busy. Function blocks with different instances can abort the currently
executing function block.
Behavior of The CommandAborted output is set when a commanded motion is interrupted by
CommandAborted another motion command.
output The reset behavior of CommandAborted output is similar to Done output. When
CommandAborted occurs, other output signals such as InVelocity are reset.

Output Active The Active output is required on buffered function blocks, and is set at the moment
the function block takes control of the motion of the according axis.
For unbuffered mode, the Active and Busy outputs can have the same value.
Enable and Valid status The Enable input is coupled to a Valid output. Enable is level sensitive, and Valid
shows that a valid set of outputs is available at the function block.
The Valid output is TRUE as long as a valid output value is available and the Enable
input is TRUE. The relevant output value can be refreshed as long as the input Enable
is TRUE.
If there is a function block error, the output is not valid (Valid set to FALSE). When the
error condition disappears, the values reappear and Valid output is set again.
Output error handling Outputs used to define errors
All blocks have the following two outputs that are used for errors that occur during
execution:
Error Rising edge of "Error" informs that an error occurred during the execution
of the function block.
ErrorID Error number.
Done and InVelocity outputs are used for successful completion so they are logically
exclusive to Error.
Instance errors do not always result in an axis error (bringing the axis to ErrorStop).
How the error outputs are reset
Error outputs of the relevant function blocks are reset with the falling edge of
Execute and Enable.
The error outputs of a function block with Enable can be reset during operation
without having to reset Enable.
Types of errors
Function blocks logics (for example, parameters out of range, state machine
violation attempted, and so on)
HW Limit or SW Limit
Mechanism/Motor
Drive
Naming conventions ENUM Due to the naming constraints in the IEC standard on the uniqueness of variable
types names, the 'mc' reference to the PLCopen Motion Control namespace is used for the
ENUMs.
In this way we avoid the conflict that using the ENUM types 'positive' and 'negative'
for instance with variables with these names throughout the rest of the project since
they are called mcPositive and mcNegative respectively.
See also
Motion control instructions on page 433
Motion control function The following topics provide details for motion control parameters that are
relevant to all motion control function blocks.
block parameter details
Motion control axis states on page 437
Motion control function block parameter numbers on page 439

Motion control function block error IDs on page 441
Axis error scenarios on page 442
AXIS_REF data type on page 443
Axis variables on page 445
Motion control axis states The basic rule for the behavior of the axis at a high level when multiple motion
control function blocks are activated is that motion commands are always taken
sequentially, even if the controller has the capability of real parallel processing.
Any motion command is a transition that changes the state of the axis and, as a
consequence, modifies the way the current motion is computed.
Motion control axis state diagram
The axis is always in one of the defined states as shown in the following diagram.
Motion control axis state behavior
No Note
1 In the ErrorStop and Stopping states, all function blocks (except MC_Reset), can be called although they will not
be executed.
MC_Reset generates a transition to the Standstill state. If an error occurs while the state machine is in the
Stopping state, a transition to the ErrorStop state is generated.
2 Power.Enable = TRUE and there is an error in the axis.

No Note
3 Power.Enable = TRUE and there is no error in the axis
4 MC_Stop.Done AND NOT MC_Stop.Execute.
5 When MC_Power is called with Enable = False, the axis goes to the Disabled state for every state including
ErrorStop.
6 If an error occurs while the state machine is in Stopping state, a transition to the ErrorStop state is generated.
Motion control axis state code values
You can monitor the axis state using the Axis Monitor feature. The following table
identifies the values used to define each of the predefined axis states.
State value State name

0x00 Disabled
0x01 Standstill
0x02 Discrete Motion
0x03 Continuous Motion
0x04 Homing
0x06 Stopping
0x07 Error Stop
Axis state updates
On motion execution, the axis state update is dependent on when the relevant
motion function block is called by the POU scan. This is the case even though the
motion profile is controlled by the Motion Engine as a background task, and is
independent from the POU scan.

For example, on a moving axis on a Ladder POU (state of a rung=true), an

MC_MoveRelative function block in the rung is scanned and the axis starts to
move. Before MC_MoveRelative completes, the state of the rung becomes False,
and MC_MoveRelative is no longer scanned. In this case, the state of the axis
cannot switch from Discrete Motion to StandStill, even after the axis fully stops,
and the velocity comes to 0.
See also
Motion control function block parameter details on page 436
Motion control function block The following function blocks use specific parameter numbers when the function
blocks are programmed.
parameter numbers
MC_ReadParameter
MC_ReadBoolParameter
MC_WriteParameter
MC_WriteBoolParameter
Parameter number identification
Parameter numbers between 0 and 999 are reserved for standard parameters.
Extensions by a supplier or user are also allowed, although using them can affect
portability between different platforms. If the parameter number is greater than
999, the parameter is supplier-specific.

Parameter Parameter Name Data R/W Description

number type
1 Commanded Position REAL R Commanded position.
2 SWLimitPos REAL R/W Positive software limit switch position.
3 SWLimitNeg REAL R/W Negative software limit switch position.

4 EnableLimitPos BOOL R/W Enable positive software limit switch.
5 EnableLimitNeg BOOL R/W Enable negative software limit switch.
8 MaxVelocitySystem REAL R Maximal allowed velocity of the axis in the motion
system.
9 MaxVelocityAppl REAL R/W Maximal allowed velocity of the axis in the
application.
11 CommandedVelocity REAL R Commanded velocity.
12 MaxAccelerationSystem REAL R Maximal allowed acceleration of the axis in the
motion system.
13 MaxAccelerationAppl REAL R/W Maximal allowed acceleration of the axis in the
application.
14 MaxDecelerationSystem REAL R Maximal allowed deceleration of the axis in the
system.
15 MaxDecelerationAppl REAL R/W Maximal allowed deceleration of the axis in the
application.
16 MaxJerk REAL R/W Maximal allowed jerk of the axis.
1001 TargetPosition REAL R The final target position for current active moving
function block
1002 TargetVelocity1 REAL R The final target velocity for current active moving
function block.
1005 Duty Cycle REAL R/W The pulse duty cycle for one pulse. The valid value is 0
100, indicating 0% - 100%. (PWM function can be
realized by adjusting this value).
This parameter is configurable only using this
Function Block. The default value is set 50.0 by the
controller.
Note: For Duty Cycle, the value will be overwritten
by the default setting, 50.0 when the controller is
switched from RUN mode to PRG and RUN again, or
when the controller power is cycled.
1006 PulsePerRevolution REAL R The Pulse per Revolution setting input by user in CCW
GUI.
1007 TravelPerRevolution REAL R The Travel per Revolution setting input by user in
CCW GUI.
See also
General rules for motion control function blocks on page 434

Motion control function block When a motion control function block ends with an error and the axis state is
ErrorStop, use MC_Reset function block or MC_Power Off/On and MC_Reset
error IDs
to recover the axis. The axis can be reset to normal motion operation without
stopping the controller operation.
Use this table to help determine the errors for the motion control function blocks.
Value MACRO ID Description
00 MC_FB_ERR_ The function block execution is successful.

NO
01 MC_FB_ERR_ The function block cannot execute because the axis is not in the correct state. Check
WRONG_STATE the axis state.
02 MC_FB_ERR_ The function block cannot execute because there is invalid axis dynamic parameter(s)
RANGE (velocity, acceleration, deceleration, or jerk) set in the function block.
Correct the setting for the dynamic parameters in the function block against Axis
Dynamics configuration page.
03 MC_FB_ERR_ The function block cannot execute because there is invalid parameter other than
PARAM velocity, acceleration, deceleration, or jerk, set in the function block.
Correct the setting for the parameters (for example, mode or position) for the
function block.
04 MC_FB_ERR_ The function block cannot execute because the axis does not exist, the axis
AXISNUM configuration data is corrupted, or the axis is not correctly configured.
05 MC_FB_ERR_ The function block cannot execute because this axis gets a fault due to drive or
MECHAN mechanical issues. Check the connection between the drive and the controller (Drive
Ready and In-Position signals), and ensure the drive is operating normally.
06 MC_FB_ERR_ The function block cannot execute because the axis is not powered on.
NOPOWER Power on the axis using MC_Power function block.
07 MC_FB_ERR_ The function block cannot execute because the resource required by the function
RESOURCE block is controlled by some other function block or it is not available.
Ensure the resource required by the function block is available for use.
Examples:
MC_Power try to control the same axis.
MC_Stop are executed against the same axis at the same time.
MC_TouchProbe are executed against the same axis at the same time.)
MC_TouchProbe is executed, while touch probe input is not enabled in Motion
Configuration.
08 MC_FB_ERR_ The function block cannot execute because the motion profile defined in the function
PROFILE block cannot be achieved.
Correct the profile in the function block.

09 MC_FB_ERR_ The function block cannot execute because the motion profile requested in the
VELOCITY function block cannot be achieved due to current axis velocity.
Examples:
The function block requests the axis to reverse the direction while the axis is
moving.
The required motion profile cannot be achieved due to current velocity too low or
too high.
Check the motion profile setting in the function block, and correct the profile, or
re-execute the function block when the axis velocity is compatible with the requested
motion profile.
0A MC_FB_ERR_ This function block cannot execute as it will end up moving beyond the Soft Limit, or
SOFT_LIMIT the function block is aborted as the Soft Limit has been reached.
Check the velocity or target position settings in the function block, or adjust Soft
Limit setting.
0B MC_FB_ERR_ This function block is aborted as the Hard Limit switch active state has been detected
HARD_LIMIT during axis movement, or aborted as the Hard Limit switch active state has been
detected before axis movement starts.
Move the axis away from the Hard Limit switch in the opposite direction.
0C MC_FB_ERR_ This function block cannot execute as it will end up moving beyond the PTO
LOG_LIMIT Accumulator logic limit, or the function block is aborted as the PTO Accumulator logic
limit has been reached.
Check the velocity or target position settings for the function block. Or use
MC_SetPosition function block to adjust the axis coordinate system.
0D MC_FB_ERR_ A motion engine execution error is detected during the execution of this function
ERR_ENGINE block.
Power cycle the whole motion setup, including controller, drives and actuators, and
re-download the User Application. If the fault persists, call Tech support.
10 MC_FB_ERR_ The function block cannot execute because the axis need to be homed first.
NOT_HOMED Execute homing against the axis using MC_Home function block.
80 MC_FB_ERR_ Warning: The requested velocity for the axis has been adjusted to a lower value.
PARAM_MODIFIED The function block executes successfully at a lower velocity.
See also
Motion control axis states on page 437
Axis error scenarios In most cases, when a movement function block instruction issued to an axis
results in a function block error, the axis transitions to an Error state, and the
corresponding ErrorID element is set on the AXIS_REF data for the axis.

In the following situations, the axis may not transition to an Error state, and it is
possible for the user application to issue a successful movement function block to
the axis after the axis state changes.
Scenario Example
A movement function block instructs an axis, but the axis is in a state The axis has no power, or the axis is in a Homing
in which the function block cannot be executed properly. sequence, or in an Error Stop state.
A movement function block instructs an axis, but the axis is still The new function block commands the axis to
controlled by another movement function block. The axis cannot allow change motion direction.
the motion to be controlled by the new function block without going
to a full stop.
When one movement function block tries to control an axis, but the User Application issues an S-Curve
axis is still controlled by another movement function block, and the MC_MoveAbsolute function block to an axis
newly-defined motion profile cannot be realized by the controller. with too short a distance given when the axis is
moving.
See also
AXIS_REF data type The AXIS_REF data type is a data structure that contains information for a
motion axis and is used as an input and output variable in all motion control
function blocks. An instance of an AXIS_REF data type is automatically created
when you add a motion axis to the configuration.
Axis_ID AXIS_REF The logic axis ID automatically assigned by Connected Components Workbench. It
cannot be edited or viewed by user.
Error Flag BOOL Indicates whether an error is present in the axis.

Once an axis is flagged with an error, and the error ID is not zero, the axis must be reset
using MC_Reset before issuing any other movement function block.
AxisHomed BOOL Indicates whether homing operation is successfully executed for the axis or not.
When the user tries to redo homing for an axis with AxisHomed already set (homing
performed successfully), and the result is not successful, the AxisHomed status is
cleared.
ConstVel BOOL Indicates whether the axis is in Constant Velocity movement or not. Stationary axis is
not considered in Constant Velocity.
AccFlag BOOL Indicates whether the axis is in an Accelerating movement or not.

DecelFlag BOOL Indicates whether the axis is in an Decelerating movement or not.
AxisState USINT Indicates the current state of the axis.
ErrorID UINT Indicates the cause for axis error when error is indicated by ErrorFlag. This error usually
results from motion control function block execution failure.
ExtraData UINT Reserved.

TargetPos REAL Indicates the final target position of the axis for MoveAbsolute and MoveRelative
function blocks.
For MoveVelocity, Stop, and Halt function blocks, TargetPos is 0 except when the
TargetPos set by previous position function blocks is not cleared.

CommandPos REAL During motion, this is the current position the controller commands the axis to take.
There may be a slight delay between the axis actual position and this CommandPos.
TargetVel REAL The maximum target velocity instructed to the axis for a moving function block. The
value of TargetVel in current function block, or smaller than it, depending on the other
parameters in the same function block.
CommandVel REAL During motion, this element indicates the current velocity the controller instructs the
axis to use.
Note that there may be a slight difference between the axis actual velocity and
CommandVel, due to the drive delay or drive adjustment overshoot.
See also
FB_AXIS_REF data type The FB_AXIS_REF data type is a data structure that contains information for a
Motion Feedback Axis. It is used as an input and output variable in motion
control function blocks. An instance of an FB_AXIS_REF data type is
automatically created when you add a HSC module and the mode is configured as
Feedback Axis mode.
Important: Once a Feedback Axis is flagged with an error, and the error ID is not zero, the FBAxis must be reset using
MC_Reset before issuing any other movement function block.
Axis_ID FB_AXIS_REF The logic axis ID automatically assigned by Connected Components Workbench. It
cannot be edited or viewed by user.
ErrorFlag BOOL Indicates whether an error is present in the Feedback Axis.

ConstVel BOOL Indicates whether the Feedback Axis is in Constant Velocity movement or not.
Stationary axis is not considered in Constant Velocity.
AccelFlag BOOL Indicates whether the Feedback Axis is in an Accelerating movement or not.
DecelFlag BOOL Indicates whether the Feedback Axis is in an Decelerating movement or not.
AxisState USINT Indicates the current state of the Feedback Axis.
ErrorID UINT Indicates the cause for axis error when error is indicated by ErrorFlag. This error
usually results from motion control function block execution failure.
ExtraData UINT Reserved.
ActualPos REAL Actual mechanical position read back from Motion feedback channel (HSC).
ActualVel REAL Actual mechanical velocity read back from Motion feedback channel (HSC).
See also

Axis variables Axis variables are used to control position, speed, acceleration, and error for a
given motion control axis.
To assign a variable to an Axis output parameter:
In a Function Block Diagram

Graphically connect the Axis output parameter of a motion control
function block to the AxisIn input parameter of another motion
control function block for convenience. For example, connect
MC_POWER Axis output parameter to MC_HOME AxisIn input
parameter.
In a Ladder Diagram
A variable can not be assigned to the Axis output parameter of a
motion control function block because it is read-only.
Monitor an AXIS_REF variable
Monitor an AXIS_REF or a FBAXIS_REF variable in the software while

connected to the controller, when the motion engine is active, or in the user
application as part of user logic. You can also monitor the AXIS_REF or
FBAXIS_REF variable remotely through various communication channels.
See also
MC_AbortTrigger (motion Aborts Motion function blocks that are connected to trigger events.
control abort trigger) MC_AbortTrigger only executes when assigned to an axis that is controlled by
MC_TouchProbe.

Text.

This instruction applies to Micro830 and Micro850 controllers that support

motion control.

EN Input BOOL Instruction block enable.
TRUE - execute current MC_AbortTrigger computation.
AxisIn Input AXIS_REF Use the AXIS_REF data type to define the AxisIn parameter.
FB_AXIS_REF If the axis is a FB_Axis (feedback axis), use the FB_AXIS_REF data
type to define AxisIn parameters.
TriggerInp Input USINT This parameter is ignored.
Execute Input BOOL When TRUE, aborts the trigger event at the rising edge.

Axis Output AXIS_REF Axis output is read-only in Ladder Diagram programs.
TriggerInput Output USINT This parameter is ignored.
Done Output BOOL TRUE - the trigger event is aborted.
Busy Output BOOL TRUE - the function block is not finished.
Error Output BOOL TRUE - an error is detected.
instruction are defined in Motion control function block error IDs.

MC_AbortTrigger Function Block Diagram example
MC_AbortTrigger Ladder Diagram example
MC_AbortTrigger Structured Text example

Results
See also
FB_AXIS_REF data type on page 444
MC_Halt (motion control Commands a controlled motion stop under normal operating conditions.
halt) Operating details;
The axis state changes to DiscreteMotion, until velocity is zero. When

velocity reaches zero, Done is set to True and the axis state changes to
StandStill.
It is possible to execute another motion command during deceleration
of the axis, which aborts MC_Halt.
If MC_Halt is issued when the axis state is Homing, the instruction
block reports an error, and the homing process is not interrupted.

Text.


motion control.
Parameter Parameter Data Description

type type

TRUE - execute current MC_Halt computation.
AxisIn Input AXIS_RE Use the AXIS_REF data type parameters to define AxisIn.
F
Execute Input BOOL Indicates when to start motion.
TRUE - start the motion at rising edge.
FALSE - do not start motion.
Executing MC_Halt during homing, MC_Halt is set to MC_FB_ERR_STATE
and the homing process continues.
Deceleration Input REAL Value of the deceleration (always positive) (decreasing energy of the
motor).
If Deceleration <= 0 and the axis state is not Standstill, MC_Halt is set to
MC_FB_ERR_RANGE.
Jerk Input REAL Value of the Jerk (always positive).
If Jerk < 0 and the axis state is Standstill, MC_Halt is set to
MC_FB_ERR_RANGE.
BufferMode Input SINT Not used. The mode is always MC_Aborting.
Axis Output AXIS_RE Axis output is read-only in Ladder Diagram programs.
F
Done Output BOOL Zero velocity reached.
Busy Output BOOL The instruction block is not finished.
Active Output BOOL Indicates that the instruction block has control on the axis.


type type
CommandAborte Output BOOL Command is aborted by another command, or error stop.

d
FALSE - No error.
ErrorID Output UINT A unique numeric that identifies the error. The errors for this instruction
are defined in Motion control function block error IDs.
MC_Halt Function Block Diagram example

MC_Halt Ladder Diagram example
MC_Halt Structured Text example

Results
See also
MC_Home (motion control Commands the axis to perform the <search home> sequence. The details of this
sequence are manufacturer dependent and can be set by the axis parameters. The
home) Position input is used to set the absolute position when a reference signal is
detected, and the configured Home offset is reached.
Operation details:
After MC_Power is issued, the axis Homed status is reset to 0 (not homed).
In most cases, after the axis is powered on, the MC_Home function block
needs to be executed to calibrate the axis position and the Home reference.
The MC_Home function block can only be aborted using a MC_Stop or a
MC_Power function block. If it is aborted before it completes, the
previously searched Home position is considered invalid and the axis
Homed status is cleared.

Text.


motion control.

type
TRUE - execute current MC_Home computation.
AxisIn Input AXIS_REF Use the AXIS_REF data type parameters to define AxisIn.
Position Input REAL Absolute position is set when the reference signal is detected and
configured Home offset is reached.
The value range for this input is -0x40000000 0x40000000 physical
pulse after the position is converted from user position unit to PTO
pulse. Set the Position value within the Soft Limit.
An invalid input value results in an error.
Error ID = MC_FB_ERR_PARAM.
HomingMode Input SINT Enum input for Homing mode.
BufferMode Input SINT Not used. The mode is always mcAborting.
Done Output BOOL TRUE - the Homing operation completed successfully and the axis
state is set to StandStill.
FALSE - Homing operation is ongoing or incomplete.
Busy Output BOOL TRUE - the instruction block is not finished.
FALSE - the instruction block is finished.


type
Active Output BOOL TRUE - indicates that the instruction block has control on the axis.
CommandAborted Output BOOL TRUE - command was aborted by another command, or error stop.
FALSE - No error.
ErrorID Output UNIT A unique numeric that identifies the error. The errors for this
HomingModes
Use this table to help determine the values for the HomingMode parameter in the
MC_Home motion control instruction.
Value Name Description

0x00 MC_HOME_ABS_SWITCH Homing process by searching Home Absolute switch
0x01 MC_HOME_LIMIT_SWITCH Homing process by searching limit switch
0x02 MC_HOME_REF_WITH_ABS Homing process by searching Home Absolute switch plus using
encoder reference pulse
0x03 MC_HOME_REF_PULSE Homing process by searching limit switch plus using encoder
reference pulse
0x04 MC_HOME_DIRECT Static homing process with direct forcing a home position from user
reference. The function block will set current position the
mechanism is in as home position, with its position determined by
the input parameter, "Position"
MC_Home Function Block Diagram example

MC_Home Ladder Diagram example
MC_Home Structured Text example

Results
See also
MC_MoveAbsolute (motion Commands a controlled motion to a specified absolute position.
control move absolute) Operation details:
For the Micro800 controller,

The sign of the input Velocity for a MC_MoveAbsolute function block

is ignored because the motion direction is determined by the Current
position and the Target position.
The input Direction for a MC_MoveAbsolute function block is
ignored because there is only one mathematical solution to reach the
Target position.
If the MC_MoveAbsolute function block is issued when the Micro800
controller axis state is StandStill and the relative distance to move is zero,
the execution of the function block is immediately reported as Done.
If a MC_MoveAbsolute function block is issued to an axis that is not in the
Homed, position, the function block reports an error.
The MoveAbsolute function block completes with Velocity zero if it is not
aborted by another function block.

Text.

motion control.

Parameter Paramet Data Description

er type type
TRUE - execute current MC_MoveAbsolute computation.
The axis should be in the home position when this execute command is
issued or an error occurs, MC_FB_ERR_NOT_HOMED.
Position Input REAL Target position for the motion in technical unit (negative or positive).
The technical unit is defined in the Motion - General configuration page
for an axis.
Velocity Input REAL Value of the maximum velocity.
The maximum velocity may not be reached when Jerk = 0.
The sign of Velocity is ignored, the motion direction is determined by the
input Position.
Acceleration Input REAL Value of the acceleration (always positive - increasing energy to the motor.)
user unit/sec2
Deceleration Input REAL Value of the deceleration (always positive - decreasing energy to the
motor).
u/sec2
Jerk Input REAL Value of the Jerk (always positive).
u/sec3
When the value of the input Jerk = 0, the Trapezoid profile is calculated by
Motion Engine. When Jerk > 0, the S-Curve profile is calculated.
Direction Input SINT This parameter is not used.

BufferMode Input SINT This parameter is not used.
Done Output BOOL When TRUE, command position reached.
When the In-Position Input is configured as Enabled for this axis, the drive
needs to set In-Position Input signal active before this Done bit goes to True.
This action completes with velocity zero unless it is aborted.
Busy Output BOOL When TRUE, the function block is not finished.
Active Output BOOL When TRUE, indicates that the function block has control of the axis
CommandAborte Output BOOL When TRUE, the Command was aborted by another command, or error stop.
d
FALSE - No error.
ErrorID Output UINT A unique numeric that identifies the error. The errors for this instruction are
defined in Motion control function block error IDs.

MC_MoveAbsolute Function Block Diagram example

MC_MoveAbsolute Ladder Diagram example
MC_MoveAbsolute Structured Text example

Results
See also
Common information for motion control instructions on page 436
Commands a controlled motion of a specified distance relative to the actual

MC_MoveRelative (motion
position at the time of the execution.
control move relative)
Operation details:
Because the motion direction for MC_MoveRelative is determined by the

current position and the target position, the sign of the Velocity is ignored.
MoveRelative completes with Velocity zero if it is not aborted by another
function block.
If MC_MoveRelative is issued when the Micro800 controller axis state is
StandStill and the relative distance to move is zero, the execution of the
function block is immediately reported as Done.
For a Micro800 controller, the sign of the input Velocity for
MC_MoveRelative is ignored because the motion direction is determined
by the Current position and the Target position.

Text.


motion control.
MC_MoveRelative operation

type
TRUE - execute current MC_MoveRelative computation.
Distance Input REAL Relative distance for the motion (in technical unit [u]).
Velocity Input REAL Value of the maximum velocity (not necessarily reached) [u/s]. As the
motion direction is determined by input Position, the sign of Velocity is
ignored by the function block.
The maximum velocity may not be reached when Jerk = 0.
Acceleration Input REAL Value of the acceleration (increasing energy of the motor) [u/s2]
Deceleration Input REAL Value of the deceleration (decreasing energy of the motor) [u/s2]
Jerk Input REAL Value of the Jerk [u/s3]


type
Done Output BOOL TRUE - commanded distance reached.
When the In-Position input is enabled for an axis, the In-Position signal
must be set to active before Done = True.

Active Output BOOL TRUE - indicates that the instruction block has control on the axis.
CommandAborted Output BOOL TRUE - command aborted by another command, or Error Stop.
FALSE - No error.
MC_MoveRelative Function Block Diagram example

MC_MoveRelative Ladder Diagram example
MC_MoveRelative Structured Text example

Results
See also

MC_MoveVelocity (motion Commands a never ending controlled motion at a specified velocity.
control move velocity) Operation details:
If the DirectionIn input for MC_MoveVelocity is equal to 0 and:

the axis is in a moving state, the sign of the Velocity input is ignored,
the axis continues to move in its current direction, and new dynamic
parameters are applied.
the axis is not in a moving state, MC_MoveRelative reports an error.
If the PTO Pulse limit is reached during execution of MC_MoveVelocity,
the PTO Accumulator value is rolled over to 0 (or to the opposite Soft
Limit if the limit is activated) and execution continues.
If the axis is in a moving state, and MC_MoveVelocity issues a motion in
which the direction (the sign of Velocity * Direction) is the opposite of the
current motion direction, the MC_MoveVelocity reports an error.
Once the signal 'InVelocity' is set, it indicates MC_MoveVelocity is
complete. Any subsequent motion event has no effect on the
MC_MoveVelocity outputs except the signal 'InVelocity'.
The InVelocity output of MC_MoveVelocity stays True once the Velocity
of the axis reaches the commanded Velocity or until MC_MoveVelocity is
aborted.
The sign of (Velocity * Direction) determines the motion direction for
MC_MoveVelocity. If the Velocity sign and the Direction sign are the same,
positive motion is issued. If the Velocity sign and the Direction sign are
different, negative motion is issued.
The signal 'InVelocity' is reset when MC_MoveVelocity is aborted by
another function block or Motion event, or at the falling edge of 'Execute'.
To stop or change the motion initiated by MC_MoveVelocity, the
instruction block must be interrupted or aborted by another instruction
block, which includes executing MC_MoveVelocity again with different
parameters.
If MC_MoveVelocity is issued with the axis state in StandStill (not
controlled by another function block) and a function block error occurs, the
axis state goes to ErrorStop.


Text.

motion control.

type
TRUE - execute current MC_MoveVelocity computation.
Velocity Input REAL Value of the maximum velocity [u/s].
Acceleration Input REAL Value of the acceleration (increasing energy of the motor) [u/s2]
Deceleration Input REAL Value of the deceleration (decreasing energy of the motor) [u/s2]
Jerk Input REAL Value of the Jerk [u/s3]
DirectionIn Input SINT The valid values are: -1, 0, 1.
InVelocity Output BOOL TRUE - commanded velocity was reached (first time).


type
Active Output BOOL TRUE - indicates the function block has control on the axis.
Direction Output SINT The valid values are: -1, 0, 1.
CommandAborted Output BOOL TRUE - command aborted by another command, or Error Stop.
FALSE - No error.
MC_MoveVelocity Function Block Diagram example

MC_MoveVelocity Ladder Diagram example
MC_MoveVelocity Structured Text example

Results
See also
Controls the power stage, ON or OFF.

MC_Power (motion control
power) Operation details:
If you import a project created in CCW 7 into CCW 8, the Mc_Power new
input parameter, __DTI_AxisIn shows. If a Build error occurs, reselect the
instruction and rebuild.
After axis power On completes, the axis Homed status is reset to 0 (not
homed).

The Enable_Positive input and the Enable_Negative input for MC_Power

are both level triggered and are checked when the Enable input changes
from OFF to ON. The on-the-fly change for the Enable_Positive input and
the Enable_Negative input without Enable input toggling is not checked.
If power fails during operation (when Servo ready has been detected) the
axis state changes to ErrorStop.
The MC_Power instruction has a time out value of 2 minutes. MC_Power
returns an error when the time out period expires and Drive Ready Input is
FALSE.
If an MC_Power function block with Enable set to True is called while the
axis state is Disabled, the axis state changes to StandStill unless an error is
detected, in which case the axis state changes to ErrorStop.
Only one MC_Power function block should be issued per axis. If a different
MC_ Power function block is used to control the same axis simultaneously,
it is rejected by the Motion Engine.
When there is a Power On or Off state switch for an axis, the absolute axis
position is not reset.
If an MC_Power function block with Enable set to False is called, the axis
state changes to Disabled for every state including ErrorStop.
The MC_Power function block can power on the axis if Enable is set to
True and power off the axis if Enable is set to False.

Text.

motion control.

Parameter Paramete Data type Description

r type
TRUE - execute current MC_Power computation.
FB_AXIS_REF For an FB_Axis (feedback axis), use the FB_AXIS_REF data type to
define AxisIn.
Enable Input BOOL TRUE - power is ON.
FALSE - power is OFF
Enable_Positive Input BOOL TRUE - motion is allowed in the positive direction.
Enable_Negative Input BOOL TRUE - motion is allowed in the negative direction.
AXIS_REF data type.
Status Output BOOL State of the power stage:
TRUE - drive power on is done.
FALSE - drive power on is not done.
FALSE - No error.
MC_Power Function Block Diagram example

MC_Power Ladder Diagram example
MC_Power Structured Text example

Results
See also
MC_ReadActualPosition Returns the actual position of the feedback axis. MC_ReadActualPosition is only
applicable to feedback motion.
(motion control read actual
position) Operation details:
Before executing MC_ReadActualPosition, verify the axis is in one of the

following Axis States:
Disabled
Standstill
Discrete Motion
Error Stop
The actual position for a feedback axis is not reset to 0 after a download. To
reset or clear the position for a feedback axis use the MC_Home instruction
or MC_SetPosition instruction.

Text.


motion control.

type
AxisIn Input FB_AXIS_REF For an FB_Axis (feedback axis), use the FB_AXIS_REF data type
to define AxisIn.
Enable Input BOOL TRUE - get the value of the parameter continuously while
enabled.
FALSE - idle.
Axis Output FB_AXIS_REF Axis output is read-only in Ladder Diagram programs.
The Axis output parameters are defined in the FB_AXIS_REF data
type.
Valid Output BOOL TRUE - the instruction block is active and new output values are
expected.
FALSE - the instruction block is inactive.
FALSE - No error.
Position Output REAL The value of the actual absolute position for feedback motion
Axis. (in axis unit [u])

MC_ReadActualPosition Function Block Diagram example
MC_ReadActualPosition Ladder Diagram example

MC_ReadActualPosition Structured Text example

Results

See also
MC_ReadActualVelocity Returns the value of the actual velocity of the feedback axis.
(motion control read actual MC_ReadActualVelocity is only applicable to feedback motion.

velocity) Before executing MC_ReadActualVelocity, verify the axis is in one of the
following Axis States:
Standstill
Discrete Motion
Error Stop

Text.


motion control.

type
AxisIn Input FB_AXIS_REF For an FB_Axis (feedback axis), use the FB_AXIS_REF data type to
define AxisIn.
Enable Input BOOL TRUE - get the value for the actual velocity continuously.
FALSE - the data is no longer valid, all outputs are reset to 0, Valid is
set to False.
Axis Output FB_AXIS_REF Axis output is read-only in Ladder Diagram programs.
The Axis output parameters are defined in the FB_AXIS_REF data
type.
Valid Output BOOL TRUE - the function block is active and new output values are
expected.
FALSE - the function is not expecting new output values.
FALSE - the function is idle.
FALSE - No error.
ActualVelocity Output REAL The value of the actual velocity for the feedback motion axis (in axis
unit [u/s]).
ActualVelocity is a signed value, which includes direction
information.

MC_ReadActualVelocity Function Block Diagram example
MC_ReadActualVelocity Ladder Diagram example

MC_ReadActualVelocity Structured Text example

Results

See also
MC_ReadAxisError (motion Reads the axis errors not related to the Motion control instruction blocks.
control read axis error) When an axis is in a Disabled state, MC_ReadAxisError may or may not get a
non-zero Error ID for the axis because a Disabled axis can contain errors or be
error-free.

Text.


motion control.

type
TRUE - execute current MC_ReadAxisError computation.
FALSE - Error, ErrorID, and AxisErrorID are reset to False(or 0).
Applies only to LD programs.
define AxisIn.
Enable Input BOOL TRUE - get the value of the parameter continuously while enabled.
FALSE - resets Error, ErrorID, and AxisErrorID outputs to 0.
The Axis output parameters are defined in the FB_AXIS_REF data type.
Valid Output BOOL TRUE - the instruction block is active and new output values are
expected.
FALSE - the instruction block is inactive.
FALSE - No error.
AxisErrorID Output UINT A unique numeric that identifies the axis error. The errors for this
instruction are defined in AxisErrorID error codes.

MC_ReadAxisError Function Block Diagram example
MC_ReadAxisError Ladder Diagram example
MC_ReadAxisError Structured Text example

Results
See also
AxisErrorID error codes on page 487
AxisErrorID error codes The following table describes the Axis error codes identified in the AxisErrorID
for MC_ReadAxisError.
00 MC_FB_ERR_ The axis is in an operational state (nothing to display).

NO
01 MC_FB_ERR_ The axis is not operational because an incorrect axis state was detected during a
WRONG_STATE function block execution.
Reset the state of the axis using the MC_Power and MC_Reset function blocks.
02 MC_FB_ERR_ The axis is not operational because an invalid axis dynamic parameter (velocity,
RANGE acceleration, deceleration, or jerk) is set in a function block.
In the function block, correct any setting for the dynamic parameters that
conflict with the settings on the Axis Dynamics configuration page.

03 MC_FB_ERR_ The axis is not operational because an invalid parameter, (other than velocity,
PARAM acceleration, deceleration, or jerk), is set in a function block.
In the function block, correct the settings for the parameters, such as mode or
position.
04 MC_FB_ERR_ Motion internal Fault, Error ID = 0x04.

AXISNUM Contact your local Rockwell Automation technical support representative. For
contact information, see:
http://www.rockwellautomation.com/support
05 MC_FB_ERR_ The axis is not operational because a drive or mechanical issue was detected.
MECHAN Check the connection between the drive and the controller (Drive Ready and
In-Position signals), and ensure the drive is operating normally.
06 MC_FB_ERR_ The axis is not powered on.

NOPOWER Power on the axis using MC_Power function block.
Reset the state of the axis using the MC_Reset function block.
07 MC_FB_ERR_ The axis is not operational because it or its related resources required by a
RESOURCE function block are under the control of other function block, or not available.
Ensure the axis or its related resources required by the function block are
available for use.
Review and correct the application if there are multiple instances of the same
function block trying to control the axis at the same time.
08 MC_FB_ERR_ The axis is not operational because the motion profile defined in a function
PROFILE block is invalid.
Correct the profile in the function block.
09 MC_FB_ERR_ The axis is not operational because the motion profile requested in a function
VELOCITY block conflicts with the current axis velocity.
Possible causes:
The function block requests the axis to reverse the direction while the axis is
moving.
The current velocity is too low or too high for the requested motion profile.
Correct the motion profile in the function block, or re-execute the function block
when the axis velocity is compatible with the requested motion profile.
10 MC_FB_ERR_ The axis is not operational because a Soft Limit error was detected, or executing
SOFT_LIMIT the function block would cause a Soft Limit error.
Check the velocity or target position settings for the function block, or adjust
Soft Limit setting.
11 MC_FB_ERR_ The axis is not operational because a Hard Limit error was detected.
HARD_LIMIT Reset the state of the axis using the MC_Reset function block, and then move
the axis away from the Hard Limit switch in the opposite direction.

12 MC_FB_ERR_ The axis is not operational because a PTO Accumulator logic limit error was
LOG_LIMIT detected, or executing the function block would cause a PTO Accumulator logic
limit error.
Check the velocity or target position settings for the function block. Use the
MC_SetPosition function block to adjust the axis coordinate system.
13 MC_FB_ERR_ The axis is not operational because a motion engine execution error was
ERR_ENGINE detected.
Power cycle the entire machine and download the User Application to the
controller again.
If the fault persists, contact your local Rockwell Automation technical support
representative. For contact information, see:
http://www.rockwellautomation.com/support .
16 MC_FB_ERR_ The axis is not operational because the axis is not homed.
NOT_HOMED Reset the state of the axis using the MC_Power and MC_Reset function blocks.
Execute homing against the axis using MC_Home function block.
128 MC_FB_ERR_ Motion internal warning, Warning ID = 0x80.
PARAM_MODIFIED Contact your local Rockwell Automation technical support representative. For
contact information, see:
http://www.rockwellautomation.com/support .
See also
MC_ReadAxisError on page 484
MC_ReadBoolParameter Returns the value of a vendor specific parameter of type BOOL.
(motion control read BOOL Languages supported: Function Block Diagram, Ladder Diagram, Structured
parameter) Text.

motion control.


type
TRUE - execute current MC_ReadBoolParameter computation.
FALSE - reset Value output to 0.
AxisIn Input AXIS_REF Use the AXIS_REF data type to define AxisIn.
FB_AXIS_REF For FB_Axis (feedback axis), use the FB_AXIS_REF data type to
define AxisIn.
Enable Input BOOL TRUE - get the value of the parameter continuously while enabled.
FALSE - the Value output is reset to 0.
ParameterNumber Input DINT Parameter identification.
Parameter numbers definitions are defined in Motion control
function block parameter numbers.
Valid Output BOOL TRUE - the value of the Parameter is available.
FALSE - the Parameter value is unavailable.
Busy Output BOOL TRUE - the function block is working and new output values are
expected.
FALSE - the function is idle.

FALSE - No error.
Value Output BOOL Value of the specified parameter in the data type, as specified by
the vendor.

MC_ReadBoolParameter Function Block Diagram example
MC_ReadBoolParameter Ladder Diagram example

MC_ReadBoolParameter Structured Text example
Results
See also

MC_ReadParameter Returns the value of a vendor specific parameter in a Real data type.
(motion control read Languages supported: Function Block Diagram, Ladder Diagram, Structured
parameter) Text.

motion control.

type
TRUE - execute current MC_ReadParameter computation.
FB_AXIS_REF For FB_Axis (feedback axis), use the FB_AXIS_REF data type to
define AxisIn.
Enable Input BOOL TRUE - get the value of the parameter number continuously.
Parameter numbers definitions are defined in Motion control
function block parameter numbers.
Valid Output BOOL TRUE - valid outputs are available.
FALSE - valid outputs are unavailable.
expected.


type
FALSE - No error.
Value Output REAL Value of the specified parameter in the data type, as specified by
the vendor.
MC_ReadParameter Function Block Diagram example
MC_ReadParameter Ladder Diagram example

MC_ReadParameter Structured Text example
Results
See also
MC_ReadStatus (motion Returns the status of the axis with respect to the motion currently in progress.
control read status) Languages supported: Function Block Diagram, Ladder Diagram, Structured
Text.


motion control.

r type
TRUE - execute current MC_ReadStatus computation.
define AxisIn.
Enable Input BOOL TRUE - get the axis status continuously.
FALSE - all status outputs are reset to 0.


r type
Valid Output BOOL TRUE - valid outputs are available.
FALSE - outputs unavailable.
expected.
FALSE - No error.
ErrorStop Output BOOL TRUE - the axis state is ErrorStop.

Axis states are defined in Motion control axis state values and
names.
Disabled Output BOOL TRUE - the axis state is Disabled.
Stopping Output BOOL TRUE - the axis state is Stopping.
Referenced Output BOOL TRUE - the axis state is homed, the absolute reference position is
known for the axis.
StandStill Output BOOL TRUE - the axis state is StandStill.
DiscreteMotion Output BOOL TRUE - the axis state is DiscreteMotion.
ContinuousMotion Output BOOL TRUE - the axis state is ContinuousMotion.
SynchronizedMotio Output BOOL Synchronized motion is not supported in Micro800 controllers.
n TRUE - never true.
FALSE - always false.
Homing Output BOOL TRUE - the axis state is Homing.
ConstantVelocity Output BOOL TRUE - the velocity for the motor is constant.
Accelerating Output BOOL TRUE - axis is accelerating, increased energy to the motor.
Decelerating Output BOOL TRUE - axis is decelerating, decreased energy to the motor.

MC_ReadStatus Function Block Diagram example

MC_ReadStatus Ladder Diagram example

MC_ReadStatus Structured Text example
Results
See also

MC_Reset (motion control Transitions the axis state from ErrorStop to StandStill by resetting all internal
axis-related errors. The outputs of the function block instances are not changed.
reset)
Operation details:
If the axis alarm state is unchanged after executing MC_Reset, execute

MC_Power followed by MC_Reset.
MC_Reset only resets the axis state from ErrorStop to StandStill. Executing
MC_Reset when the axis is in other states, including Disabled, results in an
error, and has no impact on on-going motion or the status of the axis.

Text.

motion control.

type
TRUE, execute current MC_Reset computation.
FALSE, there is no computation.
FB_AXIS_REF For FB_Axis (feedback axis), use the FB_AXIS_REF data type to define
AxisIn.
Execute Input BOOL TRUE - resets the axis to the rising edge.

Done Output BOOL TRUE - axis state is StandStill or Disabled.


type
FALSE - No error.
MC_Reset Function Block Diagram example
MC_Reset Ladder Diagram example

MC_Reset Structured Text example
Results
See also
MC_SetPosition (motion Shifts the coordinate system of an axis by manipulating the actual position of an
axis with the same value without causing any movement.
control set position)

Operation details:
MC_SetPostion can successfully complete only when the axis state is

StandStill, continuous Motion (MC_ExecutionMode = 0), or when the
on-going motion completes, and ends with a StandStill state
(MC_ExecutionMode = 1).
MC_SetPosition operates the same as MC_Home when the HomingMode
= MC_HOME_DIRECT (0x04), except the MC_Home function block
sets the Axis Homed status.
When MC_ExecutionMode = 0 (mcImmediately), the execution of the
MC_SetPosition function block reports an error if there is on-going
non-continuous motion with the axis.
When MC_ExecutionMode = 1 (mcQueued), the actual position setting
occurs only when all previous on-going motion stops. That is, each previous
function block must have at least one of the Done, Aborted, or Error
outputs equal to True.

Text.

motion control.

type
TRUE - execute current MC_SetPosition computation.
FB_AXIS_REF For FB_Axis (feedback axis), use the FB_AXIS_REF data type
to define AxisIn.


type
Execute Input BOOL TRUE - starts setting the axis position.
Position Input REAL The absolute position or relative distance to be set for the
axis.
Relative Input BOOL TRUE - set the relative distance for the axis.
FALSE - set the absolute position for the axis.
MC_ExecutionMode Input SINT Values are:
0 (mcImmediately) - The functionality is immediately
valid.
1 (mcQueued) - The new functionality becomes valid
when:
all previous motion commands set to one of the
following output parameters: Done, Aborted
or Error.
the axis is not in a moving state.
For (MC_ExecutionMode = 0), this function block
successfully completes when the axis state is Disabled or
StandStill. The execution of this function block reports an
error if there is an on-going non-Continuous motion with the
axis in this mode.
For (MC_ExecutionMode = 1), this function block

successfully completed when the axis state is Disabled,
Standstill, or the on-going motion can complete, ending
with a Standstill state.
Other input values are reserved currently, and are considered

as invalid parameters.
Done Output BOOL TRUE - the Position has new value.
FALSE - No error.
instruction are defined in Motion control function block error
IDs.

MC_SetPosition Function Block Diagram example
MC_SetPosition Ladder Diagram example
MC_SetPosition Structured Text example

Results
See also
MC_Stop (motion control Commands a controlled motion stop and transfers the axis state to Stopping. Any
ongoing function block execution is aborted. All function block move commands
stop) are ignored until the axis state transitions to StandStill.
Operation details:
As long as the Execute input is high, the axis remains in the Stopping state.
While the axis is in the Stopping state, other motion function blocks cannot
perform any motion on the same axis.
If Deceleration equals zero, the MC_Stop parameters are determined by the
Axis configuration Emergency Stop setting, including E-Stop type, E-stop
Deceleration and E-stop Jerk.
When there are no errors detected during the stop sequence, the axis state
transitions to StandStill after the Done bit is SET and the Execute input
changes to False.
Use MC_Stop for emergency stop functionality or exception situations.
Use MC_Halt for normal motion stops.

Text.


motion control.

type
TRUE - execute current MC_Stop computation.
AxisIn Input AXIS_REF Use the AXIS_REF data type to define the parameters for
AxisIn.
Execute Input BOOL TRUE - starts the action at the rising edge.
FALSE - not executing.
Deceleration Input REAL Value of the deceleration [u/s2].
Jerk Input REAL Value of the Jerk [u/s3].


Done Output BOOL TRUE - zero velocity was reached, without error during the
stop sequence.

CommandAborted Output BOOL TRUE - command was aborted by MC_Power(OFF) function
block, or ErrorStop.
FALSE - No error.


type
instruction are defined in Motion control function block error
IDs.
MC_Stop Function Block Diagram example
MC_Stop Ladder Diagram example

MC_Stop Structured Text example
Results
See also
MC_TouchProbe (motion Records an axis position at a trigger event.
control touch probe) Operation details:
If the window direction (first position --> last position) is in the opposite
direction of the motion direction, the touch probe window does not
activate.

If the window setting (FirstPosition or LastPosition) is invalid, the

MC_TouchProbe function block reports an error.
If a second instance of the MC_TouchProbe function block is issued on the
same axis, and the first function block instance is in a Busy state, the second
function block instance reports an error.
Only one MC_TouchProbe function block instance should be issued to one
axis.

Text.

motion control.

type
TRUE - execute current MC_TouchProbe computation.
AxisIn Input AXIS_REF Use the AXIS_REF data type to define the parameters for AxisIn.
FB_AXIS_REF For a feedback axis, use the FB_AXIS_REF data type to define the
parameters for AxisIn.
TriggerInp Input USINT Only embedded motion supported.
Execute Input BOOL TRUE - starts touch probe recording at the rising edge.
FALSE - not executing.


type
WindowOnly Input BOOL TRUE - only use the window to accept trigger events.
Motion resolution is limited to the Motion Engine interval
configured by the user.
For WindowOnly TouchProbe functionality, there is a maximum
response time delay that is equal to the Motion Engine interval for
both FirstPosition and LastPosition activation.
The maximum possible lag in the triggering position (both
FirstPosition and LastPosition) can be calculated by (Motion
Engine interval * moving velocity).
FirstPosition Input REAL Start position of the window from where trigger events are
accepted (in technical units [u]). Value included in window.
LastPosition Input REAL Stop position of the window from where trigger events are not
accepted (in technical units [u]). Value included in window.

FB_AXIS_REF
TriggerInput Output USINT Only embedded motion is supported.
Done Output BOOL TRUE - trigger event was recorded.
CommandAborted Output BOOL TRUE - the command was aborted by the MC_Power(OFF), or
Error Stop function block.
FALSE - No error.
RecordedPosition Output REAL Position where trigger event occurred (in technical units [u])
Motion is an open-loop motion.
The axis position at the time the trigger event occurs. If the axis
motion is an open-loop motion, the commanded position (not an
actual position) at the time the trigger event occurs, if there is no
motion delay between the drive and the motor.
Motion fixed input/output
Motion Signals PTO0 PTO1 PTO2
PTO pulse Output_0 Output_1 Output2

PTO direction Output_3 Output_4 Output_5
Lower (Negative) Limit switch Input_0 Input_4 Input_8
Upper (Positive) Limit switch Input_1 Input_5 Input_9
Absolute Home switch Input_2 Input_6 Input_10
Touch Probe Input switch Input_3 Input_7 Input_11

MC_TouchProbe Function Block Diagram example
MC_TouchProbe Ladder Diagram example

MC_TouchProbe Structured Text example
Results
See also
MC_WriteBoolParameter Modifies the value of a vendor specific parameter of type BOOL.
(motion control write BOOL The parameters set by the MC_WriteBoolParameter function block are only
parameter) applied to the application temporarily. They are overwritten by the permanent
settings, which are configured by the user in Connected Components Workbench
Motion Configuration, when the controller is switched from PRG to RUN mode,
or when the power to the controller is cycled OFF and ON.

Text.


motion control.

type
TRUE - execute current MC_WriteBoolParameter
computation.
FB_AXIS_REF AxisIn.
For a feedback axis, use the FB_AXIS_REF data type to
define the parameters for AxisIn.
Execute Input BOOL TRUE - writes the value of the parameter at the rising edge.
The parameter number is defined in Motion control function
block parameter details.
Value Input BOOL TRUE - the specified parameter has a new value.


type
valid.
when:
all previous motion commands set one of the
following output parameters: Done,
Aborted or Error
the axis is not in a moving state.
When (MC_ExecutionMode = 0), for all parameters except
Duty Cycle (1005), this FB can be completed successfully
only when the axis state is Disabled or StandStill,
When (MC_ExecutionMode = 0), for Parameter Duty Cycle
(1005), this FB can be completed successfully except the axis
is in Homing or ErrorStop state.
For (MC_ExecutionMode = 1), this function block can be
successfully completed only when the axis state is Disabled,
Standstill, or the on-going motion can complete, ending
with Standstill state
Other input values are reserved currently, and are
considered as invalid parameters.
Done Output BOOL TRUE - the parameter was successfully written.

FALSE - No error.
instruction are defined in Motion control function block
error IDs.
MC_WriteBoolParameter Function Block Diagram example

MC_WriteBoolParameter Ladder Diagram example
MC_WriteBoolParameter Structured Text example

Results
See also
MC_WriteParameter Modifies the value of a vendor specific parameter of type REAL.
(motion control write The parameters set by the MC_WriteParameter function block are only applied
parameter) to the application temporarily. They are overwritten by the permanent settings,
which are configured by the user in Connected Components Workbench Motion
Configuration, when the controller is switched from PRG to RUN, or when the
controller power is cycled OFF and ON.

Text.


motion control.

type
TRUE - execute current MC_WriteParameter computation.
FB_AXIS_REF AxisIn.
For a feedback axis, use the FB_AXIS_REF data type to
define the parameters for AxisIn.
Execute Input BOOL TRUE - writes the value of the parameter at the rising edge.

The parameter number is defined in Motion control
function block parameter details.
Value Input REAL New value of the specified parameter.


type
valid.
when:
all previous motion commands set one of the
following output parameters: Done,
Aborted or Error
the axis is not in a moving state
implies that the output parameter Busy is set
to FALSE.
When (MC_ExecutionMode = 0), for all parameters except
Duty Cycle (1005), this FB can be completed successfully
only when the axis state is Disabled or StandStill,
When (MC_ExecutionMode = 0), for Parameter Duty Cycle
(1005), this FB can be completed successfully except the
axis is in Homing or ErrorStop state.
For (MC_ExecutionMode = 1), this function block can be

successfully completed only when the axis state is
Disabled, Standstill, or the on-going motion can complete,
ending with Standstill state
Other input values are reserved currently, and are
considered as invalid parameters.
Done Output BOOL TRUE - the parameter was successfully written.
Busy Output BOOL TRUE - indicates the function block has control of the axis.
FALSE - No error.
ErrorID Output UINT A unique numeric that identifies the error. The errors for
this instruction are defined in Motion control function
block error IDs.

MC_WriteParameter Function Block Diagram example
MC_WriteParameter Ladder Diagram example
MC_WriteParameter Structured Text example

Results
See also
General rules for motion control function block on page 434

Chapter 18
Process control instructions
Use Process control instructions to monitor and maintain process loops for
quantities such as pressure, temperature, flow rate, and fluid level. Process controls
regulate the course by sending an output signal to the control valve.
DERIVATE on page 523 Differentiates a real value over a defined cycle time.
FFL on page 525 Loads 8 bit, 16 bit, 32 bit, or 64 bit data into a user-created array called a FIFO
stack.
FFU on page 535 Unloads 8 bit, 16 bit, 32 bit, or 64 bit data from a user-created array called a
FIFO stack. The data unloads in the same order as loaded using the FFL
instruction.
HYSTER on page 541 Performs aBoolean hysteresis on difference of reals.
INTEGRAL on page 543 Integrates a real value during the defined cycle time.
PWM on page 549 Turns the pulse width modulation (PWM) output for a configured PWM channel
ON or OFF.
SCALER on page 552 Scales the input value according to the output range.
STACKINT on page 555 Manages a stack of integer values.
LIMIT on page 560 Restricts integer values to a given interval.
TND on page 558 Stops the current cycle of the user program scan.
See also
DERIVATE Differentiation of a real value over a defined cycle time.
Operation details:
If the CYCLE parameter value is less than the cycle timing of the execution
of the device, the sampling period is forced to this cycle timing.
The derivation is performed with a time base of milliseconds.For example,
the derivation of an input of 1000 that changes to 2000 over a time period
of 1 second results in a value of 1. To convert the output of the instruction
to units of seconds, multiply the output by 1000.

Text.

Chapter 18 Process control instructions

controllers.

type
RUN Input BOOL Indicates the operational mode of the instruction.
TRUE - normal (perform calculation)
FALSE - reset
XIN Input REAL Defines the value on which to perform the derivation
calculation. The value must be a REAL value.
CYCLE Input TIME Defines the sampling time period over which to collect
values. Possible time period values range from 0ms to
23h59m59s999ms.
XOUT Output REAL Differentiated output.
DERIVATE Function Block Diagram example
DERIVATE Ladder Diagram example

Process control instructions Chapter 18
DERIVATE Structured Text example
(* ST Equivalence: DERIVATE1 is an instance of a DERIVATE block *)
DERIVATE1(manual_mode, sensor_value, t#100ms);

derivated_value := DERIVATE1.XOUT;
See also
Process control instructions on page 523
Loads 8 bit, 16 bit, 32 bit, or 64 bit data into a user-created array called a FIFO
FFL (FIFO load)
stack.
Operation details:
FFL instruction - non executing mode to executing mode

When Execute changes from FALSE to TRUE:
Error conditions are verified.
The contents of Src are loaded into the FIFO stack in the
available position and Position increments by 1 if Position is less
than or equal to zero and less than Length.
Full is set to TRUE if Length equals Position. Full is FALSE if
Position is less than or equal to zero and less than Length.
Done is set when the instruction executes successfully.
When Execute changes from TRUE to FALSE:
Error, Done, and ErrorID are set to FALSE.
Empty is set to TRUE if Position is equal to zero.
Full is set to TRUE when Length equals Position. Full is FALSE
if Position is less than or equal to zero and less than Length.
The FFL error conditions are not verified.
When Execute changes from TRUE to TRUE:
No load operation is performed.
Full is set to FALSE if Position is less than or equal to zero and
less than Length. Full is set to TRUE if Length equals Position.
The FFL error conditions are not verified.

When Execute changes from FALSE to FALSE:

Error, Done, and ErrorID bits are set to FALSE.
Full and Empty bits retain values from previous execution state.
Full is set to TRUE if Length equals Position. Full is FALSE if
Position is less than or equal to zero and less than Length.
FLL error conditions are not verified.
FFL instruction - executing mode to non-executing mode:
Error, ErrorID, Done, Empty, and Full retain the Execute mode
state.
To create a single element for the FIFO parameter:
Non array:
Variable based address such as Fifo1 is allowed for FIFO.
Length should be configured as 1.
Array:
Variable based address such as Fifo1 or Fifo1[0] is allowed for
FIFO.

Text.


Type
Execute Input BOOL Instruction block enable.
TRUE - If rising edge is detected, start the FFL operation.
FALSE - Rising edge is not detected.
Src Input ANY_ELEMENTARY The Src operand is the address of the value used to fill the currently
available position in the FIFO stack.
Elementary data types supported for Scr:
DWORD, REAL, TIME, DATE, LWORD, ULINT, LINT, LREAL, BOOL,
SINT, USINT, BYTE, INT, UINT, WORD, DINT, UDINT.
Sting is not supported.
Array elements such as Array[1] or Array[Index] are supported.
FIFO Input ANY_ELEMENTARY The starting address of the stack. FIFO must be configured the same
for the FFL and FFU instructions.
Elementary data types supported for FIFO:
DWORD, REAL, TIME, DATE, LWORD, ULINT, LINT, LREAL, BOOL,
SINT, USINT, BYTE, INT, UINT, WORD, DINT, UDINT.
String is not supported.
Only single dimension array is supported for FIFO.
FIFOCon Input FF_LF_CON FIFO configuration and control. The same configuration must be
configured for FFL and FFU instructions.
Use the FF_LF_CON data type to configure Position and Length.
Done Output BOOL Indicates when the FFU operation is complete.
TRUE - Operation completed successfully.
FALSE - Operation encountered an error condition or the FFU
instruction is not executing.
Empty Output BOOL Indicates when the FIFO stack is empty.
TRUE - When Position equals 0.
FALSE - When Position is not equal to 0.
Full Output BOOL Indicates when the FIFO stack is full.
TRUE - When Length is equal to Position.
FALSE - When Position is greater than or equal to zero and less than
Length.
TRUE - Operation encountered an error.
FALSE - Operation completed successfully or the instruction is not
executing.
ErrorID Output USINT A unique numeric that identifies the error. The errors are defined in
FFL error codes.
FF_LF_CON data type
Use this table to help determine the parameter values for the FF_LF_CON data
type.
Length UINT Number of elements used for FIFO operation. Maximum limit is 1024.

Position USINT Determines the next available location in the FIFO for the Src entry or removal. Position is the
offset of the array.
Example 1:
User configured array, arr[0..5]. Initial position is configured as 1. Data is pushed into
arr[1] and position increments by position + 1.
Example 2:
User configured array as arr[1..5]. Initial position is configured as 1. Data is pushed into
FFL error codes
Use this table to determine the FFL and FFU error codes and descriptions.
0 No error.
1 FFL Src data type is not supported.
2 FFU Dest data type is not supported.
3 FIFO data type is not supported.
4 Src and Dest data type mismatch with the FIFO data type.
Corrective Action:
FFL Src parameter and FFU Dest parameter data type should match with the FIFO array data type.
5 FIFO - Array dimension is not supported.
Corrective Action:
FIFO only supports single dimension Arrays.
6 FIFOCon control Length exceeds FIFO array size.
Corrective Action:
FIFOCon control Length cannot exceed the FIFO array size.
7 FIFOCon Length exceeds the max length.
8 FIFOCon Length is zero.
9 FIFOCon Position exceeds the FIFOCon Length.
10 FFL control Length and Position are equal.
11 FFU control Position is zero.
12 FFL or FFU array dimension is not supported.

Corrective Acton:
FFL and FFU only support single dimension arrays.
13 FFL or FFU DestOffset exceeds Dest array size.

FFL Function Block Diagram example
FFL Ladder Diagram example

FFL Structured Text example
Results
See also
FFL and FFU instruction timing diagrams on page 530
FFL and FFU instruction timing The following timing diagram examples describe execution scenarios for the FFL
(FIFO load) and FFU (FIFO unload) instructions.
diagrams

Successful FFL execution followed by successful FFU execution
Use this table to help determine the parameter values for each scan cycle.
1 Rung condition becomes TRUE when:

Execute input bit is TRUE.
Load (push) data to FIFO stack.
5 Rung condition becomes FALSE when:
Execute bit is FALSE.
Done output bit is FALSE.
8 Rung goes TRUE when:
Execute input bit is TRUE.
Unload data from FIFO stack.

Successful execution when the Empty bit is TRUE

Execute input bit is TRUE. Execution starts.
Position is zero. Empty bit is TRUE.
Empty bit is TRUE.

Empty bit is TRUE.


Empty bit is TRUE.
Successful execution when the Empty bit is TRUE

Position is equal to Length, Full bit is TRUE.
Full bit is TRUE.


Full bit is TRUE.
Full bit is TRUE.
Error encountered during FFL and FFU execution
Rung condition becomes TRUE when:

Error bit is TRUE.
Error and ErrorID bits are FALSE.


Error bit is TRUE.
Error and ErrorID bits are FALSE.
See also
FFL on page 535
FFU on page 535
FFU (FIFO unload) Unloads 8 bit, 16 bit, 32 bit, or 64 bit data from a user-created array called a FIFO
(first in first out) stack in the same order data was loaded using the FFL
instruction.
Operation details:
FFU instruction - non executing mode to executing mode:

When Execute changes from FALSE to TRUE:
FFU error conditions are verified.
Unloads the contents of the FIFO stack at the zero position if
Position is greater than zero and less than or equal to Length.
Remaining elements shift one position towards zero and the
highest element of the FIFO stack is set with zero, Position is
decremented by 1.
Empty is set to TRUE if Position equals zero.
Done is set when the instruction executes successfully.
When Execute changes from TRUE to FALSE:
Full is set to TRUE if Length equals Position. Full is set to
FALSE if Position is less than or equal to zero and less than
Length.
The FFU error conditions are not verified.

When Execute changes from TRUE to TRUE:

No unload operation performed.
Full is set to TRUE if Length equals Position.
The FFU error conditions are not verified.
When Execute changes from FALSE to FALSE:
Full is set to TRUE if Length equals Position. Full is set to
FALSE if Position is less than or equal to zero and less than
Length.
The FLU error conditions are not verified.
FFU instruction - executing mode to non-executing mode:
Error, ErrorID, Done, Empty, and Full retain the Execute mode state.
To create a single element for the FIFO parameter:
Non array:
Variable based address such as Fifo1 is allowed for FIFO.
Array:
Variable based address such as Fifo1 or Fifo1[0] is allowed for
FIFO.

Text.


Type
TRUE - If rising edge is detected, start FFU operation.
FALSE - Rising edge is not detected.
Dest Input ANY_ELEMENTARY Holds the value that exists in the FIFO stack.
Elementary data types supported for Dest:
DWORD, REAL, TIME, DATE, LWORD, ULINT, LINT, LREAL,
BOOL, SINT, USINT, BYTE, INT, UINT, WORD, DINT, UDINT.
Sting is not supported.
Only supports single dimension arrays such as Array[1] or
Array[Index].
DestOffset Input UINT Destination element offset.
Element offset if destination is array data type, otherwise offset
should be set to 0.
For array data type, to unload to the first element, the offset
should be set as 0.
FIFO Input ANY_ELEMENTARY The starting address of the stack. FIFO must be configured the
same in the FFL and FFU instructions.
Elementary data types supported for FIFO:
DWORD, REAL, TIME, DATE, LWORD, ULINT, LINT, LREAL,
BOOL, SINT, USINT, BYTE, INT, UINT, WORD, DINT, UDINT.
String is not supported.
Only single dimension is supported for FIFO.
FIFOCon Input FF_LF_CON FIFO configuration and control. The same configuration must be
configured for FFL and FFU instructions.
Use the FF_LF_CON data type to configure Position and Length.
Done Output BOOL Indicates when the FFU operation is complete.
TRUE - Operation completed successfully.
FALSE - Operation encountered an error condition or the FFU
instruction is not executing.
Full Output BOOL Indicates when the FIFO stack is full.
TRUE - When Length is equal to Position.
FALSE - When Position is greater than zero and less than
Length.
Empty Output BOOL Indicates when the FIFO stack is empty.
TRUE - When Position equals 0.
FALSE - When Position is not equal to 0.
TRUE - Operation encountered an Error.
FALSE - Operation completed successfully or the instruction is
not executing.
ErrorID Output USINT A unique numeric that identifies the error. The errors are
defined in FFU error codes.

FF_LF_CON Data Type
Use this table to help determine the parameter values for the FF_LF_CON data
type.
Length UINT Number of elements used for FIFO operation. Maximum limit is 1024.
Position USINT Determines the next available location in the FIFO for the Src entry or removal. Position is the
offset of the array.
Example 1:
User configured array, arr[0..5]. Initial position is configured as 1. Data is pushed into
Example 2:
User configured array as arr[1..5]. Initial position is configured as 1. Data is pushed into
FFU error codes
Use this table to determine the FFL and FFU error codes and descriptions.
0 No error.
Corrective Action:
Corrective Action:
Corrective Action:
7 FIFOCon Length exceeds the max length.
8 FIFOCon Length is zero.
9 FIFOCon Position exceeds the FIFOCon Length.
10 FFL control Length and Position are equal.
11 FFU control Position is zero.

0 No error.
Corrective Action:
Corrective Action:
Corrective Action:
12 FFL or FFU array dimension is not supported.
Corrective Acton:
FFL and FFU only support single dimension arrays.
13 FFL or FFU DestOffset exceeds Dest array size.
FFU Function Block Diagram example

FFU Ladder Diagram example
FFU Structured Text example

Results
See also
FFL and FFU instruction timing diagrams on page 530
HYSTER (hysteresis) Boolean hysteresis on difference of reals. Compares the current value of an input
with the high limit established by adding the historical amount of lag as measured
by hysteresis to the expected value for an input and assessing whether the current
value exceeds that limit.

Text.


controllers.

type
TRUE - execute the instruction block.
FALSE - do not execute the instruction block.
XIN1 Input REAL Any real value.
XIN2 Input REAL To test if the input value XIN1 has exceeded the high limit defined
for this input XIN2 + EPS.
EPS Input REAL Hysteresis value (must be greater than zero).
Q Output BOOL The result of the HYSTER instruction.
TRUE - The input exceeded the upper limit but is not below the
lower limit.
FALSE - The input did not exceed the upper limit.
HYSTER timing diagram example
In the following diagram HYSTER is used to assess the performance lag due to
motor friction over a 5 second time period. The instruction is run every 10
milliseconds. During the startup phase the motor was operating less efficiently.

HYSTER Function Block Diagram example
HYSTER Ladder Diagram example
HYSTER Structured Text example
See also
INTEGRAL Integrates a real value during the defined cycle time.
Operation details:
When the INTEGRAL function block is first initialized, its initial values
are not considered. Use the R1 parameter to set the initial values for a
calculation.

To prevent loss of the integrated value, the integration value is not cleared
automatically when the controller transitions from PROGRAM to RUN or
when the RUN parameter transitions from FALSE to TRUE. Use the R1
parameter to clear the integral value when first transitioning the controller
from PROGRAM to RUN mode and when starting a new integration.
It is recommended that the optional EN or ENO parameters are not used
with this function block because the cycle time calculation becomes
disrupted when EN is FALSE, resulting in an incorrect integration. If the
EN or ENO parameters are used, toggle the R1 parameter with EN equal to
TRUE to clear the current result and ensure correct integration.
Integration is performed with a time base of milliseconds (that is,
integrating an input of 1 with an initial value of 0 for 1 second results in a
value of 1000). To convert the output of the instruction to units of seconds,
divide the output by 1000.
If the CYCLE parameter value is less than the cycle timing of the execution
of the device, the sampling period is forced to the cycle timing.
XIN sampling and function block executions occur every cycle time + Scan
Time Jitter.
For a given user program, Scan Time Jitter varies from controller to
controller.
The cycle time determines the sensitivity of the Integral function block.
Changes occurring in XIN between two samplings (or within the cycle
time) are not taken into account when the integral XOUT value is
calculated.
Cycle time and Scan Time Jitter both contribute to the overall inaccuracy of
Integral output as shown in the XIN in sync with the function block
execution example and the XIN not in sync with function block execution
example.

Text.


controllers.

type
RUN Input BOOL Mode: TRUE = integrate / FALSE = hold.
R1 Input BOOL Overriding reset.
XIN Input REAL Input: any real value.
X0 Input REAL Initial value.
CYCLE Input TIME Sampling period. Possible values range from 0ms to
23h59m59s999ms.
Q Output BOOL Not R1.
XOUT Output REAL Integrated output.
INTEGRAL Function Block Diagram example

INTEGRAL Ladder Diagram example
INTEGRAL Structured Text example
(* ST Equivalence: INTEGRAL1 is an instance of a INTEGRAL block *)
INTEGRAL1(manual_mode, NOT(manual_mode), sensor_value,

init_value, t#100ms);
controlled_value := INTEGRAL1.XOUT;

Results

XIN in sync with function block execution example
The following images show the effect of Scan Time Jitter on the XOUT value:

XIN not in sync with function block execution example
The following images show an example in which an error is introduced in the

XOUT value of an Integral function block:
See also
Turns the PWM (Pulse Width Modulation) output for a configured PWM
PWM (Pulse Width
channel ON or OFF.
Modulation)
This instruction block is used with Micro820 2080-LC20-20QBB controllers and
supports one PWM channel using the embedded output channel 6.


Text.
This instruction applies only to the Micro820 2080-LC20-20QBB controller.

type type
Enable Input BOOL Instruction block enable. This level is instruction block triggered.
TRUE - Update Sts. PWM is made active or inactive depending on the On
input parameter and valid configuration.
FALSE - Sts is only updated. PWM state (active or inactive) is not affected.
On Input BOOL Turns the PWM output ON/Active or OFF/Inactive.
TRUE - PWM output is active or continues to be active with latest valid
configuration. Output LED is ON when PWM is active, even if duty cycle is
set to 0%.
FALSE - PWM output is inactive if configuration is also valid.
Freq Input UDINT Pulse Frequency.
1 100000 Hz
DutyCycle Input UINT Pulse Duty Cycle.
0 1000 (0% - 100%)


type type
ChType Input UINT Channel Type
0 Embedded
1 Plugin
2 Expansion
ChSlot Input UINT Channel Slot
0 Embedded
ChNum Input UINT Channel Number
0 PWM CH0
Sts Output UINT PWM status codes:
00 - Function block not enabled (no operation.)
01 - PWM configuration successful.
02 - Invalid duty cycle.
03 - Invalid Frequency.
04 - Invalid Channel Type.
05 - Invalid Channel Slot.
06 - Invalid Channel Number.
07 - Invalid Catalog. PWM feature is not supported in the catalog being
used.
PWM Function Block Diagram example

PWM Ladder Diagram example
PWM Structured Text example
See also
Process Control instructions on page 523
SCALER (scale) Scales the input value according to the output range.

Text.


controllers.

type
TRUE - execute the scaling equation.
FALSE - there is no scaling equation.
Input Input REAL Input signal.
InputMin Input REAL Minimum value of Input.
InputMax Input REAL Maximum value of Input.
OutputMin Input REAL Minimum value of Output.
OutputMax Input REAL Maximum value of Output.
Output Output REAL Output value.
SCALER Function Block Diagram example

SCALER Ladder Diagram example
SCALER Structured Text example
(* ST equivalence: SCALER1 is an instance of SCALER block *)
SCALER1(Signal_In, 4.0, 20.0 , 0.0 , 150.0 ) ;

Out_Temp := SCALER1.Output ;

Results
See also
STACKINT (stack integers) Manages a stack of integer values.
Operation details:
STACKINT includes a rising edge detection for both PUSH and POP
commands. The maximum size of the stack is 128. The OFLO value is valid
only after a reset (R1 has been set to TRUE at least once and back to
FALSE).
The application defined stack size (N) cannot be less than 1 or greater than
128.
If N < 1, STACKINT assumes a size of 1.
If N > 128, STACKINT assumes a size of 128.

Text.


controllers.
Parameter Parameter type Data type Description
PUSH Input BOOL TRUE - Rising edge detected, on PUSH command. Adds the IN
value on the top of the stack.
FALSE - Rising edge not detected on PUSH command.
POP Input BOOL TRUE - Rising edge detected, on PUSH command. Deletes the
last value pushed to the top of the stack.
FALSE - Rising edge not detected on POP command.
R1 Input BOOL TRUE - Resets the stack to its empty state.
FALSE - No reset.
IN Input DINT Pushed value.
N Input DINT Application defined stack size.The maximum size of the stack
is 128
EMPTY Output BOOL TRUE - the stack is empty.
FALSE - the stack contains values.
OFLO Output BOOL TRUE - Overflow, the stack is full and R1 has been set to TRUE
at least once and back to FALSE.
FALSE - the stack size is 128 or less. No overflow.
OUT Output DINT Value at the top of the stack.
OUT equals 0 when OFLO is TRUE.

STACKINT Function Block Diagram example
STACKINT Ladder Diagram example
STACKINT Structured Text example

(* ST Equivalence: STACKINT1 is an instance of a STACKINT block *)
STACKINT1(err_detect, acknowledge, manual_mode, err_code,

max_err);
appli_alarm := auto_mode AND NOT(STACKINT1.EMPTY);
err_alarm := STACKINT1.OFLO;
last_error := STACKINT1.OUT;
Results
See also
TND (abort current Stops the current cycle of a user program scan. After the output scan, input scan,
and housekeeping are complete, re-executes the user program from the start of the
program) first routine.

Text.

controllers.


Type
Enable Input BOOL Function enable.
When Enable = TRUE, perform the function.
When Enable = FALSE, do not perform the function.
TND Output BOOL If true, function performed.
When variable monitoring is on, the monitoring variables
value is assigned to the instructions output.
When variable monitoring is off, the output variables value is
assigned to the instructions output.
TND Function Block Diagram example
TND Ladder Diagram example
TND Structured Text example
TESTOUTPUT := TND(TESTENABLE) ;

Results
See also
LIMIT (limit test) Restricts integer values to a given interval. Integer values between the minimum
and maximum are unchanged. Integer values greater than the maximum are
replaced with the maximum value. Integer values less than the minimum are
replaced with the minimum value.

Text.

controllers.

Type
TRUE - execute current LIMIT computation.
MIN Input DINT Minimum value supported.


Type
IN Input DINT Any signed integer value.
MAX Input DINT Maximum value supported.
LIMIT Output DINT Input value bounded to the supported range.

LIMIT Function Block Diagram example
LIMIT Ladder Diagram example
LIMIT Structured Text example
new_value := LIMIT (min_value, value, max_value);

Results
See also

Chapter 19
Program control instruction
Use the program control instruction to control instructions simultaneously from a

user program and from an operator interface device.
SUS on page 563 Suspends the execution of the <M800 controller>.
See also
SUS (suspend) Suspends the execution of the controller. The controller remains in RUN mode
but execution is suspended indefinitely. Suspend catches User Program errors and
aids in User Program monitoring. Place the SUS instruction in User Program
sections where you want to trap unusual conditions. In suspend mode, RUN LED
is set to OFF to indicate the program scan is Idle.

Text.

controllers.

type
TRUE - execute function.
FALSE - do not execute function.
SusID Input UINT Suspension ID.

Chapter 19 Program control instruction
SUS Function Block Diagram example
SUS Ladder Diagram example
SUS Structured Text example
Results
See also
Program control instruction on page 563

Chapter 20
Proportional Integral Derivative (PID) instruction
Use the Proportional-Integral-Derivative (PID) instructions to control the

process more accurately using PID functionality.
IPIDCONTROLLER on page 565 Configure and control the inputs and outputs used for the Proportional
Integral Derivative (PID) logic.
PID on page 592 Configure and control the outputs that control physical properties such as
temperature, pressure, liquid level, or flow rate using process loops.
See also
Proportional-Integral-Derivative (PID) control allows the process control to

What is Proportional
accurately maintain the setpoint by adjusting the control outputs. A PID function
Integral Derivative (PID) block combines all of the necessary logic to perform
control? proportional/integral/derivative (PID) control.
See also
Proportional Integral Derivative (PID) instruction on page 565
IPIDController function block operation on page 572
Use the Proportional Integral Derivative instruction on page 574
IPIDCONTROLLER Configure and control the inputs and outputs used for
proportional-integral-derivative (PID) logic. PID logic is used to control physical
(proportionalintegralder properties such as temperature, pressure, liquid, level, or flow rate by using process
ivative controller) loops that calculate an error value as the difference between a desired setpoint and
a measured process variable. The controller attempts to minimize the error over
time by adjustment of a control variable. The calculation includes proportional
(P), integral (I), and derivative (D) terms, which are used as follows:
- P - present values of the error.
- I - past values of the error.

Chapter 20 Proportional Integral Derivative (PID) instruction
- D - possible future values of the error, based on its current rate of change, which
controls physical properties such as temperature, pressure, liquid level, or flow rate
using process loops.

Text.

controllers.

type
EN Input BOOL When TRUE, enables the instruction block.
TRUE - execute the PID calculation.
FALSE - the instruction block is idle.
Process Input REAL Process value, which is the value measured from the process
output.
SetPoint Input REAL Set point.
FeedBack Input REAL Feedback signal, which is the value of the control variable applied
to the process.
For example, the feedback can be IPIDCONTROLLER output.
Auto Input BOOL The operation mode of the PID controller:

TRUE - controller runs in normal mode.
FALSE - controller causes reset R to track (F-GE).
Initialize Input BOOL A change in value (TRUE to FALSE or FALSE to TRUE) causes the
controller to eliminate any proportional gain during that cycle.
Also initializes AutoTune sequences.

Proportional Integral Derivative (PID) instruction Chapter 20

type
Gains Input GAIN_PID Gains PID for IPIDController.
Use the GAIN_PID data type to define the parameters for the
Gains input.
AutoTune Input BOOL TRUE - When AutoTune is TRUE and Auto and Initialize are FALSE,
the AutoTune sequence is started.
FALSE - Do not not start Autotune.
ATParameters Input AT_Param Auto Tune Parameters.
Use the AT_Param data type to define the parameters for the
ATParameters input.
Output Output REAL Output value from the controller.
AbsoluteError Output REAL Absolute error (Process SetPoint) from the controller.
ATWarnings Output DINT (ATWarning) Warning for the Auto Tune sequence. Possible values
are:
0 - no auto tune done.
1 - in auto tune mode.
2 - auto tune done.
-1 - ERROR 1 input automatically set to TRUE, no auto tune
possible.
-2 - ERROR 2 auto tune error, ATDynaSet expired.
OutGains Output GAIN_PID Gains calculated after AutoTune sequences.
Use the GAIN_PID data type to define the OutGains output.
IPIDCONTROLLER Function Block Diagram examples

IPIDCONTROLLER Ladder Diagram example
IPIDCONTROLLER Structured Text example
(* ST equivalence: IPIDController1 is an instance of IPIDController

block *)
IPIDController1(Proc,
SP,
FBK,
Auto,
Init,
G_In,
A_Tune,
A_TunePar,
Err );
Out_process := IPIDController1.Output ;

A_Tune_Warn := IPIDController1.ATWarning ;
Gain_Out := IPIDController1.OutGains ;
Results
See also
AT_Param data type on page 570
GAIN_PID data type on page 569
What is Proportional Integral Derivative (PID) control? on page 565
GAIN_PID data type The following table describes the GAIN_PID data type for the
IPIDCONTROLLER instruction.

type
DirectActing BOOL The type of acting:
TRUE - direct acting, output moves same direction as error. That is, the actual process
value is greater than the SetPoint and the appropriate controller action is to increase
the output For example: Chilling.
FALSE - reverse acting, output moves opposite direction as error. That is, the actual
process value is greater than the SetPoint and the appropriate controller action is to
decrease the output For example: Heating.


type
ProportionalGain REAL Proportional gain for PID (>= 0.0001).
When ProportionalGain is (< 0.0001) then ProportionalGain = 0.0001
Proportional gain for PID (P_Gain)
A higher proportional gain causes a larger change in the output based upon the
difference between the PV (measured process value) and SV (set point value). The higher
the gain, the faster the error is decreased, but this may result in instability such as
oscillations. The lower the gain, the slower the error is decreased, but the system is more
stable and less sensitive to large errors. The P_Gain usually is the most important gain to
adjust and the first gain to adjust while tuning.
TimeIntegral REAL Time integral value for PID (>= 0.0001).
When TimeIntegral is (< 0.0001) then TimeIntegral = 0.0001
Time integral value for PID
A smaller integral time constant causes a faster change in the output based upon the
difference between the PV (measured process value) and SV (set point value) integrated
over this time. A smaller integral time constant decreases the steady state error (error
when SV is not being changed) but increases the chances of instability such as
oscillations. A larger integral time constant slows down the response of the system and
make it more stable, but PV approaches the SV at a slower rate.
TimeDerivative REAL Time derivative value for PID (> 0.0).
When TimeDerivative is (<= 0.0) then TimeDerivative = 0.0
When TimeDerivative = 0, IPID acts as PI.
Time derivative value for PID (Td)
A smaller derivative time constant causes a faster change in the output based upon the
rate of change of the difference between PV (measured process value) and SV (set point
value). A smaller derivative time constant makes a system more responsive to sudden
changes in error (SV is changed) but increases the chances of instability such as
oscillations. A larger time constant makes a system less responsive to sudden changes in
error and the system is less susceptible to noise and step changes in PV. TimeDerivative
(Td) is related to the derivative gain but allows the derivative contribution to PID to be
tuned using time so the sample time must be taken into consideration.
DerivativeGain REAL Derivative gain for PID (> 0.0).
When DerivativeGain is (< 0.0) then DerivativeGain = 0.1
Derivative gain for PID (D_Gain)
A higher derivative gain causes a larger change in the output based upon the rate of
change of the difference between the PV (measured process value) and SV (set point
value). A higher gain makes a system more responsive to sudden changes in error but
increases the chances of instability such as oscillations. A lower gain makes a system less
responsive to sudden changes in error and makes the system less susceptible to noise
and step changes in the PV.
See also
IPIDCONTROLLER on page 565
AT_Param data type The following table describes the AT_Param data type parameters.

type
Load REAL Load parameter for auto tuning. This is the output value when starting AutoTune.


type
Deviation REAL Deviation for auto tuning. This is the standard deviation used to evaluate the noise band
needed for AutoTune.
Step REAL Step value for AutoTune. Must be greater than noise band and less than Load.
ATDynamSet REAL Waiting time in seconds before abandoning auto tune.
ATReset BOOL The indication of whether the output value is reset to zero after an AutoTune sequence:
TRUE - resets output to zero.
FALSE - leaves output at Load value.
See also
IPIDCONTROLLER on page 565
Create a feedback loop for the manipulated value on page 585
How the IPIDController function The IPIDController function block, available in the Connected Components
Workbench instruction set, is based on PID control theory and combines all of
block implements PID control
the necessary logic to perform analog input channel processing and proportional
integral-derivative (PID) control. In the HMI, the IPID faceplate is available for
use with the IPIDController function block.
IPIDController function block description
The IPIDController function block uses the following function block

components:
A: Acting (+/- 1)
PG: Proportional Gain
DG: Derivative Gain
td: D

ti: I
Preventing integral windup
If the difference between the setpoint value and the process value is great, the
output value increases significantly, and during the time it takes to decrease, the
process is not in control. The IPIDController function block interactively tracks
feedback and prevents integral windup. When the output is saturated, the integral
term in the controller is recomputed so that its new value provides an output at
the saturation limit.
See also
IPIDController function block When Input Auto is TRUE, the IPIDController runs in normal auto mode.
operation

When Input Auto is FALSE, it causes reset R to track (F-GE) forcing the
IPIDController Output to track the Feedback within the IPIDController limits
at which time the controller switches back to auto without incrementing the
Output.
For Input Initialize, changing from FALSE to TRUE or TRUE to FALSE when
AutoTune is FALSE causes the IPIDController to eliminate any proportional
gain action during that cycle (for example, Initialize). Use this process to prevent
bumping the Output when changes are made to the SetPoint using a switch
function block.
To run an AutoTune sequence:
To run an AutoTune sequence, the input ATParameters must be completed. The

Input Gain and DirectActing parameters must be set according to the process and
DerivativeGain set, (typically 0.1). The AutoTune sequence is started with the
following sequence:
1. Set the input Initialize to TRUE.
2. Set the input Autotune to TRUE.
3. Change the input Initialize to FALSE.
4. Wait until the output ATWarning changes to 2.
5. Transfer the values for output OutGains to input Gains.
To finalize the tuning, some fine tuning may be needed depending on the
processes and needs. When setting TimeDerivative to 0.0, the IPIDController
forces DerivativeGain to 1.0 then works as a PI controller.

See also
What is Proportional Integral Derivative on page 565
How the IPIDController function block implements PID control on page

571
Using the Proportional Integral Derivative instruction on page 574
Use the Proportional Integral This section provides specific details and examples for using the proportional
integral derivative instruction, including the following:
Derivative instruction
Example: How to create a feedback loop for the manipulated value
Adding a feedback loop for the manipulated value prevents excessive overshooting
by providing a minimum and maximum value for the MV.
Temperature feedback loop example
At the beginning of the temperature control process, the difference between the
process value (PV) and the setpoint value (SP) is large, as shown in the following
graph. In this example of a temperature feedback loop, the PV starts at 0 degrees
Celsius and moves towards the SP value of 40 degrees Celsius. Notice also that the
fluctuation between the high and low manipulated value (MV) decreases and
stabilizes with time. The behavior of the MV depends on the values used in each of
the P, I, and D parameters.

IPIDController with a feedback loop
The following function block diagram includes a feedback loop for the
manipulated value that prevents excessive overshooting by providing a minimum
and maximum value for the MV.
Example: How to implement auto-tuning in a IPIDController function block
Use AutoTune parameter of the IPIDController function block to implement

auto-tuning in the control program.
Auto-tuning requirements and recommendations
Following is a summary of requirements and recommendations for implementing

successful auto-tuning.
Autotuning must cause the output of the control loop to oscillate, which
means the IPIDController must be called frequently enough to adequately
sample the oscillation.
The IPIDController instruction block must be executed at a relatively
constant time interval.
Configure the scan time of the program to be than half of the oscillation
period.
Consider using a Structured Text Interrupt (STI) instruction block to
control the IPIDController instruction block.
Example: How to add a UDFB to a PID program
Add UDFBs outside the main program to perform specialized functions such as
converting units or transferring values.

Transfer the auto-tune gain value
This UDFB transfers the Autotune gain value to My_GainTransfer so it can be

used by the controller.
Convert a manipulated value to a digital output
This UDFB converts a manipulated value (MV) to a digital output (DO) so it can
be used to control a digital input n(DI).
Convert a manipulated value to an analog output
This UDFB converts a manipulated value (MV) to an analog output (AO) so it

can be used to control an analog input (AI).
See also

Use auto-tune with the Use the AutoTune parameter of the IPIDController function block to implement
IPIDController function block auto-tuning in the control program.
Auto-tuning requirements and recommendations
Following is a summary of requirements and recommendations for implementing

successful auto-tuning.
Autotuning must cause the output of the control loop to oscillate, which
means the IPIDController must be called frequently enough to adequately
sample the oscillation.
The IPIDController instruction block must be executed at a relatively
constant time interval.
Configure the scan time of the program to be than half of the oscillation
period.
Consider using a Structured Text Interrupt (STI) instruction block to
control the IPIDController instruction block.
See also
Auto-tune in first and second order Use auto-tune in first order system, which uses a single element, or in a second
systems order system, which uses two independent elements.
A first order system uses a single independent energy storage element. Examples
include:
Cooling of a fluid tank, with heat energy as the storage unit.

Flow of fluid from a tank, with potential energy as the storage unit.
A motor with constant torque driving a disk flywheel, with rotational
kinetic energy as the storage unit.
An electric RC lead network, with capacitive storage energy as the storage
unit.
In a first order system, the function may be written in a standard form such as f(t)
= dy/dt + y(t)
Where:

Variable Description Example: Cooling of a fluid tank using heat energy as the storage
element
t System time constant Is equal to RC
Where
R = Thermal resistance of the walls of the tank
C = Thermal capacitance of the fluid
f Forcing function Is the Ambient temperature
y System state variable Is the Fluid temperature
A second order system uses two independent energy storage elements that
exchange stored energy. Examples include:
A motor driving a disk flywheel with the motor coupled to the flywheel via a
shaft with torsional stiffness; Rotational kinetic energy and torsion spring
energy are the storage units.
An electric circuit composed of a current source driving a series LR
(inductor and resistor) with a shunt C (capacitor); Inductive energy and
capacitive energy are the storage units.
Motor driven systems and heating systems can typically be modeled by the LR and
the C electric circuit.
See also
Use auto-tune with the IPIDController function block on page 577
Configure auto-tuning Use these general steps when implementing auto-tuning using the
IPIDController function.
No. Step Example

1 Reset setpoint to zero.

No. Step Example

2 Switch Auto mode to False
3 Set Gains parameters.
4 Set Auto-Tune parameters. Set auto-tune parameters including an initial load value, step change for the
output, an estimated time to complete the auto tuning, and the auto-tune reset.

No. Step Example

5 Set Initialize and AutoTune
to True.
6 Notice the Output changes to the value of Load when you set AutoTune to True.
7 Observe the process value

rises quickly until it gets
closer to its saturation point.
8 Observe the stabilization of

the process value and its
fluctuation.

No. Step Example

9 Set the deviation.
10 Set Initialize to False.
11 Controller starts
auto-tuning. Wait for
ATWarning to become 2.

No. Step Example

12 Set AutoTune to False.
13 Observe the tuned values

appear in OutGains.
14 Transfer parameter from

OutGain to My_Gains.

No. Step Example

15 Observe the controller is
updated with the with the
tuned gain parameter.
See also
Use a Structured Timing Interrupt Although a PID instruction works if it is not controlled by a Structured Timing
(STI) with auto-tuning Interrupt (STI), using an STI increases the auto-tune success rate because the
auto-tune operates on a fixed cycle.
See also
Example: IPIDController with

auto-tune

The following example program shows the variables used to configure the
parameters for auto-tuning.
Auto-tune parameters
The following table describes the variables that are used with each parameter in
the example to configure auto-tuning.
Input parameters
Variable Parameter Description
AutoMode Auto The operation mode of the PID controller:
TRUE - controller runs in normal mode.
FALSE derivative term is ignored forcing the controller output to
track the feedback within the controller limits, and allowing the
controller to switch back to auto without bumping the output.
Initialize Initialize Initializes AutoTune sequence.

A change in value from TRUE to FALSE or FALSE to TRUE causes the
controller to eliminate any proportional gain during the cycle.
My_Gains Gains Establishes the Gains PID for IPIDController.
My_Gains.DirectActing DirectActing Defines the type of acting for the output.
TRUE - direct acting in which the output moves in the same direction
as the error. That is, the actual process value is greater than the
SetPoint and the appropriate controller action is to increase the
output. For example, chilling.
FALSE - reverse acting in which the output moves in the opposite
direction as the error. That is, the actual process value is greater than
the SetPoint and the appropriate controller action is to decrease the
output. For example: heating.
My_Gains.ProportionalGain ProportionalGain Proportional gain for PID (>= 0.0001).
My_Gains.TimeIntegral TimeIntegral Time integral value for PID (>= 0.0001).
The tendency for oscillation increases with a decrease in ti.
My_Gains.TimeDerivative TimeDerivative Time derivative value for PID (> 0.0).
Damping increases with an increase in derivative time, but decreases
if the derivative time value is too large.
My_Gains.DerivativeGain Derivative gain for PID (> 0.0).
AutoTune When set to TRUE and Auto and Initialize are FALSE, the AutoTune sequence is started.

Input parameters
ATParameters
Load Initial output value during auto-tuning.
Allows the process value to stabilize at the load
Deviation The standard deviation for a series of stabilized process values. For example, if the
process value stabilized between 31.4 to 32.0, then the deviation value would be
(32.0-31.4)/2 = 0.3.
Some process values, such as temperature, take a very long time to stabilize.
Step The auto-tune process considers how the process value reacts to the changes in step
value and derives the Gain parameters.
ATDynaSet Allocated time for the auto-tune to complete. It must be longer than what is required
for the auto-tune process.
A common value for many systems is 600 seconds, but some systems may require more
time.
ATReset If TRUE, the output will be reset to "0" after auto-tune completes.
If FALSE, the output will remain at the load value after auto-tune completes.
Output parameters
Parameter Description
AbsoluteError Absolute error (Process SetPoint) from the controller.
ATWarning Warning for the Auto Tune sequence. Possible values are:
0 - no auto tune done.
1 - in auto tune mode.
2 - auto tune done.
-1 - ERROR 1 input automatically set to TRUE, no auto tune possible.
-2 - ERROR 2 auto tune error, ATDynaSet expired
OutGains Gains calculated after AutoTune sequences.
See also
Example: How to create a feedback Adding a feedback loop for the manipulated value prevents excessive overshooting
loop for the manipulated value by providing a minimum and maximum value for the MV.
Temperature feedback loop example
At the beginning of the temperature control process, the difference between the
process value (PV) and the setpoint value (SP) is large, as shown in the following
graph. In this example of a temperature feedback loop, the PV starts at 0 degrees
Celsius and moves towards the SP value of 40 degrees Celsius. Notice also that the
fluctuation between the high and low manipulated value (MV) decreases and
stabilizes with time. The behavior of the MV depends on the values used in each of
the P, I, and D parameters.

IPIDController with a feedback loop
The following function block diagram includes a feedback loop for the
manipulated value that prevents excessive overshooting by providing a minimum
and maximum value for the MV.
See also
Example: How to add a UDFB to a PID For PID programs, use user-defined function blocks (UDFB) outside the main
program program to perform specialized functions such as converting units or transferring
values. The following are examples of UDFBs.

Transfer the auto-tune gain value
This UDFB transfers the Autotune gain value to My_GainTransfer so it can be

used by the controller.
Convert a manipulated value to a digital output
This UDFB converts a manipulated value (MV) to a digital output (DO) so it can
be used to control a digital input n(DI).
Convert a manipulated value to an analog output
This UDFB converts a manipulated value (MV) to an analog output (AO) so it

can be used to control an analog input (AI).
See also
Example: How to create an The temperature control program maintains the temperature within the control
IPIDController program to control zone.
temperature
Setpoint, process and manipulated values
The following table defines the SP, PV, and MV values used in the temperature
control program.

Item Description
Setpoint (SP) Measurement of temperature in degrees Celsius that defines the temperature for the
control zone.
Process value (PV) Must be converted to the same unit as the SP, which is a measurement of degrees Celsius.
Manipulated value (MV) Must be converted to an analog value so it can be output to the PWM to control the heating
element.
Temperature control system
The following diagram and table define the components in the temperature
control system that are controlled by the temperature control program the events
that occur when the control program runs.
Sequence of events for temperature control program
The following table identifies the components in the temperature control system
and describes the sequence of events that occurs in the system when the
temperature control program runs.
No Item Description
Controller output Sends the MV to the PWM (On/Off).
Pulse Width Modulation (PWM Solid state relay that controls the heating element.
temperature controller
Heating element Increases temperature in the control zone.
Resistance temperature detector Measures the temperature in the control zone and sends the PV (RTD
(RTD) signal) to the controller input.
Controller input Receives the PV (RTD signal).

No Item Description
PLC program Converts the PV (RTD signal) to the same unit as the SP (degrees Celsius)
and determines the difference between the PV and the SP and adjusts the
MV according to the parameter values defined in the P, I and D
parameters.
Example: Function block diagram to control temperature
This function block diagram shows the predefined and user-defined function
blocks used in the application to control temperature in a control zone.
See also
Example: How to create an IPIDController program to control water

supply level on page 589
Example: How to create an The water supply level control program example maintains sufficient water in a
IPIDController program to control water supply tank that has an outflow. A solenoid valve controls incoming water
water supply level and fills the tank at a preset rate; outflowing water is also controlled at a preset
rate.
Program example information
The water supply level program example includes the following information.

The sequence of events that occur in the control process

How the setpoint, process and manipulated values are used in the control
program
An example function block diagram that shows the IPIDController and
other instruction blocks
Setpoint, process and manipulated values
The following table defines how the SP, PV, and MV values are used in the water
supply level program.
Item Description
Setpoint (SP) Measurement of height that defines the target water supply level.
Process value (PV) The 4-20mA must be converted to the same unit as the SP, which is a measurement of
height.
Manipulated value (MV) Must be converted to an analog value so it can be output to the drive to control the
pump.
Water supply level system
The following diagram shows the components in the water supply level system
that are controlled by the water supply level program. The table following the
diagram describes the events that occur when the control program runs.
Sequence of events in water supply level system
The following table identifies the components in the water supply system and
describes, in sequence, the events that occur in the system when the water supply
level program runs.
No Item Description
Controller Sends the MV to the PowerFlex drive (0-10V).
output

No Item Description
PowerFlex drive Controls the water pump (0-50Hz).
Water pump Controls the water level in the supply tank.
Output transfer Measures the height of the water supply level (4-20mA) and sends the PV to the controller.
device
Controller input Receives the PV (water supply level of 4-20mA).
PLC program Converts the PV to the same unit as the SP (measurement of height) and determines the
difference between the PV and SP and adjusts the MV according to the parameter values
defined in the P, I and D parameters.
Example: Function block diagram to control water supply level
The following function block diagram shows the predefined and user-defined
function blocks for the program to control the water supply level.
Function blocks and UDFBs used in the water level FBD
This application, developed in the Function Block Diagram (FBD) language, uses
the instructions described in the following table.

IPIDController function Provides PID process control.
block


IPIDController function Provides PID process control.
block
PID_OutputRegulator Regulates the output of the IPIDCONTROLLER within a safe range to ensure the hardware
UDFB used in the process is not damaged.
Sample code:
IF RMIN RIN RMAX, then ROUT = RIN,
IF RIN < RMIN, then ROUT = RMIN,
IF RIN > RMAX, then ROUT = RMAX
PID_Feedback UDFB Acts as a multiplexer.
Sample code:
IF "FB_RST" is false, FB_OUT=FB_IN;
If "FB_RST" is true, then FB_OUT=FB_PREVAL.
PID_PWM UDFB Provides a PWM function, converting a real value to a time related ON/OFF output.
SIM_WATERLVL UDFB Simulates the process in the application example.
See also
Example: How to create an IPIDController program to control

temperature on page 587
PID An output instruction that controls physical properties such as temperature,

pressure, liquid level, or flow rate using process loops.
(proportional-integral-deri
vative) Operation details:
When enabled, PID controls the process using the input parameters
including SP and Gains of the PID controller.
Run to Program mode transition, the PID instruction is disabled, parameter
values are retained.
Program to Run mode transition, the PID instruction remains disabled
until a user resets Enable to true.

Text.


Type
Enable Input BOOL Enable instruction.
TRUE - Start execution with the current input parameters.
FALSE - PID does not execute. Set CV to 0, and calculate AbsoluteError.
PV Input REAL Process Value. This value is typically read from an analog input module.
The SI unit must be the same as Setpoint.
SP Input REAL The set point value for the process.
AutoManual Input BOOL Auto or manual mode selection.
TRUE - CV is controlled by PID.
FALSE - PID is running and CV is controlled by CVManual input.
CVManual Input REAL Control value input defined for manual mode operation.
The valid range for CVManual is:
CVMin < CVManual < CVMax
CVMin Input REAL Control value minimum limit.
If CV < CVMin, then CV = CVMin.
If CVMin > CVMax, an error occurs.
CVMax Input REAL Control value maximum limit.
If CV > CVMax, then CV = CVMax.
If CVMax < CVMin, an error occurs.
Gains Input PID_GAINS Gains of PID for controller.
Use the PID_GAINS data type to configure the Gains parameter.
Control Input BOOL Control direction of the process:
TRUE - Direct acting, such as Cooling.
FALSE - Reverse acting, such as Heating.


Type
Active Output BOOL Status of the PID controller.
TRUE - PID is active.
FALSE - PID is stopped.
CV Output REAL The control value output.
If any error occurred, CV is 0.
AbsoluteError Output REAL Absolute error is the difference between process value (PV) and set
point (SP) value.
TRUE - Operation encountered an Error.
FALSE - Operation completed successfully or the instruction is not
executing.
ErrorID Output USINT A unique numeric that identifies the error. The errors are defined in PID
error codes.
PID_GAINS data type
The following table describes the PID_GAINS data type for the PID instruction.

Type Type
Kc Input REAL Controller gain for PID.
Proportional and Integral are dependent on this gain. (>= 0.0001).
Increasing Kc improves response time but also increases overshoot and
oscillation of the PID.
If Kc is invalid, an error occurs.
Ti Input REAL Time integral constant in seconds (>= 0.0001).
Increasing Ti decreases the overshoot and oscillation of the PID.
If Ti is invalid, an error occurs.
Td Input REAL Time derivative constant in seconds (>= 0.0).
When Td equals 0, there is no derivative action and PID becomes a PI controller.
Increasing Td reduces the overshot and removes the oscillation of the PID
controller.
If Td is invalid, an error occurs.
FC Input REAL Filter constant (>= 0.0). Recommended range for FC is 0 to 20.
Increasing FC smooths the response of the PID controller.
If FC is invalid, an error occurs.

PID error codes
Use this table to determine the PID error codes and descriptions.
0 PID is working normally.
1 Kc is invalid.
2 Ti is invalid.
3 Td is invalid.
4 FC is invalid.
5 CVMin > CVMax or CVMax < CVMin
6 CVManual < CVMin

CVManual is invalid.
7 CVManual > CVMax
CVManual is invalid.
PID Function Block Diagram example

PID Ladder Diagram example
PID Structured Text example

PID Results
See also
PID instruction timing diagrams on page 598
PID instruction state machine on page 597
Proportional Integral Derivative (PID) instructions on page 565
PID instruction state machine The PID State Machine diagram describes the processing states for the PID
instruction.

See also
PID instruction on page 592
PID instruction timing diagrams on page 598
PID instruction timing diagrams The following timing diagram examples describe execution scenarios for the PID
(proportional-integral-derivative) instruction.
Successful PID execution

Input parameters are valid.
Active bit is TRUE.
Error bit is FALSE.
2,3,4 No change in Rung condition.
Updates PID output parameters.

5, 9 Rung condition becomes FALSE when:

Clears PID output parameters except AbsoluteError.
AbsoluteError calculates based on PV and SP input values.
6, 7, 10, 11 No change in Rung condition.
PID execution with Error

Input parameters are invalid.
Active bit is FALSE.
Error bit is TRUE. ErrorID output is set.
CV output is set to 0.


PID execution with Error then successful execution


Active bit is FALSE.
2 No change in Rung condition.
3, 4 No change in Rung condition.
Active bit is TRUE.
Error bit is FALSE.

Successful PID execution and Error

Active bit is TRUE.
Error bit is FALSE.
Update PID output parameters.
Update PID output parameters.
3, 4 No change in Rung condition.
Clear PID output parameters except AbsoluteError.


See also
PID on page 592
PID instruction state machine on page 597

Chapter 21
Real Time Clock (RTC) instructions
Use Real Time Clock instructions to configure the calendar and the clock.
RTC_READ on page 412 Reads the real-time clock (RTC) module information.
RTC_SET on page 414 Sets real-time clock data to the RTC module information.
See also
RTC_READ ( read real-time Reads the real-time clock (RTC) module information.
clock) Operation details:
Micro810 or Micro820 controller with embedded RTC:

RTCBatLow is always set to zero (0).
RTCEnabled is always set to one (1).
When the embedded RTC has lost its charge/memory due to loss of power:
RTCData is set to 2000/1/1/0/0/0.
RTCEnabled is set to one (1).

Text.

controllers.

Chapter 21 Real Time Clock (RTC) instructions

Type
TRUE - execute RTC information read.
FALSE - there is no read operation and output RTC data is invalid.
RTCData Output RTC RTC data information: yy/mm/dd, hh/mm/ss, week.
RTCData output is defined using the RTC data type.
RTC data type

type
2000 (Jan 01, 00:00:00) to
2098 (Dec. 31, 23:59:59)
RTC_READ Function Block Diagram example

Real Time Clock (RTC) instructions Chapter 21
RTC_READ Ladder Diagram example
RTC_READ Structured Text example
See also
RTC_SET (set real-time Set RTC (real-time clock) data to the RTC module information.
clock) Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.


controllers.

Type
TRUE - execute RTC_SET with the RTC information from
input.
FALSE - there is no read operation and output RTC data is
invalid.
RTCEnable Input BOOL TRUE - To enable RTC with the RTC data specified.
FALSE - To disable RTC.
This input is ignored by Micro810 and Micro820 controllers.
RTCData Input RTC RTC data information: yy/mm/dd, hh/mm/ss, week as
defined in the RTC data type.
RTCData is ignored when RTCEnable = 0.
Sts Output USINT The read operation status.
RTC_Set status (Sts) values:
0x01 - RTC set operation success.
0x02 - RTC set operation fails.
RTC data type

Real Time Clock (RTC) instructions Chapter 21

type
2000 (Jan 01, 00:00:00) to
2098 (Dec. 31, 23:59:59)
RTC_SET Function Block Diagram example
RTC_SET Ladder Diagram example

RTC_SET Structured Text example
See also

Chapter 22
Socket instructions
Use the Sockets protocol for Ethernet communications to devices that do not
support Modbus TCP and EtherNet/IP. Sockets support client, server,
Transmission Control Protocol (TCP), and User Datagram Protocol (UDP).
Typical applications include communicating to printers, bar codes readers, and
personal computers.
Socket instruction behavior in Run Mode Change mode:
If a delete operation is performed on a SOCKET_OPEN,

SOCKET_ACCEPT, SOCKET_READ, or SOCKET_WRITE
instruction while in Run Mode Change mode, the Socket instance is
deleted.
In Run Mode Change mode, any change to a SOCKET_READ input
while operating in the BUSY state results in an error and the received
packet is discarded. SOCKET_READ input parameters are: Length, Offset,
Data Array Size, Data Array Variable.
SOCKET_READ is the only SOCKET instruction that supports add or
modify operations while in Run Mode Change mode.
If the Ethernet IP settings are modified using Run Mode Change all
created Socket instances are deleted, similar to SOCKET_DELETEALL.
Instruction Processing and Output Updates for Socket instructions:
Asynchronous: Respective instructions where all outputs update

asynchronously with user program scan, for example a Ladder scan.
Asynchronous output can not be used for edge trigger detection.
Asynchronous output parameters are not locked and can be updated after
completion of respective socket instructions.
Synchronous: Respective instructions where all output update is in sync
with user program scans. Synchronous output parameters are locked and
can not be modified after completion of respective socket instruction.
Hybrid: Respective instructions where a few outputs update in sync with
user program scan. Remaining outputs update asynchronously with user
program scan.

Chapter 22 Socket instructions
Immediate Instruction Execution: Instruction completes desired function

prior to going to next instruction.
Non-Immediate Instruction Execution: Instruction takes more than one
program scan to complete desired function. Instructions take a snap shot of
input parameters when a False > True transition is detected.
Use this table to help determine Socket instructions usage.
Instruction Description TCP TCP UDP UDP Instruction Instructio

Client Serve with withou Processing n Output
r Open t Open Update
SOCKET_ACCEPT Accepts a TCP connection NO YES NO NO Non-Immediat Hybrid
on page 613 request from a remote e
destination and returns a
socket instance used to send
and receive data on the
newly created connection.
SOCKET_CREATE Creates an instance of the YES YES YES YES Immediate Synchronou
on page 616 socket and returns an s
instance number that is used
as an input in any follow-on
socket operations.
SOCKET_DELETE Deletes a created socket YES YES YES YES Non-Immediat Synchronou
on page 621 instance. e s
SOCKET_DELETEALL Deletes all created socket YES YES YES YES Non-Immediat Synchronou
on page 624 instances. e s
SOCKET_INFO Returns information for the YES YES YES YES Immediate Synchronou
on page 626 socket such as error codes s
and execution status.
SOCKET_OPEN Opens the connection for the YES NO YES NO Non-Immediat Synchronou
on page 633 specified destination address e s
for Transmission Control
Protocol (TCP) connections.
For User Datagram Protocol
(UDP) connections,
associates a destination IP
address and port number
with the specified socket.
SOCKET_READ Reads data on a socket YES YES YES YES Non-Immediat Hybrid
on page 637 e
SOCKET_WRITE Sends data on a socket. YES YES YES YES Non-Immediat Hybrid
on page 642 e
See also
Socket instruction timing diagrams on page 653
Socket instruction transaction diagrams on page 660

Socket instructions Chapter 22
State machine diagrams for TCP on page 663
State machine diagrams for UPD on page 666
SOCKET_ACCEPT For Transmission Control Protocol (TCP) connections only. Accepts a TCP
connection request from a remote destination and returns a Socket Instance used
to send and receive data on the newly created connection.
Operation details:
Before executing Socket_Accept execute SOCKET_CREATE and specify

the local port number for the accept connection.
Outputs are updated synchronously from the program scan.

Text.

type
FALSE - no Rising Edge detected, instruction block not started.
Instance Input UDINT Identifies the socket instance. Copy the returned Socket Handler from
the SOCKET_CREATE instruction.
Timeout Input UDINT Timeout for the SOCKET_ACCEPT instruction block instances. The
function block returns an Error if the timeout value is less than
minimum value.
Timeout range: 1000- 86400000 milliseconds
Set Timeout to 0 to use the default value 10000 (10 Second).


type
Done Output BOOL Indicates when operation is complete.
TRUE - operation completed successfully.
FALSE - operation is in progress or encountered an error condition.
Busy Output BOOL TRUE - the operation is not finished.
FALSE - the operation is finished.
FALSE - No error.
Status Output SOCK_STATUS Status is defined using the SOCK_STATUS data type which contains
ErrorID, SubErrorID, and StatusBits information.
AcceptInst Output UDINT Contains the Accept Instance for this Socket Instance. Use the unique
Accept Instance number with subsequent SOCKET_READ and
SOCKET_WRITE for this connection.
AcceptAddr Output SOCKADDR_CF A data structure that contains the Accept Address for the
G socket. To specify an IP Address of 192.168.2.100 and Port =
12000:
AcceptAddr.IPAddress[0]=192
AcceptAddr.Port = 12000
SOCKET_ACCEPT Function Block Diagram example

SOCKET_ACCEPT Ladder Diagram example
SOCKET_ACCEPT Structured Text example

Results
TCP Server
See also
Socket instructions on page 611
SOCK_STATUS data type on page 647
Socket instruction status bits on page 652
Socket error codes on page 647
SOCKADDR_CFG data type on page 646
SOCKET_CREATE Creates an instance of the socket and returns an instance number that is used as an
input in any follow-on socket operations.
Operation details:
Socket instructions support Full Duplex communication with remote

devices.
User Datagram Protocol (UDP) connections supports a maximum of eight
queued UDP datagrams packets. The queue contains the most recent
packets.
Micro820 and Micro850 controllers at revision 9 or higher support up to
eight Socket Instances. The Socket instances support UDP and TCP
Sockets:

Use all eight instances for client Transmission Control Protocol (TCP)
connections.
Use all eight instances to listen for incoming TCP connections and
then accept eight connections from other devices.
Perform both TCP client and server operations.
Perform both TCP and UDP operations.
To accept incoming TCP connections to the same port, create a new Socket
Instance.
TCP Connection Loss:
User application program should detect the loss of TCP connections
and handle the event. Depending on the user application, consider the
option to Fault the controller.

Text.

type
FALSE - no Rising Edge detected.
Type Input USINT Specify the Type of Socket:
1 - Transmission Control Protocol (TCP).
2 - User Datagram Protocol (UDP).


type
SockAddr Input SOCKADDR_CFG Specify the address configuration for the socket.
The EtherNet/IP module to choose the local port number, set SockAddr
to 0.
Specify the local port number where an application is listening and
receiving, or :
Array elements must all be zero
For TCP client operations, specify 0 unless you want a specific local
port number.
For TCP server communication, specify the port number to accept
incoming connection requests.
For UDP, specify a local port number to receive datagrams on a
specific port.
Local port range: 1 to 65535.
An error occurs if the specified local port number is already in use by
the Micro820 or Micro850 controller.
The controller uses the following port numbers:
TCP Ports:
EtherNet/IP: 44818
ModbusTCP: 502
DHCP Server: 67
DHCP Client: 68
UDP Ports:
EtherNet/IP: 2222
DHCP Server: 67
DHCP Client: 68
See SOCKADDR_CFG data type.
Timeout Input UDINT Specify the Timeout for Socket inactivity.
If a socket instance does not receive any requests within the specified
inactivity timeout, the socket instance is deleted.
If a request is sent after the sock instance is deleted an error, Socket
instance not supported, is returned.
The instruction block returns an error when the timeout value is less
than the minimum value.
Set Timeout so it is longer than the longest interval between socket
operations. If the inactivity Timeout is too short socket instances may
timeout. Timeout range: 1000 - 86400000 milliseconds
Set Timeout to 0 to use the default value

300000 (5 minutes).

FALSE - No error.


type
See SOCK_STATUS data type, Socket instruction status bits, and Socket
error codes.
Instance Output UDINT Contains Socket Handler.
Use the Instance parameter for subsequent Socket instructions.
SOCKET_CREATE Function Block Diagram example
SOCKET_CREATE Ladder Diagram example

SOCKET_CREATE Structured Text example
Results
TCP Client example
TCP Server example

UDP example
See also
Socket instruction transaction diagrams on page 660
SOCKET_DELETE Deletes a created socket instance. For Transmission Control Protocol (TCP)
connections, SOCKET_DELETE also closes (Passive Close) the connection
before deleting the instance. Outputs are updated synchronously from the
program scan.

Text.


type
Instance Input UDINT Copy the returned Socket Handler from a SOCKET_CREATE or
SOCKET_ACCEPT instruction to delete the respective socket.
For UDP and TCP Client Socket types, copy the returned Socket Handler
from a SOCKET_CREATE instruction.
For TCP Server socket type, copy the returned Socket Handler from a
SOCKET_ACCEPT instruction.
FALSE - No error.
Status Output SOCK_STATU Status is defined using the SOCK_STATUS data type which contains ErrorID,
S SubErrorID, and StatusBits information.
SOCKET_DELETE Function Block Diagram example

SOCKET_DELETE Ladder Diagram example
SOCKET_DELETE Structured Text example
Results
See also

SOCKET_DELETEALL Deletes all created socket instances.
Operation details:
If the Ethernet cable is disconnected from the controller or the controller IP

address changes, you can execute SOCKET_DELETEALL to delete all
previously created socket instances.
Outputs are updated synchronously from the program scan.

Text.

type
Error Output BOOL This field is set to TRUE when the function block execution encounters an
error condition. For more information refer to Socket error codes.
Output is updated synchronously from the program scan.

SOCKET_DELETEALL Function Block Diagram examples
SOCKET_DELETEALL Ladder Diagram examples
SOCKET_DELETEALL Structured Text example

Results
See also
SOCKET_INFO Returns information for a socket instance such as error codes and execution status.
Outputs update synchronously from the program scan.

Text.


type
SOCKET_ACCEPT instruction to delete the respective socket.
For UDP and TCP Client Socket types, copy the returned Socket
Handler from a SOCKET_CREATE instruction.
For TCP Server socket type, copy the returned Socket Handler from
a SOCKET_ACCEPT instruction.
When Instance is 0, returns a summary of all Socket Instances.
ClrDiagCnt Input BOOL TRUE - clear Transmission Control Protocol (TCP) or User Datagram
Protocol (UDP) Diagnostics counter information.
FALSE - no clearing of TCP or UDP counter information.
Such as TCP and UDP, OtherInfo Array Index 1 to 6.
When Instance is 0, clear OtherInfo Array Index 7 to 14.


type
FALSE - No error.
SocketType Output USINT Socket Instance type:

0 - Not used
1 - TCP
2 - UDP
When Socket_Info Instance is 0, SocketType displays as 0.
StreamType Output USINT Socket Stream type:
0 - None
1 - TCP Server
2 - TCP Client
When Socket_Info Instance is 0, StreamType displays as 0.
TxQueCnt Output USINT Number of Tx messages currently in the queue.
When Socket_Info Instance is 0, TxQueCnt displays as 0.
RxQueCnt Output USINT Number of Rx messages currently in the queue.
When Socket_Info Instance is 0, RxQueCnt displays as 0.
SocketState Output USINT Socket Instruction State information. For more information refer to
Socket State Machine.
When Socket_Info Instance is 0, SocketState displays as 0.
LocalAddr Output SOCKETADDR_CFG Local address for the socket. For more information refer to
SOCKADDR_CFG data type.
When Socket_Info Instance is 0, LocalAddr displays as 0.
RemoteAddr Output SOCKETADDR_CFG Remote address for the socket. For more information refer to
SOCKADDR_CFG data type.
RemoteAddr displays as 0, in the following cases:
Socket_Info Instance is 0
User Datagram Protocol (UDP) connections without
SOCKET_OPEN
UDP with SOCKET_OPEN and disabled RxFilter.


type
OtherInfo UDINT[1..15] Socket Instance configured as TCP, Array Index Description is:
1 - Packet Sent: Total number of TCP Packets sent on a Socket.
2 - Bytes Sent: Total number of TCP bytes sent on a Socket.
3 - Packet Received: Total number of TCP packets received on a
Socket.
4 - Bytes Received: Total number of TCP bytes received on a Socket.
5 - Retransmit Packets: Total number of TCP packet
retransmissions.
6 - Checksum Errors: Total number of TCP Packets with Checksum
errors on a Socket.
7 - TCP State: Current state of a Socket.
8 - Receive Queue Count: Total number of queued TCP packets on a
Socket.
9 - Transmit queue depth: Total number of transmit packets
queued and waiting for ACK.
10 - Current Tx Window: Current Transmit window size.
11 - Current Rx Window : Current receive window size.
(8 to 11) - OtherInfo is not supported for TCP, displays as 0.
12 ,13,14,15 - Displays as 0.
Socket Instance configured as UDP, Array Index Description is:

1 - Packet Sent: Total number of UDP packets sent on a Socket.
2 - Bytes Sent: Total number of UDP bytes sent on a Socket.
3 - Packet Received: Total number of UDP packets received on a
Socket.
4 - Bytes Received: Total number of UDP bytes received on a
Socket.
5 - Packets Dropped: Total number of UDP received packets
dropped for a Socket due to exceeding the maximum queue size
limit of 8.
6 - Checksum Errors: Total number of UDP packets with checksum
errors on Socket.
7 to 15 - Display as 0.
Socket Instance configured as 0, Array Index Description is:
1 - Count for Socket Instance Available. Maximum number of
sockets supported.
2 - Count for Socket Instance Used. Number of sockets created
successfully.
3 - Number of Socket instances created as TCP.
4 - Number of socket instances created as TCP Client.
5 - Number of socket instances created as TCP Server.
6 - Number of Socket instances created as UDP.
7 - SOCKET_READ Success count when Socket Instance is
configured as TCP.
8 - SOCKET_WRITE Success count when Socket Instance is
configured as TCP.
9 - SOCKET_READ Failure count when Socket Instance is configured
as TCP.
10 - SOCKET_WRITE Failure count when Socket Instance configure
as TCP.
11 - SOCKET_READ Success count when Socket Instance configure
as UDP.
SOCKET_INFO Function Block Diagram example

SOCKET_INFO Ladder Diagram example

SOCKET_INFO Structured Text example
Results
See also

SOCKET_OPEN Opens the connection for the specified destination address for Transmission
Control Protocol (TCP) connections. For User Datagram Protocol (UDP)
connections, associates a destination IP address and port number with the
specified socket.
Operations details:
For User Datagram Protocol (UDP) connections using SOCKET_OPEN

the IP address and port number are not required each time data is sent.
For UDP connections not using SOCKET_OPEN, the destination address
must be specified each time SOCKET_WRITE is used to send data.
When using SOCKET_READ, in addition to receiving data, the address of
the sender is returned. The senders address can be used to send a response
using SOCKET_WRITE.
A SOCKET_OPEN operation might return before the timeout period
without creating a Transmission Control Protocol (TCP) connection. This
might occur if the destination device is running but is not listening for
connections on the specified port number, SOCKET_OPEN returns with
an error before the timeout period.

Text.

r type


r type
Instance Input UDINT Copy from the returned Socket Handler from a SOCKET_CREATE function
block.
Timeout Input UDINT Timeout for SOCKET_OPEN function block.
The function block returns an Error if the Timeout value is less than the
minimum value.
Timeout range: 1000 and 1800000 milliseconds

DestAddr Input SOCKADDR_CFG The address of the destination connection.

A connection between the IP address and the port number of remote
host is required.
The following IP Addresses are not supported for DestAddr:
Self IP Address
Loop back address
0.0.0.0
Broadcast address (Only supported for TCP)
Example for IP Address of 192.168.2.100 and Port 12000:

DestAddr.IPAddress[0]=192
DestAddr.Port = 12000
EnUDPRxFilte Input BOOL For UDP socket, when SOCKET_OPEN and Enable EnUDPRxFilter are
r used, a packet filter for specific IP Address and port number is not
needed each time to read data.
A UDP socket with open is created. DestAddr as IP 192.168.1.157 /
Port 161. EnUDPRxFilter Enable, perform Socket_Read.
When controller receive data from DestAddr (192.168.1.157 /
161), Socket_Read completes the operation successfully. If
controller receives data from any other IP or Port then socket_Read
ignores that packet and waits for DestAddr Packet.
EnUDPRxFilter Disabled:
Perform SOCKET_READ. The controller receives any data on
configure UDP port, SOCKET_READ completes operation successfully.
The application checks whether the incoming packet arrives from
the expected device or not.
The application handles filtering based on the SOCKET_READ output
parameter UDPAddr.


r type
FALSE - No error.
SOCKET_OPEN Function Block Diagram example
SOCKET_OPEN Ladder Diagram example
SOCKET_OPEN Structured Text example

Results
TCP example
UDP example
See also

SOCKET_READ Reads data on a socket and returns the specified number of bytes. For
Transmission Control Protocol (TCP), returns when any data is received, up to
the requested number of bytes. For User Datagram Protocol (UDP), completes
when a datagram is available.
Operation details:
The following SOCKET_READ behavior might impact existing communications

including non-socket communication.
If the SOCKET_READ operation is not executed in sync with the remote

device then, the controller holds the remote device receive packet until one
of the following occurs:
SOCKET_READ is executed.
Socket Timeout expires.
RST is received from a remote device.
SOCKET_DELETE or SOCKET_DELETEALL is executed.
User performs a Run Mode Change which deletes all created Socket
instances.
Controller changes from run mode to program mode which deletes all
created Socket instances.
Controller changes from run mode to program mode which clears
socket Diagnostic counter information and individual Socket counter
information.
If the Length or Offset parameter value is changed while the
SOCKET_READ operation is ongoing (BUSY = True) an error occurs and
the receive packet is discarded.
The SOCKET_READ instruction might return fewer bytes than were
requested. RxLength contains the number of bytes of data received. Write
programs to check RxLength and then issue additional read requests to
receive an entire application message.
In Run Mode Change mode, changing a SOCKET_READ input while
operating in the BUSY state results in an error and the received packet is
discarded.

Text.

This instruction applies to Micro820 and Micro850 controllers.

type
TRUE - Rising Edge detected, start the instruction with the precondition
that the last operation is complete.
FALSE - do not start instruction.
Instance Input UDINT Copy from the returned Socket Handler from a SOCKET_CREATE or
For UDP and TCP Client Socket types, copy the returned Socket Handler
from a SOCKET_CREATE instruction.
For TCP Server Socket type, copy the returned Socket Handler from a
Timeout Input UDINT Timeout for SOCKET_READ. The instruction block returns an Error if the
timeout value is less than the minimum value.
Timeout range: 1000- 86400000 milliseconds
Length Input UINT Defines the number of bytes to read.
Check RxLength for the actual number of bytes read. SOCKET_READ can
return fewer bytes than requested.
Supports up to 256 bytes.
Offset Input UNIT Offset into array of Data. Start reading data read from this location.
Data Output USINT[1..1] An Array used to store the data read from SOCKET_READ.
Data array size must be >= (Offset + Length).
Data array can be bigger than socket read Length.
Output is updated asynchronously from the program scan.


type
FALSE - No error.
RxLength Output UNIT Contains the number of data bytes received.
UDPAddr Output SOCKADDR_CFG The address of the device sending User Datagram Protocol (UDP) data.
Example defines a UDPAddr of 192.168.2.100 and Port 12000:

UDPAddr.IPAddress[0]=192
UDPAddr.Port = 12000
For Transmission Control Protocol (TCP), this structure is not used and
contain all zeros. The TCP connection conveys the remote address
information.
SOCKET_READ Function Block Diagram example

SOCKET_READ Ladder Diagram example
SOCKET_READ Structured Text example

Results
TCP example:
UDP example:
See also

SOCKET_WRITE Sends data on a socket.
Operation details:
SOCKET_WRITE attempts to send the requested number of data bytes

specified in the Length parameter. When the send operation completes
SOCKET_WRITE returns the number of data bytes written to the
TxLength parameter.
Output is updated asynchronously from the program scan.

Text.

type
For UDP and TCP-Client Socket types, copy the returned Socket
Handler from a SOCKET_CREATE instruction.
For TCP- Server socket type, copy from returned Socket Handler
from a SOCKET_ACCEPT instruction.


type
Timeout Input UDINT Timeout for SOCKET_WRITE instances. The instruction returns an Error
if the Timeout value is less than minimum value.
Timeout range: 1000 to 1800000 milliseconds
UDPAddr Input SOCKADDR_CFG The UDP destination address that the data is being written to when a
SOCKET_OPEN instruction has not been executed since creating the
socket. For TCP, or when the SOCKET_OPEN instruction has been
executed for UDP, this structure is not used and should contain all
zeros. The TCP connection and the SOCKET_OPEN instruction for UDP
convey all of the remote address information.
Example for a UDPAddr of 192.168.2.100 and Port 12000:
UDPAddr.Port = 12000
Use the SOCKADDR_CFG data type to define UDPAddr.
Data Input USINT[1..1] An Array used to store the data write to respective socket instance
using the SOCKET_WRITE Instruction.
Data array size must be >= (Offset + Length).
Data array can be bigger than SOCKET_WRITE Length.
Length Input UINT The number of bytes of data to write.

Maximum is 256 bytes.
Offset Input UNIT Offset into array of Data. The data write from the SOCKET_WRITE is
starting from this location.
FALSE - No error.
TxLength Output UNIT The number of bytes of written data.

SOCKET_WRITE Function Block Diagram example
SOCKET_WRITE Ladder Diagram example
SOCKET_WRITE Structured Text example

Results
TCP example:
UDP without open example:

UDP with open example:
See also
SOCKADDR_CFG data type The following table describes the SOCKADDR_CFG data type.
Port UINT Specify a local port number on which an application is listening and receiving.
IP Address[4] USINT Specify an IP address.
Example for an IP Address of 192.168.2.100:

IPAddress[0]=192
IPAddress[1]=168
IPAddress[2]=2
IPAddress[3]=100
See also

SOCK_STATUS data type The following table describes the SOCK_STATUS data type.
ErrorID UINT Error Code Value.
SubErrorID UINT Sub Error Code Value.
StatusBits UINT Execution Status bits for Socket instructions.
See also
Socket error codes The following table describes the status error codes for Socket instructions.
ErrorID SubErrorID Error description Corrective action

code code
0 The Socket instruction successfully completed
operation.
1 The Socket instruction is pending.
2 The Socket Instance is not available. Confirm the Socket Instance is not deleted
or the Timeout value exceeded.
3 The SOCKET_DELETEALL operation is ongoing. Wait for the pending SOCKET_DELETEALL
operation to complete.
4 1 Illegal Parameter, Invalid Channel. No action. Reserved for future use.
4 2 Illegal Parameter, Invalid Socket IP Address. Change to a valid IP Address.

Error occurs when:
SOCKET_CREATE contains a SockAddr with
any non-zero value.
SOCKET_OPEN or SOCKET_WRITE execute
with an invalid target IP Address. Invalid
target IP Addresses are:
Self IP Address
0.0.0.0
Loop back Address (127.x.x.x)
Class D Multicast Address (224.x.x.x)
Local Link Address (169.254.x.x)
Broadcast Address (Only applicable
for TCP Socket Instance)


code code
4 3 Illegal Parameter, Invalid Socket Port Address. Change the Port Address.
Error occurs when the following Ports are
specified in SOCKET_CREATE, SOCKET_OPEN, or
SOCKET_WRITE:
TCP Ports
44818 - EtherNet/IP
502 -ModbusTCP
67 - DHCP Server
68 - DHCP Client
0 - Invalid Port
UDP Ports
2222 EtherNet/IP
67 DHCP Server
68 DHCP Client
0 Invalid Port
4 4 Illegal Parameter, Invalid Socket Type. Change Socket Type.
Valid Socket Types are:
TCP - 1
UDP - 2
4 5 Illegal Parameter, Invalid Socket Timeout value. Change the Timeout value to a valid value.
Valid Timeout values are:
SOCKET_CREATE, SOCKET_ACCEPT, and
SOCKET_READ:
0 (Default), or any value between
1000 and 86400000ms.
SOCKET_OPEN and SOCKET_WRITE:
0 (Default), or any value between
1000 and 1800000ms.
6 Illegal Parameter, Invalid Socket Instance. Use the Instance Number returned in
TCP Server Socket Type: SOCKET_CREATE and SOCKET_ACCEPT
instructions after successful execution.
Use the Socket Instance returned in
SOCKET_ACCEPT for
SOCKET_WRITE, SOCKET_READ,
SOCKET_DELETE, and
SOCKET_INFO.
UDP Socket and TCP Client Socket Types:
Use the Socket Instance returned in
SOCKET_CREATE for
SOCKET_OPEN, SOCKET_WRITE,
SOCKET_READ, SOCKET_DELETE,
and SOCKET_INFO.
4 7 Illegal Parameter, Invalid Array Length. Increase the size of the array used to
contain the Socket read and write data.
4 8 Illegal Parameter, Invalid Array Dimension. Use single dimensional array to contain the
Socket read and write data.


code code
5 Socket request to cancel operation. Restart the Socket operation based on
Error occurs when: Socket Type. Refer to the respective State
Machine to restart Socket operation.
Ethernet Link is Disabled or Ethernet Cable is
Disconnected
SOCKET_DELETE operation is performed when
SOCKET_OPEN, SOCKET_ACCEPT,
SOCKET_READ, or SOCKET_WRITE operation
are in progress.
Run Mode Change operation is performed
when SOCKET_OPEN, SOCKET_ACCEPT,
are in progress.
IP Address Collision detected when
SOCKET_OPEN, SOCKET_ACCEPT,
are in progress.
6 1 Illegal Socket Sequence, Socket Open Operation Use single SOCKET_OPEN execution for
in progress or Connected. respective Socket Instance. Do not perform
Error occurs when: SOCKET_ACCEPT operation for same socket
instance.
SOCKET_OPEN is in progress (BUSY State) and
user executes another SOCKET_OPEN instance
with same socket instance.
SOCKET_OPEN is in progress (BUSY State) and
user executes SOCKET_ACCEPT with same
socket instance.
6 2 Illegal Socket Sequence, Socket Accept Operation Use single SOCKET_ACCEPT execution for
In progress or Connected. respective Socket Instance. Do not perform
Error occurs when: SOCKET_OPEN operation for same socket
instance.
SOCKET_ACCEPT is in progress (BUSY State)
and user executes another SOCKET_ACCEPT
instance with same socket instance.
SOCKET_ACCEPT is in progress (BUSY State)
and user executes SOCKET_OPEN with same
socket instance.
6 3 Illegal Socket Sequence, Socket configured as TCP
Client.
6 4 Illegal Socket Sequence, Socket configured as TCP
Server.
6 5 Illegal Socket Sequence, Socket is Connected. Make sure the Socket is not already
connected with a remote device before
executing SOCKET_OPEN or
SOCKET_ACCEPT again.
6 6 Illegal Socket Sequence, Socket configured as Make sure UDP Socket Instances are not
UDP. used with SOCKET_ACCEPT.
6 7 Illegal Socket Sequence, Socket is not connected. Confirm that Socket is connected with the
target.
7 Socket Instance Timeout. Configure Timeout values for
SOCKET_ACCEPT, SOCKET_OPEN,
SOCKET_READ, and SOCKET_WRITE
accordingly.


code code
8 The Socket module is not initialized. Make sure the Ethernet Link is Enabled or
Ethernet Cable of Controller is connected to
the Network or resolve Controller IP
Address conflict.
9 1 Socket Instruction Fatal Error, Socket Instance
Missing.
9 2 Socket Instruction Fatal Error, Invalid Socket
Instance.
9 3 Socket Instruction Fatal Error, Invalid Lock Socket
Instance.
9 4 Socket Instruction Fatal Error, Invalid Socket Type.
9 5 Socket Instruction Fatal Error, Missing Cancel
Handler.
10 1 Socket background processing Error, Address in
Use.
10 2 Socket background processing Error, UDP Make sure the SOCKET_READ Length is
Received a Large Packet and the Packet is larger equal to greater than the received packet
than Socket Read length. size. Max read size is recommended. Max
size for SOCKET_READ is 256.
10 3 Socket background processing Error, TCP Receive Make sure the SOCKET_READ Length is
Large packet. Packet received is larger than the equal to greater than the received packet
Socket Read length. size. Since client may send up to the
receive window size of 256, 256 is
recommended.
10 4 Socket background processing Error, Received RST Restart Controller TCP Client or Server as
or Disconnect from Remote Device. shown in the State Diagram. Verify the
Target device that sent RST and make sure
the Target is restarted with correct state.
10 5 Socket background processing Error, UDP Packet
received from different device, drop packet.
Reserved for future.
10 6 Socket background processing Error, Queue is full. Wait for SOCKET_READ and
Error occurs when: SOCKET_WRITE queue availability for
respective Socket instance.
SOCKET_READ or SOCKET_WRITE execute four
instructions for the same Socket instance in
same scan.
Perform a SOCKET_READ when four
SOCKET_READ instructions are in BUSY state
for same Socket instance.
10 7 Socket background processing Error, When the SOCKET_READ state is BUSY, do
SOCKET_READ Parameter change (Length, Offset, not modify the input parameters.
Data Array Size, and Data Array Variable).
11 1 Socket background processing Fatal Error, Missing
data pointer.
11 2 Socket background processing Fatal Error, Missing
Session Pointer.
11 3 Socket background processing Fatal Error, Invalid
TCP or UDP Socket pointer.


code code
Socket Instance Type.
11 5 Socket background processing Fatal Error, Socket
Instance Missing.
Socket Instance.
Socket State.
Socket Type.
11 9 Socket background processing Fatal Error, TCP
delete Failure.
11 10 Socket background processing Fatal Error, UDP
delete Failure.
128 1 No packet available for disconnect message.
128 2 Not enough room to pre-pend the TCP header.
128 3 Packet append pointer is invalid.
128 7 Invalid Socket pointer.
128 10 Invalid type-of-service, fragment, or time-to-live
option.
128 17 Invalid caller for this service.
128 18 Packet is not valid.
128 20 This component has not been enabled.
128 21 This component has already been enabled.
128 22 Listening is not enabled for the specified port.
128 26 Requested suspension was aborted.
128 33 Invalid server IP Address.
128 34 This socket is bound to another port.
128 35 Port is bound to a different socket.
128 36 Socket is not bound.
128 38 The Socket was unbound while suspended
waiting for a receive packet.
128 39 Socket was not created.
128 51 No additional listen request structures are
available.
128 52 There is already an active listen request for this
port.
128 53 Socket is not in a closed state.
128 54 The server socket supplied is not in a listen state.
128 55 No wait time was specified, the connection
attempt is in progress.
128 56 Connection failed.
128 57 Request is greater than the receiver's advertised
window size in bytes.


code code
128 64 Another thread is suspended. Only one thread is
allowed.
128 65 Disconnect failed to complete within the Timeout
period.
128 66 Socket is bound.
128 69 No available Port.
128 70 Invalid Port.
128 71 There is already a valid Socket pointer for this
port or the specified port does not have an active
listen request.
128 72 Same as NX_SUCCESS, except a queued
connection request was processed during this
call.
128 73 TCP Transmit Queue Exceeded Error.
See also
Socket instruction status The following table describes the execution status bits for socket instructions.
bits
Bit Number Name Description
0 EN - Enable Bit The EN bit is set when the instruction is enabled due to a False-to-True
transition, but has not yet completed or erred.
1 EW - Enable Wait The EW bit is set when the controller detects that a Socket instruction request
Queue Bit has entered into queue.
The controller resets the EW bit when the ST bit is set.
2 ST - Start Bit The ST bit is set when the queued instruction is executing.
The ST bit is reset when the DN or ER bit is set.
3 ER - Error Bit Indicates that an error occurred while executing the instruction. The ER bit is
reset the next time the run-condition-in goes from False to True.
4 DN - Done Bit The DN bit is set when the Socket instruction completes successfully. The DN bit
is reset the next time the run-condition-in goes from False to True.
See also

Socket instruction timing Successful execution for Socket instructions when process is immediate
diagrams
Condition A: Rung condition is TRUE during instructions execution
Rung Condition Description

Socket instructions execution is enabled.
EN bit is set and all other bits are cleared.
Socket instructions completes execution successfully.
Output for DN bit and DONE is set.
5 Rung condition becomes FALSE when EN bit is cleared.
6,7 No change in Rung condition.

Condition B: Rung condition is FALSE during instructions execution

Socket instructions completes execution successfully.

EN bit is cleared.
Successful execution for Socket instructions when process is non-immediate


Socket instructions perform background processing.
Output for EW bit and BUSY is set.
Locked Socket instructions input parameter for background processing.
2 Socket instructions start execution when:
EW bit is cleared.
ST bit is set.
3 Socket instructions complete execution successfully when:
Output for ST bit and BUSY is cleared.
EN bit is cleared.
Condition B: Rung condition goes FALSE during instructions execution

Socket instructions send for background processing.
EW bit is cleared.
ST bit is set.
Rung condition becomes FALSE.
10 Socket instructions complete execution successfully when:
Output for ST bit and BUSY are cleared.
Rung condition is FALSE.
EN bit is cleared.

Socket instructions fail when EN is TRUE and EW and ST are FALSE

Socket instructions complete execution with error.
Output for ER bit and error is set.
EN bit is cleared.

Condition B: Rung condition becomes FALSE during instructions execution

Socket instructions complete execution with error.
EN bit is cleared.
Socket instructions fail when EW is TRUE and instruction process is

non-immediate


2 Socket instructions complete execution with error when:
Output for EW bit and BUSY is cleared.
EN bit is cleared.

Output for EW bit and BUSY is cleared.
EN bit is cleared.

Socket instructions fail when ST is TRUE and instruction process is

non-immediately

Output for EW bit and BUSY output is set.
EW bit is cleared
ST bit is set.
Output for ST bit and BUSY output is cleared.
EN bit is cleared.


EW bit is cleared and ST bit is set.
Output for ST bit and BUSY is cleared.
EN bit is cleared.
See also
Socket instruction The following diagram shows a typical sequence of socket interface transactions
with the controller acting as a TCP client.
transaction diagrams
Transactions for TCP Client

Transactions for TCP Server The following diagram shows a typical sequence of socket interface transactions
with the controller as a TCP server.
Transactions for UDP with The following diagram shows a typical sequence of socket interface transactions
for UDP communications when using the Open Connection service to specify the
Open Connection destination address.

Transactions for UDP The following diagram shows a typical sequence of socket interface transactions
for UDP communications without using the Open Connection service to specify
without Open Connections the destination address. In this case, the controller specifies the destination for
each datagram and receives the sender's address along with each datagram it
receives.
See also

State machine diagrams for TCP Client using Socketinstructions
TCP

TCP Server using Socket instructions

TCP State Diagram
See also

State machine diagrams for UDP Datagram with SOCKET_OPEN instruction
UDP
UDP Datagram without SOCKET_OPEN instruction

See also

Chapter 23
String manipulation instructions
Use String manipulation instructions to alter a sequence of symbols that are

chosen from a set or alphabet to change the output status. To read input strings
containing special characters correctly, input the string characters after the
program containing the function block instance is online.
ASCII on page 669 Returns the ASCII code for characters in a string. Character -> ASCII code.
CHAR on page 671 Returns a one character string for an ASCII code. ASCII code -> character.
DELETE on page 673 Deletes characters from a string.

FIND on page 675 Locates and provides the position of sub-strings within strings.
INSERT on page 677 Inserts sub-strings at user-defined positions within strings.
LEFT on page 679 Extracts characters from the left side of a string.
MID on page 681 Extracts characters from the middle of a string.
MLEN on page 683 Calculates the length of a string.
REPLACE on page 687 Replaces parts of a string with new sets of characters.
RIGHT on page 685 Extracts characters from the right side of a string.
See also
ASCII Returns the ASCII code for characters in strings.

Text.

controllers.

Chapter 23 String manipulation instructions

Type
TRUE - display the ASCII code for characters.
FALSE - no display operation.
IN Input STRING Any non-empty string.
Pos Input DINT Position of the selected character in set [1.. len] (len is the length of
the IN string).
ASCII Output DINT ASCII code of the selected character (in set [0 .. 255]) yields 0 is Pos is
out of the string.

ASCII Function Block Diagram example
ASCII Ladder Diagram example
ASCII Structured Text example

String manipulation instructions Chapter 23
FirstChr := ASCII (message, 1);
(* FirstChr is the ASCII code of the first character of the string *)
Results
See also
String manipulation instructions on page 669
CHAR (ASCII code to string Returns a one character string for an ASCII code. ASCII code -> character.
character) Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.

controllers.

Type
TRUE - provide a single character string.
Code Input DINT ASCII code in set [0 .. 255].
CHAR Output STRING One character string.
The character has the ASCII code given in input code.


Type
CHAR Function Block Diagram example
CHAR Ladder Diagram example
CHAR Structured Text example
Display := CHAR ( value + 48 );
(* value is in set [0..9] *)
(* 48 is the ascii code of '0' *)
(* result is one character string from '0' to '9' *)

Results
See also
DELETE (delete sub-string) Deletes characters from a string.

Text.

controllers.

Type
TRUE - delete specified part of a string.
NbC Input DINT Number of characters to be deleted.
Pos Input DINT Position of the first deleted character
(first character of the string has position 1).


Type
DELETE Output STRING Output is:
a modified string.
an empty string (if Pos < 1).
the initial string (if Pos > IN string length).
the initial string (if NbC <= 0).
DELETE Function Block Diagram example
DELETE Ladder Diagram example
DELETE Structured Text example

complete_string := INSERT (ABCD , EFGH, 5); (* complete_string is

'ABCDEFGH ' *)
sub_string := DELETE (complete_string, 4, 3); (* sub_string is 'ABGH '*)
Results
See also
FIND (find sub-string) Locates and provides the position of sub-strings within strings.

controllers.

controllers.

Type
TRUE - locate position within strings.
FALSE - no locate operation.
In Input STRING Any non-empty string.


Type
Pat Input STRING Any non-empty string (Pattern).
FIND Output DINT Output is:
0 if the sub string Pat is not found.
the position of the first character of the first occurrence of
the sub-string Pat (first position is 1)
This instruction is case sensitive.
FIND Function Block Diagram example
FIND Ladder Diagram example
FIND Structured Text example
complete_string := 'ABCD' + 'EFGH'; (* complete_string is 'ABCDEFGH ' *)
found := FIND (complete_string, 'CDEF'); (* found is 3 *)

Results
See also
INSERT (insert string) Inserts sub-strings at user-defined positions within strings.

Text.

controllers.

TRUE - insert sub-strings in a string.
IN Input STRING Initial string.
Str Input STRING String to be inserted.
Pos Input DINT Position of the insertion
the insertion is done before the position
(first valid position is 1).

INSERT Output STRING Modified string. Can be:

empty string if Pos <= 0
concatenation of both strings if Pos is greater than the
length of the IN string
INSERT Function Block Diagram example
INSERT Ladder Diagram example
INSERT Structured Text example
MyName := INSERT ('Mr JONES', 'Frank ', 4);
(* MyName is 'Mr Frank JONES' *)

Results
See also
LEFT (extract left of a sting) Extract characters from the left side of a string.

Text.

controllers.

TRUE - calculate number of characters from left side of string.
NbC Input DINT Number of characters to be extracted. This number cannot be
greater than the length of the IN string.
LEFT Output STRING Left part of the IN string (its length = NbC). Can be:
empty string if NbC <= 0
complete IN string if NbC >= IN string length


LEFT Function Block Diagram example
LEFT Ladder Diagram example
LEFT Structured Text example
complete_string := RIGHT ('12345678', 4), LEFT ('12345678', 4), 5;
(* complete_string is '56781234'
the value issued from RIGHT call is '5678'
the value issued from LEFT call is '1234'*)

Results
See also
MID (extract middle of a Extract characters from the middle of a string. Use the position and number of
characters provided to calculate the required parts of strings.
string)
Text.

controllers.

Type
TRUE - generate portion of a string.
FALSE - no generate operation.

NbC Input DINT Number of characters to be extracted cannot be greater than
the length of the IN string.


Type
Pos Input DINT Position of the sub-string. The sub-string first character will be
the one pointed to by Pos (first valid position is 1).
MID Output STRING Middle part of the string (its length = NbC).
When the number of characters to extract exceeds the length
of the IN string, NbC is automatically recalculated to get the
remainder of the string only. When NbC or Pos are zero or
negative numbers, an empty string is returned.
MID Function Block Diagram example
MID Ladder Diagram example
MID Structured Text example

sub_string := MID ('abcdefgh', 2, 4);
(* sub_string is 'de' *)
Results
See also
MLEN (string length) Calculates the length of a string.

Text.

controllers.

TRUE - calculate length of string.
IN Input STRING Any string.
MLEN Output DINT Number of characters in the IN string.

MLEN Function Block Diagram example
MLEN Ladder Diagram example
MLEN Structured Text example
nbchar := MLEN (complete_string);
If (nbchar < 3) Then Return; End_if;
prefix := LEFT (complete_string, 3);
(* this program extracts the 3 characters on the left of the string and puts the result
in the prefix string variable. Nothing is done if the string length is less than 3
characters *)

Results
See also
RIGHT (extract right of a Extract characters from the right side of a string.
string) Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.

controllers.

Type
TRUE - extract specified number of characters from the right end
of the string.

NbC Input DINT Number of characters to be extracted. This number cannot be
greater than the length of the IN string.


Type
RIGHT Output STRING Right part of the string (length = NbC). Can be:
empty string if NbC <= 0
complete string if NbC >= string length
RIGHT Function Block Diagram example
RIGHT Ladder Diagram example
RIGHT Structured Text example
complete_string := RIGHT ('12345678', 4), LEFT ('12345678', 4),5;
(* complete_string is '56781234'
the value issued from RIGHT call is '5678'
the value issued from LEFT call is '1234'
*)
Results
See also
REPLACE (replace Replaces parts of a string with new sets of characters.
sub-string) Languages supported: Function Block Diagram, Ladder Diagram, Structured

Text.

controllers.

Type
TRUE - replace parts of strings with new characters.
IN Input STRING Any string.
Str Input STRING String to be inserted (to replace NbC chars).


Type
NbC Input DINT Number of characters to be deleted.
Pos Input DINT Position of the first modified character
(first valid position is 1).
REPLACE Output STRING Modified string. The NbC characters are deleted at position
Pos, then the substring Str is inserted at this position. Can be:
empty string if Pos <= 0
strings concatenation (IN+Str) if Pos is greater than the
length of the IN string
initial string IN if NbC <= 0
REPLACE Function Block Diagram example
REPLACE Ladder Diagram example

REPLACE Structured Text example
Replacing a part of a string with a new set of characters.
MyName := REPLACE ('Mr X JONES, 'Frank', 1, 4);
(* MyName is 'Mr Frank JONES' *)
Results
See also

Chapter 24
Timer instructions
Use Timer instructions to control operations based on time.
TOF on page 692 Off-delay timing. Increase an internal timer up to a given value.
TON on page 694 On-delay timing. Increase an internal timer up to a given value.
TONOFF on page 696 Delay turning on an output on a true rung, and then delay turning off the output on the
false rung.
TP on page 699 Pulse timing. On a rising edge, increases an internal timer up to a given value.
RTO on page 701 Retentive timing. Increases an internal timer when input is active, but does not reset
the internal timer when input changes to inactive.
DOY on page 703 Turn on an output if the value of the real-time clock is in the range of the Year Time
setting.
TDF on page 706 Computes the time difference between TimeA and TimeB.
TOW on page 708 Turns on an output if the value of the real-time clock is in the range of the Time of Week
setting.
See also
Timer instruction Time accuracy refers to the time between the moment the processor enables a
timer instruction and the moment the processor completes the timed interval.
configuration
The processor uses the following information from the timer instruction:
Timer - The timer control address in the timer area of data storage.
Time Base - Determines how the timer operates.
Preset - Specifies the value that the timer must reach before the processor
sets the done bit.
Accumulated value - The number of time increments the instruction has
counted. When enabled, the timer updates this value continually.
See also
Timer instructions on page 691

Chapter 24 Timer instructions
TOF (timer, off-delay) Increases an internal timer up to a given value.
Operation details:
If the EN parameter is used with this instruction block, the timer starts
incrementing when EN is set to TRUE, and continues to increment even if
EN is set to FALSE.

Text.

controllers.

type
IN Input BOOL Input control.
TRUE - Falling edge detected, starts increasing internal timer.
FALSE - Rising edge detected, stops and resets internal timer.
PT Input TIME Maximum programmed time.
Q Output BOOL TRUE - total time is not elapsed.
FALSE - total time has elapsed.
ET Output TIME Current elapsed time. Possible values range from 0ms to
1193h2m47s294ms.
TOF timing diagram

Timer instructions Chapter 24
TOF Function Block Diagram example
TOF Ladder Diagram example
TOF Structured Text example
Results

See also
Timer instruction configuration on page 691
Increases an internal timer up to a given value.

TON (timer, on-delay)
Operation details:
Do not use a jump to skip over a TON instruction block in a Ladder

Diagram (LD). If a jump is used, the TON timer continues after the elapsed
time.
For example: Rung 1 contains a jump; rung 2 contains a TON instruction
block with an elapsed time of 10 seconds; enable the jump from rung 1 to
rung 3; disable the jump after 30 seconds; the elapsed time is 30 seconds -
not 10 seconds as defined in the elapsed time.
If the EN parameter is used with TON, the timer starts incrementing when
EN is set to TRUE, and continues to increment even if EN is set to FALSE.

Text.

controllers.

type
TRUE - If rising edge, starts increasing internal timer.
FALSE- If falling edge, stops and resets internal timer.
PT Input TIME Maximum programmed time defined using Time data type.
Q Output BOOL TRUE - programmed time has elapsed.

FALSE - programmed time has not elapsed.
1193h2m47s294ms.

TON timing diagram
TON Function Block Diagram example
TON Ladder Diagram example
TON Structured Text example

Results
See also
TONOFF (time-delay, on, Delays turning on an output on a true rung, then delays turning off the output on
the false rung.
off)
Operation details:
If the EN parameter is used with TONOFF, the timer starts incrementing

when EN is set to TRUE, and continues to increment even if EN is set to
FALSE.

Text.

controllers.


type
TRUE - Rising Edge detected (IN turns from 0 to 1):
start the On-delay timer (PT).
if Programmed Off--delay time (PTOF) is not elapsed, restart
the On-delay (PT) timer.
FALSE - Falling Edge detected (IN turns from 1 to 0):
if Programmed On-delay time (PT) is not elapsed, stop PT timer
and reset ET.
if Programmed On-delay time (PT) is elapsed, the start the
Off-delay timer (PTOF).
PT Input TIME The on-delay time setting defined using the Time data type.
PTOF Input TIME The off-delay time setting defined using the Time data type.
Q Output BOOL TRUE - the Programmed On-delay time is elapsed and
Programmed Off-delay time is not elapsed.
1193h2m47s294ms.
If the Programmed On-delay time is elapsed and the Off-delay
timer is not starting, the elapsed time (ET) remains at the on-delay
(PT) value. If the Programmed Off-delay time is elapsed and the
Off-delay timer is not starting, the elapsed time (ET) remains at
the off-delay (PTOF) value until the rising edge occurs again.
TONOFF Function Block Diagram example
TONOFF Ladder Diagram example

TONOFF Structured Text example
Results

See also
On a rising edge, increases an internal timer up to a given value. If the timer is

TP (pulse timing)
elapsed, the internal time is reset.
Operation details:
If the EN parameter is used with TP, the timer starts incrementing when
EN is set to TRUE, and continues to increment even if EN is set to FALSE.

Text.

controllers.

type
IN Input BOOL TRUE - If rising edge, starts increasing internal timer (if not already
increasing).
FALSE - if timer has elapsed, resets the internal timer.
Any change to IN during counting has no effect.
PT Input TIME Maximum programmed time defined using the Time data type.
Q Output BOOL TRUE - timer is counting.
FALSE - timer is not counting..
ET Output TIME Current elapsed time.
Possible values range from 0ms to 1193h2m47s294ms.

TP timing diagram
TP Function Block Diagram example
TP Ladder Diagram example
TP Structured Text example

Results
See also
Increases an internal timer when input is active, but does not reset the internal
RTO (retentive timer,
timer when input changes to inactive.
on-delay)
Operation details:
Micro810 or Micro820 controllers, the RTO internal timer does not persist
through a power cycle by default. To persist the internal timer, set the
Retained configuration parameter to true.
Micro830 or Micro850 controller, the RTO internal timer persists through
a power cycle.

Text.


controllers.

type
TRUE - Rising edge, starts increasing internal timer.
FALSE - Falling edge, stops and does not reset the internal timer.
RST Input BOOL TRUE - Rising edge, resets the internal timer.
FALSE - Does not reset internal timer.
PT Input TIME Maximum programmed on-delay time. PT is defined using the
Time data type.
Q Output BOOL TRUE - Programmed on-delay time is elapsed.
FALSE - Program on-delay time has not elapsed.
ET Output TIME Current elapsed time.
Values range from 0ms to 1193h2m47s294ms.
ET is defined using the Time data type.
RTO timing diagram example

RTO Function Block Diagram example
RTO Ladder Diagram example
RTO Structured Text example
See also
DOY (check year for Turns on an output when the value of real-time clock (RTC) is in the range of the
Year Time setting.
real-time clock)
Operation details:
If RTC is not present, the output is always off.

Configure the Time input parameters with valid ranges as specified in the
DOYDATA Data Type. An invalid value faults the controller when
TimeX.Enable is set to TRUE and an RTC is present and enabled.

Text.

Type
TRUE - perform the operation.
FALSE - do not perform the operation.
TimeA Input DOYDATA Year Time Setting of Channel A.
Use the DOYDATA data type to configure TimeA.
TimeB Input DOYDATA Year Time Setting of Channel B.
Use the DOYDATA data type to configure TimeB.
TimeC Input DOYDATA Year Time Setting of Channel C.
Use the DOYDATA data type to configure TimeC.
TimeD Input DOYDATA Year Time Setting of Channel D.
Use the DOYDATA data type to configure TimeD.
DOY Output BOOL If TRUE, the value of the real-time clock is in the range of the
Year Time setting of any one of the four channels.
DOYDATA Data Type
The following table describes the DOYDATA data type.
Enable BOOL TRUE:Enable; FALSE:Disable

YearlyCenturial BOOL Type of timer (0:Yearly timer; 1:Centurial timer).
YearOn UINT Year On value (must be in set [2000...2098]).
MonthOn USINT Month On value (must be in set [1...12]).
DayOn USINT Day On value (must be in set [1...31], determined by "MonthOn" value).

YearOff UINT Year Off value (must be in set [2000...2098]).

MonthOff USINT Month Off value (must be in set [1...12]).
DayOff USINT Day Off value (must be in set [1...31], determined by "MonthOff" value).
DOY Function Block Diagram example
DOY Ladder Diagram example
DOY Structured Text example
TESTOUTPUT := DOY(TIMEA1, TIMEB1, TIMEC1, TIMED1) ;

See also
Compute the time difference between TimeA and TimeB.

TDF (time difference)
Text.

controllers.

Type
TRUE - perform current computation.
TimeA Input TIME The start time for time difference computation.
TimeB Input TIME The end time for time difference computation.
TDF Output TIME The time difference for the two time inputs.
TDF is name or PIN ID
TDF Function Block Diagram example

TDF Ladder Diagram example
TDF Structured Text example
TESTTIMEDIFF := TDF(TESTTIME1, TESTTIME2) ;
Results
See also

Time data type
TOW (check week for Turns on an output if the value of the real-time clock (RTC) is in the range of the
Time of Week setting.
real-time clock)
Operation details:
If an RTC is not present, the output is always off.

Configure the Time input parameters with valid ranges as specified in the
TOWDATA Data Type. An invalid value faults the controller when
TimeX.Enable is set to TRUE and an RTC is present and enabled.

Text.

Type
When EN = TRUE, perform the operation.
When EN = FALSE, do not perform the operation.
TimeA Input TOWDATA Day Time Setting of Channel A.
Use the TOWDATA Data Type to define TimeA.
TimeB Input TOWDATA Day Time Setting of Channel B.
Use the TOWDATA Data Type to define TimeB.
TimeC Input TOWDATA Day Time Setting of Channel C.
Use the TOWDATA Data Type to define TimeC.
TimeD Input TOWDATA Day Time Setting of Channel D.
Use the TOWDATA Data Type to define TimeD.
TOW Output BOOL If TRUE, the value of the real-time clock is in the range of the Day
Time setting of any one of four channels.
TOWDATA Data Type
The following table describes the TOWDATA data type:

Enable BOOL TRUE: Enable; FALSE: Disable.

DailyWeekly BOOL Type of Timer (0:daily timer; 1:weekly timer).
DayOn USINT Day of Week On value (must be in set [0...6]).
HourOn USINT Hour On value (must be in set [0...23]).
MinOn USINT Minute On value (must be in set [0...59]).
DayOff USINT Weekday Off value (must be in set [0...6]).
HourOff USINT Hour Off value (must be in set [0...23]).
MinOff USINT Minute Off value (must be in set [0...59]).
TOW Function Block Diagram example
TOW Ladder Diagram example
TOW Structured Text example

TESTOUTPUT := TOW(TIMEA, TIMEB, TIMEC, TIMED) ;
Results

See also

Index
AHL function block 124
alarms
- operator 109 LIM_ALRM function block 67
AND operator 173
AND_MASK function 143
* ANY_TO_BOOL operator 279
* operator 97 ANY_TO_BYTE operator 280
ANY_TO_DATE operator 282
ANY_TO_DINT operator 283
/ ANY_TO_DWORD operator 284
/ operator 88 ANY_TO_INT operator 286
ANY_TO_LINT operator 287
ANY_TO_LREAL operator 288
+ ANY_TO_LWORD operator 289
+ operator 77 ANY_TO_REAL operator 291
ANY_TO_SINT operator 292
ANY_TO_STRING operator 293
< ANY_TO_TIME operator 294
< operator 264 ANY_TO_UDINT operator 296
<= operator 266 ANY_TO_UINT operator 297
<> operator 268 ANY_TO_ULINT operator 298
ANY_TO_USINT operator 299
ANY_TO_WORD operator 300
= ARD function block 127
= operator 257 arithmetic
ABS function 72
ACOS function 73
> ACOS_LREAL function 75
> operator 260 addition operator 77
>= operator 262 ASIN function 78
ASIN_LREAL function 80
ATAN function 82
1 ATAN_LREAL function 83
1Gain operator 96 COS function 85
COS_LREAL function 87
division operator 88
A
EXPT function 90
ABL function block 117 LOG function 92
ABS function 72 MOD function 94
ACB function block 119 MOV operator 96
ACL function block 122 multiplication operator 97
ACOS function 73 Neg operator 99
ACOS_LREAL function 75 POW function 100
addition operator 77 RAND function 102
advanced control blocks SIN function 104
SCALER 552 SIN_LREAL 106
Index
SQRT function 107 C

subtraction operator 109
TAN function 111 calling
TAN_LREAL function 112 function blocks 19
TRUNC function 114 CHAR function 671
arithmetic operations coils
1Gain operator 96 changing types of 41
ARL function block 130 changing types of in FBD 41
ASCII function 669 direct type 45
ASIN function 78 direct type in FBD 45
ASIN_LREAL function 80 inserting 41
ATAN function 82 inserting in FBD 41
ATAN_LREAL function 83 parallel, inserting 41
AVERAGE function block 303 parallel, inserting in FBD 41
AWA function block 133 pulse falling edge (positive) 46
AWT function block 135 pulse rising edge (positive) 47
reset 49
reset in FBD 49
B reverse type 45
binary operations reverse type in FBD 45
AND_MASK function 143 set 48
NOT_MASK function 152 set in FBD 48
OR_MASK function 154 usage and available types for FBD 41
ROL function 156 usage and available types of 41
ROR function 158 communications
SHL function 160 ABL function block 117
SHR function 162 ACB function blocks 119
XOR_MASK function 164 ACL function block 122
boolean AHL function block 124
MUX4B function 184 ARD function block 127
MUX8B function 180 ARL function block 130
TTABLE function 177 AWA function block 133
boolean operations AWT function block 135
AND operator 173 MSG_CIPGENERIC function block 189
F_TRIG function block 167 MSG_CIPSYMBOLIC function block 200
NOT operator 175 MSG_MODBUS function block 204
OR operator 172 MSG_MODBUS2 function block 211
R_TRIG function block 169 comparison operations
RS function block 171 equal operator 257
SR function block 175 greater than operator 260
XOR operator 174 greater than or equal operator 262
branches less than operator 264
for LD 38 less than or equal operator 266
inserting 38 not equal operator 268
contacts
changing type of 50
direct 54
Index
direct in FBD 54 DERIVATE function block 523

inserting 50 direct
parallel, inserting 50 coils 45
pulse falling edge (positive) 56 coils in FBD 45
pulse rising edge (positive) 55 contacts 54
pulse rising edge (positive) in FBD 55 contacts in FBD 54
reverse 54 division operator 88
reverse in FBD 54 DOY function 703
usage and available types in FBD of 50
usage and available types of 50
COP function block 305
E
COS function 85 equal operator 257
COS_LREAL function 87 EXPT function 90
counter
CTD function block 271
CTU function block 273
F
CTUD function block 275 F_TRIG function block 167
CTD function block 271 FBD (Function Block Diagram)
CTU function block 273 coils, usage and available types of 41
CTUD function block 275 contacts, usage and available types of 50
direct coils 45
direct contacts 54
D jumps to labels, inserting 58
data conversion pulse rising edge (positive) contacts 55
ANY_TO_BOOL operator 279 reset coils 49
ANY_TO_BYTE operator 280 returns, inserting 56
ANY_TO_DATE operator 282 reverse coils 45
ANY_TO_DINT operator 283 reverse contacts 54
ANY_TO_DWORD operator 284 rungs, inserting 33
ANY_TO_INT operator 286 set coils 48
ANY_TO_LINT operator 287 FFL 525
ANY_TO_LREAL operator 288 FFU 535
ANY_TO_LWORD operator 289 FIND function 675
ANY_TO_REAL operator 291 function blocks
ANY_TO_SINT operator 292 ABL 117
ANY_TO_STRING operator 293 ACB 119
ANY_TO_TIME operator 294 ACL 122
ANY_TO_UDINT operator 296 AHL 124
ANY_TO_UINT operator 297 ARD 127
ANY_TO_ULINT operator 298 ARL 130
ANY_TO_USINT operator 299 AVERAGE 303
ANY_TO_WORD operator 300 AWA 133
data manipulation AWT 135
AVERAGE function block 303 calling 19
COP function block 305 COP 305
MAX function 313 CTD 271
MIN function 311 CTU 273
Index
CTUD 275 RTO 701

DERIVATE 523 SCALER 552
F_TRIG 167 SOCKET_ACCEPT 613
FFL 525 SOCKET_CREATE 616
FFU 535 SOCKET_DELETE 621
HSC 318 SOCKET_DELETEALL 624
HSC_SET_STS 335 SOCKET_INFO 626
HYSTER 541 SOCKET_OPEN 633
IIM 373 SOCKET_READ 637
INTEGRAL 543 SOCKET_WRITE 642
IOM 375 SR 175
IPIDCONTROLLER 565 STACKINT 555
KEY_READ 378 SUS 563
LIM_ALRM 67 SYS_INFO 417
MC_AbortTrigger 445 TOF 692
MC_Halt 448 TON 694
MC_Home 452 TONOFF 696
MC_MoveAbsolute 456 TP 699
MC_MoveRelative 461 TRIMPOT_READ 419
MC_MoveVelocity 466 functions
MC_Power 470 ABS 72
MC_ReadAxisError 484 ACOS 73
MC_ReadBoolParameter 489 ACOS_LREAL 75
MC_ReadParameter 493 AND_MASK 143
MC_ReadStatus 495 ASCII 669
MC_Reset 501 ASIN 78
MC_SetPosition 503 ASIN_LREAL 80
MC_Stop 507 ATAN 82
MC_TouchProbe 510 ATAN_LREAL 83
MC_WriteBoolParameter 514 CHAR 671
MC_WriteParameter 518 COS 85
MMINFO 383 COS_LREAL 87
MODULE_INFO 387 DELETE 673
MSG_CIPGENERIC 189 DOY 703
MSG_CIPSYMBOLIC 200 EXPT 90
MSG_MODBUS 204 FIND 675
MSG_MODBUS2 211 INSERT 677
PID 592 LCD 360
PLUGIN_INFO 400 LEFT 679
PLUGIN_READ 403 LIMIT 560
PLUGIN_RESET 405 LOG 92
PLUGIN_WRITE 407 MAX 313
R_TRIG 169 MID 681
RS 171 MIN 311
RTC_READ 412 MLEN 683
RTC_SET 414 MOD 94

Index
MUX4B 184 input/output

MUX8B 180 HSC function block 318
NOT_MASK 152 HSC_SET_STS function block 335
OR_MASK 154 IIM function block 373
POW 100 IOM function block 375
RAND 102 KEY_READ function block 378
REPLACE 687 LCD function 360
RHC 368 MMINFO function block 383
RIGHT 685 PLUGIN_INFO function block 400
ROL 156 PLUGIN_READ function block 403
ROR 158 PLUGIN_RESET function block 405
RPC 370 PLUGIN_WRITE function block 407
SHL 160 RHC function 368
SHR 162 RPC function 370
SIN 104 RTC_READ function block 412
SIN_LREAL 106 RTC_SET function block 414
SQRT 107 SYS_INFO function block 417
STIS 423 TRIMPOT_READ function block 419
TAN 111 INSERT function 677
TAN_LREAL 112 inserting
TDF 706 jumps to labels (FBD elements) 58
TND 558 labels Rungs 33
TOW 708 returns (FBD elements) 56
TRUNC 114 rungs (FBD elements) 33
TTABLE 177 Instruction block description 189, 200, 211, 303, 305
UIC 425 Instruction block description for
UID 427 ABL 117
UIE 429 ACB 119
UIF 430 ACL 122
XOR_MASK 164 AHL 124
functions blocks ARD 127
naming and parameters for 19 ARL 130
AVERAGE 303
AWA 133
G AWT 135
greater than operator 260 COP 305
greater than or equal operator 262 CTD 271
CTU 273
CTUD 275
H DERIVATE 523
HSC function block 318 F_TRIG 167
HSC_SET_STS function block 335 HSC 318
HYSTER function block 541 HSC_SET_STS 335
HYSTER 541
IIM 373
I
INTEGRAL 543
IIM function block 373
Index
IOM 375 INTEGRAL function block 543

IPIDCONTROLLER 565 interrupt
KEY_READ 378 STIS function 423
LIM_ALRM 67 UIC function 425
MC_AbortTrigger 445 UID function 427
MC_Halt 448 UIE function 429
MC_Home 452 UIF function 430
MC_MoveAbsolute 456 IOM function block 375
MC_MoveRelative 461 IPIDCONTROLLER function block 565
MC_MoveVelocity 466
MC_Power 470
MC_ReadAxisError 484
J
MC_ReadBoolParameter 489 jumps
MC_ReadParameter 493 for LD diagrams 58
MC_ReadStatus 495 Function Block Diagram, inserting 58
MC_Reset 501 Ladder Diagrams, inserting 58
MC_SetPosition 503 Rungs,inserting 33
MC_Stop 507
MC_TouchProbe 510
MC_WriteBoolParameter 514
K
MC_WriteParameter 518 KEY_READ function block 378
MM_INFO 383 keyboard shortcuts
MSG_CIPGENERIC 189 LD language 62
MSG_CIPSYMBOLIC 200
MSG_MODBUS 204
L
MSG_MODBUS2 211
PLUGIN_INFO 400 labels
PLUGIN_READ 403 Rungs, inserting 33
PLUGIN_RESET 405 Ladder Diagram (LD)
PLUGIN_WRITE 407 instructions 29
R_TRIG 169 language 29
RST 171 language
RTC_READ 412 Ladder Diagram (LD) 29
RTC_SET 414 LCD function 360
RTO 701 LD (Ladder Diagram)
SCALER 552 branches 38
SRT 175 coils, usage and available types of 41
STACKINT 555 contacts, usage and available types of 50
SUS 563 direct coils 45
SYS_INFO 417 direct contacts 54
TOF 692 jumps 58
TON 694 pulse falling edge (negative) coils 46
TONOFF 696 pulse falling edge (negative) contacts 56
TP 699 pulse rising edge (positive) coils 47
TRIMPOT_READ 419 pulse rising edge (positive) contacts 55
instructions 29 reset coils 49
return statements 56
Index
reverse coils 45 MC_MoveVelocity function block 466

reverse contacts 54 MC_Power function block 470
rungs, inserting 33 MC_ReadAxisError function block 484
set coils 48 MC_ReadBoolParameter function block 489
LD language MC_ReadParameter function block 493
keyboard shortcuts 62 MC_ReadStatus function block 495
LEFT function 679 MC_Reset function block 501
less than operator 264 MC_SetPosition function block 503
less than or equal operator 266 MC_Stop function block 507
LIM_ALRM function block 67 MC_TouchProbe function block 510
LIMIT function 560 MC_WriteBoolParameter function block 514
LOG function 92 MC_WriteParameter function block 518
Motion control function blocks 433
MOV operator 96
M MSG_CIPGENERIC function block 189
MAX function 313 MSG_CIPSYMBOLIC function block 200
MC_AbortTrigger function block 445 MSG_MODBUS function block 204
MC_Halt function block 448 MSG_MODBUS2 function block 211
MC_Home function block 452 multiplication operator 97
MC_MoveAbsolute function block 456 MUX4B function 184
MC_MoveRelative function block 461 MUX8B function 180
MC_MoveVelocity function block 466
MC_Power function block 470
MC_Read 479
N
MC_ReadActualPosition 474 naming conventions
MC_ReadAxisError function block 484 function blocks 19
MC_ReadBoolParameter function block 489 Neg operator 99
MC_ReadParameter function block 493 not equal operator 268
MC_ReadStatus function block 495 NOT operator 175
MC_Reset function block 501 NOT_MASK function 152
MC_SetPosition function block 503
MC_Stop function block 507
MC_TouchProbe function block 510
O
MC_WriteBoolParameter function block 514 operators
MC_WriteParameter function block 518 1Gain 96
MID function 681 addition 77
MIN function 311 AND 173
MLEN function 683 ANY_TO_BOOL 279
MMINFO function block 383 ANY_TO_BYTE 280
MOD function 94 ANY_TO_DATE 282
MODULE_INFO 387 ANY_TO_DINT 283
motion ANY_TO_DWORD 284
MC_AbortTrigger function block 445 ANY_TO_INT 286
MC_Halt function block 448 ANY_TO_LINT 287
MC_Home function block 452 ANY_TO_LREAL 288
MC_MoveAbsolute function block 456 ANY_TO_LWORD 289
MC_MoveRelative function block 461 ANY_TO_REAL 291
Index
ANY_TO_SINT 292 coils 46

ANY_TO_STRING 293 contacts 56
ANY_TO_TIME 294 pulse rising edge (positive)
ANY_TO_UDINT 296 coils 47
ANY_TO_UINT 297 contacts 55
ANY_TO_ULINT 298 contacts in FBD 55
ANY_TO_USINT 299
ANY_TO_WORD 300
division 88
R
equal 257 R_TRIG function block 169
greater than 260 RAND function 102
greater than or equal 262 REPLACE function 687
less than 264 reset
less than or equal 266 coils 49
MOV 96 reset coil in FBD 49
multiplication 97 return statements
Neg 99 for LD diagrams 56
NOT 175 inserting 56
not equal 268 return symbols
OR 172 inserting, FBD elements 56
subtraction 109 reverse
XOR 174 coils 45
OR operator 172 coils in FBD 45
OR_MASK function 154 contacts 54
contacts in FBD 54
RHC function 368
P RIGHT function 685
parallel branches for LD diagrams 38 ROL function 156
parameters ROR function 158
for function blocks 19 RPC function 370
PID 592 RS function block 171
PLUGIN_INFO function block 400 RTC_READ function block 412
PLUGIN_READ function block 403 RTC_SET function block 414
PLUGIN_RESET function block 405 RTO function block 701
PLUGIN_WRITE function block 407 rungs
POW function 100 Function Block Diagram, inserting 33
process control inserting 33
DERIVATE function block 523 labels, inserting 33
HYSTER function block 541
INTEGRAL function block 543
IPIDCONTROLLER function block 565
S
LIMIT function 560 SCALER function block 552
STACKINT function block 555 SHL function 160
program control SHR function 162
SUS function block 563 SIN function 104
TND function 558 SIN_LREAL 106
pulse falling edge (negative) SOCKET_ACCEPT 613
Index
SOCKET_CREATE 616 TON function block 694

SOCKET_DELETE 621 TONOFF function block 696
SOCKET_DELETEALL 624 TOW function 708
SOCKET_INFO 626 TP function block 699
SOCKET_OPEN 633 TRIMPOT_READ function block 419
SOCKET_READ 637 TRUNC function 114
SOCKET_WRITE 642 TTABLE function 177
SQRT function 107
SR function block 175
STACKINT function block 555
U
stencil UIC function 425
coils types available for FBD 41 UID function 427
coils types available for LD diagrams 41 UIE function 429
contact elements available for LD diagrams 50 UIF function 430
rungs, inserting in LD containers 33
STIS function 423
X
string manipulation
ASCII function 669 XOR operator 174
CHAR function 671 XOR_MASK function 164
DELETE function 673
FIND function 675
INSERT function 677
LEFT function 679
MID function 681
MLEN function 683
REPLACE function 687
RIGHT function 685
subtraction operator 109
SUS function block 563
SYS_INFO function block 417
T
TAN function 111
TAN_LREAL function 112
TDF function 706
time
DOY function 703
RTO function block 701
TDF function 706
TOF function block 692
TON function block 694
TONOFF function block 696
TOW function 708
TP function block 699
TND function 558
TOF function block 692
Rockwell Automation support
Rockwell Automation provides technical information on the web to assist you in using its products.
At http://www.rockwellautomation.com/support you can find technical and application notes, sample code, and links to software service packs.
You can also visit our Support Center at https://rockwellautomation.custhelp.com for software updates, support chats and forums, technical
information, FAQs, and to sign up for product notification updates.
In addition, we offer multiple support programs for installation, configuration, and troubleshooting. For more information, contact your local
distributor or Rockwell Automation representative, or visit http://www.rockwellautomation.com/services/online-phone .
Installation assistance
If you experience a problem within the first 24 hours of installation, review the information that is contained in this manual. You can contact
Customer Support for initial help in getting your product up and running.
United States or Canada 1.440.646.3434

Outside United States or Canada Use the Worldwide Locator available at http://www.rockwellautomation.com/locations , or contact your local Rockwell
Automation representative.
New product satisfaction return

Rockwell Automation tests all of its products to ensure that they are fully operational when shipped from the manufacturing facility. However, if
your product is not functioning and needs to be returned, follow these procedures.
United States Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to
your distributor to complete the return process.
Outside United States Please contact your local Rockwell Automation representative for the return procedure.
Documentation feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this document, complete the
feedback form, publication RA-DU002.
Rockwell Automation Publication 2080-RM001F-EN-E - November 2016
Copyright 2016 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.

2080 rm001 - en e

Uploaded by

Document Informationclick to expand document informationdatasheet1212341

Document Informationclick to expand document information

Copyright:

Available Formats

2080 rm001 - en e

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

2080 rm001 - en e

Uploaded by

Copyright:

Available Formats

Reference Manual

Micro800 Programmable Controllers General Instructions

Labels may also be on or inside the equipment to provide specific precautions.

Preface In This Manual ................................................................................................................... 13

Find information about Instruction blocks .............................................................................................................. 17

Ladder Diagram (LD) Ladder Diagram (LD) program ....................................................................................... 29

Ladder Diagram (LD) Rung .............................................................................................................................. 33

Rockwell Automation Publication 2080-RM001F-EN-E - November 2016 3

Instruction blocks in LD programs ................................................................................ 59

Alarm instruction LIM_ALRM (limit alarm) ............................................................................................... 67

Arithmetic instructions ABS (absolute value).......................................................................................................... 72

AWA (ASCII write append) ......................................................................................... 133

Binary instructions AND_MASK (AND mask) .......................................................................................... 143

Boolean instructions F_TRIG (falling edge detection) .................................................................................. 167

Communication instructions MSG_CIPGENERIC (common industrial protocol generic message)................ 189

Target path for CIP messaging ...................................................................... 197

6 Rockwell Automation Publication 2080-RM001F-EN-E - November 2016

Compare instructions Equal ................................................................................................................................... 257

Counter instructions CTD (count down) ......................................................................................................... 271

Data conversion instructions ANY_TO_BOOL ........................................................................................................... 279

Data manipulation AVERAGE ........................................................................................................................ 303

Rockwell Automation Publication 2080-RM001F-EN-E - November 2016 7

High-Speed Counter (HSC) What is a High-Speed Counter? ................................................................................... 317

Input/Output instructions LCD .................................................................................................................................... 360

8 Rockwell Automation Publication 2080-RM001F-EN-E - November 2016

RCP (recipe) ..................................................................................................................... 409

Interrupt instructions STIS (select timed start) ................................................................................................. 423

Rockwell Automation Publication 2080-RM001F-EN-E - November 2016 9

MC_WriteParameter (motion control write parameter)........................................ 518

Process control instructions DERIVATE ...................................................................................................................... 523

Program control instruction SUS (suspend)................................................................................................................... 563

10 Rockwell Automation Publication 2080-RM001F-EN-E - November 2016

Socket instructions SOCKET_ACCEPT ...................................................................................................... 613

String manipulation ASCII.................................................................................................................................. 669

Timer instructions Timer instruction configuration ................................................................................... 691

Rockwell Automation Publication 2080-RM001F-EN-E - November 2016 11

TON (timer, on-delay) ................................................................................................... 694

12 Rockwell Automation Publication 2080-RM001F-EN-E - November 2016

Rockwell Automation Publication 2080-RM001F-EN-E - November 2016 13

You can view or download publications at

Legal Notices Copyright notice

2016 Rockwell Automation, Inc. All rights reserved. Printed in USA.

This document and any accompanying Rockwell Software products are

End User License Agreement (EULA)

Allen-Bradley, ControlLogix, CompactLogix, Connected Components

Any Rockwell Automation software or hardware not mentioned here is also a

Rockwell Automation maintains current product environmental information on

Contact Rockwell Automation

Customer Support Telephone 1.440.646.3434

Online Support http://www.rockwellautomation.com/support/

Rockwell Automation Publication 2080-RM001F-EN-E - November 2016 15

Find information about instructions and ladder

Connected Components Workbench includes a comprehensive instruction set

Additionally, Connected Components Workbench includes user-interface

For information about a specific instruction, including a description, parameter

Instruction reference in alphabetical order on page 21

For a description of the ladder elements used in Connected Components